Snap for 12397640 from 86dc35af6578140380ac3259f3a21ab803bc3427 to 24Q4-release
Change-Id: I6f582a5feb44c13dbab08e47bc3980e59be22534
diff --git a/PREUPLOAD.cfg b/PREUPLOAD.cfg
index 9adfe60..421696d 100644
--- a/PREUPLOAD.cfg
+++ b/PREUPLOAD.cfg
@@ -1,5 +1,2 @@
[Hook Scripts]
check = ${REPO_ROOT}/development/tools/external_crates/android_cargo.py run --bin crate_health --manifest-path ${REPO_ROOT}/development/tools/external_crates/Cargo.toml -- preupload-check ${PREUPLOAD_FILES}
-
-[Builtin Hooks]
-bpfmt = true
diff --git a/crates/ciborium-io/cargo_embargo.json b/crates/ciborium-io/cargo_embargo.json
index 560a629..f667f05 100644
--- a/crates/ciborium-io/cargo_embargo.json
+++ b/crates/ciborium-io/cargo_embargo.json
@@ -22,6 +22,13 @@
"no_std": true
}
}
+ },
+ {
+ "features": [
+ "alloc"
+ ],
+ "generate_androidbp": false,
+ "generate_rulesmk": true
}
]
}
diff --git a/crates/ciborium-io/rules.mk b/crates/ciborium-io/rules.mk
index 6b68138..3fb80b5 100644
--- a/crates/ciborium-io/rules.mk
+++ b/crates/ciborium-io/rules.mk
@@ -1,17 +1,18 @@
-# This file is generated by cargo2rulesmk.py --run --config cargo2rulesmk.json.
-# Do not modify this file as changes will be overridden on upgrade.
+# This file is generated by cargo_embargo.
+# Do not modify this file after the LOCAL_DIR line
+# because the changes will be overridden on upgrade.
+# Content before the first line starting with LOCAL_DIR is preserved.
LOCAL_DIR := $(GET_LOCAL_DIR)
MODULE := $(LOCAL_DIR)
MODULE_CRATE_NAME := ciborium_io
-MODULE_SRCS := \
- $(LOCAL_DIR)/src/lib.rs \
-
+MODULE_RUST_CRATE_TYPES := rlib
+MODULE_SRCS := $(LOCAL_DIR)/src/lib.rs
MODULE_RUST_EDITION := 2021
MODULE_RUSTFLAGS += \
- --cfg 'feature="alloc"' \
+ --cfg 'feature="alloc"'
MODULE_LIBRARY_DEPS := \
- trusty/user/base/lib/liballoc-rust \
+
include make/library.mk
diff --git a/crates/ciborium/cargo_embargo.json b/crates/ciborium/cargo_embargo.json
index 8380dba..b2b93ca 100644
--- a/crates/ciborium/cargo_embargo.json
+++ b/crates/ciborium/cargo_embargo.json
@@ -18,6 +18,10 @@
"no_std": true
}
}
+ },
+ {
+ "generate_androidbp": false,
+ "generate_rulesmk": true
}
]
}
diff --git a/crates/ciborium/rules.mk b/crates/ciborium/rules.mk
index 9efa203..7ce683b 100644
--- a/crates/ciborium/rules.mk
+++ b/crates/ciborium/rules.mk
@@ -1,20 +1,21 @@
-# This file is generated by cargo2rulesmk.py --run.
-# Do not modify this file as changes will be overridden on upgrade.
+# This file is generated by cargo_embargo.
+# Do not modify this file after the LOCAL_DIR line
+# because the changes will be overridden on upgrade.
+# Content before the first line starting with LOCAL_DIR is preserved.
LOCAL_DIR := $(GET_LOCAL_DIR)
MODULE := $(LOCAL_DIR)
MODULE_CRATE_NAME := ciborium
-MODULE_SRCS := \
- $(LOCAL_DIR)/src/lib.rs \
-
+MODULE_RUST_CRATE_TYPES := rlib
+MODULE_SRCS := $(LOCAL_DIR)/src/lib.rs
MODULE_RUST_EDITION := 2021
MODULE_RUSTFLAGS += \
--cfg 'feature="default"' \
- --cfg 'feature="std"' \
+ --cfg 'feature="std"'
MODULE_LIBRARY_DEPS := \
- external/rust/crates/ciborium-io \
- external/rust/crates/ciborium-ll \
- external/rust/crates/serde \
+ $(call FIND_CRATE,ciborium-io) \
+ $(call FIND_CRATE,ciborium-ll) \
+ $(call FIND_CRATE,serde)
include make/library.mk
diff --git a/crates/const-oid/Android.bp b/crates/const-oid/Android.bp
index 5f7bcf4..c0ca8eb 100644
--- a/crates/const-oid/Android.bp
+++ b/crates/const-oid/Android.bp
@@ -30,7 +30,7 @@
vendor_available: true,
visibility: [
"//external/rust/android-crates-io/crates/der:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
],
@@ -59,7 +59,7 @@
vendor_available: true,
visibility: [
"//external/rust/android-crates-io/crates/der:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
],
diff --git a/crates/const-oid/cargo2android_viz.bp b/crates/const-oid/cargo2android_viz.bp
index 48ecf9e..3f5e617 100644
--- a/crates/const-oid/cargo2android_viz.bp
+++ b/crates/const-oid/cargo2android_viz.bp
@@ -1,5 +1,5 @@
visibility: [
"//external/rust/android-crates-io/crates/der:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
]
diff --git a/crates/coset/cargo_embargo.json b/crates/coset/cargo_embargo.json
index 65de91c..fb68599 100644
--- a/crates/coset/cargo_embargo.json
+++ b/crates/coset/cargo_embargo.json
@@ -23,6 +23,11 @@
"no_std": true
}
}
+ },
+ {
+ "features": [],
+ "generate_androidbp": false,
+ "generate_rulesmk": true
}
]
}
diff --git a/crates/coset/rules.mk b/crates/coset/rules.mk
index a41ac8f..78dd190 100644
--- a/crates/coset/rules.mk
+++ b/crates/coset/rules.mk
@@ -1,18 +1,16 @@
-# This file is generated by cargo2rulesmk.py --run.
-# Do not modify this file as changes will be overridden on upgrade.
+# This file is generated by cargo_embargo.
+# Do not modify this file after the LOCAL_DIR line
+# because the changes will be overridden on upgrade.
+# Content before the first line starting with LOCAL_DIR is preserved.
LOCAL_DIR := $(GET_LOCAL_DIR)
MODULE := $(LOCAL_DIR)
MODULE_CRATE_NAME := coset
-MODULE_SRCS := \
- $(LOCAL_DIR)/src/lib.rs \
-
+MODULE_RUST_CRATE_TYPES := rlib
+MODULE_SRCS := $(LOCAL_DIR)/src/lib.rs
MODULE_RUST_EDITION := 2018
-MODULE_RUSTFLAGS += \
- --cfg 'feature="default"' \
-
MODULE_LIBRARY_DEPS := \
- external/rust/crates/ciborium \
- external/rust/crates/ciborium-io \
+ $(call FIND_CRATE,ciborium) \
+ $(call FIND_CRATE,ciborium-io)
include make/library.mk
diff --git a/crates/der/Android.bp b/crates/der/Android.bp
index 327328c..dc53c97 100644
--- a/crates/der/Android.bp
+++ b/crates/der/Android.bp
@@ -45,7 +45,7 @@
"//external/rust/android-crates-io/crates/spki:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
],
@@ -90,7 +90,7 @@
"//external/rust/android-crates-io/crates/spki:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
],
diff --git a/crates/der/cargo2android_viz.bp b/crates/der/cargo2android_viz.bp
index 4cb13b9..224c6b4 100644
--- a/crates/der/cargo2android_viz.bp
+++ b/crates/der/cargo2android_viz.bp
@@ -3,7 +3,7 @@
"//external/rust/android-crates-io/crates/spki:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
]
diff --git a/crates/flagset/cargo_embargo.json b/crates/flagset/cargo_embargo.json
index 69a8042..53500c0 100644
--- a/crates/flagset/cargo_embargo.json
+++ b/crates/flagset/cargo_embargo.json
@@ -24,6 +24,10 @@
"no_std": true
}
}
+ },
+ {
+ "generate_androidbp": false,
+ "generate_rulesmk": true
}
]
}
diff --git a/crates/flagset/rules.mk b/crates/flagset/rules.mk
index 3dc41e6..4e3b902 100644
--- a/crates/flagset/rules.mk
+++ b/crates/flagset/rules.mk
@@ -1,14 +1,15 @@
-# This file is generated by cargo2rulesmk.py --run --features .
-# Do not modify this file as changes will be overridden on upgrade.
+# This file is generated by cargo_embargo.
+# Do not modify this file after the LOCAL_DIR line
+# because the changes will be overridden on upgrade.
+# Content before the first line starting with LOCAL_DIR is preserved.
LOCAL_DIR := $(GET_LOCAL_DIR)
MODULE := $(LOCAL_DIR)
MODULE_CRATE_NAME := flagset
-MODULE_SRCS := \
- $(LOCAL_DIR)/src/lib.rs \
-
+MODULE_RUST_CRATE_TYPES := rlib
+MODULE_SRCS := $(LOCAL_DIR)/src/lib.rs
MODULE_RUST_EDITION := 2018
MODULE_LIBRARY_DEPS := \
- external/rust/crates/serde \
+
include make/library.mk
diff --git a/crates/spki/Android.bp b/crates/spki/Android.bp
index b8d5bb5..ca51021 100644
--- a/crates/spki/Android.bp
+++ b/crates/spki/Android.bp
@@ -32,7 +32,7 @@
visibility: [
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
],
@@ -64,7 +64,7 @@
visibility: [
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
],
diff --git a/crates/spki/cargo2android_viz.bp b/crates/spki/cargo2android_viz.bp
index af9e79f..a008692 100644
--- a/crates/spki/cargo2android_viz.bp
+++ b/crates/spki/cargo2android_viz.bp
@@ -1,7 +1,7 @@
visibility: [
"//external/rust/android-crates-io/crates/pkcs1:__subpackages__",
"//external/rust/android-crates-io/crates/pkcs8:__subpackages__",
- "//external/rust/crates/x509-cert:__subpackages__",
+ "//external/rust/android-crates-io/crates/x509-cert:__subpackages__",
"//packages/modules/Virtualization:__subpackages__",
"//system/keymint:__subpackages__",
]
diff --git a/crates/tokio-util/.cargo-checksum.json b/crates/tokio-util/.cargo-checksum.json
new file mode 100644
index 0000000..394f5b4
--- /dev/null
+++ b/crates/tokio-util/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"80de2bb3ff688e2f0028bfab3d868688088c42d19949252909fd02eb36eb0252","Cargo.toml":"5c78756f4694814c097e87606dc9111a0110dd88a564116478abc7574721ebfd","LICENSE":"1a594f153f129c2de7b15f3262394bdca3dcc2da40058e3ea435c8473eb1f3a0","README.md":"91c8da557ba5fbfb5a9b6e58d5efd5fd1700dd836509cf017628155c249e192c","src/cfg.rs":"800248e35ac58cbff4327959990e83783cf0e6dd82fec4ccf3fd55038a92115c","src/codec/any_delimiter_codec.rs":"66a4c3aee5328ef8a8be20a58d6ce388bda2394bc70e4800cf52e95760a22e09","src/codec/bytes_codec.rs":"e8f14a93415768f5a8736cbcc0a1684742e3be6df1a6b60cb95bd146544eee74","src/codec/decoder.rs":"6fbff2ba49a0b82dcb6159e98a2c2d61914ee88dd462a406bec347db276bb58c","src/codec/encoder.rs":"e4544af47cdde075d1238ddee9555037912089bf25ce51cb4dd6f5d4f76ecf70","src/codec/framed.rs":"4ff6098906b964b68976fdceb75d77805ea02db9cf2bb1847f186d6e89e066b8","src/codec/framed_impl.rs":"d1ee46c00f6e5f8eb8a9ba1fa629be42ad7bb89289552045cfccc4efdc22c83c","src/codec/framed_read.rs":"367cc5517513c8fe256d8175b0497402f8b18dbf596aa19e6aa0c714772f0619","src/codec/framed_write.rs":"39f416786034f0f304abe4564cc74ad6483ff816687e8ab3e1bb8d4d380b3ee2","src/codec/length_delimited.rs":"d6281740a065da788c2819cf43bc06fb28b074f84cb1b6e719e397fe856f2f5d","src/codec/lines_codec.rs":"6696f39ea78111a2457e8a95953aa02ab31dc4c851784627e16dc7998df817a3","src/codec/mod.rs":"95a11e3018bb850ff5934ef48cbc5056bdf2758d130cfa357ad406f0531946ae","src/compat.rs":"67d839dc19381915b60a3e2db8ab98ff10c3aad0c99806ded1dbb1f0bd5dd261","src/context.rs":"45a23756c6ce6b834da0f1817f556cc5bdd16412ddfc1dc9082da8a56819741a","src/either.rs":"b0bc9737bf2915b75f68276a4d178e30a492b535d85f66a567035307c330516e","src/io/copy_to_bytes.rs":"6fc04baff3c89a76ce961ebd0cf7851042fa23f0a19adc6ab86554413cfa5afd","src/io/inspect.rs":"8efc0cb90d5b595de7f12184987bbc7c6e54a8c2286056b87cab7ad742345bfd","src/io/mod.rs":"316ddd0acc608d110cf3cf803f761da9025fdfb0deed6c2713c83671719dcd66","src/io/read_buf.rs":"7043c2fbec74e548395eb2f12073c41c1b30e2f2c283b30eddfb5a16125387d0","src/io/reader_stream.rs":"98d0819ef38f94d56d7085a82d29fd83bde92a9178bebfe73c4533d0022b3d94","src/io/sink_writer.rs":"ef5010f0e6c476f094790a2f2121e444b3d2ce74ec290b3bb66a64b36daf0d59","src/io/stream_reader.rs":"a2a3aaa166faf4ad0649dcea9b98e51a4ecc7160b6fb0e4a807637e0b23248a4","src/io/sync_bridge.rs":"740a19f8b156b6d53c5810ea20a374ee4cf5fdf3b45dcfc508b9cb0baca961cd","src/lib.rs":"2b40440ac4bea5ef423becce02d00260fb622ad7d3f51d4f7319d68b31db73e4","src/loom.rs":"9028ba504687ad5ec98f3c69387bc2424ec23324b1eed3df5082a9cf23c6502e","src/net/mod.rs":"a75736c1d71408b4f5fb0f0bdcb535cc113e430a2479e01e5fca733ef3fcb15b","src/net/unix/mod.rs":"d667dbb53d7003a15a4705ca0654b35be7165b56ac0d631a23e90d18027a1a90","src/sync/cancellation_token.rs":"352ca281cfedbb37b156044183e868bd80958ab683d1bc1706f4b6371f9b121d","src/sync/cancellation_token/guard.rs":"6582ba676c4126b4fa292221f94ddcb5fd6d3e0e2a794819fa424a8f661bff8a","src/sync/cancellation_token/tree_node.rs":"adb9c752be56a4e359d43cade75aa2b4e233c882221ee652a8e1b4c2ed1422dd","src/sync/mod.rs":"b84dcc8d561b847d1ba150061a0f3114bfe237f29cdfe6efbd344c541a5eccdd","src/sync/mpsc.rs":"9c872acb9897dcb49d3bfe7c00250e55d6835780ff99d8e71d2b6c439d572d54","src/sync/poll_semaphore.rs":"2a43f1404f2697fe1b374c5a915c4d812c64540571011ccaebcc081cad4325cc","src/sync/reusable_box.rs":"491fced798b9961b1aba8d1603110584e4657f5e8f6aed0336557e7bb8c240bc","src/sync/tests/loom_cancellation_token.rs":"689a734e2600eb37fce7afacb63abd27d82e6bfb29927f4924ba323ecff22b49","src/sync/tests/mod.rs":"01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b","src/task/join_map.rs":"8ea1319923a9e2597c8f638ec8b073df9823dd38551cc4dd7173f4ea60f966fe","src/task/mod.rs":"28afbcf0197fbb354e64159f47b843865759759e2322d3e310be1d8d0cd3962c","src/task/spawn_pinned.rs":"87e2de1dc75e1843b0ec0430175769b375ca2a0880c6c31bd3757ac659b029c3","src/task/task_tracker.rs":"0d7b0dbbb2944345a7a0a15ea85e13b451958094126b420b09404990a393b543","src/time/delay_queue.rs":"ed4f5f268dee32737f8b154893d2df73e14c9d5c12458572600999bc747d7335","src/time/mod.rs":"a76126419f30539dcceb72477251de79b38fe38278ef08b0743f1f716294fd9d","src/time/wheel/level.rs":"570b90de0bdb4d4aef43343fb4916a7a92a03bf51c300a089420700f099a404d","src/time/wheel/mod.rs":"22e69c084e3766dd333f9b6e05e4d23d4ee1bbb481a6035f1c437c0c2ec66356","src/time/wheel/stack.rs":"89e7667c1e204d6c5c4305118ace261f79bbfb2604dbe88ec1dd666695d8b469","src/udp/frame.rs":"7ca0c78acf6055a2ccecec6a4d176cdfd31baa334b8a55871df9aa1685e06c44","src/udp/mod.rs":"869302c0c15eb41f7079ef12ce03fa7c889a83152282ab0b7faf73d1c092ed4e","src/util/maybe_dangling.rs":"3ded8c0dd40d694ede4ac63ffcc1584f84bf401823833debf8edea04ae01bfe1","src/util/mod.rs":"e304438739aaa11a39f52a01fb646d1a611457dbbe2008b86433debea02f8cd7","src/util/poll_buf.rs":"302d5d3b68de72ee947eeffd1be83ea13c990cad875e69079467e0152beaea7a","tests/_require_full.rs":"f8dedb6ad88884209b074ff6f5faa4979528b32653b45ab8047d2ebb28e19122","tests/codecs.rs":"493df228f9dce98de69e0afa7be491d6fe4588e7a381a7910c28f248d2d038a6","tests/compat.rs":"e6bcf51881725214773a9255871f112c675ab56fcec2d9c419fa2e6af08a2749","tests/context.rs":"12780d99f343f57f66526dc81caa8183ff4a763f9be9d0197aa3ec04fea85c63","tests/framed.rs":"4e808fbc8d601138ff787b3603a377c23b3f42b4a7b882f9a1eb8cf1234c89e3","tests/framed_read.rs":"df41071388645518cc6b0700b75dd678219214b04de42605a0122f007f4ed281","tests/framed_stream.rs":"c3118fc5db62f225ad6d97f8b32ac03812b3b68cdab7a94d189f4a4d9337f13f","tests/framed_write.rs":"6334332e15f101f7a908824ffde6d36e0090dc97794475bd9fd3370cc2fb265b","tests/io_inspect.rs":"23b5760648641aca46815f486022455847690de914d18d6c4b6877dc9e682937","tests/io_reader_stream.rs":"1c9f79782c5574c5e489e86205bdb63b332fc0e8560fc4c2d602dfc2d2741a5e","tests/io_sink_writer.rs":"797657df0470db646249dd2ffae24e15a8c24eaeccd4718c9a6d54aeccdfb3f8","tests/io_stream_reader.rs":"d86e225eafbd196be3124147b1275bed384459e7ec3e8cb21775906253f75086","tests/io_sync_bridge.rs":"33ad93b28d2b4778c3c7c129236fdf9cb06ca4ae1e4af1e0f5de7177f48149b4","tests/length_delimited.rs":"42961048556ef955e222f5a154251dc2ff3de997fe324b79d23b1898d7f06650","tests/mpsc.rs":"8356ded38ddb7be0aa47dac13b3822ba8e23baea1e887ff8e150b2a951c265bd","tests/panic.rs":"349a9bb9b362371aabd3d61161082fd752ed03c13cd7e1790779e331fd22801a","tests/poll_semaphore.rs":"e970eac2e3ebd7835dd3e1b59dd8779a51bb24011593cd7456c1d905fce7fb6f","tests/reusable_box.rs":"e37643b1bfa28c7e769e95f973686a7c30ac659484fd37d758a14e96000fd548","tests/spawn_pinned.rs":"aea2409b5f03ae976409faca153a33aac27a7465b7d3c0e4bea7a27efde1f461","tests/sync_cancellation_token.rs":"8889b95ae5d2d60d97fad791be1dff142d06b47ecf89af99e8b24dcc93ed6d9f","tests/task_join_map.rs":"f72e6012944ed040ea298c869dac5cd0662a915b8ec832a55d08478e4cee1b49","tests/task_tracker.rs":"41c7d272fb1d96d11b98ecbeb0c101cb3c60c321c01f7172360444cb9c6fa5ec","tests/time_delay_queue.rs":"f5640181f2bf9d9708156efaf8e9d11f9f3bb15afac56ccfafab5c3da09cc092","tests/udp.rs":"77e44464d99f8ee79c31e675861a2958d4c31539de9be49444e2103547fdfcca"},"package":"5419f34732d9eb6ee4c3578b7989078579b7f039cbbb9ca2c4da015749371e15"}
\ No newline at end of file
diff --git a/crates/tokio-util/Android.bp b/crates/tokio-util/Android.bp
new file mode 100644
index 0000000..4a0a8bf
--- /dev/null
+++ b/crates/tokio-util/Android.bp
@@ -0,0 +1,57 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tokio-util_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tokio-util_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtokio_util",
+ host_supported: true,
+ crate_name: "tokio_util",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.7.10",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ features: [
+ "codec",
+ "compat",
+ "full",
+ "futures-io",
+ "futures-util",
+ "hashbrown",
+ "io",
+ "io-util",
+ "net",
+ "rt",
+ "slab",
+ "time",
+ "tracing",
+ ],
+ rustlibs: [
+ "libbytes",
+ "libfutures_core",
+ "libfutures_io",
+ "libfutures_sink",
+ "libfutures_util",
+ "libpin_project_lite",
+ "libslab",
+ "libtokio",
+ "libtracing",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+ min_sdk_version: "29",
+}
diff --git a/crates/tokio-util/CHANGELOG.md b/crates/tokio-util/CHANGELOG.md
new file mode 100644
index 0000000..b98092c
--- /dev/null
+++ b/crates/tokio-util/CHANGELOG.md
@@ -0,0 +1,406 @@
+# 0.7.10 (October 24th, 2023)
+
+### Added
+
+- task: add `TaskTracker` ([#6033])
+- task: add `JoinMap::keys` ([#6046])
+- io: implement `Seek` for `SyncIoBridge` ([#6058])
+
+### Changed
+
+- deps: update hashbrown to 0.14 ([#6102])
+
+[#6033]: https://github.com/tokio-rs/tokio/pull/6033
+[#6046]: https://github.com/tokio-rs/tokio/pull/6046
+[#6058]: https://github.com/tokio-rs/tokio/pull/6058
+[#6102]: https://github.com/tokio-rs/tokio/pull/6102
+
+# 0.7.9 (September 20th, 2023)
+
+### Added
+
+- io: add passthrough `AsyncRead`/`AsyncWrite` to `InspectWriter`/`InspectReader` ([#5739])
+- task: add spawn blocking methods to `JoinMap` ([#5797])
+- io: pass through traits for `StreamReader` and `SinkWriter` ([#5941])
+- io: add `SyncIoBridge::into_inner` ([#5971])
+
+### Fixed
+
+- sync: handle possibly dangling reference safely ([#5812])
+- util: fix broken intra-doc link ([#5849])
+- compat: fix clippy warnings ([#5891])
+
+### Documented
+
+- codec: Specify the line ending of `LinesCodec` ([#5982])
+
+[#5739]: https://github.com/tokio-rs/tokio/pull/5739
+[#5797]: https://github.com/tokio-rs/tokio/pull/5797
+[#5941]: https://github.com/tokio-rs/tokio/pull/5941
+[#5971]: https://github.com/tokio-rs/tokio/pull/5971
+[#5812]: https://github.com/tokio-rs/tokio/pull/5812
+[#5849]: https://github.com/tokio-rs/tokio/pull/5849
+[#5891]: https://github.com/tokio-rs/tokio/pull/5891
+[#5982]: https://github.com/tokio-rs/tokio/pull/5982
+
+# 0.7.8 (April 25th, 2023)
+
+This release bumps the MSRV of tokio-util to 1.56.
+
+### Added
+
+- time: add `DelayQueue::peek` ([#5569])
+
+### Changed
+
+This release contains one performance improvement:
+
+- sync: try to lock the parent first in `CancellationToken` ([#5561])
+
+### Fixed
+
+- time: fix panic in `DelayQueue` ([#5630])
+
+### Documented
+
+- sync: improve `CancellationToken` doc on child tokens ([#5632])
+
+[#5561]: https://github.com/tokio-rs/tokio/pull/5561
+[#5569]: https://github.com/tokio-rs/tokio/pull/5569
+[#5630]: https://github.com/tokio-rs/tokio/pull/5630
+[#5632]: https://github.com/tokio-rs/tokio/pull/5632
+
+# 0.7.7 (February 12, 2023)
+
+This release reverts the removal of the `Encoder` bound on the `FramedParts`
+constructor from [#5280] since it turned out to be a breaking change. ([#5450])
+
+[#5450]: https://github.com/tokio-rs/tokio/pull/5450
+
+# 0.7.6 (February 10, 2023)
+
+This release fixes a compilation failure in 0.7.5 when it is used together with
+Tokio version 1.21 and unstable features are enabled. ([#5445])
+
+[#5445]: https://github.com/tokio-rs/tokio/pull/5445
+
+# 0.7.5 (February 9, 2023)
+
+This release fixes an accidental breaking change where `UnwindSafe` was
+accidentally removed from `CancellationToken`.
+
+### Added
+- codec: add `Framed::backpressure_boundary` ([#5124])
+- io: add `InspectReader` and `InspectWriter` ([#5033])
+- io: add `tokio_util::io::{CopyToBytes, SinkWriter}` ([#5070], [#5436])
+- io: impl `std::io::BufRead` on `SyncIoBridge` ([#5265])
+- sync: add `PollSemaphore::poll_acquire_many` ([#5137])
+- sync: add owned future for `CancellationToken` ([#5153])
+- time: add `DelayQueue::try_remove` ([#5052])
+
+### Fixed
+- codec: fix `LengthDelimitedCodec` buffer over-reservation ([#4997])
+- sync: impl `UnwindSafe` on `CancellationToken` ([#5438])
+- util: remove `Encoder` bound on `FramedParts` constructor ([#5280])
+
+### Documented
+- io: add lines example for `StreamReader` ([#5145])
+
+[#4997]: https://github.com/tokio-rs/tokio/pull/4997
+[#5033]: https://github.com/tokio-rs/tokio/pull/5033
+[#5052]: https://github.com/tokio-rs/tokio/pull/5052
+[#5070]: https://github.com/tokio-rs/tokio/pull/5070
+[#5124]: https://github.com/tokio-rs/tokio/pull/5124
+[#5137]: https://github.com/tokio-rs/tokio/pull/5137
+[#5145]: https://github.com/tokio-rs/tokio/pull/5145
+[#5153]: https://github.com/tokio-rs/tokio/pull/5153
+[#5265]: https://github.com/tokio-rs/tokio/pull/5265
+[#5280]: https://github.com/tokio-rs/tokio/pull/5280
+[#5436]: https://github.com/tokio-rs/tokio/pull/5436
+[#5438]: https://github.com/tokio-rs/tokio/pull/5438
+
+# 0.7.4 (September 8, 2022)
+
+### Added
+
+- io: add `SyncIoBridge::shutdown()` ([#4938])
+- task: improve `LocalPoolHandle` ([#4680])
+
+### Fixed
+
+- util: add `track_caller` to public APIs ([#4785])
+
+### Unstable
+
+- task: fix compilation errors in `JoinMap` with Tokio v1.21.0 ([#4755])
+- task: remove the unstable, deprecated `JoinMap::join_one` ([#4920])
+
+[#4680]: https://github.com/tokio-rs/tokio/pull/4680
+[#4755]: https://github.com/tokio-rs/tokio/pull/4755
+[#4785]: https://github.com/tokio-rs/tokio/pull/4785
+[#4920]: https://github.com/tokio-rs/tokio/pull/4920
+[#4938]: https://github.com/tokio-rs/tokio/pull/4938
+
+# 0.7.3 (June 4, 2022)
+
+### Changed
+
+- tracing: don't require default tracing features ([#4592])
+- util: simplify implementation of `ReusableBoxFuture` ([#4675])
+
+### Added (unstable)
+
+- task: add `JoinMap` ([#4640], [#4697])
+
+[#4592]: https://github.com/tokio-rs/tokio/pull/4592
+[#4640]: https://github.com/tokio-rs/tokio/pull/4640
+[#4675]: https://github.com/tokio-rs/tokio/pull/4675
+[#4697]: https://github.com/tokio-rs/tokio/pull/4697
+
+# 0.7.2 (May 14, 2022)
+
+This release contains a rewrite of `CancellationToken` that fixes a memory leak. ([#4652])
+
+[#4652]: https://github.com/tokio-rs/tokio/pull/4652
+
+# 0.7.1 (February 21, 2022)
+
+### Added
+
+- codec: add `length_field_type` to `LengthDelimitedCodec` builder ([#4508])
+- io: add `StreamReader::into_inner_with_chunk()` ([#4559])
+
+### Changed
+
+- switch from log to tracing ([#4539])
+
+### Fixed
+
+- sync: fix waker update condition in `CancellationToken` ([#4497])
+- bumped tokio dependency to 1.6 to satisfy minimum requirements ([#4490])
+
+[#4490]: https://github.com/tokio-rs/tokio/pull/4490
+[#4497]: https://github.com/tokio-rs/tokio/pull/4497
+[#4508]: https://github.com/tokio-rs/tokio/pull/4508
+[#4539]: https://github.com/tokio-rs/tokio/pull/4539
+[#4559]: https://github.com/tokio-rs/tokio/pull/4559
+
+# 0.7.0 (February 9, 2022)
+
+### Added
+
+- task: add `spawn_pinned` ([#3370])
+- time: add `shrink_to_fit` and `compact` methods to `DelayQueue` ([#4170])
+- codec: improve `Builder::max_frame_length` docs ([#4352])
+- codec: add mutable reference getters for codecs to pinned `Framed` ([#4372])
+- net: add generic trait to combine `UnixListener` and `TcpListener` ([#4385])
+- codec: implement `Framed::map_codec` ([#4427])
+- codec: implement `Encoder<BytesMut>` for `BytesCodec` ([#4465])
+
+### Changed
+
+- sync: add lifetime parameter to `ReusableBoxFuture` ([#3762])
+- sync: refactored `PollSender<T>` to fix a subtly broken `Sink<T>` implementation ([#4214])
+- time: remove error case from the infallible `DelayQueue::poll_elapsed` ([#4241])
+
+[#3370]: https://github.com/tokio-rs/tokio/pull/3370
+[#4170]: https://github.com/tokio-rs/tokio/pull/4170
+[#4352]: https://github.com/tokio-rs/tokio/pull/4352
+[#4372]: https://github.com/tokio-rs/tokio/pull/4372
+[#4385]: https://github.com/tokio-rs/tokio/pull/4385
+[#4427]: https://github.com/tokio-rs/tokio/pull/4427
+[#4465]: https://github.com/tokio-rs/tokio/pull/4465
+[#3762]: https://github.com/tokio-rs/tokio/pull/3762
+[#4214]: https://github.com/tokio-rs/tokio/pull/4214
+[#4241]: https://github.com/tokio-rs/tokio/pull/4241
+
+# 0.6.10 (May 14, 2021)
+
+This is a backport for the memory leak in `CancellationToken` that was originally fixed in 0.7.2. ([#4652])
+
+[#4652]: https://github.com/tokio-rs/tokio/pull/4652
+
+# 0.6.9 (October 29, 2021)
+
+### Added
+
+- codec: implement `Clone` for `LengthDelimitedCodec` ([#4089])
+- io: add `SyncIoBridge` ([#4146])
+
+### Fixed
+
+- time: update deadline on removal in `DelayQueue` ([#4178])
+- codec: Update stream impl for Framed to return None after Err ([#4166])
+
+[#4089]: https://github.com/tokio-rs/tokio/pull/4089
+[#4146]: https://github.com/tokio-rs/tokio/pull/4146
+[#4166]: https://github.com/tokio-rs/tokio/pull/4166
+[#4178]: https://github.com/tokio-rs/tokio/pull/4178
+
+# 0.6.8 (September 3, 2021)
+
+### Added
+
+- sync: add drop guard for `CancellationToken` ([#3839])
+- compact: added `AsyncSeek` compat ([#4078])
+- time: expose `Key` used in `DelayQueue`'s `Expired` ([#4081])
+- io: add `with_capacity` to `ReaderStream` ([#4086])
+
+### Fixed
+
+- codec: remove unnecessary `doc(cfg(...))` ([#3989])
+
+[#3839]: https://github.com/tokio-rs/tokio/pull/3839
+[#4078]: https://github.com/tokio-rs/tokio/pull/4078
+[#4081]: https://github.com/tokio-rs/tokio/pull/4081
+[#4086]: https://github.com/tokio-rs/tokio/pull/4086
+[#3989]: https://github.com/tokio-rs/tokio/pull/3989
+
+# 0.6.7 (May 14, 2021)
+
+### Added
+
+- udp: make `UdpFramed` take `Borrow<UdpSocket>` ([#3451])
+- compat: implement `AsRawFd`/`AsRawHandle` for `Compat<T>` ([#3765])
+
+[#3451]: https://github.com/tokio-rs/tokio/pull/3451
+[#3765]: https://github.com/tokio-rs/tokio/pull/3765
+
+# 0.6.6 (April 12, 2021)
+
+### Added
+
+- util: makes `Framed` and `FramedStream` resumable after eof ([#3272])
+- util: add `PollSemaphore::{add_permits, available_permits}` ([#3683])
+
+### Fixed
+
+- chore: avoid allocation if `PollSemaphore` is unused ([#3634])
+
+[#3272]: https://github.com/tokio-rs/tokio/pull/3272
+[#3634]: https://github.com/tokio-rs/tokio/pull/3634
+[#3683]: https://github.com/tokio-rs/tokio/pull/3683
+
+# 0.6.5 (March 20, 2021)
+
+### Fixed
+
+- util: annotate time module as requiring `time` feature ([#3606])
+
+[#3606]: https://github.com/tokio-rs/tokio/pull/3606
+
+# 0.6.4 (March 9, 2021)
+
+### Added
+
+- codec: `AnyDelimiter` codec ([#3406])
+- sync: add pollable `mpsc::Sender` ([#3490])
+
+### Fixed
+
+- codec: `LinesCodec` should only return `MaxLineLengthExceeded` once per line ([#3556])
+- sync: fuse PollSemaphore ([#3578])
+
+[#3406]: https://github.com/tokio-rs/tokio/pull/3406
+[#3490]: https://github.com/tokio-rs/tokio/pull/3490
+[#3556]: https://github.com/tokio-rs/tokio/pull/3556
+[#3578]: https://github.com/tokio-rs/tokio/pull/3578
+
+# 0.6.3 (January 31, 2021)
+
+### Added
+
+- sync: add `ReusableBoxFuture` utility ([#3464])
+
+### Changed
+
+- sync: use `ReusableBoxFuture` for `PollSemaphore` ([#3463])
+- deps: remove `async-stream` dependency ([#3463])
+- deps: remove `tokio-stream` dependency ([#3487])
+
+# 0.6.2 (January 21, 2021)
+
+### Added
+
+- sync: add pollable `Semaphore` ([#3444])
+
+### Fixed
+
+- time: fix panics on updating `DelayQueue` entries ([#3270])
+
+# 0.6.1 (January 12, 2021)
+
+### Added
+
+- codec: `get_ref()`, `get_mut()`, `get_pin_mut()` and `into_inner()` for
+ `Framed`, `FramedRead`, `FramedWrite` and `StreamReader` ([#3364]).
+- codec: `write_buffer()` and `write_buffer_mut()` for `Framed` and
+ `FramedWrite` ([#3387]).
+
+# 0.6.0 (December 23, 2020)
+
+### Changed
+- depend on `tokio` 1.0.
+
+### Added
+- rt: add constructors to `TokioContext` (#3221).
+
+# 0.5.1 (December 3, 2020)
+
+### Added
+- io: `poll_read_buf` util fn (#2972).
+- io: `poll_write_buf` util fn with vectored write support (#3156).
+
+# 0.5.0 (October 30, 2020)
+
+### Changed
+- io: update `bytes` to 0.6 (#3071).
+
+# 0.4.0 (October 15, 2020)
+
+### Added
+- sync: `CancellationToken` for coordinating task cancellation (#2747).
+- rt: `TokioContext` sets the Tokio runtime for the duration of a future (#2791)
+- io: `StreamReader`/`ReaderStream` map between `AsyncRead` values and `Stream`
+ of bytes (#2788).
+- time: `DelayQueue` to manage many delays (#2897).
+
+# 0.3.1 (March 18, 2020)
+
+### Fixed
+
+- Adjust minimum-supported Tokio version to v0.2.5 to account for an internal
+ dependency on features in that version of Tokio. ([#2326])
+
+# 0.3.0 (March 4, 2020)
+
+### Changed
+
+- **Breaking Change**: Change `Encoder` trait to take a generic `Item` parameter, which allows
+ codec writers to pass references into `Framed` and `FramedWrite` types. ([#1746])
+
+### Added
+
+- Add futures-io/tokio::io compatibility layer. ([#2117])
+- Add `Framed::with_capacity`. ([#2215])
+
+### Fixed
+
+- Use advance over split_to when data is not needed. ([#2198])
+
+# 0.2.0 (November 26, 2019)
+
+- Initial release
+
+[#3487]: https://github.com/tokio-rs/tokio/pull/3487
+[#3464]: https://github.com/tokio-rs/tokio/pull/3464
+[#3463]: https://github.com/tokio-rs/tokio/pull/3463
+[#3444]: https://github.com/tokio-rs/tokio/pull/3444
+[#3387]: https://github.com/tokio-rs/tokio/pull/3387
+[#3364]: https://github.com/tokio-rs/tokio/pull/3364
+[#3270]: https://github.com/tokio-rs/tokio/pull/3270
+[#2326]: https://github.com/tokio-rs/tokio/pull/2326
+[#2215]: https://github.com/tokio-rs/tokio/pull/2215
+[#2198]: https://github.com/tokio-rs/tokio/pull/2198
+[#2117]: https://github.com/tokio-rs/tokio/pull/2117
+[#1746]: https://github.com/tokio-rs/tokio/pull/1746
diff --git a/crates/tokio-util/Cargo.toml b/crates/tokio-util/Cargo.toml
new file mode 100644
index 0000000..51e9a96
--- /dev/null
+++ b/crates/tokio-util/Cargo.toml
@@ -0,0 +1,134 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.56"
+name = "tokio-util"
+version = "0.7.10"
+authors = ["Tokio Contributors <[email protected]>"]
+description = """
+Additional utilities for working with Tokio.
+"""
+homepage = "https://tokio.rs"
+readme = "README.md"
+categories = ["asynchronous"]
+license = "MIT"
+repository = "https://github.com/tokio-rs/tokio"
+
+[package.metadata.docs.rs]
+all-features = true
+rustc-args = [
+ "--cfg",
+ "docsrs",
+ "--cfg",
+ "tokio_unstable",
+]
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+ "--cfg",
+ "tokio_unstable",
+]
+
+[dependencies.bytes]
+version = "1.0.0"
+
+[dependencies.futures-core]
+version = "0.3.0"
+
+[dependencies.futures-io]
+version = "0.3.0"
+optional = true
+
+[dependencies.futures-sink]
+version = "0.3.0"
+
+[dependencies.futures-util]
+version = "0.3.0"
+optional = true
+
+[dependencies.pin-project-lite]
+version = "0.2.11"
+
+[dependencies.slab]
+version = "0.4.4"
+optional = true
+
+[dependencies.tokio]
+version = "1.28.0"
+features = ["sync"]
+
+[dependencies.tracing]
+version = "0.1.25"
+features = ["std"]
+optional = true
+default-features = false
+
+[dev-dependencies.async-stream]
+version = "0.3.0"
+
+[dev-dependencies.futures]
+version = "0.3.0"
+
+[dev-dependencies.futures-test]
+version = "0.3.5"
+
+[dev-dependencies.parking_lot]
+version = "0.12.0"
+
+[dev-dependencies.tempfile]
+version = "3.1.0"
+
+[dev-dependencies.tokio]
+version = "1.0.0"
+features = ["full"]
+
+[dev-dependencies.tokio-stream]
+version = "0.1"
+
+[dev-dependencies.tokio-test]
+version = "0.4.0"
+
+[features]
+__docs_rs = ["futures-util"]
+codec = ["tracing"]
+compat = ["futures-io"]
+default = []
+full = [
+ "codec",
+ "compat",
+ "io-util",
+ "time",
+ "net",
+ "rt",
+]
+io = []
+io-util = [
+ "io",
+ "tokio/rt",
+ "tokio/io-util",
+]
+net = ["tokio/net"]
+rt = [
+ "tokio/rt",
+ "tokio/sync",
+ "futures-util",
+ "hashbrown",
+]
+time = [
+ "tokio/time",
+ "slab",
+]
+
+[target."cfg(tokio_unstable)".dependencies.hashbrown]
+version = "0.14.0"
+optional = true
diff --git a/crates/tokio-util/LICENSE b/crates/tokio-util/LICENSE
new file mode 100644
index 0000000..8bdf6bd
--- /dev/null
+++ b/crates/tokio-util/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2023 Tokio Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tokio-util/METADATA b/crates/tokio-util/METADATA
new file mode 100644
index 0000000..ffaab87
--- /dev/null
+++ b/crates/tokio-util/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/tokio-util
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tokio-util"
+description: "Utilities for working with Tokio."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 5
+ }
+ homepage: "https://crates.io/crates/tokio-util"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tokio-util/tokio-util-0.7.10.crate"
+ version: "0.7.10"
+ }
+}
diff --git a/crates/tokio-util/MODULE_LICENSE_MIT b/crates/tokio-util/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tokio-util/MODULE_LICENSE_MIT
diff --git a/crates/tokio-util/README.md b/crates/tokio-util/README.md
new file mode 100644
index 0000000..0d74f36
--- /dev/null
+++ b/crates/tokio-util/README.md
@@ -0,0 +1,13 @@
+# tokio-util
+
+Utilities for working with Tokio.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tokio by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tokio-util/cargo_embargo.json b/crates/tokio-util/cargo_embargo.json
new file mode 100644
index 0000000..9487e2e
--- /dev/null
+++ b/crates/tokio-util/cargo_embargo.json
@@ -0,0 +1,7 @@
+{
+ "features": [
+ "full"
+ ],
+ "min_sdk_version": "29",
+ "run_cargo": false
+}
diff --git a/crates/tokio-util/src/cfg.rs b/crates/tokio-util/src/cfg.rs
new file mode 100644
index 0000000..4035255
--- /dev/null
+++ b/crates/tokio-util/src/cfg.rs
@@ -0,0 +1,71 @@
+macro_rules! cfg_codec {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "codec")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "codec")))]
+ $item
+ )*
+ }
+}
+
+macro_rules! cfg_compat {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "compat")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "compat")))]
+ $item
+ )*
+ }
+}
+
+macro_rules! cfg_net {
+ ($($item:item)*) => {
+ $(
+ #[cfg(all(feature = "net", feature = "codec"))]
+ #[cfg_attr(docsrs, doc(cfg(all(feature = "net", feature = "codec"))))]
+ $item
+ )*
+ }
+}
+
+macro_rules! cfg_io {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "io")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "io")))]
+ $item
+ )*
+ }
+}
+
+cfg_io! {
+ macro_rules! cfg_io_util {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "io-util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "io-util")))]
+ $item
+ )*
+ }
+ }
+}
+
+macro_rules! cfg_rt {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "rt")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ $item
+ )*
+ }
+}
+
+macro_rules! cfg_time {
+ ($($item:item)*) => {
+ $(
+ #[cfg(feature = "time")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "time")))]
+ $item
+ )*
+ }
+}
diff --git a/crates/tokio-util/src/codec/any_delimiter_codec.rs b/crates/tokio-util/src/codec/any_delimiter_codec.rs
new file mode 100644
index 0000000..3dbfd45
--- /dev/null
+++ b/crates/tokio-util/src/codec/any_delimiter_codec.rs
@@ -0,0 +1,263 @@
+use crate::codec::decoder::Decoder;
+use crate::codec::encoder::Encoder;
+
+use bytes::{Buf, BufMut, Bytes, BytesMut};
+use std::{cmp, fmt, io, str, usize};
+
+const DEFAULT_SEEK_DELIMITERS: &[u8] = b",;\n\r";
+const DEFAULT_SEQUENCE_WRITER: &[u8] = b",";
+/// A simple [`Decoder`] and [`Encoder`] implementation that splits up data into chunks based on any character in the given delimiter string.
+///
+/// [`Decoder`]: crate::codec::Decoder
+/// [`Encoder`]: crate::codec::Encoder
+///
+/// # Example
+/// Decode string of bytes containing various different delimiters.
+///
+/// [`BytesMut`]: bytes::BytesMut
+/// [`Error`]: std::io::Error
+///
+/// ```
+/// use tokio_util::codec::{AnyDelimiterCodec, Decoder};
+/// use bytes::{BufMut, BytesMut};
+///
+/// #
+/// # #[tokio::main(flavor = "current_thread")]
+/// # async fn main() -> Result<(), std::io::Error> {
+/// let mut codec = AnyDelimiterCodec::new(b",;\r\n".to_vec(),b";".to_vec());
+/// let buf = &mut BytesMut::new();
+/// buf.reserve(200);
+/// buf.put_slice(b"chunk 1,chunk 2;chunk 3\n\r");
+/// assert_eq!("chunk 1", codec.decode(buf).unwrap().unwrap());
+/// assert_eq!("chunk 2", codec.decode(buf).unwrap().unwrap());
+/// assert_eq!("chunk 3", codec.decode(buf).unwrap().unwrap());
+/// assert_eq!("", codec.decode(buf).unwrap().unwrap());
+/// assert_eq!(None, codec.decode(buf).unwrap());
+/// # Ok(())
+/// # }
+/// ```
+///
+#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
+pub struct AnyDelimiterCodec {
+ // Stored index of the next index to examine for the delimiter character.
+ // This is used to optimize searching.
+ // For example, if `decode` was called with `abc` and the delimiter is '{}', it would hold `3`,
+ // because that is the next index to examine.
+ // The next time `decode` is called with `abcde}`, the method will
+ // only look at `de}` before returning.
+ next_index: usize,
+
+ /// The maximum length for a given chunk. If `usize::MAX`, chunks will be
+ /// read until a delimiter character is reached.
+ max_length: usize,
+
+ /// Are we currently discarding the remainder of a chunk which was over
+ /// the length limit?
+ is_discarding: bool,
+
+ /// The bytes that are using for search during decode
+ seek_delimiters: Vec<u8>,
+
+ /// The bytes that are using for encoding
+ sequence_writer: Vec<u8>,
+}
+
+impl AnyDelimiterCodec {
+ /// Returns a `AnyDelimiterCodec` for splitting up data into chunks.
+ ///
+ /// # Note
+ ///
+ /// The returned `AnyDelimiterCodec` will not have an upper bound on the length
+ /// of a buffered chunk. See the documentation for [`new_with_max_length`]
+ /// for information on why this could be a potential security risk.
+ ///
+ /// [`new_with_max_length`]: crate::codec::AnyDelimiterCodec::new_with_max_length()
+ pub fn new(seek_delimiters: Vec<u8>, sequence_writer: Vec<u8>) -> AnyDelimiterCodec {
+ AnyDelimiterCodec {
+ next_index: 0,
+ max_length: usize::MAX,
+ is_discarding: false,
+ seek_delimiters,
+ sequence_writer,
+ }
+ }
+
+ /// Returns a `AnyDelimiterCodec` with a maximum chunk length limit.
+ ///
+ /// If this is set, calls to `AnyDelimiterCodec::decode` will return a
+ /// [`AnyDelimiterCodecError`] when a chunk exceeds the length limit. Subsequent calls
+ /// will discard up to `limit` bytes from that chunk until a delimiter
+ /// character is reached, returning `None` until the delimiter over the limit
+ /// has been fully discarded. After that point, calls to `decode` will
+ /// function as normal.
+ ///
+ /// # Note
+ ///
+ /// Setting a length limit is highly recommended for any `AnyDelimiterCodec` which
+ /// will be exposed to untrusted input. Otherwise, the size of the buffer
+ /// that holds the chunk currently being read is unbounded. An attacker could
+ /// exploit this unbounded buffer by sending an unbounded amount of input
+ /// without any delimiter characters, causing unbounded memory consumption.
+ ///
+ /// [`AnyDelimiterCodecError`]: crate::codec::AnyDelimiterCodecError
+ pub fn new_with_max_length(
+ seek_delimiters: Vec<u8>,
+ sequence_writer: Vec<u8>,
+ max_length: usize,
+ ) -> Self {
+ AnyDelimiterCodec {
+ max_length,
+ ..AnyDelimiterCodec::new(seek_delimiters, sequence_writer)
+ }
+ }
+
+ /// Returns the maximum chunk length when decoding.
+ ///
+ /// ```
+ /// use std::usize;
+ /// use tokio_util::codec::AnyDelimiterCodec;
+ ///
+ /// let codec = AnyDelimiterCodec::new(b",;\n".to_vec(), b";".to_vec());
+ /// assert_eq!(codec.max_length(), usize::MAX);
+ /// ```
+ /// ```
+ /// use tokio_util::codec::AnyDelimiterCodec;
+ ///
+ /// let codec = AnyDelimiterCodec::new_with_max_length(b",;\n".to_vec(), b";".to_vec(), 256);
+ /// assert_eq!(codec.max_length(), 256);
+ /// ```
+ pub fn max_length(&self) -> usize {
+ self.max_length
+ }
+}
+
+impl Decoder for AnyDelimiterCodec {
+ type Item = Bytes;
+ type Error = AnyDelimiterCodecError;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<Bytes>, AnyDelimiterCodecError> {
+ loop {
+ // Determine how far into the buffer we'll search for a delimiter. If
+ // there's no max_length set, we'll read to the end of the buffer.
+ let read_to = cmp::min(self.max_length.saturating_add(1), buf.len());
+
+ let new_chunk_offset = buf[self.next_index..read_to].iter().position(|b| {
+ self.seek_delimiters
+ .iter()
+ .any(|delimiter| *b == *delimiter)
+ });
+
+ match (self.is_discarding, new_chunk_offset) {
+ (true, Some(offset)) => {
+ // If we found a new chunk, discard up to that offset and
+ // then stop discarding. On the next iteration, we'll try
+ // to read a chunk normally.
+ buf.advance(offset + self.next_index + 1);
+ self.is_discarding = false;
+ self.next_index = 0;
+ }
+ (true, None) => {
+ // Otherwise, we didn't find a new chunk, so we'll discard
+ // everything we read. On the next iteration, we'll continue
+ // discarding up to max_len bytes unless we find a new chunk.
+ buf.advance(read_to);
+ self.next_index = 0;
+ if buf.is_empty() {
+ return Ok(None);
+ }
+ }
+ (false, Some(offset)) => {
+ // Found a chunk!
+ let new_chunk_index = offset + self.next_index;
+ self.next_index = 0;
+ let mut chunk = buf.split_to(new_chunk_index + 1);
+ chunk.truncate(chunk.len() - 1);
+ let chunk = chunk.freeze();
+ return Ok(Some(chunk));
+ }
+ (false, None) if buf.len() > self.max_length => {
+ // Reached the maximum length without finding a
+ // new chunk, return an error and start discarding on the
+ // next call.
+ self.is_discarding = true;
+ return Err(AnyDelimiterCodecError::MaxChunkLengthExceeded);
+ }
+ (false, None) => {
+ // We didn't find a chunk or reach the length limit, so the next
+ // call will resume searching at the current offset.
+ self.next_index = read_to;
+ return Ok(None);
+ }
+ }
+ }
+ }
+
+ fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<Bytes>, AnyDelimiterCodecError> {
+ Ok(match self.decode(buf)? {
+ Some(frame) => Some(frame),
+ None => {
+ // return remaining data, if any
+ if buf.is_empty() {
+ None
+ } else {
+ let chunk = buf.split_to(buf.len());
+ self.next_index = 0;
+ Some(chunk.freeze())
+ }
+ }
+ })
+ }
+}
+
+impl<T> Encoder<T> for AnyDelimiterCodec
+where
+ T: AsRef<str>,
+{
+ type Error = AnyDelimiterCodecError;
+
+ fn encode(&mut self, chunk: T, buf: &mut BytesMut) -> Result<(), AnyDelimiterCodecError> {
+ let chunk = chunk.as_ref();
+ buf.reserve(chunk.len() + 1);
+ buf.put(chunk.as_bytes());
+ buf.put(self.sequence_writer.as_ref());
+
+ Ok(())
+ }
+}
+
+impl Default for AnyDelimiterCodec {
+ fn default() -> Self {
+ Self::new(
+ DEFAULT_SEEK_DELIMITERS.to_vec(),
+ DEFAULT_SEQUENCE_WRITER.to_vec(),
+ )
+ }
+}
+
+/// An error occurred while encoding or decoding a chunk.
+#[derive(Debug)]
+pub enum AnyDelimiterCodecError {
+ /// The maximum chunk length was exceeded.
+ MaxChunkLengthExceeded,
+ /// An IO error occurred.
+ Io(io::Error),
+}
+
+impl fmt::Display for AnyDelimiterCodecError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ AnyDelimiterCodecError::MaxChunkLengthExceeded => {
+ write!(f, "max chunk length exceeded")
+ }
+ AnyDelimiterCodecError::Io(e) => write!(f, "{}", e),
+ }
+ }
+}
+
+impl From<io::Error> for AnyDelimiterCodecError {
+ fn from(e: io::Error) -> AnyDelimiterCodecError {
+ AnyDelimiterCodecError::Io(e)
+ }
+}
+
+impl std::error::Error for AnyDelimiterCodecError {}
diff --git a/crates/tokio-util/src/codec/bytes_codec.rs b/crates/tokio-util/src/codec/bytes_codec.rs
new file mode 100644
index 0000000..ceab228
--- /dev/null
+++ b/crates/tokio-util/src/codec/bytes_codec.rs
@@ -0,0 +1,86 @@
+use crate::codec::decoder::Decoder;
+use crate::codec::encoder::Encoder;
+
+use bytes::{BufMut, Bytes, BytesMut};
+use std::io;
+
+/// A simple [`Decoder`] and [`Encoder`] implementation that just ships bytes around.
+///
+/// [`Decoder`]: crate::codec::Decoder
+/// [`Encoder`]: crate::codec::Encoder
+///
+/// # Example
+///
+/// Turn an [`AsyncRead`] into a stream of `Result<`[`BytesMut`]`, `[`Error`]`>`.
+///
+/// [`AsyncRead`]: tokio::io::AsyncRead
+/// [`BytesMut`]: bytes::BytesMut
+/// [`Error`]: std::io::Error
+///
+/// ```
+/// # mod hidden {
+/// # #[allow(unused_imports)]
+/// use tokio::fs::File;
+/// # }
+/// use tokio::io::AsyncRead;
+/// use tokio_util::codec::{FramedRead, BytesCodec};
+///
+/// # enum File {}
+/// # impl File {
+/// # async fn open(_name: &str) -> Result<impl AsyncRead, std::io::Error> {
+/// # use std::io::Cursor;
+/// # Ok(Cursor::new(vec![0, 1, 2, 3, 4, 5]))
+/// # }
+/// # }
+/// #
+/// # #[tokio::main(flavor = "current_thread")]
+/// # async fn main() -> Result<(), std::io::Error> {
+/// let my_async_read = File::open("filename.txt").await?;
+/// let my_stream_of_bytes = FramedRead::new(my_async_read, BytesCodec::new());
+/// # Ok(())
+/// # }
+/// ```
+///
+#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Default)]
+pub struct BytesCodec(());
+
+impl BytesCodec {
+ /// Creates a new `BytesCodec` for shipping around raw bytes.
+ pub fn new() -> BytesCodec {
+ BytesCodec(())
+ }
+}
+
+impl Decoder for BytesCodec {
+ type Item = BytesMut;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<BytesMut>, io::Error> {
+ if !buf.is_empty() {
+ let len = buf.len();
+ Ok(Some(buf.split_to(len)))
+ } else {
+ Ok(None)
+ }
+ }
+}
+
+impl Encoder<Bytes> for BytesCodec {
+ type Error = io::Error;
+
+ fn encode(&mut self, data: Bytes, buf: &mut BytesMut) -> Result<(), io::Error> {
+ buf.reserve(data.len());
+ buf.put(data);
+ Ok(())
+ }
+}
+
+impl Encoder<BytesMut> for BytesCodec {
+ type Error = io::Error;
+
+ fn encode(&mut self, data: BytesMut, buf: &mut BytesMut) -> Result<(), io::Error> {
+ buf.reserve(data.len());
+ buf.put(data);
+ Ok(())
+ }
+}
diff --git a/crates/tokio-util/src/codec/decoder.rs b/crates/tokio-util/src/codec/decoder.rs
new file mode 100644
index 0000000..84ecb22
--- /dev/null
+++ b/crates/tokio-util/src/codec/decoder.rs
@@ -0,0 +1,184 @@
+use crate::codec::Framed;
+
+use tokio::io::{AsyncRead, AsyncWrite};
+
+use bytes::BytesMut;
+use std::io;
+
+/// Decoding of frames via buffers.
+///
+/// This trait is used when constructing an instance of [`Framed`] or
+/// [`FramedRead`]. An implementation of `Decoder` takes a byte stream that has
+/// already been buffered in `src` and decodes the data into a stream of
+/// `Self::Item` frames.
+///
+/// Implementations are able to track state on `self`, which enables
+/// implementing stateful streaming parsers. In many cases, though, this type
+/// will simply be a unit struct (e.g. `struct HttpDecoder`).
+///
+/// For some underlying data-sources, namely files and FIFOs,
+/// it's possible to temporarily read 0 bytes by reaching EOF.
+///
+/// In these cases `decode_eof` will be called until it signals
+/// fulfillment of all closing frames by returning `Ok(None)`.
+/// After that, repeated attempts to read from the [`Framed`] or [`FramedRead`]
+/// will not invoke `decode` or `decode_eof` again, until data can be read
+/// during a retry.
+///
+/// It is up to the Decoder to keep track of a restart after an EOF,
+/// and to decide how to handle such an event by, for example,
+/// allowing frames to cross EOF boundaries, re-emitting opening frames, or
+/// resetting the entire internal state.
+///
+/// [`Framed`]: crate::codec::Framed
+/// [`FramedRead`]: crate::codec::FramedRead
+pub trait Decoder {
+ /// The type of decoded frames.
+ type Item;
+
+ /// The type of unrecoverable frame decoding errors.
+ ///
+ /// If an individual message is ill-formed but can be ignored without
+ /// interfering with the processing of future messages, it may be more
+ /// useful to report the failure as an `Item`.
+ ///
+ /// `From<io::Error>` is required in the interest of making `Error` suitable
+ /// for returning directly from a [`FramedRead`], and to enable the default
+ /// implementation of `decode_eof` to yield an `io::Error` when the decoder
+ /// fails to consume all available data.
+ ///
+ /// Note that implementors of this trait can simply indicate `type Error =
+ /// io::Error` to use I/O errors as this type.
+ ///
+ /// [`FramedRead`]: crate::codec::FramedRead
+ type Error: From<io::Error>;
+
+ /// Attempts to decode a frame from the provided buffer of bytes.
+ ///
+ /// This method is called by [`FramedRead`] whenever bytes are ready to be
+ /// parsed. The provided buffer of bytes is what's been read so far, and
+ /// this instance of `Decode` can determine whether an entire frame is in
+ /// the buffer and is ready to be returned.
+ ///
+ /// If an entire frame is available, then this instance will remove those
+ /// bytes from the buffer provided and return them as a decoded
+ /// frame. Note that removing bytes from the provided buffer doesn't always
+ /// necessarily copy the bytes, so this should be an efficient operation in
+ /// most circumstances.
+ ///
+ /// If the bytes look valid, but a frame isn't fully available yet, then
+ /// `Ok(None)` is returned. This indicates to the [`Framed`] instance that
+ /// it needs to read some more bytes before calling this method again.
+ ///
+ /// Note that the bytes provided may be empty. If a previous call to
+ /// `decode` consumed all the bytes in the buffer then `decode` will be
+ /// called again until it returns `Ok(None)`, indicating that more bytes need to
+ /// be read.
+ ///
+ /// Finally, if the bytes in the buffer are malformed then an error is
+ /// returned indicating why. This informs [`Framed`] that the stream is now
+ /// corrupt and should be terminated.
+ ///
+ /// [`Framed`]: crate::codec::Framed
+ /// [`FramedRead`]: crate::codec::FramedRead
+ ///
+ /// # Buffer management
+ ///
+ /// Before returning from the function, implementations should ensure that
+ /// the buffer has appropriate capacity in anticipation of future calls to
+ /// `decode`. Failing to do so leads to inefficiency.
+ ///
+ /// For example, if frames have a fixed length, or if the length of the
+ /// current frame is known from a header, a possible buffer management
+ /// strategy is:
+ ///
+ /// ```no_run
+ /// # use std::io;
+ /// #
+ /// # use bytes::BytesMut;
+ /// # use tokio_util::codec::Decoder;
+ /// #
+ /// # struct MyCodec;
+ /// #
+ /// impl Decoder for MyCodec {
+ /// // ...
+ /// # type Item = BytesMut;
+ /// # type Error = io::Error;
+ ///
+ /// fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
+ /// // ...
+ ///
+ /// // Reserve enough to complete decoding of the current frame.
+ /// let current_frame_len: usize = 1000; // Example.
+ /// // And to start decoding the next frame.
+ /// let next_frame_header_len: usize = 10; // Example.
+ /// src.reserve(current_frame_len + next_frame_header_len);
+ ///
+ /// return Ok(None);
+ /// }
+ /// }
+ /// ```
+ ///
+ /// An optimal buffer management strategy minimizes reallocations and
+ /// over-allocations.
+ fn decode(&mut self, src: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error>;
+
+ /// A default method available to be called when there are no more bytes
+ /// available to be read from the underlying I/O.
+ ///
+ /// This method defaults to calling `decode` and returns an error if
+ /// `Ok(None)` is returned while there is unconsumed data in `buf`.
+ /// Typically this doesn't need to be implemented unless the framing
+ /// protocol differs near the end of the stream, or if you need to construct
+ /// frames _across_ eof boundaries on sources that can be resumed.
+ ///
+ /// Note that the `buf` argument may be empty. If a previous call to
+ /// `decode_eof` consumed all the bytes in the buffer, `decode_eof` will be
+ /// called again until it returns `None`, indicating that there are no more
+ /// frames to yield. This behavior enables returning finalization frames
+ /// that may not be based on inbound data.
+ ///
+ /// Once `None` has been returned, `decode_eof` won't be called again until
+ /// an attempt to resume the stream has been made, where the underlying stream
+ /// actually returned more data.
+ fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<Self::Item>, Self::Error> {
+ match self.decode(buf)? {
+ Some(frame) => Ok(Some(frame)),
+ None => {
+ if buf.is_empty() {
+ Ok(None)
+ } else {
+ Err(io::Error::new(io::ErrorKind::Other, "bytes remaining on stream").into())
+ }
+ }
+ }
+ }
+
+ /// Provides a [`Stream`] and [`Sink`] interface for reading and writing to this
+ /// `Io` object, using `Decode` and `Encode` to read and write the raw data.
+ ///
+ /// Raw I/O objects work with byte sequences, but higher-level code usually
+ /// wants to batch these into meaningful chunks, called "frames". This
+ /// method layers framing on top of an I/O object, by using the `Codec`
+ /// traits to handle encoding and decoding of messages frames. Note that
+ /// the incoming and outgoing frame types may be distinct.
+ ///
+ /// This function returns a *single* object that is both `Stream` and
+ /// `Sink`; grouping this into a single object is often useful for layering
+ /// things like gzip or TLS, which require both read and write access to the
+ /// underlying object.
+ ///
+ /// If you want to work more directly with the streams and sink, consider
+ /// calling `split` on the [`Framed`] returned by this method, which will
+ /// break them into separate objects, allowing them to interact more easily.
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`Sink`]: futures_sink::Sink
+ /// [`Framed`]: crate::codec::Framed
+ fn framed<T: AsyncRead + AsyncWrite + Sized>(self, io: T) -> Framed<T, Self>
+ where
+ Self: Sized,
+ {
+ Framed::new(io, self)
+ }
+}
diff --git a/crates/tokio-util/src/codec/encoder.rs b/crates/tokio-util/src/codec/encoder.rs
new file mode 100644
index 0000000..770a10f
--- /dev/null
+++ b/crates/tokio-util/src/codec/encoder.rs
@@ -0,0 +1,25 @@
+use bytes::BytesMut;
+use std::io;
+
+/// Trait of helper objects to write out messages as bytes, for use with
+/// [`FramedWrite`].
+///
+/// [`FramedWrite`]: crate::codec::FramedWrite
+pub trait Encoder<Item> {
+ /// The type of encoding errors.
+ ///
+ /// [`FramedWrite`] requires `Encoder`s errors to implement `From<io::Error>`
+ /// in the interest letting it return `Error`s directly.
+ ///
+ /// [`FramedWrite`]: crate::codec::FramedWrite
+ type Error: From<io::Error>;
+
+ /// Encodes a frame into the buffer provided.
+ ///
+ /// This method will encode `item` into the byte buffer provided by `dst`.
+ /// The `dst` provided is an internal buffer of the [`FramedWrite`] instance and
+ /// will be written out when possible.
+ ///
+ /// [`FramedWrite`]: crate::codec::FramedWrite
+ fn encode(&mut self, item: Item, dst: &mut BytesMut) -> Result<(), Self::Error>;
+}
diff --git a/crates/tokio-util/src/codec/framed.rs b/crates/tokio-util/src/codec/framed.rs
new file mode 100644
index 0000000..8a344f9
--- /dev/null
+++ b/crates/tokio-util/src/codec/framed.rs
@@ -0,0 +1,383 @@
+use crate::codec::decoder::Decoder;
+use crate::codec::encoder::Encoder;
+use crate::codec::framed_impl::{FramedImpl, RWFrames, ReadFrame, WriteFrame};
+
+use futures_core::Stream;
+use tokio::io::{AsyncRead, AsyncWrite};
+
+use bytes::BytesMut;
+use futures_sink::Sink;
+use pin_project_lite::pin_project;
+use std::fmt;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+pin_project! {
+ /// A unified [`Stream`] and [`Sink`] interface to an underlying I/O object, using
+ /// the `Encoder` and `Decoder` traits to encode and decode frames.
+ ///
+ /// You can create a `Framed` instance by using the [`Decoder::framed`] adapter, or
+ /// by using the `new` function seen below.
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`Sink`]: futures_sink::Sink
+ /// [`AsyncRead`]: tokio::io::AsyncRead
+ /// [`Decoder::framed`]: crate::codec::Decoder::framed()
+ pub struct Framed<T, U> {
+ #[pin]
+ inner: FramedImpl<T, U, RWFrames>
+ }
+}
+
+impl<T, U> Framed<T, U>
+where
+ T: AsyncRead + AsyncWrite,
+{
+ /// Provides a [`Stream`] and [`Sink`] interface for reading and writing to this
+ /// I/O object, using [`Decoder`] and [`Encoder`] to read and write the raw data.
+ ///
+ /// Raw I/O objects work with byte sequences, but higher-level code usually
+ /// wants to batch these into meaningful chunks, called "frames". This
+ /// method layers framing on top of an I/O object, by using the codec
+ /// traits to handle encoding and decoding of messages frames. Note that
+ /// the incoming and outgoing frame types may be distinct.
+ ///
+ /// This function returns a *single* object that is both [`Stream`] and
+ /// [`Sink`]; grouping this into a single object is often useful for layering
+ /// things like gzip or TLS, which require both read and write access to the
+ /// underlying object.
+ ///
+ /// If you want to work more directly with the streams and sink, consider
+ /// calling [`split`] on the `Framed` returned by this method, which will
+ /// break them into separate objects, allowing them to interact more easily.
+ ///
+ /// Note that, for some byte sources, the stream can be resumed after an EOF
+ /// by reading from it, even after it has returned `None`. Repeated attempts
+ /// to do so, without new data available, continue to return `None` without
+ /// creating more (closing) frames.
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`Sink`]: futures_sink::Sink
+ /// [`Decode`]: crate::codec::Decoder
+ /// [`Encoder`]: crate::codec::Encoder
+ /// [`split`]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split
+ pub fn new(inner: T, codec: U) -> Framed<T, U> {
+ Framed {
+ inner: FramedImpl {
+ inner,
+ codec,
+ state: Default::default(),
+ },
+ }
+ }
+
+ /// Provides a [`Stream`] and [`Sink`] interface for reading and writing to this
+ /// I/O object, using [`Decoder`] and [`Encoder`] to read and write the raw data,
+ /// with a specific read buffer initial capacity.
+ ///
+ /// Raw I/O objects work with byte sequences, but higher-level code usually
+ /// wants to batch these into meaningful chunks, called "frames". This
+ /// method layers framing on top of an I/O object, by using the codec
+ /// traits to handle encoding and decoding of messages frames. Note that
+ /// the incoming and outgoing frame types may be distinct.
+ ///
+ /// This function returns a *single* object that is both [`Stream`] and
+ /// [`Sink`]; grouping this into a single object is often useful for layering
+ /// things like gzip or TLS, which require both read and write access to the
+ /// underlying object.
+ ///
+ /// If you want to work more directly with the streams and sink, consider
+ /// calling [`split`] on the `Framed` returned by this method, which will
+ /// break them into separate objects, allowing them to interact more easily.
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`Sink`]: futures_sink::Sink
+ /// [`Decode`]: crate::codec::Decoder
+ /// [`Encoder`]: crate::codec::Encoder
+ /// [`split`]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split
+ pub fn with_capacity(inner: T, codec: U, capacity: usize) -> Framed<T, U> {
+ Framed {
+ inner: FramedImpl {
+ inner,
+ codec,
+ state: RWFrames {
+ read: ReadFrame {
+ eof: false,
+ is_readable: false,
+ buffer: BytesMut::with_capacity(capacity),
+ has_errored: false,
+ },
+ write: WriteFrame::default(),
+ },
+ },
+ }
+ }
+}
+
+impl<T, U> Framed<T, U> {
+ /// Provides a [`Stream`] and [`Sink`] interface for reading and writing to this
+ /// I/O object, using [`Decoder`] and [`Encoder`] to read and write the raw data.
+ ///
+ /// Raw I/O objects work with byte sequences, but higher-level code usually
+ /// wants to batch these into meaningful chunks, called "frames". This
+ /// method layers framing on top of an I/O object, by using the `Codec`
+ /// traits to handle encoding and decoding of messages frames. Note that
+ /// the incoming and outgoing frame types may be distinct.
+ ///
+ /// This function returns a *single* object that is both [`Stream`] and
+ /// [`Sink`]; grouping this into a single object is often useful for layering
+ /// things like gzip or TLS, which require both read and write access to the
+ /// underlying object.
+ ///
+ /// This objects takes a stream and a readbuffer and a writebuffer. These field
+ /// can be obtained from an existing `Framed` with the [`into_parts`] method.
+ ///
+ /// If you want to work more directly with the streams and sink, consider
+ /// calling [`split`] on the `Framed` returned by this method, which will
+ /// break them into separate objects, allowing them to interact more easily.
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`Sink`]: futures_sink::Sink
+ /// [`Decoder`]: crate::codec::Decoder
+ /// [`Encoder`]: crate::codec::Encoder
+ /// [`into_parts`]: crate::codec::Framed::into_parts()
+ /// [`split`]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split
+ pub fn from_parts(parts: FramedParts<T, U>) -> Framed<T, U> {
+ Framed {
+ inner: FramedImpl {
+ inner: parts.io,
+ codec: parts.codec,
+ state: RWFrames {
+ read: parts.read_buf.into(),
+ write: parts.write_buf.into(),
+ },
+ },
+ }
+ }
+
+ /// Returns a reference to the underlying I/O stream wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_ref(&self) -> &T {
+ &self.inner.inner
+ }
+
+ /// Returns a mutable reference to the underlying I/O stream wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner.inner
+ }
+
+ /// Returns a pinned mutable reference to the underlying I/O stream wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
+ self.project().inner.project().inner
+ }
+
+ /// Returns a reference to the underlying codec wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn codec(&self) -> &U {
+ &self.inner.codec
+ }
+
+ /// Returns a mutable reference to the underlying codec wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn codec_mut(&mut self) -> &mut U {
+ &mut self.inner.codec
+ }
+
+ /// Maps the codec `U` to `C`, preserving the read and write buffers
+ /// wrapped by `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn map_codec<C, F>(self, map: F) -> Framed<T, C>
+ where
+ F: FnOnce(U) -> C,
+ {
+ // This could be potentially simplified once rust-lang/rust#86555 hits stable
+ let parts = self.into_parts();
+ Framed::from_parts(FramedParts {
+ io: parts.io,
+ codec: map(parts.codec),
+ read_buf: parts.read_buf,
+ write_buf: parts.write_buf,
+ _priv: (),
+ })
+ }
+
+ /// Returns a mutable reference to the underlying codec wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn codec_pin_mut(self: Pin<&mut Self>) -> &mut U {
+ self.project().inner.project().codec
+ }
+
+ /// Returns a reference to the read buffer.
+ pub fn read_buffer(&self) -> &BytesMut {
+ &self.inner.state.read.buffer
+ }
+
+ /// Returns a mutable reference to the read buffer.
+ pub fn read_buffer_mut(&mut self) -> &mut BytesMut {
+ &mut self.inner.state.read.buffer
+ }
+
+ /// Returns a reference to the write buffer.
+ pub fn write_buffer(&self) -> &BytesMut {
+ &self.inner.state.write.buffer
+ }
+
+ /// Returns a mutable reference to the write buffer.
+ pub fn write_buffer_mut(&mut self) -> &mut BytesMut {
+ &mut self.inner.state.write.buffer
+ }
+
+ /// Returns backpressure boundary
+ pub fn backpressure_boundary(&self) -> usize {
+ self.inner.state.write.backpressure_boundary
+ }
+
+ /// Updates backpressure boundary
+ pub fn set_backpressure_boundary(&mut self, boundary: usize) {
+ self.inner.state.write.backpressure_boundary = boundary;
+ }
+
+ /// Consumes the `Framed`, returning its underlying I/O stream.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn into_inner(self) -> T {
+ self.inner.inner
+ }
+
+ /// Consumes the `Framed`, returning its underlying I/O stream, the buffer
+ /// with unprocessed data, and the codec.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn into_parts(self) -> FramedParts<T, U> {
+ FramedParts {
+ io: self.inner.inner,
+ codec: self.inner.codec,
+ read_buf: self.inner.state.read.buffer,
+ write_buf: self.inner.state.write.buffer,
+ _priv: (),
+ }
+ }
+}
+
+// This impl just defers to the underlying FramedImpl
+impl<T, U> Stream for Framed<T, U>
+where
+ T: AsyncRead,
+ U: Decoder,
+{
+ type Item = Result<U::Item, U::Error>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
+
+// This impl just defers to the underlying FramedImpl
+impl<T, I, U> Sink<I> for Framed<T, U>
+where
+ T: AsyncWrite,
+ U: Encoder<I>,
+ U::Error: From<io::Error>,
+{
+ type Error = U::Error;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_ready(cx)
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> {
+ self.project().inner.start_send(item)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_flush(cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_close(cx)
+ }
+}
+
+impl<T, U> fmt::Debug for Framed<T, U>
+where
+ T: fmt::Debug,
+ U: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Framed")
+ .field("io", self.get_ref())
+ .field("codec", self.codec())
+ .finish()
+ }
+}
+
+/// `FramedParts` contains an export of the data of a Framed transport.
+/// It can be used to construct a new [`Framed`] with a different codec.
+/// It contains all current buffers and the inner transport.
+///
+/// [`Framed`]: crate::codec::Framed
+#[derive(Debug)]
+#[allow(clippy::manual_non_exhaustive)]
+pub struct FramedParts<T, U> {
+ /// The inner transport used to read bytes to and write bytes to
+ pub io: T,
+
+ /// The codec
+ pub codec: U,
+
+ /// The buffer with read but unprocessed data.
+ pub read_buf: BytesMut,
+
+ /// A buffer with unprocessed data which are not written yet.
+ pub write_buf: BytesMut,
+
+ /// This private field allows us to add additional fields in the future in a
+ /// backwards compatible way.
+ _priv: (),
+}
+
+impl<T, U> FramedParts<T, U> {
+ /// Create a new, default, `FramedParts`
+ pub fn new<I>(io: T, codec: U) -> FramedParts<T, U>
+ where
+ U: Encoder<I>,
+ {
+ FramedParts {
+ io,
+ codec,
+ read_buf: BytesMut::new(),
+ write_buf: BytesMut::new(),
+ _priv: (),
+ }
+ }
+}
diff --git a/crates/tokio-util/src/codec/framed_impl.rs b/crates/tokio-util/src/codec/framed_impl.rs
new file mode 100644
index 0000000..8f3fa49
--- /dev/null
+++ b/crates/tokio-util/src/codec/framed_impl.rs
@@ -0,0 +1,312 @@
+use crate::codec::decoder::Decoder;
+use crate::codec::encoder::Encoder;
+
+use futures_core::Stream;
+use tokio::io::{AsyncRead, AsyncWrite};
+
+use bytes::BytesMut;
+use futures_core::ready;
+use futures_sink::Sink;
+use pin_project_lite::pin_project;
+use std::borrow::{Borrow, BorrowMut};
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tracing::trace;
+
+pin_project! {
+ #[derive(Debug)]
+ pub(crate) struct FramedImpl<T, U, State> {
+ #[pin]
+ pub(crate) inner: T,
+ pub(crate) state: State,
+ pub(crate) codec: U,
+ }
+}
+
+const INITIAL_CAPACITY: usize = 8 * 1024;
+
+#[derive(Debug)]
+pub(crate) struct ReadFrame {
+ pub(crate) eof: bool,
+ pub(crate) is_readable: bool,
+ pub(crate) buffer: BytesMut,
+ pub(crate) has_errored: bool,
+}
+
+pub(crate) struct WriteFrame {
+ pub(crate) buffer: BytesMut,
+ pub(crate) backpressure_boundary: usize,
+}
+
+#[derive(Default)]
+pub(crate) struct RWFrames {
+ pub(crate) read: ReadFrame,
+ pub(crate) write: WriteFrame,
+}
+
+impl Default for ReadFrame {
+ fn default() -> Self {
+ Self {
+ eof: false,
+ is_readable: false,
+ buffer: BytesMut::with_capacity(INITIAL_CAPACITY),
+ has_errored: false,
+ }
+ }
+}
+
+impl Default for WriteFrame {
+ fn default() -> Self {
+ Self {
+ buffer: BytesMut::with_capacity(INITIAL_CAPACITY),
+ backpressure_boundary: INITIAL_CAPACITY,
+ }
+ }
+}
+
+impl From<BytesMut> for ReadFrame {
+ fn from(mut buffer: BytesMut) -> Self {
+ let size = buffer.capacity();
+ if size < INITIAL_CAPACITY {
+ buffer.reserve(INITIAL_CAPACITY - size);
+ }
+
+ Self {
+ buffer,
+ is_readable: size > 0,
+ eof: false,
+ has_errored: false,
+ }
+ }
+}
+
+impl From<BytesMut> for WriteFrame {
+ fn from(mut buffer: BytesMut) -> Self {
+ let size = buffer.capacity();
+ if size < INITIAL_CAPACITY {
+ buffer.reserve(INITIAL_CAPACITY - size);
+ }
+
+ Self {
+ buffer,
+ backpressure_boundary: INITIAL_CAPACITY,
+ }
+ }
+}
+
+impl Borrow<ReadFrame> for RWFrames {
+ fn borrow(&self) -> &ReadFrame {
+ &self.read
+ }
+}
+impl BorrowMut<ReadFrame> for RWFrames {
+ fn borrow_mut(&mut self) -> &mut ReadFrame {
+ &mut self.read
+ }
+}
+impl Borrow<WriteFrame> for RWFrames {
+ fn borrow(&self) -> &WriteFrame {
+ &self.write
+ }
+}
+impl BorrowMut<WriteFrame> for RWFrames {
+ fn borrow_mut(&mut self) -> &mut WriteFrame {
+ &mut self.write
+ }
+}
+impl<T, U, R> Stream for FramedImpl<T, U, R>
+where
+ T: AsyncRead,
+ U: Decoder,
+ R: BorrowMut<ReadFrame>,
+{
+ type Item = Result<U::Item, U::Error>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ use crate::util::poll_read_buf;
+
+ let mut pinned = self.project();
+ let state: &mut ReadFrame = pinned.state.borrow_mut();
+ // The following loops implements a state machine with each state corresponding
+ // to a combination of the `is_readable` and `eof` flags. States persist across
+ // loop entries and most state transitions occur with a return.
+ //
+ // The initial state is `reading`.
+ //
+ // | state | eof | is_readable | has_errored |
+ // |---------|-------|-------------|-------------|
+ // | reading | false | false | false |
+ // | framing | false | true | false |
+ // | pausing | true | true | false |
+ // | paused | true | false | false |
+ // | errored | <any> | <any> | true |
+ // `decode_eof` returns Err
+ // ┌────────────────────────────────────────────────────────┐
+ // `decode_eof` returns │ │
+ // `Ok(Some)` │ │
+ // ┌─────┐ │ `decode_eof` returns After returning │
+ // Read 0 bytes ├─────▼──┴┐ `Ok(None)` ┌────────┐ ◄───┐ `None` ┌───▼─────┐
+ // ┌────────────────►│ Pausing ├───────────────────────►│ Paused ├─┐ └───────────┤ Errored │
+ // │ └─────────┘ └─┬──▲───┘ │ └───▲───▲─┘
+ // Pending read │ │ │ │ │ │
+ // ┌──────┐ │ `decode` returns `Some` │ └─────┘ │ │
+ // │ │ │ ┌──────┐ │ Pending │ │
+ // │ ┌────▼──┴─┐ Read n>0 bytes ┌┴──────▼─┐ read n>0 bytes │ read │ │
+ // └─┤ Reading ├───────────────►│ Framing │◄────────────────────────┘ │ │
+ // └──┬─▲────┘ └─────┬──┬┘ │ │
+ // │ │ │ │ `decode` returns Err │ │
+ // │ └───decode` returns `None`──┘ └───────────────────────────────────────────────────────┘ │
+ // │ read returns Err │
+ // └────────────────────────────────────────────────────────────────────────────────────────────┘
+ loop {
+ // Return `None` if we have encountered an error from the underlying decoder
+ // See: https://github.com/tokio-rs/tokio/issues/3976
+ if state.has_errored {
+ // preparing has_errored -> paused
+ trace!("Returning None and setting paused");
+ state.is_readable = false;
+ state.has_errored = false;
+ return Poll::Ready(None);
+ }
+
+ // Repeatedly call `decode` or `decode_eof` while the buffer is "readable",
+ // i.e. it _might_ contain data consumable as a frame or closing frame.
+ // Both signal that there is no such data by returning `None`.
+ //
+ // If `decode` couldn't read a frame and the upstream source has returned eof,
+ // `decode_eof` will attempt to decode the remaining bytes as closing frames.
+ //
+ // If the underlying AsyncRead is resumable, we may continue after an EOF,
+ // but must finish emitting all of it's associated `decode_eof` frames.
+ // Furthermore, we don't want to emit any `decode_eof` frames on retried
+ // reads after an EOF unless we've actually read more data.
+ if state.is_readable {
+ // pausing or framing
+ if state.eof {
+ // pausing
+ let frame = pinned.codec.decode_eof(&mut state.buffer).map_err(|err| {
+ trace!("Got an error, going to errored state");
+ state.has_errored = true;
+ err
+ })?;
+ if frame.is_none() {
+ state.is_readable = false; // prepare pausing -> paused
+ }
+ // implicit pausing -> pausing or pausing -> paused
+ return Poll::Ready(frame.map(Ok));
+ }
+
+ // framing
+ trace!("attempting to decode a frame");
+
+ if let Some(frame) = pinned.codec.decode(&mut state.buffer).map_err(|op| {
+ trace!("Got an error, going to errored state");
+ state.has_errored = true;
+ op
+ })? {
+ trace!("frame decoded from buffer");
+ // implicit framing -> framing
+ return Poll::Ready(Some(Ok(frame)));
+ }
+
+ // framing -> reading
+ state.is_readable = false;
+ }
+ // reading or paused
+ // If we can't build a frame yet, try to read more data and try again.
+ // Make sure we've got room for at least one byte to read to ensure
+ // that we don't get a spurious 0 that looks like EOF.
+ state.buffer.reserve(1);
+ let bytect = match poll_read_buf(pinned.inner.as_mut(), cx, &mut state.buffer).map_err(
+ |err| {
+ trace!("Got an error, going to errored state");
+ state.has_errored = true;
+ err
+ },
+ )? {
+ Poll::Ready(ct) => ct,
+ // implicit reading -> reading or implicit paused -> paused
+ Poll::Pending => return Poll::Pending,
+ };
+ if bytect == 0 {
+ if state.eof {
+ // We're already at an EOF, and since we've reached this path
+ // we're also not readable. This implies that we've already finished
+ // our `decode_eof` handling, so we can simply return `None`.
+ // implicit paused -> paused
+ return Poll::Ready(None);
+ }
+ // prepare reading -> paused
+ state.eof = true;
+ } else {
+ // prepare paused -> framing or noop reading -> framing
+ state.eof = false;
+ }
+
+ // paused -> framing or reading -> framing or reading -> pausing
+ state.is_readable = true;
+ }
+ }
+}
+
+impl<T, I, U, W> Sink<I> for FramedImpl<T, U, W>
+where
+ T: AsyncWrite,
+ U: Encoder<I>,
+ U::Error: From<io::Error>,
+ W: BorrowMut<WriteFrame>,
+{
+ type Error = U::Error;
+
+ fn poll_ready(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if self.state.borrow().buffer.len() >= self.state.borrow().backpressure_boundary {
+ self.as_mut().poll_flush(cx)
+ } else {
+ Poll::Ready(Ok(()))
+ }
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> {
+ let pinned = self.project();
+ pinned
+ .codec
+ .encode(item, &mut pinned.state.borrow_mut().buffer)?;
+ Ok(())
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ use crate::util::poll_write_buf;
+ trace!("flushing framed transport");
+ let mut pinned = self.project();
+
+ while !pinned.state.borrow_mut().buffer.is_empty() {
+ let WriteFrame { buffer, .. } = pinned.state.borrow_mut();
+ trace!(remaining = buffer.len(), "writing;");
+
+ let n = ready!(poll_write_buf(pinned.inner.as_mut(), cx, buffer))?;
+
+ if n == 0 {
+ return Poll::Ready(Err(io::Error::new(
+ io::ErrorKind::WriteZero,
+ "failed to \
+ write frame to transport",
+ )
+ .into()));
+ }
+ }
+
+ // Try flushing the underlying IO
+ ready!(pinned.inner.poll_flush(cx))?;
+
+ trace!("framed transport flushed");
+ Poll::Ready(Ok(()))
+ }
+
+ fn poll_close(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ ready!(self.as_mut().poll_flush(cx))?;
+ ready!(self.project().inner.poll_shutdown(cx))?;
+
+ Poll::Ready(Ok(()))
+ }
+}
diff --git a/crates/tokio-util/src/codec/framed_read.rs b/crates/tokio-util/src/codec/framed_read.rs
new file mode 100644
index 0000000..184c567
--- /dev/null
+++ b/crates/tokio-util/src/codec/framed_read.rs
@@ -0,0 +1,199 @@
+use crate::codec::framed_impl::{FramedImpl, ReadFrame};
+use crate::codec::Decoder;
+
+use futures_core::Stream;
+use tokio::io::AsyncRead;
+
+use bytes::BytesMut;
+use futures_sink::Sink;
+use pin_project_lite::pin_project;
+use std::fmt;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+pin_project! {
+ /// A [`Stream`] of messages decoded from an [`AsyncRead`].
+ ///
+ /// [`Stream`]: futures_core::Stream
+ /// [`AsyncRead`]: tokio::io::AsyncRead
+ pub struct FramedRead<T, D> {
+ #[pin]
+ inner: FramedImpl<T, D, ReadFrame>,
+ }
+}
+
+// ===== impl FramedRead =====
+
+impl<T, D> FramedRead<T, D>
+where
+ T: AsyncRead,
+ D: Decoder,
+{
+ /// Creates a new `FramedRead` with the given `decoder`.
+ pub fn new(inner: T, decoder: D) -> FramedRead<T, D> {
+ FramedRead {
+ inner: FramedImpl {
+ inner,
+ codec: decoder,
+ state: Default::default(),
+ },
+ }
+ }
+
+ /// Creates a new `FramedRead` with the given `decoder` and a buffer of `capacity`
+ /// initial size.
+ pub fn with_capacity(inner: T, decoder: D, capacity: usize) -> FramedRead<T, D> {
+ FramedRead {
+ inner: FramedImpl {
+ inner,
+ codec: decoder,
+ state: ReadFrame {
+ eof: false,
+ is_readable: false,
+ buffer: BytesMut::with_capacity(capacity),
+ has_errored: false,
+ },
+ },
+ }
+ }
+}
+
+impl<T, D> FramedRead<T, D> {
+ /// Returns a reference to the underlying I/O stream wrapped by
+ /// `FramedRead`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_ref(&self) -> &T {
+ &self.inner.inner
+ }
+
+ /// Returns a mutable reference to the underlying I/O stream wrapped by
+ /// `FramedRead`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner.inner
+ }
+
+ /// Returns a pinned mutable reference to the underlying I/O stream wrapped by
+ /// `FramedRead`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
+ self.project().inner.project().inner
+ }
+
+ /// Consumes the `FramedRead`, returning its underlying I/O stream.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn into_inner(self) -> T {
+ self.inner.inner
+ }
+
+ /// Returns a reference to the underlying decoder.
+ pub fn decoder(&self) -> &D {
+ &self.inner.codec
+ }
+
+ /// Returns a mutable reference to the underlying decoder.
+ pub fn decoder_mut(&mut self) -> &mut D {
+ &mut self.inner.codec
+ }
+
+ /// Maps the decoder `D` to `C`, preserving the read buffer
+ /// wrapped by `Framed`.
+ pub fn map_decoder<C, F>(self, map: F) -> FramedRead<T, C>
+ where
+ F: FnOnce(D) -> C,
+ {
+ // This could be potentially simplified once rust-lang/rust#86555 hits stable
+ let FramedImpl {
+ inner,
+ state,
+ codec,
+ } = self.inner;
+ FramedRead {
+ inner: FramedImpl {
+ inner,
+ state,
+ codec: map(codec),
+ },
+ }
+ }
+
+ /// Returns a mutable reference to the underlying decoder.
+ pub fn decoder_pin_mut(self: Pin<&mut Self>) -> &mut D {
+ self.project().inner.project().codec
+ }
+
+ /// Returns a reference to the read buffer.
+ pub fn read_buffer(&self) -> &BytesMut {
+ &self.inner.state.buffer
+ }
+
+ /// Returns a mutable reference to the read buffer.
+ pub fn read_buffer_mut(&mut self) -> &mut BytesMut {
+ &mut self.inner.state.buffer
+ }
+}
+
+// This impl just defers to the underlying FramedImpl
+impl<T, D> Stream for FramedRead<T, D>
+where
+ T: AsyncRead,
+ D: Decoder,
+{
+ type Item = Result<D::Item, D::Error>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
+
+// This impl just defers to the underlying T: Sink
+impl<T, I, D> Sink<I> for FramedRead<T, D>
+where
+ T: Sink<I>,
+{
+ type Error = T::Error;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.project().inner.poll_ready(cx)
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> {
+ self.project().inner.project().inner.start_send(item)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.project().inner.poll_flush(cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.project().inner.poll_close(cx)
+ }
+}
+
+impl<T, D> fmt::Debug for FramedRead<T, D>
+where
+ T: fmt::Debug,
+ D: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FramedRead")
+ .field("inner", &self.get_ref())
+ .field("decoder", &self.decoder())
+ .field("eof", &self.inner.state.eof)
+ .field("is_readable", &self.inner.state.is_readable)
+ .field("buffer", &self.read_buffer())
+ .finish()
+ }
+}
diff --git a/crates/tokio-util/src/codec/framed_write.rs b/crates/tokio-util/src/codec/framed_write.rs
new file mode 100644
index 0000000..3f0a340
--- /dev/null
+++ b/crates/tokio-util/src/codec/framed_write.rs
@@ -0,0 +1,188 @@
+use crate::codec::encoder::Encoder;
+use crate::codec::framed_impl::{FramedImpl, WriteFrame};
+
+use futures_core::Stream;
+use tokio::io::AsyncWrite;
+
+use bytes::BytesMut;
+use futures_sink::Sink;
+use pin_project_lite::pin_project;
+use std::fmt;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+pin_project! {
+ /// A [`Sink`] of frames encoded to an `AsyncWrite`.
+ ///
+ /// [`Sink`]: futures_sink::Sink
+ pub struct FramedWrite<T, E> {
+ #[pin]
+ inner: FramedImpl<T, E, WriteFrame>,
+ }
+}
+
+impl<T, E> FramedWrite<T, E>
+where
+ T: AsyncWrite,
+{
+ /// Creates a new `FramedWrite` with the given `encoder`.
+ pub fn new(inner: T, encoder: E) -> FramedWrite<T, E> {
+ FramedWrite {
+ inner: FramedImpl {
+ inner,
+ codec: encoder,
+ state: WriteFrame::default(),
+ },
+ }
+ }
+}
+
+impl<T, E> FramedWrite<T, E> {
+ /// Returns a reference to the underlying I/O stream wrapped by
+ /// `FramedWrite`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_ref(&self) -> &T {
+ &self.inner.inner
+ }
+
+ /// Returns a mutable reference to the underlying I/O stream wrapped by
+ /// `FramedWrite`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner.inner
+ }
+
+ /// Returns a pinned mutable reference to the underlying I/O stream wrapped by
+ /// `FramedWrite`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
+ self.project().inner.project().inner
+ }
+
+ /// Consumes the `FramedWrite`, returning its underlying I/O stream.
+ ///
+ /// Note that care should be taken to not tamper with the underlying stream
+ /// of data coming in as it may corrupt the stream of frames otherwise
+ /// being worked with.
+ pub fn into_inner(self) -> T {
+ self.inner.inner
+ }
+
+ /// Returns a reference to the underlying encoder.
+ pub fn encoder(&self) -> &E {
+ &self.inner.codec
+ }
+
+ /// Returns a mutable reference to the underlying encoder.
+ pub fn encoder_mut(&mut self) -> &mut E {
+ &mut self.inner.codec
+ }
+
+ /// Maps the encoder `E` to `C`, preserving the write buffer
+ /// wrapped by `Framed`.
+ pub fn map_encoder<C, F>(self, map: F) -> FramedWrite<T, C>
+ where
+ F: FnOnce(E) -> C,
+ {
+ // This could be potentially simplified once rust-lang/rust#86555 hits stable
+ let FramedImpl {
+ inner,
+ state,
+ codec,
+ } = self.inner;
+ FramedWrite {
+ inner: FramedImpl {
+ inner,
+ state,
+ codec: map(codec),
+ },
+ }
+ }
+
+ /// Returns a mutable reference to the underlying encoder.
+ pub fn encoder_pin_mut(self: Pin<&mut Self>) -> &mut E {
+ self.project().inner.project().codec
+ }
+
+ /// Returns a reference to the write buffer.
+ pub fn write_buffer(&self) -> &BytesMut {
+ &self.inner.state.buffer
+ }
+
+ /// Returns a mutable reference to the write buffer.
+ pub fn write_buffer_mut(&mut self) -> &mut BytesMut {
+ &mut self.inner.state.buffer
+ }
+
+ /// Returns backpressure boundary
+ pub fn backpressure_boundary(&self) -> usize {
+ self.inner.state.backpressure_boundary
+ }
+
+ /// Updates backpressure boundary
+ pub fn set_backpressure_boundary(&mut self, boundary: usize) {
+ self.inner.state.backpressure_boundary = boundary;
+ }
+}
+
+// This impl just defers to the underlying FramedImpl
+impl<T, I, E> Sink<I> for FramedWrite<T, E>
+where
+ T: AsyncWrite,
+ E: Encoder<I>,
+ E::Error: From<io::Error>,
+{
+ type Error = E::Error;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_ready(cx)
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error> {
+ self.project().inner.start_send(item)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_flush(cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_close(cx)
+ }
+}
+
+// This impl just defers to the underlying T: Stream
+impl<T, D> Stream for FramedWrite<T, D>
+where
+ T: Stream,
+{
+ type Item = T::Item;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.project().inner.poll_next(cx)
+ }
+}
+
+impl<T, U> fmt::Debug for FramedWrite<T, U>
+where
+ T: fmt::Debug,
+ U: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FramedWrite")
+ .field("inner", &self.get_ref())
+ .field("encoder", &self.encoder())
+ .field("buffer", &self.inner.state.buffer)
+ .finish()
+ }
+}
diff --git a/crates/tokio-util/src/codec/length_delimited.rs b/crates/tokio-util/src/codec/length_delimited.rs
new file mode 100644
index 0000000..a182dca
--- /dev/null
+++ b/crates/tokio-util/src/codec/length_delimited.rs
@@ -0,0 +1,1043 @@
+//! Frame a stream of bytes based on a length prefix
+//!
+//! Many protocols delimit their frames by prefacing frame data with a
+//! frame head that specifies the length of the frame. The
+//! `length_delimited` module provides utilities for handling the length
+//! based framing. This allows the consumer to work with entire frames
+//! without having to worry about buffering or other framing logic.
+//!
+//! # Getting started
+//!
+//! If implementing a protocol from scratch, using length delimited framing
+//! is an easy way to get started. [`LengthDelimitedCodec::new()`] will
+//! return a length delimited codec using default configuration values.
+//! This can then be used to construct a framer to adapt a full-duplex
+//! byte stream into a stream of frames.
+//!
+//! ```
+//! use tokio::io::{AsyncRead, AsyncWrite};
+//! use tokio_util::codec::{Framed, LengthDelimitedCodec};
+//!
+//! fn bind_transport<T: AsyncRead + AsyncWrite>(io: T)
+//! -> Framed<T, LengthDelimitedCodec>
+//! {
+//! Framed::new(io, LengthDelimitedCodec::new())
+//! }
+//! # pub fn main() {}
+//! ```
+//!
+//! The returned transport implements `Sink + Stream` for `BytesMut`. It
+//! encodes the frame with a big-endian `u32` header denoting the frame
+//! payload length:
+//!
+//! ```text
+//! +----------+--------------------------------+
+//! | len: u32 | frame payload |
+//! +----------+--------------------------------+
+//! ```
+//!
+//! Specifically, given the following:
+//!
+//! ```
+//! use tokio::io::{AsyncRead, AsyncWrite};
+//! use tokio_util::codec::{Framed, LengthDelimitedCodec};
+//!
+//! use futures::SinkExt;
+//! use bytes::Bytes;
+//!
+//! async fn write_frame<T>(io: T) -> Result<(), Box<dyn std::error::Error>>
+//! where
+//! T: AsyncRead + AsyncWrite + Unpin,
+//! {
+//! let mut transport = Framed::new(io, LengthDelimitedCodec::new());
+//! let frame = Bytes::from("hello world");
+//!
+//! transport.send(frame).await?;
+//! Ok(())
+//! }
+//! ```
+//!
+//! The encoded frame will look like this:
+//!
+//! ```text
+//! +---- len: u32 ----+---- data ----+
+//! | \x00\x00\x00\x0b | hello world |
+//! +------------------+--------------+
+//! ```
+//!
+//! # Decoding
+//!
+//! [`FramedRead`] adapts an [`AsyncRead`] into a `Stream` of [`BytesMut`],
+//! such that each yielded [`BytesMut`] value contains the contents of an
+//! entire frame. There are many configuration parameters enabling
+//! [`FramedRead`] to handle a wide range of protocols. Here are some
+//! examples that will cover the various options at a high level.
+//!
+//! ## Example 1
+//!
+//! The following will parse a `u16` length field at offset 0, including the
+//! frame head in the yielded `BytesMut`.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(0) // default value
+//! .length_field_type::<u16>()
+//! .length_adjustment(0) // default value
+//! .num_skip(0) // Do not strip frame header
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT DECODED
+//! +-- len ---+--- Payload ---+ +-- len ---+--- Payload ---+
+//! | \x00\x0B | Hello world | --> | \x00\x0B | Hello world |
+//! +----------+---------------+ +----------+---------------+
+//! ```
+//!
+//! The value of the length field is 11 (`\x0B`) which represents the length
+//! of the payload, `hello world`. By default, [`FramedRead`] assumes that
+//! the length field represents the number of bytes that **follows** the
+//! length field. Thus, the entire frame has a length of 13: 2 bytes for the
+//! frame head + 11 bytes for the payload.
+//!
+//! ## Example 2
+//!
+//! The following will parse a `u16` length field at offset 0, omitting the
+//! frame head in the yielded `BytesMut`.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(0) // default value
+//! .length_field_type::<u16>()
+//! .length_adjustment(0) // default value
+//! // `num_skip` is not needed, the default is to skip
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT DECODED
+//! +-- len ---+--- Payload ---+ +--- Payload ---+
+//! | \x00\x0B | Hello world | --> | Hello world |
+//! +----------+---------------+ +---------------+
+//! ```
+//!
+//! This is similar to the first example, the only difference is that the
+//! frame head is **not** included in the yielded `BytesMut` value.
+//!
+//! ## Example 3
+//!
+//! The following will parse a `u16` length field at offset 0, including the
+//! frame head in the yielded `BytesMut`. In this case, the length field
+//! **includes** the frame head length.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(0) // default value
+//! .length_field_type::<u16>()
+//! .length_adjustment(-2) // size of head
+//! .num_skip(0)
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT DECODED
+//! +-- len ---+--- Payload ---+ +-- len ---+--- Payload ---+
+//! | \x00\x0D | Hello world | --> | \x00\x0D | Hello world |
+//! +----------+---------------+ +----------+---------------+
+//! ```
+//!
+//! In most cases, the length field represents the length of the payload
+//! only, as shown in the previous examples. However, in some protocols the
+//! length field represents the length of the whole frame, including the
+//! head. In such cases, we specify a negative `length_adjustment` to adjust
+//! the value provided in the frame head to represent the payload length.
+//!
+//! ## Example 4
+//!
+//! The following will parse a 3 byte length field at offset 0 in a 5 byte
+//! frame head, including the frame head in the yielded `BytesMut`.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(0) // default value
+//! .length_field_length(3)
+//! .length_adjustment(2) // remaining head
+//! .num_skip(0)
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT
+//! +---- len -----+- head -+--- Payload ---+
+//! | \x00\x00\x0B | \xCAFE | Hello world |
+//! +--------------+--------+---------------+
+//!
+//! DECODED
+//! +---- len -----+- head -+--- Payload ---+
+//! | \x00\x00\x0B | \xCAFE | Hello world |
+//! +--------------+--------+---------------+
+//! ```
+//!
+//! A more advanced example that shows a case where there is extra frame
+//! head data between the length field and the payload. In such cases, it is
+//! usually desirable to include the frame head as part of the yielded
+//! `BytesMut`. This lets consumers of the length delimited framer to
+//! process the frame head as needed.
+//!
+//! The positive `length_adjustment` value lets `FramedRead` factor in the
+//! additional head into the frame length calculation.
+//!
+//! ## Example 5
+//!
+//! The following will parse a `u16` length field at offset 1 of a 4 byte
+//! frame head. The first byte and the length field will be omitted from the
+//! yielded `BytesMut`, but the trailing 2 bytes of the frame head will be
+//! included.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(1) // length of hdr1
+//! .length_field_type::<u16>()
+//! .length_adjustment(1) // length of hdr2
+//! .num_skip(3) // length of hdr1 + LEN
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT
+//! +- hdr1 -+-- len ---+- hdr2 -+--- Payload ---+
+//! | \xCA | \x00\x0B | \xFE | Hello world |
+//! +--------+----------+--------+---------------+
+//!
+//! DECODED
+//! +- hdr2 -+--- Payload ---+
+//! | \xFE | Hello world |
+//! +--------+---------------+
+//! ```
+//!
+//! The length field is situated in the middle of the frame head. In this
+//! case, the first byte in the frame head could be a version or some other
+//! identifier that is not needed for processing. On the other hand, the
+//! second half of the head is needed.
+//!
+//! `length_field_offset` indicates how many bytes to skip before starting
+//! to read the length field. `length_adjustment` is the number of bytes to
+//! skip starting at the end of the length field. In this case, it is the
+//! second half of the head.
+//!
+//! ## Example 6
+//!
+//! The following will parse a `u16` length field at offset 1 of a 4 byte
+//! frame head. The first byte and the length field will be omitted from the
+//! yielded `BytesMut`, but the trailing 2 bytes of the frame head will be
+//! included. In this case, the length field **includes** the frame head
+//! length.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(1) // length of hdr1
+//! .length_field_type::<u16>()
+//! .length_adjustment(-3) // length of hdr1 + LEN, negative
+//! .num_skip(3)
+//! .new_read(io);
+//! # }
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT
+//! +- hdr1 -+-- len ---+- hdr2 -+--- Payload ---+
+//! | \xCA | \x00\x0F | \xFE | Hello world |
+//! +--------+----------+--------+---------------+
+//!
+//! DECODED
+//! +- hdr2 -+--- Payload ---+
+//! | \xFE | Hello world |
+//! +--------+---------------+
+//! ```
+//!
+//! Similar to the example above, the difference is that the length field
+//! represents the length of the entire frame instead of just the payload.
+//! The length of `hdr1` and `len` must be counted in `length_adjustment`.
+//! Note that the length of `hdr2` does **not** need to be explicitly set
+//! anywhere because it already is factored into the total frame length that
+//! is read from the byte stream.
+//!
+//! ## Example 7
+//!
+//! The following will parse a 3 byte length field at offset 0 in a 4 byte
+//! frame head, excluding the 4th byte from the yielded `BytesMut`.
+//!
+//! ```
+//! # use tokio::io::AsyncRead;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn bind_read<T: AsyncRead>(io: T) {
+//! LengthDelimitedCodec::builder()
+//! .length_field_offset(0) // default value
+//! .length_field_length(3)
+//! .length_adjustment(0) // default value
+//! .num_skip(4) // skip the first 4 bytes
+//! .new_read(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! The following frame will be decoded as such:
+//!
+//! ```text
+//! INPUT DECODED
+//! +------- len ------+--- Payload ---+ +--- Payload ---+
+//! | \x00\x00\x0B\xFF | Hello world | => | Hello world |
+//! +------------------+---------------+ +---------------+
+//! ```
+//!
+//! A simple example where there are unused bytes between the length field
+//! and the payload.
+//!
+//! # Encoding
+//!
+//! [`FramedWrite`] adapts an [`AsyncWrite`] into a `Sink` of [`BytesMut`],
+//! such that each submitted [`BytesMut`] is prefaced by a length field.
+//! There are fewer configuration options than [`FramedRead`]. Given
+//! protocols that have more complex frame heads, an encoder should probably
+//! be written by hand using [`Encoder`].
+//!
+//! Here is a simple example, given a `FramedWrite` with the following
+//! configuration:
+//!
+//! ```
+//! # use tokio::io::AsyncWrite;
+//! # use tokio_util::codec::LengthDelimitedCodec;
+//! # fn write_frame<T: AsyncWrite>(io: T) {
+//! # let _ =
+//! LengthDelimitedCodec::builder()
+//! .length_field_type::<u16>()
+//! .new_write(io);
+//! # }
+//! # pub fn main() {}
+//! ```
+//!
+//! A payload of `hello world` will be encoded as:
+//!
+//! ```text
+//! +- len: u16 -+---- data ----+
+//! | \x00\x0b | hello world |
+//! +------------+--------------+
+//! ```
+//!
+//! [`LengthDelimitedCodec::new()`]: method@LengthDelimitedCodec::new
+//! [`FramedRead`]: struct@FramedRead
+//! [`FramedWrite`]: struct@FramedWrite
+//! [`AsyncRead`]: trait@tokio::io::AsyncRead
+//! [`AsyncWrite`]: trait@tokio::io::AsyncWrite
+//! [`Encoder`]: trait@Encoder
+//! [`BytesMut`]: bytes::BytesMut
+
+use crate::codec::{Decoder, Encoder, Framed, FramedRead, FramedWrite};
+
+use tokio::io::{AsyncRead, AsyncWrite};
+
+use bytes::{Buf, BufMut, Bytes, BytesMut};
+use std::error::Error as StdError;
+use std::io::{self, Cursor};
+use std::{cmp, fmt, mem};
+
+/// Configure length delimited `LengthDelimitedCodec`s.
+///
+/// `Builder` enables constructing configured length delimited codecs. Note
+/// that not all configuration settings apply to both encoding and decoding. See
+/// the documentation for specific methods for more detail.
+#[derive(Debug, Clone, Copy)]
+pub struct Builder {
+ // Maximum frame length
+ max_frame_len: usize,
+
+ // Number of bytes representing the field length
+ length_field_len: usize,
+
+ // Number of bytes in the header before the length field
+ length_field_offset: usize,
+
+ // Adjust the length specified in the header field by this amount
+ length_adjustment: isize,
+
+ // Total number of bytes to skip before reading the payload, if not set,
+ // `length_field_len + length_field_offset`
+ num_skip: Option<usize>,
+
+ // Length field byte order (little or big endian)
+ length_field_is_big_endian: bool,
+}
+
+/// An error when the number of bytes read is more than max frame length.
+pub struct LengthDelimitedCodecError {
+ _priv: (),
+}
+
+/// A codec for frames delimited by a frame head specifying their lengths.
+///
+/// This allows the consumer to work with entire frames without having to worry
+/// about buffering or other framing logic.
+///
+/// See [module level] documentation for more detail.
+///
+/// [module level]: index.html
+#[derive(Debug, Clone)]
+pub struct LengthDelimitedCodec {
+ // Configuration values
+ builder: Builder,
+
+ // Read state
+ state: DecodeState,
+}
+
+#[derive(Debug, Clone, Copy)]
+enum DecodeState {
+ Head,
+ Data(usize),
+}
+
+// ===== impl LengthDelimitedCodec ======
+
+impl LengthDelimitedCodec {
+ /// Creates a new `LengthDelimitedCodec` with the default configuration values.
+ pub fn new() -> Self {
+ Self {
+ builder: Builder::new(),
+ state: DecodeState::Head,
+ }
+ }
+
+ /// Creates a new length delimited codec builder with default configuration
+ /// values.
+ pub fn builder() -> Builder {
+ Builder::new()
+ }
+
+ /// Returns the current max frame setting
+ ///
+ /// This is the largest size this codec will accept from the wire. Larger
+ /// frames will be rejected.
+ pub fn max_frame_length(&self) -> usize {
+ self.builder.max_frame_len
+ }
+
+ /// Updates the max frame setting.
+ ///
+ /// The change takes effect the next time a frame is decoded. In other
+ /// words, if a frame is currently in process of being decoded with a frame
+ /// size greater than `val` but less than the max frame length in effect
+ /// before calling this function, then the frame will be allowed.
+ pub fn set_max_frame_length(&mut self, val: usize) {
+ self.builder.max_frame_length(val);
+ }
+
+ fn decode_head(&mut self, src: &mut BytesMut) -> io::Result<Option<usize>> {
+ let head_len = self.builder.num_head_bytes();
+ let field_len = self.builder.length_field_len;
+
+ if src.len() < head_len {
+ // Not enough data
+ return Ok(None);
+ }
+
+ let n = {
+ let mut src = Cursor::new(&mut *src);
+
+ // Skip the required bytes
+ src.advance(self.builder.length_field_offset);
+
+ // match endianness
+ let n = if self.builder.length_field_is_big_endian {
+ src.get_uint(field_len)
+ } else {
+ src.get_uint_le(field_len)
+ };
+
+ if n > self.builder.max_frame_len as u64 {
+ return Err(io::Error::new(
+ io::ErrorKind::InvalidData,
+ LengthDelimitedCodecError { _priv: () },
+ ));
+ }
+
+ // The check above ensures there is no overflow
+ let n = n as usize;
+
+ // Adjust `n` with bounds checking
+ let n = if self.builder.length_adjustment < 0 {
+ n.checked_sub(-self.builder.length_adjustment as usize)
+ } else {
+ n.checked_add(self.builder.length_adjustment as usize)
+ };
+
+ // Error handling
+ match n {
+ Some(n) => n,
+ None => {
+ return Err(io::Error::new(
+ io::ErrorKind::InvalidInput,
+ "provided length would overflow after adjustment",
+ ));
+ }
+ }
+ };
+
+ src.advance(self.builder.get_num_skip());
+
+ // Ensure that the buffer has enough space to read the incoming
+ // payload
+ src.reserve(n.saturating_sub(src.len()));
+
+ Ok(Some(n))
+ }
+
+ fn decode_data(&self, n: usize, src: &mut BytesMut) -> Option<BytesMut> {
+ // At this point, the buffer has already had the required capacity
+ // reserved. All there is to do is read.
+ if src.len() < n {
+ return None;
+ }
+
+ Some(src.split_to(n))
+ }
+}
+
+impl Decoder for LengthDelimitedCodec {
+ type Item = BytesMut;
+ type Error = io::Error;
+
+ fn decode(&mut self, src: &mut BytesMut) -> io::Result<Option<BytesMut>> {
+ let n = match self.state {
+ DecodeState::Head => match self.decode_head(src)? {
+ Some(n) => {
+ self.state = DecodeState::Data(n);
+ n
+ }
+ None => return Ok(None),
+ },
+ DecodeState::Data(n) => n,
+ };
+
+ match self.decode_data(n, src) {
+ Some(data) => {
+ // Update the decode state
+ self.state = DecodeState::Head;
+
+ // Make sure the buffer has enough space to read the next head
+ src.reserve(self.builder.num_head_bytes().saturating_sub(src.len()));
+
+ Ok(Some(data))
+ }
+ None => Ok(None),
+ }
+ }
+}
+
+impl Encoder<Bytes> for LengthDelimitedCodec {
+ type Error = io::Error;
+
+ fn encode(&mut self, data: Bytes, dst: &mut BytesMut) -> Result<(), io::Error> {
+ let n = data.len();
+
+ if n > self.builder.max_frame_len {
+ return Err(io::Error::new(
+ io::ErrorKind::InvalidInput,
+ LengthDelimitedCodecError { _priv: () },
+ ));
+ }
+
+ // Adjust `n` with bounds checking
+ let n = if self.builder.length_adjustment < 0 {
+ n.checked_add(-self.builder.length_adjustment as usize)
+ } else {
+ n.checked_sub(self.builder.length_adjustment as usize)
+ };
+
+ let n = n.ok_or_else(|| {
+ io::Error::new(
+ io::ErrorKind::InvalidInput,
+ "provided length would overflow after adjustment",
+ )
+ })?;
+
+ // Reserve capacity in the destination buffer to fit the frame and
+ // length field (plus adjustment).
+ dst.reserve(self.builder.length_field_len + n);
+
+ if self.builder.length_field_is_big_endian {
+ dst.put_uint(n as u64, self.builder.length_field_len);
+ } else {
+ dst.put_uint_le(n as u64, self.builder.length_field_len);
+ }
+
+ // Write the frame to the buffer
+ dst.extend_from_slice(&data[..]);
+
+ Ok(())
+ }
+}
+
+impl Default for LengthDelimitedCodec {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+// ===== impl Builder =====
+
+mod builder {
+ /// Types that can be used with `Builder::length_field_type`.
+ pub trait LengthFieldType {}
+
+ impl LengthFieldType for u8 {}
+ impl LengthFieldType for u16 {}
+ impl LengthFieldType for u32 {}
+ impl LengthFieldType for u64 {}
+
+ #[cfg(any(
+ target_pointer_width = "8",
+ target_pointer_width = "16",
+ target_pointer_width = "32",
+ target_pointer_width = "64",
+ ))]
+ impl LengthFieldType for usize {}
+}
+
+impl Builder {
+ /// Creates a new length delimited codec builder with default configuration
+ /// values.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_offset(0)
+ /// .length_field_type::<u16>()
+ /// .length_adjustment(0)
+ /// .num_skip(0)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn new() -> Builder {
+ Builder {
+ // Default max frame length of 8MB
+ max_frame_len: 8 * 1_024 * 1_024,
+
+ // Default byte length of 4
+ length_field_len: 4,
+
+ // Default to the header field being at the start of the header.
+ length_field_offset: 0,
+
+ length_adjustment: 0,
+
+ // Total number of bytes to skip before reading the payload, if not set,
+ // `length_field_len + length_field_offset`
+ num_skip: None,
+
+ // Default to reading the length field in network (big) endian.
+ length_field_is_big_endian: true,
+ }
+ }
+
+ /// Read the length field as a big endian integer
+ ///
+ /// This is the default setting.
+ ///
+ /// This configuration option applies to both encoding and decoding.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .big_endian()
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn big_endian(&mut self) -> &mut Self {
+ self.length_field_is_big_endian = true;
+ self
+ }
+
+ /// Read the length field as a little endian integer
+ ///
+ /// The default setting is big endian.
+ ///
+ /// This configuration option applies to both encoding and decoding.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .little_endian()
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn little_endian(&mut self) -> &mut Self {
+ self.length_field_is_big_endian = false;
+ self
+ }
+
+ /// Read the length field as a native endian integer
+ ///
+ /// The default setting is big endian.
+ ///
+ /// This configuration option applies to both encoding and decoding.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .native_endian()
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn native_endian(&mut self) -> &mut Self {
+ if cfg!(target_endian = "big") {
+ self.big_endian()
+ } else {
+ self.little_endian()
+ }
+ }
+
+ /// Sets the max frame length in bytes
+ ///
+ /// This configuration option applies to both encoding and decoding. The
+ /// default value is 8MB.
+ ///
+ /// When decoding, the length field read from the byte stream is checked
+ /// against this setting **before** any adjustments are applied. When
+ /// encoding, the length of the submitted payload is checked against this
+ /// setting.
+ ///
+ /// When frames exceed the max length, an `io::Error` with the custom value
+ /// of the `LengthDelimitedCodecError` type will be returned.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .max_frame_length(8 * 1024 * 1024)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn max_frame_length(&mut self, val: usize) -> &mut Self {
+ self.max_frame_len = val;
+ self
+ }
+
+ /// Sets the unsigned integer type used to represent the length field.
+ ///
+ /// The default type is [`u32`]. The max type is [`u64`] (or [`usize`] on
+ /// 64-bit targets).
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_type::<u32>()
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ ///
+ /// Unlike [`Builder::length_field_length`], this does not fail at runtime
+ /// and instead produces a compile error:
+ ///
+ /// ```compile_fail
+ /// # use tokio::io::AsyncRead;
+ /// # use tokio_util::codec::LengthDelimitedCodec;
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_type::<u128>()
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn length_field_type<T: builder::LengthFieldType>(&mut self) -> &mut Self {
+ self.length_field_length(mem::size_of::<T>())
+ }
+
+ /// Sets the number of bytes used to represent the length field
+ ///
+ /// The default value is `4`. The max value is `8`.
+ ///
+ /// This configuration option applies to both encoding and decoding.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_length(4)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn length_field_length(&mut self, val: usize) -> &mut Self {
+ assert!(val > 0 && val <= 8, "invalid length field length");
+ self.length_field_len = val;
+ self
+ }
+
+ /// Sets the number of bytes in the header before the length field
+ ///
+ /// This configuration option only applies to decoding.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_offset(1)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn length_field_offset(&mut self, val: usize) -> &mut Self {
+ self.length_field_offset = val;
+ self
+ }
+
+ /// Delta between the payload length specified in the header and the real
+ /// payload length
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_adjustment(-2)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn length_adjustment(&mut self, val: isize) -> &mut Self {
+ self.length_adjustment = val;
+ self
+ }
+
+ /// Sets the number of bytes to skip before reading the payload
+ ///
+ /// Default value is `length_field_len + length_field_offset`
+ ///
+ /// This configuration option only applies to decoding
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .num_skip(4)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn num_skip(&mut self, val: usize) -> &mut Self {
+ self.num_skip = Some(val);
+ self
+ }
+
+ /// Create a configured length delimited `LengthDelimitedCodec`
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ /// # pub fn main() {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_offset(0)
+ /// .length_field_type::<u16>()
+ /// .length_adjustment(0)
+ /// .num_skip(0)
+ /// .new_codec();
+ /// # }
+ /// ```
+ pub fn new_codec(&self) -> LengthDelimitedCodec {
+ LengthDelimitedCodec {
+ builder: *self,
+ state: DecodeState::Head,
+ }
+ }
+
+ /// Create a configured length delimited `FramedRead`
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncRead;
+ /// use tokio_util::codec::LengthDelimitedCodec;
+ ///
+ /// # fn bind_read<T: AsyncRead>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_offset(0)
+ /// .length_field_type::<u16>()
+ /// .length_adjustment(0)
+ /// .num_skip(0)
+ /// .new_read(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn new_read<T>(&self, upstream: T) -> FramedRead<T, LengthDelimitedCodec>
+ where
+ T: AsyncRead,
+ {
+ FramedRead::new(upstream, self.new_codec())
+ }
+
+ /// Create a configured length delimited `FramedWrite`
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::AsyncWrite;
+ /// # use tokio_util::codec::LengthDelimitedCodec;
+ /// # fn write_frame<T: AsyncWrite>(io: T) {
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_type::<u16>()
+ /// .new_write(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn new_write<T>(&self, inner: T) -> FramedWrite<T, LengthDelimitedCodec>
+ where
+ T: AsyncWrite,
+ {
+ FramedWrite::new(inner, self.new_codec())
+ }
+
+ /// Create a configured length delimited `Framed`
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tokio::io::{AsyncRead, AsyncWrite};
+ /// # use tokio_util::codec::LengthDelimitedCodec;
+ /// # fn write_frame<T: AsyncRead + AsyncWrite>(io: T) {
+ /// # let _ =
+ /// LengthDelimitedCodec::builder()
+ /// .length_field_type::<u16>()
+ /// .new_framed(io);
+ /// # }
+ /// # pub fn main() {}
+ /// ```
+ pub fn new_framed<T>(&self, inner: T) -> Framed<T, LengthDelimitedCodec>
+ where
+ T: AsyncRead + AsyncWrite,
+ {
+ Framed::new(inner, self.new_codec())
+ }
+
+ fn num_head_bytes(&self) -> usize {
+ let num = self.length_field_offset + self.length_field_len;
+ cmp::max(num, self.num_skip.unwrap_or(0))
+ }
+
+ fn get_num_skip(&self) -> usize {
+ self.num_skip
+ .unwrap_or(self.length_field_offset + self.length_field_len)
+ }
+}
+
+impl Default for Builder {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+// ===== impl LengthDelimitedCodecError =====
+
+impl fmt::Debug for LengthDelimitedCodecError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("LengthDelimitedCodecError").finish()
+ }
+}
+
+impl fmt::Display for LengthDelimitedCodecError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str("frame size too big")
+ }
+}
+
+impl StdError for LengthDelimitedCodecError {}
diff --git a/crates/tokio-util/src/codec/lines_codec.rs b/crates/tokio-util/src/codec/lines_codec.rs
new file mode 100644
index 0000000..5a6035d
--- /dev/null
+++ b/crates/tokio-util/src/codec/lines_codec.rs
@@ -0,0 +1,232 @@
+use crate::codec::decoder::Decoder;
+use crate::codec::encoder::Encoder;
+
+use bytes::{Buf, BufMut, BytesMut};
+use std::{cmp, fmt, io, str, usize};
+
+/// A simple [`Decoder`] and [`Encoder`] implementation that splits up data into lines.
+///
+/// This uses the `\n` character as the line ending on all platforms.
+///
+/// [`Decoder`]: crate::codec::Decoder
+/// [`Encoder`]: crate::codec::Encoder
+#[derive(Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
+pub struct LinesCodec {
+ // Stored index of the next index to examine for a `\n` character.
+ // This is used to optimize searching.
+ // For example, if `decode` was called with `abc`, it would hold `3`,
+ // because that is the next index to examine.
+ // The next time `decode` is called with `abcde\n`, the method will
+ // only look at `de\n` before returning.
+ next_index: usize,
+
+ /// The maximum length for a given line. If `usize::MAX`, lines will be
+ /// read until a `\n` character is reached.
+ max_length: usize,
+
+ /// Are we currently discarding the remainder of a line which was over
+ /// the length limit?
+ is_discarding: bool,
+}
+
+impl LinesCodec {
+ /// Returns a `LinesCodec` for splitting up data into lines.
+ ///
+ /// # Note
+ ///
+ /// The returned `LinesCodec` will not have an upper bound on the length
+ /// of a buffered line. See the documentation for [`new_with_max_length`]
+ /// for information on why this could be a potential security risk.
+ ///
+ /// [`new_with_max_length`]: crate::codec::LinesCodec::new_with_max_length()
+ pub fn new() -> LinesCodec {
+ LinesCodec {
+ next_index: 0,
+ max_length: usize::MAX,
+ is_discarding: false,
+ }
+ }
+
+ /// Returns a `LinesCodec` with a maximum line length limit.
+ ///
+ /// If this is set, calls to `LinesCodec::decode` will return a
+ /// [`LinesCodecError`] when a line exceeds the length limit. Subsequent calls
+ /// will discard up to `limit` bytes from that line until a newline
+ /// character is reached, returning `None` until the line over the limit
+ /// has been fully discarded. After that point, calls to `decode` will
+ /// function as normal.
+ ///
+ /// # Note
+ ///
+ /// Setting a length limit is highly recommended for any `LinesCodec` which
+ /// will be exposed to untrusted input. Otherwise, the size of the buffer
+ /// that holds the line currently being read is unbounded. An attacker could
+ /// exploit this unbounded buffer by sending an unbounded amount of input
+ /// without any `\n` characters, causing unbounded memory consumption.
+ ///
+ /// [`LinesCodecError`]: crate::codec::LinesCodecError
+ pub fn new_with_max_length(max_length: usize) -> Self {
+ LinesCodec {
+ max_length,
+ ..LinesCodec::new()
+ }
+ }
+
+ /// Returns the maximum line length when decoding.
+ ///
+ /// ```
+ /// use std::usize;
+ /// use tokio_util::codec::LinesCodec;
+ ///
+ /// let codec = LinesCodec::new();
+ /// assert_eq!(codec.max_length(), usize::MAX);
+ /// ```
+ /// ```
+ /// use tokio_util::codec::LinesCodec;
+ ///
+ /// let codec = LinesCodec::new_with_max_length(256);
+ /// assert_eq!(codec.max_length(), 256);
+ /// ```
+ pub fn max_length(&self) -> usize {
+ self.max_length
+ }
+}
+
+fn utf8(buf: &[u8]) -> Result<&str, io::Error> {
+ str::from_utf8(buf)
+ .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "Unable to decode input as UTF8"))
+}
+
+fn without_carriage_return(s: &[u8]) -> &[u8] {
+ if let Some(&b'\r') = s.last() {
+ &s[..s.len() - 1]
+ } else {
+ s
+ }
+}
+
+impl Decoder for LinesCodec {
+ type Item = String;
+ type Error = LinesCodecError;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<String>, LinesCodecError> {
+ loop {
+ // Determine how far into the buffer we'll search for a newline. If
+ // there's no max_length set, we'll read to the end of the buffer.
+ let read_to = cmp::min(self.max_length.saturating_add(1), buf.len());
+
+ let newline_offset = buf[self.next_index..read_to]
+ .iter()
+ .position(|b| *b == b'\n');
+
+ match (self.is_discarding, newline_offset) {
+ (true, Some(offset)) => {
+ // If we found a newline, discard up to that offset and
+ // then stop discarding. On the next iteration, we'll try
+ // to read a line normally.
+ buf.advance(offset + self.next_index + 1);
+ self.is_discarding = false;
+ self.next_index = 0;
+ }
+ (true, None) => {
+ // Otherwise, we didn't find a newline, so we'll discard
+ // everything we read. On the next iteration, we'll continue
+ // discarding up to max_len bytes unless we find a newline.
+ buf.advance(read_to);
+ self.next_index = 0;
+ if buf.is_empty() {
+ return Ok(None);
+ }
+ }
+ (false, Some(offset)) => {
+ // Found a line!
+ let newline_index = offset + self.next_index;
+ self.next_index = 0;
+ let line = buf.split_to(newline_index + 1);
+ let line = &line[..line.len() - 1];
+ let line = without_carriage_return(line);
+ let line = utf8(line)?;
+ return Ok(Some(line.to_string()));
+ }
+ (false, None) if buf.len() > self.max_length => {
+ // Reached the maximum length without finding a
+ // newline, return an error and start discarding on the
+ // next call.
+ self.is_discarding = true;
+ return Err(LinesCodecError::MaxLineLengthExceeded);
+ }
+ (false, None) => {
+ // We didn't find a line or reach the length limit, so the next
+ // call will resume searching at the current offset.
+ self.next_index = read_to;
+ return Ok(None);
+ }
+ }
+ }
+ }
+
+ fn decode_eof(&mut self, buf: &mut BytesMut) -> Result<Option<String>, LinesCodecError> {
+ Ok(match self.decode(buf)? {
+ Some(frame) => Some(frame),
+ None => {
+ // No terminating newline - return remaining data, if any
+ if buf.is_empty() || buf == &b"\r"[..] {
+ None
+ } else {
+ let line = buf.split_to(buf.len());
+ let line = without_carriage_return(&line);
+ let line = utf8(line)?;
+ self.next_index = 0;
+ Some(line.to_string())
+ }
+ }
+ })
+ }
+}
+
+impl<T> Encoder<T> for LinesCodec
+where
+ T: AsRef<str>,
+{
+ type Error = LinesCodecError;
+
+ fn encode(&mut self, line: T, buf: &mut BytesMut) -> Result<(), LinesCodecError> {
+ let line = line.as_ref();
+ buf.reserve(line.len() + 1);
+ buf.put(line.as_bytes());
+ buf.put_u8(b'\n');
+ Ok(())
+ }
+}
+
+impl Default for LinesCodec {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+/// An error occurred while encoding or decoding a line.
+#[derive(Debug)]
+pub enum LinesCodecError {
+ /// The maximum line length was exceeded.
+ MaxLineLengthExceeded,
+ /// An IO error occurred.
+ Io(io::Error),
+}
+
+impl fmt::Display for LinesCodecError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ LinesCodecError::MaxLineLengthExceeded => write!(f, "max line length exceeded"),
+ LinesCodecError::Io(e) => write!(f, "{}", e),
+ }
+ }
+}
+
+impl From<io::Error> for LinesCodecError {
+ fn from(e: io::Error) -> LinesCodecError {
+ LinesCodecError::Io(e)
+ }
+}
+
+impl std::error::Error for LinesCodecError {}
diff --git a/crates/tokio-util/src/codec/mod.rs b/crates/tokio-util/src/codec/mod.rs
new file mode 100644
index 0000000..2295176
--- /dev/null
+++ b/crates/tokio-util/src/codec/mod.rs
@@ -0,0 +1,290 @@
+//! Adaptors from AsyncRead/AsyncWrite to Stream/Sink
+//!
+//! Raw I/O objects work with byte sequences, but higher-level code usually
+//! wants to batch these into meaningful chunks, called "frames".
+//!
+//! This module contains adapters to go from streams of bytes, [`AsyncRead`] and
+//! [`AsyncWrite`], to framed streams implementing [`Sink`] and [`Stream`].
+//! Framed streams are also known as transports.
+//!
+//! # The Decoder trait
+//!
+//! A [`Decoder`] is used together with [`FramedRead`] or [`Framed`] to turn an
+//! [`AsyncRead`] into a [`Stream`]. The job of the decoder trait is to specify
+//! how sequences of bytes are turned into a sequence of frames, and to
+//! determine where the boundaries between frames are. The job of the
+//! `FramedRead` is to repeatedly switch between reading more data from the IO
+//! resource, and asking the decoder whether we have received enough data to
+//! decode another frame of data.
+//!
+//! The main method on the `Decoder` trait is the [`decode`] method. This method
+//! takes as argument the data that has been read so far, and when it is called,
+//! it will be in one of the following situations:
+//!
+//! 1. The buffer contains less than a full frame.
+//! 2. The buffer contains exactly a full frame.
+//! 3. The buffer contains more than a full frame.
+//!
+//! In the first situation, the decoder should return `Ok(None)`.
+//!
+//! In the second situation, the decoder should clear the provided buffer and
+//! return `Ok(Some(the_decoded_frame))`.
+//!
+//! In the third situation, the decoder should use a method such as [`split_to`]
+//! or [`advance`] to modify the buffer such that the frame is removed from the
+//! buffer, but any data in the buffer after that frame should still remain in
+//! the buffer. The decoder should also return `Ok(Some(the_decoded_frame))` in
+//! this case.
+//!
+//! Finally the decoder may return an error if the data is invalid in some way.
+//! The decoder should _not_ return an error just because it has yet to receive
+//! a full frame.
+//!
+//! It is guaranteed that, from one call to `decode` to another, the provided
+//! buffer will contain the exact same data as before, except that if more data
+//! has arrived through the IO resource, that data will have been appended to
+//! the buffer. This means that reading frames from a `FramedRead` is
+//! essentially equivalent to the following loop:
+//!
+//! ```no_run
+//! use tokio::io::AsyncReadExt;
+//! # // This uses async_stream to create an example that compiles.
+//! # fn foo() -> impl futures_core::Stream<Item = std::io::Result<bytes::BytesMut>> { async_stream::try_stream! {
+//! # use tokio_util::codec::Decoder;
+//! # let mut decoder = tokio_util::codec::BytesCodec::new();
+//! # let io_resource = &mut &[0u8, 1, 2, 3][..];
+//!
+//! let mut buf = bytes::BytesMut::new();
+//! loop {
+//! // The read_buf call will append to buf rather than overwrite existing data.
+//! let len = io_resource.read_buf(&mut buf).await?;
+//!
+//! if len == 0 {
+//! while let Some(frame) = decoder.decode_eof(&mut buf)? {
+//! yield frame;
+//! }
+//! break;
+//! }
+//!
+//! while let Some(frame) = decoder.decode(&mut buf)? {
+//! yield frame;
+//! }
+//! }
+//! # }}
+//! ```
+//! The example above uses `yield` whenever the `Stream` produces an item.
+//!
+//! ## Example decoder
+//!
+//! As an example, consider a protocol that can be used to send strings where
+//! each frame is a four byte integer that contains the length of the frame,
+//! followed by that many bytes of string data. The decoder fails with an error
+//! if the string data is not valid utf-8 or too long.
+//!
+//! Such a decoder can be written like this:
+//! ```
+//! use tokio_util::codec::Decoder;
+//! use bytes::{BytesMut, Buf};
+//!
+//! struct MyStringDecoder {}
+//!
+//! const MAX: usize = 8 * 1024 * 1024;
+//!
+//! impl Decoder for MyStringDecoder {
+//! type Item = String;
+//! type Error = std::io::Error;
+//!
+//! fn decode(
+//! &mut self,
+//! src: &mut BytesMut
+//! ) -> Result<Option<Self::Item>, Self::Error> {
+//! if src.len() < 4 {
+//! // Not enough data to read length marker.
+//! return Ok(None);
+//! }
+//!
+//! // Read length marker.
+//! let mut length_bytes = [0u8; 4];
+//! length_bytes.copy_from_slice(&src[..4]);
+//! let length = u32::from_le_bytes(length_bytes) as usize;
+//!
+//! // Check that the length is not too large to avoid a denial of
+//! // service attack where the server runs out of memory.
+//! if length > MAX {
+//! return Err(std::io::Error::new(
+//! std::io::ErrorKind::InvalidData,
+//! format!("Frame of length {} is too large.", length)
+//! ));
+//! }
+//!
+//! if src.len() < 4 + length {
+//! // The full string has not yet arrived.
+//! //
+//! // We reserve more space in the buffer. This is not strictly
+//! // necessary, but is a good idea performance-wise.
+//! src.reserve(4 + length - src.len());
+//!
+//! // We inform the Framed that we need more bytes to form the next
+//! // frame.
+//! return Ok(None);
+//! }
+//!
+//! // Use advance to modify src such that it no longer contains
+//! // this frame.
+//! let data = src[4..4 + length].to_vec();
+//! src.advance(4 + length);
+//!
+//! // Convert the data to a string, or fail if it is not valid utf-8.
+//! match String::from_utf8(data) {
+//! Ok(string) => Ok(Some(string)),
+//! Err(utf8_error) => {
+//! Err(std::io::Error::new(
+//! std::io::ErrorKind::InvalidData,
+//! utf8_error.utf8_error(),
+//! ))
+//! },
+//! }
+//! }
+//! }
+//! ```
+//!
+//! # The Encoder trait
+//!
+//! An [`Encoder`] is used together with [`FramedWrite`] or [`Framed`] to turn
+//! an [`AsyncWrite`] into a [`Sink`]. The job of the encoder trait is to
+//! specify how frames are turned into a sequences of bytes. The job of the
+//! `FramedWrite` is to take the resulting sequence of bytes and write it to the
+//! IO resource.
+//!
+//! The main method on the `Encoder` trait is the [`encode`] method. This method
+//! takes an item that is being written, and a buffer to write the item to. The
+//! buffer may already contain data, and in this case, the encoder should append
+//! the new frame the to buffer rather than overwrite the existing data.
+//!
+//! It is guaranteed that, from one call to `encode` to another, the provided
+//! buffer will contain the exact same data as before, except that some of the
+//! data may have been removed from the front of the buffer. Writing to a
+//! `FramedWrite` is essentially equivalent to the following loop:
+//!
+//! ```no_run
+//! use tokio::io::AsyncWriteExt;
+//! use bytes::Buf; // for advance
+//! # use tokio_util::codec::Encoder;
+//! # async fn next_frame() -> bytes::Bytes { bytes::Bytes::new() }
+//! # async fn no_more_frames() { }
+//! # #[tokio::main] async fn main() -> std::io::Result<()> {
+//! # let mut io_resource = tokio::io::sink();
+//! # let mut encoder = tokio_util::codec::BytesCodec::new();
+//!
+//! const MAX: usize = 8192;
+//!
+//! let mut buf = bytes::BytesMut::new();
+//! loop {
+//! tokio::select! {
+//! num_written = io_resource.write(&buf), if !buf.is_empty() => {
+//! buf.advance(num_written?);
+//! },
+//! frame = next_frame(), if buf.len() < MAX => {
+//! encoder.encode(frame, &mut buf)?;
+//! },
+//! _ = no_more_frames() => {
+//! io_resource.write_all(&buf).await?;
+//! io_resource.shutdown().await?;
+//! return Ok(());
+//! },
+//! }
+//! }
+//! # }
+//! ```
+//! Here the `next_frame` method corresponds to any frames you write to the
+//! `FramedWrite`. The `no_more_frames` method corresponds to closing the
+//! `FramedWrite` with [`SinkExt::close`].
+//!
+//! ## Example encoder
+//!
+//! As an example, consider a protocol that can be used to send strings where
+//! each frame is a four byte integer that contains the length of the frame,
+//! followed by that many bytes of string data. The encoder will fail if the
+//! string is too long.
+//!
+//! Such an encoder can be written like this:
+//! ```
+//! use tokio_util::codec::Encoder;
+//! use bytes::BytesMut;
+//!
+//! struct MyStringEncoder {}
+//!
+//! const MAX: usize = 8 * 1024 * 1024;
+//!
+//! impl Encoder<String> for MyStringEncoder {
+//! type Error = std::io::Error;
+//!
+//! fn encode(&mut self, item: String, dst: &mut BytesMut) -> Result<(), Self::Error> {
+//! // Don't send a string if it is longer than the other end will
+//! // accept.
+//! if item.len() > MAX {
+//! return Err(std::io::Error::new(
+//! std::io::ErrorKind::InvalidData,
+//! format!("Frame of length {} is too large.", item.len())
+//! ));
+//! }
+//!
+//! // Convert the length into a byte array.
+//! // The cast to u32 cannot overflow due to the length check above.
+//! let len_slice = u32::to_le_bytes(item.len() as u32);
+//!
+//! // Reserve space in the buffer.
+//! dst.reserve(4 + item.len());
+//!
+//! // Write the length and string to the buffer.
+//! dst.extend_from_slice(&len_slice);
+//! dst.extend_from_slice(item.as_bytes());
+//! Ok(())
+//! }
+//! }
+//! ```
+//!
+//! [`AsyncRead`]: tokio::io::AsyncRead
+//! [`AsyncWrite`]: tokio::io::AsyncWrite
+//! [`Stream`]: futures_core::Stream
+//! [`Sink`]: futures_sink::Sink
+//! [`SinkExt::close`]: https://docs.rs/futures/0.3/futures/sink/trait.SinkExt.html#method.close
+//! [`FramedRead`]: struct@crate::codec::FramedRead
+//! [`FramedWrite`]: struct@crate::codec::FramedWrite
+//! [`Framed`]: struct@crate::codec::Framed
+//! [`Decoder`]: trait@crate::codec::Decoder
+//! [`decode`]: fn@crate::codec::Decoder::decode
+//! [`encode`]: fn@crate::codec::Encoder::encode
+//! [`split_to`]: fn@bytes::BytesMut::split_to
+//! [`advance`]: fn@bytes::Buf::advance
+
+mod bytes_codec;
+pub use self::bytes_codec::BytesCodec;
+
+mod decoder;
+pub use self::decoder::Decoder;
+
+mod encoder;
+pub use self::encoder::Encoder;
+
+mod framed_impl;
+#[allow(unused_imports)]
+pub(crate) use self::framed_impl::{FramedImpl, RWFrames, ReadFrame, WriteFrame};
+
+mod framed;
+pub use self::framed::{Framed, FramedParts};
+
+mod framed_read;
+pub use self::framed_read::FramedRead;
+
+mod framed_write;
+pub use self::framed_write::FramedWrite;
+
+pub mod length_delimited;
+pub use self::length_delimited::{LengthDelimitedCodec, LengthDelimitedCodecError};
+
+mod lines_codec;
+pub use self::lines_codec::{LinesCodec, LinesCodecError};
+
+mod any_delimiter_codec;
+pub use self::any_delimiter_codec::{AnyDelimiterCodec, AnyDelimiterCodecError};
diff --git a/crates/tokio-util/src/compat.rs b/crates/tokio-util/src/compat.rs
new file mode 100644
index 0000000..423bd95
--- /dev/null
+++ b/crates/tokio-util/src/compat.rs
@@ -0,0 +1,276 @@
+//! Compatibility between the `tokio::io` and `futures-io` versions of the
+//! `AsyncRead` and `AsyncWrite` traits.
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+pin_project! {
+ /// A compatibility layer that allows conversion between the
+ /// `tokio::io` and `futures-io` `AsyncRead` and `AsyncWrite` traits.
+ #[derive(Copy, Clone, Debug)]
+ pub struct Compat<T> {
+ #[pin]
+ inner: T,
+ seek_pos: Option<io::SeekFrom>,
+ }
+}
+
+/// Extension trait that allows converting a type implementing
+/// `futures_io::AsyncRead` to implement `tokio::io::AsyncRead`.
+pub trait FuturesAsyncReadCompatExt: futures_io::AsyncRead {
+ /// Wraps `self` with a compatibility layer that implements
+ /// `tokio_io::AsyncRead`.
+ fn compat(self) -> Compat<Self>
+ where
+ Self: Sized,
+ {
+ Compat::new(self)
+ }
+}
+
+impl<T: futures_io::AsyncRead> FuturesAsyncReadCompatExt for T {}
+
+/// Extension trait that allows converting a type implementing
+/// `futures_io::AsyncWrite` to implement `tokio::io::AsyncWrite`.
+pub trait FuturesAsyncWriteCompatExt: futures_io::AsyncWrite {
+ /// Wraps `self` with a compatibility layer that implements
+ /// `tokio::io::AsyncWrite`.
+ fn compat_write(self) -> Compat<Self>
+ where
+ Self: Sized,
+ {
+ Compat::new(self)
+ }
+}
+
+impl<T: futures_io::AsyncWrite> FuturesAsyncWriteCompatExt for T {}
+
+/// Extension trait that allows converting a type implementing
+/// `tokio::io::AsyncRead` to implement `futures_io::AsyncRead`.
+pub trait TokioAsyncReadCompatExt: tokio::io::AsyncRead {
+ /// Wraps `self` with a compatibility layer that implements
+ /// `futures_io::AsyncRead`.
+ fn compat(self) -> Compat<Self>
+ where
+ Self: Sized,
+ {
+ Compat::new(self)
+ }
+}
+
+impl<T: tokio::io::AsyncRead> TokioAsyncReadCompatExt for T {}
+
+/// Extension trait that allows converting a type implementing
+/// `tokio::io::AsyncWrite` to implement `futures_io::AsyncWrite`.
+pub trait TokioAsyncWriteCompatExt: tokio::io::AsyncWrite {
+ /// Wraps `self` with a compatibility layer that implements
+ /// `futures_io::AsyncWrite`.
+ fn compat_write(self) -> Compat<Self>
+ where
+ Self: Sized,
+ {
+ Compat::new(self)
+ }
+}
+
+impl<T: tokio::io::AsyncWrite> TokioAsyncWriteCompatExt for T {}
+
+// === impl Compat ===
+
+impl<T> Compat<T> {
+ fn new(inner: T) -> Self {
+ Self {
+ inner,
+ seek_pos: None,
+ }
+ }
+
+ /// Get a reference to the `Future`, `Stream`, `AsyncRead`, or `AsyncWrite` object
+ /// contained within.
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the `Future`, `Stream`, `AsyncRead`, or `AsyncWrite` object
+ /// contained within.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Returns the wrapped item.
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<T> tokio::io::AsyncRead for Compat<T>
+where
+ T: futures_io::AsyncRead,
+{
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut tokio::io::ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ // We can't trust the inner type to not peak at the bytes,
+ // so we must defensively initialize the buffer.
+ let slice = buf.initialize_unfilled();
+ let n = ready!(futures_io::AsyncRead::poll_read(
+ self.project().inner,
+ cx,
+ slice
+ ))?;
+ buf.advance(n);
+ Poll::Ready(Ok(()))
+ }
+}
+
+impl<T> futures_io::AsyncRead for Compat<T>
+where
+ T: tokio::io::AsyncRead,
+{
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ slice: &mut [u8],
+ ) -> Poll<io::Result<usize>> {
+ let mut buf = tokio::io::ReadBuf::new(slice);
+ ready!(tokio::io::AsyncRead::poll_read(
+ self.project().inner,
+ cx,
+ &mut buf
+ ))?;
+ Poll::Ready(Ok(buf.filled().len()))
+ }
+}
+
+impl<T> tokio::io::AsyncBufRead for Compat<T>
+where
+ T: futures_io::AsyncBufRead,
+{
+ fn poll_fill_buf<'a>(
+ self: Pin<&'a mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<io::Result<&'a [u8]>> {
+ futures_io::AsyncBufRead::poll_fill_buf(self.project().inner, cx)
+ }
+
+ fn consume(self: Pin<&mut Self>, amt: usize) {
+ futures_io::AsyncBufRead::consume(self.project().inner, amt)
+ }
+}
+
+impl<T> futures_io::AsyncBufRead for Compat<T>
+where
+ T: tokio::io::AsyncBufRead,
+{
+ fn poll_fill_buf<'a>(
+ self: Pin<&'a mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<io::Result<&'a [u8]>> {
+ tokio::io::AsyncBufRead::poll_fill_buf(self.project().inner, cx)
+ }
+
+ fn consume(self: Pin<&mut Self>, amt: usize) {
+ tokio::io::AsyncBufRead::consume(self.project().inner, amt)
+ }
+}
+
+impl<T> tokio::io::AsyncWrite for Compat<T>
+where
+ T: futures_io::AsyncWrite,
+{
+ fn poll_write(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<io::Result<usize>> {
+ futures_io::AsyncWrite::poll_write(self.project().inner, cx, buf)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+ futures_io::AsyncWrite::poll_flush(self.project().inner, cx)
+ }
+
+ fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+ futures_io::AsyncWrite::poll_close(self.project().inner, cx)
+ }
+}
+
+impl<T> futures_io::AsyncWrite for Compat<T>
+where
+ T: tokio::io::AsyncWrite,
+{
+ fn poll_write(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<io::Result<usize>> {
+ tokio::io::AsyncWrite::poll_write(self.project().inner, cx, buf)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+ tokio::io::AsyncWrite::poll_flush(self.project().inner, cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<()>> {
+ tokio::io::AsyncWrite::poll_shutdown(self.project().inner, cx)
+ }
+}
+
+impl<T: tokio::io::AsyncSeek> futures_io::AsyncSeek for Compat<T> {
+ fn poll_seek(
+ mut self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ pos: io::SeekFrom,
+ ) -> Poll<io::Result<u64>> {
+ if self.seek_pos != Some(pos) {
+ // Ensure previous seeks have finished before starting a new one
+ ready!(self.as_mut().project().inner.poll_complete(cx))?;
+ self.as_mut().project().inner.start_seek(pos)?;
+ *self.as_mut().project().seek_pos = Some(pos);
+ }
+ let res = ready!(self.as_mut().project().inner.poll_complete(cx));
+ *self.as_mut().project().seek_pos = None;
+ Poll::Ready(res)
+ }
+}
+
+impl<T: futures_io::AsyncSeek> tokio::io::AsyncSeek for Compat<T> {
+ fn start_seek(mut self: Pin<&mut Self>, pos: io::SeekFrom) -> io::Result<()> {
+ *self.as_mut().project().seek_pos = Some(pos);
+ Ok(())
+ }
+
+ fn poll_complete(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<u64>> {
+ let pos = match self.seek_pos {
+ None => {
+ // tokio 1.x AsyncSeek recommends calling poll_complete before start_seek.
+ // We don't have to guarantee that the value returned by
+ // poll_complete called without start_seek is correct,
+ // so we'll return 0.
+ return Poll::Ready(Ok(0));
+ }
+ Some(pos) => pos,
+ };
+ let res = ready!(self.as_mut().project().inner.poll_seek(cx, pos));
+ *self.as_mut().project().seek_pos = None;
+ Poll::Ready(res)
+ }
+}
+
+#[cfg(unix)]
+impl<T: std::os::unix::io::AsRawFd> std::os::unix::io::AsRawFd for Compat<T> {
+ fn as_raw_fd(&self) -> std::os::unix::io::RawFd {
+ self.inner.as_raw_fd()
+ }
+}
+
+#[cfg(windows)]
+impl<T: std::os::windows::io::AsRawHandle> std::os::windows::io::AsRawHandle for Compat<T> {
+ fn as_raw_handle(&self) -> std::os::windows::io::RawHandle {
+ self.inner.as_raw_handle()
+ }
+}
diff --git a/crates/tokio-util/src/context.rs b/crates/tokio-util/src/context.rs
new file mode 100644
index 0000000..a7a5e02
--- /dev/null
+++ b/crates/tokio-util/src/context.rs
@@ -0,0 +1,190 @@
+//! Tokio context aware futures utilities.
+//!
+//! This module includes utilities around integrating tokio with other runtimes
+//! by allowing the context to be attached to futures. This allows spawning
+//! futures on other executors while still using tokio to drive them. This
+//! can be useful if you need to use a tokio based library in an executor/runtime
+//! that does not provide a tokio context.
+
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::runtime::{Handle, Runtime};
+
+pin_project! {
+ /// `TokioContext` allows running futures that must be inside Tokio's
+ /// context on a non-Tokio runtime.
+ ///
+ /// It contains a [`Handle`] to the runtime. A handle to the runtime can be
+ /// obtain by calling the [`Runtime::handle()`] method.
+ ///
+ /// Note that the `TokioContext` wrapper only works if the `Runtime` it is
+ /// connected to has not yet been destroyed. You must keep the `Runtime`
+ /// alive until the future has finished executing.
+ ///
+ /// **Warning:** If `TokioContext` is used together with a [current thread]
+ /// runtime, that runtime must be inside a call to `block_on` for the
+ /// wrapped future to work. For this reason, it is recommended to use a
+ /// [multi thread] runtime, even if you configure it to only spawn one
+ /// worker thread.
+ ///
+ /// # Examples
+ ///
+ /// This example creates two runtimes, but only [enables time] on one of
+ /// them. It then uses the context of the runtime with the timer enabled to
+ /// execute a [`sleep`] future on the runtime with timing disabled.
+ /// ```
+ /// use tokio::time::{sleep, Duration};
+ /// use tokio_util::context::RuntimeExt;
+ ///
+ /// // This runtime has timers enabled.
+ /// let rt = tokio::runtime::Builder::new_multi_thread()
+ /// .enable_all()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// // This runtime has timers disabled.
+ /// let rt2 = tokio::runtime::Builder::new_multi_thread()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// // Wrap the sleep future in the context of rt.
+ /// let fut = rt.wrap(async { sleep(Duration::from_millis(2)).await });
+ ///
+ /// // Execute the future on rt2.
+ /// rt2.block_on(fut);
+ /// ```
+ ///
+ /// [`Handle`]: struct@tokio::runtime::Handle
+ /// [`Runtime::handle()`]: fn@tokio::runtime::Runtime::handle
+ /// [`RuntimeExt`]: trait@crate::context::RuntimeExt
+ /// [`new_static`]: fn@Self::new_static
+ /// [`sleep`]: fn@tokio::time::sleep
+ /// [current thread]: fn@tokio::runtime::Builder::new_current_thread
+ /// [enables time]: fn@tokio::runtime::Builder::enable_time
+ /// [multi thread]: fn@tokio::runtime::Builder::new_multi_thread
+ pub struct TokioContext<F> {
+ #[pin]
+ inner: F,
+ handle: Handle,
+ }
+}
+
+impl<F> TokioContext<F> {
+ /// Associate the provided future with the context of the runtime behind
+ /// the provided `Handle`.
+ ///
+ /// This constructor uses a `'static` lifetime to opt-out of checking that
+ /// the runtime still exists.
+ ///
+ /// # Examples
+ ///
+ /// This is the same as the example above, but uses the `new` constructor
+ /// rather than [`RuntimeExt::wrap`].
+ ///
+ /// [`RuntimeExt::wrap`]: fn@RuntimeExt::wrap
+ ///
+ /// ```
+ /// use tokio::time::{sleep, Duration};
+ /// use tokio_util::context::TokioContext;
+ ///
+ /// // This runtime has timers enabled.
+ /// let rt = tokio::runtime::Builder::new_multi_thread()
+ /// .enable_all()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// // This runtime has timers disabled.
+ /// let rt2 = tokio::runtime::Builder::new_multi_thread()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// let fut = TokioContext::new(
+ /// async { sleep(Duration::from_millis(2)).await },
+ /// rt.handle().clone(),
+ /// );
+ ///
+ /// // Execute the future on rt2.
+ /// rt2.block_on(fut);
+ /// ```
+ pub fn new(future: F, handle: Handle) -> TokioContext<F> {
+ TokioContext {
+ inner: future,
+ handle,
+ }
+ }
+
+ /// Obtain a reference to the handle inside this `TokioContext`.
+ pub fn handle(&self) -> &Handle {
+ &self.handle
+ }
+
+ /// Remove the association between the Tokio runtime and the wrapped future.
+ pub fn into_inner(self) -> F {
+ self.inner
+ }
+}
+
+impl<F: Future> Future for TokioContext<F> {
+ type Output = F::Output;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let me = self.project();
+ let handle = me.handle;
+ let fut = me.inner;
+
+ let _enter = handle.enter();
+ fut.poll(cx)
+ }
+}
+
+/// Extension trait that simplifies bundling a `Handle` with a `Future`.
+pub trait RuntimeExt {
+ /// Create a [`TokioContext`] that wraps the provided future and runs it in
+ /// this runtime's context.
+ ///
+ /// # Examples
+ ///
+ /// This example creates two runtimes, but only [enables time] on one of
+ /// them. It then uses the context of the runtime with the timer enabled to
+ /// execute a [`sleep`] future on the runtime with timing disabled.
+ ///
+ /// ```
+ /// use tokio::time::{sleep, Duration};
+ /// use tokio_util::context::RuntimeExt;
+ ///
+ /// // This runtime has timers enabled.
+ /// let rt = tokio::runtime::Builder::new_multi_thread()
+ /// .enable_all()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// // This runtime has timers disabled.
+ /// let rt2 = tokio::runtime::Builder::new_multi_thread()
+ /// .build()
+ /// .unwrap();
+ ///
+ /// // Wrap the sleep future in the context of rt.
+ /// let fut = rt.wrap(async { sleep(Duration::from_millis(2)).await });
+ ///
+ /// // Execute the future on rt2.
+ /// rt2.block_on(fut);
+ /// ```
+ ///
+ /// [`TokioContext`]: struct@crate::context::TokioContext
+ /// [`sleep`]: fn@tokio::time::sleep
+ /// [enables time]: fn@tokio::runtime::Builder::enable_time
+ fn wrap<F: Future>(&self, fut: F) -> TokioContext<F>;
+}
+
+impl RuntimeExt for Runtime {
+ fn wrap<F: Future>(&self, fut: F) -> TokioContext<F> {
+ TokioContext {
+ inner: fut,
+ handle: self.handle().clone(),
+ }
+ }
+}
diff --git a/crates/tokio-util/src/either.rs b/crates/tokio-util/src/either.rs
new file mode 100644
index 0000000..8a02398
--- /dev/null
+++ b/crates/tokio-util/src/either.rs
@@ -0,0 +1,188 @@
+//! Module defining an Either type.
+use std::{
+ future::Future,
+ io::SeekFrom,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::io::{AsyncBufRead, AsyncRead, AsyncSeek, AsyncWrite, ReadBuf, Result};
+
+/// Combines two different futures, streams, or sinks having the same associated types into a single type.
+///
+/// This type implements common asynchronous traits such as [`Future`] and those in Tokio.
+///
+/// [`Future`]: std::future::Future
+///
+/// # Example
+///
+/// The following code will not work:
+///
+/// ```compile_fail
+/// # fn some_condition() -> bool { true }
+/// # async fn some_async_function() -> u32 { 10 }
+/// # async fn other_async_function() -> u32 { 20 }
+/// #[tokio::main]
+/// async fn main() {
+/// let result = if some_condition() {
+/// some_async_function()
+/// } else {
+/// other_async_function() // <- Will print: "`if` and `else` have incompatible types"
+/// };
+///
+/// println!("Result is {}", result.await);
+/// }
+/// ```
+///
+// This is because although the output types for both futures is the same, the exact future
+// types are different, but the compiler must be able to choose a single type for the
+// `result` variable.
+///
+/// When the output type is the same, we can wrap each future in `Either` to avoid the
+/// issue:
+///
+/// ```
+/// use tokio_util::either::Either;
+/// # fn some_condition() -> bool { true }
+/// # async fn some_async_function() -> u32 { 10 }
+/// # async fn other_async_function() -> u32 { 20 }
+///
+/// #[tokio::main]
+/// async fn main() {
+/// let result = if some_condition() {
+/// Either::Left(some_async_function())
+/// } else {
+/// Either::Right(other_async_function())
+/// };
+///
+/// let value = result.await;
+/// println!("Result is {}", value);
+/// # assert_eq!(value, 10);
+/// }
+/// ```
+#[allow(missing_docs)] // Doc-comments for variants in this particular case don't make much sense.
+#[derive(Debug, Clone)]
+pub enum Either<L, R> {
+ Left(L),
+ Right(R),
+}
+
+/// A small helper macro which reduces amount of boilerplate in the actual trait method implementation.
+/// It takes an invocation of method as an argument (e.g. `self.poll(cx)`), and redirects it to either
+/// enum variant held in `self`.
+macro_rules! delegate_call {
+ ($self:ident.$method:ident($($args:ident),+)) => {
+ unsafe {
+ match $self.get_unchecked_mut() {
+ Self::Left(l) => Pin::new_unchecked(l).$method($($args),+),
+ Self::Right(r) => Pin::new_unchecked(r).$method($($args),+),
+ }
+ }
+ }
+}
+
+impl<L, R, O> Future for Either<L, R>
+where
+ L: Future<Output = O>,
+ R: Future<Output = O>,
+{
+ type Output = O;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ delegate_call!(self.poll(cx))
+ }
+}
+
+impl<L, R> AsyncRead for Either<L, R>
+where
+ L: AsyncRead,
+ R: AsyncRead,
+{
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<Result<()>> {
+ delegate_call!(self.poll_read(cx, buf))
+ }
+}
+
+impl<L, R> AsyncBufRead for Either<L, R>
+where
+ L: AsyncBufRead,
+ R: AsyncBufRead,
+{
+ fn poll_fill_buf(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<&[u8]>> {
+ delegate_call!(self.poll_fill_buf(cx))
+ }
+
+ fn consume(self: Pin<&mut Self>, amt: usize) {
+ delegate_call!(self.consume(amt));
+ }
+}
+
+impl<L, R> AsyncSeek for Either<L, R>
+where
+ L: AsyncSeek,
+ R: AsyncSeek,
+{
+ fn start_seek(self: Pin<&mut Self>, position: SeekFrom) -> Result<()> {
+ delegate_call!(self.start_seek(position))
+ }
+
+ fn poll_complete(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<u64>> {
+ delegate_call!(self.poll_complete(cx))
+ }
+}
+
+impl<L, R> AsyncWrite for Either<L, R>
+where
+ L: AsyncWrite,
+ R: AsyncWrite,
+{
+ fn poll_write(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>> {
+ delegate_call!(self.poll_write(cx, buf))
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<tokio::io::Result<()>> {
+ delegate_call!(self.poll_flush(cx))
+ }
+
+ fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<tokio::io::Result<()>> {
+ delegate_call!(self.poll_shutdown(cx))
+ }
+}
+
+impl<L, R> futures_core::stream::Stream for Either<L, R>
+where
+ L: futures_core::stream::Stream,
+ R: futures_core::stream::Stream<Item = L::Item>,
+{
+ type Item = L::Item;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ delegate_call!(self.poll_next(cx))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use tokio::io::{repeat, AsyncReadExt, Repeat};
+ use tokio_stream::{once, Once, StreamExt};
+
+ #[tokio::test]
+ async fn either_is_stream() {
+ let mut either: Either<Once<u32>, Once<u32>> = Either::Left(once(1));
+
+ assert_eq!(Some(1u32), either.next().await);
+ }
+
+ #[tokio::test]
+ async fn either_is_async_read() {
+ let mut buffer = [0; 3];
+ let mut either: Either<Repeat, Repeat> = Either::Right(repeat(0b101));
+
+ either.read_exact(&mut buffer).await.unwrap();
+ assert_eq!(buffer, [0b101, 0b101, 0b101]);
+ }
+}
diff --git a/crates/tokio-util/src/io/copy_to_bytes.rs b/crates/tokio-util/src/io/copy_to_bytes.rs
new file mode 100644
index 0000000..f0b5c35
--- /dev/null
+++ b/crates/tokio-util/src/io/copy_to_bytes.rs
@@ -0,0 +1,76 @@
+use bytes::Bytes;
+use futures_core::stream::Stream;
+use futures_sink::Sink;
+use pin_project_lite::pin_project;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+pin_project! {
+ /// A helper that wraps a [`Sink`]`<`[`Bytes`]`>` and converts it into a
+ /// [`Sink`]`<&'a [u8]>` by copying each byte slice into an owned [`Bytes`].
+ ///
+ /// See the documentation for [`SinkWriter`] for an example.
+ ///
+ /// [`Bytes`]: bytes::Bytes
+ /// [`SinkWriter`]: crate::io::SinkWriter
+ /// [`Sink`]: futures_sink::Sink
+ #[derive(Debug)]
+ pub struct CopyToBytes<S> {
+ #[pin]
+ inner: S,
+ }
+}
+
+impl<S> CopyToBytes<S> {
+ /// Creates a new [`CopyToBytes`].
+ pub fn new(inner: S) -> Self {
+ Self { inner }
+ }
+
+ /// Gets a reference to the underlying sink.
+ pub fn get_ref(&self) -> &S {
+ &self.inner
+ }
+
+ /// Gets a mutable reference to the underlying sink.
+ pub fn get_mut(&mut self) -> &mut S {
+ &mut self.inner
+ }
+
+ /// Consumes this [`CopyToBytes`], returning the underlying sink.
+ pub fn into_inner(self) -> S {
+ self.inner
+ }
+}
+
+impl<'a, S> Sink<&'a [u8]> for CopyToBytes<S>
+where
+ S: Sink<Bytes>,
+{
+ type Error = S::Error;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_ready(cx)
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: &'a [u8]) -> Result<(), Self::Error> {
+ self.project()
+ .inner
+ .start_send(Bytes::copy_from_slice(item))
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_flush(cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_close(cx)
+ }
+}
+
+impl<S: Stream> Stream for CopyToBytes<S> {
+ type Item = S::Item;
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
diff --git a/crates/tokio-util/src/io/inspect.rs b/crates/tokio-util/src/io/inspect.rs
new file mode 100644
index 0000000..c860b80
--- /dev/null
+++ b/crates/tokio-util/src/io/inspect.rs
@@ -0,0 +1,180 @@
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::io::{IoSlice, Result};
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
+
+pin_project! {
+ /// An adapter that lets you inspect the data that's being read.
+ ///
+ /// This is useful for things like hashing data as it's read in.
+ pub struct InspectReader<R, F> {
+ #[pin]
+ reader: R,
+ f: F,
+ }
+}
+
+impl<R, F> InspectReader<R, F> {
+ /// Create a new InspectReader, wrapping `reader` and calling `f` for the
+ /// new data supplied by each read call.
+ ///
+ /// The closure will only be called with an empty slice if the inner reader
+ /// returns without reading data into the buffer. This happens at EOF, or if
+ /// `poll_read` is called with a zero-size buffer.
+ pub fn new(reader: R, f: F) -> InspectReader<R, F>
+ where
+ R: AsyncRead,
+ F: FnMut(&[u8]),
+ {
+ InspectReader { reader, f }
+ }
+
+ /// Consumes the `InspectReader`, returning the wrapped reader
+ pub fn into_inner(self) -> R {
+ self.reader
+ }
+}
+
+impl<R: AsyncRead, F: FnMut(&[u8])> AsyncRead for InspectReader<R, F> {
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<Result<()>> {
+ let me = self.project();
+ let filled_length = buf.filled().len();
+ ready!(me.reader.poll_read(cx, buf))?;
+ (me.f)(&buf.filled()[filled_length..]);
+ Poll::Ready(Ok(()))
+ }
+}
+
+impl<R: AsyncWrite, F> AsyncWrite for InspectReader<R, F> {
+ fn poll_write(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<std::result::Result<usize, std::io::Error>> {
+ self.project().reader.poll_write(cx, buf)
+ }
+
+ fn poll_flush(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<std::result::Result<(), std::io::Error>> {
+ self.project().reader.poll_flush(cx)
+ }
+
+ fn poll_shutdown(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<std::result::Result<(), std::io::Error>> {
+ self.project().reader.poll_shutdown(cx)
+ }
+
+ fn poll_write_vectored(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ bufs: &[IoSlice<'_>],
+ ) -> Poll<Result<usize>> {
+ self.project().reader.poll_write_vectored(cx, bufs)
+ }
+
+ fn is_write_vectored(&self) -> bool {
+ self.reader.is_write_vectored()
+ }
+}
+
+pin_project! {
+ /// An adapter that lets you inspect the data that's being written.
+ ///
+ /// This is useful for things like hashing data as it's written out.
+ pub struct InspectWriter<W, F> {
+ #[pin]
+ writer: W,
+ f: F,
+ }
+}
+
+impl<W, F> InspectWriter<W, F> {
+ /// Create a new InspectWriter, wrapping `write` and calling `f` for the
+ /// data successfully written by each write call.
+ ///
+ /// The closure `f` will never be called with an empty slice. A vectored
+ /// write can result in multiple calls to `f` - at most one call to `f` per
+ /// buffer supplied to `poll_write_vectored`.
+ pub fn new(writer: W, f: F) -> InspectWriter<W, F>
+ where
+ W: AsyncWrite,
+ F: FnMut(&[u8]),
+ {
+ InspectWriter { writer, f }
+ }
+
+ /// Consumes the `InspectWriter`, returning the wrapped writer
+ pub fn into_inner(self) -> W {
+ self.writer
+ }
+}
+
+impl<W: AsyncWrite, F: FnMut(&[u8])> AsyncWrite for InspectWriter<W, F> {
+ fn poll_write(self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8]) -> Poll<Result<usize>> {
+ let me = self.project();
+ let res = me.writer.poll_write(cx, buf);
+ if let Poll::Ready(Ok(count)) = res {
+ if count != 0 {
+ (me.f)(&buf[..count]);
+ }
+ }
+ res
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
+ let me = self.project();
+ me.writer.poll_flush(cx)
+ }
+
+ fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>> {
+ let me = self.project();
+ me.writer.poll_shutdown(cx)
+ }
+
+ fn poll_write_vectored(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ bufs: &[IoSlice<'_>],
+ ) -> Poll<Result<usize>> {
+ let me = self.project();
+ let res = me.writer.poll_write_vectored(cx, bufs);
+ if let Poll::Ready(Ok(mut count)) = res {
+ for buf in bufs {
+ if count == 0 {
+ break;
+ }
+ let size = count.min(buf.len());
+ if size != 0 {
+ (me.f)(&buf[..size]);
+ count -= size;
+ }
+ }
+ }
+ res
+ }
+
+ fn is_write_vectored(&self) -> bool {
+ self.writer.is_write_vectored()
+ }
+}
+
+impl<W: AsyncRead, F> AsyncRead for InspectWriter<W, F> {
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<std::io::Result<()>> {
+ self.project().writer.poll_read(cx, buf)
+ }
+}
diff --git a/crates/tokio-util/src/io/mod.rs b/crates/tokio-util/src/io/mod.rs
new file mode 100644
index 0000000..6c40d73
--- /dev/null
+++ b/crates/tokio-util/src/io/mod.rs
@@ -0,0 +1,31 @@
+//! Helpers for IO related tasks.
+//!
+//! The stream types are often used in combination with hyper or reqwest, as they
+//! allow converting between a hyper [`Body`] and [`AsyncRead`].
+//!
+//! The [`SyncIoBridge`] type converts from the world of async I/O
+//! to synchronous I/O; this may often come up when using synchronous APIs
+//! inside [`tokio::task::spawn_blocking`].
+//!
+//! [`Body`]: https://docs.rs/hyper/0.13/hyper/struct.Body.html
+//! [`AsyncRead`]: tokio::io::AsyncRead
+
+mod copy_to_bytes;
+mod inspect;
+mod read_buf;
+mod reader_stream;
+mod sink_writer;
+mod stream_reader;
+
+cfg_io_util! {
+ mod sync_bridge;
+ pub use self::sync_bridge::SyncIoBridge;
+}
+
+pub use self::copy_to_bytes::CopyToBytes;
+pub use self::inspect::{InspectReader, InspectWriter};
+pub use self::read_buf::read_buf;
+pub use self::reader_stream::ReaderStream;
+pub use self::sink_writer::SinkWriter;
+pub use self::stream_reader::StreamReader;
+pub use crate::util::{poll_read_buf, poll_write_buf};
diff --git a/crates/tokio-util/src/io/read_buf.rs b/crates/tokio-util/src/io/read_buf.rs
new file mode 100644
index 0000000..d7938a3
--- /dev/null
+++ b/crates/tokio-util/src/io/read_buf.rs
@@ -0,0 +1,65 @@
+use bytes::BufMut;
+use std::future::Future;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::io::AsyncRead;
+
+/// Read data from an `AsyncRead` into an implementer of the [`BufMut`] trait.
+///
+/// [`BufMut`]: bytes::BufMut
+///
+/// # Example
+///
+/// ```
+/// use bytes::{Bytes, BytesMut};
+/// use tokio_stream as stream;
+/// use tokio::io::Result;
+/// use tokio_util::io::{StreamReader, read_buf};
+/// # #[tokio::main]
+/// # async fn main() -> std::io::Result<()> {
+///
+/// // Create a reader from an iterator. This particular reader will always be
+/// // ready.
+/// let mut read = StreamReader::new(stream::iter(vec![Result::Ok(Bytes::from_static(&[0, 1, 2, 3]))]));
+///
+/// let mut buf = BytesMut::new();
+/// let mut reads = 0;
+///
+/// loop {
+/// reads += 1;
+/// let n = read_buf(&mut read, &mut buf).await?;
+///
+/// if n == 0 {
+/// break;
+/// }
+/// }
+///
+/// // one or more reads might be necessary.
+/// assert!(reads >= 1);
+/// assert_eq!(&buf[..], &[0, 1, 2, 3]);
+/// # Ok(())
+/// # }
+/// ```
+pub async fn read_buf<R, B>(read: &mut R, buf: &mut B) -> io::Result<usize>
+where
+ R: AsyncRead + Unpin,
+ B: BufMut,
+{
+ return ReadBufFn(read, buf).await;
+
+ struct ReadBufFn<'a, R, B>(&'a mut R, &'a mut B);
+
+ impl<'a, R, B> Future for ReadBufFn<'a, R, B>
+ where
+ R: AsyncRead + Unpin,
+ B: BufMut,
+ {
+ type Output = io::Result<usize>;
+
+ fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = &mut *self;
+ crate::util::poll_read_buf(Pin::new(this.0), cx, this.1)
+ }
+ }
+}
diff --git a/crates/tokio-util/src/io/reader_stream.rs b/crates/tokio-util/src/io/reader_stream.rs
new file mode 100644
index 0000000..866c114
--- /dev/null
+++ b/crates/tokio-util/src/io/reader_stream.rs
@@ -0,0 +1,118 @@
+use bytes::{Bytes, BytesMut};
+use futures_core::stream::Stream;
+use pin_project_lite::pin_project;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::io::AsyncRead;
+
+const DEFAULT_CAPACITY: usize = 4096;
+
+pin_project! {
+ /// Convert an [`AsyncRead`] into a [`Stream`] of byte chunks.
+ ///
+ /// This stream is fused. It performs the inverse operation of
+ /// [`StreamReader`].
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # #[tokio::main]
+ /// # async fn main() -> std::io::Result<()> {
+ /// use tokio_stream::StreamExt;
+ /// use tokio_util::io::ReaderStream;
+ ///
+ /// // Create a stream of data.
+ /// let data = b"hello, world!";
+ /// let mut stream = ReaderStream::new(&data[..]);
+ ///
+ /// // Read all of the chunks into a vector.
+ /// let mut stream_contents = Vec::new();
+ /// while let Some(chunk) = stream.next().await {
+ /// stream_contents.extend_from_slice(&chunk?);
+ /// }
+ ///
+ /// // Once the chunks are concatenated, we should have the
+ /// // original data.
+ /// assert_eq!(stream_contents, data);
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`AsyncRead`]: tokio::io::AsyncRead
+ /// [`StreamReader`]: crate::io::StreamReader
+ /// [`Stream`]: futures_core::Stream
+ #[derive(Debug)]
+ pub struct ReaderStream<R> {
+ // Reader itself.
+ //
+ // This value is `None` if the stream has terminated.
+ #[pin]
+ reader: Option<R>,
+ // Working buffer, used to optimize allocations.
+ buf: BytesMut,
+ capacity: usize,
+ }
+}
+
+impl<R: AsyncRead> ReaderStream<R> {
+ /// Convert an [`AsyncRead`] into a [`Stream`] with item type
+ /// `Result<Bytes, std::io::Error>`.
+ ///
+ /// [`AsyncRead`]: tokio::io::AsyncRead
+ /// [`Stream`]: futures_core::Stream
+ pub fn new(reader: R) -> Self {
+ ReaderStream {
+ reader: Some(reader),
+ buf: BytesMut::new(),
+ capacity: DEFAULT_CAPACITY,
+ }
+ }
+
+ /// Convert an [`AsyncRead`] into a [`Stream`] with item type
+ /// `Result<Bytes, std::io::Error>`,
+ /// with a specific read buffer initial capacity.
+ ///
+ /// [`AsyncRead`]: tokio::io::AsyncRead
+ /// [`Stream`]: futures_core::Stream
+ pub fn with_capacity(reader: R, capacity: usize) -> Self {
+ ReaderStream {
+ reader: Some(reader),
+ buf: BytesMut::with_capacity(capacity),
+ capacity,
+ }
+ }
+}
+
+impl<R: AsyncRead> Stream for ReaderStream<R> {
+ type Item = std::io::Result<Bytes>;
+ fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ use crate::util::poll_read_buf;
+
+ let mut this = self.as_mut().project();
+
+ let reader = match this.reader.as_pin_mut() {
+ Some(r) => r,
+ None => return Poll::Ready(None),
+ };
+
+ if this.buf.capacity() == 0 {
+ this.buf.reserve(*this.capacity);
+ }
+
+ match poll_read_buf(reader, cx, &mut this.buf) {
+ Poll::Pending => Poll::Pending,
+ Poll::Ready(Err(err)) => {
+ self.project().reader.set(None);
+ Poll::Ready(Some(Err(err)))
+ }
+ Poll::Ready(Ok(0)) => {
+ self.project().reader.set(None);
+ Poll::Ready(None)
+ }
+ Poll::Ready(Ok(_)) => {
+ let chunk = this.buf.split();
+ Poll::Ready(Some(Ok(chunk.freeze())))
+ }
+ }
+ }
+}
diff --git a/crates/tokio-util/src/io/sink_writer.rs b/crates/tokio-util/src/io/sink_writer.rs
new file mode 100644
index 0000000..e078952
--- /dev/null
+++ b/crates/tokio-util/src/io/sink_writer.rs
@@ -0,0 +1,135 @@
+use futures_core::ready;
+use futures_sink::Sink;
+
+use futures_core::stream::Stream;
+use pin_project_lite::pin_project;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::io::{AsyncRead, AsyncWrite};
+
+pin_project! {
+ /// Convert a [`Sink`] of byte chunks into an [`AsyncWrite`].
+ ///
+ /// Whenever you write to this [`SinkWriter`], the supplied bytes are
+ /// forwarded to the inner [`Sink`]. When `shutdown` is called on this
+ /// [`SinkWriter`], the inner sink is closed.
+ ///
+ /// This adapter takes a `Sink<&[u8]>` and provides an [`AsyncWrite`] impl
+ /// for it. Because of the lifetime, this trait is relatively rarely
+ /// implemented. The main ways to get a `Sink<&[u8]>` that you can use with
+ /// this type are:
+ ///
+ /// * With the codec module by implementing the [`Encoder`]`<&[u8]>` trait.
+ /// * By wrapping a `Sink<Bytes>` in a [`CopyToBytes`].
+ /// * Manually implementing `Sink<&[u8]>` directly.
+ ///
+ /// The opposite conversion of implementing `Sink<_>` for an [`AsyncWrite`]
+ /// is done using the [`codec`] module.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use bytes::Bytes;
+ /// use futures_util::SinkExt;
+ /// use std::io::{Error, ErrorKind};
+ /// use tokio::io::AsyncWriteExt;
+ /// use tokio_util::io::{SinkWriter, CopyToBytes};
+ /// use tokio_util::sync::PollSender;
+ ///
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// # async fn main() -> Result<(), Error> {
+ /// // We use an mpsc channel as an example of a `Sink<Bytes>`.
+ /// let (tx, mut rx) = tokio::sync::mpsc::channel::<Bytes>(1);
+ /// let sink = PollSender::new(tx).sink_map_err(|_| Error::from(ErrorKind::BrokenPipe));
+ ///
+ /// // Wrap it in `CopyToBytes` to get a `Sink<&[u8]>`.
+ /// let mut writer = SinkWriter::new(CopyToBytes::new(sink));
+ ///
+ /// // Write data to our interface...
+ /// let data: [u8; 4] = [1, 2, 3, 4];
+ /// let _ = writer.write(&data).await?;
+ ///
+ /// // ... and receive it.
+ /// assert_eq!(data.as_slice(), &*rx.recv().await.unwrap());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`AsyncWrite`]: tokio::io::AsyncWrite
+ /// [`CopyToBytes`]: crate::io::CopyToBytes
+ /// [`Encoder`]: crate::codec::Encoder
+ /// [`Sink`]: futures_sink::Sink
+ /// [`codec`]: crate::codec
+ #[derive(Debug)]
+ pub struct SinkWriter<S> {
+ #[pin]
+ inner: S,
+ }
+}
+
+impl<S> SinkWriter<S> {
+ /// Creates a new [`SinkWriter`].
+ pub fn new(sink: S) -> Self {
+ Self { inner: sink }
+ }
+
+ /// Gets a reference to the underlying sink.
+ pub fn get_ref(&self) -> &S {
+ &self.inner
+ }
+
+ /// Gets a mutable reference to the underlying sink.
+ pub fn get_mut(&mut self) -> &mut S {
+ &mut self.inner
+ }
+
+ /// Consumes this [`SinkWriter`], returning the underlying sink.
+ pub fn into_inner(self) -> S {
+ self.inner
+ }
+}
+impl<S, E> AsyncWrite for SinkWriter<S>
+where
+ for<'a> S: Sink<&'a [u8], Error = E>,
+ E: Into<io::Error>,
+{
+ fn poll_write(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<Result<usize, io::Error>> {
+ let mut this = self.project();
+
+ ready!(this.inner.as_mut().poll_ready(cx).map_err(Into::into))?;
+ match this.inner.as_mut().start_send(buf) {
+ Ok(()) => Poll::Ready(Ok(buf.len())),
+ Err(e) => Poll::Ready(Err(e.into())),
+ }
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ self.project().inner.poll_flush(cx).map_err(Into::into)
+ }
+
+ fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ self.project().inner.poll_close(cx).map_err(Into::into)
+ }
+}
+
+impl<S: Stream> Stream for SinkWriter<S> {
+ type Item = S::Item;
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
+
+impl<S: AsyncRead> AsyncRead for SinkWriter<S> {
+ fn poll_read(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut tokio::io::ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ self.project().inner.poll_read(cx, buf)
+ }
+}
diff --git a/crates/tokio-util/src/io/stream_reader.rs b/crates/tokio-util/src/io/stream_reader.rs
new file mode 100644
index 0000000..6ecf8ec
--- /dev/null
+++ b/crates/tokio-util/src/io/stream_reader.rs
@@ -0,0 +1,346 @@
+use bytes::Buf;
+use futures_core::stream::Stream;
+use futures_sink::Sink;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::io::{AsyncBufRead, AsyncRead, ReadBuf};
+
+/// Convert a [`Stream`] of byte chunks into an [`AsyncRead`].
+///
+/// This type performs the inverse operation of [`ReaderStream`].
+///
+/// This type also implements the [`AsyncBufRead`] trait, so you can use it
+/// to read a `Stream` of byte chunks line-by-line. See the examples below.
+///
+/// # Example
+///
+/// ```
+/// use bytes::Bytes;
+/// use tokio::io::{AsyncReadExt, Result};
+/// use tokio_util::io::StreamReader;
+/// # #[tokio::main(flavor = "current_thread")]
+/// # async fn main() -> std::io::Result<()> {
+///
+/// // Create a stream from an iterator.
+/// let stream = tokio_stream::iter(vec![
+/// Result::Ok(Bytes::from_static(&[0, 1, 2, 3])),
+/// Result::Ok(Bytes::from_static(&[4, 5, 6, 7])),
+/// Result::Ok(Bytes::from_static(&[8, 9, 10, 11])),
+/// ]);
+///
+/// // Convert it to an AsyncRead.
+/// let mut read = StreamReader::new(stream);
+///
+/// // Read five bytes from the stream.
+/// let mut buf = [0; 5];
+/// read.read_exact(&mut buf).await?;
+/// assert_eq!(buf, [0, 1, 2, 3, 4]);
+///
+/// // Read the rest of the current chunk.
+/// assert_eq!(read.read(&mut buf).await?, 3);
+/// assert_eq!(&buf[..3], [5, 6, 7]);
+///
+/// // Read the next chunk.
+/// assert_eq!(read.read(&mut buf).await?, 4);
+/// assert_eq!(&buf[..4], [8, 9, 10, 11]);
+///
+/// // We have now reached the end.
+/// assert_eq!(read.read(&mut buf).await?, 0);
+///
+/// # Ok(())
+/// # }
+/// ```
+///
+/// If the stream produces errors which are not [`std::io::Error`],
+/// the errors can be converted using [`StreamExt`] to map each
+/// element.
+///
+/// ```
+/// use bytes::Bytes;
+/// use tokio::io::AsyncReadExt;
+/// use tokio_util::io::StreamReader;
+/// use tokio_stream::StreamExt;
+/// # #[tokio::main(flavor = "current_thread")]
+/// # async fn main() -> std::io::Result<()> {
+///
+/// // Create a stream from an iterator, including an error.
+/// let stream = tokio_stream::iter(vec![
+/// Result::Ok(Bytes::from_static(&[0, 1, 2, 3])),
+/// Result::Ok(Bytes::from_static(&[4, 5, 6, 7])),
+/// Result::Err("Something bad happened!")
+/// ]);
+///
+/// // Use StreamExt to map the stream and error to a std::io::Error
+/// let stream = stream.map(|result| result.map_err(|err| {
+/// std::io::Error::new(std::io::ErrorKind::Other, err)
+/// }));
+///
+/// // Convert it to an AsyncRead.
+/// let mut read = StreamReader::new(stream);
+///
+/// // Read five bytes from the stream.
+/// let mut buf = [0; 5];
+/// read.read_exact(&mut buf).await?;
+/// assert_eq!(buf, [0, 1, 2, 3, 4]);
+///
+/// // Read the rest of the current chunk.
+/// assert_eq!(read.read(&mut buf).await?, 3);
+/// assert_eq!(&buf[..3], [5, 6, 7]);
+///
+/// // Reading the next chunk will produce an error
+/// let error = read.read(&mut buf).await.unwrap_err();
+/// assert_eq!(error.kind(), std::io::ErrorKind::Other);
+/// assert_eq!(error.into_inner().unwrap().to_string(), "Something bad happened!");
+///
+/// // We have now reached the end.
+/// assert_eq!(read.read(&mut buf).await?, 0);
+///
+/// # Ok(())
+/// # }
+/// ```
+///
+/// Using the [`AsyncBufRead`] impl, you can read a `Stream` of byte chunks
+/// line-by-line. Note that you will usually also need to convert the error
+/// type when doing this. See the second example for an explanation of how
+/// to do this.
+///
+/// ```
+/// use tokio::io::{Result, AsyncBufReadExt};
+/// use tokio_util::io::StreamReader;
+/// # #[tokio::main(flavor = "current_thread")]
+/// # async fn main() -> std::io::Result<()> {
+///
+/// // Create a stream of byte chunks.
+/// let stream = tokio_stream::iter(vec![
+/// Result::Ok(b"The first line.\n".as_slice()),
+/// Result::Ok(b"The second line.".as_slice()),
+/// Result::Ok(b"\nThe third".as_slice()),
+/// Result::Ok(b" line.\nThe fourth line.\nThe fifth line.\n".as_slice()),
+/// ]);
+///
+/// // Convert it to an AsyncRead.
+/// let mut read = StreamReader::new(stream);
+///
+/// // Loop through the lines from the `StreamReader`.
+/// let mut line = String::new();
+/// let mut lines = Vec::new();
+/// loop {
+/// line.clear();
+/// let len = read.read_line(&mut line).await?;
+/// if len == 0 { break; }
+/// lines.push(line.clone());
+/// }
+///
+/// // Verify that we got the lines we expected.
+/// assert_eq!(
+/// lines,
+/// vec![
+/// "The first line.\n",
+/// "The second line.\n",
+/// "The third line.\n",
+/// "The fourth line.\n",
+/// "The fifth line.\n",
+/// ]
+/// );
+/// # Ok(())
+/// # }
+/// ```
+///
+/// [`AsyncRead`]: tokio::io::AsyncRead
+/// [`AsyncBufRead`]: tokio::io::AsyncBufRead
+/// [`Stream`]: futures_core::Stream
+/// [`ReaderStream`]: crate::io::ReaderStream
+/// [`StreamExt`]: https://docs.rs/tokio-stream/latest/tokio_stream/trait.StreamExt.html
+#[derive(Debug)]
+pub struct StreamReader<S, B> {
+ // This field is pinned.
+ inner: S,
+ // This field is not pinned.
+ chunk: Option<B>,
+}
+
+impl<S, B, E> StreamReader<S, B>
+where
+ S: Stream<Item = Result<B, E>>,
+ B: Buf,
+ E: Into<std::io::Error>,
+{
+ /// Convert a stream of byte chunks into an [`AsyncRead`].
+ ///
+ /// The item should be a [`Result`] with the ok variant being something that
+ /// implements the [`Buf`] trait (e.g. `Vec<u8>` or `Bytes`). The error
+ /// should be convertible into an [io error].
+ ///
+ /// [`Result`]: std::result::Result
+ /// [`Buf`]: bytes::Buf
+ /// [io error]: std::io::Error
+ pub fn new(stream: S) -> Self {
+ Self {
+ inner: stream,
+ chunk: None,
+ }
+ }
+
+ /// Do we have a chunk and is it non-empty?
+ fn has_chunk(&self) -> bool {
+ if let Some(ref chunk) = self.chunk {
+ chunk.remaining() > 0
+ } else {
+ false
+ }
+ }
+
+ /// Consumes this `StreamReader`, returning a Tuple consisting
+ /// of the underlying stream and an Option of the internal buffer,
+ /// which is Some in case the buffer contains elements.
+ pub fn into_inner_with_chunk(self) -> (S, Option<B>) {
+ if self.has_chunk() {
+ (self.inner, self.chunk)
+ } else {
+ (self.inner, None)
+ }
+ }
+}
+
+impl<S, B> StreamReader<S, B> {
+ /// Gets a reference to the underlying stream.
+ ///
+ /// It is inadvisable to directly read from the underlying stream.
+ pub fn get_ref(&self) -> &S {
+ &self.inner
+ }
+
+ /// Gets a mutable reference to the underlying stream.
+ ///
+ /// It is inadvisable to directly read from the underlying stream.
+ pub fn get_mut(&mut self) -> &mut S {
+ &mut self.inner
+ }
+
+ /// Gets a pinned mutable reference to the underlying stream.
+ ///
+ /// It is inadvisable to directly read from the underlying stream.
+ pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut S> {
+ self.project().inner
+ }
+
+ /// Consumes this `BufWriter`, returning the underlying stream.
+ ///
+ /// Note that any leftover data in the internal buffer is lost.
+ /// If you additionally want access to the internal buffer use
+ /// [`into_inner_with_chunk`].
+ ///
+ /// [`into_inner_with_chunk`]: crate::io::StreamReader::into_inner_with_chunk
+ pub fn into_inner(self) -> S {
+ self.inner
+ }
+}
+
+impl<S, B, E> AsyncRead for StreamReader<S, B>
+where
+ S: Stream<Item = Result<B, E>>,
+ B: Buf,
+ E: Into<std::io::Error>,
+{
+ fn poll_read(
+ mut self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ if buf.remaining() == 0 {
+ return Poll::Ready(Ok(()));
+ }
+
+ let inner_buf = match self.as_mut().poll_fill_buf(cx) {
+ Poll::Ready(Ok(buf)) => buf,
+ Poll::Ready(Err(err)) => return Poll::Ready(Err(err)),
+ Poll::Pending => return Poll::Pending,
+ };
+ let len = std::cmp::min(inner_buf.len(), buf.remaining());
+ buf.put_slice(&inner_buf[..len]);
+
+ self.consume(len);
+ Poll::Ready(Ok(()))
+ }
+}
+
+impl<S, B, E> AsyncBufRead for StreamReader<S, B>
+where
+ S: Stream<Item = Result<B, E>>,
+ B: Buf,
+ E: Into<std::io::Error>,
+{
+ fn poll_fill_buf(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<io::Result<&[u8]>> {
+ loop {
+ if self.as_mut().has_chunk() {
+ // This unwrap is very sad, but it can't be avoided.
+ let buf = self.project().chunk.as_ref().unwrap().chunk();
+ return Poll::Ready(Ok(buf));
+ } else {
+ match self.as_mut().project().inner.poll_next(cx) {
+ Poll::Ready(Some(Ok(chunk))) => {
+ // Go around the loop in case the chunk is empty.
+ *self.as_mut().project().chunk = Some(chunk);
+ }
+ Poll::Ready(Some(Err(err))) => return Poll::Ready(Err(err.into())),
+ Poll::Ready(None) => return Poll::Ready(Ok(&[])),
+ Poll::Pending => return Poll::Pending,
+ }
+ }
+ }
+ }
+ fn consume(self: Pin<&mut Self>, amt: usize) {
+ if amt > 0 {
+ self.project()
+ .chunk
+ .as_mut()
+ .expect("No chunk present")
+ .advance(amt);
+ }
+ }
+}
+
+// The code below is a manual expansion of the code that pin-project-lite would
+// generate. This is done because pin-project-lite fails by hitting the recusion
+// limit on this struct. (Every line of documentation is handled recursively by
+// the macro.)
+
+impl<S: Unpin, B> Unpin for StreamReader<S, B> {}
+
+struct StreamReaderProject<'a, S, B> {
+ inner: Pin<&'a mut S>,
+ chunk: &'a mut Option<B>,
+}
+
+impl<S, B> StreamReader<S, B> {
+ #[inline]
+ fn project(self: Pin<&mut Self>) -> StreamReaderProject<'_, S, B> {
+ // SAFETY: We define that only `inner` should be pinned when `Self` is
+ // and have an appropriate `impl Unpin` for this.
+ let me = unsafe { Pin::into_inner_unchecked(self) };
+ StreamReaderProject {
+ inner: unsafe { Pin::new_unchecked(&mut me.inner) },
+ chunk: &mut me.chunk,
+ }
+ }
+}
+
+impl<S: Sink<T, Error = E>, E, T> Sink<T> for StreamReader<S, E> {
+ type Error = E;
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_ready(cx)
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error> {
+ self.project().inner.start_send(item)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_flush(cx)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.project().inner.poll_close(cx)
+ }
+}
diff --git a/crates/tokio-util/src/io/sync_bridge.rs b/crates/tokio-util/src/io/sync_bridge.rs
new file mode 100644
index 0000000..2402207
--- /dev/null
+++ b/crates/tokio-util/src/io/sync_bridge.rs
@@ -0,0 +1,156 @@
+use std::io::{BufRead, Read, Seek, Write};
+use tokio::io::{
+ AsyncBufRead, AsyncBufReadExt, AsyncRead, AsyncReadExt, AsyncSeek, AsyncSeekExt, AsyncWrite,
+ AsyncWriteExt,
+};
+
+/// Use a [`tokio::io::AsyncRead`] synchronously as a [`std::io::Read`] or
+/// a [`tokio::io::AsyncWrite`] as a [`std::io::Write`].
+#[derive(Debug)]
+pub struct SyncIoBridge<T> {
+ src: T,
+ rt: tokio::runtime::Handle,
+}
+
+impl<T: AsyncBufRead + Unpin> BufRead for SyncIoBridge<T> {
+ fn fill_buf(&mut self) -> std::io::Result<&[u8]> {
+ let src = &mut self.src;
+ self.rt.block_on(AsyncBufReadExt::fill_buf(src))
+ }
+
+ fn consume(&mut self, amt: usize) {
+ let src = &mut self.src;
+ AsyncBufReadExt::consume(src, amt)
+ }
+
+ fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt
+ .block_on(AsyncBufReadExt::read_until(src, byte, buf))
+ }
+ fn read_line(&mut self, buf: &mut String) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(AsyncBufReadExt::read_line(src, buf))
+ }
+}
+
+impl<T: AsyncRead + Unpin> Read for SyncIoBridge<T> {
+ fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(AsyncReadExt::read(src, buf))
+ }
+
+ fn read_to_end(&mut self, buf: &mut Vec<u8>) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(src.read_to_end(buf))
+ }
+
+ fn read_to_string(&mut self, buf: &mut String) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(src.read_to_string(buf))
+ }
+
+ fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()> {
+ let src = &mut self.src;
+ // The AsyncRead trait returns the count, synchronous doesn't.
+ let _n = self.rt.block_on(src.read_exact(buf))?;
+ Ok(())
+ }
+}
+
+impl<T: AsyncWrite + Unpin> Write for SyncIoBridge<T> {
+ fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(src.write(buf))
+ }
+
+ fn flush(&mut self) -> std::io::Result<()> {
+ let src = &mut self.src;
+ self.rt.block_on(src.flush())
+ }
+
+ fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
+ let src = &mut self.src;
+ self.rt.block_on(src.write_all(buf))
+ }
+
+ fn write_vectored(&mut self, bufs: &[std::io::IoSlice<'_>]) -> std::io::Result<usize> {
+ let src = &mut self.src;
+ self.rt.block_on(src.write_vectored(bufs))
+ }
+}
+
+impl<T: AsyncSeek + Unpin> Seek for SyncIoBridge<T> {
+ fn seek(&mut self, pos: std::io::SeekFrom) -> std::io::Result<u64> {
+ let src = &mut self.src;
+ self.rt.block_on(AsyncSeekExt::seek(src, pos))
+ }
+}
+
+// Because https://doc.rust-lang.org/std/io/trait.Write.html#method.is_write_vectored is at the time
+// of this writing still unstable, we expose this as part of a standalone method.
+impl<T: AsyncWrite> SyncIoBridge<T> {
+ /// Determines if the underlying [`tokio::io::AsyncWrite`] target supports efficient vectored writes.
+ ///
+ /// See [`tokio::io::AsyncWrite::is_write_vectored`].
+ pub fn is_write_vectored(&self) -> bool {
+ self.src.is_write_vectored()
+ }
+}
+
+impl<T: AsyncWrite + Unpin> SyncIoBridge<T> {
+ /// Shutdown this writer. This method provides a way to call the [`AsyncWriteExt::shutdown`]
+ /// function of the inner [`tokio::io::AsyncWrite`] instance.
+ ///
+ /// # Errors
+ ///
+ /// This method returns the same errors as [`AsyncWriteExt::shutdown`].
+ ///
+ /// [`AsyncWriteExt::shutdown`]: tokio::io::AsyncWriteExt::shutdown
+ pub fn shutdown(&mut self) -> std::io::Result<()> {
+ let src = &mut self.src;
+ self.rt.block_on(src.shutdown())
+ }
+}
+
+impl<T: Unpin> SyncIoBridge<T> {
+ /// Use a [`tokio::io::AsyncRead`] synchronously as a [`std::io::Read`] or
+ /// a [`tokio::io::AsyncWrite`] as a [`std::io::Write`].
+ ///
+ /// When this struct is created, it captures a handle to the current thread's runtime with [`tokio::runtime::Handle::current`].
+ /// It is hence OK to move this struct into a separate thread outside the runtime, as created
+ /// by e.g. [`tokio::task::spawn_blocking`].
+ ///
+ /// Stated even more strongly: to make use of this bridge, you *must* move
+ /// it into a separate thread outside the runtime. The synchronous I/O will use the
+ /// underlying handle to block on the backing asynchronous source, via
+ /// [`tokio::runtime::Handle::block_on`]. As noted in the documentation for that
+ /// function, an attempt to `block_on` from an asynchronous execution context
+ /// will panic.
+ ///
+ /// # Wrapping `!Unpin` types
+ ///
+ /// Use e.g. `SyncIoBridge::new(Box::pin(src))`.
+ ///
+ /// # Panics
+ ///
+ /// This will panic if called outside the context of a Tokio runtime.
+ #[track_caller]
+ pub fn new(src: T) -> Self {
+ Self::new_with_handle(src, tokio::runtime::Handle::current())
+ }
+
+ /// Use a [`tokio::io::AsyncRead`] synchronously as a [`std::io::Read`] or
+ /// a [`tokio::io::AsyncWrite`] as a [`std::io::Write`].
+ ///
+ /// This is the same as [`SyncIoBridge::new`], but allows passing an arbitrary handle and hence may
+ /// be initially invoked outside of an asynchronous context.
+ pub fn new_with_handle(src: T, rt: tokio::runtime::Handle) -> Self {
+ Self { src, rt }
+ }
+
+ /// Consume this bridge, returning the underlying stream.
+ pub fn into_inner(self) -> T {
+ self.src
+ }
+}
diff --git a/crates/tokio-util/src/lib.rs b/crates/tokio-util/src/lib.rs
new file mode 100644
index 0000000..22ad92b
--- /dev/null
+++ b/crates/tokio-util/src/lib.rs
@@ -0,0 +1,60 @@
+#![allow(clippy::needless_doctest_main)]
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub
+)]
+#![doc(test(
+ no_crate_inject,
+ attr(deny(warnings, rust_2018_idioms), allow(dead_code, unused_variables))
+))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+
+//! Utilities for working with Tokio.
+//!
+//! This crate is not versioned in lockstep with the core
+//! [`tokio`] crate. However, `tokio-util` _will_ respect Rust's
+//! semantic versioning policy, especially with regard to breaking changes.
+//!
+//! [`tokio`]: https://docs.rs/tokio
+
+#[macro_use]
+mod cfg;
+
+mod loom;
+
+cfg_codec! {
+ pub mod codec;
+}
+
+cfg_net! {
+ #[cfg(not(target_arch = "wasm32"))]
+ pub mod udp;
+ pub mod net;
+}
+
+cfg_compat! {
+ pub mod compat;
+}
+
+cfg_io! {
+ pub mod io;
+}
+
+cfg_rt! {
+ pub mod context;
+ pub mod task;
+}
+
+cfg_time! {
+ pub mod time;
+}
+
+pub mod sync;
+
+pub mod either;
+
+pub use bytes;
+
+mod util;
diff --git a/crates/tokio-util/src/loom.rs b/crates/tokio-util/src/loom.rs
new file mode 100644
index 0000000..dd03fea
--- /dev/null
+++ b/crates/tokio-util/src/loom.rs
@@ -0,0 +1 @@
+pub(crate) use std::sync;
diff --git a/crates/tokio-util/src/net/mod.rs b/crates/tokio-util/src/net/mod.rs
new file mode 100644
index 0000000..4817e10
--- /dev/null
+++ b/crates/tokio-util/src/net/mod.rs
@@ -0,0 +1,97 @@
+//! TCP/UDP/Unix helpers for tokio.
+
+use crate::either::Either;
+use std::future::Future;
+use std::io::Result;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+#[cfg(unix)]
+pub mod unix;
+
+/// A trait for a listener: `TcpListener` and `UnixListener`.
+pub trait Listener {
+ /// The stream's type of this listener.
+ type Io: tokio::io::AsyncRead + tokio::io::AsyncWrite;
+ /// The socket address type of this listener.
+ type Addr;
+
+ /// Polls to accept a new incoming connection to this listener.
+ fn poll_accept(&mut self, cx: &mut Context<'_>) -> Poll<Result<(Self::Io, Self::Addr)>>;
+
+ /// Accepts a new incoming connection from this listener.
+ fn accept(&mut self) -> ListenerAcceptFut<'_, Self>
+ where
+ Self: Sized,
+ {
+ ListenerAcceptFut { listener: self }
+ }
+
+ /// Returns the local address that this listener is bound to.
+ fn local_addr(&self) -> Result<Self::Addr>;
+}
+
+impl Listener for tokio::net::TcpListener {
+ type Io = tokio::net::TcpStream;
+ type Addr = std::net::SocketAddr;
+
+ fn poll_accept(&mut self, cx: &mut Context<'_>) -> Poll<Result<(Self::Io, Self::Addr)>> {
+ Self::poll_accept(self, cx)
+ }
+
+ fn local_addr(&self) -> Result<Self::Addr> {
+ self.local_addr().map(Into::into)
+ }
+}
+
+/// Future for accepting a new connection from a listener.
+#[derive(Debug)]
+#[must_use = "futures do nothing unless you `.await` or poll them"]
+pub struct ListenerAcceptFut<'a, L> {
+ listener: &'a mut L,
+}
+
+impl<'a, L> Future for ListenerAcceptFut<'a, L>
+where
+ L: Listener,
+{
+ type Output = Result<(L::Io, L::Addr)>;
+
+ fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ self.listener.poll_accept(cx)
+ }
+}
+
+impl<L, R> Either<L, R>
+where
+ L: Listener,
+ R: Listener,
+{
+ /// Accepts a new incoming connection from this listener.
+ pub async fn accept(&mut self) -> Result<Either<(L::Io, L::Addr), (R::Io, R::Addr)>> {
+ match self {
+ Either::Left(listener) => {
+ let (stream, addr) = listener.accept().await?;
+ Ok(Either::Left((stream, addr)))
+ }
+ Either::Right(listener) => {
+ let (stream, addr) = listener.accept().await?;
+ Ok(Either::Right((stream, addr)))
+ }
+ }
+ }
+
+ /// Returns the local address that this listener is bound to.
+ pub fn local_addr(&self) -> Result<Either<L::Addr, R::Addr>> {
+ match self {
+ Either::Left(listener) => {
+ let addr = listener.local_addr()?;
+ Ok(Either::Left(addr))
+ }
+ Either::Right(listener) => {
+ let addr = listener.local_addr()?;
+ Ok(Either::Right(addr))
+ }
+ }
+ }
+}
diff --git a/crates/tokio-util/src/net/unix/mod.rs b/crates/tokio-util/src/net/unix/mod.rs
new file mode 100644
index 0000000..0b522c9
--- /dev/null
+++ b/crates/tokio-util/src/net/unix/mod.rs
@@ -0,0 +1,18 @@
+//! Unix domain socket helpers.
+
+use super::Listener;
+use std::io::Result;
+use std::task::{Context, Poll};
+
+impl Listener for tokio::net::UnixListener {
+ type Io = tokio::net::UnixStream;
+ type Addr = tokio::net::unix::SocketAddr;
+
+ fn poll_accept(&mut self, cx: &mut Context<'_>) -> Poll<Result<(Self::Io, Self::Addr)>> {
+ Self::poll_accept(self, cx)
+ }
+
+ fn local_addr(&self) -> Result<Self::Addr> {
+ self.local_addr().map(Into::into)
+ }
+}
diff --git a/crates/tokio-util/src/sync/cancellation_token.rs b/crates/tokio-util/src/sync/cancellation_token.rs
new file mode 100644
index 0000000..5ef8ba2
--- /dev/null
+++ b/crates/tokio-util/src/sync/cancellation_token.rs
@@ -0,0 +1,341 @@
+//! An asynchronously awaitable `CancellationToken`.
+//! The token allows to signal a cancellation request to one or more tasks.
+pub(crate) mod guard;
+mod tree_node;
+
+use crate::loom::sync::Arc;
+use crate::util::MaybeDangling;
+use core::future::Future;
+use core::pin::Pin;
+use core::task::{Context, Poll};
+
+use guard::DropGuard;
+use pin_project_lite::pin_project;
+
+/// A token which can be used to signal a cancellation request to one or more
+/// tasks.
+///
+/// Tasks can call [`CancellationToken::cancelled()`] in order to
+/// obtain a Future which will be resolved when cancellation is requested.
+///
+/// Cancellation can be requested through the [`CancellationToken::cancel`] method.
+///
+/// # Examples
+///
+/// ```no_run
+/// use tokio::select;
+/// use tokio_util::sync::CancellationToken;
+///
+/// #[tokio::main]
+/// async fn main() {
+/// let token = CancellationToken::new();
+/// let cloned_token = token.clone();
+///
+/// let join_handle = tokio::spawn(async move {
+/// // Wait for either cancellation or a very long time
+/// select! {
+/// _ = cloned_token.cancelled() => {
+/// // The token was cancelled
+/// 5
+/// }
+/// _ = tokio::time::sleep(std::time::Duration::from_secs(9999)) => {
+/// 99
+/// }
+/// }
+/// });
+///
+/// tokio::spawn(async move {
+/// tokio::time::sleep(std::time::Duration::from_millis(10)).await;
+/// token.cancel();
+/// });
+///
+/// assert_eq!(5, join_handle.await.unwrap());
+/// }
+/// ```
+pub struct CancellationToken {
+ inner: Arc<tree_node::TreeNode>,
+}
+
+impl std::panic::UnwindSafe for CancellationToken {}
+impl std::panic::RefUnwindSafe for CancellationToken {}
+
+pin_project! {
+ /// A Future that is resolved once the corresponding [`CancellationToken`]
+ /// is cancelled.
+ #[must_use = "futures do nothing unless polled"]
+ pub struct WaitForCancellationFuture<'a> {
+ cancellation_token: &'a CancellationToken,
+ #[pin]
+ future: tokio::sync::futures::Notified<'a>,
+ }
+}
+
+pin_project! {
+ /// A Future that is resolved once the corresponding [`CancellationToken`]
+ /// is cancelled.
+ ///
+ /// This is the counterpart to [`WaitForCancellationFuture`] that takes
+ /// [`CancellationToken`] by value instead of using a reference.
+ #[must_use = "futures do nothing unless polled"]
+ pub struct WaitForCancellationFutureOwned {
+ // This field internally has a reference to the cancellation token, but camouflages
+ // the relationship with `'static`. To avoid Undefined Behavior, we must ensure
+ // that the reference is only used while the cancellation token is still alive. To
+ // do that, we ensure that the future is the first field, so that it is dropped
+ // before the cancellation token.
+ //
+ // We use `MaybeDanglingFuture` here because without it, the compiler could assert
+ // the reference inside `future` to be valid even after the destructor of that
+ // field runs. (Specifically, when the `WaitForCancellationFutureOwned` is passed
+ // as an argument to a function, the reference can be asserted to be valid for the
+ // rest of that function.) To avoid that, we use `MaybeDangling` which tells the
+ // compiler that the reference stored inside it might not be valid.
+ //
+ // See <https://users.rust-lang.org/t/unsafe-code-review-semi-owning-weak-rwlock-t-guard/95706>
+ // for more info.
+ #[pin]
+ future: MaybeDangling<tokio::sync::futures::Notified<'static>>,
+ cancellation_token: CancellationToken,
+ }
+}
+
+// ===== impl CancellationToken =====
+
+impl core::fmt::Debug for CancellationToken {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ f.debug_struct("CancellationToken")
+ .field("is_cancelled", &self.is_cancelled())
+ .finish()
+ }
+}
+
+impl Clone for CancellationToken {
+ /// Creates a clone of the `CancellationToken` which will get cancelled
+ /// whenever the current token gets cancelled, and vice versa.
+ fn clone(&self) -> Self {
+ tree_node::increase_handle_refcount(&self.inner);
+ CancellationToken {
+ inner: self.inner.clone(),
+ }
+ }
+}
+
+impl Drop for CancellationToken {
+ fn drop(&mut self) {
+ tree_node::decrease_handle_refcount(&self.inner);
+ }
+}
+
+impl Default for CancellationToken {
+ fn default() -> CancellationToken {
+ CancellationToken::new()
+ }
+}
+
+impl CancellationToken {
+ /// Creates a new `CancellationToken` in the non-cancelled state.
+ pub fn new() -> CancellationToken {
+ CancellationToken {
+ inner: Arc::new(tree_node::TreeNode::new()),
+ }
+ }
+
+ /// Creates a `CancellationToken` which will get cancelled whenever the
+ /// current token gets cancelled. Unlike a cloned `CancellationToken`,
+ /// cancelling a child token does not cancel the parent token.
+ ///
+ /// If the current token is already cancelled, the child token will get
+ /// returned in cancelled state.
+ ///
+ /// # Examples
+ ///
+ /// ```no_run
+ /// use tokio::select;
+ /// use tokio_util::sync::CancellationToken;
+ ///
+ /// #[tokio::main]
+ /// async fn main() {
+ /// let token = CancellationToken::new();
+ /// let child_token = token.child_token();
+ ///
+ /// let join_handle = tokio::spawn(async move {
+ /// // Wait for either cancellation or a very long time
+ /// select! {
+ /// _ = child_token.cancelled() => {
+ /// // The token was cancelled
+ /// 5
+ /// }
+ /// _ = tokio::time::sleep(std::time::Duration::from_secs(9999)) => {
+ /// 99
+ /// }
+ /// }
+ /// });
+ ///
+ /// tokio::spawn(async move {
+ /// tokio::time::sleep(std::time::Duration::from_millis(10)).await;
+ /// token.cancel();
+ /// });
+ ///
+ /// assert_eq!(5, join_handle.await.unwrap());
+ /// }
+ /// ```
+ pub fn child_token(&self) -> CancellationToken {
+ CancellationToken {
+ inner: tree_node::child_node(&self.inner),
+ }
+ }
+
+ /// Cancel the [`CancellationToken`] and all child tokens which had been
+ /// derived from it.
+ ///
+ /// This will wake up all tasks which are waiting for cancellation.
+ ///
+ /// Be aware that cancellation is not an atomic operation. It is possible
+ /// for another thread running in parallel with a call to `cancel` to first
+ /// receive `true` from `is_cancelled` on one child node, and then receive
+ /// `false` from `is_cancelled` on another child node. However, once the
+ /// call to `cancel` returns, all child nodes have been fully cancelled.
+ pub fn cancel(&self) {
+ tree_node::cancel(&self.inner);
+ }
+
+ /// Returns `true` if the `CancellationToken` is cancelled.
+ pub fn is_cancelled(&self) -> bool {
+ tree_node::is_cancelled(&self.inner)
+ }
+
+ /// Returns a `Future` that gets fulfilled when cancellation is requested.
+ ///
+ /// The future will complete immediately if the token is already cancelled
+ /// when this method is called.
+ ///
+ /// # Cancel safety
+ ///
+ /// This method is cancel safe.
+ pub fn cancelled(&self) -> WaitForCancellationFuture<'_> {
+ WaitForCancellationFuture {
+ cancellation_token: self,
+ future: self.inner.notified(),
+ }
+ }
+
+ /// Returns a `Future` that gets fulfilled when cancellation is requested.
+ ///
+ /// The future will complete immediately if the token is already cancelled
+ /// when this method is called.
+ ///
+ /// The function takes self by value and returns a future that owns the
+ /// token.
+ ///
+ /// # Cancel safety
+ ///
+ /// This method is cancel safe.
+ pub fn cancelled_owned(self) -> WaitForCancellationFutureOwned {
+ WaitForCancellationFutureOwned::new(self)
+ }
+
+ /// Creates a `DropGuard` for this token.
+ ///
+ /// Returned guard will cancel this token (and all its children) on drop
+ /// unless disarmed.
+ pub fn drop_guard(self) -> DropGuard {
+ DropGuard { inner: Some(self) }
+ }
+}
+
+// ===== impl WaitForCancellationFuture =====
+
+impl<'a> core::fmt::Debug for WaitForCancellationFuture<'a> {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ f.debug_struct("WaitForCancellationFuture").finish()
+ }
+}
+
+impl<'a> Future for WaitForCancellationFuture<'a> {
+ type Output = ();
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
+ let mut this = self.project();
+ loop {
+ if this.cancellation_token.is_cancelled() {
+ return Poll::Ready(());
+ }
+
+ // No wakeups can be lost here because there is always a call to
+ // `is_cancelled` between the creation of the future and the call to
+ // `poll`, and the code that sets the cancelled flag does so before
+ // waking the `Notified`.
+ if this.future.as_mut().poll(cx).is_pending() {
+ return Poll::Pending;
+ }
+
+ this.future.set(this.cancellation_token.inner.notified());
+ }
+ }
+}
+
+// ===== impl WaitForCancellationFutureOwned =====
+
+impl core::fmt::Debug for WaitForCancellationFutureOwned {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ f.debug_struct("WaitForCancellationFutureOwned").finish()
+ }
+}
+
+impl WaitForCancellationFutureOwned {
+ fn new(cancellation_token: CancellationToken) -> Self {
+ WaitForCancellationFutureOwned {
+ // cancellation_token holds a heap allocation and is guaranteed to have a
+ // stable deref, thus it would be ok to move the cancellation_token while
+ // the future holds a reference to it.
+ //
+ // # Safety
+ //
+ // cancellation_token is dropped after future due to the field ordering.
+ future: MaybeDangling::new(unsafe { Self::new_future(&cancellation_token) }),
+ cancellation_token,
+ }
+ }
+
+ /// # Safety
+ /// The returned future must be destroyed before the cancellation token is
+ /// destroyed.
+ unsafe fn new_future(
+ cancellation_token: &CancellationToken,
+ ) -> tokio::sync::futures::Notified<'static> {
+ let inner_ptr = Arc::as_ptr(&cancellation_token.inner);
+ // SAFETY: The `Arc::as_ptr` method guarantees that `inner_ptr` remains
+ // valid until the strong count of the Arc drops to zero, and the caller
+ // guarantees that they will drop the future before that happens.
+ (*inner_ptr).notified()
+ }
+}
+
+impl Future for WaitForCancellationFutureOwned {
+ type Output = ();
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
+ let mut this = self.project();
+
+ loop {
+ if this.cancellation_token.is_cancelled() {
+ return Poll::Ready(());
+ }
+
+ // No wakeups can be lost here because there is always a call to
+ // `is_cancelled` between the creation of the future and the call to
+ // `poll`, and the code that sets the cancelled flag does so before
+ // waking the `Notified`.
+ if this.future.as_mut().poll(cx).is_pending() {
+ return Poll::Pending;
+ }
+
+ // # Safety
+ //
+ // cancellation_token is dropped after future due to the field ordering.
+ this.future.set(MaybeDangling::new(unsafe {
+ Self::new_future(this.cancellation_token)
+ }));
+ }
+ }
+}
diff --git a/crates/tokio-util/src/sync/cancellation_token/guard.rs b/crates/tokio-util/src/sync/cancellation_token/guard.rs
new file mode 100644
index 0000000..54ed7ea
--- /dev/null
+++ b/crates/tokio-util/src/sync/cancellation_token/guard.rs
@@ -0,0 +1,27 @@
+use crate::sync::CancellationToken;
+
+/// A wrapper for cancellation token which automatically cancels
+/// it on drop. It is created using `drop_guard` method on the `CancellationToken`.
+#[derive(Debug)]
+pub struct DropGuard {
+ pub(super) inner: Option<CancellationToken>,
+}
+
+impl DropGuard {
+ /// Returns stored cancellation token and removes this drop guard instance
+ /// (i.e. it will no longer cancel token). Other guards for this token
+ /// are not affected.
+ pub fn disarm(mut self) -> CancellationToken {
+ self.inner
+ .take()
+ .expect("`inner` can be only None in a destructor")
+ }
+}
+
+impl Drop for DropGuard {
+ fn drop(&mut self) {
+ if let Some(inner) = &self.inner {
+ inner.cancel();
+ }
+ }
+}
diff --git a/crates/tokio-util/src/sync/cancellation_token/tree_node.rs b/crates/tokio-util/src/sync/cancellation_token/tree_node.rs
new file mode 100644
index 0000000..b7a9805
--- /dev/null
+++ b/crates/tokio-util/src/sync/cancellation_token/tree_node.rs
@@ -0,0 +1,365 @@
+//! This mod provides the logic for the inner tree structure of the CancellationToken.
+//!
+//! CancellationTokens are only light handles with references to [`TreeNode`].
+//! All the logic is actually implemented in the [`TreeNode`].
+//!
+//! A [`TreeNode`] is part of the cancellation tree and may have one parent and an arbitrary number of
+//! children.
+//!
+//! A [`TreeNode`] can receive the request to perform a cancellation through a CancellationToken.
+//! This cancellation request will cancel the node and all of its descendants.
+//!
+//! As soon as a node cannot get cancelled any more (because it was already cancelled or it has no
+//! more CancellationTokens pointing to it any more), it gets removed from the tree, to keep the
+//! tree as small as possible.
+//!
+//! # Invariants
+//!
+//! Those invariants shall be true at any time.
+//!
+//! 1. A node that has no parents and no handles can no longer be cancelled.
+//! This is important during both cancellation and refcounting.
+//!
+//! 2. If node B *is* or *was* a child of node A, then node B was created *after* node A.
+//! This is important for deadlock safety, as it is used for lock order.
+//! Node B can only become the child of node A in two ways:
+//! - being created with `child_node()`, in which case it is trivially true that
+//! node A already existed when node B was created
+//! - being moved A->C->B to A->B because node C was removed in `decrease_handle_refcount()`
+//! or `cancel()`. In this case the invariant still holds, as B was younger than C, and C
+//! was younger than A, therefore B is also younger than A.
+//!
+//! 3. If two nodes are both unlocked and node A is the parent of node B, then node B is a child of
+//! node A. It is important to always restore that invariant before dropping the lock of a node.
+//!
+//! # Deadlock safety
+//!
+//! We always lock in the order of creation time. We can prove this through invariant #2.
+//! Specifically, through invariant #2, we know that we always have to lock a parent
+//! before its child.
+//!
+use crate::loom::sync::{Arc, Mutex, MutexGuard};
+
+/// A node of the cancellation tree structure
+///
+/// The actual data it holds is wrapped inside a mutex for synchronization.
+pub(crate) struct TreeNode {
+ inner: Mutex<Inner>,
+ waker: tokio::sync::Notify,
+}
+impl TreeNode {
+ pub(crate) fn new() -> Self {
+ Self {
+ inner: Mutex::new(Inner {
+ parent: None,
+ parent_idx: 0,
+ children: vec![],
+ is_cancelled: false,
+ num_handles: 1,
+ }),
+ waker: tokio::sync::Notify::new(),
+ }
+ }
+
+ pub(crate) fn notified(&self) -> tokio::sync::futures::Notified<'_> {
+ self.waker.notified()
+ }
+}
+
+/// The data contained inside a TreeNode.
+///
+/// This struct exists so that the data of the node can be wrapped
+/// in a Mutex.
+struct Inner {
+ parent: Option<Arc<TreeNode>>,
+ parent_idx: usize,
+ children: Vec<Arc<TreeNode>>,
+ is_cancelled: bool,
+ num_handles: usize,
+}
+
+/// Returns whether or not the node is cancelled
+pub(crate) fn is_cancelled(node: &Arc<TreeNode>) -> bool {
+ node.inner.lock().unwrap().is_cancelled
+}
+
+/// Creates a child node
+pub(crate) fn child_node(parent: &Arc<TreeNode>) -> Arc<TreeNode> {
+ let mut locked_parent = parent.inner.lock().unwrap();
+
+ // Do not register as child if we are already cancelled.
+ // Cancelled trees can never be uncancelled and therefore
+ // need no connection to parents or children any more.
+ if locked_parent.is_cancelled {
+ return Arc::new(TreeNode {
+ inner: Mutex::new(Inner {
+ parent: None,
+ parent_idx: 0,
+ children: vec![],
+ is_cancelled: true,
+ num_handles: 1,
+ }),
+ waker: tokio::sync::Notify::new(),
+ });
+ }
+
+ let child = Arc::new(TreeNode {
+ inner: Mutex::new(Inner {
+ parent: Some(parent.clone()),
+ parent_idx: locked_parent.children.len(),
+ children: vec![],
+ is_cancelled: false,
+ num_handles: 1,
+ }),
+ waker: tokio::sync::Notify::new(),
+ });
+
+ locked_parent.children.push(child.clone());
+
+ child
+}
+
+/// Disconnects the given parent from all of its children.
+///
+/// Takes a reference to [Inner] to make sure the parent is already locked.
+fn disconnect_children(node: &mut Inner) {
+ for child in std::mem::take(&mut node.children) {
+ let mut locked_child = child.inner.lock().unwrap();
+ locked_child.parent_idx = 0;
+ locked_child.parent = None;
+ }
+}
+
+/// Figures out the parent of the node and locks the node and its parent atomically.
+///
+/// The basic principle of preventing deadlocks in the tree is
+/// that we always lock the parent first, and then the child.
+/// For more info look at *deadlock safety* and *invariant #2*.
+///
+/// Sadly, it's impossible to figure out the parent of a node without
+/// locking it. To then achieve locking order consistency, the node
+/// has to be unlocked before the parent gets locked.
+/// This leaves a small window where we already assume that we know the parent,
+/// but neither the parent nor the node is locked. Therefore, the parent could change.
+///
+/// To prevent that this problem leaks into the rest of the code, it is abstracted
+/// in this function.
+///
+/// The locked child and optionally its locked parent, if a parent exists, get passed
+/// to the `func` argument via (node, None) or (node, Some(parent)).
+fn with_locked_node_and_parent<F, Ret>(node: &Arc<TreeNode>, func: F) -> Ret
+where
+ F: FnOnce(MutexGuard<'_, Inner>, Option<MutexGuard<'_, Inner>>) -> Ret,
+{
+ use std::sync::TryLockError;
+
+ let mut locked_node = node.inner.lock().unwrap();
+
+ // Every time this fails, the number of ancestors of the node decreases,
+ // so the loop must succeed after a finite number of iterations.
+ loop {
+ // Look up the parent of the currently locked node.
+ let potential_parent = match locked_node.parent.as_ref() {
+ Some(potential_parent) => potential_parent.clone(),
+ None => return func(locked_node, None),
+ };
+
+ // Lock the parent. This may require unlocking the child first.
+ let locked_parent = match potential_parent.inner.try_lock() {
+ Ok(locked_parent) => locked_parent,
+ Err(TryLockError::WouldBlock) => {
+ drop(locked_node);
+ // Deadlock safety:
+ //
+ // Due to invariant #2, the potential parent must come before
+ // the child in the creation order. Therefore, we can safely
+ // lock the child while holding the parent lock.
+ let locked_parent = potential_parent.inner.lock().unwrap();
+ locked_node = node.inner.lock().unwrap();
+ locked_parent
+ }
+ Err(TryLockError::Poisoned(err)) => Err(err).unwrap(),
+ };
+
+ // If we unlocked the child, then the parent may have changed. Check
+ // that we still have the right parent.
+ if let Some(actual_parent) = locked_node.parent.as_ref() {
+ if Arc::ptr_eq(actual_parent, &potential_parent) {
+ return func(locked_node, Some(locked_parent));
+ }
+ }
+ }
+}
+
+/// Moves all children from `node` to `parent`.
+///
+/// `parent` MUST have been a parent of the node when they both got locked,
+/// otherwise there is a potential for a deadlock as invariant #2 would be violated.
+///
+/// To acquire the locks for node and parent, use [with_locked_node_and_parent].
+fn move_children_to_parent(node: &mut Inner, parent: &mut Inner) {
+ // Pre-allocate in the parent, for performance
+ parent.children.reserve(node.children.len());
+
+ for child in std::mem::take(&mut node.children) {
+ {
+ let mut child_locked = child.inner.lock().unwrap();
+ child_locked.parent = node.parent.clone();
+ child_locked.parent_idx = parent.children.len();
+ }
+ parent.children.push(child);
+ }
+}
+
+/// Removes a child from the parent.
+///
+/// `parent` MUST be the parent of `node`.
+/// To acquire the locks for node and parent, use [with_locked_node_and_parent].
+fn remove_child(parent: &mut Inner, mut node: MutexGuard<'_, Inner>) {
+ // Query the position from where to remove a node
+ let pos = node.parent_idx;
+ node.parent = None;
+ node.parent_idx = 0;
+
+ // Unlock node, so that only one child at a time is locked.
+ // Otherwise we would violate the lock order (see 'deadlock safety') as we
+ // don't know the creation order of the child nodes
+ drop(node);
+
+ // If `node` is the last element in the list, we don't need any swapping
+ if parent.children.len() == pos + 1 {
+ parent.children.pop().unwrap();
+ } else {
+ // If `node` is not the last element in the list, we need to
+ // replace it with the last element
+ let replacement_child = parent.children.pop().unwrap();
+ replacement_child.inner.lock().unwrap().parent_idx = pos;
+ parent.children[pos] = replacement_child;
+ }
+
+ let len = parent.children.len();
+ if 4 * len <= parent.children.capacity() {
+ parent.children.shrink_to(2 * len);
+ }
+}
+
+/// Increases the reference count of handles.
+pub(crate) fn increase_handle_refcount(node: &Arc<TreeNode>) {
+ let mut locked_node = node.inner.lock().unwrap();
+
+ // Once no handles are left over, the node gets detached from the tree.
+ // There should never be a new handle once all handles are dropped.
+ assert!(locked_node.num_handles > 0);
+
+ locked_node.num_handles += 1;
+}
+
+/// Decreases the reference count of handles.
+///
+/// Once no handle is left, we can remove the node from the
+/// tree and connect its parent directly to its children.
+pub(crate) fn decrease_handle_refcount(node: &Arc<TreeNode>) {
+ let num_handles = {
+ let mut locked_node = node.inner.lock().unwrap();
+ locked_node.num_handles -= 1;
+ locked_node.num_handles
+ };
+
+ if num_handles == 0 {
+ with_locked_node_and_parent(node, |mut node, parent| {
+ // Remove the node from the tree
+ match parent {
+ Some(mut parent) => {
+ // As we want to remove ourselves from the tree,
+ // we have to move the children to the parent, so that
+ // they still receive the cancellation event without us.
+ // Moving them does not violate invariant #1.
+ move_children_to_parent(&mut node, &mut parent);
+
+ // Remove the node from the parent
+ remove_child(&mut parent, node);
+ }
+ None => {
+ // Due to invariant #1, we can assume that our
+ // children can no longer be cancelled through us.
+ // (as we now have neither a parent nor handles)
+ // Therefore we can disconnect them.
+ disconnect_children(&mut node);
+ }
+ }
+ });
+ }
+}
+
+/// Cancels a node and its children.
+pub(crate) fn cancel(node: &Arc<TreeNode>) {
+ let mut locked_node = node.inner.lock().unwrap();
+
+ if locked_node.is_cancelled {
+ return;
+ }
+
+ // One by one, adopt grandchildren and then cancel and detach the child
+ while let Some(child) = locked_node.children.pop() {
+ // This can't deadlock because the mutex we are already
+ // holding is the parent of child.
+ let mut locked_child = child.inner.lock().unwrap();
+
+ // Detach the child from node
+ // No need to modify node.children, as the child already got removed with `.pop`
+ locked_child.parent = None;
+ locked_child.parent_idx = 0;
+
+ // If child is already cancelled, detaching is enough
+ if locked_child.is_cancelled {
+ continue;
+ }
+
+ // Cancel or adopt grandchildren
+ while let Some(grandchild) = locked_child.children.pop() {
+ // This can't deadlock because the two mutexes we are already
+ // holding is the parent and grandparent of grandchild.
+ let mut locked_grandchild = grandchild.inner.lock().unwrap();
+
+ // Detach the grandchild
+ locked_grandchild.parent = None;
+ locked_grandchild.parent_idx = 0;
+
+ // If grandchild is already cancelled, detaching is enough
+ if locked_grandchild.is_cancelled {
+ continue;
+ }
+
+ // For performance reasons, only adopt grandchildren that have children.
+ // Otherwise, just cancel them right away, no need for another iteration.
+ if locked_grandchild.children.is_empty() {
+ // Cancel the grandchild
+ locked_grandchild.is_cancelled = true;
+ locked_grandchild.children = Vec::new();
+ drop(locked_grandchild);
+ grandchild.waker.notify_waiters();
+ } else {
+ // Otherwise, adopt grandchild
+ locked_grandchild.parent = Some(node.clone());
+ locked_grandchild.parent_idx = locked_node.children.len();
+ drop(locked_grandchild);
+ locked_node.children.push(grandchild);
+ }
+ }
+
+ // Cancel the child
+ locked_child.is_cancelled = true;
+ locked_child.children = Vec::new();
+ drop(locked_child);
+ child.waker.notify_waiters();
+
+ // Now the child is cancelled and detached and all its children are adopted.
+ // Just continue until all (including adopted) children are cancelled and detached.
+ }
+
+ // Cancel the node itself.
+ locked_node.is_cancelled = true;
+ locked_node.children = Vec::new();
+ drop(locked_node);
+ node.waker.notify_waiters();
+}
diff --git a/crates/tokio-util/src/sync/mod.rs b/crates/tokio-util/src/sync/mod.rs
new file mode 100644
index 0000000..1ae1b7e
--- /dev/null
+++ b/crates/tokio-util/src/sync/mod.rs
@@ -0,0 +1,15 @@
+//! Synchronization primitives
+
+mod cancellation_token;
+pub use cancellation_token::{
+ guard::DropGuard, CancellationToken, WaitForCancellationFuture, WaitForCancellationFutureOwned,
+};
+
+mod mpsc;
+pub use mpsc::{PollSendError, PollSender};
+
+mod poll_semaphore;
+pub use poll_semaphore::PollSemaphore;
+
+mod reusable_box;
+pub use reusable_box::ReusableBoxFuture;
diff --git a/crates/tokio-util/src/sync/mpsc.rs b/crates/tokio-util/src/sync/mpsc.rs
new file mode 100644
index 0000000..fd48c72
--- /dev/null
+++ b/crates/tokio-util/src/sync/mpsc.rs
@@ -0,0 +1,325 @@
+use futures_sink::Sink;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use std::{fmt, mem};
+use tokio::sync::mpsc::OwnedPermit;
+use tokio::sync::mpsc::Sender;
+
+use super::ReusableBoxFuture;
+
+/// Error returned by the `PollSender` when the channel is closed.
+#[derive(Debug)]
+pub struct PollSendError<T>(Option<T>);
+
+impl<T> PollSendError<T> {
+ /// Consumes the stored value, if any.
+ ///
+ /// If this error was encountered when calling `start_send`/`send_item`, this will be the item
+ /// that the caller attempted to send. Otherwise, it will be `None`.
+ pub fn into_inner(self) -> Option<T> {
+ self.0
+ }
+}
+
+impl<T> fmt::Display for PollSendError<T> {
+ fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(fmt, "channel closed")
+ }
+}
+
+impl<T: fmt::Debug> std::error::Error for PollSendError<T> {}
+
+#[derive(Debug)]
+enum State<T> {
+ Idle(Sender<T>),
+ Acquiring,
+ ReadyToSend(OwnedPermit<T>),
+ Closed,
+}
+
+/// A wrapper around [`mpsc::Sender`] that can be polled.
+///
+/// [`mpsc::Sender`]: tokio::sync::mpsc::Sender
+#[derive(Debug)]
+pub struct PollSender<T> {
+ sender: Option<Sender<T>>,
+ state: State<T>,
+ acquire: PollSenderFuture<T>,
+}
+
+// Creates a future for acquiring a permit from the underlying channel. This is used to ensure
+// there's capacity for a send to complete.
+//
+// By reusing the same async fn for both `Some` and `None`, we make sure every future passed to
+// ReusableBoxFuture has the same underlying type, and hence the same size and alignment.
+async fn make_acquire_future<T>(
+ data: Option<Sender<T>>,
+) -> Result<OwnedPermit<T>, PollSendError<T>> {
+ match data {
+ Some(sender) => sender
+ .reserve_owned()
+ .await
+ .map_err(|_| PollSendError(None)),
+ None => unreachable!("this future should not be pollable in this state"),
+ }
+}
+
+type InnerFuture<'a, T> = ReusableBoxFuture<'a, Result<OwnedPermit<T>, PollSendError<T>>>;
+
+#[derive(Debug)]
+// TODO: This should be replace with a type_alias_impl_trait to eliminate `'static` and all the transmutes
+struct PollSenderFuture<T>(InnerFuture<'static, T>);
+
+impl<T> PollSenderFuture<T> {
+ /// Create with an empty inner future with no `Send` bound.
+ fn empty() -> Self {
+ // We don't use `make_acquire_future` here because our relaxed bounds on `T` are not
+ // compatible with the transitive bounds required by `Sender<T>`.
+ Self(ReusableBoxFuture::new(async { unreachable!() }))
+ }
+}
+
+impl<T: Send> PollSenderFuture<T> {
+ /// Create with an empty inner future.
+ fn new() -> Self {
+ let v = InnerFuture::new(make_acquire_future(None));
+ // This is safe because `make_acquire_future(None)` is actually `'static`
+ Self(unsafe { mem::transmute::<InnerFuture<'_, T>, InnerFuture<'static, T>>(v) })
+ }
+
+ /// Poll the inner future.
+ fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Result<OwnedPermit<T>, PollSendError<T>>> {
+ self.0.poll(cx)
+ }
+
+ /// Replace the inner future.
+ fn set(&mut self, sender: Option<Sender<T>>) {
+ let inner: *mut InnerFuture<'static, T> = &mut self.0;
+ let inner: *mut InnerFuture<'_, T> = inner.cast();
+ // SAFETY: The `make_acquire_future(sender)` future must not exist after the type `T`
+ // becomes invalid, and this casts away the type-level lifetime check for that. However, the
+ // inner future is never moved out of this `PollSenderFuture<T>`, so the future will not
+ // live longer than the `PollSenderFuture<T>` lives. A `PollSenderFuture<T>` is guaranteed
+ // to not exist after the type `T` becomes invalid, because it is annotated with a `T`, so
+ // this is ok.
+ let inner = unsafe { &mut *inner };
+ inner.set(make_acquire_future(sender));
+ }
+}
+
+impl<T: Send> PollSender<T> {
+ /// Creates a new `PollSender`.
+ pub fn new(sender: Sender<T>) -> Self {
+ Self {
+ sender: Some(sender.clone()),
+ state: State::Idle(sender),
+ acquire: PollSenderFuture::new(),
+ }
+ }
+
+ fn take_state(&mut self) -> State<T> {
+ mem::replace(&mut self.state, State::Closed)
+ }
+
+ /// Attempts to prepare the sender to receive a value.
+ ///
+ /// This method must be called and return `Poll::Ready(Ok(()))` prior to each call to
+ /// `send_item`.
+ ///
+ /// This method returns `Poll::Ready` once the underlying channel is ready to receive a value,
+ /// by reserving a slot in the channel for the item to be sent. If this method returns
+ /// `Poll::Pending`, the current task is registered to be notified (via
+ /// `cx.waker().wake_by_ref()`) when `poll_reserve` should be called again.
+ ///
+ /// # Errors
+ ///
+ /// If the channel is closed, an error will be returned. This is a permanent state.
+ pub fn poll_reserve(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), PollSendError<T>>> {
+ loop {
+ let (result, next_state) = match self.take_state() {
+ State::Idle(sender) => {
+ // Start trying to acquire a permit to reserve a slot for our send, and
+ // immediately loop back around to poll it the first time.
+ self.acquire.set(Some(sender));
+ (None, State::Acquiring)
+ }
+ State::Acquiring => match self.acquire.poll(cx) {
+ // Channel has capacity.
+ Poll::Ready(Ok(permit)) => {
+ (Some(Poll::Ready(Ok(()))), State::ReadyToSend(permit))
+ }
+ // Channel is closed.
+ Poll::Ready(Err(e)) => (Some(Poll::Ready(Err(e))), State::Closed),
+ // Channel doesn't have capacity yet, so we need to wait.
+ Poll::Pending => (Some(Poll::Pending), State::Acquiring),
+ },
+ // We're closed, either by choice or because the underlying sender was closed.
+ s @ State::Closed => (Some(Poll::Ready(Err(PollSendError(None)))), s),
+ // We're already ready to send an item.
+ s @ State::ReadyToSend(_) => (Some(Poll::Ready(Ok(()))), s),
+ };
+
+ self.state = next_state;
+ if let Some(result) = result {
+ return result;
+ }
+ }
+ }
+
+ /// Sends an item to the channel.
+ ///
+ /// Before calling `send_item`, `poll_reserve` must be called with a successful return
+ /// value of `Poll::Ready(Ok(()))`.
+ ///
+ /// # Errors
+ ///
+ /// If the channel is closed, an error will be returned. This is a permanent state.
+ ///
+ /// # Panics
+ ///
+ /// If `poll_reserve` was not successfully called prior to calling `send_item`, then this method
+ /// will panic.
+ #[track_caller]
+ pub fn send_item(&mut self, value: T) -> Result<(), PollSendError<T>> {
+ let (result, next_state) = match self.take_state() {
+ State::Idle(_) | State::Acquiring => {
+ panic!("`send_item` called without first calling `poll_reserve`")
+ }
+ // We have a permit to send our item, so go ahead, which gets us our sender back.
+ State::ReadyToSend(permit) => (Ok(()), State::Idle(permit.send(value))),
+ // We're closed, either by choice or because the underlying sender was closed.
+ State::Closed => (Err(PollSendError(Some(value))), State::Closed),
+ };
+
+ // Handle deferred closing if `close` was called between `poll_reserve` and `send_item`.
+ self.state = if self.sender.is_some() {
+ next_state
+ } else {
+ State::Closed
+ };
+ result
+ }
+
+ /// Checks whether this sender is been closed.
+ ///
+ /// The underlying channel that this sender was wrapping may still be open.
+ pub fn is_closed(&self) -> bool {
+ matches!(self.state, State::Closed) || self.sender.is_none()
+ }
+
+ /// Gets a reference to the `Sender` of the underlying channel.
+ ///
+ /// If `PollSender` has been closed, `None` is returned. The underlying channel that this sender
+ /// was wrapping may still be open.
+ pub fn get_ref(&self) -> Option<&Sender<T>> {
+ self.sender.as_ref()
+ }
+
+ /// Closes this sender.
+ ///
+ /// No more messages will be able to be sent from this sender, but the underlying channel will
+ /// remain open until all senders have dropped, or until the [`Receiver`] closes the channel.
+ ///
+ /// If a slot was previously reserved by calling `poll_reserve`, then a final call can be made
+ /// to `send_item` in order to consume the reserved slot. After that, no further sends will be
+ /// possible. If you do not intend to send another item, you can release the reserved slot back
+ /// to the underlying sender by calling [`abort_send`].
+ ///
+ /// [`abort_send`]: crate::sync::PollSender::abort_send
+ /// [`Receiver`]: tokio::sync::mpsc::Receiver
+ pub fn close(&mut self) {
+ // Mark ourselves officially closed by dropping our main sender.
+ self.sender = None;
+
+ // If we're already idle, closed, or we haven't yet reserved a slot, we can quickly
+ // transition to the closed state. Otherwise, leave the existing permit in place for the
+ // caller if they want to complete the send.
+ match self.state {
+ State::Idle(_) => self.state = State::Closed,
+ State::Acquiring => {
+ self.acquire.set(None);
+ self.state = State::Closed;
+ }
+ _ => {}
+ }
+ }
+
+ /// Aborts the current in-progress send, if any.
+ ///
+ /// Returns `true` if a send was aborted. If the sender was closed prior to calling
+ /// `abort_send`, then the sender will remain in the closed state, otherwise the sender will be
+ /// ready to attempt another send.
+ pub fn abort_send(&mut self) -> bool {
+ // We may have been closed in the meantime, after a call to `poll_reserve` already
+ // succeeded. We'll check if `self.sender` is `None` to see if we should transition to the
+ // closed state when we actually abort a send, rather than resetting ourselves back to idle.
+
+ let (result, next_state) = match self.take_state() {
+ // We're currently trying to reserve a slot to send into.
+ State::Acquiring => {
+ // Replacing the future drops the in-flight one.
+ self.acquire.set(None);
+
+ // If we haven't closed yet, we have to clone our stored sender since we have no way
+ // to get it back from the acquire future we just dropped.
+ let state = match self.sender.clone() {
+ Some(sender) => State::Idle(sender),
+ None => State::Closed,
+ };
+ (true, state)
+ }
+ // We got the permit. If we haven't closed yet, get the sender back.
+ State::ReadyToSend(permit) => {
+ let state = if self.sender.is_some() {
+ State::Idle(permit.release())
+ } else {
+ State::Closed
+ };
+ (true, state)
+ }
+ s => (false, s),
+ };
+
+ self.state = next_state;
+ result
+ }
+}
+
+impl<T> Clone for PollSender<T> {
+ /// Clones this `PollSender`.
+ ///
+ /// The resulting `PollSender` will have an initial state identical to calling `PollSender::new`.
+ fn clone(&self) -> PollSender<T> {
+ let (sender, state) = match self.sender.clone() {
+ Some(sender) => (Some(sender.clone()), State::Idle(sender)),
+ None => (None, State::Closed),
+ };
+
+ Self {
+ sender,
+ state,
+ acquire: PollSenderFuture::empty(),
+ }
+ }
+}
+
+impl<T: Send + 'static> Sink<T> for PollSender<T> {
+ type Error = PollSendError<T>;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Pin::into_inner(self).poll_reserve(cx)
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error> {
+ Pin::into_inner(self).send_item(item)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Pin::into_inner(self).close();
+ Poll::Ready(Ok(()))
+ }
+}
diff --git a/crates/tokio-util/src/sync/poll_semaphore.rs b/crates/tokio-util/src/sync/poll_semaphore.rs
new file mode 100644
index 0000000..4960a7c
--- /dev/null
+++ b/crates/tokio-util/src/sync/poll_semaphore.rs
@@ -0,0 +1,171 @@
+use futures_core::{ready, Stream};
+use std::fmt;
+use std::pin::Pin;
+use std::sync::Arc;
+use std::task::{Context, Poll};
+use tokio::sync::{AcquireError, OwnedSemaphorePermit, Semaphore, TryAcquireError};
+
+use super::ReusableBoxFuture;
+
+/// A wrapper around [`Semaphore`] that provides a `poll_acquire` method.
+///
+/// [`Semaphore`]: tokio::sync::Semaphore
+pub struct PollSemaphore {
+ semaphore: Arc<Semaphore>,
+ permit_fut: Option<(
+ u32, // The number of permits requested.
+ ReusableBoxFuture<'static, Result<OwnedSemaphorePermit, AcquireError>>,
+ )>,
+}
+
+impl PollSemaphore {
+ /// Create a new `PollSemaphore`.
+ pub fn new(semaphore: Arc<Semaphore>) -> Self {
+ Self {
+ semaphore,
+ permit_fut: None,
+ }
+ }
+
+ /// Closes the semaphore.
+ pub fn close(&self) {
+ self.semaphore.close();
+ }
+
+ /// Obtain a clone of the inner semaphore.
+ pub fn clone_inner(&self) -> Arc<Semaphore> {
+ self.semaphore.clone()
+ }
+
+ /// Get back the inner semaphore.
+ pub fn into_inner(self) -> Arc<Semaphore> {
+ self.semaphore
+ }
+
+ /// Poll to acquire a permit from the semaphore.
+ ///
+ /// This can return the following values:
+ ///
+ /// - `Poll::Pending` if a permit is not currently available.
+ /// - `Poll::Ready(Some(permit))` if a permit was acquired.
+ /// - `Poll::Ready(None)` if the semaphore has been closed.
+ ///
+ /// When this method returns `Poll::Pending`, the current task is scheduled
+ /// to receive a wakeup when a permit becomes available, or when the
+ /// semaphore is closed. Note that on multiple calls to `poll_acquire`, only
+ /// the `Waker` from the `Context` passed to the most recent call is
+ /// scheduled to receive a wakeup.
+ pub fn poll_acquire(&mut self, cx: &mut Context<'_>) -> Poll<Option<OwnedSemaphorePermit>> {
+ self.poll_acquire_many(cx, 1)
+ }
+
+ /// Poll to acquire many permits from the semaphore.
+ ///
+ /// This can return the following values:
+ ///
+ /// - `Poll::Pending` if a permit is not currently available.
+ /// - `Poll::Ready(Some(permit))` if a permit was acquired.
+ /// - `Poll::Ready(None)` if the semaphore has been closed.
+ ///
+ /// When this method returns `Poll::Pending`, the current task is scheduled
+ /// to receive a wakeup when the permits become available, or when the
+ /// semaphore is closed. Note that on multiple calls to `poll_acquire`, only
+ /// the `Waker` from the `Context` passed to the most recent call is
+ /// scheduled to receive a wakeup.
+ pub fn poll_acquire_many(
+ &mut self,
+ cx: &mut Context<'_>,
+ permits: u32,
+ ) -> Poll<Option<OwnedSemaphorePermit>> {
+ let permit_future = match self.permit_fut.as_mut() {
+ Some((prev_permits, fut)) if *prev_permits == permits => fut,
+ Some((old_permits, fut_box)) => {
+ // We're requesting a different number of permits, so replace the future
+ // and record the new amount.
+ let fut = Arc::clone(&self.semaphore).acquire_many_owned(permits);
+ fut_box.set(fut);
+ *old_permits = permits;
+ fut_box
+ }
+ None => {
+ // avoid allocations completely if we can grab a permit immediately
+ match Arc::clone(&self.semaphore).try_acquire_many_owned(permits) {
+ Ok(permit) => return Poll::Ready(Some(permit)),
+ Err(TryAcquireError::Closed) => return Poll::Ready(None),
+ Err(TryAcquireError::NoPermits) => {}
+ }
+
+ let next_fut = Arc::clone(&self.semaphore).acquire_many_owned(permits);
+ &mut self
+ .permit_fut
+ .get_or_insert((permits, ReusableBoxFuture::new(next_fut)))
+ .1
+ }
+ };
+
+ let result = ready!(permit_future.poll(cx));
+
+ // Assume we'll request the same amount of permits in a subsequent call.
+ let next_fut = Arc::clone(&self.semaphore).acquire_many_owned(permits);
+ permit_future.set(next_fut);
+
+ match result {
+ Ok(permit) => Poll::Ready(Some(permit)),
+ Err(_closed) => {
+ self.permit_fut = None;
+ Poll::Ready(None)
+ }
+ }
+ }
+
+ /// Returns the current number of available permits.
+ ///
+ /// This is equivalent to the [`Semaphore::available_permits`] method on the
+ /// `tokio::sync::Semaphore` type.
+ ///
+ /// [`Semaphore::available_permits`]: tokio::sync::Semaphore::available_permits
+ pub fn available_permits(&self) -> usize {
+ self.semaphore.available_permits()
+ }
+
+ /// Adds `n` new permits to the semaphore.
+ ///
+ /// The maximum number of permits is [`Semaphore::MAX_PERMITS`], and this function
+ /// will panic if the limit is exceeded.
+ ///
+ /// This is equivalent to the [`Semaphore::add_permits`] method on the
+ /// `tokio::sync::Semaphore` type.
+ ///
+ /// [`Semaphore::add_permits`]: tokio::sync::Semaphore::add_permits
+ pub fn add_permits(&self, n: usize) {
+ self.semaphore.add_permits(n);
+ }
+}
+
+impl Stream for PollSemaphore {
+ type Item = OwnedSemaphorePermit;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<OwnedSemaphorePermit>> {
+ Pin::into_inner(self).poll_acquire(cx)
+ }
+}
+
+impl Clone for PollSemaphore {
+ fn clone(&self) -> PollSemaphore {
+ PollSemaphore::new(self.clone_inner())
+ }
+}
+
+impl fmt::Debug for PollSemaphore {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("PollSemaphore")
+ .field("semaphore", &self.semaphore)
+ .finish()
+ }
+}
+
+impl AsRef<Semaphore> for PollSemaphore {
+ fn as_ref(&self) -> &Semaphore {
+ &self.semaphore
+ }
+}
diff --git a/crates/tokio-util/src/sync/reusable_box.rs b/crates/tokio-util/src/sync/reusable_box.rs
new file mode 100644
index 0000000..1fae38c
--- /dev/null
+++ b/crates/tokio-util/src/sync/reusable_box.rs
@@ -0,0 +1,157 @@
+use std::alloc::Layout;
+use std::fmt;
+use std::future::{self, Future};
+use std::mem::{self, ManuallyDrop};
+use std::pin::Pin;
+use std::ptr;
+use std::task::{Context, Poll};
+
+/// A reusable `Pin<Box<dyn Future<Output = T> + Send + 'a>>`.
+///
+/// This type lets you replace the future stored in the box without
+/// reallocating when the size and alignment permits this.
+pub struct ReusableBoxFuture<'a, T> {
+ boxed: Pin<Box<dyn Future<Output = T> + Send + 'a>>,
+}
+
+impl<'a, T> ReusableBoxFuture<'a, T> {
+ /// Create a new `ReusableBoxFuture<T>` containing the provided future.
+ pub fn new<F>(future: F) -> Self
+ where
+ F: Future<Output = T> + Send + 'a,
+ {
+ Self {
+ boxed: Box::pin(future),
+ }
+ }
+
+ /// Replace the future currently stored in this box.
+ ///
+ /// This reallocates if and only if the layout of the provided future is
+ /// different from the layout of the currently stored future.
+ pub fn set<F>(&mut self, future: F)
+ where
+ F: Future<Output = T> + Send + 'a,
+ {
+ if let Err(future) = self.try_set(future) {
+ *self = Self::new(future);
+ }
+ }
+
+ /// Replace the future currently stored in this box.
+ ///
+ /// This function never reallocates, but returns an error if the provided
+ /// future has a different size or alignment from the currently stored
+ /// future.
+ pub fn try_set<F>(&mut self, future: F) -> Result<(), F>
+ where
+ F: Future<Output = T> + Send + 'a,
+ {
+ // If we try to inline the contents of this function, the type checker complains because
+ // the bound `T: 'a` is not satisfied in the call to `pending()`. But by putting it in an
+ // inner function that doesn't have `T` as a generic parameter, we implicitly get the bound
+ // `F::Output: 'a` transitively through `F: 'a`, allowing us to call `pending()`.
+ #[inline(always)]
+ fn real_try_set<'a, F>(
+ this: &mut ReusableBoxFuture<'a, F::Output>,
+ future: F,
+ ) -> Result<(), F>
+ where
+ F: Future + Send + 'a,
+ {
+ // future::Pending<T> is a ZST so this never allocates.
+ let boxed = mem::replace(&mut this.boxed, Box::pin(future::pending()));
+ reuse_pin_box(boxed, future, |boxed| this.boxed = Pin::from(boxed))
+ }
+
+ real_try_set(self, future)
+ }
+
+ /// Get a pinned reference to the underlying future.
+ pub fn get_pin(&mut self) -> Pin<&mut (dyn Future<Output = T> + Send)> {
+ self.boxed.as_mut()
+ }
+
+ /// Poll the future stored inside this box.
+ pub fn poll(&mut self, cx: &mut Context<'_>) -> Poll<T> {
+ self.get_pin().poll(cx)
+ }
+}
+
+impl<T> Future for ReusableBoxFuture<'_, T> {
+ type Output = T;
+
+ /// Poll the future stored inside this box.
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T> {
+ Pin::into_inner(self).get_pin().poll(cx)
+ }
+}
+
+// The only method called on self.boxed is poll, which takes &mut self, so this
+// struct being Sync does not permit any invalid access to the Future, even if
+// the future is not Sync.
+unsafe impl<T> Sync for ReusableBoxFuture<'_, T> {}
+
+impl<T> fmt::Debug for ReusableBoxFuture<'_, T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("ReusableBoxFuture").finish()
+ }
+}
+
+fn reuse_pin_box<T: ?Sized, U, O, F>(boxed: Pin<Box<T>>, new_value: U, callback: F) -> Result<O, U>
+where
+ F: FnOnce(Box<U>) -> O,
+{
+ let layout = Layout::for_value::<T>(&*boxed);
+ if layout != Layout::new::<U>() {
+ return Err(new_value);
+ }
+
+ // SAFETY: We don't ever construct a non-pinned reference to the old `T` from now on, and we
+ // always drop the `T`.
+ let raw: *mut T = Box::into_raw(unsafe { Pin::into_inner_unchecked(boxed) });
+
+ // When dropping the old value panics, we still want to call `callback` — so move the rest of
+ // the code into a guard type.
+ let guard = CallOnDrop::new(|| {
+ let raw: *mut U = raw.cast::<U>();
+ unsafe { raw.write(new_value) };
+
+ // SAFETY:
+ // - `T` and `U` have the same layout.
+ // - `raw` comes from a `Box` that uses the same allocator as this one.
+ // - `raw` points to a valid instance of `U` (we just wrote it in).
+ let boxed = unsafe { Box::from_raw(raw) };
+
+ callback(boxed)
+ });
+
+ // Drop the old value.
+ unsafe { ptr::drop_in_place(raw) };
+
+ // Run the rest of the code.
+ Ok(guard.call())
+}
+
+struct CallOnDrop<O, F: FnOnce() -> O> {
+ f: ManuallyDrop<F>,
+}
+
+impl<O, F: FnOnce() -> O> CallOnDrop<O, F> {
+ fn new(f: F) -> Self {
+ let f = ManuallyDrop::new(f);
+ Self { f }
+ }
+ fn call(self) -> O {
+ let mut this = ManuallyDrop::new(self);
+ let f = unsafe { ManuallyDrop::take(&mut this.f) };
+ f()
+ }
+}
+
+impl<O, F: FnOnce() -> O> Drop for CallOnDrop<O, F> {
+ fn drop(&mut self) {
+ let f = unsafe { ManuallyDrop::take(&mut self.f) };
+ f();
+ }
+}
diff --git a/crates/tokio-util/src/sync/tests/loom_cancellation_token.rs b/crates/tokio-util/src/sync/tests/loom_cancellation_token.rs
new file mode 100644
index 0000000..b57503d
--- /dev/null
+++ b/crates/tokio-util/src/sync/tests/loom_cancellation_token.rs
@@ -0,0 +1,176 @@
+use crate::sync::CancellationToken;
+
+use loom::{future::block_on, thread};
+use tokio_test::assert_ok;
+
+#[test]
+fn cancel_token() {
+ loom::model(|| {
+ let token = CancellationToken::new();
+ let token1 = token.clone();
+
+ let th1 = thread::spawn(move || {
+ block_on(async {
+ token1.cancelled().await;
+ });
+ });
+
+ let th2 = thread::spawn(move || {
+ token.cancel();
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ });
+}
+
+#[test]
+fn cancel_token_owned() {
+ loom::model(|| {
+ let token = CancellationToken::new();
+ let token1 = token.clone();
+
+ let th1 = thread::spawn(move || {
+ block_on(async {
+ token1.cancelled_owned().await;
+ });
+ });
+
+ let th2 = thread::spawn(move || {
+ token.cancel();
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ });
+}
+
+#[test]
+fn cancel_with_child() {
+ loom::model(|| {
+ let token = CancellationToken::new();
+ let token1 = token.clone();
+ let token2 = token.clone();
+ let child_token = token.child_token();
+
+ let th1 = thread::spawn(move || {
+ block_on(async {
+ token1.cancelled().await;
+ });
+ });
+
+ let th2 = thread::spawn(move || {
+ token2.cancel();
+ });
+
+ let th3 = thread::spawn(move || {
+ block_on(async {
+ child_token.cancelled().await;
+ });
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ assert_ok!(th3.join());
+ });
+}
+
+#[test]
+fn drop_token_no_child() {
+ loom::model(|| {
+ let token = CancellationToken::new();
+ let token1 = token.clone();
+ let token2 = token.clone();
+
+ let th1 = thread::spawn(move || {
+ drop(token1);
+ });
+
+ let th2 = thread::spawn(move || {
+ drop(token2);
+ });
+
+ let th3 = thread::spawn(move || {
+ drop(token);
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ assert_ok!(th3.join());
+ });
+}
+
+#[test]
+fn drop_token_with_children() {
+ loom::model(|| {
+ let token1 = CancellationToken::new();
+ let child_token1 = token1.child_token();
+ let child_token2 = token1.child_token();
+
+ let th1 = thread::spawn(move || {
+ drop(token1);
+ });
+
+ let th2 = thread::spawn(move || {
+ drop(child_token1);
+ });
+
+ let th3 = thread::spawn(move || {
+ drop(child_token2);
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ assert_ok!(th3.join());
+ });
+}
+
+#[test]
+fn drop_and_cancel_token() {
+ loom::model(|| {
+ let token1 = CancellationToken::new();
+ let token2 = token1.clone();
+ let child_token = token1.child_token();
+
+ let th1 = thread::spawn(move || {
+ drop(token1);
+ });
+
+ let th2 = thread::spawn(move || {
+ token2.cancel();
+ });
+
+ let th3 = thread::spawn(move || {
+ drop(child_token);
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ assert_ok!(th3.join());
+ });
+}
+
+#[test]
+fn cancel_parent_and_child() {
+ loom::model(|| {
+ let token1 = CancellationToken::new();
+ let token2 = token1.clone();
+ let child_token = token1.child_token();
+
+ let th1 = thread::spawn(move || {
+ drop(token1);
+ });
+
+ let th2 = thread::spawn(move || {
+ token2.cancel();
+ });
+
+ let th3 = thread::spawn(move || {
+ child_token.cancel();
+ });
+
+ assert_ok!(th1.join());
+ assert_ok!(th2.join());
+ assert_ok!(th3.join());
+ });
+}
diff --git a/crates/tokio-util/src/sync/tests/mod.rs b/crates/tokio-util/src/sync/tests/mod.rs
new file mode 100644
index 0000000..8b13789
--- /dev/null
+++ b/crates/tokio-util/src/sync/tests/mod.rs
@@ -0,0 +1 @@
+
diff --git a/crates/tokio-util/src/task/join_map.rs b/crates/tokio-util/src/task/join_map.rs
new file mode 100644
index 0000000..1fbe274
--- /dev/null
+++ b/crates/tokio-util/src/task/join_map.rs
@@ -0,0 +1,904 @@
+use hashbrown::hash_map::RawEntryMut;
+use hashbrown::HashMap;
+use std::borrow::Borrow;
+use std::collections::hash_map::RandomState;
+use std::fmt;
+use std::future::Future;
+use std::hash::{BuildHasher, Hash, Hasher};
+use std::marker::PhantomData;
+use tokio::runtime::Handle;
+use tokio::task::{AbortHandle, Id, JoinError, JoinSet, LocalSet};
+
+/// A collection of tasks spawned on a Tokio runtime, associated with hash map
+/// keys.
+///
+/// This type is very similar to the [`JoinSet`] type in `tokio::task`, with the
+/// addition of a set of keys associated with each task. These keys allow
+/// [cancelling a task][abort] or [multiple tasks][abort_matching] in the
+/// `JoinMap` based on their keys, or [test whether a task corresponding to a
+/// given key exists][contains] in the `JoinMap`.
+///
+/// In addition, when tasks in the `JoinMap` complete, they will return the
+/// associated key along with the value returned by the task, if any.
+///
+/// A `JoinMap` can be used to await the completion of some or all of the tasks
+/// in the map. The map is not ordered, and the tasks will be returned in the
+/// order they complete.
+///
+/// All of the tasks must have the same return type `V`.
+///
+/// When the `JoinMap` is dropped, all tasks in the `JoinMap` are immediately aborted.
+///
+/// **Note**: This type depends on Tokio's [unstable API][unstable]. See [the
+/// documentation on unstable features][unstable] for details on how to enable
+/// Tokio's unstable features.
+///
+/// # Examples
+///
+/// Spawn multiple tasks and wait for them:
+///
+/// ```
+/// use tokio_util::task::JoinMap;
+///
+/// #[tokio::main]
+/// async fn main() {
+/// let mut map = JoinMap::new();
+///
+/// for i in 0..10 {
+/// // Spawn a task on the `JoinMap` with `i` as its key.
+/// map.spawn(i, async move { /* ... */ });
+/// }
+///
+/// let mut seen = [false; 10];
+///
+/// // When a task completes, `join_next` returns the task's key along
+/// // with its output.
+/// while let Some((key, res)) = map.join_next().await {
+/// seen[key] = true;
+/// assert!(res.is_ok(), "task {} completed successfully!", key);
+/// }
+///
+/// for i in 0..10 {
+/// assert!(seen[i]);
+/// }
+/// }
+/// ```
+///
+/// Cancel tasks based on their keys:
+///
+/// ```
+/// use tokio_util::task::JoinMap;
+///
+/// #[tokio::main]
+/// async fn main() {
+/// let mut map = JoinMap::new();
+///
+/// map.spawn("hello world", async move { /* ... */ });
+/// map.spawn("goodbye world", async move { /* ... */});
+///
+/// // Look up the "goodbye world" task in the map and abort it.
+/// let aborted = map.abort("goodbye world");
+///
+/// // `JoinMap::abort` returns `true` if a task existed for the
+/// // provided key.
+/// assert!(aborted);
+///
+/// while let Some((key, res)) = map.join_next().await {
+/// if key == "goodbye world" {
+/// // The aborted task should complete with a cancelled `JoinError`.
+/// assert!(res.unwrap_err().is_cancelled());
+/// } else {
+/// // Other tasks should complete normally.
+/// assert!(res.is_ok());
+/// }
+/// }
+/// }
+/// ```
+///
+/// [`JoinSet`]: tokio::task::JoinSet
+/// [unstable]: tokio#unstable-features
+/// [abort]: fn@Self::abort
+/// [abort_matching]: fn@Self::abort_matching
+/// [contains]: fn@Self::contains_key
+#[cfg_attr(docsrs, doc(cfg(all(feature = "rt", tokio_unstable))))]
+pub struct JoinMap<K, V, S = RandomState> {
+ /// A map of the [`AbortHandle`]s of the tasks spawned on this `JoinMap`,
+ /// indexed by their keys and task IDs.
+ ///
+ /// The [`Key`] type contains both the task's `K`-typed key provided when
+ /// spawning tasks, and the task's IDs. The IDs are stored here to resolve
+ /// hash collisions when looking up tasks based on their pre-computed hash
+ /// (as stored in the `hashes_by_task` map).
+ tasks_by_key: HashMap<Key<K>, AbortHandle, S>,
+
+ /// A map from task IDs to the hash of the key associated with that task.
+ ///
+ /// This map is used to perform reverse lookups of tasks in the
+ /// `tasks_by_key` map based on their task IDs. When a task terminates, the
+ /// ID is provided to us by the `JoinSet`, so we can look up the hash value
+ /// of that task's key, and then remove it from the `tasks_by_key` map using
+ /// the raw hash code, resolving collisions by comparing task IDs.
+ hashes_by_task: HashMap<Id, u64, S>,
+
+ /// The [`JoinSet`] that awaits the completion of tasks spawned on this
+ /// `JoinMap`.
+ tasks: JoinSet<V>,
+}
+
+/// A [`JoinMap`] key.
+///
+/// This holds both a `K`-typed key (the actual key as seen by the user), _and_
+/// a task ID, so that hash collisions between `K`-typed keys can be resolved
+/// using either `K`'s `Eq` impl *or* by checking the task IDs.
+///
+/// This allows looking up a task using either an actual key (such as when the
+/// user queries the map with a key), *or* using a task ID and a hash (such as
+/// when removing completed tasks from the map).
+#[derive(Debug)]
+struct Key<K> {
+ key: K,
+ id: Id,
+}
+
+impl<K, V> JoinMap<K, V> {
+ /// Creates a new empty `JoinMap`.
+ ///
+ /// The `JoinMap` is initially created with a capacity of 0, so it will not
+ /// allocate until a task is first spawned on it.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ /// let map: JoinMap<&str, i32> = JoinMap::new();
+ /// ```
+ #[inline]
+ #[must_use]
+ pub fn new() -> Self {
+ Self::with_hasher(RandomState::new())
+ }
+
+ /// Creates an empty `JoinMap` with the specified capacity.
+ ///
+ /// The `JoinMap` will be able to hold at least `capacity` tasks without
+ /// reallocating.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ /// let map: JoinMap<&str, i32> = JoinMap::with_capacity(10);
+ /// ```
+ #[inline]
+ #[must_use]
+ pub fn with_capacity(capacity: usize) -> Self {
+ JoinMap::with_capacity_and_hasher(capacity, Default::default())
+ }
+}
+
+impl<K, V, S: Clone> JoinMap<K, V, S> {
+ /// Creates an empty `JoinMap` which will use the given hash builder to hash
+ /// keys.
+ ///
+ /// The created map has the default initial capacity.
+ ///
+ /// Warning: `hash_builder` is normally randomly generated, and
+ /// is designed to allow `JoinMap` to be resistant to attacks that
+ /// cause many collisions and very poor performance. Setting it
+ /// manually using this function can expose a DoS attack vector.
+ ///
+ /// The `hash_builder` passed should implement the [`BuildHasher`] trait for
+ /// the `JoinMap` to be useful, see its documentation for details.
+ #[inline]
+ #[must_use]
+ pub fn with_hasher(hash_builder: S) -> Self {
+ Self::with_capacity_and_hasher(0, hash_builder)
+ }
+
+ /// Creates an empty `JoinMap` with the specified capacity, using `hash_builder`
+ /// to hash the keys.
+ ///
+ /// The `JoinMap` will be able to hold at least `capacity` elements without
+ /// reallocating. If `capacity` is 0, the `JoinMap` will not allocate.
+ ///
+ /// Warning: `hash_builder` is normally randomly generated, and
+ /// is designed to allow HashMaps to be resistant to attacks that
+ /// cause many collisions and very poor performance. Setting it
+ /// manually using this function can expose a DoS attack vector.
+ ///
+ /// The `hash_builder` passed should implement the [`BuildHasher`] trait for
+ /// the `JoinMap`to be useful, see its documentation for details.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// use tokio_util::task::JoinMap;
+ /// use std::collections::hash_map::RandomState;
+ ///
+ /// let s = RandomState::new();
+ /// let mut map = JoinMap::with_capacity_and_hasher(10, s);
+ /// map.spawn(1, async move { "hello world!" });
+ /// # }
+ /// ```
+ #[inline]
+ #[must_use]
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ Self {
+ tasks_by_key: HashMap::with_capacity_and_hasher(capacity, hash_builder.clone()),
+ hashes_by_task: HashMap::with_capacity_and_hasher(capacity, hash_builder),
+ tasks: JoinSet::new(),
+ }
+ }
+
+ /// Returns the number of tasks currently in the `JoinMap`.
+ pub fn len(&self) -> usize {
+ let len = self.tasks_by_key.len();
+ debug_assert_eq!(len, self.hashes_by_task.len());
+ len
+ }
+
+ /// Returns whether the `JoinMap` is empty.
+ pub fn is_empty(&self) -> bool {
+ let empty = self.tasks_by_key.is_empty();
+ debug_assert_eq!(empty, self.hashes_by_task.is_empty());
+ empty
+ }
+
+ /// Returns the number of tasks the map can hold without reallocating.
+ ///
+ /// This number is a lower bound; the `JoinMap` might be able to hold
+ /// more, but is guaranteed to be able to hold at least this many.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// let map: JoinMap<i32, i32> = JoinMap::with_capacity(100);
+ /// assert!(map.capacity() >= 100);
+ /// ```
+ #[inline]
+ pub fn capacity(&self) -> usize {
+ let capacity = self.tasks_by_key.capacity();
+ debug_assert_eq!(capacity, self.hashes_by_task.capacity());
+ capacity
+ }
+}
+
+impl<K, V, S> JoinMap<K, V, S>
+where
+ K: Hash + Eq,
+ V: 'static,
+ S: BuildHasher,
+{
+ /// Spawn the provided task and store it in this `JoinMap` with the provided
+ /// key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// # Panics
+ ///
+ /// This method panics if called outside of a Tokio runtime.
+ ///
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn<F>(&mut self, key: K, task: F)
+ where
+ F: Future<Output = V>,
+ F: Send + 'static,
+ V: Send,
+ {
+ let task = self.tasks.spawn(task);
+ self.insert(key, task)
+ }
+
+ /// Spawn the provided task on the provided runtime and store it in this
+ /// `JoinMap` with the provided key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn_on<F>(&mut self, key: K, task: F, handle: &Handle)
+ where
+ F: Future<Output = V>,
+ F: Send + 'static,
+ V: Send,
+ {
+ let task = self.tasks.spawn_on(task, handle);
+ self.insert(key, task);
+ }
+
+ /// Spawn the blocking code on the blocking threadpool and store it in this `JoinMap` with the provided
+ /// key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// Note that blocking tasks cannot be cancelled after execution starts.
+ /// Replaced blocking tasks will still run to completion if the task has begun
+ /// to execute when it is replaced. A blocking task which is replaced before
+ /// it has been scheduled on a blocking worker thread will be cancelled.
+ ///
+ /// # Panics
+ ///
+ /// This method panics if called outside of a Tokio runtime.
+ ///
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn_blocking<F>(&mut self, key: K, f: F)
+ where
+ F: FnOnce() -> V,
+ F: Send + 'static,
+ V: Send,
+ {
+ let task = self.tasks.spawn_blocking(f);
+ self.insert(key, task)
+ }
+
+ /// Spawn the blocking code on the blocking threadpool of the provided runtime and store it in this
+ /// `JoinMap` with the provided key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// Note that blocking tasks cannot be cancelled after execution starts.
+ /// Replaced blocking tasks will still run to completion if the task has begun
+ /// to execute when it is replaced. A blocking task which is replaced before
+ /// it has been scheduled on a blocking worker thread will be cancelled.
+ ///
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn_blocking_on<F>(&mut self, key: K, f: F, handle: &Handle)
+ where
+ F: FnOnce() -> V,
+ F: Send + 'static,
+ V: Send,
+ {
+ let task = self.tasks.spawn_blocking_on(f, handle);
+ self.insert(key, task);
+ }
+
+ /// Spawn the provided task on the current [`LocalSet`] and store it in this
+ /// `JoinMap` with the provided key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// # Panics
+ ///
+ /// This method panics if it is called outside of a `LocalSet`.
+ ///
+ /// [`LocalSet`]: tokio::task::LocalSet
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn_local<F>(&mut self, key: K, task: F)
+ where
+ F: Future<Output = V>,
+ F: 'static,
+ {
+ let task = self.tasks.spawn_local(task);
+ self.insert(key, task);
+ }
+
+ /// Spawn the provided task on the provided [`LocalSet`] and store it in
+ /// this `JoinMap` with the provided key.
+ ///
+ /// If a task previously existed in the `JoinMap` for this key, that task
+ /// will be cancelled and replaced with the new one. The previous task will
+ /// be removed from the `JoinMap`; a subsequent call to [`join_next`] will
+ /// *not* return a cancelled [`JoinError`] for that task.
+ ///
+ /// [`LocalSet`]: tokio::task::LocalSet
+ /// [`join_next`]: Self::join_next
+ #[track_caller]
+ pub fn spawn_local_on<F>(&mut self, key: K, task: F, local_set: &LocalSet)
+ where
+ F: Future<Output = V>,
+ F: 'static,
+ {
+ let task = self.tasks.spawn_local_on(task, local_set);
+ self.insert(key, task)
+ }
+
+ fn insert(&mut self, key: K, abort: AbortHandle) {
+ let hash = self.hash(&key);
+ let id = abort.id();
+ let map_key = Key { id, key };
+
+ // Insert the new key into the map of tasks by keys.
+ let entry = self
+ .tasks_by_key
+ .raw_entry_mut()
+ .from_hash(hash, |k| k.key == map_key.key);
+ match entry {
+ RawEntryMut::Occupied(mut occ) => {
+ // There was a previous task spawned with the same key! Cancel
+ // that task, and remove its ID from the map of hashes by task IDs.
+ let Key { id: prev_id, .. } = occ.insert_key(map_key);
+ occ.insert(abort).abort();
+ let _prev_hash = self.hashes_by_task.remove(&prev_id);
+ debug_assert_eq!(Some(hash), _prev_hash);
+ }
+ RawEntryMut::Vacant(vac) => {
+ vac.insert(map_key, abort);
+ }
+ };
+
+ // Associate the key's hash with this task's ID, for looking up tasks by ID.
+ let _prev = self.hashes_by_task.insert(id, hash);
+ debug_assert!(_prev.is_none(), "no prior task should have had the same ID");
+ }
+
+ /// Waits until one of the tasks in the map completes and returns its
+ /// output, along with the key corresponding to that task.
+ ///
+ /// Returns `None` if the map is empty.
+ ///
+ /// # Cancel Safety
+ ///
+ /// This method is cancel safe. If `join_next` is used as the event in a [`tokio::select!`]
+ /// statement and some other branch completes first, it is guaranteed that no tasks were
+ /// removed from this `JoinMap`.
+ ///
+ /// # Returns
+ ///
+ /// This function returns:
+ ///
+ /// * `Some((key, Ok(value)))` if one of the tasks in this `JoinMap` has
+ /// completed. The `value` is the return value of that ask, and `key` is
+ /// the key associated with the task.
+ /// * `Some((key, Err(err))` if one of the tasks in this JoinMap` has
+ /// panicked or been aborted. `key` is the key associated with the task
+ /// that panicked or was aborted.
+ /// * `None` if the `JoinMap` is empty.
+ ///
+ /// [`tokio::select!`]: tokio::select
+ pub async fn join_next(&mut self) -> Option<(K, Result<V, JoinError>)> {
+ let (res, id) = match self.tasks.join_next_with_id().await {
+ Some(Ok((id, output))) => (Ok(output), id),
+ Some(Err(e)) => {
+ let id = e.id();
+ (Err(e), id)
+ }
+ None => return None,
+ };
+ let key = self.remove_by_id(id)?;
+ Some((key, res))
+ }
+
+ /// Aborts all tasks and waits for them to finish shutting down.
+ ///
+ /// Calling this method is equivalent to calling [`abort_all`] and then calling [`join_next`] in
+ /// a loop until it returns `None`.
+ ///
+ /// This method ignores any panics in the tasks shutting down. When this call returns, the
+ /// `JoinMap` will be empty.
+ ///
+ /// [`abort_all`]: fn@Self::abort_all
+ /// [`join_next`]: fn@Self::join_next
+ pub async fn shutdown(&mut self) {
+ self.abort_all();
+ while self.join_next().await.is_some() {}
+ }
+
+ /// Abort the task corresponding to the provided `key`.
+ ///
+ /// If this `JoinMap` contains a task corresponding to `key`, this method
+ /// will abort that task and return `true`. Otherwise, if no task exists for
+ /// `key`, this method returns `false`.
+ ///
+ /// # Examples
+ ///
+ /// Aborting a task by key:
+ ///
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut map = JoinMap::new();
+ ///
+ /// map.spawn("hello world", async move { /* ... */ });
+ /// map.spawn("goodbye world", async move { /* ... */});
+ ///
+ /// // Look up the "goodbye world" task in the map and abort it.
+ /// map.abort("goodbye world");
+ ///
+ /// while let Some((key, res)) = map.join_next().await {
+ /// if key == "goodbye world" {
+ /// // The aborted task should complete with a cancelled `JoinError`.
+ /// assert!(res.unwrap_err().is_cancelled());
+ /// } else {
+ /// // Other tasks should complete normally.
+ /// assert!(res.is_ok());
+ /// }
+ /// }
+ /// # }
+ /// ```
+ ///
+ /// `abort` returns `true` if a task was aborted:
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut map = JoinMap::new();
+ ///
+ /// map.spawn("hello world", async move { /* ... */ });
+ /// map.spawn("goodbye world", async move { /* ... */});
+ ///
+ /// // A task for the key "goodbye world" should exist in the map:
+ /// assert!(map.abort("goodbye world"));
+ ///
+ /// // Aborting a key that does not exist will return `false`:
+ /// assert!(!map.abort("goodbye universe"));
+ /// # }
+ /// ```
+ pub fn abort<Q: ?Sized>(&mut self, key: &Q) -> bool
+ where
+ Q: Hash + Eq,
+ K: Borrow<Q>,
+ {
+ match self.get_by_key(key) {
+ Some((_, handle)) => {
+ handle.abort();
+ true
+ }
+ None => false,
+ }
+ }
+
+ /// Aborts all tasks with keys matching `predicate`.
+ ///
+ /// `predicate` is a function called with a reference to each key in the
+ /// map. If it returns `true` for a given key, the corresponding task will
+ /// be cancelled.
+ ///
+ /// # Examples
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// # // use the current thread rt so that spawned tasks don't
+ /// # // complete in the background before they can be aborted.
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// # async fn main() {
+ /// let mut map = JoinMap::new();
+ ///
+ /// map.spawn("hello world", async move {
+ /// // ...
+ /// # tokio::task::yield_now().await; // don't complete immediately, get aborted!
+ /// });
+ /// map.spawn("goodbye world", async move {
+ /// // ...
+ /// # tokio::task::yield_now().await; // don't complete immediately, get aborted!
+ /// });
+ /// map.spawn("hello san francisco", async move {
+ /// // ...
+ /// # tokio::task::yield_now().await; // don't complete immediately, get aborted!
+ /// });
+ /// map.spawn("goodbye universe", async move {
+ /// // ...
+ /// # tokio::task::yield_now().await; // don't complete immediately, get aborted!
+ /// });
+ ///
+ /// // Abort all tasks whose keys begin with "goodbye"
+ /// map.abort_matching(|key| key.starts_with("goodbye"));
+ ///
+ /// let mut seen = 0;
+ /// while let Some((key, res)) = map.join_next().await {
+ /// seen += 1;
+ /// if key.starts_with("goodbye") {
+ /// // The aborted task should complete with a cancelled `JoinError`.
+ /// assert!(res.unwrap_err().is_cancelled());
+ /// } else {
+ /// // Other tasks should complete normally.
+ /// assert!(key.starts_with("hello"));
+ /// assert!(res.is_ok());
+ /// }
+ /// }
+ ///
+ /// // All spawned tasks should have completed.
+ /// assert_eq!(seen, 4);
+ /// # }
+ /// ```
+ pub fn abort_matching(&mut self, mut predicate: impl FnMut(&K) -> bool) {
+ // Note: this method iterates over the tasks and keys *without* removing
+ // any entries, so that the keys from aborted tasks can still be
+ // returned when calling `join_next` in the future.
+ for (Key { ref key, .. }, task) in &self.tasks_by_key {
+ if predicate(key) {
+ task.abort();
+ }
+ }
+ }
+
+ /// Returns an iterator visiting all keys in this `JoinMap` in arbitrary order.
+ ///
+ /// If a task has completed, but its output hasn't yet been consumed by a
+ /// call to [`join_next`], this method will still return its key.
+ ///
+ /// [`join_next`]: fn@Self::join_next
+ pub fn keys(&self) -> JoinMapKeys<'_, K, V> {
+ JoinMapKeys {
+ iter: self.tasks_by_key.keys(),
+ _value: PhantomData,
+ }
+ }
+
+ /// Returns `true` if this `JoinMap` contains a task for the provided key.
+ ///
+ /// If the task has completed, but its output hasn't yet been consumed by a
+ /// call to [`join_next`], this method will still return `true`.
+ ///
+ /// [`join_next`]: fn@Self::join_next
+ pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool
+ where
+ Q: Hash + Eq,
+ K: Borrow<Q>,
+ {
+ self.get_by_key(key).is_some()
+ }
+
+ /// Returns `true` if this `JoinMap` contains a task with the provided
+ /// [task ID].
+ ///
+ /// If the task has completed, but its output hasn't yet been consumed by a
+ /// call to [`join_next`], this method will still return `true`.
+ ///
+ /// [`join_next`]: fn@Self::join_next
+ /// [task ID]: tokio::task::Id
+ pub fn contains_task(&self, task: &Id) -> bool {
+ self.get_by_id(task).is_some()
+ }
+
+ /// Reserves capacity for at least `additional` more tasks to be spawned
+ /// on this `JoinMap` without reallocating for the map of task keys. The
+ /// collection may reserve more space to avoid frequent reallocations.
+ ///
+ /// Note that spawning a task will still cause an allocation for the task
+ /// itself.
+ ///
+ /// # Panics
+ ///
+ /// Panics if the new allocation size overflows [`usize`].
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// let mut map: JoinMap<&str, i32> = JoinMap::new();
+ /// map.reserve(10);
+ /// ```
+ #[inline]
+ pub fn reserve(&mut self, additional: usize) {
+ self.tasks_by_key.reserve(additional);
+ self.hashes_by_task.reserve(additional);
+ }
+
+ /// Shrinks the capacity of the `JoinMap` as much as possible. It will drop
+ /// down as much as possible while maintaining the internal rules
+ /// and possibly leaving some space in accordance with the resize policy.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// let mut map: JoinMap<i32, i32> = JoinMap::with_capacity(100);
+ /// map.spawn(1, async move { 2 });
+ /// map.spawn(3, async move { 4 });
+ /// assert!(map.capacity() >= 100);
+ /// map.shrink_to_fit();
+ /// assert!(map.capacity() >= 2);
+ /// # }
+ /// ```
+ #[inline]
+ pub fn shrink_to_fit(&mut self) {
+ self.hashes_by_task.shrink_to_fit();
+ self.tasks_by_key.shrink_to_fit();
+ }
+
+ /// Shrinks the capacity of the map with a lower limit. It will drop
+ /// down no lower than the supplied limit while maintaining the internal rules
+ /// and possibly leaving some space in accordance with the resize policy.
+ ///
+ /// If the current capacity is less than the lower limit, this is a no-op.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// use tokio_util::task::JoinMap;
+ ///
+ /// let mut map: JoinMap<i32, i32> = JoinMap::with_capacity(100);
+ /// map.spawn(1, async move { 2 });
+ /// map.spawn(3, async move { 4 });
+ /// assert!(map.capacity() >= 100);
+ /// map.shrink_to(10);
+ /// assert!(map.capacity() >= 10);
+ /// map.shrink_to(0);
+ /// assert!(map.capacity() >= 2);
+ /// # }
+ /// ```
+ #[inline]
+ pub fn shrink_to(&mut self, min_capacity: usize) {
+ self.hashes_by_task.shrink_to(min_capacity);
+ self.tasks_by_key.shrink_to(min_capacity)
+ }
+
+ /// Look up a task in the map by its key, returning the key and abort handle.
+ fn get_by_key<'map, Q: ?Sized>(&'map self, key: &Q) -> Option<(&'map Key<K>, &'map AbortHandle)>
+ where
+ Q: Hash + Eq,
+ K: Borrow<Q>,
+ {
+ let hash = self.hash(key);
+ self.tasks_by_key
+ .raw_entry()
+ .from_hash(hash, |k| k.key.borrow() == key)
+ }
+
+ /// Look up a task in the map by its task ID, returning the key and abort handle.
+ fn get_by_id<'map>(&'map self, id: &Id) -> Option<(&'map Key<K>, &'map AbortHandle)> {
+ let hash = self.hashes_by_task.get(id)?;
+ self.tasks_by_key
+ .raw_entry()
+ .from_hash(*hash, |k| &k.id == id)
+ }
+
+ /// Remove a task from the map by ID, returning the key for that task.
+ fn remove_by_id(&mut self, id: Id) -> Option<K> {
+ // Get the hash for the given ID.
+ let hash = self.hashes_by_task.remove(&id)?;
+
+ // Remove the entry for that hash.
+ let entry = self
+ .tasks_by_key
+ .raw_entry_mut()
+ .from_hash(hash, |k| k.id == id);
+ let (Key { id: _key_id, key }, handle) = match entry {
+ RawEntryMut::Occupied(entry) => entry.remove_entry(),
+ _ => return None,
+ };
+ debug_assert_eq!(_key_id, id);
+ debug_assert_eq!(id, handle.id());
+ self.hashes_by_task.remove(&id);
+ Some(key)
+ }
+
+ /// Returns the hash for a given key.
+ #[inline]
+ fn hash<Q: ?Sized>(&self, key: &Q) -> u64
+ where
+ Q: Hash,
+ {
+ let mut hasher = self.tasks_by_key.hasher().build_hasher();
+ key.hash(&mut hasher);
+ hasher.finish()
+ }
+}
+
+impl<K, V, S> JoinMap<K, V, S>
+where
+ V: 'static,
+{
+ /// Aborts all tasks on this `JoinMap`.
+ ///
+ /// This does not remove the tasks from the `JoinMap`. To wait for the tasks to complete
+ /// cancellation, you should call `join_next` in a loop until the `JoinMap` is empty.
+ pub fn abort_all(&mut self) {
+ self.tasks.abort_all()
+ }
+
+ /// Removes all tasks from this `JoinMap` without aborting them.
+ ///
+ /// The tasks removed by this call will continue to run in the background even if the `JoinMap`
+ /// is dropped. They may still be aborted by key.
+ pub fn detach_all(&mut self) {
+ self.tasks.detach_all();
+ self.tasks_by_key.clear();
+ self.hashes_by_task.clear();
+ }
+}
+
+// Hand-written `fmt::Debug` implementation in order to avoid requiring `V:
+// Debug`, since no value is ever actually stored in the map.
+impl<K: fmt::Debug, V, S> fmt::Debug for JoinMap<K, V, S> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // format the task keys and abort handles a little nicer by just
+ // printing the key and task ID pairs, without format the `Key` struct
+ // itself or the `AbortHandle`, which would just format the task's ID
+ // again.
+ struct KeySet<'a, K: fmt::Debug, S>(&'a HashMap<Key<K>, AbortHandle, S>);
+ impl<K: fmt::Debug, S> fmt::Debug for KeySet<'_, K, S> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_map()
+ .entries(self.0.keys().map(|Key { key, id }| (key, id)))
+ .finish()
+ }
+ }
+
+ f.debug_struct("JoinMap")
+ // The `tasks_by_key` map is the only one that contains information
+ // that's really worth formatting for the user, since it contains
+ // the tasks' keys and IDs. The other fields are basically
+ // implementation details.
+ .field("tasks", &KeySet(&self.tasks_by_key))
+ .finish()
+ }
+}
+
+impl<K, V> Default for JoinMap<K, V> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+// === impl Key ===
+
+impl<K: Hash> Hash for Key<K> {
+ // Don't include the task ID in the hash.
+ #[inline]
+ fn hash<H: Hasher>(&self, hasher: &mut H) {
+ self.key.hash(hasher);
+ }
+}
+
+// Because we override `Hash` for this type, we must also override the
+// `PartialEq` impl, so that all instances with the same hash are equal.
+impl<K: PartialEq> PartialEq for Key<K> {
+ #[inline]
+ fn eq(&self, other: &Self) -> bool {
+ self.key == other.key
+ }
+}
+
+impl<K: Eq> Eq for Key<K> {}
+
+/// An iterator over the keys of a [`JoinMap`].
+#[derive(Debug, Clone)]
+pub struct JoinMapKeys<'a, K, V> {
+ iter: hashbrown::hash_map::Keys<'a, Key<K>, AbortHandle>,
+ /// To make it easier to change JoinMap in the future, keep V as a generic
+ /// parameter.
+ _value: PhantomData<&'a V>,
+}
+
+impl<'a, K, V> Iterator for JoinMapKeys<'a, K, V> {
+ type Item = &'a K;
+
+ fn next(&mut self) -> Option<&'a K> {
+ self.iter.next().map(|key| &key.key)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.iter.size_hint()
+ }
+}
+
+impl<'a, K, V> ExactSizeIterator for JoinMapKeys<'a, K, V> {
+ fn len(&self) -> usize {
+ self.iter.len()
+ }
+}
+
+impl<'a, K, V> std::iter::FusedIterator for JoinMapKeys<'a, K, V> {}
diff --git a/crates/tokio-util/src/task/mod.rs b/crates/tokio-util/src/task/mod.rs
new file mode 100644
index 0000000..e37015a
--- /dev/null
+++ b/crates/tokio-util/src/task/mod.rs
@@ -0,0 +1,15 @@
+//! Extra utilities for spawning tasks
+
+#[cfg(tokio_unstable)]
+mod join_map;
+#[cfg(not(target_os = "wasi"))]
+mod spawn_pinned;
+#[cfg(not(target_os = "wasi"))]
+pub use spawn_pinned::LocalPoolHandle;
+
+#[cfg(tokio_unstable)]
+#[cfg_attr(docsrs, doc(cfg(all(tokio_unstable, feature = "rt"))))]
+pub use join_map::{JoinMap, JoinMapKeys};
+
+pub mod task_tracker;
+pub use task_tracker::TaskTracker;
diff --git a/crates/tokio-util/src/task/spawn_pinned.rs b/crates/tokio-util/src/task/spawn_pinned.rs
new file mode 100644
index 0000000..b4102ec
--- /dev/null
+++ b/crates/tokio-util/src/task/spawn_pinned.rs
@@ -0,0 +1,436 @@
+use futures_util::future::{AbortHandle, Abortable};
+use std::fmt;
+use std::fmt::{Debug, Formatter};
+use std::future::Future;
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::sync::Arc;
+use tokio::runtime::Builder;
+use tokio::sync::mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender};
+use tokio::sync::oneshot;
+use tokio::task::{spawn_local, JoinHandle, LocalSet};
+
+/// A cloneable handle to a local pool, used for spawning `!Send` tasks.
+///
+/// Internally the local pool uses a [`tokio::task::LocalSet`] for each worker thread
+/// in the pool. Consequently you can also use [`tokio::task::spawn_local`] (which will
+/// execute on the same thread) inside the Future you supply to the various spawn methods
+/// of `LocalPoolHandle`,
+///
+/// [`tokio::task::LocalSet`]: tokio::task::LocalSet
+/// [`tokio::task::spawn_local`]: tokio::task::spawn_local
+///
+/// # Examples
+///
+/// ```
+/// use std::rc::Rc;
+/// use tokio::{self, task };
+/// use tokio_util::task::LocalPoolHandle;
+///
+/// #[tokio::main(flavor = "current_thread")]
+/// async fn main() {
+/// let pool = LocalPoolHandle::new(5);
+///
+/// let output = pool.spawn_pinned(|| {
+/// // `data` is !Send + !Sync
+/// let data = Rc::new("local data");
+/// let data_clone = data.clone();
+///
+/// async move {
+/// task::spawn_local(async move {
+/// println!("{}", data_clone);
+/// });
+///
+/// data.to_string()
+/// }
+/// }).await.unwrap();
+/// println!("output: {}", output);
+/// }
+/// ```
+///
+#[derive(Clone)]
+pub struct LocalPoolHandle {
+ pool: Arc<LocalPool>,
+}
+
+impl LocalPoolHandle {
+ /// Create a new pool of threads to handle `!Send` tasks. Spawn tasks onto this
+ /// pool via [`LocalPoolHandle::spawn_pinned`].
+ ///
+ /// # Panics
+ ///
+ /// Panics if the pool size is less than one.
+ #[track_caller]
+ pub fn new(pool_size: usize) -> LocalPoolHandle {
+ assert!(pool_size > 0);
+
+ let workers = (0..pool_size)
+ .map(|_| LocalWorkerHandle::new_worker())
+ .collect();
+
+ let pool = Arc::new(LocalPool { workers });
+
+ LocalPoolHandle { pool }
+ }
+
+ /// Returns the number of threads of the Pool.
+ #[inline]
+ pub fn num_threads(&self) -> usize {
+ self.pool.workers.len()
+ }
+
+ /// Returns the number of tasks scheduled on each worker. The indices of the
+ /// worker threads correspond to the indices of the returned `Vec`.
+ pub fn get_task_loads_for_each_worker(&self) -> Vec<usize> {
+ self.pool
+ .workers
+ .iter()
+ .map(|worker| worker.task_count.load(Ordering::SeqCst))
+ .collect::<Vec<_>>()
+ }
+
+ /// Spawn a task onto a worker thread and pin it there so it can't be moved
+ /// off of the thread. Note that the future is not [`Send`], but the
+ /// [`FnOnce`] which creates it is.
+ ///
+ /// # Examples
+ /// ```
+ /// use std::rc::Rc;
+ /// use tokio_util::task::LocalPoolHandle;
+ ///
+ /// #[tokio::main]
+ /// async fn main() {
+ /// // Create the local pool
+ /// let pool = LocalPoolHandle::new(1);
+ ///
+ /// // Spawn a !Send future onto the pool and await it
+ /// let output = pool
+ /// .spawn_pinned(|| {
+ /// // Rc is !Send + !Sync
+ /// let local_data = Rc::new("test");
+ ///
+ /// // This future holds an Rc, so it is !Send
+ /// async move { local_data.to_string() }
+ /// })
+ /// .await
+ /// .unwrap();
+ ///
+ /// assert_eq!(output, "test");
+ /// }
+ /// ```
+ pub fn spawn_pinned<F, Fut>(&self, create_task: F) -> JoinHandle<Fut::Output>
+ where
+ F: FnOnce() -> Fut,
+ F: Send + 'static,
+ Fut: Future + 'static,
+ Fut::Output: Send + 'static,
+ {
+ self.pool
+ .spawn_pinned(create_task, WorkerChoice::LeastBurdened)
+ }
+
+ /// Differs from `spawn_pinned` only in that you can choose a specific worker thread
+ /// of the pool, whereas `spawn_pinned` chooses the worker with the smallest
+ /// number of tasks scheduled.
+ ///
+ /// A worker thread is chosen by index. Indices are 0 based and the largest index
+ /// is given by `num_threads() - 1`
+ ///
+ /// # Panics
+ ///
+ /// This method panics if the index is out of bounds.
+ ///
+ /// # Examples
+ ///
+ /// This method can be used to spawn a task on all worker threads of the pool:
+ ///
+ /// ```
+ /// use tokio_util::task::LocalPoolHandle;
+ ///
+ /// #[tokio::main]
+ /// async fn main() {
+ /// const NUM_WORKERS: usize = 3;
+ /// let pool = LocalPoolHandle::new(NUM_WORKERS);
+ /// let handles = (0..pool.num_threads())
+ /// .map(|worker_idx| {
+ /// pool.spawn_pinned_by_idx(
+ /// || {
+ /// async {
+ /// "test"
+ /// }
+ /// },
+ /// worker_idx,
+ /// )
+ /// })
+ /// .collect::<Vec<_>>();
+ ///
+ /// for handle in handles {
+ /// handle.await.unwrap();
+ /// }
+ /// }
+ /// ```
+ ///
+ #[track_caller]
+ pub fn spawn_pinned_by_idx<F, Fut>(&self, create_task: F, idx: usize) -> JoinHandle<Fut::Output>
+ where
+ F: FnOnce() -> Fut,
+ F: Send + 'static,
+ Fut: Future + 'static,
+ Fut::Output: Send + 'static,
+ {
+ self.pool
+ .spawn_pinned(create_task, WorkerChoice::ByIdx(idx))
+ }
+}
+
+impl Debug for LocalPoolHandle {
+ fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+ f.write_str("LocalPoolHandle")
+ }
+}
+
+enum WorkerChoice {
+ LeastBurdened,
+ ByIdx(usize),
+}
+
+struct LocalPool {
+ workers: Vec<LocalWorkerHandle>,
+}
+
+impl LocalPool {
+ /// Spawn a `?Send` future onto a worker
+ #[track_caller]
+ fn spawn_pinned<F, Fut>(
+ &self,
+ create_task: F,
+ worker_choice: WorkerChoice,
+ ) -> JoinHandle<Fut::Output>
+ where
+ F: FnOnce() -> Fut,
+ F: Send + 'static,
+ Fut: Future + 'static,
+ Fut::Output: Send + 'static,
+ {
+ let (sender, receiver) = oneshot::channel();
+ let (worker, job_guard) = match worker_choice {
+ WorkerChoice::LeastBurdened => self.find_and_incr_least_burdened_worker(),
+ WorkerChoice::ByIdx(idx) => self.find_worker_by_idx(idx),
+ };
+ let worker_spawner = worker.spawner.clone();
+
+ // Spawn a future onto the worker's runtime so we can immediately return
+ // a join handle.
+ worker.runtime_handle.spawn(async move {
+ // Move the job guard into the task
+ let _job_guard = job_guard;
+
+ // Propagate aborts via Abortable/AbortHandle
+ let (abort_handle, abort_registration) = AbortHandle::new_pair();
+ let _abort_guard = AbortGuard(abort_handle);
+
+ // Inside the future we can't run spawn_local yet because we're not
+ // in the context of a LocalSet. We need to send create_task to the
+ // LocalSet task for spawning.
+ let spawn_task = Box::new(move || {
+ // Once we're in the LocalSet context we can call spawn_local
+ let join_handle =
+ spawn_local(
+ async move { Abortable::new(create_task(), abort_registration).await },
+ );
+
+ // Send the join handle back to the spawner. If sending fails,
+ // we assume the parent task was canceled, so cancel this task
+ // as well.
+ if let Err(join_handle) = sender.send(join_handle) {
+ join_handle.abort()
+ }
+ });
+
+ // Send the callback to the LocalSet task
+ if let Err(e) = worker_spawner.send(spawn_task) {
+ // Propagate the error as a panic in the join handle.
+ panic!("Failed to send job to worker: {}", e);
+ }
+
+ // Wait for the task's join handle
+ let join_handle = match receiver.await {
+ Ok(handle) => handle,
+ Err(e) => {
+ // We sent the task successfully, but failed to get its
+ // join handle... We assume something happened to the worker
+ // and the task was not spawned. Propagate the error as a
+ // panic in the join handle.
+ panic!("Worker failed to send join handle: {}", e);
+ }
+ };
+
+ // Wait for the task to complete
+ let join_result = join_handle.await;
+
+ match join_result {
+ Ok(Ok(output)) => output,
+ Ok(Err(_)) => {
+ // Pinned task was aborted. But that only happens if this
+ // task is aborted. So this is an impossible branch.
+ unreachable!(
+ "Reaching this branch means this task was previously \
+ aborted but it continued running anyways"
+ )
+ }
+ Err(e) => {
+ if e.is_panic() {
+ std::panic::resume_unwind(e.into_panic());
+ } else if e.is_cancelled() {
+ // No one else should have the join handle, so this is
+ // unexpected. Forward this error as a panic in the join
+ // handle.
+ panic!("spawn_pinned task was canceled: {}", e);
+ } else {
+ // Something unknown happened (not a panic or
+ // cancellation). Forward this error as a panic in the
+ // join handle.
+ panic!("spawn_pinned task failed: {}", e);
+ }
+ }
+ }
+ })
+ }
+
+ /// Find the worker with the least number of tasks, increment its task
+ /// count, and return its handle. Make sure to actually spawn a task on
+ /// the worker so the task count is kept consistent with load.
+ ///
+ /// A job count guard is also returned to ensure the task count gets
+ /// decremented when the job is done.
+ fn find_and_incr_least_burdened_worker(&self) -> (&LocalWorkerHandle, JobCountGuard) {
+ loop {
+ let (worker, task_count) = self
+ .workers
+ .iter()
+ .map(|worker| (worker, worker.task_count.load(Ordering::SeqCst)))
+ .min_by_key(|&(_, count)| count)
+ .expect("There must be more than one worker");
+
+ // Make sure the task count hasn't changed since when we choose this
+ // worker. Otherwise, restart the search.
+ if worker
+ .task_count
+ .compare_exchange(
+ task_count,
+ task_count + 1,
+ Ordering::SeqCst,
+ Ordering::Relaxed,
+ )
+ .is_ok()
+ {
+ return (worker, JobCountGuard(Arc::clone(&worker.task_count)));
+ }
+ }
+ }
+
+ #[track_caller]
+ fn find_worker_by_idx(&self, idx: usize) -> (&LocalWorkerHandle, JobCountGuard) {
+ let worker = &self.workers[idx];
+ worker.task_count.fetch_add(1, Ordering::SeqCst);
+
+ (worker, JobCountGuard(Arc::clone(&worker.task_count)))
+ }
+}
+
+/// Automatically decrements a worker's job count when a job finishes (when
+/// this gets dropped).
+struct JobCountGuard(Arc<AtomicUsize>);
+
+impl Drop for JobCountGuard {
+ fn drop(&mut self) {
+ // Decrement the job count
+ let previous_value = self.0.fetch_sub(1, Ordering::SeqCst);
+ debug_assert!(previous_value >= 1);
+ }
+}
+
+/// Calls abort on the handle when dropped.
+struct AbortGuard(AbortHandle);
+
+impl Drop for AbortGuard {
+ fn drop(&mut self) {
+ self.0.abort();
+ }
+}
+
+type PinnedFutureSpawner = Box<dyn FnOnce() + Send + 'static>;
+
+struct LocalWorkerHandle {
+ runtime_handle: tokio::runtime::Handle,
+ spawner: UnboundedSender<PinnedFutureSpawner>,
+ task_count: Arc<AtomicUsize>,
+}
+
+impl LocalWorkerHandle {
+ /// Create a new worker for executing pinned tasks
+ fn new_worker() -> LocalWorkerHandle {
+ let (sender, receiver) = unbounded_channel();
+ let runtime = Builder::new_current_thread()
+ .enable_all()
+ .build()
+ .expect("Failed to start a pinned worker thread runtime");
+ let runtime_handle = runtime.handle().clone();
+ let task_count = Arc::new(AtomicUsize::new(0));
+ let task_count_clone = Arc::clone(&task_count);
+
+ std::thread::spawn(|| Self::run(runtime, receiver, task_count_clone));
+
+ LocalWorkerHandle {
+ runtime_handle,
+ spawner: sender,
+ task_count,
+ }
+ }
+
+ fn run(
+ runtime: tokio::runtime::Runtime,
+ mut task_receiver: UnboundedReceiver<PinnedFutureSpawner>,
+ task_count: Arc<AtomicUsize>,
+ ) {
+ let local_set = LocalSet::new();
+ local_set.block_on(&runtime, async {
+ while let Some(spawn_task) = task_receiver.recv().await {
+ // Calls spawn_local(future)
+ (spawn_task)();
+ }
+ });
+
+ // If there are any tasks on the runtime associated with a LocalSet task
+ // that has already completed, but whose output has not yet been
+ // reported, let that task complete.
+ //
+ // Since the task_count is decremented when the runtime task exits,
+ // reading that counter lets us know if any such tasks completed during
+ // the call to `block_on`.
+ //
+ // Tasks on the LocalSet can't complete during this loop since they're
+ // stored on the LocalSet and we aren't accessing it.
+ let mut previous_task_count = task_count.load(Ordering::SeqCst);
+ loop {
+ // This call will also run tasks spawned on the runtime.
+ runtime.block_on(tokio::task::yield_now());
+ let new_task_count = task_count.load(Ordering::SeqCst);
+ if new_task_count == previous_task_count {
+ break;
+ } else {
+ previous_task_count = new_task_count;
+ }
+ }
+
+ // It's now no longer possible for a task on the runtime to be
+ // associated with a LocalSet task that has completed. Drop both the
+ // LocalSet and runtime to let tasks on the runtime be cancelled if and
+ // only if they are still on the LocalSet.
+ //
+ // Drop the LocalSet task first so that anyone awaiting the runtime
+ // JoinHandle will see the cancelled error after the LocalSet task
+ // destructor has completed.
+ drop(local_set);
+ drop(runtime);
+ }
+}
diff --git a/crates/tokio-util/src/task/task_tracker.rs b/crates/tokio-util/src/task/task_tracker.rs
new file mode 100644
index 0000000..d8f3bb4
--- /dev/null
+++ b/crates/tokio-util/src/task/task_tracker.rs
@@ -0,0 +1,719 @@
+//! Types related to the [`TaskTracker`] collection.
+//!
+//! See the documentation of [`TaskTracker`] for more information.
+
+use pin_project_lite::pin_project;
+use std::fmt;
+use std::future::Future;
+use std::pin::Pin;
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::sync::Arc;
+use std::task::{Context, Poll};
+use tokio::sync::{futures::Notified, Notify};
+
+#[cfg(feature = "rt")]
+use tokio::{
+ runtime::Handle,
+ task::{JoinHandle, LocalSet},
+};
+
+/// A task tracker used for waiting until tasks exit.
+///
+/// This is usually used together with [`CancellationToken`] to implement [graceful shutdown]. The
+/// `CancellationToken` is used to signal to tasks that they should shut down, and the
+/// `TaskTracker` is used to wait for them to finish shutting down.
+///
+/// The `TaskTracker` will also keep track of a `closed` boolean. This is used to handle the case
+/// where the `TaskTracker` is empty, but we don't want to shut down yet. This means that the
+/// [`wait`] method will wait until *both* of the following happen at the same time:
+///
+/// * The `TaskTracker` must be closed using the [`close`] method.
+/// * The `TaskTracker` must be empty, that is, all tasks that it is tracking must have exited.
+///
+/// When a call to [`wait`] returns, it is guaranteed that all tracked tasks have exited and that
+/// the destructor of the future has finished running. However, there might be a short amount of
+/// time where [`JoinHandle::is_finished`] returns false.
+///
+/// # Comparison to `JoinSet`
+///
+/// The main Tokio crate has a similar collection known as [`JoinSet`]. The `JoinSet` type has a
+/// lot more features than `TaskTracker`, so `TaskTracker` should only be used when one of its
+/// unique features is required:
+///
+/// 1. When tasks exit, a `TaskTracker` will allow the task to immediately free its memory.
+/// 2. By not closing the `TaskTracker`, [`wait`] will be prevented from from returning even if
+/// the `TaskTracker` is empty.
+/// 3. A `TaskTracker` does not require mutable access to insert tasks.
+/// 4. A `TaskTracker` can be cloned to share it with many tasks.
+///
+/// The first point is the most important one. A [`JoinSet`] keeps track of the return value of
+/// every inserted task. This means that if the caller keeps inserting tasks and never calls
+/// [`join_next`], then their return values will keep building up and consuming memory, _even if_
+/// most of the tasks have already exited. This can cause the process to run out of memory. With a
+/// `TaskTracker`, this does not happen. Once tasks exit, they are immediately removed from the
+/// `TaskTracker`.
+///
+/// # Examples
+///
+/// For more examples, please see the topic page on [graceful shutdown].
+///
+/// ## Spawn tasks and wait for them to exit
+///
+/// This is a simple example. For this case, [`JoinSet`] should probably be used instead.
+///
+/// ```
+/// use tokio_util::task::TaskTracker;
+///
+/// #[tokio::main]
+/// async fn main() {
+/// let tracker = TaskTracker::new();
+///
+/// for i in 0..10 {
+/// tracker.spawn(async move {
+/// println!("Task {} is running!", i);
+/// });
+/// }
+/// // Once we spawned everything, we close the tracker.
+/// tracker.close();
+///
+/// // Wait for everything to finish.
+/// tracker.wait().await;
+///
+/// println!("This is printed after all of the tasks.");
+/// }
+/// ```
+///
+/// ## Wait for tasks to exit
+///
+/// This example shows the intended use-case of `TaskTracker`. It is used together with
+/// [`CancellationToken`] to implement graceful shutdown.
+/// ```
+/// use tokio_util::sync::CancellationToken;
+/// use tokio_util::task::TaskTracker;
+/// use tokio::time::{self, Duration};
+///
+/// async fn background_task(num: u64) {
+/// for i in 0..10 {
+/// time::sleep(Duration::from_millis(100*num)).await;
+/// println!("Background task {} in iteration {}.", num, i);
+/// }
+/// }
+///
+/// #[tokio::main]
+/// # async fn _hidden() {}
+/// # #[tokio::main(flavor = "current_thread", start_paused = true)]
+/// async fn main() {
+/// let tracker = TaskTracker::new();
+/// let token = CancellationToken::new();
+///
+/// for i in 0..10 {
+/// let token = token.clone();
+/// tracker.spawn(async move {
+/// // Use a `tokio::select!` to kill the background task if the token is
+/// // cancelled.
+/// tokio::select! {
+/// () = background_task(i) => {
+/// println!("Task {} exiting normally.", i);
+/// },
+/// () = token.cancelled() => {
+/// // Do some cleanup before we really exit.
+/// time::sleep(Duration::from_millis(50)).await;
+/// println!("Task {} finished cleanup.", i);
+/// },
+/// }
+/// });
+/// }
+///
+/// // Spawn a background task that will send the shutdown signal.
+/// {
+/// let tracker = tracker.clone();
+/// tokio::spawn(async move {
+/// // Normally you would use something like ctrl-c instead of
+/// // sleeping.
+/// time::sleep(Duration::from_secs(2)).await;
+/// tracker.close();
+/// token.cancel();
+/// });
+/// }
+///
+/// // Wait for all tasks to exit.
+/// tracker.wait().await;
+///
+/// println!("All tasks have exited now.");
+/// }
+/// ```
+///
+/// [`CancellationToken`]: crate::sync::CancellationToken
+/// [`JoinHandle::is_finished`]: tokio::task::JoinHandle::is_finished
+/// [`JoinSet`]: tokio::task::JoinSet
+/// [`close`]: Self::close
+/// [`join_next`]: tokio::task::JoinSet::join_next
+/// [`wait`]: Self::wait
+/// [graceful shutdown]: https://tokio.rs/tokio/topics/shutdown
+pub struct TaskTracker {
+ inner: Arc<TaskTrackerInner>,
+}
+
+/// Represents a task tracked by a [`TaskTracker`].
+#[must_use]
+#[derive(Debug)]
+pub struct TaskTrackerToken {
+ task_tracker: TaskTracker,
+}
+
+struct TaskTrackerInner {
+ /// Keeps track of the state.
+ ///
+ /// The lowest bit is whether the task tracker is closed.
+ ///
+ /// The rest of the bits count the number of tracked tasks.
+ state: AtomicUsize,
+ /// Used to notify when the last task exits.
+ on_last_exit: Notify,
+}
+
+pin_project! {
+ /// A future that is tracked as a task by a [`TaskTracker`].
+ ///
+ /// The associated [`TaskTracker`] cannot complete until this future is dropped.
+ ///
+ /// This future is returned by [`TaskTracker::track_future`].
+ #[must_use = "futures do nothing unless polled"]
+ pub struct TrackedFuture<F> {
+ #[pin]
+ future: F,
+ token: TaskTrackerToken,
+ }
+}
+
+pin_project! {
+ /// A future that completes when the [`TaskTracker`] is empty and closed.
+ ///
+ /// This future is returned by [`TaskTracker::wait`].
+ #[must_use = "futures do nothing unless polled"]
+ pub struct TaskTrackerWaitFuture<'a> {
+ #[pin]
+ future: Notified<'a>,
+ inner: Option<&'a TaskTrackerInner>,
+ }
+}
+
+impl TaskTrackerInner {
+ #[inline]
+ fn new() -> Self {
+ Self {
+ state: AtomicUsize::new(0),
+ on_last_exit: Notify::new(),
+ }
+ }
+
+ #[inline]
+ fn is_closed_and_empty(&self) -> bool {
+ // If empty and closed bit set, then we are done.
+ //
+ // The acquire load will synchronize with the release store of any previous call to
+ // `set_closed` and `drop_task`.
+ self.state.load(Ordering::Acquire) == 1
+ }
+
+ #[inline]
+ fn set_closed(&self) -> bool {
+ // The AcqRel ordering makes the closed bit behave like a `Mutex<bool>` for synchronization
+ // purposes. We do this because it makes the return value of `TaskTracker::{close,reopen}`
+ // more meaningful for the user. Without these orderings, this assert could fail:
+ // ```
+ // // thread 1
+ // some_other_atomic.store(true, Relaxed);
+ // tracker.close();
+ //
+ // // thread 2
+ // if tracker.reopen() {
+ // assert!(some_other_atomic.load(Relaxed));
+ // }
+ // ```
+ // However, with the AcqRel ordering, we establish a happens-before relationship from the
+ // call to `close` and the later call to `reopen` that returned true.
+ let state = self.state.fetch_or(1, Ordering::AcqRel);
+
+ // If there are no tasks, and if it was not already closed:
+ if state == 0 {
+ self.notify_now();
+ }
+
+ (state & 1) == 0
+ }
+
+ #[inline]
+ fn set_open(&self) -> bool {
+ // See `set_closed` regarding the AcqRel ordering.
+ let state = self.state.fetch_and(!1, Ordering::AcqRel);
+ (state & 1) == 1
+ }
+
+ #[inline]
+ fn add_task(&self) {
+ self.state.fetch_add(2, Ordering::Relaxed);
+ }
+
+ #[inline]
+ fn drop_task(&self) {
+ let state = self.state.fetch_sub(2, Ordering::Release);
+
+ // If this was the last task and we are closed:
+ if state == 3 {
+ self.notify_now();
+ }
+ }
+
+ #[cold]
+ fn notify_now(&self) {
+ // Insert an acquire fence. This matters for `drop_task` but doesn't matter for
+ // `set_closed` since it already uses AcqRel.
+ //
+ // This synchronizes with the release store of any other call to `drop_task`, and with the
+ // release store in the call to `set_closed`. That ensures that everything that happened
+ // before those other calls to `drop_task` or `set_closed` will be visible after this load,
+ // and those things will also be visible to anything woken by the call to `notify_waiters`.
+ self.state.load(Ordering::Acquire);
+
+ self.on_last_exit.notify_waiters();
+ }
+}
+
+impl TaskTracker {
+ /// Creates a new `TaskTracker`.
+ ///
+ /// The `TaskTracker` will start out as open.
+ #[must_use]
+ pub fn new() -> Self {
+ Self {
+ inner: Arc::new(TaskTrackerInner::new()),
+ }
+ }
+
+ /// Waits until this `TaskTracker` is both closed and empty.
+ ///
+ /// If the `TaskTracker` is already closed and empty when this method is called, then it
+ /// returns immediately.
+ ///
+ /// The `wait` future is resistant against [ABA problems][aba]. That is, if the `TaskTracker`
+ /// becomes both closed and empty for a short amount of time, then it is guarantee that all
+ /// `wait` futures that were created before the short time interval will trigger, even if they
+ /// are not polled during that short time interval.
+ ///
+ /// # Cancel safety
+ ///
+ /// This method is cancel safe.
+ ///
+ /// However, the resistance against [ABA problems][aba] is lost when using `wait` as the
+ /// condition in a `tokio::select!` loop.
+ ///
+ /// [aba]: https://en.wikipedia.org/wiki/ABA_problem
+ #[inline]
+ pub fn wait(&self) -> TaskTrackerWaitFuture<'_> {
+ TaskTrackerWaitFuture {
+ future: self.inner.on_last_exit.notified(),
+ inner: if self.inner.is_closed_and_empty() {
+ None
+ } else {
+ Some(&self.inner)
+ },
+ }
+ }
+
+ /// Close this `TaskTracker`.
+ ///
+ /// This allows [`wait`] futures to complete. It does not prevent you from spawning new tasks.
+ ///
+ /// Returns `true` if this closed the `TaskTracker`, or `false` if it was already closed.
+ ///
+ /// [`wait`]: Self::wait
+ #[inline]
+ pub fn close(&self) -> bool {
+ self.inner.set_closed()
+ }
+
+ /// Reopen this `TaskTracker`.
+ ///
+ /// This prevents [`wait`] futures from completing even if the `TaskTracker` is empty.
+ ///
+ /// Returns `true` if this reopened the `TaskTracker`, or `false` if it was already open.
+ ///
+ /// [`wait`]: Self::wait
+ #[inline]
+ pub fn reopen(&self) -> bool {
+ self.inner.set_open()
+ }
+
+ /// Returns `true` if this `TaskTracker` is [closed](Self::close).
+ #[inline]
+ #[must_use]
+ pub fn is_closed(&self) -> bool {
+ (self.inner.state.load(Ordering::Acquire) & 1) != 0
+ }
+
+ /// Returns the number of tasks tracked by this `TaskTracker`.
+ #[inline]
+ #[must_use]
+ pub fn len(&self) -> usize {
+ self.inner.state.load(Ordering::Acquire) >> 1
+ }
+
+ /// Returns `true` if there are no tasks in this `TaskTracker`.
+ #[inline]
+ #[must_use]
+ pub fn is_empty(&self) -> bool {
+ self.inner.state.load(Ordering::Acquire) <= 1
+ }
+
+ /// Spawn the provided future on the current Tokio runtime, and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `tokio::spawn(tracker.track_future(task))`.
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn<F>(&self, task: F) -> JoinHandle<F::Output>
+ where
+ F: Future + Send + 'static,
+ F::Output: Send + 'static,
+ {
+ tokio::task::spawn(self.track_future(task))
+ }
+
+ /// Spawn the provided future on the provided Tokio runtime, and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `handle.spawn(tracker.track_future(task))`.
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn_on<F>(&self, task: F, handle: &Handle) -> JoinHandle<F::Output>
+ where
+ F: Future + Send + 'static,
+ F::Output: Send + 'static,
+ {
+ handle.spawn(self.track_future(task))
+ }
+
+ /// Spawn the provided future on the current [`LocalSet`], and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `tokio::task::spawn_local(tracker.track_future(task))`.
+ ///
+ /// [`LocalSet`]: tokio::task::LocalSet
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn_local<F>(&self, task: F) -> JoinHandle<F::Output>
+ where
+ F: Future + 'static,
+ F::Output: 'static,
+ {
+ tokio::task::spawn_local(self.track_future(task))
+ }
+
+ /// Spawn the provided future on the provided [`LocalSet`], and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `local_set.spawn_local(tracker.track_future(task))`.
+ ///
+ /// [`LocalSet`]: tokio::task::LocalSet
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn_local_on<F>(&self, task: F, local_set: &LocalSet) -> JoinHandle<F::Output>
+ where
+ F: Future + 'static,
+ F::Output: 'static,
+ {
+ local_set.spawn_local(self.track_future(task))
+ }
+
+ /// Spawn the provided blocking task on the current Tokio runtime, and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `tokio::task::spawn_blocking(tracker.track_future(task))`.
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg(not(target_family = "wasm"))]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn_blocking<F, T>(&self, task: F) -> JoinHandle<T>
+ where
+ F: FnOnce() -> T,
+ F: Send + 'static,
+ T: Send + 'static,
+ {
+ let token = self.token();
+ tokio::task::spawn_blocking(move || {
+ let res = task();
+ drop(token);
+ res
+ })
+ }
+
+ /// Spawn the provided blocking task on the provided Tokio runtime, and track it in this `TaskTracker`.
+ ///
+ /// This is equivalent to `handle.spawn_blocking(tracker.track_future(task))`.
+ #[inline]
+ #[track_caller]
+ #[cfg(feature = "rt")]
+ #[cfg(not(target_family = "wasm"))]
+ #[cfg_attr(docsrs, doc(cfg(feature = "rt")))]
+ pub fn spawn_blocking_on<F, T>(&self, task: F, handle: &Handle) -> JoinHandle<T>
+ where
+ F: FnOnce() -> T,
+ F: Send + 'static,
+ T: Send + 'static,
+ {
+ let token = self.token();
+ handle.spawn_blocking(move || {
+ let res = task();
+ drop(token);
+ res
+ })
+ }
+
+ /// Track the provided future.
+ ///
+ /// The returned [`TrackedFuture`] will count as a task tracked by this collection, and will
+ /// prevent calls to [`wait`] from returning until the task is dropped.
+ ///
+ /// The task is removed from the collection when it is dropped, not when [`poll`] returns
+ /// [`Poll::Ready`].
+ ///
+ /// # Examples
+ ///
+ /// Track a future spawned with [`tokio::spawn`].
+ ///
+ /// ```
+ /// # async fn my_async_fn() {}
+ /// use tokio_util::task::TaskTracker;
+ ///
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// # async fn main() {
+ /// let tracker = TaskTracker::new();
+ ///
+ /// tokio::spawn(tracker.track_future(my_async_fn()));
+ /// # }
+ /// ```
+ ///
+ /// Track a future spawned on a [`JoinSet`].
+ /// ```
+ /// # async fn my_async_fn() {}
+ /// use tokio::task::JoinSet;
+ /// use tokio_util::task::TaskTracker;
+ ///
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// # async fn main() {
+ /// let tracker = TaskTracker::new();
+ /// let mut join_set = JoinSet::new();
+ ///
+ /// join_set.spawn(tracker.track_future(my_async_fn()));
+ /// # }
+ /// ```
+ ///
+ /// [`JoinSet`]: tokio::task::JoinSet
+ /// [`Poll::Pending`]: std::task::Poll::Pending
+ /// [`poll`]: std::future::Future::poll
+ /// [`wait`]: Self::wait
+ #[inline]
+ pub fn track_future<F: Future>(&self, future: F) -> TrackedFuture<F> {
+ TrackedFuture {
+ future,
+ token: self.token(),
+ }
+ }
+
+ /// Creates a [`TaskTrackerToken`] representing a task tracked by this `TaskTracker`.
+ ///
+ /// This token is a lower-level utility than the spawn methods. Each token is considered to
+ /// correspond to a task. As long as the token exists, the `TaskTracker` cannot complete.
+ /// Furthermore, the count returned by the [`len`] method will include the tokens in the count.
+ ///
+ /// Dropping the token indicates to the `TaskTracker` that the task has exited.
+ ///
+ /// [`len`]: TaskTracker::len
+ #[inline]
+ pub fn token(&self) -> TaskTrackerToken {
+ self.inner.add_task();
+ TaskTrackerToken {
+ task_tracker: self.clone(),
+ }
+ }
+
+ /// Returns `true` if both task trackers correspond to the same set of tasks.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::TaskTracker;
+ ///
+ /// let tracker_1 = TaskTracker::new();
+ /// let tracker_2 = TaskTracker::new();
+ /// let tracker_1_clone = tracker_1.clone();
+ ///
+ /// assert!(TaskTracker::ptr_eq(&tracker_1, &tracker_1_clone));
+ /// assert!(!TaskTracker::ptr_eq(&tracker_1, &tracker_2));
+ /// ```
+ #[inline]
+ #[must_use]
+ pub fn ptr_eq(left: &TaskTracker, right: &TaskTracker) -> bool {
+ Arc::ptr_eq(&left.inner, &right.inner)
+ }
+}
+
+impl Default for TaskTracker {
+ /// Creates a new `TaskTracker`.
+ ///
+ /// The `TaskTracker` will start out as open.
+ #[inline]
+ fn default() -> TaskTracker {
+ TaskTracker::new()
+ }
+}
+
+impl Clone for TaskTracker {
+ /// Returns a new `TaskTracker` that tracks the same set of tasks.
+ ///
+ /// Since the new `TaskTracker` shares the same set of tasks, changes to one set are visible in
+ /// all other clones.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::task::TaskTracker;
+ ///
+ /// #[tokio::main]
+ /// # async fn _hidden() {}
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// async fn main() {
+ /// let tracker = TaskTracker::new();
+ /// let cloned = tracker.clone();
+ ///
+ /// // Spawns on `tracker` are visible in `cloned`.
+ /// tracker.spawn(std::future::pending::<()>());
+ /// assert_eq!(cloned.len(), 1);
+ ///
+ /// // Spawns on `cloned` are visible in `tracker`.
+ /// cloned.spawn(std::future::pending::<()>());
+ /// assert_eq!(tracker.len(), 2);
+ ///
+ /// // Calling `close` is visible to `cloned`.
+ /// tracker.close();
+ /// assert!(cloned.is_closed());
+ ///
+ /// // Calling `reopen` is visible to `tracker`.
+ /// cloned.reopen();
+ /// assert!(!tracker.is_closed());
+ /// }
+ /// ```
+ #[inline]
+ fn clone(&self) -> TaskTracker {
+ Self {
+ inner: self.inner.clone(),
+ }
+ }
+}
+
+fn debug_inner(inner: &TaskTrackerInner, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let state = inner.state.load(Ordering::Acquire);
+ let is_closed = (state & 1) != 0;
+ let len = state >> 1;
+
+ f.debug_struct("TaskTracker")
+ .field("len", &len)
+ .field("is_closed", &is_closed)
+ .field("inner", &(inner as *const TaskTrackerInner))
+ .finish()
+}
+
+impl fmt::Debug for TaskTracker {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ debug_inner(&self.inner, f)
+ }
+}
+
+impl TaskTrackerToken {
+ /// Returns the [`TaskTracker`] that this token is associated with.
+ #[inline]
+ #[must_use]
+ pub fn task_tracker(&self) -> &TaskTracker {
+ &self.task_tracker
+ }
+}
+
+impl Clone for TaskTrackerToken {
+ /// Returns a new `TaskTrackerToken` associated with the same [`TaskTracker`].
+ ///
+ /// This is equivalent to `token.task_tracker().token()`.
+ #[inline]
+ fn clone(&self) -> TaskTrackerToken {
+ self.task_tracker.token()
+ }
+}
+
+impl Drop for TaskTrackerToken {
+ /// Dropping the token indicates to the [`TaskTracker`] that the task has exited.
+ #[inline]
+ fn drop(&mut self) {
+ self.task_tracker.inner.drop_task();
+ }
+}
+
+impl<F: Future> Future for TrackedFuture<F> {
+ type Output = F::Output;
+
+ #[inline]
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<F::Output> {
+ self.project().future.poll(cx)
+ }
+}
+
+impl<F: fmt::Debug> fmt::Debug for TrackedFuture<F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("TrackedFuture")
+ .field("future", &self.future)
+ .field("task_tracker", self.token.task_tracker())
+ .finish()
+ }
+}
+
+impl<'a> Future for TaskTrackerWaitFuture<'a> {
+ type Output = ();
+
+ #[inline]
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
+ let me = self.project();
+
+ let inner = match me.inner.as_ref() {
+ None => return Poll::Ready(()),
+ Some(inner) => inner,
+ };
+
+ let ready = inner.is_closed_and_empty() || me.future.poll(cx).is_ready();
+ if ready {
+ *me.inner = None;
+ Poll::Ready(())
+ } else {
+ Poll::Pending
+ }
+ }
+}
+
+impl<'a> fmt::Debug for TaskTrackerWaitFuture<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ struct Helper<'a>(&'a TaskTrackerInner);
+
+ impl fmt::Debug for Helper<'_> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ debug_inner(self.0, f)
+ }
+ }
+
+ f.debug_struct("TaskTrackerWaitFuture")
+ .field("future", &self.future)
+ .field("task_tracker", &self.inner.map(Helper))
+ .finish()
+ }
+}
diff --git a/crates/tokio-util/src/time/delay_queue.rs b/crates/tokio-util/src/time/delay_queue.rs
new file mode 100644
index 0000000..9136d90
--- /dev/null
+++ b/crates/tokio-util/src/time/delay_queue.rs
@@ -0,0 +1,1310 @@
+//! A queue of delayed elements.
+//!
+//! See [`DelayQueue`] for more details.
+//!
+//! [`DelayQueue`]: struct@DelayQueue
+
+use crate::time::wheel::{self, Wheel};
+
+use futures_core::ready;
+use tokio::time::{sleep_until, Duration, Instant, Sleep};
+
+use core::ops::{Index, IndexMut};
+use slab::Slab;
+use std::cmp;
+use std::collections::HashMap;
+use std::convert::From;
+use std::fmt;
+use std::fmt::Debug;
+use std::future::Future;
+use std::marker::PhantomData;
+use std::pin::Pin;
+use std::task::{self, Poll, Waker};
+
+/// A queue of delayed elements.
+///
+/// Once an element is inserted into the `DelayQueue`, it is yielded once the
+/// specified deadline has been reached.
+///
+/// # Usage
+///
+/// Elements are inserted into `DelayQueue` using the [`insert`] or
+/// [`insert_at`] methods. A deadline is provided with the item and a [`Key`] is
+/// returned. The key is used to remove the entry or to change the deadline at
+/// which it should be yielded back.
+///
+/// Once delays have been configured, the `DelayQueue` is used via its
+/// [`Stream`] implementation. [`poll_expired`] is called. If an entry has reached its
+/// deadline, it is returned. If not, `Poll::Pending` is returned indicating that the
+/// current task will be notified once the deadline has been reached.
+///
+/// # `Stream` implementation
+///
+/// Items are retrieved from the queue via [`DelayQueue::poll_expired`]. If no delays have
+/// expired, no items are returned. In this case, `Poll::Pending` is returned and the
+/// current task is registered to be notified once the next item's delay has
+/// expired.
+///
+/// If no items are in the queue, i.e. `is_empty()` returns `true`, then `poll`
+/// returns `Poll::Ready(None)`. This indicates that the stream has reached an end.
+/// However, if a new item is inserted *after*, `poll` will once again start
+/// returning items or `Poll::Pending`.
+///
+/// Items are returned ordered by their expirations. Items that are configured
+/// to expire first will be returned first. There are no ordering guarantees
+/// for items configured to expire at the same instant. Also note that delays are
+/// rounded to the closest millisecond.
+///
+/// # Implementation
+///
+/// The [`DelayQueue`] is backed by a separate instance of a timer wheel similar to that used internally
+/// by Tokio's standalone timer utilities such as [`sleep`]. Because of this, it offers the same
+/// performance and scalability benefits.
+///
+/// State associated with each entry is stored in a [`slab`]. This amortizes the cost of allocation,
+/// and allows reuse of the memory allocated for expired entries.
+///
+/// Capacity can be checked using [`capacity`] and allocated preemptively by using
+/// the [`reserve`] method.
+///
+/// # Usage
+///
+/// Using `DelayQueue` to manage cache entries.
+///
+/// ```rust,no_run
+/// use tokio_util::time::{DelayQueue, delay_queue};
+///
+/// use futures::ready;
+/// use std::collections::HashMap;
+/// use std::task::{Context, Poll};
+/// use std::time::Duration;
+/// # type CacheKey = String;
+/// # type Value = String;
+///
+/// struct Cache {
+/// entries: HashMap<CacheKey, (Value, delay_queue::Key)>,
+/// expirations: DelayQueue<CacheKey>,
+/// }
+///
+/// const TTL_SECS: u64 = 30;
+///
+/// impl Cache {
+/// fn insert(&mut self, key: CacheKey, value: Value) {
+/// let delay = self.expirations
+/// .insert(key.clone(), Duration::from_secs(TTL_SECS));
+///
+/// self.entries.insert(key, (value, delay));
+/// }
+///
+/// fn get(&self, key: &CacheKey) -> Option<&Value> {
+/// self.entries.get(key)
+/// .map(|&(ref v, _)| v)
+/// }
+///
+/// fn remove(&mut self, key: &CacheKey) {
+/// if let Some((_, cache_key)) = self.entries.remove(key) {
+/// self.expirations.remove(&cache_key);
+/// }
+/// }
+///
+/// fn poll_purge(&mut self, cx: &mut Context<'_>) -> Poll<()> {
+/// while let Some(entry) = ready!(self.expirations.poll_expired(cx)) {
+/// self.entries.remove(entry.get_ref());
+/// }
+///
+/// Poll::Ready(())
+/// }
+/// }
+/// ```
+///
+/// [`insert`]: method@Self::insert
+/// [`insert_at`]: method@Self::insert_at
+/// [`Key`]: struct@Key
+/// [`Stream`]: https://docs.rs/futures/0.1/futures/stream/trait.Stream.html
+/// [`poll_expired`]: method@Self::poll_expired
+/// [`Stream::poll_expired`]: method@Self::poll_expired
+/// [`DelayQueue`]: struct@DelayQueue
+/// [`sleep`]: fn@tokio::time::sleep
+/// [`slab`]: slab
+/// [`capacity`]: method@Self::capacity
+/// [`reserve`]: method@Self::reserve
+#[derive(Debug)]
+pub struct DelayQueue<T> {
+ /// Stores data associated with entries
+ slab: SlabStorage<T>,
+
+ /// Lookup structure tracking all delays in the queue
+ wheel: Wheel<Stack<T>>,
+
+ /// Delays that were inserted when already expired. These cannot be stored
+ /// in the wheel
+ expired: Stack<T>,
+
+ /// Delay expiring when the *first* item in the queue expires
+ delay: Option<Pin<Box<Sleep>>>,
+
+ /// Wheel polling state
+ wheel_now: u64,
+
+ /// Instant at which the timer starts
+ start: Instant,
+
+ /// Waker that is invoked when we potentially need to reset the timer.
+ /// Because we lazily create the timer when the first entry is created, we
+ /// need to awaken any poller that polled us before that point.
+ waker: Option<Waker>,
+}
+
+#[derive(Default)]
+struct SlabStorage<T> {
+ inner: Slab<Data<T>>,
+
+ // A `compact` call requires a re-mapping of the `Key`s that were changed
+ // during the `compact` call of the `slab`. Since the keys that were given out
+ // cannot be changed retroactively we need to keep track of these re-mappings.
+ // The keys of `key_map` correspond to the old keys that were given out and
+ // the values to the `Key`s that were re-mapped by the `compact` call.
+ key_map: HashMap<Key, KeyInternal>,
+
+ // Index used to create new keys to hand out.
+ next_key_index: usize,
+
+ // Whether `compact` has been called, necessary in order to decide whether
+ // to include keys in `key_map`.
+ compact_called: bool,
+}
+
+impl<T> SlabStorage<T> {
+ pub(crate) fn with_capacity(capacity: usize) -> SlabStorage<T> {
+ SlabStorage {
+ inner: Slab::with_capacity(capacity),
+ key_map: HashMap::new(),
+ next_key_index: 0,
+ compact_called: false,
+ }
+ }
+
+ // Inserts data into the inner slab and re-maps keys if necessary
+ pub(crate) fn insert(&mut self, val: Data<T>) -> Key {
+ let mut key = KeyInternal::new(self.inner.insert(val));
+ let key_contained = self.key_map.contains_key(&key.into());
+
+ if key_contained {
+ // It's possible that a `compact` call creates capacity in `self.inner` in
+ // such a way that a `self.inner.insert` call creates a `key` which was
+ // previously given out during an `insert` call prior to the `compact` call.
+ // If `key` is contained in `self.key_map`, we have encountered this exact situation,
+ // We need to create a new key `key_to_give_out` and include the relation
+ // `key_to_give_out` -> `key` in `self.key_map`.
+ let key_to_give_out = self.create_new_key();
+ assert!(!self.key_map.contains_key(&key_to_give_out.into()));
+ self.key_map.insert(key_to_give_out.into(), key);
+ key = key_to_give_out;
+ } else if self.compact_called {
+ // Include an identity mapping in `self.key_map` in order to allow us to
+ // panic if a key that was handed out is removed more than once.
+ self.key_map.insert(key.into(), key);
+ }
+
+ key.into()
+ }
+
+ // Re-map the key in case compact was previously called.
+ // Note: Since we include identity mappings in key_map after compact was called,
+ // we have information about all keys that were handed out. In the case in which
+ // compact was called and we try to remove a Key that was previously removed
+ // we can detect invalid keys if no key is found in `key_map`. This is necessary
+ // in order to prevent situations in which a previously removed key
+ // corresponds to a re-mapped key internally and which would then be incorrectly
+ // removed from the slab.
+ //
+ // Example to illuminate this problem:
+ //
+ // Let's assume our `key_map` is {1 -> 2, 2 -> 1} and we call remove(1). If we
+ // were to remove 1 again, we would not find it inside `key_map` anymore.
+ // If we were to imply from this that no re-mapping was necessary, we would
+ // incorrectly remove 1 from `self.slab.inner`, which corresponds to the
+ // handed-out key 2.
+ pub(crate) fn remove(&mut self, key: &Key) -> Data<T> {
+ let remapped_key = if self.compact_called {
+ match self.key_map.remove(key) {
+ Some(key_internal) => key_internal,
+ None => panic!("invalid key"),
+ }
+ } else {
+ (*key).into()
+ };
+
+ self.inner.remove(remapped_key.index)
+ }
+
+ pub(crate) fn shrink_to_fit(&mut self) {
+ self.inner.shrink_to_fit();
+ self.key_map.shrink_to_fit();
+ }
+
+ pub(crate) fn compact(&mut self) {
+ if !self.compact_called {
+ for (key, _) in self.inner.iter() {
+ self.key_map.insert(Key::new(key), KeyInternal::new(key));
+ }
+ }
+
+ let mut remapping = HashMap::new();
+ self.inner.compact(|_, from, to| {
+ remapping.insert(from, to);
+ true
+ });
+
+ // At this point `key_map` contains a mapping for every element.
+ for internal_key in self.key_map.values_mut() {
+ if let Some(new_internal_key) = remapping.get(&internal_key.index) {
+ *internal_key = KeyInternal::new(*new_internal_key);
+ }
+ }
+
+ if self.key_map.capacity() > 2 * self.key_map.len() {
+ self.key_map.shrink_to_fit();
+ }
+
+ self.compact_called = true;
+ }
+
+ // Tries to re-map a `Key` that was given out to the user to its
+ // corresponding internal key.
+ fn remap_key(&self, key: &Key) -> Option<KeyInternal> {
+ let key_map = &self.key_map;
+ if self.compact_called {
+ key_map.get(key).copied()
+ } else {
+ Some((*key).into())
+ }
+ }
+
+ fn create_new_key(&mut self) -> KeyInternal {
+ while self.key_map.contains_key(&Key::new(self.next_key_index)) {
+ self.next_key_index = self.next_key_index.wrapping_add(1);
+ }
+
+ KeyInternal::new(self.next_key_index)
+ }
+
+ pub(crate) fn len(&self) -> usize {
+ self.inner.len()
+ }
+
+ pub(crate) fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+
+ pub(crate) fn clear(&mut self) {
+ self.inner.clear();
+ self.key_map.clear();
+ self.compact_called = false;
+ }
+
+ pub(crate) fn reserve(&mut self, additional: usize) {
+ self.inner.reserve(additional);
+
+ if self.compact_called {
+ self.key_map.reserve(additional);
+ }
+ }
+
+ pub(crate) fn is_empty(&self) -> bool {
+ self.inner.is_empty()
+ }
+
+ pub(crate) fn contains(&self, key: &Key) -> bool {
+ let remapped_key = self.remap_key(key);
+
+ match remapped_key {
+ Some(internal_key) => self.inner.contains(internal_key.index),
+ None => false,
+ }
+ }
+}
+
+impl<T> fmt::Debug for SlabStorage<T>
+where
+ T: fmt::Debug,
+{
+ fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if fmt.alternate() {
+ fmt.debug_map().entries(self.inner.iter()).finish()
+ } else {
+ fmt.debug_struct("Slab")
+ .field("len", &self.len())
+ .field("cap", &self.capacity())
+ .finish()
+ }
+ }
+}
+
+impl<T> Index<Key> for SlabStorage<T> {
+ type Output = Data<T>;
+
+ fn index(&self, key: Key) -> &Self::Output {
+ let remapped_key = self.remap_key(&key);
+
+ match remapped_key {
+ Some(internal_key) => &self.inner[internal_key.index],
+ None => panic!("Invalid index {}", key.index),
+ }
+ }
+}
+
+impl<T> IndexMut<Key> for SlabStorage<T> {
+ fn index_mut(&mut self, key: Key) -> &mut Data<T> {
+ let remapped_key = self.remap_key(&key);
+
+ match remapped_key {
+ Some(internal_key) => &mut self.inner[internal_key.index],
+ None => panic!("Invalid index {}", key.index),
+ }
+ }
+}
+
+/// An entry in `DelayQueue` that has expired and been removed.
+///
+/// Values are returned by [`DelayQueue::poll_expired`].
+///
+/// [`DelayQueue::poll_expired`]: method@DelayQueue::poll_expired
+#[derive(Debug)]
+pub struct Expired<T> {
+ /// The data stored in the queue
+ data: T,
+
+ /// The expiration time
+ deadline: Instant,
+
+ /// The key associated with the entry
+ key: Key,
+}
+
+/// Token to a value stored in a `DelayQueue`.
+///
+/// Instances of `Key` are returned by [`DelayQueue::insert`]. See [`DelayQueue`]
+/// documentation for more details.
+///
+/// [`DelayQueue`]: struct@DelayQueue
+/// [`DelayQueue::insert`]: method@DelayQueue::insert
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub struct Key {
+ index: usize,
+}
+
+// Whereas `Key` is given out to users that use `DelayQueue`, internally we use
+// `KeyInternal` as the key type in order to make the logic of mapping between keys
+// as a result of `compact` calls clearer.
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+struct KeyInternal {
+ index: usize,
+}
+
+#[derive(Debug)]
+struct Stack<T> {
+ /// Head of the stack
+ head: Option<Key>,
+ _p: PhantomData<fn() -> T>,
+}
+
+#[derive(Debug)]
+struct Data<T> {
+ /// The data being stored in the queue and will be returned at the requested
+ /// instant.
+ inner: T,
+
+ /// The instant at which the item is returned.
+ when: u64,
+
+ /// Set to true when stored in the `expired` queue
+ expired: bool,
+
+ /// Next entry in the stack
+ next: Option<Key>,
+
+ /// Previous entry in the stack
+ prev: Option<Key>,
+}
+
+/// Maximum number of entries the queue can handle
+const MAX_ENTRIES: usize = (1 << 30) - 1;
+
+impl<T> DelayQueue<T> {
+ /// Creates a new, empty, `DelayQueue`.
+ ///
+ /// The queue will not allocate storage until items are inserted into it.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// # use tokio_util::time::DelayQueue;
+ /// let delay_queue: DelayQueue<u32> = DelayQueue::new();
+ /// ```
+ pub fn new() -> DelayQueue<T> {
+ DelayQueue::with_capacity(0)
+ }
+
+ /// Creates a new, empty, `DelayQueue` with the specified capacity.
+ ///
+ /// The queue will be able to hold at least `capacity` elements without
+ /// reallocating. If `capacity` is 0, the queue will not allocate for
+ /// storage.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// # use tokio_util::time::DelayQueue;
+ /// # use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::with_capacity(10);
+ ///
+ /// // These insertions are done without further allocation
+ /// for i in 0..10 {
+ /// delay_queue.insert(i, Duration::from_secs(i));
+ /// }
+ ///
+ /// // This will make the queue allocate additional storage
+ /// delay_queue.insert(11, Duration::from_secs(11));
+ /// # }
+ /// ```
+ pub fn with_capacity(capacity: usize) -> DelayQueue<T> {
+ DelayQueue {
+ wheel: Wheel::new(),
+ slab: SlabStorage::with_capacity(capacity),
+ expired: Stack::default(),
+ delay: None,
+ wheel_now: 0,
+ start: Instant::now(),
+ waker: None,
+ }
+ }
+
+ /// Inserts `value` into the queue set to expire at a specific instant in
+ /// time.
+ ///
+ /// This function is identical to `insert`, but takes an `Instant` instead
+ /// of a `Duration`.
+ ///
+ /// `value` is stored in the queue until `when` is reached. At which point,
+ /// `value` will be returned from [`poll_expired`]. If `when` has already been
+ /// reached, then `value` is immediately made available to poll.
+ ///
+ /// The return value represents the insertion and is used as an argument to
+ /// [`remove`] and [`reset`]. Note that [`Key`] is a token and is reused once
+ /// `value` is removed from the queue either by calling [`poll_expired`] after
+ /// `when` is reached or by calling [`remove`]. At this point, the caller
+ /// must take care to not use the returned [`Key`] again as it may reference
+ /// a different item in the queue.
+ ///
+ /// See [type] level documentation for more details.
+ ///
+ /// # Panics
+ ///
+ /// This function panics if `when` is too far in the future.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio::time::{Duration, Instant};
+ /// use tokio_util::time::DelayQueue;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert_at(
+ /// "foo", Instant::now() + Duration::from_secs(5));
+ ///
+ /// // Remove the entry
+ /// let item = delay_queue.remove(&key);
+ /// assert_eq!(*item.get_ref(), "foo");
+ /// # }
+ /// ```
+ ///
+ /// [`poll_expired`]: method@Self::poll_expired
+ /// [`remove`]: method@Self::remove
+ /// [`reset`]: method@Self::reset
+ /// [`Key`]: struct@Key
+ /// [type]: #
+ #[track_caller]
+ pub fn insert_at(&mut self, value: T, when: Instant) -> Key {
+ assert!(self.slab.len() < MAX_ENTRIES, "max entries exceeded");
+
+ // Normalize the deadline. Values cannot be set to expire in the past.
+ let when = self.normalize_deadline(when);
+
+ // Insert the value in the store
+ let key = self.slab.insert(Data {
+ inner: value,
+ when,
+ expired: false,
+ next: None,
+ prev: None,
+ });
+
+ self.insert_idx(when, key);
+
+ // Set a new delay if the current's deadline is later than the one of the new item
+ let should_set_delay = if let Some(ref delay) = self.delay {
+ let current_exp = self.normalize_deadline(delay.deadline());
+ current_exp > when
+ } else {
+ true
+ };
+
+ if should_set_delay {
+ if let Some(waker) = self.waker.take() {
+ waker.wake();
+ }
+
+ let delay_time = self.start + Duration::from_millis(when);
+ if let Some(ref mut delay) = &mut self.delay {
+ delay.as_mut().reset(delay_time);
+ } else {
+ self.delay = Some(Box::pin(sleep_until(delay_time)));
+ }
+ }
+
+ key
+ }
+
+ /// Attempts to pull out the next value of the delay queue, registering the
+ /// current task for wakeup if the value is not yet available, and returning
+ /// `None` if the queue is exhausted.
+ pub fn poll_expired(&mut self, cx: &mut task::Context<'_>) -> Poll<Option<Expired<T>>> {
+ if !self
+ .waker
+ .as_ref()
+ .map(|w| w.will_wake(cx.waker()))
+ .unwrap_or(false)
+ {
+ self.waker = Some(cx.waker().clone());
+ }
+
+ let item = ready!(self.poll_idx(cx));
+ Poll::Ready(item.map(|key| {
+ let data = self.slab.remove(&key);
+ debug_assert!(data.next.is_none());
+ debug_assert!(data.prev.is_none());
+
+ Expired {
+ key,
+ data: data.inner,
+ deadline: self.start + Duration::from_millis(data.when),
+ }
+ }))
+ }
+
+ /// Inserts `value` into the queue set to expire after the requested duration
+ /// elapses.
+ ///
+ /// This function is identical to `insert_at`, but takes a `Duration`
+ /// instead of an `Instant`.
+ ///
+ /// `value` is stored in the queue until `timeout` duration has
+ /// elapsed after `insert` was called. At that point, `value` will
+ /// be returned from [`poll_expired`]. If `timeout` is a `Duration` of
+ /// zero, then `value` is immediately made available to poll.
+ ///
+ /// The return value represents the insertion and is used as an
+ /// argument to [`remove`] and [`reset`]. Note that [`Key`] is a
+ /// token and is reused once `value` is removed from the queue
+ /// either by calling [`poll_expired`] after `timeout` has elapsed
+ /// or by calling [`remove`]. At this point, the caller must not
+ /// use the returned [`Key`] again as it may reference a different
+ /// item in the queue.
+ ///
+ /// See [type] level documentation for more details.
+ ///
+ /// # Panics
+ ///
+ /// This function panics if `timeout` is greater than the maximum
+ /// duration supported by the timer in the current `Runtime`.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// // Remove the entry
+ /// let item = delay_queue.remove(&key);
+ /// assert_eq!(*item.get_ref(), "foo");
+ /// # }
+ /// ```
+ ///
+ /// [`poll_expired`]: method@Self::poll_expired
+ /// [`remove`]: method@Self::remove
+ /// [`reset`]: method@Self::reset
+ /// [`Key`]: struct@Key
+ /// [type]: #
+ #[track_caller]
+ pub fn insert(&mut self, value: T, timeout: Duration) -> Key {
+ self.insert_at(value, Instant::now() + timeout)
+ }
+
+ #[track_caller]
+ fn insert_idx(&mut self, when: u64, key: Key) {
+ use self::wheel::{InsertError, Stack};
+
+ // Register the deadline with the timer wheel
+ match self.wheel.insert(when, key, &mut self.slab) {
+ Ok(_) => {}
+ Err((_, InsertError::Elapsed)) => {
+ self.slab[key].expired = true;
+ // The delay is already expired, store it in the expired queue
+ self.expired.push(key, &mut self.slab);
+ }
+ Err((_, err)) => panic!("invalid deadline; err={:?}", err),
+ }
+ }
+
+ /// Removes the key from the expired queue or the timer wheel
+ /// depending on its expiration status.
+ ///
+ /// # Panics
+ ///
+ /// Panics if the key is not contained in the expired queue or the wheel.
+ #[track_caller]
+ fn remove_key(&mut self, key: &Key) {
+ use crate::time::wheel::Stack;
+
+ // Special case the `expired` queue
+ if self.slab[*key].expired {
+ self.expired.remove(key, &mut self.slab);
+ } else {
+ self.wheel.remove(key, &mut self.slab);
+ }
+ }
+
+ /// Removes the item associated with `key` from the queue.
+ ///
+ /// There must be an item associated with `key`. The function returns the
+ /// removed item as well as the `Instant` at which it will the delay will
+ /// have expired.
+ ///
+ /// # Panics
+ ///
+ /// The function panics if `key` is not contained by the queue.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// // Remove the entry
+ /// let item = delay_queue.remove(&key);
+ /// assert_eq!(*item.get_ref(), "foo");
+ /// # }
+ /// ```
+ #[track_caller]
+ pub fn remove(&mut self, key: &Key) -> Expired<T> {
+ let prev_deadline = self.next_deadline();
+
+ self.remove_key(key);
+ let data = self.slab.remove(key);
+
+ let next_deadline = self.next_deadline();
+ if prev_deadline != next_deadline {
+ match (next_deadline, &mut self.delay) {
+ (None, _) => self.delay = None,
+ (Some(deadline), Some(delay)) => delay.as_mut().reset(deadline),
+ (Some(deadline), None) => self.delay = Some(Box::pin(sleep_until(deadline))),
+ }
+ }
+
+ Expired {
+ key: Key::new(key.index),
+ data: data.inner,
+ deadline: self.start + Duration::from_millis(data.when),
+ }
+ }
+
+ /// Attempts to remove the item associated with `key` from the queue.
+ ///
+ /// Removes the item associated with `key`, and returns it along with the
+ /// `Instant` at which it would have expired, if it exists.
+ ///
+ /// Returns `None` if `key` is not in the queue.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main(flavor = "current_thread")]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// // The item is in the queue, `try_remove` returns `Some(Expired("foo"))`.
+ /// let item = delay_queue.try_remove(&key);
+ /// assert_eq!(item.unwrap().into_inner(), "foo");
+ ///
+ /// // The item is not in the queue anymore, `try_remove` returns `None`.
+ /// let item = delay_queue.try_remove(&key);
+ /// assert!(item.is_none());
+ /// # }
+ /// ```
+ pub fn try_remove(&mut self, key: &Key) -> Option<Expired<T>> {
+ if self.slab.contains(key) {
+ Some(self.remove(key))
+ } else {
+ None
+ }
+ }
+
+ /// Sets the delay of the item associated with `key` to expire at `when`.
+ ///
+ /// This function is identical to `reset` but takes an `Instant` instead of
+ /// a `Duration`.
+ ///
+ /// The item remains in the queue but the delay is set to expire at `when`.
+ /// If `when` is in the past, then the item is immediately made available to
+ /// the caller.
+ ///
+ /// # Panics
+ ///
+ /// This function panics if `when` is too far in the future or if `key` is
+ /// not contained by the queue.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio::time::{Duration, Instant};
+ /// use tokio_util::time::DelayQueue;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// // "foo" is scheduled to be returned in 5 seconds
+ ///
+ /// delay_queue.reset_at(&key, Instant::now() + Duration::from_secs(10));
+ ///
+ /// // "foo" is now scheduled to be returned in 10 seconds
+ /// # }
+ /// ```
+ #[track_caller]
+ pub fn reset_at(&mut self, key: &Key, when: Instant) {
+ self.remove_key(key);
+
+ // Normalize the deadline. Values cannot be set to expire in the past.
+ let when = self.normalize_deadline(when);
+
+ self.slab[*key].when = when;
+ self.slab[*key].expired = false;
+
+ self.insert_idx(when, *key);
+
+ let next_deadline = self.next_deadline();
+ if let (Some(ref mut delay), Some(deadline)) = (&mut self.delay, next_deadline) {
+ // This should awaken us if necessary (ie, if already expired)
+ delay.as_mut().reset(deadline);
+ }
+ }
+
+ /// Shrink the capacity of the slab, which `DelayQueue` uses internally for storage allocation.
+ /// This function is not guaranteed to, and in most cases, won't decrease the capacity of the slab
+ /// to the number of elements still contained in it, because elements cannot be moved to a different
+ /// index. To decrease the capacity to the size of the slab use [`compact`].
+ ///
+ /// This function can take O(n) time even when the capacity cannot be reduced or the allocation is
+ /// shrunk in place. Repeated calls run in O(1) though.
+ ///
+ /// [`compact`]: method@Self::compact
+ pub fn shrink_to_fit(&mut self) {
+ self.slab.shrink_to_fit();
+ }
+
+ /// Shrink the capacity of the slab, which `DelayQueue` uses internally for storage allocation,
+ /// to the number of elements that are contained in it.
+ ///
+ /// This methods runs in O(n).
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::with_capacity(10);
+ ///
+ /// let key1 = delay_queue.insert(5, Duration::from_secs(5));
+ /// let key2 = delay_queue.insert(10, Duration::from_secs(10));
+ /// let key3 = delay_queue.insert(15, Duration::from_secs(15));
+ ///
+ /// delay_queue.remove(&key2);
+ ///
+ /// delay_queue.compact();
+ /// assert_eq!(delay_queue.capacity(), 2);
+ /// # }
+ /// ```
+ pub fn compact(&mut self) {
+ self.slab.compact();
+ }
+
+ /// Gets the [`Key`] that [`poll_expired`] will pull out of the queue next, without
+ /// pulling it out or waiting for the deadline to expire.
+ ///
+ /// Entries that have already expired may be returned in any order, but it is
+ /// guaranteed that this method returns them in the same order as when items
+ /// are popped from the `DelayQueue`.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ ///
+ /// let key1 = delay_queue.insert("foo", Duration::from_secs(10));
+ /// let key2 = delay_queue.insert("bar", Duration::from_secs(5));
+ /// let key3 = delay_queue.insert("baz", Duration::from_secs(15));
+ ///
+ /// assert_eq!(delay_queue.peek().unwrap(), key2);
+ /// # }
+ /// ```
+ ///
+ /// [`Key`]: struct@Key
+ /// [`poll_expired`]: method@Self::poll_expired
+ pub fn peek(&self) -> Option<Key> {
+ use self::wheel::Stack;
+
+ self.expired.peek().or_else(|| self.wheel.peek())
+ }
+
+ /// Returns the next time to poll as determined by the wheel
+ fn next_deadline(&mut self) -> Option<Instant> {
+ self.wheel
+ .poll_at()
+ .map(|poll_at| self.start + Duration::from_millis(poll_at))
+ }
+
+ /// Sets the delay of the item associated with `key` to expire after
+ /// `timeout`.
+ ///
+ /// This function is identical to `reset_at` but takes a `Duration` instead
+ /// of an `Instant`.
+ ///
+ /// The item remains in the queue but the delay is set to expire after
+ /// `timeout`. If `timeout` is zero, then the item is immediately made
+ /// available to the caller.
+ ///
+ /// # Panics
+ ///
+ /// This function panics if `timeout` is greater than the maximum supported
+ /// duration or if `key` is not contained by the queue.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// let key = delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// // "foo" is scheduled to be returned in 5 seconds
+ ///
+ /// delay_queue.reset(&key, Duration::from_secs(10));
+ ///
+ /// // "foo"is now scheduled to be returned in 10 seconds
+ /// # }
+ /// ```
+ #[track_caller]
+ pub fn reset(&mut self, key: &Key, timeout: Duration) {
+ self.reset_at(key, Instant::now() + timeout);
+ }
+
+ /// Clears the queue, removing all items.
+ ///
+ /// After calling `clear`, [`poll_expired`] will return `Ok(Ready(None))`.
+ ///
+ /// Note that this method has no effect on the allocated capacity.
+ ///
+ /// [`poll_expired`]: method@Self::poll_expired
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ ///
+ /// delay_queue.insert("foo", Duration::from_secs(5));
+ ///
+ /// assert!(!delay_queue.is_empty());
+ ///
+ /// delay_queue.clear();
+ ///
+ /// assert!(delay_queue.is_empty());
+ /// # }
+ /// ```
+ pub fn clear(&mut self) {
+ self.slab.clear();
+ self.expired = Stack::default();
+ self.wheel = Wheel::new();
+ self.delay = None;
+ }
+
+ /// Returns the number of elements the queue can hold without reallocating.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ ///
+ /// let delay_queue: DelayQueue<i32> = DelayQueue::with_capacity(10);
+ /// assert_eq!(delay_queue.capacity(), 10);
+ /// ```
+ pub fn capacity(&self) -> usize {
+ self.slab.capacity()
+ }
+
+ /// Returns the number of elements currently in the queue.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue: DelayQueue<i32> = DelayQueue::with_capacity(10);
+ /// assert_eq!(delay_queue.len(), 0);
+ /// delay_queue.insert(3, Duration::from_secs(5));
+ /// assert_eq!(delay_queue.len(), 1);
+ /// # }
+ /// ```
+ pub fn len(&self) -> usize {
+ self.slab.len()
+ }
+
+ /// Reserves capacity for at least `additional` more items to be queued
+ /// without allocating.
+ ///
+ /// `reserve` does nothing if the queue already has sufficient capacity for
+ /// `additional` more values. If more capacity is required, a new segment of
+ /// memory will be allocated and all existing values will be copied into it.
+ /// As such, if the queue is already very large, a call to `reserve` can end
+ /// up being expensive.
+ ///
+ /// The queue may reserve more than `additional` extra space in order to
+ /// avoid frequent reallocations.
+ ///
+ /// # Panics
+ ///
+ /// Panics if the new capacity exceeds the maximum number of entries the
+ /// queue can contain.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ ///
+ /// delay_queue.insert("hello", Duration::from_secs(10));
+ /// delay_queue.reserve(10);
+ ///
+ /// assert!(delay_queue.capacity() >= 11);
+ /// # }
+ /// ```
+ #[track_caller]
+ pub fn reserve(&mut self, additional: usize) {
+ assert!(
+ self.slab.capacity() + additional <= MAX_ENTRIES,
+ "max queue capacity exceeded"
+ );
+ self.slab.reserve(additional);
+ }
+
+ /// Returns `true` if there are no items in the queue.
+ ///
+ /// Note that this function returns `false` even if all items have not yet
+ /// expired and a call to `poll` will return `Poll::Pending`.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tokio_util::time::DelayQueue;
+ /// use std::time::Duration;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() {
+ /// let mut delay_queue = DelayQueue::new();
+ /// assert!(delay_queue.is_empty());
+ ///
+ /// delay_queue.insert("hello", Duration::from_secs(5));
+ /// assert!(!delay_queue.is_empty());
+ /// # }
+ /// ```
+ pub fn is_empty(&self) -> bool {
+ self.slab.is_empty()
+ }
+
+ /// Polls the queue, returning the index of the next slot in the slab that
+ /// should be returned.
+ ///
+ /// A slot should be returned when the associated deadline has been reached.
+ fn poll_idx(&mut self, cx: &mut task::Context<'_>) -> Poll<Option<Key>> {
+ use self::wheel::Stack;
+
+ let expired = self.expired.pop(&mut self.slab);
+
+ if expired.is_some() {
+ return Poll::Ready(expired);
+ }
+
+ loop {
+ if let Some(ref mut delay) = self.delay {
+ if !delay.is_elapsed() {
+ ready!(Pin::new(&mut *delay).poll(cx));
+ }
+
+ let now = crate::time::ms(delay.deadline() - self.start, crate::time::Round::Down);
+
+ self.wheel_now = now;
+ }
+
+ // We poll the wheel to get the next value out before finding the next deadline.
+ let wheel_idx = self.wheel.poll(self.wheel_now, &mut self.slab);
+
+ self.delay = self.next_deadline().map(|when| Box::pin(sleep_until(when)));
+
+ if let Some(idx) = wheel_idx {
+ return Poll::Ready(Some(idx));
+ }
+
+ if self.delay.is_none() {
+ return Poll::Ready(None);
+ }
+ }
+ }
+
+ fn normalize_deadline(&self, when: Instant) -> u64 {
+ let when = if when < self.start {
+ 0
+ } else {
+ crate::time::ms(when - self.start, crate::time::Round::Up)
+ };
+
+ cmp::max(when, self.wheel.elapsed())
+ }
+}
+
+// We never put `T` in a `Pin`...
+impl<T> Unpin for DelayQueue<T> {}
+
+impl<T> Default for DelayQueue<T> {
+ fn default() -> DelayQueue<T> {
+ DelayQueue::new()
+ }
+}
+
+impl<T> futures_core::Stream for DelayQueue<T> {
+ // DelayQueue seems much more specific, where a user may care that it
+ // has reached capacity, so return those errors instead of panicking.
+ type Item = Expired<T>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut task::Context<'_>) -> Poll<Option<Self::Item>> {
+ DelayQueue::poll_expired(self.get_mut(), cx)
+ }
+}
+
+impl<T> wheel::Stack for Stack<T> {
+ type Owned = Key;
+ type Borrowed = Key;
+ type Store = SlabStorage<T>;
+
+ fn is_empty(&self) -> bool {
+ self.head.is_none()
+ }
+
+ fn push(&mut self, item: Self::Owned, store: &mut Self::Store) {
+ // Ensure the entry is not already in a stack.
+ debug_assert!(store[item].next.is_none());
+ debug_assert!(store[item].prev.is_none());
+
+ // Remove the old head entry
+ let old = self.head.take();
+
+ if let Some(idx) = old {
+ store[idx].prev = Some(item);
+ }
+
+ store[item].next = old;
+ self.head = Some(item);
+ }
+
+ fn pop(&mut self, store: &mut Self::Store) -> Option<Self::Owned> {
+ if let Some(key) = self.head {
+ self.head = store[key].next;
+
+ if let Some(idx) = self.head {
+ store[idx].prev = None;
+ }
+
+ store[key].next = None;
+ debug_assert!(store[key].prev.is_none());
+
+ Some(key)
+ } else {
+ None
+ }
+ }
+
+ fn peek(&self) -> Option<Self::Owned> {
+ self.head
+ }
+
+ #[track_caller]
+ fn remove(&mut self, item: &Self::Borrowed, store: &mut Self::Store) {
+ let key = *item;
+ assert!(store.contains(item));
+
+ // Ensure that the entry is in fact contained by the stack
+ debug_assert!({
+ // This walks the full linked list even if an entry is found.
+ let mut next = self.head;
+ let mut contains = false;
+
+ while let Some(idx) = next {
+ let data = &store[idx];
+
+ if idx == *item {
+ debug_assert!(!contains);
+ contains = true;
+ }
+
+ next = data.next;
+ }
+
+ contains
+ });
+
+ if let Some(next) = store[key].next {
+ store[next].prev = store[key].prev;
+ }
+
+ if let Some(prev) = store[key].prev {
+ store[prev].next = store[key].next;
+ } else {
+ self.head = store[key].next;
+ }
+
+ store[key].next = None;
+ store[key].prev = None;
+ }
+
+ fn when(item: &Self::Borrowed, store: &Self::Store) -> u64 {
+ store[*item].when
+ }
+}
+
+impl<T> Default for Stack<T> {
+ fn default() -> Stack<T> {
+ Stack {
+ head: None,
+ _p: PhantomData,
+ }
+ }
+}
+
+impl Key {
+ pub(crate) fn new(index: usize) -> Key {
+ Key { index }
+ }
+}
+
+impl KeyInternal {
+ pub(crate) fn new(index: usize) -> KeyInternal {
+ KeyInternal { index }
+ }
+}
+
+impl From<Key> for KeyInternal {
+ fn from(item: Key) -> Self {
+ KeyInternal::new(item.index)
+ }
+}
+
+impl From<KeyInternal> for Key {
+ fn from(item: KeyInternal) -> Self {
+ Key::new(item.index)
+ }
+}
+
+impl<T> Expired<T> {
+ /// Returns a reference to the inner value.
+ pub fn get_ref(&self) -> &T {
+ &self.data
+ }
+
+ /// Returns a mutable reference to the inner value.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.data
+ }
+
+ /// Consumes `self` and returns the inner value.
+ pub fn into_inner(self) -> T {
+ self.data
+ }
+
+ /// Returns the deadline that the expiration was set to.
+ pub fn deadline(&self) -> Instant {
+ self.deadline
+ }
+
+ /// Returns the key that the expiration is indexed by.
+ pub fn key(&self) -> Key {
+ self.key
+ }
+}
diff --git a/crates/tokio-util/src/time/mod.rs b/crates/tokio-util/src/time/mod.rs
new file mode 100644
index 0000000..2d34008
--- /dev/null
+++ b/crates/tokio-util/src/time/mod.rs
@@ -0,0 +1,47 @@
+//! Additional utilities for tracking time.
+//!
+//! This module provides additional utilities for executing code after a set period
+//! of time. Currently there is only one:
+//!
+//! * `DelayQueue`: A queue where items are returned once the requested delay
+//! has expired.
+//!
+//! This type must be used from within the context of the `Runtime`.
+
+use std::time::Duration;
+
+mod wheel;
+
+pub mod delay_queue;
+
+#[doc(inline)]
+pub use delay_queue::DelayQueue;
+
+// ===== Internal utils =====
+
+enum Round {
+ Up,
+ Down,
+}
+
+/// Convert a `Duration` to milliseconds, rounding up and saturating at
+/// `u64::MAX`.
+///
+/// The saturating is fine because `u64::MAX` milliseconds are still many
+/// million years.
+#[inline]
+fn ms(duration: Duration, round: Round) -> u64 {
+ const NANOS_PER_MILLI: u32 = 1_000_000;
+ const MILLIS_PER_SEC: u64 = 1_000;
+
+ // Round up.
+ let millis = match round {
+ Round::Up => (duration.subsec_nanos() + NANOS_PER_MILLI - 1) / NANOS_PER_MILLI,
+ Round::Down => duration.subsec_millis(),
+ };
+
+ duration
+ .as_secs()
+ .saturating_mul(MILLIS_PER_SEC)
+ .saturating_add(u64::from(millis))
+}
diff --git a/crates/tokio-util/src/time/wheel/level.rs b/crates/tokio-util/src/time/wheel/level.rs
new file mode 100644
index 0000000..4290acf
--- /dev/null
+++ b/crates/tokio-util/src/time/wheel/level.rs
@@ -0,0 +1,277 @@
+use crate::time::wheel::Stack;
+
+use std::fmt;
+
+/// Wheel for a single level in the timer. This wheel contains 64 slots.
+pub(crate) struct Level<T> {
+ level: usize,
+
+ /// Bit field tracking which slots currently contain entries.
+ ///
+ /// Using a bit field to track slots that contain entries allows avoiding a
+ /// scan to find entries. This field is updated when entries are added or
+ /// removed from a slot.
+ ///
+ /// The least-significant bit represents slot zero.
+ occupied: u64,
+
+ /// Slots
+ slot: [T; LEVEL_MULT],
+}
+
+/// Indicates when a slot must be processed next.
+#[derive(Debug)]
+pub(crate) struct Expiration {
+ /// The level containing the slot.
+ pub(crate) level: usize,
+
+ /// The slot index.
+ pub(crate) slot: usize,
+
+ /// The instant at which the slot needs to be processed.
+ pub(crate) deadline: u64,
+}
+
+/// Level multiplier.
+///
+/// Being a power of 2 is very important.
+const LEVEL_MULT: usize = 64;
+
+impl<T: Stack> Level<T> {
+ pub(crate) fn new(level: usize) -> Level<T> {
+ // Rust's derived implementations for arrays require that the value
+ // contained by the array be `Copy`. So, here we have to manually
+ // initialize every single slot.
+ macro_rules! s {
+ () => {
+ T::default()
+ };
+ }
+
+ Level {
+ level,
+ occupied: 0,
+ slot: [
+ // It does not look like the necessary traits are
+ // derived for [T; 64].
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ s!(),
+ ],
+ }
+ }
+
+ /// Finds the slot that needs to be processed next and returns the slot and
+ /// `Instant` at which this slot must be processed.
+ pub(crate) fn next_expiration(&self, now: u64) -> Option<Expiration> {
+ // Use the `occupied` bit field to get the index of the next slot that
+ // needs to be processed.
+ let slot = match self.next_occupied_slot(now) {
+ Some(slot) => slot,
+ None => return None,
+ };
+
+ // From the slot index, calculate the `Instant` at which it needs to be
+ // processed. This value *must* be in the future with respect to `now`.
+
+ let level_range = level_range(self.level);
+ let slot_range = slot_range(self.level);
+
+ // TODO: This can probably be simplified w/ power of 2 math
+ let level_start = now - (now % level_range);
+ let mut deadline = level_start + slot as u64 * slot_range;
+ if deadline < now {
+ // A timer is in a slot "prior" to the current time. This can occur
+ // because we do not have an infinite hierarchy of timer levels, and
+ // eventually a timer scheduled for a very distant time might end up
+ // being placed in a slot that is beyond the end of all of the
+ // arrays.
+ //
+ // To deal with this, we first limit timers to being scheduled no
+ // more than MAX_DURATION ticks in the future; that is, they're at
+ // most one rotation of the top level away. Then, we force timers
+ // that logically would go into the top+1 level, to instead go into
+ // the top level's slots.
+ //
+ // What this means is that the top level's slots act as a
+ // pseudo-ring buffer, and we rotate around them indefinitely. If we
+ // compute a deadline before now, and it's the top level, it
+ // therefore means we're actually looking at a slot in the future.
+ debug_assert_eq!(self.level, super::NUM_LEVELS - 1);
+
+ deadline += level_range;
+ }
+ debug_assert!(
+ deadline >= now,
+ "deadline={:016X}; now={:016X}; level={}; slot={}; occupied={:b}",
+ deadline,
+ now,
+ self.level,
+ slot,
+ self.occupied
+ );
+
+ Some(Expiration {
+ level: self.level,
+ slot,
+ deadline,
+ })
+ }
+
+ fn next_occupied_slot(&self, now: u64) -> Option<usize> {
+ if self.occupied == 0 {
+ return None;
+ }
+
+ // Get the slot for now using Maths
+ let now_slot = (now / slot_range(self.level)) as usize;
+ let occupied = self.occupied.rotate_right(now_slot as u32);
+ let zeros = occupied.trailing_zeros() as usize;
+ let slot = (zeros + now_slot) % 64;
+
+ Some(slot)
+ }
+
+ pub(crate) fn add_entry(&mut self, when: u64, item: T::Owned, store: &mut T::Store) {
+ let slot = slot_for(when, self.level);
+
+ self.slot[slot].push(item, store);
+ self.occupied |= occupied_bit(slot);
+ }
+
+ pub(crate) fn remove_entry(&mut self, when: u64, item: &T::Borrowed, store: &mut T::Store) {
+ let slot = slot_for(when, self.level);
+
+ self.slot[slot].remove(item, store);
+
+ if self.slot[slot].is_empty() {
+ // The bit is currently set
+ debug_assert!(self.occupied & occupied_bit(slot) != 0);
+
+ // Unset the bit
+ self.occupied ^= occupied_bit(slot);
+ }
+ }
+
+ pub(crate) fn pop_entry_slot(&mut self, slot: usize, store: &mut T::Store) -> Option<T::Owned> {
+ let ret = self.slot[slot].pop(store);
+
+ if ret.is_some() && self.slot[slot].is_empty() {
+ // The bit is currently set
+ debug_assert!(self.occupied & occupied_bit(slot) != 0);
+
+ self.occupied ^= occupied_bit(slot);
+ }
+
+ ret
+ }
+
+ pub(crate) fn peek_entry_slot(&self, slot: usize) -> Option<T::Owned> {
+ self.slot[slot].peek()
+ }
+}
+
+impl<T> fmt::Debug for Level<T> {
+ fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt.debug_struct("Level")
+ .field("occupied", &self.occupied)
+ .finish()
+ }
+}
+
+fn occupied_bit(slot: usize) -> u64 {
+ 1 << slot
+}
+
+fn slot_range(level: usize) -> u64 {
+ LEVEL_MULT.pow(level as u32) as u64
+}
+
+fn level_range(level: usize) -> u64 {
+ LEVEL_MULT as u64 * slot_range(level)
+}
+
+/// Convert a duration (milliseconds) and a level to a slot position
+fn slot_for(duration: u64, level: usize) -> usize {
+ ((duration >> (level * 6)) % LEVEL_MULT as u64) as usize
+}
+
+#[cfg(all(test, not(loom)))]
+mod test {
+ use super::*;
+
+ #[test]
+ fn test_slot_for() {
+ for pos in 0..64 {
+ assert_eq!(pos as usize, slot_for(pos, 0));
+ }
+
+ for level in 1..5 {
+ for pos in level..64 {
+ let a = pos * 64_usize.pow(level as u32);
+ assert_eq!(pos as usize, slot_for(a as u64, level));
+ }
+ }
+ }
+}
diff --git a/crates/tokio-util/src/time/wheel/mod.rs b/crates/tokio-util/src/time/wheel/mod.rs
new file mode 100644
index 0000000..10a9900
--- /dev/null
+++ b/crates/tokio-util/src/time/wheel/mod.rs
@@ -0,0 +1,328 @@
+mod level;
+pub(crate) use self::level::Expiration;
+use self::level::Level;
+
+mod stack;
+pub(crate) use self::stack::Stack;
+
+use std::borrow::Borrow;
+use std::fmt::Debug;
+use std::usize;
+
+/// Timing wheel implementation.
+///
+/// This type provides the hashed timing wheel implementation that backs `Timer`
+/// and `DelayQueue`.
+///
+/// The structure is generic over `T: Stack`. This allows handling timeout data
+/// being stored on the heap or in a slab. In order to support the latter case,
+/// the slab must be passed into each function allowing the implementation to
+/// lookup timer entries.
+///
+/// See `Timer` documentation for some implementation notes.
+#[derive(Debug)]
+pub(crate) struct Wheel<T> {
+ /// The number of milliseconds elapsed since the wheel started.
+ elapsed: u64,
+
+ /// Timer wheel.
+ ///
+ /// Levels:
+ ///
+ /// * 1 ms slots / 64 ms range
+ /// * 64 ms slots / ~ 4 sec range
+ /// * ~ 4 sec slots / ~ 4 min range
+ /// * ~ 4 min slots / ~ 4 hr range
+ /// * ~ 4 hr slots / ~ 12 day range
+ /// * ~ 12 day slots / ~ 2 yr range
+ levels: Vec<Level<T>>,
+}
+
+/// Number of levels. Each level has 64 slots. By using 6 levels with 64 slots
+/// each, the timer is able to track time up to 2 years into the future with a
+/// precision of 1 millisecond.
+const NUM_LEVELS: usize = 6;
+
+/// The maximum duration of a delay
+const MAX_DURATION: u64 = (1 << (6 * NUM_LEVELS)) - 1;
+
+#[derive(Debug)]
+pub(crate) enum InsertError {
+ Elapsed,
+ Invalid,
+}
+
+impl<T> Wheel<T>
+where
+ T: Stack,
+{
+ /// Create a new timing wheel
+ pub(crate) fn new() -> Wheel<T> {
+ let levels = (0..NUM_LEVELS).map(Level::new).collect();
+
+ Wheel { elapsed: 0, levels }
+ }
+
+ /// Return the number of milliseconds that have elapsed since the timing
+ /// wheel's creation.
+ pub(crate) fn elapsed(&self) -> u64 {
+ self.elapsed
+ }
+
+ /// Insert an entry into the timing wheel.
+ ///
+ /// # Arguments
+ ///
+ /// * `when`: is the instant at which the entry should be fired. It is
+ /// represented as the number of milliseconds since the creation
+ /// of the timing wheel.
+ ///
+ /// * `item`: The item to insert into the wheel.
+ ///
+ /// * `store`: The slab or `()` when using heap storage.
+ ///
+ /// # Return
+ ///
+ /// Returns `Ok` when the item is successfully inserted, `Err` otherwise.
+ ///
+ /// `Err(Elapsed)` indicates that `when` represents an instant that has
+ /// already passed. In this case, the caller should fire the timeout
+ /// immediately.
+ ///
+ /// `Err(Invalid)` indicates an invalid `when` argument as been supplied.
+ pub(crate) fn insert(
+ &mut self,
+ when: u64,
+ item: T::Owned,
+ store: &mut T::Store,
+ ) -> Result<(), (T::Owned, InsertError)> {
+ if when <= self.elapsed {
+ return Err((item, InsertError::Elapsed));
+ } else if when - self.elapsed > MAX_DURATION {
+ return Err((item, InsertError::Invalid));
+ }
+
+ // Get the level at which the entry should be stored
+ let level = self.level_for(when);
+
+ self.levels[level].add_entry(when, item, store);
+
+ debug_assert!({
+ self.levels[level]
+ .next_expiration(self.elapsed)
+ .map(|e| e.deadline >= self.elapsed)
+ .unwrap_or(true)
+ });
+
+ Ok(())
+ }
+
+ /// Remove `item` from the timing wheel.
+ #[track_caller]
+ pub(crate) fn remove(&mut self, item: &T::Borrowed, store: &mut T::Store) {
+ let when = T::when(item, store);
+
+ assert!(
+ self.elapsed <= when,
+ "elapsed={}; when={}",
+ self.elapsed,
+ when
+ );
+
+ let level = self.level_for(when);
+
+ self.levels[level].remove_entry(when, item, store);
+ }
+
+ /// Instant at which to poll
+ pub(crate) fn poll_at(&self) -> Option<u64> {
+ self.next_expiration().map(|expiration| expiration.deadline)
+ }
+
+ /// Next key that will expire
+ pub(crate) fn peek(&self) -> Option<T::Owned> {
+ self.next_expiration()
+ .and_then(|expiration| self.peek_entry(&expiration))
+ }
+
+ /// Advances the timer up to the instant represented by `now`.
+ pub(crate) fn poll(&mut self, now: u64, store: &mut T::Store) -> Option<T::Owned> {
+ loop {
+ let expiration = self.next_expiration().and_then(|expiration| {
+ if expiration.deadline > now {
+ None
+ } else {
+ Some(expiration)
+ }
+ });
+
+ match expiration {
+ Some(ref expiration) => {
+ if let Some(item) = self.poll_expiration(expiration, store) {
+ return Some(item);
+ }
+
+ self.set_elapsed(expiration.deadline);
+ }
+ None => {
+ // in this case the poll did not indicate an expiration
+ // _and_ we were not able to find a next expiration in
+ // the current list of timers. advance to the poll's
+ // current time and do nothing else.
+ self.set_elapsed(now);
+ return None;
+ }
+ }
+ }
+ }
+
+ /// Returns the instant at which the next timeout expires.
+ fn next_expiration(&self) -> Option<Expiration> {
+ // Check all levels
+ for level in 0..NUM_LEVELS {
+ if let Some(expiration) = self.levels[level].next_expiration(self.elapsed) {
+ // There cannot be any expirations at a higher level that happen
+ // before this one.
+ debug_assert!(self.no_expirations_before(level + 1, expiration.deadline));
+
+ return Some(expiration);
+ }
+ }
+
+ None
+ }
+
+ /// Used for debug assertions
+ fn no_expirations_before(&self, start_level: usize, before: u64) -> bool {
+ let mut res = true;
+
+ for l2 in start_level..NUM_LEVELS {
+ if let Some(e2) = self.levels[l2].next_expiration(self.elapsed) {
+ if e2.deadline < before {
+ res = false;
+ }
+ }
+ }
+
+ res
+ }
+
+ /// iteratively find entries that are between the wheel's current
+ /// time and the expiration time. for each in that population either
+ /// return it for notification (in the case of the last level) or tier
+ /// it down to the next level (in all other cases).
+ pub(crate) fn poll_expiration(
+ &mut self,
+ expiration: &Expiration,
+ store: &mut T::Store,
+ ) -> Option<T::Owned> {
+ while let Some(item) = self.pop_entry(expiration, store) {
+ if expiration.level == 0 {
+ debug_assert_eq!(T::when(item.borrow(), store), expiration.deadline);
+
+ return Some(item);
+ } else {
+ let when = T::when(item.borrow(), store);
+
+ let next_level = expiration.level - 1;
+
+ self.levels[next_level].add_entry(when, item, store);
+ }
+ }
+
+ None
+ }
+
+ fn set_elapsed(&mut self, when: u64) {
+ assert!(
+ self.elapsed <= when,
+ "elapsed={:?}; when={:?}",
+ self.elapsed,
+ when
+ );
+
+ if when > self.elapsed {
+ self.elapsed = when;
+ }
+ }
+
+ fn pop_entry(&mut self, expiration: &Expiration, store: &mut T::Store) -> Option<T::Owned> {
+ self.levels[expiration.level].pop_entry_slot(expiration.slot, store)
+ }
+
+ fn peek_entry(&self, expiration: &Expiration) -> Option<T::Owned> {
+ self.levels[expiration.level].peek_entry_slot(expiration.slot)
+ }
+
+ fn level_for(&self, when: u64) -> usize {
+ level_for(self.elapsed, when)
+ }
+}
+
+fn level_for(elapsed: u64, when: u64) -> usize {
+ const SLOT_MASK: u64 = (1 << 6) - 1;
+
+ // Mask in the trailing bits ignored by the level calculation in order to cap
+ // the possible leading zeros
+ let mut masked = elapsed ^ when | SLOT_MASK;
+ if masked >= MAX_DURATION {
+ // Fudge the timer into the top level
+ masked = MAX_DURATION - 1;
+ }
+ let leading_zeros = masked.leading_zeros() as usize;
+ let significant = 63 - leading_zeros;
+ significant / 6
+}
+
+#[cfg(all(test, not(loom)))]
+mod test {
+ use super::*;
+
+ #[test]
+ fn test_level_for() {
+ for pos in 0..64 {
+ assert_eq!(
+ 0,
+ level_for(0, pos),
+ "level_for({}) -- binary = {:b}",
+ pos,
+ pos
+ );
+ }
+
+ for level in 1..5 {
+ for pos in level..64 {
+ let a = pos * 64_usize.pow(level as u32);
+ assert_eq!(
+ level,
+ level_for(0, a as u64),
+ "level_for({}) -- binary = {:b}",
+ a,
+ a
+ );
+
+ if pos > level {
+ let a = a - 1;
+ assert_eq!(
+ level,
+ level_for(0, a as u64),
+ "level_for({}) -- binary = {:b}",
+ a,
+ a
+ );
+ }
+
+ if pos < 64 {
+ let a = a + 1;
+ assert_eq!(
+ level,
+ level_for(0, a as u64),
+ "level_for({}) -- binary = {:b}",
+ a,
+ a
+ );
+ }
+ }
+ }
+ }
+}
diff --git a/crates/tokio-util/src/time/wheel/stack.rs b/crates/tokio-util/src/time/wheel/stack.rs
new file mode 100644
index 0000000..7d32f27
--- /dev/null
+++ b/crates/tokio-util/src/time/wheel/stack.rs
@@ -0,0 +1,31 @@
+use std::borrow::Borrow;
+use std::cmp::Eq;
+use std::hash::Hash;
+
+/// Abstracts the stack operations needed to track timeouts.
+pub(crate) trait Stack: Default {
+ /// Type of the item stored in the stack
+ type Owned: Borrow<Self::Borrowed>;
+
+ /// Borrowed item
+ type Borrowed: Eq + Hash;
+
+ /// Item storage, this allows a slab to be used instead of just the heap
+ type Store;
+
+ /// Returns `true` if the stack is empty
+ fn is_empty(&self) -> bool;
+
+ /// Push an item onto the stack
+ fn push(&mut self, item: Self::Owned, store: &mut Self::Store);
+
+ /// Pop an item from the stack
+ fn pop(&mut self, store: &mut Self::Store) -> Option<Self::Owned>;
+
+ /// Peek into the stack.
+ fn peek(&self) -> Option<Self::Owned>;
+
+ fn remove(&mut self, item: &Self::Borrowed, store: &mut Self::Store);
+
+ fn when(item: &Self::Borrowed, store: &Self::Store) -> u64;
+}
diff --git a/crates/tokio-util/src/udp/frame.rs b/crates/tokio-util/src/udp/frame.rs
new file mode 100644
index 0000000..d094c04
--- /dev/null
+++ b/crates/tokio-util/src/udp/frame.rs
@@ -0,0 +1,249 @@
+use crate::codec::{Decoder, Encoder};
+
+use futures_core::Stream;
+use tokio::{io::ReadBuf, net::UdpSocket};
+
+use bytes::{BufMut, BytesMut};
+use futures_core::ready;
+use futures_sink::Sink;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use std::{
+ borrow::Borrow,
+ net::{Ipv4Addr, SocketAddr, SocketAddrV4},
+};
+use std::{io, mem::MaybeUninit};
+
+/// A unified [`Stream`] and [`Sink`] interface to an underlying `UdpSocket`, using
+/// the `Encoder` and `Decoder` traits to encode and decode frames.
+///
+/// Raw UDP sockets work with datagrams, but higher-level code usually wants to
+/// batch these into meaningful chunks, called "frames". This method layers
+/// framing on top of this socket by using the `Encoder` and `Decoder` traits to
+/// handle encoding and decoding of messages frames. Note that the incoming and
+/// outgoing frame types may be distinct.
+///
+/// This function returns a *single* object that is both [`Stream`] and [`Sink`];
+/// grouping this into a single object is often useful for layering things which
+/// require both read and write access to the underlying object.
+///
+/// If you want to work more directly with the streams and sink, consider
+/// calling [`split`] on the `UdpFramed` returned by this method, which will break
+/// them into separate objects, allowing them to interact more easily.
+///
+/// [`Stream`]: futures_core::Stream
+/// [`Sink`]: futures_sink::Sink
+/// [`split`]: https://docs.rs/futures/0.3/futures/stream/trait.StreamExt.html#method.split
+#[must_use = "sinks do nothing unless polled"]
+#[derive(Debug)]
+pub struct UdpFramed<C, T = UdpSocket> {
+ socket: T,
+ codec: C,
+ rd: BytesMut,
+ wr: BytesMut,
+ out_addr: SocketAddr,
+ flushed: bool,
+ is_readable: bool,
+ current_addr: Option<SocketAddr>,
+}
+
+const INITIAL_RD_CAPACITY: usize = 64 * 1024;
+const INITIAL_WR_CAPACITY: usize = 8 * 1024;
+
+impl<C, T> Unpin for UdpFramed<C, T> {}
+
+impl<C, T> Stream for UdpFramed<C, T>
+where
+ T: Borrow<UdpSocket>,
+ C: Decoder,
+{
+ type Item = Result<(C::Item, SocketAddr), C::Error>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ let pin = self.get_mut();
+
+ pin.rd.reserve(INITIAL_RD_CAPACITY);
+
+ loop {
+ // Are there still bytes left in the read buffer to decode?
+ if pin.is_readable {
+ if let Some(frame) = pin.codec.decode_eof(&mut pin.rd)? {
+ let current_addr = pin
+ .current_addr
+ .expect("will always be set before this line is called");
+
+ return Poll::Ready(Some(Ok((frame, current_addr))));
+ }
+
+ // if this line has been reached then decode has returned `None`.
+ pin.is_readable = false;
+ pin.rd.clear();
+ }
+
+ // We're out of data. Try and fetch more data to decode
+ let addr = {
+ // Safety: `chunk_mut()` returns a `&mut UninitSlice`, and `UninitSlice` is a
+ // transparent wrapper around `[MaybeUninit<u8>]`.
+ let buf = unsafe { &mut *(pin.rd.chunk_mut() as *mut _ as *mut [MaybeUninit<u8>]) };
+ let mut read = ReadBuf::uninit(buf);
+ let ptr = read.filled().as_ptr();
+ let res = ready!(pin.socket.borrow().poll_recv_from(cx, &mut read));
+
+ assert_eq!(ptr, read.filled().as_ptr());
+ let addr = res?;
+
+ // Safety: This is guaranteed to be the number of initialized (and read) bytes due
+ // to the invariants provided by `ReadBuf::filled`.
+ unsafe { pin.rd.advance_mut(read.filled().len()) };
+
+ addr
+ };
+
+ pin.current_addr = Some(addr);
+ pin.is_readable = true;
+ }
+ }
+}
+
+impl<I, C, T> Sink<(I, SocketAddr)> for UdpFramed<C, T>
+where
+ T: Borrow<UdpSocket>,
+ C: Encoder<I>,
+{
+ type Error = C::Error;
+
+ fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if !self.flushed {
+ match self.poll_flush(cx)? {
+ Poll::Ready(()) => {}
+ Poll::Pending => return Poll::Pending,
+ }
+ }
+
+ Poll::Ready(Ok(()))
+ }
+
+ fn start_send(self: Pin<&mut Self>, item: (I, SocketAddr)) -> Result<(), Self::Error> {
+ let (frame, out_addr) = item;
+
+ let pin = self.get_mut();
+
+ pin.codec.encode(frame, &mut pin.wr)?;
+ pin.out_addr = out_addr;
+ pin.flushed = false;
+
+ Ok(())
+ }
+
+ fn poll_flush(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if self.flushed {
+ return Poll::Ready(Ok(()));
+ }
+
+ let Self {
+ ref socket,
+ ref mut out_addr,
+ ref mut wr,
+ ..
+ } = *self;
+
+ let n = ready!(socket.borrow().poll_send_to(cx, wr, *out_addr))?;
+
+ let wrote_all = n == self.wr.len();
+ self.wr.clear();
+ self.flushed = true;
+
+ let res = if wrote_all {
+ Ok(())
+ } else {
+ Err(io::Error::new(
+ io::ErrorKind::Other,
+ "failed to write entire datagram to socket",
+ )
+ .into())
+ };
+
+ Poll::Ready(res)
+ }
+
+ fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ ready!(self.poll_flush(cx))?;
+ Poll::Ready(Ok(()))
+ }
+}
+
+impl<C, T> UdpFramed<C, T>
+where
+ T: Borrow<UdpSocket>,
+{
+ /// Create a new `UdpFramed` backed by the given socket and codec.
+ ///
+ /// See struct level documentation for more details.
+ pub fn new(socket: T, codec: C) -> UdpFramed<C, T> {
+ Self {
+ socket,
+ codec,
+ out_addr: SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::new(0, 0, 0, 0), 0)),
+ rd: BytesMut::with_capacity(INITIAL_RD_CAPACITY),
+ wr: BytesMut::with_capacity(INITIAL_WR_CAPACITY),
+ flushed: true,
+ is_readable: false,
+ current_addr: None,
+ }
+ }
+
+ /// Returns a reference to the underlying I/O stream wrapped by `Framed`.
+ ///
+ /// # Note
+ ///
+ /// Care should be taken to not tamper with the underlying stream of data
+ /// coming in as it may corrupt the stream of frames otherwise being worked
+ /// with.
+ pub fn get_ref(&self) -> &T {
+ &self.socket
+ }
+
+ /// Returns a mutable reference to the underlying I/O stream wrapped by `Framed`.
+ ///
+ /// # Note
+ ///
+ /// Care should be taken to not tamper with the underlying stream of data
+ /// coming in as it may corrupt the stream of frames otherwise being worked
+ /// with.
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.socket
+ }
+
+ /// Returns a reference to the underlying codec wrapped by
+ /// `Framed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn codec(&self) -> &C {
+ &self.codec
+ }
+
+ /// Returns a mutable reference to the underlying codec wrapped by
+ /// `UdpFramed`.
+ ///
+ /// Note that care should be taken to not tamper with the underlying codec
+ /// as it may corrupt the stream of frames otherwise being worked with.
+ pub fn codec_mut(&mut self) -> &mut C {
+ &mut self.codec
+ }
+
+ /// Returns a reference to the read buffer.
+ pub fn read_buffer(&self) -> &BytesMut {
+ &self.rd
+ }
+
+ /// Returns a mutable reference to the read buffer.
+ pub fn read_buffer_mut(&mut self) -> &mut BytesMut {
+ &mut self.rd
+ }
+
+ /// Consumes the `Framed`, returning its underlying I/O stream.
+ pub fn into_inner(self) -> T {
+ self.socket
+ }
+}
diff --git a/crates/tokio-util/src/udp/mod.rs b/crates/tokio-util/src/udp/mod.rs
new file mode 100644
index 0000000..f88ea03
--- /dev/null
+++ b/crates/tokio-util/src/udp/mod.rs
@@ -0,0 +1,4 @@
+//! UDP framing
+
+mod frame;
+pub use frame::UdpFramed;
diff --git a/crates/tokio-util/src/util/maybe_dangling.rs b/crates/tokio-util/src/util/maybe_dangling.rs
new file mode 100644
index 0000000..c29a089
--- /dev/null
+++ b/crates/tokio-util/src/util/maybe_dangling.rs
@@ -0,0 +1,67 @@
+use core::future::Future;
+use core::mem::MaybeUninit;
+use core::pin::Pin;
+use core::task::{Context, Poll};
+
+/// A wrapper type that tells the compiler that the contents might not be valid.
+///
+/// This is necessary mainly when `T` contains a reference. In that case, the
+/// compiler will sometimes assume that the reference is always valid; in some
+/// cases it will assume this even after the destructor of `T` runs. For
+/// example, when a reference is used as a function argument, then the compiler
+/// will assume that the reference is valid until the function returns, even if
+/// the reference is destroyed during the function. When the reference is used
+/// as part of a self-referential struct, that assumption can be false. Wrapping
+/// the reference in this type prevents the compiler from making that
+/// assumption.
+///
+/// # Invariants
+///
+/// The `MaybeUninit` will always contain a valid value until the destructor runs.
+//
+// Reference
+// See <https://users.rust-lang.org/t/unsafe-code-review-semi-owning-weak-rwlock-t-guard/95706>
+//
+// TODO: replace this with an official solution once RFC #3336 or similar is available.
+// <https://github.com/rust-lang/rfcs/pull/3336>
+#[repr(transparent)]
+pub(crate) struct MaybeDangling<T>(MaybeUninit<T>);
+
+impl<T> Drop for MaybeDangling<T> {
+ fn drop(&mut self) {
+ // Safety: `0` is always initialized.
+ unsafe { core::ptr::drop_in_place(self.0.as_mut_ptr()) };
+ }
+}
+
+impl<T> MaybeDangling<T> {
+ pub(crate) fn new(inner: T) -> Self {
+ Self(MaybeUninit::new(inner))
+ }
+}
+
+impl<F: Future> Future for MaybeDangling<F> {
+ type Output = F::Output;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ // Safety: `0` is always initialized.
+ let fut = unsafe { self.map_unchecked_mut(|this| this.0.assume_init_mut()) };
+ fut.poll(cx)
+ }
+}
+
+#[test]
+fn maybedangling_runs_drop() {
+ struct SetOnDrop<'a>(&'a mut bool);
+
+ impl Drop for SetOnDrop<'_> {
+ fn drop(&mut self) {
+ *self.0 = true;
+ }
+ }
+
+ let mut success = false;
+
+ drop(MaybeDangling::new(SetOnDrop(&mut success)));
+ assert!(success);
+}
diff --git a/crates/tokio-util/src/util/mod.rs b/crates/tokio-util/src/util/mod.rs
new file mode 100644
index 0000000..a17f25a
--- /dev/null
+++ b/crates/tokio-util/src/util/mod.rs
@@ -0,0 +1,8 @@
+mod maybe_dangling;
+#[cfg(any(feature = "io", feature = "codec"))]
+mod poll_buf;
+
+pub(crate) use maybe_dangling::MaybeDangling;
+#[cfg(any(feature = "io", feature = "codec"))]
+#[cfg_attr(not(feature = "io"), allow(unreachable_pub))]
+pub use poll_buf::{poll_read_buf, poll_write_buf};
diff --git a/crates/tokio-util/src/util/poll_buf.rs b/crates/tokio-util/src/util/poll_buf.rs
new file mode 100644
index 0000000..82af1bb
--- /dev/null
+++ b/crates/tokio-util/src/util/poll_buf.rs
@@ -0,0 +1,145 @@
+use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
+
+use bytes::{Buf, BufMut};
+use futures_core::ready;
+use std::io::{self, IoSlice};
+use std::mem::MaybeUninit;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+/// Try to read data from an `AsyncRead` into an implementer of the [`BufMut`] trait.
+///
+/// [`BufMut`]: bytes::Buf
+///
+/// # Example
+///
+/// ```
+/// use bytes::{Bytes, BytesMut};
+/// use tokio_stream as stream;
+/// use tokio::io::Result;
+/// use tokio_util::io::{StreamReader, poll_read_buf};
+/// use futures::future::poll_fn;
+/// use std::pin::Pin;
+/// # #[tokio::main]
+/// # async fn main() -> std::io::Result<()> {
+///
+/// // Create a reader from an iterator. This particular reader will always be
+/// // ready.
+/// let mut read = StreamReader::new(stream::iter(vec![Result::Ok(Bytes::from_static(&[0, 1, 2, 3]))]));
+///
+/// let mut buf = BytesMut::new();
+/// let mut reads = 0;
+///
+/// loop {
+/// reads += 1;
+/// let n = poll_fn(|cx| poll_read_buf(Pin::new(&mut read), cx, &mut buf)).await?;
+///
+/// if n == 0 {
+/// break;
+/// }
+/// }
+///
+/// // one or more reads might be necessary.
+/// assert!(reads >= 1);
+/// assert_eq!(&buf[..], &[0, 1, 2, 3]);
+/// # Ok(())
+/// # }
+/// ```
+#[cfg_attr(not(feature = "io"), allow(unreachable_pub))]
+pub fn poll_read_buf<T: AsyncRead, B: BufMut>(
+ io: Pin<&mut T>,
+ cx: &mut Context<'_>,
+ buf: &mut B,
+) -> Poll<io::Result<usize>> {
+ if !buf.has_remaining_mut() {
+ return Poll::Ready(Ok(0));
+ }
+
+ let n = {
+ let dst = buf.chunk_mut();
+
+ // Safety: `chunk_mut()` returns a `&mut UninitSlice`, and `UninitSlice` is a
+ // transparent wrapper around `[MaybeUninit<u8>]`.
+ let dst = unsafe { &mut *(dst as *mut _ as *mut [MaybeUninit<u8>]) };
+ let mut buf = ReadBuf::uninit(dst);
+ let ptr = buf.filled().as_ptr();
+ ready!(io.poll_read(cx, &mut buf)?);
+
+ // Ensure the pointer does not change from under us
+ assert_eq!(ptr, buf.filled().as_ptr());
+ buf.filled().len()
+ };
+
+ // Safety: This is guaranteed to be the number of initialized (and read)
+ // bytes due to the invariants provided by `ReadBuf::filled`.
+ unsafe {
+ buf.advance_mut(n);
+ }
+
+ Poll::Ready(Ok(n))
+}
+
+/// Try to write data from an implementer of the [`Buf`] trait to an
+/// [`AsyncWrite`], advancing the buffer's internal cursor.
+///
+/// This function will use [vectored writes] when the [`AsyncWrite`] supports
+/// vectored writes.
+///
+/// # Examples
+///
+/// [`File`] implements [`AsyncWrite`] and [`Cursor<&[u8]>`] implements
+/// [`Buf`]:
+///
+/// ```no_run
+/// use tokio_util::io::poll_write_buf;
+/// use tokio::io;
+/// use tokio::fs::File;
+///
+/// use bytes::Buf;
+/// use std::io::Cursor;
+/// use std::pin::Pin;
+/// use futures::future::poll_fn;
+///
+/// #[tokio::main]
+/// async fn main() -> io::Result<()> {
+/// let mut file = File::create("foo.txt").await?;
+/// let mut buf = Cursor::new(b"data to write");
+///
+/// // Loop until the entire contents of the buffer are written to
+/// // the file.
+/// while buf.has_remaining() {
+/// poll_fn(|cx| poll_write_buf(Pin::new(&mut file), cx, &mut buf)).await?;
+/// }
+///
+/// Ok(())
+/// }
+/// ```
+///
+/// [`Buf`]: bytes::Buf
+/// [`AsyncWrite`]: tokio::io::AsyncWrite
+/// [`File`]: tokio::fs::File
+/// [vectored writes]: tokio::io::AsyncWrite::poll_write_vectored
+#[cfg_attr(not(feature = "io"), allow(unreachable_pub))]
+pub fn poll_write_buf<T: AsyncWrite, B: Buf>(
+ io: Pin<&mut T>,
+ cx: &mut Context<'_>,
+ buf: &mut B,
+) -> Poll<io::Result<usize>> {
+ const MAX_BUFS: usize = 64;
+
+ if !buf.has_remaining() {
+ return Poll::Ready(Ok(0));
+ }
+
+ let n = if io.is_write_vectored() {
+ let mut slices = [IoSlice::new(&[]); MAX_BUFS];
+ let cnt = buf.chunks_vectored(&mut slices);
+ ready!(io.poll_write_vectored(cx, &slices[..cnt]))?
+ } else {
+ ready!(io.poll_write(cx, buf.chunk()))?
+ };
+
+ buf.advance(n);
+
+ Poll::Ready(Ok(n))
+}
diff --git a/crates/tokio-util/tests/_require_full.rs b/crates/tokio-util/tests/_require_full.rs
new file mode 100644
index 0000000..045934d
--- /dev/null
+++ b/crates/tokio-util/tests/_require_full.rs
@@ -0,0 +1,2 @@
+#![cfg(not(feature = "full"))]
+compile_error!("run tokio-util tests with `--features full`");
diff --git a/crates/tokio-util/tests/codecs.rs b/crates/tokio-util/tests/codecs.rs
new file mode 100644
index 0000000..f9a7801
--- /dev/null
+++ b/crates/tokio-util/tests/codecs.rs
@@ -0,0 +1,464 @@
+#![warn(rust_2018_idioms)]
+
+use tokio_util::codec::{AnyDelimiterCodec, BytesCodec, Decoder, Encoder, LinesCodec};
+
+use bytes::{BufMut, Bytes, BytesMut};
+
+#[test]
+fn bytes_decoder() {
+ let mut codec = BytesCodec::new();
+ let buf = &mut BytesMut::new();
+ buf.put_slice(b"abc");
+ assert_eq!("abc", codec.decode(buf).unwrap().unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"a");
+ assert_eq!("a", codec.decode(buf).unwrap().unwrap());
+}
+
+#[test]
+fn bytes_encoder() {
+ let mut codec = BytesCodec::new();
+
+ // Default capacity of BytesMut
+ #[cfg(target_pointer_width = "64")]
+ const INLINE_CAP: usize = 4 * 8 - 1;
+ #[cfg(target_pointer_width = "32")]
+ const INLINE_CAP: usize = 4 * 4 - 1;
+
+ let mut buf = BytesMut::new();
+ codec
+ .encode(Bytes::from_static(&[0; INLINE_CAP + 1]), &mut buf)
+ .unwrap();
+
+ // Default capacity of Framed Read
+ const INITIAL_CAPACITY: usize = 8 * 1024;
+
+ let mut buf = BytesMut::with_capacity(INITIAL_CAPACITY);
+ codec
+ .encode(Bytes::from_static(&[0; INITIAL_CAPACITY + 1]), &mut buf)
+ .unwrap();
+ codec
+ .encode(BytesMut::from(&b"hello"[..]), &mut buf)
+ .unwrap();
+}
+
+#[test]
+fn lines_decoder() {
+ let mut codec = LinesCodec::new();
+ let buf = &mut BytesMut::new();
+ buf.reserve(200);
+ buf.put_slice(b"line 1\nline 2\r\nline 3\n\r\n\r");
+ assert_eq!("line 1", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("line 2", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("line 3", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("", codec.decode(buf).unwrap().unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+ buf.put_slice(b"k");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!("\rk", codec.decode_eof(buf).unwrap().unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+}
+
+#[test]
+fn lines_decoder_max_length() {
+ const MAX_LENGTH: usize = 6;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"line 1 is too long\nline 2\nline 3\r\nline 4\n\r\n\r");
+
+ assert!(codec.decode(buf).is_err());
+
+ let line = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ line.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ line,
+ MAX_LENGTH
+ );
+ assert_eq!("line 2", line);
+
+ assert!(codec.decode(buf).is_err());
+
+ let line = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ line.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ line,
+ MAX_LENGTH
+ );
+ assert_eq!("line 4", line);
+
+ let line = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ line.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ line,
+ MAX_LENGTH
+ );
+ assert_eq!("", line);
+
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+ buf.put_slice(b"k");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ let line = codec.decode_eof(buf).unwrap().unwrap();
+ assert!(
+ line.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ line,
+ MAX_LENGTH
+ );
+ assert_eq!("\rk", line);
+
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+
+ // Line that's one character too long. This could cause an out of bounds
+ // error if we peek at the next characters using slice indexing.
+ buf.put_slice(b"aaabbbc");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn lines_decoder_max_length_underrun() {
+ const MAX_LENGTH: usize = 6;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"line ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too l");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"ong\n");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ buf.put_slice(b"line 2");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"\n");
+ assert_eq!("line 2", codec.decode(buf).unwrap().unwrap());
+}
+
+#[test]
+fn lines_decoder_max_length_bursts() {
+ const MAX_LENGTH: usize = 10;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"line ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too l");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"ong\n");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn lines_decoder_max_length_big_burst() {
+ const MAX_LENGTH: usize = 10;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"line ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too long!\n");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn lines_decoder_max_length_newline_between_decodes() {
+ const MAX_LENGTH: usize = 5;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"hello");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ buf.put_slice(b"\nworld");
+ assert_eq!("hello", codec.decode(buf).unwrap().unwrap());
+}
+
+// Regression test for [infinite loop bug](https://github.com/tokio-rs/tokio/issues/1483)
+#[test]
+fn lines_decoder_discard_repeat() {
+ const MAX_LENGTH: usize = 1;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"aa");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"a");
+ assert_eq!(None, codec.decode(buf).unwrap());
+}
+
+// Regression test for [subsequent calls to LinesCodec decode does not return the desired results bug](https://github.com/tokio-rs/tokio/issues/3555)
+#[test]
+fn lines_decoder_max_length_underrun_twice() {
+ const MAX_LENGTH: usize = 11;
+
+ let mut codec = LinesCodec::new_with_max_length(MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"line ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too very l");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"aaaaaaaaaaaaaaaaaaaaaaa");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"ong\nshort\n");
+ assert_eq!("short", codec.decode(buf).unwrap().unwrap());
+}
+
+#[test]
+fn lines_encoder() {
+ let mut codec = LinesCodec::new();
+ let mut buf = BytesMut::new();
+
+ codec.encode("line 1", &mut buf).unwrap();
+ assert_eq!("line 1\n", buf);
+
+ codec.encode("line 2", &mut buf).unwrap();
+ assert_eq!("line 1\nline 2\n", buf);
+}
+
+#[test]
+fn any_delimiters_decoder_any_character() {
+ let mut codec = AnyDelimiterCodec::new(b",;\n\r".to_vec(), b",".to_vec());
+ let buf = &mut BytesMut::new();
+ buf.reserve(200);
+ buf.put_slice(b"chunk 1,chunk 2;chunk 3\n\r");
+ assert_eq!("chunk 1", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("chunk 2", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("chunk 3", codec.decode(buf).unwrap().unwrap());
+ assert_eq!("", codec.decode(buf).unwrap().unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+ buf.put_slice(b"k");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!("k", codec.decode_eof(buf).unwrap().unwrap());
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+}
+
+#[test]
+fn any_delimiters_decoder_max_length() {
+ const MAX_LENGTH: usize = 7;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"chunk 1 is too long\nchunk 2\nchunk 3\r\nchunk 4\n\r\n");
+
+ assert!(codec.decode(buf).is_err());
+
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("chunk 2", chunk);
+
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("chunk 3", chunk);
+
+ // \r\n cause empty chunk
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("", chunk);
+
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("chunk 4", chunk);
+
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("", chunk);
+
+ let chunk = codec.decode(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("", chunk);
+
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+ buf.put_slice(b"k");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ let chunk = codec.decode_eof(buf).unwrap().unwrap();
+ assert!(
+ chunk.len() <= MAX_LENGTH,
+ "{:?}.len() <= {:?}",
+ chunk,
+ MAX_LENGTH
+ );
+ assert_eq!("k", chunk);
+
+ assert_eq!(None, codec.decode(buf).unwrap());
+ assert_eq!(None, codec.decode_eof(buf).unwrap());
+
+ // Delimiter that's one character too long. This could cause an out of bounds
+ // error if we peek at the next characters using slice indexing.
+ buf.put_slice(b"aaabbbcc");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn any_delimiter_decoder_max_length_underrun() {
+ const MAX_LENGTH: usize = 7;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"chunk ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too l");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"ong\n");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ buf.put_slice(b"chunk 2");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b",");
+ assert_eq!("chunk 2", codec.decode(buf).unwrap().unwrap());
+}
+
+#[test]
+fn any_delimiter_decoder_max_length_underrun_twice() {
+ const MAX_LENGTH: usize = 11;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"chunk ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too very l");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"aaaaaaaaaaaaaaaaaaaaaaa");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"ong\nshort\n");
+ assert_eq!("short", codec.decode(buf).unwrap().unwrap());
+}
+#[test]
+fn any_delimiter_decoder_max_length_bursts() {
+ const MAX_LENGTH: usize = 11;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"chunk ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too l");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"ong\n");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn any_delimiter_decoder_max_length_big_burst() {
+ const MAX_LENGTH: usize = 11;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"chunk ");
+ assert_eq!(None, codec.decode(buf).unwrap());
+ buf.put_slice(b"too long!\n");
+ assert!(codec.decode(buf).is_err());
+}
+
+#[test]
+fn any_delimiter_decoder_max_length_delimiter_between_decodes() {
+ const MAX_LENGTH: usize = 5;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"hello");
+ assert_eq!(None, codec.decode(buf).unwrap());
+
+ buf.put_slice(b",world");
+ assert_eq!("hello", codec.decode(buf).unwrap().unwrap());
+}
+
+#[test]
+fn any_delimiter_decoder_discard_repeat() {
+ const MAX_LENGTH: usize = 1;
+
+ let mut codec =
+ AnyDelimiterCodec::new_with_max_length(b",;\n\r".to_vec(), b",".to_vec(), MAX_LENGTH);
+ let buf = &mut BytesMut::new();
+
+ buf.reserve(200);
+ buf.put_slice(b"aa");
+ assert!(codec.decode(buf).is_err());
+ buf.put_slice(b"a");
+ assert_eq!(None, codec.decode(buf).unwrap());
+}
+
+#[test]
+fn any_delimiter_encoder() {
+ let mut codec = AnyDelimiterCodec::new(b",".to_vec(), b";--;".to_vec());
+ let mut buf = BytesMut::new();
+
+ codec.encode("chunk 1", &mut buf).unwrap();
+ assert_eq!("chunk 1;--;", buf);
+
+ codec.encode("chunk 2", &mut buf).unwrap();
+ assert_eq!("chunk 1;--;chunk 2;--;", buf);
+}
diff --git a/crates/tokio-util/tests/compat.rs b/crates/tokio-util/tests/compat.rs
new file mode 100644
index 0000000..278ebfc
--- /dev/null
+++ b/crates/tokio-util/tests/compat.rs
@@ -0,0 +1,43 @@
+#![cfg(all(feature = "compat"))]
+#![cfg(not(target_os = "wasi"))] // WASI does not support all fs operations
+#![warn(rust_2018_idioms)]
+
+use futures_io::SeekFrom;
+use futures_util::{AsyncReadExt, AsyncSeekExt, AsyncWriteExt};
+use tempfile::NamedTempFile;
+use tokio::fs::OpenOptions;
+use tokio_util::compat::TokioAsyncWriteCompatExt;
+
+#[tokio::test]
+async fn compat_file_seek() -> futures_util::io::Result<()> {
+ let temp_file = NamedTempFile::new()?;
+ let mut file = OpenOptions::new()
+ .read(true)
+ .write(true)
+ .create(true)
+ .open(temp_file)
+ .await?
+ .compat_write();
+
+ file.write_all(&[0, 1, 2, 3, 4, 5]).await?;
+ file.write_all(&[6, 7]).await?;
+
+ assert_eq!(file.stream_position().await?, 8);
+
+ // Modify elements at position 2.
+ assert_eq!(file.seek(SeekFrom::Start(2)).await?, 2);
+ file.write_all(&[8, 9]).await?;
+
+ file.flush().await?;
+
+ // Verify we still have 8 elements.
+ assert_eq!(file.seek(SeekFrom::End(0)).await?, 8);
+ // Seek back to the start of the file to read and verify contents.
+ file.seek(SeekFrom::Start(0)).await?;
+
+ let mut buf = Vec::new();
+ let num_bytes = file.read_to_end(&mut buf).await?;
+ assert_eq!(&buf[..num_bytes], &[0, 1, 8, 9, 4, 5, 6, 7]);
+
+ Ok(())
+}
diff --git a/crates/tokio-util/tests/context.rs b/crates/tokio-util/tests/context.rs
new file mode 100644
index 0000000..2ec8258
--- /dev/null
+++ b/crates/tokio-util/tests/context.rs
@@ -0,0 +1,25 @@
+#![cfg(feature = "rt")]
+#![cfg(not(target_os = "wasi"))] // Wasi doesn't support threads
+#![warn(rust_2018_idioms)]
+
+use tokio::runtime::Builder;
+use tokio::time::*;
+use tokio_util::context::RuntimeExt;
+
+#[test]
+fn tokio_context_with_another_runtime() {
+ let rt1 = Builder::new_multi_thread()
+ .worker_threads(1)
+ // no timer!
+ .build()
+ .unwrap();
+ let rt2 = Builder::new_multi_thread()
+ .worker_threads(1)
+ .enable_all()
+ .build()
+ .unwrap();
+
+ // Without the `HandleExt.wrap()` there would be a panic because there is
+ // no timer running, since it would be referencing runtime r1.
+ rt1.block_on(rt2.wrap(async move { sleep(Duration::from_millis(2)).await }));
+}
diff --git a/crates/tokio-util/tests/framed.rs b/crates/tokio-util/tests/framed.rs
new file mode 100644
index 0000000..ec8cdf0
--- /dev/null
+++ b/crates/tokio-util/tests/framed.rs
@@ -0,0 +1,152 @@
+#![warn(rust_2018_idioms)]
+
+use tokio_stream::StreamExt;
+use tokio_test::assert_ok;
+use tokio_util::codec::{Decoder, Encoder, Framed, FramedParts};
+
+use bytes::{Buf, BufMut, BytesMut};
+use std::io::{self, Read};
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+const INITIAL_CAPACITY: usize = 8 * 1024;
+
+/// Encode and decode u32 values.
+#[derive(Default)]
+struct U32Codec {
+ read_bytes: usize,
+}
+
+impl Decoder for U32Codec {
+ type Item = u32;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> io::Result<Option<u32>> {
+ if buf.len() < 4 {
+ return Ok(None);
+ }
+
+ let n = buf.split_to(4).get_u32();
+ self.read_bytes += 4;
+ Ok(Some(n))
+ }
+}
+
+impl Encoder<u32> for U32Codec {
+ type Error = io::Error;
+
+ fn encode(&mut self, item: u32, dst: &mut BytesMut) -> io::Result<()> {
+ // Reserve space
+ dst.reserve(4);
+ dst.put_u32(item);
+ Ok(())
+ }
+}
+
+/// Encode and decode u64 values.
+#[derive(Default)]
+struct U64Codec {
+ read_bytes: usize,
+}
+
+impl Decoder for U64Codec {
+ type Item = u64;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> io::Result<Option<u64>> {
+ if buf.len() < 8 {
+ return Ok(None);
+ }
+
+ let n = buf.split_to(8).get_u64();
+ self.read_bytes += 8;
+ Ok(Some(n))
+ }
+}
+
+impl Encoder<u64> for U64Codec {
+ type Error = io::Error;
+
+ fn encode(&mut self, item: u64, dst: &mut BytesMut) -> io::Result<()> {
+ // Reserve space
+ dst.reserve(8);
+ dst.put_u64(item);
+ Ok(())
+ }
+}
+
+/// This value should never be used
+struct DontReadIntoThis;
+
+impl Read for DontReadIntoThis {
+ fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
+ Err(io::Error::new(
+ io::ErrorKind::Other,
+ "Read into something you weren't supposed to.",
+ ))
+ }
+}
+
+impl tokio::io::AsyncRead for DontReadIntoThis {
+ fn poll_read(
+ self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ _buf: &mut tokio::io::ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ unreachable!()
+ }
+}
+
+#[tokio::test]
+async fn can_read_from_existing_buf() {
+ let mut parts = FramedParts::new(DontReadIntoThis, U32Codec::default());
+ parts.read_buf = BytesMut::from(&[0, 0, 0, 42][..]);
+
+ let mut framed = Framed::from_parts(parts);
+ let num = assert_ok!(framed.next().await.unwrap());
+
+ assert_eq!(num, 42);
+ assert_eq!(framed.codec().read_bytes, 4);
+}
+
+#[tokio::test]
+async fn can_read_from_existing_buf_after_codec_changed() {
+ let mut parts = FramedParts::new(DontReadIntoThis, U32Codec::default());
+ parts.read_buf = BytesMut::from(&[0, 0, 0, 42, 0, 0, 0, 0, 0, 0, 0, 84][..]);
+
+ let mut framed = Framed::from_parts(parts);
+ let num = assert_ok!(framed.next().await.unwrap());
+
+ assert_eq!(num, 42);
+ assert_eq!(framed.codec().read_bytes, 4);
+
+ let mut framed = framed.map_codec(|codec| U64Codec {
+ read_bytes: codec.read_bytes,
+ });
+ let num = assert_ok!(framed.next().await.unwrap());
+
+ assert_eq!(num, 84);
+ assert_eq!(framed.codec().read_bytes, 12);
+}
+
+#[test]
+fn external_buf_grows_to_init() {
+ let mut parts = FramedParts::new(DontReadIntoThis, U32Codec::default());
+ parts.read_buf = BytesMut::from(&[0, 0, 0, 42][..]);
+
+ let framed = Framed::from_parts(parts);
+ let FramedParts { read_buf, .. } = framed.into_parts();
+
+ assert_eq!(read_buf.capacity(), INITIAL_CAPACITY);
+}
+
+#[test]
+fn external_buf_does_not_shrink() {
+ let mut parts = FramedParts::new(DontReadIntoThis, U32Codec::default());
+ parts.read_buf = BytesMut::from(&vec![0; INITIAL_CAPACITY * 2][..]);
+
+ let framed = Framed::from_parts(parts);
+ let FramedParts { read_buf, .. } = framed.into_parts();
+
+ assert_eq!(read_buf.capacity(), INITIAL_CAPACITY * 2);
+}
diff --git a/crates/tokio-util/tests/framed_read.rs b/crates/tokio-util/tests/framed_read.rs
new file mode 100644
index 0000000..2a9e27e
--- /dev/null
+++ b/crates/tokio-util/tests/framed_read.rs
@@ -0,0 +1,339 @@
+#![warn(rust_2018_idioms)]
+
+use tokio::io::{AsyncRead, ReadBuf};
+use tokio_test::assert_ready;
+use tokio_test::task;
+use tokio_util::codec::{Decoder, FramedRead};
+
+use bytes::{Buf, BytesMut};
+use futures::Stream;
+use std::collections::VecDeque;
+use std::io;
+use std::pin::Pin;
+use std::task::Poll::{Pending, Ready};
+use std::task::{Context, Poll};
+
+macro_rules! mock {
+ ($($x:expr,)*) => {{
+ let mut v = VecDeque::new();
+ v.extend(vec![$($x),*]);
+ Mock { calls: v }
+ }};
+}
+
+macro_rules! assert_read {
+ ($e:expr, $n:expr) => {{
+ let val = assert_ready!($e);
+ assert_eq!(val.unwrap().unwrap(), $n);
+ }};
+}
+
+macro_rules! pin {
+ ($id:ident) => {
+ Pin::new(&mut $id)
+ };
+}
+
+struct U32Decoder;
+
+impl Decoder for U32Decoder {
+ type Item = u32;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> io::Result<Option<u32>> {
+ if buf.len() < 4 {
+ return Ok(None);
+ }
+
+ let n = buf.split_to(4).get_u32();
+ Ok(Some(n))
+ }
+}
+
+struct U64Decoder;
+
+impl Decoder for U64Decoder {
+ type Item = u64;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> io::Result<Option<u64>> {
+ if buf.len() < 8 {
+ return Ok(None);
+ }
+
+ let n = buf.split_to(8).get_u64();
+ Ok(Some(n))
+ }
+}
+
+#[test]
+fn read_multi_frame_in_packet() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x02".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert_read!(pin!(framed).poll_next(cx), 2);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_multi_frame_across_packets() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x00".to_vec()),
+ Ok(b"\x00\x00\x00\x01".to_vec()),
+ Ok(b"\x00\x00\x00\x02".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert_read!(pin!(framed).poll_next(cx), 2);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_multi_frame_in_packet_after_codec_changed() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x08".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0x04);
+
+ let mut framed = framed.map_decoder(|_| U64Decoder);
+ assert_read!(pin!(framed).poll_next(cx), 0x08);
+
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_not_ready() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Err(io::Error::new(io::ErrorKind::WouldBlock, "")),
+ Ok(b"\x00\x00\x00\x00".to_vec()),
+ Ok(b"\x00\x00\x00\x01".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert!(pin!(framed).poll_next(cx).is_pending());
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_partial_then_not_ready() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00".to_vec()),
+ Err(io::Error::new(io::ErrorKind::WouldBlock, "")),
+ Ok(b"\x00\x00\x00\x00\x00\x01\x00\x00\x00\x02".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert!(pin!(framed).poll_next(cx).is_pending());
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert_read!(pin!(framed).poll_next(cx), 2);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_err() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Err(io::Error::new(io::ErrorKind::Other, "")),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_eq!(
+ io::ErrorKind::Other,
+ assert_ready!(pin!(framed).poll_next(cx))
+ .unwrap()
+ .unwrap_err()
+ .kind()
+ )
+ });
+}
+
+#[test]
+fn read_partial_then_err() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00".to_vec()),
+ Err(io::Error::new(io::ErrorKind::Other, "")),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_eq!(
+ io::ErrorKind::Other,
+ assert_ready!(pin!(framed).poll_next(cx))
+ .unwrap()
+ .unwrap_err()
+ .kind()
+ )
+ });
+}
+
+#[test]
+fn read_partial_would_block_then_err() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00".to_vec()),
+ Err(io::Error::new(io::ErrorKind::WouldBlock, "")),
+ Err(io::Error::new(io::ErrorKind::Other, "")),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert!(pin!(framed).poll_next(cx).is_pending());
+ assert_eq!(
+ io::ErrorKind::Other,
+ assert_ready!(pin!(framed).poll_next(cx))
+ .unwrap()
+ .unwrap_err()
+ .kind()
+ )
+ });
+}
+
+#[test]
+fn huge_size() {
+ let mut task = task::spawn(());
+ let data = &[0; 32 * 1024][..];
+ let mut framed = FramedRead::new(data, BigDecoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+
+ struct BigDecoder;
+
+ impl Decoder for BigDecoder {
+ type Item = u32;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> io::Result<Option<u32>> {
+ if buf.len() < 32 * 1024 {
+ return Ok(None);
+ }
+ buf.advance(32 * 1024);
+ Ok(Some(0))
+ }
+ }
+}
+
+#[test]
+fn data_remaining_is_error() {
+ let mut task = task::spawn(());
+ let slice = &[0; 5][..];
+ let mut framed = FramedRead::new(slice, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).unwrap().is_err());
+ });
+}
+
+#[test]
+fn multi_frames_on_eof() {
+ let mut task = task::spawn(());
+ struct MyDecoder(Vec<u32>);
+
+ impl Decoder for MyDecoder {
+ type Item = u32;
+ type Error = io::Error;
+
+ fn decode(&mut self, _buf: &mut BytesMut) -> io::Result<Option<u32>> {
+ unreachable!();
+ }
+
+ fn decode_eof(&mut self, _buf: &mut BytesMut) -> io::Result<Option<u32>> {
+ if self.0.is_empty() {
+ return Ok(None);
+ }
+
+ Ok(Some(self.0.remove(0)))
+ }
+ }
+
+ let mut framed = FramedRead::new(mock!(), MyDecoder(vec![0, 1, 2, 3]));
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 0);
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert_read!(pin!(framed).poll_next(cx), 2);
+ assert_read!(pin!(framed).poll_next(cx), 3);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+#[test]
+fn read_eof_then_resume() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x01".to_vec()),
+ Ok(b"".to_vec()),
+ Ok(b"\x00\x00\x00\x02".to_vec()),
+ Ok(b"".to_vec()),
+ Ok(b"\x00\x00\x00\x03".to_vec()),
+ };
+ let mut framed = FramedRead::new(mock, U32Decoder);
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(framed).poll_next(cx), 1);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ assert_read!(pin!(framed).poll_next(cx), 2);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ assert_read!(pin!(framed).poll_next(cx), 3);
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ assert!(assert_ready!(pin!(framed).poll_next(cx)).is_none());
+ });
+}
+
+// ===== Mock ======
+
+struct Mock {
+ calls: VecDeque<io::Result<Vec<u8>>>,
+}
+
+impl AsyncRead for Mock {
+ fn poll_read(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ use io::ErrorKind::WouldBlock;
+
+ match self.calls.pop_front() {
+ Some(Ok(data)) => {
+ debug_assert!(buf.remaining() >= data.len());
+ buf.put_slice(&data);
+ Ready(Ok(()))
+ }
+ Some(Err(ref e)) if e.kind() == WouldBlock => Pending,
+ Some(Err(e)) => Ready(Err(e)),
+ None => Ready(Ok(())),
+ }
+ }
+}
diff --git a/crates/tokio-util/tests/framed_stream.rs b/crates/tokio-util/tests/framed_stream.rs
new file mode 100644
index 0000000..76d8af7
--- /dev/null
+++ b/crates/tokio-util/tests/framed_stream.rs
@@ -0,0 +1,38 @@
+use futures_core::stream::Stream;
+use std::{io, pin::Pin};
+use tokio_test::{assert_ready, io::Builder, task};
+use tokio_util::codec::{BytesCodec, FramedRead};
+
+macro_rules! pin {
+ ($id:ident) => {
+ Pin::new(&mut $id)
+ };
+}
+
+macro_rules! assert_read {
+ ($e:expr, $n:expr) => {{
+ let val = assert_ready!($e);
+ assert_eq!(val.unwrap().unwrap(), $n);
+ }};
+}
+
+#[tokio::test]
+async fn return_none_after_error() {
+ let mut io = FramedRead::new(
+ Builder::new()
+ .read(b"abcdef")
+ .read_error(io::Error::new(io::ErrorKind::Other, "Resource errored out"))
+ .read(b"more data")
+ .build(),
+ BytesCodec::new(),
+ );
+
+ let mut task = task::spawn(());
+
+ task.enter(|cx, _| {
+ assert_read!(pin!(io).poll_next(cx), b"abcdef".to_vec());
+ assert!(assert_ready!(pin!(io).poll_next(cx)).unwrap().is_err());
+ assert!(assert_ready!(pin!(io).poll_next(cx)).is_none());
+ assert_read!(pin!(io).poll_next(cx), b"more data".to_vec());
+ })
+}
diff --git a/crates/tokio-util/tests/framed_write.rs b/crates/tokio-util/tests/framed_write.rs
new file mode 100644
index 0000000..39091c0
--- /dev/null
+++ b/crates/tokio-util/tests/framed_write.rs
@@ -0,0 +1,212 @@
+#![warn(rust_2018_idioms)]
+
+use tokio::io::AsyncWrite;
+use tokio_test::{assert_ready, task};
+use tokio_util::codec::{Encoder, FramedWrite};
+
+use bytes::{BufMut, BytesMut};
+use futures_sink::Sink;
+use std::collections::VecDeque;
+use std::io::{self, Write};
+use std::pin::Pin;
+use std::task::Poll::{Pending, Ready};
+use std::task::{Context, Poll};
+
+macro_rules! mock {
+ ($($x:expr,)*) => {{
+ let mut v = VecDeque::new();
+ v.extend(vec![$($x),*]);
+ Mock { calls: v }
+ }};
+}
+
+macro_rules! pin {
+ ($id:ident) => {
+ Pin::new(&mut $id)
+ };
+}
+
+struct U32Encoder;
+
+impl Encoder<u32> for U32Encoder {
+ type Error = io::Error;
+
+ fn encode(&mut self, item: u32, dst: &mut BytesMut) -> io::Result<()> {
+ // Reserve space
+ dst.reserve(4);
+ dst.put_u32(item);
+ Ok(())
+ }
+}
+
+struct U64Encoder;
+
+impl Encoder<u64> for U64Encoder {
+ type Error = io::Error;
+
+ fn encode(&mut self, item: u64, dst: &mut BytesMut) -> io::Result<()> {
+ // Reserve space
+ dst.reserve(8);
+ dst.put_u64(item);
+ Ok(())
+ }
+}
+
+#[test]
+fn write_multi_frame_in_packet() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x02".to_vec()),
+ };
+ let mut framed = FramedWrite::new(mock, U32Encoder);
+
+ task.enter(|cx, _| {
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(0).is_ok());
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(1).is_ok());
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(2).is_ok());
+
+ // Nothing written yet
+ assert_eq!(1, framed.get_ref().calls.len());
+
+ // Flush the writes
+ assert!(assert_ready!(pin!(framed).poll_flush(cx)).is_ok());
+
+ assert_eq!(0, framed.get_ref().calls.len());
+ });
+}
+
+#[test]
+fn write_multi_frame_after_codec_changed() {
+ let mut task = task::spawn(());
+ let mock = mock! {
+ Ok(b"\x00\x00\x00\x04\x00\x00\x00\x00\x00\x00\x00\x08".to_vec()),
+ };
+ let mut framed = FramedWrite::new(mock, U32Encoder);
+
+ task.enter(|cx, _| {
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(0x04).is_ok());
+
+ let mut framed = framed.map_encoder(|_| U64Encoder);
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(0x08).is_ok());
+
+ // Nothing written yet
+ assert_eq!(1, framed.get_ref().calls.len());
+
+ // Flush the writes
+ assert!(assert_ready!(pin!(framed).poll_flush(cx)).is_ok());
+
+ assert_eq!(0, framed.get_ref().calls.len());
+ });
+}
+
+#[test]
+fn write_hits_backpressure() {
+ const ITER: usize = 2 * 1024;
+
+ let mut mock = mock! {
+ // Block the `ITER*2`th write
+ Err(io::Error::new(io::ErrorKind::WouldBlock, "not ready")),
+ Ok(b"".to_vec()),
+ };
+
+ for i in 0..=ITER * 2 {
+ let mut b = BytesMut::with_capacity(4);
+ b.put_u32(i as u32);
+
+ // Append to the end
+ match mock.calls.back_mut().unwrap() {
+ Ok(ref mut data) => {
+ // Write in 2kb chunks
+ if data.len() < ITER {
+ data.extend_from_slice(&b[..]);
+ continue;
+ } // else fall through and create a new buffer
+ }
+ _ => unreachable!(),
+ }
+
+ // Push a new chunk
+ mock.calls.push_back(Ok(b[..].to_vec()));
+ }
+ // 1 'wouldblock', 8 * 2KB buffers, 1 b-byte buffer
+ assert_eq!(mock.calls.len(), 10);
+
+ let mut task = task::spawn(());
+ let mut framed = FramedWrite::new(mock, U32Encoder);
+ framed.set_backpressure_boundary(ITER * 8);
+ task.enter(|cx, _| {
+ // Send 16KB. This fills up FramedWrite buffer
+ for i in 0..ITER * 2 {
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+ assert!(pin!(framed).start_send(i as u32).is_ok());
+ }
+
+ // Now we poll_ready which forces a flush. The mock pops the front message
+ // and decides to block.
+ assert!(pin!(framed).poll_ready(cx).is_pending());
+
+ // We poll again, forcing another flush, which this time succeeds
+ // The whole 16KB buffer is flushed
+ assert!(assert_ready!(pin!(framed).poll_ready(cx)).is_ok());
+
+ // Send more data. This matches the final message expected by the mock
+ assert!(pin!(framed).start_send((ITER * 2) as u32).is_ok());
+
+ // Flush the rest of the buffer
+ assert!(assert_ready!(pin!(framed).poll_flush(cx)).is_ok());
+
+ // Ensure the mock is empty
+ assert_eq!(0, framed.get_ref().calls.len());
+ })
+}
+
+// // ===== Mock ======
+
+struct Mock {
+ calls: VecDeque<io::Result<Vec<u8>>>,
+}
+
+impl Write for Mock {
+ fn write(&mut self, src: &[u8]) -> io::Result<usize> {
+ match self.calls.pop_front() {
+ Some(Ok(data)) => {
+ assert!(src.len() >= data.len());
+ assert_eq!(&data[..], &src[..data.len()]);
+ Ok(data.len())
+ }
+ Some(Err(e)) => Err(e),
+ None => panic!("unexpected write; {:?}", src),
+ }
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+}
+
+impl AsyncWrite for Mock {
+ fn poll_write(
+ self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<Result<usize, io::Error>> {
+ match Pin::get_mut(self).write(buf) {
+ Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => Pending,
+ other => Ready(other),
+ }
+ }
+ fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ match Pin::get_mut(self).flush() {
+ Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => Pending,
+ other => Ready(other),
+ }
+ }
+ fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ unimplemented!()
+ }
+}
diff --git a/crates/tokio-util/tests/io_inspect.rs b/crates/tokio-util/tests/io_inspect.rs
new file mode 100644
index 0000000..e6319af
--- /dev/null
+++ b/crates/tokio-util/tests/io_inspect.rs
@@ -0,0 +1,194 @@
+use futures::future::poll_fn;
+use std::{
+ io::IoSlice,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, ReadBuf};
+use tokio_util::io::{InspectReader, InspectWriter};
+
+/// An AsyncRead implementation that works byte-by-byte, to catch out callers
+/// who don't allow for `buf` being part-filled before the call
+struct SmallReader {
+ contents: Vec<u8>,
+}
+
+impl Unpin for SmallReader {}
+
+impl AsyncRead for SmallReader {
+ fn poll_read(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<std::io::Result<()>> {
+ if let Some(byte) = self.contents.pop() {
+ buf.put_slice(&[byte])
+ }
+ Poll::Ready(Ok(()))
+ }
+}
+
+#[tokio::test]
+async fn read_tee() {
+ let contents = b"This could be really long, you know".to_vec();
+ let reader = SmallReader {
+ contents: contents.clone(),
+ };
+ let mut altout: Vec<u8> = Vec::new();
+ let mut teeout = Vec::new();
+ {
+ let mut tee = InspectReader::new(reader, |bytes| altout.extend(bytes));
+ tee.read_to_end(&mut teeout).await.unwrap();
+ }
+ assert_eq!(teeout, altout);
+ assert_eq!(altout.len(), contents.len());
+}
+
+/// An AsyncWrite implementation that works byte-by-byte for poll_write, and
+/// that reads the whole of the first buffer plus one byte from the second in
+/// poll_write_vectored.
+///
+/// This is designed to catch bugs in handling partially written buffers
+#[derive(Debug)]
+struct SmallWriter {
+ contents: Vec<u8>,
+}
+
+impl Unpin for SmallWriter {}
+
+impl AsyncWrite for SmallWriter {
+ fn poll_write(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ buf: &[u8],
+ ) -> Poll<Result<usize, std::io::Error>> {
+ // Just write one byte at a time
+ if buf.is_empty() {
+ return Poll::Ready(Ok(0));
+ }
+ self.contents.push(buf[0]);
+ Poll::Ready(Ok(1))
+ }
+
+ fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), std::io::Error>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn poll_shutdown(
+ self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ ) -> Poll<Result<(), std::io::Error>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn poll_write_vectored(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ bufs: &[IoSlice<'_>],
+ ) -> Poll<Result<usize, std::io::Error>> {
+ // Write all of the first buffer, then one byte from the second buffer
+ // This should trip up anything that doesn't correctly handle multiple
+ // buffers.
+ if bufs.is_empty() {
+ return Poll::Ready(Ok(0));
+ }
+ let mut written_len = bufs[0].len();
+ self.contents.extend_from_slice(&bufs[0]);
+
+ if bufs.len() > 1 {
+ let buf = bufs[1];
+ if !buf.is_empty() {
+ written_len += 1;
+ self.contents.push(buf[0]);
+ }
+ }
+ Poll::Ready(Ok(written_len))
+ }
+
+ fn is_write_vectored(&self) -> bool {
+ true
+ }
+}
+
+#[tokio::test]
+async fn write_tee() {
+ let mut altout: Vec<u8> = Vec::new();
+ let mut writeout = SmallWriter {
+ contents: Vec::new(),
+ };
+ {
+ let mut tee = InspectWriter::new(&mut writeout, |bytes| altout.extend(bytes));
+ tee.write_all(b"A testing string, very testing")
+ .await
+ .unwrap();
+ }
+ assert_eq!(altout, writeout.contents);
+}
+
+// This is inefficient, but works well enough for test use.
+// If you want something similar for real code, you'll want to avoid all the
+// fun of manipulating `bufs` - ideally, by the time you read this,
+// IoSlice::advance_slices will be stable, and you can use that.
+async fn write_all_vectored<W: AsyncWrite + Unpin>(
+ mut writer: W,
+ mut bufs: Vec<Vec<u8>>,
+) -> Result<usize, std::io::Error> {
+ let mut res = 0;
+ while !bufs.is_empty() {
+ let mut written = poll_fn(|cx| {
+ let bufs: Vec<IoSlice> = bufs.iter().map(|v| IoSlice::new(v)).collect();
+ Pin::new(&mut writer).poll_write_vectored(cx, &bufs)
+ })
+ .await?;
+ res += written;
+ while written > 0 {
+ let buf_len = bufs[0].len();
+ if buf_len <= written {
+ bufs.remove(0);
+ written -= buf_len;
+ } else {
+ let buf = &mut bufs[0];
+ let drain_len = written.min(buf.len());
+ buf.drain(..drain_len);
+ written -= drain_len;
+ }
+ }
+ }
+ Ok(res)
+}
+
+#[tokio::test]
+async fn write_tee_vectored() {
+ let mut altout: Vec<u8> = Vec::new();
+ let mut writeout = SmallWriter {
+ contents: Vec::new(),
+ };
+ let original = b"A very long string split up";
+ let bufs: Vec<Vec<u8>> = original
+ .split(|b| b.is_ascii_whitespace())
+ .map(Vec::from)
+ .collect();
+ assert!(bufs.len() > 1);
+ let expected: Vec<u8> = {
+ let mut out = Vec::new();
+ for item in &bufs {
+ out.extend_from_slice(item)
+ }
+ out
+ };
+ {
+ let mut bufcount = 0;
+ let tee = InspectWriter::new(&mut writeout, |bytes| {
+ bufcount += 1;
+ altout.extend(bytes)
+ });
+
+ assert!(tee.is_write_vectored());
+
+ write_all_vectored(tee, bufs.clone()).await.unwrap();
+
+ assert!(bufcount >= bufs.len());
+ }
+ assert_eq!(altout, writeout.contents);
+ assert_eq!(writeout.contents, expected);
+}
diff --git a/crates/tokio-util/tests/io_reader_stream.rs b/crates/tokio-util/tests/io_reader_stream.rs
new file mode 100644
index 0000000..e30cd85
--- /dev/null
+++ b/crates/tokio-util/tests/io_reader_stream.rs
@@ -0,0 +1,65 @@
+#![warn(rust_2018_idioms)]
+
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::io::{AsyncRead, ReadBuf};
+use tokio_stream::StreamExt;
+
+/// produces at most `remaining` zeros, that returns error.
+/// each time it reads at most 31 byte.
+struct Reader {
+ remaining: usize,
+}
+
+impl AsyncRead for Reader {
+ fn poll_read(
+ self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ buf: &mut ReadBuf<'_>,
+ ) -> Poll<std::io::Result<()>> {
+ let this = Pin::into_inner(self);
+ assert_ne!(buf.remaining(), 0);
+ if this.remaining > 0 {
+ let n = std::cmp::min(this.remaining, buf.remaining());
+ let n = std::cmp::min(n, 31);
+ for x in &mut buf.initialize_unfilled_to(n)[..n] {
+ *x = 0;
+ }
+ buf.advance(n);
+ this.remaining -= n;
+ Poll::Ready(Ok(()))
+ } else {
+ Poll::Ready(Err(std::io::Error::from_raw_os_error(22)))
+ }
+ }
+}
+
+#[tokio::test]
+async fn correct_behavior_on_errors() {
+ let reader = Reader { remaining: 8000 };
+ let mut stream = tokio_util::io::ReaderStream::new(reader);
+ let mut zeros_received = 0;
+ let mut had_error = false;
+ loop {
+ let item = stream.next().await.unwrap();
+ println!("{:?}", item);
+ match item {
+ Ok(bytes) => {
+ let bytes = &*bytes;
+ for byte in bytes {
+ assert_eq!(*byte, 0);
+ zeros_received += 1;
+ }
+ }
+ Err(_) => {
+ assert!(!had_error);
+ had_error = true;
+ break;
+ }
+ }
+ }
+
+ assert!(had_error);
+ assert_eq!(zeros_received, 8000);
+ assert!(stream.next().await.is_none());
+}
diff --git a/crates/tokio-util/tests/io_sink_writer.rs b/crates/tokio-util/tests/io_sink_writer.rs
new file mode 100644
index 0000000..e76870b
--- /dev/null
+++ b/crates/tokio-util/tests/io_sink_writer.rs
@@ -0,0 +1,72 @@
+#![warn(rust_2018_idioms)]
+
+use bytes::Bytes;
+use futures_util::SinkExt;
+use std::io::{self, Error, ErrorKind};
+use tokio::io::AsyncWriteExt;
+use tokio_util::codec::{Encoder, FramedWrite};
+use tokio_util::io::{CopyToBytes, SinkWriter};
+use tokio_util::sync::PollSender;
+
+#[tokio::test]
+async fn test_copied_sink_writer() -> Result<(), Error> {
+ // Construct a channel pair to send data across and wrap a pollable sink.
+ // Note that the sink must mimic a writable object, e.g. have `std::io::Error`
+ // as its error type.
+ // As `PollSender` requires an owned copy of the buffer, we wrap it additionally
+ // with a `CopyToBytes` helper.
+ let (tx, mut rx) = tokio::sync::mpsc::channel::<Bytes>(1);
+ let mut writer = SinkWriter::new(CopyToBytes::new(
+ PollSender::new(tx).sink_map_err(|_| io::Error::from(ErrorKind::BrokenPipe)),
+ ));
+
+ // Write data to our interface...
+ let data: [u8; 4] = [1, 2, 3, 4];
+ let _ = writer.write(&data).await;
+
+ // ... and receive it.
+ assert_eq!(data.to_vec(), rx.recv().await.unwrap().to_vec());
+
+ Ok(())
+}
+
+/// A trivial encoder.
+struct SliceEncoder;
+
+impl SliceEncoder {
+ fn new() -> Self {
+ Self {}
+ }
+}
+
+impl<'a> Encoder<&'a [u8]> for SliceEncoder {
+ type Error = Error;
+
+ fn encode(&mut self, item: &'a [u8], dst: &mut bytes::BytesMut) -> Result<(), Self::Error> {
+ // This is where we'd write packet headers, lengths, etc. in a real encoder.
+ // For simplicity and demonstration purposes, we just pack a copy of
+ // the slice at the end of a buffer.
+ dst.extend_from_slice(item);
+ Ok(())
+ }
+}
+
+#[tokio::test]
+async fn test_direct_sink_writer() -> Result<(), Error> {
+ // We define a framed writer which accepts byte slices
+ // and 'reverse' this construction immediately.
+ let framed_byte_lc = FramedWrite::new(Vec::new(), SliceEncoder::new());
+ let mut writer = SinkWriter::new(framed_byte_lc);
+
+ // Write multiple slices to the sink...
+ let _ = writer.write(&[1, 2, 3]).await;
+ let _ = writer.write(&[4, 5, 6]).await;
+
+ // ... and compare it with the buffer.
+ assert_eq!(
+ writer.into_inner().write_buffer().to_vec().as_slice(),
+ &[1, 2, 3, 4, 5, 6]
+ );
+
+ Ok(())
+}
diff --git a/crates/tokio-util/tests/io_stream_reader.rs b/crates/tokio-util/tests/io_stream_reader.rs
new file mode 100644
index 0000000..5975994
--- /dev/null
+++ b/crates/tokio-util/tests/io_stream_reader.rs
@@ -0,0 +1,35 @@
+#![warn(rust_2018_idioms)]
+
+use bytes::Bytes;
+use tokio::io::AsyncReadExt;
+use tokio_stream::iter;
+use tokio_util::io::StreamReader;
+
+#[tokio::test]
+async fn test_stream_reader() -> std::io::Result<()> {
+ let stream = iter(vec![
+ std::io::Result::Ok(Bytes::from_static(&[])),
+ Ok(Bytes::from_static(&[0, 1, 2, 3])),
+ Ok(Bytes::from_static(&[])),
+ Ok(Bytes::from_static(&[4, 5, 6, 7])),
+ Ok(Bytes::from_static(&[])),
+ Ok(Bytes::from_static(&[8, 9, 10, 11])),
+ Ok(Bytes::from_static(&[])),
+ ]);
+
+ let mut read = StreamReader::new(stream);
+
+ let mut buf = [0; 5];
+ read.read_exact(&mut buf).await?;
+ assert_eq!(buf, [0, 1, 2, 3, 4]);
+
+ assert_eq!(read.read(&mut buf).await?, 3);
+ assert_eq!(&buf[..3], [5, 6, 7]);
+
+ assert_eq!(read.read(&mut buf).await?, 4);
+ assert_eq!(&buf[..4], [8, 9, 10, 11]);
+
+ assert_eq!(read.read(&mut buf).await?, 0);
+
+ Ok(())
+}
diff --git a/crates/tokio-util/tests/io_sync_bridge.rs b/crates/tokio-util/tests/io_sync_bridge.rs
new file mode 100644
index 0000000..50d0e89
--- /dev/null
+++ b/crates/tokio-util/tests/io_sync_bridge.rs
@@ -0,0 +1,74 @@
+#![cfg(feature = "io-util")]
+#![cfg(not(target_os = "wasi"))] // Wasi doesn't support threads
+
+use std::error::Error;
+use std::io::{Cursor, Read, Result as IoResult, Write};
+use tokio::io::{AsyncRead, AsyncReadExt};
+use tokio_util::io::SyncIoBridge;
+
+async fn test_reader_len(
+ r: impl AsyncRead + Unpin + Send + 'static,
+ expected_len: usize,
+) -> IoResult<()> {
+ let mut r = SyncIoBridge::new(r);
+ let res = tokio::task::spawn_blocking(move || {
+ let mut buf = Vec::new();
+ r.read_to_end(&mut buf)?;
+ Ok::<_, std::io::Error>(buf)
+ })
+ .await?;
+ assert_eq!(res?.len(), expected_len);
+ Ok(())
+}
+
+#[tokio::test]
+async fn test_async_read_to_sync() -> Result<(), Box<dyn Error>> {
+ test_reader_len(tokio::io::empty(), 0).await?;
+ let buf = b"hello world";
+ test_reader_len(Cursor::new(buf), buf.len()).await?;
+ Ok(())
+}
+
+#[tokio::test]
+async fn test_async_write_to_sync() -> Result<(), Box<dyn Error>> {
+ let mut dest = Vec::new();
+ let src = b"hello world";
+ let dest = tokio::task::spawn_blocking(move || -> Result<_, String> {
+ let mut w = SyncIoBridge::new(Cursor::new(&mut dest));
+ std::io::copy(&mut Cursor::new(src), &mut w).map_err(|e| e.to_string())?;
+ Ok(dest)
+ })
+ .await??;
+ assert_eq!(dest.as_slice(), src);
+ Ok(())
+}
+
+#[tokio::test]
+async fn test_into_inner() -> Result<(), Box<dyn Error>> {
+ let mut buf = Vec::new();
+ SyncIoBridge::new(tokio::io::empty())
+ .into_inner()
+ .read_to_end(&mut buf)
+ .await
+ .unwrap();
+ assert_eq!(buf.len(), 0);
+ Ok(())
+}
+
+#[tokio::test]
+async fn test_shutdown() -> Result<(), Box<dyn Error>> {
+ let (s1, mut s2) = tokio::io::duplex(1024);
+ let (_rh, wh) = tokio::io::split(s1);
+ tokio::task::spawn_blocking(move || -> std::io::Result<_> {
+ let mut wh = SyncIoBridge::new(wh);
+ wh.write_all(b"hello")?;
+ wh.shutdown()?;
+ assert!(wh.write_all(b" world").is_err());
+ Ok(())
+ })
+ .await??;
+ let mut buf = vec![];
+ s2.read_to_end(&mut buf).await?;
+ assert_eq!(buf, b"hello");
+ Ok(())
+}
diff --git a/crates/tokio-util/tests/length_delimited.rs b/crates/tokio-util/tests/length_delimited.rs
new file mode 100644
index 0000000..ed5590f
--- /dev/null
+++ b/crates/tokio-util/tests/length_delimited.rs
@@ -0,0 +1,776 @@
+#![warn(rust_2018_idioms)]
+
+use tokio::io::{AsyncRead, AsyncWrite, ReadBuf};
+use tokio_test::task;
+use tokio_test::{
+ assert_err, assert_ok, assert_pending, assert_ready, assert_ready_err, assert_ready_ok,
+};
+use tokio_util::codec::*;
+
+use bytes::{BufMut, Bytes, BytesMut};
+use futures::{pin_mut, Sink, Stream};
+use std::collections::VecDeque;
+use std::io;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+macro_rules! mock {
+ ($($x:expr,)*) => {{
+ let mut v = VecDeque::new();
+ v.extend(vec![$($x),*]);
+ Mock { calls: v }
+ }};
+}
+
+macro_rules! assert_next_eq {
+ ($io:ident, $expect:expr) => {{
+ task::spawn(()).enter(|cx, _| {
+ let res = assert_ready!($io.as_mut().poll_next(cx));
+ match res {
+ Some(Ok(v)) => assert_eq!(v, $expect.as_ref()),
+ Some(Err(e)) => panic!("error = {:?}", e),
+ None => panic!("none"),
+ }
+ });
+ }};
+}
+
+macro_rules! assert_next_pending {
+ ($io:ident) => {{
+ task::spawn(()).enter(|cx, _| match $io.as_mut().poll_next(cx) {
+ Poll::Ready(Some(Ok(v))) => panic!("value = {:?}", v),
+ Poll::Ready(Some(Err(e))) => panic!("error = {:?}", e),
+ Poll::Ready(None) => panic!("done"),
+ Poll::Pending => {}
+ });
+ }};
+}
+
+macro_rules! assert_next_err {
+ ($io:ident) => {{
+ task::spawn(()).enter(|cx, _| match $io.as_mut().poll_next(cx) {
+ Poll::Ready(Some(Ok(v))) => panic!("value = {:?}", v),
+ Poll::Ready(Some(Err(_))) => {}
+ Poll::Ready(None) => panic!("done"),
+ Poll::Pending => panic!("pending"),
+ });
+ }};
+}
+
+macro_rules! assert_done {
+ ($io:ident) => {{
+ task::spawn(()).enter(|cx, _| {
+ let res = assert_ready!($io.as_mut().poll_next(cx));
+ match res {
+ Some(Ok(v)) => panic!("value = {:?}", v),
+ Some(Err(e)) => panic!("error = {:?}", e),
+ None => {}
+ }
+ });
+ }};
+}
+
+#[test]
+fn read_empty_io_yields_nothing() {
+ let io = Box::pin(FramedRead::new(mock!(), LengthDelimitedCodec::new()));
+ pin_mut!(io);
+
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_one_packet() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00\x00\x09abcdefghi"),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_one_packet_little_endian() {
+ let io = length_delimited::Builder::new()
+ .little_endian()
+ .new_read(mock! {
+ data(b"\x09\x00\x00\x00abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_one_packet_native_endian() {
+ let d = if cfg!(target_endian = "big") {
+ b"\x00\x00\x00\x09abcdefghi"
+ } else {
+ b"\x09\x00\x00\x00abcdefghi"
+ };
+ let io = length_delimited::Builder::new()
+ .native_endian()
+ .new_read(mock! {
+ data(d),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_multi_frame_one_packet() {
+ let mut d: Vec<u8> = vec![];
+ d.extend_from_slice(b"\x00\x00\x00\x09abcdefghi");
+ d.extend_from_slice(b"\x00\x00\x00\x03123");
+ d.extend_from_slice(b"\x00\x00\x00\x0bhello world");
+
+ let io = FramedRead::new(
+ mock! {
+ data(&d),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_eq!(io, b"123");
+ assert_next_eq!(io, b"hello world");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_multi_packet() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00"),
+ data(b"\x00\x09abc"),
+ data(b"defghi"),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_multi_frame_multi_packet() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00"),
+ data(b"\x00\x09abc"),
+ data(b"defghi"),
+ data(b"\x00\x00\x00\x0312"),
+ data(b"3\x00\x00\x00\x0bhello world"),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_eq!(io, b"123");
+ assert_next_eq!(io, b"hello world");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_multi_packet_wait() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00"),
+ Poll::Pending,
+ data(b"\x00\x09abc"),
+ Poll::Pending,
+ data(b"defghi"),
+ Poll::Pending,
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_pending!(io);
+ assert_next_pending!(io);
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_pending!(io);
+ assert_done!(io);
+}
+
+#[test]
+fn read_multi_frame_multi_packet_wait() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00"),
+ Poll::Pending,
+ data(b"\x00\x09abc"),
+ Poll::Pending,
+ data(b"defghi"),
+ Poll::Pending,
+ data(b"\x00\x00\x00\x0312"),
+ Poll::Pending,
+ data(b"3\x00\x00\x00\x0bhello world"),
+ Poll::Pending,
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_pending!(io);
+ assert_next_pending!(io);
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_pending!(io);
+ assert_next_pending!(io);
+ assert_next_eq!(io, b"123");
+ assert_next_eq!(io, b"hello world");
+ assert_next_pending!(io);
+ assert_done!(io);
+}
+
+#[test]
+fn read_incomplete_head() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00"),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_incomplete_head_multi() {
+ let io = FramedRead::new(
+ mock! {
+ Poll::Pending,
+ data(b"\x00"),
+ Poll::Pending,
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_pending!(io);
+ assert_next_pending!(io);
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_incomplete_payload() {
+ let io = FramedRead::new(
+ mock! {
+ data(b"\x00\x00\x00\x09ab"),
+ Poll::Pending,
+ data(b"cd"),
+ Poll::Pending,
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ assert_next_pending!(io);
+ assert_next_pending!(io);
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_max_frame_len() {
+ let io = length_delimited::Builder::new()
+ .max_frame_length(5)
+ .new_read(mock! {
+ data(b"\x00\x00\x00\x09abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_update_max_frame_len_at_rest() {
+ let io = length_delimited::Builder::new().new_read(mock! {
+ data(b"\x00\x00\x00\x09abcdefghi"),
+ data(b"\x00\x00\x00\x09abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ io.decoder_mut().set_max_frame_length(5);
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_update_max_frame_len_in_flight() {
+ let io = length_delimited::Builder::new().new_read(mock! {
+ data(b"\x00\x00\x00\x09abcd"),
+ Poll::Pending,
+ data(b"efghi"),
+ data(b"\x00\x00\x00\x09abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_pending!(io);
+ io.decoder_mut().set_max_frame_length(5);
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_err!(io);
+}
+
+#[test]
+fn read_one_byte_length_field() {
+ let io = length_delimited::Builder::new()
+ .length_field_length(1)
+ .new_read(mock! {
+ data(b"\x09abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_header_offset() {
+ let io = length_delimited::Builder::new()
+ .length_field_length(2)
+ .length_field_offset(4)
+ .new_read(mock! {
+ data(b"zzzz\x00\x09abcdefghi"),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_multi_frame_one_packet_skip_none_adjusted() {
+ let mut d: Vec<u8> = vec![];
+ d.extend_from_slice(b"xx\x00\x09abcdefghi");
+ d.extend_from_slice(b"yy\x00\x03123");
+ d.extend_from_slice(b"zz\x00\x0bhello world");
+
+ let io = length_delimited::Builder::new()
+ .length_field_length(2)
+ .length_field_offset(2)
+ .num_skip(0)
+ .length_adjustment(4)
+ .new_read(mock! {
+ data(&d),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"xx\x00\x09abcdefghi");
+ assert_next_eq!(io, b"yy\x00\x03123");
+ assert_next_eq!(io, b"zz\x00\x0bhello world");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_frame_length_adjusted() {
+ let mut d: Vec<u8> = vec![];
+ d.extend_from_slice(b"\x00\x00\x0b\x0cHello world");
+
+ let io = length_delimited::Builder::new()
+ .length_field_offset(0)
+ .length_field_length(3)
+ .length_adjustment(0)
+ .num_skip(4)
+ .new_read(mock! {
+ data(&d),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"Hello world");
+ assert_done!(io);
+}
+
+#[test]
+fn read_single_multi_frame_one_packet_length_includes_head() {
+ let mut d: Vec<u8> = vec![];
+ d.extend_from_slice(b"\x00\x0babcdefghi");
+ d.extend_from_slice(b"\x00\x05123");
+ d.extend_from_slice(b"\x00\x0dhello world");
+
+ let io = length_delimited::Builder::new()
+ .length_field_length(2)
+ .length_adjustment(-2)
+ .new_read(mock! {
+ data(&d),
+ });
+ pin_mut!(io);
+
+ assert_next_eq!(io, b"abcdefghi");
+ assert_next_eq!(io, b"123");
+ assert_next_eq!(io, b"hello world");
+ assert_done!(io);
+}
+
+#[test]
+fn write_single_frame_length_adjusted() {
+ let io = length_delimited::Builder::new()
+ .length_adjustment(-2)
+ .new_write(mock! {
+ data(b"\x00\x00\x00\x0b"),
+ data(b"abcdefghi"),
+ flush(),
+ });
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_nothing_yields_nothing() {
+ let io = FramedWrite::new(mock!(), LengthDelimitedCodec::new());
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.poll_flush(cx));
+ });
+}
+
+#[test]
+fn write_single_frame_one_packet() {
+ let io = FramedWrite::new(
+ mock! {
+ data(b"\x00\x00\x00\x09"),
+ data(b"abcdefghi"),
+ flush(),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_single_multi_frame_one_packet() {
+ let io = FramedWrite::new(
+ mock! {
+ data(b"\x00\x00\x00\x09"),
+ data(b"abcdefghi"),
+ data(b"\x00\x00\x00\x03"),
+ data(b"123"),
+ data(b"\x00\x00\x00\x0b"),
+ data(b"hello world"),
+ flush(),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("123")));
+
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("hello world")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_single_multi_frame_multi_packet() {
+ let io = FramedWrite::new(
+ mock! {
+ data(b"\x00\x00\x00\x09"),
+ data(b"abcdefghi"),
+ flush(),
+ data(b"\x00\x00\x00\x03"),
+ data(b"123"),
+ flush(),
+ data(b"\x00\x00\x00\x0b"),
+ data(b"hello world"),
+ flush(),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("123")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("hello world")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_single_frame_would_block() {
+ let io = FramedWrite::new(
+ mock! {
+ Poll::Pending,
+ data(b"\x00\x00"),
+ Poll::Pending,
+ data(b"\x00\x09"),
+ data(b"abcdefghi"),
+ flush(),
+ },
+ LengthDelimitedCodec::new(),
+ );
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+
+ assert_pending!(io.as_mut().poll_flush(cx));
+ assert_pending!(io.as_mut().poll_flush(cx));
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_single_frame_little_endian() {
+ let io = length_delimited::Builder::new()
+ .little_endian()
+ .new_write(mock! {
+ data(b"\x09\x00\x00\x00"),
+ data(b"abcdefghi"),
+ flush(),
+ });
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_single_frame_with_short_length_field() {
+ let io = length_delimited::Builder::new()
+ .length_field_length(1)
+ .new_write(mock! {
+ data(b"\x09"),
+ data(b"abcdefghi"),
+ flush(),
+ });
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdefghi")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_max_frame_len() {
+ let io = length_delimited::Builder::new()
+ .max_frame_length(5)
+ .new_write(mock! {});
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_err!(io.as_mut().start_send(Bytes::from("abcdef")));
+
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_update_max_frame_len_at_rest() {
+ let io = length_delimited::Builder::new().new_write(mock! {
+ data(b"\x00\x00\x00\x06"),
+ data(b"abcdef"),
+ flush(),
+ });
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdef")));
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ io.encoder_mut().set_max_frame_length(5);
+
+ assert_err!(io.as_mut().start_send(Bytes::from("abcdef")));
+
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_update_max_frame_len_in_flight() {
+ let io = length_delimited::Builder::new().new_write(mock! {
+ data(b"\x00\x00\x00\x06"),
+ data(b"ab"),
+ Poll::Pending,
+ data(b"cdef"),
+ flush(),
+ });
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdef")));
+
+ assert_pending!(io.as_mut().poll_flush(cx));
+
+ io.encoder_mut().set_max_frame_length(5);
+
+ assert_ready_ok!(io.as_mut().poll_flush(cx));
+
+ assert_err!(io.as_mut().start_send(Bytes::from("abcdef")));
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn write_zero() {
+ let io = length_delimited::Builder::new().new_write(mock! {});
+ pin_mut!(io);
+
+ task::spawn(()).enter(|cx, _| {
+ assert_ready_ok!(io.as_mut().poll_ready(cx));
+ assert_ok!(io.as_mut().start_send(Bytes::from("abcdef")));
+
+ assert_ready_err!(io.as_mut().poll_flush(cx));
+
+ assert!(io.get_ref().calls.is_empty());
+ });
+}
+
+#[test]
+fn encode_overflow() {
+ // Test reproducing tokio-rs/tokio#681.
+ let mut codec = length_delimited::Builder::new().new_codec();
+ let mut buf = BytesMut::with_capacity(1024);
+
+ // Put some data into the buffer without resizing it to hold more.
+ let some_as = std::iter::repeat(b'a').take(1024).collect::<Vec<_>>();
+ buf.put_slice(&some_as[..]);
+
+ // Trying to encode the length header should resize the buffer if it won't fit.
+ codec.encode(Bytes::from("hello"), &mut buf).unwrap();
+}
+
+// ===== Test utils =====
+
+struct Mock {
+ calls: VecDeque<Poll<io::Result<Op>>>,
+}
+
+enum Op {
+ Data(Vec<u8>),
+ Flush,
+}
+
+impl AsyncRead for Mock {
+ fn poll_read(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ dst: &mut ReadBuf<'_>,
+ ) -> Poll<io::Result<()>> {
+ match self.calls.pop_front() {
+ Some(Poll::Ready(Ok(Op::Data(data)))) => {
+ debug_assert!(dst.remaining() >= data.len());
+ dst.put_slice(&data);
+ Poll::Ready(Ok(()))
+ }
+ Some(Poll::Ready(Ok(_))) => panic!(),
+ Some(Poll::Ready(Err(e))) => Poll::Ready(Err(e)),
+ Some(Poll::Pending) => Poll::Pending,
+ None => Poll::Ready(Ok(())),
+ }
+ }
+}
+
+impl AsyncWrite for Mock {
+ fn poll_write(
+ mut self: Pin<&mut Self>,
+ _cx: &mut Context<'_>,
+ src: &[u8],
+ ) -> Poll<Result<usize, io::Error>> {
+ match self.calls.pop_front() {
+ Some(Poll::Ready(Ok(Op::Data(data)))) => {
+ let len = data.len();
+ assert!(src.len() >= len, "expect={:?}; actual={:?}", data, src);
+ assert_eq!(&data[..], &src[..len]);
+ Poll::Ready(Ok(len))
+ }
+ Some(Poll::Ready(Ok(_))) => panic!(),
+ Some(Poll::Ready(Err(e))) => Poll::Ready(Err(e)),
+ Some(Poll::Pending) => Poll::Pending,
+ None => Poll::Ready(Ok(0)),
+ }
+ }
+
+ fn poll_flush(mut self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ match self.calls.pop_front() {
+ Some(Poll::Ready(Ok(Op::Flush))) => Poll::Ready(Ok(())),
+ Some(Poll::Ready(Ok(_))) => panic!(),
+ Some(Poll::Ready(Err(e))) => Poll::Ready(Err(e)),
+ Some(Poll::Pending) => Poll::Pending,
+ None => Poll::Ready(Ok(())),
+ }
+ }
+
+ fn poll_shutdown(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<(), io::Error>> {
+ Poll::Ready(Ok(()))
+ }
+}
+
+impl<'a> From<&'a [u8]> for Op {
+ fn from(src: &'a [u8]) -> Op {
+ Op::Data(src.into())
+ }
+}
+
+impl From<Vec<u8>> for Op {
+ fn from(src: Vec<u8>) -> Op {
+ Op::Data(src)
+ }
+}
+
+fn data(bytes: &[u8]) -> Poll<io::Result<Op>> {
+ Poll::Ready(Ok(bytes.into()))
+}
+
+fn flush() -> Poll<io::Result<Op>> {
+ Poll::Ready(Ok(Op::Flush))
+}
diff --git a/crates/tokio-util/tests/mpsc.rs b/crates/tokio-util/tests/mpsc.rs
new file mode 100644
index 0000000..74b83c2
--- /dev/null
+++ b/crates/tokio-util/tests/mpsc.rs
@@ -0,0 +1,262 @@
+use futures::future::poll_fn;
+use tokio::sync::mpsc::channel;
+use tokio_test::task::spawn;
+use tokio_test::{assert_pending, assert_ready, assert_ready_err, assert_ready_ok};
+use tokio_util::sync::PollSender;
+
+#[tokio::test]
+async fn simple() {
+ let (send, mut recv) = channel(3);
+ let mut send = PollSender::new(send);
+
+ for i in 1..=3i32 {
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(i).unwrap();
+ }
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+
+ assert_eq!(recv.recv().await.unwrap(), 1);
+ assert!(reserve.is_woken());
+ assert_ready_ok!(reserve.poll());
+
+ drop(recv);
+
+ send.send_item(42).unwrap();
+}
+
+#[tokio::test]
+async fn simple_ref() {
+ let v = vec![1, 2, 3i32];
+
+ let (send, mut recv) = channel(3);
+ let mut send = PollSender::new(send);
+
+ for vi in v.iter() {
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(vi).unwrap();
+ }
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+
+ assert_eq!(*recv.recv().await.unwrap(), 1);
+ assert!(reserve.is_woken());
+ assert_ready_ok!(reserve.poll());
+ drop(recv);
+ send.send_item(&42).unwrap();
+}
+
+#[tokio::test]
+async fn repeated_poll_reserve() {
+ let (send, mut recv) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ assert_ready_ok!(reserve.poll());
+ send.send_item(1).unwrap();
+
+ assert_eq!(recv.recv().await.unwrap(), 1);
+}
+
+#[tokio::test]
+async fn abort_send() {
+ let (send, mut recv) = channel(3);
+ let mut send = PollSender::new(send);
+ let send2 = send.get_ref().cloned().unwrap();
+
+ for i in 1..=3i32 {
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(i).unwrap();
+ }
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+ assert_eq!(recv.recv().await.unwrap(), 1);
+ assert!(reserve.is_woken());
+ assert_ready_ok!(reserve.poll());
+
+ let mut send2_send = spawn(send2.send(5));
+ assert_pending!(send2_send.poll());
+ assert!(send.abort_send());
+ assert!(send2_send.is_woken());
+ assert_ready_ok!(send2_send.poll());
+
+ assert_eq!(recv.recv().await.unwrap(), 2);
+ assert_eq!(recv.recv().await.unwrap(), 3);
+ assert_eq!(recv.recv().await.unwrap(), 5);
+}
+
+#[tokio::test]
+async fn close_sender_last() {
+ let (send, mut recv) = channel::<i32>(3);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ send.close();
+
+ assert!(recv_task.is_woken());
+ assert!(assert_ready!(recv_task.poll()).is_none());
+}
+
+#[tokio::test]
+async fn close_sender_not_last() {
+ let (send, mut recv) = channel::<i32>(3);
+ let mut send = PollSender::new(send);
+ let send2 = send.get_ref().cloned().unwrap();
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ send.close();
+
+ assert!(!recv_task.is_woken());
+ assert_pending!(recv_task.poll());
+
+ drop(send2);
+
+ assert!(recv_task.is_woken());
+ assert!(assert_ready!(recv_task.poll()).is_none());
+}
+
+#[tokio::test]
+async fn close_sender_before_reserve() {
+ let (send, mut recv) = channel::<i32>(3);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ send.close();
+
+ assert!(recv_task.is_woken());
+ assert!(assert_ready!(recv_task.poll()).is_none());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_err!(reserve.poll());
+}
+
+#[tokio::test]
+async fn close_sender_after_pending_reserve() {
+ let (send, mut recv) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(1).unwrap();
+
+ assert!(recv_task.is_woken());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+ drop(reserve);
+
+ send.close();
+
+ assert!(send.is_closed());
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_err!(reserve.poll());
+}
+
+#[tokio::test]
+async fn close_sender_after_successful_reserve() {
+ let (send, mut recv) = channel::<i32>(3);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ drop(reserve);
+
+ send.close();
+ assert!(send.is_closed());
+ assert!(!recv_task.is_woken());
+ assert_pending!(recv_task.poll());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+}
+
+#[tokio::test]
+async fn abort_send_after_pending_reserve() {
+ let (send, mut recv) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(1).unwrap();
+
+ assert_eq!(send.get_ref().unwrap().capacity(), 0);
+ assert!(!send.abort_send());
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+
+ assert!(send.abort_send());
+ assert_eq!(send.get_ref().unwrap().capacity(), 0);
+}
+
+#[tokio::test]
+async fn abort_send_after_successful_reserve() {
+ let (send, mut recv) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut recv_task = spawn(recv.recv());
+ assert_pending!(recv_task.poll());
+
+ assert_eq!(send.get_ref().unwrap().capacity(), 1);
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ assert_eq!(send.get_ref().unwrap().capacity(), 0);
+
+ assert!(send.abort_send());
+ assert_eq!(send.get_ref().unwrap().capacity(), 1);
+}
+
+#[tokio::test]
+async fn closed_when_receiver_drops() {
+ let (send, _) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_err!(reserve.poll());
+}
+
+#[should_panic]
+#[test]
+fn start_send_panics_when_idle() {
+ let (send, _) = channel::<i32>(3);
+ let mut send = PollSender::new(send);
+
+ send.send_item(1).unwrap();
+}
+
+#[should_panic]
+#[test]
+fn start_send_panics_when_acquiring() {
+ let (send, _) = channel::<i32>(1);
+ let mut send = PollSender::new(send);
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_ready_ok!(reserve.poll());
+ send.send_item(1).unwrap();
+
+ let mut reserve = spawn(poll_fn(|cx| send.poll_reserve(cx)));
+ assert_pending!(reserve.poll());
+ send.send_item(2).unwrap();
+}
diff --git a/crates/tokio-util/tests/panic.rs b/crates/tokio-util/tests/panic.rs
new file mode 100644
index 0000000..e4fcb47
--- /dev/null
+++ b/crates/tokio-util/tests/panic.rs
@@ -0,0 +1,226 @@
+#![warn(rust_2018_idioms)]
+#![cfg(all(feature = "full", not(target_os = "wasi")))] // Wasi doesn't support panic recovery
+
+use parking_lot::{const_mutex, Mutex};
+use std::error::Error;
+use std::panic;
+use std::sync::Arc;
+use tokio::runtime::Runtime;
+use tokio::sync::mpsc::channel;
+use tokio::time::{Duration, Instant};
+use tokio_test::task;
+use tokio_util::io::SyncIoBridge;
+use tokio_util::sync::PollSender;
+use tokio_util::task::LocalPoolHandle;
+use tokio_util::time::DelayQueue;
+
+// Taken from tokio-util::time::wheel, if that changes then
+const MAX_DURATION_MS: u64 = (1 << (36)) - 1;
+
+fn test_panic<Func: FnOnce() + panic::UnwindSafe>(func: Func) -> Option<String> {
+ static PANIC_MUTEX: Mutex<()> = const_mutex(());
+
+ {
+ let _guard = PANIC_MUTEX.lock();
+ let panic_file: Arc<Mutex<Option<String>>> = Arc::new(Mutex::new(None));
+
+ let prev_hook = panic::take_hook();
+ {
+ let panic_file = panic_file.clone();
+ panic::set_hook(Box::new(move |panic_info| {
+ let panic_location = panic_info.location().unwrap();
+ panic_file
+ .lock()
+ .clone_from(&Some(panic_location.file().to_string()));
+ }));
+ }
+
+ let result = panic::catch_unwind(func);
+ // Return to the previously set panic hook (maybe default) so that we get nice error
+ // messages in the tests.
+ panic::set_hook(prev_hook);
+
+ if result.is_err() {
+ panic_file.lock().clone()
+ } else {
+ None
+ }
+ }
+}
+
+#[test]
+fn sync_bridge_new_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let _ = SyncIoBridge::new(tokio::io::empty());
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn poll_sender_send_item_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let (send, _) = channel::<u32>(3);
+ let mut send = PollSender::new(send);
+
+ let _ = send.send_item(42);
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+
+fn local_pool_handle_new_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let _ = LocalPoolHandle::new(0);
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+
+fn local_pool_handle_spawn_pinned_by_idx_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+
+ rt.block_on(async {
+ let handle = LocalPoolHandle::new(2);
+ handle.spawn_pinned_by_idx(|| async { "test" }, 3);
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+#[test]
+fn delay_queue_insert_at_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::with_capacity(3));
+
+ //let st = std::time::Instant::from(SystemTime::UNIX_EPOCH);
+ let _k = queue.insert_at(
+ "1",
+ Instant::now() + Duration::from_millis(MAX_DURATION_MS + 1),
+ );
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn delay_queue_insert_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::with_capacity(3));
+
+ let _k = queue.insert("1", Duration::from_millis(MAX_DURATION_MS + 1));
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn delay_queue_remove_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::with_capacity(3));
+
+ let key = queue.insert_at("1", Instant::now());
+ queue.remove(&key);
+ queue.remove(&key);
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn delay_queue_reset_at_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::with_capacity(3));
+
+ let key = queue.insert_at("1", Instant::now());
+ queue.reset_at(
+ &key,
+ Instant::now() + Duration::from_millis(MAX_DURATION_MS + 1),
+ );
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn delay_queue_reset_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::with_capacity(3));
+
+ let key = queue.insert_at("1", Instant::now());
+ queue.reset(&key, Duration::from_millis(MAX_DURATION_MS + 1));
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+#[test]
+fn delay_queue_reserve_panic_caller() -> Result<(), Box<dyn Error>> {
+ let panic_location_file = test_panic(|| {
+ let rt = basic();
+ rt.block_on(async {
+ let mut queue = task::spawn(DelayQueue::<u32>::with_capacity(3));
+
+ queue.reserve((1 << 30) as usize);
+ });
+ });
+
+ // The panic location should be in this file
+ assert_eq!(&panic_location_file.unwrap(), file!());
+
+ Ok(())
+}
+
+fn basic() -> Runtime {
+ tokio::runtime::Builder::new_current_thread()
+ .enable_all()
+ .build()
+ .unwrap()
+}
diff --git a/crates/tokio-util/tests/poll_semaphore.rs b/crates/tokio-util/tests/poll_semaphore.rs
new file mode 100644
index 0000000..28beca1
--- /dev/null
+++ b/crates/tokio-util/tests/poll_semaphore.rs
@@ -0,0 +1,84 @@
+use std::future::Future;
+use std::sync::Arc;
+use std::task::Poll;
+use tokio::sync::{OwnedSemaphorePermit, Semaphore};
+use tokio_util::sync::PollSemaphore;
+
+type SemRet = Option<OwnedSemaphorePermit>;
+
+fn semaphore_poll(
+ sem: &mut PollSemaphore,
+) -> tokio_test::task::Spawn<impl Future<Output = SemRet> + '_> {
+ let fut = futures::future::poll_fn(move |cx| sem.poll_acquire(cx));
+ tokio_test::task::spawn(fut)
+}
+
+fn semaphore_poll_many(
+ sem: &mut PollSemaphore,
+ permits: u32,
+) -> tokio_test::task::Spawn<impl Future<Output = SemRet> + '_> {
+ let fut = futures::future::poll_fn(move |cx| sem.poll_acquire_many(cx, permits));
+ tokio_test::task::spawn(fut)
+}
+
+#[tokio::test]
+async fn it_works() {
+ let sem = Arc::new(Semaphore::new(1));
+ let mut poll_sem = PollSemaphore::new(sem.clone());
+
+ let permit = sem.acquire().await.unwrap();
+ let mut poll = semaphore_poll(&mut poll_sem);
+ assert!(poll.poll().is_pending());
+ drop(permit);
+
+ assert!(matches!(poll.poll(), Poll::Ready(Some(_))));
+ drop(poll);
+
+ sem.close();
+
+ assert!(semaphore_poll(&mut poll_sem).await.is_none());
+
+ // Check that it is fused.
+ assert!(semaphore_poll(&mut poll_sem).await.is_none());
+ assert!(semaphore_poll(&mut poll_sem).await.is_none());
+}
+
+#[tokio::test]
+async fn can_acquire_many_permits() {
+ let sem = Arc::new(Semaphore::new(4));
+ let mut poll_sem = PollSemaphore::new(sem.clone());
+
+ let permit1 = semaphore_poll(&mut poll_sem).poll();
+ assert!(matches!(permit1, Poll::Ready(Some(_))));
+
+ let permit2 = semaphore_poll_many(&mut poll_sem, 2).poll();
+ assert!(matches!(permit2, Poll::Ready(Some(_))));
+
+ assert_eq!(sem.available_permits(), 1);
+
+ drop(permit2);
+
+ let mut permit4 = semaphore_poll_many(&mut poll_sem, 4);
+ assert!(permit4.poll().is_pending());
+
+ drop(permit1);
+
+ let permit4 = permit4.poll();
+ assert!(matches!(permit4, Poll::Ready(Some(_))));
+ assert_eq!(sem.available_permits(), 0);
+}
+
+#[tokio::test]
+async fn can_poll_different_amounts_of_permits() {
+ let sem = Arc::new(Semaphore::new(4));
+ let mut poll_sem = PollSemaphore::new(sem.clone());
+ assert!(semaphore_poll_many(&mut poll_sem, 5).poll().is_pending());
+ assert!(semaphore_poll_many(&mut poll_sem, 4).poll().is_ready());
+
+ let permit = sem.acquire_many(4).await.unwrap();
+ assert!(semaphore_poll_many(&mut poll_sem, 5).poll().is_pending());
+ assert!(semaphore_poll_many(&mut poll_sem, 4).poll().is_pending());
+ drop(permit);
+ assert!(semaphore_poll_many(&mut poll_sem, 5).poll().is_pending());
+ assert!(semaphore_poll_many(&mut poll_sem, 4).poll().is_ready());
+}
diff --git a/crates/tokio-util/tests/reusable_box.rs b/crates/tokio-util/tests/reusable_box.rs
new file mode 100644
index 0000000..e9c8a25
--- /dev/null
+++ b/crates/tokio-util/tests/reusable_box.rs
@@ -0,0 +1,85 @@
+use futures::future::FutureExt;
+use std::alloc::Layout;
+use std::future::Future;
+use std::marker::PhantomPinned;
+use std::pin::Pin;
+use std::rc::Rc;
+use std::task::{Context, Poll};
+use tokio_util::sync::ReusableBoxFuture;
+
+#[test]
+// Clippy false positive; it's useful to be able to test the trait impls for any lifetime
+#[allow(clippy::extra_unused_lifetimes)]
+fn traits<'a>() {
+ fn assert_traits<T: Send + Sync + Unpin>() {}
+ // Use a type that is !Unpin
+ assert_traits::<ReusableBoxFuture<'a, PhantomPinned>>();
+ // Use a type that is !Send + !Sync
+ assert_traits::<ReusableBoxFuture<'a, Rc<()>>>();
+}
+
+#[test]
+fn test_different_futures() {
+ let fut = async move { 10 };
+ // Not zero sized!
+ assert_eq!(Layout::for_value(&fut).size(), 1);
+
+ let mut b = ReusableBoxFuture::new(fut);
+
+ assert_eq!(b.get_pin().now_or_never(), Some(10));
+
+ b.try_set(async move { 20 })
+ .unwrap_or_else(|_| panic!("incorrect size"));
+
+ assert_eq!(b.get_pin().now_or_never(), Some(20));
+
+ b.try_set(async move { 30 })
+ .unwrap_or_else(|_| panic!("incorrect size"));
+
+ assert_eq!(b.get_pin().now_or_never(), Some(30));
+}
+
+#[test]
+fn test_different_sizes() {
+ let fut1 = async move { 10 };
+ let val = [0u32; 1000];
+ let fut2 = async move { val[0] };
+ let fut3 = ZeroSizedFuture {};
+
+ assert_eq!(Layout::for_value(&fut1).size(), 1);
+ assert_eq!(Layout::for_value(&fut2).size(), 4004);
+ assert_eq!(Layout::for_value(&fut3).size(), 0);
+
+ let mut b = ReusableBoxFuture::new(fut1);
+ assert_eq!(b.get_pin().now_or_never(), Some(10));
+ b.set(fut2);
+ assert_eq!(b.get_pin().now_or_never(), Some(0));
+ b.set(fut3);
+ assert_eq!(b.get_pin().now_or_never(), Some(5));
+}
+
+struct ZeroSizedFuture {}
+impl Future for ZeroSizedFuture {
+ type Output = u32;
+ fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<u32> {
+ Poll::Ready(5)
+ }
+}
+
+#[test]
+fn test_zero_sized() {
+ let fut = ZeroSizedFuture {};
+ // Zero sized!
+ assert_eq!(Layout::for_value(&fut).size(), 0);
+
+ let mut b = ReusableBoxFuture::new(fut);
+
+ assert_eq!(b.get_pin().now_or_never(), Some(5));
+ assert_eq!(b.get_pin().now_or_never(), Some(5));
+
+ b.try_set(ZeroSizedFuture {})
+ .unwrap_or_else(|_| panic!("incorrect size"));
+
+ assert_eq!(b.get_pin().now_or_never(), Some(5));
+ assert_eq!(b.get_pin().now_or_never(), Some(5));
+}
diff --git a/crates/tokio-util/tests/spawn_pinned.rs b/crates/tokio-util/tests/spawn_pinned.rs
new file mode 100644
index 0000000..9ea8cd2
--- /dev/null
+++ b/crates/tokio-util/tests/spawn_pinned.rs
@@ -0,0 +1,237 @@
+#![warn(rust_2018_idioms)]
+#![cfg(not(target_os = "wasi"))] // Wasi doesn't support threads
+
+use std::rc::Rc;
+use std::sync::Arc;
+use tokio::sync::Barrier;
+use tokio_util::task;
+
+/// Simple test of running a !Send future via spawn_pinned
+#[tokio::test]
+async fn can_spawn_not_send_future() {
+ let pool = task::LocalPoolHandle::new(1);
+
+ let output = pool
+ .spawn_pinned(|| {
+ // Rc is !Send + !Sync
+ let local_data = Rc::new("test");
+
+ // This future holds an Rc, so it is !Send
+ async move { local_data.to_string() }
+ })
+ .await
+ .unwrap();
+
+ assert_eq!(output, "test");
+}
+
+/// Dropping the join handle still lets the task execute
+#[test]
+fn can_drop_future_and_still_get_output() {
+ let pool = task::LocalPoolHandle::new(1);
+ let (sender, receiver) = std::sync::mpsc::channel();
+
+ let _ = pool.spawn_pinned(move || {
+ // Rc is !Send + !Sync
+ let local_data = Rc::new("test");
+
+ // This future holds an Rc, so it is !Send
+ async move {
+ let _ = sender.send(local_data.to_string());
+ }
+ });
+
+ assert_eq!(receiver.recv(), Ok("test".to_string()));
+}
+
+#[test]
+#[should_panic(expected = "assertion failed: pool_size > 0")]
+fn cannot_create_zero_sized_pool() {
+ let _pool = task::LocalPoolHandle::new(0);
+}
+
+/// We should be able to spawn multiple futures onto the pool at the same time.
+#[tokio::test]
+async fn can_spawn_multiple_futures() {
+ let pool = task::LocalPoolHandle::new(2);
+
+ let join_handle1 = pool.spawn_pinned(|| {
+ let local_data = Rc::new("test1");
+ async move { local_data.to_string() }
+ });
+ let join_handle2 = pool.spawn_pinned(|| {
+ let local_data = Rc::new("test2");
+ async move { local_data.to_string() }
+ });
+
+ assert_eq!(join_handle1.await.unwrap(), "test1");
+ assert_eq!(join_handle2.await.unwrap(), "test2");
+}
+
+/// A panic in the spawned task causes the join handle to return an error.
+/// But, you can continue to spawn tasks.
+#[tokio::test]
+async fn task_panic_propagates() {
+ let pool = task::LocalPoolHandle::new(1);
+
+ let join_handle = pool.spawn_pinned(|| async {
+ panic!("Test panic");
+ });
+
+ let result = join_handle.await;
+ assert!(result.is_err());
+ let error = result.unwrap_err();
+ assert!(error.is_panic());
+ let panic_str = error.into_panic().downcast::<&'static str>().unwrap();
+ assert_eq!(*panic_str, "Test panic");
+
+ // Trying again with a "safe" task still works
+ let join_handle = pool.spawn_pinned(|| async { "test" });
+ let result = join_handle.await;
+ assert!(result.is_ok());
+ assert_eq!(result.unwrap(), "test");
+}
+
+/// A panic during task creation causes the join handle to return an error.
+/// But, you can continue to spawn tasks.
+#[tokio::test]
+async fn callback_panic_does_not_kill_worker() {
+ let pool = task::LocalPoolHandle::new(1);
+
+ let join_handle = pool.spawn_pinned(|| {
+ panic!("Test panic");
+ #[allow(unreachable_code)]
+ async {}
+ });
+
+ let result = join_handle.await;
+ assert!(result.is_err());
+ let error = result.unwrap_err();
+ assert!(error.is_panic());
+ let panic_str = error.into_panic().downcast::<&'static str>().unwrap();
+ assert_eq!(*panic_str, "Test panic");
+
+ // Trying again with a "safe" callback works
+ let join_handle = pool.spawn_pinned(|| async { "test" });
+ let result = join_handle.await;
+ assert!(result.is_ok());
+ assert_eq!(result.unwrap(), "test");
+}
+
+/// Canceling the task via the returned join handle cancels the spawned task
+/// (which has a different, internal join handle).
+#[tokio::test]
+async fn task_cancellation_propagates() {
+ let pool = task::LocalPoolHandle::new(1);
+ let notify_dropped = Arc::new(());
+ let weak_notify_dropped = Arc::downgrade(¬ify_dropped);
+
+ let (start_sender, start_receiver) = tokio::sync::oneshot::channel();
+ let (drop_sender, drop_receiver) = tokio::sync::oneshot::channel::<()>();
+ let join_handle = pool.spawn_pinned(|| async move {
+ let _drop_sender = drop_sender;
+ // Move the Arc into the task
+ let _notify_dropped = notify_dropped;
+ let _ = start_sender.send(());
+
+ // Keep the task running until it gets aborted
+ futures::future::pending::<()>().await;
+ });
+
+ // Wait for the task to start
+ let _ = start_receiver.await;
+
+ join_handle.abort();
+
+ // Wait for the inner task to abort, dropping the sender.
+ // The top level join handle aborts quicker than the inner task (the abort
+ // needs to propagate and get processed on the worker thread), so we can't
+ // just await the top level join handle.
+ let _ = drop_receiver.await;
+
+ // Check that the Arc has been dropped. This verifies that the inner task
+ // was canceled as well.
+ assert!(weak_notify_dropped.upgrade().is_none());
+}
+
+/// Tasks should be given to the least burdened worker. When spawning two tasks
+/// on a pool with two empty workers the tasks should be spawned on separate
+/// workers.
+#[tokio::test]
+async fn tasks_are_balanced() {
+ let pool = task::LocalPoolHandle::new(2);
+
+ // Spawn a task so one thread has a task count of 1
+ let (start_sender1, start_receiver1) = tokio::sync::oneshot::channel();
+ let (end_sender1, end_receiver1) = tokio::sync::oneshot::channel();
+ let join_handle1 = pool.spawn_pinned(|| async move {
+ let _ = start_sender1.send(());
+ let _ = end_receiver1.await;
+ std::thread::current().id()
+ });
+
+ // Wait for the first task to start up
+ let _ = start_receiver1.await;
+
+ // This task should be spawned on the other thread
+ let (start_sender2, start_receiver2) = tokio::sync::oneshot::channel();
+ let join_handle2 = pool.spawn_pinned(|| async move {
+ let _ = start_sender2.send(());
+ std::thread::current().id()
+ });
+
+ // Wait for the second task to start up
+ let _ = start_receiver2.await;
+
+ // Allow the first task to end
+ let _ = end_sender1.send(());
+
+ let thread_id1 = join_handle1.await.unwrap();
+ let thread_id2 = join_handle2.await.unwrap();
+
+ // Since the first task was active when the second task spawned, they should
+ // be on separate workers/threads.
+ assert_ne!(thread_id1, thread_id2);
+}
+
+#[tokio::test]
+async fn spawn_by_idx() {
+ let pool = task::LocalPoolHandle::new(3);
+ let barrier = Arc::new(Barrier::new(4));
+ let barrier1 = barrier.clone();
+ let barrier2 = barrier.clone();
+ let barrier3 = barrier.clone();
+
+ let handle1 = pool.spawn_pinned_by_idx(
+ || async move {
+ barrier1.wait().await;
+ std::thread::current().id()
+ },
+ 0,
+ );
+ let _ = pool.spawn_pinned_by_idx(
+ || async move {
+ barrier2.wait().await;
+ std::thread::current().id()
+ },
+ 0,
+ );
+ let handle2 = pool.spawn_pinned_by_idx(
+ || async move {
+ barrier3.wait().await;
+ std::thread::current().id()
+ },
+ 1,
+ );
+
+ let loads = pool.get_task_loads_for_each_worker();
+ barrier.wait().await;
+ assert_eq!(loads[0], 2);
+ assert_eq!(loads[1], 1);
+ assert_eq!(loads[2], 0);
+
+ let thread_id1 = handle1.await.unwrap();
+ let thread_id2 = handle2.await.unwrap();
+
+ assert_ne!(thread_id1, thread_id2);
+}
diff --git a/crates/tokio-util/tests/sync_cancellation_token.rs b/crates/tokio-util/tests/sync_cancellation_token.rs
new file mode 100644
index 0000000..279d74f
--- /dev/null
+++ b/crates/tokio-util/tests/sync_cancellation_token.rs
@@ -0,0 +1,447 @@
+#![warn(rust_2018_idioms)]
+
+use tokio::pin;
+use tokio_util::sync::{CancellationToken, WaitForCancellationFuture};
+
+use core::future::Future;
+use core::task::{Context, Poll};
+use futures_test::task::new_count_waker;
+
+#[test]
+fn cancel_token() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+ assert!(!token.is_cancelled());
+
+ let wait_fut = token.cancelled();
+ pin!(wait_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ wait_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ let wait_fut_2 = token.cancelled();
+ pin!(wait_fut_2);
+
+ token.cancel();
+ assert_eq!(wake_counter, 1);
+ assert!(token.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ wait_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ wait_fut_2.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+}
+
+#[test]
+fn cancel_token_owned() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+ assert!(!token.is_cancelled());
+
+ let wait_fut = token.clone().cancelled_owned();
+ pin!(wait_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ wait_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ let wait_fut_2 = token.clone().cancelled_owned();
+ pin!(wait_fut_2);
+
+ token.cancel();
+ assert_eq!(wake_counter, 1);
+ assert!(token.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ wait_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ wait_fut_2.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+}
+
+#[test]
+fn cancel_token_owned_drop_test() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+
+ let future = token.cancelled_owned();
+ pin!(future);
+
+ assert_eq!(
+ Poll::Pending,
+ future.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ // let future be dropped while pinned and under pending state to
+ // find potential memory related bugs.
+}
+
+#[test]
+fn cancel_child_token_through_parent() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+
+ let child_token = token.child_token();
+ assert!(!child_token.is_cancelled());
+
+ let child_fut = child_token.cancelled();
+ pin!(child_fut);
+ let parent_fut = token.cancelled();
+ pin!(parent_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ token.cancel();
+ assert_eq!(wake_counter, 2);
+ assert!(token.is_cancelled());
+ assert!(child_token.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+}
+
+#[test]
+fn cancel_grandchild_token_through_parent_if_child_was_dropped() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+
+ let intermediate_token = token.child_token();
+ let child_token = intermediate_token.child_token();
+ drop(intermediate_token);
+ assert!(!child_token.is_cancelled());
+
+ let child_fut = child_token.cancelled();
+ pin!(child_fut);
+ let parent_fut = token.cancelled();
+ pin!(parent_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ token.cancel();
+ assert_eq!(wake_counter, 2);
+ assert!(token.is_cancelled());
+ assert!(child_token.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+}
+
+#[test]
+fn cancel_child_token_without_parent() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+
+ let child_token_1 = token.child_token();
+
+ let child_fut = child_token_1.cancelled();
+ pin!(child_fut);
+ let parent_fut = token.cancelled();
+ pin!(parent_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ child_token_1.cancel();
+ assert_eq!(wake_counter, 1);
+ assert!(!token.is_cancelled());
+ assert!(child_token_1.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+
+ let child_token_2 = token.child_token();
+ let child_fut_2 = child_token_2.cancelled();
+ pin!(child_fut_2);
+
+ assert_eq!(
+ Poll::Pending,
+ child_fut_2.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+
+ token.cancel();
+ assert_eq!(wake_counter, 3);
+ assert!(token.is_cancelled());
+ assert!(child_token_2.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ child_fut_2.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+}
+
+#[test]
+fn create_child_token_after_parent_was_cancelled() {
+ for drop_child_first in [true, false].iter().cloned() {
+ let (waker, wake_counter) = new_count_waker();
+ let token = CancellationToken::new();
+ token.cancel();
+
+ let child_token = token.child_token();
+ assert!(child_token.is_cancelled());
+
+ {
+ let child_fut = child_token.cancelled();
+ pin!(child_fut);
+ let parent_fut = token.cancelled();
+ pin!(parent_fut);
+
+ assert_eq!(
+ Poll::Ready(()),
+ child_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+ }
+
+ if drop_child_first {
+ drop(child_token);
+ drop(token);
+ } else {
+ drop(token);
+ drop(child_token);
+ }
+ }
+}
+
+#[test]
+fn drop_multiple_child_tokens() {
+ for drop_first_child_first in &[true, false] {
+ let token = CancellationToken::new();
+ let mut child_tokens = [None, None, None];
+ for child in &mut child_tokens {
+ *child = Some(token.child_token());
+ }
+
+ assert!(!token.is_cancelled());
+ assert!(!child_tokens[0].as_ref().unwrap().is_cancelled());
+
+ for i in 0..child_tokens.len() {
+ if *drop_first_child_first {
+ child_tokens[i] = None;
+ } else {
+ child_tokens[child_tokens.len() - 1 - i] = None;
+ }
+ assert!(!token.is_cancelled());
+ }
+
+ drop(token);
+ }
+}
+
+#[test]
+fn cancel_only_all_descendants() {
+ // ARRANGE
+ let (waker, wake_counter) = new_count_waker();
+
+ let parent_token = CancellationToken::new();
+ let token = parent_token.child_token();
+ let sibling_token = parent_token.child_token();
+ let child1_token = token.child_token();
+ let child2_token = token.child_token();
+ let grandchild_token = child1_token.child_token();
+ let grandchild2_token = child1_token.child_token();
+ let great_grandchild_token = grandchild_token.child_token();
+
+ assert!(!parent_token.is_cancelled());
+ assert!(!token.is_cancelled());
+ assert!(!sibling_token.is_cancelled());
+ assert!(!child1_token.is_cancelled());
+ assert!(!child2_token.is_cancelled());
+ assert!(!grandchild_token.is_cancelled());
+ assert!(!grandchild2_token.is_cancelled());
+ assert!(!great_grandchild_token.is_cancelled());
+
+ let parent_fut = parent_token.cancelled();
+ let fut = token.cancelled();
+ let sibling_fut = sibling_token.cancelled();
+ let child1_fut = child1_token.cancelled();
+ let child2_fut = child2_token.cancelled();
+ let grandchild_fut = grandchild_token.cancelled();
+ let grandchild2_fut = grandchild2_token.cancelled();
+ let great_grandchild_fut = great_grandchild_token.cancelled();
+
+ pin!(parent_fut);
+ pin!(fut);
+ pin!(sibling_fut);
+ pin!(child1_fut);
+ pin!(child2_fut);
+ pin!(grandchild_fut);
+ pin!(grandchild2_fut);
+ pin!(great_grandchild_fut);
+
+ assert_eq!(
+ Poll::Pending,
+ parent_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ sibling_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ child1_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ child2_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ grandchild_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ grandchild2_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Pending,
+ great_grandchild_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 0);
+
+ // ACT
+ token.cancel();
+
+ // ASSERT
+ assert_eq!(wake_counter, 6);
+ assert!(!parent_token.is_cancelled());
+ assert!(token.is_cancelled());
+ assert!(!sibling_token.is_cancelled());
+ assert!(child1_token.is_cancelled());
+ assert!(child2_token.is_cancelled());
+ assert!(grandchild_token.is_cancelled());
+ assert!(grandchild2_token.is_cancelled());
+ assert!(great_grandchild_token.is_cancelled());
+
+ assert_eq!(
+ Poll::Ready(()),
+ fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ child1_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ child2_fut.as_mut().poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ grandchild_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ grandchild2_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(
+ Poll::Ready(()),
+ great_grandchild_fut
+ .as_mut()
+ .poll(&mut Context::from_waker(&waker))
+ );
+ assert_eq!(wake_counter, 6);
+}
+
+#[test]
+fn drop_parent_before_child_tokens() {
+ let token = CancellationToken::new();
+ let child1 = token.child_token();
+ let child2 = token.child_token();
+
+ drop(token);
+ assert!(!child1.is_cancelled());
+
+ drop(child1);
+ drop(child2);
+}
+
+#[test]
+fn derives_send_sync() {
+ fn assert_send<T: Send>() {}
+ fn assert_sync<T: Sync>() {}
+
+ assert_send::<CancellationToken>();
+ assert_sync::<CancellationToken>();
+
+ assert_send::<WaitForCancellationFuture<'static>>();
+ assert_sync::<WaitForCancellationFuture<'static>>();
+}
diff --git a/crates/tokio-util/tests/task_join_map.rs b/crates/tokio-util/tests/task_join_map.rs
new file mode 100644
index 0000000..1ab5f9b
--- /dev/null
+++ b/crates/tokio-util/tests/task_join_map.rs
@@ -0,0 +1,299 @@
+#![warn(rust_2018_idioms)]
+#![cfg(all(feature = "rt", tokio_unstable))]
+
+use tokio::sync::oneshot;
+use tokio::time::Duration;
+use tokio_util::task::JoinMap;
+
+use futures::future::FutureExt;
+
+fn rt() -> tokio::runtime::Runtime {
+ tokio::runtime::Builder::new_current_thread()
+ .build()
+ .unwrap()
+}
+
+#[tokio::test(start_paused = true)]
+async fn test_with_sleep() {
+ let mut map = JoinMap::new();
+
+ for i in 0..10 {
+ map.spawn(i, async move { i });
+ assert_eq!(map.len(), 1 + i);
+ }
+ map.detach_all();
+ assert_eq!(map.len(), 0);
+
+ assert!(matches!(map.join_next().await, None));
+
+ for i in 0..10 {
+ map.spawn(i, async move {
+ tokio::time::sleep(Duration::from_secs(i as u64)).await;
+ i
+ });
+ assert_eq!(map.len(), 1 + i);
+ }
+
+ let mut seen = [false; 10];
+ while let Some((k, res)) = map.join_next().await {
+ seen[k] = true;
+ assert_eq!(res.expect("task should have completed successfully"), k);
+ }
+
+ for was_seen in &seen {
+ assert!(was_seen);
+ }
+ assert!(matches!(map.join_next().await, None));
+
+ // Do it again.
+ for i in 0..10 {
+ map.spawn(i, async move {
+ tokio::time::sleep(Duration::from_secs(i as u64)).await;
+ i
+ });
+ }
+
+ let mut seen = [false; 10];
+ while let Some((k, res)) = map.join_next().await {
+ seen[k] = true;
+ assert_eq!(res.expect("task should have completed successfully"), k);
+ }
+
+ for was_seen in &seen {
+ assert!(was_seen);
+ }
+ assert!(matches!(map.join_next().await, None));
+}
+
+#[tokio::test]
+async fn test_abort_on_drop() {
+ let mut map = JoinMap::new();
+
+ let mut recvs = Vec::new();
+
+ for i in 0..16 {
+ let (send, recv) = oneshot::channel::<()>();
+ recvs.push(recv);
+
+ map.spawn(i, async {
+ // This task will never complete on its own.
+ futures::future::pending::<()>().await;
+ drop(send);
+ });
+ }
+
+ drop(map);
+
+ for recv in recvs {
+ // The task is aborted soon and we will receive an error.
+ assert!(recv.await.is_err());
+ }
+}
+
+#[tokio::test]
+async fn alternating() {
+ let mut map = JoinMap::new();
+
+ assert_eq!(map.len(), 0);
+ map.spawn(1, async {});
+ assert_eq!(map.len(), 1);
+ map.spawn(2, async {});
+ assert_eq!(map.len(), 2);
+
+ for i in 0..16 {
+ let (_, res) = map.join_next().await.unwrap();
+ assert!(res.is_ok());
+ assert_eq!(map.len(), 1);
+ map.spawn(i, async {});
+ assert_eq!(map.len(), 2);
+ }
+}
+
+#[tokio::test]
+async fn test_keys() {
+ use std::collections::HashSet;
+
+ let mut map = JoinMap::new();
+
+ assert_eq!(map.len(), 0);
+ map.spawn(1, async {});
+ assert_eq!(map.len(), 1);
+ map.spawn(2, async {});
+ assert_eq!(map.len(), 2);
+
+ let keys = map.keys().collect::<HashSet<&u32>>();
+ assert!(keys.contains(&1));
+ assert!(keys.contains(&2));
+
+ let _ = map.join_next().await.unwrap();
+ let _ = map.join_next().await.unwrap();
+
+ assert_eq!(map.len(), 0);
+ let keys = map.keys().collect::<HashSet<&u32>>();
+ assert!(keys.is_empty());
+}
+
+#[tokio::test(start_paused = true)]
+async fn abort_by_key() {
+ let mut map = JoinMap::new();
+ let mut num_canceled = 0;
+ let mut num_completed = 0;
+ for i in 0..16 {
+ map.spawn(i, async move {
+ tokio::time::sleep(Duration::from_secs(i as u64)).await;
+ });
+ }
+
+ for i in 0..16 {
+ if i % 2 != 0 {
+ // abort odd-numbered tasks.
+ map.abort(&i);
+ }
+ }
+
+ while let Some((key, res)) = map.join_next().await {
+ match res {
+ Ok(()) => {
+ num_completed += 1;
+ assert_eq!(key % 2, 0);
+ assert!(!map.contains_key(&key));
+ }
+ Err(e) => {
+ num_canceled += 1;
+ assert!(e.is_cancelled());
+ assert_ne!(key % 2, 0);
+ assert!(!map.contains_key(&key));
+ }
+ }
+ }
+
+ assert_eq!(num_canceled, 8);
+ assert_eq!(num_completed, 8);
+}
+
+#[tokio::test(start_paused = true)]
+async fn abort_by_predicate() {
+ let mut map = JoinMap::new();
+ let mut num_canceled = 0;
+ let mut num_completed = 0;
+ for i in 0..16 {
+ map.spawn(i, async move {
+ tokio::time::sleep(Duration::from_secs(i as u64)).await;
+ });
+ }
+
+ // abort odd-numbered tasks.
+ map.abort_matching(|key| key % 2 != 0);
+
+ while let Some((key, res)) = map.join_next().await {
+ match res {
+ Ok(()) => {
+ num_completed += 1;
+ assert_eq!(key % 2, 0);
+ assert!(!map.contains_key(&key));
+ }
+ Err(e) => {
+ num_canceled += 1;
+ assert!(e.is_cancelled());
+ assert_ne!(key % 2, 0);
+ assert!(!map.contains_key(&key));
+ }
+ }
+ }
+
+ assert_eq!(num_canceled, 8);
+ assert_eq!(num_completed, 8);
+}
+
+#[test]
+fn runtime_gone() {
+ let mut map = JoinMap::new();
+ {
+ let rt = rt();
+ map.spawn_on("key", async { 1 }, rt.handle());
+ drop(rt);
+ }
+
+ let (key, res) = rt().block_on(map.join_next()).unwrap();
+ assert_eq!(key, "key");
+ assert!(res.unwrap_err().is_cancelled());
+}
+
+// This ensures that `join_next` works correctly when the coop budget is
+// exhausted.
+#[tokio::test(flavor = "current_thread")]
+async fn join_map_coop() {
+ // Large enough to trigger coop.
+ const TASK_NUM: u32 = 1000;
+
+ static SEM: tokio::sync::Semaphore = tokio::sync::Semaphore::const_new(0);
+
+ let mut map = JoinMap::new();
+
+ for i in 0..TASK_NUM {
+ map.spawn(i, async move {
+ SEM.add_permits(1);
+ i
+ });
+ }
+
+ // Wait for all tasks to complete.
+ //
+ // Since this is a `current_thread` runtime, there's no race condition
+ // between the last permit being added and the task completing.
+ let _ = SEM.acquire_many(TASK_NUM).await.unwrap();
+
+ let mut count = 0;
+ let mut coop_count = 0;
+ loop {
+ match map.join_next().now_or_never() {
+ Some(Some((key, Ok(i)))) => assert_eq!(key, i),
+ Some(Some((key, Err(err)))) => panic!("failed[{}]: {}", key, err),
+ None => {
+ coop_count += 1;
+ tokio::task::yield_now().await;
+ continue;
+ }
+ Some(None) => break,
+ }
+
+ count += 1;
+ }
+ assert!(coop_count >= 1);
+ assert_eq!(count, TASK_NUM);
+}
+
+#[tokio::test(start_paused = true)]
+async fn abort_all() {
+ let mut map: JoinMap<usize, ()> = JoinMap::new();
+
+ for i in 0..5 {
+ map.spawn(i, futures::future::pending());
+ }
+ for i in 5..10 {
+ map.spawn(i, async {
+ tokio::time::sleep(Duration::from_secs(1)).await;
+ });
+ }
+
+ // The join map will now have 5 pending tasks and 5 ready tasks.
+ tokio::time::sleep(Duration::from_secs(2)).await;
+
+ map.abort_all();
+ assert_eq!(map.len(), 10);
+
+ let mut count = 0;
+ let mut seen = [false; 10];
+ while let Some((k, res)) = map.join_next().await {
+ seen[k] = true;
+ if let Err(err) = res {
+ assert!(err.is_cancelled());
+ }
+ count += 1;
+ }
+ assert_eq!(count, 10);
+ assert_eq!(map.len(), 0);
+ for was_seen in &seen {
+ assert!(was_seen);
+ }
+}
diff --git a/crates/tokio-util/tests/task_tracker.rs b/crates/tokio-util/tests/task_tracker.rs
new file mode 100644
index 0000000..f0eb244
--- /dev/null
+++ b/crates/tokio-util/tests/task_tracker.rs
@@ -0,0 +1,178 @@
+#![warn(rust_2018_idioms)]
+
+use tokio_test::{assert_pending, assert_ready, task};
+use tokio_util::task::TaskTracker;
+
+#[test]
+fn open_close() {
+ let tracker = TaskTracker::new();
+ assert!(!tracker.is_closed());
+ assert!(tracker.is_empty());
+ assert_eq!(tracker.len(), 0);
+
+ tracker.close();
+ assert!(tracker.is_closed());
+ assert!(tracker.is_empty());
+ assert_eq!(tracker.len(), 0);
+
+ tracker.reopen();
+ assert!(!tracker.is_closed());
+ tracker.reopen();
+ assert!(!tracker.is_closed());
+
+ assert!(tracker.is_empty());
+ assert_eq!(tracker.len(), 0);
+
+ tracker.close();
+ assert!(tracker.is_closed());
+ tracker.close();
+ assert!(tracker.is_closed());
+
+ assert!(tracker.is_empty());
+ assert_eq!(tracker.len(), 0);
+}
+
+#[test]
+fn token_len() {
+ let tracker = TaskTracker::new();
+
+ let mut tokens = Vec::new();
+ for i in 0..10 {
+ assert_eq!(tracker.len(), i);
+ tokens.push(tracker.token());
+ }
+
+ assert!(!tracker.is_empty());
+ assert_eq!(tracker.len(), 10);
+
+ for (i, token) in tokens.into_iter().enumerate() {
+ drop(token);
+ assert_eq!(tracker.len(), 9 - i);
+ }
+}
+
+#[test]
+fn notify_immediately() {
+ let tracker = TaskTracker::new();
+ tracker.close();
+
+ let mut wait = task::spawn(tracker.wait());
+ assert_ready!(wait.poll());
+}
+
+#[test]
+fn notify_immediately_on_reopen() {
+ let tracker = TaskTracker::new();
+ tracker.close();
+
+ let mut wait = task::spawn(tracker.wait());
+ tracker.reopen();
+ assert_ready!(wait.poll());
+}
+
+#[test]
+fn notify_on_close() {
+ let tracker = TaskTracker::new();
+
+ let mut wait = task::spawn(tracker.wait());
+
+ assert_pending!(wait.poll());
+ tracker.close();
+ assert_ready!(wait.poll());
+}
+
+#[test]
+fn notify_on_close_reopen() {
+ let tracker = TaskTracker::new();
+
+ let mut wait = task::spawn(tracker.wait());
+
+ assert_pending!(wait.poll());
+ tracker.close();
+ tracker.reopen();
+ assert_ready!(wait.poll());
+}
+
+#[test]
+fn notify_on_last_task() {
+ let tracker = TaskTracker::new();
+ tracker.close();
+ let token = tracker.token();
+
+ let mut wait = task::spawn(tracker.wait());
+ assert_pending!(wait.poll());
+ drop(token);
+ assert_ready!(wait.poll());
+}
+
+#[test]
+fn notify_on_last_task_respawn() {
+ let tracker = TaskTracker::new();
+ tracker.close();
+ let token = tracker.token();
+
+ let mut wait = task::spawn(tracker.wait());
+ assert_pending!(wait.poll());
+ drop(token);
+ let token2 = tracker.token();
+ assert_ready!(wait.poll());
+ drop(token2);
+}
+
+#[test]
+fn no_notify_on_respawn_if_open() {
+ let tracker = TaskTracker::new();
+ let token = tracker.token();
+
+ let mut wait = task::spawn(tracker.wait());
+ assert_pending!(wait.poll());
+ drop(token);
+ let token2 = tracker.token();
+ assert_pending!(wait.poll());
+ drop(token2);
+}
+
+#[test]
+fn close_during_exit() {
+ const ITERS: usize = 5;
+
+ for close_spot in 0..=ITERS {
+ let tracker = TaskTracker::new();
+ let tokens: Vec<_> = (0..ITERS).map(|_| tracker.token()).collect();
+
+ let mut wait = task::spawn(tracker.wait());
+
+ for (i, token) in tokens.into_iter().enumerate() {
+ assert_pending!(wait.poll());
+ if i == close_spot {
+ tracker.close();
+ assert_pending!(wait.poll());
+ }
+ drop(token);
+ }
+
+ if close_spot == ITERS {
+ assert_pending!(wait.poll());
+ tracker.close();
+ }
+
+ assert_ready!(wait.poll());
+ }
+}
+
+#[test]
+fn notify_many() {
+ let tracker = TaskTracker::new();
+
+ let mut waits: Vec<_> = (0..10).map(|_| task::spawn(tracker.wait())).collect();
+
+ for wait in &mut waits {
+ assert_pending!(wait.poll());
+ }
+
+ tracker.close();
+
+ for wait in &mut waits {
+ assert_ready!(wait.poll());
+ }
+}
diff --git a/crates/tokio-util/tests/time_delay_queue.rs b/crates/tokio-util/tests/time_delay_queue.rs
new file mode 100644
index 0000000..9b7b6cc
--- /dev/null
+++ b/crates/tokio-util/tests/time_delay_queue.rs
@@ -0,0 +1,883 @@
+#![allow(clippy::disallowed_names)]
+#![warn(rust_2018_idioms)]
+#![cfg(feature = "full")]
+
+use futures::StreamExt;
+use tokio::time::{self, sleep, sleep_until, Duration, Instant};
+use tokio_test::{assert_pending, assert_ready, task};
+use tokio_util::time::DelayQueue;
+
+macro_rules! poll {
+ ($queue:ident) => {
+ $queue.enter(|cx, mut queue| queue.poll_expired(cx))
+ };
+}
+
+macro_rules! assert_ready_some {
+ ($e:expr) => {{
+ match assert_ready!($e) {
+ Some(v) => v,
+ None => panic!("None"),
+ }
+ }};
+}
+
+#[tokio::test]
+async fn single_immediate_delay() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let _key = queue.insert_at("foo", Instant::now());
+
+ // Advance time by 1ms to handle thee rounding
+ sleep(ms(1)).await;
+
+ assert_ready_some!(poll!(queue));
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none())
+}
+
+#[tokio::test]
+async fn multi_immediate_delays() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let _k = queue.insert_at("1", Instant::now());
+ let _k = queue.insert_at("2", Instant::now());
+ let _k = queue.insert_at("3", Instant::now());
+
+ sleep(ms(1)).await;
+
+ let mut res = vec![];
+
+ while res.len() < 3 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none());
+
+ res.sort_unstable();
+
+ assert_eq!("1", res[0]);
+ assert_eq!("2", res[1]);
+ assert_eq!("3", res[2]);
+}
+
+#[tokio::test]
+async fn single_short_delay() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let _key = queue.insert_at("foo", Instant::now() + ms(5));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(1)).await;
+
+ assert!(!queue.is_woken());
+
+ sleep(ms(5)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(*entry.get_ref(), "foo");
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none());
+}
+
+#[tokio::test]
+async fn multi_delay_at_start() {
+ time::pause();
+
+ let long = 262_144 + 9 * 4096;
+ let delays = &[1000, 2, 234, long, 60, 10];
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ // Setup the delays
+ for &i in delays {
+ let _key = queue.insert_at(i, Instant::now() + ms(i));
+ }
+
+ assert_pending!(poll!(queue));
+ assert!(!queue.is_woken());
+
+ let start = Instant::now();
+ for elapsed in 0..1200 {
+ println!("elapsed: {:?}", elapsed);
+ let elapsed = elapsed + 1;
+ tokio::time::sleep_until(start + ms(elapsed)).await;
+
+ if delays.contains(&elapsed) {
+ assert!(queue.is_woken());
+ assert_ready!(poll!(queue));
+ assert_pending!(poll!(queue));
+ } else if queue.is_woken() {
+ let cascade = &[192, 960];
+ assert!(
+ cascade.contains(&elapsed),
+ "elapsed={} dt={:?}",
+ elapsed,
+ Instant::now() - start
+ );
+
+ assert_pending!(poll!(queue));
+ }
+ }
+ println!("finished multi_delay_start");
+}
+
+#[tokio::test]
+async fn insert_in_past_fires_immediately() {
+ println!("running insert_in_past_fires_immediately");
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let now = Instant::now();
+
+ sleep(ms(10)).await;
+
+ queue.insert_at("foo", now);
+
+ assert_ready!(poll!(queue));
+ println!("finished insert_in_past_fires_immediately");
+}
+
+#[tokio::test]
+async fn remove_entry() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let key = queue.insert_at("foo", Instant::now() + ms(5));
+
+ assert_pending!(poll!(queue));
+
+ let entry = queue.remove(&key);
+ assert_eq!(entry.into_inner(), "foo");
+
+ sleep(ms(10)).await;
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none());
+}
+
+#[tokio::test]
+async fn reset_entry() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+ let key = queue.insert_at("foo", now + ms(5));
+
+ assert_pending!(poll!(queue));
+ sleep(ms(1)).await;
+
+ queue.reset_at(&key, now + ms(10));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(7)).await;
+
+ assert!(!queue.is_woken());
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(3)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(*entry.get_ref(), "foo");
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none())
+}
+
+// Reproduces tokio-rs/tokio#849.
+#[tokio::test]
+async fn reset_much_later() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+ sleep(ms(1)).await;
+
+ let key = queue.insert_at("foo", now + ms(200));
+ assert_pending!(poll!(queue));
+
+ sleep(ms(3)).await;
+
+ queue.reset_at(&key, now + ms(10));
+
+ sleep(ms(20)).await;
+
+ assert!(queue.is_woken());
+}
+
+// Reproduces tokio-rs/tokio#849.
+#[tokio::test]
+async fn reset_twice() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let now = Instant::now();
+
+ sleep(ms(1)).await;
+
+ let key = queue.insert_at("foo", now + ms(200));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(3)).await;
+
+ queue.reset_at(&key, now + ms(50));
+
+ sleep(ms(20)).await;
+
+ queue.reset_at(&key, now + ms(40));
+
+ sleep(ms(20)).await;
+
+ assert!(queue.is_woken());
+}
+
+/// Regression test: Given an entry inserted with a deadline in the past, so
+/// that it is placed directly on the expired queue, reset the entry to a
+/// deadline in the future. Validate that this leaves the entry and queue in an
+/// internally consistent state by running an additional reset on the entry
+/// before polling it to completion.
+#[tokio::test]
+async fn repeatedly_reset_entry_inserted_as_expired() {
+ time::pause();
+
+ // Instants before the start of the test seem to break in wasm.
+ time::sleep(ms(1000)).await;
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let now = Instant::now();
+
+ let key = queue.insert_at("foo", now - ms(100));
+
+ queue.reset_at(&key, now + ms(100));
+ queue.reset_at(&key, now + ms(50));
+
+ assert_pending!(poll!(queue));
+
+ time::sleep_until(now + ms(60)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "foo");
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none());
+}
+
+#[tokio::test]
+async fn remove_expired_item() {
+ time::pause();
+
+ let mut queue = DelayQueue::new();
+
+ let now = Instant::now();
+
+ sleep(ms(10)).await;
+
+ let key = queue.insert_at("foo", now);
+
+ let entry = queue.remove(&key);
+ assert_eq!(entry.into_inner(), "foo");
+}
+
+/// Regression test: it should be possible to remove entries which fall in the
+/// 0th slot of the internal timer wheel — that is, entries whose expiration
+/// (a) falls at the beginning of one of the wheel's hierarchical levels and (b)
+/// is equal to the wheel's current elapsed time.
+#[tokio::test]
+async fn remove_at_timer_wheel_threshold() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let key1 = queue.insert_at("foo", now + ms(64));
+ let key2 = queue.insert_at("bar", now + ms(64));
+
+ sleep(ms(80)).await;
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+
+ match entry {
+ "foo" => {
+ let entry = queue.remove(&key2).into_inner();
+ assert_eq!(entry, "bar");
+ }
+ "bar" => {
+ let entry = queue.remove(&key1).into_inner();
+ assert_eq!(entry, "foo");
+ }
+ other => panic!("other: {:?}", other),
+ }
+}
+
+#[tokio::test]
+async fn expires_before_last_insert() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("foo", now + ms(10_000));
+
+ // Delay should be set to 8.192s here.
+ assert_pending!(poll!(queue));
+
+ // Delay should be set to the delay of the new item here
+ queue.insert_at("bar", now + ms(600));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(600)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "bar");
+}
+
+#[tokio::test]
+async fn multi_reset() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let one = queue.insert_at("one", now + ms(200));
+ let two = queue.insert_at("two", now + ms(250));
+
+ assert_pending!(poll!(queue));
+
+ queue.reset_at(&one, now + ms(300));
+ queue.reset_at(&two, now + ms(350));
+ queue.reset_at(&one, now + ms(400));
+
+ sleep(ms(310)).await;
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(50)).await;
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(*entry.get_ref(), "two");
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(50)).await;
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(*entry.get_ref(), "one");
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none())
+}
+
+#[tokio::test]
+async fn expire_first_key_when_reset_to_expire_earlier() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let one = queue.insert_at("one", now + ms(200));
+ queue.insert_at("two", now + ms(250));
+
+ assert_pending!(poll!(queue));
+
+ queue.reset_at(&one, now + ms(100));
+
+ sleep(ms(100)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "one");
+}
+
+#[tokio::test]
+async fn expire_second_key_when_reset_to_expire_earlier() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("one", now + ms(200));
+ let two = queue.insert_at("two", now + ms(250));
+
+ assert_pending!(poll!(queue));
+
+ queue.reset_at(&two, now + ms(100));
+
+ sleep(ms(100)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "two");
+}
+
+#[tokio::test]
+async fn reset_first_expiring_item_to_expire_later() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let one = queue.insert_at("one", now + ms(200));
+ let _two = queue.insert_at("two", now + ms(250));
+
+ assert_pending!(poll!(queue));
+
+ queue.reset_at(&one, now + ms(300));
+ sleep(ms(250)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "two");
+}
+
+#[tokio::test]
+async fn insert_before_first_after_poll() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let _one = queue.insert_at("one", now + ms(200));
+
+ assert_pending!(poll!(queue));
+
+ let _two = queue.insert_at("two", now + ms(100));
+
+ sleep(ms(99)).await;
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(1)).await;
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "two");
+}
+
+#[tokio::test]
+async fn insert_after_ready_poll() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("1", now + ms(100));
+ queue.insert_at("2", now + ms(100));
+ queue.insert_at("3", now + ms(100));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(100)).await;
+
+ assert!(queue.is_woken());
+
+ let mut res = vec![];
+
+ while res.len() < 3 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ queue.insert_at("foo", now + ms(500));
+ }
+
+ res.sort_unstable();
+
+ assert_eq!("1", res[0]);
+ assert_eq!("2", res[1]);
+ assert_eq!("3", res[2]);
+}
+
+#[tokio::test]
+async fn reset_later_after_slot_starts() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let foo = queue.insert_at("foo", now + ms(100));
+
+ assert_pending!(poll!(queue));
+
+ sleep_until(now + Duration::from_millis(80)).await;
+
+ assert!(!queue.is_woken());
+
+ // At this point the queue hasn't been polled, so `elapsed` on the wheel
+ // for the queue is still at 0 and hence the 1ms resolution slots cover
+ // [0-64). Resetting the time on the entry to 120 causes it to get put in
+ // the [64-128) slot. As the queue knows that the first entry is within
+ // that slot, but doesn't know when, it must wake immediately to advance
+ // the wheel.
+ queue.reset_at(&foo, now + ms(120));
+ assert!(queue.is_woken());
+
+ assert_pending!(poll!(queue));
+
+ sleep_until(now + Duration::from_millis(119)).await;
+ assert!(!queue.is_woken());
+
+ sleep(ms(1)).await;
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "foo");
+}
+
+#[tokio::test]
+async fn reset_inserted_expired() {
+ time::pause();
+
+ // Instants before the start of the test seem to break in wasm.
+ time::sleep(ms(1000)).await;
+
+ let mut queue = task::spawn(DelayQueue::new());
+ let now = Instant::now();
+
+ let key = queue.insert_at("foo", now - ms(100));
+
+ // this causes the panic described in #2473
+ queue.reset_at(&key, now + ms(100));
+
+ assert_eq!(1, queue.len());
+
+ sleep(ms(200)).await;
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "foo");
+
+ assert_eq!(queue.len(), 0);
+}
+
+#[tokio::test]
+async fn reset_earlier_after_slot_starts() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let foo = queue.insert_at("foo", now + ms(200));
+
+ assert_pending!(poll!(queue));
+
+ sleep_until(now + Duration::from_millis(80)).await;
+
+ assert!(!queue.is_woken());
+
+ // At this point the queue hasn't been polled, so `elapsed` on the wheel
+ // for the queue is still at 0 and hence the 1ms resolution slots cover
+ // [0-64). Resetting the time on the entry to 120 causes it to get put in
+ // the [64-128) slot. As the queue knows that the first entry is within
+ // that slot, but doesn't know when, it must wake immediately to advance
+ // the wheel.
+ queue.reset_at(&foo, now + ms(120));
+ assert!(queue.is_woken());
+
+ assert_pending!(poll!(queue));
+
+ sleep_until(now + Duration::from_millis(119)).await;
+ assert!(!queue.is_woken());
+
+ sleep(ms(1)).await;
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "foo");
+}
+
+#[tokio::test]
+async fn insert_in_past_after_poll_fires_immediately() {
+ time::pause();
+
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("foo", now + ms(200));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(80)).await;
+
+ assert!(!queue.is_woken());
+ queue.insert_at("bar", now + ms(40));
+
+ assert!(queue.is_woken());
+
+ let entry = assert_ready_some!(poll!(queue)).into_inner();
+ assert_eq!(entry, "bar");
+}
+
+#[tokio::test]
+async fn delay_queue_poll_expired_when_empty() {
+ let mut delay_queue = task::spawn(DelayQueue::new());
+ let key = delay_queue.insert(0, std::time::Duration::from_secs(10));
+ assert_pending!(poll!(delay_queue));
+
+ delay_queue.remove(&key);
+ assert!(assert_ready!(poll!(delay_queue)).is_none());
+}
+
+#[tokio::test(start_paused = true)]
+async fn compact_expire_empty() {
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("foo1", now + ms(10));
+ queue.insert_at("foo2", now + ms(10));
+
+ sleep(ms(10)).await;
+
+ let mut res = vec![];
+ while res.len() < 2 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ queue.compact();
+
+ assert_eq!(queue.len(), 0);
+ assert_eq!(queue.capacity(), 0);
+}
+
+#[tokio::test(start_paused = true)]
+async fn compact_remove_empty() {
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let key1 = queue.insert_at("foo1", now + ms(10));
+ let key2 = queue.insert_at("foo2", now + ms(10));
+
+ queue.remove(&key1);
+ queue.remove(&key2);
+
+ queue.compact();
+
+ assert_eq!(queue.len(), 0);
+ assert_eq!(queue.capacity(), 0);
+}
+
+#[tokio::test(start_paused = true)]
+// Trigger a re-mapping of keys in the slab due to a `compact` call and
+// test removal of re-mapped keys
+async fn compact_remove_remapped_keys() {
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ queue.insert_at("foo1", now + ms(10));
+ queue.insert_at("foo2", now + ms(10));
+
+ // should be assigned indices 3 and 4
+ let key3 = queue.insert_at("foo3", now + ms(20));
+ let key4 = queue.insert_at("foo4", now + ms(20));
+
+ sleep(ms(10)).await;
+
+ let mut res = vec![];
+ while res.len() < 2 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ // items corresponding to `foo3` and `foo4` will be assigned
+ // new indices here
+ queue.compact();
+
+ queue.insert_at("foo5", now + ms(10));
+
+ // test removal of re-mapped keys
+ let expired3 = queue.remove(&key3);
+ let expired4 = queue.remove(&key4);
+
+ assert_eq!(expired3.into_inner(), "foo3");
+ assert_eq!(expired4.into_inner(), "foo4");
+
+ queue.compact();
+ assert_eq!(queue.len(), 1);
+ assert_eq!(queue.capacity(), 1);
+}
+
+#[tokio::test(start_paused = true)]
+async fn compact_change_deadline() {
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let mut now = Instant::now();
+
+ queue.insert_at("foo1", now + ms(10));
+ queue.insert_at("foo2", now + ms(10));
+
+ // should be assigned indices 3 and 4
+ queue.insert_at("foo3", now + ms(20));
+ let key4 = queue.insert_at("foo4", now + ms(20));
+
+ sleep(ms(10)).await;
+
+ let mut res = vec![];
+ while res.len() < 2 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ // items corresponding to `foo3` and `foo4` should be assigned
+ // new indices
+ queue.compact();
+
+ now = Instant::now();
+
+ queue.insert_at("foo5", now + ms(10));
+ let key6 = queue.insert_at("foo6", now + ms(10));
+
+ queue.reset_at(&key4, now + ms(20));
+ queue.reset_at(&key6, now + ms(20));
+
+ // foo3 and foo5 will expire
+ sleep(ms(10)).await;
+
+ while res.len() < 4 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ sleep(ms(10)).await;
+
+ while res.len() < 6 {
+ let entry = assert_ready_some!(poll!(queue));
+ res.push(entry.into_inner());
+ }
+
+ let entry = assert_ready!(poll!(queue));
+ assert!(entry.is_none());
+}
+
+#[tokio::test(start_paused = true)]
+async fn item_expiry_greater_than_wheel() {
+ // This function tests that a delay queue that has existed for at least 2^36 milliseconds won't panic when a new item is inserted.
+ let mut queue = DelayQueue::new();
+ for _ in 0..2 {
+ tokio::time::advance(Duration::from_millis(1 << 35)).await;
+ queue.insert(0, Duration::from_millis(0));
+ queue.next().await;
+ }
+ // This should not panic
+ let no_panic = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
+ queue.insert(1, Duration::from_millis(1));
+ }));
+ assert!(no_panic.is_ok());
+}
+
+#[cfg_attr(target_os = "wasi", ignore = "FIXME: Does not seem to work with WASI")]
+#[tokio::test(start_paused = true)]
+async fn remove_after_compact() {
+ let now = Instant::now();
+ let mut queue = DelayQueue::new();
+
+ let foo_key = queue.insert_at("foo", now + ms(10));
+ queue.insert_at("bar", now + ms(20));
+ queue.remove(&foo_key);
+ queue.compact();
+
+ let panic = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
+ queue.remove(&foo_key);
+ }));
+ assert!(panic.is_err());
+}
+
+#[cfg_attr(target_os = "wasi", ignore = "FIXME: Does not seem to work with WASI")]
+#[tokio::test(start_paused = true)]
+async fn remove_after_compact_poll() {
+ let now = Instant::now();
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let foo_key = queue.insert_at("foo", now + ms(10));
+ queue.insert_at("bar", now + ms(20));
+
+ sleep(ms(10)).await;
+ assert_eq!(assert_ready_some!(poll!(queue)).key(), foo_key);
+
+ queue.compact();
+
+ let panic = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
+ queue.remove(&foo_key);
+ }));
+ assert!(panic.is_err());
+}
+
+#[tokio::test(start_paused = true)]
+async fn peek() {
+ let mut queue = task::spawn(DelayQueue::new());
+
+ let now = Instant::now();
+
+ let key = queue.insert_at("foo", now + ms(5));
+ let key2 = queue.insert_at("bar", now);
+ let key3 = queue.insert_at("baz", now + ms(10));
+
+ assert_eq!(queue.peek(), Some(key2));
+
+ sleep(ms(6)).await;
+
+ assert_eq!(queue.peek(), Some(key2));
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(entry.get_ref(), &"bar");
+
+ assert_eq!(queue.peek(), Some(key));
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(entry.get_ref(), &"foo");
+
+ assert_eq!(queue.peek(), Some(key3));
+
+ assert_pending!(poll!(queue));
+
+ sleep(ms(5)).await;
+
+ assert_eq!(queue.peek(), Some(key3));
+
+ let entry = assert_ready_some!(poll!(queue));
+ assert_eq!(entry.get_ref(), &"baz");
+
+ assert!(queue.peek().is_none());
+}
+
+fn ms(n: u64) -> Duration {
+ Duration::from_millis(n)
+}
diff --git a/crates/tokio-util/tests/udp.rs b/crates/tokio-util/tests/udp.rs
new file mode 100644
index 0000000..db726a3
--- /dev/null
+++ b/crates/tokio-util/tests/udp.rs
@@ -0,0 +1,136 @@
+#![warn(rust_2018_idioms)]
+#![cfg(not(target_os = "wasi"))] // Wasi doesn't support UDP
+
+use tokio::net::UdpSocket;
+use tokio_stream::StreamExt;
+use tokio_util::codec::{Decoder, Encoder, LinesCodec};
+use tokio_util::udp::UdpFramed;
+
+use bytes::{BufMut, BytesMut};
+use futures::future::try_join;
+use futures::future::FutureExt;
+use futures::sink::SinkExt;
+use std::io;
+use std::sync::Arc;
+
+#[cfg_attr(
+ any(target_os = "macos", target_os = "ios", target_os = "tvos"),
+ allow(unused_assignments)
+)]
+#[tokio::test]
+async fn send_framed_byte_codec() -> std::io::Result<()> {
+ let mut a_soc = UdpSocket::bind("127.0.0.1:0").await?;
+ let mut b_soc = UdpSocket::bind("127.0.0.1:0").await?;
+
+ let a_addr = a_soc.local_addr()?;
+ let b_addr = b_soc.local_addr()?;
+
+ // test sending & receiving bytes
+ {
+ let mut a = UdpFramed::new(a_soc, ByteCodec);
+ let mut b = UdpFramed::new(b_soc, ByteCodec);
+
+ let msg = b"4567";
+
+ let send = a.send((msg, b_addr));
+ let recv = b.next().map(|e| e.unwrap());
+ let (_, received) = try_join(send, recv).await.unwrap();
+
+ let (data, addr) = received;
+ assert_eq!(msg, &*data);
+ assert_eq!(a_addr, addr);
+
+ a_soc = a.into_inner();
+ b_soc = b.into_inner();
+ }
+
+ #[cfg(not(any(target_os = "macos", target_os = "ios", target_os = "tvos")))]
+ // test sending & receiving an empty message
+ {
+ let mut a = UdpFramed::new(a_soc, ByteCodec);
+ let mut b = UdpFramed::new(b_soc, ByteCodec);
+
+ let msg = b"";
+
+ let send = a.send((msg, b_addr));
+ let recv = b.next().map(|e| e.unwrap());
+ let (_, received) = try_join(send, recv).await.unwrap();
+
+ let (data, addr) = received;
+ assert_eq!(msg, &*data);
+ assert_eq!(a_addr, addr);
+ }
+
+ Ok(())
+}
+
+pub struct ByteCodec;
+
+impl Decoder for ByteCodec {
+ type Item = Vec<u8>;
+ type Error = io::Error;
+
+ fn decode(&mut self, buf: &mut BytesMut) -> Result<Option<Vec<u8>>, io::Error> {
+ let len = buf.len();
+ Ok(Some(buf.split_to(len).to_vec()))
+ }
+}
+
+impl Encoder<&[u8]> for ByteCodec {
+ type Error = io::Error;
+
+ fn encode(&mut self, data: &[u8], buf: &mut BytesMut) -> Result<(), io::Error> {
+ buf.reserve(data.len());
+ buf.put_slice(data);
+ Ok(())
+ }
+}
+
+#[tokio::test]
+async fn send_framed_lines_codec() -> std::io::Result<()> {
+ let a_soc = UdpSocket::bind("127.0.0.1:0").await?;
+ let b_soc = UdpSocket::bind("127.0.0.1:0").await?;
+
+ let a_addr = a_soc.local_addr()?;
+ let b_addr = b_soc.local_addr()?;
+
+ let mut a = UdpFramed::new(a_soc, ByteCodec);
+ let mut b = UdpFramed::new(b_soc, LinesCodec::new());
+
+ let msg = b"1\r\n2\r\n3\r\n".to_vec();
+ a.send((&msg, b_addr)).await?;
+
+ assert_eq!(b.next().await.unwrap().unwrap(), ("1".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("2".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("3".to_string(), a_addr));
+
+ Ok(())
+}
+
+#[tokio::test]
+async fn framed_half() -> std::io::Result<()> {
+ let a_soc = Arc::new(UdpSocket::bind("127.0.0.1:0").await?);
+ let b_soc = a_soc.clone();
+
+ let a_addr = a_soc.local_addr()?;
+ let b_addr = b_soc.local_addr()?;
+
+ let mut a = UdpFramed::new(a_soc, ByteCodec);
+ let mut b = UdpFramed::new(b_soc, LinesCodec::new());
+
+ let msg = b"1\r\n2\r\n3\r\n".to_vec();
+ a.send((&msg, b_addr)).await?;
+
+ let msg = b"4\r\n5\r\n6\r\n".to_vec();
+ a.send((&msg, b_addr)).await?;
+
+ assert_eq!(b.next().await.unwrap().unwrap(), ("1".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("2".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("3".to_string(), a_addr));
+
+ assert_eq!(b.next().await.unwrap().unwrap(), ("4".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("5".to_string(), a_addr));
+ assert_eq!(b.next().await.unwrap().unwrap(), ("6".to_string(), a_addr));
+
+ Ok(())
+}
diff --git a/crates/tower-layer/.cargo-checksum.json b/crates/tower-layer/.cargo-checksum.json
new file mode 100644
index 0000000..5fd4317
--- /dev/null
+++ b/crates/tower-layer/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"6ee79947b4955229622b03cd1fe2a58345ae1a10f07f065716a067b7cfe6e26b","Cargo.toml":"0fa53842f7a4b3c03546de5e57d2f8f98ccd9c6ccbe851a7a88e81dbf74aa320","LICENSE":"4249c8e6c5ebb85f97c77e6457c6fafc1066406eb8f1ef61e796fbdc5ff18482","README.md":"224c67c67c5cbdbfd6f46a0ef4833a09798c4edb7faffaf3c549bec7f4780173","src/identity.rs":"a0420007d53421ddf4efb13ea06f1462f6e4258584bca11cf5d1df1cf76512f8","src/layer_fn.rs":"bee7fb3ad2d016fea7fd47b298677b74d30cd459f019fa2d74940a6cc2237ddb","src/lib.rs":"1ea5230dbff1b667aa4cb9afe361e0d7fe48248c193b62ceb75ebf33e866c85b","src/stack.rs":"e79e03345a1488a45200f92b610eb494e05dbd1d9bcb667335c61d7647b3556a","src/tuple.rs":"420dc53fbde5a4c213a2a70bce6ae755953b7fbddd1e895d6f4d62e2591ae466"},"package":"c20c8dbed6283a09604c3e69b4b7eeb54e298b8a600d4d5ecb5ad39de609f1d0"}
\ No newline at end of file
diff --git a/crates/tower-layer/Android.bp b/crates/tower-layer/Android.bp
new file mode 100644
index 0000000..88ce13e
--- /dev/null
+++ b/crates/tower-layer/Android.bp
@@ -0,0 +1,49 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tower-layer_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tower-layer_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtower_layer",
+ host_supported: true,
+ crate_name: "tower_layer",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.2",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "tower-layer_test_src_lib",
+ host_supported: true,
+ crate_name: "tower_layer",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.2",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ rustlibs: [
+ "libtower",
+ "libtower_service",
+ ],
+}
diff --git a/crates/tower-layer/CHANGELOG.md b/crates/tower-layer/CHANGELOG.md
new file mode 100644
index 0000000..761e9a4
--- /dev/null
+++ b/crates/tower-layer/CHANGELOG.md
@@ -0,0 +1,34 @@
+# 0.3.2 (October 7, 2022)
+
+- Implement `Layer` for tuples of up to 16 elements ([#694])
+
+[#694]: https://github.com/tower-rs/tower/pull/694
+
+# 0.3.1 (January 7, 2021)
+
+- Added `layer_fn`, for constructing a `Layer` from a function taking
+ a `Service` and returning a different `Service` ([#491])
+- Added an implementation of `Layer` for `&Layer` ([#446])
+- Multiple documentation improvements ([#487], [#490])
+
+[#491]: https://github.com/tower-rs/tower/pull/491
+[#446]: https://github.com/tower-rs/tower/pull/446
+[#487]: https://github.com/tower-rs/tower/pull/487
+[#490]: https://github.com/tower-rs/tower/pull/490
+
+# 0.3.0 (November 29, 2019)
+
+- Move layer builder from `tower-util` to tower-layer.
+
+# 0.3.0-alpha.2 (September 30, 2019)
+
+- Move to `futures-*-preview 0.3.0-alpha.19`
+- Move to `pin-project 0.4`
+
+# 0.3.0-alpha.1 (September 11, 2019)
+
+- Move to `std::future`
+
+# 0.1.0 (April 26, 2019)
+
+- Initial release
diff --git a/crates/tower-layer/Cargo.toml b/crates/tower-layer/Cargo.toml
new file mode 100644
index 0000000..0d7736e
--- /dev/null
+++ b/crates/tower-layer/Cargo.toml
@@ -0,0 +1,35 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "tower-layer"
+version = "0.3.2"
+authors = ["Tower Maintainers <[email protected]>"]
+description = """
+Decorates a `Service` to allow easy composition between `Service`s.
+"""
+homepage = "https://github.com/tower-rs/tower"
+readme = "README.md"
+categories = [
+ "asynchronous",
+ "network-programming",
+]
+license = "MIT"
+repository = "https://github.com/tower-rs/tower"
+
+[dependencies]
+
+[dev-dependencies.tower]
+version = "0.4"
+
+[dev-dependencies.tower-service]
+version = "0.3.0"
diff --git a/crates/tower-layer/LICENSE b/crates/tower-layer/LICENSE
new file mode 100644
index 0000000..b980cac
--- /dev/null
+++ b/crates/tower-layer/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tower Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tower-layer/METADATA b/crates/tower-layer/METADATA
new file mode 100644
index 0000000..85403fb
--- /dev/null
+++ b/crates/tower-layer/METADATA
@@ -0,0 +1,20 @@
+name: "tower-layer"
+description: "()"
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "tower-layer"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tower-layer/tower-layer-0.3.2.crate"
+ primary_source: true
+ }
+ version: "0.3.2"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 5
+ day: 24
+ }
+}
diff --git a/crates/tower-layer/MODULE_LICENSE_MIT b/crates/tower-layer/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tower-layer/MODULE_LICENSE_MIT
diff --git a/crates/tower-layer/README.md b/crates/tower-layer/README.md
new file mode 100644
index 0000000..48f9dbb
--- /dev/null
+++ b/crates/tower-layer/README.md
@@ -0,0 +1,43 @@
+# Tower Layer
+
+Decorates a [Tower] `Service`, transforming either the request or the response.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tower-layer.svg
+[crates-url]: https://crates.io/crates/tower-layer
+[docs-badge]: https://docs.rs/tower-layer/badge.svg
+[docs-url]: https://docs.rs/tower-layer
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tower-rs.github.io/tower/tower_layer
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tower-rs/tower/workflows/CI/badge.svg
+[actions-url]:https://github.com/tower-rs/tower/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+
+## Overview
+
+Often, many of the pieces needed for writing network applications can be
+reused across multiple services. The `Layer` trait can be used to write
+reusable components that can be applied to very different kinds of services;
+for example, it can be applied to services operating on different protocols,
+and to both the client and server side of a network transaction.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tower by you, shall be licensed as MIT, without any additional
+terms or conditions.
+
+[Tower]: https://crates.io/crates/tower
\ No newline at end of file
diff --git a/crates/tower-layer/cargo_embargo.json b/crates/tower-layer/cargo_embargo.json
new file mode 100644
index 0000000..8c587f2
--- /dev/null
+++ b/crates/tower-layer/cargo_embargo.json
@@ -0,0 +1,5 @@
+{
+ "features": [],
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/tower-layer/src/identity.rs b/crates/tower-layer/src/identity.rs
new file mode 100644
index 0000000..5ce805b
--- /dev/null
+++ b/crates/tower-layer/src/identity.rs
@@ -0,0 +1,37 @@
+use super::Layer;
+use std::fmt;
+
+/// A no-op middleware.
+///
+/// When wrapping a [`Service`], the [`Identity`] layer returns the provided
+/// service without modifying it.
+///
+/// [`Service`]: https://docs.rs/tower-service/latest/tower_service/trait.Service.html
+#[derive(Default, Clone)]
+pub struct Identity {
+ _p: (),
+}
+
+impl Identity {
+ /// Create a new [`Identity`] value
+ pub fn new() -> Identity {
+ Identity { _p: () }
+ }
+}
+
+/// Decorates a [`Service`], transforming either the request or the response.
+///
+/// [`Service`]: https://docs.rs/tower-service/latest/tower_service/trait.Service.html
+impl<S> Layer<S> for Identity {
+ type Service = S;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ inner
+ }
+}
+
+impl fmt::Debug for Identity {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Identity").finish()
+ }
+}
diff --git a/crates/tower-layer/src/layer_fn.rs b/crates/tower-layer/src/layer_fn.rs
new file mode 100644
index 0000000..06f6e0e
--- /dev/null
+++ b/crates/tower-layer/src/layer_fn.rs
@@ -0,0 +1,114 @@
+use super::Layer;
+use std::fmt;
+
+/// Returns a new [`LayerFn`] that implements [`Layer`] by calling the
+/// given function.
+///
+/// The [`Layer::layer`] method takes a type implementing [`Service`] and
+/// returns a different type implementing [`Service`]. In many cases, this can
+/// be implemented by a function or a closure. The [`LayerFn`] helper allows
+/// writing simple [`Layer`] implementations without needing the boilerplate of
+/// a new struct implementing [`Layer`].
+///
+/// # Example
+/// ```rust
+/// # use tower::Service;
+/// # use std::task::{Poll, Context};
+/// # use tower_layer::{Layer, layer_fn};
+/// # use std::fmt;
+/// # use std::convert::Infallible;
+/// #
+/// // A middleware that logs requests before forwarding them to another service
+/// pub struct LogService<S> {
+/// target: &'static str,
+/// service: S,
+/// }
+///
+/// impl<S, Request> Service<Request> for LogService<S>
+/// where
+/// S: Service<Request>,
+/// Request: fmt::Debug,
+/// {
+/// type Response = S::Response;
+/// type Error = S::Error;
+/// type Future = S::Future;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// self.service.poll_ready(cx)
+/// }
+///
+/// fn call(&mut self, request: Request) -> Self::Future {
+/// // Log the request
+/// println!("request = {:?}, target = {:?}", request, self.target);
+///
+/// self.service.call(request)
+/// }
+/// }
+///
+/// // A `Layer` that wraps services in `LogService`
+/// let log_layer = layer_fn(|service| {
+/// LogService {
+/// service,
+/// target: "tower-docs",
+/// }
+/// });
+///
+/// // An example service. This one uppercases strings
+/// let uppercase_service = tower::service_fn(|request: String| async move {
+/// Ok::<_, Infallible>(request.to_uppercase())
+/// });
+///
+/// // Wrap our service in a `LogService` so requests are logged.
+/// let wrapped_service = log_layer.layer(uppercase_service);
+/// ```
+///
+/// [`Service`]: https://docs.rs/tower-service/latest/tower_service/trait.Service.html
+/// [`Layer::layer`]: crate::Layer::layer
+pub fn layer_fn<T>(f: T) -> LayerFn<T> {
+ LayerFn { f }
+}
+
+/// A `Layer` implemented by a closure. See the docs for [`layer_fn`] for more details.
+#[derive(Clone, Copy)]
+pub struct LayerFn<F> {
+ f: F,
+}
+
+impl<F, S, Out> Layer<S> for LayerFn<F>
+where
+ F: Fn(S) -> Out,
+{
+ type Service = Out;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ (self.f)(inner)
+ }
+}
+
+impl<F> fmt::Debug for LayerFn<F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("LayerFn")
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[allow(dead_code)]
+ #[test]
+ fn layer_fn_has_useful_debug_impl() {
+ struct WrappedService<S> {
+ inner: S,
+ }
+ let layer = layer_fn(|svc| WrappedService { inner: svc });
+ let _svc = layer.layer("foo");
+
+ assert_eq!(
+ "LayerFn { f: tower_layer::layer_fn::tests::layer_fn_has_useful_debug_impl::{{closure}} }".to_string(),
+ format!("{:?}", layer),
+ );
+ }
+}
diff --git a/crates/tower-layer/src/lib.rs b/crates/tower-layer/src/lib.rs
new file mode 100644
index 0000000..8dfae3d
--- /dev/null
+++ b/crates/tower-layer/src/lib.rs
@@ -0,0 +1,112 @@
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub
+)]
+#![forbid(unsafe_code)]
+// `rustdoc::broken_intra_doc_links` is checked on CI
+
+//! Layer traits and extensions.
+//!
+//! A layer decorates an service and provides additional functionality. It
+//! allows other services to be composed with the service that implements layer.
+//!
+//! A middleware implements the [`Layer`] and [`Service`] trait.
+//!
+//! [`Service`]: https://docs.rs/tower/latest/tower/trait.Service.html
+
+mod identity;
+mod layer_fn;
+mod stack;
+mod tuple;
+
+pub use self::{
+ identity::Identity,
+ layer_fn::{layer_fn, LayerFn},
+ stack::Stack,
+};
+
+/// Decorates a [`Service`], transforming either the request or the response.
+///
+/// Often, many of the pieces needed for writing network applications can be
+/// reused across multiple services. The `Layer` trait can be used to write
+/// reusable components that can be applied to very different kinds of services;
+/// for example, it can be applied to services operating on different protocols,
+/// and to both the client and server side of a network transaction.
+///
+/// # Log
+///
+/// Take request logging as an example:
+///
+/// ```rust
+/// # use tower_service::Service;
+/// # use std::task::{Poll, Context};
+/// # use tower_layer::Layer;
+/// # use std::fmt;
+///
+/// pub struct LogLayer {
+/// target: &'static str,
+/// }
+///
+/// impl<S> Layer<S> for LogLayer {
+/// type Service = LogService<S>;
+///
+/// fn layer(&self, service: S) -> Self::Service {
+/// LogService {
+/// target: self.target,
+/// service
+/// }
+/// }
+/// }
+///
+/// // This service implements the Log behavior
+/// pub struct LogService<S> {
+/// target: &'static str,
+/// service: S,
+/// }
+///
+/// impl<S, Request> Service<Request> for LogService<S>
+/// where
+/// S: Service<Request>,
+/// Request: fmt::Debug,
+/// {
+/// type Response = S::Response;
+/// type Error = S::Error;
+/// type Future = S::Future;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// self.service.poll_ready(cx)
+/// }
+///
+/// fn call(&mut self, request: Request) -> Self::Future {
+/// // Insert log statement here or other functionality
+/// println!("request = {:?}, target = {:?}", request, self.target);
+/// self.service.call(request)
+/// }
+/// }
+/// ```
+///
+/// The above log implementation is decoupled from the underlying protocol and
+/// is also decoupled from client or server concerns. In other words, the same
+/// log middleware could be used in either a client or a server.
+///
+/// [`Service`]: https://docs.rs/tower/latest/tower/trait.Service.html
+pub trait Layer<S> {
+ /// The wrapped service
+ type Service;
+ /// Wrap the given service with the middleware, returning a new service
+ /// that has been decorated with the middleware.
+ fn layer(&self, inner: S) -> Self::Service;
+}
+
+impl<'a, T, S> Layer<S> for &'a T
+where
+ T: ?Sized + Layer<S>,
+{
+ type Service = T::Service;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ (**self).layer(inner)
+ }
+}
diff --git a/crates/tower-layer/src/stack.rs b/crates/tower-layer/src/stack.rs
new file mode 100644
index 0000000..cc0b826
--- /dev/null
+++ b/crates/tower-layer/src/stack.rs
@@ -0,0 +1,62 @@
+use super::Layer;
+use std::fmt;
+
+/// Two middlewares chained together.
+#[derive(Clone)]
+pub struct Stack<Inner, Outer> {
+ inner: Inner,
+ outer: Outer,
+}
+
+impl<Inner, Outer> Stack<Inner, Outer> {
+ /// Create a new `Stack`.
+ pub fn new(inner: Inner, outer: Outer) -> Self {
+ Stack { inner, outer }
+ }
+}
+
+impl<S, Inner, Outer> Layer<S> for Stack<Inner, Outer>
+where
+ Inner: Layer<S>,
+ Outer: Layer<Inner::Service>,
+{
+ type Service = Outer::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let inner = self.inner.layer(service);
+
+ self.outer.layer(inner)
+ }
+}
+
+impl<Inner, Outer> fmt::Debug for Stack<Inner, Outer>
+where
+ Inner: fmt::Debug,
+ Outer: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // The generated output of nested `Stack`s is very noisy and makes
+ // it harder to understand what is in a `ServiceBuilder`.
+ //
+ // Instead, this output is designed assuming that a `Stack` is
+ // usually quite nested, and inside a `ServiceBuilder`. Therefore,
+ // this skips using `f.debug_struct()`, since each one would force
+ // a new layer of indentation.
+ //
+ // - In compact mode, a nested stack ends up just looking like a flat
+ // list of layers.
+ //
+ // - In pretty mode, while a newline is inserted between each layer,
+ // the `DebugStruct` used in the `ServiceBuilder` will inject padding
+ // to that each line is at the same indentation level.
+ //
+ // Also, the order of [outer, inner] is important, since it reflects
+ // the order that the layers were added to the stack.
+ if f.alternate() {
+ // pretty
+ write!(f, "{:#?},\n{:#?}", self.outer, self.inner)
+ } else {
+ write!(f, "{:?}, {:?}", self.outer, self.inner)
+ }
+ }
+}
diff --git a/crates/tower-layer/src/tuple.rs b/crates/tower-layer/src/tuple.rs
new file mode 100644
index 0000000..14b973a
--- /dev/null
+++ b/crates/tower-layer/src/tuple.rs
@@ -0,0 +1,330 @@
+use crate::Layer;
+
+impl<S> Layer<S> for () {
+ type Service = S;
+
+ fn layer(&self, service: S) -> Self::Service {
+ service
+ }
+}
+
+impl<S, L1> Layer<S> for (L1,)
+where
+ L1: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1,) = self;
+ l1.layer(service)
+ }
+}
+
+impl<S, L1, L2> Layer<S> for (L1, L2)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2) = self;
+ l1.layer(l2.layer(service))
+ }
+}
+
+impl<S, L1, L2, L3> Layer<S> for (L1, L2, L3)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3) = self;
+ l1.layer((l2, l3).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4> Layer<S> for (L1, L2, L3, L4)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4) = self;
+ l1.layer((l2, l3, l4).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5> Layer<S> for (L1, L2, L3, L4, L5)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5) = self;
+ l1.layer((l2, l3, l4, l5).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6> Layer<S> for (L1, L2, L3, L4, L5, L6)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6) = self;
+ l1.layer((l2, l3, l4, l5, l6).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7> Layer<S> for (L1, L2, L3, L4, L5, L6, L7)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8> Layer<S> for (L1, L2, L3, L4, L5, L6, L7, L8)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9> Layer<S> for (L1, L2, L3, L4, L5, L6, L7, L8, L9)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<L12::Service>,
+ L12: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<L12::Service>,
+ L12: Layer<L13::Service>,
+ L13: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13).layer(service))
+ }
+}
+
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<L12::Service>,
+ L12: Layer<L13::Service>,
+ L13: Layer<L14::Service>,
+ L14: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14).layer(service))
+ }
+}
+
+#[rustfmt::skip]
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14, L15> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14, L15)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<L12::Service>,
+ L12: Layer<L13::Service>,
+ L13: Layer<L14::Service>,
+ L14: Layer<L15::Service>,
+ L15: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15).layer(service))
+ }
+}
+
+#[rustfmt::skip]
+impl<S, L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14, L15, L16> Layer<S>
+ for (L1, L2, L3, L4, L5, L6, L7, L8, L9, L10, L11, L12, L13, L14, L15, L16)
+where
+ L1: Layer<L2::Service>,
+ L2: Layer<L3::Service>,
+ L3: Layer<L4::Service>,
+ L4: Layer<L5::Service>,
+ L5: Layer<L6::Service>,
+ L6: Layer<L7::Service>,
+ L7: Layer<L8::Service>,
+ L8: Layer<L9::Service>,
+ L9: Layer<L10::Service>,
+ L10: Layer<L11::Service>,
+ L11: Layer<L12::Service>,
+ L12: Layer<L13::Service>,
+ L13: Layer<L14::Service>,
+ L14: Layer<L15::Service>,
+ L15: Layer<L16::Service>,
+ L16: Layer<S>,
+{
+ type Service = L1::Service;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let (l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16) = self;
+ l1.layer((l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16).layer(service))
+ }
+}
diff --git a/crates/tower-service/.cargo-checksum.json b/crates/tower-service/.cargo-checksum.json
new file mode 100644
index 0000000..a6a7c44
--- /dev/null
+++ b/crates/tower-service/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"961cd98312a75f437e0dcd51eeb3bb61f0bbe778d5fb9203ab8a287bd9cfc84b","Cargo.toml":"81b3940c5bd437f362f4c52d442e49750263eae37b3188202c475340b7255f36","LICENSE":"4249c8e6c5ebb85f97c77e6457c6fafc1066406eb8f1ef61e796fbdc5ff18482","README.md":"da9cb4815bf06e0991df6bf4e9f46272e26115dcc4e2c8f9ffc05e11d486179e","src/lib.rs":"0acd9a6540ea50c0c60c212ba7ef89a7dd7542e99cc6854db2fdd1d5db63a715"},"package":"b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52"}
\ No newline at end of file
diff --git a/crates/tower-service/Android.bp b/crates/tower-service/Android.bp
new file mode 100644
index 0000000..cbc012d
--- /dev/null
+++ b/crates/tower-service/Android.bp
@@ -0,0 +1,30 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tower-service_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tower-service_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtower_service",
+ host_supported: true,
+ crate_name: "tower_service",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.2",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tower-service/CHANGELOG.md b/crates/tower-service/CHANGELOG.md
new file mode 100644
index 0000000..8bc4f65
--- /dev/null
+++ b/crates/tower-service/CHANGELOG.md
@@ -0,0 +1,63 @@
+# Unreleased
+
+- None
+
+# 0.3.2 (June 17, 2022)
+
+## Added
+
+- **docs**: Clarify subtlety around cloning and readiness in the `Service` docs
+ ([#548])
+- **docs**: Clarify details around shared resource consumption in `poll_ready()`
+ ([#662])
+
+
+[#548]: https://github.com/tower-rs/tower/pull/548
+[#662]: https://github.com/tower-rs/tower/pull/662
+
+
+# 0.3.1 (November 29, 2019)
+
+- Improve example in `Service` docs. ([#510])
+
+[#510]: https://github.com/tower-rs/tower/pull/510
+
+# 0.3.0 (November 29, 2019)
+
+- Update to `futures 0.3`.
+- Update documentation for `std::future::Future`.
+
+# 0.3.0-alpha.2 (September 30, 2019)
+
+- Documentation fixes.
+
+# 0.3.0-alpha.1 (Aug 20, 2019)
+
+* Switch to `std::future::Future`
+
+# 0.2.0 (Dec 12, 2018)
+
+* Change `Service`'s `Request` associated type to be a generic instead.
+ * Before:
+
+ ```rust
+ impl Service for Client {
+ type Request = HttpRequest;
+ type Response = HttpResponse;
+ // ...
+ }
+ ```
+ * After:
+
+ ```rust
+ impl Service<HttpRequest> for Client {
+ type Response = HttpResponse;
+ // ...
+ }
+ ```
+* Remove `NewService`, use `tower_util::MakeService` instead.
+* Remove `Service::ready` and `Ready`, use `tower_util::ServiceExt` instead.
+
+# 0.1.0 (Aug 9, 2018)
+
+* Initial release
diff --git a/crates/tower-service/Cargo.toml b/crates/tower-service/Cargo.toml
new file mode 100644
index 0000000..b023dab
--- /dev/null
+++ b/crates/tower-service/Cargo.toml
@@ -0,0 +1,46 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "tower-service"
+version = "0.3.2"
+authors = ["Tower Maintainers <[email protected]>"]
+description = """
+Trait representing an asynchronous, request / response based, client or server.
+"""
+homepage = "https://github.com/tower-rs/tower"
+documentation = "https://docs.rs/tower-service/0.3.2"
+readme = "README.md"
+categories = [
+ "asynchronous",
+ "network-programming",
+]
+license = "MIT"
+repository = "https://github.com/tower-rs/tower"
+
+[dependencies]
+
+[dev-dependencies.futures]
+version = "0.3"
+
+[dev-dependencies.http]
+version = "0.2"
+
+[dev-dependencies.tokio]
+version = "1"
+features = [
+ "macros",
+ "time",
+]
+
+[dev-dependencies.tower-layer]
+version = "0.3"
diff --git a/crates/tower-service/LICENSE b/crates/tower-service/LICENSE
new file mode 100644
index 0000000..b980cac
--- /dev/null
+++ b/crates/tower-service/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tower Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tower-service/METADATA b/crates/tower-service/METADATA
new file mode 100644
index 0000000..95541e1
--- /dev/null
+++ b/crates/tower-service/METADATA
@@ -0,0 +1,20 @@
+name: "tower-service"
+description: "()"
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "tower-service"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tower-service/tower-service-0.3.2.crate"
+ primary_source: true
+ }
+ version: "0.3.2"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 5
+ day: 24
+ }
+}
diff --git a/crates/tower-service/MODULE_LICENSE_MIT b/crates/tower-service/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tower-service/MODULE_LICENSE_MIT
diff --git a/crates/tower-service/README.md b/crates/tower-service/README.md
new file mode 100644
index 0000000..3f2766d
--- /dev/null
+++ b/crates/tower-service/README.md
@@ -0,0 +1,56 @@
+# Tower Service
+
+The foundational `Service` trait that [Tower] is based on.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tower-service.svg
+[crates-url]: https://crates.io/crates/tower-service
+[docs-badge]: https://docs.rs/tower-service/badge.svg
+[docs-url]: https://docs.rs/tower-service
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tower-rs.github.io/tower/tower_service
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tower-rs/tower/workflows/CI/badge.svg
+[actions-url]:https://github.com/tower-rs/tower/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+
+## Overview
+
+The [`Service`] trait provides the foundation upon which [Tower] is built. It is a
+simple, but powerful trait. At its heart, `Service` is just an asynchronous
+function of request to response.
+
+```
+async fn(Request) -> Result<Response, Error>
+```
+
+Implementations of `Service` take a request, the type of which varies per
+protocol, and returns a future representing the eventual completion or failure
+of the response.
+
+Services are used to represent both clients and servers. An *instance* of
+`Service` is used through a client; a server *implements* `Service`.
+
+By using standardizing the interface, middleware can be created. Middleware
+*implement* `Service` by passing the request to another `Service`. The
+middleware may take actions such as modify the request.
+
+[`Service`]: https://docs.rs/tower-service/latest/tower_service/trait.Service.html
+[Tower]: https://crates.io/crates/tower
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tower by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tower-service/cargo_embargo.json b/crates/tower-service/cargo_embargo.json
new file mode 100644
index 0000000..b639cc5
--- /dev/null
+++ b/crates/tower-service/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "features": [],
+ "run_cargo": false
+}
diff --git a/crates/tower-service/src/lib.rs b/crates/tower-service/src/lib.rs
new file mode 100644
index 0000000..a6ef0ec
--- /dev/null
+++ b/crates/tower-service/src/lib.rs
@@ -0,0 +1,389 @@
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub
+)]
+#![forbid(unsafe_code)]
+// `rustdoc::broken_intra_doc_links` is checked on CI
+
+//! Definition of the core `Service` trait to Tower
+//!
+//! The [`Service`] trait provides the necessary abstractions for defining
+//! request / response clients and servers. It is simple but powerful and is
+//! used as the foundation for the rest of Tower.
+
+use std::future::Future;
+use std::task::{Context, Poll};
+
+/// An asynchronous function from a `Request` to a `Response`.
+///
+/// The `Service` trait is a simplified interface making it easy to write
+/// network applications in a modular and reusable way, decoupled from the
+/// underlying protocol. It is one of Tower's fundamental abstractions.
+///
+/// # Functional
+///
+/// A `Service` is a function of a `Request`. It immediately returns a
+/// `Future` representing the eventual completion of processing the
+/// request. The actual request processing may happen at any time in the
+/// future, on any thread or executor. The processing may depend on calling
+/// other services. At some point in the future, the processing will complete,
+/// and the `Future` will resolve to a response or error.
+///
+/// At a high level, the `Service::call` function represents an RPC request. The
+/// `Service` value can be a server or a client.
+///
+/// # Server
+///
+/// An RPC server *implements* the `Service` trait. Requests received by the
+/// server over the network are deserialized and then passed as an argument to the
+/// server value. The returned response is sent back over the network.
+///
+/// As an example, here is how an HTTP request is processed by a server:
+///
+/// ```rust
+/// # use std::pin::Pin;
+/// # use std::task::{Poll, Context};
+/// # use std::future::Future;
+/// # use tower_service::Service;
+/// use http::{Request, Response, StatusCode};
+///
+/// struct HelloWorld;
+///
+/// impl Service<Request<Vec<u8>>> for HelloWorld {
+/// type Response = Response<Vec<u8>>;
+/// type Error = http::Error;
+/// type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// Poll::Ready(Ok(()))
+/// }
+///
+/// fn call(&mut self, req: Request<Vec<u8>>) -> Self::Future {
+/// // create the body
+/// let body: Vec<u8> = "hello, world!\n"
+/// .as_bytes()
+/// .to_owned();
+/// // Create the HTTP response
+/// let resp = Response::builder()
+/// .status(StatusCode::OK)
+/// .body(body)
+/// .expect("Unable to create `http::Response`");
+///
+/// // create a response in a future.
+/// let fut = async {
+/// Ok(resp)
+/// };
+///
+/// // Return the response as an immediate future
+/// Box::pin(fut)
+/// }
+/// }
+/// ```
+///
+/// # Client
+///
+/// A client consumes a service by using a `Service` value. The client may
+/// issue requests by invoking `call` and passing the request as an argument.
+/// It then receives the response by waiting for the returned future.
+///
+/// As an example, here is how a Redis request would be issued:
+///
+/// ```rust,ignore
+/// let client = redis::Client::new()
+/// .connect("127.0.0.1:6379".parse().unwrap())
+/// .unwrap();
+///
+/// let resp = client.call(Cmd::set("foo", "this is the value of foo")).await?;
+///
+/// // Wait for the future to resolve
+/// println!("Redis response: {:?}", resp);
+/// ```
+///
+/// # Middleware / Layer
+///
+/// More often than not, all the pieces needed for writing robust, scalable
+/// network applications are the same no matter the underlying protocol. By
+/// unifying the API for both clients and servers in a protocol agnostic way,
+/// it is possible to write middleware that provide these pieces in a
+/// reusable way.
+///
+/// Take timeouts as an example:
+///
+/// ```rust
+/// use tower_service::Service;
+/// use tower_layer::Layer;
+/// use futures::FutureExt;
+/// use std::future::Future;
+/// use std::task::{Context, Poll};
+/// use std::time::Duration;
+/// use std::pin::Pin;
+/// use std::fmt;
+/// use std::error::Error;
+///
+/// // Our timeout service, which wraps another service and
+/// // adds a timeout to its response future.
+/// pub struct Timeout<T> {
+/// inner: T,
+/// timeout: Duration,
+/// }
+///
+/// impl<T> Timeout<T> {
+/// pub fn new(inner: T, timeout: Duration) -> Timeout<T> {
+/// Timeout {
+/// inner,
+/// timeout
+/// }
+/// }
+/// }
+///
+/// // The error returned if processing a request timed out
+/// #[derive(Debug)]
+/// pub struct Expired;
+///
+/// impl fmt::Display for Expired {
+/// fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+/// write!(f, "expired")
+/// }
+/// }
+///
+/// impl Error for Expired {}
+///
+/// // We can implement `Service` for `Timeout<T>` if `T` is a `Service`
+/// impl<T, Request> Service<Request> for Timeout<T>
+/// where
+/// T: Service<Request>,
+/// T::Future: 'static,
+/// T::Error: Into<Box<dyn Error + Send + Sync>> + 'static,
+/// T::Response: 'static,
+/// {
+/// // `Timeout` doesn't modify the response type, so we use `T`'s response type
+/// type Response = T::Response;
+/// // Errors may be either `Expired` if the timeout expired, or the inner service's
+/// // `Error` type. Therefore, we return a boxed `dyn Error + Send + Sync` trait object to erase
+/// // the error's type.
+/// type Error = Box<dyn Error + Send + Sync>;
+/// type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// // Our timeout service is ready if the inner service is ready.
+/// // This is how backpressure can be propagated through a tree of nested services.
+/// self.inner.poll_ready(cx).map_err(Into::into)
+/// }
+///
+/// fn call(&mut self, req: Request) -> Self::Future {
+/// // Create a future that completes after `self.timeout`
+/// let timeout = tokio::time::sleep(self.timeout);
+///
+/// // Call the inner service and get a future that resolves to the response
+/// let fut = self.inner.call(req);
+///
+/// // Wrap those two futures in another future that completes when either one completes
+/// //
+/// // If the inner service is too slow the `sleep` future will complete first
+/// // And an error will be returned and `fut` will be dropped and not polled again
+/// //
+/// // We have to box the errors so the types match
+/// let f = async move {
+/// tokio::select! {
+/// res = fut => {
+/// res.map_err(|err| err.into())
+/// },
+/// _ = timeout => {
+/// Err(Box::new(Expired) as Box<dyn Error + Send + Sync>)
+/// },
+/// }
+/// };
+///
+/// Box::pin(f)
+/// }
+/// }
+///
+/// // A layer for wrapping services in `Timeout`
+/// pub struct TimeoutLayer(Duration);
+///
+/// impl TimeoutLayer {
+/// pub fn new(delay: Duration) -> Self {
+/// TimeoutLayer(delay)
+/// }
+/// }
+///
+/// impl<S> Layer<S> for TimeoutLayer {
+/// type Service = Timeout<S>;
+///
+/// fn layer(&self, service: S) -> Timeout<S> {
+/// Timeout::new(service, self.0)
+/// }
+/// }
+/// ```
+///
+/// The above timeout implementation is decoupled from the underlying protocol
+/// and is also decoupled from client or server concerns. In other words, the
+/// same timeout middleware could be used in either a client or a server.
+///
+/// # Backpressure
+///
+/// Calling a `Service` which is at capacity (i.e., it is temporarily unable to process a
+/// request) should result in an error. The caller is responsible for ensuring
+/// that the service is ready to receive the request before calling it.
+///
+/// `Service` provides a mechanism by which the caller is able to coordinate
+/// readiness. `Service::poll_ready` returns `Ready` if the service expects that
+/// it is able to process a request.
+///
+/// # Be careful when cloning inner services
+///
+/// Services are permitted to panic if `call` is invoked without obtaining `Poll::Ready(Ok(()))`
+/// from `poll_ready`. You should therefore be careful when cloning services for example to move
+/// them into boxed futures. Even though the original service is ready, the clone might not be.
+///
+/// Therefore this kind of code is wrong and might panic:
+///
+/// ```rust
+/// # use std::pin::Pin;
+/// # use std::task::{Poll, Context};
+/// # use std::future::Future;
+/// # use tower_service::Service;
+/// #
+/// struct Wrapper<S> {
+/// inner: S,
+/// }
+///
+/// impl<R, S> Service<R> for Wrapper<S>
+/// where
+/// S: Service<R> + Clone + 'static,
+/// R: 'static,
+/// {
+/// type Response = S::Response;
+/// type Error = S::Error;
+/// type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// Poll::Ready(Ok(()))
+/// }
+///
+/// fn call(&mut self, req: R) -> Self::Future {
+/// let mut inner = self.inner.clone();
+/// Box::pin(async move {
+/// // `inner` might not be ready since its a clone
+/// inner.call(req).await
+/// })
+/// }
+/// }
+/// ```
+///
+/// You should instead use [`std::mem::replace`] to take the service that was ready:
+///
+/// ```rust
+/// # use std::pin::Pin;
+/// # use std::task::{Poll, Context};
+/// # use std::future::Future;
+/// # use tower_service::Service;
+/// #
+/// struct Wrapper<S> {
+/// inner: S,
+/// }
+///
+/// impl<R, S> Service<R> for Wrapper<S>
+/// where
+/// S: Service<R> + Clone + 'static,
+/// R: 'static,
+/// {
+/// type Response = S::Response;
+/// type Error = S::Error;
+/// type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;
+///
+/// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// Poll::Ready(Ok(()))
+/// }
+///
+/// fn call(&mut self, req: R) -> Self::Future {
+/// let clone = self.inner.clone();
+/// // take the service that was ready
+/// let mut inner = std::mem::replace(&mut self.inner, clone);
+/// Box::pin(async move {
+/// inner.call(req).await
+/// })
+/// }
+/// }
+/// ```
+pub trait Service<Request> {
+ /// Responses given by the service.
+ type Response;
+
+ /// Errors produced by the service.
+ type Error;
+
+ /// The future response value.
+ type Future: Future<Output = Result<Self::Response, Self::Error>>;
+
+ /// Returns `Poll::Ready(Ok(()))` when the service is able to process requests.
+ ///
+ /// If the service is at capacity, then `Poll::Pending` is returned and the task
+ /// is notified when the service becomes ready again. This function is
+ /// expected to be called while on a task. Generally, this can be done with
+ /// a simple `futures::future::poll_fn` call.
+ ///
+ /// If `Poll::Ready(Err(_))` is returned, the service is no longer able to service requests
+ /// and the caller should discard the service instance.
+ ///
+ /// Once `poll_ready` returns `Poll::Ready(Ok(()))`, a request may be dispatched to the
+ /// service using `call`. Until a request is dispatched, repeated calls to
+ /// `poll_ready` must return either `Poll::Ready(Ok(()))` or `Poll::Ready(Err(_))`.
+ ///
+ /// Note that `poll_ready` may reserve shared resources that are consumed in a subsequent
+ /// invocation of `call`. Thus, it is critical for implementations to not assume that `call`
+ /// will always be invoked and to ensure that such resources are released if the service is
+ /// dropped before `call` is invoked or the future returned by `call` is dropped before it
+ /// is polled.
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>;
+
+ /// Process the request and return the response asynchronously.
+ ///
+ /// This function is expected to be callable off task. As such,
+ /// implementations should take care to not call `poll_ready`.
+ ///
+ /// Before dispatching a request, `poll_ready` must be called and return
+ /// `Poll::Ready(Ok(()))`.
+ ///
+ /// # Panics
+ ///
+ /// Implementations are permitted to panic if `call` is invoked without
+ /// obtaining `Poll::Ready(Ok(()))` from `poll_ready`.
+ fn call(&mut self, req: Request) -> Self::Future;
+}
+
+impl<'a, S, Request> Service<Request> for &'a mut S
+where
+ S: Service<Request> + 'a,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), S::Error>> {
+ (**self).poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> S::Future {
+ (**self).call(request)
+ }
+}
+
+impl<S, Request> Service<Request> for Box<S>
+where
+ S: Service<Request> + ?Sized,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), S::Error>> {
+ (**self).poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> S::Future {
+ (**self).call(request)
+ }
+}
diff --git a/crates/tower/.cargo-checksum.json b/crates/tower/.cargo-checksum.json
new file mode 100644
index 0000000..7f7f33e
--- /dev/null
+++ b/crates/tower/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"68ac4b7d54b3e4e5d00247de47e8023c0859e7e81180fac5a557e85f98a98981","Cargo.lock":"b16aa64745b82a6781f1e0aedf4372ad6b48ac3dfd600b54279c4bd3d4b8fa95","Cargo.toml":"03135186549041d0fc131c0561ed9a57cf688f2fd4f7f98c63a8cf2aa08e3ff4","LICENSE":"4249c8e6c5ebb85f97c77e6457c6fafc1066406eb8f1ef61e796fbdc5ff18482","README.md":"05de53c84c9213cfdb00704c7aa8e2ed26cecc2481b2f91d3145e5a00fcddf1a","examples/tower-balance.rs":"f99cbf31de892c5f7f7a3aa10671a90d994c9e4de91ae06fbe74d7cb2e575471","src/balance/error.rs":"2ee79fc7ed868781bb4b3ef12c9464772a246be3841befa3fa90e030f60531b1","src/balance/mod.rs":"f14fa5f37b3d393d0aac143875f879be7ea5831e7008f0d096f49e84c76e717a","src/balance/p2c/layer.rs":"e0086c7c4144cc666d489fceb7b1531084f91f7e6af17029d9c84d83d81b0882","src/balance/p2c/make.rs":"ba47e72999893e83b5760e58078ed6f5c5b63284ebef5cda6d6d4325486a42a6","src/balance/p2c/mod.rs":"086de5f09b67c6bcfc06eb53a2c8b9aaa18360a7d72c0cf0dcd5e17ad7b77546","src/balance/p2c/service.rs":"16d5750c423315eea18034138c83ad3d5ec200fc6b7dfb4b3ce00fd817fd72cf","src/balance/p2c/test.rs":"7351bd8528b713352d7195d41ad7840e655d106c72a863dc428ddee4f5ec5261","src/balance/pool/mod.rs":"c60f6cccc65a49491ef74dfc781fb49f292e4bfda8925626cdb6313b10f182cc","src/balance/pool/test.rs":"ef2b39e6aa6921e655660a006928e16903bda7d6875432dadc5c4e89b983f161","src/buffer/error.rs":"cb32f3412eaa5c6317d3b1a2cb7d23416ba74e6b08967229699a9c62fe201c36","src/buffer/future.rs":"86825db0749a56d8590d572271814fb9b3ee068809d54efb79a765879157fe5a","src/buffer/layer.rs":"491613bfa4fa5f72dd5aa064f3aae10590f9f472b7742a9277a232e3598ad2ae","src/buffer/message.rs":"1cb3ee7d31bcc733964c8bd42d4e4da9c7d7caff9ccbb478b6200b5acbe1de0d","src/buffer/mod.rs":"7708b45c4e67800d61384f954596bb9ad71e5517c94d1227097c9ec2073977e2","src/buffer/service.rs":"3d8985f686655341bfa897e8f7958dd5e5d7b29919742d073163ef077ca886c2","src/buffer/worker.rs":"0b046caea2245c5bf42edfab2e3bb7f3fa64e1f36fb1a4fa1246c41d33cbd191","src/builder/mod.rs":"83c8ea00f2d0b45adff155918134646131f9bb59a375f946d753849f09632636","src/discover/error.rs":"b8848e4df4c50efee7e355aa8808aacd4ba68559658860a7f74f4acbbe709f59","src/discover/list.rs":"8d9feac55ae29fb7d2959b4f38c3ffa82a6afcfcdeb2f6a6883888f9ec80e10a","src/discover/mod.rs":"fd382f3e6c7b93cb7a8d6f4451bb3456147b09faef55fcda7416ec31ed58d3aa","src/filter/future.rs":"4fc71c6e085ee4f8e2d52bf5628cdbbb6015f4bcb9e0a6aed3283ec165cd523b","src/filter/layer.rs":"fba0877ce6d8d9b36af465c510e4f1395a93001102e4a01db74a4f4670f13b0f","src/filter/mod.rs":"ceb718a0555425539d9b8425c19b85a141797bd4b2c4f33239791470f54adf85","src/filter/predicate.rs":"633d4374ad50c130d09fa549f11e4db8e1d72dbb1997c3e7cd9dd09dde232844","src/hedge/delay.rs":"64e023970151ca45856777da2ff60423c316d2fb9e54c3d147a085a3f2193415","src/hedge/latency.rs":"a3864a898ef0734fa0c45b49e84b315c4c5ac9f06a8a28aad1501c7446daa8af","src/hedge/mod.rs":"614c301e93b748031bc1836eccd44f16f4998710459f126d8bf6ee8b462e8034","src/hedge/rotating_histogram.rs":"f075966185592451d2f6784fdecf3109086b168f7a986c35fad52780be3e48a9","src/hedge/select.rs":"e143e5f27f97031992299b6662bbae9490ecae3ab48d3e7b9f6df53db7f95d64","src/layer.rs":"0c422e476b83ea6adc9e6f96728aafcd52f6ac6a4457697e96bc228eec0e59b1","src/lib.rs":"ed3844d1229eb1c23e3afd69395fbb3be8135028526b2def64dd741a9b192073","src/limit/concurrency/future.rs":"0c3be7829f7cf0ea57c6277193754e4f8b869f5a4e3e46b1a5c2ffe41ddb812f","src/limit/concurrency/layer.rs":"c6c7ab80e3f6e6bd39c051e08f07d6a5a11da1559c353723471aa0c3516fd9d2","src/limit/concurrency/mod.rs":"99e5e2bf0273fae172f893d89a93bb3768dc0522b09ae94c5d0ab6492d460391","src/limit/concurrency/never.rs":"910bc64f9969d0df927678b477a80110e5dd3b516a4e86754e72e007a60f5d14","src/limit/concurrency/service.rs":"df0478de8056c09ab4ebb628618591f08d075fe6d5a961c690915700b70367c0","src/limit/mod.rs":"59565acc1d14a3500069ba2dc9667e7fc03162cc89db4051204d7d38b5b69ccb","src/limit/rate/layer.rs":"2c06a7d09a520180893f406d7b3344e01f18817c4dc6a81792ccf8715949d828","src/limit/rate/mod.rs":"6414465408a5d9c06789f586ddc2f40f8e59f3a1eb19cec5e37df82095012cb2","src/limit/rate/rate.rs":"574b04fd1c363443fd304e4c342f63f6526938966435ff9f808fb1de9b0d7bc6","src/limit/rate/service.rs":"e40a43e491ee01b96ca8cc746028adda559086db848ed1cd156f83ed1fca85d4","src/load/completion.rs":"3d74a30514fcb1cac4c8c614d4ef993cb3556a345712ffa016ff96ef2b50b3a0","src/load/constant.rs":"f849649c988f84545292c5e49fe90467a28deecf80c10c69dd2cbd2b87afdb5f","src/load/mod.rs":"f48be59dfd34c2f3b2ffc68ea15654d1541ea31c52747f8b8a82b988d1fdaff2","src/load/peak_ewma.rs":"871383ffb65fe7e14c7316589e35038a132ed71d72065c8bbdeaaf9bbc4fab61","src/load/pending_requests.rs":"a8c7a80b85fcec67e475663993355fce280daf3da6e577b867466dfe68c3f17b","src/load_shed/error.rs":"7ea489a051638093ce56a17f5546b1bf91b536538eda1756866bccd8f72cd440","src/load_shed/future.rs":"999c3080c947746dff8623cec30a34b8af9d46d73192dfe4be821b0e418a0e89","src/load_shed/layer.rs":"dffaebd79748e105076e53f400904c87a0167d5a7f217d9dd0407b85e841bb64","src/load_shed/mod.rs":"837a0204c8187f805d367fbf029ece2fa53d7f2717335b860ad6de8b85772bb4","src/macros.rs":"5910f539cd05afa93bfeaa2c7b5b4c20714d4df06f052a699ce3d9dcc89131ac","src/make/make_connection.rs":"d30788e3406d2e7dbe218f9ea40aaec6e5763e635f3df998677115c2e768e21a","src/make/make_service.rs":"eba1e9615416d9b2f019d87dfc82c4c7a8245aa06722bed1391f62664c8db35a","src/make/make_service/shared.rs":"70be68b2f876ce3cbd231fa8c22660fd0c98f2e2b7d9c6b92acaf91bc7f9f5d9","src/make/mod.rs":"defd871542f92bea3be28e83c766e31644c007a584b824bdb59944cf5ece3d0d","src/ready_cache/cache.rs":"25187fabd153094b92ece758f91d58ed7c0d8cde650c34368fb82694c6c0b1c3","src/ready_cache/error.rs":"385425991f9801eecd4206e94b46f1ec5ed7eb47a44aadb715515faa960052b2","src/ready_cache/mod.rs":"987076ba544d8d321229e5faf65d1142663bf02c391eb1df73c7881b6f1ebdae","src/reconnect/future.rs":"8c5306a38e84513f95c7e6165acc0bfccf71532f1f4826543b21bb288ff567f9","src/reconnect/mod.rs":"ce7657aa8d5ac59343d1b0e855723abdc046469f3efb32c6a4fcdf6c2bb5fb7a","src/retry/budget.rs":"9ba006ad860767d2d91fd6975589e79071ac92f6d37fda4256719f21a4be19cb","src/retry/future.rs":"2209d94ae0ae79cd042600ae728e25f7f927183a5571ef6add817fec710c43e2","src/retry/layer.rs":"8936cf2528c5909a51352bd35d78dd3d09a973783a094ab766d42863ae1c1368","src/retry/mod.rs":"e106cf5d5603f05278328deb81f4af043bee2c36df6f2741e35873797f6d14d7","src/retry/never.rs":"fa4851e57c9f1e3fb6503a51343b4376346b6babb74a33b1b3b03fc517a26c20","src/retry/policy.rs":"77716fc37f829448a36142a5903241944a2dfe6fb404026cc4dc76b6154f8671","src/spawn_ready/future.rs":"0fbcfdcb51faaed676f38bc26355c1c77e7da1fd99fd48718eb9682b3b085960","src/spawn_ready/layer.rs":"3edc2badece7c6c435d82dbf86f33e386ec069e57b43abe69de7eb3c2827220c","src/spawn_ready/make.rs":"15c00c03a6a4b7283aded96de922672be31061c85f216a1c5bc34b83fb6b72f8","src/spawn_ready/mod.rs":"61a453b2ce94a0c944f09ad1df575ee3058cdf422be89078e922b5c52efd9a5b","src/spawn_ready/service.rs":"757a8c587ce930142b691f722e5e2b29391cfea997d7881852de26c717b42ba1","src/steer/mod.rs":"aa09c7cf18b0878d4bb8fc7c43065e2f57b9a6d064e110c74762de654f90e75d","src/timeout/error.rs":"7fc548e755b1c2de74c3d1c370c004b1acea2f15c3f8fbb73b5e7236d317e7c7","src/timeout/future.rs":"c95840418f9409ab807c9658248f043a637795417bf6fce3c34cd3c6ca2eb50c","src/timeout/layer.rs":"b4e8a8fd6ba3877fb7e8976e76186efa5ad8195ac18a04a337aa310689c67b04","src/timeout/mod.rs":"4977f4c8d3bfd5768821804ad5b27df72a3eaf16d5cdcb5cdebd0e9058437fbc","src/util/and_then.rs":"0fe6ebe3529352c6d35bdb4d4e22b483b0b42fd86e045b1f343b5dd841da17cc","src/util/boxed/layer.rs":"b04a61d416697a33cebfa0613a1bbaab39f1e006c40318abc766a7c359ecbc7d","src/util/boxed/mod.rs":"4ae6948d8f62ac412a83bbb1eccc84fd394a36b34f2966cde899d7c8db6ab421","src/util/boxed/sync.rs":"89940c239c1fe7eab206d277ca444118cf6605b49bfff9cd954d9819b106887a","src/util/boxed/unsync.rs":"8a1880bd5d06544fe14ee55b88891061afba1eb5e95ee1c2c174a179928f1f3b","src/util/boxed_clone.rs":"fda370fe8d2f0dd5671534b3f4c66fbe0357cf11427a327eea0eff64bbe112ee","src/util/call_all/common.rs":"cedfacfbdde4571f8dfce4a6c3be556a2a05df21bf3d7d1bb7e966e714cd069a","src/util/call_all/mod.rs":"30ad048636f4efb770a2d2dc3e5830827125fed132aebe741429fe766a6a38b1","src/util/call_all/ordered.rs":"af66fcc57f53b8e372c0f51cf3d7c46b28c3dc8fc8acd20a100ba9458c4f5845","src/util/call_all/unordered.rs":"67fda5251af7c2d529a409fbc8a9032739e7eb585123ae954bbe867bfe87e557","src/util/either.rs":"0613e0775590a69ea634f8d2b3d28def7cb71ee22debd94e0a0416acde4778db","src/util/future_service.rs":"ce2df36c4918513a867ef1b490cd5f5d231409d7c3ef589abec0ff321a9c7503","src/util/map_err.rs":"889ad649661524d275be89acc285629c7b431d0a215e9e0b573a269df9c91883","src/util/map_future.rs":"616a0b5c6aa5fa524b3abe6992ae658bc7e14ddfeb9a106315db5596bfc33636","src/util/map_request.rs":"5caf43eec2df2cdec146c684fbc230ac636318eae80d0647bbcb2a2373a4e3c3","src/util/map_response.rs":"d897483952caf50f65204918bd7d4caab26ef704b926b52ce38e77be4d641060","src/util/map_result.rs":"a3f578b5792cb1895491bd9f2104fb101daad5e6cae0cd86455d50643c3a0b6f","src/util/mod.rs":"d7c4eb965d703d4bb09eea772bb994978b9acbd8b7454d7c37ecd36ac415a0a0","src/util/oneshot.rs":"57a665a40472f3f27680bf597613da7f6c81c71d2a004cac5932c16284323652","src/util/optional/error.rs":"984180fcdac724c1dd8ce7bc7d35f1185555b5c407e025ea99a51bfa9ea506c2","src/util/optional/future.rs":"4ca99dbc2ab0eb39b922f54d6e159dce1922e4623a57762cd827a48fc400a77e","src/util/optional/mod.rs":"013262e69160eaf4474281481f177282ba6c1db98f38343eb76c87b8abdc2507","src/util/ready.rs":"78e9005366bd8a1790b842f5e72e4b7a7a2be806dc7130137072dbe37d3bba6d","src/util/service_fn.rs":"149dd5ef61af4a0ae8a55e28534f829a754dd0fa9604e01135143dcde7ed7c37","src/util/then.rs":"5906db998fa3dc16fbd5b6323d9de27e9df95ef293adc08c5b70c730ed8f5e4c","tests/balance/main.rs":"fb527f3a6a0409c59d9c622d46d807adf1f70f6e85a574aa70d2b20e873f9f68","tests/buffer/main.rs":"6b086e3792646eed0897a877757d84960454ca113b57ee4e64b620dd44e42217","tests/builder.rs":"e938c9dd43c6a0eaf54a27cf61c72363a2dafc693691a9a70e9536698a5e51cc","tests/filter/async_filter.rs":"8748a06916f42859d9e07883ba09f1141362a8fd2f7c92380c1f6f0355fc6c98","tests/hedge/main.rs":"e3ca75823f8132ee2dbea21d68e5990c8523df06414bf93af16d78009d4a720f","tests/limit/concurrency.rs":"20b06a1c60f2b4aab764d90a91def14b094ec6d67deefc9529461cd999d343d5","tests/limit/main.rs":"039a2731c8fce846b71d98937da2a08cea71a6a0ed2ebe0f20d215f33cdec66e","tests/limit/rate.rs":"52cfca0f27b6081e3ad19ceace931628a4eaf668274f963e15d80e1ea7aec380","tests/load_shed/main.rs":"c1d82eb9b30a4b1f0517b48cce9e87c9fb75c8d055c5b537f125d89225f65e95","tests/ready_cache/main.rs":"f71048223e26f708d5ffeef75ca57d7427b1ffc752af861a916cf53e81bc63c0","tests/retry/main.rs":"fd12935de233010084b0f1531d294197de22b681faadbefac409e78356d085e3","tests/spawn_ready/main.rs":"61230d0e5e412bfa7203142f4164cfb87402662e9cfd3de9ccf24f7edf911d16","tests/steer/main.rs":"979b3492545f4ecf71d65898a6c0c97d5f122ef6104e6a4e4820031fa10acff8","tests/support.rs":"8e6e32f9e0959b51096e38c98a848f10b2eedb9314335005b734f6a7e65ad11a","tests/util/call_all.rs":"b1d2ca6dbfee5d3e130b33c88bf88690f9777c247a665e71af6860bf4ae7106d","tests/util/main.rs":"a8b7960492d409914041a358c8eda79c10462baaf6548757fe05285a43e7f4a8","tests/util/oneshot.rs":"e4f013e5e3d2f2dc25d43337a8dd50d45ba835af74883908b67cab3d05380795","tests/util/service_fn.rs":"302962b6723804b415bf079717809dffebc455595567d865578c8701f2c0941f"},"package":"b8fa9be0de6cf49e536ce1851f987bd21a43b771b09473c3549a6c853db37c1c"}
\ No newline at end of file
diff --git a/crates/tower/Android.bp b/crates/tower/Android.bp
new file mode 100644
index 0000000..19a971b
--- /dev/null
+++ b/crates/tower/Android.bp
@@ -0,0 +1,66 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tower_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tower_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtower",
+ host_supported: true,
+ crate_name: "tower",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.4.13",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "__common",
+ "balance",
+ "buffer",
+ "discover",
+ "futures-core",
+ "futures-util",
+ "indexmap",
+ "limit",
+ "load",
+ "make",
+ "pin-project",
+ "pin-project-lite",
+ "rand",
+ "ready-cache",
+ "slab",
+ "timeout",
+ "tokio",
+ "tokio-util",
+ "tracing",
+ "util",
+ ],
+ rustlibs: [
+ "libfutures_core",
+ "libfutures_util",
+ "libindexmap",
+ "libpin_project",
+ "libpin_project_lite",
+ "librand",
+ "libslab",
+ "libtokio",
+ "libtokio_util",
+ "libtower_layer",
+ "libtower_service",
+ "libtracing",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tower/CHANGELOG.md b/crates/tower/CHANGELOG.md
new file mode 100644
index 0000000..db476d5
--- /dev/null
+++ b/crates/tower/CHANGELOG.md
@@ -0,0 +1,418 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+# Unreleased
+
+- None.
+
+# 0.4.13 (June 17, 2022)
+
+### Added
+
+- **load_shed**: Public constructor for `Overloaded` error ([#661])
+
+### Fixed
+
+- **util**: Fix hang with `call_all` when the `Stream` of requests is pending
+ ([#656])
+- **ready_cache**: Ensure cancelation is observed by pending services ([#668],
+ fixes [#415])
+- **docs**: Fix a missing section header due to a typo ([#646])
+- **docs**: Fix broken links to `Service` trait ([#659])
+
+
+[#661]: https://github.com/tower-rs/tower/pull/661
+[#656]: https://github.com/tower-rs/tower/pull/656
+[#668]: https://github.com/tower-rs/tower/pull/668
+[#415]: https://github.com/tower-rs/tower/pull/415
+[#646]: https://github.com/tower-rs/tower/pull/646
+[#659]: https://github.com/tower-rs/tower/pull/659
+
+# 0.4.12 (February 16, 2022)
+
+### Fixed
+
+- **hedge**, **load**, **retry**: Fix use of `Instant` operations that can panic
+ on platforms where `Instant` is not monotonic ([#633])
+- Disable `attributes` feature on `tracing` dependency ([#623])
+- Remove unused dependencies and dependency features with some feature
+ combinations ([#603], [#602])
+- **docs**: Fix a typo in the RustDoc for `Buffer` ([#622])
+
+### Changed
+
+- Updated minimum supported Rust version (MSRV) to 1.49.0.
+- **hedge**: Updated `hdrhistogram` dependency to v7.0 ([#602])
+- Updated `tokio-util` dependency to v0.7 ([#638])
+
+[#633]: https://github.com/tower-rs/tower/pull/633
+[#623]: https://github.com/tower-rs/tower/pull/623
+[#603]: https://github.com/tower-rs/tower/pull/603
+[#602]: https://github.com/tower-rs/tower/pull/602
+[#622]: https://github.com/tower-rs/tower/pull/622
+[#638]: https://github.com/tower-rs/tower/pull/638
+
+# 0.4.11 (November 18, 2021)
+
+### Added
+
+- **util**: Add `BoxCloneService` which is a `Clone + Send` boxed `Service` ([#615])
+- **util**: Add `ServiceExt::boxed` and `ServiceExt::boxed_clone` for applying the
+ `BoxService` and `BoxCloneService` middleware ([#616])
+- **builder**: Add `ServiceBuilder::boxed` and `ServiceBuilder::boxed_clone` for
+ applying `BoxService` and `BoxCloneService` layers ([#616])
+
+### Fixed
+
+- **util**: Remove redundant `F: Clone` bound from `ServiceExt::map_request` ([#607])
+- **util**: Remove unnecessary `Debug` bounds from `impl Debug for BoxService` ([#617])
+- **util**: Remove unnecessary `Debug` bounds from `impl Debug for UnsyncBoxService` ([#617])
+- **balance**: Remove redundant `Req: Clone` bound from `Clone` impls
+ for `MakeBalance`, and `MakeBalanceLayer` ([#607])
+- **balance**: Remove redundant `Req: Debug` bound from `Debug` impls
+ for `MakeBalance`, `MakeFuture`, `Balance`, and `Pool` ([#607])
+- **ready-cache**: Remove redundant `Req: Debug` bound from `Debug` impl
+ for `ReadyCache` ([#607])
+- **steer**: Remove redundant `Req: Debug` bound from `Debug` impl
+ for `Steer` ([#607])
+- **docs**: Fix `doc(cfg(...))` attributes
+ of `PeakEwmaDiscover`, and `PendingRequestsDiscover` ([#610])
+
+[#607]: https://github.com/tower-rs/tower/pull/607
+[#610]: https://github.com/tower-rs/tower/pull/610
+[#615]: https://github.com/tower-rs/tower/pull/615
+[#616]: https://github.com/tower-rs/tower/pull/616
+[#617]: https://github.com/tower-rs/tower/pull/617
+
+# 0.4.10 (October 19, 2021)
+
+- Fix accidental breaking change when using the
+ `rustdoc::broken_intra_doc_links` lint ([#605])
+- Clarify that tower's minimum supported rust version is 1.46 ([#605])
+
+[#605]: https://github.com/tower-rs/tower/pull/605
+
+# 0.4.9 (October 13, 2021)
+
+- Migrate to [pin-project-lite] ([#595])
+- **builder**: Implement `Layer` for `ServiceBuilder` ([#600])
+- **builder**: Add `ServiceBuilder::and_then` analogous to
+ `ServiceExt::and_then` ([#601])
+
+[#600]: https://github.com/tower-rs/tower/pull/600
+[#601]: https://github.com/tower-rs/tower/pull/601
+[#595]: https://github.com/tower-rs/tower/pull/595
+[pin-project-lite]: https://crates.io/crates/pin-project-lite
+
+# 0.4.8 (May 28, 2021)
+
+- **builder**: Add `ServiceBuilder::map_result` analogous to
+ `ServiceExt::map_result` ([#583])
+- **limit**: Add `GlobalConcurrencyLimitLayer` to allow reusing a concurrency
+ limit across multiple services ([#574])
+
+[#574]: https://github.com/tower-rs/tower/pull/574
+[#583]: https://github.com/tower-rs/tower/pull/583
+
+# 0.4.7 (April 27, 2021)
+
+### Added
+
+- **builder**: Add `ServiceBuilder::check_service` to check the request,
+ response, and error types of the output service. ([#576])
+- **builder**: Add `ServiceBuilder::check_service_clone` to check the output
+ service can be cloned. ([#576])
+
+### Fixed
+
+- **spawn_ready**: Abort spawned background tasks when the `SpawnReady` service
+ is dropped, fixing a potential task/resource leak (#[581])
+- Fixed broken documentation links ([#578])
+
+[#576]: https://github.com/tower-rs/tower/pull/576
+[#578]: https://github.com/tower-rs/tower/pull/578
+[#581]: https://github.com/tower-rs/tower/pull/581
+
+# 0.4.6 (February 26, 2021)
+
+### Deprecated
+
+- **util**: Deprecated `ServiceExt::ready_and` (renamed to `ServiceExt::ready`).
+ ([#567])
+- **util**: Deprecated `ReadyAnd` future (renamed to `Ready`). ([#567])
+### Added
+
+- **builder**: Add `ServiceBuilder::layer_fn` to add a layer built from a
+ function. ([#560])
+- **builder**: Add `ServiceBuilder::map_future` for transforming the futures
+ produced by a service. ([#559])
+- **builder**: Add `ServiceBuilder::service_fn` for applying `Layer`s to an
+ async function using `util::service_fn`. ([#564])
+- **util**: Add example for `service_fn`. ([#563])
+- **util**: Add `BoxLayer` for creating boxed `Layer` trait objects. ([#569])
+
+[#567]: https://github.com/tower-rs/tower/pull/567
+[#560]: https://github.com/tower-rs/tower/pull/560
+[#559]: https://github.com/tower-rs/tower/pull/559
+[#564]: https://github.com/tower-rs/tower/pull/564
+[#563]: https://github.com/tower-rs/tower/pull/563
+[#569]: https://github.com/tower-rs/tower/pull/569
+
+# 0.4.5 (February 10, 2021)
+
+### Added
+
+- **util**: Add `ServiceExt::map_future`. ([#542])
+- **builder**: Add `ServiceBuilder::option_layer` to optionally add a layer. ([#555])
+- **make**: Add `Shared` which lets you implement `MakeService` by cloning a
+ service. ([#533])
+
+### Fixed
+
+- **util**: Make combinators that contain closures implement `Debug`. They
+ previously wouldn't since closures never implement `Debug`. ([#552])
+- **steer**: Implement `Clone` for `Steer`. ([#554])
+- **spawn-ready**: SpawnReady now propagates the current `tracing` span to
+ spawned tasks ([#557])
+- Only pull in `tracing` for the features that need it. ([#551])
+
+[#542]: https://github.com/tower-rs/tower/pull/542
+[#555]: https://github.com/tower-rs/tower/pull/555
+[#557]: https://github.com/tower-rs/tower/pull/557
+[#533]: https://github.com/tower-rs/tower/pull/533
+[#551]: https://github.com/tower-rs/tower/pull/551
+[#554]: https://github.com/tower-rs/tower/pull/554
+[#552]: https://github.com/tower-rs/tower/pull/552
+
+# 0.4.4 (January 20, 2021)
+
+### Added
+
+- **util**: Implement `Layer` for `Either<A, B>`. ([#531])
+- **util**: Implement `Clone` for `FilterLayer`. ([#535])
+- **timeout**: Implement `Clone` for `TimeoutLayer`. ([#535])
+- **limit**: Implement `Clone` for `RateLimitLayer`. ([#535])
+
+### Fixed
+
+- Added "full" feature which turns on all other features. ([#532])
+- **spawn-ready**: Avoid oneshot allocations. ([#538])
+
+[#531]: https://github.com/tower-rs/tower/pull/531
+[#532]: https://github.com/tower-rs/tower/pull/532
+[#535]: https://github.com/tower-rs/tower/pull/535
+[#538]: https://github.com/tower-rs/tower/pull/538
+
+# 0.4.3 (January 13, 2021)
+
+### Added
+
+- **filter**: `Filter::check` and `AsyncFilter::check` methods which check a
+ request against the filter's `Predicate` ([#521])
+- **filter**: Added `get_ref`, `get_mut`, and `into_inner` methods to `Filter`
+ and `AsyncFilter`, allowing access to the wrapped service ([#522])
+- **util**: Added `layer` associated function to `AndThen`, `Then`,
+ `MapRequest`, `MapResponse`, and `MapResult` types. These return a `Layer`
+ that produces middleware of that type, as a convenience to avoid having to
+ import the `Layer` type separately. ([#524])
+- **util**: Added missing `Clone` impls to `AndThenLayer`, `MapRequestLayer`,
+ and `MapErrLayer`, when the mapped function implements `Clone` ([#525])
+- **util**: Added `FutureService::new` constructor, with less restrictive bounds
+ than the `future_service` free function ([#523])
+
+[#521]: https://github.com/tower-rs/tower/pull/521
+[#522]: https://github.com/tower-rs/tower/pull/522
+[#523]: https://github.com/tower-rs/tower/pull/523
+[#524]: https://github.com/tower-rs/tower/pull/524
+[#525]: https://github.com/tower-rs/tower/pull/525
+
+# 0.4.2 (January 11, 2021)
+
+### Added
+
+- Export `layer_fn` and `LayerFn` from the `tower::layer` module. ([#516])
+
+### Fixed
+
+- Fix missing `Sync` implementation for `Buffer` and `ConcurrencyLimit` ([#518])
+
+[#518]: https://github.com/tower-rs/tower/pull/518
+[#516]: https://github.com/tower-rs/tower/pull/516
+
+# 0.4.1 (January 7, 2021)
+
+### Fixed
+
+- Updated `tower-layer` to 0.3.1 to fix broken re-exports.
+
+# 0.4.0 (January 7, 2021)
+
+This is a major breaking release including a large number of changes. In
+particular, this release updates `tower` to depend on Tokio 1.0, and moves all
+middleware into the `tower` crate. In addition, Tower 0.4 reworks several
+middleware APIs, as well as introducing new ones.
+
+This release does *not* change the core `Service` or `Layer` traits, so `tower`
+0.4 still depends on `tower-service` 0.3 and `tower-layer` 0.3. This means that
+`tower` 0.4 is still compatible with libraries that depend on those crates.
+
+### Added
+
+- **make**: Added `MakeService::into_service` and `MakeService::as_service` for
+ converting `MakeService`s into `Service`s ([#492])
+- **steer**: Added `steer` middleware for routing requests to one of a set of
+ services ([#426])
+- **util**: Added `MapRequest` middleware and `ServiceExt::map_request`, for
+ applying a function to a request before passing it to the inner service
+ ([#435])
+- **util**: Added `MapResponse` middleware and `ServiceExt::map_response`, for
+ applying a function to the `Response` type of an inner service after its
+ future completes ([#435])
+- **util**: Added `MapErr` middleware and `ServiceExt::map_err`, for
+ applying a function to the `Error` returned by an inner service if it fails
+ ([#396])
+- **util**: Added `MapResult` middleware and `ServiceExt::map_result`, for
+ applying a function to the `Result` returned by an inner service's future
+ regardless of whether it succeeds or fails ([#499])
+- **util**: Added `Then` middleware and `ServiceExt::then`, for chaining another
+ future after an inner service's future completes (with a `Response` or an
+ `Error`) ([#500])
+- **util**: Added `AndThen` middleware and `ServiceExt::and_then`, for
+ chaining another future after an inner service's future completes successfully
+ ([#485])
+- **util**: Added `layer_fn`, for constructing a `Layer` from a function taking
+ a `Service` and returning a different `Service` ([#491])
+- **util**: Added `FutureService`, which implements `Service` for a
+ `Future` whose `Output` type is a `Service` ([#496])
+- **util**: Added `BoxService::layer` and `UnsyncBoxService::layer`, to make
+ constructing layers more ergonomic ([#503])
+- **layer**: Added `Layer` impl for `&Layer` ([#446])
+- **retry**: Added `Retry::get_ref`, `Retry::get_mut`, and `Retry::into_inner`
+ to access the inner service ([#463])
+- **timeout**: Added `Timeout::get_ref`, `Timeout::get_mut`, and
+ `Timeout::into_inner` to access the inner service ([#463])
+- **buffer**: Added `Clone` and `Copy` impls for `BufferLayer` (#[493])
+- Several documentation improvements ([#442], [#444], [#445], [#449], [#487],
+ [#490], [#506]])
+
+### Changed
+
+- All middleware `tower-*` crates were merged into `tower` and placed
+ behind feature flags ([#432])
+- Updated Tokio dependency to 1.0 ([#489])
+- **builder**: Make `ServiceBuilder::service` take `self` by reference rather
+ than by value ([#504])
+- **reconnect**: Return errors from `MakeService` in the response future, rather than
+ in `poll_ready`, allowing the reconnect service to be reused when a reconnect
+ fails ([#386], [#437])
+- **discover**: Changed `Discover` to be a sealed trait alias for a
+ `TryStream<Item = Change>`. `Discover` implementations are now written by
+ implementing `Stream`. ([#443])
+- **load**: Renamed the `Instrument` trait to `TrackCompletion` ([#445])
+- **load**: Renamed `NoInstrument` to `CompleteOnResponse` ([#445])
+- **balance**: Renamed `BalanceLayer` to `MakeBalanceLayer` ([#449])
+- **balance**: Renamed `BalanceMake` to `MakeBalance` ([#449])
+- **ready-cache**: Changed `ready_cache::error::Failed`'s `fmt::Debug` impl to
+ require the key type to also implement `fmt::Debug` ([#467])
+- **filter**: Changed `Filter` and `Predicate` to use a synchronous function as
+ a predicate ([#508])
+- **filter**: Renamed the previous `Filter` and `Predicate` (where `Predicate`s
+ returned a `Future`) to `AsyncFilter` and `AsyncPredicate` ([#508])
+- **filter**: `Predicate`s now take a `Request` type by value and may return a
+ new request, potentially of a different type ([#508])
+- **filter**: `Predicate`s may now return an error of any type ([#508])
+
+### Fixed
+
+- **limit**: Fixed an issue where `RateLimit` services do not reset the remaining
+ count when rate limiting ([#438], [#439])
+- **util**: Fixed a bug where `oneshot` futures panic if the service does not
+ immediately become ready ([#447])
+- **ready-cache**: Fixed `ready_cache::error::Failed` not returning inner error types
+ via `Error::source` ([#467])
+- **hedge**: Fixed an interaction with `buffer` where `buffer` slots were
+ eagerly reserved for hedge requests even if they were not sent ([#472])
+- **hedge**: Fixed the use of a fixed 10 second bound on the hedge latency
+ histogram resulting on errors with longer-lived requests. The latency
+ histogram now automatically resizes ([#484])
+- **buffer**: Fixed an issue where tasks waiting for buffer capacity were not
+ woken when a buffer is dropped, potentially resulting in a task leak ([#480])
+
+### Removed
+
+- Remove `ServiceExt::ready`.
+- **discover**: Removed `discover::stream` module, since `Discover` is now an
+ alias for `Stream` ([#443])
+- **buffer**: Removed `MakeBalance::from_rng`, which caused all balancers to use
+ the same RNG ([#497])
+
+[#432]: https://github.com/tower-rs/tower/pull/432
+[#426]: https://github.com/tower-rs/tower/pull/426
+[#435]: https://github.com/tower-rs/tower/pull/435
+[#499]: https://github.com/tower-rs/tower/pull/499
+[#386]: https://github.com/tower-rs/tower/pull/386
+[#437]: https://github.com/tower-rs/tower/pull/487
+[#438]: https://github.com/tower-rs/tower/pull/438
+[#437]: https://github.com/tower-rs/tower/pull/439
+[#443]: https://github.com/tower-rs/tower/pull/443
+[#442]: https://github.com/tower-rs/tower/pull/442
+[#444]: https://github.com/tower-rs/tower/pull/444
+[#445]: https://github.com/tower-rs/tower/pull/445
+[#446]: https://github.com/tower-rs/tower/pull/446
+[#447]: https://github.com/tower-rs/tower/pull/447
+[#449]: https://github.com/tower-rs/tower/pull/449
+[#463]: https://github.com/tower-rs/tower/pull/463
+[#396]: https://github.com/tower-rs/tower/pull/396
+[#467]: https://github.com/tower-rs/tower/pull/467
+[#472]: https://github.com/tower-rs/tower/pull/472
+[#480]: https://github.com/tower-rs/tower/pull/480
+[#484]: https://github.com/tower-rs/tower/pull/484
+[#489]: https://github.com/tower-rs/tower/pull/489
+[#497]: https://github.com/tower-rs/tower/pull/497
+[#487]: https://github.com/tower-rs/tower/pull/487
+[#493]: https://github.com/tower-rs/tower/pull/493
+[#491]: https://github.com/tower-rs/tower/pull/491
+[#495]: https://github.com/tower-rs/tower/pull/495
+[#503]: https://github.com/tower-rs/tower/pull/503
+[#504]: https://github.com/tower-rs/tower/pull/504
+[#492]: https://github.com/tower-rs/tower/pull/492
+[#500]: https://github.com/tower-rs/tower/pull/500
+[#490]: https://github.com/tower-rs/tower/pull/490
+[#506]: https://github.com/tower-rs/tower/pull/506
+[#508]: https://github.com/tower-rs/tower/pull/508
+[#485]: https://github.com/tower-rs/tower/pull/485
+
+# 0.3.1 (January 17, 2020)
+
+- Allow opting out of tracing/log (#410).
+
+# 0.3.0 (December 19, 2019)
+
+- Update all tower based crates to `0.3`.
+- Update to `tokio 0.2`
+- Update to `futures 0.3`
+
+# 0.3.0-alpha.2 (September 30, 2019)
+
+- Move to `futures-*-preview 0.3.0-alpha.19`
+- Move to `pin-project 0.4`
+
+# 0.3.0-alpha.1a (September 13, 2019)
+
+- Update `tower-buffer` to `0.3.0-alpha.1b`
+
+# 0.3.0-alpha.1 (September 11, 2019)
+
+- Move to `std::future`
+
+# 0.1.1 (July 19, 2019)
+
+- Add `ServiceBuilder::into_inner`
+
+# 0.1.0 (April 26, 2019)
+
+- Initial release
diff --git a/crates/tower/Cargo.lock b/crates/tower/Cargo.lock
new file mode 100644
index 0000000..e6119fe
--- /dev/null
+++ b/crates/tower/Cargo.lock
@@ -0,0 +1,574 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "ansi_term"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d52a9bb7ec0cf484c551830a7ce27bd20d67eac647e1befb56b0be4ee39a55d2"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "async-stream"
+version = "0.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dad5c83079eae9969be7fadefe640a1c566901f05ff91ab221de4b6f68d9507e"
+dependencies = [
+ "async-stream-impl",
+ "futures-core",
+]
+
+[[package]]
+name = "async-stream-impl"
+version = "0.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "10f203db73a71dfa2fb6dd22763990fa26f3d2625a6da2da900d23b87d26be27"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "autocfg"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+
+[[package]]
+name = "byteorder"
+version = "1.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "14c189c53d098945499cdfa7ecc63567cf3886b3332b312a5b4585d8d3a6a610"
+
+[[package]]
+name = "bytes"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c4872d67bab6358e59559027aa3b9157c53d9358c51423c17554809a8858e0f8"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "fnv"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
+
+[[package]]
+name = "futures"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f73fe65f54d1e12b726f517d3e2135ca3125a437b6d998caf1962961f7172d9e"
+dependencies = [
+ "futures-channel",
+ "futures-core",
+ "futures-executor",
+ "futures-io",
+ "futures-sink",
+ "futures-task",
+ "futures-util",
+]
+
+[[package]]
+name = "futures-channel"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c3083ce4b914124575708913bca19bfe887522d6e2e6d0952943f5eac4a74010"
+dependencies = [
+ "futures-core",
+ "futures-sink",
+]
+
+[[package]]
+name = "futures-core"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c09fd04b7e4073ac7156a9539b57a484a8ea920f79c7c675d05d289ab6110d3"
+
+[[package]]
+name = "futures-executor"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9420b90cfa29e327d0429f19be13e7ddb68fa1cccb09d65e5706b8c7a749b8a6"
+dependencies = [
+ "futures-core",
+ "futures-task",
+ "futures-util",
+]
+
+[[package]]
+name = "futures-io"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fc4045962a5a5e935ee2fdedaa4e08284547402885ab326734432bed5d12966b"
+
+[[package]]
+name = "futures-macro"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "33c1e13800337f4d4d7a316bf45a567dbcb6ffe087f16424852d97e97a91f512"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "futures-sink"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "21163e139fa306126e6eedaf49ecdb4588f939600f0b1e770f4205ee4b7fa868"
+
+[[package]]
+name = "futures-task"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "57c66a976bf5909d801bbef33416c41372779507e7a6b3a5e25e4749c58f776a"
+
+[[package]]
+name = "futures-util"
+version = "0.3.21"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d8b7abd5d659d9b90c8cba917f6ec750a74e2dc23902ef9cd4cc8c8b22e6036a"
+dependencies = [
+ "futures-channel",
+ "futures-core",
+ "futures-io",
+ "futures-macro",
+ "futures-sink",
+ "futures-task",
+ "memchr",
+ "pin-project-lite",
+ "pin-utils",
+ "slab",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4eb1a864a501629691edf6c15a593b7a51eebaa1e8468e9ddc623de7c9b58ec6"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "hashbrown"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "db0d4cf898abf0081f964436dc980e96670a0f36863e4b83aaacdb65c9d7ccc3"
+
+[[package]]
+name = "hdrhistogram"
+version = "7.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "31672b7011be2c4f7456c4ddbcb40e7e9a4a9fad8efe49a6ebaf5f307d0109c0"
+dependencies = [
+ "byteorder",
+ "num-traits",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.1.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "http"
+version = "0.2.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75f43d41e26995c17e71ee126451dd3941010b0514a81a9d11f3b341debc2399"
+dependencies = [
+ "bytes",
+ "fnv",
+ "itoa",
+]
+
+[[package]]
+name = "indexmap"
+version = "1.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6c6392766afd7964e2531940894cffe4bd8d7d17dbc3c1c4857040fd4b33bdb3"
+dependencies = [
+ "autocfg",
+ "hashbrown",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "112c678d4050afce233f4f2852bb2eb519230b3cf12f33585275537d7e41578d"
+
+[[package]]
+name = "lazy_static"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+
+[[package]]
+name = "libc"
+version = "0.2.126"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "349d5a591cd28b49e1d1037471617a32ddcda5731b99419008085f72d5a53836"
+
+[[package]]
+name = "log"
+version = "0.4.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "memchr"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d"
+
+[[package]]
+name = "num-traits"
+version = "0.2.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "578ede34cf02f8924ab9447f50c28075b4d3e5b269972345e7e0372b38c6cdcd"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "num_cpus"
+version = "1.13.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19e64526ebdee182341572e50e9ad03965aa510cd94427a4549448f285e957a1"
+dependencies = [
+ "hermit-abi",
+ "libc",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7709cef83f0c1f58f666e746a08b21e0085f7440fa6a29cc194d68aac97a4225"
+
+[[package]]
+name = "pin-project"
+version = "1.0.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "58ad3879ad3baf4e44784bc6a718a8698867bb991f8ce24d1bcbe2cfb4c3a75e"
+dependencies = [
+ "pin-project-internal",
+]
+
+[[package]]
+name = "pin-project-internal"
+version = "1.0.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "744b6f092ba29c3650faf274db506afd39944f48420f6c86b17cfe0ee1cb36bb"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "pin-project-lite"
+version = "0.2.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e0a7ae3ac2f1173085d398531c705756c94a4c56843785df85a60c1a0afac116"
+
+[[package]]
+name = "pin-utils"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184"
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eb9f9e6e233e5c4a35559a617bf40a4ec447db2e84c20b55a6f83167b7e57872"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.39"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c54b25569025b7fc9651de43004ae593a75ad88543b17178aa5e1b9c4f15f56f"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a1feb54ed693b93a84e14094943b84b7c4eae204c512b7ccb95ab0c66d278ad1"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d34f1408f55294453790c48b2f1ebbb1c5b4b7563eb1f418bcfcfdbb06ebb4e7"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "sharded-slab"
+version = "0.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "900fba806f70c630b0a382d0d825e17a0f19fcd059a2ade1ff237bcddf446b31"
+dependencies = [
+ "lazy_static",
+]
+
+[[package]]
+name = "slab"
+version = "0.4.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eb703cfe953bccee95685111adeedb76fabe4e97549a58d16f03ea7b9367bb32"
+
+[[package]]
+name = "syn"
+version = "1.0.96"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0748dd251e24453cb8717f0354206b91557e4ec8703673a4b30208f2abaf1ebf"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "thread_local"
+version = "1.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5516c27b78311c50bf42c071425c560ac799b11c30b31f87e3081965fe5e0180"
+dependencies = [
+ "once_cell",
+]
+
+[[package]]
+name = "tokio"
+version = "1.19.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c51a52ed6686dd62c320f9b89299e9dfb46f730c7a48e635c19f21d116cb1439"
+dependencies = [
+ "num_cpus",
+ "once_cell",
+ "pin-project-lite",
+ "tokio-macros",
+]
+
+[[package]]
+name = "tokio-macros"
+version = "1.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9724f9a975fb987ef7a3cd9be0350edcbe130698af5b8f7a631e23d42d052484"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "tokio-stream"
+version = "0.1.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df54d54117d6fdc4e4fea40fe1e4e566b3505700e148a6827e59b34b0d2600d9"
+dependencies = [
+ "futures-core",
+ "pin-project-lite",
+ "tokio",
+]
+
+[[package]]
+name = "tokio-test"
+version = "0.4.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53474327ae5e166530d17f2d956afcb4f8a004de581b3cae10f12006bc8163e3"
+dependencies = [
+ "async-stream",
+ "bytes",
+ "futures-core",
+ "tokio",
+ "tokio-stream",
+]
+
+[[package]]
+name = "tokio-util"
+version = "0.7.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cc463cd8deddc3770d20f9852143d50bf6094e640b485cb2e189a2099085ff45"
+dependencies = [
+ "bytes",
+ "futures-core",
+ "futures-sink",
+ "pin-project-lite",
+ "tokio",
+]
+
+[[package]]
+name = "tower"
+version = "0.4.13"
+dependencies = [
+ "futures",
+ "futures-core",
+ "futures-util",
+ "hdrhistogram",
+ "http",
+ "indexmap",
+ "lazy_static",
+ "pin-project",
+ "pin-project-lite",
+ "rand",
+ "slab",
+ "tokio",
+ "tokio-stream",
+ "tokio-test",
+ "tokio-util",
+ "tower-layer",
+ "tower-service",
+ "tower-test",
+ "tracing",
+ "tracing-subscriber",
+]
+
+[[package]]
+name = "tower-layer"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "343bc9466d3fe6b0f960ef45960509f84480bf4fd96f92901afe7ff3df9d3a62"
+
+[[package]]
+name = "tower-service"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52"
+
+[[package]]
+name = "tower-test"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a4546773ffeab9e4ea02b8872faa49bb616a80a7da66afc2f32688943f97efa7"
+dependencies = [
+ "futures-util",
+ "pin-project",
+ "tokio",
+ "tokio-test",
+ "tower-layer",
+ "tower-service",
+]
+
+[[package]]
+name = "tracing"
+version = "0.1.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a400e31aa60b9d44a52a8ee0343b5b18566b03a8321e0d321f695cf56e940160"
+dependencies = [
+ "cfg-if",
+ "log",
+ "pin-project-lite",
+ "tracing-core",
+]
+
+[[package]]
+name = "tracing-core"
+version = "0.1.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7709595b8878a4965ce5e87ebf880a7d39c9afc6837721b21a5a816a8117d921"
+dependencies = [
+ "once_cell",
+ "valuable",
+]
+
+[[package]]
+name = "tracing-subscriber"
+version = "0.3.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4bc28f93baff38037f64e6f43d34cfa1605f27a49c34e8a04c5e78b0babf2596"
+dependencies = [
+ "ansi_term",
+ "sharded-slab",
+ "thread_local",
+ "tracing-core",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5bd2fe26506023ed7b5e1e315add59d6f584c621d037f9368fea9cfb988f368c"
+
+[[package]]
+name = "valuable"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d"
+
+[[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
diff --git a/crates/tower/Cargo.toml b/crates/tower/Cargo.toml
new file mode 100644
index 0000000..6dd357d
--- /dev/null
+++ b/crates/tower/Cargo.toml
@@ -0,0 +1,263 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.49.0"
+name = "tower"
+version = "0.4.13"
+authors = ["Tower Maintainers <[email protected]>"]
+description = """
+Tower is a library of modular and reusable components for building robust
+clients and servers.
+"""
+homepage = "https://github.com/tower-rs/tower"
+documentation = "https://docs.rs/tower/0.4.13"
+readme = "README.md"
+keywords = [
+ "io",
+ "async",
+ "non-blocking",
+ "futures",
+ "service",
+]
+categories = [
+ "asynchronous",
+ "network-programming",
+]
+license = "MIT"
+repository = "https://github.com/tower-rs/tower"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+]
+
+[package.metadata.playground]
+features = ["full"]
+
+[[example]]
+name = "tower-balance"
+path = "examples/tower-balance.rs"
+required-features = ["full"]
+
+[dependencies.futures-core]
+version = "0.3"
+optional = true
+
+[dependencies.futures-util]
+version = "0.3"
+features = ["alloc"]
+optional = true
+default-features = false
+
+[dependencies.hdrhistogram]
+version = "7.0"
+optional = true
+default-features = false
+
+[dependencies.indexmap]
+version = "1.0.2"
+optional = true
+
+[dependencies.pin-project]
+version = "1"
+optional = true
+
+[dependencies.pin-project-lite]
+version = "0.2.7"
+optional = true
+
+[dependencies.rand]
+version = "0.8"
+features = ["small_rng"]
+optional = true
+
+[dependencies.slab]
+version = "0.4"
+optional = true
+
+[dependencies.tokio]
+version = "1.6"
+features = ["sync"]
+optional = true
+
+[dependencies.tokio-stream]
+version = "0.1.0"
+optional = true
+
+[dependencies.tokio-util]
+version = "0.7.0"
+optional = true
+default-features = false
+
+[dependencies.tower-layer]
+version = "0.3.1"
+
+[dependencies.tower-service]
+version = "0.3.1"
+
+[dependencies.tracing]
+version = "0.1.2"
+features = ["std"]
+optional = true
+default-features = false
+
+[dev-dependencies.futures]
+version = "0.3"
+
+[dev-dependencies.hdrhistogram]
+version = "7.0"
+default-features = false
+
+[dev-dependencies.http]
+version = "0.2"
+
+[dev-dependencies.lazy_static]
+version = "1.4.0"
+
+[dev-dependencies.pin-project-lite]
+version = "0.2.7"
+
+[dev-dependencies.tokio]
+version = "1.6.2"
+features = [
+ "macros",
+ "sync",
+ "test-util",
+ "rt-multi-thread",
+]
+
+[dev-dependencies.tokio-stream]
+version = "0.1"
+
+[dev-dependencies.tokio-test]
+version = "0.4"
+
+[dev-dependencies.tower-test]
+version = "0.4"
+
+[dev-dependencies.tracing-subscriber]
+version = "0.3"
+features = [
+ "fmt",
+ "ansi",
+]
+default-features = false
+
+[features]
+__common = [
+ "futures-core",
+ "pin-project-lite",
+]
+balance = [
+ "discover",
+ "load",
+ "ready-cache",
+ "make",
+ "rand",
+ "slab",
+]
+buffer = [
+ "__common",
+ "tokio/sync",
+ "tokio/rt",
+ "tokio-util",
+ "tracing",
+]
+default = ["log"]
+discover = ["__common"]
+filter = [
+ "__common",
+ "futures-util",
+]
+full = [
+ "balance",
+ "buffer",
+ "discover",
+ "filter",
+ "hedge",
+ "limit",
+ "load",
+ "load-shed",
+ "make",
+ "ready-cache",
+ "reconnect",
+ "retry",
+ "spawn-ready",
+ "steer",
+ "timeout",
+ "util",
+]
+hedge = [
+ "util",
+ "filter",
+ "futures-util",
+ "hdrhistogram",
+ "tokio/time",
+ "tracing",
+]
+limit = [
+ "__common",
+ "tokio/time",
+ "tokio/sync",
+ "tokio-util",
+ "tracing",
+]
+load = [
+ "__common",
+ "tokio/time",
+ "tracing",
+]
+load-shed = ["__common"]
+log = ["tracing/log"]
+make = [
+ "futures-util",
+ "pin-project-lite",
+ "tokio/io-std",
+]
+ready-cache = [
+ "futures-core",
+ "futures-util",
+ "indexmap",
+ "tokio/sync",
+ "tracing",
+ "pin-project-lite",
+]
+reconnect = [
+ "make",
+ "tokio/io-std",
+ "tracing",
+]
+retry = [
+ "__common",
+ "tokio/time",
+]
+spawn-ready = [
+ "__common",
+ "futures-util",
+ "tokio/sync",
+ "tokio/rt",
+ "util",
+ "tracing",
+]
+steer = []
+timeout = [
+ "pin-project-lite",
+ "tokio/time",
+]
+util = [
+ "__common",
+ "futures-util",
+ "pin-project",
+]
diff --git a/crates/tower/LICENSE b/crates/tower/LICENSE
new file mode 100644
index 0000000..b980cac
--- /dev/null
+++ b/crates/tower/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tower Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tower/METADATA b/crates/tower/METADATA
new file mode 100644
index 0000000..488e27b
--- /dev/null
+++ b/crates/tower/METADATA
@@ -0,0 +1,20 @@
+name: "tower"
+description: "()"
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "tower"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tower/tower-0.4.13.crate"
+ primary_source: true
+ }
+ version: "0.4.13"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 5
+ day: 27
+ }
+}
diff --git a/crates/tower/MODULE_LICENSE_MIT b/crates/tower/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tower/MODULE_LICENSE_MIT
diff --git a/crates/tower/README.md b/crates/tower/README.md
new file mode 100644
index 0000000..d8f6f41
--- /dev/null
+++ b/crates/tower/README.md
@@ -0,0 +1,190 @@
+# Tower
+
+Tower is a library of modular and reusable components for building robust
+networking clients and servers.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tower.svg
+[crates-url]: https://crates.io/crates/tower
+[docs-badge]: https://docs.rs/tower/badge.svg
+[docs-url]: https://docs.rs/tower
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tower-rs.github.io/tower/tower
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tower-rs/tower/workflows/CI/badge.svg
+[actions-url]:https://github.com/tower-rs/tower/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+## Overview
+
+Tower aims to make it as easy as possible to build robust networking clients and
+servers. It is protocol agnostic, but is designed around a request / response
+pattern. If your protocol is entirely stream based, Tower may not be a good fit.
+
+Tower provides a simple core abstraction, the [`Service`] trait, which
+represents an asynchronous function taking a request and returning either a
+response or an error. This abstraction can be used to model both clients and
+servers.
+
+Generic components, like [timeouts], [rate limiting], and [load balancing],
+can be modeled as [`Service`]s that wrap some inner service and apply
+additional behavior before or after the inner service is called. This allows
+implementing these components in a protocol-agnostic, composable way. Typically,
+such services are referred to as _middleware_.
+
+An additional abstraction, the [`Layer`] trait, is used to compose
+middleware with [`Service`]s. If a [`Service`] can be thought of as an
+asynchronous function from a request type to a response type, a [`Layer`] is
+a function taking a [`Service`] of one type and returning a [`Service`] of a
+different type. The [`ServiceBuilder`] type is used to add middleware to a
+service by composing it with multiple multiple [`Layer`]s.
+
+### The Tower Ecosystem
+
+Tower is made up of the following crates:
+
+* [`tower`] (this crate)
+* [`tower-service`]
+* [`tower-layer`]
+* [`tower-test`]
+
+Since the [`Service`] and [`Layer`] traits are important integration points
+for all libraries using Tower, they are kept as stable as possible, and
+breaking changes are made rarely. Therefore, they are defined in separate
+crates, [`tower-service`] and [`tower-layer`]. This crate contains
+re-exports of those core traits, implementations of commonly-used
+middleware, and [utilities] for working with [`Service`]s and [`Layer`]s.
+Finally, the [`tower-test`] crate provides tools for testing programs using
+Tower.
+
+## Usage
+
+Tower provides an abstraction layer, and generic implementations of various
+middleware. This means that the `tower` crate on its own does *not* provide
+a working implementation of a network client or server. Instead, Tower's
+[`Service` trait][`Service`] provides an integration point between
+application code, libraries providing middleware implementations, and
+libraries that implement servers and/or clients for various network
+protocols.
+
+Depending on your particular use case, you might use Tower in several ways:
+
+* **Implementing application logic** for a networked program. You might
+ use the [`Service`] trait to model your application's behavior, and use
+ the middleware [provided by this crate][all_layers] and by other libraries
+ to add functionality to clients and servers provided by one or more
+ protocol implementations.
+* **Implementing middleware** to add custom behavior to network clients and
+ servers in a reusable manner. This might be general-purpose middleware
+ (and if it is, please consider releasing your middleware as a library for
+ other Tower users!) or application-specific behavior that needs to be
+ shared between multiple clients or servers.
+* **Implementing a network protocol**. Libraries that implement network
+ protocols (such as HTTP) can depend on `tower-service` to use the
+ [`Service`] trait as an integration point between the protocol and user
+ code. For example, a client for some protocol might implement [`Service`],
+ allowing users to add arbitrary Tower middleware to those clients.
+ Similarly, a server might be created from a user-provided [`Service`].
+
+ Additionally, when a network protocol requires functionality already
+ provided by existing Tower middleware, a protocol implementation might use
+ Tower middleware internally, as well as as an integration point.
+
+### Library Support
+
+A number of third-party libraries support Tower and the [`Service`] trait.
+The following is an incomplete list of such libraries:
+
+* [`hyper`]: A fast and correct low-level HTTP implementation.
+* [`tonic`]: A [gRPC-over-HTTP/2][grpc] implementation built on top of
+ [`hyper`]. See [here][tonic-examples] for examples of using [`tonic`] with
+ Tower.
+* [`warp`]: A lightweight, composable web framework. See
+ [here][warp-service] for details on using [`warp`] with Tower.
+* [`tower-lsp`] and its fork, [`lspower`]: implementations of the [Language
+ Server Protocol][lsp] based on Tower.
+* [`kube`]: Kubernetes client and futures controller runtime. [`kube::Client`]
+ makes use of the Tower ecosystem: [`tower`], [`tower-http`], and
+ [`tower-test`]. See [here][kube-example-minimal] and
+ [here][kube-example-trace] for examples of using [`kube`] with Tower.
+
+[`hyper`]: https://crates.io/crates/hyper
+[`tonic`]: https://crates.io/crates/tonic
+[tonic-examples]: https://github.com/hyperium/tonic/tree/master/examples/src/tower
+[grpc]: https://grpc.io
+[`warp`]: https://crates.io/crates/warp
+[warp-service]: https://docs.rs/warp/0.2.5/warp/fn.service.html
+[`tower-lsp`]: https://crates.io/crates/tower-lsp
+[`lspower`]: https://crates.io/crates/lspower
+[lsp]: https://microsoft.github.io/language-server-protocol/
+[`kube`]: https://crates.io/crates/kube
+[`kube::Client`]: https://docs.rs/kube/latest/kube/struct.Client.html
+[kube-example-minimal]: https://github.com/clux/kube-rs/blob/master/examples/custom_client.rs
+[kube-example-trace]: https://github.com/clux/kube-rs/blob/master/examples/custom_client_trace.rs
+[`tower-http`]: https://crates.io/crates/tower-http
+
+If you're the maintainer of a crate that supports Tower, we'd love to add
+your crate to this list! Please [open a PR] adding a brief description of
+your library!
+
+### Getting Started
+
+The various middleware implementations provided by this crate are feature
+flagged, so that users can only compile the parts of Tower they need. By
+default, all the optional middleware are disabled.
+
+To get started using all of Tower's optional middleware, add this to your
+`Cargo.toml`:
+
+```toml
+tower = { version = "0.4", features = ["full"] }
+```
+
+Alternatively, you can only enable some features. For example, to enable
+only the [`retry`] and [`timeout`][timeouts] middleware, write:
+
+```toml
+tower = { version = "0.4", features = ["retry", "timeout"] }
+```
+
+See [here][all_layers] for a complete list of all middleware provided by
+Tower.
+
+[`Service`]: https://docs.rs/tower/latest/tower/trait.Service.html
+[`Layer`]: https://docs.rs/tower/latest/tower/trait.Layer.html
+[all_layers]: https://docs.rs/tower/latest/tower/#modules
+[timeouts]: https://docs.rs/tower/latest/tower/timeout/
+[rate limiting]: https://docs.rs/tower/latest/tower/limit/rate
+[load balancing]: https://docs.rs/tower/latest/tower/balance/
+[`ServiceBuilder`]: https://docs.rs/tower/latest/tower/struct.ServiceBuilder.html
+[utilities]: https://docs.rs/tower/latest/tower/trait.ServiceExt.html
+[`tower`]: https://crates.io/crates/tower
+[`tower-service`]: https://crates.io/crates/tower-service
+[`tower-layer`]: https://crates.io/crates/tower-layer
+[`tower-test`]: https://crates.io/crates/tower-test
+[`retry`]: https://docs.rs/tower/latest/tower/retry
+[open a PR]: https://github.com/tower-rs/tower/compare
+
+
+## Supported Rust Versions
+
+Tower will keep a rolling MSRV (minimum supported Rust version) policy of **at
+least** 6 months. When increasing the MSRV, the new Rust version must have been
+released at least six months ago. The current MSRV is 1.49.0.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tower by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tower/cargo_embargo.json b/crates/tower/cargo_embargo.json
new file mode 100644
index 0000000..ef2a686
--- /dev/null
+++ b/crates/tower/cargo_embargo.json
@@ -0,0 +1,25 @@
+{
+ "features":[
+ "__common",
+ "balance",
+ "buffer",
+ "discover",
+ "futures-core",
+ "futures-util",
+ "indexmap",
+ "limit",
+ "load",
+ "make",
+ "pin-project",
+ "pin-project-lite",
+ "rand",
+ "ready-cache",
+ "slab",
+ "timeout",
+ "tokio",
+ "tokio-util",
+ "tracing",
+ "util"
+ ],
+ "run_cargo":false
+}
\ No newline at end of file
diff --git a/crates/tower/examples/tower-balance.rs b/crates/tower/examples/tower-balance.rs
new file mode 100644
index 0000000..998bb7c
--- /dev/null
+++ b/crates/tower/examples/tower-balance.rs
@@ -0,0 +1,235 @@
+//! Exercises load balancers with mocked services.
+
+use futures_core::{Stream, TryStream};
+use futures_util::{stream, stream::StreamExt, stream::TryStreamExt};
+use hdrhistogram::Histogram;
+use pin_project_lite::pin_project;
+use rand::{self, Rng};
+use std::hash::Hash;
+use std::time::Duration;
+use std::{
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::time::{self, Instant};
+use tower::balance as lb;
+use tower::discover::{Change, Discover};
+use tower::limit::concurrency::ConcurrencyLimit;
+use tower::load;
+use tower::util::ServiceExt;
+use tower_service::Service;
+
+const REQUESTS: usize = 100_000;
+const CONCURRENCY: usize = 500;
+const DEFAULT_RTT: Duration = Duration::from_millis(30);
+static ENDPOINT_CAPACITY: usize = CONCURRENCY;
+static MAX_ENDPOINT_LATENCIES: [Duration; 10] = [
+ Duration::from_millis(1),
+ Duration::from_millis(5),
+ Duration::from_millis(10),
+ Duration::from_millis(10),
+ Duration::from_millis(10),
+ Duration::from_millis(100),
+ Duration::from_millis(100),
+ Duration::from_millis(100),
+ Duration::from_millis(500),
+ Duration::from_millis(1000),
+];
+
+struct Summary {
+ latencies: Histogram<u64>,
+ start: Instant,
+ count_by_instance: [usize; 10],
+}
+
+#[tokio::main]
+async fn main() {
+ tracing::subscriber::set_global_default(tracing_subscriber::FmtSubscriber::default()).unwrap();
+
+ println!("REQUESTS={}", REQUESTS);
+ println!("CONCURRENCY={}", CONCURRENCY);
+ println!("ENDPOINT_CAPACITY={}", ENDPOINT_CAPACITY);
+ print!("MAX_ENDPOINT_LATENCIES=[");
+ for max in &MAX_ENDPOINT_LATENCIES {
+ let l = max.as_secs() * 1_000 + u64::from(max.subsec_millis());
+ print!("{}ms, ", l);
+ }
+ println!("]");
+
+ let decay = Duration::from_secs(10);
+ let d = gen_disco();
+ let pe = lb::p2c::Balance::new(load::PeakEwmaDiscover::new(
+ d,
+ DEFAULT_RTT,
+ decay,
+ load::CompleteOnResponse::default(),
+ ));
+ run("P2C+PeakEWMA...", pe).await;
+
+ let d = gen_disco();
+ let ll = lb::p2c::Balance::new(load::PendingRequestsDiscover::new(
+ d,
+ load::CompleteOnResponse::default(),
+ ));
+ run("P2C+LeastLoaded...", ll).await;
+}
+
+type Error = Box<dyn std::error::Error + Send + Sync>;
+
+type Key = usize;
+
+pin_project! {
+ struct Disco<S> {
+ services: Vec<(Key, S)>
+ }
+}
+
+impl<S> Disco<S> {
+ fn new(services: Vec<(Key, S)>) -> Self {
+ Self { services }
+ }
+}
+
+impl<S> Stream for Disco<S>
+where
+ S: Service<Req, Response = Rsp, Error = Error>,
+{
+ type Item = Result<Change<Key, S>, Error>;
+
+ fn poll_next(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ match self.project().services.pop() {
+ Some((k, service)) => Poll::Ready(Some(Ok(Change::Insert(k, service)))),
+ None => {
+ // there may be more later
+ Poll::Pending
+ }
+ }
+ }
+}
+
+fn gen_disco() -> impl Discover<
+ Key = Key,
+ Error = Error,
+ Service = ConcurrencyLimit<
+ impl Service<Req, Response = Rsp, Error = Error, Future = impl Send> + Send,
+ >,
+> + Send {
+ Disco::new(
+ MAX_ENDPOINT_LATENCIES
+ .iter()
+ .enumerate()
+ .map(|(instance, latency)| {
+ let svc = tower::service_fn(move |_| {
+ let start = Instant::now();
+
+ let maxms = u64::from(latency.subsec_millis())
+ .saturating_add(latency.as_secs().saturating_mul(1_000));
+ let latency = Duration::from_millis(rand::thread_rng().gen_range(0..maxms));
+
+ async move {
+ time::sleep_until(start + latency).await;
+ let latency = start.elapsed();
+ Ok(Rsp { latency, instance })
+ }
+ });
+
+ (instance, ConcurrencyLimit::new(svc, ENDPOINT_CAPACITY))
+ })
+ .collect(),
+ )
+}
+
+async fn run<D>(name: &'static str, lb: lb::p2c::Balance<D, Req>)
+where
+ D: Discover + Unpin + Send + 'static,
+ D::Error: Into<Error>,
+ D::Key: Clone + Send + Hash,
+ D::Service: Service<Req, Response = Rsp> + load::Load + Send,
+ <D::Service as Service<Req>>::Error: Into<Error>,
+ <D::Service as Service<Req>>::Future: Send,
+ <D::Service as load::Load>::Metric: std::fmt::Debug,
+{
+ println!("{}", name);
+
+ let requests = stream::repeat(Req).take(REQUESTS);
+ let service = ConcurrencyLimit::new(lb, CONCURRENCY);
+ let responses = service.call_all(requests).unordered();
+
+ compute_histo(responses).await.unwrap().report();
+}
+
+async fn compute_histo<S>(mut times: S) -> Result<Summary, Error>
+where
+ S: TryStream<Ok = Rsp, Error = Error> + 'static + Unpin,
+{
+ let mut summary = Summary::new();
+ while let Some(rsp) = times.try_next().await? {
+ summary.count(rsp);
+ }
+ Ok(summary)
+}
+
+impl Summary {
+ fn new() -> Self {
+ Self {
+ // The max delay is 2000ms. At 3 significant figures.
+ latencies: Histogram::<u64>::new_with_max(3_000, 3).unwrap(),
+ start: Instant::now(),
+ count_by_instance: [0; 10],
+ }
+ }
+
+ fn count(&mut self, rsp: Rsp) {
+ let ms = rsp.latency.as_secs() * 1_000;
+ let ms = ms + u64::from(rsp.latency.subsec_nanos()) / 1_000 / 1_000;
+ self.latencies += ms;
+ self.count_by_instance[rsp.instance] += 1;
+ }
+
+ fn report(&self) {
+ let mut total = 0;
+ for c in &self.count_by_instance {
+ total += c;
+ }
+ for (i, c) in self.count_by_instance.iter().enumerate() {
+ let p = *c as f64 / total as f64 * 100.0;
+ println!(" [{:02}] {:>5.01}%", i, p);
+ }
+
+ println!(" wall {:4}s", self.start.elapsed().as_secs());
+
+ if self.latencies.len() < 2 {
+ return;
+ }
+ println!(" p50 {:4}ms", self.latencies.value_at_quantile(0.5));
+
+ if self.latencies.len() < 10 {
+ return;
+ }
+ println!(" p90 {:4}ms", self.latencies.value_at_quantile(0.9));
+
+ if self.latencies.len() < 50 {
+ return;
+ }
+ println!(" p95 {:4}ms", self.latencies.value_at_quantile(0.95));
+
+ if self.latencies.len() < 100 {
+ return;
+ }
+ println!(" p99 {:4}ms", self.latencies.value_at_quantile(0.99));
+
+ if self.latencies.len() < 1000 {
+ return;
+ }
+ println!(" p999 {:4}ms", self.latencies.value_at_quantile(0.999));
+ }
+}
+
+#[derive(Debug, Clone)]
+struct Req;
+
+#[derive(Debug)]
+struct Rsp {
+ latency: Duration,
+ instance: usize,
+}
diff --git a/crates/tower/src/balance/error.rs b/crates/tower/src/balance/error.rs
new file mode 100644
index 0000000..4d47630
--- /dev/null
+++ b/crates/tower/src/balance/error.rs
@@ -0,0 +1,21 @@
+//! Error types for the [`tower::balance`] middleware.
+//!
+//! [`tower::balance`]: crate::balance
+
+use std::fmt;
+
+/// The balancer's endpoint discovery stream failed.
+#[derive(Debug)]
+pub struct Discover(pub(crate) crate::BoxError);
+
+impl fmt::Display for Discover {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "load balancer discovery error: {}", self.0)
+ }
+}
+
+impl std::error::Error for Discover {
+ fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+ Some(&*self.0)
+ }
+}
diff --git a/crates/tower/src/balance/mod.rs b/crates/tower/src/balance/mod.rs
new file mode 100644
index 0000000..4e27f4a
--- /dev/null
+++ b/crates/tower/src/balance/mod.rs
@@ -0,0 +1,61 @@
+//! Middleware that allows balancing load among multiple services.
+//!
+//! In larger systems, multiple endpoints are often available for a given service. As load
+//! increases, you want to ensure that that load is spread evenly across the available services.
+//! Otherwise, clients could see spikes in latency if their request goes to a particularly loaded
+//! service, even when spare capacity is available to handle that request elsewhere.
+//!
+//! This module provides two pieces of middleware that helps with this type of load balancing:
+//!
+//! First, [`p2c`] implements the "[Power of Two Random Choices]" algorithm, a simple but robust
+//! technique for spreading load across services with only inexact load measurements. Use this if
+//! the set of available services is not within your control, and you simply want to spread load
+//! among that set of services.
+//!
+//! [Power of Two Random Choices]: http://www.eecs.harvard.edu/~michaelm/postscripts/handbook2001.pdf
+//!
+//! Second, [`pool`] implements a dynamically sized pool of services. It estimates the overall
+//! current load by tracking successful and unsuccessful calls to [`poll_ready`], and uses an
+//! exponentially weighted moving average to add (using [`MakeService`]) or remove (by dropping)
+//! services in response to increases or decreases in load. Use this if you are able to
+//! dynamically add more service endpoints to the system to handle added load.
+//!
+//! # Examples
+//!
+//! ```rust
+//! # #[cfg(feature = "util")]
+//! # #[cfg(feature = "load")]
+//! # fn warnings_are_errors() {
+//! use tower::balance::p2c::Balance;
+//! use tower::load::Load;
+//! use tower::{Service, ServiceExt};
+//! use futures_util::pin_mut;
+//! # use futures_core::Stream;
+//! # use futures_util::StreamExt;
+//!
+//! async fn spread<Req, S: Service<Req> + Load>(svc1: S, svc2: S, reqs: impl Stream<Item = Req>)
+//! where
+//! S::Error: Into<tower::BoxError>,
+//! # // this bound is pretty unfortunate, and the compiler does _not_ help
+//! S::Metric: std::fmt::Debug,
+//! {
+//! // Spread load evenly across the two services
+//! let p2c = Balance::new(tower::discover::ServiceList::new(vec![svc1, svc2]));
+//!
+//! // Issue all the requests that come in.
+//! // Some will go to svc1, some will go to svc2.
+//! pin_mut!(reqs);
+//! let mut responses = p2c.call_all(reqs);
+//! while let Some(rsp) = responses.next().await {
+//! // ...
+//! }
+//! }
+//! # }
+//! ```
+//!
+//! [`MakeService`]: crate::MakeService
+//! [`poll_ready`]: crate::Service::poll_ready
+
+pub mod error;
+pub mod p2c;
+pub mod pool;
diff --git a/crates/tower/src/balance/p2c/layer.rs b/crates/tower/src/balance/p2c/layer.rs
new file mode 100644
index 0000000..ce59c6e
--- /dev/null
+++ b/crates/tower/src/balance/p2c/layer.rs
@@ -0,0 +1,60 @@
+use super::MakeBalance;
+use std::{fmt, marker::PhantomData};
+use tower_layer::Layer;
+
+/// Construct load balancers ([`Balance`]) over dynamic service sets ([`Discover`]) produced by the
+/// "inner" service in response to requests coming from the "outer" service.
+///
+/// This construction may seem a little odd at first glance. This is not a layer that takes
+/// requests and produces responses in the traditional sense. Instead, it is more like
+/// [`MakeService`] in that it takes service _descriptors_ (see `Target` on [`MakeService`])
+/// and produces _services_. Since [`Balance`] spreads requests across a _set_ of services,
+/// the inner service should produce a [`Discover`], not just a single
+/// [`Service`], given a service descriptor.
+///
+/// See the [module-level documentation](crate::balance) for details on load balancing.
+///
+/// [`Balance`]: crate::balance::p2c::Balance
+/// [`Discover`]: crate::discover::Discover
+/// [`MakeService`]: crate::MakeService
+/// [`Service`]: crate::Service
+pub struct MakeBalanceLayer<D, Req> {
+ _marker: PhantomData<fn(D, Req)>,
+}
+
+impl<D, Req> MakeBalanceLayer<D, Req> {
+ /// Build balancers using operating system entropy.
+ pub fn new() -> Self {
+ Self {
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<D, Req> Default for MakeBalanceLayer<D, Req> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<D, Req> Clone for MakeBalanceLayer<D, Req> {
+ fn clone(&self) -> Self {
+ Self {
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<S, Req> Layer<S> for MakeBalanceLayer<S, Req> {
+ type Service = MakeBalance<S, Req>;
+
+ fn layer(&self, make_discover: S) -> Self::Service {
+ MakeBalance::new(make_discover)
+ }
+}
+
+impl<D, Req> fmt::Debug for MakeBalanceLayer<D, Req> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_struct("MakeBalanceLayer").finish()
+ }
+}
diff --git a/crates/tower/src/balance/p2c/make.rs b/crates/tower/src/balance/p2c/make.rs
new file mode 100644
index 0000000..538d703
--- /dev/null
+++ b/crates/tower/src/balance/p2c/make.rs
@@ -0,0 +1,125 @@
+use super::Balance;
+use crate::discover::Discover;
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::hash::Hash;
+use std::marker::PhantomData;
+use std::{
+ fmt,
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+/// Constructs load balancers over dynamic service sets produced by a wrapped "inner" service.
+///
+/// This is effectively an implementation of [`MakeService`] except that it forwards the service
+/// descriptors (`Target`) to an inner service (`S`), and expects that service to produce a
+/// service set in the form of a [`Discover`]. It then wraps the service set in a [`Balance`]
+/// before returning it as the "made" service.
+///
+/// See the [module-level documentation](crate::balance) for details on load balancing.
+///
+/// [`MakeService`]: crate::MakeService
+/// [`Discover`]: crate::discover::Discover
+/// [`Balance`]: crate::balance::p2c::Balance
+pub struct MakeBalance<S, Req> {
+ inner: S,
+ _marker: PhantomData<fn(Req)>,
+}
+
+pin_project! {
+ /// A [`Balance`] in the making.
+ ///
+ /// [`Balance`]: crate::balance::p2c::Balance
+ pub struct MakeFuture<F, Req> {
+ #[pin]
+ inner: F,
+ _marker: PhantomData<fn(Req)>,
+ }
+}
+
+impl<S, Req> MakeBalance<S, Req> {
+ /// Build balancers using operating system entropy.
+ pub fn new(make_discover: S) -> Self {
+ Self {
+ inner: make_discover,
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<S, Req> Clone for MakeBalance<S, Req>
+where
+ S: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ inner: self.inner.clone(),
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<S, Target, Req> Service<Target> for MakeBalance<S, Req>
+where
+ S: Service<Target>,
+ S::Response: Discover,
+ <S::Response as Discover>::Key: Hash,
+ <S::Response as Discover>::Service: Service<Req>,
+ <<S::Response as Discover>::Service as Service<Req>>::Error: Into<crate::BoxError>,
+{
+ type Response = Balance<S::Response, Req>;
+ type Error = S::Error;
+ type Future = MakeFuture<S::Future, Req>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, target: Target) -> Self::Future {
+ MakeFuture {
+ inner: self.inner.call(target),
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<S, Req> fmt::Debug for MakeBalance<S, Req>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self { inner, _marker } = self;
+ f.debug_struct("MakeBalance").field("inner", inner).finish()
+ }
+}
+
+impl<F, T, E, Req> Future for MakeFuture<F, Req>
+where
+ F: Future<Output = Result<T, E>>,
+ T: Discover,
+ <T as Discover>::Key: Hash,
+ <T as Discover>::Service: Service<Req>,
+ <<T as Discover>::Service as Service<Req>>::Error: Into<crate::BoxError>,
+{
+ type Output = Result<Balance<T, Req>, E>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+ let inner = ready!(this.inner.poll(cx))?;
+ let svc = Balance::new(inner);
+ Poll::Ready(Ok(svc))
+ }
+}
+
+impl<F, Req> fmt::Debug for MakeFuture<F, Req>
+where
+ F: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self { inner, _marker } = self;
+ f.debug_struct("MakeFuture").field("inner", inner).finish()
+ }
+}
diff --git a/crates/tower/src/balance/p2c/mod.rs b/crates/tower/src/balance/p2c/mod.rs
new file mode 100644
index 0000000..0d4203c
--- /dev/null
+++ b/crates/tower/src/balance/p2c/mod.rs
@@ -0,0 +1,41 @@
+//! This module implements the "[Power of Two Random Choices]" load balancing algorithm.
+//!
+//! It is a simple but robust technique for spreading load across services with only inexact load
+//! measurements. As its name implies, whenever a request comes in, it samples two ready services
+//! at random, and issues the request to whichever service is less loaded. How loaded a service is
+//! is determined by the return value of [`Load`](crate::load::Load).
+//!
+//! As described in the [Finagle Guide][finagle]:
+//!
+//! > The algorithm randomly picks two services from the set of ready endpoints and
+//! > selects the least loaded of the two. By repeatedly using this strategy, we can
+//! > expect a manageable upper bound on the maximum load of any server.
+//! >
+//! > The maximum load variance between any two servers is bound by `ln(ln(n))` where
+//! > `n` is the number of servers in the cluster.
+//!
+//! The balance service and layer implementations rely on _service discovery_ to provide the
+//! underlying set of services to balance requests across. This happens through the
+//! [`Discover`](crate::discover::Discover) trait, which is essentially a [`Stream`] that indicates
+//! when services become available or go away. If you have a fixed set of services, consider using
+//! [`ServiceList`](crate::discover::ServiceList).
+//!
+//! Since the load balancer needs to perform _random_ choices, the constructors in this module
+//! usually come in two forms: one that uses randomness provided by the operating system, and one
+//! that lets you specify the random seed to use. Usually the former is what you'll want, though
+//! the latter may come in handy for reproducability or to reduce reliance on the operating system.
+//!
+//! [Power of Two Random Choices]: http://www.eecs.harvard.edu/~michaelm/postscripts/handbook2001.pdf
+//! [finagle]: https://twitter.github.io/finagle/guide/Clients.html#power-of-two-choices-p2c-least-loaded
+//! [`Stream`]: https://docs.rs/futures/0.3/futures/stream/trait.Stream.html
+
+mod layer;
+mod make;
+mod service;
+
+#[cfg(test)]
+mod test;
+
+pub use layer::MakeBalanceLayer;
+pub use make::{MakeBalance, MakeFuture};
+pub use service::Balance;
diff --git a/crates/tower/src/balance/p2c/service.rs b/crates/tower/src/balance/p2c/service.rs
new file mode 100644
index 0000000..f85d241
--- /dev/null
+++ b/crates/tower/src/balance/p2c/service.rs
@@ -0,0 +1,335 @@
+use super::super::error;
+use crate::discover::{Change, Discover};
+use crate::load::Load;
+use crate::ready_cache::{error::Failed, ReadyCache};
+use futures_core::ready;
+use futures_util::future::{self, TryFutureExt};
+use pin_project_lite::pin_project;
+use rand::{rngs::SmallRng, Rng, SeedableRng};
+use std::hash::Hash;
+use std::marker::PhantomData;
+use std::{
+ fmt,
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::sync::oneshot;
+use tower_service::Service;
+use tracing::{debug, trace};
+
+/// Efficiently distributes requests across an arbitrary number of services.
+///
+/// See the [module-level documentation](..) for details.
+///
+/// Note that [`Balance`] requires that the [`Discover`] you use is [`Unpin`] in order to implement
+/// [`Service`]. This is because it needs to be accessed from [`Service::poll_ready`], which takes
+/// `&mut self`. You can achieve this easily by wrapping your [`Discover`] in [`Box::pin`] before you
+/// construct the [`Balance`] instance. For more details, see [#319].
+///
+/// [`Box::pin`]: std::boxed::Box::pin()
+/// [#319]: https://github.com/tower-rs/tower/issues/319
+pub struct Balance<D, Req>
+where
+ D: Discover,
+ D::Key: Hash,
+{
+ discover: D,
+
+ services: ReadyCache<D::Key, D::Service, Req>,
+ ready_index: Option<usize>,
+
+ rng: SmallRng,
+
+ _req: PhantomData<Req>,
+}
+
+impl<D: Discover, Req> fmt::Debug for Balance<D, Req>
+where
+ D: fmt::Debug,
+ D::Key: Hash + fmt::Debug,
+ D::Service: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Balance")
+ .field("discover", &self.discover)
+ .field("services", &self.services)
+ .finish()
+ }
+}
+
+pin_project! {
+ /// A Future that becomes satisfied when an `S`-typed service is ready.
+ ///
+ /// May fail due to cancelation, i.e., if [`Discover`] removes the service from the service set.
+ struct UnreadyService<K, S, Req> {
+ key: Option<K>,
+ #[pin]
+ cancel: oneshot::Receiver<()>,
+ service: Option<S>,
+
+ _req: PhantomData<Req>,
+ }
+}
+
+enum Error<E> {
+ Inner(E),
+ Canceled,
+}
+
+impl<D, Req> Balance<D, Req>
+where
+ D: Discover,
+ D::Key: Hash,
+ D::Service: Service<Req>,
+ <D::Service as Service<Req>>::Error: Into<crate::BoxError>,
+{
+ /// Constructs a load balancer that uses operating system entropy.
+ pub fn new(discover: D) -> Self {
+ Self::from_rng(discover, &mut rand::thread_rng()).expect("ThreadRNG must be valid")
+ }
+
+ /// Constructs a load balancer seeded with the provided random number generator.
+ pub fn from_rng<R: Rng>(discover: D, rng: R) -> Result<Self, rand::Error> {
+ let rng = SmallRng::from_rng(rng)?;
+ Ok(Self {
+ rng,
+ discover,
+ services: ReadyCache::default(),
+ ready_index: None,
+
+ _req: PhantomData,
+ })
+ }
+
+ /// Returns the number of endpoints currently tracked by the balancer.
+ pub fn len(&self) -> usize {
+ self.services.len()
+ }
+
+ /// Returns whether or not the balancer is empty.
+ pub fn is_empty(&self) -> bool {
+ self.services.is_empty()
+ }
+}
+
+impl<D, Req> Balance<D, Req>
+where
+ D: Discover + Unpin,
+ D::Key: Hash + Clone,
+ D::Error: Into<crate::BoxError>,
+ D::Service: Service<Req> + Load,
+ <D::Service as Load>::Metric: std::fmt::Debug,
+ <D::Service as Service<Req>>::Error: Into<crate::BoxError>,
+{
+ /// Polls `discover` for updates, adding new items to `not_ready`.
+ ///
+ /// Removals may alter the order of either `ready` or `not_ready`.
+ fn update_pending_from_discover(
+ &mut self,
+ cx: &mut Context<'_>,
+ ) -> Poll<Option<Result<(), error::Discover>>> {
+ debug!("updating from discover");
+ loop {
+ match ready!(Pin::new(&mut self.discover).poll_discover(cx))
+ .transpose()
+ .map_err(|e| error::Discover(e.into()))?
+ {
+ None => return Poll::Ready(None),
+ Some(Change::Remove(key)) => {
+ trace!("remove");
+ self.services.evict(&key);
+ }
+ Some(Change::Insert(key, svc)) => {
+ trace!("insert");
+ // If this service already existed in the set, it will be
+ // replaced as the new one becomes ready.
+ self.services.push(key, svc);
+ }
+ }
+ }
+ }
+
+ fn promote_pending_to_ready(&mut self, cx: &mut Context<'_>) {
+ loop {
+ match self.services.poll_pending(cx) {
+ Poll::Ready(Ok(())) => {
+ // There are no remaining pending services.
+ debug_assert_eq!(self.services.pending_len(), 0);
+ break;
+ }
+ Poll::Pending => {
+ // None of the pending services are ready.
+ debug_assert!(self.services.pending_len() > 0);
+ break;
+ }
+ Poll::Ready(Err(error)) => {
+ // An individual service was lost; continue processing
+ // pending services.
+ debug!(%error, "dropping failed endpoint");
+ }
+ }
+ }
+ trace!(
+ ready = %self.services.ready_len(),
+ pending = %self.services.pending_len(),
+ "poll_unready"
+ );
+ }
+
+ /// Performs P2C on inner services to find a suitable endpoint.
+ fn p2c_ready_index(&mut self) -> Option<usize> {
+ match self.services.ready_len() {
+ 0 => None,
+ 1 => Some(0),
+ len => {
+ // Get two distinct random indexes (in a random order) and
+ // compare the loads of the service at each index.
+ let idxs = rand::seq::index::sample(&mut self.rng, len, 2);
+
+ let aidx = idxs.index(0);
+ let bidx = idxs.index(1);
+ debug_assert_ne!(aidx, bidx, "random indices must be distinct");
+
+ let aload = self.ready_index_load(aidx);
+ let bload = self.ready_index_load(bidx);
+ let chosen = if aload <= bload { aidx } else { bidx };
+
+ trace!(
+ a.index = aidx,
+ a.load = ?aload,
+ b.index = bidx,
+ b.load = ?bload,
+ chosen = if chosen == aidx { "a" } else { "b" },
+ "p2c",
+ );
+ Some(chosen)
+ }
+ }
+ }
+
+ /// Accesses a ready endpoint by index and returns its current load.
+ fn ready_index_load(&self, index: usize) -> <D::Service as Load>::Metric {
+ let (_, svc) = self.services.get_ready_index(index).expect("invalid index");
+ svc.load()
+ }
+
+ pub(crate) fn discover_mut(&mut self) -> &mut D {
+ &mut self.discover
+ }
+}
+
+impl<D, Req> Service<Req> for Balance<D, Req>
+where
+ D: Discover + Unpin,
+ D::Key: Hash + Clone,
+ D::Error: Into<crate::BoxError>,
+ D::Service: Service<Req> + Load,
+ <D::Service as Load>::Metric: std::fmt::Debug,
+ <D::Service as Service<Req>>::Error: Into<crate::BoxError>,
+{
+ type Response = <D::Service as Service<Req>>::Response;
+ type Error = crate::BoxError;
+ type Future = future::MapErr<
+ <D::Service as Service<Req>>::Future,
+ fn(<D::Service as Service<Req>>::Error) -> crate::BoxError,
+ >;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // `ready_index` may have already been set by a prior invocation. These
+ // updates cannot disturb the order of existing ready services.
+ let _ = self.update_pending_from_discover(cx)?;
+ self.promote_pending_to_ready(cx);
+
+ loop {
+ // If a service has already been selected, ensure that it is ready.
+ // This ensures that the underlying service is ready immediately
+ // before a request is dispatched to it (i.e. in the same task
+ // invocation). If, e.g., a failure detector has changed the state
+ // of the service, it may be evicted from the ready set so that
+ // another service can be selected.
+ if let Some(index) = self.ready_index.take() {
+ match self.services.check_ready_index(cx, index) {
+ Ok(true) => {
+ // The service remains ready.
+ self.ready_index = Some(index);
+ return Poll::Ready(Ok(()));
+ }
+ Ok(false) => {
+ // The service is no longer ready. Try to find a new one.
+ trace!("ready service became unavailable");
+ }
+ Err(Failed(_, error)) => {
+ // The ready endpoint failed, so log the error and try
+ // to find a new one.
+ debug!(%error, "endpoint failed");
+ }
+ }
+ }
+
+ // Select a new service by comparing two at random and using the
+ // lesser-loaded service.
+ self.ready_index = self.p2c_ready_index();
+ if self.ready_index.is_none() {
+ debug_assert_eq!(self.services.ready_len(), 0);
+ // We have previously registered interest in updates from
+ // discover and pending services.
+ return Poll::Pending;
+ }
+ }
+ }
+
+ fn call(&mut self, request: Req) -> Self::Future {
+ let index = self.ready_index.take().expect("called before ready");
+ self.services
+ .call_ready_index(index, request)
+ .map_err(Into::into)
+ }
+}
+
+impl<K, S: Service<Req>, Req> Future for UnreadyService<K, S, Req> {
+ type Output = Result<(K, S), (K, Error<S::Error>)>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+
+ if let Poll::Ready(Ok(())) = this.cancel.poll(cx) {
+ let key = this.key.take().expect("polled after ready");
+ return Poll::Ready(Err((key, Error::Canceled)));
+ }
+
+ let res = ready!(this
+ .service
+ .as_mut()
+ .expect("poll after ready")
+ .poll_ready(cx));
+
+ let key = this.key.take().expect("polled after ready");
+ let svc = this.service.take().expect("polled after ready");
+
+ match res {
+ Ok(()) => Poll::Ready(Ok((key, svc))),
+ Err(e) => Poll::Ready(Err((key, Error::Inner(e)))),
+ }
+ }
+}
+
+impl<K, S, Req> fmt::Debug for UnreadyService<K, S, Req>
+where
+ K: fmt::Debug,
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self {
+ key,
+ cancel,
+ service,
+ _req,
+ } = self;
+ f.debug_struct("UnreadyService")
+ .field("key", key)
+ .field("cancel", cancel)
+ .field("service", service)
+ .finish()
+ }
+}
diff --git a/crates/tower/src/balance/p2c/test.rs b/crates/tower/src/balance/p2c/test.rs
new file mode 100644
index 0000000..2370860
--- /dev/null
+++ b/crates/tower/src/balance/p2c/test.rs
@@ -0,0 +1,125 @@
+use crate::discover::ServiceList;
+use crate::load;
+use futures_util::pin_mut;
+use std::task::Poll;
+use tokio_test::{assert_pending, assert_ready, assert_ready_ok, task};
+use tower_test::{assert_request_eq, mock};
+
+use super::*;
+
+#[tokio::test]
+async fn empty() {
+ let empty: Vec<load::Constant<mock::Mock<(), &'static str>, usize>> = vec![];
+ let disco = ServiceList::new(empty);
+ let mut svc = mock::Spawn::new(Balance::new(disco));
+ assert_pending!(svc.poll_ready());
+}
+
+#[tokio::test]
+async fn single_endpoint() {
+ let (mut svc, mut handle) = mock::spawn_with(|s| {
+ let mock = load::Constant::new(s, 0);
+ let disco = ServiceList::new(vec![mock].into_iter());
+ Balance::new(disco)
+ });
+
+ handle.allow(0);
+ assert_pending!(svc.poll_ready());
+ assert_eq!(
+ svc.get_ref().len(),
+ 1,
+ "balancer must have discovered endpoint"
+ );
+
+ handle.allow(1);
+ assert_ready_ok!(svc.poll_ready());
+
+ let mut fut = task::spawn(svc.call(()));
+
+ assert_request_eq!(handle, ()).send_response(1);
+
+ assert_eq!(assert_ready_ok!(fut.poll()), 1);
+ handle.allow(1);
+ assert_ready_ok!(svc.poll_ready());
+
+ handle.send_error("endpoint lost");
+ assert_pending!(svc.poll_ready());
+ assert!(
+ svc.get_ref().is_empty(),
+ "balancer must drop failed endpoints"
+ );
+}
+
+#[tokio::test]
+async fn two_endpoints_with_equal_load() {
+ let (mock_a, handle_a) = mock::pair();
+ let (mock_b, handle_b) = mock::pair();
+ let mock_a = load::Constant::new(mock_a, 1);
+ let mock_b = load::Constant::new(mock_b, 1);
+
+ pin_mut!(handle_a);
+ pin_mut!(handle_b);
+
+ let disco = ServiceList::new(vec![mock_a, mock_b].into_iter());
+ let mut svc = mock::Spawn::new(Balance::new(disco));
+
+ handle_a.allow(0);
+ handle_b.allow(0);
+ assert_pending!(svc.poll_ready());
+ assert_eq!(
+ svc.get_ref().len(),
+ 2,
+ "balancer must have discovered both endpoints"
+ );
+
+ handle_a.allow(1);
+ handle_b.allow(0);
+ assert_ready_ok!(
+ svc.poll_ready(),
+ "must be ready when one of two services is ready"
+ );
+ {
+ let mut fut = task::spawn(svc.call(()));
+ assert_request_eq!(handle_a, ()).send_response("a");
+ assert_eq!(assert_ready_ok!(fut.poll()), "a");
+ }
+
+ handle_a.allow(0);
+ handle_b.allow(1);
+ assert_ready_ok!(
+ svc.poll_ready(),
+ "must be ready when both endpoints are ready"
+ );
+ {
+ let mut fut = task::spawn(svc.call(()));
+ assert_request_eq!(handle_b, ()).send_response("b");
+ assert_eq!(assert_ready_ok!(fut.poll()), "b");
+ }
+
+ handle_a.allow(1);
+ handle_b.allow(1);
+ for _ in 0..2 {
+ assert_ready_ok!(
+ svc.poll_ready(),
+ "must be ready when both endpoints are ready"
+ );
+ let mut fut = task::spawn(svc.call(()));
+
+ for (ref mut h, c) in &mut [(&mut handle_a, "a"), (&mut handle_b, "b")] {
+ if let Poll::Ready(Some((_, tx))) = h.as_mut().poll_request() {
+ tracing::info!("using {}", c);
+ tx.send_response(c);
+ h.allow(0);
+ }
+ }
+ assert_ready_ok!(fut.poll());
+ }
+
+ handle_a.send_error("endpoint lost");
+ assert_pending!(svc.poll_ready());
+ assert_eq!(
+ svc.get_ref().len(),
+ 1,
+ "balancer must drop failed endpoints",
+ );
+}
diff --git a/crates/tower/src/balance/pool/mod.rs b/crates/tower/src/balance/pool/mod.rs
new file mode 100644
index 0000000..ab43936
--- /dev/null
+++ b/crates/tower/src/balance/pool/mod.rs
@@ -0,0 +1,459 @@
+//! This module defines a load-balanced pool of services that adds new services when load is high.
+//!
+//! The pool uses `poll_ready` as a signal indicating whether additional services should be spawned
+//! to handle the current level of load. Specifically, every time `poll_ready` on the inner service
+//! returns `Ready`, [`Pool`] consider that a 0, and every time it returns `Pending`, [`Pool`]
+//! considers it a 1. [`Pool`] then maintains an [exponential moving
+//! average](https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average) over those
+//! samples, which gives an estimate of how often the underlying service has been ready when it was
+//! needed "recently" (see [`Builder::urgency`]). If the service is loaded (see
+//! [`Builder::loaded_above`]), a new service is created and added to the underlying [`Balance`].
+//! If the service is underutilized (see [`Builder::underutilized_below`]) and there are two or
+//! more services, then the latest added service is removed. In either case, the load estimate is
+//! reset to its initial value (see [`Builder::initial`] to prevent services from being rapidly
+//! added or removed.
+#![deny(missing_docs)]
+
+use super::p2c::Balance;
+use crate::discover::Change;
+use crate::load::Load;
+use crate::make::MakeService;
+use futures_core::{ready, Stream};
+use pin_project_lite::pin_project;
+use slab::Slab;
+use std::{
+ fmt,
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+#[cfg(test)]
+mod test;
+
+#[derive(Debug, Clone, Copy, Eq, PartialEq)]
+enum Level {
+ /// Load is low -- remove a service instance.
+ Low,
+ /// Load is normal -- keep the service set as it is.
+ Normal,
+ /// Load is high -- add another service instance.
+ High,
+}
+
+pin_project! {
+ /// A wrapper around `MakeService` that discovers a new service when load is high, and removes a
+ /// service when load is low. See [`Pool`].
+ pub struct PoolDiscoverer<MS, Target, Request>
+ where
+ MS: MakeService<Target, Request>,
+ {
+ maker: MS,
+ #[pin]
+ making: Option<MS::Future>,
+ target: Target,
+ load: Level,
+ services: Slab<()>,
+ died_tx: tokio::sync::mpsc::UnboundedSender<usize>,
+ #[pin]
+ died_rx: tokio::sync::mpsc::UnboundedReceiver<usize>,
+ limit: Option<usize>,
+ }
+}
+
+impl<MS, Target, Request> fmt::Debug for PoolDiscoverer<MS, Target, Request>
+where
+ MS: MakeService<Target, Request> + fmt::Debug,
+ Target: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("PoolDiscoverer")
+ .field("maker", &self.maker)
+ .field("making", &self.making.is_some())
+ .field("target", &self.target)
+ .field("load", &self.load)
+ .field("services", &self.services)
+ .field("limit", &self.limit)
+ .finish()
+ }
+}
+
+impl<MS, Target, Request> Stream for PoolDiscoverer<MS, Target, Request>
+where
+ MS: MakeService<Target, Request>,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone,
+{
+ type Item = Result<Change<usize, DropNotifyService<MS::Service>>, MS::MakeError>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ let mut this = self.project();
+
+ while let Poll::Ready(Some(sid)) = this.died_rx.as_mut().poll_recv(cx) {
+ this.services.remove(sid);
+ tracing::trace!(
+ pool.services = this.services.len(),
+ message = "removing dropped service"
+ );
+ }
+
+ if this.services.is_empty() && this.making.is_none() {
+ let _ = ready!(this.maker.poll_ready(cx))?;
+ tracing::trace!("construct initial pool connection");
+ this.making
+ .set(Some(this.maker.make_service(this.target.clone())));
+ }
+
+ if let Level::High = this.load {
+ if this.making.is_none() {
+ if this
+ .limit
+ .map(|limit| this.services.len() >= limit)
+ .unwrap_or(false)
+ {
+ return Poll::Pending;
+ }
+
+ tracing::trace!(
+ pool.services = this.services.len(),
+ message = "decided to add service to loaded pool"
+ );
+ ready!(this.maker.poll_ready(cx))?;
+ tracing::trace!("making new service");
+ // TODO: it'd be great if we could avoid the clone here and use, say, &Target
+ this.making
+ .set(Some(this.maker.make_service(this.target.clone())));
+ }
+ }
+
+ if let Some(fut) = this.making.as_mut().as_pin_mut() {
+ let svc = ready!(fut.poll(cx))?;
+ this.making.set(None);
+
+ let id = this.services.insert(());
+ let svc = DropNotifyService {
+ svc,
+ id,
+ notify: this.died_tx.clone(),
+ };
+ tracing::trace!(
+ pool.services = this.services.len(),
+ message = "finished creating new service"
+ );
+ *this.load = Level::Normal;
+ return Poll::Ready(Some(Ok(Change::Insert(id, svc))));
+ }
+
+ match this.load {
+ Level::High => {
+ unreachable!("found high load but no Service being made");
+ }
+ Level::Normal => Poll::Pending,
+ Level::Low if this.services.len() == 1 => Poll::Pending,
+ Level::Low => {
+ *this.load = Level::Normal;
+ // NOTE: this is a little sad -- we'd prefer to kill short-living services
+ let rm = this.services.iter().next().unwrap().0;
+ // note that we _don't_ remove from self.services here
+ // that'll happen automatically on drop
+ tracing::trace!(
+ pool.services = this.services.len(),
+ message = "removing service for over-provisioned pool"
+ );
+ Poll::Ready(Some(Ok(Change::Remove(rm))))
+ }
+ }
+ }
+}
+
+/// A [builder] that lets you configure how a [`Pool`] determines whether the underlying service is
+/// loaded or not. See the [module-level documentation](self) and the builder's methods for
+/// details.
+///
+/// [builder]: https://rust-lang-nursery.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
+#[derive(Copy, Clone, Debug)]
+pub struct Builder {
+ low: f64,
+ high: f64,
+ init: f64,
+ alpha: f64,
+ limit: Option<usize>,
+}
+
+impl Default for Builder {
+ fn default() -> Self {
+ Builder {
+ init: 0.1,
+ low: 0.00001,
+ high: 0.2,
+ alpha: 0.03,
+ limit: None,
+ }
+ }
+}
+
+impl Builder {
+ /// Create a new builder with default values for all load settings.
+ ///
+ /// If you just want to use the defaults, you can just use [`Pool::new`].
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ /// When the estimated load (see the [module-level docs](self)) drops below this
+ /// threshold, and there are at least two services active, a service is removed.
+ ///
+ /// The default value is 0.01. That is, when one in every 100 `poll_ready` calls return
+ /// `Pending`, then the underlying service is considered underutilized.
+ pub fn underutilized_below(&mut self, low: f64) -> &mut Self {
+ self.low = low;
+ self
+ }
+
+ /// When the estimated load (see the [module-level docs](self)) exceeds this
+ /// threshold, and no service is currently in the process of being added, a new service is
+ /// scheduled to be added to the underlying [`Balance`].
+ ///
+ /// The default value is 0.5. That is, when every other call to `poll_ready` returns
+ /// `Pending`, then the underlying service is considered highly loaded.
+ pub fn loaded_above(&mut self, high: f64) -> &mut Self {
+ self.high = high;
+ self
+ }
+
+ /// The initial estimated load average.
+ ///
+ /// This is also the value that the estimated load will be reset to whenever a service is added
+ /// or removed.
+ ///
+ /// The default value is 0.1.
+ pub fn initial(&mut self, init: f64) -> &mut Self {
+ self.init = init;
+ self
+ }
+
+ /// How aggressively the estimated load average is updated.
+ ///
+ /// This is the α parameter of the formula for the [exponential moving
+ /// average](https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average), and
+ /// dictates how quickly new samples of the current load affect the estimated load. If the
+ /// value is closer to 1, newer samples affect the load average a lot (when α is 1, the load
+ /// average is immediately set to the current load). If the value is closer to 0, newer samples
+ /// affect the load average very little at a time.
+ ///
+ /// The given value is clamped to `[0,1]`.
+ ///
+ /// The default value is 0.05, meaning, in very approximate terms, that each new load sample
+ /// affects the estimated load by 5%.
+ pub fn urgency(&mut self, alpha: f64) -> &mut Self {
+ self.alpha = alpha.max(0.0).min(1.0);
+ self
+ }
+
+ /// The maximum number of backing `Service` instances to maintain.
+ ///
+ /// When the limit is reached, the load estimate is clamped to the high load threshhold, and no
+ /// new service is spawned.
+ ///
+ /// No maximum limit is imposed by default.
+ pub fn max_services(&mut self, limit: Option<usize>) -> &mut Self {
+ self.limit = limit;
+ self
+ }
+
+ /// See [`Pool::new`].
+ pub fn build<MS, Target, Request>(
+ &self,
+ make_service: MS,
+ target: Target,
+ ) -> Pool<MS, Target, Request>
+ where
+ MS: MakeService<Target, Request>,
+ MS::Service: Load,
+ <MS::Service as Load>::Metric: std::fmt::Debug,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone,
+ {
+ let (died_tx, died_rx) = tokio::sync::mpsc::unbounded_channel();
+ let d = PoolDiscoverer {
+ maker: make_service,
+ making: None,
+ target,
+ load: Level::Normal,
+ services: Slab::new(),
+ died_tx,
+ died_rx,
+ limit: self.limit,
+ };
+
+ Pool {
+ balance: Balance::new(Box::pin(d)),
+ options: *self,
+ ewma: self.init,
+ }
+ }
+}
+
+/// A dynamically sized, load-balanced pool of `Service` instances.
+pub struct Pool<MS, Target, Request>
+where
+ MS: MakeService<Target, Request>,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone,
+{
+ // the Pin<Box<_>> here is needed since Balance requires the Service to be Unpin
+ balance: Balance<Pin<Box<PoolDiscoverer<MS, Target, Request>>>, Request>,
+ options: Builder,
+ ewma: f64,
+}
+
+impl<MS, Target, Request> fmt::Debug for Pool<MS, Target, Request>
+where
+ MS: MakeService<Target, Request> + fmt::Debug,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone + fmt::Debug,
+ MS::Service: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Pool")
+ .field("balance", &self.balance)
+ .field("options", &self.options)
+ .field("ewma", &self.ewma)
+ .finish()
+ }
+}
+
+impl<MS, Target, Request> Pool<MS, Target, Request>
+where
+ MS: MakeService<Target, Request>,
+ MS::Service: Load,
+ <MS::Service as Load>::Metric: std::fmt::Debug,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone,
+{
+ /// Construct a new dynamically sized `Pool`.
+ ///
+ /// If many calls to `poll_ready` return `Pending`, `new_service` is used to
+ /// construct another `Service` that is then added to the load-balanced pool.
+ /// If many calls to `poll_ready` succeed, the most recently added `Service`
+ /// is dropped from the pool.
+ pub fn new(make_service: MS, target: Target) -> Self {
+ Builder::new().build(make_service, target)
+ }
+}
+
+type PinBalance<S, Request> = Balance<Pin<Box<S>>, Request>;
+
+impl<MS, Target, Req> Service<Req> for Pool<MS, Target, Req>
+where
+ MS: MakeService<Target, Req>,
+ MS::Service: Load,
+ <MS::Service as Load>::Metric: std::fmt::Debug,
+ MS::MakeError: Into<crate::BoxError>,
+ MS::Error: Into<crate::BoxError>,
+ Target: Clone,
+{
+ type Response = <PinBalance<PoolDiscoverer<MS, Target, Req>, Req> as Service<Req>>::Response;
+ type Error = <PinBalance<PoolDiscoverer<MS, Target, Req>, Req> as Service<Req>>::Error;
+ type Future = <PinBalance<PoolDiscoverer<MS, Target, Req>, Req> as Service<Req>>::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if let Poll::Ready(()) = self.balance.poll_ready(cx)? {
+ // services was ready -- there are enough services
+ // update ewma with a 0 sample
+ self.ewma *= 1.0 - self.options.alpha;
+
+ let discover = self.balance.discover_mut().as_mut().project();
+ if self.ewma < self.options.low {
+ if *discover.load != Level::Low {
+ tracing::trace!({ ewma = %self.ewma }, "pool is over-provisioned");
+ }
+ *discover.load = Level::Low;
+
+ if discover.services.len() > 1 {
+ // reset EWMA so we don't immediately try to remove another service
+ self.ewma = self.options.init;
+ }
+ } else {
+ if *discover.load != Level::Normal {
+ tracing::trace!({ ewma = %self.ewma }, "pool is appropriately provisioned");
+ }
+ *discover.load = Level::Normal;
+ }
+
+ return Poll::Ready(Ok(()));
+ }
+
+ let discover = self.balance.discover_mut().as_mut().project();
+ if discover.making.is_none() {
+ // no services are ready -- we're overloaded
+ // update ewma with a 1 sample
+ self.ewma = self.options.alpha + (1.0 - self.options.alpha) * self.ewma;
+
+ if self.ewma > self.options.high {
+ if *discover.load != Level::High {
+ tracing::trace!({ ewma = %self.ewma }, "pool is under-provisioned");
+ }
+ *discover.load = Level::High;
+
+ // don't reset the EWMA -- in theory, poll_ready should now start returning
+ // `Ready`, so we won't try to launch another service immediately.
+ // we clamp it to high though in case the # of services is limited.
+ self.ewma = self.options.high;
+
+ // we need to call balance again for PoolDiscover to realize
+ // it can make a new service
+ return self.balance.poll_ready(cx);
+ } else {
+ *discover.load = Level::Normal;
+ }
+ }
+
+ Poll::Pending
+ }
+
+ fn call(&mut self, req: Req) -> Self::Future {
+ self.balance.call(req)
+ }
+}
+
+#[doc(hidden)]
+#[derive(Debug)]
+pub struct DropNotifyService<Svc> {
+ svc: Svc,
+ id: usize,
+ notify: tokio::sync::mpsc::UnboundedSender<usize>,
+}
+
+impl<Svc> Drop for DropNotifyService<Svc> {
+ fn drop(&mut self) {
+ let _ = self.notify.send(self.id).is_ok();
+ }
+}
+
+impl<Svc: Load> Load for DropNotifyService<Svc> {
+ type Metric = Svc::Metric;
+ fn load(&self) -> Self::Metric {
+ self.svc.load()
+ }
+}
+
+impl<Request, Svc: Service<Request>> Service<Request> for DropNotifyService<Svc> {
+ type Response = Svc::Response;
+ type Future = Svc::Future;
+ type Error = Svc::Error;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.svc.poll_ready(cx)
+ }
+
+ fn call(&mut self, req: Request) -> Self::Future {
+ self.svc.call(req)
+ }
+}
diff --git a/crates/tower/src/balance/pool/test.rs b/crates/tower/src/balance/pool/test.rs
new file mode 100644
index 0000000..6861b25
--- /dev/null
+++ b/crates/tower/src/balance/pool/test.rs
@@ -0,0 +1,190 @@
+use crate::load;
+use futures_util::pin_mut;
+use tokio_test::{assert_pending, assert_ready, assert_ready_ok, task};
+use tower_test::{assert_request_eq, mock};
+
+use super::*;
+
+#[tokio::test]
+async fn basic() {
+ // start the pool
+ let (mock, handle) = mock::pair::<(), load::Constant<mock::Mock<(), &'static str>, usize>>();
+ pin_mut!(handle);
+
+ let mut pool = mock::Spawn::new(Builder::new().build(mock, ()));
+ assert_pending!(pool.poll_ready());
+
+ // give the pool a backing service
+ let (svc1_m, svc1) = mock::pair();
+ pin_mut!(svc1);
+
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc1_m, 0));
+ assert_ready_ok!(pool.poll_ready());
+
+ // send a request to the one backing service
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_pending!(fut.poll());
+ assert_request_eq!(svc1, ()).send_response("foobar");
+ assert_eq!(assert_ready_ok!(fut.poll()), "foobar");
+}
+
+#[tokio::test]
+async fn high_load() {
+ // start the pool
+ let (mock, handle) = mock::pair::<(), load::Constant<mock::Mock<(), &'static str>, usize>>();
+ pin_mut!(handle);
+
+ let pool = Builder::new()
+ .urgency(1.0) // so _any_ Pending will add a service
+ .underutilized_below(0.0) // so no Ready will remove a service
+ .max_services(Some(2))
+ .build(mock, ());
+ let mut pool = mock::Spawn::new(pool);
+ assert_pending!(pool.poll_ready());
+
+ // give the pool a backing service
+ let (svc1_m, svc1) = mock::pair();
+ pin_mut!(svc1);
+
+ svc1.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc1_m, 0));
+ assert_ready_ok!(pool.poll_ready());
+
+ // make the one backing service not ready
+ let mut fut1 = task::spawn(pool.call(()));
+
+ // if we poll_ready again, pool should notice that load is increasing
+ // since urgency == 1.0, it should immediately enter high load
+ assert_pending!(pool.poll_ready());
+ // it should ask the maker for another service, so we give it one
+ let (svc2_m, svc2) = mock::pair();
+ pin_mut!(svc2);
+
+ svc2.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc2_m, 0));
+
+ // the pool should now be ready again for one more request
+ assert_ready_ok!(pool.poll_ready());
+ let mut fut2 = task::spawn(pool.call(()));
+
+ assert_pending!(pool.poll_ready());
+
+ // the pool should _not_ try to add another service
+ // sicen we have max_services(2)
+ assert_pending!(handle.as_mut().poll_request());
+
+ // let see that each service got one request
+ assert_request_eq!(svc1, ()).send_response("foo");
+ assert_request_eq!(svc2, ()).send_response("bar");
+ assert_eq!(assert_ready_ok!(fut1.poll()), "foo");
+ assert_eq!(assert_ready_ok!(fut2.poll()), "bar");
+}
+
+#[tokio::test]
+async fn low_load() {
+ // start the pool
+ let (mock, handle) = mock::pair::<(), load::Constant<mock::Mock<(), &'static str>, usize>>();
+ pin_mut!(handle);
+
+ let pool = Builder::new()
+ .urgency(1.0) // so any event will change the service count
+ .build(mock, ());
+
+ let mut pool = mock::Spawn::new(pool);
+
+ assert_pending!(pool.poll_ready());
+
+ // give the pool a backing service
+ let (svc1_m, svc1) = mock::pair();
+ pin_mut!(svc1);
+
+ svc1.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc1_m, 0));
+ assert_ready_ok!(pool.poll_ready());
+
+ // cycling a request should now work
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_request_eq!(svc1, ()).send_response("foo");
+ assert_eq!(assert_ready_ok!(fut.poll()), "foo");
+ // and pool should now not be ready (since svc1 isn't ready)
+ // it should immediately try to add another service
+ // which we give it
+ assert_pending!(pool.poll_ready());
+ let (svc2_m, svc2) = mock::pair();
+ pin_mut!(svc2);
+
+ svc2.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc2_m, 0));
+ // pool is now ready
+ // which (because of urgency == 1.0) should immediately cause it to drop a service
+ // it'll drop svc1, so it'll still be ready
+ assert_ready_ok!(pool.poll_ready());
+ // and even with another ready, it won't drop svc2 since its now the only service
+ assert_ready_ok!(pool.poll_ready());
+
+ // cycling a request should now work on svc2
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_request_eq!(svc2, ()).send_response("foo");
+ assert_eq!(assert_ready_ok!(fut.poll()), "foo");
+
+ // and again (still svc2)
+ svc2.allow(1);
+ assert_ready_ok!(pool.poll_ready());
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_request_eq!(svc2, ()).send_response("foo");
+ assert_eq!(assert_ready_ok!(fut.poll()), "foo");
+}
+
+#[tokio::test]
+async fn failing_service() {
+ // start the pool
+ let (mock, handle) = mock::pair::<(), load::Constant<mock::Mock<(), &'static str>, usize>>();
+ pin_mut!(handle);
+
+ let pool = Builder::new()
+ .urgency(1.0) // so _any_ Pending will add a service
+ .underutilized_below(0.0) // so no Ready will remove a service
+ .build(mock, ());
+
+ let mut pool = mock::Spawn::new(pool);
+
+ assert_pending!(pool.poll_ready());
+
+ // give the pool a backing service
+ let (svc1_m, svc1) = mock::pair();
+ pin_mut!(svc1);
+
+ svc1.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc1_m, 0));
+ assert_ready_ok!(pool.poll_ready());
+
+ // one request-response cycle
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_request_eq!(svc1, ()).send_response("foo");
+ assert_eq!(assert_ready_ok!(fut.poll()), "foo");
+
+ // now make svc1 fail, so it has to be removed
+ svc1.send_error("ouch");
+ // polling now should recognize the failed service,
+ // try to create a new one, and then realize the maker isn't ready
+ assert_pending!(pool.poll_ready());
+ // then we release another service
+ let (svc2_m, svc2) = mock::pair();
+ pin_mut!(svc2);
+
+ svc2.allow(1);
+ assert_request_eq!(handle, ()).send_response(load::Constant::new(svc2_m, 0));
+
+ // the pool should now be ready again
+ assert_ready_ok!(pool.poll_ready());
+ // and a cycle should work (and go through svc2)
+ let mut fut = task::spawn(pool.call(()));
+
+ assert_request_eq!(svc2, ()).send_response("bar");
+ assert_eq!(assert_ready_ok!(fut.poll()), "bar");
+}
diff --git a/crates/tower/src/buffer/error.rs b/crates/tower/src/buffer/error.rs
new file mode 100644
index 0000000..f046cbc
--- /dev/null
+++ b/crates/tower/src/buffer/error.rs
@@ -0,0 +1,68 @@
+//! Error types for the `Buffer` middleware.
+
+use crate::BoxError;
+use std::{fmt, sync::Arc};
+
+/// An error produced by a [`Service`] wrapped by a [`Buffer`]
+///
+/// [`Service`]: crate::Service
+/// [`Buffer`]: crate::buffer::Buffer
+#[derive(Debug)]
+pub struct ServiceError {
+ inner: Arc<BoxError>,
+}
+
+/// An error produced when the a buffer's worker closes unexpectedly.
+pub struct Closed {
+ _p: (),
+}
+
+// ===== impl ServiceError =====
+
+impl ServiceError {
+ pub(crate) fn new(inner: BoxError) -> ServiceError {
+ let inner = Arc::new(inner);
+ ServiceError { inner }
+ }
+
+ // Private to avoid exposing `Clone` trait as part of the public API
+ pub(crate) fn clone(&self) -> ServiceError {
+ ServiceError {
+ inner: self.inner.clone(),
+ }
+ }
+}
+
+impl fmt::Display for ServiceError {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "buffered service failed: {}", self.inner)
+ }
+}
+
+impl std::error::Error for ServiceError {
+ fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+ Some(&**self.inner)
+ }
+}
+
+// ===== impl Closed =====
+
+impl Closed {
+ pub(crate) fn new() -> Self {
+ Closed { _p: () }
+ }
+}
+
+impl fmt::Debug for Closed {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_tuple("Closed").finish()
+ }
+}
+
+impl fmt::Display for Closed {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.write_str("buffer's worker closed unexpectedly")
+ }
+}
+
+impl std::error::Error for Closed {}
diff --git a/crates/tower/src/buffer/future.rs b/crates/tower/src/buffer/future.rs
new file mode 100644
index 0000000..4117890
--- /dev/null
+++ b/crates/tower/src/buffer/future.rs
@@ -0,0 +1,79 @@
+//! Future types for the [`Buffer`] middleware.
+//!
+//! [`Buffer`]: crate::buffer::Buffer
+
+use super::{error::Closed, message};
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+pin_project! {
+ /// Future that completes when the buffered service eventually services the submitted request.
+ #[derive(Debug)]
+ pub struct ResponseFuture<T> {
+ #[pin]
+ state: ResponseState<T>,
+ }
+}
+
+pin_project! {
+ #[project = ResponseStateProj]
+ #[derive(Debug)]
+ enum ResponseState<T> {
+ Failed {
+ error: Option<crate::BoxError>,
+ },
+ Rx {
+ #[pin]
+ rx: message::Rx<T>,
+ },
+ Poll {
+ #[pin]
+ fut: T,
+ },
+ }
+}
+
+impl<T> ResponseFuture<T> {
+ pub(crate) fn new(rx: message::Rx<T>) -> Self {
+ ResponseFuture {
+ state: ResponseState::Rx { rx },
+ }
+ }
+
+ pub(crate) fn failed(err: crate::BoxError) -> Self {
+ ResponseFuture {
+ state: ResponseState::Failed { error: Some(err) },
+ }
+ }
+}
+
+impl<F, T, E> Future for ResponseFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let mut this = self.project();
+
+ loop {
+ match this.state.as_mut().project() {
+ ResponseStateProj::Failed { error } => {
+ return Poll::Ready(Err(error.take().expect("polled after error")));
+ }
+ ResponseStateProj::Rx { rx } => match ready!(rx.poll(cx)) {
+ Ok(Ok(fut)) => this.state.set(ResponseState::Poll { fut }),
+ Ok(Err(e)) => return Poll::Ready(Err(e.into())),
+ Err(_) => return Poll::Ready(Err(Closed::new().into())),
+ },
+ ResponseStateProj::Poll { fut } => return fut.poll(cx).map_err(Into::into),
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/buffer/layer.rs b/crates/tower/src/buffer/layer.rs
new file mode 100644
index 0000000..aadc938
--- /dev/null
+++ b/crates/tower/src/buffer/layer.rs
@@ -0,0 +1,75 @@
+use super::service::Buffer;
+use std::{fmt, marker::PhantomData};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Adds an mpsc buffer in front of an inner service.
+///
+/// The default Tokio executor is used to run the given service,
+/// which means that this layer can only be used on the Tokio runtime.
+///
+/// See the module documentation for more details.
+pub struct BufferLayer<Request> {
+ bound: usize,
+ _p: PhantomData<fn(Request)>,
+}
+
+impl<Request> BufferLayer<Request> {
+ /// Creates a new [`BufferLayer`] with the provided `bound`.
+ ///
+ /// `bound` gives the maximal number of requests that can be queued for the service before
+ /// backpressure is applied to callers.
+ ///
+ /// # A note on choosing a `bound`
+ ///
+ /// When [`Buffer`]'s implementation of [`poll_ready`] returns [`Poll::Ready`], it reserves a
+ /// slot in the channel for the forthcoming [`call`]. However, if this call doesn't arrive,
+ /// this reserved slot may be held up for a long time. As a result, it's advisable to set
+ /// `bound` to be at least the maximum number of concurrent requests the [`Buffer`] will see.
+ /// If you do not, all the slots in the buffer may be held up by futures that have just called
+ /// [`poll_ready`] but will not issue a [`call`], which prevents other senders from issuing new
+ /// requests.
+ ///
+ /// [`Poll::Ready`]: std::task::Poll::Ready
+ /// [`call`]: crate::Service::call
+ /// [`poll_ready`]: crate::Service::poll_ready
+ pub fn new(bound: usize) -> Self {
+ BufferLayer {
+ bound,
+ _p: PhantomData,
+ }
+ }
+}
+
+impl<S, Request> Layer<S> for BufferLayer<Request>
+where
+ S: Service<Request> + Send + 'static,
+ S::Future: Send,
+ S::Error: Into<crate::BoxError> + Send + Sync,
+ Request: Send + 'static,
+{
+ type Service = Buffer<S, Request>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ Buffer::new(service, self.bound)
+ }
+}
+
+impl<Request> fmt::Debug for BufferLayer<Request> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_struct("BufferLayer")
+ .field("bound", &self.bound)
+ .finish()
+ }
+}
+
+impl<Request> Clone for BufferLayer<Request> {
+ fn clone(&self) -> Self {
+ Self {
+ bound: self.bound,
+ _p: PhantomData,
+ }
+ }
+}
+
+impl<Request> Copy for BufferLayer<Request> {}
diff --git a/crates/tower/src/buffer/message.rs b/crates/tower/src/buffer/message.rs
new file mode 100644
index 0000000..2b2fcde
--- /dev/null
+++ b/crates/tower/src/buffer/message.rs
@@ -0,0 +1,17 @@
+use super::error::ServiceError;
+use tokio::sync::{oneshot, OwnedSemaphorePermit};
+
+/// Message sent over buffer
+#[derive(Debug)]
+pub(crate) struct Message<Request, Fut> {
+ pub(crate) request: Request,
+ pub(crate) tx: Tx<Fut>,
+ pub(crate) span: tracing::Span,
+ pub(super) _permit: OwnedSemaphorePermit,
+}
+
+/// Response sender
+pub(crate) type Tx<Fut> = oneshot::Sender<Result<Fut, ServiceError>>;
+
+/// Response receiver
+pub(crate) type Rx<Fut> = oneshot::Receiver<Result<Fut, ServiceError>>;
diff --git a/crates/tower/src/buffer/mod.rs b/crates/tower/src/buffer/mod.rs
new file mode 100644
index 0000000..923b442
--- /dev/null
+++ b/crates/tower/src/buffer/mod.rs
@@ -0,0 +1,47 @@
+//! Middleware that provides a buffered mpsc channel to a service.
+//!
+//! Sometimes you want to give out multiple handles to a single service, and allow each handle to
+//! enqueue requests. That is, you want a [`Service`] to be [`Clone`]. This module allows you to do
+//! that by placing the service behind a multi-producer, single-consumer buffering channel. Clients
+//! enqueue requests by sending on the channel from any of the handles ([`Buffer`]), and the single
+//! service running elsewhere (usually spawned) receives and services the requests one by one. Each
+//! request is enqueued alongside a response channel that allows the service to report the result
+//! of the request back to the caller.
+//!
+//! # Examples
+//!
+//! ```rust
+//! # #[cfg(feature = "util")]
+//! use tower::buffer::Buffer;
+//! # #[cfg(feature = "util")]
+//! use tower::{Service, ServiceExt};
+//! # #[cfg(feature = "util")]
+//! async fn mass_produce<S: Service<usize>>(svc: S)
+//! where
+//! S: 'static + Send,
+//! S::Error: Send + Sync + std::error::Error,
+//! S::Future: Send
+//! {
+//! let svc = Buffer::new(svc, 10 /* buffer length */);
+//! for _ in 0..10 {
+//! let mut svc = svc.clone();
+//! tokio::spawn(async move {
+//! for i in 0usize.. {
+//! svc.ready().await.expect("service crashed").call(i).await;
+//! }
+//! });
+//! }
+//! }
+//! ```
+//!
+//! [`Service`]: crate::Service
+
+pub mod error;
+pub mod future;
+mod layer;
+mod message;
+mod service;
+mod worker;
+
+pub use self::layer::BufferLayer;
+pub use self::service::Buffer;
diff --git a/crates/tower/src/buffer/service.rs b/crates/tower/src/buffer/service.rs
new file mode 100644
index 0000000..9b690f0
--- /dev/null
+++ b/crates/tower/src/buffer/service.rs
@@ -0,0 +1,183 @@
+use super::{
+ future::ResponseFuture,
+ message::Message,
+ worker::{Handle, Worker},
+};
+
+use futures_core::ready;
+use std::sync::Arc;
+use std::task::{Context, Poll};
+use tokio::sync::{mpsc, oneshot, OwnedSemaphorePermit, Semaphore};
+use tokio_util::sync::PollSemaphore;
+use tower_service::Service;
+
+/// Adds an mpsc buffer in front of an inner service.
+///
+/// See the module documentation for more details.
+#[derive(Debug)]
+pub struct Buffer<T, Request>
+where
+ T: Service<Request>,
+{
+ // Note: this actually _is_ bounded, but rather than using Tokio's bounded
+ // channel, we use Tokio's semaphore separately to implement the bound.
+ tx: mpsc::UnboundedSender<Message<Request, T::Future>>,
+ // When the buffer's channel is full, we want to exert backpressure in
+ // `poll_ready`, so that callers such as load balancers could choose to call
+ // another service rather than waiting for buffer capacity.
+ //
+ // Unfortunately, this can't be done easily using Tokio's bounded MPSC
+ // channel, because it doesn't expose a polling-based interface, only an
+ // `async fn ready`, which borrows the sender. Therefore, we implement our
+ // own bounded MPSC on top of the unbounded channel, using a semaphore to
+ // limit how many items are in the channel.
+ semaphore: PollSemaphore,
+ // The current semaphore permit, if one has been acquired.
+ //
+ // This is acquired in `poll_ready` and taken in `call`.
+ permit: Option<OwnedSemaphorePermit>,
+ handle: Handle,
+}
+
+impl<T, Request> Buffer<T, Request>
+where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+{
+ /// Creates a new [`Buffer`] wrapping `service`.
+ ///
+ /// `bound` gives the maximal number of requests that can be queued for the service before
+ /// backpressure is applied to callers.
+ ///
+ /// The default Tokio executor is used to run the given service, which means that this method
+ /// must be called while on the Tokio runtime.
+ ///
+ /// # A note on choosing a `bound`
+ ///
+ /// When [`Buffer`]'s implementation of [`poll_ready`] returns [`Poll::Ready`], it reserves a
+ /// slot in the channel for the forthcoming [`call`]. However, if this call doesn't arrive,
+ /// this reserved slot may be held up for a long time. As a result, it's advisable to set
+ /// `bound` to be at least the maximum number of concurrent requests the [`Buffer`] will see.
+ /// If you do not, all the slots in the buffer may be held up by futures that have just called
+ /// [`poll_ready`] but will not issue a [`call`], which prevents other senders from issuing new
+ /// requests.
+ ///
+ /// [`Poll::Ready`]: std::task::Poll::Ready
+ /// [`call`]: crate::Service::call
+ /// [`poll_ready`]: crate::Service::poll_ready
+ pub fn new(service: T, bound: usize) -> Self
+ where
+ T: Send + 'static,
+ T::Future: Send,
+ T::Error: Send + Sync,
+ Request: Send + 'static,
+ {
+ let (service, worker) = Self::pair(service, bound);
+ tokio::spawn(worker);
+ service
+ }
+
+ /// Creates a new [`Buffer`] wrapping `service`, but returns the background worker.
+ ///
+ /// This is useful if you do not want to spawn directly onto the tokio runtime
+ /// but instead want to use your own executor. This will return the [`Buffer`] and
+ /// the background `Worker` that you can then spawn.
+ pub fn pair(service: T, bound: usize) -> (Buffer<T, Request>, Worker<T, Request>)
+ where
+ T: Send + 'static,
+ T::Error: Send + Sync,
+ Request: Send + 'static,
+ {
+ let (tx, rx) = mpsc::unbounded_channel();
+ let semaphore = Arc::new(Semaphore::new(bound));
+ let (handle, worker) = Worker::new(service, rx, &semaphore);
+ let buffer = Buffer {
+ tx,
+ handle,
+ semaphore: PollSemaphore::new(semaphore),
+ permit: None,
+ };
+ (buffer, worker)
+ }
+
+ fn get_worker_error(&self) -> crate::BoxError {
+ self.handle.get_error_on_closed()
+ }
+}
+
+impl<T, Request> Service<Request> for Buffer<T, Request>
+where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+{
+ type Response = T::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<T::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // First, check if the worker is still alive.
+ if self.tx.is_closed() {
+ // If the inner service has errored, then we error here.
+ return Poll::Ready(Err(self.get_worker_error()));
+ }
+
+ // Then, check if we've already acquired a permit.
+ if self.permit.is_some() {
+ // We've already reserved capacity to send a request. We're ready!
+ return Poll::Ready(Ok(()));
+ }
+
+ // Finally, if we haven't already acquired a permit, poll the semaphore
+ // to acquire one. If we acquire a permit, then there's enough buffer
+ // capacity to send a new request. Otherwise, we need to wait for
+ // capacity.
+ let permit =
+ ready!(self.semaphore.poll_acquire(cx)).ok_or_else(|| self.get_worker_error())?;
+ self.permit = Some(permit);
+
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ tracing::trace!("sending request to buffer worker");
+ let _permit = self
+ .permit
+ .take()
+ .expect("buffer full; poll_ready must be called first");
+
+ // get the current Span so that we can explicitly propagate it to the worker
+ // if we didn't do this, events on the worker related to this span wouldn't be counted
+ // towards that span since the worker would have no way of entering it.
+ let span = tracing::Span::current();
+
+ // If we've made it here, then a semaphore permit has already been
+ // acquired, so we can freely allocate a oneshot.
+ let (tx, rx) = oneshot::channel();
+
+ match self.tx.send(Message {
+ request,
+ span,
+ tx,
+ _permit,
+ }) {
+ Err(_) => ResponseFuture::failed(self.get_worker_error()),
+ Ok(_) => ResponseFuture::new(rx),
+ }
+ }
+}
+
+impl<T, Request> Clone for Buffer<T, Request>
+where
+ T: Service<Request>,
+{
+ fn clone(&self) -> Self {
+ Self {
+ tx: self.tx.clone(),
+ handle: self.handle.clone(),
+ semaphore: self.semaphore.clone(),
+ // The new clone hasn't acquired a permit yet. It will when it's
+ // next polled ready.
+ permit: None,
+ }
+ }
+}
diff --git a/crates/tower/src/buffer/worker.rs b/crates/tower/src/buffer/worker.rs
new file mode 100644
index 0000000..fe7ea55
--- /dev/null
+++ b/crates/tower/src/buffer/worker.rs
@@ -0,0 +1,256 @@
+use super::{
+ error::{Closed, ServiceError},
+ message::Message,
+};
+use futures_core::ready;
+use std::sync::{Arc, Mutex, Weak};
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::sync::{mpsc, Semaphore};
+use tower_service::Service;
+
+pin_project_lite::pin_project! {
+ /// Task that handles processing the buffer. This type should not be used
+ /// directly, instead `Buffer` requires an `Executor` that can accept this task.
+ ///
+ /// The struct is `pub` in the private module and the type is *not* re-exported
+ /// as part of the public API. This is the "sealed" pattern to include "private"
+ /// types in public traits that are not meant for consumers of the library to
+ /// implement (only call).
+ #[derive(Debug)]
+ pub struct Worker<T, Request>
+ where
+ T: Service<Request>,
+ {
+ current_message: Option<Message<Request, T::Future>>,
+ rx: mpsc::UnboundedReceiver<Message<Request, T::Future>>,
+ service: T,
+ finish: bool,
+ failed: Option<ServiceError>,
+ handle: Handle,
+ close: Option<Weak<Semaphore>>,
+ }
+
+ impl<T: Service<Request>, Request> PinnedDrop for Worker<T, Request>
+ {
+ fn drop(mut this: Pin<&mut Self>) {
+ this.as_mut().close_semaphore();
+ }
+ }
+}
+
+/// Get the error out
+#[derive(Debug)]
+pub(crate) struct Handle {
+ inner: Arc<Mutex<Option<ServiceError>>>,
+}
+
+impl<T, Request> Worker<T, Request>
+where
+ T: Service<Request>,
+{
+ /// Closes the buffer's semaphore if it is still open, waking any pending
+ /// tasks.
+ fn close_semaphore(&mut self) {
+ if let Some(close) = self.close.take().as_ref().and_then(Weak::upgrade) {
+ tracing::debug!("buffer closing; waking pending tasks");
+ close.close();
+ } else {
+ tracing::trace!("buffer already closed");
+ }
+ }
+}
+
+impl<T, Request> Worker<T, Request>
+where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+{
+ pub(crate) fn new(
+ service: T,
+ rx: mpsc::UnboundedReceiver<Message<Request, T::Future>>,
+ semaphore: &Arc<Semaphore>,
+ ) -> (Handle, Worker<T, Request>) {
+ let handle = Handle {
+ inner: Arc::new(Mutex::new(None)),
+ };
+
+ let semaphore = Arc::downgrade(semaphore);
+ let worker = Worker {
+ current_message: None,
+ finish: false,
+ failed: None,
+ rx,
+ service,
+ handle: handle.clone(),
+ close: Some(semaphore),
+ };
+
+ (handle, worker)
+ }
+
+ /// Return the next queued Message that hasn't been canceled.
+ ///
+ /// If a `Message` is returned, the `bool` is true if this is the first time we received this
+ /// message, and false otherwise (i.e., we tried to forward it to the backing service before).
+ fn poll_next_msg(
+ &mut self,
+ cx: &mut Context<'_>,
+ ) -> Poll<Option<(Message<Request, T::Future>, bool)>> {
+ if self.finish {
+ // We've already received None and are shutting down
+ return Poll::Ready(None);
+ }
+
+ tracing::trace!("worker polling for next message");
+ if let Some(msg) = self.current_message.take() {
+ // If the oneshot sender is closed, then the receiver is dropped,
+ // and nobody cares about the response. If this is the case, we
+ // should continue to the next request.
+ if !msg.tx.is_closed() {
+ tracing::trace!("resuming buffered request");
+ return Poll::Ready(Some((msg, false)));
+ }
+
+ tracing::trace!("dropping cancelled buffered request");
+ }
+
+ // Get the next request
+ while let Some(msg) = ready!(Pin::new(&mut self.rx).poll_recv(cx)) {
+ if !msg.tx.is_closed() {
+ tracing::trace!("processing new request");
+ return Poll::Ready(Some((msg, true)));
+ }
+ // Otherwise, request is canceled, so pop the next one.
+ tracing::trace!("dropping cancelled request");
+ }
+
+ Poll::Ready(None)
+ }
+
+ fn failed(&mut self, error: crate::BoxError) {
+ // The underlying service failed when we called `poll_ready` on it with the given `error`. We
+ // need to communicate this to all the `Buffer` handles. To do so, we wrap up the error in
+ // an `Arc`, send that `Arc<E>` to all pending requests, and store it so that subsequent
+ // requests will also fail with the same error.
+
+ // Note that we need to handle the case where some handle is concurrently trying to send us
+ // a request. We need to make sure that *either* the send of the request fails *or* it
+ // receives an error on the `oneshot` it constructed. Specifically, we want to avoid the
+ // case where we send errors to all outstanding requests, and *then* the caller sends its
+ // request. We do this by *first* exposing the error, *then* closing the channel used to
+ // send more requests (so the client will see the error when the send fails), and *then*
+ // sending the error to all outstanding requests.
+ let error = ServiceError::new(error);
+
+ let mut inner = self.handle.inner.lock().unwrap();
+
+ if inner.is_some() {
+ // Future::poll was called after we've already errored out!
+ return;
+ }
+
+ *inner = Some(error.clone());
+ drop(inner);
+
+ self.rx.close();
+
+ // By closing the mpsc::Receiver, we know that poll_next_msg will soon return Ready(None),
+ // which will trigger the `self.finish == true` phase. We just need to make sure that any
+ // requests that we receive before we've exhausted the receiver receive the error:
+ self.failed = Some(error);
+ }
+}
+
+impl<T, Request> Future for Worker<T, Request>
+where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+{
+ type Output = ();
+
+ fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ if self.finish {
+ return Poll::Ready(());
+ }
+
+ loop {
+ match ready!(self.poll_next_msg(cx)) {
+ Some((msg, first)) => {
+ let _guard = msg.span.enter();
+ if let Some(ref failed) = self.failed {
+ tracing::trace!("notifying caller about worker failure");
+ let _ = msg.tx.send(Err(failed.clone()));
+ continue;
+ }
+
+ // Wait for the service to be ready
+ tracing::trace!(
+ resumed = !first,
+ message = "worker received request; waiting for service readiness"
+ );
+ match self.service.poll_ready(cx) {
+ Poll::Ready(Ok(())) => {
+ tracing::debug!(service.ready = true, message = "processing request");
+ let response = self.service.call(msg.request);
+
+ // Send the response future back to the sender.
+ //
+ // An error means the request had been canceled in-between
+ // our calls, the response future will just be dropped.
+ tracing::trace!("returning response future");
+ let _ = msg.tx.send(Ok(response));
+ }
+ Poll::Pending => {
+ tracing::trace!(service.ready = false, message = "delay");
+ // Put out current message back in its slot.
+ drop(_guard);
+ self.current_message = Some(msg);
+ return Poll::Pending;
+ }
+ Poll::Ready(Err(e)) => {
+ let error = e.into();
+ tracing::debug!({ %error }, "service failed");
+ drop(_guard);
+ self.failed(error);
+ let _ = msg.tx.send(Err(self
+ .failed
+ .as_ref()
+ .expect("Worker::failed did not set self.failed?")
+ .clone()));
+ // Wake any tasks waiting on channel capacity.
+ self.close_semaphore();
+ }
+ }
+ }
+ None => {
+ // No more more requests _ever_.
+ self.finish = true;
+ return Poll::Ready(());
+ }
+ }
+ }
+ }
+}
+
+impl Handle {
+ pub(crate) fn get_error_on_closed(&self) -> crate::BoxError {
+ self.inner
+ .lock()
+ .unwrap()
+ .as_ref()
+ .map(|svc_err| svc_err.clone().into())
+ .unwrap_or_else(|| Closed::new().into())
+ }
+}
+
+impl Clone for Handle {
+ fn clone(&self) -> Handle {
+ Handle {
+ inner: self.inner.clone(),
+ }
+ }
+}
diff --git a/crates/tower/src/builder/mod.rs b/crates/tower/src/builder/mod.rs
new file mode 100644
index 0000000..3368413
--- /dev/null
+++ b/crates/tower/src/builder/mod.rs
@@ -0,0 +1,828 @@
+//! Builder types to compose layers and services
+
+use tower_layer::{Identity, Layer, Stack};
+use tower_service::Service;
+
+use std::fmt;
+
+/// Declaratively construct [`Service`] values.
+///
+/// [`ServiceBuilder`] provides a [builder-like interface][builder] for composing
+/// layers to be applied to a [`Service`].
+///
+/// # Service
+///
+/// A [`Service`] is a trait representing an asynchronous function of a request
+/// to a response. It is similar to `async fn(Request) -> Result<Response, Error>`.
+///
+/// A [`Service`] is typically bound to a single transport, such as a TCP
+/// connection. It defines how _all_ inbound or outbound requests are handled
+/// by that connection.
+///
+/// [builder]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
+///
+/// # Order
+///
+/// The order in which layers are added impacts how requests are handled. Layers
+/// that are added first will be called with the request first. The argument to
+/// `service` will be last to see the request.
+///
+/// ```
+/// # // this (and other) doctest is ignored because we don't have a way
+/// # // to say that it should only be run with cfg(feature = "...")
+/// # use tower::Service;
+/// # use tower::builder::ServiceBuilder;
+/// # #[cfg(all(feature = "buffer", feature = "limit"))]
+/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+/// ServiceBuilder::new()
+/// .buffer(100)
+/// .concurrency_limit(10)
+/// .service(svc)
+/// # ;
+/// # }
+/// ```
+///
+/// In the above example, the buffer layer receives the request first followed
+/// by `concurrency_limit`. `buffer` enables up to 100 request to be in-flight
+/// **on top of** the requests that have already been forwarded to the next
+/// layer. Combined with `concurrency_limit`, this allows up to 110 requests to be
+/// in-flight.
+///
+/// ```
+/// # use tower::Service;
+/// # use tower::builder::ServiceBuilder;
+/// # #[cfg(all(feature = "buffer", feature = "limit"))]
+/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+/// ServiceBuilder::new()
+/// .concurrency_limit(10)
+/// .buffer(100)
+/// .service(svc)
+/// # ;
+/// # }
+/// ```
+///
+/// The above example is similar, but the order of layers is reversed. Now,
+/// `concurrency_limit` applies first and only allows 10 requests to be in-flight
+/// total.
+///
+/// # Examples
+///
+/// A [`Service`] stack with a single layer:
+///
+/// ```
+/// # use tower::Service;
+/// # use tower::builder::ServiceBuilder;
+/// # #[cfg(feature = "limit")]
+/// # use tower::limit::concurrency::ConcurrencyLimitLayer;
+/// # #[cfg(feature = "limit")]
+/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+/// ServiceBuilder::new()
+/// .concurrency_limit(5)
+/// .service(svc);
+/// # ;
+/// # }
+/// ```
+///
+/// A [`Service`] stack with _multiple_ layers that contain rate limiting,
+/// in-flight request limits, and a channel-backed, clonable [`Service`]:
+///
+/// ```
+/// # use tower::Service;
+/// # use tower::builder::ServiceBuilder;
+/// # use std::time::Duration;
+/// # #[cfg(all(feature = "buffer", feature = "limit"))]
+/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+/// ServiceBuilder::new()
+/// .buffer(5)
+/// .concurrency_limit(5)
+/// .rate_limit(5, Duration::from_secs(1))
+/// .service(svc);
+/// # ;
+/// # }
+/// ```
+///
+/// [`Service`]: crate::Service
+#[derive(Clone)]
+pub struct ServiceBuilder<L> {
+ layer: L,
+}
+
+impl Default for ServiceBuilder<Identity> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl ServiceBuilder<Identity> {
+ /// Create a new [`ServiceBuilder`].
+ pub fn new() -> Self {
+ ServiceBuilder {
+ layer: Identity::new(),
+ }
+ }
+}
+
+impl<L> ServiceBuilder<L> {
+ /// Add a new layer `T` into the [`ServiceBuilder`].
+ ///
+ /// This wraps the inner service with the service provided by a user-defined
+ /// [`Layer`]. The provided layer must implement the [`Layer`] trait.
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer<T>(self, layer: T) -> ServiceBuilder<Stack<T, L>> {
+ ServiceBuilder {
+ layer: Stack::new(layer, self.layer),
+ }
+ }
+
+ /// Optionally add a new layer `T` into the [`ServiceBuilder`].
+ ///
+ /// ```
+ /// # use std::time::Duration;
+ /// # use tower::Service;
+ /// # use tower::builder::ServiceBuilder;
+ /// # use tower::timeout::TimeoutLayer;
+ /// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+ /// # let timeout = Some(Duration::new(10, 0));
+ /// // Apply a timeout if configured
+ /// ServiceBuilder::new()
+ /// .option_layer(timeout.map(TimeoutLayer::new))
+ /// .service(svc)
+ /// # ;
+ /// # }
+ /// ```
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn option_layer<T>(
+ self,
+ layer: Option<T>,
+ ) -> ServiceBuilder<Stack<crate::util::Either<T, Identity>, L>> {
+ self.layer(crate::util::option_layer(layer))
+ }
+
+ /// Add a [`Layer`] built from a function that accepts a service and returns another service.
+ ///
+ /// See the documentation for [`layer_fn`] for more details.
+ ///
+ /// [`layer_fn`]: crate::layer::layer_fn
+ pub fn layer_fn<F>(self, f: F) -> ServiceBuilder<Stack<crate::layer::LayerFn<F>, L>> {
+ self.layer(crate::layer::layer_fn(f))
+ }
+
+ /// Buffer requests when the next layer is not ready.
+ ///
+ /// This wraps the inner service with an instance of the [`Buffer`]
+ /// middleware.
+ ///
+ /// [`Buffer`]: crate::buffer
+ #[cfg(feature = "buffer")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "buffer")))]
+ pub fn buffer<Request>(
+ self,
+ bound: usize,
+ ) -> ServiceBuilder<Stack<crate::buffer::BufferLayer<Request>, L>> {
+ self.layer(crate::buffer::BufferLayer::new(bound))
+ }
+
+ /// Limit the max number of in-flight requests.
+ ///
+ /// A request is in-flight from the time the request is received until the
+ /// response future completes. This includes the time spent in the next
+ /// layers.
+ ///
+ /// This wraps the inner service with an instance of the
+ /// [`ConcurrencyLimit`] middleware.
+ ///
+ /// [`ConcurrencyLimit`]: crate::limit::concurrency
+ #[cfg(feature = "limit")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "limit")))]
+ pub fn concurrency_limit(
+ self,
+ max: usize,
+ ) -> ServiceBuilder<Stack<crate::limit::ConcurrencyLimitLayer, L>> {
+ self.layer(crate::limit::ConcurrencyLimitLayer::new(max))
+ }
+
+ /// Drop requests when the next layer is unable to respond to requests.
+ ///
+ /// Usually, when a service or middleware does not have capacity to process a
+ /// request (i.e., [`poll_ready`] returns [`Pending`]), the caller waits until
+ /// capacity becomes available.
+ ///
+ /// [`LoadShed`] immediately responds with an error when the next layer is
+ /// out of capacity.
+ ///
+ /// This wraps the inner service with an instance of the [`LoadShed`]
+ /// middleware.
+ ///
+ /// [`LoadShed`]: crate::load_shed
+ /// [`poll_ready`]: crate::Service::poll_ready
+ /// [`Pending`]: std::task::Poll::Pending
+ #[cfg(feature = "load-shed")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "load-shed")))]
+ pub fn load_shed(self) -> ServiceBuilder<Stack<crate::load_shed::LoadShedLayer, L>> {
+ self.layer(crate::load_shed::LoadShedLayer::new())
+ }
+
+ /// Limit requests to at most `num` per the given duration.
+ ///
+ /// This wraps the inner service with an instance of the [`RateLimit`]
+ /// middleware.
+ ///
+ /// [`RateLimit`]: crate::limit::rate
+ #[cfg(feature = "limit")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "limit")))]
+ pub fn rate_limit(
+ self,
+ num: u64,
+ per: std::time::Duration,
+ ) -> ServiceBuilder<Stack<crate::limit::RateLimitLayer, L>> {
+ self.layer(crate::limit::RateLimitLayer::new(num, per))
+ }
+
+ /// Retry failed requests according to the given [retry policy][policy].
+ ///
+ /// `policy` determines which failed requests will be retried. It must
+ /// implement the [`retry::Policy`][policy] trait.
+ ///
+ /// This wraps the inner service with an instance of the [`Retry`]
+ /// middleware.
+ ///
+ /// [`Retry`]: crate::retry
+ /// [policy]: crate::retry::Policy
+ #[cfg(feature = "retry")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "retry")))]
+ pub fn retry<P>(self, policy: P) -> ServiceBuilder<Stack<crate::retry::RetryLayer<P>, L>> {
+ self.layer(crate::retry::RetryLayer::new(policy))
+ }
+
+ /// Fail requests that take longer than `timeout`.
+ ///
+ /// If the next layer takes more than `timeout` to respond to a request,
+ /// processing is terminated and an error is returned.
+ ///
+ /// This wraps the inner service with an instance of the [`timeout`]
+ /// middleware.
+ ///
+ /// [`timeout`]: crate::timeout
+ #[cfg(feature = "timeout")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "timeout")))]
+ pub fn timeout(
+ self,
+ timeout: std::time::Duration,
+ ) -> ServiceBuilder<Stack<crate::timeout::TimeoutLayer, L>> {
+ self.layer(crate::timeout::TimeoutLayer::new(timeout))
+ }
+
+ /// Conditionally reject requests based on `predicate`.
+ ///
+ /// `predicate` must implement the [`Predicate`] trait.
+ ///
+ /// This wraps the inner service with an instance of the [`Filter`]
+ /// middleware.
+ ///
+ /// [`Filter`]: crate::filter
+ /// [`Predicate`]: crate::filter::Predicate
+ #[cfg(feature = "filter")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
+ pub fn filter<P>(
+ self,
+ predicate: P,
+ ) -> ServiceBuilder<Stack<crate::filter::FilterLayer<P>, L>> {
+ self.layer(crate::filter::FilterLayer::new(predicate))
+ }
+
+ /// Conditionally reject requests based on an asynchronous `predicate`.
+ ///
+ /// `predicate` must implement the [`AsyncPredicate`] trait.
+ ///
+ /// This wraps the inner service with an instance of the [`AsyncFilter`]
+ /// middleware.
+ ///
+ /// [`AsyncFilter`]: crate::filter::AsyncFilter
+ /// [`AsyncPredicate`]: crate::filter::AsyncPredicate
+ #[cfg(feature = "filter")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
+ pub fn filter_async<P>(
+ self,
+ predicate: P,
+ ) -> ServiceBuilder<Stack<crate::filter::AsyncFilterLayer<P>, L>> {
+ self.layer(crate::filter::AsyncFilterLayer::new(predicate))
+ }
+
+ /// Map one request type to another.
+ ///
+ /// This wraps the inner service with an instance of the [`MapRequest`]
+ /// middleware.
+ ///
+ /// # Examples
+ ///
+ /// Changing the type of a request:
+ ///
+ /// ```rust
+ /// use tower::ServiceBuilder;
+ /// use tower::ServiceExt;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() -> Result<(), ()> {
+ /// // Suppose we have some `Service` whose request type is `String`:
+ /// let string_svc = tower::service_fn(|request: String| async move {
+ /// println!("request: {}", request);
+ /// Ok(())
+ /// });
+ ///
+ /// // ...but we want to call that service with a `usize`. What do we do?
+ ///
+ /// let usize_svc = ServiceBuilder::new()
+ /// // Add a middlware that converts the request type to a `String`:
+ /// .map_request(|request: usize| format!("{}", request))
+ /// // ...and wrap the string service with that middleware:
+ /// .service(string_svc);
+ ///
+ /// // Now, we can call that service with a `usize`:
+ /// usize_svc.oneshot(42).await?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// Modifying the request value:
+ ///
+ /// ```rust
+ /// use tower::ServiceBuilder;
+ /// use tower::ServiceExt;
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() -> Result<(), ()> {
+ /// // A service that takes a number and returns it:
+ /// let svc = tower::service_fn(|request: usize| async move {
+ /// Ok(request)
+ /// });
+ ///
+ /// let svc = ServiceBuilder::new()
+ /// // Add a middleware that adds 1 to each request
+ /// .map_request(|request: usize| request + 1)
+ /// .service(svc);
+ ///
+ /// let response = svc.oneshot(1).await?;
+ /// assert_eq!(response, 2);
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`MapRequest`]: crate::util::MapRequest
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn map_request<F, R1, R2>(
+ self,
+ f: F,
+ ) -> ServiceBuilder<Stack<crate::util::MapRequestLayer<F>, L>>
+ where
+ F: FnMut(R1) -> R2 + Clone,
+ {
+ self.layer(crate::util::MapRequestLayer::new(f))
+ }
+
+ /// Map one response type to another.
+ ///
+ /// This wraps the inner service with an instance of the [`MapResponse`]
+ /// middleware.
+ ///
+ /// See the documentation for the [`map_response` combinator] for details.
+ ///
+ /// [`MapResponse`]: crate::util::MapResponse
+ /// [`map_response` combinator]: crate::util::ServiceExt::map_response
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn map_response<F>(
+ self,
+ f: F,
+ ) -> ServiceBuilder<Stack<crate::util::MapResponseLayer<F>, L>> {
+ self.layer(crate::util::MapResponseLayer::new(f))
+ }
+
+ /// Map one error type to another.
+ ///
+ /// This wraps the inner service with an instance of the [`MapErr`]
+ /// middleware.
+ ///
+ /// See the documentation for the [`map_err` combinator] for details.
+ ///
+ /// [`MapErr`]: crate::util::MapErr
+ /// [`map_err` combinator]: crate::util::ServiceExt::map_err
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn map_err<F>(self, f: F) -> ServiceBuilder<Stack<crate::util::MapErrLayer<F>, L>> {
+ self.layer(crate::util::MapErrLayer::new(f))
+ }
+
+ /// Composes a function that transforms futures produced by the service.
+ ///
+ /// This wraps the inner service with an instance of the [`MapFutureLayer`] middleware.
+ ///
+ /// See the documentation for the [`map_future`] combinator for details.
+ ///
+ /// [`MapFutureLayer`]: crate::util::MapFutureLayer
+ /// [`map_future`]: crate::util::ServiceExt::map_future
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn map_future<F>(self, f: F) -> ServiceBuilder<Stack<crate::util::MapFutureLayer<F>, L>> {
+ self.layer(crate::util::MapFutureLayer::new(f))
+ }
+
+ /// Apply an asynchronous function after the service, regardless of whether the future
+ /// succeeds or fails.
+ ///
+ /// This wraps the inner service with an instance of the [`Then`]
+ /// middleware.
+ ///
+ /// This is similar to the [`map_response`] and [`map_err`] functions,
+ /// except that the *same* function is invoked when the service's future
+ /// completes, whether it completes successfully or fails. This function
+ /// takes the [`Result`] returned by the service's future, and returns a
+ /// [`Result`].
+ ///
+ /// See the documentation for the [`then` combinator] for details.
+ ///
+ /// [`Then`]: crate::util::Then
+ /// [`then` combinator]: crate::util::ServiceExt::then
+ /// [`map_response`]: ServiceBuilder::map_response
+ /// [`map_err`]: ServiceBuilder::map_err
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn then<F>(self, f: F) -> ServiceBuilder<Stack<crate::util::ThenLayer<F>, L>> {
+ self.layer(crate::util::ThenLayer::new(f))
+ }
+
+ /// Executes a new future after this service's future resolves. This does
+ /// not alter the behaviour of the [`poll_ready`] method.
+ ///
+ /// This method can be used to change the [`Response`] type of the service
+ /// into a different type. You can use this method to chain along a computation once the
+ /// service's response has been resolved.
+ ///
+ /// This wraps the inner service with an instance of the [`AndThen`]
+ /// middleware.
+ ///
+ /// See the documentation for the [`and_then` combinator] for details.
+ ///
+ /// [`Response`]: crate::Service::Response
+ /// [`poll_ready`]: crate::Service::poll_ready
+ /// [`and_then` combinator]: crate::util::ServiceExt::and_then
+ /// [`AndThen`]: crate::util::AndThen
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn and_then<F>(self, f: F) -> ServiceBuilder<Stack<crate::util::AndThenLayer<F>, L>> {
+ self.layer(crate::util::AndThenLayer::new(f))
+ }
+
+ /// Maps this service's result type (`Result<Self::Response, Self::Error>`)
+ /// to a different value, regardless of whether the future succeeds or
+ /// fails.
+ ///
+ /// This wraps the inner service with an instance of the [`MapResult`]
+ /// middleware.
+ ///
+ /// See the documentation for the [`map_result` combinator] for details.
+ ///
+ /// [`map_result` combinator]: crate::util::ServiceExt::map_result
+ /// [`MapResult`]: crate::util::MapResult
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn map_result<F>(self, f: F) -> ServiceBuilder<Stack<crate::util::MapResultLayer<F>, L>> {
+ self.layer(crate::util::MapResultLayer::new(f))
+ }
+
+ /// Returns the underlying `Layer` implementation.
+ pub fn into_inner(self) -> L {
+ self.layer
+ }
+
+ /// Wrap the service `S` with the middleware provided by this
+ /// [`ServiceBuilder`]'s [`Layer`]'s, returning a new [`Service`].
+ ///
+ /// [`Layer`]: crate::Layer
+ /// [`Service`]: crate::Service
+ pub fn service<S>(&self, service: S) -> L::Service
+ where
+ L: Layer<S>,
+ {
+ self.layer.layer(service)
+ }
+
+ /// Wrap the async function `F` with the middleware provided by this [`ServiceBuilder`]'s
+ /// [`Layer`]s, returning a new [`Service`].
+ ///
+ /// This is a convenience method which is equivalent to calling
+ /// [`ServiceBuilder::service`] with a [`service_fn`], like this:
+ ///
+ /// ```rust
+ /// # use tower::{ServiceBuilder, service_fn};
+ /// # async fn handler_fn(_: ()) -> Result<(), ()> { Ok(()) }
+ /// # let _ = {
+ /// ServiceBuilder::new()
+ /// // ...
+ /// .service(service_fn(handler_fn))
+ /// # };
+ /// ```
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// use std::time::Duration;
+ /// use tower::{ServiceBuilder, ServiceExt, BoxError, service_fn};
+ ///
+ /// # #[tokio::main]
+ /// # async fn main() -> Result<(), BoxError> {
+ /// async fn handle(request: &'static str) -> Result<&'static str, BoxError> {
+ /// Ok(request)
+ /// }
+ ///
+ /// let svc = ServiceBuilder::new()
+ /// .buffer(1024)
+ /// .timeout(Duration::from_secs(10))
+ /// .service_fn(handle);
+ ///
+ /// let response = svc.oneshot("foo").await?;
+ ///
+ /// assert_eq!(response, "foo");
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`Layer`]: crate::Layer
+ /// [`Service`]: crate::Service
+ /// [`service_fn`]: crate::service_fn
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn service_fn<F>(self, f: F) -> L::Service
+ where
+ L: Layer<crate::util::ServiceFn<F>>,
+ {
+ self.service(crate::util::service_fn(f))
+ }
+
+ /// Check that the builder implements `Clone`.
+ ///
+ /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers.
+ ///
+ /// Doesn't actually change the builder but serves as a type check.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// use tower::ServiceBuilder;
+ ///
+ /// let builder = ServiceBuilder::new()
+ /// // Do something before processing the request
+ /// .map_request(|request: String| {
+ /// println!("got request!");
+ /// request
+ /// })
+ /// // Ensure our `ServiceBuilder` can be cloned
+ /// .check_clone()
+ /// // Do something after processing the request
+ /// .map_response(|response: String| {
+ /// println!("got response!");
+ /// response
+ /// });
+ /// ```
+ #[inline]
+ pub fn check_clone(self) -> Self
+ where
+ Self: Clone,
+ {
+ self
+ }
+
+ /// Check that the builder when given a service of type `S` produces a service that implements
+ /// `Clone`.
+ ///
+ /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers.
+ ///
+ /// Doesn't actually change the builder but serves as a type check.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// use tower::ServiceBuilder;
+ ///
+ /// # #[derive(Clone)]
+ /// # struct MyService;
+ /// #
+ /// let builder = ServiceBuilder::new()
+ /// // Do something before processing the request
+ /// .map_request(|request: String| {
+ /// println!("got request!");
+ /// request
+ /// })
+ /// // Ensure that the service produced when given a `MyService` implements
+ /// .check_service_clone::<MyService>()
+ /// // Do something after processing the request
+ /// .map_response(|response: String| {
+ /// println!("got response!");
+ /// response
+ /// });
+ /// ```
+ #[inline]
+ pub fn check_service_clone<S>(self) -> Self
+ where
+ L: Layer<S>,
+ L::Service: Clone,
+ {
+ self
+ }
+
+ /// Check that the builder when given a service of type `S` produces a service with the given
+ /// request, response, and error types.
+ ///
+ /// This can be useful when debugging type errors in `ServiceBuilder`s with lots of layers.
+ ///
+ /// Doesn't actually change the builder but serves as a type check.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// use tower::ServiceBuilder;
+ /// use std::task::{Poll, Context};
+ /// use tower::{Service, ServiceExt};
+ ///
+ /// // An example service
+ /// struct MyService;
+ ///
+ /// impl Service<Request> for MyService {
+ /// type Response = Response;
+ /// type Error = Error;
+ /// type Future = futures_util::future::Ready<Result<Response, Error>>;
+ ///
+ /// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// // ...
+ /// # todo!()
+ /// }
+ ///
+ /// fn call(&mut self, request: Request) -> Self::Future {
+ /// // ...
+ /// # todo!()
+ /// }
+ /// }
+ ///
+ /// struct Request;
+ /// struct Response;
+ /// struct Error;
+ ///
+ /// struct WrappedResponse(Response);
+ ///
+ /// let builder = ServiceBuilder::new()
+ /// // At this point in the builder if given a `MyService` it produces a service that
+ /// // accepts `Request`s, produces `Response`s, and fails with `Error`s
+ /// .check_service::<MyService, Request, Response, Error>()
+ /// // Wrap responses in `WrappedResponse`
+ /// .map_response(|response: Response| WrappedResponse(response))
+ /// // Now the response type will be `WrappedResponse`
+ /// .check_service::<MyService, _, WrappedResponse, _>();
+ /// ```
+ #[inline]
+ pub fn check_service<S, T, U, E>(self) -> Self
+ where
+ L: Layer<S>,
+ L::Service: Service<T, Response = U, Error = E>,
+ {
+ self
+ }
+
+ /// This wraps the inner service with the [`Layer`] returned by [`BoxService::layer()`].
+ ///
+ /// See that method for more details.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use tower::{Service, ServiceBuilder, BoxError, util::BoxService};
+ /// use std::time::Duration;
+ /// #
+ /// # struct Request;
+ /// # struct Response;
+ /// # impl Response {
+ /// # fn new() -> Self { Self }
+ /// # }
+ ///
+ /// let service: BoxService<Request, Response, BoxError> = ServiceBuilder::new()
+ /// .boxed()
+ /// .load_shed()
+ /// .concurrency_limit(64)
+ /// .timeout(Duration::from_secs(10))
+ /// .service_fn(|req: Request| async {
+ /// Ok::<_, BoxError>(Response::new())
+ /// });
+ /// # let service = assert_service(service);
+ /// # fn assert_service<S, R>(svc: S) -> S
+ /// # where S: Service<R> { svc }
+ /// ```
+ ///
+ /// [`BoxService::layer()`]: crate::util::BoxService::layer()
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn boxed<S, R>(
+ self,
+ ) -> ServiceBuilder<
+ Stack<
+ tower_layer::LayerFn<
+ fn(
+ L::Service,
+ ) -> crate::util::BoxService<
+ R,
+ <L::Service as Service<R>>::Response,
+ <L::Service as Service<R>>::Error,
+ >,
+ >,
+ L,
+ >,
+ >
+ where
+ L: Layer<S>,
+ L::Service: Service<R> + Send + 'static,
+ <L::Service as Service<R>>::Future: Send + 'static,
+ {
+ self.layer(crate::util::BoxService::layer())
+ }
+
+ /// This wraps the inner service with the [`Layer`] returned by [`BoxCloneService::layer()`].
+ ///
+ /// This is similar to the [`boxed`] method, but it requires that `Self` implement
+ /// [`Clone`], and the returned boxed service implements [`Clone`].
+ ///
+ /// See [`BoxCloneService`] for more details.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use tower::{Service, ServiceBuilder, BoxError, util::BoxCloneService};
+ /// use std::time::Duration;
+ /// #
+ /// # struct Request;
+ /// # struct Response;
+ /// # impl Response {
+ /// # fn new() -> Self { Self }
+ /// # }
+ ///
+ /// let service: BoxCloneService<Request, Response, BoxError> = ServiceBuilder::new()
+ /// .boxed_clone()
+ /// .load_shed()
+ /// .concurrency_limit(64)
+ /// .timeout(Duration::from_secs(10))
+ /// .service_fn(|req: Request| async {
+ /// Ok::<_, BoxError>(Response::new())
+ /// });
+ /// # let service = assert_service(service);
+ ///
+ /// // The boxed service can still be cloned.
+ /// service.clone();
+ /// # fn assert_service<S, R>(svc: S) -> S
+ /// # where S: Service<R> { svc }
+ /// ```
+ ///
+ /// [`BoxCloneService::layer()`]: crate::util::BoxCloneService::layer()
+ /// [`BoxCloneService`]: crate::util::BoxCloneService
+ /// [`boxed`]: Self::boxed
+ #[cfg(feature = "util")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+ pub fn boxed_clone<S, R>(
+ self,
+ ) -> ServiceBuilder<
+ Stack<
+ tower_layer::LayerFn<
+ fn(
+ L::Service,
+ ) -> crate::util::BoxCloneService<
+ R,
+ <L::Service as Service<R>>::Response,
+ <L::Service as Service<R>>::Error,
+ >,
+ >,
+ L,
+ >,
+ >
+ where
+ L: Layer<S>,
+ L::Service: Service<R> + Clone + Send + 'static,
+ <L::Service as Service<R>>::Future: Send + 'static,
+ {
+ self.layer(crate::util::BoxCloneService::layer())
+ }
+}
+
+impl<L: fmt::Debug> fmt::Debug for ServiceBuilder<L> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_tuple("ServiceBuilder").field(&self.layer).finish()
+ }
+}
+
+impl<S, L> Layer<S> for ServiceBuilder<L>
+where
+ L: Layer<S>,
+{
+ type Service = L::Service;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ self.layer.layer(inner)
+ }
+}
diff --git a/crates/tower/src/discover/error.rs b/crates/tower/src/discover/error.rs
new file mode 100644
index 0000000..cec3de4
--- /dev/null
+++ b/crates/tower/src/discover/error.rs
@@ -0,0 +1,12 @@
+use std::{error::Error, fmt};
+
+#[derive(Debug)]
+pub enum Never {}
+
+impl fmt::Display for Never {
+ fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result {
+ match *self {}
+ }
+}
+
+impl Error for Never {}
diff --git a/crates/tower/src/discover/list.rs b/crates/tower/src/discover/list.rs
new file mode 100644
index 0000000..b419802
--- /dev/null
+++ b/crates/tower/src/discover/list.rs
@@ -0,0 +1,61 @@
+use super::{error::Never, Change};
+use futures_core::Stream;
+use pin_project_lite::pin_project;
+use std::iter::{Enumerate, IntoIterator};
+use std::{
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// Static service discovery based on a predetermined list of services.
+ ///
+ /// [`ServiceList`] is created with an initial list of services. The discovery
+ /// process will yield this list once and do nothing after.
+ #[derive(Debug)]
+ pub struct ServiceList<T>
+ where
+ T: IntoIterator,
+ {
+ inner: Enumerate<T::IntoIter>,
+ }
+}
+
+impl<T, U> ServiceList<T>
+where
+ T: IntoIterator<Item = U>,
+{
+ #[allow(missing_docs)]
+ pub fn new<Request>(services: T) -> ServiceList<T>
+ where
+ U: Service<Request>,
+ {
+ ServiceList {
+ inner: services.into_iter().enumerate(),
+ }
+ }
+}
+
+impl<T, U> Stream for ServiceList<T>
+where
+ T: IntoIterator<Item = U>,
+{
+ type Item = Result<Change<usize, U>, Never>;
+
+ fn poll_next(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ match self.project().inner.next() {
+ Some((i, service)) => Poll::Ready(Some(Ok(Change::Insert(i, service)))),
+ None => Poll::Ready(None),
+ }
+ }
+}
+
+// check that List can be directly over collections
+#[cfg(test)]
+#[allow(dead_code)]
+type ListVecTest<T> = ServiceList<Vec<T>>;
+
+#[cfg(test)]
+#[allow(dead_code)]
+type ListVecIterTest<T> = ServiceList<::std::vec::IntoIter<T>>;
diff --git a/crates/tower/src/discover/mod.rs b/crates/tower/src/discover/mod.rs
new file mode 100644
index 0000000..3b3ba21
--- /dev/null
+++ b/crates/tower/src/discover/mod.rs
@@ -0,0 +1,107 @@
+//! Service discovery
+//!
+//! This module provides the [`Change`] enum, which indicates the arrival or departure of a service
+//! from a collection of similar services. Most implementations should use the [`Discover`] trait
+//! in their bounds to indicate that they can handle services coming and going. [`Discover`] itself
+//! is primarily a convenience wrapper around [`TryStream<Ok = Change>`][`TryStream`].
+//!
+//! Every discovered service is assigned an identifier that is distinct among the currently active
+//! services. If that service later goes away, a [`Change::Remove`] is yielded with that service's
+//! identifier. From that point forward, the identifier may be re-used.
+//!
+//! # Examples
+//!
+//! ```rust
+//! use futures_util::{future::poll_fn, pin_mut};
+//! use tower::discover::{Change, Discover};
+//! async fn services_monitor<D: Discover>(services: D) {
+//! pin_mut!(services);
+//! while let Some(Ok(change)) = poll_fn(|cx| services.as_mut().poll_discover(cx)).await {
+//! match change {
+//! Change::Insert(key, svc) => {
+//! // a new service with identifier `key` was discovered
+//! # let _ = (key, svc);
+//! }
+//! Change::Remove(key) => {
+//! // the service with identifier `key` has gone away
+//! # let _ = (key);
+//! }
+//! }
+//! }
+//! }
+//! ```
+//!
+//! [`TryStream`]: https://docs.rs/futures/latest/futures/stream/trait.TryStream.html
+
+mod error;
+mod list;
+
+pub use self::list::ServiceList;
+
+use crate::sealed::Sealed;
+use futures_core::TryStream;
+use std::{
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+/// A dynamically changing set of related services.
+///
+/// As new services arrive and old services are retired,
+/// [`Change`]s are returned which provide unique identifiers
+/// for the services.
+///
+/// See the module documentation for more details.
+pub trait Discover: Sealed<Change<(), ()>> {
+ /// A unique identifier for each active service.
+ ///
+ /// An identifier can be re-used once a [`Change::Remove`] has been yielded for its service.
+ type Key: Eq;
+
+ /// The type of [`Service`] yielded by this [`Discover`].
+ ///
+ /// [`Service`]: crate::Service
+ type Service;
+
+ /// Error produced during discovery
+ type Error;
+
+ /// Yields the next discovery change set.
+ fn poll_discover(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<Option<Result<Change<Self::Key, Self::Service>, Self::Error>>>;
+}
+
+impl<K, S, E, D: ?Sized> Sealed<Change<(), ()>> for D
+where
+ D: TryStream<Ok = Change<K, S>, Error = E>,
+ K: Eq,
+{
+}
+
+impl<K, S, E, D: ?Sized> Discover for D
+where
+ D: TryStream<Ok = Change<K, S>, Error = E>,
+ K: Eq,
+{
+ type Key = K;
+ type Service = S;
+ type Error = E;
+
+ fn poll_discover(
+ self: Pin<&mut Self>,
+ cx: &mut Context<'_>,
+ ) -> Poll<Option<Result<D::Ok, D::Error>>> {
+ TryStream::try_poll_next(self, cx)
+ }
+}
+
+/// A change in the service set.
+#[derive(Debug)]
+pub enum Change<K, V> {
+ /// A new service identified by key `K` was identified.
+ Insert(K, V),
+ /// The service identified by key `K` disappeared.
+ Remove(K),
+}
diff --git a/crates/tower/src/filter/future.rs b/crates/tower/src/filter/future.rs
new file mode 100644
index 0000000..67772bb
--- /dev/null
+++ b/crates/tower/src/filter/future.rs
@@ -0,0 +1,98 @@
+//! Future types
+
+use super::AsyncPredicate;
+use crate::BoxError;
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// Filtered response future from [`AsyncFilter`] services.
+ ///
+ /// [`AsyncFilter`]: crate::filter::AsyncFilter
+ #[derive(Debug)]
+ pub struct AsyncResponseFuture<P, S, Request>
+ where
+ P: AsyncPredicate<Request>,
+ S: Service<P::Request>,
+ {
+ #[pin]
+ state: State<P::Future, S::Future>,
+
+ // Inner service
+ service: S,
+ }
+}
+
+opaque_future! {
+ /// Filtered response future from [`Filter`] services.
+ ///
+ /// [`Filter`]: crate::filter::Filter
+ pub type ResponseFuture<R, F> =
+ futures_util::future::Either<
+ futures_util::future::Ready<Result<R, crate::BoxError>>,
+ futures_util::future::ErrInto<F, crate::BoxError>
+ >;
+}
+
+pin_project! {
+ #[project = StateProj]
+ #[derive(Debug)]
+ enum State<F, G> {
+ /// Waiting for the predicate future
+ Check {
+ #[pin]
+ check: F
+ },
+ /// Waiting for the response future
+ WaitResponse {
+ #[pin]
+ response: G
+ },
+ }
+}
+
+impl<P, S, Request> AsyncResponseFuture<P, S, Request>
+where
+ P: AsyncPredicate<Request>,
+ S: Service<P::Request>,
+ S::Error: Into<BoxError>,
+{
+ pub(crate) fn new(check: P::Future, service: S) -> Self {
+ Self {
+ state: State::Check { check },
+ service,
+ }
+ }
+}
+
+impl<P, S, Request> Future for AsyncResponseFuture<P, S, Request>
+where
+ P: AsyncPredicate<Request>,
+ S: Service<P::Request>,
+ S::Error: Into<crate::BoxError>,
+{
+ type Output = Result<S::Response, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let mut this = self.project();
+
+ loop {
+ match this.state.as_mut().project() {
+ StateProj::Check { mut check } => {
+ let request = ready!(check.as_mut().poll(cx))?;
+ let response = this.service.call(request);
+ this.state.set(State::WaitResponse { response });
+ }
+ StateProj::WaitResponse { response } => {
+ return response.poll(cx).map_err(Into::into);
+ }
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/filter/layer.rs b/crates/tower/src/filter/layer.rs
new file mode 100644
index 0000000..2f92e2f
--- /dev/null
+++ b/crates/tower/src/filter/layer.rs
@@ -0,0 +1,72 @@
+use super::{AsyncFilter, Filter};
+use tower_layer::Layer;
+
+/// Conditionally dispatch requests to the inner service based on a synchronous
+/// [predicate].
+///
+/// This [`Layer`] produces instances of the [`Filter`] service.
+///
+/// [predicate]: crate::filter::Predicate
+/// [`Layer`]: crate::Layer
+/// [`Filter`]: crate::filter::Filter
+#[derive(Debug, Clone)]
+pub struct FilterLayer<U> {
+ predicate: U,
+}
+
+/// Conditionally dispatch requests to the inner service based on an asynchronous
+/// [predicate].
+///
+/// This [`Layer`] produces instances of the [`AsyncFilter`] service.
+///
+/// [predicate]: crate::filter::AsyncPredicate
+/// [`Layer`]: crate::Layer
+/// [`Filter`]: crate::filter::AsyncFilter
+#[derive(Debug)]
+pub struct AsyncFilterLayer<U> {
+ predicate: U,
+}
+
+// === impl FilterLayer ===
+
+impl<U> FilterLayer<U> {
+ /// Returns a new layer that produces [`Filter`] services with the given
+ /// [`Predicate`].
+ ///
+ /// [`Predicate`]: crate::filter::Predicate
+ /// [`Filter`]: crate::filter::Filter
+ pub fn new(predicate: U) -> Self {
+ Self { predicate }
+ }
+}
+
+impl<U: Clone, S> Layer<S> for FilterLayer<U> {
+ type Service = Filter<S, U>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let predicate = self.predicate.clone();
+ Filter::new(service, predicate)
+ }
+}
+
+// === impl AsyncFilterLayer ===
+
+impl<U> AsyncFilterLayer<U> {
+ /// Returns a new layer that produces [`AsyncFilter`] services with the given
+ /// [`AsyncPredicate`].
+ ///
+ /// [`AsyncPredicate`]: crate::filter::AsyncPredicate
+ /// [`Filter`]: crate::filter::Filter
+ pub fn new(predicate: U) -> Self {
+ Self { predicate }
+ }
+}
+
+impl<U: Clone, S> Layer<S> for AsyncFilterLayer<U> {
+ type Service = AsyncFilter<S, U>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let predicate = self.predicate.clone();
+ AsyncFilter::new(service, predicate)
+ }
+}
diff --git a/crates/tower/src/filter/mod.rs b/crates/tower/src/filter/mod.rs
new file mode 100644
index 0000000..b7c05cf
--- /dev/null
+++ b/crates/tower/src/filter/mod.rs
@@ -0,0 +1,191 @@
+//! Conditionally dispatch requests to the inner service based on the result of
+//! a predicate.
+//!
+//! A predicate takes some request type and returns a `Result<Request, Error>`.
+//! If the predicate returns [`Ok`], the inner service is called with the request
+//! returned by the predicate — which may be the original request or a
+//! modified one. If the predicate returns [`Err`], the request is rejected and
+//! the inner service is not called.
+//!
+//! Predicates may either be synchronous (simple functions from a `Request` to
+//! a [`Result`]) or asynchronous (functions returning [`Future`]s). Separate
+//! traits, [`Predicate`] and [`AsyncPredicate`], represent these two types of
+//! predicate. Note that when it is not necessary to await some other
+//! asynchronous operation in the predicate, the synchronous predicate should be
+//! preferred, as it introduces less overhead.
+//!
+//! The predicate traits are implemented for closures and function pointers.
+//! However, users may also implement them for other types, such as when the
+//! predicate requires some state carried between requests. For example,
+//! [`Predicate`] could be implemented for a type that rejects a fixed set of
+//! requests by checking if they are contained by a a [`HashSet`] or other
+//! collection.
+//!
+//! [`Future`]: std::future::Future
+//! [`HashSet`]: std::collections::HashSet
+pub mod future;
+mod layer;
+mod predicate;
+
+pub use self::{
+ layer::{AsyncFilterLayer, FilterLayer},
+ predicate::{AsyncPredicate, Predicate},
+};
+
+use self::future::{AsyncResponseFuture, ResponseFuture};
+use crate::BoxError;
+use futures_util::{future::Either, TryFutureExt};
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+/// Conditionally dispatch requests to the inner service based on a [predicate].
+///
+/// [predicate]: Predicate
+#[derive(Clone, Debug)]
+pub struct Filter<T, U> {
+ inner: T,
+ predicate: U,
+}
+
+/// Conditionally dispatch requests to the inner service based on an
+/// [asynchronous predicate].
+///
+/// [asynchronous predicate]: AsyncPredicate
+#[derive(Clone, Debug)]
+pub struct AsyncFilter<T, U> {
+ inner: T,
+ predicate: U,
+}
+
+// ==== impl Filter ====
+
+impl<T, U> Filter<T, U> {
+ /// Returns a new [`Filter`] service wrapping `inner`.
+ pub fn new(inner: T, predicate: U) -> Self {
+ Self { inner, predicate }
+ }
+
+ /// Returns a new [`Layer`] that wraps services with a [`Filter`] service
+ /// with the given [`Predicate`].
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer(predicate: U) -> FilterLayer<U> {
+ FilterLayer::new(predicate)
+ }
+
+ /// Check a `Request` value against this filter's predicate.
+ pub fn check<R>(&mut self, request: R) -> Result<U::Request, BoxError>
+ where
+ U: Predicate<R>,
+ {
+ self.predicate.check(request)
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<T, U, Request> Service<Request> for Filter<T, U>
+where
+ U: Predicate<Request>,
+ T: Service<U::Request>,
+ T::Error: Into<BoxError>,
+{
+ type Response = T::Response;
+ type Error = BoxError;
+ type Future = ResponseFuture<T::Response, T::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(Into::into)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ ResponseFuture::new(match self.predicate.check(request) {
+ Ok(request) => Either::Right(self.inner.call(request).err_into()),
+ Err(e) => Either::Left(futures_util::future::ready(Err(e))),
+ })
+ }
+}
+
+// ==== impl AsyncFilter ====
+
+impl<T, U> AsyncFilter<T, U> {
+ /// Returns a new [`AsyncFilter`] service wrapping `inner`.
+ pub fn new(inner: T, predicate: U) -> Self {
+ Self { inner, predicate }
+ }
+
+ /// Returns a new [`Layer`] that wraps services with an [`AsyncFilter`]
+ /// service with the given [`AsyncPredicate`].
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer(predicate: U) -> FilterLayer<U> {
+ FilterLayer::new(predicate)
+ }
+
+ /// Check a `Request` value against this filter's predicate.
+ pub async fn check<R>(&mut self, request: R) -> Result<U::Request, BoxError>
+ where
+ U: AsyncPredicate<R>,
+ {
+ self.predicate.check(request).await
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<T, U, Request> Service<Request> for AsyncFilter<T, U>
+where
+ U: AsyncPredicate<Request>,
+ T: Service<U::Request> + Clone,
+ T::Error: Into<BoxError>,
+{
+ type Response = T::Response;
+ type Error = BoxError;
+ type Future = AsyncResponseFuture<U, T, Request>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(Into::into)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ use std::mem;
+
+ let inner = self.inner.clone();
+ // In case the inner service has state that's driven to readiness and
+ // not tracked by clones (such as `Buffer`), pass the version we have
+ // already called `poll_ready` on into the future, and leave its clone
+ // behind.
+ let inner = mem::replace(&mut self.inner, inner);
+
+ // Check the request
+ let check = self.predicate.check(request);
+
+ AsyncResponseFuture::new(check, inner)
+ }
+}
diff --git a/crates/tower/src/filter/predicate.rs b/crates/tower/src/filter/predicate.rs
new file mode 100644
index 0000000..181bc96
--- /dev/null
+++ b/crates/tower/src/filter/predicate.rs
@@ -0,0 +1,65 @@
+use crate::BoxError;
+use std::future::Future;
+
+/// Checks a request asynchronously.
+pub trait AsyncPredicate<Request> {
+ /// The future returned by [`check`].
+ ///
+ /// [`check`]: crate::filter::AsyncPredicate::check
+ type Future: Future<Output = Result<Self::Request, BoxError>>;
+
+ /// The type of requests returned by [`check`].
+ ///
+ /// This request is forwarded to the inner service if the predicate
+ /// succeeds.
+ ///
+ /// [`check`]: crate::filter::AsyncPredicate::check
+ type Request;
+
+ /// Check whether the given request should be forwarded.
+ ///
+ /// If the future resolves with [`Ok`], the request is forwarded to the inner service.
+ fn check(&mut self, request: Request) -> Self::Future;
+}
+/// Checks a request synchronously.
+pub trait Predicate<Request> {
+ /// The type of requests returned by [`check`].
+ ///
+ /// This request is forwarded to the inner service if the predicate
+ /// succeeds.
+ ///
+ /// [`check`]: crate::filter::Predicate::check
+ type Request;
+
+ /// Check whether the given request should be forwarded.
+ ///
+ /// If the future resolves with [`Ok`], the request is forwarded to the inner service.
+ fn check(&mut self, request: Request) -> Result<Self::Request, BoxError>;
+}
+
+impl<F, T, U, R, E> AsyncPredicate<T> for F
+where
+ F: FnMut(T) -> U,
+ U: Future<Output = Result<R, E>>,
+ E: Into<BoxError>,
+{
+ type Future = futures_util::future::ErrInto<U, BoxError>;
+ type Request = R;
+
+ fn check(&mut self, request: T) -> Self::Future {
+ use futures_util::TryFutureExt;
+ self(request).err_into()
+ }
+}
+
+impl<F, T, R, E> Predicate<T> for F
+where
+ F: FnMut(T) -> Result<R, E>,
+ E: Into<BoxError>,
+{
+ type Request = R;
+
+ fn check(&mut self, request: T) -> Result<Self::Request, BoxError> {
+ self(request).map_err(Into::into)
+ }
+}
diff --git a/crates/tower/src/hedge/delay.rs b/crates/tower/src/hedge/delay.rs
new file mode 100644
index 0000000..3d634bf
--- /dev/null
+++ b/crates/tower/src/hedge/delay.rs
@@ -0,0 +1,126 @@
+use futures_util::ready;
+use pin_project_lite::pin_project;
+use std::time::Duration;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+use crate::util::Oneshot;
+
+/// A policy which specifies how long each request should be delayed for.
+pub trait Policy<Request> {
+ fn delay(&self, req: &Request) -> Duration;
+}
+
+/// A middleware which delays sending the request to the underlying service
+/// for an amount of time specified by the policy.
+#[derive(Debug)]
+pub struct Delay<P, S> {
+ policy: P,
+ service: S,
+}
+
+pin_project! {
+ #[derive(Debug)]
+ pub struct ResponseFuture<Request, S>
+ where
+ S: Service<Request>,
+ {
+ service: Option<S>,
+ #[pin]
+ state: State<Request, Oneshot<S, Request>>,
+ }
+}
+
+pin_project! {
+ #[project = StateProj]
+ #[derive(Debug)]
+ enum State<Request, F> {
+ Delaying {
+ #[pin]
+ delay: tokio::time::Sleep,
+ req: Option<Request>,
+ },
+ Called {
+ #[pin]
+ fut: F,
+ },
+ }
+}
+
+impl<Request, F> State<Request, F> {
+ fn delaying(delay: tokio::time::Sleep, req: Option<Request>) -> Self {
+ Self::Delaying { delay, req }
+ }
+
+ fn called(fut: F) -> Self {
+ Self::Called { fut }
+ }
+}
+
+impl<P, S> Delay<P, S> {
+ pub fn new<Request>(policy: P, service: S) -> Self
+ where
+ P: Policy<Request>,
+ S: Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+ {
+ Delay { policy, service }
+ }
+}
+
+impl<Request, P, S> Service<Request> for Delay<P, S>
+where
+ P: Policy<Request>,
+ S: Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<Request, S>;
+
+ fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // Calling self.service.poll_ready would reserve a slot for the delayed request,
+ // potentially well in advance of actually making it. Instead, signal readiness here and
+ // treat the service as a Oneshot in the future.
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ let delay = self.policy.delay(&request);
+ ResponseFuture {
+ service: Some(self.service.clone()),
+ state: State::delaying(tokio::time::sleep(delay), Some(request)),
+ }
+ }
+}
+
+impl<Request, S, T, E> Future for ResponseFuture<Request, S>
+where
+ E: Into<crate::BoxError>,
+ S: Service<Request, Response = T, Error = E>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let mut this = self.project();
+
+ loop {
+ match this.state.as_mut().project() {
+ StateProj::Delaying { delay, req } => {
+ ready!(delay.poll(cx));
+ let req = req.take().expect("Missing request in delay");
+ let svc = this.service.take().expect("Missing service in delay");
+ let fut = Oneshot::new(svc, req);
+ this.state.set(State::called(fut));
+ }
+ StateProj::Called { fut } => {
+ return fut.poll(cx).map_err(Into::into);
+ }
+ };
+ }
+ }
+}
diff --git a/crates/tower/src/hedge/latency.rs b/crates/tower/src/hedge/latency.rs
new file mode 100644
index 0000000..b1a8b24
--- /dev/null
+++ b/crates/tower/src/hedge/latency.rs
@@ -0,0 +1,89 @@
+use futures_util::ready;
+use pin_project_lite::pin_project;
+use std::time::Duration;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::time::Instant;
+use tower_service::Service;
+
+/// Record is the interface for accepting request latency measurements. When
+/// a request completes, record is called with the elapsed duration between
+/// when the service was called and when the future completed.
+pub trait Record {
+ fn record(&mut self, latency: Duration);
+}
+
+/// Latency is a middleware that measures request latency and records it to the
+/// provided Record instance.
+#[derive(Clone, Debug)]
+pub struct Latency<R, S> {
+ rec: R,
+ service: S,
+}
+
+pin_project! {
+ #[derive(Debug)]
+ pub struct ResponseFuture<R, F> {
+ start: Instant,
+ rec: R,
+ #[pin]
+ inner: F,
+ }
+}
+
+impl<S, R> Latency<R, S>
+where
+ R: Record + Clone,
+{
+ pub fn new<Request>(rec: R, service: S) -> Self
+ where
+ S: Service<Request>,
+ S::Error: Into<crate::BoxError>,
+ {
+ Latency { rec, service }
+ }
+}
+
+impl<S, R, Request> Service<Request> for Latency<R, S>
+where
+ S: Service<Request>,
+ S::Error: Into<crate::BoxError>,
+ R: Record + Clone,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<R, S::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.service.poll_ready(cx).map_err(Into::into)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ ResponseFuture {
+ start: Instant::now(),
+ rec: self.rec.clone(),
+ inner: self.service.call(request),
+ }
+ }
+}
+
+impl<R, F, T, E> Future for ResponseFuture<R, F>
+where
+ R: Record,
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+
+ let rsp = ready!(this.inner.poll(cx)).map_err(Into::into)?;
+ let duration = Instant::now().saturating_duration_since(*this.start);
+ this.rec.record(duration);
+ Poll::Ready(Ok(rsp))
+ }
+}
diff --git a/crates/tower/src/hedge/mod.rs b/crates/tower/src/hedge/mod.rs
new file mode 100644
index 0000000..3cd152e
--- /dev/null
+++ b/crates/tower/src/hedge/mod.rs
@@ -0,0 +1,266 @@
+//! Pre-emptively retry requests which have been outstanding for longer
+//! than a given latency percentile.
+
+#![warn(missing_debug_implementations, missing_docs, unreachable_pub)]
+
+use crate::filter::AsyncFilter;
+use futures_util::future;
+use pin_project_lite::pin_project;
+use std::sync::{Arc, Mutex};
+use std::time::Duration;
+use std::{
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tracing::error;
+
+mod delay;
+mod latency;
+mod rotating_histogram;
+mod select;
+
+use delay::Delay;
+use latency::Latency;
+use rotating_histogram::RotatingHistogram;
+use select::Select;
+
+type Histo = Arc<Mutex<RotatingHistogram>>;
+type Service<S, P> = select::Select<
+ SelectPolicy<P>,
+ Latency<Histo, S>,
+ Delay<DelayPolicy, AsyncFilter<Latency<Histo, S>, PolicyPredicate<P>>>,
+>;
+
+/// A middleware that pre-emptively retries requests which have been outstanding
+/// for longer than a given latency percentile. If either of the original
+/// future or the retry future completes, that value is used.
+#[derive(Debug)]
+pub struct Hedge<S, P>(Service<S, P>);
+
+pin_project! {
+ /// The [`Future`] returned by the [`Hedge`] service.
+ ///
+ /// [`Future`]: std::future::Future
+ #[derive(Debug)]
+ pub struct Future<S, Request>
+ where
+ S: tower_service::Service<Request>,
+ {
+ #[pin]
+ inner: S::Future,
+ }
+}
+
+/// A policy which describes which requests can be cloned and then whether those
+/// requests should be retried.
+pub trait Policy<Request> {
+ /// Called when the request is first received to determine if the request is retryable.
+ fn clone_request(&self, req: &Request) -> Option<Request>;
+
+ /// Called after the hedge timeout to determine if the hedge retry should be issued.
+ fn can_retry(&self, req: &Request) -> bool;
+}
+
+// NOTE: these are pub only because they appear inside a Future<F>
+
+#[doc(hidden)]
+#[derive(Clone, Debug)]
+pub struct PolicyPredicate<P>(P);
+
+#[doc(hidden)]
+#[derive(Debug)]
+pub struct DelayPolicy {
+ histo: Histo,
+ latency_percentile: f32,
+}
+
+#[doc(hidden)]
+#[derive(Debug)]
+pub struct SelectPolicy<P> {
+ policy: P,
+ histo: Histo,
+ min_data_points: u64,
+}
+
+impl<S, P> Hedge<S, P> {
+ /// Create a new hedge middleware.
+ pub fn new<Request>(
+ service: S,
+ policy: P,
+ min_data_points: u64,
+ latency_percentile: f32,
+ period: Duration,
+ ) -> Hedge<S, P>
+ where
+ S: tower_service::Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+ P: Policy<Request> + Clone,
+ {
+ let histo = Arc::new(Mutex::new(RotatingHistogram::new(period)));
+ Self::new_with_histo(service, policy, min_data_points, latency_percentile, histo)
+ }
+
+ /// A hedge middleware with a prepopulated latency histogram. This is usedful
+ /// for integration tests.
+ pub fn new_with_mock_latencies<Request>(
+ service: S,
+ policy: P,
+ min_data_points: u64,
+ latency_percentile: f32,
+ period: Duration,
+ latencies_ms: &[u64],
+ ) -> Hedge<S, P>
+ where
+ S: tower_service::Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+ P: Policy<Request> + Clone,
+ {
+ let histo = Arc::new(Mutex::new(RotatingHistogram::new(period)));
+ {
+ let mut locked = histo.lock().unwrap();
+ for latency in latencies_ms.iter() {
+ locked.read().record(*latency).unwrap();
+ }
+ }
+ Self::new_with_histo(service, policy, min_data_points, latency_percentile, histo)
+ }
+
+ fn new_with_histo<Request>(
+ service: S,
+ policy: P,
+ min_data_points: u64,
+ latency_percentile: f32,
+ histo: Histo,
+ ) -> Hedge<S, P>
+ where
+ S: tower_service::Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+ P: Policy<Request> + Clone,
+ {
+ // Clone the underlying service and wrap both copies in a middleware that
+ // records the latencies in a rotating histogram.
+ let recorded_a = Latency::new(histo.clone(), service.clone());
+ let recorded_b = Latency::new(histo.clone(), service);
+
+ // Check policy to see if the hedge request should be issued.
+ let filtered = AsyncFilter::new(recorded_b, PolicyPredicate(policy.clone()));
+
+ // Delay the second request by a percentile of the recorded request latency
+ // histogram.
+ let delay_policy = DelayPolicy {
+ histo: histo.clone(),
+ latency_percentile,
+ };
+ let delayed = Delay::new(delay_policy, filtered);
+
+ // If the request is retryable, issue two requests -- the second one delayed
+ // by a latency percentile. Use the first result to complete.
+ let select_policy = SelectPolicy {
+ policy,
+ histo,
+ min_data_points,
+ };
+ Hedge(Select::new(select_policy, recorded_a, delayed))
+ }
+}
+
+impl<S, P, Request> tower_service::Service<Request> for Hedge<S, P>
+where
+ S: tower_service::Service<Request> + Clone,
+ S::Error: Into<crate::BoxError>,
+ P: Policy<Request> + Clone,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = Future<Service<S, P>, Request>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.0.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ Future {
+ inner: self.0.call(request),
+ }
+ }
+}
+
+impl<S, Request> std::future::Future for Future<S, Request>
+where
+ S: tower_service::Service<Request>,
+ S::Error: Into<crate::BoxError>,
+{
+ type Output = Result<S::Response, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ self.project().inner.poll(cx).map_err(Into::into)
+ }
+}
+
+// TODO: Remove when Duration::as_millis() becomes stable.
+const NANOS_PER_MILLI: u32 = 1_000_000;
+const MILLIS_PER_SEC: u64 = 1_000;
+fn millis(duration: Duration) -> u64 {
+ // Round up.
+ let millis = (duration.subsec_nanos() + NANOS_PER_MILLI - 1) / NANOS_PER_MILLI;
+ duration
+ .as_secs()
+ .saturating_mul(MILLIS_PER_SEC)
+ .saturating_add(u64::from(millis))
+}
+
+impl latency::Record for Histo {
+ fn record(&mut self, latency: Duration) {
+ let mut locked = self.lock().unwrap();
+ locked.write().record(millis(latency)).unwrap_or_else(|e| {
+ error!("Failed to write to hedge histogram: {:?}", e);
+ })
+ }
+}
+
+impl<P, Request> crate::filter::AsyncPredicate<Request> for PolicyPredicate<P>
+where
+ P: Policy<Request>,
+{
+ type Future = future::Either<
+ future::Ready<Result<Request, crate::BoxError>>,
+ future::Pending<Result<Request, crate::BoxError>>,
+ >;
+ type Request = Request;
+
+ fn check(&mut self, request: Request) -> Self::Future {
+ if self.0.can_retry(&request) {
+ future::Either::Left(future::ready(Ok(request)))
+ } else {
+ // If the hedge retry should not be issued, we simply want to wait
+ // for the result of the original request. Therefore we don't want
+ // to return an error here. Instead, we use future::pending to ensure
+ // that the original request wins the select.
+ future::Either::Right(future::pending())
+ }
+ }
+}
+
+impl<Request> delay::Policy<Request> for DelayPolicy {
+ fn delay(&self, _req: &Request) -> Duration {
+ let mut locked = self.histo.lock().unwrap();
+ let millis = locked
+ .read()
+ .value_at_quantile(self.latency_percentile.into());
+ Duration::from_millis(millis)
+ }
+}
+
+impl<P, Request> select::Policy<Request> for SelectPolicy<P>
+where
+ P: Policy<Request>,
+{
+ fn clone_request(&self, req: &Request) -> Option<Request> {
+ self.policy.clone_request(req).filter(|_| {
+ let mut locked = self.histo.lock().unwrap();
+ // Do not attempt a retry if there are insufficiently many data
+ // points in the histogram.
+ locked.read().len() >= self.min_data_points
+ })
+ }
+}
diff --git a/crates/tower/src/hedge/rotating_histogram.rs b/crates/tower/src/hedge/rotating_histogram.rs
new file mode 100644
index 0000000..4b07a15
--- /dev/null
+++ b/crates/tower/src/hedge/rotating_histogram.rs
@@ -0,0 +1,73 @@
+use hdrhistogram::Histogram;
+use std::time::Duration;
+use tokio::time::Instant;
+use tracing::trace;
+
+/// This represents a "rotating" histogram which stores two histogram, one which
+/// should be read and one which should be written to. Every period, the read
+/// histogram is discarded and replaced by the write histogram. The idea here
+/// is that the read histogram should always contain a full period (the previous
+/// period) of write operations.
+#[derive(Debug)]
+pub struct RotatingHistogram {
+ read: Histogram<u64>,
+ write: Histogram<u64>,
+ last_rotation: Instant,
+ period: Duration,
+}
+
+impl RotatingHistogram {
+ pub fn new(period: Duration) -> RotatingHistogram {
+ RotatingHistogram {
+ // Use an auto-resizing histogram to avoid choosing
+ // a maximum latency bound for all users.
+ read: Histogram::<u64>::new(3).expect("Invalid histogram params"),
+ write: Histogram::<u64>::new(3).expect("Invalid histogram params"),
+ last_rotation: Instant::now(),
+ period,
+ }
+ }
+
+ pub fn read(&mut self) -> &mut Histogram<u64> {
+ self.maybe_rotate();
+ &mut self.read
+ }
+
+ pub fn write(&mut self) -> &mut Histogram<u64> {
+ self.maybe_rotate();
+ &mut self.write
+ }
+
+ fn maybe_rotate(&mut self) {
+ let delta = Instant::now().saturating_duration_since(self.last_rotation);
+ // TODO: replace with delta.duration_div when it becomes stable.
+ let rotations = (nanos(delta) / nanos(self.period)) as u32;
+ if rotations >= 2 {
+ trace!("Time since last rotation is {:?}. clearing!", delta);
+ self.clear();
+ } else if rotations == 1 {
+ trace!("Time since last rotation is {:?}. rotating!", delta);
+ self.rotate();
+ }
+ self.last_rotation += self.period * rotations;
+ }
+
+ fn rotate(&mut self) {
+ std::mem::swap(&mut self.read, &mut self.write);
+ trace!("Rotated {:?} points into read", self.read.len());
+ self.write.clear();
+ }
+
+ fn clear(&mut self) {
+ self.read.clear();
+ self.write.clear();
+ }
+}
+
+const NANOS_PER_SEC: u64 = 1_000_000_000;
+fn nanos(duration: Duration) -> u64 {
+ duration
+ .as_secs()
+ .saturating_mul(NANOS_PER_SEC)
+ .saturating_add(u64::from(duration.subsec_nanos()))
+}
diff --git a/crates/tower/src/hedge/select.rs b/crates/tower/src/hedge/select.rs
new file mode 100644
index 0000000..5d1573c
--- /dev/null
+++ b/crates/tower/src/hedge/select.rs
@@ -0,0 +1,105 @@
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+/// A policy which decides which requests can be cloned and sent to the B
+/// service.
+pub trait Policy<Request> {
+ fn clone_request(&self, req: &Request) -> Option<Request>;
+}
+
+/// Select is a middleware which attempts to clone the request and sends the
+/// original request to the A service and, if the request was able to be cloned,
+/// the cloned request to the B service. Both resulting futures will be polled
+/// and whichever future completes first will be used as the result.
+#[derive(Debug)]
+pub struct Select<P, A, B> {
+ policy: P,
+ a: A,
+ b: B,
+}
+
+pin_project! {
+ #[derive(Debug)]
+ pub struct ResponseFuture<AF, BF> {
+ #[pin]
+ a_fut: AF,
+ #[pin]
+ b_fut: Option<BF>,
+ }
+}
+
+impl<P, A, B> Select<P, A, B> {
+ pub fn new<Request>(policy: P, a: A, b: B) -> Self
+ where
+ P: Policy<Request>,
+ A: Service<Request>,
+ A::Error: Into<crate::BoxError>,
+ B: Service<Request, Response = A::Response>,
+ B::Error: Into<crate::BoxError>,
+ {
+ Select { policy, a, b }
+ }
+}
+
+impl<P, A, B, Request> Service<Request> for Select<P, A, B>
+where
+ P: Policy<Request>,
+ A: Service<Request>,
+ A::Error: Into<crate::BoxError>,
+ B: Service<Request, Response = A::Response>,
+ B::Error: Into<crate::BoxError>,
+{
+ type Response = A::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<A::Future, B::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ match (self.a.poll_ready(cx), self.b.poll_ready(cx)) {
+ (Poll::Ready(Ok(())), Poll::Ready(Ok(()))) => Poll::Ready(Ok(())),
+ (Poll::Ready(Err(e)), _) => Poll::Ready(Err(e.into())),
+ (_, Poll::Ready(Err(e))) => Poll::Ready(Err(e.into())),
+ _ => Poll::Pending,
+ }
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ let b_fut = if let Some(cloned_req) = self.policy.clone_request(&request) {
+ Some(self.b.call(cloned_req))
+ } else {
+ None
+ };
+ ResponseFuture {
+ a_fut: self.a.call(request),
+ b_fut,
+ }
+ }
+}
+
+impl<AF, BF, T, AE, BE> Future for ResponseFuture<AF, BF>
+where
+ AF: Future<Output = Result<T, AE>>,
+ AE: Into<crate::BoxError>,
+ BF: Future<Output = Result<T, BE>>,
+ BE: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+
+ if let Poll::Ready(r) = this.a_fut.poll(cx) {
+ return Poll::Ready(Ok(r.map_err(Into::into)?));
+ }
+ if let Some(b_fut) = this.b_fut.as_pin_mut() {
+ if let Poll::Ready(r) = b_fut.poll(cx) {
+ return Poll::Ready(Ok(r.map_err(Into::into)?));
+ }
+ }
+ Poll::Pending
+ }
+}
diff --git a/crates/tower/src/layer.rs b/crates/tower/src/layer.rs
new file mode 100644
index 0000000..3c40c6e
--- /dev/null
+++ b/crates/tower/src/layer.rs
@@ -0,0 +1,14 @@
+//! A collection of [`Layer`] based tower services
+//!
+//! [`Layer`]: crate::Layer
+
+pub use tower_layer::{layer_fn, Layer, LayerFn};
+
+/// Utilities for combining layers
+///
+/// [`Identity`]: crate::layer::util::Identity
+/// [`Layer`]: crate::Layer
+/// [`Stack`]: crate::layer::util::Stack
+pub mod util {
+ pub use tower_layer::{Identity, Stack};
+}
diff --git a/crates/tower/src/lib.rs b/crates/tower/src/lib.rs
new file mode 100644
index 0000000..10230b8
--- /dev/null
+++ b/crates/tower/src/lib.rs
@@ -0,0 +1,242 @@
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub
+)]
+#![forbid(unsafe_code)]
+#![allow(elided_lifetimes_in_paths, clippy::type_complexity)]
+#![cfg_attr(test, allow(clippy::float_cmp))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+// `rustdoc::broken_intra_doc_links` is checked on CI
+
+//! `async fn(Request) -> Result<Response, Error>`
+//!
+//! # Overview
+//!
+//! Tower is a library of modular and reusable components for building
+//! robust networking clients and servers.
+//!
+//! Tower provides a simple core abstraction, the [`Service`] trait, which
+//! represents an asynchronous function taking a request and returning either a
+//! response or an error. This abstraction can be used to model both clients and
+//! servers.
+//!
+//! Generic components, like [timeouts], [rate limiting], and [load balancing],
+//! can be modeled as [`Service`]s that wrap some inner service and apply
+//! additional behavior before or after the inner service is called. This allows
+//! implementing these components in a protocol-agnostic, composable way. Typically,
+//! such services are referred to as _middleware_.
+//!
+//! An additional abstraction, the [`Layer`] trait, is used to compose
+//! middleware with [`Service`]s. If a [`Service`] can be thought of as an
+//! asynchronous function from a request type to a response type, a [`Layer`] is
+//! a function taking a [`Service`] of one type and returning a [`Service`] of a
+//! different type. The [`ServiceBuilder`] type is used to add middleware to a
+//! service by composing it with multiple [`Layer`]s.
+//!
+//! ## The Tower Ecosystem
+//!
+//! Tower is made up of the following crates:
+//!
+//! * [`tower`] (this crate)
+//! * [`tower-service`]
+//! * [`tower-layer`]
+//! * [`tower-test`]
+//!
+//! Since the [`Service`] and [`Layer`] traits are important integration points
+//! for all libraries using Tower, they are kept as stable as possible, and
+//! breaking changes are made rarely. Therefore, they are defined in separate
+//! crates, [`tower-service`] and [`tower-layer`]. This crate contains
+//! re-exports of those core traits, implementations of commonly-used
+//! middleware, and [utilities] for working with [`Service`]s and [`Layer`]s.
+//! Finally, the [`tower-test`] crate provides tools for testing programs using
+//! Tower.
+//!
+//! # Usage
+//!
+//! Tower provides an abstraction layer, and generic implementations of various
+//! middleware. This means that the `tower` crate on its own does *not* provide
+//! a working implementation of a network client or server. Instead, Tower's
+//! [`Service` trait][`Service`] provides an integration point between
+//! application code, libraries providing middleware implementations, and
+//! libraries that implement servers and/or clients for various network
+//! protocols.
+//!
+//! Depending on your particular use case, you might use Tower in several ways:
+//!
+//! * **Implementing application logic** for a networked program. You might
+//! use the [`Service`] trait to model your application's behavior, and use
+//! the middleware [provided by this crate](#modules) and by other libraries
+//! to add functionality to clients and servers provided by one or more
+//! protocol implementations.
+//! * **Implementing middleware** to add custom behavior to network clients and
+//! servers in a reusable manner. This might be general-purpose middleware
+//! (and if it is, please consider releasing your middleware as a library for
+//! other Tower users!) or application-specific behavior that needs to be
+//! shared between multiple clients or servers.
+//! * **Implementing a network protocol**. Libraries that implement network
+//! protocols (such as HTTP) can depend on `tower-service` to use the
+//! [`Service`] trait as an integration point between the protocol and user
+//! code. For example, a client for some protocol might implement [`Service`],
+//! allowing users to add arbitrary Tower middleware to those clients.
+//! Similarly, a server might be created from a user-provided [`Service`].
+//!
+//! Additionally, when a network protocol requires functionality already
+//! provided by existing Tower middleware, a protocol implementation might use
+//! Tower middleware internally, as well as as an integration point.
+//!
+//! ## Library Support
+//!
+//! A number of third-party libraries support Tower and the [`Service`] trait.
+//! The following is an incomplete list of such libraries:
+//!
+//! * [`hyper`]: A fast and correct low-level HTTP implementation.
+//! * [`tonic`]: A [gRPC-over-HTTP/2][grpc] implementation built on top of
+//! [`hyper`]. See [here][tonic-examples] for examples of using [`tonic`] with
+//! Tower.
+//! * [`warp`]: A lightweight, composable web framework. See
+//! [here][warp-service] for details on using [`warp`] with Tower.
+//! * [`tower-lsp`] and its fork, [`lspower`]: implementations of the [Language
+//! Server Protocol][lsp] based on Tower.
+//!
+//! [`hyper`]: https://crates.io/crates/hyper
+//! [`tonic`]: https://crates.io/crates/tonic
+//! [tonic-examples]: https://github.com/hyperium/tonic/tree/master/examples/src/tower
+//! [grpc]: https://grpc.io
+//! [`warp`]: https://crates.io/crates/warp
+//! [warp-service]: https://docs.rs/warp/0.2.5/warp/fn.service.html
+//! [`tower-lsp`]: https://crates.io/crates/tower-lsp
+//! [`lspower`]: https://crates.io/crates/lspower
+//! [lsp]: https://microsoft.github.io/language-server-protocol/
+//!
+//! If you're the maintainer of a crate that supports Tower, we'd love to add
+//! your crate to this list! Please [open a PR] adding a brief description of
+//! your library!
+//!
+//! ## Getting Started
+//!
+//! If you're brand new to Tower and want to start with the basics, we recommend you
+//! check out some of our [guides].
+//!
+//! The various middleware implementations provided by this crate are feature
+//! flagged, so that users can only compile the parts of Tower they need. By
+//! default, all the optional middleware are disabled.
+//!
+//! To get started using all of Tower's optional middleware, add this to your
+//! `Cargo.toml`:
+//!
+//! ```toml
+//! tower = { version = "0.4", features = ["full"] }
+//! ```
+//!
+//! Alternatively, you can only enable some features. For example, to enable
+//! only the [`retry`] and [`timeout`][timeouts] middleware, write:
+//!
+//! ```toml
+//! tower = { version = "0.4", features = ["retry", "timeout"] }
+//! ```
+//!
+//! See [here](#modules) for a complete list of all middleware provided by
+//! Tower.
+//!
+//!
+//! ## Supported Rust Versions
+//!
+//! Tower will keep a rolling MSRV (minimum supported Rust version) policy of **at
+//! least** 6 months. When increasing the MSRV, the new Rust version must have been
+//! released at least six months ago. The current MSRV is 1.49.0.
+//!
+//! [`Service`]: crate::Service
+//! [`Layer`]: crate::Layer
+//! [timeouts]: crate::timeout
+//! [rate limiting]: crate::limit::rate
+//! [load balancing]: crate::balance
+//! [`ServiceBuilder`]: crate::ServiceBuilder
+//! [utilities]: crate::ServiceExt
+//! [`tower`]: https://crates.io/crates/tower
+//! [`tower-service`]: https://crates.io/crates/tower-service
+//! [`tower-layer`]: https://crates.io/crates/tower-layer
+//! [`tower-test`]: https://crates.io/crates/tower-test
+//! [`retry`]: crate::retry
+//! [open a PR]: https://github.com/tower-rs/tower/compare
+//! [guides]: https://github.com/tower-rs/tower/tree/master/guides
+
+#[macro_use]
+pub(crate) mod macros;
+#[cfg(feature = "balance")]
+#[cfg_attr(docsrs, doc(cfg(feature = "balance")))]
+pub mod balance;
+#[cfg(feature = "buffer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "buffer")))]
+pub mod buffer;
+#[cfg(feature = "discover")]
+#[cfg_attr(docsrs, doc(cfg(feature = "discover")))]
+pub mod discover;
+#[cfg(feature = "filter")]
+#[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
+pub mod filter;
+#[cfg(feature = "hedge")]
+#[cfg_attr(docsrs, doc(cfg(feature = "hedge")))]
+pub mod hedge;
+#[cfg(feature = "limit")]
+#[cfg_attr(docsrs, doc(cfg(feature = "limit")))]
+pub mod limit;
+#[cfg(feature = "load")]
+#[cfg_attr(docsrs, doc(cfg(feature = "load")))]
+pub mod load;
+#[cfg(feature = "load-shed")]
+#[cfg_attr(docsrs, doc(cfg(feature = "load-shed")))]
+pub mod load_shed;
+
+#[cfg(feature = "make")]
+#[cfg_attr(docsrs, doc(cfg(feature = "make")))]
+pub mod make;
+#[cfg(feature = "ready-cache")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ready-cache")))]
+pub mod ready_cache;
+#[cfg(feature = "reconnect")]
+#[cfg_attr(docsrs, doc(cfg(feature = "reconnect")))]
+pub mod reconnect;
+#[cfg(feature = "retry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "retry")))]
+pub mod retry;
+#[cfg(feature = "spawn-ready")]
+#[cfg_attr(docsrs, doc(cfg(feature = "spawn-ready")))]
+pub mod spawn_ready;
+#[cfg(feature = "steer")]
+#[cfg_attr(docsrs, doc(cfg(feature = "steer")))]
+pub mod steer;
+#[cfg(feature = "timeout")]
+#[cfg_attr(docsrs, doc(cfg(feature = "timeout")))]
+pub mod timeout;
+#[cfg(feature = "util")]
+#[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+pub mod util;
+
+pub mod builder;
+pub mod layer;
+
+#[cfg(feature = "util")]
+#[cfg_attr(docsrs, doc(cfg(feature = "util")))]
+#[doc(inline)]
+pub use self::util::{service_fn, ServiceExt};
+
+#[doc(inline)]
+pub use crate::builder::ServiceBuilder;
+#[cfg(feature = "make")]
+#[cfg_attr(docsrs, doc(cfg(feature = "make")))]
+#[doc(inline)]
+pub use crate::make::MakeService;
+#[doc(inline)]
+pub use tower_layer::Layer;
+#[doc(inline)]
+pub use tower_service::Service;
+
+#[allow(unreachable_pub)]
+mod sealed {
+ pub trait Sealed<T> {}
+}
+
+/// Alias for a type-erased error type.
+pub type BoxError = Box<dyn std::error::Error + Send + Sync>;
diff --git a/crates/tower/src/limit/concurrency/future.rs b/crates/tower/src/limit/concurrency/future.rs
new file mode 100644
index 0000000..6eb0100
--- /dev/null
+++ b/crates/tower/src/limit/concurrency/future.rs
@@ -0,0 +1,41 @@
+//! [`Future`] types
+//!
+//! [`Future`]: std::future::Future
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::sync::OwnedSemaphorePermit;
+
+pin_project! {
+ /// Future for the [`ConcurrencyLimit`] service.
+ ///
+ /// [`ConcurrencyLimit`]: crate::limit::ConcurrencyLimit
+ #[derive(Debug)]
+ pub struct ResponseFuture<T> {
+ #[pin]
+ inner: T,
+ // Keep this around so that it is dropped when the future completes
+ _permit: OwnedSemaphorePermit,
+ }
+}
+
+impl<T> ResponseFuture<T> {
+ pub(crate) fn new(inner: T, _permit: OwnedSemaphorePermit) -> ResponseFuture<T> {
+ ResponseFuture { inner, _permit }
+ }
+}
+
+impl<F, T, E> Future for ResponseFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+{
+ type Output = Result<T, E>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ Poll::Ready(ready!(self.project().inner.poll(cx)))
+ }
+}
diff --git a/crates/tower/src/limit/concurrency/layer.rs b/crates/tower/src/limit/concurrency/layer.rs
new file mode 100644
index 0000000..1966d57
--- /dev/null
+++ b/crates/tower/src/limit/concurrency/layer.rs
@@ -0,0 +1,60 @@
+use std::sync::Arc;
+
+use super::ConcurrencyLimit;
+use tokio::sync::Semaphore;
+use tower_layer::Layer;
+
+/// Enforces a limit on the concurrent number of requests the underlying
+/// service can handle.
+#[derive(Debug, Clone)]
+pub struct ConcurrencyLimitLayer {
+ max: usize,
+}
+
+impl ConcurrencyLimitLayer {
+ /// Create a new concurrency limit layer.
+ pub fn new(max: usize) -> Self {
+ ConcurrencyLimitLayer { max }
+ }
+}
+
+impl<S> Layer<S> for ConcurrencyLimitLayer {
+ type Service = ConcurrencyLimit<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ ConcurrencyLimit::new(service, self.max)
+ }
+}
+
+/// Enforces a limit on the concurrent number of requests the underlying
+/// service can handle.
+///
+/// Unlike [`ConcurrencyLimitLayer`], which enforces a per-service concurrency
+/// limit, this layer accepts a owned semaphore (`Arc<Semaphore>`) which can be
+/// shared across multiple services.
+///
+/// Cloning this layer will not create a new semaphore.
+#[derive(Debug, Clone)]
+pub struct GlobalConcurrencyLimitLayer {
+ semaphore: Arc<Semaphore>,
+}
+
+impl GlobalConcurrencyLimitLayer {
+ /// Create a new `GlobalConcurrencyLimitLayer`.
+ pub fn new(max: usize) -> Self {
+ Self::with_semaphore(Arc::new(Semaphore::new(max)))
+ }
+
+ /// Create a new `GlobalConcurrencyLimitLayer` from a `Arc<Semaphore>`
+ pub fn with_semaphore(semaphore: Arc<Semaphore>) -> Self {
+ GlobalConcurrencyLimitLayer { semaphore }
+ }
+}
+
+impl<S> Layer<S> for GlobalConcurrencyLimitLayer {
+ type Service = ConcurrencyLimit<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ ConcurrencyLimit::with_semaphore(service, self.semaphore.clone())
+ }
+}
diff --git a/crates/tower/src/limit/concurrency/mod.rs b/crates/tower/src/limit/concurrency/mod.rs
new file mode 100644
index 0000000..ac0be8a
--- /dev/null
+++ b/crates/tower/src/limit/concurrency/mod.rs
@@ -0,0 +1,10 @@
+//! Limit the max number of requests being concurrently processed.
+
+pub mod future;
+mod layer;
+mod service;
+
+pub use self::{
+ layer::{ConcurrencyLimitLayer, GlobalConcurrencyLimitLayer},
+ service::ConcurrencyLimit,
+};
diff --git a/crates/tower/src/limit/concurrency/never.rs b/crates/tower/src/limit/concurrency/never.rs
new file mode 100644
index 0000000..3bb12aa
--- /dev/null
+++ b/crates/tower/src/limit/concurrency/never.rs
@@ -0,0 +1,12 @@
+use std::fmt;
+#[derive(Debug)]
+/// An error that can never occur.
+pub enum Never {}
+
+impl fmt::Display for Never {
+ fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result {
+ match *self {}
+ }
+}
+
+impl std::error::Error for Never {}
diff --git a/crates/tower/src/limit/concurrency/service.rs b/crates/tower/src/limit/concurrency/service.rs
new file mode 100644
index 0000000..02d8534
--- /dev/null
+++ b/crates/tower/src/limit/concurrency/service.rs
@@ -0,0 +1,119 @@
+use super::future::ResponseFuture;
+use tokio::sync::{OwnedSemaphorePermit, Semaphore};
+use tokio_util::sync::PollSemaphore;
+use tower_service::Service;
+
+use futures_core::ready;
+use std::{
+ sync::Arc,
+ task::{Context, Poll},
+};
+
+/// Enforces a limit on the concurrent number of requests the underlying
+/// service can handle.
+#[derive(Debug)]
+pub struct ConcurrencyLimit<T> {
+ inner: T,
+ semaphore: PollSemaphore,
+ /// The currently acquired semaphore permit, if there is sufficient
+ /// concurrency to send a new request.
+ ///
+ /// The permit is acquired in `poll_ready`, and taken in `call` when sending
+ /// a new request.
+ permit: Option<OwnedSemaphorePermit>,
+}
+
+impl<T> ConcurrencyLimit<T> {
+ /// Create a new concurrency limiter.
+ pub fn new(inner: T, max: usize) -> Self {
+ Self::with_semaphore(inner, Arc::new(Semaphore::new(max)))
+ }
+
+ /// Create a new concurrency limiter with a provided shared semaphore
+ pub fn with_semaphore(inner: T, semaphore: Arc<Semaphore>) -> Self {
+ ConcurrencyLimit {
+ inner,
+ semaphore: PollSemaphore::new(semaphore),
+ permit: None,
+ }
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<S, Request> Service<Request> for ConcurrencyLimit<S>
+where
+ S: Service<Request>,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = ResponseFuture<S::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // If we haven't already acquired a permit from the semaphore, try to
+ // acquire one first.
+ if self.permit.is_none() {
+ self.permit = ready!(self.semaphore.poll_acquire(cx));
+ debug_assert!(
+ self.permit.is_some(),
+ "ConcurrencyLimit semaphore is never closed, so `poll_acquire` \
+ should never fail",
+ );
+ }
+
+ // Once we've acquired a permit (or if we already had one), poll the
+ // inner service.
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ // Take the permit
+ let permit = self
+ .permit
+ .take()
+ .expect("max requests in-flight; poll_ready must be called first");
+
+ // Call the inner service
+ let future = self.inner.call(request);
+
+ ResponseFuture::new(future, permit)
+ }
+}
+
+impl<T: Clone> Clone for ConcurrencyLimit<T> {
+ fn clone(&self) -> Self {
+ // Since we hold an `OwnedSemaphorePermit`, we can't derive `Clone`.
+ // Instead, when cloning the service, create a new service with the
+ // same semaphore, but with the permit in the un-acquired state.
+ Self {
+ inner: self.inner.clone(),
+ semaphore: self.semaphore.clone(),
+ permit: None,
+ }
+ }
+}
+
+#[cfg(feature = "load")]
+#[cfg_attr(docsrs, doc(cfg(feature = "load")))]
+impl<S> crate::load::Load for ConcurrencyLimit<S>
+where
+ S: crate::load::Load,
+{
+ type Metric = S::Metric;
+ fn load(&self) -> Self::Metric {
+ self.inner.load()
+ }
+}
diff --git a/crates/tower/src/limit/mod.rs b/crates/tower/src/limit/mod.rs
new file mode 100644
index 0000000..6a10dca
--- /dev/null
+++ b/crates/tower/src/limit/mod.rs
@@ -0,0 +1,9 @@
+//! Tower middleware for limiting requests.
+
+pub mod concurrency;
+pub mod rate;
+
+pub use self::{
+ concurrency::{ConcurrencyLimit, ConcurrencyLimitLayer, GlobalConcurrencyLimitLayer},
+ rate::{RateLimit, RateLimitLayer},
+};
diff --git a/crates/tower/src/limit/rate/layer.rs b/crates/tower/src/limit/rate/layer.rs
new file mode 100644
index 0000000..9051ddd
--- /dev/null
+++ b/crates/tower/src/limit/rate/layer.rs
@@ -0,0 +1,26 @@
+use super::{Rate, RateLimit};
+use std::time::Duration;
+use tower_layer::Layer;
+
+/// Enforces a rate limit on the number of requests the underlying
+/// service can handle over a period of time.
+#[derive(Debug, Clone)]
+pub struct RateLimitLayer {
+ rate: Rate,
+}
+
+impl RateLimitLayer {
+ /// Create new rate limit layer.
+ pub fn new(num: u64, per: Duration) -> Self {
+ let rate = Rate::new(num, per);
+ RateLimitLayer { rate }
+ }
+}
+
+impl<S> Layer<S> for RateLimitLayer {
+ type Service = RateLimit<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ RateLimit::new(service, self.rate)
+ }
+}
diff --git a/crates/tower/src/limit/rate/mod.rs b/crates/tower/src/limit/rate/mod.rs
new file mode 100644
index 0000000..52b179b
--- /dev/null
+++ b/crates/tower/src/limit/rate/mod.rs
@@ -0,0 +1,8 @@
+//! Limit the rate at which requests are processed.
+
+mod layer;
+#[allow(clippy::module_inception)]
+mod rate;
+mod service;
+
+pub use self::{layer::RateLimitLayer, rate::Rate, service::RateLimit};
diff --git a/crates/tower/src/limit/rate/rate.rs b/crates/tower/src/limit/rate/rate.rs
new file mode 100644
index 0000000..d0736f4
--- /dev/null
+++ b/crates/tower/src/limit/rate/rate.rs
@@ -0,0 +1,30 @@
+use std::time::Duration;
+
+/// A rate of requests per time period.
+#[derive(Debug, Copy, Clone)]
+pub struct Rate {
+ num: u64,
+ per: Duration,
+}
+
+impl Rate {
+ /// Create a new rate.
+ ///
+ /// # Panics
+ ///
+ /// This function panics if `num` or `per` is 0.
+ pub fn new(num: u64, per: Duration) -> Self {
+ assert!(num > 0);
+ assert!(per > Duration::from_millis(0));
+
+ Rate { num, per }
+ }
+
+ pub(crate) fn num(&self) -> u64 {
+ self.num
+ }
+
+ pub(crate) fn per(&self) -> Duration {
+ self.per
+ }
+}
diff --git a/crates/tower/src/limit/rate/service.rs b/crates/tower/src/limit/rate/service.rs
new file mode 100644
index 0000000..b760460
--- /dev/null
+++ b/crates/tower/src/limit/rate/service.rs
@@ -0,0 +1,131 @@
+use super::Rate;
+use futures_core::ready;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::time::{Instant, Sleep};
+use tower_service::Service;
+
+/// Enforces a rate limit on the number of requests the underlying
+/// service can handle over a period of time.
+#[derive(Debug)]
+pub struct RateLimit<T> {
+ inner: T,
+ rate: Rate,
+ state: State,
+ sleep: Pin<Box<Sleep>>,
+}
+
+#[derive(Debug)]
+enum State {
+ // The service has hit its limit
+ Limited,
+ Ready { until: Instant, rem: u64 },
+}
+
+impl<T> RateLimit<T> {
+ /// Create a new rate limiter
+ pub fn new(inner: T, rate: Rate) -> Self {
+ let until = Instant::now();
+ let state = State::Ready {
+ until,
+ rem: rate.num(),
+ };
+
+ RateLimit {
+ inner,
+ rate,
+ state,
+ // The sleep won't actually be used with this duration, but
+ // we create it eagerly so that we can reset it in place rather than
+ // `Box::pin`ning a new `Sleep` every time we need one.
+ sleep: Box::pin(tokio::time::sleep_until(until)),
+ }
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<S, Request> Service<Request> for RateLimit<S>
+where
+ S: Service<Request>,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ match self.state {
+ State::Ready { .. } => return Poll::Ready(ready!(self.inner.poll_ready(cx))),
+ State::Limited => {
+ if Pin::new(&mut self.sleep).poll(cx).is_pending() {
+ tracing::trace!("rate limit exceeded; sleeping.");
+ return Poll::Pending;
+ }
+ }
+ }
+
+ self.state = State::Ready {
+ until: Instant::now() + self.rate.per(),
+ rem: self.rate.num(),
+ };
+
+ Poll::Ready(ready!(self.inner.poll_ready(cx)))
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ match self.state {
+ State::Ready { mut until, mut rem } => {
+ let now = Instant::now();
+
+ // If the period has elapsed, reset it.
+ if now >= until {
+ until = now + self.rate.per();
+ rem = self.rate.num();
+ }
+
+ if rem > 1 {
+ rem -= 1;
+ self.state = State::Ready { until, rem };
+ } else {
+ // The service is disabled until further notice
+ // Reset the sleep future in place, so that we don't have to
+ // deallocate the existing box and allocate a new one.
+ self.sleep.as_mut().reset(until);
+ self.state = State::Limited;
+ }
+
+ // Call the inner future
+ self.inner.call(request)
+ }
+ State::Limited => panic!("service not ready; poll_ready must be called first"),
+ }
+ }
+}
+
+#[cfg(feature = "load")]
+#[cfg_attr(docsrs, doc(cfg(feature = "load")))]
+impl<S> crate::load::Load for RateLimit<S>
+where
+ S: crate::load::Load,
+{
+ type Metric = S::Metric;
+ fn load(&self) -> Self::Metric {
+ self.inner.load()
+ }
+}
diff --git a/crates/tower/src/load/completion.rs b/crates/tower/src/load/completion.rs
new file mode 100644
index 0000000..3c14a7f
--- /dev/null
+++ b/crates/tower/src/load/completion.rs
@@ -0,0 +1,95 @@
+//! Application-specific request completion semantics.
+
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+/// Attaches `H`-typed completion tracker to `V` typed values.
+///
+/// Handles (of type `H`) are intended to be RAII guards that primarily implement [`Drop`] and update
+/// load metric state as they are dropped. This trait allows implementors to "forward" the handle
+/// to later parts of the request-handling pipeline, so that the handle is only dropped when the
+/// request has truly completed.
+///
+/// This utility allows load metrics to have a protocol-agnostic means to track streams past their
+/// initial response future. For example, if `V` represents an HTTP response type, an
+/// implementation could add `H`-typed handles to each response's extensions to detect when all the
+/// response's extensions have been dropped.
+///
+/// A base `impl<H, V> TrackCompletion<H, V> for CompleteOnResponse` is provided to drop the handle
+/// once the response future is resolved. This is appropriate when a response is discrete and
+/// cannot comprise multiple messages.
+///
+/// In many cases, the `Output` type is simply `V`. However, [`TrackCompletion`] may alter the type
+/// in order to instrument it appropriately. For example, an HTTP [`TrackCompletion`] may modify
+/// the body type: so a [`TrackCompletion`] that takes values of type
+/// [`http::Response<A>`][response] may output values of type [`http::Response<B>`][response].
+///
+/// [response]: https://docs.rs/http/latest/http/response/struct.Response.html
+pub trait TrackCompletion<H, V>: Clone {
+ /// The instrumented value type.
+ type Output;
+
+ /// Attaches a `H`-typed handle to a `V`-typed value.
+ fn track_completion(&self, handle: H, value: V) -> Self::Output;
+}
+
+/// A [`TrackCompletion`] implementation that considers the request completed when the response
+/// future is resolved.
+#[derive(Clone, Copy, Debug, Default)]
+#[non_exhaustive]
+pub struct CompleteOnResponse;
+
+pin_project! {
+ /// Attaches a `C`-typed completion tracker to the result of an `F`-typed [`Future`].
+ #[derive(Debug)]
+ pub struct TrackCompletionFuture<F, C, H> {
+ #[pin]
+ future: F,
+ handle: Option<H>,
+ completion: C,
+ }
+}
+
+// ===== impl InstrumentFuture =====
+
+impl<F, C, H> TrackCompletionFuture<F, C, H> {
+ /// Wraps a future, propagating the tracker into its value if successful.
+ pub fn new(completion: C, handle: H, future: F) -> Self {
+ TrackCompletionFuture {
+ future,
+ completion,
+ handle: Some(handle),
+ }
+ }
+}
+
+impl<F, C, H, T, E> Future for TrackCompletionFuture<F, C, H>
+where
+ F: Future<Output = Result<T, E>>,
+ C: TrackCompletion<H, T>,
+{
+ type Output = Result<C::Output, E>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+ let rsp = ready!(this.future.poll(cx))?;
+ let h = this.handle.take().expect("handle");
+ Poll::Ready(Ok(this.completion.track_completion(h, rsp)))
+ }
+}
+
+// ===== CompleteOnResponse =====
+
+impl<H, V> TrackCompletion<H, V> for CompleteOnResponse {
+ type Output = V;
+
+ fn track_completion(&self, handle: H, value: V) -> V {
+ drop(handle);
+ value
+ }
+}
diff --git a/crates/tower/src/load/constant.rs b/crates/tower/src/load/constant.rs
new file mode 100644
index 0000000..a7c874e
--- /dev/null
+++ b/crates/tower/src/load/constant.rs
@@ -0,0 +1,80 @@
+//! A constant [`Load`] implementation.
+
+#[cfg(feature = "discover")]
+use crate::discover::{Change, Discover};
+#[cfg(feature = "discover")]
+use futures_core::{ready, Stream};
+#[cfg(feature = "discover")]
+use std::pin::Pin;
+
+use super::Load;
+use pin_project_lite::pin_project;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+pin_project! {
+ #[derive(Debug)]
+ /// Wraps a type so that it implements [`Load`] and returns a constant load metric.
+ ///
+ /// This load estimator is primarily useful for testing.
+ pub struct Constant<T, M> {
+ inner: T,
+ load: M,
+ }
+}
+
+// ===== impl Constant =====
+
+impl<T, M: Copy> Constant<T, M> {
+ /// Wraps a `T`-typed service with a constant `M`-typed load metric.
+ pub fn new(inner: T, load: M) -> Self {
+ Self { inner, load }
+ }
+}
+
+impl<T, M: Copy + PartialOrd> Load for Constant<T, M> {
+ type Metric = M;
+
+ fn load(&self) -> M {
+ self.load
+ }
+}
+
+impl<S, M, Request> Service<Request> for Constant<S, M>
+where
+ S: Service<Request>,
+ M: Copy,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, req: Request) -> Self::Future {
+ self.inner.call(req)
+ }
+}
+
+/// Proxies [`Discover`] such that all changes are wrapped with a constant load.
+#[cfg(feature = "discover")]
+#[cfg_attr(docsrs, doc(cfg(feature = "discover")))]
+impl<D: Discover + Unpin, M: Copy> Stream for Constant<D, M> {
+ type Item = Result<Change<D::Key, Constant<D::Service, M>>, D::Error>;
+
+ /// Yields the next discovery change set.
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ use self::Change::*;
+
+ let this = self.project();
+ let change = match ready!(Pin::new(this.inner).poll_discover(cx)).transpose()? {
+ None => return Poll::Ready(None),
+ Some(Insert(k, svc)) => Insert(k, Constant::new(svc, *this.load)),
+ Some(Remove(k)) => Remove(k),
+ };
+
+ Poll::Ready(Some(Ok(change)))
+ }
+}
diff --git a/crates/tower/src/load/mod.rs b/crates/tower/src/load/mod.rs
new file mode 100644
index 0000000..2f9a373
--- /dev/null
+++ b/crates/tower/src/load/mod.rs
@@ -0,0 +1,89 @@
+//! Service load measurement
+//!
+//! This module provides the [`Load`] trait, which allows measuring how loaded a service is.
+//! It also provides several wrapper types that measure load in different ways:
+//!
+//! - [`Constant`] — Always returns the same constant load value for a service.
+//! - [`PendingRequests`] — Measures load by tracking the number of in-flight requests.
+//! - [`PeakEwma`] — Measures load using a moving average of the peak latency for the service.
+//!
+//! In general, you will want to use one of these when using the types in [`tower::balance`] which
+//! balance services depending on their load. Which load metric to use depends on your exact
+//! use-case, but the ones above should get you quite far!
+//!
+//! When the `discover` feature is enabled, wrapper types for [`Discover`] that
+//! wrap the discovered services with the given load estimator are also provided.
+//!
+//! # When does a request complete?
+//!
+//! For many applications, the request life-cycle is relatively simple: when a service responds to
+//! a request, that request is done, and the system can forget about it. However, for some
+//! applications, the service may respond to the initial request while other parts of the system
+//! are still acting on that request. In such an application, the system load must take these
+//! requests into account as well, or risk the system underestimating its own load.
+//!
+//! To support these use-cases, the load estimators in this module are parameterized by the
+//! [`TrackCompletion`] trait, with [`CompleteOnResponse`] as the default type. The behavior of
+//! [`CompleteOnResponse`] is what you would normally expect for a request-response cycle: when the
+//! response is produced, the request is considered "finished", and load goes down. This can be
+//! overriden by your own user-defined type to track more complex request completion semantics. See
+//! the documentation for [`completion`] for more details.
+//!
+//! # Examples
+//!
+//! ```rust
+//! # #[cfg(feature = "util")]
+//! use tower::util::ServiceExt;
+//! # #[cfg(feature = "util")]
+//! use tower::{load::Load, Service};
+//! # #[cfg(feature = "util")]
+//! async fn simple_balance<S1, S2, R>(
+//! svc1: &mut S1,
+//! svc2: &mut S2,
+//! request: R
+//! ) -> Result<S1::Response, S1::Error>
+//! where
+//! S1: Load + Service<R>,
+//! S2: Load<Metric = S1::Metric> + Service<R, Response = S1::Response, Error = S1::Error>
+//! {
+//! if svc1.load() < svc2.load() {
+//! svc1.ready().await?.call(request).await
+//! } else {
+//! svc2.ready().await?.call(request).await
+//! }
+//! }
+//! ```
+//!
+//! [`tower::balance`]: crate::balance
+//! [`Discover`]: crate::discover::Discover
+//! [`CompleteOnResponse`]: crate::load::completion::CompleteOnResponse
+// TODO: a custom completion example would be good here
+
+pub mod completion;
+mod constant;
+pub mod peak_ewma;
+pub mod pending_requests;
+
+pub use self::{
+ completion::{CompleteOnResponse, TrackCompletion},
+ constant::Constant,
+ peak_ewma::PeakEwma,
+ pending_requests::PendingRequests,
+};
+
+#[cfg(feature = "discover")]
+pub use self::{peak_ewma::PeakEwmaDiscover, pending_requests::PendingRequestsDiscover};
+
+/// Types that implement this trait can give an estimate of how loaded they are.
+///
+/// See the module documentation for more details.
+pub trait Load {
+ /// A comparable load metric.
+ ///
+ /// Lesser values indicate that the service is less loaded, and should be preferred for new
+ /// requests over another service with a higher value.
+ type Metric: PartialOrd;
+
+ /// Estimate the service's current load.
+ fn load(&self) -> Self::Metric;
+}
diff --git a/crates/tower/src/load/peak_ewma.rs b/crates/tower/src/load/peak_ewma.rs
new file mode 100644
index 0000000..61ac201
--- /dev/null
+++ b/crates/tower/src/load/peak_ewma.rs
@@ -0,0 +1,407 @@
+//! A `Load` implementation that measures load using the PeakEWMA response latency.
+
+#[cfg(feature = "discover")]
+use crate::discover::{Change, Discover};
+#[cfg(feature = "discover")]
+use futures_core::{ready, Stream};
+#[cfg(feature = "discover")]
+use pin_project_lite::pin_project;
+#[cfg(feature = "discover")]
+use std::pin::Pin;
+
+use super::completion::{CompleteOnResponse, TrackCompletion, TrackCompletionFuture};
+use super::Load;
+use std::task::{Context, Poll};
+use std::{
+ sync::{Arc, Mutex},
+ time::Duration,
+};
+use tokio::time::Instant;
+use tower_service::Service;
+use tracing::trace;
+
+/// Measures the load of the underlying service using Peak-EWMA load measurement.
+///
+/// [`PeakEwma`] implements [`Load`] with the [`Cost`] metric that estimates the amount of
+/// pending work to an endpoint. Work is calculated by multiplying the
+/// exponentially-weighted moving average (EWMA) of response latencies by the number of
+/// pending requests. The Peak-EWMA algorithm is designed to be especially sensitive to
+/// worst-case latencies. Over time, the peak latency value decays towards the moving
+/// average of latencies to the endpoint.
+///
+/// When no latency information has been measured for an endpoint, an arbitrary default
+/// RTT of 1 second is used to prevent the endpoint from being overloaded before a
+/// meaningful baseline can be established..
+///
+/// ## Note
+///
+/// This is derived from [Finagle][finagle], which is distributed under the Apache V2
+/// license. Copyright 2017, Twitter Inc.
+///
+/// [finagle]:
+/// https://github.com/twitter/finagle/blob/9cc08d15216497bb03a1cafda96b7266cfbbcff1/finagle-core/src/main/scala/com/twitter/finagle/loadbalancer/PeakEwma.scala
+#[derive(Debug)]
+pub struct PeakEwma<S, C = CompleteOnResponse> {
+ service: S,
+ decay_ns: f64,
+ rtt_estimate: Arc<Mutex<RttEstimate>>,
+ completion: C,
+}
+
+#[cfg(feature = "discover")]
+pin_project! {
+ /// Wraps a `D`-typed stream of discovered services with `PeakEwma`.
+ #[cfg_attr(docsrs, doc(cfg(feature = "discover")))]
+ #[derive(Debug)]
+ pub struct PeakEwmaDiscover<D, C = CompleteOnResponse> {
+ #[pin]
+ discover: D,
+ decay_ns: f64,
+ default_rtt: Duration,
+ completion: C,
+ }
+}
+
+/// Represents the relative cost of communicating with a service.
+///
+/// The underlying value estimates the amount of pending work to a service: the Peak-EWMA
+/// latency estimate multiplied by the number of pending requests.
+#[derive(Copy, Clone, Debug, PartialEq, PartialOrd)]
+pub struct Cost(f64);
+
+/// Tracks an in-flight request and updates the RTT-estimate on Drop.
+#[derive(Debug)]
+pub struct Handle {
+ sent_at: Instant,
+ decay_ns: f64,
+ rtt_estimate: Arc<Mutex<RttEstimate>>,
+}
+
+/// Holds the current RTT estimate and the last time this value was updated.
+#[derive(Debug)]
+struct RttEstimate {
+ update_at: Instant,
+ rtt_ns: f64,
+}
+
+const NANOS_PER_MILLI: f64 = 1_000_000.0;
+
+// ===== impl PeakEwma =====
+
+impl<S, C> PeakEwma<S, C> {
+ /// Wraps an `S`-typed service so that its load is tracked by the EWMA of its peak latency.
+ pub fn new(service: S, default_rtt: Duration, decay_ns: f64, completion: C) -> Self {
+ debug_assert!(decay_ns > 0.0, "decay_ns must be positive");
+ Self {
+ service,
+ decay_ns,
+ rtt_estimate: Arc::new(Mutex::new(RttEstimate::new(nanos(default_rtt)))),
+ completion,
+ }
+ }
+
+ fn handle(&self) -> Handle {
+ Handle {
+ decay_ns: self.decay_ns,
+ sent_at: Instant::now(),
+ rtt_estimate: self.rtt_estimate.clone(),
+ }
+ }
+}
+
+impl<S, C, Request> Service<Request> for PeakEwma<S, C>
+where
+ S: Service<Request>,
+ C: TrackCompletion<Handle, S::Response>,
+{
+ type Response = C::Output;
+ type Error = S::Error;
+ type Future = TrackCompletionFuture<S::Future, C, Handle>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.service.poll_ready(cx)
+ }
+
+ fn call(&mut self, req: Request) -> Self::Future {
+ TrackCompletionFuture::new(
+ self.completion.clone(),
+ self.handle(),
+ self.service.call(req),
+ )
+ }
+}
+
+impl<S, C> Load for PeakEwma<S, C> {
+ type Metric = Cost;
+
+ fn load(&self) -> Self::Metric {
+ let pending = Arc::strong_count(&self.rtt_estimate) as u32 - 1;
+
+ // Update the RTT estimate to account for decay since the last update.
+ // If an estimate has not been established, a default is provided
+ let estimate = self.update_estimate();
+
+ let cost = Cost(estimate * f64::from(pending + 1));
+ trace!(
+ "load estimate={:.0}ms pending={} cost={:?}",
+ estimate / NANOS_PER_MILLI,
+ pending,
+ cost,
+ );
+ cost
+ }
+}
+
+impl<S, C> PeakEwma<S, C> {
+ fn update_estimate(&self) -> f64 {
+ let mut rtt = self.rtt_estimate.lock().expect("peak ewma prior_estimate");
+ rtt.decay(self.decay_ns)
+ }
+}
+
+// ===== impl PeakEwmaDiscover =====
+
+#[cfg(feature = "discover")]
+impl<D, C> PeakEwmaDiscover<D, C> {
+ /// Wraps a `D`-typed [`Discover`] so that services have a [`PeakEwma`] load metric.
+ ///
+ /// The provided `default_rtt` is used as the default RTT estimate for newly
+ /// added services.
+ ///
+ /// They `decay` value determines over what time period a RTT estimate should
+ /// decay.
+ pub fn new<Request>(discover: D, default_rtt: Duration, decay: Duration, completion: C) -> Self
+ where
+ D: Discover,
+ D::Service: Service<Request>,
+ C: TrackCompletion<Handle, <D::Service as Service<Request>>::Response>,
+ {
+ PeakEwmaDiscover {
+ discover,
+ decay_ns: nanos(decay),
+ default_rtt,
+ completion,
+ }
+ }
+}
+
+#[cfg(feature = "discover")]
+#[cfg_attr(docsrs, doc(cfg(feature = "discover")))]
+impl<D, C> Stream for PeakEwmaDiscover<D, C>
+where
+ D: Discover,
+ C: Clone,
+{
+ type Item = Result<Change<D::Key, PeakEwma<D::Service, C>>, D::Error>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ let this = self.project();
+ let change = match ready!(this.discover.poll_discover(cx)).transpose()? {
+ None => return Poll::Ready(None),
+ Some(Change::Remove(k)) => Change::Remove(k),
+ Some(Change::Insert(k, svc)) => {
+ let peak_ewma = PeakEwma::new(
+ svc,
+ *this.default_rtt,
+ *this.decay_ns,
+ this.completion.clone(),
+ );
+ Change::Insert(k, peak_ewma)
+ }
+ };
+
+ Poll::Ready(Some(Ok(change)))
+ }
+}
+
+// ===== impl RttEstimate =====
+
+impl RttEstimate {
+ fn new(rtt_ns: f64) -> Self {
+ debug_assert!(0.0 < rtt_ns, "rtt must be positive");
+ Self {
+ rtt_ns,
+ update_at: Instant::now(),
+ }
+ }
+
+ /// Decays the RTT estimate with a decay period of `decay_ns`.
+ fn decay(&mut self, decay_ns: f64) -> f64 {
+ // Updates with a 0 duration so that the estimate decays towards 0.
+ let now = Instant::now();
+ self.update(now, now, decay_ns)
+ }
+
+ /// Updates the Peak-EWMA RTT estimate.
+ ///
+ /// The elapsed time from `sent_at` to `recv_at` is added
+ fn update(&mut self, sent_at: Instant, recv_at: Instant, decay_ns: f64) -> f64 {
+ debug_assert!(
+ sent_at <= recv_at,
+ "recv_at={:?} after sent_at={:?}",
+ recv_at,
+ sent_at
+ );
+ let rtt = nanos(recv_at.saturating_duration_since(sent_at));
+
+ let now = Instant::now();
+ debug_assert!(
+ self.update_at <= now,
+ "update_at={:?} in the future",
+ self.update_at
+ );
+
+ self.rtt_ns = if self.rtt_ns < rtt {
+ // For Peak-EWMA, always use the worst-case (peak) value as the estimate for
+ // subsequent requests.
+ trace!(
+ "update peak rtt={}ms prior={}ms",
+ rtt / NANOS_PER_MILLI,
+ self.rtt_ns / NANOS_PER_MILLI,
+ );
+ rtt
+ } else {
+ // When an RTT is observed that is less than the estimated RTT, we decay the
+ // prior estimate according to how much time has elapsed since the last
+ // update. The inverse of the decay is used to scale the estimate towards the
+ // observed RTT value.
+ let elapsed = nanos(now.saturating_duration_since(self.update_at));
+ let decay = (-elapsed / decay_ns).exp();
+ let recency = 1.0 - decay;
+ let next_estimate = (self.rtt_ns * decay) + (rtt * recency);
+ trace!(
+ "update rtt={:03.0}ms decay={:06.0}ns; next={:03.0}ms",
+ rtt / NANOS_PER_MILLI,
+ self.rtt_ns - next_estimate,
+ next_estimate / NANOS_PER_MILLI,
+ );
+ next_estimate
+ };
+ self.update_at = now;
+
+ self.rtt_ns
+ }
+}
+
+// ===== impl Handle =====
+
+impl Drop for Handle {
+ fn drop(&mut self) {
+ let recv_at = Instant::now();
+
+ if let Ok(mut rtt) = self.rtt_estimate.lock() {
+ rtt.update(self.sent_at, recv_at, self.decay_ns);
+ }
+ }
+}
+
+// ===== impl Cost =====
+
+// Utility that converts durations to nanos in f64.
+//
+// Due to a lossy transformation, the maximum value that can be represented is ~585 years,
+// which, I hope, is more than enough to represent request latencies.
+fn nanos(d: Duration) -> f64 {
+ const NANOS_PER_SEC: u64 = 1_000_000_000;
+ let n = f64::from(d.subsec_nanos());
+ let s = d.as_secs().saturating_mul(NANOS_PER_SEC) as f64;
+ n + s
+}
+
+#[cfg(test)]
+mod tests {
+ use futures_util::future;
+ use std::time::Duration;
+ use tokio::time;
+ use tokio_test::{assert_ready, assert_ready_ok, task};
+
+ use super::*;
+
+ struct Svc;
+ impl Service<()> for Svc {
+ type Response = ();
+ type Error = ();
+ type Future = future::Ready<Result<(), ()>>;
+
+ fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), ()>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, (): ()) -> Self::Future {
+ future::ok(())
+ }
+ }
+
+ /// The default RTT estimate decays, so that new nodes are considered if the
+ /// default RTT is too high.
+ #[tokio::test]
+ async fn default_decay() {
+ time::pause();
+
+ let svc = PeakEwma::new(
+ Svc,
+ Duration::from_millis(10),
+ NANOS_PER_MILLI * 1_000.0,
+ CompleteOnResponse,
+ );
+ let Cost(load) = svc.load();
+ assert_eq!(load, 10.0 * NANOS_PER_MILLI);
+
+ time::advance(Duration::from_millis(100)).await;
+ let Cost(load) = svc.load();
+ assert!(9.0 * NANOS_PER_MILLI < load && load < 10.0 * NANOS_PER_MILLI);
+
+ time::advance(Duration::from_millis(100)).await;
+ let Cost(load) = svc.load();
+ assert!(8.0 * NANOS_PER_MILLI < load && load < 9.0 * NANOS_PER_MILLI);
+ }
+
+ // The default RTT estimate decays, so that new nodes are considered if the default RTT is too
+ // high.
+ #[tokio::test]
+ async fn compound_decay() {
+ time::pause();
+
+ let mut svc = PeakEwma::new(
+ Svc,
+ Duration::from_millis(20),
+ NANOS_PER_MILLI * 1_000.0,
+ CompleteOnResponse,
+ );
+ assert_eq!(svc.load(), Cost(20.0 * NANOS_PER_MILLI));
+
+ time::advance(Duration::from_millis(100)).await;
+ let mut rsp0 = task::spawn(svc.call(()));
+ assert!(svc.load() > Cost(20.0 * NANOS_PER_MILLI));
+
+ time::advance(Duration::from_millis(100)).await;
+ let mut rsp1 = task::spawn(svc.call(()));
+ assert!(svc.load() > Cost(40.0 * NANOS_PER_MILLI));
+
+ time::advance(Duration::from_millis(100)).await;
+ let () = assert_ready_ok!(rsp0.poll());
+ assert_eq!(svc.load(), Cost(400_000_000.0));
+
+ time::advance(Duration::from_millis(100)).await;
+ let () = assert_ready_ok!(rsp1.poll());
+ assert_eq!(svc.load(), Cost(200_000_000.0));
+
+ // Check that values decay as time elapses
+ time::advance(Duration::from_secs(1)).await;
+ assert!(svc.load() < Cost(100_000_000.0));
+
+ time::advance(Duration::from_secs(10)).await;
+ assert!(svc.load() < Cost(100_000.0));
+ }
+
+ #[test]
+ fn nanos() {
+ assert_eq!(super::nanos(Duration::new(0, 0)), 0.0);
+ assert_eq!(super::nanos(Duration::new(0, 123)), 123.0);
+ assert_eq!(super::nanos(Duration::new(1, 23)), 1_000_000_023.0);
+ assert_eq!(
+ super::nanos(Duration::new(::std::u64::MAX, 999_999_999)),
+ 18446744074709553000.0
+ );
+ }
+}
diff --git a/crates/tower/src/load/pending_requests.rs b/crates/tower/src/load/pending_requests.rs
new file mode 100644
index 0000000..3d8689b
--- /dev/null
+++ b/crates/tower/src/load/pending_requests.rs
@@ -0,0 +1,216 @@
+//! A [`Load`] implementation that measures load using the number of in-flight requests.
+
+#[cfg(feature = "discover")]
+use crate::discover::{Change, Discover};
+#[cfg(feature = "discover")]
+use futures_core::{ready, Stream};
+#[cfg(feature = "discover")]
+use pin_project_lite::pin_project;
+#[cfg(feature = "discover")]
+use std::pin::Pin;
+
+use super::completion::{CompleteOnResponse, TrackCompletion, TrackCompletionFuture};
+use super::Load;
+use std::sync::Arc;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+/// Measures the load of the underlying service using the number of currently-pending requests.
+#[derive(Debug)]
+pub struct PendingRequests<S, C = CompleteOnResponse> {
+ service: S,
+ ref_count: RefCount,
+ completion: C,
+}
+
+/// Shared between instances of [`PendingRequests`] and [`Handle`] to track active references.
+#[derive(Clone, Debug, Default)]
+struct RefCount(Arc<()>);
+
+#[cfg(feature = "discover")]
+pin_project! {
+ /// Wraps a `D`-typed stream of discovered services with [`PendingRequests`].
+ #[cfg_attr(docsrs, doc(cfg(feature = "discover")))]
+ #[derive(Debug)]
+ pub struct PendingRequestsDiscover<D, C = CompleteOnResponse> {
+ #[pin]
+ discover: D,
+ completion: C,
+ }
+}
+
+/// Represents the number of currently-pending requests to a given service.
+#[derive(Clone, Copy, Debug, Default, PartialOrd, PartialEq, Ord, Eq)]
+pub struct Count(usize);
+
+/// Tracks an in-flight request by reference count.
+#[derive(Debug)]
+pub struct Handle(RefCount);
+
+// ===== impl PendingRequests =====
+
+impl<S, C> PendingRequests<S, C> {
+ /// Wraps an `S`-typed service so that its load is tracked by the number of pending requests.
+ pub fn new(service: S, completion: C) -> Self {
+ Self {
+ service,
+ completion,
+ ref_count: RefCount::default(),
+ }
+ }
+
+ fn handle(&self) -> Handle {
+ Handle(self.ref_count.clone())
+ }
+}
+
+impl<S, C> Load for PendingRequests<S, C> {
+ type Metric = Count;
+
+ fn load(&self) -> Count {
+ // Count the number of references that aren't `self`.
+ Count(self.ref_count.ref_count() - 1)
+ }
+}
+
+impl<S, C, Request> Service<Request> for PendingRequests<S, C>
+where
+ S: Service<Request>,
+ C: TrackCompletion<Handle, S::Response>,
+{
+ type Response = C::Output;
+ type Error = S::Error;
+ type Future = TrackCompletionFuture<S::Future, C, Handle>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.service.poll_ready(cx)
+ }
+
+ fn call(&mut self, req: Request) -> Self::Future {
+ TrackCompletionFuture::new(
+ self.completion.clone(),
+ self.handle(),
+ self.service.call(req),
+ )
+ }
+}
+
+// ===== impl PendingRequestsDiscover =====
+
+#[cfg(feature = "discover")]
+impl<D, C> PendingRequestsDiscover<D, C> {
+ /// Wraps a [`Discover`], wrapping all of its services with [`PendingRequests`].
+ pub fn new<Request>(discover: D, completion: C) -> Self
+ where
+ D: Discover,
+ D::Service: Service<Request>,
+ C: TrackCompletion<Handle, <D::Service as Service<Request>>::Response>,
+ {
+ Self {
+ discover,
+ completion,
+ }
+ }
+}
+
+#[cfg(feature = "discover")]
+impl<D, C> Stream for PendingRequestsDiscover<D, C>
+where
+ D: Discover,
+ C: Clone,
+{
+ type Item = Result<Change<D::Key, PendingRequests<D::Service, C>>, D::Error>;
+
+ /// Yields the next discovery change set.
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ use self::Change::*;
+
+ let this = self.project();
+ let change = match ready!(this.discover.poll_discover(cx)).transpose()? {
+ None => return Poll::Ready(None),
+ Some(Insert(k, svc)) => Insert(k, PendingRequests::new(svc, this.completion.clone())),
+ Some(Remove(k)) => Remove(k),
+ };
+
+ Poll::Ready(Some(Ok(change)))
+ }
+}
+
+// ==== RefCount ====
+
+impl RefCount {
+ pub(crate) fn ref_count(&self) -> usize {
+ Arc::strong_count(&self.0)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use futures_util::future;
+ use std::task::{Context, Poll};
+
+ struct Svc;
+ impl Service<()> for Svc {
+ type Response = ();
+ type Error = ();
+ type Future = future::Ready<Result<(), ()>>;
+
+ fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), ()>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, (): ()) -> Self::Future {
+ future::ok(())
+ }
+ }
+
+ #[test]
+ fn default() {
+ let mut svc = PendingRequests::new(Svc, CompleteOnResponse);
+ assert_eq!(svc.load(), Count(0));
+
+ let rsp0 = svc.call(());
+ assert_eq!(svc.load(), Count(1));
+
+ let rsp1 = svc.call(());
+ assert_eq!(svc.load(), Count(2));
+
+ let () = tokio_test::block_on(rsp0).unwrap();
+ assert_eq!(svc.load(), Count(1));
+
+ let () = tokio_test::block_on(rsp1).unwrap();
+ assert_eq!(svc.load(), Count(0));
+ }
+
+ #[test]
+ fn with_completion() {
+ #[derive(Clone)]
+ struct IntoHandle;
+ impl TrackCompletion<Handle, ()> for IntoHandle {
+ type Output = Handle;
+ fn track_completion(&self, i: Handle, (): ()) -> Handle {
+ i
+ }
+ }
+
+ let mut svc = PendingRequests::new(Svc, IntoHandle);
+ assert_eq!(svc.load(), Count(0));
+
+ let rsp = svc.call(());
+ assert_eq!(svc.load(), Count(1));
+ let i0 = tokio_test::block_on(rsp).unwrap();
+ assert_eq!(svc.load(), Count(1));
+
+ let rsp = svc.call(());
+ assert_eq!(svc.load(), Count(2));
+ let i1 = tokio_test::block_on(rsp).unwrap();
+ assert_eq!(svc.load(), Count(2));
+
+ drop(i1);
+ assert_eq!(svc.load(), Count(1));
+
+ drop(i0);
+ assert_eq!(svc.load(), Count(0));
+ }
+}
diff --git a/crates/tower/src/load_shed/error.rs b/crates/tower/src/load_shed/error.rs
new file mode 100644
index 0000000..3a4c025
--- /dev/null
+++ b/crates/tower/src/load_shed/error.rs
@@ -0,0 +1,34 @@
+//! Error types
+
+use std::fmt;
+
+/// An error returned by [`LoadShed`] when the underlying service
+/// is not ready to handle any requests at the time of being
+/// called.
+///
+/// [`LoadShed`]: crate::load_shed::LoadShed
+#[derive(Default)]
+pub struct Overloaded {
+ _p: (),
+}
+
+impl Overloaded {
+ /// Construct a new overloaded error
+ pub fn new() -> Self {
+ Overloaded { _p: () }
+ }
+}
+
+impl fmt::Debug for Overloaded {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str("Overloaded")
+ }
+}
+
+impl fmt::Display for Overloaded {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str("service overloaded")
+ }
+}
+
+impl std::error::Error for Overloaded {}
diff --git a/crates/tower/src/load_shed/future.rs b/crates/tower/src/load_shed/future.rs
new file mode 100644
index 0000000..64f394c
--- /dev/null
+++ b/crates/tower/src/load_shed/future.rs
@@ -0,0 +1,73 @@
+//! Future types
+
+use std::fmt;
+use std::future::Future;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+
+use futures_core::ready;
+use pin_project_lite::pin_project;
+
+use super::error::Overloaded;
+
+pin_project! {
+ /// Future for the [`LoadShed`] service.
+ ///
+ /// [`LoadShed`]: crate::load_shed::LoadShed
+ pub struct ResponseFuture<F> {
+ #[pin]
+ state: ResponseState<F>,
+ }
+}
+
+pin_project! {
+ #[project = ResponseStateProj]
+ enum ResponseState<F> {
+ Called {
+ #[pin]
+ fut: F
+ },
+ Overloaded,
+ }
+}
+
+impl<F> ResponseFuture<F> {
+ pub(crate) fn called(fut: F) -> Self {
+ ResponseFuture {
+ state: ResponseState::Called { fut },
+ }
+ }
+
+ pub(crate) fn overloaded() -> Self {
+ ResponseFuture {
+ state: ResponseState::Overloaded,
+ }
+ }
+}
+
+impl<F, T, E> Future for ResponseFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ match self.project().state.project() {
+ ResponseStateProj::Called { fut } => {
+ Poll::Ready(ready!(fut.poll(cx)).map_err(Into::into))
+ }
+ ResponseStateProj::Overloaded => Poll::Ready(Err(Overloaded::new().into())),
+ }
+ }
+}
+
+impl<F> fmt::Debug for ResponseFuture<F>
+where
+ // bounds for future-proofing...
+ F: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str("ResponseFuture")
+ }
+}
diff --git a/crates/tower/src/load_shed/layer.rs b/crates/tower/src/load_shed/layer.rs
new file mode 100644
index 0000000..65ab29f
--- /dev/null
+++ b/crates/tower/src/load_shed/layer.rs
@@ -0,0 +1,33 @@
+use std::fmt;
+use tower_layer::Layer;
+
+use super::LoadShed;
+
+/// A [`Layer`] to wrap services in [`LoadShed`] middleware.
+///
+/// [`Layer`]: crate::Layer
+#[derive(Clone, Default)]
+pub struct LoadShedLayer {
+ _p: (),
+}
+
+impl LoadShedLayer {
+ /// Creates a new layer.
+ pub fn new() -> Self {
+ LoadShedLayer { _p: () }
+ }
+}
+
+impl<S> Layer<S> for LoadShedLayer {
+ type Service = LoadShed<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ LoadShed::new(service)
+ }
+}
+
+impl fmt::Debug for LoadShedLayer {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_struct("LoadShedLayer").finish()
+ }
+}
diff --git a/crates/tower/src/load_shed/mod.rs b/crates/tower/src/load_shed/mod.rs
new file mode 100644
index 0000000..deadf0f
--- /dev/null
+++ b/crates/tower/src/load_shed/mod.rs
@@ -0,0 +1,76 @@
+//! Middleware for shedding load when inner services aren't ready.
+
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+pub mod error;
+pub mod future;
+mod layer;
+
+use self::future::ResponseFuture;
+pub use self::layer::LoadShedLayer;
+
+/// A [`Service`] that sheds load when the inner service isn't ready.
+///
+/// [`Service`]: crate::Service
+#[derive(Debug)]
+pub struct LoadShed<S> {
+ inner: S,
+ is_ready: bool,
+}
+
+// ===== impl LoadShed =====
+
+impl<S> LoadShed<S> {
+ /// Wraps a service in [`LoadShed`] middleware.
+ pub fn new(inner: S) -> Self {
+ LoadShed {
+ inner,
+ is_ready: false,
+ }
+ }
+}
+
+impl<S, Req> Service<Req> for LoadShed<S>
+where
+ S: Service<Req>,
+ S::Error: Into<crate::BoxError>,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<S::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // We check for readiness here, so that we can know in `call` if
+ // the inner service is overloaded or not.
+ self.is_ready = match self.inner.poll_ready(cx) {
+ Poll::Ready(Err(e)) => return Poll::Ready(Err(e.into())),
+ r => r.is_ready(),
+ };
+
+ // But we always report Ready, so that layers above don't wait until
+ // the inner service is ready (the entire point of this layer!)
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, req: Req) -> Self::Future {
+ if self.is_ready {
+ // readiness only counts once, you need to check again!
+ self.is_ready = false;
+ ResponseFuture::called(self.inner.call(req))
+ } else {
+ ResponseFuture::overloaded()
+ }
+ }
+}
+
+impl<S: Clone> Clone for LoadShed<S> {
+ fn clone(&self) -> Self {
+ LoadShed {
+ inner: self.inner.clone(),
+ // new clones shouldn't carry the readiness state, as a cloneable
+ // inner service likely tracks readiness per clone.
+ is_ready: false,
+ }
+ }
+}
diff --git a/crates/tower/src/macros.rs b/crates/tower/src/macros.rs
new file mode 100644
index 0000000..f307756
--- /dev/null
+++ b/crates/tower/src/macros.rs
@@ -0,0 +1,42 @@
+#[cfg(any(
+ feature = "util",
+ feature = "spawn-ready",
+ feature = "filter",
+ feature = "make"
+))]
+macro_rules! opaque_future {
+ ($(#[$m:meta])* pub type $name:ident<$($param:ident),+> = $actual:ty;) => {
+ pin_project_lite::pin_project! {
+ $(#[$m])*
+ pub struct $name<$($param),+> {
+ #[pin]
+ inner: $actual
+ }
+ }
+
+ impl<$($param),+> $name<$($param),+> {
+ pub(crate) fn new(inner: $actual) -> Self {
+ Self {
+ inner
+ }
+ }
+ }
+
+ impl<$($param),+> std::fmt::Debug for $name<$($param),+> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.debug_tuple(stringify!($name)).field(&format_args!("...")).finish()
+ }
+ }
+
+ impl<$($param),+> std::future::Future for $name<$($param),+>
+ where
+ $actual: std::future::Future,
+ {
+ type Output = <$actual as std::future::Future>::Output;
+ #[inline]
+ fn poll(self: std::pin::Pin<&mut Self>, cx: &mut std::task::Context<'_>) -> std::task::Poll<Self::Output> {
+ self.project().inner.poll(cx)
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/make/make_connection.rs b/crates/tower/src/make/make_connection.rs
new file mode 100644
index 0000000..9566cc6
--- /dev/null
+++ b/crates/tower/src/make/make_connection.rs
@@ -0,0 +1,47 @@
+use crate::sealed::Sealed;
+use std::future::Future;
+use std::task::{Context, Poll};
+use tokio::io::{AsyncRead, AsyncWrite};
+use tower_service::Service;
+
+/// The [`MakeConnection`] trait is used to create transports.
+///
+/// The goal of this service is to allow composable methods for creating
+/// `AsyncRead + AsyncWrite` transports. This could mean creating a TLS
+/// based connection or using some other method to authenticate the connection.
+pub trait MakeConnection<Target>: Sealed<(Target,)> {
+ /// The transport provided by this service
+ type Connection: AsyncRead + AsyncWrite;
+
+ /// Errors produced by the connecting service
+ type Error;
+
+ /// The future that eventually produces the transport
+ type Future: Future<Output = Result<Self::Connection, Self::Error>>;
+
+ /// Returns `Poll::Ready(Ok(()))` when it is able to make more connections.
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>;
+
+ /// Connect and return a transport asynchronously
+ fn make_connection(&mut self, target: Target) -> Self::Future;
+}
+
+impl<S, Target> Sealed<(Target,)> for S where S: Service<Target> {}
+
+impl<C, Target> MakeConnection<Target> for C
+where
+ C: Service<Target>,
+ C::Response: AsyncRead + AsyncWrite,
+{
+ type Connection = C::Response;
+ type Error = C::Error;
+ type Future = C::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Service::poll_ready(self, cx)
+ }
+
+ fn make_connection(&mut self, target: Target) -> Self::Future {
+ Service::call(self, target)
+ }
+}
diff --git a/crates/tower/src/make/make_service.rs b/crates/tower/src/make/make_service.rs
new file mode 100644
index 0000000..aa519d6
--- /dev/null
+++ b/crates/tower/src/make/make_service.rs
@@ -0,0 +1,251 @@
+//! Contains [`MakeService`] which is a trait alias for a [`Service`] of [`Service`]s.
+
+use crate::sealed::Sealed;
+use std::fmt;
+use std::future::Future;
+use std::marker::PhantomData;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+pub(crate) mod shared;
+
+/// Creates new [`Service`] values.
+///
+/// Acts as a service factory. This is useful for cases where new [`Service`]
+/// values must be produced. One case is a TCP server listener. The listener
+/// accepts new TCP streams, obtains a new [`Service`] value using the
+/// [`MakeService`] trait, and uses that new [`Service`] value to process inbound
+/// requests on that new TCP stream.
+///
+/// This is essentially a trait alias for a [`Service`] of [`Service`]s.
+pub trait MakeService<Target, Request>: Sealed<(Target, Request)> {
+ /// Responses given by the service
+ type Response;
+
+ /// Errors produced by the service
+ type Error;
+
+ /// The [`Service`] value created by this factory
+ type Service: Service<Request, Response = Self::Response, Error = Self::Error>;
+
+ /// Errors produced while building a service.
+ type MakeError;
+
+ /// The future of the [`Service`] instance.
+ type Future: Future<Output = Result<Self::Service, Self::MakeError>>;
+
+ /// Returns [`Poll::Ready`] when the factory is able to create more services.
+ ///
+ /// If the service is at capacity, then [`Poll::Pending`] is returned and the task
+ /// is notified when the service becomes ready again. This function is
+ /// expected to be called while on a task.
+ ///
+ /// [`Poll::Ready`]: std::task::Poll::Ready
+ /// [`Poll::Pending`]: std::task::Poll::Pending
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::MakeError>>;
+
+ /// Create and return a new service value asynchronously.
+ fn make_service(&mut self, target: Target) -> Self::Future;
+
+ /// Consume this [`MakeService`] and convert it into a [`Service`].
+ ///
+ /// # Example
+ /// ```
+ /// use std::convert::Infallible;
+ /// use tower::Service;
+ /// use tower::make::MakeService;
+ /// use tower::service_fn;
+ ///
+ /// # fn main() {
+ /// # async {
+ /// // A `MakeService`
+ /// let make_service = service_fn(|make_req: ()| async {
+ /// Ok::<_, Infallible>(service_fn(|req: String| async {
+ /// Ok::<_, Infallible>(req)
+ /// }))
+ /// });
+ ///
+ /// // Convert the `MakeService` into a `Service`
+ /// let mut svc = make_service.into_service();
+ ///
+ /// // Make a new service
+ /// let mut new_svc = svc.call(()).await.unwrap();
+ ///
+ /// // Call the service
+ /// let res = new_svc.call("foo".to_string()).await.unwrap();
+ /// # };
+ /// # }
+ /// ```
+ fn into_service(self) -> IntoService<Self, Request>
+ where
+ Self: Sized,
+ {
+ IntoService {
+ make: self,
+ _marker: PhantomData,
+ }
+ }
+
+ /// Convert this [`MakeService`] into a [`Service`] without consuming the original [`MakeService`].
+ ///
+ /// # Example
+ /// ```
+ /// use std::convert::Infallible;
+ /// use tower::Service;
+ /// use tower::make::MakeService;
+ /// use tower::service_fn;
+ ///
+ /// # fn main() {
+ /// # async {
+ /// // A `MakeService`
+ /// let mut make_service = service_fn(|make_req: ()| async {
+ /// Ok::<_, Infallible>(service_fn(|req: String| async {
+ /// Ok::<_, Infallible>(req)
+ /// }))
+ /// });
+ ///
+ /// // Convert the `MakeService` into a `Service`
+ /// let mut svc = make_service.as_service();
+ ///
+ /// // Make a new service
+ /// let mut new_svc = svc.call(()).await.unwrap();
+ ///
+ /// // Call the service
+ /// let res = new_svc.call("foo".to_string()).await.unwrap();
+ ///
+ /// // The original `MakeService` is still accessible
+ /// let new_svc = make_service.make_service(()).await.unwrap();
+ /// # };
+ /// # }
+ /// ```
+ fn as_service(&mut self) -> AsService<Self, Request>
+ where
+ Self: Sized,
+ {
+ AsService {
+ make: self,
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<M, S, Target, Request> Sealed<(Target, Request)> for M
+where
+ M: Service<Target, Response = S>,
+ S: Service<Request>,
+{
+}
+
+impl<M, S, Target, Request> MakeService<Target, Request> for M
+where
+ M: Service<Target, Response = S>,
+ S: Service<Request>,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Service = S;
+ type MakeError = M::Error;
+ type Future = M::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::MakeError>> {
+ Service::poll_ready(self, cx)
+ }
+
+ fn make_service(&mut self, target: Target) -> Self::Future {
+ Service::call(self, target)
+ }
+}
+
+/// Service returned by [`MakeService::into_service`][into].
+///
+/// See the documentation on [`into_service`][into] for details.
+///
+/// [into]: MakeService::into_service
+pub struct IntoService<M, Request> {
+ make: M,
+ _marker: PhantomData<Request>,
+}
+
+impl<M, Request> Clone for IntoService<M, Request>
+where
+ M: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ make: self.make.clone(),
+ _marker: PhantomData,
+ }
+ }
+}
+
+impl<M, Request> fmt::Debug for IntoService<M, Request>
+where
+ M: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("IntoService")
+ .field("make", &self.make)
+ .finish()
+ }
+}
+
+impl<M, S, Target, Request> Service<Target> for IntoService<M, Request>
+where
+ M: Service<Target, Response = S>,
+ S: Service<Request>,
+{
+ type Response = M::Response;
+ type Error = M::Error;
+ type Future = M::Future;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.make.poll_ready(cx)
+ }
+
+ #[inline]
+ fn call(&mut self, target: Target) -> Self::Future {
+ self.make.make_service(target)
+ }
+}
+
+/// Service returned by [`MakeService::as_service`][as].
+///
+/// See the documentation on [`as_service`][as] for details.
+///
+/// [as]: MakeService::as_service
+pub struct AsService<'a, M, Request> {
+ make: &'a mut M,
+ _marker: PhantomData<Request>,
+}
+
+impl<M, Request> fmt::Debug for AsService<'_, M, Request>
+where
+ M: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("AsService")
+ .field("make", &self.make)
+ .finish()
+ }
+}
+
+impl<M, S, Target, Request> Service<Target> for AsService<'_, M, Request>
+where
+ M: Service<Target, Response = S>,
+ S: Service<Request>,
+{
+ type Response = M::Response;
+ type Error = M::Error;
+ type Future = M::Future;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.make.poll_ready(cx)
+ }
+
+ #[inline]
+ fn call(&mut self, target: Target) -> Self::Future {
+ self.make.make_service(target)
+ }
+}
diff --git a/crates/tower/src/make/make_service/shared.rs b/crates/tower/src/make/make_service/shared.rs
new file mode 100644
index 0000000..fd308a0
--- /dev/null
+++ b/crates/tower/src/make/make_service/shared.rs
@@ -0,0 +1,146 @@
+use std::convert::Infallible;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+/// A [`MakeService`] that produces services by cloning an inner service.
+///
+/// [`MakeService`]: super::MakeService
+///
+/// # Example
+///
+/// ```
+/// # use std::task::{Context, Poll};
+/// # use std::pin::Pin;
+/// # use std::convert::Infallible;
+/// use tower::make::{MakeService, Shared};
+/// use tower::buffer::Buffer;
+/// use tower::Service;
+/// use futures::future::{Ready, ready};
+///
+/// // An example connection type
+/// struct Connection {}
+///
+/// // An example request type
+/// struct Request {}
+///
+/// // An example response type
+/// struct Response {}
+///
+/// // Some service that doesn't implement `Clone`
+/// struct MyService;
+///
+/// impl Service<Request> for MyService {
+/// type Response = Response;
+/// type Error = Infallible;
+/// type Future = Ready<Result<Response, Infallible>>;
+///
+/// fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+/// Poll::Ready(Ok(()))
+/// }
+///
+/// fn call(&mut self, req: Request) -> Self::Future {
+/// ready(Ok(Response {}))
+/// }
+/// }
+///
+/// // Example function that runs a service by accepting new connections and using
+/// // `Make` to create new services that might be bound to the connection.
+/// //
+/// // This is similar to what you might find in hyper.
+/// async fn serve_make_service<Make>(make: Make)
+/// where
+/// Make: MakeService<Connection, Request>
+/// {
+/// // ...
+/// }
+///
+/// # async {
+/// // Our service
+/// let svc = MyService;
+///
+/// // Make it `Clone` by putting a channel in front
+/// let buffered = Buffer::new(svc, 1024);
+///
+/// // Convert it into a `MakeService`
+/// let make = Shared::new(buffered);
+///
+/// // Run the service and just ignore the `Connection`s as `MyService` doesn't need them
+/// serve_make_service(make).await;
+/// # };
+/// ```
+#[derive(Debug, Clone, Copy)]
+pub struct Shared<S> {
+ service: S,
+}
+
+impl<S> Shared<S> {
+ /// Create a new [`Shared`] from a service.
+ pub fn new(service: S) -> Self {
+ Self { service }
+ }
+}
+
+impl<S, T> Service<T> for Shared<S>
+where
+ S: Clone,
+{
+ type Response = S;
+ type Error = Infallible;
+ type Future = SharedFuture<S>;
+
+ fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, _target: T) -> Self::Future {
+ SharedFuture::new(futures_util::future::ready(Ok(self.service.clone())))
+ }
+}
+
+opaque_future! {
+ /// Response future from [`Shared`] services.
+ pub type SharedFuture<S> = futures_util::future::Ready<Result<S, Infallible>>;
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::make::MakeService;
+ use crate::service_fn;
+ use futures::future::poll_fn;
+
+ async fn echo<R>(req: R) -> Result<R, Infallible> {
+ Ok(req)
+ }
+
+ #[tokio::test]
+ async fn as_make_service() {
+ let mut shared = Shared::new(service_fn(echo::<&'static str>));
+
+ poll_fn(|cx| MakeService::<(), _>::poll_ready(&mut shared, cx))
+ .await
+ .unwrap();
+ let mut svc = shared.make_service(()).await.unwrap();
+
+ poll_fn(|cx| svc.poll_ready(cx)).await.unwrap();
+ let res = svc.call("foo").await.unwrap();
+
+ assert_eq!(res, "foo");
+ }
+
+ #[tokio::test]
+ async fn as_make_service_into_service() {
+ let shared = Shared::new(service_fn(echo::<&'static str>));
+ let mut shared = MakeService::<(), _>::into_service(shared);
+
+ poll_fn(|cx| Service::<()>::poll_ready(&mut shared, cx))
+ .await
+ .unwrap();
+ let mut svc = shared.call(()).await.unwrap();
+
+ poll_fn(|cx| svc.poll_ready(cx)).await.unwrap();
+ let res = svc.call("foo").await.unwrap();
+
+ assert_eq!(res, "foo");
+ }
+}
diff --git a/crates/tower/src/make/mod.rs b/crates/tower/src/make/mod.rs
new file mode 100644
index 0000000..a377f2a
--- /dev/null
+++ b/crates/tower/src/make/mod.rs
@@ -0,0 +1,14 @@
+//! Trait aliases for Services that produce specific types of Responses.
+
+mod make_connection;
+mod make_service;
+
+pub use self::make_connection::MakeConnection;
+pub use self::make_service::shared::Shared;
+pub use self::make_service::{AsService, IntoService, MakeService};
+
+pub mod future {
+ //! Future types
+
+ pub use super::make_service::shared::SharedFuture;
+}
diff --git a/crates/tower/src/ready_cache/cache.rs b/crates/tower/src/ready_cache/cache.rs
new file mode 100644
index 0000000..8070d78
--- /dev/null
+++ b/crates/tower/src/ready_cache/cache.rs
@@ -0,0 +1,493 @@
+//! A cache of services.
+
+use super::error;
+use futures_core::Stream;
+use futures_util::{stream::FuturesUnordered, task::AtomicWaker};
+pub use indexmap::Equivalent;
+use indexmap::IndexMap;
+use std::fmt;
+use std::future::Future;
+use std::hash::Hash;
+use std::pin::Pin;
+use std::sync::atomic::{AtomicBool, Ordering};
+use std::sync::Arc;
+use std::task::{Context, Poll};
+use tower_service::Service;
+use tracing::{debug, trace};
+
+/// Drives readiness over a set of services.
+///
+/// The cache maintains two internal data structures:
+///
+/// * a set of _pending_ services that have not yet become ready; and
+/// * a set of _ready_ services that have previously polled ready.
+///
+/// As each `S` typed [`Service`] is added to the cache via [`ReadyCache::push`], it
+/// is added to the _pending set_. As [`ReadyCache::poll_pending`] is invoked,
+/// pending services are polled and added to the _ready set_.
+///
+/// [`ReadyCache::call_ready`] (or [`ReadyCache::call_ready_index`]) dispatches a
+/// request to the specified service, but panics if the specified service is not
+/// in the ready set. The `ReadyCache::check_*` functions can be used to ensure
+/// that a service is ready before dispatching a request.
+///
+/// The ready set can hold services for an abitrarily long time. During this
+/// time, the runtime may process events that invalidate that ready state (for
+/// instance, if a keepalive detects a lost connection). In such cases, callers
+/// should use [`ReadyCache::check_ready`] (or [`ReadyCache::check_ready_index`])
+/// immediately before dispatching a request to ensure that the service has not
+/// become unavailable.
+///
+/// Once `ReadyCache::call_ready*` is invoked, the service is placed back into
+/// the _pending_ set to be driven to readiness again.
+///
+/// When `ReadyCache::check_ready*` returns `false`, it indicates that the
+/// specified service is _not_ ready. If an error is returned, this indicats that
+/// the server failed and has been removed from the cache entirely.
+///
+/// [`ReadyCache::evict`] can be used to remove a service from the cache (by key),
+/// though the service may not be dropped (if it is currently pending) until
+/// [`ReadyCache::poll_pending`] is invoked.
+///
+/// Note that the by-index accessors are provided to support use cases (like
+/// power-of-two-choices load balancing) where the caller does not care to keep
+/// track of each service's key. Instead, it needs only to access _some_ ready
+/// service. In such a case, it should be noted that calls to
+/// [`ReadyCache::poll_pending`] and [`ReadyCache::evict`] may perturb the order of
+/// the ready set, so any cached indexes should be discarded after such a call.
+pub struct ReadyCache<K, S, Req>
+where
+ K: Eq + Hash,
+{
+ /// A stream of services that are not yet ready.
+ pending: FuturesUnordered<Pending<K, S, Req>>,
+ /// An index of cancelation handles for pending streams.
+ pending_cancel_txs: IndexMap<K, CancelTx>,
+
+ /// Services that have previously become ready. Readiness can become stale,
+ /// so a given service should be polled immediately before use.
+ ///
+ /// The cancelation oneshot is preserved (though unused) while the service is
+ /// ready so that it need not be reallocated each time a request is
+ /// dispatched.
+ ready: IndexMap<K, (S, CancelPair)>,
+}
+
+// Safety: This is safe because we do not use `Pin::new_unchecked`.
+impl<S, K: Eq + Hash, Req> Unpin for ReadyCache<K, S, Req> {}
+
+#[derive(Debug)]
+struct Cancel {
+ waker: AtomicWaker,
+ canceled: AtomicBool,
+}
+
+#[derive(Debug)]
+struct CancelRx(Arc<Cancel>);
+
+#[derive(Debug)]
+struct CancelTx(Arc<Cancel>);
+
+type CancelPair = (CancelTx, CancelRx);
+
+#[derive(Debug)]
+enum PendingError<K, E> {
+ Canceled(K),
+ Inner(K, E),
+}
+
+pin_project_lite::pin_project! {
+ /// A [`Future`] that becomes satisfied when an `S`-typed service is ready.
+ ///
+ /// May fail due to cancelation, i.e. if the service is evicted from the balancer.
+ struct Pending<K, S, Req> {
+ key: Option<K>,
+ cancel: Option<CancelRx>,
+ ready: Option<S>,
+ _pd: std::marker::PhantomData<Req>,
+ }
+}
+
+// === ReadyCache ===
+
+impl<K, S, Req> Default for ReadyCache<K, S, Req>
+where
+ K: Eq + Hash,
+ S: Service<Req>,
+{
+ fn default() -> Self {
+ Self {
+ ready: IndexMap::default(),
+ pending: FuturesUnordered::new(),
+ pending_cancel_txs: IndexMap::default(),
+ }
+ }
+}
+
+impl<K, S, Req> fmt::Debug for ReadyCache<K, S, Req>
+where
+ K: fmt::Debug + Eq + Hash,
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self {
+ pending,
+ pending_cancel_txs,
+ ready,
+ } = self;
+ f.debug_struct("ReadyCache")
+ .field("pending", pending)
+ .field("pending_cancel_txs", pending_cancel_txs)
+ .field("ready", ready)
+ .finish()
+ }
+}
+
+impl<K, S, Req> ReadyCache<K, S, Req>
+where
+ K: Eq + Hash,
+{
+ /// Returns the total number of services in the cache.
+ pub fn len(&self) -> usize {
+ self.ready_len() + self.pending_len()
+ }
+
+ /// Returns whether or not there are any services in the cache.
+ pub fn is_empty(&self) -> bool {
+ self.ready.is_empty() && self.pending.is_empty()
+ }
+
+ /// Returns the number of services in the ready set.
+ pub fn ready_len(&self) -> usize {
+ self.ready.len()
+ }
+
+ /// Returns the number of services in the unready set.
+ pub fn pending_len(&self) -> usize {
+ self.pending.len()
+ }
+
+ /// Returns true iff the given key is in the unready set.
+ pub fn pending_contains<Q: Hash + Equivalent<K>>(&self, key: &Q) -> bool {
+ self.pending_cancel_txs.contains_key(key)
+ }
+
+ /// Obtains a reference to a service in the ready set by key.
+ pub fn get_ready<Q: Hash + Equivalent<K>>(&self, key: &Q) -> Option<(usize, &K, &S)> {
+ self.ready.get_full(key).map(|(i, k, v)| (i, k, &v.0))
+ }
+
+ /// Obtains a mutable reference to a service in the ready set by key.
+ pub fn get_ready_mut<Q: Hash + Equivalent<K>>(
+ &mut self,
+ key: &Q,
+ ) -> Option<(usize, &K, &mut S)> {
+ self.ready
+ .get_full_mut(key)
+ .map(|(i, k, v)| (i, k, &mut v.0))
+ }
+
+ /// Obtains a reference to a service in the ready set by index.
+ pub fn get_ready_index(&self, idx: usize) -> Option<(&K, &S)> {
+ self.ready.get_index(idx).map(|(k, v)| (k, &v.0))
+ }
+
+ /// Obtains a mutable reference to a service in the ready set by index.
+ pub fn get_ready_index_mut(&mut self, idx: usize) -> Option<(&mut K, &mut S)> {
+ self.ready.get_index_mut(idx).map(|(k, v)| (k, &mut v.0))
+ }
+
+ /// Evicts an item from the cache.
+ ///
+ /// Returns true if a service was marked for eviction.
+ ///
+ /// Services are dropped from the ready set immediately. Services in the
+ /// pending set are marked for cancellation, but [`ReadyCache::poll_pending`]
+ /// must be called to cause the service to be dropped.
+ pub fn evict<Q: Hash + Equivalent<K>>(&mut self, key: &Q) -> bool {
+ let canceled = if let Some(c) = self.pending_cancel_txs.swap_remove(key) {
+ c.cancel();
+ true
+ } else {
+ false
+ };
+
+ self.ready
+ .swap_remove_full(key)
+ .map(|_| true)
+ .unwrap_or(canceled)
+ }
+}
+
+impl<K, S, Req> ReadyCache<K, S, Req>
+where
+ K: Clone + Eq + Hash,
+ S: Service<Req>,
+ <S as Service<Req>>::Error: Into<crate::BoxError>,
+ S::Error: Into<crate::BoxError>,
+{
+ /// Pushes a new service onto the pending set.
+ ///
+ /// The service will be promoted to the ready set as [`poll_pending`] is invoked.
+ ///
+ /// Note that this does **not** remove services from the ready set. Once the
+ /// old service is used, it will be dropped instead of being added back to
+ /// the pending set; OR, when the new service becomes ready, it will replace
+ /// the prior service in the ready set.
+ ///
+ /// [`poll_pending`]: crate::ready_cache::cache::ReadyCache::poll_pending
+ pub fn push(&mut self, key: K, svc: S) {
+ let cancel = cancelable();
+ self.push_pending(key, svc, cancel);
+ }
+
+ fn push_pending(&mut self, key: K, svc: S, (cancel_tx, cancel_rx): CancelPair) {
+ if let Some(c) = self.pending_cancel_txs.insert(key.clone(), cancel_tx) {
+ // If there is already a service for this key, cancel it.
+ c.cancel();
+ }
+ self.pending.push(Pending {
+ key: Some(key),
+ cancel: Some(cancel_rx),
+ ready: Some(svc),
+ _pd: std::marker::PhantomData,
+ });
+ }
+
+ /// Polls services pending readiness, adding ready services to the ready set.
+ ///
+ /// Returns [`Poll::Ready`] when there are no remaining unready services.
+ /// [`poll_pending`] should be called again after [`push`] or
+ /// [`call_ready_index`] are invoked.
+ ///
+ /// Failures indicate that an individual pending service failed to become
+ /// ready (and has been removed from the cache). In such a case,
+ /// [`poll_pending`] should typically be called again to continue driving
+ /// pending services to readiness.
+ ///
+ /// [`poll_pending`]: crate::ready_cache::cache::ReadyCache::poll_pending
+ /// [`push`]: crate::ready_cache::cache::ReadyCache::push
+ /// [`call_ready_index`]: crate::ready_cache::cache::ReadyCache::call_ready_index
+ pub fn poll_pending(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), error::Failed<K>>> {
+ loop {
+ match Pin::new(&mut self.pending).poll_next(cx) {
+ Poll::Pending => return Poll::Pending,
+ Poll::Ready(None) => return Poll::Ready(Ok(())),
+ Poll::Ready(Some(Ok((key, svc, cancel_rx)))) => {
+ trace!("endpoint ready");
+ let cancel_tx = self.pending_cancel_txs.swap_remove(&key);
+ if let Some(cancel_tx) = cancel_tx {
+ // Keep track of the cancelation so that it need not be
+ // recreated after the service is used.
+ self.ready.insert(key, (svc, (cancel_tx, cancel_rx)));
+ } else {
+ assert!(
+ cancel_tx.is_some(),
+ "services that become ready must have a pending cancelation"
+ );
+ }
+ }
+ Poll::Ready(Some(Err(PendingError::Canceled(_)))) => {
+ debug!("endpoint canceled");
+ // The cancellation for this service was removed in order to
+ // cause this cancellation.
+ }
+ Poll::Ready(Some(Err(PendingError::Inner(key, e)))) => {
+ let cancel_tx = self.pending_cancel_txs.swap_remove(&key);
+ assert!(
+ cancel_tx.is_some(),
+ "services that return an error must have a pending cancelation"
+ );
+ return Err(error::Failed(key, e.into())).into();
+ }
+ }
+ }
+ }
+
+ /// Checks whether the referenced endpoint is ready.
+ ///
+ /// Returns true if the endpoint is ready and false if it is not. An error is
+ /// returned if the endpoint fails.
+ pub fn check_ready<Q: Hash + Equivalent<K>>(
+ &mut self,
+ cx: &mut Context<'_>,
+ key: &Q,
+ ) -> Result<bool, error::Failed<K>> {
+ match self.ready.get_full_mut(key) {
+ Some((index, _, _)) => self.check_ready_index(cx, index),
+ None => Ok(false),
+ }
+ }
+
+ /// Checks whether the referenced endpoint is ready.
+ ///
+ /// If the service is no longer ready, it is moved back into the pending set
+ /// and `false` is returned.
+ ///
+ /// If the service errors, it is removed and dropped and the error is returned.
+ pub fn check_ready_index(
+ &mut self,
+ cx: &mut Context<'_>,
+ index: usize,
+ ) -> Result<bool, error::Failed<K>> {
+ let svc = match self.ready.get_index_mut(index) {
+ None => return Ok(false),
+ Some((_, (svc, _))) => svc,
+ };
+ match svc.poll_ready(cx) {
+ Poll::Ready(Ok(())) => Ok(true),
+ Poll::Pending => {
+ // became unready; so move it back there.
+ let (key, (svc, cancel)) = self
+ .ready
+ .swap_remove_index(index)
+ .expect("invalid ready index");
+
+ // If a new version of this service has been added to the
+ // unready set, don't overwrite it.
+ if !self.pending_contains(&key) {
+ self.push_pending(key, svc, cancel);
+ }
+
+ Ok(false)
+ }
+ Poll::Ready(Err(e)) => {
+ // failed, so drop it.
+ let (key, _) = self
+ .ready
+ .swap_remove_index(index)
+ .expect("invalid ready index");
+ Err(error::Failed(key, e.into()))
+ }
+ }
+ }
+
+ /// Calls a ready service by key.
+ ///
+ /// # Panics
+ ///
+ /// If the specified key does not exist in the ready
+ pub fn call_ready<Q: Hash + Equivalent<K>>(&mut self, key: &Q, req: Req) -> S::Future {
+ let (index, _, _) = self
+ .ready
+ .get_full_mut(key)
+ .expect("check_ready was not called");
+ self.call_ready_index(index, req)
+ }
+
+ /// Calls a ready service by index.
+ ///
+ /// # Panics
+ ///
+ /// If the specified index is out of range.
+ pub fn call_ready_index(&mut self, index: usize, req: Req) -> S::Future {
+ let (key, (mut svc, cancel)) = self
+ .ready
+ .swap_remove_index(index)
+ .expect("check_ready_index was not called");
+
+ let fut = svc.call(req);
+
+ // If a new version of this service has been added to the
+ // unready set, don't overwrite it.
+ if !self.pending_contains(&key) {
+ self.push_pending(key, svc, cancel);
+ }
+
+ fut
+ }
+}
+
+// === impl Cancel ===
+
+/// Creates a cancelation sender and receiver.
+///
+/// A `tokio::sync::oneshot` is NOT used, as a `Receiver` is not guaranteed to
+/// observe results as soon as a `Sender` fires. Using an `AtomicBool` allows
+/// the state to be observed as soon as the cancelation is triggered.
+fn cancelable() -> CancelPair {
+ let cx = Arc::new(Cancel {
+ waker: AtomicWaker::new(),
+ canceled: AtomicBool::new(false),
+ });
+ (CancelTx(cx.clone()), CancelRx(cx))
+}
+
+impl CancelTx {
+ fn cancel(self) {
+ self.0.canceled.store(true, Ordering::SeqCst);
+ self.0.waker.wake();
+ }
+}
+
+// === Pending ===
+
+impl<K, S, Req> Future for Pending<K, S, Req>
+where
+ S: Service<Req>,
+{
+ type Output = Result<(K, S, CancelRx), PendingError<K, S::Error>>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+ // Before checking whether the service is ready, check to see whether
+ // readiness has been canceled.
+ let CancelRx(cancel) = this.cancel.as_mut().expect("polled after complete");
+ if cancel.canceled.load(Ordering::SeqCst) {
+ let key = this.key.take().expect("polled after complete");
+ return Err(PendingError::Canceled(key)).into();
+ }
+
+ match this
+ .ready
+ .as_mut()
+ .expect("polled after ready")
+ .poll_ready(cx)
+ {
+ Poll::Pending => {
+ // Before returning Pending, register interest in cancelation so
+ // that this future is polled again if the state changes.
+ let CancelRx(cancel) = this.cancel.as_mut().expect("polled after complete");
+ cancel.waker.register(cx.waker());
+ // Because both the cancel receiver and cancel sender are held
+ // by the `ReadyCache` (i.e., on a single task), then it must
+ // not be possible for the cancelation state to change while
+ // polling a `Pending` service.
+ assert!(
+ !cancel.canceled.load(Ordering::SeqCst),
+ "cancelation cannot be notified while polling a pending service"
+ );
+ Poll::Pending
+ }
+ Poll::Ready(Ok(())) => {
+ let key = this.key.take().expect("polled after complete");
+ let cancel = this.cancel.take().expect("polled after complete");
+ Ok((key, this.ready.take().expect("polled after ready"), cancel)).into()
+ }
+ Poll::Ready(Err(e)) => {
+ let key = this.key.take().expect("polled after compete");
+ Err(PendingError::Inner(key, e)).into()
+ }
+ }
+ }
+}
+
+impl<K, S, Req> fmt::Debug for Pending<K, S, Req>
+where
+ K: fmt::Debug,
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self {
+ key,
+ cancel,
+ ready,
+ _pd,
+ } = self;
+ f.debug_struct("Pending")
+ .field("key", key)
+ .field("cancel", cancel)
+ .field("ready", ready)
+ .finish()
+ }
+}
diff --git a/crates/tower/src/ready_cache/error.rs b/crates/tower/src/ready_cache/error.rs
new file mode 100644
index 0000000..08115f4
--- /dev/null
+++ b/crates/tower/src/ready_cache/error.rs
@@ -0,0 +1,28 @@
+//! Errors
+
+/// An error indicating that the service with a `K`-typed key failed with an
+/// error.
+pub struct Failed<K>(pub K, pub crate::BoxError);
+
+// === Failed ===
+
+impl<K: std::fmt::Debug> std::fmt::Debug for Failed<K> {
+ fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+ f.debug_tuple("Failed")
+ .field(&self.0)
+ .field(&self.1)
+ .finish()
+ }
+}
+
+impl<K> std::fmt::Display for Failed<K> {
+ fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+ self.1.fmt(f)
+ }
+}
+
+impl<K: std::fmt::Debug> std::error::Error for Failed<K> {
+ fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+ Some(&*self.1)
+ }
+}
diff --git a/crates/tower/src/ready_cache/mod.rs b/crates/tower/src/ready_cache/mod.rs
new file mode 100644
index 0000000..ebf85ab
--- /dev/null
+++ b/crates/tower/src/ready_cache/mod.rs
@@ -0,0 +1,6 @@
+//! A cache of services
+
+pub mod cache;
+pub mod error;
+
+pub use self::cache::ReadyCache;
diff --git a/crates/tower/src/reconnect/future.rs b/crates/tower/src/reconnect/future.rs
new file mode 100644
index 0000000..3c295b9
--- /dev/null
+++ b/crates/tower/src/reconnect/future.rs
@@ -0,0 +1,73 @@
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+pin_project! {
+ /// Future that resolves to the response or failure to connect.
+ #[derive(Debug)]
+ pub struct ResponseFuture<F, E> {
+ #[pin]
+ inner: Inner<F, E>,
+ }
+}
+
+pin_project! {
+ #[project = InnerProj]
+ #[derive(Debug)]
+ enum Inner<F, E> {
+ Future {
+ #[pin]
+ fut: F,
+ },
+ Error {
+ error: Option<E>,
+ },
+ }
+}
+
+impl<F, E> Inner<F, E> {
+ fn future(fut: F) -> Self {
+ Self::Future { fut }
+ }
+
+ fn error(error: Option<E>) -> Self {
+ Self::Error { error }
+ }
+}
+
+impl<F, E> ResponseFuture<F, E> {
+ pub(crate) fn new(inner: F) -> Self {
+ ResponseFuture {
+ inner: Inner::future(inner),
+ }
+ }
+
+ pub(crate) fn error(error: E) -> Self {
+ ResponseFuture {
+ inner: Inner::error(Some(error)),
+ }
+ }
+}
+
+impl<F, T, E, ME> Future for ResponseFuture<F, ME>
+where
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+ ME: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let me = self.project();
+ match me.inner.project() {
+ InnerProj::Future { fut } => fut.poll(cx).map_err(Into::into),
+ InnerProj::Error { error } => {
+ let e = error.take().expect("Polled after ready.").into();
+ Poll::Ready(Err(e))
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/reconnect/mod.rs b/crates/tower/src/reconnect/mod.rs
new file mode 100644
index 0000000..ff35482
--- /dev/null
+++ b/crates/tower/src/reconnect/mod.rs
@@ -0,0 +1,171 @@
+//! Reconnect services when they fail.
+//!
+//! Reconnect takes some [`MakeService`] and transforms it into a
+//! [`Service`]. It then attempts to lazily connect and
+//! reconnect on failure. The `Reconnect` service becomes unavailable
+//! when the inner `MakeService::poll_ready` returns an error. When the
+//! connection future returned from `MakeService::call` fails this will be
+//! returned in the next call to `Reconnect::call`. This allows the user to
+//! call the service again even if the inner `MakeService` was unable to
+//! connect on the last call.
+//!
+//! [`MakeService`]: crate::make::MakeService
+//! [`Service`]: crate::Service
+
+mod future;
+
+pub use future::ResponseFuture;
+
+use crate::make::MakeService;
+use std::fmt;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+use tracing::trace;
+
+/// Reconnect to failed services.
+pub struct Reconnect<M, Target>
+where
+ M: Service<Target>,
+{
+ mk_service: M,
+ state: State<M::Future, M::Response>,
+ target: Target,
+ error: Option<M::Error>,
+}
+
+#[derive(Debug)]
+enum State<F, S> {
+ Idle,
+ Connecting(F),
+ Connected(S),
+}
+
+impl<M, Target> Reconnect<M, Target>
+where
+ M: Service<Target>,
+{
+ /// Lazily connect and reconnect to a [`Service`].
+ pub fn new<S, Request>(mk_service: M, target: Target) -> Self {
+ Reconnect {
+ mk_service,
+ state: State::Idle,
+ target,
+ error: None,
+ }
+ }
+
+ /// Reconnect to a already connected [`Service`].
+ pub fn with_connection(init_conn: M::Response, mk_service: M, target: Target) -> Self {
+ Reconnect {
+ mk_service,
+ state: State::Connected(init_conn),
+ target,
+ error: None,
+ }
+ }
+}
+
+impl<M, Target, S, Request> Service<Request> for Reconnect<M, Target>
+where
+ M: Service<Target, Response = S>,
+ S: Service<Request>,
+ M::Future: Unpin,
+ crate::BoxError: From<M::Error> + From<S::Error>,
+ Target: Clone,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<S::Future, M::Error>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ loop {
+ match &mut self.state {
+ State::Idle => {
+ trace!("poll_ready; idle");
+ match self.mk_service.poll_ready(cx) {
+ Poll::Ready(r) => r?,
+ Poll::Pending => {
+ trace!("poll_ready; MakeService not ready");
+ return Poll::Pending;
+ }
+ }
+
+ let fut = self.mk_service.make_service(self.target.clone());
+ self.state = State::Connecting(fut);
+ continue;
+ }
+ State::Connecting(ref mut f) => {
+ trace!("poll_ready; connecting");
+ match Pin::new(f).poll(cx) {
+ Poll::Ready(Ok(service)) => {
+ self.state = State::Connected(service);
+ }
+ Poll::Pending => {
+ trace!("poll_ready; not ready");
+ return Poll::Pending;
+ }
+ Poll::Ready(Err(e)) => {
+ trace!("poll_ready; error");
+ self.state = State::Idle;
+ self.error = Some(e);
+ break;
+ }
+ }
+ }
+ State::Connected(ref mut inner) => {
+ trace!("poll_ready; connected");
+ match inner.poll_ready(cx) {
+ Poll::Ready(Ok(())) => {
+ trace!("poll_ready; ready");
+ return Poll::Ready(Ok(()));
+ }
+ Poll::Pending => {
+ trace!("poll_ready; not ready");
+ return Poll::Pending;
+ }
+ Poll::Ready(Err(_)) => {
+ trace!("poll_ready; error");
+ self.state = State::Idle;
+ }
+ }
+ }
+ }
+ }
+
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ if let Some(error) = self.error.take() {
+ return ResponseFuture::error(error);
+ }
+
+ let service = match self.state {
+ State::Connected(ref mut service) => service,
+ _ => panic!("service not ready; poll_ready must be called first"),
+ };
+
+ let fut = service.call(request);
+ ResponseFuture::new(fut)
+ }
+}
+
+impl<M, Target> fmt::Debug for Reconnect<M, Target>
+where
+ M: Service<Target> + fmt::Debug,
+ M::Future: fmt::Debug,
+ M::Response: fmt::Debug,
+ Target: fmt::Debug,
+{
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_struct("Reconnect")
+ .field("mk_service", &self.mk_service)
+ .field("state", &self.state)
+ .field("target", &self.target)
+ .finish()
+ }
+}
diff --git a/crates/tower/src/retry/budget.rs b/crates/tower/src/retry/budget.rs
new file mode 100644
index 0000000..3705f82
--- /dev/null
+++ b/crates/tower/src/retry/budget.rs
@@ -0,0 +1,273 @@
+//! A retry "budget" for allowing only a certain amount of retries over time.
+
+use std::{
+ fmt,
+ sync::{
+ atomic::{AtomicIsize, Ordering},
+ Mutex,
+ },
+ time::Duration,
+};
+use tokio::time::Instant;
+
+/// Represents a "budget" for retrying requests.
+///
+/// This is useful for limiting the amount of retries a service can perform
+/// over a period of time, or per a certain number of requests attempted.
+pub struct Budget {
+ bucket: Bucket,
+ deposit_amount: isize,
+ withdraw_amount: isize,
+}
+
+/// Indicates that it is not currently allowed to "withdraw" another retry
+/// from the [`Budget`].
+#[derive(Debug)]
+pub struct Overdrawn {
+ _inner: (),
+}
+
+#[derive(Debug)]
+struct Bucket {
+ generation: Mutex<Generation>,
+ /// Initial budget allowed for every second.
+ reserve: isize,
+ /// Slots of a the TTL divided evenly.
+ slots: Box<[AtomicIsize]>,
+ /// The amount of time represented by each slot.
+ window: Duration,
+ /// The changers for the current slot to be commited
+ /// after the slot expires.
+ writer: AtomicIsize,
+}
+
+#[derive(Debug)]
+struct Generation {
+ /// Slot index of the last generation.
+ index: usize,
+ /// The timestamp since the last generation expired.
+ time: Instant,
+}
+
+// ===== impl Budget =====
+
+impl Budget {
+ /// Create a [`Budget`] that allows for a certain percent of the total
+ /// requests to be retried.
+ ///
+ /// - The `ttl` is the duration of how long a single `deposit` should be
+ /// considered. Must be between 1 and 60 seconds.
+ /// - The `min_per_sec` is the minimum rate of retries allowed to accomodate
+ /// clients that have just started issuing requests, or clients that do
+ /// not issue many requests per window.
+ /// - The `retry_percent` is the percentage of calls to `deposit` that can
+ /// be retried. This is in addition to any retries allowed for via
+ /// `min_per_sec`. Must be between 0 and 1000.
+ ///
+ /// As an example, if `0.1` is used, then for every 10 calls to `deposit`,
+ /// 1 retry will be allowed. If `2.0` is used, then every `deposit`
+ /// allows for 2 retries.
+ pub fn new(ttl: Duration, min_per_sec: u32, retry_percent: f32) -> Self {
+ // assertions taken from finagle
+ assert!(ttl >= Duration::from_secs(1));
+ assert!(ttl <= Duration::from_secs(60));
+ assert!(retry_percent >= 0.0);
+ assert!(retry_percent <= 1000.0);
+ assert!(min_per_sec < ::std::i32::MAX as u32);
+
+ let (deposit_amount, withdraw_amount) = if retry_percent == 0.0 {
+ // If there is no percent, then you gain nothing from deposits.
+ // Withdrawals can only be made against the reserve, over time.
+ (0, 1)
+ } else if retry_percent <= 1.0 {
+ (1, (1.0 / retry_percent) as isize)
+ } else {
+ // Support for when retry_percent is between 1.0 and 1000.0,
+ // meaning for every deposit D, D*retry_percent withdrawals
+ // can be made.
+ (1000, (1000.0 / retry_percent) as isize)
+ };
+ let reserve = (min_per_sec as isize)
+ .saturating_mul(ttl.as_secs() as isize) // ttl is between 1 and 60 seconds
+ .saturating_mul(withdraw_amount);
+
+ // AtomicIsize isn't clone, so the slots need to be built in a loop...
+ let windows = 10u32;
+ let mut slots = Vec::with_capacity(windows as usize);
+ for _ in 0..windows {
+ slots.push(AtomicIsize::new(0));
+ }
+
+ Budget {
+ bucket: Bucket {
+ generation: Mutex::new(Generation {
+ index: 0,
+ time: Instant::now(),
+ }),
+ reserve,
+ slots: slots.into_boxed_slice(),
+ window: ttl / windows,
+ writer: AtomicIsize::new(0),
+ },
+ deposit_amount,
+ withdraw_amount,
+ }
+ }
+
+ /// Store a "deposit" in the budget, which will be used to permit future
+ /// withdrawals.
+ pub fn deposit(&self) {
+ self.bucket.put(self.deposit_amount);
+ }
+
+ /// Check whether there is enough "balance" in the budget to issue a new
+ /// retry.
+ ///
+ /// If there is not enough, an `Err(Overdrawn)` is returned.
+ pub fn withdraw(&self) -> Result<(), Overdrawn> {
+ if self.bucket.try_get(self.withdraw_amount) {
+ Ok(())
+ } else {
+ Err(Overdrawn { _inner: () })
+ }
+ }
+}
+
+impl Default for Budget {
+ fn default() -> Budget {
+ Budget::new(Duration::from_secs(10), 10, 0.2)
+ }
+}
+
+impl fmt::Debug for Budget {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_struct("Budget")
+ .field("deposit", &self.deposit_amount)
+ .field("withdraw", &self.withdraw_amount)
+ .field("balance", &self.bucket.sum())
+ .finish()
+ }
+}
+
+// ===== impl Bucket =====
+
+impl Bucket {
+ fn put(&self, amt: isize) {
+ self.expire();
+ self.writer.fetch_add(amt, Ordering::SeqCst);
+ }
+
+ fn try_get(&self, amt: isize) -> bool {
+ debug_assert!(amt >= 0);
+
+ self.expire();
+
+ let sum = self.sum();
+ if sum >= amt {
+ self.writer.fetch_add(-amt, Ordering::SeqCst);
+ true
+ } else {
+ false
+ }
+ }
+
+ fn expire(&self) {
+ let mut gen = self.generation.lock().expect("generation lock");
+
+ let now = Instant::now();
+ let diff = now.saturating_duration_since(gen.time);
+ if diff < self.window {
+ // not expired yet
+ return;
+ }
+
+ let to_commit = self.writer.swap(0, Ordering::SeqCst);
+ self.slots[gen.index].store(to_commit, Ordering::SeqCst);
+
+ let mut diff = diff;
+ let mut idx = (gen.index + 1) % self.slots.len();
+ while diff > self.window {
+ self.slots[idx].store(0, Ordering::SeqCst);
+ diff -= self.window;
+ idx = (idx + 1) % self.slots.len();
+ }
+
+ gen.index = idx;
+ gen.time = now;
+ }
+
+ fn sum(&self) -> isize {
+ let current = self.writer.load(Ordering::SeqCst);
+ let windowed_sum: isize = self
+ .slots
+ .iter()
+ .map(|slot| slot.load(Ordering::SeqCst))
+ // fold() is used instead of sum() to determine overflow behavior
+ .fold(0, isize::saturating_add);
+
+ current
+ .saturating_add(windowed_sum)
+ .saturating_add(self.reserve)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use tokio::time;
+
+ #[test]
+ fn empty() {
+ let bgt = Budget::new(Duration::from_secs(1), 0, 1.0);
+ bgt.withdraw().unwrap_err();
+ }
+
+ #[tokio::test]
+ async fn leaky() {
+ time::pause();
+
+ let bgt = Budget::new(Duration::from_secs(1), 0, 1.0);
+ bgt.deposit();
+
+ time::advance(Duration::from_secs(3)).await;
+
+ bgt.withdraw().unwrap_err();
+ }
+
+ #[tokio::test]
+ async fn slots() {
+ time::pause();
+
+ let bgt = Budget::new(Duration::from_secs(1), 0, 0.5);
+ bgt.deposit();
+ bgt.deposit();
+ time::advance(Duration::from_millis(901)).await;
+ // 900ms later, the deposit should still be valid
+ bgt.withdraw().unwrap();
+
+ // blank slate
+ time::advance(Duration::from_millis(2001)).await;
+
+ bgt.deposit();
+ time::advance(Duration::from_millis(301)).await;
+ bgt.deposit();
+ time::advance(Duration::from_millis(801)).await;
+ bgt.deposit();
+
+ // the first deposit is expired, but the 2nd should still be valid,
+ // combining with the 3rd
+ bgt.withdraw().unwrap();
+ }
+
+ #[tokio::test]
+ async fn reserve() {
+ let bgt = Budget::new(Duration::from_secs(1), 5, 1.0);
+ bgt.withdraw().unwrap();
+ bgt.withdraw().unwrap();
+ bgt.withdraw().unwrap();
+ bgt.withdraw().unwrap();
+ bgt.withdraw().unwrap();
+
+ bgt.withdraw().unwrap_err();
+ }
+}
diff --git a/crates/tower/src/retry/future.rs b/crates/tower/src/retry/future.rs
new file mode 100644
index 0000000..d18a5ab
--- /dev/null
+++ b/crates/tower/src/retry/future.rs
@@ -0,0 +1,123 @@
+//! Future types
+
+use super::{Policy, Retry};
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::future::Future;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+pin_project! {
+ /// The [`Future`] returned by a [`Retry`] service.
+ #[derive(Debug)]
+ pub struct ResponseFuture<P, S, Request>
+ where
+ P: Policy<Request, S::Response, S::Error>,
+ S: Service<Request>,
+ {
+ request: Option<Request>,
+ #[pin]
+ retry: Retry<P, S>,
+ #[pin]
+ state: State<S::Future, P::Future>,
+ }
+}
+
+pin_project! {
+ #[project = StateProj]
+ #[derive(Debug)]
+ enum State<F, P> {
+ // Polling the future from [`Service::call`]
+ Called {
+ #[pin]
+ future: F
+ },
+ // Polling the future from [`Policy::retry`]
+ Checking {
+ #[pin]
+ checking: P
+ },
+ // Polling [`Service::poll_ready`] after [`Checking`] was OK.
+ Retrying,
+ }
+}
+
+impl<P, S, Request> ResponseFuture<P, S, Request>
+where
+ P: Policy<Request, S::Response, S::Error>,
+ S: Service<Request>,
+{
+ pub(crate) fn new(
+ request: Option<Request>,
+ retry: Retry<P, S>,
+ future: S::Future,
+ ) -> ResponseFuture<P, S, Request> {
+ ResponseFuture {
+ request,
+ retry,
+ state: State::Called { future },
+ }
+ }
+}
+
+impl<P, S, Request> Future for ResponseFuture<P, S, Request>
+where
+ P: Policy<Request, S::Response, S::Error> + Clone,
+ S: Service<Request> + Clone,
+{
+ type Output = Result<S::Response, S::Error>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let mut this = self.project();
+
+ loop {
+ match this.state.as_mut().project() {
+ StateProj::Called { future } => {
+ let result = ready!(future.poll(cx));
+ if let Some(ref req) = this.request {
+ match this.retry.policy.retry(req, result.as_ref()) {
+ Some(checking) => {
+ this.state.set(State::Checking { checking });
+ }
+ None => return Poll::Ready(result),
+ }
+ } else {
+ // request wasn't cloned, so no way to retry it
+ return Poll::Ready(result);
+ }
+ }
+ StateProj::Checking { checking } => {
+ this.retry
+ .as_mut()
+ .project()
+ .policy
+ .set(ready!(checking.poll(cx)));
+ this.state.set(State::Retrying);
+ }
+ StateProj::Retrying => {
+ // NOTE: we assume here that
+ //
+ // this.retry.poll_ready()
+ //
+ // is equivalent to
+ //
+ // this.retry.service.poll_ready()
+ //
+ // we need to make that assumption to avoid adding an Unpin bound to the Policy
+ // in Ready to make it Unpin so that we can get &mut Ready as needed to call
+ // poll_ready on it.
+ ready!(this.retry.as_mut().project().service.poll_ready(cx))?;
+ let req = this
+ .request
+ .take()
+ .expect("retrying requires cloned request");
+ *this.request = this.retry.policy.clone_request(&req);
+ this.state.set(State::Called {
+ future: this.retry.as_mut().project().service.call(req),
+ });
+ }
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/retry/layer.rs b/crates/tower/src/retry/layer.rs
new file mode 100644
index 0000000..ea03c78
--- /dev/null
+++ b/crates/tower/src/retry/layer.rs
@@ -0,0 +1,27 @@
+use super::Retry;
+use tower_layer::Layer;
+
+/// Retry requests based on a policy
+#[derive(Debug)]
+pub struct RetryLayer<P> {
+ policy: P,
+}
+
+impl<P> RetryLayer<P> {
+ /// Create a new [`RetryLayer`] from a retry policy
+ pub fn new(policy: P) -> Self {
+ RetryLayer { policy }
+ }
+}
+
+impl<P, S> Layer<S> for RetryLayer<P>
+where
+ P: Clone,
+{
+ type Service = Retry<P, S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ let policy = self.policy.clone();
+ Retry::new(policy, service)
+ }
+}
diff --git a/crates/tower/src/retry/mod.rs b/crates/tower/src/retry/mod.rs
new file mode 100644
index 0000000..a9e2738
--- /dev/null
+++ b/crates/tower/src/retry/mod.rs
@@ -0,0 +1,74 @@
+//! Middleware for retrying "failed" requests.
+
+pub mod budget;
+pub mod future;
+mod layer;
+mod policy;
+
+pub use self::layer::RetryLayer;
+pub use self::policy::Policy;
+
+use self::future::ResponseFuture;
+use pin_project_lite::pin_project;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+pin_project! {
+ /// Configure retrying requests of "failed" responses.
+ ///
+ /// A [`Policy`] classifies what is a "failed" response.
+ #[derive(Clone, Debug)]
+ pub struct Retry<P, S> {
+ #[pin]
+ policy: P,
+ service: S,
+ }
+}
+
+// ===== impl Retry =====
+
+impl<P, S> Retry<P, S> {
+ /// Retry the inner service depending on this [`Policy`].
+ pub fn new(policy: P, service: S) -> Self {
+ Retry { policy, service }
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &S {
+ &self.service
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut S {
+ &mut self.service
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> S {
+ self.service
+ }
+}
+
+impl<P, S, Request> Service<Request> for Retry<P, S>
+where
+ P: Policy<Request, S::Response, S::Error> + Clone,
+ S: Service<Request> + Clone,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = ResponseFuture<P, S, Request>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ // NOTE: the Future::poll impl for ResponseFuture assumes that Retry::poll_ready is
+ // equivalent to Ready.service.poll_ready. If this ever changes, that code must be updated
+ // as well.
+ self.service.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ let cloned = self.policy.clone_request(&request);
+ let future = self.service.call(request);
+
+ ResponseFuture::new(cloned, self.clone(), future)
+ }
+}
diff --git a/crates/tower/src/retry/never.rs b/crates/tower/src/retry/never.rs
new file mode 100644
index 0000000..af7264b
--- /dev/null
+++ b/crates/tower/src/retry/never.rs
@@ -0,0 +1,13 @@
+use std::fmt;
+
+#[derive(Debug)]
+/// An error that can never occur.
+pub enum Never {}
+
+impl fmt::Display for Never {
+ fn fmt(&self, _: &mut fmt::Formatter) -> fmt::Result {
+ match *self {}
+ }
+}
+
+impl std::error::Error for Never {}
diff --git a/crates/tower/src/retry/policy.rs b/crates/tower/src/retry/policy.rs
new file mode 100644
index 0000000..6f8a5b7
--- /dev/null
+++ b/crates/tower/src/retry/policy.rs
@@ -0,0 +1,67 @@
+use std::future::Future;
+
+/// A "retry policy" to classify if a request should be retried.
+///
+/// # Example
+///
+/// ```
+/// use tower::retry::Policy;
+/// use futures_util::future;
+///
+/// type Req = String;
+/// type Res = String;
+///
+/// struct Attempts(usize);
+///
+/// impl<E> Policy<Req, Res, E> for Attempts {
+/// type Future = future::Ready<Self>;
+///
+/// fn retry(&self, req: &Req, result: Result<&Res, &E>) -> Option<Self::Future> {
+/// match result {
+/// Ok(_) => {
+/// // Treat all `Response`s as success,
+/// // so don't retry...
+/// None
+/// },
+/// Err(_) => {
+/// // Treat all errors as failures...
+/// // But we limit the number of attempts...
+/// if self.0 > 0 {
+/// // Try again!
+/// Some(future::ready(Attempts(self.0 - 1)))
+/// } else {
+/// // Used all our attempts, no retry...
+/// None
+/// }
+/// }
+/// }
+/// }
+///
+/// fn clone_request(&self, req: &Req) -> Option<Req> {
+/// Some(req.clone())
+/// }
+/// }
+/// ```
+pub trait Policy<Req, Res, E>: Sized {
+ /// The [`Future`] type returned by [`Policy::retry`].
+ type Future: Future<Output = Self>;
+
+ /// Check the policy if a certain request should be retried.
+ ///
+ /// This method is passed a reference to the original request, and either
+ /// the [`Service::Response`] or [`Service::Error`] from the inner service.
+ ///
+ /// If the request should **not** be retried, return `None`.
+ ///
+ /// If the request *should* be retried, return `Some` future of a new
+ /// policy that would apply for the next request attempt.
+ ///
+ /// [`Service::Response`]: crate::Service::Response
+ /// [`Service::Error`]: crate::Service::Error
+ fn retry(&self, req: &Req, result: Result<&Res, &E>) -> Option<Self::Future>;
+
+ /// Tries to clone a request before being passed to the inner service.
+ ///
+ /// If the request cannot be cloned, return [`None`].
+ fn clone_request(&self, req: &Req) -> Option<Req>;
+}
diff --git a/crates/tower/src/spawn_ready/future.rs b/crates/tower/src/spawn_ready/future.rs
new file mode 100644
index 0000000..c7d4da5
--- /dev/null
+++ b/crates/tower/src/spawn_ready/future.rs
@@ -0,0 +1,8 @@
+//! Background readiness types
+
+opaque_future! {
+ /// Response future from [`SpawnReady`] services.
+ ///
+ /// [`SpawnReady`]: crate::spawn_ready::SpawnReady
+ pub type ResponseFuture<F, E> = futures_util::future::MapErr<F, fn(E) -> crate::BoxError>;
+}
diff --git a/crates/tower/src/spawn_ready/layer.rs b/crates/tower/src/spawn_ready/layer.rs
new file mode 100644
index 0000000..1151ea1
--- /dev/null
+++ b/crates/tower/src/spawn_ready/layer.rs
@@ -0,0 +1,21 @@
+use super::MakeSpawnReady;
+use tower_layer::Layer;
+
+/// Spawns tasks to drive its inner service to readiness.
+#[derive(Debug, Clone, Default)]
+pub struct SpawnReadyLayer;
+
+impl SpawnReadyLayer {
+ /// Builds a [`SpawnReadyLayer`] with the default executor.
+ pub fn new() -> Self {
+ Self
+ }
+}
+
+impl<S> Layer<S> for SpawnReadyLayer {
+ type Service = MakeSpawnReady<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ MakeSpawnReady::new(service)
+ }
+}
diff --git a/crates/tower/src/spawn_ready/make.rs b/crates/tower/src/spawn_ready/make.rs
new file mode 100644
index 0000000..a8adc73
--- /dev/null
+++ b/crates/tower/src/spawn_ready/make.rs
@@ -0,0 +1,64 @@
+use super::SpawnReady;
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+/// Builds [`SpawnReady`] instances with the result of an inner [`Service`].
+#[derive(Clone, Debug)]
+pub struct MakeSpawnReady<S> {
+ inner: S,
+}
+
+impl<S> MakeSpawnReady<S> {
+ /// Creates a new [`MakeSpawnReady`] wrapping `service`.
+ pub fn new(service: S) -> Self {
+ Self { inner: service }
+ }
+}
+
+pin_project! {
+ /// Builds a [`SpawnReady`] with the result of an inner [`Future`].
+ #[derive(Debug)]
+ pub struct MakeFuture<F> {
+ #[pin]
+ inner: F,
+ }
+}
+
+impl<S, Target> Service<Target> for MakeSpawnReady<S>
+where
+ S: Service<Target>,
+{
+ type Response = SpawnReady<S::Response>;
+ type Error = S::Error;
+ type Future = MakeFuture<S::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, target: Target) -> Self::Future {
+ MakeFuture {
+ inner: self.inner.call(target),
+ }
+ }
+}
+
+impl<F, T, E> Future for MakeFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+{
+ type Output = Result<SpawnReady<T>, E>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+ let inner = ready!(this.inner.poll(cx))?;
+ let svc = SpawnReady::new(inner);
+ Poll::Ready(Ok(svc))
+ }
+}
diff --git a/crates/tower/src/spawn_ready/mod.rs b/crates/tower/src/spawn_ready/mod.rs
new file mode 100644
index 0000000..7b725b8
--- /dev/null
+++ b/crates/tower/src/spawn_ready/mod.rs
@@ -0,0 +1,11 @@
+//! When an underlying service is not ready, drive it to readiness on a
+//! background task.
+
+pub mod future;
+mod layer;
+mod make;
+mod service;
+
+pub use self::layer::SpawnReadyLayer;
+pub use self::make::{MakeFuture, MakeSpawnReady};
+pub use self::service::SpawnReady;
diff --git a/crates/tower/src/spawn_ready/service.rs b/crates/tower/src/spawn_ready/service.rs
new file mode 100644
index 0000000..7461843
--- /dev/null
+++ b/crates/tower/src/spawn_ready/service.rs
@@ -0,0 +1,83 @@
+use super::future::ResponseFuture;
+use crate::{util::ServiceExt, BoxError};
+use futures_core::ready;
+use futures_util::future::TryFutureExt;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+use tracing::Instrument;
+
+/// Spawns tasks to drive an inner service to readiness.
+///
+/// See crate level documentation for more details.
+#[derive(Debug)]
+pub struct SpawnReady<S> {
+ inner: Inner<S>,
+}
+
+#[derive(Debug)]
+enum Inner<S> {
+ Service(Option<S>),
+ Future(tokio::task::JoinHandle<Result<S, BoxError>>),
+}
+
+impl<S> SpawnReady<S> {
+ /// Creates a new [`SpawnReady`] wrapping `service`.
+ pub fn new(service: S) -> Self {
+ Self {
+ inner: Inner::Service(Some(service)),
+ }
+ }
+}
+
+impl<S> Drop for SpawnReady<S> {
+ fn drop(&mut self) {
+ if let Inner::Future(ref mut task) = self.inner {
+ task.abort();
+ }
+ }
+}
+
+impl<S, Req> Service<Req> for SpawnReady<S>
+where
+ Req: 'static,
+ S: Service<Req> + Send + 'static,
+ S::Error: Into<BoxError>,
+{
+ type Response = S::Response;
+ type Error = BoxError;
+ type Future = ResponseFuture<S::Future, S::Error>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), BoxError>> {
+ loop {
+ self.inner = match self.inner {
+ Inner::Service(ref mut svc) => {
+ if let Poll::Ready(r) = svc.as_mut().expect("illegal state").poll_ready(cx) {
+ return Poll::Ready(r.map_err(Into::into));
+ }
+
+ let svc = svc.take().expect("illegal state");
+ let rx =
+ tokio::spawn(svc.ready_oneshot().map_err(Into::into).in_current_span());
+ Inner::Future(rx)
+ }
+ Inner::Future(ref mut fut) => {
+ let svc = ready!(Pin::new(fut).poll(cx))??;
+ Inner::Service(Some(svc))
+ }
+ }
+ }
+ }
+
+ fn call(&mut self, request: Req) -> Self::Future {
+ match self.inner {
+ Inner::Service(Some(ref mut svc)) => {
+ ResponseFuture::new(svc.call(request).map_err(Into::into))
+ }
+ _ => unreachable!("poll_ready must be called"),
+ }
+ }
+}
diff --git a/crates/tower/src/steer/mod.rs b/crates/tower/src/steer/mod.rs
new file mode 100644
index 0000000..3483c92
--- /dev/null
+++ b/crates/tower/src/steer/mod.rs
@@ -0,0 +1,204 @@
+//! This module provides functionality to aid managing routing requests between [`Service`]s.
+//!
+//! # Example
+//!
+//! [`Steer`] can for example be used to create a router, akin to what you might find in web
+//! frameworks.
+//!
+//! Here, `GET /` will be sent to the `root` service, while all other requests go to `not_found`.
+//!
+//! ```rust
+//! # use std::task::{Context, Poll};
+//! # use tower_service::Service;
+//! # use futures_util::future::{ready, Ready, poll_fn};
+//! # use tower::steer::Steer;
+//! # use tower::service_fn;
+//! # use tower::util::BoxService;
+//! # use tower::ServiceExt;
+//! # use std::convert::Infallible;
+//! use http::{Request, Response, StatusCode, Method};
+//!
+//! # #[tokio::main]
+//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
+//! // Service that responds to `GET /`
+//! let root = service_fn(|req: Request<String>| async move {
+//! # assert_eq!(req.uri().path(), "/");
+//! let res = Response::new("Hello, World!".to_string());
+//! Ok::<_, Infallible>(res)
+//! });
+//! // We have to box the service so its type gets erased and we can put it in a `Vec` with other
+//! // services
+//! let root = BoxService::new(root);
+//!
+//! // Service that responds with `404 Not Found` to all requests
+//! let not_found = service_fn(|req: Request<String>| async move {
+//! let res = Response::builder()
+//! .status(StatusCode::NOT_FOUND)
+//! .body(String::new())
+//! .expect("response is valid");
+//! Ok::<_, Infallible>(res)
+//! });
+//! // Box that as well
+//! let not_found = BoxService::new(not_found);
+//!
+//! let mut svc = Steer::new(
+//! // All services we route between
+//! vec![root, not_found],
+//! // How we pick which service to send the request to
+//! |req: &Request<String>, _services: &[_]| {
+//! if req.method() == Method::GET && req.uri().path() == "/" {
+//! 0 // Index of `root`
+//! } else {
+//! 1 // Index of `not_found`
+//! }
+//! },
+//! );
+//!
+//! // This request will get sent to `root`
+//! let req = Request::get("/").body(String::new()).unwrap();
+//! let res = svc.ready().await?.call(req).await?;
+//! assert_eq!(res.into_body(), "Hello, World!");
+//!
+//! // This request will get sent to `not_found`
+//! let req = Request::get("/does/not/exist").body(String::new()).unwrap();
+//! let res = svc.ready().await?.call(req).await?;
+//! assert_eq!(res.status(), StatusCode::NOT_FOUND);
+//! assert_eq!(res.into_body(), "");
+//! #
+//! # Ok(())
+//! # }
+//! ```
+use std::task::{Context, Poll};
+use std::{collections::VecDeque, fmt, marker::PhantomData};
+use tower_service::Service;
+
+/// This is how callers of [`Steer`] tell it which `Service` a `Req` corresponds to.
+pub trait Picker<S, Req> {
+ /// Return an index into the iterator of `Service` passed to [`Steer::new`].
+ fn pick(&mut self, r: &Req, services: &[S]) -> usize;
+}
+
+impl<S, F, Req> Picker<S, Req> for F
+where
+ F: Fn(&Req, &[S]) -> usize,
+{
+ fn pick(&mut self, r: &Req, services: &[S]) -> usize {
+ self(r, services)
+ }
+}
+
+/// [`Steer`] manages a list of [`Service`]s which all handle the same type of request.
+///
+/// An example use case is a sharded service.
+/// It accepts new requests, then:
+/// 1. Determines, via the provided [`Picker`], which [`Service`] the request coresponds to.
+/// 2. Waits (in [`Service::poll_ready`]) for *all* services to be ready.
+/// 3. Calls the correct [`Service`] with the request, and returns a future corresponding to the
+/// call.
+///
+/// Note that [`Steer`] must wait for all services to be ready since it can't know ahead of time
+/// which [`Service`] the next message will arrive for, and is unwilling to buffer items
+/// indefinitely. This will cause head-of-line blocking unless paired with a [`Service`] that does
+/// buffer items indefinitely, and thus always returns [`Poll::Ready`]. For example, wrapping each
+/// component service with a [`Buffer`] with a high enough limit (the maximum number of concurrent
+/// requests) will prevent head-of-line blocking in [`Steer`].
+///
+/// [`Buffer`]: crate::buffer::Buffer
+pub struct Steer<S, F, Req> {
+ router: F,
+ services: Vec<S>,
+ not_ready: VecDeque<usize>,
+ _phantom: PhantomData<Req>,
+}
+
+impl<S, F, Req> Steer<S, F, Req> {
+ /// Make a new [`Steer`] with a list of [`Service`]'s and a [`Picker`].
+ ///
+ /// Note: the order of the [`Service`]'s is significant for [`Picker::pick`]'s return value.
+ pub fn new(services: impl IntoIterator<Item = S>, router: F) -> Self {
+ let services: Vec<_> = services.into_iter().collect();
+ let not_ready: VecDeque<_> = services.iter().enumerate().map(|(i, _)| i).collect();
+ Self {
+ router,
+ services,
+ not_ready,
+ _phantom: PhantomData,
+ }
+ }
+}
+
+impl<S, Req, F> Service<Req> for Steer<S, F, Req>
+where
+ S: Service<Req>,
+ F: Picker<S, Req>,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ loop {
+ // must wait for *all* services to be ready.
+ // this will cause head-of-line blocking unless the underlying services are always ready.
+ if self.not_ready.is_empty() {
+ return Poll::Ready(Ok(()));
+ } else {
+ if self.services[self.not_ready[0]]
+ .poll_ready(cx)?
+ .is_pending()
+ {
+ return Poll::Pending;
+ }
+
+ self.not_ready.pop_front();
+ }
+ }
+ }
+
+ fn call(&mut self, req: Req) -> Self::Future {
+ assert!(
+ self.not_ready.is_empty(),
+ "Steer must wait for all services to be ready. Did you forget to call poll_ready()?"
+ );
+
+ let idx = self.router.pick(&req, &self.services[..]);
+ let cl = &mut self.services[idx];
+ self.not_ready.push_back(idx);
+ cl.call(req)
+ }
+}
+
+impl<S, F, Req> Clone for Steer<S, F, Req>
+where
+ S: Clone,
+ F: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ router: self.router.clone(),
+ services: self.services.clone(),
+ not_ready: self.not_ready.clone(),
+ _phantom: PhantomData,
+ }
+ }
+}
+
+impl<S, F, Req> fmt::Debug for Steer<S, F, Req>
+where
+ S: fmt::Debug,
+ F: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let Self {
+ router,
+ services,
+ not_ready,
+ _phantom,
+ } = self;
+ f.debug_struct("Steer")
+ .field("router", router)
+ .field("services", services)
+ .field("not_ready", not_ready)
+ .finish()
+ }
+}
diff --git a/crates/tower/src/timeout/error.rs b/crates/tower/src/timeout/error.rs
new file mode 100644
index 0000000..223cada
--- /dev/null
+++ b/crates/tower/src/timeout/error.rs
@@ -0,0 +1,22 @@
+//! Error types
+
+use std::{error, fmt};
+
+/// The timeout elapsed.
+#[derive(Debug, Default)]
+pub struct Elapsed(pub(super) ());
+
+impl Elapsed {
+ /// Construct a new elapsed error
+ pub fn new() -> Self {
+ Elapsed(())
+ }
+}
+
+impl fmt::Display for Elapsed {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad("request timed out")
+ }
+}
+
+impl error::Error for Elapsed {}
diff --git a/crates/tower/src/timeout/future.rs b/crates/tower/src/timeout/future.rs
new file mode 100644
index 0000000..b4eb3f4
--- /dev/null
+++ b/crates/tower/src/timeout/future.rs
@@ -0,0 +1,53 @@
+//! Future types
+
+use super::error::Elapsed;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tokio::time::Sleep;
+
+pin_project! {
+ /// [`Timeout`] response future
+ ///
+ /// [`Timeout`]: crate::timeout::Timeout
+ #[derive(Debug)]
+ pub struct ResponseFuture<T> {
+ #[pin]
+ response: T,
+ #[pin]
+ sleep: Sleep,
+ }
+}
+
+impl<T> ResponseFuture<T> {
+ pub(crate) fn new(response: T, sleep: Sleep) -> Self {
+ ResponseFuture { response, sleep }
+ }
+}
+
+impl<F, T, E> Future for ResponseFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+
+ // First, try polling the future
+ match this.response.poll(cx) {
+ Poll::Ready(v) => return Poll::Ready(v.map_err(Into::into)),
+ Poll::Pending => {}
+ }
+
+ // Now check the sleep
+ match this.sleep.poll(cx) {
+ Poll::Pending => Poll::Pending,
+ Poll::Ready(_) => Poll::Ready(Err(Elapsed(()).into())),
+ }
+ }
+}
diff --git a/crates/tower/src/timeout/layer.rs b/crates/tower/src/timeout/layer.rs
new file mode 100644
index 0000000..3397fd8
--- /dev/null
+++ b/crates/tower/src/timeout/layer.rs
@@ -0,0 +1,24 @@
+use super::Timeout;
+use std::time::Duration;
+use tower_layer::Layer;
+
+/// Applies a timeout to requests via the supplied inner service.
+#[derive(Debug, Clone)]
+pub struct TimeoutLayer {
+ timeout: Duration,
+}
+
+impl TimeoutLayer {
+ /// Create a timeout from a duration
+ pub fn new(timeout: Duration) -> Self {
+ TimeoutLayer { timeout }
+ }
+}
+
+impl<S> Layer<S> for TimeoutLayer {
+ type Service = Timeout<S>;
+
+ fn layer(&self, service: S) -> Self::Service {
+ Timeout::new(service, self.timeout)
+ }
+}
diff --git a/crates/tower/src/timeout/mod.rs b/crates/tower/src/timeout/mod.rs
new file mode 100644
index 0000000..0e65a3f
--- /dev/null
+++ b/crates/tower/src/timeout/mod.rs
@@ -0,0 +1,70 @@
+//! Middleware that applies a timeout to requests.
+//!
+//! If the response does not complete within the specified timeout, the response
+//! will be aborted.
+
+pub mod error;
+pub mod future;
+mod layer;
+
+pub use self::layer::TimeoutLayer;
+
+use self::future::ResponseFuture;
+use std::task::{Context, Poll};
+use std::time::Duration;
+use tower_service::Service;
+
+/// Applies a timeout to requests.
+#[derive(Debug, Clone)]
+pub struct Timeout<T> {
+ inner: T,
+ timeout: Duration,
+}
+
+// ===== impl Timeout =====
+
+impl<T> Timeout<T> {
+ /// Creates a new [`Timeout`]
+ pub fn new(inner: T, timeout: Duration) -> Self {
+ Timeout { inner, timeout }
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &T {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
+
+impl<S, Request> Service<Request> for Timeout<S>
+where
+ S: Service<Request>,
+ S::Error: Into<crate::BoxError>,
+{
+ type Response = S::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<S::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ match self.inner.poll_ready(cx) {
+ Poll::Pending => Poll::Pending,
+ Poll::Ready(r) => Poll::Ready(r.map_err(Into::into)),
+ }
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ let response = self.inner.call(request);
+ let sleep = tokio::time::sleep(self.timeout);
+
+ ResponseFuture::new(response, sleep)
+ }
+}
diff --git a/crates/tower/src/util/and_then.rs b/crates/tower/src/util/and_then.rs
new file mode 100644
index 0000000..819ca27
--- /dev/null
+++ b/crates/tower/src/util/and_then.rs
@@ -0,0 +1,130 @@
+use futures_core::TryFuture;
+use futures_util::{future, TryFutureExt};
+use std::fmt;
+use std::future::Future;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Service returned by the [`and_then`] combinator.
+///
+/// [`and_then`]: crate::util::ServiceExt::and_then
+#[derive(Clone)]
+pub struct AndThen<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for AndThen<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("AndThen")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+pin_project_lite::pin_project! {
+ /// Response future from [`AndThen`] services.
+ ///
+ /// [`AndThen`]: crate::util::AndThen
+ pub struct AndThenFuture<F1, F2: TryFuture, N> {
+ #[pin]
+ inner: future::AndThen<future::ErrInto<F1, F2::Error>, F2, N>,
+ }
+}
+
+impl<F1, F2: TryFuture, N> AndThenFuture<F1, F2, N> {
+ pub(crate) fn new(inner: future::AndThen<future::ErrInto<F1, F2::Error>, F2, N>) -> Self {
+ Self { inner }
+ }
+}
+
+impl<F1, F2: TryFuture, N> std::fmt::Debug for AndThenFuture<F1, F2, N> {
+ fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+ f.debug_tuple("AndThenFuture")
+ .field(&format_args!("..."))
+ .finish()
+ }
+}
+
+impl<F1, F2: TryFuture, N> Future for AndThenFuture<F1, F2, N>
+where
+ future::AndThen<future::ErrInto<F1, F2::Error>, F2, N>: Future,
+{
+ type Output = <future::AndThen<future::ErrInto<F1, F2::Error>, F2, N> as Future>::Output;
+
+ #[inline]
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ self.project().inner.poll(cx)
+ }
+}
+
+/// A [`Layer`] that produces a [`AndThen`] service.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Clone, Debug)]
+pub struct AndThenLayer<F> {
+ f: F,
+}
+
+impl<S, F> AndThen<S, F> {
+ /// Creates a new `AndThen` service.
+ pub fn new(inner: S, f: F) -> Self {
+ AndThen { f, inner }
+ }
+
+ /// Returns a new [`Layer`] that produces [`AndThen`] services.
+ ///
+ /// This is a convenience function that simply calls [`AndThenLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> AndThenLayer<F> {
+ AndThenLayer { f }
+ }
+}
+
+impl<S, F, Request, Fut> Service<Request> for AndThen<S, F>
+where
+ S: Service<Request>,
+ S::Error: Into<Fut::Error>,
+ F: FnOnce(S::Response) -> Fut + Clone,
+ Fut: TryFuture,
+{
+ type Response = Fut::Ok;
+ type Error = Fut::Error;
+ type Future = AndThenFuture<S::Future, Fut, F>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(Into::into)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ AndThenFuture::new(self.inner.call(request).err_into().and_then(self.f.clone()))
+ }
+}
+
+impl<F> AndThenLayer<F> {
+ /// Creates a new [`AndThenLayer`] layer.
+ pub fn new(f: F) -> Self {
+ AndThenLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for AndThenLayer<F>
+where
+ F: Clone,
+{
+ type Service = AndThen<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ AndThen {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/src/util/boxed/layer.rs b/crates/tower/src/util/boxed/layer.rs
new file mode 100644
index 0000000..34e65fa
--- /dev/null
+++ b/crates/tower/src/util/boxed/layer.rs
@@ -0,0 +1,97 @@
+use crate::util::BoxService;
+use std::{fmt, sync::Arc};
+use tower_layer::{layer_fn, Layer};
+use tower_service::Service;
+
+/// A boxed [`Layer`] trait object.
+///
+/// [`BoxLayer`] turns a layer into a trait object, allowing both the [`Layer`] itself
+/// and the output [`Service`] to be dynamic, while having consistent types.
+///
+/// This [`Layer`] produces [`BoxService`] instances erasing the type of the
+/// [`Service`] produced by the wrapped [`Layer`].
+///
+/// # Example
+///
+/// `BoxLayer` can, for example, be useful to create layers dynamically that otherwise wouldn't have
+/// the same types. In this example, we include a [`Timeout`] layer
+/// only if an environment variable is set. We can use `BoxLayer`
+/// to return a consistent type regardless of runtime configuration:
+///
+/// ```
+/// use std::time::Duration;
+/// use tower::{Service, ServiceBuilder, BoxError, util::BoxLayer};
+///
+/// fn common_layer<S, T>() -> BoxLayer<S, T, S::Response, BoxError>
+/// where
+/// S: Service<T> + Send + 'static,
+/// S::Future: Send + 'static,
+/// S::Error: Into<BoxError> + 'static,
+/// {
+/// let builder = ServiceBuilder::new()
+/// .concurrency_limit(100);
+///
+/// if std::env::var("SET_TIMEOUT").is_ok() {
+/// let layer = builder
+/// .timeout(Duration::from_secs(30))
+/// .into_inner();
+///
+/// BoxLayer::new(layer)
+/// } else {
+/// let layer = builder
+/// .map_err(Into::into)
+/// .into_inner();
+///
+/// BoxLayer::new(layer)
+/// }
+/// }
+/// ```
+///
+/// [`Layer`]: tower_layer::Layer
+/// [`Service`]: tower_service::Service
+/// [`BoxService`]: super::BoxService
+/// [`Timeout`]: crate::timeout
+pub struct BoxLayer<In, T, U, E> {
+ boxed: Arc<dyn Layer<In, Service = BoxService<T, U, E>> + Send + Sync + 'static>,
+}
+
+impl<In, T, U, E> BoxLayer<In, T, U, E> {
+ /// Create a new [`BoxLayer`].
+ pub fn new<L>(inner_layer: L) -> Self
+ where
+ L: Layer<In> + Send + Sync + 'static,
+ L::Service: Service<T, Response = U, Error = E> + Send + 'static,
+ <L::Service as Service<T>>::Future: Send + 'static,
+ {
+ let layer = layer_fn(move |inner: In| {
+ let out = inner_layer.layer(inner);
+ BoxService::new(out)
+ });
+
+ Self {
+ boxed: Arc::new(layer),
+ }
+ }
+}
+
+impl<In, T, U, E> Layer<In> for BoxLayer<In, T, U, E> {
+ type Service = BoxService<T, U, E>;
+
+ fn layer(&self, inner: In) -> Self::Service {
+ self.boxed.layer(inner)
+ }
+}
+
+impl<In, T, U, E> Clone for BoxLayer<In, T, U, E> {
+ fn clone(&self) -> Self {
+ Self {
+ boxed: Arc::clone(&self.boxed),
+ }
+ }
+}
+
+impl<In, T, U, E> fmt::Debug for BoxLayer<In, T, U, E> {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_struct("BoxLayer").finish()
+ }
+}
diff --git a/crates/tower/src/util/boxed/mod.rs b/crates/tower/src/util/boxed/mod.rs
new file mode 100644
index 0000000..436b8ec
--- /dev/null
+++ b/crates/tower/src/util/boxed/mod.rs
@@ -0,0 +1,40 @@
+//! Trait object [`Service`] instances
+//!
+//! Dynamically dispatched [`Service`] objects allow for erasing the underlying
+//! [`Service`] type and using the `Service` instances as opaque handles. This can
+//! be useful when the service instance cannot be explicitly named for whatever
+//! reason.
+//!
+//! There are two variants of service objects. [`BoxService`] requires both the
+//! service and the response future to be [`Send`]. These values can move freely
+//! across threads. [`UnsyncBoxService`] requires both the service and the
+//! response future to remain on the current thread. This is useful for
+//! representing services that are backed by [`Rc`] or other non-[`Send`] types.
+//!
+//! # Examples
+//!
+//! ```
+//! use futures_util::future::ready;
+//! # use tower_service::Service;
+//! # use tower::util::{BoxService, service_fn};
+//! // Respond to requests using a closure, but closures cannot be named...
+//! # pub fn main() {
+//! let svc = service_fn(|mut request: String| {
+//! request.push_str(" response");
+//! ready(Ok(request))
+//! });
+//!
+//! let service: BoxService<String, String, ()> = BoxService::new(svc);
+//! # drop(service);
+//! }
+//! ```
+//!
+//! [`Service`]: crate::Service
+//! [`Rc`]: std::rc::Rc
+
+mod layer;
+mod sync;
+mod unsync;
+
+#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
+pub use self::{layer::BoxLayer, sync::BoxService, unsync::UnsyncBoxService};
diff --git a/crates/tower/src/util/boxed/sync.rs b/crates/tower/src/util/boxed/sync.rs
new file mode 100644
index 0000000..8c02fb4
--- /dev/null
+++ b/crates/tower/src/util/boxed/sync.rs
@@ -0,0 +1,74 @@
+use crate::ServiceExt;
+use tower_layer::{layer_fn, LayerFn};
+use tower_service::Service;
+
+use std::fmt;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+/// A boxed `Service + Send` trait object.
+///
+/// [`BoxService`] turns a service into a trait object, allowing the response
+/// future type to be dynamic. This type requires both the service and the
+/// response future to be [`Send`].
+///
+/// If you need a boxed [`Service`] that implements [`Clone`] consider using
+/// [`BoxCloneService`](crate::util::BoxCloneService).
+///
+/// See module level documentation for more details.
+pub struct BoxService<T, U, E> {
+ inner: Box<dyn Service<T, Response = U, Error = E, Future = BoxFuture<U, E>> + Send>,
+}
+
+/// A boxed `Future + Send` trait object.
+///
+/// This type alias represents a boxed future that is [`Send`] and can be moved
+/// across threads.
+type BoxFuture<T, E> = Pin<Box<dyn Future<Output = Result<T, E>> + Send>>;
+
+impl<T, U, E> BoxService<T, U, E> {
+ #[allow(missing_docs)]
+ pub fn new<S>(inner: S) -> Self
+ where
+ S: Service<T, Response = U, Error = E> + Send + 'static,
+ S::Future: Send + 'static,
+ {
+ let inner = Box::new(inner.map_future(|f: S::Future| Box::pin(f) as _));
+ BoxService { inner }
+ }
+
+ /// Returns a [`Layer`] for wrapping a [`Service`] in a [`BoxService`]
+ /// middleware.
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer<S>() -> LayerFn<fn(S) -> Self>
+ where
+ S: Service<T, Response = U, Error = E> + Send + 'static,
+ S::Future: Send + 'static,
+ {
+ layer_fn(Self::new)
+ }
+}
+
+impl<T, U, E> Service<T> for BoxService<T, U, E> {
+ type Response = U;
+ type Error = E;
+ type Future = BoxFuture<U, E>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), E>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: T) -> BoxFuture<U, E> {
+ self.inner.call(request)
+ }
+}
+
+impl<T, U, E> fmt::Debug for BoxService<T, U, E> {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_struct("BoxService").finish()
+ }
+}
diff --git a/crates/tower/src/util/boxed/unsync.rs b/crates/tower/src/util/boxed/unsync.rs
new file mode 100644
index 0000000..f645f16
--- /dev/null
+++ b/crates/tower/src/util/boxed/unsync.rs
@@ -0,0 +1,86 @@
+use tower_layer::{layer_fn, LayerFn};
+use tower_service::Service;
+
+use std::fmt;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+/// A boxed [`Service`] trait object.
+pub struct UnsyncBoxService<T, U, E> {
+ inner: Box<dyn Service<T, Response = U, Error = E, Future = UnsyncBoxFuture<U, E>>>,
+}
+
+/// A boxed [`Future`] trait object.
+///
+/// This type alias represents a boxed future that is *not* [`Send`] and must
+/// remain on the current thread.
+type UnsyncBoxFuture<T, E> = Pin<Box<dyn Future<Output = Result<T, E>>>>;
+
+#[derive(Debug)]
+struct UnsyncBoxed<S> {
+ inner: S,
+}
+
+impl<T, U, E> UnsyncBoxService<T, U, E> {
+ #[allow(missing_docs)]
+ pub fn new<S>(inner: S) -> Self
+ where
+ S: Service<T, Response = U, Error = E> + 'static,
+ S::Future: 'static,
+ {
+ let inner = Box::new(UnsyncBoxed { inner });
+ UnsyncBoxService { inner }
+ }
+
+ /// Returns a [`Layer`] for wrapping a [`Service`] in an [`UnsyncBoxService`] middleware.
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer<S>() -> LayerFn<fn(S) -> Self>
+ where
+ S: Service<T, Response = U, Error = E> + 'static,
+ S::Future: 'static,
+ {
+ layer_fn(Self::new)
+ }
+}
+
+impl<T, U, E> Service<T> for UnsyncBoxService<T, U, E> {
+ type Response = U;
+ type Error = E;
+ type Future = UnsyncBoxFuture<U, E>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), E>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: T) -> UnsyncBoxFuture<U, E> {
+ self.inner.call(request)
+ }
+}
+
+impl<T, U, E> fmt::Debug for UnsyncBoxService<T, U, E> {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_struct("UnsyncBoxService").finish()
+ }
+}
+
+impl<S, Request> Service<Request> for UnsyncBoxed<S>
+where
+ S: Service<Request> + 'static,
+ S::Future: 'static,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = Pin<Box<dyn Future<Output = Result<S::Response, S::Error>>>>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ Box::pin(self.inner.call(request))
+ }
+}
diff --git a/crates/tower/src/util/boxed_clone.rs b/crates/tower/src/util/boxed_clone.rs
new file mode 100644
index 0000000..1209fd2
--- /dev/null
+++ b/crates/tower/src/util/boxed_clone.rs
@@ -0,0 +1,136 @@
+use super::ServiceExt;
+use futures_util::future::BoxFuture;
+use std::{
+ fmt,
+ task::{Context, Poll},
+};
+use tower_layer::{layer_fn, LayerFn};
+use tower_service::Service;
+
+/// A [`Clone`] + [`Send`] boxed [`Service`].
+///
+/// [`BoxCloneService`] turns a service into a trait object, allowing the
+/// response future type to be dynamic, and allowing the service to be cloned.
+///
+/// This is similar to [`BoxService`](super::BoxService) except the resulting
+/// service implements [`Clone`].
+///
+/// # Example
+///
+/// ```
+/// use tower::{Service, ServiceBuilder, BoxError, util::BoxCloneService};
+/// use std::time::Duration;
+/// #
+/// # struct Request;
+/// # struct Response;
+/// # impl Response {
+/// # fn new() -> Self { Self }
+/// # }
+///
+/// // This service has a complex type that is hard to name
+/// let service = ServiceBuilder::new()
+/// .map_request(|req| {
+/// println!("received request");
+/// req
+/// })
+/// .map_response(|res| {
+/// println!("response produced");
+/// res
+/// })
+/// .load_shed()
+/// .concurrency_limit(64)
+/// .timeout(Duration::from_secs(10))
+/// .service_fn(|req: Request| async {
+/// Ok::<_, BoxError>(Response::new())
+/// });
+/// # let service = assert_service(service);
+///
+/// // `BoxCloneService` will erase the type so it's nameable
+/// let service: BoxCloneService<Request, Response, BoxError> = BoxCloneService::new(service);
+/// # let service = assert_service(service);
+///
+/// // And we can still clone the service
+/// let cloned_service = service.clone();
+/// #
+/// # fn assert_service<S, R>(svc: S) -> S
+/// # where S: Service<R> { svc }
+/// ```
+pub struct BoxCloneService<T, U, E>(
+ Box<
+ dyn CloneService<T, Response = U, Error = E, Future = BoxFuture<'static, Result<U, E>>>
+ + Send,
+ >,
+);
+
+impl<T, U, E> BoxCloneService<T, U, E> {
+ /// Create a new `BoxCloneService`.
+ pub fn new<S>(inner: S) -> Self
+ where
+ S: Service<T, Response = U, Error = E> + Clone + Send + 'static,
+ S::Future: Send + 'static,
+ {
+ let inner = inner.map_future(|f| Box::pin(f) as _);
+ BoxCloneService(Box::new(inner))
+ }
+
+ /// Returns a [`Layer`] for wrapping a [`Service`] in a [`BoxCloneService`]
+ /// middleware.
+ ///
+ /// [`Layer`]: crate::Layer
+ pub fn layer<S>() -> LayerFn<fn(S) -> Self>
+ where
+ S: Service<T, Response = U, Error = E> + Clone + Send + 'static,
+ S::Future: Send + 'static,
+ {
+ layer_fn(Self::new)
+ }
+}
+
+impl<T, U, E> Service<T> for BoxCloneService<T, U, E> {
+ type Response = U;
+ type Error = E;
+ type Future = BoxFuture<'static, Result<U, E>>;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), E>> {
+ self.0.poll_ready(cx)
+ }
+
+ #[inline]
+ fn call(&mut self, request: T) -> Self::Future {
+ self.0.call(request)
+ }
+}
+
+impl<T, U, E> Clone for BoxCloneService<T, U, E> {
+ fn clone(&self) -> Self {
+ Self(self.0.clone_box())
+ }
+}
+
+trait CloneService<R>: Service<R> {
+ fn clone_box(
+ &self,
+ ) -> Box<
+ dyn CloneService<R, Response = Self::Response, Error = Self::Error, Future = Self::Future>
+ + Send,
+ >;
+}
+
+impl<R, T> CloneService<R> for T
+where
+ T: Service<R> + Send + Clone + 'static,
+{
+ fn clone_box(
+ &self,
+ ) -> Box<dyn CloneService<R, Response = T::Response, Error = T::Error, Future = T::Future> + Send>
+ {
+ Box::new(self.clone())
+ }
+}
+
+impl<T, U, E> fmt::Debug for BoxCloneService<T, U, E> {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ fmt.debug_struct("BoxCloneService").finish()
+ }
+}
diff --git a/crates/tower/src/util/call_all/common.rs b/crates/tower/src/util/call_all/common.rs
new file mode 100644
index 0000000..8e37afc
--- /dev/null
+++ b/crates/tower/src/util/call_all/common.rs
@@ -0,0 +1,118 @@
+use futures_core::{ready, Stream};
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// The [`Future`] returned by the [`ServiceExt::call_all`] combinator.
+ #[derive(Debug)]
+ pub(crate) struct CallAll<Svc, S, Q> {
+ service: Option<Svc>,
+ #[pin]
+ stream: S,
+ queue: Q,
+ eof: bool,
+ }
+}
+
+pub(crate) trait Drive<F: Future> {
+ fn is_empty(&self) -> bool;
+
+ fn push(&mut self, future: F);
+
+ fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Option<F::Output>>;
+}
+
+impl<Svc, S, Q> CallAll<Svc, S, Q>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+ Q: Drive<Svc::Future>,
+{
+ pub(crate) fn new(service: Svc, stream: S, queue: Q) -> CallAll<Svc, S, Q> {
+ CallAll {
+ service: Some(service),
+ stream,
+ queue,
+ eof: false,
+ }
+ }
+
+ /// Extract the wrapped [`Service`].
+ pub(crate) fn into_inner(mut self) -> Svc {
+ self.service.take().expect("Service already taken")
+ }
+
+ /// Extract the wrapped [`Service`].
+ pub(crate) fn take_service(self: Pin<&mut Self>) -> Svc {
+ self.project()
+ .service
+ .take()
+ .expect("Service already taken")
+ }
+
+ pub(crate) fn unordered(mut self) -> super::CallAllUnordered<Svc, S> {
+ assert!(self.queue.is_empty() && !self.eof);
+
+ super::CallAllUnordered::new(self.service.take().unwrap(), self.stream)
+ }
+}
+
+impl<Svc, S, Q> Stream for CallAll<Svc, S, Q>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+ Q: Drive<Svc::Future>,
+{
+ type Item = Result<Svc::Response, crate::BoxError>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ let mut this = self.project();
+
+ loop {
+ // First, see if we have any responses to yield
+ if let Poll::Ready(r) = this.queue.poll(cx) {
+ if let Some(rsp) = r.transpose().map_err(Into::into)? {
+ return Poll::Ready(Some(Ok(rsp)));
+ }
+ }
+
+ // If there are no more requests coming, check if we're done
+ if *this.eof {
+ if this.queue.is_empty() {
+ return Poll::Ready(None);
+ } else {
+ return Poll::Pending;
+ }
+ }
+
+ // Then, see that the service is ready for another request
+ let svc = this
+ .service
+ .as_mut()
+ .expect("Using CallAll after extracing inner Service");
+ ready!(svc.poll_ready(cx)).map_err(Into::into)?;
+
+ // If it is, gather the next request (if there is one), or return `Pending` if the
+ // stream is not ready.
+ // TODO: We probably want to "release" the slot we reserved in Svc if the
+ // stream returns `Pending`. It may be a while until we get around to actually
+ // using it.
+ match ready!(this.stream.as_mut().poll_next(cx)) {
+ Some(req) => {
+ this.queue.push(svc.call(req));
+ }
+ None => {
+ // We're all done once any outstanding requests have completed
+ *this.eof = true;
+ }
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/util/call_all/mod.rs b/crates/tower/src/util/call_all/mod.rs
new file mode 100644
index 0000000..0cac72d
--- /dev/null
+++ b/crates/tower/src/util/call_all/mod.rs
@@ -0,0 +1,11 @@
+//! [`Stream<Item = Request>`][stream] + [`Service<Request>`] => [`Stream<Item = Response>`][stream].
+//!
+//! [`Service<Request>`]: crate::Service
+//! [stream]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+
+mod common;
+mod ordered;
+mod unordered;
+
+#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
+pub use self::{ordered::CallAll, unordered::CallAllUnordered};
diff --git a/crates/tower/src/util/call_all/ordered.rs b/crates/tower/src/util/call_all/ordered.rs
new file mode 100644
index 0000000..a0c9ae4
--- /dev/null
+++ b/crates/tower/src/util/call_all/ordered.rs
@@ -0,0 +1,179 @@
+//! [`Stream<Item = Request>`][stream] + [`Service<Request>`] => [`Stream<Item = Response>`][stream].
+//!
+//! [`Service<Request>`]: crate::Service
+//! [stream]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+
+use super::common;
+use futures_core::Stream;
+use futures_util::stream::FuturesOrdered;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// This is a [`Stream`] of responses resulting from calling the wrapped [`Service`] for each
+ /// request received on the wrapped [`Stream`].
+ ///
+ /// ```rust
+ /// # use std::task::{Poll, Context};
+ /// # use std::cell::Cell;
+ /// # use std::error::Error;
+ /// # use std::rc::Rc;
+ /// #
+ /// use futures::future::{ready, Ready};
+ /// use futures::StreamExt;
+ /// use futures::channel::mpsc;
+ /// use tower_service::Service;
+ /// use tower::util::ServiceExt;
+ ///
+ /// // First, we need to have a Service to process our requests.
+ /// #[derive(Debug, Eq, PartialEq)]
+ /// struct FirstLetter;
+ /// impl Service<&'static str> for FirstLetter {
+ /// type Response = &'static str;
+ /// type Error = Box<dyn Error + Send + Sync>;
+ /// type Future = Ready<Result<Self::Response, Self::Error>>;
+ ///
+ /// fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// Poll::Ready(Ok(()))
+ /// }
+ ///
+ /// fn call(&mut self, req: &'static str) -> Self::Future {
+ /// ready(Ok(&req[..1]))
+ /// }
+ /// }
+ ///
+ /// #[tokio::main]
+ /// async fn main() {
+ /// // Next, we need a Stream of requests.
+ // TODO(eliza): when `tokio-util` has a nice way to convert MPSCs to streams,
+ // tokio::sync::mpsc again?
+ /// let (mut reqs, rx) = mpsc::unbounded();
+ /// // Note that we have to help Rust out here by telling it what error type to use.
+ /// // Specifically, it has to be From<Service::Error> + From<Stream::Error>.
+ /// let mut rsps = FirstLetter.call_all(rx);
+ ///
+ /// // Now, let's send a few requests and then check that we get the corresponding responses.
+ /// reqs.unbounded_send("one").unwrap();
+ /// reqs.unbounded_send("two").unwrap();
+ /// reqs.unbounded_send("three").unwrap();
+ /// drop(reqs);
+ ///
+ /// // We then loop over the response Strem that we get back from call_all.
+ /// let mut i = 0usize;
+ /// while let Some(rsp) = rsps.next().await {
+ /// // Each response is a Result (we could also have used TryStream::try_next)
+ /// match (i + 1, rsp.unwrap()) {
+ /// (1, "o") |
+ /// (2, "t") |
+ /// (3, "t") => {}
+ /// (n, i) => {
+ /// unreachable!("{}. response was '{}'", n, i);
+ /// }
+ /// }
+ /// i += 1;
+ /// }
+ ///
+ /// // And at the end, we can get the Service back when there are no more requests.
+ /// assert_eq!(rsps.into_inner(), FirstLetter);
+ /// }
+ /// ```
+ ///
+ /// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+ #[derive(Debug)]
+ pub struct CallAll<Svc, S>
+ where
+ Svc: Service<S::Item>,
+ S: Stream,
+ {
+ #[pin]
+ inner: common::CallAll<Svc, S, FuturesOrdered<Svc::Future>>,
+ }
+}
+
+impl<Svc, S> CallAll<Svc, S>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+{
+ /// Create new [`CallAll`] combinator.
+ ///
+ /// Each request yielded by `stream` is passed to `svc`, and the resulting responses are
+ /// yielded in the same order by the implementation of [`Stream`] for [`CallAll`].
+ ///
+ /// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+ pub fn new(service: Svc, stream: S) -> CallAll<Svc, S> {
+ CallAll {
+ inner: common::CallAll::new(service, stream, FuturesOrdered::new()),
+ }
+ }
+
+ /// Extract the wrapped [`Service`].
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`take_service`] was already called.
+ ///
+ /// [`take_service`]: crate::util::CallAll::take_service
+ pub fn into_inner(self) -> Svc {
+ self.inner.into_inner()
+ }
+
+ /// Extract the wrapped [`Service`].
+ ///
+ /// This [`CallAll`] can no longer be used after this function has been called.
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`take_service`] was already called.
+ ///
+ /// [`take_service`]: crate::util::CallAll::take_service
+ pub fn take_service(self: Pin<&mut Self>) -> Svc {
+ self.project().inner.take_service()
+ }
+
+ /// Return responses as they are ready, regardless of the initial order.
+ ///
+ /// This function must be called before the stream is polled.
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`poll`] was called.
+ ///
+ /// [`poll`]: std::future::Future::poll
+ pub fn unordered(self) -> super::CallAllUnordered<Svc, S> {
+ self.inner.unordered()
+ }
+}
+
+impl<Svc, S> Stream for CallAll<Svc, S>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+{
+ type Item = Result<Svc::Response, crate::BoxError>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
+
+impl<F: Future> common::Drive<F> for FuturesOrdered<F> {
+ fn is_empty(&self) -> bool {
+ FuturesOrdered::is_empty(self)
+ }
+
+ fn push(&mut self, future: F) {
+ FuturesOrdered::push(self, future)
+ }
+
+ fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Option<F::Output>> {
+ Stream::poll_next(Pin::new(self), cx)
+ }
+}
diff --git a/crates/tower/src/util/call_all/unordered.rs b/crates/tower/src/util/call_all/unordered.rs
new file mode 100644
index 0000000..acf2c86
--- /dev/null
+++ b/crates/tower/src/util/call_all/unordered.rs
@@ -0,0 +1,100 @@
+//! [`Stream<Item = Request>`][stream] + [`Service<Request>`] => [`Stream<Item = Response>`][stream].
+//!
+//! [`Service<Request>`]: crate::Service
+//! [stream]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+
+use super::common;
+use futures_core::Stream;
+use futures_util::stream::FuturesUnordered;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// A stream of responses received from the inner service in received order.
+ ///
+ /// Similar to [`CallAll`] except, instead of yielding responses in request order,
+ /// responses are returned as they are available.
+ ///
+ /// [`CallAll`]: crate::util::CallAll
+ #[derive(Debug)]
+ pub struct CallAllUnordered<Svc, S>
+ where
+ Svc: Service<S::Item>,
+ S: Stream,
+ {
+ #[pin]
+ inner: common::CallAll<Svc, S, FuturesUnordered<Svc::Future>>,
+ }
+}
+
+impl<Svc, S> CallAllUnordered<Svc, S>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+{
+ /// Create new [`CallAllUnordered`] combinator.
+ ///
+ /// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+ pub fn new(service: Svc, stream: S) -> CallAllUnordered<Svc, S> {
+ CallAllUnordered {
+ inner: common::CallAll::new(service, stream, FuturesUnordered::new()),
+ }
+ }
+
+ /// Extract the wrapped [`Service`].
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`take_service`] was already called.
+ ///
+ /// [`take_service`]: crate::util::CallAllUnordered::take_service
+ pub fn into_inner(self) -> Svc {
+ self.inner.into_inner()
+ }
+
+ /// Extract the wrapped `Service`.
+ ///
+ /// This [`CallAllUnordered`] can no longer be used after this function has been called.
+ ///
+ /// # Panics
+ ///
+ /// Panics if [`take_service`] was already called.
+ ///
+ /// [`take_service`]: crate::util::CallAllUnordered::take_service
+ pub fn take_service(self: Pin<&mut Self>) -> Svc {
+ self.project().inner.take_service()
+ }
+}
+
+impl<Svc, S> Stream for CallAllUnordered<Svc, S>
+where
+ Svc: Service<S::Item>,
+ Svc::Error: Into<crate::BoxError>,
+ S: Stream,
+{
+ type Item = Result<Svc::Response, crate::BoxError>;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_next(cx)
+ }
+}
+
+impl<F: Future> common::Drive<F> for FuturesUnordered<F> {
+ fn is_empty(&self) -> bool {
+ FuturesUnordered::is_empty(self)
+ }
+
+ fn push(&mut self, future: F) {
+ FuturesUnordered::push(self, future)
+ }
+
+ fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Option<F::Output>> {
+ Stream::poll_next(Pin::new(self), cx)
+ }
+}
diff --git a/crates/tower/src/util/either.rs b/crates/tower/src/util/either.rs
new file mode 100644
index 0000000..5933755
--- /dev/null
+++ b/crates/tower/src/util/either.rs
@@ -0,0 +1,89 @@
+//! Contains [`Either`] and related types and functions.
+//!
+//! See [`Either`] documentation for more details.
+
+use futures_core::ready;
+use pin_project::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Combine two different service types into a single type.
+///
+/// Both services must be of the same request, response, and error types.
+/// [`Either`] is useful for handling conditional branching in service middleware
+/// to different inner service types.
+#[pin_project(project = EitherProj)]
+#[derive(Clone, Debug)]
+pub enum Either<A, B> {
+ /// One type of backing [`Service`].
+ A(#[pin] A),
+ /// The other type of backing [`Service`].
+ B(#[pin] B),
+}
+
+impl<A, B, Request> Service<Request> for Either<A, B>
+where
+ A: Service<Request>,
+ A::Error: Into<crate::BoxError>,
+ B: Service<Request, Response = A::Response>,
+ B::Error: Into<crate::BoxError>,
+{
+ type Response = A::Response;
+ type Error = crate::BoxError;
+ type Future = Either<A::Future, B::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ use self::Either::*;
+
+ match self {
+ A(service) => Poll::Ready(Ok(ready!(service.poll_ready(cx)).map_err(Into::into)?)),
+ B(service) => Poll::Ready(Ok(ready!(service.poll_ready(cx)).map_err(Into::into)?)),
+ }
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ use self::Either::*;
+
+ match self {
+ A(service) => A(service.call(request)),
+ B(service) => B(service.call(request)),
+ }
+ }
+}
+
+impl<A, B, T, AE, BE> Future for Either<A, B>
+where
+ A: Future<Output = Result<T, AE>>,
+ AE: Into<crate::BoxError>,
+ B: Future<Output = Result<T, BE>>,
+ BE: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ match self.project() {
+ EitherProj::A(fut) => Poll::Ready(Ok(ready!(fut.poll(cx)).map_err(Into::into)?)),
+ EitherProj::B(fut) => Poll::Ready(Ok(ready!(fut.poll(cx)).map_err(Into::into)?)),
+ }
+ }
+}
+
+impl<S, A, B> Layer<S> for Either<A, B>
+where
+ A: Layer<S>,
+ B: Layer<S>,
+{
+ type Service = Either<A::Service, B::Service>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ match self {
+ Either::A(layer) => Either::A(layer.layer(inner)),
+ Either::B(layer) => Either::B(layer.layer(inner)),
+ }
+ }
+}
diff --git a/crates/tower/src/util/future_service.rs b/crates/tower/src/util/future_service.rs
new file mode 100644
index 0000000..ef3a749
--- /dev/null
+++ b/crates/tower/src/util/future_service.rs
@@ -0,0 +1,215 @@
+use std::fmt;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+/// Returns a new [`FutureService`] for the given future.
+///
+/// A [`FutureService`] allows you to treat a future that resolves to a service as a service. This
+/// can be useful for services that are created asynchronously.
+///
+/// # Example
+/// ```
+/// use tower::{service_fn, Service, ServiceExt};
+/// use tower::util::future_service;
+/// use std::convert::Infallible;
+///
+/// # fn main() {
+/// # async {
+/// // A future which outputs a type implementing `Service`.
+/// let future_of_a_service = async {
+/// let svc = service_fn(|_req: ()| async { Ok::<_, Infallible>("ok") });
+/// Ok::<_, Infallible>(svc)
+/// };
+///
+/// // Wrap the future with a `FutureService`, allowing it to be used
+/// // as a service without awaiting the future's completion:
+/// let mut svc = future_service(Box::pin(future_of_a_service));
+///
+/// // Now, when we wait for the service to become ready, it will
+/// // drive the future to completion internally.
+/// let svc = svc.ready().await.unwrap();
+/// let res = svc.call(()).await.unwrap();
+/// # };
+/// # }
+/// ```
+///
+/// # Regarding the [`Unpin`] bound
+///
+/// The [`Unpin`] bound on `F` is necessary because the future will be polled in
+/// [`Service::poll_ready`] which doesn't have a pinned receiver (it takes `&mut self` and not `self:
+/// Pin<&mut Self>`). So we cannot put the future into a `Pin` without requiring `Unpin`.
+///
+/// This will most likely come up if you're calling `future_service` with an async block. In that
+/// case you can use `Box::pin(async { ... })` as shown in the example.
+pub fn future_service<F, S, R, E>(future: F) -> FutureService<F, S>
+where
+ F: Future<Output = Result<S, E>> + Unpin,
+ S: Service<R, Error = E>,
+{
+ FutureService::new(future)
+}
+
+/// A type that implements [`Service`] for a [`Future`] that produces a [`Service`].
+///
+/// See [`future_service`] for more details.
+#[derive(Clone)]
+pub struct FutureService<F, S> {
+ state: State<F, S>,
+}
+
+impl<F, S> FutureService<F, S> {
+ /// Returns a new [`FutureService`] for the given future.
+ ///
+ /// A [`FutureService`] allows you to treat a future that resolves to a service as a service. This
+ /// can be useful for services that are created asynchronously.
+ ///
+ /// # Example
+ /// ```
+ /// use tower::{service_fn, Service, ServiceExt};
+ /// use tower::util::FutureService;
+ /// use std::convert::Infallible;
+ ///
+ /// # fn main() {
+ /// # async {
+ /// // A future which outputs a type implementing `Service`.
+ /// let future_of_a_service = async {
+ /// let svc = service_fn(|_req: ()| async { Ok::<_, Infallible>("ok") });
+ /// Ok::<_, Infallible>(svc)
+ /// };
+ ///
+ /// // Wrap the future with a `FutureService`, allowing it to be used
+ /// // as a service without awaiting the future's completion:
+ /// let mut svc = FutureService::new(Box::pin(future_of_a_service));
+ ///
+ /// // Now, when we wait for the service to become ready, it will
+ /// // drive the future to completion internally.
+ /// let svc = svc.ready().await.unwrap();
+ /// let res = svc.call(()).await.unwrap();
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// # Regarding the [`Unpin`] bound
+ ///
+ /// The [`Unpin`] bound on `F` is necessary because the future will be polled in
+ /// [`Service::poll_ready`] which doesn't have a pinned receiver (it takes `&mut self` and not `self:
+ /// Pin<&mut Self>`). So we cannot put the future into a `Pin` without requiring `Unpin`.
+ ///
+ /// This will most likely come up if you're calling `future_service` with an async block. In that
+ /// case you can use `Box::pin(async { ... })` as shown in the example.
+ pub fn new(future: F) -> Self {
+ Self {
+ state: State::Future(future),
+ }
+ }
+}
+
+impl<F, S> fmt::Debug for FutureService<F, S>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FutureService")
+ .field("state", &format_args!("{:?}", self.state))
+ .finish()
+ }
+}
+
+#[derive(Clone)]
+enum State<F, S> {
+ Future(F),
+ Service(S),
+}
+
+impl<F, S> fmt::Debug for State<F, S>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ State::Future(_) => f
+ .debug_tuple("State::Future")
+ .field(&format_args!("<{}>", std::any::type_name::<F>()))
+ .finish(),
+ State::Service(svc) => f.debug_tuple("State::Service").field(svc).finish(),
+ }
+ }
+}
+
+impl<F, S, R, E> Service<R> for FutureService<F, S>
+where
+ F: Future<Output = Result<S, E>> + Unpin,
+ S: Service<R, Error = E>,
+{
+ type Response = S::Response;
+ type Error = E;
+ type Future = S::Future;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ loop {
+ self.state = match &mut self.state {
+ State::Future(fut) => {
+ let fut = Pin::new(fut);
+ let svc = futures_core::ready!(fut.poll(cx)?);
+ State::Service(svc)
+ }
+ State::Service(svc) => return svc.poll_ready(cx),
+ };
+ }
+ }
+
+ fn call(&mut self, req: R) -> Self::Future {
+ if let State::Service(svc) = &mut self.state {
+ svc.call(req)
+ } else {
+ panic!("FutureService::call was called before FutureService::poll_ready")
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::util::{future_service, ServiceExt};
+ use crate::Service;
+ use futures::future::{ready, Ready};
+ use std::convert::Infallible;
+
+ #[tokio::test]
+ async fn pending_service_debug_impl() {
+ let mut pending_svc = future_service(ready(Ok(DebugService)));
+
+ assert_eq!(
+ format!("{:?}", pending_svc),
+ "FutureService { state: State::Future(<futures_util::future::ready::Ready<core::result::Result<tower::util::future_service::tests::DebugService, core::convert::Infallible>>>) }"
+ );
+
+ pending_svc.ready().await.unwrap();
+
+ assert_eq!(
+ format!("{:?}", pending_svc),
+ "FutureService { state: State::Service(DebugService) }"
+ );
+ }
+
+ #[derive(Debug)]
+ struct DebugService;
+
+ impl Service<()> for DebugService {
+ type Response = ();
+ type Error = Infallible;
+ type Future = Ready<Result<Self::Response, Self::Error>>;
+
+ fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ Ok(()).into()
+ }
+
+ fn call(&mut self, _req: ()) -> Self::Future {
+ ready(Ok(()))
+ }
+ }
+}
diff --git a/crates/tower/src/util/map_err.rs b/crates/tower/src/util/map_err.rs
new file mode 100644
index 0000000..b79c5fe
--- /dev/null
+++ b/crates/tower/src/util/map_err.rs
@@ -0,0 +1,98 @@
+use futures_util::{future, TryFutureExt};
+use std::fmt;
+use std::task::{Context, Poll};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Service returned by the [`map_err`] combinator.
+///
+/// [`map_err`]: crate::util::ServiceExt::map_err
+#[derive(Clone)]
+pub struct MapErr<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for MapErr<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapErr")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+/// A [`Layer`] that produces [`MapErr`] services.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Clone, Debug)]
+pub struct MapErrLayer<F> {
+ f: F,
+}
+
+opaque_future! {
+ /// Response future from [`MapErr`] services.
+ ///
+ /// [`MapErr`]: crate::util::MapErr
+ pub type MapErrFuture<F, N> = future::MapErr<F, N>;
+}
+
+impl<S, F> MapErr<S, F> {
+ /// Creates a new [`MapErr`] service.
+ pub fn new(inner: S, f: F) -> Self {
+ MapErr { f, inner }
+ }
+
+ /// Returns a new [`Layer`] that produces [`MapErr`] services.
+ ///
+ /// This is a convenience function that simply calls [`MapErrLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> MapErrLayer<F> {
+ MapErrLayer { f }
+ }
+}
+
+impl<S, F, Request, Error> Service<Request> for MapErr<S, F>
+where
+ S: Service<Request>,
+ F: FnOnce(S::Error) -> Error + Clone,
+{
+ type Response = S::Response;
+ type Error = Error;
+ type Future = MapErrFuture<S::Future, F>;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(self.f.clone())
+ }
+
+ #[inline]
+ fn call(&mut self, request: Request) -> Self::Future {
+ MapErrFuture::new(self.inner.call(request).map_err(self.f.clone()))
+ }
+}
+
+impl<F> MapErrLayer<F> {
+ /// Creates a new [`MapErrLayer`].
+ pub fn new(f: F) -> Self {
+ MapErrLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for MapErrLayer<F>
+where
+ F: Clone,
+{
+ type Service = MapErr<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ MapErr {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/src/util/map_future.rs b/crates/tower/src/util/map_future.rs
new file mode 100644
index 0000000..9f5670a
--- /dev/null
+++ b/crates/tower/src/util/map_future.rs
@@ -0,0 +1,113 @@
+use std::{
+ fmt,
+ future::Future,
+ task::{Context, Poll},
+};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// [`Service`] returned by the [`map_future`] combinator.
+///
+/// [`map_future`]: crate::util::ServiceExt::map_future
+#[derive(Clone)]
+pub struct MapFuture<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> MapFuture<S, F> {
+ /// Creates a new [`MapFuture`] service.
+ pub fn new(inner: S, f: F) -> Self {
+ Self { inner, f }
+ }
+
+ /// Returns a new [`Layer`] that produces [`MapFuture`] services.
+ ///
+ /// This is a convenience function that simply calls [`MapFutureLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> MapFutureLayer<F> {
+ MapFutureLayer::new(f)
+ }
+
+ /// Get a reference to the inner service
+ pub fn get_ref(&self) -> &S {
+ &self.inner
+ }
+
+ /// Get a mutable reference to the inner service
+ pub fn get_mut(&mut self) -> &mut S {
+ &mut self.inner
+ }
+
+ /// Consume `self`, returning the inner service
+ pub fn into_inner(self) -> S {
+ self.inner
+ }
+}
+
+impl<R, S, F, T, E, Fut> Service<R> for MapFuture<S, F>
+where
+ S: Service<R>,
+ F: FnMut(S::Future) -> Fut,
+ E: From<S::Error>,
+ Fut: Future<Output = Result<T, E>>,
+{
+ type Response = T;
+ type Error = E;
+ type Future = Fut;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(From::from)
+ }
+
+ fn call(&mut self, req: R) -> Self::Future {
+ (self.f)(self.inner.call(req))
+ }
+}
+
+impl<S, F> fmt::Debug for MapFuture<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapFuture")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+/// A [`Layer`] that produces a [`MapFuture`] service.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Clone)]
+pub struct MapFutureLayer<F> {
+ f: F,
+}
+
+impl<F> MapFutureLayer<F> {
+ /// Creates a new [`MapFutureLayer`] layer.
+ pub fn new(f: F) -> Self {
+ Self { f }
+ }
+}
+
+impl<S, F> Layer<S> for MapFutureLayer<F>
+where
+ F: Clone,
+{
+ type Service = MapFuture<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ MapFuture::new(inner, self.f.clone())
+ }
+}
+
+impl<F> fmt::Debug for MapFutureLayer<F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapFutureLayer")
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
diff --git a/crates/tower/src/util/map_request.rs b/crates/tower/src/util/map_request.rs
new file mode 100644
index 0000000..e86e068
--- /dev/null
+++ b/crates/tower/src/util/map_request.rs
@@ -0,0 +1,90 @@
+use std::fmt;
+use std::task::{Context, Poll};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Service returned by the [`MapRequest`] combinator.
+///
+/// [`MapRequest`]: crate::util::ServiceExt::map_request
+#[derive(Clone)]
+pub struct MapRequest<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for MapRequest<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapRequest")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+impl<S, F> MapRequest<S, F> {
+ /// Creates a new [`MapRequest`] service.
+ pub fn new(inner: S, f: F) -> Self {
+ MapRequest { inner, f }
+ }
+
+ /// Returns a new [`Layer`] that produces [`MapRequest`] services.
+ ///
+ /// This is a convenience function that simply calls [`MapRequestLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> MapRequestLayer<F> {
+ MapRequestLayer { f }
+ }
+}
+
+impl<S, F, R1, R2> Service<R1> for MapRequest<S, F>
+where
+ S: Service<R2>,
+ F: FnMut(R1) -> R2,
+{
+ type Response = S::Response;
+ type Error = S::Error;
+ type Future = S::Future;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), S::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ #[inline]
+ fn call(&mut self, request: R1) -> S::Future {
+ self.inner.call((self.f)(request))
+ }
+}
+
+/// A [`Layer`] that produces [`MapRequest`] services.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Clone, Debug)]
+pub struct MapRequestLayer<F> {
+ f: F,
+}
+
+impl<F> MapRequestLayer<F> {
+ /// Creates a new [`MapRequestLayer`].
+ pub fn new(f: F) -> Self {
+ MapRequestLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for MapRequestLayer<F>
+where
+ F: Clone,
+{
+ type Service = MapRequest<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ MapRequest {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/src/util/map_response.rs b/crates/tower/src/util/map_response.rs
new file mode 100644
index 0000000..249be3a
--- /dev/null
+++ b/crates/tower/src/util/map_response.rs
@@ -0,0 +1,98 @@
+use futures_util::{future::MapOk, TryFutureExt};
+use std::fmt;
+use std::task::{Context, Poll};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Service returned by the [`map_response`] combinator.
+///
+/// [`map_response`]: crate::util::ServiceExt::map_response
+#[derive(Clone)]
+pub struct MapResponse<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for MapResponse<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapResponse")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+/// A [`Layer`] that produces a [`MapResponse`] service.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Debug, Clone)]
+pub struct MapResponseLayer<F> {
+ f: F,
+}
+
+opaque_future! {
+ /// Response future from [`MapResponse`] services.
+ ///
+ /// [`MapResponse`]: crate::util::MapResponse
+ pub type MapResponseFuture<F, N> = MapOk<F, N>;
+}
+
+impl<S, F> MapResponse<S, F> {
+ /// Creates a new `MapResponse` service.
+ pub fn new(inner: S, f: F) -> Self {
+ MapResponse { f, inner }
+ }
+
+ /// Returns a new [`Layer`] that produces [`MapResponse`] services.
+ ///
+ /// This is a convenience function that simply calls [`MapResponseLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> MapResponseLayer<F> {
+ MapResponseLayer { f }
+ }
+}
+
+impl<S, F, Request, Response> Service<Request> for MapResponse<S, F>
+where
+ S: Service<Request>,
+ F: FnOnce(S::Response) -> Response + Clone,
+{
+ type Response = Response;
+ type Error = S::Error;
+ type Future = MapResponseFuture<S::Future, F>;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx)
+ }
+
+ #[inline]
+ fn call(&mut self, request: Request) -> Self::Future {
+ MapResponseFuture::new(self.inner.call(request).map_ok(self.f.clone()))
+ }
+}
+
+impl<F> MapResponseLayer<F> {
+ /// Creates a new [`MapResponseLayer`] layer.
+ pub fn new(f: F) -> Self {
+ MapResponseLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for MapResponseLayer<F>
+where
+ F: Clone,
+{
+ type Service = MapResponse<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ MapResponse {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/src/util/map_result.rs b/crates/tower/src/util/map_result.rs
new file mode 100644
index 0000000..bfe16b5
--- /dev/null
+++ b/crates/tower/src/util/map_result.rs
@@ -0,0 +1,99 @@
+use futures_util::{future::Map, FutureExt};
+use std::fmt;
+use std::task::{Context, Poll};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// Service returned by the [`map_result`] combinator.
+///
+/// [`map_result`]: crate::util::ServiceExt::map_result
+#[derive(Clone)]
+pub struct MapResult<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for MapResult<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("MapResult")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+/// A [`Layer`] that produces a [`MapResult`] service.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Debug, Clone)]
+pub struct MapResultLayer<F> {
+ f: F,
+}
+
+opaque_future! {
+ /// Response future from [`MapResult`] services.
+ ///
+ /// [`MapResult`]: crate::util::MapResult
+ pub type MapResultFuture<F, N> = Map<F, N>;
+}
+
+impl<S, F> MapResult<S, F> {
+ /// Creates a new [`MapResult`] service.
+ pub fn new(inner: S, f: F) -> Self {
+ MapResult { f, inner }
+ }
+
+ /// Returns a new [`Layer`] that produces [`MapResult`] services.
+ ///
+ /// This is a convenience function that simply calls [`MapResultLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> MapResultLayer<F> {
+ MapResultLayer { f }
+ }
+}
+
+impl<S, F, Request, Response, Error> Service<Request> for MapResult<S, F>
+where
+ S: Service<Request>,
+ Error: From<S::Error>,
+ F: FnOnce(Result<S::Response, S::Error>) -> Result<Response, Error> + Clone,
+{
+ type Response = Response;
+ type Error = Error;
+ type Future = MapResultFuture<S::Future, F>;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(Into::into)
+ }
+
+ #[inline]
+ fn call(&mut self, request: Request) -> Self::Future {
+ MapResultFuture::new(self.inner.call(request).map(self.f.clone()))
+ }
+}
+
+impl<F> MapResultLayer<F> {
+ /// Creates a new [`MapResultLayer`] layer.
+ pub fn new(f: F) -> Self {
+ MapResultLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for MapResultLayer<F>
+where
+ F: Clone,
+{
+ type Service = MapResult<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ MapResult {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/src/util/mod.rs b/crates/tower/src/util/mod.rs
new file mode 100644
index 0000000..129c9d7
--- /dev/null
+++ b/crates/tower/src/util/mod.rs
@@ -0,0 +1,1083 @@
+//! Various utility types and functions that are generally used with Tower.
+
+mod and_then;
+mod boxed;
+mod boxed_clone;
+mod call_all;
+mod either;
+
+mod future_service;
+mod map_err;
+mod map_request;
+mod map_response;
+mod map_result;
+
+mod map_future;
+mod oneshot;
+mod optional;
+mod ready;
+mod service_fn;
+mod then;
+
+#[allow(deprecated)]
+pub use self::{
+ and_then::{AndThen, AndThenLayer},
+ boxed::{BoxLayer, BoxService, UnsyncBoxService},
+ boxed_clone::BoxCloneService,
+ either::Either,
+ future_service::{future_service, FutureService},
+ map_err::{MapErr, MapErrLayer},
+ map_future::{MapFuture, MapFutureLayer},
+ map_request::{MapRequest, MapRequestLayer},
+ map_response::{MapResponse, MapResponseLayer},
+ map_result::{MapResult, MapResultLayer},
+ oneshot::Oneshot,
+ optional::Optional,
+ ready::{Ready, ReadyAnd, ReadyOneshot},
+ service_fn::{service_fn, ServiceFn},
+ then::{Then, ThenLayer},
+};
+
+pub use self::call_all::{CallAll, CallAllUnordered};
+use std::future::Future;
+
+use crate::layer::util::Identity;
+
+pub mod error {
+ //! Error types
+
+ pub use super::optional::error as optional;
+}
+
+pub mod future {
+ //! Future types
+
+ pub use super::and_then::AndThenFuture;
+ pub use super::map_err::MapErrFuture;
+ pub use super::map_response::MapResponseFuture;
+ pub use super::map_result::MapResultFuture;
+ pub use super::optional::future as optional;
+ pub use super::then::ThenFuture;
+}
+
+/// An extension trait for `Service`s that provides a variety of convenient
+/// adapters
+pub trait ServiceExt<Request>: tower_service::Service<Request> {
+ /// Yields a mutable reference to the service when it is ready to accept a request.
+ fn ready(&mut self) -> Ready<'_, Self, Request>
+ where
+ Self: Sized,
+ {
+ Ready::new(self)
+ }
+
+ /// Yields a mutable reference to the service when it is ready to accept a request.
+ #[deprecated(
+ since = "0.4.6",
+ note = "please use the `ServiceExt::ready` method instead"
+ )]
+ #[allow(deprecated)]
+ fn ready_and(&mut self) -> ReadyAnd<'_, Self, Request>
+ where
+ Self: Sized,
+ {
+ ReadyAnd::new(self)
+ }
+
+ /// Yields the service when it is ready to accept a request.
+ fn ready_oneshot(self) -> ReadyOneshot<Self, Request>
+ where
+ Self: Sized,
+ {
+ ReadyOneshot::new(self)
+ }
+
+ /// Consume this `Service`, calling with the providing request once it is ready.
+ fn oneshot(self, req: Request) -> Oneshot<Self, Request>
+ where
+ Self: Sized,
+ {
+ Oneshot::new(self, req)
+ }
+
+ /// Process all requests from the given [`Stream`], and produce a [`Stream`] of their responses.
+ ///
+ /// This is essentially [`Stream<Item = Request>`][stream] + `Self` => [`Stream<Item =
+ /// Response>`][stream]. See the documentation for [`CallAll`] for
+ /// details.
+ ///
+ /// [`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+ /// [stream]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
+ fn call_all<S>(self, reqs: S) -> CallAll<Self, S>
+ where
+ Self: Sized,
+ Self::Error: Into<crate::BoxError>,
+ S: futures_core::Stream<Item = Request>,
+ {
+ CallAll::new(self, reqs)
+ }
+
+ /// Executes a new future after this service's future resolves. This does
+ /// not alter the behaviour of the [`poll_ready`] method.
+ ///
+ /// This method can be used to change the [`Response`] type of the service
+ /// into a different type. You can use this method to chain along a computation once the
+ /// service's response has been resolved.
+ ///
+ /// [`Response`]: crate::Service::Response
+ /// [`poll_ready`]: crate::Service::poll_ready
+ ///
+ /// # Example
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # struct Record {
+ /// # pub name: String,
+ /// # pub age: u16
+ /// # }
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Record;
+ /// # type Error = u8;
+ /// # type Future = futures_util::future::Ready<Result<Record, u8>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
+ /// # }
+ /// # }
+ /// #
+ /// # async fn avatar_lookup(name: String) -> Result<Vec<u8>, u8> { Ok(vec![]) }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service returning Result<Record, _>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Map the response into a new response
+ /// let mut new_service = service.and_then(|record: Record| async move {
+ /// let name = record.name;
+ /// avatar_lookup(name).await
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let avatar = new_service.call(id).await.unwrap();
+ /// # };
+ /// # }
+ /// ```
+ fn and_then<F>(self, f: F) -> AndThen<Self, F>
+ where
+ Self: Sized,
+ F: Clone,
+ {
+ AndThen::new(self, f)
+ }
+
+ /// Maps this service's response value to a different value. This does not
+ /// alter the behaviour of the [`poll_ready`] method.
+ ///
+ /// This method can be used to change the [`Response`] type of the service
+ /// into a different type. It is similar to the [`Result::map`]
+ /// method. You can use this method to chain along a computation once the
+ /// service's response has been resolved.
+ ///
+ /// [`Response`]: crate::Service::Response
+ /// [`poll_ready`]: crate::Service::poll_ready
+ ///
+ /// # Example
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # struct Record {
+ /// # pub name: String,
+ /// # pub age: u16
+ /// # }
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Record;
+ /// # type Error = u8;
+ /// # type Future = futures_util::future::Ready<Result<Record, u8>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service returning Result<Record, _>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Map the response into a new response
+ /// let mut new_service = service.map_response(|record| record.name);
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let name = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await?;
+ /// # Ok::<(), u8>(())
+ /// # };
+ /// # }
+ /// ```
+ fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
+ where
+ Self: Sized,
+ F: FnOnce(Self::Response) -> Response + Clone,
+ {
+ MapResponse::new(self, f)
+ }
+
+ /// Maps this service's error value to a different value. This does not
+ /// alter the behaviour of the [`poll_ready`] method.
+ ///
+ /// This method can be used to change the [`Error`] type of the service
+ /// into a different type. It is similar to the [`Result::map_err`] method.
+ ///
+ /// [`Error`]: crate::Service::Error
+ /// [`poll_ready`]: crate::Service::poll_ready
+ ///
+ /// # Example
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # struct Error {
+ /// # pub code: u32,
+ /// # pub message: String
+ /// # }
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = String;
+ /// # type Error = Error;
+ /// # type Future = futures_util::future::Ready<Result<String, Error>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(String::new()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service returning Result<_, Error>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Map the error to a new error
+ /// let mut new_service = service.map_err(|err| err.code);
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let code = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await
+ /// .unwrap_err();
+ /// # Ok::<(), u32>(())
+ /// # };
+ /// # }
+ /// ```
+ fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
+ where
+ Self: Sized,
+ F: FnOnce(Self::Error) -> Error + Clone,
+ {
+ MapErr::new(self, f)
+ }
+
+ /// Maps this service's result type (`Result<Self::Response, Self::Error>`)
+ /// to a different value, regardless of whether the future succeeds or
+ /// fails.
+ ///
+ /// This is similar to the [`map_response`] and [`map_err`] combinators,
+ /// except that the *same* function is invoked when the service's future
+ /// completes, whether it completes successfully or fails. This function
+ /// takes the [`Result`] returned by the service's future, and returns a
+ /// [`Result`].
+ ///
+ /// Like the standard library's [`Result::and_then`], this method can be
+ /// used to implement control flow based on `Result` values. For example, it
+ /// may be used to implement error recovery, by turning some [`Err`]
+ /// responses from the service into [`Ok`] responses. Similarly, some
+ /// successful responses from the service could be rejected, by returning an
+ /// [`Err`] conditionally, depending on the value inside the [`Ok`.] Finally,
+ /// this method can also be used to implement behaviors that must run when a
+ /// service's future completes, regardless of whether it succeeded or failed.
+ ///
+ /// This method can be used to change the [`Response`] type of the service
+ /// into a different type. It can also be used to change the [`Error`] type
+ /// of the service. However, because the [`map_result`] function is not applied
+ /// to the errors returned by the service's [`poll_ready`] method, it must
+ /// be possible to convert the service's [`Error`] type into the error type
+ /// returned by the [`map_result`] function. This is trivial when the function
+ /// returns the same error type as the service, but in other cases, it can
+ /// be useful to use [`BoxError`] to erase differing error types.
+ ///
+ /// # Examples
+ ///
+ /// Recovering from certain errors:
+ ///
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # struct Record {
+ /// # pub name: String,
+ /// # pub age: u16
+ /// # }
+ /// # #[derive(Debug)]
+ /// # enum DbError {
+ /// # Parse(std::num::ParseIntError),
+ /// # NoRecordsFound,
+ /// # }
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Vec<Record>;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<Vec<Record>, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(vec![Record { name: "Jack".into(), age: 32 }]))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service returning Result<Vec<Record>, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // If the database returns no records for the query, we just want an empty `Vec`.
+ /// let mut new_service = service.map_result(|result| match result {
+ /// // If the error indicates that no records matched the query, return an empty
+ /// // `Vec` instead.
+ /// Err(DbError::NoRecordsFound) => Ok(Vec::new()),
+ /// // Propagate all other responses (`Ok` and `Err`) unchanged
+ /// x => x,
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let name = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await?;
+ /// # Ok::<(), DbError>(())
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// Rejecting some `Ok` responses:
+ ///
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # struct Record {
+ /// # pub name: String,
+ /// # pub age: u16
+ /// # }
+ /// # type DbError = String;
+ /// # type AppError = String;
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Record;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(Record { name: "Jack".into(), age: 32 }))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// use tower::BoxError;
+ ///
+ /// // A service returning Result<Record, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // If the user is zero years old, return an error.
+ /// let mut new_service = service.map_result(|result| {
+ /// let record = result?;
+ ///
+ /// if record.age == 0 {
+ /// // Users must have been born to use our app!
+ /// let app_error = AppError::from("users cannot be 0 years old!");
+ ///
+ /// // Box the error to erase its type (as it can be an `AppError`
+ /// // *or* the inner service's `DbError`).
+ /// return Err(BoxError::from(app_error));
+ /// }
+ ///
+ /// // Otherwise, return the record.
+ /// Ok(record)
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let record = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await?;
+ /// # Ok::<(), BoxError>(())
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// Performing an action that must be run for both successes and failures:
+ ///
+ /// ```
+ /// # use std::convert::TryFrom;
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = String;
+ /// # type Error = u8;
+ /// # type Future = futures_util::future::Ready<Result<String, u8>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(String::new()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service returning Result<Record, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Print a message whenever a query completes.
+ /// let mut new_service = service.map_result(|result| {
+ /// println!("query completed; success={}", result.is_ok());
+ /// result
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let response = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await;
+ /// # response
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// [`map_response`]: ServiceExt::map_response
+ /// [`map_err`]: ServiceExt::map_err
+ /// [`map_result`]: ServiceExt::map_result
+ /// [`Error`]: crate::Service::Error
+ /// [`Response`]: crate::Service::Response
+ /// [`poll_ready`]: crate::Service::poll_ready
+ /// [`BoxError`]: crate::BoxError
+ fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
+ where
+ Self: Sized,
+ Error: From<Self::Error>,
+ F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
+ {
+ MapResult::new(self, f)
+ }
+
+ /// Composes a function *in front of* the service.
+ ///
+ /// This adapter produces a new service that passes each value through the
+ /// given function `f` before sending it to `self`.
+ ///
+ /// # Example
+ /// ```
+ /// # use std::convert::TryFrom;
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # impl Service<String> for DatabaseService {
+ /// # type Response = String;
+ /// # type Error = u8;
+ /// # type Future = futures_util::future::Ready<Result<String, u8>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: String) -> Self::Future {
+ /// # futures_util::future::ready(Ok(String::new()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service taking a String as a request
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Map the request to a new request
+ /// let mut new_service = service.map_request(|id: u32| id.to_string());
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let response = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await;
+ /// # response
+ /// # };
+ /// # }
+ /// ```
+ fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
+ where
+ Self: Sized,
+ F: FnMut(NewRequest) -> Request,
+ {
+ MapRequest::new(self, f)
+ }
+
+ /// Composes this service with a [`Filter`] that conditionally accepts or
+ /// rejects requests based on a [predicate].
+ ///
+ /// This adapter produces a new service that passes each value through the
+ /// given function `predicate` before sending it to `self`.
+ ///
+ /// # Example
+ /// ```
+ /// # use std::convert::TryFrom;
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # #[derive(Debug)] enum DbError {
+ /// # Parse(std::num::ParseIntError)
+ /// # }
+ /// #
+ /// # impl std::fmt::Display for DbError {
+ /// # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Debug::fmt(self, f) }
+ /// # }
+ /// # impl std::error::Error for DbError {}
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = String;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<String, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(String::new()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service taking a u32 as a request and returning Result<_, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // Fallibly map the request to a new request
+ /// let mut new_service = service
+ /// .filter(|id_str: &str| id_str.parse().map_err(DbError::Parse));
+ ///
+ /// // Call the new service
+ /// let id = "13";
+ /// let response = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await;
+ /// # response
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// [`Filter`]: crate::filter::Filter
+ /// [predicate]: crate::filter::Predicate
+ #[cfg(feature = "filter")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
+ fn filter<F, NewRequest>(self, filter: F) -> crate::filter::Filter<Self, F>
+ where
+ Self: Sized,
+ F: crate::filter::Predicate<NewRequest>,
+ {
+ crate::filter::Filter::new(self, filter)
+ }
+
+ /// Composes this service with an [`AsyncFilter`] that conditionally accepts or
+ /// rejects requests based on an [async predicate].
+ ///
+ /// This adapter produces a new service that passes each value through the
+ /// given function `predicate` before sending it to `self`.
+ ///
+ /// # Example
+ /// ```
+ /// # use std::convert::TryFrom;
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # #[derive(Clone)] struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// # #[derive(Debug)]
+ /// # enum DbError {
+ /// # Rejected
+ /// # }
+ /// # impl std::fmt::Display for DbError {
+ /// # fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { std::fmt::Debug::fmt(self, f) }
+ /// # }
+ /// # impl std::error::Error for DbError {}
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = String;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<String, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(String::new()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # async {
+ /// // A service taking a u32 as a request and returning Result<_, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// /// Returns `true` if we should query the database for an ID.
+ /// async fn should_query(id: u32) -> bool {
+ /// // ...
+ /// # true
+ /// }
+ ///
+ /// // Filter requests based on `should_query`.
+ /// let mut new_service = service
+ /// .filter_async(|id: u32| async move {
+ /// if should_query(id).await {
+ /// return Ok(id);
+ /// }
+ ///
+ /// Err(DbError::Rejected)
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// # let id: u32 = id;
+ /// let response = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await;
+ /// # response
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// [`AsyncFilter`]: crate::filter::AsyncFilter
+ /// [asynchronous predicate]: crate::filter::AsyncPredicate
+ #[cfg(feature = "filter")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "filter")))]
+ fn filter_async<F, NewRequest>(self, filter: F) -> crate::filter::AsyncFilter<Self, F>
+ where
+ Self: Sized,
+ F: crate::filter::AsyncPredicate<NewRequest>,
+ {
+ crate::filter::AsyncFilter::new(self, filter)
+ }
+
+ /// Composes an asynchronous function *after* this service.
+ ///
+ /// This takes a function or closure returning a future, and returns a new
+ /// `Service` that chains that function after this service's [`Future`]. The
+ /// new `Service`'s future will consist of this service's future, followed
+ /// by the future returned by calling the chained function with the future's
+ /// [`Output`] type. The chained function is called regardless of whether
+ /// this service's future completes with a successful response or with an
+ /// error.
+ ///
+ /// This method can be thought of as an equivalent to the [`futures`
+ /// crate]'s [`FutureExt::then`] combinator, but acting on `Service`s that
+ /// _return_ futures, rather than on an individual future. Similarly to that
+ /// combinator, [`ServiceExt::then`] can be used to implement asynchronous
+ /// error recovery, by calling some asynchronous function with errors
+ /// returned by this service. Alternatively, it may also be used to call a
+ /// fallible async function with the successful response of this service.
+ ///
+ /// This method can be used to change the [`Response`] type of the service
+ /// into a different type. It can also be used to change the [`Error`] type
+ /// of the service. However, because the `then` function is not applied
+ /// to the errors returned by the service's [`poll_ready`] method, it must
+ /// be possible to convert the service's [`Error`] type into the error type
+ /// returned by the `then` future. This is trivial when the function
+ /// returns the same error type as the service, but in other cases, it can
+ /// be useful to use [`BoxError`] to erase differing error types.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # type Record = ();
+ /// # type DbError = ();
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Record;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// // A service returning Result<Record, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ ///
+ /// // An async function that attempts to recover from errors returned by the
+ /// // database.
+ /// async fn recover_from_error(error: DbError) -> Result<Record, DbError> {
+ /// // ...
+ /// # Ok(())
+ /// }
+ /// # async {
+ ///
+ /// // If the database service returns an error, attempt to recover by
+ /// // calling `recover_from_error`. Otherwise, return the successful response.
+ /// let mut new_service = service.then(|result| async move {
+ /// match result {
+ /// Ok(record) => Ok(record),
+ /// Err(e) => recover_from_error(e).await,
+ /// }
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let record = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await?;
+ /// # Ok::<(), DbError>(())
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// [`Future`]: crate::Service::Future
+ /// [`Output`]: std::future::Future::Output
+ /// [`futures` crate]: https://docs.rs/futures
+ /// [`FutureExt::then`]: https://docs.rs/futures/latest/futures/future/trait.FutureExt.html#method.then
+ /// [`Error`]: crate::Service::Error
+ /// [`Response`]: crate::Service::Response
+ /// [`poll_ready`]: crate::Service::poll_ready
+ /// [`BoxError`]: crate::BoxError
+ fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
+ where
+ Self: Sized,
+ Error: From<Self::Error>,
+ F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
+ Fut: Future<Output = Result<Response, Error>>,
+ {
+ Then::new(self, f)
+ }
+
+ /// Composes a function that transforms futures produced by the service.
+ ///
+ /// This takes a function or closure returning a future computed from the future returned by
+ /// the service's [`call`] method, as opposed to the responses produced by the future.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use std::task::{Poll, Context};
+ /// # use tower::{Service, ServiceExt, BoxError};
+ /// #
+ /// # struct DatabaseService;
+ /// # impl DatabaseService {
+ /// # fn new(address: &str) -> Self {
+ /// # DatabaseService
+ /// # }
+ /// # }
+ /// #
+ /// # type Record = ();
+ /// # type DbError = crate::BoxError;
+ /// #
+ /// # impl Service<u32> for DatabaseService {
+ /// # type Response = Record;
+ /// # type Error = DbError;
+ /// # type Future = futures_util::future::Ready<Result<Record, DbError>>;
+ /// #
+ /// # fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ /// # Poll::Ready(Ok(()))
+ /// # }
+ /// #
+ /// # fn call(&mut self, request: u32) -> Self::Future {
+ /// # futures_util::future::ready(Ok(()))
+ /// # }
+ /// # }
+ /// #
+ /// # fn main() {
+ /// use std::time::Duration;
+ /// use tokio::time::timeout;
+ ///
+ /// // A service returning Result<Record, DbError>
+ /// let service = DatabaseService::new("127.0.0.1:8080");
+ /// # async {
+ ///
+ /// let mut new_service = service.map_future(|future| async move {
+ /// let res = timeout(Duration::from_secs(1), future).await?;
+ /// Ok::<_, BoxError>(res)
+ /// });
+ ///
+ /// // Call the new service
+ /// let id = 13;
+ /// let record = new_service
+ /// .ready()
+ /// .await?
+ /// .call(id)
+ /// .await?;
+ /// # Ok::<(), BoxError>(())
+ /// # };
+ /// # }
+ /// ```
+ ///
+ /// Note that normally you wouldn't implement timeouts like this and instead use [`Timeout`].
+ ///
+ /// [`call`]: crate::Service::call
+ /// [`Timeout`]: crate::timeout::Timeout
+ fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
+ where
+ Self: Sized,
+ F: FnMut(Self::Future) -> Fut,
+ Error: From<Self::Error>,
+ Fut: Future<Output = Result<Response, Error>>,
+ {
+ MapFuture::new(self, f)
+ }
+
+ /// Convert the service into a [`Service`] + [`Send`] trait object.
+ ///
+ /// See [`BoxService`] for more details.
+ ///
+ /// If `Self` implements the [`Clone`] trait, the [`boxed_clone`] method
+ /// can be used instead, to produce a boxed service which will also
+ /// implement [`Clone`].
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use tower::{Service, ServiceExt, BoxError, service_fn, util::BoxService};
+ /// #
+ /// # struct Request;
+ /// # struct Response;
+ /// # impl Response {
+ /// # fn new() -> Self { Self }
+ /// # }
+ ///
+ /// let service = service_fn(|req: Request| async {
+ /// Ok::<_, BoxError>(Response::new())
+ /// });
+ ///
+ /// let service: BoxService<Request, Response, BoxError> = service
+ /// .map_request(|req| {
+ /// println!("received request");
+ /// req
+ /// })
+ /// .map_response(|res| {
+ /// println!("response produced");
+ /// res
+ /// })
+ /// .boxed();
+ /// # let service = assert_service(service);
+ /// # fn assert_service<S, R>(svc: S) -> S
+ /// # where S: Service<R> { svc }
+ /// ```
+ ///
+ /// [`Service`]: crate::Service
+ /// [`boxed_clone`]: Self::boxed_clone
+ fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>
+ where
+ Self: Sized + Send + 'static,
+ Self::Future: Send + 'static,
+ {
+ BoxService::new(self)
+ }
+
+ /// Convert the service into a [`Service`] + [`Clone`] + [`Send`] trait object.
+ ///
+ /// This is similar to the [`boxed`] method, but it requires that `Self` implement
+ /// [`Clone`], and the returned boxed service implements [`Clone`].
+ /// See [`BoxCloneService`] for more details.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use tower::{Service, ServiceExt, BoxError, service_fn, util::BoxCloneService};
+ /// #
+ /// # struct Request;
+ /// # struct Response;
+ /// # impl Response {
+ /// # fn new() -> Self { Self }
+ /// # }
+ ///
+ /// let service = service_fn(|req: Request| async {
+ /// Ok::<_, BoxError>(Response::new())
+ /// });
+ ///
+ /// let service: BoxCloneService<Request, Response, BoxError> = service
+ /// .map_request(|req| {
+ /// println!("received request");
+ /// req
+ /// })
+ /// .map_response(|res| {
+ /// println!("response produced");
+ /// res
+ /// })
+ /// .boxed_clone();
+ ///
+ /// // The boxed service can still be cloned.
+ /// service.clone();
+ /// # let service = assert_service(service);
+ /// # fn assert_service<S, R>(svc: S) -> S
+ /// # where S: Service<R> { svc }
+ /// ```
+ ///
+ /// [`Service`]: crate::Service
+ /// [`boxed`]: Self::boxed
+ fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error>
+ where
+ Self: Clone + Sized + Send + 'static,
+ Self::Future: Send + 'static,
+ {
+ BoxCloneService::new(self)
+ }
+}
+
+impl<T: ?Sized, Request> ServiceExt<Request> for T where T: tower_service::Service<Request> {}
+
+/// Convert an `Option<Layer>` into a [`Layer`].
+///
+/// ```
+/// # use std::time::Duration;
+/// # use tower::Service;
+/// # use tower::builder::ServiceBuilder;
+/// use tower::util::option_layer;
+/// # use tower::timeout::TimeoutLayer;
+/// # async fn wrap<S>(svc: S) where S: Service<(), Error = &'static str> + 'static + Send, S::Future: Send {
+/// # let timeout = Some(Duration::new(10, 0));
+/// // Layer to apply a timeout if configured
+/// let maybe_timeout = option_layer(timeout.map(TimeoutLayer::new));
+///
+/// ServiceBuilder::new()
+/// .layer(maybe_timeout)
+/// .service(svc);
+/// # }
+/// ```
+///
+/// [`Layer`]: crate::layer::Layer
+pub fn option_layer<L>(layer: Option<L>) -> Either<L, Identity> {
+ if let Some(layer) = layer {
+ Either::A(layer)
+ } else {
+ Either::B(Identity::new())
+ }
+}
diff --git a/crates/tower/src/util/oneshot.rs b/crates/tower/src/util/oneshot.rs
new file mode 100644
index 0000000..93b5070
--- /dev/null
+++ b/crates/tower/src/util/oneshot.rs
@@ -0,0 +1,105 @@
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ fmt,
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+pin_project! {
+ /// A [`Future`] consuming a [`Service`] and request, waiting until the [`Service`]
+ /// is ready, and then calling [`Service::call`] with the request, and
+ /// waiting for that [`Future`].
+ #[derive(Debug)]
+ pub struct Oneshot<S: Service<Req>, Req> {
+ #[pin]
+ state: State<S, Req>,
+ }
+}
+
+pin_project! {
+ #[project = StateProj]
+ enum State<S: Service<Req>, Req> {
+ NotReady {
+ svc: S,
+ req: Option<Req>,
+ },
+ Called {
+ #[pin]
+ fut: S::Future,
+ },
+ Done,
+ }
+}
+
+impl<S: Service<Req>, Req> State<S, Req> {
+ fn not_ready(svc: S, req: Option<Req>) -> Self {
+ Self::NotReady { svc, req }
+ }
+
+ fn called(fut: S::Future) -> Self {
+ Self::Called { fut }
+ }
+}
+
+impl<S, Req> fmt::Debug for State<S, Req>
+where
+ S: Service<Req> + fmt::Debug,
+ Req: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ State::NotReady {
+ svc,
+ req: Some(req),
+ } => f
+ .debug_tuple("State::NotReady")
+ .field(svc)
+ .field(req)
+ .finish(),
+ State::NotReady { req: None, .. } => unreachable!(),
+ State::Called { .. } => f.debug_tuple("State::Called").field(&"S::Future").finish(),
+ State::Done => f.debug_tuple("State::Done").finish(),
+ }
+ }
+}
+
+impl<S, Req> Oneshot<S, Req>
+where
+ S: Service<Req>,
+{
+ #[allow(missing_docs)]
+ pub fn new(svc: S, req: Req) -> Self {
+ Oneshot {
+ state: State::not_ready(svc, Some(req)),
+ }
+ }
+}
+
+impl<S, Req> Future for Oneshot<S, Req>
+where
+ S: Service<Req>,
+{
+ type Output = Result<S::Response, S::Error>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let mut this = self.project();
+ loop {
+ match this.state.as_mut().project() {
+ StateProj::NotReady { svc, req } => {
+ let _ = ready!(svc.poll_ready(cx))?;
+ let f = svc.call(req.take().expect("already called"));
+ this.state.set(State::called(f));
+ }
+ StateProj::Called { fut } => {
+ let res = ready!(fut.poll(cx))?;
+ this.state.set(State::Done);
+ return Poll::Ready(Ok(res));
+ }
+ StateProj::Done => panic!("polled after complete"),
+ }
+ }
+ }
+}
diff --git a/crates/tower/src/util/optional/error.rs b/crates/tower/src/util/optional/error.rs
new file mode 100644
index 0000000..7806133
--- /dev/null
+++ b/crates/tower/src/util/optional/error.rs
@@ -0,0 +1,21 @@
+use std::{error, fmt};
+
+/// Error returned if the inner [`Service`] has not been set.
+///
+/// [`Service`]: crate::Service
+#[derive(Debug)]
+pub struct None(());
+
+impl None {
+ pub(crate) fn new() -> None {
+ None(())
+ }
+}
+
+impl fmt::Display for None {
+ fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+ write!(fmt, "None")
+ }
+}
+
+impl error::Error for None {}
diff --git a/crates/tower/src/util/optional/future.rs b/crates/tower/src/util/optional/future.rs
new file mode 100644
index 0000000..7d289b7
--- /dev/null
+++ b/crates/tower/src/util/optional/future.rs
@@ -0,0 +1,40 @@
+use super::error;
+use futures_core::ready;
+use pin_project_lite::pin_project;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+
+pin_project! {
+ /// Response future returned by [`Optional`].
+ ///
+ /// [`Optional`]: crate::util::Optional
+ #[derive(Debug)]
+ pub struct ResponseFuture<T> {
+ #[pin]
+ inner: Option<T>,
+ }
+}
+
+impl<T> ResponseFuture<T> {
+ pub(crate) fn new(inner: Option<T>) -> ResponseFuture<T> {
+ ResponseFuture { inner }
+ }
+}
+
+impl<F, T, E> Future for ResponseFuture<F>
+where
+ F: Future<Output = Result<T, E>>,
+ E: Into<crate::BoxError>,
+{
+ type Output = Result<T, crate::BoxError>;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ match self.project().inner.as_pin_mut() {
+ Some(inner) => Poll::Ready(Ok(ready!(inner.poll(cx)).map_err(Into::into)?)),
+ None => Poll::Ready(Err(error::None::new().into())),
+ }
+ }
+}
diff --git a/crates/tower/src/util/optional/mod.rs b/crates/tower/src/util/optional/mod.rs
new file mode 100644
index 0000000..8ba3ab9
--- /dev/null
+++ b/crates/tower/src/util/optional/mod.rs
@@ -0,0 +1,59 @@
+//! Contains [`Optional`] and related types and functions.
+//!
+//! See [`Optional`] documentation for more details.
+
+/// Error types for [`Optional`].
+pub mod error;
+/// Future types for [`Optional`].
+pub mod future;
+
+use self::future::ResponseFuture;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+/// Optionally forwards requests to an inner service.
+///
+/// If the inner service is [`None`], [`optional::None`] is returned as the response.
+///
+/// [`optional::None`]: crate::util::error::optional::None
+#[derive(Debug)]
+pub struct Optional<T> {
+ inner: Option<T>,
+}
+
+impl<T> Optional<T> {
+ /// Create a new [`Optional`].
+ pub fn new<Request>(inner: Option<T>) -> Optional<T>
+ where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+ {
+ Optional { inner }
+ }
+}
+
+impl<T, Request> Service<Request> for Optional<T>
+where
+ T: Service<Request>,
+ T::Error: Into<crate::BoxError>,
+{
+ type Response = T::Response;
+ type Error = crate::BoxError;
+ type Future = ResponseFuture<T::Future>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ match self.inner {
+ Some(ref mut inner) => match inner.poll_ready(cx) {
+ Poll::Ready(r) => Poll::Ready(r.map_err(Into::into)),
+ Poll::Pending => Poll::Pending,
+ },
+ // None services are always ready
+ None => Poll::Ready(Ok(())),
+ }
+ }
+
+ fn call(&mut self, request: Request) -> Self::Future {
+ let inner = self.inner.as_mut().map(|i| i.call(request));
+ ResponseFuture::new(inner)
+ }
+}
diff --git a/crates/tower/src/util/ready.rs b/crates/tower/src/util/ready.rs
new file mode 100644
index 0000000..8b0fe2c
--- /dev/null
+++ b/crates/tower/src/util/ready.rs
@@ -0,0 +1,111 @@
+use std::{fmt, marker::PhantomData};
+
+use futures_core::ready;
+use std::{
+ future::Future,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use tower_service::Service;
+
+/// A [`Future`] that yields the service when it is ready to accept a request.
+///
+/// [`ReadyOneshot`] values are produced by [`ServiceExt::ready_oneshot`].
+///
+/// [`ServiceExt::ready_oneshot`]: crate::util::ServiceExt::ready_oneshot
+pub struct ReadyOneshot<T, Request> {
+ inner: Option<T>,
+ _p: PhantomData<fn() -> Request>,
+}
+
+// Safety: This is safe because `Services`'s are always `Unpin`.
+impl<T, Request> Unpin for ReadyOneshot<T, Request> {}
+
+impl<T, Request> ReadyOneshot<T, Request>
+where
+ T: Service<Request>,
+{
+ #[allow(missing_docs)]
+ pub fn new(service: T) -> Self {
+ Self {
+ inner: Some(service),
+ _p: PhantomData,
+ }
+ }
+}
+
+impl<T, Request> Future for ReadyOneshot<T, Request>
+where
+ T: Service<Request>,
+{
+ type Output = Result<T, T::Error>;
+
+ fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ ready!(self
+ .inner
+ .as_mut()
+ .expect("poll after Poll::Ready")
+ .poll_ready(cx))?;
+
+ Poll::Ready(Ok(self.inner.take().expect("poll after Poll::Ready")))
+ }
+}
+
+impl<T, Request> fmt::Debug for ReadyOneshot<T, Request>
+where
+ T: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_struct("ReadyOneshot")
+ .field("inner", &self.inner)
+ .finish()
+ }
+}
+
+/// A future that yields a mutable reference to the service when it is ready to accept a request.
+///
+/// [`Ready`] values are produced by [`ServiceExt::ready`].
+///
+/// [`ServiceExt::ready`]: crate::util::ServiceExt::ready
+pub struct Ready<'a, T, Request>(ReadyOneshot<&'a mut T, Request>);
+
+/// A future that yields a mutable reference to the service when it is ready to accept a request.
+///
+/// [`ReadyAnd`] values are produced by [`ServiceExt::ready_and`].
+///
+/// [`ServiceExt::ready_and`]: crate::util::ServiceExt::ready_and
+#[deprecated(since = "0.4.6", note = "Please use the Ready future instead")]
+pub type ReadyAnd<'a, T, Request> = Ready<'a, T, Request>;
+
+// Safety: This is safe for the same reason that the impl for ReadyOneshot is safe.
+impl<'a, T, Request> Unpin for Ready<'a, T, Request> {}
+
+impl<'a, T, Request> Ready<'a, T, Request>
+where
+ T: Service<Request>,
+{
+ #[allow(missing_docs)]
+ pub fn new(service: &'a mut T) -> Self {
+ Self(ReadyOneshot::new(service))
+ }
+}
+
+impl<'a, T, Request> Future for Ready<'a, T, Request>
+where
+ T: Service<Request>,
+{
+ type Output = Result<&'a mut T, T::Error>;
+
+ fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ Pin::new(&mut self.0).poll(cx)
+ }
+}
+
+impl<'a, T, Request> fmt::Debug for Ready<'a, T, Request>
+where
+ T: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.debug_tuple("Ready").field(&self.0).finish()
+ }
+}
diff --git a/crates/tower/src/util/service_fn.rs b/crates/tower/src/util/service_fn.rs
new file mode 100644
index 0000000..d6e6be8
--- /dev/null
+++ b/crates/tower/src/util/service_fn.rs
@@ -0,0 +1,82 @@
+use std::fmt;
+use std::future::Future;
+use std::task::{Context, Poll};
+use tower_service::Service;
+
+/// Returns a new [`ServiceFn`] with the given closure.
+///
+/// This lets you build a [`Service`] from an async function that returns a [`Result`].
+///
+/// # Example
+///
+/// ```
+/// use tower::{service_fn, Service, ServiceExt, BoxError};
+/// # struct Request;
+/// # impl Request {
+/// # fn new() -> Self { Self }
+/// # }
+/// # struct Response(&'static str);
+/// # impl Response {
+/// # fn new(body: &'static str) -> Self {
+/// # Self(body)
+/// # }
+/// # fn into_body(self) -> &'static str { self.0 }
+/// # }
+///
+/// # #[tokio::main]
+/// # async fn main() -> Result<(), BoxError> {
+/// async fn handle(request: Request) -> Result<Response, BoxError> {
+/// let response = Response::new("Hello, World!");
+/// Ok(response)
+/// }
+///
+/// let mut service = service_fn(handle);
+///
+/// let response = service
+/// .ready()
+/// .await?
+/// .call(Request::new())
+/// .await?;
+///
+/// assert_eq!("Hello, World!", response.into_body());
+/// #
+/// # Ok(())
+/// # }
+/// ```
+pub fn service_fn<T>(f: T) -> ServiceFn<T> {
+ ServiceFn { f }
+}
+
+/// A [`Service`] implemented by a closure.
+///
+/// See [`service_fn`] for more details.
+#[derive(Copy, Clone)]
+pub struct ServiceFn<T> {
+ f: T,
+}
+
+impl<T> fmt::Debug for ServiceFn<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("ServiceFn")
+ .field("f", &format_args!("{}", std::any::type_name::<T>()))
+ .finish()
+ }
+}
+
+impl<T, F, Request, R, E> Service<Request> for ServiceFn<T>
+where
+ T: FnMut(Request) -> F,
+ F: Future<Output = Result<R, E>>,
+{
+ type Response = R;
+ type Error = E;
+ type Future = F;
+
+ fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), E>> {
+ Ok(()).into()
+ }
+
+ fn call(&mut self, req: Request) -> Self::Future {
+ (self.f)(req)
+ }
+}
diff --git a/crates/tower/src/util/then.rs b/crates/tower/src/util/then.rs
new file mode 100644
index 0000000..1ec3c14
--- /dev/null
+++ b/crates/tower/src/util/then.rs
@@ -0,0 +1,103 @@
+use futures_util::{future, FutureExt};
+use std::{
+ fmt,
+ future::Future,
+ task::{Context, Poll},
+};
+use tower_layer::Layer;
+use tower_service::Service;
+
+/// [`Service`] returned by the [`then`] combinator.
+///
+/// [`then`]: crate::util::ServiceExt::then
+#[derive(Clone)]
+pub struct Then<S, F> {
+ inner: S,
+ f: F,
+}
+
+impl<S, F> fmt::Debug for Then<S, F>
+where
+ S: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Then")
+ .field("inner", &self.inner)
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .finish()
+ }
+}
+
+/// A [`Layer`] that produces a [`Then`] service.
+///
+/// [`Layer`]: tower_layer::Layer
+#[derive(Debug, Clone)]
+pub struct ThenLayer<F> {
+ f: F,
+}
+
+impl<S, F> Then<S, F> {
+ /// Creates a new `Then` service.
+ pub fn new(inner: S, f: F) -> Self {
+ Then { f, inner }
+ }
+
+ /// Returns a new [`Layer`] that produces [`Then`] services.
+ ///
+ /// This is a convenience function that simply calls [`ThenLayer::new`].
+ ///
+ /// [`Layer`]: tower_layer::Layer
+ pub fn layer(f: F) -> ThenLayer<F> {
+ ThenLayer { f }
+ }
+}
+
+opaque_future! {
+ /// Response future from [`Then`] services.
+ ///
+ /// [`Then`]: crate::util::Then
+ pub type ThenFuture<F1, F2, N> = future::Then<F1, F2, N>;
+}
+
+impl<S, F, Request, Response, Error, Fut> Service<Request> for Then<S, F>
+where
+ S: Service<Request>,
+ S::Error: Into<Error>,
+ F: FnOnce(Result<S::Response, S::Error>) -> Fut + Clone,
+ Fut: Future<Output = Result<Response, Error>>,
+{
+ type Response = Response;
+ type Error = Error;
+ type Future = ThenFuture<S::Future, Fut, F>;
+
+ #[inline]
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ self.inner.poll_ready(cx).map_err(Into::into)
+ }
+
+ #[inline]
+ fn call(&mut self, request: Request) -> Self::Future {
+ ThenFuture::new(self.inner.call(request).then(self.f.clone()))
+ }
+}
+
+impl<F> ThenLayer<F> {
+ /// Creates a new [`ThenLayer`] layer.
+ pub fn new(f: F) -> Self {
+ ThenLayer { f }
+ }
+}
+
+impl<S, F> Layer<S> for ThenLayer<F>
+where
+ F: Clone,
+{
+ type Service = Then<S, F>;
+
+ fn layer(&self, inner: S) -> Self::Service {
+ Then {
+ f: self.f.clone(),
+ inner,
+ }
+ }
+}
diff --git a/crates/tower/tests/balance/main.rs b/crates/tower/tests/balance/main.rs
new file mode 100644
index 0000000..aed5120
--- /dev/null
+++ b/crates/tower/tests/balance/main.rs
@@ -0,0 +1,170 @@
+#![cfg(feature = "balance")]
+#[path = "../support.rs"]
+mod support;
+
+use std::future::Future;
+use std::task::{Context, Poll};
+use tokio_test::{assert_pending, assert_ready, task};
+use tower::balance::p2c::Balance;
+use tower::discover::Change;
+use tower_service::Service;
+use tower_test::mock;
+
+type Req = &'static str;
+struct Mock(mock::Mock<Req, Req>);
+
+impl Service<Req> for Mock {
+ type Response = <mock::Mock<Req, Req> as Service<Req>>::Response;
+ type Error = <mock::Mock<Req, Req> as Service<Req>>::Error;
+ type Future = <mock::Mock<Req, Req> as Service<Req>>::Future;
+ fn poll_ready(&mut self, cx: &mut Context) -> Poll<Result<(), Self::Error>> {
+ self.0.poll_ready(cx)
+ }
+ fn call(&mut self, req: Req) -> Self::Future {
+ self.0.call(req)
+ }
+}
+
+impl tower::load::Load for Mock {
+ type Metric = usize;
+ fn load(&self) -> Self::Metric {
+ rand::random()
+ }
+}
+
+#[test]
+fn stress() {
+ let _t = support::trace_init();
+ let mut task = task::spawn(());
+ let (tx, rx) = tokio::sync::mpsc::unbounded_channel::<Result<_, &'static str>>();
+ let mut cache = Balance::<_, Req>::new(support::IntoStream::new(rx));
+
+ let mut nready = 0;
+ let mut services = slab::Slab::<(mock::Handle<Req, Req>, bool)>::new();
+ let mut retired = Vec::<mock::Handle<Req, Req>>::new();
+ for _ in 0..100_000 {
+ for _ in 0..(rand::random::<u8>() % 8) {
+ if !services.is_empty() && rand::random() {
+ if nready == 0 || rand::random::<u8>() > u8::max_value() / 4 {
+ // ready a service
+ // TODO: sometimes ready a removed service?
+ for (_, (handle, ready)) in &mut services {
+ if !*ready {
+ handle.allow(1);
+ *ready = true;
+ nready += 1;
+ break;
+ }
+ }
+ } else {
+ // use a service
+ use std::task::Poll;
+ match task.enter(|cx, _| cache.poll_ready(cx)) {
+ Poll::Ready(Ok(())) => {
+ assert_ne!(nready, 0, "got ready when no service is ready");
+ let mut fut = cache.call("hello");
+ let mut fut = std::pin::Pin::new(&mut fut);
+ assert_pending!(task.enter(|cx, _| fut.as_mut().poll(cx)));
+ let mut found = false;
+ for (_, (handle, ready)) in &mut services {
+ if *ready {
+ if let Poll::Ready(Some((req, res))) = handle.poll_request() {
+ assert_eq!(req, "hello");
+ res.send_response("world");
+ *ready = false;
+ nready -= 1;
+ found = true;
+ break;
+ }
+ }
+ }
+ if !found {
+ // we must have been given a retired service
+ let mut at = None;
+ for (i, handle) in retired.iter_mut().enumerate() {
+ if let Poll::Ready(Some((req, res))) = handle.poll_request() {
+ assert_eq!(req, "hello");
+ res.send_response("world");
+ at = Some(i);
+ break;
+ }
+ }
+ let _ = retired.swap_remove(
+ at.expect("request was not sent to a ready service"),
+ );
+ nready -= 1;
+ }
+ assert_ready!(task.enter(|cx, _| fut.as_mut().poll(cx))).unwrap();
+ }
+ Poll::Ready(_) => unreachable!("discover stream has not failed"),
+ Poll::Pending => {
+ // assert_eq!(nready, 0, "got pending when a service is ready");
+ }
+ }
+ }
+ } else if services.is_empty() || rand::random() {
+ if services.is_empty() || nready == 0 || rand::random() {
+ // add
+ let (svc, mut handle) = mock::pair::<Req, Req>();
+ let svc = Mock(svc);
+ handle.allow(0);
+ let k = services.insert((handle, false));
+ let ok = tx.send(Ok(Change::Insert(k, svc)));
+ assert!(ok.is_ok());
+ } else {
+ // remove
+ while !services.is_empty() {
+ let k = rand::random::<usize>() % (services.iter().last().unwrap().0 + 1);
+ if services.contains(k) {
+ let (handle, ready) = services.remove(k);
+ if ready {
+ retired.push(handle);
+ }
+ let ok = tx.send(Ok(Change::Remove(k)));
+ assert!(ok.is_ok());
+ break;
+ }
+ }
+ }
+ } else {
+ // fail a service
+ while !services.is_empty() {
+ let k = rand::random::<usize>() % (services.iter().last().unwrap().0 + 1);
+ if services.contains(k) {
+ let (mut handle, ready) = services.remove(k);
+ if ready {
+ nready -= 1;
+ }
+ handle.send_error("doom");
+ break;
+ }
+ }
+ }
+ }
+
+ let r = task.enter(|cx, _| cache.poll_ready(cx));
+
+ // drop any retired services that the p2c has gotten rid of
+ let mut removed = Vec::new();
+ for (i, handle) in retired.iter_mut().enumerate() {
+ if let Poll::Ready(None) = handle.poll_request() {
+ removed.push(i);
+ }
+ }
+ for i in removed.into_iter().rev() {
+ retired.swap_remove(i);
+ nready -= 1;
+ }
+
+ use std::task::Poll;
+ match r {
+ Poll::Ready(Ok(())) => {
+ assert_ne!(nready, 0, "got ready when no service is ready");
+ }
+ Poll::Ready(_) => unreachable!("discover stream has not failed"),
+ Poll::Pending => {
+ assert_eq!(nready, 0, "got pending when a service is ready");
+ }
+ }
+ }
+}
diff --git a/crates/tower/tests/buffer/main.rs b/crates/tower/tests/buffer/main.rs
new file mode 100644
index 0000000..b5e7c19
--- /dev/null
+++ b/crates/tower/tests/buffer/main.rs
@@ -0,0 +1,430 @@
+#![cfg(feature = "buffer")]
+#[path = "../support.rs"]
+mod support;
+use std::thread;
+use tokio_test::{assert_pending, assert_ready, assert_ready_err, assert_ready_ok, task};
+use tower::buffer::{error, Buffer};
+use tower::{util::ServiceExt, Service};
+use tower_test::{assert_request_eq, mock};
+
+fn let_worker_work() {
+ // Allow the Buffer's executor to do work
+ thread::sleep(::std::time::Duration::from_millis(100));
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn req_and_res() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service();
+
+ assert_ready_ok!(service.poll_ready());
+ let mut response = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_response("world");
+
+ let_worker_work();
+ assert_eq!(assert_ready_ok!(response.poll()), "world");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn clears_canceled_requests() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service();
+
+ handle.allow(1);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut res1 = task::spawn(service.call("hello"));
+
+ let send_response1 = assert_request_eq!(handle, "hello");
+
+ // don't respond yet, new requests will get buffered
+ assert_ready_ok!(service.poll_ready());
+ let res2 = task::spawn(service.call("hello2"));
+
+ assert_pending!(handle.poll_request());
+
+ assert_ready_ok!(service.poll_ready());
+ let mut res3 = task::spawn(service.call("hello3"));
+
+ drop(res2);
+
+ send_response1.send_response("world");
+
+ let_worker_work();
+ assert_eq!(assert_ready_ok!(res1.poll()), "world");
+
+ // res2 was dropped, so it should have been canceled in the buffer
+ handle.allow(1);
+
+ assert_request_eq!(handle, "hello3").send_response("world3");
+
+ let_worker_work();
+ assert_eq!(assert_ready_ok!(res3.poll()), "world3");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_inner_is_not_ready() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service();
+
+ // Make the service NotReady
+ handle.allow(0);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut res1 = task::spawn(service.call("hello"));
+
+ let_worker_work();
+ assert_pending!(res1.poll());
+ assert_pending!(handle.poll_request());
+
+ handle.allow(1);
+
+ assert_request_eq!(handle, "hello").send_response("world");
+
+ let_worker_work();
+ assert_eq!(assert_ready_ok!(res1.poll()), "world");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_inner_fails() {
+ use std::error::Error as StdError;
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service();
+
+ // Make the service NotReady
+ handle.allow(0);
+ handle.send_error("foobar");
+
+ assert_ready_ok!(service.poll_ready());
+ let mut res1 = task::spawn(service.call("hello"));
+
+ let_worker_work();
+ let e = assert_ready_err!(res1.poll());
+ if let Some(e) = e.downcast_ref::<error::ServiceError>() {
+ let e = e.source().unwrap();
+
+ assert_eq!(e.to_string(), "foobar");
+ } else {
+ panic!("unexpected error type: {:?}", e);
+ }
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn poll_ready_when_worker_is_dropped_early() {
+ let _t = support::trace_init();
+
+ let (service, _handle) = mock::pair::<(), ()>();
+
+ let (service, worker) = Buffer::pair(service, 1);
+
+ let mut service = mock::Spawn::new(service);
+
+ drop(worker);
+
+ let err = assert_ready_err!(service.poll_ready());
+
+ assert!(err.is::<error::Closed>(), "should be a Closed: {:?}", err);
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn response_future_when_worker_is_dropped_early() {
+ let _t = support::trace_init();
+
+ let (service, mut handle) = mock::pair::<_, ()>();
+
+ let (service, worker) = Buffer::pair(service, 1);
+
+ let mut service = mock::Spawn::new(service);
+
+ // keep the request in the worker
+ handle.allow(0);
+ assert_ready_ok!(service.poll_ready());
+ let mut response = task::spawn(service.call("hello"));
+
+ drop(worker);
+
+ let_worker_work();
+ let err = assert_ready_err!(response.poll());
+ assert!(err.is::<error::Closed>(), "should be a Closed: {:?}", err);
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn waits_for_channel_capacity() {
+ let _t = support::trace_init();
+
+ let (service, mut handle) = mock::pair::<&'static str, &'static str>();
+
+ let (service, worker) = Buffer::pair(service, 3);
+
+ let mut service = mock::Spawn::new(service);
+ let mut worker = task::spawn(worker);
+
+ // keep requests in the worker
+ handle.allow(0);
+ assert_ready_ok!(service.poll_ready());
+ let mut response1 = task::spawn(service.call("hello"));
+ assert_pending!(worker.poll());
+
+ assert_ready_ok!(service.poll_ready());
+ let mut response2 = task::spawn(service.call("hello"));
+ assert_pending!(worker.poll());
+
+ assert_ready_ok!(service.poll_ready());
+ let mut response3 = task::spawn(service.call("hello"));
+ assert_pending!(service.poll_ready());
+ assert_pending!(worker.poll());
+
+ handle.allow(1);
+ assert_pending!(worker.poll());
+
+ handle
+ .next_request()
+ .await
+ .unwrap()
+ .1
+ .send_response("world");
+ assert_pending!(worker.poll());
+ assert_ready_ok!(response1.poll());
+
+ assert_ready_ok!(service.poll_ready());
+ let mut response4 = task::spawn(service.call("hello"));
+ assert_pending!(worker.poll());
+
+ handle.allow(3);
+ assert_pending!(worker.poll());
+
+ handle
+ .next_request()
+ .await
+ .unwrap()
+ .1
+ .send_response("world");
+ assert_pending!(worker.poll());
+ assert_ready_ok!(response2.poll());
+
+ assert_pending!(worker.poll());
+ handle
+ .next_request()
+ .await
+ .unwrap()
+ .1
+ .send_response("world");
+ assert_pending!(worker.poll());
+ assert_ready_ok!(response3.poll());
+
+ assert_pending!(worker.poll());
+ handle
+ .next_request()
+ .await
+ .unwrap()
+ .1
+ .send_response("world");
+ assert_pending!(worker.poll());
+ assert_ready_ok!(response4.poll());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn wakes_pending_waiters_on_close() {
+ let _t = support::trace_init();
+
+ let (service, mut handle) = mock::pair::<_, ()>();
+
+ let (mut service, worker) = Buffer::pair(service, 1);
+ let mut worker = task::spawn(worker);
+
+ // keep the request in the worker
+ handle.allow(0);
+ let service1 = service.ready().await.unwrap();
+ assert_pending!(worker.poll());
+ let mut response = task::spawn(service1.call("hello"));
+
+ let mut service1 = service.clone();
+ let mut ready1 = task::spawn(service1.ready());
+ assert_pending!(worker.poll());
+ assert_pending!(ready1.poll(), "no capacity");
+
+ let mut service1 = service.clone();
+ let mut ready2 = task::spawn(service1.ready());
+ assert_pending!(worker.poll());
+ assert_pending!(ready2.poll(), "no capacity");
+
+ // kill the worker task
+ drop(worker);
+
+ let err = assert_ready_err!(response.poll());
+ assert!(
+ err.is::<error::Closed>(),
+ "response should fail with a Closed, got: {:?}",
+ err
+ );
+
+ assert!(
+ ready1.is_woken(),
+ "dropping worker should wake ready task 1"
+ );
+ let err = assert_ready_err!(ready1.poll());
+ assert!(
+ err.is::<error::Closed>(),
+ "ready 1 should fail with a Closed, got: {:?}",
+ err
+ );
+
+ assert!(
+ ready2.is_woken(),
+ "dropping worker should wake ready task 2"
+ );
+ let err = assert_ready_err!(ready1.poll());
+ assert!(
+ err.is::<error::Closed>(),
+ "ready 2 should fail with a Closed, got: {:?}",
+ err
+ );
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn wakes_pending_waiters_on_failure() {
+ let _t = support::trace_init();
+
+ let (service, mut handle) = mock::pair::<_, ()>();
+
+ let (mut service, worker) = Buffer::pair(service, 1);
+ let mut worker = task::spawn(worker);
+
+ // keep the request in the worker
+ handle.allow(0);
+ let service1 = service.ready().await.unwrap();
+ assert_pending!(worker.poll());
+ let mut response = task::spawn(service1.call("hello"));
+
+ let mut service1 = service.clone();
+ let mut ready1 = task::spawn(service1.ready());
+ assert_pending!(worker.poll());
+ assert_pending!(ready1.poll(), "no capacity");
+
+ let mut service1 = service.clone();
+ let mut ready2 = task::spawn(service1.ready());
+ assert_pending!(worker.poll());
+ assert_pending!(ready2.poll(), "no capacity");
+
+ // fail the inner service
+ handle.send_error("foobar");
+ // worker task terminates
+ assert_ready!(worker.poll());
+
+ let err = assert_ready_err!(response.poll());
+ assert!(
+ err.is::<error::ServiceError>(),
+ "response should fail with a ServiceError, got: {:?}",
+ err
+ );
+
+ assert!(
+ ready1.is_woken(),
+ "dropping worker should wake ready task 1"
+ );
+ let err = assert_ready_err!(ready1.poll());
+ assert!(
+ err.is::<error::ServiceError>(),
+ "ready 1 should fail with a ServiceError, got: {:?}",
+ err
+ );
+
+ assert!(
+ ready2.is_woken(),
+ "dropping worker should wake ready task 2"
+ );
+ let err = assert_ready_err!(ready1.poll());
+ assert!(
+ err.is::<error::ServiceError>(),
+ "ready 2 should fail with a ServiceError, got: {:?}",
+ err
+ );
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn propagates_trace_spans() {
+ use tower::util::ServiceExt;
+ use tracing::Instrument;
+
+ let _t = support::trace_init();
+
+ let span = tracing::info_span!("my_span");
+
+ let service = support::AssertSpanSvc::new(span.clone());
+ let (service, worker) = Buffer::pair(service, 5);
+ let worker = tokio::spawn(worker);
+
+ let result = tokio::spawn(service.oneshot(()).instrument(span));
+
+ result.await.expect("service panicked").expect("failed");
+ worker.await.expect("worker panicked");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn doesnt_leak_permits() {
+ let _t = support::trace_init();
+
+ let (service, mut handle) = mock::pair::<_, ()>();
+
+ let (mut service1, worker) = Buffer::pair(service, 2);
+ let mut worker = task::spawn(worker);
+ let mut service2 = service1.clone();
+ let mut service3 = service1.clone();
+
+ // Attempt to poll the first clone of the buffer to readiness multiple
+ // times. These should all succeed, because the readiness is never
+ // *consumed* --- no request is sent.
+ assert_ready_ok!(task::spawn(service1.ready()).poll());
+ assert_ready_ok!(task::spawn(service1.ready()).poll());
+ assert_ready_ok!(task::spawn(service1.ready()).poll());
+
+ // It should also be possible to drive the second clone of the service to
+ // readiness --- it should only acquire one permit, as well.
+ assert_ready_ok!(task::spawn(service2.ready()).poll());
+ assert_ready_ok!(task::spawn(service2.ready()).poll());
+ assert_ready_ok!(task::spawn(service2.ready()).poll());
+
+ // The third clone *doesn't* poll ready, because the first two clones have
+ // each acquired one permit.
+ let mut ready3 = task::spawn(service3.ready());
+ assert_pending!(ready3.poll());
+
+ // Consume the first service's readiness.
+ let mut response = task::spawn(service1.call(()));
+ handle.allow(1);
+ assert_pending!(worker.poll());
+
+ handle.next_request().await.unwrap().1.send_response(());
+ assert_pending!(worker.poll());
+ assert_ready_ok!(response.poll());
+
+ // Now, the third service should acquire a permit...
+ assert!(ready3.is_woken());
+ assert_ready_ok!(ready3.poll());
+}
+
+type Mock = mock::Mock<&'static str, &'static str>;
+type Handle = mock::Handle<&'static str, &'static str>;
+
+fn new_service() -> (mock::Spawn<Buffer<Mock, &'static str>>, Handle) {
+ // bound is >0 here because clears_canceled_requests needs multiple outstanding requests
+ new_service_with_bound(10)
+}
+
+fn new_service_with_bound(bound: usize) -> (mock::Spawn<Buffer<Mock, &'static str>>, Handle) {
+ mock::spawn_with(|s| {
+ let (svc, worker) = Buffer::pair(s, bound);
+
+ thread::spawn(move || {
+ let mut fut = tokio_test::task::spawn(worker);
+ while fut.poll().is_pending() {}
+ });
+
+ svc
+ })
+}
diff --git a/crates/tower/tests/builder.rs b/crates/tower/tests/builder.rs
new file mode 100644
index 0000000..8bc8ce1
--- /dev/null
+++ b/crates/tower/tests/builder.rs
@@ -0,0 +1,55 @@
+#![cfg(all(feature = "buffer", feature = "limit", feature = "retry"))]
+mod support;
+use futures_util::{future::Ready, pin_mut};
+use std::time::Duration;
+use tower::builder::ServiceBuilder;
+use tower::retry::Policy;
+use tower::util::ServiceExt;
+use tower_service::*;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn builder_service() {
+ let _t = support::trace_init();
+
+ let (service, handle) = mock::pair();
+ pin_mut!(handle);
+
+ let policy = MockPolicy::<&'static str, bool>::default();
+ let mut client = ServiceBuilder::new()
+ .buffer(5)
+ .concurrency_limit(5)
+ .rate_limit(5, Duration::from_secs(5))
+ .retry(policy)
+ .map_response(|r: &'static str| r == "world")
+ .map_request(|r: &'static str| r == "hello")
+ .service(service);
+
+ // allow a request through
+ handle.allow(1);
+
+ let fut = client.ready().await.unwrap().call("hello");
+ assert_request_eq!(handle, true).send_response("world");
+ assert!(fut.await.unwrap());
+}
+
+#[derive(Debug, Clone, Default)]
+struct MockPolicy<Req, Res> {
+ _pd: std::marker::PhantomData<(Req, Res)>,
+}
+
+impl<Req, Res, E> Policy<Req, Res, E> for MockPolicy<Req, Res>
+where
+ Req: Clone,
+ E: Into<Box<dyn std::error::Error + Send + Sync + 'static>>,
+{
+ type Future = Ready<Self>;
+
+ fn retry(&self, _req: &Req, _result: Result<&Res, &E>) -> Option<Self::Future> {
+ None
+ }
+
+ fn clone_request(&self, req: &Req) -> Option<Req> {
+ Some(req.clone())
+ }
+}
diff --git a/crates/tower/tests/filter/async_filter.rs b/crates/tower/tests/filter/async_filter.rs
new file mode 100644
index 0000000..4a0a5a9
--- /dev/null
+++ b/crates/tower/tests/filter/async_filter.rs
@@ -0,0 +1,63 @@
+#![cfg(feature = "filter")]
+#[path = "../support.rs"]
+mod support;
+use futures_util::{future::poll_fn, pin_mut};
+use std::future::Future;
+use tower::filter::{error::Error, AsyncFilter};
+use tower_service::Service;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn passthrough_sync() {
+ let _t = support::trace_init();
+
+ let (mut service, handle) = new_service(|_| async { Ok(()) });
+
+ let th = tokio::spawn(async move {
+ // Receive the requests and respond
+ pin_mut!(handle);
+ for i in 0..10usize {
+ assert_request_eq!(handle, format!("ping-{}", i)).send_response(format!("pong-{}", i));
+ }
+ });
+
+ let mut responses = vec![];
+
+ for i in 0usize..10 {
+ let request = format!("ping-{}", i);
+ poll_fn(|cx| service.poll_ready(cx)).await.unwrap();
+ let exchange = service.call(request);
+ let exchange = async move {
+ let response = exchange.await.unwrap();
+ let expect = format!("pong-{}", i);
+ assert_eq!(response.as_str(), expect.as_str());
+ };
+
+ responses.push(exchange);
+ }
+
+ futures_util::future::join_all(responses).await;
+ th.await.unwrap();
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn rejected_sync() {
+ let _t = support::trace_init();
+
+ let (mut service, _handle) = new_service(|_| async { Err(Error::rejected()) });
+
+ service.call("hello".into()).await.unwrap_err();
+}
+
+type Mock = mock::Mock<String, String>;
+type Handle = mock::Handle<String, String>;
+
+fn new_service<F, U>(f: F) -> (AsyncFilter<Mock, F>, Handle)
+where
+ F: Fn(&String) -> U,
+ U: Future<Output = Result<(), Error>>,
+{
+ let (service, handle) = mock::pair();
+ let service = AsyncFilter::new(service, f);
+ (service, handle)
+}
diff --git a/crates/tower/tests/hedge/main.rs b/crates/tower/tests/hedge/main.rs
new file mode 100644
index 0000000..d4082ca
--- /dev/null
+++ b/crates/tower/tests/hedge/main.rs
@@ -0,0 +1,184 @@
+#![cfg(feature = "hedge")]
+#[path = "../support.rs"]
+mod support;
+
+use std::time::Duration;
+use tokio::time;
+use tokio_test::{assert_pending, assert_ready, assert_ready_ok, task};
+use tower::hedge::{Hedge, Policy};
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn hedge_orig_completes_first() {
+ let _t = support::trace_init();
+ time::pause();
+
+ let (mut service, mut handle) = new_service(TestPolicy);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("orig"));
+
+ // Check that orig request has been issued.
+ let req = assert_request_eq!(handle, "orig");
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+ time::advance(Duration::from_millis(11)).await;
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+ // Check that the hedge has been issued.
+ let _hedge_req = assert_request_eq!(handle, "orig");
+
+ req.send_response("orig-done");
+ // Check that fut gets orig response.
+ assert_eq!(assert_ready_ok!(fut.poll()), "orig-done");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn hedge_hedge_completes_first() {
+ let _t = support::trace_init();
+ time::pause();
+
+ let (mut service, mut handle) = new_service(TestPolicy);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("orig"));
+
+ // Check that orig request has been issued.
+ let _req = assert_request_eq!(handle, "orig");
+
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+ time::advance(Duration::from_millis(11)).await;
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ // Check that the hedge has been issued.
+ let hedge_req = assert_request_eq!(handle, "orig");
+ hedge_req.send_response("hedge-done");
+ // Check that fut gets hedge response.
+ assert_eq!(assert_ready_ok!(fut.poll()), "hedge-done");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn completes_before_hedge() {
+ let _t = support::trace_init();
+ let (mut service, mut handle) = new_service(TestPolicy);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("orig"));
+
+ // Check that orig request has been issued.
+ let req = assert_request_eq!(handle, "orig");
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ req.send_response("orig-done");
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+ // Check that fut gets orig response.
+ assert_eq!(assert_ready_ok!(fut.poll()), "orig-done");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn request_not_retyable() {
+ let _t = support::trace_init();
+ time::pause();
+
+ let (mut service, mut handle) = new_service(TestPolicy);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call(NOT_RETRYABLE));
+
+ // Check that orig request has been issued.
+ let req = assert_request_eq!(handle, NOT_RETRYABLE);
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+ time::advance(Duration::from_millis(10)).await;
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+
+ req.send_response("orig-done");
+ // Check that fut gets orig response.
+ assert_eq!(assert_ready_ok!(fut.poll()), "orig-done");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn request_not_clonable() {
+ let _t = support::trace_init();
+ time::pause();
+
+ let (mut service, mut handle) = new_service(TestPolicy);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call(NOT_CLONABLE));
+
+ // Check that orig request has been issued.
+ let req = assert_request_eq!(handle, NOT_CLONABLE);
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+ time::advance(Duration::from_millis(10)).await;
+ // Check fut is not ready.
+ assert_pending!(fut.poll());
+ // Check hedge has not been issued.
+ assert_pending!(handle.poll_request());
+
+ req.send_response("orig-done");
+ // Check that fut gets orig response.
+ assert_eq!(assert_ready_ok!(fut.poll()), "orig-done");
+}
+
+type Req = &'static str;
+type Res = &'static str;
+type Mock = tower_test::mock::Mock<Req, Res>;
+type Handle = tower_test::mock::Handle<Req, Res>;
+
+static NOT_RETRYABLE: &str = "NOT_RETRYABLE";
+static NOT_CLONABLE: &str = "NOT_CLONABLE";
+
+#[derive(Clone)]
+struct TestPolicy;
+
+impl tower::hedge::Policy<Req> for TestPolicy {
+ fn can_retry(&self, req: &Req) -> bool {
+ *req != NOT_RETRYABLE
+ }
+
+ fn clone_request(&self, req: &Req) -> Option<Req> {
+ if *req == NOT_CLONABLE {
+ None
+ } else {
+ Some(req)
+ }
+ }
+}
+
+fn new_service<P: Policy<Req> + Clone>(policy: P) -> (mock::Spawn<Hedge<Mock, P>>, Handle) {
+ let (service, handle) = tower_test::mock::pair();
+
+ let mock_latencies: [u64; 10] = [1, 1, 1, 1, 1, 1, 1, 1, 10, 10];
+
+ let service = Hedge::new_with_mock_latencies(
+ service,
+ policy,
+ 10,
+ 0.9,
+ Duration::from_secs(60),
+ &mock_latencies,
+ );
+
+ (mock::Spawn::new(service), handle)
+}
diff --git a/crates/tower/tests/limit/concurrency.rs b/crates/tower/tests/limit/concurrency.rs
new file mode 100644
index 0000000..a471c52
--- /dev/null
+++ b/crates/tower/tests/limit/concurrency.rs
@@ -0,0 +1,217 @@
+#[path = "../support.rs"]
+mod support;
+use tokio_test::{assert_pending, assert_ready, assert_ready_ok};
+use tower::limit::concurrency::ConcurrencyLimitLayer;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn basic_service_limit_functionality_with_poll_ready() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(2);
+ let (mut service, mut handle) = mock::spawn_layer(limit);
+
+ assert_ready_ok!(service.poll_ready());
+ let r1 = service.call("hello 1");
+
+ assert_ready_ok!(service.poll_ready());
+ let r2 = service.call("hello 2");
+
+ assert_pending!(service.poll_ready());
+
+ assert!(!service.is_woken());
+
+ // The request gets passed through
+ assert_request_eq!(handle, "hello 1").send_response("world 1");
+
+ // The next request gets passed through
+ assert_request_eq!(handle, "hello 2").send_response("world 2");
+
+ // There are no more requests
+ assert_pending!(handle.poll_request());
+
+ assert_eq!(r1.await.unwrap(), "world 1");
+
+ assert!(service.is_woken());
+
+ // Another request can be sent
+ assert_ready_ok!(service.poll_ready());
+
+ let r3 = service.call("hello 3");
+
+ assert_pending!(service.poll_ready());
+
+ assert_eq!(r2.await.unwrap(), "world 2");
+
+ // The request gets passed through
+ assert_request_eq!(handle, "hello 3").send_response("world 3");
+
+ assert_eq!(r3.await.unwrap(), "world 3");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn basic_service_limit_functionality_without_poll_ready() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(2);
+ let (mut service, mut handle) = mock::spawn_layer(limit);
+
+ assert_ready_ok!(service.poll_ready());
+ let r1 = service.call("hello 1");
+
+ assert_ready_ok!(service.poll_ready());
+ let r2 = service.call("hello 2");
+
+ assert_pending!(service.poll_ready());
+
+ // The request gets passed through
+ assert_request_eq!(handle, "hello 1").send_response("world 1");
+
+ assert!(!service.is_woken());
+
+ // The next request gets passed through
+ assert_request_eq!(handle, "hello 2").send_response("world 2");
+
+ assert!(!service.is_woken());
+
+ // There are no more requests
+ assert_pending!(handle.poll_request());
+
+ assert_eq!(r1.await.unwrap(), "world 1");
+
+ assert!(service.is_woken());
+
+ // One more request can be sent
+ assert_ready_ok!(service.poll_ready());
+ let r4 = service.call("hello 4");
+
+ assert_pending!(service.poll_ready());
+
+ assert_eq!(r2.await.unwrap(), "world 2");
+ assert!(service.is_woken());
+
+ // The request gets passed through
+ assert_request_eq!(handle, "hello 4").send_response("world 4");
+
+ assert_eq!(r4.await.unwrap(), "world 4");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn request_without_capacity() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(0);
+ let (mut service, _) = mock::spawn_layer::<(), (), _>(limit);
+
+ assert_pending!(service.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn reserve_capacity_without_sending_request() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(1);
+ let (mut s1, mut handle) = mock::spawn_layer(limit);
+
+ let mut s2 = s1.clone();
+
+ // Reserve capacity in s1
+ assert_ready_ok!(s1.poll_ready());
+
+ // Service 2 cannot get capacity
+ assert_pending!(s2.poll_ready());
+
+ // s1 sends the request, then s2 is able to get capacity
+ let r1 = s1.call("hello");
+
+ assert_request_eq!(handle, "hello").send_response("world");
+
+ assert_pending!(s2.poll_ready());
+
+ r1.await.unwrap();
+
+ assert_ready_ok!(s2.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn service_drop_frees_capacity() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(1);
+ let (mut s1, _handle) = mock::spawn_layer::<(), (), _>(limit);
+
+ let mut s2 = s1.clone();
+
+ // Reserve capacity in s1
+ assert_ready_ok!(s1.poll_ready());
+
+ // Service 2 cannot get capacity
+ assert_pending!(s2.poll_ready());
+
+ drop(s1);
+
+ assert!(s2.is_woken());
+ assert_ready_ok!(s2.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn response_error_releases_capacity() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(1);
+ let (mut s1, mut handle) = mock::spawn_layer::<_, (), _>(limit);
+
+ let mut s2 = s1.clone();
+
+ // Reserve capacity in s1
+ assert_ready_ok!(s1.poll_ready());
+
+ // s1 sends the request, then s2 is able to get capacity
+ let r1 = s1.call("hello");
+
+ assert_request_eq!(handle, "hello").send_error("boom");
+
+ r1.await.unwrap_err();
+
+ assert_ready_ok!(s2.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn response_future_drop_releases_capacity() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(1);
+ let (mut s1, _handle) = mock::spawn_layer::<_, (), _>(limit);
+
+ let mut s2 = s1.clone();
+
+ // Reserve capacity in s1
+ assert_ready_ok!(s1.poll_ready());
+
+ // s1 sends the request, then s2 is able to get capacity
+ let r1 = s1.call("hello");
+
+ assert_pending!(s2.poll_ready());
+
+ drop(r1);
+
+ assert_ready_ok!(s2.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn multi_waiters() {
+ let _t = support::trace_init();
+ let limit = ConcurrencyLimitLayer::new(1);
+ let (mut s1, _handle) = mock::spawn_layer::<(), (), _>(limit);
+ let mut s2 = s1.clone();
+ let mut s3 = s1.clone();
+
+ // Reserve capacity in s1
+ assert_ready_ok!(s1.poll_ready());
+
+ // s2 and s3 are not ready
+ assert_pending!(s2.poll_ready());
+ assert_pending!(s3.poll_ready());
+
+ drop(s1);
+
+ assert!(s2.is_woken());
+ assert!(!s3.is_woken());
+
+ drop(s2);
+
+ assert!(s3.is_woken());
+}
diff --git a/crates/tower/tests/limit/main.rs b/crates/tower/tests/limit/main.rs
new file mode 100644
index 0000000..1274454
--- /dev/null
+++ b/crates/tower/tests/limit/main.rs
@@ -0,0 +1,5 @@
+#![cfg(feature = "limit")]
+mod concurrency;
+mod rate;
+#[path = "../support.rs"]
+pub(crate) mod support;
diff --git a/crates/tower/tests/limit/rate.rs b/crates/tower/tests/limit/rate.rs
new file mode 100644
index 0000000..9c49e4b
--- /dev/null
+++ b/crates/tower/tests/limit/rate.rs
@@ -0,0 +1,71 @@
+use super::support;
+use std::time::Duration;
+use tokio::time;
+use tokio_test::{assert_pending, assert_ready, assert_ready_ok};
+use tower::limit::rate::RateLimitLayer;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn reaching_capacity() {
+ let _t = support::trace_init();
+ time::pause();
+
+ let rate_limit = RateLimitLayer::new(1, Duration::from_millis(100));
+ let (mut service, mut handle) = mock::spawn_layer(rate_limit);
+
+ assert_ready_ok!(service.poll_ready());
+
+ let response = service.call("hello");
+
+ assert_request_eq!(handle, "hello").send_response("world");
+
+ assert_eq!(response.await.unwrap(), "world");
+ assert_pending!(service.poll_ready());
+
+ assert_pending!(handle.poll_request());
+
+ time::advance(Duration::from_millis(101)).await;
+
+ assert_ready_ok!(service.poll_ready());
+
+ let response = service.call("two");
+
+ assert_request_eq!(handle, "two").send_response("done");
+
+ assert_eq!(response.await.unwrap(), "done");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn remaining_gets_reset() {
+ // This test checks for the case where the `until` state gets reset
+ // but the `rem` does not. This was a bug found `cd7dd12315706fc0860a35646b1eb7b60c50a5c1`.
+ //
+ // The main premise here is that we can make one request which should initialize the state
+ // as ready. Then we can advance the clock to put us beyond the current period. When we make
+ // subsequent requests the `rem` for the next window is continued from the previous when
+ // it should be totally reset.
+ let _t = support::trace_init();
+ time::pause();
+
+ let rate_limit = RateLimitLayer::new(3, Duration::from_millis(100));
+ let (mut service, mut handle) = mock::spawn_layer(rate_limit);
+
+ assert_ready_ok!(service.poll_ready());
+ let response = service.call("hello");
+ assert_request_eq!(handle, "hello").send_response("world");
+ assert_eq!(response.await.unwrap(), "world");
+
+ time::advance(Duration::from_millis(100)).await;
+
+ assert_ready_ok!(service.poll_ready());
+ let response = service.call("hello");
+ assert_request_eq!(handle, "hello").send_response("world");
+ assert_eq!(response.await.unwrap(), "world");
+
+ assert_ready_ok!(service.poll_ready());
+ let response = service.call("hello");
+ assert_request_eq!(handle, "hello").send_response("world");
+ assert_eq!(response.await.unwrap(), "world");
+
+ assert_ready_ok!(service.poll_ready());
+}
diff --git a/crates/tower/tests/load_shed/main.rs b/crates/tower/tests/load_shed/main.rs
new file mode 100644
index 0000000..98eba86
--- /dev/null
+++ b/crates/tower/tests/load_shed/main.rs
@@ -0,0 +1,39 @@
+#![cfg(feature = "load-shed")]
+#[path = "../support.rs"]
+mod support;
+
+use tokio_test::{assert_ready_err, assert_ready_ok, task};
+use tower::load_shed::LoadShedLayer;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_ready() {
+ let _t = support::trace_init();
+
+ let layer = LoadShedLayer::new();
+ let (mut service, mut handle) = mock::spawn_layer(layer);
+
+ assert_ready_ok!(service.poll_ready(), "overload always reports ready");
+
+ let mut response = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_response("world");
+ assert_eq!(assert_ready_ok!(response.poll()), "world");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_not_ready() {
+ let _t = support::trace_init();
+
+ let layer = LoadShedLayer::new();
+ let (mut service, mut handle) = mock::spawn_layer::<_, (), _>(layer);
+
+ handle.allow(0);
+
+ assert_ready_ok!(service.poll_ready(), "overload always reports ready");
+
+ let mut fut = task::spawn(service.call("hello"));
+
+ let err = assert_ready_err!(fut.poll());
+ assert!(err.is::<tower::load_shed::error::Overloaded>());
+}
diff --git a/crates/tower/tests/ready_cache/main.rs b/crates/tower/tests/ready_cache/main.rs
new file mode 100644
index 0000000..56be6a9
--- /dev/null
+++ b/crates/tower/tests/ready_cache/main.rs
@@ -0,0 +1,223 @@
+#![cfg(feature = "ready-cache")]
+#[path = "../support.rs"]
+mod support;
+
+use std::pin::Pin;
+use tokio_test::{assert_pending, assert_ready, task};
+use tower::ready_cache::{error, ReadyCache};
+use tower_test::mock;
+
+type Req = &'static str;
+type Mock = mock::Mock<Req, Req>;
+
+#[test]
+fn poll_ready_inner_failure() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service0, mut handle0) = mock::pair::<Req, Req>();
+ handle0.send_error("doom");
+ cache.push(0, service0);
+
+ let (service1, mut handle1) = mock::pair::<Req, Req>();
+ handle1.allow(1);
+ cache.push(1, service1);
+
+ let failed = assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap_err();
+
+ assert_eq!(failed.0, 0);
+ assert_eq!(format!("{}", failed.1), "doom");
+
+ assert_eq!(cache.len(), 1);
+}
+
+#[test]
+fn poll_ready_not_ready() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service0, mut handle0) = mock::pair::<Req, Req>();
+ handle0.allow(0);
+ cache.push(0, service0);
+
+ let (service1, mut handle1) = mock::pair::<Req, Req>();
+ handle1.allow(0);
+ cache.push(1, service1);
+
+ assert_pending!(task.enter(|cx, _| cache.poll_pending(cx)));
+
+ assert_eq!(cache.ready_len(), 0);
+ assert_eq!(cache.pending_len(), 2);
+ assert_eq!(cache.len(), 2);
+}
+
+#[test]
+fn poll_ready_promotes_inner() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service0, mut handle0) = mock::pair::<Req, Req>();
+ handle0.allow(1);
+ cache.push(0, service0);
+
+ let (service1, mut handle1) = mock::pair::<Req, Req>();
+ handle1.allow(1);
+ cache.push(1, service1);
+
+ assert_eq!(cache.ready_len(), 0);
+ assert_eq!(cache.pending_len(), 2);
+ assert_eq!(cache.len(), 2);
+
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+
+ assert_eq!(cache.ready_len(), 2);
+ assert_eq!(cache.pending_len(), 0);
+ assert_eq!(cache.len(), 2);
+}
+
+#[test]
+fn evict_ready_then_error() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service, mut handle) = mock::pair::<Req, Req>();
+ handle.allow(0);
+ cache.push(0, service);
+
+ assert_pending!(task.enter(|cx, _| cache.poll_pending(cx)));
+
+ handle.allow(1);
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+
+ handle.send_error("doom");
+ assert!(cache.evict(&0));
+
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+}
+
+#[test]
+fn evict_pending_then_error() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service, mut handle) = mock::pair::<Req, Req>();
+ handle.allow(0);
+ cache.push(0, service);
+
+ assert_pending!(task.enter(|cx, _| cache.poll_pending(cx)));
+
+ handle.send_error("doom");
+ assert!(cache.evict(&0));
+
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+}
+
+#[test]
+fn push_then_evict() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service, mut handle) = mock::pair::<Req, Req>();
+ handle.allow(0);
+ cache.push(0, service);
+ handle.send_error("doom");
+ assert!(cache.evict(&0));
+
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+}
+
+#[test]
+fn error_after_promote() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service, mut handle) = mock::pair::<Req, Req>();
+ handle.allow(0);
+ cache.push(0, service);
+
+ assert_pending!(task.enter(|cx, _| cache.poll_pending(cx)));
+
+ handle.allow(1);
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+
+ handle.send_error("doom");
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+}
+
+#[test]
+fn duplicate_key_by_index() {
+ let _t = support::trace_init();
+
+ let mut task = task::spawn(());
+ let mut cache = ReadyCache::<usize, Mock, Req>::default();
+
+ let (service0, mut handle0) = mock::pair::<Req, Req>();
+ handle0.allow(1);
+ cache.push(0, service0);
+
+ let (service1, mut handle1) = mock::pair::<Req, Req>();
+ handle1.allow(1);
+ // this push should replace the old service (service0)
+ cache.push(0, service1);
+
+ // this evict should evict service1
+ cache.evict(&0);
+
+ // poll_pending should complete (there are no remaining pending services)
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+ // but service 0 should not be ready (1 replaced, 1 evicted)
+ assert!(!task.enter(|cx, _| cache.check_ready(cx, &0)).unwrap());
+
+ let (service2, mut handle2) = mock::pair::<Req, Req>();
+ handle2.allow(1);
+ // this push should ensure replace the evicted service1
+ cache.push(0, service2);
+
+ // there should be no more pending
+ assert_ready!(task.enter(|cx, _| cache.poll_pending(cx))).unwrap();
+ // _and_ service 0 should now be callable
+ assert!(task.enter(|cx, _| cache.check_ready(cx, &0)).unwrap());
+}
+
+// Tests https://github.com/tower-rs/tower/issues/415
+#[tokio::test(flavor = "current_thread")]
+async fn cancelation_observed() {
+ let mut cache = ReadyCache::default();
+ let mut handles = vec![];
+
+ // NOTE This test passes at 129 items, but fails at 130 items (if coop
+ // schedulding interferes with cancelation).
+ for _ in 0..130 {
+ let (svc, mut handle) = tower_test::mock::pair::<(), ()>();
+ handle.allow(1);
+ cache.push("ep0", svc);
+ handles.push(handle);
+ }
+
+ struct Ready(ReadyCache<&'static str, tower_test::mock::Mock<(), ()>, ()>);
+ impl Unpin for Ready {}
+ impl std::future::Future for Ready {
+ type Output = Result<(), error::Failed<&'static str>>;
+ fn poll(
+ self: Pin<&mut Self>,
+ cx: &mut std::task::Context<'_>,
+ ) -> std::task::Poll<Self::Output> {
+ self.get_mut().0.poll_pending(cx)
+ }
+ }
+ Ready(cache).await.unwrap();
+}
diff --git a/crates/tower/tests/retry/main.rs b/crates/tower/tests/retry/main.rs
new file mode 100644
index 0000000..a07242b
--- /dev/null
+++ b/crates/tower/tests/retry/main.rs
@@ -0,0 +1,175 @@
+#![cfg(feature = "retry")]
+#[path = "../support.rs"]
+mod support;
+
+use futures_util::future;
+use tokio_test::{assert_pending, assert_ready_err, assert_ready_ok, task};
+use tower::retry::Policy;
+use tower_test::{assert_request_eq, mock};
+
+#[tokio::test(flavor = "current_thread")]
+async fn retry_errors() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service(RetryErrors);
+
+ assert_ready_ok!(service.poll_ready());
+
+ let mut fut = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_error("retry me");
+
+ assert_pending!(fut.poll());
+
+ assert_request_eq!(handle, "hello").send_response("world");
+
+ assert_eq!(fut.into_inner().await.unwrap(), "world");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn retry_limit() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service(Limit(2));
+
+ assert_ready_ok!(service.poll_ready());
+
+ let mut fut = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_error("retry 1");
+ assert_pending!(fut.poll());
+
+ assert_request_eq!(handle, "hello").send_error("retry 2");
+ assert_pending!(fut.poll());
+
+ assert_request_eq!(handle, "hello").send_error("retry 3");
+ assert_eq!(assert_ready_err!(fut.poll()).to_string(), "retry 3");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn retry_error_inspection() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service(UnlessErr("reject"));
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_error("retry 1");
+ assert_pending!(fut.poll());
+
+ assert_request_eq!(handle, "hello").send_error("reject");
+ assert_eq!(assert_ready_err!(fut.poll()).to_string(), "reject");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn retry_cannot_clone_request() {
+ let _t = support::trace_init();
+
+ let (mut service, mut handle) = new_service(CannotClone);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_error("retry 1");
+ assert_eq!(assert_ready_err!(fut.poll()).to_string(), "retry 1");
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn success_with_cannot_clone() {
+ let _t = support::trace_init();
+
+ // Even though the request couldn't be cloned, if the first request succeeds,
+ // it should succeed overall.
+ let (mut service, mut handle) = new_service(CannotClone);
+
+ assert_ready_ok!(service.poll_ready());
+ let mut fut = task::spawn(service.call("hello"));
+
+ assert_request_eq!(handle, "hello").send_response("world");
+ assert_ready_ok!(fut.poll(), "world");
+}
+
+type Req = &'static str;
+type Res = &'static str;
+type InnerError = &'static str;
+type Error = Box<dyn std::error::Error + Send + Sync>;
+type Mock = mock::Mock<Req, Res>;
+type Handle = mock::Handle<Req, Res>;
+
+#[derive(Clone)]
+struct RetryErrors;
+
+impl Policy<Req, Res, Error> for RetryErrors {
+ type Future = future::Ready<Self>;
+ fn retry(&self, _: &Req, result: Result<&Res, &Error>) -> Option<Self::Future> {
+ if result.is_err() {
+ Some(future::ready(RetryErrors))
+ } else {
+ None
+ }
+ }
+
+ fn clone_request(&self, req: &Req) -> Option<Req> {
+ Some(*req)
+ }
+}
+
+#[derive(Clone)]
+struct Limit(usize);
+
+impl Policy<Req, Res, Error> for Limit {
+ type Future = future::Ready<Self>;
+ fn retry(&self, _: &Req, result: Result<&Res, &Error>) -> Option<Self::Future> {
+ if result.is_err() && self.0 > 0 {
+ Some(future::ready(Limit(self.0 - 1)))
+ } else {
+ None
+ }
+ }
+
+ fn clone_request(&self, req: &Req) -> Option<Req> {
+ Some(*req)
+ }
+}
+
+#[derive(Clone)]
+struct UnlessErr(InnerError);
+
+impl Policy<Req, Res, Error> for UnlessErr {
+ type Future = future::Ready<Self>;
+ fn retry(&self, _: &Req, result: Result<&Res, &Error>) -> Option<Self::Future> {
+ result.err().and_then(|err| {
+ if err.to_string() != self.0 {
+ Some(future::ready(self.clone()))
+ } else {
+ None
+ }
+ })
+ }
+
+ fn clone_request(&self, req: &Req) -> Option<Req> {
+ Some(*req)
+ }
+}
+
+#[derive(Clone)]
+struct CannotClone;
+
+impl Policy<Req, Res, Error> for CannotClone {
+ type Future = future::Ready<Self>;
+ fn retry(&self, _: &Req, _: Result<&Res, &Error>) -> Option<Self::Future> {
+ unreachable!("retry cannot be called since request isn't cloned");
+ }
+
+ fn clone_request(&self, _req: &Req) -> Option<Req> {
+ None
+ }
+}
+
+fn new_service<P: Policy<Req, Res, Error> + Clone>(
+ policy: P,
+) -> (mock::Spawn<tower::retry::Retry<P, Mock>>, Handle) {
+ let retry = tower::retry::RetryLayer::new(policy);
+ mock::spawn_layer(retry)
+}
diff --git a/crates/tower/tests/spawn_ready/main.rs b/crates/tower/tests/spawn_ready/main.rs
new file mode 100644
index 0000000..d189015
--- /dev/null
+++ b/crates/tower/tests/spawn_ready/main.rs
@@ -0,0 +1,86 @@
+#![cfg(feature = "spawn-ready")]
+#[path = "../support.rs"]
+mod support;
+
+use tokio::time;
+use tokio_test::{assert_pending, assert_ready, assert_ready_err, assert_ready_ok};
+use tower::spawn_ready::{SpawnReady, SpawnReadyLayer};
+use tower::util::ServiceExt;
+use tower_test::mock;
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_inner_is_not_ready() {
+ time::pause();
+
+ let _t = support::trace_init();
+
+ let layer = SpawnReadyLayer::new();
+ let (mut service, mut handle) = mock::spawn_layer::<(), (), _>(layer);
+
+ // Make the service NotReady
+ handle.allow(0);
+
+ assert_pending!(service.poll_ready());
+
+ // Make the service is Ready
+ handle.allow(1);
+ time::sleep(time::Duration::from_millis(100)).await;
+ assert_ready_ok!(service.poll_ready());
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn when_inner_fails() {
+ let _t = support::trace_init();
+
+ let layer = SpawnReadyLayer::new();
+ let (mut service, mut handle) = mock::spawn_layer::<(), (), _>(layer);
+
+ // Make the service NotReady
+ handle.allow(0);
+ handle.send_error("foobar");
+
+ assert_eq!(
+ assert_ready_err!(service.poll_ready()).to_string(),
+ "foobar"
+ );
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn propagates_trace_spans() {
+ use tracing::Instrument;
+
+ let _t = support::trace_init();
+
+ let span = tracing::info_span!("my_span");
+
+ let service = support::AssertSpanSvc::new(span.clone());
+ let service = SpawnReady::new(service);
+ let result = tokio::spawn(service.oneshot(()).instrument(span));
+
+ result.await.expect("service panicked").expect("failed");
+}
+
+#[cfg(test)]
+#[tokio::test(flavor = "current_thread")]
+async fn abort_on_drop() {
+ let (mock, mut handle) = mock::pair::<(), ()>();
+ let mut svc = SpawnReady::new(mock);
+ handle.allow(0);
+
+ // Drive the service to readiness until we signal a drop.
+ let (drop_tx, drop_rx) = tokio::sync::oneshot::channel();
+ let mut task = tokio_test::task::spawn(async move {
+ tokio::select! {
+ _ = drop_rx => {}
+ _ = svc.ready() => unreachable!("Service must not become ready"),
+ }
+ });
+ assert_pending!(task.poll());
+ assert_pending!(handle.poll_request());
+
+ // End the task and ensure that the inner service has been dropped.
+ assert!(drop_tx.send(()).is_ok());
+ tokio_test::assert_ready!(task.poll());
+ tokio::task::yield_now().await;
+ assert!(tokio_test::assert_ready!(handle.poll_request()).is_none());
+}
diff --git a/crates/tower/tests/steer/main.rs b/crates/tower/tests/steer/main.rs
new file mode 100644
index 0000000..1ff08d3
--- /dev/null
+++ b/crates/tower/tests/steer/main.rs
@@ -0,0 +1,59 @@
+#![cfg(feature = "steer")]
+#[path = "../support.rs"]
+mod support;
+
+use futures_util::future::{ready, Ready};
+use std::task::{Context, Poll};
+use tower::steer::Steer;
+use tower_service::Service;
+
+type StdError = Box<dyn std::error::Error + Send + Sync + 'static>;
+
+struct MyService(u8, bool);
+
+impl Service<String> for MyService {
+ type Response = u8;
+ type Error = StdError;
+ type Future = Ready<Result<u8, Self::Error>>;
+
+ fn poll_ready(&mut self, _cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if !self.1 {
+ Poll::Pending
+ } else {
+ Poll::Ready(Ok(()))
+ }
+ }
+
+ fn call(&mut self, _req: String) -> Self::Future {
+ ready(Ok(self.0))
+ }
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn pick_correctly() {
+ let _t = support::trace_init();
+ let srvs = vec![MyService(42, true), MyService(57, true)];
+ let mut st = Steer::new(srvs, |_: &_, _: &[_]| 1);
+
+ futures_util::future::poll_fn(|cx| st.poll_ready(cx))
+ .await
+ .unwrap();
+ let r = st.call(String::from("foo")).await.unwrap();
+ assert_eq!(r, 57);
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn pending_all_ready() {
+ let _t = support::trace_init();
+
+ let srvs = vec![MyService(42, true), MyService(57, false)];
+ let mut st = Steer::new(srvs, |_: &_, _: &[_]| 0);
+
+ let p = futures_util::poll!(futures_util::future::poll_fn(|cx| st.poll_ready(cx)));
+ match p {
+ Poll::Pending => (),
+ _ => panic!(
+ "Steer should not return poll_ready if at least one component service is not ready"
+ ),
+ }
+}
diff --git a/crates/tower/tests/support.rs b/crates/tower/tests/support.rs
new file mode 100644
index 0000000..b547082
--- /dev/null
+++ b/crates/tower/tests/support.rs
@@ -0,0 +1,112 @@
+#![allow(dead_code)]
+
+use futures::future;
+use std::fmt;
+use std::pin::Pin;
+use std::task::{Context, Poll};
+use tokio::sync::mpsc;
+use tokio_stream::Stream;
+use tower::Service;
+
+pub(crate) fn trace_init() -> tracing::subscriber::DefaultGuard {
+ let subscriber = tracing_subscriber::fmt()
+ .with_test_writer()
+ .with_max_level(tracing::Level::TRACE)
+ .with_thread_names(true)
+ .finish();
+ tracing::subscriber::set_default(subscriber)
+}
+
+pin_project_lite::pin_project! {
+ #[derive(Clone, Debug)]
+ pub struct IntoStream<S> {
+ #[pin]
+ inner: S
+ }
+}
+
+impl<S> IntoStream<S> {
+ pub fn new(inner: S) -> Self {
+ Self { inner }
+ }
+}
+
+impl<I> Stream for IntoStream<mpsc::Receiver<I>> {
+ type Item = I;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_recv(cx)
+ }
+}
+
+impl<I> Stream for IntoStream<mpsc::UnboundedReceiver<I>> {
+ type Item = I;
+
+ fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
+ self.project().inner.poll_recv(cx)
+ }
+}
+
+#[derive(Clone, Debug)]
+pub struct AssertSpanSvc {
+ span: tracing::Span,
+ polled: bool,
+}
+
+pub struct AssertSpanError(String);
+
+impl fmt::Debug for AssertSpanError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&self.0, f)
+ }
+}
+
+impl fmt::Display for AssertSpanError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&self.0, f)
+ }
+}
+
+impl std::error::Error for AssertSpanError {}
+
+impl AssertSpanSvc {
+ pub fn new(span: tracing::Span) -> Self {
+ Self {
+ span,
+ polled: false,
+ }
+ }
+
+ fn check(&self, func: &str) -> Result<(), AssertSpanError> {
+ let current_span = tracing::Span::current();
+ tracing::debug!(?current_span, ?self.span, %func);
+ if current_span == self.span {
+ return Ok(());
+ }
+
+ Err(AssertSpanError(format!(
+ "{} called outside expected span\n expected: {:?}\n current: {:?}",
+ func, self.span, current_span
+ )))
+ }
+}
+
+impl Service<()> for AssertSpanSvc {
+ type Response = ();
+ type Error = AssertSpanError;
+ type Future = future::Ready<Result<Self::Response, Self::Error>>;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if self.polled {
+ return Poll::Ready(self.check("poll_ready"));
+ }
+
+ cx.waker().wake_by_ref();
+ self.polled = true;
+ Poll::Pending
+ }
+
+ fn call(&mut self, _: ()) -> Self::Future {
+ future::ready(self.check("call"))
+ }
+}
diff --git a/crates/tower/tests/util/call_all.rs b/crates/tower/tests/util/call_all.rs
new file mode 100644
index 0000000..02e69ef
--- /dev/null
+++ b/crates/tower/tests/util/call_all.rs
@@ -0,0 +1,166 @@
+use super::support;
+use futures_core::Stream;
+use futures_util::{
+ future::{ready, Ready},
+ pin_mut,
+};
+use std::task::{Context, Poll};
+use std::{cell::Cell, rc::Rc};
+use tokio_test::{assert_pending, assert_ready, task};
+use tower::util::ServiceExt;
+use tower_service::*;
+use tower_test::{assert_request_eq, mock};
+
+type Error = Box<dyn std::error::Error + Send + Sync>;
+
+#[derive(Debug, Eq, PartialEq)]
+struct Srv {
+ admit: Rc<Cell<bool>>,
+ count: Rc<Cell<usize>>,
+}
+impl Service<&'static str> for Srv {
+ type Response = &'static str;
+ type Error = Error;
+ type Future = Ready<Result<Self::Response, Error>>;
+
+ fn poll_ready(&mut self, _: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
+ if !self.admit.get() {
+ return Poll::Pending;
+ }
+
+ self.admit.set(false);
+ Poll::Ready(Ok(()))
+ }
+
+ fn call(&mut self, req: &'static str) -> Self::Future {
+ self.count.set(self.count.get() + 1);
+ ready(Ok(req))
+ }
+}
+
+#[test]
+fn ordered() {
+ let _t = support::trace_init();
+
+ let mut mock = task::spawn(());
+
+ let admit = Rc::new(Cell::new(false));
+ let count = Rc::new(Cell::new(0));
+ let srv = Srv {
+ count: count.clone(),
+ admit: admit.clone(),
+ };
+ let (tx, rx) = tokio::sync::mpsc::unbounded_channel();
+ let ca = srv.call_all(support::IntoStream::new(rx));
+ pin_mut!(ca);
+
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ tx.send("one").unwrap();
+ mock.is_woken();
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ admit.set(true);
+ let v = assert_ready!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("one"));
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ admit.set(true);
+ tx.send("two").unwrap();
+ mock.is_woken();
+ tx.send("three").unwrap();
+ let v = assert_ready!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("two"));
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ admit.set(true);
+ let v = assert_ready!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("three"));
+ admit.set(true);
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ admit.set(true);
+ tx.send("four").unwrap();
+ mock.is_woken();
+ let v = assert_ready!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("four"));
+ assert_pending!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)));
+
+ // need to be ready since impl doesn't know it'll get EOF
+ admit.set(true);
+
+ // When we drop the request stream, CallAll should return None.
+ drop(tx);
+ mock.is_woken();
+ let v = assert_ready!(mock.enter(|cx, _| ca.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert!(v.is_none());
+ assert_eq!(count.get(), 4);
+
+ // We should also be able to recover the wrapped Service.
+ assert_eq!(ca.take_service(), Srv { count, admit });
+}
+
+#[tokio::test(flavor = "current_thread")]
+async fn unordered() {
+ let _t = support::trace_init();
+
+ let (mock, handle) = mock::pair::<_, &'static str>();
+ pin_mut!(handle);
+
+ let mut task = task::spawn(());
+ let requests = futures_util::stream::iter(&["one", "two"]);
+
+ let svc = mock.call_all(requests).unordered();
+ pin_mut!(svc);
+
+ assert_pending!(task.enter(|cx, _| svc.as_mut().poll_next(cx)));
+
+ let resp1 = assert_request_eq!(handle, &"one");
+ let resp2 = assert_request_eq!(handle, &"two");
+
+ resp2.send_response("resp 1");
+
+ let v = assert_ready!(task.enter(|cx, _| svc.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("resp 1"));
+ assert_pending!(task.enter(|cx, _| svc.as_mut().poll_next(cx)));
+
+ resp1.send_response("resp 2");
+
+ let v = assert_ready!(task.enter(|cx, _| svc.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert_eq!(v, Some("resp 2"));
+
+ let v = assert_ready!(task.enter(|cx, _| svc.as_mut().poll_next(cx)))
+ .transpose()
+ .unwrap();
+ assert!(v.is_none());
+}
+
+#[tokio::test]
+async fn pending() {
+ let _t = support::trace_init();
+
+ let (mock, mut handle) = mock::pair::<_, &'static str>();
+
+ let mut task = task::spawn(());
+
+ let (tx, rx) = tokio::sync::mpsc::unbounded_channel();
+ let ca = mock.call_all(support::IntoStream::new(rx));
+ pin_mut!(ca);
+
+ assert_pending!(task.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ tx.send("req").unwrap();
+ assert_pending!(task.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ assert_request_eq!(handle, "req").send_response("res");
+ let res = assert_ready!(task.enter(|cx, _| ca.as_mut().poll_next(cx)));
+ assert_eq!(res.transpose().unwrap(), Some("res"));
+ assert_pending!(task.enter(|cx, _| ca.as_mut().poll_next(cx)));
+}
diff --git a/crates/tower/tests/util/main.rs b/crates/tower/tests/util/main.rs
new file mode 100644
index 0000000..18b7813
--- /dev/null
+++ b/crates/tower/tests/util/main.rs
@@ -0,0 +1,8 @@
+#![cfg(feature = "util")]
+#![allow(clippy::type_complexity)]
+
+mod call_all;
+mod oneshot;
+mod service_fn;
+#[path = "../support.rs"]
+pub(crate) mod support;
diff --git a/crates/tower/tests/util/oneshot.rs b/crates/tower/tests/util/oneshot.rs
new file mode 100644
index 0000000..54120e7
--- /dev/null
+++ b/crates/tower/tests/util/oneshot.rs
@@ -0,0 +1,40 @@
+use std::task::{Context, Poll};
+use std::{future::Future, pin::Pin};
+use tower::util::ServiceExt;
+use tower_service::Service;
+
+#[tokio::test(flavor = "current_thread")]
+async fn service_driven_to_readiness() {
+ // This test ensures that `oneshot` will repeatedly call `poll_ready` until
+ // the service is ready.
+ let _t = super::support::trace_init();
+
+ struct PollMeTwice {
+ ready: bool,
+ }
+ impl Service<()> for PollMeTwice {
+ type Error = ();
+ type Response = ();
+ type Future = Pin<
+ Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send + Sync + 'static>,
+ >;
+
+ fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), ()>> {
+ if self.ready {
+ Poll::Ready(Ok(()))
+ } else {
+ self.ready = true;
+ cx.waker().wake_by_ref();
+ Poll::Pending
+ }
+ }
+
+ fn call(&mut self, _: ()) -> Self::Future {
+ assert!(self.ready, "service not driven to readiness!");
+ Box::pin(async { Ok(()) })
+ }
+ }
+
+ let svc = PollMeTwice { ready: false };
+ svc.oneshot(()).await.unwrap();
+}
diff --git a/crates/tower/tests/util/service_fn.rs b/crates/tower/tests/util/service_fn.rs
new file mode 100644
index 0000000..ac6bf06
--- /dev/null
+++ b/crates/tower/tests/util/service_fn.rs
@@ -0,0 +1,12 @@
+use futures_util::future::ready;
+use tower::util::service_fn;
+use tower_service::Service;
+
+#[tokio::test(flavor = "current_thread")]
+async fn simple() {
+ let _t = super::support::trace_init();
+
+ let mut add_one = service_fn(|req| ready(Ok::<_, ()>(req + 1)));
+ let answer = add_one.call(1).await.unwrap();
+ assert_eq!(answer, 2);
+}
diff --git a/crates/tracing-attributes/.cargo-checksum.json b/crates/tracing-attributes/.cargo-checksum.json
new file mode 100644
index 0000000..cc2b53e
--- /dev/null
+++ b/crates/tracing-attributes/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"e410a2cbd565bff62c52c66580bd3c7aa9bd81e4b73b5f4cdd0f7c5ab13b21de","Cargo.toml":"2cb782a6b7cb5412591a8457af156d081514ae846a81bec889a9f60f68a39dca","LICENSE":"898b1ae9821e98daf8964c8d6c7f61641f5f5aa78ad500020771c0939ee0dea1","README.md":"d878157a8f65779ef3d2e53d6772f99b5b79d7addccb6d04a2eb681ce1de99e1","src/attr.rs":"d0224a2a9be76743f039c86c1935622ca0b5b2e618b9323149855bf0e326fe48","src/expand.rs":"548b8d5fb5e92fe57a067bb656b88ceb403234521eed8bce4e0ec91b5fdacf78","src/lib.rs":"de2409d2cefba7a21739ac1021ea8e0dec892a342b1ecb46a81f66b782ea8f5b","tests/async_fn.rs":"66dab5e2a58119f588daae74efa47b5d8db0751cb99660856d792f352a3a263e","tests/destructuring.rs":"d920dca0b7db5b48697c1eb5a40ce676956760eb8bc2dcbe4c5ce1bc3631877b","tests/err.rs":"6b717be09a2447bcb0583a9b6a42b53361935b4a61093572c55f506f9d5f5cff","tests/fields.rs":"8babe90df46cfe9018caf20ef85060c90d611c5531b4d603f10f83a38744e7c2","tests/follows_from.rs":"d0478db45cb838d76f0d52f930847e8540b09456e2cd56591e56910c5e9985c6","tests/instrument.rs":"0c47bd9117858ecc585faab597115b7b49e2c79ae20172c32a6184674c8fd274","tests/levels.rs":"20483e9c7555991044b748f209def016d28da0a64eb9f85fabb489b0fb75a440","tests/names.rs":"2a67b33681cc7689c4d677de7a97b846df1817406a56a98ba91bf67b9f7d630a","tests/parents.rs":"95451328d8d7dba9020dc3eeb4ee56fc7f4591d5d38e793b815e621e73063da1","tests/ret.rs":"4628f562f8b0fb36a0dc13f488d70df8a545bd9b49422dfbf05fd2cab3870fc3","tests/targets.rs":"2065af7ff491be720c56d1b218b095a64e4573bf2586e49ce638c5ed4d639811","tests/ui.rs":"60ed69aba2cbf4b1a2f42b78703f7f21d8a69f62e39bb0509f6a2224cad9b9de","tests/ui/async_instrument.rs":"00fcde05841e8f9f6cc6f9434f8cc4baed5cf6e3ca73e8faddccbdace14e9485","tests/ui/async_instrument.stderr":"1d650a0914f0f59beeb88946a8ad6991feffe885016462ba917ea8e09792f866","tests/ui/const_instrument.rs":"253160848b023cbf73c3d1dece4969ff892ae9a3149e771159230733fa1cab1b","tests/ui/const_instrument.stderr":"86527fbc2410ceba8f051771fdb4bf71eb853e086a4e4d17353089c65b918c18"},"package":"34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7"}
\ No newline at end of file
diff --git a/crates/tracing-attributes/Android.bp b/crates/tracing-attributes/Android.bp
new file mode 100644
index 0000000..f10c572
--- /dev/null
+++ b/crates/tracing-attributes/Android.bp
@@ -0,0 +1,30 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tracing-attributes_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tracing-attributes_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_proc_macro {
+ name: "libtracing_attributes",
+ crate_name: "tracing_attributes",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.27",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ rustlibs: [
+ "libproc_macro2",
+ "libquote",
+ "libsyn",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tracing-attributes/CHANGELOG.md b/crates/tracing-attributes/CHANGELOG.md
new file mode 100644
index 0000000..3cb95f7
--- /dev/null
+++ b/crates/tracing-attributes/CHANGELOG.md
@@ -0,0 +1,420 @@
+# 0.1.27 (October 13, 2023)
+
+### Changed
+
+- Bump minimum version of proc-macro2 to 1.0.60 ([#2732])
+- Generate less dead code for async block return type hint ([#2709])
+
+### Fixed
+
+- Fix a compilation error in `#[instrument]` when the `"log"` feature is enabled ([#2599])
+
+[#2732]: https://github.com/tokio-rs/tracing/pull/2732
+[#2709]: https://github.com/tokio-rs/tracing/pull/2709
+[#2599]: https://github.com/tokio-rs/tracing/pull/2599
+
+# 0.1.26 (June 21th, 2023)
+
+This release of `tracing-attributes` fixes warnings due to `allow` attributes in
+generated code that allow lints which may not exist on earlier versions of rustc.
+
+### Fixed
+
+- Allow `unknown_lints` in macro-generated code ([#2626])
+
+Thanks to @mladedav for contributing to this release!
+
+# 0.1.25 (June 19th, 2023)
+
+This release of `tracing-attributes` fixes the Clippy lint
+[`let_with_type_underscore`] in code generated by the `#[instrument]`
+attribute in Rust 1.70+.
+
+### Fixed
+
+- Allow [`clippy::let_with_type_underscore`] in macro-generated code ([#2609])
+
+Thanks to @coolreader19 for contributing to this release!
+
+[#2609]: https://github.com/tokio-rs/tracing/pull/2609
+
+[`let_with_type_underscore`]: http://rust-lang.github.io/rust-clippy/rust-1.70.0/index.html#let_with_type_underscore
+
+# 0.1.24 (April 24th, 2023)
+
+This release of `tracing-attributes` adds support for passing an optional
+`level` to the `err` and `ret` arguments to `#[instrument]`, allowing the level
+of the generated return-value event to be overridden. For example,
+
+```rust
+#[instrument(err(level = "info"))]
+fn my_great_function() -> Result<(), &'static str> {
+ // ...
+}
+```
+
+will emit an `INFO`-level event if the function returns an `Err`.
+
+In addition, this release updates the [`syn`] dependency to v2.x.x.
+
+### Added
+
+- `level` argument to `err` and `ret` to override the level of the generated
+ return value event ([#2335])
+- Improved compiler error message when `#[instrument]` is added to a `const fn`
+ ([#2418])
+
+### Changed
+
+- Updated `syn` dependency to 2.0 ([#2516])
+
+### Fixed
+
+- Fix `clippy::unreachable` warnings in `#[instrument]`-generated code ([#2356])
+- Removed unused "visit" feature flag from `syn` dependency ([#2530])
+
+### Documented
+
+- Documented default level for `err` ([#2433])
+- Improved documentation for levels in `#[instrument]` ([#2350])
+
+Thanks to @nitnelave, @jsgf, @Abhicodes-crypto, @LukeMathWalker, @andrewpollack,
+@quad, @klensy, @davidpdrsn, and @dbidwell94 for contributign to this release!
+
+[`syn`]: https://crates.io/crates/syn
+[#2335]: https://github.com/tokio-rs/tracing/pull/2335
+[#2418]: https://github.com/tokio-rs/tracing/pull/2418
+[#2516]: https://github.com/tokio-rs/tracing/pull/2516
+[#2356]: https://github.com/tokio-rs/tracing/pull/2356
+[#2530]: https://github.com/tokio-rs/tracing/pull/2530
+[#2433]: https://github.com/tokio-rs/tracing/pull/2433
+[#2350]: https://github.com/tokio-rs/tracing/pull/2350
+
+# 0.1.23 (October 6, 2022)
+
+This release of `tracing-attributes` fixes a bug where compiler diagnostic spans
+for type errors in `#[instrument]`ed `async fn`s have the location of the
+`#[instrument]` attribute rather than the location of the actual error, and a
+bug where inner attributes in `#[instrument]`ed functions would cause a compiler
+error.
+
+### Fixed
+
+- Fix incorrect handling of inner attributes in `#[instrument]`ed functions ([#2307])
+- Add fake return to improve spans generated for type errors in `async fn`s ([#2270])
+- Updated `syn` dependency to fix compilation with `-Z minimal-versions`
+ ([#2246])
+
+Thanks to new contributors @compiler-errors and @e-nomem, as well as @CAD97, for
+contributing to this release!
+
+[#2307]: https://github.com/tokio-rs/tracing/pull/2307
+[#2270]: https://github.com/tokio-rs/tracing/pull/2270
+[#2246]: https://github.com/tokio-rs/tracing/pull/2246
+
+# 0.1.22 (July 1, 2022)
+
+This release fixes an issue where using the `err` or `ret` arguments to
+`#[instrument]` along with an overridden target, such as
+
+```rust
+#[instrument(target = "...", err, ret)]
+```
+
+would not propagate the overridden target to the events generated for
+errors/return values.
+
+### Fixed
+
+- Error and return value events generated by `#[instrument(err)]` or
+ `#[instrument(ret)]` not inheriting an overridden target ([#2184])
+- Incorrect default level in documentation ([#2119])
+
+Thanks to new contributor @tbraun96 for contributing to this release!
+
+[#2184]: https://github.com/tokio-rs/tracing/pull/2184
+[#2119]: https://github.com/tokio-rs/tracing/pull/2119
+
+# 0.1.21 (April 26, 2022)
+
+This release adds support for setting explicit parent and follows-from spans
+in the `#[instrument]` attribute.
+
+### Added
+
+- `#[instrument(follows_from = ...)]` argument for setting one or more
+ follows-from span ([#2093])
+- `#[instrument(parent = ...)]` argument for overriding the generated span's
+ parent ([#2091])
+
+### Fixed
+
+- Extra braces around `async` blocks in expanded code (causes a Clippy warning)
+ ([#2090])
+- Broken documentation links ([#2068], [#2077])
+
+Thanks to @jarrodldavis, @ben0x539, and new contributor @jswrenn for
+contributing to this release!
+
+
+[#2093]: https://github.com/tokio-rs/tracing/pull/2093
+[#2091]: https://github.com/tokio-rs/tracing/pull/2091
+[#2090]: https://github.com/tokio-rs/tracing/pull/2090
+[#2077]: https://github.com/tokio-rs/tracing/pull/2077
+[#2068]: https://github.com/tokio-rs/tracing/pull/2068
+
+# 0.1.20 (March 8, 2022)
+
+### Fixed
+
+- Compilation failure with `--minimal-versions` due to a too-permissive `syn`
+ dependency ([#1960])
+
+### Changed
+
+- Bumped minimum supported Rust version (MSRV) to 1.49.0 ([#1913])
+
+Thanks to new contributor @udoprog for contributing to this release!
+
+[#1960]: https://github.com/tokio-rs/tracing/pull/1960
+[#1913]: https://github.com/tokio-rs/tracing/pull/1913
+
+# 0.1.19 (February 3, 2022)
+
+This release introduces a new `#[instrument(ret)]` argument to emit an event
+with the return value of an instrumented function.
+
+### Added
+
+- `#[instrument(ret)]` to record the return value of a function ([#1716])
+- added `err(Debug)` argument to cause `#[instrument(err)]` to record errors
+ with `Debug` rather than `Display ([#1631])
+
+### Fixed
+
+- incorrect code generation for functions returning async blocks ([#1866])
+- incorrect diagnostics when using `rust-analyzer` ([#1634])
+
+Thanks to @Swatinem, @hkmatsumoto, @cynecx, and @ciuncan for contributing to
+this release!
+
+[#1716]: https://github.com/tokio-rs/tracing/pull/1716
+[#1631]: https://github.com/tokio-rs/tracing/pull/1631
+[#1634]: https://github.com/tokio-rs/tracing/pull/1634
+[#1866]: https://github.com/tokio-rs/tracing/pull/1866
+
+# 0.1.18 (October 5, 2021)
+
+This release fixes issues introduced in v0.1.17.
+
+### Fixed
+
+- fixed mismatched types compiler error that may occur when using
+ `#[instrument]` on an `async fn` that returns an `impl Trait` value that
+ includes a closure ([#1616])
+- fixed false positives for `clippy::suspicious_else_formatting` warnings due to
+ rust-lang/rust-clippy#7760 and rust-lang/rust-clippy#6249 ([#1617])
+- fixed `clippy::let_unit_value` lints when using `#[instrument]` ([#1614])
+
+[#1617]: https://github.com/tokio-rs/tracing/pull/1617
+[#1616]: https://github.com/tokio-rs/tracing/pull/1616
+[#1614]: https://github.com/tokio-rs/tracing/pull/1614
+
+# 0.1.17 (YANKED) (October 1, 2021)
+
+This release significantly improves performance when `#[instrument]`-generated
+spans are below the maximum enabled level.
+
+### Added
+
+- improve performance when skipping `#[instrument]`-generated spans below the
+ max level ([#1600], [#1605])
+
+Thanks to @oli-obk for contributing to this release!
+
+[#1600]: https://github.com/tokio-rs/tracing/pull/1600
+[#1605]: https://github.com/tokio-rs/tracing/pull/1605
+
+# 0.1.16 (September 13, 2021)
+
+This release adds a new `#[instrument(skip_all)]` option to skip recording *all*
+arguments to an instrumented function as fields. Additionally, it adds support
+for recording arguments that are `tracing` primitive types as typed values,
+rather than as `fmt::Debug`.
+
+### Added
+
+- add `skip_all` option to `#[instrument]` ([#1548])
+- record primitive types as primitive values rather than as `fmt::Debug`
+ ([#1378])
+- added support for `f64`s as typed values ([#1522])
+
+Thanks to @Folyd and @jsgf for contributing to this release!
+
+[#1548]: https://github.com/tokio-rs/tracing/pull/1548
+[#1378]: https://github.com/tokio-rs/tracing/pull/1378
+[#1522]: https://github.com/tokio-rs/tracing/pull/1524
+
+# 0.1.15 (March 12, 2021)
+
+### Fixed
+
+- `#[instrument]` on functions returning `Box::pin`ned futures incorrectly
+ skipping function bodies prior to returning a future ([#1297])
+
+Thanks to @nightmared for contributing to this release!
+
+[#1297]: https://github.com/tokio-rs/tracing/pull/1297
+
+# 0.1.14 (March 10, 2021)
+
+### Fixed
+
+- Compatibility between `#[instrument]` and `async-trait` v0.1.43 and newer
+ ([#1228])
+
+Thanks to @nightmared for lots of hard work on this fix!
+
+[#1228]: https://github.com/tokio-rs/tracing/pull/1228
+
+# 0.1.13 (February 17, 2021)
+
+### Fixed
+
+- Compiler error when using `#[instrument(err)]` on functions which return `impl
+ Trait` ([#1236])
+
+[#1236]: https://github.com/tokio-rs/tracing/pull/1236
+
+# 0.1.12 (February 4, 2021)
+
+### Fixed
+
+- Compiler error when using `#[instrument(err)]` on functions with mutable
+ parameters ([#1167])
+- Missing function visibility modifier when using `#[instrument]` with
+ `async-trait` ([#977])
+- Multiple documentation fixes and improvements ([#965], [#981], [#1215])
+
+### Changed
+
+- `tracing-futures` dependency is no longer required when using `#[instrument]`
+ on async functions ([#808])
+
+Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to this
+release!
+
+[#1167]: https://github.com/tokio-rs/tracing/pull/1167
+[#977]: https://github.com/tokio-rs/tracing/pull/977
+[#965]: https://github.com/tokio-rs/tracing/pull/965
+[#981]: https://github.com/tokio-rs/tracing/pull/981
+[#1215]: https://github.com/tokio-rs/tracing/pull/1215
+[#808]: https://github.com/tokio-rs/tracing/pull/808
+
+# 0.1.11 (August 18, 2020)
+
+### Fixed
+
+- Corrected wrong minimum supported Rust version note in docs (#941)
+- Removed unused `syn` features (#928)
+
+Thanks to new contributor @jhpratt for contributing to this release!
+
+# 0.1.10 (August 10, 2020)
+
+### Added
+
+- Support for using `self` in field expressions when instrumenting `async-trait`
+ functions (#875)
+- Several documentation improvements (#832, #897, #911, #913)
+
+Thanks to @anton-dutov and @nightmared for contributing to this release!
+
+# 0.1.9 (July 8, 2020)
+
+### Added
+
+- Support for arbitrary expressions as fields in `#[instrument]` (#672)
+
+### Changed
+
+- `#[instrument]` now emits a compiler warning when ignoring unrecognized
+ input (#672, #786)
+
+# 0.1.8 (May 13, 2020)
+
+### Added
+
+- Support for using `#[instrument]` on methods that are part of [`async-trait`]
+ trait implementations (#711)
+- Optional `#[instrument(err)]` argument to automatically emit an event if an
+ instrumented function returns `Err` (#637)
+
+Thanks to @ilana and @nightmared for contributing to this release!
+
+[`async-trait`]: https://crates.io/crates/async-trait
+
+# 0.1.7 (February 26, 2020)
+
+### Added
+
+- Support for adding arbitrary literal fields to spans generated by
+ `#[instrument]` (#569)
+- `#[instrument]` now emits a helpful compiler error when attempting to skip a
+ function parameter (#600)
+
+Thanks to @Kobzol for contributing to this release!
+
+# 0.1.6 (December 20, 2019)
+
+### Added
+
+- Updated documentation (#468)
+
+# 0.1.5 (October 22, 2019)
+
+### Added
+
+- Support for destructuring in arguments to `#[instrument]`ed functions (#397)
+- Generated field for `self` parameters when `#[instrument]`ing methods (#397)
+
+# 0.1.4 (September 26, 2019)
+
+### Added
+
+- Optional `skip` argument to `#[instrument]` for excluding function parameters
+ from generated spans (#359)
+
+# 0.1.3 (September 12, 2019)
+
+### Fixed
+
+- Fixed `#[instrument]`ed async functions not compiling on `nightly-2019-09-11`
+ or newer (#342)
+
+# 0.1.2 (August 19, 2019)
+
+### Changed
+
+- Updated `syn` and `quote` dependencies to 1.0 (#292)
+- Removed direct dependency on `proc-macro2` to avoid potential version
+ conflicts (#296)
+
+### Fixed
+
+- Outdated idioms in examples (#271, #273)
+
+# 0.1.1 (August 9, 2019)
+
+### Changed
+
+- Using the `#[instrument]` attribute on `async fn`s no longer requires a
+ feature flag (#258)
+
+### Fixed
+
+- The `#[instrument]` macro now works on generic functions (#262)
+
+# 0.1.0 (August 8, 2019)
+
+- Initial release
diff --git a/crates/tracing-attributes/Cargo.toml b/crates/tracing-attributes/Cargo.toml
new file mode 100644
index 0000000..8d90671
--- /dev/null
+++ b/crates/tracing-attributes/Cargo.toml
@@ -0,0 +1,87 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.56.0"
+name = "tracing-attributes"
+version = "0.1.27"
+authors = [
+ "Tokio Contributors <[email protected]>",
+ "Eliza Weisman <[email protected]>",
+ "David Barsky <[email protected]>",
+]
+description = """
+Procedural macro attributes for automatically instrumenting functions.
+"""
+homepage = "https://tokio.rs"
+readme = "README.md"
+keywords = [
+ "logging",
+ "tracing",
+ "macro",
+ "instrument",
+ "log",
+]
+categories = [
+ "development-tools::debugging",
+ "development-tools::profiling",
+ "asynchronous",
+]
+license = "MIT"
+repository = "https://github.com/tokio-rs/tracing"
+
+[lib]
+proc-macro = true
+
+[dependencies.proc-macro2]
+version = "1.0.60"
+
+[dependencies.quote]
+version = "1.0.20"
+
+[dependencies.syn]
+version = "2.0"
+features = [
+ "full",
+ "parsing",
+ "printing",
+ "visit-mut",
+ "clone-impls",
+ "extra-traits",
+ "proc-macro",
+]
+default-features = false
+
+[dev-dependencies.async-trait]
+version = "0.1.67"
+
+[dev-dependencies.rustversion]
+version = "1.0.9"
+
+[dev-dependencies.tokio-test]
+version = "0.4.2"
+
+[dev-dependencies.tracing]
+version = "0.1.35"
+
+[dev-dependencies.tracing-subscriber]
+version = "0.3.0"
+features = ["env-filter"]
+
+[dev-dependencies.trybuild]
+version = "1.0.64"
+
+[features]
+async-await = []
+
+[badges.maintenance]
+status = "experimental"
diff --git a/crates/tracing-attributes/LICENSE b/crates/tracing-attributes/LICENSE
new file mode 100644
index 0000000..cdb28b4
--- /dev/null
+++ b/crates/tracing-attributes/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tokio Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tracing-attributes/METADATA b/crates/tracing-attributes/METADATA
new file mode 100644
index 0000000..e49db78
--- /dev/null
+++ b/crates/tracing-attributes/METADATA
@@ -0,0 +1,23 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/tracing-attributes
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tracing-attributes"
+description: "Macro attributes for application-level tracing."
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/tracing-attributes"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/tracing-attributes/tracing-attributes-0.1.27.crate"
+ }
+ version: "0.1.27"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 11
+ day: 17
+ }
+}
diff --git a/crates/tracing-attributes/MODULE_LICENSE_MIT b/crates/tracing-attributes/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tracing-attributes/MODULE_LICENSE_MIT
diff --git a/crates/tracing-attributes/README.md b/crates/tracing-attributes/README.md
new file mode 100644
index 0000000..f14dbb6
--- /dev/null
+++ b/crates/tracing-attributes/README.md
@@ -0,0 +1,91 @@
+![Tracing — Structured, application-level diagnostics][splash]
+
+[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg
+
+# tracing-attributes
+
+Macro attributes for application-level tracing.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[Documentation][docs-url] | [Chat][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tracing-attributes.svg
+[crates-url]: https://crates.io/crates/tracing-attributes
+[docs-badge]: https://docs.rs/tracing-attributes/badge.svg
+[docs-url]: https://docs.rs/tracing-attributes/0.1.26
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tracing-rs.netlify.com/tracing_attributes
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
+[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+
+## Overview
+
+[`tracing`] is a framework for instrumenting Rust programs to collect
+structured, event-based diagnostic information. This crate provides the
+`#[instrument]` attribute for automatically instrumenting functions using
+`tracing`.
+
+Note that this macro is also re-exported by the main `tracing` crate.
+
+*Compiler support: [requires `rustc` 1.56+][msrv]*
+
+[msrv]: #supported-rust-versions
+
+## Usage
+
+First, add this to your `Cargo.toml`:
+
+```toml
+[dependencies]
+tracing-attributes = "0.1.26"
+```
+
+
+This crate provides the `#[instrument]` attribute for instrumenting a function
+with a `tracing` [span]. For example:
+
+```rust
+use tracing_attributes::instrument;
+
+#[instrument]
+pub fn my_function(my_arg: usize) {
+ // ...
+}
+```
+
+[`tracing`]: https://crates.io/crates/tracing
+[span]: https://docs.rs/tracing/latest/tracing/span/index.html
+
+## Supported Rust Versions
+
+Tracing is built against the latest stable release. The minimum supported
+version is 1.56. The current Tracing version is not guaranteed to build on Rust
+versions earlier than the minimum supported version.
+
+Tracing follows the same compiler support policies as the rest of the Tokio
+project. The current stable Rust compiler and the three most recent minor
+versions before it will always be supported. For example, if the current stable
+compiler version is 1.69, the minimum supported version will not be increased
+past 1.66, three minor versions prior. Increasing the minimum supported compiler
+version is not considered a semver breaking change as long as doing so complies
+with this policy.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tokio by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tracing-attributes/cargo_embargo.json b/crates/tracing-attributes/cargo_embargo.json
new file mode 100644
index 0000000..cb908d7
--- /dev/null
+++ b/crates/tracing-attributes/cargo_embargo.json
@@ -0,0 +1,3 @@
+{
+ "run_cargo": false
+}
diff --git a/crates/tracing-attributes/src/attr.rs b/crates/tracing-attributes/src/attr.rs
new file mode 100644
index 0000000..f5ad409
--- /dev/null
+++ b/crates/tracing-attributes/src/attr.rs
@@ -0,0 +1,457 @@
+use std::collections::HashSet;
+use syn::{punctuated::Punctuated, Expr, Ident, LitInt, LitStr, Path, Token};
+
+use proc_macro2::TokenStream;
+use quote::{quote, quote_spanned, ToTokens};
+use syn::ext::IdentExt as _;
+use syn::parse::{Parse, ParseStream};
+
+/// Arguments to `#[instrument(err(...))]` and `#[instrument(ret(...))]` which describe how the
+/// return value event should be emitted.
+#[derive(Clone, Default, Debug)]
+pub(crate) struct EventArgs {
+ level: Option<Level>,
+ pub(crate) mode: FormatMode,
+}
+
+#[derive(Clone, Default, Debug)]
+pub(crate) struct InstrumentArgs {
+ level: Option<Level>,
+ pub(crate) name: Option<LitStr>,
+ target: Option<LitStr>,
+ pub(crate) parent: Option<Expr>,
+ pub(crate) follows_from: Option<Expr>,
+ pub(crate) skips: HashSet<Ident>,
+ pub(crate) skip_all: bool,
+ pub(crate) fields: Option<Fields>,
+ pub(crate) err_args: Option<EventArgs>,
+ pub(crate) ret_args: Option<EventArgs>,
+ /// Errors describing any unrecognized parse inputs that we skipped.
+ parse_warnings: Vec<syn::Error>,
+}
+
+impl InstrumentArgs {
+ pub(crate) fn level(&self) -> Level {
+ self.level.clone().unwrap_or(Level::Info)
+ }
+
+ pub(crate) fn target(&self) -> impl ToTokens {
+ if let Some(ref target) = self.target {
+ quote!(#target)
+ } else {
+ quote!(module_path!())
+ }
+ }
+
+ /// Generate "deprecation" warnings for any unrecognized attribute inputs
+ /// that we skipped.
+ ///
+ /// For backwards compatibility, we need to emit compiler warnings rather
+ /// than errors for unrecognized inputs. Generating a fake deprecation is
+ /// the only way to do this on stable Rust right now.
+ pub(crate) fn warnings(&self) -> impl ToTokens {
+ let warnings = self.parse_warnings.iter().map(|err| {
+ let msg = format!("found unrecognized input, {}", err);
+ let msg = LitStr::new(&msg, err.span());
+ // TODO(eliza): This is a bit of a hack, but it's just about the
+ // only way to emit warnings from a proc macro on stable Rust.
+ // Eventually, when the `proc_macro::Diagnostic` API stabilizes, we
+ // should definitely use that instead.
+ quote_spanned! {err.span()=>
+ #[warn(deprecated)]
+ {
+ #[deprecated(since = "not actually deprecated", note = #msg)]
+ const TRACING_INSTRUMENT_WARNING: () = ();
+ let _ = TRACING_INSTRUMENT_WARNING;
+ }
+ }
+ });
+ quote! {
+ { #(#warnings)* }
+ }
+ }
+}
+
+impl Parse for InstrumentArgs {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let mut args = Self::default();
+ while !input.is_empty() {
+ let lookahead = input.lookahead1();
+ if lookahead.peek(kw::name) {
+ if args.name.is_some() {
+ return Err(input.error("expected only a single `name` argument"));
+ }
+ let name = input.parse::<StrArg<kw::name>>()?.value;
+ args.name = Some(name);
+ } else if lookahead.peek(LitStr) {
+ // XXX: apparently we support names as either named args with an
+ // sign, _or_ as unnamed string literals. That's weird, but
+ // changing it is apparently breaking.
+ if args.name.is_some() {
+ return Err(input.error("expected only a single `name` argument"));
+ }
+ args.name = Some(input.parse()?);
+ } else if lookahead.peek(kw::target) {
+ if args.target.is_some() {
+ return Err(input.error("expected only a single `target` argument"));
+ }
+ let target = input.parse::<StrArg<kw::target>>()?.value;
+ args.target = Some(target);
+ } else if lookahead.peek(kw::parent) {
+ if args.target.is_some() {
+ return Err(input.error("expected only a single `parent` argument"));
+ }
+ let parent = input.parse::<ExprArg<kw::parent>>()?;
+ args.parent = Some(parent.value);
+ } else if lookahead.peek(kw::follows_from) {
+ if args.target.is_some() {
+ return Err(input.error("expected only a single `follows_from` argument"));
+ }
+ let follows_from = input.parse::<ExprArg<kw::follows_from>>()?;
+ args.follows_from = Some(follows_from.value);
+ } else if lookahead.peek(kw::level) {
+ if args.level.is_some() {
+ return Err(input.error("expected only a single `level` argument"));
+ }
+ args.level = Some(input.parse()?);
+ } else if lookahead.peek(kw::skip) {
+ if !args.skips.is_empty() {
+ return Err(input.error("expected only a single `skip` argument"));
+ }
+ if args.skip_all {
+ return Err(input.error("expected either `skip` or `skip_all` argument"));
+ }
+ let Skips(skips) = input.parse()?;
+ args.skips = skips;
+ } else if lookahead.peek(kw::skip_all) {
+ if args.skip_all {
+ return Err(input.error("expected only a single `skip_all` argument"));
+ }
+ if !args.skips.is_empty() {
+ return Err(input.error("expected either `skip` or `skip_all` argument"));
+ }
+ let _ = input.parse::<kw::skip_all>()?;
+ args.skip_all = true;
+ } else if lookahead.peek(kw::fields) {
+ if args.fields.is_some() {
+ return Err(input.error("expected only a single `fields` argument"));
+ }
+ args.fields = Some(input.parse()?);
+ } else if lookahead.peek(kw::err) {
+ let _ = input.parse::<kw::err>();
+ let err_args = EventArgs::parse(input)?;
+ args.err_args = Some(err_args);
+ } else if lookahead.peek(kw::ret) {
+ let _ = input.parse::<kw::ret>()?;
+ let ret_args = EventArgs::parse(input)?;
+ args.ret_args = Some(ret_args);
+ } else if lookahead.peek(Token![,]) {
+ let _ = input.parse::<Token![,]>()?;
+ } else {
+ // We found a token that we didn't expect!
+ // We want to emit warnings for these, rather than errors, so
+ // we'll add it to the list of unrecognized inputs we've seen so
+ // far and keep going.
+ args.parse_warnings.push(lookahead.error());
+ // Parse the unrecognized token tree to advance the parse
+ // stream, and throw it away so we can keep parsing.
+ let _ = input.parse::<proc_macro2::TokenTree>();
+ }
+ }
+ Ok(args)
+ }
+}
+
+impl EventArgs {
+ pub(crate) fn level(&self, default: Level) -> Level {
+ self.level.clone().unwrap_or(default)
+ }
+}
+
+impl Parse for EventArgs {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ if !input.peek(syn::token::Paren) {
+ return Ok(Self::default());
+ }
+ let content;
+ let _ = syn::parenthesized!(content in input);
+ let mut result = Self::default();
+ let mut parse_one_arg =
+ || {
+ let lookahead = content.lookahead1();
+ if lookahead.peek(kw::level) {
+ if result.level.is_some() {
+ return Err(content.error("expected only a single `level` argument"));
+ }
+ result.level = Some(content.parse()?);
+ } else if result.mode != FormatMode::default() {
+ return Err(content.error("expected only a single format argument"));
+ } else if let Some(ident) = content.parse::<Option<Ident>>()? {
+ match ident.to_string().as_str() {
+ "Debug" => result.mode = FormatMode::Debug,
+ "Display" => result.mode = FormatMode::Display,
+ _ => return Err(syn::Error::new(
+ ident.span(),
+ "unknown event formatting mode, expected either `Debug` or `Display`",
+ )),
+ }
+ }
+ Ok(())
+ };
+ parse_one_arg()?;
+ if !content.is_empty() {
+ if content.lookahead1().peek(Token![,]) {
+ let _ = content.parse::<Token![,]>()?;
+ parse_one_arg()?;
+ } else {
+ return Err(content.error("expected `,` or `)`"));
+ }
+ }
+ Ok(result)
+ }
+}
+
+struct StrArg<T> {
+ value: LitStr,
+ _p: std::marker::PhantomData<T>,
+}
+
+impl<T: Parse> Parse for StrArg<T> {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let _ = input.parse::<T>()?;
+ let _ = input.parse::<Token![=]>()?;
+ let value = input.parse()?;
+ Ok(Self {
+ value,
+ _p: std::marker::PhantomData,
+ })
+ }
+}
+
+struct ExprArg<T> {
+ value: Expr,
+ _p: std::marker::PhantomData<T>,
+}
+
+impl<T: Parse> Parse for ExprArg<T> {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let _ = input.parse::<T>()?;
+ let _ = input.parse::<Token![=]>()?;
+ let value = input.parse()?;
+ Ok(Self {
+ value,
+ _p: std::marker::PhantomData,
+ })
+ }
+}
+
+struct Skips(HashSet<Ident>);
+
+impl Parse for Skips {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let _ = input.parse::<kw::skip>();
+ let content;
+ let _ = syn::parenthesized!(content in input);
+ let names = content.parse_terminated(Ident::parse_any, Token![,])?;
+ let mut skips = HashSet::new();
+ for name in names {
+ if skips.contains(&name) {
+ return Err(syn::Error::new(
+ name.span(),
+ "tried to skip the same field twice",
+ ));
+ } else {
+ skips.insert(name);
+ }
+ }
+ Ok(Self(skips))
+ }
+}
+
+#[derive(Clone, Debug, Hash, PartialEq, Eq)]
+pub(crate) enum FormatMode {
+ Default,
+ Display,
+ Debug,
+}
+
+impl Default for FormatMode {
+ fn default() -> Self {
+ FormatMode::Default
+ }
+}
+
+#[derive(Clone, Debug)]
+pub(crate) struct Fields(pub(crate) Punctuated<Field, Token![,]>);
+
+#[derive(Clone, Debug)]
+pub(crate) struct Field {
+ pub(crate) name: Punctuated<Ident, Token![.]>,
+ pub(crate) value: Option<Expr>,
+ pub(crate) kind: FieldKind,
+}
+
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub(crate) enum FieldKind {
+ Debug,
+ Display,
+ Value,
+}
+
+impl Parse for Fields {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let _ = input.parse::<kw::fields>();
+ let content;
+ let _ = syn::parenthesized!(content in input);
+ let fields = content.parse_terminated(Field::parse, Token![,])?;
+ Ok(Self(fields))
+ }
+}
+
+impl ToTokens for Fields {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ self.0.to_tokens(tokens)
+ }
+}
+
+impl Parse for Field {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let mut kind = FieldKind::Value;
+ if input.peek(Token![%]) {
+ input.parse::<Token![%]>()?;
+ kind = FieldKind::Display;
+ } else if input.peek(Token![?]) {
+ input.parse::<Token![?]>()?;
+ kind = FieldKind::Debug;
+ };
+ let name = Punctuated::parse_separated_nonempty_with(input, Ident::parse_any)?;
+ let value = if input.peek(Token![=]) {
+ input.parse::<Token![=]>()?;
+ if input.peek(Token![%]) {
+ input.parse::<Token![%]>()?;
+ kind = FieldKind::Display;
+ } else if input.peek(Token![?]) {
+ input.parse::<Token![?]>()?;
+ kind = FieldKind::Debug;
+ };
+ Some(input.parse()?)
+ } else {
+ None
+ };
+ Ok(Self { name, value, kind })
+ }
+}
+
+impl ToTokens for Field {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ if let Some(ref value) = self.value {
+ let name = &self.name;
+ let kind = &self.kind;
+ tokens.extend(quote! {
+ #name = #kind #value
+ })
+ } else if self.kind == FieldKind::Value {
+ // XXX(eliza): I don't like that fields without values produce
+ // empty fields rather than local variable shorthand...but,
+ // we've released a version where field names without values in
+ // `instrument` produce empty field values, so changing it now
+ // is a breaking change. agh.
+ let name = &self.name;
+ tokens.extend(quote!(#name = tracing::field::Empty))
+ } else {
+ self.kind.to_tokens(tokens);
+ self.name.to_tokens(tokens);
+ }
+ }
+}
+
+impl ToTokens for FieldKind {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ match self {
+ FieldKind::Debug => tokens.extend(quote! { ? }),
+ FieldKind::Display => tokens.extend(quote! { % }),
+ _ => {}
+ }
+ }
+}
+
+#[derive(Clone, Debug)]
+pub(crate) enum Level {
+ Trace,
+ Debug,
+ Info,
+ Warn,
+ Error,
+ Path(Path),
+}
+
+impl Parse for Level {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let _ = input.parse::<kw::level>()?;
+ let _ = input.parse::<Token![=]>()?;
+ let lookahead = input.lookahead1();
+ if lookahead.peek(LitStr) {
+ let str: LitStr = input.parse()?;
+ match str.value() {
+ s if s.eq_ignore_ascii_case("trace") => Ok(Level::Trace),
+ s if s.eq_ignore_ascii_case("debug") => Ok(Level::Debug),
+ s if s.eq_ignore_ascii_case("info") => Ok(Level::Info),
+ s if s.eq_ignore_ascii_case("warn") => Ok(Level::Warn),
+ s if s.eq_ignore_ascii_case("error") => Ok(Level::Error),
+ _ => Err(input.error(
+ "unknown verbosity level, expected one of \"trace\", \
+ \"debug\", \"info\", \"warn\", or \"error\", or a number 1-5",
+ )),
+ }
+ } else if lookahead.peek(LitInt) {
+ fn is_level(lit: &LitInt, expected: u64) -> bool {
+ match lit.base10_parse::<u64>() {
+ Ok(value) => value == expected,
+ Err(_) => false,
+ }
+ }
+ let int: LitInt = input.parse()?;
+ match &int {
+ i if is_level(i, 1) => Ok(Level::Trace),
+ i if is_level(i, 2) => Ok(Level::Debug),
+ i if is_level(i, 3) => Ok(Level::Info),
+ i if is_level(i, 4) => Ok(Level::Warn),
+ i if is_level(i, 5) => Ok(Level::Error),
+ _ => Err(input.error(
+ "unknown verbosity level, expected one of \"trace\", \
+ \"debug\", \"info\", \"warn\", or \"error\", or a number 1-5",
+ )),
+ }
+ } else if lookahead.peek(Ident) {
+ Ok(Self::Path(input.parse()?))
+ } else {
+ Err(lookahead.error())
+ }
+ }
+}
+
+impl ToTokens for Level {
+ fn to_tokens(&self, tokens: &mut TokenStream) {
+ match self {
+ Level::Trace => tokens.extend(quote!(tracing::Level::TRACE)),
+ Level::Debug => tokens.extend(quote!(tracing::Level::DEBUG)),
+ Level::Info => tokens.extend(quote!(tracing::Level::INFO)),
+ Level::Warn => tokens.extend(quote!(tracing::Level::WARN)),
+ Level::Error => tokens.extend(quote!(tracing::Level::ERROR)),
+ Level::Path(ref pat) => tokens.extend(quote!(#pat)),
+ }
+ }
+}
+
+mod kw {
+ syn::custom_keyword!(fields);
+ syn::custom_keyword!(skip);
+ syn::custom_keyword!(skip_all);
+ syn::custom_keyword!(level);
+ syn::custom_keyword!(target);
+ syn::custom_keyword!(parent);
+ syn::custom_keyword!(follows_from);
+ syn::custom_keyword!(name);
+ syn::custom_keyword!(err);
+ syn::custom_keyword!(ret);
+}
diff --git a/crates/tracing-attributes/src/expand.rs b/crates/tracing-attributes/src/expand.rs
new file mode 100644
index 0000000..a7123e5
--- /dev/null
+++ b/crates/tracing-attributes/src/expand.rs
@@ -0,0 +1,827 @@
+use std::iter;
+
+use proc_macro2::TokenStream;
+use quote::{quote, quote_spanned, ToTokens};
+use syn::visit_mut::VisitMut;
+use syn::{
+ punctuated::Punctuated, spanned::Spanned, Block, Expr, ExprAsync, ExprCall, FieldPat, FnArg,
+ Ident, Item, ItemFn, Pat, PatIdent, PatReference, PatStruct, PatTuple, PatTupleStruct, PatType,
+ Path, ReturnType, Signature, Stmt, Token, Type, TypePath,
+};
+
+use crate::{
+ attr::{Field, Fields, FormatMode, InstrumentArgs, Level},
+ MaybeItemFn, MaybeItemFnRef,
+};
+
+/// Given an existing function, generate an instrumented version of that function
+pub(crate) fn gen_function<'a, B: ToTokens + 'a>(
+ input: MaybeItemFnRef<'a, B>,
+ args: InstrumentArgs,
+ instrumented_function_name: &str,
+ self_type: Option<&TypePath>,
+) -> proc_macro2::TokenStream {
+ // these are needed ahead of time, as ItemFn contains the function body _and_
+ // isn't representable inside a quote!/quote_spanned! macro
+ // (Syn's ToTokens isn't implemented for ItemFn)
+ let MaybeItemFnRef {
+ outer_attrs,
+ inner_attrs,
+ vis,
+ sig,
+ block,
+ } = input;
+
+ let Signature {
+ output,
+ inputs: params,
+ unsafety,
+ asyncness,
+ constness,
+ abi,
+ ident,
+ generics:
+ syn::Generics {
+ params: gen_params,
+ where_clause,
+ ..
+ },
+ ..
+ } = sig;
+
+ let warnings = args.warnings();
+
+ let (return_type, return_span) = if let ReturnType::Type(_, return_type) = &output {
+ (erase_impl_trait(return_type), return_type.span())
+ } else {
+ // Point at function name if we don't have an explicit return type
+ (syn::parse_quote! { () }, ident.span())
+ };
+ // Install a fake return statement as the first thing in the function
+ // body, so that we eagerly infer that the return type is what we
+ // declared in the async fn signature.
+ // The `#[allow(..)]` is given because the return statement is
+ // unreachable, but does affect inference, so it needs to be written
+ // exactly that way for it to do its magic.
+ let fake_return_edge = quote_spanned! {return_span=>
+ #[allow(
+ unknown_lints, unreachable_code, clippy::diverging_sub_expression,
+ clippy::let_unit_value, clippy::unreachable, clippy::let_with_type_underscore,
+ clippy::empty_loop
+ )]
+ if false {
+ let __tracing_attr_fake_return: #return_type = loop {};
+ return __tracing_attr_fake_return;
+ }
+ };
+ let block = quote! {
+ {
+ #fake_return_edge
+ #block
+ }
+ };
+
+ let body = gen_block(
+ &block,
+ params,
+ asyncness.is_some(),
+ args,
+ instrumented_function_name,
+ self_type,
+ );
+
+ quote!(
+ #(#outer_attrs) *
+ #vis #constness #unsafety #asyncness #abi fn #ident<#gen_params>(#params) #output
+ #where_clause
+ {
+ #(#inner_attrs) *
+ #warnings
+ #body
+ }
+ )
+}
+
+/// Instrument a block
+fn gen_block<B: ToTokens>(
+ block: &B,
+ params: &Punctuated<FnArg, Token![,]>,
+ async_context: bool,
+ mut args: InstrumentArgs,
+ instrumented_function_name: &str,
+ self_type: Option<&TypePath>,
+) -> proc_macro2::TokenStream {
+ // generate the span's name
+ let span_name = args
+ // did the user override the span's name?
+ .name
+ .as_ref()
+ .map(|name| quote!(#name))
+ .unwrap_or_else(|| quote!(#instrumented_function_name));
+
+ let args_level = args.level();
+ let level = args_level.clone();
+
+ let follows_from = args.follows_from.iter();
+ let follows_from = quote! {
+ #(for cause in #follows_from {
+ __tracing_attr_span.follows_from(cause);
+ })*
+ };
+
+ // generate this inside a closure, so we can return early on errors.
+ let span = (|| {
+ // Pull out the arguments-to-be-skipped first, so we can filter results
+ // below.
+ let param_names: Vec<(Ident, (Ident, RecordType))> = params
+ .clone()
+ .into_iter()
+ .flat_map(|param| match param {
+ FnArg::Typed(PatType { pat, ty, .. }) => {
+ param_names(*pat, RecordType::parse_from_ty(&ty))
+ }
+ FnArg::Receiver(_) => Box::new(iter::once((
+ Ident::new("self", param.span()),
+ RecordType::Debug,
+ ))),
+ })
+ // Little dance with new (user-exposed) names and old (internal)
+ // names of identifiers. That way, we could do the following
+ // even though async_trait (<=0.1.43) rewrites "self" as "_self":
+ // ```
+ // #[async_trait]
+ // impl Foo for FooImpl {
+ // #[instrument(skip(self))]
+ // async fn foo(&self, v: usize) {}
+ // }
+ // ```
+ .map(|(x, record_type)| {
+ // if we are inside a function generated by async-trait <=0.1.43, we need to
+ // take care to rewrite "_self" as "self" for 'user convenience'
+ if self_type.is_some() && x == "_self" {
+ (Ident::new("self", x.span()), (x, record_type))
+ } else {
+ (x.clone(), (x, record_type))
+ }
+ })
+ .collect();
+
+ for skip in &args.skips {
+ if !param_names.iter().map(|(user, _)| user).any(|y| y == skip) {
+ return quote_spanned! {skip.span()=>
+ compile_error!("attempting to skip non-existent parameter")
+ };
+ }
+ }
+
+ let target = args.target();
+
+ let parent = args.parent.iter();
+
+ // filter out skipped fields
+ let quoted_fields: Vec<_> = param_names
+ .iter()
+ .filter(|(param, _)| {
+ if args.skip_all || args.skips.contains(param) {
+ return false;
+ }
+
+ // If any parameters have the same name as a custom field, skip
+ // and allow them to be formatted by the custom field.
+ if let Some(ref fields) = args.fields {
+ fields.0.iter().all(|Field { ref name, .. }| {
+ let first = name.first();
+ first != name.last() || !first.iter().any(|name| name == ¶m)
+ })
+ } else {
+ true
+ }
+ })
+ .map(|(user_name, (real_name, record_type))| match record_type {
+ RecordType::Value => quote!(#user_name = #real_name),
+ RecordType::Debug => quote!(#user_name = tracing::field::debug(&#real_name)),
+ })
+ .collect();
+
+ // replace every use of a variable with its original name
+ if let Some(Fields(ref mut fields)) = args.fields {
+ let mut replacer = IdentAndTypesRenamer {
+ idents: param_names.into_iter().map(|(a, (b, _))| (a, b)).collect(),
+ types: Vec::new(),
+ };
+
+ // when async-trait <=0.1.43 is in use, replace instances
+ // of the "Self" type inside the fields values
+ if let Some(self_type) = self_type {
+ replacer.types.push(("Self", self_type.clone()));
+ }
+
+ for e in fields.iter_mut().filter_map(|f| f.value.as_mut()) {
+ syn::visit_mut::visit_expr_mut(&mut replacer, e);
+ }
+ }
+
+ let custom_fields = &args.fields;
+
+ quote!(tracing::span!(
+ target: #target,
+ #(parent: #parent,)*
+ #level,
+ #span_name,
+ #(#quoted_fields,)*
+ #custom_fields
+
+ ))
+ })();
+
+ let target = args.target();
+
+ let err_event = match args.err_args {
+ Some(event_args) => {
+ let level_tokens = event_args.level(Level::Error);
+ match event_args.mode {
+ FormatMode::Default | FormatMode::Display => Some(quote!(
+ tracing::event!(target: #target, #level_tokens, error = %e)
+ )),
+ FormatMode::Debug => Some(quote!(
+ tracing::event!(target: #target, #level_tokens, error = ?e)
+ )),
+ }
+ }
+ _ => None,
+ };
+
+ let ret_event = match args.ret_args {
+ Some(event_args) => {
+ let level_tokens = event_args.level(args_level);
+ match event_args.mode {
+ FormatMode::Display => Some(quote!(
+ tracing::event!(target: #target, #level_tokens, return = %x)
+ )),
+ FormatMode::Default | FormatMode::Debug => Some(quote!(
+ tracing::event!(target: #target, #level_tokens, return = ?x)
+ )),
+ }
+ }
+ _ => None,
+ };
+
+ // Generate the instrumented function body.
+ // If the function is an `async fn`, this will wrap it in an async block,
+ // which is `instrument`ed using `tracing-futures`. Otherwise, this will
+ // enter the span and then perform the rest of the body.
+ // If `err` is in args, instrument any resulting `Err`s.
+ // If `ret` is in args, instrument any resulting `Ok`s when the function
+ // returns `Result`s, otherwise instrument any resulting values.
+ if async_context {
+ let mk_fut = match (err_event, ret_event) {
+ (Some(err_event), Some(ret_event)) => quote_spanned!(block.span()=>
+ async move {
+ match async move #block.await {
+ #[allow(clippy::unit_arg)]
+ Ok(x) => {
+ #ret_event;
+ Ok(x)
+ },
+ Err(e) => {
+ #err_event;
+ Err(e)
+ }
+ }
+ }
+ ),
+ (Some(err_event), None) => quote_spanned!(block.span()=>
+ async move {
+ match async move #block.await {
+ #[allow(clippy::unit_arg)]
+ Ok(x) => Ok(x),
+ Err(e) => {
+ #err_event;
+ Err(e)
+ }
+ }
+ }
+ ),
+ (None, Some(ret_event)) => quote_spanned!(block.span()=>
+ async move {
+ let x = async move #block.await;
+ #ret_event;
+ x
+ }
+ ),
+ (None, None) => quote_spanned!(block.span()=>
+ async move #block
+ ),
+ };
+
+ return quote!(
+ let __tracing_attr_span = #span;
+ let __tracing_instrument_future = #mk_fut;
+ if !__tracing_attr_span.is_disabled() {
+ #follows_from
+ tracing::Instrument::instrument(
+ __tracing_instrument_future,
+ __tracing_attr_span
+ )
+ .await
+ } else {
+ __tracing_instrument_future.await
+ }
+ );
+ }
+
+ let span = quote!(
+ // These variables are left uninitialized and initialized only
+ // if the tracing level is statically enabled at this point.
+ // While the tracing level is also checked at span creation
+ // time, that will still create a dummy span, and a dummy guard
+ // and drop the dummy guard later. By lazily initializing these
+ // variables, Rust will generate a drop flag for them and thus
+ // only drop the guard if it was created. This creates code that
+ // is very straightforward for LLVM to optimize out if the tracing
+ // level is statically disabled, while not causing any performance
+ // regression in case the level is enabled.
+ let __tracing_attr_span;
+ let __tracing_attr_guard;
+ if tracing::level_enabled!(#level) || tracing::if_log_enabled!(#level, {true} else {false}) {
+ __tracing_attr_span = #span;
+ #follows_from
+ __tracing_attr_guard = __tracing_attr_span.enter();
+ }
+ );
+
+ match (err_event, ret_event) {
+ (Some(err_event), Some(ret_event)) => quote_spanned! {block.span()=>
+ #span
+ #[allow(clippy::redundant_closure_call)]
+ match (move || #block)() {
+ #[allow(clippy::unit_arg)]
+ Ok(x) => {
+ #ret_event;
+ Ok(x)
+ },
+ Err(e) => {
+ #err_event;
+ Err(e)
+ }
+ }
+ },
+ (Some(err_event), None) => quote_spanned!(block.span()=>
+ #span
+ #[allow(clippy::redundant_closure_call)]
+ match (move || #block)() {
+ #[allow(clippy::unit_arg)]
+ Ok(x) => Ok(x),
+ Err(e) => {
+ #err_event;
+ Err(e)
+ }
+ }
+ ),
+ (None, Some(ret_event)) => quote_spanned!(block.span()=>
+ #span
+ #[allow(clippy::redundant_closure_call)]
+ let x = (move || #block)();
+ #ret_event;
+ x
+ ),
+ (None, None) => quote_spanned!(block.span() =>
+ // Because `quote` produces a stream of tokens _without_ whitespace, the
+ // `if` and the block will appear directly next to each other. This
+ // generates a clippy lint about suspicious `if/else` formatting.
+ // Therefore, suppress the lint inside the generated code...
+ #[allow(clippy::suspicious_else_formatting)]
+ {
+ #span
+ // ...but turn the lint back on inside the function body.
+ #[warn(clippy::suspicious_else_formatting)]
+ #block
+ }
+ ),
+ }
+}
+
+/// Indicates whether a field should be recorded as `Value` or `Debug`.
+enum RecordType {
+ /// The field should be recorded using its `Value` implementation.
+ Value,
+ /// The field should be recorded using `tracing::field::debug()`.
+ Debug,
+}
+
+impl RecordType {
+ /// Array of primitive types which should be recorded as [RecordType::Value].
+ const TYPES_FOR_VALUE: &'static [&'static str] = &[
+ "bool",
+ "str",
+ "u8",
+ "i8",
+ "u16",
+ "i16",
+ "u32",
+ "i32",
+ "u64",
+ "i64",
+ "f32",
+ "f64",
+ "usize",
+ "isize",
+ "NonZeroU8",
+ "NonZeroI8",
+ "NonZeroU16",
+ "NonZeroI16",
+ "NonZeroU32",
+ "NonZeroI32",
+ "NonZeroU64",
+ "NonZeroI64",
+ "NonZeroUsize",
+ "NonZeroIsize",
+ "Wrapping",
+ ];
+
+ /// Parse `RecordType` from [Type] by looking up
+ /// the [RecordType::TYPES_FOR_VALUE] array.
+ fn parse_from_ty(ty: &Type) -> Self {
+ match ty {
+ Type::Path(TypePath { path, .. })
+ if path
+ .segments
+ .iter()
+ .last()
+ .map(|path_segment| {
+ let ident = path_segment.ident.to_string();
+ Self::TYPES_FOR_VALUE.iter().any(|&t| t == ident)
+ })
+ .unwrap_or(false) =>
+ {
+ RecordType::Value
+ }
+ Type::Reference(syn::TypeReference { elem, .. }) => RecordType::parse_from_ty(elem),
+ _ => RecordType::Debug,
+ }
+ }
+}
+
+fn param_names(pat: Pat, record_type: RecordType) -> Box<dyn Iterator<Item = (Ident, RecordType)>> {
+ match pat {
+ Pat::Ident(PatIdent { ident, .. }) => Box::new(iter::once((ident, record_type))),
+ Pat::Reference(PatReference { pat, .. }) => param_names(*pat, record_type),
+ // We can't get the concrete type of fields in the struct/tuple
+ // patterns by using `syn`. e.g. `fn foo(Foo { x, y }: Foo) {}`.
+ // Therefore, the struct/tuple patterns in the arguments will just
+ // always be recorded as `RecordType::Debug`.
+ Pat::Struct(PatStruct { fields, .. }) => Box::new(
+ fields
+ .into_iter()
+ .flat_map(|FieldPat { pat, .. }| param_names(*pat, RecordType::Debug)),
+ ),
+ Pat::Tuple(PatTuple { elems, .. }) => Box::new(
+ elems
+ .into_iter()
+ .flat_map(|p| param_names(p, RecordType::Debug)),
+ ),
+ Pat::TupleStruct(PatTupleStruct { elems, .. }) => Box::new(
+ elems
+ .into_iter()
+ .flat_map(|p| param_names(p, RecordType::Debug)),
+ ),
+
+ // The above *should* cover all cases of irrefutable patterns,
+ // but we purposefully don't do any funny business here
+ // (such as panicking) because that would obscure rustc's
+ // much more informative error message.
+ _ => Box::new(iter::empty()),
+ }
+}
+
+/// The specific async code pattern that was detected
+enum AsyncKind<'a> {
+ /// Immediately-invoked async fn, as generated by `async-trait <= 0.1.43`:
+ /// `async fn foo<...>(...) {...}; Box::pin(foo<...>(...))`
+ Function(&'a ItemFn),
+ /// A function returning an async (move) block, optionally `Box::pin`-ed,
+ /// as generated by `async-trait >= 0.1.44`:
+ /// `Box::pin(async move { ... })`
+ Async {
+ async_expr: &'a ExprAsync,
+ pinned_box: bool,
+ },
+}
+
+pub(crate) struct AsyncInfo<'block> {
+ // statement that must be patched
+ source_stmt: &'block Stmt,
+ kind: AsyncKind<'block>,
+ self_type: Option<TypePath>,
+ input: &'block ItemFn,
+}
+
+impl<'block> AsyncInfo<'block> {
+ /// Get the AST of the inner function we need to hook, if it looks like a
+ /// manual future implementation.
+ ///
+ /// When we are given a function that returns a (pinned) future containing the
+ /// user logic, it is that (pinned) future that needs to be instrumented.
+ /// Were we to instrument its parent, we would only collect information
+ /// regarding the allocation of that future, and not its own span of execution.
+ ///
+ /// We inspect the block of the function to find if it matches any of the
+ /// following patterns:
+ ///
+ /// - Immediately-invoked async fn, as generated by `async-trait <= 0.1.43`:
+ /// `async fn foo<...>(...) {...}; Box::pin(foo<...>(...))`
+ ///
+ /// - A function returning an async (move) block, optionally `Box::pin`-ed,
+ /// as generated by `async-trait >= 0.1.44`:
+ /// `Box::pin(async move { ... })`
+ ///
+ /// We the return the statement that must be instrumented, along with some
+ /// other information.
+ /// 'gen_body' will then be able to use that information to instrument the
+ /// proper function/future.
+ ///
+ /// (this follows the approach suggested in
+ /// https://github.com/dtolnay/async-trait/issues/45#issuecomment-571245673)
+ pub(crate) fn from_fn(input: &'block ItemFn) -> Option<Self> {
+ // are we in an async context? If yes, this isn't a manual async-like pattern
+ if input.sig.asyncness.is_some() {
+ return None;
+ }
+
+ let block = &input.block;
+
+ // list of async functions declared inside the block
+ let inside_funs = block.stmts.iter().filter_map(|stmt| {
+ if let Stmt::Item(Item::Fn(fun)) = &stmt {
+ // If the function is async, this is a candidate
+ if fun.sig.asyncness.is_some() {
+ return Some((stmt, fun));
+ }
+ }
+ None
+ });
+
+ // last expression of the block: it determines the return value of the
+ // block, this is quite likely a `Box::pin` statement or an async block
+ let (last_expr_stmt, last_expr) = block.stmts.iter().rev().find_map(|stmt| {
+ if let Stmt::Expr(expr, _semi) = stmt {
+ Some((stmt, expr))
+ } else {
+ None
+ }
+ })?;
+
+ // is the last expression an async block?
+ if let Expr::Async(async_expr) = last_expr {
+ return Some(AsyncInfo {
+ source_stmt: last_expr_stmt,
+ kind: AsyncKind::Async {
+ async_expr,
+ pinned_box: false,
+ },
+ self_type: None,
+ input,
+ });
+ }
+
+ // is the last expression a function call?
+ let (outside_func, outside_args) = match last_expr {
+ Expr::Call(ExprCall { func, args, .. }) => (func, args),
+ _ => return None,
+ };
+
+ // is it a call to `Box::pin()`?
+ let path = match outside_func.as_ref() {
+ Expr::Path(path) => &path.path,
+ _ => return None,
+ };
+ if !path_to_string(path).ends_with("Box::pin") {
+ return None;
+ }
+
+ // Does the call take an argument? If it doesn't,
+ // it's not gonna compile anyway, but that's no reason
+ // to (try to) perform an out of bounds access
+ if outside_args.is_empty() {
+ return None;
+ }
+
+ // Is the argument to Box::pin an async block that
+ // captures its arguments?
+ if let Expr::Async(async_expr) = &outside_args[0] {
+ return Some(AsyncInfo {
+ source_stmt: last_expr_stmt,
+ kind: AsyncKind::Async {
+ async_expr,
+ pinned_box: true,
+ },
+ self_type: None,
+ input,
+ });
+ }
+
+ // Is the argument to Box::pin a function call itself?
+ let func = match &outside_args[0] {
+ Expr::Call(ExprCall { func, .. }) => func,
+ _ => return None,
+ };
+
+ // "stringify" the path of the function called
+ let func_name = match **func {
+ Expr::Path(ref func_path) => path_to_string(&func_path.path),
+ _ => return None,
+ };
+
+ // Was that function defined inside of the current block?
+ // If so, retrieve the statement where it was declared and the function itself
+ let (stmt_func_declaration, func) = inside_funs
+ .into_iter()
+ .find(|(_, fun)| fun.sig.ident == func_name)?;
+
+ // If "_self" is present as an argument, we store its type to be able to rewrite "Self" (the
+ // parameter type) with the type of "_self"
+ let mut self_type = None;
+ for arg in &func.sig.inputs {
+ if let FnArg::Typed(ty) = arg {
+ if let Pat::Ident(PatIdent { ref ident, .. }) = *ty.pat {
+ if ident == "_self" {
+ let mut ty = *ty.ty.clone();
+ // extract the inner type if the argument is "&self" or "&mut self"
+ if let Type::Reference(syn::TypeReference { elem, .. }) = ty {
+ ty = *elem;
+ }
+
+ if let Type::Path(tp) = ty {
+ self_type = Some(tp);
+ break;
+ }
+ }
+ }
+ }
+ }
+
+ Some(AsyncInfo {
+ source_stmt: stmt_func_declaration,
+ kind: AsyncKind::Function(func),
+ self_type,
+ input,
+ })
+ }
+
+ pub(crate) fn gen_async(
+ self,
+ args: InstrumentArgs,
+ instrumented_function_name: &str,
+ ) -> Result<proc_macro::TokenStream, syn::Error> {
+ // let's rewrite some statements!
+ let mut out_stmts: Vec<TokenStream> = self
+ .input
+ .block
+ .stmts
+ .iter()
+ .map(|stmt| stmt.to_token_stream())
+ .collect();
+
+ if let Some((iter, _stmt)) = self
+ .input
+ .block
+ .stmts
+ .iter()
+ .enumerate()
+ .find(|(_iter, stmt)| *stmt == self.source_stmt)
+ {
+ // instrument the future by rewriting the corresponding statement
+ out_stmts[iter] = match self.kind {
+ // `Box::pin(immediately_invoked_async_fn())`
+ AsyncKind::Function(fun) => {
+ let fun = MaybeItemFn::from(fun.clone());
+ gen_function(
+ fun.as_ref(),
+ args,
+ instrumented_function_name,
+ self.self_type.as_ref(),
+ )
+ }
+ // `async move { ... }`, optionally pinned
+ AsyncKind::Async {
+ async_expr,
+ pinned_box,
+ } => {
+ let instrumented_block = gen_block(
+ &async_expr.block,
+ &self.input.sig.inputs,
+ true,
+ args,
+ instrumented_function_name,
+ None,
+ );
+ let async_attrs = &async_expr.attrs;
+ if pinned_box {
+ quote! {
+ Box::pin(#(#async_attrs) * async move { #instrumented_block })
+ }
+ } else {
+ quote! {
+ #(#async_attrs) * async move { #instrumented_block }
+ }
+ }
+ }
+ };
+ }
+
+ let vis = &self.input.vis;
+ let sig = &self.input.sig;
+ let attrs = &self.input.attrs;
+ Ok(quote!(
+ #(#attrs) *
+ #vis #sig {
+ #(#out_stmts) *
+ }
+ )
+ .into())
+ }
+}
+
+// Return a path as a String
+fn path_to_string(path: &Path) -> String {
+ use std::fmt::Write;
+ // some heuristic to prevent too many allocations
+ let mut res = String::with_capacity(path.segments.len() * 5);
+ for i in 0..path.segments.len() {
+ write!(&mut res, "{}", path.segments[i].ident)
+ .expect("writing to a String should never fail");
+ if i < path.segments.len() - 1 {
+ res.push_str("::");
+ }
+ }
+ res
+}
+
+/// A visitor struct to replace idents and types in some piece
+/// of code (e.g. the "self" and "Self" tokens in user-supplied
+/// fields expressions when the function is generated by an old
+/// version of async-trait).
+struct IdentAndTypesRenamer<'a> {
+ types: Vec<(&'a str, TypePath)>,
+ idents: Vec<(Ident, Ident)>,
+}
+
+impl<'a> VisitMut for IdentAndTypesRenamer<'a> {
+ // we deliberately compare strings because we want to ignore the spans
+ // If we apply clippy's lint, the behavior changes
+ #[allow(clippy::cmp_owned)]
+ fn visit_ident_mut(&mut self, id: &mut Ident) {
+ for (old_ident, new_ident) in &self.idents {
+ if id.to_string() == old_ident.to_string() {
+ *id = new_ident.clone();
+ }
+ }
+ }
+
+ fn visit_type_mut(&mut self, ty: &mut Type) {
+ for (type_name, new_type) in &self.types {
+ if let Type::Path(TypePath { path, .. }) = ty {
+ if path_to_string(path) == *type_name {
+ *ty = Type::Path(new_type.clone());
+ }
+ }
+ }
+ }
+}
+
+// A visitor struct that replace an async block by its patched version
+struct AsyncTraitBlockReplacer<'a> {
+ block: &'a Block,
+ patched_block: Block,
+}
+
+impl<'a> VisitMut for AsyncTraitBlockReplacer<'a> {
+ fn visit_block_mut(&mut self, i: &mut Block) {
+ if i == self.block {
+ *i = self.patched_block.clone();
+ }
+ }
+}
+
+// Replaces any `impl Trait` with `_` so it can be used as the type in
+// a `let` statement's LHS.
+struct ImplTraitEraser;
+
+impl VisitMut for ImplTraitEraser {
+ fn visit_type_mut(&mut self, t: &mut Type) {
+ if let Type::ImplTrait(..) = t {
+ *t = syn::TypeInfer {
+ underscore_token: Token),
+ }
+ .into();
+ } else {
+ syn::visit_mut::visit_type_mut(self, t);
+ }
+ }
+}
+
+fn erase_impl_trait(ty: &Type) -> Type {
+ let mut ty = ty.clone();
+ ImplTraitEraser.visit_type_mut(&mut ty);
+ ty
+}
diff --git a/crates/tracing-attributes/src/lib.rs b/crates/tracing-attributes/src/lib.rs
new file mode 100644
index 0000000..6a0fd54
--- /dev/null
+++ b/crates/tracing-attributes/src/lib.rs
@@ -0,0 +1,695 @@
+//! A procedural macro attribute for instrumenting functions with [`tracing`].
+//!
+//! [`tracing`] is a framework for instrumenting Rust programs to collect
+//! structured, event-based diagnostic information. This crate provides the
+//! [`#[instrument]`][instrument] procedural macro attribute.
+//!
+//! Note that this macro is also re-exported by the main `tracing` crate.
+//!
+//! *Compiler support: [requires `rustc` 1.56+][msrv]*
+//!
+//! [msrv]: #supported-rust-versions
+//!
+//! ## Usage
+//!
+//! In the `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing-attributes = "0.1.24"
+//! ```
+//!
+//! The [`#[instrument]`][instrument] attribute can now be added to a function
+//! to automatically create and enter `tracing` [span] when that function is
+//! called. For example:
+//!
+//! ```
+//! use tracing::instrument;
+//!
+//! #[instrument]
+//! pub fn my_function(my_arg: usize) {
+//! // ...
+//! }
+//!
+//! # fn main() {}
+//! ```
+//!
+//! [`tracing`]: https://crates.io/crates/tracing
+//! [span]: https://docs.rs/tracing/latest/tracing/span/index.html
+//! [instrument]: macro@self::instrument
+//!
+//! ## Supported Rust Versions
+//!
+//! Tracing is built against the latest stable release. The minimum supported
+//! version is 1.56. The current Tracing version is not guaranteed to build on
+//! Rust versions earlier than the minimum supported version.
+//!
+//! Tracing follows the same compiler support policies as the rest of the Tokio
+//! project. The current stable Rust compiler and the three most recent minor
+//! versions before it will always be supported. For example, if the current
+//! stable compiler version is 1.69, the minimum supported version will not be
+//! increased past 1.66, three minor versions prior. Increasing the minimum
+//! supported compiler version is not considered a semver breaking change as
+//! long as doing so complies with this policy.
+//!
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
+ issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
+#![cfg_attr(docsrs, deny(rustdoc::broken_intra_doc_links))]
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub,
+ bad_style,
+ dead_code,
+ improper_ctypes,
+ non_shorthand_field_patterns,
+ no_mangle_generic_items,
+ overflowing_literals,
+ path_statements,
+ patterns_in_fns_without_body,
+ private_in_public,
+ unconditional_recursion,
+ unused_allocation,
+ unused_comparisons,
+ unused_parens,
+ while_true
+)]
+// TODO: once `tracing` bumps its MSRV to 1.42, remove this allow.
+#![allow(unused)]
+extern crate proc_macro;
+
+use proc_macro2::TokenStream;
+use quote::{quote, ToTokens};
+use syn::parse::{Parse, ParseStream};
+use syn::{Attribute, ItemFn, Signature, Visibility};
+
+mod attr;
+mod expand;
+/// Instruments a function to create and enter a `tracing` [span] every time
+/// the function is called.
+///
+/// Unless overridden, a span with the [`INFO`] [level] will be generated.
+/// The generated span's name will be the name of the function.
+/// By default, all arguments to the function are included as fields on the
+/// span. Arguments that are `tracing` [primitive types] implementing the
+/// [`Value` trait] will be recorded as fields of that type. Types which do
+/// not implement `Value` will be recorded using [`std::fmt::Debug`].
+///
+/// [primitive types]: https://docs.rs/tracing/latest/tracing/field/trait.Value.html#foreign-impls
+/// [`Value` trait]: https://docs.rs/tracing/latest/tracing/field/trait.Value.html.
+///
+/// # Overriding Span Attributes
+///
+/// To change the [name] of the generated span, add a `name` argument to the
+/// `#[instrument]` macro, followed by an equals sign and a string literal. For
+/// example:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+///
+/// // The generated span's name will be "my_span" rather than "my_function".
+/// #[instrument(name = "my_span")]
+/// pub fn my_function() {
+/// // ... do something incredibly interesting and important ...
+/// }
+/// ```
+///
+/// To override the [target] of the generated span, add a `target` argument to
+/// the `#[instrument]` macro, followed by an equals sign and a string literal
+/// for the new target. The [module path] is still recorded separately. For
+/// example:
+///
+/// ```
+/// pub mod my_module {
+/// # use tracing_attributes::instrument;
+/// // The generated span's target will be "my_crate::some_special_target",
+/// // rather than "my_crate::my_module".
+/// #[instrument(target = "my_crate::some_special_target")]
+/// pub fn my_function() {
+/// // ... all kinds of neat code in here ...
+/// }
+/// }
+/// ```
+///
+/// Finally, to override the [level] of the generated span, add a `level`
+/// argument, followed by an equals sign and a string literal with the name of
+/// the desired level. Level names are not case sensitive. For example:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// // The span's level will be TRACE rather than INFO.
+/// #[instrument(level = "trace")]
+/// pub fn my_function() {
+/// // ... I have written a truly marvelous implementation of this function,
+/// // which this example is too narrow to contain ...
+/// }
+/// ```
+///
+/// # Skipping Fields
+///
+/// To skip recording one or more arguments to a function or method, pass
+/// the argument's name inside the `skip()` argument on the `#[instrument]`
+/// macro. This can be used when an argument to an instrumented function does
+/// not implement [`fmt::Debug`], or to exclude an argument with a verbose or
+/// costly `Debug` implementation. Note that:
+///
+/// - multiple argument names can be passed to `skip`.
+/// - arguments passed to `skip` do _not_ need to implement `fmt::Debug`.
+///
+/// You can also use `skip_all` to skip all arguments.
+///
+/// ## Examples
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// # use std::collections::HashMap;
+/// // This type doesn't implement `fmt::Debug`!
+/// struct NonDebug;
+///
+/// // `arg` will be recorded, while `non_debug` will not.
+/// #[instrument(skip(non_debug))]
+/// fn my_function(arg: usize, non_debug: NonDebug) {
+/// // ...
+/// }
+///
+/// // These arguments are huge
+/// #[instrument(skip_all)]
+/// fn my_big_data_function(large: Vec<u8>, also_large: HashMap<String, String>) {
+/// // ...
+/// }
+/// ```
+///
+/// Skipping the `self` parameter:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[derive(Debug)]
+/// struct MyType {
+/// data: Vec<u8>, // Suppose this buffer is often quite long...
+/// }
+///
+/// impl MyType {
+/// // Suppose we don't want to print an entire kilobyte of `data`
+/// // every time this is called...
+/// #[instrument(skip(self))]
+/// pub fn my_method(&mut self, an_interesting_argument: usize) {
+/// // ... do something (hopefully, using all that `data`!)
+/// }
+/// }
+/// ```
+///
+/// # Adding Fields
+///
+/// Additional fields (key-value pairs with arbitrary data) can be passed to
+/// to the generated span through the `fields` argument on the
+/// `#[instrument]` macro. Strings, integers or boolean literals are accepted values
+/// for each field. The name of the field must be a single valid Rust
+/// identifier, nested (dotted) field names are not supported. Any
+/// Rust expression can be used as a field value in this manner. These
+/// expressions will be evaluated at the beginning of the function's body, so
+/// arguments to the function may be used in these expressions. Field names may
+/// also be specified *without* values. Doing so will result in an [empty field]
+/// whose value may be recorded later within the function body.
+///
+/// Note that overlap between the names of fields and (non-skipped) arguments
+/// will result in a compile error.
+///
+/// ## Examples
+///
+/// Adding a new field based on the value of an argument:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+///
+/// // This will record a field named "i" with the value of `i` *and* a field
+/// // named "next" with the value of `i` + 1.
+/// #[instrument(fields(next = i + 1))]
+/// pub fn my_function(i: usize) {
+/// // ...
+/// }
+/// ```
+///
+/// Recording specific properties of a struct as their own fields:
+///
+/// ```
+/// # mod http {
+/// # pub struct Error;
+/// # pub struct Response<B> { pub(super) _b: std::marker::PhantomData<B> }
+/// # pub struct Request<B> { _b: B }
+/// # impl<B> std::fmt::Debug for Request<B> {
+/// # fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+/// # f.pad("request")
+/// # }
+/// # }
+/// # impl<B> Request<B> {
+/// # pub fn uri(&self) -> &str { "fake" }
+/// # pub fn method(&self) -> &str { "GET" }
+/// # }
+/// # }
+/// # use tracing_attributes::instrument;
+///
+/// // This will record the request's URI and HTTP method as their own separate
+/// // fields.
+/// #[instrument(fields(http.uri = req.uri(), http.method = req.method()))]
+/// pub fn handle_request<B>(req: http::Request<B>) -> http::Response<B> {
+/// // ... handle the request ...
+/// # http::Response { _b: std::marker::PhantomData }
+/// }
+/// ```
+///
+/// This can be used in conjunction with `skip` or `skip_all` to record only
+/// some fields of a struct:
+/// ```
+/// # use tracing_attributes::instrument;
+/// // Remember the struct with the very large `data` field from the earlier
+/// // example? Now it also has a `name`, which we might want to include in
+/// // our span.
+/// #[derive(Debug)]
+/// struct MyType {
+/// name: &'static str,
+/// data: Vec<u8>,
+/// }
+///
+/// impl MyType {
+/// // This will skip the `data` field, but will include `self.name`,
+/// // formatted using `fmt::Display`.
+/// #[instrument(skip(self), fields(self.name = %self.name))]
+/// pub fn my_method(&mut self, an_interesting_argument: usize) {
+/// // ... do something (hopefully, using all that `data`!)
+/// }
+/// }
+/// ```
+///
+/// Adding an empty field to be recorded later:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+///
+/// // This function does a very interesting and important mathematical calculation.
+/// // Suppose we want to record both the inputs to the calculation *and* its result...
+/// #[instrument(fields(result))]
+/// pub fn do_calculation(input_1: usize, input_2: usize) -> usize {
+/// // Rerform the calculation.
+/// let result = input_1 + input_2;
+///
+/// // Record the result as part of the current span.
+/// tracing::Span::current().record("result", &result);
+///
+/// // Now, the result will also be included on this event!
+/// tracing::info!("calculation complete!");
+///
+/// // ... etc ...
+/// # 0
+/// }
+/// ```
+///
+/// # Examples
+///
+/// Instrumenting a function:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument]
+/// pub fn my_function(my_arg: usize) {
+/// // This event will be recorded inside a span named `my_function` with the
+/// // field `my_arg`.
+/// tracing::info!("inside my_function!");
+/// // ...
+/// }
+/// ```
+/// Setting the level for the generated span:
+/// ```
+/// # use tracing_attributes::instrument;
+/// # use tracing::Level;
+/// #[instrument(level = Level::DEBUG)]
+/// pub fn my_function() {
+/// // ...
+/// }
+/// ```
+/// Levels can be specified either with [`Level`] constants, literal strings
+/// (e.g., `"debug"`, `"info"`) or numerically (1—5, corresponding to [`Level::TRACE`]—[`Level::ERROR`]).
+///
+/// Overriding the generated span's name:
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(name = "my_name")]
+/// pub fn my_function() {
+/// // ...
+/// }
+/// ```
+/// Overriding the generated span's target:
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(target = "my_target")]
+/// pub fn my_function() {
+/// // ...
+/// }
+/// ```
+/// Overriding the generated span's parent:
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(parent = None)]
+/// pub fn my_function() {
+/// // ...
+/// }
+/// ```
+/// ```
+/// # use tracing_attributes::instrument;
+/// // A struct which owns a span handle.
+/// struct MyStruct
+/// {
+/// span: tracing::Span
+/// }
+///
+/// impl MyStruct
+/// {
+/// // Use the struct's `span` field as the parent span
+/// #[instrument(parent = &self.span, skip(self))]
+/// fn my_method(&self) {}
+/// }
+/// ```
+/// Specifying [`follows_from`] relationships:
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(follows_from = causes)]
+/// pub fn my_function(causes: &[tracing::Id]) {
+/// // ...
+/// }
+/// ```
+/// Any expression of type `impl IntoIterator<Item = impl Into<Option<Id>>>`
+/// may be provided to `follows_from`; e.g.:
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(follows_from = [cause])]
+/// pub fn my_function(cause: &tracing::span::EnteredSpan) {
+/// // ...
+/// }
+/// ```
+///
+///
+/// To skip recording an argument, pass the argument's name to the `skip`:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// struct NonDebug;
+///
+/// #[instrument(skip(non_debug))]
+/// fn my_function(arg: usize, non_debug: NonDebug) {
+/// // ...
+/// }
+/// ```
+///
+/// To add additional context to the span, pass key-value pairs to `fields`:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(fields(foo="bar", id=1, show=true))]
+/// fn my_function(arg: usize) {
+/// // ...
+/// }
+/// ```
+///
+/// Adding the `ret` argument to `#[instrument]` will emit an event with the function's
+/// return value when the function returns:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(ret)]
+/// fn my_function() -> i32 {
+/// 42
+/// }
+/// ```
+/// The return value event will have the same level as the span generated by `#[instrument]`.
+/// By default, this will be [`INFO`], but if the level is overridden, the event will be at the same
+/// level.
+///
+/// It's also possible to override the level for the `ret` event independently:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// # use tracing::Level;
+/// #[instrument(ret(level = Level::WARN))]
+/// fn my_function() -> i32 {
+/// 42
+/// }
+/// ```
+///
+/// **Note**: if the function returns a `Result<T, E>`, `ret` will record returned values if and
+/// only if the function returns [`Result::Ok`].
+///
+/// By default, returned values will be recorded using their [`std::fmt::Debug`] implementations.
+/// If a returned value implements [`std::fmt::Display`], it can be recorded using its `Display`
+/// implementation instead, by writing `ret(Display)`:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(ret(Display))]
+/// fn my_function() -> i32 {
+/// 42
+/// }
+/// ```
+///
+/// If the function returns a `Result<T, E>` and `E` implements `std::fmt::Display`, adding
+/// `err` or `err(Display)` will emit error events when the function returns `Err`:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(err)]
+/// fn my_function(arg: usize) -> Result<(), std::io::Error> {
+/// Ok(())
+/// }
+/// ```
+///
+/// The level of the error value event defaults to `ERROR`.
+///
+/// Similarly, overriding the level of the `err` event :
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// # use tracing::Level;
+/// #[instrument(err(level = Level::INFO))]
+/// fn my_function(arg: usize) -> Result<(), std::io::Error> {
+/// Ok(())
+/// }
+/// ```
+///
+/// By default, error values will be recorded using their `std::fmt::Display` implementations.
+/// If an error implements `std::fmt::Debug`, it can be recorded using its `Debug` implementation
+/// instead by writing `err(Debug)`:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(err(Debug))]
+/// fn my_function(arg: usize) -> Result<(), std::io::Error> {
+/// Ok(())
+/// }
+/// ```
+///
+/// If a `target` is specified, both the `ret` and `err` arguments will emit outputs to
+/// the declared target (or the default channel if `target` is not specified).
+///
+/// The `ret` and `err` arguments can be combined in order to record an event if a
+/// function returns [`Result::Ok`] or [`Result::Err`]:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument(err, ret)]
+/// fn my_function(arg: usize) -> Result<(), std::io::Error> {
+/// Ok(())
+/// }
+/// ```
+///
+/// `async fn`s may also be instrumented:
+///
+/// ```
+/// # use tracing_attributes::instrument;
+/// #[instrument]
+/// pub async fn my_function() -> Result<(), ()> {
+/// // ...
+/// # Ok(())
+/// }
+/// ```
+///
+/// It also works with [async-trait](https://crates.io/crates/async-trait)
+/// (a crate that allows defining async functions in traits,
+/// something not currently possible in Rust),
+/// and hopefully most libraries that exhibit similar behaviors:
+///
+/// ```
+/// # use tracing::instrument;
+/// use async_trait::async_trait;
+///
+/// #[async_trait]
+/// pub trait Foo {
+/// async fn foo(&self, arg: usize);
+/// }
+///
+/// #[derive(Debug)]
+/// struct FooImpl(usize);
+///
+/// #[async_trait]
+/// impl Foo for FooImpl {
+/// #[instrument(fields(value = self.0, tmp = std::any::type_name::<Self>()))]
+/// async fn foo(&self, arg: usize) {}
+/// }
+/// ```
+///
+/// `const fn` cannot be instrumented, and will result in a compilation failure:
+///
+/// ```compile_fail
+/// # use tracing_attributes::instrument;
+/// #[instrument]
+/// const fn my_const_function() {}
+/// ```
+///
+/// [span]: https://docs.rs/tracing/latest/tracing/span/index.html
+/// [name]: https://docs.rs/tracing/latest/tracing/struct.Metadata.html#method.name
+/// [target]: https://docs.rs/tracing/latest/tracing/struct.Metadata.html#method.target
+/// [level]: https://docs.rs/tracing/latest/tracing/struct.Level.html
+/// [module path]: https://docs.rs/tracing/latest/tracing/struct.Metadata.html#method.module_path
+/// [`INFO`]: https://docs.rs/tracing/latest/tracing/struct.Level.html#associatedconstant.INFO
+/// [empty field]: https://docs.rs/tracing/latest/tracing/field/struct.Empty.html
+/// [field syntax]: https://docs.rs/tracing/latest/tracing/#recording-fields
+/// [`follows_from`]: https://docs.rs/tracing/latest/tracing/struct.Span.html#method.follows_from
+/// [`tracing`]: https://github.com/tokio-rs/tracing
+/// [`fmt::Debug`]: std::fmt::Debug
+/// [`Level`]: https://docs.rs/tracing/latest/tracing/struct.Level.html
+/// [`Level::TRACE`]: https://docs.rs/tracing/latest/tracing/struct.Level.html#associatedconstant.TRACE
+/// [`Level::ERROR`]: https://docs.rs/tracing/latest/tracing/struct.Level.html#associatedconstant.ERROR
+#[proc_macro_attribute]
+pub fn instrument(
+ args: proc_macro::TokenStream,
+ item: proc_macro::TokenStream,
+) -> proc_macro::TokenStream {
+ let args = syn::parse_macro_input!(args as attr::InstrumentArgs);
+ // Cloning a `TokenStream` is cheap since it's reference counted internally.
+ instrument_precise(args.clone(), item.clone())
+ .unwrap_or_else(|_err| instrument_speculative(args, item))
+}
+
+/// Instrument the function, without parsing the function body (instead using the raw tokens).
+fn instrument_speculative(
+ args: attr::InstrumentArgs,
+ item: proc_macro::TokenStream,
+) -> proc_macro::TokenStream {
+ let input = syn::parse_macro_input!(item as MaybeItemFn);
+ let instrumented_function_name = input.sig.ident.to_string();
+ expand::gen_function(
+ input.as_ref(),
+ args,
+ instrumented_function_name.as_str(),
+ None,
+ )
+ .into()
+}
+
+/// Instrument the function, by fully parsing the function body,
+/// which allows us to rewrite some statements related to async-like patterns.
+fn instrument_precise(
+ args: attr::InstrumentArgs,
+ item: proc_macro::TokenStream,
+) -> Result<proc_macro::TokenStream, syn::Error> {
+ let input = syn::parse::<ItemFn>(item)?;
+ let instrumented_function_name = input.sig.ident.to_string();
+
+ if input.sig.constness.is_some() {
+ return Ok(quote! {
+ compile_error!("the `#[instrument]` attribute may not be used with `const fn`s")
+ }
+ .into());
+ }
+
+ // check for async_trait-like patterns in the block, and instrument
+ // the future instead of the wrapper
+ if let Some(async_like) = expand::AsyncInfo::from_fn(&input) {
+ return async_like.gen_async(args, instrumented_function_name.as_str());
+ }
+
+ let input = MaybeItemFn::from(input);
+
+ Ok(expand::gen_function(
+ input.as_ref(),
+ args,
+ instrumented_function_name.as_str(),
+ None,
+ )
+ .into())
+}
+
+/// This is a more flexible/imprecise `ItemFn` type,
+/// which's block is just a `TokenStream` (it may contain invalid code).
+#[derive(Debug, Clone)]
+struct MaybeItemFn {
+ outer_attrs: Vec<Attribute>,
+ inner_attrs: Vec<Attribute>,
+ vis: Visibility,
+ sig: Signature,
+ block: TokenStream,
+}
+
+impl MaybeItemFn {
+ fn as_ref(&self) -> MaybeItemFnRef<'_, TokenStream> {
+ MaybeItemFnRef {
+ outer_attrs: &self.outer_attrs,
+ inner_attrs: &self.inner_attrs,
+ vis: &self.vis,
+ sig: &self.sig,
+ block: &self.block,
+ }
+ }
+}
+
+/// This parses a `TokenStream` into a `MaybeItemFn`
+/// (just like `ItemFn`, but skips parsing the body).
+impl Parse for MaybeItemFn {
+ fn parse(input: ParseStream<'_>) -> syn::Result<Self> {
+ let outer_attrs = input.call(Attribute::parse_outer)?;
+ let vis: Visibility = input.parse()?;
+ let sig: Signature = input.parse()?;
+ let inner_attrs = input.call(Attribute::parse_inner)?;
+ let block: TokenStream = input.parse()?;
+ Ok(Self {
+ outer_attrs,
+ inner_attrs,
+ vis,
+ sig,
+ block,
+ })
+ }
+}
+
+impl From<ItemFn> for MaybeItemFn {
+ fn from(
+ ItemFn {
+ attrs,
+ vis,
+ sig,
+ block,
+ }: ItemFn,
+ ) -> Self {
+ let (outer_attrs, inner_attrs) = attrs
+ .into_iter()
+ .partition(|attr| attr.style == syn::AttrStyle::Outer);
+ Self {
+ outer_attrs,
+ inner_attrs,
+ vis,
+ sig,
+ block: block.to_token_stream(),
+ }
+ }
+}
+
+/// A generic reference type for `MaybeItemFn`,
+/// that takes a generic block type `B` that implements `ToTokens` (eg. `TokenStream`, `Block`).
+#[derive(Debug, Clone)]
+struct MaybeItemFnRef<'a, B: ToTokens> {
+ outer_attrs: &'a Vec<Attribute>,
+ inner_attrs: &'a Vec<Attribute>,
+ vis: &'a Visibility,
+ sig: &'a Signature,
+ block: &'a B,
+}
diff --git a/crates/tracing-attributes/tests/async_fn.rs b/crates/tracing-attributes/tests/async_fn.rs
new file mode 100644
index 0000000..1d92734
--- /dev/null
+++ b/crates/tracing-attributes/tests/async_fn.rs
@@ -0,0 +1,487 @@
+use tracing_mock::*;
+
+use std::convert::Infallible;
+use std::{future::Future, pin::Pin, sync::Arc};
+use tracing::subscriber::with_default;
+use tracing_attributes::instrument;
+
+#[instrument]
+async fn test_async_fn(polls: usize) -> Result<(), ()> {
+ let future = PollN::new_ok(polls);
+ tracing::trace!(awaiting = true);
+ future.await
+}
+
+// Reproduces a compile error when returning an `impl Trait` from an
+// instrumented async fn (see https://github.com/tokio-rs/tracing/issues/1615)
+#[allow(dead_code)] // this is just here to test whether it compiles.
+#[instrument]
+async fn test_ret_impl_trait(n: i32) -> Result<impl Iterator<Item = i32>, ()> {
+ Ok((0..10).filter(move |x| *x < n))
+}
+
+// Reproduces a compile error when returning an `impl Trait` from an
+// instrumented async fn (see https://github.com/tokio-rs/tracing/issues/1615)
+#[allow(dead_code)] // this is just here to test whether it compiles.
+#[instrument(err)]
+async fn test_ret_impl_trait_err(n: i32) -> Result<impl Iterator<Item = i32>, &'static str> {
+ Ok((0..10).filter(move |x| *x < n))
+}
+
+#[instrument]
+async fn test_async_fn_empty() {}
+
+// Reproduces a compile error when an instrumented function body contains inner
+// attributes (https://github.com/tokio-rs/tracing/issues/2294).
+#[deny(unused_variables)]
+#[instrument]
+async fn repro_async_2294() {
+ #![allow(unused_variables)]
+ let i = 42;
+}
+
+// Reproduces https://github.com/tokio-rs/tracing/issues/1613
+#[instrument]
+// LOAD-BEARING `#[rustfmt::skip]`! This is necessary to reproduce the bug;
+// with the rustfmt-generated formatting, the lint will not be triggered!
+#[rustfmt::skip]
+#[deny(clippy::suspicious_else_formatting)]
+async fn repro_1613(var: bool) {
+ println!(
+ "{}",
+ if var { "true" } else { "false" }
+ );
+}
+
+// Reproduces https://github.com/tokio-rs/tracing/issues/1613
+// and https://github.com/rust-lang/rust-clippy/issues/7760
+#[instrument]
+#[deny(clippy::suspicious_else_formatting)]
+async fn repro_1613_2() {
+ // hello world
+ // else
+}
+
+// Reproduces https://github.com/tokio-rs/tracing/issues/1831
+#[allow(dead_code)] // this is just here to test whether it compiles.
+#[instrument]
+#[deny(unused_braces)]
+fn repro_1831() -> Pin<Box<dyn Future<Output = ()>>> {
+ Box::pin(async move {})
+}
+
+// This replicates the pattern used to implement async trait methods on nightly using the
+// `type_alias_impl_trait` feature
+#[allow(dead_code)] // this is just here to test whether it compiles.
+#[instrument(ret, err)]
+#[deny(unused_braces)]
+#[allow(clippy::manual_async_fn)]
+fn repro_1831_2() -> impl Future<Output = Result<(), Infallible>> {
+ async { Ok(()) }
+}
+
+#[test]
+fn async_fn_only_enters_for_polls() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("test_async_fn"))
+ .enter(expect::span().named("test_async_fn"))
+ .event(expect::event().with_fields(expect::field("awaiting").with_value(&true)))
+ .exit(expect::span().named("test_async_fn"))
+ .enter(expect::span().named("test_async_fn"))
+ .exit(expect::span().named("test_async_fn"))
+ .enter(expect::span().named("test_async_fn"))
+ .exit(expect::span().named("test_async_fn"))
+ .drop_span(expect::span().named("test_async_fn"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ block_on_future(async { test_async_fn(2).await }).unwrap();
+ });
+ handle.assert_finished();
+}
+
+#[test]
+fn async_fn_nested() {
+ #[instrument]
+ async fn test_async_fns_nested() {
+ test_async_fns_nested_other().await
+ }
+
+ #[instrument]
+ async fn test_async_fns_nested_other() {
+ tracing::trace!(nested = true);
+ }
+
+ let span = expect::span().named("test_async_fns_nested");
+ let span2 = expect::span().named("test_async_fns_nested_other");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .new_span(span2.clone())
+ .enter(span2.clone())
+ .event(expect::event().with_fields(expect::field("nested").with_value(&true)))
+ .exit(span2.clone())
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async { test_async_fns_nested().await });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn async_fn_with_async_trait() {
+ use async_trait::async_trait;
+
+ // test the correctness of the metadata obtained by #[instrument]
+ // (function name, functions parameters) when async-trait is used
+ #[async_trait]
+ pub trait TestA {
+ async fn foo(&mut self, v: usize);
+ }
+
+ // test nesting of async fns with aync-trait
+ #[async_trait]
+ pub trait TestB {
+ async fn bar(&self);
+ }
+
+ // test skip(self) with async-await
+ #[async_trait]
+ pub trait TestC {
+ async fn baz(&self);
+ }
+
+ #[derive(Debug)]
+ struct TestImpl(usize);
+
+ #[async_trait]
+ impl TestA for TestImpl {
+ #[instrument]
+ async fn foo(&mut self, v: usize) {
+ self.baz().await;
+ self.0 = v;
+ self.bar().await
+ }
+ }
+
+ #[async_trait]
+ impl TestB for TestImpl {
+ #[instrument]
+ async fn bar(&self) {
+ tracing::trace!(val = self.0);
+ }
+ }
+
+ #[async_trait]
+ impl TestC for TestImpl {
+ #[instrument(skip(self))]
+ async fn baz(&self) {
+ tracing::trace!(val = self.0);
+ }
+ }
+
+ let span = expect::span().named("foo");
+ let span2 = expect::span().named("bar");
+ let span3 = expect::span().named("baz");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone()
+ .with_field(expect::field("self"))
+ .with_field(expect::field("v")),
+ )
+ .enter(span.clone())
+ .new_span(span3.clone())
+ .enter(span3.clone())
+ .event(expect::event().with_fields(expect::field("val").with_value(&2u64)))
+ .exit(span3.clone())
+ .enter(span3.clone())
+ .exit(span3.clone())
+ .drop_span(span3)
+ .new_span(span2.clone().with_field(expect::field("self")))
+ .enter(span2.clone())
+ .event(expect::event().with_fields(expect::field("val").with_value(&5u64)))
+ .exit(span2.clone())
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let mut test = TestImpl(2);
+ block_on_future(async { test.foo(5).await });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn async_fn_with_async_trait_and_fields_expressions() {
+ use async_trait::async_trait;
+
+ #[async_trait]
+ pub trait Test {
+ async fn call(&mut self, v: usize);
+ }
+
+ #[derive(Clone, Debug)]
+ struct TestImpl;
+
+ impl TestImpl {
+ fn foo(&self) -> usize {
+ 42
+ }
+ }
+
+ #[async_trait]
+ impl Test for TestImpl {
+ // check that self is correctly handled, even when using async_trait
+ #[instrument(fields(val=self.foo(), val2=Self::clone(self).foo(), test=%_v+5))]
+ async fn call(&mut self, _v: usize) {}
+ }
+
+ let span = expect::span().named("call");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("_v")
+ .with_value(&5usize)
+ .and(expect::field("test").with_value(&tracing::field::debug(10)))
+ .and(expect::field("val").with_value(&42u64))
+ .and(expect::field("val2").with_value(&42u64)),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async { TestImpl.call(5).await });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn async_fn_with_async_trait_and_fields_expressions_with_generic_parameter() {
+ use async_trait::async_trait;
+
+ #[async_trait]
+ pub trait Test {
+ async fn call();
+ async fn call_with_self(&self);
+ async fn call_with_mut_self(&mut self);
+ }
+
+ #[derive(Clone, Debug)]
+ struct TestImpl;
+
+ // we also test sync functions that return futures, as they should be handled just like
+ // async-trait (>= 0.1.44) functions
+ impl TestImpl {
+ #[instrument(fields(Self=std::any::type_name::<Self>()))]
+ fn sync_fun(&self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>> {
+ let val = self.clone();
+ Box::pin(async move {
+ let _ = val;
+ })
+ }
+ }
+
+ #[async_trait]
+ impl Test for TestImpl {
+ // instrumenting this is currently not possible, see https://github.com/tokio-rs/tracing/issues/864#issuecomment-667508801
+ //#[instrument(fields(Self=std::any::type_name::<Self>()))]
+ async fn call() {}
+
+ #[instrument(fields(Self=std::any::type_name::<Self>()))]
+ async fn call_with_self(&self) {
+ self.sync_fun().await;
+ }
+
+ #[instrument(fields(Self=std::any::type_name::<Self>()))]
+ async fn call_with_mut_self(&mut self) {}
+ }
+
+ //let span = span::mock().named("call");
+ let span2 = expect::span().named("call_with_self");
+ let span3 = expect::span().named("call_with_mut_self");
+ let span4 = expect::span().named("sync_fun");
+ let (subscriber, handle) = subscriber::mock()
+ /*.new_span(span.clone()
+ .with_field(
+ expect::field("Self").with_value(&"TestImpler")))
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)*/
+ .new_span(
+ span2
+ .clone()
+ .with_field(expect::field("Self").with_value(&std::any::type_name::<TestImpl>())),
+ )
+ .enter(span2.clone())
+ .new_span(
+ span4
+ .clone()
+ .with_field(expect::field("Self").with_value(&std::any::type_name::<TestImpl>())),
+ )
+ .enter(span4.clone())
+ .exit(span4.clone())
+ .enter(span4.clone())
+ .exit(span4)
+ .exit(span2.clone())
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .new_span(
+ span3
+ .clone()
+ .with_field(expect::field("Self").with_value(&std::any::type_name::<TestImpl>())),
+ )
+ .enter(span3.clone())
+ .exit(span3.clone())
+ .enter(span3.clone())
+ .exit(span3.clone())
+ .drop_span(span3)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async {
+ TestImpl::call().await;
+ TestImpl.call_with_self().await;
+ TestImpl.call_with_mut_self().await
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn out_of_scope_fields() {
+ // Reproduces tokio-rs/tracing#1296
+
+ struct Thing {
+ metrics: Arc<()>,
+ }
+
+ impl Thing {
+ #[instrument(skip(self, _req), fields(app_id))]
+ fn call(&mut self, _req: ()) -> Pin<Box<dyn Future<Output = Arc<()>> + Send + Sync>> {
+ // ...
+ let metrics = self.metrics.clone();
+ // ...
+ Box::pin(async move {
+ // ...
+ metrics // cannot find value `metrics` in this scope
+ })
+ }
+ }
+
+ let span = expect::span().named("call");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async {
+ let mut my_thing = Thing {
+ metrics: Arc::new(()),
+ };
+ my_thing.call(()).await;
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn manual_impl_future() {
+ #[allow(clippy::manual_async_fn)]
+ #[instrument]
+ fn manual_impl_future() -> impl Future<Output = ()> {
+ async {
+ tracing::trace!(poll = true);
+ }
+ }
+
+ let span = expect::span().named("manual_impl_future");
+ let poll_event = || expect::event().with_fields(expect::field("poll").with_value(&true));
+
+ let (subscriber, handle) = subscriber::mock()
+ // await manual_impl_future
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(poll_event())
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async {
+ manual_impl_future().await;
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn manual_box_pin() {
+ #[instrument]
+ fn manual_box_pin() -> Pin<Box<dyn Future<Output = ()>>> {
+ Box::pin(async {
+ tracing::trace!(poll = true);
+ })
+ }
+
+ let span = expect::span().named("manual_box_pin");
+ let poll_event = || expect::event().with_fields(expect::field("poll").with_value(&true));
+
+ let (subscriber, handle) = subscriber::mock()
+ // await manual_box_pin
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(poll_event())
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async {
+ manual_box_pin().await;
+ });
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/destructuring.rs b/crates/tracing-attributes/tests/destructuring.rs
new file mode 100644
index 0000000..cc4fecf
--- /dev/null
+++ b/crates/tracing-attributes/tests/destructuring.rs
@@ -0,0 +1,213 @@
+use tracing::subscriber::with_default;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[test]
+fn destructure_tuples() {
+ #[instrument]
+ fn my_fn((arg1, arg2): (usize, usize)) {}
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("1"))
+ .and(expect::field("arg2").with_value(&format_args!("2")))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn((1, 2));
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn destructure_nested_tuples() {
+ #[instrument]
+ fn my_fn(((arg1, arg2), (arg3, arg4)): ((usize, usize), (usize, usize))) {}
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("1"))
+ .and(expect::field("arg2").with_value(&format_args!("2")))
+ .and(expect::field("arg3").with_value(&format_args!("3")))
+ .and(expect::field("arg4").with_value(&format_args!("4")))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(((1, 2), (3, 4)));
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn destructure_refs() {
+ #[instrument]
+ fn my_fn(&arg1: &usize) {}
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone()
+ .with_field(expect::field("arg1").with_value(&1usize).only()),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(&1);
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn destructure_tuple_structs() {
+ struct Foo(usize, usize);
+
+ #[instrument]
+ fn my_fn(Foo(arg1, arg2): Foo) {}
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("1"))
+ .and(expect::field("arg2").with_value(&format_args!("2")))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(Foo(1, 2));
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn destructure_structs() {
+ struct Foo {
+ bar: usize,
+ baz: usize,
+ }
+
+ #[instrument]
+ fn my_fn(
+ Foo {
+ bar: arg1,
+ baz: arg2,
+ }: Foo,
+ ) {
+ let _ = (arg1, arg2);
+ }
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("1"))
+ .and(expect::field("arg2").with_value(&format_args!("2")))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(Foo { bar: 1, baz: 2 });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn destructure_everything() {
+ struct Foo {
+ bar: Bar,
+ baz: (usize, usize),
+ qux: NoDebug,
+ }
+ struct Bar((usize, usize));
+ struct NoDebug;
+
+ #[instrument]
+ fn my_fn(
+ &Foo {
+ bar: Bar((arg1, arg2)),
+ baz: (arg3, arg4),
+ ..
+ }: &Foo,
+ ) {
+ let _ = (arg1, arg2, arg3, arg4);
+ }
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("1"))
+ .and(expect::field("arg2").with_value(&format_args!("2")))
+ .and(expect::field("arg3").with_value(&format_args!("3")))
+ .and(expect::field("arg4").with_value(&format_args!("4")))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = Foo {
+ bar: Bar((1, 2)),
+ baz: (3, 4),
+ qux: NoDebug,
+ };
+ let _ = foo.qux; // to eliminate unused field warning
+ my_fn(&foo);
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/err.rs b/crates/tracing-attributes/tests/err.rs
new file mode 100644
index 0000000..bee7aa5
--- /dev/null
+++ b/crates/tracing-attributes/tests/err.rs
@@ -0,0 +1,327 @@
+use tracing::subscriber::with_default;
+use tracing::Level;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+use tracing_subscriber::filter::EnvFilter;
+use tracing_subscriber::layer::SubscriberExt;
+
+use std::convert::TryFrom;
+use std::num::TryFromIntError;
+
+#[instrument(err)]
+fn err() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[instrument(err)]
+fn err_suspicious_else() -> Result<u8, TryFromIntError> {
+ {}
+ u8::try_from(1234)
+}
+
+#[test]
+fn test() {
+ let span = expect::span().named("err");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err().ok());
+ handle.assert_finished();
+}
+
+#[instrument(err)]
+fn err_early_return() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)?;
+ Ok(5)
+}
+
+#[test]
+fn test_early_return() {
+ let span = expect::span().named("err_early_return");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_early_return().ok());
+ handle.assert_finished();
+}
+
+#[instrument(err)]
+async fn err_async(polls: usize) -> Result<u8, TryFromIntError> {
+ let future = PollN::new_ok(polls);
+ tracing::trace!(awaiting = true);
+ future.await.ok();
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_async() {
+ let span = expect::span().named("err_async");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("awaiting").with_value(&true))
+ .at_level(Level::TRACE),
+ )
+ .exit(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ block_on_future(async { err_async(2).await }).ok();
+ });
+ handle.assert_finished();
+}
+
+#[instrument(err)]
+fn err_mut(out: &mut u8) -> Result<(), TryFromIntError> {
+ *out = u8::try_from(1234)?;
+ Ok(())
+}
+
+#[test]
+fn test_mut() {
+ let span = expect::span().named("err_mut");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_mut(&mut 0).ok());
+ handle.assert_finished();
+}
+
+#[instrument(err)]
+async fn err_mut_async(polls: usize, out: &mut u8) -> Result<(), TryFromIntError> {
+ let future = PollN::new_ok(polls);
+ tracing::trace!(awaiting = true);
+ future.await.ok();
+ *out = u8::try_from(1234)?;
+ Ok(())
+}
+
+#[test]
+fn test_mut_async() {
+ let span = expect::span().named("err_mut_async");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("awaiting").with_value(&true))
+ .at_level(Level::TRACE),
+ )
+ .exit(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ block_on_future(async { err_mut_async(2, &mut 0).await }).ok();
+ });
+ handle.assert_finished();
+}
+
+#[test]
+fn impl_trait_return_type() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/1227
+
+ #[instrument(err)]
+ fn returns_impl_trait(x: usize) -> Result<impl Iterator<Item = usize>, String> {
+ Ok(0..x)
+ }
+
+ let span = expect::span().named("returns_impl_trait");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone()
+ .with_field(expect::field("x").with_value(&10usize).only()),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ for _ in returns_impl_trait(10).unwrap() {
+ // nop
+ }
+ });
+
+ handle.assert_finished();
+}
+
+#[instrument(err(Debug))]
+fn err_dbg() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_err_dbg() {
+ let span = expect::span().named("err_dbg");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event().at_level(Level::ERROR).with_fields(
+ expect::field("error")
+ // use the actual error value that will be emitted, so
+ // that this test doesn't break if the standard library
+ // changes the `fmt::Debug` output from the error type
+ // in the future.
+ .with_value(&tracing::field::debug(u8::try_from(1234).unwrap_err())),
+ ),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_dbg().ok());
+ handle.assert_finished();
+}
+
+#[test]
+fn test_err_display_default() {
+ let span = expect::span().named("err");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event().at_level(Level::ERROR).with_fields(
+ expect::field("error")
+ // by default, errors will be emitted with their display values
+ .with_value(&tracing::field::display(u8::try_from(1234).unwrap_err())),
+ ),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err().ok());
+ handle.assert_finished();
+}
+
+#[test]
+fn test_err_custom_target() {
+ let filter: EnvFilter = "my_target=error".parse().expect("filter should parse");
+ let span = expect::span().named("error_span").with_target("my_target");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::ERROR)
+ .with_target("my_target"),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ let error_span = tracing::error_span!(target: "my_target", "error_span");
+
+ {
+ let _enter = error_span.enter();
+ tracing::error!(target: "my_target", "This should display")
+ }
+ });
+ handle.assert_finished();
+}
+
+#[instrument(err(level = "info"))]
+fn err_info() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_err_info() {
+ let span = expect::span().named("err_info");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::INFO))
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_info().ok());
+ handle.assert_finished();
+}
+
+#[instrument(err(Debug, level = "info"))]
+fn err_dbg_info() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_err_dbg_info() {
+ let span = expect::span().named("err_dbg_info");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event().at_level(Level::INFO).with_fields(
+ expect::field("error")
+ // use the actual error value that will be emitted, so
+ // that this test doesn't break if the standard library
+ // changes the `fmt::Debug` output from the error type
+ // in the future.
+ .with_value(&tracing::field::debug(u8::try_from(1234).unwrap_err())),
+ ),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_dbg_info().ok());
+ handle.assert_finished();
+}
+
+#[instrument(level = "warn", err(level = "info"))]
+fn err_warn_info() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_err_warn_info() {
+ let span = expect::span().named("err_warn_info").at_level(Level::WARN);
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(expect::event().at_level(Level::INFO))
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || err_warn_info().ok());
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/fields.rs b/crates/tracing-attributes/tests/fields.rs
new file mode 100644
index 0000000..a3b23d7
--- /dev/null
+++ b/crates/tracing-attributes/tests/fields.rs
@@ -0,0 +1,159 @@
+use tracing::subscriber::with_default;
+use tracing_attributes::instrument;
+use tracing_mock::{expect, span::NewSpan, subscriber};
+
+#[instrument(fields(foo = "bar", dsa = true, num = 1))]
+fn fn_no_param() {}
+
+#[instrument(fields(foo = "bar"))]
+fn fn_param(param: u32) {}
+
+#[instrument(fields(foo = "bar", empty))]
+fn fn_empty_field() {}
+
+#[instrument(fields(len = s.len()))]
+fn fn_expr_field(s: &str) {}
+
+#[instrument(fields(s.len = s.len(), s.is_empty = s.is_empty()))]
+fn fn_two_expr_fields(s: &str) {
+ let _ = s;
+}
+
+#[instrument(fields(%s, s.len = s.len()))]
+fn fn_clashy_expr_field(s: &str) {
+ let _ = s;
+}
+
+#[instrument(fields(s = "s"))]
+fn fn_clashy_expr_field2(s: &str) {
+ let _ = s;
+}
+
+#[instrument(fields(s = &s))]
+fn fn_string(s: String) {
+ let _ = s;
+}
+
+#[derive(Debug)]
+struct HasField {
+ my_field: &'static str,
+}
+
+impl HasField {
+ #[instrument(fields(my_field = self.my_field), skip(self))]
+ fn self_expr_field(&self) {}
+}
+
+#[test]
+fn fields() {
+ let span = expect::span().with_field(
+ expect::field("foo")
+ .with_value(&"bar")
+ .and(expect::field("dsa").with_value(&true))
+ .and(expect::field("num").with_value(&1))
+ .only(),
+ );
+ run_test(span, || {
+ fn_no_param();
+ });
+}
+
+#[test]
+fn expr_field() {
+ let span = expect::span().with_field(
+ expect::field("s")
+ .with_value(&"hello world")
+ .and(expect::field("len").with_value(&"hello world".len()))
+ .only(),
+ );
+ run_test(span, || {
+ fn_expr_field("hello world");
+ });
+}
+
+#[test]
+fn two_expr_fields() {
+ let span = expect::span().with_field(
+ expect::field("s")
+ .with_value(&"hello world")
+ .and(expect::field("s.len").with_value(&"hello world".len()))
+ .and(expect::field("s.is_empty").with_value(&false))
+ .only(),
+ );
+ run_test(span, || {
+ fn_two_expr_fields("hello world");
+ });
+}
+
+#[test]
+fn clashy_expr_field() {
+ let span = expect::span().with_field(
+ // Overriding the `s` field should record `s` as a `Display` value,
+ // rather than as a `Debug` value.
+ expect::field("s")
+ .with_value(&tracing::field::display("hello world"))
+ .and(expect::field("s.len").with_value(&"hello world".len()))
+ .only(),
+ );
+ run_test(span, || {
+ fn_clashy_expr_field("hello world");
+ });
+
+ let span = expect::span().with_field(expect::field("s").with_value(&"s").only());
+ run_test(span, || {
+ fn_clashy_expr_field2("hello world");
+ });
+}
+
+#[test]
+fn self_expr_field() {
+ let span =
+ expect::span().with_field(expect::field("my_field").with_value(&"hello world").only());
+ run_test(span, || {
+ let has_field = HasField {
+ my_field: "hello world",
+ };
+ has_field.self_expr_field();
+ });
+}
+
+#[test]
+fn parameters_with_fields() {
+ let span = expect::span().with_field(
+ expect::field("foo")
+ .with_value(&"bar")
+ .and(expect::field("param").with_value(&1u32))
+ .only(),
+ );
+ run_test(span, || {
+ fn_param(1);
+ });
+}
+
+#[test]
+fn empty_field() {
+ let span = expect::span().with_field(expect::field("foo").with_value(&"bar").only());
+ run_test(span, || {
+ fn_empty_field();
+ });
+}
+
+#[test]
+fn string_field() {
+ let span = expect::span().with_field(expect::field("s").with_value(&"hello world").only());
+ run_test(span, || {
+ fn_string(String::from("hello world"));
+ });
+}
+
+fn run_test<F: FnOnce() -> T, T>(span: NewSpan, fun: F) {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span)
+ .enter(expect::span())
+ .exit(expect::span())
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, fun);
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/follows_from.rs b/crates/tracing-attributes/tests/follows_from.rs
new file mode 100644
index 0000000..6b5526b
--- /dev/null
+++ b/crates/tracing-attributes/tests/follows_from.rs
@@ -0,0 +1,101 @@
+use tracing::{subscriber::with_default, Id, Level, Span};
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[instrument(follows_from = causes, skip(causes))]
+fn with_follows_from_sync(causes: impl IntoIterator<Item = impl Into<Option<Id>>>) {}
+
+#[instrument(follows_from = causes, skip(causes))]
+async fn with_follows_from_async(causes: impl IntoIterator<Item = impl Into<Option<Id>>>) {}
+
+#[instrument(follows_from = [&Span::current()])]
+fn follows_from_current() {}
+
+#[test]
+fn follows_from_sync_test() {
+ let cause_a = expect::span().named("cause_a");
+ let cause_b = expect::span().named("cause_b");
+ let cause_c = expect::span().named("cause_c");
+ let consequence = expect::span().named("with_follows_from_sync");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(cause_a.clone())
+ .new_span(cause_b.clone())
+ .new_span(cause_c.clone())
+ .new_span(consequence.clone())
+ .follows_from(consequence.clone(), cause_a)
+ .follows_from(consequence.clone(), cause_b)
+ .follows_from(consequence.clone(), cause_c)
+ .enter(consequence.clone())
+ .exit(consequence)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let cause_a = tracing::span!(Level::TRACE, "cause_a");
+ let cause_b = tracing::span!(Level::TRACE, "cause_b");
+ let cause_c = tracing::span!(Level::TRACE, "cause_c");
+
+ with_follows_from_sync(&[cause_a, cause_b, cause_c])
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn follows_from_async_test() {
+ let cause_a = expect::span().named("cause_a");
+ let cause_b = expect::span().named("cause_b");
+ let cause_c = expect::span().named("cause_c");
+ let consequence = expect::span().named("with_follows_from_async");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(cause_a.clone())
+ .new_span(cause_b.clone())
+ .new_span(cause_c.clone())
+ .new_span(consequence.clone())
+ .follows_from(consequence.clone(), cause_a)
+ .follows_from(consequence.clone(), cause_b)
+ .follows_from(consequence.clone(), cause_c)
+ .enter(consequence.clone())
+ .exit(consequence.clone())
+ .enter(consequence.clone())
+ .exit(consequence)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ block_on_future(async {
+ let cause_a = tracing::span!(Level::TRACE, "cause_a");
+ let cause_b = tracing::span!(Level::TRACE, "cause_b");
+ let cause_c = tracing::span!(Level::TRACE, "cause_c");
+
+ with_follows_from_async(&[cause_a, cause_b, cause_c]).await
+ })
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn follows_from_current_test() {
+ let cause = expect::span().named("cause");
+ let consequence = expect::span().named("follows_from_current");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(cause.clone())
+ .enter(cause.clone())
+ .new_span(consequence.clone())
+ .follows_from(consequence.clone(), cause.clone())
+ .enter(consequence.clone())
+ .exit(consequence)
+ .exit(cause)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "cause").in_scope(follows_from_current)
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/instrument.rs b/crates/tracing-attributes/tests/instrument.rs
new file mode 100644
index 0000000..f751eeb
--- /dev/null
+++ b/crates/tracing-attributes/tests/instrument.rs
@@ -0,0 +1,252 @@
+use tracing::subscriber::with_default;
+use tracing::Level;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+// Reproduces a compile error when an instrumented function body contains inner
+// attributes (https://github.com/tokio-rs/tracing/issues/2294).
+#[deny(unused_variables)]
+#[instrument]
+fn repro_2294() {
+ #![allow(unused_variables)]
+ let i = 42;
+}
+
+#[test]
+fn override_everything() {
+ #[instrument(target = "my_target", level = "debug")]
+ fn my_fn() {}
+
+ #[instrument(level = Level::DEBUG, target = "my_target")]
+ fn my_other_fn() {}
+
+ let span = expect::span()
+ .named("my_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+ let span2 = expect::span()
+ .named("my_other_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .new_span(span2.clone())
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn();
+ my_other_fn();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn fields() {
+ #[instrument(target = "my_target", level = "debug")]
+ fn my_fn(arg1: usize, arg2: bool) {}
+
+ let span = expect::span()
+ .named("my_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+
+ let span2 = expect::span()
+ .named("my_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&2usize)
+ .and(expect::field("arg2").with_value(&false))
+ .only(),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .new_span(
+ span2.clone().with_field(
+ expect::field("arg1")
+ .with_value(&3usize)
+ .and(expect::field("arg2").with_value(&true))
+ .only(),
+ ),
+ )
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(2, false);
+ my_fn(3, true);
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn skip() {
+ struct UnDebug(pub u32);
+
+ #[instrument(target = "my_target", level = "debug", skip(_arg2, _arg3))]
+ fn my_fn(arg1: usize, _arg2: UnDebug, _arg3: UnDebug) {}
+
+ #[instrument(target = "my_target", level = "debug", skip_all)]
+ fn my_fn2(_arg1: usize, _arg2: UnDebug, _arg3: UnDebug) {}
+
+ let span = expect::span()
+ .named("my_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+
+ let span2 = expect::span()
+ .named("my_fn")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+
+ let span3 = expect::span()
+ .named("my_fn2")
+ .at_level(Level::DEBUG)
+ .with_target("my_target");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone()
+ .with_field(expect::field("arg1").with_value(&2usize).only()),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .new_span(
+ span2
+ .clone()
+ .with_field(expect::field("arg1").with_value(&3usize).only()),
+ )
+ .enter(span2.clone())
+ .exit(span2.clone())
+ .drop_span(span2)
+ .new_span(span3.clone())
+ .enter(span3.clone())
+ .exit(span3.clone())
+ .drop_span(span3)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(2, UnDebug(0), UnDebug(1));
+ my_fn(3, UnDebug(0), UnDebug(1));
+ my_fn2(2, UnDebug(0), UnDebug(1));
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn generics() {
+ #[derive(Debug)]
+ struct Foo;
+
+ #[instrument]
+ fn my_fn<S, T: std::fmt::Debug>(arg1: S, arg2: T)
+ where
+ S: std::fmt::Debug,
+ {
+ }
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("arg1")
+ .with_value(&format_args!("Foo"))
+ .and(expect::field("arg2").with_value(&format_args!("false"))),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ my_fn(Foo, false);
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn methods() {
+ #[derive(Debug)]
+ struct Foo;
+
+ impl Foo {
+ #[instrument]
+ fn my_fn(&self, arg1: usize) {}
+ }
+
+ let span = expect::span().named("my_fn");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone().with_field(
+ expect::field("self")
+ .with_value(&format_args!("Foo"))
+ .and(expect::field("arg1").with_value(&42usize)),
+ ),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = Foo;
+ foo.my_fn(42);
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn impl_trait_return_type() {
+ #[instrument]
+ fn returns_impl_trait(x: usize) -> impl Iterator<Item = usize> {
+ 0..x
+ }
+
+ let span = expect::span().named("returns_impl_trait");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ span.clone()
+ .with_field(expect::field("x").with_value(&10usize).only()),
+ )
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ for _ in returns_impl_trait(10) {
+ // nop
+ }
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/levels.rs b/crates/tracing-attributes/tests/levels.rs
new file mode 100644
index 0000000..ed80dc1
--- /dev/null
+++ b/crates/tracing-attributes/tests/levels.rs
@@ -0,0 +1,142 @@
+use tracing::subscriber::with_default;
+use tracing::Level;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[test]
+fn named_levels() {
+ #[instrument(level = "trace")]
+ fn trace() {}
+
+ #[instrument(level = "Debug")]
+ fn debug() {}
+
+ #[instrument(level = "INFO")]
+ fn info() {}
+
+ #[instrument(level = "WARn")]
+ fn warn() {}
+
+ #[instrument(level = "eRrOr")]
+ fn error() {}
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("trace").at_level(Level::TRACE))
+ .enter(expect::span().named("trace").at_level(Level::TRACE))
+ .exit(expect::span().named("trace").at_level(Level::TRACE))
+ .new_span(expect::span().named("debug").at_level(Level::DEBUG))
+ .enter(expect::span().named("debug").at_level(Level::DEBUG))
+ .exit(expect::span().named("debug").at_level(Level::DEBUG))
+ .new_span(expect::span().named("info").at_level(Level::INFO))
+ .enter(expect::span().named("info").at_level(Level::INFO))
+ .exit(expect::span().named("info").at_level(Level::INFO))
+ .new_span(expect::span().named("warn").at_level(Level::WARN))
+ .enter(expect::span().named("warn").at_level(Level::WARN))
+ .exit(expect::span().named("warn").at_level(Level::WARN))
+ .new_span(expect::span().named("error").at_level(Level::ERROR))
+ .enter(expect::span().named("error").at_level(Level::ERROR))
+ .exit(expect::span().named("error").at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ trace();
+ debug();
+ info();
+ warn();
+ error();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn numeric_levels() {
+ #[instrument(level = 1)]
+ fn trace() {}
+
+ #[instrument(level = 2)]
+ fn debug() {}
+
+ #[instrument(level = 3)]
+ fn info() {}
+
+ #[instrument(level = 4)]
+ fn warn() {}
+
+ #[instrument(level = 5)]
+ fn error() {}
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("trace").at_level(Level::TRACE))
+ .enter(expect::span().named("trace").at_level(Level::TRACE))
+ .exit(expect::span().named("trace").at_level(Level::TRACE))
+ .new_span(expect::span().named("debug").at_level(Level::DEBUG))
+ .enter(expect::span().named("debug").at_level(Level::DEBUG))
+ .exit(expect::span().named("debug").at_level(Level::DEBUG))
+ .new_span(expect::span().named("info").at_level(Level::INFO))
+ .enter(expect::span().named("info").at_level(Level::INFO))
+ .exit(expect::span().named("info").at_level(Level::INFO))
+ .new_span(expect::span().named("warn").at_level(Level::WARN))
+ .enter(expect::span().named("warn").at_level(Level::WARN))
+ .exit(expect::span().named("warn").at_level(Level::WARN))
+ .new_span(expect::span().named("error").at_level(Level::ERROR))
+ .enter(expect::span().named("error").at_level(Level::ERROR))
+ .exit(expect::span().named("error").at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ trace();
+ debug();
+ info();
+ warn();
+ error();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn enum_levels() {
+ #[instrument(level = Level::TRACE)]
+ fn trace() {}
+
+ #[instrument(level = Level::DEBUG)]
+ fn debug() {}
+
+ #[instrument(level = tracing::Level::INFO)]
+ fn info() {}
+
+ #[instrument(level = Level::WARN)]
+ fn warn() {}
+
+ #[instrument(level = Level::ERROR)]
+ fn error() {}
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("trace").at_level(Level::TRACE))
+ .enter(expect::span().named("trace").at_level(Level::TRACE))
+ .exit(expect::span().named("trace").at_level(Level::TRACE))
+ .new_span(expect::span().named("debug").at_level(Level::DEBUG))
+ .enter(expect::span().named("debug").at_level(Level::DEBUG))
+ .exit(expect::span().named("debug").at_level(Level::DEBUG))
+ .new_span(expect::span().named("info").at_level(Level::INFO))
+ .enter(expect::span().named("info").at_level(Level::INFO))
+ .exit(expect::span().named("info").at_level(Level::INFO))
+ .new_span(expect::span().named("warn").at_level(Level::WARN))
+ .enter(expect::span().named("warn").at_level(Level::WARN))
+ .exit(expect::span().named("warn").at_level(Level::WARN))
+ .new_span(expect::span().named("error").at_level(Level::ERROR))
+ .enter(expect::span().named("error").at_level(Level::ERROR))
+ .exit(expect::span().named("error").at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ trace();
+ debug();
+ info();
+ warn();
+ error();
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/names.rs b/crates/tracing-attributes/tests/names.rs
new file mode 100644
index 0000000..03e3dbf
--- /dev/null
+++ b/crates/tracing-attributes/tests/names.rs
@@ -0,0 +1,63 @@
+use tracing::subscriber::with_default;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[instrument]
+fn default_name() {}
+
+#[instrument(name = "my_name")]
+fn custom_name() {}
+
+// XXX: it's weird that we support both of these forms, but apparently we
+// managed to release a version that accepts both syntax, so now we have to
+// support it! yay!
+#[instrument("my_other_name")]
+fn custom_name_no_equals() {}
+
+#[test]
+fn default_name_test() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("default_name"))
+ .enter(expect::span().named("default_name"))
+ .exit(expect::span().named("default_name"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ default_name();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn custom_name_test() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("my_name"))
+ .enter(expect::span().named("my_name"))
+ .exit(expect::span().named("my_name"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ custom_name();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn custom_name_no_equals_test() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("my_other_name"))
+ .enter(expect::span().named("my_other_name"))
+ .exit(expect::span().named("my_other_name"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ custom_name_no_equals();
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/parents.rs b/crates/tracing-attributes/tests/parents.rs
new file mode 100644
index 0000000..d455941
--- /dev/null
+++ b/crates/tracing-attributes/tests/parents.rs
@@ -0,0 +1,102 @@
+use tracing::{subscriber::with_default, Id, Level};
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[instrument]
+fn with_default_parent() {}
+
+#[instrument(parent = parent_span, skip(parent_span))]
+fn with_explicit_parent<P>(parent_span: P)
+where
+ P: Into<Option<Id>>,
+{
+}
+
+#[test]
+fn default_parent_test() {
+ let contextual_parent = expect::span().named("contextual_parent");
+ let child = expect::span().named("with_default_parent");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ contextual_parent
+ .clone()
+ .with_contextual_parent(None)
+ .with_explicit_parent(None),
+ )
+ .new_span(
+ child
+ .clone()
+ .with_contextual_parent(Some("contextual_parent"))
+ .with_explicit_parent(None),
+ )
+ .enter(child.clone())
+ .exit(child.clone())
+ .enter(contextual_parent.clone())
+ .new_span(
+ child
+ .clone()
+ .with_contextual_parent(Some("contextual_parent"))
+ .with_explicit_parent(None),
+ )
+ .enter(child.clone())
+ .exit(child)
+ .exit(contextual_parent)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let contextual_parent = tracing::span!(Level::TRACE, "contextual_parent");
+
+ with_default_parent();
+
+ contextual_parent.in_scope(|| {
+ with_default_parent();
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn explicit_parent_test() {
+ let contextual_parent = expect::span().named("contextual_parent");
+ let explicit_parent = expect::span().named("explicit_parent");
+ let child = expect::span().named("with_explicit_parent");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ contextual_parent
+ .clone()
+ .with_contextual_parent(None)
+ .with_explicit_parent(None),
+ )
+ .new_span(
+ explicit_parent
+ .with_contextual_parent(None)
+ .with_explicit_parent(None),
+ )
+ .enter(contextual_parent.clone())
+ .new_span(
+ child
+ .clone()
+ .with_contextual_parent(Some("contextual_parent"))
+ .with_explicit_parent(Some("explicit_parent")),
+ )
+ .enter(child.clone())
+ .exit(child)
+ .exit(contextual_parent)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let contextual_parent = tracing::span!(Level::INFO, "contextual_parent");
+ let explicit_parent = tracing::span!(Level::INFO, "explicit_parent");
+
+ contextual_parent.in_scope(|| {
+ with_explicit_parent(&explicit_parent);
+ });
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/ret.rs b/crates/tracing-attributes/tests/ret.rs
new file mode 100644
index 0000000..90bd9e1
--- /dev/null
+++ b/crates/tracing-attributes/tests/ret.rs
@@ -0,0 +1,307 @@
+use std::convert::TryFrom;
+use std::num::TryFromIntError;
+use tracing_mock::*;
+
+use tracing::{subscriber::with_default, Level};
+use tracing_attributes::instrument;
+use tracing_subscriber::layer::SubscriberExt;
+use tracing_subscriber::EnvFilter;
+
+#[instrument(ret)]
+fn ret() -> i32 {
+ 42
+}
+
+#[instrument(target = "my_target", ret)]
+fn ret_with_target() -> i32 {
+ 42
+}
+
+#[test]
+fn test() {
+ let span = expect::span().named("ret");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret);
+ handle.assert_finished();
+}
+
+#[test]
+fn test_custom_target() {
+ let filter: EnvFilter = "my_target=info".parse().expect("filter should parse");
+ let span = expect::span()
+ .named("ret_with_target")
+ .with_target("my_target");
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::INFO)
+ .with_target("my_target"),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, ret_with_target);
+ handle.assert_finished();
+}
+
+#[instrument(level = "warn", ret)]
+fn ret_warn() -> i32 {
+ 42
+}
+
+#[test]
+fn test_warn() {
+ let span = expect::span().named("ret_warn");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::WARN),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret_warn);
+ handle.assert_finished();
+}
+
+#[instrument(ret)]
+fn ret_mut(a: &mut i32) -> i32 {
+ *a *= 2;
+ tracing::info!(?a);
+ *a
+}
+
+#[test]
+fn test_mut() {
+ let span = expect::span().named("ret_mut");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("a").with_value(&tracing::field::display(2)))
+ .at_level(Level::INFO),
+ )
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(2)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || ret_mut(&mut 1));
+ handle.assert_finished();
+}
+
+#[instrument(ret)]
+async fn ret_async() -> i32 {
+ 42
+}
+
+#[test]
+fn test_async() {
+ let span = expect::span().named("ret_async");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .enter(span.clone())
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || block_on_future(async { ret_async().await }));
+ handle.assert_finished();
+}
+
+#[instrument(ret)]
+fn ret_impl_type() -> impl Copy {
+ 42
+}
+
+#[test]
+fn test_impl_type() {
+ let span = expect::span().named("ret_impl_type");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret_impl_type);
+ handle.assert_finished();
+}
+
+#[instrument(ret(Display))]
+fn ret_display() -> i32 {
+ 42
+}
+
+#[test]
+fn test_dbg() {
+ let span = expect::span().named("ret_display");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::display(42)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret_display);
+ handle.assert_finished();
+}
+
+#[instrument(err, ret)]
+fn ret_and_err() -> Result<u8, TryFromIntError> {
+ u8::try_from(1234)
+}
+
+#[test]
+fn test_ret_and_err() {
+ let span = expect::span().named("ret_and_err");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(
+ expect::field("error")
+ .with_value(&tracing::field::display(u8::try_from(1234).unwrap_err()))
+ .only(),
+ )
+ .at_level(Level::ERROR),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || ret_and_err().ok());
+ handle.assert_finished();
+}
+
+#[instrument(err, ret)]
+fn ret_and_ok() -> Result<u8, TryFromIntError> {
+ u8::try_from(123)
+}
+
+#[test]
+fn test_ret_and_ok() {
+ let span = expect::span().named("ret_and_ok");
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(
+ expect::field("return")
+ .with_value(&tracing::field::debug(u8::try_from(123).unwrap()))
+ .only(),
+ )
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || ret_and_ok().ok());
+ handle.assert_finished();
+}
+
+#[instrument(level = "warn", ret(level = "info"))]
+fn ret_warn_info() -> i32 {
+ 42
+}
+
+#[test]
+fn test_warn_info() {
+ let span = expect::span().named("ret_warn_info").at_level(Level::WARN);
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::INFO),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret_warn_info);
+ handle.assert_finished();
+}
+
+#[instrument(ret(level = "warn", Debug))]
+fn ret_dbg_warn() -> i32 {
+ 42
+}
+
+#[test]
+fn test_dbg_warn() {
+ let span = expect::span().named("ret_dbg_warn").at_level(Level::INFO);
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(span.clone())
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .with_fields(expect::field("return").with_value(&tracing::field::debug(42)))
+ .at_level(Level::WARN),
+ )
+ .exit(span.clone())
+ .drop_span(span)
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, ret_dbg_warn);
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/targets.rs b/crates/tracing-attributes/tests/targets.rs
new file mode 100644
index 0000000..0e70287
--- /dev/null
+++ b/crates/tracing-attributes/tests/targets.rs
@@ -0,0 +1,109 @@
+use tracing::subscriber::with_default;
+use tracing_attributes::instrument;
+use tracing_mock::*;
+
+#[instrument]
+fn default_target() {}
+
+#[instrument(target = "my_target")]
+fn custom_target() {}
+
+mod my_mod {
+ use tracing_attributes::instrument;
+
+ pub const MODULE_PATH: &str = module_path!();
+
+ #[instrument]
+ pub fn default_target() {}
+
+ #[instrument(target = "my_other_target")]
+ pub fn custom_target() {}
+}
+
+#[test]
+fn default_targets() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("default_target")
+ .with_target(module_path!()),
+ )
+ .enter(
+ expect::span()
+ .named("default_target")
+ .with_target(module_path!()),
+ )
+ .exit(
+ expect::span()
+ .named("default_target")
+ .with_target(module_path!()),
+ )
+ .new_span(
+ expect::span()
+ .named("default_target")
+ .with_target(my_mod::MODULE_PATH),
+ )
+ .enter(
+ expect::span()
+ .named("default_target")
+ .with_target(my_mod::MODULE_PATH),
+ )
+ .exit(
+ expect::span()
+ .named("default_target")
+ .with_target(my_mod::MODULE_PATH),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ default_target();
+ my_mod::default_target();
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn custom_targets() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_target"),
+ )
+ .enter(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_target"),
+ )
+ .exit(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_target"),
+ )
+ .new_span(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_other_target"),
+ )
+ .enter(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_other_target"),
+ )
+ .exit(
+ expect::span()
+ .named("custom_target")
+ .with_target("my_other_target"),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ custom_target();
+ my_mod::custom_target();
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-attributes/tests/ui.rs b/crates/tracing-attributes/tests/ui.rs
new file mode 100644
index 0000000..73d7fdc
--- /dev/null
+++ b/crates/tracing-attributes/tests/ui.rs
@@ -0,0 +1,14 @@
+// Only test on nightly, since UI tests are bound to change over time
+#[rustversion::stable]
+#[test]
+fn async_instrument() {
+ let t = trybuild::TestCases::new();
+ t.compile_fail("tests/ui/async_instrument.rs");
+}
+
+#[rustversion::stable]
+#[test]
+fn const_instrument() {
+ let t = trybuild::TestCases::new();
+ t.compile_fail("tests/ui/const_instrument.rs");
+}
diff --git a/crates/tracing-attributes/tests/ui/async_instrument.rs b/crates/tracing-attributes/tests/ui/async_instrument.rs
new file mode 100644
index 0000000..5b24574
--- /dev/null
+++ b/crates/tracing-attributes/tests/ui/async_instrument.rs
@@ -0,0 +1,46 @@
+#![allow(unreachable_code)]
+
+#[tracing::instrument]
+async fn unit() {
+ ""
+}
+
+#[tracing::instrument]
+async fn simple_mismatch() -> String {
+ ""
+}
+
+// FIXME: this span is still pretty poor
+#[tracing::instrument]
+async fn opaque_unsatisfied() -> impl std::fmt::Display {
+ ("",)
+}
+
+struct Wrapper<T>(T);
+
+#[tracing::instrument]
+async fn mismatch_with_opaque() -> Wrapper<impl std::fmt::Display> {
+ ""
+}
+
+#[tracing::instrument]
+async fn early_return_unit() {
+ if true {
+ return "";
+ }
+}
+
+#[tracing::instrument]
+async fn early_return() -> String {
+ if true {
+ return "";
+ }
+ String::new()
+}
+
+#[tracing::instrument]
+async fn extra_semicolon() -> i32 {
+ 1;
+}
+
+fn main() {}
diff --git a/crates/tracing-attributes/tests/ui/async_instrument.stderr b/crates/tracing-attributes/tests/ui/async_instrument.stderr
new file mode 100644
index 0000000..2c64b0c
--- /dev/null
+++ b/crates/tracing-attributes/tests/ui/async_instrument.stderr
@@ -0,0 +1,98 @@
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:5:5
+ |
+5 | ""
+ | ^^ expected `()`, found `&str`
+ |
+note: return type inferred to be `()` here
+ --> tests/ui/async_instrument.rs:4:10
+ |
+4 | async fn unit() {
+ | ^^^^
+
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:10:5
+ |
+10 | ""
+ | ^^- help: try using a conversion method: `.to_string()`
+ | |
+ | expected `String`, found `&str`
+ |
+note: return type inferred to be `String` here
+ --> tests/ui/async_instrument.rs:9:31
+ |
+9 | async fn simple_mismatch() -> String {
+ | ^^^^^^
+
+error[E0277]: `(&str,)` doesn't implement `std::fmt::Display`
+ --> tests/ui/async_instrument.rs:14:1
+ |
+14 | #[tracing::instrument]
+ | ^^^^^^^^^^^^^^^^^^^^^^ `(&str,)` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `(&str,)`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+ = note: this error originates in the attribute macro `tracing::instrument` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error[E0277]: `(&str,)` doesn't implement `std::fmt::Display`
+ --> tests/ui/async_instrument.rs:15:34
+ |
+15 | async fn opaque_unsatisfied() -> impl std::fmt::Display {
+ | ^^^^^^^^^^^^^^^^^^^^^^ `(&str,)` cannot be formatted with the default formatter
+ |
+ = help: the trait `std::fmt::Display` is not implemented for `(&str,)`
+ = note: in format strings you may be able to use `{:?}` (or {:#?} for pretty-print) instead
+
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:23:5
+ |
+23 | ""
+ | ^^ expected `Wrapper<_>`, found `&str`
+ |
+ = note: expected struct `Wrapper<_>`
+ found reference `&'static str`
+note: return type inferred to be `Wrapper<_>` here
+ --> tests/ui/async_instrument.rs:22:36
+ |
+22 | async fn mismatch_with_opaque() -> Wrapper<impl std::fmt::Display> {
+ | ^^^^^^^
+help: try wrapping the expression in `Wrapper`
+ |
+23 | Wrapper("")
+ | ++++++++ +
+
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:29:16
+ |
+29 | return "";
+ | ^^ expected `()`, found `&str`
+ |
+note: return type inferred to be `()` here
+ --> tests/ui/async_instrument.rs:27:10
+ |
+27 | async fn early_return_unit() {
+ | ^^^^^^^^^^^^^^^^^
+
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:36:16
+ |
+36 | return "";
+ | ^^- help: try using a conversion method: `.to_string()`
+ | |
+ | expected `String`, found `&str`
+ |
+note: return type inferred to be `String` here
+ --> tests/ui/async_instrument.rs:34:28
+ |
+34 | async fn early_return() -> String {
+ | ^^^^^^
+
+error[E0308]: mismatched types
+ --> tests/ui/async_instrument.rs:42:35
+ |
+42 | async fn extra_semicolon() -> i32 {
+ | ___________________________________^
+43 | | 1;
+ | | - help: remove this semicolon to return this value
+44 | | }
+ | |_^ expected `i32`, found `()`
diff --git a/crates/tracing-attributes/tests/ui/const_instrument.rs b/crates/tracing-attributes/tests/ui/const_instrument.rs
new file mode 100644
index 0000000..a251e8f
--- /dev/null
+++ b/crates/tracing-attributes/tests/ui/const_instrument.rs
@@ -0,0 +1,8 @@
+#![allow(unreachable_code)]
+
+#[tracing::instrument]
+const fn unit() {
+ ""
+}
+
+fn main() {}
diff --git a/crates/tracing-attributes/tests/ui/const_instrument.stderr b/crates/tracing-attributes/tests/ui/const_instrument.stderr
new file mode 100644
index 0000000..e76d4ac
--- /dev/null
+++ b/crates/tracing-attributes/tests/ui/const_instrument.stderr
@@ -0,0 +1,15 @@
+error: macros that expand to items must be delimited with braces or followed by a semicolon
+ --> tests/ui/const_instrument.rs:3:1
+ |
+3 | #[tracing::instrument]
+ | ^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: this error originates in the attribute macro `tracing::instrument` (in Nightly builds, run with -Z macro-backtrace for more info)
+
+error: the `#[instrument]` attribute may not be used with `const fn`s
+ --> tests/ui/const_instrument.rs:3:1
+ |
+3 | #[tracing::instrument]
+ | ^^^^^^^^^^^^^^^^^^^^^^
+ |
+ = note: this error originates in the attribute macro `tracing::instrument` (in Nightly builds, run with -Z macro-backtrace for more info)
diff --git a/crates/tracing-core/.cargo-checksum.json b/crates/tracing-core/.cargo-checksum.json
new file mode 100644
index 0000000..a445372
--- /dev/null
+++ b/crates/tracing-core/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"5c72ced3c4b609b6121b0ca5f980f8292f8b542d3f11c7b97581f23fd6ab7e1b","Cargo.toml":"7ae6601ad9768415a61eba2be6c82e30c71c6d3c76561f230ce6eafa2e66255f","LICENSE":"898b1ae9821e98daf8964c8d6c7f61641f5f5aa78ad500020771c0939ee0dea1","README.md":"0ace2b660151cc4aa04d954daef0b60151c2f797d695dfb0b78d931f497c82ac","src/callsite.rs":"83789dd16601faa675e2c75e1bbfe1512c2d4b405b880bf99db2a6f6bbb15363","src/dispatcher.rs":"2a751f9256e8418105d1f7134fd80500f39b920c8a17b02eaf3dcd701d1737ad","src/event.rs":"f2673bf5d266972e567e521c9cd92fb33f28b0c7e010937e3bc2bf9eb483087f","src/field.rs":"0f7ec541d932beae7ee67d0fcb09cfeabacdcb4ee6310a7b20f9fb07a75e091f","src/lazy.rs":"318e3558e4446abf26294287167c0788e343044a28072f9217bd985929809087","src/lib.rs":"d0f56d6d890f721e1d769376f500dc3e80b7ac969330c98049c344fda47a107a","src/metadata.rs":"319e8a80804c7e927595e73d2139c027b2c4d58887af4a95ab2bb3411e7ab3d1","src/parent.rs":"5d5ad733343280a64a1feb6a008e186c39305ec554f14279012b8d7915821471","src/span.rs":"dcf2135e4ca158c1be45007f0be25426c375a4081f8f3c5a4d7f7382d8a950a4","src/spin/LICENSE":"58545fed1565e42d687aecec6897d35c6d37ccb71479a137c0deb2203e125c79","src/spin/mod.rs":"c458ce5e875acb7fbfb279f23254f4924d7c6d6fee419b740800d2e8087d1524","src/spin/mutex.rs":"4d30ff2b59b18fd7909f016e1abdf9aa0c04aa11d047a46e98cffe1319e32dad","src/spin/once.rs":"3781fd4eae0db04d80c03a039906c99b1e01d1583b29ac0144e6fbbd5a0fef0b","src/stdlib.rs":"698693062b8109cace3ffea02e9c2372b7d5b5d43c0b11cb4800b0e7b1a69971","src/subscriber.rs":"c7b6d52633e479bcad50fc30e1bf596339e575533761d269498cfc79e99020ef","tests/common/mod.rs":"0bbb217baa17df0f96cc1ff57dfa74ccc5a959e7f66b15bb7d25d5f43358a278","tests/dispatch.rs":"d3f000fab43734a854c82a7783142910c5e79f806cbd3f8ec5eded598c59ddb1","tests/global_dispatch.rs":"cdc05d77e448ee8b50bfb930abafa3f19b4c6f922b7bebc7797fa1dbdaa1d398","tests/local_dispatch_before_init.rs":"338846cd519e9a3a6895f958b11bd3f97e4350d08adb50f95b8552113a593b0d","tests/macros.rs":"b1603d888b349c8d103794deceec3b1ae4538b8d3eba805f3f561899e8ad0dd2"},"package":"c06d3da6113f116aaee68e4d601191614c9053067f9ab7f6edbcb161237daa54"}
\ No newline at end of file
diff --git a/crates/tracing-core/Android.bp b/crates/tracing-core/Android.bp
new file mode 100644
index 0000000..84b70b8
--- /dev/null
+++ b/crates/tracing-core/Android.bp
@@ -0,0 +1,159 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tracing-core_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tracing-core_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtracing_core",
+ host_supported: true,
+ crate_name: "tracing_core",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: ["libonce_cell"],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "tracing-core_test_src_lib",
+ host_supported: true,
+ crate_name: "tracing_core",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: ["libonce_cell"],
+}
+
+rust_test {
+ name: "tracing-core_test_tests_dispatch",
+ host_supported: true,
+ crate_name: "dispatch",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "tests/dispatch.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: [
+ "libonce_cell",
+ "libtracing_core",
+ ],
+}
+
+rust_test {
+ name: "tracing-core_test_tests_global_dispatch",
+ host_supported: true,
+ crate_name: "global_dispatch",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "tests/global_dispatch.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: [
+ "libonce_cell",
+ "libtracing_core",
+ ],
+}
+
+rust_test {
+ name: "tracing-core_test_tests_local_dispatch_before_init",
+ host_supported: true,
+ crate_name: "local_dispatch_before_init",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "tests/local_dispatch_before_init.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: [
+ "libonce_cell",
+ "libtracing_core",
+ ],
+}
+
+rust_test {
+ name: "tracing-core_test_tests_macros",
+ host_supported: true,
+ crate_name: "macros",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.32",
+ crate_root: "tests/macros.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "once_cell",
+ "std",
+ "valuable",
+ ],
+ rustlibs: [
+ "libonce_cell",
+ "libtracing_core",
+ ],
+}
diff --git a/crates/tracing-core/CHANGELOG.md b/crates/tracing-core/CHANGELOG.md
new file mode 100644
index 0000000..2e92f74
--- /dev/null
+++ b/crates/tracing-core/CHANGELOG.md
@@ -0,0 +1,541 @@
+# 0.1.32 (October 13, 2023)
+
+### Documented
+
+- Fix typo in `field` docs ([#2611])
+- Remove duplicate wording ([#2674])
+
+### Changed
+
+- Allow `ValueSet`s of any length ([#2508])
+
+[#2611]: https://github.com/tokio-rs/tracing/pull/2611
+[#2674]: https://github.com/tokio-rs/tracing/pull/2674
+[#2508]: https://github.com/tokio-rs/tracing/pull/2508
+
+# 0.1.31 (May 11, 2023)
+
+This release of `tracing-core` fixes a bug that caused threads which call
+`dispatcher::get_default` _before_ a global default subscriber is set to never
+see the global default once it is set. In addition, it includes improvements for
+instrumentation performance in some cases, especially when using a global
+default dispatcher.
+
+### Fixed
+
+- Fixed incorrect thread-local caching of `Dispatch::none` if
+ `dispatcher::get_default` is called before `dispatcher::set_global_default`
+ ([#2593])
+
+### Changed
+
+- Cloning a `Dispatch` that points at a global default subscriber no longer
+ requires an `Arc` reference count increment, improving performance
+ substantially ([#2593])
+- `dispatcher::get_default` no longer attempts to access a thread local if the
+ scoped dispatcher is not in use, improving performance when the default
+ dispatcher is global ([#2593])
+- Added `#[inline]` annotations called by the `event!` and `span!` macros to
+ reduce the size of macro-generated code and improve recording performance
+ ([#2555])
+
+Thanks to new contributor @ldm0 for contributing to this release!
+
+[#2593]: https://github.com/tokio-rs/tracing/pull/2593
+[#2555]: https://github.com/tokio-rs/tracing/pull/2555
+
+# 0.1.30 (October 6, 2022)
+
+This release of `tracing-core` adds a new `on_register_dispatch` method to the
+`Subscriber` trait to allow the `Subscriber` to perform initialization after
+being registered as a `Dispatch`, and a `WeakDispatch` type to allow a
+`Subscriber` to store its own `Dispatch` without creating reference count
+cycles.
+
+### Added
+
+- `Subscriber::on_register_dispatch` method ([#2269])
+- `WeakDispatch` type and `Dispatch::downgrade()` function ([#2293])
+
+Thanks to @jswrenn for contributing to this release!
+
+[#2269]: https://github.com/tokio-rs/tracing/pull/2269
+[#2293]: https://github.com/tokio-rs/tracing/pull/2293
+
+# 0.1.29 (July 29, 2022)
+
+This release of `tracing-core` adds `PartialEq` and `Eq` implementations for
+metadata types, and improves error messages when setting the global default
+subscriber fails.
+
+### Added
+
+- `PartialEq` and `Eq` implementations for `Metadata` ([#2229])
+- `PartialEq` and `Eq` implementations for `FieldSet` ([#2229])
+
+### Fixed
+
+- Fixed unhelpful `fmt::Debug` output for `dispatcher::SetGlobalDefaultError`
+ ([#2250])
+- Fixed compilation with `-Z minimal-versions` ([#2246])
+
+Thanks to @jswrenn and @CAD97 for contributing to this release!
+
+[#2229]: https://github.com/tokio-rs/tracing/pull/2229
+[#2246]: https://github.com/tokio-rs/tracing/pull/2246
+[#2250]: https://github.com/tokio-rs/tracing/pull/2250
+
+# 0.1.28 (June 23, 2022)
+
+This release of `tracing-core` adds new `Value` implementations, including one
+for `String`, to allow recording `&String` as a value without having to call
+`as_str()` or similar, and for 128-bit integers (`i128` and `u128`). In
+addition, it adds new methods and trait implementations for `Subscriber`s.
+
+### Added
+
+- `Value` implementation for `String` ([#2164])
+- `Value` implementation for `u128` and `i28` ([#2166])
+- `downcast_ref` and `is` methods for `dyn Subscriber + Sync`,
+ `dyn Subscriber + Send`, and `dyn Subscriber + Send + Sync` ([#2160])
+- `Subscriber::event_enabled` method to enable filtering based on `Event` field
+ values ([#2008])
+- `Subscriber` implementation for `Box<S: Subscriber + ?Sized>` and
+ `Arc<S: Subscriber + ?Sized>` ([#2161])
+
+Thanks to @jswrenn and @CAD97 for contributing to this release!
+
+[#2164]: https://github.com/tokio-rs/tracing/pull/2164
+[#2166]: https://github.com/tokio-rs/tracing/pull/2166
+[#2160]: https://github.com/tokio-rs/tracing/pull/2160
+[#2008]: https://github.com/tokio-rs/tracing/pull/2008
+[#2161]: https://github.com/tokio-rs/tracing/pull/2161
+
+# 0.1.27 (June 7, 2022)
+
+This release of `tracing-core` introduces a new `DefaultCallsite` type, which
+can be used by instrumentation crates rather than implementing their own
+callsite types. Using `DefaultCallsite` may offer reduced overhead from callsite
+registration.
+
+### Added
+
+- `DefaultCallsite`, a pre-written `Callsite` implementation for use in
+ instrumentation crates ([#2083])
+- `ValueSet::len` and `Record::len` methods returning the number of fields in a
+ `ValueSet` or `Record` ([#2152])
+
+### Changed
+
+- Replaced `lazy_static` dependency with `once_cell` ([#2147])
+
+### Documented
+
+- Added documentation to the `callsite` module ([#2088], [#2149])
+
+Thanks to new contributors @jamesmunns and @james7132 for contributing to this
+release!
+
+[#2083]: https://github.com/tokio-rs/tracing/pull/2083
+[#2152]: https://github.com/tokio-rs/tracing/pull/2152
+[#2147]: https://github.com/tokio-rs/tracing/pull/2147
+[#2088]: https://github.com/tokio-rs/tracing/pull/2088
+[#2149]: https://github.com/tokio-rs/tracing/pull/2149
+
+# 0.1.26 (April 14, 2022)
+
+This release adds a `Value` implementation for `Box<T: Value>` to allow
+recording boxed values more conveniently. In particular, this should improve
+the ergonomics of the implementations for `dyn std::error::Error` trait objects,
+including those added in [v0.1.25].
+
+### Added
+
+- `Value` implementation for `Box<T> where T: Value` ([#2071])
+
+### Fixed
+
+- Broken documentation links ([#2068])
+
+Thanks to new contributor @ben0x539 for contributing to this release!
+
+
+[v0.1.25]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.25
+[#2071]: https://github.com/tokio-rs/tracing/pull/2071
+[#2068]: https://github.com/tokio-rs/tracing/pull/2068
+
+# 0.1.25 (April 12, 2022)
+
+This release adds additional `Value` implementations for `std::error::Error`
+trait objects with auto trait bounds (`Send` and `Sync`), as Rust will not
+auto-coerce trait objects. Additionally, it fixes a bug when setting scoped
+dispatchers that was introduced in the previous release ([v0.1.24]).
+
+### Added
+
+- `Value` implementations for `dyn Error + Send + 'static`, `dyn Error + Send +
+ Sync + 'static`, `dyn Error + Sync + 'static` ([#2066])
+
+### Fixed
+
+- Failure to use the global default dispatcher if a thread has set a scoped
+ default prior to setting the global default, and unset the scoped default
+ after setting the global default ([#2065])
+
+Thanks to @lilyball for contributing to this release!
+
+[v0.1.24]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.24
+[#2066]: https://github.com/tokio-rs/tracing/pull/2066
+[#2065]: https://github.com/tokio-rs/tracing/pull/2065
+
+# 0.1.24 (April 1, 2022)
+
+This release fixes a bug where setting `NoSubscriber` as the local default would
+not disable the global default subscriber locally.
+
+### Fixed
+
+- Setting `NoSubscriber` as the local default now correctly disables the global
+ default subscriber ([#2001])
+- Fixed compilation warnings with the "std" feature disabled ([#2022])
+
+### Changed
+
+- Removed unnecessary use of `write!` and `format_args!` macros ([#1988])
+
+[#1988]: https://github.com/tokio-rs/tracing/pull/1988
+[#2001]: https://github.com/tokio-rs/tracing/pull/2001
+[#2022]: https://github.com/tokio-rs/tracing/pull/2022
+
+# 0.1.23 (March 8, 2022)
+
+### Changed
+
+- Removed `#[inline]` attributes from some `Dispatch` methods whose
+ callers are now inlined ([#1974])
+- Bumped minimum supported Rust version (MSRV) to Rust 1.49.0 ([#1913])
+
+[#1913]: https://github.com/tokio-rs/tracing/pull/1913
+[#1974]: https://github.com/tokio-rs/tracing/pull/1974
+
+# 0.1.22 (February 3, 2022)
+
+This release adds *experimental* support for recording structured field values
+using the [`valuable`] crate. See [this blog post][post] for details on
+`valuable`.
+
+Note that `valuable` support currently requires `--cfg tracing_unstable`. See
+the documentation for details.
+
+### Added
+
+- **field**: Experimental support for recording field values using the
+ [`valuable`] crate ([#1608], [#1888], [#1887])
+- **field**: Added `ValueSet::record` method ([#1823])
+- **subscriber**: `Default` impl for `NoSubscriber` ([#1785])
+- **metadata**: New `Kind::HINT` to support the `enabled!` macro in `tracing`
+ ([#1883], [#1891])
+### Fixed
+
+- Fixed a number of documentation issues ([#1665], [#1692], [#1737])
+
+Thanks to @xd009642, @Skepfyr, @guswynn, @Folyd, and @mbergkvist for
+contributing to this release!
+
+[`valuable`]: https://crates.io/crates/valuable
+[post]: https://tokio.rs/blog/2021-05-valuable
+[#1608]: https://github.com/tokio-rs/tracing/pull/1608
+[#1888]: https://github.com/tokio-rs/tracing/pull/1888
+[#1887]: https://github.com/tokio-rs/tracing/pull/1887
+[#1823]: https://github.com/tokio-rs/tracing/pull/1823
+[#1785]: https://github.com/tokio-rs/tracing/pull/1785
+[#1883]: https://github.com/tokio-rs/tracing/pull/1883
+[#1891]: https://github.com/tokio-rs/tracing/pull/1891
+[#1665]: https://github.com/tokio-rs/tracing/pull/1665
+[#1692]: https://github.com/tokio-rs/tracing/pull/1692
+[#1737]: https://github.com/tokio-rs/tracing/pull/1737
+
+# 0.1.21 (October 1, 2021)
+
+This release adds support for recording `Option<T> where T: Value` as typed
+`tracing` field values.
+
+### Added
+
+- **field**: `Value` impl for `Option<T> where T: Value` ([#1585])
+
+### Fixed
+
+- Fixed deprecation warnings when building with `default-features` disabled
+ ([#1603], [#1606])
+- Documentation fixes and improvements ([#1595], [#1601])
+
+Thanks to @brianburgers, @DCjanus, and @matklad for contributing to this
+release!
+
+[#1585]: https://github.com/tokio-rs/tracing/pull/1585
+[#1595]: https://github.com/tokio-rs/tracing/pull/1595
+[#1601]: https://github.com/tokio-rs/tracing/pull/1601
+[#1603]: https://github.com/tokio-rs/tracing/pull/1603
+[#1606]: https://github.com/tokio-rs/tracing/pull/1606
+
+# 0.1.20 (September 12, 2021)
+
+This release adds support for `f64` as one of the `tracing-core`
+primitive field values, allowing floating-point values to be recorded as
+typed values rather than with `fmt::Debug`. Additionally, it adds
+`NoSubscriber`, a `Subscriber` implementation that does nothing.
+
+### Added
+
+- **subscriber**: `NoSubscriber`, a no-op `Subscriber` implementation
+ ([#1549])
+- **field**: Added `Visit::record_f64` and support for recording
+ floating-point values ([#1507])
+
+Thanks to new contributors @jsgf and @maxburke for contributing to this
+release!
+
+[#1549]: https://github.com/tokio-rs/tracing/pull/1549
+[#1507]: https://github.com/tokio-rs/tracing/pull/1507
+
+# 0.1.19 (August 17, 2021)
+### Added
+
+- `Level::as_str` ([#1413])
+- `Hash` implementation for `Level` and `LevelFilter` ([#1456])
+- `Value` implementation for `&mut T where T: Value` ([#1385])
+- Multiple documentation fixes and improvements ([#1435], [#1446])
+
+Thanks to @Folyd, @teozkr, and @dvdplm for contributing to this release!
+
+[#1413]: https://github.com/tokio-rs/tracing/pull/1413
+[#1456]: https://github.com/tokio-rs/tracing/pull/1456
+[#1385]: https://github.com/tokio-rs/tracing/pull/1385
+[#1435]: https://github.com/tokio-rs/tracing/pull/1435
+[#1446]: https://github.com/tokio-rs/tracing/pull/1446
+
+# 0.1.18 (April 30, 2021)
+
+### Added
+
+- `Subscriber` impl for `Box<dyn Subscriber + Send + Sync + 'static>` ([#1358])
+- `Subscriber` impl for `Arc<dyn Subscriber + Send + Sync + 'static>` ([#1374])
+- Symmetric `From` impls for existing `Into` impls on `Current` and `Option<Id>`
+ ([#1335])
+- `Attributes::fields` accessor that returns the set of fields defined on a
+ span's `Attributes` ([#1331])
+
+
+Thanks to @Folyd for contributing to this release!
+
+[#1358]: https://github.com/tokio-rs/tracing/pull/1358
+[#1374]: https://github.com/tokio-rs/tracing/pull/1374
+[#1335]: https://github.com/tokio-rs/tracing/pull/1335
+[#1331]: https://github.com/tokio-rs/tracing/pull/1331
+
+# 0.1.17 (September 28, 2020)
+
+### Fixed
+
+- Incorrect inlining of `Event::dispatch` and `Event::child_of`, which could
+ result in `dispatcher::get_default` being inlined at the callsite ([#994])
+
+### Added
+
+- `Copy` implementations for `Level` and `LevelFilter` ([#992])
+
+Thanks to new contributors @jyn514 and @TaKO8Ki for contributing to this
+release!
+
+[#994]: https://github.com/tokio-rs/tracing/pull/994
+[#992]: https://github.com/tokio-rs/tracing/pull/992
+
+# 0.1.16 (September 8, 2020)
+
+### Fixed
+
+- Added a conversion from `Option<Level>` to `LevelFilter`. This resolves a
+ previously unreported regression where `Option<Level>` was no longer
+ a valid LevelFilter. ([#966](https://github.com/tokio-rs/tracing/pull/966))
+
+# 0.1.15 (August 22, 2020)
+
+### Fixed
+
+- When combining `Interest` from multiple subscribers, if the interests differ,
+ the current subscriber is now always asked if a callsite should be enabled
+ (#927)
+
+## Added
+
+- Internal API changes to support optimizations in the `tracing` crate (#943)
+- **docs**: Multiple fixes and improvements (#913, #941)
+
+# 0.1.14 (August 10, 2020)
+
+### Fixed
+
+- Incorrect calculation of global max level filter which could result in fast
+ filtering paths not being taken (#908)
+
+# 0.1.13 (August 4, 2020)
+
+### Fixed
+
+- Missing `fmt::Display` impl for `field::DisplayValue` causing a compilation
+ failure when the "log" feature is enabled (#887)
+
+Thanks to @d-e-s-o for contributing to this release!
+
+# 0.1.12 (July 31, 2020)
+
+### Added
+
+- `LevelFilter` type and `LevelFilter::current()` for returning the highest level
+ that any subscriber will enable (#853)
+- `Subscriber::max_level_hint` optional trait method, for setting the value
+ returned by `LevelFilter::current()` (#853)
+
+### Fixed
+
+- **docs**: Removed outdated reference to a Tokio API that no longer exists
+ (#857)
+
+Thanks to new contributor @dignati for contributing to this release!
+
+# 0.1.11 (June 8, 2020)
+
+### Changed
+
+- Replaced use of `inner_local_macros` with `$crate::` (#729)
+
+### Added
+
+- `must_use` warning to guards returned by `dispatcher::set_default` (#686)
+- `fmt::Debug` impl to `dyn Value`s (#696)
+- Functions to convert between `span::Id` and `NonZeroU64` (#770)
+- More obvious warnings in documentation (#769)
+
+### Fixed
+
+- Compiler error when `tracing-core/std` feature is enabled but `tracing/std` is
+ not (#760)
+- Clippy warning on vtable address comparison in `callsite::Identifier` (#749)
+- Documentation formatting issues (#715, #771)
+
+Thanks to @bkchr, @majecty, @taiki-e, @nagisa, and @nvzqz for contributing to
+this release!
+
+# 0.1.10 (January 24, 2020)
+
+### Added
+
+- `field::Empty` type for declaring empty fields whose values will be recorded
+ later (#548)
+- `field::Value` implementations for `Wrapping` and `NonZero*` numbers (#538)
+
+### Fixed
+
+- Broken and unresolvable links in RustDoc (#595)
+
+Thanks to @oli-cosmian for contributing to this release!
+
+# 0.1.9 (January 10, 2020)
+
+### Added
+
+- API docs now show what feature flags are required to enable each item (#523)
+
+### Fixed
+
+- A panic when the current default subscriber subscriber calls
+ `dispatcher::with_default` as it is being dropped (#522)
+- Incorrect documentation for `Subscriber::drop_span` (#524)
+
+# 0.1.8 (December 20, 2019)
+
+### Added
+
+- `Default` impl for `Dispatch` (#411)
+
+### Fixed
+
+- Removed duplicate `lazy_static` dependencies (#424)
+- Fixed no-std dependencies being enabled even when `std` feature flag is set
+ (#424)
+- Broken link to `Metadata` in `Event` docs (#461)
+
+# 0.1.7 (October 18, 2019)
+
+### Added
+
+- Added `dispatcher::set_default` API which returns a drop guard (#388)
+
+### Fixed
+
+- Added missing `Value` impl for `u8` (#392)
+- Broken links in docs.
+
+# 0.1.6 (September 12, 2019)
+
+### Added
+
+- Internal APIs to support performance optimizations (#326)
+
+### Fixed
+
+- Clarified wording in `field::display` documentation (#340)
+
+# 0.1.5 (August 16, 2019)
+
+### Added
+
+- `std::error::Error` as a new primitive `Value` type (#277)
+- `Event::new` and `Event::new_child_of` to manually construct `Event`s (#281)
+
+# 0.1.4 (August 9, 2019)
+
+### Added
+
+- Support for `no-std` + `liballoc` (#256)
+
+### Fixed
+
+- Broken links in RustDoc (#259)
+
+# 0.1.3 (August 8, 2019)
+
+### Added
+
+- `std::fmt::Display` implementation for `Level` (#194)
+- `std::str::FromStr` implementation for `Level` (#195)
+
+# 0.1.2 (July 10, 2019)
+
+### Deprecated
+
+- `Subscriber::drop_span` in favor of new `Subscriber::try_close` (#168)
+
+### Added
+
+- `Into<Option<&Id>>`, `Into<Option<Id>>`, and
+ `Into<Option<&'static Metadata<'static>>>` impls for `span::Current` (#170)
+- `Subscriber::try_close` method (#153)
+- Improved documentation for `dispatcher` (#171)
+
+# 0.1.1 (July 6, 2019)
+
+### Added
+
+- `Subscriber::current_span` API to return the current span (#148).
+- `span::Current` type, representing the `Subscriber`'s view of the current
+ span (#148).
+
+### Fixed
+
+- Typos and broken links in documentation (#123, #124, #128, #154)
+
+# 0.1.0 (June 27, 2019)
+
+- Initial release
diff --git a/crates/tracing-core/Cargo.toml b/crates/tracing-core/Cargo.toml
new file mode 100644
index 0000000..961b391
--- /dev/null
+++ b/crates/tracing-core/Cargo.toml
@@ -0,0 +1,66 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.56.0"
+name = "tracing-core"
+version = "0.1.32"
+authors = ["Tokio Contributors <[email protected]>"]
+description = """
+Core primitives for application-level tracing.
+"""
+homepage = "https://tokio.rs"
+readme = "README.md"
+keywords = [
+ "logging",
+ "tracing",
+ "profiling",
+]
+categories = [
+ "development-tools::debugging",
+ "development-tools::profiling",
+ "asynchronous",
+]
+license = "MIT"
+repository = "https://github.com/tokio-rs/tracing"
+
+[package.metadata.docs.rs]
+all-features = true
+rustc-args = [
+ "--cfg",
+ "tracing_unstable",
+]
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+ "--cfg",
+ "tracing_unstable",
+]
+
+[dependencies.once_cell]
+version = "1.13.0"
+optional = true
+
+[features]
+default = [
+ "std",
+ "valuable/std",
+]
+std = ["once_cell"]
+
+[target."cfg(tracing_unstable)".dependencies.valuable]
+version = "0.1.0"
+optional = true
+default-features = false
+
+[badges.maintenance]
+status = "actively-developed"
diff --git a/crates/tracing-core/LICENSE b/crates/tracing-core/LICENSE
new file mode 100644
index 0000000..cdb28b4
--- /dev/null
+++ b/crates/tracing-core/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tokio Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tracing-core/METADATA b/crates/tracing-core/METADATA
new file mode 100644
index 0000000..6993fb6
--- /dev/null
+++ b/crates/tracing-core/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/tracing-core
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tracing-core"
+description: "Core primitives for application-level tracing."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 6
+ }
+ homepage: "https://crates.io/crates/tracing-core"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tracing-core/tracing-core-0.1.32.crate"
+ version: "0.1.32"
+ }
+}
diff --git a/crates/tracing-core/MODULE_LICENSE_MIT b/crates/tracing-core/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tracing-core/MODULE_LICENSE_MIT
diff --git a/crates/tracing-core/README.md b/crates/tracing-core/README.md
new file mode 100644
index 0000000..3655948
--- /dev/null
+++ b/crates/tracing-core/README.md
@@ -0,0 +1,121 @@
+![Tracing — Structured, application-level diagnostics][splash]
+
+[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg
+
+# tracing-core
+
+Core primitives for application-level tracing.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[Documentation][docs-url] | [Chat][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tracing-core.svg
+[crates-url]: https://crates.io/crates/tracing-core/0.1.31
+[docs-badge]: https://docs.rs/tracing-core/badge.svg
+[docs-url]: https://docs.rs/tracing-core/0.1.31
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tracing-rs.netlify.com/tracing_core
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
+[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+
+## Overview
+
+[`tracing`] is a framework for instrumenting Rust programs to collect
+structured, event-based diagnostic information. This crate defines the core
+primitives of `tracing`.
+
+The crate provides:
+
+* [`span::Id`] identifies a span within the execution of a program.
+
+* [`Event`] represents a single event within a trace.
+
+* [`Subscriber`], the trait implemented to collect trace data.
+
+* [`Metadata`] and [`Callsite`] provide information describing spans and
+ events.
+
+* [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
+ structured data attached to spans and events.
+
+* [`Dispatch`] allows spans and events to be dispatched to `Subscriber`s.
+
+In addition, it defines the global callsite registry and per-thread current
+dispatcher which other components of the tracing system rely on.
+
+*Compiler support: [requires `rustc` 1.56+][msrv]*
+
+[msrv]: #supported-rust-versions
+
+## Usage
+
+Application authors will typically not use this crate directly. Instead, they
+will use the [`tracing`] crate, which provides a much more fully-featured
+API. However, this crate's API will change very infrequently, so it may be used
+when dependencies must be very stable.
+
+`Subscriber` implementations may depend on `tracing-core` rather than `tracing`,
+as the additional APIs provided by `tracing` are primarily useful for
+instrumenting libraries and applications, and are generally not necessary for
+`Subscriber` implementations.
+
+### Crate Feature Flags
+
+The following crate feature flags are available:
+
+* `std`: Depend on the Rust standard library (enabled by default).
+
+ `no_std` users may disable this feature with `default-features = false`:
+
+ ```toml
+ [dependencies]
+ tracing-core = { version = "0.1.31", default-features = false }
+ ```
+
+ **Note**:`tracing-core`'s `no_std` support requires `liballoc`.
+
+[`tracing`]: ../tracing
+[`span::Id`]: https://docs.rs/tracing-core/0.1.31/tracing_core/span/struct.Id.html
+[`Event`]: https://docs.rs/tracing-core/0.1.31/tracing_core/event/struct.Event.html
+[`Subscriber`]: https://docs.rs/tracing-core/0.1.31/tracing_core/subscriber/trait.Subscriber.html
+[`Metadata`]: https://docs.rs/tracing-core/0.1.31/tracing_core/metadata/struct.Metadata.html
+[`Callsite`]: https://docs.rs/tracing-core/0.1.31/tracing_core/callsite/trait.Callsite.html
+[`Field`]: https://docs.rs/tracing-core/0.1.31/tracing_core/field/struct.Field.html
+[`FieldSet`]: https://docs.rs/tracing-core/0.1.31/tracing_core/field/struct.FieldSet.html
+[`Value`]: https://docs.rs/tracing-core/0.1.31/tracing_core/field/trait.Value.html
+[`ValueSet`]: https://docs.rs/tracing-core/0.1.31/tracing_core/field/struct.ValueSet.html
+[`Dispatch`]: https://docs.rs/tracing-core/0.1.31/tracing_core/dispatcher/struct.Dispatch.html
+
+## Supported Rust Versions
+
+Tracing is built against the latest stable release. The minimum supported
+version is 1.56. The current Tracing version is not guaranteed to build on Rust
+versions earlier than the minimum supported version.
+
+Tracing follows the same compiler support policies as the rest of the Tokio
+project. The current stable Rust compiler and the three most recent minor
+versions before it will always be supported. For example, if the current stable
+compiler version is 1.69, the minimum supported version will not be increased
+past 1.69, three minor versions prior. Increasing the minimum supported compiler
+version is not considered a semver breaking change as long as doing so complies
+with this policy.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tokio by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tracing-core/cargo_embargo.json b/crates/tracing-core/cargo_embargo.json
new file mode 100644
index 0000000..c8842d1
--- /dev/null
+++ b/crates/tracing-core/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/tracing-core/src/callsite.rs b/crates/tracing-core/src/callsite.rs
new file mode 100644
index 0000000..62fa8c4
--- /dev/null
+++ b/crates/tracing-core/src/callsite.rs
@@ -0,0 +1,619 @@
+//! Callsites represent the source locations from which spans or events
+//! originate.
+//!
+//! # What Are Callsites?
+//!
+//! Every span or event in `tracing` is associated with a [`Callsite`]. A
+//! callsite is a small `static` value that is responsible for the following:
+//!
+//! * Storing the span or event's [`Metadata`],
+//! * Uniquely [identifying](Identifier) the span or event definition,
+//! * Caching the subscriber's [`Interest`][^1] in that span or event, to avoid
+//! re-evaluating filters.
+//!
+//! # Registering Callsites
+//!
+//! When a span or event is recorded for the first time, its callsite
+//! [`register`]s itself with the global callsite registry. Registering a
+//! callsite calls the [`Subscriber::register_callsite`][`register_callsite`]
+//! method with that callsite's [`Metadata`] on every currently active
+//! subscriber. This serves two primary purposes: informing subscribers of the
+//! callsite's existence, and performing static filtering.
+//!
+//! ## Callsite Existence
+//!
+//! If a [`Subscriber`] implementation wishes to allocate storage for each
+//! unique span/event location in the program, or pre-compute some value
+//! that will be used to record that span or event in the future, it can
+//! do so in its [`register_callsite`] method.
+//!
+//! ## Performing Static Filtering
+//!
+//! The [`register_callsite`] method returns an [`Interest`] value,
+//! which indicates that the subscriber either [always] wishes to record
+//! that span or event, [sometimes] wishes to record it based on a
+//! dynamic filter evaluation, or [never] wishes to record it.
+//!
+//! When registering a new callsite, the [`Interest`]s returned by every
+//! currently active subscriber are combined, and the result is stored at
+//! each callsite. This way, when the span or event occurs in the
+//! future, the cached [`Interest`] value can be checked efficiently
+//! to determine if the span or event should be recorded, without
+//! needing to perform expensive filtering (i.e. calling the
+//! [`Subscriber::enabled`] method every time a span or event occurs).
+//!
+//! ### Rebuilding Cached Interest
+//!
+//! When a new [`Dispatch`] is created (i.e. a new subscriber becomes
+//! active), any previously cached [`Interest`] values are re-evaluated
+//! for all callsites in the program. This way, if the new subscriber
+//! will enable a callsite that was not previously enabled, the
+//! [`Interest`] in that callsite is updated. Similarly, when a
+//! subscriber is dropped, the interest cache is also re-evaluated, so
+//! that any callsites enabled only by that subscriber are disabled.
+//!
+//! In addition, the [`rebuild_interest_cache`] function in this module can be
+//! used to manually invalidate all cached interest and re-register those
+//! callsites. This function is useful in situations where a subscriber's
+//! interest can change, but it does so relatively infrequently. The subscriber
+//! may wish for its interest to be cached most of the time, and return
+//! [`Interest::always`][always] or [`Interest::never`][never] in its
+//! [`register_callsite`] method, so that its [`Subscriber::enabled`] method
+//! doesn't need to be evaluated every time a span or event is recorded.
+//! However, when the configuration changes, the subscriber can call
+//! [`rebuild_interest_cache`] to re-evaluate the entire interest cache with its
+//! new configuration. This is a relatively costly operation, but if the
+//! configuration changes infrequently, it may be more efficient than calling
+//! [`Subscriber::enabled`] frequently.
+//!
+//! # Implementing Callsites
+//!
+//! In most cases, instrumenting code using `tracing` should *not* require
+//! implementing the [`Callsite`] trait directly. When using the [`tracing`
+//! crate's macros][macros] or the [`#[instrument]` attribute][instrument], a
+//! `Callsite` is automatically generated.
+//!
+//! However, code which provides alternative forms of `tracing` instrumentation
+//! may need to interact with the callsite system directly. If
+//! instrumentation-side code needs to produce a `Callsite` to emit spans or
+//! events, the [`DefaultCallsite`] struct provided in this module is a
+//! ready-made `Callsite` implementation that is suitable for most uses. When
+//! possible, the use of `DefaultCallsite` should be preferred over implementing
+//! [`Callsite`] for user types, as `DefaultCallsite` may benefit from
+//! additional performance optimizations.
+//!
+//! [^1]: Returned by the [`Subscriber::register_callsite`][`register_callsite`]
+//! method.
+//!
+//! [`Metadata`]: crate::metadata::Metadata
+//! [`Interest`]: crate::subscriber::Interest
+//! [`Subscriber`]: crate::subscriber::Subscriber
+//! [`register_callsite`]: crate::subscriber::Subscriber::register_callsite
+//! [`Subscriber::enabled`]: crate::subscriber::Subscriber::enabled
+//! [always]: crate::subscriber::Interest::always
+//! [sometimes]: crate::subscriber::Interest::sometimes
+//! [never]: crate::subscriber::Interest::never
+//! [`Dispatch`]: crate::dispatch::Dispatch
+//! [macros]: https://docs.rs/tracing/latest/tracing/#macros
+//! [instrument]: https://docs.rs/tracing/latest/tracing/attr.instrument.html
+use crate::stdlib::{
+ any::TypeId,
+ fmt,
+ hash::{Hash, Hasher},
+ ptr,
+ sync::{
+ atomic::{AtomicBool, AtomicPtr, AtomicU8, Ordering},
+ Mutex,
+ },
+ vec::Vec,
+};
+use crate::{
+ dispatcher::Dispatch,
+ lazy::Lazy,
+ metadata::{LevelFilter, Metadata},
+ subscriber::Interest,
+};
+
+use self::dispatchers::Dispatchers;
+
+/// Trait implemented by callsites.
+///
+/// These functions are only intended to be called by the callsite registry, which
+/// correctly handles determining the common interest between all subscribers.
+///
+/// See the [module-level documentation](crate::callsite) for details on
+/// callsites.
+pub trait Callsite: Sync {
+ /// Sets the [`Interest`] for this callsite.
+ ///
+ /// See the [documentation on callsite interest caching][cache-docs] for
+ /// details.
+ ///
+ /// [`Interest`]: super::subscriber::Interest
+ /// [cache-docs]: crate::callsite#performing-static-filtering
+ fn set_interest(&self, interest: Interest);
+
+ /// Returns the [metadata] associated with the callsite.
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ ///
+ /// **Note:** Implementations of this method should not produce [`Metadata`]
+ /// that share the same callsite [`Identifier`] but otherwise differ in any
+ /// way (e.g., have different `name`s).
+ ///
+ /// </pre></div>
+ ///
+ /// [metadata]: super::metadata::Metadata
+ fn metadata(&self) -> &Metadata<'_>;
+
+ /// This method is an *internal implementation detail* of `tracing-core`. It
+ /// is *not* intended to be called or overridden from downstream code.
+ ///
+ /// The `Private` type can only be constructed from within `tracing-core`.
+ /// Because this method takes a `Private` as an argument, it cannot be
+ /// called from (safe) code external to `tracing-core`. Because it must
+ /// *return* a `Private`, the only valid implementation possible outside of
+ /// `tracing-core` would have to always unconditionally panic.
+ ///
+ /// THIS IS BY DESIGN. There is currently no valid reason for code outside
+ /// of `tracing-core` to override this method.
+ // TODO(eliza): this could be used to implement a public downcasting API
+ // for `&dyn Callsite`s in the future.
+ #[doc(hidden)]
+ #[inline]
+ fn private_type_id(&self, _: private::Private<()>) -> private::Private<TypeId>
+ where
+ Self: 'static,
+ {
+ private::Private(TypeId::of::<Self>())
+ }
+}
+
+/// Uniquely identifies a [`Callsite`]
+///
+/// Two `Identifier`s are equal if they both refer to the same callsite.
+///
+/// [`Callsite`]: super::callsite::Callsite
+#[derive(Clone)]
+pub struct Identifier(
+ /// **Warning**: The fields on this type are currently `pub` because it must
+ /// be able to be constructed statically by macros. However, when `const
+ /// fn`s are available on stable Rust, this will no longer be necessary.
+ /// Thus, these fields are *not* considered stable public API, and they may
+ /// change warning. Do not rely on any fields on `Identifier`. When
+ /// constructing new `Identifier`s, use the `identify_callsite!` macro
+ /// instead.
+ #[doc(hidden)]
+ pub &'static dyn Callsite,
+);
+
+/// A default [`Callsite`] implementation.
+#[derive(Debug)]
+pub struct DefaultCallsite {
+ interest: AtomicU8,
+ registration: AtomicU8,
+ meta: &'static Metadata<'static>,
+ next: AtomicPtr<Self>,
+}
+
+/// Clear and reregister interest on every [`Callsite`]
+///
+/// This function is intended for runtime reconfiguration of filters on traces
+/// when the filter recalculation is much less frequent than trace events are.
+/// The alternative is to have the [`Subscriber`] that supports runtime
+/// reconfiguration of filters always return [`Interest::sometimes()`] so that
+/// [`enabled`] is evaluated for every event.
+///
+/// This function will also re-compute the global maximum level as determined by
+/// the [`max_level_hint`] method. If a [`Subscriber`]
+/// implementation changes the value returned by its `max_level_hint`
+/// implementation at runtime, then it **must** call this function after that
+/// value changes, in order for the change to be reflected.
+///
+/// See the [documentation on callsite interest caching][cache-docs] for
+/// additional information on this function's usage.
+///
+/// [`max_level_hint`]: super::subscriber::Subscriber::max_level_hint
+/// [`Callsite`]: super::callsite::Callsite
+/// [`enabled`]: super::subscriber::Subscriber#tymethod.enabled
+/// [`Interest::sometimes()`]: super::subscriber::Interest::sometimes
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [cache-docs]: crate::callsite#rebuilding-cached-interest
+pub fn rebuild_interest_cache() {
+ CALLSITES.rebuild_interest(DISPATCHERS.rebuilder());
+}
+
+/// Register a new [`Callsite`] with the global registry.
+///
+/// This should be called once per callsite after the callsite has been
+/// constructed.
+///
+/// See the [documentation on callsite registration][reg-docs] for details
+/// on the global callsite registry.
+///
+/// [`Callsite`]: crate::callsite::Callsite
+/// [reg-docs]: crate::callsite#registering-callsites
+pub fn register(callsite: &'static dyn Callsite) {
+ rebuild_callsite_interest(callsite, &DISPATCHERS.rebuilder());
+
+ // Is this a `DefaultCallsite`? If so, use the fancy linked list!
+ if callsite.private_type_id(private::Private(())).0 == TypeId::of::<DefaultCallsite>() {
+ let callsite = unsafe {
+ // Safety: the pointer cast is safe because the type id of the
+ // provided callsite matches that of the target type for the cast
+ // (`DefaultCallsite`). Because user implementations of `Callsite`
+ // cannot override `private_type_id`, we can trust that the callsite
+ // is not lying about its type ID.
+ &*(callsite as *const dyn Callsite as *const DefaultCallsite)
+ };
+ CALLSITES.push_default(callsite);
+ return;
+ }
+
+ CALLSITES.push_dyn(callsite);
+}
+
+static CALLSITES: Callsites = Callsites {
+ list_head: AtomicPtr::new(ptr::null_mut()),
+ has_locked_callsites: AtomicBool::new(false),
+};
+
+static DISPATCHERS: Dispatchers = Dispatchers::new();
+
+static LOCKED_CALLSITES: Lazy<Mutex<Vec<&'static dyn Callsite>>> = Lazy::new(Default::default);
+
+struct Callsites {
+ list_head: AtomicPtr<DefaultCallsite>,
+ has_locked_callsites: AtomicBool,
+}
+
+// === impl DefaultCallsite ===
+
+impl DefaultCallsite {
+ const UNREGISTERED: u8 = 0;
+ const REGISTERING: u8 = 1;
+ const REGISTERED: u8 = 2;
+
+ const INTEREST_NEVER: u8 = 0;
+ const INTEREST_SOMETIMES: u8 = 1;
+ const INTEREST_ALWAYS: u8 = 2;
+
+ /// Returns a new `DefaultCallsite` with the specified `Metadata`.
+ pub const fn new(meta: &'static Metadata<'static>) -> Self {
+ Self {
+ interest: AtomicU8::new(0xFF),
+ meta,
+ next: AtomicPtr::new(ptr::null_mut()),
+ registration: AtomicU8::new(Self::UNREGISTERED),
+ }
+ }
+
+ /// Registers this callsite with the global callsite registry.
+ ///
+ /// If the callsite is already registered, this does nothing. When using
+ /// [`DefaultCallsite`], this method should be preferred over
+ /// [`tracing_core::callsite::register`], as it ensures that the callsite is
+ /// only registered a single time.
+ ///
+ /// Other callsite implementations will generally ensure that
+ /// callsites are not re-registered through another mechanism.
+ ///
+ /// See the [documentation on callsite registration][reg-docs] for details
+ /// on the global callsite registry.
+ ///
+ /// [`Callsite`]: crate::callsite::Callsite
+ /// [reg-docs]: crate::callsite#registering-callsites
+ #[inline(never)]
+ // This only happens once (or if the cached interest value was corrupted).
+ #[cold]
+ pub fn register(&'static self) -> Interest {
+ // Attempt to advance the registration state to `REGISTERING`...
+ match self.registration.compare_exchange(
+ Self::UNREGISTERED,
+ Self::REGISTERING,
+ Ordering::AcqRel,
+ Ordering::Acquire,
+ ) {
+ Ok(_) => {
+ // Okay, we advanced the state, try to register the callsite.
+ rebuild_callsite_interest(self, &DISPATCHERS.rebuilder());
+ CALLSITES.push_default(self);
+ self.registration.store(Self::REGISTERED, Ordering::Release);
+ }
+ // Great, the callsite is already registered! Just load its
+ // previous cached interest.
+ Err(Self::REGISTERED) => {}
+ // Someone else is registering...
+ Err(_state) => {
+ debug_assert_eq!(
+ _state,
+ Self::REGISTERING,
+ "weird callsite registration state"
+ );
+ // Just hit `enabled` this time.
+ return Interest::sometimes();
+ }
+ }
+
+ match self.interest.load(Ordering::Relaxed) {
+ Self::INTEREST_NEVER => Interest::never(),
+ Self::INTEREST_ALWAYS => Interest::always(),
+ _ => Interest::sometimes(),
+ }
+ }
+
+ /// Returns the callsite's cached `Interest`, or registers it for the
+ /// first time if it has not yet been registered.
+ #[inline]
+ pub fn interest(&'static self) -> Interest {
+ match self.interest.load(Ordering::Relaxed) {
+ Self::INTEREST_NEVER => Interest::never(),
+ Self::INTEREST_SOMETIMES => Interest::sometimes(),
+ Self::INTEREST_ALWAYS => Interest::always(),
+ _ => self.register(),
+ }
+ }
+}
+
+impl Callsite for DefaultCallsite {
+ fn set_interest(&self, interest: Interest) {
+ let interest = match () {
+ _ if interest.is_never() => Self::INTEREST_NEVER,
+ _ if interest.is_always() => Self::INTEREST_ALWAYS,
+ _ => Self::INTEREST_SOMETIMES,
+ };
+ self.interest.store(interest, Ordering::SeqCst);
+ }
+
+ #[inline(always)]
+ fn metadata(&self) -> &Metadata<'static> {
+ self.meta
+ }
+}
+
+// ===== impl Identifier =====
+
+impl PartialEq for Identifier {
+ fn eq(&self, other: &Identifier) -> bool {
+ core::ptr::eq(
+ self.0 as *const _ as *const (),
+ other.0 as *const _ as *const (),
+ )
+ }
+}
+
+impl Eq for Identifier {}
+
+impl fmt::Debug for Identifier {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "Identifier({:p})", self.0)
+ }
+}
+
+impl Hash for Identifier {
+ fn hash<H>(&self, state: &mut H)
+ where
+ H: Hasher,
+ {
+ (self.0 as *const dyn Callsite).hash(state)
+ }
+}
+
+// === impl Callsites ===
+
+impl Callsites {
+ /// Rebuild `Interest`s for all callsites in the registry.
+ ///
+ /// This also re-computes the max level hint.
+ fn rebuild_interest(&self, dispatchers: dispatchers::Rebuilder<'_>) {
+ let mut max_level = LevelFilter::OFF;
+ dispatchers.for_each(|dispatch| {
+ // If the subscriber did not provide a max level hint, assume
+ // that it may enable every level.
+ let level_hint = dispatch.max_level_hint().unwrap_or(LevelFilter::TRACE);
+ if level_hint > max_level {
+ max_level = level_hint;
+ }
+ });
+
+ self.for_each(|callsite| {
+ rebuild_callsite_interest(callsite, &dispatchers);
+ });
+ LevelFilter::set_max(max_level);
+ }
+
+ /// Push a `dyn Callsite` trait object to the callsite registry.
+ ///
+ /// This will attempt to lock the callsites vector.
+ fn push_dyn(&self, callsite: &'static dyn Callsite) {
+ let mut lock = LOCKED_CALLSITES.lock().unwrap();
+ self.has_locked_callsites.store(true, Ordering::Release);
+ lock.push(callsite);
+ }
+
+ /// Push a `DefaultCallsite` to the callsite registry.
+ ///
+ /// If we know the callsite being pushed is a `DefaultCallsite`, we can push
+ /// it to the linked list without having to acquire a lock.
+ fn push_default(&self, callsite: &'static DefaultCallsite) {
+ let mut head = self.list_head.load(Ordering::Acquire);
+
+ loop {
+ callsite.next.store(head, Ordering::Release);
+
+ assert_ne!(
+ callsite as *const _, head,
+ "Attempted to register a `DefaultCallsite` that already exists! \
+ This will cause an infinite loop when attempting to read from the \
+ callsite cache. This is likely a bug! You should only need to call \
+ `DefaultCallsite::register` once per `DefaultCallsite`."
+ );
+
+ match self.list_head.compare_exchange(
+ head,
+ callsite as *const _ as *mut _,
+ Ordering::AcqRel,
+ Ordering::Acquire,
+ ) {
+ Ok(_) => {
+ break;
+ }
+ Err(current) => head = current,
+ }
+ }
+ }
+
+ /// Invokes the provided closure `f` with each callsite in the registry.
+ fn for_each(&self, mut f: impl FnMut(&'static dyn Callsite)) {
+ let mut head = self.list_head.load(Ordering::Acquire);
+
+ while let Some(cs) = unsafe { head.as_ref() } {
+ f(cs);
+
+ head = cs.next.load(Ordering::Acquire);
+ }
+
+ if self.has_locked_callsites.load(Ordering::Acquire) {
+ let locked = LOCKED_CALLSITES.lock().unwrap();
+ for &cs in locked.iter() {
+ f(cs);
+ }
+ }
+ }
+}
+
+pub(crate) fn register_dispatch(dispatch: &Dispatch) {
+ let dispatchers = DISPATCHERS.register_dispatch(dispatch);
+ dispatch.subscriber().on_register_dispatch(dispatch);
+ CALLSITES.rebuild_interest(dispatchers);
+}
+
+fn rebuild_callsite_interest(
+ callsite: &'static dyn Callsite,
+ dispatchers: &dispatchers::Rebuilder<'_>,
+) {
+ let meta = callsite.metadata();
+
+ let mut interest = None;
+ dispatchers.for_each(|dispatch| {
+ let this_interest = dispatch.register_callsite(meta);
+ interest = match interest.take() {
+ None => Some(this_interest),
+ Some(that_interest) => Some(that_interest.and(this_interest)),
+ }
+ });
+
+ let interest = interest.unwrap_or_else(Interest::never);
+ callsite.set_interest(interest)
+}
+
+mod private {
+ /// Don't call this function, it's private.
+ #[allow(missing_debug_implementations)]
+ pub struct Private<T>(pub(crate) T);
+}
+
+#[cfg(feature = "std")]
+mod dispatchers {
+ use crate::{dispatcher, lazy::Lazy};
+ use std::sync::{
+ atomic::{AtomicBool, Ordering},
+ RwLock, RwLockReadGuard, RwLockWriteGuard,
+ };
+
+ pub(super) struct Dispatchers {
+ has_just_one: AtomicBool,
+ }
+
+ static LOCKED_DISPATCHERS: Lazy<RwLock<Vec<dispatcher::Registrar>>> =
+ Lazy::new(Default::default);
+
+ pub(super) enum Rebuilder<'a> {
+ JustOne,
+ Read(RwLockReadGuard<'a, Vec<dispatcher::Registrar>>),
+ Write(RwLockWriteGuard<'a, Vec<dispatcher::Registrar>>),
+ }
+
+ impl Dispatchers {
+ pub(super) const fn new() -> Self {
+ Self {
+ has_just_one: AtomicBool::new(true),
+ }
+ }
+
+ pub(super) fn rebuilder(&self) -> Rebuilder<'_> {
+ if self.has_just_one.load(Ordering::SeqCst) {
+ return Rebuilder::JustOne;
+ }
+ Rebuilder::Read(LOCKED_DISPATCHERS.read().unwrap())
+ }
+
+ pub(super) fn register_dispatch(&self, dispatch: &dispatcher::Dispatch) -> Rebuilder<'_> {
+ let mut dispatchers = LOCKED_DISPATCHERS.write().unwrap();
+ dispatchers.retain(|d| d.upgrade().is_some());
+ dispatchers.push(dispatch.registrar());
+ self.has_just_one
+ .store(dispatchers.len() <= 1, Ordering::SeqCst);
+ Rebuilder::Write(dispatchers)
+ }
+ }
+
+ impl Rebuilder<'_> {
+ pub(super) fn for_each(&self, mut f: impl FnMut(&dispatcher::Dispatch)) {
+ let iter = match self {
+ Rebuilder::JustOne => {
+ dispatcher::get_default(f);
+ return;
+ }
+ Rebuilder::Read(vec) => vec.iter(),
+ Rebuilder::Write(vec) => vec.iter(),
+ };
+ iter.filter_map(dispatcher::Registrar::upgrade)
+ .for_each(|dispatch| f(&dispatch))
+ }
+ }
+}
+
+#[cfg(not(feature = "std"))]
+mod dispatchers {
+ use crate::dispatcher;
+
+ pub(super) struct Dispatchers(());
+ pub(super) struct Rebuilder<'a>(Option<&'a dispatcher::Dispatch>);
+
+ impl Dispatchers {
+ pub(super) const fn new() -> Self {
+ Self(())
+ }
+
+ pub(super) fn rebuilder(&self) -> Rebuilder<'_> {
+ Rebuilder(None)
+ }
+
+ pub(super) fn register_dispatch<'dispatch>(
+ &self,
+ dispatch: &'dispatch dispatcher::Dispatch,
+ ) -> Rebuilder<'dispatch> {
+ // nop; on no_std, there can only ever be one dispatcher
+ Rebuilder(Some(dispatch))
+ }
+ }
+
+ impl Rebuilder<'_> {
+ #[inline]
+ pub(super) fn for_each(&self, mut f: impl FnMut(&dispatcher::Dispatch)) {
+ if let Some(dispatch) = self.0 {
+ // we are rebuilding the interest cache because a new dispatcher
+ // is about to be set. on `no_std`, this should only happen
+ // once, because the new dispatcher will be the global default.
+ f(dispatch)
+ } else {
+ // otherwise, we are rebuilding the cache because the subscriber
+ // configuration changed, so use the global default.
+ // on no_std, there can only ever be one dispatcher
+ dispatcher::get_default(f)
+ }
+ }
+ }
+}
diff --git a/crates/tracing-core/src/dispatcher.rs b/crates/tracing-core/src/dispatcher.rs
new file mode 100644
index 0000000..de02afb
--- /dev/null
+++ b/crates/tracing-core/src/dispatcher.rs
@@ -0,0 +1,1071 @@
+//! Dispatches trace events to [`Subscriber`]s.
+//!
+//! The _dispatcher_ is the component of the tracing system which is responsible
+//! for forwarding trace data from the instrumentation points that generate it
+//! to the subscriber that collects it.
+//!
+//! # Using the Trace Dispatcher
+//!
+//! Every thread in a program using `tracing` has a _default subscriber_. When
+//! events occur, or spans are created, they are dispatched to the thread's
+//! current subscriber.
+//!
+//! ## Setting the Default Subscriber
+//!
+//! By default, the current subscriber is an empty implementation that does
+//! nothing. To use a subscriber implementation, it must be set as the default.
+//! There are two methods for doing so: [`with_default`] and
+//! [`set_global_default`]. `with_default` sets the default subscriber for the
+//! duration of a scope, while `set_global_default` sets a default subscriber
+//! for the entire process.
+//!
+//! To use either of these functions, we must first wrap our subscriber in a
+//! [`Dispatch`], a cloneable, type-erased reference to a subscriber. For
+//! example:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! use dispatcher::Dispatch;
+//!
+//! let my_subscriber = FooSubscriber::new();
+//! let my_dispatch = Dispatch::new(my_subscriber);
+//! ```
+//! Then, we can use [`with_default`] to set our `Dispatch` as the default for
+//! the duration of a block:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! # let my_subscriber = FooSubscriber::new();
+//! # let my_dispatch = dispatcher::Dispatch::new(my_subscriber);
+//! // no default subscriber
+//!
+//! # #[cfg(feature = "std")]
+//! dispatcher::with_default(&my_dispatch, || {
+//! // my_subscriber is the default
+//! });
+//!
+//! // no default subscriber again
+//! ```
+//! It's important to note that `with_default` will not propagate the current
+//! thread's default subscriber to any threads spawned within the `with_default`
+//! block. To propagate the default subscriber to new threads, either use
+//! `with_default` from the new thread, or use `set_global_default`.
+//!
+//! As an alternative to `with_default`, we can use [`set_global_default`] to
+//! set a `Dispatch` as the default for all threads, for the lifetime of the
+//! program. For example:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! # let my_subscriber = FooSubscriber::new();
+//! # let my_dispatch = dispatcher::Dispatch::new(my_subscriber);
+//! // no default subscriber
+//!
+//! dispatcher::set_global_default(my_dispatch)
+//! // `set_global_default` will return an error if the global default
+//! // subscriber has already been set.
+//! .expect("global default was already set!");
+//!
+//! // `my_subscriber` is now the default
+//! ```
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>:the thread-local scoped dispatcher
+//! (<a href="#fn.with_default"><code>with_default</code></a>) requires the
+//! Rust standard library. <code>no_std</code> users should use
+//! <a href="#fn.set_global_default"><code>set_global_default</code></a>
+//! instead.
+//! </pre>
+//!
+//! ## Accessing the Default Subscriber
+//!
+//! A thread's current default subscriber can be accessed using the
+//! [`get_default`] function, which executes a closure with a reference to the
+//! currently default `Dispatch`. This is used primarily by `tracing`
+//! instrumentation.
+//!
+use crate::{
+ callsite, span,
+ subscriber::{self, NoSubscriber, Subscriber},
+ Event, LevelFilter, Metadata,
+};
+
+use crate::stdlib::{
+ any::Any,
+ fmt,
+ sync::{
+ atomic::{AtomicBool, AtomicUsize, Ordering},
+ Arc, Weak,
+ },
+};
+
+#[cfg(feature = "std")]
+use crate::stdlib::{
+ cell::{Cell, Ref, RefCell},
+ error,
+};
+
+#[cfg(feature = "alloc")]
+use alloc::sync::{Arc, Weak};
+
+#[cfg(feature = "alloc")]
+use core::ops::Deref;
+
+/// `Dispatch` trace data to a [`Subscriber`].
+#[derive(Clone)]
+pub struct Dispatch {
+ subscriber: Kind<Arc<dyn Subscriber + Send + Sync>>,
+}
+
+/// `WeakDispatch` is a version of [`Dispatch`] that holds a non-owning reference
+/// to a [`Subscriber`].
+///
+/// The Subscriber` may be accessed by calling [`WeakDispatch::upgrade`],
+/// which returns an `Option<Dispatch>`. If all [`Dispatch`] clones that point
+/// at the `Subscriber` have been dropped, [`WeakDispatch::upgrade`] will return
+/// `None`. Otherwise, it will return `Some(Dispatch)`.
+///
+/// A `WeakDispatch` may be created from a [`Dispatch`] by calling the
+/// [`Dispatch::downgrade`] method. The primary use for creating a
+/// [`WeakDispatch`] is to allow a Subscriber` to hold a cyclical reference to
+/// itself without creating a memory leak. See [here] for details.
+///
+/// This type is analogous to the [`std::sync::Weak`] type, but for a
+/// [`Dispatch`] rather than an [`Arc`].
+///
+/// [`Arc`]: std::sync::Arc
+/// [here]: Subscriber#avoiding-memory-leaks
+#[derive(Clone)]
+pub struct WeakDispatch {
+ subscriber: Kind<Weak<dyn Subscriber + Send + Sync>>,
+}
+
+#[derive(Clone)]
+enum Kind<T> {
+ Global(&'static (dyn Subscriber + Send + Sync)),
+ Scoped(T),
+}
+
+#[cfg(feature = "std")]
+thread_local! {
+ static CURRENT_STATE: State = State {
+ default: RefCell::new(None),
+ can_enter: Cell::new(true),
+ };
+}
+
+static EXISTS: AtomicBool = AtomicBool::new(false);
+static GLOBAL_INIT: AtomicUsize = AtomicUsize::new(UNINITIALIZED);
+
+#[cfg(feature = "std")]
+static SCOPED_COUNT: AtomicUsize = AtomicUsize::new(0);
+
+const UNINITIALIZED: usize = 0;
+const INITIALIZING: usize = 1;
+const INITIALIZED: usize = 2;
+
+static mut GLOBAL_DISPATCH: Dispatch = Dispatch {
+ subscriber: Kind::Global(&NO_SUBSCRIBER),
+};
+static NONE: Dispatch = Dispatch {
+ subscriber: Kind::Global(&NO_SUBSCRIBER),
+};
+static NO_SUBSCRIBER: NoSubscriber = NoSubscriber::new();
+
+/// The dispatch state of a thread.
+#[cfg(feature = "std")]
+struct State {
+ /// This thread's current default dispatcher.
+ default: RefCell<Option<Dispatch>>,
+ /// Whether or not we can currently begin dispatching a trace event.
+ ///
+ /// This is set to `false` when functions such as `enter`, `exit`, `event`,
+ /// and `new_span` are called on this thread's default dispatcher, to
+ /// prevent further trace events triggered inside those functions from
+ /// creating an infinite recursion. When we finish handling a dispatch, this
+ /// is set back to `true`.
+ can_enter: Cell<bool>,
+}
+
+/// While this guard is active, additional calls to subscriber functions on
+/// the default dispatcher will not be able to access the dispatch context.
+/// Dropping the guard will allow the dispatch context to be re-entered.
+#[cfg(feature = "std")]
+struct Entered<'a>(&'a State);
+
+/// A guard that resets the current default dispatcher to the prior
+/// default dispatcher when dropped.
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+#[derive(Debug)]
+pub struct DefaultGuard(Option<Dispatch>);
+
+/// Sets this dispatch as the default for the duration of a closure.
+///
+/// The default dispatcher is used when creating a new [span] or
+/// [`Event`].
+///
+/// <pre class="ignore" style="white-space:normal;font:inherit;">
+/// <strong>Note</strong>: This function required the Rust standard library.
+/// <code>no_std</code> users should use <a href="../fn.set_global_default.html">
+/// <code>set_global_default</code></a> instead.
+/// </pre>
+///
+/// [span]: super::span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
+/// [`set_global_default`]: super::set_global_default
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub fn with_default<T>(dispatcher: &Dispatch, f: impl FnOnce() -> T) -> T {
+ // When this guard is dropped, the default dispatcher will be reset to the
+ // prior default. Using this (rather than simply resetting after calling
+ // `f`) ensures that we always reset to the prior dispatcher even if `f`
+ // panics.
+ let _guard = set_default(dispatcher);
+ f()
+}
+
+/// Sets the dispatch as the default dispatch for the duration of the lifetime
+/// of the returned DefaultGuard
+///
+/// <pre class="ignore" style="white-space:normal;font:inherit;">
+/// <strong>Note</strong>: This function required the Rust standard library.
+/// <code>no_std</code> users should use <a href="../fn.set_global_default.html">
+/// <code>set_global_default</code></a> instead.
+/// </pre>
+///
+/// [`set_global_default`]: super::set_global_default
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+#[must_use = "Dropping the guard unregisters the dispatcher."]
+pub fn set_default(dispatcher: &Dispatch) -> DefaultGuard {
+ // When this guard is dropped, the default dispatcher will be reset to the
+ // prior default. Using this ensures that we always reset to the prior
+ // dispatcher even if the thread calling this function panics.
+ State::set_default(dispatcher.clone())
+}
+
+/// Sets this dispatch as the global default for the duration of the entire program.
+/// Will be used as a fallback if no thread-local dispatch has been set in a thread
+/// (using `with_default`.)
+///
+/// Can only be set once; subsequent attempts to set the global default will fail.
+/// Returns `Err` if the global default has already been set.
+///
+/// <div class="example-wrap" style="display:inline-block"><pre class="compile_fail" style="white-space:normal;font:inherit;">
+/// <strong>Warning</strong>: In general, libraries should <em>not</em> call
+/// <code>set_global_default()</code>! Doing so will cause conflicts when
+/// executables that depend on the library try to set the default later.
+/// </pre></div>
+///
+/// [span]: super::span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
+pub fn set_global_default(dispatcher: Dispatch) -> Result<(), SetGlobalDefaultError> {
+ // if `compare_exchange` returns Result::Ok(_), then `new` has been set and
+ // `current`—now the prior value—has been returned in the `Ok()` branch.
+ if GLOBAL_INIT
+ .compare_exchange(
+ UNINITIALIZED,
+ INITIALIZING,
+ Ordering::SeqCst,
+ Ordering::SeqCst,
+ )
+ .is_ok()
+ {
+ let subscriber = {
+ let subscriber = match dispatcher.subscriber {
+ Kind::Global(s) => s,
+ Kind::Scoped(s) => unsafe {
+ // safety: this leaks the subscriber onto the heap. the
+ // reference count will always be at least 1, because the
+ // global default will never be dropped.
+ &*Arc::into_raw(s)
+ },
+ };
+ Kind::Global(subscriber)
+ };
+ unsafe {
+ GLOBAL_DISPATCH = Dispatch { subscriber };
+ }
+ GLOBAL_INIT.store(INITIALIZED, Ordering::SeqCst);
+ EXISTS.store(true, Ordering::Release);
+ Ok(())
+ } else {
+ Err(SetGlobalDefaultError { _no_construct: () })
+ }
+}
+
+/// Returns true if a `tracing` dispatcher has ever been set.
+///
+/// This may be used to completely elide trace points if tracing is not in use
+/// at all or has yet to be initialized.
+#[doc(hidden)]
+#[inline(always)]
+pub fn has_been_set() -> bool {
+ EXISTS.load(Ordering::Relaxed)
+}
+
+/// Returned if setting the global dispatcher fails.
+pub struct SetGlobalDefaultError {
+ _no_construct: (),
+}
+
+impl fmt::Debug for SetGlobalDefaultError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_tuple("SetGlobalDefaultError")
+ .field(&Self::MESSAGE)
+ .finish()
+ }
+}
+
+impl fmt::Display for SetGlobalDefaultError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad(Self::MESSAGE)
+ }
+}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl error::Error for SetGlobalDefaultError {}
+
+impl SetGlobalDefaultError {
+ const MESSAGE: &'static str = "a global default trace dispatcher has already been set";
+}
+
+/// Executes a closure with a reference to this thread's current [dispatcher].
+///
+/// Note that calls to `get_default` should not be nested; if this function is
+/// called while inside of another `get_default`, that closure will be provided
+/// with `Dispatch::none` rather than the previously set dispatcher.
+///
+/// [dispatcher]: super::dispatcher::Dispatch
+#[cfg(feature = "std")]
+pub fn get_default<T, F>(mut f: F) -> T
+where
+ F: FnMut(&Dispatch) -> T,
+{
+ if SCOPED_COUNT.load(Ordering::Acquire) == 0 {
+ // fast path if no scoped dispatcher has been set; just use the global
+ // default.
+ return f(get_global());
+ }
+
+ CURRENT_STATE
+ .try_with(|state| {
+ if let Some(entered) = state.enter() {
+ return f(&entered.current());
+ }
+
+ f(&NONE)
+ })
+ .unwrap_or_else(|_| f(&NONE))
+}
+
+/// Executes a closure with a reference to this thread's current [dispatcher].
+///
+/// Note that calls to `get_default` should not be nested; if this function is
+/// called while inside of another `get_default`, that closure will be provided
+/// with `Dispatch::none` rather than the previously set dispatcher.
+///
+/// [dispatcher]: super::dispatcher::Dispatch
+#[cfg(feature = "std")]
+#[doc(hidden)]
+#[inline(never)]
+pub fn get_current<T>(f: impl FnOnce(&Dispatch) -> T) -> Option<T> {
+ if SCOPED_COUNT.load(Ordering::Acquire) == 0 {
+ // fast path if no scoped dispatcher has been set; just use the global
+ // default.
+ return Some(f(get_global()));
+ }
+
+ CURRENT_STATE
+ .try_with(|state| {
+ let entered = state.enter()?;
+ Some(f(&entered.current()))
+ })
+ .ok()?
+}
+
+/// Executes a closure with a reference to the current [dispatcher].
+///
+/// [dispatcher]: super::dispatcher::Dispatch
+#[cfg(not(feature = "std"))]
+#[doc(hidden)]
+pub fn get_current<T>(f: impl FnOnce(&Dispatch) -> T) -> Option<T> {
+ Some(f(get_global()))
+}
+
+/// Executes a closure with a reference to the current [dispatcher].
+///
+/// [dispatcher]: super::dispatcher::Dispatch
+#[cfg(not(feature = "std"))]
+pub fn get_default<T, F>(mut f: F) -> T
+where
+ F: FnMut(&Dispatch) -> T,
+{
+ f(&get_global())
+}
+
+#[inline]
+fn get_global() -> &'static Dispatch {
+ if GLOBAL_INIT.load(Ordering::SeqCst) != INITIALIZED {
+ return &NONE;
+ }
+ unsafe {
+ // This is safe given the invariant that setting the global dispatcher
+ // also sets `GLOBAL_INIT` to `INITIALIZED`.
+ &GLOBAL_DISPATCH
+ }
+}
+
+#[cfg(feature = "std")]
+pub(crate) struct Registrar(Kind<Weak<dyn Subscriber + Send + Sync>>);
+
+impl Dispatch {
+ /// Returns a new `Dispatch` that discards events and spans.
+ #[inline]
+ pub fn none() -> Self {
+ Dispatch {
+ subscriber: Kind::Global(&NO_SUBSCRIBER),
+ }
+ }
+
+ /// Returns a `Dispatch` that forwards to the given [`Subscriber`].
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ pub fn new<S>(subscriber: S) -> Self
+ where
+ S: Subscriber + Send + Sync + 'static,
+ {
+ let me = Dispatch {
+ subscriber: Kind::Scoped(Arc::new(subscriber)),
+ };
+ callsite::register_dispatch(&me);
+ me
+ }
+
+ #[cfg(feature = "std")]
+ pub(crate) fn registrar(&self) -> Registrar {
+ Registrar(self.subscriber.downgrade())
+ }
+
+ /// Creates a [`WeakDispatch`] from this `Dispatch`.
+ ///
+ /// A [`WeakDispatch`] is similar to a [`Dispatch`], but it does not prevent
+ /// the underlying [`Subscriber`] from being dropped. Instead, it only permits
+ /// access while other references to the `Subscriber` exist. This is equivalent
+ /// to the standard library's [`Arc::downgrade`] method, but for `Dispatch`
+ /// rather than `Arc`.
+ ///
+ /// The primary use for creating a [`WeakDispatch`] is to allow a `Subscriber`
+ /// to hold a cyclical reference to itself without creating a memory leak.
+ /// See [here] for details.
+ ///
+ /// [`Arc::downgrade`]: std::sync::Arc::downgrade
+ /// [here]: Subscriber#avoiding-memory-leaks
+ pub fn downgrade(&self) -> WeakDispatch {
+ WeakDispatch {
+ subscriber: self.subscriber.downgrade(),
+ }
+ }
+
+ #[inline(always)]
+ pub(crate) fn subscriber(&self) -> &(dyn Subscriber + Send + Sync) {
+ match self.subscriber {
+ Kind::Global(s) => s,
+ Kind::Scoped(ref s) => s.as_ref(),
+ }
+ }
+
+ /// Registers a new callsite with this subscriber, returning whether or not
+ /// the subscriber is interested in being notified about the callsite.
+ ///
+ /// This calls the [`register_callsite`] function on the [`Subscriber`]
+ /// that this `Dispatch` forwards to.
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`register_callsite`]: super::subscriber::Subscriber::register_callsite
+ #[inline]
+ pub fn register_callsite(&self, metadata: &'static Metadata<'static>) -> subscriber::Interest {
+ self.subscriber().register_callsite(metadata)
+ }
+
+ /// Returns the highest [verbosity level][level] that this [`Subscriber`] will
+ /// enable, or `None`, if the subscriber does not implement level-based
+ /// filtering or chooses not to implement this method.
+ ///
+ /// This calls the [`max_level_hint`] function on the [`Subscriber`]
+ /// that this `Dispatch` forwards to.
+ ///
+ /// [level]: super::Level
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`register_callsite`]: super::subscriber::Subscriber::max_level_hint
+ // TODO(eliza): consider making this a public API?
+ #[inline]
+ pub(crate) fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.subscriber().max_level_hint()
+ }
+
+ /// Record the construction of a new span, returning a new [ID] for the
+ /// span being constructed.
+ ///
+ /// This calls the [`new_span`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
+ #[inline]
+ pub fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
+ self.subscriber().new_span(span)
+ }
+
+ /// Record a set of values on a span.
+ ///
+ /// This calls the [`record`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`record`]: super::subscriber::Subscriber::record
+ #[inline]
+ pub fn record(&self, span: &span::Id, values: &span::Record<'_>) {
+ self.subscriber().record(span, values)
+ }
+
+ /// Adds an indication that `span` follows from the span with the id
+ /// `follows`.
+ ///
+ /// This calls the [`record_follows_from`] function on the [`Subscriber`]
+ /// that this `Dispatch` forwards to.
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`record_follows_from`]: super::subscriber::Subscriber::record_follows_from
+ #[inline]
+ pub fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
+ self.subscriber().record_follows_from(span, follows)
+ }
+
+ /// Returns true if a span with the specified [metadata] would be
+ /// recorded.
+ ///
+ /// This calls the [`enabled`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [metadata]: super::metadata::Metadata
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`enabled`]: super::subscriber::Subscriber::enabled
+ #[inline]
+ pub fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ self.subscriber().enabled(metadata)
+ }
+
+ /// Records that an [`Event`] has occurred.
+ ///
+ /// This calls the [`event`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [`Event`]: super::event::Event
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`event`]: super::subscriber::Subscriber::event
+ #[inline]
+ pub fn event(&self, event: &Event<'_>) {
+ let subscriber = self.subscriber();
+ if subscriber.event_enabled(event) {
+ subscriber.event(event);
+ }
+ }
+
+ /// Records that a span has been can_enter.
+ ///
+ /// This calls the [`enter`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`enter`]: super::subscriber::Subscriber::enter
+ pub fn enter(&self, span: &span::Id) {
+ self.subscriber().enter(span);
+ }
+
+ /// Records that a span has been exited.
+ ///
+ /// This calls the [`exit`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`exit`]: super::subscriber::Subscriber::exit
+ pub fn exit(&self, span: &span::Id) {
+ self.subscriber().exit(span);
+ }
+
+ /// Notifies the subscriber that a [span ID] has been cloned.
+ ///
+ /// This function must only be called with span IDs that were returned by
+ /// this `Dispatch`'s [`new_span`] function. The `tracing` crate upholds
+ /// this guarantee and any other libraries implementing instrumentation APIs
+ /// must as well.
+ ///
+ /// This calls the [`clone_span`] function on the `Subscriber` that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`clone_span`]: super::subscriber::Subscriber::clone_span
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
+ #[inline]
+ pub fn clone_span(&self, id: &span::Id) -> span::Id {
+ self.subscriber().clone_span(id)
+ }
+
+ /// Notifies the subscriber that a [span ID] has been dropped.
+ ///
+ /// This function must only be called with span IDs that were returned by
+ /// this `Dispatch`'s [`new_span`] function. The `tracing` crate upholds
+ /// this guarantee and any other libraries implementing instrumentation APIs
+ /// must as well.
+ ///
+ /// This calls the [`drop_span`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// <pre class="compile_fail" style="white-space:normal;font:inherit;">
+ /// <strong>Deprecated</strong>: The <a href="#method.try_close"><code>
+ /// try_close</code></a> method is functionally identical, but returns
+ /// <code>true</code> if the span is now closed. It should be used
+ /// instead of this method.
+ /// </pre>
+ ///
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`drop_span`]: super::subscriber::Subscriber::drop_span
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
+ /// [`try_close`]: Entered::try_close()
+ #[inline]
+ #[deprecated(since = "0.1.2", note = "use `Dispatch::try_close` instead")]
+ pub fn drop_span(&self, id: span::Id) {
+ #[allow(deprecated)]
+ self.subscriber().drop_span(id);
+ }
+
+ /// Notifies the subscriber that a [span ID] has been dropped, and returns
+ /// `true` if there are now 0 IDs referring to that span.
+ ///
+ /// This function must only be called with span IDs that were returned by
+ /// this `Dispatch`'s [`new_span`] function. The `tracing` crate upholds
+ /// this guarantee and any other libraries implementing instrumentation APIs
+ /// must as well.
+ ///
+ /// This calls the [`try_close`] function on the [`Subscriber`] that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [span ID]: super::span::Id
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [`try_close`]: super::subscriber::Subscriber::try_close
+ /// [`new_span`]: super::subscriber::Subscriber::new_span
+ pub fn try_close(&self, id: span::Id) -> bool {
+ self.subscriber().try_close(id)
+ }
+
+ /// Returns a type representing this subscriber's view of the current span.
+ ///
+ /// This calls the [`current`] function on the `Subscriber` that this
+ /// `Dispatch` forwards to.
+ ///
+ /// [`current`]: super::subscriber::Subscriber::current_span
+ #[inline]
+ pub fn current_span(&self) -> span::Current {
+ self.subscriber().current_span()
+ }
+
+ /// Returns `true` if this `Dispatch` forwards to a `Subscriber` of type
+ /// `T`.
+ #[inline]
+ pub fn is<T: Any>(&self) -> bool {
+ <dyn Subscriber>::is::<T>(self.subscriber())
+ }
+
+ /// Returns some reference to the `Subscriber` this `Dispatch` forwards to
+ /// if it is of type `T`, or `None` if it isn't.
+ #[inline]
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ <dyn Subscriber>::downcast_ref(self.subscriber())
+ }
+}
+
+impl Default for Dispatch {
+ /// Returns the current default dispatcher
+ fn default() -> Self {
+ get_default(|default| default.clone())
+ }
+}
+
+impl fmt::Debug for Dispatch {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.subscriber {
+ Kind::Scoped(ref s) => f
+ .debug_tuple("Dispatch::Scoped")
+ .field(&format_args!("{:p}", s))
+ .finish(),
+ Kind::Global(s) => f
+ .debug_tuple("Dispatch::Global")
+ .field(&format_args!("{:p}", s))
+ .finish(),
+ }
+ }
+}
+
+impl<S> From<S> for Dispatch
+where
+ S: Subscriber + Send + Sync + 'static,
+{
+ #[inline]
+ fn from(subscriber: S) -> Self {
+ Dispatch::new(subscriber)
+ }
+}
+
+// === impl WeakDispatch ===
+
+impl WeakDispatch {
+ /// Attempts to upgrade this `WeakDispatch` to a [`Dispatch`].
+ ///
+ /// Returns `None` if the referenced `Dispatch` has already been dropped.
+ ///
+ /// ## Examples
+ ///
+ /// ```
+ /// # use tracing_core::subscriber::NoSubscriber;
+ /// # use tracing_core::dispatcher::Dispatch;
+ /// let strong = Dispatch::new(NoSubscriber::default());
+ /// let weak = strong.downgrade();
+ ///
+ /// // The strong here keeps it alive, so we can still access the object.
+ /// assert!(weak.upgrade().is_some());
+ ///
+ /// drop(strong); // But not any more.
+ /// assert!(weak.upgrade().is_none());
+ /// ```
+ pub fn upgrade(&self) -> Option<Dispatch> {
+ self.subscriber
+ .upgrade()
+ .map(|subscriber| Dispatch { subscriber })
+ }
+}
+
+impl fmt::Debug for WeakDispatch {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.subscriber {
+ Kind::Scoped(ref s) => f
+ .debug_tuple("WeakDispatch::Scoped")
+ .field(&format_args!("{:p}", s))
+ .finish(),
+ Kind::Global(s) => f
+ .debug_tuple("WeakDispatch::Global")
+ .field(&format_args!("{:p}", s))
+ .finish(),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl Registrar {
+ pub(crate) fn upgrade(&self) -> Option<Dispatch> {
+ self.0.upgrade().map(|subscriber| Dispatch { subscriber })
+ }
+}
+
+// ===== impl State =====
+
+impl Kind<Arc<dyn Subscriber + Send + Sync>> {
+ fn downgrade(&self) -> Kind<Weak<dyn Subscriber + Send + Sync>> {
+ match self {
+ Kind::Global(s) => Kind::Global(*s),
+ Kind::Scoped(ref s) => Kind::Scoped(Arc::downgrade(s)),
+ }
+ }
+}
+
+impl Kind<Weak<dyn Subscriber + Send + Sync>> {
+ fn upgrade(&self) -> Option<Kind<Arc<dyn Subscriber + Send + Sync>>> {
+ match self {
+ Kind::Global(s) => Some(Kind::Global(*s)),
+ Kind::Scoped(ref s) => Some(Kind::Scoped(s.upgrade()?)),
+ }
+ }
+}
+
+// ===== impl State =====
+
+#[cfg(feature = "std")]
+impl State {
+ /// Replaces the current default dispatcher on this thread with the provided
+ /// dispatcher.Any
+ ///
+ /// Dropping the returned `ResetGuard` will reset the default dispatcher to
+ /// the previous value.
+ #[inline]
+ fn set_default(new_dispatch: Dispatch) -> DefaultGuard {
+ let prior = CURRENT_STATE
+ .try_with(|state| {
+ state.can_enter.set(true);
+ state.default.replace(Some(new_dispatch))
+ })
+ .ok()
+ .flatten();
+ EXISTS.store(true, Ordering::Release);
+ SCOPED_COUNT.fetch_add(1, Ordering::Release);
+ DefaultGuard(prior)
+ }
+
+ #[inline]
+ fn enter(&self) -> Option<Entered<'_>> {
+ if self.can_enter.replace(false) {
+ Some(Entered(self))
+ } else {
+ None
+ }
+ }
+}
+
+// ===== impl Entered =====
+
+#[cfg(feature = "std")]
+impl<'a> Entered<'a> {
+ #[inline]
+ fn current(&self) -> Ref<'a, Dispatch> {
+ let default = self.0.default.borrow();
+ Ref::map(default, |default| match default {
+ Some(default) => default,
+ None => get_global(),
+ })
+ }
+}
+
+#[cfg(feature = "std")]
+impl<'a> Drop for Entered<'a> {
+ #[inline]
+ fn drop(&mut self) {
+ self.0.can_enter.set(true);
+ }
+}
+
+// ===== impl DefaultGuard =====
+
+#[cfg(feature = "std")]
+impl Drop for DefaultGuard {
+ #[inline]
+ fn drop(&mut self) {
+ // Replace the dispatcher and then drop the old one outside
+ // of the thread-local context. Dropping the dispatch may
+ // lead to the drop of a subscriber which, in the process,
+ // could then also attempt to access the same thread local
+ // state -- causing a clash.
+ let prev = CURRENT_STATE.try_with(|state| state.default.replace(self.0.take()));
+ SCOPED_COUNT.fetch_sub(1, Ordering::Release);
+ drop(prev)
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ #[cfg(feature = "std")]
+ use crate::stdlib::sync::atomic::{AtomicUsize, Ordering};
+ use crate::{
+ callsite::Callsite,
+ metadata::{Kind, Level, Metadata},
+ subscriber::Interest,
+ };
+
+ #[test]
+ fn dispatch_is() {
+ let dispatcher = Dispatch::new(NoSubscriber::default());
+ assert!(dispatcher.is::<NoSubscriber>());
+ }
+
+ #[test]
+ fn dispatch_downcasts() {
+ let dispatcher = Dispatch::new(NoSubscriber::default());
+ assert!(dispatcher.downcast_ref::<NoSubscriber>().is_some());
+ }
+
+ struct TestCallsite;
+ static TEST_CALLSITE: TestCallsite = TestCallsite;
+ static TEST_META: Metadata<'static> = metadata! {
+ name: "test",
+ target: module_path!(),
+ level: Level::DEBUG,
+ fields: &[],
+ callsite: &TEST_CALLSITE,
+ kind: Kind::EVENT
+ };
+
+ impl Callsite for TestCallsite {
+ fn set_interest(&self, _: Interest) {}
+ fn metadata(&self) -> &Metadata<'_> {
+ &TEST_META
+ }
+ }
+
+ #[test]
+ #[cfg(feature = "std")]
+ fn events_dont_infinite_loop() {
+ // This test ensures that an event triggered within a subscriber
+ // won't cause an infinite loop of events.
+ struct TestSubscriber;
+ impl Subscriber for TestSubscriber {
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(0xAAAA)
+ }
+
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+
+ fn event(&self, _: &Event<'_>) {
+ static EVENTS: AtomicUsize = AtomicUsize::new(0);
+ assert_eq!(
+ EVENTS.fetch_add(1, Ordering::Relaxed),
+ 0,
+ "event method called twice!"
+ );
+ Event::dispatch(&TEST_META, &TEST_META.fields().value_set(&[]))
+ }
+
+ fn enter(&self, _: &span::Id) {}
+
+ fn exit(&self, _: &span::Id) {}
+ }
+
+ with_default(&Dispatch::new(TestSubscriber), || {
+ Event::dispatch(&TEST_META, &TEST_META.fields().value_set(&[]))
+ })
+ }
+
+ #[test]
+ #[cfg(feature = "std")]
+ fn spans_dont_infinite_loop() {
+ // This test ensures that a span created within a subscriber
+ // won't cause an infinite loop of new spans.
+
+ fn mk_span() {
+ get_default(|current| {
+ current.new_span(&span::Attributes::new(
+ &TEST_META,
+ &TEST_META.fields().value_set(&[]),
+ ))
+ });
+ }
+
+ struct TestSubscriber;
+ impl Subscriber for TestSubscriber {
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ static NEW_SPANS: AtomicUsize = AtomicUsize::new(0);
+ assert_eq!(
+ NEW_SPANS.fetch_add(1, Ordering::Relaxed),
+ 0,
+ "new_span method called twice!"
+ );
+ mk_span();
+ span::Id::from_u64(0xAAAA)
+ }
+
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+
+ fn event(&self, _: &Event<'_>) {}
+
+ fn enter(&self, _: &span::Id) {}
+
+ fn exit(&self, _: &span::Id) {}
+ }
+
+ with_default(&Dispatch::new(TestSubscriber), mk_span)
+ }
+
+ #[test]
+ fn default_no_subscriber() {
+ let default_dispatcher = Dispatch::default();
+ assert!(default_dispatcher.is::<NoSubscriber>());
+ }
+
+ #[cfg(feature = "std")]
+ #[test]
+ fn default_dispatch() {
+ struct TestSubscriber;
+ impl Subscriber for TestSubscriber {
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(0xAAAA)
+ }
+
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+
+ fn event(&self, _: &Event<'_>) {}
+
+ fn enter(&self, _: &span::Id) {}
+
+ fn exit(&self, _: &span::Id) {}
+ }
+ let guard = set_default(&Dispatch::new(TestSubscriber));
+ let default_dispatcher = Dispatch::default();
+ assert!(default_dispatcher.is::<TestSubscriber>());
+
+ drop(guard);
+ let default_dispatcher = Dispatch::default();
+ assert!(default_dispatcher.is::<NoSubscriber>());
+ }
+}
diff --git a/crates/tracing-core/src/event.rs b/crates/tracing-core/src/event.rs
new file mode 100644
index 0000000..6e25437
--- /dev/null
+++ b/crates/tracing-core/src/event.rs
@@ -0,0 +1,128 @@
+//! Events represent single points in time during the execution of a program.
+use crate::parent::Parent;
+use crate::span::Id;
+use crate::{field, Metadata};
+
+/// `Event`s represent single points in time where something occurred during the
+/// execution of a program.
+///
+/// An `Event` can be compared to a log record in unstructured logging, but with
+/// two key differences:
+/// - `Event`s exist _within the context of a [span]_. Unlike log lines, they
+/// may be located within the trace tree, allowing visibility into the
+/// _temporal_ context in which the event occurred, as well as the source
+/// code location.
+/// - Like spans, `Event`s have structured key-value data known as _[fields]_,
+/// which may include textual message. In general, a majority of the data
+/// associated with an event should be in the event's fields rather than in
+/// the textual message, as the fields are more structured.
+///
+/// [span]: super::span
+/// [fields]: super::field
+#[derive(Debug)]
+pub struct Event<'a> {
+ fields: &'a field::ValueSet<'a>,
+ metadata: &'static Metadata<'static>,
+ parent: Parent,
+}
+
+impl<'a> Event<'a> {
+ /// Constructs a new `Event` with the specified metadata and set of values,
+ /// and observes it with the current subscriber.
+ pub fn dispatch(metadata: &'static Metadata<'static>, fields: &'a field::ValueSet<'_>) {
+ let event = Event::new(metadata, fields);
+ crate::dispatcher::get_default(|current| {
+ current.event(&event);
+ });
+ }
+
+ /// Returns a new `Event` in the current span, with the specified metadata
+ /// and set of values.
+ #[inline]
+ pub fn new(metadata: &'static Metadata<'static>, fields: &'a field::ValueSet<'a>) -> Self {
+ Event {
+ fields,
+ metadata,
+ parent: Parent::Current,
+ }
+ }
+
+ /// Returns a new `Event` as a child of the specified span, with the
+ /// provided metadata and set of values.
+ #[inline]
+ pub fn new_child_of(
+ parent: impl Into<Option<Id>>,
+ metadata: &'static Metadata<'static>,
+ fields: &'a field::ValueSet<'a>,
+ ) -> Self {
+ let parent = match parent.into() {
+ Some(p) => Parent::Explicit(p),
+ None => Parent::Root,
+ };
+ Event {
+ fields,
+ metadata,
+ parent,
+ }
+ }
+
+ /// Constructs a new `Event` with the specified metadata and set of values,
+ /// and observes it with the current subscriber and an explicit parent.
+ pub fn child_of(
+ parent: impl Into<Option<Id>>,
+ metadata: &'static Metadata<'static>,
+ fields: &'a field::ValueSet<'_>,
+ ) {
+ let event = Self::new_child_of(parent, metadata, fields);
+ crate::dispatcher::get_default(|current| {
+ current.event(&event);
+ });
+ }
+
+ /// Visits all the fields on this `Event` with the specified [visitor].
+ ///
+ /// [visitor]: super::field::Visit
+ #[inline]
+ pub fn record(&self, visitor: &mut dyn field::Visit) {
+ self.fields.record(visitor);
+ }
+
+ /// Returns an iterator over the set of values on this `Event`.
+ pub fn fields(&self) -> field::Iter {
+ self.fields.field_set().iter()
+ }
+
+ /// Returns [metadata] describing this `Event`.
+ ///
+ /// [metadata]: super::Metadata
+ pub fn metadata(&self) -> &'static Metadata<'static> {
+ self.metadata
+ }
+
+ /// Returns true if the new event should be a root.
+ pub fn is_root(&self) -> bool {
+ matches!(self.parent, Parent::Root)
+ }
+
+ /// Returns true if the new event's parent should be determined based on the
+ /// current context.
+ ///
+ /// If this is true and the current thread is currently inside a span, then
+ /// that span should be the new event's parent. Otherwise, if the current
+ /// thread is _not_ inside a span, then the new event will be the root of its
+ /// own trace tree.
+ pub fn is_contextual(&self) -> bool {
+ matches!(self.parent, Parent::Current)
+ }
+
+ /// Returns the new event's explicitly-specified parent, if there is one.
+ ///
+ /// Otherwise (if the new event is a root or is a child of the current span),
+ /// returns `None`.
+ pub fn parent(&self) -> Option<&Id> {
+ match self.parent {
+ Parent::Explicit(ref p) => Some(p),
+ _ => None,
+ }
+ }
+}
diff --git a/crates/tracing-core/src/field.rs b/crates/tracing-core/src/field.rs
new file mode 100644
index 0000000..90c4eaa
--- /dev/null
+++ b/crates/tracing-core/src/field.rs
@@ -0,0 +1,1255 @@
+//! `Span` and `Event` key-value data.
+//!
+//! Spans and events may be annotated with key-value data, known as _fields_.
+//! These fields consist of a mapping from a key (corresponding to a `&str` but
+//! represented internally as an array index) to a [`Value`].
+//!
+//! # `Value`s and `Subscriber`s
+//!
+//! `Subscriber`s consume `Value`s as fields attached to [span]s or [`Event`]s.
+//! The set of field keys on a given span or event is defined on its [`Metadata`].
+//! When a span is created, it provides [`Attributes`] to the `Subscriber`'s
+//! [`new_span`] method, containing any fields whose values were provided when
+//! the span was created; and may call the `Subscriber`'s [`record`] method
+//! with additional [`Record`]s if values are added for more of its fields.
+//! Similarly, the [`Event`] type passed to the subscriber's [`event`] method
+//! will contain any fields attached to each event.
+//!
+//! `tracing` represents values as either one of a set of Rust primitives
+//! (`i64`, `u64`, `f64`, `i128`, `u128`, `bool`, and `&str`) or using a
+//! `fmt::Display` or `fmt::Debug` implementation. `Subscriber`s are provided
+//! these primitive value types as `dyn Value` trait objects.
+//!
+//! These trait objects can be formatted using `fmt::Debug`, but may also be
+//! recorded as typed data by calling the [`Value::record`] method on these
+//! trait objects with a _visitor_ implementing the [`Visit`] trait. This trait
+//! represents the behavior used to record values of various types. For example,
+//! an implementation of `Visit` might record integers by incrementing counters
+//! for their field names rather than printing them.
+//!
+//!
+//! # Using `valuable`
+//!
+//! `tracing`'s [`Value`] trait is intentionally minimalist: it supports only a small
+//! number of Rust primitives as typed values, and only permits recording
+//! user-defined types with their [`fmt::Debug`] or [`fmt::Display`]
+//! implementations. However, there are some cases where it may be useful to record
+//! nested values (such as arrays, `Vec`s, or `HashMap`s containing values), or
+//! user-defined `struct` and `enum` types without having to format them as
+//! unstructured text.
+//!
+//! To address `Value`'s limitations, `tracing` offers experimental support for
+//! the [`valuable`] crate, which provides object-safe inspection of structured
+//! values. User-defined types can implement the [`valuable::Valuable`] trait,
+//! and be recorded as a `tracing` field by calling their [`as_value`] method.
+//! If the [`Subscriber`] also supports the `valuable` crate, it can
+//! then visit those types fields as structured values using `valuable`.
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: <code>valuable</code> support is an
+//! <a href = "../index.html#unstable-features">unstable feature</a>. See
+//! the documentation on unstable features for details on how to enable it.
+//! </pre>
+//!
+//! For example:
+//! ```ignore
+//! // Derive `Valuable` for our types:
+//! use valuable::Valuable;
+//!
+//! #[derive(Clone, Debug, Valuable)]
+//! struct User {
+//! name: String,
+//! age: u32,
+//! address: Address,
+//! }
+//!
+//! #[derive(Clone, Debug, Valuable)]
+//! struct Address {
+//! country: String,
+//! city: String,
+//! street: String,
+//! }
+//!
+//! let user = User {
+//! name: "Arwen Undomiel".to_string(),
+//! age: 3000,
+//! address: Address {
+//! country: "Middle Earth".to_string(),
+//! city: "Rivendell".to_string(),
+//! street: "leafy lane".to_string(),
+//! },
+//! };
+//!
+//! // Recording `user` as a `valuable::Value` will allow the `tracing` subscriber
+//! // to traverse its fields as a nested, typed structure:
+//! tracing::info!(current_user = user.as_value());
+//! ```
+//!
+//! Alternatively, the [`valuable()`] function may be used to convert a type
+//! implementing [`Valuable`] into a `tracing` field value.
+//!
+//! When the `valuable` feature is enabled, the [`Visit`] trait will include an
+//! optional [`record_value`] method. `Visit` implementations that wish to
+//! record `valuable` values can implement this method with custom behavior.
+//! If a visitor does not implement `record_value`, the [`valuable::Value`] will
+//! be forwarded to the visitor's [`record_debug`] method.
+//!
+//! [`valuable`]: https://crates.io/crates/valuable
+//! [`as_value`]: valuable::Valuable::as_value
+//! [`Subscriber`]: crate::Subscriber
+//! [`record_value`]: Visit::record_value
+//! [`record_debug`]: Visit::record_debug
+//!
+//! [span]: super::span
+//! [`Event`]: super::event::Event
+//! [`Metadata`]: super::metadata::Metadata
+//! [`Attributes`]: super::span::Attributes
+//! [`Record`]: super::span::Record
+//! [`new_span`]: super::subscriber::Subscriber::new_span
+//! [`record`]: super::subscriber::Subscriber::record
+//! [`event`]: super::subscriber::Subscriber::event
+//! [`Value::record`]: Value::record
+use crate::callsite;
+use crate::stdlib::{
+ borrow::Borrow,
+ fmt,
+ hash::{Hash, Hasher},
+ num,
+ ops::Range,
+ string::String,
+};
+
+use self::private::ValidLen;
+
+/// An opaque key allowing _O_(1) access to a field in a `Span`'s key-value
+/// data.
+///
+/// As keys are defined by the _metadata_ of a span, rather than by an
+/// individual instance of a span, a key may be used to access the same field
+/// across all instances of a given span with the same metadata. Thus, when a
+/// subscriber observes a new span, it need only access a field by name _once_,
+/// and use the key for that name for all other accesses.
+#[derive(Debug)]
+pub struct Field {
+ i: usize,
+ fields: FieldSet,
+}
+
+/// An empty field.
+///
+/// This can be used to indicate that the value of a field is not currently
+/// present but will be recorded later.
+///
+/// When a field's value is `Empty`. it will not be recorded.
+#[derive(Debug, Eq, PartialEq)]
+pub struct Empty;
+
+/// Describes the fields present on a span.
+///
+/// ## Equality
+///
+/// In well-behaved applications, two `FieldSet`s [initialized] with equal
+/// [callsite identifiers] will have identical fields. Consequently, in release
+/// builds, [`FieldSet::eq`] *only* checks that its arguments have equal
+/// callsites. However, the equality of field names is checked in debug builds.
+///
+/// [initialized]: Self::new
+/// [callsite identifiers]: callsite::Identifier
+pub struct FieldSet {
+ /// The names of each field on the described span.
+ names: &'static [&'static str],
+ /// The callsite where the described span originates.
+ callsite: callsite::Identifier,
+}
+
+/// A set of fields and values for a span.
+pub struct ValueSet<'a> {
+ values: &'a [(&'a Field, Option<&'a (dyn Value + 'a)>)],
+ fields: &'a FieldSet,
+}
+
+/// An iterator over a set of fields.
+#[derive(Debug)]
+pub struct Iter {
+ idxs: Range<usize>,
+ fields: FieldSet,
+}
+
+/// Visits typed values.
+///
+/// An instance of `Visit` ("a visitor") represents the logic necessary to
+/// record field values of various types. When an implementor of [`Value`] is
+/// [recorded], it calls the appropriate method on the provided visitor to
+/// indicate the type that value should be recorded as.
+///
+/// When a [`Subscriber`] implementation [records an `Event`] or a
+/// [set of `Value`s added to a `Span`], it can pass an `&mut Visit` to the
+/// `record` method on the provided [`ValueSet`] or [`Event`]. This visitor
+/// will then be used to record all the field-value pairs present on that
+/// `Event` or `ValueSet`.
+///
+/// # Examples
+///
+/// A simple visitor that writes to a string might be implemented like so:
+/// ```
+/// # extern crate tracing_core as tracing;
+/// use std::fmt::{self, Write};
+/// use tracing::field::{Value, Visit, Field};
+/// pub struct StringVisitor<'a> {
+/// string: &'a mut String,
+/// }
+///
+/// impl<'a> Visit for StringVisitor<'a> {
+/// fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+/// write!(self.string, "{} = {:?}; ", field.name(), value).unwrap();
+/// }
+/// }
+/// ```
+/// This visitor will format each recorded value using `fmt::Debug`, and
+/// append the field name and formatted value to the provided string,
+/// regardless of the type of the recorded value. When all the values have
+/// been recorded, the `StringVisitor` may be dropped, allowing the string
+/// to be printed or stored in some other data structure.
+///
+/// The `Visit` trait provides default implementations for `record_i64`,
+/// `record_u64`, `record_bool`, `record_str`, and `record_error`, which simply
+/// forward the recorded value to `record_debug`. Thus, `record_debug` is the
+/// only method which a `Visit` implementation *must* implement. However,
+/// visitors may override the default implementations of these functions in
+/// order to implement type-specific behavior.
+///
+/// Additionally, when a visitor receives a value of a type it does not care
+/// about, it is free to ignore those values completely. For example, a
+/// visitor which only records numeric data might look like this:
+///
+/// ```
+/// # extern crate tracing_core as tracing;
+/// # use std::fmt::{self, Write};
+/// # use tracing::field::{Value, Visit, Field};
+/// pub struct SumVisitor {
+/// sum: i64,
+/// }
+///
+/// impl Visit for SumVisitor {
+/// fn record_i64(&mut self, _field: &Field, value: i64) {
+/// self.sum += value;
+/// }
+///
+/// fn record_u64(&mut self, _field: &Field, value: u64) {
+/// self.sum += value as i64;
+/// }
+///
+/// fn record_debug(&mut self, _field: &Field, _value: &fmt::Debug) {
+/// // Do nothing
+/// }
+/// }
+/// ```
+///
+/// This visitor (which is probably not particularly useful) keeps a running
+/// sum of all the numeric values it records, and ignores all other values. A
+/// more practical example of recording typed values is presented in
+/// `examples/counters.rs`, which demonstrates a very simple metrics system
+/// implemented using `tracing`.
+///
+/// <div class="example-wrap" style="display:inline-block">
+/// <pre class="ignore" style="white-space:normal;font:inherit;">
+/// <strong>Note</strong>: The <code>record_error</code> trait method is only
+/// available when the Rust standard library is present, as it requires the
+/// <code>std::error::Error</code> trait.
+/// </pre></div>
+///
+/// [recorded]: Value::record
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [records an `Event`]: super::subscriber::Subscriber::event
+/// [set of `Value`s added to a `Span`]: super::subscriber::Subscriber::record
+/// [`Event`]: super::event::Event
+pub trait Visit {
+ /// Visits an arbitrary type implementing the [`valuable`] crate's `Valuable` trait.
+ ///
+ /// [`valuable`]: https://docs.rs/valuable
+ #[cfg(all(tracing_unstable, feature = "valuable"))]
+ #[cfg_attr(docsrs, doc(cfg(all(tracing_unstable, feature = "valuable"))))]
+ fn record_value(&mut self, field: &Field, value: valuable::Value<'_>) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit a double-precision floating point value.
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit a signed 64-bit integer value.
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit an unsigned 64-bit integer value.
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit a signed 128-bit integer value.
+ fn record_i128(&mut self, field: &Field, value: i128) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit an unsigned 128-bit integer value.
+ fn record_u128(&mut self, field: &Field, value: u128) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit a boolean value.
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.record_debug(field, &value)
+ }
+
+ /// Visit a string value.
+ fn record_str(&mut self, field: &Field, value: &str) {
+ self.record_debug(field, &value)
+ }
+
+ /// Records a type implementing `Error`.
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This is only enabled when the Rust standard library is
+ /// present.
+ /// </pre>
+ /// </div>
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ self.record_debug(field, &DisplayValue(value))
+ }
+
+ /// Visit a value implementing `fmt::Debug`.
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug);
+}
+
+/// A field value of an erased type.
+///
+/// Implementors of `Value` may call the appropriate typed recording methods on
+/// the [visitor] passed to their `record` method in order to indicate how
+/// their data should be recorded.
+///
+/// [visitor]: Visit
+pub trait Value: crate::sealed::Sealed {
+ /// Visits this value with the given `Visitor`.
+ fn record(&self, key: &Field, visitor: &mut dyn Visit);
+}
+
+/// A `Value` which serializes using `fmt::Display`.
+///
+/// Uses `record_debug` in the `Value` implementation to
+/// avoid an unnecessary evaluation.
+#[derive(Clone)]
+pub struct DisplayValue<T: fmt::Display>(T);
+
+/// A `Value` which serializes as a string using `fmt::Debug`.
+#[derive(Clone)]
+pub struct DebugValue<T: fmt::Debug>(T);
+
+/// Wraps a type implementing `fmt::Display` as a `Value` that can be
+/// recorded using its `Display` implementation.
+pub fn display<T>(t: T) -> DisplayValue<T>
+where
+ T: fmt::Display,
+{
+ DisplayValue(t)
+}
+
+/// Wraps a type implementing `fmt::Debug` as a `Value` that can be
+/// recorded using its `Debug` implementation.
+pub fn debug<T>(t: T) -> DebugValue<T>
+where
+ T: fmt::Debug,
+{
+ DebugValue(t)
+}
+
+/// Wraps a type implementing [`Valuable`] as a `Value` that
+/// can be recorded using its `Valuable` implementation.
+///
+/// [`Valuable`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html
+#[cfg(all(tracing_unstable, feature = "valuable"))]
+#[cfg_attr(docsrs, doc(cfg(all(tracing_unstable, feature = "valuable"))))]
+pub fn valuable<T>(t: &T) -> valuable::Value<'_>
+where
+ T: valuable::Valuable,
+{
+ t.as_value()
+}
+
+// ===== impl Visit =====
+
+impl<'a, 'b> Visit for fmt::DebugStruct<'a, 'b> {
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ self.field(field.name(), value);
+ }
+}
+
+impl<'a, 'b> Visit for fmt::DebugMap<'a, 'b> {
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ self.entry(&format_args!("{}", field), value);
+ }
+}
+
+impl<F> Visit for F
+where
+ F: FnMut(&Field, &dyn fmt::Debug),
+{
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ (self)(field, value)
+ }
+}
+
+// ===== impl Value =====
+
+macro_rules! impl_values {
+ ( $( $record:ident( $( $whatever:tt)+ ) ),+ ) => {
+ $(
+ impl_value!{ $record( $( $whatever )+ ) }
+ )+
+ }
+}
+
+macro_rules! ty_to_nonzero {
+ (u8) => {
+ NonZeroU8
+ };
+ (u16) => {
+ NonZeroU16
+ };
+ (u32) => {
+ NonZeroU32
+ };
+ (u64) => {
+ NonZeroU64
+ };
+ (u128) => {
+ NonZeroU128
+ };
+ (usize) => {
+ NonZeroUsize
+ };
+ (i8) => {
+ NonZeroI8
+ };
+ (i16) => {
+ NonZeroI16
+ };
+ (i32) => {
+ NonZeroI32
+ };
+ (i64) => {
+ NonZeroI64
+ };
+ (i128) => {
+ NonZeroI128
+ };
+ (isize) => {
+ NonZeroIsize
+ };
+}
+
+macro_rules! impl_one_value {
+ (f32, $op:expr, $record:ident) => {
+ impl_one_value!(normal, f32, $op, $record);
+ };
+ (f64, $op:expr, $record:ident) => {
+ impl_one_value!(normal, f64, $op, $record);
+ };
+ (bool, $op:expr, $record:ident) => {
+ impl_one_value!(normal, bool, $op, $record);
+ };
+ ($value_ty:tt, $op:expr, $record:ident) => {
+ impl_one_value!(normal, $value_ty, $op, $record);
+ impl_one_value!(nonzero, $value_ty, $op, $record);
+ };
+ (normal, $value_ty:tt, $op:expr, $record:ident) => {
+ impl $crate::sealed::Sealed for $value_ty {}
+ impl $crate::field::Value for $value_ty {
+ fn record(&self, key: &$crate::field::Field, visitor: &mut dyn $crate::field::Visit) {
+ // `op` is always a function; the closure is used because
+ // sometimes there isn't a real function corresponding to that
+ // operation. the clippy warning is not that useful here.
+ #[allow(clippy::redundant_closure_call)]
+ visitor.$record(key, $op(*self))
+ }
+ }
+ };
+ (nonzero, $value_ty:tt, $op:expr, $record:ident) => {
+ // This `use num::*;` is reported as unused because it gets emitted
+ // for every single invocation of this macro, so there are multiple `use`s.
+ // All but the first are useless indeed.
+ // We need this import because we can't write a path where one part is
+ // the `ty_to_nonzero!($value_ty)` invocation.
+ #[allow(clippy::useless_attribute, unused)]
+ use num::*;
+ impl $crate::sealed::Sealed for ty_to_nonzero!($value_ty) {}
+ impl $crate::field::Value for ty_to_nonzero!($value_ty) {
+ fn record(&self, key: &$crate::field::Field, visitor: &mut dyn $crate::field::Visit) {
+ // `op` is always a function; the closure is used because
+ // sometimes there isn't a real function corresponding to that
+ // operation. the clippy warning is not that useful here.
+ #[allow(clippy::redundant_closure_call)]
+ visitor.$record(key, $op(self.get()))
+ }
+ }
+ };
+}
+
+macro_rules! impl_value {
+ ( $record:ident( $( $value_ty:tt ),+ ) ) => {
+ $(
+ impl_one_value!($value_ty, |this: $value_ty| this, $record);
+ )+
+ };
+ ( $record:ident( $( $value_ty:tt ),+ as $as_ty:ty) ) => {
+ $(
+ impl_one_value!($value_ty, |this: $value_ty| this as $as_ty, $record);
+ )+
+ };
+}
+
+// ===== impl Value =====
+
+impl_values! {
+ record_u64(u64),
+ record_u64(usize, u32, u16, u8 as u64),
+ record_i64(i64),
+ record_i64(isize, i32, i16, i8 as i64),
+ record_u128(u128),
+ record_i128(i128),
+ record_bool(bool),
+ record_f64(f64, f32 as f64)
+}
+
+impl<T: crate::sealed::Sealed> crate::sealed::Sealed for Wrapping<T> {}
+impl<T: crate::field::Value> crate::field::Value for Wrapping<T> {
+ fn record(&self, key: &crate::field::Field, visitor: &mut dyn crate::field::Visit) {
+ self.0.record(key, visitor)
+ }
+}
+
+impl crate::sealed::Sealed for str {}
+
+impl Value for str {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_str(key, self)
+ }
+}
+
+#[cfg(feature = "std")]
+impl crate::sealed::Sealed for dyn std::error::Error + 'static {}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl Value for dyn std::error::Error + 'static {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_error(key, self)
+ }
+}
+
+#[cfg(feature = "std")]
+impl crate::sealed::Sealed for dyn std::error::Error + Send + 'static {}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl Value for dyn std::error::Error + Send + 'static {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ (self as &dyn std::error::Error).record(key, visitor)
+ }
+}
+
+#[cfg(feature = "std")]
+impl crate::sealed::Sealed for dyn std::error::Error + Sync + 'static {}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl Value for dyn std::error::Error + Sync + 'static {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ (self as &dyn std::error::Error).record(key, visitor)
+ }
+}
+
+#[cfg(feature = "std")]
+impl crate::sealed::Sealed for dyn std::error::Error + Send + Sync + 'static {}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl Value for dyn std::error::Error + Send + Sync + 'static {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ (self as &dyn std::error::Error).record(key, visitor)
+ }
+}
+
+impl<'a, T: ?Sized> crate::sealed::Sealed for &'a T where T: Value + crate::sealed::Sealed + 'a {}
+
+impl<'a, T: ?Sized> Value for &'a T
+where
+ T: Value + 'a,
+{
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ (*self).record(key, visitor)
+ }
+}
+
+impl<'a, T: ?Sized> crate::sealed::Sealed for &'a mut T where T: Value + crate::sealed::Sealed + 'a {}
+
+impl<'a, T: ?Sized> Value for &'a mut T
+where
+ T: Value + 'a,
+{
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ // Don't use `(*self).record(key, visitor)`, otherwise would
+ // cause stack overflow due to `unconditional_recursion`.
+ T::record(self, key, visitor)
+ }
+}
+
+impl<'a> crate::sealed::Sealed for fmt::Arguments<'a> {}
+
+impl<'a> Value for fmt::Arguments<'a> {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_debug(key, self)
+ }
+}
+
+impl<T: ?Sized> crate::sealed::Sealed for crate::stdlib::boxed::Box<T> where T: Value {}
+
+impl<T: ?Sized> Value for crate::stdlib::boxed::Box<T>
+where
+ T: Value,
+{
+ #[inline]
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ self.as_ref().record(key, visitor)
+ }
+}
+
+impl crate::sealed::Sealed for String {}
+impl Value for String {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_str(key, self.as_str())
+ }
+}
+
+impl fmt::Debug for dyn Value {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // We are only going to be recording the field value, so we don't
+ // actually care about the field name here.
+ struct NullCallsite;
+ static NULL_CALLSITE: NullCallsite = NullCallsite;
+ impl crate::callsite::Callsite for NullCallsite {
+ fn set_interest(&self, _: crate::subscriber::Interest) {
+ unreachable!("you somehow managed to register the null callsite?")
+ }
+
+ fn metadata(&self) -> &crate::Metadata<'_> {
+ unreachable!("you somehow managed to access the null callsite?")
+ }
+ }
+
+ static FIELD: Field = Field {
+ i: 0,
+ fields: FieldSet::new(&[], crate::identify_callsite!(&NULL_CALLSITE)),
+ };
+
+ let mut res = Ok(());
+ self.record(&FIELD, &mut |_: &Field, val: &dyn fmt::Debug| {
+ res = write!(f, "{:?}", val);
+ });
+ res
+ }
+}
+
+impl fmt::Display for dyn Value {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Debug::fmt(self, f)
+ }
+}
+
+// ===== impl DisplayValue =====
+
+impl<T: fmt::Display> crate::sealed::Sealed for DisplayValue<T> {}
+
+impl<T> Value for DisplayValue<T>
+where
+ T: fmt::Display,
+{
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_debug(key, self)
+ }
+}
+
+impl<T: fmt::Display> fmt::Debug for DisplayValue<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(self, f)
+ }
+}
+
+impl<T: fmt::Display> fmt::Display for DisplayValue<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+// ===== impl DebugValue =====
+
+impl<T: fmt::Debug> crate::sealed::Sealed for DebugValue<T> {}
+
+impl<T> Value for DebugValue<T>
+where
+ T: fmt::Debug,
+{
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_debug(key, &self.0)
+ }
+}
+
+impl<T: fmt::Debug> fmt::Debug for DebugValue<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+// ===== impl ValuableValue =====
+
+#[cfg(all(tracing_unstable, feature = "valuable"))]
+impl crate::sealed::Sealed for valuable::Value<'_> {}
+
+#[cfg(all(tracing_unstable, feature = "valuable"))]
+#[cfg_attr(docsrs, doc(cfg(all(tracing_unstable, feature = "valuable"))))]
+impl Value for valuable::Value<'_> {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_value(key, *self)
+ }
+}
+
+#[cfg(all(tracing_unstable, feature = "valuable"))]
+impl crate::sealed::Sealed for &'_ dyn valuable::Valuable {}
+
+#[cfg(all(tracing_unstable, feature = "valuable"))]
+#[cfg_attr(docsrs, doc(cfg(all(tracing_unstable, feature = "valuable"))))]
+impl Value for &'_ dyn valuable::Valuable {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ visitor.record_value(key, self.as_value())
+ }
+}
+
+impl crate::sealed::Sealed for Empty {}
+impl Value for Empty {
+ #[inline]
+ fn record(&self, _: &Field, _: &mut dyn Visit) {}
+}
+
+impl<T: Value> crate::sealed::Sealed for Option<T> {}
+
+impl<T: Value> Value for Option<T> {
+ fn record(&self, key: &Field, visitor: &mut dyn Visit) {
+ if let Some(v) = &self {
+ v.record(key, visitor)
+ }
+ }
+}
+
+// ===== impl Field =====
+
+impl Field {
+ /// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
+ /// which defines this field.
+ ///
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
+ #[inline]
+ pub fn callsite(&self) -> callsite::Identifier {
+ self.fields.callsite()
+ }
+
+ /// Returns a string representing the name of the field.
+ pub fn name(&self) -> &'static str {
+ self.fields.names[self.i]
+ }
+}
+
+impl fmt::Display for Field {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad(self.name())
+ }
+}
+
+impl AsRef<str> for Field {
+ fn as_ref(&self) -> &str {
+ self.name()
+ }
+}
+
+impl PartialEq for Field {
+ fn eq(&self, other: &Self) -> bool {
+ self.callsite() == other.callsite() && self.i == other.i
+ }
+}
+
+impl Eq for Field {}
+
+impl Hash for Field {
+ fn hash<H>(&self, state: &mut H)
+ where
+ H: Hasher,
+ {
+ self.callsite().hash(state);
+ self.i.hash(state);
+ }
+}
+
+impl Clone for Field {
+ fn clone(&self) -> Self {
+ Field {
+ i: self.i,
+ fields: FieldSet {
+ names: self.fields.names,
+ callsite: self.fields.callsite(),
+ },
+ }
+ }
+}
+
+// ===== impl FieldSet =====
+
+impl FieldSet {
+ /// Constructs a new `FieldSet` with the given array of field names and callsite.
+ pub const fn new(names: &'static [&'static str], callsite: callsite::Identifier) -> Self {
+ Self { names, callsite }
+ }
+
+ /// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
+ /// which defines this set of fields..
+ ///
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
+ #[inline]
+ pub(crate) fn callsite(&self) -> callsite::Identifier {
+ callsite::Identifier(self.callsite.0)
+ }
+
+ /// Returns the [`Field`] named `name`, or `None` if no such field exists.
+ ///
+ /// [`Field`]: super::Field
+ pub fn field<Q: ?Sized>(&self, name: &Q) -> Option<Field>
+ where
+ Q: Borrow<str>,
+ {
+ let name = &name.borrow();
+ self.names.iter().position(|f| f == name).map(|i| Field {
+ i,
+ fields: FieldSet {
+ names: self.names,
+ callsite: self.callsite(),
+ },
+ })
+ }
+
+ /// Returns `true` if `self` contains the given `field`.
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: If <code>field</code> shares a name with a field
+ /// in this <code>FieldSet</code>, but was created by a <code>FieldSet</code>
+ /// with a different callsite, this <code>FieldSet</code> does <em>not</em>
+ /// contain it. This is so that if two separate span callsites define a field
+ /// named "foo", the <code>Field</code> corresponding to "foo" for each
+ /// of those callsites are not equivalent.
+ /// </pre></div>
+ pub fn contains(&self, field: &Field) -> bool {
+ field.callsite() == self.callsite() && field.i <= self.len()
+ }
+
+ /// Returns an iterator over the `Field`s in this `FieldSet`.
+ #[inline]
+ pub fn iter(&self) -> Iter {
+ let idxs = 0..self.len();
+ Iter {
+ idxs,
+ fields: FieldSet {
+ names: self.names,
+ callsite: self.callsite(),
+ },
+ }
+ }
+
+ /// Returns a new `ValueSet` with entries for this `FieldSet`'s values.
+ #[doc(hidden)]
+ pub fn value_set<'v, V>(&'v self, values: &'v V) -> ValueSet<'v>
+ where
+ V: ValidLen<'v>,
+ {
+ ValueSet {
+ fields: self,
+ values: values.borrow(),
+ }
+ }
+
+ /// Returns the number of fields in this `FieldSet`.
+ #[inline]
+ pub fn len(&self) -> usize {
+ self.names.len()
+ }
+
+ /// Returns whether or not this `FieldSet` has fields.
+ #[inline]
+ pub fn is_empty(&self) -> bool {
+ self.names.is_empty()
+ }
+}
+
+impl<'a> IntoIterator for &'a FieldSet {
+ type IntoIter = Iter;
+ type Item = Field;
+ #[inline]
+ fn into_iter(self) -> Self::IntoIter {
+ self.iter()
+ }
+}
+
+impl fmt::Debug for FieldSet {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FieldSet")
+ .field("names", &self.names)
+ .field("callsite", &self.callsite)
+ .finish()
+ }
+}
+
+impl fmt::Display for FieldSet {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_set()
+ .entries(self.names.iter().map(display))
+ .finish()
+ }
+}
+
+impl Eq for FieldSet {}
+
+impl PartialEq for FieldSet {
+ fn eq(&self, other: &Self) -> bool {
+ if core::ptr::eq(&self, &other) {
+ true
+ } else if cfg!(not(debug_assertions)) {
+ // In a well-behaving application, two `FieldSet`s can be assumed to
+ // be totally equal so long as they share the same callsite.
+ self.callsite == other.callsite
+ } else {
+ // However, when debug-assertions are enabled, do NOT assume that
+ // the application is well-behaving; check every the field names of
+ // each `FieldSet` for equality.
+
+ // `FieldSet` is destructured here to ensure a compile-error if the
+ // fields of `FieldSet` change.
+ let Self {
+ names: lhs_names,
+ callsite: lhs_callsite,
+ } = self;
+
+ let Self {
+ names: rhs_names,
+ callsite: rhs_callsite,
+ } = &other;
+
+ // Check callsite equality first, as it is probably cheaper to do
+ // than str equality.
+ lhs_callsite == rhs_callsite && lhs_names == rhs_names
+ }
+ }
+}
+
+// ===== impl Iter =====
+
+impl Iterator for Iter {
+ type Item = Field;
+ #[inline]
+ fn next(&mut self) -> Option<Field> {
+ let i = self.idxs.next()?;
+ Some(Field {
+ i,
+ fields: FieldSet {
+ names: self.fields.names,
+ callsite: self.fields.callsite(),
+ },
+ })
+ }
+}
+
+// ===== impl ValueSet =====
+
+impl<'a> ValueSet<'a> {
+ /// Returns an [`Identifier`] that uniquely identifies the [`Callsite`]
+ /// defining the fields this `ValueSet` refers to.
+ ///
+ /// [`Identifier`]: super::callsite::Identifier
+ /// [`Callsite`]: super::callsite::Callsite
+ #[inline]
+ pub fn callsite(&self) -> callsite::Identifier {
+ self.fields.callsite()
+ }
+
+ /// Visits all the fields in this `ValueSet` with the provided [visitor].
+ ///
+ /// [visitor]: Visit
+ pub fn record(&self, visitor: &mut dyn Visit) {
+ let my_callsite = self.callsite();
+ for (field, value) in self.values {
+ if field.callsite() != my_callsite {
+ continue;
+ }
+ if let Some(value) = value {
+ value.record(field, visitor);
+ }
+ }
+ }
+
+ /// Returns the number of fields in this `ValueSet` that would be visited
+ /// by a given [visitor] to the [`ValueSet::record()`] method.
+ ///
+ /// [visitor]: Visit
+ /// [`ValueSet::record()`]: ValueSet::record()
+ pub fn len(&self) -> usize {
+ let my_callsite = self.callsite();
+ self.values
+ .iter()
+ .filter(|(field, _)| field.callsite() == my_callsite)
+ .count()
+ }
+
+ /// Returns `true` if this `ValueSet` contains a value for the given `Field`.
+ pub(crate) fn contains(&self, field: &Field) -> bool {
+ field.callsite() == self.callsite()
+ && self
+ .values
+ .iter()
+ .any(|(key, val)| *key == field && val.is_some())
+ }
+
+ /// Returns true if this `ValueSet` contains _no_ values.
+ pub fn is_empty(&self) -> bool {
+ let my_callsite = self.callsite();
+ self.values
+ .iter()
+ .all(|(key, val)| val.is_none() || key.callsite() != my_callsite)
+ }
+
+ pub(crate) fn field_set(&self) -> &FieldSet {
+ self.fields
+ }
+}
+
+impl<'a> fmt::Debug for ValueSet<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.values
+ .iter()
+ .fold(&mut f.debug_struct("ValueSet"), |dbg, (key, v)| {
+ if let Some(val) = v {
+ val.record(key, dbg);
+ }
+ dbg
+ })
+ .field("callsite", &self.callsite())
+ .finish()
+ }
+}
+
+impl<'a> fmt::Display for ValueSet<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.values
+ .iter()
+ .fold(&mut f.debug_map(), |dbg, (key, v)| {
+ if let Some(val) = v {
+ val.record(key, dbg);
+ }
+ dbg
+ })
+ .finish()
+ }
+}
+
+// ===== impl ValidLen =====
+
+mod private {
+ use super::*;
+
+ /// Restrictions on `ValueSet` lengths were removed in #2508 but this type remains for backwards compatibility.
+ pub trait ValidLen<'a>: Borrow<[(&'a Field, Option<&'a (dyn Value + 'a)>)]> {}
+
+ impl<'a, const N: usize> ValidLen<'a> for [(&'a Field, Option<&'a (dyn Value + 'a)>); N] {}
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::metadata::{Kind, Level, Metadata};
+ use crate::stdlib::{borrow::ToOwned, string::String};
+
+ // Make sure TEST_CALLSITE_* have non-zero size, so they can't be located at the same address.
+ struct TestCallsite1(u8);
+ static TEST_CALLSITE_1: TestCallsite1 = TestCallsite1(0);
+ static TEST_META_1: Metadata<'static> = metadata! {
+ name: "field_test1",
+ target: module_path!(),
+ level: Level::INFO,
+ fields: &["foo", "bar", "baz"],
+ callsite: &TEST_CALLSITE_1,
+ kind: Kind::SPAN,
+ };
+
+ impl crate::callsite::Callsite for TestCallsite1 {
+ fn set_interest(&self, _: crate::subscriber::Interest) {
+ unimplemented!()
+ }
+
+ fn metadata(&self) -> &Metadata<'_> {
+ &TEST_META_1
+ }
+ }
+
+ struct TestCallsite2(u8);
+ static TEST_CALLSITE_2: TestCallsite2 = TestCallsite2(0);
+ static TEST_META_2: Metadata<'static> = metadata! {
+ name: "field_test2",
+ target: module_path!(),
+ level: Level::INFO,
+ fields: &["foo", "bar", "baz"],
+ callsite: &TEST_CALLSITE_2,
+ kind: Kind::SPAN,
+ };
+
+ impl crate::callsite::Callsite for TestCallsite2 {
+ fn set_interest(&self, _: crate::subscriber::Interest) {
+ unimplemented!()
+ }
+
+ fn metadata(&self) -> &Metadata<'_> {
+ &TEST_META_2
+ }
+ }
+
+ #[test]
+ fn value_set_with_no_values_is_empty() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), None),
+ (&fields.field("bar").unwrap(), None),
+ (&fields.field("baz").unwrap(), None),
+ ];
+ let valueset = fields.value_set(values);
+ assert!(valueset.is_empty());
+ }
+
+ #[test]
+ fn empty_value_set_is_empty() {
+ let fields = TEST_META_1.fields();
+ let valueset = fields.value_set(&[]);
+ assert!(valueset.is_empty());
+ }
+
+ #[test]
+ fn value_sets_with_fields_from_other_callsites_are_empty() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), Some(&1 as &dyn Value)),
+ (&fields.field("bar").unwrap(), Some(&2 as &dyn Value)),
+ (&fields.field("baz").unwrap(), Some(&3 as &dyn Value)),
+ ];
+ let valueset = TEST_META_2.fields().value_set(values);
+ assert!(valueset.is_empty())
+ }
+
+ #[test]
+ fn sparse_value_sets_are_not_empty() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), None),
+ (&fields.field("bar").unwrap(), Some(&57 as &dyn Value)),
+ (&fields.field("baz").unwrap(), None),
+ ];
+ let valueset = fields.value_set(values);
+ assert!(!valueset.is_empty());
+ }
+
+ #[test]
+ fn fields_from_other_callsets_are_skipped() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), None),
+ (
+ &TEST_META_2.fields().field("bar").unwrap(),
+ Some(&57 as &dyn Value),
+ ),
+ (&fields.field("baz").unwrap(), None),
+ ];
+
+ struct MyVisitor;
+ impl Visit for MyVisitor {
+ fn record_debug(&mut self, field: &Field, _: &dyn (crate::stdlib::fmt::Debug)) {
+ assert_eq!(field.callsite(), TEST_META_1.callsite())
+ }
+ }
+ let valueset = fields.value_set(values);
+ valueset.record(&mut MyVisitor);
+ }
+
+ #[test]
+ fn empty_fields_are_skipped() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), Some(&Empty as &dyn Value)),
+ (&fields.field("bar").unwrap(), Some(&57 as &dyn Value)),
+ (&fields.field("baz").unwrap(), Some(&Empty as &dyn Value)),
+ ];
+
+ struct MyVisitor;
+ impl Visit for MyVisitor {
+ fn record_debug(&mut self, field: &Field, _: &dyn (crate::stdlib::fmt::Debug)) {
+ assert_eq!(field.name(), "bar")
+ }
+ }
+ let valueset = fields.value_set(values);
+ valueset.record(&mut MyVisitor);
+ }
+
+ #[test]
+ fn record_debug_fn() {
+ let fields = TEST_META_1.fields();
+ let values = &[
+ (&fields.field("foo").unwrap(), Some(&1 as &dyn Value)),
+ (&fields.field("bar").unwrap(), Some(&2 as &dyn Value)),
+ (&fields.field("baz").unwrap(), Some(&3 as &dyn Value)),
+ ];
+ let valueset = fields.value_set(values);
+ let mut result = String::new();
+ valueset.record(&mut |_: &Field, value: &dyn fmt::Debug| {
+ use crate::stdlib::fmt::Write;
+ write!(&mut result, "{:?}", value).unwrap();
+ });
+ assert_eq!(result, "123".to_owned());
+ }
+
+ #[test]
+ #[cfg(feature = "std")]
+ fn record_error() {
+ let fields = TEST_META_1.fields();
+ let err: Box<dyn std::error::Error + Send + Sync + 'static> =
+ std::io::Error::new(std::io::ErrorKind::Other, "lol").into();
+ let values = &[
+ (&fields.field("foo").unwrap(), Some(&err as &dyn Value)),
+ (&fields.field("bar").unwrap(), Some(&Empty as &dyn Value)),
+ (&fields.field("baz").unwrap(), Some(&Empty as &dyn Value)),
+ ];
+ let valueset = fields.value_set(values);
+ let mut result = String::new();
+ valueset.record(&mut |_: &Field, value: &dyn fmt::Debug| {
+ use core::fmt::Write;
+ write!(&mut result, "{:?}", value).unwrap();
+ });
+ assert_eq!(result, format!("{}", err));
+ }
+}
diff --git a/crates/tracing-core/src/lazy.rs b/crates/tracing-core/src/lazy.rs
new file mode 100644
index 0000000..4f004e6
--- /dev/null
+++ b/crates/tracing-core/src/lazy.rs
@@ -0,0 +1,76 @@
+#[cfg(feature = "std")]
+pub(crate) use once_cell::sync::Lazy;
+
+#[cfg(not(feature = "std"))]
+pub(crate) use self::spin::Lazy;
+
+#[cfg(not(feature = "std"))]
+mod spin {
+ //! This is the `once_cell::sync::Lazy` type, but modified to use our
+ //! `spin::Once` type rather than `OnceCell`. This is used to replace
+ //! `once_cell::sync::Lazy` on `no-std` builds.
+ use crate::spin::Once;
+ use core::{cell::Cell, fmt, ops::Deref};
+
+ /// Re-implementation of `once_cell::sync::Lazy` on top of `spin::Once`
+ /// rather than `OnceCell`.
+ ///
+ /// This is used when the standard library is disabled.
+ pub(crate) struct Lazy<T, F = fn() -> T> {
+ cell: Once<T>,
+ init: Cell<Option<F>>,
+ }
+
+ impl<T: fmt::Debug, F> fmt::Debug for Lazy<T, F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Lazy")
+ .field("cell", &self.cell)
+ .field("init", &"..")
+ .finish()
+ }
+ }
+
+ // We never create a `&F` from a `&Lazy<T, F>` so it is fine to not impl
+ // `Sync` for `F`. We do create a `&mut Option<F>` in `force`, but this is
+ // properly synchronized, so it only happens once so it also does not
+ // contribute to this impl.
+ unsafe impl<T, F: Send> Sync for Lazy<T, F> where Once<T>: Sync {}
+ // auto-derived `Send` impl is OK.
+
+ impl<T, F> Lazy<T, F> {
+ /// Creates a new lazy value with the given initializing function.
+ pub(crate) const fn new(init: F) -> Lazy<T, F> {
+ Lazy {
+ cell: Once::new(),
+ init: Cell::new(Some(init)),
+ }
+ }
+ }
+
+ impl<T, F: FnOnce() -> T> Lazy<T, F> {
+ /// Forces the evaluation of this lazy value and returns a reference to
+ /// the result.
+ ///
+ /// This is equivalent to the `Deref` impl, but is explicit.
+ pub(crate) fn force(this: &Lazy<T, F>) -> &T {
+ this.cell.call_once(|| match this.init.take() {
+ Some(f) => f(),
+ None => panic!("Lazy instance has previously been poisoned"),
+ })
+ }
+ }
+
+ impl<T, F: FnOnce() -> T> Deref for Lazy<T, F> {
+ type Target = T;
+ fn deref(&self) -> &T {
+ Lazy::force(self)
+ }
+ }
+
+ impl<T: Default> Default for Lazy<T> {
+ /// Creates a new lazy value using `Default` as the initializing function.
+ fn default() -> Lazy<T> {
+ Lazy::new(T::default)
+ }
+ }
+}
diff --git a/crates/tracing-core/src/lib.rs b/crates/tracing-core/src/lib.rs
new file mode 100644
index 0000000..d43a6b8
--- /dev/null
+++ b/crates/tracing-core/src/lib.rs
@@ -0,0 +1,293 @@
+//! Core primitives for `tracing`.
+//!
+//! [`tracing`] is a framework for instrumenting Rust programs to collect
+//! structured, event-based diagnostic information. This crate defines the core
+//! primitives of `tracing`.
+//!
+//! This crate provides:
+//!
+//! * [`span::Id`] identifies a span within the execution of a program.
+//!
+//! * [`Event`] represents a single event within a trace.
+//!
+//! * [`Subscriber`], the trait implemented to collect trace data.
+//!
+//! * [`Metadata`] and [`Callsite`] provide information describing spans and
+//! `Event`s.
+//!
+//! * [`Field`], [`FieldSet`], [`Value`], and [`ValueSet`] represent the
+//! structured data attached to a span.
+//!
+//! * [`Dispatch`] allows spans and events to be dispatched to `Subscriber`s.
+//!
+//! In addition, it defines the global callsite registry and per-thread current
+//! dispatcher which other components of the tracing system rely on.
+//!
+//! *Compiler support: [requires `rustc` 1.56+][msrv]*
+//!
+//! [msrv]: #supported-rust-versions
+//!
+//! ## Usage
+//!
+//! Application authors will typically not use this crate directly. Instead,
+//! they will use the [`tracing`] crate, which provides a much more
+//! fully-featured API. However, this crate's API will change very infrequently,
+//! so it may be used when dependencies must be very stable.
+//!
+//! `Subscriber` implementations may depend on `tracing-core` rather than
+//! `tracing`, as the additional APIs provided by `tracing` are primarily useful
+//! for instrumenting libraries and applications, and are generally not
+//! necessary for `Subscriber` implementations.
+//!
+//! The [`tokio-rs/tracing`] repository contains less stable crates designed to
+//! be used with the `tracing` ecosystem. It includes a collection of
+//! `Subscriber` implementations, as well as utility and adapter crates.
+//!
+//! ## Crate Feature Flags
+//!
+//! The following crate [feature flags] are available:
+//!
+//! * `std`: Depend on the Rust standard library (enabled by default).
+//!
+//! `no_std` users may disable this feature with `default-features = false`:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing-core = { version = "0.1.22", default-features = false }
+//! ```
+//!
+//! **Note**:`tracing-core`'s `no_std` support requires `liballoc`.
+//!
+//! ### Unstable Features
+//!
+//! These feature flags enable **unstable** features. The public API may break in 0.1.x
+//! releases. To enable these features, the `--cfg tracing_unstable` must be passed to
+//! `rustc` when compiling.
+//!
+//! The following unstable feature flags are currently available:
+//!
+//! * `valuable`: Enables support for recording [field values] using the
+//! [`valuable`] crate.
+//!
+//! #### Enabling Unstable Features
+//!
+//! The easiest way to set the `tracing_unstable` cfg is to use the `RUSTFLAGS`
+//! env variable when running `cargo` commands:
+//!
+//! ```shell
+//! RUSTFLAGS="--cfg tracing_unstable" cargo build
+//! ```
+//! Alternatively, the following can be added to the `.cargo/config` file in a
+//! project to automatically enable the cfg flag for that project:
+//!
+//! ```toml
+//! [build]
+//! rustflags = ["--cfg", "tracing_unstable"]
+//! ```
+//!
+//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
+//! [field values]: crate::field
+//! [`valuable`]: https://crates.io/crates/valuable
+//!
+//! ## Supported Rust Versions
+//!
+//! Tracing is built against the latest stable release. The minimum supported
+//! version is 1.56. The current Tracing version is not guaranteed to build on
+//! Rust versions earlier than the minimum supported version.
+//!
+//! Tracing follows the same compiler support policies as the rest of the Tokio
+//! project. The current stable Rust compiler and the three most recent minor
+//! versions before it will always be supported. For example, if the current
+//! stable compiler version is 1.69, the minimum supported version will not be
+//! increased past 1.66, three minor versions prior. Increasing the minimum
+//! supported compiler version is not considered a semver breaking change as
+//! long as doing so complies with this policy.
+//!
+//!
+//! [`span::Id`]: span::Id
+//! [`Event`]: event::Event
+//! [`Subscriber`]: subscriber::Subscriber
+//! [`Metadata`]: metadata::Metadata
+//! [`Callsite`]: callsite::Callsite
+//! [`Field`]: field::Field
+//! [`FieldSet`]: field::FieldSet
+//! [`Value`]: field::Value
+//! [`ValueSet`]: field::ValueSet
+//! [`Dispatch`]: dispatcher::Dispatch
+//! [`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing
+//! [`tracing`]: https://crates.io/crates/tracing
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
+ issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
+#![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg), deny(rustdoc::broken_intra_doc_links))]
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub,
+ bad_style,
+ dead_code,
+ improper_ctypes,
+ non_shorthand_field_patterns,
+ no_mangle_generic_items,
+ overflowing_literals,
+ path_statements,
+ patterns_in_fns_without_body,
+ private_in_public,
+ unconditional_recursion,
+ unused,
+ unused_allocation,
+ unused_comparisons,
+ unused_parens,
+ while_true
+)]
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+
+/// Statically constructs an [`Identifier`] for the provided [`Callsite`].
+///
+/// This may be used in contexts such as static initializers.
+///
+/// For example:
+/// ```rust
+/// use tracing_core::{callsite, identify_callsite};
+/// # use tracing_core::{Metadata, subscriber::Interest};
+/// # fn main() {
+/// pub struct MyCallsite {
+/// // ...
+/// }
+/// impl callsite::Callsite for MyCallsite {
+/// # fn set_interest(&self, _: Interest) { unimplemented!() }
+/// # fn metadata(&self) -> &Metadata { unimplemented!() }
+/// // ...
+/// }
+///
+/// static CALLSITE: MyCallsite = MyCallsite {
+/// // ...
+/// };
+///
+/// static CALLSITE_ID: callsite::Identifier = identify_callsite!(&CALLSITE);
+/// # }
+/// ```
+///
+/// [`Identifier`]: callsite::Identifier
+/// [`Callsite`]: callsite::Callsite
+#[macro_export]
+macro_rules! identify_callsite {
+ ($callsite:expr) => {
+ $crate::callsite::Identifier($callsite)
+ };
+}
+
+/// Statically constructs new span [metadata].
+///
+/// /// For example:
+/// ```rust
+/// # use tracing_core::{callsite::Callsite, subscriber::Interest};
+/// use tracing_core::metadata;
+/// use tracing_core::metadata::{Kind, Level, Metadata};
+/// # fn main() {
+/// # pub struct MyCallsite { }
+/// # impl Callsite for MyCallsite {
+/// # fn set_interest(&self, _: Interest) { unimplemented!() }
+/// # fn metadata(&self) -> &Metadata { unimplemented!() }
+/// # }
+/// #
+/// static FOO_CALLSITE: MyCallsite = MyCallsite {
+/// // ...
+/// };
+///
+/// static FOO_METADATA: Metadata = metadata!{
+/// name: "foo",
+/// target: module_path!(),
+/// level: Level::DEBUG,
+/// fields: &["bar", "baz"],
+/// callsite: &FOO_CALLSITE,
+/// kind: Kind::SPAN,
+/// };
+/// # }
+/// ```
+///
+/// [metadata]: metadata::Metadata
+/// [`Metadata::new`]: metadata::Metadata::new
+#[macro_export]
+macro_rules! metadata {
+ (
+ name: $name:expr,
+ target: $target:expr,
+ level: $level:expr,
+ fields: $fields:expr,
+ callsite: $callsite:expr,
+ kind: $kind:expr
+ ) => {
+ $crate::metadata! {
+ name: $name,
+ target: $target,
+ level: $level,
+ fields: $fields,
+ callsite: $callsite,
+ kind: $kind,
+ }
+ };
+ (
+ name: $name:expr,
+ target: $target:expr,
+ level: $level:expr,
+ fields: $fields:expr,
+ callsite: $callsite:expr,
+ kind: $kind:expr,
+ ) => {
+ $crate::metadata::Metadata::new(
+ $name,
+ $target,
+ $level,
+ ::core::option::Option::Some(file!()),
+ ::core::option::Option::Some(line!()),
+ ::core::option::Option::Some(module_path!()),
+ $crate::field::FieldSet::new($fields, $crate::identify_callsite!($callsite)),
+ $kind,
+ )
+ };
+}
+
+pub(crate) mod lazy;
+
+// Trimmed-down vendored version of spin 0.5.2 (0387621)
+// Dependency of no_std lazy_static, not required in a std build
+#[cfg(not(feature = "std"))]
+pub(crate) mod spin;
+
+#[cfg(not(feature = "std"))]
+#[doc(hidden)]
+pub type Once = self::spin::Once<()>;
+
+#[cfg(feature = "std")]
+pub use stdlib::sync::Once;
+
+pub mod callsite;
+pub mod dispatcher;
+pub mod event;
+pub mod field;
+pub mod metadata;
+mod parent;
+pub mod span;
+pub(crate) mod stdlib;
+pub mod subscriber;
+
+#[doc(inline)]
+pub use self::{
+ callsite::Callsite,
+ dispatcher::Dispatch,
+ event::Event,
+ field::Field,
+ metadata::{Level, LevelFilter, Metadata},
+ subscriber::Subscriber,
+};
+
+pub use self::{metadata::Kind, subscriber::Interest};
+
+mod sealed {
+ pub trait Sealed {}
+}
diff --git a/crates/tracing-core/src/metadata.rs b/crates/tracing-core/src/metadata.rs
new file mode 100644
index 0000000..5e475c1
--- /dev/null
+++ b/crates/tracing-core/src/metadata.rs
@@ -0,0 +1,1115 @@
+//! Metadata describing trace data.
+use super::{callsite, field};
+use crate::stdlib::{
+ cmp, fmt,
+ str::FromStr,
+ sync::atomic::{AtomicUsize, Ordering},
+};
+
+/// Metadata describing a [span] or [event].
+///
+/// All spans and events have the following metadata:
+/// - A [name], represented as a static string.
+/// - A [target], a string that categorizes part of the system where the span
+/// or event occurred. The `tracing` macros default to using the module
+/// path where the span or event originated as the target, but it may be
+/// overridden.
+/// - A [verbosity level]. This determines how verbose a given span or event
+/// is, and allows enabling or disabling more verbose diagnostics
+/// situationally. See the documentation for the [`Level`] type for details.
+/// - The names of the [fields] defined by the span or event.
+/// - Whether the metadata corresponds to a span or event.
+///
+/// In addition, the following optional metadata describing the source code
+/// location where the span or event originated _may_ be provided:
+/// - The [file name]
+/// - The [line number]
+/// - The [module path]
+///
+/// Metadata is used by [`Subscriber`]s when filtering spans and events, and it
+/// may also be used as part of their data payload.
+///
+/// When created by the `event!` or `span!` macro, the metadata describing a
+/// particular event or span is constructed statically and exists as a single
+/// static instance. Thus, the overhead of creating the metadata is
+/// _significantly_ lower than that of creating the actual span. Therefore,
+/// filtering is based on metadata, rather than on the constructed span.
+///
+/// ## Equality
+///
+/// In well-behaved applications, two `Metadata` with equal
+/// [callsite identifiers] will be equal in all other ways (i.e., have the same
+/// `name`, `target`, etc.). Consequently, in release builds, [`Metadata::eq`]
+/// *only* checks that its arguments have equal callsites. However, the equality
+/// of `Metadata`'s other fields is checked in debug builds.
+///
+/// [span]: super::span
+/// [event]: super::event
+/// [name]: Self::name
+/// [target]: Self::target
+/// [fields]: Self::fields
+/// [verbosity level]: Self::level
+/// [file name]: Self::file
+/// [line number]: Self::line
+/// [module path]: Self::module_path
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [callsite identifiers]: Self::callsite
+pub struct Metadata<'a> {
+ /// The name of the span described by this metadata.
+ name: &'static str,
+
+ /// The part of the system that the span that this metadata describes
+ /// occurred in.
+ target: &'a str,
+
+ /// The level of verbosity of the described span.
+ level: Level,
+
+ /// The name of the Rust module where the span occurred, or `None` if this
+ /// could not be determined.
+ module_path: Option<&'a str>,
+
+ /// The name of the source code file where the span occurred, or `None` if
+ /// this could not be determined.
+ file: Option<&'a str>,
+
+ /// The line number in the source code file where the span occurred, or
+ /// `None` if this could not be determined.
+ line: Option<u32>,
+
+ /// The names of the key-value fields attached to the described span or
+ /// event.
+ fields: field::FieldSet,
+
+ /// The kind of the callsite.
+ kind: Kind,
+}
+
+/// Indicates whether the callsite is a span or event.
+#[derive(Clone, Eq, PartialEq)]
+pub struct Kind(u8);
+
+/// Describes the level of verbosity of a span or event.
+///
+/// # Comparing Levels
+///
+/// `Level` implements the [`PartialOrd`] and [`Ord`] traits, allowing two
+/// `Level`s to be compared to determine which is considered more or less
+/// verbose. Levels which are more verbose are considered "greater than" levels
+/// which are less verbose, with [`Level::ERROR`] considered the lowest, and
+/// [`Level::TRACE`] considered the highest.
+///
+/// For example:
+/// ```
+/// use tracing_core::Level;
+///
+/// assert!(Level::TRACE > Level::DEBUG);
+/// assert!(Level::ERROR < Level::WARN);
+/// assert!(Level::INFO <= Level::DEBUG);
+/// assert_eq!(Level::TRACE, Level::TRACE);
+/// ```
+///
+/// # Filtering
+///
+/// `Level`s are typically used to implement filtering that determines which
+/// spans and events are enabled. Depending on the use case, more or less
+/// verbose diagnostics may be desired. For example, when running in
+/// development, [`DEBUG`]-level traces may be enabled by default. When running in
+/// production, only [`INFO`]-level and lower traces might be enabled. Libraries
+/// may include very verbose diagnostics at the [`DEBUG`] and/or [`TRACE`] levels.
+/// Applications using those libraries typically chose to ignore those traces. However, when
+/// debugging an issue involving said libraries, it may be useful to temporarily
+/// enable the more verbose traces.
+///
+/// The [`LevelFilter`] type is provided to enable filtering traces by
+/// verbosity. `Level`s can be compared against [`LevelFilter`]s, and
+/// [`LevelFilter`] has a variant for each `Level`, which compares analogously
+/// to that level. In addition, [`LevelFilter`] adds a [`LevelFilter::OFF`]
+/// variant, which is considered "less verbose" than every other `Level`. This is
+/// intended to allow filters to completely disable tracing in a particular context.
+///
+/// For example:
+/// ```
+/// use tracing_core::{Level, LevelFilter};
+///
+/// assert!(LevelFilter::OFF < Level::TRACE);
+/// assert!(LevelFilter::TRACE > Level::DEBUG);
+/// assert!(LevelFilter::ERROR < Level::WARN);
+/// assert!(LevelFilter::INFO <= Level::DEBUG);
+/// assert!(LevelFilter::INFO >= Level::INFO);
+/// ```
+///
+/// ## Examples
+///
+/// Below is a simple example of how a [`Subscriber`] could implement filtering through
+/// a [`LevelFilter`]. When a span or event is recorded, the [`Subscriber::enabled`] method
+/// compares the span or event's `Level` against the configured [`LevelFilter`].
+/// The optional [`Subscriber::max_level_hint`] method can also be implemented to allow spans
+/// and events above a maximum verbosity level to be skipped more efficiently,
+/// often improving performance in short-lived programs.
+///
+/// ```
+/// use tracing_core::{span, Event, Level, LevelFilter, Subscriber, Metadata};
+/// # use tracing_core::span::{Id, Record, Current};
+///
+/// #[derive(Debug)]
+/// pub struct MySubscriber {
+/// /// The most verbose level that this subscriber will enable.
+/// max_level: LevelFilter,
+///
+/// // ...
+/// }
+///
+/// impl MySubscriber {
+/// /// Returns a new `MySubscriber` which will record spans and events up to
+/// /// `max_level`.
+/// pub fn with_max_level(max_level: LevelFilter) -> Self {
+/// Self {
+/// max_level,
+/// // ...
+/// }
+/// }
+/// }
+/// impl Subscriber for MySubscriber {
+/// fn enabled(&self, meta: &Metadata<'_>) -> bool {
+/// // A span or event is enabled if it is at or below the configured
+/// // maximum level.
+/// meta.level() <= &self.max_level
+/// }
+///
+/// // This optional method returns the most verbose level that this
+/// // subscriber will enable. Although implementing this method is not
+/// // *required*, it permits additional optimizations when it is provided,
+/// // allowing spans and events above the max level to be skipped
+/// // more efficiently.
+/// fn max_level_hint(&self) -> Option<LevelFilter> {
+/// Some(self.max_level)
+/// }
+///
+/// // Implement the rest of the subscriber...
+/// fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
+/// // ...
+/// # drop(span); Id::from_u64(1)
+/// }
+
+/// fn event(&self, event: &Event<'_>) {
+/// // ...
+/// # drop(event);
+/// }
+///
+/// // ...
+/// # fn enter(&self, _: &Id) {}
+/// # fn exit(&self, _: &Id) {}
+/// # fn record(&self, _: &Id, _: &Record<'_>) {}
+/// # fn record_follows_from(&self, _: &Id, _: &Id) {}
+/// }
+/// ```
+///
+/// It is worth noting that the `tracing-subscriber` crate provides [additional
+/// APIs][envfilter] for performing more sophisticated filtering, such as
+/// enabling different levels based on which module or crate a span or event is
+/// recorded in.
+///
+/// [`DEBUG`]: Level::DEBUG
+/// [`INFO`]: Level::INFO
+/// [`TRACE`]: Level::TRACE
+/// [`Subscriber::enabled`]: crate::subscriber::Subscriber::enabled
+/// [`Subscriber::max_level_hint`]: crate::subscriber::Subscriber::max_level_hint
+/// [`Subscriber`]: crate::subscriber::Subscriber
+/// [envfilter]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
+pub struct Level(LevelInner);
+
+/// A filter comparable to a verbosity [`Level`].
+///
+/// If a [`Level`] is considered less than a `LevelFilter`, it should be
+/// considered enabled; if greater than or equal to the `LevelFilter`,
+/// that level is disabled. See [`LevelFilter::current`] for more
+/// details.
+///
+/// Note that this is essentially identical to the `Level` type, but with the
+/// addition of an [`OFF`] level that completely disables all trace
+/// instrumentation.
+///
+/// See the documentation for the [`Level`] type to see how `Level`s
+/// and `LevelFilter`s interact.
+///
+/// [`OFF`]: LevelFilter::OFF
+#[repr(transparent)]
+#[derive(Copy, Clone, Eq, PartialEq, Hash)]
+pub struct LevelFilter(Option<Level>);
+
+/// Indicates that a string could not be parsed to a valid level.
+#[derive(Clone, Debug)]
+pub struct ParseLevelFilterError(());
+
+static MAX_LEVEL: AtomicUsize = AtomicUsize::new(LevelFilter::OFF_USIZE);
+
+// ===== impl Metadata =====
+
+impl<'a> Metadata<'a> {
+ /// Construct new metadata for a span or event, with a name, target, level, field
+ /// names, and optional source code location.
+ pub const fn new(
+ name: &'static str,
+ target: &'a str,
+ level: Level,
+ file: Option<&'a str>,
+ line: Option<u32>,
+ module_path: Option<&'a str>,
+ fields: field::FieldSet,
+ kind: Kind,
+ ) -> Self {
+ Metadata {
+ name,
+ target,
+ level,
+ module_path,
+ file,
+ line,
+ fields,
+ kind,
+ }
+ }
+
+ /// Returns the names of the fields on the described span or event.
+ #[inline]
+ pub fn fields(&self) -> &field::FieldSet {
+ &self.fields
+ }
+
+ /// Returns the level of verbosity of the described span or event.
+ pub fn level(&self) -> &Level {
+ &self.level
+ }
+
+ /// Returns the name of the span.
+ pub fn name(&self) -> &'static str {
+ self.name
+ }
+
+ /// Returns a string describing the part of the system where the span or
+ /// event that this metadata describes occurred.
+ ///
+ /// Typically, this is the module path, but alternate targets may be set
+ /// when spans or events are constructed.
+ pub fn target(&self) -> &'a str {
+ self.target
+ }
+
+ /// Returns the path to the Rust module where the span occurred, or
+ /// `None` if the module path is unknown.
+ pub fn module_path(&self) -> Option<&'a str> {
+ self.module_path
+ }
+
+ /// Returns the name of the source code file where the span
+ /// occurred, or `None` if the file is unknown
+ pub fn file(&self) -> Option<&'a str> {
+ self.file
+ }
+
+ /// Returns the line number in the source code file where the span
+ /// occurred, or `None` if the line number is unknown.
+ pub fn line(&self) -> Option<u32> {
+ self.line
+ }
+
+ /// Returns an opaque `Identifier` that uniquely identifies the callsite
+ /// this `Metadata` originated from.
+ #[inline]
+ pub fn callsite(&self) -> callsite::Identifier {
+ self.fields.callsite()
+ }
+
+ /// Returns true if the callsite kind is `Event`.
+ pub fn is_event(&self) -> bool {
+ self.kind.is_event()
+ }
+
+ /// Return true if the callsite kind is `Span`.
+ pub fn is_span(&self) -> bool {
+ self.kind.is_span()
+ }
+}
+
+impl<'a> fmt::Debug for Metadata<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut meta = f.debug_struct("Metadata");
+ meta.field("name", &self.name)
+ .field("target", &self.target)
+ .field("level", &self.level);
+
+ if let Some(path) = self.module_path() {
+ meta.field("module_path", &path);
+ }
+
+ match (self.file(), self.line()) {
+ (Some(file), Some(line)) => {
+ meta.field("location", &format_args!("{}:{}", file, line));
+ }
+ (Some(file), None) => {
+ meta.field("file", &format_args!("{}", file));
+ }
+
+ // Note: a line num with no file is a kind of weird case that _probably_ never occurs...
+ (None, Some(line)) => {
+ meta.field("line", &line);
+ }
+ (None, None) => {}
+ };
+
+ meta.field("fields", &format_args!("{}", self.fields))
+ .field("callsite", &self.callsite())
+ .field("kind", &self.kind)
+ .finish()
+ }
+}
+
+impl Kind {
+ const EVENT_BIT: u8 = 1 << 0;
+ const SPAN_BIT: u8 = 1 << 1;
+ const HINT_BIT: u8 = 1 << 2;
+
+ /// `Event` callsite
+ pub const EVENT: Kind = Kind(Self::EVENT_BIT);
+
+ /// `Span` callsite
+ pub const SPAN: Kind = Kind(Self::SPAN_BIT);
+
+ /// `enabled!` callsite. [`Subscriber`][`crate::subscriber::Subscriber`]s can assume
+ /// this `Kind` means they will never recieve a
+ /// full event with this [`Metadata`].
+ pub const HINT: Kind = Kind(Self::HINT_BIT);
+
+ /// Return true if the callsite kind is `Span`
+ pub fn is_span(&self) -> bool {
+ self.0 & Self::SPAN_BIT == Self::SPAN_BIT
+ }
+
+ /// Return true if the callsite kind is `Event`
+ pub fn is_event(&self) -> bool {
+ self.0 & Self::EVENT_BIT == Self::EVENT_BIT
+ }
+
+ /// Return true if the callsite kind is `Hint`
+ pub fn is_hint(&self) -> bool {
+ self.0 & Self::HINT_BIT == Self::HINT_BIT
+ }
+
+ /// Sets that this `Kind` is a [hint](Self::HINT).
+ ///
+ /// This can be called on [`SPAN`](Self::SPAN) and [`EVENT`](Self::EVENT)
+ /// kinds to construct a hint callsite that also counts as a span or event.
+ pub const fn hint(self) -> Self {
+ Self(self.0 | Self::HINT_BIT)
+ }
+}
+
+impl fmt::Debug for Kind {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str("Kind(")?;
+ let mut has_bits = false;
+ let mut write_bit = |name: &str| {
+ if has_bits {
+ f.write_str(" | ")?;
+ }
+ f.write_str(name)?;
+ has_bits = true;
+ Ok(())
+ };
+
+ if self.is_event() {
+ write_bit("EVENT")?;
+ }
+
+ if self.is_span() {
+ write_bit("SPAN")?;
+ }
+
+ if self.is_hint() {
+ write_bit("HINT")?;
+ }
+
+ // if none of the expected bits were set, something is messed up, so
+ // just print the bits for debugging purposes
+ if !has_bits {
+ write!(f, "{:#b}", self.0)?;
+ }
+
+ f.write_str(")")
+ }
+}
+
+impl<'a> Eq for Metadata<'a> {}
+
+impl<'a> PartialEq for Metadata<'a> {
+ #[inline]
+ fn eq(&self, other: &Self) -> bool {
+ if core::ptr::eq(&self, &other) {
+ true
+ } else if cfg!(not(debug_assertions)) {
+ // In a well-behaving application, two `Metadata` can be assumed to
+ // be totally equal so long as they share the same callsite.
+ self.callsite() == other.callsite()
+ } else {
+ // However, when debug-assertions are enabled, do not assume that
+ // the application is well-behaving; check every field of `Metadata`
+ // for equality.
+
+ // `Metadata` is destructured here to ensure a compile-error if the
+ // fields of `Metadata` change.
+ let Metadata {
+ name: lhs_name,
+ target: lhs_target,
+ level: lhs_level,
+ module_path: lhs_module_path,
+ file: lhs_file,
+ line: lhs_line,
+ fields: lhs_fields,
+ kind: lhs_kind,
+ } = self;
+
+ let Metadata {
+ name: rhs_name,
+ target: rhs_target,
+ level: rhs_level,
+ module_path: rhs_module_path,
+ file: rhs_file,
+ line: rhs_line,
+ fields: rhs_fields,
+ kind: rhs_kind,
+ } = &other;
+
+ // The initial comparison of callsites is purely an optimization;
+ // it can be removed without affecting the overall semantics of the
+ // expression.
+ self.callsite() == other.callsite()
+ && lhs_name == rhs_name
+ && lhs_target == rhs_target
+ && lhs_level == rhs_level
+ && lhs_module_path == rhs_module_path
+ && lhs_file == rhs_file
+ && lhs_line == rhs_line
+ && lhs_fields == rhs_fields
+ && lhs_kind == rhs_kind
+ }
+ }
+}
+
+// ===== impl Level =====
+
+impl Level {
+ /// The "error" level.
+ ///
+ /// Designates very serious errors.
+ pub const ERROR: Level = Level(LevelInner::Error);
+ /// The "warn" level.
+ ///
+ /// Designates hazardous situations.
+ pub const WARN: Level = Level(LevelInner::Warn);
+ /// The "info" level.
+ ///
+ /// Designates useful information.
+ pub const INFO: Level = Level(LevelInner::Info);
+ /// The "debug" level.
+ ///
+ /// Designates lower priority information.
+ pub const DEBUG: Level = Level(LevelInner::Debug);
+ /// The "trace" level.
+ ///
+ /// Designates very low priority, often extremely verbose, information.
+ pub const TRACE: Level = Level(LevelInner::Trace);
+
+ /// Returns the string representation of the `Level`.
+ ///
+ /// This returns the same string as the `fmt::Display` implementation.
+ pub fn as_str(&self) -> &'static str {
+ match *self {
+ Level::TRACE => "TRACE",
+ Level::DEBUG => "DEBUG",
+ Level::INFO => "INFO",
+ Level::WARN => "WARN",
+ Level::ERROR => "ERROR",
+ }
+ }
+}
+
+impl fmt::Display for Level {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ Level::TRACE => f.pad("TRACE"),
+ Level::DEBUG => f.pad("DEBUG"),
+ Level::INFO => f.pad("INFO"),
+ Level::WARN => f.pad("WARN"),
+ Level::ERROR => f.pad("ERROR"),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl crate::stdlib::error::Error for ParseLevelError {}
+
+impl FromStr for Level {
+ type Err = ParseLevelError;
+ fn from_str(s: &str) -> Result<Self, ParseLevelError> {
+ s.parse::<usize>()
+ .map_err(|_| ParseLevelError { _p: () })
+ .and_then(|num| match num {
+ 1 => Ok(Level::ERROR),
+ 2 => Ok(Level::WARN),
+ 3 => Ok(Level::INFO),
+ 4 => Ok(Level::DEBUG),
+ 5 => Ok(Level::TRACE),
+ _ => Err(ParseLevelError { _p: () }),
+ })
+ .or_else(|_| match s {
+ s if s.eq_ignore_ascii_case("error") => Ok(Level::ERROR),
+ s if s.eq_ignore_ascii_case("warn") => Ok(Level::WARN),
+ s if s.eq_ignore_ascii_case("info") => Ok(Level::INFO),
+ s if s.eq_ignore_ascii_case("debug") => Ok(Level::DEBUG),
+ s if s.eq_ignore_ascii_case("trace") => Ok(Level::TRACE),
+ _ => Err(ParseLevelError { _p: () }),
+ })
+ }
+}
+
+#[repr(usize)]
+#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq)]
+enum LevelInner {
+ /// The "trace" level.
+ ///
+ /// Designates very low priority, often extremely verbose, information.
+ Trace = 0,
+ /// The "debug" level.
+ ///
+ /// Designates lower priority information.
+ Debug = 1,
+ /// The "info" level.
+ ///
+ /// Designates useful information.
+ Info = 2,
+ /// The "warn" level.
+ ///
+ /// Designates hazardous situations.
+ Warn = 3,
+ /// The "error" level.
+ ///
+ /// Designates very serious errors.
+ Error = 4,
+}
+
+// === impl LevelFilter ===
+
+impl From<Level> for LevelFilter {
+ #[inline]
+ fn from(level: Level) -> Self {
+ Self::from_level(level)
+ }
+}
+
+impl From<Option<Level>> for LevelFilter {
+ #[inline]
+ fn from(level: Option<Level>) -> Self {
+ Self(level)
+ }
+}
+
+impl From<LevelFilter> for Option<Level> {
+ #[inline]
+ fn from(filter: LevelFilter) -> Self {
+ filter.into_level()
+ }
+}
+
+impl LevelFilter {
+ /// The "off" level.
+ ///
+ /// Designates that trace instrumentation should be completely disabled.
+ pub const OFF: LevelFilter = LevelFilter(None);
+ /// The "error" level.
+ ///
+ /// Designates very serious errors.
+ pub const ERROR: LevelFilter = LevelFilter::from_level(Level::ERROR);
+ /// The "warn" level.
+ ///
+ /// Designates hazardous situations.
+ pub const WARN: LevelFilter = LevelFilter::from_level(Level::WARN);
+ /// The "info" level.
+ ///
+ /// Designates useful information.
+ pub const INFO: LevelFilter = LevelFilter::from_level(Level::INFO);
+ /// The "debug" level.
+ ///
+ /// Designates lower priority information.
+ pub const DEBUG: LevelFilter = LevelFilter::from_level(Level::DEBUG);
+ /// The "trace" level.
+ ///
+ /// Designates very low priority, often extremely verbose, information.
+ pub const TRACE: LevelFilter = LevelFilter(Some(Level::TRACE));
+
+ /// Returns a `LevelFilter` that enables spans and events with verbosity up
+ /// to and including `level`.
+ pub const fn from_level(level: Level) -> Self {
+ Self(Some(level))
+ }
+
+ /// Returns the most verbose [`Level`] that this filter accepts, or `None`
+ /// if it is [`OFF`].
+ ///
+ /// [`OFF`]: LevelFilter::OFF
+ pub const fn into_level(self) -> Option<Level> {
+ self.0
+ }
+
+ // These consts are necessary because `as` casts are not allowed as
+ // match patterns.
+ const ERROR_USIZE: usize = LevelInner::Error as usize;
+ const WARN_USIZE: usize = LevelInner::Warn as usize;
+ const INFO_USIZE: usize = LevelInner::Info as usize;
+ const DEBUG_USIZE: usize = LevelInner::Debug as usize;
+ const TRACE_USIZE: usize = LevelInner::Trace as usize;
+ // Using the value of the last variant + 1 ensures that we match the value
+ // for `Option::None` as selected by the niche optimization for
+ // `LevelFilter`. If this is the case, converting a `usize` value into a
+ // `LevelFilter` (in `LevelFilter::current`) will be an identity conversion,
+ // rather than generating a lookup table.
+ const OFF_USIZE: usize = LevelInner::Error as usize + 1;
+
+ /// Returns a `LevelFilter` that matches the most verbose [`Level`] that any
+ /// currently active [`Subscriber`] will enable.
+ ///
+ /// User code should treat this as a *hint*. If a given span or event has a
+ /// level *higher* than the returned `LevelFilter`, it will not be enabled.
+ /// However, if the level is less than or equal to this value, the span or
+ /// event is *not* guaranteed to be enabled; the subscriber will still
+ /// filter each callsite individually.
+ ///
+ /// Therefore, comparing a given span or event's level to the returned
+ /// `LevelFilter` **can** be used for determining if something is
+ /// *disabled*, but **should not** be used for determining if something is
+ /// *enabled*.
+ ///
+ /// [`Level`]: super::Level
+ /// [`Subscriber`]: super::Subscriber
+ #[inline(always)]
+ pub fn current() -> Self {
+ match MAX_LEVEL.load(Ordering::Relaxed) {
+ Self::ERROR_USIZE => Self::ERROR,
+ Self::WARN_USIZE => Self::WARN,
+ Self::INFO_USIZE => Self::INFO,
+ Self::DEBUG_USIZE => Self::DEBUG,
+ Self::TRACE_USIZE => Self::TRACE,
+ Self::OFF_USIZE => Self::OFF,
+ #[cfg(debug_assertions)]
+ unknown => unreachable!(
+ "/!\\ `LevelFilter` representation seems to have changed! /!\\ \n\
+ This is a bug (and it's pretty bad). Please contact the `tracing` \
+ maintainers. Thank you and I'm sorry.\n \
+ The offending repr was: {:?}",
+ unknown,
+ ),
+ #[cfg(not(debug_assertions))]
+ _ => unsafe {
+ // Using `unreachable_unchecked` here (rather than
+ // `unreachable!()`) is necessary to ensure that rustc generates
+ // an identity conversion from integer -> discriminant, rather
+ // than generating a lookup table. We want to ensure this
+ // function is a single `mov` instruction (on x86) if at all
+ // possible, because it is called *every* time a span/event
+ // callsite is hit; and it is (potentially) the only code in the
+ // hottest path for skipping a majority of callsites when level
+ // filtering is in use.
+ //
+ // safety: This branch is only truly unreachable if we guarantee
+ // that no values other than the possible enum discriminants
+ // will *ever* be present. The `AtomicUsize` is initialized to
+ // the `OFF` value. It is only set by the `set_max` function,
+ // which takes a `LevelFilter` as a parameter. This restricts
+ // the inputs to `set_max` to the set of valid discriminants.
+ // Therefore, **as long as `MAX_VALUE` is only ever set by
+ // `set_max`**, this is safe.
+ crate::stdlib::hint::unreachable_unchecked()
+ },
+ }
+ }
+
+ pub(crate) fn set_max(LevelFilter(level): LevelFilter) {
+ let val = match level {
+ Some(Level(level)) => level as usize,
+ None => Self::OFF_USIZE,
+ };
+
+ // using an AcqRel swap ensures an ordered relationship of writes to the
+ // max level.
+ MAX_LEVEL.swap(val, Ordering::AcqRel);
+ }
+}
+
+impl fmt::Display for LevelFilter {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ LevelFilter::OFF => f.pad("off"),
+ LevelFilter::ERROR => f.pad("error"),
+ LevelFilter::WARN => f.pad("warn"),
+ LevelFilter::INFO => f.pad("info"),
+ LevelFilter::DEBUG => f.pad("debug"),
+ LevelFilter::TRACE => f.pad("trace"),
+ }
+ }
+}
+
+impl fmt::Debug for LevelFilter {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ LevelFilter::OFF => f.pad("LevelFilter::OFF"),
+ LevelFilter::ERROR => f.pad("LevelFilter::ERROR"),
+ LevelFilter::WARN => f.pad("LevelFilter::WARN"),
+ LevelFilter::INFO => f.pad("LevelFilter::INFO"),
+ LevelFilter::DEBUG => f.pad("LevelFilter::DEBUG"),
+ LevelFilter::TRACE => f.pad("LevelFilter::TRACE"),
+ }
+ }
+}
+
+impl FromStr for LevelFilter {
+ type Err = ParseLevelFilterError;
+ fn from_str(from: &str) -> Result<Self, Self::Err> {
+ from.parse::<usize>()
+ .ok()
+ .and_then(|num| match num {
+ 0 => Some(LevelFilter::OFF),
+ 1 => Some(LevelFilter::ERROR),
+ 2 => Some(LevelFilter::WARN),
+ 3 => Some(LevelFilter::INFO),
+ 4 => Some(LevelFilter::DEBUG),
+ 5 => Some(LevelFilter::TRACE),
+ _ => None,
+ })
+ .or_else(|| match from {
+ "" => Some(LevelFilter::ERROR),
+ s if s.eq_ignore_ascii_case("error") => Some(LevelFilter::ERROR),
+ s if s.eq_ignore_ascii_case("warn") => Some(LevelFilter::WARN),
+ s if s.eq_ignore_ascii_case("info") => Some(LevelFilter::INFO),
+ s if s.eq_ignore_ascii_case("debug") => Some(LevelFilter::DEBUG),
+ s if s.eq_ignore_ascii_case("trace") => Some(LevelFilter::TRACE),
+ s if s.eq_ignore_ascii_case("off") => Some(LevelFilter::OFF),
+ _ => None,
+ })
+ .ok_or(ParseLevelFilterError(()))
+ }
+}
+
+/// Returned if parsing a `Level` fails.
+#[derive(Debug)]
+pub struct ParseLevelError {
+ _p: (),
+}
+
+impl fmt::Display for ParseLevelError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad(
+ "error parsing level: expected one of \"error\", \"warn\", \
+ \"info\", \"debug\", \"trace\", or a number 1-5",
+ )
+ }
+}
+
+impl fmt::Display for ParseLevelFilterError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad(
+ "error parsing level filter: expected one of \"off\", \"error\", \
+ \"warn\", \"info\", \"debug\", \"trace\", or a number 0-5",
+ )
+ }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for ParseLevelFilterError {}
+
+// ==== Level and LevelFilter comparisons ====
+
+// /!\ BIG, IMPORTANT WARNING /!\
+// Do NOT mess with these implementations! They are hand-written for a reason!
+//
+// Since comparing `Level`s and `LevelFilter`s happens in a *very* hot path
+// (potentially, every time a span or event macro is hit, regardless of whether
+// or not is enabled), we *need* to ensure that these comparisons are as fast as
+// possible. Therefore, we have some requirements:
+//
+// 1. We want to do our best to ensure that rustc will generate integer-integer
+// comparisons wherever possible.
+//
+// The derived `Ord`/`PartialOrd` impls for `LevelFilter` will not do this,
+// because `LevelFilter`s are represented by `Option<Level>`, rather than as
+// a separate `#[repr(usize)]` enum. This was (unfortunately) necessary for
+// backwards-compatibility reasons, as the `tracing` crate's original
+// version of `LevelFilter` defined `const fn` conversions between `Level`s
+// and `LevelFilter`, so we're stuck with the `Option<Level>` repr.
+// Therefore, we need hand-written `PartialOrd` impls that cast both sides of
+// the comparison to `usize`s, to force the compiler to generate integer
+// compares.
+//
+// 2. The hottest `Level`/`LevelFilter` comparison, the one that happens every
+// time a callsite is hit, occurs *within the `tracing` crate's macros*.
+// This means that the comparison is happening *inside* a crate that
+// *depends* on `tracing-core`, not in `tracing-core` itself. The compiler
+// will only inline function calls across crate boundaries if the called
+// function is annotated with an `#[inline]` attribute, and we *definitely*
+// want the comparison functions to be inlined: as previously mentioned, they
+// should compile down to a single integer comparison on release builds, and
+// it seems really sad to push an entire stack frame to call a function
+// consisting of one `cmp` instruction!
+//
+// Therefore, we need to ensure that all the comparison methods have
+// `#[inline]` or `#[inline(always)]` attributes. It's not sufficient to just
+// add the attribute to `partial_cmp` in a manual implementation of the
+// trait, since it's the comparison operators (`lt`, `le`, `gt`, and `ge`)
+// that will actually be *used*, and the default implementation of *those*
+// methods, which calls `partial_cmp`, does not have an inline annotation.
+//
+// 3. We need the comparisons to be inverted. The discriminants for the
+// `LevelInner` enum are assigned in "backwards" order, with `TRACE` having
+// the *lowest* value. However, we want `TRACE` to compare greater-than all
+// other levels.
+//
+// Why are the numeric values inverted? In order to ensure that `LevelFilter`
+// (which, as previously mentioned, *has* to be internally represented by an
+// `Option<Level>`) compiles down to a single integer value. This is
+// necessary for storing the global max in an `AtomicUsize`, and for ensuring
+// that we use fast integer-integer comparisons, as mentioned previously. In
+// order to ensure this, we exploit the niche optimization. The niche
+// optimization for `Option<{enum with a numeric repr}>` will choose
+// `(HIGHEST_DISCRIMINANT_VALUE + 1)` as the representation for `None`.
+// Therefore, the integer representation of `LevelFilter::OFF` (which is
+// `None`) will be the number 5. `OFF` must compare higher than every other
+// level in order for it to filter as expected. Since we want to use a single
+// `cmp` instruction, we can't special-case the integer value of `OFF` to
+// compare higher, as that will generate more code. Instead, we need it to be
+// on one end of the enum, with `ERROR` on the opposite end, so we assign the
+// value 0 to `ERROR`.
+//
+// This *does* mean that when parsing `LevelFilter`s or `Level`s from
+// `String`s, the integer values are inverted, but that doesn't happen in a
+// hot path.
+//
+// Note that we manually invert the comparisons by swapping the left-hand and
+// right-hand side. Using `Ordering::reverse` generates significantly worse
+// code (per Matt Godbolt's Compiler Explorer).
+//
+// Anyway, that's a brief history of why this code is the way it is. Don't
+// change it unless you know what you're doing.
+
+impl PartialEq<LevelFilter> for Level {
+ #[inline(always)]
+ fn eq(&self, other: &LevelFilter) -> bool {
+ self.0 as usize == filter_as_usize(&other.0)
+ }
+}
+
+impl PartialOrd for Level {
+ #[inline(always)]
+ fn partial_cmp(&self, other: &Level) -> Option<cmp::Ordering> {
+ Some(self.cmp(other))
+ }
+
+ #[inline(always)]
+ fn lt(&self, other: &Level) -> bool {
+ (other.0 as usize) < (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn le(&self, other: &Level) -> bool {
+ (other.0 as usize) <= (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn gt(&self, other: &Level) -> bool {
+ (other.0 as usize) > (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn ge(&self, other: &Level) -> bool {
+ (other.0 as usize) >= (self.0 as usize)
+ }
+}
+
+impl Ord for Level {
+ #[inline(always)]
+ fn cmp(&self, other: &Self) -> cmp::Ordering {
+ (other.0 as usize).cmp(&(self.0 as usize))
+ }
+}
+
+impl PartialOrd<LevelFilter> for Level {
+ #[inline(always)]
+ fn partial_cmp(&self, other: &LevelFilter) -> Option<cmp::Ordering> {
+ Some(filter_as_usize(&other.0).cmp(&(self.0 as usize)))
+ }
+
+ #[inline(always)]
+ fn lt(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) < (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn le(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) <= (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn gt(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) > (self.0 as usize)
+ }
+
+ #[inline(always)]
+ fn ge(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) >= (self.0 as usize)
+ }
+}
+
+#[inline(always)]
+fn filter_as_usize(x: &Option<Level>) -> usize {
+ match x {
+ Some(Level(f)) => *f as usize,
+ None => LevelFilter::OFF_USIZE,
+ }
+}
+
+impl PartialEq<Level> for LevelFilter {
+ #[inline(always)]
+ fn eq(&self, other: &Level) -> bool {
+ filter_as_usize(&self.0) == other.0 as usize
+ }
+}
+
+impl PartialOrd for LevelFilter {
+ #[inline(always)]
+ fn partial_cmp(&self, other: &LevelFilter) -> Option<cmp::Ordering> {
+ Some(self.cmp(other))
+ }
+
+ #[inline(always)]
+ fn lt(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) < filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn le(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) <= filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn gt(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) > filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn ge(&self, other: &LevelFilter) -> bool {
+ filter_as_usize(&other.0) >= filter_as_usize(&self.0)
+ }
+}
+
+impl Ord for LevelFilter {
+ #[inline(always)]
+ fn cmp(&self, other: &Self) -> cmp::Ordering {
+ filter_as_usize(&other.0).cmp(&filter_as_usize(&self.0))
+ }
+}
+
+impl PartialOrd<Level> for LevelFilter {
+ #[inline(always)]
+ fn partial_cmp(&self, other: &Level) -> Option<cmp::Ordering> {
+ Some((other.0 as usize).cmp(&filter_as_usize(&self.0)))
+ }
+
+ #[inline(always)]
+ fn lt(&self, other: &Level) -> bool {
+ (other.0 as usize) < filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn le(&self, other: &Level) -> bool {
+ (other.0 as usize) <= filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn gt(&self, other: &Level) -> bool {
+ (other.0 as usize) > filter_as_usize(&self.0)
+ }
+
+ #[inline(always)]
+ fn ge(&self, other: &Level) -> bool {
+ (other.0 as usize) >= filter_as_usize(&self.0)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::stdlib::mem;
+
+ #[test]
+ fn level_from_str() {
+ assert_eq!("error".parse::<Level>().unwrap(), Level::ERROR);
+ assert_eq!("4".parse::<Level>().unwrap(), Level::DEBUG);
+ assert!("0".parse::<Level>().is_err())
+ }
+
+ #[test]
+ fn filter_level_conversion() {
+ let mapping = [
+ (LevelFilter::OFF, None),
+ (LevelFilter::ERROR, Some(Level::ERROR)),
+ (LevelFilter::WARN, Some(Level::WARN)),
+ (LevelFilter::INFO, Some(Level::INFO)),
+ (LevelFilter::DEBUG, Some(Level::DEBUG)),
+ (LevelFilter::TRACE, Some(Level::TRACE)),
+ ];
+ for (filter, level) in mapping.iter() {
+ assert_eq!(filter.into_level(), *level);
+ match level {
+ Some(level) => {
+ let actual: LevelFilter = (*level).into();
+ assert_eq!(actual, *filter);
+ }
+ None => {
+ let actual: LevelFilter = None.into();
+ assert_eq!(actual, *filter);
+ }
+ }
+ }
+ }
+
+ #[test]
+ fn level_filter_is_usize_sized() {
+ assert_eq!(
+ mem::size_of::<LevelFilter>(),
+ mem::size_of::<usize>(),
+ "`LevelFilter` is no longer `usize`-sized! global MAX_LEVEL may now be invalid!"
+ )
+ }
+
+ #[test]
+ fn level_filter_reprs() {
+ let mapping = [
+ (LevelFilter::OFF, LevelInner::Error as usize + 1),
+ (LevelFilter::ERROR, LevelInner::Error as usize),
+ (LevelFilter::WARN, LevelInner::Warn as usize),
+ (LevelFilter::INFO, LevelInner::Info as usize),
+ (LevelFilter::DEBUG, LevelInner::Debug as usize),
+ (LevelFilter::TRACE, LevelInner::Trace as usize),
+ ];
+ for &(filter, expected) in &mapping {
+ let repr = unsafe {
+ // safety: The entire purpose of this test is to assert that the
+ // actual repr matches what we expect it to be --- we're testing
+ // that *other* unsafe code is sound using the transmuted value.
+ // We're not going to do anything with it that might be unsound.
+ mem::transmute::<LevelFilter, usize>(filter)
+ };
+ assert_eq!(expected, repr, "repr changed for {:?}", filter)
+ }
+ }
+}
diff --git a/crates/tracing-core/src/parent.rs b/crates/tracing-core/src/parent.rs
new file mode 100644
index 0000000..cb34b37
--- /dev/null
+++ b/crates/tracing-core/src/parent.rs
@@ -0,0 +1,11 @@
+use crate::span::Id;
+
+#[derive(Debug)]
+pub(crate) enum Parent {
+ /// The new span will be a root span.
+ Root,
+ /// The new span will be rooted in the current span.
+ Current,
+ /// The new span has an explicitly-specified parent.
+ Explicit(Id),
+}
diff --git a/crates/tracing-core/src/span.rs b/crates/tracing-core/src/span.rs
new file mode 100644
index 0000000..44738b2
--- /dev/null
+++ b/crates/tracing-core/src/span.rs
@@ -0,0 +1,341 @@
+//! Spans represent periods of time in the execution of a program.
+use crate::field::FieldSet;
+use crate::parent::Parent;
+use crate::stdlib::num::NonZeroU64;
+use crate::{field, Metadata};
+
+/// Identifies a span within the context of a subscriber.
+///
+/// They are generated by [`Subscriber`]s for each span as it is created, by
+/// the [`new_span`] trait method. See the documentation for that method for
+/// more information on span ID generation.
+///
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`new_span`]: super::subscriber::Subscriber::new_span
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
+pub struct Id(NonZeroU64);
+
+/// Attributes provided to a `Subscriber` describing a new span when it is
+/// created.
+#[derive(Debug)]
+pub struct Attributes<'a> {
+ metadata: &'static Metadata<'static>,
+ values: &'a field::ValueSet<'a>,
+ parent: Parent,
+}
+
+/// A set of fields recorded by a span.
+#[derive(Debug)]
+pub struct Record<'a> {
+ values: &'a field::ValueSet<'a>,
+}
+
+/// Indicates what [the `Subscriber` considers] the "current" span.
+///
+/// As subscribers may not track a notion of a current span, this has three
+/// possible states:
+/// - "unknown", indicating that the subscriber does not track a current span,
+/// - "none", indicating that the current context is known to not be in a span,
+/// - "some", with the current span's [`Id`] and [`Metadata`].
+///
+/// [the `Subscriber` considers]: super::subscriber::Subscriber::current_span
+/// [`Metadata`]: super::metadata::Metadata
+#[derive(Debug)]
+pub struct Current {
+ inner: CurrentInner,
+}
+
+#[derive(Debug)]
+enum CurrentInner {
+ Current {
+ id: Id,
+ metadata: &'static Metadata<'static>,
+ },
+ None,
+ Unknown,
+}
+
+// ===== impl Span =====
+
+impl Id {
+ /// Constructs a new span ID from the given `u64`.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: Span IDs must be greater than zero.
+ /// </pre>
+ ///
+ /// # Panics
+ /// - If the provided `u64` is 0.
+ pub fn from_u64(u: u64) -> Self {
+ Id(NonZeroU64::new(u).expect("span IDs must be > 0"))
+ }
+
+ /// Constructs a new span ID from the given `NonZeroU64`.
+ ///
+ /// Unlike [`Id::from_u64`](Id::from_u64()), this will never panic.
+ #[inline]
+ pub const fn from_non_zero_u64(id: NonZeroU64) -> Self {
+ Id(id)
+ }
+
+ // Allow `into` by-ref since we don't want to impl Copy for Id
+ #[allow(clippy::wrong_self_convention)]
+ /// Returns the span's ID as a `u64`.
+ pub fn into_u64(&self) -> u64 {
+ self.0.get()
+ }
+
+ // Allow `into` by-ref since we don't want to impl Copy for Id
+ #[allow(clippy::wrong_self_convention)]
+ /// Returns the span's ID as a `NonZeroU64`.
+ #[inline]
+ pub const fn into_non_zero_u64(&self) -> NonZeroU64 {
+ self.0
+ }
+}
+
+impl<'a> From<&'a Id> for Option<Id> {
+ fn from(id: &'a Id) -> Self {
+ Some(id.clone())
+ }
+}
+
+// ===== impl Attributes =====
+
+impl<'a> Attributes<'a> {
+ /// Returns `Attributes` describing a new child span of the current span,
+ /// with the provided metadata and values.
+ pub fn new(metadata: &'static Metadata<'static>, values: &'a field::ValueSet<'a>) -> Self {
+ Attributes {
+ metadata,
+ values,
+ parent: Parent::Current,
+ }
+ }
+
+ /// Returns `Attributes` describing a new span at the root of its own trace
+ /// tree, with the provided metadata and values.
+ pub fn new_root(metadata: &'static Metadata<'static>, values: &'a field::ValueSet<'a>) -> Self {
+ Attributes {
+ metadata,
+ values,
+ parent: Parent::Root,
+ }
+ }
+
+ /// Returns `Attributes` describing a new child span of the specified
+ /// parent span, with the provided metadata and values.
+ pub fn child_of(
+ parent: Id,
+ metadata: &'static Metadata<'static>,
+ values: &'a field::ValueSet<'a>,
+ ) -> Self {
+ Attributes {
+ metadata,
+ values,
+ parent: Parent::Explicit(parent),
+ }
+ }
+
+ /// Returns a reference to the new span's metadata.
+ pub fn metadata(&self) -> &'static Metadata<'static> {
+ self.metadata
+ }
+
+ /// Returns a reference to a `ValueSet` containing any values the new span
+ /// was created with.
+ pub fn values(&self) -> &field::ValueSet<'a> {
+ self.values
+ }
+
+ /// Returns true if the new span should be a root.
+ pub fn is_root(&self) -> bool {
+ matches!(self.parent, Parent::Root)
+ }
+
+ /// Returns true if the new span's parent should be determined based on the
+ /// current context.
+ ///
+ /// If this is true and the current thread is currently inside a span, then
+ /// that span should be the new span's parent. Otherwise, if the current
+ /// thread is _not_ inside a span, then the new span will be the root of its
+ /// own trace tree.
+ pub fn is_contextual(&self) -> bool {
+ matches!(self.parent, Parent::Current)
+ }
+
+ /// Returns the new span's explicitly-specified parent, if there is one.
+ ///
+ /// Otherwise (if the new span is a root or is a child of the current span),
+ /// returns `None`.
+ pub fn parent(&self) -> Option<&Id> {
+ match self.parent {
+ Parent::Explicit(ref p) => Some(p),
+ _ => None,
+ }
+ }
+
+ /// Records all the fields in this set of `Attributes` with the provided
+ /// [Visitor].
+ ///
+ /// [visitor]: super::field::Visit
+ pub fn record(&self, visitor: &mut dyn field::Visit) {
+ self.values.record(visitor)
+ }
+
+ /// Returns `true` if this set of `Attributes` contains a value for the
+ /// given `Field`.
+ pub fn contains(&self, field: &field::Field) -> bool {
+ self.values.contains(field)
+ }
+
+ /// Returns true if this set of `Attributes` contains _no_ values.
+ pub fn is_empty(&self) -> bool {
+ self.values.is_empty()
+ }
+
+ /// Returns the set of all [fields] defined by this span's [`Metadata`].
+ ///
+ /// Note that the [`FieldSet`] returned by this method includes *all* the
+ /// fields declared by this span, not just those with values that are recorded
+ /// as part of this set of `Attributes`. Other fields with values not present in
+ /// this `Attributes`' value set may [record] values later.
+ ///
+ /// [fields]: crate::field
+ /// [record]: Attributes::record()
+ /// [`Metadata`]: crate::metadata::Metadata
+ /// [`FieldSet`]: crate::field::FieldSet
+ pub fn fields(&self) -> &FieldSet {
+ self.values.field_set()
+ }
+}
+
+// ===== impl Record =====
+
+impl<'a> Record<'a> {
+ /// Constructs a new `Record` from a `ValueSet`.
+ pub fn new(values: &'a field::ValueSet<'a>) -> Self {
+ Self { values }
+ }
+
+ /// Records all the fields in this `Record` with the provided [Visitor].
+ ///
+ /// [visitor]: super::field::Visit
+ pub fn record(&self, visitor: &mut dyn field::Visit) {
+ self.values.record(visitor)
+ }
+
+ /// Returns the number of fields that would be visited from this `Record`
+ /// when [`Record::record()`] is called
+ ///
+ /// [`Record::record()`]: Record::record()
+ pub fn len(&self) -> usize {
+ self.values.len()
+ }
+
+ /// Returns `true` if this `Record` contains a value for the given `Field`.
+ pub fn contains(&self, field: &field::Field) -> bool {
+ self.values.contains(field)
+ }
+
+ /// Returns true if this `Record` contains _no_ values.
+ pub fn is_empty(&self) -> bool {
+ self.values.is_empty()
+ }
+}
+
+// ===== impl Current =====
+
+impl Current {
+ /// Constructs a new `Current` that indicates the current context is a span
+ /// with the given `metadata` and `metadata`.
+ pub fn new(id: Id, metadata: &'static Metadata<'static>) -> Self {
+ Self {
+ inner: CurrentInner::Current { id, metadata },
+ }
+ }
+
+ /// Constructs a new `Current` that indicates the current context is *not*
+ /// in a span.
+ pub fn none() -> Self {
+ Self {
+ inner: CurrentInner::None,
+ }
+ }
+
+ /// Constructs a new `Current` that indicates the `Subscriber` does not
+ /// track a current span.
+ pub(crate) fn unknown() -> Self {
+ Self {
+ inner: CurrentInner::Unknown,
+ }
+ }
+
+ /// Returns `true` if the `Subscriber` that constructed this `Current` tracks a
+ /// current span.
+ ///
+ /// If this returns `true` and [`id`], [`metadata`], or [`into_inner`]
+ /// return `None`, that indicates that we are currently known to *not* be
+ /// inside a span. If this returns `false`, those methods will also return
+ /// `None`, but in this case, that is because the subscriber does not keep
+ /// track of the currently-entered span.
+ ///
+ /// [`id`]: Current::id()
+ /// [`metadata`]: Current::metadata()
+ /// [`into_inner`]: Current::into_inner()
+ pub fn is_known(&self) -> bool {
+ !matches!(self.inner, CurrentInner::Unknown)
+ }
+
+ /// Consumes `self` and returns the span `Id` and `Metadata` of the current
+ /// span, if one exists and is known.
+ pub fn into_inner(self) -> Option<(Id, &'static Metadata<'static>)> {
+ match self.inner {
+ CurrentInner::Current { id, metadata } => Some((id, metadata)),
+ _ => None,
+ }
+ }
+
+ /// Borrows the `Id` of the current span, if one exists and is known.
+ pub fn id(&self) -> Option<&Id> {
+ match self.inner {
+ CurrentInner::Current { ref id, .. } => Some(id),
+ _ => None,
+ }
+ }
+
+ /// Borrows the `Metadata` of the current span, if one exists and is known.
+ pub fn metadata(&self) -> Option<&'static Metadata<'static>> {
+ match self.inner {
+ CurrentInner::Current { metadata, .. } => Some(metadata),
+ _ => None,
+ }
+ }
+}
+
+impl<'a> From<&'a Current> for Option<&'a Id> {
+ fn from(cur: &'a Current) -> Self {
+ cur.id()
+ }
+}
+
+impl<'a> From<&'a Current> for Option<Id> {
+ fn from(cur: &'a Current) -> Self {
+ cur.id().cloned()
+ }
+}
+
+impl From<Current> for Option<Id> {
+ fn from(cur: Current) -> Self {
+ match cur.inner {
+ CurrentInner::Current { id, .. } => Some(id),
+ _ => None,
+ }
+ }
+}
+
+impl<'a> From<&'a Current> for Option<&'static Metadata<'static>> {
+ fn from(cur: &'a Current) -> Self {
+ cur.metadata()
+ }
+}
diff --git a/crates/tracing-core/src/spin/LICENSE b/crates/tracing-core/src/spin/LICENSE
new file mode 100644
index 0000000..84d5f4d
--- /dev/null
+++ b/crates/tracing-core/src/spin/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mathijs van de Nes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/crates/tracing-core/src/spin/mod.rs b/crates/tracing-core/src/spin/mod.rs
new file mode 100644
index 0000000..148b192
--- /dev/null
+++ b/crates/tracing-core/src/spin/mod.rs
@@ -0,0 +1,7 @@
+//! Synchronization primitives based on spinning
+
+pub(crate) use mutex::*;
+pub(crate) use once::Once;
+
+mod mutex;
+mod once;
diff --git a/crates/tracing-core/src/spin/mutex.rs b/crates/tracing-core/src/spin/mutex.rs
new file mode 100644
index 0000000..c261a61
--- /dev/null
+++ b/crates/tracing-core/src/spin/mutex.rs
@@ -0,0 +1,118 @@
+use core::cell::UnsafeCell;
+use core::default::Default;
+use core::fmt;
+use core::hint;
+use core::marker::Sync;
+use core::ops::{Deref, DerefMut, Drop};
+use core::option::Option::{self, None, Some};
+use core::sync::atomic::{AtomicBool, Ordering};
+
+/// This type provides MUTual EXclusion based on spinning.
+pub(crate) struct Mutex<T: ?Sized> {
+ lock: AtomicBool,
+ data: UnsafeCell<T>,
+}
+
+/// A guard to which the protected data can be accessed
+///
+/// When the guard falls out of scope it will release the lock.
+#[derive(Debug)]
+pub(crate) struct MutexGuard<'a, T: ?Sized> {
+ lock: &'a AtomicBool,
+ data: &'a mut T,
+}
+
+// Same unsafe impls as `std::sync::Mutex`
+unsafe impl<T: ?Sized + Send> Sync for Mutex<T> {}
+unsafe impl<T: ?Sized + Send> Send for Mutex<T> {}
+
+impl<T> Mutex<T> {
+ /// Creates a new spinlock wrapping the supplied data.
+ pub(crate) const fn new(user_data: T) -> Mutex<T> {
+ Mutex {
+ lock: AtomicBool::new(false),
+ data: UnsafeCell::new(user_data),
+ }
+ }
+}
+
+impl<T: ?Sized> Mutex<T> {
+ fn obtain_lock(&self) {
+ while self
+ .lock
+ .compare_exchange_weak(false, true, Ordering::Acquire, Ordering::Relaxed)
+ .is_err()
+ {
+ // Wait until the lock looks unlocked before retrying
+ while self.lock.load(Ordering::Relaxed) {
+ hint::spin_loop();
+ }
+ }
+ }
+
+ /// Locks the spinlock and returns a guard.
+ ///
+ /// The returned value may be dereferenced for data access
+ /// and the lock will be dropped when the guard falls out of scope.
+ pub(crate) fn lock(&self) -> MutexGuard<'_, T> {
+ self.obtain_lock();
+ MutexGuard {
+ lock: &self.lock,
+ data: unsafe { &mut *self.data.get() },
+ }
+ }
+
+ /// Tries to lock the mutex. If it is already locked, it will return None. Otherwise it returns
+ /// a guard within Some.
+ pub(crate) fn try_lock(&self) -> Option<MutexGuard<'_, T>> {
+ if self
+ .lock
+ .compare_exchange(false, true, Ordering::Acquire, Ordering::Relaxed)
+ .is_ok()
+ {
+ Some(MutexGuard {
+ lock: &self.lock,
+ data: unsafe { &mut *self.data.get() },
+ })
+ } else {
+ None
+ }
+ }
+}
+
+impl<T: ?Sized + fmt::Debug> fmt::Debug for Mutex<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.try_lock() {
+ Some(guard) => write!(f, "Mutex {{ data: ")
+ .and_then(|()| (&*guard).fmt(f))
+ .and_then(|()| write!(f, "}}")),
+ None => write!(f, "Mutex {{ <locked> }}"),
+ }
+ }
+}
+
+impl<T: ?Sized + Default> Default for Mutex<T> {
+ fn default() -> Mutex<T> {
+ Mutex::new(Default::default())
+ }
+}
+
+impl<'a, T: ?Sized> Deref for MutexGuard<'a, T> {
+ type Target = T;
+ fn deref<'b>(&'b self) -> &'b T {
+ &*self.data
+ }
+}
+
+impl<'a, T: ?Sized> DerefMut for MutexGuard<'a, T> {
+ fn deref_mut<'b>(&'b mut self) -> &'b mut T {
+ &mut *self.data
+ }
+}
+
+impl<'a, T: ?Sized> Drop for MutexGuard<'a, T> {
+ /// The dropping of the MutexGuard will release the lock it was created from.
+ fn drop(&mut self) {
+ self.lock.store(false, Ordering::Release);
+ }
+}
diff --git a/crates/tracing-core/src/spin/once.rs b/crates/tracing-core/src/spin/once.rs
new file mode 100644
index 0000000..27c99e5
--- /dev/null
+++ b/crates/tracing-core/src/spin/once.rs
@@ -0,0 +1,158 @@
+use core::cell::UnsafeCell;
+use core::fmt;
+use core::hint::spin_loop;
+use core::sync::atomic::{AtomicUsize, Ordering};
+
+/// A synchronization primitive which can be used to run a one-time global
+/// initialization. Unlike its std equivalent, this is generalized so that the
+/// closure returns a value and it is stored. Once therefore acts something like
+/// a future, too.
+pub struct Once<T> {
+ state: AtomicUsize,
+ data: UnsafeCell<Option<T>>, // TODO remove option and use mem::uninitialized
+}
+
+impl<T: fmt::Debug> fmt::Debug for Once<T> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.r#try() {
+ Some(s) => write!(f, "Once {{ data: ")
+ .and_then(|()| s.fmt(f))
+ .and_then(|()| write!(f, "}}")),
+ None => write!(f, "Once {{ <uninitialized> }}"),
+ }
+ }
+}
+
+// Same unsafe impls as `std::sync::RwLock`, because this also allows for
+// concurrent reads.
+unsafe impl<T: Send + Sync> Sync for Once<T> {}
+unsafe impl<T: Send> Send for Once<T> {}
+
+// Four states that a Once can be in, encoded into the lower bits of `state` in
+// the Once structure.
+const INCOMPLETE: usize = 0x0;
+const RUNNING: usize = 0x1;
+const COMPLETE: usize = 0x2;
+const PANICKED: usize = 0x3;
+
+use core::hint::unreachable_unchecked as unreachable;
+
+impl<T> Once<T> {
+ /// Initialization constant of `Once`.
+ pub const INIT: Self = Once {
+ state: AtomicUsize::new(INCOMPLETE),
+ data: UnsafeCell::new(None),
+ };
+
+ /// Creates a new `Once` value.
+ pub const fn new() -> Once<T> {
+ Self::INIT
+ }
+
+ fn force_get<'a>(&'a self) -> &'a T {
+ match unsafe { &*self.data.get() }.as_ref() {
+ None => unsafe { unreachable() },
+ Some(p) => p,
+ }
+ }
+
+ /// Performs an initialization routine once and only once. The given closure
+ /// will be executed if this is the first time `call_once` has been called,
+ /// and otherwise the routine will *not* be invoked.
+ ///
+ /// This method will block the calling thread if another initialization
+ /// routine is currently running.
+ ///
+ /// When this function returns, it is guaranteed that some initialization
+ /// has run and completed (it may not be the closure specified). The
+ /// returned pointer will point to the result from the closure that was
+ /// run.
+ pub fn call_once<'a, F>(&'a self, builder: F) -> &'a T
+ where
+ F: FnOnce() -> T,
+ {
+ let mut status = self.state.load(Ordering::SeqCst);
+
+ if status == INCOMPLETE {
+ status = match self.state.compare_exchange(
+ INCOMPLETE,
+ RUNNING,
+ Ordering::SeqCst,
+ Ordering::SeqCst,
+ ) {
+ Ok(status) => {
+ debug_assert_eq!(
+ status, INCOMPLETE,
+ "if compare_exchange succeeded, previous status must be incomplete",
+ );
+ // We init
+ // We use a guard (Finish) to catch panics caused by builder
+ let mut finish = Finish {
+ state: &self.state,
+ panicked: true,
+ };
+ unsafe { *self.data.get() = Some(builder()) };
+ finish.panicked = false;
+
+ self.state.store(COMPLETE, Ordering::SeqCst);
+
+ // This next line is strictly an optimization
+ return self.force_get();
+ }
+ Err(status) => status,
+ }
+ }
+
+ loop {
+ match status {
+ INCOMPLETE => unreachable!(),
+ RUNNING => {
+ // We spin
+ spin_loop();
+ status = self.state.load(Ordering::SeqCst)
+ }
+ PANICKED => panic!("Once has panicked"),
+ COMPLETE => return self.force_get(),
+ _ => unsafe { unreachable() },
+ }
+ }
+ }
+
+ /// Returns a pointer iff the `Once` was previously initialized
+ pub fn r#try<'a>(&'a self) -> Option<&'a T> {
+ match self.state.load(Ordering::SeqCst) {
+ COMPLETE => Some(self.force_get()),
+ _ => None,
+ }
+ }
+
+ /// Like try, but will spin if the `Once` is in the process of being
+ /// initialized
+ pub fn wait<'a>(&'a self) -> Option<&'a T> {
+ loop {
+ match self.state.load(Ordering::SeqCst) {
+ INCOMPLETE => return None,
+
+ RUNNING => {
+ spin_loop() // We spin
+ }
+ COMPLETE => return Some(self.force_get()),
+ PANICKED => panic!("Once has panicked"),
+ _ => unsafe { unreachable() },
+ }
+ }
+ }
+}
+
+struct Finish<'a> {
+ state: &'a AtomicUsize,
+ panicked: bool,
+}
+
+impl<'a> Drop for Finish<'a> {
+ fn drop(&mut self) {
+ if self.panicked {
+ self.state.store(PANICKED, Ordering::SeqCst);
+ }
+ }
+}
diff --git a/crates/tracing-core/src/stdlib.rs b/crates/tracing-core/src/stdlib.rs
new file mode 100644
index 0000000..7415495
--- /dev/null
+++ b/crates/tracing-core/src/stdlib.rs
@@ -0,0 +1,78 @@
+//! Re-exports either the Rust `std` library or `core` and `alloc` when `std` is
+//! disabled.
+//!
+//! `crate::stdlib::...` should be used rather than `std::` when adding code that
+//! will be available with the standard library disabled.
+//!
+//! Note that this module is called `stdlib` rather than `std`, as Rust 1.34.0
+//! does not permit redefining the name `stdlib` (although this works on the
+//! latest stable Rust).
+#[cfg(feature = "std")]
+pub(crate) use std::*;
+
+#[cfg(not(feature = "std"))]
+pub(crate) use self::no_std::*;
+
+#[cfg(not(feature = "std"))]
+mod no_std {
+ // We pre-emptively export everything from libcore/liballoc, (even modules
+ // we aren't using currently) to make adding new code easier. Therefore,
+ // some of these imports will be unused.
+ #![allow(unused_imports)]
+
+ pub(crate) use core::{
+ any, array, ascii, cell, char, clone, cmp, convert, default, f32, f64, ffi, future, hash,
+ hint, i128, i16, i8, isize, iter, marker, mem, num, ops, option, pin, ptr, result, task,
+ time, u128, u16, u32, u8, usize,
+ };
+
+ pub(crate) use alloc::{boxed, collections, rc, string, vec};
+
+ pub(crate) mod borrow {
+ pub(crate) use alloc::borrow::*;
+ pub(crate) use core::borrow::*;
+ }
+
+ pub(crate) mod fmt {
+ pub(crate) use alloc::fmt::*;
+ pub(crate) use core::fmt::*;
+ }
+
+ pub(crate) mod slice {
+ pub(crate) use alloc::slice::*;
+ pub(crate) use core::slice::*;
+ }
+
+ pub(crate) mod str {
+ pub(crate) use alloc::str::*;
+ pub(crate) use core::str::*;
+ }
+
+ pub(crate) mod sync {
+ pub(crate) use crate::spin::MutexGuard;
+ pub(crate) use alloc::sync::*;
+ pub(crate) use core::sync::*;
+
+ /// This wraps `spin::Mutex` to return a `Result`, so that it can be
+ /// used with code written against `std::sync::Mutex`.
+ ///
+ /// Since `spin::Mutex` doesn't support poisoning, the `Result` returned
+ /// by `lock` will always be `Ok`.
+ #[derive(Debug, Default)]
+ pub(crate) struct Mutex<T> {
+ inner: crate::spin::Mutex<T>,
+ }
+
+ impl<T> Mutex<T> {
+ // pub(crate) fn new(data: T) -> Self {
+ // Self {
+ // inner: crate::spin::Mutex::new(data),
+ // }
+ // }
+
+ pub(crate) fn lock(&self) -> Result<MutexGuard<'_, T>, ()> {
+ Ok(self.inner.lock())
+ }
+ }
+ }
+}
diff --git a/crates/tracing-core/src/subscriber.rs b/crates/tracing-core/src/subscriber.rs
new file mode 100644
index 0000000..17b6316
--- /dev/null
+++ b/crates/tracing-core/src/subscriber.rs
@@ -0,0 +1,878 @@
+//! Collectors collect and record trace data.
+use crate::{span, Dispatch, Event, LevelFilter, Metadata};
+
+use crate::stdlib::{
+ any::{Any, TypeId},
+ boxed::Box,
+ sync::Arc,
+};
+
+/// Trait representing the functions required to collect trace data.
+///
+/// Crates that provide implementations of methods for collecting or recording
+/// trace data should implement the `Subscriber` interface. This trait is
+/// intended to represent fundamental primitives for collecting trace events and
+/// spans — other libraries may offer utility functions and types to make
+/// subscriber implementations more modular or improve the ergonomics of writing
+/// subscribers.
+///
+/// A subscriber is responsible for the following:
+/// - Registering new spans as they are created, and providing them with span
+/// IDs. Implicitly, this means the subscriber may determine the strategy for
+/// determining span equality.
+/// - Recording the attachment of field values and follows-from annotations to
+/// spans.
+/// - Filtering spans and events, and determining when those filters must be
+/// invalidated.
+/// - Observing spans as they are entered, exited, and closed, and events as
+/// they occur.
+///
+/// When a span is entered or exited, the subscriber is provided only with the
+/// [ID] with which it tagged that span when it was created. This means
+/// that it is up to the subscriber to determine whether and how span _data_ —
+/// the fields and metadata describing the span — should be stored. The
+/// [`new_span`] function is called when a new span is created, and at that
+/// point, the subscriber _may_ choose to store the associated data if it will
+/// be referenced again. However, if the data has already been recorded and will
+/// not be needed by the implementations of `enter` and `exit`, the subscriber
+/// may freely discard that data without allocating space to store it.
+///
+/// ## Overriding default impls
+///
+/// Some trait methods on `Subscriber` have default implementations, either in
+/// order to reduce the surface area of implementing `Subscriber`, or for
+/// backward-compatibility reasons. However, many subscribers will likely want
+/// to override these default implementations.
+///
+/// The following methods are likely of interest:
+///
+/// - [`register_callsite`] is called once for each callsite from which a span
+/// event may originate, and returns an [`Interest`] value describing whether or
+/// not the subscriber wishes to see events or spans from that callsite. By
+/// default, it calls [`enabled`], and returns `Interest::always()` if
+/// `enabled` returns true, or `Interest::never()` if enabled returns false.
+/// However, if the subscriber's interest can change dynamically at runtime,
+/// it may want to override this function to return `Interest::sometimes()`.
+/// Additionally, subscribers which wish to perform a behaviour once for each
+/// callsite, such as allocating storage for data related to that callsite,
+/// can perform it in `register_callsite`.
+///
+/// See also the [documentation on the callsite registry][cs-reg] for details
+/// on [`register_callsite`].
+///
+/// - [`event_enabled`] is called once before every call to the [`event`]
+/// method. This can be used to implement filtering on events once their field
+/// values are known, but before any processing is done in the `event` method.
+/// - [`clone_span`] is called every time a span ID is cloned, and [`try_close`]
+/// is called when a span ID is dropped. By default, these functions do
+/// nothing. However, they can be used to implement reference counting for
+/// spans, allowing subscribers to free storage for span data and to determine
+/// when a span has _closed_ permanently (rather than being exited).
+/// Subscribers which store per-span data or which need to track span closures
+/// should override these functions together.
+///
+/// [ID]: super::span::Id
+/// [`new_span`]: Subscriber::new_span
+/// [`register_callsite`]: Subscriber::register_callsite
+/// [`enabled`]: Subscriber::enabled
+/// [`clone_span`]: Subscriber::clone_span
+/// [`try_close`]: Subscriber::try_close
+/// [cs-reg]: crate::callsite#registering-callsites
+/// [`event`]: Subscriber::event
+/// [`event_enabled`]: Subscriber::event_enabled
+pub trait Subscriber: 'static {
+ /// Invoked when this subscriber becomes a [`Dispatch`].
+ ///
+ /// ## Avoiding Memory Leaks
+ ///
+ /// `Subscriber`s should not store their own [`Dispatch`]. Because the
+ /// `Dispatch` owns the `Subscriber`, storing the `Dispatch` within the
+ /// `Subscriber` will create a reference count cycle, preventing the `Dispatch`
+ /// from ever being dropped.
+ ///
+ /// Instead, when it is necessary to store a cyclical reference to the
+ /// `Dispatch` within a `Subscriber`, use [`Dispatch::downgrade`] to convert a
+ /// `Dispatch` into a [`WeakDispatch`]. This type is analogous to
+ /// [`std::sync::Weak`], and does not create a reference count cycle. A
+ /// [`WeakDispatch`] can be stored within a `Subscriber` without causing a
+ /// memory leak, and can be [upgraded] into a `Dispatch` temporarily when
+ /// the `Dispatch` must be accessed by the `Subscriber`.
+ ///
+ /// [`WeakDispatch`]: crate::dispatcher::WeakDispatch
+ /// [upgraded]: crate::dispatcher::WeakDispatch::upgrade
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ let _ = subscriber;
+ }
+
+ /// Registers a new [callsite] with this subscriber, returning whether or not
+ /// the subscriber is interested in being notified about the callsite.
+ ///
+ /// By default, this function assumes that the subscriber's [filter]
+ /// represents an unchanging view of its interest in the callsite. However,
+ /// if this is not the case, subscribers may override this function to
+ /// indicate different interests, or to implement behaviour that should run
+ /// once for every callsite.
+ ///
+ /// This function is guaranteed to be called at least once per callsite on
+ /// every active subscriber. The subscriber may store the keys to fields it
+ /// cares about in order to reduce the cost of accessing fields by name,
+ /// preallocate storage for that callsite, or perform any other actions it
+ /// wishes to perform once for each callsite.
+ ///
+ /// The subscriber should then return an [`Interest`], indicating
+ /// whether it is interested in being notified about that callsite in the
+ /// future. This may be `Always` indicating that the subscriber always
+ /// wishes to be notified about the callsite, and its filter need not be
+ /// re-evaluated; `Sometimes`, indicating that the subscriber may sometimes
+ /// care about the callsite but not always (such as when sampling), or
+ /// `Never`, indicating that the subscriber never wishes to be notified about
+ /// that callsite. If all active subscribers return `Never`, a callsite will
+ /// never be enabled unless a new subscriber expresses interest in it.
+ ///
+ /// `Subscriber`s which require their filters to be run every time an event
+ /// occurs or a span is entered/exited should return `Interest::sometimes`.
+ /// If a subscriber returns `Interest::sometimes`, then its [`enabled`] method
+ /// will be called every time an event or span is created from that callsite.
+ ///
+ /// For example, suppose a sampling subscriber is implemented by
+ /// incrementing a counter every time `enabled` is called and only returning
+ /// `true` when the counter is divisible by a specified sampling rate. If
+ /// that subscriber returns `Interest::always` from `register_callsite`, then
+ /// the filter will not be re-evaluated once it has been applied to a given
+ /// set of metadata. Thus, the counter will not be incremented, and the span
+ /// or event that corresponds to the metadata will never be `enabled`.
+ ///
+ /// `Subscriber`s that need to change their filters occasionally should call
+ /// [`rebuild_interest_cache`] to re-evaluate `register_callsite` for all
+ /// callsites.
+ ///
+ /// Similarly, if a `Subscriber` has a filtering strategy that can be
+ /// changed dynamically at runtime, it would need to re-evaluate that filter
+ /// if the cached results have changed.
+ ///
+ /// A subscriber which manages fanout to multiple other subscribers
+ /// should proxy this decision to all of its child subscribers,
+ /// returning `Interest::never` only if _all_ such children return
+ /// `Interest::never`. If the set of subscribers to which spans are
+ /// broadcast may change dynamically, the subscriber should also never
+ /// return `Interest::Never`, as a new subscriber may be added that _is_
+ /// interested.
+ ///
+ /// See the [documentation on the callsite registry][cs-reg] for more
+ /// details on how and when the `register_callsite` method is called.
+ ///
+ /// # Notes
+ /// This function may be called again when a new subscriber is created or
+ /// when the registry is invalidated.
+ ///
+ /// If a subscriber returns `Interest::never` for a particular callsite, it
+ /// _may_ still see spans and events originating from that callsite, if
+ /// another subscriber expressed interest in it.
+ ///
+ /// [callsite]: crate::callsite
+ /// [filter]: Self::enabled
+ /// [metadata]: super::metadata::Metadata
+ /// [`enabled`]: Subscriber::enabled()
+ /// [`rebuild_interest_cache`]: super::callsite::rebuild_interest_cache
+ /// [cs-reg]: crate::callsite#registering-callsites
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ if self.enabled(metadata) {
+ Interest::always()
+ } else {
+ Interest::never()
+ }
+ }
+
+ /// Returns true if a span or event with the specified [metadata] would be
+ /// recorded.
+ ///
+ /// By default, it is assumed that this filter needs only be evaluated once
+ /// for each callsite, so it is called by [`register_callsite`] when each
+ /// callsite is registered. The result is used to determine if the subscriber
+ /// is always [interested] or never interested in that callsite. This is intended
+ /// primarily as an optimization, so that expensive filters (such as those
+ /// involving string search, et cetera) need not be re-evaluated.
+ ///
+ /// However, if the subscriber's interest in a particular span or event may
+ /// change, or depends on contexts only determined dynamically at runtime,
+ /// then the `register_callsite` method should be overridden to return
+ /// [`Interest::sometimes`]. In that case, this function will be called every
+ /// time that span or event occurs.
+ ///
+ /// [metadata]: super::metadata::Metadata
+ /// [interested]: Interest
+ /// [`Interest::sometimes`]: Interest::sometimes
+ /// [`register_callsite`]: Subscriber::register_callsite()
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool;
+
+ /// Returns the highest [verbosity level][level] that this `Subscriber` will
+ /// enable, or `None`, if the subscriber does not implement level-based
+ /// filtering or chooses not to implement this method.
+ ///
+ /// If this method returns a [`Level`][level], it will be used as a hint to
+ /// determine the most verbose level that will be enabled. This will allow
+ /// spans and events which are more verbose than that level to be skipped
+ /// more efficiently. Subscribers which perform filtering are strongly
+ /// encouraged to provide an implementation of this method.
+ ///
+ /// If the maximum level the subscriber will enable can change over the
+ /// course of its lifetime, it is free to return a different value from
+ /// multiple invocations of this method. However, note that changes in the
+ /// maximum level will **only** be reflected after the callsite [`Interest`]
+ /// cache is rebuilt, by calling the [`callsite::rebuild_interest_cache`][rebuild]
+ /// function. Therefore, if the subscriber will change the value returned by
+ /// this method, it is responsible for ensuring that
+ /// [`rebuild_interest_cache`][rebuild] is called after the value of the max
+ /// level changes.
+ ///
+ /// [level]: super::Level
+ /// [rebuild]: super::callsite::rebuild_interest_cache
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ None
+ }
+
+ /// Visit the construction of a new span, returning a new [span ID] for the
+ /// span being constructed.
+ ///
+ /// The provided [`Attributes`] contains any field values that were provided
+ /// when the span was created. The subscriber may pass a [visitor] to the
+ /// `Attributes`' [`record` method] to record these values.
+ ///
+ /// IDs are used to uniquely identify spans and events within the context of a
+ /// subscriber, so span equality will be based on the returned ID. Thus, if
+ /// the subscriber wishes for all spans with the same metadata to be
+ /// considered equal, it should return the same ID every time it is given a
+ /// particular set of metadata. Similarly, if it wishes for two separate
+ /// instances of a span with the same metadata to *not* be equal, it should
+ /// return a distinct ID every time this function is called, regardless of
+ /// the metadata.
+ ///
+ /// Note that the subscriber is free to assign span IDs based on whatever
+ /// scheme it sees fit. Any guarantees about uniqueness, ordering, or ID
+ /// reuse are left up to the subscriber implementation to determine.
+ ///
+ /// [span ID]: super::span::Id
+ /// [`Attributes`]: super::span::Attributes
+ /// [visitor]: super::field::Visit
+ /// [`record` method]: super::span::Attributes::record
+ fn new_span(&self, span: &span::Attributes<'_>) -> span::Id;
+
+ // === Notification methods ===============================================
+
+ /// Record a set of values on a span.
+ ///
+ /// This method will be invoked when value is recorded on a span.
+ /// Recording multiple values for the same field is possible,
+ /// but the actual behaviour is defined by the subscriber implementation.
+ ///
+ /// Keep in mind that a span might not provide a value
+ /// for each field it declares.
+ ///
+ /// The subscriber is expected to provide a [visitor] to the `Record`'s
+ /// [`record` method] in order to record the added values.
+ ///
+ /// # Example
+ /// "foo = 3" will be recorded when [`record`] is called on the
+ /// `Attributes` passed to `new_span`.
+ /// Since values are not provided for the `bar` and `baz` fields,
+ /// the span's `Metadata` will indicate that it _has_ those fields,
+ /// but values for them won't be recorded at this time.
+ ///
+ /// ```rust,ignore
+ /// # use tracing::span;
+ ///
+ /// let mut span = span!("my_span", foo = 3, bar, baz);
+ ///
+ /// // `Subscriber::record` will be called with a `Record`
+ /// // containing "bar = false"
+ /// span.record("bar", &false);
+ ///
+ /// // `Subscriber::record` will be called with a `Record`
+ /// // containing "baz = "a string""
+ /// span.record("baz", &"a string");
+ /// ```
+ ///
+ /// [visitor]: super::field::Visit
+ /// [`record`]: super::span::Attributes::record
+ /// [`record` method]: super::span::Record::record
+ fn record(&self, span: &span::Id, values: &span::Record<'_>);
+
+ /// Adds an indication that `span` follows from the span with the id
+ /// `follows`.
+ ///
+ /// This relationship differs somewhat from the parent-child relationship: a
+ /// span may have any number of prior spans, rather than a single one; and
+ /// spans are not considered to be executing _inside_ of the spans they
+ /// follow from. This means that a span may close even if subsequent spans
+ /// that follow from it are still open, and time spent inside of a
+ /// subsequent span should not be included in the time its precedents were
+ /// executing. This is used to model causal relationships such as when a
+ /// single future spawns several related background tasks, et cetera.
+ ///
+ /// If the subscriber has spans corresponding to the given IDs, it should
+ /// record this relationship in whatever way it deems necessary. Otherwise,
+ /// if one or both of the given span IDs do not correspond to spans that the
+ /// subscriber knows about, or if a cyclical relationship would be created
+ /// (i.e., some span _a_ which proceeds some other span _b_ may not also
+ /// follow from _b_), it may silently do nothing.
+ fn record_follows_from(&self, span: &span::Id, follows: &span::Id);
+
+ /// Determine if an [`Event`] should be recorded.
+ ///
+ /// By default, this returns `true` and `Subscriber`s can filter events in
+ /// [`event`][Self::event] without any penalty. However, when `event` is
+ /// more complicated, this can be used to determine if `event` should be
+ /// called at all, separating out the decision from the processing.
+ fn event_enabled(&self, event: &Event<'_>) -> bool {
+ let _ = event;
+ true
+ }
+
+ /// Records that an [`Event`] has occurred.
+ ///
+ /// This method will be invoked when an Event is constructed by
+ /// the `Event`'s [`dispatch` method]. For example, this happens internally
+ /// when an event macro from `tracing` is called.
+ ///
+ /// The key difference between this method and `record` is that `record` is
+ /// called when a value is recorded for a field defined by a span,
+ /// while `event` is called when a new event occurs.
+ ///
+ /// The provided `Event` struct contains any field values attached to the
+ /// event. The subscriber may pass a [visitor] to the `Event`'s
+ /// [`record` method] to record these values.
+ ///
+ /// [`Event`]: super::event::Event
+ /// [visitor]: super::field::Visit
+ /// [`record` method]: super::event::Event::record
+ /// [`dispatch` method]: super::event::Event::dispatch
+ fn event(&self, event: &Event<'_>);
+
+ /// Records that a span has been entered.
+ ///
+ /// When entering a span, this method is called to notify the subscriber
+ /// that the span has been entered. The subscriber is provided with the
+ /// [span ID] of the entered span, and should update any internal state
+ /// tracking the current span accordingly.
+ ///
+ /// [span ID]: super::span::Id
+ fn enter(&self, span: &span::Id);
+
+ /// Records that a span has been exited.
+ ///
+ /// When exiting a span, this method is called to notify the subscriber
+ /// that the span has been exited. The subscriber is provided with the
+ /// [span ID] of the exited span, and should update any internal state
+ /// tracking the current span accordingly.
+ ///
+ /// Exiting a span does not imply that the span will not be re-entered.
+ ///
+ /// [span ID]: super::span::Id
+ fn exit(&self, span: &span::Id);
+
+ /// Notifies the subscriber that a [span ID] has been cloned.
+ ///
+ /// This function is guaranteed to only be called with span IDs that were
+ /// returned by this subscriber's `new_span` function.
+ ///
+ /// Note that the default implementation of this function this is just the
+ /// identity function, passing through the identifier. However, it can be
+ /// used in conjunction with [`try_close`] to track the number of handles
+ /// capable of `enter`ing a span. When all the handles have been dropped
+ /// (i.e., `try_close` has been called one more time than `clone_span` for a
+ /// given ID), the subscriber may assume that the span will not be entered
+ /// again. It is then free to deallocate storage for data associated with
+ /// that span, write data from that span to IO, and so on.
+ ///
+ /// For more unsafe situations, however, if `id` is itself a pointer of some
+ /// kind this can be used as a hook to "clone" the pointer, depending on
+ /// what that means for the specified pointer.
+ ///
+ /// [span ID]: super::span::Id
+ /// [`try_close`]: Subscriber::try_close
+ fn clone_span(&self, id: &span::Id) -> span::Id {
+ id.clone()
+ }
+
+ /// **This method is deprecated.**
+ ///
+ /// Using `drop_span` may result in subscribers composed using
+ /// `tracing-subscriber` crate's `Layer` trait from observing close events.
+ /// Use [`try_close`] instead.
+ ///
+ /// The default implementation of this function does nothing.
+ ///
+ /// [`try_close`]: Subscriber::try_close
+ #[deprecated(since = "0.1.2", note = "use `Subscriber::try_close` instead")]
+ fn drop_span(&self, _id: span::Id) {}
+
+ /// Notifies the subscriber that a [span ID] has been dropped, and returns
+ /// `true` if there are now 0 IDs that refer to that span.
+ ///
+ /// Higher-level libraries providing functionality for composing multiple
+ /// subscriber implementations may use this return value to notify any
+ /// "layered" subscribers that this subscriber considers the span closed.
+ ///
+ /// The default implementation of this method calls the subscriber's
+ /// [`drop_span`] method and returns `false`. This means that, unless the
+ /// subscriber overrides the default implementation, close notifications
+ /// will never be sent to any layered subscribers. In general, if the
+ /// subscriber tracks reference counts, this method should be implemented,
+ /// rather than `drop_span`.
+ ///
+ /// This function is guaranteed to only be called with span IDs that were
+ /// returned by this subscriber's `new_span` function.
+ ///
+ /// It's guaranteed that if this function has been called once more than the
+ /// number of times `clone_span` was called with the same `id`, then no more
+ /// handles that can enter the span with that `id` exist. This means that it
+ /// can be used in conjunction with [`clone_span`] to track the number of
+ /// handles capable of `enter`ing a span. When all the handles have been
+ /// dropped (i.e., `try_close` has been called one more time than
+ /// `clone_span` for a given ID), the subscriber may assume that the span
+ /// will not be entered again, and should return `true`. It is then free to
+ /// deallocate storage for data associated with that span, write data from
+ /// that span to IO, and so on.
+ ///
+ /// **Note**: since this function is called when spans are dropped,
+ /// implementations should ensure that they are unwind-safe. Panicking from
+ /// inside of a `try_close` function may cause a double panic, if the span
+ /// was dropped due to a thread unwinding.
+ ///
+ /// [span ID]: super::span::Id
+ /// [`clone_span`]: Subscriber::clone_span
+ /// [`drop_span`]: Subscriber::drop_span
+ fn try_close(&self, id: span::Id) -> bool {
+ #[allow(deprecated)]
+ self.drop_span(id);
+ false
+ }
+
+ /// Returns a type representing this subscriber's view of the current span.
+ ///
+ /// If subscribers track a current span, they should override this function
+ /// to return [`Current::new`] if the thread from which this method is
+ /// called is inside a span, or [`Current::none`] if the thread is not
+ /// inside a span.
+ ///
+ /// By default, this returns a value indicating that the subscriber
+ /// does **not** track what span is current. If the subscriber does not
+ /// implement a current span, it should not override this method.
+ ///
+ /// [`Current::new`]: super::span::Current#tymethod.new
+ /// [`Current::none`]: super::span::Current#tymethod.none
+ fn current_span(&self) -> span::Current {
+ span::Current::unknown()
+ }
+
+ // === Downcasting methods ================================================
+
+ /// If `self` is the same type as the provided `TypeId`, returns an untyped
+ /// `*const` pointer to that type. Otherwise, returns `None`.
+ ///
+ /// If you wish to downcast a `Subscriber`, it is strongly advised to use
+ /// the safe API provided by [`downcast_ref`] instead.
+ ///
+ /// This API is required for `downcast_raw` to be a trait method; a method
+ /// signature like [`downcast_ref`] (with a generic type parameter) is not
+ /// object-safe, and thus cannot be a trait method for `Subscriber`. This
+ /// means that if we only exposed `downcast_ref`, `Subscriber`
+ /// implementations could not override the downcasting behavior
+ ///
+ /// This method may be overridden by "fan out" or "chained" subscriber
+ /// implementations which consist of multiple composed types. Such
+ /// subscribers might allow `downcast_raw` by returning references to those
+ /// component if they contain components with the given `TypeId`.
+ ///
+ /// # Safety
+ ///
+ /// The [`downcast_ref`] method expects that the pointer returned by
+ /// `downcast_raw` is non-null and points to a valid instance of the type
+ /// with the provided `TypeId`. Failure to ensure this will result in
+ /// undefined behaviour, so implementing `downcast_raw` is unsafe.
+ ///
+ /// [`downcast_ref`]: #method.downcast_ref
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ Some(self as *const Self as *const ())
+ } else {
+ None
+ }
+ }
+}
+
+impl dyn Subscriber {
+ /// Returns `true` if this `Subscriber` is the same type as `T`.
+ pub fn is<T: Any>(&self) -> bool {
+ self.downcast_ref::<T>().is_some()
+ }
+
+ /// Returns some reference to this `Subscriber` value if it is of type `T`,
+ /// or `None` if it isn't.
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ unsafe {
+ let raw = self.downcast_raw(TypeId::of::<T>())?;
+ if raw.is_null() {
+ None
+ } else {
+ Some(&*(raw as *const _))
+ }
+ }
+ }
+}
+
+impl dyn Subscriber + Send {
+ /// Returns `true` if this [`Subscriber`] is the same type as `T`.
+ pub fn is<T: Any>(&self) -> bool {
+ self.downcast_ref::<T>().is_some()
+ }
+
+ /// Returns some reference to this [`Subscriber`] value if it is of type `T`,
+ /// or `None` if it isn't.
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ unsafe {
+ let raw = self.downcast_raw(TypeId::of::<T>())?;
+ if raw.is_null() {
+ None
+ } else {
+ Some(&*(raw as *const _))
+ }
+ }
+ }
+}
+
+impl dyn Subscriber + Sync {
+ /// Returns `true` if this [`Subscriber`] is the same type as `T`.
+ pub fn is<T: Any>(&self) -> bool {
+ self.downcast_ref::<T>().is_some()
+ }
+
+ /// Returns some reference to this `[`Subscriber`] value if it is of type `T`,
+ /// or `None` if it isn't.
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ unsafe {
+ let raw = self.downcast_raw(TypeId::of::<T>())?;
+ if raw.is_null() {
+ None
+ } else {
+ Some(&*(raw as *const _))
+ }
+ }
+ }
+}
+
+impl dyn Subscriber + Send + Sync {
+ /// Returns `true` if this [`Subscriber`] is the same type as `T`.
+ pub fn is<T: Any>(&self) -> bool {
+ self.downcast_ref::<T>().is_some()
+ }
+
+ /// Returns some reference to this [`Subscriber`] value if it is of type `T`,
+ /// or `None` if it isn't.
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ unsafe {
+ let raw = self.downcast_raw(TypeId::of::<T>())?;
+ if raw.is_null() {
+ None
+ } else {
+ Some(&*(raw as *const _))
+ }
+ }
+ }
+}
+
+/// Indicates a [`Subscriber`]'s interest in a particular callsite.
+///
+/// `Subscriber`s return an `Interest` from their [`register_callsite`] methods
+/// in order to determine whether that span should be enabled or disabled.
+///
+/// [`Subscriber`]: super::Subscriber
+/// [`register_callsite`]: super::Subscriber::register_callsite
+#[derive(Clone, Debug)]
+pub struct Interest(InterestKind);
+
+#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd)]
+enum InterestKind {
+ Never = 0,
+ Sometimes = 1,
+ Always = 2,
+}
+
+impl Interest {
+ /// Returns an `Interest` indicating that the subscriber is never interested
+ /// in being notified about a callsite.
+ ///
+ /// If all active subscribers are `never()` interested in a callsite, it will
+ /// be completely disabled unless a new subscriber becomes active.
+ #[inline]
+ pub fn never() -> Self {
+ Interest(InterestKind::Never)
+ }
+
+ /// Returns an `Interest` indicating the subscriber is sometimes interested
+ /// in being notified about a callsite.
+ ///
+ /// If all active subscribers are `sometimes` or `never` interested in a
+ /// callsite, the currently active subscriber will be asked to filter that
+ /// callsite every time it creates a span. This will be the case until a new
+ /// subscriber expresses that it is `always` interested in the callsite.
+ #[inline]
+ pub fn sometimes() -> Self {
+ Interest(InterestKind::Sometimes)
+ }
+
+ /// Returns an `Interest` indicating the subscriber is always interested in
+ /// being notified about a callsite.
+ ///
+ /// If any subscriber expresses that it is `always()` interested in a given
+ /// callsite, then the callsite will always be enabled.
+ #[inline]
+ pub fn always() -> Self {
+ Interest(InterestKind::Always)
+ }
+
+ /// Returns `true` if the subscriber is never interested in being notified
+ /// about this callsite.
+ #[inline]
+ pub fn is_never(&self) -> bool {
+ matches!(self.0, InterestKind::Never)
+ }
+
+ /// Returns `true` if the subscriber is sometimes interested in being notified
+ /// about this callsite.
+ #[inline]
+ pub fn is_sometimes(&self) -> bool {
+ matches!(self.0, InterestKind::Sometimes)
+ }
+
+ /// Returns `true` if the subscriber is always interested in being notified
+ /// about this callsite.
+ #[inline]
+ pub fn is_always(&self) -> bool {
+ matches!(self.0, InterestKind::Always)
+ }
+
+ /// Returns the common interest between these two Interests.
+ ///
+ /// If both interests are the same, this propagates that interest.
+ /// Otherwise, if they differ, the result must always be
+ /// `Interest::sometimes` --- if the two subscribers differ in opinion, we
+ /// will have to ask the current subscriber what it thinks, no matter what.
+ pub(crate) fn and(self, rhs: Interest) -> Self {
+ if self.0 == rhs.0 {
+ self
+ } else {
+ Interest::sometimes()
+ }
+ }
+}
+
+/// A no-op [`Subscriber`].
+///
+/// [`NoSubscriber`] implements the [`Subscriber`] trait by never being enabled,
+/// never being interested in any callsite, and dropping all spans and events.
+#[derive(Copy, Clone, Debug, Default)]
+pub struct NoSubscriber(());
+
+impl Subscriber for NoSubscriber {
+ #[inline]
+ fn register_callsite(&self, _: &'static Metadata<'static>) -> Interest {
+ Interest::never()
+ }
+
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(0xDEAD)
+ }
+
+ fn event(&self, _event: &Event<'_>) {}
+
+ fn record(&self, _span: &span::Id, _values: &span::Record<'_>) {}
+
+ fn record_follows_from(&self, _span: &span::Id, _follows: &span::Id) {}
+
+ #[inline]
+ fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
+ false
+ }
+
+ fn enter(&self, _span: &span::Id) {}
+ fn exit(&self, _span: &span::Id) {}
+}
+
+impl NoSubscriber {
+ /// Returns a new `NoSubscriber`.
+ #[must_use]
+ pub const fn new() -> Self {
+ Self(())
+ }
+}
+
+impl<S> Subscriber for Box<S>
+where
+ S: Subscriber + ?Sized,
+{
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.as_ref().register_callsite(metadata)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ self.as_ref().enabled(metadata)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.as_ref().max_level_hint()
+ }
+
+ #[inline]
+ fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
+ self.as_ref().new_span(span)
+ }
+
+ #[inline]
+ fn record(&self, span: &span::Id, values: &span::Record<'_>) {
+ self.as_ref().record(span, values)
+ }
+
+ #[inline]
+ fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
+ self.as_ref().record_follows_from(span, follows)
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>) -> bool {
+ self.as_ref().event_enabled(event)
+ }
+
+ #[inline]
+ fn event(&self, event: &Event<'_>) {
+ self.as_ref().event(event)
+ }
+
+ #[inline]
+ fn enter(&self, span: &span::Id) {
+ self.as_ref().enter(span)
+ }
+
+ #[inline]
+ fn exit(&self, span: &span::Id) {
+ self.as_ref().exit(span)
+ }
+
+ #[inline]
+ fn clone_span(&self, id: &span::Id) -> span::Id {
+ self.as_ref().clone_span(id)
+ }
+
+ #[inline]
+ fn try_close(&self, id: span::Id) -> bool {
+ self.as_ref().try_close(id)
+ }
+
+ #[inline]
+ #[allow(deprecated)]
+ fn drop_span(&self, id: span::Id) {
+ self.as_ref().try_close(id);
+ }
+
+ #[inline]
+ fn current_span(&self) -> span::Current {
+ self.as_ref().current_span()
+ }
+
+ #[inline]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ return Some(self as *const Self as *const _);
+ }
+
+ self.as_ref().downcast_raw(id)
+ }
+}
+
+impl<S> Subscriber for Arc<S>
+where
+ S: Subscriber + ?Sized,
+{
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.as_ref().register_callsite(metadata)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ self.as_ref().enabled(metadata)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.as_ref().max_level_hint()
+ }
+
+ #[inline]
+ fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
+ self.as_ref().new_span(span)
+ }
+
+ #[inline]
+ fn record(&self, span: &span::Id, values: &span::Record<'_>) {
+ self.as_ref().record(span, values)
+ }
+
+ #[inline]
+ fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
+ self.as_ref().record_follows_from(span, follows)
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>) -> bool {
+ self.as_ref().event_enabled(event)
+ }
+
+ #[inline]
+ fn event(&self, event: &Event<'_>) {
+ self.as_ref().event(event)
+ }
+
+ #[inline]
+ fn enter(&self, span: &span::Id) {
+ self.as_ref().enter(span)
+ }
+
+ #[inline]
+ fn exit(&self, span: &span::Id) {
+ self.as_ref().exit(span)
+ }
+
+ #[inline]
+ fn clone_span(&self, id: &span::Id) -> span::Id {
+ self.as_ref().clone_span(id)
+ }
+
+ #[inline]
+ fn try_close(&self, id: span::Id) -> bool {
+ self.as_ref().try_close(id)
+ }
+
+ #[inline]
+ #[allow(deprecated)]
+ fn drop_span(&self, id: span::Id) {
+ self.as_ref().try_close(id);
+ }
+
+ #[inline]
+ fn current_span(&self) -> span::Current {
+ self.as_ref().current_span()
+ }
+
+ #[inline]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ return Some(self as *const Self as *const _);
+ }
+
+ self.as_ref().downcast_raw(id)
+ }
+}
diff --git a/crates/tracing-core/tests/common/mod.rs b/crates/tracing-core/tests/common/mod.rs
new file mode 100644
index 0000000..3420f0b
--- /dev/null
+++ b/crates/tracing-core/tests/common/mod.rs
@@ -0,0 +1,30 @@
+use tracing_core::{metadata::Metadata, span, subscriber::Subscriber, Event};
+
+pub struct TestSubscriberA;
+impl Subscriber for TestSubscriberA {
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(1)
+ }
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+ fn event(&self, _: &Event<'_>) {}
+ fn enter(&self, _: &span::Id) {}
+ fn exit(&self, _: &span::Id) {}
+}
+pub struct TestSubscriberB;
+impl Subscriber for TestSubscriberB {
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(1)
+ }
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+ fn event(&self, _: &Event<'_>) {}
+ fn enter(&self, _: &span::Id) {}
+ fn exit(&self, _: &span::Id) {}
+}
diff --git a/crates/tracing-core/tests/dispatch.rs b/crates/tracing-core/tests/dispatch.rs
new file mode 100644
index 0000000..3820692
--- /dev/null
+++ b/crates/tracing-core/tests/dispatch.rs
@@ -0,0 +1,56 @@
+#![cfg(feature = "std")]
+mod common;
+
+use common::*;
+use tracing_core::dispatcher::*;
+
+#[test]
+fn set_default_dispatch() {
+ set_global_default(Dispatch::new(TestSubscriberA)).expect("global dispatch set failed");
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "global dispatch get failed"
+ )
+ });
+
+ let guard = set_default(&Dispatch::new(TestSubscriberB));
+ get_default(|current| assert!(current.is::<TestSubscriberB>(), "set_default get failed"));
+
+ // Drop the guard, setting the dispatch back to the global dispatch
+ drop(guard);
+
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "global dispatch get failed"
+ )
+ });
+}
+
+#[test]
+fn nested_set_default() {
+ let _guard = set_default(&Dispatch::new(TestSubscriberA));
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "set_default for outer subscriber failed"
+ )
+ });
+
+ let inner_guard = set_default(&Dispatch::new(TestSubscriberB));
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberB>(),
+ "set_default inner subscriber failed"
+ )
+ });
+
+ drop(inner_guard);
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "set_default outer subscriber failed"
+ )
+ });
+}
diff --git a/crates/tracing-core/tests/global_dispatch.rs b/crates/tracing-core/tests/global_dispatch.rs
new file mode 100644
index 0000000..d430ac6
--- /dev/null
+++ b/crates/tracing-core/tests/global_dispatch.rs
@@ -0,0 +1,34 @@
+mod common;
+
+use common::*;
+use tracing_core::dispatcher::*;
+#[test]
+fn global_dispatch() {
+ set_global_default(Dispatch::new(TestSubscriberA)).expect("global dispatch set failed");
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "global dispatch get failed"
+ )
+ });
+
+ #[cfg(feature = "std")]
+ with_default(&Dispatch::new(TestSubscriberB), || {
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberB>(),
+ "thread-local override of global dispatch failed"
+ )
+ });
+ });
+
+ get_default(|current| {
+ assert!(
+ current.is::<TestSubscriberA>(),
+ "reset to global override failed"
+ )
+ });
+
+ set_global_default(Dispatch::new(TestSubscriberA))
+ .expect_err("double global dispatch set succeeded");
+}
diff --git a/crates/tracing-core/tests/local_dispatch_before_init.rs b/crates/tracing-core/tests/local_dispatch_before_init.rs
new file mode 100644
index 0000000..71b67f8
--- /dev/null
+++ b/crates/tracing-core/tests/local_dispatch_before_init.rs
@@ -0,0 +1,43 @@
+mod common;
+
+use common::*;
+use tracing_core::{
+ dispatcher::{self, Dispatch},
+ subscriber::NoSubscriber,
+};
+
+/// This test reproduces the following issues:
+/// - https://github.com/tokio-rs/tracing/issues/2587
+/// - https://github.com/tokio-rs/tracing/issues/2411
+/// - https://github.com/tokio-rs/tracing/issues/2436
+#[test]
+fn local_dispatch_before_init() {
+ dispatcher::get_default(|current| assert!(dbg!(current).is::<NoSubscriber>()));
+
+ // Temporarily override the default dispatcher with a scoped dispatcher.
+ // Using a scoped dispatcher makes the thread local state attempt to cache
+ // the scoped default.
+ #[cfg(feature = "std")]
+ {
+ dispatcher::with_default(&Dispatch::new(TestSubscriberB), || {
+ dispatcher::get_default(|current| {
+ assert!(
+ dbg!(current).is::<TestSubscriberB>(),
+ "overriden subscriber not set",
+ );
+ })
+ })
+ }
+
+ dispatcher::get_default(|current| assert!(current.is::<NoSubscriber>()));
+
+ dispatcher::set_global_default(Dispatch::new(TestSubscriberA))
+ .expect("set global dispatch failed");
+
+ dispatcher::get_default(|current| {
+ assert!(
+ dbg!(current).is::<TestSubscriberA>(),
+ "default subscriber not set"
+ );
+ });
+}
diff --git a/crates/tracing-core/tests/macros.rs b/crates/tracing-core/tests/macros.rs
new file mode 100644
index 0000000..ee9007e
--- /dev/null
+++ b/crates/tracing-core/tests/macros.rs
@@ -0,0 +1,48 @@
+use tracing_core::{
+ callsite::Callsite,
+ metadata,
+ metadata::{Kind, Level, Metadata},
+ subscriber::Interest,
+};
+
+#[test]
+fn metadata_macro_api() {
+ // This test should catch any inadvertent breaking changes
+ // caused by changes to the macro.
+ struct TestCallsite;
+
+ impl Callsite for TestCallsite {
+ fn set_interest(&self, _: Interest) {
+ unimplemented!("test")
+ }
+ fn metadata(&self) -> &Metadata<'_> {
+ unimplemented!("test")
+ }
+ }
+
+ static CALLSITE: TestCallsite = TestCallsite;
+ let _metadata = metadata! {
+ name: "test_metadata",
+ target: "test_target",
+ level: Level::DEBUG,
+ fields: &["foo", "bar", "baz"],
+ callsite: &CALLSITE,
+ kind: Kind::SPAN,
+ };
+ let _metadata = metadata! {
+ name: "test_metadata",
+ target: "test_target",
+ level: Level::TRACE,
+ fields: &[],
+ callsite: &CALLSITE,
+ kind: Kind::EVENT,
+ };
+ let _metadata = metadata! {
+ name: "test_metadata",
+ target: "test_target",
+ level: Level::INFO,
+ fields: &[],
+ callsite: &CALLSITE,
+ kind: Kind::EVENT
+ };
+}
diff --git a/crates/tracing-subscriber/.cargo-checksum.json b/crates/tracing-subscriber/.cargo-checksum.json
new file mode 100644
index 0000000..fedf795
--- /dev/null
+++ b/crates/tracing-subscriber/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"2152435d7e0fec79dd62372abe24848a9de126309911e65631698524460c763c","Cargo.toml":"31a06777dd56c5b135fa2cd4ade703cbe87505b76a20d81303f15365af574083","LICENSE":"898b1ae9821e98daf8964c8d6c7f61641f5f5aa78ad500020771c0939ee0dea1","README.md":"14f92d71cc6400aee373510afe8eb6ecf66fec98dca29ab8159751fe8c943c07","benches/enter.rs":"4a94a04e2abd07950ef2f0b646f4dcdf4ff00abf6396edb5a53c8b41b7691b1a","benches/filter.rs":"6374005ffa47fa19880bb95e3e37406f40ea72a02c5136f4d5eb4c663d452b18","benches/filter_log.rs":"612716bdf9a188093e84d014a4847f18157f148f7d64e54150cd5c91ac709a8a","benches/fmt.rs":"5a0ff37967ffef3a221eebb78855d031e2e883a8a67528c8e794cc6f16cbee8a","benches/support/mod.rs":"82d20104f557b884b3da5d7e12d705fc6032021131f44254ab78593236a23254","src/field/debug.rs":"4ab50198a0b042d92fefa77b5cac0aef7ba6936149fa555f4b6e2036dcd7f2d7","src/field/delimited.rs":"5e7967637dc3181c097637dcb2a95f35db16583b5fc293b30211db5779ab21ab","src/field/display.rs":"da8cfcb22a39f451f075e2c3a9ce5193c6afe19853cdbd643239657cac5b7e47","src/field/mod.rs":"a33c896b25b20e832e27547555137b4d3b2ea1a408ddee7bba32308de18cc446","src/filter/directive.rs":"2fa641b29551d0550a2d441203a8d803d55698db9104163ac555bf04ffcd3842","src/filter/env/builder.rs":"5001a78c904e7bd080881c73acb79bf4daa61ab5b808f9fb23e78c16f07e8c6c","src/filter/env/directive.rs":"b3168cd8bbb3bb46b9a4358d9d4582d493bfdfdc54c039a7c492b70f287f7635","src/filter/env/field.rs":"e1e32a2fc39884c9a5df1d5047128e43f1d0720c0b9daa6bf1e08ca9bcc5f537","src/filter/env/mod.rs":"8403df3f061a1c266b6ab6b30b03c6eb32c1c9354037a2d1eeb36817932e6ea5","src/filter/filter_fn.rs":"0debbc4a4b4d2a57b2a06905017ac908bf34b0a64aaf961535fbf6f4d5a700a9","src/filter/layer_filters/combinator.rs":"695de9d8b0a04df09bea08cc40403e09ff66613c07f72c403f7bc65b89e1fd36","src/filter/layer_filters/mod.rs":"3daf9ea751ca43cea8abe4ced0497b821272d19753f991739385a253a6e51636","src/filter/level.rs":"cc449757aac47caaf19dd5ba4d74c8efbcd7531fcd6c13da0c5f6fdda12cc9ca","src/filter/mod.rs":"8ebfd0dc92415ff27ec552f20919e598842a87186f13f120449053a96e1e3307","src/filter/targets.rs":"f587ad41d70e4c770f5732e498d88f34ed9d05946ef5c79bcf8ba0553db56668","src/fmt/fmt_layer.rs":"f20886b8418e8ecd8debd71004c4c03c0783134a2c6b938c10e189e0fbf454bd","src/fmt/format/json.rs":"84b7ffbca13a1a89c4fecc006bf2675632125550198bf47ad6adc71da7aa75e7","src/fmt/format/mod.rs":"53154811fcb0be70650653e4f22e2c6f3585258ec477bc6686a995579120090c","src/fmt/format/pretty.rs":"d4b61d70d1e5b9e01b856acc9db7b23dd27697c587e424f699fb586dd29f73a4","src/fmt/mod.rs":"3de04211e3079116c0c466e76d0ea82a4f51ac9a807b6c66b96b95ff612094f0","src/fmt/time/chrono_crate.rs":"25ff3d1cc8f943669d0141acebf5b50826055d95eee331dd7884deb0903505f0","src/fmt/time/datetime.rs":"778d4604d800e46b940087394e7b72750738b554e02aea523fa9820ab0768c08","src/fmt/time/mod.rs":"3f5d27b05420ba1fc74cea95ab1f8f5382b28234b6078a670a4efcba07ab63be","src/fmt/time/time_crate.rs":"764b79ab3d8de82cd6f4d133e71a7c181dfb5cacd7437d116b55a68b0378de55","src/fmt/writer.rs":"e448b1e384d771dd1fc682d93a7871229ad1d949ad985c99d77a2df586bf10ba","src/layer/context.rs":"77137d8b2810c9059ce7838c3b665748bcb9765487d6103b92596e08b0e9e84b","src/layer/layered.rs":"85c427dfe90823a5c7120fe0e9fd7e0d74e464ab6bb5b3fd37632d522dba9c75","src/layer/mod.rs":"81eff2363ccf313073b9e44d5d564100e51ce78c53d9159506e8b47eadd7942f","src/layer/tests.rs":"3e974d627c4bc4269cfa10c82c890e596c9d46af8e6bc03c6c117bde1237e948","src/lib.rs":"d948bcd65f871ee09d9bce47f8e52a4db922359856ef174a6b3c09deb2c83fcf","src/macros.rs":"6993489ad52c487e2b4df2f1102970af3ef918dfef0479ddcc5e904be7679d65","src/prelude.rs":"088635def33be9a4c4b6ed934dc22540c555e27d62f7625a43aa9c0e525ca467","src/registry/extensions.rs":"0418b39287bbc06cc95b8cecd6a25aa808b8e04714d842340ff75db458cafe5b","src/registry/mod.rs":"8f5f87c6c0a307d0be805a726ff91d1b92202397bc0c747b99752e3f22693781","src/registry/sharded.rs":"f2d2e016d2541146801d290fc98962303c17d1ff9de1e65a73ebf6de1089e096","src/registry/stack.rs":"9ef333d6a8a28a064e80ff1e376dbb07bc597009010ec332b2dc3ab435d737c2","src/reload.rs":"c9522d15d5cd2b840d37e2bbf366e55c1372df5c75781fde12c8bd092e9e21d1","src/sync.rs":"7f78f3de5b618a999be0e61f936a233975e7769f1ebb55a0e48c3d199e9c45e3","src/util.rs":"55b4e9d63112f9d5a12a287273a9b1212741058384332d3edc024168cacfd627","tests/cached_layer_filters_dont_break_other_layers.rs":"781b58dbb6a1a1c12e44458566e73baada0ab74ce5cf1d39d7fb1534f2337410","tests/duplicate_spans.rs":"3bf35184fb7d1dc5f33e5098820febbec37ef3ccd06b693d11b5585affb60ff4","tests/env_filter/main.rs":"5fea3520cb3e26104b4328c6cdbb7f18c2c6f5550bf88001f7eeb4b446f61bfa","tests/env_filter/per_layer.rs":"bbd651d43489da587ccb5c6cb9e6faf0fd0cc64badc1a060bd34c8dd8cbc5e56","tests/event_enabling.rs":"15e301a8ff6c74c454547dad15a47b5f11fc54e539162191f21462b6d5080830","tests/field_filter.rs":"08883ba496404558966cd1d7a995f7ec0539afde6ff143530c74429b84b26089","tests/filter_log.rs":"f7f4a871cd4d6336c01388776ef7c85ee28457bab833a67e3d6c9f123942b124","tests/fmt_max_level_hint.rs":"d4c6d6f976ae41ab8052fa610a7337ad7150802cbd5634cb30fc45c1f215cfcd","tests/hinted_layer_filters_dont_break_other_layers.rs":"264372daa411a2b0475b70bd03d2a76b699ed3f4eced7e974b415100968c5b94","tests/layer_filter_interests_are_cached.rs":"0d6005ea0d5add4c5be1e9425ced63d1fe6db47ae5b5d11fa47b7c74ef247be8","tests/layer_filters/boxed.rs":"c6ab82b5818e98fdc75a87f7dbb7c1574fa1ae26453df55db85644c3f35edc08","tests/layer_filters/combinators.rs":"37f92286cbf9b2767c53103d47d1cde110f5f52ea2af796cd04a0a929f026286","tests/layer_filters/downcast_raw.rs":"9b90ead571543cbe14e89b4fe637360d9baf3069f6f656ed3bdf65e7318648f1","tests/layer_filters/filter_scopes.rs":"cf27445dfb0794aaa702ae6c0b6ec7ec49202d8bb438965761bf65bc95ed5504","tests/layer_filters/main.rs":"f4fac09c5eb320675af5e865b33d144cc4ddb94dc114094cbaac71ab3fa55fb0","tests/layer_filters/option.rs":"f68ebfb1dd4046021e0c450eb729eee908fec3b363911172db8e2b06f87a6f03","tests/layer_filters/per_event.rs":"d042e51d4659cf0121c7765afd2cb132cc3b68c7069d569a642747a3cb1a26d2","tests/layer_filters/targets.rs":"c4e0d74484ea8f9a03ff29f8f69551ba47d4236e432ce3e2c6f677244bf0e2c7","tests/layer_filters/trees.rs":"c178ff3a97637d8102a5f6e10b25f34fff90744d6bc2e15b92830a21e208e951","tests/layer_filters/vec.rs":"c89e100e995b0f777e13fafefe11096071a19d4dacc8eb8c2fba75e51abaeec8","tests/multiple_layer_filter_interests_cached.rs":"617f67af50e99bada5e06130845109468020be807fb238d5e9c193dcce4eb04a","tests/option.rs":"0268ca64fb3068bfa95126a477009611253130f902fc558a4605649945bdae29","tests/option_filter_interest_caching.rs":"696fad992d96f4571d74b73ace72274e17ebe1b929c511f6b18030d04d95d717","tests/registry_max_level_hint.rs":"ba386d32b8d13832d7009163241c3d0723488c0393d85647eb9368776251e4fc","tests/registry_with_subscriber.rs":"61a545e1bf3f75efd0dd18c20bb93e8a1f2e0158b342179a94228c4cbd5bb9cc","tests/reload.rs":"8f169b60ab67bbc171dd7e576236b901293b5baa08ea469765a042375855e0f4","tests/same_len_filters.rs":"68b6c0965af1ed745b5304c8c19476c51e8cc213ed41edea0002cb181f831ae2","tests/unhinted_layer_filters_dont_break_other_layers.rs":"f36746f221817e76a280658331c9e8a0a959f755fc4dc05580224514eee79221","tests/utils.rs":"774e41c08ec6ee831e25142d21389f82e84cc7707aaddb5bd12d7429e4fb6a79","tests/vec.rs":"d1176f3e1b0954129792a28282b95084d417143b0cc4e35887b95cee3c675392","tests/vec_subscriber_filter_interests_cached.rs":"c5f894c93699bc67ec0635bfa3f2cbe6fcc8ab255ed8400e7927f86d3205ec8d"},"package":"ad0f048c97dbd9faa9b7df56362b8ebcaa52adb06b498c050d2f4e32f90a7a8b"}
\ No newline at end of file
diff --git a/crates/tracing-subscriber/Android.bp b/crates/tracing-subscriber/Android.bp
new file mode 100644
index 0000000..85f9a99
--- /dev/null
+++ b/crates/tracing-subscriber/Android.bp
@@ -0,0 +1,47 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tracing-subscriber_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tracing-subscriber_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtracing_subscriber",
+ host_supported: true,
+ crate_name: "tracing_subscriber",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.18",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "alloc",
+ "fmt",
+ "parking_lot",
+ "registry",
+ "sharded-slab",
+ "smallvec",
+ "std",
+ "thread_local",
+ ],
+ rustlibs: [
+ "libparking_lot",
+ "libsharded_slab",
+ "libsmallvec",
+ "libthread_local",
+ "libtracing_core",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tracing-subscriber/CHANGELOG.md b/crates/tracing-subscriber/CHANGELOG.md
new file mode 100644
index 0000000..a8894b9
--- /dev/null
+++ b/crates/tracing-subscriber/CHANGELOG.md
@@ -0,0 +1,1363 @@
+# 0.3.18 (November 13, 2023)
+
+This release of `tracing-subscriber` adds support for the [`NO_COLOR`] environment
+variable (an informal standard to disable emitting ANSI color escape codes) in
+`fmt::Layer`, reintroduces support for the [`chrono`] crate, and increases the
+minimum supported Rust version (MSRV) to Rust 1.63.0.
+
+It also introduces several minor API improvements.
+
+### Added
+
+- **chrono**: Add [`chrono`] implementations of `FormatTime` ([#2690])
+- **subscriber**: Add support for the [`NO_COLOR`] environment variable in
+`fmt::Layer` ([#2647])
+- **fmt**: make `format::Writer::new()` public ([#2680])
+- **filter**: Implement `layer::Filter` for `Option<Filter>` ([#2407])
+
+### Changed
+
+- **log**: bump version of `tracing-log` to 0.2 ([#2772])
+- Increased minimum supported Rust version (MSRV) to 1.63.0+.
+
+[`chrono`]: https://github.com/chronotope/chrono
+[`NO_COLOR`]: https://no-color.org/
+[#2690]: https://github.com/tokio-rs/tracing/pull/2690
+[#2647]: https://github.com/tokio-rs/tracing/pull/2647
+[#2680]: https://github.com/tokio-rs/tracing/pull/2680
+[#2407]: https://github.com/tokio-rs/tracing/pull/2407
+[#2772]: https://github.com/tokio-rs/tracing/pull/2772
+
+Thanks to @shayne-fletcher, @dmlary, @kaifastromai, and @jsgf for contributing!
+
+# 0.3.17 (April 21, 2023)
+
+This release of `tracing-subscriber` fixes a build error when using `env-filter`
+with recent versions of the `regex` crate. It also introduces several minor API
+improvements.
+
+### Fixed
+
+- **env-filter**: Add "unicode-case" and "unicode-perl" to the `regex`
+ dependency, fixing a build error with recent versions of `regex` ([#2566])
+- A number of minor documentation typos and other fixes ([#2384], [#2378],
+ [#2368], [#2548])
+
+### Added
+
+- **filter**: Add `fmt::Display` impl for `filter::Targets` ([#2343])
+- **fmt**: Made `with_ansi(false)` no longer require the "ansi" feature, so that
+ ANSI formatting escapes can be disabled without requiring ANSI-specific
+ dependencies ([#2532])
+
+### Changed
+
+- **fmt**: Dim targets in the `Compact` formatter, matching the default
+ formatter ([#2409])
+
+Thanks to @keepsimple1, @andrewhalle, @LeoniePhiline, @LukeMathWalker,
+@howardjohn, @daxpedda, and @dbidwell94 for contributing to this release!
+
+[#2566]: https://github.com/tokio-rs/tracing/pull/2566
+[#2384]: https://github.com/tokio-rs/tracing/pull/2384
+[#2378]: https://github.com/tokio-rs/tracing/pull/2378
+[#2368]: https://github.com/tokio-rs/tracing/pull/2368
+[#2548]: https://github.com/tokio-rs/tracing/pull/2548
+[#2343]: https://github.com/tokio-rs/tracing/pull/2343
+[#2532]: https://github.com/tokio-rs/tracing/pull/2532
+[#2409]: https://github.com/tokio-rs/tracing/pull/2409
+
+# 0.3.16 (October 6, 2022)
+
+This release of `tracing-subscriber` fixes a regression introduced in
+[v0.3.15][subscriber-0.3.15] where `Option::None`'s `Layer` implementation would
+set the max level hint to `OFF`. In addition, it adds several new APIs,
+including the `Filter::event_enabled` method for filtering events based on
+fields values, and the ability to log internal errors that occur when writing a
+log line.
+
+This release also replaces the dependency on the unmaintained [`ansi-term`]
+crate with the [`nu-ansi-term`] crate, resolving an *informational* security
+advisory ([RUSTSEC-2021-0139]) for [`ansi-term`]'s maintainance status. This
+increases the minimum supported Rust version (MSRV) to Rust 1.50+, although the
+crate should still compile for the previous MSRV of Rust 1.49+ when the `ansi`
+feature is not enabled.
+
+### Fixed
+
+- **layer**: `Option::None`'s `Layer` impl always setting the `max_level_hint`
+ to `LevelFilter::OFF` ([#2321])
+- Compilation with `-Z minimal versions` ([#2246])
+- **env-filter**: Clarify that disabled level warnings are emitted by
+ `tracing-subscriber` ([#2285])
+
+### Added
+
+- **fmt**: Log internal errors to `stderr` if writing a log line fails ([#2102])
+- **fmt**: `FmtLayer::log_internal_errors` and
+ `FmtSubscriber::log_internal_errors` methods for configuring whether internal
+ writer errors are printed to `stderr` ([#2102])
+- **fmt**: `#[must_use]` attributes on builders to warn if a `Subscriber` is
+ configured but not set as the default subscriber ([#2239])
+- **filter**: `Filter::event_enabled` method for filtering an event based on its
+ fields ([#2245], [#2251])
+- **filter**: `Targets::default_level` accessor ([#2242])
+
+### Changed
+
+- **ansi**: Replaced dependency on unmaintained `ansi-term` crate with
+ `nu-ansi-term` (([#2287], fixes informational advisory [RUSTSEC-2021-0139])
+- `tracing-core`: updated to [0.1.30][core-0.1.30]
+- Minimum Supported Rust Version (MSRV) increased to Rust 1.50+ (when the
+ `ansi`) feature flag is enabled ([#2287])
+
+### Documented
+
+- **fmt**: Correct inaccuracies in `fmt::init` documentation ([#2224])
+- **filter**: Fix incorrect doc link in `filter::Not` combinator ([#2249])
+
+Thanks to new contributors @cgbur, @DesmondWillowbrook, @RalfJung, and
+@poliorcetics, as well as returning contributors @CAD97, @connec, @jswrenn,
+@guswynn, and @bryangarza, for contributing to this release!
+
+[nu-ansi-term]: https://github.com/nushell/nu-ansi-term
+[ansi_term]: https://github.com/ogham/rust-ansi-term
+[RUSTSEC-2021-0139]: https://rustsec.org/advisories/RUSTSEC-2021-0139.html
+[core-0.1.30]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.30
+[subscriber-0.3.15]: https://github.com/tokio-rs/tracing/releases/tag/tracing-subscriber-0.3.15
+[#2321]: https://github.com/tokio-rs/tracing/pull/2321
+[#2246]: https://github.com/tokio-rs/tracing/pull/2246
+[#2285]: https://github.com/tokio-rs/tracing/pull/2285
+[#2102]: https://github.com/tokio-rs/tracing/pull/2102
+[#2239]: https://github.com/tokio-rs/tracing/pull/2239
+[#2245]: https://github.com/tokio-rs/tracing/pull/2245
+[#2251]: https://github.com/tokio-rs/tracing/pull/2251
+[#2287]: https://github.com/tokio-rs/tracing/pull/2287
+[#2224]: https://github.com/tokio-rs/tracing/pull/2224
+[#2249]: https://github.com/tokio-rs/tracing/pull/2249
+
+# 0.3.15 (Jul 20, 2022)
+
+This release fixes a bug where the `reload` layer would fail to pass through
+`max_level_hint` to the underlying layer, potentially breaking filtering.
+
+### Fixed
+
+- **reload**: pass through `max_level_hint` to the inner `Layer` ([#2204])
+
+Thanks to @guswynn for contributing to this release!
+
+[#2204]: https://github.com/tokio-rs/tracing/pull/2204
+
+# 0.3.14 (Jul 1, 2022)
+
+This release fixes multiple filtering bugs in the `Layer` implementations for
+`Option<impl Layer>` and `Vec<impl Layer>`.
+
+### Fixed
+
+- **layer**: `Layer::event_enabled` implementation for `Option<impl Layer<S>>`
+ returning `false` when the `Option` is `None`, disabling all events globally
+ ([#2193])
+- **layer**: `Layer::max_level_hint` implementation for `Option<impl Layer<S>>`
+ incorrectly disabling max level filtering when the option is `None` ([#2195])
+- **layer**: `Layer::max_level_hint` implementation for `Vec<impl Layer<S>>`
+ returning `LevelFilter::ERROR` rather than `LevelFilter::OFF` when the `Vec`
+ is empty ([#2195])
+
+Thanks to @CAD97 and @guswynn for contributing to this release!
+
+[#2193]: https://github.com/tokio-rs/tracing/pull/2193
+[#2195]: https://github.com/tokio-rs/tracing/pull/2195
+
+# 0.3.13 (Jun 30, 2022) (YANKED)
+
+This release of `tracing-subscriber` fixes a compilation failure due to an
+incorrect `tracing-core` dependency that was introduced in v0.3.12.
+
+### Changed
+
+- **tracing_core**: Updated minimum dependency version to 0.1.28 ([#2190])
+
+[#2190]: https://github.com/tokio-rs/tracing/pull/2190
+
+# 0.3.12 (Jun 29, 2022) (YANKED)
+
+This release of `tracing-subscriber` adds a new `Layer::event_enabled` method,
+which allows `Layer`s to filter events *after* their field values are recorded;
+a `Filter` implementation for `reload::Layer`, to make using `reload` with
+per-layer filtering more ergonomic, and additional inherent method downcasting
+APIs for the `Layered` type. In addition, it includes dependency updates, and
+minor fixes for documentation and feature flagging.
+
+### Added
+
+- **layer**: `Layer::event_enabled` method, which can be implemented to filter
+ events based on their field values ([#2008])
+- **reload**: `Filter` implementation for `reload::Layer` ([#2159])
+- **layer**: `Layered::downcast_ref` and `Layered::is` inherent methods
+ ([#2160])
+
+### Changed
+
+- **parking_lot**: Updated dependency on `parking_lot` to 0.13.0 ([#2143])
+- Replaced `lazy_static` dependency with `once_cell` ([#2147])
+
+### Fixed
+
+- Don't enable `tracing-core` features by default ([#2107])
+- Several documentation link and typo fixes ([#2064], [#2068], #[2077], [#2161],
+ [#1088])
+
+Thanks to @ben0x539, @jamesmunns, @georgemp, @james7132, @jswrenn, @CAD97, and
+@guswynn for contributing to this release!
+
+[#2008]: https://github.com/tokio-rs/tracing/pull/2008
+[#2159]: https://github.com/tokio-rs/tracing/pull/2159
+[#2160]: https://github.com/tokio-rs/tracing/pull/2160
+[#2143]: https://github.com/tokio-rs/tracing/pull/2143
+[#2107]: https://github.com/tokio-rs/tracing/pull/2107
+[#2064]: https://github.com/tokio-rs/tracing/pull/2064
+[#2068]: https://github.com/tokio-rs/tracing/pull/2068
+[#2077]: https://github.com/tokio-rs/tracing/pull/2077
+[#2161]: https://github.com/tokio-rs/tracing/pull/2161
+[#1088]: https://github.com/tokio-rs/tracing/pull/1088
+
+# 0.3.11 (Apr 9, 2022)
+
+This is a bugfix release for the `Filter` implementation for `EnvFilter` added
+in [v0.3.10].
+
+### Fixed
+
+- **env-filter**: Added missing `Filter::on_record` callback to `EnvFilter`'s
+ `Filter` impl ([#2058])
+- **env-filter**: Fixed method resolution issues when calling `EnvFilter`
+ methods with both the `Filter` and `Layer` traits in scope ([#2057])
+- **env-filter**: Fixed `EnvFilter::builder().parse()` and other parsing methods
+ returning an error when parsing an empty string ([#2052])
+
+Thanks to new contributor @Ma124 for contributing to this release!
+
+[v0.3.10]: https://github.com/tokio-rs/tracing/releases/tag/tracing-subscriber-0.3.10
+[#2058]: https://github.com/tokio-rs/tracing/pull/2058
+[#2057]: https://github.com/tokio-rs/tracing/pull/2057
+[#2052]: https://github.com/tokio-rs/tracing/pull/2052
+
+# 0.3.10 (Apr 1, 2022)
+
+This release adds several new features, including a `Filter` implementation and
+new builder API for `EnvFilter`, support for using a `Vec<L> where L: Layer` as
+a `Layer`, and a number of smaller API improvements to make working with dynamic
+and reloadable layers easier.
+
+### Added
+
+- **registry**: Implement `Filter` for `EnvFilter`, allowing it to be used with
+ per-layer filtering ([#1983])
+- **registry**: `Filter::on_new_span`, `Filter::on_enter`,
+ `Filter::on_exit`, `Filter::on_close` and `Filter::on_record` callbacks to
+ allow `Filter`s to track span states internally ([#1973], [#2017], [#2031])
+- **registry**: `Filtered::filter` and `Filtered::filter_mut` accessors
+ ([#1959])
+- **registry**: `Filtered::inner` and `Filtered::inner_mut` accessors to borrow
+ the wrapped `Layer` ([#2034])
+- **layer**: Implement `Layer` for `Vec<L: Layer>`, to allow composing together
+ a dynamically sized list of `Layer`s ([#2027])
+- **layer**: `Layer::boxed` method to make type-erasing `Layer`s easier
+ ([#2026])
+- **fmt**: `fmt::Layer::writer` and `fmt::Layer::writer_mut` accessors ([#2034])
+- **fmt**: `fmt::Layer::set_ansi` method to allow changing the ANSI formatting
+ configuration at runtime ([#2034])
+- **env-filter**: `EnvFilter::builder` to configure a new `EnvFilter` prior to
+ parsing it ([#2035])
+- Several documentation fixes and improvements ([#1972], [#1971], [#2023],
+ [#2023])
+
+### Fixed
+
+- **fmt**: `fmt::Layer`'s auto traits no longer depend on the `Subscriber` type
+ parameter's auto traits ([#2025])
+- **env-filter**: Fixed missing help text when the `ansi` feature is disabled
+ ([#2029])
+
+Thanks to new contributors @TimoFreiberg and @wagenet, as well as @CAD97 for
+contributing to this release!
+
+[#1983]: https://github.com/tokio-rs/tracing/pull/1983
+[#1973]: https://github.com/tokio-rs/tracing/pull/1973
+[#2017]: https://github.com/tokio-rs/tracing/pull/2017
+[#2031]: https://github.com/tokio-rs/tracing/pull/2031
+[#1959]: https://github.com/tokio-rs/tracing/pull/1959
+[#2034]: https://github.com/tokio-rs/tracing/pull/2034
+[#2027]: https://github.com/tokio-rs/tracing/pull/2027
+[#2026]: https://github.com/tokio-rs/tracing/pull/2026
+[#2035]: https://github.com/tokio-rs/tracing/pull/2035
+[#1972]: https://github.com/tokio-rs/tracing/pull/1972
+[#1971]: https://github.com/tokio-rs/tracing/pull/1971
+[#2023]: https://github.com/tokio-rs/tracing/pull/2023
+[#2025]: https://github.com/tokio-rs/tracing/pull/2025
+[#2029]: https://github.com/tokio-rs/tracing/pull/2029
+
+# 0.3.9 (Feb 17, 2022)
+
+This release updates the minimum supported Rust version (MSRV) to 1.49.0, and
+updates the (optional) dependency on `parking_lot` to v0.12.
+
+### Changed
+
+- Updated minimum supported Rust version (MSRV) to 1.49.0 ([#1913])
+- `parking_lot`: updated to v0.12 ([008339d])
+
+### Added
+
+- **fmt**: Documentation improvements ([#1926], [#1927])
+
+[#1913]: https://github.com/tokio-rs/tracing/pull/1913
+[#1926]: https://github.com/tokio-rs/tracing/pull/1926
+[#1927]: https://github.com/tokio-rs/tracing/pull/1927
+[008339d]: https://github.com/tokio-rs/tracing/commit/008339d1e8750ffe7b4634fc7789bda0c522424f
+
+# 0.3.8 (Feb 4, 2022)
+
+This release adds *experimental* support for recording structured field
+values using the [`valuable`] crate to the `format::Json` formatter. In
+particular, user-defined types which are recorded using their
+[`valuable::Valuable`] implementations will be serialized as JSON objects,
+rather than using their `fmt::Debug` representation. See [this blog post][post]
+for details on `valuable`.
+
+Note that `valuable` support currently requires `--cfg tracing_unstable`. See
+the documentation for details.
+
+Additionally, this release includes a number of other smaller API improvements.
+
+### Added
+
+- **json**: Experimental support for recording [`valuable`] values as structured
+ JSON ([#1862], [#1901])
+- **filter**: `Targets::would_enable` method for testing if a `Targets` filter
+ would enable a given target ([#1903])
+- **fmt**: `map_event_format`, `map_fmt_fields`, and `map_writer` methods to
+ `fmt::Layer` and `fmt::SubscriberBuilder` ([#1871])
+
+### Changed
+
+- `tracing-core`: updated to [0.1.22][core-0.1.22]
+
+### Fixed
+
+- Set `smallvec` minimal version to 1.2.0, to fix compilation errors with `-Z
+ minimal-versions` ([#1890])
+- Minor documentation fixes ([#1902], [#1893])
+
+Thanks to @guswynn, @glts, and @lilyball for contributing to this release!
+
+[`valuable`]: https://crates.io/crates/valuable
+[`valuable::Valuable`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html
+[post]: https://tokio.rs/blog/2021-05-valuable
+[core-0.1.22]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.22
+[#1862]: https://github.com/tokio-rs/tracing/pull/1862
+[#1901]: https://github.com/tokio-rs/tracing/pull/1901
+[#1903]: https://github.com/tokio-rs/tracing/pull/1903
+[#1871]: https://github.com/tokio-rs/tracing/pull/1871
+[#1890]: https://github.com/tokio-rs/tracing/pull/1890
+[#1902]: https://github.com/tokio-rs/tracing/pull/1902
+[#1893]: https://github.com/tokio-rs/tracing/pull/1893
+
+# 0.3.7 (Jan 25, 2022)
+
+This release adds combinators for combining filters.
+
+Additionally, this release also updates the `thread-local` crate to v1.1.4,
+fixing warnings for the security advisory [RUSTSEC-2022-0006]. Note that
+previous versions of `tracing-subscriber` did not use any of the `thread-local`
+crate's APIs effected by the vulnerability. However, updating the version fixes
+warnings emitted by `cargo audit` and similar tools.
+
+### Added
+
+- **filter**: Added combinators for combining filters ([#1578])
+
+### Fixed
+
+- **registry**: Updated `thread-local` to v1.1.4 ([#1858])
+
+Thanks to new contributor @matze for contributing to this release!
+
+[RUSTSEC-2022-0006]: https://rustsec.org/advisories/RUSTSEC-2022-0006
+[#1578]: https://github.com/tokio-rs/tracing/pull/1578
+[#1858]: https://github.com/tokio-rs/tracing/pull/1858
+
+# 0.3.6 (Jan 14, 2022)
+
+This release adds configuration options to `tracing_subscriber::fmt` to log
+source code locations for events.
+### Added
+
+- **fmt**: Added `with_file` and `with_line_number`
+ configuration methods to `fmt::Format`, `fmt::SubscriberBuilder`, and
+ `fmt::Layer` ([#1773])
+
+### Fixed
+
+- **fmt**: Removed incorrect leading comma from span fields with the `Pretty`
+ formatter ([#1833])
+
+### Deprecated
+
+- **fmt**: Deprecated `Pretty::with_source_location`, as it can now be replaced
+ by the more general `Format`, `SubscriberBuilder`, and `Layer` methods
+ ([#1773])
+
+Thanks to new contributor @renecouto for contributing to this release!
+
+[#1773]: https://github.com/tokio-rs/tracing/pull/1773
+[#1833]: https://github.com/tokio-rs/tracing/pull/1833
+
+# 0.3.5 (Dec 29, 2021)
+
+This release re-enables `RUST_LOG` filtering in `tracing_subscriber::fmt`'s
+default initialization methods, and adds an `OffsetLocalTime` formatter for
+using local timestamps with the `time` crate.
+
+### Added
+
+- **fmt**: Added `OffsetLocalTime` formatter to `fmt::time` for formatting local
+ timestamps with a fixed offset ([#1772])
+
+### Fixed
+
+- **fmt**: Added a `Targets` filter to `fmt::init()` and `fmt::try_init()` when
+ the "env-filter" feature is disabled, so that `RUST_LOG` is still honored
+ ([#1781])
+
+Thanks to @marienz and @ishitatsuyuki for contributing to this release!
+
+[#1772]: https://github.com/tokio-rs/tracing/pull/1772
+[#1781]: https://github.com/tokio-rs/tracing/pull/1781
+
+# 0.3.4 (Dec 23, 2021)
+
+This release contains bugfixes for the `fmt` module, as well as documentation
+improvements.
+
+### Fixed
+
+- **fmt**: Fixed `fmt` not emitting log lines when timestamp formatting fails
+ ([#1689])
+- **fmt**: Fixed double space before thread IDs with `Pretty` formatter
+ ([#1778])
+- Several documentation improvements ([#1608], [#1699], [#1701])
+
+[#1689]: https://github.com/tokio-rs/tracing/pull/1689
+[#1778]: https://github.com/tokio-rs/tracing/pull/1778
+[#1608]: https://github.com/tokio-rs/tracing/pull/1608
+[#1699]: https://github.com/tokio-rs/tracing/pull/1699
+[#1701]: https://github.com/tokio-rs/tracing/pull/1701
+
+Thanks to new contributors @Swatinem and @rukai for contributing to this
+release!
+
+# 0.3.3 (Nov 29, 2021)
+
+This release fixes a pair of regressions in `tracing-subscriber`'s `fmt` module.
+
+### Fixed
+
+- **fmt**: Fixed missing event fields with `Compact` formatter ([#1755])
+- **fmt**: Fixed `PrettyFields` formatter (and thus `format::Pretty` event
+ formatter) ignoring the `fmt::Layer`'s ANSI color code configuration ([#1747])
+
+[#1755]: https://github.com/tokio-rs/tracing/pull/1755
+[#1747]: https://github.com/tokio-rs/tracing/pull/1747
+
+# 0.3.2 (Nov 19, 2021)
+
+### Fixed
+
+- **fmt**: Fixed `MakeWriter` filtering not working with `BoxMakeWriter`
+ ([#1694])
+
+### Added
+
+- **fmt**: `Writer::has_ansi_escapes` method to check if an output supports ANSI
+ terminal formatting escape codes ([#1696])
+- **fmt**: Added additional ANSI terminal formatting to field formatters when
+ supported ([#1702])
+- **fmt**: Added `FmtContext::span_scope`, `FmtContext::event_scope`, and
+ `FmtContext::parent_span` methods for accessing the current span and its scope
+ when formatting an event ([#1728])
+- **fmt**: Improved documentation on implementing event formatters ([#1727])
+
+[#1694]: https://github.com/tokio-rs/tracing/pull/1694
+[#1696]: https://github.com/tokio-rs/tracing/pull/1696
+[#1702]: https://github.com/tokio-rs/tracing/pull/1702
+[#1728]: https://github.com/tokio-rs/tracing/pull/1728
+[#1727]: https://github.com/tokio-rs/tracing/pull/1727
+# 0.3.1 (Oct 25, 2021)
+
+This release fixes a few issues related to feature flagging.
+
+### Fixed
+
+- **time**: Compilation error when enabling the "time" feature flag without also
+ enabling the "local-time" feature flag ([#1685])
+- **registry**: Unused method warnings when the "std" feature is enabled but the
+ "registry" feature is disabled ([#1686])
+
+[#1685]: https://github.com/tokio-rs/tracing/pull/1685
+[#1686]: https://github.com/tokio-rs/tracing/pull/1686
+
+# 0.3.0 (Oct 22, 2021)
+
+This is a breaking release of `tracing-subscriber`. The primary breaking change
+in this release is the removal of the dependency on the [`chrono` crate], due to
+[RUSTSEC-2020-0159]. To replace `chrono`, support is added for formatting
+timestamps using the [`time` crate] instead.
+
+In addition, this release includes a number of other breaking API changes, such
+as adding (limited) support for `#![no_std]` targets, removing previously
+deprecated APIs, and more.
+
+### Breaking Changes
+
+- Removed APIs deprecated in the v0.2.x release series.
+- Renamed `Layer::new_span` to `Layer::on_new_span` ([#1674])
+- Removed `Layer` impl for `Arc<L: Layer<S>>` and `Arc<dyn Layer<S> + ...>`
+ ([#1649])
+- Replaced the [`chrono` crate] with the [`time` crate] for timestamp formatting, to
+ resolve [RUSTSEC-2020-0159] ([#1646])
+- Removed `json` and `env-filter` from default features. They must now be
+ enabled explictly ([#1647]). This means that `RUST_LOG`-based filters _will not_
+ work unless the `env-filter` feature is enabled.
+- Changed `FormatEvent::format_event` and `FormatFields::format_fields`
+ trait methods to take a `Writer` type, rather than a `&mut dyn fmt::Write`
+ trait object ([#1661])
+- Changed the signature of the `MakeWriter` trait by adding a lifetime parameter
+ ([#781])
+
+### Changed
+
+- **layer**: Renamed `Layer::new_span` to `Layer::on_new_span` ([#1674])
+- **fmt**: Changed `FormatEvent::format_event` and `FormatFields::format_fields`
+ trait methods to take a `Writer` type, rather than a `&mut dyn fmt::Write`
+ trait object ([#1661])
+- **json**, **env-filter**: `json` and `env-filter` feature flags are no longer
+ enabled by default ([#1647])
+### Removed
+
+- Removed deprecated `CurrentSpan` type ([#1320])
+- **registry**: Removed deprecated `SpanRef::parents` iterator, replaced by
+ `SpanRef::scope` in [#1431] ([#1648)])
+- **layer**: Removed deprecated `Context::scope` iterator, replaced by
+ `Context::span_scope` and `Context::event_scope` in [#1431] and [#1434]
+ ([#1648)])
+- **layer**: Removed `Layer` impl for `Arc<L: Layer<S>>` and
+ `Arc<dyn Layer<S> + ...>`. These interfere with per-layer filtering. ([#1649])
+- **fmt**: Removed deprecated `LayerBuilder` type ([#1673])
+- **fmt**: Removed `fmt::Layer::on_event` (renamed to `fmt::Layer::fmt_event`)
+ ([#1673])
+- **fmt**, **chrono**: Removed the `chrono` feature flag and APIs for using the
+ [`chrono` crate] for timestamp formatting ([#1646])
+### Added
+
+- **fmt**, **time**: `LocalTime` and `UtcTime` types for formatting timestamps
+ using the [`time` crate] ([#1646])
+- **fmt**: Added a lifetime parameter to the `MakeWriter` trait, allowing it to
+ return a borrowed writer. This enables implementations of `MakeWriter` for
+ types such as `Mutex<T: io::Write>` and `std::fs::File`. ([#781])
+- **env-filter**: Documentation improvements ([#1637])
+- Support for some APIs on `#![no_std]` targets, by disabling the `std` feature
+ flag ([#1660])
+
+Thanks to @Folyd and @nmathewson for contributing to this release!
+
+[#1320]: https://github.com/tokio-rs/tracing/pull/1320
+[#1673]: https://github.com/tokio-rs/tracing/pull/1673
+[#1674]: https://github.com/tokio-rs/tracing/pull/1674
+[#1646]: https://github.com/tokio-rs/tracing/pull/1646
+[#1647]: https://github.com/tokio-rs/tracing/pull/1647
+[#1648]: https://github.com/tokio-rs/tracing/pull/1648
+[#1649]: https://github.com/tokio-rs/tracing/pull/1649
+[#1660]: https://github.com/tokio-rs/tracing/pull/1660
+[#1661]: https://github.com/tokio-rs/tracing/pull/1661
+[#1431]: https://github.com/tokio-rs/tracing/pull/1431
+[#1434]: https://github.com/tokio-rs/tracing/pull/1434
+[#781]: https://github.com/tokio-rs/tracing/pull/781
+
+[`chrono` crate]: https://crates.io/crates/chrono
+[`time` crate]: https://crates.io/crates/time
+[RUSTSEC-2020-0159]: https://rustsec.org/advisories/RUSTSEC-2020-0159.html
+
+# 0.2.25 (October 5, 2021)
+
+This release fixes an issue where a `Layer` implementation's custom
+`downcast_raw` implementation was lost when wrapping that layer with a per-layer
+filter.
+
+### Fixed
+
+- **registry**: Forward `Filtered::downcast_raw` to wrapped `Layer` ([#1619])
+
+### Added
+
+- Documentation improvements ([#1596], [#1601])
+
+Thanks to @bryanburgers for contributing to this release!
+
+[#1619]: https://github.com/tokio-rs/tracing/pull/1619
+[#1601]: https://github.com/tokio-rs/tracing/pull/1601
+[#1596]: https://github.com/tokio-rs/tracing/pull/1596
+
+# 0.2.24 (September 19, 2021)
+
+This release contains a number of bug fixes, including a fix for
+`tracing-subscriber` failing to compile on the minimum supported Rust version of
+1.42.0. It also adds `IntoIterator` implementations for the `Targets` type.
+
+### Fixed
+
+- Fixed compilation on Rust 1.42.0 ([#1580], [#1581])
+- **registry**: Ensure per-layer filter `enabled` state is cleared when a global
+ filter short-circuits filter evaluation ([#1575])
+- **layer**: Fixed `Layer::on_layer` not being called for `Box`ed `Layer`s,
+ which broke per-layer filtering ([#1576])
+
+### Added
+
+- **filter**: Added `Targets::iter`, returning an iterator over the set of
+ target-level pairs enabled by a `Targets` filter ([#1574])
+- **filter**: Added `IntoIterator` implementations for `Targets` and `&Targets`
+ ([#1574])
+
+Thanks to new contributor @connec for contributing to this release!
+
+[#1580]: https://github.com/tokio-rs/tracing/pull/1580
+[#1581]: https://github.com/tokio-rs/tracing/pull/1581
+[#1575]: https://github.com/tokio-rs/tracing/pull/1575
+[#1576]: https://github.com/tokio-rs/tracing/pull/1576
+[#1574]: https://github.com/tokio-rs/tracing/pull/1574
+
+# 0.2.23 (September 16, 2021)
+
+This release fixes a few bugs in the per-layer filtering API added in v0.2.21.
+
+### Fixed
+
+- **env-filter**: Fixed excessive `EnvFilter` memory use ([#1568])
+- **filter**: Fixed a panic that may occur in debug mode when using per-layer
+ filters together with global filters ([#1569])
+- Fixed incorrect documentation formatting ([#1572])
+
+[#1568]: https://github.com/tokio-rs/tracing/pull/1568
+[#1569]: https://github.com/tokio-rs/tracing/pull/1569
+[#1572]: https://github.com/tokio-rs/tracing/pull/1572
+
+# 0.2.22 (September 13, 2021)
+
+This fixes a regression where the `filter::ParseError` type was accidentally
+renamed.
+
+### Fixed
+
+- **filter**: Fix `filter::ParseError` accidentally being renamed to
+ `filter::DirectiveParseError` ([#1558])
+
+[#1558]: https://github.com/tokio-rs/tracing/pull/1558
+
+# 0.2.21 (September 12, 2021)
+
+This release introduces the [`Filter`] trait, a new API for [per-layer
+filtering][plf]. This allows controlling which spans and events are recorded by
+various layers individually, rather than globally.
+
+In addition, it adds a new [`Targets`] filter, which provides a lighter-weight
+version of the filtering provided by [`EnvFilter`], as well as other smaller API
+improvements and fixes.
+
+### Deprecated
+
+- **registry**: `SpanRef::parent_id`, which cannot properly support per-layer
+ filtering. Use `.parent().map(SpanRef::id)` instead. ([#1523])
+
+### Fixed
+
+- **layer** `Context` methods that are provided when the `Subscriber` implements
+ `LookupSpan` no longer require the "registry" feature flag ([#1525])
+- **layer** `fmt::Debug` implementation for `Layered` no longer requires the `S`
+ type parameter to implement `Debug` ([#1528])
+
+### Added
+
+- **registry**: `Filter` trait, `Filtered` type, `Layer::with_filter` method,
+ and other APIs for per-layer filtering ([#1523])
+- **filter**: `FilterFn` and `DynFilterFn` types that implement global (`Layer`)
+ and per-layer (`Filter`) filtering for closures and function pointers
+ ([#1523])
+- **filter**: `Targets` filter, which implements a lighter-weight form of
+ `EnvFilter`-like filtering ([#1550])
+- **env-filter**: Added support for filtering on floating-point values ([#1507])
+- **layer**: `Layer::on_layer` callback, called when layering the `Layer` onto a
+`Subscriber` ([#1523])
+- **layer**: `Layer` implementations for `Box<L>` and `Arc<L>` where `L: Layer`
+ ([#1536])
+- **layer**: `Layer` implementations for `Box<dyn Layer<S> + Send + Sync + 'static>`
+ and `Arc<dyn Layer<S> + Send + Sync + 'static>` ([#1536])
+- A number of small documentation fixes and improvements ([#1553], [#1544],
+ [#1539], [#1524])
+
+Special thanks to new contributors @jsgf and @maxburke for contributing to this
+release!
+
+[`Filter`]: https://docs.rs/tracing-subscriber/0.2.21/tracing_subscriber/layer/trait.Filter.html
+[plf]: https://docs.rs/tracing-subscriber/0.2.21/tracing_subscriber/layer/index.html#per-layer-filtering
+[`Targets`]: https://docs.rs/tracing-subscriber/0.2.21/tracing_subscriber/filter/struct.Targets.html
+[`EnvFilter`]: https://docs.rs/tracing-subscriber/0.2.21/tracing_subscriber/filter/struct.EnvFilter.html
+[#1507]: https://github.com/tokio-rs/tracing/pull/1507
+[#1523]: https://github.com/tokio-rs/tracing/pull/1523
+[#1524]: https://github.com/tokio-rs/tracing/pull/1524
+[#1525]: https://github.com/tokio-rs/tracing/pull/1525
+[#1528]: https://github.com/tokio-rs/tracing/pull/1528
+[#1539]: https://github.com/tokio-rs/tracing/pull/1539
+[#1544]: https://github.com/tokio-rs/tracing/pull/1544
+[#1550]: https://github.com/tokio-rs/tracing/pull/1550
+[#1553]: https://github.com/tokio-rs/tracing/pull/1553
+
+# 0.2.20 (August 17, 2021)
+
+### Fixed
+
+- **fmt**: Fixed `fmt` printing only the first `source` for errors with a chain
+ of sources ([#1460])
+- **fmt**: Fixed missing space between level and event in the `Pretty` formatter
+ ([#1498])
+- **json**: Fixed `Json` formatter not honoring `without_time` and `with_level`
+ configurations ([#1463])
+
+### Added
+
+- **registry**: Improved panic message when cloning a span whose ID doesn't
+ exist, to aid in debugging issues with multiple subscribers ([#1483])
+- **registry**: Improved documentation on span ID generation ([#1453])
+
+[#1460]: https://github.com/tokio-rs/tracing/pull/1460
+[#1483]: https://github.com/tokio-rs/tracing/pull/1483
+[#1463]: https://github.com/tokio-rs/tracing/pull/1463
+[#1453]: https://github.com/tokio-rs/tracing/pull/1453
+[#1498]: https://github.com/tokio-rs/tracing/pull/1498
+
+Thanks to new contributors @joshtriplett and @lerouxrgd, and returning
+contributor @teozkr, for contributing to this release!
+
+# 0.2.19 (June 25, 2021)
+
+### Deprecated
+
+- **registry**: `SpanRef::parents`, `SpanRef::from_root`, and `Context::scope`
+ iterators, which are replaced by new `SpanRef::scope` and `Scope::from_root`
+ iterators ([#1413])
+
+### Added
+
+- **registry**: `SpanRef::scope` method, which returns a leaf-to-root `Iterator`
+ including the leaf span ([#1413])
+- **registry**: `Scope::from_root` method, which reverses the `scope` iterator
+ to iterate root-to-leaf ([#1413])
+- **registry**: `Context::event_span` method, which looks up the parent span of
+ an event ([#1434])
+- **registry**: `Context::event_scope` method, returning a `Scope` iterator over
+ the span scope of an event ([#1434])
+- **fmt**: `MakeWriter::make_writer_for` method, which allows returning a
+ different writer based on a span or event's metadata ([#1141])
+- **fmt**: `MakeWriterExt` trait, with `with_max_level`, `with_min_level`,
+ `with_filter`, `and`, and `or_else` combinators ([#1274])
+- **fmt**: `MakeWriter` implementation for `Arc<W> where &W: io::Write`
+ ([#1274])
+
+Thanks to @teozkr and @Folyd for contributing to this release!
+
+[#1413]: https://github.com/tokio-rs/tracing/pull/1413
+[#1434]: https://github.com/tokio-rs/tracing/pull/1434
+[#1141]: https://github.com/tokio-rs/tracing/pull/1141
+[#1274]: https://github.com/tokio-rs/tracing/pull/1274
+
+# 0.2.18 (April 30, 2021)
+
+### Deprecated
+
+- Deprecated the `CurrentSpan` type, which is inefficient and largely superseded
+ by the `registry` API ([#1321])
+
+### Fixed
+
+- **json**: Invalid JSON emitted for events in spans with no fields ([#1333])
+- **json**: Missing span data for synthesized new span, exit, and close events
+ ([#1334])
+- **fmt**: Extra space before log lines when timestamps are disabled ([#1355])
+
+### Added
+
+- **env-filter**: Support for filters on spans whose names contain any
+ characters other than `{` and `]` ([#1368])
+
+Thanks to @Folyd, and new contributors @akinnane and @aym-v for contributing to
+this release!
+
+[#1321]: https://github.com/tokio-rs/tracing/pull/1321
+[#1333]: https://github.com/tokio-rs/tracing/pull/1333
+[#1334]: https://github.com/tokio-rs/tracing/pull/1334
+[#1355]: https://github.com/tokio-rs/tracing/pull/1355
+[#1368]: https://github.com/tokio-rs/tracing/pull/1368
+
+# 0.2.17 (March 12, 2021)
+
+### Fixed
+
+- **fmt**: `Pretty` formatter now honors `with_ansi(false)` to disable ANSI
+ terminal formatting ([#1240])
+- **fmt**: Fixed extra padding when using `Pretty` formatter ([#1275])
+- **chrono**: Removed extra trailing space with `ChronoLocal` time formatter
+ ([#1103])
+
+### Added
+
+- **fmt**: Added `FmtContext::current_span()` method, returning the current span
+ ([#1290])
+- **fmt**: `FmtSpan` variants may now be combined using the `|` operator for
+ more granular control over what span events are generated ([#1277])
+
+Thanks to new contributors @cratelyn, @dignati, and @zicklag, as well as @Folyd,
+@matklad, and @najamelan, for contributing to this release!
+
+[#1240]: https://github.com/tokio-rs/tracing/pull/1240
+[#1275]: https://github.com/tokio-rs/tracing/pull/1275
+[#1103]: https://github.com/tokio-rs/tracing/pull/1103
+[#1290]: https://github.com/tokio-rs/tracing/pull/1290
+[#1277]: https://github.com/tokio-rs/tracing/pull/1277
+
+# 0.2.16 (February 19, 2021)
+
+### Fixed
+
+- **env-filter**: Fixed directives where the level is in mixed case (such as
+ `Info`) failing to parse ([#1126])
+- **fmt**: Fixed `fmt::Subscriber` not providing a max-level hint ([#1251])
+- `tracing-subscriber` no longer enables `tracing` and `tracing-core`'s default
+ features ([#1144])
+
+### Changed
+
+- **chrono**: Updated `chrono` dependency to 0.4.16 ([#1189])
+- **log**: Updated `tracing-log` dependency to 0.1.2
+
+Thanks to @salewski, @taiki-e, @davidpdrsn and @markdingram for contributing to
+this release!
+
+[#1126]: https://github.com/tokio-rs/tracing/pull/1126
+[#1251]: https://github.com/tokio-rs/tracing/pull/1251
+[#1144]: https://github.com/tokio-rs/tracing/pull/1144
+[#1189]: https://github.com/tokio-rs/tracing/pull/1189
+
+# 0.2.15 (November 2, 2020)
+
+### Fixed
+
+- **fmt**: Fixed wrong lifetime parameters on `FormatFields` impl for
+ `FmtContext` ([#1082])
+
+### Added
+
+- **fmt**: `format::Pretty`, an aesthetically pleasing, human-readable event
+ formatter for local development and user-facing CLIs ([#1080])
+- **fmt**: `FmtContext::field_format`, which returns the subscriber's field
+ formatter ([#1082])
+
+[#1082]: https://github.com/tokio-rs/tracing/pull/1082
+[#1080]: https://github.com/tokio-rs/tracing/pull/1080
+
+# 0.2.14 (October 22, 2020)
+
+### Fixed
+
+- **registry**: Fixed `Registry::new` allocating an excessively large amount of
+ memory, most of which would never be used ([#1064])
+
+### Changed
+
+- **registry**: Improved `new_span` performance by reusing `HashMap` allocations
+ for `Extensions` ([#1064])
+- **registry**: Significantly improved the performance of `Registry::enter` and
+ `Registry::exit` ([#1058])
+
+[#1064]: https://github.com/tokio-rs/tracing/pull/1064
+[#1058]: https://github.com/tokio-rs/tracing/pull/1058
+
+# 0.2.13 (October 7, 2020)
+
+### Changed
+
+- Updated `tracing-core` to 0.1.17 ([#992])
+
+### Added
+
+- **env-filter**: Added support for filtering on targets which contain dashes
+ ([#1014])
+- **env-filter**: Added a warning when creating an `EnvFilter` that contains
+ directives that would enable a level disabled by the `tracing` crate's
+ `static_max_level` features ([#1021])
+
+Thanks to @jyn514 and @bkchr for contributing to this release!
+
+[#992]: https://github.com/tokio-rs/tracing/pull/992
+[#1014]: https://github.com/tokio-rs/tracing/pull/1014
+[#1021]: https://github.com/tokio-rs/tracing/pull/1021
+
+# 0.2.12 (September 11, 2020)
+
+### Fixed
+
+- **env-filter**: Fixed a regression where `Option<Level>` lost its
+ `Into<LevelFilter>` impl ([#966])
+- **env-filter**: Fixed `EnvFilter` enabling spans that should not be enabled
+ when multiple subscribers are in use ([#927])
+
+### Changed
+
+- **json**: `format::Json` now outputs fields in a more readable order ([#892])
+- Updated `tracing-core` dependency to 0.1.16
+
+### Added
+
+- **fmt**: Add `BoxMakeWriter` for erasing the type of a `MakeWriter`
+ implementation ([#958])
+- **fmt**: Add `TestWriter` `MakeWriter` implementation to support libtest
+ output capturing ([#938])
+- **layer**: Add `Layer` impl for `Option<T> where T: Layer` ([#910])
+- **env-filter**: Add `From<Level>` impl for `Directive` ([#918])
+- Multiple documentation fixes and improvements
+
+Thanks to @Pothulapati, @samrg472, @bryanburgers, @keetonian, and @SriRamanujam
+for contributing to this release!
+
+[#927]: https://github.com/tokio-rs/tracing/pull/927
+[#966]: https://github.com/tokio-rs/tracing/pull/966
+[#958]: https://github.com/tokio-rs/tracing/pull/958
+[#892]: https://github.com/tokio-rs/tracing/pull/892
+[#938]: https://github.com/tokio-rs/tracing/pull/938
+[#910]: https://github.com/tokio-rs/tracing/pull/910
+[#918]: https://github.com/tokio-rs/tracing/pull/918
+
+# 0.2.11 (August 10, 2020)
+
+### Fixed
+
+- **env-filter**: Incorrect max level hint when filters involving span field
+ values are in use (#907)
+- **registry**: Fixed inconsistent span stacks when multiple registries are in
+ use on the same thread (#901)
+
+### Changed
+
+- **env-filter**: `regex` dependency enables fewer unused feature flags (#899)
+
+Thanks to @bdonlan and @jeromegn for contributing to this release!
+
+# 0.2.10 (July 31, 2020)
+
+### Fixed
+
+- **docs**: Incorrect formatting (#862)
+
+### Changed
+
+- **filter**: `LevelFilter` is now a re-export of the
+ `tracing_core::LevelFilter` type, it can now be used interchangably with the
+ versions in `tracing` and `tracing-core` (#853)
+- **filter**: Significant performance improvements when comparing `LevelFilter`s
+ and `Level`s (#853)
+- Updated the minimum `tracing-core` dependency to 0.1.12 (#853)
+
+### Added
+
+- **filter**: `LevelFilter` and `EnvFilter` now participate in `tracing-core`'s
+ max level hinting, improving performance significantly in some use cases where
+ levels are disabled globally (#853)
+
+# 0.2.9 (July 23, 2020)
+
+### Fixed
+
+- **fmt**: Fixed compilation failure on MSRV when the `chrono` feature is
+ disabled (#844)
+
+### Added
+
+- **fmt**: Span lookup methods defined by `layer::Context` are now also provided
+ by `FmtContext` (#834)
+
+# 0.2.8 (July 17, 2020)
+
+### Changed
+
+- **fmt**: When the `chrono` dependency is enabled, the `SystemTime` timestamp
+ formatter now emits human-readable timestamps rather than using `SystemTime`'s
+ `fmt::Debug`implementation (`chrono` is still required for customized
+ timestamp formatting) (#807)
+- **ansi**: Updated `ansi_term` dependency to 0.12 (#816)
+
+### Added
+
+- **json**: `with_span_list` method to configure the JSON formatter to include a
+ list of all spans in the current trace in formatting events (similarly to the
+ text formatter) (#741)
+- **json**: `with_current_span` method to configure the JSON formatter to include
+ a field for the _current_ span (the leaf of the trace) in formatted events
+ (#741)
+- **fmt**: `with_thread_names` and `with_thread_ids` methods to configure
+ `fmt::Subscriber`s and `fmt::Layer`s to include the thread name and/or thread ID
+ of the current thread when formatting events (#818)
+
+Thanks to new contributors @mockersf, @keetonian, and @Pothulapati for
+contributing to this release!
+
+# 0.2.7 (July 1, 2020)
+
+### Changed
+
+- **parking_lot**: Updated the optional `parking_lot` dependency to accept the
+ latest `parking_lot` version (#774)
+
+### Fixed
+
+- **fmt**: Fixed events with explicitly overridden parent spans being formatted
+ as though they were children of the current span (#767)
+
+### Added
+
+- **fmt**: Added the option to print synthesized events when spans are created,
+ entered, exited, and closed, including span durations (#761)
+- Documentation clarification and improvement (#762, #769)
+
+Thanks to @rkuhn, @greenwoodcm, and @Ralith for contributing to this release!
+
+# 0.2.6 (June 19, 2020)
+
+### Fixed
+
+- **fmt**: Fixed an issue in the JSON formatter where using `Span::record` would
+ result in malformed spans (#709)
+
+# 0.2.5 (April 21, 2020)
+
+### Changed
+
+- **fmt**: Bump sharded-slab dependency (#679)
+
+### Fixed
+
+- **fmt**: remove trailing space in `ChronoUtc` `format_time` (#677)
+
+# 0.2.4 (April 6, 2020)
+
+This release includes several API ergonomics improvements, including shorthand
+constructors for many types, and an extension trait for initializing subscribers
+using method-chaining style. Additionally, several bugs in less commonly used
+`fmt` APIs were fixed.
+
+### Added
+
+- **fmt**: Shorthand free functions for constructing most types in `fmt`
+ (including `tracing_subscriber::fmt()` to return a `SubscriberBuilder`,
+ `tracing_subscriber::fmt::layer()` to return a format `Layer`, etc) (#660)
+- **registry**: Shorthand free function `tracing_subscriber::registry()` to
+ construct a new registry (#660)
+- Added `SubscriberInitExt` extension trait for more ergonomic subscriber
+ initialization (#660)
+
+### Changed
+
+- **fmt**: Moved `LayerBuilder` methods to `Layer` (#655)
+
+### Deprecated
+
+- **fmt**: `LayerBuilder`, as `Layer` now implements all builder methods (#655)
+
+### Fixed
+
+- **fmt**: Fixed `Compact` formatter not omitting levels with
+ `with_level(false)` (#657)
+- **fmt**: Fixed `fmt::Layer` duplicating the fields for a new span if another
+ layer has already formatted its fields (#634)
+- **fmt**: Added missing space when using `record` to add new fields to a span
+ that already has fields (#659)
+- Updated outdated documentation (#647)
+
+
+# 0.2.3 (March 5, 2020)
+
+### Fixed
+
+- **env-filter**: Regression where filter directives were selected in the order
+ they were listed, rather than most specific first (#624)
+
+# 0.2.2 (February 27, 2020)
+
+### Added
+
+- **fmt**: Added `flatten_event` to `SubscriberBuilder` (#599)
+- **fmt**: Added `with_level` to `SubscriberBuilder` (#594)
+
+# 0.2.1 (February 13, 2020)
+
+### Changed
+
+- **filter**: `EnvFilter` directive selection now behaves correctly (i.e. like
+ `env_logger`) (#583)
+
+### Fixed
+
+- **filter**: Fixed `EnvFilter` incorrectly allowing less-specific filter
+ directives to enable events that are disabled by more-specific filters (#583)
+- **filter**: Multiple significant `EnvFilter` performance improvements,
+ especially when filtering events generated by `log` records (#578, #583)
+- **filter**: Replaced `BTreeMap` with `Vec` in `DirectiveSet`, improving
+ iteration performance significantly with typical numbers of filter directives
+ (#580)
+
+A big thank-you to @samschlegel for lots of help with `EnvFilter` performance
+tuning in this release!
+
+# 0.2.0 (February 4, 2020)
+
+### Breaking Changes
+
+- **fmt**: Renamed `Context` to `FmtContext` (#420, #425)
+- **fmt**: Renamed `Builder` to `SubscriberBuilder` (#420)
+- **filter**: Removed `Filter`. Use `EnvFilter` instead (#434)
+
+### Added
+
+- **registry**: `Registry`, a `Subscriber` implementation that `Layer`s can use
+ as a high-performance, in-memory span store. (#420, #425, #432, #433, #435)
+- **registry**: Added `LookupSpan` trait, implemented by `Subscriber`s to expose
+ stored span data to `Layer`s (#420)
+- **fmt**: Added `fmt::Layer`, to allow composing log formatting with other `Layer`s
+- **fmt**: Added support for JSON field and event formatting (#377, #415)
+- **filter**: Documentation for filtering directives (#554)
+
+### Changed
+
+- **fmt**: Renamed `Context` to `FmtContext` (#420, #425) (BREAKING)
+- **fmt**: Renamed `Builder` to `SubscriberBuilder` (#420) (BREAKING)
+- **fmt**: Reimplemented `fmt::Subscriber` in terms of the `Registry`
+ and `Layer`s (#420)
+
+### Removed
+
+- **filter**: Removed `Filter`. Use `EnvFilter` instead (#434) (BREAKING)
+
+### Fixed
+
+- **fmt**: Fixed memory leaks in the slab used to store per-span data
+ (3c35048)
+- **fmt**: `fmt::SubscriberBuilder::init` not setting up `log` compatibility
+ (#489)
+- **fmt**: Spans closed by a child span closing not also closing _their_
+ parents (#514)
+- **Layer**: Fixed `Layered` subscribers failing to downcast to their own type
+ (#549)
+- **Layer**: Fixed `Layer::downcast_ref` returning invalid references (#454)
+
+# 0.2.0-alpha.6 (February 3, 2020)
+
+### Fixed
+
+- **fmt**: Fixed empty `{}` printed after spans with no fields (f079f2d)
+- **fmt**: Fixed inconsistent formatting when ANSI colors are disabled (506a482)
+- **fmt**: Fixed mis-aligned levels when ANSI colors are disabled (eba1adb)
+- Fixed warnings on nightly Rust compilers (#558)
+
+# 0.2.0-alpha.5 (January 31, 2020)
+
+### Added
+
+- **env_filter**: Documentation for filtering directives (#554)
+- **registry**, **env_filter**: Updated `smallvec` dependency to 0.1 (#543)
+
+### Fixed
+
+- **registry**: Fixed a memory leak in the slab used to store per-span data
+ (3c35048)
+- **Layer**: Fixed `Layered` subscribers failing to downcast to their own type
+ (#549)
+- **fmt**: Fixed a panic when multiple layers insert `FormattedFields`
+ extensions from the same formatter type (1c3bb70)
+- **fmt**: Fixed `fmt::Layer::on_record` inserting a new `FormattedFields` when
+ formatted fields for a span already exist (1c3bb70)
+
+# 0.2.0-alpha.4 (January 11, 2020)
+
+### Fixed
+
+- **registry**: Removed inadvertently committed `dbg!` macros (#533)
+
+# 0.2.0-alpha.3 (January 10, 2020)
+
+### Added
+
+- **fmt**: Public `FormattedFields::new` constructor (#478)
+- **fmt**: Added examples to `fmt::Layer` documentation (#510)
+- Documentation now shows what feature flags are required by each API item (#525)
+
+### Fixed
+
+- **fmt**: Missing space between timestamp and level (#480)
+- **fmt**: Incorrect formatting with `with_target(false)` (#481)
+- **fmt**: `fmt::SubscriberBuilder::init` not setting up `log` compatibility
+ (#489)
+- **registry**: Spans exited out of order not being closed properly on exit
+ (#509)
+- **registry**: Memory leak when spans are closed by a child span closing (#514)
+- **registry**: Spans closed by a child span closing not also closing _their_
+ parents (#514)
+- Compilation errors with `no-default-features` (#499, #500)
+
+# 0.2.0-alpha.2 (December 8, 2019)
+
+### Added
+
+- `LookupSpans` implementation for `Layered` (#448)
+- `SpanRef::from_root` to iterate over a span's parents from the root (#460)
+- `Context::scope`, to iterate over the current context from the root (#460)
+- `Context::lookup_current`, which returns a `SpanRef` to the current
+ span's data (#460)
+
+### Changed
+
+- Lifetimes on some new `Context` methods to be less restrictive (#460)
+
+### Fixed
+
+- `Layer::downcast_ref` returning invalid references (#454)
+- Compilation failure on 32-bit platforms (#462)
+- Compilation failure with ANSI formatters (#438)
+
+# 0.2.0-alpha.1 (November 18, 2019)
+
+### Added
+
+- `Registry`, a reusable span store that `Layer`s can use a
+ high-performance, in-memory store. (#420, #425, #432, #433, #435)
+- Reimplemented `fmt::Subscriber` in terms of the `Registry`
+ and `Layer`s (#420)
+- Add benchmarks for fmt subscriber (#421)
+- Add support for JSON field and event formatting (#377, #415)
+
+### Changed
+
+- **BREAKING**: Change `fmt::format::FormatFields` and
+ `fmt::format::FormatEvent` to accept a mandatory `FmtContext`. These
+ `FormatFields` and `FormatEvent` will likely see additional breaking
+ changes in subsequent alpha. (#420, #425)
+- **BREAKING**: Removed `Filter`. Use `EnvFilter` instead (#434)
+
+### Contributers
+
+Thanks to all the contributers to this release!
+
+- @pimeys for #377 and #415
+
+# 0.1.6 (October 29, 2019)
+
+### Added
+
+- Add `init` and `try_init` functions to `FmtSubscriber` (#385)
+- Add `ChronoUtc` and `ChronoLocal` timers, RFC 3339 support (#387)
+- Add `tracing::subscriber::set_default` which sets the default
+ subscriber and returns a drop guard. This drop guard will reset the
+ dispatch on drop (#388).
+
+### Fixed
+
+- Fix default level for `EnvFilter`. Setting `RUST_LOG=target`
+ previously only the `ERROR` level, while it should enable everything.
+ `tracing-subscriber` now defaults to `TRACE` if no level is specified
+ (#401)
+- Fix `tracing-log` feature flag for init + try_init. The feature flag
+ `tracing_log` was used instead of the correct `tracing-log`. As a
+ result, both `tracing-log` and `tracing_log` needed to be specified in
+ order to initialize the global logger. Only `tracing-log` needs to be
+ specified now (#400).
+
+### Contributers
+
+Thanks to all the contributers to this release!
+
+- @emschwartz for #385, #387, #400 and #401
+- @bIgBV for #388
+
+# 0.1.5 (October 7, 2019)
+
+### Fixed
+
+- Spans not being closed properly when `FmtSubscriber::current_span` is used
+ (#371)
+
+# 0.1.4 (September 26, 2019)
+
+### Fixed
+
+- Spans entered twice on the same thread sometimes being completely exited when
+ the more deeply-nested entry is exited (#361)
+- Setting `with_ansi(false)` on `FmtSubscriber` not disabling ANSI color
+ formatting for timestamps (#354)
+- Incorrect reference counting in `FmtSubscriber` that could cause spans to not
+ be closed when all references are dropped (#366)
+
+# 0.1.3 (September 16, 2019)
+
+### Fixed
+
+- `Layered` subscribers not properly forwarding calls to `current_span`
+ (#350)
+
+# 0.1.2 (September 12, 2019)
+
+### Fixed
+
+- `EnvFilter` ignoring directives with targets that are the same number of
+ characters (#333)
+- `EnvFilter` failing to properly apply filter directives to events generated
+ from `log` records by`tracing-log` (#344)
+
+### Changed
+
+- Renamed `Filter` to `EnvFilter`, deprecated `Filter` (#339)
+- Renamed "filter" feature flag to "env-filter", deprecated "filter" (#339)
+- `FmtSubscriber` now defaults to enabling only the `INFO` level and above when
+ a max level filter or `EnvFilter` is not set (#336)
+- Made `parking_lot` dependency an opt-in feature flag (#348)
+
+### Added
+
+- `EnvFilter::add_directive` to add new directives to filters after they are
+ constructed (#334)
+- `fmt::Builder::with_max_level` to set a global level filter for a
+ `FmtSubscriber` without requiring the use of `EnvFilter` (#336)
+- `Layer` implementation for `LevelFilter` (#336)
+- `EnvFilter` now implements `fmt::Display` (#329)
+
+### Removed
+
+- Removed dependency on `crossbeam-util` (#348)
+
+# 0.1.1 (September 4, 2019)
+
+### Fixed
+
+- Potential double panic in `CurrentSpan` (#325)
+
+# 0.1.0 (September 3, 2019)
+
+- Initial release
diff --git a/crates/tracing-subscriber/Cargo.toml b/crates/tracing-subscriber/Cargo.toml
new file mode 100644
index 0000000..c20d5ba
--- /dev/null
+++ b/crates/tracing-subscriber/Cargo.toml
@@ -0,0 +1,246 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.63.0"
+name = "tracing-subscriber"
+version = "0.3.18"
+authors = [
+ "Eliza Weisman <[email protected]>",
+ "David Barsky <[email protected]>",
+ "Tokio Contributors <[email protected]>",
+]
+description = """
+Utilities for implementing and composing `tracing` subscribers.
+"""
+homepage = "https://tokio.rs"
+readme = "README.md"
+keywords = [
+ "logging",
+ "tracing",
+ "metrics",
+ "subscriber",
+]
+categories = [
+ "development-tools::debugging",
+ "development-tools::profiling",
+ "asynchronous",
+]
+license = "MIT"
+repository = "https://github.com/tokio-rs/tracing"
+resolver = "2"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+]
+
+[[bench]]
+name = "filter"
+harness = false
+
+[[bench]]
+name = "filter_log"
+harness = false
+
+[[bench]]
+name = "fmt"
+harness = false
+
+[[bench]]
+name = "enter"
+harness = false
+
+[dependencies.chrono]
+version = "0.4.26"
+features = [
+ "clock",
+ "std",
+]
+optional = true
+default-features = false
+
+[dependencies.matchers]
+version = "0.1.0"
+optional = true
+
+[dependencies.nu-ansi-term]
+version = "0.46.0"
+optional = true
+
+[dependencies.once_cell]
+version = "1.13.0"
+optional = true
+
+[dependencies.parking_lot]
+version = "0.12.1"
+optional = true
+
+[dependencies.regex]
+version = "1.6.0"
+features = [
+ "std",
+ "unicode-case",
+ "unicode-perl",
+]
+optional = true
+default-features = false
+
+[dependencies.serde]
+version = "1.0.140"
+optional = true
+
+[dependencies.serde_json]
+version = "1.0.82"
+optional = true
+
+[dependencies.sharded-slab]
+version = "0.1.4"
+optional = true
+
+[dependencies.smallvec]
+version = "1.9.0"
+optional = true
+
+[dependencies.thread_local]
+version = "1.1.4"
+optional = true
+
+[dependencies.time]
+version = "0.3.2"
+features = ["formatting"]
+optional = true
+
+[dependencies.tracing]
+version = "0.1.35"
+optional = true
+default-features = false
+
+[dependencies.tracing-core]
+version = "0.1.30"
+default-features = false
+
+[dependencies.tracing-log]
+version = "0.2.0"
+features = [
+ "log-tracer",
+ "std",
+]
+optional = true
+default-features = false
+
+[dependencies.tracing-serde]
+version = "0.1.3"
+optional = true
+
+[dev-dependencies.criterion]
+version = "0.3.6"
+default-features = false
+
+[dev-dependencies.log]
+version = "0.4.17"
+
+[dev-dependencies.regex]
+version = "1"
+features = ["std"]
+default-features = false
+
+[dev-dependencies.time]
+version = "0.3.2"
+features = [
+ "formatting",
+ "macros",
+]
+
+[dev-dependencies.tokio]
+version = "1"
+features = [
+ "rt",
+ "macros",
+]
+
+[dev-dependencies.tracing]
+version = "0.1.35"
+
+[dev-dependencies.tracing-futures]
+version = "0.2.0"
+features = [
+ "std-future",
+ "std",
+]
+default-features = false
+
+[dev-dependencies.tracing-log]
+version = "0.2.0"
+
+[features]
+alloc = []
+ansi = [
+ "fmt",
+ "nu-ansi-term",
+]
+default = [
+ "smallvec",
+ "fmt",
+ "ansi",
+ "tracing-log",
+ "std",
+]
+env-filter = [
+ "matchers",
+ "regex",
+ "once_cell",
+ "tracing",
+ "std",
+ "thread_local",
+]
+fmt = [
+ "registry",
+ "std",
+]
+json = [
+ "tracing-serde",
+ "serde",
+ "serde_json",
+]
+local-time = ["time/local-offset"]
+registry = [
+ "sharded-slab",
+ "thread_local",
+ "std",
+]
+std = [
+ "alloc",
+ "tracing-core/std",
+]
+valuable = [
+ "tracing-core/valuable",
+ "valuable_crate",
+ "valuable-serde",
+ "tracing-serde/valuable",
+]
+
+[target."cfg(tracing_unstable)".dependencies.valuable-serde]
+version = "0.1.0"
+optional = true
+default-features = false
+
+[target."cfg(tracing_unstable)".dependencies.valuable_crate]
+version = "0.1.0"
+optional = true
+default-features = false
+package = "valuable"
+
+[badges.maintenance]
+status = "experimental"
diff --git a/crates/tracing-subscriber/LICENSE b/crates/tracing-subscriber/LICENSE
new file mode 100644
index 0000000..cdb28b4
--- /dev/null
+++ b/crates/tracing-subscriber/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tokio Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tracing-subscriber/METADATA b/crates/tracing-subscriber/METADATA
new file mode 100644
index 0000000..bf11a20
--- /dev/null
+++ b/crates/tracing-subscriber/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/tracing-subscriber
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tracing-subscriber"
+description: "()"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 6
+ }
+ homepage: "https://crates.io/crates/tracing-subscriber"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tracing-subscriber/tracing-subscriber-0.3.18.crate"
+ version: "0.3.18"
+ }
+}
diff --git a/crates/tracing-subscriber/MODULE_LICENSE_MIT b/crates/tracing-subscriber/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tracing-subscriber/MODULE_LICENSE_MIT
diff --git a/crates/tracing-subscriber/README.md b/crates/tracing-subscriber/README.md
new file mode 100644
index 0000000..cc5426d
--- /dev/null
+++ b/crates/tracing-subscriber/README.md
@@ -0,0 +1,61 @@
+![Tracing — Structured, application-level diagnostics][splash]
+
+[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg
+
+# tracing-subscriber
+
+Utilities for implementing and composing [`tracing`][tracing] subscribers.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+![maintenance status][maint-badge]
+
+[Documentation][docs-url] | [Chat][discord-url]
+
+[tracing]: https://github.com/tokio-rs/tracing/tree/master/tracing
+[tracing-fmt]: https://github.com/tokio-rs/tracing/tree/master/tracing-subscriber
+[crates-badge]: https://img.shields.io/crates/v/tracing-subscriber.svg
+[crates-url]: https://crates.io/crates/tracing-subscriber
+[docs-badge]: https://docs.rs/tracing-subscriber/badge.svg
+[docs-url]: https://docs.rs/tracing-subscriber/latest
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tracing-rs.netlify.com/tracing_subscriber
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
+[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+[maint-badge]: https://img.shields.io/badge/maintenance-experimental-blue.svg
+
+*Compiler support: [requires `rustc` 1.63+][msrv]*
+
+[msrv]: #supported-rust-versions
+
+## Supported Rust Versions
+
+Tracing is built against the latest stable release. The minimum supported
+version is 1.63. The current Tracing version is not guaranteed to build on Rust
+versions earlier than the minimum supported version.
+
+Tracing follows the same compiler support policies as the rest of the Tokio
+project. The current stable Rust compiler and the three most recent minor
+versions before it will always be supported. For example, if the current stable
+compiler version is 1.69, the minimum supported version will not be increased
+past 1.66, three minor versions prior. Increasing the minimum supported compiler
+version is not considered a semver breaking change as long as doing so complies
+with this policy.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tracing by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tracing-subscriber/benches/enter.rs b/crates/tracing-subscriber/benches/enter.rs
new file mode 100644
index 0000000..49c6e73
--- /dev/null
+++ b/crates/tracing-subscriber/benches/enter.rs
@@ -0,0 +1,64 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tracing_subscriber::prelude::*;
+
+fn enter(c: &mut Criterion) {
+ let mut group = c.benchmark_group("enter");
+ let _subscriber = tracing_subscriber::fmt()
+ .with_max_level(tracing::Level::INFO)
+ .finish()
+ .set_default();
+ group.bench_function("enabled", |b| {
+ let span = tracing::info_span!("foo");
+ b.iter_with_large_drop(|| span.enter())
+ });
+ group.bench_function("disabled", |b| {
+ let span = tracing::debug_span!("foo");
+ b.iter_with_large_drop(|| span.enter())
+ });
+}
+
+fn enter_exit(c: &mut Criterion) {
+ let mut group = c.benchmark_group("enter_exit");
+ let _subscriber = tracing_subscriber::fmt()
+ .with_max_level(tracing::Level::INFO)
+ .finish()
+ .set_default();
+ group.bench_function("enabled", |b| {
+ let span = tracing::info_span!("foo");
+ b.iter(|| span.enter())
+ });
+ group.bench_function("disabled", |b| {
+ let span = tracing::debug_span!("foo");
+ b.iter(|| span.enter())
+ });
+}
+
+fn enter_many(c: &mut Criterion) {
+ let mut group = c.benchmark_group("enter_many");
+ let _subscriber = tracing_subscriber::fmt()
+ .with_max_level(tracing::Level::INFO)
+ .finish()
+ .set_default();
+ group.bench_function("enabled", |b| {
+ let span1 = tracing::info_span!("span1");
+ let _e1 = span1.enter();
+ let span2 = tracing::info_span!("span2");
+ let _e2 = span2.enter();
+ let span3 = tracing::info_span!("span3");
+ let _e3 = span3.enter();
+ let span = tracing::info_span!("foo");
+ b.iter_with_large_drop(|| span.enter())
+ });
+ group.bench_function("disabled", |b| {
+ let span1 = tracing::info_span!("span1");
+ let _e1 = span1.enter();
+ let span2 = tracing::info_span!("span2");
+ let _e2 = span2.enter();
+ let span3 = tracing::info_span!("span3");
+ let _e3 = span3.enter();
+ let span = tracing::debug_span!("foo");
+ b.iter_with_large_drop(|| span.enter())
+ });
+}
+criterion_group!(benches, enter, enter_exit, enter_many);
+criterion_main!(benches);
diff --git a/crates/tracing-subscriber/benches/filter.rs b/crates/tracing-subscriber/benches/filter.rs
new file mode 100644
index 0000000..91ab9c9
--- /dev/null
+++ b/crates/tracing-subscriber/benches/filter.rs
@@ -0,0 +1,308 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use std::time::Duration;
+use tracing::{dispatcher::Dispatch, span, Event, Id, Metadata};
+use tracing_subscriber::{prelude::*, EnvFilter};
+
+mod support;
+use support::MultithreadedBench;
+
+/// A subscriber that is enabled but otherwise does nothing.
+struct EnabledSubscriber;
+
+impl tracing::Subscriber for EnabledSubscriber {
+ fn new_span(&self, span: &span::Attributes<'_>) -> Id {
+ let _ = span;
+ Id::from_u64(0xDEAD_FACE)
+ }
+
+ fn event(&self, event: &Event<'_>) {
+ let _ = event;
+ }
+
+ fn record(&self, span: &Id, values: &span::Record<'_>) {
+ let _ = (span, values);
+ }
+
+ fn record_follows_from(&self, span: &Id, follows: &Id) {
+ let _ = (span, follows);
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ let _ = metadata;
+ true
+ }
+
+ fn enter(&self, span: &Id) {
+ let _ = span;
+ }
+
+ fn exit(&self, span: &Id) {
+ let _ = span;
+ }
+}
+
+fn bench_static(c: &mut Criterion) {
+ let mut group = c.benchmark_group("static");
+
+ group.bench_function("baseline_single_threaded", |b| {
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ tracing::debug!(target: "static_filter", "hi");
+ tracing::warn!(target: "static_filter", "hi");
+ tracing::trace!(target: "foo", "hi");
+ })
+ });
+ });
+ group.bench_function("single_threaded", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ tracing::debug!(target: "static_filter", "hi");
+ tracing::warn!(target: "static_filter", "hi");
+ tracing::trace!(target: "foo", "hi");
+ })
+ });
+ });
+ group.bench_function("enabled_one", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("enabled_many", |b| {
+ let filter = "foo=debug,bar=trace,baz=error,quux=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_level_one", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::debug!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_level_many", |b| {
+ let filter = "foo=debug,bar=info,baz=error,quux=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::trace!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_one", |b| {
+ let filter = "foo=info".parse::<EnvFilter>().expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_many", |b| {
+ let filter = "foo=debug,bar=trace,baz=error,quux=warn,whibble=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("baseline_multithreaded", |b| {
+ let dispatch = Dispatch::new(EnabledSubscriber);
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::debug!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::warn!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::warn!(target: "foo", "hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ group.bench_function("multithreaded", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ let dispatch = Dispatch::new(EnabledSubscriber.with(filter));
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::debug!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::warn!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ tracing::warn!(target: "foo", "hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ });
+ });
+ group.finish();
+}
+
+fn bench_dynamic(c: &mut Criterion) {
+ let mut group = c.benchmark_group("dynamic");
+
+ group.bench_function("baseline_single_threaded", |b| {
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ b.iter(|| {
+ tracing::info_span!("foo").in_scope(|| {
+ tracing::info!("hi");
+ tracing::debug!("hi");
+ });
+ tracing::info_span!("bar").in_scope(|| {
+ tracing::warn!("hi");
+ });
+ tracing::trace!("hi");
+ })
+ });
+ });
+ group.bench_function("single_threaded", |b| {
+ let filter = "[foo]=trace".parse::<EnvFilter>().expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info_span!("foo").in_scope(|| {
+ tracing::info!("hi");
+ tracing::debug!("hi");
+ });
+ tracing::info_span!("bar").in_scope(|| {
+ tracing::warn!("hi");
+ });
+ tracing::trace!("hi");
+ })
+ });
+ });
+ group.bench_function("baseline_multithreaded", |b| {
+ let dispatch = Dispatch::new(EnabledSubscriber);
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ tracing::info!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ tracing::debug!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("bar");
+ let _ = span.enter();
+ tracing::debug!("hi");
+ })
+ .thread(|| {
+ tracing::trace!("hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ group.bench_function("multithreaded", |b| {
+ let filter = "[foo]=trace".parse::<EnvFilter>().expect("should parse");
+ let dispatch = Dispatch::new(EnabledSubscriber.with(filter));
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ tracing::info!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ tracing::debug!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("bar");
+ let _ = span.enter();
+ tracing::debug!("hi");
+ })
+ .thread(|| {
+ tracing::trace!("hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+
+ group.finish();
+}
+
+fn bench_mixed(c: &mut Criterion) {
+ let mut group = c.benchmark_group("mixed");
+ group.bench_function("disabled", |b| {
+ let filter = "[foo]=trace,bar[quux]=debug,[{baz}]=debug,asdf=warn,wibble=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_by_level", |b| {
+ let filter = "[foo]=info,bar[quux]=debug,asdf=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::trace!(target: "static_filter", "hi");
+ })
+ });
+ });
+}
+
+criterion_group!(benches, bench_static, bench_dynamic, bench_mixed);
+criterion_main!(benches);
diff --git a/crates/tracing-subscriber/benches/filter_log.rs b/crates/tracing-subscriber/benches/filter_log.rs
new file mode 100644
index 0000000..4dcf3b4
--- /dev/null
+++ b/crates/tracing-subscriber/benches/filter_log.rs
@@ -0,0 +1,315 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use std::time::Duration;
+use tracing::{dispatcher::Dispatch, span, Event, Id, Metadata};
+use tracing_subscriber::{prelude::*, EnvFilter};
+
+mod support;
+use support::MultithreadedBench;
+
+/// A subscriber that is enabled but otherwise does nothing.
+struct EnabledSubscriber;
+
+impl tracing::Subscriber for EnabledSubscriber {
+ fn new_span(&self, span: &span::Attributes<'_>) -> Id {
+ let _ = span;
+ Id::from_u64(0xDEAD_FACE)
+ }
+
+ fn event(&self, event: &Event<'_>) {
+ let _ = event;
+ }
+
+ fn record(&self, span: &Id, values: &span::Record<'_>) {
+ let _ = (span, values);
+ }
+
+ fn record_follows_from(&self, span: &Id, follows: &Id) {
+ let _ = (span, follows);
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ let _ = metadata;
+ true
+ }
+
+ fn enter(&self, span: &Id) {
+ let _ = span;
+ }
+
+ fn exit(&self, span: &Id) {
+ let _ = span;
+ }
+}
+
+fn bench_static(c: &mut Criterion) {
+ let _ = tracing_log::LogTracer::init();
+
+ let mut group = c.benchmark_group("log/static");
+
+ group.bench_function("baseline_single_threaded", |b| {
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ log::debug!(target: "static_filter", "hi");
+ log::warn!(target: "static_filter", "hi");
+ log::trace!(target: "foo", "hi");
+ })
+ });
+ });
+ group.bench_function("single_threaded", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ log::debug!(target: "static_filter", "hi");
+ log::warn!(target: "static_filter", "hi");
+ log::trace!(target: "foo", "hi");
+ })
+ });
+ });
+ group.bench_function("enabled_one", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("enabled_many", |b| {
+ let filter = "foo=debug,bar=trace,baz=error,quux=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_level_one", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::debug!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_level_many", |b| {
+ let filter = "foo=debug,bar=info,baz=error,quux=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::trace!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_one", |b| {
+ let filter = "foo=info".parse::<EnvFilter>().expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_many", |b| {
+ let filter = "foo=debug,bar=trace,baz=error,quux=warn,whibble=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("baseline_multithreaded", |b| {
+ let dispatch = Dispatch::new(EnabledSubscriber);
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::debug!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::warn!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::warn!(target: "foo", "hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ group.bench_function("multithreaded", |b| {
+ let filter = "static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ let dispatch = Dispatch::new(EnabledSubscriber.with(filter));
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::debug!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::warn!(target: "static_filter", "hi");
+ })
+ .thread(|| {
+ log::warn!(target: "foo", "hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ });
+ });
+ group.finish();
+}
+
+fn bench_dynamic(c: &mut Criterion) {
+ let _ = tracing_log::LogTracer::init();
+
+ let mut group = c.benchmark_group("log/dynamic");
+
+ group.bench_function("baseline_single_threaded", |b| {
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ b.iter(|| {
+ tracing::info_span!("foo").in_scope(|| {
+ log::info!("hi");
+ log::debug!("hi");
+ });
+ tracing::info_span!("bar").in_scope(|| {
+ log::warn!("hi");
+ });
+ log::trace!("hi");
+ })
+ });
+ });
+ group.bench_function("single_threaded", |b| {
+ let filter = "[foo]=trace".parse::<EnvFilter>().expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ tracing::info_span!("foo").in_scope(|| {
+ log::info!("hi");
+ log::debug!("hi");
+ });
+ tracing::info_span!("bar").in_scope(|| {
+ log::warn!("hi");
+ });
+ log::trace!("hi");
+ })
+ });
+ });
+ group.bench_function("baseline_multithreaded", |b| {
+ let dispatch = Dispatch::new(EnabledSubscriber);
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ log::info!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ log::debug!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("bar");
+ let _ = span.enter();
+ log::debug!("hi");
+ })
+ .thread(|| {
+ log::trace!("hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ group.bench_function("multithreaded", |b| {
+ let filter = "[foo]=trace".parse::<EnvFilter>().expect("should parse");
+ let dispatch = Dispatch::new(EnabledSubscriber.with(filter));
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ log::info!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("foo");
+ let _ = span.enter();
+ log::debug!("hi");
+ })
+ .thread(|| {
+ let span = tracing::info_span!("bar");
+ let _ = span.enter();
+ log::debug!("hi");
+ })
+ .thread(|| {
+ log::trace!("hi");
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+
+ group.finish();
+}
+
+fn bench_mixed(c: &mut Criterion) {
+ let _ = tracing_log::LogTracer::init();
+
+ let mut group = c.benchmark_group("log/mixed");
+
+ group.bench_function("disabled", |b| {
+ let filter = "[foo]=trace,bar[quux]=debug,[{baz}]=debug,asdf=warn,wibble=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::info!(target: "static_filter", "hi");
+ })
+ });
+ });
+ group.bench_function("disabled_by_level", |b| {
+ let filter = "[foo]=info,bar[quux]=debug,asdf=warn,static_filter=info"
+ .parse::<EnvFilter>()
+ .expect("should parse");
+ tracing::subscriber::with_default(EnabledSubscriber.with(filter), || {
+ b.iter(|| {
+ log::trace!(target: "static_filter", "hi");
+ })
+ });
+ });
+}
+
+criterion_group!(benches, bench_static, bench_dynamic, bench_mixed);
+criterion_main!(benches);
diff --git a/crates/tracing-subscriber/benches/fmt.rs b/crates/tracing-subscriber/benches/fmt.rs
new file mode 100644
index 0000000..a039e66
--- /dev/null
+++ b/crates/tracing-subscriber/benches/fmt.rs
@@ -0,0 +1,331 @@
+use criterion::{criterion_group, criterion_main, BenchmarkId, Criterion, Throughput};
+use std::{io, time::Duration};
+
+mod support;
+use support::MultithreadedBench;
+
+/// A fake writer that doesn't actually do anything.
+///
+/// We want to measure the subscriber's overhead, *not* the performance of
+/// stdout/file writers. Using a no-op Write implementation lets us only measure
+/// the subscriber's overhead.
+struct NoWriter;
+
+impl io::Write for NoWriter {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ Ok(buf.len())
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+}
+
+impl NoWriter {
+ fn new() -> Self {
+ Self
+ }
+}
+
+fn bench_new_span(c: &mut Criterion) {
+ bench_thrpt(c, "new_span", |group, i| {
+ group.bench_with_input(BenchmarkId::new("single_thread", i), i, |b, &i| {
+ tracing::dispatcher::with_default(&mk_dispatch(), || {
+ b.iter(|| {
+ for n in 0..i {
+ let _span = tracing::info_span!("span", n);
+ }
+ })
+ });
+ });
+ group.bench_with_input(BenchmarkId::new("multithreaded", i), i, |b, &i| {
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ let dispatch = mk_dispatch();
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(move || {
+ for n in 0..i {
+ let _span = tracing::info_span!("span", n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ let _span = tracing::info_span!("span", n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ let _span = tracing::info_span!("span", n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ let _span = tracing::info_span!("span", n);
+ }
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ });
+}
+
+type Group<'a> = criterion::BenchmarkGroup<'a, criterion::measurement::WallTime>;
+fn bench_thrpt(c: &mut Criterion, name: &'static str, mut f: impl FnMut(&mut Group<'_>, &usize)) {
+ const N_SPANS: &[usize] = &[1, 10, 50];
+
+ let mut group = c.benchmark_group(name);
+ for spans in N_SPANS {
+ group.throughput(Throughput::Elements(*spans as u64));
+ f(&mut group, spans);
+ }
+ group.finish();
+}
+
+fn mk_dispatch() -> tracing::Dispatch {
+ let subscriber = tracing_subscriber::FmtSubscriber::builder()
+ .with_writer(NoWriter::new)
+ .finish();
+ tracing::Dispatch::new(subscriber)
+}
+
+fn bench_event(c: &mut Criterion) {
+ bench_thrpt(c, "event", |group, i| {
+ group.bench_with_input(BenchmarkId::new("root/single_threaded", i), i, |b, &i| {
+ let dispatch = mk_dispatch();
+ tracing::dispatcher::with_default(&dispatch, || {
+ b.iter(|| {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ });
+ });
+ group.bench_with_input(BenchmarkId::new("root/multithreaded", i), i, |b, &i| {
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ let dispatch = mk_dispatch();
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread(move || {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread(move || {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ });
+ group.bench_with_input(
+ BenchmarkId::new("unique_parent/single_threaded", i),
+ i,
+ |b, &i| {
+ tracing::dispatcher::with_default(&mk_dispatch(), || {
+ let span = tracing::info_span!("unique_parent", foo = false);
+ let _guard = span.enter();
+ b.iter(|| {
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ });
+ },
+ );
+ group.bench_with_input(
+ BenchmarkId::new("unique_parent/multithreaded", i),
+ i,
+ |b, &i| {
+ b.iter_custom(|iters| {
+ let mut total = Duration::from_secs(0);
+ let dispatch = mk_dispatch();
+ for _ in 0..iters {
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let elapsed = bench
+ .thread_with_setup(move |start| {
+ let span = tracing::info_span!("unique_parent", foo = false);
+ let _guard = span.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread_with_setup(move |start| {
+ let span = tracing::info_span!("unique_parent", foo = false);
+ let _guard = span.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread_with_setup(move |start| {
+ let span = tracing::info_span!("unique_parent", foo = false);
+ let _guard = span.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .thread_with_setup(move |start| {
+ let span = tracing::info_span!("unique_parent", foo = false);
+ let _guard = span.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ })
+ .run();
+ total += elapsed;
+ }
+ total
+ })
+ },
+ );
+ group.bench_with_input(
+ BenchmarkId::new("shared_parent/multithreaded", i),
+ i,
+ |b, &i| {
+ b.iter_custom(|iters| {
+ let dispatch = mk_dispatch();
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let parent = tracing::dispatcher::with_default(&dispatch, || {
+ tracing::info_span!("shared_parent", foo = "hello world")
+ });
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ for n in 0..i {
+ tracing::info!(n);
+ }
+ });
+ let elapsed = bench.run();
+ total += elapsed;
+ }
+ total
+ })
+ },
+ );
+ group.bench_with_input(
+ BenchmarkId::new("multi-parent/multithreaded", i),
+ i,
+ |b, &i| {
+ b.iter_custom(|iters| {
+ let dispatch = mk_dispatch();
+ let mut total = Duration::from_secs(0);
+ for _ in 0..iters {
+ let parent = tracing::dispatcher::with_default(&dispatch, || {
+ tracing::info_span!("multiparent", foo = "hello world")
+ });
+ let bench = MultithreadedBench::new(dispatch.clone());
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ let mut span = tracing::info_span!("parent");
+ for n in 0..i {
+ let s = tracing::info_span!(parent: &span, "parent2", n, i);
+ s.in_scope(|| {
+ tracing::info!(n);
+ });
+ span = s;
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ let mut span = tracing::info_span!("parent");
+ for n in 0..i {
+ let s = tracing::info_span!(parent: &span, "parent2", n, i);
+ s.in_scope(|| {
+ tracing::info!(n);
+ });
+ span = s;
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ let mut span = tracing::info_span!("parent");
+ for n in 0..i {
+ let s = tracing::info_span!(parent: &span, "parent2", n, i);
+ s.in_scope(|| {
+ tracing::info!(n);
+ });
+ span = s;
+ }
+ });
+ let parent2 = parent.clone();
+ bench.thread_with_setup(move |start| {
+ let _guard = parent2.enter();
+ start.wait();
+ let mut span = tracing::info_span!("parent");
+ for n in 0..i {
+ let s = tracing::info_span!(parent: &span, "parent2", n, i);
+ s.in_scope(|| {
+ tracing::info!(n);
+ });
+ span = s;
+ }
+ });
+ let elapsed = bench.run();
+ total += elapsed;
+ }
+ total
+ })
+ },
+ );
+ });
+}
+
+criterion_group!(benches, bench_new_span, bench_event);
+criterion_main!(benches);
diff --git a/crates/tracing-subscriber/benches/support/mod.rs b/crates/tracing-subscriber/benches/support/mod.rs
new file mode 100644
index 0000000..3abaa80
--- /dev/null
+++ b/crates/tracing-subscriber/benches/support/mod.rs
@@ -0,0 +1,49 @@
+use std::{
+ sync::{Arc, Barrier},
+ thread,
+ time::{Duration, Instant},
+};
+use tracing::dispatcher::Dispatch;
+
+#[derive(Clone)]
+pub(super) struct MultithreadedBench {
+ start: Arc<Barrier>,
+ end: Arc<Barrier>,
+ dispatch: Dispatch,
+}
+
+impl MultithreadedBench {
+ pub(super) fn new(dispatch: Dispatch) -> Self {
+ Self {
+ start: Arc::new(Barrier::new(5)),
+ end: Arc::new(Barrier::new(5)),
+ dispatch,
+ }
+ }
+
+ pub(super) fn thread(&self, f: impl FnOnce() + Send + 'static) -> &Self {
+ self.thread_with_setup(|start| {
+ start.wait();
+ f()
+ })
+ }
+
+ pub(super) fn thread_with_setup(&self, f: impl FnOnce(&Barrier) + Send + 'static) -> &Self {
+ let this = self.clone();
+ thread::spawn(move || {
+ let dispatch = this.dispatch.clone();
+ tracing::dispatcher::with_default(&dispatch, move || {
+ f(&this.start);
+ this.end.wait();
+ })
+ });
+ self
+ }
+
+ pub(super) fn run(&self) -> Duration {
+ self.start.wait();
+ let t0 = Instant::now();
+ self.end.wait();
+ t0.elapsed()
+ }
+}
diff --git a/crates/tracing-subscriber/cargo_embargo.json b/crates/tracing-subscriber/cargo_embargo.json
new file mode 100644
index 0000000..c9709e0
--- /dev/null
+++ b/crates/tracing-subscriber/cargo_embargo.json
@@ -0,0 +1,11 @@
+{
+ "features": [
+ "alloc",
+ "std",
+ "smallvec",
+ "parking_lot",
+ "fmt",
+ "registry"
+ ],
+ "run_cargo": false
+}
diff --git a/crates/tracing-subscriber/src/field/debug.rs b/crates/tracing-subscriber/src/field/debug.rs
new file mode 100644
index 0000000..cc67d29
--- /dev/null
+++ b/crates/tracing-subscriber/src/field/debug.rs
@@ -0,0 +1,111 @@
+//! `MakeVisitor` wrappers for working with `fmt::Debug` fields.
+use super::{MakeVisitor, VisitFmt, VisitOutput};
+use tracing_core::field::{Field, Visit};
+
+use core::fmt;
+
+/// A visitor wrapper that ensures any `fmt::Debug` fields are formatted using
+/// the alternate (`:#`) formatter.
+#[derive(Debug, Clone)]
+pub struct Alt<V>(V);
+
+// TODO(eliza): When `error` as a primitive type is stable, add a
+// `DisplayErrors` wrapper...
+
+// === impl Alt ===
+//
+impl<V> Alt<V> {
+ /// Wraps the provided visitor so that any `fmt::Debug` fields are formatted
+ /// using the alternative (`:#`) formatter.
+ pub fn new(inner: V) -> Self {
+ Alt(inner)
+ }
+}
+
+impl<T, V> MakeVisitor<T> for Alt<V>
+where
+ V: MakeVisitor<T>,
+{
+ type Visitor = Alt<V::Visitor>;
+
+ #[inline]
+ fn make_visitor(&self, target: T) -> Self::Visitor {
+ Alt(self.0.make_visitor(target))
+ }
+}
+
+impl<V> Visit for Alt<V>
+where
+ V: Visit,
+{
+ #[inline]
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ self.0.record_f64(field, value)
+ }
+
+ #[inline]
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.0.record_i64(field, value)
+ }
+
+ #[inline]
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.0.record_u64(field, value)
+ }
+
+ #[inline]
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.0.record_bool(field, value)
+ }
+
+ /// Visit a string value.
+ fn record_str(&mut self, field: &Field, value: &str) {
+ self.0.record_str(field, value)
+ }
+
+ // TODO(eliza): add RecordError when stable
+ // fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ // self.record_debug(field, &format_args!("{}", value))
+ // }
+
+ #[inline]
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ self.0.record_debug(field, &format_args!("{:#?}", value))
+ }
+}
+
+impl<V, O> VisitOutput<O> for Alt<V>
+where
+ V: VisitOutput<O>,
+{
+ #[inline]
+ fn finish(self) -> O {
+ self.0.finish()
+ }
+}
+
+feature! {
+ #![feature = "std"]
+ use super::VisitWrite;
+ use std::io;
+
+ impl<V> VisitWrite for Alt<V>
+ where
+ V: VisitWrite,
+ {
+ #[inline]
+ fn writer(&mut self) -> &mut dyn io::Write {
+ self.0.writer()
+ }
+ }
+}
+
+impl<V> VisitFmt for Alt<V>
+where
+ V: VisitFmt,
+{
+ #[inline]
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.0.writer()
+ }
+}
diff --git a/crates/tracing-subscriber/src/field/delimited.rs b/crates/tracing-subscriber/src/field/delimited.rs
new file mode 100644
index 0000000..98634ce
--- /dev/null
+++ b/crates/tracing-subscriber/src/field/delimited.rs
@@ -0,0 +1,184 @@
+//! A `MakeVisitor` wrapper that separates formatted fields with a delimiter.
+use super::{MakeVisitor, VisitFmt, VisitOutput};
+
+use core::fmt;
+use tracing_core::field::{Field, Visit};
+
+/// A `MakeVisitor` wrapper that wraps a visitor that writes formatted output so
+/// that a delimiter is inserted between writing formatted field values.
+#[derive(Debug, Clone)]
+pub struct Delimited<D, V> {
+ delimiter: D,
+ inner: V,
+}
+
+/// A visitor wrapper that inserts a delimiter after the wrapped visitor formats
+/// a field value.
+#[derive(Debug)]
+pub struct VisitDelimited<D, V> {
+ delimiter: D,
+ seen: bool,
+ inner: V,
+ err: fmt::Result,
+}
+
+// === impl Delimited ===
+
+impl<D, V, T> MakeVisitor<T> for Delimited<D, V>
+where
+ D: AsRef<str> + Clone,
+ V: MakeVisitor<T>,
+ V::Visitor: VisitFmt,
+{
+ type Visitor = VisitDelimited<D, V::Visitor>;
+ fn make_visitor(&self, target: T) -> Self::Visitor {
+ let inner = self.inner.make_visitor(target);
+ VisitDelimited::new(self.delimiter.clone(), inner)
+ }
+}
+
+impl<D, V> Delimited<D, V> {
+ /// Returns a new [`MakeVisitor`] implementation that wraps `inner` so that
+ /// it will format each visited field separated by the provided `delimiter`.
+ ///
+ /// [`MakeVisitor`]: super::MakeVisitor
+ pub fn new(delimiter: D, inner: V) -> Self {
+ Self { delimiter, inner }
+ }
+}
+
+// === impl VisitDelimited ===
+
+impl<D, V> VisitDelimited<D, V> {
+ /// Returns a new [`Visit`] implementation that wraps `inner` so that
+ /// each formatted field is separated by the provided `delimiter`.
+ ///
+ /// [`Visit`]: tracing_core::field::Visit
+ pub fn new(delimiter: D, inner: V) -> Self {
+ Self {
+ delimiter,
+ inner,
+ seen: false,
+ err: Ok(()),
+ }
+ }
+
+ fn delimit(&mut self)
+ where
+ V: VisitFmt,
+ D: AsRef<str>,
+ {
+ if self.err.is_err() {
+ return;
+ }
+
+ if self.seen {
+ self.err = self.inner.writer().write_str(self.delimiter.as_ref());
+ }
+
+ self.seen = true;
+ }
+}
+
+impl<D, V> Visit for VisitDelimited<D, V>
+where
+ V: VisitFmt,
+ D: AsRef<str>,
+{
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.delimit();
+ self.inner.record_i64(field, value);
+ }
+
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.delimit();
+ self.inner.record_u64(field, value);
+ }
+
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.delimit();
+ self.inner.record_bool(field, value);
+ }
+
+ fn record_str(&mut self, field: &Field, value: &str) {
+ self.delimit();
+ self.inner.record_str(field, value);
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ self.delimit();
+ self.inner.record_debug(field, value);
+ }
+}
+
+impl<D, V> VisitOutput<fmt::Result> for VisitDelimited<D, V>
+where
+ V: VisitFmt,
+ D: AsRef<str>,
+{
+ fn finish(self) -> fmt::Result {
+ self.err?;
+ self.inner.finish()
+ }
+}
+
+impl<D, V> VisitFmt for VisitDelimited<D, V>
+where
+ V: VisitFmt,
+ D: AsRef<str>,
+{
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.inner.writer()
+ }
+}
+
+#[cfg(test)]
+#[cfg(all(test, feature = "alloc"))]
+mod test {
+ use super::*;
+ use crate::field::test_util::*;
+
+ #[test]
+ fn delimited_visitor() {
+ let mut s = String::new();
+ let visitor = DebugVisitor::new(&mut s);
+ let mut visitor = VisitDelimited::new(", ", visitor);
+
+ TestAttrs1::with(|attrs| attrs.record(&mut visitor));
+ visitor.finish().unwrap();
+
+ assert_eq!(
+ s.as_str(),
+ "question=\"life, the universe, and everything\", tricky=true, can_you_do_it=true"
+ );
+ }
+
+ #[test]
+ fn delimited_new_visitor() {
+ let make = Delimited::new("; ", MakeDebug);
+
+ TestAttrs1::with(|attrs| {
+ let mut s = String::new();
+ {
+ let mut v = make.make_visitor(&mut s);
+ attrs.record(&mut v);
+ }
+ assert_eq!(
+ s.as_str(),
+ "question=\"life, the universe, and everything\"; tricky=true; can_you_do_it=true"
+ );
+ });
+
+ TestAttrs2::with(|attrs| {
+ let mut s = String::new();
+ {
+ let mut v = make.make_visitor(&mut s);
+ attrs.record(&mut v);
+ }
+ assert_eq!(
+ s.as_str(),
+ "question=None; question.answer=42; tricky=true; can_you_do_it=false"
+ );
+ });
+ }
+}
diff --git a/crates/tracing-subscriber/src/field/display.rs b/crates/tracing-subscriber/src/field/display.rs
new file mode 100644
index 0000000..78a039c
--- /dev/null
+++ b/crates/tracing-subscriber/src/field/display.rs
@@ -0,0 +1,117 @@
+//! `MakeVisitor` wrappers for working with `fmt::Display` fields.
+use super::{MakeVisitor, VisitFmt, VisitOutput};
+use tracing_core::field::{Field, Visit};
+
+use core::fmt;
+
+/// A visitor wrapper that ensures any strings named "message" are formatted
+/// using `fmt::Display`
+#[derive(Debug, Clone)]
+pub struct Messages<V>(V);
+
+// TODO(eliza): When `error` as a primitive type is stable, add a
+// `DisplayErrors` wrapper...
+
+// === impl Messages ===
+//
+impl<V> Messages<V> {
+ /// Returns a new [`MakeVisitor`] implementation that will wrap `inner` so
+ /// that any strings named `message` are formatted using `fmt::Display`.
+ ///
+ /// [`MakeVisitor`]: super::MakeVisitor
+ pub fn new(inner: V) -> Self {
+ Messages(inner)
+ }
+}
+
+impl<T, V> MakeVisitor<T> for Messages<V>
+where
+ V: MakeVisitor<T>,
+{
+ type Visitor = Messages<V::Visitor>;
+
+ #[inline]
+ fn make_visitor(&self, target: T) -> Self::Visitor {
+ Messages(self.0.make_visitor(target))
+ }
+}
+
+impl<V> Visit for Messages<V>
+where
+ V: Visit,
+{
+ #[inline]
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ self.0.record_f64(field, value)
+ }
+
+ #[inline]
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.0.record_i64(field, value)
+ }
+
+ #[inline]
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.0.record_u64(field, value)
+ }
+
+ #[inline]
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.0.record_bool(field, value)
+ }
+
+ /// Visit a string value.
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if field.name() == "message" {
+ self.0.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.0.record_str(field, value)
+ }
+ }
+
+ // TODO(eliza): add RecordError when stable
+ // fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ // self.record_debug(field, &format_args!("{}", value))
+ // }
+
+ #[inline]
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ self.0.record_debug(field, value)
+ }
+}
+
+impl<V, O> VisitOutput<O> for Messages<V>
+where
+ V: VisitOutput<O>,
+{
+ #[inline]
+ fn finish(self) -> O {
+ self.0.finish()
+ }
+}
+
+feature! {
+ #![feature = "std"]
+ use super::VisitWrite;
+ use std::io;
+
+ impl<V> VisitWrite for Messages<V>
+ where
+ V: VisitWrite,
+ {
+ #[inline]
+ fn writer(&mut self) -> &mut dyn io::Write {
+ self.0.writer()
+ }
+ }
+}
+
+impl<V> VisitFmt for Messages<V>
+where
+ V: VisitFmt,
+{
+ #[inline]
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.0.writer()
+ }
+}
diff --git a/crates/tracing-subscriber/src/field/mod.rs b/crates/tracing-subscriber/src/field/mod.rs
new file mode 100644
index 0000000..03b9146
--- /dev/null
+++ b/crates/tracing-subscriber/src/field/mod.rs
@@ -0,0 +1,365 @@
+//! Utilities for working with [fields] and [field visitors].
+//!
+//! [fields]: tracing_core::field
+//! [field visitors]: tracing_core::field::Visit
+use core::{fmt, marker::PhantomData};
+pub use tracing_core::field::Visit;
+use tracing_core::{
+ span::{Attributes, Record},
+ Event,
+};
+pub mod debug;
+pub mod delimited;
+pub mod display;
+
+/// Creates new [visitors].
+///
+/// A type implementing `MakeVisitor` represents a composable factory for types
+/// implementing the [`Visit` trait][visitors]. The `MakeVisitor` trait defines
+/// a single function, `make_visitor`, which takes in a `T`-typed `target` and
+/// returns a type implementing `Visit` configured for that target. A target may
+/// be a string, output stream, or data structure that the visitor will record
+/// data to, configuration variables that determine the visitor's behavior, or
+/// `()` when no input is required to produce a visitor.
+///
+/// [visitors]: tracing_core::field::Visit
+pub trait MakeVisitor<T> {
+ /// The visitor type produced by this `MakeVisitor`.
+ type Visitor: Visit;
+
+ /// Make a new visitor for the provided `target`.
+ fn make_visitor(&self, target: T) -> Self::Visitor;
+}
+
+/// A [visitor] that produces output once it has visited a set of fields.
+///
+/// [visitor]: tracing_core::field::Visit
+pub trait VisitOutput<Out>: Visit {
+ /// Completes the visitor, returning any output.
+ ///
+ /// This is called once a full set of fields has been visited.
+ fn finish(self) -> Out;
+
+ /// Visit a set of fields, and return the output of finishing the visitor
+ /// once the fields have been visited.
+ fn visit<R>(mut self, fields: &R) -> Out
+ where
+ R: RecordFields,
+ Self: Sized,
+ {
+ fields.record(&mut self);
+ self.finish()
+ }
+}
+
+/// Extension trait implemented by types which can be recorded by a [visitor].
+///
+/// This allows writing code that is generic over `tracing_core`'s
+/// [`span::Attributes`][attr], [`span::Record`][rec], and [`Event`]
+/// types. These types all provide inherent `record` methods that allow a
+/// visitor to record their fields, but there is no common trait representing this.
+///
+/// With `RecordFields`, we can write code like this:
+/// ```
+/// use tracing_core::field::Visit;
+/// # use tracing_core::field::Field;
+/// use tracing_subscriber::field::RecordFields;
+///
+/// struct MyVisitor {
+/// // ...
+/// }
+/// # impl MyVisitor { fn new() -> Self { Self{} } }
+/// impl Visit for MyVisitor {
+/// // ...
+/// # fn record_debug(&mut self, _: &Field, _: &dyn std::fmt::Debug) {}
+/// }
+///
+/// fn record_with_my_visitor<R>(r: R)
+/// where
+/// R: RecordFields,
+/// {
+/// let mut visitor = MyVisitor::new();
+/// r.record(&mut visitor);
+/// }
+/// ```
+/// [visitor]: tracing_core::field::Visit
+/// [attr]: tracing_core::span::Attributes
+/// [rec]: tracing_core::span::Record
+pub trait RecordFields: crate::sealed::Sealed<RecordFieldsMarker> {
+ /// Record all the fields in `self` with the provided `visitor`.
+ fn record(&self, visitor: &mut dyn Visit);
+}
+
+/// Extension trait implemented for all `MakeVisitor` implementations that
+/// produce a visitor implementing `VisitOutput`.
+pub trait MakeOutput<T, Out>
+where
+ Self: MakeVisitor<T> + crate::sealed::Sealed<(T, Out)>,
+ Self::Visitor: VisitOutput<Out>,
+{
+ /// Visits all fields in `fields` with a new visitor constructed from
+ /// `target`.
+ fn visit_with<F>(&self, target: T, fields: &F) -> Out
+ where
+ F: RecordFields,
+ {
+ self.make_visitor(target).visit(fields)
+ }
+}
+
+feature! {
+ #![feature = "std"]
+ use std::io;
+
+ /// Extension trait implemented by visitors to indicate that they write to an
+ /// `io::Write` instance, and allow access to that writer.
+ pub trait VisitWrite: VisitOutput<Result<(), io::Error>> {
+ /// Returns the writer that this visitor writes to.
+ fn writer(&mut self) -> &mut dyn io::Write;
+ }
+}
+
+/// Extension trait implemented by visitors to indicate that they write to a
+/// `fmt::Write` instance, and allow access to that writer.
+pub trait VisitFmt: VisitOutput<fmt::Result> {
+ /// Returns the formatter that this visitor writes to.
+ fn writer(&mut self) -> &mut dyn fmt::Write;
+}
+
+/// Extension trait providing `MakeVisitor` combinators.
+pub trait MakeExt<T>
+where
+ Self: MakeVisitor<T> + Sized,
+ Self: crate::sealed::Sealed<MakeExtMarker<T>>,
+{
+ /// Wraps `self` so that any `fmt::Debug` fields are recorded using the
+ /// alternate formatter (`{:#?}`).
+ fn debug_alt(self) -> debug::Alt<Self> {
+ debug::Alt::new(self)
+ }
+
+ /// Wraps `self` so that any string fields named "message" are recorded
+ /// using `fmt::Display`.
+ fn display_messages(self) -> display::Messages<Self> {
+ display::Messages::new(self)
+ }
+
+ /// Wraps `self` so that when fields are formatted to a writer, they are
+ /// separated by the provided `delimiter`.
+ fn delimited<D>(self, delimiter: D) -> delimited::Delimited<D, Self>
+ where
+ D: AsRef<str> + Clone,
+ Self::Visitor: VisitFmt,
+ {
+ delimited::Delimited::new(delimiter, self)
+ }
+}
+
+// === impl RecordFields ===
+
+impl<'a> crate::sealed::Sealed<RecordFieldsMarker> for Event<'a> {}
+impl<'a> RecordFields for Event<'a> {
+ fn record(&self, visitor: &mut dyn Visit) {
+ Event::record(self, visitor)
+ }
+}
+
+impl<'a> crate::sealed::Sealed<RecordFieldsMarker> for Attributes<'a> {}
+impl<'a> RecordFields for Attributes<'a> {
+ fn record(&self, visitor: &mut dyn Visit) {
+ Attributes::record(self, visitor)
+ }
+}
+
+impl<'a> crate::sealed::Sealed<RecordFieldsMarker> for Record<'a> {}
+impl<'a> RecordFields for Record<'a> {
+ fn record(&self, visitor: &mut dyn Visit) {
+ Record::record(self, visitor)
+ }
+}
+
+impl<'a, F> crate::sealed::Sealed<RecordFieldsMarker> for &'a F where F: RecordFields {}
+impl<'a, F> RecordFields for &'a F
+where
+ F: RecordFields,
+{
+ fn record(&self, visitor: &mut dyn Visit) {
+ F::record(*self, visitor)
+ }
+}
+
+// === blanket impls ===
+
+impl<T, V, F> MakeVisitor<T> for F
+where
+ F: Fn(T) -> V,
+ V: Visit,
+{
+ type Visitor = V;
+ fn make_visitor(&self, target: T) -> Self::Visitor {
+ (self)(target)
+ }
+}
+
+impl<T, Out, M> crate::sealed::Sealed<(T, Out)> for M
+where
+ M: MakeVisitor<T>,
+ M::Visitor: VisitOutput<Out>,
+{
+}
+
+impl<T, Out, M> MakeOutput<T, Out> for M
+where
+ M: MakeVisitor<T>,
+ M::Visitor: VisitOutput<Out>,
+{
+}
+
+impl<T, M> crate::sealed::Sealed<MakeExtMarker<T>> for M where M: MakeVisitor<T> + Sized {}
+
+impl<T, M> MakeExt<T> for M
+where
+ M: MakeVisitor<T> + Sized,
+ M: crate::sealed::Sealed<MakeExtMarker<T>>,
+{
+}
+
+#[derive(Debug)]
+#[doc(hidden)]
+pub struct MakeExtMarker<T> {
+ _p: PhantomData<T>,
+}
+
+#[derive(Debug)]
+#[doc(hidden)]
+pub struct RecordFieldsMarker {
+ _p: (),
+}
+
+#[cfg(all(test, feature = "alloc"))]
+#[macro_use]
+pub(in crate::field) mod test_util {
+ use super::*;
+ pub(in crate::field) use alloc::string::String;
+ use tracing_core::{
+ callsite::Callsite,
+ field::{Field, Value},
+ metadata::{Kind, Level, Metadata},
+ };
+
+ pub(crate) struct TestAttrs1;
+ pub(crate) struct TestAttrs2;
+
+ impl TestAttrs1 {
+ pub(crate) fn with<T>(f: impl FnOnce(Attributes<'_>) -> T) -> T {
+ let fieldset = TEST_META_1.fields();
+ let values = &[
+ (
+ &fieldset.field("question").unwrap(),
+ Some(&"life, the universe, and everything" as &dyn Value),
+ ),
+ (&fieldset.field("question.answer").unwrap(), None),
+ (
+ &fieldset.field("tricky").unwrap(),
+ Some(&true as &dyn Value),
+ ),
+ (
+ &fieldset.field("can_you_do_it").unwrap(),
+ Some(&true as &dyn Value),
+ ),
+ ];
+ let valueset = fieldset.value_set(values);
+ let attrs = tracing_core::span::Attributes::new(&TEST_META_1, &valueset);
+ f(attrs)
+ }
+ }
+
+ impl TestAttrs2 {
+ pub(crate) fn with<T>(f: impl FnOnce(Attributes<'_>) -> T) -> T {
+ let fieldset = TEST_META_1.fields();
+ let none = tracing_core::field::debug(&Option::<&str>::None);
+ let values = &[
+ (
+ &fieldset.field("question").unwrap(),
+ Some(&none as &dyn Value),
+ ),
+ (
+ &fieldset.field("question.answer").unwrap(),
+ Some(&42 as &dyn Value),
+ ),
+ (
+ &fieldset.field("tricky").unwrap(),
+ Some(&true as &dyn Value),
+ ),
+ (
+ &fieldset.field("can_you_do_it").unwrap(),
+ Some(&false as &dyn Value),
+ ),
+ ];
+ let valueset = fieldset.value_set(values);
+ let attrs = tracing_core::span::Attributes::new(&TEST_META_1, &valueset);
+ f(attrs)
+ }
+ }
+
+ struct TestCallsite1;
+ static TEST_CALLSITE_1: &'static dyn Callsite = &TestCallsite1;
+ static TEST_META_1: Metadata<'static> = tracing_core::metadata! {
+ name: "field_test1",
+ target: module_path!(),
+ level: Level::INFO,
+ fields: &["question", "question.answer", "tricky", "can_you_do_it"],
+ callsite: TEST_CALLSITE_1,
+ kind: Kind::SPAN,
+ };
+
+ impl Callsite for TestCallsite1 {
+ fn set_interest(&self, _: tracing_core::subscriber::Interest) {
+ unimplemented!()
+ }
+
+ fn metadata(&self) -> &Metadata<'_> {
+ &TEST_META_1
+ }
+ }
+
+ pub(crate) struct MakeDebug;
+ pub(crate) struct DebugVisitor<'a> {
+ writer: &'a mut dyn fmt::Write,
+ err: fmt::Result,
+ }
+
+ impl<'a> DebugVisitor<'a> {
+ pub(crate) fn new(writer: &'a mut dyn fmt::Write) -> Self {
+ Self {
+ writer,
+ err: Ok(()),
+ }
+ }
+ }
+
+ impl<'a> Visit for DebugVisitor<'a> {
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ write!(self.writer, "{}={:?}", field, value).unwrap();
+ }
+ }
+
+ impl<'a> VisitOutput<fmt::Result> for DebugVisitor<'a> {
+ fn finish(self) -> fmt::Result {
+ self.err
+ }
+ }
+
+ impl<'a> VisitFmt for DebugVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.writer
+ }
+ }
+
+ impl<'a> MakeVisitor<&'a mut dyn fmt::Write> for MakeDebug {
+ type Visitor = DebugVisitor<'a>;
+ fn make_visitor(&self, w: &'a mut dyn fmt::Write) -> DebugVisitor<'a> {
+ DebugVisitor::new(w)
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/directive.rs b/crates/tracing-subscriber/src/filter/directive.rs
new file mode 100644
index 0000000..9ee2ce5
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/directive.rs
@@ -0,0 +1,457 @@
+use crate::filter::level::{self, LevelFilter};
+#[cfg(not(feature = "smallvec"))]
+use alloc::vec;
+#[cfg(not(feature = "std"))]
+use alloc::{string::String, vec::Vec};
+
+use core::{cmp::Ordering, fmt, iter::FromIterator, slice, str::FromStr};
+use tracing_core::{Level, Metadata};
+/// Indicates that a string could not be parsed as a filtering directive.
+#[derive(Debug)]
+pub struct ParseError {
+ kind: ParseErrorKind,
+}
+
+/// A directive which will statically enable or disable a given callsite.
+///
+/// Unlike a dynamic directive, this can be cached by the callsite.
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub(crate) struct StaticDirective {
+ pub(in crate::filter) target: Option<String>,
+ pub(in crate::filter) field_names: Vec<String>,
+ pub(in crate::filter) level: LevelFilter,
+}
+
+#[cfg(feature = "smallvec")]
+pub(crate) type FilterVec<T> = smallvec::SmallVec<[T; 8]>;
+#[cfg(not(feature = "smallvec"))]
+pub(crate) type FilterVec<T> = Vec<T>;
+
+#[derive(Debug, PartialEq, Clone)]
+pub(in crate::filter) struct DirectiveSet<T> {
+ directives: FilterVec<T>,
+ pub(in crate::filter) max_level: LevelFilter,
+}
+
+pub(in crate::filter) trait Match {
+ fn cares_about(&self, meta: &Metadata<'_>) -> bool;
+ fn level(&self) -> &LevelFilter;
+}
+
+#[derive(Debug)]
+enum ParseErrorKind {
+ #[cfg(feature = "std")]
+ Field(Box<dyn std::error::Error + Send + Sync>),
+ Level(level::ParseError),
+ Other(Option<&'static str>),
+}
+
+// === impl DirectiveSet ===
+
+impl<T> DirectiveSet<T> {
+ // this is only used by `env-filter`.
+ #[cfg(all(feature = "std", feature = "env-filter"))]
+ pub(crate) fn is_empty(&self) -> bool {
+ self.directives.is_empty()
+ }
+
+ pub(crate) fn iter(&self) -> slice::Iter<'_, T> {
+ self.directives.iter()
+ }
+}
+
+impl<T: Ord> Default for DirectiveSet<T> {
+ fn default() -> Self {
+ Self {
+ directives: FilterVec::new(),
+ max_level: LevelFilter::OFF,
+ }
+ }
+}
+
+impl<T: Match + Ord> DirectiveSet<T> {
+ pub(crate) fn directives(&self) -> impl Iterator<Item = &T> {
+ self.directives.iter()
+ }
+
+ pub(crate) fn directives_for<'a>(
+ &'a self,
+ metadata: &'a Metadata<'a>,
+ ) -> impl Iterator<Item = &'a T> + 'a {
+ self.directives().filter(move |d| d.cares_about(metadata))
+ }
+
+ pub(crate) fn add(&mut self, directive: T) {
+ // does this directive enable a more verbose level than the current
+ // max? if so, update the max level.
+ let level = *directive.level();
+ if level > self.max_level {
+ self.max_level = level;
+ }
+ // insert the directive into the vec of directives, ordered by
+ // specificity (length of target + number of field filters). this
+ // ensures that, when finding a directive to match a span or event, we
+ // search the directive set in most specific first order.
+ match self.directives.binary_search(&directive) {
+ Ok(i) => self.directives[i] = directive,
+ Err(i) => self.directives.insert(i, directive),
+ }
+ }
+
+ #[cfg(test)]
+ pub(in crate::filter) fn into_vec(self) -> FilterVec<T> {
+ self.directives
+ }
+}
+
+impl<T: Match + Ord> FromIterator<T> for DirectiveSet<T> {
+ fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
+ let mut this = Self::default();
+ this.extend(iter);
+ this
+ }
+}
+
+impl<T: Match + Ord> Extend<T> for DirectiveSet<T> {
+ fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
+ for directive in iter.into_iter() {
+ self.add(directive);
+ }
+ }
+}
+
+impl<T> IntoIterator for DirectiveSet<T> {
+ type Item = T;
+
+ #[cfg(feature = "smallvec")]
+ type IntoIter = smallvec::IntoIter<[T; 8]>;
+ #[cfg(not(feature = "smallvec"))]
+ type IntoIter = vec::IntoIter<T>;
+
+ fn into_iter(self) -> Self::IntoIter {
+ self.directives.into_iter()
+ }
+}
+
+// === impl Statics ===
+
+impl DirectiveSet<StaticDirective> {
+ pub(crate) fn enabled(&self, meta: &Metadata<'_>) -> bool {
+ let level = meta.level();
+ match self.directives_for(meta).next() {
+ Some(d) => d.level >= *level,
+ None => false,
+ }
+ }
+
+ /// Same as `enabled` above, but skips `Directive`'s with fields.
+ pub(crate) fn target_enabled(&self, target: &str, level: &Level) -> bool {
+ match self.directives_for_target(target).next() {
+ Some(d) => d.level >= *level,
+ None => false,
+ }
+ }
+
+ pub(crate) fn directives_for_target<'a>(
+ &'a self,
+ target: &'a str,
+ ) -> impl Iterator<Item = &'a StaticDirective> + 'a {
+ self.directives()
+ .filter(move |d| d.cares_about_target(target))
+ }
+}
+
+// === impl StaticDirective ===
+
+impl StaticDirective {
+ pub(in crate::filter) fn new(
+ target: Option<String>,
+ field_names: Vec<String>,
+ level: LevelFilter,
+ ) -> Self {
+ Self {
+ target,
+ field_names,
+ level,
+ }
+ }
+
+ pub(in crate::filter) fn cares_about_target(&self, to_check: &str) -> bool {
+ // Does this directive have a target filter, and does it match the
+ // metadata's target?
+ if let Some(ref target) = self.target {
+ if !to_check.starts_with(&target[..]) {
+ return false;
+ }
+ }
+
+ if !self.field_names.is_empty() {
+ return false;
+ }
+
+ true
+ }
+}
+
+impl Ord for StaticDirective {
+ fn cmp(&self, other: &StaticDirective) -> Ordering {
+ // We attempt to order directives by how "specific" they are. This
+ // ensures that we try the most specific directives first when
+ // attempting to match a piece of metadata.
+
+ // First, we compare based on whether a target is specified, and the
+ // lengths of those targets if both have targets.
+ let ordering = self
+ .target
+ .as_ref()
+ .map(String::len)
+ .cmp(&other.target.as_ref().map(String::len))
+ // Then we compare how many field names are matched by each directive.
+ .then_with(|| self.field_names.len().cmp(&other.field_names.len()))
+ // Finally, we fall back to lexicographical ordering if the directives are
+ // equally specific. Although this is no longer semantically important,
+ // we need to define a total ordering to determine the directive's place
+ // in the BTreeMap.
+ .then_with(|| {
+ self.target
+ .cmp(&other.target)
+ .then_with(|| self.field_names[..].cmp(&other.field_names[..]))
+ })
+ .reverse();
+
+ #[cfg(debug_assertions)]
+ {
+ if ordering == Ordering::Equal {
+ debug_assert_eq!(
+ self.target, other.target,
+ "invariant violated: Ordering::Equal must imply a.target == b.target"
+ );
+ debug_assert_eq!(
+ self.field_names, other.field_names,
+ "invariant violated: Ordering::Equal must imply a.field_names == b.field_names"
+ );
+ }
+ }
+
+ ordering
+ }
+}
+
+impl PartialOrd for StaticDirective {
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+}
+
+impl Match for StaticDirective {
+ fn cares_about(&self, meta: &Metadata<'_>) -> bool {
+ // Does this directive have a target filter, and does it match the
+ // metadata's target?
+ if let Some(ref target) = self.target {
+ if !meta.target().starts_with(&target[..]) {
+ return false;
+ }
+ }
+
+ if meta.is_event() && !self.field_names.is_empty() {
+ let fields = meta.fields();
+ for name in &self.field_names {
+ if fields.field(name).is_none() {
+ return false;
+ }
+ }
+ }
+
+ true
+ }
+
+ fn level(&self) -> &LevelFilter {
+ &self.level
+ }
+}
+
+impl Default for StaticDirective {
+ fn default() -> Self {
+ StaticDirective {
+ target: None,
+ field_names: Vec::new(),
+ level: LevelFilter::ERROR,
+ }
+ }
+}
+
+impl fmt::Display for StaticDirective {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut wrote_any = false;
+ if let Some(ref target) = self.target {
+ fmt::Display::fmt(target, f)?;
+ wrote_any = true;
+ }
+
+ if !self.field_names.is_empty() {
+ f.write_str("[")?;
+
+ let mut fields = self.field_names.iter();
+ if let Some(field) = fields.next() {
+ write!(f, "{{{}", field)?;
+ for field in fields {
+ write!(f, ",{}", field)?;
+ }
+ f.write_str("}")?;
+ }
+
+ f.write_str("]")?;
+ wrote_any = true;
+ }
+
+ if wrote_any {
+ f.write_str("=")?;
+ }
+
+ fmt::Display::fmt(&self.level, f)
+ }
+}
+
+impl FromStr for StaticDirective {
+ type Err = ParseError;
+
+ fn from_str(s: &str) -> Result<Self, Self::Err> {
+ // This method parses a filtering directive in one of the following
+ // forms:
+ //
+ // * `foo=trace` (TARGET=LEVEL)
+ // * `foo[{bar,baz}]=info` (TARGET[{FIELD,+}]=LEVEL)
+ // * `trace` (bare LEVEL)
+ // * `foo` (bare TARGET)
+ let mut split = s.split('=');
+ let part0 = split
+ .next()
+ .ok_or_else(|| ParseError::msg("string must not be empty"))?;
+
+ // Directive includes an `=`:
+ // * `foo=trace`
+ // * `foo[{bar}]=trace`
+ // * `foo[{bar,baz}]=trace`
+ if let Some(part1) = split.next() {
+ if split.next().is_some() {
+ return Err(ParseError::msg(
+ "too many '=' in filter directive, expected 0 or 1",
+ ));
+ }
+
+ let mut split = part0.split("[{");
+ let target = split.next().map(String::from);
+ let mut field_names = Vec::new();
+ // Directive includes fields:
+ // * `foo[{bar}]=trace`
+ // * `foo[{bar,baz}]=trace`
+ if let Some(maybe_fields) = split.next() {
+ if split.next().is_some() {
+ return Err(ParseError::msg(
+ "too many '[{' in filter directive, expected 0 or 1",
+ ));
+ }
+
+ if !maybe_fields.ends_with("}]") {
+ return Err(ParseError::msg("expected fields list to end with '}]'"));
+ }
+
+ let fields = maybe_fields
+ .trim_end_matches("}]")
+ .split(',')
+ .filter_map(|s| {
+ if s.is_empty() {
+ None
+ } else {
+ Some(String::from(s))
+ }
+ });
+ field_names.extend(fields);
+ };
+ let level = part1.parse()?;
+ return Ok(Self {
+ level,
+ field_names,
+ target,
+ });
+ }
+
+ // Okay, the part after the `=` was empty, the directive is either a
+ // bare level or a bare target.
+ // * `foo`
+ // * `info`
+ Ok(match part0.parse::<LevelFilter>() {
+ Ok(level) => Self {
+ level,
+ target: None,
+ field_names: Vec::new(),
+ },
+ Err(_) => Self {
+ target: Some(String::from(part0)),
+ level: LevelFilter::TRACE,
+ field_names: Vec::new(),
+ },
+ })
+ }
+}
+
+// === impl ParseError ===
+
+impl ParseError {
+ #[cfg(all(feature = "std", feature = "env-filter"))]
+ pub(crate) fn new() -> Self {
+ ParseError {
+ kind: ParseErrorKind::Other(None),
+ }
+ }
+
+ pub(crate) fn msg(s: &'static str) -> Self {
+ ParseError {
+ kind: ParseErrorKind::Other(Some(s)),
+ }
+ }
+}
+
+impl fmt::Display for ParseError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.kind {
+ ParseErrorKind::Other(None) => f.pad("invalid filter directive"),
+ ParseErrorKind::Other(Some(msg)) => write!(f, "invalid filter directive: {}", msg),
+ ParseErrorKind::Level(ref l) => l.fmt(f),
+ #[cfg(feature = "std")]
+ ParseErrorKind::Field(ref e) => write!(f, "invalid field filter: {}", e),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for ParseError {
+ fn description(&self) -> &str {
+ "invalid filter directive"
+ }
+
+ fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+ match self.kind {
+ ParseErrorKind::Other(_) => None,
+ ParseErrorKind::Level(ref l) => Some(l),
+ ParseErrorKind::Field(ref n) => Some(n.as_ref()),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl From<Box<dyn std::error::Error + Send + Sync>> for ParseError {
+ fn from(e: Box<dyn std::error::Error + Send + Sync>) -> Self {
+ Self {
+ kind: ParseErrorKind::Field(e),
+ }
+ }
+}
+
+impl From<level::ParseError> for ParseError {
+ fn from(l: level::ParseError) -> Self {
+ Self {
+ kind: ParseErrorKind::Level(l),
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/env/builder.rs b/crates/tracing-subscriber/src/filter/env/builder.rs
new file mode 100644
index 0000000..8afe117
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/env/builder.rs
@@ -0,0 +1,326 @@
+use super::{
+ directive::{self, Directive},
+ EnvFilter, FromEnvError,
+};
+use crate::sync::RwLock;
+use std::env;
+use thread_local::ThreadLocal;
+use tracing::level_filters::STATIC_MAX_LEVEL;
+
+/// A [builder] for constructing new [`EnvFilter`]s.
+///
+/// [builder]: https://rust-unofficial.github.io/patterns/patterns/creational/builder.html
+#[derive(Debug, Clone)]
+#[must_use]
+pub struct Builder {
+ regex: bool,
+ env: Option<String>,
+ default_directive: Option<Directive>,
+}
+
+impl Builder {
+ /// Sets whether span field values can be matched with regular expressions.
+ ///
+ /// If this is `true`, field filter directives will be interpreted as
+ /// regular expressions if they are not able to be interpreted as a `bool`,
+ /// `i64`, `u64`, or `f64` literal. If this is `false,` those field values
+ /// will be interpreted as literal [`std::fmt::Debug`] output instead.
+ ///
+ /// By default, regular expressions are enabled.
+ ///
+ /// **Note**: when [`EnvFilter`]s are constructed from untrusted inputs,
+ /// disabling regular expressions is strongly encouraged.
+ pub fn with_regex(self, regex: bool) -> Self {
+ Self { regex, ..self }
+ }
+
+ /// Sets a default [filtering directive] that will be added to the filter if
+ /// the parsed string or environment variable contains no filter directives.
+ ///
+ /// By default, there is no default directive.
+ ///
+ /// # Examples
+ ///
+ /// If [`parse`], [`parse_lossy`], [`from_env`], or [`from_env_lossy`] are
+ /// called with an empty string or environment variable, the default
+ /// directive is used instead:
+ ///
+ /// ```rust
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// let filter = EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::INFO.into())
+ /// .parse("")?;
+ ///
+ /// assert_eq!(format!("{}", filter), "info");
+ /// # Ok(()) }
+ /// ```
+ ///
+ /// Note that the `lossy` variants ([`parse_lossy`] and [`from_env_lossy`])
+ /// will ignore any invalid directives. If all directives in a filter
+ /// string or environment variable are invalid, those methods will also use
+ /// the default directive:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// let filter = EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::INFO.into())
+ /// .parse_lossy("some_target=fake level,foo::bar=lolwut");
+ ///
+ /// assert_eq!(format!("{}", filter), "info");
+ /// ```
+ ///
+ ///
+ /// If the string or environment variable contains valid filtering
+ /// directives, the default directive is not used:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// let filter = EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::INFO.into())
+ /// .parse_lossy("foo=trace");
+ ///
+ /// // The default directive is *not* used:
+ /// assert_eq!(format!("{}", filter), "foo=trace");
+ /// ```
+ ///
+ /// Parsing a more complex default directive from a string:
+ ///
+ /// ```rust
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// let default = "myapp=debug".parse()
+ /// .expect("hard-coded default directive should be valid");
+ ///
+ /// let filter = EnvFilter::builder()
+ /// .with_default_directive(default)
+ /// .parse("")?;
+ ///
+ /// assert_eq!(format!("{}", filter), "myapp=debug");
+ /// # Ok(()) }
+ /// ```
+ ///
+ /// [`parse_lossy`]: Self::parse_lossy
+ /// [`from_env_lossy`]: Self::from_env_lossy
+ /// [`parse`]: Self::parse
+ /// [`from_env`]: Self::from_env
+ pub fn with_default_directive(self, default_directive: Directive) -> Self {
+ Self {
+ default_directive: Some(default_directive),
+ ..self
+ }
+ }
+
+ /// Sets the name of the environment variable used by the [`from_env`],
+ /// [`from_env_lossy`], and [`try_from_env`] methods.
+ ///
+ /// By default, this is the value of [`EnvFilter::DEFAULT_ENV`]
+ /// (`RUST_LOG`).
+ ///
+ /// [`from_env`]: Self::from_env
+ /// [`from_env_lossy`]: Self::from_env_lossy
+ /// [`try_from_env`]: Self::try_from_env
+ pub fn with_env_var(self, var: impl ToString) -> Self {
+ Self {
+ env: Some(var.to_string()),
+ ..self
+ }
+ }
+
+ /// Returns a new [`EnvFilter`] from the directives in the given string,
+ /// *ignoring* any that are invalid.
+ pub fn parse_lossy<S: AsRef<str>>(&self, dirs: S) -> EnvFilter {
+ let directives = dirs
+ .as_ref()
+ .split(',')
+ .filter(|s| !s.is_empty())
+ .filter_map(|s| match Directive::parse(s, self.regex) {
+ Ok(d) => Some(d),
+ Err(err) => {
+ eprintln!("ignoring `{}`: {}", s, err);
+ None
+ }
+ });
+ self.from_directives(directives)
+ }
+
+ /// Returns a new [`EnvFilter`] from the directives in the given string,
+ /// or an error if any are invalid.
+ pub fn parse<S: AsRef<str>>(&self, dirs: S) -> Result<EnvFilter, directive::ParseError> {
+ let dirs = dirs.as_ref();
+ if dirs.is_empty() {
+ return Ok(self.from_directives(std::iter::empty()));
+ }
+ let directives = dirs
+ .split(',')
+ .filter(|s| !s.is_empty())
+ .map(|s| Directive::parse(s, self.regex))
+ .collect::<Result<Vec<_>, _>>()?;
+ Ok(self.from_directives(directives))
+ }
+
+ /// Returns a new [`EnvFilter`] from the directives in the configured
+ /// environment variable, ignoring any directives that are invalid.
+ pub fn from_env_lossy(&self) -> EnvFilter {
+ let var = env::var(self.env_var_name()).unwrap_or_default();
+ self.parse_lossy(var)
+ }
+
+ /// Returns a new [`EnvFilter`] from the directives in the configured
+ /// environment variable. If the environment variable is unset, no directive is added.
+ ///
+ /// An error is returned if the environment contains invalid directives.
+ pub fn from_env(&self) -> Result<EnvFilter, FromEnvError> {
+ let var = env::var(self.env_var_name()).unwrap_or_default();
+ self.parse(var).map_err(Into::into)
+ }
+
+ /// Returns a new [`EnvFilter`] from the directives in the configured
+ /// environment variable, or an error if the environment variable is not set
+ /// or contains invalid directives.
+ pub fn try_from_env(&self) -> Result<EnvFilter, FromEnvError> {
+ let var = env::var(self.env_var_name())?;
+ self.parse(var).map_err(Into::into)
+ }
+
+ // TODO(eliza): consider making this a public API?
+ // Clippy doesn't love this naming, because it suggests that `from_` methods
+ // should not take a `Self`...but in this case, it's the `EnvFilter` that is
+ // being constructed "from" the directives, rather than the builder itself.
+ #[allow(clippy::wrong_self_convention)]
+ pub(super) fn from_directives(
+ &self,
+ directives: impl IntoIterator<Item = Directive>,
+ ) -> EnvFilter {
+ use tracing::Level;
+
+ let mut directives: Vec<_> = directives.into_iter().collect();
+ let mut disabled = Vec::new();
+ for directive in &mut directives {
+ if directive.level > STATIC_MAX_LEVEL {
+ disabled.push(directive.clone());
+ }
+ if !self.regex {
+ directive.deregexify();
+ }
+ }
+
+ if !disabled.is_empty() {
+ #[cfg(feature = "nu_ansi_term")]
+ use nu_ansi_term::{Color, Style};
+ // NOTE: We can't use a configured `MakeWriter` because the EnvFilter
+ // has no knowledge of any underlying subscriber or subscriber, which
+ // may or may not use a `MakeWriter`.
+ let warn = |msg: &str| {
+ #[cfg(not(feature = "nu_ansi_term"))]
+ let msg = format!("warning: {}", msg);
+ #[cfg(feature = "nu_ansi_term")]
+ let msg = {
+ let bold = Style::new().bold();
+ let mut warning = Color::Yellow.paint("warning");
+ warning.style_ref_mut().is_bold = true;
+ format!("{}{} {}", warning, bold.paint(":"), bold.paint(msg))
+ };
+ eprintln!("{}", msg);
+ };
+ let ctx_prefixed = |prefix: &str, msg: &str| {
+ #[cfg(not(feature = "nu_ansi_term"))]
+ let msg = format!("{} {}", prefix, msg);
+ #[cfg(feature = "nu_ansi_term")]
+ let msg = {
+ let mut equal = Color::Fixed(21).paint("="); // dark blue
+ equal.style_ref_mut().is_bold = true;
+ format!(" {} {} {}", equal, Style::new().bold().paint(prefix), msg)
+ };
+ eprintln!("{}", msg);
+ };
+ let ctx_help = |msg| ctx_prefixed("help:", msg);
+ let ctx_note = |msg| ctx_prefixed("note:", msg);
+ let ctx = |msg: &str| {
+ #[cfg(not(feature = "nu_ansi_term"))]
+ let msg = format!("note: {}", msg);
+ #[cfg(feature = "nu_ansi_term")]
+ let msg = {
+ let mut pipe = Color::Fixed(21).paint("|");
+ pipe.style_ref_mut().is_bold = true;
+ format!(" {} {}", pipe, msg)
+ };
+ eprintln!("{}", msg);
+ };
+ warn("some trace filter directives would enable traces that are disabled statically");
+ for directive in disabled {
+ let target = if let Some(target) = &directive.target {
+ format!("the `{}` target", target)
+ } else {
+ "all targets".into()
+ };
+ let level = directive
+ .level
+ .into_level()
+ .expect("=off would not have enabled any filters");
+ ctx(&format!(
+ "`{}` would enable the {} level for {}",
+ directive, level, target
+ ));
+ }
+ ctx_note(&format!("the static max level is `{}`", STATIC_MAX_LEVEL));
+ let help_msg = || {
+ let (feature, filter) = match STATIC_MAX_LEVEL.into_level() {
+ Some(Level::TRACE) => unreachable!(
+ "if the max level is trace, no static filtering features are enabled"
+ ),
+ Some(Level::DEBUG) => ("max_level_debug", Level::TRACE),
+ Some(Level::INFO) => ("max_level_info", Level::DEBUG),
+ Some(Level::WARN) => ("max_level_warn", Level::INFO),
+ Some(Level::ERROR) => ("max_level_error", Level::WARN),
+ None => return ("max_level_off", String::new()),
+ };
+ (feature, format!("{} ", filter))
+ };
+ let (feature, earlier_level) = help_msg();
+ ctx_help(&format!(
+ "to enable {}logging, remove the `{}` feature from the `tracing` crate",
+ earlier_level, feature
+ ));
+ }
+
+ let (dynamics, statics) = Directive::make_tables(directives);
+ let has_dynamics = !dynamics.is_empty();
+
+ let mut filter = EnvFilter {
+ statics,
+ dynamics,
+ has_dynamics,
+ by_id: RwLock::new(Default::default()),
+ by_cs: RwLock::new(Default::default()),
+ scope: ThreadLocal::new(),
+ regex: self.regex,
+ };
+
+ if !has_dynamics && filter.statics.is_empty() {
+ if let Some(ref default) = self.default_directive {
+ filter = filter.add_directive(default.clone());
+ }
+ }
+
+ filter
+ }
+
+ fn env_var_name(&self) -> &str {
+ self.env.as_deref().unwrap_or(EnvFilter::DEFAULT_ENV)
+ }
+}
+
+impl Default for Builder {
+ fn default() -> Self {
+ Self {
+ regex: true,
+ env: None,
+ default_directive: None,
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/env/directive.rs b/crates/tracing-subscriber/src/filter/env/directive.rs
new file mode 100644
index 0000000..d095065
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/env/directive.rs
@@ -0,0 +1,867 @@
+pub(crate) use crate::filter::directive::{FilterVec, ParseError, StaticDirective};
+use crate::filter::{
+ directive::{DirectiveSet, Match},
+ env::{field, FieldMap},
+ level::LevelFilter,
+};
+use once_cell::sync::Lazy;
+use regex::Regex;
+use std::{cmp::Ordering, fmt, iter::FromIterator, str::FromStr};
+use tracing_core::{span, Level, Metadata};
+
+/// A single filtering directive.
+// TODO(eliza): add a builder for programmatically constructing directives?
+#[derive(Clone, Debug, Eq, PartialEq)]
+#[cfg_attr(docsrs, doc(cfg(feature = "env-filter")))]
+pub struct Directive {
+ in_span: Option<String>,
+ fields: Vec<field::Match>,
+ pub(crate) target: Option<String>,
+ pub(crate) level: LevelFilter,
+}
+
+/// A set of dynamic filtering directives.
+pub(super) type Dynamics = DirectiveSet<Directive>;
+
+/// A set of static filtering directives.
+pub(super) type Statics = DirectiveSet<StaticDirective>;
+
+pub(crate) type CallsiteMatcher = MatchSet<field::CallsiteMatch>;
+pub(crate) type SpanMatcher = MatchSet<field::SpanMatch>;
+
+#[derive(Debug, PartialEq, Eq)]
+pub(crate) struct MatchSet<T> {
+ field_matches: FilterVec<T>,
+ base_level: LevelFilter,
+}
+
+impl Directive {
+ pub(super) fn has_name(&self) -> bool {
+ self.in_span.is_some()
+ }
+
+ pub(super) fn has_fields(&self) -> bool {
+ !self.fields.is_empty()
+ }
+
+ pub(super) fn to_static(&self) -> Option<StaticDirective> {
+ if !self.is_static() {
+ return None;
+ }
+
+ // TODO(eliza): these strings are all immutable; we should consider
+ // `Arc`ing them to make this more efficient...
+ let field_names = self.fields.iter().map(field::Match::name).collect();
+
+ Some(StaticDirective::new(
+ self.target.clone(),
+ field_names,
+ self.level,
+ ))
+ }
+
+ fn is_static(&self) -> bool {
+ !self.has_name() && !self.fields.iter().any(field::Match::has_value)
+ }
+
+ pub(super) fn is_dynamic(&self) -> bool {
+ self.has_name() || self.has_fields()
+ }
+
+ pub(crate) fn field_matcher(&self, meta: &Metadata<'_>) -> Option<field::CallsiteMatch> {
+ let fieldset = meta.fields();
+ let fields = self
+ .fields
+ .iter()
+ .filter_map(
+ |field::Match {
+ ref name,
+ ref value,
+ }| {
+ if let Some(field) = fieldset.field(name) {
+ let value = value.as_ref().cloned()?;
+ Some(Ok((field, value)))
+ } else {
+ Some(Err(()))
+ }
+ },
+ )
+ .collect::<Result<FieldMap<_>, ()>>()
+ .ok()?;
+ Some(field::CallsiteMatch {
+ fields,
+ level: self.level,
+ })
+ }
+
+ pub(super) fn make_tables(
+ directives: impl IntoIterator<Item = Directive>,
+ ) -> (Dynamics, Statics) {
+ // TODO(eliza): this could be made more efficient...
+ let (dyns, stats): (Vec<Directive>, Vec<Directive>) =
+ directives.into_iter().partition(Directive::is_dynamic);
+ let statics = stats
+ .into_iter()
+ .filter_map(|d| d.to_static())
+ .chain(dyns.iter().filter_map(Directive::to_static))
+ .collect();
+ (Dynamics::from_iter(dyns), statics)
+ }
+
+ pub(super) fn deregexify(&mut self) {
+ for field in &mut self.fields {
+ field.value = match field.value.take() {
+ Some(field::ValueMatch::Pat(pat)) => {
+ Some(field::ValueMatch::Debug(pat.into_debug_match()))
+ }
+ x => x,
+ }
+ }
+ }
+
+ pub(super) fn parse(from: &str, regex: bool) -> Result<Self, ParseError> {
+ static DIRECTIVE_RE: Lazy<Regex> = Lazy::new(|| {
+ Regex::new(
+ r"(?x)
+ ^(?P<global_level>(?i:trace|debug|info|warn|error|off|[0-5]))$ |
+ # ^^^.
+ # `note: we match log level names case-insensitively
+ ^
+ (?: # target name or span name
+ (?P<target>[\w:-]+)|(?P<span>\[[^\]]*\])
+ ){1,2}
+ (?: # level or nothing
+ =(?P<level>(?i:trace|debug|info|warn|error|off|[0-5]))?
+ # ^^^.
+ # `note: we match log level names case-insensitively
+ )?
+ $
+ ",
+ )
+ .unwrap()
+ });
+ static SPAN_PART_RE: Lazy<Regex> =
+ Lazy::new(|| Regex::new(r"(?P<name>[^\]\{]+)?(?:\{(?P<fields>[^\}]*)\})?").unwrap());
+ static FIELD_FILTER_RE: Lazy<Regex> =
+ // TODO(eliza): this doesn't _currently_ handle value matchers that include comma
+ // characters. We should fix that.
+ Lazy::new(|| {
+ Regex::new(
+ r"(?x)
+ (
+ # field name
+ [[:word:]][[[:word:]]\.]*
+ # value part (optional)
+ (?:=[^,]+)?
+ )
+ # trailing comma or EOS
+ (?:,\s?|$)
+ ",
+ )
+ .unwrap()
+ });
+
+ let caps = DIRECTIVE_RE.captures(from).ok_or_else(ParseError::new)?;
+
+ if let Some(level) = caps
+ .name("global_level")
+ .and_then(|s| s.as_str().parse().ok())
+ {
+ return Ok(Directive {
+ level,
+ ..Default::default()
+ });
+ }
+
+ let target = caps.name("target").and_then(|c| {
+ let s = c.as_str();
+ if s.parse::<LevelFilter>().is_ok() {
+ None
+ } else {
+ Some(s.to_owned())
+ }
+ });
+
+ let (in_span, fields) = caps
+ .name("span")
+ .and_then(|cap| {
+ let cap = cap.as_str().trim_matches(|c| c == '[' || c == ']');
+ let caps = SPAN_PART_RE.captures(cap)?;
+ let span = caps.name("name").map(|c| c.as_str().to_owned());
+ let fields = caps
+ .name("fields")
+ .map(|c| {
+ FIELD_FILTER_RE
+ .find_iter(c.as_str())
+ .map(|c| field::Match::parse(c.as_str(), regex))
+ .collect::<Result<Vec<_>, _>>()
+ })
+ .unwrap_or_else(|| Ok(Vec::new()));
+ Some((span, fields))
+ })
+ .unwrap_or_else(|| (None, Ok(Vec::new())));
+
+ let level = caps
+ .name("level")
+ .and_then(|l| l.as_str().parse().ok())
+ // Setting the target without the level enables every level for that target
+ .unwrap_or(LevelFilter::TRACE);
+
+ Ok(Self {
+ level,
+ target,
+ in_span,
+ fields: fields?,
+ })
+ }
+}
+
+impl Match for Directive {
+ fn cares_about(&self, meta: &Metadata<'_>) -> bool {
+ // Does this directive have a target filter, and does it match the
+ // metadata's target?
+ if let Some(ref target) = self.target {
+ if !meta.target().starts_with(&target[..]) {
+ return false;
+ }
+ }
+
+ // Do we have a name filter, and does it match the metadata's name?
+ // TODO(eliza): put name globbing here?
+ if let Some(ref name) = self.in_span {
+ if name != meta.name() {
+ return false;
+ }
+ }
+
+ // Does the metadata define all the fields that this directive cares about?
+ let actual_fields = meta.fields();
+ for expected_field in &self.fields {
+ // Does the actual field set (from the metadata) contain this field?
+ if actual_fields.field(&expected_field.name).is_none() {
+ return false;
+ }
+ }
+
+ true
+ }
+
+ fn level(&self) -> &LevelFilter {
+ &self.level
+ }
+}
+
+impl FromStr for Directive {
+ type Err = ParseError;
+ fn from_str(from: &str) -> Result<Self, Self::Err> {
+ Directive::parse(from, true)
+ }
+}
+
+impl Default for Directive {
+ fn default() -> Self {
+ Directive {
+ level: LevelFilter::OFF,
+ target: None,
+ in_span: None,
+ fields: Vec::new(),
+ }
+ }
+}
+
+impl PartialOrd for Directive {
+ fn partial_cmp(&self, other: &Directive) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+}
+
+impl Ord for Directive {
+ fn cmp(&self, other: &Directive) -> Ordering {
+ // We attempt to order directives by how "specific" they are. This
+ // ensures that we try the most specific directives first when
+ // attempting to match a piece of metadata.
+
+ // First, we compare based on whether a target is specified, and the
+ // lengths of those targets if both have targets.
+ let ordering = self
+ .target
+ .as_ref()
+ .map(String::len)
+ .cmp(&other.target.as_ref().map(String::len))
+ // Next compare based on the presence of span names.
+ .then_with(|| self.in_span.is_some().cmp(&other.in_span.is_some()))
+ // Then we compare how many fields are defined by each
+ // directive.
+ .then_with(|| self.fields.len().cmp(&other.fields.len()))
+ // Finally, we fall back to lexicographical ordering if the directives are
+ // equally specific. Although this is no longer semantically important,
+ // we need to define a total ordering to determine the directive's place
+ // in the BTreeMap.
+ .then_with(|| {
+ self.target
+ .cmp(&other.target)
+ .then_with(|| self.in_span.cmp(&other.in_span))
+ .then_with(|| self.fields[..].cmp(&other.fields[..]))
+ })
+ .reverse();
+
+ #[cfg(debug_assertions)]
+ {
+ if ordering == Ordering::Equal {
+ debug_assert_eq!(
+ self.target, other.target,
+ "invariant violated: Ordering::Equal must imply a.target == b.target"
+ );
+ debug_assert_eq!(
+ self.in_span, other.in_span,
+ "invariant violated: Ordering::Equal must imply a.in_span == b.in_span"
+ );
+ debug_assert_eq!(
+ self.fields, other.fields,
+ "invariant violated: Ordering::Equal must imply a.fields == b.fields"
+ );
+ }
+ }
+
+ ordering
+ }
+}
+
+impl fmt::Display for Directive {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut wrote_any = false;
+ if let Some(ref target) = self.target {
+ fmt::Display::fmt(target, f)?;
+ wrote_any = true;
+ }
+
+ if self.in_span.is_some() || !self.fields.is_empty() {
+ f.write_str("[")?;
+
+ if let Some(ref span) = self.in_span {
+ fmt::Display::fmt(span, f)?;
+ }
+
+ let mut fields = self.fields.iter();
+ if let Some(field) = fields.next() {
+ write!(f, "{{{}", field)?;
+ for field in fields {
+ write!(f, ",{}", field)?;
+ }
+ f.write_str("}")?;
+ }
+
+ f.write_str("]")?;
+ wrote_any = true;
+ }
+
+ if wrote_any {
+ f.write_str("=")?;
+ }
+
+ fmt::Display::fmt(&self.level, f)
+ }
+}
+
+impl From<LevelFilter> for Directive {
+ fn from(level: LevelFilter) -> Self {
+ Self {
+ level,
+ ..Self::default()
+ }
+ }
+}
+
+impl From<Level> for Directive {
+ fn from(level: Level) -> Self {
+ LevelFilter::from_level(level).into()
+ }
+}
+
+// === impl Dynamics ===
+
+impl Dynamics {
+ pub(crate) fn matcher(&self, metadata: &Metadata<'_>) -> Option<CallsiteMatcher> {
+ let mut base_level = None;
+ let field_matches = self
+ .directives_for(metadata)
+ .filter_map(|d| {
+ if let Some(f) = d.field_matcher(metadata) {
+ return Some(f);
+ }
+ match base_level {
+ Some(ref b) if d.level > *b => base_level = Some(d.level),
+ None => base_level = Some(d.level),
+ _ => {}
+ }
+ None
+ })
+ .collect();
+
+ if let Some(base_level) = base_level {
+ Some(CallsiteMatcher {
+ field_matches,
+ base_level,
+ })
+ } else if !field_matches.is_empty() {
+ Some(CallsiteMatcher {
+ field_matches,
+ base_level: base_level.unwrap_or(LevelFilter::OFF),
+ })
+ } else {
+ None
+ }
+ }
+
+ pub(crate) fn has_value_filters(&self) -> bool {
+ self.directives()
+ .any(|d| d.fields.iter().any(|f| f.value.is_some()))
+ }
+}
+
+// ===== impl DynamicMatch =====
+
+impl CallsiteMatcher {
+ /// Create a new `SpanMatch` for a given instance of the matched callsite.
+ pub(crate) fn to_span_match(&self, attrs: &span::Attributes<'_>) -> SpanMatcher {
+ let field_matches = self
+ .field_matches
+ .iter()
+ .map(|m| {
+ let m = m.to_span_match();
+ attrs.record(&mut m.visitor());
+ m
+ })
+ .collect();
+ SpanMatcher {
+ field_matches,
+ base_level: self.base_level,
+ }
+ }
+}
+
+impl SpanMatcher {
+ /// Returns the level currently enabled for this callsite.
+ pub(crate) fn level(&self) -> LevelFilter {
+ self.field_matches
+ .iter()
+ .filter_map(field::SpanMatch::filter)
+ .max()
+ .unwrap_or(self.base_level)
+ }
+
+ pub(crate) fn record_update(&self, record: &span::Record<'_>) {
+ for m in &self.field_matches {
+ record.record(&mut m.visitor())
+ }
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+
+ fn parse_directives(dirs: impl AsRef<str>) -> Vec<Directive> {
+ dirs.as_ref()
+ .split(',')
+ .filter_map(|s| s.parse().ok())
+ .collect()
+ }
+
+ fn expect_parse(dirs: impl AsRef<str>) -> Vec<Directive> {
+ dirs.as_ref()
+ .split(',')
+ .map(|s| {
+ s.parse()
+ .unwrap_or_else(|err| panic!("directive '{:?}' should parse: {}", s, err))
+ })
+ .collect()
+ }
+
+ #[test]
+ fn directive_ordering_by_target_len() {
+ // TODO(eliza): it would be nice to have a property-based test for this
+ // instead.
+ let mut dirs = expect_parse(
+ "foo::bar=debug,foo::bar::baz=trace,foo=info,a_really_long_name_with_no_colons=warn",
+ );
+ dirs.sort_unstable();
+
+ let expected = vec![
+ "a_really_long_name_with_no_colons",
+ "foo::bar::baz",
+ "foo::bar",
+ "foo",
+ ];
+ let sorted = dirs
+ .iter()
+ .map(|d| d.target.as_ref().unwrap())
+ .collect::<Vec<_>>();
+
+ assert_eq!(expected, sorted);
+ }
+ #[test]
+ fn directive_ordering_by_span() {
+ // TODO(eliza): it would be nice to have a property-based test for this
+ // instead.
+ let mut dirs = expect_parse("bar[span]=trace,foo=debug,baz::quux=info,a[span]=warn");
+ dirs.sort_unstable();
+
+ let expected = vec!["baz::quux", "bar", "foo", "a"];
+ let sorted = dirs
+ .iter()
+ .map(|d| d.target.as_ref().unwrap())
+ .collect::<Vec<_>>();
+
+ assert_eq!(expected, sorted);
+ }
+
+ #[test]
+ fn directive_ordering_uses_lexicographic_when_equal() {
+ // TODO(eliza): it would be nice to have a property-based test for this
+ // instead.
+ let mut dirs = expect_parse("span[b]=debug,b=debug,a=trace,c=info,span[a]=info");
+ dirs.sort_unstable();
+
+ let expected = vec![
+ ("span", Some("b")),
+ ("span", Some("a")),
+ ("c", None),
+ ("b", None),
+ ("a", None),
+ ];
+ let sorted = dirs
+ .iter()
+ .map(|d| {
+ (
+ d.target.as_ref().unwrap().as_ref(),
+ d.in_span.as_ref().map(String::as_ref),
+ )
+ })
+ .collect::<Vec<_>>();
+
+ assert_eq!(expected, sorted);
+ }
+
+ // TODO: this test requires the parser to support directives with multiple
+ // fields, which it currently can't handle. We should enable this test when
+ // that's implemented.
+ #[test]
+ #[ignore]
+ fn directive_ordering_by_field_num() {
+ // TODO(eliza): it would be nice to have a property-based test for this
+ // instead.
+ let mut dirs = expect_parse(
+ "b[{foo,bar}]=info,c[{baz,quuux,quuux}]=debug,a[{foo}]=warn,bar[{field}]=trace,foo=debug,baz::quux=info"
+ );
+ dirs.sort_unstable();
+
+ let expected = vec!["baz::quux", "bar", "foo", "c", "b", "a"];
+ let sorted = dirs
+ .iter()
+ .map(|d| d.target.as_ref().unwrap())
+ .collect::<Vec<_>>();
+
+ assert_eq!(expected, sorted);
+ }
+
+ #[test]
+ fn parse_directives_ralith() {
+ let dirs = parse_directives("common=trace,server=trace");
+ assert_eq!(dirs.len(), 2, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("common".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::TRACE);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("server".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::TRACE);
+ assert_eq!(dirs[1].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_ralith_uc() {
+ let dirs = parse_directives("common=INFO,server=DEBUG");
+ assert_eq!(dirs.len(), 2, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("common".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::INFO);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("server".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[1].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_ralith_mixed() {
+ let dirs = parse_directives("common=iNfo,server=dEbUg");
+ assert_eq!(dirs.len(), 2, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("common".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::INFO);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("server".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[1].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_valid() {
+ let dirs = parse_directives("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off");
+ assert_eq!(dirs.len(), 4, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::ERROR);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::TRACE);
+ assert_eq!(dirs[1].in_span, None);
+
+ assert_eq!(dirs[2].target, Some("crate2".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[2].in_span, None);
+
+ assert_eq!(dirs[3].target, Some("crate3".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::OFF);
+ assert_eq!(dirs[3].in_span, None);
+ }
+
+ #[test]
+
+ fn parse_level_directives() {
+ let dirs = parse_directives(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off",
+ );
+ assert_eq!(dirs.len(), 6, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::ERROR);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::WARN);
+ assert_eq!(dirs[1].in_span, None);
+
+ assert_eq!(dirs[2].target, Some("crate1::mod2::mod3".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::INFO);
+ assert_eq!(dirs[2].in_span, None);
+
+ assert_eq!(dirs[3].target, Some("crate2".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[3].in_span, None);
+
+ assert_eq!(dirs[4].target, Some("crate3".to_string()));
+ assert_eq!(dirs[4].level, LevelFilter::TRACE);
+ assert_eq!(dirs[4].in_span, None);
+
+ assert_eq!(dirs[5].target, Some("crate3::mod2::mod1".to_string()));
+ assert_eq!(dirs[5].level, LevelFilter::OFF);
+ assert_eq!(dirs[5].in_span, None);
+ }
+
+ #[test]
+ fn parse_uppercase_level_directives() {
+ let dirs = parse_directives(
+ "crate1::mod1=ERROR,crate1::mod2=WARN,crate1::mod2::mod3=INFO,\
+ crate2=DEBUG,crate3=TRACE,crate3::mod2::mod1=OFF",
+ );
+ assert_eq!(dirs.len(), 6, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::ERROR);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::WARN);
+ assert_eq!(dirs[1].in_span, None);
+
+ assert_eq!(dirs[2].target, Some("crate1::mod2::mod3".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::INFO);
+ assert_eq!(dirs[2].in_span, None);
+
+ assert_eq!(dirs[3].target, Some("crate2".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[3].in_span, None);
+
+ assert_eq!(dirs[4].target, Some("crate3".to_string()));
+ assert_eq!(dirs[4].level, LevelFilter::TRACE);
+ assert_eq!(dirs[4].in_span, None);
+
+ assert_eq!(dirs[5].target, Some("crate3::mod2::mod1".to_string()));
+ assert_eq!(dirs[5].level, LevelFilter::OFF);
+ assert_eq!(dirs[5].in_span, None);
+ }
+
+ #[test]
+ fn parse_numeric_level_directives() {
+ let dirs = parse_directives(
+ "crate1::mod1=1,crate1::mod2=2,crate1::mod2::mod3=3,crate2=4,\
+ crate3=5,crate3::mod2::mod1=0",
+ );
+ assert_eq!(dirs.len(), 6, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::ERROR);
+ assert_eq!(dirs[0].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::WARN);
+ assert_eq!(dirs[1].in_span, None);
+
+ assert_eq!(dirs[2].target, Some("crate1::mod2::mod3".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::INFO);
+ assert_eq!(dirs[2].in_span, None);
+
+ assert_eq!(dirs[3].target, Some("crate2".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[3].in_span, None);
+
+ assert_eq!(dirs[4].target, Some("crate3".to_string()));
+ assert_eq!(dirs[4].level, LevelFilter::TRACE);
+ assert_eq!(dirs[4].in_span, None);
+
+ assert_eq!(dirs[5].target, Some("crate3::mod2::mod1".to_string()));
+ assert_eq!(dirs[5].level, LevelFilter::OFF);
+ assert_eq!(dirs[5].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_invalid_crate() {
+ // test parse_directives with multiple = in specification
+ let dirs = parse_directives("crate1::mod1=warn=info,crate2=debug");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate2".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_invalid_level() {
+ // test parse_directives with 'noNumber' as log level
+ let dirs = parse_directives("crate1::mod1=noNumber,crate2=debug");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate2".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_string_level() {
+ // test parse_directives with 'warn' as log level
+ let dirs = parse_directives("crate1::mod1=wrong,crate2=warn");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate2".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::WARN);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_empty_level() {
+ // test parse_directives with '' as log level
+ let dirs = parse_directives("crate1::mod1=wrong,crate2=");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate2".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::TRACE);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_global() {
+ // test parse_directives with no crate
+ let dirs = parse_directives("warn,crate2=debug");
+ assert_eq!(dirs.len(), 2, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, None);
+ assert_eq!(dirs[0].level, LevelFilter::WARN);
+ assert_eq!(dirs[1].in_span, None);
+
+ assert_eq!(dirs[1].target, Some("crate2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[1].in_span, None);
+ }
+
+ // helper function for tests below
+ fn test_parse_bare_level(directive_to_test: &str, level_expected: LevelFilter) {
+ let dirs = parse_directives(directive_to_test);
+ assert_eq!(
+ dirs.len(),
+ 1,
+ "\ninput: \"{}\"; parsed: {:#?}",
+ directive_to_test,
+ dirs
+ );
+ assert_eq!(dirs[0].target, None);
+ assert_eq!(dirs[0].level, level_expected);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_global_bare_warn_lc() {
+ // test parse_directives with no crate, in isolation, all lowercase
+ test_parse_bare_level("warn", LevelFilter::WARN);
+ }
+
+ #[test]
+ fn parse_directives_global_bare_warn_uc() {
+ // test parse_directives with no crate, in isolation, all uppercase
+ test_parse_bare_level("WARN", LevelFilter::WARN);
+ }
+
+ #[test]
+ fn parse_directives_global_bare_warn_mixed() {
+ // test parse_directives with no crate, in isolation, mixed case
+ test_parse_bare_level("wArN", LevelFilter::WARN);
+ }
+
+ #[test]
+ fn parse_directives_valid_with_spans() {
+ let dirs = parse_directives("crate1::mod1[foo]=error,crate1::mod2[bar],crate2[baz]=debug");
+ assert_eq!(dirs.len(), 3, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::ERROR);
+ assert_eq!(dirs[0].in_span, Some("foo".to_string()));
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::TRACE);
+ assert_eq!(dirs[1].in_span, Some("bar".to_string()));
+
+ assert_eq!(dirs[2].target, Some("crate2".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[2].in_span, Some("baz".to_string()));
+ }
+
+ #[test]
+ fn parse_directives_with_dash_in_target_name() {
+ let dirs = parse_directives("target-name=info");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("target-name".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::INFO);
+ assert_eq!(dirs[0].in_span, None);
+ }
+
+ #[test]
+ fn parse_directives_with_dash_in_span_name() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/1367
+
+ let dirs = parse_directives("target[span-name]=info");
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("target".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::INFO);
+ assert_eq!(dirs[0].in_span, Some("span-name".to_string()));
+ }
+
+ #[test]
+ fn parse_directives_with_special_characters_in_span_name() {
+ let span_name = "!\"#$%&'()*+-./:;<=>?@^_`|~[}";
+
+ let dirs = parse_directives(format!("target[{}]=info", span_name));
+ assert_eq!(dirs.len(), 1, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("target".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::INFO);
+ assert_eq!(dirs[0].in_span, Some(span_name.to_string()));
+ }
+
+ #[test]
+ fn parse_directives_with_invalid_span_chars() {
+ let invalid_span_name = "]{";
+
+ let dirs = parse_directives(format!("target[{}]=info", invalid_span_name));
+ assert_eq!(dirs.len(), 0, "\nparsed: {:#?}", dirs);
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/env/field.rs b/crates/tracing-subscriber/src/filter/env/field.rs
new file mode 100644
index 0000000..1394fd0
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/env/field.rs
@@ -0,0 +1,626 @@
+use matchers::Pattern;
+use std::{
+ cmp::Ordering,
+ error::Error,
+ fmt::{self, Write},
+ str::FromStr,
+ sync::{
+ atomic::{AtomicBool, Ordering::*},
+ Arc,
+ },
+};
+
+use super::{FieldMap, LevelFilter};
+use tracing_core::field::{Field, Visit};
+
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub(crate) struct Match {
+ pub(crate) name: String, // TODO: allow match patterns for names?
+ pub(crate) value: Option<ValueMatch>,
+}
+
+#[derive(Debug, Eq, PartialEq)]
+pub(crate) struct CallsiteMatch {
+ pub(crate) fields: FieldMap<ValueMatch>,
+ pub(crate) level: LevelFilter,
+}
+
+#[derive(Debug)]
+pub(crate) struct SpanMatch {
+ fields: FieldMap<(ValueMatch, AtomicBool)>,
+ level: LevelFilter,
+ has_matched: AtomicBool,
+}
+
+pub(crate) struct MatchVisitor<'a> {
+ inner: &'a SpanMatch,
+}
+
+#[derive(Debug, Clone)]
+pub(crate) enum ValueMatch {
+ /// Matches a specific `bool` value.
+ Bool(bool),
+ /// Matches a specific `f64` value.
+ F64(f64),
+ /// Matches a specific `u64` value.
+ U64(u64),
+ /// Matches a specific `i64` value.
+ I64(i64),
+ /// Matches any `NaN` `f64` value.
+ NaN,
+ /// Matches any field whose `fmt::Debug` output is equal to a fixed string.
+ Debug(MatchDebug),
+ /// Matches any field whose `fmt::Debug` output matches a regular expression
+ /// pattern.
+ Pat(Box<MatchPattern>),
+}
+
+impl Eq for ValueMatch {}
+
+impl PartialEq for ValueMatch {
+ fn eq(&self, other: &Self) -> bool {
+ use ValueMatch::*;
+ match (self, other) {
+ (Bool(a), Bool(b)) => a.eq(b),
+ (F64(a), F64(b)) => {
+ debug_assert!(!a.is_nan());
+ debug_assert!(!b.is_nan());
+
+ a.eq(b)
+ }
+ (U64(a), U64(b)) => a.eq(b),
+ (I64(a), I64(b)) => a.eq(b),
+ (NaN, NaN) => true,
+ (Pat(a), Pat(b)) => a.eq(b),
+ _ => false,
+ }
+ }
+}
+
+impl Ord for ValueMatch {
+ fn cmp(&self, other: &Self) -> Ordering {
+ use ValueMatch::*;
+ match (self, other) {
+ (Bool(this), Bool(that)) => this.cmp(that),
+ (Bool(_), _) => Ordering::Less,
+
+ (F64(this), F64(that)) => this
+ .partial_cmp(that)
+ .expect("`ValueMatch::F64` may not contain `NaN` values"),
+ (F64(_), Bool(_)) => Ordering::Greater,
+ (F64(_), _) => Ordering::Less,
+
+ (NaN, NaN) => Ordering::Equal,
+ (NaN, Bool(_)) | (NaN, F64(_)) => Ordering::Greater,
+ (NaN, _) => Ordering::Less,
+
+ (U64(this), U64(that)) => this.cmp(that),
+ (U64(_), Bool(_)) | (U64(_), F64(_)) | (U64(_), NaN) => Ordering::Greater,
+ (U64(_), _) => Ordering::Less,
+
+ (I64(this), I64(that)) => this.cmp(that),
+ (I64(_), Bool(_)) | (I64(_), F64(_)) | (I64(_), NaN) | (I64(_), U64(_)) => {
+ Ordering::Greater
+ }
+ (I64(_), _) => Ordering::Less,
+
+ (Pat(this), Pat(that)) => this.cmp(that),
+ (Pat(_), _) => Ordering::Greater,
+
+ (Debug(this), Debug(that)) => this.cmp(that),
+ (Debug(_), _) => Ordering::Greater,
+ }
+ }
+}
+
+impl PartialOrd for ValueMatch {
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+}
+
+/// Matches a field's `fmt::Debug` output against a regular expression pattern.
+///
+/// This is used for matching all non-literal field value filters when regular
+/// expressions are enabled.
+#[derive(Debug, Clone)]
+pub(crate) struct MatchPattern {
+ pub(crate) matcher: Pattern,
+ pattern: Arc<str>,
+}
+
+/// Matches a field's `fmt::Debug` output against a fixed string pattern.
+///
+/// This is used for matching all non-literal field value filters when regular
+/// expressions are disabled.
+#[derive(Debug, Clone)]
+pub(crate) struct MatchDebug {
+ pattern: Arc<str>,
+}
+
+/// Indicates that a field name specified in a filter directive was invalid.
+#[derive(Clone, Debug)]
+#[cfg_attr(docsrs, doc(cfg(feature = "env-filter")))]
+pub struct BadName {
+ name: String,
+}
+
+// === impl Match ===
+
+impl Match {
+ pub(crate) fn has_value(&self) -> bool {
+ self.value.is_some()
+ }
+
+ // TODO: reference count these strings?
+ pub(crate) fn name(&self) -> String {
+ self.name.clone()
+ }
+
+ pub(crate) fn parse(s: &str, regex: bool) -> Result<Self, Box<dyn Error + Send + Sync>> {
+ let mut parts = s.split('=');
+ let name = parts
+ .next()
+ .ok_or_else(|| BadName {
+ name: "".to_string(),
+ })?
+ // TODO: validate field name
+ .to_string();
+ let value = parts
+ .next()
+ .map(|part| match regex {
+ true => ValueMatch::parse_regex(part),
+ false => Ok(ValueMatch::parse_non_regex(part)),
+ })
+ .transpose()?;
+ Ok(Match { name, value })
+ }
+}
+
+impl fmt::Display for Match {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&self.name, f)?;
+ if let Some(ref value) = self.value {
+ write!(f, "={}", value)?;
+ }
+ Ok(())
+ }
+}
+
+impl Ord for Match {
+ fn cmp(&self, other: &Self) -> Ordering {
+ // Ordering for `Match` directives is based first on _whether_ a value
+ // is matched or not. This is semantically meaningful --- we would
+ // prefer to check directives that match values first as they are more
+ // specific.
+ let has_value = match (self.value.as_ref(), other.value.as_ref()) {
+ (Some(_), None) => Ordering::Greater,
+ (None, Some(_)) => Ordering::Less,
+ _ => Ordering::Equal,
+ };
+ // If both directives match a value, we fall back to the field names in
+ // length + lexicographic ordering, and if these are equal as well, we
+ // compare the match directives.
+ //
+ // This ordering is no longer semantically meaningful but is necessary
+ // so that the directives can be stored in the `BTreeMap` in a defined
+ // order.
+ has_value
+ .then_with(|| self.name.cmp(&other.name))
+ .then_with(|| self.value.cmp(&other.value))
+ }
+}
+
+impl PartialOrd for Match {
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+}
+
+// === impl ValueMatch ===
+
+fn value_match_f64(v: f64) -> ValueMatch {
+ if v.is_nan() {
+ ValueMatch::NaN
+ } else {
+ ValueMatch::F64(v)
+ }
+}
+
+impl ValueMatch {
+ /// Parse a `ValueMatch` that will match `fmt::Debug` fields using regular
+ /// expressions.
+ ///
+ /// This returns an error if the string didn't contain a valid `bool`,
+ /// `u64`, `i64`, or `f64` literal, and couldn't be parsed as a regular
+ /// expression.
+ fn parse_regex(s: &str) -> Result<Self, matchers::Error> {
+ s.parse::<bool>()
+ .map(ValueMatch::Bool)
+ .or_else(|_| s.parse::<u64>().map(ValueMatch::U64))
+ .or_else(|_| s.parse::<i64>().map(ValueMatch::I64))
+ .or_else(|_| s.parse::<f64>().map(value_match_f64))
+ .or_else(|_| {
+ s.parse::<MatchPattern>()
+ .map(|p| ValueMatch::Pat(Box::new(p)))
+ })
+ }
+
+ /// Parse a `ValueMatch` that will match `fmt::Debug` against a fixed
+ /// string.
+ ///
+ /// This does *not* return an error, because any string that isn't a valid
+ /// `bool`, `u64`, `i64`, or `f64` literal is treated as expected
+ /// `fmt::Debug` output.
+ fn parse_non_regex(s: &str) -> Self {
+ s.parse::<bool>()
+ .map(ValueMatch::Bool)
+ .or_else(|_| s.parse::<u64>().map(ValueMatch::U64))
+ .or_else(|_| s.parse::<i64>().map(ValueMatch::I64))
+ .or_else(|_| s.parse::<f64>().map(value_match_f64))
+ .unwrap_or_else(|_| ValueMatch::Debug(MatchDebug::new(s)))
+ }
+}
+
+impl fmt::Display for ValueMatch {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ ValueMatch::Bool(ref inner) => fmt::Display::fmt(inner, f),
+ ValueMatch::F64(ref inner) => fmt::Display::fmt(inner, f),
+ ValueMatch::NaN => fmt::Display::fmt(&std::f64::NAN, f),
+ ValueMatch::I64(ref inner) => fmt::Display::fmt(inner, f),
+ ValueMatch::U64(ref inner) => fmt::Display::fmt(inner, f),
+ ValueMatch::Debug(ref inner) => fmt::Display::fmt(inner, f),
+ ValueMatch::Pat(ref inner) => fmt::Display::fmt(inner, f),
+ }
+ }
+}
+
+// === impl MatchPattern ===
+
+impl FromStr for MatchPattern {
+ type Err = matchers::Error;
+ fn from_str(s: &str) -> Result<Self, Self::Err> {
+ let matcher = s.parse::<Pattern>()?;
+ Ok(Self {
+ matcher,
+ pattern: s.to_owned().into(),
+ })
+ }
+}
+
+impl fmt::Display for MatchPattern {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&*self.pattern, f)
+ }
+}
+
+impl AsRef<str> for MatchPattern {
+ #[inline]
+ fn as_ref(&self) -> &str {
+ self.pattern.as_ref()
+ }
+}
+
+impl MatchPattern {
+ #[inline]
+ fn str_matches(&self, s: &impl AsRef<str>) -> bool {
+ self.matcher.matches(s)
+ }
+
+ #[inline]
+ fn debug_matches(&self, d: &impl fmt::Debug) -> bool {
+ self.matcher.debug_matches(d)
+ }
+
+ pub(super) fn into_debug_match(self) -> MatchDebug {
+ MatchDebug {
+ pattern: self.pattern,
+ }
+ }
+}
+
+impl PartialEq for MatchPattern {
+ #[inline]
+ fn eq(&self, other: &Self) -> bool {
+ self.pattern == other.pattern
+ }
+}
+
+impl Eq for MatchPattern {}
+
+impl PartialOrd for MatchPattern {
+ #[inline]
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ Some(self.pattern.cmp(&other.pattern))
+ }
+}
+
+impl Ord for MatchPattern {
+ #[inline]
+ fn cmp(&self, other: &Self) -> Ordering {
+ self.pattern.cmp(&other.pattern)
+ }
+}
+
+// === impl MatchDebug ===
+
+impl MatchDebug {
+ fn new(s: &str) -> Self {
+ Self {
+ pattern: s.to_owned().into(),
+ }
+ }
+
+ #[inline]
+ fn debug_matches(&self, d: &impl fmt::Debug) -> bool {
+ // Naively, we would probably match a value's `fmt::Debug` output by
+ // formatting it to a string, and then checking if the string is equal
+ // to the expected pattern. However, this would require allocating every
+ // time we want to match a field value against a `Debug` matcher, which
+ // can be avoided.
+ //
+ // Instead, we implement `fmt::Write` for a type that, rather than
+ // actually _writing_ the strings to something, matches them against the
+ // expected pattern, and returns an error if the pattern does not match.
+ struct Matcher<'a> {
+ pattern: &'a str,
+ }
+
+ impl fmt::Write for Matcher<'_> {
+ fn write_str(&mut self, s: &str) -> fmt::Result {
+ // If the string is longer than the remaining expected string,
+ // we know it won't match, so bail.
+ if s.len() > self.pattern.len() {
+ return Err(fmt::Error);
+ }
+
+ // If the expected string begins with the string that was
+ // written, we are still potentially a match. Advance the
+ // position in the expected pattern to chop off the matched
+ // output, and continue.
+ if self.pattern.starts_with(s) {
+ self.pattern = &self.pattern[s.len()..];
+ return Ok(());
+ }
+
+ // Otherwise, the expected string doesn't include the string
+ // that was written at the current position, so the `fmt::Debug`
+ // output doesn't match! Return an error signalling that this
+ // doesn't match.
+ Err(fmt::Error)
+ }
+ }
+ let mut matcher = Matcher {
+ pattern: &self.pattern,
+ };
+
+ // Try to "write" the value's `fmt::Debug` output to a `Matcher`. This
+ // returns an error if the `fmt::Debug` implementation wrote any
+ // characters that did not match the expected pattern.
+ write!(matcher, "{:?}", d).is_ok()
+ }
+}
+
+impl fmt::Display for MatchDebug {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&*self.pattern, f)
+ }
+}
+
+impl AsRef<str> for MatchDebug {
+ #[inline]
+ fn as_ref(&self) -> &str {
+ self.pattern.as_ref()
+ }
+}
+
+impl PartialEq for MatchDebug {
+ #[inline]
+ fn eq(&self, other: &Self) -> bool {
+ self.pattern == other.pattern
+ }
+}
+
+impl Eq for MatchDebug {}
+
+impl PartialOrd for MatchDebug {
+ #[inline]
+ fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+ Some(self.pattern.cmp(&other.pattern))
+ }
+}
+
+impl Ord for MatchDebug {
+ #[inline]
+ fn cmp(&self, other: &Self) -> Ordering {
+ self.pattern.cmp(&other.pattern)
+ }
+}
+
+// === impl BadName ===
+
+impl Error for BadName {}
+
+impl fmt::Display for BadName {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "invalid field name `{}`", self.name)
+ }
+}
+
+impl CallsiteMatch {
+ pub(crate) fn to_span_match(&self) -> SpanMatch {
+ let fields = self
+ .fields
+ .iter()
+ .map(|(k, v)| (k.clone(), (v.clone(), AtomicBool::new(false))))
+ .collect();
+ SpanMatch {
+ fields,
+ level: self.level,
+ has_matched: AtomicBool::new(false),
+ }
+ }
+}
+
+impl SpanMatch {
+ pub(crate) fn visitor(&self) -> MatchVisitor<'_> {
+ MatchVisitor { inner: self }
+ }
+
+ #[inline]
+ pub(crate) fn is_matched(&self) -> bool {
+ if self.has_matched.load(Acquire) {
+ return true;
+ }
+ self.is_matched_slow()
+ }
+
+ #[inline(never)]
+ fn is_matched_slow(&self) -> bool {
+ let matched = self
+ .fields
+ .values()
+ .all(|(_, matched)| matched.load(Acquire));
+ if matched {
+ self.has_matched.store(true, Release);
+ }
+ matched
+ }
+
+ #[inline]
+ pub(crate) fn filter(&self) -> Option<LevelFilter> {
+ if self.is_matched() {
+ Some(self.level)
+ } else {
+ None
+ }
+ }
+}
+
+impl<'a> Visit for MatchVisitor<'a> {
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::NaN, ref matched)) if value.is_nan() => {
+ matched.store(true, Release);
+ }
+ Some((ValueMatch::F64(ref e), ref matched))
+ if (value - *e).abs() < std::f64::EPSILON =>
+ {
+ matched.store(true, Release);
+ }
+ _ => {}
+ }
+ }
+
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ use std::convert::TryInto;
+
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::I64(ref e), ref matched)) if value == *e => {
+ matched.store(true, Release);
+ }
+ Some((ValueMatch::U64(ref e), ref matched)) if Ok(value) == (*e).try_into() => {
+ matched.store(true, Release);
+ }
+ _ => {}
+ }
+ }
+
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::U64(ref e), ref matched)) if value == *e => {
+ matched.store(true, Release);
+ }
+ _ => {}
+ }
+ }
+
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::Bool(ref e), ref matched)) if value == *e => {
+ matched.store(true, Release);
+ }
+ _ => {}
+ }
+ }
+
+ fn record_str(&mut self, field: &Field, value: &str) {
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::Pat(ref e), ref matched)) if e.str_matches(&value) => {
+ matched.store(true, Release);
+ }
+ Some((ValueMatch::Debug(ref e), ref matched)) if e.debug_matches(&value) => {
+ matched.store(true, Release)
+ }
+ _ => {}
+ }
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ match self.inner.fields.get(field) {
+ Some((ValueMatch::Pat(ref e), ref matched)) if e.debug_matches(&value) => {
+ matched.store(true, Release);
+ }
+ Some((ValueMatch::Debug(ref e), ref matched)) if e.debug_matches(&value) => {
+ matched.store(true, Release)
+ }
+ _ => {}
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ #[derive(Debug)]
+ #[allow(dead_code)]
+ struct MyStruct {
+ answer: usize,
+ question: &'static str,
+ }
+
+ #[test]
+ fn debug_struct_match() {
+ let my_struct = MyStruct {
+ answer: 42,
+ question: "life, the universe, and everything",
+ };
+
+ let pattern = "MyStruct { answer: 42, question: \"life, the universe, and everything\" }";
+
+ assert_eq!(
+ format!("{:?}", my_struct),
+ pattern,
+ "`MyStruct`'s `Debug` impl doesn't output the expected string"
+ );
+
+ let matcher = MatchDebug {
+ pattern: pattern.into(),
+ };
+ assert!(matcher.debug_matches(&my_struct))
+ }
+
+ #[test]
+ fn debug_struct_not_match() {
+ let my_struct = MyStruct {
+ answer: 42,
+ question: "what shall we have for lunch?",
+ };
+
+ let pattern = "MyStruct { answer: 42, question: \"life, the universe, and everything\" }";
+
+ assert_eq!(
+ format!("{:?}", my_struct),
+ "MyStruct { answer: 42, question: \"what shall we have for lunch?\" }",
+ "`MyStruct`'s `Debug` impl doesn't output the expected string"
+ );
+
+ let matcher = MatchDebug {
+ pattern: pattern.into(),
+ };
+ assert!(!matcher.debug_matches(&my_struct))
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/env/mod.rs b/crates/tracing-subscriber/src/filter/env/mod.rs
new file mode 100644
index 0000000..81a9ae2
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/env/mod.rs
@@ -0,0 +1,991 @@
+//! A `Layer` that enables or disables spans and events based on a set of
+//! filtering directives.
+
+// these are publicly re-exported, but the compiler doesn't realize
+// that for some reason.
+#[allow(unreachable_pub)]
+pub use self::{builder::Builder, directive::Directive, field::BadName as BadFieldName};
+mod builder;
+mod directive;
+mod field;
+
+use crate::{
+ filter::LevelFilter,
+ layer::{Context, Layer},
+ sync::RwLock,
+};
+use directive::ParseError;
+use std::{cell::RefCell, collections::HashMap, env, error::Error, fmt, str::FromStr};
+use thread_local::ThreadLocal;
+use tracing_core::{
+ callsite,
+ field::Field,
+ span,
+ subscriber::{Interest, Subscriber},
+ Metadata,
+};
+
+/// A [`Layer`] which filters spans and events based on a set of filter
+/// directives.
+///
+/// `EnvFilter` implements both the [`Layer`](#impl-Layer<S>) and [`Filter`] traits, so it may
+/// be used for both [global filtering][global] and [per-layer filtering][plf],
+/// respectively. See [the documentation on filtering with `Layer`s][filtering]
+/// for details.
+///
+/// The [`Targets`] type implements a similar form of filtering, but without the
+/// ability to dynamically enable events based on the current span context, and
+/// without filtering on field values. When these features are not required,
+/// [`Targets`] provides a lighter-weight alternative to [`EnvFilter`].
+///
+/// # Directives
+///
+/// A filter consists of one or more comma-separated directives which match on [`Span`]s and [`Event`]s.
+/// Each directive may have a corresponding maximum verbosity [`level`] which
+/// enables (e.g., _selects for_) spans and events that match. Like `log`,
+/// `tracing` considers less exclusive levels (like `trace` or `info`) to be more
+/// verbose than more exclusive levels (like `error` or `warn`).
+///
+/// The directive syntax is similar to that of [`env_logger`]'s. At a high level, the syntax for directives
+/// consists of several parts:
+///
+/// ```text
+/// target[span{field=value}]=level
+/// ```
+///
+/// Each component (`target`, `span`, `field`, `value`, and `level`) will be covered in turn.
+///
+/// - `target` matches the event or span's target. In general, this is the module path and/or crate name.
+/// Examples of targets `h2`, `tokio::net`, or `tide::server`. For more information on targets,
+/// please refer to [`Metadata`]'s documentation.
+/// - `span` matches on the span's name. If a `span` directive is provided alongside a `target`,
+/// the `span` directive will match on spans _within_ the `target`.
+/// - `field` matches on [fields] within spans. Field names can also be supplied without a `value`
+/// and will match on any [`Span`] or [`Event`] that has a field with that name.
+/// For example: `[span{field=\"value\"}]=debug`, `[{field}]=trace`.
+/// - `value` matches on the value of a span's field. If a value is a numeric literal or a bool,
+/// it will match _only_ on that value. Otherwise, this filter matches the
+/// [`std::fmt::Debug`] output from the value.
+/// - `level` sets a maximum verbosity level accepted by this directive.
+///
+/// When a field value directive (`[{<FIELD NAME>=<FIELD_VALUE>}]=...`) matches a
+/// value's [`std::fmt::Debug`] output (i.e., the field value in the directive
+/// is not a `bool`, `i64`, `u64`, or `f64` literal), the matched pattern may be
+/// interpreted as either a regular expression or as the precise expected
+/// output of the field's [`std::fmt::Debug`] implementation. By default, these
+/// filters are interpreted as regular expressions, but this can be disabled
+/// using the [`Builder::with_regex`] builder method to use precise matching
+/// instead.
+///
+/// When field value filters are interpreted as regular expressions, the
+/// [`regex-automata` crate's regular expression syntax][re-syntax] is
+/// supported.
+///
+/// **Note**: When filters are constructed from potentially untrusted inputs,
+/// [disabling regular expression matching](Builder::with_regex) is strongly
+/// recommended.
+///
+/// ## Usage Notes
+///
+/// - The portion of the directive which is included within the square brackets is `tracing`-specific.
+/// - Any portion of the directive can be omitted.
+/// - The sole exception are the `field` and `value` directives. If a `value` is provided,
+/// a `field` must _also_ be provided. However, the converse does not hold, as fields can
+/// be matched without a value.
+/// - If only a level is provided, it will set the maximum level for all `Span`s and `Event`s
+/// that are not enabled by other filters.
+/// - A directive without a level will enable anything that it matches. This is equivalent to `=trace`.
+/// - When a crate has a dash in its name, the default target for events will be the
+/// crate's module path as it appears in Rust. This means every dash will be replaced
+/// with an underscore.
+/// - A dash in a target will only appear when being specified explicitly:
+/// `tracing::info!(target: "target-name", ...);`
+///
+/// ## Example Syntax
+///
+/// - `tokio::net=info` will enable all spans or events that:
+/// - have the `tokio::net` target,
+/// - at the level `info` or above.
+/// - `warn,tokio::net=info` will enable all spans and events that:
+/// - are at the level `warn` or above, *or*
+/// - have the `tokio::net` target at the level `info` or above.
+/// - `my_crate[span_a]=trace` will enable all spans and events that:
+/// - are within the `span_a` span or named `span_a` _if_ `span_a` has the target `my_crate`,
+/// - at the level `trace` or above.
+/// - `[span_b{name=\"bob\"}]` will enable all spans or event that:
+/// - have _any_ target,
+/// - are inside a span named `span_b`,
+/// - which has a field named `name` with value `bob`,
+/// - at _any_ level.
+///
+/// # Examples
+///
+/// Parsing an `EnvFilter` from the [default environment
+/// variable](EnvFilter::from_default_env) (`RUST_LOG`):
+///
+/// ```
+/// use tracing_subscriber::{EnvFilter, fmt, prelude::*};
+///
+/// tracing_subscriber::registry()
+/// .with(fmt::layer())
+/// .with(EnvFilter::from_default_env())
+/// .init();
+/// ```
+///
+/// Parsing an `EnvFilter` [from a user-provided environment
+/// variable](EnvFilter::from_env):
+///
+/// ```
+/// use tracing_subscriber::{EnvFilter, fmt, prelude::*};
+///
+/// tracing_subscriber::registry()
+/// .with(fmt::layer())
+/// .with(EnvFilter::from_env("MYAPP_LOG"))
+/// .init();
+/// ```
+///
+/// Using `EnvFilter` as a [per-layer filter][plf] to filter only a single
+/// [`Layer`]:
+///
+/// ```
+/// use tracing_subscriber::{EnvFilter, fmt, prelude::*};
+///
+/// // Parse an `EnvFilter` configuration from the `RUST_LOG`
+/// // environment variable.
+/// let filter = EnvFilter::from_default_env();
+///
+/// // Apply the filter to this layer *only*.
+/// let filtered_layer = fmt::layer().with_filter(filter);
+///
+/// // Some other layer, whose output we don't want to filter.
+/// let unfiltered_layer = // ...
+/// # fmt::layer();
+///
+/// tracing_subscriber::registry()
+/// .with(filtered_layer)
+/// .with(unfiltered_layer)
+/// .init();
+/// ```
+/// # Constructing `EnvFilter`s
+///
+/// An `EnvFilter` is be constructed by parsing a string containing one or more
+/// directives. The [`EnvFilter::new`] constructor parses an `EnvFilter` from a
+/// string, ignoring any invalid directives, while [`EnvFilter::try_new`]
+/// returns an error if invalid directives are encountered. Similarly, the
+/// [`EnvFilter::from_env`] and [`EnvFilter::try_from_env`] constructors parse
+/// an `EnvFilter` from the value of the provided environment variable, with
+/// lossy and strict validation, respectively.
+///
+/// A [builder](EnvFilter::builder) interface is available to set additional
+/// configuration options prior to parsing an `EnvFilter`. See the [`Builder`
+/// type's documentation](Builder) for details on the options that can be
+/// configured using the builder.
+///
+/// [`Span`]: tracing_core::span
+/// [fields]: tracing_core::Field
+/// [`Event`]: tracing_core::Event
+/// [`level`]: tracing_core::Level
+/// [`Metadata`]: tracing_core::Metadata
+/// [`Targets`]: crate::filter::Targets
+/// [`env_logger`]: https://crates.io/crates/env_logger
+/// [`Filter`]: #impl-Filter<S>
+/// [global]: crate::layer#global-filtering
+/// [plf]: crate::layer#per-layer-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+#[cfg_attr(docsrs, doc(cfg(all(feature = "env-filter", feature = "std"))))]
+#[derive(Debug)]
+pub struct EnvFilter {
+ statics: directive::Statics,
+ dynamics: directive::Dynamics,
+ has_dynamics: bool,
+ by_id: RwLock<HashMap<span::Id, directive::SpanMatcher>>,
+ by_cs: RwLock<HashMap<callsite::Identifier, directive::CallsiteMatcher>>,
+ scope: ThreadLocal<RefCell<Vec<LevelFilter>>>,
+ regex: bool,
+}
+
+type FieldMap<T> = HashMap<Field, T>;
+
+/// Indicates that an error occurred while parsing a `EnvFilter` from an
+/// environment variable.
+#[cfg_attr(docsrs, doc(cfg(all(feature = "env-filter", feature = "std"))))]
+#[derive(Debug)]
+pub struct FromEnvError {
+ kind: ErrorKind,
+}
+
+#[derive(Debug)]
+enum ErrorKind {
+ Parse(ParseError),
+ Env(env::VarError),
+}
+
+impl EnvFilter {
+ /// `RUST_LOG` is the default environment variable used by
+ /// [`EnvFilter::from_default_env`] and [`EnvFilter::try_from_default_env`].
+ ///
+ /// [`EnvFilter::from_default_env`]: EnvFilter::from_default_env()
+ /// [`EnvFilter::try_from_default_env`]: EnvFilter::try_from_default_env()
+ pub const DEFAULT_ENV: &'static str = "RUST_LOG";
+
+ // === constructors, etc ===
+
+ /// Returns a [builder] that can be used to configure a new [`EnvFilter`]
+ /// instance.
+ ///
+ /// The [`Builder`] type is used to set additional configurations, such as
+ /// [whether regular expressions are enabled](Builder::with_regex) or [the
+ /// default directive](Builder::with_default_directive) before parsing an
+ /// [`EnvFilter`] from a string or environment variable.
+ ///
+ /// [builder]: https://rust-unofficial.github.io/patterns/patterns/creational/builder.html
+ pub fn builder() -> Builder {
+ Builder::default()
+ }
+
+ /// Returns a new `EnvFilter` from the value of the `RUST_LOG` environment
+ /// variable, ignoring any invalid filter directives.
+ ///
+ /// If the environment variable is empty or not set, or if it contains only
+ /// invalid directives, a default directive enabling the [`ERROR`] level is
+ /// added.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// # fn docs() -> EnvFilter {
+ /// EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::ERROR.into())
+ /// .from_env_lossy()
+ /// # }
+ /// ```
+ ///
+ /// [`ERROR`]: tracing::Level::ERROR
+ pub fn from_default_env() -> Self {
+ Self::builder()
+ .with_default_directive(LevelFilter::ERROR.into())
+ .from_env_lossy()
+ }
+
+ /// Returns a new `EnvFilter` from the value of the given environment
+ /// variable, ignoring any invalid filter directives.
+ ///
+ /// If the environment variable is empty or not set, or if it contains only
+ /// invalid directives, a default directive enabling the [`ERROR`] level is
+ /// added.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// # fn docs() -> EnvFilter {
+ /// # let env = "";
+ /// EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::ERROR.into())
+ /// .with_env_var(env)
+ /// .from_env_lossy()
+ /// # }
+ /// ```
+ ///
+ /// [`ERROR`]: tracing::Level::ERROR
+ pub fn from_env<A: AsRef<str>>(env: A) -> Self {
+ Self::builder()
+ .with_default_directive(LevelFilter::ERROR.into())
+ .with_env_var(env.as_ref())
+ .from_env_lossy()
+ }
+
+ /// Returns a new `EnvFilter` from the directives in the given string,
+ /// ignoring any that are invalid.
+ ///
+ /// If the string is empty or contains only invalid directives, a default
+ /// directive enabling the [`ERROR`] level is added.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// # fn docs() -> EnvFilter {
+ /// # let directives = "";
+ /// EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::ERROR.into())
+ /// .parse_lossy(directives)
+ /// # }
+ /// ```
+ ///
+ /// [`ERROR`]: tracing::Level::ERROR
+ pub fn new<S: AsRef<str>>(directives: S) -> Self {
+ Self::builder()
+ .with_default_directive(LevelFilter::ERROR.into())
+ .parse_lossy(directives)
+ }
+
+ /// Returns a new `EnvFilter` from the directives in the given string,
+ /// or an error if any are invalid.
+ ///
+ /// If the string is empty, a default directive enabling the [`ERROR`] level
+ /// is added.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ ///
+ /// # fn docs() -> Result<EnvFilter, tracing_subscriber::filter::ParseError> {
+ /// # let directives = "";
+ /// EnvFilter::builder()
+ /// .with_default_directive(LevelFilter::ERROR.into())
+ /// .parse(directives)
+ /// # }
+ /// ```
+ ///
+ /// [`ERROR`]: tracing::Level::ERROR
+ pub fn try_new<S: AsRef<str>>(dirs: S) -> Result<Self, directive::ParseError> {
+ Self::builder().parse(dirs)
+ }
+
+ /// Returns a new `EnvFilter` from the value of the `RUST_LOG` environment
+ /// variable, or an error if the environment variable is unset or contains
+ /// any invalid filter directives.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::EnvFilter;
+ ///
+ /// # fn docs() -> Result<EnvFilter, tracing_subscriber::filter::FromEnvError> {
+ /// EnvFilter::builder().try_from_env()
+ /// # }
+ /// ```
+ pub fn try_from_default_env() -> Result<Self, FromEnvError> {
+ Self::builder().try_from_env()
+ }
+
+ /// Returns a new `EnvFilter` from the value of the given environment
+ /// variable, or an error if the environment variable is unset or contains
+ /// any invalid filter directives.
+ ///
+ /// To set additional configuration options prior to parsing the filter, use
+ /// the [`Builder`] type instead.
+ ///
+ /// This function is equivalent to the following:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::EnvFilter;
+ ///
+ /// # fn docs() -> Result<EnvFilter, tracing_subscriber::filter::FromEnvError> {
+ /// # let env = "";
+ /// EnvFilter::builder().with_env_var(env).try_from_env()
+ /// # }
+ /// ```
+ pub fn try_from_env<A: AsRef<str>>(env: A) -> Result<Self, FromEnvError> {
+ Self::builder().with_env_var(env.as_ref()).try_from_env()
+ }
+
+ /// Add a filtering directive to this `EnvFilter`.
+ ///
+ /// The added directive will be used in addition to any previously set
+ /// directives, either added using this method or provided when the filter
+ /// is constructed.
+ ///
+ /// Filters may be created from [`LevelFilter`] or [`Level`], which will
+ /// enable all traces at or below a certain verbosity level, or
+ /// parsed from a string specifying a directive.
+ ///
+ /// If a filter directive is inserted that matches exactly the same spans
+ /// and events as a previous filter, but sets a different level for those
+ /// spans and events, the previous directive is overwritten.
+ ///
+ /// [`LevelFilter`]: super::LevelFilter
+ /// [`Level`]: tracing_core::Level
+ ///
+ /// # Examples
+ ///
+ /// From [`LevelFilter`]:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ /// let mut filter = EnvFilter::from_default_env()
+ /// .add_directive(LevelFilter::INFO.into());
+ /// ```
+ ///
+ /// Or from [`Level`]:
+ ///
+ /// ```rust
+ /// # use tracing_subscriber::filter::{EnvFilter, LevelFilter};
+ /// # use tracing::Level;
+ /// let mut filter = EnvFilter::from_default_env()
+ /// .add_directive(Level::INFO.into());
+ /// ```
+ ///
+ /// Parsed from a string:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::filter::{EnvFilter, Directive};
+ ///
+ /// # fn try_mk_filter() -> Result<(), Box<dyn ::std::error::Error>> {
+ /// let mut filter = EnvFilter::try_from_default_env()?
+ /// .add_directive("my_crate::module=trace".parse()?)
+ /// .add_directive("my_crate::my_other_module::something=info".parse()?);
+ /// # Ok(())
+ /// # }
+ /// ```
+ /// In the above example, substitute `my_crate`, `module`, etc. with the
+ /// name your target crate/module is imported with. This might be
+ /// different from the package name in Cargo.toml (`-` is replaced by `_`).
+ /// Example, if the package name in your Cargo.toml is `MY-FANCY-LIB`, then
+ /// the corresponding Rust identifier would be `MY_FANCY_LIB`:
+ pub fn add_directive(mut self, mut directive: Directive) -> Self {
+ if !self.regex {
+ directive.deregexify();
+ }
+ if let Some(stat) = directive.to_static() {
+ self.statics.add(stat)
+ } else {
+ self.has_dynamics = true;
+ self.dynamics.add(directive);
+ }
+ self
+ }
+
+ // === filtering methods ===
+
+ /// Returns `true` if this `EnvFilter` would enable the provided `metadata`
+ /// in the current context.
+ ///
+ /// This is equivalent to calling the [`Layer::enabled`] or
+ /// [`Filter::enabled`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ pub fn enabled<S>(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool {
+ let level = metadata.level();
+
+ // is it possible for a dynamic filter directive to enable this event?
+ // if not, we can avoid the thread loca'l access + iterating over the
+ // spans in the current scope.
+ if self.has_dynamics && self.dynamics.max_level >= *level {
+ if metadata.is_span() {
+ // If the metadata is a span, see if we care about its callsite.
+ let enabled_by_cs = self
+ .by_cs
+ .read()
+ .ok()
+ .map(|by_cs| by_cs.contains_key(&metadata.callsite()))
+ .unwrap_or(false);
+ if enabled_by_cs {
+ return true;
+ }
+ }
+
+ let enabled_by_scope = {
+ let scope = self.scope.get_or_default().borrow();
+ for filter in &*scope {
+ if filter >= level {
+ return true;
+ }
+ }
+ false
+ };
+ if enabled_by_scope {
+ return true;
+ }
+ }
+
+ // is it possible for a static filter directive to enable this event?
+ if self.statics.max_level >= *level {
+ // Otherwise, fall back to checking if the callsite is
+ // statically enabled.
+ return self.statics.enabled(metadata);
+ }
+
+ false
+ }
+
+ /// Returns an optional hint of the highest [verbosity level][level] that
+ /// this `EnvFilter` will enable.
+ ///
+ /// This is equivalent to calling the [`Layer::max_level_hint`] or
+ /// [`Filter::max_level_hint`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ ///
+ /// [level]: tracing_core::metadata::Level
+ pub fn max_level_hint(&self) -> Option<LevelFilter> {
+ if self.dynamics.has_value_filters() {
+ // If we perform any filtering on span field *values*, we will
+ // enable *all* spans, because their field values are not known
+ // until recording.
+ return Some(LevelFilter::TRACE);
+ }
+ std::cmp::max(
+ self.statics.max_level.into(),
+ self.dynamics.max_level.into(),
+ )
+ }
+
+ /// Informs the filter that a new span was created.
+ ///
+ /// This is equivalent to calling the [`Layer::on_new_span`] or
+ /// [`Filter::on_new_span`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ pub fn on_new_span<S>(&self, attrs: &span::Attributes<'_>, id: &span::Id, _: Context<'_, S>) {
+ let by_cs = try_lock!(self.by_cs.read());
+ if let Some(cs) = by_cs.get(&attrs.metadata().callsite()) {
+ let span = cs.to_span_match(attrs);
+ try_lock!(self.by_id.write()).insert(id.clone(), span);
+ }
+ }
+
+ /// Informs the filter that the span with the provided `id` was entered.
+ ///
+ /// This is equivalent to calling the [`Layer::on_enter`] or
+ /// [`Filter::on_enter`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ pub fn on_enter<S>(&self, id: &span::Id, _: Context<'_, S>) {
+ // XXX: This is where _we_ could push IDs to the stack instead, and use
+ // that to allow changing the filter while a span is already entered.
+ // But that might be much less efficient...
+ if let Some(span) = try_lock!(self.by_id.read()).get(id) {
+ self.scope.get_or_default().borrow_mut().push(span.level());
+ }
+ }
+
+ /// Informs the filter that the span with the provided `id` was exited.
+ ///
+ /// This is equivalent to calling the [`Layer::on_exit`] or
+ /// [`Filter::on_exit`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ pub fn on_exit<S>(&self, id: &span::Id, _: Context<'_, S>) {
+ if self.cares_about_span(id) {
+ self.scope.get_or_default().borrow_mut().pop();
+ }
+ }
+
+ /// Informs the filter that the span with the provided `id` was closed.
+ ///
+ /// This is equivalent to calling the [`Layer::on_close`] or
+ /// [`Filter::on_close`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope.
+ pub fn on_close<S>(&self, id: span::Id, _: Context<'_, S>) {
+ // If we don't need to acquire a write lock, avoid doing so.
+ if !self.cares_about_span(&id) {
+ return;
+ }
+
+ let mut spans = try_lock!(self.by_id.write());
+ spans.remove(&id);
+ }
+
+ /// Informs the filter that the span with the provided `id` recorded the
+ /// provided field `values`.
+ ///
+ /// This is equivalent to calling the [`Layer::on_record`] or
+ /// [`Filter::on_record`] methods on `EnvFilter`'s implementations of those
+ /// traits, but it does not require the trait to be in scope
+ pub fn on_record<S>(&self, id: &span::Id, values: &span::Record<'_>, _: Context<'_, S>) {
+ if let Some(span) = try_lock!(self.by_id.read()).get(id) {
+ span.record_update(values);
+ }
+ }
+
+ fn cares_about_span(&self, span: &span::Id) -> bool {
+ let spans = try_lock!(self.by_id.read(), else return false);
+ spans.contains_key(span)
+ }
+
+ fn base_interest(&self) -> Interest {
+ if self.has_dynamics {
+ Interest::sometimes()
+ } else {
+ Interest::never()
+ }
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ if self.has_dynamics && metadata.is_span() {
+ // If this metadata describes a span, first, check if there is a
+ // dynamic filter that should be constructed for it. If so, it
+ // should always be enabled, since it influences filtering.
+ if let Some(matcher) = self.dynamics.matcher(metadata) {
+ let mut by_cs = try_lock!(self.by_cs.write(), else return self.base_interest());
+ by_cs.insert(metadata.callsite(), matcher);
+ return Interest::always();
+ }
+ }
+
+ // Otherwise, check if any of our static filters enable this metadata.
+ if self.statics.enabled(metadata) {
+ Interest::always()
+ } else {
+ self.base_interest()
+ }
+ }
+}
+
+impl<S: Subscriber> Layer<S> for EnvFilter {
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ EnvFilter::register_callsite(self, metadata)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ EnvFilter::max_level_hint(self)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ self.enabled(metadata, ctx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, id: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ self.on_record(id, values, ctx);
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ self.on_close(id, ctx);
+ }
+}
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+ use crate::layer::Filter;
+
+ impl<S> Filter<S> for EnvFilter {
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, ctx: &Context<'_, S>) -> bool {
+ self.enabled(meta, ctx.clone())
+ }
+
+ #[inline]
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ self.register_callsite(meta)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ EnvFilter::max_level_hint(self)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, id: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ self.on_record(id, values, ctx);
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ self.on_close(id, ctx);
+ }
+ }
+}
+
+impl FromStr for EnvFilter {
+ type Err = directive::ParseError;
+
+ fn from_str(spec: &str) -> Result<Self, Self::Err> {
+ Self::try_new(spec)
+ }
+}
+
+impl<S> From<S> for EnvFilter
+where
+ S: AsRef<str>,
+{
+ fn from(s: S) -> Self {
+ Self::new(s)
+ }
+}
+
+impl Default for EnvFilter {
+ fn default() -> Self {
+ Builder::default().from_directives(std::iter::empty())
+ }
+}
+
+impl fmt::Display for EnvFilter {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut statics = self.statics.iter();
+ let wrote_statics = if let Some(next) = statics.next() {
+ fmt::Display::fmt(next, f)?;
+ for directive in statics {
+ write!(f, ",{}", directive)?;
+ }
+ true
+ } else {
+ false
+ };
+
+ let mut dynamics = self.dynamics.iter();
+ if let Some(next) = dynamics.next() {
+ if wrote_statics {
+ f.write_str(",")?;
+ }
+ fmt::Display::fmt(next, f)?;
+ for directive in dynamics {
+ write!(f, ",{}", directive)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+// ===== impl FromEnvError =====
+
+impl From<directive::ParseError> for FromEnvError {
+ fn from(p: directive::ParseError) -> Self {
+ Self {
+ kind: ErrorKind::Parse(p),
+ }
+ }
+}
+
+impl From<env::VarError> for FromEnvError {
+ fn from(v: env::VarError) -> Self {
+ Self {
+ kind: ErrorKind::Env(v),
+ }
+ }
+}
+
+impl fmt::Display for FromEnvError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.kind {
+ ErrorKind::Parse(ref p) => p.fmt(f),
+ ErrorKind::Env(ref e) => e.fmt(f),
+ }
+ }
+}
+
+impl Error for FromEnvError {
+ fn source(&self) -> Option<&(dyn Error + 'static)> {
+ match self.kind {
+ ErrorKind::Parse(ref p) => Some(p),
+ ErrorKind::Env(ref e) => Some(e),
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use tracing_core::field::FieldSet;
+ use tracing_core::*;
+
+ struct NoSubscriber;
+ impl Subscriber for NoSubscriber {
+ #[inline]
+ fn register_callsite(&self, _: &'static Metadata<'static>) -> subscriber::Interest {
+ subscriber::Interest::always()
+ }
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(0xDEAD)
+ }
+ fn event(&self, _event: &Event<'_>) {}
+ fn record(&self, _span: &span::Id, _values: &span::Record<'_>) {}
+ fn record_follows_from(&self, _span: &span::Id, _follows: &span::Id) {}
+
+ #[inline]
+ fn enabled(&self, _metadata: &Metadata<'_>) -> bool {
+ true
+ }
+ fn enter(&self, _span: &span::Id) {}
+ fn exit(&self, _span: &span::Id) {}
+ }
+
+ struct Cs;
+ impl Callsite for Cs {
+ fn set_interest(&self, _interest: Interest) {}
+ fn metadata(&self) -> &Metadata<'_> {
+ unimplemented!()
+ }
+ }
+
+ #[test]
+ fn callsite_enabled_no_span_directive() {
+ let filter = EnvFilter::new("app=debug").with_subscriber(NoSubscriber);
+ static META: &Metadata<'static> = &Metadata::new(
+ "mySpan",
+ "app",
+ Level::TRACE,
+ None,
+ None,
+ None,
+ FieldSet::new(&[], identify_callsite!(&Cs)),
+ Kind::SPAN,
+ );
+
+ let interest = filter.register_callsite(META);
+ assert!(interest.is_never());
+ }
+
+ #[test]
+ fn callsite_off() {
+ let filter = EnvFilter::new("app=off").with_subscriber(NoSubscriber);
+ static META: &Metadata<'static> = &Metadata::new(
+ "mySpan",
+ "app",
+ Level::ERROR,
+ None,
+ None,
+ None,
+ FieldSet::new(&[], identify_callsite!(&Cs)),
+ Kind::SPAN,
+ );
+
+ let interest = filter.register_callsite(META);
+ assert!(interest.is_never());
+ }
+
+ #[test]
+ fn callsite_enabled_includes_span_directive() {
+ let filter = EnvFilter::new("app[mySpan]=debug").with_subscriber(NoSubscriber);
+ static META: &Metadata<'static> = &Metadata::new(
+ "mySpan",
+ "app",
+ Level::TRACE,
+ None,
+ None,
+ None,
+ FieldSet::new(&[], identify_callsite!(&Cs)),
+ Kind::SPAN,
+ );
+
+ let interest = filter.register_callsite(META);
+ assert!(interest.is_always());
+ }
+
+ #[test]
+ fn callsite_enabled_includes_span_directive_field() {
+ let filter =
+ EnvFilter::new("app[mySpan{field=\"value\"}]=debug").with_subscriber(NoSubscriber);
+ static META: &Metadata<'static> = &Metadata::new(
+ "mySpan",
+ "app",
+ Level::TRACE,
+ None,
+ None,
+ None,
+ FieldSet::new(&["field"], identify_callsite!(&Cs)),
+ Kind::SPAN,
+ );
+
+ let interest = filter.register_callsite(META);
+ assert!(interest.is_always());
+ }
+
+ #[test]
+ fn callsite_enabled_includes_span_directive_multiple_fields() {
+ let filter = EnvFilter::new("app[mySpan{field=\"value\",field2=2}]=debug")
+ .with_subscriber(NoSubscriber);
+ static META: &Metadata<'static> = &Metadata::new(
+ "mySpan",
+ "app",
+ Level::TRACE,
+ None,
+ None,
+ None,
+ FieldSet::new(&["field"], identify_callsite!(&Cs)),
+ Kind::SPAN,
+ );
+
+ let interest = filter.register_callsite(META);
+ assert!(interest.is_never());
+ }
+
+ #[test]
+ fn roundtrip() {
+ let f1: EnvFilter =
+ "[span1{foo=1}]=error,[span2{bar=2 baz=false}],crate2[{quux=\"quuux\"}]=debug"
+ .parse()
+ .unwrap();
+ let f2: EnvFilter = format!("{}", f1).parse().unwrap();
+ assert_eq!(f1.statics, f2.statics);
+ assert_eq!(f1.dynamics, f2.dynamics);
+ }
+
+ #[test]
+ fn size_of_filters() {
+ fn print_sz(s: &str) {
+ let filter = s.parse::<EnvFilter>().expect("filter should parse");
+ println!(
+ "size_of_val({:?})\n -> {}B",
+ s,
+ std::mem::size_of_val(&filter)
+ );
+ }
+
+ print_sz("info");
+
+ print_sz("foo=debug");
+
+ print_sz(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off",
+ );
+
+ print_sz("[span1{foo=1}]=error,[span2{bar=2 baz=false}],crate2[{quux=\"quuux\"}]=debug");
+
+ print_sz(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off,[span1{foo=1}]=error,\
+ [span2{bar=2 baz=false}],crate2[{quux=\"quuux\"}]=debug",
+ );
+ }
+
+ #[test]
+ fn parse_empty_string() {
+ // There is no corresponding test for [`Builder::parse_lossy`] as failed
+ // parsing does not produce any observable side effects. If this test fails
+ // check that [`Builder::parse_lossy`] is behaving correctly as well.
+ assert!(EnvFilter::builder().parse("").is_ok());
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/filter_fn.rs b/crates/tracing-subscriber/src/filter/filter_fn.rs
new file mode 100644
index 0000000..332bf86
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/filter_fn.rs
@@ -0,0 +1,749 @@
+use crate::{
+ filter::LevelFilter,
+ layer::{Context, Layer},
+};
+use core::{any::type_name, fmt, marker::PhantomData};
+use tracing_core::{Interest, Metadata, Subscriber};
+
+/// A filter implemented by a closure or function pointer that
+/// determines whether a given span or event is enabled, based on its
+/// [`Metadata`].
+///
+/// This type can be used for both [per-layer filtering][plf] (using its
+/// [`Filter`] implementation) and [global filtering][global] (using its
+/// [`Layer`] implementation).
+///
+/// See the [documentation on filtering with layers][filtering] for details.
+///
+/// [`Metadata`]: tracing_core::Metadata
+/// [`Filter`]: crate::layer::Filter
+/// [`Layer`]: crate::layer::Layer
+/// [plf]: crate::layer#per-layer-filtering
+/// [global]: crate::layer#global-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+#[derive(Clone)]
+pub struct FilterFn<F = fn(&Metadata<'_>) -> bool> {
+ enabled: F,
+ max_level_hint: Option<LevelFilter>,
+}
+
+/// A filter implemented by a closure or function pointer that
+/// determines whether a given span or event is enabled _dynamically_,
+/// potentially based on the current [span context].
+///
+/// This type can be used for both [per-layer filtering][plf] (using its
+/// [`Filter`] implementation) and [global filtering][global] (using its
+/// [`Layer`] implementation).
+///
+/// See the [documentation on filtering with layers][filtering] for details.
+///
+/// [span context]: crate::layer::Context
+/// [`Filter`]: crate::layer::Filter
+/// [`Layer`]: crate::layer::Layer
+/// [plf]: crate::layer#per-layer-filtering
+/// [global]: crate::layer#global-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+pub struct DynFilterFn<
+ S,
+ // TODO(eliza): should these just be boxed functions?
+ F = fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+ R = fn(&'static Metadata<'static>) -> Interest,
+> {
+ enabled: F,
+ register_callsite: Option<R>,
+ max_level_hint: Option<LevelFilter>,
+ _s: PhantomData<fn(S)>,
+}
+
+// === impl FilterFn ===
+
+/// Constructs a [`FilterFn`], from a function or closure that returns `true` if
+/// a span or event should be enabled, based on its [`Metadata`].
+///
+/// The returned [`FilterFn`] can be used for both [per-layer filtering][plf]
+/// (using its [`Filter`] implementation) and [global filtering][global] (using
+/// its [`Layer`] implementation).
+///
+/// See the [documentation on filtering with layers][filtering] for details.
+///
+/// This is equivalent to calling [`FilterFn::new`].
+///
+/// [`Metadata`]: tracing_core::Metadata
+/// [`Filter`]: crate::layer::Filter
+/// [`Layer`]: crate::layer::Layer
+/// [plf]: crate::layer#per-layer-filtering
+/// [global]: crate::layer#global-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+///
+/// # Examples
+///
+/// ```
+/// use tracing_subscriber::{
+/// layer::{Layer, SubscriberExt},
+/// filter,
+/// util::SubscriberInitExt,
+/// };
+///
+/// let my_filter = filter::filter_fn(|metadata| {
+/// // Only enable spans or events with the target "interesting_things"
+/// metadata.target() == "interesting_things"
+/// });
+///
+/// let my_layer = tracing_subscriber::fmt::layer();
+///
+/// tracing_subscriber::registry()
+/// .with(my_layer.with_filter(my_filter))
+/// .init();
+///
+/// // This event will not be enabled.
+/// tracing::warn!("something important but uninteresting happened!");
+///
+/// // This event will be enabled.
+/// tracing::debug!(target: "interesting_things", "an interesting minor detail...");
+/// ```
+pub fn filter_fn<F>(f: F) -> FilterFn<F>
+where
+ F: Fn(&Metadata<'_>) -> bool,
+{
+ FilterFn::new(f)
+}
+
+/// Constructs a [`DynFilterFn`] from a function or closure that returns `true`
+/// if a span or event should be enabled within a particular [span context][`Context`].
+///
+/// This is equivalent to calling [`DynFilterFn::new`].
+///
+/// Unlike [`filter_fn`], this function takes a closure or function pointer
+/// taking the [`Metadata`] for a span or event *and* the current [`Context`].
+/// This means that a [`DynFilterFn`] can choose whether to enable spans or
+/// events based on information about the _current_ span (or its parents).
+///
+/// If this is *not* necessary, use [`filter_fn`] instead.
+///
+/// The returned [`DynFilterFn`] can be used for both [per-layer filtering][plf]
+/// (using its [`Filter`] implementation) and [global filtering][global] (using
+/// its [`Layer`] implementation).
+///
+/// See the [documentation on filtering with layers][filtering] for details.
+///
+/// # Examples
+///
+/// ```
+/// use tracing_subscriber::{
+/// layer::{Layer, SubscriberExt},
+/// filter,
+/// util::SubscriberInitExt,
+/// };
+///
+/// // Only enable spans or events within a span named "interesting_span".
+/// let my_filter = filter::dynamic_filter_fn(|metadata, cx| {
+/// // If this *is* "interesting_span", make sure to enable it.
+/// if metadata.is_span() && metadata.name() == "interesting_span" {
+/// return true;
+/// }
+///
+/// // Otherwise, are we in an interesting span?
+/// if let Some(current_span) = cx.lookup_current() {
+/// return current_span.name() == "interesting_span";
+/// }
+///
+/// false
+/// });
+///
+/// let my_layer = tracing_subscriber::fmt::layer();
+///
+/// tracing_subscriber::registry()
+/// .with(my_layer.with_filter(my_filter))
+/// .init();
+///
+/// // This event will not be enabled.
+/// tracing::info!("something happened");
+///
+/// tracing::info_span!("interesting_span").in_scope(|| {
+/// // This event will be enabled.
+/// tracing::debug!("something else happened");
+/// });
+/// ```
+///
+/// [`Filter`]: crate::layer::Filter
+/// [`Layer`]: crate::layer::Layer
+/// [plf]: crate::layer#per-layer-filtering
+/// [global]: crate::layer#global-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+/// [`Context`]: crate::layer::Context
+/// [`Metadata`]: tracing_core::Metadata
+pub fn dynamic_filter_fn<S, F>(f: F) -> DynFilterFn<S, F>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+{
+ DynFilterFn::new(f)
+}
+
+impl<F> FilterFn<F>
+where
+ F: Fn(&Metadata<'_>) -> bool,
+{
+ /// Constructs a [`FilterFn`] from a function or closure that returns `true`
+ /// if a span or event should be enabled, based on its [`Metadata`].
+ ///
+ /// If determining whether a span or event should be enabled also requires
+ /// information about the current span context, use [`DynFilterFn`] instead.
+ ///
+ /// See the [documentation on per-layer filtering][plf] for details on using
+ /// [`Filter`]s.
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [plf]: crate::layer#per-layer-filtering
+ /// [`Metadata`]: tracing_core::Metadata
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// layer::{Layer, SubscriberExt},
+ /// filter::FilterFn,
+ /// util::SubscriberInitExt,
+ /// };
+ ///
+ /// let my_filter = FilterFn::new(|metadata| {
+ /// // Only enable spans or events with the target "interesting_things"
+ /// metadata.target() == "interesting_things"
+ /// });
+ ///
+ /// let my_layer = tracing_subscriber::fmt::layer();
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(my_layer.with_filter(my_filter))
+ /// .init();
+ ///
+ /// // This event will not be enabled.
+ /// tracing::warn!("something important but uninteresting happened!");
+ ///
+ /// // This event will be enabled.
+ /// tracing::debug!(target: "interesting_things", "an interesting minor detail...");
+ /// ```
+ pub fn new(enabled: F) -> Self {
+ Self {
+ enabled,
+ max_level_hint: None,
+ }
+ }
+
+ /// Sets the highest verbosity [`Level`] the filter function will enable.
+ ///
+ /// The value passed to this method will be returned by this `FilterFn`'s
+ /// [`Filter::max_level_hint`] method.
+ ///
+ /// If the provided function will not enable all levels, it is recommended
+ /// to call this method to configure it with the most verbose level it will
+ /// enable.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// layer::{Layer, SubscriberExt},
+ /// filter::{filter_fn, LevelFilter},
+ /// util::SubscriberInitExt,
+ /// };
+ /// use tracing_core::Level;
+ ///
+ /// let my_filter = filter_fn(|metadata| {
+ /// // Only enable spans or events with targets starting with `my_crate`
+ /// // and levels at or below `INFO`.
+ /// metadata.level() <= &Level::INFO && metadata.target().starts_with("my_crate")
+ /// })
+ /// // Since the filter closure will only enable the `INFO` level and
+ /// // below, set the max level hint
+ /// .with_max_level_hint(LevelFilter::INFO);
+ ///
+ /// let my_layer = tracing_subscriber::fmt::layer();
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(my_layer.with_filter(my_filter))
+ /// .init();
+ /// ```
+ ///
+ /// [`Level`]: tracing_core::Level
+ /// [`Filter::max_level_hint`]: crate::layer::Filter::max_level_hint
+ pub fn with_max_level_hint(self, max_level_hint: impl Into<LevelFilter>) -> Self {
+ Self {
+ max_level_hint: Some(max_level_hint.into()),
+ ..self
+ }
+ }
+
+ #[inline]
+ pub(in crate::filter) fn is_enabled(&self, metadata: &Metadata<'_>) -> bool {
+ let enabled = (self.enabled)(metadata);
+ debug_assert!(
+ !enabled || self.is_below_max_level(metadata),
+ "FilterFn<{}> claimed it would only enable {:?} and below, \
+ but it enabled metadata with the {:?} level\nmetadata={:#?}",
+ type_name::<F>(),
+ self.max_level_hint.unwrap(),
+ metadata.level(),
+ metadata,
+ );
+
+ enabled
+ }
+
+ #[inline]
+ pub(in crate::filter) fn is_callsite_enabled(
+ &self,
+ metadata: &'static Metadata<'static>,
+ ) -> Interest {
+ // Because `self.enabled` takes a `Metadata` only (and no `Context`
+ // parameter), we can reasonably assume its results are cachable, and
+ // just return `Interest::always`/`Interest::never`.
+ if (self.enabled)(metadata) {
+ debug_assert!(
+ self.is_below_max_level(metadata),
+ "FilterFn<{}> claimed it was only interested in {:?} and below, \
+ but it enabled metadata with the {:?} level\nmetadata={:#?}",
+ type_name::<F>(),
+ self.max_level_hint.unwrap(),
+ metadata.level(),
+ metadata,
+ );
+ return Interest::always();
+ }
+
+ Interest::never()
+ }
+
+ fn is_below_max_level(&self, metadata: &Metadata<'_>) -> bool {
+ self.max_level_hint
+ .as_ref()
+ .map(|hint| metadata.level() <= hint)
+ .unwrap_or(true)
+ }
+}
+
+impl<S, F> Layer<S> for FilterFn<F>
+where
+ F: Fn(&Metadata<'_>) -> bool + 'static,
+ S: Subscriber,
+{
+ fn enabled(&self, metadata: &Metadata<'_>, _: Context<'_, S>) -> bool {
+ self.is_enabled(metadata)
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.is_callsite_enabled(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.max_level_hint
+ }
+}
+
+impl<F> From<F> for FilterFn<F>
+where
+ F: Fn(&Metadata<'_>) -> bool,
+{
+ fn from(enabled: F) -> Self {
+ Self::new(enabled)
+ }
+}
+
+impl<F> fmt::Debug for FilterFn<F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FilterFn")
+ .field("enabled", &format_args!("{}", type_name::<F>()))
+ .field("max_level_hint", &self.max_level_hint)
+ .finish()
+ }
+}
+
+// === impl DynFilterFn ==
+
+impl<S, F> DynFilterFn<S, F>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+{
+ /// Constructs a [`Filter`] from a function or closure that returns `true`
+ /// if a span or event should be enabled in the current [span
+ /// context][`Context`].
+ ///
+ /// Unlike [`FilterFn`], a `DynFilterFn` is constructed from a closure or
+ /// function pointer that takes both the [`Metadata`] for a span or event
+ /// *and* the current [`Context`]. This means that a [`DynFilterFn`] can
+ /// choose whether to enable spans or events based on information about the
+ /// _current_ span (or its parents).
+ ///
+ /// If this is *not* necessary, use [`FilterFn`] instead.
+ ///
+ /// See the [documentation on per-layer filtering][plf] for details on using
+ /// [`Filter`]s.
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [plf]: crate::layer#per-layer-filtering
+ /// [`Context`]: crate::layer::Context
+ /// [`Metadata`]: tracing_core::Metadata
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// layer::{Layer, SubscriberExt},
+ /// filter::DynFilterFn,
+ /// util::SubscriberInitExt,
+ /// };
+ ///
+ /// // Only enable spans or events within a span named "interesting_span".
+ /// let my_filter = DynFilterFn::new(|metadata, cx| {
+ /// // If this *is* "interesting_span", make sure to enable it.
+ /// if metadata.is_span() && metadata.name() == "interesting_span" {
+ /// return true;
+ /// }
+ ///
+ /// // Otherwise, are we in an interesting span?
+ /// if let Some(current_span) = cx.lookup_current() {
+ /// return current_span.name() == "interesting_span";
+ /// }
+ ///
+ /// false
+ /// });
+ ///
+ /// let my_layer = tracing_subscriber::fmt::layer();
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(my_layer.with_filter(my_filter))
+ /// .init();
+ ///
+ /// // This event will not be enabled.
+ /// tracing::info!("something happened");
+ ///
+ /// tracing::info_span!("interesting_span").in_scope(|| {
+ /// // This event will be enabled.
+ /// tracing::debug!("something else happened");
+ /// });
+ /// ```
+ pub fn new(enabled: F) -> Self {
+ Self {
+ enabled,
+ register_callsite: None,
+ max_level_hint: None,
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<S, F, R> DynFilterFn<S, F, R>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+{
+ /// Sets the highest verbosity [`Level`] the filter function will enable.
+ ///
+ /// The value passed to this method will be returned by this `DynFilterFn`'s
+ /// [`Filter::max_level_hint`] method.
+ ///
+ /// If the provided function will not enable all levels, it is recommended
+ /// to call this method to configure it with the most verbose level it will
+ /// enable.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// layer::{Layer, SubscriberExt},
+ /// filter::{DynFilterFn, LevelFilter},
+ /// util::SubscriberInitExt,
+ /// };
+ /// use tracing_core::Level;
+ ///
+ /// // Only enable spans or events with levels at or below `INFO`, if
+ /// // we are inside a span called "interesting_span".
+ /// let my_filter = DynFilterFn::new(|metadata, cx| {
+ /// // If the level is greater than INFO, disable it.
+ /// if metadata.level() > &Level::INFO {
+ /// return false;
+ /// }
+ ///
+ /// // If any span in the current scope is named "interesting_span",
+ /// // enable this span or event.
+ /// for span in cx.lookup_current().iter().flat_map(|span| span.scope()) {
+ /// if span.name() == "interesting_span" {
+ /// return true;
+ /// }
+ /// }
+ ///
+ /// // Otherwise, disable it.
+ /// false
+ /// })
+ /// // Since the filter closure will only enable the `INFO` level and
+ /// // below, set the max level hint
+ /// .with_max_level_hint(LevelFilter::INFO);
+ ///
+ /// let my_layer = tracing_subscriber::fmt::layer();
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(my_layer.with_filter(my_filter))
+ /// .init();
+ /// ```
+ ///
+ /// [`Level`]: tracing_core::Level
+ /// [`Filter::max_level_hint`]: crate::layer::Filter::max_level_hint
+ pub fn with_max_level_hint(self, max_level_hint: impl Into<LevelFilter>) -> Self {
+ Self {
+ max_level_hint: Some(max_level_hint.into()),
+ ..self
+ }
+ }
+
+ /// Adds a function for filtering callsites to this filter.
+ ///
+ /// When this filter's [`Filter::callsite_enabled`][cse] method is called,
+ /// the provided function will be used rather than the default.
+ ///
+ /// By default, `DynFilterFn` assumes that, because the filter _may_ depend
+ /// dynamically on the current [span context], its result should never be
+ /// cached. However, some filtering strategies may require dynamic information
+ /// from the current span context in *some* cases, but are able to make
+ /// static filtering decisions from [`Metadata`] alone in others.
+ ///
+ /// For example, consider the filter given in the example for
+ /// [`DynFilterFn::new`]. That filter enables all spans named
+ /// "interesting_span", and any events and spans that occur inside of an
+ /// interesting span. Since the span's name is part of its static
+ /// [`Metadata`], the "interesting_span" can be enabled in
+ /// [`callsite_enabled`][cse]:
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// layer::{Layer, SubscriberExt},
+ /// filter::DynFilterFn,
+ /// util::SubscriberInitExt,
+ /// };
+ /// use tracing_core::subscriber::Interest;
+ ///
+ /// // Only enable spans or events within a span named "interesting_span".
+ /// let my_filter = DynFilterFn::new(|metadata, cx| {
+ /// // If this *is* "interesting_span", make sure to enable it.
+ /// if metadata.is_span() && metadata.name() == "interesting_span" {
+ /// return true;
+ /// }
+ ///
+ /// // Otherwise, are we in an interesting span?
+ /// if let Some(current_span) = cx.lookup_current() {
+ /// return current_span.name() == "interesting_span";
+ /// }
+ ///
+ /// false
+ /// }).with_callsite_filter(|metadata| {
+ /// // If this is an "interesting_span", we know we will always
+ /// // enable it.
+ /// if metadata.is_span() && metadata.name() == "interesting_span" {
+ /// return Interest::always();
+ /// }
+ ///
+ /// // Otherwise, it depends on whether or not we're in an interesting
+ /// // span. You'll have to ask us again for each span/event!
+ /// Interest::sometimes()
+ /// });
+ ///
+ /// let my_layer = tracing_subscriber::fmt::layer();
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(my_layer.with_filter(my_filter))
+ /// .init();
+ /// ```
+ ///
+ /// [cse]: crate::layer::Filter::callsite_enabled
+ /// [`enabled`]: crate::layer::Filter::enabled
+ /// [`Metadata`]: tracing_core::Metadata
+ /// [span context]: crate::layer::Context
+ pub fn with_callsite_filter<R2>(self, callsite_enabled: R2) -> DynFilterFn<S, F, R2>
+ where
+ R2: Fn(&'static Metadata<'static>) -> Interest,
+ {
+ let register_callsite = Some(callsite_enabled);
+ let DynFilterFn {
+ enabled,
+ max_level_hint,
+ _s,
+ ..
+ } = self;
+ DynFilterFn {
+ enabled,
+ register_callsite,
+ max_level_hint,
+ _s,
+ }
+ }
+
+ fn default_callsite_enabled(&self, metadata: &Metadata<'_>) -> Interest {
+ // If it's below the configured max level, assume that `enabled` will
+ // never enable it...
+ if !is_below_max_level(&self.max_level_hint, metadata) {
+ debug_assert!(
+ !(self.enabled)(metadata, &Context::none()),
+ "DynFilterFn<{}> claimed it would only enable {:?} and below, \
+ but it enabled metadata with the {:?} level\nmetadata={:#?}",
+ type_name::<F>(),
+ self.max_level_hint.unwrap(),
+ metadata.level(),
+ metadata,
+ );
+ return Interest::never();
+ }
+
+ // Otherwise, since this `enabled` function is dynamic and depends on
+ // the current context, we don't know whether this span or event will be
+ // enabled or not. Ask again every time it's recorded!
+ Interest::sometimes()
+ }
+}
+
+impl<S, F, R> DynFilterFn<S, F, R>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+ R: Fn(&'static Metadata<'static>) -> Interest,
+{
+ #[inline]
+ fn is_enabled(&self, metadata: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ let enabled = (self.enabled)(metadata, cx);
+ debug_assert!(
+ !enabled || is_below_max_level(&self.max_level_hint, metadata),
+ "DynFilterFn<{}> claimed it would only enable {:?} and below, \
+ but it enabled metadata with the {:?} level\nmetadata={:#?}",
+ type_name::<F>(),
+ self.max_level_hint.unwrap(),
+ metadata.level(),
+ metadata,
+ );
+
+ enabled
+ }
+
+ #[inline]
+ fn is_callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ let interest = self
+ .register_callsite
+ .as_ref()
+ .map(|callsite_enabled| callsite_enabled(metadata))
+ .unwrap_or_else(|| self.default_callsite_enabled(metadata));
+ debug_assert!(
+ interest.is_never() || is_below_max_level(&self.max_level_hint, metadata),
+ "DynFilterFn<{}, {}> claimed it was only interested in {:?} and below, \
+ but it enabled metadata with the {:?} level\nmetadata={:#?}",
+ type_name::<F>(),
+ type_name::<R>(),
+ self.max_level_hint.unwrap(),
+ metadata.level(),
+ metadata,
+ );
+
+ interest
+ }
+}
+
+impl<S, F, R> Layer<S> for DynFilterFn<S, F, R>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool + 'static,
+ R: Fn(&'static Metadata<'static>) -> Interest + 'static,
+ S: Subscriber,
+{
+ fn enabled(&self, metadata: &Metadata<'_>, cx: Context<'_, S>) -> bool {
+ self.is_enabled(metadata, &cx)
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.is_callsite_enabled(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.max_level_hint
+ }
+}
+
+impl<S, F, R> fmt::Debug for DynFilterFn<S, F, R> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut s = f.debug_struct("DynFilterFn");
+ s.field("enabled", &format_args!("{}", type_name::<F>()));
+ if self.register_callsite.is_some() {
+ s.field(
+ "register_callsite",
+ &format_args!("Some({})", type_name::<R>()),
+ );
+ } else {
+ s.field("register_callsite", &format_args!("None"));
+ }
+
+ s.field("max_level_hint", &self.max_level_hint).finish()
+ }
+}
+
+impl<S, F, R> Clone for DynFilterFn<S, F, R>
+where
+ F: Clone,
+ R: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ enabled: self.enabled.clone(),
+ register_callsite: self.register_callsite.clone(),
+ max_level_hint: self.max_level_hint,
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<F, S> From<F> for DynFilterFn<S, F>
+where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+{
+ fn from(f: F) -> Self {
+ Self::new(f)
+ }
+}
+
+// === PLF impls ===
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+ use crate::layer::Filter;
+
+ impl<S, F> Filter<S> for FilterFn<F>
+ where
+ F: Fn(&Metadata<'_>) -> bool,
+ {
+ fn enabled(&self, metadata: &Metadata<'_>, _: &Context<'_, S>) -> bool {
+ self.is_enabled(metadata)
+ }
+
+ fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.is_callsite_enabled(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.max_level_hint
+ }
+ }
+
+ impl<S, F, R> Filter<S> for DynFilterFn<S, F, R>
+ where
+ F: Fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+ R: Fn(&'static Metadata<'static>) -> Interest,
+ {
+ fn enabled(&self, metadata: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ self.is_enabled(metadata, cx)
+ }
+
+ fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.is_callsite_enabled(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.max_level_hint
+ }
+ }
+}
+
+fn is_below_max_level(hint: &Option<LevelFilter>, metadata: &Metadata<'_>) -> bool {
+ hint.as_ref()
+ .map(|hint| metadata.level() <= hint)
+ .unwrap_or(true)
+}
diff --git a/crates/tracing-subscriber/src/filter/layer_filters/combinator.rs b/crates/tracing-subscriber/src/filter/layer_filters/combinator.rs
new file mode 100644
index 0000000..3934a13
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/layer_filters/combinator.rs
@@ -0,0 +1,542 @@
+//! Filter combinators
+use crate::layer::{Context, Filter};
+use std::{cmp, fmt, marker::PhantomData};
+use tracing_core::{
+ span::{Attributes, Id, Record},
+ subscriber::Interest,
+ LevelFilter, Metadata,
+};
+
+/// Combines two [`Filter`]s so that spans and events are enabled if and only if
+/// *both* filters return `true`.
+///
+/// This type is typically returned by the [`FilterExt::and`] method. See that
+/// method's documentation for details.
+///
+/// [`Filter`]: crate::layer::Filter
+/// [`FilterExt::and`]: crate::filter::FilterExt::and
+pub struct And<A, B, S> {
+ a: A,
+ b: B,
+ _s: PhantomData<fn(S)>,
+}
+
+/// Combines two [`Filter`]s so that spans and events are enabled if *either* filter
+/// returns `true`.
+///
+/// This type is typically returned by the [`FilterExt::or`] method. See that
+/// method's documentation for details.
+///
+/// [`Filter`]: crate::layer::Filter
+/// [`FilterExt::or`]: crate::filter::FilterExt::or
+pub struct Or<A, B, S> {
+ a: A,
+ b: B,
+ _s: PhantomData<fn(S)>,
+}
+
+/// Inverts the result of a [`Filter`].
+///
+/// If the wrapped filter would enable a span or event, it will be disabled. If
+/// it would disable a span or event, that span or event will be enabled.
+///
+/// This type is typically returned by the [`FilterExt::not`] method. See that
+/// method's documentation for details.
+///
+/// [`Filter`]: crate::layer::Filter
+/// [`FilterExt::not`]: crate::filter::FilterExt::not
+pub struct Not<A, S> {
+ a: A,
+ _s: PhantomData<fn(S)>,
+}
+
+// === impl And ===
+
+impl<A, B, S> And<A, B, S>
+where
+ A: Filter<S>,
+ B: Filter<S>,
+{
+ /// Combines two [`Filter`]s so that spans and events are enabled if and only if
+ /// *both* filters return `true`.
+ ///
+ /// # Examples
+ ///
+ /// Enabling spans or events if they have both a particular target *and* are
+ /// above a certain level:
+ ///
+ /// ```ignore
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, combinator::And},
+ /// prelude::*,
+ /// };
+ ///
+ /// // Enables spans and events with targets starting with `interesting_target`:
+ /// let target_filter = filter_fn(|meta| {
+ /// meta.target().starts_with("interesting_target")
+ /// });
+ ///
+ /// // Enables spans and events with levels `INFO` and below:
+ /// let level_filter = LevelFilter::INFO;
+ ///
+ /// // Combine the two filters together so that a span or event is only enabled
+ /// // if *both* filters would enable it:
+ /// let filter = And::new(level_filter, target_filter);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::info!("an event with an uninteresting target");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!(target: "interesting_target", "a very interesting event");
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::debug!(target: "interesting_target", "interesting debug event...");
+ /// ```
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ pub(crate) fn new(a: A, b: B) -> Self {
+ Self {
+ a,
+ b,
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<A, B, S> Filter<S> for And<A, B, S>
+where
+ A: Filter<S>,
+ B: Filter<S>,
+{
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ self.a.enabled(meta, cx) && self.b.enabled(meta, cx)
+ }
+
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ let a = self.a.callsite_enabled(meta);
+ if a.is_never() {
+ return a;
+ }
+
+ let b = self.b.callsite_enabled(meta);
+
+ if !b.is_always() {
+ return b;
+ }
+
+ a
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ // If either hint is `None`, return `None`. Otherwise, return the most restrictive.
+ cmp::min(self.a.max_level_hint(), self.b.max_level_hint())
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &tracing_core::Event<'_>, cx: &Context<'_, S>) -> bool {
+ self.a.event_enabled(event, cx) && self.b.event_enabled(event, cx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_new_span(attrs, id, ctx.clone());
+ self.b.on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>) {
+ self.a.on_record(id, values, ctx.clone());
+ self.b.on_record(id, values, ctx);
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_enter(id, ctx.clone());
+ self.b.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_exit(id, ctx.clone());
+ self.b.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ self.a.on_close(id.clone(), ctx.clone());
+ self.b.on_close(id, ctx);
+ }
+}
+
+impl<A, B, S> Clone for And<A, B, S>
+where
+ A: Clone,
+ B: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ a: self.a.clone(),
+ b: self.b.clone(),
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<A, B, S> fmt::Debug for And<A, B, S>
+where
+ A: fmt::Debug,
+ B: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("And")
+ .field("a", &self.a)
+ .field("b", &self.b)
+ .finish()
+ }
+}
+
+// === impl Or ===
+
+impl<A, B, S> Or<A, B, S>
+where
+ A: Filter<S>,
+ B: Filter<S>,
+{
+ /// Combines two [`Filter`]s so that spans and events are enabled if *either* filter
+ /// returns `true`.
+ ///
+ /// # Examples
+ ///
+ /// Enabling spans and events at the `INFO` level and above, and all spans
+ /// and events with a particular target:
+ ///
+ /// ```ignore
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, combinator::Or},
+ /// prelude::*,
+ /// };
+ ///
+ /// // Enables spans and events with targets starting with `interesting_target`:
+ /// let target_filter = filter_fn(|meta| {
+ /// meta.target().starts_with("interesting_target")
+ /// });
+ ///
+ /// // Enables spans and events with levels `INFO` and below:
+ /// let level_filter = LevelFilter::INFO;
+ ///
+ /// // Combine the two filters together so that a span or event is enabled
+ /// // if it is at INFO or lower, or if it has a target starting with
+ /// // `interesting_target`.
+ /// let filter = Or::new(level_filter, target_filter);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::debug!("an uninteresting event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!("an uninteresting INFO event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!(target: "interesting_target", "a very interesting event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::debug!(target: "interesting_target", "interesting debug event...");
+ /// ```
+ ///
+ /// Enabling a higher level for a particular target by using `Or` in
+ /// conjunction with the [`And`] combinator:
+ ///
+ /// ```ignore
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, combinator},
+ /// prelude::*,
+ /// };
+ ///
+ /// // This filter will enable spans and events with targets beginning with
+ /// // `my_crate`:
+ /// let my_crate = filter_fn(|meta| {
+ /// meta.target().starts_with("my_crate")
+ /// });
+ ///
+ /// // Combine the `my_crate` filter with a `LevelFilter` to produce a filter
+ /// // that will enable the `INFO` level and lower for spans and events with
+ /// // `my_crate` targets:
+ /// let filter = combinator::And::new(my_crate, LevelFilter::INFO);
+ ///
+ /// // If a span or event *doesn't* have a target beginning with
+ /// // `my_crate`, enable it if it has the `WARN` level or lower:
+ /// // let filter = combinator::Or::new(filter, LevelFilter::WARN);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ /// ```
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ pub(crate) fn new(a: A, b: B) -> Self {
+ Self {
+ a,
+ b,
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<A, B, S> Filter<S> for Or<A, B, S>
+where
+ A: Filter<S>,
+ B: Filter<S>,
+{
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ self.a.enabled(meta, cx) || self.b.enabled(meta, cx)
+ }
+
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ let a = self.a.callsite_enabled(meta);
+ let b = self.b.callsite_enabled(meta);
+
+ // If either filter will always enable the span or event, return `always`.
+ if a.is_always() || b.is_always() {
+ return Interest::always();
+ }
+
+ // Okay, if either filter will sometimes enable the span or event,
+ // return `sometimes`.
+ if a.is_sometimes() || b.is_sometimes() {
+ return Interest::sometimes();
+ }
+
+ debug_assert!(
+ a.is_never() && b.is_never(),
+ "if neither filter was `always` or `sometimes`, both must be `never` (a={:?}; b={:?})",
+ a,
+ b,
+ );
+ Interest::never()
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ // If either hint is `None`, return `None`. Otherwise, return the less restrictive.
+ Some(cmp::max(self.a.max_level_hint()?, self.b.max_level_hint()?))
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &tracing_core::Event<'_>, cx: &Context<'_, S>) -> bool {
+ self.a.event_enabled(event, cx) || self.b.event_enabled(event, cx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_new_span(attrs, id, ctx.clone());
+ self.b.on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>) {
+ self.a.on_record(id, values, ctx.clone());
+ self.b.on_record(id, values, ctx);
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_enter(id, ctx.clone());
+ self.b.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_exit(id, ctx.clone());
+ self.b.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ self.a.on_close(id.clone(), ctx.clone());
+ self.b.on_close(id, ctx);
+ }
+}
+
+impl<A, B, S> Clone for Or<A, B, S>
+where
+ A: Clone,
+ B: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ a: self.a.clone(),
+ b: self.b.clone(),
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<A, B, S> fmt::Debug for Or<A, B, S>
+where
+ A: fmt::Debug,
+ B: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Or")
+ .field("a", &self.a)
+ .field("b", &self.b)
+ .finish()
+ }
+}
+
+// === impl Not ===
+
+impl<A, S> Not<A, S>
+where
+ A: Filter<S>,
+{
+ /// Inverts the result of a [`Filter`].
+ ///
+ /// If the wrapped filter would enable a span or event, it will be disabled. If
+ /// it would disable a span or event, that span or event will be enabled.
+ ///
+ /// This inverts the values returned by the [`enabled`] and [`callsite_enabled`]
+ /// methods on the wrapped filter; it does *not* invert [`event_enabled`], as
+ /// filters which do not implement filtering on event field values will return
+ /// the default `true` even for events that their [`enabled`] method disables.
+ ///
+ /// Consider a normal filter defined as:
+ ///
+ /// ```ignore (pseudo-code)
+ /// // for spans
+ /// match callsite_enabled() {
+ /// ALWAYS => on_span(),
+ /// SOMETIMES => if enabled() { on_span() },
+ /// NEVER => (),
+ /// }
+ /// // for events
+ /// match callsite_enabled() {
+ /// ALWAYS => on_event(),
+ /// SOMETIMES => if enabled() && event_enabled() { on_event() },
+ /// NEVER => (),
+ /// }
+ /// ```
+ ///
+ /// and an inverted filter defined as:
+ ///
+ /// ```ignore (pseudo-code)
+ /// // for spans
+ /// match callsite_enabled() {
+ /// ALWAYS => (),
+ /// SOMETIMES => if !enabled() { on_span() },
+ /// NEVER => on_span(),
+ /// }
+ /// // for events
+ /// match callsite_enabled() {
+ /// ALWAYS => (),
+ /// SOMETIMES => if !enabled() { on_event() },
+ /// NEVER => on_event(),
+ /// }
+ /// ```
+ ///
+ /// A proper inversion would do `!(enabled() && event_enabled())` (or
+ /// `!enabled() || !event_enabled()`), but because of the implicit `&&`
+ /// relation between `enabled` and `event_enabled`, it is difficult to
+ /// short circuit and not call the wrapped `event_enabled`.
+ ///
+ /// A combinator which remembers the result of `enabled` in order to call
+ /// `event_enabled` only when `enabled() == true` is possible, but requires
+ /// additional thread-local mutable state to support a very niche use case.
+ //
+ // Also, it'd mean the wrapped layer's `enabled()` always gets called and
+ // globally applied to events where it doesn't today, since we can't know
+ // what `event_enabled` will say until we have the event to call it with.
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [`enabled`]: crate::layer::Filter::enabled
+ /// [`event_enabled`]: crate::layer::Filter::event_enabled
+ /// [`callsite_enabled`]: crate::layer::Filter::callsite_enabled
+ pub(crate) fn new(a: A) -> Self {
+ Self { a, _s: PhantomData }
+ }
+}
+
+impl<A, S> Filter<S> for Not<A, S>
+where
+ A: Filter<S>,
+{
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ !self.a.enabled(meta, cx)
+ }
+
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ match self.a.callsite_enabled(meta) {
+ i if i.is_always() => Interest::never(),
+ i if i.is_never() => Interest::always(),
+ _ => Interest::sometimes(),
+ }
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ // TODO(eliza): figure this out???
+ None
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &tracing_core::Event<'_>, cx: &Context<'_, S>) -> bool {
+ // Never disable based on event_enabled; we "disabled" it in `enabled`,
+ // so the `not` has already been applied and filtered this not out.
+ let _ = (event, cx);
+ true
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_new_span(attrs, id, ctx);
+ }
+
+ #[inline]
+ fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>) {
+ self.a.on_record(id, values, ctx.clone());
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &Id, ctx: Context<'_, S>) {
+ self.a.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ self.a.on_close(id, ctx);
+ }
+}
+
+impl<A, S> Clone for Not<A, S>
+where
+ A: Clone,
+{
+ fn clone(&self) -> Self {
+ Self {
+ a: self.a.clone(),
+ _s: PhantomData,
+ }
+ }
+}
+
+impl<A, S> fmt::Debug for Not<A, S>
+where
+ A: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_tuple("Not").field(&self.a).finish()
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/layer_filters/mod.rs b/crates/tracing-subscriber/src/filter/layer_filters/mod.rs
new file mode 100644
index 0000000..69736fa
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/layer_filters/mod.rs
@@ -0,0 +1,1319 @@
+//! ## Per-Layer Filtering
+//!
+//! Per-layer filters permit individual `Layer`s to have their own filter
+//! configurations without interfering with other `Layer`s.
+//!
+//! This module is not public; the public APIs defined in this module are
+//! re-exported in the top-level `filter` module. Therefore, this documentation
+//! primarily concerns the internal implementation details. For the user-facing
+//! public API documentation, see the individual public types in this module, as
+//! well as the, see the `Layer` trait documentation's [per-layer filtering
+//! section]][1].
+//!
+//! ## How does per-layer filtering work?
+//!
+//! As described in the API documentation, the [`Filter`] trait defines a
+//! filtering strategy for a per-layer filter. We expect there will be a variety
+//! of implementations of [`Filter`], both in `tracing-subscriber` and in user
+//! code.
+//!
+//! To actually *use* a [`Filter`] implementation, it is combined with a
+//! [`Layer`] by the [`Filtered`] struct defined in this module. [`Filtered`]
+//! implements [`Layer`] by calling into the wrapped [`Layer`], or not, based on
+//! the filtering strategy. While there will be a variety of types that implement
+//! [`Filter`], all actual *uses* of per-layer filtering will occur through the
+//! [`Filtered`] struct. Therefore, most of the implementation details live
+//! there.
+//!
+//! [1]: crate::layer#per-layer-filtering
+//! [`Filter`]: crate::layer::Filter
+use crate::{
+ filter::LevelFilter,
+ layer::{self, Context, Layer},
+ registry,
+};
+use std::{
+ any::TypeId,
+ cell::{Cell, RefCell},
+ fmt,
+ marker::PhantomData,
+ ops::Deref,
+ sync::Arc,
+ thread_local,
+};
+use tracing_core::{
+ span,
+ subscriber::{Interest, Subscriber},
+ Dispatch, Event, Metadata,
+};
+pub mod combinator;
+
+/// A [`Layer`] that wraps an inner [`Layer`] and adds a [`Filter`] which
+/// controls what spans and events are enabled for that layer.
+///
+/// This is returned by the [`Layer::with_filter`] method. See the
+/// [documentation on per-layer filtering][plf] for details.
+///
+/// [`Filter`]: crate::layer::Filter
+/// [plf]: crate::layer#per-layer-filtering
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+#[derive(Clone)]
+pub struct Filtered<L, F, S> {
+ filter: F,
+ layer: L,
+ id: MagicPlfDowncastMarker,
+ _s: PhantomData<fn(S)>,
+}
+
+/// Uniquely identifies an individual [`Filter`] instance in the context of
+/// a [`Subscriber`].
+///
+/// When adding a [`Filtered`] [`Layer`] to a [`Subscriber`], the [`Subscriber`]
+/// generates a `FilterId` for that [`Filtered`] layer. The [`Filtered`] layer
+/// will then use the generated ID to query whether a particular span was
+/// previously enabled by that layer's [`Filter`].
+///
+/// **Note**: Currently, the [`Registry`] type provided by this crate is the
+/// **only** [`Subscriber`] implementation capable of participating in per-layer
+/// filtering. Therefore, the `FilterId` type cannot currently be constructed by
+/// code outside of `tracing-subscriber`. In the future, new APIs will be added to `tracing-subscriber` to
+/// allow non-Registry [`Subscriber`]s to also participate in per-layer
+/// filtering. When those APIs are added, subscribers will be responsible
+/// for generating and assigning `FilterId`s.
+///
+/// [`Filter`]: crate::layer::Filter
+/// [`Subscriber`]: tracing_core::Subscriber
+/// [`Layer`]: crate::layer::Layer
+/// [`Registry`]: crate::registry::Registry
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+#[derive(Copy, Clone)]
+pub struct FilterId(u64);
+
+/// A bitmap tracking which [`FilterId`]s have enabled a given span or
+/// event.
+///
+/// This is currently a private type that's used exclusively by the
+/// [`Registry`]. However, in the future, this may become a public API, in order
+/// to allow user subscribers to host [`Filter`]s.
+///
+/// [`Registry`]: crate::Registry
+/// [`Filter`]: crate::layer::Filter
+#[derive(Default, Copy, Clone, Eq, PartialEq)]
+pub(crate) struct FilterMap {
+ bits: u64,
+}
+
+/// The current state of `enabled` calls to per-layer filters on this
+/// thread.
+///
+/// When `Filtered::enabled` is called, the filter will set the bit
+/// corresponding to its ID if the filter will disable the event/span being
+/// filtered. When the event or span is recorded, the per-layer filter will
+/// check its bit to determine if it disabled that event or span, and skip
+/// forwarding the event or span to the inner layer if the bit is set. Once
+/// a span or event has been skipped by a per-layer filter, it unsets its
+/// bit, so that the `FilterMap` has been cleared for the next set of
+/// `enabled` calls.
+///
+/// FilterState is also read by the `Registry`, for two reasons:
+///
+/// 1. When filtering a span, the Registry must store the `FilterMap`
+/// generated by `Filtered::enabled` calls for that span as part of the
+/// span's per-span data. This allows `Filtered` layers to determine
+/// whether they had previously disabled a given span, and avoid showing it
+/// to the wrapped layer if it was disabled.
+///
+/// This allows `Filtered` layers to also filter out the spans they
+/// disable from span traversals (such as iterating over parents, etc).
+/// 2. If all the bits are set, then every per-layer filter has decided it
+/// doesn't want to enable that span or event. In that case, the
+/// `Registry`'s `enabled` method will return `false`, so that
+/// recording a span or event can be skipped entirely.
+#[derive(Debug)]
+pub(crate) struct FilterState {
+ enabled: Cell<FilterMap>,
+ // TODO(eliza): `Interest`s should _probably_ be `Copy`. The only reason
+ // they're not is our Obsessive Commitment to Forwards-Compatibility. If
+ // this changes in tracing-core`, we can make this a `Cell` rather than
+ // `RefCell`...
+ interest: RefCell<Option<Interest>>,
+
+ #[cfg(debug_assertions)]
+ counters: DebugCounters,
+}
+
+/// Extra counters added to `FilterState` used only to make debug assertions.
+#[cfg(debug_assertions)]
+#[derive(Debug, Default)]
+struct DebugCounters {
+ /// How many per-layer filters have participated in the current `enabled`
+ /// call?
+ in_filter_pass: Cell<usize>,
+
+ /// How many per-layer filters have participated in the current `register_callsite`
+ /// call?
+ in_interest_pass: Cell<usize>,
+}
+
+thread_local! {
+ pub(crate) static FILTERING: FilterState = FilterState::new();
+}
+
+/// Extension trait adding [combinators] for combining [`Filter`].
+///
+/// [combinators]: crate::filter::combinator
+/// [`Filter`]: crate::layer::Filter
+pub trait FilterExt<S>: layer::Filter<S> {
+ /// Combines this [`Filter`] with another [`Filter`] s so that spans and
+ /// events are enabled if and only if *both* filters return `true`.
+ ///
+ /// # Examples
+ ///
+ /// Enabling spans or events if they have both a particular target *and* are
+ /// above a certain level:
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, FilterExt},
+ /// prelude::*,
+ /// };
+ ///
+ /// // Enables spans and events with targets starting with `interesting_target`:
+ /// let target_filter = filter_fn(|meta| {
+ /// meta.target().starts_with("interesting_target")
+ /// });
+ ///
+ /// // Enables spans and events with levels `INFO` and below:
+ /// let level_filter = LevelFilter::INFO;
+ ///
+ /// // Combine the two filters together, returning a filter that only enables
+ /// // spans and events that *both* filters will enable:
+ /// let filter = target_filter.and(level_filter);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::info!("an event with an uninteresting target");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!(target: "interesting_target", "a very interesting event");
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::debug!(target: "interesting_target", "interesting debug event...");
+ /// ```
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ fn and<B>(self, other: B) -> combinator::And<Self, B, S>
+ where
+ Self: Sized,
+ B: layer::Filter<S>,
+ {
+ combinator::And::new(self, other)
+ }
+
+ /// Combines two [`Filter`]s so that spans and events are enabled if *either* filter
+ /// returns `true`.
+ ///
+ /// # Examples
+ ///
+ /// Enabling spans and events at the `INFO` level and above, and all spans
+ /// and events with a particular target:
+ /// ```
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, FilterExt},
+ /// prelude::*,
+ /// };
+ ///
+ /// // Enables spans and events with targets starting with `interesting_target`:
+ /// let target_filter = filter_fn(|meta| {
+ /// meta.target().starts_with("interesting_target")
+ /// });
+ ///
+ /// // Enables spans and events with levels `INFO` and below:
+ /// let level_filter = LevelFilter::INFO;
+ ///
+ /// // Combine the two filters together so that a span or event is enabled
+ /// // if it is at INFO or lower, or if it has a target starting with
+ /// // `interesting_target`.
+ /// let filter = level_filter.or(target_filter);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ ///
+ /// // This event will *not* be enabled:
+ /// tracing::debug!("an uninteresting event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!("an uninteresting INFO event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::info!(target: "interesting_target", "a very interesting event");
+ ///
+ /// // This event *will* be enabled:
+ /// tracing::debug!(target: "interesting_target", "interesting debug event...");
+ /// ```
+ ///
+ /// Enabling a higher level for a particular target by using `or` in
+ /// conjunction with the [`and`] combinator:
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, FilterExt},
+ /// prelude::*,
+ /// };
+ ///
+ /// // This filter will enable spans and events with targets beginning with
+ /// // `my_crate`:
+ /// let my_crate = filter_fn(|meta| {
+ /// meta.target().starts_with("my_crate")
+ /// });
+ ///
+ /// let filter = my_crate
+ /// // Combine the `my_crate` filter with a `LevelFilter` to produce a
+ /// // filter that will enable the `INFO` level and lower for spans and
+ /// // events with `my_crate` targets:
+ /// .and(LevelFilter::INFO)
+ /// // If a span or event *doesn't* have a target beginning with
+ /// // `my_crate`, enable it if it has the `WARN` level or lower:
+ /// .or(LevelFilter::WARN);
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ /// ```
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [`and`]: FilterExt::and
+ fn or<B>(self, other: B) -> combinator::Or<Self, B, S>
+ where
+ Self: Sized,
+ B: layer::Filter<S>,
+ {
+ combinator::Or::new(self, other)
+ }
+
+ /// Inverts `self`, returning a filter that enables spans and events only if
+ /// `self` would *not* enable them.
+ ///
+ /// This inverts the values returned by the [`enabled`] and [`callsite_enabled`]
+ /// methods on the wrapped filter; it does *not* invert [`event_enabled`], as
+ /// filters which do not implement filtering on event field values will return
+ /// the default `true` even for events that their [`enabled`] method disables.
+ ///
+ /// Consider a normal filter defined as:
+ ///
+ /// ```ignore (pseudo-code)
+ /// // for spans
+ /// match callsite_enabled() {
+ /// ALWAYS => on_span(),
+ /// SOMETIMES => if enabled() { on_span() },
+ /// NEVER => (),
+ /// }
+ /// // for events
+ /// match callsite_enabled() {
+ /// ALWAYS => on_event(),
+ /// SOMETIMES => if enabled() && event_enabled() { on_event() },
+ /// NEVER => (),
+ /// }
+ /// ```
+ ///
+ /// and an inverted filter defined as:
+ ///
+ /// ```ignore (pseudo-code)
+ /// // for spans
+ /// match callsite_enabled() {
+ /// ALWAYS => (),
+ /// SOMETIMES => if !enabled() { on_span() },
+ /// NEVER => on_span(),
+ /// }
+ /// // for events
+ /// match callsite_enabled() {
+ /// ALWAYS => (),
+ /// SOMETIMES => if !enabled() { on_event() },
+ /// NEVER => on_event(),
+ /// }
+ /// ```
+ ///
+ /// A proper inversion would do `!(enabled() && event_enabled())` (or
+ /// `!enabled() || !event_enabled()`), but because of the implicit `&&`
+ /// relation between `enabled` and `event_enabled`, it is difficult to
+ /// short circuit and not call the wrapped `event_enabled`.
+ ///
+ /// A combinator which remembers the result of `enabled` in order to call
+ /// `event_enabled` only when `enabled() == true` is possible, but requires
+ /// additional thread-local mutable state to support a very niche use case.
+ //
+ // Also, it'd mean the wrapped layer's `enabled()` always gets called and
+ // globally applied to events where it doesn't today, since we can't know
+ // what `event_enabled` will say until we have the event to call it with.
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [`enabled`]: crate::layer::Filter::enabled
+ /// [`event_enabled`]: crate::layer::Filter::event_enabled
+ /// [`callsite_enabled`]: crate::layer::Filter::callsite_enabled
+ fn not(self) -> combinator::Not<Self, S>
+ where
+ Self: Sized,
+ {
+ combinator::Not::new(self)
+ }
+
+ /// [Boxes] `self`, erasing its concrete type.
+ ///
+ /// This is equivalent to calling [`Box::new`], but in method form, so that
+ /// it can be used when chaining combinator methods.
+ ///
+ /// # Examples
+ ///
+ /// When different combinations of filters are used conditionally, they may
+ /// have different types. For example, the following code won't compile,
+ /// since the `if` and `else` clause produce filters of different types:
+ ///
+ /// ```compile_fail
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, FilterExt},
+ /// prelude::*,
+ /// };
+ ///
+ /// let enable_bar_target: bool = // ...
+ /// # false;
+ ///
+ /// let filter = if enable_bar_target {
+ /// filter_fn(|meta| meta.target().starts_with("foo"))
+ /// // If `enable_bar_target` is true, add a `filter_fn` enabling
+ /// // spans and events with the target `bar`:
+ /// .or(filter_fn(|meta| meta.target().starts_with("bar")))
+ /// .and(LevelFilter::INFO)
+ /// } else {
+ /// filter_fn(|meta| meta.target().starts_with("foo"))
+ /// .and(LevelFilter::INFO)
+ /// };
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ /// ```
+ ///
+ /// By using `boxed`, the types of the two different branches can be erased,
+ /// so the assignment to the `filter` variable is valid (as both branches
+ /// have the type `Box<dyn Filter<S> + Send + Sync + 'static>`). The
+ /// following code *does* compile:
+ ///
+ /// ```
+ /// use tracing_subscriber::{
+ /// filter::{filter_fn, LevelFilter, FilterExt},
+ /// prelude::*,
+ /// };
+ ///
+ /// let enable_bar_target: bool = // ...
+ /// # false;
+ ///
+ /// let filter = if enable_bar_target {
+ /// filter_fn(|meta| meta.target().starts_with("foo"))
+ /// .or(filter_fn(|meta| meta.target().starts_with("bar")))
+ /// .and(LevelFilter::INFO)
+ /// // Boxing the filter erases its type, so both branches now
+ /// // have the same type.
+ /// .boxed()
+ /// } else {
+ /// filter_fn(|meta| meta.target().starts_with("foo"))
+ /// .and(LevelFilter::INFO)
+ /// .boxed()
+ /// };
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(tracing_subscriber::fmt::layer().with_filter(filter))
+ /// .init();
+ /// ```
+ ///
+ /// [Boxes]: std::boxed
+ /// [`Box::new`]: std::boxed::Box::new
+ fn boxed(self) -> Box<dyn layer::Filter<S> + Send + Sync + 'static>
+ where
+ Self: Sized + Send + Sync + 'static,
+ {
+ Box::new(self)
+ }
+}
+
+// === impl Filter ===
+
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+impl<S> layer::Filter<S> for LevelFilter {
+ fn enabled(&self, meta: &Metadata<'_>, _: &Context<'_, S>) -> bool {
+ meta.level() <= self
+ }
+
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ if meta.level() <= self {
+ Interest::always()
+ } else {
+ Interest::never()
+ }
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ Some(*self)
+ }
+}
+
+macro_rules! filter_impl_body {
+ () => {
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, cx: &Context<'_, S>) -> bool {
+ self.deref().enabled(meta, cx)
+ }
+
+ #[inline]
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ self.deref().callsite_enabled(meta)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.deref().max_level_hint()
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool {
+ self.deref().event_enabled(event, cx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, id: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ self.deref().on_record(id, values, ctx)
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_enter(id, ctx)
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_exit(id, ctx)
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ self.deref().on_close(id, ctx)
+ }
+ };
+}
+
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+impl<S> layer::Filter<S> for Arc<dyn layer::Filter<S> + Send + Sync + 'static> {
+ filter_impl_body!();
+}
+
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+impl<S> layer::Filter<S> for Box<dyn layer::Filter<S> + Send + Sync + 'static> {
+ filter_impl_body!();
+}
+
+// Implement Filter for Option<Filter> where None => allow
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+impl<F, S> layer::Filter<S> for Option<F>
+where
+ F: layer::Filter<S>,
+{
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>, ctx: &Context<'_, S>) -> bool {
+ self.as_ref()
+ .map(|inner| inner.enabled(meta, ctx))
+ .unwrap_or(true)
+ }
+
+ #[inline]
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ self.as_ref()
+ .map(|inner| inner.callsite_enabled(meta))
+ .unwrap_or_else(Interest::always)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.as_ref().and_then(|inner| inner.max_level_hint())
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, ctx: &Context<'_, S>) -> bool {
+ self.as_ref()
+ .map(|inner| inner.event_enabled(event, ctx))
+ .unwrap_or(true)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(inner) = self {
+ inner.on_new_span(attrs, id, ctx)
+ }
+ }
+
+ #[inline]
+ fn on_record(&self, id: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ if let Some(inner) = self {
+ inner.on_record(id, values, ctx)
+ }
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(inner) = self {
+ inner.on_enter(id, ctx)
+ }
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(inner) = self {
+ inner.on_exit(id, ctx)
+ }
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ if let Some(inner) = self {
+ inner.on_close(id, ctx)
+ }
+ }
+}
+
+// === impl Filtered ===
+
+impl<L, F, S> Filtered<L, F, S> {
+ /// Wraps the provided [`Layer`] so that it is filtered by the given
+ /// [`Filter`].
+ ///
+ /// This is equivalent to calling the [`Layer::with_filter`] method.
+ ///
+ /// See the [documentation on per-layer filtering][plf] for details.
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [plf]: crate::layer#per-layer-filtering
+ pub fn new(layer: L, filter: F) -> Self {
+ Self {
+ layer,
+ filter,
+ id: MagicPlfDowncastMarker(FilterId::disabled()),
+ _s: PhantomData,
+ }
+ }
+
+ #[inline(always)]
+ fn id(&self) -> FilterId {
+ debug_assert!(
+ !self.id.0.is_disabled(),
+ "a `Filtered` layer was used, but it had no `FilterId`; \
+ was it registered with the subscriber?"
+ );
+ self.id.0
+ }
+
+ fn did_enable(&self, f: impl FnOnce()) {
+ FILTERING.with(|filtering| filtering.did_enable(self.id(), f))
+ }
+
+ /// Borrows the [`Filter`](crate::layer::Filter) used by this layer.
+ pub fn filter(&self) -> &F {
+ &self.filter
+ }
+
+ /// Mutably borrows the [`Filter`](crate::layer::Filter) used by this layer.
+ ///
+ /// When this layer can be mutably borrowed, this may be used to mutate the filter.
+ /// Generally, this will primarily be used with the
+ /// [`reload::Handle::modify`](crate::reload::Handle::modify) method.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::info;
+ /// # use tracing_subscriber::{filter,fmt,reload,Registry,prelude::*};
+ /// # fn main() {
+ /// let filtered_layer = fmt::Layer::default().with_filter(filter::LevelFilter::WARN);
+ /// let (filtered_layer, reload_handle) = reload::Layer::new(filtered_layer);
+ /// #
+ /// # // specifying the Registry type is required
+ /// # let _: &reload::Handle<filter::Filtered<fmt::Layer<Registry>,
+ /// # filter::LevelFilter, Registry>,Registry>
+ /// # = &reload_handle;
+ /// #
+ /// info!("This will be ignored");
+ /// reload_handle.modify(|layer| *layer.filter_mut() = filter::LevelFilter::INFO);
+ /// info!("This will be logged");
+ /// # }
+ /// ```
+ pub fn filter_mut(&mut self) -> &mut F {
+ &mut self.filter
+ }
+
+ /// Borrows the inner [`Layer`] wrapped by this `Filtered` layer.
+ pub fn inner(&self) -> &L {
+ &self.layer
+ }
+
+ /// Mutably borrows the inner [`Layer`] wrapped by this `Filtered` layer.
+ ///
+ /// This method is primarily expected to be used with the
+ /// [`reload::Handle::modify`](crate::reload::Handle::modify) method.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::info;
+ /// # use tracing_subscriber::{filter,fmt,reload,Registry,prelude::*};
+ /// # fn non_blocking<T: std::io::Write>(writer: T) -> (fn() -> std::io::Stdout) {
+ /// # std::io::stdout
+ /// # }
+ /// # fn main() {
+ /// let filtered_layer = fmt::layer().with_writer(non_blocking(std::io::stderr())).with_filter(filter::LevelFilter::INFO);
+ /// let (filtered_layer, reload_handle) = reload::Layer::new(filtered_layer);
+ /// #
+ /// # // specifying the Registry type is required
+ /// # let _: &reload::Handle<filter::Filtered<fmt::Layer<Registry, _, _, fn() -> std::io::Stdout>,
+ /// # filter::LevelFilter, Registry>, Registry>
+ /// # = &reload_handle;
+ /// #
+ /// info!("This will be logged to stderr");
+ /// reload_handle.modify(|layer| *layer.inner_mut().writer_mut() = non_blocking(std::io::stdout()));
+ /// info!("This will be logged to stdout");
+ /// # }
+ /// ```
+ ///
+ /// [`Layer`]: crate::layer::Layer
+ pub fn inner_mut(&mut self) -> &mut L {
+ &mut self.layer
+ }
+}
+
+impl<S, L, F> Layer<S> for Filtered<L, F, S>
+where
+ S: Subscriber + for<'span> registry::LookupSpan<'span> + 'static,
+ F: layer::Filter<S> + 'static,
+ L: Layer<S>,
+{
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ self.layer.on_register_dispatch(subscriber);
+ }
+
+ fn on_layer(&mut self, subscriber: &mut S) {
+ self.id = MagicPlfDowncastMarker(subscriber.register_filter());
+ self.layer.on_layer(subscriber);
+ }
+
+ // TODO(eliza): can we figure out a nice way to make the `Filtered` layer
+ // not call `is_enabled_for` in hooks that the inner layer doesn't actually
+ // have real implementations of? probably not...
+ //
+ // it would be cool if there was some wild rust reflection way of checking
+ // if a trait impl has the default impl of a trait method or not, but that's
+ // almsot certainly impossible...right?
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ let interest = self.filter.callsite_enabled(metadata);
+
+ // If the filter didn't disable the callsite, allow the inner layer to
+ // register it — since `register_callsite` is also used for purposes
+ // such as reserving/caching per-callsite data, we want the inner layer
+ // to be able to perform any other registration steps. However, we'll
+ // ignore its `Interest`.
+ if !interest.is_never() {
+ self.layer.register_callsite(metadata);
+ }
+
+ // Add our `Interest` to the current sum of per-layer filter `Interest`s
+ // for this callsite.
+ FILTERING.with(|filtering| filtering.add_interest(interest));
+
+ // don't short circuit! if the stack consists entirely of `Layer`s with
+ // per-layer filters, the `Registry` will return the actual `Interest`
+ // value that's the sum of all the `register_callsite` calls to those
+ // per-layer filters. if we returned an actual `never` interest here, a
+ // `Layered` layer would short-circuit and not allow any `Filtered`
+ // layers below us if _they_ are interested in the callsite.
+ Interest::always()
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>, cx: Context<'_, S>) -> bool {
+ let cx = cx.with_filter(self.id());
+ let enabled = self.filter.enabled(metadata, &cx);
+ FILTERING.with(|filtering| filtering.set(self.id(), enabled));
+
+ if enabled {
+ // If the filter enabled this metadata, ask the wrapped layer if
+ // _it_ wants it --- it might have a global filter.
+ self.layer.enabled(metadata, cx)
+ } else {
+ // Otherwise, return `true`. The _per-layer_ filter disabled this
+ // metadata, but returning `false` in `Layer::enabled` will
+ // short-circuit and globally disable the span or event. This is
+ // *not* what we want for per-layer filters, as other layers may
+ // still want this event. Returning `true` here means we'll continue
+ // asking the next layer in the stack.
+ //
+ // Once all per-layer filters have been evaluated, the `Registry`
+ // at the root of the stack will return `false` from its `enabled`
+ // method if *every* per-layer filter disabled this metadata.
+ // Otherwise, the individual per-layer filters will skip the next
+ // `new_span` or `on_event` call for their layer if *they* disabled
+ // the span or event, but it was not globally disabled.
+ true
+ }
+ }
+
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, cx: Context<'_, S>) {
+ self.did_enable(|| {
+ let cx = cx.with_filter(self.id());
+ self.filter.on_new_span(attrs, id, cx.clone());
+ self.layer.on_new_span(attrs, id, cx);
+ })
+ }
+
+ #[doc(hidden)]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.filter.max_level_hint()
+ }
+
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, cx: Context<'_, S>) {
+ if let Some(cx) = cx.if_enabled_for(span, self.id()) {
+ self.filter.on_record(span, values, cx.clone());
+ self.layer.on_record(span, values, cx)
+ }
+ }
+
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, cx: Context<'_, S>) {
+ // only call `on_follows_from` if both spans are enabled by us
+ if cx.is_enabled_for(span, self.id()) && cx.is_enabled_for(follows, self.id()) {
+ self.layer
+ .on_follows_from(span, follows, cx.with_filter(self.id()))
+ }
+ }
+
+ fn event_enabled(&self, event: &Event<'_>, cx: Context<'_, S>) -> bool {
+ let cx = cx.with_filter(self.id());
+ let enabled = FILTERING
+ .with(|filtering| filtering.and(self.id(), || self.filter.event_enabled(event, &cx)));
+
+ if enabled {
+ // If the filter enabled this event, ask the wrapped subscriber if
+ // _it_ wants it --- it might have a global filter.
+ self.layer.event_enabled(event, cx)
+ } else {
+ // Otherwise, return `true`. See the comment in `enabled` for why this
+ // is necessary.
+ true
+ }
+ }
+
+ fn on_event(&self, event: &Event<'_>, cx: Context<'_, S>) {
+ self.did_enable(|| {
+ self.layer.on_event(event, cx.with_filter(self.id()));
+ })
+ }
+
+ fn on_enter(&self, id: &span::Id, cx: Context<'_, S>) {
+ if let Some(cx) = cx.if_enabled_for(id, self.id()) {
+ self.filter.on_enter(id, cx.clone());
+ self.layer.on_enter(id, cx);
+ }
+ }
+
+ fn on_exit(&self, id: &span::Id, cx: Context<'_, S>) {
+ if let Some(cx) = cx.if_enabled_for(id, self.id()) {
+ self.filter.on_exit(id, cx.clone());
+ self.layer.on_exit(id, cx);
+ }
+ }
+
+ fn on_close(&self, id: span::Id, cx: Context<'_, S>) {
+ if let Some(cx) = cx.if_enabled_for(&id, self.id()) {
+ self.filter.on_close(id.clone(), cx.clone());
+ self.layer.on_close(id, cx);
+ }
+ }
+
+ // XXX(eliza): the existence of this method still makes me sad...
+ fn on_id_change(&self, old: &span::Id, new: &span::Id, cx: Context<'_, S>) {
+ if let Some(cx) = cx.if_enabled_for(old, self.id()) {
+ self.layer.on_id_change(old, new, cx)
+ }
+ }
+
+ #[doc(hidden)]
+ #[inline]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ match id {
+ id if id == TypeId::of::<Self>() => Some(self as *const _ as *const ()),
+ id if id == TypeId::of::<L>() => Some(&self.layer as *const _ as *const ()),
+ id if id == TypeId::of::<F>() => Some(&self.filter as *const _ as *const ()),
+ id if id == TypeId::of::<MagicPlfDowncastMarker>() => {
+ Some(&self.id as *const _ as *const ())
+ }
+ _ => self.layer.downcast_raw(id),
+ }
+ }
+}
+
+impl<F, L, S> fmt::Debug for Filtered<F, L, S>
+where
+ F: fmt::Debug,
+ L: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Filtered")
+ .field("filter", &self.filter)
+ .field("layer", &self.layer)
+ .field("id", &self.id)
+ .finish()
+ }
+}
+
+// === impl FilterId ===
+
+impl FilterId {
+ const fn disabled() -> Self {
+ Self(std::u64::MAX)
+ }
+
+ /// Returns a `FilterId` that will consider _all_ spans enabled.
+ pub(crate) const fn none() -> Self {
+ Self(0)
+ }
+
+ pub(crate) fn new(id: u8) -> Self {
+ assert!(id < 64, "filter IDs may not be greater than 64");
+ Self(1 << id as usize)
+ }
+
+ /// Combines two `FilterId`s, returning a new `FilterId` that will match a
+ /// [`FilterMap`] where the span was disabled by _either_ this `FilterId`
+ /// *or* the combined `FilterId`.
+ ///
+ /// This method is called by [`Context`]s when adding the `FilterId` of a
+ /// [`Filtered`] layer to the context.
+ ///
+ /// This is necessary for cases where we have a tree of nested [`Filtered`]
+ /// layers, like this:
+ ///
+ /// ```text
+ /// Filtered {
+ /// filter1,
+ /// Layered {
+ /// layer1,
+ /// Filtered {
+ /// filter2,
+ /// layer2,
+ /// },
+ /// }
+ /// ```
+ ///
+ /// We want `layer2` to be affected by both `filter1` _and_ `filter2`.
+ /// Without combining `FilterId`s, this works fine when filtering
+ /// `on_event`/`new_span`, because the outer `Filtered` layer (`filter1`)
+ /// won't call the inner layer's `on_event` or `new_span` callbacks if it
+ /// disabled the event/span.
+ ///
+ /// However, it _doesn't_ work when filtering span lookups and traversals
+ /// (e.g. `scope`). This is because the [`Context`] passed to `layer2`
+ /// would set its filter ID to the filter ID of `filter2`, and would skip
+ /// spans that were disabled by `filter2`. However, what if a span was
+ /// disabled by `filter1`? We wouldn't see it in `new_span`, but we _would_
+ /// see it in lookups and traversals...which we don't want.
+ ///
+ /// When a [`Filtered`] layer adds its ID to a [`Context`], it _combines_ it
+ /// with any previous filter ID that the context had, rather than replacing
+ /// it. That way, `layer2`'s context will check if a span was disabled by
+ /// `filter1` _or_ `filter2`. The way we do this, instead of representing
+ /// `FilterId`s as a number number that we shift a 1 over by to get a mask,
+ /// we just store the actual mask,so we can combine them with a bitwise-OR.
+ ///
+ /// For example, if we consider the following case (pretending that the
+ /// masks are 8 bits instead of 64 just so i don't have to write out a bunch
+ /// of extra zeroes):
+ ///
+ /// - `filter1` has the filter id 1 (`0b0000_0001`)
+ /// - `filter2` has the filter id 2 (`0b0000_0010`)
+ ///
+ /// A span that gets disabled by filter 1 would have the [`FilterMap`] with
+ /// bits `0b0000_0001`.
+ ///
+ /// If the `FilterId` was internally represented as `(bits to shift + 1),
+ /// when `layer2`'s [`Context`] checked if it enabled the span, it would
+ /// make the mask `0b0000_0010` (`1 << 1`). That bit would not be set in the
+ /// [`FilterMap`], so it would see that it _didn't_ disable the span. Which
+ /// is *true*, it just doesn't reflect the tree-like shape of the actual
+ /// subscriber.
+ ///
+ /// By having the IDs be masks instead of shifts, though, when the
+ /// [`Filtered`] with `filter2` gets the [`Context`] with `filter1`'s filter ID,
+ /// instead of replacing it, it ors them together:
+ ///
+ /// ```ignore
+ /// 0b0000_0001 | 0b0000_0010 == 0b0000_0011;
+ /// ```
+ ///
+ /// We then test if the span was disabled by seeing if _any_ bits in the
+ /// mask are `1`:
+ ///
+ /// ```ignore
+ /// filtermap & mask != 0;
+ /// 0b0000_0001 & 0b0000_0011 != 0;
+ /// 0b0000_0001 != 0;
+ /// true;
+ /// ```
+ ///
+ /// [`Context`]: crate::layer::Context
+ pub(crate) fn and(self, FilterId(other): Self) -> Self {
+ // If this mask is disabled, just return the other --- otherwise, we
+ // would always see that every span is disabled.
+ if self.0 == Self::disabled().0 {
+ return Self(other);
+ }
+
+ Self(self.0 | other)
+ }
+
+ fn is_disabled(self) -> bool {
+ self.0 == Self::disabled().0
+ }
+}
+
+impl fmt::Debug for FilterId {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // don't print a giant set of the numbers 0..63 if the filter ID is disabled.
+ if self.0 == Self::disabled().0 {
+ return f
+ .debug_tuple("FilterId")
+ .field(&format_args!("DISABLED"))
+ .finish();
+ }
+
+ if f.alternate() {
+ f.debug_struct("FilterId")
+ .field("ids", &format_args!("{:?}", FmtBitset(self.0)))
+ .field("bits", &format_args!("{:b}", self.0))
+ .finish()
+ } else {
+ f.debug_tuple("FilterId").field(&FmtBitset(self.0)).finish()
+ }
+ }
+}
+
+impl fmt::Binary for FilterId {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_tuple("FilterId")
+ .field(&format_args!("{:b}", self.0))
+ .finish()
+ }
+}
+
+// === impl FilterExt ===
+
+impl<F, S> FilterExt<S> for F where F: layer::Filter<S> {}
+
+// === impl FilterMap ===
+
+impl FilterMap {
+ pub(crate) fn set(self, FilterId(mask): FilterId, enabled: bool) -> Self {
+ if mask == std::u64::MAX {
+ return self;
+ }
+
+ if enabled {
+ Self {
+ bits: self.bits & (!mask),
+ }
+ } else {
+ Self {
+ bits: self.bits | mask,
+ }
+ }
+ }
+
+ #[inline]
+ pub(crate) fn is_enabled(self, FilterId(mask): FilterId) -> bool {
+ self.bits & mask == 0
+ }
+
+ #[inline]
+ pub(crate) fn any_enabled(self) -> bool {
+ self.bits != std::u64::MAX
+ }
+}
+
+impl fmt::Debug for FilterMap {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let alt = f.alternate();
+ let mut s = f.debug_struct("FilterMap");
+ s.field("disabled_by", &format_args!("{:?}", &FmtBitset(self.bits)));
+
+ if alt {
+ s.field("bits", &format_args!("{:b}", self.bits));
+ }
+
+ s.finish()
+ }
+}
+
+impl fmt::Binary for FilterMap {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FilterMap")
+ .field("bits", &format_args!("{:b}", self.bits))
+ .finish()
+ }
+}
+
+// === impl FilterState ===
+
+impl FilterState {
+ fn new() -> Self {
+ Self {
+ enabled: Cell::new(FilterMap::default()),
+ interest: RefCell::new(None),
+
+ #[cfg(debug_assertions)]
+ counters: DebugCounters::default(),
+ }
+ }
+
+ fn set(&self, filter: FilterId, enabled: bool) {
+ #[cfg(debug_assertions)]
+ {
+ let in_current_pass = self.counters.in_filter_pass.get();
+ if in_current_pass == 0 {
+ debug_assert_eq!(self.enabled.get(), FilterMap::default());
+ }
+ self.counters.in_filter_pass.set(in_current_pass + 1);
+ debug_assert_eq!(
+ self.counters.in_interest_pass.get(),
+ 0,
+ "if we are in or starting a filter pass, we must not be in an interest pass."
+ )
+ }
+
+ self.enabled.set(self.enabled.get().set(filter, enabled))
+ }
+
+ fn add_interest(&self, interest: Interest) {
+ let mut curr_interest = self.interest.borrow_mut();
+
+ #[cfg(debug_assertions)]
+ {
+ let in_current_pass = self.counters.in_interest_pass.get();
+ if in_current_pass == 0 {
+ debug_assert!(curr_interest.is_none());
+ }
+ self.counters.in_interest_pass.set(in_current_pass + 1);
+ }
+
+ if let Some(curr_interest) = curr_interest.as_mut() {
+ if (curr_interest.is_always() && !interest.is_always())
+ || (curr_interest.is_never() && !interest.is_never())
+ {
+ *curr_interest = Interest::sometimes();
+ }
+ // If the two interests are the same, do nothing. If the current
+ // interest is `sometimes`, stay sometimes.
+ } else {
+ *curr_interest = Some(interest);
+ }
+ }
+
+ pub(crate) fn event_enabled() -> bool {
+ FILTERING
+ .try_with(|this| {
+ let enabled = this.enabled.get().any_enabled();
+ #[cfg(debug_assertions)]
+ {
+ if this.counters.in_filter_pass.get() == 0 {
+ debug_assert_eq!(this.enabled.get(), FilterMap::default());
+ }
+
+ // Nothing enabled this event, we won't tick back down the
+ // counter in `did_enable`. Reset it.
+ if !enabled {
+ this.counters.in_filter_pass.set(0);
+ }
+ }
+ enabled
+ })
+ .unwrap_or(true)
+ }
+
+ /// Executes a closure if the filter with the provided ID did not disable
+ /// the current span/event.
+ ///
+ /// This is used to implement the `on_event` and `new_span` methods for
+ /// `Filtered`.
+ fn did_enable(&self, filter: FilterId, f: impl FnOnce()) {
+ let map = self.enabled.get();
+ if map.is_enabled(filter) {
+ // If the filter didn't disable the current span/event, run the
+ // callback.
+ f();
+ } else {
+ // Otherwise, if this filter _did_ disable the span or event
+ // currently being processed, clear its bit from this thread's
+ // `FilterState`. The bit has already been "consumed" by skipping
+ // this callback, and we need to ensure that the `FilterMap` for
+ // this thread is reset when the *next* `enabled` call occurs.
+ self.enabled.set(map.set(filter, true));
+ }
+ #[cfg(debug_assertions)]
+ {
+ let in_current_pass = self.counters.in_filter_pass.get();
+ if in_current_pass <= 1 {
+ debug_assert_eq!(self.enabled.get(), FilterMap::default());
+ }
+ self.counters
+ .in_filter_pass
+ .set(in_current_pass.saturating_sub(1));
+ debug_assert_eq!(
+ self.counters.in_interest_pass.get(),
+ 0,
+ "if we are in a filter pass, we must not be in an interest pass."
+ )
+ }
+ }
+
+ /// Run a second filtering pass, e.g. for Layer::event_enabled.
+ fn and(&self, filter: FilterId, f: impl FnOnce() -> bool) -> bool {
+ let map = self.enabled.get();
+ let enabled = map.is_enabled(filter) && f();
+ self.enabled.set(map.set(filter, enabled));
+ enabled
+ }
+
+ /// Clears the current in-progress filter state.
+ ///
+ /// This resets the [`FilterMap`] and current [`Interest`] as well as
+ /// clearing the debug counters.
+ pub(crate) fn clear_enabled() {
+ // Drop the `Result` returned by `try_with` --- if we are in the middle
+ // a panic and the thread-local has been torn down, that's fine, just
+ // ignore it ratehr than panicking.
+ let _ = FILTERING.try_with(|filtering| {
+ filtering.enabled.set(FilterMap::default());
+
+ #[cfg(debug_assertions)]
+ filtering.counters.in_filter_pass.set(0);
+ });
+ }
+
+ pub(crate) fn take_interest() -> Option<Interest> {
+ FILTERING
+ .try_with(|filtering| {
+ #[cfg(debug_assertions)]
+ {
+ if filtering.counters.in_interest_pass.get() == 0 {
+ debug_assert!(filtering.interest.try_borrow().ok()?.is_none());
+ }
+ filtering.counters.in_interest_pass.set(0);
+ }
+ filtering.interest.try_borrow_mut().ok()?.take()
+ })
+ .ok()?
+ }
+
+ pub(crate) fn filter_map(&self) -> FilterMap {
+ let map = self.enabled.get();
+ #[cfg(debug_assertions)]
+ {
+ if self.counters.in_filter_pass.get() == 0 {
+ debug_assert_eq!(map, FilterMap::default());
+ }
+ }
+
+ map
+ }
+}
+/// This is a horrible and bad abuse of the downcasting system to expose
+/// *internally* whether a layer has per-layer filtering, within
+/// `tracing-subscriber`, without exposing a public API for it.
+///
+/// If a `Layer` has per-layer filtering, it will downcast to a
+/// `MagicPlfDowncastMarker`. Since layers which contain other layers permit
+/// downcasting to recurse to their children, this will do the Right Thing with
+/// layers like Reload, Option, etc.
+///
+/// Why is this a wrapper around the `FilterId`, you may ask? Because
+/// downcasting works by returning a pointer, and we don't want to risk
+/// introducing UB by constructing pointers that _don't_ point to a valid
+/// instance of the type they claim to be. In this case, we don't _intend_ for
+/// this pointer to be dereferenced, so it would actually be fine to return one
+/// that isn't a valid pointer...but we can't guarantee that the caller won't
+/// (accidentally) dereference it, so it's better to be safe than sorry. We
+/// could, alternatively, add an additional field to the type that's used only
+/// for returning pointers to as as part of the evil downcasting hack, but I
+/// thought it was nicer to just add a `repr(transparent)` wrapper to the
+/// existing `FilterId` field, since it won't make the struct any bigger.
+///
+/// Don't worry, this isn't on the test. :)
+#[derive(Clone, Copy)]
+#[repr(transparent)]
+struct MagicPlfDowncastMarker(FilterId);
+impl fmt::Debug for MagicPlfDowncastMarker {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // Just pretend that `MagicPlfDowncastMarker` doesn't exist for
+ // `fmt::Debug` purposes...if no one *sees* it in their `Debug` output,
+ // they don't have to know I thought this code would be a good idea.
+ fmt::Debug::fmt(&self.0, f)
+ }
+}
+
+pub(crate) fn is_plf_downcast_marker(type_id: TypeId) -> bool {
+ type_id == TypeId::of::<MagicPlfDowncastMarker>()
+}
+
+/// Does a type implementing `Subscriber` contain any per-layer filters?
+pub(crate) fn subscriber_has_plf<S>(subscriber: &S) -> bool
+where
+ S: Subscriber,
+{
+ (subscriber as &dyn Subscriber).is::<MagicPlfDowncastMarker>()
+}
+
+/// Does a type implementing `Layer` contain any per-layer filters?
+pub(crate) fn layer_has_plf<L, S>(layer: &L) -> bool
+where
+ L: Layer<S>,
+ S: Subscriber,
+{
+ unsafe {
+ // Safety: we're not actually *doing* anything with this pointer --- we
+ // only care about the `Option`, which we're turning into a `bool`. So
+ // even if the layer decides to be evil and give us some kind of invalid
+ // pointer, we don't ever dereference it, so this is always safe.
+ layer.downcast_raw(TypeId::of::<MagicPlfDowncastMarker>())
+ }
+ .is_some()
+}
+
+struct FmtBitset(u64);
+
+impl fmt::Debug for FmtBitset {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut set = f.debug_set();
+ for bit in 0..64 {
+ // if the `bit`-th bit is set, add it to the debug set
+ if self.0 & (1 << bit) != 0 {
+ set.entry(&bit);
+ }
+ }
+ set.finish()
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/level.rs b/crates/tracing-subscriber/src/filter/level.rs
new file mode 100644
index 0000000..0fa6012
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/level.rs
@@ -0,0 +1,27 @@
+use tracing_core::{
+ subscriber::{Interest, Subscriber},
+ Metadata,
+};
+
+#[allow(unreachable_pub)] // https://github.com/rust-lang/rust/issues/57411
+pub use tracing_core::metadata::{LevelFilter, ParseLevelFilterError as ParseError};
+
+// === impl LevelFilter ===
+
+impl<S: Subscriber> crate::Layer<S> for LevelFilter {
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ if self >= metadata.level() {
+ Interest::always()
+ } else {
+ Interest::never()
+ }
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>, _: crate::layer::Context<'_, S>) -> bool {
+ self >= metadata.level()
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ Some(*self)
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/mod.rs b/crates/tracing-subscriber/src/filter/mod.rs
new file mode 100644
index 0000000..000a271
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/mod.rs
@@ -0,0 +1,66 @@
+//! [`Layer`]s that control which spans and events are enabled by the wrapped
+//! subscriber.
+//!
+//! This module contains a number of types that provide implementations of
+//! various strategies for filtering which spans and events are enabled. For
+//! details on filtering spans and events using [`Layer`]s, see the
+//! [`layer` module's documentation].
+//!
+//! [`layer` module's documentation]: crate::layer#filtering-with-layers
+//! [`Layer`]: crate::layer
+mod filter_fn;
+
+feature! {
+ #![all(feature = "env-filter", feature = "std")]
+ mod env;
+ pub use self::env::*;
+}
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+ mod layer_filters;
+ pub use self::layer_filters::*;
+}
+
+mod level;
+
+pub use self::filter_fn::*;
+pub use self::level::{LevelFilter, ParseError as LevelParseError};
+
+#[cfg(not(all(feature = "registry", feature = "std")))]
+pub(crate) use self::has_plf_stubs::*;
+
+feature! {
+ #![any(feature = "std", feature = "alloc")]
+ pub mod targets;
+ pub use self::targets::Targets;
+
+ mod directive;
+ pub use self::directive::ParseError;
+}
+
+/// Stub implementations of the per-layer-fitler detection functions for when the
+/// `registry` feature is disabled.
+#[cfg(not(all(feature = "registry", feature = "std")))]
+mod has_plf_stubs {
+ pub(crate) fn is_plf_downcast_marker(_: core::any::TypeId) -> bool {
+ false
+ }
+
+ /// Does a type implementing `Subscriber` contain any per-layer filters?
+ pub(crate) fn subscriber_has_plf<S>(_: &S) -> bool
+ where
+ S: tracing_core::Subscriber,
+ {
+ false
+ }
+
+ /// Does a type implementing `Layer` contain any per-layer filters?
+ pub(crate) fn layer_has_plf<L, S>(_: &L) -> bool
+ where
+ L: crate::Layer<S>,
+ S: tracing_core::Subscriber,
+ {
+ false
+ }
+}
diff --git a/crates/tracing-subscriber/src/filter/targets.rs b/crates/tracing-subscriber/src/filter/targets.rs
new file mode 100644
index 0000000..19f2d99
--- /dev/null
+++ b/crates/tracing-subscriber/src/filter/targets.rs
@@ -0,0 +1,834 @@
+//! A [filter] that enables or disables spans and events based on their [target] and [level].
+//!
+//! See [`Targets`] for details.
+//!
+//! [target]: tracing_core::Metadata::target
+//! [level]: tracing_core::Level
+//! [filter]: crate::layer#filtering-with-layers
+
+use crate::{
+ filter::{
+ directive::{DirectiveSet, ParseError, StaticDirective},
+ LevelFilter,
+ },
+ layer,
+};
+#[cfg(not(feature = "std"))]
+use alloc::string::String;
+use core::{
+ fmt,
+ iter::{Extend, FilterMap, FromIterator},
+ slice,
+ str::FromStr,
+};
+use tracing_core::{Interest, Level, Metadata, Subscriber};
+
+/// A filter that enables or disables spans and events based on their [target]
+/// and [level].
+///
+/// Targets are typically equal to the Rust module path of the code where the
+/// span or event was recorded, although they may be overridden.
+///
+/// This type can be used for both [per-layer filtering][plf] (using its
+/// [`Filter`] implementation) and [global filtering][global] (using its
+/// [`Layer`] implementation).
+///
+/// See the [documentation on filtering with layers][filtering] for details.
+///
+/// # Filtering With `Targets`
+///
+/// A `Targets` filter consists of one or more [target] prefixes, paired with
+/// [`LevelFilter`]s. If a span or event's [target] begins with one of those
+/// prefixes, and its [level] is at or below the [`LevelFilter`] enabled for
+/// that prefix, then the span or event will be enabled.
+///
+/// This is similar to the behavior implemented by the [`env_logger` crate] in
+/// the `log` ecosystem.
+///
+/// The [`EnvFilter`] type also provided by this crate is very similar to `Targets`,
+/// but is capable of a more sophisticated form of filtering where events may
+/// also be enabled or disabled based on the span they are recorded in.
+/// `Targets` can be thought of as a lighter-weight form of [`EnvFilter`] that
+/// can be used instead when this dynamic filtering is not required.
+///
+/// # Examples
+///
+/// A `Targets` filter can be constructed by programmatically adding targets and
+/// levels to enable:
+///
+/// ```
+/// use tracing_subscriber::{filter, prelude::*};
+/// use tracing_core::Level;
+///
+/// let filter = filter::Targets::new()
+/// // Enable the `INFO` level for anything in `my_crate`
+/// .with_target("my_crate", Level::INFO)
+/// // Enable the `DEBUG` level for a specific module.
+/// .with_target("my_crate::interesting_module", Level::DEBUG);
+///
+/// // Build a new subscriber with the `fmt` layer using the `Targets`
+/// // filter we constructed above.
+/// tracing_subscriber::registry()
+/// .with(tracing_subscriber::fmt::layer())
+/// .with(filter)
+/// .init();
+/// ```
+///
+/// [`LevelFilter::OFF`] can be used to disable a particular target:
+/// ```
+/// use tracing_subscriber::filter::{Targets, LevelFilter};
+/// use tracing_core::Level;
+///
+/// let filter = Targets::new()
+/// .with_target("my_crate", Level::INFO)
+/// // Disable all traces from `annoying_module`.
+/// .with_target("my_crate::annoying_module", LevelFilter::OFF);
+/// # drop(filter);
+/// ```
+///
+/// Alternatively, `Targets` implements [`std::str::FromStr`], allowing it to be
+/// parsed from a comma-delimited list of `target=level` pairs. For example:
+///
+/// ```rust
+/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+/// use tracing_subscriber::filter;
+/// use tracing_core::Level;
+///
+/// let filter = "my_crate=info,my_crate::interesting_module=trace,other_crate=debug"
+/// .parse::<filter::Targets>()?;
+///
+/// // The parsed filter is identical to a filter constructed using `with_target`:
+/// assert_eq!(
+/// filter,
+/// filter::Targets::new()
+/// .with_target("my_crate", Level::INFO)
+/// .with_target("my_crate::interesting_module", Level::TRACE)
+/// .with_target("other_crate", Level::DEBUG)
+/// );
+/// # Ok(()) }
+/// ```
+///
+/// This is particularly useful when the list of enabled targets is configurable
+/// by the user at runtime.
+///
+/// The `Targets` filter can be used as a [per-layer filter][plf] *and* as a
+/// [global filter][global]:
+///
+/// ```rust
+/// use tracing_subscriber::{
+/// fmt,
+/// filter::{Targets, LevelFilter},
+/// prelude::*,
+/// };
+/// use tracing_core::Level;
+/// use std::{sync::Arc, fs::File};
+/// # fn docs() -> Result<(), Box<dyn std::error::Error>> {
+///
+/// // A layer that logs events to stdout using the human-readable "pretty"
+/// // format.
+/// let stdout_log = fmt::layer().pretty();
+///
+/// // A layer that logs events to a file, using the JSON format.
+/// let file = File::create("debug_log.json")?;
+/// let debug_log = fmt::layer()
+/// .with_writer(Arc::new(file))
+/// .json();
+///
+/// tracing_subscriber::registry()
+/// // Only log INFO and above to stdout, unless the span or event
+/// // has the `my_crate::cool_module` target prefix.
+/// .with(stdout_log
+/// .with_filter(
+/// Targets::default()
+/// .with_target("my_crate::cool_module", Level::DEBUG)
+/// .with_default(Level::INFO)
+/// )
+/// )
+/// // Log everything enabled by the global filter to `debug_log.json`.
+/// .with(debug_log)
+/// // Configure a global filter for the whole subscriber stack. This will
+/// // control what spans and events are recorded by both the `debug_log`
+/// // and the `stdout_log` layers, and `stdout_log` will *additionally* be
+/// // filtered by its per-layer filter.
+/// .with(
+/// Targets::default()
+/// .with_target("my_crate", Level::TRACE)
+/// .with_target("other_crate", Level::INFO)
+/// .with_target("other_crate::annoying_module", LevelFilter::OFF)
+/// .with_target("third_crate", Level::DEBUG)
+/// ).init();
+/// # Ok(()) }
+///```
+///
+/// [target]: tracing_core::Metadata::target
+/// [level]: tracing_core::Level
+/// [`Filter`]: crate::layer::Filter
+/// [`Layer`]: crate::layer::Layer
+/// [plf]: crate::layer#per-layer-filtering
+/// [global]: crate::layer#global-filtering
+/// [filtering]: crate::layer#filtering-with-layers
+/// [`env_logger` crate]: https://docs.rs/env_logger/0.9.0/env_logger/index.html#enabling-logging
+/// [`EnvFilter`]: crate::filter::EnvFilter
+#[derive(Debug, Default, Clone, PartialEq)]
+pub struct Targets(DirectiveSet<StaticDirective>);
+
+impl Targets {
+ /// Returns a new `Targets` filter.
+ ///
+ /// This filter will enable no targets. Call [`with_target`] or [`with_targets`]
+ /// to add enabled targets, and [`with_default`] to change the default level
+ /// enabled for spans and events that didn't match any of the provided targets.
+ ///
+ /// [`with_target`]: Targets::with_target
+ /// [`with_targets`]: Targets::with_targets
+ /// [`with_default`]: Targets::with_default
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ /// Enables spans and events with [target]s starting with the provided target
+ /// prefix if they are at or below the provided [`LevelFilter`].
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::filter;
+ /// use tracing_core::Level;
+ ///
+ /// let filter = filter::Targets::new()
+ /// // Enable the `INFO` level for anything in `my_crate`
+ /// .with_target("my_crate", Level::INFO)
+ /// // Enable the `DEBUG` level for a specific module.
+ /// .with_target("my_crate::interesting_module", Level::DEBUG);
+ /// # drop(filter);
+ /// ```
+ ///
+ /// [`LevelFilter::OFF`] can be used to disable a particular target:
+ /// ```
+ /// use tracing_subscriber::filter::{Targets, LevelFilter};
+ /// use tracing_core::Level;
+ ///
+ /// let filter = Targets::new()
+ /// .with_target("my_crate", Level::INFO)
+ /// // Disable all traces from `annoying_module`.
+ /// .with_target("my_crate::interesting_module", LevelFilter::OFF);
+ /// # drop(filter);
+ /// ```
+ ///
+ /// [target]: tracing_core::Metadata::target
+ pub fn with_target(mut self, target: impl Into<String>, level: impl Into<LevelFilter>) -> Self {
+ self.0.add(StaticDirective::new(
+ Some(target.into()),
+ Default::default(),
+ level.into(),
+ ));
+ self
+ }
+ /// Adds [target]s from an iterator of [target]-[`LevelFilter`] pairs to this filter.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::filter;
+ /// use tracing_core::Level;
+ ///
+ /// let filter = filter::Targets::new()
+ /// .with_targets(vec![
+ /// ("my_crate", Level::INFO),
+ /// ("my_crate::some_module", Level::DEBUG),
+ /// ("my_crate::other_module::cool_stuff", Level::TRACE),
+ /// ("other_crate", Level::WARN)
+ /// ]);
+ /// # drop(filter);
+ /// ```
+ ///
+ /// [`LevelFilter::OFF`] can be used to disable a particular target:
+ /// ```
+ /// use tracing_subscriber::filter::{Targets, LevelFilter};
+ /// use tracing_core::Level;
+ ///
+ /// let filter = Targets::new()
+ /// .with_target("my_crate", Level::INFO)
+ /// // Disable all traces from `annoying_module`.
+ /// .with_target("my_crate::interesting_module", LevelFilter::OFF);
+ /// # drop(filter);
+ /// ```
+ ///
+ /// [target]: tracing_core::Metadata::target
+ pub fn with_targets<T, L>(mut self, targets: impl IntoIterator<Item = (T, L)>) -> Self
+ where
+ String: From<T>,
+ LevelFilter: From<L>,
+ {
+ self.extend(targets);
+ self
+ }
+
+ /// Sets the default level to enable for spans and events whose targets did
+ /// not match any of the configured prefixes.
+ ///
+ /// By default, this is [`LevelFilter::OFF`]. This means that spans and
+ /// events will only be enabled if they match one of the configured target
+ /// prefixes. If this is changed to a different [`LevelFilter`], spans and
+ /// events with targets that did not match any of the configured prefixes
+ /// will be enabled if their level is at or below the provided level.
+ pub fn with_default(mut self, level: impl Into<LevelFilter>) -> Self {
+ self.0
+ .add(StaticDirective::new(None, Default::default(), level.into()));
+ self
+ }
+
+ /// Returns the default level for this filter, if one is set.
+ ///
+ /// The default level is used to filter any spans or events with targets
+ /// that do not match any of the configured set of prefixes.
+ ///
+ /// The default level can be set for a filter either by using
+ /// [`with_default`](Self::with_default) or when parsing from a filter string that includes a
+ /// level without a target (e.g. `"trace"`).
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::filter::{LevelFilter, Targets};
+ ///
+ /// let filter = Targets::new().with_default(LevelFilter::INFO);
+ /// assert_eq!(filter.default_level(), Some(LevelFilter::INFO));
+ ///
+ /// let filter: Targets = "info".parse().unwrap();
+ /// assert_eq!(filter.default_level(), Some(LevelFilter::INFO));
+ /// ```
+ ///
+ /// The default level is `None` if no default is set:
+ ///
+ /// ```
+ /// use tracing_subscriber::filter::Targets;
+ ///
+ /// let filter = Targets::new();
+ /// assert_eq!(filter.default_level(), None);
+ ///
+ /// let filter: Targets = "my_crate=info".parse().unwrap();
+ /// assert_eq!(filter.default_level(), None);
+ /// ```
+ ///
+ /// Note that an unset default level (`None`) behaves like [`LevelFilter::OFF`] when the filter is
+ /// used, but it could also be set explicitly which may be useful to distinguish (such as when
+ /// merging multiple `Targets`).
+ ///
+ /// ```
+ /// use tracing_subscriber::filter::{LevelFilter, Targets};
+ ///
+ /// let filter = Targets::new().with_default(LevelFilter::OFF);
+ /// assert_eq!(filter.default_level(), Some(LevelFilter::OFF));
+ ///
+ /// let filter: Targets = "off".parse().unwrap();
+ /// assert_eq!(filter.default_level(), Some(LevelFilter::OFF));
+ /// ```
+ pub fn default_level(&self) -> Option<LevelFilter> {
+ self.0.directives().find_map(|d| {
+ if d.target.is_none() {
+ Some(d.level)
+ } else {
+ None
+ }
+ })
+ }
+
+ /// Returns an iterator over the [target]-[`LevelFilter`] pairs in this filter.
+ ///
+ /// The order of iteration is undefined.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::filter::{Targets, LevelFilter};
+ /// use tracing_core::Level;
+ ///
+ /// let filter = Targets::new()
+ /// .with_target("my_crate", Level::INFO)
+ /// .with_target("my_crate::interesting_module", Level::DEBUG);
+ ///
+ /// let mut targets: Vec<_> = filter.iter().collect();
+ /// targets.sort();
+ ///
+ /// assert_eq!(targets, vec![
+ /// ("my_crate", LevelFilter::INFO),
+ /// ("my_crate::interesting_module", LevelFilter::DEBUG),
+ /// ]);
+ /// ```
+ ///
+ /// [target]: tracing_core::Metadata::target
+ pub fn iter(&self) -> Iter<'_> {
+ self.into_iter()
+ }
+
+ #[inline]
+ fn interested(&self, metadata: &'static Metadata<'static>) -> Interest {
+ if self.0.enabled(metadata) {
+ Interest::always()
+ } else {
+ Interest::never()
+ }
+ }
+
+ /// Returns whether a [target]-[`Level`] pair would be enabled
+ /// by this `Targets`.
+ ///
+ /// This method can be used with [`module_path!`] from `std` as the target
+ /// in order to emulate the behavior of the [`tracing::event!`] and [`tracing::span!`]
+ /// macros.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::filter::{Targets, LevelFilter};
+ /// use tracing_core::Level;
+ ///
+ /// let filter = Targets::new()
+ /// .with_target("my_crate", Level::INFO)
+ /// .with_target("my_crate::interesting_module", Level::DEBUG);
+ ///
+ /// assert!(filter.would_enable("my_crate", &Level::INFO));
+ /// assert!(!filter.would_enable("my_crate::interesting_module", &Level::TRACE));
+ /// ```
+ ///
+ /// [target]: tracing_core::Metadata::target
+ /// [`module_path!`]: std::module_path!
+ pub fn would_enable(&self, target: &str, level: &Level) -> bool {
+ // "Correct" to call because `Targets` only produces `StaticDirective`'s with NO
+ // fields
+ self.0.target_enabled(target, level)
+ }
+}
+
+impl<T, L> Extend<(T, L)> for Targets
+where
+ T: Into<String>,
+ L: Into<LevelFilter>,
+{
+ fn extend<I: IntoIterator<Item = (T, L)>>(&mut self, iter: I) {
+ let iter = iter.into_iter().map(|(target, level)| {
+ StaticDirective::new(Some(target.into()), Default::default(), level.into())
+ });
+ self.0.extend(iter);
+ }
+}
+
+impl<T, L> FromIterator<(T, L)> for Targets
+where
+ T: Into<String>,
+ L: Into<LevelFilter>,
+{
+ fn from_iter<I: IntoIterator<Item = (T, L)>>(iter: I) -> Self {
+ let mut this = Self::default();
+ this.extend(iter);
+ this
+ }
+}
+
+impl FromStr for Targets {
+ type Err = ParseError;
+ fn from_str(s: &str) -> Result<Self, Self::Err> {
+ s.split(',')
+ .map(StaticDirective::from_str)
+ .collect::<Result<_, _>>()
+ .map(Self)
+ }
+}
+
+impl<S> layer::Layer<S> for Targets
+where
+ S: Subscriber,
+{
+ fn enabled(&self, metadata: &Metadata<'_>, _: layer::Context<'_, S>) -> bool {
+ self.0.enabled(metadata)
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.interested(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ Some(self.0.max_level)
+ }
+}
+
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+impl<S> layer::Filter<S> for Targets {
+ fn enabled(&self, metadata: &Metadata<'_>, _: &layer::Context<'_, S>) -> bool {
+ self.0.enabled(metadata)
+ }
+
+ fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.interested(metadata)
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ Some(self.0.max_level)
+ }
+}
+
+impl IntoIterator for Targets {
+ type Item = (String, LevelFilter);
+
+ type IntoIter = IntoIter;
+
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter::new(self)
+ }
+}
+
+impl<'a> IntoIterator for &'a Targets {
+ type Item = (&'a str, LevelFilter);
+
+ type IntoIter = Iter<'a>;
+
+ fn into_iter(self) -> Self::IntoIter {
+ Iter::new(self)
+ }
+}
+
+impl fmt::Display for Targets {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut directives = self.0.directives();
+ if let Some(directive) = directives.next() {
+ write!(f, "{}", directive)?;
+ for directive in directives {
+ write!(f, ",{}", directive)?;
+ }
+ }
+
+ Ok(())
+ }
+}
+
+/// An owning iterator over the [target]-[level] pairs of a `Targets` filter.
+///
+/// This struct is created by the `IntoIterator` trait implementation of [`Targets`].
+///
+/// # Examples
+///
+/// Merge the targets from one `Targets` with another:
+///
+/// ```
+/// use tracing_subscriber::filter::Targets;
+/// use tracing_core::Level;
+///
+/// let mut filter = Targets::new().with_target("my_crate", Level::INFO);
+/// let overrides = Targets::new().with_target("my_crate::interesting_module", Level::DEBUG);
+///
+/// filter.extend(overrides);
+/// # drop(filter);
+/// ```
+///
+/// [target]: tracing_core::Metadata::target
+/// [level]: tracing_core::Level
+#[derive(Debug)]
+pub struct IntoIter(
+ #[allow(clippy::type_complexity)] // alias indirection would probably make this more confusing
+ FilterMap<
+ <DirectiveSet<StaticDirective> as IntoIterator>::IntoIter,
+ fn(StaticDirective) -> Option<(String, LevelFilter)>,
+ >,
+);
+
+impl IntoIter {
+ fn new(targets: Targets) -> Self {
+ Self(targets.0.into_iter().filter_map(|directive| {
+ let level = directive.level;
+ directive.target.map(|target| (target, level))
+ }))
+ }
+}
+
+impl Iterator for IntoIter {
+ type Item = (String, LevelFilter);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next()
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// A borrowing iterator over the [target]-[level] pairs of a `Targets` filter.
+///
+/// This struct is created by [`iter`] method of [`Targets`], or from the `IntoIterator`
+/// implementation for `&Targets`.
+///
+/// [target]: tracing_core::Metadata::target
+/// [level]: tracing_core::Level
+/// [`iter`]: Targets::iter
+#[derive(Debug)]
+pub struct Iter<'a>(
+ FilterMap<
+ slice::Iter<'a, StaticDirective>,
+ fn(&'a StaticDirective) -> Option<(&'a str, LevelFilter)>,
+ >,
+);
+
+impl<'a> Iter<'a> {
+ fn new(targets: &'a Targets) -> Self {
+ Self(targets.0.iter().filter_map(|directive| {
+ directive
+ .target
+ .as_deref()
+ .map(|target| (target, directive.level))
+ }))
+ }
+}
+
+impl<'a> Iterator for Iter<'a> {
+ type Item = (&'a str, LevelFilter);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next()
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ feature! {
+ #![not(feature = "std")]
+ use alloc::{vec, vec::Vec, string::ToString};
+
+ // `dbg!` is only available with `libstd`; just nop it out when testing
+ // with alloc only.
+ macro_rules! dbg {
+ ($x:expr) => { $x }
+ }
+ }
+
+ fn expect_parse(s: &str) -> Targets {
+ match dbg!(s).parse::<Targets>() {
+ Err(e) => panic!("string {:?} did not parse successfully: {}", s, e),
+ Ok(e) => e,
+ }
+ }
+
+ fn expect_parse_ralith(s: &str) {
+ let dirs = expect_parse(s).0.into_vec();
+ assert_eq!(dirs.len(), 2, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("server".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[0].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[1].target, Some("common".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::INFO);
+ assert_eq!(dirs[1].field_names, Vec::<String>::new());
+ }
+
+ fn expect_parse_level_directives(s: &str) {
+ let dirs = expect_parse(s).0.into_vec();
+ assert_eq!(dirs.len(), 6, "\nparsed: {:#?}", dirs);
+
+ assert_eq!(dirs[0].target, Some("crate3::mod2::mod1".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::OFF);
+ assert_eq!(dirs[0].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[1].target, Some("crate1::mod2::mod3".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::INFO);
+ assert_eq!(dirs[1].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[2].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::WARN);
+ assert_eq!(dirs[2].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[3].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::ERROR);
+ assert_eq!(dirs[3].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[4].target, Some("crate3".to_string()));
+ assert_eq!(dirs[4].level, LevelFilter::TRACE);
+ assert_eq!(dirs[4].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[5].target, Some("crate2".to_string()));
+ assert_eq!(dirs[5].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[5].field_names, Vec::<String>::new());
+ }
+
+ #[test]
+ fn parse_ralith() {
+ expect_parse_ralith("common=info,server=debug");
+ }
+
+ #[test]
+ fn parse_ralith_uc() {
+ expect_parse_ralith("common=INFO,server=DEBUG");
+ }
+
+ #[test]
+ fn parse_ralith_mixed() {
+ expect_parse("common=iNfo,server=dEbUg");
+ }
+
+ #[test]
+ fn expect_parse_valid() {
+ let dirs = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off")
+ .0
+ .into_vec();
+ assert_eq!(dirs.len(), 4, "\nparsed: {:#?}", dirs);
+ assert_eq!(dirs[0].target, Some("crate1::mod2".to_string()));
+ assert_eq!(dirs[0].level, LevelFilter::TRACE);
+ assert_eq!(dirs[0].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[1].target, Some("crate1::mod1".to_string()));
+ assert_eq!(dirs[1].level, LevelFilter::ERROR);
+ assert_eq!(dirs[1].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[2].target, Some("crate3".to_string()));
+ assert_eq!(dirs[2].level, LevelFilter::OFF);
+ assert_eq!(dirs[2].field_names, Vec::<String>::new());
+
+ assert_eq!(dirs[3].target, Some("crate2".to_string()));
+ assert_eq!(dirs[3].level, LevelFilter::DEBUG);
+ assert_eq!(dirs[3].field_names, Vec::<String>::new());
+ }
+
+ #[test]
+ fn parse_level_directives() {
+ expect_parse_level_directives(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off",
+ )
+ }
+
+ #[test]
+ fn parse_uppercase_level_directives() {
+ expect_parse_level_directives(
+ "crate1::mod1=ERROR,crate1::mod2=WARN,crate1::mod2::mod3=INFO,\
+ crate2=DEBUG,crate3=TRACE,crate3::mod2::mod1=OFF",
+ )
+ }
+
+ #[test]
+ fn parse_numeric_level_directives() {
+ expect_parse_level_directives(
+ "crate1::mod1=1,crate1::mod2=2,crate1::mod2::mod3=3,crate2=4,\
+ crate3=5,crate3::mod2::mod1=0",
+ )
+ }
+
+ #[test]
+ fn targets_iter() {
+ let filter = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off")
+ .with_default(LevelFilter::WARN);
+
+ let mut targets: Vec<_> = filter.iter().collect();
+ targets.sort();
+
+ assert_eq!(
+ targets,
+ vec![
+ ("crate1::mod1", LevelFilter::ERROR),
+ ("crate1::mod2", LevelFilter::TRACE),
+ ("crate2", LevelFilter::DEBUG),
+ ("crate3", LevelFilter::OFF),
+ ]
+ );
+ }
+
+ #[test]
+ fn targets_into_iter() {
+ let filter = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off")
+ .with_default(LevelFilter::WARN);
+
+ let mut targets: Vec<_> = filter.into_iter().collect();
+ targets.sort();
+
+ assert_eq!(
+ targets,
+ vec![
+ ("crate1::mod1".to_string(), LevelFilter::ERROR),
+ ("crate1::mod2".to_string(), LevelFilter::TRACE),
+ ("crate2".to_string(), LevelFilter::DEBUG),
+ ("crate3".to_string(), LevelFilter::OFF),
+ ]
+ );
+ }
+
+ #[test]
+ fn targets_default_level() {
+ let filter = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off");
+ assert_eq!(filter.default_level(), None);
+
+ let filter = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off")
+ .with_default(LevelFilter::OFF);
+ assert_eq!(filter.default_level(), Some(LevelFilter::OFF));
+
+ let filter = expect_parse("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off")
+ .with_default(LevelFilter::OFF)
+ .with_default(LevelFilter::INFO);
+ assert_eq!(filter.default_level(), Some(LevelFilter::INFO));
+ }
+
+ #[test]
+ // `println!` is only available with `libstd`.
+ #[cfg(feature = "std")]
+ fn size_of_filters() {
+ fn print_sz(s: &str) {
+ let filter = s.parse::<Targets>().expect("filter should parse");
+ println!(
+ "size_of_val({:?})\n -> {}B",
+ s,
+ std::mem::size_of_val(&filter)
+ );
+ }
+
+ print_sz("info");
+
+ print_sz("foo=debug");
+
+ print_sz(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off",
+ );
+ }
+
+ /// Test that the `fmt::Display` implementation for `Targets` emits a string
+ /// that can itself be parsed as a `Targets`, and that the parsed `Targets`
+ /// is equivalent to the original one.
+ #[test]
+ fn display_roundtrips() {
+ fn test_roundtrip(s: &str) {
+ let filter = expect_parse(s);
+ // we don't assert that the display output is equivalent to the
+ // original parsed filter string, because the `Display` impl always
+ // uses lowercase level names and doesn't use the
+ // target-without-level shorthand syntax. while they may not be
+ // textually equivalent, though, they should still *parse* to the
+ // same filter.
+ let formatted = filter.to_string();
+ let filter2 = match dbg!(&formatted).parse::<Targets>() {
+ Ok(filter) => filter,
+ Err(e) => panic!(
+ "failed to parse formatted filter string {:?}: {}",
+ formatted, e
+ ),
+ };
+ assert_eq!(filter, filter2);
+ }
+
+ test_roundtrip("crate1::mod1=error,crate1::mod2,crate2=debug,crate3=off");
+ test_roundtrip(
+ "crate1::mod1=ERROR,crate1::mod2=WARN,crate1::mod2::mod3=INFO,\
+ crate2=DEBUG,crate3=TRACE,crate3::mod2::mod1=OFF",
+ );
+ test_roundtrip(
+ "crate1::mod1=error,crate1::mod2=warn,crate1::mod2::mod3=info,\
+ crate2=debug,crate3=trace,crate3::mod2::mod1=off",
+ );
+ test_roundtrip("crate1::mod1,crate1::mod2,info");
+ test_roundtrip("crate1");
+ test_roundtrip("info");
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/fmt_layer.rs b/crates/tracing-subscriber/src/fmt/fmt_layer.rs
new file mode 100644
index 0000000..d3cb8c1
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/fmt_layer.rs
@@ -0,0 +1,1590 @@
+use crate::{
+ field::RecordFields,
+ fmt::{format, FormatEvent, FormatFields, MakeWriter, TestWriter},
+ layer::{self, Context},
+ registry::{self, LookupSpan, SpanRef},
+};
+use format::{FmtSpan, TimingDisplay};
+use std::{
+ any::TypeId, cell::RefCell, env, fmt, io, marker::PhantomData, ops::Deref, time::Instant,
+};
+use tracing_core::{
+ field,
+ span::{Attributes, Current, Id, Record},
+ Event, Metadata, Subscriber,
+};
+
+/// A [`Layer`] that logs formatted representations of `tracing` events.
+///
+/// ## Examples
+///
+/// Constructing a layer with the default configuration:
+///
+/// ```rust
+/// use tracing_subscriber::{fmt, Registry};
+/// use tracing_subscriber::prelude::*;
+///
+/// let subscriber = Registry::default()
+/// .with(fmt::Layer::default());
+///
+/// tracing::subscriber::set_global_default(subscriber).unwrap();
+/// ```
+///
+/// Overriding the layer's behavior:
+///
+/// ```rust
+/// use tracing_subscriber::{fmt, Registry};
+/// use tracing_subscriber::prelude::*;
+///
+/// let fmt_layer = fmt::layer()
+/// .with_target(false) // don't include event targets when logging
+/// .with_level(false); // don't include event levels when logging
+///
+/// let subscriber = Registry::default().with(fmt_layer);
+/// # tracing::subscriber::set_global_default(subscriber).unwrap();
+/// ```
+///
+/// Setting a custom event formatter:
+///
+/// ```rust
+/// use tracing_subscriber::fmt::{self, format, time};
+/// use tracing_subscriber::prelude::*;
+///
+/// let fmt = format().with_timer(time::Uptime::default());
+/// let fmt_layer = fmt::layer()
+/// .event_format(fmt)
+/// .with_target(false);
+/// # let subscriber = fmt_layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+/// # tracing::subscriber::set_global_default(subscriber).unwrap();
+/// ```
+///
+/// [`Layer`]: super::layer::Layer
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+#[derive(Debug)]
+pub struct Layer<
+ S,
+ N = format::DefaultFields,
+ E = format::Format<format::Full>,
+ W = fn() -> io::Stdout,
+> {
+ make_writer: W,
+ fmt_fields: N,
+ fmt_event: E,
+ fmt_span: format::FmtSpanConfig,
+ is_ansi: bool,
+ log_internal_errors: bool,
+ _inner: PhantomData<fn(S)>,
+}
+
+impl<S> Layer<S> {
+ /// Returns a new [`Layer`][self::Layer] with the default configuration.
+ pub fn new() -> Self {
+ Self::default()
+ }
+}
+
+// This needs to be a seperate impl block because they place different bounds on the type parameters.
+impl<S, N, E, W> Layer<S, N, E, W>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+{
+ /// Sets the [event formatter][`FormatEvent`] that the layer being built will
+ /// use to format events.
+ ///
+ /// The event formatter may be any type implementing the [`FormatEvent`]
+ /// trait, which is implemented for all functions taking a [`FmtContext`], a
+ /// [`Writer`], and an [`Event`].
+ ///
+ /// # Examples
+ ///
+ /// Setting a type implementing [`FormatEvent`] as the formatter:
+ /// ```rust
+ /// use tracing_subscriber::fmt::{self, format};
+ ///
+ /// let layer = fmt::layer()
+ /// .event_format(format().compact());
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ /// [`FormatEvent`]: format::FormatEvent
+ /// [`Event`]: tracing::Event
+ /// [`Writer`]: format::Writer
+ pub fn event_format<E2>(self, e: E2) -> Layer<S, N, E2, W>
+ where
+ E2: FormatEvent<S, N> + 'static,
+ {
+ Layer {
+ fmt_fields: self.fmt_fields,
+ fmt_event: e,
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Updates the event formatter by applying a function to the existing event formatter.
+ ///
+ /// This sets the event formatter that the layer being built will use to record fields.
+ ///
+ /// # Examples
+ ///
+ /// Updating an event formatter:
+ ///
+ /// ```rust
+ /// let layer = tracing_subscriber::fmt::layer()
+ /// .map_event_format(|e| e.compact());
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ pub fn map_event_format<E2>(self, f: impl FnOnce(E) -> E2) -> Layer<S, N, E2, W>
+ where
+ E2: FormatEvent<S, N> + 'static,
+ {
+ Layer {
+ fmt_fields: self.fmt_fields,
+ fmt_event: f(self.fmt_event),
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+}
+
+// This needs to be a seperate impl block because they place different bounds on the type parameters.
+impl<S, N, E, W> Layer<S, N, E, W> {
+ /// Sets the [`MakeWriter`] that the layer being built will use to write events.
+ ///
+ /// # Examples
+ ///
+ /// Using `stderr` rather than `stdout`:
+ ///
+ /// ```rust
+ /// use std::io;
+ /// use tracing_subscriber::fmt;
+ ///
+ /// let layer = fmt::layer()
+ /// .with_writer(io::stderr);
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ pub fn with_writer<W2>(self, make_writer: W2) -> Layer<S, N, E, W2>
+ where
+ W2: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ Layer {
+ fmt_fields: self.fmt_fields,
+ fmt_event: self.fmt_event,
+ fmt_span: self.fmt_span,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ make_writer,
+ _inner: self._inner,
+ }
+ }
+
+ /// Borrows the [writer] for this [`Layer`].
+ ///
+ /// [writer]: MakeWriter
+ pub fn writer(&self) -> &W {
+ &self.make_writer
+ }
+
+ /// Mutably borrows the [writer] for this [`Layer`].
+ ///
+ /// This method is primarily expected to be used with the
+ /// [`reload::Handle::modify`](crate::reload::Handle::modify) method.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::info;
+ /// # use tracing_subscriber::{fmt,reload,Registry,prelude::*};
+ /// # fn non_blocking<T: std::io::Write>(writer: T) -> (fn() -> std::io::Stdout) {
+ /// # std::io::stdout
+ /// # }
+ /// # fn main() {
+ /// let layer = fmt::layer().with_writer(non_blocking(std::io::stderr()));
+ /// let (layer, reload_handle) = reload::Layer::new(layer);
+ /// #
+ /// # // specifying the Registry type is required
+ /// # let _: &reload::Handle<fmt::Layer<Registry, _, _, _>, Registry> = &reload_handle;
+ /// #
+ /// info!("This will be logged to stderr");
+ /// reload_handle.modify(|layer| *layer.writer_mut() = non_blocking(std::io::stdout()));
+ /// info!("This will be logged to stdout");
+ /// # }
+ /// ```
+ ///
+ /// [writer]: MakeWriter
+ pub fn writer_mut(&mut self) -> &mut W {
+ &mut self.make_writer
+ }
+
+ /// Sets whether this layer should use ANSI terminal formatting
+ /// escape codes (such as colors).
+ ///
+ /// This method is primarily expected to be used with the
+ /// [`reload::Handle::modify`](crate::reload::Handle::modify) method when changing
+ /// the writer.
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn set_ansi(&mut self, ansi: bool) {
+ self.is_ansi = ansi;
+ }
+
+ /// Configures the layer to support [`libtest`'s output capturing][capturing] when used in
+ /// unit tests.
+ ///
+ /// See [`TestWriter`] for additional details.
+ ///
+ /// # Examples
+ ///
+ /// Using [`TestWriter`] to let `cargo test` capture test output:
+ ///
+ /// ```rust
+ /// use std::io;
+ /// use tracing_subscriber::fmt;
+ ///
+ /// let layer = fmt::layer()
+ /// .with_test_writer();
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ /// [capturing]:
+ /// https://doc.rust-lang.org/book/ch11-02-running-tests.html#showing-function-output
+ /// [`TestWriter`]: super::writer::TestWriter
+ pub fn with_test_writer(self) -> Layer<S, N, E, TestWriter> {
+ Layer {
+ fmt_fields: self.fmt_fields,
+ fmt_event: self.fmt_event,
+ fmt_span: self.fmt_span,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ make_writer: TestWriter::default(),
+ _inner: self._inner,
+ }
+ }
+
+ /// Sets whether or not the formatter emits ANSI terminal escape codes
+ /// for colors and other text formatting.
+ ///
+ /// When the "ansi" crate feature flag is enabled, ANSI colors are enabled
+ /// by default unless the [`NO_COLOR`] environment variable is set to
+ /// a non-empty value. If the [`NO_COLOR`] environment variable is set to
+ /// any non-empty value, then ANSI colors will be suppressed by default.
+ /// The [`with_ansi`] and [`set_ansi`] methods can be used to forcibly
+ /// enable ANSI colors, overriding any [`NO_COLOR`] environment variable.
+ ///
+ /// [`NO_COLOR`]: https://no-color.org/
+ ///
+ /// Enabling ANSI escapes (calling `with_ansi(true)`) requires the "ansi"
+ /// crate feature flag. Calling `with_ansi(true)` without the "ansi"
+ /// feature flag enabled will panic if debug assertions are enabled, or
+ /// print a warning otherwise.
+ ///
+ /// This method itself is still available without the feature flag. This
+ /// is to allow ANSI escape codes to be explicitly *disabled* without
+ /// having to opt-in to the dependencies required to emit ANSI formatting.
+ /// This way, code which constructs a formatter that should never emit
+ /// ANSI escape codes can ensure that they are not used, regardless of
+ /// whether or not other crates in the dependency graph enable the "ansi"
+ /// feature flag.
+ ///
+ /// [`with_ansi`]: Subscriber::with_ansi
+ /// [`set_ansi`]: Subscriber::set_ansi
+ pub fn with_ansi(self, ansi: bool) -> Self {
+ #[cfg(not(feature = "ansi"))]
+ if ansi {
+ const ERROR: &str =
+ "tracing-subscriber: the `ansi` crate feature is required to enable ANSI terminal colors";
+ #[cfg(debug_assertions)]
+ panic!("{}", ERROR);
+ #[cfg(not(debug_assertions))]
+ eprintln!("{}", ERROR);
+ }
+
+ Self {
+ is_ansi: ansi,
+ ..self
+ }
+ }
+
+ /// Sets whether to write errors from [`FormatEvent`] to the writer.
+ /// Defaults to true.
+ ///
+ /// By default, `fmt::Layer` will write any `FormatEvent`-internal errors to
+ /// the writer. These errors are unlikely and will only occur if there is a
+ /// bug in the `FormatEvent` implementation or its dependencies.
+ ///
+ /// If writing to the writer fails, the error message is printed to stderr
+ /// as a fallback.
+ ///
+ /// [`FormatEvent`]: crate::fmt::FormatEvent
+ pub fn log_internal_errors(self, log_internal_errors: bool) -> Self {
+ Self {
+ log_internal_errors,
+ ..self
+ }
+ }
+
+ /// Updates the [`MakeWriter`] by applying a function to the existing [`MakeWriter`].
+ ///
+ /// This sets the [`MakeWriter`] that the layer being built will use to write events.
+ ///
+ /// # Examples
+ ///
+ /// Redirect output to stderr if level is <= WARN:
+ ///
+ /// ```rust
+ /// use tracing::Level;
+ /// use tracing_subscriber::fmt::{self, writer::MakeWriterExt};
+ ///
+ /// let stderr = std::io::stderr.with_max_level(Level::WARN);
+ /// let layer = fmt::layer()
+ /// .map_writer(move |w| stderr.or_else(w));
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ pub fn map_writer<W2>(self, f: impl FnOnce(W) -> W2) -> Layer<S, N, E, W2>
+ where
+ W2: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ Layer {
+ fmt_fields: self.fmt_fields,
+ fmt_event: self.fmt_event,
+ fmt_span: self.fmt_span,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ make_writer: f(self.make_writer),
+ _inner: self._inner,
+ }
+ }
+}
+
+impl<S, N, L, T, W> Layer<S, N, format::Format<L, T>, W>
+where
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ /// Use the given [`timer`] for span and event timestamps.
+ ///
+ /// See the [`time` module] for the provided timer implementations.
+ ///
+ /// Note that using the `"time`"" feature flag enables the
+ /// additional time formatters [`UtcTime`] and [`LocalTime`], which use the
+ /// [`time` crate] to provide more sophisticated timestamp formatting
+ /// options.
+ ///
+ /// [`timer`]: super::time::FormatTime
+ /// [`time` module]: mod@super::time
+ /// [`UtcTime`]: super::time::UtcTime
+ /// [`LocalTime`]: super::time::LocalTime
+ /// [`time` crate]: https://docs.rs/time/0.3
+ pub fn with_timer<T2>(self, timer: T2) -> Layer<S, N, format::Format<L, T2>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_timer(timer),
+ fmt_fields: self.fmt_fields,
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Do not emit timestamps with spans and event.
+ pub fn without_time(self) -> Layer<S, N, format::Format<L, ()>, W> {
+ Layer {
+ fmt_event: self.fmt_event.without_time(),
+ fmt_fields: self.fmt_fields,
+ fmt_span: self.fmt_span.without_time(),
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Configures how synthesized events are emitted at points in the [span
+ /// lifecycle][lifecycle].
+ ///
+ /// The following options are available:
+ ///
+ /// - `FmtSpan::NONE`: No events will be synthesized when spans are
+ /// created, entered, exited, or closed. Data from spans will still be
+ /// included as the context for formatted events. This is the default.
+ /// - `FmtSpan::NEW`: An event will be synthesized when spans are created.
+ /// - `FmtSpan::ENTER`: An event will be synthesized when spans are entered.
+ /// - `FmtSpan::EXIT`: An event will be synthesized when spans are exited.
+ /// - `FmtSpan::CLOSE`: An event will be synthesized when a span closes. If
+ /// [timestamps are enabled][time] for this formatter, the generated
+ /// event will contain fields with the span's _busy time_ (the total
+ /// time for which it was entered) and _idle time_ (the total time that
+ /// the span existed but was not entered).
+ /// - `FmtSpan::ACTIVE`: Events will be synthesized when spans are entered
+ /// or exited.
+ /// - `FmtSpan::FULL`: Events will be synthesized whenever a span is
+ /// created, entered, exited, or closed. If timestamps are enabled, the
+ /// close event will contain the span's busy and idle time, as
+ /// described above.
+ ///
+ /// The options can be enabled in any combination. For instance, the following
+ /// will synthesize events whenever spans are created and closed:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::fmt;
+ /// use tracing_subscriber::fmt::format::FmtSpan;
+ ///
+ /// let subscriber = fmt()
+ /// .with_span_events(FmtSpan::NEW | FmtSpan::CLOSE)
+ /// .finish();
+ /// ```
+ ///
+ /// Note that the generated events will only be part of the log output by
+ /// this formatter; they will not be recorded by other `Subscriber`s or by
+ /// `Layer`s added to this subscriber.
+ ///
+ /// [lifecycle]: https://docs.rs/tracing/latest/tracing/span/index.html#the-span-lifecycle
+ /// [time]: Layer::without_time()
+ pub fn with_span_events(self, kind: FmtSpan) -> Self {
+ Layer {
+ fmt_span: self.fmt_span.with_kind(kind),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's target is displayed.
+ pub fn with_target(self, display_target: bool) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_target(display_target),
+ ..self
+ }
+ }
+ /// Sets whether or not an event's [source code file path][file] is
+ /// displayed.
+ ///
+ /// [file]: tracing_core::Metadata::file
+ pub fn with_file(self, display_filename: bool) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_file(display_filename),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code line number][line] is
+ /// displayed.
+ ///
+ /// [line]: tracing_core::Metadata::line
+ pub fn with_line_number(
+ self,
+ display_line_number: bool,
+ ) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_line_number(display_line_number),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's level is displayed.
+ pub fn with_level(self, display_level: bool) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_level(display_level),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [thread ID] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [thread ID]: std::thread::ThreadId
+ pub fn with_thread_ids(self, display_thread_ids: bool) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_thread_ids(display_thread_ids),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [name] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [name]: std::thread#naming-threads
+ pub fn with_thread_names(
+ self,
+ display_thread_names: bool,
+ ) -> Layer<S, N, format::Format<L, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_thread_names(display_thread_names),
+ ..self
+ }
+ }
+
+ /// Sets the layer being built to use a [less verbose formatter][super::format::Compact].
+ pub fn compact(self) -> Layer<S, N, format::Format<format::Compact, T>, W>
+ where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ {
+ Layer {
+ fmt_event: self.fmt_event.compact(),
+ fmt_fields: self.fmt_fields,
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Sets the layer being built to use an [excessively pretty, human-readable formatter](crate::fmt::format::Pretty).
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn pretty(self) -> Layer<S, format::Pretty, format::Format<format::Pretty, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.pretty(),
+ fmt_fields: format::Pretty::default(),
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Sets the layer being built to use a [JSON formatter][super::format::Json].
+ ///
+ /// The full format includes fields from all entered spans.
+ ///
+ /// # Example Output
+ ///
+ /// ```ignore,json
+ /// {"timestamp":"Feb 20 11:28:15.096","level":"INFO","target":"mycrate","fields":{"message":"some message", "key": "value"}}
+ /// ```
+ ///
+ /// # Options
+ ///
+ /// - [`Layer::flatten_event`] can be used to enable flattening event fields into the root
+ /// object.
+ ///
+ /// [`Layer::flatten_event`]: Layer::flatten_event()
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn json(self) -> Layer<S, format::JsonFields, format::Format<format::Json, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.json(),
+ fmt_fields: format::JsonFields::new(),
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ // always disable ANSI escapes in JSON mode!
+ is_ansi: false,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+}
+
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+impl<S, T, W> Layer<S, format::JsonFields, format::Format<format::Json, T>, W> {
+ /// Sets the JSON layer being built to flatten event metadata.
+ ///
+ /// See [`format::Json`][super::format::Json]
+ pub fn flatten_event(
+ self,
+ flatten_event: bool,
+ ) -> Layer<S, format::JsonFields, format::Format<format::Json, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.flatten_event(flatten_event),
+ fmt_fields: format::JsonFields::new(),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the formatter will include the current span in
+ /// formatted events.
+ ///
+ /// See [`format::Json`][super::format::Json]
+ pub fn with_current_span(
+ self,
+ display_current_span: bool,
+ ) -> Layer<S, format::JsonFields, format::Format<format::Json, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_current_span(display_current_span),
+ fmt_fields: format::JsonFields::new(),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the formatter will include a list (from root to leaf)
+ /// of all currently entered spans in formatted events.
+ ///
+ /// See [`format::Json`][super::format::Json]
+ pub fn with_span_list(
+ self,
+ display_span_list: bool,
+ ) -> Layer<S, format::JsonFields, format::Format<format::Json, T>, W> {
+ Layer {
+ fmt_event: self.fmt_event.with_span_list(display_span_list),
+ fmt_fields: format::JsonFields::new(),
+ ..self
+ }
+ }
+}
+
+impl<S, N, E, W> Layer<S, N, E, W> {
+ /// Sets the field formatter that the layer being built will use to record
+ /// fields.
+ pub fn fmt_fields<N2>(self, fmt_fields: N2) -> Layer<S, N2, E, W>
+ where
+ N2: for<'writer> FormatFields<'writer> + 'static,
+ {
+ Layer {
+ fmt_event: self.fmt_event,
+ fmt_fields,
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+
+ /// Updates the field formatter by applying a function to the existing field formatter.
+ ///
+ /// This sets the field formatter that the layer being built will use to record fields.
+ ///
+ /// # Examples
+ ///
+ /// Updating a field formatter:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::field::MakeExt;
+ /// let layer = tracing_subscriber::fmt::layer()
+ /// .map_fmt_fields(|f| f.debug_alt());
+ /// # // this is necessary for type inference.
+ /// # use tracing_subscriber::Layer as _;
+ /// # let _ = layer.with_subscriber(tracing_subscriber::registry::Registry::default());
+ /// ```
+ pub fn map_fmt_fields<N2>(self, f: impl FnOnce(N) -> N2) -> Layer<S, N2, E, W>
+ where
+ N2: for<'writer> FormatFields<'writer> + 'static,
+ {
+ Layer {
+ fmt_event: self.fmt_event,
+ fmt_fields: f(self.fmt_fields),
+ fmt_span: self.fmt_span,
+ make_writer: self.make_writer,
+ is_ansi: self.is_ansi,
+ log_internal_errors: self.log_internal_errors,
+ _inner: self._inner,
+ }
+ }
+}
+
+impl<S> Default for Layer<S> {
+ fn default() -> Self {
+ // only enable ANSI when the feature is enabled, and the NO_COLOR
+ // environment variable is unset or empty.
+ let ansi = cfg!(feature = "ansi") && env::var("NO_COLOR").map_or(true, |v| v.is_empty());
+
+ Layer {
+ fmt_fields: format::DefaultFields::default(),
+ fmt_event: format::Format::default(),
+ fmt_span: format::FmtSpanConfig::default(),
+ make_writer: io::stdout,
+ is_ansi: ansi,
+ log_internal_errors: false,
+ _inner: PhantomData,
+ }
+ }
+}
+
+impl<S, N, E, W> Layer<S, N, E, W>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ E: FormatEvent<S, N> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+{
+ #[inline]
+ fn make_ctx<'a>(&'a self, ctx: Context<'a, S>, event: &'a Event<'a>) -> FmtContext<'a, S, N> {
+ FmtContext {
+ ctx,
+ fmt_fields: &self.fmt_fields,
+ event,
+ }
+ }
+}
+
+/// A formatted representation of a span's fields stored in its [extensions].
+///
+/// Because `FormattedFields` is generic over the type of the formatter that
+/// produced it, multiple versions of a span's formatted fields can be stored in
+/// the [`Extensions`][extensions] type-map. This means that when multiple
+/// formatters are in use, each can store its own formatted representation
+/// without conflicting.
+///
+/// [extensions]: crate::registry::Extensions
+#[derive(Default)]
+pub struct FormattedFields<E: ?Sized> {
+ _format_fields: PhantomData<fn(E)>,
+ was_ansi: bool,
+ /// The formatted fields of a span.
+ pub fields: String,
+}
+
+impl<E: ?Sized> FormattedFields<E> {
+ /// Returns a new `FormattedFields`.
+ pub fn new(fields: String) -> Self {
+ Self {
+ fields,
+ was_ansi: false,
+ _format_fields: PhantomData,
+ }
+ }
+
+ /// Returns a new [`format::Writer`] for writing to this `FormattedFields`.
+ ///
+ /// The returned [`format::Writer`] can be used with the
+ /// [`FormatFields::format_fields`] method.
+ pub fn as_writer(&mut self) -> format::Writer<'_> {
+ format::Writer::new(&mut self.fields).with_ansi(self.was_ansi)
+ }
+}
+
+impl<E: ?Sized> fmt::Debug for FormattedFields<E> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FormattedFields")
+ .field("fields", &self.fields)
+ .field("formatter", &format_args!("{}", std::any::type_name::<E>()))
+ .field("was_ansi", &self.was_ansi)
+ .finish()
+ }
+}
+
+impl<E: ?Sized> fmt::Display for FormattedFields<E> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&self.fields, f)
+ }
+}
+
+impl<E: ?Sized> Deref for FormattedFields<E> {
+ type Target = String;
+ fn deref(&self) -> &Self::Target {
+ &self.fields
+ }
+}
+
+// === impl FmtLayer ===
+
+macro_rules! with_event_from_span {
+ ($id:ident, $span:ident, $($field:literal = $value:expr),*, |$event:ident| $code:block) => {
+ let meta = $span.metadata();
+ let cs = meta.callsite();
+ let fs = field::FieldSet::new(&[$($field),*], cs);
+ #[allow(unused)]
+ let mut iter = fs.iter();
+ let v = [$(
+ (&iter.next().unwrap(), ::core::option::Option::Some(&$value as &dyn field::Value)),
+ )*];
+ let vs = fs.value_set(&v);
+ let $event = Event::new_child_of($id, meta, &vs);
+ $code
+ };
+}
+
+impl<S, N, E, W> layer::Layer<S> for Layer<S, N, E, W>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ E: FormatEvent<S, N> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+{
+ fn on_new_span(&self, attrs: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
+ let span = ctx.span(id).expect("Span not found, this is a bug");
+ let mut extensions = span.extensions_mut();
+
+ if extensions.get_mut::<FormattedFields<N>>().is_none() {
+ let mut fields = FormattedFields::<N>::new(String::new());
+ if self
+ .fmt_fields
+ .format_fields(fields.as_writer().with_ansi(self.is_ansi), attrs)
+ .is_ok()
+ {
+ fields.was_ansi = self.is_ansi;
+ extensions.insert(fields);
+ } else {
+ eprintln!(
+ "[tracing-subscriber] Unable to format the following event, ignoring: {:?}",
+ attrs
+ );
+ }
+ }
+
+ if self.fmt_span.fmt_timing
+ && self.fmt_span.trace_close()
+ && extensions.get_mut::<Timings>().is_none()
+ {
+ extensions.insert(Timings::new());
+ }
+
+ if self.fmt_span.trace_new() {
+ with_event_from_span!(id, span, "message" = "new", |event| {
+ drop(extensions);
+ drop(span);
+ self.on_event(&event, ctx);
+ });
+ }
+ }
+
+ fn on_record(&self, id: &Id, values: &Record<'_>, ctx: Context<'_, S>) {
+ let span = ctx.span(id).expect("Span not found, this is a bug");
+ let mut extensions = span.extensions_mut();
+ if let Some(fields) = extensions.get_mut::<FormattedFields<N>>() {
+ let _ = self.fmt_fields.add_fields(fields, values);
+ return;
+ }
+
+ let mut fields = FormattedFields::<N>::new(String::new());
+ if self
+ .fmt_fields
+ .format_fields(fields.as_writer().with_ansi(self.is_ansi), values)
+ .is_ok()
+ {
+ fields.was_ansi = self.is_ansi;
+ extensions.insert(fields);
+ }
+ }
+
+ fn on_enter(&self, id: &Id, ctx: Context<'_, S>) {
+ if self.fmt_span.trace_enter() || self.fmt_span.trace_close() && self.fmt_span.fmt_timing {
+ let span = ctx.span(id).expect("Span not found, this is a bug");
+ let mut extensions = span.extensions_mut();
+ if let Some(timings) = extensions.get_mut::<Timings>() {
+ let now = Instant::now();
+ timings.idle += (now - timings.last).as_nanos() as u64;
+ timings.last = now;
+ }
+
+ if self.fmt_span.trace_enter() {
+ with_event_from_span!(id, span, "message" = "enter", |event| {
+ drop(extensions);
+ drop(span);
+ self.on_event(&event, ctx);
+ });
+ }
+ }
+ }
+
+ fn on_exit(&self, id: &Id, ctx: Context<'_, S>) {
+ if self.fmt_span.trace_exit() || self.fmt_span.trace_close() && self.fmt_span.fmt_timing {
+ let span = ctx.span(id).expect("Span not found, this is a bug");
+ let mut extensions = span.extensions_mut();
+ if let Some(timings) = extensions.get_mut::<Timings>() {
+ let now = Instant::now();
+ timings.busy += (now - timings.last).as_nanos() as u64;
+ timings.last = now;
+ }
+
+ if self.fmt_span.trace_exit() {
+ with_event_from_span!(id, span, "message" = "exit", |event| {
+ drop(extensions);
+ drop(span);
+ self.on_event(&event, ctx);
+ });
+ }
+ }
+ }
+
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ if self.fmt_span.trace_close() {
+ let span = ctx.span(&id).expect("Span not found, this is a bug");
+ let extensions = span.extensions();
+ if let Some(timing) = extensions.get::<Timings>() {
+ let Timings {
+ busy,
+ mut idle,
+ last,
+ } = *timing;
+ idle += (Instant::now() - last).as_nanos() as u64;
+
+ let t_idle = field::display(TimingDisplay(idle));
+ let t_busy = field::display(TimingDisplay(busy));
+
+ with_event_from_span!(
+ id,
+ span,
+ "message" = "close",
+ "time.busy" = t_busy,
+ "time.idle" = t_idle,
+ |event| {
+ drop(extensions);
+ drop(span);
+ self.on_event(&event, ctx);
+ }
+ );
+ } else {
+ with_event_from_span!(id, span, "message" = "close", |event| {
+ drop(extensions);
+ drop(span);
+ self.on_event(&event, ctx);
+ });
+ }
+ }
+ }
+
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ thread_local! {
+ static BUF: RefCell<String> = RefCell::new(String::new());
+ }
+
+ BUF.with(|buf| {
+ let borrow = buf.try_borrow_mut();
+ let mut a;
+ let mut b;
+ let mut buf = match borrow {
+ Ok(buf) => {
+ a = buf;
+ &mut *a
+ }
+ _ => {
+ b = String::new();
+ &mut b
+ }
+ };
+
+ let ctx = self.make_ctx(ctx, event);
+ if self
+ .fmt_event
+ .format_event(
+ &ctx,
+ format::Writer::new(&mut buf).with_ansi(self.is_ansi),
+ event,
+ )
+ .is_ok()
+ {
+ let mut writer = self.make_writer.make_writer_for(event.metadata());
+ let res = io::Write::write_all(&mut writer, buf.as_bytes());
+ if self.log_internal_errors {
+ if let Err(e) = res {
+ eprintln!("[tracing-subscriber] Unable to write an event to the Writer for this Subscriber! Error: {}\n", e);
+ }
+ }
+ } else if self.log_internal_errors {
+ let err_msg = format!("Unable to format the following event. Name: {}; Fields: {:?}\n",
+ event.metadata().name(), event.fields());
+ let mut writer = self.make_writer.make_writer_for(event.metadata());
+ let res = io::Write::write_all(&mut writer, err_msg.as_bytes());
+ if let Err(e) = res {
+ eprintln!("[tracing-subscriber] Unable to write an \"event formatting error\" to the Writer for this Subscriber! Error: {}\n", e);
+ }
+ }
+
+ buf.clear();
+ });
+ }
+
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ // This `downcast_raw` impl allows downcasting a `fmt` layer to any of
+ // its components (event formatter, field formatter, and `MakeWriter`)
+ // as well as to the layer's type itself. The potential use-cases for
+ // this *may* be somewhat niche, though...
+ match () {
+ _ if id == TypeId::of::<Self>() => Some(self as *const Self as *const ()),
+ _ if id == TypeId::of::<E>() => Some(&self.fmt_event as *const E as *const ()),
+ _ if id == TypeId::of::<N>() => Some(&self.fmt_fields as *const N as *const ()),
+ _ if id == TypeId::of::<W>() => Some(&self.make_writer as *const W as *const ()),
+ _ => None,
+ }
+ }
+}
+
+/// Provides the current span context to a formatter.
+pub struct FmtContext<'a, S, N> {
+ pub(crate) ctx: Context<'a, S>,
+ pub(crate) fmt_fields: &'a N,
+ pub(crate) event: &'a Event<'a>,
+}
+
+impl<'a, S, N> fmt::Debug for FmtContext<'a, S, N> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FmtContext").finish()
+ }
+}
+
+impl<'cx, 'writer, S, N> FormatFields<'writer> for FmtContext<'cx, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: FormatFields<'writer> + 'static,
+{
+ fn format_fields<R: RecordFields>(
+ &self,
+ writer: format::Writer<'writer>,
+ fields: R,
+ ) -> fmt::Result {
+ self.fmt_fields.format_fields(writer, fields)
+ }
+}
+
+impl<'a, S, N> FmtContext<'a, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ /// Visits every span in the current context with a closure.
+ ///
+ /// The provided closure will be called first with the current span,
+ /// and then with that span's parent, and then that span's parent,
+ /// and so on until a root span is reached.
+ pub fn visit_spans<E, F>(&self, mut f: F) -> Result<(), E>
+ where
+ F: FnMut(&SpanRef<'_, S>) -> Result<(), E>,
+ {
+ // visit all the current spans
+ if let Some(scope) = self.event_scope() {
+ for span in scope.from_root() {
+ f(&span)?;
+ }
+ }
+ Ok(())
+ }
+
+ /// Returns metadata for the span with the given `id`, if it exists.
+ ///
+ /// If this returns `None`, then no span exists for that ID (either it has
+ /// closed or the ID is invalid).
+ #[inline]
+ pub fn metadata(&self, id: &Id) -> Option<&'static Metadata<'static>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.ctx.metadata(id)
+ }
+
+ /// Returns [stored data] for the span with the given `id`, if it exists.
+ ///
+ /// If this returns `None`, then no span exists for that ID (either it has
+ /// closed or the ID is invalid).
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ #[inline]
+ pub fn span(&self, id: &Id) -> Option<SpanRef<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.ctx.span(id)
+ }
+
+ /// Returns `true` if an active span exists for the given `Id`.
+ #[inline]
+ pub fn exists(&self, id: &Id) -> bool
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.ctx.exists(id)
+ }
+
+ /// Returns [stored data] for the span that the wrapped subscriber considers
+ /// to be the current.
+ ///
+ /// If this returns `None`, then we are not currently within a span.
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ #[inline]
+ pub fn lookup_current(&self) -> Option<SpanRef<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.ctx.lookup_current()
+ }
+
+ /// Returns the current span for this formatter.
+ pub fn current_span(&self) -> Current {
+ self.ctx.current_span()
+ }
+
+ /// Returns [stored data] for the parent span of the event currently being
+ /// formatted.
+ ///
+ /// If the event has a contextual parent, this will return the current span. If
+ /// the event has an explicit parent span, this will return that span. If
+ /// the event does not have a parent span, this will return `None`.
+ ///
+ /// [stored data]: SpanRef
+ pub fn parent_span(&self) -> Option<SpanRef<'_, S>> {
+ self.ctx.event_span(self.event)
+ }
+
+ /// Returns an iterator over the [stored data] for all the spans in the
+ /// current context, starting with the specified span and ending with the
+ /// root of the trace tree and ending with the current span.
+ ///
+ /// This is equivalent to the [`Context::span_scope`] method.
+ ///
+ /// <div class="information">
+ /// <div class="tooltip ignore" style="">ⓘ<span class="tooltiptext">Note</span></div>
+ /// </div>
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: Compared to <a href="#method.scope"><code>scope</code></a> this
+ /// returns the spans in reverse order (from leaf to root). Use
+ /// <a href="../registry/struct.Scope.html#method.from_root"><code>Scope::from_root</code></a>
+ /// in case root-to-leaf ordering is desired.
+ /// </pre></div>
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to implement the
+ /// <a href="../registry/trait.LookupSpan.html"><code>LookupSpan</code></a> trait.
+ /// See the documentation on <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre></div>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ pub fn span_scope(&self, id: &Id) -> Option<registry::Scope<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.ctx.span_scope(id)
+ }
+
+ /// Returns an iterator over the [stored data] for all the spans in the
+ /// event's span context, starting with its parent span and ending with the
+ /// root of the trace tree.
+ ///
+ /// This is equivalent to calling the [`Context::event_scope`] method and
+ /// passing the event currently being formatted.
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: Compared to <a href="#method.scope"><code>scope</code></a> this
+ /// returns the spans in reverse order (from leaf to root). Use
+ /// <a href="../registry/struct.Scope.html#method.from_root"><code>Scope::from_root</code></a>
+ /// in case root-to-leaf ordering is desired.
+ /// </pre></div>
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to implement the
+ /// <a href="../registry/trait.LookupSpan.html"><code>LookupSpan</code></a> trait.
+ /// See the documentation on <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre></div>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ pub fn event_scope(&self) -> Option<registry::Scope<'_, S>>
+ where
+ S: for<'lookup> registry::LookupSpan<'lookup>,
+ {
+ self.ctx.event_scope(self.event)
+ }
+
+ /// Returns the [field formatter] configured by the subscriber invoking
+ /// `format_event`.
+ ///
+ /// The event formatter may use the returned field formatter to format the
+ /// fields of any events it records.
+ ///
+ /// [field formatter]: FormatFields
+ pub fn field_format(&self) -> &N {
+ self.fmt_fields
+ }
+}
+
+struct Timings {
+ idle: u64,
+ busy: u64,
+ last: Instant,
+}
+
+impl Timings {
+ fn new() -> Self {
+ Self {
+ idle: 0,
+ busy: 0,
+ last: Instant::now(),
+ }
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::fmt::{
+ self,
+ format::{self, test::MockTime, Format},
+ layer::Layer as _,
+ test::{MockMakeWriter, MockWriter},
+ time,
+ };
+ use crate::Registry;
+ use format::FmtSpan;
+ use regex::Regex;
+ use tracing::subscriber::with_default;
+ use tracing_core::dispatcher::Dispatch;
+
+ #[test]
+ fn impls() {
+ let f = Format::default().with_timer(time::Uptime::default());
+ let fmt = fmt::Layer::default().event_format(f);
+ let subscriber = fmt.with_subscriber(Registry::default());
+ let _dispatch = Dispatch::new(subscriber);
+
+ let f = format::Format::default();
+ let fmt = fmt::Layer::default().event_format(f);
+ let subscriber = fmt.with_subscriber(Registry::default());
+ let _dispatch = Dispatch::new(subscriber);
+
+ let f = format::Format::default().compact();
+ let fmt = fmt::Layer::default().event_format(f);
+ let subscriber = fmt.with_subscriber(Registry::default());
+ let _dispatch = Dispatch::new(subscriber);
+ }
+
+ #[test]
+ fn fmt_layer_downcasts() {
+ let f = format::Format::default();
+ let fmt = fmt::Layer::default().event_format(f);
+ let subscriber = fmt.with_subscriber(Registry::default());
+
+ let dispatch = Dispatch::new(subscriber);
+ assert!(dispatch.downcast_ref::<fmt::Layer<Registry>>().is_some());
+ }
+
+ #[test]
+ fn fmt_layer_downcasts_to_parts() {
+ let f = format::Format::default();
+ let fmt = fmt::Layer::default().event_format(f);
+ let subscriber = fmt.with_subscriber(Registry::default());
+ let dispatch = Dispatch::new(subscriber);
+ assert!(dispatch.downcast_ref::<format::DefaultFields>().is_some());
+ assert!(dispatch.downcast_ref::<format::Format>().is_some())
+ }
+
+ #[test]
+ fn is_lookup_span() {
+ fn assert_lookup_span<T: for<'a> crate::registry::LookupSpan<'a>>(_: T) {}
+ let fmt = fmt::Layer::default();
+ let subscriber = fmt.with_subscriber(Registry::default());
+ assert_lookup_span(subscriber)
+ }
+
+ fn sanitize_timings(s: String) -> String {
+ let re = Regex::new("time\\.(idle|busy)=([0-9.]+)[mµn]s").unwrap();
+ re.replace_all(s.as_str(), "timing").to_string()
+ }
+
+ #[test]
+ fn format_error_print_to_stderr() {
+ struct AlwaysError;
+
+ impl std::fmt::Debug for AlwaysError {
+ fn fmt(&self, _f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ Err(std::fmt::Error)
+ }
+ }
+
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, || {
+ tracing::info!(?AlwaysError);
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+
+ // Only assert the start because the line number and callsite may change.
+ let expected = concat!(
+ "Unable to format the following event. Name: event ",
+ file!(),
+ ":"
+ );
+ assert!(
+ actual.as_str().starts_with(expected),
+ "\nactual = {}\nshould start with expected = {}\n",
+ actual,
+ expected
+ );
+ }
+
+ #[test]
+ fn format_error_ignore_if_log_internal_errors_is_false() {
+ struct AlwaysError;
+
+ impl std::fmt::Debug for AlwaysError {
+ fn fmt(&self, _f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ Err(std::fmt::Error)
+ }
+ }
+
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .log_internal_errors(false)
+ .finish();
+
+ with_default(subscriber, || {
+ tracing::info!(?AlwaysError);
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!("", actual.as_str());
+ }
+
+ #[test]
+ fn synthesize_span_none() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ // check that FmtSpan::NONE is the default
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", x = 42);
+ let _e = span1.enter();
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!("", actual.as_str());
+ }
+
+ #[test]
+ fn synthesize_span_active() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .with_span_events(FmtSpan::ACTIVE)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", x = 42);
+ let _e = span1.enter();
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!(
+ "fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: enter\n\
+ fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: exit\n",
+ actual.as_str()
+ );
+ }
+
+ #[test]
+ fn synthesize_span_close() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .with_span_events(FmtSpan::CLOSE)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", x = 42);
+ let _e = span1.enter();
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!(
+ "fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: close timing timing\n",
+ actual.as_str()
+ );
+ }
+
+ #[test]
+ fn synthesize_span_close_no_timing() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .without_time()
+ .with_span_events(FmtSpan::CLOSE)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", x = 42);
+ let _e = span1.enter();
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!(
+ "span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: close\n",
+ actual.as_str()
+ );
+ }
+
+ #[test]
+ fn synthesize_span_full() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .with_span_events(FmtSpan::FULL)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", x = 42);
+ let _e = span1.enter();
+ });
+ let actual = sanitize_timings(make_writer.get_string());
+ assert_eq!(
+ "fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: new\n\
+ fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: enter\n\
+ fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: exit\n\
+ fake time span1{x=42}: tracing_subscriber::fmt::fmt_layer::test: close timing timing\n",
+ actual.as_str()
+ );
+ }
+
+ #[test]
+ fn make_writer_based_on_meta() {
+ struct MakeByTarget {
+ make_writer1: MockMakeWriter,
+ make_writer2: MockMakeWriter,
+ }
+
+ impl<'a> MakeWriter<'a> for MakeByTarget {
+ type Writer = MockWriter;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ self.make_writer1.make_writer()
+ }
+
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ if meta.target() == "writer2" {
+ return self.make_writer2.make_writer();
+ }
+ self.make_writer()
+ }
+ }
+
+ let make_writer1 = MockMakeWriter::default();
+ let make_writer2 = MockMakeWriter::default();
+
+ let make_writer = MakeByTarget {
+ make_writer1: make_writer1.clone(),
+ make_writer2: make_writer2.clone(),
+ };
+
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer)
+ .with_level(false)
+ .with_target(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .with_span_events(FmtSpan::CLOSE)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("writer1_span", x = 42);
+ let _e = span1.enter();
+ tracing::info!(target: "writer2", "hello writer2!");
+ let span2 = tracing::info_span!(target: "writer2", "writer2_span");
+ let _e = span2.enter();
+ tracing::warn!(target: "writer1", "hello writer1!");
+ });
+
+ let actual = sanitize_timings(make_writer1.get_string());
+ assert_eq!(
+ "fake time writer1_span{x=42}:writer2_span: hello writer1!\n\
+ fake time writer1_span{x=42}: close timing timing\n",
+ actual.as_str()
+ );
+ let actual = sanitize_timings(make_writer2.get_string());
+ assert_eq!(
+ "fake time writer1_span{x=42}: hello writer2!\n\
+ fake time writer1_span{x=42}:writer2_span: close timing timing\n",
+ actual.as_str()
+ );
+ }
+
+ // Because we need to modify an environment variable for these test cases,
+ // we do them all in a single test.
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn layer_no_color() {
+ const NO_COLOR: &str = "NO_COLOR";
+
+ // Restores the previous value of the `NO_COLOR` env variable when
+ // dropped.
+ //
+ // This is done in a `Drop` implementation, rather than just resetting
+ // the value at the end of the test, so that the previous value is
+ // restored even if the test panics.
+ struct RestoreEnvVar(Result<String, env::VarError>);
+ impl Drop for RestoreEnvVar {
+ fn drop(&mut self) {
+ match self.0 {
+ Ok(ref var) => env::set_var(NO_COLOR, var),
+ Err(_) => env::remove_var(NO_COLOR),
+ }
+ }
+ }
+
+ let _saved_no_color = RestoreEnvVar(env::var(NO_COLOR));
+
+ let cases: Vec<(Option<&str>, bool)> = vec![
+ (Some("0"), false), // any non-empty value disables ansi
+ (Some("off"), false), // any non-empty value disables ansi
+ (Some("1"), false),
+ (Some(""), true), // empty value does not disable ansi
+ (None, true),
+ ];
+
+ for (var, ansi) in cases {
+ if let Some(value) = var {
+ env::set_var(NO_COLOR, value);
+ } else {
+ env::remove_var(NO_COLOR);
+ }
+
+ let layer: Layer<()> = fmt::Layer::default();
+ assert_eq!(
+ layer.is_ansi, ansi,
+ "NO_COLOR={:?}; Layer::default().is_ansi should be {}",
+ var, ansi
+ );
+
+ // with_ansi should override any `NO_COLOR` value
+ let layer: Layer<()> = fmt::Layer::default().with_ansi(true);
+ assert!(
+ layer.is_ansi,
+ "NO_COLOR={:?}; Layer::default().with_ansi(true).is_ansi should be true",
+ var
+ );
+
+ // set_ansi should override any `NO_COLOR` value
+ let mut layer: Layer<()> = fmt::Layer::default();
+ layer.set_ansi(true);
+ assert!(
+ layer.is_ansi,
+ "NO_COLOR={:?}; layer.set_ansi(true); layer.is_ansi should be true",
+ var
+ );
+ }
+
+ // dropping `_saved_no_color` will restore the previous value of
+ // `NO_COLOR`.
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/format/json.rs b/crates/tracing-subscriber/src/fmt/format/json.rs
new file mode 100644
index 0000000..bf32f7c
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/format/json.rs
@@ -0,0 +1,885 @@
+use super::{Format, FormatEvent, FormatFields, FormatTime, Writer};
+use crate::{
+ field::{RecordFields, VisitOutput},
+ fmt::{
+ fmt_layer::{FmtContext, FormattedFields},
+ writer::WriteAdaptor,
+ },
+ registry::LookupSpan,
+};
+use serde::ser::{SerializeMap, Serializer as _};
+use serde_json::Serializer;
+use std::{
+ collections::BTreeMap,
+ fmt::{self, Write},
+};
+use tracing_core::{
+ field::{self, Field},
+ span::Record,
+ Event, Subscriber,
+};
+use tracing_serde::AsSerde;
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+/// Marker for [`Format`] that indicates that the newline-delimited JSON log
+/// format should be used.
+///
+/// This formatter is intended for production use with systems where structured
+/// logs are consumed as JSON by analysis and viewing tools. The JSON output is
+/// not optimized for human readability; instead, it should be pretty-printed
+/// using external JSON tools such as `jq`, or using a JSON log viewer.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-json
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-json`
+/// {"timestamp":"2022-02-15T18:47:10.821315Z","level":"INFO","fields":{"message":"preparing to shave yaks","number_of_yaks":3},"target":"fmt_json"}
+/// {"timestamp":"2022-02-15T18:47:10.821422Z","level":"INFO","fields":{"message":"shaving yaks"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821495Z","level":"TRACE","fields":{"message":"hello! I'm gonna shave a yak","excitement":"yay!"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":1,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821546Z","level":"TRACE","fields":{"message":"yak shaved successfully"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":1,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821598Z","level":"DEBUG","fields":{"yak":1,"shaved":true},"target":"yak_events","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821637Z","level":"TRACE","fields":{"yaks_shaved":1},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821684Z","level":"TRACE","fields":{"message":"hello! I'm gonna shave a yak","excitement":"yay!"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":2,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821727Z","level":"TRACE","fields":{"message":"yak shaved successfully"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":2,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821773Z","level":"DEBUG","fields":{"yak":2,"shaved":true},"target":"yak_events","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821806Z","level":"TRACE","fields":{"yaks_shaved":2},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821909Z","level":"TRACE","fields":{"message":"hello! I'm gonna shave a yak","excitement":"yay!"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":3,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.821956Z","level":"WARN","fields":{"message":"could not locate yak"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"},{"yak":3,"name":"shave"}]}
+/// {"timestamp":"2022-02-15T18:47:10.822006Z","level":"DEBUG","fields":{"yak":3,"shaved":false},"target":"yak_events","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.822041Z","level":"ERROR","fields":{"message":"failed to shave yak","yak":3,"error":"missing yak"},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.822079Z","level":"TRACE","fields":{"yaks_shaved":2},"target":"fmt_json::yak_shave","spans":[{"yaks":3,"name":"shaving_yaks"}]}
+/// {"timestamp":"2022-02-15T18:47:10.822117Z","level":"INFO","fields":{"message":"yak shaving completed","all_yaks_shaved":false},"target":"fmt_json"}
+/// </pre>
+///
+/// # Options
+///
+/// This formatter exposes additional options to configure the structure of the
+/// output JSON objects:
+///
+/// - [`Json::flatten_event`] can be used to enable flattening event fields into
+/// the root
+/// - [`Json::with_current_span`] can be used to control logging of the current
+/// span
+/// - [`Json::with_span_list`] can be used to control logging of the span list
+/// object.
+///
+/// By default, event fields are not flattened, and both current span and span
+/// list are logged.
+///
+/// # Valuable Support
+///
+/// Experimental support is available for using the [`valuable`] crate to record
+/// user-defined values as structured JSON. When the ["valuable" unstable
+/// feature][unstable] is enabled, types implementing [`valuable::Valuable`] will
+/// be recorded as structured JSON, rather than
+/// using their [`std::fmt::Debug`] implementations.
+///
+/// **Note**: This is an experimental feature. [Unstable features][unstable]
+/// must be enabled in order to use `valuable` support.
+///
+/// [`Json::flatten_event`]: Json::flatten_event()
+/// [`Json::with_current_span`]: Json::with_current_span()
+/// [`Json::with_span_list`]: Json::with_span_list()
+/// [`valuable`]: https://crates.io/crates/valuable
+/// [unstable]: crate#unstable-features
+/// [`valuable::Valuable`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html
+#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Json {
+ pub(crate) flatten_event: bool,
+ pub(crate) display_current_span: bool,
+ pub(crate) display_span_list: bool,
+}
+
+impl Json {
+ /// If set to `true` event metadata will be flattened into the root object.
+ pub fn flatten_event(&mut self, flatten_event: bool) {
+ self.flatten_event = flatten_event;
+ }
+
+ /// If set to `false`, formatted events won't contain a field for the current span.
+ pub fn with_current_span(&mut self, display_current_span: bool) {
+ self.display_current_span = display_current_span;
+ }
+
+ /// If set to `false`, formatted events won't contain a list of all currently
+ /// entered spans. Spans are logged in a list from root to leaf.
+ pub fn with_span_list(&mut self, display_span_list: bool) {
+ self.display_span_list = display_span_list;
+ }
+}
+
+struct SerializableContext<'a, 'b, Span, N>(
+ &'b crate::layer::Context<'a, Span>,
+ std::marker::PhantomData<N>,
+)
+where
+ Span: Subscriber + for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static;
+
+impl<'a, 'b, Span, N> serde::ser::Serialize for SerializableContext<'a, 'b, Span, N>
+where
+ Span: Subscriber + for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn serialize<Ser>(&self, serializer_o: Ser) -> Result<Ser::Ok, Ser::Error>
+ where
+ Ser: serde::ser::Serializer,
+ {
+ use serde::ser::SerializeSeq;
+ let mut serializer = serializer_o.serialize_seq(None)?;
+
+ if let Some(leaf_span) = self.0.lookup_current() {
+ for span in leaf_span.scope().from_root() {
+ serializer.serialize_element(&SerializableSpan(&span, self.1))?;
+ }
+ }
+
+ serializer.end()
+ }
+}
+
+struct SerializableSpan<'a, 'b, Span, N>(
+ &'b crate::registry::SpanRef<'a, Span>,
+ std::marker::PhantomData<N>,
+)
+where
+ Span: for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static;
+
+impl<'a, 'b, Span, N> serde::ser::Serialize for SerializableSpan<'a, 'b, Span, N>
+where
+ Span: for<'lookup> crate::registry::LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
+ where
+ Ser: serde::ser::Serializer,
+ {
+ let mut serializer = serializer.serialize_map(None)?;
+
+ let ext = self.0.extensions();
+ let data = ext
+ .get::<FormattedFields<N>>()
+ .expect("Unable to find FormattedFields in extensions; this is a bug");
+
+ // TODO: let's _not_ do this, but this resolves
+ // https://github.com/tokio-rs/tracing/issues/391.
+ // We should probably rework this to use a `serde_json::Value` or something
+ // similar in a JSON-specific layer, but I'd (david)
+ // rather have a uglier fix now rather than shipping broken JSON.
+ match serde_json::from_str::<serde_json::Value>(data) {
+ Ok(serde_json::Value::Object(fields)) => {
+ for field in fields {
+ serializer.serialize_entry(&field.0, &field.1)?;
+ }
+ }
+ // We have fields for this span which are valid JSON but not an object.
+ // This is probably a bug, so panic if we're in debug mode
+ Ok(_) if cfg!(debug_assertions) => panic!(
+ "span '{}' had malformed fields! this is a bug.\n error: invalid JSON object\n fields: {:?}",
+ self.0.metadata().name(),
+ data
+ ),
+ // If we *aren't* in debug mode, it's probably best not to
+ // crash the program, let's log the field found but also an
+ // message saying it's type is invalid
+ Ok(value) => {
+ serializer.serialize_entry("field", &value)?;
+ serializer.serialize_entry("field_error", "field was no a valid object")?
+ }
+ // We have previously recorded fields for this span
+ // should be valid JSON. However, they appear to *not*
+ // be valid JSON. This is almost certainly a bug, so
+ // panic if we're in debug mode
+ Err(e) if cfg!(debug_assertions) => panic!(
+ "span '{}' had malformed fields! this is a bug.\n error: {}\n fields: {:?}",
+ self.0.metadata().name(),
+ e,
+ data
+ ),
+ // If we *aren't* in debug mode, it's probably best not
+ // crash the program, but let's at least make sure it's clear
+ // that the fields are not supposed to be missing.
+ Err(e) => serializer.serialize_entry("field_error", &format!("{}", e))?,
+ };
+ serializer.serialize_entry("name", self.0.metadata().name())?;
+ serializer.end()
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Json, T>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result
+ where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ {
+ let mut timestamp = String::new();
+ self.timer.format_time(&mut Writer::new(&mut timestamp))?;
+
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ let mut visit = || {
+ let mut serializer = Serializer::new(WriteAdaptor::new(&mut writer));
+
+ let mut serializer = serializer.serialize_map(None)?;
+
+ if self.display_timestamp {
+ serializer.serialize_entry("timestamp", ×tamp)?;
+ }
+
+ if self.display_level {
+ serializer.serialize_entry("level", &meta.level().as_serde())?;
+ }
+
+ let format_field_marker: std::marker::PhantomData<N> = std::marker::PhantomData;
+
+ let current_span = if self.format.display_current_span || self.format.display_span_list
+ {
+ event
+ .parent()
+ .and_then(|id| ctx.span(id))
+ .or_else(|| ctx.lookup_current())
+ } else {
+ None
+ };
+
+ if self.format.flatten_event {
+ let mut visitor = tracing_serde::SerdeMapVisitor::new(serializer);
+ event.record(&mut visitor);
+
+ serializer = visitor.take_serializer()?;
+ } else {
+ use tracing_serde::fields::AsMap;
+ serializer.serialize_entry("fields", &event.field_map())?;
+ };
+
+ if self.display_target {
+ serializer.serialize_entry("target", meta.target())?;
+ }
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ serializer.serialize_entry("filename", filename)?;
+ }
+ }
+
+ if self.display_line_number {
+ if let Some(line_number) = meta.line() {
+ serializer.serialize_entry("line_number", &line_number)?;
+ }
+ }
+
+ if self.format.display_current_span {
+ if let Some(ref span) = current_span {
+ serializer
+ .serialize_entry("span", &SerializableSpan(span, format_field_marker))
+ .unwrap_or(());
+ }
+ }
+
+ if self.format.display_span_list && current_span.is_some() {
+ serializer.serialize_entry(
+ "spans",
+ &SerializableContext(&ctx.ctx, format_field_marker),
+ )?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ serializer.serialize_entry("threadName", name)?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ serializer
+ .serialize_entry("threadName", &format!("{:?}", current_thread.id()))?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ serializer
+ .serialize_entry("threadId", &format!("{:?}", std::thread::current().id()))?;
+ }
+
+ serializer.end()
+ };
+
+ visit().map_err(|_| fmt::Error)?;
+ writeln!(writer)
+ }
+}
+
+impl Default for Json {
+ fn default() -> Json {
+ Json {
+ flatten_event: false,
+ display_current_span: true,
+ display_span_list: true,
+ }
+ }
+}
+
+/// The JSON [`FormatFields`] implementation.
+///
+#[derive(Debug)]
+pub struct JsonFields {
+ // reserve the ability to add fields to this without causing a breaking
+ // change in the future.
+ _private: (),
+}
+
+impl JsonFields {
+ /// Returns a new JSON [`FormatFields`] implementation.
+ ///
+ pub fn new() -> Self {
+ Self { _private: () }
+ }
+}
+
+impl Default for JsonFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<'a> FormatFields<'a> for JsonFields {
+ /// Format the provided `fields` to the provided `writer`, returning a result.
+ fn format_fields<R: RecordFields>(&self, mut writer: Writer<'_>, fields: R) -> fmt::Result {
+ let mut v = JsonVisitor::new(&mut writer);
+ fields.record(&mut v);
+ v.finish()
+ }
+
+ /// Record additional field(s) on an existing span.
+ ///
+ /// By default, this appends a space to the current set of fields if it is
+ /// non-empty, and then calls `self.format_fields`. If different behavior is
+ /// required, the default implementation of this method can be overridden.
+ fn add_fields(
+ &self,
+ current: &'a mut FormattedFields<Self>,
+ fields: &Record<'_>,
+ ) -> fmt::Result {
+ if current.is_empty() {
+ // If there are no previously recorded fields, we can just reuse the
+ // existing string.
+ let mut writer = current.as_writer();
+ let mut v = JsonVisitor::new(&mut writer);
+ fields.record(&mut v);
+ v.finish()?;
+ return Ok(());
+ }
+
+ // If fields were previously recorded on this span, we need to parse
+ // the current set of fields as JSON, add the new fields, and
+ // re-serialize them. Otherwise, if we just appended the new fields
+ // to a previously serialized JSON object, we would end up with
+ // malformed JSON.
+ //
+ // XXX(eliza): this is far from efficient, but unfortunately, it is
+ // necessary as long as the JSON formatter is implemented on top of
+ // an interface that stores all formatted fields as strings.
+ //
+ // We should consider reimplementing the JSON formatter as a
+ // separate layer, rather than a formatter for the `fmt` layer —
+ // then, we could store fields as JSON values, and add to them
+ // without having to parse and re-serialize.
+ let mut new = String::new();
+ let map: BTreeMap<&'_ str, serde_json::Value> =
+ serde_json::from_str(current).map_err(|_| fmt::Error)?;
+ let mut v = JsonVisitor::new(&mut new);
+ v.values = map;
+ fields.record(&mut v);
+ v.finish()?;
+ current.fields = new;
+
+ Ok(())
+ }
+}
+
+/// The [visitor] produced by [`JsonFields`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: crate::field::Visit
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+pub struct JsonVisitor<'a> {
+ values: BTreeMap<&'a str, serde_json::Value>,
+ writer: &'a mut dyn Write,
+}
+
+impl<'a> fmt::Debug for JsonVisitor<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_fmt(format_args!("JsonVisitor {{ values: {:?} }}", self.values))
+ }
+}
+
+impl<'a> JsonVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: &'a mut dyn Write) -> Self {
+ Self {
+ values: BTreeMap::new(),
+ writer,
+ }
+ }
+}
+
+impl<'a> crate::field::VisitFmt for JsonVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ self.writer
+ }
+}
+
+impl<'a> crate::field::VisitOutput<fmt::Result> for JsonVisitor<'a> {
+ fn finish(self) -> fmt::Result {
+ let inner = || {
+ let mut serializer = Serializer::new(WriteAdaptor::new(self.writer));
+ let mut ser_map = serializer.serialize_map(None)?;
+
+ for (k, v) in self.values {
+ ser_map.serialize_entry(k, &v)?;
+ }
+
+ ser_map.end()
+ };
+
+ if inner().is_err() {
+ Err(fmt::Error)
+ } else {
+ Ok(())
+ }
+ }
+}
+
+impl<'a> field::Visit for JsonVisitor<'a> {
+ #[cfg(all(tracing_unstable, feature = "valuable"))]
+ fn record_value(&mut self, field: &Field, value: valuable_crate::Value<'_>) {
+ let value = match serde_json::to_value(valuable_serde::Serializable::new(value)) {
+ Ok(value) => value,
+ Err(_e) => {
+ #[cfg(debug_assertions)]
+ unreachable!(
+ "`valuable::Valuable` implementations should always serialize \
+ successfully, but an error occurred: {}",
+ _e,
+ );
+
+ #[cfg(not(debug_assertions))]
+ return;
+ }
+ };
+
+ self.values.insert(field.name(), value);
+ }
+
+ /// Visit a double precision floating point value.
+ fn record_f64(&mut self, field: &Field, value: f64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a signed 64-bit integer value.
+ fn record_i64(&mut self, field: &Field, value: i64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit an unsigned 64-bit integer value.
+ fn record_u64(&mut self, field: &Field, value: u64) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a boolean value.
+ fn record_bool(&mut self, field: &Field, value: bool) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ /// Visit a string value.
+ fn record_str(&mut self, field: &Field, value: &str) {
+ self.values
+ .insert(field.name(), serde_json::Value::from(value));
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ match field.name() {
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => (),
+ name if name.starts_with("r#") => {
+ self.values
+ .insert(&name[2..], serde_json::Value::from(format!("{:?}", value)));
+ }
+ name => {
+ self.values
+ .insert(name, serde_json::Value::from(format!("{:?}", value)));
+ }
+ };
+ }
+}
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::fmt::{format::FmtSpan, test::MockMakeWriter, time::FormatTime, SubscriberBuilder};
+ use tracing::{self, subscriber::with_default};
+
+ use std::fmt;
+ use std::path::Path;
+
+ struct MockTime;
+ impl FormatTime for MockTime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ write!(w, "fake time")
+ }
+ }
+
+ fn subscriber() -> SubscriberBuilder<JsonFields, Format<Json>> {
+ SubscriberBuilder::default().json()
+ }
+
+ #[test]
+ fn json() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_filename() {
+ let current_path = Path::new("tracing-subscriber")
+ .join("src")
+ .join("fmt")
+ .join("format")
+ .join("json.rs")
+ .to_str()
+ .expect("path must be valid unicode")
+ // escape windows backslashes
+ .replace('\\', "\\\\");
+ let expected =
+ &format!("{}{}{}",
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"filename\":\"",
+ current_path,
+ "\",\"fields\":{\"message\":\"some json test\"}}\n");
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_file(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_line_number() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"line_number\":42,\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_line_number(true)
+ .with_span_list(true);
+ test_json_with_line_number(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_flattened_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"message\":\"some json test\"}\n";
+
+ let subscriber = subscriber()
+ .flatten_event(true)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_disabled_current_span_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(false)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_disabled_span_list_event() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":42,\"name\":\"json_span\",\"number\":3},\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(false);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_nested_span() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"span\":{\"answer\":43,\"name\":\"nested_json_span\",\"number\":4},\"spans\":[{\"answer\":42,\"name\":\"json_span\",\"number\":3},{\"answer\":43,\"name\":\"nested_json_span\",\"number\":4}],\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ let span = tracing::span!(tracing::Level::INFO, "json_span", answer = 42, number = 3);
+ let _guard = span.enter();
+ let span = tracing::span!(
+ tracing::Level::INFO,
+ "nested_json_span",
+ answer = 43,
+ number = 4
+ );
+ let _guard = span.enter();
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn json_no_span() {
+ let expected =
+ "{\"timestamp\":\"fake time\",\"level\":\"INFO\",\"target\":\"tracing_subscriber::fmt::format::json::test\",\"fields\":{\"message\":\"some json test\"}}\n";
+ let subscriber = subscriber()
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(true);
+ test_json(expected, subscriber, || {
+ tracing::info!("some json test");
+ });
+ }
+
+ #[test]
+ fn record_works() {
+ // This test reproduces issue #707, where using `Span::record` causes
+ // any events inside the span to be ignored.
+
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt()
+ .json()
+ .with_writer(make_writer.clone())
+ .finish();
+
+ with_default(subscriber, || {
+ tracing::info!("an event outside the root span");
+ assert_eq!(
+ parse_as_json(&make_writer)["fields"]["message"],
+ "an event outside the root span"
+ );
+
+ let span = tracing::info_span!("the span", na = tracing::field::Empty);
+ span.record("na", "value");
+ let _enter = span.enter();
+
+ tracing::info!("an event inside the root span");
+ assert_eq!(
+ parse_as_json(&make_writer)["fields"]["message"],
+ "an event inside the root span"
+ );
+ });
+ }
+
+ #[test]
+ fn json_span_event_show_correct_context() {
+ let buffer = MockMakeWriter::default();
+ let subscriber = subscriber()
+ .with_writer(buffer.clone())
+ .flatten_event(false)
+ .with_current_span(true)
+ .with_span_list(false)
+ .with_span_events(FmtSpan::FULL)
+ .finish();
+
+ with_default(subscriber, || {
+ let context = "parent";
+ let parent_span = tracing::info_span!("parent_span", context);
+
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "new");
+ assert_eq!(event["span"]["context"], "parent");
+
+ let _parent_enter = parent_span.enter();
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "enter");
+ assert_eq!(event["span"]["context"], "parent");
+
+ let context = "child";
+ let child_span = tracing::info_span!("child_span", context);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "new");
+ assert_eq!(event["span"]["context"], "child");
+
+ let _child_enter = child_span.enter();
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "enter");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(_child_enter);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "exit");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(child_span);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "close");
+ assert_eq!(event["span"]["context"], "child");
+
+ drop(_parent_enter);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "exit");
+ assert_eq!(event["span"]["context"], "parent");
+
+ drop(parent_span);
+ let event = parse_as_json(&buffer);
+ assert_eq!(event["fields"]["message"], "close");
+ assert_eq!(event["span"]["context"], "parent");
+ });
+ }
+
+ #[test]
+ fn json_span_event_with_no_fields() {
+ // Check span events serialize correctly.
+ // Discussion: https://github.com/tokio-rs/tracing/issues/829#issuecomment-661984255
+ let buffer = MockMakeWriter::default();
+ let subscriber = subscriber()
+ .with_writer(buffer.clone())
+ .flatten_event(false)
+ .with_current_span(false)
+ .with_span_list(false)
+ .with_span_events(FmtSpan::FULL)
+ .finish();
+
+ with_default(subscriber, || {
+ let span = tracing::info_span!("valid_json");
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "new");
+
+ let _enter = span.enter();
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "enter");
+
+ drop(_enter);
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "exit");
+
+ drop(span);
+ assert_eq!(parse_as_json(&buffer)["fields"]["message"], "close");
+ });
+ }
+
+ fn parse_as_json(buffer: &MockMakeWriter) -> serde_json::Value {
+ let buf = String::from_utf8(buffer.buf().to_vec()).unwrap();
+ let json = buf
+ .lines()
+ .last()
+ .expect("expected at least one line to be written!");
+ match serde_json::from_str(json) {
+ Ok(v) => v,
+ Err(e) => panic!(
+ "assertion failed: JSON shouldn't be malformed\n error: {}\n json: {}",
+ e, json
+ ),
+ }
+ }
+
+ fn test_json<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<JsonFields, Format<Json>>,
+ producer: impl FnOnce() -> T,
+ ) {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, producer);
+
+ let buf = make_writer.buf();
+ let actual = std::str::from_utf8(&buf[..]).unwrap();
+ assert_eq!(
+ serde_json::from_str::<std::collections::HashMap<&str, serde_json::Value>>(expected)
+ .unwrap(),
+ serde_json::from_str(actual).unwrap()
+ );
+ }
+
+ fn test_json_with_line_number<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<JsonFields, Format<Json>>,
+ producer: impl FnOnce() -> T,
+ ) {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, producer);
+
+ let buf = make_writer.buf();
+ let actual = std::str::from_utf8(&buf[..]).unwrap();
+ let mut expected =
+ serde_json::from_str::<std::collections::HashMap<&str, serde_json::Value>>(expected)
+ .unwrap();
+ let expect_line_number = expected.remove("line_number").is_some();
+ let mut actual: std::collections::HashMap<&str, serde_json::Value> =
+ serde_json::from_str(actual).unwrap();
+ let line_number = actual.remove("line_number");
+ if expect_line_number {
+ assert_eq!(line_number.map(|x| x.is_number()), Some(true));
+ } else {
+ assert!(line_number.is_none());
+ }
+ assert_eq!(actual, expected);
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/format/mod.rs b/crates/tracing-subscriber/src/fmt/format/mod.rs
new file mode 100644
index 0000000..80612e1
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/format/mod.rs
@@ -0,0 +1,2179 @@
+//! Formatters for logging `tracing` events.
+//!
+//! This module provides several formatter implementations, as well as utilities
+//! for implementing custom formatters.
+//!
+//! # Formatters
+//! This module provides a number of formatter implementations:
+//!
+//! * [`Full`]: The default formatter. This emits human-readable,
+//! single-line logs for each event that occurs, with the current span context
+//! displayed before the formatted representation of the event. See
+//! [here](Full#example-output) for sample output.
+//!
+//! * [`Compact`]: A variant of the default formatter, optimized for
+//! short line lengths. Fields from the current span context are appended to
+//! the fields of the formatted event, and span names are not shown; the
+//! verbosity level is abbreviated to a single character. See
+//! [here](Compact#example-output) for sample output.
+//!
+//! * [`Pretty`]: Emits excessively pretty, multi-line logs, optimized
+//! for human readability. This is primarily intended to be used in local
+//! development and debugging, or for command-line applications, where
+//! automated analysis and compact storage of logs is less of a priority than
+//! readability and visual appeal. See [here](Pretty#example-output)
+//! for sample output.
+//!
+//! * [`Json`]: Outputs newline-delimited JSON logs. This is intended
+//! for production use with systems where structured logs are consumed as JSON
+//! by analysis and viewing tools. The JSON output is not optimized for human
+//! readability. See [here](Json#example-output) for sample output.
+use super::time::{FormatTime, SystemTime};
+use crate::{
+ field::{MakeOutput, MakeVisitor, RecordFields, VisitFmt, VisitOutput},
+ fmt::fmt_layer::FmtContext,
+ fmt::fmt_layer::FormattedFields,
+ registry::LookupSpan,
+};
+
+use std::fmt::{self, Debug, Display, Write};
+use tracing_core::{
+ field::{self, Field, Visit},
+ span, Event, Level, Subscriber,
+};
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+#[cfg(feature = "ansi")]
+use nu_ansi_term::{Color, Style};
+
+#[cfg(feature = "json")]
+mod json;
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+pub use json::*;
+
+#[cfg(feature = "ansi")]
+mod pretty;
+#[cfg(feature = "ansi")]
+#[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+pub use pretty::*;
+
+/// A type that can format a tracing [`Event`] to a [`Writer`].
+///
+/// `FormatEvent` is primarily used in the context of [`fmt::Subscriber`] or
+/// [`fmt::Layer`]. Each time an event is dispatched to [`fmt::Subscriber`] or
+/// [`fmt::Layer`], the subscriber or layer
+/// forwards it to its associated `FormatEvent` to emit a log message.
+///
+/// This trait is already implemented for function pointers with the same
+/// signature as `format_event`.
+///
+/// # Arguments
+///
+/// The following arguments are passed to `FormatEvent::format_event`:
+///
+/// * A [`FmtContext`]. This is an extension of the [`layer::Context`] type,
+/// which can be used for accessing stored information such as the current
+/// span context an event occurred in.
+///
+/// In addition, [`FmtContext`] exposes access to the [`FormatFields`]
+/// implementation that the subscriber was configured to use via the
+/// [`FmtContext::field_format`] method. This can be used when the
+/// [`FormatEvent`] implementation needs to format the event's fields.
+///
+/// For convenience, [`FmtContext`] also [implements `FormatFields`],
+/// forwarding to the configured [`FormatFields`] type.
+///
+/// * A [`Writer`] to which the formatted representation of the event is
+/// written. This type implements the [`std::fmt::Write`] trait, and therefore
+/// can be used with the [`std::write!`] and [`std::writeln!`] macros, as well
+/// as calling [`std::fmt::Write`] methods directly.
+///
+/// The [`Writer`] type also implements additional methods that provide
+/// information about how the event should be formatted. The
+/// [`Writer::has_ansi_escapes`] method indicates whether [ANSI terminal
+/// escape codes] are supported by the underlying I/O writer that the event
+/// will be written to. If this returns `true`, the formatter is permitted to
+/// use ANSI escape codes to add colors and other text formatting to its
+/// output. If it returns `false`, the event will be written to an output that
+/// does not support ANSI escape codes (such as a log file), and they should
+/// not be emitted.
+///
+/// Crates like [`nu_ansi_term`] and [`owo-colors`] can be used to add ANSI
+/// escape codes to formatted output.
+///
+/// * The actual [`Event`] to be formatted.
+///
+/// # Examples
+///
+/// This example re-implements a simiplified version of this crate's [default
+/// formatter]:
+///
+/// ```rust
+/// use std::fmt;
+/// use tracing_core::{Subscriber, Event};
+/// use tracing_subscriber::fmt::{
+/// format::{self, FormatEvent, FormatFields},
+/// FmtContext,
+/// FormattedFields,
+/// };
+/// use tracing_subscriber::registry::LookupSpan;
+///
+/// struct MyFormatter;
+///
+/// impl<S, N> FormatEvent<S, N> for MyFormatter
+/// where
+/// S: Subscriber + for<'a> LookupSpan<'a>,
+/// N: for<'a> FormatFields<'a> + 'static,
+/// {
+/// fn format_event(
+/// &self,
+/// ctx: &FmtContext<'_, S, N>,
+/// mut writer: format::Writer<'_>,
+/// event: &Event<'_>,
+/// ) -> fmt::Result {
+/// // Format values from the event's's metadata:
+/// let metadata = event.metadata();
+/// write!(&mut writer, "{} {}: ", metadata.level(), metadata.target())?;
+///
+/// // Format all the spans in the event's span context.
+/// if let Some(scope) = ctx.event_scope() {
+/// for span in scope.from_root() {
+/// write!(writer, "{}", span.name())?;
+///
+/// // `FormattedFields` is a formatted representation of the span's
+/// // fields, which is stored in its extensions by the `fmt` layer's
+/// // `new_span` method. The fields will have been formatted
+/// // by the same field formatter that's provided to the event
+/// // formatter in the `FmtContext`.
+/// let ext = span.extensions();
+/// let fields = &ext
+/// .get::<FormattedFields<N>>()
+/// .expect("will never be `None`");
+///
+/// // Skip formatting the fields if the span had no fields.
+/// if !fields.is_empty() {
+/// write!(writer, "{{{}}}", fields)?;
+/// }
+/// write!(writer, ": ")?;
+/// }
+/// }
+///
+/// // Write fields on the event
+/// ctx.field_format().format_fields(writer.by_ref(), event)?;
+///
+/// writeln!(writer)
+/// }
+/// }
+///
+/// let _subscriber = tracing_subscriber::fmt()
+/// .event_format(MyFormatter)
+/// .init();
+///
+/// let _span = tracing::info_span!("my_span", answer = 42).entered();
+/// tracing::info!(question = "life, the universe, and everything", "hello world");
+/// ```
+///
+/// This formatter will print events like this:
+///
+/// ```text
+/// DEBUG yak_shaving::shaver: some-span{field-on-span=foo}: started shaving yak
+/// ```
+///
+/// [`layer::Context`]: crate::layer::Context
+/// [`fmt::Layer`]: super::Layer
+/// [`fmt::Subscriber`]: super::Subscriber
+/// [`Event`]: tracing::Event
+/// [implements `FormatFields`]: super::FmtContext#impl-FormatFields<'writer>
+/// [ANSI terminal escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
+/// [`Writer::has_ansi_escapes`]: Writer::has_ansi_escapes
+/// [`nu_ansi_term`]: https://crates.io/crates/nu_ansi_term
+/// [`owo-colors`]: https://crates.io/crates/owo-colors
+/// [default formatter]: Full
+pub trait FormatEvent<S, N>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+{
+ /// Write a log message for `Event` in `Context` to the given [`Writer`].
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result;
+}
+
+impl<S, N> FormatEvent<S, N>
+ for fn(ctx: &FmtContext<'_, S, N>, Writer<'_>, &Event<'_>) -> fmt::Result
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ (*self)(ctx, writer, event)
+ }
+}
+/// A type that can format a [set of fields] to a [`Writer`].
+///
+/// `FormatFields` is primarily used in the context of [`FmtSubscriber`]. Each
+/// time a span or event with fields is recorded, the subscriber will format
+/// those fields with its associated `FormatFields` implementation.
+///
+/// [set of fields]: crate::field::RecordFields
+/// [`FmtSubscriber`]: super::Subscriber
+pub trait FormatFields<'writer> {
+ /// Format the provided `fields` to the provided [`Writer`], returning a result.
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result;
+
+ /// Record additional field(s) on an existing span.
+ ///
+ /// By default, this appends a space to the current set of fields if it is
+ /// non-empty, and then calls `self.format_fields`. If different behavior is
+ /// required, the default implementation of this method can be overridden.
+ fn add_fields(
+ &self,
+ current: &'writer mut FormattedFields<Self>,
+ fields: &span::Record<'_>,
+ ) -> fmt::Result {
+ if !current.fields.is_empty() {
+ current.fields.push(' ');
+ }
+ self.format_fields(current.as_writer(), fields)
+ }
+}
+
+/// Returns the default configuration for an [event formatter].
+///
+/// Methods on the returned event formatter can be used for further
+/// configuration. For example:
+///
+/// ```rust
+/// let format = tracing_subscriber::fmt::format()
+/// .without_time() // Don't include timestamps
+/// .with_target(false) // Don't include event targets.
+/// .with_level(false) // Don't include event levels.
+/// .compact(); // Use a more compact, abbreviated format.
+///
+/// // Use the configured formatter when building a new subscriber.
+/// tracing_subscriber::fmt()
+/// .event_format(format)
+/// .init();
+/// ```
+pub fn format() -> Format {
+ Format::default()
+}
+
+/// Returns the default configuration for a JSON [event formatter].
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+pub fn json() -> Format<Json> {
+ format().json()
+}
+
+/// Returns a [`FormatFields`] implementation that formats fields using the
+/// provided function or closure.
+///
+pub fn debug_fn<F>(f: F) -> FieldFn<F>
+where
+ F: Fn(&mut Writer<'_>, &Field, &dyn fmt::Debug) -> fmt::Result + Clone,
+{
+ FieldFn(f)
+}
+
+/// A writer to which formatted representations of spans and events are written.
+///
+/// This type is provided as input to the [`FormatEvent::format_event`] and
+/// [`FormatFields::format_fields`] methods, which will write formatted
+/// representations of [`Event`]s and [fields] to the `Writer`.
+///
+/// This type implements the [`std::fmt::Write`] trait, allowing it to be used
+/// with any function that takes an instance of [`std::fmt::Write`].
+/// Additionally, it can be used with the standard library's [`std::write!`] and
+/// [`std::writeln!`] macros.
+///
+/// Additionally, a `Writer` may expose additional `tracing`-specific
+/// information to the formatter implementation.
+///
+/// [fields]: tracing_core::field
+pub struct Writer<'writer> {
+ writer: &'writer mut dyn fmt::Write,
+ // TODO(eliza): add ANSI support
+ is_ansi: bool,
+}
+
+/// A [`FormatFields`] implementation that formats fields by calling a function
+/// or closure.
+///
+#[derive(Debug, Clone)]
+pub struct FieldFn<F>(F);
+/// The [visitor] produced by [`FieldFn`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: super::super::field::Visit
+/// [`MakeVisitor`]: super::super::field::MakeVisitor
+pub struct FieldFnVisitor<'a, F> {
+ f: F,
+ writer: Writer<'a>,
+ result: fmt::Result,
+}
+/// Marker for [`Format`] that indicates that the compact log format should be used.
+///
+/// The compact format includes fields from all currently entered spans, after
+/// the event's fields. Span fields are ordered (but not grouped) by
+/// span, and span names are not shown. A more compact representation of the
+/// event's [`Level`] is used, and additional information—such as the event's
+/// target—is disabled by default.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-compact
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-compact`
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809287Z </font><font color="#4E9A06"> INFO</font> <b>fmt_compact</b><font color="#AAAAAA">: preparing to shave yaks </font><i>number_of_yaks</i><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809367Z </font><font color="#4E9A06"> INFO</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: shaving yaks </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809414Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!" </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809443Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: yak shaved successfully </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809477Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=1 </font><i>shaved</i><font color="#AAAAAA">=true </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809500Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=1 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809531Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!" </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809554Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: yak shaved successfully </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809581Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=2 </font><i>shaved</i><font color="#AAAAAA">=true </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809606Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=2 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809635Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!" </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809664Z </font><font color="#C4A000"> WARN</font> <b>shaving_yaks</b>:<b>shave</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: could not locate yak </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3 </font><font color="#AAAAAA"><i>yak</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809693Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks</b>: <b>yak_events</b><font color="#AAAAAA">: </font><i>yak</i><font color="#AAAAAA">=3 </font><i>shaved</i><font color="#AAAAAA">=false </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809717Z </font><font color="#CC0000">ERROR</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: failed to shave yak </font><i>yak</i><font color="#AAAAAA">=3 </font><i>error</i><font color="#AAAAAA">=missing yak </font><i>error.sources</i><font color="#AAAAAA">=[out of space, out of cash] </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809743Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks</b>: <b>fmt_compact::yak_shave</b><font color="#AAAAAA">: </font><i>yaks_shaved</i><font color="#AAAAAA">=2 </font><font color="#AAAAAA"><i>yaks</i></font><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-17T19:51:05.809768Z </font><font color="#4E9A06"> INFO</font> <b>fmt_compact</b><font color="#AAAAAA">: yak shaving completed </font><i>all_yaks_shaved</i><font color="#AAAAAA">=false</font>
+///
+/// </pre>
+#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Compact;
+
+/// Marker for [`Format`] that indicates that the default log format should be used.
+///
+/// This formatter shows the span context before printing event data. Spans are
+/// displayed including their names and fields.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt`
+/// <font color="#AAAAAA">2022-02-15T18:40:14.289898Z </font><font color="#4E9A06"> INFO</font> fmt: preparing to shave yaks <i>number_of_yaks</i><font color="#AAAAAA">=3</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.289974Z </font><font color="#4E9A06"> INFO</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: shaving yaks</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290011Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=1</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!"</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290038Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=1</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: yak shaved successfully</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290070Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=1 </font><i>shaved</i><font color="#AAAAAA">=true</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290089Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=1</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290114Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=2</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!"</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290134Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=2</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: yak shaved successfully</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290157Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=2 </font><i>shaved</i><font color="#AAAAAA">=true</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290174Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290198Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: hello! I'm gonna shave a yak </font><i>excitement</i><font color="#AAAAAA">="yay!"</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290222Z </font><font color="#C4A000"> WARN</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">:</font><b>shave{</b><i>yak</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: could not locate yak</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290247Z </font><font color="#3465A4">DEBUG</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: yak_events: </font><i>yak</i><font color="#AAAAAA">=3 </font><i>shaved</i><font color="#AAAAAA">=false</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290268Z </font><font color="#CC0000">ERROR</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: failed to shave yak </font><i>yak</i><font color="#AAAAAA">=3 </font><i>error</i><font color="#AAAAAA">=missing yak </font><i>error.sources</i><font color="#AAAAAA">=[out of space, out of cash]</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290287Z </font><font color="#75507B">TRACE</font> <b>shaving_yaks{</b><i>yaks</i><font color="#AAAAAA">=3</font><b>}</b><font color="#AAAAAA">: fmt::yak_shave: </font><i>yaks_shaved</i><font color="#AAAAAA">=2</font>
+/// <font color="#AAAAAA">2022-02-15T18:40:14.290309Z </font><font color="#4E9A06"> INFO</font> fmt: yak shaving completed. <i>all_yaks_shaved</i><font color="#AAAAAA">=false</font>
+/// </pre>
+#[derive(Default, Debug, Copy, Clone, Eq, PartialEq)]
+pub struct Full;
+
+/// A pre-configured event formatter.
+///
+/// You will usually want to use this as the `FormatEvent` for a `FmtSubscriber`.
+///
+/// The default logging format, [`Full`] includes all fields in each event and its containing
+/// spans. The [`Compact`] logging format is intended to produce shorter log
+/// lines; it displays each event's fields, along with fields from the current
+/// span context, but other information is abbreviated. The [`Pretty`] logging
+/// format is an extra-verbose, multi-line human-readable logging format
+/// intended for use in development.
+#[derive(Debug, Clone)]
+pub struct Format<F = Full, T = SystemTime> {
+ format: F,
+ pub(crate) timer: T,
+ pub(crate) ansi: Option<bool>,
+ pub(crate) display_timestamp: bool,
+ pub(crate) display_target: bool,
+ pub(crate) display_level: bool,
+ pub(crate) display_thread_id: bool,
+ pub(crate) display_thread_name: bool,
+ pub(crate) display_filename: bool,
+ pub(crate) display_line_number: bool,
+}
+
+// === impl Writer ===
+
+impl<'writer> Writer<'writer> {
+ // TODO(eliza): consider making this a public API?
+ // We may not want to do that if we choose to expose specialized
+ // constructors instead (e.g. `from_string` that stores whether the string
+ // is empty...?)
+ //(@kaifastromai) I suppose having dedicated constructors may have certain benefits
+ // but I am not privy to the larger direction of tracing/subscriber.
+ /// Create a new [`Writer`] from any type that implements [`fmt::Write`].
+ ///
+ /// The returned `Writer` value may be passed as an argument to methods
+ /// such as [`Format::format_event`]. Since constructing a `Writer`
+ /// mutably borrows the underlying [`fmt::Write`] instance, that value may
+ /// be accessed again once the `Writer` is dropped. For example, if the
+ /// value implementing [`fmt::Write`] is a [`String`], it will contain
+ /// the formatted output of [`Format::format_event`], which may then be
+ /// used for other purposes.
+ #[must_use]
+ pub fn new(writer: &'writer mut impl fmt::Write) -> Self {
+ Self {
+ writer: writer as &mut dyn fmt::Write,
+ is_ansi: false,
+ }
+ }
+
+ // TODO(eliza): consider making this a public API?
+ pub(crate) fn with_ansi(self, is_ansi: bool) -> Self {
+ Self { is_ansi, ..self }
+ }
+
+ /// Return a new `Writer` that mutably borrows `self`.
+ ///
+ /// This can be used to temporarily borrow a `Writer` to pass a new `Writer`
+ /// to a function that takes a `Writer` by value, allowing the original writer
+ /// to still be used once that function returns.
+ pub fn by_ref(&mut self) -> Writer<'_> {
+ let is_ansi = self.is_ansi;
+ Writer {
+ writer: self as &mut dyn fmt::Write,
+ is_ansi,
+ }
+ }
+
+ /// Writes a string slice into this `Writer`, returning whether the write succeeded.
+ ///
+ /// This method can only succeed if the entire string slice was successfully
+ /// written, and this method will not return until all data has been written
+ /// or an error occurs.
+ ///
+ /// This is identical to calling the [`write_str` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an instance of [`std::fmt::Error`] on error.
+ ///
+ /// [`write_str` method]: std::fmt::Write::write_str
+ #[inline]
+ pub fn write_str(&mut self, s: &str) -> fmt::Result {
+ self.writer.write_str(s)
+ }
+
+ /// Writes a [`char`] into this writer, returning whether the write succeeded.
+ ///
+ /// A single [`char`] may be encoded as more than one byte.
+ /// This method can only succeed if the entire byte sequence was successfully
+ /// written, and this method will not return until all data has been
+ /// written or an error occurs.
+ ///
+ /// This is identical to calling the [`write_char` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an instance of [`std::fmt::Error`] on error.
+ ///
+ /// [`write_char` method]: std::fmt::Write::write_char
+ #[inline]
+ pub fn write_char(&mut self, c: char) -> fmt::Result {
+ self.writer.write_char(c)
+ }
+
+ /// Glue for usage of the [`write!`] macro with `Writer`s.
+ ///
+ /// This method should generally not be invoked manually, but rather through
+ /// the [`write!`] macro itself.
+ ///
+ /// This is identical to calling the [`write_fmt` method] from the `Writer`'s
+ /// [`std::fmt::Write`] implementation. However, it is also provided as an
+ /// inherent method, so that `Writer`s can be used with the [`write!` macro]
+ /// without needing to import the
+ /// [`std::fmt::Write`] trait.
+ ///
+ /// [`write_fmt` method]: std::fmt::Write::write_fmt
+ pub fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result {
+ self.writer.write_fmt(args)
+ }
+
+ /// Returns `true` if [ANSI escape codes] may be used to add colors
+ /// and other formatting when writing to this `Writer`.
+ ///
+ /// If this returns `false`, formatters should not emit ANSI escape codes.
+ ///
+ /// [ANSI escape codes]: https://en.wikipedia.org/wiki/ANSI_escape_code
+ pub fn has_ansi_escapes(&self) -> bool {
+ self.is_ansi
+ }
+
+ pub(in crate::fmt::format) fn bold(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().bold();
+ }
+ }
+
+ Style::new()
+ }
+
+ pub(in crate::fmt::format) fn dimmed(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().dimmed();
+ }
+ }
+
+ Style::new()
+ }
+
+ pub(in crate::fmt::format) fn italic(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.is_ansi {
+ return Style::new().italic();
+ }
+ }
+
+ Style::new()
+ }
+}
+
+impl fmt::Write for Writer<'_> {
+ #[inline]
+ fn write_str(&mut self, s: &str) -> fmt::Result {
+ Writer::write_str(self, s)
+ }
+
+ #[inline]
+ fn write_char(&mut self, c: char) -> fmt::Result {
+ Writer::write_char(self, c)
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, args: fmt::Arguments<'_>) -> fmt::Result {
+ Writer::write_fmt(self, args)
+ }
+}
+
+impl fmt::Debug for Writer<'_> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Writer")
+ .field("writer", &format_args!("<&mut dyn fmt::Write>"))
+ .field("is_ansi", &self.is_ansi)
+ .finish()
+ }
+}
+
+// === impl Format ===
+
+impl Default for Format<Full, SystemTime> {
+ fn default() -> Self {
+ Format {
+ format: Full,
+ timer: SystemTime,
+ ansi: None,
+ display_timestamp: true,
+ display_target: true,
+ display_level: true,
+ display_thread_id: false,
+ display_thread_name: false,
+ display_filename: false,
+ display_line_number: false,
+ }
+ }
+}
+
+impl<F, T> Format<F, T> {
+ /// Use a less verbose output format.
+ ///
+ /// See [`Compact`].
+ pub fn compact(self) -> Format<Compact, T> {
+ Format {
+ format: Compact,
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Use an excessively pretty, human-readable output format.
+ ///
+ /// See [`Pretty`].
+ ///
+ /// Note that this requires the "ansi" feature to be enabled.
+ ///
+ /// # Options
+ ///
+ /// [`Format::with_ansi`] can be used to disable ANSI terminal escape codes (which enable
+ /// formatting such as colors, bold, italic, etc) in event formatting. However, a field
+ /// formatter must be manually provided to avoid ANSI in the formatting of parent spans, like
+ /// so:
+ ///
+ /// ```
+ /// # use tracing_subscriber::fmt::format;
+ /// tracing_subscriber::fmt()
+ /// .pretty()
+ /// .with_ansi(false)
+ /// .fmt_fields(format::PrettyFields::new().with_ansi(false))
+ /// // ... other settings ...
+ /// .init();
+ /// ```
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn pretty(self) -> Format<Pretty, T> {
+ Format {
+ format: Pretty::default(),
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: true,
+ display_line_number: true,
+ }
+ }
+
+ /// Use the full JSON format.
+ ///
+ /// The full format includes fields from all entered spans.
+ ///
+ /// # Example Output
+ ///
+ /// ```ignore,json
+ /// {"timestamp":"Feb 20 11:28:15.096","level":"INFO","target":"mycrate","fields":{"message":"some message", "key": "value"}}
+ /// ```
+ ///
+ /// # Options
+ ///
+ /// - [`Format::flatten_event`] can be used to enable flattening event fields into the root
+ /// object.
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn json(self) -> Format<Json, T> {
+ Format {
+ format: Json::default(),
+ timer: self.timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Use the given [`timer`] for log message timestamps.
+ ///
+ /// See [`time` module] for the provided timer implementations.
+ ///
+ /// Note that using the `"time"` feature flag enables the
+ /// additional time formatters [`UtcTime`] and [`LocalTime`], which use the
+ /// [`time` crate] to provide more sophisticated timestamp formatting
+ /// options.
+ ///
+ /// [`timer`]: super::time::FormatTime
+ /// [`time` module]: mod@super::time
+ /// [`UtcTime`]: super::time::UtcTime
+ /// [`LocalTime`]: super::time::LocalTime
+ /// [`time` crate]: https://docs.rs/time/0.3
+ pub fn with_timer<T2>(self, timer: T2) -> Format<F, T2> {
+ Format {
+ format: self.format,
+ timer,
+ ansi: self.ansi,
+ display_target: self.display_target,
+ display_timestamp: self.display_timestamp,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Do not emit timestamps with log messages.
+ pub fn without_time(self) -> Format<F, ()> {
+ Format {
+ format: self.format,
+ timer: (),
+ ansi: self.ansi,
+ display_timestamp: false,
+ display_target: self.display_target,
+ display_level: self.display_level,
+ display_thread_id: self.display_thread_id,
+ display_thread_name: self.display_thread_name,
+ display_filename: self.display_filename,
+ display_line_number: self.display_line_number,
+ }
+ }
+
+ /// Enable ANSI terminal colors for formatted output.
+ pub fn with_ansi(self, ansi: bool) -> Format<F, T> {
+ Format {
+ ansi: Some(ansi),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's target is displayed.
+ pub fn with_target(self, display_target: bool) -> Format<F, T> {
+ Format {
+ display_target,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's level is displayed.
+ pub fn with_level(self, display_level: bool) -> Format<F, T> {
+ Format {
+ display_level,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [thread ID] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [thread ID]: std::thread::ThreadId
+ pub fn with_thread_ids(self, display_thread_id: bool) -> Format<F, T> {
+ Format {
+ display_thread_id,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [name] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [name]: std::thread#naming-threads
+ pub fn with_thread_names(self, display_thread_name: bool) -> Format<F, T> {
+ Format {
+ display_thread_name,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code file path][file] is
+ /// displayed.
+ ///
+ /// [file]: tracing_core::Metadata::file
+ pub fn with_file(self, display_filename: bool) -> Format<F, T> {
+ Format {
+ display_filename,
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code line number][line] is
+ /// displayed.
+ ///
+ /// [line]: tracing_core::Metadata::line
+ pub fn with_line_number(self, display_line_number: bool) -> Format<F, T> {
+ Format {
+ display_line_number,
+ ..self
+ }
+ }
+
+ /// Sets whether or not the source code location from which an event
+ /// originated is displayed.
+ ///
+ /// This is equivalent to calling [`Format::with_file`] and
+ /// [`Format::with_line_number`] with the same value.
+ pub fn with_source_location(self, display_location: bool) -> Self {
+ self.with_line_number(display_location)
+ .with_file(display_location)
+ }
+
+ #[inline]
+ fn format_timestamp(&self, writer: &mut Writer<'_>) -> fmt::Result
+ where
+ T: FormatTime,
+ {
+ // If timestamps are disabled, do nothing.
+ if !self.display_timestamp {
+ return Ok(());
+ }
+
+ // If ANSI color codes are enabled, format the timestamp with ANSI
+ // colors.
+ #[cfg(feature = "ansi")]
+ {
+ if writer.has_ansi_escapes() {
+ let style = Style::new().dimmed();
+ write!(writer, "{}", style.prefix())?;
+
+ // If getting the timestamp failed, don't bail --- only bail on
+ // formatting errors.
+ if self.timer.format_time(writer).is_err() {
+ writer.write_str("<unknown time>")?;
+ }
+
+ write!(writer, "{} ", style.suffix())?;
+ return Ok(());
+ }
+ }
+
+ // Otherwise, just format the timestamp without ANSI formatting.
+ // If getting the timestamp failed, don't bail --- only bail on
+ // formatting errors.
+ if self.timer.format_time(writer).is_err() {
+ writer.write_str("<unknown time>")?;
+ }
+ writer.write_char(' ')
+ }
+}
+
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+impl<T> Format<Json, T> {
+ /// Use the full JSON format with the event's event fields flattened.
+ ///
+ /// # Example Output
+ ///
+ /// ```ignore,json
+ /// {"timestamp":"Feb 20 11:28:15.096","level":"INFO","target":"mycrate", "message":"some message", "key": "value"}
+ /// ```
+ /// See [`Json`][super::format::Json].
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn flatten_event(mut self, flatten_event: bool) -> Format<Json, T> {
+ self.format.flatten_event(flatten_event);
+ self
+ }
+
+ /// Sets whether or not the formatter will include the current span in
+ /// formatted events.
+ ///
+ /// See [`format::Json`][Json]
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn with_current_span(mut self, display_current_span: bool) -> Format<Json, T> {
+ self.format.with_current_span(display_current_span);
+ self
+ }
+
+ /// Sets whether or not the formatter will include a list (from root to
+ /// leaf) of all currently entered spans in formatted events.
+ ///
+ /// See [`format::Json`][Json]
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn with_span_list(mut self, display_span_list: bool) -> Format<Json, T> {
+ self.format.with_span_list(display_span_list);
+ self
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Full, T>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ if self.display_level {
+ let fmt_level = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtLevel::new(meta.level())
+ }
+ };
+ write!(writer, "{} ", fmt_level)?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ write!(writer, "{} ", FmtThreadName::new(name))?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ write!(writer, "{:0>2?} ", current_thread.id())?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ write!(writer, "{:0>2?} ", std::thread::current().id())?;
+ }
+
+ let dimmed = writer.dimmed();
+
+ if let Some(scope) = ctx.event_scope() {
+ let bold = writer.bold();
+
+ let mut seen = false;
+
+ for span in scope.from_root() {
+ write!(writer, "{}", bold.paint(span.metadata().name()))?;
+ seen = true;
+
+ let ext = span.extensions();
+ if let Some(fields) = &ext.get::<FormattedFields<N>>() {
+ if !fields.is_empty() {
+ write!(writer, "{}{}{}", bold.paint("{"), fields, bold.paint("}"))?;
+ }
+ }
+ write!(writer, "{}", dimmed.paint(":"))?;
+ }
+
+ if seen {
+ writer.write_char(' ')?;
+ }
+ };
+
+ if self.display_target {
+ write!(
+ writer,
+ "{}{} ",
+ dimmed.paint(meta.target()),
+ dimmed.paint(":")
+ )?;
+ }
+
+ let line_number = if self.display_line_number {
+ meta.line()
+ } else {
+ None
+ };
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ write!(
+ writer,
+ "{}{}{}",
+ dimmed.paint(filename),
+ dimmed.paint(":"),
+ if line_number.is_some() { "" } else { " " }
+ )?;
+ }
+ }
+
+ if let Some(line_number) = line_number {
+ write!(
+ writer,
+ "{}{}:{} ",
+ dimmed.prefix(),
+ line_number,
+ dimmed.suffix()
+ )?;
+ }
+
+ ctx.format_fields(writer.by_ref(), event)?;
+ writeln!(writer)
+ }
+}
+
+impl<S, N, T> FormatEvent<S, N> for Format<Compact, T>
+where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, S, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ if self.display_level {
+ let fmt_level = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtLevel::new(meta.level())
+ }
+ };
+ write!(writer, "{} ", fmt_level)?;
+ }
+
+ if self.display_thread_name {
+ let current_thread = std::thread::current();
+ match current_thread.name() {
+ Some(name) => {
+ write!(writer, "{} ", FmtThreadName::new(name))?;
+ }
+ // fall-back to thread id when name is absent and ids are not enabled
+ None if !self.display_thread_id => {
+ write!(writer, "{:0>2?} ", current_thread.id())?;
+ }
+ _ => {}
+ }
+ }
+
+ if self.display_thread_id {
+ write!(writer, "{:0>2?} ", std::thread::current().id())?;
+ }
+
+ let fmt_ctx = {
+ #[cfg(feature = "ansi")]
+ {
+ FmtCtx::new(ctx, event.parent(), writer.has_ansi_escapes())
+ }
+ #[cfg(not(feature = "ansi"))]
+ {
+ FmtCtx::new(&ctx, event.parent())
+ }
+ };
+ write!(writer, "{}", fmt_ctx)?;
+
+ let dimmed = writer.dimmed();
+
+ let mut needs_space = false;
+ if self.display_target {
+ write!(
+ writer,
+ "{}{}",
+ dimmed.paint(meta.target()),
+ dimmed.paint(":")
+ )?;
+ needs_space = true;
+ }
+
+ if self.display_filename {
+ if let Some(filename) = meta.file() {
+ if self.display_target {
+ writer.write_char(' ')?;
+ }
+ write!(writer, "{}{}", dimmed.paint(filename), dimmed.paint(":"))?;
+ needs_space = true;
+ }
+ }
+
+ if self.display_line_number {
+ if let Some(line_number) = meta.line() {
+ write!(
+ writer,
+ "{}{}{}{}",
+ dimmed.prefix(),
+ line_number,
+ dimmed.suffix(),
+ dimmed.paint(":")
+ )?;
+ needs_space = true;
+ }
+ }
+
+ if needs_space {
+ writer.write_char(' ')?;
+ }
+
+ ctx.format_fields(writer.by_ref(), event)?;
+
+ for span in ctx
+ .event_scope()
+ .into_iter()
+ .flat_map(crate::registry::Scope::from_root)
+ {
+ let exts = span.extensions();
+ if let Some(fields) = exts.get::<FormattedFields<N>>() {
+ if !fields.is_empty() {
+ write!(writer, " {}", dimmed.paint(&fields.fields))?;
+ }
+ }
+ }
+ writeln!(writer)
+ }
+}
+
+// === impl FormatFields ===
+impl<'writer, M> FormatFields<'writer> for M
+where
+ M: MakeOutput<Writer<'writer>, fmt::Result>,
+ M::Visitor: VisitFmt + VisitOutput<fmt::Result>,
+{
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result {
+ let mut v = self.make_visitor(writer);
+ fields.record(&mut v);
+ v.finish()
+ }
+}
+
+/// The default [`FormatFields`] implementation.
+///
+#[derive(Debug)]
+pub struct DefaultFields {
+ // reserve the ability to add fields to this without causing a breaking
+ // change in the future.
+ _private: (),
+}
+
+/// The [visitor] produced by [`DefaultFields`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: super::super::field::Visit
+/// [`MakeVisitor`]: super::super::field::MakeVisitor
+#[derive(Debug)]
+pub struct DefaultVisitor<'a> {
+ writer: Writer<'a>,
+ is_empty: bool,
+ result: fmt::Result,
+}
+
+impl DefaultFields {
+ /// Returns a new default [`FormatFields`] implementation.
+ ///
+ pub fn new() -> Self {
+ Self { _private: () }
+ }
+}
+
+impl Default for DefaultFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<'a> MakeVisitor<Writer<'a>> for DefaultFields {
+ type Visitor = DefaultVisitor<'a>;
+
+ #[inline]
+ fn make_visitor(&self, target: Writer<'a>) -> Self::Visitor {
+ DefaultVisitor::new(target, true)
+ }
+}
+
+// === impl DefaultVisitor ===
+
+impl<'a> DefaultVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: Writer<'a>, is_empty: bool) -> Self {
+ Self {
+ writer,
+ is_empty,
+ result: Ok(()),
+ }
+ }
+
+ fn maybe_pad(&mut self) {
+ if self.is_empty {
+ self.is_empty = false;
+ } else {
+ self.result = write!(self.writer, " ");
+ }
+ }
+}
+
+impl<'a> field::Visit for DefaultVisitor<'a> {
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if self.result.is_err() {
+ return;
+ }
+
+ if field.name() == "message" {
+ self.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.record_debug(field, &value)
+ }
+ }
+
+ fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ if let Some(source) = value.source() {
+ let italic = self.writer.italic();
+ self.record_debug(
+ field,
+ &format_args!(
+ "{} {}{}{}{}",
+ value,
+ italic.paint(field.name()),
+ italic.paint(".sources"),
+ self.writer.dimmed().paint("="),
+ ErrorSourceList(source)
+ ),
+ )
+ } else {
+ self.record_debug(field, &format_args!("{}", value))
+ }
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_err() {
+ return;
+ }
+
+ self.maybe_pad();
+ self.result = match field.name() {
+ "message" => write!(self.writer, "{:?}", value),
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => Ok(()),
+ name if name.starts_with("r#") => write!(
+ self.writer,
+ "{}{}{:?}",
+ self.writer.italic().paint(&name[2..]),
+ self.writer.dimmed().paint("="),
+ value
+ ),
+ name => write!(
+ self.writer,
+ "{}{}{:?}",
+ self.writer.italic().paint(name),
+ self.writer.dimmed().paint("="),
+ value
+ ),
+ };
+ }
+}
+
+impl<'a> crate::field::VisitOutput<fmt::Result> for DefaultVisitor<'a> {
+ fn finish(self) -> fmt::Result {
+ self.result
+ }
+}
+
+impl<'a> crate::field::VisitFmt for DefaultVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}
+
+/// Renders an error into a list of sources, *including* the error
+struct ErrorSourceList<'a>(&'a (dyn std::error::Error + 'static));
+
+impl<'a> Display for ErrorSourceList<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut list = f.debug_list();
+ let mut curr = Some(self.0);
+ while let Some(curr_err) = curr {
+ list.entry(&format_args!("{}", curr_err));
+ curr = curr_err.source();
+ }
+ list.finish()
+ }
+}
+
+struct FmtCtx<'a, S, N> {
+ ctx: &'a FmtContext<'a, S, N>,
+ span: Option<&'a span::Id>,
+ #[cfg(feature = "ansi")]
+ ansi: bool,
+}
+
+impl<'a, S, N: 'a> FmtCtx<'a, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ #[cfg(feature = "ansi")]
+ pub(crate) fn new(
+ ctx: &'a FmtContext<'_, S, N>,
+ span: Option<&'a span::Id>,
+ ansi: bool,
+ ) -> Self {
+ Self { ctx, span, ansi }
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ pub(crate) fn new(ctx: &'a FmtContext<'_, S, N>, span: Option<&'a span::Id>) -> Self {
+ Self { ctx, span }
+ }
+
+ fn bold(&self) -> Style {
+ #[cfg(feature = "ansi")]
+ {
+ if self.ansi {
+ return Style::new().bold();
+ }
+ }
+
+ Style::new()
+ }
+}
+
+impl<'a, S, N: 'a> fmt::Display for FmtCtx<'a, S, N>
+where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let bold = self.bold();
+ let mut seen = false;
+
+ let span = self
+ .span
+ .and_then(|id| self.ctx.ctx.span(id))
+ .or_else(|| self.ctx.ctx.lookup_current());
+
+ let scope = span.into_iter().flat_map(|span| span.scope().from_root());
+
+ for span in scope {
+ seen = true;
+ write!(f, "{}:", bold.paint(span.metadata().name()))?;
+ }
+
+ if seen {
+ f.write_char(' ')?;
+ }
+ Ok(())
+ }
+}
+
+#[cfg(not(feature = "ansi"))]
+struct Style;
+
+#[cfg(not(feature = "ansi"))]
+impl Style {
+ fn new() -> Self {
+ Style
+ }
+
+ fn bold(self) -> Self {
+ self
+ }
+
+ fn paint(&self, d: impl fmt::Display) -> impl fmt::Display {
+ d
+ }
+
+ fn prefix(&self) -> impl fmt::Display {
+ ""
+ }
+
+ fn suffix(&self) -> impl fmt::Display {
+ ""
+ }
+}
+
+struct FmtThreadName<'a> {
+ name: &'a str,
+}
+
+impl<'a> FmtThreadName<'a> {
+ pub(crate) fn new(name: &'a str) -> Self {
+ Self { name }
+ }
+}
+
+impl<'a> fmt::Display for FmtThreadName<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ use std::sync::atomic::{
+ AtomicUsize,
+ Ordering::{AcqRel, Acquire, Relaxed},
+ };
+
+ // Track the longest thread name length we've seen so far in an atomic,
+ // so that it can be updated by any thread.
+ static MAX_LEN: AtomicUsize = AtomicUsize::new(0);
+ let len = self.name.len();
+ // Snapshot the current max thread name length.
+ let mut max_len = MAX_LEN.load(Relaxed);
+
+ while len > max_len {
+ // Try to set a new max length, if it is still the value we took a
+ // snapshot of.
+ match MAX_LEN.compare_exchange(max_len, len, AcqRel, Acquire) {
+ // We successfully set the new max value
+ Ok(_) => break,
+ // Another thread set a new max value since we last observed
+ // it! It's possible that the new length is actually longer than
+ // ours, so we'll loop again and check whether our length is
+ // still the longest. If not, we'll just use the newer value.
+ Err(actual) => max_len = actual,
+ }
+ }
+
+ // pad thread name using `max_len`
+ write!(f, "{:>width$}", self.name, width = max_len)
+ }
+}
+
+struct FmtLevel<'a> {
+ level: &'a Level,
+ #[cfg(feature = "ansi")]
+ ansi: bool,
+}
+
+impl<'a> FmtLevel<'a> {
+ #[cfg(feature = "ansi")]
+ pub(crate) fn new(level: &'a Level, ansi: bool) -> Self {
+ Self { level, ansi }
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ pub(crate) fn new(level: &'a Level) -> Self {
+ Self { level }
+ }
+}
+
+const TRACE_STR: &str = "TRACE";
+const DEBUG_STR: &str = "DEBUG";
+const INFO_STR: &str = " INFO";
+const WARN_STR: &str = " WARN";
+const ERROR_STR: &str = "ERROR";
+
+#[cfg(not(feature = "ansi"))]
+impl<'a> fmt::Display for FmtLevel<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self.level {
+ Level::TRACE => f.pad(TRACE_STR),
+ Level::DEBUG => f.pad(DEBUG_STR),
+ Level::INFO => f.pad(INFO_STR),
+ Level::WARN => f.pad(WARN_STR),
+ Level::ERROR => f.pad(ERROR_STR),
+ }
+ }
+}
+
+#[cfg(feature = "ansi")]
+impl<'a> fmt::Display for FmtLevel<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if self.ansi {
+ match *self.level {
+ Level::TRACE => write!(f, "{}", Color::Purple.paint(TRACE_STR)),
+ Level::DEBUG => write!(f, "{}", Color::Blue.paint(DEBUG_STR)),
+ Level::INFO => write!(f, "{}", Color::Green.paint(INFO_STR)),
+ Level::WARN => write!(f, "{}", Color::Yellow.paint(WARN_STR)),
+ Level::ERROR => write!(f, "{}", Color::Red.paint(ERROR_STR)),
+ }
+ } else {
+ match *self.level {
+ Level::TRACE => f.pad(TRACE_STR),
+ Level::DEBUG => f.pad(DEBUG_STR),
+ Level::INFO => f.pad(INFO_STR),
+ Level::WARN => f.pad(WARN_STR),
+ Level::ERROR => f.pad(ERROR_STR),
+ }
+ }
+ }
+}
+
+// === impl FieldFn ===
+
+impl<'a, F> MakeVisitor<Writer<'a>> for FieldFn<F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result + Clone,
+{
+ type Visitor = FieldFnVisitor<'a, F>;
+
+ fn make_visitor(&self, writer: Writer<'a>) -> Self::Visitor {
+ FieldFnVisitor {
+ writer,
+ f: self.0.clone(),
+ result: Ok(()),
+ }
+ }
+}
+
+impl<'a, F> Visit for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_ok() {
+ self.result = (self.f)(&mut self.writer, field, value)
+ }
+ }
+}
+
+impl<'a, F> VisitOutput<fmt::Result> for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn finish(self) -> fmt::Result {
+ self.result
+ }
+}
+
+impl<'a, F> VisitFmt for FieldFnVisitor<'a, F>
+where
+ F: Fn(&mut Writer<'a>, &Field, &dyn fmt::Debug) -> fmt::Result,
+{
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}
+
+impl<'a, F> fmt::Debug for FieldFnVisitor<'a, F> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("FieldFnVisitor")
+ .field("f", &format_args!("{}", std::any::type_name::<F>()))
+ .field("writer", &self.writer)
+ .field("result", &self.result)
+ .finish()
+ }
+}
+
+// === printing synthetic Span events ===
+
+/// Configures what points in the span lifecycle are logged as events.
+///
+/// See also [`with_span_events`](super::SubscriberBuilder.html::with_span_events).
+#[derive(Clone, Eq, PartialEq, Ord, PartialOrd)]
+pub struct FmtSpan(u8);
+
+impl FmtSpan {
+ /// one event when span is created
+ pub const NEW: FmtSpan = FmtSpan(1 << 0);
+ /// one event per enter of a span
+ pub const ENTER: FmtSpan = FmtSpan(1 << 1);
+ /// one event per exit of a span
+ pub const EXIT: FmtSpan = FmtSpan(1 << 2);
+ /// one event when the span is dropped
+ pub const CLOSE: FmtSpan = FmtSpan(1 << 3);
+
+ /// spans are ignored (this is the default)
+ pub const NONE: FmtSpan = FmtSpan(0);
+ /// one event per enter/exit of a span
+ pub const ACTIVE: FmtSpan = FmtSpan(FmtSpan::ENTER.0 | FmtSpan::EXIT.0);
+ /// events at all points (new, enter, exit, drop)
+ pub const FULL: FmtSpan =
+ FmtSpan(FmtSpan::NEW.0 | FmtSpan::ENTER.0 | FmtSpan::EXIT.0 | FmtSpan::CLOSE.0);
+
+ /// Check whether or not a certain flag is set for this [`FmtSpan`]
+ fn contains(&self, other: FmtSpan) -> bool {
+ self.clone() & other.clone() == other
+ }
+}
+
+macro_rules! impl_fmt_span_bit_op {
+ ($trait:ident, $func:ident, $op:tt) => {
+ impl std::ops::$trait for FmtSpan {
+ type Output = FmtSpan;
+
+ fn $func(self, rhs: Self) -> Self::Output {
+ FmtSpan(self.0 $op rhs.0)
+ }
+ }
+ };
+}
+
+macro_rules! impl_fmt_span_bit_assign_op {
+ ($trait:ident, $func:ident, $op:tt) => {
+ impl std::ops::$trait for FmtSpan {
+ fn $func(&mut self, rhs: Self) {
+ *self = FmtSpan(self.0 $op rhs.0)
+ }
+ }
+ };
+}
+
+impl_fmt_span_bit_op!(BitAnd, bitand, &);
+impl_fmt_span_bit_op!(BitOr, bitor, |);
+impl_fmt_span_bit_op!(BitXor, bitxor, ^);
+
+impl_fmt_span_bit_assign_op!(BitAndAssign, bitand_assign, &);
+impl_fmt_span_bit_assign_op!(BitOrAssign, bitor_assign, |);
+impl_fmt_span_bit_assign_op!(BitXorAssign, bitxor_assign, ^);
+
+impl Debug for FmtSpan {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut wrote_flag = false;
+ let mut write_flags = |flag, flag_str| -> fmt::Result {
+ if self.contains(flag) {
+ if wrote_flag {
+ f.write_str(" | ")?;
+ }
+
+ f.write_str(flag_str)?;
+ wrote_flag = true;
+ }
+
+ Ok(())
+ };
+
+ if FmtSpan::NONE | self.clone() == FmtSpan::NONE {
+ f.write_str("FmtSpan::NONE")?;
+ } else {
+ write_flags(FmtSpan::NEW, "FmtSpan::NEW")?;
+ write_flags(FmtSpan::ENTER, "FmtSpan::ENTER")?;
+ write_flags(FmtSpan::EXIT, "FmtSpan::EXIT")?;
+ write_flags(FmtSpan::CLOSE, "FmtSpan::CLOSE")?;
+ }
+
+ Ok(())
+ }
+}
+
+pub(super) struct FmtSpanConfig {
+ pub(super) kind: FmtSpan,
+ pub(super) fmt_timing: bool,
+}
+
+impl FmtSpanConfig {
+ pub(super) fn without_time(self) -> Self {
+ Self {
+ kind: self.kind,
+ fmt_timing: false,
+ }
+ }
+ pub(super) fn with_kind(self, kind: FmtSpan) -> Self {
+ Self {
+ kind,
+ fmt_timing: self.fmt_timing,
+ }
+ }
+ pub(super) fn trace_new(&self) -> bool {
+ self.kind.contains(FmtSpan::NEW)
+ }
+ pub(super) fn trace_enter(&self) -> bool {
+ self.kind.contains(FmtSpan::ENTER)
+ }
+ pub(super) fn trace_exit(&self) -> bool {
+ self.kind.contains(FmtSpan::EXIT)
+ }
+ pub(super) fn trace_close(&self) -> bool {
+ self.kind.contains(FmtSpan::CLOSE)
+ }
+}
+
+impl Debug for FmtSpanConfig {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.kind.fmt(f)
+ }
+}
+
+impl Default for FmtSpanConfig {
+ fn default() -> Self {
+ Self {
+ kind: FmtSpan::NONE,
+ fmt_timing: true,
+ }
+ }
+}
+
+pub(super) struct TimingDisplay(pub(super) u64);
+impl Display for TimingDisplay {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut t = self.0 as f64;
+ for unit in ["ns", "µs", "ms", "s"].iter() {
+ if t < 10.0 {
+ return write!(f, "{:.2}{}", t, unit);
+ } else if t < 100.0 {
+ return write!(f, "{:.1}{}", t, unit);
+ } else if t < 1000.0 {
+ return write!(f, "{:.0}{}", t, unit);
+ }
+ t /= 1000.0;
+ }
+ write!(f, "{:.0}s", t * 1000.0)
+ }
+}
+
+#[cfg(test)]
+pub(super) mod test {
+ use crate::fmt::{test::MockMakeWriter, time::FormatTime};
+ use tracing::{
+ self,
+ dispatcher::{set_default, Dispatch},
+ subscriber::with_default,
+ };
+
+ use super::*;
+
+ use regex::Regex;
+ use std::{fmt, path::Path};
+
+ pub(crate) struct MockTime;
+ impl FormatTime for MockTime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ write!(w, "fake time")
+ }
+ }
+
+ #[test]
+ fn disable_everything() {
+ // This test reproduces https://github.com/tokio-rs/tracing/issues/1354
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .without_time()
+ .with_level(false)
+ .with_target(false)
+ .with_thread_ids(false)
+ .with_thread_names(false);
+ #[cfg(feature = "ansi")]
+ let subscriber = subscriber.with_ansi(false);
+ assert_info_hello(subscriber, make_writer, "hello\n")
+ }
+
+ fn test_ansi<T>(
+ is_ansi: bool,
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_ansi(is_ansi)
+ .with_timer(MockTime);
+ run_test(subscriber, make_writer, expected)
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ fn test_without_ansi<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder.with_writer(make_writer).with_timer(MockTime);
+ run_test(subscriber, make_writer, expected)
+ }
+
+ fn test_without_level<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ run_test(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn with_line_number_and_file_name() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_file(true)
+ .with_line_number(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+
+ let expected = Regex::new(&format!(
+ "^fake time tracing_subscriber::fmt::format::test: {}:[0-9]+: hello\n$",
+ current_path()
+ // if we're on Windows, the path might contain backslashes, which
+ // have to be escpaed before compiling the regex.
+ .replace('\\', "\\\\")
+ ))
+ .unwrap();
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let res = make_writer.get_string();
+ assert!(expected.is_match(&res));
+ }
+
+ #[test]
+ fn with_line_number() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_line_number(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+
+ let expected =
+ Regex::new("^fake time tracing_subscriber::fmt::format::test: [0-9]+: hello\n$")
+ .unwrap();
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let res = make_writer.get_string();
+ assert!(expected.is_match(&res));
+ }
+
+ #[test]
+ fn with_filename() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_file(true)
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = &format!(
+ "fake time tracing_subscriber::fmt::format::test: {}: hello\n",
+ current_path(),
+ );
+ assert_info_hello(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn with_thread_ids() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_thread_ids(true)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected =
+ "fake time INFO ThreadId(NUMERIC) tracing_subscriber::fmt::format::test: hello\n";
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, expected);
+ }
+
+ #[test]
+ fn pretty_default() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .pretty()
+ .with_writer(make_writer.clone())
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = format!(
+ r#" fake time INFO tracing_subscriber::fmt::format::test: hello
+ at {}:NUMERIC
+
+"#,
+ file!()
+ );
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, &expected)
+ }
+
+ fn assert_info_hello(subscriber: impl Into<Dispatch>, buf: MockMakeWriter, expected: &str) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ let result = buf.get_string();
+
+ assert_eq!(expected, result)
+ }
+
+ // When numeric characters are used they often form a non-deterministic value as they usually represent things like a thread id or line number.
+ // This assert method should be used when non-deterministic numeric characters are present.
+ fn assert_info_hello_ignore_numeric(
+ subscriber: impl Into<Dispatch>,
+ buf: MockMakeWriter,
+ expected: &str,
+ ) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+
+ let regex = Regex::new("[0-9]+").unwrap();
+ let result = buf.get_string();
+ let result_cleaned = regex.replace_all(&result, "NUMERIC");
+
+ assert_eq!(expected, result_cleaned)
+ }
+
+ fn test_overridden_parents<T>(
+ expected: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", span = 1);
+ let span2 = tracing::info_span!(parent: &span1, "span2", span = 2);
+ tracing::info!(parent: &span2, "hello");
+ });
+ assert_eq!(expected, make_writer.get_string());
+ }
+
+ fn test_overridden_parents_in_scope<T>(
+ expected1: &str,
+ expected2: &str,
+ builder: crate::fmt::SubscriberBuilder<DefaultFields, Format<T>>,
+ ) where
+ Format<T, MockTime>: FormatEvent<crate::Registry, DefaultFields>,
+ T: Send + Sync + 'static,
+ {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = builder
+ .with_writer(make_writer.clone())
+ .with_level(false)
+ .with_ansi(false)
+ .with_timer(MockTime)
+ .finish();
+
+ with_default(subscriber, || {
+ let span1 = tracing::info_span!("span1", span = 1);
+ let span2 = tracing::info_span!(parent: &span1, "span2", span = 2);
+ let span3 = tracing::info_span!("span3", span = 3);
+ let _e3 = span3.enter();
+
+ tracing::info!("hello");
+ assert_eq!(expected1, make_writer.get_string().as_str());
+
+ tracing::info!(parent: &span2, "hello");
+ assert_eq!(expected2, make_writer.get_string().as_str());
+ });
+ }
+
+ fn run_test(subscriber: impl Into<Dispatch>, buf: MockMakeWriter, expected: &str) {
+ let _default = set_default(&subscriber.into());
+ tracing::info!("hello");
+ assert_eq!(expected, buf.get_string())
+ }
+
+ mod default {
+ use super::*;
+
+ #[test]
+ fn with_thread_ids() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .with_writer(make_writer.clone())
+ .with_thread_ids(true)
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected =
+ "fake time INFO ThreadId(NUMERIC) tracing_subscriber::fmt::format::test: hello\n";
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, expected);
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_true() {
+ let expected = "\u{1b}[2mfake time\u{1b}[0m \u{1b}[32m INFO\u{1b}[0m \u{1b}[2mtracing_subscriber::fmt::format::test\u{1b}[0m\u{1b}[2m:\u{1b}[0m hello\n";
+ test_ansi(true, expected, crate::fmt::Subscriber::builder());
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_false() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_ansi(false, expected, crate::fmt::Subscriber::builder());
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ #[test]
+ fn without_ansi() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_without_ansi(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn without_level() {
+ let expected = "fake time tracing_subscriber::fmt::format::test: hello\n";
+ test_without_level(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn overridden_parents() {
+ let expected = "fake time span1{span=1}:span2{span=2}: tracing_subscriber::fmt::format::test: hello\n";
+ test_overridden_parents(expected, crate::fmt::Subscriber::builder())
+ }
+
+ #[test]
+ fn overridden_parents_in_scope() {
+ test_overridden_parents_in_scope(
+ "fake time span3{span=3}: tracing_subscriber::fmt::format::test: hello\n",
+ "fake time span1{span=1}:span2{span=2}: tracing_subscriber::fmt::format::test: hello\n",
+ crate::fmt::Subscriber::builder(),
+ )
+ }
+ }
+
+ mod compact {
+ use super::*;
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_true() {
+ let expected = "\u{1b}[2mfake time\u{1b}[0m \u{1b}[32m INFO\u{1b}[0m \u{1b}[2mtracing_subscriber::fmt::format::test\u{1b}[0m\u{1b}[2m:\u{1b}[0m hello\n";
+ test_ansi(true, expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[cfg(feature = "ansi")]
+ #[test]
+ fn with_ansi_false() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_ansi(false, expected, crate::fmt::Subscriber::builder().compact());
+ }
+
+ #[cfg(not(feature = "ansi"))]
+ #[test]
+ fn without_ansi() {
+ let expected = "fake time INFO tracing_subscriber::fmt::format::test: hello\n";
+ test_without_ansi(expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[test]
+ fn without_level() {
+ let expected = "fake time tracing_subscriber::fmt::format::test: hello\n";
+ test_without_level(expected, crate::fmt::Subscriber::builder().compact());
+ }
+
+ #[test]
+ fn overridden_parents() {
+ let expected = "fake time span1:span2: tracing_subscriber::fmt::format::test: hello span=1 span=2\n";
+ test_overridden_parents(expected, crate::fmt::Subscriber::builder().compact())
+ }
+
+ #[test]
+ fn overridden_parents_in_scope() {
+ test_overridden_parents_in_scope(
+ "fake time span3: tracing_subscriber::fmt::format::test: hello span=3\n",
+ "fake time span1:span2: tracing_subscriber::fmt::format::test: hello span=1 span=2\n",
+ crate::fmt::Subscriber::builder().compact(),
+ )
+ }
+ }
+
+ mod pretty {
+ use super::*;
+
+ #[test]
+ fn pretty_default() {
+ let make_writer = MockMakeWriter::default();
+ let subscriber = crate::fmt::Subscriber::builder()
+ .pretty()
+ .with_writer(make_writer.clone())
+ .with_ansi(false)
+ .with_timer(MockTime);
+ let expected = format!(
+ " fake time INFO tracing_subscriber::fmt::format::test: hello\n at {}:NUMERIC\n\n",
+ file!()
+ );
+
+ assert_info_hello_ignore_numeric(subscriber, make_writer, &expected)
+ }
+ }
+
+ #[test]
+ fn format_nanos() {
+ fn fmt(t: u64) -> String {
+ TimingDisplay(t).to_string()
+ }
+
+ assert_eq!(fmt(1), "1.00ns");
+ assert_eq!(fmt(12), "12.0ns");
+ assert_eq!(fmt(123), "123ns");
+ assert_eq!(fmt(1234), "1.23µs");
+ assert_eq!(fmt(12345), "12.3µs");
+ assert_eq!(fmt(123456), "123µs");
+ assert_eq!(fmt(1234567), "1.23ms");
+ assert_eq!(fmt(12345678), "12.3ms");
+ assert_eq!(fmt(123456789), "123ms");
+ assert_eq!(fmt(1234567890), "1.23s");
+ assert_eq!(fmt(12345678901), "12.3s");
+ assert_eq!(fmt(123456789012), "123s");
+ assert_eq!(fmt(1234567890123), "1235s");
+ }
+
+ #[test]
+ fn fmt_span_combinations() {
+ let f = FmtSpan::NONE;
+ assert!(!f.contains(FmtSpan::NEW));
+ assert!(!f.contains(FmtSpan::ENTER));
+ assert!(!f.contains(FmtSpan::EXIT));
+ assert!(!f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::ACTIVE;
+ assert!(!f.contains(FmtSpan::NEW));
+ assert!(f.contains(FmtSpan::ENTER));
+ assert!(f.contains(FmtSpan::EXIT));
+ assert!(!f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::FULL;
+ assert!(f.contains(FmtSpan::NEW));
+ assert!(f.contains(FmtSpan::ENTER));
+ assert!(f.contains(FmtSpan::EXIT));
+ assert!(f.contains(FmtSpan::CLOSE));
+
+ let f = FmtSpan::NEW | FmtSpan::CLOSE;
+ assert!(f.contains(FmtSpan::NEW));
+ assert!(!f.contains(FmtSpan::ENTER));
+ assert!(!f.contains(FmtSpan::EXIT));
+ assert!(f.contains(FmtSpan::CLOSE));
+ }
+
+ /// Returns the test's module path.
+ fn current_path() -> String {
+ Path::new("tracing-subscriber")
+ .join("src")
+ .join("fmt")
+ .join("format")
+ .join("mod.rs")
+ .to_str()
+ .expect("path must not contain invalid unicode")
+ .to_owned()
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/format/pretty.rs b/crates/tracing-subscriber/src/fmt/format/pretty.rs
new file mode 100644
index 0000000..12071de
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/format/pretty.rs
@@ -0,0 +1,511 @@
+use super::*;
+use crate::{
+ field::{VisitFmt, VisitOutput},
+ fmt::fmt_layer::{FmtContext, FormattedFields},
+ registry::LookupSpan,
+};
+
+use std::fmt;
+use tracing_core::{
+ field::{self, Field},
+ Event, Level, Subscriber,
+};
+
+#[cfg(feature = "tracing-log")]
+use tracing_log::NormalizeEvent;
+
+use nu_ansi_term::{Color, Style};
+
+/// An excessively pretty, human-readable event formatter.
+///
+/// Unlike the [`Full`], [`Compact`], and [`Json`] formatters, this is a
+/// multi-line output format. Each individual event may output multiple lines of
+/// text.
+///
+/// # Example Output
+///
+/// <pre><font color="#4E9A06"><b>:;</b></font> <font color="#4E9A06">cargo</font> run --example fmt-pretty
+/// <font color="#4E9A06"><b> Finished</b></font> dev [unoptimized + debuginfo] target(s) in 0.08s
+/// <font color="#4E9A06"><b> Running</b></font> `target/debug/examples/fmt-pretty`
+/// 2022-02-15T18:44:24.535324Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty</b></font><font color="#4E9A06">: preparing to shave yaks, </font><font color="#4E9A06"><b>number_of_yaks</b></font><font color="#4E9A06">: 3</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt-pretty.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+///
+/// 2022-02-15T18:44:24.535403Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty::yak_shave</b></font><font color="#4E9A06">: shaving yaks</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:41 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535442Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I'm gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: "yay!"</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 1
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535469Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: yak shaved successfully</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:25 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 1
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535502Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 1, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: true</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535524Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 1</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535551Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I'm gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: "yay!"</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 2
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535573Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: yak shaved successfully</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:25 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 2
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535600Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 2, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: true</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535618Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 2</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535644Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: hello! I'm gonna shave a yak, </font><font color="#75507B"><b>excitement</b></font><font color="#75507B">: "yay!"</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:16 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 3
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535670Z <font color="#C4A000"> WARN</font> <font color="#C4A000"><b>fmt_pretty::yak_shave</b></font><font color="#C4A000">: could not locate yak</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:18 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shave</b> <font color="#AAAAAA"><i>with</i></font> <b>yak</b>: 3
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535698Z <font color="#3465A4">DEBUG</font> <font color="#3465A4"><b>yak_events</b></font><font color="#3465A4">: </font><font color="#3465A4"><b>yak</b></font><font color="#3465A4">: 3, </font><font color="#3465A4"><b>shaved</b></font><font color="#3465A4">: false</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:46 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535720Z <font color="#CC0000">ERROR</font> <font color="#CC0000"><b>fmt_pretty::yak_shave</b></font><font color="#CC0000">: failed to shave yak, </font><font color="#CC0000"><b>yak</b></font><font color="#CC0000">: 3, </font><font color="#CC0000"><b>error</b></font><font color="#CC0000">: missing yak, </font><font color="#CC0000"><b>error.sources</b></font><font color="#CC0000">: [out of space, out of cash]</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:51 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535742Z <font color="#75507B">TRACE</font> <font color="#75507B"><b>fmt_pretty::yak_shave</b></font><font color="#75507B">: </font><font color="#75507B"><b>yaks_shaved</b></font><font color="#75507B">: 2</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt/yak_shave.rs:55 <font color="#AAAAAA"><i>on</i></font> main
+/// <font color="#AAAAAA"><i>in</i></font> fmt_pretty::yak_shave::<b>shaving_yaks</b> <font color="#AAAAAA"><i>with</i></font> <b>yaks</b>: 3
+///
+/// 2022-02-15T18:44:24.535765Z <font color="#4E9A06"> INFO</font> <font color="#4E9A06"><b>fmt_pretty</b></font><font color="#4E9A06">: yak shaving completed, </font><font color="#4E9A06"><b>all_yaks_shaved</b></font><font color="#4E9A06">: false</font>
+/// <font color="#AAAAAA"><i>at</i></font> examples/examples/fmt-pretty.rs:19 <font color="#AAAAAA"><i>on</i></font> main
+/// </pre>
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct Pretty {
+ display_location: bool,
+}
+
+/// The [visitor] produced by [`Pretty`]'s [`MakeVisitor`] implementation.
+///
+/// [visitor]: field::Visit
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+#[derive(Debug)]
+pub struct PrettyVisitor<'a> {
+ writer: Writer<'a>,
+ is_empty: bool,
+ style: Style,
+ result: fmt::Result,
+}
+
+/// An excessively pretty, human-readable [`MakeVisitor`] implementation.
+///
+/// [`MakeVisitor`]: crate::field::MakeVisitor
+#[derive(Debug)]
+pub struct PrettyFields {
+ /// A value to override the provided `Writer`'s ANSI formatting
+ /// configuration.
+ ///
+ /// If this is `Some`, we override the `Writer`'s ANSI setting. This is
+ /// necessary in order to continue supporting the deprecated
+ /// `PrettyFields::with_ansi` method. If it is `None`, we don't override the
+ /// ANSI formatting configuration (because the deprecated method was not
+ /// called).
+ // TODO: when `PrettyFields::with_ansi` is removed, we can get rid
+ // of this entirely.
+ ansi: Option<bool>,
+}
+
+// === impl Pretty ===
+
+impl Default for Pretty {
+ fn default() -> Self {
+ Self {
+ display_location: true,
+ }
+ }
+}
+
+impl Pretty {
+ fn style_for(level: &Level) -> Style {
+ match *level {
+ Level::TRACE => Style::new().fg(Color::Purple),
+ Level::DEBUG => Style::new().fg(Color::Blue),
+ Level::INFO => Style::new().fg(Color::Green),
+ Level::WARN => Style::new().fg(Color::Yellow),
+ Level::ERROR => Style::new().fg(Color::Red),
+ }
+ }
+
+ /// Sets whether the event's source code location is displayed.
+ ///
+ /// This defaults to `true`.
+ #[deprecated(
+ since = "0.3.6",
+ note = "all formatters now support configurable source locations. Use `Format::with_source_location` instead."
+ )]
+ pub fn with_source_location(self, display_location: bool) -> Self {
+ Self {
+ display_location,
+ ..self
+ }
+ }
+}
+
+impl<C, N, T> FormatEvent<C, N> for Format<Pretty, T>
+where
+ C: Subscriber + for<'a> LookupSpan<'a>,
+ N: for<'a> FormatFields<'a> + 'static,
+ T: FormatTime,
+{
+ fn format_event(
+ &self,
+ ctx: &FmtContext<'_, C, N>,
+ mut writer: Writer<'_>,
+ event: &Event<'_>,
+ ) -> fmt::Result {
+ #[cfg(feature = "tracing-log")]
+ let normalized_meta = event.normalized_metadata();
+ #[cfg(feature = "tracing-log")]
+ let meta = normalized_meta.as_ref().unwrap_or_else(|| event.metadata());
+ #[cfg(not(feature = "tracing-log"))]
+ let meta = event.metadata();
+ write!(&mut writer, " ")?;
+
+ // if the `Format` struct *also* has an ANSI color configuration,
+ // override the writer...the API for configuring ANSI color codes on the
+ // `Format` struct is deprecated, but we still need to honor those
+ // configurations.
+ if let Some(ansi) = self.ansi {
+ writer = writer.with_ansi(ansi);
+ }
+
+ self.format_timestamp(&mut writer)?;
+
+ let style = if self.display_level && writer.has_ansi_escapes() {
+ Pretty::style_for(meta.level())
+ } else {
+ Style::new()
+ };
+
+ if self.display_level {
+ write!(
+ writer,
+ "{} ",
+ super::FmtLevel::new(meta.level(), writer.has_ansi_escapes())
+ )?;
+ }
+
+ if self.display_target {
+ let target_style = if writer.has_ansi_escapes() {
+ style.bold()
+ } else {
+ style
+ };
+ write!(
+ writer,
+ "{}{}{}:",
+ target_style.prefix(),
+ meta.target(),
+ target_style.infix(style)
+ )?;
+ }
+ let line_number = if self.display_line_number {
+ meta.line()
+ } else {
+ None
+ };
+
+ // If the file name is disabled, format the line number right after the
+ // target. Otherwise, if we also display the file, it'll go on a
+ // separate line.
+ if let (Some(line_number), false, true) = (
+ line_number,
+ self.display_filename,
+ self.format.display_location,
+ ) {
+ write!(
+ writer,
+ "{}{}{}:",
+ style.prefix(),
+ line_number,
+ style.infix(style)
+ )?;
+ }
+
+ writer.write_char(' ')?;
+
+ let mut v = PrettyVisitor::new(writer.by_ref(), true).with_style(style);
+ event.record(&mut v);
+ v.finish()?;
+ writer.write_char('\n')?;
+
+ let dimmed = if writer.has_ansi_escapes() {
+ Style::new().dimmed().italic()
+ } else {
+ Style::new()
+ };
+ let thread = self.display_thread_name || self.display_thread_id;
+
+ if let (Some(file), true, true) = (
+ meta.file(),
+ self.format.display_location,
+ self.display_filename,
+ ) {
+ write!(writer, " {} {}", dimmed.paint("at"), file,)?;
+
+ if let Some(line) = line_number {
+ write!(writer, ":{}", line)?;
+ }
+ writer.write_char(if thread { ' ' } else { '\n' })?;
+ } else if thread {
+ write!(writer, " ")?;
+ };
+
+ if thread {
+ write!(writer, "{} ", dimmed.paint("on"))?;
+ let thread = std::thread::current();
+ if self.display_thread_name {
+ if let Some(name) = thread.name() {
+ write!(writer, "{}", name)?;
+ if self.display_thread_id {
+ writer.write_char(' ')?;
+ }
+ }
+ }
+ if self.display_thread_id {
+ write!(writer, "{:?}", thread.id())?;
+ }
+ writer.write_char('\n')?;
+ }
+
+ let bold = writer.bold();
+ let span = event
+ .parent()
+ .and_then(|id| ctx.span(id))
+ .or_else(|| ctx.lookup_current());
+
+ let scope = span.into_iter().flat_map(|span| span.scope());
+
+ for span in scope {
+ let meta = span.metadata();
+ if self.display_target {
+ write!(
+ writer,
+ " {} {}::{}",
+ dimmed.paint("in"),
+ meta.target(),
+ bold.paint(meta.name()),
+ )?;
+ } else {
+ write!(
+ writer,
+ " {} {}",
+ dimmed.paint("in"),
+ bold.paint(meta.name()),
+ )?;
+ }
+
+ let ext = span.extensions();
+ let fields = &ext
+ .get::<FormattedFields<N>>()
+ .expect("Unable to find FormattedFields in extensions; this is a bug");
+ if !fields.is_empty() {
+ write!(writer, " {} {}", dimmed.paint("with"), fields)?;
+ }
+ writer.write_char('\n')?;
+ }
+
+ writer.write_char('\n')
+ }
+}
+
+impl<'writer> FormatFields<'writer> for Pretty {
+ fn format_fields<R: RecordFields>(&self, writer: Writer<'writer>, fields: R) -> fmt::Result {
+ let mut v = PrettyVisitor::new(writer, true);
+ fields.record(&mut v);
+ v.finish()
+ }
+
+ fn add_fields(
+ &self,
+ current: &'writer mut FormattedFields<Self>,
+ fields: &span::Record<'_>,
+ ) -> fmt::Result {
+ let empty = current.is_empty();
+ let writer = current.as_writer();
+ let mut v = PrettyVisitor::new(writer, empty);
+ fields.record(&mut v);
+ v.finish()
+ }
+}
+
+// === impl PrettyFields ===
+
+impl Default for PrettyFields {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl PrettyFields {
+ /// Returns a new default [`PrettyFields`] implementation.
+ pub fn new() -> Self {
+ // By default, don't override the `Writer`'s ANSI colors
+ // configuration. We'll only do this if the user calls the
+ // deprecated `PrettyFields::with_ansi` method.
+ Self { ansi: None }
+ }
+
+ /// Enable ANSI encoding for formatted fields.
+ #[deprecated(
+ since = "0.3.3",
+ note = "Use `fmt::Subscriber::with_ansi` or `fmt::Layer::with_ansi` instead."
+ )]
+ pub fn with_ansi(self, ansi: bool) -> Self {
+ Self {
+ ansi: Some(ansi),
+ ..self
+ }
+ }
+}
+
+impl<'a> MakeVisitor<Writer<'a>> for PrettyFields {
+ type Visitor = PrettyVisitor<'a>;
+
+ #[inline]
+ fn make_visitor(&self, mut target: Writer<'a>) -> Self::Visitor {
+ if let Some(ansi) = self.ansi {
+ target = target.with_ansi(ansi);
+ }
+ PrettyVisitor::new(target, true)
+ }
+}
+
+// === impl PrettyVisitor ===
+
+impl<'a> PrettyVisitor<'a> {
+ /// Returns a new default visitor that formats to the provided `writer`.
+ ///
+ /// # Arguments
+ /// - `writer`: the writer to format to.
+ /// - `is_empty`: whether or not any fields have been previously written to
+ /// that writer.
+ pub fn new(writer: Writer<'a>, is_empty: bool) -> Self {
+ Self {
+ writer,
+ is_empty,
+ style: Style::default(),
+ result: Ok(()),
+ }
+ }
+
+ pub(crate) fn with_style(self, style: Style) -> Self {
+ Self { style, ..self }
+ }
+
+ fn write_padded(&mut self, value: &impl fmt::Debug) {
+ let padding = if self.is_empty {
+ self.is_empty = false;
+ ""
+ } else {
+ ", "
+ };
+ self.result = write!(self.writer, "{}{:?}", padding, value);
+ }
+
+ fn bold(&self) -> Style {
+ if self.writer.has_ansi_escapes() {
+ self.style.bold()
+ } else {
+ Style::new()
+ }
+ }
+}
+
+impl<'a> field::Visit for PrettyVisitor<'a> {
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if self.result.is_err() {
+ return;
+ }
+
+ if field.name() == "message" {
+ self.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.record_debug(field, &value)
+ }
+ }
+
+ fn record_error(&mut self, field: &Field, value: &(dyn std::error::Error + 'static)) {
+ if let Some(source) = value.source() {
+ let bold = self.bold();
+ self.record_debug(
+ field,
+ &format_args!(
+ "{}, {}{}.sources{}: {}",
+ value,
+ bold.prefix(),
+ field,
+ bold.infix(self.style),
+ ErrorSourceList(source),
+ ),
+ )
+ } else {
+ self.record_debug(field, &format_args!("{}", value))
+ }
+ }
+
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ if self.result.is_err() {
+ return;
+ }
+ let bold = self.bold();
+ match field.name() {
+ "message" => self.write_padded(&format_args!("{}{:?}", self.style.prefix(), value,)),
+ // Skip fields that are actually log metadata that have already been handled
+ #[cfg(feature = "tracing-log")]
+ name if name.starts_with("log.") => self.result = Ok(()),
+ name if name.starts_with("r#") => self.write_padded(&format_args!(
+ "{}{}{}: {:?}",
+ bold.prefix(),
+ &name[2..],
+ bold.infix(self.style),
+ value
+ )),
+ name => self.write_padded(&format_args!(
+ "{}{}{}: {:?}",
+ bold.prefix(),
+ name,
+ bold.infix(self.style),
+ value
+ )),
+ };
+ }
+}
+
+impl<'a> VisitOutput<fmt::Result> for PrettyVisitor<'a> {
+ fn finish(mut self) -> fmt::Result {
+ write!(&mut self.writer, "{}", self.style.suffix())?;
+ self.result
+ }
+}
+
+impl<'a> VisitFmt for PrettyVisitor<'a> {
+ fn writer(&mut self) -> &mut dyn fmt::Write {
+ &mut self.writer
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/mod.rs b/crates/tracing-subscriber/src/fmt/mod.rs
new file mode 100644
index 0000000..3762164
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/mod.rs
@@ -0,0 +1,1370 @@
+//! A `Subscriber` for formatting and logging `tracing` data.
+//!
+//! # Overview
+//!
+//! [`tracing`] is a framework for instrumenting Rust programs with context-aware,
+//! structured, event-based diagnostic information. This crate provides an
+//! implementation of the [`Subscriber`] trait that records `tracing`'s `Event`s
+//! and `Span`s by formatting them as text and logging them to stdout.
+//!
+//! # Usage
+//!
+//! First, add this to your `Cargo.toml` file:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing-subscriber = "0.3"
+//! ```
+//!
+//! *Compiler support: [requires `rustc` 1.63+][msrv]*
+//!
+//! [msrv]: super#supported-rust-versions
+//!
+//! Add the following to your executable to initialize the default subscriber:
+//! ```rust
+//! use tracing_subscriber;
+//!
+//! tracing_subscriber::fmt::init();
+//! ```
+//!
+//! ## Filtering Events with Environment Variables
+//!
+//! The default subscriber installed by `init` enables you to filter events
+//! at runtime using environment variables (using the [`EnvFilter`]).
+//!
+//! The filter syntax is a superset of the [`env_logger`] syntax.
+//!
+//! For example:
+//! - Setting `RUST_LOG=debug` enables all `Span`s and `Event`s
+//! set to the log level `DEBUG` or higher
+//! - Setting `RUST_LOG=my_crate=trace` enables `Span`s and `Event`s
+//! in `my_crate` at all log levels
+//!
+//! **Note**: This should **not** be called by libraries. Libraries should use
+//! [`tracing`] to publish `tracing` `Event`s.
+//!
+//! # Configuration
+//!
+//! You can configure a subscriber instead of using the defaults with
+//! the following functions:
+//!
+//! ### Subscriber
+//!
+//! The [`FmtSubscriber`] formats and records `tracing` events as line-oriented logs.
+//! You can create one by calling:
+//!
+//! ```rust
+//! let subscriber = tracing_subscriber::fmt()
+//! // ... add configuration
+//! .finish();
+//! ```
+//!
+//! You can find the configuration methods for [`FmtSubscriber`] in
+//! [`SubscriberBuilder`].
+//!
+//! ## Formatters
+//!
+//! The output format used by the layer and subscriber in this module is
+//! represented by implementing the [`FormatEvent`] trait, and can be
+//! customized. This module provides a number of formatter implementations:
+//!
+//! * [`format::Full`]: The default formatter. This emits human-readable,
+//! single-line logs for each event that occurs, with the current span context
+//! displayed before the formatted representation of the event. See
+//! [here](format::Full#example-output) for sample output.
+//!
+//! * [`format::Compact`]: A variant of the default formatter, optimized for
+//! short line lengths. Fields from the current span context are appended to
+//! the fields of the formatted event. See
+//! [here](format::Compact#example-output) for sample output.
+//!
+//! * [`format::Pretty`]: Emits excessively pretty, multi-line logs, optimized
+//! for human readability. This is primarily intended to be used in local
+//! development and debugging, or for command-line applications, where
+//! automated analysis and compact storage of logs is less of a priority than
+//! readability and visual appeal. See [here](format::Pretty#example-output)
+//! for sample output.
+//!
+//! * [`format::Json`]: Outputs newline-delimited JSON logs. This is intended
+//! for production use with systems where structured logs are consumed as JSON
+//! by analysis and viewing tools. The JSON output is not optimized for human
+//! readability. See [here](format::Json#example-output) for sample output.
+//!
+//! ### Customizing Formatters
+//!
+//! The formatting of log lines for spans and events is controlled by two
+//! traits, [`FormatEvent`] and [`FormatFields`]. The [`FormatEvent`] trait
+//! determines the overall formatting of the log line, such as what information
+//! from the event's metadata and span context is included and in what order.
+//! The [`FormatFields`] trait determines how fields — both the event's
+//! fields and fields on spans — are formatted.
+//!
+//! The [`fmt::format`] module provides several types which implement these traits,
+//! many of which expose additional configuration options to customize their
+//! output. The [`format::Format`] type implements common configuration used by
+//! all the formatters provided in this crate, and can be used as a builder to
+//! set specific formatting settings. For example:
+//!
+//! ```
+//! use tracing_subscriber::fmt;
+//!
+//! // Configure a custom event formatter
+//! let format = fmt::format()
+//! .with_level(false) // don't include levels in formatted output
+//! .with_target(false) // don't include targets
+//! .with_thread_ids(true) // include the thread ID of the current thread
+//! .with_thread_names(true) // include the name of the current thread
+//! .compact(); // use the `Compact` formatting style.
+//!
+//! // Create a `fmt` subscriber that uses our custom event format, and set it
+//! // as the default.
+//! tracing_subscriber::fmt()
+//! .event_format(format)
+//! .init();
+//! ```
+//!
+//! However, if a specific output format is needed, other crates can
+//! also implement [`FormatEvent`] and [`FormatFields`]. See those traits'
+//! documentation for details on how to implement them.
+//!
+//! ## Filters
+//!
+//! If you want to filter the `tracing` `Events` based on environment
+//! variables, you can use the [`EnvFilter`] as follows:
+//!
+//! ```rust
+//! use tracing_subscriber::EnvFilter;
+//!
+//! let filter = EnvFilter::from_default_env();
+//! ```
+//!
+//! As mentioned above, the [`EnvFilter`] allows `Span`s and `Event`s to
+//! be filtered at runtime by setting the `RUST_LOG` environment variable.
+//!
+//! You can find the other available [`filter`]s in the documentation.
+//!
+//! ### Using Your Subscriber
+//!
+//! Finally, once you have configured your `Subscriber`, you need to
+//! configure your executable to use it.
+//!
+//! A subscriber can be installed globally using:
+//! ```rust
+//! use tracing;
+//! use tracing_subscriber::FmtSubscriber;
+//!
+//! let subscriber = FmtSubscriber::new();
+//!
+//! tracing::subscriber::set_global_default(subscriber)
+//! .map_err(|_err| eprintln!("Unable to set global default subscriber"));
+//! // Note this will only fail if you try to set the global default
+//! // subscriber multiple times
+//! ```
+//!
+//! ### Composing Layers
+//!
+//! Composing an [`EnvFilter`] `Layer` and a [format `Layer`][super::fmt::Layer]:
+//!
+//! ```rust
+//! use tracing_subscriber::{fmt, EnvFilter};
+//! use tracing_subscriber::prelude::*;
+//!
+//! let fmt_layer = fmt::layer()
+//! .with_target(false);
+//! let filter_layer = EnvFilter::try_from_default_env()
+//! .or_else(|_| EnvFilter::try_new("info"))
+//! .unwrap();
+//!
+//! tracing_subscriber::registry()
+//! .with(filter_layer)
+//! .with(fmt_layer)
+//! .init();
+//! ```
+//!
+//! [`EnvFilter`]: super::filter::EnvFilter
+//! [`env_logger`]: https://docs.rs/env_logger/
+//! [`filter`]: super::filter
+//! [`FmtSubscriber`]: Subscriber
+//! [`Subscriber`]:
+//! https://docs.rs/tracing/latest/tracing/trait.Subscriber.html
+//! [`tracing`]: https://crates.io/crates/tracing
+//! [`fmt::format`]: mod@crate::fmt::format
+use std::{any::TypeId, error::Error, io};
+use tracing_core::{span, subscriber::Interest, Event, Metadata};
+
+mod fmt_layer;
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub mod format;
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub mod time;
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub mod writer;
+
+pub use fmt_layer::{FmtContext, FormattedFields, Layer};
+
+use crate::layer::Layer as _;
+use crate::util::SubscriberInitExt;
+use crate::{
+ filter::LevelFilter,
+ layer,
+ registry::{LookupSpan, Registry},
+};
+
+#[doc(inline)]
+pub use self::{
+ format::{format, FormatEvent, FormatFields},
+ time::time,
+ writer::{MakeWriter, TestWriter},
+};
+
+/// A `Subscriber` that logs formatted representations of `tracing` events.
+///
+/// This consists of an inner `Formatter` wrapped in a layer that performs filtering.
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+#[derive(Debug)]
+pub struct Subscriber<
+ N = format::DefaultFields,
+ E = format::Format<format::Full>,
+ F = LevelFilter,
+ W = fn() -> io::Stdout,
+> {
+ inner: layer::Layered<F, Formatter<N, E, W>>,
+}
+
+/// A `Subscriber` that logs formatted representations of `tracing` events.
+/// This type only logs formatted events; it does not perform any filtering.
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub type Formatter<
+ N = format::DefaultFields,
+ E = format::Format<format::Full>,
+ W = fn() -> io::Stdout,
+> = layer::Layered<fmt_layer::Layer<Registry, N, E, W>, Registry>;
+
+/// Configures and constructs `Subscriber`s.
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+#[derive(Debug)]
+#[must_use]
+pub struct SubscriberBuilder<
+ N = format::DefaultFields,
+ E = format::Format<format::Full>,
+ F = LevelFilter,
+ W = fn() -> io::Stdout,
+> {
+ filter: F,
+ inner: Layer<Registry, N, E, W>,
+}
+
+/// Returns a new [`SubscriberBuilder`] for configuring a [formatting subscriber].
+///
+/// This is essentially shorthand for [`SubscriberBuilder::default()]`.
+///
+/// # Examples
+///
+/// Using [`init`] to set the default subscriber:
+///
+/// ```rust
+/// tracing_subscriber::fmt().init();
+/// ```
+///
+/// Configuring the output format:
+///
+/// ```rust
+///
+/// tracing_subscriber::fmt()
+/// // Configure formatting settings.
+/// .with_target(false)
+/// .with_timer(tracing_subscriber::fmt::time::uptime())
+/// .with_level(true)
+/// // Set the subscriber as the default.
+/// .init();
+/// ```
+///
+/// [`try_init`] returns an error if the default subscriber could not be set:
+///
+/// ```rust
+/// use std::error::Error;
+///
+/// fn init_subscriber() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
+/// tracing_subscriber::fmt()
+/// // Configure the subscriber to emit logs in JSON format.
+/// .json()
+/// // Configure the subscriber to flatten event fields in the output JSON objects.
+/// .flatten_event(true)
+/// // Set the subscriber as the default, returning an error if this fails.
+/// .try_init()?;
+///
+/// Ok(())
+/// }
+/// ```
+///
+/// Rather than setting the subscriber as the default, [`finish`] _returns_ the
+/// constructed subscriber, which may then be passed to other functions:
+///
+/// ```rust
+/// let subscriber = tracing_subscriber::fmt()
+/// .with_max_level(tracing::Level::DEBUG)
+/// .compact()
+/// .finish();
+///
+/// tracing::subscriber::with_default(subscriber, || {
+/// // the subscriber will only be set as the default
+/// // inside this closure...
+/// })
+/// ```
+///
+/// [formatting subscriber]: Subscriber
+/// [`SubscriberBuilder::default()`]: SubscriberBuilder::default
+/// [`init`]: SubscriberBuilder::init()
+/// [`try_init`]: SubscriberBuilder::try_init()
+/// [`finish`]: SubscriberBuilder::finish()
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub fn fmt() -> SubscriberBuilder {
+ SubscriberBuilder::default()
+}
+
+/// Returns a new [formatting layer] that can be [composed] with other layers to
+/// construct a [`Subscriber`].
+///
+/// This is a shorthand for the equivalent [`Layer::default()`] function.
+///
+/// [formatting layer]: Layer
+/// [composed]: crate::layer
+/// [`Layer::default()`]: Layer::default
+#[cfg_attr(docsrs, doc(cfg(all(feature = "fmt", feature = "std"))))]
+pub fn layer<S>() -> Layer<S> {
+ Layer::default()
+}
+
+impl Subscriber {
+ /// The maximum [verbosity level] that is enabled by a `Subscriber` by
+ /// default.
+ ///
+ /// This can be overridden with the [`SubscriberBuilder::with_max_level`] method.
+ ///
+ /// [verbosity level]: tracing_core::Level
+ /// [`SubscriberBuilder::with_max_level`]: SubscriberBuilder::with_max_level
+ pub const DEFAULT_MAX_LEVEL: LevelFilter = LevelFilter::INFO;
+
+ /// Returns a new `SubscriberBuilder` for configuring a format subscriber.
+ pub fn builder() -> SubscriberBuilder {
+ SubscriberBuilder::default()
+ }
+
+ /// Returns a new format subscriber with the default configuration.
+ pub fn new() -> Self {
+ Default::default()
+ }
+}
+
+impl Default for Subscriber {
+ fn default() -> Self {
+ SubscriberBuilder::default().finish()
+ }
+}
+
+// === impl Subscriber ===
+
+impl<N, E, F, W> tracing_core::Subscriber for Subscriber<N, E, F, W>
+where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ E: FormatEvent<Registry, N> + 'static,
+ F: layer::Layer<Formatter<N, E, W>> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+ layer::Layered<F, Formatter<N, E, W>>: tracing_core::Subscriber,
+ fmt_layer::Layer<Registry, N, E, W>: layer::Layer<Registry>,
+{
+ #[inline]
+ fn register_callsite(&self, meta: &'static Metadata<'static>) -> Interest {
+ self.inner.register_callsite(meta)
+ }
+
+ #[inline]
+ fn enabled(&self, meta: &Metadata<'_>) -> bool {
+ self.inner.enabled(meta)
+ }
+
+ #[inline]
+ fn new_span(&self, attrs: &span::Attributes<'_>) -> span::Id {
+ self.inner.new_span(attrs)
+ }
+
+ #[inline]
+ fn record(&self, span: &span::Id, values: &span::Record<'_>) {
+ self.inner.record(span, values)
+ }
+
+ #[inline]
+ fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
+ self.inner.record_follows_from(span, follows)
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>) -> bool {
+ self.inner.event_enabled(event)
+ }
+
+ #[inline]
+ fn event(&self, event: &Event<'_>) {
+ self.inner.event(event);
+ }
+
+ #[inline]
+ fn enter(&self, id: &span::Id) {
+ // TODO: add on_enter hook
+ self.inner.enter(id);
+ }
+
+ #[inline]
+ fn exit(&self, id: &span::Id) {
+ self.inner.exit(id);
+ }
+
+ #[inline]
+ fn current_span(&self) -> span::Current {
+ self.inner.current_span()
+ }
+
+ #[inline]
+ fn clone_span(&self, id: &span::Id) -> span::Id {
+ self.inner.clone_span(id)
+ }
+
+ #[inline]
+ fn try_close(&self, id: span::Id) -> bool {
+ self.inner.try_close(id)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<tracing_core::LevelFilter> {
+ self.inner.max_level_hint()
+ }
+
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ Some(self as *const Self as *const ())
+ } else {
+ self.inner.downcast_raw(id)
+ }
+ }
+}
+
+impl<'a, N, E, F, W> LookupSpan<'a> for Subscriber<N, E, F, W>
+where
+ layer::Layered<F, Formatter<N, E, W>>: LookupSpan<'a>,
+{
+ type Data = <layer::Layered<F, Formatter<N, E, W>> as LookupSpan<'a>>::Data;
+
+ fn span_data(&'a self, id: &span::Id) -> Option<Self::Data> {
+ self.inner.span_data(id)
+ }
+}
+
+// ===== impl SubscriberBuilder =====
+
+impl Default for SubscriberBuilder {
+ fn default() -> Self {
+ SubscriberBuilder {
+ filter: Subscriber::DEFAULT_MAX_LEVEL,
+ inner: Default::default(),
+ }
+ .log_internal_errors(true)
+ }
+}
+
+impl<N, E, F, W> SubscriberBuilder<N, E, F, W>
+where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ E: FormatEvent<Registry, N> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+ F: layer::Layer<Formatter<N, E, W>> + Send + Sync + 'static,
+ fmt_layer::Layer<Registry, N, E, W>: layer::Layer<Registry> + Send + Sync + 'static,
+{
+ /// Finish the builder, returning a new `FmtSubscriber`.
+ pub fn finish(self) -> Subscriber<N, E, F, W> {
+ let subscriber = self.inner.with_subscriber(Registry::default());
+ Subscriber {
+ inner: self.filter.with_subscriber(subscriber),
+ }
+ }
+
+ /// Install this Subscriber as the global default if one is
+ /// not already set.
+ ///
+ /// If the `tracing-log` feature is enabled, this will also install
+ /// the LogTracer to convert `Log` records into `tracing` `Event`s.
+ ///
+ /// # Errors
+ /// Returns an Error if the initialization was unsuccessful, likely
+ /// because a global subscriber was already installed by another
+ /// call to `try_init`.
+ pub fn try_init(self) -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
+ use crate::util::SubscriberInitExt;
+ self.finish().try_init()?;
+
+ Ok(())
+ }
+
+ /// Install this Subscriber as the global default.
+ ///
+ /// If the `tracing-log` feature is enabled, this will also install
+ /// the LogTracer to convert `Log` records into `tracing` `Event`s.
+ ///
+ /// # Panics
+ /// Panics if the initialization was unsuccessful, likely because a
+ /// global subscriber was already installed by another call to `try_init`.
+ pub fn init(self) {
+ self.try_init()
+ .expect("Unable to install global subscriber")
+ }
+}
+
+impl<N, E, F, W> From<SubscriberBuilder<N, E, F, W>> for tracing_core::Dispatch
+where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ E: FormatEvent<Registry, N> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+ F: layer::Layer<Formatter<N, E, W>> + Send + Sync + 'static,
+ fmt_layer::Layer<Registry, N, E, W>: layer::Layer<Registry> + Send + Sync + 'static,
+{
+ fn from(builder: SubscriberBuilder<N, E, F, W>) -> tracing_core::Dispatch {
+ tracing_core::Dispatch::new(builder.finish())
+ }
+}
+
+impl<N, L, T, F, W> SubscriberBuilder<N, format::Format<L, T>, F, W>
+where
+ N: for<'writer> FormatFields<'writer> + 'static,
+{
+ /// Use the given [`timer`] for log message timestamps.
+ ///
+ /// See the [`time` module] for the provided timer implementations.
+ ///
+ /// Note that using the `"time`"" feature flag enables the
+ /// additional time formatters [`UtcTime`] and [`LocalTime`], which use the
+ /// [`time` crate] to provide more sophisticated timestamp formatting
+ /// options.
+ ///
+ /// [`timer`]: time::FormatTime
+ /// [`time` module]: mod@time
+ /// [`UtcTime`]: time::UtcTime
+ /// [`LocalTime`]: time::LocalTime
+ /// [`time` crate]: https://docs.rs/time/0.3
+ pub fn with_timer<T2>(self, timer: T2) -> SubscriberBuilder<N, format::Format<L, T2>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.with_timer(timer),
+ }
+ }
+
+ /// Do not emit timestamps with log messages.
+ pub fn without_time(self) -> SubscriberBuilder<N, format::Format<L, ()>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.without_time(),
+ }
+ }
+
+ /// Configures how synthesized events are emitted at points in the [span
+ /// lifecycle][lifecycle].
+ ///
+ /// The following options are available:
+ ///
+ /// - `FmtSpan::NONE`: No events will be synthesized when spans are
+ /// created, entered, exited, or closed. Data from spans will still be
+ /// included as the context for formatted events. This is the default.
+ /// - `FmtSpan::NEW`: An event will be synthesized when spans are created.
+ /// - `FmtSpan::ENTER`: An event will be synthesized when spans are entered.
+ /// - `FmtSpan::EXIT`: An event will be synthesized when spans are exited.
+ /// - `FmtSpan::CLOSE`: An event will be synthesized when a span closes. If
+ /// [timestamps are enabled][time] for this formatter, the generated
+ /// event will contain fields with the span's _busy time_ (the total
+ /// time for which it was entered) and _idle time_ (the total time that
+ /// the span existed but was not entered).
+ /// - `FmtSpan::ACTIVE`: An event will be synthesized when spans are entered
+ /// or exited.
+ /// - `FmtSpan::FULL`: Events will be synthesized whenever a span is
+ /// created, entered, exited, or closed. If timestamps are enabled, the
+ /// close event will contain the span's busy and idle time, as
+ /// described above.
+ ///
+ /// The options can be enabled in any combination. For instance, the following
+ /// will synthesize events whenever spans are created and closed:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::fmt::format::FmtSpan;
+ /// use tracing_subscriber::fmt;
+ ///
+ /// let subscriber = fmt()
+ /// .with_span_events(FmtSpan::NEW | FmtSpan::CLOSE)
+ /// .finish();
+ /// ```
+ ///
+ /// Note that the generated events will only be part of the log output by
+ /// this formatter; they will not be recorded by other `Subscriber`s or by
+ /// `Layer`s added to this subscriber.
+ ///
+ /// [lifecycle]: https://docs.rs/tracing/latest/tracing/span/index.html#the-span-lifecycle
+ /// [time]: SubscriberBuilder::without_time()
+ pub fn with_span_events(self, kind: format::FmtSpan) -> Self {
+ SubscriberBuilder {
+ inner: self.inner.with_span_events(kind),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the formatter emits ANSI terminal escape codes
+ /// for colors and other text formatting.
+ ///
+ /// Enabling ANSI escapes (calling `with_ansi(true)`) requires the "ansi"
+ /// crate feature flag. Calling `with_ansi(true)` without the "ansi"
+ /// feature flag enabled will panic if debug assertions are enabled, or
+ /// print a warning otherwise.
+ ///
+ /// This method itself is still available without the feature flag. This
+ /// is to allow ANSI escape codes to be explicitly *disabled* without
+ /// having to opt-in to the dependencies required to emit ANSI formatting.
+ /// This way, code which constructs a formatter that should never emit
+ /// ANSI escape codes can ensure that they are not used, regardless of
+ /// whether or not other crates in the dependency graph enable the "ansi"
+ /// feature flag.
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn with_ansi(self, ansi: bool) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_ansi(ansi),
+ ..self
+ }
+ }
+
+ /// Sets whether to write errors from [`FormatEvent`] to the writer.
+ /// Defaults to true.
+ ///
+ /// By default, `fmt::Layer` will write any `FormatEvent`-internal errors to
+ /// the writer. These errors are unlikely and will only occur if there is a
+ /// bug in the `FormatEvent` implementation or its dependencies.
+ ///
+ /// If writing to the writer fails, the error message is printed to stderr
+ /// as a fallback.
+ ///
+ /// [`FormatEvent`]: crate::fmt::FormatEvent
+ pub fn log_internal_errors(
+ self,
+ log_internal_errors: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.log_internal_errors(log_internal_errors),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's target is displayed.
+ pub fn with_target(
+ self,
+ display_target: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_target(display_target),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code file path][file] is
+ /// displayed.
+ ///
+ /// [file]: tracing_core::Metadata::file
+ pub fn with_file(
+ self,
+ display_filename: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_file(display_filename),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's [source code line number][line] is
+ /// displayed.
+ ///
+ /// [line]: tracing_core::Metadata::line
+ pub fn with_line_number(
+ self,
+ display_line_number: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_line_number(display_line_number),
+ ..self
+ }
+ }
+
+ /// Sets whether or not an event's level is displayed.
+ pub fn with_level(
+ self,
+ display_level: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_level(display_level),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [name] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [name]: std::thread#naming-threads
+ pub fn with_thread_names(
+ self,
+ display_thread_names: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_thread_names(display_thread_names),
+ ..self
+ }
+ }
+
+ /// Sets whether or not the [thread ID] of the current thread is displayed
+ /// when formatting events.
+ ///
+ /// [thread ID]: std::thread::ThreadId
+ pub fn with_thread_ids(
+ self,
+ display_thread_ids: bool,
+ ) -> SubscriberBuilder<N, format::Format<L, T>, F, W> {
+ SubscriberBuilder {
+ inner: self.inner.with_thread_ids(display_thread_ids),
+ ..self
+ }
+ }
+
+ /// Sets the subscriber being built to use a less verbose formatter.
+ ///
+ /// See [`format::Compact`].
+ pub fn compact(self) -> SubscriberBuilder<N, format::Format<format::Compact, T>, F, W>
+ where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.compact(),
+ }
+ }
+
+ /// Sets the subscriber being built to use an [excessively pretty, human-readable formatter](crate::fmt::format::Pretty).
+ #[cfg(feature = "ansi")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "ansi")))]
+ pub fn pretty(
+ self,
+ ) -> SubscriberBuilder<format::Pretty, format::Format<format::Pretty, T>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.pretty(),
+ }
+ }
+
+ /// Sets the subscriber being built to use a JSON formatter.
+ ///
+ /// See [`format::Json`] for details.
+ #[cfg(feature = "json")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+ pub fn json(
+ self,
+ ) -> SubscriberBuilder<format::JsonFields, format::Format<format::Json, T>, F, W>
+ where
+ N: for<'writer> FormatFields<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.json(),
+ }
+ }
+}
+
+#[cfg(feature = "json")]
+#[cfg_attr(docsrs, doc(cfg(feature = "json")))]
+impl<T, F, W> SubscriberBuilder<format::JsonFields, format::Format<format::Json, T>, F, W> {
+ /// Sets the json subscriber being built to flatten event metadata.
+ ///
+ /// See [`format::Json`] for details.
+ pub fn flatten_event(
+ self,
+ flatten_event: bool,
+ ) -> SubscriberBuilder<format::JsonFields, format::Format<format::Json, T>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.flatten_event(flatten_event),
+ }
+ }
+
+ /// Sets whether or not the JSON subscriber being built will include the current span
+ /// in formatted events.
+ ///
+ /// See [`format::Json`] for details.
+ pub fn with_current_span(
+ self,
+ display_current_span: bool,
+ ) -> SubscriberBuilder<format::JsonFields, format::Format<format::Json, T>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.with_current_span(display_current_span),
+ }
+ }
+
+ /// Sets whether or not the JSON subscriber being built will include a list (from
+ /// root to leaf) of all currently entered spans in formatted events.
+ ///
+ /// See [`format::Json`] for details.
+ pub fn with_span_list(
+ self,
+ display_span_list: bool,
+ ) -> SubscriberBuilder<format::JsonFields, format::Format<format::Json, T>, F, W> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.with_span_list(display_span_list),
+ }
+ }
+}
+
+#[cfg(feature = "env-filter")]
+#[cfg_attr(docsrs, doc(cfg(feature = "env-filter")))]
+impl<N, E, W> SubscriberBuilder<N, E, crate::EnvFilter, W>
+where
+ Formatter<N, E, W>: tracing_core::Subscriber + 'static,
+{
+ /// Configures the subscriber being built to allow filter reloading at
+ /// runtime.
+ pub fn with_filter_reloading(
+ self,
+ ) -> SubscriberBuilder<N, E, crate::reload::Layer<crate::EnvFilter, Formatter<N, E, W>>, W>
+ {
+ let (filter, _) = crate::reload::Layer::new(self.filter);
+ SubscriberBuilder {
+ filter,
+ inner: self.inner,
+ }
+ }
+}
+
+#[cfg(feature = "env-filter")]
+#[cfg_attr(docsrs, doc(cfg(feature = "env-filter")))]
+impl<N, E, W> SubscriberBuilder<N, E, crate::reload::Layer<crate::EnvFilter, Formatter<N, E, W>>, W>
+where
+ Formatter<N, E, W>: tracing_core::Subscriber + 'static,
+{
+ /// Returns a `Handle` that may be used to reload the constructed subscriber's
+ /// filter.
+ pub fn reload_handle(&self) -> crate::reload::Handle<crate::EnvFilter, Formatter<N, E, W>> {
+ self.filter.handle()
+ }
+}
+
+impl<N, E, F, W> SubscriberBuilder<N, E, F, W> {
+ /// Sets the field formatter that the subscriber being built will use to record
+ /// fields.
+ ///
+ /// For example:
+ /// ```rust
+ /// use tracing_subscriber::fmt::format;
+ /// use tracing_subscriber::prelude::*;
+ ///
+ /// let formatter =
+ /// // Construct a custom formatter for `Debug` fields
+ /// format::debug_fn(|writer, field, value| write!(writer, "{}: {:?}", field, value))
+ /// // Use the `tracing_subscriber::MakeFmtExt` trait to wrap the
+ /// // formatter so that a delimiter is added between fields.
+ /// .delimited(", ");
+ ///
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .fmt_fields(formatter)
+ /// .finish();
+ /// # drop(subscriber)
+ /// ```
+ pub fn fmt_fields<N2>(self, fmt_fields: N2) -> SubscriberBuilder<N2, E, F, W>
+ where
+ N2: for<'writer> FormatFields<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.fmt_fields(fmt_fields),
+ }
+ }
+
+ /// Sets the [`EnvFilter`] that the subscriber will use to determine if
+ /// a span or event is enabled.
+ ///
+ /// Note that this method requires the "env-filter" feature flag to be enabled.
+ ///
+ /// If a filter was previously set, or a maximum level was set by the
+ /// [`with_max_level`] method, that value is replaced by the new filter.
+ ///
+ /// # Examples
+ ///
+ /// Setting a filter based on the value of the `RUST_LOG` environment
+ /// variable:
+ /// ```rust
+ /// use tracing_subscriber::{fmt, EnvFilter};
+ ///
+ /// fmt()
+ /// .with_env_filter(EnvFilter::from_default_env())
+ /// .init();
+ /// ```
+ ///
+ /// Setting a filter based on a pre-set filter directive string:
+ /// ```rust
+ /// use tracing_subscriber::fmt;
+ ///
+ /// fmt()
+ /// .with_env_filter("my_crate=info,my_crate::my_mod=debug,[my_span]=trace")
+ /// .init();
+ /// ```
+ ///
+ /// Adding additional directives to a filter constructed from an env var:
+ /// ```rust
+ /// use tracing_subscriber::{fmt, filter::{EnvFilter, LevelFilter}};
+ ///
+ /// # fn filter() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+ /// let filter = EnvFilter::try_from_env("MY_CUSTOM_FILTER_ENV_VAR")?
+ /// // Set the base level when not matched by other directives to WARN.
+ /// .add_directive(LevelFilter::WARN.into())
+ /// // Set the max level for `my_crate::my_mod` to DEBUG, overriding
+ /// // any directives parsed from the env variable.
+ /// .add_directive("my_crate::my_mod=debug".parse()?);
+ ///
+ /// fmt()
+ /// .with_env_filter(filter)
+ /// .try_init()?;
+ /// # Ok(())}
+ /// ```
+ /// [`EnvFilter`]: super::filter::EnvFilter
+ /// [`with_max_level`]: SubscriberBuilder::with_max_level()
+ #[cfg(feature = "env-filter")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "env-filter")))]
+ pub fn with_env_filter(
+ self,
+ filter: impl Into<crate::EnvFilter>,
+ ) -> SubscriberBuilder<N, E, crate::EnvFilter, W>
+ where
+ Formatter<N, E, W>: tracing_core::Subscriber + 'static,
+ {
+ let filter = filter.into();
+ SubscriberBuilder {
+ filter,
+ inner: self.inner,
+ }
+ }
+
+ /// Sets the maximum [verbosity level] that will be enabled by the
+ /// subscriber.
+ ///
+ /// If the max level has already been set, or a [`EnvFilter`] was added by
+ /// [`with_env_filter`], this replaces that configuration with the new
+ /// maximum level.
+ ///
+ /// # Examples
+ ///
+ /// Enable up to the `DEBUG` verbosity level:
+ /// ```rust
+ /// use tracing_subscriber::fmt;
+ /// use tracing::Level;
+ ///
+ /// fmt()
+ /// .with_max_level(Level::DEBUG)
+ /// .init();
+ /// ```
+ /// This subscriber won't record any spans or events!
+ /// ```rust
+ /// use tracing_subscriber::{fmt, filter::LevelFilter};
+ ///
+ /// let subscriber = fmt()
+ /// .with_max_level(LevelFilter::OFF)
+ /// .finish();
+ /// ```
+ /// [verbosity level]: tracing_core::Level
+ /// [`EnvFilter`]: struct@crate::filter::EnvFilter
+ /// [`with_env_filter`]: fn@Self::with_env_filter
+ pub fn with_max_level(
+ self,
+ filter: impl Into<LevelFilter>,
+ ) -> SubscriberBuilder<N, E, LevelFilter, W> {
+ let filter = filter.into();
+ SubscriberBuilder {
+ filter,
+ inner: self.inner,
+ }
+ }
+
+ /// Sets the [event formatter][`FormatEvent`] that the subscriber being built
+ /// will use to format events that occur.
+ ///
+ /// The event formatter may be any type implementing the [`FormatEvent`]
+ /// trait, which is implemented for all functions taking a [`FmtContext`], a
+ /// [`Writer`], and an [`Event`].
+ ///
+ /// # Examples
+ ///
+ /// Setting a type implementing [`FormatEvent`] as the formatter:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::fmt::format;
+ ///
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .event_format(format().compact())
+ /// .finish();
+ /// ```
+ ///
+ /// [`Writer`]: struct@self::format::Writer
+ pub fn event_format<E2>(self, fmt_event: E2) -> SubscriberBuilder<N, E2, F, W>
+ where
+ E2: FormatEvent<Registry, N> + 'static,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.event_format(fmt_event),
+ }
+ }
+
+ /// Sets the [`MakeWriter`] that the subscriber being built will use to write events.
+ ///
+ /// # Examples
+ ///
+ /// Using `stderr` rather than `stdout`:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::fmt;
+ /// use std::io;
+ ///
+ /// fmt()
+ /// .with_writer(io::stderr)
+ /// .init();
+ /// ```
+ pub fn with_writer<W2>(self, make_writer: W2) -> SubscriberBuilder<N, E, F, W2>
+ where
+ W2: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.with_writer(make_writer),
+ }
+ }
+
+ /// Configures the subscriber to support [`libtest`'s output capturing][capturing] when used in
+ /// unit tests.
+ ///
+ /// See [`TestWriter`] for additional details.
+ ///
+ /// # Examples
+ ///
+ /// Using [`TestWriter`] to let `cargo test` capture test output. Note that we do not install it
+ /// globally as it may cause conflicts.
+ ///
+ /// ```rust
+ /// use tracing_subscriber::fmt;
+ /// use tracing::subscriber;
+ ///
+ /// subscriber::set_default(
+ /// fmt()
+ /// .with_test_writer()
+ /// .finish()
+ /// );
+ /// ```
+ ///
+ /// [capturing]:
+ /// https://doc.rust-lang.org/book/ch11-02-running-tests.html#showing-function-output
+ /// [`TestWriter`]: writer::TestWriter
+ pub fn with_test_writer(self) -> SubscriberBuilder<N, E, F, TestWriter> {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.with_writer(TestWriter::default()),
+ }
+ }
+
+ /// Updates the event formatter by applying a function to the existing event formatter.
+ ///
+ /// This sets the event formatter that the subscriber being built will use to record fields.
+ ///
+ /// # Examples
+ ///
+ /// Updating an event formatter:
+ ///
+ /// ```rust
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .map_event_format(|e| e.compact())
+ /// .finish();
+ /// ```
+ pub fn map_event_format<E2>(self, f: impl FnOnce(E) -> E2) -> SubscriberBuilder<N, E2, F, W>
+ where
+ E2: FormatEvent<Registry, N> + 'static,
+ N: for<'writer> FormatFields<'writer> + 'static,
+ W: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.map_event_format(f),
+ }
+ }
+
+ /// Updates the field formatter by applying a function to the existing field formatter.
+ ///
+ /// This sets the field formatter that the subscriber being built will use to record fields.
+ ///
+ /// # Examples
+ ///
+ /// Updating a field formatter:
+ ///
+ /// ```rust
+ /// use tracing_subscriber::field::MakeExt;
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .map_fmt_fields(|f| f.debug_alt())
+ /// .finish();
+ /// ```
+ pub fn map_fmt_fields<N2>(self, f: impl FnOnce(N) -> N2) -> SubscriberBuilder<N2, E, F, W>
+ where
+ N2: for<'writer> FormatFields<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.map_fmt_fields(f),
+ }
+ }
+
+ /// Updates the [`MakeWriter`] by applying a function to the existing [`MakeWriter`].
+ ///
+ /// This sets the [`MakeWriter`] that the subscriber being built will use to write events.
+ ///
+ /// # Examples
+ ///
+ /// Redirect output to stderr if level is <= WARN:
+ ///
+ /// ```rust
+ /// use tracing::Level;
+ /// use tracing_subscriber::fmt::{self, writer::MakeWriterExt};
+ ///
+ /// let stderr = std::io::stderr.with_max_level(Level::WARN);
+ /// let layer = tracing_subscriber::fmt()
+ /// .map_writer(move |w| stderr.or_else(w))
+ /// .finish();
+ /// ```
+ pub fn map_writer<W2>(self, f: impl FnOnce(W) -> W2) -> SubscriberBuilder<N, E, F, W2>
+ where
+ W2: for<'writer> MakeWriter<'writer> + 'static,
+ {
+ SubscriberBuilder {
+ filter: self.filter,
+ inner: self.inner.map_writer(f),
+ }
+ }
+}
+
+/// Install a global tracing subscriber that listens for events and
+/// filters based on the value of the [`RUST_LOG` environment variable],
+/// if one is not already set.
+///
+/// If the `tracing-log` feature is enabled, this will also install
+/// the [`LogTracer`] to convert `log` records into `tracing` `Event`s.
+///
+/// This is shorthand for
+///
+/// ```rust
+/// # fn doc() -> Result<(), Box<dyn std::error::Error + Send + Sync + 'static>> {
+/// tracing_subscriber::fmt().try_init()
+/// # }
+/// ```
+///
+///
+/// # Errors
+///
+/// Returns an Error if the initialization was unsuccessful,
+/// likely because a global subscriber was already installed by another
+/// call to `try_init`.
+///
+/// [`LogTracer`]:
+/// https://docs.rs/tracing-log/0.1.0/tracing_log/struct.LogTracer.html
+/// [`RUST_LOG` environment variable]: crate::filter::EnvFilter::DEFAULT_ENV
+pub fn try_init() -> Result<(), Box<dyn Error + Send + Sync + 'static>> {
+ let builder = Subscriber::builder();
+
+ #[cfg(feature = "env-filter")]
+ let builder = builder.with_env_filter(crate::EnvFilter::from_default_env());
+
+ // If `env-filter` is disabled, remove the default max level filter from the
+ // subscriber; it will be added to the `Targets` filter instead if no filter
+ // is set in `RUST_LOG`.
+ // Replacing the default `LevelFilter` with an `EnvFilter` would imply this,
+ // but we can't replace the builder's filter with a `Targets` filter yet.
+ #[cfg(not(feature = "env-filter"))]
+ let builder = builder.with_max_level(LevelFilter::TRACE);
+
+ let subscriber = builder.finish();
+ #[cfg(not(feature = "env-filter"))]
+ let subscriber = {
+ use crate::{filter::Targets, layer::SubscriberExt};
+ use std::{env, str::FromStr};
+ let targets = match env::var("RUST_LOG") {
+ Ok(var) => Targets::from_str(&var)
+ .map_err(|e| {
+ eprintln!("Ignoring `RUST_LOG={:?}`: {}", var, e);
+ })
+ .unwrap_or_default(),
+ Err(env::VarError::NotPresent) => {
+ Targets::new().with_default(Subscriber::DEFAULT_MAX_LEVEL)
+ }
+ Err(e) => {
+ eprintln!("Ignoring `RUST_LOG`: {}", e);
+ Targets::new().with_default(Subscriber::DEFAULT_MAX_LEVEL)
+ }
+ };
+ subscriber.with(targets)
+ };
+
+ subscriber.try_init().map_err(Into::into)
+}
+
+/// Install a global tracing subscriber that listens for events and
+/// filters based on the value of the [`RUST_LOG` environment variable].
+///
+/// The configuration of the subscriber initialized by this function
+/// depends on what [feature flags](crate#feature-flags) are enabled.
+///
+/// If the `tracing-log` feature is enabled, this will also install
+/// the LogTracer to convert `Log` records into `tracing` `Event`s.
+///
+/// If the `env-filter` feature is enabled, this is shorthand for
+///
+/// ```rust
+/// # use tracing_subscriber::EnvFilter;
+/// tracing_subscriber::fmt()
+/// .with_env_filter(EnvFilter::from_default_env())
+/// .init();
+/// ```
+///
+/// # Panics
+/// Panics if the initialization was unsuccessful, likely because a
+/// global subscriber was already installed by another call to `try_init`.
+///
+/// [`RUST_LOG` environment variable]: crate::filter::EnvFilter::DEFAULT_ENV
+pub fn init() {
+ try_init().expect("Unable to install global subscriber")
+}
+
+#[cfg(test)]
+mod test {
+ use crate::{
+ filter::LevelFilter,
+ fmt::{
+ format::{self, Format},
+ time,
+ writer::MakeWriter,
+ Subscriber,
+ },
+ };
+ use std::{
+ io,
+ sync::{Arc, Mutex, MutexGuard, TryLockError},
+ };
+ use tracing_core::dispatcher::Dispatch;
+
+ pub(crate) struct MockWriter {
+ buf: Arc<Mutex<Vec<u8>>>,
+ }
+
+ impl MockWriter {
+ pub(crate) fn new(buf: Arc<Mutex<Vec<u8>>>) -> Self {
+ Self { buf }
+ }
+
+ pub(crate) fn map_error<Guard>(err: TryLockError<Guard>) -> io::Error {
+ match err {
+ TryLockError::WouldBlock => io::Error::from(io::ErrorKind::WouldBlock),
+ TryLockError::Poisoned(_) => io::Error::from(io::ErrorKind::Other),
+ }
+ }
+
+ pub(crate) fn buf(&self) -> io::Result<MutexGuard<'_, Vec<u8>>> {
+ self.buf.try_lock().map_err(Self::map_error)
+ }
+ }
+
+ impl io::Write for MockWriter {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ self.buf()?.write(buf)
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ self.buf()?.flush()
+ }
+ }
+
+ #[derive(Clone, Default)]
+ pub(crate) struct MockMakeWriter {
+ buf: Arc<Mutex<Vec<u8>>>,
+ }
+
+ impl MockMakeWriter {
+ pub(crate) fn new(buf: Arc<Mutex<Vec<u8>>>) -> Self {
+ Self { buf }
+ }
+
+ // this is currently only used by the JSON formatter tests. if we need
+ // it elsewhere in the future, feel free to remove the `#[cfg]`
+ // attribute!
+ #[cfg(feature = "json")]
+ pub(crate) fn buf(&self) -> MutexGuard<'_, Vec<u8>> {
+ self.buf.lock().unwrap()
+ }
+
+ pub(crate) fn get_string(&self) -> String {
+ let mut buf = self.buf.lock().expect("lock shouldn't be poisoned");
+ let string = std::str::from_utf8(&buf[..])
+ .expect("formatter should not have produced invalid utf-8")
+ .to_owned();
+ buf.clear();
+ string
+ }
+ }
+
+ impl<'a> MakeWriter<'a> for MockMakeWriter {
+ type Writer = MockWriter;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ MockWriter::new(self.buf.clone())
+ }
+ }
+
+ #[test]
+ fn impls() {
+ let f = Format::default().with_timer(time::Uptime::default());
+ let subscriber = Subscriber::builder().event_format(f).finish();
+ let _dispatch = Dispatch::new(subscriber);
+
+ let f = format::Format::default();
+ let subscriber = Subscriber::builder().event_format(f).finish();
+ let _dispatch = Dispatch::new(subscriber);
+
+ let f = format::Format::default().compact();
+ let subscriber = Subscriber::builder().event_format(f).finish();
+ let _dispatch = Dispatch::new(subscriber);
+ }
+
+ #[test]
+ fn subscriber_downcasts() {
+ let subscriber = Subscriber::builder().finish();
+ let dispatch = Dispatch::new(subscriber);
+ assert!(dispatch.downcast_ref::<Subscriber>().is_some());
+ }
+
+ #[test]
+ fn subscriber_downcasts_to_parts() {
+ let subscriber = Subscriber::new();
+ let dispatch = Dispatch::new(subscriber);
+ assert!(dispatch.downcast_ref::<format::DefaultFields>().is_some());
+ assert!(dispatch.downcast_ref::<LevelFilter>().is_some());
+ assert!(dispatch.downcast_ref::<format::Format>().is_some())
+ }
+
+ #[test]
+ fn is_lookup_span() {
+ fn assert_lookup_span<T: for<'a> crate::registry::LookupSpan<'a>>(_: T) {}
+ let subscriber = Subscriber::new();
+ assert_lookup_span(subscriber)
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/time/chrono_crate.rs b/crates/tracing-subscriber/src/fmt/time/chrono_crate.rs
new file mode 100644
index 0000000..1a831ef
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/time/chrono_crate.rs
@@ -0,0 +1,177 @@
+use crate::fmt::format::Writer;
+use crate::fmt::time::FormatTime;
+
+use std::sync::Arc;
+
+/// Formats [local time]s and [UTC time]s with `FormatTime` implementations
+/// that use the [`chrono` crate].
+///
+/// [local time]: [`chrono::offset::Local`]
+/// [UTC time]: [`chrono::offset::Utc`]
+/// [`chrono` crate]: [`chrono`]
+
+/// Formats the current [local time] using a [formatter] from the [`chrono`] crate.
+///
+/// [local time]: chrono::Local::now()
+/// [formatter]: chrono::format
+#[cfg_attr(docsrs, doc(cfg(feature = "chrono")))]
+#[derive(Debug, Clone, Eq, PartialEq, Default)]
+pub struct ChronoLocal {
+ format: Arc<ChronoFmtType>,
+}
+
+impl ChronoLocal {
+ /// Format the time using the [`RFC 3339`] format
+ /// (a subset of [`ISO 8601`]).
+ ///
+ /// [`RFC 3339`]: https://tools.ietf.org/html/rfc3339
+ /// [`ISO 8601`]: https://en.wikipedia.org/wiki/ISO_8601
+ pub fn rfc_3339() -> Self {
+ Self {
+ format: Arc::new(ChronoFmtType::Rfc3339),
+ }
+ }
+
+ /// Format the time using the given format string.
+ ///
+ /// See [`chrono::format::strftime`] for details on the supported syntax.
+ pub fn new(format_string: String) -> Self {
+ Self {
+ format: Arc::new(ChronoFmtType::Custom(format_string)),
+ }
+ }
+}
+
+impl FormatTime for ChronoLocal {
+ fn format_time(&self, w: &mut Writer<'_>) -> alloc::fmt::Result {
+ let t = chrono::Local::now();
+ match self.format.as_ref() {
+ ChronoFmtType::Rfc3339 => {
+ use chrono::format::{Fixed, Item};
+ write!(
+ w,
+ "{}",
+ t.format_with_items(core::iter::once(Item::Fixed(Fixed::RFC3339)))
+ )
+ }
+ ChronoFmtType::Custom(fmt) => {
+ write!(w, "{}", t.format(fmt))
+ }
+ }
+ }
+}
+
+/// Formats the current [UTC time] using a [formatter] from the [`chrono`] crate.
+///
+/// [UTC time]: chrono::Utc::now()
+/// [formatter]: chrono::format
+#[cfg_attr(docsrs, doc(cfg(feature = "chrono")))]
+#[derive(Debug, Clone, Eq, PartialEq, Default)]
+pub struct ChronoUtc {
+ format: Arc<ChronoFmtType>,
+}
+
+impl ChronoUtc {
+ /// Format the time using the [`RFC 3339`] format
+ /// (a subset of [`ISO 8601`]).
+ ///
+ /// [`RFC 3339`]: https://tools.ietf.org/html/rfc3339
+ /// [`ISO 8601`]: https://en.wikipedia.org/wiki/ISO_8601
+ pub fn rfc_3339() -> Self {
+ Self {
+ format: Arc::new(ChronoFmtType::Rfc3339),
+ }
+ }
+
+ /// Format the time using the given format string.
+ ///
+ /// See [`chrono::format::strftime`] for details on the supported syntax.
+ pub fn new(format_string: String) -> Self {
+ Self {
+ format: Arc::new(ChronoFmtType::Custom(format_string)),
+ }
+ }
+}
+
+impl FormatTime for ChronoUtc {
+ fn format_time(&self, w: &mut Writer<'_>) -> alloc::fmt::Result {
+ let t = chrono::Utc::now();
+ match self.format.as_ref() {
+ ChronoFmtType::Rfc3339 => w.write_str(&t.to_rfc3339()),
+ ChronoFmtType::Custom(fmt) => w.write_str(&format!("{}", t.format(fmt))),
+ }
+ }
+}
+
+/// The RFC 3339 format is used by default but a custom format string
+/// can be used. See [`chrono::format::strftime`]for details on
+/// the supported syntax.
+///
+/// [`chrono::format::strftime`]: https://docs.rs/chrono/0.4.9/chrono/format/strftime/index.html
+#[derive(Debug, Clone, Eq, PartialEq)]
+enum ChronoFmtType {
+ /// Format according to the RFC 3339 convention.
+ Rfc3339,
+ /// Format according to a custom format string.
+ Custom(String),
+}
+
+impl Default for ChronoFmtType {
+ fn default() -> Self {
+ ChronoFmtType::Rfc3339
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::fmt::format::Writer;
+ use crate::fmt::time::FormatTime;
+
+ use std::sync::Arc;
+
+ use super::ChronoFmtType;
+ use super::ChronoLocal;
+ use super::ChronoUtc;
+
+ #[test]
+ fn test_chrono_format_time_utc_default() {
+ let mut buf = String::new();
+ let mut dst: Writer<'_> = Writer::new(&mut buf);
+ assert!(FormatTime::format_time(&ChronoUtc::default(), &mut dst).is_ok());
+ // e.g. `buf` contains "2023-08-18T19:05:08.662499+00:00"
+ assert!(chrono::DateTime::parse_from_str(&buf, "%FT%H:%M:%S%.6f%z").is_ok());
+ }
+
+ #[test]
+ fn test_chrono_format_time_utc_custom() {
+ let fmt = ChronoUtc {
+ format: Arc::new(ChronoFmtType::Custom("%a %b %e %T %Y".to_owned())),
+ };
+ let mut buf = String::new();
+ let mut dst: Writer<'_> = Writer::new(&mut buf);
+ assert!(FormatTime::format_time(&fmt, &mut dst).is_ok());
+ // e.g. `buf` contains "Wed Aug 23 15:53:23 2023"
+ assert!(chrono::NaiveDateTime::parse_from_str(&buf, "%a %b %e %T %Y").is_ok());
+ }
+
+ #[test]
+ fn test_chrono_format_time_local_default() {
+ let mut buf = String::new();
+ let mut dst: Writer<'_> = Writer::new(&mut buf);
+ assert!(FormatTime::format_time(&ChronoLocal::default(), &mut dst).is_ok());
+ // e.g. `buf` contains "2023-08-18T14:59:08.662499-04:00".
+ assert!(chrono::DateTime::parse_from_str(&buf, "%FT%H:%M:%S%.6f%z").is_ok());
+ }
+
+ #[test]
+ fn test_chrono_format_time_local_custom() {
+ let fmt = ChronoLocal {
+ format: Arc::new(ChronoFmtType::Custom("%a %b %e %T %Y".to_owned())),
+ };
+ let mut buf = String::new();
+ let mut dst: Writer<'_> = Writer::new(&mut buf);
+ assert!(FormatTime::format_time(&fmt, &mut dst).is_ok());
+ // e.g. `buf` contains "Wed Aug 23 15:55:46 2023".
+ assert!(chrono::NaiveDateTime::parse_from_str(&buf, "%a %b %e %T %Y").is_ok());
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/time/datetime.rs b/crates/tracing-subscriber/src/fmt/time/datetime.rs
new file mode 100644
index 0000000..5313316
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/time/datetime.rs
@@ -0,0 +1,410 @@
+// musl as a whole is licensed under the following standard MIT license:
+//
+// ----------------------------------------------------------------------
+// Copyright © 2005-2020 Rich Felker, et al.
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+// ----------------------------------------------------------------------
+//
+// Authors/contributors include:
+//
+// A. Wilcox
+// Ada Worcester
+// Alex Dowad
+// Alex Suykov
+// Alexander Monakov
+// Andre McCurdy
+// Andrew Kelley
+// Anthony G. Basile
+// Aric Belsito
+// Arvid Picciani
+// Bartosz Brachaczek
+// Benjamin Peterson
+// Bobby Bingham
+// Boris Brezillon
+// Brent Cook
+// Chris Spiegel
+// Clément Vasseur
+// Daniel Micay
+// Daniel Sabogal
+// Daurnimator
+// David Carlier
+// David Edelsohn
+// Denys Vlasenko
+// Dmitry Ivanov
+// Dmitry V. Levin
+// Drew DeVault
+// Emil Renner Berthing
+// Fangrui Song
+// Felix Fietkau
+// Felix Janda
+// Gianluca Anzolin
+// Hauke Mehrtens
+// He X
+// Hiltjo Posthuma
+// Isaac Dunham
+// Jaydeep Patil
+// Jens Gustedt
+// Jeremy Huntwork
+// Jo-Philipp Wich
+// Joakim Sindholt
+// John Spencer
+// Julien Ramseier
+// Justin Cormack
+// Kaarle Ritvanen
+// Khem Raj
+// Kylie McClain
+// Leah Neukirchen
+// Luca Barbato
+// Luka Perkov
+// M Farkas-Dyck (Strake)
+// Mahesh Bodapati
+// Markus Wichmann
+// Masanori Ogino
+// Michael Clark
+// Michael Forney
+// Mikhail Kremnyov
+// Natanael Copa
+// Nicholas J. Kain
+// orc
+// Pascal Cuoq
+// Patrick Oppenlander
+// Petr Hosek
+// Petr Skocik
+// Pierre Carrier
+// Reini Urban
+// Rich Felker
+// Richard Pennington
+// Ryan Fairfax
+// Samuel Holland
+// Segev Finer
+// Shiz
+// sin
+// Solar Designer
+// Stefan Kristiansson
+// Stefan O'Rear
+// Szabolcs Nagy
+// Timo Teräs
+// Trutz Behn
+// Valentin Ochs
+// Will Dietz
+// William Haddon
+// William Pitcock
+//
+// Portions of this software are derived from third-party works licensed
+// under terms compatible with the above MIT license:
+//
+// The TRE regular expression implementation (src/regex/reg* and
+// src/regex/tre*) is Copyright © 2001-2008 Ville Laurikari and licensed
+// under a 2-clause BSD license (license text in the source files). The
+// included version has been heavily modified by Rich Felker in 2012, in
+// the interests of size, simplicity, and namespace cleanliness.
+//
+// Much of the math library code (src/math/* and src/complex/*) is
+// Copyright © 1993,2004 Sun Microsystems or
+// Copyright © 2003-2011 David Schultz or
+// Copyright © 2003-2009 Steven G. Kargl or
+// Copyright © 2003-2009 Bruce D. Evans or
+// Copyright © 2008 Stephen L. Moshier or
+// Copyright © 2017-2018 Arm Limited
+// and labelled as such in comments in the individual source files. All
+// have been licensed under extremely permissive terms.
+//
+// The ARM memcpy code (src/string/arm/memcpy.S) is Copyright © 2008
+// The Android Open Source Project and is licensed under a two-clause BSD
+// license. It was taken from Bionic libc, used on Android.
+//
+// The AArch64 memcpy and memset code (src/string/aarch64/*) are
+// Copyright © 1999-2019, Arm Limited.
+//
+// The implementation of DES for crypt (src/crypt/crypt_des.c) is
+// Copyright © 1994 David Burren. It is licensed under a BSD license.
+//
+// The implementation of blowfish crypt (src/crypt/crypt_blowfish.c) was
+// originally written by Solar Designer and placed into the public
+// domain. The code also comes with a fallback permissive license for use
+// in jurisdictions that may not recognize the public domain.
+//
+// The smoothsort implementation (src/stdlib/qsort.c) is Copyright © 2011
+// Valentin Ochs and is licensed under an MIT-style license.
+//
+// The x86_64 port was written by Nicholas J. Kain and is licensed under
+// the standard MIT terms.
+//
+// The mips and microblaze ports were originally written by Richard
+// Pennington for use in the ellcc project. The original code was adapted
+// by Rich Felker for build system and code conventions during upstream
+// integration. It is licensed under the standard MIT terms.
+//
+// The mips64 port was contributed by Imagination Technologies and is
+// licensed under the standard MIT terms.
+//
+// The powerpc port was also originally written by Richard Pennington,
+// and later supplemented and integrated by John Spencer. It is licensed
+// under the standard MIT terms.
+//
+// All other files which have no copyright comments are original works
+// produced specifically for use as part of this library, written either
+// by Rich Felker, the main author of the library, or by one or more
+// contibutors listed above. Details on authorship of individual files
+// can be found in the git version control history of the project. The
+// omission of copyright and license comments in each file is in the
+// interest of source tree size.
+//
+// In addition, permission is hereby granted for all public header files
+// (include/* and arch/*/bits/*) and crt files intended to be linked into
+// applications (crt/*, ldso/dlstart.c, and arch/*/crt_arch.h) to omit
+// the copyright notice and permission notice otherwise required by the
+// license, and to use these files without any requirement of
+// attribution. These files include substantial contributions from:
+//
+// Bobby Bingham
+// John Spencer
+// Nicholas J. Kain
+// Rich Felker
+// Richard Pennington
+// Stefan Kristiansson
+// Szabolcs Nagy
+//
+// all of whom have explicitly granted such permission.
+//
+// This file previously contained text expressing a belief that most of
+// the files covered by the above exception were sufficiently trivial not
+// to be subject to copyright, resulting in confusion over whether it
+// negated the permissions granted in the license. In the spirit of
+// permissive licensing, and of not having licensing issues being an
+// obstacle to adoption, that text has been removed.
+
+
+use std::fmt;
+
+/// A date/time type which exists primarily to convert `SystemTime` timestamps into an ISO 8601
+/// formatted string.
+///
+/// Yes, this exists. Before you have a heart attack, understand that the meat of this is musl's
+/// [`__secs_to_tm`][1] converted to Rust via [c2rust][2] and then cleaned up by hand as part of
+/// the [kudu-rs project][3], [released under MIT][4].
+///
+/// [1] http://git.musl-libc.org/cgit/musl/tree/src/time/__secs_to_tm.c
+/// [2] https://c2rust.com/
+/// [3] https://github.com/danburkert/kudu-rs/blob/c9660067e5f4c1a54143f169b5eeb49446f82e54/src/timestamp.rs#L5-L18
+/// [4] https://github.com/tokio-rs/tracing/issues/1644#issuecomment-963888244
+///
+/// All existing `strftime`-like APIs I found were unable to handle the full range of timestamps representable
+/// by `SystemTime`, including `strftime` itself, since tm.tm_year is an int.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub(crate) struct DateTime {
+ year: i64,
+ month: u8,
+ day: u8,
+ hour: u8,
+ minute: u8,
+ second: u8,
+ nanos: u32,
+}
+
+impl fmt::Display for DateTime {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if self.year > 9999 {
+ write!(f, "+{}", self.year)?;
+ } else if self.year < 0 {
+ write!(f, "{:05}", self.year)?;
+ } else {
+ write!(f, "{:04}", self.year)?;
+ }
+
+ write!(
+ f,
+ "-{:02}-{:02}T{:02}:{:02}:{:02}.{:06}Z",
+ self.month,
+ self.day,
+ self.hour,
+ self.minute,
+ self.second,
+ self.nanos / 1_000
+ )
+ }
+}
+
+impl From<std::time::SystemTime> for DateTime {
+ fn from(timestamp: std::time::SystemTime) -> DateTime {
+ let (t, nanos) = match timestamp.duration_since(std::time::UNIX_EPOCH) {
+ Ok(duration) => {
+ debug_assert!(duration.as_secs() <= std::i64::MAX as u64);
+ (duration.as_secs() as i64, duration.subsec_nanos())
+ }
+ Err(error) => {
+ let duration = error.duration();
+ debug_assert!(duration.as_secs() <= std::i64::MAX as u64);
+ let (secs, nanos) = (duration.as_secs() as i64, duration.subsec_nanos());
+ if nanos == 0 {
+ (-secs, 0)
+ } else {
+ (-secs - 1, 1_000_000_000 - nanos)
+ }
+ }
+ };
+
+ // 2000-03-01 (mod 400 year, immediately after feb29
+ const LEAPOCH: i64 = 946_684_800 + 86400 * (31 + 29);
+ const DAYS_PER_400Y: i32 = 365 * 400 + 97;
+ const DAYS_PER_100Y: i32 = 365 * 100 + 24;
+ const DAYS_PER_4Y: i32 = 365 * 4 + 1;
+ static DAYS_IN_MONTH: [i8; 12] = [31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31, 29];
+
+ // Note(dcb): this bit is rearranged slightly to avoid integer overflow.
+ let mut days: i64 = (t / 86_400) - (LEAPOCH / 86_400);
+ let mut remsecs: i32 = (t % 86_400) as i32;
+ if remsecs < 0i32 {
+ remsecs += 86_400;
+ days -= 1
+ }
+
+ let mut qc_cycles: i32 = (days / i64::from(DAYS_PER_400Y)) as i32;
+ let mut remdays: i32 = (days % i64::from(DAYS_PER_400Y)) as i32;
+ if remdays < 0 {
+ remdays += DAYS_PER_400Y;
+ qc_cycles -= 1;
+ }
+
+ let mut c_cycles: i32 = remdays / DAYS_PER_100Y;
+ if c_cycles == 4 {
+ c_cycles -= 1;
+ }
+ remdays -= c_cycles * DAYS_PER_100Y;
+
+ let mut q_cycles: i32 = remdays / DAYS_PER_4Y;
+ if q_cycles == 25 {
+ q_cycles -= 1;
+ }
+ remdays -= q_cycles * DAYS_PER_4Y;
+
+ let mut remyears: i32 = remdays / 365;
+ if remyears == 4 {
+ remyears -= 1;
+ }
+ remdays -= remyears * 365;
+
+ let mut years: i64 = i64::from(remyears)
+ + 4 * i64::from(q_cycles)
+ + 100 * i64::from(c_cycles)
+ + 400 * i64::from(qc_cycles);
+
+ let mut months: i32 = 0;
+ while i32::from(DAYS_IN_MONTH[months as usize]) <= remdays {
+ remdays -= i32::from(DAYS_IN_MONTH[months as usize]);
+ months += 1
+ }
+
+ if months >= 10 {
+ months -= 12;
+ years += 1;
+ }
+
+ DateTime {
+ year: years + 2000,
+ month: (months + 3) as u8,
+ day: (remdays + 1) as u8,
+ hour: (remsecs / 3600) as u8,
+ minute: (remsecs / 60 % 60) as u8,
+ second: (remsecs % 60) as u8,
+ nanos,
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use std::i32;
+ use std::time::{Duration, UNIX_EPOCH};
+
+ use super::*;
+
+ #[test]
+ fn test_datetime() {
+ let case = |expected: &str, secs: i64, micros: u32| {
+ let timestamp = if secs >= 0 {
+ UNIX_EPOCH + Duration::new(secs as u64, micros * 1_000)
+ } else {
+ (UNIX_EPOCH - Duration::new(!secs as u64 + 1, 0)) + Duration::new(0, micros * 1_000)
+ };
+ assert_eq!(
+ expected,
+ format!("{}", DateTime::from(timestamp)),
+ "secs: {}, micros: {}",
+ secs,
+ micros
+ )
+ };
+
+ // Mostly generated with:
+ // - date -jur <secs> +"%Y-%m-%dT%H:%M:%S.000000Z"
+ // - http://unixtimestamp.50x.eu/
+
+ case("1970-01-01T00:00:00.000000Z", 0, 0);
+
+ case("1970-01-01T00:00:00.000001Z", 0, 1);
+ case("1970-01-01T00:00:00.500000Z", 0, 500_000);
+ case("1970-01-01T00:00:01.000001Z", 1, 1);
+ case("1970-01-01T00:01:01.000001Z", 60 + 1, 1);
+ case("1970-01-01T01:01:01.000001Z", 60 * 60 + 60 + 1, 1);
+ case(
+ "1970-01-02T01:01:01.000001Z",
+ 24 * 60 * 60 + 60 * 60 + 60 + 1,
+ 1,
+ );
+
+ case("1969-12-31T23:59:59.000000Z", -1, 0);
+ case("1969-12-31T23:59:59.000001Z", -1, 1);
+ case("1969-12-31T23:59:59.500000Z", -1, 500_000);
+ case("1969-12-31T23:58:59.000001Z", -60 - 1, 1);
+ case("1969-12-31T22:58:59.000001Z", -60 * 60 - 60 - 1, 1);
+ case(
+ "1969-12-30T22:58:59.000001Z",
+ -24 * 60 * 60 - 60 * 60 - 60 - 1,
+ 1,
+ );
+
+ case("2038-01-19T03:14:07.000000Z", std::i32::MAX as i64, 0);
+ case("2038-01-19T03:14:08.000000Z", std::i32::MAX as i64 + 1, 0);
+ case("1901-12-13T20:45:52.000000Z", i32::MIN as i64, 0);
+ case("1901-12-13T20:45:51.000000Z", i32::MIN as i64 - 1, 0);
+
+ // Skipping these tests on windows as std::time::SysteTime range is low
+ // on Windows compared with that of Unix which can cause the following
+ // high date value tests to panic
+ #[cfg(not(target_os = "windows"))]
+ {
+ case("+292277026596-12-04T15:30:07.000000Z", std::i64::MAX, 0);
+ case("+292277026596-12-04T15:30:06.000000Z", std::i64::MAX - 1, 0);
+ case("-292277022657-01-27T08:29:53.000000Z", i64::MIN + 1, 0);
+ }
+
+ case("1900-01-01T00:00:00.000000Z", -2208988800, 0);
+ case("1899-12-31T23:59:59.000000Z", -2208988801, 0);
+ case("0000-01-01T00:00:00.000000Z", -62167219200, 0);
+ case("-0001-12-31T23:59:59.000000Z", -62167219201, 0);
+
+ case("1234-05-06T07:08:09.000000Z", -23215049511, 0);
+ case("-1234-05-06T07:08:09.000000Z", -101097651111, 0);
+ case("2345-06-07T08:09:01.000000Z", 11847456541, 0);
+ case("-2345-06-07T08:09:01.000000Z", -136154620259, 0);
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/time/mod.rs b/crates/tracing-subscriber/src/fmt/time/mod.rs
new file mode 100644
index 0000000..48f34d1
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/time/mod.rs
@@ -0,0 +1,151 @@
+//! Formatters for event timestamps.
+use crate::fmt::format::Writer;
+use std::fmt;
+use std::time::Instant;
+
+mod datetime;
+
+#[cfg(feature = "time")]
+mod time_crate;
+
+#[cfg(feature = "time")]
+#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
+pub use time_crate::UtcTime;
+
+#[cfg(feature = "local-time")]
+#[cfg_attr(docsrs, doc(cfg(all(unsound_local_offset, feature = "local-time"))))]
+pub use time_crate::LocalTime;
+
+#[cfg(feature = "time")]
+#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
+pub use time_crate::OffsetTime;
+
+/// [`chrono`]-based implementation for [`FormatTime`].
+#[cfg(feature = "chrono")]
+mod chrono_crate;
+
+#[cfg(feature = "chrono")]
+#[cfg_attr(docsrs, doc(cfg(feature = "chrono")))]
+pub use chrono_crate::ChronoLocal;
+
+#[cfg(feature = "chrono")]
+#[cfg_attr(docsrs, doc(cfg(feature = "chrono")))]
+pub use chrono_crate::ChronoUtc;
+
+/// A type that can measure and format the current time.
+///
+/// This trait is used by `Format` to include a timestamp with each `Event` when it is logged.
+///
+/// Notable default implementations of this trait are `SystemTime` and `()`. The former prints the
+/// current time as reported by `std::time::SystemTime`, and the latter does not print the current
+/// time at all. `FormatTime` is also automatically implemented for any function pointer with the
+/// appropriate signature.
+///
+/// The full list of provided implementations can be found in [`time`].
+///
+/// [`time`]: self
+pub trait FormatTime {
+ /// Measure and write out the current time.
+ ///
+ /// When `format_time` is called, implementors should get the current time using their desired
+ /// mechanism, and write it out to the given `fmt::Write`. Implementors must insert a trailing
+ /// space themselves if they wish to separate the time from subsequent log message text.
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result;
+}
+
+/// Returns a new `SystemTime` timestamp provider.
+///
+/// This can then be configured further to determine how timestamps should be
+/// configured.
+///
+/// This is equivalent to calling
+/// ```rust
+/// # fn timer() -> tracing_subscriber::fmt::time::SystemTime {
+/// tracing_subscriber::fmt::time::SystemTime::default()
+/// # }
+/// ```
+pub fn time() -> SystemTime {
+ SystemTime
+}
+
+/// Returns a new `Uptime` timestamp provider.
+///
+/// With this timer, timestamps will be formatted with the amount of time
+/// elapsed since the timestamp provider was constructed.
+///
+/// This can then be configured further to determine how timestamps should be
+/// configured.
+///
+/// This is equivalent to calling
+/// ```rust
+/// # fn timer() -> tracing_subscriber::fmt::time::Uptime {
+/// tracing_subscriber::fmt::time::Uptime::default()
+/// # }
+/// ```
+pub fn uptime() -> Uptime {
+ Uptime::default()
+}
+
+impl<'a, F> FormatTime for &'a F
+where
+ F: FormatTime,
+{
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ (*self).format_time(w)
+ }
+}
+
+impl FormatTime for () {
+ fn format_time(&self, _: &mut Writer<'_>) -> fmt::Result {
+ Ok(())
+ }
+}
+
+impl FormatTime for fn(&mut Writer<'_>) -> fmt::Result {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ (*self)(w)
+ }
+}
+
+/// Retrieve and print the current wall-clock time.
+#[derive(Debug, Clone, Copy, Eq, PartialEq, Default)]
+pub struct SystemTime;
+
+/// Retrieve and print the relative elapsed wall-clock time since an epoch.
+///
+/// The `Default` implementation for `Uptime` makes the epoch the current time.
+#[derive(Debug, Clone, Copy, Eq, PartialEq)]
+pub struct Uptime {
+ epoch: Instant,
+}
+
+impl Default for Uptime {
+ fn default() -> Self {
+ Uptime {
+ epoch: Instant::now(),
+ }
+ }
+}
+
+impl From<Instant> for Uptime {
+ fn from(epoch: Instant) -> Self {
+ Uptime { epoch }
+ }
+}
+
+impl FormatTime for SystemTime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ write!(
+ w,
+ "{}",
+ datetime::DateTime::from(std::time::SystemTime::now())
+ )
+ }
+}
+
+impl FormatTime for Uptime {
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ let e = self.epoch.elapsed();
+ write!(w, "{:4}.{:09}s", e.as_secs(), e.subsec_nanos())
+ }
+}
diff --git a/crates/tracing-subscriber/src/fmt/time/time_crate.rs b/crates/tracing-subscriber/src/fmt/time/time_crate.rs
new file mode 100644
index 0000000..4883db4
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/time/time_crate.rs
@@ -0,0 +1,470 @@
+use crate::fmt::{format::Writer, time::FormatTime, writer::WriteAdaptor};
+use std::fmt;
+use time::{format_description::well_known, formatting::Formattable, OffsetDateTime, UtcOffset};
+
+/// Formats the current [local time] using a [formatter] from the [`time` crate].
+///
+/// To format the current [UTC time] instead, use the [`UtcTime`] type.
+///
+/// <div class="example-wrap" style="display:inline-block">
+/// <pre class="compile_fail" style="white-space:normal;font:inherit;">
+/// <strong>Warning</strong>: The <a href = "https://docs.rs/time/0.3/time/"><code>time</code>
+/// crate</a> must be compiled with <code>--cfg unsound_local_offset</code> in order to use
+/// local timestamps. When this cfg is not enabled, local timestamps cannot be recorded, and
+/// events will be logged without timestamps.
+///
+/// Alternatively, [`OffsetTime`] can log with a local offset if it is initialized early.
+///
+/// See the <a href="https://docs.rs/time/0.3.4/time/#feature-flags"><code>time</code>
+/// documentation</a> for more details.
+/// </pre></div>
+///
+/// [local time]: time::OffsetDateTime::now_local
+/// [UTC time]: time::OffsetDateTime::now_utc
+/// [formatter]: time::formatting::Formattable
+/// [`time` crate]: time
+#[derive(Clone, Debug)]
+#[cfg_attr(
+ docsrs,
+ doc(cfg(all(unsound_local_offset, feature = "time", feature = "local-time")))
+)]
+#[cfg(feature = "local-time")]
+pub struct LocalTime<F> {
+ format: F,
+}
+
+/// Formats the current [UTC time] using a [formatter] from the [`time` crate].
+///
+/// To format the current [local time] instead, use the [`LocalTime`] type.
+///
+/// [local time]: time::OffsetDateTime::now_local
+/// [UTC time]: time::OffsetDateTime::now_utc
+/// [formatter]: time::formatting::Formattable
+/// [`time` crate]: time
+#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
+#[derive(Clone, Debug)]
+pub struct UtcTime<F> {
+ format: F,
+}
+
+/// Formats the current time using a fixed offset and a [formatter] from the [`time` crate].
+///
+/// This is typically used as an alternative to [`LocalTime`]. `LocalTime` determines the offset
+/// every time it formats a message, which may be unsound or fail. With `OffsetTime`, the offset is
+/// determined once. This makes it possible to do so while the program is still single-threaded and
+/// handle any errors. However, this also means the offset cannot change while the program is
+/// running (the offset will not change across DST changes).
+///
+/// [formatter]: time::formatting::Formattable
+/// [`time` crate]: time
+#[derive(Clone, Debug)]
+#[cfg_attr(docsrs, doc(cfg(feature = "time")))]
+pub struct OffsetTime<F> {
+ offset: time::UtcOffset,
+ format: F,
+}
+
+// === impl LocalTime ===
+
+#[cfg(feature = "local-time")]
+impl LocalTime<well_known::Rfc3339> {
+ /// Returns a formatter that formats the current [local time] in the
+ /// [RFC 3339] format (a subset of the [ISO 8601] timestamp format).
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time};
+ ///
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(time::LocalTime::rfc_3339());
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// [local time]: time::OffsetDateTime::now_local
+ /// [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339
+ /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
+ pub fn rfc_3339() -> Self {
+ Self::new(well_known::Rfc3339)
+ }
+}
+
+#[cfg(feature = "local-time")]
+impl<F: Formattable> LocalTime<F> {
+ /// Returns a formatter that formats the current [local time] using the
+ /// [`time` crate] with the provided provided format. The format may be any
+ /// type that implements the [`Formattable`] trait.
+ ///
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="compile_fail" style="white-space:normal;font:inherit;">
+ /// <strong>Warning</strong>: The <a href = "https://docs.rs/time/0.3/time/">
+ /// <code>time</code> crate</a> must be compiled with <code>--cfg
+ /// unsound_local_offset</code> in order to use local timestamps. When this
+ /// cfg is not enabled, local timestamps cannot be recorded, and
+ /// events will be logged without timestamps.
+ ///
+ /// See the <a href="https://docs.rs/time/0.3.4/time/#feature-flags">
+ /// <code>time</code> documentation</a> for more details.
+ /// </pre></div>
+ ///
+ /// Typically, the format will be a format description string, or one of the
+ /// `time` crate's [well-known formats].
+ ///
+ /// If the format description is statically known, then the
+ /// [`format_description!`] macro should be used. This is identical to the
+ /// [`time::format_description::parse`] method, but runs at compile-time,
+ /// throwing an error if the format description is invalid. If the desired format
+ /// is not known statically (e.g., a user is providing a format string), then the
+ /// [`time::format_description::parse`] method should be used. Note that this
+ /// method is fallible.
+ ///
+ /// See the [`time` book] for details on the format description syntax.
+ ///
+ /// # Examples
+ ///
+ /// Using the [`format_description!`] macro:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::LocalTime};
+ /// use time::macros::format_description;
+ ///
+ /// let timer = LocalTime::new(format_description!("[hour]:[minute]:[second]"));
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using [`time::format_description::parse`]:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::LocalTime};
+ ///
+ /// let time_format = time::format_description::parse("[hour]:[minute]:[second]")
+ /// .expect("format string should be valid!");
+ /// let timer = LocalTime::new(time_format);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using the [`format_description!`] macro requires enabling the `time`
+ /// crate's "macros" feature flag.
+ ///
+ /// Using a [well-known format][well-known formats] (this is equivalent to
+ /// [`LocalTime::rfc_3339`]):
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::LocalTime};
+ ///
+ /// let timer = LocalTime::new(time::format_description::well_known::Rfc3339);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// [local time]: time::OffsetDateTime::now_local()
+ /// [`time` crate]: time
+ /// [`Formattable`]: time::formatting::Formattable
+ /// [well-known formats]: time::format_description::well_known
+ /// [`format_description!`]: time::macros::format_description!
+ /// [`time::format_description::parse`]: time::format_description::parse()
+ /// [`time` book]: https://time-rs.github.io/book/api/format-description.html
+ pub fn new(format: F) -> Self {
+ Self { format }
+ }
+}
+
+#[cfg(feature = "local-time")]
+impl<F> FormatTime for LocalTime<F>
+where
+ F: Formattable,
+{
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ let now = OffsetDateTime::now_local().map_err(|_| fmt::Error)?;
+ format_datetime(now, w, &self.format)
+ }
+}
+
+#[cfg(feature = "local-time")]
+impl<F> Default for LocalTime<F>
+where
+ F: Formattable + Default,
+{
+ fn default() -> Self {
+ Self::new(F::default())
+ }
+}
+
+// === impl UtcTime ===
+
+impl UtcTime<well_known::Rfc3339> {
+ /// Returns a formatter that formats the current [UTC time] in the
+ /// [RFC 3339] format, which is a subset of the [ISO 8601] timestamp format.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time};
+ ///
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(time::UtcTime::rfc_3339());
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// [local time]: time::OffsetDateTime::now_utc
+ /// [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339
+ /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
+ pub fn rfc_3339() -> Self {
+ Self::new(well_known::Rfc3339)
+ }
+}
+
+impl<F: Formattable> UtcTime<F> {
+ /// Returns a formatter that formats the current [UTC time] using the
+ /// [`time` crate], with the provided provided format. The format may be any
+ /// type that implements the [`Formattable`] trait.
+ ///
+ /// Typically, the format will be a format description string, or one of the
+ /// `time` crate's [well-known formats].
+ ///
+ /// If the format description is statically known, then the
+ /// [`format_description!`] macro should be used. This is identical to the
+ /// [`time::format_description::parse`] method, but runs at compile-time,
+ /// failing an error if the format description is invalid. If the desired format
+ /// is not known statically (e.g., a user is providing a format string), then the
+ /// [`time::format_description::parse`] method should be used. Note that this
+ /// method is fallible.
+ ///
+ /// See the [`time` book] for details on the format description syntax.
+ ///
+ /// # Examples
+ ///
+ /// Using the [`format_description!`] macro:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::UtcTime};
+ /// use time::macros::format_description;
+ ///
+ /// let timer = UtcTime::new(format_description!("[hour]:[minute]:[second]"));
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using the [`format_description!`] macro requires enabling the `time`
+ /// crate's "macros" feature flag.
+ ///
+ /// Using [`time::format_description::parse`]:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::UtcTime};
+ ///
+ /// let time_format = time::format_description::parse("[hour]:[minute]:[second]")
+ /// .expect("format string should be valid!");
+ /// let timer = UtcTime::new(time_format);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using a [well-known format][well-known formats] (this is equivalent to
+ /// [`UtcTime::rfc_3339`]):
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::UtcTime};
+ ///
+ /// let timer = UtcTime::new(time::format_description::well_known::Rfc3339);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// [UTC time]: time::OffsetDateTime::now_utc()
+ /// [`time` crate]: time
+ /// [`Formattable`]: time::formatting::Formattable
+ /// [well-known formats]: time::format_description::well_known
+ /// [`format_description!`]: time::macros::format_description!
+ /// [`time::format_description::parse`]: time::format_description::parse
+ /// [`time` book]: https://time-rs.github.io/book/api/format-description.html
+ pub fn new(format: F) -> Self {
+ Self { format }
+ }
+}
+
+impl<F> FormatTime for UtcTime<F>
+where
+ F: Formattable,
+{
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ format_datetime(OffsetDateTime::now_utc(), w, &self.format)
+ }
+}
+
+impl<F> Default for UtcTime<F>
+where
+ F: Formattable + Default,
+{
+ fn default() -> Self {
+ Self::new(F::default())
+ }
+}
+
+// === impl OffsetTime ===
+
+#[cfg(feature = "local-time")]
+impl OffsetTime<well_known::Rfc3339> {
+ /// Returns a formatter that formats the current time using the [local time offset] in the [RFC
+ /// 3339] format (a subset of the [ISO 8601] timestamp format).
+ ///
+ /// Returns an error if the local time offset cannot be determined. This typically occurs in
+ /// multithreaded programs. To avoid this problem, initialize `OffsetTime` before forking
+ /// threads. When using Tokio, this means initializing `OffsetTime` before the Tokio runtime.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time};
+ ///
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(time::OffsetTime::local_rfc_3339().expect("could not get local offset!"));
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using `OffsetTime` with Tokio:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::time::OffsetTime;
+ ///
+ /// #[tokio::main]
+ /// async fn run() {
+ /// tracing::info!("runtime initialized");
+ ///
+ /// // At this point the Tokio runtime is initialized, and we can use both Tokio and Tracing
+ /// // normally.
+ /// }
+ ///
+ /// fn main() {
+ /// // Because we need to get the local offset before Tokio spawns any threads, our `main`
+ /// // function cannot use `tokio::main`.
+ /// tracing_subscriber::fmt()
+ /// .with_timer(OffsetTime::local_rfc_3339().expect("could not get local time offset"))
+ /// .init();
+ ///
+ /// // Even though `run` is written as an `async fn`, because we used `tokio::main` on it
+ /// // we can call it as a synchronous function.
+ /// run();
+ /// }
+ /// ```
+ ///
+ /// [local time offset]: time::UtcOffset::current_local_offset
+ /// [RFC 3339]: https://datatracker.ietf.org/doc/html/rfc3339
+ /// [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
+ pub fn local_rfc_3339() -> Result<Self, time::error::IndeterminateOffset> {
+ Ok(Self::new(
+ UtcOffset::current_local_offset()?,
+ well_known::Rfc3339,
+ ))
+ }
+}
+
+impl<F: time::formatting::Formattable> OffsetTime<F> {
+ /// Returns a formatter that formats the current time using the [`time` crate] with the provided
+ /// provided format and [timezone offset]. The format may be any type that implements the
+ /// [`Formattable`] trait.
+ ///
+ ///
+ /// Typically, the offset will be the [local offset], and format will be a format description
+ /// string, or one of the `time` crate's [well-known formats].
+ ///
+ /// If the format description is statically known, then the
+ /// [`format_description!`] macro should be used. This is identical to the
+ /// [`time::format_description::parse`] method, but runs at compile-time,
+ /// throwing an error if the format description is invalid. If the desired format
+ /// is not known statically (e.g., a user is providing a format string), then the
+ /// [`time::format_description::parse`] method should be used. Note that this
+ /// method is fallible.
+ ///
+ /// See the [`time` book] for details on the format description syntax.
+ ///
+ /// # Examples
+ ///
+ /// Using the [`format_description!`] macro:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::OffsetTime};
+ /// use time::macros::format_description;
+ /// use time::UtcOffset;
+ ///
+ /// let offset = UtcOffset::current_local_offset().expect("should get local offset!");
+ /// let timer = OffsetTime::new(offset, format_description!("[hour]:[minute]:[second]"));
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using [`time::format_description::parse`]:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::OffsetTime};
+ /// use time::UtcOffset;
+ ///
+ /// let offset = UtcOffset::current_local_offset().expect("should get local offset!");
+ /// let time_format = time::format_description::parse("[hour]:[minute]:[second]")
+ /// .expect("format string should be valid!");
+ /// let timer = OffsetTime::new(offset, time_format);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// Using the [`format_description!`] macro requires enabling the `time`
+ /// crate's "macros" feature flag.
+ ///
+ /// Using a [well-known format][well-known formats] (this is equivalent to
+ /// [`OffsetTime::local_rfc_3339`]):
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::{self, time::OffsetTime};
+ /// use time::UtcOffset;
+ ///
+ /// let offset = UtcOffset::current_local_offset().expect("should get local offset!");
+ /// let timer = OffsetTime::new(offset, time::format_description::well_known::Rfc3339);
+ /// let subscriber = tracing_subscriber::fmt()
+ /// .with_timer(timer);
+ /// # drop(subscriber);
+ /// ```
+ ///
+ /// [`time` crate]: time
+ /// [timezone offset]: time::UtcOffset
+ /// [`Formattable`]: time::formatting::Formattable
+ /// [local offset]: time::UtcOffset::current_local_offset()
+ /// [well-known formats]: time::format_description::well_known
+ /// [`format_description!`]: time::macros::format_description
+ /// [`time::format_description::parse`]: time::format_description::parse
+ /// [`time` book]: https://time-rs.github.io/book/api/format-description.html
+ pub fn new(offset: time::UtcOffset, format: F) -> Self {
+ Self { offset, format }
+ }
+}
+
+impl<F> FormatTime for OffsetTime<F>
+where
+ F: time::formatting::Formattable,
+{
+ fn format_time(&self, w: &mut Writer<'_>) -> fmt::Result {
+ let now = OffsetDateTime::now_utc().to_offset(self.offset);
+ format_datetime(now, w, &self.format)
+ }
+}
+
+fn format_datetime(
+ now: OffsetDateTime,
+ into: &mut Writer<'_>,
+ fmt: &impl Formattable,
+) -> fmt::Result {
+ let mut into = WriteAdaptor::new(into);
+ now.format_into(&mut into, fmt)
+ .map_err(|_| fmt::Error)
+ .map(|_| ())
+}
diff --git a/crates/tracing-subscriber/src/fmt/writer.rs b/crates/tracing-subscriber/src/fmt/writer.rs
new file mode 100644
index 0000000..bbc1c4a
--- /dev/null
+++ b/crates/tracing-subscriber/src/fmt/writer.rs
@@ -0,0 +1,1463 @@
+//! Abstractions for creating [`io::Write`] instances.
+//!
+//! [`io::Write`]: std::io::Write
+use std::{
+ fmt,
+ io::{self, Write},
+ sync::{Arc, Mutex, MutexGuard},
+};
+use tracing_core::Metadata;
+
+/// A type that can create [`io::Write`] instances.
+///
+/// `MakeWriter` is used by [`fmt::Layer`] or [`fmt::Subscriber`] to print
+/// formatted text representations of [`Event`]s.
+///
+/// This trait is already implemented for function pointers and
+/// immutably-borrowing closures that return an instance of [`io::Write`], such
+/// as [`io::stdout`] and [`io::stderr`]. Additionally, it is implemented for
+/// [`std::sync::Mutex`] when the type inside the mutex implements
+/// [`io::Write`].
+///
+/// # Examples
+///
+/// The simplest usage is to pass in a named function that returns a writer. For
+/// example, to log all events to stderr, we could write:
+/// ```
+/// let subscriber = tracing_subscriber::fmt()
+/// .with_writer(std::io::stderr)
+/// .finish();
+/// # drop(subscriber);
+/// ```
+///
+/// Any function that returns a writer can be used:
+///
+/// ```
+/// fn make_my_great_writer() -> impl std::io::Write {
+/// // ...
+/// # std::io::stdout()
+/// }
+///
+/// let subscriber = tracing_subscriber::fmt()
+/// .with_writer(make_my_great_writer)
+/// .finish();
+/// # drop(subscriber);
+/// ```
+///
+/// A closure can be used to introduce arbitrary logic into how the writer is
+/// created. Consider the (admittedly rather silly) example of sending every 5th
+/// event to stderr, and all other events to stdout:
+///
+/// ```
+/// use std::io;
+/// use std::sync::atomic::{AtomicUsize, Ordering::Relaxed};
+///
+/// let n = AtomicUsize::new(0);
+/// let subscriber = tracing_subscriber::fmt()
+/// .with_writer(move || -> Box<dyn io::Write> {
+/// if n.fetch_add(1, Relaxed) % 5 == 0 {
+/// Box::new(io::stderr())
+/// } else {
+/// Box::new(io::stdout())
+/// }
+/// })
+/// .finish();
+/// # drop(subscriber);
+/// ```
+///
+/// A single instance of a type implementing [`io::Write`] may be used as a
+/// `MakeWriter` by wrapping it in a [`Mutex`]. For example, we could
+/// write to a file like so:
+///
+/// ```
+/// use std::{fs::File, sync::Mutex};
+///
+/// # fn docs() -> Result<(), Box<dyn std::error::Error>> {
+/// let log_file = File::create("my_cool_trace.log")?;
+/// let subscriber = tracing_subscriber::fmt()
+/// .with_writer(Mutex::new(log_file))
+/// .finish();
+/// # drop(subscriber);
+/// # Ok(())
+/// # }
+/// ```
+///
+/// [`io::Write`]: std::io::Write
+/// [`fmt::Layer`]: crate::fmt::Layer
+/// [`fmt::Subscriber`]: crate::fmt::Subscriber
+/// [`Event`]: tracing_core::event::Event
+/// [`io::stdout`]: std::io::stdout()
+/// [`io::stderr`]: std::io::stderr()
+/// [`MakeWriter::make_writer_for`]: MakeWriter::make_writer_for
+/// [`Metadata`]: tracing_core::Metadata
+/// [levels]: tracing_core::Level
+/// [targets]: tracing_core::Metadata::target
+pub trait MakeWriter<'a> {
+ /// The concrete [`io::Write`] implementation returned by [`make_writer`].
+ ///
+ /// [`io::Write`]: std::io::Write
+ /// [`make_writer`]: MakeWriter::make_writer
+ type Writer: io::Write;
+
+ /// Returns an instance of [`Writer`].
+ ///
+ /// # Implementer notes
+ ///
+ /// [`fmt::Layer`] or [`fmt::Subscriber`] will call this method each time an event is recorded. Ensure any state
+ /// that must be saved across writes is not lost when the [`Writer`] instance is dropped. If
+ /// creating a [`io::Write`] instance is expensive, be sure to cache it when implementing
+ /// [`MakeWriter`] to improve performance.
+ ///
+ /// [`Writer`]: MakeWriter::Writer
+ /// [`fmt::Layer`]: crate::fmt::Layer
+ /// [`fmt::Subscriber`]: crate::fmt::Subscriber
+ /// [`io::Write`]: std::io::Write
+ fn make_writer(&'a self) -> Self::Writer;
+
+ /// Returns a [`Writer`] for writing data from the span or event described
+ /// by the provided [`Metadata`].
+ ///
+ /// By default, this calls [`self.make_writer()`][make_writer], ignoring
+ /// the provided metadata, but implementations can override this to provide
+ /// metadata-specific behaviors.
+ ///
+ /// This method allows `MakeWriter` implementations to implement different
+ /// behaviors based on the span or event being written. The `MakeWriter`
+ /// type might return different writers based on the provided metadata, or
+ /// might write some values to the writer before or after providing it to
+ /// the caller.
+ ///
+ /// For example, we might want to write data from spans and events at the
+ /// [`ERROR`] and [`WARN`] levels to `stderr`, and data from spans or events
+ /// at lower levels to stdout:
+ ///
+ /// ```
+ /// use std::io::{self, Stdout, Stderr, StdoutLock, StderrLock};
+ /// use tracing_subscriber::fmt::writer::MakeWriter;
+ /// use tracing_core::{Metadata, Level};
+ ///
+ /// pub struct MyMakeWriter {
+ /// stdout: Stdout,
+ /// stderr: Stderr,
+ /// }
+ ///
+ /// /// A lock on either stdout or stderr, depending on the verbosity level
+ /// /// of the event being written.
+ /// pub enum StdioLock<'a> {
+ /// Stdout(StdoutLock<'a>),
+ /// Stderr(StderrLock<'a>),
+ /// }
+ ///
+ /// impl<'a> io::Write for StdioLock<'a> {
+ /// fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ /// match self {
+ /// StdioLock::Stdout(lock) => lock.write(buf),
+ /// StdioLock::Stderr(lock) => lock.write(buf),
+ /// }
+ /// }
+ ///
+ /// fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
+ /// // ...
+ /// # match self {
+ /// # StdioLock::Stdout(lock) => lock.write_all(buf),
+ /// # StdioLock::Stderr(lock) => lock.write_all(buf),
+ /// # }
+ /// }
+ ///
+ /// fn flush(&mut self) -> io::Result<()> {
+ /// // ...
+ /// # match self {
+ /// # StdioLock::Stdout(lock) => lock.flush(),
+ /// # StdioLock::Stderr(lock) => lock.flush(),
+ /// # }
+ /// }
+ /// }
+ ///
+ /// impl<'a> MakeWriter<'a> for MyMakeWriter {
+ /// type Writer = StdioLock<'a>;
+ ///
+ /// fn make_writer(&'a self) -> Self::Writer {
+ /// // We must have an implementation of `make_writer` that makes
+ /// // a "default" writer without any configuring metadata. Let's
+ /// // just return stdout in that case.
+ /// StdioLock::Stdout(self.stdout.lock())
+ /// }
+ ///
+ /// fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ /// // Here's where we can implement our special behavior. We'll
+ /// // check if the metadata's verbosity level is WARN or ERROR,
+ /// // and return stderr in that case.
+ /// if meta.level() <= &Level::WARN {
+ /// return StdioLock::Stderr(self.stderr.lock());
+ /// }
+ ///
+ /// // Otherwise, we'll return stdout.
+ /// StdioLock::Stdout(self.stdout.lock())
+ /// }
+ /// }
+ /// ```
+ ///
+ /// [`Writer`]: MakeWriter::Writer
+ /// [`Metadata`]: tracing_core::Metadata
+ /// [make_writer]: MakeWriter::make_writer
+ /// [`WARN`]: tracing_core::Level::WARN
+ /// [`ERROR`]: tracing_core::Level::ERROR
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ let _ = meta;
+ self.make_writer()
+ }
+}
+
+/// Extension trait adding combinators for working with types implementing
+/// [`MakeWriter`].
+///
+/// This is not intended to be implemented directly for user-defined
+/// [`MakeWriter`]s; instead, it should be imported when the desired methods are
+/// used.
+pub trait MakeWriterExt<'a>: MakeWriter<'a> {
+ /// Wraps `self` and returns a [`MakeWriter`] that will only write output
+ /// for events at or below the provided verbosity [`Level`]. For instance,
+ /// `Level::TRACE` is considered to be _more verbose` than `Level::INFO`.
+ ///
+ /// Events whose level is more verbose than `level` will be ignored, and no
+ /// output will be written.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing::Level;
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ ///
+ /// // Construct a writer that outputs events to `stderr` only if the span or
+ /// // event's level is >= WARN (WARN and ERROR).
+ /// let mk_writer = std::io::stderr.with_max_level(Level::WARN);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ ///
+ /// Writing the `ERROR` and `WARN` levels to `stderr`, and everything else
+ /// to `stdout`:
+ ///
+ /// ```
+ /// # use tracing::Level;
+ /// # use tracing_subscriber::fmt::writer::MakeWriterExt;
+ ///
+ /// let mk_writer = std::io::stderr
+ /// .with_max_level(Level::WARN)
+ /// .or_else(std::io::stdout);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ ///
+ /// Writing the `ERROR` level to `stderr`, the `INFO` and `WARN` levels to
+ /// `stdout`, and the `INFO` and DEBUG` levels to a file:
+ ///
+ /// ```
+ /// # use tracing::Level;
+ /// # use tracing_subscriber::fmt::writer::MakeWriterExt;
+ /// use std::{sync::Arc, fs::File};
+ /// # // don't actually create the file when running the tests.
+ /// # fn docs() -> std::io::Result<()> {
+ /// let debug_log = Arc::new(File::create("debug.log")?);
+ ///
+ /// let mk_writer = std::io::stderr
+ /// .with_max_level(Level::ERROR)
+ /// .or_else(std::io::stdout
+ /// .with_max_level(Level::INFO)
+ /// .and(debug_log.with_max_level(Level::DEBUG))
+ /// );
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// # Ok(()) }
+ /// ```
+ ///
+ /// [`Level`]: tracing_core::Level
+ /// [`io::Write`]: std::io::Write
+ fn with_max_level(self, level: tracing_core::Level) -> WithMaxLevel<Self>
+ where
+ Self: Sized,
+ {
+ WithMaxLevel::new(self, level)
+ }
+
+ /// Wraps `self` and returns a [`MakeWriter`] that will only write output
+ /// for events at or above the provided verbosity [`Level`].
+ ///
+ /// Events whose level is less verbose than `level` will be ignored, and no
+ /// output will be written.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing::Level;
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ ///
+ /// // Construct a writer that outputs events to `stdout` only if the span or
+ /// // event's level is <= DEBUG (DEBUG and TRACE).
+ /// let mk_writer = std::io::stdout.with_min_level(Level::DEBUG);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ /// This can be combined with [`MakeWriterExt::with_max_level`] to write
+ /// only within a range of levels:
+ ///
+ /// ```
+ /// # use tracing::Level;
+ /// # use tracing_subscriber::fmt::writer::MakeWriterExt;
+ /// // Only write the `DEBUG` and `INFO` levels to stdout.
+ /// let mk_writer = std::io::stdout
+ /// .with_max_level(Level::DEBUG)
+ /// .with_min_level(Level::INFO)
+ /// // Write the `WARN` and `ERROR` levels to stderr.
+ /// .and(std::io::stderr.with_min_level(Level::WARN));
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ /// [`Level`]: tracing_core::Level
+ /// [`io::Write`]: std::io::Write
+ fn with_min_level(self, level: tracing_core::Level) -> WithMinLevel<Self>
+ where
+ Self: Sized,
+ {
+ WithMinLevel::new(self, level)
+ }
+
+ /// Wraps `self` with a predicate that takes a span or event's [`Metadata`]
+ /// and returns a `bool`. The returned [`MakeWriter`]'s
+ /// [`MakeWriter::make_writer_for`] method will check the predicate to
+ /// determine if a writer should be produced for a given span or event.
+ ///
+ /// If the predicate returns `false`, the wrapped [`MakeWriter`]'s
+ /// [`make_writer_for`][mwf] will return [`OptionalWriter::none`][own].
+ /// Otherwise, it calls the wrapped [`MakeWriter`]'s
+ /// [`make_writer_for`][mwf] method, and returns the produced writer.
+ ///
+ /// This can be used to filter an output based on arbitrary [`Metadata`]
+ /// parameters.
+ ///
+ /// # Examples
+ ///
+ /// Writing events with a specific target to an HTTP access log, and other
+ /// events to stdout:
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ /// use std::{sync::Arc, fs::File};
+ /// # // don't actually create the file when running the tests.
+ /// # fn docs() -> std::io::Result<()> {
+ /// let access_log = Arc::new(File::create("access.log")?);
+ ///
+ /// let mk_writer = access_log
+ /// // Only write events with the target "http::access_log" to the
+ /// // access log file.
+ /// .with_filter(|meta| meta.target() == "http::access_log")
+ /// // Write events with all other targets to stdout.
+ /// .or_else(std::io::stdout);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// Conditionally enabling or disabling a log file:
+ /// ```
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ /// use std::{
+ /// sync::{Arc, atomic::{AtomicBool, Ordering}},
+ /// fs::File,
+ /// };
+ ///
+ /// static DEBUG_LOG_ENABLED: AtomicBool = AtomicBool::new(false);
+ ///
+ /// # // don't actually create the file when running the tests.
+ /// # fn docs() -> std::io::Result<()> {
+ /// // Create the debug log file
+ /// let debug_file = Arc::new(File::create("debug.log")?)
+ /// // Enable the debug log only if the flag is enabled.
+ /// .with_filter(|_| DEBUG_LOG_ENABLED.load(Ordering::Acquire));
+ ///
+ /// // Always write to stdout
+ /// let mk_writer = std::io::stdout
+ /// // Write to the debug file if it's enabled
+ /// .and(debug_file);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ ///
+ /// // ...
+ ///
+ /// // Later, we can toggle on or off the debug log file.
+ /// DEBUG_LOG_ENABLED.store(true, Ordering::Release);
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`Metadata`]: tracing_core::Metadata
+ /// [mwf]: MakeWriter::make_writer_for
+ /// [own]: EitherWriter::none
+ fn with_filter<F>(self, filter: F) -> WithFilter<Self, F>
+ where
+ Self: Sized,
+ F: Fn(&Metadata<'_>) -> bool,
+ {
+ WithFilter::new(self, filter)
+ }
+
+ /// Combines `self` with another type implementing [`MakeWriter`], returning
+ /// a new [`MakeWriter`] that produces [writers] that write to *both*
+ /// outputs.
+ ///
+ /// If writing to either writer returns an error, the returned writer will
+ /// return that error. However, both writers will still be written to before
+ /// the error is returned, so it is possible for one writer to fail while
+ /// the other is written to successfully.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ ///
+ /// // Construct a writer that outputs events to `stdout` *and* `stderr`.
+ /// let mk_writer = std::io::stdout.and(std::io::stderr);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ ///
+ /// `and` can be used in conjunction with filtering combinators. For
+ /// example, if we want to write to a number of outputs depending on the
+ /// level of an event, we could write:
+ ///
+ /// ```
+ /// use tracing::Level;
+ /// # use tracing_subscriber::fmt::writer::MakeWriterExt;
+ /// use std::{sync::Arc, fs::File};
+ /// # // don't actually create the file when running the tests.
+ /// # fn docs() -> std::io::Result<()> {
+ /// let debug_log = Arc::new(File::create("debug.log")?);
+ ///
+ /// // Write everything to the debug log.
+ /// let mk_writer = debug_log
+ /// // Write the `ERROR` and `WARN` levels to stderr.
+ /// .and(std::io::stderr.with_max_level(Level::WARN))
+ /// // Write `INFO` to `stdout`.
+ /// .and(std::io::stdout
+ /// .with_max_level(Level::INFO)
+ /// .with_min_level(Level::INFO)
+ /// );
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// # Ok(()) }
+ /// ```
+ ///
+ /// [writers]: std::io::Write
+ fn and<B>(self, other: B) -> Tee<Self, B>
+ where
+ Self: Sized,
+ B: MakeWriter<'a> + Sized,
+ {
+ Tee::new(self, other)
+ }
+
+ /// Combines `self` with another type implementing [`MakeWriter`], returning
+ /// a new [`MakeWriter`] that calls `other`'s [`make_writer`] if `self`'s
+ /// `make_writer` returns [`OptionalWriter::none`][own].
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use tracing::Level;
+ /// use tracing_subscriber::fmt::writer::MakeWriterExt;
+ ///
+ /// // Produces a writer that writes to `stderr` if the level is >= WARN,
+ /// // or returns `OptionalWriter::none()` otherwise.
+ /// let stderr = std::io::stderr.with_max_level(Level::WARN);
+ ///
+ /// // If the `stderr` `MakeWriter` is disabled by the max level filter,
+ /// // write to stdout instead:
+ /// let mk_writer = stderr.or_else(std::io::stdout);
+ ///
+ /// tracing_subscriber::fmt().with_writer(mk_writer).init();
+ /// ```
+ ///
+ /// [`make_writer`]: MakeWriter::make_writer
+ /// [own]: EitherWriter::none
+ fn or_else<W, B>(self, other: B) -> OrElse<Self, B>
+ where
+ Self: MakeWriter<'a, Writer = OptionalWriter<W>> + Sized,
+ B: MakeWriter<'a> + Sized,
+ W: Write,
+ {
+ OrElse::new(self, other)
+ }
+}
+
+/// A writer intended to support [`libtest`'s output capturing][capturing] for use in unit tests.
+///
+/// `TestWriter` is used by [`fmt::Subscriber`] or [`fmt::Layer`] to enable capturing support.
+///
+/// `cargo test` can only capture output from the standard library's [`print!`] macro. See
+/// [`libtest`'s output capturing][capturing] for more details about output capturing.
+///
+/// Writing to [`io::stdout`] and [`io::stderr`] produces the same results as using
+/// [`libtest`'s `--nocapture` option][nocapture] which may make the results look unreadable.
+///
+/// [`fmt::Subscriber`]: super::Subscriber
+/// [`fmt::Layer`]: super::Layer
+/// [capturing]: https://doc.rust-lang.org/book/ch11-02-running-tests.html#showing-function-output
+/// [nocapture]: https://doc.rust-lang.org/cargo/commands/cargo-test.html
+/// [`io::stdout`]: std::io::stdout
+/// [`io::stderr`]: std::io::stderr
+/// [`print!`]: std::print!
+#[derive(Default, Debug)]
+pub struct TestWriter {
+ _p: (),
+}
+
+/// A writer that erases the specific [`io::Write`] and [`MakeWriter`] types being used.
+///
+/// This is useful in cases where the concrete type of the writer cannot be known
+/// until runtime.
+///
+/// # Examples
+///
+/// A function that returns a [`Subscriber`] that will write to either stdout or stderr:
+///
+/// ```rust
+/// # use tracing::Subscriber;
+/// # use tracing_subscriber::fmt::writer::BoxMakeWriter;
+///
+/// fn dynamic_writer(use_stderr: bool) -> impl Subscriber {
+/// let writer = if use_stderr {
+/// BoxMakeWriter::new(std::io::stderr)
+/// } else {
+/// BoxMakeWriter::new(std::io::stdout)
+/// };
+///
+/// tracing_subscriber::fmt().with_writer(writer).finish()
+/// }
+/// ```
+///
+/// [`Subscriber`]: tracing::Subscriber
+/// [`io::Write`]: std::io::Write
+pub struct BoxMakeWriter {
+ inner: Box<dyn for<'a> MakeWriter<'a, Writer = Box<dyn Write + 'a>> + Send + Sync>,
+ name: &'static str,
+}
+
+/// A [writer] that is one of two types implementing [`io::Write`].
+///
+/// This may be used by [`MakeWriter`] implementations that may conditionally
+/// return one of two writers.
+///
+/// [writer]: std::io::Write
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub enum EitherWriter<A, B> {
+ /// A writer of type `A`.
+ A(A),
+ /// A writer of type `B`.
+ B(B),
+}
+
+/// A [writer] which may or may not be enabled.
+///
+/// This may be used by [`MakeWriter`] implementations that wish to
+/// conditionally enable or disable the returned writer based on a span or
+/// event's [`Metadata`].
+///
+/// [writer]: std::io::Write
+pub type OptionalWriter<T> = EitherWriter<T, std::io::Sink>;
+
+/// A [`MakeWriter`] combinator that only returns an enabled [writer] for spans
+/// and events with metadata at or below a specified verbosity [`Level`].
+///
+/// This is returned by the [`MakeWriterExt::with_max_level`] method. See the
+/// method documentation for details.
+///
+/// [writer]: std::io::Write
+/// [`Level`]: tracing_core::Level
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct WithMaxLevel<M> {
+ make: M,
+ level: tracing_core::Level,
+}
+
+/// A [`MakeWriter`] combinator that only returns an enabled [writer] for spans
+/// and events with metadata at or above a specified verbosity [`Level`].
+///
+/// This is returned by the [`MakeWriterExt::with_min_level`] method. See the
+/// method documentation for details.
+///
+/// [writer]: std::io::Write
+/// [`Level`]: tracing_core::Level
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct WithMinLevel<M> {
+ make: M,
+ level: tracing_core::Level,
+}
+
+/// A [`MakeWriter`] combinator that wraps a [`MakeWriter`] with a predicate for
+/// span and event [`Metadata`], so that the [`MakeWriter::make_writer_for`]
+/// method returns [`OptionalWriter::some`][ows] when the predicate returns `true`,
+/// and [`OptionalWriter::none`][own] when the predicate returns `false`.
+///
+/// This is returned by the [`MakeWriterExt::with_filter`] method. See the
+/// method documentation for details.
+///
+/// [`Metadata`]: tracing_core::Metadata
+/// [ows]: EitherWriter::some
+/// [own]: EitherWriter::none
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct WithFilter<M, F> {
+ make: M,
+ filter: F,
+}
+
+/// Combines a [`MakeWriter`] that returns an [`OptionalWriter`] with another
+/// [`MakeWriter`], so that the second [`MakeWriter`] is used when the first
+/// [`MakeWriter`] returns [`OptionalWriter::none`][own].
+///
+/// This is returned by the [`MakeWriterExt::or_else] method. See the
+/// method documentation for details.
+///
+/// [own]: EitherWriter::none
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct OrElse<A, B> {
+ inner: A,
+ or_else: B,
+}
+
+/// Combines two types implementing [`MakeWriter`] (or [`std::io::Write`]) to
+/// produce a writer that writes to both [`MakeWriter`]'s returned writers.
+///
+/// This is returned by the [`MakeWriterExt::and`] method. See the method
+/// documentation for details.
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct Tee<A, B> {
+ a: A,
+ b: B,
+}
+
+/// A type implementing [`io::Write`] for a [`MutexGuard`] where the type
+/// inside the [`Mutex`] implements [`io::Write`].
+///
+/// This is used by the [`MakeWriter`] implementation for [`Mutex`], because
+/// [`MutexGuard`] itself will not implement [`io::Write`] — instead, it
+/// _dereferences_ to a type implementing [`io::Write`]. Because [`MakeWriter`]
+/// requires the `Writer` type to implement [`io::Write`], it's necessary to add
+/// a newtype that forwards the trait implementation.
+///
+/// [`io::Write`]: std::io::Write
+/// [`MutexGuard`]: std::sync::MutexGuard
+/// [`Mutex`]: std::sync::Mutex
+#[derive(Debug)]
+pub struct MutexGuardWriter<'a, W>(MutexGuard<'a, W>);
+
+/// Implements [`std::io::Write`] for an [`Arc`]<W> where `&W: Write`.
+///
+/// This is an implementation detail of the [`MakeWriter`] impl for [`Arc`].
+#[derive(Clone, Debug)]
+pub struct ArcWriter<W>(Arc<W>);
+
+/// A bridge between `fmt::Write` and `io::Write`.
+///
+/// This is used by the timestamp formatting implementation for the `time`
+/// crate and by the JSON formatter. In both cases, this is needed because
+/// `tracing-subscriber`'s `FormatEvent`/`FormatTime` traits expect a
+/// `fmt::Write` implementation, while `serde_json::Serializer` and `time`'s
+/// `format_into` methods expect an `io::Write`.
+#[cfg(any(feature = "json", feature = "time"))]
+pub(in crate::fmt) struct WriteAdaptor<'a> {
+ fmt_write: &'a mut dyn fmt::Write,
+}
+
+impl<'a, F, W> MakeWriter<'a> for F
+where
+ F: Fn() -> W,
+ W: io::Write,
+{
+ type Writer = W;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ (self)()
+ }
+}
+
+impl<'a, W> MakeWriter<'a> for Arc<W>
+where
+ &'a W: io::Write + 'a,
+{
+ type Writer = &'a W;
+ fn make_writer(&'a self) -> Self::Writer {
+ self
+ }
+}
+
+impl<'a> MakeWriter<'a> for std::fs::File {
+ type Writer = &'a std::fs::File;
+ fn make_writer(&'a self) -> Self::Writer {
+ self
+ }
+}
+
+// === impl TestWriter ===
+
+impl TestWriter {
+ /// Returns a new `TestWriter` with the default configuration.
+ pub fn new() -> Self {
+ Self::default()
+ }
+}
+
+impl io::Write for TestWriter {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ let out_str = String::from_utf8_lossy(buf);
+ print!("{}", out_str);
+ Ok(buf.len())
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a> MakeWriter<'a> for TestWriter {
+ type Writer = Self;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ Self::default()
+ }
+}
+
+// === impl BoxMakeWriter ===
+
+impl BoxMakeWriter {
+ /// Constructs a `BoxMakeWriter` wrapping a type implementing [`MakeWriter`].
+ ///
+ pub fn new<M>(make_writer: M) -> Self
+ where
+ M: for<'a> MakeWriter<'a> + Send + Sync + 'static,
+ {
+ Self {
+ inner: Box::new(Boxed(make_writer)),
+ name: std::any::type_name::<M>(),
+ }
+ }
+}
+
+impl fmt::Debug for BoxMakeWriter {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_tuple("BoxMakeWriter")
+ .field(&format_args!("<{}>", self.name))
+ .finish()
+ }
+}
+
+impl<'a> MakeWriter<'a> for BoxMakeWriter {
+ type Writer = Box<dyn Write + 'a>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ self.inner.make_writer()
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ self.inner.make_writer_for(meta)
+ }
+}
+
+struct Boxed<M>(M);
+
+impl<'a, M> MakeWriter<'a> for Boxed<M>
+where
+ M: MakeWriter<'a>,
+{
+ type Writer = Box<dyn Write + 'a>;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ let w = self.0.make_writer();
+ Box::new(w)
+ }
+
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ let w = self.0.make_writer_for(meta);
+ Box::new(w)
+ }
+}
+
+// === impl Mutex/MutexGuardWriter ===
+
+impl<'a, W> MakeWriter<'a> for Mutex<W>
+where
+ W: io::Write + 'a,
+{
+ type Writer = MutexGuardWriter<'a, W>;
+
+ fn make_writer(&'a self) -> Self::Writer {
+ MutexGuardWriter(self.lock().expect("lock poisoned"))
+ }
+}
+
+impl<'a, W> io::Write for MutexGuardWriter<'a, W>
+where
+ W: io::Write,
+{
+ #[inline]
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ self.0.write(buf)
+ }
+
+ #[inline]
+ fn flush(&mut self) -> io::Result<()> {
+ self.0.flush()
+ }
+
+ #[inline]
+ fn write_vectored(&mut self, bufs: &[io::IoSlice<'_>]) -> io::Result<usize> {
+ self.0.write_vectored(bufs)
+ }
+
+ #[inline]
+ fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
+ self.0.write_all(buf)
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> io::Result<()> {
+ self.0.write_fmt(fmt)
+ }
+}
+
+// === impl EitherWriter ===
+
+impl<A, B> io::Write for EitherWriter<A, B>
+where
+ A: io::Write,
+ B: io::Write,
+{
+ #[inline]
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ match self {
+ EitherWriter::A(a) => a.write(buf),
+ EitherWriter::B(b) => b.write(buf),
+ }
+ }
+
+ #[inline]
+ fn flush(&mut self) -> io::Result<()> {
+ match self {
+ EitherWriter::A(a) => a.flush(),
+ EitherWriter::B(b) => b.flush(),
+ }
+ }
+
+ #[inline]
+ fn write_vectored(&mut self, bufs: &[io::IoSlice<'_>]) -> io::Result<usize> {
+ match self {
+ EitherWriter::A(a) => a.write_vectored(bufs),
+ EitherWriter::B(b) => b.write_vectored(bufs),
+ }
+ }
+
+ #[inline]
+ fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
+ match self {
+ EitherWriter::A(a) => a.write_all(buf),
+ EitherWriter::B(b) => b.write_all(buf),
+ }
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> io::Result<()> {
+ match self {
+ EitherWriter::A(a) => a.write_fmt(fmt),
+ EitherWriter::B(b) => b.write_fmt(fmt),
+ }
+ }
+}
+
+impl<T> OptionalWriter<T> {
+ /// Returns a [disabled writer].
+ ///
+ /// Any bytes written to the returned writer are discarded.
+ ///
+ /// This is equivalent to returning [`Option::None`].
+ ///
+ /// [disabled writer]: std::io::sink
+ #[inline]
+ pub fn none() -> Self {
+ EitherWriter::B(std::io::sink())
+ }
+
+ /// Returns an enabled writer of type `T`.
+ ///
+ /// This is equivalent to returning [`Option::Some`].
+ #[inline]
+ pub fn some(t: T) -> Self {
+ EitherWriter::A(t)
+ }
+}
+
+impl<T> From<Option<T>> for OptionalWriter<T> {
+ #[inline]
+ fn from(opt: Option<T>) -> Self {
+ match opt {
+ Some(writer) => Self::some(writer),
+ None => Self::none(),
+ }
+ }
+}
+
+// === impl WithMaxLevel ===
+
+impl<M> WithMaxLevel<M> {
+ /// Wraps the provided [`MakeWriter`] with a maximum [`Level`], so that it
+ /// returns [`OptionalWriter::none`] for spans and events whose level is
+ /// more verbose than the maximum level.
+ ///
+ /// See [`MakeWriterExt::with_max_level`] for details.
+ ///
+ /// [`Level`]: tracing_core::Level
+ pub fn new(make: M, level: tracing_core::Level) -> Self {
+ Self { make, level }
+ }
+}
+
+impl<'a, M: MakeWriter<'a>> MakeWriter<'a> for WithMaxLevel<M> {
+ type Writer = OptionalWriter<M::Writer>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ // If we don't know the level, assume it's disabled.
+ OptionalWriter::none()
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ if meta.level() <= &self.level {
+ return OptionalWriter::some(self.make.make_writer_for(meta));
+ }
+ OptionalWriter::none()
+ }
+}
+
+// === impl WithMinLevel ===
+
+impl<M> WithMinLevel<M> {
+ /// Wraps the provided [`MakeWriter`] with a minimum [`Level`], so that it
+ /// returns [`OptionalWriter::none`] for spans and events whose level is
+ /// less verbose than the maximum level.
+ ///
+ /// See [`MakeWriterExt::with_min_level`] for details.
+ ///
+ /// [`Level`]: tracing_core::Level
+ pub fn new(make: M, level: tracing_core::Level) -> Self {
+ Self { make, level }
+ }
+}
+
+impl<'a, M: MakeWriter<'a>> MakeWriter<'a> for WithMinLevel<M> {
+ type Writer = OptionalWriter<M::Writer>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ // If we don't know the level, assume it's disabled.
+ OptionalWriter::none()
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ if meta.level() >= &self.level {
+ return OptionalWriter::some(self.make.make_writer_for(meta));
+ }
+ OptionalWriter::none()
+ }
+}
+
+// ==== impl WithFilter ===
+
+impl<M, F> WithFilter<M, F> {
+ /// Wraps `make` with the provided `filter`, returning a [`MakeWriter`] that
+ /// will call `make.make_writer_for()` when `filter` returns `true` for a
+ /// span or event's [`Metadata`], and returns a [`sink`] otherwise.
+ ///
+ /// See [`MakeWriterExt::with_filter`] for details.
+ ///
+ /// [`Metadata`]: tracing_core::Metadata
+ /// [`sink`]: std::io::sink
+ pub fn new(make: M, filter: F) -> Self
+ where
+ F: Fn(&Metadata<'_>) -> bool,
+ {
+ Self { make, filter }
+ }
+}
+
+impl<'a, M, F> MakeWriter<'a> for WithFilter<M, F>
+where
+ M: MakeWriter<'a>,
+ F: Fn(&Metadata<'_>) -> bool,
+{
+ type Writer = OptionalWriter<M::Writer>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ OptionalWriter::some(self.make.make_writer())
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ if (self.filter)(meta) {
+ OptionalWriter::some(self.make.make_writer_for(meta))
+ } else {
+ OptionalWriter::none()
+ }
+ }
+}
+
+// === impl Tee ===
+
+impl<A, B> Tee<A, B> {
+ /// Combines two types implementing [`MakeWriter`], returning
+ /// a new [`MakeWriter`] that produces [writers] that write to *both*
+ /// outputs.
+ ///
+ /// See the documentation for [`MakeWriterExt::and`] for details.
+ ///
+ /// [writers]: std::io::Write
+ pub fn new(a: A, b: B) -> Self {
+ Self { a, b }
+ }
+}
+
+impl<'a, A, B> MakeWriter<'a> for Tee<A, B>
+where
+ A: MakeWriter<'a>,
+ B: MakeWriter<'a>,
+{
+ type Writer = Tee<A::Writer, B::Writer>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ Tee::new(self.a.make_writer(), self.b.make_writer())
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ Tee::new(self.a.make_writer_for(meta), self.b.make_writer_for(meta))
+ }
+}
+
+macro_rules! impl_tee {
+ ($self_:ident.$f:ident($($arg:ident),*)) => {
+ {
+ let res_a = $self_.a.$f($($arg),*);
+ let res_b = $self_.b.$f($($arg),*);
+ (res_a?, res_b?)
+ }
+ }
+}
+
+impl<A, B> io::Write for Tee<A, B>
+where
+ A: io::Write,
+ B: io::Write,
+{
+ #[inline]
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ let (a, b) = impl_tee!(self.write(buf));
+ Ok(std::cmp::max(a, b))
+ }
+
+ #[inline]
+ fn flush(&mut self) -> io::Result<()> {
+ impl_tee!(self.flush());
+ Ok(())
+ }
+
+ #[inline]
+ fn write_vectored(&mut self, bufs: &[io::IoSlice<'_>]) -> io::Result<usize> {
+ let (a, b) = impl_tee!(self.write_vectored(bufs));
+ Ok(std::cmp::max(a, b))
+ }
+
+ #[inline]
+ fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
+ impl_tee!(self.write_all(buf));
+ Ok(())
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> io::Result<()> {
+ impl_tee!(self.write_fmt(fmt));
+ Ok(())
+ }
+}
+
+// === impl OrElse ===
+
+impl<A, B> OrElse<A, B> {
+ /// Combines
+ pub fn new<'a, W>(inner: A, or_else: B) -> Self
+ where
+ A: MakeWriter<'a, Writer = OptionalWriter<W>>,
+ B: MakeWriter<'a>,
+ W: Write,
+ {
+ Self { inner, or_else }
+ }
+}
+
+impl<'a, A, B, W> MakeWriter<'a> for OrElse<A, B>
+where
+ A: MakeWriter<'a, Writer = OptionalWriter<W>>,
+ B: MakeWriter<'a>,
+ W: io::Write,
+{
+ type Writer = EitherWriter<W, B::Writer>;
+
+ #[inline]
+ fn make_writer(&'a self) -> Self::Writer {
+ match self.inner.make_writer() {
+ EitherWriter::A(writer) => EitherWriter::A(writer),
+ EitherWriter::B(_) => EitherWriter::B(self.or_else.make_writer()),
+ }
+ }
+
+ #[inline]
+ fn make_writer_for(&'a self, meta: &Metadata<'_>) -> Self::Writer {
+ match self.inner.make_writer_for(meta) {
+ EitherWriter::A(writer) => EitherWriter::A(writer),
+ EitherWriter::B(_) => EitherWriter::B(self.or_else.make_writer_for(meta)),
+ }
+ }
+}
+
+// === impl ArcWriter ===
+
+impl<W> io::Write for ArcWriter<W>
+where
+ for<'a> &'a W: io::Write,
+{
+ #[inline]
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ (&*self.0).write(buf)
+ }
+
+ #[inline]
+ fn flush(&mut self) -> io::Result<()> {
+ (&*self.0).flush()
+ }
+
+ #[inline]
+ fn write_vectored(&mut self, bufs: &[io::IoSlice<'_>]) -> io::Result<usize> {
+ (&*self.0).write_vectored(bufs)
+ }
+
+ #[inline]
+ fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
+ (&*self.0).write_all(buf)
+ }
+
+ #[inline]
+ fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> io::Result<()> {
+ (&*self.0).write_fmt(fmt)
+ }
+}
+
+// === impl WriteAdaptor ===
+
+#[cfg(any(feature = "json", feature = "time"))]
+impl<'a> WriteAdaptor<'a> {
+ pub(in crate::fmt) fn new(fmt_write: &'a mut dyn fmt::Write) -> Self {
+ Self { fmt_write }
+ }
+}
+#[cfg(any(feature = "json", feature = "time"))]
+impl<'a> io::Write for WriteAdaptor<'a> {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ let s =
+ std::str::from_utf8(buf).map_err(|e| io::Error::new(io::ErrorKind::InvalidData, e))?;
+
+ self.fmt_write
+ .write_str(s)
+ .map_err(|e| io::Error::new(io::ErrorKind::Other, e))?;
+
+ Ok(s.as_bytes().len())
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+}
+
+#[cfg(any(feature = "json", feature = "time"))]
+impl<'a> fmt::Debug for WriteAdaptor<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad("WriteAdaptor { .. }")
+ }
+}
+// === blanket impls ===
+
+impl<'a, M> MakeWriterExt<'a> for M where M: MakeWriter<'a> {}
+#[cfg(test)]
+mod test {
+ use super::*;
+ use crate::fmt::format::Format;
+ use crate::fmt::test::{MockMakeWriter, MockWriter};
+ use crate::fmt::Subscriber;
+ use std::sync::atomic::{AtomicBool, Ordering};
+ use std::sync::{Arc, Mutex};
+ use tracing::{debug, error, info, trace, warn, Level};
+ use tracing_core::dispatcher::{self, Dispatch};
+
+ fn test_writer<T>(make_writer: T, msg: &str, buf: &Mutex<Vec<u8>>)
+ where
+ T: for<'writer> MakeWriter<'writer> + Send + Sync + 'static,
+ {
+ let subscriber = {
+ #[cfg(feature = "ansi")]
+ let f = Format::default().without_time().with_ansi(false);
+ #[cfg(not(feature = "ansi"))]
+ let f = Format::default().without_time();
+ Subscriber::builder()
+ .event_format(f)
+ .with_writer(make_writer)
+ .finish()
+ };
+ let dispatch = Dispatch::from(subscriber);
+
+ dispatcher::with_default(&dispatch, || {
+ error!("{}", msg);
+ });
+
+ let expected = format!("ERROR {}: {}\n", module_path!(), msg);
+ let actual = String::from_utf8(buf.try_lock().unwrap().to_vec()).unwrap();
+ assert!(actual.contains(expected.as_str()));
+ }
+
+ fn has_lines(buf: &Mutex<Vec<u8>>, msgs: &[(tracing::Level, &str)]) {
+ let actual = String::from_utf8(buf.try_lock().unwrap().to_vec()).unwrap();
+ let mut expected_lines = msgs.iter();
+ for line in actual.lines() {
+ let line = dbg!(line).trim();
+ let (level, msg) = expected_lines
+ .next()
+ .unwrap_or_else(|| panic!("expected no more lines, but got: {:?}", line));
+ let expected = format!("{} {}: {}", level, module_path!(), msg);
+ assert_eq!(line, expected.as_str());
+ }
+ }
+
+ #[test]
+ fn custom_writer_closure() {
+ let buf = Arc::new(Mutex::new(Vec::new()));
+ let buf2 = buf.clone();
+ let make_writer = move || MockWriter::new(buf2.clone());
+ let msg = "my custom writer closure error";
+ test_writer(make_writer, msg, &buf);
+ }
+
+ #[test]
+ fn custom_writer_struct() {
+ let buf = Arc::new(Mutex::new(Vec::new()));
+ let make_writer = MockMakeWriter::new(buf.clone());
+ let msg = "my custom writer struct error";
+ test_writer(make_writer, msg, &buf);
+ }
+
+ #[test]
+ fn custom_writer_mutex() {
+ let buf = Arc::new(Mutex::new(Vec::new()));
+ let writer = MockWriter::new(buf.clone());
+ let make_writer = Mutex::new(writer);
+ let msg = "my mutex writer error";
+ test_writer(make_writer, msg, &buf);
+ }
+
+ #[test]
+ fn combinators_level_filters() {
+ let info_buf = Arc::new(Mutex::new(Vec::new()));
+ let info = MockMakeWriter::new(info_buf.clone());
+
+ let debug_buf = Arc::new(Mutex::new(Vec::new()));
+ let debug = MockMakeWriter::new(debug_buf.clone());
+
+ let warn_buf = Arc::new(Mutex::new(Vec::new()));
+ let warn = MockMakeWriter::new(warn_buf.clone());
+
+ let err_buf = Arc::new(Mutex::new(Vec::new()));
+ let err = MockMakeWriter::new(err_buf.clone());
+
+ let make_writer = info
+ .with_max_level(Level::INFO)
+ .and(debug.with_max_level(Level::DEBUG))
+ .and(warn.with_max_level(Level::WARN))
+ .and(err.with_max_level(Level::ERROR));
+
+ let c = {
+ #[cfg(feature = "ansi")]
+ let f = Format::default().without_time().with_ansi(false);
+ #[cfg(not(feature = "ansi"))]
+ let f = Format::default().without_time();
+ Subscriber::builder()
+ .event_format(f)
+ .with_writer(make_writer)
+ .with_max_level(Level::TRACE)
+ .finish()
+ };
+
+ let _s = tracing::subscriber::set_default(c);
+
+ trace!("trace");
+ debug!("debug");
+ info!("info");
+ warn!("warn");
+ error!("error");
+
+ let all_lines = [
+ (Level::TRACE, "trace"),
+ (Level::DEBUG, "debug"),
+ (Level::INFO, "info"),
+ (Level::WARN, "warn"),
+ (Level::ERROR, "error"),
+ ];
+
+ println!("max level debug");
+ has_lines(&debug_buf, &all_lines[1..]);
+
+ println!("max level info");
+ has_lines(&info_buf, &all_lines[2..]);
+
+ println!("max level warn");
+ has_lines(&warn_buf, &all_lines[3..]);
+
+ println!("max level error");
+ has_lines(&err_buf, &all_lines[4..]);
+ }
+
+ #[test]
+ fn combinators_or_else() {
+ let some_buf = Arc::new(Mutex::new(Vec::new()));
+ let some = MockMakeWriter::new(some_buf.clone());
+
+ let or_else_buf = Arc::new(Mutex::new(Vec::new()));
+ let or_else = MockMakeWriter::new(or_else_buf.clone());
+
+ let return_some = AtomicBool::new(true);
+ let make_writer = move || {
+ if return_some.swap(false, Ordering::Relaxed) {
+ OptionalWriter::some(some.make_writer())
+ } else {
+ OptionalWriter::none()
+ }
+ };
+ let make_writer = make_writer.or_else(or_else);
+ let c = {
+ #[cfg(feature = "ansi")]
+ let f = Format::default().without_time().with_ansi(false);
+ #[cfg(not(feature = "ansi"))]
+ let f = Format::default().without_time();
+ Subscriber::builder()
+ .event_format(f)
+ .with_writer(make_writer)
+ .with_max_level(Level::TRACE)
+ .finish()
+ };
+
+ let _s = tracing::subscriber::set_default(c);
+ info!("hello");
+ info!("world");
+ info!("goodbye");
+
+ has_lines(&some_buf, &[(Level::INFO, "hello")]);
+ has_lines(
+ &or_else_buf,
+ &[(Level::INFO, "world"), (Level::INFO, "goodbye")],
+ );
+ }
+
+ #[test]
+ fn combinators_or_else_chain() {
+ let info_buf = Arc::new(Mutex::new(Vec::new()));
+ let info = MockMakeWriter::new(info_buf.clone());
+
+ let debug_buf = Arc::new(Mutex::new(Vec::new()));
+ let debug = MockMakeWriter::new(debug_buf.clone());
+
+ let warn_buf = Arc::new(Mutex::new(Vec::new()));
+ let warn = MockMakeWriter::new(warn_buf.clone());
+
+ let err_buf = Arc::new(Mutex::new(Vec::new()));
+ let err = MockMakeWriter::new(err_buf.clone());
+
+ let make_writer = err.with_max_level(Level::ERROR).or_else(
+ warn.with_max_level(Level::WARN).or_else(
+ info.with_max_level(Level::INFO)
+ .or_else(debug.with_max_level(Level::DEBUG)),
+ ),
+ );
+
+ let c = {
+ #[cfg(feature = "ansi")]
+ let f = Format::default().without_time().with_ansi(false);
+ #[cfg(not(feature = "ansi"))]
+ let f = Format::default().without_time();
+ Subscriber::builder()
+ .event_format(f)
+ .with_writer(make_writer)
+ .with_max_level(Level::TRACE)
+ .finish()
+ };
+
+ let _s = tracing::subscriber::set_default(c);
+
+ trace!("trace");
+ debug!("debug");
+ info!("info");
+ warn!("warn");
+ error!("error");
+
+ println!("max level debug");
+ has_lines(&debug_buf, &[(Level::DEBUG, "debug")]);
+
+ println!("max level info");
+ has_lines(&info_buf, &[(Level::INFO, "info")]);
+
+ println!("max level warn");
+ has_lines(&warn_buf, &[(Level::WARN, "warn")]);
+
+ println!("max level error");
+ has_lines(&err_buf, &[(Level::ERROR, "error")]);
+ }
+
+ #[test]
+ fn combinators_and() {
+ let a_buf = Arc::new(Mutex::new(Vec::new()));
+ let a = MockMakeWriter::new(a_buf.clone());
+
+ let b_buf = Arc::new(Mutex::new(Vec::new()));
+ let b = MockMakeWriter::new(b_buf.clone());
+
+ let lines = &[(Level::INFO, "hello"), (Level::INFO, "world")];
+
+ let make_writer = a.and(b);
+ let c = {
+ #[cfg(feature = "ansi")]
+ let f = Format::default().without_time().with_ansi(false);
+ #[cfg(not(feature = "ansi"))]
+ let f = Format::default().without_time();
+ Subscriber::builder()
+ .event_format(f)
+ .with_writer(make_writer)
+ .with_max_level(Level::TRACE)
+ .finish()
+ };
+
+ let _s = tracing::subscriber::set_default(c);
+ info!("hello");
+ info!("world");
+
+ has_lines(&a_buf, &lines[..]);
+ has_lines(&b_buf, &lines[..]);
+ }
+}
diff --git a/crates/tracing-subscriber/src/layer/context.rs b/crates/tracing-subscriber/src/layer/context.rs
new file mode 100644
index 0000000..4625499
--- /dev/null
+++ b/crates/tracing-subscriber/src/layer/context.rs
@@ -0,0 +1,434 @@
+use tracing_core::{metadata::Metadata, span, subscriber::Subscriber, Event};
+
+use crate::registry::{self, LookupSpan, SpanRef};
+
+#[cfg(all(feature = "registry", feature = "std"))]
+use crate::{filter::FilterId, registry::Registry};
+/// Represents information about the current context provided to [`Layer`]s by the
+/// wrapped [`Subscriber`].
+///
+/// To access [stored data] keyed by a span ID, implementors of the `Layer`
+/// trait should ensure that the `Subscriber` type parameter is *also* bound by the
+/// [`LookupSpan`]:
+///
+/// ```rust
+/// use tracing::Subscriber;
+/// use tracing_subscriber::{Layer, registry::LookupSpan};
+///
+/// pub struct MyLayer;
+///
+/// impl<S> Layer<S> for MyLayer
+/// where
+/// S: Subscriber + for<'a> LookupSpan<'a>,
+/// {
+/// // ...
+/// }
+/// ```
+///
+/// [`Layer`]: super::Layer
+/// [`Subscriber`]: tracing_core::Subscriber
+/// [stored data]: crate::registry::SpanRef
+/// [`LookupSpan`]: crate::registry::LookupSpan
+#[derive(Debug)]
+pub struct Context<'a, S> {
+ subscriber: Option<&'a S>,
+ /// The bitmask of all [`Filtered`] layers that currently apply in this
+ /// context. If there is only a single [`Filtered`] wrapping the layer that
+ /// produced this context, then this is that filter's ID. Otherwise, if we
+ /// are in a nested tree with multiple filters, this is produced by
+ /// [`and`]-ing together the [`FilterId`]s of each of the filters that wrap
+ /// the current layer.
+ ///
+ /// [`Filtered`]: crate::filter::Filtered
+ /// [`FilterId`]: crate::filter::FilterId
+ /// [`and`]: crate::filter::FilterId::and
+ #[cfg(all(feature = "registry", feature = "std"))]
+ filter: FilterId,
+}
+
+// === impl Context ===
+
+impl<'a, S> Context<'a, S>
+where
+ S: Subscriber,
+{
+ pub(super) fn new(subscriber: &'a S) -> Self {
+ Self {
+ subscriber: Some(subscriber),
+
+ #[cfg(feature = "registry")]
+ filter: FilterId::none(),
+ }
+ }
+
+ /// Returns the wrapped subscriber's view of the current span.
+ #[inline]
+ pub fn current_span(&self) -> span::Current {
+ self.subscriber
+ .map(Subscriber::current_span)
+ // TODO: this would be more correct as "unknown", so perhaps
+ // `tracing-core` should make `Current::unknown()` public?
+ .unwrap_or_else(span::Current::none)
+ }
+
+ /// Returns whether the wrapped subscriber would enable the current span.
+ #[inline]
+ pub fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ self.subscriber
+ .map(|subscriber| subscriber.enabled(metadata))
+ // If this context is `None`, we are registering a callsite, so
+ // return `true` so that the layer does not incorrectly assume that
+ // the inner subscriber has disabled this metadata.
+ // TODO(eliza): would it be more correct for this to return an `Option`?
+ .unwrap_or(true)
+ }
+
+ /// Records the provided `event` with the wrapped subscriber.
+ ///
+ /// # Notes
+ ///
+ /// - The subscriber is free to expect that the event's callsite has been
+ /// [registered][register], and may panic or fail to observe the event if this is
+ /// not the case. The `tracing` crate's macros ensure that all events are
+ /// registered, but if the event is constructed through other means, the
+ /// user is responsible for ensuring that [`register_callsite`][register]
+ /// has been called prior to calling this method.
+ /// - This does _not_ call [`enabled`] on the inner subscriber. If the
+ /// caller wishes to apply the wrapped subscriber's filter before choosing
+ /// whether to record the event, it may first call [`Context::enabled`] to
+ /// check whether the event would be enabled. This allows `Layer`s to
+ /// elide constructing the event if it would not be recorded.
+ ///
+ /// [register]: tracing_core::subscriber::Subscriber::register_callsite()
+ /// [`enabled`]: tracing_core::subscriber::Subscriber::enabled()
+ /// [`Context::enabled`]: Context::enabled()
+ #[inline]
+ pub fn event(&self, event: &Event<'_>) {
+ if let Some(subscriber) = self.subscriber {
+ subscriber.event(event);
+ }
+ }
+
+ /// Returns a [`SpanRef`] for the parent span of the given [`Event`], if
+ /// it has a parent.
+ ///
+ /// If the event has an explicitly overridden parent, this method returns
+ /// a reference to that span. If the event's parent is the current span,
+ /// this returns a reference to the current span, if there is one. If this
+ /// returns `None`, then either the event's parent was explicitly set to
+ /// `None`, or the event's parent was defined contextually, but no span
+ /// is currently entered.
+ ///
+ /// Compared to [`Context::current_span`] and [`Context::lookup_current`],
+ /// this respects overrides provided by the [`Event`].
+ ///
+ /// Compared to [`Event::parent`], this automatically falls back to the contextual
+ /// span, if required.
+ ///
+ /// ```rust
+ /// use tracing::{Event, Subscriber};
+ /// use tracing_subscriber::{
+ /// layer::{Context, Layer},
+ /// prelude::*,
+ /// registry::LookupSpan,
+ /// };
+ ///
+ /// struct PrintingLayer;
+ /// impl<S> Layer<S> for PrintingLayer
+ /// where
+ /// S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ /// {
+ /// fn on_event(&self, event: &Event, ctx: Context<S>) {
+ /// let span = ctx.event_span(event);
+ /// println!("Event in span: {:?}", span.map(|s| s.name()));
+ /// }
+ /// }
+ ///
+ /// tracing::subscriber::with_default(tracing_subscriber::registry().with(PrintingLayer), || {
+ /// tracing::info!("no span");
+ /// // Prints: Event in span: None
+ ///
+ /// let span = tracing::info_span!("span");
+ /// tracing::info!(parent: &span, "explicitly specified");
+ /// // Prints: Event in span: Some("span")
+ ///
+ /// let _guard = span.enter();
+ /// tracing::info!("contextual span");
+ /// // Prints: Event in span: Some("span")
+ /// });
+ /// ```
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ #[inline]
+ pub fn event_span(&self, event: &Event<'_>) -> Option<SpanRef<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ if event.is_root() {
+ None
+ } else if event.is_contextual() {
+ self.lookup_current()
+ } else {
+ // TODO(eliza): this should handle parent IDs
+ event.parent().and_then(|id| self.span(id))
+ }
+ }
+
+ /// Returns metadata for the span with the given `id`, if it exists.
+ ///
+ /// If this returns `None`, then no span exists for that ID (either it has
+ /// closed or the ID is invalid).
+ #[inline]
+ pub fn metadata(&self, id: &span::Id) -> Option<&'static Metadata<'static>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ let span = self.span(id)?;
+ Some(span.metadata())
+ }
+
+ /// Returns [stored data] for the span with the given `id`, if it exists.
+ ///
+ /// If this returns `None`, then no span exists for that ID (either it has
+ /// closed or the ID is invalid).
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ #[inline]
+ pub fn span(&self, id: &span::Id) -> Option<registry::SpanRef<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ let span = self.subscriber.as_ref()?.span(id)?;
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ return span.try_with_filter(self.filter);
+
+ #[cfg(not(feature = "registry"))]
+ Some(span)
+ }
+
+ /// Returns `true` if an active span exists for the given `Id`.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ #[inline]
+ pub fn exists(&self, id: &span::Id) -> bool
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.subscriber.as_ref().and_then(|s| s.span(id)).is_some()
+ }
+
+ /// Returns [stored data] for the span that the wrapped subscriber considers
+ /// to be the current.
+ ///
+ /// If this returns `None`, then we are not currently within a span.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ #[inline]
+ pub fn lookup_current(&self) -> Option<registry::SpanRef<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ let subscriber = *self.subscriber.as_ref()?;
+ let current = subscriber.current_span();
+ let id = current.id()?;
+ let span = subscriber.span(id);
+ debug_assert!(
+ span.is_some(),
+ "the subscriber should have data for the current span ({:?})!",
+ id,
+ );
+
+ // If we found a span, and our per-layer filter enables it, return that
+ // span!
+ #[cfg(all(feature = "registry", feature = "std"))]
+ {
+ if let Some(span) = span?.try_with_filter(self.filter) {
+ Some(span)
+ } else {
+ // Otherwise, the span at the *top* of the stack is disabled by
+ // per-layer filtering, but there may be additional spans in the stack.
+ //
+ // Currently, `LookupSpan` doesn't have a nice way of exposing access to
+ // the whole span stack. However, if we can downcast the innermost
+ // subscriber to a a `Registry`, we can iterate over its current span
+ // stack.
+ //
+ // TODO(eliza): when https://github.com/tokio-rs/tracing/issues/1459 is
+ // implemented, change this to use that instead...
+ self.lookup_current_filtered(subscriber)
+ }
+ }
+
+ #[cfg(not(feature = "registry"))]
+ span
+ }
+
+ /// Slow path for when the current span is disabled by PLF and we have a
+ /// registry.
+ // This is called by `lookup_current` in the case that per-layer filtering
+ // is in use. `lookup_current` is allowed to be inlined, but this method is
+ // factored out to prevent the loop and (potentially-recursive) subscriber
+ // downcasting from being inlined if `lookup_current` is inlined.
+ #[inline(never)]
+ #[cfg(all(feature = "registry", feature = "std"))]
+ fn lookup_current_filtered<'lookup>(
+ &self,
+ subscriber: &'lookup S,
+ ) -> Option<registry::SpanRef<'lookup, S>>
+ where
+ S: LookupSpan<'lookup>,
+ {
+ let registry = (subscriber as &dyn Subscriber).downcast_ref::<Registry>()?;
+ registry
+ .span_stack()
+ .iter()
+ .find_map(|id| subscriber.span(id)?.try_with_filter(self.filter))
+ }
+
+ /// Returns an iterator over the [stored data] for all the spans in the
+ /// current context, starting with the specified span and ending with the
+ /// root of the trace tree and ending with the current span.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: Compared to <a href="#method.scope"><code>scope</code></a> this
+ /// returns the spans in reverse order (from leaf to root). Use
+ /// <a href="../registry/struct.Scope.html#method.from_root"><code>Scope::from_root</code></a>
+ /// in case root-to-leaf ordering is desired.
+ /// </pre>
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ pub fn span_scope(&self, id: &span::Id) -> Option<registry::Scope<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ Some(self.span(id)?.scope())
+ }
+
+ /// Returns an iterator over the [stored data] for all the spans in the
+ /// current context, starting with the parent span of the specified event,
+ /// and ending with the root of the trace tree and ending with the current span.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: Compared to <a href="#method.scope"><code>scope</code></a> this
+ /// returns the spans in reverse order (from leaf to root). Use
+ /// <a href="../registry/struct.Scope.html#method.from_root"><code>Scope::from_root</code></a>
+ /// in case root-to-leaf ordering is desired.
+ /// </pre>
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This requires the wrapped subscriber to
+ /// implement the <a href="../registry/trait.LookupSpan.html"><code>
+ /// LookupSpan</code></a> trait. See the documentation on
+ /// <a href="./struct.Context.html"><code>Context</code>'s
+ /// declaration</a> for details.
+ /// </pre>
+ ///
+ /// [stored data]: crate::registry::SpanRef
+ pub fn event_scope(&self, event: &Event<'_>) -> Option<registry::Scope<'_, S>>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ Some(self.event_span(event)?.scope())
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ pub(crate) fn with_filter(self, filter: FilterId) -> Self {
+ // If we already have our own `FilterId`, combine it with the provided
+ // one. That way, the new `FilterId` will consider a span to be disabled
+ // if it was disabled by the given `FilterId` *or* any `FilterId`s for
+ // layers "above" us in the stack.
+ //
+ // See the doc comment for `FilterId::and` for details.
+ let filter = self.filter.and(filter);
+ Self { filter, ..self }
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ pub(crate) fn is_enabled_for(&self, span: &span::Id, filter: FilterId) -> bool
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ self.is_enabled_inner(span, filter).unwrap_or(false)
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ pub(crate) fn if_enabled_for(self, span: &span::Id, filter: FilterId) -> Option<Self>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ if self.is_enabled_inner(span, filter)? {
+ Some(self.with_filter(filter))
+ } else {
+ None
+ }
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ fn is_enabled_inner(&self, span: &span::Id, filter: FilterId) -> Option<bool>
+ where
+ S: for<'lookup> LookupSpan<'lookup>,
+ {
+ Some(self.span(span)?.is_enabled_for(filter))
+ }
+}
+
+impl<'a, S> Context<'a, S> {
+ pub(crate) fn none() -> Self {
+ Self {
+ subscriber: None,
+
+ #[cfg(feature = "registry")]
+ filter: FilterId::none(),
+ }
+ }
+}
+
+impl<'a, S> Clone for Context<'a, S> {
+ #[inline]
+ fn clone(&self) -> Self {
+ let subscriber = self.subscriber.as_ref().copied();
+ Context {
+ subscriber,
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ filter: self.filter,
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/layer/layered.rs b/crates/tracing-subscriber/src/layer/layered.rs
new file mode 100644
index 0000000..e276514
--- /dev/null
+++ b/crates/tracing-subscriber/src/layer/layered.rs
@@ -0,0 +1,554 @@
+use tracing_core::{metadata::Metadata, span, Dispatch, Event, Interest, LevelFilter, Subscriber};
+
+use crate::{
+ filter,
+ layer::{Context, Layer},
+ registry::LookupSpan,
+};
+#[cfg(all(feature = "registry", feature = "std"))]
+use crate::{filter::FilterId, registry::Registry};
+use core::{
+ any::{Any, TypeId},
+ cmp, fmt,
+ marker::PhantomData,
+};
+
+/// A [`Subscriber`] composed of a `Subscriber` wrapped by one or more
+/// [`Layer`]s.
+///
+/// [`Layer`]: crate::Layer
+/// [`Subscriber`]: tracing_core::Subscriber
+#[derive(Clone)]
+pub struct Layered<L, I, S = I> {
+ /// The layer.
+ layer: L,
+
+ /// The inner value that `self.layer` was layered onto.
+ ///
+ /// If this is also a `Layer`, then this `Layered` will implement `Layer`.
+ /// If this is a `Subscriber`, then this `Layered` will implement
+ /// `Subscriber` instead.
+ inner: I,
+
+ // These booleans are used to determine how to combine `Interest`s and max
+ // level hints when per-layer filters are in use.
+ /// Is `self.inner` a `Registry`?
+ ///
+ /// If so, when combining `Interest`s, we want to "bubble up" its
+ /// `Interest`.
+ inner_is_registry: bool,
+
+ /// Does `self.layer` have per-layer filters?
+ ///
+ /// This will be true if:
+ /// - `self.inner` is a `Filtered`.
+ /// - `self.inner` is a tree of `Layered`s where _all_ arms of those
+ /// `Layered`s have per-layer filters.
+ ///
+ /// Otherwise, if it's a `Layered` with one per-layer filter in one branch,
+ /// but a non-per-layer-filtered layer in the other branch, this will be
+ /// _false_, because the `Layered` is already handling the combining of
+ /// per-layer filter `Interest`s and max level hints with its non-filtered
+ /// `Layer`.
+ has_layer_filter: bool,
+
+ /// Does `self.inner` have per-layer filters?
+ ///
+ /// This is determined according to the same rules as
+ /// `has_layer_filter` above.
+ inner_has_layer_filter: bool,
+ _s: PhantomData<fn(S)>,
+}
+
+// === impl Layered ===
+
+impl<L, S> Layered<L, S>
+where
+ L: Layer<S>,
+ S: Subscriber,
+{
+ /// Returns `true` if this [`Subscriber`] is the same type as `T`.
+ pub fn is<T: Any>(&self) -> bool {
+ self.downcast_ref::<T>().is_some()
+ }
+
+ /// Returns some reference to this [`Subscriber`] value if it is of type `T`,
+ /// or `None` if it isn't.
+ pub fn downcast_ref<T: Any>(&self) -> Option<&T> {
+ unsafe {
+ let raw = self.downcast_raw(TypeId::of::<T>())?;
+ if raw.is_null() {
+ None
+ } else {
+ Some(&*(raw as *const T))
+ }
+ }
+ }
+}
+
+impl<L, S> Subscriber for Layered<L, S>
+where
+ L: Layer<S>,
+ S: Subscriber,
+{
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.pick_interest(self.layer.register_callsite(metadata), || {
+ self.inner.register_callsite(metadata)
+ })
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ if self.layer.enabled(metadata, self.ctx()) {
+ // if the outer layer enables the callsite metadata, ask the subscriber.
+ self.inner.enabled(metadata)
+ } else {
+ // otherwise, the callsite is disabled by the layer
+
+ // If per-layer filters are in use, and we are short-circuiting
+ // (rather than calling into the inner type), clear the current
+ // per-layer filter `enabled` state.
+ #[cfg(feature = "registry")]
+ filter::FilterState::clear_enabled();
+
+ false
+ }
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.pick_level_hint(
+ self.layer.max_level_hint(),
+ self.inner.max_level_hint(),
+ super::subscriber_is_none(&self.inner),
+ )
+ }
+
+ fn new_span(&self, span: &span::Attributes<'_>) -> span::Id {
+ let id = self.inner.new_span(span);
+ self.layer.on_new_span(span, &id, self.ctx());
+ id
+ }
+
+ fn record(&self, span: &span::Id, values: &span::Record<'_>) {
+ self.inner.record(span, values);
+ self.layer.on_record(span, values, self.ctx());
+ }
+
+ fn record_follows_from(&self, span: &span::Id, follows: &span::Id) {
+ self.inner.record_follows_from(span, follows);
+ self.layer.on_follows_from(span, follows, self.ctx());
+ }
+
+ fn event_enabled(&self, event: &Event<'_>) -> bool {
+ if self.layer.event_enabled(event, self.ctx()) {
+ // if the outer layer enables the event, ask the inner subscriber.
+ self.inner.event_enabled(event)
+ } else {
+ // otherwise, the event is disabled by this layer
+ false
+ }
+ }
+
+ fn event(&self, event: &Event<'_>) {
+ self.inner.event(event);
+ self.layer.on_event(event, self.ctx());
+ }
+
+ fn enter(&self, span: &span::Id) {
+ self.inner.enter(span);
+ self.layer.on_enter(span, self.ctx());
+ }
+
+ fn exit(&self, span: &span::Id) {
+ self.inner.exit(span);
+ self.layer.on_exit(span, self.ctx());
+ }
+
+ fn clone_span(&self, old: &span::Id) -> span::Id {
+ let new = self.inner.clone_span(old);
+ if &new != old {
+ self.layer.on_id_change(old, &new, self.ctx())
+ };
+ new
+ }
+
+ #[inline]
+ fn drop_span(&self, id: span::Id) {
+ self.try_close(id);
+ }
+
+ fn try_close(&self, id: span::Id) -> bool {
+ #[cfg(all(feature = "registry", feature = "std"))]
+ let subscriber = &self.inner as &dyn Subscriber;
+ #[cfg(all(feature = "registry", feature = "std"))]
+ let mut guard = subscriber
+ .downcast_ref::<Registry>()
+ .map(|registry| registry.start_close(id.clone()));
+ if self.inner.try_close(id.clone()) {
+ // If we have a registry's close guard, indicate that the span is
+ // closing.
+ #[cfg(all(feature = "registry", feature = "std"))]
+ {
+ if let Some(g) = guard.as_mut() {
+ g.set_closing()
+ };
+ }
+
+ self.layer.on_close(id, self.ctx());
+ true
+ } else {
+ false
+ }
+ }
+
+ #[inline]
+ fn current_span(&self) -> span::Current {
+ self.inner.current_span()
+ }
+
+ #[doc(hidden)]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ // Unlike the implementation of `Layer` for `Layered`, we don't have to
+ // handle the "magic PLF downcast marker" here. If a `Layered`
+ // implements `Subscriber`, we already know that the `inner` branch is
+ // going to contain something that doesn't have per-layer filters (the
+ // actual root `Subscriber`). Thus, a `Layered` that implements
+ // `Subscriber` will always be propagating the root subscriber's
+ // `Interest`/level hint, even if it includes a `Layer` that has
+ // per-layer filters, because it will only ever contain layers where
+ // _one_ child has per-layer filters.
+ //
+ // The complex per-layer filter detection logic is only relevant to
+ // *trees* of layers, which involve the `Layer` implementation for
+ // `Layered`, not *lists* of layers, where every `Layered` implements
+ // `Subscriber`. Of course, a linked list can be thought of as a
+ // degenerate tree...but luckily, we are able to make a type-level
+ // distinction between individual `Layered`s that are definitely
+ // list-shaped (their inner child implements `Subscriber`), and
+ // `Layered`s that might be tree-shaped (the inner child is also a
+ // `Layer`).
+
+ // If downcasting to `Self`, return a pointer to `self`.
+ if id == TypeId::of::<Self>() {
+ return Some(self as *const _ as *const ());
+ }
+
+ self.layer
+ .downcast_raw(id)
+ .or_else(|| self.inner.downcast_raw(id))
+ }
+}
+
+impl<S, A, B> Layer<S> for Layered<A, B, S>
+where
+ A: Layer<S>,
+ B: Layer<S>,
+ S: Subscriber,
+{
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ self.layer.on_register_dispatch(subscriber);
+ self.inner.on_register_dispatch(subscriber);
+ }
+
+ fn on_layer(&mut self, subscriber: &mut S) {
+ self.layer.on_layer(subscriber);
+ self.inner.on_layer(subscriber);
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.pick_interest(self.layer.register_callsite(metadata), || {
+ self.inner.register_callsite(metadata)
+ })
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ if self.layer.enabled(metadata, ctx.clone()) {
+ // if the outer subscriber enables the callsite metadata, ask the inner layer.
+ self.inner.enabled(metadata, ctx)
+ } else {
+ // otherwise, the callsite is disabled by this layer
+ false
+ }
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.pick_level_hint(
+ self.layer.max_level_hint(),
+ self.inner.max_level_hint(),
+ super::layer_is_none(&self.inner),
+ )
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ self.inner.on_new_span(attrs, id, ctx.clone());
+ self.layer.on_new_span(attrs, id, ctx);
+ }
+
+ #[inline]
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ self.inner.on_record(span, values, ctx.clone());
+ self.layer.on_record(span, values, ctx);
+ }
+
+ #[inline]
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, ctx: Context<'_, S>) {
+ self.inner.on_follows_from(span, follows, ctx.clone());
+ self.layer.on_follows_from(span, follows, ctx);
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, ctx: Context<'_, S>) -> bool {
+ if self.layer.event_enabled(event, ctx.clone()) {
+ // if the outer layer enables the event, ask the inner subscriber.
+ self.inner.event_enabled(event, ctx)
+ } else {
+ // otherwise, the event is disabled by this layer
+ false
+ }
+ }
+
+ #[inline]
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ self.inner.on_event(event, ctx.clone());
+ self.layer.on_event(event, ctx);
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.inner.on_enter(id, ctx.clone());
+ self.layer.on_enter(id, ctx);
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.inner.on_exit(id, ctx.clone());
+ self.layer.on_exit(id, ctx);
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ self.inner.on_close(id.clone(), ctx.clone());
+ self.layer.on_close(id, ctx);
+ }
+
+ #[inline]
+ fn on_id_change(&self, old: &span::Id, new: &span::Id, ctx: Context<'_, S>) {
+ self.inner.on_id_change(old, new, ctx.clone());
+ self.layer.on_id_change(old, new, ctx);
+ }
+
+ #[doc(hidden)]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ match id {
+ // If downcasting to `Self`, return a pointer to `self`.
+ id if id == TypeId::of::<Self>() => Some(self as *const _ as *const ()),
+
+ // Oh, we're looking for per-layer filters!
+ //
+ // This should only happen if we are inside of another `Layered`,
+ // and it's trying to determine how it should combine `Interest`s
+ // and max level hints.
+ //
+ // In that case, this `Layered` should be considered to be
+ // "per-layer filtered" if *both* the outer layer and the inner
+ // layer/subscriber have per-layer filters. Otherwise, this `Layered
+ // should *not* be considered per-layer filtered (even if one or the
+ // other has per layer filters). If only one `Layer` is per-layer
+ // filtered, *this* `Layered` will handle aggregating the `Interest`
+ // and level hints on behalf of its children, returning the
+ // aggregate (which is the value from the &non-per-layer-filtered*
+ // child).
+ //
+ // Yes, this rule *is* slightly counter-intuitive, but it's
+ // necessary due to a weird edge case that can occur when two
+ // `Layered`s where one side is per-layer filtered and the other
+ // isn't are `Layered` together to form a tree. If we didn't have
+ // this rule, we would actually end up *ignoring* `Interest`s from
+ // the non-per-layer-filtered layers, since both branches would
+ // claim to have PLF.
+ //
+ // If you don't understand this...that's fine, just don't mess with
+ // it. :)
+ id if filter::is_plf_downcast_marker(id) => {
+ self.layer.downcast_raw(id).and(self.inner.downcast_raw(id))
+ }
+
+ // Otherwise, try to downcast both branches normally...
+ _ => self
+ .layer
+ .downcast_raw(id)
+ .or_else(|| self.inner.downcast_raw(id)),
+ }
+ }
+}
+
+impl<'a, L, S> LookupSpan<'a> for Layered<L, S>
+where
+ S: Subscriber + LookupSpan<'a>,
+{
+ type Data = S::Data;
+
+ fn span_data(&'a self, id: &span::Id) -> Option<Self::Data> {
+ self.inner.span_data(id)
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ fn register_filter(&mut self) -> FilterId {
+ self.inner.register_filter()
+ }
+}
+
+impl<L, S> Layered<L, S>
+where
+ S: Subscriber,
+{
+ fn ctx(&self) -> Context<'_, S> {
+ Context::new(&self.inner)
+ }
+}
+
+impl<A, B, S> Layered<A, B, S>
+where
+ A: Layer<S>,
+ S: Subscriber,
+{
+ pub(super) fn new(layer: A, inner: B, inner_has_layer_filter: bool) -> Self {
+ #[cfg(all(feature = "registry", feature = "std"))]
+ let inner_is_registry = TypeId::of::<S>() == TypeId::of::<crate::registry::Registry>();
+
+ #[cfg(not(all(feature = "registry", feature = "std")))]
+ let inner_is_registry = false;
+
+ let inner_has_layer_filter = inner_has_layer_filter || inner_is_registry;
+ let has_layer_filter = filter::layer_has_plf(&layer);
+ Self {
+ layer,
+ inner,
+ has_layer_filter,
+ inner_has_layer_filter,
+ inner_is_registry,
+ _s: PhantomData,
+ }
+ }
+
+ fn pick_interest(&self, outer: Interest, inner: impl FnOnce() -> Interest) -> Interest {
+ if self.has_layer_filter {
+ return inner();
+ }
+
+ // If the outer layer has disabled the callsite, return now so that
+ // the inner layer/subscriber doesn't get its hopes up.
+ if outer.is_never() {
+ // If per-layer filters are in use, and we are short-circuiting
+ // (rather than calling into the inner type), clear the current
+ // per-layer filter interest state.
+ #[cfg(feature = "registry")]
+ filter::FilterState::take_interest();
+
+ return outer;
+ }
+
+ // The `inner` closure will call `inner.register_callsite()`. We do this
+ // before the `if` statement to ensure that the inner subscriber is
+ // informed that the callsite exists regardless of the outer layer's
+ // filtering decision.
+ let inner = inner();
+ if outer.is_sometimes() {
+ // if this interest is "sometimes", return "sometimes" to ensure that
+ // filters are reevaluated.
+ return outer;
+ }
+
+ // If there is a per-layer filter in the `inner` stack, and it returns
+ // `never`, change the interest to `sometimes`, because the `outer`
+ // layer didn't return `never`. This means that _some_ layer still wants
+ // to see that callsite, even though the inner stack's per-layer filter
+ // didn't want it. Therefore, returning `sometimes` will ensure
+ // `enabled` is called so that the per-layer filter can skip that
+ // span/event, while the `outer` layer still gets to see it.
+ if inner.is_never() && self.inner_has_layer_filter {
+ return Interest::sometimes();
+ }
+
+ // otherwise, allow the inner subscriber or subscriber to weigh in.
+ inner
+ }
+
+ fn pick_level_hint(
+ &self,
+ outer_hint: Option<LevelFilter>,
+ inner_hint: Option<LevelFilter>,
+ inner_is_none: bool,
+ ) -> Option<LevelFilter> {
+ if self.inner_is_registry {
+ return outer_hint;
+ }
+
+ if self.has_layer_filter && self.inner_has_layer_filter {
+ return Some(cmp::max(outer_hint?, inner_hint?));
+ }
+
+ if self.has_layer_filter && inner_hint.is_none() {
+ return None;
+ }
+
+ if self.inner_has_layer_filter && outer_hint.is_none() {
+ return None;
+ }
+
+ // If the layer is `Option::None`, then we
+ // want to short-circuit the layer underneath, if it
+ // returns `None`, to override the `None` layer returning
+ // `Some(OFF)`, which should ONLY apply when there are
+ // no other layers that return `None`. Note this
+ // `None` does not == `Some(TRACE)`, it means
+ // something more like: "whatever all the other
+ // layers agree on, default to `TRACE` if none
+ // have an opinion". We also choose do this AFTER
+ // we check for per-layer filters, which
+ // have their own logic.
+ //
+ // Also note that this does come at some perf cost, but
+ // this function is only called on initialization and
+ // subscriber reloading.
+ if super::layer_is_none(&self.layer) {
+ return cmp::max(outer_hint, Some(inner_hint?));
+ }
+
+ // Similarly, if the layer on the inside is `None` and it returned an
+ // `Off` hint, we want to override that with the outer hint.
+ if inner_is_none && inner_hint == Some(LevelFilter::OFF) {
+ return outer_hint;
+ }
+
+ cmp::max(outer_hint, inner_hint)
+ }
+}
+
+impl<A, B, S> fmt::Debug for Layered<A, B, S>
+where
+ A: fmt::Debug,
+ B: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ #[cfg(all(feature = "registry", feature = "std"))]
+ let alt = f.alternate();
+ let mut s = f.debug_struct("Layered");
+ // These additional fields are more verbose and usually only necessary
+ // for internal debugging purposes, so only print them if alternate mode
+ // is enabled.
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ {
+ if alt {
+ s.field("inner_is_registry", &self.inner_is_registry)
+ .field("has_layer_filter", &self.has_layer_filter)
+ .field("inner_has_layer_filter", &self.inner_has_layer_filter);
+ }
+ }
+
+ s.field("layer", &self.layer)
+ .field("inner", &self.inner)
+ .finish()
+ }
+}
diff --git a/crates/tracing-subscriber/src/layer/mod.rs b/crates/tracing-subscriber/src/layer/mod.rs
new file mode 100644
index 0000000..296de5e
--- /dev/null
+++ b/crates/tracing-subscriber/src/layer/mod.rs
@@ -0,0 +1,1909 @@
+//! The [`Layer`] trait, a composable abstraction for building [`Subscriber`]s.
+//!
+//! The [`Subscriber`] trait in `tracing-core` represents the _complete_ set of
+//! functionality required to consume `tracing` instrumentation. This means that
+//! a single `Subscriber` instance is a self-contained implementation of a
+//! complete strategy for collecting traces; but it _also_ means that the
+//! `Subscriber` trait cannot easily be composed with other `Subscriber`s.
+//!
+//! In particular, [`Subscriber`]s are responsible for generating [span IDs] and
+//! assigning them to spans. Since these IDs must uniquely identify a span
+//! within the context of the current trace, this means that there may only be
+//! a single `Subscriber` for a given thread at any point in time —
+//! otherwise, there would be no authoritative source of span IDs.
+//!
+//! On the other hand, the majority of the [`Subscriber`] trait's functionality
+//! is composable: any number of subscribers may _observe_ events, span entry
+//! and exit, and so on, provided that there is a single authoritative source of
+//! span IDs. The [`Layer`] trait represents this composable subset of the
+//! [`Subscriber`] behavior; it can _observe_ events and spans, but does not
+//! assign IDs.
+//!
+//! # Composing Layers
+//!
+//! Since a [`Layer`] does not implement a complete strategy for collecting
+//! traces, it must be composed with a `Subscriber` in order to be used. The
+//! [`Layer`] trait is generic over a type parameter (called `S` in the trait
+//! definition), representing the types of `Subscriber` they can be composed
+//! with. Thus, a [`Layer`] may be implemented that will only compose with a
+//! particular `Subscriber` implementation, or additional trait bounds may be
+//! added to constrain what types implementing `Subscriber` a `Layer` can wrap.
+//!
+//! `Layer`s may be added to a `Subscriber` by using the [`SubscriberExt::with`]
+//! method, which is provided by `tracing-subscriber`'s [prelude]. This method
+//! returns a [`Layered`] struct that implements `Subscriber` by composing the
+//! `Layer` with the `Subscriber`.
+//!
+//! For example:
+//! ```rust
+//! use tracing_subscriber::Layer;
+//! use tracing_subscriber::prelude::*;
+//! use tracing::Subscriber;
+//!
+//! pub struct MyLayer {
+//! // ...
+//! }
+//!
+//! impl<S: Subscriber> Layer<S> for MyLayer {
+//! // ...
+//! }
+//!
+//! pub struct MySubscriber {
+//! // ...
+//! }
+//!
+//! # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
+//! impl Subscriber for MySubscriber {
+//! // ...
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! }
+//! # impl MyLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//! # impl MySubscriber {
+//! # fn new() -> Self { Self { }}
+//! # }
+//!
+//! let subscriber = MySubscriber::new()
+//! .with(MyLayer::new());
+//!
+//! tracing::subscriber::set_global_default(subscriber);
+//! ```
+//!
+//! Multiple `Layer`s may be composed in the same manner:
+//! ```rust
+//! # use tracing_subscriber::{Layer, layer::SubscriberExt};
+//! # use tracing::Subscriber;
+//! pub struct MyOtherLayer {
+//! // ...
+//! }
+//!
+//! impl<S: Subscriber> Layer<S> for MyOtherLayer {
+//! // ...
+//! }
+//!
+//! pub struct MyThirdLayer {
+//! // ...
+//! }
+//!
+//! impl<S: Subscriber> Layer<S> for MyThirdLayer {
+//! // ...
+//! }
+//! # pub struct MyLayer {}
+//! # impl<S: Subscriber> Layer<S> for MyLayer {}
+//! # pub struct MySubscriber { }
+//! # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
+//! # impl Subscriber for MySubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! }
+//! # impl MyLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//! # impl MyOtherLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//! # impl MyThirdLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//! # impl MySubscriber {
+//! # fn new() -> Self { Self { }}
+//! # }
+//!
+//! let subscriber = MySubscriber::new()
+//! .with(MyLayer::new())
+//! .with(MyOtherLayer::new())
+//! .with(MyThirdLayer::new());
+//!
+//! tracing::subscriber::set_global_default(subscriber);
+//! ```
+//!
+//! The [`Layer::with_subscriber`] constructs the [`Layered`] type from a
+//! [`Layer`] and [`Subscriber`], and is called by [`SubscriberExt::with`]. In
+//! general, it is more idiomatic to use [`SubscriberExt::with`], and treat
+//! [`Layer::with_subscriber`] as an implementation detail, as `with_subscriber`
+//! calls must be nested, leading to less clear code for the reader.
+//!
+//! ## Runtime Configuration With `Layer`s
+//!
+//! In some cases, a particular [`Layer`] may be enabled or disabled based on
+//! runtime configuration. This can introduce challenges, because the type of a
+//! layered [`Subscriber`] depends on which layers are added to it: if an `if`
+//! or `match` expression adds some [`Layer`] implementation in one branch,
+//! and other layers in another, the [`Subscriber`] values returned by those
+//! branches will have different types. For example, the following _will not_
+//! work:
+//!
+//! ```compile_fail
+//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
+//! # struct Config {
+//! # is_prod: bool,
+//! # path: &'static str,
+//! # }
+//! # let cfg = Config { is_prod: false, path: "debug.log" };
+//! use std::fs::File;
+//! use tracing_subscriber::{Registry, prelude::*};
+//!
+//! let stdout_log = tracing_subscriber::fmt::layer().pretty();
+//! let subscriber = Registry::default().with(stdout_log);
+//!
+//! // The compile error will occur here because the if and else
+//! // branches have different (and therefore incompatible) types.
+//! let subscriber = if cfg.is_prod {
+//! let file = File::create(cfg.path)?;
+//! let layer = tracing_subscriber::fmt::layer()
+//! .json()
+//! .with_writer(Arc::new(file));
+//! layer.with(subscriber)
+//! } else {
+//! layer
+//! };
+//!
+//! tracing::subscriber::set_global_default(subscriber)
+//! .expect("Unable to set global subscriber");
+//! # Ok(()) }
+//! ```
+//!
+//! However, a [`Layer`] wrapped in an [`Option`] [also implements the `Layer`
+//! trait][option-impl]. This allows individual layers to be enabled or disabled at
+//! runtime while always producing a [`Subscriber`] of the same type. For
+//! example:
+//!
+//! ```
+//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
+//! # struct Config {
+//! # is_prod: bool,
+//! # path: &'static str,
+//! # }
+//! # let cfg = Config { is_prod: false, path: "debug.log" };
+//! use std::fs::File;
+//! use tracing_subscriber::{Registry, prelude::*};
+//!
+//! let stdout_log = tracing_subscriber::fmt::layer().pretty();
+//! let subscriber = Registry::default().with(stdout_log);
+//!
+//! // if `cfg.is_prod` is true, also log JSON-formatted logs to a file.
+//! let json_log = if cfg.is_prod {
+//! let file = File::create(cfg.path)?;
+//! let json_log = tracing_subscriber::fmt::layer()
+//! .json()
+//! .with_writer(file);
+//! Some(json_log)
+//! } else {
+//! None
+//! };
+//!
+//! // If `cfg.is_prod` is false, then `json` will be `None`, and this layer
+//! // will do nothing. However, the subscriber will still have the same type
+//! // regardless of whether the `Option`'s value is `None` or `Some`.
+//! let subscriber = subscriber.with(json_log);
+//!
+//! tracing::subscriber::set_global_default(subscriber)
+//! .expect("Unable to set global subscriber");
+//! # Ok(()) }
+//! ```
+//!
+//! If a [`Layer`] may be one of several different types, note that [`Box<dyn
+//! Layer<S> + Send + Sync>` implements `Layer`][box-impl].
+//! This may be used to erase the type of a [`Layer`].
+//!
+//! For example, a function that configures a [`Layer`] to log to one of
+//! several outputs might return a `Box<dyn Layer<S> + Send + Sync + 'static>`:
+//! ```
+//! use tracing_subscriber::{
+//! Layer,
+//! registry::LookupSpan,
+//! prelude::*,
+//! };
+//! use std::{path::PathBuf, fs::File, io};
+//!
+//! /// Configures whether logs are emitted to a file, to stdout, or to stderr.
+//! pub enum LogConfig {
+//! File(PathBuf),
+//! Stdout,
+//! Stderr,
+//! }
+//!
+//! impl LogConfig {
+//! pub fn layer<S>(self) -> Box<dyn Layer<S> + Send + Sync + 'static>
+//! where
+//! S: tracing_core::Subscriber,
+//! for<'a> S: LookupSpan<'a>,
+//! {
+//! // Shared configuration regardless of where logs are output to.
+//! let fmt = tracing_subscriber::fmt::layer()
+//! .with_target(true)
+//! .with_thread_names(true);
+//!
+//! // Configure the writer based on the desired log target:
+//! match self {
+//! LogConfig::File(path) => {
+//! let file = File::create(path).expect("failed to create log file");
+//! Box::new(fmt.with_writer(file))
+//! },
+//! LogConfig::Stdout => Box::new(fmt.with_writer(io::stdout)),
+//! LogConfig::Stderr => Box::new(fmt.with_writer(io::stderr)),
+//! }
+//! }
+//! }
+//!
+//! let config = LogConfig::Stdout;
+//! tracing_subscriber::registry()
+//! .with(config.layer())
+//! .init();
+//! ```
+//!
+//! The [`Layer::boxed`] method is provided to make boxing a `Layer`
+//! more convenient, but [`Box::new`] may be used as well.
+//!
+//! When the number of `Layer`s varies at runtime, note that a
+//! [`Vec<L> where L: Layer` also implements `Layer`][vec-impl]. This
+//! can be used to add a variable number of `Layer`s to a `Subscriber`:
+//!
+//! ```
+//! use tracing_subscriber::{Layer, prelude::*};
+//! struct MyLayer {
+//! // ...
+//! }
+//! # impl MyLayer { fn new() -> Self { Self {} }}
+//!
+//! impl<S: tracing_core::Subscriber> Layer<S> for MyLayer {
+//! // ...
+//! }
+//!
+//! /// Returns how many layers we need
+//! fn how_many_layers() -> usize {
+//! // ...
+//! # 3
+//! }
+//!
+//! // Create a variable-length `Vec` of layers
+//! let mut layers = Vec::new();
+//! for _ in 0..how_many_layers() {
+//! layers.push(MyLayer::new());
+//! }
+//!
+//! tracing_subscriber::registry()
+//! .with(layers)
+//! .init();
+//! ```
+//!
+//! If a variable number of `Layer` is needed and those `Layer`s have
+//! different types, a `Vec` of [boxed `Layer` trait objects][box-impl] may
+//! be used. For example:
+//!
+//! ```
+//! use tracing_subscriber::{filter::LevelFilter, Layer, prelude::*};
+//! use std::fs::File;
+//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
+//! struct Config {
+//! enable_log_file: bool,
+//! enable_stdout: bool,
+//! enable_stderr: bool,
+//! // ...
+//! }
+//! # impl Config {
+//! # fn from_config_file()-> Result<Self, Box<dyn std::error::Error>> {
+//! # // don't enable the log file so that the example doesn't actually create it
+//! # Ok(Self { enable_log_file: false, enable_stdout: true, enable_stderr: true })
+//! # }
+//! # }
+//!
+//! let cfg = Config::from_config_file()?;
+//!
+//! // Based on our dynamically loaded config file, create any number of layers:
+//! let mut layers = Vec::new();
+//!
+//! if cfg.enable_log_file {
+//! let file = File::create("myapp.log")?;
+//! let layer = tracing_subscriber::fmt::layer()
+//! .with_thread_names(true)
+//! .with_target(true)
+//! .json()
+//! .with_writer(file)
+//! // Box the layer as a type-erased trait object, so that it can
+//! // be pushed to the `Vec`.
+//! .boxed();
+//! layers.push(layer);
+//! }
+//!
+//! if cfg.enable_stdout {
+//! let layer = tracing_subscriber::fmt::layer()
+//! .pretty()
+//! .with_filter(LevelFilter::INFO)
+//! // Box the layer as a type-erased trait object, so that it can
+//! // be pushed to the `Vec`.
+//! .boxed();
+//! layers.push(layer);
+//! }
+//!
+//! if cfg.enable_stdout {
+//! let layer = tracing_subscriber::fmt::layer()
+//! .with_target(false)
+//! .with_filter(LevelFilter::WARN)
+//! // Box the layer as a type-erased trait object, so that it can
+//! // be pushed to the `Vec`.
+//! .boxed();
+//! layers.push(layer);
+//! }
+//!
+//! tracing_subscriber::registry()
+//! .with(layers)
+//! .init();
+//!# Ok(()) }
+//! ```
+//!
+//! Finally, if the number of layers _changes_ at runtime, a `Vec` of
+//! subscribers can be used alongside the [`reload`](crate::reload) module to
+//! add or remove subscribers dynamically at runtime.
+//!
+//! [option-impl]: Layer#impl-Layer<S>-for-Option<L>
+//! [box-impl]: Layer#impl-Layer%3CS%3E-for-Box%3Cdyn%20Layer%3CS%3E%20+%20Send%20+%20Sync%3E
+//! [vec-impl]: Layer#impl-Layer<S>-for-Vec<L>
+//! [prelude]: crate::prelude
+//!
+//! # Recording Traces
+//!
+//! The [`Layer`] trait defines a set of methods for consuming notifications from
+//! tracing instrumentation, which are generally equivalent to the similarly
+//! named methods on [`Subscriber`]. Unlike [`Subscriber`], the methods on
+//! `Layer` are additionally passed a [`Context`] type, which exposes additional
+//! information provided by the wrapped subscriber (such as [the current span])
+//! to the layer.
+//!
+//! # Filtering with `Layer`s
+//!
+//! As well as strategies for handling trace events, the `Layer` trait may also
+//! be used to represent composable _filters_. This allows the determination of
+//! what spans and events should be recorded to be decoupled from _how_ they are
+//! recorded: a filtering layer can be applied to other layers or
+//! subscribers. `Layer`s can be used to implement _global filtering_, where a
+//! `Layer` provides a filtering strategy for the entire subscriber.
+//! Additionally, individual recording `Layer`s or sets of `Layer`s may be
+//! combined with _per-layer filters_ that control what spans and events are
+//! recorded by those layers.
+//!
+//! ## Global Filtering
+//!
+//! A `Layer` that implements a filtering strategy should override the
+//! [`register_callsite`] and/or [`enabled`] methods. It may also choose to implement
+//! methods such as [`on_enter`], if it wishes to filter trace events based on
+//! the current span context.
+//!
+//! Note that the [`Layer::register_callsite`] and [`Layer::enabled`] methods
+//! determine whether a span or event is enabled *globally*. Thus, they should
+//! **not** be used to indicate whether an individual layer wishes to record a
+//! particular span or event. Instead, if a layer is only interested in a subset
+//! of trace data, but does *not* wish to disable other spans and events for the
+//! rest of the layer stack should ignore those spans and events in its
+//! notification methods.
+//!
+//! The filtering methods on a stack of `Layer`s are evaluated in a top-down
+//! order, starting with the outermost `Layer` and ending with the wrapped
+//! [`Subscriber`]. If any layer returns `false` from its [`enabled`] method, or
+//! [`Interest::never()`] from its [`register_callsite`] method, filter
+//! evaluation will short-circuit and the span or event will be disabled.
+//!
+//! ### Enabling Interest
+//!
+//! Whenever an tracing event (or span) is emitted, it goes through a number of
+//! steps to determine how and how much it should be processed. The earlier an
+//! event is disabled, the less work has to be done to process the event, so
+//! `Layer`s that implement filtering should attempt to disable unwanted
+//! events as early as possible. In order, each event checks:
+//!
+//! - [`register_callsite`], once per callsite (roughly: once per time that
+//! `event!` or `span!` is written in the source code; this is cached at the
+//! callsite). See [`Subscriber::register_callsite`] and
+//! [`tracing_core::callsite`] for a summary of how this behaves.
+//! - [`enabled`], once per emitted event (roughly: once per time that `event!`
+//! or `span!` is *executed*), and only if `register_callsite` regesters an
+//! [`Interest::sometimes`]. This is the main customization point to globally
+//! filter events based on their [`Metadata`]. If an event can be disabled
+//! based only on [`Metadata`], it should be, as this allows the construction
+//! of the actual `Event`/`Span` to be skipped.
+//! - For events only (and not spans), [`event_enabled`] is called just before
+//! processing the event. This gives layers one last chance to say that
+//! an event should be filtered out, now that the event's fields are known.
+//!
+//! ## Per-Layer Filtering
+//!
+//! **Note**: per-layer filtering APIs currently require the [`"registry"` crate
+//! feature flag][feat] to be enabled.
+//!
+//! Sometimes, it may be desirable for one `Layer` to record a particular subset
+//! of spans and events, while a different subset of spans and events are
+//! recorded by other `Layer`s. For example:
+//!
+//! - A layer that records metrics may wish to observe only events including
+//! particular tracked values, while a logging layer ignores those events.
+//! - If recording a distributed trace is expensive, it might be desirable to
+//! only send spans with `INFO` and lower verbosity to the distributed tracing
+//! system, while logging more verbose spans to a file.
+//! - Spans and events with a particular target might be recorded differently
+//! from others, such as by generating an HTTP access log from a span that
+//! tracks the lifetime of an HTTP request.
+//!
+//! The [`Filter`] trait is used to control what spans and events are
+//! observed by an individual `Layer`, while still allowing other `Layer`s to
+//! potentially record them. The [`Layer::with_filter`] method combines a
+//! `Layer` with a [`Filter`], returning a [`Filtered`] layer.
+//!
+//! This crate's [`filter`] module provides a number of types which implement
+//! the [`Filter`] trait, such as [`LevelFilter`], [`Targets`], and
+//! [`FilterFn`]. These [`Filter`]s provide ready-made implementations of
+//! common forms of filtering. For custom filtering policies, the [`FilterFn`]
+//! and [`DynFilterFn`] types allow implementing a [`Filter`] with a closure or
+//! function pointer. In addition, when more control is required, the [`Filter`]
+//! trait may also be implemented for user-defined types.
+//!
+//! //! [`Option<Filter>`] also implements [`Filter`], which allows for an optional
+//! filter. [`None`](Option::None) filters out _nothing_ (that is, allows
+//! everything through). For example:
+//!
+//! ```rust
+//! # use tracing_subscriber::{filter::filter_fn, Layer};
+//! # use tracing_core::{Metadata, subscriber::Subscriber};
+//! # struct MyLayer<S>(std::marker::PhantomData<S>);
+//! # impl<S> MyLayer<S> { fn new() -> Self { Self(std::marker::PhantomData)} }
+//! # impl<S: Subscriber> Layer<S> for MyLayer<S> {}
+//! # fn my_filter(_: &str) -> impl Fn(&Metadata) -> bool { |_| true }
+//! fn setup_tracing<S: Subscriber>(filter_config: Option<&str>) {
+//! let layer = MyLayer::<S>::new()
+//! .with_filter(filter_config.map(|config| filter_fn(my_filter(config))));
+//! //...
+//! }
+//! ```
+//!
+//! <pre class="compile_fail" style="white-space:normal;font:inherit;">
+//! <strong>Warning</strong>: Currently, the <a href="../struct.Registry.html">
+//! <code>Registry</code></a> type defined in this crate is the only root
+//! <code>Subscriber</code> capable of supporting <code>Layer</code>s with
+//! per-layer filters. In the future, new APIs will be added to allow other
+//! root <code>Subscriber</code>s to support per-layer filters.
+//! </pre>
+//!
+//! For example, to generate an HTTP access log based on spans with
+//! the `http_access` target, while logging other spans and events to
+//! standard out, a [`Filter`] can be added to the access log layer:
+//!
+//! ```
+//! use tracing_subscriber::{filter, prelude::*};
+//!
+//! // Generates an HTTP access log.
+//! let access_log = // ...
+//! # filter::LevelFilter::INFO;
+//!
+//! // Add a filter to the access log layer so that it only observes
+//! // spans and events with the `http_access` target.
+//! let access_log = access_log.with_filter(filter::filter_fn(|metadata| {
+//! // Returns `true` if and only if the span or event's target is
+//! // "http_access".
+//! metadata.target() == "http_access"
+//! }));
+//!
+//! // A general-purpose logging layer.
+//! let fmt_layer = tracing_subscriber::fmt::layer();
+//!
+//! // Build a subscriber that combines the access log and stdout log
+//! // layers.
+//! tracing_subscriber::registry()
+//! .with(fmt_layer)
+//! .with(access_log)
+//! .init();
+//! ```
+//!
+//! Multiple layers can have their own, separate per-layer filters. A span or
+//! event will be recorded if it is enabled by _any_ per-layer filter, but it
+//! will be skipped by the layers whose filters did not enable it. Building on
+//! the previous example:
+//!
+//! ```
+//! use tracing_subscriber::{filter::{filter_fn, LevelFilter}, prelude::*};
+//!
+//! let access_log = // ...
+//! # LevelFilter::INFO;
+//! let fmt_layer = tracing_subscriber::fmt::layer();
+//!
+//! tracing_subscriber::registry()
+//! // Add the filter for the "http_access" target to the access
+//! // log layer, like before.
+//! .with(access_log.with_filter(filter_fn(|metadata| {
+//! metadata.target() == "http_access"
+//! })))
+//! // Add a filter for spans and events with the INFO level
+//! // and below to the logging layer.
+//! .with(fmt_layer.with_filter(LevelFilter::INFO))
+//! .init();
+//!
+//! // Neither layer will observe this event
+//! tracing::debug!(does_anyone_care = false, "a tree fell in the forest");
+//!
+//! // This event will be observed by the logging layer, but not
+//! // by the access log layer.
+//! tracing::warn!(dose_roentgen = %3.8, "not great, but not terrible");
+//!
+//! // This event will be observed only by the access log layer.
+//! tracing::trace!(target: "http_access", "HTTP request started");
+//!
+//! // Both layers will observe this event.
+//! tracing::error!(target: "http_access", "HTTP request failed with a very bad error!");
+//! ```
+//!
+//! A per-layer filter can be applied to multiple [`Layer`]s at a time, by
+//! combining them into a [`Layered`] layer using [`Layer::and_then`], and then
+//! calling [`Layer::with_filter`] on the resulting [`Layered`] layer.
+//!
+//! Consider the following:
+//! - `layer_a` and `layer_b`, which should only receive spans and events at
+//! the [`INFO`] [level] and above.
+//! - A third layer, `layer_c`, which should receive spans and events at
+//! the [`DEBUG`] [level] as well.
+//! The layers and filters would be composed thusly:
+//!
+//! ```
+//! use tracing_subscriber::{filter::LevelFilter, prelude::*};
+//!
+//! let layer_a = // ...
+//! # LevelFilter::INFO;
+//! let layer_b = // ...
+//! # LevelFilter::INFO;
+//! let layer_c = // ...
+//! # LevelFilter::INFO;
+//!
+//! let info_layers = layer_a
+//! // Combine `layer_a` and `layer_b` into a `Layered` layer:
+//! .and_then(layer_b)
+//! // ...and then add an `INFO` `LevelFilter` to that layer:
+//! .with_filter(LevelFilter::INFO);
+//!
+//! tracing_subscriber::registry()
+//! // Add `layer_c` with a `DEBUG` filter.
+//! .with(layer_c.with_filter(LevelFilter::DEBUG))
+//! .with(info_layers)
+//! .init();
+//!```
+//!
+//! If a [`Filtered`] [`Layer`] is combined with another [`Layer`]
+//! [`Layer::and_then`], and a filter is added to the [`Layered`] layer, that
+//! layer will be filtered by *both* the inner filter and the outer filter.
+//! Only spans and events that are enabled by *both* filters will be
+//! observed by that layer. This can be used to implement complex filtering
+//! trees.
+//!
+//! As an example, consider the following constraints:
+//! - Suppose that a particular [target] is used to indicate events that
+//! should be counted as part of a metrics system, which should be only
+//! observed by a layer that collects metrics.
+//! - A log of high-priority events ([`INFO`] and above) should be logged
+//! to stdout, while more verbose events should be logged to a debugging log file.
+//! - Metrics-focused events should *not* be included in either log output.
+//!
+//! In that case, it is possible to apply a filter to both logging layers to
+//! exclude the metrics events, while additionally adding a [`LevelFilter`]
+//! to the stdout log:
+//!
+//! ```
+//! # // wrap this in a function so we don't actually create `debug.log` when
+//! # // running the doctests..
+//! # fn docs() -> Result<(), Box<dyn std::error::Error + 'static>> {
+//! use tracing_subscriber::{filter, prelude::*};
+//! use std::{fs::File, sync::Arc};
+//!
+//! // A layer that logs events to stdout using the human-readable "pretty"
+//! // format.
+//! let stdout_log = tracing_subscriber::fmt::layer()
+//! .pretty();
+//!
+//! // A layer that logs events to a file.
+//! let file = File::create("debug.log")?;
+//! let debug_log = tracing_subscriber::fmt::layer()
+//! .with_writer(Arc::new(file));
+//!
+//! // A layer that collects metrics using specific events.
+//! let metrics_layer = /* ... */ filter::LevelFilter::INFO;
+//!
+//! tracing_subscriber::registry()
+//! .with(
+//! stdout_log
+//! // Add an `INFO` filter to the stdout logging layer
+//! .with_filter(filter::LevelFilter::INFO)
+//! // Combine the filtered `stdout_log` layer with the
+//! // `debug_log` layer, producing a new `Layered` layer.
+//! .and_then(debug_log)
+//! // Add a filter to *both* layers that rejects spans and
+//! // events whose targets start with `metrics`.
+//! .with_filter(filter::filter_fn(|metadata| {
+//! !metadata.target().starts_with("metrics")
+//! }))
+//! )
+//! .with(
+//! // Add a filter to the metrics label that *only* enables
+//! // events whose targets start with `metrics`.
+//! metrics_layer.with_filter(filter::filter_fn(|metadata| {
+//! metadata.target().starts_with("metrics")
+//! }))
+//! )
+//! .init();
+//!
+//! // This event will *only* be recorded by the metrics layer.
+//! tracing::info!(target: "metrics::cool_stuff_count", value = 42);
+//!
+//! // This event will only be seen by the debug log file layer:
+//! tracing::debug!("this is a message, and part of a system of messages");
+//!
+//! // This event will be seen by both the stdout log layer *and*
+//! // the debug log file layer, but not by the metrics layer.
+//! tracing::warn!("the message is a warning about danger!");
+//! # Ok(()) }
+//! ```
+//!
+//! [`Subscriber`]: tracing_core::subscriber::Subscriber
+//! [span IDs]: tracing_core::span::Id
+//! [the current span]: Context::current_span
+//! [`register_callsite`]: Layer::register_callsite
+//! [`enabled`]: Layer::enabled
+//! [`event_enabled`]: Layer::event_enabled
+//! [`on_enter`]: Layer::on_enter
+//! [`Layer::register_callsite`]: Layer::register_callsite
+//! [`Layer::enabled`]: Layer::enabled
+//! [`Interest::never()`]: tracing_core::subscriber::Interest::never()
+//! [`Filtered`]: crate::filter::Filtered
+//! [`filter`]: crate::filter
+//! [`Targets`]: crate::filter::Targets
+//! [`FilterFn`]: crate::filter::FilterFn
+//! [`DynFilterFn`]: crate::filter::DynFilterFn
+//! [level]: tracing_core::Level
+//! [`INFO`]: tracing_core::Level::INFO
+//! [`DEBUG`]: tracing_core::Level::DEBUG
+//! [target]: tracing_core::Metadata::target
+//! [`LevelFilter`]: crate::filter::LevelFilter
+//! [feat]: crate#feature-flags
+use crate::filter;
+
+use tracing_core::{
+ metadata::Metadata,
+ span,
+ subscriber::{Interest, Subscriber},
+ Dispatch, Event, LevelFilter,
+};
+
+use core::any::TypeId;
+
+feature! {
+ #![feature = "alloc"]
+ use alloc::boxed::Box;
+ use core::ops::{Deref, DerefMut};
+}
+
+mod context;
+mod layered;
+pub use self::{context::*, layered::*};
+
+// The `tests` module is `pub(crate)` because it contains test utilities used by
+// other modules.
+#[cfg(test)]
+pub(crate) mod tests;
+
+/// A composable handler for `tracing` events.
+///
+/// A `Layer` implements a behavior for recording or collecting traces that can
+/// be composed together with other `Layer`s to build a [`Subscriber`]. See the
+/// [module-level documentation](crate::layer) for details.
+///
+/// [`Subscriber`]: tracing_core::Subscriber
+#[cfg_attr(docsrs, doc(notable_trait))]
+pub trait Layer<S>
+where
+ S: Subscriber,
+ Self: 'static,
+{
+ /// Performs late initialization when installing this layer as a
+ /// [`Subscriber`].
+ ///
+ /// ## Avoiding Memory Leaks
+ ///
+ /// `Layer`s should not store the [`Dispatch`] pointing to the [`Subscriber`]
+ /// that they are a part of. Because the `Dispatch` owns the `Subscriber`,
+ /// storing the `Dispatch` within the `Subscriber` will create a reference
+ /// count cycle, preventing the `Dispatch` from ever being dropped.
+ ///
+ /// Instead, when it is necessary to store a cyclical reference to the
+ /// `Dispatch` within a `Layer`, use [`Dispatch::downgrade`] to convert a
+ /// `Dispatch` into a [`WeakDispatch`]. This type is analogous to
+ /// [`std::sync::Weak`], and does not create a reference count cycle. A
+ /// [`WeakDispatch`] can be stored within a subscriber without causing a
+ /// memory leak, and can be [upgraded] into a `Dispatch` temporarily when
+ /// the `Dispatch` must be accessed by the subscriber.
+ ///
+ /// [`WeakDispatch`]: tracing_core::dispatcher::WeakDispatch
+ /// [upgraded]: tracing_core::dispatcher::WeakDispatch::upgrade
+ /// [`Subscriber`]: tracing_core::Subscriber
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ let _ = subscriber;
+ }
+
+ /// Performs late initialization when attaching a `Layer` to a
+ /// [`Subscriber`].
+ ///
+ /// This is a callback that is called when the `Layer` is added to a
+ /// [`Subscriber`] (e.g. in [`Layer::with_subscriber`] and
+ /// [`SubscriberExt::with`]). Since this can only occur before the
+ /// [`Subscriber`] has been set as the default, both the `Layer` and
+ /// [`Subscriber`] are passed to this method _mutably_. This gives the
+ /// `Layer` the opportunity to set any of its own fields with values
+ /// recieved by method calls on the [`Subscriber`].
+ ///
+ /// For example, [`Filtered`] layers implement `on_layer` to call the
+ /// [`Subscriber`]'s [`register_filter`] method, and store the returned
+ /// [`FilterId`] as a field.
+ ///
+ /// **Note** In most cases, `Layer` implementations will not need to
+ /// implement this method. However, in cases where a type implementing
+ /// `Layer` wraps one or more other types that implement `Layer`, like the
+ /// [`Layered`] and [`Filtered`] types in this crate, that type MUST ensure
+ /// that the inner `Layer`s' `on_layer` methods are called. Otherwise,
+ /// functionality that relies on `on_layer`, such as [per-layer filtering],
+ /// may not work correctly.
+ ///
+ /// [`Filtered`]: crate::filter::Filtered
+ /// [`register_filter`]: crate::registry::LookupSpan::register_filter
+ /// [per-layer filtering]: #per-layer-filtering
+ /// [`FilterId`]: crate::filter::FilterId
+ fn on_layer(&mut self, subscriber: &mut S) {
+ let _ = subscriber;
+ }
+
+ /// Registers a new callsite with this layer, returning whether or not
+ /// the layer is interested in being notified about the callsite, similarly
+ /// to [`Subscriber::register_callsite`].
+ ///
+ /// By default, this returns [`Interest::always()`] if [`self.enabled`] returns
+ /// true, or [`Interest::never()`] if it returns false.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This method (and <a href="#method.enabled">
+ /// <code>Layer::enabled</code></a>) determine whether a span or event is
+ /// globally enabled, <em>not</em> whether the individual layer will be
+ /// notified about that span or event. This is intended to be used
+ /// by layers that implement filtering for the entire stack. Layers which do
+ /// not wish to be notified about certain spans or events but do not wish to
+ /// globally disable them should ignore those spans or events in their
+ /// <a href="#method.on_event"><code>on_event</code></a>,
+ /// <a href="#method.on_enter"><code>on_enter</code></a>,
+ /// <a href="#method.on_exit"><code>on_exit</code></a>, and other notification
+ /// methods.
+ /// </pre>
+ ///
+ /// See [the trait-level documentation] for more information on filtering
+ /// with `Layer`s.
+ ///
+ /// Layers may also implement this method to perform any behaviour that
+ /// should be run once per callsite. If the layer wishes to use
+ /// `register_callsite` for per-callsite behaviour, but does not want to
+ /// globally enable or disable those callsites, it should always return
+ /// [`Interest::always()`].
+ ///
+ /// [`Interest`]: tracing_core::Interest
+ /// [`Subscriber::register_callsite`]: tracing_core::Subscriber::register_callsite()
+ /// [`Interest::never()`]: tracing_core::subscriber::Interest::never()
+ /// [`Interest::always()`]: tracing_core::subscriber::Interest::always()
+ /// [`self.enabled`]: Layer::enabled()
+ /// [`Layer::enabled`]: Layer::enabled()
+ /// [`on_event`]: Layer::on_event()
+ /// [`on_enter`]: Layer::on_enter()
+ /// [`on_exit`]: Layer::on_exit()
+ /// [the trait-level documentation]: #filtering-with-layers
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ if self.enabled(metadata, Context::none()) {
+ Interest::always()
+ } else {
+ Interest::never()
+ }
+ }
+
+ /// Returns `true` if this layer is interested in a span or event with the
+ /// given `metadata` in the current [`Context`], similarly to
+ /// [`Subscriber::enabled`].
+ ///
+ /// By default, this always returns `true`, allowing the wrapped subscriber
+ /// to choose to disable the span.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: This method (and <a href="#method.register_callsite">
+ /// <code>Layer::register_callsite</code></a>) determine whether a span or event is
+ /// globally enabled, <em>not</em> whether the individual layer will be
+ /// notified about that span or event. This is intended to be used
+ /// by layers that implement filtering for the entire stack. Layers which do
+ /// not wish to be notified about certain spans or events but do not wish to
+ /// globally disable them should ignore those spans or events in their
+ /// <a href="#method.on_event"><code>on_event</code></a>,
+ /// <a href="#method.on_enter"><code>on_enter</code></a>,
+ /// <a href="#method.on_exit"><code>on_exit</code></a>, and other notification
+ /// methods.
+ /// </pre>
+ ///
+ ///
+ /// See [the trait-level documentation] for more information on filtering
+ /// with `Layer`s.
+ ///
+ /// [`Interest`]: tracing_core::Interest
+ /// [`Subscriber::enabled`]: tracing_core::Subscriber::enabled()
+ /// [`Layer::register_callsite`]: Layer::register_callsite()
+ /// [`on_event`]: Layer::on_event()
+ /// [`on_enter`]: Layer::on_enter()
+ /// [`on_exit`]: Layer::on_exit()
+ /// [the trait-level documentation]: #filtering-with-layers
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ let _ = (metadata, ctx);
+ true
+ }
+
+ /// Notifies this layer that a new span was constructed with the given
+ /// `Attributes` and `Id`.
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ let _ = (attrs, id, ctx);
+ }
+
+ // TODO(eliza): do we want this to be a public API? If we end up moving
+ // filtering layers to a separate trait, we may no longer want `Layer`s to
+ // be able to participate in max level hinting...
+ #[doc(hidden)]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ None
+ }
+
+ /// Notifies this layer that a span with the given `Id` recorded the given
+ /// `values`.
+ // Note: it's unclear to me why we'd need the current span in `record` (the
+ // only thing the `Context` type currently provides), but passing it in anyway
+ // seems like a good future-proofing measure as it may grow other methods later...
+ fn on_record(&self, _span: &span::Id, _values: &span::Record<'_>, _ctx: Context<'_, S>) {}
+
+ /// Notifies this layer that a span with the ID `span` recorded that it
+ /// follows from the span with the ID `follows`.
+ // Note: it's unclear to me why we'd need the current span in `record` (the
+ // only thing the `Context` type currently provides), but passing it in anyway
+ // seems like a good future-proofing measure as it may grow other methods later...
+ fn on_follows_from(&self, _span: &span::Id, _follows: &span::Id, _ctx: Context<'_, S>) {}
+
+ /// Called before [`on_event`], to determine if `on_event` should be called.
+ ///
+ /// <div class="example-wrap" style="display:inline-block">
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ ///
+ /// **Note**: This method determines whether an event is globally enabled,
+ /// *not* whether the individual `Layer` will be notified about the
+ /// event. This is intended to be used by `Layer`s that implement
+ /// filtering for the entire stack. `Layer`s which do not wish to be
+ /// notified about certain events but do not wish to globally disable them
+ /// should ignore those events in their [on_event][Self::on_event].
+ ///
+ /// </pre></div>
+ ///
+ /// See [the trait-level documentation] for more information on filtering
+ /// with `Layer`s.
+ ///
+ /// [`on_event`]: Self::on_event
+ /// [`Interest`]: tracing_core::Interest
+ /// [the trait-level documentation]: #filtering-with-layers
+ #[inline] // collapse this to a constant please mrs optimizer
+ fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, S>) -> bool {
+ true
+ }
+
+ /// Notifies this layer that an event has occurred.
+ fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, S>) {}
+
+ /// Notifies this layer that a span with the given ID was entered.
+ fn on_enter(&self, _id: &span::Id, _ctx: Context<'_, S>) {}
+
+ /// Notifies this layer that the span with the given ID was exited.
+ fn on_exit(&self, _id: &span::Id, _ctx: Context<'_, S>) {}
+
+ /// Notifies this layer that the span with the given ID has been closed.
+ fn on_close(&self, _id: span::Id, _ctx: Context<'_, S>) {}
+
+ /// Notifies this layer that a span ID has been cloned, and that the
+ /// subscriber returned a different ID.
+ fn on_id_change(&self, _old: &span::Id, _new: &span::Id, _ctx: Context<'_, S>) {}
+
+ /// Composes this layer around the given `Layer`, returning a `Layered`
+ /// struct implementing `Layer`.
+ ///
+ /// The returned `Layer` will call the methods on this `Layer` and then
+ /// those of the new `Layer`, before calling the methods on the subscriber
+ /// it wraps. For example:
+ ///
+ /// ```rust
+ /// # use tracing_subscriber::layer::Layer;
+ /// # use tracing_core::Subscriber;
+ /// pub struct FooLayer {
+ /// // ...
+ /// }
+ ///
+ /// pub struct BarLayer {
+ /// // ...
+ /// }
+ ///
+ /// pub struct MySubscriber {
+ /// // ...
+ /// }
+ ///
+ /// impl<S: Subscriber> Layer<S> for FooLayer {
+ /// // ...
+ /// }
+ ///
+ /// impl<S: Subscriber> Layer<S> for BarLayer {
+ /// // ...
+ /// }
+ ///
+ /// # impl FooLayer {
+ /// # fn new() -> Self { Self {} }
+ /// # }
+ /// # impl BarLayer {
+ /// # fn new() -> Self { Self { }}
+ /// # }
+ /// # impl MySubscriber {
+ /// # fn new() -> Self { Self { }}
+ /// # }
+ /// # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
+ /// # impl tracing_core::Subscriber for MySubscriber {
+ /// # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
+ /// # fn record(&self, _: &Id, _: &Record) {}
+ /// # fn event(&self, _: &Event) {}
+ /// # fn record_follows_from(&self, _: &Id, _: &Id) {}
+ /// # fn enabled(&self, _: &Metadata) -> bool { false }
+ /// # fn enter(&self, _: &Id) {}
+ /// # fn exit(&self, _: &Id) {}
+ /// # }
+ /// let subscriber = FooLayer::new()
+ /// .and_then(BarLayer::new())
+ /// .with_subscriber(MySubscriber::new());
+ /// ```
+ ///
+ /// Multiple layers may be composed in this manner:
+ ///
+ /// ```rust
+ /// # use tracing_subscriber::layer::Layer;
+ /// # use tracing_core::Subscriber;
+ /// # pub struct FooLayer {}
+ /// # pub struct BarLayer {}
+ /// # pub struct MySubscriber {}
+ /// # impl<S: Subscriber> Layer<S> for FooLayer {}
+ /// # impl<S: Subscriber> Layer<S> for BarLayer {}
+ /// # impl FooLayer {
+ /// # fn new() -> Self { Self {} }
+ /// # }
+ /// # impl BarLayer {
+ /// # fn new() -> Self { Self { }}
+ /// # }
+ /// # impl MySubscriber {
+ /// # fn new() -> Self { Self { }}
+ /// # }
+ /// # use tracing_core::{span::{Id, Attributes, Record}, Metadata, Event};
+ /// # impl tracing_core::Subscriber for MySubscriber {
+ /// # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(1) }
+ /// # fn record(&self, _: &Id, _: &Record) {}
+ /// # fn event(&self, _: &Event) {}
+ /// # fn record_follows_from(&self, _: &Id, _: &Id) {}
+ /// # fn enabled(&self, _: &Metadata) -> bool { false }
+ /// # fn enter(&self, _: &Id) {}
+ /// # fn exit(&self, _: &Id) {}
+ /// # }
+ /// pub struct BazLayer {
+ /// // ...
+ /// }
+ ///
+ /// impl<S: Subscriber> Layer<S> for BazLayer {
+ /// // ...
+ /// }
+ /// # impl BazLayer { fn new() -> Self { BazLayer {} } }
+ ///
+ /// let subscriber = FooLayer::new()
+ /// .and_then(BarLayer::new())
+ /// .and_then(BazLayer::new())
+ /// .with_subscriber(MySubscriber::new());
+ /// ```
+ fn and_then<L>(self, layer: L) -> Layered<L, Self, S>
+ where
+ L: Layer<S>,
+ Self: Sized,
+ {
+ let inner_has_layer_filter = filter::layer_has_plf(&self);
+ Layered::new(layer, self, inner_has_layer_filter)
+ }
+
+ /// Composes this `Layer` with the given [`Subscriber`], returning a
+ /// `Layered` struct that implements [`Subscriber`].
+ ///
+ /// The returned `Layered` subscriber will call the methods on this `Layer`
+ /// and then those of the wrapped subscriber.
+ ///
+ /// For example:
+ /// ```rust
+ /// # use tracing_subscriber::layer::Layer;
+ /// # use tracing_core::Subscriber;
+ /// pub struct FooLayer {
+ /// // ...
+ /// }
+ ///
+ /// pub struct MySubscriber {
+ /// // ...
+ /// }
+ ///
+ /// impl<S: Subscriber> Layer<S> for FooLayer {
+ /// // ...
+ /// }
+ ///
+ /// # impl FooLayer {
+ /// # fn new() -> Self { Self {} }
+ /// # }
+ /// # impl MySubscriber {
+ /// # fn new() -> Self { Self { }}
+ /// # }
+ /// # use tracing_core::{span::{Id, Attributes, Record}, Metadata};
+ /// # impl tracing_core::Subscriber for MySubscriber {
+ /// # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+ /// # fn record(&self, _: &Id, _: &Record) {}
+ /// # fn event(&self, _: &tracing_core::Event) {}
+ /// # fn record_follows_from(&self, _: &Id, _: &Id) {}
+ /// # fn enabled(&self, _: &Metadata) -> bool { false }
+ /// # fn enter(&self, _: &Id) {}
+ /// # fn exit(&self, _: &Id) {}
+ /// # }
+ /// let subscriber = FooLayer::new()
+ /// .with_subscriber(MySubscriber::new());
+ ///```
+ ///
+ /// [`Subscriber`]: tracing_core::Subscriber
+ fn with_subscriber(mut self, mut inner: S) -> Layered<Self, S>
+ where
+ Self: Sized,
+ {
+ let inner_has_layer_filter = filter::subscriber_has_plf(&inner);
+ self.on_layer(&mut inner);
+ Layered::new(self, inner, inner_has_layer_filter)
+ }
+
+ /// Combines `self` with a [`Filter`], returning a [`Filtered`] layer.
+ ///
+ /// The [`Filter`] will control which spans and events are enabled for
+ /// this layer. See [the trait-level documentation][plf] for details on
+ /// per-layer filtering.
+ ///
+ /// [`Filtered`]: crate::filter::Filtered
+ /// [plf]: crate::layer#per-layer-filtering
+ #[cfg(all(feature = "registry", feature = "std"))]
+ #[cfg_attr(docsrs, doc(cfg(all(feature = "registry", feature = "std"))))]
+ fn with_filter<F>(self, filter: F) -> filter::Filtered<Self, F, S>
+ where
+ Self: Sized,
+ F: Filter<S>,
+ {
+ filter::Filtered::new(self, filter)
+ }
+
+ /// Erases the type of this [`Layer`], returning a [`Box`]ed `dyn
+ /// Layer` trait object.
+ ///
+ /// This can be used when a function returns a `Layer` which may be of
+ /// one of several types, or when a `Layer` subscriber has a very long type
+ /// signature.
+ ///
+ /// # Examples
+ ///
+ /// The following example will *not* compile, because the value assigned to
+ /// `log_layer` may have one of several different types:
+ ///
+ /// ```compile_fail
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// use tracing_subscriber::{Layer, filter::LevelFilter, prelude::*};
+ /// use std::{path::PathBuf, fs::File, io};
+ ///
+ /// /// Configures whether logs are emitted to a file, to stdout, or to stderr.
+ /// pub enum LogConfig {
+ /// File(PathBuf),
+ /// Stdout,
+ /// Stderr,
+ /// }
+ ///
+ /// let config = // ...
+ /// # LogConfig::Stdout;
+ ///
+ /// // Depending on the config, construct a layer of one of several types.
+ /// let log_layer = match config {
+ /// // If logging to a file, use a maximally-verbose configuration.
+ /// LogConfig::File(path) => {
+ /// let file = File::create(path)?;
+ /// tracing_subscriber::fmt::layer()
+ /// .with_thread_ids(true)
+ /// .with_thread_names(true)
+ /// // Selecting the JSON logging format changes the layer's
+ /// // type.
+ /// .json()
+ /// .with_span_list(true)
+ /// // Setting the writer to use our log file changes the
+ /// // layer's type again.
+ /// .with_writer(file)
+ /// },
+ ///
+ /// // If logging to stdout, use a pretty, human-readable configuration.
+ /// LogConfig::Stdout => tracing_subscriber::fmt::layer()
+ /// // Selecting the "pretty" logging format changes the
+ /// // layer's type!
+ /// .pretty()
+ /// .with_writer(io::stdout)
+ /// // Add a filter based on the RUST_LOG environment variable;
+ /// // this changes the type too!
+ /// .and_then(tracing_subscriber::EnvFilter::from_default_env()),
+ ///
+ /// // If logging to stdout, only log errors and warnings.
+ /// LogConfig::Stderr => tracing_subscriber::fmt::layer()
+ /// // Changing the writer changes the layer's type
+ /// .with_writer(io::stderr)
+ /// // Only log the `WARN` and `ERROR` levels. Adding a filter
+ /// // changes the layer's type to `Filtered<LevelFilter, ...>`.
+ /// .with_filter(LevelFilter::WARN),
+ /// };
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(log_layer)
+ /// .init();
+ /// # Ok(()) }
+ /// ```
+ ///
+ /// However, adding a call to `.boxed()` after each match arm erases the
+ /// layer's type, so this code *does* compile:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// # use tracing_subscriber::{Layer, filter::LevelFilter, prelude::*};
+ /// # use std::{path::PathBuf, fs::File, io};
+ /// # pub enum LogConfig {
+ /// # File(PathBuf),
+ /// # Stdout,
+ /// # Stderr,
+ /// # }
+ /// # let config = LogConfig::Stdout;
+ /// let log_layer = match config {
+ /// LogConfig::File(path) => {
+ /// let file = File::create(path)?;
+ /// tracing_subscriber::fmt::layer()
+ /// .with_thread_ids(true)
+ /// .with_thread_names(true)
+ /// .json()
+ /// .with_span_list(true)
+ /// .with_writer(file)
+ /// // Erase the type by boxing the layer
+ /// .boxed()
+ /// },
+ ///
+ /// LogConfig::Stdout => tracing_subscriber::fmt::layer()
+ /// .pretty()
+ /// .with_writer(io::stdout)
+ /// .and_then(tracing_subscriber::EnvFilter::from_default_env())
+ /// // Erase the type by boxing the layer
+ /// .boxed(),
+ ///
+ /// LogConfig::Stderr => tracing_subscriber::fmt::layer()
+ /// .with_writer(io::stderr)
+ /// .with_filter(LevelFilter::WARN)
+ /// // Erase the type by boxing the layer
+ /// .boxed(),
+ /// };
+ ///
+ /// tracing_subscriber::registry()
+ /// .with(log_layer)
+ /// .init();
+ /// # Ok(()) }
+ /// ```
+ #[cfg(any(feature = "alloc", feature = "std"))]
+ #[cfg_attr(docsrs, doc(cfg(any(feature = "alloc", feature = "std"))))]
+ fn boxed(self) -> Box<dyn Layer<S> + Send + Sync + 'static>
+ where
+ Self: Sized,
+ Self: Layer<S> + Send + Sync + 'static,
+ S: Subscriber,
+ {
+ Box::new(self)
+ }
+
+ #[doc(hidden)]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ Some(self as *const _ as *const ())
+ } else {
+ None
+ }
+ }
+}
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+
+ /// A per-[`Layer`] filter that determines whether a span or event is enabled
+ /// for an individual layer.
+ ///
+ /// See [the module-level documentation][plf] for details on using [`Filter`]s.
+ ///
+ /// [plf]: crate::layer#per-layer-filtering
+ #[cfg_attr(docsrs, doc(notable_trait))]
+ pub trait Filter<S> {
+ /// Returns `true` if this layer is interested in a span or event with the
+ /// given [`Metadata`] in the current [`Context`], similarly to
+ /// [`Subscriber::enabled`].
+ ///
+ /// If this returns `false`, the span or event will be disabled _for the
+ /// wrapped [`Layer`]_. Unlike [`Layer::enabled`], the span or event will
+ /// still be recorded if any _other_ layers choose to enable it. However,
+ /// the layer [filtered] by this filter will skip recording that span or
+ /// event.
+ ///
+ /// If all layers indicate that they do not wish to see this span or event,
+ /// it will be disabled.
+ ///
+ /// [`metadata`]: tracing_core::Metadata
+ /// [`Subscriber::enabled`]: tracing_core::Subscriber::enabled
+ /// [filtered]: crate::filter::Filtered
+ fn enabled(&self, meta: &Metadata<'_>, cx: &Context<'_, S>) -> bool;
+
+ /// Returns an [`Interest`] indicating whether this layer will [always],
+ /// [sometimes], or [never] be interested in the given [`Metadata`].
+ ///
+ /// When a given callsite will [always] or [never] be enabled, the results
+ /// of evaluating the filter may be cached for improved performance.
+ /// Therefore, if a filter is capable of determining that it will always or
+ /// never enable a particular callsite, providing an implementation of this
+ /// function is recommended.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: If a <code>Filter</code> will perform
+ /// <em>dynamic filtering</em> that depends on the current context in which
+ /// a span or event was observered (e.g. only enabling an event when it
+ /// occurs within a particular span), it <strong>must</strong> return
+ /// <code>Interest::sometimes()</code> from this method. If it returns
+ /// <code>Interest::always()</code> or <code>Interest::never()</code>, the
+ /// <code>enabled</code> method may not be called when a particular instance
+ /// of that span or event is recorded.
+ /// </pre>
+ ///
+ /// This method is broadly similar to [`Subscriber::register_callsite`];
+ /// however, since the returned value represents only the interest of
+ /// *this* layer, the resulting behavior is somewhat different.
+ ///
+ /// If a [`Subscriber`] returns [`Interest::always()`][always] or
+ /// [`Interest::never()`][never] for a given [`Metadata`], its [`enabled`]
+ /// method is then *guaranteed* to never be called for that callsite. On the
+ /// other hand, when a `Filter` returns [`Interest::always()`][always] or
+ /// [`Interest::never()`][never] for a callsite, _other_ [`Layer`]s may have
+ /// differing interests in that callsite. If this is the case, the callsite
+ /// will recieve [`Interest::sometimes()`][sometimes], and the [`enabled`]
+ /// method will still be called for that callsite when it records a span or
+ /// event.
+ ///
+ /// Returning [`Interest::always()`][always] or [`Interest::never()`][never] from
+ /// `Filter::callsite_enabled` will permanently enable or disable a
+ /// callsite (without requiring subsequent calls to [`enabled`]) if and only
+ /// if the following is true:
+ ///
+ /// - all [`Layer`]s that comprise the subscriber include `Filter`s
+ /// (this includes a tree of [`Layered`] layers that share the same
+ /// `Filter`)
+ /// - all those `Filter`s return the same [`Interest`].
+ ///
+ /// For example, if a [`Subscriber`] consists of two [`Filtered`] layers,
+ /// and both of those layers return [`Interest::never()`][never], that
+ /// callsite *will* never be enabled, and the [`enabled`] methods of those
+ /// [`Filter`]s will not be called.
+ ///
+ /// ## Default Implementation
+ ///
+ /// The default implementation of this method assumes that the
+ /// `Filter`'s [`enabled`] method _may_ perform dynamic filtering, and
+ /// returns [`Interest::sometimes()`][sometimes], to ensure that [`enabled`]
+ /// is called to determine whether a particular _instance_ of the callsite
+ /// is enabled in the current context. If this is *not* the case, and the
+ /// `Filter`'s [`enabled`] method will always return the same result
+ /// for a particular [`Metadata`], this method can be overridden as
+ /// follows:
+ ///
+ /// ```
+ /// use tracing_subscriber::layer;
+ /// use tracing_core::{Metadata, subscriber::Interest};
+ ///
+ /// struct MyFilter {
+ /// // ...
+ /// }
+ ///
+ /// impl MyFilter {
+ /// // The actual logic for determining whether a `Metadata` is enabled
+ /// // must be factored out from the `enabled` method, so that it can be
+ /// // called without a `Context` (which is not provided to the
+ /// // `callsite_enabled` method).
+ /// fn is_enabled(&self, metadata: &Metadata<'_>) -> bool {
+ /// // ...
+ /// # drop(metadata); true
+ /// }
+ /// }
+ ///
+ /// impl<S> layer::Filter<S> for MyFilter {
+ /// fn enabled(&self, metadata: &Metadata<'_>, _: &layer::Context<'_, S>) -> bool {
+ /// // Even though we are implementing `callsite_enabled`, we must still provide a
+ /// // working implementation of `enabled`, as returning `Interest::always()` or
+ /// // `Interest::never()` will *allow* caching, but will not *guarantee* it.
+ /// // Other filters may still return `Interest::sometimes()`, so we may be
+ /// // asked again in `enabled`.
+ /// self.is_enabled(metadata)
+ /// }
+ ///
+ /// fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ /// // The result of `self.enabled(metadata, ...)` will always be
+ /// // the same for any given `Metadata`, so we can convert it into
+ /// // an `Interest`:
+ /// if self.is_enabled(metadata) {
+ /// Interest::always()
+ /// } else {
+ /// Interest::never()
+ /// }
+ /// }
+ /// }
+ /// ```
+ ///
+ /// [`Metadata`]: tracing_core::Metadata
+ /// [`Interest`]: tracing_core::Interest
+ /// [always]: tracing_core::Interest::always
+ /// [sometimes]: tracing_core::Interest::sometimes
+ /// [never]: tracing_core::Interest::never
+ /// [`Subscriber::register_callsite`]: tracing_core::Subscriber::register_callsite
+ /// [`Subscriber`]: tracing_core::Subscriber
+ /// [`enabled`]: Filter::enabled
+ /// [`Filtered`]: crate::filter::Filtered
+ fn callsite_enabled(&self, meta: &'static Metadata<'static>) -> Interest {
+ let _ = meta;
+ Interest::sometimes()
+ }
+
+ /// Called before the filtered [`Layer]'s [`on_event`], to determine if
+ /// `on_event` should be called.
+ ///
+ /// This gives a chance to filter events based on their fields. Note,
+ /// however, that this *does not* override [`enabled`], and is not even
+ /// called if [`enabled`] returns `false`.
+ ///
+ /// ## Default Implementation
+ ///
+ /// By default, this method returns `true`, indicating that no events are
+ /// filtered out based on their fields.
+ ///
+ /// [`enabled`]: crate::layer::Filter::enabled
+ /// [`on_event`]: crate::layer::Layer::on_event
+ #[inline] // collapse this to a constant please mrs optimizer
+ fn event_enabled(&self, event: &Event<'_>, cx: &Context<'_, S>) -> bool {
+ let _ = (event, cx);
+ true
+ }
+
+ /// Returns an optional hint of the highest [verbosity level][level] that
+ /// this `Filter` will enable.
+ ///
+ /// If this method returns a [`LevelFilter`], it will be used as a hint to
+ /// determine the most verbose level that will be enabled. This will allow
+ /// spans and events which are more verbose than that level to be skipped
+ /// more efficiently. An implementation of this method is optional, but
+ /// strongly encouraged.
+ ///
+ /// If the maximum level the `Filter` will enable can change over the
+ /// course of its lifetime, it is free to return a different value from
+ /// multiple invocations of this method. However, note that changes in the
+ /// maximum level will **only** be reflected after the callsite [`Interest`]
+ /// cache is rebuilt, by calling the
+ /// [`tracing_core::callsite::rebuild_interest_cache`][rebuild] function.
+ /// Therefore, if the `Filter will change the value returned by this
+ /// method, it is responsible for ensuring that
+ /// [`rebuild_interest_cache`][rebuild] is called after the value of the max
+ /// level changes.
+ ///
+ /// ## Default Implementation
+ ///
+ /// By default, this method returns `None`, indicating that the maximum
+ /// level is unknown.
+ ///
+ /// [level]: tracing_core::metadata::Level
+ /// [`LevelFilter`]: crate::filter::LevelFilter
+ /// [`Interest`]: tracing_core::subscriber::Interest
+ /// [rebuild]: tracing_core::callsite::rebuild_interest_cache
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ None
+ }
+
+ /// Notifies this filter that a new span was constructed with the given
+ /// `Attributes` and `Id`.
+ ///
+ /// By default, this method does nothing. `Filter` implementations that
+ /// need to be notified when new spans are created can override this
+ /// method.
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ let _ = (attrs, id, ctx);
+ }
+
+
+ /// Notifies this filter that a span with the given `Id` recorded the given
+ /// `values`.
+ ///
+ /// By default, this method does nothing. `Filter` implementations that
+ /// need to be notified when new spans are created can override this
+ /// method.
+ fn on_record(&self, id: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ let _ = (id, values, ctx);
+ }
+
+ /// Notifies this filter that a span with the given ID was entered.
+ ///
+ /// By default, this method does nothing. `Filter` implementations that
+ /// need to be notified when a span is entered can override this method.
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ let _ = (id, ctx);
+ }
+
+ /// Notifies this filter that a span with the given ID was exited.
+ ///
+ /// By default, this method does nothing. `Filter` implementations that
+ /// need to be notified when a span is exited can override this method.
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ let _ = (id, ctx);
+ }
+
+ /// Notifies this filter that a span with the given ID has been closed.
+ ///
+ /// By default, this method does nothing. `Filter` implementations that
+ /// need to be notified when a span is closed can override this method.
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ let _ = (id, ctx);
+ }
+ }
+}
+
+/// Extension trait adding a `with(Layer)` combinator to `Subscriber`s.
+pub trait SubscriberExt: Subscriber + crate::sealed::Sealed {
+ /// Wraps `self` with the provided `layer`.
+ fn with<L>(self, layer: L) -> Layered<L, Self>
+ where
+ L: Layer<Self>,
+ Self: Sized,
+ {
+ layer.with_subscriber(self)
+ }
+}
+
+/// A layer that does nothing.
+#[derive(Clone, Debug, Default)]
+pub struct Identity {
+ _p: (),
+}
+
+// === impl Layer ===
+
+#[derive(Clone, Copy)]
+pub(crate) struct NoneLayerMarker(());
+static NONE_LAYER_MARKER: NoneLayerMarker = NoneLayerMarker(());
+
+/// Is a type implementing `Layer` `Option::<_>::None`?
+pub(crate) fn layer_is_none<L, S>(layer: &L) -> bool
+where
+ L: Layer<S>,
+ S: Subscriber,
+{
+ unsafe {
+ // Safety: we're not actually *doing* anything with this pointer ---
+ // this only care about the `Option`, which is essentially being used
+ // as a bool. We can rely on the pointer being valid, because it is
+ // a crate-private type, and is only returned by the `Layer` impl
+ // for `Option`s. However, even if the layer *does* decide to be
+ // evil and give us an invalid pointer here, that's fine, because we'll
+ // never actually dereference it.
+ layer.downcast_raw(TypeId::of::<NoneLayerMarker>())
+ }
+ .is_some()
+}
+
+/// Is a type implementing `Subscriber` `Option::<_>::None`?
+pub(crate) fn subscriber_is_none<S>(subscriber: &S) -> bool
+where
+ S: Subscriber,
+{
+ unsafe {
+ // Safety: we're not actually *doing* anything with this pointer ---
+ // this only care about the `Option`, which is essentially being used
+ // as a bool. We can rely on the pointer being valid, because it is
+ // a crate-private type, and is only returned by the `Layer` impl
+ // for `Option`s. However, even if the subscriber *does* decide to be
+ // evil and give us an invalid pointer here, that's fine, because we'll
+ // never actually dereference it.
+ subscriber.downcast_raw(TypeId::of::<NoneLayerMarker>())
+ }
+ .is_some()
+}
+
+impl<L, S> Layer<S> for Option<L>
+where
+ L: Layer<S>,
+ S: Subscriber,
+{
+ fn on_layer(&mut self, subscriber: &mut S) {
+ if let Some(ref mut layer) = self {
+ layer.on_layer(subscriber)
+ }
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_new_span(attrs, id, ctx)
+ }
+ }
+
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ match self {
+ Some(ref inner) => inner.register_callsite(metadata),
+ None => Interest::always(),
+ }
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ match self {
+ Some(ref inner) => inner.enabled(metadata, ctx),
+ None => true,
+ }
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ match self {
+ Some(ref inner) => inner.max_level_hint(),
+ None => {
+ // There is no inner layer, so this layer will
+ // never enable anything.
+ Some(LevelFilter::OFF)
+ }
+ }
+ }
+
+ #[inline]
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_record(span, values, ctx);
+ }
+ }
+
+ #[inline]
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_follows_from(span, follows, ctx);
+ }
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, ctx: Context<'_, S>) -> bool {
+ match self {
+ Some(ref inner) => inner.event_enabled(event, ctx),
+ None => true,
+ }
+ }
+
+ #[inline]
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_event(event, ctx);
+ }
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_enter(id, ctx);
+ }
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_exit(id, ctx);
+ }
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_close(id, ctx);
+ }
+ }
+
+ #[inline]
+ fn on_id_change(&self, old: &span::Id, new: &span::Id, ctx: Context<'_, S>) {
+ if let Some(ref inner) = self {
+ inner.on_id_change(old, new, ctx)
+ }
+ }
+
+ #[doc(hidden)]
+ #[inline]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ if id == TypeId::of::<Self>() {
+ Some(self as *const _ as *const ())
+ } else if id == TypeId::of::<NoneLayerMarker>() && self.is_none() {
+ Some(&NONE_LAYER_MARKER as *const _ as *const ())
+ } else {
+ self.as_ref().and_then(|inner| inner.downcast_raw(id))
+ }
+ }
+}
+
+feature! {
+ #![any(feature = "std", feature = "alloc")]
+ #[cfg(not(feature = "std"))]
+ use alloc::vec::Vec;
+
+ macro_rules! layer_impl_body {
+ () => {
+ #[inline]
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ self.deref().on_register_dispatch(subscriber);
+ }
+
+ #[inline]
+ fn on_layer(&mut self, subscriber: &mut S) {
+ self.deref_mut().on_layer(subscriber);
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ self.deref().register_callsite(metadata)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ self.deref().enabled(metadata, ctx)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.deref().max_level_hint()
+ }
+
+ #[inline]
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ self.deref().on_record(span, values, ctx)
+ }
+
+ #[inline]
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_follows_from(span, follows, ctx)
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, ctx: Context<'_, S>) -> bool {
+ self.deref().event_enabled(event, ctx)
+ }
+
+ #[inline]
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ self.deref().on_event(event, ctx)
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_enter(id, ctx)
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_exit(id, ctx)
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ self.deref().on_close(id, ctx)
+ }
+
+ #[inline]
+ fn on_id_change(&self, old: &span::Id, new: &span::Id, ctx: Context<'_, S>) {
+ self.deref().on_id_change(old, new, ctx)
+ }
+
+ #[doc(hidden)]
+ #[inline]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ self.deref().downcast_raw(id)
+ }
+ };
+ }
+
+ impl<L, S> Layer<S> for Box<L>
+ where
+ L: Layer<S>,
+ S: Subscriber,
+ {
+ layer_impl_body! {}
+ }
+
+ impl<S> Layer<S> for Box<dyn Layer<S> + Send + Sync>
+ where
+ S: Subscriber,
+ {
+ layer_impl_body! {}
+ }
+
+
+
+ impl<S, L> Layer<S> for Vec<L>
+ where
+ L: Layer<S>,
+ S: Subscriber,
+ {
+
+ fn on_layer(&mut self, subscriber: &mut S) {
+ for l in self {
+ l.on_layer(subscriber);
+ }
+ }
+
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ // Return highest level of interest.
+ let mut interest = Interest::never();
+ for l in self {
+ let new_interest = l.register_callsite(metadata);
+ if (interest.is_sometimes() && new_interest.is_always())
+ || (interest.is_never() && !new_interest.is_never())
+ {
+ interest = new_interest;
+ }
+ }
+
+ interest
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: Context<'_, S>) -> bool {
+ self.iter().all(|l| l.enabled(metadata, ctx.clone()))
+ }
+
+ fn event_enabled(&self, event: &Event<'_>, ctx: Context<'_, S>) -> bool {
+ self.iter().all(|l| l.event_enabled(event, ctx.clone()))
+ }
+
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_new_span(attrs, id, ctx.clone());
+ }
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ // Default to `OFF` if there are no inner layers.
+ let mut max_level = LevelFilter::OFF;
+ for l in self {
+ // NOTE(eliza): this is slightly subtle: if *any* layer
+ // returns `None`, we have to return `None`, assuming there is
+ // no max level hint, since that particular layer cannot
+ // provide a hint.
+ let hint = l.max_level_hint()?;
+ max_level = core::cmp::max(hint, max_level);
+ }
+ Some(max_level)
+ }
+
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_record(span, values, ctx.clone())
+ }
+ }
+
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_follows_from(span, follows, ctx.clone());
+ }
+ }
+
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_event(event, ctx.clone());
+ }
+ }
+
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_enter(id, ctx.clone());
+ }
+ }
+
+ fn on_exit(&self, id: &span::Id, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_exit(id, ctx.clone());
+ }
+ }
+
+ fn on_close(&self, id: span::Id, ctx: Context<'_, S>) {
+ for l in self {
+ l.on_close(id.clone(), ctx.clone());
+ }
+ }
+
+ #[doc(hidden)]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ // If downcasting to `Self`, return a pointer to `self`.
+ if id == TypeId::of::<Self>() {
+ return Some(self as *const _ as *const ());
+ }
+
+ // Someone is looking for per-layer filters. But, this `Vec`
+ // might contain layers with per-layer filters *and*
+ // layers without filters. It should only be treated as a
+ // per-layer-filtered layer if *all* its layers have
+ // per-layer filters.
+ // XXX(eliza): it's a bummer we have to do this linear search every
+ // time. It would be nice if this could be cached, but that would
+ // require replacing the `Vec` impl with an impl for a newtype...
+ if filter::is_plf_downcast_marker(id) && self.iter().any(|s| s.downcast_raw(id).is_none()) {
+ return None;
+ }
+
+ // Otherwise, return the first child of `self` that downcaasts to
+ // the selected type, if any.
+ // XXX(eliza): hope this is reasonable lol
+ self.iter().find_map(|l| l.downcast_raw(id))
+ }
+ }
+}
+
+// === impl SubscriberExt ===
+
+impl<S: Subscriber> crate::sealed::Sealed for S {}
+impl<S: Subscriber> SubscriberExt for S {}
+
+// === impl Identity ===
+
+impl<S: Subscriber> Layer<S> for Identity {}
+
+impl Identity {
+ /// Returns a new `Identity` layer.
+ pub fn new() -> Self {
+ Self { _p: () }
+ }
+}
diff --git a/crates/tracing-subscriber/src/layer/tests.rs b/crates/tracing-subscriber/src/layer/tests.rs
new file mode 100644
index 0000000..d7ad617
--- /dev/null
+++ b/crates/tracing-subscriber/src/layer/tests.rs
@@ -0,0 +1,308 @@
+use super::*;
+use tracing_core::subscriber::NoSubscriber;
+
+#[derive(Debug)]
+pub(crate) struct NopLayer;
+impl<S: Subscriber> Layer<S> for NopLayer {}
+
+#[allow(dead_code)]
+struct NopLayer2;
+impl<S: Subscriber> Layer<S> for NopLayer2 {}
+
+/// A layer that holds a string.
+///
+/// Used to test that pointers returned by downcasting are actually valid.
+struct StringLayer(&'static str);
+impl<S: Subscriber> Layer<S> for StringLayer {}
+struct StringLayer2(&'static str);
+impl<S: Subscriber> Layer<S> for StringLayer2 {}
+
+struct StringLayer3(&'static str);
+impl<S: Subscriber> Layer<S> for StringLayer3 {}
+
+pub(crate) struct StringSubscriber(&'static str);
+
+impl Subscriber for StringSubscriber {
+ fn register_callsite(&self, _: &'static Metadata<'static>) -> Interest {
+ Interest::never()
+ }
+
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ false
+ }
+
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(1)
+ }
+
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+ fn event(&self, _: &Event<'_>) {}
+ fn enter(&self, _: &span::Id) {}
+ fn exit(&self, _: &span::Id) {}
+}
+
+fn assert_subscriber(_s: impl Subscriber) {}
+fn assert_layer<S: Subscriber>(_l: &impl Layer<S>) {}
+
+#[test]
+fn layer_is_subscriber() {
+ let s = NopLayer.with_subscriber(NoSubscriber::default());
+ assert_subscriber(s)
+}
+
+#[test]
+fn two_layers_are_subscriber() {
+ let s = NopLayer
+ .and_then(NopLayer)
+ .with_subscriber(NoSubscriber::default());
+ assert_subscriber(s)
+}
+
+#[test]
+fn three_layers_are_subscriber() {
+ let s = NopLayer
+ .and_then(NopLayer)
+ .and_then(NopLayer)
+ .with_subscriber(NoSubscriber::default());
+ assert_subscriber(s)
+}
+
+#[test]
+fn three_layers_are_layer() {
+ let layers = NopLayer.and_then(NopLayer).and_then(NopLayer);
+ assert_layer(&layers);
+ let _ = layers.with_subscriber(NoSubscriber::default());
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn box_layer_is_layer() {
+ use alloc::boxed::Box;
+ let l: Box<dyn Layer<NoSubscriber> + Send + Sync> = Box::new(NopLayer);
+ assert_layer(&l);
+ l.with_subscriber(NoSubscriber::default());
+}
+
+#[test]
+fn downcasts_to_subscriber() {
+ let s = NopLayer
+ .and_then(NopLayer)
+ .and_then(NopLayer)
+ .with_subscriber(StringSubscriber("subscriber"));
+ let subscriber =
+ <dyn Subscriber>::downcast_ref::<StringSubscriber>(&s).expect("subscriber should downcast");
+ assert_eq!(subscriber.0, "subscriber");
+}
+
+#[test]
+fn downcasts_to_layer() {
+ let s = StringLayer("layer_1")
+ .and_then(StringLayer2("layer_2"))
+ .and_then(StringLayer3("layer_3"))
+ .with_subscriber(NoSubscriber::default());
+ let layer = <dyn Subscriber>::downcast_ref::<StringLayer>(&s).expect("layer 1 should downcast");
+ assert_eq!(layer.0, "layer_1");
+ let layer =
+ <dyn Subscriber>::downcast_ref::<StringLayer2>(&s).expect("layer 2 should downcast");
+ assert_eq!(layer.0, "layer_2");
+ let layer =
+ <dyn Subscriber>::downcast_ref::<StringLayer3>(&s).expect("layer 3 should downcast");
+ assert_eq!(layer.0, "layer_3");
+}
+
+#[cfg(all(feature = "registry", feature = "std"))]
+mod registry_tests {
+ use super::*;
+ use crate::registry::LookupSpan;
+
+ #[test]
+ fn context_event_span() {
+ use std::sync::{Arc, Mutex};
+ let last_event_span = Arc::new(Mutex::new(None));
+
+ struct RecordingLayer {
+ last_event_span: Arc<Mutex<Option<&'static str>>>,
+ }
+
+ impl<S> Layer<S> for RecordingLayer
+ where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ {
+ fn on_event(&self, event: &Event<'_>, ctx: Context<'_, S>) {
+ let span = ctx.event_span(event);
+ *self.last_event_span.lock().unwrap() = span.map(|s| s.name());
+ }
+ }
+
+ tracing::subscriber::with_default(
+ crate::registry().with(RecordingLayer {
+ last_event_span: last_event_span.clone(),
+ }),
+ || {
+ tracing::info!("no span");
+ assert_eq!(*last_event_span.lock().unwrap(), None);
+
+ let parent = tracing::info_span!("explicit");
+ tracing::info!(parent: &parent, "explicit span");
+ assert_eq!(*last_event_span.lock().unwrap(), Some("explicit"));
+
+ let _guard = tracing::info_span!("contextual").entered();
+ tracing::info!("contextual span");
+ assert_eq!(*last_event_span.lock().unwrap(), Some("contextual"));
+ },
+ );
+ }
+
+ /// Tests for how max-level hints are calculated when combining layers
+ /// with and without per-layer filtering.
+ mod max_level_hints {
+
+ use super::*;
+ use crate::filter::*;
+
+ #[test]
+ fn mixed_with_unfiltered() {
+ let subscriber = crate::registry()
+ .with(NopLayer)
+ .with(NopLayer.with_filter(LevelFilter::INFO));
+ assert_eq!(subscriber.max_level_hint(), None);
+ }
+
+ #[test]
+ fn mixed_with_unfiltered_layered() {
+ let subscriber = crate::registry().with(NopLayer).with(
+ NopLayer
+ .with_filter(LevelFilter::INFO)
+ .and_then(NopLayer.with_filter(LevelFilter::TRACE)),
+ );
+ assert_eq!(dbg!(subscriber).max_level_hint(), None);
+ }
+
+ #[test]
+ fn mixed_interleaved() {
+ let subscriber = crate::registry()
+ .with(NopLayer)
+ .with(NopLayer.with_filter(LevelFilter::INFO))
+ .with(NopLayer)
+ .with(NopLayer.with_filter(LevelFilter::INFO));
+ assert_eq!(dbg!(subscriber).max_level_hint(), None);
+ }
+
+ #[test]
+ fn mixed_layered() {
+ let subscriber = crate::registry()
+ .with(NopLayer.with_filter(LevelFilter::INFO).and_then(NopLayer))
+ .with(NopLayer.and_then(NopLayer.with_filter(LevelFilter::INFO)));
+ assert_eq!(dbg!(subscriber).max_level_hint(), None);
+ }
+
+ #[test]
+ fn plf_only_unhinted() {
+ let subscriber = crate::registry()
+ .with(NopLayer.with_filter(LevelFilter::INFO))
+ .with(NopLayer.with_filter(filter_fn(|_| true)));
+ assert_eq!(dbg!(subscriber).max_level_hint(), None);
+ }
+
+ #[test]
+ fn plf_only_unhinted_nested_outer() {
+ // if a nested tree of per-layer filters has an _outer_ filter with
+ // no max level hint, it should return `None`.
+ let subscriber = crate::registry()
+ .with(
+ NopLayer
+ .with_filter(LevelFilter::INFO)
+ .and_then(NopLayer.with_filter(LevelFilter::WARN)),
+ )
+ .with(
+ NopLayer
+ .with_filter(filter_fn(|_| true))
+ .and_then(NopLayer.with_filter(LevelFilter::DEBUG)),
+ );
+ assert_eq!(dbg!(subscriber).max_level_hint(), None);
+ }
+
+ #[test]
+ fn plf_only_unhinted_nested_inner() {
+ // If a nested tree of per-layer filters has an _inner_ filter with
+ // no max-level hint, but the _outer_ filter has a max level hint,
+ // it should pick the outer hint. This is because the outer filter
+ // will disable the spans/events before they make it to the inner
+ // filter.
+ let subscriber = dbg!(crate::registry().with(
+ NopLayer
+ .with_filter(filter_fn(|_| true))
+ .and_then(NopLayer.with_filter(filter_fn(|_| true)))
+ .with_filter(LevelFilter::INFO),
+ ));
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::INFO));
+ }
+
+ #[test]
+ fn unhinted_nested_inner() {
+ let subscriber = dbg!(crate::registry()
+ .with(NopLayer.and_then(NopLayer).with_filter(LevelFilter::INFO))
+ .with(
+ NopLayer
+ .with_filter(filter_fn(|_| true))
+ .and_then(NopLayer.with_filter(filter_fn(|_| true)))
+ .with_filter(LevelFilter::WARN),
+ ));
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::INFO));
+ }
+
+ #[test]
+ fn unhinted_nested_inner_mixed() {
+ let subscriber = dbg!(crate::registry()
+ .with(
+ NopLayer
+ .and_then(NopLayer.with_filter(filter_fn(|_| true)))
+ .with_filter(LevelFilter::INFO)
+ )
+ .with(
+ NopLayer
+ .with_filter(filter_fn(|_| true))
+ .and_then(NopLayer.with_filter(filter_fn(|_| true)))
+ .with_filter(LevelFilter::WARN),
+ ));
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::INFO));
+ }
+
+ #[test]
+ fn plf_only_picks_max() {
+ let subscriber = crate::registry()
+ .with(NopLayer.with_filter(LevelFilter::WARN))
+ .with(NopLayer.with_filter(LevelFilter::DEBUG));
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::DEBUG));
+ }
+
+ #[test]
+ fn many_plf_only_picks_max() {
+ let subscriber = crate::registry()
+ .with(NopLayer.with_filter(LevelFilter::WARN))
+ .with(NopLayer.with_filter(LevelFilter::DEBUG))
+ .with(NopLayer.with_filter(LevelFilter::INFO))
+ .with(NopLayer.with_filter(LevelFilter::ERROR));
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::DEBUG));
+ }
+
+ #[test]
+ fn nested_plf_only_picks_max() {
+ let subscriber = crate::registry()
+ .with(
+ NopLayer.with_filter(LevelFilter::INFO).and_then(
+ NopLayer
+ .with_filter(LevelFilter::WARN)
+ .and_then(NopLayer.with_filter(LevelFilter::DEBUG)),
+ ),
+ )
+ .with(
+ NopLayer
+ .with_filter(LevelFilter::INFO)
+ .and_then(NopLayer.with_filter(LevelFilter::ERROR)),
+ );
+ assert_eq!(dbg!(subscriber).max_level_hint(), Some(LevelFilter::DEBUG));
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/lib.rs b/crates/tracing-subscriber/src/lib.rs
new file mode 100644
index 0000000..21cfe70
--- /dev/null
+++ b/crates/tracing-subscriber/src/lib.rs
@@ -0,0 +1,250 @@
+//! Utilities for implementing and composing [`tracing`] subscribers.
+//!
+//! [`tracing`] is a framework for instrumenting Rust programs to collect
+//! scoped, structured, and async-aware diagnostics. The [`Subscriber`] trait
+//! represents the functionality necessary to collect this trace data. This
+//! crate contains tools for composing subscribers out of smaller units of
+//! behaviour, and batteries-included implementations of common subscriber
+//! functionality.
+//!
+//! `tracing-subscriber` is intended for use by both `Subscriber` authors and
+//! application authors using `tracing` to instrument their applications.
+//!
+//! *Compiler support: [requires `rustc` 1.63+][msrv]*
+//!
+//! [msrv]: #supported-rust-versions
+//!
+//! ## `Layer`s and `Filter`s
+//!
+//! The most important component of the `tracing-subscriber` API is the
+//! [`Layer`] trait, which provides a composable abstraction for building
+//! [`Subscriber`]s. Like the [`Subscriber`] trait, a [`Layer`] defines a
+//! particular behavior for collecting trace data. Unlike [`Subscriber`]s,
+//! which implement a *complete* strategy for how trace data is collected,
+//! [`Layer`]s provide *modular* implementations of specific behaviors.
+//! Therefore, they can be [composed together] to form a [`Subscriber`] which is
+//! capable of recording traces in a variety of ways. See the [`layer` module's
+//! documentation][layer] for details on using [`Layer`]s.
+//!
+//! In addition, the [`Filter`] trait defines an interface for filtering what
+//! spans and events are recorded by a particular layer. This allows different
+//! [`Layer`]s to handle separate subsets of the trace data emitted by a
+//! program. See the [documentation on per-layer filtering][plf] for more
+//! information on using [`Filter`]s.
+//!
+//! [`Layer`]: crate::layer::Layer
+//! [composed together]: crate::layer#composing-layers
+//! [layer]: crate::layer
+//! [`Filter`]: crate::layer::Filter
+//! [plf]: crate::layer#per-layer-filtering
+//!
+//! ## Included Subscribers
+//!
+//! The following `Subscriber`s are provided for application authors:
+//!
+//! - [`fmt`] - Formats and logs tracing data (requires the `fmt` feature flag)
+//!
+//! ## Feature Flags
+//!
+//! - `std`: Enables APIs that depend on the Rust standard library
+//! (enabled by default).
+//! - `alloc`: Depend on [`liballoc`] (enabled by "std").
+//! - `env-filter`: Enables the [`EnvFilter`] type, which implements filtering
+//! similar to the [`env_logger` crate]. **Requires "std"**.
+//! - `fmt`: Enables the [`fmt`] module, which provides a subscriber
+//! implementation for printing formatted representations of trace events.
+//! Enabled by default. **Requires "registry" and "std"**.
+//! - `ansi`: Enables `fmt` support for ANSI terminal colors. Enabled by
+//! default.
+//! - `registry`: enables the [`registry`] module. Enabled by default.
+//! **Requires "std"**.
+//! - `json`: Enables `fmt` support for JSON output. In JSON output, the ANSI
+//! feature does nothing. **Requires "fmt" and "std"**.
+//! - `local-time`: Enables local time formatting when using the [`time`
+//! crate]'s timestamp formatters with the `fmt` subscriber.
+//!
+//! [`registry`]: mod@registry
+//!
+//! ### Optional Dependencies
+//!
+//! - [`tracing-log`]: Enables better formatting for events emitted by `log`
+//! macros in the `fmt` subscriber. Enabled by default.
+//! - [`time`][`time` crate]: Enables support for using the [`time` crate] for timestamp
+//! formatting in the `fmt` subscriber.
+//! - [`smallvec`]: Causes the `EnvFilter` type to use the `smallvec` crate (rather
+//! than `Vec`) as a performance optimization. Enabled by default.
+//! - [`parking_lot`]: Use the `parking_lot` crate's `RwLock` implementation
+//! rather than the Rust standard library's implementation.
+//!
+//! ### `no_std` Support
+//!
+//! In embedded systems and other bare-metal applications, `tracing` can be
+//! used without requiring the Rust standard library, although some features are
+//! disabled. Although most of the APIs provided by `tracing-subscriber`, such
+//! as [`fmt`] and [`EnvFilter`], require the standard library, some
+//! functionality, such as the [`Layer`] trait, can still be used in
+//! `no_std` environments.
+//!
+//! The dependency on the standard library is controlled by two crate feature
+//! flags, "std", which enables the dependency on [`libstd`], and "alloc", which
+//! enables the dependency on [`liballoc`] (and is enabled by the "std"
+//! feature). These features are enabled by default, but `no_std` users can
+//! disable them using:
+//!
+//! ```toml
+//! # Cargo.toml
+//! tracing-subscriber = { version = "0.3", default-features = false }
+//! ```
+//!
+//! Additional APIs are available when [`liballoc`] is available. To enable
+//! `liballoc` but not `std`, use:
+//!
+//! ```toml
+//! # Cargo.toml
+//! tracing-subscriber = { version = "0.3", default-features = false, features = ["alloc"] }
+//! ```
+//!
+//! ### Unstable Features
+//!
+//! These feature flags enable **unstable** features. The public API may break in 0.1.x
+//! releases. To enable these features, the `--cfg tracing_unstable` must be passed to
+//! `rustc` when compiling.
+//!
+//! The following unstable feature flags are currently available:
+//!
+//! * `valuable`: Enables support for serializing values recorded using the
+//! [`valuable`] crate as structured JSON in the [`format::Json`] formatter.
+//!
+//! #### Enabling Unstable Features
+//!
+//! The easiest way to set the `tracing_unstable` cfg is to use the `RUSTFLAGS`
+//! env variable when running `cargo` commands:
+//!
+//! ```shell
+//! RUSTFLAGS="--cfg tracing_unstable" cargo build
+//! ```
+//! Alternatively, the following can be added to the `.cargo/config` file in a
+//! project to automatically enable the cfg flag for that project:
+//!
+//! ```toml
+//! [build]
+//! rustflags = ["--cfg", "tracing_unstable"]
+//! ```
+//!
+//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
+//! [`valuable`]: https://crates.io/crates/valuable
+//! [`format::Json`]: crate::fmt::format::Json
+//!
+//! ## Supported Rust Versions
+//!
+//! Tracing is built against the latest stable release. The minimum supported
+//! version is 1.63. The current Tracing version is not guaranteed to build on
+//! Rust versions earlier than the minimum supported version.
+//!
+//! Tracing follows the same compiler support policies as the rest of the Tokio
+//! project. The current stable Rust compiler and the three most recent minor
+//! versions before it will always be supported. For example, if the current
+//! stable compiler version is 1.69, the minimum supported version will not be
+//! increased past 1.66, three minor versions prior. Increasing the minimum
+//! supported compiler version is not considered a semver breaking change as
+//! long as doing so complies with this policy.
+//!
+//! [`Subscriber`]: tracing_core::subscriber::Subscriber
+//! [`tracing`]: https://docs.rs/tracing/latest/tracing
+//! [`EnvFilter`]: filter::EnvFilter
+//! [`fmt`]: mod@fmt
+//! [`tracing-log`]: https://crates.io/crates/tracing-log
+//! [`smallvec`]: https://crates.io/crates/smallvec
+//! [`env_logger` crate]: https://crates.io/crates/env_logger
+//! [`parking_lot`]: https://crates.io/crates/parking_lot
+//! [`time` crate]: https://crates.io/crates/time
+//! [`liballoc`]: https://doc.rust-lang.org/alloc/index.html
+//! [`libstd`]: https://doc.rust-lang.org/std/index.html
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
+ issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
+#![cfg_attr(
+ docsrs,
+ // Allows displaying cfgs/feature flags in the documentation.
+ feature(doc_cfg),
+ // Allows adding traits to RustDoc's list of "notable traits"
+ feature(doc_notable_trait),
+ // Fail the docs build if any intra-docs links are broken
+ deny(rustdoc::broken_intra_doc_links),
+)]
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub,
+ bad_style,
+ dead_code,
+ improper_ctypes,
+ non_shorthand_field_patterns,
+ no_mangle_generic_items,
+ overflowing_literals,
+ path_statements,
+ patterns_in_fns_without_body,
+ private_in_public,
+ unconditional_recursion,
+ unused,
+ unused_allocation,
+ unused_comparisons,
+ unused_parens,
+ while_true
+)]
+// Using struct update syntax when a struct has no additional fields avoids
+// a potential source change if additional fields are added to the struct in the
+// future, reducing diff noise. Allow this even though clippy considers it
+// "needless".
+#![allow(clippy::needless_update)]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+#[cfg(feature = "alloc")]
+extern crate alloc;
+
+#[macro_use]
+mod macros;
+
+pub mod field;
+pub mod filter;
+pub mod prelude;
+pub mod registry;
+
+pub mod layer;
+pub mod util;
+
+feature! {
+ #![feature = "std"]
+ pub mod reload;
+ pub(crate) mod sync;
+}
+
+feature! {
+ #![all(feature = "fmt", feature = "std")]
+ pub mod fmt;
+ pub use fmt::fmt;
+ pub use fmt::Subscriber as FmtSubscriber;
+}
+
+feature! {
+ #![all(feature = "env-filter", feature = "std")]
+ pub use filter::EnvFilter;
+}
+
+pub use layer::Layer;
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+ pub use registry::Registry;
+
+ ///
+ pub fn registry() -> Registry {
+ Registry::default()
+ }
+}
+
+mod sealed {
+ pub trait Sealed<A = ()> {}
+}
diff --git a/crates/tracing-subscriber/src/macros.rs b/crates/tracing-subscriber/src/macros.rs
new file mode 100644
index 0000000..5b461d0
--- /dev/null
+++ b/crates/tracing-subscriber/src/macros.rs
@@ -0,0 +1,28 @@
+#[cfg(feature = "std")]
+macro_rules! try_lock {
+ ($lock:expr) => {
+ try_lock!($lock, else return)
+ };
+ ($lock:expr, else $els:expr) => {
+ if let ::core::result::Result::Ok(l) = $lock {
+ l
+ } else if std::thread::panicking() {
+ $els
+ } else {
+ panic!("lock poisoned")
+ }
+ };
+}
+
+macro_rules! feature {
+ (
+ #![$meta:meta]
+ $($item:item)*
+ ) => {
+ $(
+ #[cfg($meta)]
+ #[cfg_attr(docsrs, doc(cfg($meta)))]
+ $item
+ )*
+ }
+}
diff --git a/crates/tracing-subscriber/src/prelude.rs b/crates/tracing-subscriber/src/prelude.rs
new file mode 100644
index 0000000..c223090
--- /dev/null
+++ b/crates/tracing-subscriber/src/prelude.rs
@@ -0,0 +1,19 @@
+//! The `tracing-subscriber` prelude.
+//!
+//! This brings into scope a number of extension traits that define methods on
+//! types defined here and in other crates.
+
+pub use crate::field::{
+ MakeExt as __tracing_subscriber_field_MakeExt,
+ RecordFields as __tracing_subscriber_field_RecordFields,
+};
+pub use crate::layer::{
+ Layer as __tracing_subscriber_Layer, SubscriberExt as __tracing_subscriber_SubscriberExt,
+};
+
+pub use crate::util::SubscriberInitExt as _;
+
+feature! {
+ #![all(feature = "fmt", feature = "std")]
+ pub use crate::fmt::writer::MakeWriterExt as _;
+}
diff --git a/crates/tracing-subscriber/src/registry/extensions.rs b/crates/tracing-subscriber/src/registry/extensions.rs
new file mode 100644
index 0000000..ff76fb5
--- /dev/null
+++ b/crates/tracing-subscriber/src/registry/extensions.rs
@@ -0,0 +1,274 @@
+// taken from https://github.com/hyperium/http/blob/master/src/extensions.rs.
+
+use crate::sync::{RwLockReadGuard, RwLockWriteGuard};
+use std::{
+ any::{Any, TypeId},
+ collections::HashMap,
+ fmt,
+ hash::{BuildHasherDefault, Hasher},
+};
+
+#[allow(warnings)]
+type AnyMap = HashMap<TypeId, Box<dyn Any + Send + Sync>, BuildHasherDefault<IdHasher>>;
+
+/// With TypeIds as keys, there's no need to hash them. They are already hashes
+/// themselves, coming from the compiler. The IdHasher holds the u64 of
+/// the TypeId, and then returns it, instead of doing any bit fiddling.
+#[derive(Default, Debug)]
+struct IdHasher(u64);
+
+impl Hasher for IdHasher {
+ fn write(&mut self, _: &[u8]) {
+ unreachable!("TypeId calls write_u64");
+ }
+
+ #[inline]
+ fn write_u64(&mut self, id: u64) {
+ self.0 = id;
+ }
+
+ #[inline]
+ fn finish(&self) -> u64 {
+ self.0
+ }
+}
+
+/// An immutable, read-only reference to a Span's extensions.
+#[derive(Debug)]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub struct Extensions<'a> {
+ inner: RwLockReadGuard<'a, ExtensionsInner>,
+}
+
+impl<'a> Extensions<'a> {
+ #[cfg(feature = "registry")]
+ pub(crate) fn new(inner: RwLockReadGuard<'a, ExtensionsInner>) -> Self {
+ Self { inner }
+ }
+
+ /// Immutably borrows a type previously inserted into this `Extensions`.
+ pub fn get<T: 'static>(&self) -> Option<&T> {
+ self.inner.get::<T>()
+ }
+}
+
+/// An mutable reference to a Span's extensions.
+#[derive(Debug)]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub struct ExtensionsMut<'a> {
+ inner: RwLockWriteGuard<'a, ExtensionsInner>,
+}
+
+impl<'a> ExtensionsMut<'a> {
+ #[cfg(feature = "registry")]
+ pub(crate) fn new(inner: RwLockWriteGuard<'a, ExtensionsInner>) -> Self {
+ Self { inner }
+ }
+
+ /// Insert a type into this `Extensions`.
+ ///
+ /// Note that extensions are _not_
+ /// `Layer`-specific—they are _span_-specific. This means that
+ /// other layers can access and mutate extensions that
+ /// a different Layer recorded. For example, an application might
+ /// have a layer that records execution timings, alongside a layer
+ /// that reports spans and events to a distributed
+ /// tracing system that requires timestamps for spans.
+ /// Ideally, if one layer records a timestamp _x_, the other layer
+ /// should be able to reuse timestamp _x_.
+ ///
+ /// Therefore, extensions should generally be newtypes, rather than common
+ /// types like [`String`](std::string::String), to avoid accidental
+ /// cross-`Layer` clobbering.
+ ///
+ /// ## Panics
+ ///
+ /// If `T` is already present in `Extensions`, then this method will panic.
+ pub fn insert<T: Send + Sync + 'static>(&mut self, val: T) {
+ assert!(self.replace(val).is_none())
+ }
+
+ /// Replaces an existing `T` into this extensions.
+ ///
+ /// If `T` is not present, `Option::None` will be returned.
+ pub fn replace<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
+ self.inner.insert(val)
+ }
+
+ /// Get a mutable reference to a type previously inserted on this `ExtensionsMut`.
+ pub fn get_mut<T: 'static>(&mut self) -> Option<&mut T> {
+ self.inner.get_mut::<T>()
+ }
+
+ /// Remove a type from this `Extensions`.
+ ///
+ /// If a extension of this type existed, it will be returned.
+ pub fn remove<T: Send + Sync + 'static>(&mut self) -> Option<T> {
+ self.inner.remove::<T>()
+ }
+}
+
+/// A type map of span extensions.
+///
+/// [ExtensionsInner] is used by `SpanData` to store and
+/// span-specific data. A given `Layer` can read and write
+/// data that it is interested in recording and emitting.
+#[derive(Default)]
+pub(crate) struct ExtensionsInner {
+ map: AnyMap,
+}
+
+impl ExtensionsInner {
+ /// Create an empty `Extensions`.
+ #[cfg(any(test, feature = "registry"))]
+ #[inline]
+ #[cfg(any(test, feature = "registry"))]
+ pub(crate) fn new() -> ExtensionsInner {
+ ExtensionsInner {
+ map: AnyMap::default(),
+ }
+ }
+
+ /// Insert a type into this `Extensions`.
+ ///
+ /// If a extension of this type already existed, it will
+ /// be returned.
+ pub(crate) fn insert<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
+ self.map
+ .insert(TypeId::of::<T>(), Box::new(val))
+ .and_then(|boxed| {
+ #[allow(warnings)]
+ {
+ (boxed as Box<Any + 'static>)
+ .downcast()
+ .ok()
+ .map(|boxed| *boxed)
+ }
+ })
+ }
+
+ /// Get a reference to a type previously inserted on this `Extensions`.
+ pub(crate) fn get<T: 'static>(&self) -> Option<&T> {
+ self.map
+ .get(&TypeId::of::<T>())
+ .and_then(|boxed| (&**boxed as &(dyn Any + 'static)).downcast_ref())
+ }
+
+ /// Get a mutable reference to a type previously inserted on this `Extensions`.
+ pub(crate) fn get_mut<T: 'static>(&mut self) -> Option<&mut T> {
+ self.map
+ .get_mut(&TypeId::of::<T>())
+ .and_then(|boxed| (&mut **boxed as &mut (dyn Any + 'static)).downcast_mut())
+ }
+
+ /// Remove a type from this `Extensions`.
+ ///
+ /// If a extension of this type existed, it will be returned.
+ pub(crate) fn remove<T: Send + Sync + 'static>(&mut self) -> Option<T> {
+ self.map.remove(&TypeId::of::<T>()).and_then(|boxed| {
+ #[allow(warnings)]
+ {
+ (boxed as Box<Any + 'static>)
+ .downcast()
+ .ok()
+ .map(|boxed| *boxed)
+ }
+ })
+ }
+
+ /// Clear the `ExtensionsInner` in-place, dropping any elements in the map but
+ /// retaining allocated capacity.
+ ///
+ /// This permits the hash map allocation to be pooled by the registry so
+ /// that future spans will not need to allocate new hashmaps.
+ #[cfg(any(test, feature = "registry"))]
+ pub(crate) fn clear(&mut self) {
+ self.map.clear();
+ }
+}
+
+impl fmt::Debug for ExtensionsInner {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("Extensions")
+ .field("len", &self.map.len())
+ .field("capacity", &self.map.capacity())
+ .finish()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[derive(Debug, PartialEq)]
+ struct MyType(i32);
+
+ #[test]
+ fn test_extensions() {
+ let mut extensions = ExtensionsInner::new();
+
+ extensions.insert(5i32);
+ extensions.insert(MyType(10));
+
+ assert_eq!(extensions.get(), Some(&5i32));
+ assert_eq!(extensions.get_mut(), Some(&mut 5i32));
+
+ assert_eq!(extensions.remove::<i32>(), Some(5i32));
+ assert!(extensions.get::<i32>().is_none());
+
+ assert_eq!(extensions.get::<bool>(), None);
+ assert_eq!(extensions.get(), Some(&MyType(10)));
+ }
+
+ #[test]
+ fn clear_retains_capacity() {
+ let mut extensions = ExtensionsInner::new();
+ extensions.insert(5i32);
+ extensions.insert(MyType(10));
+ extensions.insert(true);
+
+ assert_eq!(extensions.map.len(), 3);
+ let prev_capacity = extensions.map.capacity();
+ extensions.clear();
+
+ assert_eq!(
+ extensions.map.len(),
+ 0,
+ "after clear(), extensions map should have length 0"
+ );
+ assert_eq!(
+ extensions.map.capacity(),
+ prev_capacity,
+ "after clear(), extensions map should retain prior capacity"
+ );
+ }
+
+ #[test]
+ fn clear_drops_elements() {
+ use std::sync::Arc;
+ struct DropMePlease(Arc<()>);
+ struct DropMeTooPlease(Arc<()>);
+
+ let mut extensions = ExtensionsInner::new();
+ let val1 = DropMePlease(Arc::new(()));
+ let val2 = DropMeTooPlease(Arc::new(()));
+
+ let val1_dropped = Arc::downgrade(&val1.0);
+ let val2_dropped = Arc::downgrade(&val2.0);
+ extensions.insert(val1);
+ extensions.insert(val2);
+
+ assert!(val1_dropped.upgrade().is_some());
+ assert!(val2_dropped.upgrade().is_some());
+
+ extensions.clear();
+ assert!(
+ val1_dropped.upgrade().is_none(),
+ "after clear(), val1 should be dropped"
+ );
+ assert!(
+ val2_dropped.upgrade().is_none(),
+ "after clear(), val2 should be dropped"
+ );
+ }
+}
diff --git a/crates/tracing-subscriber/src/registry/mod.rs b/crates/tracing-subscriber/src/registry/mod.rs
new file mode 100644
index 0000000..1617f5c
--- /dev/null
+++ b/crates/tracing-subscriber/src/registry/mod.rs
@@ -0,0 +1,598 @@
+//! Storage for span data shared by multiple [`Layer`]s.
+//!
+//! ## Using the Span Registry
+//!
+//! This module provides the [`Registry`] type, a [`Subscriber`] implementation
+//! which tracks per-span data and exposes it to [`Layer`]s. When a `Registry`
+//! is used as the base `Subscriber` of a `Layer` stack, the
+//! [`layer::Context`][ctx] type will provide methods allowing `Layer`s to
+//! [look up span data][lookup] stored in the registry. While [`Registry`] is a
+//! reasonable default for storing spans and events, other stores that implement
+//! [`LookupSpan`] and [`Subscriber`] themselves (with [`SpanData`] implemented
+//! by the per-span data they store) can be used as a drop-in replacement.
+//!
+//! For example, we might create a `Registry` and add multiple `Layer`s like so:
+//! ```rust
+//! use tracing_subscriber::{registry::Registry, Layer, prelude::*};
+//! # use tracing_core::Subscriber;
+//! # pub struct FooLayer {}
+//! # pub struct BarLayer {}
+//! # impl<S: Subscriber> Layer<S> for FooLayer {}
+//! # impl<S: Subscriber> Layer<S> for BarLayer {}
+//! # impl FooLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//! # impl BarLayer {
+//! # fn new() -> Self { Self {} }
+//! # }
+//!
+//! let subscriber = Registry::default()
+//! .with(FooLayer::new())
+//! .with(BarLayer::new());
+//! ```
+//!
+//! If a type implementing `Layer` depends on the functionality of a `Registry`
+//! implementation, it should bound its `Subscriber` type parameter with the
+//! [`LookupSpan`] trait, like so:
+//!
+//! ```rust
+//! use tracing_subscriber::{registry, Layer};
+//! use tracing_core::Subscriber;
+//!
+//! pub struct MyLayer {
+//! // ...
+//! }
+//!
+//! impl<S> Layer<S> for MyLayer
+//! where
+//! S: Subscriber + for<'a> registry::LookupSpan<'a>,
+//! {
+//! // ...
+//! }
+//! ```
+//! When this bound is added, the `Layer` implementation will be guaranteed
+//! access to the [`Context`][ctx] methods, such as [`Context::span`][lookup], that
+//! require the root subscriber to be a registry.
+//!
+//! [`Layer`]: crate::layer::Layer
+//! [`Subscriber`]: tracing_core::Subscriber
+//! [ctx]: crate::layer::Context
+//! [lookup]: crate::layer::Context::span()
+use tracing_core::{field::FieldSet, span::Id, Metadata};
+
+feature! {
+ #![feature = "std"]
+ /// A module containing a type map of span extensions.
+ mod extensions;
+ pub use extensions::{Extensions, ExtensionsMut};
+
+}
+
+feature! {
+ #![all(feature = "registry", feature = "std")]
+
+ mod sharded;
+ mod stack;
+
+ pub use sharded::Data;
+ pub use sharded::Registry;
+
+ use crate::filter::FilterId;
+}
+
+/// Provides access to stored span data.
+///
+/// Subscribers which store span data and associate it with span IDs should
+/// implement this trait; if they do, any [`Layer`]s wrapping them can look up
+/// metadata via the [`Context`] type's [`span()`] method.
+///
+/// [`Layer`]: super::layer::Layer
+/// [`Context`]: super::layer::Context
+/// [`span()`]: super::layer::Context::span
+pub trait LookupSpan<'a> {
+ /// The type of span data stored in this registry.
+ type Data: SpanData<'a>;
+
+ /// Returns the [`SpanData`] for a given `Id`, if it exists.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: users of the <code>LookupSpan</code> trait should
+ /// typically call the <a href="#method.span"><code>span</code></a> method rather
+ /// than this method. The <code>span</code> method is implemented by
+ /// <em>calling</em> <code>span_data</code>, but returns a reference which is
+ /// capable of performing more sophisiticated queries.
+ /// </pre>
+ ///
+ fn span_data(&'a self, id: &Id) -> Option<Self::Data>;
+
+ /// Returns a [`SpanRef`] for the span with the given `Id`, if it exists.
+ ///
+ /// A `SpanRef` is similar to [`SpanData`], but it allows performing
+ /// additional lookups against the registryr that stores the wrapped data.
+ ///
+ /// In general, _users_ of the `LookupSpan` trait should use this method
+ /// rather than the [`span_data`] method; while _implementors_ of this trait
+ /// should only implement `span_data`.
+ ///
+ /// [`span_data`]: LookupSpan::span_data()
+ fn span(&'a self, id: &Id) -> Option<SpanRef<'_, Self>>
+ where
+ Self: Sized,
+ {
+ let data = self.span_data(id)?;
+ Some(SpanRef {
+ registry: self,
+ data,
+ #[cfg(feature = "registry")]
+ filter: FilterId::none(),
+ })
+ }
+
+ /// Registers a [`Filter`] for [per-layer filtering] with this
+ /// [`Subscriber`].
+ ///
+ /// The [`Filter`] can then use the returned [`FilterId`] to
+ /// [check if it previously enabled a span][check].
+ ///
+ /// # Panics
+ ///
+ /// If this `Subscriber` does not support [per-layer filtering].
+ ///
+ /// [`Filter`]: crate::layer::Filter
+ /// [per-layer filtering]: crate::layer::Layer#per-layer-filtering
+ /// [`Subscriber`]: tracing_core::Subscriber
+ /// [`FilterId`]: crate::filter::FilterId
+ /// [check]: SpanData::is_enabled_for
+ #[cfg(feature = "registry")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+ fn register_filter(&mut self) -> FilterId {
+ panic!(
+ "{} does not currently support filters",
+ std::any::type_name::<Self>()
+ )
+ }
+}
+
+/// A stored representation of data associated with a span.
+pub trait SpanData<'a> {
+ /// Returns this span's ID.
+ fn id(&self) -> Id;
+
+ /// Returns a reference to the span's `Metadata`.
+ fn metadata(&self) -> &'static Metadata<'static>;
+
+ /// Returns a reference to the ID
+ fn parent(&self) -> Option<&Id>;
+
+ /// Returns a reference to this span's `Extensions`.
+ ///
+ /// The extensions may be used by `Layer`s to store additional data
+ /// describing the span.
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ fn extensions(&self) -> Extensions<'_>;
+
+ /// Returns a mutable reference to this span's `Extensions`.
+ ///
+ /// The extensions may be used by `Layer`s to store additional data
+ /// describing the span.
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ fn extensions_mut(&self) -> ExtensionsMut<'_>;
+
+ /// Returns `true` if this span is enabled for the [per-layer filter][plf]
+ /// corresponding to the provided [`FilterId`].
+ ///
+ /// ## Default Implementation
+ ///
+ /// By default, this method assumes that the [`LookupSpan`] implementation
+ /// does not support [per-layer filtering][plf], and always returns `true`.
+ ///
+ /// [plf]: crate::layer::Layer#per-layer-filtering
+ /// [`FilterId`]: crate::filter::FilterId
+ #[cfg(feature = "registry")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "registry")))]
+ fn is_enabled_for(&self, filter: FilterId) -> bool {
+ let _ = filter;
+ true
+ }
+}
+
+/// A reference to [span data] and the associated [registry].
+///
+/// This type implements all the same methods as [`SpanData`], and provides
+/// additional methods for querying the registry based on values from the span.
+///
+/// [registry]: LookupSpan
+#[derive(Debug)]
+pub struct SpanRef<'a, R: LookupSpan<'a>> {
+ registry: &'a R,
+ data: R::Data,
+
+ #[cfg(feature = "registry")]
+ filter: FilterId,
+}
+
+/// An iterator over the parents of a span, ordered from leaf to root.
+///
+/// This is returned by the [`SpanRef::scope`] method.
+#[derive(Debug)]
+pub struct Scope<'a, R> {
+ registry: &'a R,
+ next: Option<Id>,
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ filter: FilterId,
+}
+
+feature! {
+ #![any(feature = "alloc", feature = "std")]
+
+ #[cfg(not(feature = "smallvec"))]
+ use alloc::vec::{self, Vec};
+
+ use core::{fmt,iter};
+
+ /// An iterator over the parents of a span, ordered from root to leaf.
+ ///
+ /// This is returned by the [`Scope::from_root`] method.
+ pub struct ScopeFromRoot<'a, R>
+ where
+ R: LookupSpan<'a>,
+ {
+ #[cfg(feature = "smallvec")]
+ spans: iter::Rev<smallvec::IntoIter<SpanRefVecArray<'a, R>>>,
+ #[cfg(not(feature = "smallvec"))]
+ spans: iter::Rev<vec::IntoIter<SpanRef<'a, R>>>,
+ }
+
+ #[cfg(feature = "smallvec")]
+ type SpanRefVecArray<'span, L> = [SpanRef<'span, L>; 16];
+
+ impl<'a, R> Scope<'a, R>
+ where
+ R: LookupSpan<'a>,
+ {
+ /// Flips the order of the iterator, so that it is ordered from root to leaf.
+ ///
+ /// The iterator will first return the root span, then that span's immediate child,
+ /// and so on until it finally returns the span that [`SpanRef::scope`] was called on.
+ ///
+ /// If any items were consumed from the [`Scope`] before calling this method then they
+ /// will *not* be returned from the [`ScopeFromRoot`].
+ ///
+ /// **Note**: this will allocate if there are many spans remaining, or if the
+ /// "smallvec" feature flag is not enabled.
+ #[allow(clippy::wrong_self_convention)]
+ pub fn from_root(self) -> ScopeFromRoot<'a, R> {
+ #[cfg(feature = "smallvec")]
+ type Buf<T> = smallvec::SmallVec<T>;
+ #[cfg(not(feature = "smallvec"))]
+ type Buf<T> = Vec<T>;
+ ScopeFromRoot {
+ spans: self.collect::<Buf<_>>().into_iter().rev(),
+ }
+ }
+ }
+
+ impl<'a, R> Iterator for ScopeFromRoot<'a, R>
+ where
+ R: LookupSpan<'a>,
+ {
+ type Item = SpanRef<'a, R>;
+
+ #[inline]
+ fn next(&mut self) -> Option<Self::Item> {
+ self.spans.next()
+ }
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.spans.size_hint()
+ }
+ }
+
+ impl<'a, R> fmt::Debug for ScopeFromRoot<'a, R>
+ where
+ R: LookupSpan<'a>,
+ {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.pad("ScopeFromRoot { .. }")
+ }
+ }
+}
+
+impl<'a, R> Iterator for Scope<'a, R>
+where
+ R: LookupSpan<'a>,
+{
+ type Item = SpanRef<'a, R>;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ loop {
+ let curr = self.registry.span(self.next.as_ref()?)?;
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ let curr = curr.with_filter(self.filter);
+ self.next = curr.data.parent().cloned();
+
+ // If the `Scope` is filtered, check if the current span is enabled
+ // by the selected filter ID.
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ {
+ if !curr.is_enabled_for(self.filter) {
+ // The current span in the chain is disabled for this
+ // filter. Try its parent.
+ continue;
+ }
+ }
+
+ return Some(curr);
+ }
+ }
+}
+
+impl<'a, R> SpanRef<'a, R>
+where
+ R: LookupSpan<'a>,
+{
+ /// Returns this span's ID.
+ pub fn id(&self) -> Id {
+ self.data.id()
+ }
+
+ /// Returns a static reference to the span's metadata.
+ pub fn metadata(&self) -> &'static Metadata<'static> {
+ self.data.metadata()
+ }
+
+ /// Returns the span's name,
+ pub fn name(&self) -> &'static str {
+ self.data.metadata().name()
+ }
+
+ /// Returns a list of [fields] defined by the span.
+ ///
+ /// [fields]: tracing_core::field
+ pub fn fields(&self) -> &FieldSet {
+ self.data.metadata().fields()
+ }
+
+ /// Returns a `SpanRef` describing this span's parent, or `None` if this
+ /// span is the root of its trace tree.
+ pub fn parent(&self) -> Option<Self> {
+ let id = self.data.parent()?;
+ let data = self.registry.span_data(id)?;
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ {
+ // move these into mut bindings if the registry feature is enabled,
+ // since they may be mutated in the loop.
+ let mut data = data;
+ loop {
+ // Is this parent enabled by our filter?
+ if data.is_enabled_for(self.filter) {
+ return Some(Self {
+ registry: self.registry,
+ filter: self.filter,
+ data,
+ });
+ }
+
+ // It's not enabled. If the disabled span has a parent, try that!
+ let id = data.parent()?;
+ data = self.registry.span_data(id)?;
+ }
+ }
+
+ #[cfg(not(all(feature = "registry", feature = "std")))]
+ Some(Self {
+ registry: self.registry,
+ data,
+ })
+ }
+
+ /// Returns an iterator over all parents of this span, starting with this span,
+ /// ordered from leaf to root.
+ ///
+ /// The iterator will first return the span, then the span's immediate parent,
+ /// followed by that span's parent, and so on, until it reaches a root span.
+ ///
+ /// ```rust
+ /// use tracing::{span, Subscriber};
+ /// use tracing_subscriber::{
+ /// layer::{Context, Layer},
+ /// prelude::*,
+ /// registry::LookupSpan,
+ /// };
+ ///
+ /// struct PrintingLayer;
+ /// impl<S> Layer<S> for PrintingLayer
+ /// where
+ /// S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ /// {
+ /// fn on_enter(&self, id: &span::Id, ctx: Context<S>) {
+ /// let span = ctx.span(id).unwrap();
+ /// let scope = span.scope().map(|span| span.name()).collect::<Vec<_>>();
+ /// println!("Entering span: {:?}", scope);
+ /// }
+ /// }
+ ///
+ /// tracing::subscriber::with_default(tracing_subscriber::registry().with(PrintingLayer), || {
+ /// let _root = tracing::info_span!("root").entered();
+ /// // Prints: Entering span: ["root"]
+ /// let _child = tracing::info_span!("child").entered();
+ /// // Prints: Entering span: ["child", "root"]
+ /// let _leaf = tracing::info_span!("leaf").entered();
+ /// // Prints: Entering span: ["leaf", "child", "root"]
+ /// });
+ /// ```
+ ///
+ /// If the opposite order (from the root to this span) is desired, calling [`Scope::from_root`] on
+ /// the returned iterator reverses the order.
+ ///
+ /// ```rust
+ /// # use tracing::{span, Subscriber};
+ /// # use tracing_subscriber::{
+ /// # layer::{Context, Layer},
+ /// # prelude::*,
+ /// # registry::LookupSpan,
+ /// # };
+ /// # struct PrintingLayer;
+ /// impl<S> Layer<S> for PrintingLayer
+ /// where
+ /// S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ /// {
+ /// fn on_enter(&self, id: &span::Id, ctx: Context<S>) {
+ /// let span = ctx.span(id).unwrap();
+ /// let scope = span.scope().from_root().map(|span| span.name()).collect::<Vec<_>>();
+ /// println!("Entering span: {:?}", scope);
+ /// }
+ /// }
+ ///
+ /// tracing::subscriber::with_default(tracing_subscriber::registry().with(PrintingLayer), || {
+ /// let _root = tracing::info_span!("root").entered();
+ /// // Prints: Entering span: ["root"]
+ /// let _child = tracing::info_span!("child").entered();
+ /// // Prints: Entering span: ["root", "child"]
+ /// let _leaf = tracing::info_span!("leaf").entered();
+ /// // Prints: Entering span: ["root", "child", "leaf"]
+ /// });
+ /// ```
+ pub fn scope(&self) -> Scope<'a, R> {
+ Scope {
+ registry: self.registry,
+ next: Some(self.id()),
+
+ #[cfg(feature = "registry")]
+ filter: self.filter,
+ }
+ }
+
+ /// Returns a reference to this span's `Extensions`.
+ ///
+ /// The extensions may be used by `Layer`s to store additional data
+ /// describing the span.
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ pub fn extensions(&self) -> Extensions<'_> {
+ self.data.extensions()
+ }
+
+ /// Returns a mutable reference to this span's `Extensions`.
+ ///
+ /// The extensions may be used by `Layer`s to store additional data
+ /// describing the span.
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ pub fn extensions_mut(&self) -> ExtensionsMut<'_> {
+ self.data.extensions_mut()
+ }
+
+ #[cfg(all(feature = "registry", feature = "std"))]
+ pub(crate) fn try_with_filter(self, filter: FilterId) -> Option<Self> {
+ if self.is_enabled_for(filter) {
+ return Some(self.with_filter(filter));
+ }
+
+ None
+ }
+
+ #[inline]
+ #[cfg(all(feature = "registry", feature = "std"))]
+ pub(crate) fn is_enabled_for(&self, filter: FilterId) -> bool {
+ self.data.is_enabled_for(filter)
+ }
+
+ #[inline]
+ #[cfg(all(feature = "registry", feature = "std"))]
+ fn with_filter(self, filter: FilterId) -> Self {
+ Self { filter, ..self }
+ }
+}
+
+#[cfg(all(test, feature = "registry", feature = "std"))]
+mod tests {
+ use crate::{
+ layer::{Context, Layer},
+ prelude::*,
+ registry::LookupSpan,
+ };
+ use std::sync::{Arc, Mutex};
+ use tracing::{span, Subscriber};
+
+ #[test]
+ fn spanref_scope_iteration_order() {
+ let last_entered_scope = Arc::new(Mutex::new(Vec::new()));
+
+ #[derive(Default)]
+ struct PrintingLayer {
+ last_entered_scope: Arc<Mutex<Vec<&'static str>>>,
+ }
+
+ impl<S> Layer<S> for PrintingLayer
+ where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ {
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ let span = ctx.span(id).unwrap();
+ let scope = span.scope().map(|span| span.name()).collect::<Vec<_>>();
+ *self.last_entered_scope.lock().unwrap() = scope;
+ }
+ }
+
+ let _guard = tracing::subscriber::set_default(crate::registry().with(PrintingLayer {
+ last_entered_scope: last_entered_scope.clone(),
+ }));
+
+ let _root = tracing::info_span!("root").entered();
+ assert_eq!(&*last_entered_scope.lock().unwrap(), &["root"]);
+ let _child = tracing::info_span!("child").entered();
+ assert_eq!(&*last_entered_scope.lock().unwrap(), &["child", "root"]);
+ let _leaf = tracing::info_span!("leaf").entered();
+ assert_eq!(
+ &*last_entered_scope.lock().unwrap(),
+ &["leaf", "child", "root"]
+ );
+ }
+
+ #[test]
+ fn spanref_scope_fromroot_iteration_order() {
+ let last_entered_scope = Arc::new(Mutex::new(Vec::new()));
+
+ #[derive(Default)]
+ struct PrintingLayer {
+ last_entered_scope: Arc<Mutex<Vec<&'static str>>>,
+ }
+
+ impl<S> Layer<S> for PrintingLayer
+ where
+ S: Subscriber + for<'lookup> LookupSpan<'lookup>,
+ {
+ fn on_enter(&self, id: &span::Id, ctx: Context<'_, S>) {
+ let span = ctx.span(id).unwrap();
+ let scope = span
+ .scope()
+ .from_root()
+ .map(|span| span.name())
+ .collect::<Vec<_>>();
+ *self.last_entered_scope.lock().unwrap() = scope;
+ }
+ }
+
+ let _guard = tracing::subscriber::set_default(crate::registry().with(PrintingLayer {
+ last_entered_scope: last_entered_scope.clone(),
+ }));
+
+ let _root = tracing::info_span!("root").entered();
+ assert_eq!(&*last_entered_scope.lock().unwrap(), &["root"]);
+ let _child = tracing::info_span!("child").entered();
+ assert_eq!(&*last_entered_scope.lock().unwrap(), &["root", "child",]);
+ let _leaf = tracing::info_span!("leaf").entered();
+ assert_eq!(
+ &*last_entered_scope.lock().unwrap(),
+ &["root", "child", "leaf"]
+ );
+ }
+}
diff --git a/crates/tracing-subscriber/src/registry/sharded.rs b/crates/tracing-subscriber/src/registry/sharded.rs
new file mode 100644
index 0000000..88520a2
--- /dev/null
+++ b/crates/tracing-subscriber/src/registry/sharded.rs
@@ -0,0 +1,908 @@
+use sharded_slab::{pool::Ref, Clear, Pool};
+use thread_local::ThreadLocal;
+
+use super::stack::SpanStack;
+use crate::{
+ filter::{FilterId, FilterMap, FilterState},
+ registry::{
+ extensions::{Extensions, ExtensionsInner, ExtensionsMut},
+ LookupSpan, SpanData,
+ },
+ sync::RwLock,
+};
+use std::{
+ cell::{self, Cell, RefCell},
+ sync::atomic::{fence, AtomicUsize, Ordering},
+};
+use tracing_core::{
+ dispatcher::{self, Dispatch},
+ span::{self, Current, Id},
+ Event, Interest, Metadata, Subscriber,
+};
+
+/// A shared, reusable store for spans.
+///
+/// A `Registry` is a [`Subscriber`] around which multiple [`Layer`]s
+/// implementing various behaviors may be [added]. Unlike other types
+/// implementing `Subscriber`, `Registry` does not actually record traces itself:
+/// instead, it collects and stores span data that is exposed to any [`Layer`]s
+/// wrapping it through implementations of the [`LookupSpan`] trait.
+/// The `Registry` is responsible for storing span metadata, recording
+/// relationships between spans, and tracking which spans are active and which
+/// are closed. In addition, it provides a mechanism for [`Layer`]s to store
+/// user-defined per-span data, called [extensions], in the registry. This
+/// allows [`Layer`]-specific data to benefit from the `Registry`'s
+/// high-performance concurrent storage.
+///
+/// This registry is implemented using a [lock-free sharded slab][slab], and is
+/// highly optimized for concurrent access.
+///
+/// # Span ID Generation
+///
+/// Span IDs are not globally unique, but the registry ensures that
+/// no two currently active spans have the same ID within a process.
+///
+/// One of the primary responsibilities of the registry is to generate [span
+/// IDs]. Therefore, it's important for other code that interacts with the
+/// registry, such as [`Layer`]s, to understand the guarantees of the
+/// span IDs that are generated.
+///
+/// The registry's span IDs are guaranteed to be unique **at a given point
+/// in time**. This means that an active span will never be assigned the
+/// same ID as another **currently active** span. However, the registry
+/// **will** eventually reuse the IDs of [closed] spans, although an ID
+/// will never be reassigned immediately after a span has closed.
+///
+/// Spans are not [considered closed] by the `Registry` until *every*
+/// [`Span`] reference with that ID has been dropped.
+///
+/// Thus: span IDs generated by the registry should be considered unique
+/// only at a given point in time, and only relative to other spans
+/// generated by the same process. Two spans with the same ID will not exist
+/// in the same process concurrently. However, if historical span data is
+/// being stored, the same ID may occur for multiple spans times in that
+/// data. If spans must be uniquely identified in historical data, the user
+/// code storing this data must assign its own unique identifiers to those
+/// spans. A counter is generally sufficient for this.
+///
+/// Similarly, span IDs generated by the registry are not unique outside of
+/// a given process. Distributed tracing systems may require identifiers
+/// that are unique across multiple processes on multiple machines (for
+/// example, [OpenTelemetry's `SpanId`s and `TraceId`s][ot]). `tracing` span
+/// IDs generated by the registry should **not** be used for this purpose.
+/// Instead, code which integrates with a distributed tracing system should
+/// generate and propagate its own IDs according to the rules specified by
+/// the distributed tracing system. These IDs can be associated with
+/// `tracing` spans using [fields] and/or [stored span data].
+///
+/// [span IDs]: tracing_core::span::Id
+/// [slab]: sharded_slab
+/// [`Layer`]: crate::Layer
+/// [added]: crate::layer::Layer#composing-layers
+/// [extensions]: super::Extensions
+/// [closed]: https://docs.rs/tracing/latest/tracing/span/index.html#closing-spans
+/// [considered closed]: tracing_core::subscriber::Subscriber::try_close()
+/// [`Span`]: https://docs.rs/tracing/latest/tracing/span/struct.Span.html
+/// [ot]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#spancontext
+/// [fields]: tracing_core::field
+/// [stored span data]: crate::registry::SpanData::extensions_mut
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(all(feature = "registry", feature = "std"))))]
+#[derive(Debug)]
+pub struct Registry {
+ spans: Pool<DataInner>,
+ current_spans: ThreadLocal<RefCell<SpanStack>>,
+ next_filter_id: u8,
+}
+
+/// Span data stored in a [`Registry`].
+///
+/// The registry stores well-known data defined by tracing: span relationships,
+/// metadata and reference counts. Additional user-defined data provided by
+/// [`Layer`s], such as formatted fields, metrics, or distributed traces should
+/// be stored in the [extensions] typemap.
+///
+/// [`Layer`s]: crate::layer::Layer
+/// [extensions]: Extensions
+#[cfg(feature = "registry")]
+#[cfg_attr(docsrs, doc(cfg(all(feature = "registry", feature = "std"))))]
+#[derive(Debug)]
+pub struct Data<'a> {
+ /// Immutable reference to the pooled `DataInner` entry.
+ inner: Ref<'a, DataInner>,
+}
+
+/// Stored data associated with a span.
+///
+/// This type is pooled using [`sharded_slab::Pool`]; when a span is
+/// dropped, the `DataInner` entry at that span's slab index is cleared
+/// in place and reused by a future span. Thus, the `Default` and
+/// [`sharded_slab::Clear`] implementations for this type are
+/// load-bearing.
+#[derive(Debug)]
+struct DataInner {
+ filter_map: FilterMap,
+ metadata: &'static Metadata<'static>,
+ parent: Option<Id>,
+ ref_count: AtomicUsize,
+ // The span's `Extensions` typemap. Allocations for the `HashMap` backing
+ // this are pooled and reused in place.
+ pub(crate) extensions: RwLock<ExtensionsInner>,
+}
+
+// === impl Registry ===
+
+impl Default for Registry {
+ fn default() -> Self {
+ Self {
+ spans: Pool::new(),
+ current_spans: ThreadLocal::new(),
+ next_filter_id: 0,
+ }
+ }
+}
+
+#[inline]
+fn idx_to_id(idx: usize) -> Id {
+ Id::from_u64(idx as u64 + 1)
+}
+
+#[inline]
+fn id_to_idx(id: &Id) -> usize {
+ id.into_u64() as usize - 1
+}
+
+/// A guard that tracks how many [`Registry`]-backed `Layer`s have
+/// processed an `on_close` event.
+///
+/// This is needed to enable a [`Registry`]-backed Layer to access span
+/// data after the `Layer` has recieved the `on_close` callback.
+///
+/// Once all `Layer`s have processed this event, the [`Registry`] knows
+/// that is able to safely remove the span tracked by `id`. `CloseGuard`
+/// accomplishes this through a two-step process:
+/// 1. Whenever a [`Registry`]-backed `Layer::on_close` method is
+/// called, `Registry::start_close` is closed.
+/// `Registry::start_close` increments a thread-local `CLOSE_COUNT`
+/// by 1 and returns a `CloseGuard`.
+/// 2. The `CloseGuard` is dropped at the end of `Layer::on_close`. On
+/// drop, `CloseGuard` checks thread-local `CLOSE_COUNT`. If
+/// `CLOSE_COUNT` is 0, the `CloseGuard` removes the span with the
+/// `id` from the registry, as all `Layers` that might have seen the
+/// `on_close` notification have processed it. If `CLOSE_COUNT` is
+/// greater than 0, `CloseGuard` decrements the counter by one and
+/// _does not_ remove the span from the [`Registry`].
+///
+pub(crate) struct CloseGuard<'a> {
+ id: Id,
+ registry: &'a Registry,
+ is_closing: bool,
+}
+
+impl Registry {
+ fn get(&self, id: &Id) -> Option<Ref<'_, DataInner>> {
+ self.spans.get(id_to_idx(id))
+ }
+
+ /// Returns a guard which tracks how many `Layer`s have
+ /// processed an `on_close` notification via the `CLOSE_COUNT` thread-local.
+ /// For additional details, see [`CloseGuard`].
+ ///
+ pub(crate) fn start_close(&self, id: Id) -> CloseGuard<'_> {
+ CLOSE_COUNT.with(|count| {
+ let c = count.get();
+ count.set(c + 1);
+ });
+ CloseGuard {
+ id,
+ registry: self,
+ is_closing: false,
+ }
+ }
+
+ pub(crate) fn has_per_layer_filters(&self) -> bool {
+ self.next_filter_id > 0
+ }
+
+ pub(crate) fn span_stack(&self) -> cell::Ref<'_, SpanStack> {
+ self.current_spans.get_or_default().borrow()
+ }
+}
+
+thread_local! {
+ /// `CLOSE_COUNT` is the thread-local counter used by `CloseGuard` to
+ /// track how many layers have processed the close.
+ /// For additional details, see [`CloseGuard`].
+ ///
+ static CLOSE_COUNT: Cell<usize> = Cell::new(0);
+}
+
+impl Subscriber for Registry {
+ fn register_callsite(&self, _: &'static Metadata<'static>) -> Interest {
+ if self.has_per_layer_filters() {
+ return FilterState::take_interest().unwrap_or_else(Interest::always);
+ }
+
+ Interest::always()
+ }
+
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ if self.has_per_layer_filters() {
+ return FilterState::event_enabled();
+ }
+ true
+ }
+
+ #[inline]
+ fn new_span(&self, attrs: &span::Attributes<'_>) -> span::Id {
+ let parent = if attrs.is_root() {
+ None
+ } else if attrs.is_contextual() {
+ self.current_span().id().map(|id| self.clone_span(id))
+ } else {
+ attrs.parent().map(|id| self.clone_span(id))
+ };
+
+ let id = self
+ .spans
+ // Check out a `DataInner` entry from the pool for the new span. If
+ // there are free entries already allocated in the pool, this will
+ // preferentially reuse one; otherwise, a new `DataInner` is
+ // allocated and added to the pool.
+ .create_with(|data| {
+ data.metadata = attrs.metadata();
+ data.parent = parent;
+ data.filter_map = crate::filter::FILTERING.with(|filtering| filtering.filter_map());
+ #[cfg(debug_assertions)]
+ {
+ if data.filter_map != FilterMap::default() {
+ debug_assert!(self.has_per_layer_filters());
+ }
+ }
+
+ let refs = data.ref_count.get_mut();
+ debug_assert_eq!(*refs, 0);
+ *refs = 1;
+ })
+ .expect("Unable to allocate another span");
+ idx_to_id(id)
+ }
+
+ /// This is intentionally not implemented, as recording fields
+ /// on a span is the responsibility of layers atop of this registry.
+ #[inline]
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+
+ fn record_follows_from(&self, _span: &span::Id, _follows: &span::Id) {}
+
+ fn event_enabled(&self, _event: &Event<'_>) -> bool {
+ if self.has_per_layer_filters() {
+ return FilterState::event_enabled();
+ }
+ true
+ }
+
+ /// This is intentionally not implemented, as recording events
+ /// is the responsibility of layers atop of this registry.
+ fn event(&self, _: &Event<'_>) {}
+
+ fn enter(&self, id: &span::Id) {
+ if self
+ .current_spans
+ .get_or_default()
+ .borrow_mut()
+ .push(id.clone())
+ {
+ self.clone_span(id);
+ }
+ }
+
+ fn exit(&self, id: &span::Id) {
+ if let Some(spans) = self.current_spans.get() {
+ if spans.borrow_mut().pop(id) {
+ dispatcher::get_default(|dispatch| dispatch.try_close(id.clone()));
+ }
+ }
+ }
+
+ fn clone_span(&self, id: &span::Id) -> span::Id {
+ let span = self
+ .get(id)
+ .unwrap_or_else(|| panic!(
+ "tried to clone {:?}, but no span exists with that ID\n\
+ This may be caused by consuming a parent span (`parent: span`) rather than borrowing it (`parent: &span`).",
+ id,
+ ));
+ // Like `std::sync::Arc`, adds to the ref count (on clone) don't require
+ // a strong ordering; if we call` clone_span`, the reference count must
+ // always at least 1. The only synchronization necessary is between
+ // calls to `try_close`: we have to ensure that all threads have
+ // dropped their refs to the span before the span is closed.
+ let refs = span.ref_count.fetch_add(1, Ordering::Relaxed);
+ assert_ne!(
+ refs, 0,
+ "tried to clone a span ({:?}) that already closed",
+ id
+ );
+ id.clone()
+ }
+
+ fn current_span(&self) -> Current {
+ self.current_spans
+ .get()
+ .and_then(|spans| {
+ let spans = spans.borrow();
+ let id = spans.current()?;
+ let span = self.get(id)?;
+ Some(Current::new(id.clone(), span.metadata))
+ })
+ .unwrap_or_else(Current::none)
+ }
+
+ /// Decrements the reference count of the span with the given `id`, and
+ /// removes the span if it is zero.
+ ///
+ /// The allocated span slot will be reused when a new span is created.
+ fn try_close(&self, id: span::Id) -> bool {
+ let span = match self.get(&id) {
+ Some(span) => span,
+ None if std::thread::panicking() => return false,
+ None => panic!("tried to drop a ref to {:?}, but no such span exists!", id),
+ };
+
+ let refs = span.ref_count.fetch_sub(1, Ordering::Release);
+ if !std::thread::panicking() {
+ assert!(refs < std::usize::MAX, "reference count overflow!");
+ }
+ if refs > 1 {
+ return false;
+ }
+
+ // Synchronize if we are actually removing the span (stolen
+ // from std::Arc); this ensures that all other `try_close` calls on
+ // other threads happen-before we actually remove the span.
+ fence(Ordering::Acquire);
+ true
+ }
+}
+
+impl<'a> LookupSpan<'a> for Registry {
+ type Data = Data<'a>;
+
+ fn span_data(&'a self, id: &Id) -> Option<Self::Data> {
+ let inner = self.get(id)?;
+ Some(Data { inner })
+ }
+
+ fn register_filter(&mut self) -> FilterId {
+ let id = FilterId::new(self.next_filter_id);
+ self.next_filter_id += 1;
+ id
+ }
+}
+
+// === impl CloseGuard ===
+
+impl<'a> CloseGuard<'a> {
+ pub(crate) fn set_closing(&mut self) {
+ self.is_closing = true;
+ }
+}
+
+impl<'a> Drop for CloseGuard<'a> {
+ fn drop(&mut self) {
+ // If this returns with an error, we are already panicking. At
+ // this point, there's nothing we can really do to recover
+ // except by avoiding a double-panic.
+ let _ = CLOSE_COUNT.try_with(|count| {
+ let c = count.get();
+ // Decrement the count to indicate that _this_ guard's
+ // `on_close` callback has completed.
+ //
+ // Note that we *must* do this before we actually remove the span
+ // from the registry, since dropping the `DataInner` may trigger a
+ // new close, if this span is the last reference to a parent span.
+ count.set(c - 1);
+
+ // If the current close count is 1, this stack frame is the last
+ // `on_close` call. If the span is closing, it's okay to remove the
+ // span.
+ if c == 1 && self.is_closing {
+ self.registry.spans.clear(id_to_idx(&self.id));
+ }
+ });
+ }
+}
+
+// === impl Data ===
+
+impl<'a> SpanData<'a> for Data<'a> {
+ fn id(&self) -> Id {
+ idx_to_id(self.inner.key())
+ }
+
+ fn metadata(&self) -> &'static Metadata<'static> {
+ self.inner.metadata
+ }
+
+ fn parent(&self) -> Option<&Id> {
+ self.inner.parent.as_ref()
+ }
+
+ fn extensions(&self) -> Extensions<'_> {
+ Extensions::new(self.inner.extensions.read().expect("Mutex poisoned"))
+ }
+
+ fn extensions_mut(&self) -> ExtensionsMut<'_> {
+ ExtensionsMut::new(self.inner.extensions.write().expect("Mutex poisoned"))
+ }
+
+ #[inline]
+ fn is_enabled_for(&self, filter: FilterId) -> bool {
+ self.inner.filter_map.is_enabled(filter)
+ }
+}
+
+// === impl DataInner ===
+
+impl Default for DataInner {
+ fn default() -> Self {
+ // Since `DataInner` owns a `&'static Callsite` pointer, we need
+ // something to use as the initial default value for that callsite.
+ // Since we can't access a `DataInner` until it has had actual span data
+ // inserted into it, the null metadata will never actually be accessed.
+ struct NullCallsite;
+ impl tracing_core::callsite::Callsite for NullCallsite {
+ fn set_interest(&self, _: Interest) {
+ unreachable!(
+ "/!\\ Tried to register the null callsite /!\\\n \
+ This should never have happened and is definitely a bug. \
+ A `tracing` bug report would be appreciated."
+ )
+ }
+
+ fn metadata(&self) -> &Metadata<'_> {
+ unreachable!(
+ "/!\\ Tried to access the null callsite's metadata /!\\\n \
+ This should never have happened and is definitely a bug. \
+ A `tracing` bug report would be appreciated."
+ )
+ }
+ }
+
+ static NULL_CALLSITE: NullCallsite = NullCallsite;
+ static NULL_METADATA: Metadata<'static> = tracing_core::metadata! {
+ name: "",
+ target: "",
+ level: tracing_core::Level::TRACE,
+ fields: &[],
+ callsite: &NULL_CALLSITE,
+ kind: tracing_core::metadata::Kind::SPAN,
+ };
+
+ Self {
+ filter_map: FilterMap::default(),
+ metadata: &NULL_METADATA,
+ parent: None,
+ ref_count: AtomicUsize::new(0),
+ extensions: RwLock::new(ExtensionsInner::new()),
+ }
+ }
+}
+
+impl Clear for DataInner {
+ /// Clears the span's data in place, dropping the parent's reference count.
+ fn clear(&mut self) {
+ // A span is not considered closed until all of its children have closed.
+ // Therefore, each span's `DataInner` holds a "reference" to the parent
+ // span, keeping the parent span open until all its children have closed.
+ // When we close a span, we must then decrement the parent's ref count
+ // (potentially, allowing it to close, if this child is the last reference
+ // to that span).
+ // We have to actually unpack the option inside the `get_default`
+ // closure, since it is a `FnMut`, but testing that there _is_ a value
+ // here lets us avoid the thread-local access if we don't need the
+ // dispatcher at all.
+ if self.parent.is_some() {
+ // Note that --- because `Layered::try_close` works by calling
+ // `try_close` on the inner subscriber and using the return value to
+ // determine whether to call the `Layer`'s `on_close` callback ---
+ // we must call `try_close` on the entire subscriber stack, rather
+ // than just on the registry. If the registry called `try_close` on
+ // itself directly, the layers wouldn't see the close notification.
+ let subscriber = dispatcher::get_default(Dispatch::clone);
+ if let Some(parent) = self.parent.take() {
+ let _ = subscriber.try_close(parent);
+ }
+ }
+
+ // Clear (but do not deallocate!) the pooled `HashMap` for the span's extensions.
+ self.extensions
+ .get_mut()
+ .unwrap_or_else(|l| {
+ // This function can be called in a `Drop` impl, such as while
+ // panicking, so ignore lock poisoning.
+ l.into_inner()
+ })
+ .clear();
+
+ self.filter_map = FilterMap::default();
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{layer::Context, registry::LookupSpan, Layer};
+ use std::{
+ collections::HashMap,
+ sync::{Arc, Mutex, Weak},
+ };
+ use tracing::{self, subscriber::with_default};
+ use tracing_core::{
+ dispatcher,
+ span::{Attributes, Id},
+ Subscriber,
+ };
+
+ #[derive(Debug)]
+ struct DoesNothing;
+ impl<S: Subscriber> Layer<S> for DoesNothing {}
+
+ struct AssertionLayer;
+ impl<S> Layer<S> for AssertionLayer
+ where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ {
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ dbg!(format_args!("closing {:?}", id));
+ assert!(&ctx.span(&id).is_some());
+ }
+ }
+
+ #[test]
+ fn single_layer_can_access_closed_span() {
+ let subscriber = AssertionLayer.with_subscriber(Registry::default());
+
+ with_default(subscriber, || {
+ let span = tracing::debug_span!("span");
+ drop(span);
+ });
+ }
+
+ #[test]
+ fn multiple_layers_can_access_closed_span() {
+ let subscriber = AssertionLayer
+ .and_then(AssertionLayer)
+ .with_subscriber(Registry::default());
+
+ with_default(subscriber, || {
+ let span = tracing::debug_span!("span");
+ drop(span);
+ });
+ }
+
+ struct CloseLayer {
+ inner: Arc<Mutex<CloseState>>,
+ }
+
+ struct CloseHandle {
+ state: Arc<Mutex<CloseState>>,
+ }
+
+ #[derive(Default)]
+ struct CloseState {
+ open: HashMap<&'static str, Weak<()>>,
+ closed: Vec<(&'static str, Weak<()>)>,
+ }
+
+ struct SetRemoved(Arc<()>);
+
+ impl<S> Layer<S> for CloseLayer
+ where
+ S: Subscriber + for<'a> LookupSpan<'a>,
+ {
+ fn on_new_span(&self, _: &Attributes<'_>, id: &Id, ctx: Context<'_, S>) {
+ let span = ctx.span(id).expect("Missing span; this is a bug");
+ let mut lock = self.inner.lock().unwrap();
+ let is_removed = Arc::new(());
+ assert!(
+ lock.open
+ .insert(span.name(), Arc::downgrade(&is_removed))
+ .is_none(),
+ "test layer saw multiple spans with the same name, the test is probably messed up"
+ );
+ let mut extensions = span.extensions_mut();
+ extensions.insert(SetRemoved(is_removed));
+ }
+
+ fn on_close(&self, id: Id, ctx: Context<'_, S>) {
+ let span = if let Some(span) = ctx.span(&id) {
+ span
+ } else {
+ println!(
+ "span {:?} did not exist in `on_close`, are we panicking?",
+ id
+ );
+ return;
+ };
+ let name = span.name();
+ println!("close {} ({:?})", name, id);
+ if let Ok(mut lock) = self.inner.lock() {
+ if let Some(is_removed) = lock.open.remove(name) {
+ assert!(is_removed.upgrade().is_some());
+ lock.closed.push((name, is_removed));
+ }
+ }
+ }
+ }
+
+ impl CloseLayer {
+ fn new() -> (Self, CloseHandle) {
+ let state = Arc::new(Mutex::new(CloseState::default()));
+ (
+ Self {
+ inner: state.clone(),
+ },
+ CloseHandle { state },
+ )
+ }
+ }
+
+ impl CloseState {
+ fn is_open(&self, span: &str) -> bool {
+ self.open.contains_key(span)
+ }
+
+ fn is_closed(&self, span: &str) -> bool {
+ self.closed.iter().any(|(name, _)| name == &span)
+ }
+ }
+
+ impl CloseHandle {
+ fn assert_closed(&self, span: &str) {
+ let lock = self.state.lock().unwrap();
+ assert!(
+ lock.is_closed(span),
+ "expected {} to be closed{}",
+ span,
+ if lock.is_open(span) {
+ " (it was still open)"
+ } else {
+ ", but it never existed (is there a problem with the test?)"
+ }
+ )
+ }
+
+ fn assert_open(&self, span: &str) {
+ let lock = self.state.lock().unwrap();
+ assert!(
+ lock.is_open(span),
+ "expected {} to be open{}",
+ span,
+ if lock.is_closed(span) {
+ " (it was still open)"
+ } else {
+ ", but it never existed (is there a problem with the test?)"
+ }
+ )
+ }
+
+ fn assert_removed(&self, span: &str) {
+ let lock = self.state.lock().unwrap();
+ let is_removed = match lock.closed.iter().find(|(name, _)| name == &span) {
+ Some((_, is_removed)) => is_removed,
+ None => panic!(
+ "expected {} to be removed from the registry, but it was not closed {}",
+ span,
+ if lock.is_closed(span) {
+ " (it was still open)"
+ } else {
+ ", but it never existed (is there a problem with the test?)"
+ }
+ ),
+ };
+ assert!(
+ is_removed.upgrade().is_none(),
+ "expected {} to have been removed from the registry",
+ span
+ )
+ }
+
+ fn assert_not_removed(&self, span: &str) {
+ let lock = self.state.lock().unwrap();
+ let is_removed = match lock.closed.iter().find(|(name, _)| name == &span) {
+ Some((_, is_removed)) => is_removed,
+ None if lock.is_open(span) => return,
+ None => unreachable!(),
+ };
+ assert!(
+ is_removed.upgrade().is_some(),
+ "expected {} to have been removed from the registry",
+ span
+ )
+ }
+
+ #[allow(unused)] // may want this for future tests
+ fn assert_last_closed(&self, span: Option<&str>) {
+ let lock = self.state.lock().unwrap();
+ let last = lock.closed.last().map(|(span, _)| span);
+ assert_eq!(
+ last,
+ span.as_ref(),
+ "expected {:?} to have closed last",
+ span
+ );
+ }
+
+ fn assert_closed_in_order(&self, order: impl AsRef<[&'static str]>) {
+ let lock = self.state.lock().unwrap();
+ let order = order.as_ref();
+ for (i, name) in order.iter().enumerate() {
+ assert_eq!(
+ lock.closed.get(i).map(|(span, _)| span),
+ Some(name),
+ "expected close order: {:?}, actual: {:?}",
+ order,
+ lock.closed.iter().map(|(name, _)| name).collect::<Vec<_>>()
+ );
+ }
+ }
+ }
+
+ #[test]
+ fn spans_are_removed_from_registry() {
+ let (close_layer, state) = CloseLayer::new();
+ let subscriber = AssertionLayer
+ .and_then(close_layer)
+ .with_subscriber(Registry::default());
+
+ // Create a `Dispatch` (which is internally reference counted) so that
+ // the subscriber lives to the end of the test. Otherwise, if we just
+ // passed the subscriber itself to `with_default`, we could see the span
+ // be dropped when the subscriber itself is dropped, destroying the
+ // registry.
+ let dispatch = dispatcher::Dispatch::new(subscriber);
+
+ dispatcher::with_default(&dispatch, || {
+ let span = tracing::debug_span!("span1");
+ drop(span);
+ let span = tracing::info_span!("span2");
+ drop(span);
+ });
+
+ state.assert_removed("span1");
+ state.assert_removed("span2");
+
+ // Ensure the registry itself outlives the span.
+ drop(dispatch);
+ }
+
+ #[test]
+ fn spans_are_only_closed_when_the_last_ref_drops() {
+ let (close_layer, state) = CloseLayer::new();
+ let subscriber = AssertionLayer
+ .and_then(close_layer)
+ .with_subscriber(Registry::default());
+
+ // Create a `Dispatch` (which is internally reference counted) so that
+ // the subscriber lives to the end of the test. Otherwise, if we just
+ // passed the subscriber itself to `with_default`, we could see the span
+ // be dropped when the subscriber itself is dropped, destroying the
+ // registry.
+ let dispatch = dispatcher::Dispatch::new(subscriber);
+
+ let span2 = dispatcher::with_default(&dispatch, || {
+ let span = tracing::debug_span!("span1");
+ drop(span);
+ let span2 = tracing::info_span!("span2");
+ let span2_clone = span2.clone();
+ drop(span2);
+ span2_clone
+ });
+
+ state.assert_removed("span1");
+ state.assert_not_removed("span2");
+
+ drop(span2);
+ state.assert_removed("span1");
+
+ // Ensure the registry itself outlives the span.
+ drop(dispatch);
+ }
+
+ #[test]
+ fn span_enter_guards_are_dropped_out_of_order() {
+ let (close_layer, state) = CloseLayer::new();
+ let subscriber = AssertionLayer
+ .and_then(close_layer)
+ .with_subscriber(Registry::default());
+
+ // Create a `Dispatch` (which is internally reference counted) so that
+ // the subscriber lives to the end of the test. Otherwise, if we just
+ // passed the subscriber itself to `with_default`, we could see the span
+ // be dropped when the subscriber itself is dropped, destroying the
+ // registry.
+ let dispatch = dispatcher::Dispatch::new(subscriber);
+
+ dispatcher::with_default(&dispatch, || {
+ let span1 = tracing::debug_span!("span1");
+ let span2 = tracing::info_span!("span2");
+
+ let enter1 = span1.enter();
+ let enter2 = span2.enter();
+
+ drop(enter1);
+ drop(span1);
+
+ state.assert_removed("span1");
+ state.assert_not_removed("span2");
+
+ drop(enter2);
+ state.assert_not_removed("span2");
+
+ drop(span2);
+ state.assert_removed("span1");
+ state.assert_removed("span2");
+ });
+ }
+
+ #[test]
+ fn child_closes_parent() {
+ // This test asserts that if a parent span's handle is dropped before
+ // a child span's handle, the parent will remain open until child
+ // closes, and will then be closed.
+
+ let (close_layer, state) = CloseLayer::new();
+ let subscriber = close_layer.with_subscriber(Registry::default());
+
+ let dispatch = dispatcher::Dispatch::new(subscriber);
+
+ dispatcher::with_default(&dispatch, || {
+ let span1 = tracing::info_span!("parent");
+ let span2 = tracing::info_span!(parent: &span1, "child");
+
+ state.assert_open("parent");
+ state.assert_open("child");
+
+ drop(span1);
+ state.assert_open("parent");
+ state.assert_open("child");
+
+ drop(span2);
+ state.assert_closed("parent");
+ state.assert_closed("child");
+ });
+ }
+
+ #[test]
+ fn child_closes_grandparent() {
+ // This test asserts that, when a span is kept open by a child which
+ // is *itself* kept open by a child, closing the grandchild will close
+ // both the parent *and* the grandparent.
+ let (close_layer, state) = CloseLayer::new();
+ let subscriber = close_layer.with_subscriber(Registry::default());
+
+ let dispatch = dispatcher::Dispatch::new(subscriber);
+
+ dispatcher::with_default(&dispatch, || {
+ let span1 = tracing::info_span!("grandparent");
+ let span2 = tracing::info_span!(parent: &span1, "parent");
+ let span3 = tracing::info_span!(parent: &span2, "child");
+
+ state.assert_open("grandparent");
+ state.assert_open("parent");
+ state.assert_open("child");
+
+ drop(span1);
+ drop(span2);
+ state.assert_open("grandparent");
+ state.assert_open("parent");
+ state.assert_open("child");
+
+ drop(span3);
+
+ state.assert_closed_in_order(["child", "parent", "grandparent"]);
+ });
+ }
+}
diff --git a/crates/tracing-subscriber/src/registry/stack.rs b/crates/tracing-subscriber/src/registry/stack.rs
new file mode 100644
index 0000000..4a3f7e5
--- /dev/null
+++ b/crates/tracing-subscriber/src/registry/stack.rs
@@ -0,0 +1,77 @@
+pub(crate) use tracing_core::span::Id;
+
+#[derive(Debug)]
+struct ContextId {
+ id: Id,
+ duplicate: bool,
+}
+
+/// `SpanStack` tracks what spans are currently executing on a thread-local basis.
+///
+/// A "separate current span" for each thread is a semantic choice, as each span
+/// can be executing in a different thread.
+#[derive(Debug, Default)]
+pub(crate) struct SpanStack {
+ stack: Vec<ContextId>,
+}
+
+impl SpanStack {
+ #[inline]
+ pub(super) fn push(&mut self, id: Id) -> bool {
+ let duplicate = self.stack.iter().any(|i| i.id == id);
+ self.stack.push(ContextId { id, duplicate });
+ !duplicate
+ }
+
+ #[inline]
+ pub(super) fn pop(&mut self, expected_id: &Id) -> bool {
+ if let Some((idx, _)) = self
+ .stack
+ .iter()
+ .enumerate()
+ .rev()
+ .find(|(_, ctx_id)| ctx_id.id == *expected_id)
+ {
+ let ContextId { id: _, duplicate } = self.stack.remove(idx);
+ return !duplicate;
+ }
+ false
+ }
+
+ #[inline]
+ pub(crate) fn iter(&self) -> impl Iterator<Item = &Id> {
+ self.stack
+ .iter()
+ .rev()
+ .filter_map(|ContextId { id, duplicate }| if !*duplicate { Some(id) } else { None })
+ }
+
+ #[inline]
+ pub(crate) fn current(&self) -> Option<&Id> {
+ self.iter().next()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{Id, SpanStack};
+
+ #[test]
+ fn pop_last_span() {
+ let mut stack = SpanStack::default();
+ let id = Id::from_u64(1);
+ stack.push(id.clone());
+
+ assert!(stack.pop(&id));
+ }
+
+ #[test]
+ fn pop_first_span() {
+ let mut stack = SpanStack::default();
+ stack.push(Id::from_u64(1));
+ stack.push(Id::from_u64(2));
+
+ let id = Id::from_u64(1);
+ assert!(stack.pop(&id));
+ }
+}
diff --git a/crates/tracing-subscriber/src/reload.rs b/crates/tracing-subscriber/src/reload.rs
new file mode 100644
index 0000000..096f83d
--- /dev/null
+++ b/crates/tracing-subscriber/src/reload.rs
@@ -0,0 +1,384 @@
+//! Wrapper for a `Layer` to allow it to be dynamically reloaded.
+//!
+//! This module provides a [`Layer` type] implementing the [`Layer` trait] or [`Filter` trait]
+//! which wraps another type implementing the corresponding trait. This
+//! allows the wrapped type to be replaced with another
+//! instance of that type at runtime.
+//!
+//! This can be used in cases where a subset of `Layer` or `Filter` functionality
+//! should be dynamically reconfigured, such as when filtering directives may
+//! change at runtime. Note that this layer introduces a (relatively small)
+//! amount of overhead, and should thus only be used as needed.
+//!
+//! # Examples
+//!
+//! Reloading a [global filtering](crate::layer#global-filtering) layer:
+//!
+//! ```rust
+//! # use tracing::info;
+//! use tracing_subscriber::{filter, fmt, reload, prelude::*};
+//! let filter = filter::LevelFilter::WARN;
+//! let (filter, reload_handle) = reload::Layer::new(filter);
+//! tracing_subscriber::registry()
+//! .with(filter)
+//! .with(fmt::Layer::default())
+//! .init();
+//! #
+//! # // specifying the Registry type is required
+//! # let _: &reload::Handle<filter::LevelFilter, tracing_subscriber::Registry> = &reload_handle;
+//! #
+//! info!("This will be ignored");
+//! reload_handle.modify(|filter| *filter = filter::LevelFilter::INFO);
+//! info!("This will be logged");
+//! ```
+//!
+//! Reloading a [`Filtered`](crate::filter::Filtered) layer:
+//!
+//! ```rust
+//! # use tracing::info;
+//! use tracing_subscriber::{filter, fmt, reload, prelude::*};
+//! let filtered_layer = fmt::Layer::default().with_filter(filter::LevelFilter::WARN);
+//! let (filtered_layer, reload_handle) = reload::Layer::new(filtered_layer);
+//! #
+//! # // specifying the Registry type is required
+//! # let _: &reload::Handle<filter::Filtered<fmt::Layer<tracing_subscriber::Registry>,
+//! # filter::LevelFilter, tracing_subscriber::Registry>,tracing_subscriber::Registry>
+//! # = &reload_handle;
+//! #
+//! tracing_subscriber::registry()
+//! .with(filtered_layer)
+//! .init();
+//! info!("This will be ignored");
+//! reload_handle.modify(|layer| *layer.filter_mut() = filter::LevelFilter::INFO);
+//! info!("This will be logged");
+//! ```
+//!
+//! ## Note
+//!
+//! The [`Layer`] implementation is unable to implement downcasting functionality,
+//! so certain [`Layer`] will fail to downcast if wrapped in a `reload::Layer`.
+//!
+//! If you only want to be able to dynamically change the
+//! `Filter` on a layer, prefer wrapping that `Filter` in the `reload::Layer`.
+//!
+//! [`Filter` trait]: crate::layer::Filter
+//! [`Layer` type]: Layer
+//! [`Layer` trait]: super::layer::Layer
+use crate::layer;
+use crate::sync::RwLock;
+
+use core::any::TypeId;
+use std::{
+ error, fmt,
+ marker::PhantomData,
+ sync::{Arc, Weak},
+};
+use tracing_core::{
+ callsite, span,
+ subscriber::{Interest, Subscriber},
+ Dispatch, Event, LevelFilter, Metadata,
+};
+
+/// Wraps a `Layer` or `Filter`, allowing it to be reloaded dynamically at runtime.
+#[derive(Debug)]
+pub struct Layer<L, S> {
+ // TODO(eliza): this once used a `crossbeam_util::ShardedRwLock`. We may
+ // eventually wish to replace it with a sharded lock implementation on top
+ // of our internal `RwLock` wrapper type. If possible, we should profile
+ // this first to determine if it's necessary.
+ inner: Arc<RwLock<L>>,
+ _s: PhantomData<fn(S)>,
+}
+
+/// Allows reloading the state of an associated [`Layer`](crate::layer::Layer).
+#[derive(Debug)]
+pub struct Handle<L, S> {
+ inner: Weak<RwLock<L>>,
+ _s: PhantomData<fn(S)>,
+}
+
+/// Indicates that an error occurred when reloading a layer.
+#[derive(Debug)]
+pub struct Error {
+ kind: ErrorKind,
+}
+
+#[derive(Debug)]
+enum ErrorKind {
+ SubscriberGone,
+ Poisoned,
+}
+
+// ===== impl Layer =====
+
+impl<L, S> crate::Layer<S> for Layer<L, S>
+where
+ L: crate::Layer<S> + 'static,
+ S: Subscriber,
+{
+ fn on_register_dispatch(&self, subscriber: &Dispatch) {
+ try_lock!(self.inner.read()).on_register_dispatch(subscriber);
+ }
+
+ fn on_layer(&mut self, subscriber: &mut S) {
+ try_lock!(self.inner.write(), else return).on_layer(subscriber);
+ }
+
+ #[inline]
+ fn register_callsite(&self, metadata: &'static Metadata<'static>) -> Interest {
+ try_lock!(self.inner.read(), else return Interest::sometimes()).register_callsite(metadata)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: layer::Context<'_, S>) -> bool {
+ try_lock!(self.inner.read(), else return false).enabled(metadata, ctx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_record(span, values, ctx)
+ }
+
+ #[inline]
+ fn on_follows_from(&self, span: &span::Id, follows: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_follows_from(span, follows, ctx)
+ }
+
+ #[inline]
+ fn event_enabled(&self, event: &Event<'_>, ctx: layer::Context<'_, S>) -> bool {
+ try_lock!(self.inner.read(), else return false).event_enabled(event, ctx)
+ }
+
+ #[inline]
+ fn on_event(&self, event: &Event<'_>, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_event(event, ctx)
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_enter(id, ctx)
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_exit(id, ctx)
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_close(id, ctx)
+ }
+
+ #[inline]
+ fn on_id_change(&self, old: &span::Id, new: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_id_change(old, new, ctx)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ try_lock!(self.inner.read(), else return None).max_level_hint()
+ }
+
+ #[doc(hidden)]
+ unsafe fn downcast_raw(&self, id: TypeId) -> Option<*const ()> {
+ // Safety: it is generally unsafe to downcast through a reload, because
+ // the pointer can be invalidated after the lock is dropped.
+ // `NoneLayerMarker` is a special case because it
+ // is never dereferenced.
+ //
+ // Additionally, even if the marker type *is* dereferenced (which it
+ // never will be), the pointer should be valid even if the subscriber
+ // is reloaded, because all `NoneLayerMarker` pointers that we return
+ // actually point to the global static singleton `NoneLayerMarker`,
+ // rather than to a field inside the lock.
+ if id == TypeId::of::<layer::NoneLayerMarker>() {
+ return try_lock!(self.inner.read(), else return None).downcast_raw(id);
+ }
+
+ None
+ }
+}
+
+// ===== impl Filter =====
+
+#[cfg(all(feature = "registry", feature = "std"))]
+#[cfg_attr(docsrs, doc(cfg(all(feature = "registry", feature = "std"))))]
+impl<S, L> crate::layer::Filter<S> for Layer<L, S>
+where
+ L: crate::layer::Filter<S> + 'static,
+ S: Subscriber,
+{
+ #[inline]
+ fn callsite_enabled(&self, metadata: &'static Metadata<'static>) -> Interest {
+ try_lock!(self.inner.read(), else return Interest::sometimes()).callsite_enabled(metadata)
+ }
+
+ #[inline]
+ fn enabled(&self, metadata: &Metadata<'_>, ctx: &layer::Context<'_, S>) -> bool {
+ try_lock!(self.inner.read(), else return false).enabled(metadata, ctx)
+ }
+
+ #[inline]
+ fn on_new_span(&self, attrs: &span::Attributes<'_>, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_new_span(attrs, id, ctx)
+ }
+
+ #[inline]
+ fn on_record(&self, span: &span::Id, values: &span::Record<'_>, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_record(span, values, ctx)
+ }
+
+ #[inline]
+ fn on_enter(&self, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_enter(id, ctx)
+ }
+
+ #[inline]
+ fn on_exit(&self, id: &span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_exit(id, ctx)
+ }
+
+ #[inline]
+ fn on_close(&self, id: span::Id, ctx: layer::Context<'_, S>) {
+ try_lock!(self.inner.read()).on_close(id, ctx)
+ }
+
+ #[inline]
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ try_lock!(self.inner.read(), else return None).max_level_hint()
+ }
+}
+
+impl<L, S> Layer<L, S> {
+ /// Wraps the given [`Layer`] or [`Filter`], returning a `reload::Layer`
+ /// and a `Handle` that allows the inner value to be modified at runtime.
+ ///
+ /// [`Layer`]: crate::layer::Layer
+ /// [`Filter`]: crate::layer::Filter
+ pub fn new(inner: L) -> (Self, Handle<L, S>) {
+ let this = Self {
+ inner: Arc::new(RwLock::new(inner)),
+ _s: PhantomData,
+ };
+ let handle = this.handle();
+ (this, handle)
+ }
+
+ /// Returns a `Handle` that can be used to reload the wrapped [`Layer`] or [`Filter`].
+ ///
+ /// [`Layer`]: crate::layer::Layer
+ /// [`Filter`]: crate::filter::Filter
+ pub fn handle(&self) -> Handle<L, S> {
+ Handle {
+ inner: Arc::downgrade(&self.inner),
+ _s: PhantomData,
+ }
+ }
+}
+
+// ===== impl Handle =====
+
+impl<L, S> Handle<L, S> {
+ /// Replace the current [`Layer`] or [`Filter`] with the provided `new_value`.
+ ///
+ /// [`Handle::reload`] cannot be used with the [`Filtered`] layer; use
+ /// [`Handle::modify`] instead (see [this issue] for additional details).
+ ///
+ /// However, if the _only_ the [`Filter`] needs to be modified, use
+ /// `reload::Layer` to wrap the `Filter` directly.
+ ///
+ /// [`Layer`]: crate::layer::Layer
+ /// [`Filter`]: crate::layer::Filter
+ /// [`Filtered`]: crate::filter::Filtered
+ ///
+ /// [this issue]: https://github.com/tokio-rs/tracing/issues/1629
+ pub fn reload(&self, new_value: impl Into<L>) -> Result<(), Error> {
+ self.modify(|layer| {
+ *layer = new_value.into();
+ })
+ }
+
+ /// Invokes a closure with a mutable reference to the current layer or filter,
+ /// allowing it to be modified in place.
+ pub fn modify(&self, f: impl FnOnce(&mut L)) -> Result<(), Error> {
+ let inner = self.inner.upgrade().ok_or(Error {
+ kind: ErrorKind::SubscriberGone,
+ })?;
+
+ let mut lock = try_lock!(inner.write(), else return Err(Error::poisoned()));
+ f(&mut *lock);
+ // Release the lock before rebuilding the interest cache, as that
+ // function will lock the new layer.
+ drop(lock);
+
+ callsite::rebuild_interest_cache();
+ Ok(())
+ }
+
+ /// Returns a clone of the layer or filter's current value if it still exists.
+ /// Otherwise, if the subscriber has been dropped, returns `None`.
+ pub fn clone_current(&self) -> Option<L>
+ where
+ L: Clone,
+ {
+ self.with_current(L::clone).ok()
+ }
+
+ /// Invokes a closure with a borrowed reference to the current layer or filter,
+ /// returning the result (or an error if the subscriber no longer exists).
+ pub fn with_current<T>(&self, f: impl FnOnce(&L) -> T) -> Result<T, Error> {
+ let inner = self.inner.upgrade().ok_or(Error {
+ kind: ErrorKind::SubscriberGone,
+ })?;
+ let inner = try_lock!(inner.read(), else return Err(Error::poisoned()));
+ Ok(f(&*inner))
+ }
+}
+
+impl<L, S> Clone for Handle<L, S> {
+ fn clone(&self) -> Self {
+ Handle {
+ inner: self.inner.clone(),
+ _s: PhantomData,
+ }
+ }
+}
+
+// ===== impl Error =====
+
+impl Error {
+ fn poisoned() -> Self {
+ Self {
+ kind: ErrorKind::Poisoned,
+ }
+ }
+
+ /// Returns `true` if this error occurred because the layer was poisoned by
+ /// a panic on another thread.
+ pub fn is_poisoned(&self) -> bool {
+ matches!(self.kind, ErrorKind::Poisoned)
+ }
+
+ /// Returns `true` if this error occurred because the `Subscriber`
+ /// containing the reloadable layer was dropped.
+ pub fn is_dropped(&self) -> bool {
+ matches!(self.kind, ErrorKind::SubscriberGone)
+ }
+}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let msg = match self.kind {
+ ErrorKind::SubscriberGone => "subscriber no longer exists",
+ ErrorKind::Poisoned => "lock poisoned",
+ };
+ f.pad(msg)
+ }
+}
+
+impl error::Error for Error {}
diff --git a/crates/tracing-subscriber/src/sync.rs b/crates/tracing-subscriber/src/sync.rs
new file mode 100644
index 0000000..ec42b83
--- /dev/null
+++ b/crates/tracing-subscriber/src/sync.rs
@@ -0,0 +1,57 @@
+//! Abstracts over sync primitive implementations.
+//!
+//! Optionally, we allow the Rust standard library's `RwLock` to be replaced
+//! with the `parking_lot` crate's implementation. This may provide improved
+//! performance in some cases. However, the `parking_lot` dependency is an
+//! opt-in feature flag. Because `parking_lot::RwLock` has a slightly different
+//! API than `std::sync::RwLock` (it does not support poisoning on panics), we
+//! wrap it with a type that provides the same method signatures. This allows us
+//! to transparently swap `parking_lot` in without changing code at the callsite.
+#[allow(unused_imports)] // may be used later;
+pub(crate) use std::sync::{LockResult, PoisonError, TryLockResult};
+
+#[cfg(not(feature = "parking_lot"))]
+pub(crate) use std::sync::{RwLock, RwLockReadGuard, RwLockWriteGuard};
+
+#[cfg(feature = "parking_lot")]
+pub(crate) use self::parking_lot_impl::*;
+
+#[cfg(feature = "parking_lot")]
+mod parking_lot_impl {
+ pub(crate) use parking_lot::{RwLockReadGuard, RwLockWriteGuard};
+ use std::sync::{LockResult, TryLockError, TryLockResult};
+
+ #[derive(Debug)]
+ pub(crate) struct RwLock<T> {
+ inner: parking_lot::RwLock<T>,
+ }
+
+ impl<T> RwLock<T> {
+ pub(crate) fn new(val: T) -> Self {
+ Self {
+ inner: parking_lot::RwLock::new(val),
+ }
+ }
+
+ #[inline]
+ pub(crate) fn get_mut(&mut self) -> LockResult<&mut T> {
+ Ok(self.inner.get_mut())
+ }
+
+ #[inline]
+ pub(crate) fn read(&self) -> LockResult<RwLockReadGuard<'_, T>> {
+ Ok(self.inner.read())
+ }
+
+ #[inline]
+ #[allow(dead_code)] // may be used later;
+ pub(crate) fn try_read(&self) -> TryLockResult<RwLockReadGuard<'_, T>> {
+ self.inner.try_read().ok_or(TryLockError::WouldBlock)
+ }
+
+ #[inline]
+ pub(crate) fn write(&self) -> LockResult<RwLockWriteGuard<'_, T>> {
+ Ok(self.inner.write())
+ }
+ }
+}
diff --git a/crates/tracing-subscriber/src/util.rs b/crates/tracing-subscriber/src/util.rs
new file mode 100644
index 0000000..1c98aa4
--- /dev/null
+++ b/crates/tracing-subscriber/src/util.rs
@@ -0,0 +1,153 @@
+//! Extension traits and other utilities to make working with subscribers more
+//! ergonomic.
+use core::fmt;
+#[cfg(feature = "std")]
+use std::error::Error;
+use tracing_core::dispatcher::{self, Dispatch};
+#[cfg(feature = "tracing-log")]
+use tracing_log::AsLog;
+
+/// Extension trait adding utility methods for subscriber initialization.
+///
+/// This trait provides extension methods to make configuring and setting a
+/// [default subscriber] more ergonomic. It is automatically implemented for all
+/// types that can be converted into a [trace dispatcher]. Since `Dispatch`
+/// implements `From<T>` for all `T: Subscriber`, all `Subscriber`
+/// implementations will implement this extension trait as well. Types which
+/// can be converted into `Subscriber`s, such as builders that construct a
+/// `Subscriber`, may implement `Into<Dispatch>`, and will also receive an
+/// implementation of this trait.
+///
+/// [default subscriber]: https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber
+/// [trace dispatcher]: https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html
+pub trait SubscriberInitExt
+where
+ Self: Into<Dispatch>,
+{
+ /// Sets `self` as the [default subscriber] in the current scope, returning a
+ /// guard that will unset it when dropped.
+ ///
+ /// If the "tracing-log" feature flag is enabled, this will also initialize
+ /// a [`log`] compatibility layer. This allows the subscriber to consume
+ /// `log::Record`s as though they were `tracing` `Event`s.
+ ///
+ /// [default subscriber]: https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber
+ /// [`log`]: https://crates.io/log
+ #[cfg(feature = "std")]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ fn set_default(self) -> dispatcher::DefaultGuard {
+ #[cfg(feature = "tracing-log")]
+ let _ = tracing_log::LogTracer::init();
+
+ dispatcher::set_default(&self.into())
+ }
+
+ /// Attempts to set `self` as the [global default subscriber] in the current
+ /// scope, returning an error if one is already set.
+ ///
+ /// If the "tracing-log" feature flag is enabled, this will also attempt to
+ /// initialize a [`log`] compatibility layer. This allows the subscriber to
+ /// consume `log::Record`s as though they were `tracing` `Event`s.
+ ///
+ /// This method returns an error if a global default subscriber has already
+ /// been set, or if a `log` logger has already been set (when the
+ /// "tracing-log" feature is enabled).
+ ///
+ /// [global default subscriber]: https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber
+ /// [`log`]: https://crates.io/log
+ fn try_init(self) -> Result<(), TryInitError> {
+ dispatcher::set_global_default(self.into()).map_err(TryInitError::new)?;
+
+ // Since we are setting the global default subscriber, we can
+ // opportunistically go ahead and set its global max level hint as
+ // the max level for the `log` crate as well. This should make
+ // skipping `log` diagnostics much faster.
+ #[cfg(feature = "tracing-log")]
+ tracing_log::LogTracer::builder()
+ // Note that we must call this *after* setting the global default
+ // subscriber, so that we get its max level hint.
+ .with_max_level(tracing_core::LevelFilter::current().as_log())
+ .init()
+ .map_err(TryInitError::new)?;
+
+ Ok(())
+ }
+
+ /// Attempts to set `self` as the [global default subscriber] in the current
+ /// scope, panicking if this fails.
+ ///
+ /// If the "tracing-log" feature flag is enabled, this will also attempt to
+ /// initialize a [`log`] compatibility layer. This allows the subscriber to
+ /// consume `log::Record`s as though they were `tracing` `Event`s.
+ ///
+ /// This method panics if a global default subscriber has already been set,
+ /// or if a `log` logger has already been set (when the "tracing-log"
+ /// feature is enabled).
+ ///
+ /// [global default subscriber]: https://docs.rs/tracing/0.1.21/tracing/dispatcher/index.html#setting-the-default-subscriber
+ /// [`log`]: https://crates.io/log
+ fn init(self) {
+ self.try_init()
+ .expect("failed to set global default subscriber")
+ }
+}
+
+impl<T> SubscriberInitExt for T where T: Into<Dispatch> {}
+
+/// Error returned by [`try_init`](SubscriberInitExt::try_init) if a global default subscriber could not be initialized.
+pub struct TryInitError {
+ #[cfg(feature = "std")]
+ inner: Box<dyn Error + Send + Sync + 'static>,
+
+ #[cfg(not(feature = "std"))]
+ _p: (),
+}
+
+// ==== impl TryInitError ====
+
+impl TryInitError {
+ #[cfg(feature = "std")]
+ fn new(e: impl Into<Box<dyn Error + Send + Sync + 'static>>) -> Self {
+ Self { inner: e.into() }
+ }
+
+ #[cfg(not(feature = "std"))]
+ fn new<T>(_: T) -> Self {
+ Self { _p: () }
+ }
+}
+
+impl fmt::Debug for TryInitError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ #[cfg(feature = "std")]
+ {
+ fmt::Debug::fmt(&self.inner, f)
+ }
+
+ #[cfg(not(feature = "std"))]
+ {
+ f.write_str("TryInitError(())")
+ }
+ }
+}
+
+impl fmt::Display for TryInitError {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ #[cfg(feature = "std")]
+ {
+ fmt::Display::fmt(&self.inner, f)
+ }
+
+ #[cfg(not(feature = "std"))]
+ {
+ f.write_str("failed to set global default subscriber")
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl Error for TryInitError {
+ fn source(&self) -> Option<&(dyn Error + 'static)> {
+ self.inner.source()
+ }
+}
diff --git a/crates/tracing-subscriber/tests/cached_layer_filters_dont_break_other_layers.rs b/crates/tracing-subscriber/tests/cached_layer_filters_dont_break_other_layers.rs
new file mode 100644
index 0000000..b6d7677
--- /dev/null
+++ b/crates/tracing-subscriber/tests/cached_layer_filters_dont_break_other_layers.rs
@@ -0,0 +1,126 @@
+#![cfg(feature = "registry")]
+use tracing::Level;
+use tracing_mock::{
+ expect,
+ layer::{self, MockLayer},
+ subscriber,
+};
+use tracing_subscriber::{filter::LevelFilter, prelude::*};
+
+#[test]
+fn layer_filters() {
+ let (unfiltered, unfiltered_handle) = unfiltered("unfiltered");
+ let (filtered, filtered_handle) = filtered("filtered");
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered.with_filter(filter()))
+ .set_default();
+
+ events();
+
+ unfiltered_handle.assert_finished();
+ filtered_handle.assert_finished();
+}
+
+#[test]
+fn layered_layer_filters() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let unfiltered = unfiltered1.and_then(unfiltered2);
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+ let filtered = filtered1
+ .with_filter(filter())
+ .and_then(filtered2.with_filter(filter()));
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered)
+ .set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn out_of_order() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered1)
+ .with(filtered1.with_filter(filter()))
+ .with(unfiltered2)
+ .with(filtered2.with_filter(filter()))
+ .set_default();
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn mixed_layered() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let layered1 = filtered1.with_filter(filter()).and_then(unfiltered1);
+ let layered2 = unfiltered2.and_then(filtered2.with_filter(filter()));
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layered1)
+ .with(layered2)
+ .set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+}
+
+fn filter() -> LevelFilter {
+ LevelFilter::INFO
+}
+
+fn unfiltered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
+
+fn filtered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
diff --git a/crates/tracing-subscriber/tests/duplicate_spans.rs b/crates/tracing-subscriber/tests/duplicate_spans.rs
new file mode 100644
index 0000000..5d4dc6a
--- /dev/null
+++ b/crates/tracing-subscriber/tests/duplicate_spans.rs
@@ -0,0 +1,47 @@
+#![cfg(all(feature = "env-filter", feature = "fmt"))]
+use tracing::{self, subscriber::with_default, Span};
+use tracing_subscriber::{filter::EnvFilter, FmtSubscriber};
+
+#[test]
+fn duplicate_spans() {
+ let subscriber = FmtSubscriber::builder()
+ .with_env_filter(EnvFilter::new("[root]=debug"))
+ .finish();
+
+ with_default(subscriber, || {
+ let root = tracing::debug_span!("root");
+ root.in_scope(|| {
+ // root:
+ assert_eq!(root, Span::current(), "Current span must be 'root'");
+ let leaf = tracing::debug_span!("leaf");
+ leaf.in_scope(|| {
+ // root:leaf:
+ assert_eq!(leaf, Span::current(), "Current span must be 'leaf'");
+ root.in_scope(|| {
+ // root:leaf:
+ assert_eq!(
+ leaf,
+ Span::current(),
+ "Current span must be 'leaf' after entering twice the 'root' span"
+ );
+ })
+ });
+ // root:
+ assert_eq!(
+ root,
+ Span::current(),
+ "Current span must be root ('leaf' exited, nested 'root' exited)"
+ );
+
+ root.in_scope(|| {
+ assert_eq!(root, Span::current(), "Current span must be root");
+ });
+ // root:
+ assert_eq!(
+ root,
+ Span::current(),
+ "Current span must still be root after exiting nested 'root'"
+ );
+ });
+ });
+}
diff --git a/crates/tracing-subscriber/tests/env_filter/main.rs b/crates/tracing-subscriber/tests/env_filter/main.rs
new file mode 100644
index 0000000..1692181
--- /dev/null
+++ b/crates/tracing-subscriber/tests/env_filter/main.rs
@@ -0,0 +1,545 @@
+#![cfg(feature = "env-filter")]
+
+mod per_layer;
+
+use tracing::{self, subscriber::with_default, Level};
+use tracing_mock::{expect, layer, span, subscriber};
+use tracing_subscriber::{
+ filter::{EnvFilter, LevelFilter},
+ prelude::*,
+ Registry,
+};
+
+#[test]
+fn level_filter_event() {
+ let filter: EnvFilter = "info".parse().expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "foo", "this should also be disabled");
+ tracing::warn!(target: "foo", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn same_name_spans() {
+ let filter: EnvFilter = "[foo{bar}]=trace,[foo{baz}]=trace"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("bar")),
+ )
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("baz")),
+ )
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+ with_default(subscriber, || {
+ tracing::trace_span!("foo", bar = 1);
+ tracing::trace_span!("foo", baz = 1);
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn level_filter_event_with_target() {
+ let filter: EnvFilter = "info,stuff=debug".parse().expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn level_filter_event_with_target_and_span_global() {
+ let filter: EnvFilter = "info,stuff[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+
+ let cool_span = span::named("cool_span");
+ let uncool_span = span::named("uncool_span");
+ let (layer, handle) = layer::mock()
+ .enter(cool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![cool_span.clone()]),
+ )
+ .exit(cool_span)
+ .enter(uncool_span.clone())
+ .exit(uncool_span)
+ .only()
+ .run_with_handle();
+
+ let subscriber = Registry::default().with(filter).with(layer);
+
+ with_default(subscriber, || {
+ {
+ let _span = tracing::info_span!(target: "stuff", "cool_span").entered();
+ tracing::debug!("this should be enabled");
+ }
+
+ tracing::debug!("should also be disabled");
+
+ {
+ let _span = tracing::info_span!("uncool_span").entered();
+ tracing::debug!("this should be disabled");
+ }
+ });
+
+ handle.assert_finished();
+}
+
+#[test]
+fn not_order_dependent() {
+ // this test reproduces tokio-rs/tracing#623
+
+ let filter: EnvFilter = "stuff=debug,info".parse().expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn add_directive_enables_event() {
+ // this test reproduces tokio-rs/tracing#591
+
+ // by default, use info level
+ let mut filter = EnvFilter::new(LevelFilter::INFO.to_string());
+
+ // overwrite with a more specific directive
+ filter = filter.add_directive("hello=trace".parse().expect("directive should parse"));
+
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO).with_target("hello"))
+ .event(expect::event().at_level(Level::TRACE).with_target("hello"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::info!(target: "hello", "hello info");
+ tracing::trace!(target: "hello", "hello trace");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn span_name_filter_is_dynamic() {
+ let filter: EnvFilter = "info,[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .enter(expect::span().named("cool_span"))
+ .event(expect::event().at_level(Level::DEBUG))
+ .enter(expect::span().named("uncool_span"))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::DEBUG))
+ .exit(expect::span().named("uncool_span"))
+ .exit(expect::span().named("cool_span"))
+ .enter(expect::span().named("uncool_span"))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .exit(expect::span().named("uncool_span"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ let cool_span = tracing::info_span!("cool_span");
+ let uncool_span = tracing::info_span!("uncool_span");
+
+ {
+ let _enter = cool_span.enter();
+ tracing::debug!("i'm a cool event");
+ tracing::trace!("i'm cool, but not cool enough");
+ let _enter2 = uncool_span.enter();
+ tracing::warn!("warning: extremely cool!");
+ tracing::debug!("i'm still cool");
+ }
+
+ let _enter = uncool_span.enter();
+ tracing::warn!("warning: not that cool");
+ tracing::trace!("im not cool enough");
+ tracing::error!("uncool error");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn method_name_resolution() {
+ #[allow(unused_imports)]
+ use tracing_subscriber::layer::{Filter, Layer};
+
+ let filter = EnvFilter::new("hello_world=info");
+ filter.max_level_hint();
+}
+
+// contains the same tests as the first half of this file
+// but using EnvFilter as a `Filter`, not as a `Layer`
+mod per_layer_filter {
+ use super::*;
+
+ #[test]
+ fn level_filter_event() {
+ let filter: EnvFilter = "info".parse().expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "foo", "this should also be disabled");
+ tracing::warn!(target: "foo", "this should be enabled");
+ tracing::error!("this should be enabled too");
+
+ handle.assert_finished();
+ }
+
+ #[test]
+ fn same_name_spans() {
+ let filter: EnvFilter = "[foo{bar}]=trace,[foo{baz}]=trace"
+ .parse()
+ .expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("bar")),
+ )
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("baz")),
+ )
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace_span!("foo", bar = 1);
+ tracing::trace_span!("foo", baz = 1);
+
+ handle.assert_finished();
+ }
+
+ #[test]
+ fn level_filter_event_with_target() {
+ let filter: EnvFilter = "info,stuff=debug".parse().expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+
+ handle.assert_finished();
+ }
+
+ #[test]
+ fn level_filter_event_with_target_and_span() {
+ let filter: EnvFilter = "stuff[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+
+ let cool_span = span::named("cool_span");
+ let (layer, handle) = layer::mock()
+ .enter(cool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![cool_span.clone()]),
+ )
+ .exit(cool_span)
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ {
+ let _span = tracing::info_span!(target: "stuff", "cool_span").entered();
+ tracing::debug!("this should be enabled");
+ }
+
+ tracing::debug!("should also be disabled");
+
+ {
+ let _span = tracing::info_span!("uncool_span").entered();
+ tracing::debug!("this should be disabled");
+ }
+
+ handle.assert_finished();
+ }
+
+ #[test]
+ fn not_order_dependent() {
+ // this test reproduces tokio-rs/tracing#623
+
+ let filter: EnvFilter = "stuff=debug,info".parse().expect("filter should parse");
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+
+ finished.assert_finished();
+ }
+
+ #[test]
+ fn add_directive_enables_event() {
+ // this test reproduces tokio-rs/tracing#591
+
+ // by default, use info level
+ let mut filter = EnvFilter::new(LevelFilter::INFO.to_string());
+
+ // overwrite with a more specific directive
+ filter = filter.add_directive("hello=trace".parse().expect("directive should parse"));
+
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO).with_target("hello"))
+ .event(expect::event().at_level(Level::TRACE).with_target("hello"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::info!(target: "hello", "hello info");
+ tracing::trace!(target: "hello", "hello trace");
+
+ finished.assert_finished();
+ }
+
+ #[test]
+ fn span_name_filter_is_dynamic() {
+ let filter: EnvFilter = "info,[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+ let cool_span = span::named("cool_span");
+ let uncool_span = span::named("uncool_span");
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .enter(cool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![cool_span.clone()]),
+ )
+ .enter(uncool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::WARN)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .exit(uncool_span.clone())
+ .exit(cool_span)
+ .enter(uncool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::WARN)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::ERROR)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .exit(uncool_span)
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ let cool_span = tracing::info_span!("cool_span");
+ let uncool_span = tracing::info_span!("uncool_span");
+
+ {
+ let _enter = cool_span.enter();
+ tracing::debug!("i'm a cool event");
+ tracing::trace!("i'm cool, but not cool enough");
+ let _enter2 = uncool_span.enter();
+ tracing::warn!("warning: extremely cool!");
+ tracing::debug!("i'm still cool");
+ }
+
+ {
+ let _enter = uncool_span.enter();
+ tracing::warn!("warning: not that cool");
+ tracing::trace!("im not cool enough");
+ tracing::error!("uncool error");
+ }
+
+ finished.assert_finished();
+ }
+
+ #[test]
+ fn multiple_dynamic_filters() {
+ // Test that multiple dynamic (span) filters only apply to the layers
+ // they're attached to.
+ let (layer1, handle1) = {
+ let span = span::named("span1");
+ let filter: EnvFilter = "[span1]=debug".parse().expect("filter 1 should parse");
+ let (layer, handle) = layer::named("layer1")
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![span.clone()]),
+ )
+ .exit(span)
+ .only()
+ .run_with_handle();
+ (layer.with_filter(filter), handle)
+ };
+
+ let (layer2, handle2) = {
+ let span = span::named("span2");
+ let filter: EnvFilter = "[span2]=info".parse().expect("filter 2 should parse");
+ let (layer, handle) = layer::named("layer2")
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .in_scope(vec![span.clone()]),
+ )
+ .exit(span)
+ .only()
+ .run_with_handle();
+ (layer.with_filter(filter), handle)
+ };
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer1)
+ .with(layer2)
+ .set_default();
+
+ tracing::info_span!("span1").in_scope(|| {
+ tracing::debug!("hello from span 1");
+ tracing::trace!("not enabled");
+ });
+
+ tracing::info_span!("span2").in_scope(|| {
+ tracing::info!("hello from span 2");
+ tracing::debug!("not enabled");
+ });
+
+ handle1.assert_finished();
+ handle2.assert_finished();
+ }
+}
diff --git a/crates/tracing-subscriber/tests/env_filter/per_layer.rs b/crates/tracing-subscriber/tests/env_filter/per_layer.rs
new file mode 100644
index 0000000..229b9ff
--- /dev/null
+++ b/crates/tracing-subscriber/tests/env_filter/per_layer.rs
@@ -0,0 +1,306 @@
+//! Tests for using `EnvFilter` as a per-layer filter (rather than a global
+//! `Layer` filter).
+#![cfg(feature = "registry")]
+use super::*;
+use tracing_mock::{layer, span};
+
+#[test]
+fn level_filter_event() {
+ let filter: EnvFilter = "info".parse().expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "foo", "this should also be disabled");
+ tracing::warn!(target: "foo", "this should be enabled");
+ tracing::error!("this should be enabled too");
+
+ handle.assert_finished();
+}
+
+#[test]
+fn same_name_spans() {
+ let filter: EnvFilter = "[foo{bar}]=trace,[foo{baz}]=trace"
+ .parse()
+ .expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("bar")),
+ )
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("baz")),
+ )
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace_span!("foo", bar = 1);
+ tracing::trace_span!("foo", baz = 1);
+
+ handle.assert_finished();
+}
+
+#[test]
+fn level_filter_event_with_target() {
+ let filter: EnvFilter = "info,stuff=debug".parse().expect("filter should parse");
+ let (layer, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+
+ handle.assert_finished();
+}
+
+#[test]
+fn level_filter_event_with_target_and_span() {
+ let filter: EnvFilter = "stuff[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+
+ let cool_span = span::named("cool_span");
+ let (layer, handle) = layer::mock()
+ .enter(cool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![cool_span.clone()]),
+ )
+ .exit(cool_span)
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ {
+ let _span = tracing::info_span!(target: "stuff", "cool_span").entered();
+ tracing::debug!("this should be enabled");
+ }
+
+ tracing::debug!("should also be disabled");
+
+ {
+ let _span = tracing::info_span!("uncool_span").entered();
+ tracing::debug!("this should be disabled");
+ }
+
+ handle.assert_finished();
+}
+
+#[test]
+fn not_order_dependent() {
+ // this test reproduces tokio-rs/tracing#623
+
+ let filter: EnvFilter = "stuff=debug,info".parse().expect("filter should parse");
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG).with_target("stuff"))
+ .event(expect::event().at_level(Level::WARN).with_target("stuff"))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::ERROR).with_target("stuff"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ tracing::debug!(target: "stuff", "this should be enabled");
+ tracing::debug!("but this shouldn't");
+ tracing::trace!(target: "stuff", "and neither should this");
+ tracing::warn!(target: "stuff", "this should be enabled");
+ tracing::error!("this should be enabled too");
+ tracing::error!(target: "stuff", "this should be enabled also");
+
+ finished.assert_finished();
+}
+
+#[test]
+fn add_directive_enables_event() {
+ // this test reproduces tokio-rs/tracing#591
+
+ // by default, use info level
+ let mut filter = EnvFilter::new(LevelFilter::INFO.to_string());
+
+ // overwrite with a more specific directive
+ filter = filter.add_directive("hello=trace".parse().expect("directive should parse"));
+
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO).with_target("hello"))
+ .event(expect::event().at_level(Level::TRACE).with_target("hello"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::info!(target: "hello", "hello info");
+ tracing::trace!(target: "hello", "hello trace");
+
+ finished.assert_finished();
+}
+
+#[test]
+fn span_name_filter_is_dynamic() {
+ let filter: EnvFilter = "info,[cool_span]=debug"
+ .parse()
+ .expect("filter should parse");
+ let cool_span = span::named("cool_span");
+ let uncool_span = span::named("uncool_span");
+ let (layer, finished) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .enter(cool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![cool_span.clone()]),
+ )
+ .enter(uncool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::WARN)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .exit(uncool_span.clone())
+ .exit(cool_span)
+ .enter(uncool_span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::WARN)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::ERROR)
+ .in_scope(vec![uncool_span.clone()]),
+ )
+ .exit(uncool_span)
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::trace!("this should be disabled");
+ tracing::info!("this shouldn't be");
+ let cool_span = tracing::info_span!("cool_span");
+ let uncool_span = tracing::info_span!("uncool_span");
+
+ {
+ let _enter = cool_span.enter();
+ tracing::debug!("i'm a cool event");
+ tracing::trace!("i'm cool, but not cool enough");
+ let _enter2 = uncool_span.enter();
+ tracing::warn!("warning: extremely cool!");
+ tracing::debug!("i'm still cool");
+ }
+
+ {
+ let _enter = uncool_span.enter();
+ tracing::warn!("warning: not that cool");
+ tracing::trace!("im not cool enough");
+ tracing::error!("uncool error");
+ }
+
+ finished.assert_finished();
+}
+
+#[test]
+fn multiple_dynamic_filters() {
+ // Test that multiple dynamic (span) filters only apply to the layers
+ // they're attached to.
+ let (layer1, handle1) = {
+ let span = span::named("span1");
+ let filter: EnvFilter = "[span1]=debug".parse().expect("filter 1 should parse");
+ let (layer, handle) = layer::named("layer1")
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .in_scope(vec![span.clone()]),
+ )
+ .exit(span)
+ .only()
+ .run_with_handle();
+ (layer.with_filter(filter), handle)
+ };
+
+ let (layer2, handle2) = {
+ let span = span::named("span2");
+ let filter: EnvFilter = "[span2]=info".parse().expect("filter 2 should parse");
+ let (layer, handle) = layer::named("layer2")
+ .enter(span.clone())
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .in_scope(vec![span.clone()]),
+ )
+ .exit(span)
+ .only()
+ .run_with_handle();
+ (layer.with_filter(filter), handle)
+ };
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer1)
+ .with(layer2)
+ .set_default();
+
+ tracing::info_span!("span1").in_scope(|| {
+ tracing::debug!("hello from span 1");
+ tracing::trace!("not enabled");
+ });
+
+ tracing::info_span!("span2").in_scope(|| {
+ tracing::info!("hello from span 2");
+ tracing::debug!("not enabled");
+ });
+
+ handle1.assert_finished();
+ handle2.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/event_enabling.rs b/crates/tracing-subscriber/tests/event_enabling.rs
new file mode 100644
index 0000000..8f67cfc
--- /dev/null
+++ b/crates/tracing-subscriber/tests/event_enabling.rs
@@ -0,0 +1,81 @@
+#![cfg(feature = "registry")]
+
+use std::sync::{Arc, Mutex};
+use tracing::{subscriber::with_default, Event, Metadata, Subscriber};
+use tracing_subscriber::{layer::Context, prelude::*, registry, Layer};
+
+struct TrackingLayer {
+ enabled: bool,
+ event_enabled_count: Arc<Mutex<usize>>,
+ event_enabled: bool,
+ on_event_count: Arc<Mutex<usize>>,
+}
+
+impl<C> Layer<C> for TrackingLayer
+where
+ C: Subscriber + Send + Sync + 'static,
+{
+ fn enabled(&self, _metadata: &Metadata<'_>, _ctx: Context<'_, C>) -> bool {
+ self.enabled
+ }
+
+ fn event_enabled(&self, _event: &Event<'_>, _ctx: Context<'_, C>) -> bool {
+ *self.event_enabled_count.lock().unwrap() += 1;
+ self.event_enabled
+ }
+
+ fn on_event(&self, _event: &Event<'_>, _ctx: Context<'_, C>) {
+ *self.on_event_count.lock().unwrap() += 1;
+ }
+}
+
+#[test]
+fn event_enabled_is_only_called_once() {
+ let event_enabled_count = Arc::new(Mutex::default());
+ let count = event_enabled_count.clone();
+ let subscriber = registry().with(TrackingLayer {
+ enabled: true,
+ event_enabled_count,
+ event_enabled: true,
+ on_event_count: Arc::new(Mutex::default()),
+ });
+ with_default(subscriber, || {
+ tracing::error!("hiya!");
+ });
+
+ assert_eq!(1, *count.lock().unwrap());
+}
+
+#[test]
+fn event_enabled_not_called_when_not_enabled() {
+ let event_enabled_count = Arc::new(Mutex::default());
+ let count = event_enabled_count.clone();
+ let subscriber = registry().with(TrackingLayer {
+ enabled: false,
+ event_enabled_count,
+ event_enabled: true,
+ on_event_count: Arc::new(Mutex::default()),
+ });
+ with_default(subscriber, || {
+ tracing::error!("hiya!");
+ });
+
+ assert_eq!(0, *count.lock().unwrap());
+}
+
+#[test]
+fn event_disabled_does_disable_event() {
+ let on_event_count = Arc::new(Mutex::default());
+ let count = on_event_count.clone();
+ let subscriber = registry().with(TrackingLayer {
+ enabled: true,
+ event_enabled_count: Arc::new(Mutex::default()),
+ event_enabled: false,
+ on_event_count,
+ });
+ with_default(subscriber, || {
+ tracing::error!("hiya!");
+ });
+
+ assert_eq!(0, *count.lock().unwrap());
+}
diff --git a/crates/tracing-subscriber/tests/field_filter.rs b/crates/tracing-subscriber/tests/field_filter.rs
new file mode 100644
index 0000000..b14aebc
--- /dev/null
+++ b/crates/tracing-subscriber/tests/field_filter.rs
@@ -0,0 +1,115 @@
+#![cfg(feature = "env-filter")]
+
+use tracing::{self, subscriber::with_default, Level};
+use tracing_mock::*;
+use tracing_subscriber::{filter::EnvFilter, prelude::*};
+
+#[test]
+#[cfg_attr(not(flaky_tests), ignore)]
+fn field_filter_events() {
+ let filter: EnvFilter = "[{thing}]=debug".parse().expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_fields(expect::field("thing")),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .with_fields(expect::field("thing")),
+ )
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!(disabled = true);
+ tracing::info!("also disabled");
+ tracing::info!(thing = 1);
+ tracing::debug!(thing = 2);
+ tracing::trace!(thing = 3);
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+#[cfg_attr(not(flaky_tests), ignore)]
+fn field_filter_spans() {
+ let filter: EnvFilter = "[{enabled=true}]=debug"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .enter(expect::span().named("span1"))
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_fields(expect::field("something")),
+ )
+ .exit(expect::span().named("span1"))
+ .enter(expect::span().named("span2"))
+ .exit(expect::span().named("span2"))
+ .enter(expect::span().named("span3"))
+ .event(
+ expect::event()
+ .at_level(Level::DEBUG)
+ .with_fields(expect::field("something")),
+ )
+ .exit(expect::span().named("span3"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!("disabled");
+ tracing::info!("also disabled");
+ tracing::info_span!("span1", enabled = true).in_scope(|| {
+ tracing::info!(something = 1);
+ });
+ tracing::debug_span!("span2", enabled = false, foo = "hi").in_scope(|| {
+ tracing::warn!(something = 2);
+ });
+ tracing::trace_span!("span3", enabled = true, answer = 42).in_scope(|| {
+ tracing::debug!(something = 2);
+ });
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn record_after_created() {
+ let filter: EnvFilter = "[{enabled=true}]=debug"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .enter(expect::span().named("span"))
+ .exit(expect::span().named("span"))
+ .record(
+ expect::span().named("span"),
+ expect::field("enabled").with_value(&true),
+ )
+ .enter(expect::span().named("span"))
+ .event(expect::event().at_level(Level::DEBUG))
+ .exit(expect::span().named("span"))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ let span = tracing::info_span!("span", enabled = false);
+ span.in_scope(|| {
+ tracing::debug!("i'm disabled!");
+ });
+
+ span.record("enabled", true);
+ span.in_scope(|| {
+ tracing::debug!("i'm enabled!");
+ });
+
+ tracing::debug!("i'm also disabled");
+ });
+
+ finished.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/filter_log.rs b/crates/tracing-subscriber/tests/filter_log.rs
new file mode 100644
index 0000000..9cda434
--- /dev/null
+++ b/crates/tracing-subscriber/tests/filter_log.rs
@@ -0,0 +1,63 @@
+#![cfg(all(feature = "env-filter", feature = "tracing-log"))]
+
+use tracing::{self, Level};
+use tracing_mock::*;
+use tracing_subscriber::{filter::EnvFilter, prelude::*};
+
+mod my_module {
+ pub(crate) fn test_records() {
+ log::trace!("this should be disabled");
+ log::info!("this shouldn't be");
+ log::debug!("this should be disabled");
+ log::warn!("this should be enabled");
+ log::warn!(target: "something else", "this shouldn't be enabled");
+ log::error!("this should be enabled too");
+ }
+
+ pub(crate) fn test_log_enabled() {
+ assert!(
+ log::log_enabled!(log::Level::Info),
+ "info should be enabled inside `my_module`"
+ );
+ assert!(
+ !log::log_enabled!(log::Level::Debug),
+ "debug should not be enabled inside `my_module`"
+ );
+ assert!(
+ log::log_enabled!(log::Level::Warn),
+ "warn should be enabled inside `my_module`"
+ );
+ }
+}
+
+#[test]
+fn log_is_enabled() {
+ let filter: EnvFilter = "filter_log::my_module=info"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ // Note: we have to set the global default in order to set the `log` max
+ // level, which can only be set once.
+ subscriber.with(filter).init();
+
+ my_module::test_records();
+ log::info!("this is disabled");
+
+ my_module::test_log_enabled();
+ assert!(
+ !log::log_enabled!(log::Level::Info),
+ "info should not be enabled outside `my_module`"
+ );
+ assert!(
+ !log::log_enabled!(log::Level::Warn),
+ "warn should not be enabled outside `my_module`"
+ );
+
+ finished.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/fmt_max_level_hint.rs b/crates/tracing-subscriber/tests/fmt_max_level_hint.rs
new file mode 100644
index 0000000..57a0f6e
--- /dev/null
+++ b/crates/tracing-subscriber/tests/fmt_max_level_hint.rs
@@ -0,0 +1,10 @@
+#![cfg(feature = "fmt")]
+use tracing_subscriber::filter::LevelFilter;
+
+#[test]
+fn fmt_sets_max_level_hint() {
+ tracing_subscriber::fmt()
+ .with_max_level(LevelFilter::DEBUG)
+ .init();
+ assert_eq!(LevelFilter::current(), LevelFilter::DEBUG);
+}
diff --git a/crates/tracing-subscriber/tests/hinted_layer_filters_dont_break_other_layers.rs b/crates/tracing-subscriber/tests/hinted_layer_filters_dont_break_other_layers.rs
new file mode 100644
index 0000000..a3ad351
--- /dev/null
+++ b/crates/tracing-subscriber/tests/hinted_layer_filters_dont_break_other_layers.rs
@@ -0,0 +1,134 @@
+#![cfg(feature = "registry")]
+use tracing::{Level, Metadata, Subscriber};
+use tracing_mock::{
+ expect, layer,
+ layer::MockLayer,
+ subscriber::{self},
+};
+use tracing_subscriber::{filter::DynFilterFn, layer::Context, prelude::*};
+
+#[test]
+fn layer_filters() {
+ let (unfiltered, unfiltered_handle) = unfiltered("unfiltered");
+ let (filtered, filtered_handle) = filtered("filtered");
+
+ let subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered.with_filter(filter()));
+ assert_eq!(subscriber.max_level_hint(), None);
+ let _subscriber = subscriber.set_default();
+
+ events();
+
+ unfiltered_handle.assert_finished();
+ filtered_handle.assert_finished();
+}
+
+#[test]
+fn layered_layer_filters() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let unfiltered = unfiltered1.and_then(unfiltered2);
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+ let filtered = filtered1
+ .with_filter(filter())
+ .and_then(filtered2.with_filter(filter()));
+
+ let subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered);
+ assert_eq!(subscriber.max_level_hint(), None);
+ let _subscriber = subscriber.set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn out_of_order() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let subscriber = tracing_subscriber::registry()
+ .with(unfiltered1)
+ .with(filtered1.with_filter(filter()))
+ .with(unfiltered2)
+ .with(filtered2.with_filter(filter()));
+ assert_eq!(subscriber.max_level_hint(), None);
+ let _subscriber = subscriber.set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn mixed_layered() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let layered1 = filtered1.with_filter(filter()).and_then(unfiltered1);
+ let layered2 = unfiltered2.and_then(filtered2.with_filter(filter()));
+
+ let subscriber = tracing_subscriber::registry().with(layered1).with(layered2);
+ assert_eq!(subscriber.max_level_hint(), None);
+ let _subscriber = subscriber.set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+}
+
+fn filter<S>() -> DynFilterFn<S> {
+ DynFilterFn::new(
+ (|metadata: &Metadata<'_>, _: &tracing_subscriber::layer::Context<'_, S>| {
+ metadata.level() <= &Level::INFO
+ }) as fn(&Metadata<'_>, &Context<'_, S>) -> bool,
+ )
+ .with_max_level_hint(Level::INFO)
+}
+
+fn unfiltered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
+
+fn filtered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
diff --git a/crates/tracing-subscriber/tests/layer_filter_interests_are_cached.rs b/crates/tracing-subscriber/tests/layer_filter_interests_are_cached.rs
new file mode 100644
index 0000000..867fdd0
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filter_interests_are_cached.rs
@@ -0,0 +1,67 @@
+#![cfg(feature = "registry")]
+use std::{
+ collections::HashMap,
+ sync::{Arc, Mutex},
+};
+use tracing::{Level, Subscriber};
+use tracing_mock::{expect, layer};
+use tracing_subscriber::{filter, prelude::*};
+
+#[test]
+fn layer_filter_interests_are_cached() {
+ let seen = Arc::new(Mutex::new(HashMap::new()));
+ let seen2 = seen.clone();
+ let filter = filter::filter_fn(move |meta| {
+ *seen
+ .lock()
+ .unwrap()
+ .entry(meta.callsite())
+ .or_insert(0usize) += 1;
+ meta.level() == &Level::INFO
+ });
+
+ let (expect, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let subscriber = tracing_subscriber::registry().with(expect.with_filter(filter));
+ assert!(subscriber.max_level_hint().is_none());
+
+ let _subscriber = subscriber.set_default();
+
+ fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+ }
+
+ events();
+ {
+ let lock = seen2.lock().unwrap();
+ for (callsite, &count) in lock.iter() {
+ assert_eq!(
+ count, 1,
+ "callsite {:?} should have been seen 1 time (after first set of events)",
+ callsite
+ );
+ }
+ }
+
+ events();
+ {
+ let lock = seen2.lock().unwrap();
+ for (callsite, &count) in lock.iter() {
+ assert_eq!(
+ count, 1,
+ "callsite {:?} should have been seen 1 time (after second set of events)",
+ callsite
+ );
+ }
+ }
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/boxed.rs b/crates/tracing-subscriber/tests/layer_filters/boxed.rs
new file mode 100644
index 0000000..96566a5
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/boxed.rs
@@ -0,0 +1,43 @@
+use super::*;
+use tracing_mock::layer::MockLayer;
+use tracing_subscriber::{filter, prelude::*, Layer};
+
+fn layer() -> (MockLayer, subscriber::MockHandle) {
+ layer::mock().only().run_with_handle()
+}
+
+fn filter<S>() -> filter::DynFilterFn<S> {
+ // Use dynamic filter fn to disable interest caching and max-level hints,
+ // allowing us to put all of these tests in the same file.
+ filter::dynamic_filter_fn(|_, _| false)
+}
+
+/// reproduces https://github.com/tokio-rs/tracing/issues/1563#issuecomment-921363629
+#[test]
+fn box_works() {
+ let (layer, handle) = layer();
+ let layer = Box::new(layer.with_filter(filter()));
+
+ let _guard = tracing_subscriber::registry().with(layer).set_default();
+
+ for i in 0..2 {
+ tracing::info!(i);
+ }
+
+ handle.assert_finished();
+}
+
+/// the same as `box_works` but with a type-erased `Box`.
+#[test]
+fn dyn_box_works() {
+ let (layer, handle) = layer();
+ let layer: Box<dyn Layer<_> + Send + Sync + 'static> = Box::new(layer.with_filter(filter()));
+
+ let _guard = tracing_subscriber::registry().with(layer).set_default();
+
+ for i in 0..2 {
+ tracing::info!(i);
+ }
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/combinators.rs b/crates/tracing-subscriber/tests/layer_filters/combinators.rs
new file mode 100644
index 0000000..c5ea3b5
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/combinators.rs
@@ -0,0 +1,42 @@
+use super::*;
+use tracing_subscriber::{
+ filter::{filter_fn, FilterExt, LevelFilter},
+ prelude::*,
+};
+
+#[test]
+fn and() {
+ let (layer, handle) = layer::mock()
+ .event(
+ event::msg("a very interesting event")
+ .at_level(tracing::Level::INFO)
+ .with_target("interesting_target"),
+ )
+ .only()
+ .run_with_handle();
+
+ // Enables spans and events with targets starting with `interesting_target`:
+ let target_filter = filter::filter_fn(|meta| meta.target().starts_with("interesting_target"));
+
+ // Enables spans and events with levels `INFO` and below:
+ let level_filter = LevelFilter::INFO;
+
+ // Combine the two filters together, returning a filter that only enables
+ // spans and events that *both* filters will enable:
+ let filter = target_filter.and(level_filter);
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ // This event will *not* be enabled:
+ tracing::info!("an event with an uninteresting target");
+
+ // This event *will* be enabled:
+ tracing::info!(target: "interesting_target", "a very interesting event");
+
+ // This event will *not* be enabled:
+ tracing::debug!(target: "interesting_target", "interesting debug event...");
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/downcast_raw.rs b/crates/tracing-subscriber/tests/layer_filters/downcast_raw.rs
new file mode 100644
index 0000000..b5f7e35
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/downcast_raw.rs
@@ -0,0 +1,68 @@
+use tracing::Subscriber;
+use tracing_subscriber::filter::Targets;
+use tracing_subscriber::prelude::*;
+use tracing_subscriber::Layer;
+
+#[test]
+fn downcast_ref_to_inner_layer_and_filter() {
+ // Test that a filtered layer gives downcast_ref access to
+ // both the layer and the filter.
+
+ struct WrappedLayer;
+
+ impl<S> Layer<S> for WrappedLayer
+ where
+ S: Subscriber,
+ S: for<'lookup> tracing_subscriber::registry::LookupSpan<'lookup>,
+ {
+ }
+
+ let layer = WrappedLayer;
+ let filter = Targets::new().with_default(tracing::Level::INFO);
+ let registry = tracing_subscriber::registry().with(layer.with_filter(filter));
+ let dispatch = tracing::dispatcher::Dispatch::new(registry);
+
+ // The filter is available
+ assert!(dispatch.downcast_ref::<Targets>().is_some());
+ // The wrapped layer is available
+ assert!(dispatch.downcast_ref::<WrappedLayer>().is_some());
+}
+
+#[test]
+fn forward_downcast_raw_to_layer() {
+ // Test that a filtered layer still gives its wrapped layer a chance to
+ // return a custom struct from downcast_raw.
+ // https://github.com/tokio-rs/tracing/issues/1618
+
+ struct WrappedLayer {
+ with_context: WithContext,
+ }
+
+ struct WithContext;
+
+ impl<S> Layer<S> for WrappedLayer
+ where
+ S: Subscriber,
+ S: for<'lookup> tracing_subscriber::registry::LookupSpan<'lookup>,
+ {
+ unsafe fn downcast_raw(&self, id: std::any::TypeId) -> Option<*const ()> {
+ match id {
+ id if id == std::any::TypeId::of::<Self>() => Some(self as *const _ as *const ()),
+ id if id == std::any::TypeId::of::<WithContext>() => {
+ Some(&self.with_context as *const _ as *const ())
+ }
+ _ => None,
+ }
+ }
+ }
+
+ let layer = WrappedLayer {
+ with_context: WithContext,
+ };
+ let filter = Targets::new().with_default(tracing::Level::INFO);
+ let registry = tracing_subscriber::registry().with(layer.with_filter(filter));
+ let dispatch = tracing::dispatcher::Dispatch::new(registry);
+
+ // Types from a custom implementation of `downcast_raw` are available
+ assert!(dispatch.downcast_ref::<WithContext>().is_some());
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/filter_scopes.rs b/crates/tracing-subscriber/tests/layer_filters/filter_scopes.rs
new file mode 100644
index 0000000..02d0007
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/filter_scopes.rs
@@ -0,0 +1,132 @@
+use super::*;
+use tracing_mock::{event, expect, layer::MockLayer};
+
+#[test]
+fn filters_span_scopes() {
+ let (debug_layer, debug_handle) = layer::named("debug")
+ .enter(expect::span().at_level(Level::DEBUG))
+ .enter(expect::span().at_level(Level::INFO))
+ .enter(expect::span().at_level(Level::WARN))
+ .enter(expect::span().at_level(Level::ERROR))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().at_level(Level::ERROR),
+ expect::span().at_level(Level::WARN),
+ expect::span().at_level(Level::INFO),
+ expect::span().at_level(Level::DEBUG),
+ ]))
+ .exit(expect::span().at_level(Level::ERROR))
+ .exit(expect::span().at_level(Level::WARN))
+ .exit(expect::span().at_level(Level::INFO))
+ .exit(expect::span().at_level(Level::DEBUG))
+ .only()
+ .run_with_handle();
+ let (info_layer, info_handle) = layer::named("info")
+ .enter(expect::span().at_level(Level::INFO))
+ .enter(expect::span().at_level(Level::WARN))
+ .enter(expect::span().at_level(Level::ERROR))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().at_level(Level::ERROR),
+ expect::span().at_level(Level::WARN),
+ expect::span().at_level(Level::INFO),
+ ]))
+ .exit(expect::span().at_level(Level::ERROR))
+ .exit(expect::span().at_level(Level::WARN))
+ .exit(expect::span().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let (warn_layer, warn_handle) = layer::named("warn")
+ .enter(expect::span().at_level(Level::WARN))
+ .enter(expect::span().at_level(Level::ERROR))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().at_level(Level::ERROR),
+ expect::span().at_level(Level::WARN),
+ ]))
+ .exit(expect::span().at_level(Level::ERROR))
+ .exit(expect::span().at_level(Level::WARN))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(debug_layer.with_filter(LevelFilter::DEBUG))
+ .with(info_layer.with_filter(LevelFilter::INFO))
+ .with(warn_layer.with_filter(LevelFilter::WARN))
+ .set_default();
+
+ {
+ let _trace = tracing::trace_span!("my_span").entered();
+ let _debug = tracing::debug_span!("my_span").entered();
+ let _info = tracing::info_span!("my_span").entered();
+ let _warn = tracing::warn_span!("my_span").entered();
+ let _error = tracing::error_span!("my_span").entered();
+ tracing::error!("hello world");
+ }
+
+ debug_handle.assert_finished();
+ info_handle.assert_finished();
+ warn_handle.assert_finished();
+}
+
+#[test]
+fn filters_interleaved_span_scopes() {
+ fn target_layer(target: &'static str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(format!("target_{}", target))
+ .enter(expect::span().with_target(target))
+ .enter(expect::span().with_target(target))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().with_target(target),
+ expect::span().with_target(target),
+ ]))
+ .event(
+ event::msg("hello to my target")
+ .in_scope(vec![
+ expect::span().with_target(target),
+ expect::span().with_target(target),
+ ])
+ .with_target(target),
+ )
+ .exit(expect::span().with_target(target))
+ .exit(expect::span().with_target(target))
+ .only()
+ .run_with_handle()
+ }
+
+ let (a_layer, a_handle) = target_layer("a");
+ let (b_layer, b_handle) = target_layer("b");
+ let (all_layer, all_handle) = layer::named("all")
+ .enter(expect::span().with_target("b"))
+ .enter(expect::span().with_target("a"))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().with_target("a"),
+ expect::span().with_target("b"),
+ ]))
+ .exit(expect::span().with_target("a"))
+ .exit(expect::span().with_target("b"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(all_layer.with_filter(LevelFilter::INFO))
+ .with(a_layer.with_filter(filter::filter_fn(|meta| {
+ let target = meta.target();
+ target == "a" || target == module_path!()
+ })))
+ .with(b_layer.with_filter(filter::filter_fn(|meta| {
+ let target = meta.target();
+ target == "b" || target == module_path!()
+ })))
+ .set_default();
+
+ {
+ let _a1 = tracing::trace_span!(target: "a", "a/trace").entered();
+ let _b1 = tracing::info_span!(target: "b", "b/info").entered();
+ let _a2 = tracing::info_span!(target: "a", "a/info").entered();
+ let _b2 = tracing::trace_span!(target: "b", "b/trace").entered();
+ tracing::info!("hello world");
+ tracing::debug!(target: "a", "hello to my target");
+ tracing::debug!(target: "b", "hello to my target");
+ }
+
+ a_handle.assert_finished();
+ b_handle.assert_finished();
+ all_handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/main.rs b/crates/tracing-subscriber/tests/layer_filters/main.rs
new file mode 100644
index 0000000..80b929c
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/main.rs
@@ -0,0 +1,189 @@
+#![cfg(feature = "registry")]
+mod boxed;
+mod downcast_raw;
+mod filter_scopes;
+mod option;
+mod per_event;
+mod targets;
+mod trees;
+mod vec;
+
+use tracing::{level_filters::LevelFilter, Level};
+use tracing_mock::{event, expect, layer, subscriber};
+use tracing_subscriber::{filter, prelude::*, Layer};
+
+#[test]
+fn basic_layer_filters() {
+ let (trace_layer, trace_handle) = layer::named("trace")
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let (debug_layer, debug_handle) = layer::named("debug")
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let (info_layer, info_handle) = layer::named("info")
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(trace_layer.with_filter(LevelFilter::TRACE))
+ .with(debug_layer.with_filter(LevelFilter::DEBUG))
+ .with(info_layer.with_filter(LevelFilter::INFO))
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+
+ trace_handle.assert_finished();
+ debug_handle.assert_finished();
+ info_handle.assert_finished();
+}
+
+#[test]
+fn basic_layer_filter_spans() {
+ let (trace_layer, trace_handle) = layer::named("trace")
+ .new_span(expect::span().at_level(Level::TRACE))
+ .new_span(expect::span().at_level(Level::DEBUG))
+ .new_span(expect::span().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let (debug_layer, debug_handle) = layer::named("debug")
+ .new_span(expect::span().at_level(Level::DEBUG))
+ .new_span(expect::span().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let (info_layer, info_handle) = layer::named("info")
+ .new_span(expect::span().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(trace_layer.with_filter(LevelFilter::TRACE))
+ .with(debug_layer.with_filter(LevelFilter::DEBUG))
+ .with(info_layer.with_filter(LevelFilter::INFO))
+ .set_default();
+
+ tracing::trace_span!("hello trace");
+ tracing::debug_span!("hello debug");
+ tracing::info_span!("hello info");
+
+ trace_handle.assert_finished();
+ debug_handle.assert_finished();
+ info_handle.assert_finished();
+}
+
+#[test]
+fn global_filters_subscribers_still_work() {
+ let (expect, handle) = layer::mock()
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(expect)
+ .with(LevelFilter::INFO)
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+
+ handle.assert_finished();
+}
+
+#[test]
+fn global_filter_interests_are_cached() {
+ let (expect, handle) = layer::mock()
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(expect.with_filter(filter::filter_fn(|meta| {
+ assert!(
+ meta.level() <= &Level::INFO,
+ "enabled should not be called for callsites disabled by the global filter"
+ );
+ meta.level() <= &Level::WARN
+ })))
+ .with(LevelFilter::INFO)
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+
+ handle.assert_finished();
+}
+
+#[test]
+fn global_filters_affect_subscriber_filters() {
+ let (expect, handle) = layer::named("debug")
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(expect.with_filter(LevelFilter::DEBUG))
+ .with(LevelFilter::INFO)
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+
+ handle.assert_finished();
+}
+
+#[test]
+fn filter_fn() {
+ let (all, all_handle) = layer::named("all_targets")
+ .event(event::msg("hello foo"))
+ .event(event::msg("hello bar"))
+ .only()
+ .run_with_handle();
+
+ let (foo, foo_handle) = layer::named("foo_target")
+ .event(event::msg("hello foo"))
+ .only()
+ .run_with_handle();
+
+ let (bar, bar_handle) = layer::named("bar_target")
+ .event(event::msg("hello bar"))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(all)
+ .with(foo.with_filter(filter::filter_fn(|meta| meta.target().starts_with("foo"))))
+ .with(bar.with_filter(filter::filter_fn(|meta| meta.target().starts_with("bar"))))
+ .set_default();
+
+ tracing::trace!(target: "foo", "hello foo");
+ tracing::trace!(target: "bar", "hello bar");
+
+ foo_handle.assert_finished();
+ bar_handle.assert_finished();
+ all_handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/option.rs b/crates/tracing-subscriber/tests/layer_filters/option.rs
new file mode 100644
index 0000000..6eb4c40
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/option.rs
@@ -0,0 +1,143 @@
+use super::*;
+use tracing::Subscriber;
+use tracing_subscriber::{
+ filter::{self, LevelFilter},
+ prelude::*,
+ Layer,
+};
+
+fn filter_out_everything<S>() -> filter::DynFilterFn<S> {
+ // Use dynamic filter fn to disable interest caching and max-level hints,
+ // allowing us to put all of these tests in the same file.
+ filter::dynamic_filter_fn(|_, _| false)
+}
+
+#[test]
+fn option_some() {
+ let (layer, handle) = layer::mock().only().run_with_handle();
+ let layer = layer.with_filter(Some(filter_out_everything()));
+
+ let _guard = tracing_subscriber::registry().with(layer).set_default();
+
+ for i in 0..2 {
+ tracing::info!(i);
+ }
+
+ handle.assert_finished();
+}
+
+#[test]
+fn option_none() {
+ let (layer, handle) = layer::mock()
+ .event(expect::event())
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer = layer.with_filter(None::<filter::DynFilterFn<_>>);
+
+ let _guard = tracing_subscriber::registry().with(layer).set_default();
+
+ for i in 0..2 {
+ tracing::info!(i);
+ }
+
+ handle.assert_finished();
+}
+
+#[test]
+fn option_mixed() {
+ let (layer, handle) = layer::mock()
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer = layer
+ .with_filter(filter::dynamic_filter_fn(|meta, _ctx| {
+ meta.target() == "interesting"
+ }))
+ .with_filter(None::<filter::DynFilterFn<_>>);
+
+ let _guard = tracing_subscriber::registry().with(layer).set_default();
+
+ tracing::info!(target: "interesting", x="foo");
+ tracing::info!(target: "boring", x="bar");
+
+ handle.assert_finished();
+}
+
+/// The lack of a max level hint from a `None` filter should result in no max
+/// level hint when combined with other filters/layer.
+#[test]
+fn none_max_level_hint() {
+ let (layer_some, handle_none) = layer::mock()
+ .event(expect::event())
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let subscribe_none = layer_some.with_filter(None::<filter::DynFilterFn<_>>);
+ assert!(subscribe_none.max_level_hint().is_none());
+
+ let (layer_filter_fn, handle_filter_fn) = layer::mock()
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let max_level = Level::INFO;
+ let layer_filter_fn = layer_filter_fn.with_filter(
+ filter::dynamic_filter_fn(move |meta, _| return meta.level() <= &max_level)
+ .with_max_level_hint(max_level),
+ );
+ assert_eq!(layer_filter_fn.max_level_hint(), Some(LevelFilter::INFO));
+
+ let subscriber = tracing_subscriber::registry()
+ .with(subscribe_none)
+ .with(layer_filter_fn);
+ // The absence of a hint from the `None` filter upgrades the `INFO` hint
+ // from the filter fn layer.
+ assert!(subscriber.max_level_hint().is_none());
+
+ let _guard = subscriber.set_default();
+ tracing::info!(target: "interesting", x="foo");
+ tracing::debug!(target: "sometimes_interesting", x="bar");
+
+ handle_none.assert_finished();
+ handle_filter_fn.assert_finished();
+}
+
+/// The max level hint from inside a `Some(filter)` filter should be propagated
+/// and combined with other filters/layers.
+#[test]
+fn some_max_level_hint() {
+ let (layer_some, handle_some) = layer::mock()
+ .event(expect::event())
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer_some = layer_some.with_filter(Some(
+ filter::dynamic_filter_fn(move |meta, _| return meta.level() <= &Level::DEBUG)
+ .with_max_level_hint(Level::DEBUG),
+ ));
+ assert_eq!(layer_some.max_level_hint(), Some(LevelFilter::DEBUG));
+
+ let (layer_filter_fn, handle_filter_fn) = layer::mock()
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer_filter_fn = layer_filter_fn.with_filter(
+ filter::dynamic_filter_fn(move |meta, _| return meta.level() <= &Level::INFO)
+ .with_max_level_hint(Level::INFO),
+ );
+ assert_eq!(layer_filter_fn.max_level_hint(), Some(LevelFilter::INFO));
+
+ let subscriber = tracing_subscriber::registry()
+ .with(layer_some)
+ .with(layer_filter_fn);
+ // The `DEBUG` hint from the `Some` filter upgrades the `INFO` hint from the
+ // filter fn layer.
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::DEBUG));
+
+ let _guard = subscriber.set_default();
+ tracing::info!(target: "interesting", x="foo");
+ tracing::debug!(target: "sometimes_interesting", x="bar");
+
+ handle_some.assert_finished();
+ handle_filter_fn.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/per_event.rs b/crates/tracing-subscriber/tests/layer_filters/per_event.rs
new file mode 100644
index 0000000..897c9f2
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/per_event.rs
@@ -0,0 +1,61 @@
+use tracing::Level;
+use tracing_mock::{expect, layer};
+use tracing_subscriber::{field::Visit, layer::Filter, prelude::*};
+
+struct FilterEvent;
+
+impl<S> Filter<S> for FilterEvent {
+ fn enabled(
+ &self,
+ _meta: &tracing::Metadata<'_>,
+ _cx: &tracing_subscriber::layer::Context<'_, S>,
+ ) -> bool {
+ true
+ }
+
+ fn event_enabled(
+ &self,
+ event: &tracing::Event<'_>,
+ _cx: &tracing_subscriber::layer::Context<'_, S>,
+ ) -> bool {
+ struct ShouldEnable(bool);
+ impl Visit for ShouldEnable {
+ fn record_bool(&mut self, field: &tracing_core::Field, value: bool) {
+ if field.name() == "enable" {
+ self.0 = value;
+ }
+ }
+
+ fn record_debug(
+ &mut self,
+ _field: &tracing_core::Field,
+ _value: &dyn core::fmt::Debug,
+ ) {
+ }
+ }
+ let mut should_enable = ShouldEnable(false);
+ event.record(&mut should_enable);
+ should_enable.0
+ }
+}
+
+#[test]
+fn per_layer_event_field_filtering() {
+ let (expect, handle) = layer::mock()
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(expect.with_filter(FilterEvent))
+ .set_default();
+
+ tracing::trace!(enable = true, "hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!(enable = true, "hello info");
+ tracing::warn!(enable = false, "hello warn");
+ tracing::error!("hello error");
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/targets.rs b/crates/tracing-subscriber/tests/layer_filters/targets.rs
new file mode 100644
index 0000000..19bcff1
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/targets.rs
@@ -0,0 +1,60 @@
+use super::*;
+use tracing_mock::event;
+use tracing_subscriber::{
+ filter::{filter_fn, Targets},
+ prelude::*,
+};
+
+#[test]
+#[cfg_attr(not(feature = "tracing-log"), ignore)]
+fn log_events() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/1563
+ mod inner {
+ pub(super) const MODULE_PATH: &str = module_path!();
+
+ #[tracing::instrument]
+ pub(super) fn logs() {
+ log::debug!("inner");
+ }
+ }
+
+ let filter = Targets::new()
+ .with_default(LevelFilter::DEBUG)
+ .with_target(inner::MODULE_PATH, LevelFilter::WARN);
+
+ let layer =
+ tracing_subscriber::layer::Identity::new().with_filter(filter_fn(move |_meta| true));
+
+ let _guard = tracing_subscriber::registry()
+ .with(filter)
+ .with(layer)
+ .set_default();
+
+ inner::logs();
+}
+
+#[test]
+fn inner_layer_short_circuits() {
+ // This test ensures that when a global filter short-circuits `Interest`
+ // evaluation, we aren't left with a "dirty" per-layer filter state.
+
+ let (layer, handle) = layer::mock()
+ .event(event::msg("hello world"))
+ .only()
+ .run_with_handle();
+
+ let filter = Targets::new().with_target("magic_target", LevelFilter::DEBUG);
+
+ let _guard = tracing_subscriber::registry()
+ // Note: we don't just use a `LevelFilter` for the global filter here,
+ // because it will just return a max level filter, and the chain of
+ // `register_callsite` calls that would trigger the bug never happens...
+ .with(filter::filter_fn(|meta| meta.level() <= &Level::INFO))
+ .with(layer.with_filter(filter))
+ .set_default();
+
+ tracing::debug!("skip me please!");
+ tracing::info!(target: "magic_target", "hello world");
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/trees.rs b/crates/tracing-subscriber/tests/layer_filters/trees.rs
new file mode 100644
index 0000000..a0dbbbe
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/trees.rs
@@ -0,0 +1,158 @@
+use super::*;
+use tracing_mock::{event, expect, layer::MockLayer};
+
+#[test]
+fn basic_trees() {
+ let (with_target, with_target_handle) = layer::named("info_with_target")
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_target("my_target"),
+ )
+ .only()
+ .run_with_handle();
+
+ let (info, info_handle) = layer::named("info")
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_target(module_path!()),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_target("my_target"),
+ )
+ .only()
+ .run_with_handle();
+
+ let (all, all_handle) = layer::named("all")
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_target(module_path!()),
+ )
+ .event(expect::event().at_level(Level::TRACE))
+ .event(
+ expect::event()
+ .at_level(Level::INFO)
+ .with_target("my_target"),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::TRACE)
+ .with_target("my_target"),
+ )
+ .only()
+ .run_with_handle();
+
+ let info_tree = info
+ .and_then(
+ with_target.with_filter(filter::filter_fn(|meta| dbg!(meta.target()) == "my_target")),
+ )
+ .with_filter(LevelFilter::INFO);
+
+ let subscriber = tracing_subscriber::registry().with(info_tree).with(all);
+ let _guard = dbg!(subscriber).set_default();
+
+ tracing::info!("hello world");
+ tracing::trace!("hello trace");
+ tracing::info!(target: "my_target", "hi to my target");
+ tracing::trace!(target: "my_target", "hi to my target at trace");
+
+ all_handle.assert_finished();
+ info_handle.assert_finished();
+ with_target_handle.assert_finished();
+}
+
+#[test]
+fn filter_span_scopes() {
+ fn target_layer(target: &'static str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(format!("target_{}", target))
+ .enter(expect::span().with_target(target).at_level(Level::INFO))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().with_target(target).at_level(Level::INFO),
+ ]))
+ .exit(expect::span().with_target(target).at_level(Level::INFO))
+ .only()
+ .run_with_handle()
+ }
+
+ let (a_layer, a_handle) = target_layer("a");
+ let (b_layer, b_handle) = target_layer("b");
+ let (info_layer, info_handle) = layer::named("info")
+ .enter(expect::span().with_target("b").at_level(Level::INFO))
+ .enter(expect::span().with_target("a").at_level(Level::INFO))
+ .event(event::msg("hello world").in_scope(vec![
+ expect::span().with_target("a").at_level(Level::INFO),
+ expect::span().with_target("b").at_level(Level::INFO),
+ ]))
+ .exit(expect::span().with_target("a").at_level(Level::INFO))
+ .exit(expect::span().with_target("b").at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+
+ let full_scope = vec![
+ expect::span().with_target("b").at_level(Level::TRACE),
+ expect::span().with_target("a").at_level(Level::INFO),
+ expect::span().with_target("b").at_level(Level::INFO),
+ expect::span().with_target("a").at_level(Level::TRACE),
+ ];
+ let (all_layer, all_handle) = layer::named("all")
+ .enter(expect::span().with_target("a").at_level(Level::TRACE))
+ .enter(expect::span().with_target("b").at_level(Level::INFO))
+ .enter(expect::span().with_target("a").at_level(Level::INFO))
+ .enter(expect::span().with_target("b").at_level(Level::TRACE))
+ .event(event::msg("hello world").in_scope(full_scope.clone()))
+ .event(
+ event::msg("hello to my target")
+ .with_target("a")
+ .in_scope(full_scope.clone()),
+ )
+ .event(
+ event::msg("hello to my target")
+ .with_target("b")
+ .in_scope(full_scope),
+ )
+ .exit(expect::span().with_target("b").at_level(Level::TRACE))
+ .exit(expect::span().with_target("a").at_level(Level::INFO))
+ .exit(expect::span().with_target("b").at_level(Level::INFO))
+ .exit(expect::span().with_target("a").at_level(Level::TRACE))
+ .only()
+ .run_with_handle();
+
+ let a_layer = a_layer.with_filter(filter::filter_fn(|meta| {
+ let target = meta.target();
+ target == "a" || target == module_path!()
+ }));
+
+ let b_layer = b_layer.with_filter(filter::filter_fn(|meta| {
+ let target = meta.target();
+ target == "b" || target == module_path!()
+ }));
+
+ let info_tree = info_layer
+ .and_then(a_layer)
+ .and_then(b_layer)
+ .with_filter(LevelFilter::INFO);
+
+ let subscriber = tracing_subscriber::registry()
+ .with(info_tree)
+ .with(all_layer);
+ let _guard = dbg!(subscriber).set_default();
+
+ {
+ let _a1 = tracing::trace_span!(target: "a", "a/trace").entered();
+ let _b1 = tracing::info_span!(target: "b", "b/info").entered();
+ let _a2 = tracing::info_span!(target: "a", "a/info").entered();
+ let _b2 = tracing::trace_span!(target: "b", "b/trace").entered();
+ tracing::info!("hello world");
+ tracing::debug!(target: "a", "hello to my target");
+ tracing::debug!(target: "b", "hello to my target");
+ }
+
+ all_handle.assert_finished();
+ info_handle.assert_finished();
+ a_handle.assert_finished();
+ b_handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/layer_filters/vec.rs b/crates/tracing-subscriber/tests/layer_filters/vec.rs
new file mode 100644
index 0000000..42aa308
--- /dev/null
+++ b/crates/tracing-subscriber/tests/layer_filters/vec.rs
@@ -0,0 +1,121 @@
+use super::*;
+use tracing::Subscriber;
+use tracing_mock::{expect, layer::MockLayer};
+
+#[test]
+fn with_filters_unboxed() {
+ let (trace_layer, trace_handle) = layer::named("trace")
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let trace_layer = trace_layer.with_filter(LevelFilter::TRACE);
+
+ let (debug_layer, debug_handle) = layer::named("debug")
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let debug_layer = debug_layer.with_filter(LevelFilter::DEBUG);
+
+ let (info_layer, info_handle) = layer::named("info")
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let info_layer = info_layer.with_filter(LevelFilter::INFO);
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(vec![trace_layer, debug_layer, info_layer])
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+
+ trace_handle.assert_finished();
+ debug_handle.assert_finished();
+ info_handle.assert_finished();
+}
+
+#[test]
+fn with_filters_boxed() {
+ let (unfiltered_layer, unfiltered_handle) = layer::named("unfiltered")
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let unfiltered_layer = unfiltered_layer.boxed();
+
+ let (debug_layer, debug_handle) = layer::named("debug")
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let debug_layer = debug_layer.with_filter(LevelFilter::DEBUG).boxed();
+
+ let (target_layer, target_handle) = layer::named("target")
+ .event(expect::event().at_level(Level::INFO))
+ .only()
+ .run_with_handle();
+ let target_layer = target_layer
+ .with_filter(filter::filter_fn(|meta| meta.target() == "my_target"))
+ .boxed();
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(vec![unfiltered_layer, debug_layer, target_layer])
+ .set_default();
+
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!(target: "my_target", "hello my target");
+
+ unfiltered_handle.assert_finished();
+ debug_handle.assert_finished();
+ target_handle.assert_finished();
+}
+
+#[test]
+fn mixed_max_level_hint() {
+ let unfiltered = layer::named("unfiltered").run().boxed();
+ let info = layer::named("info")
+ .run()
+ .with_filter(LevelFilter::INFO)
+ .boxed();
+ let debug = layer::named("debug")
+ .run()
+ .with_filter(LevelFilter::DEBUG)
+ .boxed();
+
+ let subscriber = tracing_subscriber::registry().with(vec![unfiltered, info, debug]);
+
+ assert_eq!(subscriber.max_level_hint(), None);
+}
+
+#[test]
+fn all_filtered_max_level_hint() {
+ let warn = layer::named("warn")
+ .run()
+ .with_filter(LevelFilter::WARN)
+ .boxed();
+ let info = layer::named("info")
+ .run()
+ .with_filter(LevelFilter::INFO)
+ .boxed();
+ let debug = layer::named("debug")
+ .run()
+ .with_filter(LevelFilter::DEBUG)
+ .boxed();
+
+ let subscriber = tracing_subscriber::registry().with(vec![warn, info, debug]);
+
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::DEBUG));
+}
+
+#[test]
+fn empty_vec() {
+ // Just a None means everything is off
+ let subscriber = tracing_subscriber::registry().with(Vec::<MockLayer>::new());
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::OFF));
+}
diff --git a/crates/tracing-subscriber/tests/multiple_layer_filter_interests_cached.rs b/crates/tracing-subscriber/tests/multiple_layer_filter_interests_cached.rs
new file mode 100644
index 0000000..553c537
--- /dev/null
+++ b/crates/tracing-subscriber/tests/multiple_layer_filter_interests_cached.rs
@@ -0,0 +1,129 @@
+#![cfg(feature = "registry")]
+use std::{
+ collections::HashMap,
+ sync::{Arc, Mutex},
+};
+use tracing::{Level, Subscriber};
+use tracing_mock::{expect, layer};
+use tracing_subscriber::{filter, prelude::*};
+
+#[test]
+fn multiple_layer_filter_interests_are_cached() {
+ // This layer will return Interest::always for INFO and lower.
+ let seen_info = Arc::new(Mutex::new(HashMap::new()));
+ let seen_info2 = seen_info.clone();
+ let filter = filter::filter_fn(move |meta| {
+ *seen_info
+ .lock()
+ .unwrap()
+ .entry(*meta.level())
+ .or_insert(0usize) += 1;
+ meta.level() <= &Level::INFO
+ });
+ let seen_info = seen_info2;
+
+ let (info_layer, info_handle) = layer::named("info")
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let info_layer = info_layer.with_filter(filter);
+
+ // This layer will return Interest::always for WARN and lower.
+ let seen_warn = Arc::new(Mutex::new(HashMap::new()));
+ let seen_warn2 = seen_warn.clone();
+ let filter = filter::filter_fn(move |meta| {
+ *seen_warn
+ .lock()
+ .unwrap()
+ .entry(*meta.level())
+ .or_insert(0usize) += 1;
+ meta.level() <= &Level::WARN
+ });
+ let seen_warn = seen_warn2;
+
+ let (warn_layer, warn_handle) = layer::named("warn")
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let warn_layer = warn_layer.with_filter(filter);
+
+ let subscriber = tracing_subscriber::registry()
+ .with(warn_layer)
+ .with(info_layer);
+ assert!(subscriber.max_level_hint().is_none());
+
+ let _subscriber = subscriber.set_default();
+
+ fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+ }
+
+ events();
+ {
+ let lock = seen_info.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the INFO layer (after first set of events)",
+ level
+ );
+ }
+
+ let lock = seen_warn.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the WARN layer (after first set of events)",
+ level
+ );
+ }
+ }
+
+ events();
+ {
+ let lock = seen_info.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the INFO layer (after second set of events)",
+ level
+ );
+ }
+
+ let lock = seen_warn.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the WARN layer (after second set of events)",
+ level
+ );
+ }
+ }
+
+ info_handle.assert_finished();
+ warn_handle.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/option.rs b/crates/tracing-subscriber/tests/option.rs
new file mode 100644
index 0000000..c87519c
--- /dev/null
+++ b/crates/tracing-subscriber/tests/option.rs
@@ -0,0 +1,262 @@
+#![cfg(feature = "registry")]
+use tracing_core::{subscriber::Interest, LevelFilter, Metadata, Subscriber};
+use tracing_subscriber::{layer, prelude::*};
+
+// A basic layer that returns its inner for `max_level_hint`
+#[derive(Debug)]
+struct BasicLayer(Option<LevelFilter>);
+impl<S: Subscriber> tracing_subscriber::Layer<S> for BasicLayer {
+ fn register_callsite(&self, _m: &Metadata<'_>) -> Interest {
+ Interest::sometimes()
+ }
+
+ fn enabled(&self, _m: &Metadata<'_>, _: layer::Context<'_, S>) -> bool {
+ true
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ self.0
+ }
+}
+
+// This test is just used to compare to the tests below
+#[test]
+fn just_layer() {
+ let subscriber = tracing_subscriber::registry().with(LevelFilter::INFO);
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::INFO));
+}
+
+#[test]
+fn subscriber_and_option_some_layer() {
+ let subscriber = tracing_subscriber::registry()
+ .with(LevelFilter::INFO)
+ .with(Some(LevelFilter::DEBUG));
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::DEBUG));
+}
+
+#[test]
+fn subscriber_and_option_none_layer() {
+ // None means the other layer takes control
+ let subscriber = tracing_subscriber::registry()
+ .with(LevelFilter::ERROR)
+ .with(None::<LevelFilter>);
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::ERROR));
+}
+
+#[test]
+fn just_option_some_layer() {
+ // Just a None means everything is off
+ let subscriber = tracing_subscriber::registry().with(None::<LevelFilter>);
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::OFF));
+}
+
+/// Tests that the logic tested in `doesnt_override_none` works through the reload subscriber
+#[test]
+fn just_option_none_layer() {
+ let subscriber = tracing_subscriber::registry().with(Some(LevelFilter::ERROR));
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::ERROR));
+}
+
+// Test that the `None` max level hint only applies if its the only layer
+#[test]
+fn none_outside_doesnt_override_max_level() {
+ // None means the other layer takes control
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(None))
+ .with(None::<LevelFilter>);
+ assert_eq!(
+ subscriber.max_level_hint(),
+ None,
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The `None`-returning layer still wins
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(None))
+ .with(Some(LevelFilter::ERROR));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::ERROR),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Check that we aren't doing anything truly wrong
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(Some(LevelFilter::DEBUG)))
+ .with(None::<LevelFilter>);
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Test that per-subscriber filters aren't affected
+
+ // One layer is None so it "wins"
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(None))
+ .with(None::<LevelFilter>.with_filter(LevelFilter::DEBUG));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ None,
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The max-levels wins
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(Some(LevelFilter::INFO)))
+ .with(None::<LevelFilter>.with_filter(LevelFilter::DEBUG));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Test filter on the other layer
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(Some(LevelFilter::INFO)).with_filter(LevelFilter::DEBUG))
+ .with(None::<LevelFilter>);
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(None).with_filter(LevelFilter::DEBUG))
+ .with(None::<LevelFilter>);
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The `OFF` from `None` over overridden.
+ let subscriber = tracing_subscriber::registry()
+ .with(BasicLayer(Some(LevelFilter::INFO)))
+ .with(None::<LevelFilter>);
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::INFO),
+ "\n stack: {:#?}",
+ subscriber
+ );
+}
+
+// Test that the `None` max level hint only applies if its the only layer
+#[test]
+fn none_inside_doesnt_override_max_level() {
+ // None means the other layer takes control
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>)
+ .with(BasicLayer(None));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ None,
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The `None`-returning layer still wins
+ let subscriber = tracing_subscriber::registry()
+ .with(Some(LevelFilter::ERROR))
+ .with(BasicLayer(None));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::ERROR),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Check that we aren't doing anything truly wrong
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>)
+ .with(BasicLayer(Some(LevelFilter::DEBUG)));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Test that per-subscriber filters aren't affected
+
+ // One layer is None so it "wins"
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>.with_filter(LevelFilter::DEBUG))
+ .with(BasicLayer(None));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ None,
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The max-levels wins
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>.with_filter(LevelFilter::DEBUG))
+ .with(BasicLayer(Some(LevelFilter::INFO)));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // Test filter on the other layer
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>)
+ .with(BasicLayer(Some(LevelFilter::INFO)).with_filter(LevelFilter::DEBUG));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>)
+ .with(BasicLayer(None).with_filter(LevelFilter::DEBUG));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::DEBUG),
+ "\n stack: {:#?}",
+ subscriber
+ );
+
+ // The `OFF` from `None` over overridden.
+ let subscriber = tracing_subscriber::registry()
+ .with(None::<LevelFilter>)
+ .with(BasicLayer(Some(LevelFilter::INFO)));
+ assert_eq!(
+ subscriber.max_level_hint(),
+ Some(LevelFilter::INFO),
+ "\n stack: {:#?}",
+ subscriber
+ );
+}
+
+/// Tests that the logic tested in `doesnt_override_none` works through the reload layer
+#[test]
+fn reload_works_with_none() {
+ let (layer1, handle1) = tracing_subscriber::reload::Layer::new(None::<BasicLayer>);
+ let (layer2, _handle2) = tracing_subscriber::reload::Layer::new(None::<BasicLayer>);
+
+ let subscriber = tracing_subscriber::registry().with(layer1).with(layer2);
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::OFF));
+
+ // reloading one should pass through correctly.
+ handle1.reload(Some(BasicLayer(None))).unwrap();
+ assert_eq!(subscriber.max_level_hint(), None);
+
+ // Check pass-through of an actual level as well
+ handle1
+ .reload(Some(BasicLayer(Some(LevelFilter::DEBUG))))
+ .unwrap();
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::DEBUG));
+}
diff --git a/crates/tracing-subscriber/tests/option_filter_interest_caching.rs b/crates/tracing-subscriber/tests/option_filter_interest_caching.rs
new file mode 100644
index 0000000..609007c
--- /dev/null
+++ b/crates/tracing-subscriber/tests/option_filter_interest_caching.rs
@@ -0,0 +1,53 @@
+// A separate test crate for `Option<Filter>` for isolation from other tests
+// that may influence the interest cache.
+
+use std::sync::{
+ atomic::{AtomicUsize, Ordering},
+ Arc,
+};
+use tracing_mock::{expect, layer};
+use tracing_subscriber::{filter, prelude::*, Layer};
+
+/// A `None` filter should always be interested in events, and it should not
+/// needlessly degrade the caching of other filters.
+#[test]
+fn none_interest_cache() {
+ let (layer_none, handle_none) = layer::mock()
+ .event(expect::event())
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer_none = layer_none.with_filter(None::<filter::DynFilterFn<_>>);
+
+ let times_filtered = Arc::new(AtomicUsize::new(0));
+ let (layer_filter_fn, handle_filter_fn) = layer::mock()
+ .event(expect::event())
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+ let layer_filter_fn = layer_filter_fn.with_filter(filter::filter_fn({
+ let times_filtered = Arc::clone(×_filtered);
+ move |_| {
+ times_filtered.fetch_add(1, Ordering::Relaxed);
+ true
+ }
+ }));
+
+ let subscriber = tracing_subscriber::registry()
+ .with(layer_none)
+ .with(layer_filter_fn);
+
+ let _guard = subscriber.set_default();
+ for _ in 0..2 {
+ tracing::debug!(target: "always_interesting", x="bar");
+ }
+
+ // The `None` filter is unchanging and performs no filtering, so it should
+ // be cacheable and always be interested in events. The filter fn is a
+ // non-dynamic filter fn, which means the result can be cached per callsite.
+ // The filter fn should only need to be called once, and the `Option` filter
+ // should not interfere in the caching of that result.
+ assert_eq!(times_filtered.load(Ordering::Relaxed), 1);
+ handle_none.assert_finished();
+ handle_filter_fn.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/registry_max_level_hint.rs b/crates/tracing-subscriber/tests/registry_max_level_hint.rs
new file mode 100644
index 0000000..f94c8a1
--- /dev/null
+++ b/crates/tracing-subscriber/tests/registry_max_level_hint.rs
@@ -0,0 +1,11 @@
+#![cfg(all(feature = "registry", feature = "fmt"))]
+use tracing_subscriber::{filter::LevelFilter, prelude::*};
+
+#[test]
+fn registry_sets_max_level_hint() {
+ tracing_subscriber::registry()
+ .with(tracing_subscriber::fmt::layer())
+ .with(LevelFilter::DEBUG)
+ .init();
+ assert_eq!(LevelFilter::current(), LevelFilter::DEBUG);
+}
diff --git a/crates/tracing-subscriber/tests/registry_with_subscriber.rs b/crates/tracing-subscriber/tests/registry_with_subscriber.rs
new file mode 100644
index 0000000..50d2f55
--- /dev/null
+++ b/crates/tracing-subscriber/tests/registry_with_subscriber.rs
@@ -0,0 +1,25 @@
+#![cfg(feature = "registry")]
+use tracing_futures::{Instrument, WithSubscriber};
+use tracing_subscriber::prelude::*;
+
+#[tokio::test]
+async fn future_with_subscriber() {
+ tracing_subscriber::registry().init();
+ let span = tracing::info_span!("foo");
+ let _e = span.enter();
+ let span = tracing::info_span!("bar");
+ let _e = span.enter();
+ tokio::spawn(
+ async {
+ async {
+ let span = tracing::Span::current();
+ println!("{:?}", span);
+ }
+ .instrument(tracing::info_span!("hi"))
+ .await
+ }
+ .with_subscriber(tracing_subscriber::registry()),
+ )
+ .await
+ .unwrap();
+}
diff --git a/crates/tracing-subscriber/tests/reload.rs b/crates/tracing-subscriber/tests/reload.rs
new file mode 100644
index 0000000..28662e2
--- /dev/null
+++ b/crates/tracing-subscriber/tests/reload.rs
@@ -0,0 +1,155 @@
+#![cfg(feature = "registry")]
+use std::sync::atomic::{AtomicUsize, Ordering};
+use tracing_core::{
+ span::{Attributes, Id, Record},
+ subscriber::Interest,
+ Event, LevelFilter, Metadata, Subscriber,
+};
+use tracing_subscriber::{layer, prelude::*, reload::*};
+
+pub struct NopSubscriber;
+fn event() {
+ tracing::info!("my event");
+}
+
+impl Subscriber for NopSubscriber {
+ fn register_callsite(&self, _: &'static Metadata<'static>) -> Interest {
+ Interest::never()
+ }
+
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ false
+ }
+
+ fn new_span(&self, _: &Attributes<'_>) -> Id {
+ Id::from_u64(1)
+ }
+
+ fn record(&self, _: &Id, _: &Record<'_>) {}
+ fn record_follows_from(&self, _: &Id, _: &Id) {}
+ fn event(&self, _: &Event<'_>) {}
+ fn enter(&self, _: &Id) {}
+ fn exit(&self, _: &Id) {}
+}
+
+#[test]
+fn reload_handle() {
+ static FILTER1_CALLS: AtomicUsize = AtomicUsize::new(0);
+ static FILTER2_CALLS: AtomicUsize = AtomicUsize::new(0);
+
+ enum Filter {
+ One,
+ Two,
+ }
+
+ impl<S: Subscriber> tracing_subscriber::Layer<S> for Filter {
+ fn register_callsite(&self, m: &Metadata<'_>) -> Interest {
+ println!("REGISTER: {:?}", m);
+ Interest::sometimes()
+ }
+
+ fn enabled(&self, m: &Metadata<'_>, _: layer::Context<'_, S>) -> bool {
+ println!("ENABLED: {:?}", m);
+ match self {
+ Filter::One => FILTER1_CALLS.fetch_add(1, Ordering::SeqCst),
+ Filter::Two => FILTER2_CALLS.fetch_add(1, Ordering::SeqCst),
+ };
+ true
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ match self {
+ Filter::One => Some(LevelFilter::INFO),
+ Filter::Two => Some(LevelFilter::DEBUG),
+ }
+ }
+ }
+
+ let (layer, handle) = Layer::new(Filter::One);
+
+ let subscriber = tracing_core::dispatcher::Dispatch::new(layer.with_subscriber(NopSubscriber));
+
+ tracing_core::dispatcher::with_default(&subscriber, || {
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 0);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 0);
+
+ event();
+
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 1);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 0);
+
+ assert_eq!(LevelFilter::current(), LevelFilter::INFO);
+ handle.reload(Filter::Two).expect("should reload");
+ assert_eq!(LevelFilter::current(), LevelFilter::DEBUG);
+
+ event();
+
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 1);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 1);
+ })
+}
+
+#[test]
+fn reload_filter() {
+ struct NopLayer;
+ impl<S: Subscriber> tracing_subscriber::Layer<S> for NopLayer {
+ fn register_callsite(&self, _m: &Metadata<'_>) -> Interest {
+ Interest::sometimes()
+ }
+
+ fn enabled(&self, _m: &Metadata<'_>, _: layer::Context<'_, S>) -> bool {
+ true
+ }
+ }
+
+ static FILTER1_CALLS: AtomicUsize = AtomicUsize::new(0);
+ static FILTER2_CALLS: AtomicUsize = AtomicUsize::new(0);
+
+ enum Filter {
+ One,
+ Two,
+ }
+
+ impl<S: Subscriber> tracing_subscriber::layer::Filter<S> for Filter {
+ fn enabled(&self, m: &Metadata<'_>, _: &layer::Context<'_, S>) -> bool {
+ println!("ENABLED: {:?}", m);
+ match self {
+ Filter::One => FILTER1_CALLS.fetch_add(1, Ordering::SeqCst),
+ Filter::Two => FILTER2_CALLS.fetch_add(1, Ordering::SeqCst),
+ };
+ true
+ }
+
+ fn max_level_hint(&self) -> Option<LevelFilter> {
+ match self {
+ Filter::One => Some(LevelFilter::INFO),
+ Filter::Two => Some(LevelFilter::DEBUG),
+ }
+ }
+ }
+
+ let (filter, handle) = Layer::new(Filter::One);
+
+ let dispatcher = tracing_core::Dispatch::new(
+ tracing_subscriber::registry().with(NopLayer.with_filter(filter)),
+ );
+
+ tracing_core::dispatcher::with_default(&dispatcher, || {
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 0);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 0);
+
+ event();
+
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 1);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 0);
+
+ assert_eq!(LevelFilter::current(), LevelFilter::INFO);
+ handle.reload(Filter::Two).expect("should reload");
+ assert_eq!(LevelFilter::current(), LevelFilter::DEBUG);
+
+ event();
+
+ assert_eq!(FILTER1_CALLS.load(Ordering::SeqCst), 1);
+ assert_eq!(FILTER2_CALLS.load(Ordering::SeqCst), 1);
+ })
+}
diff --git a/crates/tracing-subscriber/tests/same_len_filters.rs b/crates/tracing-subscriber/tests/same_len_filters.rs
new file mode 100644
index 0000000..ac0b908
--- /dev/null
+++ b/crates/tracing-subscriber/tests/same_len_filters.rs
@@ -0,0 +1,81 @@
+// These tests include field filters with no targets, so they have to go in a
+// separate file.
+#![cfg(feature = "env-filter")]
+
+use tracing::{self, subscriber::with_default, Level};
+use tracing_mock::*;
+use tracing_subscriber::{filter::EnvFilter, prelude::*};
+
+#[test]
+fn same_length_targets() {
+ let filter: EnvFilter = "foo=trace,bar=trace".parse().expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::TRACE))
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+
+ with_default(subscriber, || {
+ tracing::trace!(target: "foo", "foo");
+ tracing::trace!(target: "bar", "bar");
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn same_num_fields_event() {
+ let filter: EnvFilter = "[{foo}]=trace,[{bar}]=trace"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .event(
+ expect::event()
+ .at_level(Level::TRACE)
+ .with_fields(expect::field("foo")),
+ )
+ .event(
+ expect::event()
+ .at_level(Level::TRACE)
+ .with_fields(expect::field("bar")),
+ )
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+ with_default(subscriber, || {
+ tracing::trace!(foo = 1);
+ tracing::trace!(bar = 3);
+ });
+
+ finished.assert_finished();
+}
+
+#[test]
+fn same_num_fields_and_name_len() {
+ let filter: EnvFilter = "[foo{bar=1}]=trace,[baz{boz=1}]=trace"
+ .parse()
+ .expect("filter should parse");
+ let (subscriber, finished) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("bar")),
+ )
+ .new_span(
+ expect::span()
+ .named("baz")
+ .at_level(Level::TRACE)
+ .with_field(expect::field("boz")),
+ )
+ .only()
+ .run_with_handle();
+ let subscriber = subscriber.with(filter);
+ with_default(subscriber, || {
+ tracing::trace_span!("foo", bar = 1);
+ tracing::trace_span!("baz", boz = 1);
+ });
+
+ finished.assert_finished();
+}
diff --git a/crates/tracing-subscriber/tests/unhinted_layer_filters_dont_break_other_layers.rs b/crates/tracing-subscriber/tests/unhinted_layer_filters_dont_break_other_layers.rs
new file mode 100644
index 0000000..a0f3b51
--- /dev/null
+++ b/crates/tracing-subscriber/tests/unhinted_layer_filters_dont_break_other_layers.rs
@@ -0,0 +1,126 @@
+#![cfg(feature = "registry")]
+use tracing::Level;
+use tracing_mock::{
+ expect,
+ layer::{self, MockLayer},
+ subscriber,
+};
+use tracing_subscriber::{filter::DynFilterFn, prelude::*};
+
+#[test]
+fn layer_filters() {
+ let (unfiltered, unfiltered_handle) = unfiltered("unfiltered");
+ let (filtered, filtered_handle) = filtered("filtered");
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered.with_filter(filter()))
+ .set_default();
+
+ events();
+
+ unfiltered_handle.assert_finished();
+ filtered_handle.assert_finished();
+}
+
+#[test]
+fn layered_layer_filters() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let unfiltered = unfiltered1.and_then(unfiltered2);
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+ let filtered = filtered1
+ .with_filter(filter())
+ .and_then(filtered2.with_filter(filter()));
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered)
+ .with(filtered)
+ .set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn out_of_order() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(unfiltered1)
+ .with(filtered1.with_filter(filter()))
+ .with(unfiltered2)
+ .with(filtered2.with_filter(filter()))
+ .set_default();
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+#[test]
+fn mixed_layered() {
+ let (unfiltered1, unfiltered1_handle) = unfiltered("unfiltered_1");
+ let (unfiltered2, unfiltered2_handle) = unfiltered("unfiltered_2");
+ let (filtered1, filtered1_handle) = filtered("filtered_1");
+ let (filtered2, filtered2_handle) = filtered("filtered_2");
+
+ let layered1 = filtered1.with_filter(filter()).and_then(unfiltered1);
+ let layered2 = unfiltered2.and_then(filtered2.with_filter(filter()));
+
+ let _subscriber = tracing_subscriber::registry()
+ .with(layered1)
+ .with(layered2)
+ .set_default();
+
+ events();
+
+ unfiltered1_handle.assert_finished();
+ unfiltered2_handle.assert_finished();
+ filtered1_handle.assert_finished();
+ filtered2_handle.assert_finished();
+}
+
+fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+}
+
+fn filter<S>() -> DynFilterFn<S> {
+ DynFilterFn::new(|metadata, _| metadata.level() <= &Level::INFO)
+}
+
+fn unfiltered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::TRACE))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
+
+fn filtered(name: &str) -> (MockLayer, subscriber::MockHandle) {
+ layer::named(name)
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle()
+}
diff --git a/crates/tracing-subscriber/tests/utils.rs b/crates/tracing-subscriber/tests/utils.rs
new file mode 100644
index 0000000..9a8eb30
--- /dev/null
+++ b/crates/tracing-subscriber/tests/utils.rs
@@ -0,0 +1,39 @@
+#![cfg(feature = "std")]
+
+use tracing_mock::*;
+use tracing_subscriber::prelude::*;
+
+#[test]
+fn init_ext_works() {
+ let (subscriber, finished) = subscriber::mock()
+ .event(
+ expect::event()
+ .at_level(tracing::Level::INFO)
+ .with_target("init_works"),
+ )
+ .only()
+ .run_with_handle();
+
+ let _guard = subscriber.set_default();
+ tracing::info!(target: "init_works", "it worked!");
+ finished.assert_finished();
+}
+
+#[test]
+#[cfg(feature = "fmt")]
+fn builders_are_init_ext() {
+ tracing_subscriber::fmt().set_default();
+ let _ = tracing_subscriber::fmt()
+ .with_target(false)
+ .compact()
+ .try_init();
+}
+
+#[test]
+#[cfg(all(feature = "fmt", feature = "env-filter"))]
+fn layered_is_init_ext() {
+ tracing_subscriber::registry()
+ .with(tracing_subscriber::fmt::layer())
+ .with(tracing_subscriber::EnvFilter::new("foo=info"))
+ .set_default();
+}
diff --git a/crates/tracing-subscriber/tests/vec.rs b/crates/tracing-subscriber/tests/vec.rs
new file mode 100644
index 0000000..92abf0b
--- /dev/null
+++ b/crates/tracing-subscriber/tests/vec.rs
@@ -0,0 +1,19 @@
+#![cfg(feature = "registry")]
+use tracing::level_filters::LevelFilter;
+use tracing::Subscriber;
+use tracing_subscriber::prelude::*;
+
+#[test]
+fn just_empty_vec() {
+ // Just a None means everything is off
+ let subscriber = tracing_subscriber::registry().with(Vec::<LevelFilter>::new());
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::OFF));
+}
+
+#[test]
+fn layer_and_empty_vec() {
+ let subscriber = tracing_subscriber::registry()
+ .with(LevelFilter::INFO)
+ .with(Vec::<LevelFilter>::new());
+ assert_eq!(subscriber.max_level_hint(), Some(LevelFilter::INFO));
+}
diff --git a/crates/tracing-subscriber/tests/vec_subscriber_filter_interests_cached.rs b/crates/tracing-subscriber/tests/vec_subscriber_filter_interests_cached.rs
new file mode 100644
index 0000000..e80cfa0
--- /dev/null
+++ b/crates/tracing-subscriber/tests/vec_subscriber_filter_interests_cached.rs
@@ -0,0 +1,115 @@
+#![cfg(feature = "registry")]
+use std::{
+ collections::HashMap,
+ sync::{Arc, Mutex},
+};
+use tracing::{Level, Subscriber};
+use tracing_mock::{layer::MockLayer, *};
+use tracing_subscriber::{filter, prelude::*};
+
+#[test]
+fn vec_layer_filter_interests_are_cached() {
+ let mk_filtered = |level: Level, subscriber: MockLayer| {
+ let seen = Arc::new(Mutex::new(HashMap::new()));
+ let filter = filter::filter_fn({
+ let seen = seen.clone();
+ move |meta| {
+ *seen.lock().unwrap().entry(*meta.level()).or_insert(0usize) += 1;
+ meta.level() <= &level
+ }
+ });
+ (subscriber.with_filter(filter).boxed(), seen)
+ };
+
+ // This layer will return Interest::always for INFO and lower.
+ let (info_layer, info_handle) = layer::named("info")
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let (info_layer, seen_info) = mk_filtered(Level::INFO, info_layer);
+
+ // This layer will return Interest::always for WARN and lower.
+ let (warn_layer, warn_handle) = layer::named("warn")
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let (warn_layer, seen_warn) = mk_filtered(Level::WARN, warn_layer);
+
+ let subscriber = tracing_subscriber::registry().with(vec![warn_layer, info_layer]);
+ assert!(subscriber.max_level_hint().is_none());
+
+ let _subscriber = subscriber.set_default();
+
+ fn events() {
+ tracing::trace!("hello trace");
+ tracing::debug!("hello debug");
+ tracing::info!("hello info");
+ tracing::warn!("hello warn");
+ tracing::error!("hello error");
+ }
+
+ events();
+ {
+ let lock = seen_info.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the INFO subscriber (after first set of events)",
+ level
+ );
+ }
+
+ let lock = seen_warn.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the WARN subscriber (after first set of events)",
+ level
+ );
+ }
+ }
+
+ events();
+ {
+ let lock = seen_info.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the INFO subscriber (after second set of events)",
+ level
+ );
+ }
+
+ let lock = seen_warn.lock().unwrap();
+ for (&level, &count) in lock.iter() {
+ if level == Level::INFO {
+ continue;
+ }
+ assert_eq!(
+ count, 1,
+ "level {:?} should have been seen 1 time by the WARN subscriber (after second set of events)",
+ level
+ );
+ }
+ }
+
+ info_handle.assert_finished();
+ warn_handle.assert_finished();
+}
diff --git a/crates/tracing/.cargo-checksum.json b/crates/tracing/.cargo-checksum.json
new file mode 100644
index 0000000..92c7ecf
--- /dev/null
+++ b/crates/tracing/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"8f2a5e3f70b90ef91e724b0089f511f6ce95cc6afaf1da30d3d486e30935c520","Cargo.toml":"e8262bfd368f8b9c2f902db368a71da88f446584167392a2611b8eb08e411175","LICENSE":"898b1ae9821e98daf8964c8d6c7f61641f5f5aa78ad500020771c0939ee0dea1","README.md":"baed1881843d68618241ccc57e2120993f6eb67c0e1987115b6855f7d328def3","benches/baseline.rs":"43a3e31b6c33dba2e6328052301b707b212487b83f0dcffc843061a9c48a2319","benches/dispatch_get_clone.rs":"866239abeb74a82440741c948a4e7e0a44e92e8cc87319ec57e3b057c9e8f5dd","benches/dispatch_get_ref.rs":"dd2803259a6784c256304e676bbce05de233e4c8451ac85863787213343e9be7","benches/empty_span.rs":"9f51cf376414ea751b2f50c357f2435a545d606118286f5b8b89f185e28aad8c","benches/enter_span.rs":"4410ec73d277e7b54e9f306c00ff3b79a150d1832966b7fc29984c8e3ad8d57c","benches/event.rs":"98de3c82ed18abe0a3cbe6eda9a4f9deec2b69bca42c3aac11dea4b608b85a67","benches/shared.rs":"2623311af7d153685064e664a5903d03e7dc3179754c324f3a76f29f060515e6","benches/span_fields.rs":"9166cd43ef2783e5419dd61ea57a02e48e8cc38aa1b357e9b79fa581929b60d8","benches/span_no_fields.rs":"79cc4befacf27d7ce728246087c4f06a6066f913e831d9043caeb7941f0193f6","benches/span_repeated.rs":"e4b3c99a7a9fc15d9042b8db399a56cf647b4eebd26f29d95325bb057b68330b","src/dispatcher.rs":"a8732392ffe56b1178f8fd3d6e6e02d40b51475c38bb4600abd9cd170df1bf6c","src/field.rs":"fe6c2eb36f92880254a707a465f873ca84510d93f06614b9b36ba20b48bf209d","src/instrument.rs":"034b1c7e46ab2fae331ea215a3d1b1a2211ef6b18d7e7113523e3ef5bf3ca9bb","src/level_filters.rs":"92aca5797a59b2f3c34adfb896260400c2602456eec0fe9c7d49204df37ff699","src/lib.rs":"54a1168ed65d746ce1cc6668a78931131af2afc7e0530391dcffcaa58a9f7971","src/macros.rs":"6ffcbea4b4b402b46e9e074f0808fb755b59ce2bb1c97aa4acdfdb31bb26bf4c","src/span.rs":"4efa37a8fc7604fcc3547eac488122c13bcb28e136f46381082480e0036217a0","src/stdlib.rs":"248514a9bae6106e436358aee44c92abf8e7f79022895c4a25136ddef211d198","src/subscriber.rs":"8933d8766439f929c0a98a0863d20aff37b221314b3825edd9058be511149968","tests/enabled.rs":"a80fd3c70be439b0d1d2509b46a2b9ca31748aab4341f67d0fa721f32c6a65a1","tests/event.rs":"d3c6d688fc1938516770a9fb486252bbe8e95f24b37097a2291e7119b6e78373","tests/filter_caching_is_lexically_scoped.rs":"5487a37db5fbdf3d57020ab1f01185d928c45d967d99d723ffc434540459d8dc","tests/filters_are_not_reevaluated_for_the_same_span.rs":"251abbc000dddd298448958a1f0e5be71da527ac6c1a368d57837c83a5467329","tests/filters_are_reevaluated_for_different_call_sites.rs":"e0fdd8e930c043674702831b4d96f331e63aba824576bbac50b3f53bb0241cc7","tests/filters_dont_leak.rs":"6c41d3209cf2a37a1656a8314399777022ceec556e44f5417f1f5a4cd24eb43a","tests/future_send.rs":"3e9c9193219d12e342c18bbedb2f6ec940334202feb3cffba91601d6001b8575","tests/instrument.rs":"e46cf30db3ff0174e4e0885720b97531c56cbe7d05bb4580e38790f272856b56","tests/macro_imports.rs":"d5de857162185d4a2384f3cb644bfcf76c7f5c1a3b5f72bfa0d2620ac6e3873c","tests/macros.rs":"acb6987a37be2035cde28c8a6b3cecbdbffffafebe6c007712cd145afbd1beb8","tests/macros_incompatible_concat.rs":"5f3bcbb65e4ae39db1cfc2def62fc913c20bab0fb769c8f731504e2615585ee5","tests/max_level_hint.rs":"39576a958df3ea215c49154ff72c3dd14c8b3be3fcdb849e7dd847c8c9fd09e2","tests/multiple_max_level_hints.rs":"28ead97a8424358a0632547dae987ddbddc5bb69cdcd996d20feb49a7f3ddc69","tests/no_subscriber.rs":"ca42d0d4a20eb3b4e0a342b5e0090c7ada8b5a157f3cddb7b5d051238cdc1202","tests/register_callsite_deadlock.rs":"c0b3142543e7a10065c7583a8ee0b6bc978ea4f3979599651101c5a28966e7c8","tests/scoped_clobbers_default.rs":"5fd48ff207df64b0e2ee443de75da0d8bd3b0817c6d9b003b0b00157ec244d7b","tests/span.rs":"2a5a8c666c8a2b51a1a1222e6046a1067690f039d15ef8b56d0e83bffa76f78d","tests/subscriber.rs":"ed3c02e8a75c6e4fc187a024fde6319e6d1ea95c993eda3fd9d559fd41fe7cce"},"package":"c3523ab5a71916ccf420eebdf5521fcef02141234bbc0b8a49f2fdc4544364ef"}
\ No newline at end of file
diff --git a/crates/tracing/Android.bp b/crates/tracing/Android.bp
new file mode 100644
index 0000000..3e4c007
--- /dev/null
+++ b/crates/tracing/Android.bp
@@ -0,0 +1,65 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tracing_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tracing_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtracing",
+ host_supported: true,
+ crate_name: "tracing",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.40",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "attributes",
+ "default",
+ "std",
+ "tracing-attributes",
+ ],
+ rustlibs: [
+ "libpin_project_lite",
+ "libtracing_core",
+ ],
+ proc_macros: ["libtracing_attributes"],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_library {
+ name: "libtracing_max_level_off",
+ host_supported: true,
+ crate_name: "tracing",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.40",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "max_level_off",
+ "release_max_level_off",
+ ],
+ rustlibs: [
+ "libpin_project_lite",
+ "libtracing_core",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tracing/CHANGELOG.md b/crates/tracing/CHANGELOG.md
new file mode 100644
index 0000000..db1668b
--- /dev/null
+++ b/crates/tracing/CHANGELOG.md
@@ -0,0 +1,941 @@
+# 0.1.40
+
+This release fixes a potential stack use-after-free in the
+`Instrument::into_inner` method. Only uses of this method are affected by this
+bug.
+
+### Fixed
+
+- Use `mem::ManuallyDrop` instead of `mem::forget` in `Instrument::into_inner`
+ ([#2765])
+
+[#2765]: https://github.com/tokio-rs/tracing/pull/2765
+
+Thanks to @cramertj and @manishearth for finding and fixing this issue!
+
+# 0.1.39 (October 12, 2023)
+
+This release adds several additional features to the `tracing` macros. In
+addition, it updates the `tracing-core` dependency to [v0.1.32][core-0.1.32] and
+the `tracing-attributes` dependency to [v0.1.27][attrs-0.1.27].
+
+### Added
+
+- Allow constant field names in macros ([#2617])
+- Allow setting event names in macros ([#2699])
+- **core**: Allow `ValueSet`s of any length ([#2508])
+
+### Changed
+
+- `tracing-attributes`: updated to [0.1.27][attrs-0.1.27]
+- `tracing-core`: updated to [0.1.32][core-0.1.32]
+- **attributes**: Bump minimum version of proc-macro2 to 1.0.60 ([#2732])
+- **attributes**: Generate less dead code for async block return type hint ([#2709])
+
+### Fixed
+
+- Use fully qualified names in macros for items exported from std prelude
+ ([#2621], [#2757])
+- **attributes**: Allow [`clippy::let_with_type_underscore`] in macro-generated
+ code ([#2609])
+- **attributes**: Allow `unknown_lints` in macro-generated code ([#2626])
+- **attributes**: Fix a compilation error in `#[instrument]` when the `"log"`
+ feature is enabled ([#2599])
+
+### Documented
+
+- Add `axum-insights` to relevant crates. ([#2713])
+- Fix link to RAI pattern crate documentation ([#2612])
+- Fix docs typos and warnings ([#2581])
+- Add `clippy-tracing` to related crates ([#2628])
+- Add `tracing-cloudwatch` to related crates ([#2667])
+- Fix deadlink to `tracing-etw` repo ([#2602])
+
+[#2617]: https://github.com/tokio-rs/tracing/pull/2617
+[#2699]: https://github.com/tokio-rs/tracing/pull/2699
+[#2508]: https://github.com/tokio-rs/tracing/pull/2508
+[#2621]: https://github.com/tokio-rs/tracing/pull/2621
+[#2713]: https://github.com/tokio-rs/tracing/pull/2713
+[#2581]: https://github.com/tokio-rs/tracing/pull/2581
+[#2628]: https://github.com/tokio-rs/tracing/pull/2628
+[#2667]: https://github.com/tokio-rs/tracing/pull/2667
+[#2602]: https://github.com/tokio-rs/tracing/pull/2602
+[#2626]: https://github.com/tokio-rs/tracing/pull/2626
+[#2757]: https://github.com/tokio-rs/tracing/pull/2757
+[#2732]: https://github.com/tokio-rs/tracing/pull/2732
+[#2709]: https://github.com/tokio-rs/tracing/pull/2709
+[#2599]: https://github.com/tokio-rs/tracing/pull/2599
+[`let_with_type_underscore`]: http://rust-lang.github.io/rust-clippy/rust-1.70.0/index.html#let_with_type_underscore
+[attrs-0.1.27]:
+ https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.27
+[core-0.1.32]:
+ https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.32
+
+# 0.1.38 (April 25th, 2023)
+
+This `tracing` release changes the `Drop` implementation for `Instrumented`
+`Future`s so that the attached `Span` is entered when dropping the `Future`. This
+means that events emitted by the `Future`'s `Drop` implementation will now be
+recorded within its `Span`. It also adds `#[inline]` hints to methods called in
+the `event!` macro's expansion, for an improvement in both binary size and
+performance.
+
+Additionally, this release updates the `tracing-attributes` dependency to
+[v0.1.24][attrs-0.1.24], which updates the [`syn`] dependency to v2.x.x.
+`tracing-attributes` v0.1.24 also includes improvements to the `#[instrument]`
+macro; see [the `tracing-attributes` 0.1.24 release notes][attrs-0.1.24] for
+details.
+
+### Added
+
+- `Instrumented` futures will now enter the attached `Span` in their `Drop`
+ implementation, allowing events emitted when dropping the future to occur
+ within the span ([#2562])
+- `#[inline]` attributes for methods called by the `event!` macros, making
+ generated code smaller ([#2555])
+- **attributes**: `level` argument to `#[instrument(err)]` and
+ `#[instrument(ret)]` to override the level of
+ the generated return value event ([#2335])
+- **attributes**: Improved compiler error message when `#[instrument]` is added to a `const fn`
+ ([#2418])
+
+### Changed
+
+- `tracing-attributes`: updated to [0.1.24][attrs-0.1.24]
+- Removed unneeded `cfg-if` dependency ([#2553])
+- **attributes**: Updated [`syn`] dependency to 2.0 ([#2516])
+
+### Fixed
+
+- **attributes**: Fix `clippy::unreachable` warnings in `#[instrument]`-generated code ([#2356])
+- **attributes**: Removed unused "visit" feature flag from `syn` dependency ([#2530])
+
+### Documented
+
+- **attributes**: Documented default level for `#[instrument(err)]` ([#2433])
+- **attributes**: Improved documentation for levels in `#[instrument]` ([#2350])
+
+Thanks to @nitnelave, @jsgf, @Abhicodes-crypto, @LukeMathWalker, @andrewpollack,
+@quad, @klensy, @davidpdrsn, @dbidwell94, @ldm0, @NobodyXu, @ilsv, and @daxpedda
+for contributing to this release!
+
+[`syn`]: https://crates.io/crates/syn
+[attrs-0.1.24]:
+ https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.24
+[#2565]: https://github.com/tokio-rs/tracing/pull/2565
+[#2555]: https://github.com/tokio-rs/tracing/pull/2555
+[#2553]: https://github.com/tokio-rs/tracing/pull/2553
+[#2335]: https://github.com/tokio-rs/tracing/pull/2335
+[#2418]: https://github.com/tokio-rs/tracing/pull/2418
+[#2516]: https://github.com/tokio-rs/tracing/pull/2516
+[#2356]: https://github.com/tokio-rs/tracing/pull/2356
+[#2530]: https://github.com/tokio-rs/tracing/pull/2530
+[#2433]: https://github.com/tokio-rs/tracing/pull/2433
+[#2350]: https://github.com/tokio-rs/tracing/pull/2350
+
+# 0.1.37 (October 6, 2022)
+
+This release of `tracing` incorporates changes from `tracing-core`
+[v0.1.30][core-0.1.30] and `tracing-attributes` [v0.1.23][attrs-0.1.23],
+including the new `Subscriber::on_register_dispatch` method for performing late
+initialization after a `Subscriber` is registered as a `Dispatch`, and bugfixes
+for the `#[instrument]` attribute. Additionally, it fixes instances of the
+`bare_trait_objects` lint, which is now a warning on `tracing`'s MSRV and will
+become an error in the next edition.
+
+### Fixed
+
+- **attributes**: Incorrect handling of inner attributes in `#[instrument]`ed
+ functions ([#2307])
+- **attributes**: Incorrect location of compiler diagnostic spans generated for
+ type errors in `#[instrument]`ed `async fn`s ([#2270])
+- **attributes**: Updated `syn` dependency to fix compilation with `-Z
+ minimal-versions` ([#2246])
+- `bare_trait_objects` warning in `valueset!` macro expansion ([#2308])
+
+### Added
+
+- **core**: `Subscriber::on_register_dispatch` method ([#2269])
+- **core**: `WeakDispatch` type and `Dispatch::downgrade()` function ([#2293])
+
+### Changed
+
+- `tracing-core`: updated to [0.1.30][core-0.1.30]
+- `tracing-attributes`: updated to [0.1.23][attrs-0.1.23]
+
+### Documented
+
+- Added [`tracing-web`] and [`reqwest-tracing`] to related crates ([#2283],
+ [#2331])
+
+Thanks to new contributors @compiler-errors, @e-nomem, @WorldSEnder, @Xiami2012,
+and @tl-rodrigo-gryzinski, as well as @jswrenn and @CAD97, for contributing to
+this release!
+
+[core-0.1.30]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.30
+[attrs-0.1.23]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.23
+[`tracing-web`]: https://crates.io/crates/tracing-web/
+[`reqwest-tracing`]: https://crates.io/crates/reqwest-tracing/
+[#2246]: https://github.com/tokio-rs/tracing/pull/2246
+[#2269]: https://github.com/tokio-rs/tracing/pull/2269
+[#2283]: https://github.com/tokio-rs/tracing/pull/2283
+[#2270]: https://github.com/tokio-rs/tracing/pull/2270
+[#2293]: https://github.com/tokio-rs/tracing/pull/2293
+[#2307]: https://github.com/tokio-rs/tracing/pull/2307
+[#2308]: https://github.com/tokio-rs/tracing/pull/2308
+[#2331]: https://github.com/tokio-rs/tracing/pull/2331
+
+# 0.1.36 (July 29, 2022)
+
+This release adds support for owned values and fat pointers as arguments to the
+`Span::record` method, as well as updating the minimum `tracing-core` version
+and several documentation improvements.
+
+### Fixed
+
+- Incorrect docs in `dispatcher::set_default` ([#2220])
+- Compilation with `-Z minimal-versions` ([#2246])
+
+### Added
+
+- Support for owned values and fat pointers in `Span::record` ([#2212])
+- Documentation improvements ([#2208], [#2163])
+
+### Changed
+
+- `tracing-core`: updated to [0.1.29][core-0.1.29]
+
+Thanks to @fredr, @cgbur, @jyn514, @matklad, and @CAD97 for contributing to this
+release!
+
+[core-0.1.29]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.29
+[#2220]: https://github.com/tokio-rs/tracing/pull/2220
+[#2246]: https://github.com/tokio-rs/tracing/pull/2246
+[#2212]: https://github.com/tokio-rs/tracing/pull/2212
+[#2208]: https://github.com/tokio-rs/tracing/pull/2208
+[#2163]: https://github.com/tokio-rs/tracing/pull/2163
+
+# 0.1.35 (June 8, 2022)
+
+This release reduces the overhead of callsite registration by using new
+`tracing-core` APIs.
+
+### Added
+
+- Use `DefaultCallsite` to reduce callsite registration overhead ([#2083])
+
+### Changed
+
+- `tracing-core`: updated to [0.1.27][core-0.1.27]
+
+[core-0.1.27]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.27
+[#2088]: https://github.com/tokio-rs/tracing/pull/2083
+
+# 0.1.34 (April 14, 2022)
+
+This release includes bug fixes for the "log" support feature and for the use of
+both scoped and global default dispatchers in the same program.
+
+### Fixed
+
+- Failure to use the global default dispatcher when a thread sets a local
+ default dispatcher before the global default is set ([#2065])
+- **log**: Compilation errors due to `async` block/fn futures becoming `!Send`
+ when the "log" feature flag is enabled ([#2073])
+- Broken links in documentation ([#2068])
+
+Thanks to @ben0x539 for contributing to this release!
+
+[#2065]: https://github.com/tokio-rs/tracing/pull/2065
+[#2073]: https://github.com/tokio-rs/tracing/pull/2073
+[#2068]: https://github.com/tokio-rs/tracing/pull/2068
+
+# 0.1.33 (April 9, 2022)
+
+This release adds new `span_enabled!` and `event_enabled!` variants of the
+`enabled!` macro, for testing whether a subscriber would specifically enable a
+span or an event.
+
+### Added
+
+- `span_enabled!` and `event_enabled!` macros ([#1900])
+- Several documentation improvements ([#2010], [#2012])
+
+### Fixed
+
+- Compilation warning when compiling for <=32-bit targets (including `wasm32`)
+ ([#2060])
+
+Thanks to @guswynn, @arifd, @hrxi, @CAD97, and @name1e5s for contributing to
+this release!
+
+[#1900]: https://github.com/tokio-rs/tracing/pull/1900
+[#2010]: https://github.com/tokio-rs/tracing/pull/2010
+[#2012]: https://github.com/tokio-rs/tracing/pull/2012
+[#2060]: https://github.com/tokio-rs/tracing/pull/2060
+
+# 0.1.32 (March 8th, 2022)
+
+This release reduces the overhead of creating and dropping disabled
+spans significantly, which should improve performance when no `tracing`
+subscriber is in use or when spans are disabled by a filter.
+
+### Fixed
+
+- **attributes**: Compilation failure with `--minimal-versions` due to a
+ too-permissive `syn` dependency ([#1960])
+
+### Changed
+
+- Reduced `Drop` overhead for disabled spans ([#1974])
+- `tracing-attributes`: updated to [0.1.20][attributes-0.1.20]
+
+[#1974]: https://github.com/tokio-rs/tracing/pull/1974
+[#1960]: https://github.com/tokio-rs/tracing/pull/1960
+[attributes-0.1.20]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.20
+
+# 0.1.31 (February 17th, 2022)
+
+This release increases the minimum supported Rust version (MSRV) to 1.49.0. In
+addition, it fixes some relatively rare macro bugs.
+
+### Added
+
+- Added `tracing-forest` to the list of related crates ([#1935])
+
+### Changed
+
+- Updated minimum supported Rust version (MSRV) to 1.49.0 ([#1913])
+
+### Fixed
+
+- Fixed the `warn!` macro incorrectly generating an event with the `TRACE` level
+ ([#1930])
+- Fixed macro hygiene issues when used in a crate that defines its own `concat!`
+ macro, for real this time ([#1918])
+
+Thanks to @QnnOkabayashi, @nicolaasg, and @teohhanhui for contributing to this
+release!
+
+[#1935]: https://github.com/tokio-rs/tracing/pull/1935
+[#1913]: https://github.com/tokio-rs/tracing/pull/1913
+[#1930]: https://github.com/tokio-rs/tracing/pull/1930
+[#1918]: https://github.com/tokio-rs/tracing/pull/1918
+
+# 0.1.30 (February 3rd, 2022)
+
+This release adds *experimental* support for recording structured field
+values using the [`valuable`] crate. See [this blog post][post] for
+details on `valuable`.
+
+Note that `valuable` support currently requires `--cfg tracing_unstable`. See
+the documentation for details.
+
+This release also adds a new `enabled!` macro for testing if a span or event
+would be enabled.
+
+### Added
+
+- **field**: Experimental support for recording field values using the
+ [`valuable`] crate ([#1608], [#1888], [#1887])
+- `enabled!` macro for testing if a span or event is enabled ([#1882])
+
+### Changed
+
+- `tracing-core`: updated to [0.1.22][core-0.1.22]
+- `tracing-attributes`: updated to [0.1.19][attributes-0.1.19]
+
+### Fixed
+
+- **log**: Fixed "use of moved value" compiler error when the "log" feature is
+ enabled ([#1823])
+- Fixed macro hygiene issues when used in a crate that defines its own `concat!`
+ macro ([#1842])
+- A very large number of documentation fixes and improvements.
+
+Thanks to @@Vlad-Scherbina, @Skepfyr, @Swatinem, @guswynn, @teohhanhui,
+@xd009642, @tobz, @d-e-s-o@0b01, and @nickelc for contributing to this release!
+
+[`valuable`]: https://crates.io/crates/valuable
+[post]: https://tokio.rs/blog/2021-05-valuable
+[core-0.1.22]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.22
+[attributes-0.1.19]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.19
+[#1608]: https://github.com/tokio-rs/tracing/pull/1608
+[#1888]: https://github.com/tokio-rs/tracing/pull/1888
+[#1887]: https://github.com/tokio-rs/tracing/pull/1887
+[#1882]: https://github.com/tokio-rs/tracing/pull/1882
+[#1823]: https://github.com/tokio-rs/tracing/pull/1823
+[#1842]: https://github.com/tokio-rs/tracing/pull/1842
+
+# 0.1.29 (October 5th, 2021)
+
+This release adds support for recording `Option<T> where T: Value` as typed
+`tracing` field values. It also includes significant performance improvements
+for functions annotated with the `#[instrument]` attribute when the generated
+span is disabled.
+
+### Changed
+
+- `tracing-core`: updated to v0.1.21
+- `tracing-attributes`: updated to v0.1.18
+
+### Added
+
+- **field**: `Value` impl for `Option<T> where T: Value` ([#1585])
+- **attributes**: - improved performance when skipping `#[instrument]`-generated
+ spans below the max level ([#1600], [#1605], [#1614], [#1616], [#1617])
+
+### Fixed
+
+- **instrument**: added missing `Future` implementation for `WithSubscriber`,
+ making the `WithDispatch` extension trait actually useable ([#1602])
+- Documentation fixes and improvements ([#1595], [#1601], [#1597])
+
+Thanks to @brianburgers, @mattiast, @DCjanus, @oli-obk, and @matklad for
+contributing to this release!
+
+[#1585]: https://github.com/tokio-rs/tracing/pull/1585
+[#1595]: https://github.com/tokio-rs/tracing/pull/1596
+[#1597]: https://github.com/tokio-rs/tracing/pull/1597
+[#1600]: https://github.com/tokio-rs/tracing/pull/1600
+[#1601]: https://github.com/tokio-rs/tracing/pull/1601
+[#1602]: https://github.com/tokio-rs/tracing/pull/1602
+[#1605]: https://github.com/tokio-rs/tracing/pull/1605
+[#1614]: https://github.com/tokio-rs/tracing/pull/1614
+[#1616]: https://github.com/tokio-rs/tracing/pull/1616
+[#1617]: https://github.com/tokio-rs/tracing/pull/1617
+
+# 0.1.28 (September 17th, 2021)
+
+This release fixes an issue where the RustDoc documentation was rendered
+incorrectly. It doesn't include any actual code changes, and is very boring and
+can be ignored.
+
+### Fixed
+
+- **docs**: Incorrect documentation rendering due to unclosed `<div>` tag
+ ([#1572])
+
+[#1572]: https://github.com/tokio-rs/tracing/pull/1572
+
+# 0.1.27 (September 13, 2021)
+
+This release adds a new [`Span::or_current`] method to aid in efficiently
+propagating span contexts to spawned threads or tasks. Additionally, it updates
+the [`tracing-core`] version to [0.1.20] and the [`tracing-attributes`] version to
+[0.1.16], ensuring that a number of new features in those crates are present.
+
+### Fixed
+
+- **instrument**: Added missing `WithSubscriber` implementations for futures and
+ other types ([#1424])
+
+### Added
+
+- `Span::or_current` method, to help with efficient span context propagation
+ ([#1538])
+- **attributes**: add `skip_all` option to `#[instrument]` ([#1548])
+- **attributes**: record primitive types as primitive values rather than as
+ `fmt::Debug` ([#1378])
+- **core**: `NoSubscriber`, a no-op `Subscriber` implementation
+ ([#1549])
+- **core**: Added `Visit::record_f64` and support for recording floating-point
+ values ([#1507], [#1522])
+- A large number of documentation improvements and fixes ([#1369], [#1398],
+ [#1435], [#1442], [#1524], [#1556])
+
+Thanks to new contributors @dzvon and @mbergkvist, as well as @teozkr,
+@maxburke, @LukeMathWalker, and @jsgf, for contributing to this
+release!
+
+[`Span::or_current`]: https://docs.rs/tracing/0.1.27/tracing/struct.Span.html#method.or_current
+[`tracing-core`]: https://crates.io/crates/tracing-core
+[`tracing-attributes`]: https://crates.io/crates/tracing-attributes
+[`tracing-core`]: https://crates.io/crates/tracing-core
+[0.1.20]: https://github.com/tokio-rs/tracing/releases/tag/tracing-core-0.1.20
+[0.1.16]: https://github.com/tokio-rs/tracing/releases/tag/tracing-attributes-0.1.16
+[#1424]: https://github.com/tokio-rs/tracing/pull/1424
+[#1538]: https://github.com/tokio-rs/tracing/pull/1538
+[#1548]: https://github.com/tokio-rs/tracing/pull/1548
+[#1378]: https://github.com/tokio-rs/tracing/pull/1378
+[#1507]: https://github.com/tokio-rs/tracing/pull/1507
+[#1522]: https://github.com/tokio-rs/tracing/pull/1522
+[#1369]: https://github.com/tokio-rs/tracing/pull/1369
+[#1398]: https://github.com/tokio-rs/tracing/pull/1398
+[#1435]: https://github.com/tokio-rs/tracing/pull/1435
+[#1442]: https://github.com/tokio-rs/tracing/pull/1442
+[#1524]: https://github.com/tokio-rs/tracing/pull/1524
+[#1556]: https://github.com/tokio-rs/tracing/pull/1556
+
+# 0.1.26 (April 30, 2021)
+
+### Fixed
+
+- **attributes**: Compatibility between `#[instrument]` and `async-trait`
+ v0.1.43 and newer ([#1228])
+- Several documentation fixes ([#1305], [#1344])
+### Added
+
+- `Subscriber` impl for `Box<dyn Subscriber + Send + Sync + 'static>` ([#1358])
+- `Subscriber` impl for `Arc<dyn Subscriber + Send + Sync + 'static>` ([#1374])
+- Symmetric `From` impls for existing `Into` impls on `span::Current`, `Span`,
+ and `Option<Id>` ([#1335], [#1338])
+- `From<EnteredSpan>` implementation for `Option<Id>`, allowing `EnteredSpan` to
+ be used in a `span!` macro's `parent:` field ([#1325])
+- `Attributes::fields` accessor that returns the set of fields defined on a
+ span's `Attributes` ([#1331])
+
+
+Thanks to @Folyd, @nightmared, and new contributors @rmsc and @Fishrock123 for
+contributing to this release!
+
+[#1227]: https://github.com/tokio-rs/tracing/pull/1228
+[#1305]: https://github.com/tokio-rs/tracing/pull/1305
+[#1325]: https://github.com/tokio-rs/tracing/pull/1325
+[#1338]: https://github.com/tokio-rs/tracing/pull/1338
+[#1344]: https://github.com/tokio-rs/tracing/pull/1344
+[#1358]: https://github.com/tokio-rs/tracing/pull/1358
+[#1374]: https://github.com/tokio-rs/tracing/pull/1374
+[#1335]: https://github.com/tokio-rs/tracing/pull/1335
+[#1331]: https://github.com/tokio-rs/tracing/pull/1331
+
+# 0.1.25 (February 23, 2021)
+
+### Added
+
+- `Span::entered` method for entering a span and moving it into a guard by value
+ rather than borrowing it ([#1252])
+
+Thanks to @matklad for contributing to this release!
+
+[#1252]: https://github.com/tokio-rs/tracing/pull/1252
+
+# 0.1.24 (February 17, 2021)
+
+### Fixed
+
+- **attributes**: Compiler error when using `#[instrument(err)]` on functions
+ which return `impl Trait` ([#1236])
+- Fixed broken match arms in event macros ([#1239])
+- Documentation improvements ([#1232])
+
+Thanks to @bkchr and @lfranke for contributing to this release!
+
+[#1236]: https://github.com/tokio-rs/tracing/pull/1236
+[#1239]: https://github.com/tokio-rs/tracing/pull/1239
+[#1232]: https://github.com/tokio-rs/tracing/pull/1232
+
+# 0.1.23 (February 4, 2021)
+
+### Fixed
+
+- **attributes**: Compiler error when using `#[instrument(err)]` on functions
+ with mutable parameters ([#1167])
+- **attributes**: Missing function visibility modifier when using
+ `#[instrument]` with `async-trait` ([#977])
+- **attributes** Removed unused `syn` features ([#928])
+- **log**: Fixed an issue where the `tracing` macros would generate code for
+ events whose levels are disabled statically by the `log` crate's
+ `static_max_level_XXX` features ([#1175])
+- Fixed deprecations and clippy lints ([#1195])
+- Several documentation fixes and improvements ([#941], [#965], [#981], [#1146],
+ [#1215])
+
+### Changed
+
+- **attributes**: `tracing-futures` dependency is no longer required when using
+ `#[instrument]` on async functions ([#808])
+- **attributes**: Updated `tracing-attributes` minimum dependency to v0.1.12
+ ([#1222])
+
+Thanks to @nagisa, @Txuritan, @TaKO8Ki, @okready, and @krojew for contributing
+to this release!
+
+[#1167]: https://github.com/tokio-rs/tracing/pull/1167
+[#977]: https://github.com/tokio-rs/tracing/pull/977
+[#965]: https://github.com/tokio-rs/tracing/pull/965
+[#981]: https://github.com/tokio-rs/tracing/pull/981
+[#1215]: https://github.com/tokio-rs/tracing/pull/1215
+[#808]: https://github.com/tokio-rs/tracing/pull/808
+[#941]: https://github.com/tokio-rs/tracing/pull/941
+[#1146]: https://github.com/tokio-rs/tracing/pull/1146
+[#1175]: https://github.com/tokio-rs/tracing/pull/1175
+[#1195]: https://github.com/tokio-rs/tracing/pull/1195
+[#1222]: https://github.com/tokio-rs/tracing/pull/1222
+
+# 0.1.22 (November 23, 2020)
+
+### Changed
+
+- Updated `pin-project-lite` dependency to 0.2 ([#1108])
+
+[#1108]: https://github.com/tokio-rs/tracing/pull/1108
+
+# 0.1.21 (September 28, 2020)
+
+### Fixed
+
+- Incorrect inlining of `Span::new`, `Span::new_root`, and `Span::new_child_of`,
+ which could result in `dispatcher::get_default` being inlined at the callsite
+ ([#994])
+- Regression where using a struct field as a span or event field when other
+ fields on that struct are borrowed mutably would fail to compile ([#987])
+
+### Changed
+
+- Updated `tracing-core` to 0.1.17 ([#992])
+
+### Added
+
+- `Instrument` trait and `Instrumented` type for attaching a `Span` to a
+ `Future` ([#808])
+- `Copy` implementations for `Level` and `LevelFilter` ([#992])
+- Multiple documentation fixes and improvements ([#964], [#980], [#981])
+
+Thanks to @nagisa, and new contributors @SecurityInsanity, @froydnj, @jyn514 and
+@TaKO8Ki for contributing to this release!
+
+[#994]: https://github.com/tokio-rs/tracing/pull/994
+[#992]: https://github.com/tokio-rs/tracing/pull/992
+[#987]: https://github.com/tokio-rs/tracing/pull/987
+[#980]: https://github.com/tokio-rs/tracing/pull/980
+[#981]: https://github.com/tokio-rs/tracing/pull/981
+[#964]: https://github.com/tokio-rs/tracing/pull/964
+[#808]: https://github.com/tokio-rs/tracing/pull/808
+
+# 0.1.20 (August 24, 2020)
+
+### Changed
+
+- Significantly reduced assembly generated by macro invocations (#943)
+- Updated `tracing-core` to 0.1.15 (#943)
+
+### Added
+
+- Documented minimum supported Rust version policy (#941)
+
+# 0.1.19 (August 10, 2020)
+
+### Fixed
+
+- Updated `tracing-core` to fix incorrect calculation of the global max level
+ filter (#908)
+
+### Added
+
+- **attributes**: Support for using `self` in field expressions when
+ instrumenting `async-trait` functions (#875)
+- Several documentation improvements (#832, #881, #896, #897, #911, #913)
+
+Thanks to @anton-dutov, @nightmared, @mystor, and @toshokan for contributing to
+this release!
+
+# 0.1.18 (July 31, 2020)
+
+### Fixed
+
+- Fixed a bug where `LevelFilter::OFF` (and thus also the `static_max_level_off`
+ feature flag) would enable *all* traces, rather than *none* (#853)
+- **log**: Fixed `tracing` macros and `Span`s not checking `log::max_level`
+ before emitting `log` records (#870)
+
+### Changed
+
+- **macros**: Macros now check the global max level (`LevelFilter::current`)
+ before the per-callsite cache when determining if a span or event is enabled.
+ This significantly improves performance in some use cases (#853)
+- **macros**: Simplified the code generated by macro expansion significantly,
+ which may improve compile times and/or `rustc` optimizatation of surrounding
+ code (#869, #869)
+- **macros**: Macros now check the static max level before checking any runtime
+ filtering, improving performance when a span or event is disabled by a
+ `static_max_level_XXX` feature flag (#868)
+- `LevelFilter` is now a re-export of the `tracing_core::LevelFilter` type, it
+ can now be used interchangably with the versions in `tracing-core` and
+ `tracing-subscriber` (#853)
+- Significant performance improvements when comparing `LevelFilter`s and
+ `Level`s (#853)
+- Updated the minimum `tracing-core` dependency to 0.1.12 (#853)
+
+### Added
+
+- **macros**: Quoted string literals may now be used as field names, to allow
+ fields whose names are not valid Rust identifiers (#790)
+- **docs**: Several documentation improvements (#850, #857, #841)
+- `LevelFilter::current()` function, which returns the highest level that any
+ subscriber will enable (#853)
+- `Subscriber::max_level_hint` optional trait method, for setting the value
+ returned by `LevelFilter::current()` (#853)
+
+Thanks to new contributors @cuviper, @ethanboxx, @ben0x539, @dignati,
+@colelawrence, and @rbtcollins for helping out with this release!
+
+# 0.1.17 (July 22, 2020)
+
+### Changed
+
+- **log**: Moved verbose span enter/exit log records to "tracing::span::active"
+ target, allowing them to be filtered separately (#833)
+- **log**: All span lifecycle log records without fields now have the `Trace`
+ log filter, to guard against `log` users enabling them by default with blanket
+ level filtering (#833)
+
+### Fixed
+
+- **log**/**macros**: Fixed missing implicit imports of the
+ `tracing::field::debug` and `tracing::field::display` functions inside the
+ macros when the "log" feature is enabled (#835)
+
+# 0.1.16 (July 8, 2020)
+
+### Added
+
+- **attributes**: Support for arbitrary expressions as fields in `#[instrument]` (#672)
+- **attributes**: `#[instrument]` now emits a compiler warning when ignoring unrecognized
+ input (#672, #786)
+- Improved documentation on using `tracing` in async code (#769)
+
+### Changed
+
+- Updated `tracing-core` dependency to 0.1.11
+
+### Fixed
+
+- **macros**: Excessive monomorphization in macros, which could lead to
+ longer compilation times (#787)
+- **log**: Compiler warnings in macros when `log` or `log-always` features
+ are enabled (#753)
+- Compiler error when `tracing-core/std` feature is enabled but `tracing/std` is
+ not (#760)
+
+Thanks to @nagisa for contributing to this release!
+
+# 0.1.15 (June 2, 2020)
+
+### Changed
+
+- **macros**: Replaced use of legacy `local_inner_macros` with `$crate::` (#740)
+
+### Added
+
+- Docs fixes and improvements (#742, #731, #730)
+
+Thanks to @bnjjj, @blaenk, and @LukeMathWalker for contributing to this release!
+
+# 0.1.14 (May 14, 2020)
+
+### Added
+
+- **log**: When using the [`log`] compatibility feature alongside a `tracing`
+ `Subscriber`, log records for spans now include span IDs (#613)
+- **attributes**: Support for using `#[instrument]` on methods that are part of
+ [`async-trait`] trait implementations (#711)
+- **attributes**: Optional `#[instrument(err)]` argument to automatically emit
+ an event if an instrumented function returns `Err` (#637)
+- Added `#[must_use]` attribute to the guard returned by
+ `subscriber::set_default` (#685)
+
+### Changed
+
+- **log**: Made [`log`] records emitted by spans much less noisy when span IDs are
+ not available (#613)
+
+### Fixed
+
+- Several typos in the documentation (#656, #710, #715)
+
+Thanks to @FintanH, @shepmaster, @inanna-malick, @zekisharif, @bkchr, @majecty,
+@ilana and @nightmared for contributing to this release!
+
+[`async-trait`]: https://crates.io/crates/async-trait
+[`log`]: https://crates.io/crates/log
+
+# 0.1.13 (February 26, 2019)
+
+### Added
+
+- **field**: `field::Empty` type for declaring empty fields whose values will be
+ recorded later (#548)
+- **field**: `field::Value` implementations for `Wrapping` and `NonZero*`
+ numbers (#538)
+- **attributes**: Support for adding arbitrary literal fields to spans generated
+ by `#[instrument]` (#569)
+- **attributes**: `#[instrument]` now emits a helpful compiler error when
+ attempting to skip a function parameter (#600)
+
+### Changed
+
+- **attributes**: The `#[instrument]` attribute was placed under an on-by-default
+ feature flag "attributes" (#603)
+
+### Fixed
+
+- Broken and unresolvable links in RustDoc (#595)
+
+Thanks to @oli-cosmian and @Kobzol for contributing to this release!
+
+# 0.1.12 (January 11, 2019)
+
+### Added
+
+- `Span::with_subscriber` method to access the subscriber that tracks a `Span`
+ (#503)
+- API documentation now shows which features are required by feature-flagged
+ items (#523)
+- Improved README examples (#496)
+- Documentation links to related crates (#507)
+
+# 0.1.11 (December 20, 2019)
+
+### Added
+
+- `Span::is_none` method (#475)
+- `LevelFilter::into_level` method (#470)
+- `LevelFilter::from_level` function and `From<Level>` impl (#471)
+- Documented minimum supported Rust version (#482)
+
+### Fixed
+
+- Incorrect parameter type to `Span::follows_from` that made it impossible to
+ call (#467)
+- Missing whitespace in `log` records generated when enabling the `log` feature
+ flag (#484)
+- Typos and missing links in documentation (#405, #423, #439)
+
+# 0.1.10 (October 23, 2019)
+
+### Added
+
+- Support for destructuring in arguments to `#[instrument]`ed functions (#397)
+- Generated field for `self` parameters when `#[instrument]`ing methods (#397)
+- Optional `skip` argument to `#[instrument]` for excluding function parameters
+ from generated spans (#359)
+- Added `dispatcher::set_default` and `subscriber::set_default` APIs, which
+ return a drop guard (#388)
+
+### Fixed
+
+- Some minor documentation errors (#356, #370)
+
+# 0.1.9 (September 13, 2019)
+
+### Fixed
+
+- Fixed `#[instrument]`ed async functions not compiling on `nightly-2019-09-11`
+ or newer (#342)
+
+### Changed
+
+- Significantly reduced performance impact of skipped spans and events when a
+ `Subscriber` is not in use (#326)
+- The `log` feature will now only cause `tracing` spans and events to emit log
+ records when a `Subscriber` is not in use (#346)
+
+### Added
+
+- Added support for overriding the name of the span generated by `#[instrument]`
+ (#330)
+- `log-always` feature flag to emit log records even when a `Subscriber` is set
+ (#346)
+
+# 0.1.8 (September 3, 2019)
+
+### Changed
+
+- Reorganized and improved API documentation (#317)
+
+### Removed
+
+- Dev-dependencies on `ansi_term` and `humantime` crates, which were used only
+ for examples (#316)
+
+# 0.1.7 (August 30, 2019)
+
+### Changed
+
+- New (curly-brace free) event message syntax to place the message in the first
+ field rather than the last (#309)
+
+### Fixed
+
+- Fixed a regression causing macro stack exhaustion when the `log` feature flag
+ is enabled (#304)
+
+# 0.1.6 (August 20, 2019)
+
+### Added
+
+- `std::error::Error` as a new primitive type (#277)
+- Support for mixing key-value fields and `format_args` messages without curly
+ braces as delimiters (#288)
+
+### Changed
+
+- `tracing-core` dependency to 0.1.5 (#294)
+- `tracing-attributes` dependency to 0.1.2 (#297)
+
+# 0.1.5 (August 9, 2019)
+
+### Added
+
+- Support for `no-std` + `liballoc` (#263)
+
+### Changed
+
+- Using the `#[instrument]` attribute on `async fn`s no longer requires a
+ feature flag (#258)
+
+### Fixed
+
+- The `#[instrument]` macro now works on generic functions (#262)
+
+# 0.1.4 (August 8, 2019)
+
+### Added
+
+- `#[instrument]` attribute for automatically adding spans to functions (#253)
+
+# 0.1.3 (July 11, 2019)
+
+### Added
+
+- Log messages when a subscriber indicates that a span has closed, when the
+ `log` feature flag is enabled (#180).
+
+### Changed
+
+- `tracing-core` minimum dependency version to 0.1.2 (#174).
+
+### Fixed
+
+- Fixed an issue where event macro invocations with a single field, using local
+ variable shorthand, would recur infinitely (#166).
+- Fixed uses of deprecated `tracing-core` APIs (#174).
+
+# 0.1.2 (July 6, 2019)
+
+### Added
+
+- `Span::none()` constructor, which does not require metadata and
+ returns a completely empty span (#147).
+- `Span::current()` function, returning the current span if it is
+ known to the subscriber (#148).
+
+### Fixed
+
+- Broken macro imports when used prefixed with `tracing::` (#152).
+
+# 0.1.1 (July 3, 2019)
+
+### Changed
+
+- `cfg_if` dependency to 0.1.9.
+
+### Fixed
+
+- Compilation errors when the `log` feature is enabled (#131).
+- Unclear wording and typos in documentation (#124, #128, #142).
+
+# 0.1.0 (June 27, 2019)
+
+- Initial release
diff --git a/crates/tracing/Cargo.toml b/crates/tracing/Cargo.toml
new file mode 100644
index 0000000..1143cd6
--- /dev/null
+++ b/crates/tracing/Cargo.toml
@@ -0,0 +1,143 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.56.0"
+name = "tracing"
+version = "0.1.40"
+authors = [
+ "Eliza Weisman <[email protected]>",
+ "Tokio Contributors <[email protected]>",
+]
+description = """
+Application-level tracing for Rust.
+"""
+homepage = "https://tokio.rs"
+readme = "README.md"
+keywords = [
+ "logging",
+ "tracing",
+ "metrics",
+ "async",
+]
+categories = [
+ "development-tools::debugging",
+ "development-tools::profiling",
+ "asynchronous",
+ "no-std",
+]
+license = "MIT"
+repository = "https://github.com/tokio-rs/tracing"
+
+[package.metadata.docs.rs]
+all-features = true
+rustc-args = [
+ "--cfg",
+ "tracing_unstable",
+]
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+ "--cfg",
+ "tracing_unstable",
+]
+
+[[bench]]
+name = "baseline"
+harness = false
+
+[[bench]]
+name = "dispatch_get_clone"
+harness = false
+
+[[bench]]
+name = "dispatch_get_ref"
+harness = false
+
+[[bench]]
+name = "empty_span"
+harness = false
+
+[[bench]]
+name = "enter_span"
+harness = false
+
+[[bench]]
+name = "event"
+harness = false
+
+[[bench]]
+name = "span_fields"
+harness = false
+
+[[bench]]
+name = "span_no_fields"
+harness = false
+
+[[bench]]
+name = "span_repeated"
+harness = false
+
+[dependencies.log]
+version = "0.4.17"
+optional = true
+
+[dependencies.pin-project-lite]
+version = "0.2.9"
+
+[dependencies.tracing-attributes]
+version = "0.1.27"
+optional = true
+
+[dependencies.tracing-core]
+version = "0.1.32"
+default-features = false
+
+[dev-dependencies.criterion]
+version = "0.3.6"
+default_features = false
+
+[dev-dependencies.futures]
+version = "0.3.21"
+default_features = false
+
+[dev-dependencies.log]
+version = "0.4.17"
+
+[features]
+async-await = []
+attributes = ["tracing-attributes"]
+default = [
+ "std",
+ "attributes",
+]
+log-always = ["log"]
+max_level_debug = []
+max_level_error = []
+max_level_info = []
+max_level_off = []
+max_level_trace = []
+max_level_warn = []
+release_max_level_debug = []
+release_max_level_error = []
+release_max_level_info = []
+release_max_level_off = []
+release_max_level_trace = []
+release_max_level_warn = []
+std = ["tracing-core/std"]
+valuable = ["tracing-core/valuable"]
+
+[target."cfg(target_arch = \"wasm32\")".dev-dependencies.wasm-bindgen-test]
+version = "^0.3"
+
+[badges.maintenance]
+status = "actively-developed"
diff --git a/crates/tracing/LICENSE b/crates/tracing/LICENSE
new file mode 100644
index 0000000..cdb28b4
--- /dev/null
+++ b/crates/tracing/LICENSE
@@ -0,0 +1,25 @@
+Copyright (c) 2019 Tokio Contributors
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/tracing/METADATA b/crates/tracing/METADATA
new file mode 100644
index 0000000..150b64d
--- /dev/null
+++ b/crates/tracing/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/tracing
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tracing"
+description: "A scoped, structured logging and diagnostics system."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 6
+ }
+ homepage: "https://crates.io/crates/tracing"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tracing/tracing-0.1.40.crate"
+ version: "0.1.40"
+ }
+}
diff --git a/crates/tracing/MODULE_LICENSE_MIT b/crates/tracing/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tracing/MODULE_LICENSE_MIT
diff --git a/crates/tracing/README.md b/crates/tracing/README.md
new file mode 100644
index 0000000..a42636f
--- /dev/null
+++ b/crates/tracing/README.md
@@ -0,0 +1,467 @@
+![Tracing — Structured, application-level diagnostics][splash]
+
+[splash]: https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/splash.svg
+
+# tracing
+
+Application-level tracing for Rust.
+
+[![Crates.io][crates-badge]][crates-url]
+[![Documentation][docs-badge]][docs-url]
+[![Documentation (master)][docs-master-badge]][docs-master-url]
+[![MIT licensed][mit-badge]][mit-url]
+[![Build Status][actions-badge]][actions-url]
+[![Discord chat][discord-badge]][discord-url]
+
+[Documentation][docs-url] | [Chat][discord-url]
+
+[crates-badge]: https://img.shields.io/crates/v/tracing.svg
+[crates-url]: https://crates.io/crates/tracing
+[docs-badge]: https://docs.rs/tracing/badge.svg
+[docs-url]: https://docs.rs/tracing
+[docs-master-badge]: https://img.shields.io/badge/docs-master-blue
+[docs-master-url]: https://tracing-rs.netlify.com/tracing
+[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[mit-url]: LICENSE
+[actions-badge]: https://github.com/tokio-rs/tracing/workflows/CI/badge.svg
+[actions-url]:https://github.com/tokio-rs/tracing/actions?query=workflow%3ACI
+[discord-badge]: https://img.shields.io/discord/500028886025895936?logo=discord&label=discord&logoColor=white
+[discord-url]: https://discord.gg/EeF3cQw
+
+## Overview
+
+`tracing` is a framework for instrumenting Rust programs to collect
+structured, event-based diagnostic information.
+
+In asynchronous systems like Tokio, interpreting traditional log messages can
+often be quite challenging. Since individual tasks are multiplexed on the same
+thread, associated events and log lines are intermixed making it difficult to
+trace the logic flow. `tracing` expands upon logging-style diagnostics by
+allowing libraries and applications to record structured events with additional
+information about *temporality* and *causality* — unlike a log message, a span
+in `tracing` has a beginning and end time, may be entered and exited by the
+flow of execution, and may exist within a nested tree of similar spans. In
+addition, `tracing` spans are *structured*, with the ability to record typed
+data as well as textual messages.
+
+The `tracing` crate provides the APIs necessary for instrumenting libraries
+and applications to emit trace data.
+
+*Compiler support: [requires `rustc` 1.56+][msrv]*
+
+[msrv]: #supported-rust-versions
+
+## Usage
+
+(The examples below are borrowed from the `log` crate's yak-shaving
+[example](https://docs.rs/log/0.4.10/log/index.html#examples), modified to
+idiomatic `tracing`.)
+
+### In Applications
+
+In order to record trace events, executables have to use a `Subscriber`
+implementation compatible with `tracing`. A `Subscriber` implements a way of
+collecting trace data, such as by logging it to standard output. [`tracing_subscriber`](https://docs.rs/tracing-subscriber/)'s
+[`fmt` module](https://docs.rs/tracing-subscriber/0.3/tracing_subscriber/fmt/index.html) provides reasonable defaults.
+Additionally, `tracing-subscriber` is able to consume messages emitted by `log`-instrumented libraries and modules.
+
+The simplest way to use a subscriber is to call the `set_global_default` function.
+
+```rust
+use tracing::{info, Level};
+use tracing_subscriber::FmtSubscriber;
+
+fn main() {
+ // a builder for `FmtSubscriber`.
+ let subscriber = FmtSubscriber::builder()
+ // all spans/events with a level higher than TRACE (e.g, debug, info, warn, etc.)
+ // will be written to stdout.
+ .with_max_level(Level::TRACE)
+ // completes the builder.
+ .finish();
+
+ tracing::subscriber::set_global_default(subscriber)
+ .expect("setting default subscriber failed");
+
+ let number_of_yaks = 3;
+ // this creates a new event, outside of any spans.
+ info!(number_of_yaks, "preparing to shave yaks");
+
+ let number_shaved = yak_shave::shave_all(number_of_yaks);
+ info!(
+ all_yaks_shaved = number_shaved == number_of_yaks,
+ "yak shaving completed."
+ );
+}
+```
+
+```toml
+[dependencies]
+tracing = "0.1"
+tracing-subscriber = "0.3.0"
+```
+
+This subscriber will be used as the default in all threads for the remainder of the duration
+of the program, similar to how loggers work in the `log` crate.
+
+In addition, you can locally override the default subscriber. For example:
+
+```rust
+use tracing::{info, Level};
+use tracing_subscriber::FmtSubscriber;
+
+fn main() {
+ let subscriber = tracing_subscriber::FmtSubscriber::builder()
+ // all spans/events with a level higher than TRACE (e.g, debug, info, warn, etc.)
+ // will be written to stdout.
+ .with_max_level(Level::TRACE)
+ // builds the subscriber.
+ .finish();
+
+ tracing::subscriber::with_default(subscriber, || {
+ info!("This will be logged to stdout");
+ });
+ info!("This will _not_ be logged to stdout");
+}
+```
+
+This approach allows trace data to be collected by multiple subscribers
+within different contexts in the program. Note that the override only applies to the
+currently executing thread; other threads will not see the change from with_default.
+
+Any trace events generated outside the context of a subscriber will not be collected.
+
+Once a subscriber has been set, instrumentation points may be added to the
+executable using the `tracing` crate's macros.
+
+### In Libraries
+
+Libraries should only rely on the `tracing` crate and use the provided macros
+and types to collect whatever information might be useful to downstream consumers.
+
+```rust
+use std::{error::Error, io};
+use tracing::{debug, error, info, span, warn, Level};
+
+// the `#[tracing::instrument]` attribute creates and enters a span
+// every time the instrumented function is called. The span is named after the
+// the function or method. Paramaters passed to the function are recorded as fields.
+#[tracing::instrument]
+pub fn shave(yak: usize) -> Result<(), Box<dyn Error + 'static>> {
+ // this creates an event at the DEBUG level with two fields:
+ // - `excitement`, with the key "excitement" and the value "yay!"
+ // - `message`, with the key "message" and the value "hello! I'm gonna shave a yak."
+ //
+ // unlike other fields, `message`'s shorthand initialization is just the string itself.
+ debug!(excitement = "yay!", "hello! I'm gonna shave a yak.");
+ if yak == 3 {
+ warn!("could not locate yak!");
+ // note that this is intended to demonstrate `tracing`'s features, not idiomatic
+ // error handling! in a library or application, you should consider returning
+ // a dedicated `YakError`. libraries like snafu or thiserror make this easy.
+ return Err(io::Error::new(io::ErrorKind::Other, "shaving yak failed!").into());
+ } else {
+ debug!("yak shaved successfully");
+ }
+ Ok(())
+}
+
+pub fn shave_all(yaks: usize) -> usize {
+ // Constructs a new span named "shaving_yaks" at the TRACE level,
+ // and a field whose key is "yaks". This is equivalent to writing:
+ //
+ // let span = span!(Level::TRACE, "shaving_yaks", yaks = yaks);
+ //
+ // local variables (`yaks`) can be used as field values
+ // without an assignment, similar to struct initializers.
+ let _span_ = span!(Level::TRACE, "shaving_yaks", yaks).entered();
+
+ info!("shaving yaks");
+
+ let mut yaks_shaved = 0;
+ for yak in 1..=yaks {
+ let res = shave(yak);
+ debug!(yak, shaved = res.is_ok());
+
+ if let Err(ref error) = res {
+ // Like spans, events can also use the field initialization shorthand.
+ // In this instance, `yak` is the field being initalized.
+ error!(yak, error = error.as_ref(), "failed to shave yak!");
+ } else {
+ yaks_shaved += 1;
+ }
+ debug!(yaks_shaved);
+ }
+
+ yaks_shaved
+}
+```
+
+```toml
+[dependencies]
+tracing = "0.1"
+```
+
+Note: Libraries should *NOT* call `set_global_default()`, as this will cause
+conflicts when executables try to set the default later.
+
+### In Asynchronous Code
+
+If you are instrumenting code that make use of
+[`std::future::Future`](https://doc.rust-lang.org/stable/std/future/trait.Future.html)
+or async/await, avoid using the `Span::enter` method. The following example
+_will not_ work:
+
+```rust
+async {
+ let _s = span.enter();
+ // ...
+}
+```
+```rust
+async {
+ let _s = tracing::span!(...).entered();
+ // ...
+}
+```
+
+The span guard `_s` will not exit until the future generated by the `async` block is complete.
+Since futures and spans can be entered and exited _multiple_ times without them completing,
+the span remains entered for as long as the future exists, rather than being entered only when
+it is polled, leading to very confusing and incorrect output.
+For more details, see [the documentation on closing spans](https://tracing.rs/tracing/span/index.html#closing-spans).
+
+There are two ways to instrument asynchronous code. The first is through the
+[`Future::instrument`](https://docs.rs/tracing/latest/tracing/trait.Instrument.html#method.instrument) combinator:
+
+```rust
+use tracing::Instrument;
+
+let my_future = async {
+ // ...
+};
+
+my_future
+ .instrument(tracing::info_span!("my_future"))
+ .await
+```
+
+`Future::instrument` attaches a span to the future, ensuring that the span's lifetime
+is as long as the future's.
+
+The second, and preferred, option is through the
+[`#[instrument]`](https://docs.rs/tracing/0.1.38/tracing/attr.instrument.html)
+attribute:
+
+```rust
+use tracing::{info, instrument};
+use tokio::{io::AsyncWriteExt, net::TcpStream};
+use std::io;
+
+#[instrument]
+async fn write(stream: &mut TcpStream) -> io::Result<usize> {
+ let result = stream.write(b"hello world\n").await;
+ info!("wrote to stream; success={:?}", result.is_ok());
+ result
+}
+```
+
+Under the hood, the `#[instrument]` macro performs the same explicit span
+attachment that `Future::instrument` does.
+
+### Concepts
+
+This crate provides macros for creating `Span`s and `Event`s, which represent
+periods of time and momentary events within the execution of a program,
+respectively.
+
+As a rule of thumb, _spans_ should be used to represent discrete units of work
+(e.g., a given request's lifetime in a server) or periods of time spent in a
+given context (e.g., time spent interacting with an instance of an external
+system, such as a database). In contrast, _events_ should be used to represent
+points in time within a span — a request returned with a given status code,
+_n_ new items were taken from a queue, and so on.
+
+`Span`s are constructed using the `span!` macro, and then _entered_
+to indicate that some code takes place within the context of that `Span`:
+
+```rust
+use tracing::{span, Level};
+
+// Construct a new span named "my span".
+let mut span = span!(Level::INFO, "my span");
+span.in_scope(|| {
+ // Any trace events in this closure or code called by it will occur within
+ // the span.
+});
+// Dropping the span will close it, indicating that it has ended.
+```
+
+The [`#[instrument]`](https://docs.rs/tracing/0.1.38/tracing/attr.instrument.html) attribute macro
+can reduce some of this boilerplate:
+
+```rust
+use tracing::{instrument};
+
+#[instrument]
+pub fn my_function(my_arg: usize) {
+ // This event will be recorded inside a span named `my_function` with the
+ // field `my_arg`.
+ tracing::info!("inside my_function!");
+ // ...
+}
+```
+
+The `Event` type represent an event that occurs instantaneously, and is
+essentially a `Span` that cannot be entered. They are created using the `event!`
+macro:
+
+```rust
+use tracing::{event, Level};
+
+event!(Level::INFO, "something has happened!");
+```
+
+Users of the [`log`] crate should note that `tracing` exposes a set of macros for
+creating `Event`s (`trace!`, `debug!`, `info!`, `warn!`, and `error!`) which may
+be invoked with the same syntax as the similarly-named macros from the `log`
+crate. Often, the process of converting a project to use `tracing` can begin
+with a simple drop-in replacement.
+
+## Supported Rust Versions
+
+Tracing is built against the latest stable release. The minimum supported
+version is 1.42. The current Tracing version is not guaranteed to build on Rust
+versions earlier than the minimum supported version.
+
+Tracing follows the same compiler support policies as the rest of the Tokio
+project. The current stable Rust compiler and the three most recent minor
+versions before it will always be supported. For example, if the current stable
+compiler version is 1.45, the minimum supported version will not be increased
+past 1.42, three minor versions prior. Increasing the minimum supported compiler
+version is not considered a semver breaking change as long as doing so complies
+with this policy.
+
+## Ecosystem
+
+### Related Crates
+
+In addition to `tracing` and `tracing-core`, the [`tokio-rs/tracing`] repository
+contains several additional crates designed to be used with the `tracing` ecosystem.
+This includes a collection of `Subscriber` implementations, as well as utility
+and adapter crates to assist in writing `Subscriber`s and instrumenting
+applications.
+
+In particular, the following crates are likely to be of interest:
+
+- [`tracing-futures`] provides a compatibility layer with the `futures`
+ crate, allowing spans to be attached to `Future`s, `Stream`s, and `Executor`s.
+- [`tracing-subscriber`] provides `Subscriber` implementations and
+ utilities for working with `Subscriber`s. This includes a [`FmtSubscriber`]
+ `FmtSubscriber` for logging formatted trace data to stdout, with similar
+ filtering and formatting to the [`env_logger`] crate.
+- [`tracing-log`] provides a compatibility layer with the [`log`] crate,
+ allowing log messages to be recorded as `tracing` `Event`s within the
+ trace tree. This is useful when a project using `tracing` have
+ dependencies which use `log`. Note that if you're using
+ `tracing-subscriber`'s `FmtSubscriber`, you don't need to depend on
+ `tracing-log` directly.
+
+Additionally, there are also several third-party crates which are not
+maintained by the `tokio` project. These include:
+
+- [`tracing-timing`] implements inter-event timing metrics on top of `tracing`.
+ It provides a subscriber that records the time elapsed between pairs of
+ `tracing` events and generates histograms.
+- [`tracing-opentelemetry`] provides a subscriber for emitting traces to
+ [OpenTelemetry]-compatible distributed tracing systems.
+- [`tracing-honeycomb`] Provides a layer that reports traces spanning multiple machines to [honeycomb.io]. Backed by [`tracing-distributed`].
+- [`tracing-distributed`] Provides a generic implementation of a layer that reports traces spanning multiple machines to some backend.
+- [`tracing-actix`] provides `tracing` integration for the `actix` actor
+ framework.
+- [`axum-insights`] provides `tracing` integration and Application insights export for the `axum` web framework.
+- [`tracing-gelf`] implements a subscriber for exporting traces in Greylog
+ GELF format.
+- [`tracing-coz`] provides integration with the [coz] causal profiler
+ (Linux-only).
+- [`test-log`] takes care of initializing `tracing` for tests, based on
+ environment variables with an `env_logger` compatible syntax.
+- [`tracing-unwrap`] provides convenience methods to report failed unwraps on `Result` or `Option` types to a `Subscriber`.
+- [`diesel-tracing`] provides integration with [`diesel`] database connections.
+- [`tracing-tracy`] provides a way to collect [Tracy] profiles in instrumented
+ applications.
+- [`tracing-elastic-apm`] provides a layer for reporting traces to [Elastic APM].
+- [`tracing-etw`] provides a layer for emitting Windows [ETW] events.
+- [`tracing-fluent-assertions`] provides a fluent assertions-style testing
+ framework for validating the behavior of `tracing` spans.
+- [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
+- [`tracing-loki`] provides a layer for shipping logs to [Grafana Loki].
+- [`tracing-logfmt`] provides a layer that formats events and spans into the logfmt format.
+
+If you're the maintainer of a `tracing` ecosystem crate not listed above,
+please let us know! We'd love to add your project to the list!
+
+[`tracing-timing`]: https://crates.io/crates/tracing-timing
+[`tracing-opentelemetry`]: https://crates.io/crates/tracing-opentelemetry
+[OpenTelemetry]: https://opentelemetry.io/
+[`tracing-honeycomb`]: https://crates.io/crates/tracing-honeycomb
+[`tracing-distributed`]: https://crates.io/crates/tracing-distributed
+[honeycomb.io]: https://www.honeycomb.io/
+[`tracing-actix`]: https://crates.io/crates/tracing-actix
+[`axum-insights`]: https://crates.io/crates/axum-insights
+[`tracing-gelf`]: https://crates.io/crates/tracing-gelf
+[`tracing-coz`]: https://crates.io/crates/tracing-coz
+[coz]: https://github.com/plasma-umass/coz
+[`test-log`]: https://crates.io/crates/test-log
+[`tracing-unwrap`]: https://docs.rs/tracing-unwrap
+[`diesel`]: https://crates.io/crates/diesel
+[`diesel-tracing`]: https://crates.io/crates/diesel-tracing
+[`tracing-tracy`]: https://crates.io/crates/tracing-tracy
+[Tracy]: https://github.com/wolfpld/tracy
+[`tracing-elastic-apm`]: https://crates.io/crates/tracing-elastic-apm
+[Elastic APM]: https://www.elastic.co/apm
+[`tracing-etw`]: https://github.com/microsoft/tracing-etw
+[ETW]: https://docs.microsoft.com/en-us/windows/win32/etw/about-event-tracing
+[`tracing-fluent-assertions`]: https://crates.io/crates/tracing-fluent-assertions
+[`sentry-tracing`]: https://crates.io/crates/sentry-tracing
+[Sentry]: https://sentry.io/welcome/
+[`tracing-loki`]: https://crates.io/crates/tracing-loki
+[Grafana Loki]: https://grafana.com/oss/loki/
+[`tracing-logfmt`]: https://crates.io/crates/tracing-logfmt
+
+**Note:** that some of the ecosystem crates are currently unreleased and
+undergoing active development. They may be less stable than `tracing` and
+`tracing-core`.
+
+[`log`]: https://docs.rs/log/0.4.6/log/
+[`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing
+[`tracing-futures`]: https://github.com/tokio-rs/tracing/tree/master/tracing-futures
+[`tracing-subscriber`]: https://github.com/tokio-rs/tracing/tree/master/tracing-subscriber
+[`tracing-log`]: https://github.com/tokio-rs/tracing/tree/master/tracing-log
+[`env_logger`]: https://crates.io/crates/env_logger
+[`FmtSubscriber`]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/struct.Subscriber.html
+[`examples`]: https://github.com/tokio-rs/tracing/tree/master/examples
+
+## Supported Rust Versions
+
+Tracing is built against the latest stable release. The minimum supported
+version is 1.56. The current Tracing version is not guaranteed to build on Rust
+versions earlier than the minimum supported version.
+
+Tracing follows the same compiler support policies as the rest of the Tokio
+project. The current stable Rust compiler and the three most recent minor
+versions before it will always be supported. For example, if the current stable
+compiler version is 1.69, the minimum supported version will not be increased
+past 1.66, three minor versions prior. Increasing the minimum supported compiler
+version is not considered a semver breaking change as long as doing so complies
+with this policy.
+
+## License
+
+This project is licensed under the [MIT license](LICENSE).
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in Tokio by you, shall be licensed as MIT, without any additional
+terms or conditions.
diff --git a/crates/tracing/benches/baseline.rs b/crates/tracing/benches/baseline.rs
new file mode 100644
index 0000000..93c14f4
--- /dev/null
+++ b/crates/tracing/benches/baseline.rs
@@ -0,0 +1,24 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+fn bench(c: &mut Criterion) {
+ use std::sync::atomic::{AtomicUsize, Ordering};
+
+ let mut group = c.benchmark_group("comparison");
+ group.bench_function("relaxed_load", |b| {
+ let foo = AtomicUsize::new(1);
+ b.iter(|| black_box(foo.load(Ordering::Relaxed)));
+ });
+ group.bench_function("acquire_load", |b| {
+ let foo = AtomicUsize::new(1);
+ b.iter(|| black_box(foo.load(Ordering::Acquire)))
+ });
+ group.bench_function("log", |b| {
+ b.iter(|| {
+ log::log!(log::Level::Info, "log");
+ })
+ });
+ group.finish();
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/dispatch_get_clone.rs b/crates/tracing/benches/dispatch_get_clone.rs
new file mode 100644
index 0000000..15577c6
--- /dev/null
+++ b/crates/tracing/benches/dispatch_get_clone.rs
@@ -0,0 +1,15 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_dispatches(&mut c.benchmark_group("Dispatch::get_clone"), |b| {
+ b.iter(|| {
+ let current = tracing::dispatcher::get_default(|current| current.clone());
+ black_box(current);
+ })
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/dispatch_get_ref.rs b/crates/tracing/benches/dispatch_get_ref.rs
new file mode 100644
index 0000000..a59c343
--- /dev/null
+++ b/crates/tracing/benches/dispatch_get_ref.rs
@@ -0,0 +1,16 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_dispatches(&mut c.benchmark_group("Dispatch::get_ref"), |b| {
+ b.iter(|| {
+ tracing::dispatcher::get_default(|current| {
+ black_box(¤t);
+ })
+ })
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/empty_span.rs b/crates/tracing/benches/empty_span.rs
new file mode 100644
index 0000000..fb38b08
--- /dev/null
+++ b/crates/tracing/benches/empty_span.rs
@@ -0,0 +1,43 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ let mut group = c.benchmark_group("empty_span");
+ shared::for_all_dispatches(&mut group, |b| {
+ b.iter(|| {
+ let span = tracing::span::Span::none();
+ black_box(&span);
+ })
+ });
+ group.bench_function("baseline_struct", |b| {
+ b.iter(|| {
+ let span = FakeEmptySpan::new();
+ black_box(&span);
+ })
+ });
+}
+
+struct FakeEmptySpan {
+ inner: Option<(usize, std::sync::Arc<()>)>,
+ meta: Option<&'static ()>,
+}
+
+impl FakeEmptySpan {
+ fn new() -> Self {
+ Self {
+ inner: None,
+ meta: None,
+ }
+ }
+}
+
+impl Drop for FakeEmptySpan {
+ fn drop(&mut self) {
+ black_box(&self.inner);
+ black_box(&self.meta);
+ }
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/enter_span.rs b/crates/tracing/benches/enter_span.rs
new file mode 100644
index 0000000..757350a
--- /dev/null
+++ b/crates/tracing/benches/enter_span.rs
@@ -0,0 +1,16 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tracing::{span, Level};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_dispatches(&mut c.benchmark_group("enter_span"), |b| {
+ let span = span!(Level::TRACE, "span");
+ b.iter(|| {
+ let _span = span.enter();
+ })
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/event.rs b/crates/tracing/benches/event.rs
new file mode 100644
index 0000000..1649325
--- /dev/null
+++ b/crates/tracing/benches/event.rs
@@ -0,0 +1,12 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_recording(&mut c.benchmark_group("event"), |b| {
+ b.iter(|| tracing::info!("hello world!"))
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/shared.rs b/crates/tracing/benches/shared.rs
new file mode 100644
index 0000000..56508c4
--- /dev/null
+++ b/crates/tracing/benches/shared.rs
@@ -0,0 +1,160 @@
+#![allow(dead_code)]
+use criterion::{black_box, measurement::WallTime, Bencher};
+use tracing::{field, span, Event, Id, Metadata};
+
+use std::{
+ fmt::{self, Write},
+ sync::{Mutex, MutexGuard},
+};
+
+pub fn for_all_recording(
+ group: &mut criterion::BenchmarkGroup<'_, WallTime>,
+ mut iter: impl FnMut(&mut Bencher<'_, WallTime>),
+) {
+ // first, run benchmarks with no subscriber
+ group.bench_function("none", &mut iter);
+
+ // then, run benchmarks with a scoped default subscriber
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ group.bench_function("scoped", &mut iter)
+ });
+
+ let subscriber = VisitingSubscriber(Mutex::new(String::from("")));
+ tracing::subscriber::with_default(subscriber, || {
+ group.bench_function("scoped_recording", &mut iter);
+ });
+
+ // finally, set a global default subscriber, and run the benchmarks again.
+ tracing::subscriber::set_global_default(EnabledSubscriber)
+ .expect("global default should not have already been set!");
+ let _ = log::set_logger(&NOP_LOGGER);
+ log::set_max_level(log::LevelFilter::Trace);
+ group.bench_function("global", &mut iter);
+}
+
+pub fn for_all_dispatches(
+ group: &mut criterion::BenchmarkGroup<'_, WallTime>,
+ mut iter: impl FnMut(&mut Bencher<'_, WallTime>),
+) {
+ // first, run benchmarks with no subscriber
+ group.bench_function("none", &mut iter);
+
+ // then, run benchmarks with a scoped default subscriber
+ tracing::subscriber::with_default(EnabledSubscriber, || {
+ group.bench_function("scoped", &mut iter)
+ });
+
+ // finally, set a global default subscriber, and run the benchmarks again.
+ tracing::subscriber::set_global_default(EnabledSubscriber)
+ .expect("global default should not have already been set!");
+ let _ = log::set_logger(&NOP_LOGGER);
+ log::set_max_level(log::LevelFilter::Trace);
+ group.bench_function("global", &mut iter);
+}
+
+const NOP_LOGGER: NopLogger = NopLogger;
+
+struct NopLogger;
+
+impl log::Log for NopLogger {
+ fn enabled(&self, _metadata: &log::Metadata) -> bool {
+ true
+ }
+
+ fn log(&self, record: &log::Record) {
+ if self.enabled(record.metadata()) {
+ let mut this = self;
+ let _ = write!(this, "{}", record.args());
+ }
+ }
+
+ fn flush(&self) {}
+}
+
+impl Write for &NopLogger {
+ fn write_str(&mut self, s: &str) -> std::fmt::Result {
+ black_box(s);
+ Ok(())
+ }
+}
+
+/// Simulates a subscriber that records span data.
+struct VisitingSubscriber(Mutex<String>);
+
+struct Visitor<'a>(MutexGuard<'a, String>);
+
+impl<'a> field::Visit for Visitor<'a> {
+ fn record_debug(&mut self, _field: &field::Field, value: &dyn fmt::Debug) {
+ let _ = write!(&mut *self.0, "{:?}", value);
+ }
+}
+
+impl tracing::Subscriber for VisitingSubscriber {
+ fn new_span(&self, span: &span::Attributes<'_>) -> Id {
+ let mut visitor = Visitor(self.0.lock().unwrap());
+ span.record(&mut visitor);
+ Id::from_u64(0xDEAD_FACE)
+ }
+
+ fn record(&self, _span: &Id, values: &span::Record<'_>) {
+ let mut visitor = Visitor(self.0.lock().unwrap());
+ values.record(&mut visitor);
+ }
+
+ fn event(&self, event: &Event<'_>) {
+ let mut visitor = Visitor(self.0.lock().unwrap());
+ event.record(&mut visitor);
+ }
+
+ fn record_follows_from(&self, span: &Id, follows: &Id) {
+ let _ = (span, follows);
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ let _ = metadata;
+ true
+ }
+
+ fn enter(&self, span: &Id) {
+ let _ = span;
+ }
+
+ fn exit(&self, span: &Id) {
+ let _ = span;
+ }
+}
+
+/// A subscriber that is enabled but otherwise does nothing.
+struct EnabledSubscriber;
+
+impl tracing::Subscriber for EnabledSubscriber {
+ fn new_span(&self, span: &span::Attributes<'_>) -> Id {
+ let _ = span;
+ Id::from_u64(0xDEAD_FACE)
+ }
+
+ fn event(&self, event: &Event<'_>) {
+ let _ = event;
+ }
+
+ fn record(&self, span: &Id, values: &span::Record<'_>) {
+ let _ = (span, values);
+ }
+
+ fn record_follows_from(&self, span: &Id, follows: &Id) {
+ let _ = (span, follows);
+ }
+
+ fn enabled(&self, metadata: &Metadata<'_>) -> bool {
+ let _ = metadata;
+ true
+ }
+
+ fn enter(&self, span: &Id) {
+ let _ = span;
+ }
+
+ fn exit(&self, span: &Id) {
+ let _ = span;
+ }
+}
diff --git a/crates/tracing/benches/span_fields.rs b/crates/tracing/benches/span_fields.rs
new file mode 100644
index 0000000..5ad8289
--- /dev/null
+++ b/crates/tracing/benches/span_fields.rs
@@ -0,0 +1,23 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tracing::{span, Level};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_recording(&mut c.benchmark_group("span_fields"), |b| {
+ b.iter(|| {
+ let span = span!(
+ Level::TRACE,
+ "span",
+ foo = "foo",
+ bar = "bar",
+ baz = 3,
+ quuux = tracing::field::debug(0.99)
+ );
+ criterion::black_box(span)
+ })
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/span_no_fields.rs b/crates/tracing/benches/span_no_fields.rs
new file mode 100644
index 0000000..8a1ff6e
--- /dev/null
+++ b/crates/tracing/benches/span_no_fields.rs
@@ -0,0 +1,13 @@
+use criterion::{criterion_group, criterion_main, Criterion};
+use tracing::{span, Level};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_recording(&mut c.benchmark_group("span_no_fields"), |b| {
+ b.iter(|| span!(Level::TRACE, "span"))
+ });
+}
+
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/benches/span_repeated.rs b/crates/tracing/benches/span_repeated.rs
new file mode 100644
index 0000000..4c6ac40
--- /dev/null
+++ b/crates/tracing/benches/span_repeated.rs
@@ -0,0 +1,20 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use tracing::{span, Level};
+
+mod shared;
+
+fn bench(c: &mut Criterion) {
+ shared::for_all_recording(&mut c.benchmark_group("span_repeated"), |b| {
+ let n = black_box(N_SPANS);
+ b.iter(|| (0..n).fold(mk_span(0), |_, i| mk_span(i as u64)))
+ });
+}
+
+#[inline]
+fn mk_span(i: u64) -> tracing::Span {
+ span!(Level::TRACE, "span", i = i)
+}
+
+const N_SPANS: usize = 100;
+criterion_group!(benches, bench);
+criterion_main!(benches);
diff --git a/crates/tracing/cargo_embargo.json b/crates/tracing/cargo_embargo.json
new file mode 100644
index 0000000..33fc981
--- /dev/null
+++ b/crates/tracing/cargo_embargo.json
@@ -0,0 +1,15 @@
+{
+ "run_cargo": false,
+ "variants": [
+ {},
+ {
+ "features": [
+ "max_level_off",
+ "release_max_level_off"
+ ],
+ "module_name_overrides": {
+ "libtracing": "libtracing_max_level_off"
+ }
+ }
+ ]
+}
diff --git a/crates/tracing/src/dispatcher.rs b/crates/tracing/src/dispatcher.rs
new file mode 100644
index 0000000..a84b99f
--- /dev/null
+++ b/crates/tracing/src/dispatcher.rs
@@ -0,0 +1,145 @@
+//! Dispatches trace events to [`Subscriber`]s.
+//!
+//! The _dispatcher_ is the component of the tracing system which is responsible
+//! for forwarding trace data from the instrumentation points that generate it
+//! to the subscriber that collects it.
+//!
+//! # Using the Trace Dispatcher
+//!
+//! Every thread in a program using `tracing` has a _default subscriber_. When
+//! events occur, or spans are created, they are dispatched to the thread's
+//! current subscriber.
+//!
+//! ## Setting the Default Subscriber
+//!
+//! By default, the current subscriber is an empty implementation that does
+//! nothing. To use a subscriber implementation, it must be set as the default.
+//! There are two methods for doing so: [`with_default`] and
+//! [`set_global_default`]. `with_default` sets the default subscriber for the
+//! duration of a scope, while `set_global_default` sets a default subscriber
+//! for the entire process.
+//!
+//! To use either of these functions, we must first wrap our subscriber in a
+//! [`Dispatch`], a cloneable, type-erased reference to a subscriber. For
+//! example:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! use dispatcher::Dispatch;
+//!
+//! let my_subscriber = FooSubscriber::new();
+//! let my_dispatch = Dispatch::new(my_subscriber);
+//! ```
+//! Then, we can use [`with_default`] to set our `Dispatch` as the default for
+//! the duration of a block:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! # let my_subscriber = FooSubscriber::new();
+//! # let my_dispatch = dispatcher::Dispatch::new(my_subscriber);
+//! // no default subscriber
+//!
+//! # #[cfg(feature = "std")]
+//! dispatcher::with_default(&my_dispatch, || {
+//! // my_subscriber is the default
+//! });
+//!
+//! // no default subscriber again
+//! ```
+//! It's important to note that `with_default` will not propagate the current
+//! thread's default subscriber to any threads spawned within the `with_default`
+//! block. To propagate the default subscriber to new threads, either use
+//! `with_default` from the new thread, or use `set_global_default`.
+//!
+//! As an alternative to `with_default`, we can use [`set_global_default`] to
+//! set a `Dispatch` as the default for all threads, for the lifetime of the
+//! program. For example:
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing_core::{
+//! # dispatcher, Event, Metadata,
+//! # span::{Attributes, Id, Record}
+//! # };
+//! # impl tracing_core::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber { fn new() -> Self { FooSubscriber } }
+//! # let my_subscriber = FooSubscriber::new();
+//! # let my_dispatch = dispatcher::Dispatch::new(my_subscriber);
+//! // no default subscriber
+//!
+//! dispatcher::set_global_default(my_dispatch)
+//! // `set_global_default` will return an error if the global default
+//! // subscriber has already been set.
+//! .expect("global default was already set!");
+//!
+//! // `my_subscriber` is now the default
+//! ```
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: The thread-local scoped dispatcher (<code>with_default</code>)
+//! requires the Rust standard library. <code>no_std</code> users should
+//! use <a href="fn.set_global_default.html"><code>set_global_default</code></a>
+//! instead.
+//! </pre>
+//!
+//! ## Accessing the Default Subscriber
+//!
+//! A thread's current default subscriber can be accessed using the
+//! [`get_default`] function, which executes a closure with a reference to the
+//! currently default `Dispatch`. This is used primarily by `tracing`
+//! instrumentation.
+//!
+//! [`Subscriber`]: crate::Subscriber
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub use tracing_core::dispatcher::set_default;
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub use tracing_core::dispatcher::with_default;
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub use tracing_core::dispatcher::DefaultGuard;
+pub use tracing_core::dispatcher::{
+ get_default, set_global_default, Dispatch, SetGlobalDefaultError, WeakDispatch,
+};
+
+/// Private API for internal use by tracing's macros.
+///
+/// This function is *not* considered part of `tracing`'s public API, and has no
+/// stability guarantees. If you use it, and it breaks or disappears entirely,
+/// don't say we didn;'t warn you.
+#[doc(hidden)]
+pub use tracing_core::dispatcher::has_been_set;
diff --git a/crates/tracing/src/field.rs b/crates/tracing/src/field.rs
new file mode 100644
index 0000000..ea8e373
--- /dev/null
+++ b/crates/tracing/src/field.rs
@@ -0,0 +1,170 @@
+//! `Span` and `Event` key-value data.
+//!
+//! Spans and events may be annotated with key-value data, referred to as _fields_.
+//! These fields consist of a mapping from a key (corresponding to
+//! a `&str` but represented internally as an array index) to a [`Value`].
+//!
+//! # `Value`s and `Subscriber`s
+//!
+//! `Subscriber`s consume `Value`s as fields attached to [span]s or [`Event`]s.
+//! The set of field keys on a given span or event is defined on its [`Metadata`].
+//! When a span is created, it provides [`Attributes`] to the `Subscriber`'s
+//! [`new_span`] method, containing any fields whose values were provided when
+//! the span was created; and may call the `Subscriber`'s [`record`] method
+//! with additional [`Record`]s if values are added for more of its fields.
+//! Similarly, the [`Event`] type passed to the subscriber's [`event`] method
+//! will contain any fields attached to each event.
+//!
+//! `tracing` represents values as either one of a set of Rust primitives
+//! (`i64`, `u64`, `f64`, `bool`, and `&str`) or using a `fmt::Display` or
+//! `fmt::Debug` implementation. `Subscriber`s are provided these primitive
+//! value types as `dyn Value` trait objects.
+//!
+//! These trait objects can be formatted using `fmt::Debug`, but may also be
+//! recorded as typed data by calling the [`Value::record`] method on these
+//! trait objects with a _visitor_ implementing the [`Visit`] trait. This trait
+//! represents the behavior used to record values of various types. For example,
+//! an implementation of `Visit` might record integers by incrementing counters
+//! for their field names rather than printing them.
+//!
+//!
+//! # Using `valuable`
+//!
+//! `tracing`'s [`Value`] trait is intentionally minimalist: it supports only a small
+//! number of Rust primitives as typed values, and only permits recording
+//! user-defined types with their [`fmt::Debug`] or [`fmt::Display`]
+//! implementations. However, there are some cases where it may be useful to record
+//! nested values (such as arrays, `Vec`s, or `HashMap`s containing values), or
+//! user-defined `struct` and `enum` types without having to format them as
+//! unstructured text.
+//!
+//! To address `Value`'s limitations, `tracing` offers experimental support for
+//! the [`valuable`] crate, which provides object-safe inspection of structured
+//! values. User-defined types can implement the [`valuable::Valuable`] trait,
+//! and be recorded as a `tracing` field by calling their [`as_value`] method.
+//! If the [`Subscriber`] also supports the `valuable` crate, it can
+//! then visit those types fields as structured values using `valuable`.
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: <code>valuable</code> support is an
+//! <a href = "../index.html#unstable-features">unstable feature</a>. See
+//! the documentation on unstable features for details on how to enable it.
+//! </pre>
+//!
+//! For example:
+//! ```ignore
+//! // Derive `Valuable` for our types:
+//! use valuable::Valuable;
+//!
+//! #[derive(Clone, Debug, Valuable)]
+//! struct User {
+//! name: String,
+//! age: u32,
+//! address: Address,
+//! }
+//!
+//! #[derive(Clone, Debug, Valuable)]
+//! struct Address {
+//! country: String,
+//! city: String,
+//! street: String,
+//! }
+//!
+//! let user = User {
+//! name: "Arwen Undomiel".to_string(),
+//! age: 3000,
+//! address: Address {
+//! country: "Middle Earth".to_string(),
+//! city: "Rivendell".to_string(),
+//! street: "leafy lane".to_string(),
+//! },
+//! };
+//!
+//! // Recording `user` as a `valuable::Value` will allow the `tracing` subscriber
+//! // to traverse its fields as a nested, typed structure:
+//! tracing::info!(current_user = user.as_value());
+//! ```
+//!
+//! Alternatively, the [`valuable()`] function may be used to convert a type
+//! implementing [`Valuable`] into a `tracing` field value.
+//!
+//! When the `valuable` feature is enabled, the [`Visit`] trait will include an
+//! optional [`record_value`] method. `Visit` implementations that wish to
+//! record `valuable` values can implement this method with custom behavior.
+//! If a visitor does not implement `record_value`, the [`valuable::Value`] will
+//! be forwarded to the visitor's [`record_debug`] method.
+//!
+//! [`fmt::Debug`]: std::fmt::Debug
+//! [`fmt::Display`]: std::fmt::Debug
+//! [`valuable`]: https://crates.io/crates/valuable
+//! [`valuable::Valuable`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html
+//! [`as_value`]: https://docs.rs/valuable/latest/valuable/trait.Valuable.html#tymethod.as_value
+//! [`valuable::Value`]: https://docs.rs/valuable/latest/valuable/enum.Value.html
+//! [`Subscriber`]: crate::Subscriber
+//! [`record_value`]: Visit::record_value
+//! [`record_debug`]: Visit::record_debug
+//! [span]: mod@crate::span
+//! [`Event`]: crate::event::Event
+//! [`Metadata`]: crate::Metadata
+//! [`Attributes`]: crate::span::Attributes
+//! [`Record`]: crate::span::Record
+//! [`new_span`]: crate::Subscriber::new_span
+//! [`record`]: crate::Subscriber::record
+//! [`event`]: crate::Subscriber::event
+pub use tracing_core::field::*;
+
+use crate::Metadata;
+
+/// Trait implemented to allow a type to be used as a field key.
+///
+/// <pre class="ignore" style="white-space:normal;font:inherit;">
+/// <strong>Note</strong>: Although this is implemented for both the
+/// <a href="./struct.Field.html"><code>Field</code></a> type <em>and</em> any
+/// type that can be borrowed as an <code>&str</code>, only <code>Field</code>
+/// allows <em>O</em>(1) access.
+/// Indexing a field with a string results in an iterative search that performs
+/// string comparisons. Thus, if possible, once the key for a field is known, it
+/// should be used whenever possible.
+/// </pre>
+pub trait AsField: crate::sealed::Sealed {
+ /// Attempts to convert `&self` into a `Field` with the specified `metadata`.
+ ///
+ /// If `metadata` defines this field, then the field is returned. Otherwise,
+ /// this returns `None`.
+ fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field>;
+}
+
+// ===== impl AsField =====
+
+impl AsField for Field {
+ #[inline]
+ fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field> {
+ if self.callsite() == metadata.callsite() {
+ Some(self.clone())
+ } else {
+ None
+ }
+ }
+}
+
+impl<'a> AsField for &'a Field {
+ #[inline]
+ fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field> {
+ if self.callsite() == metadata.callsite() {
+ Some((*self).clone())
+ } else {
+ None
+ }
+ }
+}
+
+impl AsField for str {
+ #[inline]
+ fn as_field(&self, metadata: &Metadata<'_>) -> Option<Field> {
+ metadata.fields().field(&self)
+ }
+}
+
+impl crate::sealed::Sealed for Field {}
+impl<'a> crate::sealed::Sealed for &'a Field {}
+impl crate::sealed::Sealed for str {}
diff --git a/crates/tracing/src/instrument.rs b/crates/tracing/src/instrument.rs
new file mode 100644
index 0000000..87c7401
--- /dev/null
+++ b/crates/tracing/src/instrument.rs
@@ -0,0 +1,429 @@
+use crate::{
+ dispatcher::{self, Dispatch},
+ span::Span,
+};
+use core::{
+ future::Future,
+ marker::Sized,
+ mem::ManuallyDrop,
+ pin::Pin,
+ task::{Context, Poll},
+};
+use pin_project_lite::pin_project;
+
+/// Attaches spans to a [`std::future::Future`].
+///
+/// Extension trait allowing futures to be
+/// instrumented with a `tracing` [span].
+///
+/// [span]: super::Span
+pub trait Instrument: Sized {
+ /// Instruments this type with the provided [`Span`], returning an
+ /// `Instrumented` wrapper.
+ ///
+ /// The attached [`Span`] will be [entered] every time the instrumented
+ /// [`Future`] is polled or [`Drop`]ped.
+ ///
+ /// # Examples
+ ///
+ /// Instrumenting a future:
+ ///
+ /// ```rust
+ /// use tracing::Instrument;
+ ///
+ /// # async fn doc() {
+ /// let my_future = async {
+ /// // ...
+ /// };
+ ///
+ /// my_future
+ /// .instrument(tracing::info_span!("my_future"))
+ /// .await
+ /// # }
+ /// ```
+ ///
+ /// The [`Span::or_current`] combinator can be used in combination with
+ /// `instrument` to ensure that the [current span] is attached to the
+ /// future if the span passed to `instrument` is [disabled]:
+ ///
+ /// ```
+ /// use tracing::Instrument;
+ /// # mod tokio {
+ /// # pub(super) fn spawn(_: impl std::future::Future) {}
+ /// # }
+ ///
+ /// let my_future = async {
+ /// // ...
+ /// };
+ ///
+ /// let outer_span = tracing::info_span!("outer").entered();
+ ///
+ /// // If the "my_future" span is enabled, then the spawned task will
+ /// // be within both "my_future" *and* "outer", since "outer" is
+ /// // "my_future"'s parent. However, if "my_future" is disabled,
+ /// // the spawned task will *not* be in any span.
+ /// tokio::spawn(
+ /// my_future
+ /// .instrument(tracing::debug_span!("my_future"))
+ /// );
+ ///
+ /// // Using `Span::or_current` ensures the spawned task is instrumented
+ /// // with the current span, if the new span passed to `instrument` is
+ /// // not enabled. This means that if the "my_future" span is disabled,
+ /// // the spawned task will still be instrumented with the "outer" span:
+ /// # let my_future = async {};
+ /// tokio::spawn(
+ /// my_future
+ /// .instrument(tracing::debug_span!("my_future").or_current())
+ /// );
+ /// ```
+ ///
+ /// [entered]: super::Span::enter()
+ /// [`Span::or_current`]: super::Span::or_current()
+ /// [current span]: super::Span::current()
+ /// [disabled]: super::Span::is_disabled()
+ /// [`Future`]: std::future::Future
+ fn instrument(self, span: Span) -> Instrumented<Self> {
+ Instrumented {
+ inner: ManuallyDrop::new(self),
+ span,
+ }
+ }
+
+ /// Instruments this type with the [current] [`Span`], returning an
+ /// `Instrumented` wrapper.
+ ///
+ /// The attached [`Span`] will be [entered] every time the instrumented
+ /// [`Future`] is polled or [`Drop`]ped.
+ ///
+ /// This can be used to propagate the current span when spawning a new future.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use tracing::Instrument;
+ ///
+ /// # mod tokio {
+ /// # pub(super) fn spawn(_: impl std::future::Future) {}
+ /// # }
+ /// # async fn doc() {
+ /// let span = tracing::info_span!("my_span");
+ /// let _enter = span.enter();
+ ///
+ /// // ...
+ ///
+ /// let future = async {
+ /// tracing::debug!("this event will occur inside `my_span`");
+ /// // ...
+ /// };
+ /// tokio::spawn(future.in_current_span());
+ /// # }
+ /// ```
+ ///
+ /// [current]: super::Span::current()
+ /// [entered]: super::Span::enter()
+ /// [`Span`]: crate::Span
+ /// [`Future`]: std::future::Future
+ #[inline]
+ fn in_current_span(self) -> Instrumented<Self> {
+ self.instrument(Span::current())
+ }
+}
+
+/// Extension trait allowing futures to be instrumented with
+/// a `tracing` [`Subscriber`](crate::Subscriber).
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub trait WithSubscriber: Sized {
+ /// Attaches the provided [`Subscriber`] to this type, returning a
+ /// [`WithDispatch`] wrapper.
+ ///
+ /// The attached [`Subscriber`] will be set as the [default] when the returned
+ /// [`Future`] is polled.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::subscriber::NoSubscriber as MySubscriber;
+ /// # use tracing::subscriber::NoSubscriber as MyOtherSubscriber;
+ /// # async fn docs() {
+ /// use tracing::instrument::WithSubscriber;
+ ///
+ /// // Set the default `Subscriber`
+ /// let _default = tracing::subscriber::set_default(MySubscriber::default());
+ ///
+ /// tracing::info!("this event will be recorded by the default `Subscriber`");
+ ///
+ /// // Create a different `Subscriber` and attach it to a future.
+ /// let other_subscriber = MyOtherSubscriber::default();
+ /// let future = async {
+ /// tracing::info!("this event will be recorded by the other `Subscriber`");
+ /// // ...
+ /// };
+ ///
+ /// future
+ /// // Attach the other `Subscriber` to the future before awaiting it
+ /// .with_subscriber(other_subscriber)
+ /// .await;
+ ///
+ /// // Once the future has completed, we return to the default `Subscriber`.
+ /// tracing::info!("this event will be recorded by the default `Subscriber`");
+ /// # }
+ /// ```
+ ///
+ /// [`Subscriber`]: super::Subscriber
+ /// [default]: crate::dispatcher#setting-the-default-subscriber
+ /// [`Future`]: std::future::Future
+ fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
+ where
+ S: Into<Dispatch>,
+ {
+ WithDispatch {
+ inner: self,
+ dispatcher: subscriber.into(),
+ }
+ }
+
+ /// Attaches the current [default] [`Subscriber`] to this type, returning a
+ /// [`WithDispatch`] wrapper.
+ ///
+ /// The attached `Subscriber` will be set as the [default] when the returned
+ /// [`Future`] is polled.
+ ///
+ /// This can be used to propagate the current dispatcher context when
+ /// spawning a new future that may run on a different thread.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # mod tokio {
+ /// # pub(super) fn spawn(_: impl std::future::Future) {}
+ /// # }
+ /// # use tracing::subscriber::NoSubscriber as MySubscriber;
+ /// # async fn docs() {
+ /// use tracing::instrument::WithSubscriber;
+ ///
+ /// // Using `set_default` (rather than `set_global_default`) sets the
+ /// // default `Subscriber` for *this* thread only.
+ /// let _default = tracing::subscriber::set_default(MySubscriber::default());
+ ///
+ /// let future = async {
+ /// // ...
+ /// };
+ ///
+ /// // If a multi-threaded async runtime is in use, this spawned task may
+ /// // run on a different thread, in a different default `Subscriber`'s context.
+ /// tokio::spawn(future);
+ ///
+ /// // However, calling `with_current_subscriber` on the future before
+ /// // spawning it, ensures that the current thread's default `Subscriber` is
+ /// // propagated to the spawned task, regardless of where it executes:
+ /// # let future = async { };
+ /// tokio::spawn(future.with_current_subscriber());
+ /// # }
+ /// ```
+ /// [`Subscriber`]: super::Subscriber
+ /// [default]: crate::dispatcher#setting-the-default-subscriber
+ /// [`Future`]: std::future::Future
+ #[inline]
+ fn with_current_subscriber(self) -> WithDispatch<Self> {
+ WithDispatch {
+ inner: self,
+ dispatcher: crate::dispatcher::get_default(|default| default.clone()),
+ }
+ }
+}
+
+pin_project! {
+ /// A [`Future`] that has been instrumented with a `tracing` [`Subscriber`].
+ ///
+ /// This type is returned by the [`WithSubscriber`] extension trait. See that
+ /// trait's documentation for details.
+ ///
+ /// [`Future`]: std::future::Future
+ /// [`Subscriber`]: crate::Subscriber
+ #[derive(Clone, Debug)]
+ #[must_use = "futures do nothing unless you `.await` or poll them"]
+ #[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+ pub struct WithDispatch<T> {
+ #[pin]
+ inner: T,
+ dispatcher: Dispatch,
+ }
+}
+
+pin_project! {
+ /// A [`Future`] that has been instrumented with a `tracing` [`Span`].
+ ///
+ /// This type is returned by the [`Instrument`] extension trait. See that
+ /// trait's documentation for details.
+ ///
+ /// [`Future`]: std::future::Future
+ /// [`Span`]: crate::Span
+ #[project = InstrumentedProj]
+ #[project_ref = InstrumentedProjRef]
+ #[derive(Debug, Clone)]
+ #[must_use = "futures do nothing unless you `.await` or poll them"]
+ pub struct Instrumented<T> {
+ // `ManuallyDrop` is used here to to enter instrument `Drop` by entering
+ // `Span` and executing `ManuallyDrop::drop`.
+ #[pin]
+ inner: ManuallyDrop<T>,
+ span: Span,
+ }
+
+ impl<T> PinnedDrop for Instrumented<T> {
+ fn drop(this: Pin<&mut Self>) {
+ let this = this.project();
+ let _enter = this.span.enter();
+ // SAFETY: 1. `Pin::get_unchecked_mut()` is safe, because this isn't
+ // different from wrapping `T` in `Option` and calling
+ // `Pin::set(&mut this.inner, None)`, except avoiding
+ // additional memory overhead.
+ // 2. `ManuallyDrop::drop()` is safe, because
+ // `PinnedDrop::drop()` is guaranteed to be called only
+ // once.
+ unsafe { ManuallyDrop::drop(this.inner.get_unchecked_mut()) }
+ }
+ }
+}
+
+impl<'a, T> InstrumentedProj<'a, T> {
+ /// Get a mutable reference to the [`Span`] a pinned mutable reference to
+ /// the wrapped type.
+ fn span_and_inner_pin_mut(self) -> (&'a mut Span, Pin<&'a mut T>) {
+ // SAFETY: As long as `ManuallyDrop<T>` does not move, `T` won't move
+ // and `inner` is valid, because `ManuallyDrop::drop` is called
+ // only inside `Drop` of the `Instrumented`.
+ let inner = unsafe { self.inner.map_unchecked_mut(|v| &mut **v) };
+ (self.span, inner)
+ }
+}
+
+impl<'a, T> InstrumentedProjRef<'a, T> {
+ /// Get a reference to the [`Span`] a pinned reference to the wrapped type.
+ fn span_and_inner_pin_ref(self) -> (&'a Span, Pin<&'a T>) {
+ // SAFETY: As long as `ManuallyDrop<T>` does not move, `T` won't move
+ // and `inner` is valid, because `ManuallyDrop::drop` is called
+ // only inside `Drop` of the `Instrumented`.
+ let inner = unsafe { self.inner.map_unchecked(|v| &**v) };
+ (self.span, inner)
+ }
+}
+
+// === impl Instrumented ===
+
+impl<T: Future> Future for Instrumented<T> {
+ type Output = T::Output;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let (span, inner) = self.project().span_and_inner_pin_mut();
+ let _enter = span.enter();
+ inner.poll(cx)
+ }
+}
+
+impl<T: Sized> Instrument for T {}
+
+impl<T> Instrumented<T> {
+ /// Borrows the `Span` that this type is instrumented by.
+ pub fn span(&self) -> &Span {
+ &self.span
+ }
+
+ /// Mutably borrows the `Span` that this type is instrumented by.
+ pub fn span_mut(&mut self) -> &mut Span {
+ &mut self.span
+ }
+
+ /// Borrows the wrapped type.
+ pub fn inner(&self) -> &T {
+ &self.inner
+ }
+
+ /// Mutably borrows the wrapped type.
+ pub fn inner_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Get a pinned reference to the wrapped type.
+ pub fn inner_pin_ref(self: Pin<&Self>) -> Pin<&T> {
+ self.project_ref().span_and_inner_pin_ref().1
+ }
+
+ /// Get a pinned mutable reference to the wrapped type.
+ pub fn inner_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
+ self.project().span_and_inner_pin_mut().1
+ }
+
+ /// Consumes the `Instrumented`, returning the wrapped type.
+ ///
+ /// Note that this drops the span.
+ pub fn into_inner(self) -> T {
+ // To manually destructure `Instrumented` without `Drop`, we
+ // move it into a ManuallyDrop and use pointers to its fields
+ let this = ManuallyDrop::new(self);
+ let span: *const Span = &this.span;
+ let inner: *const ManuallyDrop<T> = &this.inner;
+ // SAFETY: Those pointers are valid for reads, because `Drop` didn't
+ // run, and properly aligned, because `Instrumented` isn't
+ // `#[repr(packed)]`.
+ let _span = unsafe { span.read() };
+ let inner = unsafe { inner.read() };
+ ManuallyDrop::into_inner(inner)
+ }
+}
+
+// === impl WithDispatch ===
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl<T: Future> Future for WithDispatch<T> {
+ type Output = T::Output;
+
+ fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
+ let this = self.project();
+ let dispatcher = this.dispatcher;
+ let future = this.inner;
+ let _default = dispatcher::set_default(dispatcher);
+ future.poll(cx)
+ }
+}
+
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl<T: Sized> WithSubscriber for T {}
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+impl<T> WithDispatch<T> {
+ /// Borrows the [`Dispatch`] that is entered when this type is polled.
+ pub fn dispatcher(&self) -> &Dispatch {
+ &self.dispatcher
+ }
+
+ /// Borrows the wrapped type.
+ pub fn inner(&self) -> &T {
+ &self.inner
+ }
+
+ /// Mutably borrows the wrapped type.
+ pub fn inner_mut(&mut self) -> &mut T {
+ &mut self.inner
+ }
+
+ /// Get a pinned reference to the wrapped type.
+ pub fn inner_pin_ref(self: Pin<&Self>) -> Pin<&T> {
+ self.project_ref().inner
+ }
+
+ /// Get a pinned mutable reference to the wrapped type.
+ pub fn inner_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T> {
+ self.project().inner
+ }
+
+ /// Consumes the `Instrumented`, returning the wrapped type.
+ ///
+ /// Note that this drops the span.
+ pub fn into_inner(self) -> T {
+ self.inner
+ }
+}
diff --git a/crates/tracing/src/level_filters.rs b/crates/tracing/src/level_filters.rs
new file mode 100644
index 0000000..4e56ada
--- /dev/null
+++ b/crates/tracing/src/level_filters.rs
@@ -0,0 +1,98 @@
+//! Trace verbosity level filtering.
+//!
+//! # Compile time filters
+//!
+//! Trace verbosity levels can be statically disabled at compile time via Cargo
+//! features, similar to the [`log` crate]. Trace instrumentation at disabled
+//! levels will be skipped and will not even be present in the resulting binary
+//! unless the verbosity level is specified dynamically. This level is
+//! configured separately for release and debug builds. The features are:
+//!
+//! * `max_level_off`
+//! * `max_level_error`
+//! * `max_level_warn`
+//! * `max_level_info`
+//! * `max_level_debug`
+//! * `max_level_trace`
+//! * `release_max_level_off`
+//! * `release_max_level_error`
+//! * `release_max_level_warn`
+//! * `release_max_level_info`
+//! * `release_max_level_debug`
+//! * `release_max_level_trace`
+//!
+//! These features control the value of the `STATIC_MAX_LEVEL` constant. The
+//! instrumentation macros macros check this value before recording an event or
+//! constructing a span. By default, no levels are disabled.
+//!
+//! For example, a crate can disable trace level instrumentation in debug builds
+//! and trace, debug, and info level instrumentation in release builds with the
+//! following configuration:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing = { version = "0.1", features = ["max_level_debug", "release_max_level_warn"] }
+//! ```
+//! ## Notes
+//!
+//! Please note that `tracing`'s static max level features do *not* control the
+//! [`log`] records that may be emitted when [`tracing`'s "log" feature flag][f] is
+//! enabled. This is to allow `tracing` to be disabled entirely at compile time
+//! while still emitting `log` records --- such as when a library using
+//! `tracing` is used by an application using `log` that doesn't want to
+//! generate any `tracing`-related code, but does want to collect `log` records.
+//!
+//! This means that if the "log" feature is in use, some code may be generated
+//! for `log` records emitted by disabled `tracing` events. If this is not
+//! desirable, `log` records may be disabled separately using [`log`'s static
+//! max level features][`log` crate].
+//!
+//! [`log`]: https://docs.rs/log/
+//! [`log` crate]: https://docs.rs/log/latest/log/#compile-time-filters
+//! [f]: https://docs.rs/tracing/latest/tracing/#emitting-log-records
+pub use tracing_core::{metadata::ParseLevelFilterError, LevelFilter};
+
+/// The statically configured maximum trace level.
+///
+/// See the [module-level documentation] for information on how to configure
+/// this.
+///
+/// This value is checked by the `event!` and `span!` macros. Code that
+/// manually constructs events or spans via the `Event::record` function or
+/// `Span` constructors should compare the level against this value to
+/// determine if those spans or events are enabled.
+///
+/// [module-level documentation]: self#compile-time-filters
+pub const STATIC_MAX_LEVEL: LevelFilter = get_max_level_inner();
+
+const fn get_max_level_inner() -> LevelFilter {
+ if cfg!(not(debug_assertions)) {
+ if cfg!(feature = "release_max_level_off") {
+ LevelFilter::OFF
+ } else if cfg!(feature = "release_max_level_error") {
+ LevelFilter::ERROR
+ } else if cfg!(feature = "release_max_level_warn") {
+ LevelFilter::WARN
+ } else if cfg!(feature = "release_max_level_info") {
+ LevelFilter::INFO
+ } else if cfg!(feature = "release_max_level_debug") {
+ LevelFilter::DEBUG
+ } else {
+ // Same as branch cfg!(feature = "release_max_level_trace")
+ LevelFilter::TRACE
+ }
+ } else if cfg!(feature = "max_level_off") {
+ LevelFilter::OFF
+ } else if cfg!(feature = "max_level_error") {
+ LevelFilter::ERROR
+ } else if cfg!(feature = "max_level_warn") {
+ LevelFilter::WARN
+ } else if cfg!(feature = "max_level_info") {
+ LevelFilter::INFO
+ } else if cfg!(feature = "max_level_debug") {
+ LevelFilter::DEBUG
+ } else {
+ // Same as branch cfg!(feature = "max_level_trace")
+ LevelFilter::TRACE
+ }
+}
diff --git a/crates/tracing/src/lib.rs b/crates/tracing/src/lib.rs
new file mode 100644
index 0000000..258cbe5
--- /dev/null
+++ b/crates/tracing/src/lib.rs
@@ -0,0 +1,1125 @@
+//! A scoped, structured logging and diagnostics system.
+//!
+//! # Overview
+//!
+//! `tracing` is a framework for instrumenting Rust programs to collect
+//! structured, event-based diagnostic information.
+//!
+//! In asynchronous systems like Tokio, interpreting traditional log messages can
+//! often be quite challenging. Since individual tasks are multiplexed on the same
+//! thread, associated events and log lines are intermixed making it difficult to
+//! trace the logic flow. `tracing` expands upon logging-style diagnostics by
+//! allowing libraries and applications to record structured events with additional
+//! information about *temporality* and *causality* — unlike a log message, a span
+//! in `tracing` has a beginning and end time, may be entered and exited by the
+//! flow of execution, and may exist within a nested tree of similar spans. In
+//! addition, `tracing` spans are *structured*, with the ability to record typed
+//! data as well as textual messages.
+//!
+//! The `tracing` crate provides the APIs necessary for instrumenting libraries
+//! and applications to emit trace data.
+//!
+//! *Compiler support: [requires `rustc` 1.56+][msrv]*
+//!
+//! [msrv]: #supported-rust-versions
+//! # Core Concepts
+//!
+//! The core of `tracing`'s API is composed of _spans_, _events_ and
+//! _subscribers_. We'll cover these in turn.
+//!
+//! ## Spans
+//!
+//! To record the flow of execution through a program, `tracing` introduces the
+//! concept of [spans]. Unlike a log line that represents a _moment in
+//! time_, a span represents a _period of time_ with a beginning and an end. When a
+//! program begins executing in a context or performing a unit of work, it
+//! _enters_ that context's span, and when it stops executing in that context,
+//! it _exits_ the span. The span in which a thread is currently executing is
+//! referred to as that thread's _current_ span.
+//!
+//! For example:
+//! ```
+//! use tracing::{span, Level};
+//! # fn main() {
+//! let span = span!(Level::TRACE, "my_span");
+//! // `enter` returns a RAII guard which, when dropped, exits the span. this
+//! // indicates that we are in the span for the current lexical scope.
+//! let _enter = span.enter();
+//! // perform some work in the context of `my_span`...
+//! # }
+//!```
+//!
+//! The [`span` module][span]'s documentation provides further details on how to
+//! use spans.
+//!
+//! <div class="example-wrap" style="display:inline-block"><pre class="compile_fail" style="white-space:normal;font:inherit;">
+//!
+//! **Warning**: In asynchronous code that uses async/await syntax,
+//! `Span::enter` may produce incorrect traces if the returned drop
+//! guard is held across an await point. See
+//! [the method documentation][Span#in-asynchronous-code] for details.
+//!
+//! </pre></div>
+//!
+//! ## Events
+//!
+//! An [`Event`] represents a _moment_ in time. It signifies something that
+//! happened while a trace was being recorded. `Event`s are comparable to the log
+//! records emitted by unstructured logging code, but unlike a typical log line,
+//! an `Event` may occur within the context of a span.
+//!
+//! For example:
+//! ```
+//! use tracing::{event, span, Level};
+//!
+//! # fn main() {
+//! // records an event outside of any span context:
+//! event!(Level::INFO, "something happened");
+//!
+//! let span = span!(Level::INFO, "my_span");
+//! let _guard = span.enter();
+//!
+//! // records an event within "my_span".
+//! event!(Level::DEBUG, "something happened inside my_span");
+//! # }
+//!```
+//!
+//! In general, events should be used to represent points in time _within_ a
+//! span — a request returned with a given status code, _n_ new items were
+//! taken from a queue, and so on.
+//!
+//! The [`Event` struct][`Event`] documentation provides further details on using
+//! events.
+//!
+//! ## Subscribers
+//!
+//! As `Span`s and `Event`s occur, they are recorded or aggregated by
+//! implementations of the [`Subscriber`] trait. `Subscriber`s are notified
+//! when an `Event` takes place and when a `Span` is entered or exited. These
+//! notifications are represented by the following `Subscriber` trait methods:
+//!
+//! + [`event`][Subscriber::event], called when an `Event` takes place,
+//! + [`enter`], called when execution enters a `Span`,
+//! + [`exit`], called when execution exits a `Span`
+//!
+//! In addition, subscribers may implement the [`enabled`] function to _filter_
+//! the notifications they receive based on [metadata] describing each `Span`
+//! or `Event`. If a call to `Subscriber::enabled` returns `false` for a given
+//! set of metadata, that `Subscriber` will *not* be notified about the
+//! corresponding `Span` or `Event`. For performance reasons, if no currently
+//! active subscribers express interest in a given set of metadata by returning
+//! `true`, then the corresponding `Span` or `Event` will never be constructed.
+//!
+//! # Usage
+//!
+//! First, add this to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing = "0.1"
+//! ```
+//!
+//! ## Recording Spans and Events
+//!
+//! Spans and events are recorded using macros.
+//!
+//! ### Spans
+//!
+//! The [`span!`] macro expands to a [`Span` struct][`Span`] which is used to
+//! record a span. The [`Span::enter`] method on that struct records that the
+//! span has been entered, and returns a [RAII] guard object, which will exit
+//! the span when dropped.
+//!
+//! For example:
+//!
+//! ```rust
+//! use tracing::{span, Level};
+//! # fn main() {
+//! // Construct a new span named "my span" with trace log level.
+//! let span = span!(Level::TRACE, "my span");
+//!
+//! // Enter the span, returning a guard object.
+//! let _enter = span.enter();
+//!
+//! // Any trace events that occur before the guard is dropped will occur
+//! // within the span.
+//!
+//! // Dropping the guard will exit the span.
+//! # }
+//! ```
+//!
+//! The [`#[instrument]`][instrument] attribute provides an easy way to
+//! add `tracing` spans to functions. A function annotated with `#[instrument]`
+//! will create and enter a span with that function's name every time the
+//! function is called, with arguments to that function will be recorded as
+//! fields using `fmt::Debug`.
+//!
+//! For example:
+//! ```ignore
+//! # // this doctest is ignored because we don't have a way to say
+//! # // that it should only be run with cfg(feature = "attributes")
+//! use tracing::{Level, event, instrument};
+//!
+//! #[instrument]
+//! pub fn my_function(my_arg: usize) {
+//! // This event will be recorded inside a span named `my_function` with the
+//! // field `my_arg`.
+//! event!(Level::INFO, "inside my_function!");
+//! // ...
+//! }
+//! # fn main() {}
+//! ```
+//!
+//! For functions which don't have built-in tracing support and can't have
+//! the `#[instrument]` attribute applied (such as from an external crate),
+//! the [`Span` struct][`Span`] has a [`in_scope()` method][`in_scope`]
+//! which can be used to easily wrap synchonous code in a span.
+//!
+//! For example:
+//! ```rust
+//! use tracing::info_span;
+//!
+//! # fn doc() -> Result<(), ()> {
+//! # mod serde_json {
+//! # pub(crate) fn from_slice(buf: &[u8]) -> Result<(), ()> { Ok(()) }
+//! # }
+//! # let buf: [u8; 0] = [];
+//! let json = info_span!("json.parse").in_scope(|| serde_json::from_slice(&buf))?;
+//! # let _ = json; // suppress unused variable warning
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! You can find more examples showing how to use this crate [here][examples].
+//!
+//! [RAII]: https://github.com/rust-unofficial/patterns/blob/main/src/patterns/behavioural/RAII.md
+//! [examples]: https://github.com/tokio-rs/tracing/tree/master/examples
+//!
+//! ### Events
+//!
+//! [`Event`]s are recorded using the [`event!`] macro:
+//!
+//! ```rust
+//! # fn main() {
+//! use tracing::{event, Level};
+//! event!(Level::INFO, "something has happened!");
+//! # }
+//! ```
+//!
+//! ## Using the Macros
+//!
+//! The [`span!`] and [`event!`] macros as well as the `#[instrument]` attribute
+//! use fairly similar syntax, with some exceptions.
+//!
+//! ### Configuring Attributes
+//!
+//! Both macros require a [`Level`] specifying the verbosity of the span or
+//! event. Optionally, the, [target] and [parent span] may be overridden. If the
+//! target and parent span are not overridden, they will default to the
+//! module path where the macro was invoked and the current span (as determined
+//! by the subscriber), respectively.
+//!
+//! For example:
+//!
+//! ```
+//! # use tracing::{span, event, Level};
+//! # fn main() {
+//! span!(target: "app_spans", Level::TRACE, "my span");
+//! event!(target: "app_events", Level::INFO, "something has happened!");
+//! # }
+//! ```
+//! ```
+//! # use tracing::{span, event, Level};
+//! # fn main() {
+//! let span = span!(Level::TRACE, "my span");
+//! event!(parent: &span, Level::INFO, "something has happened!");
+//! # }
+//! ```
+//!
+//! The span macros also take a string literal after the level, to set the name
+//! of the span (as above). In the case of the event macros, the name of the event can
+//! be overridden (the default is `event file:line`) using the `name:` specifier.
+//!
+//! ```
+//! # use tracing::{span, event, Level};
+//! # fn main() {
+//! span!(Level::TRACE, "my span");
+//! event!(name: "some_info", Level::INFO, "something has happened!");
+//! # }
+//! ```
+//!
+//! ### Recording Fields
+//!
+//! Structured fields on spans and events are specified using the syntax
+//! `field_name = field_value`. Fields are separated by commas.
+//!
+//! ```
+//! # use tracing::{event, Level};
+//! # fn main() {
+//! // records an event with two fields:
+//! // - "answer", with the value 42
+//! // - "question", with the value "life, the universe and everything"
+//! event!(Level::INFO, answer = 42, question = "life, the universe, and everything");
+//! # }
+//! ```
+//!
+//! As shorthand, local variables may be used as field values without an
+//! assignment, similar to [struct initializers]. For example:
+//!
+//! ```
+//! # use tracing::{span, Level};
+//! # fn main() {
+//! let user = "ferris";
+//!
+//! span!(Level::TRACE, "login", user);
+//! // is equivalent to:
+//! span!(Level::TRACE, "login", user = user);
+//! # }
+//!```
+//!
+//! Field names can include dots, but should not be terminated by them:
+//! ```
+//! # use tracing::{span, Level};
+//! # fn main() {
+//! let user = "ferris";
+//! let email = "[email protected]";
+//! span!(Level::TRACE, "login", user, user.email = email);
+//! # }
+//!```
+//!
+//! Since field names can include dots, fields on local structs can be used
+//! using the local variable shorthand:
+//! ```
+//! # use tracing::{span, Level};
+//! # fn main() {
+//! # struct User {
+//! # name: &'static str,
+//! # email: &'static str,
+//! # }
+//! let user = User {
+//! name: "ferris",
+//! email: "[email protected]",
+//! };
+//! // the span will have the fields `user.name = "ferris"` and
+//! // `user.email = "[email protected]"`.
+//! span!(Level::TRACE, "login", user.name, user.email);
+//! # }
+//!```
+//!
+//! Fields with names that are not Rust identifiers, or with names that are Rust reserved words,
+//! may be created using quoted string literals. However, this may not be used with the local
+//! variable shorthand.
+//! ```
+//! # use tracing::{span, Level};
+//! # fn main() {
+//! // records an event with fields whose names are not Rust identifiers
+//! // - "guid:x-request-id", containing a `:`, with the value "abcdef"
+//! // - "type", which is a reserved word, with the value "request"
+//! span!(Level::TRACE, "api", "guid:x-request-id" = "abcdef", "type" = "request");
+//! # }
+//!```
+//!
+//! Constant expressions can also be used as field names. Constants
+//! must be enclosed in curly braces (`{}`) to indicate that the *value*
+//! of the constant is to be used as the field name, rather than the
+//! constant's name. For example:
+//! ```
+//! # use tracing::{span, Level};
+//! # fn main() {
+//! const RESOURCE_NAME: &str = "foo";
+//! // this span will have the field `foo = "some_id"`
+//! span!(Level::TRACE, "get", { RESOURCE_NAME } = "some_id");
+//! # }
+//!```
+//!
+//! The `?` sigil is shorthand that specifies a field should be recorded using
+//! its [`fmt::Debug`] implementation:
+//! ```
+//! # use tracing::{event, Level};
+//! # fn main() {
+//! #[derive(Debug)]
+//! struct MyStruct {
+//! field: &'static str,
+//! }
+//!
+//! let my_struct = MyStruct {
+//! field: "Hello world!"
+//! };
+//!
+//! // `my_struct` will be recorded using its `fmt::Debug` implementation.
+//! event!(Level::TRACE, greeting = ?my_struct);
+//! // is equivalent to:
+//! event!(Level::TRACE, greeting = tracing::field::debug(&my_struct));
+//! # }
+//! ```
+//!
+//! The `%` sigil operates similarly, but indicates that the value should be
+//! recorded using its [`fmt::Display`] implementation:
+//! ```
+//! # use tracing::{event, Level};
+//! # fn main() {
+//! # #[derive(Debug)]
+//! # struct MyStruct {
+//! # field: &'static str,
+//! # }
+//! #
+//! # let my_struct = MyStruct {
+//! # field: "Hello world!"
+//! # };
+//! // `my_struct.field` will be recorded using its `fmt::Display` implementation.
+//! event!(Level::TRACE, greeting = %my_struct.field);
+//! // is equivalent to:
+//! event!(Level::TRACE, greeting = tracing::field::display(&my_struct.field));
+//! # }
+//! ```
+//!
+//! The `%` and `?` sigils may also be used with local variable shorthand:
+//!
+//! ```
+//! # use tracing::{event, Level};
+//! # fn main() {
+//! # #[derive(Debug)]
+//! # struct MyStruct {
+//! # field: &'static str,
+//! # }
+//! #
+//! # let my_struct = MyStruct {
+//! # field: "Hello world!"
+//! # };
+//! // `my_struct.field` will be recorded using its `fmt::Display` implementation.
+//! event!(Level::TRACE, %my_struct.field);
+//! # }
+//! ```
+//!
+//! Additionally, a span may declare fields with the special value [`Empty`],
+//! which indicates that that the value for that field does not currently exist
+//! but may be recorded later. For example:
+//!
+//! ```
+//! use tracing::{trace_span, field};
+//!
+//! // Create a span with two fields: `greeting`, with the value "hello world", and
+//! // `parting`, without a value.
+//! let span = trace_span!("my_span", greeting = "hello world", parting = field::Empty);
+//!
+//! // ...
+//!
+//! // Now, record a value for parting as well.
+//! span.record("parting", &"goodbye world!");
+//! ```
+//!
+//! Finally, events may also include human-readable messages, in the form of a
+//! [format string][fmt] and (optional) arguments, **after** the event's
+//! key-value fields. If a format string and arguments are provided,
+//! they will implicitly create a new field named `message` whose value is the
+//! provided set of format arguments.
+//!
+//! For example:
+//!
+//! ```
+//! # use tracing::{event, Level};
+//! # fn main() {
+//! let question = "the ultimate question of life, the universe, and everything";
+//! let answer = 42;
+//! // records an event with the following fields:
+//! // - `question.answer` with the value 42,
+//! // - `question.tricky` with the value `true`,
+//! // - "message", with the value "the answer to the ultimate question of life, the
+//! // universe, and everything is 42."
+//! event!(
+//! Level::DEBUG,
+//! question.answer = answer,
+//! question.tricky = true,
+//! "the answer to {} is {}.", question, answer
+//! );
+//! # }
+//! ```
+//!
+//! Specifying a formatted message in this manner does not allocate by default.
+//!
+//! [struct initializers]: https://doc.rust-lang.org/book/ch05-01-defining-structs.html#using-the-field-init-shorthand-when-variables-and-fields-have-the-same-name
+//! [target]: Metadata::target
+//! [parent span]: span::Attributes::parent
+//! [determined contextually]: span::Attributes::is_contextual
+//! [`fmt::Debug`]: std::fmt::Debug
+//! [`fmt::Display`]: std::fmt::Display
+//! [fmt]: std::fmt#usage
+//! [`Empty`]: field::Empty
+//!
+//! ### Shorthand Macros
+//!
+//! `tracing` also offers a number of macros with preset verbosity levels.
+//! The [`trace!`], [`debug!`], [`info!`], [`warn!`], and [`error!`] behave
+//! similarly to the [`event!`] macro, but with the [`Level`] argument already
+//! specified, while the corresponding [`trace_span!`], [`debug_span!`],
+//! [`info_span!`], [`warn_span!`], and [`error_span!`] macros are the same,
+//! but for the [`span!`] macro.
+//!
+//! These are intended both as a shorthand, and for compatibility with the [`log`]
+//! crate (see the next section).
+//!
+//! [`span!`]: span!
+//! [`event!`]: event!
+//! [`trace!`]: trace!
+//! [`debug!`]: debug!
+//! [`info!`]: info!
+//! [`warn!`]: warn!
+//! [`error!`]: error!
+//! [`trace_span!`]: trace_span!
+//! [`debug_span!`]: debug_span!
+//! [`info_span!`]: info_span!
+//! [`warn_span!`]: warn_span!
+//! [`error_span!`]: error_span!
+//!
+//! ### For `log` Users
+//!
+//! Users of the [`log`] crate should note that `tracing` exposes a set of
+//! macros for creating `Event`s (`trace!`, `debug!`, `info!`, `warn!`, and
+//! `error!`) which may be invoked with the same syntax as the similarly-named
+//! macros from the `log` crate. Often, the process of converting a project to
+//! use `tracing` can begin with a simple drop-in replacement.
+//!
+//! Let's consider the `log` crate's yak-shaving example:
+//!
+//! ```rust,ignore
+//! use std::{error::Error, io};
+//! use tracing::{debug, error, info, span, warn, Level};
+//!
+//! // the `#[tracing::instrument]` attribute creates and enters a span
+//! // every time the instrumented function is called. The span is named after the
+//! // the function or method. Parameters passed to the function are recorded as fields.
+//! #[tracing::instrument]
+//! pub fn shave(yak: usize) -> Result<(), Box<dyn Error + 'static>> {
+//! // this creates an event at the DEBUG level with two fields:
+//! // - `excitement`, with the key "excitement" and the value "yay!"
+//! // - `message`, with the key "message" and the value "hello! I'm gonna shave a yak."
+//! //
+//! // unlike other fields, `message`'s shorthand initialization is just the string itself.
+//! debug!(excitement = "yay!", "hello! I'm gonna shave a yak.");
+//! if yak == 3 {
+//! warn!("could not locate yak!");
+//! // note that this is intended to demonstrate `tracing`'s features, not idiomatic
+//! // error handling! in a library or application, you should consider returning
+//! // a dedicated `YakError`. libraries like snafu or thiserror make this easy.
+//! return Err(io::Error::new(io::ErrorKind::Other, "shaving yak failed!").into());
+//! } else {
+//! debug!("yak shaved successfully");
+//! }
+//! Ok(())
+//! }
+//!
+//! pub fn shave_all(yaks: usize) -> usize {
+//! // Constructs a new span named "shaving_yaks" at the TRACE level,
+//! // and a field whose key is "yaks". This is equivalent to writing:
+//! //
+//! // let span = span!(Level::TRACE, "shaving_yaks", yaks = yaks);
+//! //
+//! // local variables (`yaks`) can be used as field values
+//! // without an assignment, similar to struct initializers.
+//! let _span = span!(Level::TRACE, "shaving_yaks", yaks).entered();
+//!
+//! info!("shaving yaks");
+//!
+//! let mut yaks_shaved = 0;
+//! for yak in 1..=yaks {
+//! let res = shave(yak);
+//! debug!(yak, shaved = res.is_ok());
+//!
+//! if let Err(ref error) = res {
+//! // Like spans, events can also use the field initialization shorthand.
+//! // In this instance, `yak` is the field being initalized.
+//! error!(yak, error = error.as_ref(), "failed to shave yak!");
+//! } else {
+//! yaks_shaved += 1;
+//! }
+//! debug!(yaks_shaved);
+//! }
+//!
+//! yaks_shaved
+//! }
+//! ```
+//!
+//! ## In libraries
+//!
+//! Libraries should link only to the `tracing` crate, and use the provided
+//! macros to record whatever information will be useful to downstream
+//! consumers.
+//!
+//! ## In executables
+//!
+//! In order to record trace events, executables have to use a `Subscriber`
+//! implementation compatible with `tracing`. A `Subscriber` implements a
+//! way of collecting trace data, such as by logging it to standard output.
+//!
+//! This library does not contain any `Subscriber` implementations; these are
+//! provided by [other crates](#related-crates).
+//!
+//! The simplest way to use a subscriber is to call the [`set_global_default`]
+//! function:
+//!
+//! ```
+//! extern crate tracing;
+//! # pub struct FooSubscriber;
+//! # use tracing::{span::{Id, Attributes, Record}, Metadata};
+//! # impl tracing::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &tracing::Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber {
+//! # fn new() -> Self { FooSubscriber }
+//! # }
+//! # fn main() {
+//!
+//! let my_subscriber = FooSubscriber::new();
+//! tracing::subscriber::set_global_default(my_subscriber)
+//! .expect("setting tracing default failed");
+//! # }
+//! ```
+//!
+//! <pre class="compile_fail" style="white-space:normal;font:inherit;">
+//! <strong>Warning</strong>: In general, libraries should <em>not</em> call
+//! <code>set_global_default()</code>! Doing so will cause conflicts when
+//! executables that depend on the library try to set the default later.
+//! </pre>
+//!
+//! This subscriber will be used as the default in all threads for the
+//! remainder of the duration of the program, similar to setting the logger
+//! in the `log` crate.
+//!
+//! In addition, the default subscriber can be set through using the
+//! [`with_default`] function. This follows the `tokio` pattern of using
+//! closures to represent executing code in a context that is exited at the end
+//! of the closure. For example:
+//!
+//! ```rust
+//! # pub struct FooSubscriber;
+//! # use tracing::{span::{Id, Attributes, Record}, Metadata};
+//! # impl tracing::Subscriber for FooSubscriber {
+//! # fn new_span(&self, _: &Attributes) -> Id { Id::from_u64(0) }
+//! # fn record(&self, _: &Id, _: &Record) {}
+//! # fn event(&self, _: &tracing::Event) {}
+//! # fn record_follows_from(&self, _: &Id, _: &Id) {}
+//! # fn enabled(&self, _: &Metadata) -> bool { false }
+//! # fn enter(&self, _: &Id) {}
+//! # fn exit(&self, _: &Id) {}
+//! # }
+//! # impl FooSubscriber {
+//! # fn new() -> Self { FooSubscriber }
+//! # }
+//! # fn main() {
+//!
+//! let my_subscriber = FooSubscriber::new();
+//! # #[cfg(feature = "std")]
+//! tracing::subscriber::with_default(my_subscriber, || {
+//! // Any trace events generated in this closure or by functions it calls
+//! // will be collected by `my_subscriber`.
+//! })
+//! # }
+//! ```
+//!
+//! This approach allows trace data to be collected by multiple subscribers
+//! within different contexts in the program. Note that the override only applies to the
+//! currently executing thread; other threads will not see the change from with_default.
+//!
+//! Any trace events generated outside the context of a subscriber will not be collected.
+//!
+//! Once a subscriber has been set, instrumentation points may be added to the
+//! executable using the `tracing` crate's macros.
+//!
+//! ## `log` Compatibility
+//!
+//! The [`log`] crate provides a simple, lightweight logging facade for Rust.
+//! While `tracing` builds upon `log`'s foundation with richer structured
+//! diagnostic data, `log`'s simplicity and ubiquity make it the "lowest common
+//! denominator" for text-based logging in Rust — a vast majority of Rust
+//! libraries and applications either emit or consume `log` records. Therefore,
+//! `tracing` provides multiple forms of interoperability with `log`: `tracing`
+//! instrumentation can emit `log` records, and a compatibility layer enables
+//! `tracing` [`Subscriber`]s to consume `log` records as `tracing` [`Event`]s.
+//!
+//! ### Emitting `log` Records
+//!
+//! This crate provides two feature flags, "log" and "log-always", which will
+//! cause [spans] and [events] to emit `log` records. When the "log" feature is
+//! enabled, if no `tracing` `Subscriber` is active, invoking an event macro or
+//! creating a span with fields will emit a `log` record. This is intended
+//! primarily for use in libraries which wish to emit diagnostics that can be
+//! consumed by applications using `tracing` *or* `log`, without paying the
+//! additional overhead of emitting both forms of diagnostics when `tracing` is
+//! in use.
+//!
+//! Enabling the "log-always" feature will cause `log` records to be emitted
+//! even if a `tracing` `Subscriber` _is_ set. This is intended to be used in
+//! applications where a `log` `Logger` is being used to record a textual log,
+//! and `tracing` is used only to record other forms of diagnostics (such as
+//! metrics, profiling, or distributed tracing data). Unlike the "log" feature,
+//! libraries generally should **not** enable the "log-always" feature, as doing
+//! so will prevent applications from being able to opt out of the `log` records.
+//!
+//! See [here][flags] for more details on this crate's feature flags.
+//!
+//! The generated `log` records' messages will be a string representation of the
+//! span or event's fields, and all additional information recorded by `log`
+//! (target, verbosity level, module path, file, and line number) will also be
+//! populated. Additionally, `log` records are also generated when spans are
+//! entered, exited, and closed. Since these additional span lifecycle logs have
+//! the potential to be very verbose, and don't include additional fields, they
+//! will always be emitted at the `Trace` level, rather than inheriting the
+//! level of the span that generated them. Furthermore, they are are categorized
+//! under a separate `log` target, "tracing::span" (and its sub-target,
+//! "tracing::span::active", for the logs on entering and exiting a span), which
+//! may be enabled or disabled separately from other `log` records emitted by
+//! `tracing`.
+//!
+//! ### Consuming `log` Records
+//!
+//! The [`tracing-log`] crate provides a compatibility layer which
+//! allows a `tracing` [`Subscriber`] to consume `log` records as though they
+//! were `tracing` [events]. This allows applications using `tracing` to record
+//! the logs emitted by dependencies using `log` as events within the context of
+//! the application's trace tree. See [that crate's documentation][log-tracer]
+//! for details.
+//!
+//! [log-tracer]: https://docs.rs/tracing-log/latest/tracing_log/#convert-log-records-to-tracing-events
+//!
+//! ## Related Crates
+//!
+//! In addition to `tracing` and `tracing-core`, the [`tokio-rs/tracing`] repository
+//! contains several additional crates designed to be used with the `tracing` ecosystem.
+//! This includes a collection of `Subscriber` implementations, as well as utility
+//! and adapter crates to assist in writing `Subscriber`s and instrumenting
+//! applications.
+//!
+//! In particular, the following crates are likely to be of interest:
+//!
+//! - [`tracing-futures`] provides a compatibility layer with the `futures`
+//! crate, allowing spans to be attached to `Future`s, `Stream`s, and `Executor`s.
+//! - [`tracing-subscriber`] provides `Subscriber` implementations and
+//! utilities for working with `Subscriber`s. This includes a [`FmtSubscriber`]
+//! `FmtSubscriber` for logging formatted trace data to stdout, with similar
+//! filtering and formatting to the [`env_logger`] crate.
+//! - [`tracing-log`] provides a compatibility layer with the [`log`] crate,
+//! allowing log messages to be recorded as `tracing` `Event`s within the
+//! trace tree. This is useful when a project using `tracing` have
+//! dependencies which use `log`. Note that if you're using
+//! `tracing-subscriber`'s `FmtSubscriber`, you don't need to depend on
+//! `tracing-log` directly.
+//! - [`tracing-appender`] provides utilities for outputting tracing data,
+//! including a file appender and non blocking writer.
+//!
+//! Additionally, there are also several third-party crates which are not
+//! maintained by the `tokio` project. These include:
+//!
+//! - [`tracing-timing`] implements inter-event timing metrics on top of `tracing`.
+//! It provides a subscriber that records the time elapsed between pairs of
+//! `tracing` events and generates histograms.
+//! - [`tracing-opentelemetry`] provides a subscriber for emitting traces to
+//! [OpenTelemetry]-compatible distributed tracing systems.
+//! - [`tracing-honeycomb`] Provides a layer that reports traces spanning multiple machines to [honeycomb.io]. Backed by [`tracing-distributed`].
+//! - [`tracing-distributed`] Provides a generic implementation of a layer that reports traces spanning multiple machines to some backend.
+//! - [`tracing-actix-web`] provides `tracing` integration for the `actix-web` web framework.
+//! - [`tracing-actix`] provides `tracing` integration for the `actix` actor
+//! framework.
+//! - [`axum-insights`] provides `tracing` integration and Application insights export for the `axum` web framework.
+//! - [`tracing-gelf`] implements a subscriber for exporting traces in Greylog
+//! GELF format.
+//! - [`tracing-coz`] provides integration with the [coz] causal profiler
+//! (Linux-only).
+//! - [`tracing-bunyan-formatter`] provides a layer implementation that reports events and spans
+//! in [bunyan] format, enriched with timing information.
+//! - [`tracing-wasm`] provides a `Subscriber`/`Layer` implementation that reports
+//! events and spans via browser `console.log` and [User Timing API (`window.performance`)].
+//! - [`tracing-web`] provides a layer implementation of level-aware logging of events
+//! to web browsers' `console.*` and span events to the [User Timing API (`window.performance`)].
+//! - [`tide-tracing`] provides a [tide] middleware to trace all incoming requests and responses.
+//! - [`test-log`] takes care of initializing `tracing` for tests, based on
+//! environment variables with an `env_logger` compatible syntax.
+//! - [`tracing-unwrap`] provides convenience methods to report failed unwraps
+//! on `Result` or `Option` types to a `Subscriber`.
+//! - [`diesel-tracing`] provides integration with [`diesel`] database connections.
+//! - [`tracing-tracy`] provides a way to collect [Tracy] profiles in instrumented
+//! applications.
+//! - [`tracing-elastic-apm`] provides a layer for reporting traces to [Elastic APM].
+//! - [`tracing-etw`] provides a layer for emitting Windows [ETW] events.
+//! - [`tracing-fluent-assertions`] provides a fluent assertions-style testing
+//! framework for validating the behavior of `tracing` spans.
+//! - [`sentry-tracing`] provides a layer for reporting events and traces to [Sentry].
+//! - [`tracing-forest`] provides a subscriber that preserves contextual coherence by
+//! grouping together logs from the same spans during writing.
+//! - [`tracing-loki`] provides a layer for shipping logs to [Grafana Loki].
+//! - [`tracing-logfmt`] provides a layer that formats events and spans into the logfmt format.
+//! - [`reqwest-tracing`] provides a middleware to trace [`reqwest`] HTTP requests.
+//! - [`tracing-cloudwatch`] provides a layer that sends events to AWS CloudWatch Logs.
+//! - [`clippy-tracing`] provides a tool to add, remove and check for `tracing::instrument`.
+//!
+//! If you're the maintainer of a `tracing` ecosystem crate not listed above,
+//! please let us know! We'd love to add your project to the list!
+//!
+//! [`tracing-opentelemetry`]: https://crates.io/crates/tracing-opentelemetry
+//! [OpenTelemetry]: https://opentelemetry.io/
+//! [`tracing-honeycomb`]: https://crates.io/crates/tracing-honeycomb
+//! [`tracing-distributed`]: https://crates.io/crates/tracing-distributed
+//! [honeycomb.io]: https://www.honeycomb.io/
+//! [`tracing-actix-web`]: https://crates.io/crates/tracing-actix-web
+//! [`tracing-actix`]: https://crates.io/crates/tracing-actix
+//! [`axum-insights`]: https://crates.io/crates/axum-insights
+//! [`tracing-gelf`]: https://crates.io/crates/tracing-gelf
+//! [`tracing-coz`]: https://crates.io/crates/tracing-coz
+//! [coz]: https://github.com/plasma-umass/coz
+//! [`tracing-bunyan-formatter`]: https://crates.io/crates/tracing-bunyan-formatter
+//! [bunyan]: https://github.com/trentm/node-bunyan
+//! [`tracing-wasm`]: https://docs.rs/tracing-wasm
+//! [`tracing-web`]: https://docs.rs/tracing-web
+//! [User Timing API (`window.performance`)]: https://developer.mozilla.org/en-US/docs/Web/API/User_Timing_API
+//! [`tide-tracing`]: https://crates.io/crates/tide-tracing
+//! [tide]: https://crates.io/crates/tide
+//! [`test-log`]: https://crates.io/crates/test-log
+//! [`tracing-unwrap`]: https://docs.rs/tracing-unwrap
+//! [`diesel`]: https://crates.io/crates/diesel
+//! [`diesel-tracing`]: https://crates.io/crates/diesel-tracing
+//! [`tracing-tracy`]: https://crates.io/crates/tracing-tracy
+//! [Tracy]: https://github.com/wolfpld/tracy
+//! [`tracing-elastic-apm`]: https://crates.io/crates/tracing-elastic-apm
+//! [Elastic APM]: https://www.elastic.co/apm
+//! [`tracing-etw`]: https://github.com/microsoft/rust_win_etw/tree/main/win_etw_tracing
+//! [ETW]: https://docs.microsoft.com/en-us/windows/win32/etw/about-event-tracing
+//! [`tracing-fluent-assertions`]: https://crates.io/crates/tracing-fluent-assertions
+//! [`sentry-tracing`]: https://crates.io/crates/sentry-tracing
+//! [Sentry]: https://sentry.io/welcome/
+//! [`tracing-forest`]: https://crates.io/crates/tracing-forest
+//! [`tracing-loki`]: https://crates.io/crates/tracing-loki
+//! [Grafana Loki]: https://grafana.com/oss/loki/
+//! [`tracing-logfmt`]: https://crates.io/crates/tracing-logfmt
+//! [`reqwest-tracing`]: https://crates.io/crates/reqwest-tracing
+//! [`reqwest`]: https://crates.io/crates/reqwest
+//! [`tracing-cloudwatch`]: https://crates.io/crates/tracing-cloudwatch
+//! [`clippy-tracing`]: https://crates.io/crates/clippy-tracing
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: Some of these ecosystem crates are currently
+//! unreleased and/or in earlier stages of development. They may be less stable
+//! than <code>tracing</code> and <code>tracing-core</code>.
+//! </pre>
+//!
+//! ## Crate Feature Flags
+//!
+//! The following crate [feature flags] are available:
+//!
+//! * A set of features controlling the [static verbosity level].
+//! * `log`: causes trace instrumentation points to emit [`log`] records as well
+//! as trace events, if a default `tracing` subscriber has not been set. This
+//! is intended for use in libraries whose users may be using either `tracing`
+//! or `log`.
+//! * `log-always`: Emit `log` records from all `tracing` spans and events, even
+//! if a `tracing` subscriber has been set. This should be set only by
+//! applications which intend to collect traces and logs separately; if an
+//! adapter is used to convert `log` records into `tracing` events, this will
+//! cause duplicate events to occur.
+//! * `attributes`: Includes support for the `#[instrument]` attribute.
+//! This is on by default, but does bring in the `syn` crate as a dependency,
+//! which may add to the compile time of crates that do not already use it.
+//! * `std`: Depend on the Rust standard library (enabled by default).
+//!
+//! `no_std` users may disable this feature with `default-features = false`:
+//!
+//! ```toml
+//! [dependencies]
+//! tracing = { version = "0.1.38", default-features = false }
+//! ```
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: <code>tracing</code>'s <code>no_std</code> support
+//! requires <code>liballoc</code>.
+//! </pre>
+//!
+//! ### Unstable Features
+//!
+//! These feature flags enable **unstable** features. The public API may break in 0.1.x
+//! releases. To enable these features, the `--cfg tracing_unstable` must be passed to
+//! `rustc` when compiling.
+//!
+//! The following unstable feature flags are currently available:
+//!
+//! * `valuable`: Enables support for recording [field values] using the
+//! [`valuable`] crate.
+//!
+//! #### Enabling Unstable Features
+//!
+//! The easiest way to set the `tracing_unstable` cfg is to use the `RUSTFLAGS`
+//! env variable when running `cargo` commands:
+//!
+//! ```shell
+//! RUSTFLAGS="--cfg tracing_unstable" cargo build
+//! ```
+//! Alternatively, the following can be added to the `.cargo/config` file in a
+//! project to automatically enable the cfg flag for that project:
+//!
+//! ```toml
+//! [build]
+//! rustflags = ["--cfg", "tracing_unstable"]
+//! ```
+//!
+//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
+//! [field values]: crate::field
+//! [`valuable`]: https://crates.io/crates/valuable
+//!
+//! ## Supported Rust Versions
+//!
+//! Tracing is built against the latest stable release. The minimum supported
+//! version is 1.56. The current Tracing version is not guaranteed to build on
+//! Rust versions earlier than the minimum supported version.
+//!
+//! Tracing follows the same compiler support policies as the rest of the Tokio
+//! project. The current stable Rust compiler and the three most recent minor
+//! versions before it will always be supported. For example, if the current
+//! stable compiler version is 1.69, the minimum supported version will not be
+//! increased past 1.66, three minor versions prior. Increasing the minimum
+//! supported compiler version is not considered a semver breaking change as
+//! long as doing so complies with this policy.
+//!
+//! [`log`]: https://docs.rs/log/0.4.6/log/
+//! [span]: mod@span
+//! [spans]: mod@span
+//! [`Span`]: span::Span
+//! [`in_scope`]: span::Span::in_scope
+//! [event]: Event
+//! [events]: Event
+//! [`Subscriber`]: subscriber::Subscriber
+//! [Subscriber::event]: subscriber::Subscriber::event
+//! [`enter`]: subscriber::Subscriber::enter
+//! [`exit`]: subscriber::Subscriber::exit
+//! [`enabled`]: subscriber::Subscriber::enabled
+//! [metadata]: Metadata
+//! [`field::display`]: field::display
+//! [`field::debug`]: field::debug
+//! [`set_global_default`]: subscriber::set_global_default
+//! [`with_default`]: subscriber::with_default
+//! [`tokio-rs/tracing`]: https://github.com/tokio-rs/tracing
+//! [`tracing-futures`]: https://crates.io/crates/tracing-futures
+//! [`tracing-subscriber`]: https://crates.io/crates/tracing-subscriber
+//! [`tracing-log`]: https://crates.io/crates/tracing-log
+//! [`tracing-timing`]: https://crates.io/crates/tracing-timing
+//! [`tracing-appender`]: https://crates.io/crates/tracing-appender
+//! [`env_logger`]: https://crates.io/crates/env_logger
+//! [`FmtSubscriber`]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/struct.Subscriber.html
+//! [static verbosity level]: level_filters#compile-time-filters
+//! [instrument]: https://docs.rs/tracing-attributes/latest/tracing_attributes/attr.instrument.html
+//! [flags]: #crate-feature-flags
+#![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg), deny(rustdoc::broken_intra_doc_links))]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png",
+ issue_tracker_base_url = "https://github.com/tokio-rs/tracing/issues/"
+)]
+#![warn(
+ missing_debug_implementations,
+ missing_docs,
+ rust_2018_idioms,
+ unreachable_pub,
+ bad_style,
+ dead_code,
+ improper_ctypes,
+ non_shorthand_field_patterns,
+ no_mangle_generic_items,
+ overflowing_literals,
+ path_statements,
+ patterns_in_fns_without_body,
+ private_in_public,
+ unconditional_recursion,
+ unused,
+ unused_allocation,
+ unused_comparisons,
+ unused_parens,
+ while_true
+)]
+
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+
+// Somehow this `use` statement is necessary for us to re-export the `core`
+// macros on Rust 1.26.0. I'm not sure how this makes it work, but it does.
+#[allow(unused_imports)]
+#[doc(hidden)]
+use tracing_core::*;
+
+#[doc(inline)]
+pub use self::instrument::Instrument;
+pub use self::{dispatcher::Dispatch, event::Event, field::Value, subscriber::Subscriber};
+
+#[doc(hidden)]
+pub use self::span::Id;
+
+#[doc(hidden)]
+pub use tracing_core::{
+ callsite::{self, Callsite},
+ metadata,
+};
+pub use tracing_core::{event, Level, Metadata};
+
+#[doc(inline)]
+pub use self::span::Span;
+#[cfg(feature = "attributes")]
+#[cfg_attr(docsrs, doc(cfg(feature = "attributes")))]
+#[doc(inline)]
+pub use tracing_attributes::instrument;
+
+#[macro_use]
+mod macros;
+
+pub mod dispatcher;
+pub mod field;
+/// Attach a span to a `std::future::Future`.
+pub mod instrument;
+pub mod level_filters;
+pub mod span;
+pub(crate) mod stdlib;
+pub mod subscriber;
+
+#[doc(hidden)]
+pub mod __macro_support {
+ pub use crate::callsite::Callsite;
+ use crate::{subscriber::Interest, Metadata};
+ pub use core::concat;
+
+ /// Callsite implementation used by macro-generated code.
+ ///
+ /// /!\ WARNING: This is *not* a stable API! /!\
+ /// This type, and all code contained in the `__macro_support` module, is
+ /// a *private* API of `tracing`. It is exposed publicly because it is used
+ /// by the `tracing` macros, but it is not part of the stable versioned API.
+ /// Breaking changes to this module may occur in small-numbered versions
+ /// without warning.
+ pub use tracing_core::callsite::DefaultCallsite as MacroCallsite;
+
+ /// /!\ WARNING: This is *not* a stable API! /!\
+ /// This function, and all code contained in the `__macro_support` module, is
+ /// a *private* API of `tracing`. It is exposed publicly because it is used
+ /// by the `tracing` macros, but it is not part of the stable versioned API.
+ /// Breaking changes to this module may occur in small-numbered versions
+ /// without warning.
+ pub fn __is_enabled(meta: &Metadata<'static>, interest: Interest) -> bool {
+ interest.is_always() || crate::dispatcher::get_default(|default| default.enabled(meta))
+ }
+
+ /// /!\ WARNING: This is *not* a stable API! /!\
+ /// This function, and all code contained in the `__macro_support` module, is
+ /// a *private* API of `tracing`. It is exposed publicly because it is used
+ /// by the `tracing` macros, but it is not part of the stable versioned API.
+ /// Breaking changes to this module may occur in small-numbered versions
+ /// without warning.
+ #[inline]
+ #[cfg(feature = "log")]
+ pub fn __disabled_span(meta: &'static Metadata<'static>) -> crate::Span {
+ crate::Span::new_disabled(meta)
+ }
+
+ /// /!\ WARNING: This is *not* a stable API! /!\
+ /// This function, and all code contained in the `__macro_support` module, is
+ /// a *private* API of `tracing`. It is exposed publicly because it is used
+ /// by the `tracing` macros, but it is not part of the stable versioned API.
+ /// Breaking changes to this module may occur in small-numbered versions
+ /// without warning.
+ #[inline]
+ #[cfg(not(feature = "log"))]
+ pub fn __disabled_span(_: &'static Metadata<'static>) -> crate::Span {
+ crate::Span::none()
+ }
+
+ /// /!\ WARNING: This is *not* a stable API! /!\
+ /// This function, and all code contained in the `__macro_support` module, is
+ /// a *private* API of `tracing`. It is exposed publicly because it is used
+ /// by the `tracing` macros, but it is not part of the stable versioned API.
+ /// Breaking changes to this module may occur in small-numbered versions
+ /// without warning.
+ #[cfg(feature = "log")]
+ pub fn __tracing_log(
+ meta: &Metadata<'static>,
+ logger: &'static dyn log::Log,
+ log_meta: log::Metadata<'_>,
+ values: &tracing_core::field::ValueSet<'_>,
+ ) {
+ logger.log(
+ &crate::log::Record::builder()
+ .file(meta.file())
+ .module_path(meta.module_path())
+ .line(meta.line())
+ .metadata(log_meta)
+ .args(format_args!(
+ "{}",
+ crate::log::LogValueSet {
+ values,
+ is_first: true
+ }
+ ))
+ .build(),
+ );
+ }
+}
+
+#[cfg(feature = "log")]
+#[doc(hidden)]
+pub mod log {
+ use core::fmt;
+ pub use log::*;
+ use tracing_core::field::{Field, ValueSet, Visit};
+
+ /// Utility to format [`ValueSet`]s for logging.
+ pub(crate) struct LogValueSet<'a> {
+ pub(crate) values: &'a ValueSet<'a>,
+ pub(crate) is_first: bool,
+ }
+
+ impl<'a> fmt::Display for LogValueSet<'a> {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ struct LogVisitor<'a, 'b> {
+ f: &'a mut fmt::Formatter<'b>,
+ is_first: bool,
+ result: fmt::Result,
+ }
+
+ impl Visit for LogVisitor<'_, '_> {
+ fn record_debug(&mut self, field: &Field, value: &dyn fmt::Debug) {
+ let res = if self.is_first {
+ self.is_first = false;
+ if field.name() == "message" {
+ write!(self.f, "{:?}", value)
+ } else {
+ write!(self.f, "{}={:?}", field.name(), value)
+ }
+ } else {
+ write!(self.f, " {}={:?}", field.name(), value)
+ };
+ if let Err(err) = res {
+ self.result = self.result.and(Err(err));
+ }
+ }
+
+ fn record_str(&mut self, field: &Field, value: &str) {
+ if field.name() == "message" {
+ self.record_debug(field, &format_args!("{}", value))
+ } else {
+ self.record_debug(field, &value)
+ }
+ }
+ }
+
+ let mut visit = LogVisitor {
+ f,
+ is_first: self.is_first,
+ result: Ok(()),
+ };
+ self.values.record(&mut visit);
+ visit.result
+ }
+ }
+}
+
+mod sealed {
+ pub trait Sealed {}
+}
diff --git a/crates/tracing/src/macros.rs b/crates/tracing/src/macros.rs
new file mode 100644
index 0000000..dba49d1
--- /dev/null
+++ b/crates/tracing/src/macros.rs
@@ -0,0 +1,3165 @@
+/// Constructs a new span.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// Creating a new span:
+/// ```
+/// # use tracing::{span, Level};
+/// # fn main() {
+/// let span = span!(Level::TRACE, "my span");
+/// let _enter = span.enter();
+/// // do work inside the span...
+/// # }
+/// ```
+#[macro_export]
+macro_rules! span {
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, $name:expr) => {
+ $crate::span!(target: $target, parent: $parent, $lvl, $name,)
+ };
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, $name:expr, $($fields:tt)*) => {
+ {
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::__macro_support::MacroCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::SPAN,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let mut interest = $crate::subscriber::Interest::never();
+ if $crate::level_enabled!($lvl)
+ && { interest = __CALLSITE.interest(); !interest.is_never() }
+ && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ {
+ let meta = __CALLSITE.metadata();
+ // span with explicit parent
+ $crate::Span::child_of(
+ $parent,
+ meta,
+ &$crate::valueset!(meta.fields(), $($fields)*),
+ )
+ } else {
+ let span = $crate::__macro_support::__disabled_span(__CALLSITE.metadata());
+ $crate::if_log_enabled! { $lvl, {
+ span.record_all(&$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ }};
+ span
+ }
+ }
+ };
+ (target: $target:expr, $lvl:expr, $name:expr, $($fields:tt)*) => {
+ {
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::callsite::DefaultCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::SPAN,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let mut interest = $crate::subscriber::Interest::never();
+ if $crate::level_enabled!($lvl)
+ && { interest = __CALLSITE.interest(); !interest.is_never() }
+ && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ {
+ let meta = __CALLSITE.metadata();
+ // span with contextual parent
+ $crate::Span::new(
+ meta,
+ &$crate::valueset!(meta.fields(), $($fields)*),
+ )
+ } else {
+ let span = $crate::__macro_support::__disabled_span(__CALLSITE.metadata());
+ $crate::if_log_enabled! { $lvl, {
+ span.record_all(&$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ }};
+ span
+ }
+ }
+ };
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, $name:expr) => {
+ $crate::span!(target: $target, parent: $parent, $lvl, $name,)
+ };
+ (parent: $parent:expr, $lvl:expr, $name:expr, $($fields:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ $name,
+ $($fields)*
+ )
+ };
+ (parent: $parent:expr, $lvl:expr, $name:expr) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ $name,
+ )
+ };
+ (target: $target:expr, $lvl:expr, $name:expr, $($fields:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $lvl,
+ $name,
+ $($fields)*
+ )
+ };
+ (target: $target:expr, $lvl:expr, $name:expr) => {
+ $crate::span!(target: $target, $lvl, $name,)
+ };
+ ($lvl:expr, $name:expr, $($fields:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $lvl,
+ $name,
+ $($fields)*
+ )
+ };
+ ($lvl:expr, $name:expr) => {
+ $crate::span!(
+ target: module_path!(),
+ $lvl,
+ $name,
+ )
+ };
+}
+
+/// Constructs a span at the trace level.
+///
+/// [Fields] and [attributes] are set using the same syntax as the [`span!`]
+/// macro.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+/// [attributes]: crate#configuring-attributes
+/// [Fields]: crate#recording-fields
+/// [`span!`]: crate::span!
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{trace_span, span, Level};
+/// # fn main() {
+/// trace_span!("my_span");
+/// // is equivalent to:
+/// span!(Level::TRACE, "my_span");
+/// # }
+/// ```
+///
+/// ```rust
+/// # use tracing::{trace_span, span, Level};
+/// # fn main() {
+/// let span = trace_span!("my span");
+/// span.in_scope(|| {
+/// // do work inside the span...
+/// });
+/// # }
+/// ```
+#[macro_export]
+macro_rules! trace_span {
+ (target: $target:expr, parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ parent: $parent,
+ $crate::Level::TRACE,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, parent: $parent:expr, $name:expr) => {
+ $crate::trace_span!(target: $target, parent: $parent, $name,)
+ };
+ (parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ $name,
+ $($field)*
+ )
+ };
+ (parent: $parent:expr, $name:expr) => {
+ $crate::trace_span!(parent: $parent, $name,)
+ };
+ (target: $target:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $crate::Level::TRACE,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, $name:expr) => {
+ $crate::trace_span!(target: $target, $name,)
+ };
+ ($name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ $name,
+ $($field)*
+ )
+ };
+ ($name:expr) => { $crate::trace_span!($name,) };
+}
+
+/// Constructs a span at the debug level.
+///
+/// [Fields] and [attributes] are set using the same syntax as the [`span!`]
+/// macro.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+/// [attributes]: crate#configuring-attributes
+/// [Fields]: crate#recording-fields
+/// [`span!`]: crate::span!
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{debug_span, span, Level};
+/// # fn main() {
+/// debug_span!("my_span");
+/// // is equivalent to:
+/// span!(Level::DEBUG, "my_span");
+/// # }
+/// ```
+///
+/// ```rust
+/// # use tracing::debug_span;
+/// # fn main() {
+/// let span = debug_span!("my span");
+/// span.in_scope(|| {
+/// // do work inside the span...
+/// });
+/// # }
+/// ```
+#[macro_export]
+macro_rules! debug_span {
+ (target: $target:expr, parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ parent: $parent,
+ $crate::Level::DEBUG,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, parent: $parent:expr, $name:expr) => {
+ $crate::debug_span!(target: $target, parent: $parent, $name,)
+ };
+ (parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ $name,
+ $($field)*
+ )
+ };
+ (parent: $parent:expr, $name:expr) => {
+ $crate::debug_span!(parent: $parent, $name,)
+ };
+ (target: $target:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $crate::Level::DEBUG,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, $name:expr) => {
+ $crate::debug_span!(target: $target, $name,)
+ };
+ ($name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ $name,
+ $($field)*
+ )
+ };
+ ($name:expr) => {$crate::debug_span!($name,)};
+}
+
+/// Constructs a span at the info level.
+///
+/// [Fields] and [attributes] are set using the same syntax as the [`span!`]
+/// macro.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+/// [attributes]: crate#configuring-attributes
+/// [Fields]: crate#recording-fields
+/// [`span!`]: crate::span!
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{span, info_span, Level};
+/// # fn main() {
+/// info_span!("my_span");
+/// // is equivalent to:
+/// span!(Level::INFO, "my_span");
+/// # }
+/// ```
+///
+/// ```rust
+/// # use tracing::info_span;
+/// # fn main() {
+/// let span = info_span!("my span");
+/// span.in_scope(|| {
+/// // do work inside the span...
+/// });
+/// # }
+/// ```
+#[macro_export]
+macro_rules! info_span {
+ (target: $target:expr, parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ parent: $parent,
+ $crate::Level::INFO,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, parent: $parent:expr, $name:expr) => {
+ $crate::info_span!(target: $target, parent: $parent, $name,)
+ };
+ (parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ $name,
+ $($field)*
+ )
+ };
+ (parent: $parent:expr, $name:expr) => {
+ $crate::info_span!(parent: $parent, $name,)
+ };
+ (target: $target:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $crate::Level::INFO,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, $name:expr) => {
+ $crate::info_span!(target: $target, $name,)
+ };
+ ($name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ $name,
+ $($field)*
+ )
+ };
+ ($name:expr) => {$crate::info_span!($name,)};
+}
+
+/// Constructs a span at the warn level.
+///
+/// [Fields] and [attributes] are set using the same syntax as the [`span!`]
+/// macro.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+/// [attributes]: crate#configuring-attributes
+/// [Fields]: crate#recording-fields
+/// [`span!`]: crate::span!
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{warn_span, span, Level};
+/// # fn main() {
+/// warn_span!("my_span");
+/// // is equivalent to:
+/// span!(Level::WARN, "my_span");
+/// # }
+/// ```
+///
+/// ```rust
+/// use tracing::warn_span;
+/// # fn main() {
+/// let span = warn_span!("my span");
+/// span.in_scope(|| {
+/// // do work inside the span...
+/// });
+/// # }
+/// ```
+#[macro_export]
+macro_rules! warn_span {
+ (target: $target:expr, parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ parent: $parent,
+ $crate::Level::WARN,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, parent: $parent:expr, $name:expr) => {
+ $crate::warn_span!(target: $target, parent: $parent, $name,)
+ };
+ (parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ $name,
+ $($field)*
+ )
+ };
+ (parent: $parent:expr, $name:expr) => {
+ $crate::warn_span!(parent: $parent, $name,)
+ };
+ (target: $target:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $crate::Level::WARN,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, $name:expr) => {
+ $crate::warn_span!(target: $target, $name,)
+ };
+ ($name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ $name,
+ $($field)*
+ )
+ };
+ ($name:expr) => {$crate::warn_span!($name,)};
+}
+/// Constructs a span at the error level.
+///
+/// [Fields] and [attributes] are set using the same syntax as the [`span!`]
+/// macro.
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+/// [attributes]: crate#configuring-attributes
+/// [Fields]: crate#recording-fields
+/// [`span!`]: crate::span!
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{span, error_span, Level};
+/// # fn main() {
+/// error_span!("my_span");
+/// // is equivalent to:
+/// span!(Level::ERROR, "my_span");
+/// # }
+/// ```
+///
+/// ```rust
+/// # use tracing::error_span;
+/// # fn main() {
+/// let span = error_span!("my span");
+/// span.in_scope(|| {
+/// // do work inside the span...
+/// });
+/// # }
+/// ```
+#[macro_export]
+macro_rules! error_span {
+ (target: $target:expr, parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ parent: $parent,
+ $crate::Level::ERROR,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, parent: $parent:expr, $name:expr) => {
+ $crate::error_span!(target: $target, parent: $parent, $name,)
+ };
+ (parent: $parent:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ $name,
+ $($field)*
+ )
+ };
+ (parent: $parent:expr, $name:expr) => {
+ $crate::error_span!(parent: $parent, $name,)
+ };
+ (target: $target:expr, $name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: $target,
+ $crate::Level::ERROR,
+ $name,
+ $($field)*
+ )
+ };
+ (target: $target:expr, $name:expr) => {
+ $crate::error_span!(target: $target, $name,)
+ };
+ ($name:expr, $($field:tt)*) => {
+ $crate::span!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ $name,
+ $($field)*
+ )
+ };
+ ($name:expr) => {$crate::error_span!($name,)};
+}
+
+/// Constructs a new `Event`.
+///
+/// The event macro is invoked with a `Level` and up to 32 key-value fields.
+/// Optionally, a format string and arguments may follow the fields; this will
+/// be used to construct an implicit field named "message".
+///
+/// See [the top-level documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::{event, Level};
+///
+/// # fn main() {
+/// let data = (42, "forty-two");
+/// let private_data = "private";
+/// let error = "a bad error";
+///
+/// event!(Level::ERROR, %error, "Received error");
+/// event!(
+/// target: "app_events",
+/// Level::WARN,
+/// private_data,
+/// ?data,
+/// "App warning: {}",
+/// error
+/// );
+/// event!(name: "answer", Level::INFO, the_answer = data.0);
+/// event!(Level::INFO, the_answer = data.0);
+/// # }
+/// ```
+///
+// /// Note that *unlike `span!`*, `event!` requires a value for all fields. As
+// /// events are recorded immediately when the macro is invoked, there is no
+// /// opportunity for fields to be recorded later. A trailing comma on the final
+// /// field is valid.
+// ///
+// /// For example, the following does not compile:
+// /// ```rust,compile_fail
+// /// # use tracing::{Level, event};
+// /// # fn main() {
+// /// event!(Level::INFO, foo = 5, bad_field, bar = "hello")
+// /// #}
+// /// ```
+#[macro_export]
+macro_rules! event {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::__macro_support::MacroCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::EVENT,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ let meta = __CALLSITE.metadata();
+ // event with explicit parent
+ $crate::Event::child_of(
+ $parent,
+ meta,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ name: $name,
+ target: $target,
+ parent: $parent,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $lvl, { $($k).+ = $($fields)* })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $lvl:expr, $($arg:tt)+) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $lvl, { $($arg)+ })
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::__macro_support::MacroCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::EVENT,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ let meta = __CALLSITE.metadata();
+ // event with contextual parent
+ $crate::Event::dispatch(
+ meta,
+ &value_set
+ );
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (name: $name:expr, target: $target:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ name: $name,
+ target: $target,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (name: $name:expr, target: $target:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $lvl, { $($k).+ = $($fields)* })
+ );
+ (name: $name:expr, target: $target:expr, $lvl:expr, $($arg:tt)+) => (
+ $crate::event!(name: $name, target: $target, $lvl, { $($arg)+ })
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::callsite::DefaultCallsite = $crate::callsite2! {
+ name: $crate::__macro_support::concat!(
+ "event ",
+ file!(),
+ ":",
+ line!()
+ ),
+ kind: $crate::metadata::Kind::EVENT,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ let meta = __CALLSITE.metadata();
+ // event with explicit parent
+ $crate::Event::child_of(
+ $parent,
+ meta,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: $target,
+ parent: $parent,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $lvl, { $($k).+ = $($fields)* })
+ );
+ (target: $target:expr, parent: $parent:expr, $lvl:expr, $($arg:tt)+) => (
+ $crate::event!(target: $target, parent: $parent, $lvl, { $($arg)+ })
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::__macro_support::MacroCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::EVENT,
+ target: module_path!(),
+ level: $lvl,
+ fields: $($fields)*
+ };
+
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && __CALLSITE.is_enabled(interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ let meta = __CALLSITE.metadata();
+ // event with explicit parent
+ $crate::Event::child_of(
+ $parent,
+ meta,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (name: $name:expr, parent: $parent:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ name: $name,
+ parent: $parent,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (name: $name:expr, parent: $parent:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $lvl, { $($k).+ = $($fields)* })
+ );
+ (name: $name:expr, parent: $parent:expr, $lvl:expr, $($arg:tt)+) => (
+ $crate::event!(name: $name, parent: $parent, $lvl, { $($arg)+ })
+ );
+
+ // Name.
+ (name: $name:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::__macro_support::MacroCallsite = $crate::callsite2! {
+ name: $name,
+ kind: $crate::metadata::Kind::EVENT,
+ target: module_path!(),
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ let meta = __CALLSITE.metadata();
+ // event with contextual parent
+ $crate::Event::dispatch(
+ meta,
+ &value_set
+ );
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (name: $name:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ name: $name,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (name: $name:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(name: $name, $lvl, { $($k).+ = $($fields)* })
+ );
+ (name: $name:expr, $lvl:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $lvl, { $($arg)+ })
+ );
+
+ // Target.
+ (target: $target:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::callsite::DefaultCallsite = $crate::callsite2! {
+ name: $crate::__macro_support::concat!(
+ "event ",
+ file!(),
+ ":",
+ line!()
+ ),
+ kind: $crate::metadata::Kind::EVENT,
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let enabled = $crate::level_enabled!($lvl) && {
+ let interest = __CALLSITE.interest();
+ !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest)
+ };
+ if enabled {
+ (|value_set: $crate::field::ValueSet| {
+ let meta = __CALLSITE.metadata();
+ // event with contextual parent
+ $crate::Event::dispatch(
+ meta,
+ &value_set
+ );
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &value_set
+ );
+ })($crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*));
+ } else {
+ $crate::__tracing_log!(
+ $lvl,
+ __CALLSITE,
+ &$crate::valueset!(__CALLSITE.metadata().fields(), $($fields)*)
+ );
+ }
+ });
+ (target: $target:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: $target,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (target: $target:expr, $lvl:expr, $($k:ident).+ = $($fields:tt)* ) => (
+ $crate::event!(target: $target, $lvl, { $($k).+ = $($fields)* })
+ );
+ (target: $target:expr, $lvl:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $lvl, { $($arg)+ })
+ );
+
+ // Parent.
+ (parent: $parent:expr, $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $lvl,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $lvl:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: module_path!(), parent: $parent, $lvl, { $($arg)+ })
+ );
+
+ // ...
+ ( $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { message = ::core::format_args!($($arg)+), $($fields)* }
+ )
+ );
+ ( $lvl:expr, { $($fields:tt)* }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { message = format_args!($($arg)+), $($fields)* }
+ )
+ );
+ ($lvl:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { $($k).+ = $($field)*}
+ )
+ );
+ ($lvl:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { $($k).+, $($field)*}
+ )
+ );
+ ($lvl:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ ($lvl:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $lvl,
+ { %$($k).+, $($field)*}
+ )
+ );
+ ($lvl:expr, ?$($k:ident).+) => (
+ $crate::event!($lvl, ?$($k).+,)
+ );
+ ($lvl:expr, %$($k:ident).+) => (
+ $crate::event!($lvl, %$($k).+,)
+ );
+ ($lvl:expr, $($k:ident).+) => (
+ $crate::event!($lvl, $($k).+,)
+ );
+ ( $lvl:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: module_path!(), $lvl, { $($arg)+ })
+ );
+}
+
+/// Tests whether an event with the specified level and target would be enabled.
+///
+/// This is similar to [`enabled!`], but queries the current subscriber specifically for
+/// an event, whereas [`enabled!`] queries for an event _or_ span.
+///
+/// See the documentation for [`enabled!]` for more details on using this macro.
+/// See also [`span_enabled!`].
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{event_enabled, Level};
+/// if event_enabled!(target: "my_crate", Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// // simpler
+/// if event_enabled!(Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// // with fields
+/// if event_enabled!(Level::DEBUG, foo_field) {
+/// // some expensive work...
+/// }
+/// ```
+///
+/// [`enabled!`]: crate::enabled
+/// [`span_enabled!`]: crate::span_enabled
+#[macro_export]
+macro_rules! event_enabled {
+ ($($rest:tt)*)=> (
+ $crate::enabled!(kind: $crate::metadata::Kind::EVENT, $($rest)*)
+ )
+}
+
+/// Tests whether a span with the specified level and target would be enabled.
+///
+/// This is similar to [`enabled!`], but queries the current subscriber specifically for
+/// an event, whereas [`enabled!`] queries for an event _or_ span.
+///
+/// See the documentation for [`enabled!]` for more details on using this macro.
+/// See also [`span_enabled!`].
+///
+/// # Examples
+///
+/// ```rust
+/// # use tracing::{span_enabled, Level};
+/// if span_enabled!(target: "my_crate", Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// // simpler
+/// if span_enabled!(Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// // with fields
+/// if span_enabled!(Level::DEBUG, foo_field) {
+/// // some expensive work...
+/// }
+/// ```
+///
+/// [`enabled!`]: crate::enabled
+/// [`span_enabled!`]: crate::span_enabled
+#[macro_export]
+macro_rules! span_enabled {
+ ($($rest:tt)*)=> (
+ $crate::enabled!(kind: $crate::metadata::Kind::SPAN, $($rest)*)
+ )
+}
+
+/// Checks whether a span or event is [enabled] based on the provided [metadata].
+///
+/// [enabled]: crate::Subscriber::enabled
+/// [metadata]: crate::Metadata
+///
+/// This macro is a specialized tool: it is intended to be used prior
+/// to an expensive computation required *just* for that event, but
+/// *cannot* be done as part of an argument to that event, such as
+/// when multiple events are emitted (e.g., iterating over a collection
+/// and emitting an event for each item).
+///
+/// # Usage
+///
+/// [Subscribers] can make filtering decisions based all the data included in a
+/// span or event's [`Metadata`]. This means that it is possible for `enabled!`
+/// to return a _false positive_ (indicating that something would be enabled
+/// when it actually would not be) or a _false negative_ (indicating that
+/// something would be disabled when it would actually be enabled).
+///
+/// [Subscribers]: crate::subscriber::Subscriber
+/// [`Metadata`]: crate::metadata::Metadata
+///
+/// This occurs when a subscriber is using a _more specific_ filter than the
+/// metadata provided to the `enabled!` macro. Some situations that can result
+/// in false positives or false negatives include:
+///
+/// - If a subscriber is using a filter which may enable a span or event based
+/// on field names, but `enabled!` is invoked without listing field names,
+/// `enabled!` may return a false negative if a specific field name would
+/// cause the subscriber to enable something that would otherwise be disabled.
+/// - If a subscriber is using a filter which enables or disables specific events by
+/// file path and line number, a particular event may be enabled/disabled
+/// even if an `enabled!` invocation with the same level, target, and fields
+/// indicated otherwise.
+/// - The subscriber can choose to enable _only_ spans or _only_ events, which `enabled`
+/// will not reflect.
+///
+/// `enabled!()` requires a [level](crate::Level) argument, an optional `target:`
+/// argument, and an optional set of field names. If the fields are not provided,
+/// they are considered to be unknown. `enabled!` attempts to match the
+/// syntax of `event!()` as closely as possible, which can be seen in the
+/// examples below.
+///
+/// # Examples
+///
+/// If the current subscriber is interested in recording `DEBUG`-level spans and
+/// events in the current file and module path, this will evaluate to true:
+/// ```rust
+/// use tracing::{enabled, Level};
+///
+/// if enabled!(Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// ```
+///
+/// If the current subscriber is interested in recording spans and events
+/// in the current file and module path, with the target "my_crate", and at the
+/// level `DEBUG`, this will evaluate to true:
+/// ```rust
+/// # use tracing::{enabled, Level};
+/// if enabled!(target: "my_crate", Level::DEBUG) {
+/// // some expensive work...
+/// }
+/// ```
+///
+/// If the current subscriber is interested in recording spans and events
+/// in the current file and module path, with the target "my_crate", at
+/// the level `DEBUG`, and with a field named "hello", this will evaluate
+/// to true:
+///
+/// ```rust
+/// # use tracing::{enabled, Level};
+/// if enabled!(target: "my_crate", Level::DEBUG, hello) {
+/// // some expensive work...
+/// }
+/// ```
+///
+/// # Alternatives
+///
+/// `enabled!` queries subscribers with [`Metadata`] where
+/// [`is_event`] and [`is_span`] both return `false`. Alternatively,
+/// use [`event_enabled!`] or [`span_enabled!`] to ensure one of these
+/// returns true.
+///
+///
+/// [`Metadata`]: crate::Metadata
+/// [`is_event`]: crate::Metadata::is_event
+/// [`is_span`]: crate::Metadata::is_span
+/// [`enabled!`]: crate::enabled
+/// [`span_enabled!`]: crate::span_enabled
+#[macro_export]
+macro_rules! enabled {
+ (kind: $kind:expr, target: $target:expr, $lvl:expr, { $($fields:tt)* } )=> ({
+ if $crate::level_enabled!($lvl) {
+ use $crate::__macro_support::Callsite as _;
+ static __CALLSITE: $crate::callsite::DefaultCallsite = $crate::callsite2! {
+ name: $crate::__macro_support::concat!(
+ "enabled ",
+ file!(),
+ ":",
+ line!()
+ ),
+ kind: $kind.hint(),
+ target: $target,
+ level: $lvl,
+ fields: $($fields)*
+ };
+ let interest = __CALLSITE.interest();
+ if !interest.is_never() && $crate::__macro_support::__is_enabled(__CALLSITE.metadata(), interest) {
+ let meta = __CALLSITE.metadata();
+ $crate::dispatcher::get_default(|current| current.enabled(meta))
+ } else {
+ false
+ }
+ } else {
+ false
+ }
+ });
+ // Just target and level
+ (kind: $kind:expr, target: $target:expr, $lvl:expr ) => (
+ $crate::enabled!(kind: $kind, target: $target, $lvl, { })
+ );
+ (target: $target:expr, $lvl:expr ) => (
+ $crate::enabled!(kind: $crate::metadata::Kind::HINT, target: $target, $lvl, { })
+ );
+
+ // These four cases handle fields with no values
+ (kind: $kind:expr, target: $target:expr, $lvl:expr, $($field:tt)*) => (
+ $crate::enabled!(
+ kind: $kind,
+ target: $target,
+ $lvl,
+ { $($field)*}
+ )
+ );
+ (target: $target:expr, $lvl:expr, $($field:tt)*) => (
+ $crate::enabled!(
+ kind: $crate::metadata::Kind::HINT,
+ target: $target,
+ $lvl,
+ { $($field)*}
+ )
+ );
+
+ // Level and field case
+ (kind: $kind:expr, $lvl:expr, $($field:tt)*) => (
+ $crate::enabled!(
+ kind: $kind,
+ target: module_path!(),
+ $lvl,
+ { $($field)*}
+ )
+ );
+
+ // Simplest `enabled!` case
+ (kind: $kind:expr, $lvl:expr) => (
+ $crate::enabled!(kind: $kind, target: module_path!(), $lvl, { })
+ );
+ ($lvl:expr) => (
+ $crate::enabled!(kind: $crate::metadata::Kind::HINT, target: module_path!(), $lvl, { })
+ );
+
+ // Fallthrough from above
+ ($lvl:expr, $($field:tt)*) => (
+ $crate::enabled!(
+ kind: $crate::metadata::Kind::HINT,
+ target: module_path!(),
+ $lvl,
+ { $($field)*}
+ )
+ );
+}
+
+/// Constructs an event at the trace level.
+///
+/// This functions similarly to the [`event!`] macro. See [the top-level
+/// documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [`event!`]: crate::event!
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::trace;
+/// # #[derive(Debug, Copy, Clone)] struct Position { x: f32, y: f32 }
+/// # impl Position {
+/// # const ORIGIN: Self = Self { x: 0.0, y: 0.0 };
+/// # fn dist(&self, other: Position) -> f32 {
+/// # let x = (other.x - self.x).exp2(); let y = (self.y - other.y).exp2();
+/// # (x + y).sqrt()
+/// # }
+/// # }
+/// # fn main() {
+/// let pos = Position { x: 3.234, y: -1.223 };
+/// let origin_dist = pos.dist(Position::ORIGIN);
+///
+/// trace!(position = ?pos, ?origin_dist);
+/// trace!(
+/// target: "app_events",
+/// position = ?pos,
+/// "x is {} and y is {}",
+/// if pos.x >= 0.0 { "positive" } else { "negative" },
+/// if pos.y >= 0.0 { "positive" } else { "negative" }
+/// );
+/// trace!(name: "completed", position = ?pos);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! trace {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::TRACE, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Name.
+ (name: $name:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::TRACE, { $($k).+ $($field)* })
+ );
+ (name: $name:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::TRACE, { ?$($k).+ $($field)* })
+ );
+ (name: $name:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::TRACE, { %$($k).+ $($field)* })
+ );
+ (name: $name:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Target.
+ (target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::TRACE, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::TRACE, { $($k).+ $($field)* })
+ );
+ (target: $target:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::TRACE, { ?$($k).+ $($field)* })
+ );
+ (target: $target:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::TRACE, { %$($k).+ $($field)* })
+ );
+ (target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $crate::Level::TRACE, {}, $($arg)+)
+ );
+
+ // Parent.
+ (parent: $parent:expr, { $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::TRACE,
+ {},
+ $($arg)+
+ )
+ );
+
+ // ...
+ ({ $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ ($($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (%$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ ($($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { $($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (%$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { ?$($k).+ }
+ )
+ );
+ (%$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { %$($k).+ }
+ )
+ );
+ ($($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ { $($k).+ }
+ )
+ );
+ ($($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::TRACE,
+ {},
+ $($arg)+
+ )
+ );
+}
+
+/// Constructs an event at the debug level.
+///
+/// This functions similarly to the [`event!`] macro. See [the top-level
+/// documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [`event!`]: crate::event!
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::debug;
+/// # fn main() {
+/// # #[derive(Debug)] struct Position { x: f32, y: f32 }
+///
+/// let pos = Position { x: 3.234, y: -1.223 };
+///
+/// debug!(?pos.x, ?pos.y);
+/// debug!(target: "app_events", position = ?pos, "New position");
+/// debug!(name: "completed", position = ?pos);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! debug {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::DEBUG, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Name.
+ (name: $name:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::DEBUG, { $($k).+ $($field)* })
+ );
+ (name: $name:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::DEBUG, { ?$($k).+ $($field)* })
+ );
+ (name: $name:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::DEBUG, { %$($k).+ $($field)* })
+ );
+ (name: $name:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Target.
+ (target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::DEBUG, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::DEBUG, { $($k).+ $($field)* })
+ );
+ (target: $target:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::DEBUG, { ?$($k).+ $($field)* })
+ );
+ (target: $target:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::DEBUG, { %$($k).+ $($field)* })
+ );
+ (target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $crate::Level::DEBUG, {}, $($arg)+)
+ );
+
+ // Parent.
+ (parent: $parent:expr, { $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::DEBUG,
+ {},
+ $($arg)+
+ )
+ );
+
+ // ...
+ ({ $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ ($($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (%$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ ($($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { $($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (%$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { ?$($k).+ }
+ )
+ );
+ (%$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { %$($k).+ }
+ )
+ );
+ ($($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ { $($k).+ }
+ )
+ );
+ ($($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::DEBUG,
+ {},
+ $($arg)+
+ )
+ );
+}
+
+/// Constructs an event at the info level.
+///
+/// This functions similarly to the [`event!`] macro. See [the top-level
+/// documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [`event!`]: crate::event!
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::info;
+/// # // this is so the test will still work in no-std mode
+/// # #[derive(Debug)]
+/// # pub struct Ipv4Addr;
+/// # impl Ipv4Addr { fn new(o1: u8, o2: u8, o3: u8, o4: u8) -> Self { Self } }
+/// # fn main() {
+/// # struct Connection { port: u32, speed: f32 }
+/// use tracing::field;
+///
+/// let addr = Ipv4Addr::new(127, 0, 0, 1);
+/// let conn = Connection { port: 40, speed: 3.20 };
+///
+/// info!(conn.port, "connected to {:?}", addr);
+/// info!(
+/// target: "connection_events",
+/// ip = ?addr,
+/// conn.port,
+/// ?conn.speed,
+/// );
+/// info!(name: "completed", "completed connection to {:?}", addr);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! info {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::INFO, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Name.
+ (name: $name:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::INFO, { $($k).+ $($field)* })
+ );
+ (name: $name:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::INFO, { ?$($k).+ $($field)* })
+ );
+ (name: $name:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::INFO, { %$($k).+ $($field)* })
+ );
+ (name: $name:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Target.
+ (target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::INFO, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::INFO, { $($k).+ $($field)* })
+ );
+ (target: $target:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::INFO, { ?$($k).+ $($field)* })
+ );
+ (target: $target:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::INFO, { %$($k).+ $($field)* })
+ );
+ (target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $crate::Level::INFO, {}, $($arg)+)
+ );
+
+ // Parent.
+ (parent: $parent:expr, { $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::INFO,
+ {},
+ $($arg)+
+ )
+ );
+
+ // ...
+ ({ $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ ($($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (%$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ ($($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { $($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (%$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { ?$($k).+ }
+ )
+ );
+ (%$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { %$($k).+ }
+ )
+ );
+ ($($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ { $($k).+ }
+ )
+ );
+ ($($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::INFO,
+ {},
+ $($arg)+
+ )
+ );
+}
+
+/// Constructs an event at the warn level.
+///
+/// This functions similarly to the [`event!`] macro. See [the top-level
+/// documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [`event!`]: crate::event!
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::warn;
+/// # fn main() {
+///
+/// let warn_description = "Invalid Input";
+/// let input = &[0x27, 0x45];
+///
+/// warn!(?input, warning = warn_description);
+/// warn!(
+/// target: "input_events",
+/// warning = warn_description,
+/// "Received warning for input: {:?}", input,
+/// );
+/// warn!(name: "invalid", ?input);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! warn {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::WARN, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Name.
+ (name: $name:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::WARN, { $($k).+ $($field)* })
+ );
+ (name: $name:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::WARN, { ?$($k).+ $($field)* })
+ );
+ (name: $name:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::WARN, { %$($k).+ $($field)* })
+ );
+ (name: $name:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Target.
+ (target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::WARN, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::WARN, { $($k).+ $($field)* })
+ );
+ (target: $target:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::WARN, { ?$($k).+ $($field)* })
+ );
+ (target: $target:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::WARN, { %$($k).+ $($field)* })
+ );
+ (target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $crate::Level::WARN, {}, $($arg)+)
+ );
+
+ // Parent.
+ (parent: $parent:expr, { $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::WARN,
+ {},
+ $($arg)+
+ )
+ );
+
+ // ...
+ ({ $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ ($($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (%$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ ($($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { $($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (%$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { ?$($k).+ }
+ )
+ );
+ (%$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { %$($k).+ }
+ )
+ );
+ ($($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ { $($k).+ }
+ )
+ );
+ ($($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::WARN,
+ {},
+ $($arg)+
+ )
+ );
+}
+
+/// Constructs an event at the error level.
+///
+/// This functions similarly to the [`event!`] macro. See [the top-level
+/// documentation][lib] for details on the syntax accepted by
+/// this macro.
+///
+/// [`event!`]: crate::event!
+/// [lib]: crate#using-the-macros
+///
+/// # Examples
+///
+/// ```rust
+/// use tracing::error;
+/// # fn main() {
+///
+/// let (err_info, port) = ("No connection", 22);
+///
+/// error!(port, error = %err_info);
+/// error!(target: "app_events", "App Error: {}", err_info);
+/// error!({ info = err_info }, "error on port: {}", port);
+/// error!(name: "invalid_input", "Invalid input: {}", err_info);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! error {
+ // Name / target / parent.
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, parent: $parent, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Name / target.
+ (name: $name:expr, target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, target: $target:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, target: $target, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Target / parent.
+ (target: $target:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (target: $target:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, parent: $parent, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Name / parent.
+ (name: $name:expr, parent: $parent:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, parent: $parent:expr, $($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, ?$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, %$($k:ident).+ $($field:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::ERROR, { $($k).+ $($field)+ })
+ );
+ (name: $name:expr, parent: $parent:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, parent: $parent, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Name.
+ (name: $name:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (name: $name:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::ERROR, { $($k).+ $($field)* })
+ );
+ (name: $name:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::ERROR, { ?$($k).+ $($field)* })
+ );
+ (name: $name:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(name: $name, $crate::Level::ERROR, { %$($k).+ $($field)* })
+ );
+ (name: $name:expr, $($arg:tt)+ ) => (
+ $crate::event!(name: $name, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Target.
+ (target: $target:expr, { $($field:tt)* }, $($arg:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::ERROR, { $($field)* }, $($arg)*)
+ );
+ (target: $target:expr, $($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::ERROR, { $($k).+ $($field)* })
+ );
+ (target: $target:expr, ?$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::ERROR, { ?$($k).+ $($field)* })
+ );
+ (target: $target:expr, %$($k:ident).+ $($field:tt)* ) => (
+ $crate::event!(target: $target, $crate::Level::ERROR, { %$($k).+ $($field)* })
+ );
+ (target: $target:expr, $($arg:tt)+ ) => (
+ $crate::event!(target: $target, $crate::Level::ERROR, {}, $($arg)+)
+ );
+
+ // Parent.
+ (parent: $parent:expr, { $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { $($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, ?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, %$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (parent: $parent:expr, $($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ parent: $parent,
+ $crate::Level::ERROR,
+ {},
+ $($arg)+
+ )
+ );
+
+ // ...
+ ({ $($field:tt)+ }, $($arg:tt)+ ) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { $($field)+ },
+ $($arg)+
+ )
+ );
+ ($($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { $($k).+ = $($field)*}
+ )
+ );
+ (?$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { ?$($k).+ = $($field)*}
+ )
+ );
+ (%$($k:ident).+ = $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { %$($k).+ = $($field)*}
+ )
+ );
+ ($($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { $($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { ?$($k).+, $($field)*}
+ )
+ );
+ (%$($k:ident).+, $($field:tt)*) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { %$($k).+, $($field)*}
+ )
+ );
+ (?$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { ?$($k).+ }
+ )
+ );
+ (%$($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { %$($k).+ }
+ )
+ );
+ ($($k:ident).+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ { $($k).+ }
+ )
+ );
+ ($($arg:tt)+) => (
+ $crate::event!(
+ target: module_path!(),
+ $crate::Level::ERROR,
+ {},
+ $($arg)+
+ )
+ );
+}
+
+/// Constructs a new static callsite for a span or event.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! callsite {
+ (name: $name:expr, kind: $kind:expr, fields: $($fields:tt)*) => {{
+ $crate::callsite! {
+ name: $name,
+ kind: $kind,
+ target: module_path!(),
+ level: $crate::Level::TRACE,
+ fields: $($fields)*
+ }
+ }};
+ (
+ name: $name:expr,
+ kind: $kind:expr,
+ level: $lvl:expr,
+ fields: $($fields:tt)*
+ ) => {{
+ $crate::callsite! {
+ name: $name,
+ kind: $kind,
+ target: module_path!(),
+ level: $lvl,
+ fields: $($fields)*
+ }
+ }};
+ (
+ name: $name:expr,
+ kind: $kind:expr,
+ target: $target:expr,
+ level: $lvl:expr,
+ fields: $($fields:tt)*
+ ) => {{
+ static META: $crate::Metadata<'static> = {
+ $crate::metadata! {
+ name: $name,
+ target: $target,
+ level: $lvl,
+ fields: $crate::fieldset!( $($fields)* ),
+ callsite: &__CALLSITE,
+ kind: $kind,
+ }
+ };
+ static __CALLSITE: $crate::callsite::DefaultCallsite = $crate::callsite::DefaultCallsite::new(&META);
+ __CALLSITE.register();
+ &__CALLSITE
+ }};
+}
+
+/// Constructs a new static callsite for a span or event.
+#[doc(hidden)]
+#[macro_export]
+macro_rules! callsite2 {
+ (name: $name:expr, kind: $kind:expr, fields: $($fields:tt)*) => {{
+ $crate::callsite2! {
+ name: $name,
+ kind: $kind,
+ target: module_path!(),
+ level: $crate::Level::TRACE,
+ fields: $($fields)*
+ }
+ }};
+ (
+ name: $name:expr,
+ kind: $kind:expr,
+ level: $lvl:expr,
+ fields: $($fields:tt)*
+ ) => {{
+ $crate::callsite2! {
+ name: $name,
+ kind: $kind,
+ target: module_path!(),
+ level: $lvl,
+ fields: $($fields)*
+ }
+ }};
+ (
+ name: $name:expr,
+ kind: $kind:expr,
+ target: $target:expr,
+ level: $lvl:expr,
+ fields: $($fields:tt)*
+ ) => {{
+ static META: $crate::Metadata<'static> = {
+ $crate::metadata! {
+ name: $name,
+ target: $target,
+ level: $lvl,
+ fields: $crate::fieldset!( $($fields)* ),
+ callsite: &__CALLSITE,
+ kind: $kind,
+ }
+ };
+ $crate::callsite::DefaultCallsite::new(&META)
+ }};
+}
+
+#[macro_export]
+// TODO: determine if this ought to be public API?`
+#[doc(hidden)]
+macro_rules! level_enabled {
+ ($lvl:expr) => {
+ $lvl <= $crate::level_filters::STATIC_MAX_LEVEL
+ && $lvl <= $crate::level_filters::LevelFilter::current()
+ };
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! valueset {
+
+ // === base case ===
+ (@ { $(,)* $($val:expr),* $(,)* }, $next:expr $(,)*) => {
+ &[ $($val),* ]
+ };
+
+ // === recursive case (more tts) ===
+
+ // TODO(#1138): determine a new syntax for uninitialized span fields, and
+ // re-enable this.
+ // (@{ $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = _, $($rest:tt)*) => {
+ // $crate::valueset!(@ { $($out),*, (&$next, None) }, $next, $($rest)*)
+ // };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = ?$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = %$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = $val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$val as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$($k).+ as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, ?$($k:ident).+, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$($k).+) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, %$($k:ident).+, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$($k).+) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = ?$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = %$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+ = $val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$val as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($k:ident).+) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$($k).+ as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, ?$($k:ident).+) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$($k).+) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, %$($k:ident).+) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$($k).+) as &dyn Value)) },
+ $next,
+ )
+ };
+
+ // Handle literal names
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = ?$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = %$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = $val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$val as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = ?$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = %$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&display(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, $k:literal = $val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, ::core::option::Option::Some(&$val as &dyn Value)) },
+ $next,
+ )
+ };
+
+ // Handle constant names
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = ?$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = %$val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&display(&$val) as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = $val:expr, $($rest:tt)*) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&$val as &dyn Value)) },
+ $next,
+ $($rest)*
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = ?$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&debug(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = %$val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&display(&$val) as &dyn Value)) },
+ $next,
+ )
+ };
+ (@ { $(,)* $($out:expr),* }, $next:expr, { $k:expr } = $val:expr) => {
+ $crate::valueset!(
+ @ { $($out),*, (&$next, Some(&$val as &dyn Value)) },
+ $next,
+ )
+ };
+
+ // Remainder is unparsable, but exists --- must be format args!
+ (@ { $(,)* $($out:expr),* }, $next:expr, $($rest:tt)+) => {
+ $crate::valueset!(@ { (&$next, ::core::option::Option::Some(&::core::format_args!($($rest)+) as &dyn Value)), $($out),* }, $next, )
+ };
+
+ // === entry ===
+ ($fields:expr, $($kvs:tt)+) => {
+ {
+ #[allow(unused_imports)]
+ use $crate::field::{debug, display, Value};
+ let mut iter = $fields.iter();
+ $fields.value_set($crate::valueset!(
+ @ { },
+ ::core::iter::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
+ $($kvs)+
+ ))
+ }
+ };
+ ($fields:expr,) => {
+ {
+ $fields.value_set(&[])
+ }
+ };
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! fieldset {
+ // == base case ==
+ (@ { $(,)* $($out:expr),* $(,)* } $(,)*) => {
+ &[ $($out),* ]
+ };
+
+ // == recursive cases (more tts) ==
+ (@ { $(,)* $($out:expr),* } $($k:ident).+ = ?$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } $($k:ident).+ = %$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } $($k:ident).+ = $val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+ // TODO(#1138): determine a new syntax for uninitialized span fields, and
+ // re-enable this.
+ // (@ { $($out:expr),* } $($k:ident).+ = _, $($rest:tt)*) => {
+ // $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ // };
+ (@ { $(,)* $($out:expr),* } ?$($k:ident).+, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } %$($k:ident).+, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } $($k:ident).+, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $crate::__tracing_stringify!($($k).+) } $($rest)*)
+ };
+
+ // Handle literal names
+ (@ { $(,)* $($out:expr),* } $k:literal = ?$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } $k:literal = %$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } $k:literal = $val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+
+ // Handle constant names
+ (@ { $(,)* $($out:expr),* } { $k:expr } = ?$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } { $k:expr } = %$val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+ (@ { $(,)* $($out:expr),* } { $k:expr } = $val:expr, $($rest:tt)*) => {
+ $crate::fieldset!(@ { $($out),*, $k } $($rest)*)
+ };
+
+ // Remainder is unparseable, but exists --- must be format args!
+ (@ { $(,)* $($out:expr),* } $($rest:tt)+) => {
+ $crate::fieldset!(@ { "message", $($out),*, })
+ };
+
+ // == entry ==
+ ($($args:tt)*) => {
+ $crate::fieldset!(@ { } $($args)*,)
+ };
+
+}
+
+#[cfg(feature = "log")]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! level_to_log {
+ ($level:expr) => {
+ match $level {
+ $crate::Level::ERROR => $crate::log::Level::Error,
+ $crate::Level::WARN => $crate::log::Level::Warn,
+ $crate::Level::INFO => $crate::log::Level::Info,
+ $crate::Level::DEBUG => $crate::log::Level::Debug,
+ _ => $crate::log::Level::Trace,
+ }
+ };
+}
+
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __tracing_stringify {
+ ($s:expr) => {
+ stringify!($s)
+ };
+}
+
+#[cfg(not(feature = "log"))]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __tracing_log {
+ ($level:expr, $callsite:expr, $value_set:expr) => {};
+}
+
+#[cfg(feature = "log")]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! __tracing_log {
+ ($level:expr, $callsite:expr, $value_set:expr) => {
+ $crate::if_log_enabled! { $level, {
+ use $crate::log;
+ let level = $crate::level_to_log!($level);
+ if level <= log::max_level() {
+ let meta = $callsite.metadata();
+ let log_meta = log::Metadata::builder()
+ .level(level)
+ .target(meta.target())
+ .build();
+ let logger = log::logger();
+ if logger.enabled(&log_meta) {
+ $crate::__macro_support::__tracing_log(meta, logger, log_meta, $value_set)
+ }
+ }
+ }}
+ };
+}
+
+#[cfg(not(feature = "log"))]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! if_log_enabled {
+ ($lvl:expr, $e:expr;) => {
+ $crate::if_log_enabled! { $lvl, $e }
+ };
+ ($lvl:expr, $if_log:block) => {
+ $crate::if_log_enabled! { $lvl, $if_log else {} }
+ };
+ ($lvl:expr, $if_log:block else $else_block:block) => {
+ $else_block
+ };
+}
+
+#[cfg(all(feature = "log", not(feature = "log-always")))]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! if_log_enabled {
+ ($lvl:expr, $e:expr;) => {
+ $crate::if_log_enabled! { $lvl, $e }
+ };
+ ($lvl:expr, $if_log:block) => {
+ $crate::if_log_enabled! { $lvl, $if_log else {} }
+ };
+ ($lvl:expr, $if_log:block else $else_block:block) => {
+ if $crate::level_to_log!($lvl) <= $crate::log::STATIC_MAX_LEVEL {
+ if !$crate::dispatcher::has_been_set() {
+ $if_log
+ } else {
+ $else_block
+ }
+ } else {
+ $else_block
+ }
+ };
+}
+
+#[cfg(all(feature = "log", feature = "log-always"))]
+#[doc(hidden)]
+#[macro_export]
+macro_rules! if_log_enabled {
+ ($lvl:expr, $e:expr;) => {
+ $crate::if_log_enabled! { $lvl, $e }
+ };
+ ($lvl:expr, $if_log:block) => {
+ $crate::if_log_enabled! { $lvl, $if_log else {} }
+ };
+ ($lvl:expr, $if_log:block else $else_block:block) => {
+ if $crate::level_to_log!($lvl) <= $crate::log::STATIC_MAX_LEVEL {
+ #[allow(unused_braces)]
+ $if_log
+ } else {
+ $else_block
+ }
+ };
+}
diff --git a/crates/tracing/src/span.rs b/crates/tracing/src/span.rs
new file mode 100644
index 0000000..3c235dc
--- /dev/null
+++ b/crates/tracing/src/span.rs
@@ -0,0 +1,1623 @@
+//! Spans represent periods of time in which a program was executing in a
+//! particular context.
+//!
+//! A span consists of [fields], user-defined key-value pairs of arbitrary data
+//! that describe the context the span represents, and a set of fixed attributes
+//! that describe all `tracing` spans and events. Attributes describing spans
+//! include:
+//!
+//! - An [`Id`] assigned by the subscriber that uniquely identifies it in relation
+//! to other spans.
+//! - The span's [parent] in the trace tree.
+//! - [Metadata] that describes static characteristics of all spans
+//! originating from that callsite, such as its name, source code location,
+//! [verbosity level], and the names of its fields.
+//!
+//! # Creating Spans
+//!
+//! Spans are created using the [`span!`] macro. This macro is invoked with the
+//! following arguments, in order:
+//!
+//! - The [`target`] and/or [`parent`][parent] attributes, if the user wishes to
+//! override their default values.
+//! - The span's [verbosity level]
+//! - A string literal providing the span's name.
+//! - Finally, zero or more arbitrary key/value fields.
+//!
+//! [`target`]: super::Metadata::target
+//!
+//! For example:
+//! ```rust
+//! use tracing::{span, Level};
+//!
+//! /// Construct a new span at the `INFO` level named "my_span", with a single
+//! /// field named answer , with the value `42`.
+//! let my_span = span!(Level::INFO, "my_span", answer = 42);
+//! ```
+//!
+//! The documentation for the [`span!`] macro provides additional examples of
+//! the various options that exist when creating spans.
+//!
+//! The [`trace_span!`], [`debug_span!`], [`info_span!`], [`warn_span!`], and
+//! [`error_span!`] exist as shorthand for constructing spans at various
+//! verbosity levels.
+//!
+//! ## Recording Span Creation
+//!
+//! The [`Attributes`] type contains data associated with a span, and is
+//! provided to the [`Subscriber`] when a new span is created. It contains
+//! the span's metadata, the ID of [the span's parent][parent] if one was
+//! explicitly set, and any fields whose values were recorded when the span was
+//! constructed. The subscriber, which is responsible for recording `tracing`
+//! data, can then store or record these values.
+//!
+//! # The Span Lifecycle
+//!
+//! ## Entering a Span
+//!
+//! A thread of execution is said to _enter_ a span when it begins executing,
+//! and _exit_ the span when it switches to another context. Spans may be
+//! entered through the [`enter`], [`entered`], and [`in_scope`] methods.
+//!
+//! The [`enter`] method enters a span, returning a [guard] that exits the span
+//! when dropped
+//! ```
+//! # use tracing::{span, Level};
+//! let my_var: u64 = 5;
+//! let my_span = span!(Level::TRACE, "my_span", my_var);
+//!
+//! // `my_span` exists but has not been entered.
+//!
+//! // Enter `my_span`...
+//! let _enter = my_span.enter();
+//!
+//! // Perform some work inside of the context of `my_span`...
+//! // Dropping the `_enter` guard will exit the span.
+//!```
+//!
+//! <div class="example-wrap" style="display:inline-block"><pre class="compile_fail" style="white-space:normal;font:inherit;">
+//! <strong>Warning</strong>: In asynchronous code that uses async/await syntax,
+//! <code>Span::enter</code> may produce incorrect traces if the returned drop
+//! guard is held across an await point. See
+//! <a href="struct.Span.html#in-asynchronous-code">the method documentation</a>
+//! for details.
+//! </pre></div>
+//!
+//! The [`entered`] method is analogous to [`enter`], but moves the span into
+//! the returned guard, rather than borrowing it. This allows creating and
+//! entering a span in a single expression:
+//!
+//! ```
+//! # use tracing::{span, Level};
+//! // Create a span and enter it, returning a guard:
+//! let span = span!(Level::INFO, "my_span").entered();
+//!
+//! // We are now inside the span! Like `enter()`, the guard returned by
+//! // `entered()` will exit the span when it is dropped...
+//!
+//! // ...but, it can also be exited explicitly, returning the `Span`
+//! // struct:
+//! let span = span.exit();
+//! ```
+//!
+//! Finally, [`in_scope`] takes a closure or function pointer and executes it
+//! inside the span:
+//!
+//! ```
+//! # use tracing::{span, Level};
+//! let my_var: u64 = 5;
+//! let my_span = span!(Level::TRACE, "my_span", my_var = &my_var);
+//!
+//! my_span.in_scope(|| {
+//! // perform some work in the context of `my_span`...
+//! });
+//!
+//! // Perform some work outside of the context of `my_span`...
+//!
+//! my_span.in_scope(|| {
+//! // Perform some more work in the context of `my_span`.
+//! });
+//! ```
+//!
+//! <pre class="ignore" style="white-space:normal;font:inherit;">
+//! <strong>Note</strong>: Since entering a span takes <code>&self</code>, and
+//! <code>Span</code>s are <code>Clone</code>, <code>Send</code>, and
+//! <code>Sync</code>, it is entirely valid for multiple threads to enter the
+//! same span concurrently.
+//! </pre>
+//!
+//! ## Span Relationships
+//!
+//! Spans form a tree structure — unless it is a root span, all spans have a
+//! _parent_, and may have one or more _children_. When a new span is created,
+//! the current span becomes the new span's parent. The total execution time of
+//! a span consists of the time spent in that span and in the entire subtree
+//! represented by its children. Thus, a parent span always lasts for at least
+//! as long as the longest-executing span in its subtree.
+//!
+//! ```
+//! # use tracing::{Level, span};
+//! // this span is considered the "root" of a new trace tree:
+//! span!(Level::INFO, "root").in_scope(|| {
+//! // since we are now inside "root", this span is considered a child
+//! // of "root":
+//! span!(Level::DEBUG, "outer_child").in_scope(|| {
+//! // this span is a child of "outer_child", which is in turn a
+//! // child of "root":
+//! span!(Level::TRACE, "inner_child").in_scope(|| {
+//! // and so on...
+//! });
+//! });
+//! // another span created here would also be a child of "root".
+//! });
+//!```
+//!
+//! In addition, the parent of a span may be explicitly specified in
+//! the `span!` macro. For example:
+//!
+//! ```rust
+//! # use tracing::{Level, span};
+//! // Create, but do not enter, a span called "foo".
+//! let foo = span!(Level::INFO, "foo");
+//!
+//! // Create and enter a span called "bar".
+//! let bar = span!(Level::INFO, "bar");
+//! let _enter = bar.enter();
+//!
+//! // Although we have currently entered "bar", "baz"'s parent span
+//! // will be "foo".
+//! let baz = span!(parent: &foo, Level::INFO, "baz");
+//! ```
+//!
+//! A child span should typically be considered _part_ of its parent. For
+//! example, if a subscriber is recording the length of time spent in various
+//! spans, it should generally include the time spent in a span's children as
+//! part of that span's duration.
+//!
+//! In addition to having zero or one parent, a span may also _follow from_ any
+//! number of other spans. This indicates a causal relationship between the span
+//! and the spans that it follows from, but a follower is *not* typically
+//! considered part of the duration of the span it follows. Unlike the parent, a
+//! span may record that it follows from another span after it is created, using
+//! the [`follows_from`] method.
+//!
+//! As an example, consider a listener task in a server. As the listener accepts
+//! incoming connections, it spawns new tasks that handle those connections. We
+//! might want to have a span representing the listener, and instrument each
+//! spawned handler task with its own span. We would want our instrumentation to
+//! record that the handler tasks were spawned as a result of the listener task.
+//! However, we might not consider the handler tasks to be _part_ of the time
+//! spent in the listener task, so we would not consider those spans children of
+//! the listener span. Instead, we would record that the handler tasks follow
+//! from the listener, recording the causal relationship but treating the spans
+//! as separate durations.
+//!
+//! ## Closing Spans
+//!
+//! Execution may enter and exit a span multiple times before that span is
+//! _closed_. Consider, for example, a future which has an associated
+//! span and enters that span every time it is polled:
+//! ```rust
+//! # use std::future::Future;
+//! # use std::task::{Context, Poll};
+//! # use std::pin::Pin;
+//! struct MyFuture {
+//! // data
+//! span: tracing::Span,
+//! }
+//!
+//! impl Future for MyFuture {
+//! type Output = ();
+//!
+//! fn poll(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Self::Output> {
+//! let _enter = self.span.enter();
+//! // Do actual future work...
+//! # Poll::Ready(())
+//! }
+//! }
+//! ```
+//!
+//! If this future was spawned on an executor, it might yield one or more times
+//! before `poll` returns [`Poll::Ready`]. If the future were to yield, then
+//! the executor would move on to poll the next future, which may _also_ enter
+//! an associated span or series of spans. Therefore, it is valid for a span to
+//! be entered repeatedly before it completes. Only the time when that span or
+//! one of its children was the current span is considered to be time spent in
+//! that span. A span which is not executing and has not yet been closed is said
+//! to be _idle_.
+//!
+//! Because spans may be entered and exited multiple times before they close,
+//! [`Subscriber`]s have separate trait methods which are called to notify them
+//! of span exits and when span handles are dropped. When execution exits a
+//! span, [`exit`] will always be called with that span's ID to notify the
+//! subscriber that the span has been exited. When span handles are dropped, the
+//! [`drop_span`] method is called with that span's ID. The subscriber may use
+//! this to determine whether or not the span will be entered again.
+//!
+//! If there is only a single handle with the capacity to exit a span, dropping
+//! that handle "closes" the span, since the capacity to enter it no longer
+//! exists. For example:
+//! ```
+//! # use tracing::{Level, span};
+//! {
+//! span!(Level::TRACE, "my_span").in_scope(|| {
+//! // perform some work in the context of `my_span`...
+//! }); // --> Subscriber::exit(my_span)
+//!
+//! // The handle to `my_span` only lives inside of this block; when it is
+//! // dropped, the subscriber will be informed via `drop_span`.
+//!
+//! } // --> Subscriber::drop_span(my_span)
+//! ```
+//!
+//! However, if multiple handles exist, the span can still be re-entered even if
+//! one or more is dropped. For determining when _all_ handles to a span have
+//! been dropped, `Subscriber`s have a [`clone_span`] method, which is called
+//! every time a span handle is cloned. Combined with `drop_span`, this may be
+//! used to track the number of handles to a given span — if `drop_span` has
+//! been called one more time than the number of calls to `clone_span` for a
+//! given ID, then no more handles to the span with that ID exist. The
+//! subscriber may then treat it as closed.
+//!
+//! # When to use spans
+//!
+//! As a rule of thumb, spans should be used to represent discrete units of work
+//! (e.g., a given request's lifetime in a server) or periods of time spent in a
+//! given context (e.g., time spent interacting with an instance of an external
+//! system, such as a database).
+//!
+//! Which scopes in a program correspond to new spans depend somewhat on user
+//! intent. For example, consider the case of a loop in a program. Should we
+//! construct one span and perform the entire loop inside of that span, like:
+//!
+//! ```rust
+//! # use tracing::{Level, span};
+//! # let n = 1;
+//! let span = span!(Level::TRACE, "my_loop");
+//! let _enter = span.enter();
+//! for i in 0..n {
+//! # let _ = i;
+//! // ...
+//! }
+//! ```
+//! Or, should we create a new span for each iteration of the loop, as in:
+//! ```rust
+//! # use tracing::{Level, span};
+//! # let n = 1u64;
+//! for i in 0..n {
+//! let span = span!(Level::TRACE, "my_loop", iteration = i);
+//! let _enter = span.enter();
+//! // ...
+//! }
+//! ```
+//!
+//! Depending on the circumstances, we might want to do either, or both. For
+//! example, if we want to know how long was spent in the loop overall, we would
+//! create a single span around the entire loop; whereas if we wanted to know how
+//! much time was spent in each individual iteration, we would enter a new span
+//! on every iteration.
+//!
+//! [fields]: super::field
+//! [Metadata]: super::Metadata
+//! [verbosity level]: super::Level
+//! [`Poll::Ready`]: std::task::Poll::Ready
+//! [`span!`]: super::span!
+//! [`trace_span!`]: super::trace_span!
+//! [`debug_span!`]: super::debug_span!
+//! [`info_span!`]: super::info_span!
+//! [`warn_span!`]: super::warn_span!
+//! [`error_span!`]: super::error_span!
+//! [`clone_span`]: super::subscriber::Subscriber::clone_span()
+//! [`drop_span`]: super::subscriber::Subscriber::drop_span()
+//! [`exit`]: super::subscriber::Subscriber::exit
+//! [`Subscriber`]: super::subscriber::Subscriber
+//! [`enter`]: Span::enter()
+//! [`entered`]: Span::entered()
+//! [`in_scope`]: Span::in_scope()
+//! [`follows_from`]: Span::follows_from()
+//! [guard]: Entered
+//! [parent]: #span-relationships
+pub use tracing_core::span::{Attributes, Id, Record};
+
+use crate::stdlib::{
+ cmp, fmt,
+ hash::{Hash, Hasher},
+ marker::PhantomData,
+ mem,
+ ops::Deref,
+};
+use crate::{
+ dispatcher::{self, Dispatch},
+ field, Metadata,
+};
+
+/// Trait implemented by types which have a span `Id`.
+pub trait AsId: crate::sealed::Sealed {
+ /// Returns the `Id` of the span that `self` corresponds to, or `None` if
+ /// this corresponds to a disabled span.
+ fn as_id(&self) -> Option<&Id>;
+}
+
+/// A handle representing a span, with the capability to enter the span if it
+/// exists.
+///
+/// If the span was rejected by the current `Subscriber`'s filter, entering the
+/// span will silently do nothing. Thus, the handle can be used in the same
+/// manner regardless of whether or not the trace is currently being collected.
+#[derive(Clone)]
+pub struct Span {
+ /// A handle used to enter the span when it is not executing.
+ ///
+ /// If this is `None`, then the span has either closed or was never enabled.
+ inner: Option<Inner>,
+ /// Metadata describing the span.
+ ///
+ /// This might be `Some` even if `inner` is `None`, in the case that the
+ /// span is disabled but the metadata is needed for `log` support.
+ meta: Option<&'static Metadata<'static>>,
+}
+
+/// A handle representing the capacity to enter a span which is known to exist.
+///
+/// Unlike `Span`, this type is only constructed for spans which _have_ been
+/// enabled by the current filter. This type is primarily used for implementing
+/// span handles; users should typically not need to interact with it directly.
+#[derive(Debug)]
+pub(crate) struct Inner {
+ /// The span's ID, as provided by `subscriber`.
+ id: Id,
+
+ /// The subscriber that will receive events relating to this span.
+ ///
+ /// This should be the same subscriber that provided this span with its
+ /// `id`.
+ subscriber: Dispatch,
+}
+
+/// A guard representing a span which has been entered and is currently
+/// executing.
+///
+/// When the guard is dropped, the span will be exited.
+///
+/// This is returned by the [`Span::enter`] function.
+///
+/// [`Span::enter`]: super::Span::enter
+#[derive(Debug)]
+#[must_use = "once a span has been entered, it should be exited"]
+pub struct Entered<'a> {
+ span: &'a Span,
+}
+
+/// An owned version of [`Entered`], a guard representing a span which has been
+/// entered and is currently executing.
+///
+/// When the guard is dropped, the span will be exited.
+///
+/// This is returned by the [`Span::entered`] function.
+///
+/// [`Span::entered`]: super::Span::entered()
+#[derive(Debug)]
+#[must_use = "once a span has been entered, it should be exited"]
+pub struct EnteredSpan {
+ span: Span,
+
+ /// ```compile_fail
+ /// use tracing::span::*;
+ /// trait AssertSend: Send {}
+ ///
+ /// impl AssertSend for EnteredSpan {}
+ /// ```
+ _not_send: PhantomNotSend,
+}
+
+/// `log` target for all span lifecycle (creation/enter/exit/close) records.
+#[cfg(feature = "log")]
+const LIFECYCLE_LOG_TARGET: &str = "tracing::span";
+/// `log` target for span activity (enter/exit) records.
+#[cfg(feature = "log")]
+const ACTIVITY_LOG_TARGET: &str = "tracing::span::active";
+
+// ===== impl Span =====
+
+impl Span {
+ /// Constructs a new `Span` with the given [metadata] and set of
+ /// [field values].
+ ///
+ /// The new span will be constructed by the currently-active [`Subscriber`],
+ /// with the current span as its parent (if one exists).
+ ///
+ /// After the span is constructed, [field values] and/or [`follows_from`]
+ /// annotations may be added to it.
+ ///
+ /// [metadata]: super::Metadata
+ /// [`Subscriber`]: super::subscriber::Subscriber
+ /// [field values]: super::field::ValueSet
+ /// [`follows_from`]: super::Span::follows_from
+ pub fn new(meta: &'static Metadata<'static>, values: &field::ValueSet<'_>) -> Span {
+ dispatcher::get_default(|dispatch| Self::new_with(meta, values, dispatch))
+ }
+
+ #[inline]
+ #[doc(hidden)]
+ pub fn new_with(
+ meta: &'static Metadata<'static>,
+ values: &field::ValueSet<'_>,
+ dispatch: &Dispatch,
+ ) -> Span {
+ let new_span = Attributes::new(meta, values);
+ Self::make_with(meta, new_span, dispatch)
+ }
+
+ /// Constructs a new `Span` as the root of its own trace tree, with the
+ /// given [metadata] and set of [field values].
+ ///
+ /// After the span is constructed, [field values] and/or [`follows_from`]
+ /// annotations may be added to it.
+ ///
+ /// [metadata]: super::Metadata
+ /// [field values]: super::field::ValueSet
+ /// [`follows_from`]: super::Span::follows_from
+ pub fn new_root(meta: &'static Metadata<'static>, values: &field::ValueSet<'_>) -> Span {
+ dispatcher::get_default(|dispatch| Self::new_root_with(meta, values, dispatch))
+ }
+
+ #[inline]
+ #[doc(hidden)]
+ pub fn new_root_with(
+ meta: &'static Metadata<'static>,
+ values: &field::ValueSet<'_>,
+ dispatch: &Dispatch,
+ ) -> Span {
+ let new_span = Attributes::new_root(meta, values);
+ Self::make_with(meta, new_span, dispatch)
+ }
+
+ /// Constructs a new `Span` as child of the given parent span, with the
+ /// given [metadata] and set of [field values].
+ ///
+ /// After the span is constructed, [field values] and/or [`follows_from`]
+ /// annotations may be added to it.
+ ///
+ /// [metadata]: super::Metadata
+ /// [field values]: super::field::ValueSet
+ /// [`follows_from`]: super::Span::follows_from
+ pub fn child_of(
+ parent: impl Into<Option<Id>>,
+ meta: &'static Metadata<'static>,
+ values: &field::ValueSet<'_>,
+ ) -> Span {
+ let mut parent = parent.into();
+ dispatcher::get_default(move |dispatch| {
+ Self::child_of_with(Option::take(&mut parent), meta, values, dispatch)
+ })
+ }
+
+ #[inline]
+ #[doc(hidden)]
+ pub fn child_of_with(
+ parent: impl Into<Option<Id>>,
+ meta: &'static Metadata<'static>,
+ values: &field::ValueSet<'_>,
+ dispatch: &Dispatch,
+ ) -> Span {
+ let new_span = match parent.into() {
+ Some(parent) => Attributes::child_of(parent, meta, values),
+ None => Attributes::new_root(meta, values),
+ };
+ Self::make_with(meta, new_span, dispatch)
+ }
+
+ /// Constructs a new disabled span with the given `Metadata`.
+ ///
+ /// This should be used when a span is constructed from a known callsite,
+ /// but the subscriber indicates that it is disabled.
+ ///
+ /// Entering, exiting, and recording values on this span will not notify the
+ /// `Subscriber` but _may_ record log messages if the `log` feature flag is
+ /// enabled.
+ #[inline(always)]
+ pub fn new_disabled(meta: &'static Metadata<'static>) -> Span {
+ Self {
+ inner: None,
+ meta: Some(meta),
+ }
+ }
+
+ /// Constructs a new span that is *completely disabled*.
+ ///
+ /// This can be used rather than `Option<Span>` to represent cases where a
+ /// span is not present.
+ ///
+ /// Entering, exiting, and recording values on this span will do nothing.
+ #[inline(always)]
+ pub const fn none() -> Span {
+ Self {
+ inner: None,
+ meta: None,
+ }
+ }
+
+ /// Returns a handle to the span [considered by the `Subscriber`] to be the
+ /// current span.
+ ///
+ /// If the subscriber indicates that it does not track the current span, or
+ /// that the thread from which this function is called is not currently
+ /// inside a span, the returned span will be disabled.
+ ///
+ /// [considered by the `Subscriber`]:
+ /// super::subscriber::Subscriber::current_span
+ pub fn current() -> Span {
+ dispatcher::get_default(|dispatch| {
+ if let Some((id, meta)) = dispatch.current_span().into_inner() {
+ let id = dispatch.clone_span(&id);
+ Self {
+ inner: Some(Inner::new(id, dispatch)),
+ meta: Some(meta),
+ }
+ } else {
+ Self::none()
+ }
+ })
+ }
+
+ fn make_with(
+ meta: &'static Metadata<'static>,
+ new_span: Attributes<'_>,
+ dispatch: &Dispatch,
+ ) -> Span {
+ let attrs = &new_span;
+ let id = dispatch.new_span(attrs);
+ let inner = Some(Inner::new(id, dispatch));
+
+ let span = Self {
+ inner,
+ meta: Some(meta),
+ };
+
+ if_log_enabled! { *meta.level(), {
+ let target = if attrs.is_empty() {
+ LIFECYCLE_LOG_TARGET
+ } else {
+ meta.target()
+ };
+ let values = attrs.values();
+ span.log(
+ target,
+ level_to_log!(*meta.level()),
+ format_args!("++ {};{}", meta.name(), crate::log::LogValueSet { values, is_first: false }),
+ );
+ }}
+
+ span
+ }
+
+ /// Enters this span, returning a guard that will exit the span when dropped.
+ ///
+ /// If this span is enabled by the current subscriber, then this function will
+ /// call [`Subscriber::enter`] with the span's [`Id`], and dropping the guard
+ /// will call [`Subscriber::exit`]. If the span is disabled, this does
+ /// nothing.
+ ///
+ /// # In Asynchronous Code
+ ///
+ /// **Warning**: in asynchronous code that uses [async/await syntax][syntax],
+ /// `Span::enter` should be used very carefully or avoided entirely. Holding
+ /// the drop guard returned by `Span::enter` across `.await` points will
+ /// result in incorrect traces. For example,
+ ///
+ /// ```
+ /// # use tracing::info_span;
+ /// # async fn some_other_async_function() {}
+ /// async fn my_async_function() {
+ /// let span = info_span!("my_async_function");
+ ///
+ /// // WARNING: This span will remain entered until this
+ /// // guard is dropped...
+ /// let _enter = span.enter();
+ /// // ...but the `await` keyword may yield, causing the
+ /// // runtime to switch to another task, while remaining in
+ /// // this span!
+ /// some_other_async_function().await
+ ///
+ /// // ...
+ /// }
+ /// ```
+ ///
+ /// The drop guard returned by `Span::enter` exits the span when it is
+ /// dropped. When an async function or async block yields at an `.await`
+ /// point, the current scope is _exited_, but values in that scope are
+ /// **not** dropped (because the async block will eventually resume
+ /// execution from that await point). This means that _another_ task will
+ /// begin executing while _remaining_ in the entered span. This results in
+ /// an incorrect trace.
+ ///
+ /// Instead of using `Span::enter` in asynchronous code, prefer the
+ /// following:
+ ///
+ /// * To enter a span for a synchronous section of code within an async
+ /// block or function, prefer [`Span::in_scope`]. Since `in_scope` takes a
+ /// synchronous closure and exits the span when the closure returns, the
+ /// span will always be exited before the next await point. For example:
+ /// ```
+ /// # use tracing::info_span;
+ /// # async fn some_other_async_function(_: ()) {}
+ /// async fn my_async_function() {
+ /// let span = info_span!("my_async_function");
+ ///
+ /// let some_value = span.in_scope(|| {
+ /// // run some synchronous code inside the span...
+ /// });
+ ///
+ /// // This is okay! The span has already been exited before we reach
+ /// // the await point.
+ /// some_other_async_function(some_value).await;
+ ///
+ /// // ...
+ /// }
+ /// ```
+ /// * For instrumenting asynchronous code, `tracing` provides the
+ /// [`Future::instrument` combinator][instrument] for
+ /// attaching a span to a future (async function or block). This will
+ /// enter the span _every_ time the future is polled, and exit it whenever
+ /// the future yields.
+ ///
+ /// `Instrument` can be used with an async block inside an async function:
+ /// ```ignore
+ /// # use tracing::info_span;
+ /// use tracing::Instrument;
+ ///
+ /// # async fn some_other_async_function() {}
+ /// async fn my_async_function() {
+ /// let span = info_span!("my_async_function");
+ /// async move {
+ /// // This is correct! If we yield here, the span will be exited,
+ /// // and re-entered when we resume.
+ /// some_other_async_function().await;
+ ///
+ /// //more asynchronous code inside the span...
+ ///
+ /// }
+ /// // instrument the async block with the span...
+ /// .instrument(span)
+ /// // ...and await it.
+ /// .await
+ /// }
+ /// ```
+ ///
+ /// It can also be used to instrument calls to async functions at the
+ /// callsite:
+ /// ```ignore
+ /// # use tracing::debug_span;
+ /// use tracing::Instrument;
+ ///
+ /// # async fn some_other_async_function() {}
+ /// async fn my_async_function() {
+ /// let some_value = some_other_async_function()
+ /// .instrument(debug_span!("some_other_async_function"))
+ /// .await;
+ ///
+ /// // ...
+ /// }
+ /// ```
+ ///
+ /// * The [`#[instrument]` attribute macro][attr] can automatically generate
+ /// correct code when used on an async function:
+ ///
+ /// ```ignore
+ /// # async fn some_other_async_function() {}
+ /// #[tracing::instrument(level = "info")]
+ /// async fn my_async_function() {
+ ///
+ /// // This is correct! If we yield here, the span will be exited,
+ /// // and re-entered when we resume.
+ /// some_other_async_function().await;
+ ///
+ /// // ...
+ ///
+ /// }
+ /// ```
+ ///
+ /// [syntax]: https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html
+ /// [`Span::in_scope`]: Span::in_scope()
+ /// [instrument]: crate::Instrument
+ /// [attr]: macro@crate::instrument
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::{span, Level};
+ /// let span = span!(Level::INFO, "my_span");
+ /// let guard = span.enter();
+ ///
+ /// // code here is within the span
+ ///
+ /// drop(guard);
+ ///
+ /// // code here is no longer within the span
+ ///
+ /// ```
+ ///
+ /// Guards need not be explicitly dropped:
+ ///
+ /// ```
+ /// # use tracing::trace_span;
+ /// fn my_function() -> String {
+ /// // enter a span for the duration of this function.
+ /// let span = trace_span!("my_function");
+ /// let _enter = span.enter();
+ ///
+ /// // anything happening in functions we call is still inside the span...
+ /// my_other_function();
+ ///
+ /// // returning from the function drops the guard, exiting the span.
+ /// return "Hello world".to_owned();
+ /// }
+ ///
+ /// fn my_other_function() {
+ /// // ...
+ /// }
+ /// ```
+ ///
+ /// Sub-scopes may be created to limit the duration for which the span is
+ /// entered:
+ ///
+ /// ```
+ /// # use tracing::{info, info_span};
+ /// let span = info_span!("my_great_span");
+ ///
+ /// {
+ /// let _enter = span.enter();
+ ///
+ /// // this event occurs inside the span.
+ /// info!("i'm in the span!");
+ ///
+ /// // exiting the scope drops the guard, exiting the span.
+ /// }
+ ///
+ /// // this event is not inside the span.
+ /// info!("i'm outside the span!")
+ /// ```
+ ///
+ /// [`Subscriber::enter`]: super::subscriber::Subscriber::enter()
+ /// [`Subscriber::exit`]: super::subscriber::Subscriber::exit()
+ /// [`Id`]: super::Id
+ #[inline(always)]
+ pub fn enter(&self) -> Entered<'_> {
+ self.do_enter();
+ Entered { span: self }
+ }
+
+ /// Enters this span, consuming it and returning a [guard][`EnteredSpan`]
+ /// that will exit the span when dropped.
+ ///
+ /// <pre class="compile_fail" style="white-space:normal;font:inherit;">
+ /// <strong>Warning</strong>: In asynchronous code that uses async/await syntax,
+ /// <code>Span::entered</code> may produce incorrect traces if the returned drop
+ /// guard is held across an await point. See <a href="#in-asynchronous-code">the
+ /// <code>Span::enter</code> documentation</a> for details.
+ /// </pre>
+ ///
+ ///
+ /// If this span is enabled by the current subscriber, then this function will
+ /// call [`Subscriber::enter`] with the span's [`Id`], and dropping the guard
+ /// will call [`Subscriber::exit`]. If the span is disabled, this does
+ /// nothing.
+ ///
+ /// This is similar to the [`Span::enter`] method, except that it moves the
+ /// span by value into the returned guard, rather than borrowing it.
+ /// Therefore, this method can be used to create and enter a span in a
+ /// single expression, without requiring a `let`-binding. For example:
+ ///
+ /// ```
+ /// # use tracing::info_span;
+ /// let _span = info_span!("something_interesting").entered();
+ /// ```
+ /// rather than:
+ /// ```
+ /// # use tracing::info_span;
+ /// let span = info_span!("something_interesting");
+ /// let _e = span.enter();
+ /// ```
+ ///
+ /// Furthermore, `entered` may be used when the span must be stored in some
+ /// other struct or be passed to a function while remaining entered.
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: The returned <a href="../struct.EnteredSpan.html">
+ /// <code>EnteredSpan</code></a> guard does not implement <code>Send</code>.
+ /// Dropping the guard will exit <em>this</em> span, and if the guard is sent
+ /// to another thread and dropped there, that thread may never have entered
+ /// this span. Thus, <code>EnteredSpan</code>s should not be sent between threads.
+ /// </pre>
+ ///
+ /// [syntax]: https://rust-lang.github.io/async-book/01_getting_started/04_async_await_primer.html
+ ///
+ /// # Examples
+ ///
+ /// The returned guard can be [explicitly exited][EnteredSpan::exit],
+ /// returning the un-entered span:
+ ///
+ /// ```
+ /// # use tracing::{Level, span};
+ /// let span = span!(Level::INFO, "doing_something").entered();
+ ///
+ /// // code here is within the span
+ ///
+ /// // explicitly exit the span, returning it
+ /// let span = span.exit();
+ ///
+ /// // code here is no longer within the span
+ ///
+ /// // enter the span again
+ /// let span = span.entered();
+ ///
+ /// // now we are inside the span once again
+ /// ```
+ ///
+ /// Guards need not be explicitly dropped:
+ ///
+ /// ```
+ /// # use tracing::trace_span;
+ /// fn my_function() -> String {
+ /// // enter a span for the duration of this function.
+ /// let span = trace_span!("my_function").entered();
+ ///
+ /// // anything happening in functions we call is still inside the span...
+ /// my_other_function();
+ ///
+ /// // returning from the function drops the guard, exiting the span.
+ /// return "Hello world".to_owned();
+ /// }
+ ///
+ /// fn my_other_function() {
+ /// // ...
+ /// }
+ /// ```
+ ///
+ /// Since the [`EnteredSpan`] guard can dereference to the [`Span`] itself,
+ /// the span may still be accessed while entered. For example:
+ ///
+ /// ```rust
+ /// # use tracing::info_span;
+ /// use tracing::field;
+ ///
+ /// // create the span with an empty field, and enter it.
+ /// let span = info_span!("my_span", some_field = field::Empty).entered();
+ ///
+ /// // we can still record a value for the field while the span is entered.
+ /// span.record("some_field", &"hello world!");
+ /// ```
+ ///
+
+ /// [`Subscriber::enter`]: super::subscriber::Subscriber::enter()
+ /// [`Subscriber::exit`]: super::subscriber::Subscriber::exit()
+ /// [`Id`]: super::Id
+ #[inline(always)]
+ pub fn entered(self) -> EnteredSpan {
+ self.do_enter();
+ EnteredSpan {
+ span: self,
+ _not_send: PhantomNotSend,
+ }
+ }
+
+ /// Returns this span, if it was [enabled] by the current [`Subscriber`], or
+ /// the [current span] (whose lexical distance may be further than expected),
+ /// if this span [is disabled].
+ ///
+ /// This method can be useful when propagating spans to spawned threads or
+ /// [async tasks]. Consider the following:
+ ///
+ /// ```
+ /// let _parent_span = tracing::info_span!("parent").entered();
+ ///
+ /// // ...
+ ///
+ /// let child_span = tracing::debug_span!("child");
+ ///
+ /// std::thread::spawn(move || {
+ /// let _entered = child_span.entered();
+ ///
+ /// tracing::info!("spawned a thread!");
+ ///
+ /// // ...
+ /// });
+ /// ```
+ ///
+ /// If the current [`Subscriber`] enables the [`DEBUG`] level, then both
+ /// the "parent" and "child" spans will be enabled. Thus, when the "spawaned
+ /// a thread!" event occurs, it will be inside of the "child" span. Because
+ /// "parent" is the parent of "child", the event will _also_ be inside of
+ /// "parent".
+ ///
+ /// However, if the [`Subscriber`] only enables the [`INFO`] level, the "child"
+ /// span will be disabled. When the thread is spawned, the
+ /// `child_span.entered()` call will do nothing, since "child" is not
+ /// enabled. In this case, the "spawned a thread!" event occurs outside of
+ /// *any* span, since the "child" span was responsible for propagating its
+ /// parent to the spawned thread.
+ ///
+ /// If this is not the desired behavior, `Span::or_current` can be used to
+ /// ensure that the "parent" span is propagated in both cases, either as a
+ /// parent of "child" _or_ directly. For example:
+ ///
+ /// ```
+ /// let _parent_span = tracing::info_span!("parent").entered();
+ ///
+ /// // ...
+ ///
+ /// // If DEBUG is enabled, then "child" will be enabled, and `or_current`
+ /// // returns "child". Otherwise, if DEBUG is not enabled, "child" will be
+ /// // disabled, and `or_current` returns "parent".
+ /// let child_span = tracing::debug_span!("child").or_current();
+ ///
+ /// std::thread::spawn(move || {
+ /// let _entered = child_span.entered();
+ ///
+ /// tracing::info!("spawned a thread!");
+ ///
+ /// // ...
+ /// });
+ /// ```
+ ///
+ /// When spawning [asynchronous tasks][async tasks], `Span::or_current` can
+ /// be used similarly, in combination with [`instrument`]:
+ ///
+ /// ```
+ /// use tracing::Instrument;
+ /// # // lol
+ /// # mod tokio {
+ /// # pub(super) fn spawn(_: impl std::future::Future) {}
+ /// # }
+ ///
+ /// let _parent_span = tracing::info_span!("parent").entered();
+ ///
+ /// // ...
+ ///
+ /// let child_span = tracing::debug_span!("child");
+ ///
+ /// tokio::spawn(
+ /// async {
+ /// tracing::info!("spawned a task!");
+ ///
+ /// // ...
+ ///
+ /// }.instrument(child_span.or_current())
+ /// );
+ /// ```
+ ///
+ /// In general, `or_current` should be preferred over nesting an
+ /// [`instrument`] call inside of an [`in_current_span`] call, as using
+ /// `or_current` will be more efficient.
+ ///
+ /// ```
+ /// use tracing::Instrument;
+ /// # // lol
+ /// # mod tokio {
+ /// # pub(super) fn spawn(_: impl std::future::Future) {}
+ /// # }
+ /// async fn my_async_fn() {
+ /// // ...
+ /// }
+ ///
+ /// let _parent_span = tracing::info_span!("parent").entered();
+ ///
+ /// // Do this:
+ /// tokio::spawn(
+ /// my_async_fn().instrument(tracing::debug_span!("child").or_current())
+ /// );
+ ///
+ /// // ...rather than this:
+ /// tokio::spawn(
+ /// my_async_fn()
+ /// .instrument(tracing::debug_span!("child"))
+ /// .in_current_span()
+ /// );
+ /// ```
+ ///
+ /// [enabled]: crate::Subscriber::enabled
+ /// [`Subscriber`]: crate::Subscriber
+ /// [current span]: Span::current
+ /// [is disabled]: Span::is_disabled
+ /// [`INFO`]: crate::Level::INFO
+ /// [`DEBUG`]: crate::Level::DEBUG
+ /// [async tasks]: std::task
+ /// [`instrument`]: crate::instrument::Instrument::instrument
+ /// [`in_current_span`]: crate::instrument::Instrument::in_current_span
+ pub fn or_current(self) -> Self {
+ if self.is_disabled() {
+ return Self::current();
+ }
+ self
+ }
+
+ #[inline(always)]
+ fn do_enter(&self) {
+ if let Some(inner) = self.inner.as_ref() {
+ inner.subscriber.enter(&inner.id);
+ }
+
+ if_log_enabled! { crate::Level::TRACE, {
+ if let Some(_meta) = self.meta {
+ self.log(ACTIVITY_LOG_TARGET, log::Level::Trace, format_args!("-> {};", _meta.name()));
+ }
+ }}
+ }
+
+ // Called from [`Entered`] and [`EnteredSpan`] drops.
+ //
+ // Running this behaviour on drop rather than with an explicit function
+ // call means that spans may still be exited when unwinding.
+ #[inline(always)]
+ fn do_exit(&self) {
+ if let Some(inner) = self.inner.as_ref() {
+ inner.subscriber.exit(&inner.id);
+ }
+
+ if_log_enabled! { crate::Level::TRACE, {
+ if let Some(_meta) = self.meta {
+ self.log(ACTIVITY_LOG_TARGET, log::Level::Trace, format_args!("<- {};", _meta.name()));
+ }
+ }}
+ }
+
+ /// Executes the given function in the context of this span.
+ ///
+ /// If this span is enabled, then this function enters the span, invokes `f`
+ /// and then exits the span. If the span is disabled, `f` will still be
+ /// invoked, but in the context of the currently-executing span (if there is
+ /// one).
+ ///
+ /// Returns the result of evaluating `f`.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use tracing::{trace, span, Level};
+ /// let my_span = span!(Level::TRACE, "my_span");
+ ///
+ /// my_span.in_scope(|| {
+ /// // this event occurs within the span.
+ /// trace!("i'm in the span!");
+ /// });
+ ///
+ /// // this event occurs outside the span.
+ /// trace!("i'm not in the span!");
+ /// ```
+ ///
+ /// Calling a function and returning the result:
+ /// ```
+ /// # use tracing::{info_span, Level};
+ /// fn hello_world() -> String {
+ /// "Hello world!".to_owned()
+ /// }
+ ///
+ /// let span = info_span!("hello_world");
+ /// // the span will be entered for the duration of the call to
+ /// // `hello_world`.
+ /// let a_string = span.in_scope(hello_world);
+ ///
+ pub fn in_scope<F: FnOnce() -> T, T>(&self, f: F) -> T {
+ let _enter = self.enter();
+ f()
+ }
+
+ /// Returns a [`Field`][super::field::Field] for the field with the
+ /// given `name`, if one exists,
+ pub fn field<Q: ?Sized>(&self, field: &Q) -> Option<field::Field>
+ where
+ Q: field::AsField,
+ {
+ self.metadata().and_then(|meta| field.as_field(meta))
+ }
+
+ /// Returns true if this `Span` has a field for the given
+ /// [`Field`][super::field::Field] or field name.
+ #[inline]
+ pub fn has_field<Q: ?Sized>(&self, field: &Q) -> bool
+ where
+ Q: field::AsField,
+ {
+ self.field(field).is_some()
+ }
+
+ /// Records that the field described by `field` has the value `value`.
+ ///
+ /// This may be used with [`field::Empty`] to declare fields whose values
+ /// are not known when the span is created, and record them later:
+ /// ```
+ /// use tracing::{trace_span, field};
+ ///
+ /// // Create a span with two fields: `greeting`, with the value "hello world", and
+ /// // `parting`, without a value.
+ /// let span = trace_span!("my_span", greeting = "hello world", parting = field::Empty);
+ ///
+ /// // ...
+ ///
+ /// // Now, record a value for parting as well.
+ /// // (note that the field name is passed as a string slice)
+ /// span.record("parting", "goodbye world!");
+ /// ```
+ /// However, it may also be used to record a _new_ value for a field whose
+ /// value was already recorded:
+ /// ```
+ /// use tracing::info_span;
+ /// # fn do_something() -> Result<(), ()> { Err(()) }
+ ///
+ /// // Initially, let's assume that our attempt to do something is going okay...
+ /// let span = info_span!("doing_something", is_okay = true);
+ /// let _e = span.enter();
+ ///
+ /// match do_something() {
+ /// Ok(something) => {
+ /// // ...
+ /// }
+ /// Err(_) => {
+ /// // Things are no longer okay!
+ /// span.record("is_okay", false);
+ /// }
+ /// }
+ /// ```
+ ///
+ /// <pre class="ignore" style="white-space:normal;font:inherit;">
+ /// <strong>Note</strong>: The fields associated with a span are part
+ /// of its <a href="../struct.Metadata.html"><code>Metadata</code></a>.
+ /// The <a href="../struct.Metadata.html"><code>Metadata</code></a>
+ /// describing a particular span is constructed statically when the span
+ /// is created and cannot be extended later to add new fields. Therefore,
+ /// you cannot record a value for a field that was not specified when the
+ /// span was created:
+ /// </pre>
+ ///
+ /// ```
+ /// use tracing::{trace_span, field};
+ ///
+ /// // Create a span with two fields: `greeting`, with the value "hello world", and
+ /// // `parting`, without a value.
+ /// let span = trace_span!("my_span", greeting = "hello world", parting = field::Empty);
+ ///
+ /// // ...
+ ///
+ /// // Now, you try to record a value for a new field, `new_field`, which was not
+ /// // declared as `Empty` or populated when you created `span`.
+ /// // You won't get any error, but the assignment will have no effect!
+ /// span.record("new_field", "interesting_value_you_really_need");
+ ///
+ /// // Instead, all fields that may be recorded after span creation should be declared up front,
+ /// // using field::Empty when a value is not known, as we did for `parting`.
+ /// // This `record` call will indeed replace field::Empty with "you will be remembered".
+ /// span.record("parting", "you will be remembered");
+ /// ```
+ ///
+ /// [`field::Empty`]: super::field::Empty
+ /// [`Metadata`]: super::Metadata
+ pub fn record<Q: ?Sized, V>(&self, field: &Q, value: V) -> &Self
+ where
+ Q: field::AsField,
+ V: field::Value,
+ {
+ if let Some(meta) = self.meta {
+ if let Some(field) = field.as_field(meta) {
+ self.record_all(
+ &meta
+ .fields()
+ .value_set(&[(&field, Some(&value as &dyn field::Value))]),
+ );
+ }
+ }
+
+ self
+ }
+
+ /// Records all the fields in the provided `ValueSet`.
+ pub fn record_all(&self, values: &field::ValueSet<'_>) -> &Self {
+ let record = Record::new(values);
+ if let Some(ref inner) = self.inner {
+ inner.record(&record);
+ }
+
+ if let Some(_meta) = self.meta {
+ if_log_enabled! { *_meta.level(), {
+ let target = if record.is_empty() {
+ LIFECYCLE_LOG_TARGET
+ } else {
+ _meta.target()
+ };
+ self.log(
+ target,
+ level_to_log!(*_meta.level()),
+ format_args!("{};{}", _meta.name(), crate::log::LogValueSet { values, is_first: false }),
+ );
+ }}
+ }
+
+ self
+ }
+
+ /// Returns `true` if this span was disabled by the subscriber and does not
+ /// exist.
+ ///
+ /// See also [`is_none`].
+ ///
+ /// [`is_none`]: Span::is_none()
+ #[inline]
+ pub fn is_disabled(&self) -> bool {
+ self.inner.is_none()
+ }
+
+ /// Returns `true` if this span was constructed by [`Span::none`] and is
+ /// empty.
+ ///
+ /// If `is_none` returns `true` for a given span, then [`is_disabled`] will
+ /// also return `true`. However, when a span is disabled by the subscriber
+ /// rather than constructed by `Span::none`, this method will return
+ /// `false`, while `is_disabled` will return `true`.
+ ///
+ /// [`Span::none`]: Span::none()
+ /// [`is_disabled`]: Span::is_disabled()
+ #[inline]
+ pub fn is_none(&self) -> bool {
+ self.is_disabled() && self.meta.is_none()
+ }
+
+ /// Indicates that the span with the given ID has an indirect causal
+ /// relationship with this span.
+ ///
+ /// This relationship differs somewhat from the parent-child relationship: a
+ /// span may have any number of prior spans, rather than a single one; and
+ /// spans are not considered to be executing _inside_ of the spans they
+ /// follow from. This means that a span may close even if subsequent spans
+ /// that follow from it are still open, and time spent inside of a
+ /// subsequent span should not be included in the time its precedents were
+ /// executing. This is used to model causal relationships such as when a
+ /// single future spawns several related background tasks, et cetera.
+ ///
+ /// If this span is disabled, or the resulting follows-from relationship
+ /// would be invalid, this function will do nothing.
+ ///
+ /// # Examples
+ ///
+ /// Setting a `follows_from` relationship with a `Span`:
+ /// ```
+ /// # use tracing::{span, Id, Level, Span};
+ /// let span1 = span!(Level::INFO, "span_1");
+ /// let span2 = span!(Level::DEBUG, "span_2");
+ /// span2.follows_from(span1);
+ /// ```
+ ///
+ /// Setting a `follows_from` relationship with the current span:
+ /// ```
+ /// # use tracing::{span, Id, Level, Span};
+ /// let span = span!(Level::INFO, "hello!");
+ /// span.follows_from(Span::current());
+ /// ```
+ ///
+ /// Setting a `follows_from` relationship with a `Span` reference:
+ /// ```
+ /// # use tracing::{span, Id, Level, Span};
+ /// let span = span!(Level::INFO, "hello!");
+ /// let curr = Span::current();
+ /// span.follows_from(&curr);
+ /// ```
+ ///
+ /// Setting a `follows_from` relationship with an `Id`:
+ /// ```
+ /// # use tracing::{span, Id, Level, Span};
+ /// let span = span!(Level::INFO, "hello!");
+ /// let id = span.id();
+ /// span.follows_from(id);
+ /// ```
+ pub fn follows_from(&self, from: impl Into<Option<Id>>) -> &Self {
+ if let Some(ref inner) = self.inner {
+ if let Some(from) = from.into() {
+ inner.follows_from(&from);
+ }
+ }
+ self
+ }
+
+ /// Returns this span's `Id`, if it is enabled.
+ pub fn id(&self) -> Option<Id> {
+ self.inner.as_ref().map(Inner::id)
+ }
+
+ /// Returns this span's `Metadata`, if it is enabled.
+ pub fn metadata(&self) -> Option<&'static Metadata<'static>> {
+ self.meta
+ }
+
+ #[cfg(feature = "log")]
+ #[inline]
+ fn log(&self, target: &str, level: log::Level, message: fmt::Arguments<'_>) {
+ if let Some(meta) = self.meta {
+ if level_to_log!(*meta.level()) <= log::max_level() {
+ let logger = log::logger();
+ let log_meta = log::Metadata::builder().level(level).target(target).build();
+ if logger.enabled(&log_meta) {
+ if let Some(ref inner) = self.inner {
+ logger.log(
+ &log::Record::builder()
+ .metadata(log_meta)
+ .module_path(meta.module_path())
+ .file(meta.file())
+ .line(meta.line())
+ .args(format_args!("{} span={}", message, inner.id.into_u64()))
+ .build(),
+ );
+ } else {
+ logger.log(
+ &log::Record::builder()
+ .metadata(log_meta)
+ .module_path(meta.module_path())
+ .file(meta.file())
+ .line(meta.line())
+ .args(message)
+ .build(),
+ );
+ }
+ }
+ }
+ }
+ }
+
+ /// Invokes a function with a reference to this span's ID and subscriber.
+ ///
+ /// if this span is enabled, the provided function is called, and the result is returned.
+ /// If the span is disabled, the function is not called, and this method returns `None`
+ /// instead.
+ pub fn with_subscriber<T>(&self, f: impl FnOnce((&Id, &Dispatch)) -> T) -> Option<T> {
+ self.inner
+ .as_ref()
+ .map(|inner| f((&inner.id, &inner.subscriber)))
+ }
+}
+
+impl cmp::PartialEq for Span {
+ fn eq(&self, other: &Self) -> bool {
+ match (&self.meta, &other.meta) {
+ (Some(this), Some(that)) => {
+ this.callsite() == that.callsite() && self.inner == other.inner
+ }
+ _ => false,
+ }
+ }
+}
+
+impl Hash for Span {
+ fn hash<H: Hasher>(&self, hasher: &mut H) {
+ self.inner.hash(hasher);
+ }
+}
+
+impl fmt::Debug for Span {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let mut span = f.debug_struct("Span");
+ if let Some(meta) = self.meta {
+ span.field("name", &meta.name())
+ .field("level", &meta.level())
+ .field("target", &meta.target());
+
+ if let Some(ref inner) = self.inner {
+ span.field("id", &inner.id());
+ } else {
+ span.field("disabled", &true);
+ }
+
+ if let Some(ref path) = meta.module_path() {
+ span.field("module_path", &path);
+ }
+
+ if let Some(ref line) = meta.line() {
+ span.field("line", &line);
+ }
+
+ if let Some(ref file) = meta.file() {
+ span.field("file", &file);
+ }
+ } else {
+ span.field("none", &true);
+ }
+
+ span.finish()
+ }
+}
+
+impl<'a> From<&'a Span> for Option<&'a Id> {
+ fn from(span: &'a Span) -> Self {
+ span.inner.as_ref().map(|inner| &inner.id)
+ }
+}
+
+impl<'a> From<&'a Span> for Option<Id> {
+ fn from(span: &'a Span) -> Self {
+ span.inner.as_ref().map(Inner::id)
+ }
+}
+
+impl From<Span> for Option<Id> {
+ fn from(span: Span) -> Self {
+ span.inner.as_ref().map(Inner::id)
+ }
+}
+
+impl<'a> From<&'a EnteredSpan> for Option<&'a Id> {
+ fn from(span: &'a EnteredSpan) -> Self {
+ span.inner.as_ref().map(|inner| &inner.id)
+ }
+}
+
+impl<'a> From<&'a EnteredSpan> for Option<Id> {
+ fn from(span: &'a EnteredSpan) -> Self {
+ span.inner.as_ref().map(Inner::id)
+ }
+}
+
+impl Drop for Span {
+ #[inline(always)]
+ fn drop(&mut self) {
+ if let Some(Inner {
+ ref id,
+ ref subscriber,
+ }) = self.inner
+ {
+ subscriber.try_close(id.clone());
+ }
+
+ if_log_enabled! { crate::Level::TRACE, {
+ if let Some(meta) = self.meta {
+ self.log(
+ LIFECYCLE_LOG_TARGET,
+ log::Level::Trace,
+ format_args!("-- {};", meta.name()),
+ );
+ }
+ }}
+ }
+}
+
+// ===== impl Inner =====
+
+impl Inner {
+ /// Indicates that the span with the given ID has an indirect causal
+ /// relationship with this span.
+ ///
+ /// This relationship differs somewhat from the parent-child relationship: a
+ /// span may have any number of prior spans, rather than a single one; and
+ /// spans are not considered to be executing _inside_ of the spans they
+ /// follow from. This means that a span may close even if subsequent spans
+ /// that follow from it are still open, and time spent inside of a
+ /// subsequent span should not be included in the time its precedents were
+ /// executing. This is used to model causal relationships such as when a
+ /// single future spawns several related background tasks, et cetera.
+ ///
+ /// If this span is disabled, this function will do nothing. Otherwise, it
+ /// returns `Ok(())` if the other span was added as a precedent of this
+ /// span, or an error if this was not possible.
+ fn follows_from(&self, from: &Id) {
+ self.subscriber.record_follows_from(&self.id, from)
+ }
+
+ /// Returns the span's ID.
+ fn id(&self) -> Id {
+ self.id.clone()
+ }
+
+ fn record(&self, values: &Record<'_>) {
+ self.subscriber.record(&self.id, values)
+ }
+
+ fn new(id: Id, subscriber: &Dispatch) -> Self {
+ Inner {
+ id,
+ subscriber: subscriber.clone(),
+ }
+ }
+}
+
+impl cmp::PartialEq for Inner {
+ fn eq(&self, other: &Self) -> bool {
+ self.id == other.id
+ }
+}
+
+impl Hash for Inner {
+ fn hash<H: Hasher>(&self, state: &mut H) {
+ self.id.hash(state);
+ }
+}
+
+impl Clone for Inner {
+ fn clone(&self) -> Self {
+ Inner {
+ id: self.subscriber.clone_span(&self.id),
+ subscriber: self.subscriber.clone(),
+ }
+ }
+}
+
+// ===== impl Entered =====
+
+impl EnteredSpan {
+ /// Returns this span's `Id`, if it is enabled.
+ pub fn id(&self) -> Option<Id> {
+ self.inner.as_ref().map(Inner::id)
+ }
+
+ /// Exits this span, returning the underlying [`Span`].
+ #[inline]
+ pub fn exit(mut self) -> Span {
+ // One does not simply move out of a struct with `Drop`.
+ let span = mem::replace(&mut self.span, Span::none());
+ span.do_exit();
+ span
+ }
+}
+
+impl Deref for EnteredSpan {
+ type Target = Span;
+
+ #[inline]
+ fn deref(&self) -> &Span {
+ &self.span
+ }
+}
+
+impl<'a> Drop for Entered<'a> {
+ #[inline(always)]
+ fn drop(&mut self) {
+ self.span.do_exit()
+ }
+}
+
+impl Drop for EnteredSpan {
+ #[inline(always)]
+ fn drop(&mut self) {
+ self.span.do_exit()
+ }
+}
+
+/// Technically, `EnteredSpan` _can_ implement both `Send` *and*
+/// `Sync` safely. It doesn't, because it has a `PhantomNotSend` field,
+/// specifically added in order to make it `!Send`.
+///
+/// Sending an `EnteredSpan` guard between threads cannot cause memory unsafety.
+/// However, it *would* result in incorrect behavior, so we add a
+/// `PhantomNotSend` to prevent it from being sent between threads. This is
+/// because it must be *dropped* on the same thread that it was created;
+/// otherwise, the span will never be exited on the thread where it was entered,
+/// and it will attempt to exit the span on a thread that may never have entered
+/// it. However, we still want them to be `Sync` so that a struct holding an
+/// `Entered` guard can be `Sync`.
+///
+/// Thus, this is totally safe.
+#[derive(Debug)]
+struct PhantomNotSend {
+ ghost: PhantomData<*mut ()>,
+}
+
+#[allow(non_upper_case_globals)]
+const PhantomNotSend: PhantomNotSend = PhantomNotSend { ghost: PhantomData };
+
+/// # Safety
+///
+/// Trivially safe, as `PhantomNotSend` doesn't have any API.
+unsafe impl Sync for PhantomNotSend {}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+
+ trait AssertSend: Send {}
+ impl AssertSend for Span {}
+
+ trait AssertSync: Sync {}
+ impl AssertSync for Span {}
+ impl AssertSync for Entered<'_> {}
+ impl AssertSync for EnteredSpan {}
+
+ #[test]
+ fn test_record_backwards_compat() {
+ Span::current().record("some-key", "some text");
+ Span::current().record("some-key", false);
+ }
+}
diff --git a/crates/tracing/src/stdlib.rs b/crates/tracing/src/stdlib.rs
new file mode 100644
index 0000000..12b5408
--- /dev/null
+++ b/crates/tracing/src/stdlib.rs
@@ -0,0 +1,55 @@
+//! Re-exports either the Rust `std` library or `core` and `alloc` when `std` is
+//! disabled.
+//!
+//! `crate::stdlib::...` should be used rather than `std::` when adding code that
+//! will be available with the standard library disabled.
+//!
+//! Note that this module is called `stdlib` rather than `std`, as Rust 1.34.0
+//! does not permit redefining the name `stdlib` (although this works on the
+//! latest stable Rust).
+#[cfg(feature = "std")]
+pub(crate) use std::*;
+
+#[cfg(not(feature = "std"))]
+pub(crate) use self::no_std::*;
+
+#[cfg(not(feature = "std"))]
+mod no_std {
+ // We pre-emptively export everything from libcore/liballoc, (even modules
+ // we aren't using currently) to make adding new code easier. Therefore,
+ // some of these imports will be unused.
+ #![allow(unused_imports)]
+
+ pub(crate) use core::{
+ any, array, ascii, cell, char, clone, cmp, convert, default, f32, f64, ffi, future, hash,
+ hint, i128, i16, i8, isize, iter, marker, mem, num, ops, option, pin, ptr, result, task,
+ time, u128, u16, u32, u8, usize,
+ };
+
+ pub(crate) use alloc::{boxed, collections, rc, string, vec};
+
+ pub(crate) mod borrow {
+ pub(crate) use alloc::borrow::*;
+ pub(crate) use core::borrow::*;
+ }
+
+ pub(crate) mod fmt {
+ pub(crate) use alloc::fmt::*;
+ pub(crate) use core::fmt::*;
+ }
+
+ pub(crate) mod slice {
+ pub(crate) use alloc::slice::*;
+ pub(crate) use core::slice::*;
+ }
+
+ pub(crate) mod str {
+ pub(crate) use alloc::str::*;
+ pub(crate) use core::str::*;
+ }
+
+ pub(crate) mod sync {
+ pub(crate) use alloc::sync::*;
+ pub(crate) use core::sync::*;
+ }
+}
diff --git a/crates/tracing/src/subscriber.rs b/crates/tracing/src/subscriber.rs
new file mode 100644
index 0000000..f55698d
--- /dev/null
+++ b/crates/tracing/src/subscriber.rs
@@ -0,0 +1,65 @@
+//! Collects and records trace data.
+pub use tracing_core::subscriber::*;
+
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub use tracing_core::dispatcher::DefaultGuard;
+
+/// Sets this [`Subscriber`] as the default for the current thread for the
+/// duration of a closure.
+///
+/// The default subscriber is used when creating a new [`Span`] or
+/// [`Event`].
+///
+///
+/// [`Span`]: super::span::Span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+pub fn with_default<T, S>(subscriber: S, f: impl FnOnce() -> T) -> T
+where
+ S: Subscriber + Send + Sync + 'static,
+{
+ crate::dispatcher::with_default(&crate::Dispatch::new(subscriber), f)
+}
+
+/// Sets this subscriber as the global default for the duration of the entire program.
+/// Will be used as a fallback if no thread-local subscriber has been set in a thread (using `with_default`.)
+///
+/// Can only be set once; subsequent attempts to set the global default will fail.
+/// Returns whether the initialization was successful.
+///
+/// Note: Libraries should *NOT* call `set_global_default()`! That will cause conflicts when
+/// executables try to set them later.
+///
+/// [span]: super::span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
+pub fn set_global_default<S>(subscriber: S) -> Result<(), SetGlobalDefaultError>
+where
+ S: Subscriber + Send + Sync + 'static,
+{
+ crate::dispatcher::set_global_default(crate::Dispatch::new(subscriber))
+}
+
+/// Sets the [`Subscriber`] as the default for the current thread for the
+/// duration of the lifetime of the returned [`DefaultGuard`].
+///
+/// The default subscriber is used when creating a new [`Span`] or [`Event`].
+///
+/// [`Span`]: super::span::Span
+/// [`Subscriber`]: super::subscriber::Subscriber
+/// [`Event`]: super::event::Event
+/// [`DefaultGuard`]: super::dispatcher::DefaultGuard
+#[cfg(feature = "std")]
+#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
+#[must_use = "Dropping the guard unregisters the subscriber."]
+pub fn set_default<S>(subscriber: S) -> DefaultGuard
+where
+ S: Subscriber + Send + Sync + 'static,
+{
+ crate::dispatcher::set_default(&crate::Dispatch::new(subscriber))
+}
+
+pub use tracing_core::dispatcher::SetGlobalDefaultError;
diff --git a/crates/tracing/tests/enabled.rs b/crates/tracing/tests/enabled.rs
new file mode 100644
index 0000000..5a45963
--- /dev/null
+++ b/crates/tracing/tests/enabled.rs
@@ -0,0 +1,54 @@
+#![cfg(feature = "std")]
+use tracing::Level;
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn level_and_target() {
+ let subscriber = subscriber::mock()
+ .with_filter(|meta| {
+ if meta.target() == "debug_module" {
+ meta.level() <= &Level::DEBUG
+ } else {
+ meta.level() <= &Level::INFO
+ }
+ })
+ .only()
+ .run();
+
+ let _guard = tracing::subscriber::set_default(subscriber);
+
+ assert!(tracing::enabled!(target: "debug_module", Level::DEBUG));
+ assert!(tracing::enabled!(Level::ERROR));
+ assert!(!tracing::enabled!(Level::DEBUG));
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_and_event() {
+ let subscriber = subscriber::mock()
+ .with_filter(|meta| {
+ if meta.target() == "debug_module" {
+ meta.level() <= &Level::DEBUG
+ } else if meta.is_span() {
+ meta.level() <= &Level::TRACE
+ } else if meta.is_event() {
+ meta.level() <= &Level::DEBUG
+ } else {
+ meta.level() <= &Level::INFO
+ }
+ })
+ .only()
+ .run();
+
+ let _guard = tracing::subscriber::set_default(subscriber);
+
+ // Ensure that the `_event` and `_span` alternatives work corretly
+ assert!(!tracing::event_enabled!(Level::TRACE));
+ assert!(tracing::event_enabled!(Level::DEBUG));
+ assert!(tracing::span_enabled!(Level::TRACE));
+
+ // target variants
+ assert!(tracing::span_enabled!(target: "debug_module", Level::DEBUG));
+ assert!(tracing::event_enabled!(target: "debug_module", Level::DEBUG));
+}
diff --git a/crates/tracing/tests/event.rs b/crates/tracing/tests/event.rs
new file mode 100644
index 0000000..0be7c0b
--- /dev/null
+++ b/crates/tracing/tests/event.rs
@@ -0,0 +1,554 @@
+// These tests require the thread-local scoped dispatcher, which only works when
+// we have a standard library. The behaviour being tested should be the same
+// with the standard lib disabled.
+//
+// The alternative would be for each of these tests to be defined in a separate
+// file, which is :(
+#![cfg(feature = "std")]
+
+use tracing::{
+ debug, error,
+ field::{debug, display},
+ info,
+ subscriber::with_default,
+ trace, warn, Level,
+};
+use tracing_mock::*;
+
+macro_rules! event_without_message {
+ ($name:ident: $e:expr) => {
+ #[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+ #[test]
+ fn $name() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("answer")
+ .with_value(&42)
+ .and(
+ expect::field("to_question")
+ .with_value(&"life, the universe, and everything"),
+ )
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ info!(
+ answer = $e,
+ to_question = "life, the universe, and everything"
+ );
+ });
+
+ handle.assert_finished();
+ }
+ };
+}
+
+event_without_message! {event_without_message: 42}
+event_without_message! {wrapping_event_without_message: std::num::Wrapping(42)}
+event_without_message! {nonzeroi32_event_without_message: std::num::NonZeroI32::new(42).unwrap()}
+// needs API breakage
+//event_without_message!{nonzerou128_event_without_message: std::num::NonZeroU128::new(42).unwrap()}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_with_message() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(expect::field("message").with_value(
+ &tracing::field::debug(format_args!(
+ "hello from my tracing::event! yak shaved = {:?}",
+ true
+ )),
+ )),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ debug!("hello from my tracing::event! yak shaved = {:?}", true);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn message_without_delims() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("answer")
+ .with_value(&42)
+ .and(
+ expect::field("question").with_value(&"life, the universe, and everything"),
+ )
+ .and(field::msg(format_args!(
+ "hello from my event! tricky? {:?}!",
+ true
+ )))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let question = "life, the universe, and everything";
+ debug!(answer = 42, question, "hello from {where}! tricky? {:?}!", true, where = "my event");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn string_message_without_delims() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("answer")
+ .with_value(&42)
+ .and(
+ expect::field("question").with_value(&"life, the universe, and everything"),
+ )
+ .and(field::msg(format_args!("hello from my event")))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let question = "life, the universe, and everything";
+ debug!(answer = 42, question, "hello from my event");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn one_with_everything() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event()
+ .with_fields(
+ expect::field("message")
+ .with_value(&tracing::field::debug(format_args!(
+ "{:#x} make me one with{what:.>20}",
+ 4_277_009_102u64,
+ what = "everything"
+ )))
+ .and(expect::field("foo").with_value(&666))
+ .and(expect::field("bar").with_value(&false))
+ .and(expect::field("like_a_butterfly").with_value(&42.0))
+ .only(),
+ )
+ .at_level(Level::ERROR)
+ .with_target("whatever"),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::event!(
+ target: "whatever",
+ Level::ERROR,
+ { foo = 666, bar = false, like_a_butterfly = 42.0 },
+ "{:#x} make me one with{what:.>20}", 4_277_009_102u64, what = "everything"
+ );
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn moved_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("foo")
+ .with_value(&display("hello from my event"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let from = "my event";
+ tracing::event!(Level::INFO, foo = display(format!("hello from {}", from)))
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn dotted_field_name() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("foo.bar")
+ .with_value(&true)
+ .and(expect::field("foo.baz").with_value(&false))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::event!(Level::INFO, foo.bar = true, foo.baz = false);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn borrowed_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("foo")
+ .with_value(&display("hello from my event"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let from = "my event";
+ let mut message = format!("hello from {}", from);
+ tracing::event!(Level::INFO, foo = display(&message));
+ message.push_str(", which happened!");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+// If emitting log instrumentation, this gets moved anyway, breaking the test.
+#[cfg(not(feature = "log"))]
+fn move_field_out_of_struct() {
+ use tracing::field::debug;
+
+ #[derive(Debug)]
+ struct Position {
+ x: f32,
+ y: f32,
+ }
+
+ let pos = Position {
+ x: 3.234,
+ y: -1.223,
+ };
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("x")
+ .with_value(&debug(3.234))
+ .and(expect::field("y").with_value(&debug(-1.223)))
+ .only(),
+ ),
+ )
+ .event(expect::event().with_fields(expect::field("position").with_value(&debug(&pos))))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let pos = Position {
+ x: 3.234,
+ y: -1.223,
+ };
+ debug!(x = debug(pos.x), y = debug(pos.y));
+ debug!(target: "app_events", { position = debug(pos) }, "New position");
+ });
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn display_shorthand() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("my_field")
+ .with_value(&display("hello world"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::event!(Level::TRACE, my_field = %"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_shorthand() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("my_field")
+ .with_value(&debug("hello world"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::event!(Level::TRACE, my_field = ?"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn both_shorthands() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("display_field")
+ .with_value(&display("hello world"))
+ .and(expect::field("debug_field").with_value(&debug("hello world")))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::event!(Level::TRACE, display_field = %"hello world", debug_field = ?"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_child() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ tracing::event!(parent: foo.id(), Level::TRACE, "bar");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_child_at_levels() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .event(expect::event().with_explicit_parent(Some("foo")))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ trace!(parent: foo.id(), "a");
+ debug!(parent: foo.id(), "b");
+ info!(parent: foo.id(), "c");
+ warn!(parent: foo.id(), "d");
+ error!(parent: foo.id(), "e");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn option_values() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("some_str")
+ .with_value(&"yes")
+ .and(expect::field("some_bool").with_value(&true))
+ .and(expect::field("some_u64").with_value(&42_u64))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let some_str = Some("yes");
+ let none_str: Option<&'static str> = None;
+ let some_bool = Some(true);
+ let none_bool: Option<bool> = None;
+ let some_u64 = Some(42_u64);
+ let none_u64: Option<u64> = None;
+ trace!(
+ some_str = some_str,
+ none_str = none_str,
+ some_bool = some_bool,
+ none_bool = none_bool,
+ some_u64 = some_u64,
+ none_u64 = none_u64
+ );
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn option_ref_values() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("some_str")
+ .with_value(&"yes")
+ .and(expect::field("some_bool").with_value(&true))
+ .and(expect::field("some_u64").with_value(&42_u64))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let some_str = &Some("yes");
+ let none_str: &Option<&'static str> = &None;
+ let some_bool = &Some(true);
+ let none_bool: &Option<bool> = &None;
+ let some_u64 = &Some(42_u64);
+ let none_u64: &Option<u64> = &None;
+ trace!(
+ some_str = some_str,
+ none_str = none_str,
+ some_bool = some_bool,
+ none_bool = none_bool,
+ some_u64 = some_u64,
+ none_u64 = none_u64
+ );
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn option_ref_mut_values() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(
+ expect::event().with_fields(
+ expect::field("some_str")
+ .with_value(&"yes")
+ .and(expect::field("some_bool").with_value(&true))
+ .and(expect::field("some_u64").with_value(&42_u64))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let some_str = &mut Some("yes");
+ let none_str: &mut Option<&'static str> = &mut None;
+ let some_bool = &mut Some(true);
+ let none_bool: &mut Option<bool> = &mut None;
+ let some_u64 = &mut Some(42_u64);
+ let none_u64: &mut Option<u64> = &mut None;
+ trace!(
+ some_str = some_str,
+ none_str = none_str,
+ some_bool = some_bool,
+ none_bool = none_bool,
+ some_u64 = some_u64,
+ none_u64 = none_u64
+ );
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn string_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(expect::event().with_fields(expect::field("my_string").with_value(&"hello").only()))
+ .event(
+ expect::event().with_fields(
+ expect::field("my_string")
+ .with_value(&"hello world!")
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let mut my_string = String::from("hello");
+
+ tracing::event!(Level::INFO, my_string);
+
+ // the string is not moved by using it as a field!
+ my_string.push_str(" world!");
+
+ tracing::event!(Level::INFO, my_string);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn constant_field_name() {
+ let expect_event = || {
+ expect::event().with_fields(
+ expect::field("foo")
+ .with_value(&"bar")
+ .and(expect::field("constant string").with_value(&"also works"))
+ .and(expect::field("foo.bar").with_value(&"baz"))
+ .and(expect::field("message").with_value(&debug(format_args!("quux"))))
+ .only(),
+ )
+ };
+ let (subscriber, handle) = subscriber::mock()
+ .event(expect_event())
+ .event(expect_event())
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ const FOO: &str = "foo";
+ tracing::event!(
+ Level::INFO,
+ { std::convert::identity(FOO) } = "bar",
+ { "constant string" } = "also works",
+ foo.bar = "baz",
+ "quux"
+ );
+ tracing::event!(
+ Level::INFO,
+ {
+ { std::convert::identity(FOO) } = "bar",
+ { "constant string" } = "also works",
+ foo.bar = "baz",
+ },
+ "quux"
+ );
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing/tests/filter_caching_is_lexically_scoped.rs b/crates/tracing/tests/filter_caching_is_lexically_scoped.rs
new file mode 100644
index 0000000..e291103
--- /dev/null
+++ b/crates/tracing/tests/filter_caching_is_lexically_scoped.rs
@@ -0,0 +1,65 @@
+// Tests that depend on a count of the number of times their filter is evaluated
+// can't exist in the same file with other tests that add subscribers to the
+// registry. The registry was changed so that each time a new dispatcher is
+// added all filters are re-evaluated. The tests being run only in separate
+// threads with shared global state lets them interfere with each other
+
+#[cfg(not(feature = "std"))]
+extern crate std;
+
+use tracing::{span, Level};
+use tracing_mock::*;
+
+use std::sync::{
+ atomic::{AtomicUsize, Ordering},
+ Arc,
+};
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn filter_caching_is_lexically_scoped() {
+ pub fn my_great_function() -> bool {
+ span!(Level::TRACE, "emily").in_scope(|| true)
+ }
+
+ pub fn my_other_function() -> bool {
+ span!(Level::TRACE, "frank").in_scope(|| true)
+ }
+
+ let count = Arc::new(AtomicUsize::new(0));
+ let count2 = count.clone();
+
+ let subscriber = subscriber::mock()
+ .with_filter(move |meta| match meta.name() {
+ "emily" | "frank" => {
+ count2.fetch_add(1, Ordering::Relaxed);
+ true
+ }
+ _ => false,
+ })
+ .run();
+
+ // Since this test is in its own file anyway, we can do this. Thus, this
+ // test will work even with no-std.
+ tracing::subscriber::set_global_default(subscriber).unwrap();
+
+ // Call the function once. The filter should be re-evaluated.
+ assert!(my_great_function());
+ assert_eq!(count.load(Ordering::Relaxed), 1);
+
+ // Call the function again. The cached result should be used.
+ assert!(my_great_function());
+ assert_eq!(count.load(Ordering::Relaxed), 1);
+
+ assert!(my_other_function());
+ assert_eq!(count.load(Ordering::Relaxed), 2);
+
+ assert!(my_great_function());
+ assert_eq!(count.load(Ordering::Relaxed), 2);
+
+ assert!(my_other_function());
+ assert_eq!(count.load(Ordering::Relaxed), 2);
+
+ assert!(my_great_function());
+ assert_eq!(count.load(Ordering::Relaxed), 2);
+}
diff --git a/crates/tracing/tests/filters_are_not_reevaluated_for_the_same_span.rs b/crates/tracing/tests/filters_are_not_reevaluated_for_the_same_span.rs
new file mode 100644
index 0000000..e9b2529
--- /dev/null
+++ b/crates/tracing/tests/filters_are_not_reevaluated_for_the_same_span.rs
@@ -0,0 +1,70 @@
+// Tests that depend on a count of the number of times their filter is evaluated
+// cant exist in the same file with other tests that add subscribers to the
+// registry. The registry was changed so that each time a new dispatcher is
+// added all filters are re-evaluated. The tests being run only in separate
+// threads with shared global state lets them interfere with each other
+#[cfg(not(feature = "std"))]
+extern crate std;
+
+use tracing::{span, Level};
+use tracing_mock::*;
+
+use std::sync::{
+ atomic::{AtomicUsize, Ordering},
+ Arc,
+};
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn filters_are_not_reevaluated_for_the_same_span() {
+ // Asserts that the `span!` macro caches the result of calling
+ // `Subscriber::enabled` for each span.
+ let alice_count = Arc::new(AtomicUsize::new(0));
+ let bob_count = Arc::new(AtomicUsize::new(0));
+ let alice_count2 = alice_count.clone();
+ let bob_count2 = bob_count.clone();
+
+ let (subscriber, handle) = subscriber::mock()
+ .with_filter(move |meta| match meta.name() {
+ "alice" => {
+ alice_count2.fetch_add(1, Ordering::Relaxed);
+ false
+ }
+ "bob" => {
+ bob_count2.fetch_add(1, Ordering::Relaxed);
+ true
+ }
+ _ => false,
+ })
+ .run_with_handle();
+
+ // Since this test is in its own file anyway, we can do this. Thus, this
+ // test will work even with no-std.
+ tracing::subscriber::set_global_default(subscriber).unwrap();
+
+ // Enter "alice" and then "bob". The dispatcher expects to see "bob" but
+ // not "alice."
+ let alice = span!(Level::TRACE, "alice");
+ let bob = alice.in_scope(|| {
+ let bob = span!(Level::TRACE, "bob");
+ bob.in_scope(|| ());
+ bob
+ });
+
+ // The filter should have seen each span a single time.
+ assert_eq!(alice_count.load(Ordering::Relaxed), 1);
+ assert_eq!(bob_count.load(Ordering::Relaxed), 1);
+
+ alice.in_scope(|| bob.in_scope(|| {}));
+
+ // The subscriber should see "bob" again, but the filter should not have
+ // been called.
+ assert_eq!(alice_count.load(Ordering::Relaxed), 1);
+ assert_eq!(bob_count.load(Ordering::Relaxed), 1);
+
+ bob.in_scope(|| {});
+ assert_eq!(alice_count.load(Ordering::Relaxed), 1);
+ assert_eq!(bob_count.load(Ordering::Relaxed), 1);
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing/tests/filters_are_reevaluated_for_different_call_sites.rs b/crates/tracing/tests/filters_are_reevaluated_for_different_call_sites.rs
new file mode 100644
index 0000000..265d4a8
--- /dev/null
+++ b/crates/tracing/tests/filters_are_reevaluated_for_different_call_sites.rs
@@ -0,0 +1,80 @@
+// Tests that depend on a count of the number of times their filter is evaluated
+// cant exist in the same file with other tests that add subscribers to the
+// registry. The registry was changed so that each time a new dispatcher is
+// added all filters are re-evaluated. The tests being run only in separate
+// threads with shared global state lets them interfere with each other
+#[cfg(not(feature = "std"))]
+extern crate std;
+
+use tracing::{span, Level};
+use tracing_mock::*;
+
+use std::sync::{
+ atomic::{AtomicUsize, Ordering},
+ Arc,
+};
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn filters_are_reevaluated_for_different_call_sites() {
+ // Asserts that the `span!` macro caches the result of calling
+ // `Subscriber::enabled` for each span.
+ let charlie_count = Arc::new(AtomicUsize::new(0));
+ let dave_count = Arc::new(AtomicUsize::new(0));
+ let charlie_count2 = charlie_count.clone();
+ let dave_count2 = dave_count.clone();
+
+ let subscriber = subscriber::mock()
+ .with_filter(move |meta| {
+ println!("Filter: {:?}", meta.name());
+ match meta.name() {
+ "charlie" => {
+ charlie_count2.fetch_add(1, Ordering::Relaxed);
+ false
+ }
+ "dave" => {
+ dave_count2.fetch_add(1, Ordering::Relaxed);
+ true
+ }
+ _ => false,
+ }
+ })
+ .run();
+
+ // Since this test is in its own file anyway, we can do this. Thus, this
+ // test will work even with no-std.
+ tracing::subscriber::set_global_default(subscriber).unwrap();
+
+ // Enter "charlie" and then "dave". The dispatcher expects to see "dave" but
+ // not "charlie."
+ let charlie = span!(Level::TRACE, "charlie");
+ let dave = charlie.in_scope(|| {
+ let dave = span!(Level::TRACE, "dave");
+ dave.in_scope(|| {});
+ dave
+ });
+
+ // The filter should have seen each span a single time.
+ assert_eq!(charlie_count.load(Ordering::Relaxed), 1);
+ assert_eq!(dave_count.load(Ordering::Relaxed), 1);
+
+ charlie.in_scope(|| dave.in_scope(|| {}));
+
+ // The subscriber should see "dave" again, but the filter should not have
+ // been called.
+ assert_eq!(charlie_count.load(Ordering::Relaxed), 1);
+ assert_eq!(dave_count.load(Ordering::Relaxed), 1);
+
+ // A different span with the same name has a different call site, so it
+ // should cause the filter to be reapplied.
+ let charlie2 = span!(Level::TRACE, "charlie");
+ charlie.in_scope(|| {});
+ assert_eq!(charlie_count.load(Ordering::Relaxed), 2);
+ assert_eq!(dave_count.load(Ordering::Relaxed), 1);
+
+ // But, the filter should not be re-evaluated for the new "charlie" span
+ // when it is re-entered.
+ charlie2.in_scope(|| span!(Level::TRACE, "dave").in_scope(|| {}));
+ assert_eq!(charlie_count.load(Ordering::Relaxed), 2);
+ assert_eq!(dave_count.load(Ordering::Relaxed), 2);
+}
diff --git a/crates/tracing/tests/filters_dont_leak.rs b/crates/tracing/tests/filters_dont_leak.rs
new file mode 100644
index 0000000..c46b91f
--- /dev/null
+++ b/crates/tracing/tests/filters_dont_leak.rs
@@ -0,0 +1,81 @@
+#![cfg(feature = "std")]
+
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn spans_dont_leak() {
+ fn do_span() {
+ let span = tracing::debug_span!("alice");
+ let _e = span.enter();
+ }
+
+ let (subscriber, handle) = subscriber::mock()
+ .named("spans/subscriber1")
+ .with_filter(|_| false)
+ .only()
+ .run_with_handle();
+
+ let _guard = tracing::subscriber::set_default(subscriber);
+
+ do_span();
+
+ let alice = expect::span().named("alice");
+ let (subscriber2, handle2) = subscriber::mock()
+ .named("spans/subscriber2")
+ .with_filter(|_| true)
+ .new_span(alice.clone())
+ .enter(alice.clone())
+ .exit(alice.clone())
+ .drop_span(alice)
+ .only()
+ .run_with_handle();
+
+ tracing::subscriber::with_default(subscriber2, || {
+ println!("--- subscriber 2 is default ---");
+ do_span()
+ });
+
+ println!("--- subscriber 1 is default ---");
+ do_span();
+
+ handle.assert_finished();
+ handle2.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn events_dont_leak() {
+ fn do_event() {
+ tracing::debug!("alice");
+ }
+
+ let (subscriber, handle) = subscriber::mock()
+ .named("events/subscriber1")
+ .with_filter(|_| false)
+ .only()
+ .run_with_handle();
+
+ let _guard = tracing::subscriber::set_default(subscriber);
+
+ do_event();
+
+ let (subscriber2, handle2) = subscriber::mock()
+ .named("events/subscriber2")
+ .with_filter(|_| true)
+ .event(expect::event())
+ .only()
+ .run_with_handle();
+
+ tracing::subscriber::with_default(subscriber2, || {
+ println!("--- subscriber 2 is default ---");
+ do_event()
+ });
+
+ println!("--- subscriber 1 is default ---");
+
+ do_event();
+
+ handle.assert_finished();
+ handle2.assert_finished();
+}
diff --git a/crates/tracing/tests/future_send.rs b/crates/tracing/tests/future_send.rs
new file mode 100644
index 0000000..5e5f9f1
--- /dev/null
+++ b/crates/tracing/tests/future_send.rs
@@ -0,0 +1,22 @@
+// These tests reproduce the following issues:
+// - https://github.com/tokio-rs/tracing/issues/1487
+// - https://github.com/tokio-rs/tracing/issues/1793
+
+use core::future::{self, Future};
+#[test]
+fn async_fn_is_send() {
+ async fn some_async_fn() {
+ tracing::info!("{}", future::ready("test").await);
+ }
+
+ assert_send(some_async_fn())
+}
+
+#[test]
+fn async_block_is_send() {
+ assert_send(async {
+ tracing::info!("{}", future::ready("test").await);
+ })
+}
+
+fn assert_send<F: Future + Send>(_f: F) {}
diff --git a/crates/tracing/tests/instrument.rs b/crates/tracing/tests/instrument.rs
new file mode 100644
index 0000000..5247249
--- /dev/null
+++ b/crates/tracing/tests/instrument.rs
@@ -0,0 +1,59 @@
+// These tests require the thread-local scoped dispatcher, which only works when
+// we have a standard library. The behaviour being tested should be the same
+// with the standard lib disabled.
+#![cfg(feature = "std")]
+
+use std::{future::Future, pin::Pin, task};
+
+use futures::FutureExt as _;
+use tracing::{subscriber::with_default, Instrument as _, Level};
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_on_drop() {
+ #[derive(Clone, Debug)]
+ struct AssertSpanOnDrop;
+
+ impl Drop for AssertSpanOnDrop {
+ fn drop(&mut self) {
+ tracing::info!("Drop");
+ }
+ }
+
+ struct Fut(Option<AssertSpanOnDrop>);
+
+ impl Future for Fut {
+ type Output = ();
+
+ fn poll(mut self: Pin<&mut Self>, _: &mut task::Context<'_>) -> task::Poll<Self::Output> {
+ self.set(Fut(None));
+ task::Poll::Ready(())
+ }
+ }
+
+ let subscriber = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event().at_level(Level::INFO))
+ .exit(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .enter(expect::span().named("bar"))
+ .event(expect::event().at_level(Level::INFO))
+ .exit(expect::span().named("bar"))
+ .drop_span(expect::span().named("bar"))
+ .only()
+ .run();
+
+ with_default(subscriber, || {
+ // polled once
+ Fut(Some(AssertSpanOnDrop))
+ .instrument(tracing::span!(Level::TRACE, "foo"))
+ .now_or_never()
+ .unwrap();
+
+ // never polled
+ drop(Fut(Some(AssertSpanOnDrop)).instrument(tracing::span!(Level::TRACE, "bar")));
+ });
+}
diff --git a/crates/tracing/tests/macro_imports.rs b/crates/tracing/tests/macro_imports.rs
new file mode 100644
index 0000000..2d0a9d6
--- /dev/null
+++ b/crates/tracing/tests/macro_imports.rs
@@ -0,0 +1,23 @@
+use tracing::Level;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn prefixed_span_macros() {
+ tracing::span!(Level::DEBUG, "foo");
+ tracing::trace_span!("foo");
+ tracing::debug_span!("foo");
+ tracing::info_span!("foo");
+ tracing::warn_span!("foo");
+ tracing::error_span!("foo");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn prefixed_event_macros() {
+ tracing::event!(Level::DEBUG, "foo");
+ tracing::trace!("foo");
+ tracing::debug!("foo");
+ tracing::info!("foo");
+ tracing::warn!("foo");
+ tracing::error!("foo");
+}
diff --git a/crates/tracing/tests/macros.rs b/crates/tracing/tests/macros.rs
new file mode 100644
index 0000000..81b929d
--- /dev/null
+++ b/crates/tracing/tests/macros.rs
@@ -0,0 +1,1271 @@
+#![deny(warnings)]
+// We call all macros in this module with `no_implicit_prelude` to ensure they do not depend on the standard prelude.
+#![no_implicit_prelude]
+extern crate tracing;
+#[cfg(target_arch = "wasm32")]
+extern crate wasm_bindgen_test;
+
+// TODO: remove this once https://github.com/tokio-rs/tracing/pull/2675#issuecomment-1667628907 is resolved
+#[cfg(target_arch = "wasm32")]
+use ::core::option::Option::None;
+
+use tracing::{
+ callsite, debug, debug_span, enabled, error, error_span, event, event_enabled, info, info_span,
+ span, span_enabled, trace, trace_span, warn, warn_span, Level,
+};
+
+// Tests that macros work across various invocation syntax.
+//
+// These are quite repetitive, and _could_ be generated by a macro. However,
+// they're compile-time tests, so I want to get line numbers etc out of
+// failures, and producing them with a macro would muddy the waters a bit.
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span() {
+ span!(target: "foo_events", Level::DEBUG, "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ span!(target: "foo_events", Level::DEBUG, "foo", bar.baz = 2, quux = 3);
+ span!(target: "foo_events", Level::DEBUG, "foo", bar.baz = 2, quux = 4,);
+ span!(target: "foo_events", Level::DEBUG, "foo");
+ span!(target: "foo_events", Level::DEBUG, "bar",);
+ span!(Level::DEBUG, "foo", bar.baz = 2, quux = 3);
+ span!(Level::DEBUG, "foo", bar.baz = 2, quux = 4,);
+ span!(Level::DEBUG, "foo", bar.baz = 2, quux = 3);
+ span!(Level::DEBUG, "foo", bar.baz = 2, quux = 4,);
+ span!(Level::DEBUG, "foo", bar.baz = ?2);
+ span!(Level::DEBUG, "foo", bar.baz = %2);
+ span!(Level::DEBUG, "foo");
+ span!(Level::DEBUG, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace_span() {
+ trace_span!(target: "foo_events", "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ trace_span!(target: "foo_events", "foo", bar.baz = 2, quux = 3);
+ trace_span!(target: "foo_events", "foo", bar.baz = 2, quux = 4,);
+ trace_span!(target: "foo_events", "foo");
+ trace_span!(target: "foo_events", "bar",);
+ trace_span!("foo", bar.baz = 2, quux = 3);
+ trace_span!("foo", bar.baz = 2, quux = 4,);
+ trace_span!("foo", bar.baz = ?2);
+ trace_span!("foo", bar.baz = %2);
+ trace_span!("bar");
+ trace_span!("bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_span() {
+ debug_span!(target: "foo_events", "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ debug_span!(target: "foo_events", "foo", bar.baz = 2, quux = 3);
+ debug_span!(target: "foo_events", "foo", bar.baz = 2, quux = 4,);
+ debug_span!(target: "foo_events", "foo");
+ debug_span!(target: "foo_events", "bar",);
+ debug_span!("foo", bar.baz = 2, quux = 3);
+ debug_span!("foo", bar.baz = 2, quux = 4,);
+ debug_span!("foo", bar.baz = ?2);
+ debug_span!("foo", bar.baz = %2);
+ debug_span!("bar");
+ debug_span!("bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info_span() {
+ info_span!(target: "foo_events", "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ info_span!(target: "foo_events", "foo", bar.baz = 2, quux = 3);
+ info_span!(target: "foo_events", "foo", bar.baz = 2, quux = 4,);
+ info_span!(target: "foo_events", "foo");
+ info_span!(target: "foo_events", "bar",);
+ info_span!("foo", bar.baz = 2, quux = 3);
+ info_span!("foo", bar.baz = 2, quux = 4,);
+ info_span!("foo", bar.baz = ?2);
+ info_span!("foo", bar.baz = %2);
+ info_span!("bar");
+ info_span!("bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn_span() {
+ warn_span!(target: "foo_events", "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ warn_span!(target: "foo_events", "foo", bar.baz = 2, quux = 3);
+ warn_span!(target: "foo_events", "foo", bar.baz = 2, quux = 4,);
+ warn_span!(target: "foo_events", "foo");
+ warn_span!(target: "foo_events", "bar",);
+ warn_span!("foo", bar.baz = 2, quux = 3);
+ warn_span!("foo", bar.baz = 2, quux = 4,);
+ warn_span!("foo", bar.baz = ?2);
+ warn_span!("foo", bar.baz = %2);
+ warn_span!("bar");
+ warn_span!("bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error_span() {
+ error_span!(target: "foo_events", "foo", bar.baz = ?2, quux = %3, quuux = 4);
+ error_span!(target: "foo_events", "foo", bar.baz = 2, quux = 3);
+ error_span!(target: "foo_events", "foo", bar.baz = 2, quux = 4,);
+ error_span!(target: "foo_events", "foo");
+ error_span!(target: "foo_events", "bar",);
+ error_span!("foo", bar.baz = 2, quux = 3);
+ error_span!("foo", bar.baz = 2, quux = 4,);
+ error_span!("foo", bar.baz = ?2);
+ error_span!("foo", bar.baz = %2);
+ error_span!("bar");
+ error_span!("bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_root() {
+ span!(target: "foo_events", parent: ::core::option::Option::None, Level::TRACE, "foo", bar.baz = 2, quux = 3);
+ span!(target: "foo_events", parent: ::core::option::Option::None, Level::TRACE, "foo", bar.baz = 2, quux = 3);
+ span!(target: "foo_events", parent: ::core::option::Option::None, Level::TRACE, "foo", bar.baz = 2, quux = 4,);
+ span!(target: "foo_events", parent: ::core::option::Option::None, Level::TRACE, "foo");
+ span!(target: "foo_events", parent: ::core::option::Option::None, Level::TRACE, "bar",);
+ span!(
+ parent: ::core::option::Option::None,
+ Level::DEBUG,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ span!(
+ parent: ::core::option::Option::None,
+ Level::DEBUG,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ span!(parent: ::core::option::Option::None, Level::DEBUG, "foo");
+ span!(parent: ::core::option::Option::None, Level::DEBUG, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace_span_root() {
+ trace_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 3);
+ trace_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 4,);
+ trace_span!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ trace_span!(target: "foo_events", parent: ::core::option::Option::None, "bar",);
+ trace_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ trace_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ trace_span!(parent: ::core::option::Option::None, "foo");
+ trace_span!(parent: ::core::option::Option::None, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_span_root() {
+ debug_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 3);
+ debug_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 4,);
+ debug_span!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ debug_span!(target: "foo_events", parent: ::core::option::Option::None, "bar",);
+ debug_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ debug_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ debug_span!(parent: ::core::option::Option::None, "foo");
+ debug_span!(parent: ::core::option::Option::None, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info_span_root() {
+ info_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 3);
+ info_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 4,);
+ info_span!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ info_span!(target: "foo_events", parent: ::core::option::Option::None, "bar",);
+ info_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ info_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ info_span!(parent: ::core::option::Option::None, "foo");
+ info_span!(parent: ::core::option::Option::None, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn_span_root() {
+ warn_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 3);
+ warn_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 4,);
+ warn_span!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ warn_span!(target: "foo_events", parent: ::core::option::Option::None, "bar",);
+ warn_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ warn_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ warn_span!(parent: ::core::option::Option::None, "foo");
+ warn_span!(parent: ::core::option::Option::None, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error_span_root() {
+ error_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 3);
+ error_span!(target: "foo_events", parent: ::core::option::Option::None, "foo", bar.baz = 2, quux = 4,);
+ error_span!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ error_span!(target: "foo_events", parent: ::core::option::Option::None, "bar",);
+ error_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 3
+ );
+ error_span!(
+ parent: ::core::option::Option::None,
+ "foo",
+ bar.baz = 2,
+ quux = 4,
+ );
+ error_span!(parent: ::core::option::Option::None, "foo");
+ error_span!(parent: ::core::option::Option::None, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ span!(target: "foo_events", parent: &p, Level::TRACE, "foo", bar.baz = 2, quux = 3);
+ span!(target: "foo_events", parent: &p, Level::TRACE, "foo", bar.baz = 2, quux = 4,);
+ span!(target: "foo_events", parent: &p, Level::TRACE, "foo");
+ span!(target: "foo_events", parent: &p, Level::TRACE, "bar",);
+ span!(parent: &p, Level::DEBUG, "foo", bar.baz = 2, quux = 3);
+ span!(parent: &p, Level::DEBUG, "foo", bar.baz = 2, quux = 4,);
+ span!(parent: &p, Level::DEBUG, "foo");
+ span!(parent: &p, Level::DEBUG, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace_span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ trace_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 3);
+ trace_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 4,);
+ trace_span!(target: "foo_events", parent: &p, "foo");
+ trace_span!(target: "foo_events", parent: &p, "bar",);
+
+ trace_span!(parent: &p, "foo", bar.baz = 2, quux = 3);
+ trace_span!(parent: &p, "foo", bar.baz = 2, quux = 4,);
+
+ trace_span!(parent: &p, "foo");
+ trace_span!(parent: &p, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ debug_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 3);
+ debug_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 4,);
+ debug_span!(target: "foo_events", parent: &p, "foo");
+ debug_span!(target: "foo_events", parent: &p, "bar",);
+
+ debug_span!(parent: &p, "foo", bar.baz = 2, quux = 3);
+ debug_span!(parent: &p, "foo", bar.baz = 2, quux = 4,);
+
+ debug_span!(parent: &p, "foo");
+ debug_span!(parent: &p, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info_span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ info_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 3);
+ info_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 4,);
+ info_span!(target: "foo_events", parent: &p, "foo");
+ info_span!(target: "foo_events", parent: &p, "bar",);
+
+ info_span!(parent: &p, "foo", bar.baz = 2, quux = 3);
+ info_span!(parent: &p, "foo", bar.baz = 2, quux = 4,);
+
+ info_span!(parent: &p, "foo");
+ info_span!(parent: &p, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn_span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ warn_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 3);
+ warn_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 4,);
+ warn_span!(target: "foo_events", parent: &p, "foo");
+ warn_span!(target: "foo_events", parent: &p, "bar",);
+
+ warn_span!(parent: &p, "foo", bar.baz = 2, quux = 3);
+ warn_span!(parent: &p, "foo", bar.baz = 2, quux = 4,);
+
+ warn_span!(parent: &p, "foo");
+ warn_span!(parent: &p, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error_span_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ error_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 3);
+ error_span!(target: "foo_events", parent: &p, "foo", bar.baz = 2, quux = 4,);
+ error_span!(target: "foo_events", parent: &p, "foo");
+ error_span!(target: "foo_events", parent: &p, "bar",);
+
+ error_span!(parent: &p, "foo", bar.baz = 2, quux = 3);
+ error_span!(parent: &p, "foo", bar.baz = 2, quux = 4,);
+
+ error_span!(parent: &p, "foo");
+ error_span!(parent: &p, "bar",);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_with_non_rust_symbol() {
+ span!(Level::TRACE, "non-rust", "guid:x-request-id" = ?"abcdef", "more {}", 42);
+ span!(Level::TRACE, "non-rust", "guid:x-request-id" = %"abcdef", "more {}", 51);
+ span!(
+ Level::TRACE,
+ "non-rust",
+ "guid:x-request-id" = "abcdef",
+ "more {}",
+ 60
+ );
+ span!(Level::TRACE, "non-rust", "guid:x-request-id" = ?"abcdef");
+ span!(Level::TRACE, "non-rust", "guid:x-request-id" = %"abcdef");
+ span!(Level::TRACE, "non-rust", "guid:x-request-id" = "abcdef");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn large_span() {
+ span!(
+ Level::TRACE,
+ "spans with more than 32 fields have been supported since #2508",
+ a = 1,
+ b = 2,
+ c = 3,
+ d = 4,
+ e = 5,
+ f = 6,
+ g = 7,
+ h = 8,
+ i = 9,
+ j = 10,
+ k = 11,
+ l = 12,
+ m = 13,
+ n = 14,
+ o = 15,
+ p = 16,
+ q = 17,
+ r = 18,
+ s = 19,
+ t = 20,
+ u = 21,
+ v = 22,
+ w = 23,
+ x = 24,
+ y = 25,
+ z = 26,
+ aa = 27,
+ bb = 28,
+ cc = 29,
+ dd = 30,
+ ee = 31,
+ ff = 32,
+ gg = 33
+ );
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event() {
+ event!(Level::DEBUG, foo = ?3, bar.baz = %2, quux = false);
+ event!(Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(Level::DEBUG, "foo");
+ event!(Level::DEBUG, "foo: {}", 3);
+ event!(Level::INFO, foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ event!(
+ Level::INFO,
+ foo = 3,
+ bar.baz = 2,
+ quux = false,
+ "hello world {:?}",
+ 42
+ );
+ event!(Level::INFO, foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ event!(Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(Level::DEBUG, { foo = ?2, bar.baz = %78 }, "quux");
+ event!(target: "foo_events", Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(target: "foo_events", Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(target: "foo_events", Level::DEBUG, "foo");
+ event!(target: "foo_events", Level::DEBUG, "foo: {}", 3);
+ event!(target: "foo_events", Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(target: "foo_events", Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(target: "foo_events", Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(target: "foo_events", Level::DEBUG, { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ event!(Level::DEBUG, ?foo);
+ event!(Level::DEBUG, %foo);
+ event!(Level::DEBUG, foo);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn enabled() {
+ enabled!(Level::DEBUG, foo, bar.baz, quux,);
+ enabled!(Level::DEBUG, message);
+ enabled!(Level::INFO, foo, bar.baz, quux, message,);
+ enabled!(Level::INFO, foo, bar., message,);
+ enabled!(Level::DEBUG, foo);
+
+ enabled!(Level::DEBUG);
+ enabled!(target: "rando", Level::DEBUG);
+ enabled!(target: "rando", Level::DEBUG, field);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_enabled() {
+ span_enabled!(Level::DEBUG, foo, bar.baz, quux,);
+ span_enabled!(Level::DEBUG, message);
+ span_enabled!(Level::INFO, foo, bar.baz, quux, message,);
+ span_enabled!(Level::INFO, foo, bar., message,);
+ span_enabled!(Level::DEBUG, foo);
+
+ span_enabled!(Level::DEBUG);
+ span_enabled!(target: "rando", Level::DEBUG);
+ span_enabled!(target: "rando", Level::DEBUG, field);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_enabled() {
+ event_enabled!(Level::DEBUG, foo, bar.baz, quux,);
+ event_enabled!(Level::DEBUG, message);
+ event_enabled!(Level::INFO, foo, bar.baz, quux, message,);
+ event_enabled!(Level::INFO, foo, bar., message,);
+ event_enabled!(Level::DEBUG, foo);
+
+ event_enabled!(Level::DEBUG);
+ event_enabled!(target: "rando", Level::DEBUG);
+ event_enabled!(target: "rando", Level::DEBUG, field);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn locals_with_message() {
+ let data = (42, "forty-two");
+ let private_data = "private";
+ let error = "a bad error";
+ event!(Level::ERROR, %error, "Received error");
+ event!(
+ target: "app_events",
+ Level::WARN,
+ private_data,
+ ?data,
+ "App warning: {}",
+ error
+ );
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn locals_no_message() {
+ let data = (42, "forty-two");
+ let private_data = "private";
+ let error = "a bad error";
+ event!(
+ name: "foo",
+ target: "app_events",
+ Level::WARN,
+ private_data,
+ ?data,
+ );
+ event!(
+ target: "app_events",
+ Level::WARN,
+ private_data,
+ ?data,
+ );
+ event!(
+ target: "app_events",
+ Level::WARN,
+ private_data,
+ ?data,
+ error,
+ );
+ event!(
+ target: "app_events",
+ Level::WARN,
+ private_data,
+ ?data,
+ error
+ );
+ event!(Level::WARN, private_data, ?data, error,);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace() {
+ trace!(foo = ?3, bar.baz = %2, quux = false);
+ trace!(foo = 3, bar.baz = 2, quux = false);
+ trace!(foo = 3, bar.baz = 3,);
+ trace!("foo");
+ trace!("foo: {}", 3);
+ trace!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ trace!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
+ trace!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ trace!({ foo = 3, bar.baz = 80 }, "quux");
+ trace!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!({ foo = 2, bar.baz = 78 }, "quux");
+ trace!({ foo = ?2, bar.baz = %78 }, "quux");
+ trace!(name: "foo", foo = 3, bar.baz = 2, quux = false);
+ trace!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ trace!(target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ trace!(target: "foo_events", foo = 3, bar.baz = 3,);
+ trace!(target: "foo_events", "foo");
+ trace!(target: "foo_events", "foo: {}", 3);
+ trace!(target: "foo_events", { foo = 3, bar.baz = 80 }, "quux");
+ trace!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(target: "foo_events", { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ trace!(?foo);
+ trace!(%foo);
+ trace!(foo);
+ trace!(name: "foo", ?foo);
+ trace!(name: "foo", %foo);
+ trace!(name: "foo", foo);
+ trace!(name: "foo", ?foo, true, "message");
+ trace!(name: "foo", %foo, true, "message");
+ trace!(name: "foo", foo, true, "message");
+ trace!(target: "foo_events", ?foo);
+ trace!(target: "foo_events", %foo);
+ trace!(target: "foo_events", foo);
+ trace!(target: "foo_events", ?foo, true, "message");
+ trace!(target: "foo_events", %foo, true, "message");
+ trace!(target: "foo_events", foo, true, "message");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug() {
+ debug!(foo = ?3, bar.baz = %2, quux = false);
+ debug!(foo = 3, bar.baz = 2, quux = false);
+ debug!(foo = 3, bar.baz = 3,);
+ debug!("foo");
+ debug!("foo: {}", 3);
+ debug!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ debug!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
+ debug!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ debug!({ foo = 3, bar.baz = 80 }, "quux");
+ debug!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!({ foo = 2, bar.baz = 78 }, "quux");
+ debug!({ foo = ?2, bar.baz = %78 }, "quux");
+ debug!(name: "foo", foo = 3, bar.baz = 2, quux = false);
+ debug!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ debug!(target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ debug!(target: "foo_events", foo = 3, bar.baz = 3,);
+ debug!(target: "foo_events", "foo");
+ debug!(target: "foo_events", "foo: {}", 3);
+ debug!(target: "foo_events", { foo = 3, bar.baz = 80 }, "quux");
+ debug!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(target: "foo_events", { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ debug!(?foo);
+ debug!(%foo);
+ debug!(foo);
+ debug!(name: "foo", ?foo);
+ debug!(name: "foo", %foo);
+ debug!(name: "foo", foo);
+ debug!(name: "foo", ?foo, true, "message");
+ debug!(name: "foo", %foo, true, "message");
+ debug!(name: "foo", foo, true, "message");
+ debug!(target: "foo_events", ?foo);
+ debug!(target: "foo_events", %foo);
+ debug!(target: "foo_events", foo);
+ debug!(target: "foo_events", ?foo, true, "message");
+ debug!(target: "foo_events", %foo, true, "message");
+ debug!(target: "foo_events", foo, true, "message");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info() {
+ info!(foo = ?3, bar.baz = %2, quux = false);
+ info!(foo = 3, bar.baz = 2, quux = false);
+ info!(foo = 3, bar.baz = 3,);
+ info!("foo");
+ info!("foo: {}", 3);
+ info!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ info!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
+ info!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ info!({ foo = 3, bar.baz = 80 }, "quux");
+ info!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!({ foo = 2, bar.baz = 78 }, "quux");
+ info!({ foo = ?2, bar.baz = %78 }, "quux");
+ info!(name: "foo", foo = 3, bar.baz = 2, quux = false);
+ info!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ info!(target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ info!(target: "foo_events", foo = 3, bar.baz = 3,);
+ info!(target: "foo_events", "foo");
+ info!(target: "foo_events", "foo: {}", 3);
+ info!(target: "foo_events", { foo = 3, bar.baz = 80 }, "quux");
+ info!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(target: "foo_events", { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ info!(?foo);
+ info!(%foo);
+ info!(foo);
+ info!(name: "foo", ?foo);
+ info!(name: "foo", %foo);
+ info!(name: "foo", foo);
+ info!(name: "foo", ?foo, true, "message");
+ info!(name: "foo", %foo, true, "message");
+ info!(name: "foo", foo, true, "message");
+ info!(target: "foo_events", ?foo);
+ info!(target: "foo_events", %foo);
+ info!(target: "foo_events", foo);
+ info!(target: "foo_events", ?foo, true, "message");
+ info!(target: "foo_events", %foo, true, "message");
+ info!(target: "foo_events", foo, true, "message");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn() {
+ warn!(foo = ?3, bar.baz = %2, quux = false);
+ warn!(foo = 3, bar.baz = 2, quux = false);
+ warn!(foo = 3, bar.baz = 3,);
+ warn!("foo");
+ warn!("foo: {}", 3);
+ warn!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ warn!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
+ warn!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ warn!({ foo = 3, bar.baz = 80 }, "quux");
+ warn!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!({ foo = 2, bar.baz = 78 }, "quux");
+ warn!({ foo = ?2, bar.baz = %78 }, "quux");
+ warn!(name: "foo", foo = 3, bar.baz = 2, quux = false);
+ warn!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ warn!(target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ warn!(target: "foo_events", foo = 3, bar.baz = 3,);
+ warn!(target: "foo_events", "foo");
+ warn!(target: "foo_events", "foo: {}", 3);
+ warn!(target: "foo_events", { foo = 3, bar.baz = 80 }, "quux");
+ warn!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(target: "foo_events", { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ warn!(?foo);
+ warn!(%foo);
+ warn!(foo);
+ warn!(name: "foo", ?foo);
+ warn!(name: "foo", %foo);
+ warn!(name: "foo", foo);
+ warn!(name: "foo", ?foo, true, "message");
+ warn!(name: "foo", %foo, true, "message");
+ warn!(name: "foo", foo, true, "message");
+ warn!(target: "foo_events", ?foo);
+ warn!(target: "foo_events", %foo);
+ warn!(target: "foo_events", foo);
+ warn!(target: "foo_events", ?foo, true, "message");
+ warn!(target: "foo_events", %foo, true, "message");
+ warn!(target: "foo_events", foo, true, "message");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error() {
+ error!(foo = ?3, bar.baz = %2, quux = false);
+ error!(foo = 3, bar.baz = 2, quux = false);
+ error!(foo = 3, bar.baz = 3,);
+ error!("foo");
+ error!("foo: {}", 3);
+ error!(foo = ?3, bar.baz = %2, quux = false, "hello world {:?}", 42);
+ error!(foo = 3, bar.baz = 2, quux = false, "hello world {:?}", 42);
+ error!(foo = 3, bar.baz = 3, "hello world {:?}", 42,);
+ error!({ foo = 3, bar.baz = 80 }, "quux");
+ error!({ foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!({ foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!({ foo = 2, bar.baz = 78, }, "quux");
+ error!({ foo = ?2, bar.baz = %78 }, "quux");
+ error!(name: "foo", foo = 3, bar.baz = 2, quux = false);
+ error!(name: "foo", target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ error!(target: "foo_events", foo = 3, bar.baz = 2, quux = false);
+ error!(target: "foo_events", foo = 3, bar.baz = 3,);
+ error!(target: "foo_events", "foo");
+ error!(target: "foo_events", "foo: {}", 3);
+ error!(target: "foo_events", { foo = 3, bar.baz = 80 }, "quux");
+ error!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(target: "foo_events", { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(target: "foo_events", { foo = 2, bar.baz = 78, }, "quux");
+ let foo = 1;
+ error!(?foo);
+ error!(%foo);
+ error!(foo);
+ error!(name: "foo", ?foo);
+ error!(name: "foo", %foo);
+ error!(name: "foo", foo);
+ error!(name: "foo", ?foo, true, "message");
+ error!(name: "foo", %foo, true, "message");
+ error!(name: "foo", foo, true, "message");
+ error!(target: "foo_events", ?foo);
+ error!(target: "foo_events", %foo);
+ error!(target: "foo_events", foo);
+ error!(target: "foo_events", ?foo, true, "message");
+ error!(target: "foo_events", %foo, true, "message");
+ error!(target: "foo_events", foo, true, "message");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_root() {
+ event!(parent: ::core::option::Option::None, Level::DEBUG, foo = ?3, bar.baz = %2, quux = false);
+ event!(
+ parent: ::core::option::Option::None,
+ Level::DEBUG,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ event!(
+ parent: ::core::option::Option::None,
+ Level::DEBUG,
+ foo = 3,
+ bar.baz = 3,
+ );
+ event!(parent: ::core::option::Option::None, Level::DEBUG, "foo");
+ event!(
+ parent: ::core::option::Option::None,
+ Level::DEBUG,
+ "foo: {}",
+ 3
+ );
+ event!(parent: ::core::option::Option::None, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(parent: ::core::option::Option::None, Level::DEBUG, { foo = ?2, bar.baz = %78 }, "quux");
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, "foo");
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, "foo: {}", 3);
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 78, }, "quux");
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, "foo");
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, "foo: {}", 3);
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, Level::DEBUG, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace_root() {
+ trace!(parent: ::core::option::Option::None, foo = ?3, bar.baz = %2, quux = false);
+ trace!(
+ parent: ::core::option::Option::None,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ trace!(parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ trace!(parent: ::core::option::Option::None, "foo");
+ trace!(parent: ::core::option::Option::None, "foo: {}", 3);
+ trace!(parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 78 }, "quux");
+ trace!(parent: ::core::option::Option::None, { foo = ?2, bar.baz = %78 }, "quux");
+ trace!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ trace!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ trace!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ trace!(target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ trace!(target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo");
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_root() {
+ debug!(parent: ::core::option::Option::None, foo = ?3, bar.baz = %2, quux = false);
+ debug!(
+ parent: ::core::option::Option::None,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ debug!(parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ debug!(parent: ::core::option::Option::None, "foo");
+ debug!(parent: ::core::option::Option::None, "foo: {}", 3);
+ debug!(parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 78 }, "quux");
+ debug!(parent: ::core::option::Option::None, { foo = ?2, bar.baz = %78 }, "quux");
+ debug!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ debug!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ debug!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ debug!(target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ debug!(target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo");
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info_root() {
+ info!(parent: ::core::option::Option::None, foo = ?3, bar.baz = %2, quux = false);
+ info!(
+ parent: ::core::option::Option::None,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ info!(parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ info!(parent: ::core::option::Option::None, "foo");
+ info!(parent: ::core::option::Option::None, "foo: {}", 3);
+ info!(parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ info!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 78 }, "quux");
+ info!(parent: ::core::option::Option::None, { foo = ?2, bar.baz = %78 }, "quux");
+ info!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ info!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ info!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ info!(target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ info!(target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ info!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo");
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn_root() {
+ warn!(parent: ::core::option::Option::None, foo = ?3, bar.baz = %2, quux = false);
+ warn!(
+ parent: ::core::option::Option::None,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ warn!(parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ warn!(parent: ::core::option::Option::None, "foo");
+ warn!(parent: ::core::option::Option::None, "foo: {}", 3);
+ warn!(parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 78 }, "quux");
+ warn!(parent: ::core::option::Option::None, { foo = ?2, bar.baz = %78 }, "quux");
+ warn!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ warn!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ warn!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ warn!(target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ warn!(target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo");
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error_root() {
+ error!(parent: ::core::option::Option::None, foo = ?3, bar.baz = %2, quux = false);
+ error!(
+ parent: ::core::option::Option::None,
+ foo = 3,
+ bar.baz = 2,
+ quux = false
+ );
+ error!(parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ error!(parent: ::core::option::Option::None, "foo");
+ error!(parent: ::core::option::Option::None, "foo: {}", 3);
+ error!(parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ error!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(parent: ::core::option::Option::None, { foo = 2, bar.baz = 78 }, "quux");
+ error!(parent: ::core::option::Option::None, { foo = ?2, bar.baz = %78 }, "quux");
+ error!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ error!(target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ error!(target: "foo_events", parent: ::core::option::Option::None, "foo");
+ error!(target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ error!(target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ error!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 2, quux = false);
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, foo = 3, bar.baz = 3,);
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo");
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, "foo: {}", 3);
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 3, bar.baz = 80 }, "quux");
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(name: "foo", target: "foo_events", parent: ::core::option::Option::None, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ event!(parent: &p, Level::DEBUG, foo = ?3, bar.baz = %2, quux = false);
+ event!(parent: &p, Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(parent: &p, Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(parent: &p, Level::DEBUG, "foo");
+ event!(parent: &p, Level::DEBUG, "foo: {}", 3);
+ event!(parent: &p, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(parent: &p, Level::DEBUG, { foo = ?2, bar.baz = %78 }, "quux");
+ event!(target: "foo_events", parent: &p, Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(target: "foo_events", parent: &p, Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(target: "foo_events", parent: &p, Level::DEBUG, "foo");
+ event!(target: "foo_events", parent: &p, Level::DEBUG, "foo: {}", 3);
+ event!(target: "foo_events", parent: &p, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 78, }, "quux");
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, foo = 3, bar.baz = 2, quux = false);
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, foo = 3, bar.baz = 3,);
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, "foo");
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, "foo: {}", 3);
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, { foo = 3, bar.baz = 80 }, "quux");
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ event!(name: "foo", target: "foo_events", parent: &p, Level::DEBUG, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn trace_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ trace!(parent: &p, foo = ?3, bar.baz = %2, quux = false);
+ trace!(parent: &p, foo = 3, bar.baz = 2, quux = false);
+ trace!(parent: &p, foo = 3, bar.baz = 3,);
+ trace!(parent: &p, "foo");
+ trace!(parent: &p, "foo: {}", 3);
+ trace!(parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(parent: &p, { foo = 2, bar.baz = 78 }, "quux");
+ trace!(parent: &p, { foo = ?2, bar.baz = %78 }, "quux");
+ trace!(target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ trace!(target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ trace!(target: "foo_events", parent: &p, "foo");
+ trace!(target: "foo_events", parent: &p, "foo: {}", 3);
+ trace!(target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+ trace!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ trace!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ trace!(name: "foo", target: "foo_events", parent: &p, "foo");
+ trace!(name: "foo", target: "foo_events", parent: &p, "foo: {}", 3);
+ trace!(name: "foo", target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ trace!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ trace!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ trace!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ debug!(parent: &p, foo = ?3, bar.baz = %2, quux = false);
+ debug!(parent: &p, foo = 3, bar.baz = 2, quux = false);
+ debug!(parent: &p, foo = 3, bar.baz = 3,);
+ debug!(parent: &p, "foo");
+ debug!(parent: &p, "foo: {}", 3);
+ debug!(parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(parent: &p, { foo = 2, bar.baz = 78 }, "quux");
+ debug!(parent: &p, { foo = ?2, bar.baz = %78 }, "quux");
+ debug!(target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ debug!(target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ debug!(target: "foo_events", parent: &p, "foo");
+ debug!(target: "foo_events", parent: &p, "foo: {}", 3);
+ debug!(target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+ debug!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ debug!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ debug!(name: "foo", target: "foo_events", parent: &p, "foo");
+ debug!(name: "foo", target: "foo_events", parent: &p, "foo: {}", 3);
+ debug!(name: "foo", target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ debug!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ debug!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ debug!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn info_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ info!(parent: &p, foo = ?3, bar.baz = %2, quux = false);
+ info!(parent: &p, foo = 3, bar.baz = 2, quux = false);
+ info!(parent: &p, foo = 3, bar.baz = 3,);
+ info!(parent: &p, "foo");
+ info!(parent: &p, "foo: {}", 3);
+ info!(parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ info!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(parent: &p, { foo = 2, bar.baz = 78 }, "quux");
+ info!(parent: &p, { foo = ?2, bar.baz = %78 }, "quux");
+ info!(target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ info!(target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ info!(target: "foo_events", parent: &p, "foo");
+ info!(target: "foo_events", parent: &p, "foo: {}", 3);
+ info!(target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ info!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+ info!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ info!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ info!(name: "foo", target: "foo_events", parent: &p, "foo");
+ info!(name: "foo", target: "foo_events", parent: &p, "foo: {}", 3);
+ info!(name: "foo", target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ info!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ info!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ info!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn warn_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ warn!(parent: &p, foo = ?3, bar.baz = %2, quux = false);
+ warn!(parent: &p, foo = 3, bar.baz = 2, quux = false);
+ warn!(parent: &p, foo = 3, bar.baz = 3,);
+ warn!(parent: &p, "foo");
+ warn!(parent: &p, "foo: {}", 3);
+ warn!(parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(parent: &p, { foo = 2, bar.baz = 78 }, "quux");
+ warn!(parent: &p, { foo = ?2, bar.baz = %78 }, "quux");
+ warn!(target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ warn!(target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ warn!(target: "foo_events", parent: &p, "foo");
+ warn!(target: "foo_events", parent: &p, "foo: {}", 3);
+ warn!(target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+ warn!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ warn!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ warn!(name: "foo", target: "foo_events", parent: &p, "foo");
+ warn!(name: "foo", target: "foo_events", parent: &p, "foo: {}", 3);
+ warn!(name: "foo", target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ warn!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ warn!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ warn!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn error_with_parent() {
+ let p = span!(Level::TRACE, "im_a_parent!");
+ error!(parent: &p, foo = ?3, bar.baz = %2, quux = false);
+ error!(parent: &p, foo = 3, bar.baz = 2, quux = false);
+ error!(parent: &p, foo = 3, bar.baz = 3,);
+ error!(parent: &p, "foo");
+ error!(parent: &p, "foo: {}", 3);
+ error!(parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ error!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(parent: &p, { foo = 2, bar.baz = 78 }, "quux");
+ error!(parent: &p, { foo = ?2, bar.baz = %78 }, "quux");
+ error!(target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ error!(target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ error!(target: "foo_events", parent: &p, "foo");
+ error!(target: "foo_events", parent: &p, "foo: {}", 3);
+ error!(target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ error!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+ error!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 2, quux = false);
+ error!(name: "foo", target: "foo_events", parent: &p, foo = 3, bar.baz = 3,);
+ error!(name: "foo", target: "foo_events", parent: &p, "foo");
+ error!(name: "foo", target: "foo_events", parent: &p, "foo: {}", 3);
+ error!(name: "foo", target: "foo_events", parent: &p, { foo = 3, bar.baz = 80 }, "quux");
+ error!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}", true);
+ error!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 79 }, "quux {:?}, {quux}", true, quux = false);
+ error!(name: "foo", target: "foo_events", parent: &p, { foo = 2, bar.baz = 78, }, "quux");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn field_shorthand_only() {
+ #[derive(Debug)]
+ struct Position {
+ x: f32,
+ y: f32,
+ }
+ let pos = Position {
+ x: 3.234,
+ y: -1.223,
+ };
+
+ trace!(?pos.x, ?pos.y);
+ debug!(?pos.x, ?pos.y);
+ info!(?pos.x, ?pos.y);
+ warn!(?pos.x, ?pos.y);
+ error!(?pos.x, ?pos.y);
+ event!(Level::TRACE, ?pos.x, ?pos.y);
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn borrow_val_events() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/954
+ let mut foo = (::std::string::String::new(), ::std::string::String::new());
+ let zero = &mut foo.0;
+ trace!(one = ?foo.1);
+ debug!(one = ?foo.1);
+ info!(one = ?foo.1);
+ warn!(one = ?foo.1);
+ error!(one = ?foo.1);
+ zero.push_str("hello world");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn borrow_val_spans() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/954
+ let mut foo = (::std::string::String::new(), ::std::string::String::new());
+ let zero = &mut foo.0;
+ let _span = trace_span!("span", one = ?foo.1);
+ let _span = debug_span!("span", one = ?foo.1);
+ let _span = info_span!("span", one = ?foo.1);
+ let _span = warn_span!("span", one = ?foo.1);
+ let _span = error_span!("span", one = ?foo.1);
+ zero.push_str("hello world");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn callsite_macro_api() {
+ // This test should catch any inadvertent breaking changes
+ // caused by changes to the macro.
+ let _callsite = callsite! {
+ name: "test callsite",
+ kind: tracing::metadata::Kind::EVENT,
+ target: "test target",
+ level: tracing::Level::TRACE,
+ fields: foo, bar,
+ };
+ let _callsite = callsite! {
+ name: "test callsite",
+ kind: tracing::metadata::Kind::SPAN,
+ level: tracing::Level::TRACE,
+ fields: foo,
+ };
+ let _callsite = callsite! {
+ name: "test callsite",
+ kind: tracing::metadata::Kind::SPAN,
+ fields: foo,
+ };
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn format_args_already_defined() {
+ // Reproduces: https://github.com/tokio-rs/tracing/issues/2721
+ #[allow(unused)]
+ macro_rules! format_args {
+ ($i:expr) => {};
+ }
+ event!(Level::DEBUG, "foo: {}", 3);
+ trace!("foo: {}", 3);
+ debug!("foo: {}", 3);
+ info!("foo: {}", 3);
+ warn!("foo: {}", 3);
+ error!("foo: {}", 3);
+}
diff --git a/crates/tracing/tests/macros_incompatible_concat.rs b/crates/tracing/tests/macros_incompatible_concat.rs
new file mode 100644
index 0000000..bda6b96
--- /dev/null
+++ b/crates/tracing/tests/macros_incompatible_concat.rs
@@ -0,0 +1,24 @@
+use tracing::{enabled, event, span, Level};
+
+#[macro_export]
+macro_rules! concat {
+ () => {};
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span() {
+ span!(Level::DEBUG, "foo");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event() {
+ event!(Level::DEBUG, "foo");
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn enabled() {
+ enabled!(Level::DEBUG);
+}
diff --git a/crates/tracing/tests/max_level_hint.rs b/crates/tracing/tests/max_level_hint.rs
new file mode 100644
index 0000000..2e04bc3
--- /dev/null
+++ b/crates/tracing/tests/max_level_hint.rs
@@ -0,0 +1,37 @@
+use tracing::Level;
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn max_level_hints() {
+ // This test asserts that when a subscriber provides us with the global
+ // maximum level that it will enable (by implementing the
+ // `Subscriber::max_level_hint` method), we will never call
+ // `Subscriber::enabled` for events above that maximum level.
+ //
+ // In this case, we test that by making the `enabled` method assert that no
+ // `Metadata` for spans or events at the `TRACE` or `DEBUG` levels.
+ let (subscriber, handle) = subscriber::mock()
+ .with_max_level_hint(Level::INFO)
+ .with_filter(|meta| {
+ assert!(
+ dbg!(meta).level() <= &Level::INFO,
+ "a TRACE or DEBUG event was dynamically filtered: "
+ );
+ true
+ })
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ tracing::subscriber::set_global_default(subscriber).unwrap();
+
+ tracing::info!("doing a thing that you might care about");
+ tracing::debug!("charging turboencabulator with interocitor");
+ tracing::warn!("extremely serious warning, pay attention");
+ tracing::trace!("interocitor charge level is 10%");
+ tracing::error!("everything is on fire");
+ handle.assert_finished();
+}
diff --git a/crates/tracing/tests/multiple_max_level_hints.rs b/crates/tracing/tests/multiple_max_level_hints.rs
new file mode 100644
index 0000000..f78fda7
--- /dev/null
+++ b/crates/tracing/tests/multiple_max_level_hints.rs
@@ -0,0 +1,69 @@
+#![cfg(feature = "std")]
+
+use tracing::Level;
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn multiple_max_level_hints() {
+ // This test ensures that when multiple subscribers are active, their max
+ // level hints are handled correctly. The global max level should be the
+ // maximum of the level filters returned by the two `Subscriber`'s
+ // `max_level_hint` method.
+ //
+ // In this test, we create a subscriber whose max level is `INFO`, and
+ // another whose max level is `DEBUG`. We then add an assertion to both of
+ // those subscribers' `enabled` method that no metadata for `TRACE` spans or
+ // events are filtered, since they are disabled by the global max filter.
+
+ fn do_events() {
+ tracing::info!("doing a thing that you might care about");
+ tracing::debug!("charging turboencabulator with interocitor");
+ tracing::warn!("extremely serious warning, pay attention");
+ tracing::trace!("interocitor charge level is 10%");
+ tracing::error!("everything is on fire");
+ }
+
+ let (subscriber1, handle1) = subscriber::mock()
+ .named("subscriber1")
+ .with_max_level_hint(Level::INFO)
+ .with_filter(|meta| {
+ let level = dbg!(meta.level());
+ assert!(
+ level <= &Level::DEBUG,
+ "a TRACE event was dynamically filtered by subscriber1"
+ );
+ level <= &Level::INFO
+ })
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+ let (subscriber2, handle2) = subscriber::mock()
+ .named("subscriber2")
+ .with_max_level_hint(Level::DEBUG)
+ .with_filter(|meta| {
+ let level = dbg!(meta.level());
+ assert!(
+ level <= &Level::DEBUG,
+ "a TRACE event was dynamically filtered by subscriber2"
+ );
+ level <= &Level::DEBUG
+ })
+ .event(expect::event().at_level(Level::INFO))
+ .event(expect::event().at_level(Level::DEBUG))
+ .event(expect::event().at_level(Level::WARN))
+ .event(expect::event().at_level(Level::ERROR))
+ .only()
+ .run_with_handle();
+
+ let dispatch1 = tracing::Dispatch::new(subscriber1);
+
+ tracing::dispatcher::with_default(&dispatch1, do_events);
+ handle1.assert_finished();
+
+ let dispatch2 = tracing::Dispatch::new(subscriber2);
+ tracing::dispatcher::with_default(&dispatch2, do_events);
+ handle2.assert_finished();
+}
diff --git a/crates/tracing/tests/no_subscriber.rs b/crates/tracing/tests/no_subscriber.rs
new file mode 100644
index 0000000..d15a2c8
--- /dev/null
+++ b/crates/tracing/tests/no_subscriber.rs
@@ -0,0 +1,16 @@
+#![cfg(feature = "std")]
+
+use tracing_mock::subscriber;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn no_subscriber_disables_global() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/1999
+ let (subscriber, handle) = subscriber::mock().only().run_with_handle();
+ tracing::subscriber::set_global_default(subscriber)
+ .expect("setting global default must succeed");
+ tracing::subscriber::with_default(tracing::subscriber::NoSubscriber::default(), || {
+ tracing::info!("this should not be recorded");
+ });
+ handle.assert_finished();
+}
diff --git a/crates/tracing/tests/register_callsite_deadlock.rs b/crates/tracing/tests/register_callsite_deadlock.rs
new file mode 100644
index 0000000..e4c116c
--- /dev/null
+++ b/crates/tracing/tests/register_callsite_deadlock.rs
@@ -0,0 +1,47 @@
+use std::{sync::mpsc, thread, time::Duration};
+use tracing::{
+ metadata::Metadata,
+ span,
+ subscriber::{self, Interest, Subscriber},
+ Event,
+};
+
+#[test]
+fn register_callsite_doesnt_deadlock() {
+ pub struct EvilSubscriber;
+
+ impl Subscriber for EvilSubscriber {
+ fn register_callsite(&self, meta: &'static Metadata<'static>) -> Interest {
+ tracing::info!(?meta, "registered a callsite");
+ Interest::always()
+ }
+
+ fn enabled(&self, _: &Metadata<'_>) -> bool {
+ true
+ }
+ fn new_span(&self, _: &span::Attributes<'_>) -> span::Id {
+ span::Id::from_u64(1)
+ }
+ fn record(&self, _: &span::Id, _: &span::Record<'_>) {}
+ fn record_follows_from(&self, _: &span::Id, _: &span::Id) {}
+ fn event(&self, _: &Event<'_>) {}
+ fn enter(&self, _: &span::Id) {}
+ fn exit(&self, _: &span::Id) {}
+ }
+
+ subscriber::set_global_default(EvilSubscriber).unwrap();
+
+ // spawn a thread, and assert it doesn't hang...
+ let (tx, didnt_hang) = mpsc::channel();
+ let th = thread::spawn(move || {
+ tracing::info!("hello world!");
+ tx.send(()).unwrap();
+ });
+
+ didnt_hang
+ // Note: 60 seconds is *way* more than enough, but let's be generous in
+ // case of e.g. slow CI machines.
+ .recv_timeout(Duration::from_secs(60))
+ .expect("the thread must not have hung!");
+ th.join().expect("thread should join successfully");
+}
diff --git a/crates/tracing/tests/scoped_clobbers_default.rs b/crates/tracing/tests/scoped_clobbers_default.rs
new file mode 100644
index 0000000..dfd6fc9
--- /dev/null
+++ b/crates/tracing/tests/scoped_clobbers_default.rs
@@ -0,0 +1,35 @@
+#![cfg(feature = "std")]
+use tracing_mock::*;
+
+#[test]
+fn scoped_clobbers_global() {
+ // Reproduces https://github.com/tokio-rs/tracing/issues/2050
+
+ let (scoped, scoped_handle) = subscriber::mock()
+ .event(event::msg("before global"))
+ .event(event::msg("before drop"))
+ .only()
+ .run_with_handle();
+
+ let (global, global_handle) = subscriber::mock()
+ .event(event::msg("after drop"))
+ .only()
+ .run_with_handle();
+
+ // Set a scoped default subscriber, returning a guard.
+ let guard = tracing::subscriber::set_default(scoped);
+ tracing::info!("before global");
+
+ // Now, set the global default.
+ tracing::subscriber::set_global_default(global)
+ .expect("global default should not already be set");
+ // This event should still be collected by the scoped default.
+ tracing::info!("before drop");
+
+ // Drop the guard. Now, the global default subscriber should be used.
+ drop(guard);
+ tracing::info!("after drop");
+
+ scoped_handle.assert_finished();
+ global_handle.assert_finished();
+}
diff --git a/crates/tracing/tests/span.rs b/crates/tracing/tests/span.rs
new file mode 100644
index 0000000..09f1be8
--- /dev/null
+++ b/crates/tracing/tests/span.rs
@@ -0,0 +1,868 @@
+// These tests require the thread-local scoped dispatcher, which only works when
+// we have a standard library. The behaviour being tested should be the same
+// with the standard lib disabled.
+#![cfg(feature = "std")]
+
+use std::thread;
+
+use tracing::{
+ field::{debug, display},
+ subscriber::with_default,
+ Level, Span,
+};
+use tracing_mock::*;
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn handles_to_the_same_span_are_equal() {
+ // Create a mock subscriber that will return `true` on calls to
+ // `Subscriber::enabled`, so that the spans will be constructed. We
+ // won't enter any spans in this test, so the subscriber won't actually
+ // expect to see any spans.
+ with_default(subscriber::mock().run(), || {
+ let foo1 = tracing::span!(Level::TRACE, "foo");
+
+ // The purpose of this test is to assert that two clones of the same
+ // span are equal, so the clone here is kind of the whole point :)
+ #[allow(clippy::redundant_clone)]
+ let foo2 = foo1.clone();
+
+ // Two handles that point to the same span are equal.
+ assert_eq!(foo1, foo2);
+ });
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn handles_to_different_spans_are_not_equal() {
+ with_default(subscriber::mock().run(), || {
+ // Even though these spans have the same name and fields, they will have
+ // differing metadata, since they were created on different lines.
+ let foo1 = tracing::span!(Level::TRACE, "foo", bar = 1u64, baz = false);
+ let foo2 = tracing::span!(Level::TRACE, "foo", bar = 1u64, baz = false);
+
+ assert_ne!(foo1, foo2);
+ });
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn handles_to_different_spans_with_the_same_metadata_are_not_equal() {
+ // Every time time this function is called, it will return a _new
+ // instance_ of a span with the same metadata, name, and fields.
+ fn make_span() -> Span {
+ tracing::span!(Level::TRACE, "foo", bar = 1u64, baz = false)
+ }
+
+ with_default(subscriber::mock().run(), || {
+ let foo1 = make_span();
+ let foo2 = make_span();
+
+ assert_ne!(foo1, foo2);
+ // assert_ne!(foo1.data(), foo2.data());
+ });
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn spans_always_go_to_the_subscriber_that_tagged_them() {
+ let subscriber1 = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run();
+ let subscriber2 = subscriber::mock().run();
+
+ let foo = with_default(subscriber1, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ foo.in_scope(|| {});
+ foo
+ });
+ // Even though we enter subscriber 2's context, the subscriber that
+ // tagged the span should see the enter/exit.
+ with_default(subscriber2, move || foo.in_scope(|| {}));
+}
+
+// This gets exempt from testing in wasm because of: `thread::spawn` which is
+// not yet possible to do in WASM. There is work going on see:
+// <https://rustwasm.github.io/2018/10/24/multithreading-rust-and-wasm.html>
+//
+// But for now since it's not possible we don't need to test for it :)
+#[test]
+fn spans_always_go_to_the_subscriber_that_tagged_them_even_across_threads() {
+ let subscriber1 = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run();
+ let foo = with_default(subscriber1, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ foo.in_scope(|| {});
+ foo
+ });
+
+ // Even though we enter subscriber 2's context, the subscriber that
+ // tagged the span should see the enter/exit.
+ thread::spawn(move || {
+ with_default(subscriber::mock().run(), || {
+ foo.in_scope(|| {});
+ })
+ })
+ .join()
+ .unwrap();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn dropping_a_span_calls_drop_span() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo");
+ span.in_scope(|| {});
+ drop(span);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_closes_after_event() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event())
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo").in_scope(|| {
+ tracing::event!(Level::DEBUG, {}, "my tracing::event!");
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn new_span_after_event() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event())
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .enter(expect::span().named("bar"))
+ .exit(expect::span().named("bar"))
+ .drop_span(expect::span().named("bar"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo").in_scope(|| {
+ tracing::event!(Level::DEBUG, {}, "my tracing::event!");
+ });
+ tracing::span!(Level::TRACE, "bar").in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_outside_of_span() {
+ let (subscriber, handle) = subscriber::mock()
+ .event(expect::event())
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::debug!("my tracing::event!");
+ tracing::span!(Level::TRACE, "foo").in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn cloning_a_span_calls_clone_span() {
+ let (subscriber, handle) = subscriber::mock()
+ .clone_span(expect::span().named("foo"))
+ .run_with_handle();
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo");
+ // Allow the "redundant" `.clone` since it is used to call into the `.clone_span` hook.
+ #[allow(clippy::redundant_clone)]
+ let _span2 = span.clone();
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn drop_span_when_exiting_dispatchers_context() {
+ let (subscriber, handle) = subscriber::mock()
+ .clone_span(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .run_with_handle();
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo");
+ let _span2 = span.clone();
+ drop(span);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn clone_and_drop_span_always_go_to_the_subscriber_that_tagged_the_span() {
+ let (subscriber1, handle1) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .clone_span(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .run_with_handle();
+ let subscriber2 = subscriber::mock().only().run();
+
+ let foo = with_default(subscriber1, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ foo.in_scope(|| {});
+ foo
+ });
+ // Even though we enter subscriber 2's context, the subscriber that
+ // tagged the span should see the enter/exit.
+ with_default(subscriber2, move || {
+ let foo2 = foo.clone();
+ foo.in_scope(|| {});
+ drop(foo);
+ drop(foo2);
+ });
+
+ handle1.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn span_closes_when_exited() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+
+ foo.in_scope(|| {});
+
+ drop(foo);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn enter() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event())
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ let _enter = foo.enter();
+ tracing::debug!("dropping guard...");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn entered() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event())
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let _span = tracing::span!(Level::TRACE, "foo").entered();
+ tracing::debug!("dropping guard...");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn entered_api() {
+ let (subscriber, handle) = subscriber::mock()
+ .enter(expect::span().named("foo"))
+ .event(expect::event())
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo").entered();
+ let _derefs_to_span = span.id();
+ tracing::debug!("exiting span...");
+ let _: Span = span.exit();
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn moved_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&display("hello from my span"))
+ .only(),
+ ),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ let from = "my span";
+ let span = tracing::span!(
+ Level::TRACE,
+ "foo",
+ bar = display(format!("hello from {}", from))
+ );
+ span.in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn dotted_field_name() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .with_field(expect::field("fields.bar").with_value(&true).only()),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo", fields.bar = true);
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn borrowed_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&display("hello from my span"))
+ .only(),
+ ),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let from = "my span";
+ let mut message = format!("hello from {}", from);
+ let span = tracing::span!(Level::TRACE, "foo", bar = display(&message));
+ span.in_scope(|| {
+ message.insert_str(10, " inside");
+ });
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+// If emitting log instrumentation, this gets moved anyway, breaking the test.
+#[cfg(not(feature = "log"))]
+fn move_field_out_of_struct() {
+ use tracing::field::debug;
+
+ #[derive(Debug)]
+ struct Position {
+ x: f32,
+ y: f32,
+ }
+
+ let pos = Position {
+ x: 3.234,
+ y: -1.223,
+ };
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("x")
+ .with_value(&debug(3.234))
+ .and(expect::field("y").with_value(&debug(-1.223)))
+ .only(),
+ ),
+ )
+ .new_span(
+ expect::span()
+ .named("bar")
+ .with_field(expect::field("position").with_value(&debug(&pos)).only()),
+ )
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let pos = Position {
+ x: 3.234,
+ y: -1.223,
+ };
+ let foo = tracing::span!(Level::TRACE, "foo", x = debug(pos.x), y = debug(pos.y));
+ let bar = tracing::span!(Level::TRACE, "bar", position = debug(pos));
+ foo.in_scope(|| {});
+ bar.in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn float_values() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("x")
+ .with_value(&3.234)
+ .and(expect::field("y").with_value(&-1.223))
+ .only(),
+ ),
+ )
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo", x = 3.234, y = -1.223);
+ foo.in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+// TODO(#1138): determine a new syntax for uninitialized span fields, and
+// re-enable these.
+/*
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn add_field_after_new_span() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .with_field(expect::field("bar").with_value(&5)
+ .and(expect::field("baz").with_value).only()),
+ )
+ .record(
+ expect::span().named("foo"),
+ field::expect("baz").with_value(&true).only(),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo", bar = 5, baz = false);
+ span.record("baz", &true);
+ span.in_scope(|| {})
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn add_fields_only_after_new_span() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .record(
+ expect::span().named("foo"),
+ field::expect("bar").with_value(&5).only(),
+ )
+ .record(
+ expect::span().named("foo"),
+ field::expect("baz").with_value(&true).only(),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo", bar = _, baz = _);
+ span.record("bar", &5);
+ span.record("baz", &true);
+ span.in_scope(|| {})
+ });
+
+ handle.assert_finished();
+}
+*/
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn record_new_value_for_field() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&5)
+ .and(expect::field("baz").with_value(&false))
+ .only(),
+ ),
+ )
+ .record(
+ expect::span().named("foo"),
+ expect::field("baz").with_value(&true).only(),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo", bar = 5, baz = false);
+ span.record("baz", true);
+ span.in_scope(|| {})
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn record_new_values_for_fields() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&4)
+ .and(expect::field("baz").with_value(&false))
+ .only(),
+ ),
+ )
+ .record(
+ expect::span().named("foo"),
+ expect::field("bar").with_value(&5).only(),
+ )
+ .record(
+ expect::span().named("foo"),
+ expect::field("baz").with_value(&true).only(),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let span = tracing::span!(Level::TRACE, "foo", bar = 4, baz = false);
+ span.record("bar", 5);
+ span.record("baz", true);
+ span.in_scope(|| {})
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn new_span_with_target_and_log_level() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span()
+ .named("foo")
+ .with_target("app_span")
+ .at_level(Level::DEBUG),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(target: "app_span", Level::DEBUG, "foo");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_root_span_is_root() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo").with_explicit_parent(None))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(parent: None, Level::TRACE, "foo");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_root_span_is_root_regardless_of_ctx() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .new_span(expect::span().named("bar").with_explicit_parent(None))
+ .exit(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo").in_scope(|| {
+ tracing::span!(parent: None, Level::TRACE, "bar");
+ })
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_child() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .new_span(
+ expect::span()
+ .named("bar")
+ .with_explicit_parent(Some("foo")),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ tracing::span!(parent: foo.id(), Level::TRACE, "bar");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_child_at_levels() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .new_span(expect::span().named("a").with_explicit_parent(Some("foo")))
+ .new_span(expect::span().named("b").with_explicit_parent(Some("foo")))
+ .new_span(expect::span().named("c").with_explicit_parent(Some("foo")))
+ .new_span(expect::span().named("d").with_explicit_parent(Some("foo")))
+ .new_span(expect::span().named("e").with_explicit_parent(Some("foo")))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ tracing::trace_span!(parent: foo.id(), "a");
+ tracing::debug_span!(parent: foo.id(), "b");
+ tracing::info_span!(parent: foo.id(), "c");
+ tracing::warn_span!(parent: foo.id(), "d");
+ tracing::error_span!(parent: foo.id(), "e");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn explicit_child_regardless_of_ctx() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .new_span(expect::span().named("bar"))
+ .enter(expect::span().named("bar"))
+ .new_span(
+ expect::span()
+ .named("baz")
+ .with_explicit_parent(Some("foo")),
+ )
+ .exit(expect::span().named("bar"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ let foo = tracing::span!(Level::TRACE, "foo");
+ tracing::span!(Level::TRACE, "bar")
+ .in_scope(|| tracing::span!(parent: foo.id(), Level::TRACE, "baz"))
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn contextual_root() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo").with_contextual_parent(None))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn contextual_child() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(expect::span().named("foo"))
+ .enter(expect::span().named("foo"))
+ .new_span(
+ expect::span()
+ .named("bar")
+ .with_contextual_parent(Some("foo")),
+ )
+ .exit(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "foo").in_scope(|| {
+ tracing::span!(Level::TRACE, "bar");
+ })
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn display_shorthand() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("my_span").with_field(
+ expect::field("my_field")
+ .with_value(&display("hello world"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "my_span", my_field = %"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn debug_shorthand() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("my_span").with_field(
+ expect::field("my_field")
+ .with_value(&debug("hello world"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "my_span", my_field = ?"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn both_shorthands() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("my_span").with_field(
+ expect::field("display_field")
+ .with_value(&display("hello world"))
+ .and(expect::field("debug_field").with_value(&debug("hello world")))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+ with_default(subscriber, || {
+ tracing::span!(Level::TRACE, "my_span", display_field = %"hello world", debug_field = ?"hello world");
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn constant_field_name() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("my_span").with_field(
+ expect::field("foo")
+ .with_value(&"bar")
+ .and(expect::field("constant string").with_value(&"also works"))
+ .and(expect::field("foo.bar").with_value(&"baz"))
+ .only(),
+ ),
+ )
+ .only()
+ .run_with_handle();
+
+ with_default(subscriber, || {
+ const FOO: &str = "foo";
+ tracing::span!(
+ Level::TRACE,
+ "my_span",
+ { std::convert::identity(FOO) } = "bar",
+ { "constant string" } = "also works",
+ foo.bar = "baz",
+ );
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/tracing/tests/subscriber.rs b/crates/tracing/tests/subscriber.rs
new file mode 100644
index 0000000..f676efe
--- /dev/null
+++ b/crates/tracing/tests/subscriber.rs
@@ -0,0 +1,129 @@
+// These tests require the thread-local scoped dispatcher, which only works when
+// we have a standard library. The behaviour being tested should be the same
+// with the standard lib disabled.
+//
+// The alternative would be for each of these tests to be defined in a separate
+// file, which is :(
+#![cfg(feature = "std")]
+use tracing::{
+ field::display,
+ span::{Attributes, Id, Record},
+ subscriber::{with_default, Interest, Subscriber},
+ Event, Level, Metadata,
+};
+use tracing_mock::{expect, subscriber};
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn event_macros_dont_infinite_loop() {
+ // This test ensures that an event macro within a subscriber
+ // won't cause an infinite loop of events.
+ struct TestSubscriber;
+ impl Subscriber for TestSubscriber {
+ fn register_callsite(&self, _: &Metadata<'_>) -> Interest {
+ // Always return sometimes so that `enabled` will be called
+ // (which can loop).
+ Interest::sometimes()
+ }
+
+ fn enabled(&self, meta: &Metadata<'_>) -> bool {
+ assert!(meta.fields().iter().any(|f| f.name() == "foo"));
+ tracing::event!(Level::TRACE, bar = false);
+ true
+ }
+
+ fn new_span(&self, _: &Attributes<'_>) -> Id {
+ Id::from_u64(0xAAAA)
+ }
+
+ fn record(&self, _: &Id, _: &Record<'_>) {}
+
+ fn record_follows_from(&self, _: &Id, _: &Id) {}
+
+ fn event(&self, event: &Event<'_>) {
+ assert!(event.metadata().fields().iter().any(|f| f.name() == "foo"));
+ tracing::event!(Level::TRACE, baz = false);
+ }
+
+ fn enter(&self, _: &Id) {}
+
+ fn exit(&self, _: &Id) {}
+ }
+
+ with_default(TestSubscriber, || {
+ tracing::event!(Level::TRACE, foo = false);
+ })
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn boxed_subscriber() {
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&display("hello from my span"))
+ .only(),
+ ),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .only()
+ .run_with_handle();
+ let subscriber: Box<dyn Subscriber + Send + Sync + 'static> = Box::new(subscriber);
+
+ with_default(subscriber, || {
+ let from = "my span";
+ let span = tracing::span!(
+ Level::TRACE,
+ "foo",
+ bar = format_args!("hello from {}", from)
+ );
+ span.in_scope(|| {});
+ });
+
+ handle.assert_finished();
+}
+
+#[cfg_attr(target_arch = "wasm32", wasm_bindgen_test::wasm_bindgen_test)]
+#[test]
+fn arced_subscriber() {
+ use std::sync::Arc;
+
+ let (subscriber, handle) = subscriber::mock()
+ .new_span(
+ expect::span().named("foo").with_field(
+ expect::field("bar")
+ .with_value(&display("hello from my span"))
+ .only(),
+ ),
+ )
+ .enter(expect::span().named("foo"))
+ .exit(expect::span().named("foo"))
+ .drop_span(expect::span().named("foo"))
+ .event(
+ expect::event()
+ .with_fields(expect::field("message").with_value(&display("hello from my event"))),
+ )
+ .only()
+ .run_with_handle();
+ let subscriber: Arc<dyn Subscriber + Send + Sync + 'static> = Arc::new(subscriber);
+
+ // Test using a clone of the `Arc`ed subscriber
+ with_default(subscriber.clone(), || {
+ let from = "my span";
+ let span = tracing::span!(
+ Level::TRACE,
+ "foo",
+ bar = format_args!("hello from {}", from)
+ );
+ span.in_scope(|| {});
+ });
+
+ with_default(subscriber, || {
+ tracing::info!("hello from my event");
+ });
+
+ handle.assert_finished();
+}
diff --git a/crates/try-lock/.cargo-checksum.json b/crates/try-lock/.cargo-checksum.json
new file mode 100644
index 0000000..80ab156
--- /dev/null
+++ b/crates/try-lock/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"b929e378a4dd54a76870264bb0b25d059c8a12ec1dda78a8017d7dbba96260fc","LICENSE":"c816a0749cdc6bf062a5111c159723de51b2bfac66a1dac2655abd9e6b1583eb","README.md":"976bf116dd8794213bd242a61f819811a5c5a0fd4372acdbd21308863c05cfb6","src/lib.rs":"4f8e19b938527c5543e3180901a11ec31f8933d5ac918790456d2f4027a12f6f"},"package":"e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b"}
\ No newline at end of file
diff --git a/crates/try-lock/Android.bp b/crates/try-lock/Android.bp
new file mode 100644
index 0000000..0167ec5
--- /dev/null
+++ b/crates/try-lock/Android.bp
@@ -0,0 +1,45 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_try-lock_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_try-lock_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtry_lock",
+ host_supported: true,
+ crate_name: "try_lock",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.5",
+ crate_root: "src/lib.rs",
+ edition: "2015",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "try-lock_test_src_lib",
+ host_supported: true,
+ crate_name: "try_lock",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.5",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2015",
+}
diff --git a/crates/try-lock/Cargo.toml b/crates/try-lock/Cargo.toml
new file mode 100644
index 0000000..ef2f8dd
--- /dev/null
+++ b/crates/try-lock/Cargo.toml
@@ -0,0 +1,31 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+name = "try-lock"
+version = "0.2.5"
+authors = ["Sean McArthur <[email protected]>"]
+description = "A lightweight atomic lock."
+homepage = "https://github.com/seanmonstar/try-lock"
+documentation = "https://docs.rs/try-lock"
+readme = "README.md"
+keywords = [
+ "lock",
+ "atomic",
+]
+categories = [
+ "concurrency",
+ "no-std",
+]
+license = "MIT"
+repository = "https://github.com/seanmonstar/try-lock"
+
+[dependencies]
diff --git a/crates/try-lock/LICENSE b/crates/try-lock/LICENSE
new file mode 100644
index 0000000..ef65989
--- /dev/null
+++ b/crates/try-lock/LICENSE
@@ -0,0 +1,21 @@
+Copyright (c) 2018-2023 Sean McArthur
+Copyright (c) 2016 Alex Crichton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
diff --git a/crates/try-lock/METADATA b/crates/try-lock/METADATA
new file mode 100644
index 0000000..e0c7b76
--- /dev/null
+++ b/crates/try-lock/METADATA
@@ -0,0 +1,20 @@
+name: "try-lock"
+description: "A lightweight atomic lock."
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "try-lock"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/try-lock/try-lock-0.2.5.crate"
+ primary_source: true
+ }
+ version: "0.2.5"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 5
+ day: 27
+ }
+}
diff --git a/crates/try-lock/MODULE_LICENSE_MIT b/crates/try-lock/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/try-lock/MODULE_LICENSE_MIT
diff --git a/crates/try-lock/README.md b/crates/try-lock/README.md
new file mode 100644
index 0000000..abbb0ea
--- /dev/null
+++ b/crates/try-lock/README.md
@@ -0,0 +1,44 @@
+# TryLock
+
+- [Crates.io](https://crates.io/crates/try-lock)
+- [Docs](https://docs.rs/try-lock)
+
+A light-weight lock guarded by an atomic boolean.
+
+Most efficient when contention is low, acquiring the lock is a single atomic swap, and releasing it just 1 more atomic swap.
+
+## Example
+
+```rust
+use std::sync::Arc;
+use try_lock::TryLock;
+
+// a thing we want to share
+struct Widget {
+ name: String,
+}
+
+// lock it up!
+let widget1 = Arc::new(TryLock::new(Widget {
+ name: "Spanner".into(),
+}));
+
+let widget2 = widget1.clone();
+
+
+// mutate the widget
+let mut locked = widget1.try_lock().expect("example isn't locked yet");
+locked.name.push_str(" Bundle");
+
+// hands off, buddy
+let not_locked = widget2.try_lock();
+assert!(not_locked.is_none(), "widget1 has the lock");
+
+// ok, you can have it
+drop(locked);
+
+let locked2 = widget2.try_lock().expect("widget1 lock is released");
+
+assert_eq!(locked2.name, "Spanner Bundle");
+```
+
diff --git a/crates/try-lock/cargo_embargo.json b/crates/try-lock/cargo_embargo.json
new file mode 100644
index 0000000..c8842d1
--- /dev/null
+++ b/crates/try-lock/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/try-lock/patches/std.diff b/crates/try-lock/patches/std.diff
new file mode 100644
index 0000000..ed76c3e
--- /dev/null
+++ b/crates/try-lock/patches/std.diff
@@ -0,0 +1,24 @@
+diff --git a/src/lib.rs b/src/lib.rs
+index 2811996..4faa975 100644
+--- a/src/lib.rs
++++ b/src/lib.rs
+@@ -1,7 +1,8 @@
+ #![deny(missing_docs)]
+ #![deny(missing_debug_implementations)]
+ #![deny(warnings)]
+-#![cfg_attr(not(test), no_std)]
++// ANDROID: Use std to allow building as a dylib.
++#![cfg_attr(not(any(test, android_dylib)), no_std)]
+
+ //! A light-weight lock guarded by an atomic boolean.
+ //!
+@@ -43,7 +44,8 @@
+ //! assert_eq!(locked2.name, "Spanner Bundle");
+ //! ```
+
+-#[cfg(test)]
++// ANDROID: Use std to allow building as a dylib.
++#[cfg(any(test, android_dylib))]
+ extern crate core;
+
+ use core::cell::UnsafeCell;
diff --git a/crates/try-lock/src/lib.rs b/crates/try-lock/src/lib.rs
new file mode 100644
index 0000000..4faa975
--- /dev/null
+++ b/crates/try-lock/src/lib.rs
@@ -0,0 +1,268 @@
+#![deny(missing_docs)]
+#![deny(missing_debug_implementations)]
+#![deny(warnings)]
+// ANDROID: Use std to allow building as a dylib.
+#![cfg_attr(not(any(test, android_dylib)), no_std)]
+
+//! A light-weight lock guarded by an atomic boolean.
+//!
+//! Most efficient when contention is low, acquiring the lock is a single
+//! atomic swap, and releasing it just 1 more atomic swap.
+//!
+//! # Example
+//!
+//! ```
+//! use std::sync::Arc;
+//! use try_lock::TryLock;
+//!
+//! // a thing we want to share
+//! struct Widget {
+//! name: String,
+//! }
+//!
+//! // lock it up!
+//! let widget1 = Arc::new(TryLock::new(Widget {
+//! name: "Spanner".into(),
+//! }));
+//!
+//! let widget2 = widget1.clone();
+//!
+//!
+//! // mutate the widget
+//! let mut locked = widget1.try_lock().expect("example isn't locked yet");
+//! locked.name.push_str(" Bundle");
+//!
+//! // hands off, buddy
+//! let not_locked = widget2.try_lock();
+//! assert!(not_locked.is_none(), "widget1 has the lock");
+//!
+//! // ok, you can have it
+//! drop(locked);
+//!
+//! let locked2 = widget2.try_lock().expect("widget1 lock is released");
+//!
+//! assert_eq!(locked2.name, "Spanner Bundle");
+//! ```
+
+// ANDROID: Use std to allow building as a dylib.
+#[cfg(any(test, android_dylib))]
+extern crate core;
+
+use core::cell::UnsafeCell;
+use core::fmt;
+use core::ops::{Deref, DerefMut};
+use core::sync::atomic::{AtomicBool, Ordering};
+use core::marker::PhantomData;
+
+/// A light-weight lock guarded by an atomic boolean.
+///
+/// Most efficient when contention is low, acquiring the lock is a single
+/// atomic swap, and releasing it just 1 more atomic swap.
+///
+/// It is only possible to try to acquire the lock, it is not possible to
+/// wait for the lock to become ready, like with a `Mutex`.
+#[derive(Default)]
+pub struct TryLock<T> {
+ is_locked: AtomicBool,
+ value: UnsafeCell<T>,
+}
+
+impl<T> TryLock<T> {
+ /// Create a `TryLock` around the value.
+ #[inline]
+ pub const fn new(val: T) -> TryLock<T> {
+ TryLock {
+ is_locked: AtomicBool::new(false),
+ value: UnsafeCell::new(val),
+ }
+ }
+
+ /// Try to acquire the lock of this value.
+ ///
+ /// If the lock is already acquired by someone else, this returns
+ /// `None`. You can try to acquire again whenever you want, perhaps
+ /// by spinning a few times, or by using some other means of
+ /// notification.
+ ///
+ /// # Note
+ ///
+ /// The default memory ordering is to use `Acquire` to lock, and `Release`
+ /// to unlock. If different ordering is required, use
+ /// [`try_lock_explicit`](TryLock::try_lock_explicit) or
+ /// [`try_lock_explicit_unchecked`](TryLock::try_lock_explicit_unchecked).
+ #[inline]
+ pub fn try_lock(&self) -> Option<Locked<T>> {
+ unsafe {
+ self.try_lock_explicit_unchecked(Ordering::Acquire, Ordering::Release)
+ }
+ }
+
+ /// Try to acquire the lock of this value using the lock and unlock orderings.
+ ///
+ /// If the lock is already acquired by someone else, this returns
+ /// `None`. You can try to acquire again whenever you want, perhaps
+ /// by spinning a few times, or by using some other means of
+ /// notification.
+ #[inline]
+ #[deprecated(
+ since = "0.2.3",
+ note = "This method is actually unsafe because it unsafely allows \
+ the use of weaker memory ordering. Please use try_lock_explicit instead"
+ )]
+ pub fn try_lock_order(&self, lock_order: Ordering, unlock_order: Ordering) -> Option<Locked<T>> {
+ unsafe {
+ self.try_lock_explicit_unchecked(lock_order, unlock_order)
+ }
+ }
+
+ /// Try to acquire the lock of this value using the specified lock and
+ /// unlock orderings.
+ ///
+ /// If the lock is already acquired by someone else, this returns
+ /// `None`. You can try to acquire again whenever you want, perhaps
+ /// by spinning a few times, or by using some other means of
+ /// notification.
+ ///
+ /// # Panic
+ ///
+ /// This method panics if `lock_order` is not any of `Acquire`, `AcqRel`,
+ /// and `SeqCst`, or `unlock_order` is not any of `Release` and `SeqCst`.
+ #[inline]
+ pub fn try_lock_explicit(&self, lock_order: Ordering, unlock_order: Ordering) -> Option<Locked<T>> {
+ match lock_order {
+ Ordering::Acquire |
+ Ordering::AcqRel |
+ Ordering::SeqCst => {}
+ _ => panic!("lock ordering must be `Acquire`, `AcqRel`, or `SeqCst`"),
+ }
+
+ match unlock_order {
+ Ordering::Release |
+ Ordering::SeqCst => {}
+ _ => panic!("unlock ordering must be `Release` or `SeqCst`"),
+ }
+
+ unsafe {
+ self.try_lock_explicit_unchecked(lock_order, unlock_order)
+ }
+ }
+
+ /// Try to acquire the lock of this value using the specified lock and
+ /// unlock orderings without checking that the specified orderings are
+ /// strong enough to be safe.
+ ///
+ /// If the lock is already acquired by someone else, this returns
+ /// `None`. You can try to acquire again whenever you want, perhaps
+ /// by spinning a few times, or by using some other means of
+ /// notification.
+ ///
+ /// # Safety
+ ///
+ /// Unlike [`try_lock_explicit`], this method is unsafe because it does not
+ /// check that the given memory orderings are strong enough to prevent data
+ /// race.
+ ///
+ /// [`try_lock_explicit`]: Self::try_lock_explicit
+ #[inline]
+ pub unsafe fn try_lock_explicit_unchecked(&self, lock_order: Ordering, unlock_order: Ordering) -> Option<Locked<T>> {
+ if !self.is_locked.swap(true, lock_order) {
+ Some(Locked {
+ lock: self,
+ order: unlock_order,
+ _p: PhantomData,
+ })
+ } else {
+ None
+ }
+ }
+
+ /// Take the value back out of the lock when this is the sole owner.
+ #[inline]
+ pub fn into_inner(self) -> T {
+ debug_assert!(!self.is_locked.load(Ordering::Relaxed), "TryLock was mem::forgotten");
+ self.value.into_inner()
+ }
+}
+
+unsafe impl<T: Send> Send for TryLock<T> {}
+unsafe impl<T: Send> Sync for TryLock<T> {}
+
+impl<T: fmt::Debug> fmt::Debug for TryLock<T> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+
+ // Used if the TryLock cannot acquire the lock.
+ struct LockedPlaceholder;
+
+ impl fmt::Debug for LockedPlaceholder {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ f.write_str("<locked>")
+ }
+ }
+
+ let mut builder = f.debug_struct("TryLock");
+ if let Some(locked) = self.try_lock() {
+ builder.field("value", &*locked);
+ } else {
+ builder.field("value", &LockedPlaceholder);
+ }
+ builder.finish()
+ }
+}
+
+/// A locked value acquired from a `TryLock`.
+///
+/// The type represents an exclusive view at the underlying value. The lock is
+/// released when this type is dropped.
+///
+/// This type derefs to the underlying value.
+#[must_use = "TryLock will immediately unlock if not used"]
+pub struct Locked<'a, T: 'a> {
+ lock: &'a TryLock<T>,
+ order: Ordering,
+ /// Suppresses Send and Sync autotraits for `struct Locked`.
+ _p: PhantomData<*mut T>,
+}
+
+impl<'a, T> Deref for Locked<'a, T> {
+ type Target = T;
+ #[inline]
+ fn deref(&self) -> &T {
+ unsafe { &*self.lock.value.get() }
+ }
+}
+
+impl<'a, T> DerefMut for Locked<'a, T> {
+ #[inline]
+ fn deref_mut(&mut self) -> &mut T {
+ unsafe { &mut *self.lock.value.get() }
+ }
+}
+
+impl<'a, T> Drop for Locked<'a, T> {
+ #[inline]
+ fn drop(&mut self) {
+ self.lock.is_locked.store(false, self.order);
+ }
+}
+
+impl<'a, T: fmt::Debug> fmt::Debug for Locked<'a, T> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ fmt::Debug::fmt(&**self, f)
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::TryLock;
+
+ #[test]
+ fn fmt_debug() {
+ let lock = TryLock::new(5);
+ assert_eq!(format!("{:?}", lock), "TryLock { value: 5 }");
+
+ let locked = lock.try_lock().unwrap();
+ assert_eq!(format!("{:?}", locked), "5");
+
+ assert_eq!(format!("{:?}", lock), "TryLock { value: <locked> }");
+ }
+}
diff --git a/crates/tungstenite/.cargo-checksum.json b/crates/tungstenite/.cargo-checksum.json
new file mode 100644
index 0000000..9c9ac07
--- /dev/null
+++ b/crates/tungstenite/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"983d5f14ef39ef3662e843dc9b6411c176a8d085c15c35740d043c7bb47dee0f","Cargo.lock":"4a39b4dc027e931a05182eb15728e3c1ccb12a7790325ece5470da88b38428b8","Cargo.toml":"58aa0d3b733e4bf0232c5bddf3d79988037359c4b2eae4875d16657a2492fd29","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"7fea0ee51a4ca5d5cea7464135fd55e8b09caf3a61da3d451ac8a22af95c033f","README.md":"0a8b44c900be104faf8bb8d24e419ca1569e32d7bfae4f1528bc27f9f01d4b33","benches/buffer.rs":"615d66b4e5d5f11758aa111f2c3274e82dba5afeca3863bf39138d906c67344c","benches/write.rs":"921c72b4f1b219873fd2c69baa15fcb064373d55d0a5a47f29fc7f03eebde767","examples/autobahn-client.rs":"9d525f68cab5cc1791aa8ba376bea77f27534f3e953f3a486bb4a515b9b3fbf4","examples/autobahn-server.rs":"4b50ff21113ca920a2d91a37f8f3452ecc64ee3dcf0d557905d3bcd1746a92e3","examples/callback-error.rs":"fe732374176dfe4e5d1f36a3fa09d6d6e3cc95885e920480ef5bcd94206835e0","examples/client.rs":"348a78efba691d502c5d2cb2c02f1704c513b2a752a2fa36e2e18d01f234a2bb","examples/server.rs":"676d6cc3b3042b106def38a5a5f65f2be9f43d6156f9164046b0a666ed06f048","examples/srv_accept_unmasked_frames.rs":"9a898510c622d2b2d3a28505d45b9187272186ae487fd74b827fe280c8f6a5f9","src/buffer.rs":"c346e4282b294b856d29a17ea078ebd2580b3142f531e1e10d545e4af0baba2b","src/client.rs":"4691e64343a38879367cafe45a999789fc143938e5e71a4d34e96d924df5ece3","src/error.rs":"4fa76e7d681a464da9e144b6fcc7022b00591607cac04107474b35e46ba50307","src/handshake/client.rs":"ee777c8e23f3503213d0fc5d0e35cee1c4f2112bfb2902543dda64e963b8257f","src/handshake/headers.rs":"0e6d3e15faa8b82bd2a239f5094335368e578acef2f17ee74825de606f529b75","src/handshake/machine.rs":"d8d07e8797ab93516154abc904cbc44dc72b49f6ce9601b4e559c7fc1ae065f5","src/handshake/mod.rs":"783b05cb7a45fcc4ff3d06eec5f17d87f7d1cc32db9dd836d1b8fcd2d9018436","src/handshake/server.rs":"000d888d2d5ba140a57db1e1520f844441b403fda61f7e674c4730e1fe15a202","src/lib.rs":"f5e1e6ae7e1af292f5d56011333f8dc28de18cd5a81d0da580a0c73b98ab7d5e","src/protocol/frame/coding.rs":"dfa740428a7ae63a308b0d22258354f5234690a105e10963075d4af02d8d5450","src/protocol/frame/frame.rs":"efebb2b48d17d7cecf090805ccb8c1930471210b74276c5c62ce941d8188a402","src/protocol/frame/mask.rs":"ab2d387f9e2dbfda29b26d3147facacaeb7b91de1ae5d07d742fb9b9d297f8b1","src/protocol/frame/mod.rs":"7ae23d5c389fb1ff789b7f2597ff390d7846dfd5d654bccf4ec3682ad1741055","src/protocol/message.rs":"446cfc9c28ac8cc91214699b62044d0a1ab1d8c62bee1f101758ae8560db5223","src/protocol/mod.rs":"e24aaa577263eeb890b5b0a3cf0ad023c1c8ccc01080abf441a3d8fd1cb88a47","src/server.rs":"f01a418588a7d924dcfc0cdc632aec7f483a4ab5409c1b5563b2205d97cf8a49","src/stream.rs":"af00ffb61ce504a83fbe88b2ceb5780824008cff4a876007e969ec1455a7b723","src/tls.rs":"8260cf1ac17f404d5c985f3defb3ca799324449c3a98ff438c6d2a7805335049","src/util.rs":"ada1383900811e7c367f20d02ebf87145b423c3b8fcee1d64329578d80064f8d"},"package":"9ef1a641ea34f399a848dea702823bbecfb4c486f911735368f1f137cb8257e1"}
\ No newline at end of file
diff --git a/crates/tungstenite/Android.bp b/crates/tungstenite/Android.bp
new file mode 100644
index 0000000..2e273b6
--- /dev/null
+++ b/crates/tungstenite/Android.bp
@@ -0,0 +1,38 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_tungstenite_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_tungstenite_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtungstenite",
+ host_supported: true,
+ crate_name: "tungstenite",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.21.0",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ rustlibs: [
+ "libbyteorder",
+ "libbytes",
+ "liblog_rust",
+ "librand",
+ "libthiserror",
+ "libutf8",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/tungstenite/CHANGELOG.md b/crates/tungstenite/CHANGELOG.md
new file mode 100644
index 0000000..5c0348e
--- /dev/null
+++ b/crates/tungstenite/CHANGELOG.md
@@ -0,0 +1,95 @@
+# Unreleased
+- Fix read-predominant auto pong responses not flushing when hitting WouldBlock errors.
+- Improve `FrameHeader::format` write correctness.
+- Up minimum _rustls_ to `0.21.6`.
+- Update _webpki-roots_ to `0.26`.
+
+# 0.20.1
+- Fixes [CVE-2023-43669](https://github.com/snapview/tungstenite-rs/pull/379).
+
+# 0.20.0
+- Remove many implicit flushing behaviours. In general reading and writing messages will no
+ longer flush until calling `flush`. An exception is automatic responses (e.g. pongs)
+ which will continue to be written and flushed when reading and writing.
+ This allows writing a batch of messages and flushing once, improving performance.
+- Add `WebSocket::read`, `write`, `send`, `flush`. Deprecate `read_message`, `write_message`, `write_pending`.
+- Add `FrameSocket::read`, `write`, `send`, `flush`. Remove `read_frame`, `write_frame`, `write_pending`.
+ Note: Previous use of `write_frame` may be replaced with `send`.
+- Add `WebSocketContext::read`, `write`, `flush`. Remove `read_message`, `write_message`, `write_pending`.
+ Note: Previous use of `write_message` may be replaced with `write` + `flush`.
+- Remove `send_queue`, replaced with using the frame write buffer to achieve similar results.
+ * Add `WebSocketConfig::max_write_buffer_size`. Deprecate `max_send_queue`.
+ * Add `Error::WriteBufferFull`. Remove `Error::SendQueueFull`.
+ Note: `WriteBufferFull` returns the message that could not be written as a `Message::Frame`.
+- Add ability to buffer multiple writes before writing to the underlying stream, controlled by
+ `WebSocketConfig::write_buffer_size` (default 128 KiB). Improves batch message write performance.
+- Panic on receiving invalid `WebSocketConfig`.
+
+# 0.19.0
+
+- Update TLS dependencies.
+- Exchanging `base64` for `data-encoding`.
+
+# 0.18.0
+
+- Make handshake dependencies optional with a new `handshake` feature (now a default one!).
+- Return HTTP error responses (their HTTP body) upon non 101 status codes.
+
+# 0.17.3
+
+- Respect the case-sentitivity of the "Origin" header to keep compatibility with the older servers that use case-sensitive comparison.
+
+# 0.17.2
+
+- Fix panic when invalid manually constructed `http::Request` is passed to `tungstenite`.
+- Downgrade the MSRV to `1.56` due to some other crates that rely on us not being quite ready for `1.58`.
+
+# 0.17.1
+
+- Specify the minimum required Rust version.
+
+# 0.17.0
+
+- Update of dependencies (primarily `sha1`).
+- Add support of the fragmented messages (allow the user to send the frames without composing the full message).
+- Overhaul of the client's request generation process. Now the users are able to pass the constructed `http::Request` "as is" to `tungstenite-rs`, letting the library to check the correctness of the request and specifying their own headers (including its own key if necessary). No changes for those ones who used the client in a normal way by connecting using a URL/URI (most common use-case).
+
+# 0.16.0
+
+- Update of dependencies (primarily `rustls`, `webpki-roots`, `rustls-native-certs`).
+- When the close frame is received, the reply that is automatically sent to the initiator has the same code (so we just echo the frame back). Previously a new close frame was created (i.e. the close code / reason was always the same regardless of what code / reason specified by the initiator). Now it’s more symmetrical and arguably more intuitive behavior (see [#246](https://github.com/snapview/tungstenite-rs/pull/246) for more context).
+- The internal `ReadBuffer` implementation uses heap instead of stack to store the buffer. This should solve issues with possible stack overflows in some scenarios (see [#241](https://github.com/snapview/tungstenite-rs/pull/241) for more context).
+
+# 0.15.0
+
+- Allow selecting the method of loading root certificates if `rustls` is used as TLS implementation.
+ - Two new feature flags `rustls-tls-native-roots` and `rustls-tls-webpki-roots` have been added
+ that activate the respective method to load certificates.
+ - The `rustls-tls` flag was removed to raise awareness of this change. Otherwise, compilation
+ would have continue to work and potential errors (due to different or missing certificates)
+ only occurred at runtime.
+ - The new feature flags are additive. If both are enabled, both methods will be used to add
+ certificates to the TLS configuration.
+- Allow specifying a connector (for more fine-grained configuration of the TLS).
+
+# 0.14.0
+
+- Use `rustls-native-certs` instead of `webpki-root` when `rustls-tls` feature is enabled.
+- Don't use `native-tls` as a default feature (see #202 for more details).
+- New fast and safe implementation of the reading buffer (replacement for the `input_buffer`).
+- Remove some errors from the `Error` enum that can't be triggered anymore with the new buffer implementation.
+
+# 0.13.0
+
+- Add `CapacityError`, `UrlError`, and `ProtocolError` types to represent the different types of capacity, URL, and protocol errors respectively.
+- Modify variants `Error::Capacity`, `Error::Url`, and `Error::Protocol` to hold the above errors types instead of string error messages.
+- Add `handshake::derive_accept_key` to facilitate external handshakes.
+- Add support for `rustls` as TLS backend. The previous `tls` feature flag is now removed in favor
+ of `native-tls` and `rustls-tls`, which allows to pick the TLS backend. The error API surface had
+ to be changed to support the new error types coming from rustls related crates.
+
+# 0.12.0
+
+- Add facilities to allow clients to follow HTTP 3XX redirects.
+- Allow accepting unmasked clients on the server side to be compatible with some legacy / invalid clients.
+- Update of dependencies and documentation fixes.
diff --git a/crates/tungstenite/Cargo.lock b/crates/tungstenite/Cargo.lock
new file mode 100644
index 0000000..7ec88dc
--- /dev/null
+++ b/crates/tungstenite/Cargo.lock
@@ -0,0 +1,1349 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "aho-corasick"
+version = "1.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b2969dcb958b36655471fc61f7e416fa76033bdd4bfed0678d8fee1e2d07a1f0"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "anes"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299"
+
+[[package]]
+name = "anstyle"
+version = "1.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7079075b41f533b8c61d2a4d073c4676e1f8b249ff94a393b0595db304e0dd87"
+
+[[package]]
+name = "autocfg"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+
+[[package]]
+name = "base64"
+version = "0.21.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "35636a1494ede3b646cc98f74f8e62c773a38a659ebc777a2cf26b9b74171df9"
+
+[[package]]
+name = "bitflags"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bitflags"
+version = "2.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "327762f6e5a765692301e5bb513e0d9fef63be86bbc14528052b1cd3e6f03e07"
+
+[[package]]
+name = "block-buffer"
+version = "0.10.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3078c7629b62d3f0439517fa394996acacc5cbc91c5a20d8c658e77abd503a71"
+dependencies = [
+ "generic-array",
+]
+
+[[package]]
+name = "bumpalo"
+version = "3.14.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7f30e7476521f6f8af1a1c4c0b8cc94f0bee37d91763d0ca2665f299b6cd8aec"
+
+[[package]]
+name = "byteorder"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b"
+
+[[package]]
+name = "bytes"
+version = "1.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2bd12c1caf447e69cd4528f47f94d203fd2582878ecb9e9465484c4148a8223"
+
+[[package]]
+name = "cast"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5"
+
+[[package]]
+name = "cc"
+version = "1.0.83"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "ciborium"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "effd91f6c78e5a4ace8a5d3c0b6bfaec9e2baaef55f3efc00e45fb2e477ee926"
+dependencies = [
+ "ciborium-io",
+ "ciborium-ll",
+ "serde",
+]
+
+[[package]]
+name = "ciborium-io"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cdf919175532b369853f5d5e20b26b43112613fd6fe7aee757e35f7a44642656"
+
+[[package]]
+name = "ciborium-ll"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "defaa24ecc093c77630e6c15e17c51f5e187bf35ee514f4e2d67baaa96dae22b"
+dependencies = [
+ "ciborium-io",
+ "half",
+]
+
+[[package]]
+name = "clap"
+version = "4.4.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bfaff671f6b22ca62406885ece523383b9b64022e341e53e009a62ebc47a45f2"
+dependencies = [
+ "clap_builder",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.4.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a216b506622bb1d316cd51328dce24e07bdff4a6128a47c7e7fad11878d5adbb"
+dependencies = [
+ "anstyle",
+ "clap_lex",
+]
+
+[[package]]
+name = "clap_lex"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "702fc72eb24e5a1e48ce58027a675bc24edd52096d5397d4aea7c6dd9eca0bd1"
+
+[[package]]
+name = "core-foundation"
+version = "0.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91e195e091a93c46f7102ec7818a2aa394e1e1771c3ab4825963fa03e45afb8f"
+dependencies = [
+ "core-foundation-sys",
+ "libc",
+]
+
+[[package]]
+name = "core-foundation-sys"
+version = "0.8.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f"
+
+[[package]]
+name = "cpufeatures"
+version = "0.2.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce420fe07aecd3e67c5f910618fe65e94158f6dcc0adf44e00d69ce2bdfe0fd0"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "criterion"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2b12d017a929603d80db1831cd3a24082f8137ce19c69e6447f54f5fc8d692f"
+dependencies = [
+ "anes",
+ "cast",
+ "ciborium",
+ "clap",
+ "criterion-plot",
+ "is-terminal",
+ "itertools",
+ "num-traits",
+ "once_cell",
+ "oorandom",
+ "plotters",
+ "rayon",
+ "regex",
+ "serde",
+ "serde_derive",
+ "serde_json",
+ "tinytemplate",
+ "walkdir",
+]
+
+[[package]]
+name = "criterion-plot"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6b50826342786a51a89e2da3a28f1c32b06e387201bc2d19791f622c673706b1"
+dependencies = [
+ "cast",
+ "itertools",
+]
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef"
+dependencies = [
+ "cfg-if",
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ae211234986c545741a7dc064309f67ee1e5ad243d0e48335adc0484d960bcc7"
+dependencies = [
+ "autocfg",
+ "cfg-if",
+ "crossbeam-utils",
+ "memoffset",
+ "scopeguard",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a22b2d63d4d1dc0b7f1b6b2747dd0088008a9be28b6ddf0b1e7d335e3037294"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "crypto-common"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
+dependencies = [
+ "generic-array",
+ "typenum",
+]
+
+[[package]]
+name = "data-encoding"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7e962a19be5cfc3f3bf6dd8f61eb50107f356ad6270fbb3ed41476571db78be5"
+
+[[package]]
+name = "digest"
+version = "0.10.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ed9a281f7bc9b7576e61468ba615a66a5c8cfdff42420a70aa82701a3b1e292"
+dependencies = [
+ "block-buffer",
+ "crypto-common",
+]
+
+[[package]]
+name = "either"
+version = "1.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
+
+[[package]]
+name = "env_logger"
+version = "0.10.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "95b3f3e67048839cb0d0781f445682a35113da7121f7c949db0e2be96a4fbece"
+dependencies = [
+ "humantime",
+ "is-terminal",
+ "log",
+ "regex",
+ "termcolor",
+]
+
+[[package]]
+name = "errno"
+version = "0.3.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a258e46cdc063eb8519c00b9fc845fc47bcfca4130e2f08e88665ceda8474245"
+dependencies = [
+ "libc",
+ "windows-sys 0.52.0",
+]
+
+[[package]]
+name = "fastrand"
+version = "2.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "25cbce373ec4653f1a01a31e8a5e5ec0c622dc27ff9c4e6606eefef5cbbed4a5"
+
+[[package]]
+name = "fnv"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
+
+[[package]]
+name = "foreign-types"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f6f339eb8adc052cd2ca78910fda869aefa38d22d5cb648e6485e4d3fc06f3b1"
+dependencies = [
+ "foreign-types-shared",
+]
+
+[[package]]
+name = "foreign-types-shared"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b"
+
+[[package]]
+name = "form_urlencoded"
+version = "1.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e13624c2627564efccf4934284bdd98cbaa14e79b0b5a141218e507b3a823456"
+dependencies = [
+ "percent-encoding",
+]
+
+[[package]]
+name = "generic-array"
+version = "0.14.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "85649ca51fd72272d7821adaf274ad91c288277713d9c18820d8499a7ff69e9a"
+dependencies = [
+ "typenum",
+ "version_check",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fe9006bed769170c11f845cf00c7c1e9092aeb3f268e007c3e760ac68008070f"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "half"
+version = "1.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eabb4a44450da02c90444cf74558da904edde8fb4e9035a9a6a4e15445af0bd7"
+
+[[package]]
+name = "hermit-abi"
+version = "0.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d77f7ec81a6d05a3abb01ab6eb7590f6083d08449fe5a1c8b1e620283546ccb7"
+
+[[package]]
+name = "http"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b32afd38673a8016f7c9ae69e5af41a58f81b1d31689040f2f1959594ce194ea"
+dependencies = [
+ "bytes",
+ "fnv",
+ "itoa",
+]
+
+[[package]]
+name = "httparse"
+version = "1.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d897f394bad6a705d5f4104762e116a75639e470d80901eed05a860a95cb1904"
+
+[[package]]
+name = "humantime"
+version = "2.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4"
+
+[[package]]
+name = "idna"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "634d9b1461af396cad843f47fdba5597a4f9e6ddd4bfb6ff5d85028c25cb12f6"
+dependencies = [
+ "unicode-bidi",
+ "unicode-normalization",
+]
+
+[[package]]
+name = "input_buffer"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "acee673b88a760f5d1f7b2677a90ab797878282ca36ebd0ed8d560361bee9810"
+dependencies = [
+ "bytes",
+]
+
+[[package]]
+name = "is-terminal"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cb0889898416213fab133e1d33a0e5858a48177452750691bde3666d0fdbaf8b"
+dependencies = [
+ "hermit-abi",
+ "rustix",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "itertools"
+version = "0.10.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b0fd2260e829bddf4cb6ea802289de2f86d6a7a690192fbe91b3f46e0f2c8473"
+dependencies = [
+ "either",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38"
+
+[[package]]
+name = "js-sys"
+version = "0.3.66"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cee9c64da59eae3b50095c18d3e74f8b73c0b86d2792824ff01bbce68ba229ca"
+dependencies = [
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "lazy_static"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+
+[[package]]
+name = "libc"
+version = "0.2.150"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "89d92a4743f9a61002fae18374ed11e7973f530cb3a3255fb354818118b2203c"
+
+[[package]]
+name = "linux-raw-sys"
+version = "0.4.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c4cd1a83af159aa67994778be9070f0ae1bd732942279cabb14f86f986a21456"
+
+[[package]]
+name = "log"
+version = "0.4.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"
+
+[[package]]
+name = "memchr"
+version = "2.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f665ee40bc4a3c5590afb1e9677db74a508659dfd71e126420da8274909a0167"
+
+[[package]]
+name = "memoffset"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "native-tls"
+version = "0.2.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "07226173c32f2926027b63cce4bcd8076c3552846cbe7925f3aaffeac0a3b92e"
+dependencies = [
+ "lazy_static",
+ "libc",
+ "log",
+ "openssl",
+ "openssl-probe",
+ "openssl-sys",
+ "schannel",
+ "security-framework",
+ "security-framework-sys",
+ "tempfile",
+]
+
+[[package]]
+name = "num-traits"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "39e3200413f237f41ab11ad6d161bc7239c84dcb631773ccd7de3dfe4b5c267c"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.18.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d"
+
+[[package]]
+name = "oorandom"
+version = "11.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ab1bc2a289d34bd04a330323ac98a1b4bc82c9d9fcb1e66b63caa84da26b575"
+
+[[package]]
+name = "openssl"
+version = "0.10.61"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6b8419dc8cc6d866deb801274bba2e6f8f6108c1bb7fcc10ee5ab864931dbb45"
+dependencies = [
+ "bitflags 2.4.1",
+ "cfg-if",
+ "foreign-types",
+ "libc",
+ "once_cell",
+ "openssl-macros",
+ "openssl-sys",
+]
+
+[[package]]
+name = "openssl-macros"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "openssl-probe"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf"
+
+[[package]]
+name = "openssl-src"
+version = "300.1.6+3.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "439fac53e092cd7442a3660c85dde4643ab3b5bd39040912388dcdabf6b88085"
+dependencies = [
+ "cc",
+]
+
+[[package]]
+name = "openssl-sys"
+version = "0.9.97"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c3eaad34cdd97d81de97964fc7f29e2d104f483840d906ef56daa1912338460b"
+dependencies = [
+ "cc",
+ "libc",
+ "openssl-src",
+ "pkg-config",
+ "vcpkg",
+]
+
+[[package]]
+name = "percent-encoding"
+version = "2.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e3148f5046208a5d56bcfc03053e3ca6334e51da8dfb19b6cdc8b306fae3283e"
+
+[[package]]
+name = "pkg-config"
+version = "0.3.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "26072860ba924cbfa98ea39c8c19b4dd6a4a25423dbdf219c1eca91aa0cf6964"
+
+[[package]]
+name = "plotters"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d2c224ba00d7cadd4d5c660deaf2098e5e80e07846537c51f9cfa4be50c1fd45"
+dependencies = [
+ "num-traits",
+ "plotters-backend",
+ "plotters-svg",
+ "wasm-bindgen",
+ "web-sys",
+]
+
+[[package]]
+name = "plotters-backend"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9e76628b4d3a7581389a35d5b6e2139607ad7c75b17aed325f210aa91f4a9609"
+
+[[package]]
+name = "plotters-svg"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "38f6d39893cca0701371e3c27294f09797214b86f1fb951b89ade8ec04e2abab"
+dependencies = [
+ "plotters-backend",
+]
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.70"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "39278fbbf5fb4f646ce651690877f89d1c5811a3d4acb27700c1cb3cdb78fd3b"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "rayon"
+version = "1.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c27db03db7734835b3f53954b534c91069375ce6ccaa2e065441e07d9b6cdb1"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.12.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ce3fb6ad83f861aac485e76e1985cd109d9a3713802152be56c3b1f0e0658ed"
+dependencies = [
+ "crossbeam-deque",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "redox_syscall"
+version = "0.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4722d768eff46b75989dd134e5c353f0d6296e5aaa3132e776cbdb56be7731aa"
+dependencies = [
+ "bitflags 1.3.2",
+]
+
+[[package]]
+name = "regex"
+version = "1.10.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "380b951a9c5e80ddfd6136919eef32310721aa4aacd4889a8d39124b026ab343"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5f804c7828047e88b2d32e2d7fe5a105da8ee3264f01902f796c8e067dc2483f"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c08c74e62047bb2de4ff487b251e4a92e24f48745648451635cec7d591162d9f"
+
+[[package]]
+name = "ring"
+version = "0.17.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "688c63d65483050968b2a8937f7995f443e27041a0f7700aa59b0822aedebb74"
+dependencies = [
+ "cc",
+ "getrandom",
+ "libc",
+ "spin",
+ "untrusted",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "rustix"
+version = "0.38.26"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9470c4bf8246c8daf25f9598dca807fb6510347b1e1cfa55749113850c79d88a"
+dependencies = [
+ "bitflags 2.4.1",
+ "errno",
+ "libc",
+ "linux-raw-sys",
+ "windows-sys 0.52.0",
+]
+
+[[package]]
+name = "rustls"
+version = "0.22.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5bc238b76c51bbc449c55ffbc39d03772a057cc8cf783c49d4af4c2537b74a8b"
+dependencies = [
+ "log",
+ "ring",
+ "rustls-pki-types",
+ "rustls-webpki",
+ "subtle",
+ "zeroize",
+]
+
+[[package]]
+name = "rustls-native-certs"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f1fb85efa936c42c6d5fc28d2629bb51e4b2f4b8a5211e297d599cc5a093792"
+dependencies = [
+ "openssl-probe",
+ "rustls-pemfile",
+ "rustls-pki-types",
+ "schannel",
+ "security-framework",
+]
+
+[[package]]
+name = "rustls-pemfile"
+version = "2.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "35e4980fa29e4c4b212ffb3db068a564cbf560e51d3944b7c88bd8bf5bec64f4"
+dependencies = [
+ "base64",
+ "rustls-pki-types",
+]
+
+[[package]]
+name = "rustls-pki-types"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e7673e0aa20ee4937c6aacfc12bb8341cfbf054cdd21df6bec5fd0629fe9339b"
+
+[[package]]
+name = "rustls-webpki"
+version = "0.102.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "de2635c8bc2b88d367767c5de8ea1d8db9af3f6219eba28442242d9ab81d1b89"
+dependencies = [
+ "ring",
+ "rustls-pki-types",
+ "untrusted",
+]
+
+[[package]]
+name = "ryu"
+version = "1.0.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741"
+
+[[package]]
+name = "same-file"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502"
+dependencies = [
+ "winapi-util",
+]
+
+[[package]]
+name = "schannel"
+version = "0.1.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c3733bf4cf7ea0880754e19cb5a462007c4a8c1914bff372ccc95b464f1df88"
+dependencies = [
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "scopeguard"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
+
+[[package]]
+name = "security-framework"
+version = "2.9.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05b64fb303737d99b81884b2c63433e9ae28abebe5eb5045dcdd175dc2ecf4de"
+dependencies = [
+ "bitflags 1.3.2",
+ "core-foundation",
+ "core-foundation-sys",
+ "libc",
+ "security-framework-sys",
+]
+
+[[package]]
+name = "security-framework-sys"
+version = "2.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e932934257d3b408ed8f30db49d85ea163bfe74961f017f405b025af298f0c7a"
+dependencies = [
+ "core-foundation-sys",
+ "libc",
+]
+
+[[package]]
+name = "serde"
+version = "1.0.193"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "25dd9975e68d0cb5aa1120c288333fc98731bd1dd12f561e468ea4728c042b89"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.193"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43576ca501357b9b071ac53cdc7da8ef0cbd9493d8df094cd821777ea6e894d3"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.108"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3d1c7e3eac408d115102c4c24ad393e0821bb3a5df4d506a80f85f7a742a526b"
+dependencies = [
+ "itoa",
+ "ryu",
+ "serde",
+]
+
+[[package]]
+name = "sha1"
+version = "0.10.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e3bf829a2d51ab4a5ddf1352d8470c140cadc8301b2ae1789db023f01cedd6ba"
+dependencies = [
+ "cfg-if",
+ "cpufeatures",
+ "digest",
+]
+
+[[package]]
+name = "socket2"
+version = "0.5.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b5fac59a5cb5dd637972e5fca70daf0523c9067fcdc4842f053dae04a18f8e9"
+dependencies = [
+ "libc",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "spin"
+version = "0.9.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
+
+[[package]]
+name = "subtle"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "81cdd64d312baedb58e21336b31bc043b77e01cc99033ce76ef539f78e965ebc"
+
+[[package]]
+name = "syn"
+version = "2.0.39"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "23e78b90f2fcf45d3e842032ce32e3f2d1545ba6636271dcbf24fa306d87be7a"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "tempfile"
+version = "3.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ef1adac450ad7f4b3c28589471ade84f25f731a7a0fe30d71dfa9f60fd808e5"
+dependencies = [
+ "cfg-if",
+ "fastrand",
+ "redox_syscall",
+ "rustix",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "termcolor"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ff1bc3d3f05aff0403e8ac0d92ced918ec05b666a43f83297ccef5bea8a3d449"
+dependencies = [
+ "winapi-util",
+]
+
+[[package]]
+name = "thiserror"
+version = "1.0.50"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f9a7210f5c9a7156bb50aa36aed4c95afb51df0df00713949448cf9e97d382d2"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "1.0.50"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "266b2e40bc00e5a6c09c3584011e08b06f123c00362c92b975ba9843aaaa14b8"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "tinytemplate"
+version = "1.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be4d6b5f19ff7664e8c98d03e2139cb510db9b0a60b55f8e8709b689d939b6bc"
+dependencies = [
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "tinyvec"
+version = "1.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "87cc5ceb3875bb20c2890005a4e226a4651264a5c75edb2421b52861a0a0cb50"
+dependencies = [
+ "tinyvec_macros",
+]
+
+[[package]]
+name = "tinyvec_macros"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"
+
+[[package]]
+name = "tungstenite"
+version = "0.21.0"
+dependencies = [
+ "byteorder",
+ "bytes",
+ "criterion",
+ "data-encoding",
+ "env_logger",
+ "http",
+ "httparse",
+ "input_buffer",
+ "log",
+ "native-tls",
+ "rand",
+ "rustls",
+ "rustls-native-certs",
+ "rustls-pki-types",
+ "sha1",
+ "socket2",
+ "thiserror",
+ "url",
+ "utf-8",
+ "webpki-roots",
+]
+
+[[package]]
+name = "typenum"
+version = "1.17.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825"
+
+[[package]]
+name = "unicode-bidi"
+version = "0.3.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6f2528f27a9eb2b21e69c95319b30bd0efd85d09c379741b0f78ea1d86be2416"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
+
+[[package]]
+name = "unicode-normalization"
+version = "0.1.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c5713f0fc4b5db668a2ac63cdb7bb4469d8c9fed047b1d0292cc7b0ce2ba921"
+dependencies = [
+ "tinyvec",
+]
+
+[[package]]
+name = "untrusted"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1"
+
+[[package]]
+name = "url"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "31e6302e3bb753d46e83516cae55ae196fc0c309407cf11ab35cc51a4c2a4633"
+dependencies = [
+ "form_urlencoded",
+ "idna",
+ "percent-encoding",
+]
+
+[[package]]
+name = "utf-8"
+version = "0.7.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9"
+
+[[package]]
+name = "vcpkg"
+version = "0.2.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426"
+
+[[package]]
+name = "version_check"
+version = "0.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
+
+[[package]]
+name = "walkdir"
+version = "2.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d71d857dc86794ca4c280d616f7da00d2dbfd8cd788846559a6813e6aa4b54ee"
+dependencies = [
+ "same-file",
+ "winapi-util",
+]
+
+[[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
+[[package]]
+name = "wasm-bindgen"
+version = "0.2.89"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ed0d4f68a3015cc185aff4db9506a015f4b96f95303897bfa23f846db54064e"
+dependencies = [
+ "cfg-if",
+ "wasm-bindgen-macro",
+]
+
+[[package]]
+name = "wasm-bindgen-backend"
+version = "0.2.89"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b56f625e64f3a1084ded111c4d5f477df9f8c92df113852fa5a374dbda78826"
+dependencies = [
+ "bumpalo",
+ "log",
+ "once_cell",
+ "proc-macro2",
+ "quote",
+ "syn",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-macro"
+version = "0.2.89"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0162dbf37223cd2afce98f3d0785506dcb8d266223983e4b5b525859e6e182b2"
+dependencies = [
+ "quote",
+ "wasm-bindgen-macro-support",
+]
+
+[[package]]
+name = "wasm-bindgen-macro-support"
+version = "0.2.89"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f0eb82fcb7930ae6219a7ecfd55b217f5f0893484b7a13022ebb2b2bf20b5283"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+ "wasm-bindgen-backend",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-shared"
+version = "0.2.89"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ab9b36309365056cd639da3134bf87fa8f3d86008abf99e612384a6eecd459f"
+
+[[package]]
+name = "web-sys"
+version = "0.3.66"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "50c24a44ec86bb68fbecd1b3efed7e85ea5621b39b35ef2766b66cd984f8010f"
+dependencies = [
+ "js-sys",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "webpki-roots"
+version = "0.26.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0de2cfda980f21be5a7ed2eadb3e6fe074d56022bea2cdeb1a62eb220fc04188"
+dependencies = [
+ "rustls-pki-types",
+]
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-util"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f29e6f9198ba0d26b4c9f07dbe6f9ed633e1f3d5b8b414090084349e46a52596"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "windows-sys"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
+dependencies = [
+ "windows-targets 0.48.5",
+]
+
+[[package]]
+name = "windows-sys"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d"
+dependencies = [
+ "windows-targets 0.52.0",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
+dependencies = [
+ "windows_aarch64_gnullvm 0.48.5",
+ "windows_aarch64_msvc 0.48.5",
+ "windows_i686_gnu 0.48.5",
+ "windows_i686_msvc 0.48.5",
+ "windows_x86_64_gnu 0.48.5",
+ "windows_x86_64_gnullvm 0.48.5",
+ "windows_x86_64_msvc 0.48.5",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd"
+dependencies = [
+ "windows_aarch64_gnullvm 0.52.0",
+ "windows_aarch64_msvc 0.52.0",
+ "windows_i686_gnu 0.52.0",
+ "windows_i686_msvc 0.52.0",
+ "windows_x86_64_gnu 0.52.0",
+ "windows_x86_64_gnullvm 0.52.0",
+ "windows_x86_64_msvc 0.52.0",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.48.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.52.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04"
+
+[[package]]
+name = "zeroize"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "525b4ec142c6b68a2d10f01f7bbf6755599ca3f81ea53b8431b7dd348f5fdb2d"
diff --git a/crates/tungstenite/Cargo.toml b/crates/tungstenite/Cargo.toml
new file mode 100644
index 0000000..3d8cca5
--- /dev/null
+++ b/crates/tungstenite/Cargo.toml
@@ -0,0 +1,179 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.51"
+name = "tungstenite"
+version = "0.21.0"
+authors = [
+ "Alexey Galakhov",
+ "Daniel Abramov",
+]
+include = [
+ "benches/**/*",
+ "src/**/*",
+ "examples/**/*",
+ "LICENSE-*",
+ "README.md",
+ "CHANGELOG.md",
+]
+description = "Lightweight stream-based WebSocket implementation"
+homepage = "https://github.com/snapview/tungstenite-rs"
+documentation = "https://docs.rs/tungstenite/0.21.0"
+readme = "README.md"
+keywords = [
+ "websocket",
+ "io",
+ "web",
+]
+categories = [
+ "web-programming::websocket",
+ "network-programming",
+]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/snapview/tungstenite-rs"
+
+[package.metadata.docs.rs]
+all-features = true
+
+[[example]]
+name = "client"
+required-features = ["handshake"]
+
+[[example]]
+name = "server"
+required-features = ["handshake"]
+
+[[example]]
+name = "autobahn-client"
+required-features = ["handshake"]
+
+[[example]]
+name = "autobahn-server"
+required-features = ["handshake"]
+
+[[example]]
+name = "callback-error"
+required-features = ["handshake"]
+
+[[example]]
+name = "srv_accept_unmasked_frames"
+required-features = ["handshake"]
+
+[[bench]]
+name = "buffer"
+harness = false
+
+[[bench]]
+name = "write"
+harness = false
+
+[dependencies.byteorder]
+version = "1.3.2"
+
+[dependencies.bytes]
+version = "1.0"
+
+[dependencies.data-encoding]
+version = "2"
+optional = true
+
+[dependencies.http]
+version = "1.0"
+optional = true
+
+[dependencies.httparse]
+version = "1.3.4"
+optional = true
+
+[dependencies.log]
+version = "0.4.8"
+
+[dependencies.native-tls-crate]
+version = "0.2.3"
+optional = true
+package = "native-tls"
+
+[dependencies.rand]
+version = "0.8.0"
+
+[dependencies.rustls]
+version = "0.22.0"
+optional = true
+
+[dependencies.rustls-native-certs]
+version = "0.7.0"
+optional = true
+
+[dependencies.rustls-pki-types]
+version = "1.0"
+optional = true
+
+[dependencies.sha1]
+version = "0.10"
+optional = true
+
+[dependencies.thiserror]
+version = "1.0.23"
+
+[dependencies.url]
+version = "2.1.0"
+optional = true
+
+[dependencies.utf-8]
+version = "0.7.5"
+
+[dependencies.webpki-roots]
+version = "0.26"
+optional = true
+
+[dev-dependencies.criterion]
+version = "0.5.0"
+
+[dev-dependencies.env_logger]
+version = "0.10.0"
+
+[dev-dependencies.input_buffer]
+version = "0.5.0"
+
+[dev-dependencies.rand]
+version = "0.8.4"
+
+[dev-dependencies.socket2]
+version = "0.5.5"
+
+[features]
+__rustls-tls = [
+ "rustls",
+ "rustls-pki-types",
+]
+default = ["handshake"]
+handshake = [
+ "data-encoding",
+ "http",
+ "httparse",
+ "sha1",
+ "url",
+]
+native-tls = ["native-tls-crate"]
+native-tls-vendored = [
+ "native-tls",
+ "native-tls-crate/vendored",
+]
+rustls-tls-native-roots = [
+ "__rustls-tls",
+ "rustls-native-certs",
+]
+rustls-tls-webpki-roots = [
+ "__rustls-tls",
+ "webpki-roots",
+]
diff --git a/crates/tungstenite/LICENSE b/crates/tungstenite/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/tungstenite/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/tungstenite/LICENSE-APACHE b/crates/tungstenite/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/tungstenite/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/tungstenite/LICENSE-MIT b/crates/tungstenite/LICENSE-MIT
new file mode 100644
index 0000000..dfb98c6
--- /dev/null
+++ b/crates/tungstenite/LICENSE-MIT
@@ -0,0 +1,20 @@
+Copyright (c) 2017 Alexey Galakhov
+Copyright (c) 2016 Jason Housley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/crates/tungstenite/METADATA b/crates/tungstenite/METADATA
new file mode 100644
index 0000000..8220772
--- /dev/null
+++ b/crates/tungstenite/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/tungstenite
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "tungstenite"
+description: "Lightweight stream-based WebSocket implementation"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 8
+ }
+ homepage: "https://crates.io/crates/tungstenite"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/tungstenite/tungstenite-0.21.0.crate"
+ version: "0.21.0"
+ }
+}
diff --git a/crates/tungstenite/MODULE_LICENSE_APACHE2 b/crates/tungstenite/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/tungstenite/MODULE_LICENSE_APACHE2
diff --git a/crates/tungstenite/README.md b/crates/tungstenite/README.md
new file mode 100644
index 0000000..8c1b2a2
--- /dev/null
+++ b/crates/tungstenite/README.md
@@ -0,0 +1,86 @@
+# Tungstenite
+
+Lightweight stream-based WebSocket implementation for [Rust](https://www.rust-lang.org/).
+
+```rust
+use std::net::TcpListener;
+use std::thread::spawn;
+use tungstenite::accept;
+
+/// A WebSocket echo server
+fn main () {
+ let server = TcpListener::bind("127.0.0.1:9001").unwrap();
+ for stream in server.incoming() {
+ spawn (move || {
+ let mut websocket = accept(stream.unwrap()).unwrap();
+ loop {
+ let msg = websocket.read().unwrap();
+
+ // We do not want to send back ping/pong messages.
+ if msg.is_binary() || msg.is_text() {
+ websocket.send(msg).unwrap();
+ }
+ }
+ });
+ }
+}
+```
+
+Take a look at the examples section to see how to write a simple client/server.
+
+**NOTE:** `tungstenite-rs` is more like a barebone to build reliable modern networking applications
+using WebSockets. If you're looking for a modern production-ready "batteries included" WebSocket
+library that allows you to efficiently use non-blocking sockets and do "full-duplex" communication,
+take a look at [`tokio-tungstenite`](https://github.com/snapview/tokio-tungstenite).
+
+[](./LICENSE-MIT)
+[](./LICENSE-APACHE)
+[](https://crates.io/crates/tungstenite)
+[](https://github.com/snapview/tungstenite-rs/actions)
+
+[Documentation](https://docs.rs/tungstenite)
+
+Introduction
+------------
+This library provides an implementation of WebSockets,
+[RFC6455](https://tools.ietf.org/html/rfc6455). It allows for both synchronous (like TcpStream)
+and asynchronous usage and is easy to integrate into any third-party event loops including
+[MIO](https://github.com/tokio-rs/mio). The API design abstracts away all the internals of the
+WebSocket protocol but still makes them accessible for those who wants full control over the
+network.
+
+Why Tungstenite?
+----------------
+
+It's formerly WS2, the 2nd implementation of WS. WS2 is the chemical formula of
+tungsten disulfide, the tungstenite mineral.
+
+Features
+--------
+
+Tungstenite provides a complete implementation of the WebSocket specification.
+TLS is supported on all platforms using `native-tls` or `rustls`. The following
+features are available:
+
+* `native-tls`
+* `native-tls-vendored`
+* `rustls-tls-native-roots`
+* `rustls-tls-webpki-roots`
+
+Choose the one that is appropriate for your needs.
+
+By default **no TLS feature is activated**, so make sure you use one of the TLS features,
+otherwise you won't be able to communicate with the TLS endpoints.
+
+There is no support for permessage-deflate at the moment, but the PRs are welcome :wink:
+
+Testing
+-------
+
+Tungstenite is thoroughly tested and passes the [Autobahn Test Suite](https://github.com/crossbario/autobahn-testsuite) for
+WebSockets. It is also covered by internal unit tests as well as possible.
+
+Contributing
+------------
+
+Please report bugs and make feature requests [here](https://github.com/snapview/tungstenite-rs/issues).
diff --git a/crates/tungstenite/benches/buffer.rs b/crates/tungstenite/benches/buffer.rs
new file mode 100644
index 0000000..9f15d13
--- /dev/null
+++ b/crates/tungstenite/benches/buffer.rs
@@ -0,0 +1,126 @@
+use std::io::{Cursor, Read, Result as IoResult};
+
+use bytes::Buf;
+use criterion::*;
+use input_buffer::InputBuffer;
+
+use tungstenite::buffer::ReadBuffer;
+
+const CHUNK_SIZE: usize = 4096;
+
+/// A FIFO buffer for reading packets from the network.
+#[derive(Debug)]
+pub struct StackReadBuffer<const CHUNK_SIZE: usize> {
+ storage: Cursor<Vec<u8>>,
+ chunk: [u8; CHUNK_SIZE],
+}
+
+impl<const CHUNK_SIZE: usize> StackReadBuffer<CHUNK_SIZE> {
+ /// Create a new empty input buffer.
+ pub fn new() -> Self {
+ Self::with_capacity(CHUNK_SIZE)
+ }
+
+ /// Create a new empty input buffer with a given `capacity`.
+ pub fn with_capacity(capacity: usize) -> Self {
+ Self::from_partially_read(Vec::with_capacity(capacity))
+ }
+
+ /// Create a input buffer filled with previously read data.
+ pub fn from_partially_read(part: Vec<u8>) -> Self {
+ Self { storage: Cursor::new(part), chunk: [0; CHUNK_SIZE] }
+ }
+
+ /// Get a cursor to the data storage.
+ pub fn as_cursor(&self) -> &Cursor<Vec<u8>> {
+ &self.storage
+ }
+
+ /// Get a cursor to the mutable data storage.
+ pub fn as_cursor_mut(&mut self) -> &mut Cursor<Vec<u8>> {
+ &mut self.storage
+ }
+
+ /// Consume the `ReadBuffer` and get the internal storage.
+ pub fn into_vec(mut self) -> Vec<u8> {
+ // Current implementation of `tungstenite-rs` expects that the `into_vec()` drains
+ // the data from the container that has already been read by the cursor.
+ self.clean_up();
+
+ // Now we can safely return the internal container.
+ self.storage.into_inner()
+ }
+
+ /// Read next portion of data from the given input stream.
+ pub fn read_from<S: Read>(&mut self, stream: &mut S) -> IoResult<usize> {
+ self.clean_up();
+ let size = stream.read(&mut self.chunk)?;
+ self.storage.get_mut().extend_from_slice(&self.chunk[..size]);
+ Ok(size)
+ }
+
+ /// Cleans ups the part of the vector that has been already read by the cursor.
+ fn clean_up(&mut self) {
+ let pos = self.storage.position() as usize;
+ self.storage.get_mut().drain(0..pos).count();
+ self.storage.set_position(0);
+ }
+}
+
+impl<const CHUNK_SIZE: usize> Buf for StackReadBuffer<CHUNK_SIZE> {
+ fn remaining(&self) -> usize {
+ Buf::remaining(self.as_cursor())
+ }
+
+ fn chunk(&self) -> &[u8] {
+ Buf::chunk(self.as_cursor())
+ }
+
+ fn advance(&mut self, cnt: usize) {
+ Buf::advance(self.as_cursor_mut(), cnt)
+ }
+}
+
+impl<const CHUNK_SIZE: usize> Default for StackReadBuffer<CHUNK_SIZE> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+#[inline]
+fn input_buffer(mut stream: impl Read) {
+ let mut buffer = InputBuffer::with_capacity(CHUNK_SIZE);
+ while buffer.read_from(&mut stream).unwrap() != 0 {}
+}
+
+#[inline]
+fn stack_read_buffer(mut stream: impl Read) {
+ let mut buffer = StackReadBuffer::<CHUNK_SIZE>::new();
+ while buffer.read_from(&mut stream).unwrap() != 0 {}
+}
+
+#[inline]
+fn heap_read_buffer(mut stream: impl Read) {
+ let mut buffer = ReadBuffer::<CHUNK_SIZE>::new();
+ while buffer.read_from(&mut stream).unwrap() != 0 {}
+}
+
+fn benchmark(c: &mut Criterion) {
+ const STREAM_SIZE: usize = 1024 * 1024 * 4;
+ let data: Vec<u8> = (0..STREAM_SIZE).map(|_| rand::random()).collect();
+ let stream = Cursor::new(data);
+
+ let mut group = c.benchmark_group("buffers");
+ group.throughput(Throughput::Bytes(STREAM_SIZE as u64));
+ group.bench_function("InputBuffer", |b| b.iter(|| input_buffer(black_box(stream.clone()))));
+ group.bench_function("ReadBuffer (stack)", |b| {
+ b.iter(|| stack_read_buffer(black_box(stream.clone())))
+ });
+ group.bench_function("ReadBuffer (heap)", |b| {
+ b.iter(|| heap_read_buffer(black_box(stream.clone())))
+ });
+ group.finish();
+}
+
+criterion_group!(benches, benchmark);
+criterion_main!(benches);
diff --git a/crates/tungstenite/benches/write.rs b/crates/tungstenite/benches/write.rs
new file mode 100644
index 0000000..7908818
--- /dev/null
+++ b/crates/tungstenite/benches/write.rs
@@ -0,0 +1,75 @@
+//! Benchmarks for write performance.
+use criterion::{BatchSize, Criterion};
+use std::{
+ hint,
+ io::{self, Read, Write},
+ time::{Duration, Instant},
+};
+use tungstenite::{Message, WebSocket};
+
+const MOCK_WRITE_LEN: usize = 8 * 1024 * 1024;
+
+/// `Write` impl that simulates slowish writes and slow flushes.
+///
+/// Each `write` can buffer up to 8 MiB before flushing but takes an additional **~80ns**
+/// to simulate stuff going on in the underlying stream.
+/// Each `flush` takes **~8µs** to simulate flush io.
+struct MockWrite(Vec<u8>);
+
+impl Read for MockWrite {
+ fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
+ Err(io::Error::new(io::ErrorKind::WouldBlock, "reads not supported"))
+ }
+}
+impl Write for MockWrite {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ if self.0.len() + buf.len() > MOCK_WRITE_LEN {
+ self.flush()?;
+ }
+ // simulate io
+ spin(Duration::from_nanos(80));
+ self.0.extend(buf);
+ Ok(buf.len())
+ }
+
+ fn flush(&mut self) -> io::Result<()> {
+ if !self.0.is_empty() {
+ // simulate io
+ spin(Duration::from_micros(8));
+ self.0.clear();
+ }
+ Ok(())
+ }
+}
+
+fn spin(duration: Duration) {
+ let a = Instant::now();
+ while a.elapsed() < duration {
+ hint::spin_loop();
+ }
+}
+
+fn benchmark(c: &mut Criterion) {
+ // Writes 100k small json text messages then flushes
+ c.bench_function("write 100k small texts then flush", |b| {
+ let mut ws = WebSocket::from_raw_socket(
+ MockWrite(Vec::with_capacity(MOCK_WRITE_LEN)),
+ tungstenite::protocol::Role::Server,
+ None,
+ );
+
+ b.iter_batched(
+ || (0..100_000).map(|i| Message::Text(format!("{{\"id\":{i}}}"))),
+ |batch| {
+ for msg in batch {
+ ws.write(msg).unwrap();
+ }
+ ws.flush().unwrap();
+ },
+ BatchSize::SmallInput,
+ )
+ });
+}
+
+criterion::criterion_group!(write_benches, benchmark);
+criterion::criterion_main!(write_benches);
diff --git a/crates/tungstenite/cargo_embargo.json b/crates/tungstenite/cargo_embargo.json
new file mode 100644
index 0000000..b639cc5
--- /dev/null
+++ b/crates/tungstenite/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "features": [],
+ "run_cargo": false
+}
diff --git a/crates/tungstenite/examples/autobahn-client.rs b/crates/tungstenite/examples/autobahn-client.rs
new file mode 100644
index 0000000..ac7a7d1
--- /dev/null
+++ b/crates/tungstenite/examples/autobahn-client.rs
@@ -0,0 +1,53 @@
+use log::*;
+use url::Url;
+
+use tungstenite::{connect, Error, Message, Result};
+
+const AGENT: &str = "Tungstenite";
+
+fn get_case_count() -> Result<u32> {
+ let (mut socket, _) = connect(Url::parse("ws://localhost:9001/getCaseCount").unwrap())?;
+ let msg = socket.read()?;
+ socket.close(None)?;
+ Ok(msg.into_text()?.parse::<u32>().unwrap())
+}
+
+fn update_reports() -> Result<()> {
+ let (mut socket, _) = connect(
+ Url::parse(&format!("ws://localhost:9001/updateReports?agent={}", AGENT)).unwrap(),
+ )?;
+ socket.close(None)?;
+ Ok(())
+}
+
+fn run_test(case: u32) -> Result<()> {
+ info!("Running test case {}", case);
+ let case_url =
+ Url::parse(&format!("ws://localhost:9001/runCase?case={}&agent={}", case, AGENT)).unwrap();
+ let (mut socket, _) = connect(case_url)?;
+ loop {
+ match socket.read()? {
+ msg @ Message::Text(_) | msg @ Message::Binary(_) => {
+ socket.send(msg)?;
+ }
+ Message::Ping(_) | Message::Pong(_) | Message::Close(_) | Message::Frame(_) => {}
+ }
+ }
+}
+
+fn main() {
+ env_logger::init();
+
+ let total = get_case_count().unwrap();
+
+ for case in 1..=total {
+ if let Err(e) = run_test(case) {
+ match e {
+ Error::ConnectionClosed | Error::Protocol(_) | Error::Utf8 => (),
+ err => error!("test: {}", err),
+ }
+ }
+ }
+
+ update_reports().unwrap();
+}
diff --git a/crates/tungstenite/examples/autobahn-server.rs b/crates/tungstenite/examples/autobahn-server.rs
new file mode 100644
index 0000000..dafe37b
--- /dev/null
+++ b/crates/tungstenite/examples/autobahn-server.rs
@@ -0,0 +1,47 @@
+use std::{
+ net::{TcpListener, TcpStream},
+ thread::spawn,
+};
+
+use log::*;
+use tungstenite::{accept, handshake::HandshakeRole, Error, HandshakeError, Message, Result};
+
+fn must_not_block<Role: HandshakeRole>(err: HandshakeError<Role>) -> Error {
+ match err {
+ HandshakeError::Interrupted(_) => panic!("Bug: blocking socket would block"),
+ HandshakeError::Failure(f) => f,
+ }
+}
+
+fn handle_client(stream: TcpStream) -> Result<()> {
+ let mut socket = accept(stream).map_err(must_not_block)?;
+ info!("Running test");
+ loop {
+ match socket.read()? {
+ msg @ Message::Text(_) | msg @ Message::Binary(_) => {
+ socket.send(msg)?;
+ }
+ Message::Ping(_) | Message::Pong(_) | Message::Close(_) | Message::Frame(_) => {}
+ }
+ }
+}
+
+fn main() {
+ env_logger::init();
+
+ let server = TcpListener::bind("127.0.0.1:9002").unwrap();
+
+ for stream in server.incoming() {
+ spawn(move || match stream {
+ Ok(stream) => {
+ if let Err(err) = handle_client(stream) {
+ match err {
+ Error::ConnectionClosed | Error::Protocol(_) | Error::Utf8 => (),
+ e => error!("test: {}", e),
+ }
+ }
+ }
+ Err(e) => error!("Error accepting stream: {}", e),
+ });
+ }
+}
diff --git a/crates/tungstenite/examples/callback-error.rs b/crates/tungstenite/examples/callback-error.rs
new file mode 100644
index 0000000..cf78a2e
--- /dev/null
+++ b/crates/tungstenite/examples/callback-error.rs
@@ -0,0 +1,23 @@
+use std::{net::TcpListener, thread::spawn};
+
+use tungstenite::{
+ accept_hdr,
+ handshake::server::{Request, Response},
+ http::StatusCode,
+};
+
+fn main() {
+ let server = TcpListener::bind("127.0.0.1:3012").unwrap();
+ for stream in server.incoming() {
+ spawn(move || {
+ let callback = |_req: &Request, _resp| {
+ let resp = Response::builder()
+ .status(StatusCode::FORBIDDEN)
+ .body(Some("Access denied".into()))
+ .unwrap();
+ Err(resp)
+ };
+ accept_hdr(stream.unwrap(), callback).unwrap_err();
+ });
+ }
+}
diff --git a/crates/tungstenite/examples/client.rs b/crates/tungstenite/examples/client.rs
new file mode 100644
index 0000000..a24f316
--- /dev/null
+++ b/crates/tungstenite/examples/client.rs
@@ -0,0 +1,23 @@
+use tungstenite::{connect, Message};
+use url::Url;
+
+fn main() {
+ env_logger::init();
+
+ let (mut socket, response) =
+ connect(Url::parse("ws://localhost:3012/socket").unwrap()).expect("Can't connect");
+
+ println!("Connected to the server");
+ println!("Response HTTP code: {}", response.status());
+ println!("Response contains the following headers:");
+ for (ref header, _value) in response.headers() {
+ println!("* {}", header);
+ }
+
+ socket.send(Message::Text("Hello WebSocket".into())).unwrap();
+ loop {
+ let msg = socket.read().expect("Error reading message");
+ println!("Received: {}", msg);
+ }
+ // socket.close(None);
+}
diff --git a/crates/tungstenite/examples/server.rs b/crates/tungstenite/examples/server.rs
new file mode 100644
index 0000000..2183b96
--- /dev/null
+++ b/crates/tungstenite/examples/server.rs
@@ -0,0 +1,38 @@
+use std::{net::TcpListener, thread::spawn};
+
+use tungstenite::{
+ accept_hdr,
+ handshake::server::{Request, Response},
+};
+
+fn main() {
+ env_logger::init();
+ let server = TcpListener::bind("127.0.0.1:3012").unwrap();
+ for stream in server.incoming() {
+ spawn(move || {
+ let callback = |req: &Request, mut response: Response| {
+ println!("Received a new ws handshake");
+ println!("The request's path is: {}", req.uri().path());
+ println!("The request's headers are:");
+ for (ref header, _value) in req.headers() {
+ println!("* {}", header);
+ }
+
+ // Let's add an additional header to our response to the client.
+ let headers = response.headers_mut();
+ headers.append("MyCustomHeader", ":)".parse().unwrap());
+ headers.append("SOME_TUNGSTENITE_HEADER", "header_value".parse().unwrap());
+
+ Ok(response)
+ };
+ let mut websocket = accept_hdr(stream.unwrap(), callback).unwrap();
+
+ loop {
+ let msg = websocket.read().unwrap();
+ if msg.is_binary() || msg.is_text() {
+ websocket.send(msg).unwrap();
+ }
+ }
+ });
+ }
+}
diff --git a/crates/tungstenite/examples/srv_accept_unmasked_frames.rs b/crates/tungstenite/examples/srv_accept_unmasked_frames.rs
new file mode 100644
index 0000000..b65e4f7
--- /dev/null
+++ b/crates/tungstenite/examples/srv_accept_unmasked_frames.rs
@@ -0,0 +1,48 @@
+use std::{net::TcpListener, thread::spawn};
+use tungstenite::{
+ accept_hdr_with_config,
+ handshake::server::{Request, Response},
+ protocol::WebSocketConfig,
+};
+
+fn main() {
+ env_logger::init();
+ let server = TcpListener::bind("127.0.0.1:3012").unwrap();
+ for stream in server.incoming() {
+ spawn(move || {
+ let callback = |req: &Request, mut response: Response| {
+ println!("Received a new ws handshake");
+ println!("The request's path is: {}", req.uri().path());
+ println!("The request's headers are:");
+ for (ref header, _value) in req.headers() {
+ println!("* {}", header);
+ }
+
+ // Let's add an additional header to our response to the client.
+ let headers = response.headers_mut();
+ headers.append("MyCustomHeader", ":)".parse().unwrap());
+ headers.append("SOME_TUNGSTENITE_HEADER", "header_value".parse().unwrap());
+
+ Ok(response)
+ };
+
+ let config = Some(WebSocketConfig {
+ // This setting allows to accept client frames which are not masked
+ // This is not in compliance with RFC 6455 but might be handy in some
+ // rare cases where it is necessary to integrate with existing/legacy
+ // clients which are sending unmasked frames
+ accept_unmasked_frames: true,
+ ..<_>::default()
+ });
+
+ let mut websocket = accept_hdr_with_config(stream.unwrap(), callback, config).unwrap();
+
+ loop {
+ let msg = websocket.read().unwrap();
+ if msg.is_binary() || msg.is_text() {
+ println!("received message {}", msg);
+ }
+ }
+ });
+ }
+}
diff --git a/crates/tungstenite/src/buffer.rs b/crates/tungstenite/src/buffer.rs
new file mode 100644
index 0000000..a5e7490
--- /dev/null
+++ b/crates/tungstenite/src/buffer.rs
@@ -0,0 +1,125 @@
+//! A buffer for reading data from the network.
+//!
+//! The `ReadBuffer` is a buffer of bytes similar to a first-in, first-out queue.
+//! It is filled by reading from a stream supporting `Read` and is then
+//! accessible as a cursor for reading bytes.
+
+use std::io::{Cursor, Read, Result as IoResult};
+
+use bytes::Buf;
+
+/// A FIFO buffer for reading packets from the network.
+#[derive(Debug)]
+pub struct ReadBuffer<const CHUNK_SIZE: usize> {
+ storage: Cursor<Vec<u8>>,
+ chunk: Box<[u8; CHUNK_SIZE]>,
+}
+
+impl<const CHUNK_SIZE: usize> ReadBuffer<CHUNK_SIZE> {
+ /// Create a new empty input buffer.
+ pub fn new() -> Self {
+ Self::with_capacity(CHUNK_SIZE)
+ }
+
+ /// Create a new empty input buffer with a given `capacity`.
+ pub fn with_capacity(capacity: usize) -> Self {
+ Self::from_partially_read(Vec::with_capacity(capacity))
+ }
+
+ /// Create a input buffer filled with previously read data.
+ pub fn from_partially_read(part: Vec<u8>) -> Self {
+ Self { storage: Cursor::new(part), chunk: Box::new([0; CHUNK_SIZE]) }
+ }
+
+ /// Get a cursor to the data storage.
+ pub fn as_cursor(&self) -> &Cursor<Vec<u8>> {
+ &self.storage
+ }
+
+ /// Get a cursor to the mutable data storage.
+ pub fn as_cursor_mut(&mut self) -> &mut Cursor<Vec<u8>> {
+ &mut self.storage
+ }
+
+ /// Consume the `ReadBuffer` and get the internal storage.
+ pub fn into_vec(mut self) -> Vec<u8> {
+ // Current implementation of `tungstenite-rs` expects that the `into_vec()` drains
+ // the data from the container that has already been read by the cursor.
+ self.clean_up();
+
+ // Now we can safely return the internal container.
+ self.storage.into_inner()
+ }
+
+ /// Read next portion of data from the given input stream.
+ pub fn read_from<S: Read>(&mut self, stream: &mut S) -> IoResult<usize> {
+ self.clean_up();
+ let size = stream.read(&mut *self.chunk)?;
+ self.storage.get_mut().extend_from_slice(&self.chunk[..size]);
+ Ok(size)
+ }
+
+ /// Cleans ups the part of the vector that has been already read by the cursor.
+ fn clean_up(&mut self) {
+ let pos = self.storage.position() as usize;
+ self.storage.get_mut().drain(0..pos).count();
+ self.storage.set_position(0);
+ }
+}
+
+impl<const CHUNK_SIZE: usize> Buf for ReadBuffer<CHUNK_SIZE> {
+ fn remaining(&self) -> usize {
+ Buf::remaining(self.as_cursor())
+ }
+
+ fn chunk(&self) -> &[u8] {
+ Buf::chunk(self.as_cursor())
+ }
+
+ fn advance(&mut self, cnt: usize) {
+ Buf::advance(self.as_cursor_mut(), cnt)
+ }
+}
+
+impl<const CHUNK_SIZE: usize> Default for ReadBuffer<CHUNK_SIZE> {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn simple_reading() {
+ let mut input = Cursor::new(b"Hello World!".to_vec());
+ let mut buffer = ReadBuffer::<4096>::new();
+ let size = buffer.read_from(&mut input).unwrap();
+ assert_eq!(size, 12);
+ assert_eq!(buffer.chunk(), b"Hello World!");
+ }
+
+ #[test]
+ fn reading_in_chunks() {
+ let mut inp = Cursor::new(b"Hello World!".to_vec());
+ let mut buf = ReadBuffer::<4>::new();
+
+ let size = buf.read_from(&mut inp).unwrap();
+ assert_eq!(size, 4);
+ assert_eq!(buf.chunk(), b"Hell");
+
+ buf.advance(2);
+ assert_eq!(buf.chunk(), b"ll");
+ assert_eq!(buf.storage.get_mut(), b"Hell");
+
+ let size = buf.read_from(&mut inp).unwrap();
+ assert_eq!(size, 4);
+ assert_eq!(buf.chunk(), b"llo Wo");
+ assert_eq!(buf.storage.get_mut(), b"llo Wo");
+
+ let size = buf.read_from(&mut inp).unwrap();
+ assert_eq!(size, 4);
+ assert_eq!(buf.chunk(), b"llo World!");
+ }
+}
diff --git a/crates/tungstenite/src/client.rs b/crates/tungstenite/src/client.rs
new file mode 100644
index 0000000..9b30037
--- /dev/null
+++ b/crates/tungstenite/src/client.rs
@@ -0,0 +1,267 @@
+//! Methods to connect to a WebSocket as a client.
+
+use std::{
+ io::{Read, Write},
+ net::{SocketAddr, TcpStream, ToSocketAddrs},
+ result::Result as StdResult,
+};
+
+use http::{request::Parts, Uri};
+use log::*;
+
+use url::Url;
+
+use crate::{
+ handshake::client::{generate_key, Request, Response},
+ protocol::WebSocketConfig,
+ stream::MaybeTlsStream,
+};
+
+use crate::{
+ error::{Error, Result, UrlError},
+ handshake::{client::ClientHandshake, HandshakeError},
+ protocol::WebSocket,
+ stream::{Mode, NoDelay},
+};
+
+/// Connect to the given WebSocket in blocking mode.
+///
+/// Uses a websocket configuration passed as an argument to the function. Calling it with `None` is
+/// equal to calling `connect()` function.
+///
+/// The URL may be either ws:// or wss://.
+/// To support wss:// URLs, you must activate the TLS feature on the crate level. Please refer to the
+/// project's [README][readme] for more information on available features.
+///
+/// This function "just works" for those who wants a simple blocking solution
+/// similar to `std::net::TcpStream`. If you want a non-blocking or other
+/// custom stream, call `client` instead.
+///
+/// This function uses `native_tls` or `rustls` to do TLS depending on the feature flags enabled. If
+/// you want to use other TLS libraries, use `client` instead. There is no need to enable any of
+/// the `*-tls` features if you don't call `connect` since it's the only function that uses them.
+///
+/// [readme]: https://github.com/snapview/tungstenite-rs/#features
+pub fn connect_with_config<Req: IntoClientRequest>(
+ request: Req,
+ config: Option<WebSocketConfig>,
+ max_redirects: u8,
+) -> Result<(WebSocket<MaybeTlsStream<TcpStream>>, Response)> {
+ fn try_client_handshake(
+ request: Request,
+ config: Option<WebSocketConfig>,
+ ) -> Result<(WebSocket<MaybeTlsStream<TcpStream>>, Response)> {
+ let uri = request.uri();
+ let mode = uri_mode(uri)?;
+ let host = request.uri().host().ok_or(Error::Url(UrlError::NoHostName))?;
+ let host = if host.starts_with('[') { &host[1..host.len() - 1] } else { host };
+ let port = uri.port_u16().unwrap_or(match mode {
+ Mode::Plain => 80,
+ Mode::Tls => 443,
+ });
+ let addrs = (host, port).to_socket_addrs()?;
+ let mut stream = connect_to_some(addrs.as_slice(), request.uri())?;
+ NoDelay::set_nodelay(&mut stream, true)?;
+
+ #[cfg(not(any(feature = "native-tls", feature = "__rustls-tls")))]
+ let client = client_with_config(request, MaybeTlsStream::Plain(stream), config);
+ #[cfg(any(feature = "native-tls", feature = "__rustls-tls"))]
+ let client = crate::tls::client_tls_with_config(request, stream, config, None);
+
+ client.map_err(|e| match e {
+ HandshakeError::Failure(f) => f,
+ HandshakeError::Interrupted(_) => panic!("Bug: blocking handshake not blocked"),
+ })
+ }
+
+ fn create_request(parts: &Parts, uri: &Uri) -> Request {
+ let mut builder =
+ Request::builder().uri(uri.clone()).method(parts.method.clone()).version(parts.version);
+ *builder.headers_mut().expect("Failed to create `Request`") = parts.headers.clone();
+ builder.body(()).expect("Failed to create `Request`")
+ }
+
+ let (parts, _) = request.into_client_request()?.into_parts();
+ let mut uri = parts.uri.clone();
+
+ for attempt in 0..(max_redirects + 1) {
+ let request = create_request(&parts, &uri);
+
+ match try_client_handshake(request, config) {
+ Err(Error::Http(res)) if res.status().is_redirection() && attempt < max_redirects => {
+ if let Some(location) = res.headers().get("Location") {
+ uri = location.to_str()?.parse::<Uri>()?;
+ debug!("Redirecting to {:?}", uri);
+ continue;
+ } else {
+ warn!("No `Location` found in redirect");
+ return Err(Error::Http(res));
+ }
+ }
+ other => return other,
+ }
+ }
+
+ unreachable!("Bug in a redirect handling logic")
+}
+
+/// Connect to the given WebSocket in blocking mode.
+///
+/// The URL may be either ws:// or wss://.
+/// To support wss:// URLs, feature `native-tls` or `rustls-tls` must be turned on.
+///
+/// This function "just works" for those who wants a simple blocking solution
+/// similar to `std::net::TcpStream`. If you want a non-blocking or other
+/// custom stream, call `client` instead.
+///
+/// This function uses `native_tls` or `rustls` to do TLS depending on the feature flags enabled. If
+/// you want to use other TLS libraries, use `client` instead. There is no need to enable any of
+/// the `*-tls` features if you don't call `connect` since it's the only function that uses them.
+pub fn connect<Req: IntoClientRequest>(
+ request: Req,
+) -> Result<(WebSocket<MaybeTlsStream<TcpStream>>, Response)> {
+ connect_with_config(request, None, 3)
+}
+
+fn connect_to_some(addrs: &[SocketAddr], uri: &Uri) -> Result<TcpStream> {
+ for addr in addrs {
+ debug!("Trying to contact {} at {}...", uri, addr);
+ if let Ok(stream) = TcpStream::connect(addr) {
+ return Ok(stream);
+ }
+ }
+ Err(Error::Url(UrlError::UnableToConnect(uri.to_string())))
+}
+
+/// Get the mode of the given URL.
+///
+/// This function may be used to ease the creation of custom TLS streams
+/// in non-blocking algorithms or for use with TLS libraries other than `native_tls` or `rustls`.
+pub fn uri_mode(uri: &Uri) -> Result<Mode> {
+ match uri.scheme_str() {
+ Some("ws") => Ok(Mode::Plain),
+ Some("wss") => Ok(Mode::Tls),
+ _ => Err(Error::Url(UrlError::UnsupportedUrlScheme)),
+ }
+}
+
+/// Do the client handshake over the given stream given a web socket configuration. Passing `None`
+/// as configuration is equal to calling `client()` function.
+///
+/// Use this function if you need a nonblocking handshake support or if you
+/// want to use a custom stream like `mio::net::TcpStream` or `openssl::ssl::SslStream`.
+/// Any stream supporting `Read + Write` will do.
+pub fn client_with_config<Stream, Req>(
+ request: Req,
+ stream: Stream,
+ config: Option<WebSocketConfig>,
+) -> StdResult<(WebSocket<Stream>, Response), HandshakeError<ClientHandshake<Stream>>>
+where
+ Stream: Read + Write,
+ Req: IntoClientRequest,
+{
+ ClientHandshake::start(stream, request.into_client_request()?, config)?.handshake()
+}
+
+/// Do the client handshake over the given stream.
+///
+/// Use this function if you need a nonblocking handshake support or if you
+/// want to use a custom stream like `mio::net::TcpStream` or `openssl::ssl::SslStream`.
+/// Any stream supporting `Read + Write` will do.
+pub fn client<Stream, Req>(
+ request: Req,
+ stream: Stream,
+) -> StdResult<(WebSocket<Stream>, Response), HandshakeError<ClientHandshake<Stream>>>
+where
+ Stream: Read + Write,
+ Req: IntoClientRequest,
+{
+ client_with_config(request, stream, None)
+}
+
+/// Trait for converting various types into HTTP requests used for a client connection.
+///
+/// This trait is implemented by default for string slices, strings, `url::Url`, `http::Uri` and
+/// `http::Request<()>`. Note that the implementation for `http::Request<()>` is trivial and will
+/// simply take your request and pass it as is further without altering any headers or URLs, so
+/// be aware of this. If you just want to connect to the endpoint with a certain URL, better pass
+/// a regular string containing the URL in which case `tungstenite-rs` will take care for generating
+/// the proper `http::Request<()>` for you.
+pub trait IntoClientRequest {
+ /// Convert into a `Request` that can be used for a client connection.
+ fn into_client_request(self) -> Result<Request>;
+}
+
+impl<'a> IntoClientRequest for &'a str {
+ fn into_client_request(self) -> Result<Request> {
+ self.parse::<Uri>()?.into_client_request()
+ }
+}
+
+impl<'a> IntoClientRequest for &'a String {
+ fn into_client_request(self) -> Result<Request> {
+ <&str as IntoClientRequest>::into_client_request(self)
+ }
+}
+
+impl IntoClientRequest for String {
+ fn into_client_request(self) -> Result<Request> {
+ <&str as IntoClientRequest>::into_client_request(&self)
+ }
+}
+
+impl<'a> IntoClientRequest for &'a Uri {
+ fn into_client_request(self) -> Result<Request> {
+ self.clone().into_client_request()
+ }
+}
+
+impl IntoClientRequest for Uri {
+ fn into_client_request(self) -> Result<Request> {
+ let authority = self.authority().ok_or(Error::Url(UrlError::NoHostName))?.as_str();
+ let host = authority
+ .find('@')
+ .map(|idx| authority.split_at(idx + 1).1)
+ .unwrap_or_else(|| authority);
+
+ if host.is_empty() {
+ return Err(Error::Url(UrlError::EmptyHostName));
+ }
+
+ let req = Request::builder()
+ .method("GET")
+ .header("Host", host)
+ .header("Connection", "Upgrade")
+ .header("Upgrade", "websocket")
+ .header("Sec-WebSocket-Version", "13")
+ .header("Sec-WebSocket-Key", generate_key())
+ .uri(self)
+ .body(())?;
+ Ok(req)
+ }
+}
+
+impl<'a> IntoClientRequest for &'a Url {
+ fn into_client_request(self) -> Result<Request> {
+ self.as_str().into_client_request()
+ }
+}
+
+impl IntoClientRequest for Url {
+ fn into_client_request(self) -> Result<Request> {
+ self.as_str().into_client_request()
+ }
+}
+
+impl IntoClientRequest for Request {
+ fn into_client_request(self) -> Result<Request> {
+ Ok(self)
+ }
+}
+
+impl<'h, 'b> IntoClientRequest for httparse::Request<'h, 'b> {
+ fn into_client_request(self) -> Result<Request> {
+ use crate::handshake::headers::FromHttparse;
+ Request::from_httparse(self)
+ }
+}
diff --git a/crates/tungstenite/src/error.rs b/crates/tungstenite/src/error.rs
new file mode 100644
index 0000000..faea80b
--- /dev/null
+++ b/crates/tungstenite/src/error.rs
@@ -0,0 +1,281 @@
+//! Error handling.
+
+use std::{io, result, str, string};
+
+use crate::protocol::{frame::coding::Data, Message};
+#[cfg(feature = "handshake")]
+use http::{header::HeaderName, Response};
+use thiserror::Error;
+
+/// Result type of all Tungstenite library calls.
+pub type Result<T, E = Error> = result::Result<T, E>;
+
+/// Possible WebSocket errors.
+#[derive(Error, Debug)]
+pub enum Error {
+ /// WebSocket connection closed normally. This informs you of the close.
+ /// It's not an error as such and nothing wrong happened.
+ ///
+ /// This is returned as soon as the close handshake is finished (we have both sent and
+ /// received a close frame) on the server end and as soon as the server has closed the
+ /// underlying connection if this endpoint is a client.
+ ///
+ /// Thus when you receive this, it is safe to drop the underlying connection.
+ ///
+ /// Receiving this error means that the WebSocket object is not usable anymore and the
+ /// only meaningful action with it is dropping it.
+ #[error("Connection closed normally")]
+ ConnectionClosed,
+ /// Trying to work with already closed connection.
+ ///
+ /// Trying to read or write after receiving `ConnectionClosed` causes this.
+ ///
+ /// As opposed to `ConnectionClosed`, this indicates your code tries to operate on the
+ /// connection when it really shouldn't anymore, so this really indicates a programmer
+ /// error on your part.
+ #[error("Trying to work with closed connection")]
+ AlreadyClosed,
+ /// Input-output error. Apart from WouldBlock, these are generally errors with the
+ /// underlying connection and you should probably consider them fatal.
+ #[error("IO error: {0}")]
+ Io(#[from] io::Error),
+ /// TLS error.
+ ///
+ /// Note that this error variant is enabled unconditionally even if no TLS feature is enabled,
+ /// to provide a feature-agnostic API surface.
+ #[error("TLS error: {0}")]
+ Tls(#[from] TlsError),
+ /// - When reading: buffer capacity exhausted.
+ /// - When writing: your message is bigger than the configured max message size
+ /// (64MB by default).
+ #[error("Space limit exceeded: {0}")]
+ Capacity(#[from] CapacityError),
+ /// Protocol violation.
+ #[error("WebSocket protocol error: {0}")]
+ Protocol(#[from] ProtocolError),
+ /// Message write buffer is full.
+ #[error("Write buffer is full")]
+ WriteBufferFull(Message),
+ /// UTF coding error.
+ #[error("UTF-8 encoding error")]
+ Utf8,
+ /// Attack attempt detected.
+ #[error("Attack attempt detected")]
+ AttackAttempt,
+ /// Invalid URL.
+ #[error("URL error: {0}")]
+ Url(#[from] UrlError),
+ /// HTTP error.
+ #[error("HTTP error: {}", .0.status())]
+ #[cfg(feature = "handshake")]
+ Http(Response<Option<Vec<u8>>>),
+ /// HTTP format error.
+ #[error("HTTP format error: {0}")]
+ #[cfg(feature = "handshake")]
+ HttpFormat(#[from] http::Error),
+}
+
+impl From<str::Utf8Error> for Error {
+ fn from(_: str::Utf8Error) -> Self {
+ Error::Utf8
+ }
+}
+
+impl From<string::FromUtf8Error> for Error {
+ fn from(_: string::FromUtf8Error) -> Self {
+ Error::Utf8
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<http::header::InvalidHeaderValue> for Error {
+ fn from(err: http::header::InvalidHeaderValue) -> Self {
+ Error::HttpFormat(err.into())
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<http::header::InvalidHeaderName> for Error {
+ fn from(err: http::header::InvalidHeaderName) -> Self {
+ Error::HttpFormat(err.into())
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<http::header::ToStrError> for Error {
+ fn from(_: http::header::ToStrError) -> Self {
+ Error::Utf8
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<http::uri::InvalidUri> for Error {
+ fn from(err: http::uri::InvalidUri) -> Self {
+ Error::HttpFormat(err.into())
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<http::status::InvalidStatusCode> for Error {
+ fn from(err: http::status::InvalidStatusCode) -> Self {
+ Error::HttpFormat(err.into())
+ }
+}
+
+#[cfg(feature = "handshake")]
+impl From<httparse::Error> for Error {
+ fn from(err: httparse::Error) -> Self {
+ match err {
+ httparse::Error::TooManyHeaders => Error::Capacity(CapacityError::TooManyHeaders),
+ e => Error::Protocol(ProtocolError::HttparseError(e)),
+ }
+ }
+}
+
+/// Indicates the specific type/cause of a capacity error.
+#[derive(Error, Debug, PartialEq, Eq, Clone, Copy)]
+pub enum CapacityError {
+ /// Too many headers provided (see [`httparse::Error::TooManyHeaders`]).
+ #[error("Too many headers")]
+ TooManyHeaders,
+ /// Received header is too long.
+ /// Message is bigger than the maximum allowed size.
+ #[error("Message too long: {size} > {max_size}")]
+ MessageTooLong {
+ /// The size of the message.
+ size: usize,
+ /// The maximum allowed message size.
+ max_size: usize,
+ },
+}
+
+/// Indicates the specific type/cause of a protocol error.
+#[allow(missing_copy_implementations)]
+#[derive(Error, Debug, PartialEq, Eq, Clone)]
+pub enum ProtocolError {
+ /// Use of the wrong HTTP method (the WebSocket protocol requires the GET method be used).
+ #[error("Unsupported HTTP method used - only GET is allowed")]
+ WrongHttpMethod,
+ /// Wrong HTTP version used (the WebSocket protocol requires version 1.1 or higher).
+ #[error("HTTP version must be 1.1 or higher")]
+ WrongHttpVersion,
+ /// Missing `Connection: upgrade` HTTP header.
+ #[error("No \"Connection: upgrade\" header")]
+ MissingConnectionUpgradeHeader,
+ /// Missing `Upgrade: websocket` HTTP header.
+ #[error("No \"Upgrade: websocket\" header")]
+ MissingUpgradeWebSocketHeader,
+ /// Missing `Sec-WebSocket-Version: 13` HTTP header.
+ #[error("No \"Sec-WebSocket-Version: 13\" header")]
+ MissingSecWebSocketVersionHeader,
+ /// Missing `Sec-WebSocket-Key` HTTP header.
+ #[error("No \"Sec-WebSocket-Key\" header")]
+ MissingSecWebSocketKey,
+ /// The `Sec-WebSocket-Accept` header is either not present or does not specify the correct key value.
+ #[error("Key mismatch in \"Sec-WebSocket-Accept\" header")]
+ SecWebSocketAcceptKeyMismatch,
+ /// Garbage data encountered after client request.
+ #[error("Junk after client request")]
+ JunkAfterRequest,
+ /// Custom responses must be unsuccessful.
+ #[error("Custom response must not be successful")]
+ CustomResponseSuccessful,
+ /// Invalid header is passed. Or the header is missing in the request. Or not present at all. Check the request that you pass.
+ #[error("Missing, duplicated or incorrect header {0}")]
+ #[cfg(feature = "handshake")]
+ InvalidHeader(HeaderName),
+ /// No more data while still performing handshake.
+ #[error("Handshake not finished")]
+ HandshakeIncomplete,
+ /// Wrapper around a [`httparse::Error`] value.
+ #[error("httparse error: {0}")]
+ #[cfg(feature = "handshake")]
+ HttparseError(#[from] httparse::Error),
+ /// Not allowed to send after having sent a closing frame.
+ #[error("Sending after closing is not allowed")]
+ SendAfterClosing,
+ /// Remote sent data after sending a closing frame.
+ #[error("Remote sent after having closed")]
+ ReceivedAfterClosing,
+ /// Reserved bits in frame header are non-zero.
+ #[error("Reserved bits are non-zero")]
+ NonZeroReservedBits,
+ /// The server must close the connection when an unmasked frame is received.
+ #[error("Received an unmasked frame from client")]
+ UnmaskedFrameFromClient,
+ /// The client must close the connection when a masked frame is received.
+ #[error("Received a masked frame from server")]
+ MaskedFrameFromServer,
+ /// Control frames must not be fragmented.
+ #[error("Fragmented control frame")]
+ FragmentedControlFrame,
+ /// Control frames must have a payload of 125 bytes or less.
+ #[error("Control frame too big (payload must be 125 bytes or less)")]
+ ControlFrameTooBig,
+ /// Type of control frame not recognised.
+ #[error("Unknown control frame type: {0}")]
+ UnknownControlFrameType(u8),
+ /// Type of data frame not recognised.
+ #[error("Unknown data frame type: {0}")]
+ UnknownDataFrameType(u8),
+ /// Received a continue frame despite there being nothing to continue.
+ #[error("Continue frame but nothing to continue")]
+ UnexpectedContinueFrame,
+ /// Received data while waiting for more fragments.
+ #[error("While waiting for more fragments received: {0}")]
+ ExpectedFragment(Data),
+ /// Connection closed without performing the closing handshake.
+ #[error("Connection reset without closing handshake")]
+ ResetWithoutClosingHandshake,
+ /// Encountered an invalid opcode.
+ #[error("Encountered invalid opcode: {0}")]
+ InvalidOpcode(u8),
+ /// The payload for the closing frame is invalid.
+ #[error("Invalid close sequence")]
+ InvalidCloseSequence,
+}
+
+/// Indicates the specific type/cause of URL error.
+#[derive(Error, Debug, PartialEq, Eq)]
+pub enum UrlError {
+ /// TLS is used despite not being compiled with the TLS feature enabled.
+ #[error("TLS support not compiled in")]
+ TlsFeatureNotEnabled,
+ /// The URL does not include a host name.
+ #[error("No host name in the URL")]
+ NoHostName,
+ /// Failed to connect with this URL.
+ #[error("Unable to connect to {0}")]
+ UnableToConnect(String),
+ /// Unsupported URL scheme used (only `ws://` or `wss://` may be used).
+ #[error("URL scheme not supported")]
+ UnsupportedUrlScheme,
+ /// The URL host name, though included, is empty.
+ #[error("URL contains empty host name")]
+ EmptyHostName,
+ /// The URL does not include a path/query.
+ #[error("No path/query in URL")]
+ NoPathOrQuery,
+}
+
+/// TLS errors.
+///
+/// Note that even if you enable only the rustls-based TLS support, the error at runtime could still
+/// be `Native`, as another crate in the dependency graph may enable native TLS support.
+#[allow(missing_copy_implementations)]
+#[derive(Error, Debug)]
+#[non_exhaustive]
+pub enum TlsError {
+ /// Native TLS error.
+ #[cfg(feature = "native-tls")]
+ #[error("native-tls error: {0}")]
+ Native(#[from] native_tls_crate::Error),
+ /// Rustls error.
+ #[cfg(feature = "__rustls-tls")]
+ #[error("rustls error: {0}")]
+ Rustls(#[from] rustls::Error),
+ /// DNS name resolution error.
+ #[cfg(feature = "__rustls-tls")]
+ #[error("Invalid DNS name")]
+ InvalidDnsName,
+}
diff --git a/crates/tungstenite/src/handshake/client.rs b/crates/tungstenite/src/handshake/client.rs
new file mode 100644
index 0000000..08cc7b2
--- /dev/null
+++ b/crates/tungstenite/src/handshake/client.rs
@@ -0,0 +1,359 @@
+//! Client handshake machine.
+
+use std::{
+ io::{Read, Write},
+ marker::PhantomData,
+};
+
+use http::{
+ header::HeaderName, HeaderMap, Request as HttpRequest, Response as HttpResponse, StatusCode,
+};
+use httparse::Status;
+use log::*;
+
+use super::{
+ derive_accept_key,
+ headers::{FromHttparse, MAX_HEADERS},
+ machine::{HandshakeMachine, StageResult, TryParse},
+ HandshakeRole, MidHandshake, ProcessingResult,
+};
+use crate::{
+ error::{Error, ProtocolError, Result, UrlError},
+ protocol::{Role, WebSocket, WebSocketConfig},
+};
+
+/// Client request type.
+pub type Request = HttpRequest<()>;
+
+/// Client response type.
+pub type Response = HttpResponse<Option<Vec<u8>>>;
+
+/// Client handshake role.
+#[derive(Debug)]
+pub struct ClientHandshake<S> {
+ verify_data: VerifyData,
+ config: Option<WebSocketConfig>,
+ _marker: PhantomData<S>,
+}
+
+impl<S: Read + Write> ClientHandshake<S> {
+ /// Initiate a client handshake.
+ pub fn start(
+ stream: S,
+ request: Request,
+ config: Option<WebSocketConfig>,
+ ) -> Result<MidHandshake<Self>> {
+ if request.method() != http::Method::GET {
+ return Err(Error::Protocol(ProtocolError::WrongHttpMethod));
+ }
+
+ if request.version() < http::Version::HTTP_11 {
+ return Err(Error::Protocol(ProtocolError::WrongHttpVersion));
+ }
+
+ // Check the URI scheme: only ws or wss are supported
+ let _ = crate::client::uri_mode(request.uri())?;
+
+ // Convert and verify the `http::Request` and turn it into the request as per RFC.
+ // Also extract the key from it (it must be present in a correct request).
+ let (request, key) = generate_request(request)?;
+
+ let machine = HandshakeMachine::start_write(stream, request);
+
+ let client = {
+ let accept_key = derive_accept_key(key.as_ref());
+ ClientHandshake { verify_data: VerifyData { accept_key }, config, _marker: PhantomData }
+ };
+
+ trace!("Client handshake initiated.");
+ Ok(MidHandshake { role: client, machine })
+ }
+}
+
+impl<S: Read + Write> HandshakeRole for ClientHandshake<S> {
+ type IncomingData = Response;
+ type InternalStream = S;
+ type FinalResult = (WebSocket<S>, Response);
+ fn stage_finished(
+ &mut self,
+ finish: StageResult<Self::IncomingData, Self::InternalStream>,
+ ) -> Result<ProcessingResult<Self::InternalStream, Self::FinalResult>> {
+ Ok(match finish {
+ StageResult::DoneWriting(stream) => {
+ ProcessingResult::Continue(HandshakeMachine::start_read(stream))
+ }
+ StageResult::DoneReading { stream, result, tail } => {
+ let result = match self.verify_data.verify_response(result) {
+ Ok(r) => r,
+ Err(Error::Http(mut e)) => {
+ *e.body_mut() = Some(tail);
+ return Err(Error::Http(e));
+ }
+ Err(e) => return Err(e),
+ };
+
+ debug!("Client handshake done.");
+ let websocket =
+ WebSocket::from_partially_read(stream, tail, Role::Client, self.config);
+ ProcessingResult::Done((websocket, result))
+ }
+ })
+ }
+}
+
+/// Verifies and generates a client WebSocket request from the original request and extracts a WebSocket key from it.
+pub fn generate_request(mut request: Request) -> Result<(Vec<u8>, String)> {
+ let mut req = Vec::new();
+ write!(
+ req,
+ "GET {path} {version:?}\r\n",
+ path = request.uri().path_and_query().ok_or(Error::Url(UrlError::NoPathOrQuery))?.as_str(),
+ version = request.version()
+ )
+ .unwrap();
+
+ // Headers that must be present in a correct request.
+ const KEY_HEADERNAME: &str = "Sec-WebSocket-Key";
+ const WEBSOCKET_HEADERS: [&str; 5] =
+ ["Host", "Connection", "Upgrade", "Sec-WebSocket-Version", KEY_HEADERNAME];
+
+ // We must extract a WebSocket key from a properly formed request or fail if it's not present.
+ let key = request
+ .headers()
+ .get(KEY_HEADERNAME)
+ .ok_or_else(|| {
+ Error::Protocol(ProtocolError::InvalidHeader(
+ HeaderName::from_bytes(KEY_HEADERNAME.as_bytes()).unwrap(),
+ ))
+ })?
+ .to_str()?
+ .to_owned();
+
+ // We must check that all necessary headers for a valid request are present. Note that we have to
+ // deal with the fact that some apps seem to have a case-sensitive check for headers which is not
+ // correct and should not considered the correct behavior, but it seems like some apps ignore it.
+ // `http` by default writes all headers in lower-case which is fine (and does not violate the RFC)
+ // but some servers seem to be poorely written and ignore RFC.
+ //
+ // See similar problem in `hyper`: https://github.com/hyperium/hyper/issues/1492
+ let headers = request.headers_mut();
+ for &header in &WEBSOCKET_HEADERS {
+ let value = headers.remove(header).ok_or_else(|| {
+ Error::Protocol(ProtocolError::InvalidHeader(
+ HeaderName::from_bytes(header.as_bytes()).unwrap(),
+ ))
+ })?;
+ write!(req, "{header}: {value}\r\n", header = header, value = value.to_str()?).unwrap();
+ }
+
+ // Now we must ensure that the headers that we've written once are not anymore present in the map.
+ // If they do, then the request is invalid (some headers are duplicated there for some reason).
+ let insensitive: Vec<String> =
+ WEBSOCKET_HEADERS.iter().map(|h| h.to_ascii_lowercase()).collect();
+ for (k, v) in headers {
+ let mut name = k.as_str();
+
+ // We have already written the necessary headers once (above) and removed them from the map.
+ // If we encounter them again, then the request is considered invalid and error is returned.
+ // Note that we can't use `.contains()`, since `&str` does not coerce to `&String` in Rust.
+ if insensitive.iter().any(|x| x == name) {
+ return Err(Error::Protocol(ProtocolError::InvalidHeader(k.clone())));
+ }
+
+ // Relates to the issue of some servers treating headers in a case-sensitive way, please see:
+ // https://github.com/snapview/tungstenite-rs/pull/119 (original fix of the problem)
+ if name == "sec-websocket-protocol" {
+ name = "Sec-WebSocket-Protocol";
+ }
+
+ if name == "origin" {
+ name = "Origin";
+ }
+
+ writeln!(req, "{}: {}\r", name, v.to_str()?).unwrap();
+ }
+
+ writeln!(req, "\r").unwrap();
+ trace!("Request: {:?}", String::from_utf8_lossy(&req));
+ Ok((req, key))
+}
+
+/// Information for handshake verification.
+#[derive(Debug)]
+struct VerifyData {
+ /// Accepted server key.
+ accept_key: String,
+}
+
+impl VerifyData {
+ pub fn verify_response(&self, response: Response) -> Result<Response> {
+ // 1. If the status code received from the server is not 101, the
+ // client handles the response per HTTP [RFC2616] procedures. (RFC 6455)
+ if response.status() != StatusCode::SWITCHING_PROTOCOLS {
+ return Err(Error::Http(response));
+ }
+
+ let headers = response.headers();
+
+ // 2. If the response lacks an |Upgrade| header field or the |Upgrade|
+ // header field contains a value that is not an ASCII case-
+ // insensitive match for the value "websocket", the client MUST
+ // _Fail the WebSocket Connection_. (RFC 6455)
+ if !headers
+ .get("Upgrade")
+ .and_then(|h| h.to_str().ok())
+ .map(|h| h.eq_ignore_ascii_case("websocket"))
+ .unwrap_or(false)
+ {
+ return Err(Error::Protocol(ProtocolError::MissingUpgradeWebSocketHeader));
+ }
+ // 3. If the response lacks a |Connection| header field or the
+ // |Connection| header field doesn't contain a token that is an
+ // ASCII case-insensitive match for the value "Upgrade", the client
+ // MUST _Fail the WebSocket Connection_. (RFC 6455)
+ if !headers
+ .get("Connection")
+ .and_then(|h| h.to_str().ok())
+ .map(|h| h.eq_ignore_ascii_case("Upgrade"))
+ .unwrap_or(false)
+ {
+ return Err(Error::Protocol(ProtocolError::MissingConnectionUpgradeHeader));
+ }
+ // 4. If the response lacks a |Sec-WebSocket-Accept| header field or
+ // the |Sec-WebSocket-Accept| contains a value other than the
+ // base64-encoded SHA-1 of ... the client MUST _Fail the WebSocket
+ // Connection_. (RFC 6455)
+ if !headers.get("Sec-WebSocket-Accept").map(|h| h == &self.accept_key).unwrap_or(false) {
+ return Err(Error::Protocol(ProtocolError::SecWebSocketAcceptKeyMismatch));
+ }
+ // 5. If the response includes a |Sec-WebSocket-Extensions| header
+ // field and this header field indicates the use of an extension
+ // that was not present in the client's handshake (the server has
+ // indicated an extension not requested by the client), the client
+ // MUST _Fail the WebSocket Connection_. (RFC 6455)
+ // TODO
+
+ // 6. If the response includes a |Sec-WebSocket-Protocol| header field
+ // and this header field indicates the use of a subprotocol that was
+ // not present in the client's handshake (the server has indicated a
+ // subprotocol not requested by the client), the client MUST _Fail
+ // the WebSocket Connection_. (RFC 6455)
+ // TODO
+
+ Ok(response)
+ }
+}
+
+impl TryParse for Response {
+ fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> {
+ let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS];
+ let mut req = httparse::Response::new(&mut hbuffer);
+ Ok(match req.parse(buf)? {
+ Status::Partial => None,
+ Status::Complete(size) => Some((size, Response::from_httparse(req)?)),
+ })
+ }
+}
+
+impl<'h, 'b: 'h> FromHttparse<httparse::Response<'h, 'b>> for Response {
+ fn from_httparse(raw: httparse::Response<'h, 'b>) -> Result<Self> {
+ if raw.version.expect("Bug: no HTTP version") < /*1.*/1 {
+ return Err(Error::Protocol(ProtocolError::WrongHttpVersion));
+ }
+
+ let headers = HeaderMap::from_httparse(raw.headers)?;
+
+ let mut response = Response::new(None);
+ *response.status_mut() = StatusCode::from_u16(raw.code.expect("Bug: no HTTP status code"))?;
+ *response.headers_mut() = headers;
+ // TODO: httparse only supports HTTP 0.9/1.0/1.1 but not HTTP 2.0
+ // so the only valid value we could get in the response would be 1.1.
+ *response.version_mut() = http::Version::HTTP_11;
+
+ Ok(response)
+ }
+}
+
+/// Generate a random key for the `Sec-WebSocket-Key` header.
+pub fn generate_key() -> String {
+ // a base64-encoded (see Section 4 of [RFC4648]) value that,
+ // when decoded, is 16 bytes in length (RFC 6455)
+ let r: [u8; 16] = rand::random();
+ data_encoding::BASE64.encode(&r)
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{super::machine::TryParse, generate_key, generate_request, Response};
+ use crate::client::IntoClientRequest;
+
+ #[test]
+ fn random_keys() {
+ let k1 = generate_key();
+ println!("Generated random key 1: {}", k1);
+ let k2 = generate_key();
+ println!("Generated random key 2: {}", k2);
+ assert_ne!(k1, k2);
+ assert_eq!(k1.len(), k2.len());
+ assert_eq!(k1.len(), 24);
+ assert_eq!(k2.len(), 24);
+ assert!(k1.ends_with("=="));
+ assert!(k2.ends_with("=="));
+ assert!(k1[..22].find('=').is_none());
+ assert!(k2[..22].find('=').is_none());
+ }
+
+ fn construct_expected(host: &str, key: &str) -> Vec<u8> {
+ format!(
+ "\
+ GET /getCaseCount HTTP/1.1\r\n\
+ Host: {host}\r\n\
+ Connection: Upgrade\r\n\
+ Upgrade: websocket\r\n\
+ Sec-WebSocket-Version: 13\r\n\
+ Sec-WebSocket-Key: {key}\r\n\
+ \r\n",
+ host = host,
+ key = key
+ )
+ .into_bytes()
+ }
+
+ #[test]
+ fn request_formatting() {
+ let request = "ws://localhost/getCaseCount".into_client_request().unwrap();
+ let (request, key) = generate_request(request).unwrap();
+ let correct = construct_expected("localhost", &key);
+ assert_eq!(&request[..], &correct[..]);
+ }
+
+ #[test]
+ fn request_formatting_with_host() {
+ let request = "wss://localhost:9001/getCaseCount".into_client_request().unwrap();
+ let (request, key) = generate_request(request).unwrap();
+ let correct = construct_expected("localhost:9001", &key);
+ assert_eq!(&request[..], &correct[..]);
+ }
+
+ #[test]
+ fn request_formatting_with_at() {
+ let request = "wss://user:pass@localhost:9001/getCaseCount".into_client_request().unwrap();
+ let (request, key) = generate_request(request).unwrap();
+ let correct = construct_expected("localhost:9001", &key);
+ assert_eq!(&request[..], &correct[..]);
+ }
+
+ #[test]
+ fn response_parsing() {
+ const DATA: &[u8] = b"HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n";
+ let (_, resp) = Response::try_parse(DATA).unwrap().unwrap();
+ assert_eq!(resp.status(), http::StatusCode::OK);
+ assert_eq!(resp.headers().get("Content-Type").unwrap(), &b"text/html"[..],);
+ }
+
+ #[test]
+ fn invalid_custom_request() {
+ let request = http::Request::builder().method("GET").body(()).unwrap();
+ assert!(generate_request(request).is_err());
+ }
+}
diff --git a/crates/tungstenite/src/handshake/headers.rs b/crates/tungstenite/src/handshake/headers.rs
new file mode 100644
index 0000000..f336c65
--- /dev/null
+++ b/crates/tungstenite/src/handshake/headers.rs
@@ -0,0 +1,81 @@
+//! HTTP Request and response header handling.
+
+use http::header::{HeaderMap, HeaderName, HeaderValue};
+use httparse::Status;
+
+use super::machine::TryParse;
+use crate::error::Result;
+
+/// Limit for the number of header lines.
+pub const MAX_HEADERS: usize = 124;
+
+/// Trait to convert raw objects into HTTP parseables.
+pub(crate) trait FromHttparse<T>: Sized {
+ /// Convert raw object into parsed HTTP headers.
+ fn from_httparse(raw: T) -> Result<Self>;
+}
+
+impl<'b: 'h, 'h> FromHttparse<&'b [httparse::Header<'h>]> for HeaderMap {
+ fn from_httparse(raw: &'b [httparse::Header<'h>]) -> Result<Self> {
+ let mut headers = HeaderMap::new();
+ for h in raw {
+ headers.append(
+ HeaderName::from_bytes(h.name.as_bytes())?,
+ HeaderValue::from_bytes(h.value)?,
+ );
+ }
+
+ Ok(headers)
+ }
+}
+impl TryParse for HeaderMap {
+ fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> {
+ let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS];
+ Ok(match httparse::parse_headers(buf, &mut hbuffer)? {
+ Status::Partial => None,
+ Status::Complete((size, hdr)) => Some((size, HeaderMap::from_httparse(hdr)?)),
+ })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+
+ use super::{super::machine::TryParse, HeaderMap};
+
+ #[test]
+ fn headers() {
+ const DATA: &[u8] = b"Host: foo.com\r\n\
+ Connection: Upgrade\r\n\
+ Upgrade: websocket\r\n\
+ \r\n";
+ let (_, hdr) = HeaderMap::try_parse(DATA).unwrap().unwrap();
+ assert_eq!(hdr.get("Host").unwrap(), &b"foo.com"[..]);
+ assert_eq!(hdr.get("Upgrade").unwrap(), &b"websocket"[..]);
+ assert_eq!(hdr.get("Connection").unwrap(), &b"Upgrade"[..]);
+ }
+
+ #[test]
+ fn headers_iter() {
+ const DATA: &[u8] = b"Host: foo.com\r\n\
+ Sec-WebSocket-Extensions: permessage-deflate\r\n\
+ Connection: Upgrade\r\n\
+ Sec-WebSocket-ExtenSIONS: permessage-unknown\r\n\
+ Upgrade: websocket\r\n\
+ \r\n";
+ let (_, hdr) = HeaderMap::try_parse(DATA).unwrap().unwrap();
+ let mut iter = hdr.get_all("Sec-WebSocket-Extensions").iter();
+ assert_eq!(iter.next().unwrap(), &b"permessage-deflate"[..]);
+ assert_eq!(iter.next().unwrap(), &b"permessage-unknown"[..]);
+ assert_eq!(iter.next(), None);
+ }
+
+ #[test]
+ fn headers_incomplete() {
+ const DATA: &[u8] = b"Host: foo.com\r\n\
+ Connection: Upgrade\r\n\
+ Upgrade: websocket\r\n";
+ let hdr = HeaderMap::try_parse(DATA).unwrap();
+ assert!(hdr.is_none());
+ }
+}
diff --git a/crates/tungstenite/src/handshake/machine.rs b/crates/tungstenite/src/handshake/machine.rs
new file mode 100644
index 0000000..2e3f2cb
--- /dev/null
+++ b/crates/tungstenite/src/handshake/machine.rs
@@ -0,0 +1,178 @@
+//! WebSocket handshake machine.
+
+use bytes::Buf;
+use log::*;
+use std::io::{Cursor, Read, Write};
+
+use crate::{
+ error::{Error, ProtocolError, Result},
+ util::NonBlockingResult,
+ ReadBuffer,
+};
+
+/// A generic handshake state machine.
+#[derive(Debug)]
+pub struct HandshakeMachine<Stream> {
+ stream: Stream,
+ state: HandshakeState,
+}
+
+impl<Stream> HandshakeMachine<Stream> {
+ /// Start reading data from the peer.
+ pub fn start_read(stream: Stream) -> Self {
+ Self { stream, state: HandshakeState::Reading(ReadBuffer::new(), AttackCheck::new()) }
+ }
+ /// Start writing data to the peer.
+ pub fn start_write<D: Into<Vec<u8>>>(stream: Stream, data: D) -> Self {
+ HandshakeMachine { stream, state: HandshakeState::Writing(Cursor::new(data.into())) }
+ }
+ /// Returns a shared reference to the inner stream.
+ pub fn get_ref(&self) -> &Stream {
+ &self.stream
+ }
+ /// Returns a mutable reference to the inner stream.
+ pub fn get_mut(&mut self) -> &mut Stream {
+ &mut self.stream
+ }
+}
+
+impl<Stream: Read + Write> HandshakeMachine<Stream> {
+ /// Perform a single handshake round.
+ pub fn single_round<Obj: TryParse>(mut self) -> Result<RoundResult<Obj, Stream>> {
+ trace!("Doing handshake round.");
+ match self.state {
+ HandshakeState::Reading(mut buf, mut attack_check) => {
+ let read = buf.read_from(&mut self.stream).no_block()?;
+ match read {
+ Some(0) => Err(Error::Protocol(ProtocolError::HandshakeIncomplete)),
+ Some(count) => {
+ attack_check.check_incoming_packet_size(count)?;
+ // TODO: this is slow for big headers with too many small packets.
+ // The parser has to be reworked in order to work on streams instead
+ // of buffers.
+ Ok(if let Some((size, obj)) = Obj::try_parse(Buf::chunk(&buf))? {
+ buf.advance(size);
+ RoundResult::StageFinished(StageResult::DoneReading {
+ result: obj,
+ stream: self.stream,
+ tail: buf.into_vec(),
+ })
+ } else {
+ RoundResult::Incomplete(HandshakeMachine {
+ state: HandshakeState::Reading(buf, attack_check),
+ ..self
+ })
+ })
+ }
+ None => Ok(RoundResult::WouldBlock(HandshakeMachine {
+ state: HandshakeState::Reading(buf, attack_check),
+ ..self
+ })),
+ }
+ }
+ HandshakeState::Writing(mut buf) => {
+ assert!(buf.has_remaining());
+ if let Some(size) = self.stream.write(Buf::chunk(&buf)).no_block()? {
+ assert!(size > 0);
+ buf.advance(size);
+ Ok(if buf.has_remaining() {
+ RoundResult::Incomplete(HandshakeMachine {
+ state: HandshakeState::Writing(buf),
+ ..self
+ })
+ } else {
+ RoundResult::StageFinished(StageResult::DoneWriting(self.stream))
+ })
+ } else {
+ Ok(RoundResult::WouldBlock(HandshakeMachine {
+ state: HandshakeState::Writing(buf),
+ ..self
+ }))
+ }
+ }
+ }
+ }
+}
+
+/// The result of the round.
+#[derive(Debug)]
+pub enum RoundResult<Obj, Stream> {
+ /// Round not done, I/O would block.
+ WouldBlock(HandshakeMachine<Stream>),
+ /// Round done, state unchanged.
+ Incomplete(HandshakeMachine<Stream>),
+ /// Stage complete.
+ StageFinished(StageResult<Obj, Stream>),
+}
+
+/// The result of the stage.
+#[derive(Debug)]
+pub enum StageResult<Obj, Stream> {
+ /// Reading round finished.
+ #[allow(missing_docs)]
+ DoneReading { result: Obj, stream: Stream, tail: Vec<u8> },
+ /// Writing round finished.
+ DoneWriting(Stream),
+}
+
+/// The parseable object.
+pub trait TryParse: Sized {
+ /// Return Ok(None) if incomplete, Err on syntax error.
+ fn try_parse(data: &[u8]) -> Result<Option<(usize, Self)>>;
+}
+
+/// The handshake state.
+#[derive(Debug)]
+enum HandshakeState {
+ /// Reading data from the peer.
+ Reading(ReadBuffer, AttackCheck),
+ /// Sending data to the peer.
+ Writing(Cursor<Vec<u8>>),
+}
+
+/// Attack mitigation. Contains counters needed to prevent DoS attacks
+/// and reject valid but useless headers.
+#[derive(Debug)]
+pub(crate) struct AttackCheck {
+ /// Number of HTTP header successful reads (TCP packets).
+ number_of_packets: usize,
+ /// Total number of bytes in HTTP header.
+ number_of_bytes: usize,
+}
+
+impl AttackCheck {
+ /// Initialize attack checking for incoming buffer.
+ fn new() -> Self {
+ Self { number_of_packets: 0, number_of_bytes: 0 }
+ }
+
+ /// Check the size of an incoming packet. To be called immediately after `read()`
+ /// passing its returned bytes count as `size`.
+ fn check_incoming_packet_size(&mut self, size: usize) -> Result<()> {
+ self.number_of_packets += 1;
+ self.number_of_bytes += size;
+
+ // TODO: these values are hardcoded. Instead of making them configurable,
+ // rework the way HTTP header is parsed to remove this check at all.
+ const MAX_BYTES: usize = 65536;
+ const MAX_PACKETS: usize = 512;
+ const MIN_PACKET_SIZE: usize = 128;
+ const MIN_PACKET_CHECK_THRESHOLD: usize = 64;
+
+ if self.number_of_bytes > MAX_BYTES {
+ return Err(Error::AttackAttempt);
+ }
+
+ if self.number_of_packets > MAX_PACKETS {
+ return Err(Error::AttackAttempt);
+ }
+
+ if self.number_of_packets > MIN_PACKET_CHECK_THRESHOLD
+ && self.number_of_packets * MIN_PACKET_SIZE > self.number_of_bytes
+ {
+ return Err(Error::AttackAttempt);
+ }
+
+ Ok(())
+ }
+}
diff --git a/crates/tungstenite/src/handshake/mod.rs b/crates/tungstenite/src/handshake/mod.rs
new file mode 100644
index 0000000..a8db9a9
--- /dev/null
+++ b/crates/tungstenite/src/handshake/mod.rs
@@ -0,0 +1,135 @@
+//! WebSocket handshake control.
+
+pub mod client;
+pub mod headers;
+pub mod machine;
+pub mod server;
+
+use std::{
+ error::Error as ErrorTrait,
+ fmt,
+ io::{Read, Write},
+};
+
+use sha1::{Digest, Sha1};
+
+use self::machine::{HandshakeMachine, RoundResult, StageResult, TryParse};
+use crate::error::Error;
+
+/// A WebSocket handshake.
+#[derive(Debug)]
+pub struct MidHandshake<Role: HandshakeRole> {
+ role: Role,
+ machine: HandshakeMachine<Role::InternalStream>,
+}
+
+impl<Role: HandshakeRole> MidHandshake<Role> {
+ /// Allow access to machine
+ pub fn get_ref(&self) -> &HandshakeMachine<Role::InternalStream> {
+ &self.machine
+ }
+
+ /// Allow mutable access to machine
+ pub fn get_mut(&mut self) -> &mut HandshakeMachine<Role::InternalStream> {
+ &mut self.machine
+ }
+
+ /// Restarts the handshake process.
+ pub fn handshake(mut self) -> Result<Role::FinalResult, HandshakeError<Role>> {
+ let mut mach = self.machine;
+ loop {
+ mach = match mach.single_round()? {
+ RoundResult::WouldBlock(m) => {
+ return Err(HandshakeError::Interrupted(MidHandshake { machine: m, ..self }))
+ }
+ RoundResult::Incomplete(m) => m,
+ RoundResult::StageFinished(s) => match self.role.stage_finished(s)? {
+ ProcessingResult::Continue(m) => m,
+ ProcessingResult::Done(result) => return Ok(result),
+ },
+ }
+ }
+ }
+}
+
+/// A handshake result.
+pub enum HandshakeError<Role: HandshakeRole> {
+ /// Handshake was interrupted (would block).
+ Interrupted(MidHandshake<Role>),
+ /// Handshake failed.
+ Failure(Error),
+}
+
+impl<Role: HandshakeRole> fmt::Debug for HandshakeError<Role> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ HandshakeError::Interrupted(_) => write!(f, "HandshakeError::Interrupted(...)"),
+ HandshakeError::Failure(ref e) => write!(f, "HandshakeError::Failure({:?})", e),
+ }
+ }
+}
+
+impl<Role: HandshakeRole> fmt::Display for HandshakeError<Role> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ HandshakeError::Interrupted(_) => write!(f, "Interrupted handshake (WouldBlock)"),
+ HandshakeError::Failure(ref e) => write!(f, "{}", e),
+ }
+ }
+}
+
+impl<Role: HandshakeRole> ErrorTrait for HandshakeError<Role> {}
+
+impl<Role: HandshakeRole> From<Error> for HandshakeError<Role> {
+ fn from(err: Error) -> Self {
+ HandshakeError::Failure(err)
+ }
+}
+
+/// Handshake role.
+pub trait HandshakeRole {
+ #[doc(hidden)]
+ type IncomingData: TryParse;
+ #[doc(hidden)]
+ type InternalStream: Read + Write;
+ #[doc(hidden)]
+ type FinalResult;
+ #[doc(hidden)]
+ fn stage_finished(
+ &mut self,
+ finish: StageResult<Self::IncomingData, Self::InternalStream>,
+ ) -> Result<ProcessingResult<Self::InternalStream, Self::FinalResult>, Error>;
+}
+
+/// Stage processing result.
+#[doc(hidden)]
+#[derive(Debug)]
+pub enum ProcessingResult<Stream, FinalResult> {
+ Continue(HandshakeMachine<Stream>),
+ Done(FinalResult),
+}
+
+/// Derive the `Sec-WebSocket-Accept` response header from a `Sec-WebSocket-Key` request header.
+///
+/// This function can be used to perform a handshake before passing a raw TCP stream to
+/// [`WebSocket::from_raw_socket`][crate::protocol::WebSocket::from_raw_socket].
+pub fn derive_accept_key(request_key: &[u8]) -> String {
+ // ... field is constructed by concatenating /key/ ...
+ // ... with the string "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" (RFC 6455)
+ const WS_GUID: &[u8] = b"258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
+ let mut sha1 = Sha1::default();
+ sha1.update(request_key);
+ sha1.update(WS_GUID);
+ data_encoding::BASE64.encode(&sha1.finalize())
+}
+
+#[cfg(test)]
+mod tests {
+ use super::derive_accept_key;
+
+ #[test]
+ fn key_conversion() {
+ // example from RFC 6455
+ assert_eq!(derive_accept_key(b"dGhlIHNhbXBsZSBub25jZQ=="), "s3pPLMBiTxaQ9kYGzzhZRbK+xOo=");
+ }
+}
diff --git a/crates/tungstenite/src/handshake/server.rs b/crates/tungstenite/src/handshake/server.rs
new file mode 100644
index 0000000..bc072ce
--- /dev/null
+++ b/crates/tungstenite/src/handshake/server.rs
@@ -0,0 +1,324 @@
+//! Server handshake machine.
+
+use std::{
+ io::{self, Read, Write},
+ marker::PhantomData,
+ result::Result as StdResult,
+};
+
+use http::{
+ response::Builder, HeaderMap, Request as HttpRequest, Response as HttpResponse, StatusCode,
+};
+use httparse::Status;
+use log::*;
+
+use super::{
+ derive_accept_key,
+ headers::{FromHttparse, MAX_HEADERS},
+ machine::{HandshakeMachine, StageResult, TryParse},
+ HandshakeRole, MidHandshake, ProcessingResult,
+};
+use crate::{
+ error::{Error, ProtocolError, Result},
+ protocol::{Role, WebSocket, WebSocketConfig},
+};
+
+/// Server request type.
+pub type Request = HttpRequest<()>;
+
+/// Server response type.
+pub type Response = HttpResponse<()>;
+
+/// Server error response type.
+pub type ErrorResponse = HttpResponse<Option<String>>;
+
+fn create_parts<T>(request: &HttpRequest<T>) -> Result<Builder> {
+ if request.method() != http::Method::GET {
+ return Err(Error::Protocol(ProtocolError::WrongHttpMethod));
+ }
+
+ if request.version() < http::Version::HTTP_11 {
+ return Err(Error::Protocol(ProtocolError::WrongHttpVersion));
+ }
+
+ if !request
+ .headers()
+ .get("Connection")
+ .and_then(|h| h.to_str().ok())
+ .map(|h| h.split(|c| c == ' ' || c == ',').any(|p| p.eq_ignore_ascii_case("Upgrade")))
+ .unwrap_or(false)
+ {
+ return Err(Error::Protocol(ProtocolError::MissingConnectionUpgradeHeader));
+ }
+
+ if !request
+ .headers()
+ .get("Upgrade")
+ .and_then(|h| h.to_str().ok())
+ .map(|h| h.eq_ignore_ascii_case("websocket"))
+ .unwrap_or(false)
+ {
+ return Err(Error::Protocol(ProtocolError::MissingUpgradeWebSocketHeader));
+ }
+
+ if !request.headers().get("Sec-WebSocket-Version").map(|h| h == "13").unwrap_or(false) {
+ return Err(Error::Protocol(ProtocolError::MissingSecWebSocketVersionHeader));
+ }
+
+ let key = request
+ .headers()
+ .get("Sec-WebSocket-Key")
+ .ok_or(Error::Protocol(ProtocolError::MissingSecWebSocketKey))?;
+
+ let builder = Response::builder()
+ .status(StatusCode::SWITCHING_PROTOCOLS)
+ .version(request.version())
+ .header("Connection", "Upgrade")
+ .header("Upgrade", "websocket")
+ .header("Sec-WebSocket-Accept", derive_accept_key(key.as_bytes()));
+
+ Ok(builder)
+}
+
+/// Create a response for the request.
+pub fn create_response(request: &Request) -> Result<Response> {
+ Ok(create_parts(request)?.body(())?)
+}
+
+/// Create a response for the request with a custom body.
+pub fn create_response_with_body<T>(
+ request: &HttpRequest<T>,
+ generate_body: impl FnOnce() -> T,
+) -> Result<HttpResponse<T>> {
+ Ok(create_parts(request)?.body(generate_body())?)
+}
+
+/// Write `response` to the stream `w`.
+pub fn write_response<T>(mut w: impl io::Write, response: &HttpResponse<T>) -> Result<()> {
+ writeln!(
+ w,
+ "{version:?} {status}\r",
+ version = response.version(),
+ status = response.status()
+ )?;
+
+ for (k, v) in response.headers() {
+ writeln!(w, "{}: {}\r", k, v.to_str()?)?;
+ }
+
+ writeln!(w, "\r")?;
+
+ Ok(())
+}
+
+impl TryParse for Request {
+ fn try_parse(buf: &[u8]) -> Result<Option<(usize, Self)>> {
+ let mut hbuffer = [httparse::EMPTY_HEADER; MAX_HEADERS];
+ let mut req = httparse::Request::new(&mut hbuffer);
+ Ok(match req.parse(buf)? {
+ Status::Partial => None,
+ Status::Complete(size) => Some((size, Request::from_httparse(req)?)),
+ })
+ }
+}
+
+impl<'h, 'b: 'h> FromHttparse<httparse::Request<'h, 'b>> for Request {
+ fn from_httparse(raw: httparse::Request<'h, 'b>) -> Result<Self> {
+ if raw.method.expect("Bug: no method in header") != "GET" {
+ return Err(Error::Protocol(ProtocolError::WrongHttpMethod));
+ }
+
+ if raw.version.expect("Bug: no HTTP version") < /*1.*/1 {
+ return Err(Error::Protocol(ProtocolError::WrongHttpVersion));
+ }
+
+ let headers = HeaderMap::from_httparse(raw.headers)?;
+
+ let mut request = Request::new(());
+ *request.method_mut() = http::Method::GET;
+ *request.headers_mut() = headers;
+ *request.uri_mut() = raw.path.expect("Bug: no path in header").parse()?;
+ // TODO: httparse only supports HTTP 0.9/1.0/1.1 but not HTTP 2.0
+ // so the only valid value we could get in the response would be 1.1.
+ *request.version_mut() = http::Version::HTTP_11;
+
+ Ok(request)
+ }
+}
+
+/// The callback trait.
+///
+/// The callback is called when the server receives an incoming WebSocket
+/// handshake request from the client. Specifying a callback allows you to analyze incoming headers
+/// and add additional headers to the response that server sends to the client and/or reject the
+/// connection based on the incoming headers.
+pub trait Callback: Sized {
+ /// Called whenever the server read the request from the client and is ready to reply to it.
+ /// May return additional reply headers.
+ /// Returning an error resulting in rejecting the incoming connection.
+ fn on_request(
+ self,
+ request: &Request,
+ response: Response,
+ ) -> StdResult<Response, ErrorResponse>;
+}
+
+impl<F> Callback for F
+where
+ F: FnOnce(&Request, Response) -> StdResult<Response, ErrorResponse>,
+{
+ fn on_request(
+ self,
+ request: &Request,
+ response: Response,
+ ) -> StdResult<Response, ErrorResponse> {
+ self(request, response)
+ }
+}
+
+/// Stub for callback that does nothing.
+#[derive(Clone, Copy, Debug)]
+pub struct NoCallback;
+
+impl Callback for NoCallback {
+ fn on_request(
+ self,
+ _request: &Request,
+ response: Response,
+ ) -> StdResult<Response, ErrorResponse> {
+ Ok(response)
+ }
+}
+
+/// Server handshake role.
+#[allow(missing_copy_implementations)]
+#[derive(Debug)]
+pub struct ServerHandshake<S, C> {
+ /// Callback which is called whenever the server read the request from the client and is ready
+ /// to reply to it. The callback returns an optional headers which will be added to the reply
+ /// which the server sends to the user.
+ callback: Option<C>,
+ /// WebSocket configuration.
+ config: Option<WebSocketConfig>,
+ /// Error code/flag. If set, an error will be returned after sending response to the client.
+ error_response: Option<ErrorResponse>,
+ /// Internal stream type.
+ _marker: PhantomData<S>,
+}
+
+impl<S: Read + Write, C: Callback> ServerHandshake<S, C> {
+ /// Start server handshake. `callback` specifies a custom callback which the user can pass to
+ /// the handshake, this callback will be called when the a websocket client connects to the
+ /// server, you can specify the callback if you want to add additional header to the client
+ /// upon join based on the incoming headers.
+ pub fn start(stream: S, callback: C, config: Option<WebSocketConfig>) -> MidHandshake<Self> {
+ trace!("Server handshake initiated.");
+ MidHandshake {
+ machine: HandshakeMachine::start_read(stream),
+ role: ServerHandshake {
+ callback: Some(callback),
+ config,
+ error_response: None,
+ _marker: PhantomData,
+ },
+ }
+ }
+}
+
+impl<S: Read + Write, C: Callback> HandshakeRole for ServerHandshake<S, C> {
+ type IncomingData = Request;
+ type InternalStream = S;
+ type FinalResult = WebSocket<S>;
+
+ fn stage_finished(
+ &mut self,
+ finish: StageResult<Self::IncomingData, Self::InternalStream>,
+ ) -> Result<ProcessingResult<Self::InternalStream, Self::FinalResult>> {
+ Ok(match finish {
+ StageResult::DoneReading { stream, result, tail } => {
+ if !tail.is_empty() {
+ return Err(Error::Protocol(ProtocolError::JunkAfterRequest));
+ }
+
+ let response = create_response(&result)?;
+ let callback_result = if let Some(callback) = self.callback.take() {
+ callback.on_request(&result, response)
+ } else {
+ Ok(response)
+ };
+
+ match callback_result {
+ Ok(response) => {
+ let mut output = vec![];
+ write_response(&mut output, &response)?;
+ ProcessingResult::Continue(HandshakeMachine::start_write(stream, output))
+ }
+
+ Err(resp) => {
+ if resp.status().is_success() {
+ return Err(Error::Protocol(ProtocolError::CustomResponseSuccessful));
+ }
+
+ self.error_response = Some(resp);
+ let resp = self.error_response.as_ref().unwrap();
+
+ let mut output = vec![];
+ write_response(&mut output, resp)?;
+
+ if let Some(body) = resp.body() {
+ output.extend_from_slice(body.as_bytes());
+ }
+
+ ProcessingResult::Continue(HandshakeMachine::start_write(stream, output))
+ }
+ }
+ }
+
+ StageResult::DoneWriting(stream) => {
+ if let Some(err) = self.error_response.take() {
+ debug!("Server handshake failed.");
+
+ let (parts, body) = err.into_parts();
+ let body = body.map(|b| b.as_bytes().to_vec());
+ return Err(Error::Http(http::Response::from_parts(parts, body)));
+ } else {
+ debug!("Server handshake done.");
+ let websocket = WebSocket::from_raw_socket(stream, Role::Server, self.config);
+ ProcessingResult::Done(websocket)
+ }
+ }
+ })
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{super::machine::TryParse, create_response, Request};
+
+ #[test]
+ fn request_parsing() {
+ const DATA: &[u8] = b"GET /script.ws HTTP/1.1\r\nHost: foo.com\r\n\r\n";
+ let (_, req) = Request::try_parse(DATA).unwrap().unwrap();
+ assert_eq!(req.uri().path(), "/script.ws");
+ assert_eq!(req.headers().get("Host").unwrap(), &b"foo.com"[..]);
+ }
+
+ #[test]
+ fn request_replying() {
+ const DATA: &[u8] = b"\
+ GET /script.ws HTTP/1.1\r\n\
+ Host: foo.com\r\n\
+ Connection: upgrade\r\n\
+ Upgrade: websocket\r\n\
+ Sec-WebSocket-Version: 13\r\n\
+ Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==\r\n\
+ \r\n";
+ let (_, req) = Request::try_parse(DATA).unwrap().unwrap();
+ let response = create_response(&req).unwrap();
+
+ assert_eq!(
+ response.headers().get("Sec-WebSocket-Accept").unwrap(),
+ b"s3pPLMBiTxaQ9kYGzzhZRbK+xOo=".as_ref()
+ );
+ }
+}
diff --git a/crates/tungstenite/src/lib.rs b/crates/tungstenite/src/lib.rs
new file mode 100644
index 0000000..4fdf0a6
--- /dev/null
+++ b/crates/tungstenite/src/lib.rs
@@ -0,0 +1,48 @@
+//! Lightweight, flexible WebSockets for Rust.
+#![deny(
+ missing_docs,
+ missing_copy_implementations,
+ missing_debug_implementations,
+ trivial_casts,
+ trivial_numeric_casts,
+ unstable_features,
+ unused_must_use,
+ unused_mut,
+ unused_imports,
+ unused_import_braces
+)]
+
+#[cfg(feature = "handshake")]
+pub use http;
+
+pub mod buffer;
+#[cfg(feature = "handshake")]
+pub mod client;
+pub mod error;
+#[cfg(feature = "handshake")]
+pub mod handshake;
+pub mod protocol;
+#[cfg(feature = "handshake")]
+mod server;
+pub mod stream;
+#[cfg(all(any(feature = "native-tls", feature = "__rustls-tls"), feature = "handshake"))]
+mod tls;
+pub mod util;
+
+const READ_BUFFER_CHUNK_SIZE: usize = 4096;
+type ReadBuffer = buffer::ReadBuffer<READ_BUFFER_CHUNK_SIZE>;
+
+pub use crate::{
+ error::{Error, Result},
+ protocol::{Message, WebSocket},
+};
+
+#[cfg(feature = "handshake")]
+pub use crate::{
+ client::{client, connect},
+ handshake::{client::ClientHandshake, server::ServerHandshake, HandshakeError},
+ server::{accept, accept_hdr, accept_hdr_with_config, accept_with_config},
+};
+
+#[cfg(all(any(feature = "native-tls", feature = "__rustls-tls"), feature = "handshake"))]
+pub use tls::{client_tls, client_tls_with_config, Connector};
diff --git a/crates/tungstenite/src/protocol/frame/coding.rs b/crates/tungstenite/src/protocol/frame/coding.rs
new file mode 100644
index 0000000..827b7ca
--- /dev/null
+++ b/crates/tungstenite/src/protocol/frame/coding.rs
@@ -0,0 +1,291 @@
+//! Various codes defined in RFC 6455.
+
+use std::{
+ convert::{From, Into},
+ fmt,
+};
+
+/// WebSocket message opcode as in RFC 6455.
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+pub enum OpCode {
+ /// Data (text or binary).
+ Data(Data),
+ /// Control message (close, ping, pong).
+ Control(Control),
+}
+
+/// Data opcodes as in RFC 6455
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+pub enum Data {
+ /// 0x0 denotes a continuation frame
+ Continue,
+ /// 0x1 denotes a text frame
+ Text,
+ /// 0x2 denotes a binary frame
+ Binary,
+ /// 0x3-7 are reserved for further non-control frames
+ Reserved(u8),
+}
+
+/// Control opcodes as in RFC 6455
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+pub enum Control {
+ /// 0x8 denotes a connection close
+ Close,
+ /// 0x9 denotes a ping
+ Ping,
+ /// 0xa denotes a pong
+ Pong,
+ /// 0xb-f are reserved for further control frames
+ Reserved(u8),
+}
+
+impl fmt::Display for Data {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ Data::Continue => write!(f, "CONTINUE"),
+ Data::Text => write!(f, "TEXT"),
+ Data::Binary => write!(f, "BINARY"),
+ Data::Reserved(x) => write!(f, "RESERVED_DATA_{}", x),
+ }
+ }
+}
+
+impl fmt::Display for Control {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ Control::Close => write!(f, "CLOSE"),
+ Control::Ping => write!(f, "PING"),
+ Control::Pong => write!(f, "PONG"),
+ Control::Reserved(x) => write!(f, "RESERVED_CONTROL_{}", x),
+ }
+ }
+}
+
+impl fmt::Display for OpCode {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ OpCode::Data(d) => d.fmt(f),
+ OpCode::Control(c) => c.fmt(f),
+ }
+ }
+}
+
+impl From<OpCode> for u8 {
+ fn from(code: OpCode) -> Self {
+ use self::{
+ Control::{Close, Ping, Pong},
+ Data::{Binary, Continue, Text},
+ OpCode::*,
+ };
+ match code {
+ Data(Continue) => 0,
+ Data(Text) => 1,
+ Data(Binary) => 2,
+ Data(self::Data::Reserved(i)) => i,
+
+ Control(Close) => 8,
+ Control(Ping) => 9,
+ Control(Pong) => 10,
+ Control(self::Control::Reserved(i)) => i,
+ }
+ }
+}
+
+impl From<u8> for OpCode {
+ fn from(byte: u8) -> OpCode {
+ use self::{
+ Control::{Close, Ping, Pong},
+ Data::{Binary, Continue, Text},
+ OpCode::*,
+ };
+ match byte {
+ 0 => Data(Continue),
+ 1 => Data(Text),
+ 2 => Data(Binary),
+ i @ 3..=7 => Data(self::Data::Reserved(i)),
+ 8 => Control(Close),
+ 9 => Control(Ping),
+ 10 => Control(Pong),
+ i @ 11..=15 => Control(self::Control::Reserved(i)),
+ _ => panic!("Bug: OpCode out of range"),
+ }
+ }
+}
+
+use self::CloseCode::*;
+/// Status code used to indicate why an endpoint is closing the WebSocket connection.
+#[derive(Debug, Eq, PartialEq, Clone, Copy)]
+pub enum CloseCode {
+ /// Indicates a normal closure, meaning that the purpose for
+ /// which the connection was established has been fulfilled.
+ Normal,
+ /// Indicates that an endpoint is "going away", such as a server
+ /// going down or a browser having navigated away from a page.
+ Away,
+ /// Indicates that an endpoint is terminating the connection due
+ /// to a protocol error.
+ Protocol,
+ /// Indicates that an endpoint is terminating the connection
+ /// because it has received a type of data it cannot accept (e.g., an
+ /// endpoint that understands only text data MAY send this if it
+ /// receives a binary message).
+ Unsupported,
+ /// Indicates that no status code was included in a closing frame. This
+ /// close code makes it possible to use a single method, `on_close` to
+ /// handle even cases where no close code was provided.
+ Status,
+ /// Indicates an abnormal closure. If the abnormal closure was due to an
+ /// error, this close code will not be used. Instead, the `on_error` method
+ /// of the handler will be called with the error. However, if the connection
+ /// is simply dropped, without an error, this close code will be sent to the
+ /// handler.
+ Abnormal,
+ /// Indicates that an endpoint is terminating the connection
+ /// because it has received data within a message that was not
+ /// consistent with the type of the message (e.g., non-UTF-8 \[RFC3629\]
+ /// data within a text message).
+ Invalid,
+ /// Indicates that an endpoint is terminating the connection
+ /// because it has received a message that violates its policy. This
+ /// is a generic status code that can be returned when there is no
+ /// other more suitable status code (e.g., Unsupported or Size) or if there
+ /// is a need to hide specific details about the policy.
+ Policy,
+ /// Indicates that an endpoint is terminating the connection
+ /// because it has received a message that is too big for it to
+ /// process.
+ Size,
+ /// Indicates that an endpoint (client) is terminating the
+ /// connection because it has expected the server to negotiate one or
+ /// more extension, but the server didn't return them in the response
+ /// message of the WebSocket handshake. The list of extensions that
+ /// are needed should be given as the reason for closing.
+ /// Note that this status code is not used by the server, because it
+ /// can fail the WebSocket handshake instead.
+ Extension,
+ /// Indicates that a server is terminating the connection because
+ /// it encountered an unexpected condition that prevented it from
+ /// fulfilling the request.
+ Error,
+ /// Indicates that the server is restarting. A client may choose to reconnect,
+ /// and if it does, it should use a randomized delay of 5-30 seconds between attempts.
+ Restart,
+ /// Indicates that the server is overloaded and the client should either connect
+ /// to a different IP (when multiple targets exist), or reconnect to the same IP
+ /// when a user has performed an action.
+ Again,
+ #[doc(hidden)]
+ Tls,
+ #[doc(hidden)]
+ Reserved(u16),
+ #[doc(hidden)]
+ Iana(u16),
+ #[doc(hidden)]
+ Library(u16),
+ #[doc(hidden)]
+ Bad(u16),
+}
+
+impl CloseCode {
+ /// Check if this CloseCode is allowed.
+ pub fn is_allowed(self) -> bool {
+ !matches!(self, Bad(_) | Reserved(_) | Status | Abnormal | Tls)
+ }
+}
+
+impl fmt::Display for CloseCode {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ let code: u16 = self.into();
+ write!(f, "{}", code)
+ }
+}
+
+impl From<CloseCode> for u16 {
+ fn from(code: CloseCode) -> u16 {
+ match code {
+ Normal => 1000,
+ Away => 1001,
+ Protocol => 1002,
+ Unsupported => 1003,
+ Status => 1005,
+ Abnormal => 1006,
+ Invalid => 1007,
+ Policy => 1008,
+ Size => 1009,
+ Extension => 1010,
+ Error => 1011,
+ Restart => 1012,
+ Again => 1013,
+ Tls => 1015,
+ Reserved(code) => code,
+ Iana(code) => code,
+ Library(code) => code,
+ Bad(code) => code,
+ }
+ }
+}
+
+impl<'t> From<&'t CloseCode> for u16 {
+ fn from(code: &'t CloseCode) -> u16 {
+ (*code).into()
+ }
+}
+
+impl From<u16> for CloseCode {
+ fn from(code: u16) -> CloseCode {
+ match code {
+ 1000 => Normal,
+ 1001 => Away,
+ 1002 => Protocol,
+ 1003 => Unsupported,
+ 1005 => Status,
+ 1006 => Abnormal,
+ 1007 => Invalid,
+ 1008 => Policy,
+ 1009 => Size,
+ 1010 => Extension,
+ 1011 => Error,
+ 1012 => Restart,
+ 1013 => Again,
+ 1015 => Tls,
+ 1..=999 => Bad(code),
+ 1016..=2999 => Reserved(code),
+ 3000..=3999 => Iana(code),
+ 4000..=4999 => Library(code),
+ _ => Bad(code),
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn opcode_from_u8() {
+ let byte = 2u8;
+ assert_eq!(OpCode::from(byte), OpCode::Data(Data::Binary));
+ }
+
+ #[test]
+ fn opcode_into_u8() {
+ let text = OpCode::Data(Data::Text);
+ let byte: u8 = text.into();
+ assert_eq!(byte, 1u8);
+ }
+
+ #[test]
+ fn closecode_from_u16() {
+ let byte = 1008u16;
+ assert_eq!(CloseCode::from(byte), CloseCode::Policy);
+ }
+
+ #[test]
+ fn closecode_into_u16() {
+ let text = CloseCode::Away;
+ let byte: u16 = text.into();
+ assert_eq!(byte, 1001u16);
+ assert_eq!(u16::from(text), 1001u16);
+ }
+}
diff --git a/crates/tungstenite/src/protocol/frame/frame.rs b/crates/tungstenite/src/protocol/frame/frame.rs
new file mode 100644
index 0000000..6b797a9
--- /dev/null
+++ b/crates/tungstenite/src/protocol/frame/frame.rs
@@ -0,0 +1,486 @@
+use byteorder::{NetworkEndian, ReadBytesExt};
+use log::*;
+use std::{
+ borrow::Cow,
+ default::Default,
+ fmt,
+ io::{Cursor, ErrorKind, Read, Write},
+ result::Result as StdResult,
+ str::Utf8Error,
+ string::{FromUtf8Error, String},
+};
+
+use super::{
+ coding::{CloseCode, Control, Data, OpCode},
+ mask::{apply_mask, generate_mask},
+};
+use crate::error::{Error, ProtocolError, Result};
+
+/// A struct representing the close command.
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct CloseFrame<'t> {
+ /// The reason as a code.
+ pub code: CloseCode,
+ /// The reason as text string.
+ pub reason: Cow<'t, str>,
+}
+
+impl<'t> CloseFrame<'t> {
+ /// Convert into a owned string.
+ pub fn into_owned(self) -> CloseFrame<'static> {
+ CloseFrame { code: self.code, reason: self.reason.into_owned().into() }
+ }
+}
+
+impl<'t> fmt::Display for CloseFrame<'t> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "{} ({})", self.reason, self.code)
+ }
+}
+
+/// A struct representing a WebSocket frame header.
+#[allow(missing_copy_implementations)]
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct FrameHeader {
+ /// Indicates that the frame is the last one of a possibly fragmented message.
+ pub is_final: bool,
+ /// Reserved for protocol extensions.
+ pub rsv1: bool,
+ /// Reserved for protocol extensions.
+ pub rsv2: bool,
+ /// Reserved for protocol extensions.
+ pub rsv3: bool,
+ /// WebSocket protocol opcode.
+ pub opcode: OpCode,
+ /// A frame mask, if any.
+ pub mask: Option<[u8; 4]>,
+}
+
+impl Default for FrameHeader {
+ fn default() -> Self {
+ FrameHeader {
+ is_final: true,
+ rsv1: false,
+ rsv2: false,
+ rsv3: false,
+ opcode: OpCode::Control(Control::Close),
+ mask: None,
+ }
+ }
+}
+
+impl FrameHeader {
+ /// Parse a header from an input stream.
+ /// Returns `None` if insufficient data and does not consume anything in this case.
+ /// Payload size is returned along with the header.
+ pub fn parse(cursor: &mut Cursor<impl AsRef<[u8]>>) -> Result<Option<(Self, u64)>> {
+ let initial = cursor.position();
+ match Self::parse_internal(cursor) {
+ ret @ Ok(None) => {
+ cursor.set_position(initial);
+ ret
+ }
+ ret => ret,
+ }
+ }
+
+ /// Get the size of the header formatted with given payload length.
+ #[allow(clippy::len_without_is_empty)]
+ pub fn len(&self, length: u64) -> usize {
+ 2 + LengthFormat::for_length(length).extra_bytes() + if self.mask.is_some() { 4 } else { 0 }
+ }
+
+ /// Format a header for given payload size.
+ pub fn format(&self, length: u64, output: &mut impl Write) -> Result<()> {
+ let code: u8 = self.opcode.into();
+
+ let one = {
+ code | if self.is_final { 0x80 } else { 0 }
+ | if self.rsv1 { 0x40 } else { 0 }
+ | if self.rsv2 { 0x20 } else { 0 }
+ | if self.rsv3 { 0x10 } else { 0 }
+ };
+
+ let lenfmt = LengthFormat::for_length(length);
+
+ let two = { lenfmt.length_byte() | if self.mask.is_some() { 0x80 } else { 0 } };
+
+ output.write_all(&[one, two])?;
+ match lenfmt {
+ LengthFormat::U8(_) => (),
+ LengthFormat::U16 => {
+ output.write_all(&(length as u16).to_be_bytes())?;
+ }
+ LengthFormat::U64 => {
+ output.write_all(&length.to_be_bytes())?;
+ }
+ }
+
+ if let Some(ref mask) = self.mask {
+ output.write_all(mask)?
+ }
+
+ Ok(())
+ }
+
+ /// Generate a random frame mask and store this in the header.
+ ///
+ /// Of course this does not change frame contents. It just generates a mask.
+ pub(crate) fn set_random_mask(&mut self) {
+ self.mask = Some(generate_mask())
+ }
+}
+
+impl FrameHeader {
+ /// Internal parse engine.
+ /// Returns `None` if insufficient data.
+ /// Payload size is returned along with the header.
+ fn parse_internal(cursor: &mut impl Read) -> Result<Option<(Self, u64)>> {
+ let (first, second) = {
+ let mut head = [0u8; 2];
+ if cursor.read(&mut head)? != 2 {
+ return Ok(None);
+ }
+ trace!("Parsed headers {:?}", head);
+ (head[0], head[1])
+ };
+
+ trace!("First: {:b}", first);
+ trace!("Second: {:b}", second);
+
+ let is_final = first & 0x80 != 0;
+
+ let rsv1 = first & 0x40 != 0;
+ let rsv2 = first & 0x20 != 0;
+ let rsv3 = first & 0x10 != 0;
+
+ let opcode = OpCode::from(first & 0x0F);
+ trace!("Opcode: {:?}", opcode);
+
+ let masked = second & 0x80 != 0;
+ trace!("Masked: {:?}", masked);
+
+ let length = {
+ let length_byte = second & 0x7F;
+ let length_length = LengthFormat::for_byte(length_byte).extra_bytes();
+ if length_length > 0 {
+ match cursor.read_uint::<NetworkEndian>(length_length) {
+ Err(ref err) if err.kind() == ErrorKind::UnexpectedEof => {
+ return Ok(None);
+ }
+ Err(err) => {
+ return Err(err.into());
+ }
+ Ok(read) => read,
+ }
+ } else {
+ u64::from(length_byte)
+ }
+ };
+
+ let mask = if masked {
+ let mut mask_bytes = [0u8; 4];
+ if cursor.read(&mut mask_bytes)? != 4 {
+ return Ok(None);
+ } else {
+ Some(mask_bytes)
+ }
+ } else {
+ None
+ };
+
+ // Disallow bad opcode
+ match opcode {
+ OpCode::Control(Control::Reserved(_)) | OpCode::Data(Data::Reserved(_)) => {
+ return Err(Error::Protocol(ProtocolError::InvalidOpcode(first & 0x0F)))
+ }
+ _ => (),
+ }
+
+ let hdr = FrameHeader { is_final, rsv1, rsv2, rsv3, opcode, mask };
+
+ Ok(Some((hdr, length)))
+ }
+}
+
+/// A struct representing a WebSocket frame.
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct Frame {
+ header: FrameHeader,
+ payload: Vec<u8>,
+}
+
+impl Frame {
+ /// Get the length of the frame.
+ /// This is the length of the header + the length of the payload.
+ #[inline]
+ pub fn len(&self) -> usize {
+ let length = self.payload.len();
+ self.header.len(length as u64) + length
+ }
+
+ /// Check if the frame is empty.
+ #[inline]
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// Get a reference to the frame's header.
+ #[inline]
+ pub fn header(&self) -> &FrameHeader {
+ &self.header
+ }
+
+ /// Get a mutable reference to the frame's header.
+ #[inline]
+ pub fn header_mut(&mut self) -> &mut FrameHeader {
+ &mut self.header
+ }
+
+ /// Get a reference to the frame's payload.
+ #[inline]
+ pub fn payload(&self) -> &Vec<u8> {
+ &self.payload
+ }
+
+ /// Get a mutable reference to the frame's payload.
+ #[inline]
+ pub fn payload_mut(&mut self) -> &mut Vec<u8> {
+ &mut self.payload
+ }
+
+ /// Test whether the frame is masked.
+ #[inline]
+ pub(crate) fn is_masked(&self) -> bool {
+ self.header.mask.is_some()
+ }
+
+ /// Generate a random mask for the frame.
+ ///
+ /// This just generates a mask, payload is not changed. The actual masking is performed
+ /// either on `format()` or on `apply_mask()` call.
+ #[inline]
+ pub(crate) fn set_random_mask(&mut self) {
+ self.header.set_random_mask()
+ }
+
+ /// This method unmasks the payload and should only be called on frames that are actually
+ /// masked. In other words, those frames that have just been received from a client endpoint.
+ #[inline]
+ pub(crate) fn apply_mask(&mut self) {
+ if let Some(mask) = self.header.mask.take() {
+ apply_mask(&mut self.payload, mask)
+ }
+ }
+
+ /// Consume the frame into its payload as binary.
+ #[inline]
+ pub fn into_data(self) -> Vec<u8> {
+ self.payload
+ }
+
+ /// Consume the frame into its payload as string.
+ #[inline]
+ pub fn into_string(self) -> StdResult<String, FromUtf8Error> {
+ String::from_utf8(self.payload)
+ }
+
+ /// Get frame payload as `&str`.
+ #[inline]
+ pub fn to_text(&self) -> Result<&str, Utf8Error> {
+ std::str::from_utf8(&self.payload)
+ }
+
+ /// Consume the frame into a closing frame.
+ #[inline]
+ pub(crate) fn into_close(self) -> Result<Option<CloseFrame<'static>>> {
+ match self.payload.len() {
+ 0 => Ok(None),
+ 1 => Err(Error::Protocol(ProtocolError::InvalidCloseSequence)),
+ _ => {
+ let mut data = self.payload;
+ let code = u16::from_be_bytes([data[0], data[1]]).into();
+ data.drain(0..2);
+ let text = String::from_utf8(data)?;
+ Ok(Some(CloseFrame { code, reason: text.into() }))
+ }
+ }
+ }
+
+ /// Create a new data frame.
+ #[inline]
+ pub fn message(data: Vec<u8>, opcode: OpCode, is_final: bool) -> Frame {
+ debug_assert!(matches!(opcode, OpCode::Data(_)), "Invalid opcode for data frame.");
+
+ Frame { header: FrameHeader { is_final, opcode, ..FrameHeader::default() }, payload: data }
+ }
+
+ /// Create a new Pong control frame.
+ #[inline]
+ pub fn pong(data: Vec<u8>) -> Frame {
+ Frame {
+ header: FrameHeader {
+ opcode: OpCode::Control(Control::Pong),
+ ..FrameHeader::default()
+ },
+ payload: data,
+ }
+ }
+
+ /// Create a new Ping control frame.
+ #[inline]
+ pub fn ping(data: Vec<u8>) -> Frame {
+ Frame {
+ header: FrameHeader {
+ opcode: OpCode::Control(Control::Ping),
+ ..FrameHeader::default()
+ },
+ payload: data,
+ }
+ }
+
+ /// Create a new Close control frame.
+ #[inline]
+ pub fn close(msg: Option<CloseFrame>) -> Frame {
+ let payload = if let Some(CloseFrame { code, reason }) = msg {
+ let mut p = Vec::with_capacity(reason.as_bytes().len() + 2);
+ p.extend(u16::from(code).to_be_bytes());
+ p.extend_from_slice(reason.as_bytes());
+ p
+ } else {
+ Vec::new()
+ };
+
+ Frame { header: FrameHeader::default(), payload }
+ }
+
+ /// Create a frame from given header and data.
+ pub fn from_payload(header: FrameHeader, payload: Vec<u8>) -> Self {
+ Frame { header, payload }
+ }
+
+ /// Write a frame out to a buffer
+ pub fn format(mut self, output: &mut impl Write) -> Result<()> {
+ self.header.format(self.payload.len() as u64, output)?;
+ self.apply_mask();
+ output.write_all(self.payload())?;
+ Ok(())
+ }
+}
+
+impl fmt::Display for Frame {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ use std::fmt::Write;
+
+ write!(
+ f,
+ "
+<FRAME>
+final: {}
+reserved: {} {} {}
+opcode: {}
+length: {}
+payload length: {}
+payload: 0x{}
+ ",
+ self.header.is_final,
+ self.header.rsv1,
+ self.header.rsv2,
+ self.header.rsv3,
+ self.header.opcode,
+ // self.mask.map(|mask| format!("{:?}", mask)).unwrap_or("NONE".into()),
+ self.len(),
+ self.payload.len(),
+ self.payload.iter().fold(String::new(), |mut output, byte| {
+ _ = write!(output, "{byte:02x}");
+ output
+ })
+ )
+ }
+}
+
+/// Handling of the length format.
+enum LengthFormat {
+ U8(u8),
+ U16,
+ U64,
+}
+
+impl LengthFormat {
+ /// Get the length format for a given data size.
+ #[inline]
+ fn for_length(length: u64) -> Self {
+ if length < 126 {
+ LengthFormat::U8(length as u8)
+ } else if length < 65536 {
+ LengthFormat::U16
+ } else {
+ LengthFormat::U64
+ }
+ }
+
+ /// Get the size of the length encoding.
+ #[inline]
+ fn extra_bytes(&self) -> usize {
+ match *self {
+ LengthFormat::U8(_) => 0,
+ LengthFormat::U16 => 2,
+ LengthFormat::U64 => 8,
+ }
+ }
+
+ /// Encode the given length.
+ #[inline]
+ fn length_byte(&self) -> u8 {
+ match *self {
+ LengthFormat::U8(b) => b,
+ LengthFormat::U16 => 126,
+ LengthFormat::U64 => 127,
+ }
+ }
+
+ /// Get the length format for a given length byte.
+ #[inline]
+ fn for_byte(byte: u8) -> Self {
+ match byte & 0x7F {
+ 126 => LengthFormat::U16,
+ 127 => LengthFormat::U64,
+ b => LengthFormat::U8(b),
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ use super::super::coding::{Data, OpCode};
+ use std::io::Cursor;
+
+ #[test]
+ fn parse() {
+ let mut raw: Cursor<Vec<u8>> =
+ Cursor::new(vec![0x82, 0x07, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
+ let (header, length) = FrameHeader::parse(&mut raw).unwrap().unwrap();
+ assert_eq!(length, 7);
+ let mut payload = Vec::new();
+ raw.read_to_end(&mut payload).unwrap();
+ let frame = Frame::from_payload(header, payload);
+ assert_eq!(frame.into_data(), vec![0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
+ }
+
+ #[test]
+ fn format() {
+ let frame = Frame::ping(vec![0x01, 0x02]);
+ let mut buf = Vec::with_capacity(frame.len());
+ frame.format(&mut buf).unwrap();
+ assert_eq!(buf, vec![0x89, 0x02, 0x01, 0x02]);
+ }
+
+ #[test]
+ fn display() {
+ let f = Frame::message("hi there".into(), OpCode::Data(Data::Text), true);
+ let view = format!("{}", f);
+ assert!(view.contains("payload:"));
+ }
+}
diff --git a/crates/tungstenite/src/protocol/frame/mask.rs b/crates/tungstenite/src/protocol/frame/mask.rs
new file mode 100644
index 0000000..ff6eb75
--- /dev/null
+++ b/crates/tungstenite/src/protocol/frame/mask.rs
@@ -0,0 +1,73 @@
+/// Generate a random frame mask.
+#[inline]
+pub fn generate_mask() -> [u8; 4] {
+ rand::random()
+}
+
+/// Mask/unmask a frame.
+#[inline]
+pub fn apply_mask(buf: &mut [u8], mask: [u8; 4]) {
+ apply_mask_fast32(buf, mask)
+}
+
+/// A safe unoptimized mask application.
+#[inline]
+fn apply_mask_fallback(buf: &mut [u8], mask: [u8; 4]) {
+ for (i, byte) in buf.iter_mut().enumerate() {
+ *byte ^= mask[i & 3];
+ }
+}
+
+/// Faster version of `apply_mask()` which operates on 4-byte blocks.
+#[inline]
+pub fn apply_mask_fast32(buf: &mut [u8], mask: [u8; 4]) {
+ let mask_u32 = u32::from_ne_bytes(mask);
+
+ let (prefix, words, suffix) = unsafe { buf.align_to_mut::<u32>() };
+ apply_mask_fallback(prefix, mask);
+ let head = prefix.len() & 3;
+ let mask_u32 = if head > 0 {
+ if cfg!(target_endian = "big") {
+ mask_u32.rotate_left(8 * head as u32)
+ } else {
+ mask_u32.rotate_right(8 * head as u32)
+ }
+ } else {
+ mask_u32
+ };
+ for word in words.iter_mut() {
+ *word ^= mask_u32;
+ }
+ apply_mask_fallback(suffix, mask_u32.to_ne_bytes());
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_apply_mask() {
+ let mask = [0x6d, 0xb6, 0xb2, 0x80];
+ let unmasked = [
+ 0xf3, 0x00, 0x01, 0x02, 0x03, 0x80, 0x81, 0x82, 0xff, 0xfe, 0x00, 0x17, 0x74, 0xf9,
+ 0x12, 0x03,
+ ];
+
+ for data_len in 0..=unmasked.len() {
+ let unmasked = &unmasked[0..data_len];
+ // Check masking with different alignment.
+ for off in 0..=3 {
+ if unmasked.len() < off {
+ continue;
+ }
+ let mut masked = unmasked.to_vec();
+ apply_mask_fallback(&mut masked[off..], mask);
+
+ let mut masked_fast = unmasked.to_vec();
+ apply_mask_fast32(&mut masked_fast[off..], mask);
+
+ assert_eq!(masked, masked_fast);
+ }
+ }
+ }
+}
diff --git a/crates/tungstenite/src/protocol/frame/mod.rs b/crates/tungstenite/src/protocol/frame/mod.rs
new file mode 100644
index 0000000..7d2ee41
--- /dev/null
+++ b/crates/tungstenite/src/protocol/frame/mod.rs
@@ -0,0 +1,325 @@
+//! Utilities to work with raw WebSocket frames.
+
+pub mod coding;
+
+#[allow(clippy::module_inception)]
+mod frame;
+mod mask;
+
+use crate::{
+ error::{CapacityError, Error, Result},
+ Message, ReadBuffer,
+};
+use log::*;
+use std::io::{Error as IoError, ErrorKind as IoErrorKind, Read, Write};
+
+pub use self::frame::{CloseFrame, Frame, FrameHeader};
+
+/// A reader and writer for WebSocket frames.
+#[derive(Debug)]
+pub struct FrameSocket<Stream> {
+ /// The underlying network stream.
+ stream: Stream,
+ /// Codec for reading/writing frames.
+ codec: FrameCodec,
+}
+
+impl<Stream> FrameSocket<Stream> {
+ /// Create a new frame socket.
+ pub fn new(stream: Stream) -> Self {
+ FrameSocket { stream, codec: FrameCodec::new() }
+ }
+
+ /// Create a new frame socket from partially read data.
+ pub fn from_partially_read(stream: Stream, part: Vec<u8>) -> Self {
+ FrameSocket { stream, codec: FrameCodec::from_partially_read(part) }
+ }
+
+ /// Extract a stream from the socket.
+ pub fn into_inner(self) -> (Stream, Vec<u8>) {
+ (self.stream, self.codec.in_buffer.into_vec())
+ }
+
+ /// Returns a shared reference to the inner stream.
+ pub fn get_ref(&self) -> &Stream {
+ &self.stream
+ }
+
+ /// Returns a mutable reference to the inner stream.
+ pub fn get_mut(&mut self) -> &mut Stream {
+ &mut self.stream
+ }
+}
+
+impl<Stream> FrameSocket<Stream>
+where
+ Stream: Read,
+{
+ /// Read a frame from stream.
+ pub fn read(&mut self, max_size: Option<usize>) -> Result<Option<Frame>> {
+ self.codec.read_frame(&mut self.stream, max_size)
+ }
+}
+
+impl<Stream> FrameSocket<Stream>
+where
+ Stream: Write,
+{
+ /// Writes and immediately flushes a frame.
+ /// Equivalent to calling [`write`](Self::write) then [`flush`](Self::flush).
+ pub fn send(&mut self, frame: Frame) -> Result<()> {
+ self.write(frame)?;
+ self.flush()
+ }
+
+ /// Write a frame to stream.
+ ///
+ /// A subsequent call should be made to [`flush`](Self::flush) to flush writes.
+ ///
+ /// This function guarantees that the frame is queued unless [`Error::WriteBufferFull`]
+ /// is returned.
+ /// In order to handle WouldBlock or Incomplete, call [`flush`](Self::flush) afterwards.
+ pub fn write(&mut self, frame: Frame) -> Result<()> {
+ self.codec.buffer_frame(&mut self.stream, frame)
+ }
+
+ /// Flush writes.
+ pub fn flush(&mut self) -> Result<()> {
+ self.codec.write_out_buffer(&mut self.stream)?;
+ Ok(self.stream.flush()?)
+ }
+}
+
+/// A codec for WebSocket frames.
+#[derive(Debug)]
+pub(super) struct FrameCodec {
+ /// Buffer to read data from the stream.
+ in_buffer: ReadBuffer,
+ /// Buffer to send packets to the network.
+ out_buffer: Vec<u8>,
+ /// Capacity limit for `out_buffer`.
+ max_out_buffer_len: usize,
+ /// Buffer target length to reach before writing to the stream
+ /// on calls to `buffer_frame`.
+ ///
+ /// Setting this to non-zero will buffer small writes from hitting
+ /// the stream.
+ out_buffer_write_len: usize,
+ /// Header and remaining size of the incoming packet being processed.
+ header: Option<(FrameHeader, u64)>,
+}
+
+impl FrameCodec {
+ /// Create a new frame codec.
+ pub(super) fn new() -> Self {
+ Self {
+ in_buffer: ReadBuffer::new(),
+ out_buffer: Vec::new(),
+ max_out_buffer_len: usize::MAX,
+ out_buffer_write_len: 0,
+ header: None,
+ }
+ }
+
+ /// Create a new frame codec from partially read data.
+ pub(super) fn from_partially_read(part: Vec<u8>) -> Self {
+ Self {
+ in_buffer: ReadBuffer::from_partially_read(part),
+ out_buffer: Vec::new(),
+ max_out_buffer_len: usize::MAX,
+ out_buffer_write_len: 0,
+ header: None,
+ }
+ }
+
+ /// Sets a maximum size for the out buffer.
+ pub(super) fn set_max_out_buffer_len(&mut self, max: usize) {
+ self.max_out_buffer_len = max;
+ }
+
+ /// Sets [`Self::buffer_frame`] buffer target length to reach before
+ /// writing to the stream.
+ pub(super) fn set_out_buffer_write_len(&mut self, len: usize) {
+ self.out_buffer_write_len = len;
+ }
+
+ /// Read a frame from the provided stream.
+ pub(super) fn read_frame<Stream>(
+ &mut self,
+ stream: &mut Stream,
+ max_size: Option<usize>,
+ ) -> Result<Option<Frame>>
+ where
+ Stream: Read,
+ {
+ let max_size = max_size.unwrap_or_else(usize::max_value);
+
+ let payload = loop {
+ {
+ let cursor = self.in_buffer.as_cursor_mut();
+
+ if self.header.is_none() {
+ self.header = FrameHeader::parse(cursor)?;
+ }
+
+ if let Some((_, ref length)) = self.header {
+ let length = *length;
+
+ // Enforce frame size limit early and make sure `length`
+ // is not too big (fits into `usize`).
+ if length > max_size as u64 {
+ return Err(Error::Capacity(CapacityError::MessageTooLong {
+ size: length as usize,
+ max_size,
+ }));
+ }
+
+ let input_size = cursor.get_ref().len() as u64 - cursor.position();
+ if length <= input_size {
+ // No truncation here since `length` is checked above
+ let mut payload = Vec::with_capacity(length as usize);
+ if length > 0 {
+ cursor.take(length).read_to_end(&mut payload)?;
+ }
+ break payload;
+ }
+ }
+ }
+
+ // Not enough data in buffer.
+ let size = self.in_buffer.read_from(stream)?;
+ if size == 0 {
+ trace!("no frame received");
+ return Ok(None);
+ }
+ };
+
+ let (header, length) = self.header.take().expect("Bug: no frame header");
+ debug_assert_eq!(payload.len() as u64, length);
+ let frame = Frame::from_payload(header, payload);
+ trace!("received frame {}", frame);
+ Ok(Some(frame))
+ }
+
+ /// Writes a frame into the `out_buffer`.
+ /// If the out buffer size is over the `out_buffer_write_len` will also write
+ /// the out buffer into the provided `stream`.
+ ///
+ /// To ensure buffered frames are written call [`Self::write_out_buffer`].
+ ///
+ /// May write to the stream, will **not** flush.
+ pub(super) fn buffer_frame<Stream>(&mut self, stream: &mut Stream, frame: Frame) -> Result<()>
+ where
+ Stream: Write,
+ {
+ if frame.len() + self.out_buffer.len() > self.max_out_buffer_len {
+ return Err(Error::WriteBufferFull(Message::Frame(frame)));
+ }
+
+ trace!("writing frame {}", frame);
+
+ self.out_buffer.reserve(frame.len());
+ frame.format(&mut self.out_buffer).expect("Bug: can't write to vector");
+
+ if self.out_buffer.len() > self.out_buffer_write_len {
+ self.write_out_buffer(stream)
+ } else {
+ Ok(())
+ }
+ }
+
+ /// Writes the out_buffer to the provided stream.
+ ///
+ /// Does **not** flush.
+ pub(super) fn write_out_buffer<Stream>(&mut self, stream: &mut Stream) -> Result<()>
+ where
+ Stream: Write,
+ {
+ while !self.out_buffer.is_empty() {
+ let len = stream.write(&self.out_buffer)?;
+ if len == 0 {
+ // This is the same as "Connection reset by peer"
+ return Err(IoError::new(
+ IoErrorKind::ConnectionReset,
+ "Connection reset while sending",
+ )
+ .into());
+ }
+ self.out_buffer.drain(0..len);
+ }
+
+ Ok(())
+ }
+}
+
+#[cfg(test)]
+mod tests {
+
+ use crate::error::{CapacityError, Error};
+
+ use super::{Frame, FrameSocket};
+
+ use std::io::Cursor;
+
+ #[test]
+ fn read_frames() {
+ let raw = Cursor::new(vec![
+ 0x82, 0x07, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x82, 0x03, 0x03, 0x02, 0x01,
+ 0x99,
+ ]);
+ let mut sock = FrameSocket::new(raw);
+
+ assert_eq!(
+ sock.read(None).unwrap().unwrap().into_data(),
+ vec![0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]
+ );
+ assert_eq!(sock.read(None).unwrap().unwrap().into_data(), vec![0x03, 0x02, 0x01]);
+ assert!(sock.read(None).unwrap().is_none());
+
+ let (_, rest) = sock.into_inner();
+ assert_eq!(rest, vec![0x99]);
+ }
+
+ #[test]
+ fn from_partially_read() {
+ let raw = Cursor::new(vec![0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
+ let mut sock = FrameSocket::from_partially_read(raw, vec![0x82, 0x07, 0x01]);
+ assert_eq!(
+ sock.read(None).unwrap().unwrap().into_data(),
+ vec![0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]
+ );
+ }
+
+ #[test]
+ fn write_frames() {
+ let mut sock = FrameSocket::new(Vec::new());
+
+ let frame = Frame::ping(vec![0x04, 0x05]);
+ sock.send(frame).unwrap();
+
+ let frame = Frame::pong(vec![0x01]);
+ sock.send(frame).unwrap();
+
+ let (buf, _) = sock.into_inner();
+ assert_eq!(buf, vec![0x89, 0x02, 0x04, 0x05, 0x8a, 0x01, 0x01]);
+ }
+
+ #[test]
+ fn parse_overflow() {
+ let raw = Cursor::new(vec![
+ 0x83, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x00,
+ ]);
+ let mut sock = FrameSocket::new(raw);
+ let _ = sock.read(None); // should not crash
+ }
+
+ #[test]
+ fn size_limit_hit() {
+ let raw = Cursor::new(vec![0x82, 0x07, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
+ let mut sock = FrameSocket::new(raw);
+ assert!(matches!(
+ sock.read(Some(5)),
+ Err(Error::Capacity(CapacityError::MessageTooLong { size: 7, max_size: 5 }))
+ ));
+ }
+}
diff --git a/crates/tungstenite/src/protocol/message.rs b/crates/tungstenite/src/protocol/message.rs
new file mode 100644
index 0000000..2b2ed0b
--- /dev/null
+++ b/crates/tungstenite/src/protocol/message.rs
@@ -0,0 +1,370 @@
+use std::{
+ convert::{AsRef, From, Into, TryFrom},
+ fmt,
+ result::Result as StdResult,
+ str,
+};
+
+use super::frame::{CloseFrame, Frame};
+use crate::error::{CapacityError, Error, Result};
+
+mod string_collect {
+ use utf8::DecodeError;
+
+ use crate::error::{Error, Result};
+
+ #[derive(Debug)]
+ pub struct StringCollector {
+ data: String,
+ incomplete: Option<utf8::Incomplete>,
+ }
+
+ impl StringCollector {
+ pub fn new() -> Self {
+ StringCollector { data: String::new(), incomplete: None }
+ }
+
+ pub fn len(&self) -> usize {
+ self.data
+ .len()
+ .saturating_add(self.incomplete.map(|i| i.buffer_len as usize).unwrap_or(0))
+ }
+
+ pub fn extend<T: AsRef<[u8]>>(&mut self, tail: T) -> Result<()> {
+ let mut input: &[u8] = tail.as_ref();
+
+ if let Some(mut incomplete) = self.incomplete.take() {
+ if let Some((result, rest)) = incomplete.try_complete(input) {
+ input = rest;
+ if let Ok(text) = result {
+ self.data.push_str(text);
+ } else {
+ return Err(Error::Utf8);
+ }
+ } else {
+ input = &[];
+ self.incomplete = Some(incomplete);
+ }
+ }
+
+ if !input.is_empty() {
+ match utf8::decode(input) {
+ Ok(text) => {
+ self.data.push_str(text);
+ Ok(())
+ }
+ Err(DecodeError::Incomplete { valid_prefix, incomplete_suffix }) => {
+ self.data.push_str(valid_prefix);
+ self.incomplete = Some(incomplete_suffix);
+ Ok(())
+ }
+ Err(DecodeError::Invalid { valid_prefix, .. }) => {
+ self.data.push_str(valid_prefix);
+ Err(Error::Utf8)
+ }
+ }
+ } else {
+ Ok(())
+ }
+ }
+
+ pub fn into_string(self) -> Result<String> {
+ if self.incomplete.is_some() {
+ Err(Error::Utf8)
+ } else {
+ Ok(self.data)
+ }
+ }
+ }
+}
+
+use self::string_collect::StringCollector;
+
+/// A struct representing the incomplete message.
+#[derive(Debug)]
+pub struct IncompleteMessage {
+ collector: IncompleteMessageCollector,
+}
+
+#[derive(Debug)]
+enum IncompleteMessageCollector {
+ Text(StringCollector),
+ Binary(Vec<u8>),
+}
+
+impl IncompleteMessage {
+ /// Create new.
+ pub fn new(message_type: IncompleteMessageType) -> Self {
+ IncompleteMessage {
+ collector: match message_type {
+ IncompleteMessageType::Binary => IncompleteMessageCollector::Binary(Vec::new()),
+ IncompleteMessageType::Text => {
+ IncompleteMessageCollector::Text(StringCollector::new())
+ }
+ },
+ }
+ }
+
+ /// Get the current filled size of the buffer.
+ pub fn len(&self) -> usize {
+ match self.collector {
+ IncompleteMessageCollector::Text(ref t) => t.len(),
+ IncompleteMessageCollector::Binary(ref b) => b.len(),
+ }
+ }
+
+ /// Add more data to an existing message.
+ pub fn extend<T: AsRef<[u8]>>(&mut self, tail: T, size_limit: Option<usize>) -> Result<()> {
+ // Always have a max size. This ensures an error in case of concatenating two buffers
+ // of more than `usize::max_value()` bytes in total.
+ let max_size = size_limit.unwrap_or_else(usize::max_value);
+ let my_size = self.len();
+ let portion_size = tail.as_ref().len();
+ // Be careful about integer overflows here.
+ if my_size > max_size || portion_size > max_size - my_size {
+ return Err(Error::Capacity(CapacityError::MessageTooLong {
+ size: my_size + portion_size,
+ max_size,
+ }));
+ }
+
+ match self.collector {
+ IncompleteMessageCollector::Binary(ref mut v) => {
+ v.extend(tail.as_ref());
+ Ok(())
+ }
+ IncompleteMessageCollector::Text(ref mut t) => t.extend(tail),
+ }
+ }
+
+ /// Convert an incomplete message into a complete one.
+ pub fn complete(self) -> Result<Message> {
+ match self.collector {
+ IncompleteMessageCollector::Binary(v) => Ok(Message::Binary(v)),
+ IncompleteMessageCollector::Text(t) => {
+ let text = t.into_string()?;
+ Ok(Message::Text(text))
+ }
+ }
+ }
+}
+
+/// The type of incomplete message.
+pub enum IncompleteMessageType {
+ Text,
+ Binary,
+}
+
+/// An enum representing the various forms of a WebSocket message.
+#[derive(Debug, Eq, PartialEq, Clone)]
+pub enum Message {
+ /// A text WebSocket message
+ Text(String),
+ /// A binary WebSocket message
+ Binary(Vec<u8>),
+ /// A ping message with the specified payload
+ ///
+ /// The payload here must have a length less than 125 bytes
+ Ping(Vec<u8>),
+ /// A pong message with the specified payload
+ ///
+ /// The payload here must have a length less than 125 bytes
+ Pong(Vec<u8>),
+ /// A close message with the optional close frame.
+ Close(Option<CloseFrame<'static>>),
+ /// Raw frame. Note, that you're not going to get this value while reading the message.
+ Frame(Frame),
+}
+
+impl Message {
+ /// Create a new text WebSocket message from a stringable.
+ pub fn text<S>(string: S) -> Message
+ where
+ S: Into<String>,
+ {
+ Message::Text(string.into())
+ }
+
+ /// Create a new binary WebSocket message by converting to `Vec<u8>`.
+ pub fn binary<B>(bin: B) -> Message
+ where
+ B: Into<Vec<u8>>,
+ {
+ Message::Binary(bin.into())
+ }
+
+ /// Indicates whether a message is a text message.
+ pub fn is_text(&self) -> bool {
+ matches!(*self, Message::Text(_))
+ }
+
+ /// Indicates whether a message is a binary message.
+ pub fn is_binary(&self) -> bool {
+ matches!(*self, Message::Binary(_))
+ }
+
+ /// Indicates whether a message is a ping message.
+ pub fn is_ping(&self) -> bool {
+ matches!(*self, Message::Ping(_))
+ }
+
+ /// Indicates whether a message is a pong message.
+ pub fn is_pong(&self) -> bool {
+ matches!(*self, Message::Pong(_))
+ }
+
+ /// Indicates whether a message is a close message.
+ pub fn is_close(&self) -> bool {
+ matches!(*self, Message::Close(_))
+ }
+
+ /// Get the length of the WebSocket message.
+ pub fn len(&self) -> usize {
+ match *self {
+ Message::Text(ref string) => string.len(),
+ Message::Binary(ref data) | Message::Ping(ref data) | Message::Pong(ref data) => {
+ data.len()
+ }
+ Message::Close(ref data) => data.as_ref().map(|d| d.reason.len()).unwrap_or(0),
+ Message::Frame(ref frame) => frame.len(),
+ }
+ }
+
+ /// Returns true if the WebSocket message has no content.
+ /// For example, if the other side of the connection sent an empty string.
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// Consume the WebSocket and return it as binary data.
+ pub fn into_data(self) -> Vec<u8> {
+ match self {
+ Message::Text(string) => string.into_bytes(),
+ Message::Binary(data) | Message::Ping(data) | Message::Pong(data) => data,
+ Message::Close(None) => Vec::new(),
+ Message::Close(Some(frame)) => frame.reason.into_owned().into_bytes(),
+ Message::Frame(frame) => frame.into_data(),
+ }
+ }
+
+ /// Attempt to consume the WebSocket message and convert it to a String.
+ pub fn into_text(self) -> Result<String> {
+ match self {
+ Message::Text(string) => Ok(string),
+ Message::Binary(data) | Message::Ping(data) | Message::Pong(data) => {
+ Ok(String::from_utf8(data)?)
+ }
+ Message::Close(None) => Ok(String::new()),
+ Message::Close(Some(frame)) => Ok(frame.reason.into_owned()),
+ Message::Frame(frame) => Ok(frame.into_string()?),
+ }
+ }
+
+ /// Attempt to get a &str from the WebSocket message,
+ /// this will try to convert binary data to utf8.
+ pub fn to_text(&self) -> Result<&str> {
+ match *self {
+ Message::Text(ref string) => Ok(string),
+ Message::Binary(ref data) | Message::Ping(ref data) | Message::Pong(ref data) => {
+ Ok(str::from_utf8(data)?)
+ }
+ Message::Close(None) => Ok(""),
+ Message::Close(Some(ref frame)) => Ok(&frame.reason),
+ Message::Frame(ref frame) => Ok(frame.to_text()?),
+ }
+ }
+}
+
+impl From<String> for Message {
+ fn from(string: String) -> Self {
+ Message::text(string)
+ }
+}
+
+impl<'s> From<&'s str> for Message {
+ fn from(string: &'s str) -> Self {
+ Message::text(string)
+ }
+}
+
+impl<'b> From<&'b [u8]> for Message {
+ fn from(data: &'b [u8]) -> Self {
+ Message::binary(data)
+ }
+}
+
+impl From<Vec<u8>> for Message {
+ fn from(data: Vec<u8>) -> Self {
+ Message::binary(data)
+ }
+}
+
+impl From<Message> for Vec<u8> {
+ fn from(message: Message) -> Self {
+ message.into_data()
+ }
+}
+
+impl TryFrom<Message> for String {
+ type Error = Error;
+
+ fn try_from(value: Message) -> StdResult<Self, Self::Error> {
+ value.into_text()
+ }
+}
+
+impl fmt::Display for Message {
+ fn fmt(&self, f: &mut fmt::Formatter) -> StdResult<(), fmt::Error> {
+ if let Ok(string) = self.to_text() {
+ write!(f, "{}", string)
+ } else {
+ write!(f, "Binary Data<length={}>", self.len())
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn display() {
+ let t = Message::text("test".to_owned());
+ assert_eq!(t.to_string(), "test".to_owned());
+
+ let bin = Message::binary(vec![0, 1, 3, 4, 241]);
+ assert_eq!(bin.to_string(), "Binary Data<length=5>".to_owned());
+ }
+
+ #[test]
+ fn binary_convert() {
+ let bin = [6u8, 7, 8, 9, 10, 241];
+ let msg = Message::from(&bin[..]);
+ assert!(msg.is_binary());
+ assert!(msg.into_text().is_err());
+ }
+
+ #[test]
+ fn binary_convert_vec() {
+ let bin = vec![6u8, 7, 8, 9, 10, 241];
+ let msg = Message::from(bin);
+ assert!(msg.is_binary());
+ assert!(msg.into_text().is_err());
+ }
+
+ #[test]
+ fn binary_convert_into_vec() {
+ let bin = vec![6u8, 7, 8, 9, 10, 241];
+ let bin_copy = bin.clone();
+ let msg = Message::from(bin);
+ let serialized: Vec<u8> = msg.into();
+ assert_eq!(bin_copy, serialized);
+ }
+
+ #[test]
+ fn text_convert() {
+ let s = "kiwotsukete";
+ let msg = Message::from(s);
+ assert!(msg.is_text());
+ }
+}
diff --git a/crates/tungstenite/src/protocol/mod.rs b/crates/tungstenite/src/protocol/mod.rs
new file mode 100644
index 0000000..21c996a
--- /dev/null
+++ b/crates/tungstenite/src/protocol/mod.rs
@@ -0,0 +1,861 @@
+//! Generic WebSocket message stream.
+
+pub mod frame;
+
+mod message;
+
+pub use self::{frame::CloseFrame, message::Message};
+
+use self::{
+ frame::{
+ coding::{CloseCode, Control as OpCtl, Data as OpData, OpCode},
+ Frame, FrameCodec,
+ },
+ message::{IncompleteMessage, IncompleteMessageType},
+};
+use crate::error::{Error, ProtocolError, Result};
+use log::*;
+use std::{
+ io::{self, Read, Write},
+ mem::replace,
+};
+
+/// Indicates a Client or Server role of the websocket
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub enum Role {
+ /// This socket is a server
+ Server,
+ /// This socket is a client
+ Client,
+}
+
+/// The configuration for WebSocket connection.
+#[derive(Debug, Clone, Copy)]
+pub struct WebSocketConfig {
+ /// Does nothing, instead use `max_write_buffer_size`.
+ #[deprecated]
+ pub max_send_queue: Option<usize>,
+ /// The target minimum size of the write buffer to reach before writing the data
+ /// to the underlying stream.
+ /// The default value is 128 KiB.
+ ///
+ /// If set to `0` each message will be eagerly written to the underlying stream.
+ /// It is often more optimal to allow them to buffer a little, hence the default value.
+ ///
+ /// Note: [`flush`](WebSocket::flush) will always fully write the buffer regardless.
+ pub write_buffer_size: usize,
+ /// The max size of the write buffer in bytes. Setting this can provide backpressure
+ /// in the case the write buffer is filling up due to write errors.
+ /// The default value is unlimited.
+ ///
+ /// Note: The write buffer only builds up past [`write_buffer_size`](Self::write_buffer_size)
+ /// when writes to the underlying stream are failing. So the **write buffer can not
+ /// fill up if you are not observing write errors even if not flushing**.
+ ///
+ /// Note: Should always be at least [`write_buffer_size + 1 message`](Self::write_buffer_size)
+ /// and probably a little more depending on error handling strategy.
+ pub max_write_buffer_size: usize,
+ /// The maximum size of an incoming message. `None` means no size limit. The default value is 64 MiB
+ /// which should be reasonably big for all normal use-cases but small enough to prevent
+ /// memory eating by a malicious user.
+ pub max_message_size: Option<usize>,
+ /// The maximum size of a single incoming message frame. `None` means no size limit. The limit is for
+ /// frame payload NOT including the frame header. The default value is 16 MiB which should
+ /// be reasonably big for all normal use-cases but small enough to prevent memory eating
+ /// by a malicious user.
+ pub max_frame_size: Option<usize>,
+ /// When set to `true`, the server will accept and handle unmasked frames
+ /// from the client. According to the RFC 6455, the server must close the
+ /// connection to the client in such cases, however it seems like there are
+ /// some popular libraries that are sending unmasked frames, ignoring the RFC.
+ /// By default this option is set to `false`, i.e. according to RFC 6455.
+ pub accept_unmasked_frames: bool,
+}
+
+impl Default for WebSocketConfig {
+ fn default() -> Self {
+ #[allow(deprecated)]
+ WebSocketConfig {
+ max_send_queue: None,
+ write_buffer_size: 128 * 1024,
+ max_write_buffer_size: usize::MAX,
+ max_message_size: Some(64 << 20),
+ max_frame_size: Some(16 << 20),
+ accept_unmasked_frames: false,
+ }
+ }
+}
+
+impl WebSocketConfig {
+ /// Panic if values are invalid.
+ pub(crate) fn assert_valid(&self) {
+ assert!(
+ self.max_write_buffer_size > self.write_buffer_size,
+ "WebSocketConfig::max_write_buffer_size must be greater than write_buffer_size, \
+ see WebSocketConfig docs`"
+ );
+ }
+}
+
+/// WebSocket input-output stream.
+///
+/// This is THE structure you want to create to be able to speak the WebSocket protocol.
+/// It may be created by calling `connect`, `accept` or `client` functions.
+///
+/// Use [`WebSocket::read`], [`WebSocket::send`] to received and send messages.
+#[derive(Debug)]
+pub struct WebSocket<Stream> {
+ /// The underlying socket.
+ socket: Stream,
+ /// The context for managing a WebSocket.
+ context: WebSocketContext,
+}
+
+impl<Stream> WebSocket<Stream> {
+ /// Convert a raw socket into a WebSocket without performing a handshake.
+ ///
+ /// Call this function if you're using Tungstenite as a part of a web framework
+ /// or together with an existing one. If you need an initial handshake, use
+ /// `connect()` or `accept()` functions of the crate to construct a websocket.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn from_raw_socket(stream: Stream, role: Role, config: Option<WebSocketConfig>) -> Self {
+ WebSocket { socket: stream, context: WebSocketContext::new(role, config) }
+ }
+
+ /// Convert a raw socket into a WebSocket without performing a handshake.
+ ///
+ /// Call this function if you're using Tungstenite as a part of a web framework
+ /// or together with an existing one. If you need an initial handshake, use
+ /// `connect()` or `accept()` functions of the crate to construct a websocket.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn from_partially_read(
+ stream: Stream,
+ part: Vec<u8>,
+ role: Role,
+ config: Option<WebSocketConfig>,
+ ) -> Self {
+ WebSocket {
+ socket: stream,
+ context: WebSocketContext::from_partially_read(part, role, config),
+ }
+ }
+
+ /// Returns a shared reference to the inner stream.
+ pub fn get_ref(&self) -> &Stream {
+ &self.socket
+ }
+ /// Returns a mutable reference to the inner stream.
+ pub fn get_mut(&mut self) -> &mut Stream {
+ &mut self.socket
+ }
+
+ /// Change the configuration.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn set_config(&mut self, set_func: impl FnOnce(&mut WebSocketConfig)) {
+ self.context.set_config(set_func)
+ }
+
+ /// Read the configuration.
+ pub fn get_config(&self) -> &WebSocketConfig {
+ self.context.get_config()
+ }
+
+ /// Check if it is possible to read messages.
+ ///
+ /// Reading is impossible after receiving `Message::Close`. It is still possible after
+ /// sending close frame since the peer still may send some data before confirming close.
+ pub fn can_read(&self) -> bool {
+ self.context.can_read()
+ }
+
+ /// Check if it is possible to write messages.
+ ///
+ /// Writing gets impossible immediately after sending or receiving `Message::Close`.
+ pub fn can_write(&self) -> bool {
+ self.context.can_write()
+ }
+}
+
+impl<Stream: Read + Write> WebSocket<Stream> {
+ /// Read a message from stream, if possible.
+ ///
+ /// This will also queue responses to ping and close messages. These responses
+ /// will be written and flushed on the next call to [`read`](Self::read),
+ /// [`write`](Self::write) or [`flush`](Self::flush).
+ ///
+ /// # Closing the connection
+ /// When the remote endpoint decides to close the connection this will return
+ /// the close message with an optional close frame.
+ ///
+ /// You should continue calling [`read`](Self::read), [`write`](Self::write) or
+ /// [`flush`](Self::flush) to drive the reply to the close frame until [`Error::ConnectionClosed`]
+ /// is returned. Once that happens it is safe to drop the underlying connection.
+ pub fn read(&mut self) -> Result<Message> {
+ self.context.read(&mut self.socket)
+ }
+
+ /// Writes and immediately flushes a message.
+ /// Equivalent to calling [`write`](Self::write) then [`flush`](Self::flush).
+ pub fn send(&mut self, message: Message) -> Result<()> {
+ self.write(message)?;
+ self.flush()
+ }
+
+ /// Write a message to the provided stream, if possible.
+ ///
+ /// A subsequent call should be made to [`flush`](Self::flush) to flush writes.
+ ///
+ /// In the event of stream write failure the message frame will be stored
+ /// in the write buffer and will try again on the next call to [`write`](Self::write)
+ /// or [`flush`](Self::flush).
+ ///
+ /// If the write buffer would exceed the configured [`WebSocketConfig::max_write_buffer_size`]
+ /// [`Err(WriteBufferFull(msg_frame))`](Error::WriteBufferFull) is returned.
+ ///
+ /// This call will generally not flush. However, if there are queued automatic messages
+ /// they will be written and eagerly flushed.
+ ///
+ /// For example, upon receiving ping messages tungstenite queues pong replies automatically.
+ /// The next call to [`read`](Self::read), [`write`](Self::write) or [`flush`](Self::flush)
+ /// will write & flush the pong reply. This means you should not respond to ping frames manually.
+ ///
+ /// You can however send pong frames manually in order to indicate a unidirectional heartbeat
+ /// as described in [RFC 6455](https://tools.ietf.org/html/rfc6455#section-5.5.3). Note that
+ /// if [`read`](Self::read) returns a ping, you should [`flush`](Self::flush) before passing
+ /// a custom pong to [`write`](Self::write), otherwise the automatic queued response to the
+ /// ping will not be sent as it will be replaced by your custom pong message.
+ ///
+ /// # Errors
+ /// - If the WebSocket's write buffer is full, [`Error::WriteBufferFull`] will be returned
+ /// along with the equivalent passed message frame.
+ /// - If the connection is closed and should be dropped, this will return [`Error::ConnectionClosed`].
+ /// - If you try again after [`Error::ConnectionClosed`] was returned either from here or from
+ /// [`read`](Self::read), [`Error::AlreadyClosed`] will be returned. This indicates a program
+ /// error on your part.
+ /// - [`Error::Io`] is returned if the underlying connection returns an error
+ /// (consider these fatal except for WouldBlock).
+ /// - [`Error::Capacity`] if your message size is bigger than the configured max message size.
+ pub fn write(&mut self, message: Message) -> Result<()> {
+ self.context.write(&mut self.socket, message)
+ }
+
+ /// Flush writes.
+ ///
+ /// Ensures all messages previously passed to [`write`](Self::write) and automatic
+ /// queued pong responses are written & flushed into the underlying stream.
+ pub fn flush(&mut self) -> Result<()> {
+ self.context.flush(&mut self.socket)
+ }
+
+ /// Close the connection.
+ ///
+ /// This function guarantees that the close frame will be queued.
+ /// There is no need to call it again. Calling this function is
+ /// the same as calling `write(Message::Close(..))`.
+ ///
+ /// After queuing the close frame you should continue calling [`read`](Self::read) or
+ /// [`flush`](Self::flush) to drive the close handshake to completion.
+ ///
+ /// The websocket RFC defines that the underlying connection should be closed
+ /// by the server. Tungstenite takes care of this asymmetry for you.
+ ///
+ /// When the close handshake is finished (we have both sent and received
+ /// a close message), [`read`](Self::read) or [`flush`](Self::flush) will return
+ /// [Error::ConnectionClosed] if this endpoint is the server.
+ ///
+ /// If this endpoint is a client, [Error::ConnectionClosed] will only be
+ /// returned after the server has closed the underlying connection.
+ ///
+ /// It is thus safe to drop the underlying connection as soon as [Error::ConnectionClosed]
+ /// is returned from [`read`](Self::read) or [`flush`](Self::flush).
+ pub fn close(&mut self, code: Option<CloseFrame>) -> Result<()> {
+ self.context.close(&mut self.socket, code)
+ }
+
+ /// Old name for [`read`](Self::read).
+ #[deprecated(note = "Use `read`")]
+ pub fn read_message(&mut self) -> Result<Message> {
+ self.read()
+ }
+
+ /// Old name for [`send`](Self::send).
+ #[deprecated(note = "Use `send`")]
+ pub fn write_message(&mut self, message: Message) -> Result<()> {
+ self.send(message)
+ }
+
+ /// Old name for [`flush`](Self::flush).
+ #[deprecated(note = "Use `flush`")]
+ pub fn write_pending(&mut self) -> Result<()> {
+ self.flush()
+ }
+}
+
+/// A context for managing WebSocket stream.
+#[derive(Debug)]
+pub struct WebSocketContext {
+ /// Server or client?
+ role: Role,
+ /// encoder/decoder of frame.
+ frame: FrameCodec,
+ /// The state of processing, either "active" or "closing".
+ state: WebSocketState,
+ /// Receive: an incomplete message being processed.
+ incomplete: Option<IncompleteMessage>,
+ /// Send in addition to regular messages E.g. "pong" or "close".
+ additional_send: Option<Frame>,
+ /// True indicates there is an additional message (like a pong)
+ /// that failed to flush previously and we should try again.
+ unflushed_additional: bool,
+ /// The configuration for the websocket session.
+ config: WebSocketConfig,
+}
+
+impl WebSocketContext {
+ /// Create a WebSocket context that manages a post-handshake stream.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn new(role: Role, config: Option<WebSocketConfig>) -> Self {
+ Self::_new(role, FrameCodec::new(), config.unwrap_or_default())
+ }
+
+ /// Create a WebSocket context that manages an post-handshake stream.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn from_partially_read(part: Vec<u8>, role: Role, config: Option<WebSocketConfig>) -> Self {
+ Self::_new(role, FrameCodec::from_partially_read(part), config.unwrap_or_default())
+ }
+
+ fn _new(role: Role, mut frame: FrameCodec, config: WebSocketConfig) -> Self {
+ config.assert_valid();
+ frame.set_max_out_buffer_len(config.max_write_buffer_size);
+ frame.set_out_buffer_write_len(config.write_buffer_size);
+ Self {
+ role,
+ frame,
+ state: WebSocketState::Active,
+ incomplete: None,
+ additional_send: None,
+ unflushed_additional: false,
+ config,
+ }
+ }
+
+ /// Change the configuration.
+ ///
+ /// # Panics
+ /// Panics if config is invalid e.g. `max_write_buffer_size <= write_buffer_size`.
+ pub fn set_config(&mut self, set_func: impl FnOnce(&mut WebSocketConfig)) {
+ set_func(&mut self.config);
+ self.config.assert_valid();
+ self.frame.set_max_out_buffer_len(self.config.max_write_buffer_size);
+ self.frame.set_out_buffer_write_len(self.config.write_buffer_size);
+ }
+
+ /// Read the configuration.
+ pub fn get_config(&self) -> &WebSocketConfig {
+ &self.config
+ }
+
+ /// Check if it is possible to read messages.
+ ///
+ /// Reading is impossible after receiving `Message::Close`. It is still possible after
+ /// sending close frame since the peer still may send some data before confirming close.
+ pub fn can_read(&self) -> bool {
+ self.state.can_read()
+ }
+
+ /// Check if it is possible to write messages.
+ ///
+ /// Writing gets impossible immediately after sending or receiving `Message::Close`.
+ pub fn can_write(&self) -> bool {
+ self.state.is_active()
+ }
+
+ /// Read a message from the provided stream, if possible.
+ ///
+ /// This function sends pong and close responses automatically.
+ /// However, it never blocks on write.
+ pub fn read<Stream>(&mut self, stream: &mut Stream) -> Result<Message>
+ where
+ Stream: Read + Write,
+ {
+ // Do not read from already closed connections.
+ self.state.check_not_terminated()?;
+
+ loop {
+ if self.additional_send.is_some() || self.unflushed_additional {
+ // Since we may get ping or close, we need to reply to the messages even during read.
+ match self.flush(stream) {
+ Ok(_) => {}
+ Err(Error::Io(err)) if err.kind() == io::ErrorKind::WouldBlock => {
+ // If blocked continue reading, but try again later
+ self.unflushed_additional = true;
+ }
+ Err(err) => return Err(err),
+ }
+ } else if self.role == Role::Server && !self.state.can_read() {
+ self.state = WebSocketState::Terminated;
+ return Err(Error::ConnectionClosed);
+ }
+
+ // If we get here, either write blocks or we have nothing to write.
+ // Thus if read blocks, just let it return WouldBlock.
+ if let Some(message) = self.read_message_frame(stream)? {
+ trace!("Received message {}", message);
+ return Ok(message);
+ }
+ }
+ }
+
+ /// Write a message to the provided stream.
+ ///
+ /// A subsequent call should be made to [`flush`](Self::flush) to flush writes.
+ ///
+ /// In the event of stream write failure the message frame will be stored
+ /// in the write buffer and will try again on the next call to [`write`](Self::write)
+ /// or [`flush`](Self::flush).
+ ///
+ /// If the write buffer would exceed the configured [`WebSocketConfig::max_write_buffer_size`]
+ /// [`Err(WriteBufferFull(msg_frame))`](Error::WriteBufferFull) is returned.
+ pub fn write<Stream>(&mut self, stream: &mut Stream, message: Message) -> Result<()>
+ where
+ Stream: Read + Write,
+ {
+ // When terminated, return AlreadyClosed.
+ self.state.check_not_terminated()?;
+
+ // Do not write after sending a close frame.
+ if !self.state.is_active() {
+ return Err(Error::Protocol(ProtocolError::SendAfterClosing));
+ }
+
+ let frame = match message {
+ Message::Text(data) => Frame::message(data.into(), OpCode::Data(OpData::Text), true),
+ Message::Binary(data) => Frame::message(data, OpCode::Data(OpData::Binary), true),
+ Message::Ping(data) => Frame::ping(data),
+ Message::Pong(data) => {
+ self.set_additional(Frame::pong(data));
+ // Note: user pongs can be user flushed so no need to flush here
+ return self._write(stream, None).map(|_| ());
+ }
+ Message::Close(code) => return self.close(stream, code),
+ Message::Frame(f) => f,
+ };
+
+ let should_flush = self._write(stream, Some(frame))?;
+ if should_flush {
+ self.flush(stream)?;
+ }
+ Ok(())
+ }
+
+ /// Flush writes.
+ ///
+ /// Ensures all messages previously passed to [`write`](Self::write) and automatically
+ /// queued pong responses are written & flushed into the `stream`.
+ #[inline]
+ pub fn flush<Stream>(&mut self, stream: &mut Stream) -> Result<()>
+ where
+ Stream: Read + Write,
+ {
+ self._write(stream, None)?;
+ self.frame.write_out_buffer(stream)?;
+ stream.flush()?;
+ self.unflushed_additional = false;
+ Ok(())
+ }
+
+ /// Writes any data in the out_buffer, `additional_send` and given `data`.
+ ///
+ /// Does **not** flush.
+ ///
+ /// Returns true if the write contents indicate we should flush immediately.
+ fn _write<Stream>(&mut self, stream: &mut Stream, data: Option<Frame>) -> Result<bool>
+ where
+ Stream: Read + Write,
+ {
+ if let Some(data) = data {
+ self.buffer_frame(stream, data)?;
+ }
+
+ // Upon receipt of a Ping frame, an endpoint MUST send a Pong frame in
+ // response, unless it already received a Close frame. It SHOULD
+ // respond with Pong frame as soon as is practical. (RFC 6455)
+ let should_flush = if let Some(msg) = self.additional_send.take() {
+ trace!("Sending pong/close");
+ match self.buffer_frame(stream, msg) {
+ Err(Error::WriteBufferFull(Message::Frame(msg))) => {
+ // if an system message would exceed the buffer put it back in
+ // `additional_send` for retry. Otherwise returning this error
+ // may not make sense to the user, e.g. calling `flush`.
+ self.set_additional(msg);
+ false
+ }
+ Err(err) => return Err(err),
+ Ok(_) => true,
+ }
+ } else {
+ self.unflushed_additional
+ };
+
+ // If we're closing and there is nothing to send anymore, we should close the connection.
+ if self.role == Role::Server && !self.state.can_read() {
+ // The underlying TCP connection, in most normal cases, SHOULD be closed
+ // first by the server, so that it holds the TIME_WAIT state and not the
+ // client (as this would prevent it from re-opening the connection for 2
+ // maximum segment lifetimes (2MSL), while there is no corresponding
+ // server impact as a TIME_WAIT connection is immediately reopened upon
+ // a new SYN with a higher seq number). (RFC 6455)
+ self.frame.write_out_buffer(stream)?;
+ self.state = WebSocketState::Terminated;
+ Err(Error::ConnectionClosed)
+ } else {
+ Ok(should_flush)
+ }
+ }
+
+ /// Close the connection.
+ ///
+ /// This function guarantees that the close frame will be queued.
+ /// There is no need to call it again. Calling this function is
+ /// the same as calling `send(Message::Close(..))`.
+ pub fn close<Stream>(&mut self, stream: &mut Stream, code: Option<CloseFrame>) -> Result<()>
+ where
+ Stream: Read + Write,
+ {
+ if let WebSocketState::Active = self.state {
+ self.state = WebSocketState::ClosedByUs;
+ let frame = Frame::close(code);
+ self._write(stream, Some(frame))?;
+ }
+ self.flush(stream)
+ }
+
+ /// Try to decode one message frame. May return None.
+ fn read_message_frame<Stream>(&mut self, stream: &mut Stream) -> Result<Option<Message>>
+ where
+ Stream: Read + Write,
+ {
+ if let Some(mut frame) = self
+ .frame
+ .read_frame(stream, self.config.max_frame_size)
+ .check_connection_reset(self.state)?
+ {
+ if !self.state.can_read() {
+ return Err(Error::Protocol(ProtocolError::ReceivedAfterClosing));
+ }
+ // MUST be 0 unless an extension is negotiated that defines meanings
+ // for non-zero values. If a nonzero value is received and none of
+ // the negotiated extensions defines the meaning of such a nonzero
+ // value, the receiving endpoint MUST _Fail the WebSocket
+ // Connection_.
+ {
+ let hdr = frame.header();
+ if hdr.rsv1 || hdr.rsv2 || hdr.rsv3 {
+ return Err(Error::Protocol(ProtocolError::NonZeroReservedBits));
+ }
+ }
+
+ match self.role {
+ Role::Server => {
+ if frame.is_masked() {
+ // A server MUST remove masking for data frames received from a client
+ // as described in Section 5.3. (RFC 6455)
+ frame.apply_mask()
+ } else if !self.config.accept_unmasked_frames {
+ // The server MUST close the connection upon receiving a
+ // frame that is not masked. (RFC 6455)
+ // The only exception here is if the user explicitly accepts given
+ // stream by setting WebSocketConfig.accept_unmasked_frames to true
+ return Err(Error::Protocol(ProtocolError::UnmaskedFrameFromClient));
+ }
+ }
+ Role::Client => {
+ if frame.is_masked() {
+ // A client MUST close a connection if it detects a masked frame. (RFC 6455)
+ return Err(Error::Protocol(ProtocolError::MaskedFrameFromServer));
+ }
+ }
+ }
+
+ match frame.header().opcode {
+ OpCode::Control(ctl) => {
+ match ctl {
+ // All control frames MUST have a payload length of 125 bytes or less
+ // and MUST NOT be fragmented. (RFC 6455)
+ _ if !frame.header().is_final => {
+ Err(Error::Protocol(ProtocolError::FragmentedControlFrame))
+ }
+ _ if frame.payload().len() > 125 => {
+ Err(Error::Protocol(ProtocolError::ControlFrameTooBig))
+ }
+ OpCtl::Close => Ok(self.do_close(frame.into_close()?).map(Message::Close)),
+ OpCtl::Reserved(i) => {
+ Err(Error::Protocol(ProtocolError::UnknownControlFrameType(i)))
+ }
+ OpCtl::Ping => {
+ let data = frame.into_data();
+ // No ping processing after we sent a close frame.
+ if self.state.is_active() {
+ self.set_additional(Frame::pong(data.clone()));
+ }
+ Ok(Some(Message::Ping(data)))
+ }
+ OpCtl::Pong => Ok(Some(Message::Pong(frame.into_data()))),
+ }
+ }
+
+ OpCode::Data(data) => {
+ let fin = frame.header().is_final;
+ match data {
+ OpData::Continue => {
+ if let Some(ref mut msg) = self.incomplete {
+ msg.extend(frame.into_data(), self.config.max_message_size)?;
+ } else {
+ return Err(Error::Protocol(
+ ProtocolError::UnexpectedContinueFrame,
+ ));
+ }
+ if fin {
+ Ok(Some(self.incomplete.take().unwrap().complete()?))
+ } else {
+ Ok(None)
+ }
+ }
+ c if self.incomplete.is_some() => {
+ Err(Error::Protocol(ProtocolError::ExpectedFragment(c)))
+ }
+ OpData::Text | OpData::Binary => {
+ let msg = {
+ let message_type = match data {
+ OpData::Text => IncompleteMessageType::Text,
+ OpData::Binary => IncompleteMessageType::Binary,
+ _ => panic!("Bug: message is not text nor binary"),
+ };
+ let mut m = IncompleteMessage::new(message_type);
+ m.extend(frame.into_data(), self.config.max_message_size)?;
+ m
+ };
+ if fin {
+ Ok(Some(msg.complete()?))
+ } else {
+ self.incomplete = Some(msg);
+ Ok(None)
+ }
+ }
+ OpData::Reserved(i) => {
+ Err(Error::Protocol(ProtocolError::UnknownDataFrameType(i)))
+ }
+ }
+ }
+ } // match opcode
+ } else {
+ // Connection closed by peer
+ match replace(&mut self.state, WebSocketState::Terminated) {
+ WebSocketState::ClosedByPeer | WebSocketState::CloseAcknowledged => {
+ Err(Error::ConnectionClosed)
+ }
+ _ => Err(Error::Protocol(ProtocolError::ResetWithoutClosingHandshake)),
+ }
+ }
+ }
+
+ /// Received a close frame. Tells if we need to return a close frame to the user.
+ #[allow(clippy::option_option)]
+ fn do_close<'t>(&mut self, close: Option<CloseFrame<'t>>) -> Option<Option<CloseFrame<'t>>> {
+ debug!("Received close frame: {:?}", close);
+ match self.state {
+ WebSocketState::Active => {
+ self.state = WebSocketState::ClosedByPeer;
+
+ let close = close.map(|frame| {
+ if !frame.code.is_allowed() {
+ CloseFrame {
+ code: CloseCode::Protocol,
+ reason: "Protocol violation".into(),
+ }
+ } else {
+ frame
+ }
+ });
+
+ let reply = Frame::close(close.clone());
+ debug!("Replying to close with {:?}", reply);
+ self.set_additional(reply);
+
+ Some(close)
+ }
+ WebSocketState::ClosedByPeer | WebSocketState::CloseAcknowledged => {
+ // It is already closed, just ignore.
+ None
+ }
+ WebSocketState::ClosedByUs => {
+ // We received a reply.
+ self.state = WebSocketState::CloseAcknowledged;
+ Some(close)
+ }
+ WebSocketState::Terminated => unreachable!(),
+ }
+ }
+
+ /// Write a single frame into the write-buffer.
+ fn buffer_frame<Stream>(&mut self, stream: &mut Stream, mut frame: Frame) -> Result<()>
+ where
+ Stream: Read + Write,
+ {
+ match self.role {
+ Role::Server => {}
+ Role::Client => {
+ // 5. If the data is being sent by the client, the frame(s) MUST be
+ // masked as defined in Section 5.3. (RFC 6455)
+ frame.set_random_mask();
+ }
+ }
+
+ trace!("Sending frame: {:?}", frame);
+ self.frame.buffer_frame(stream, frame).check_connection_reset(self.state)
+ }
+
+ /// Replace `additional_send` if it is currently a `Pong` message.
+ fn set_additional(&mut self, add: Frame) {
+ let empty_or_pong = self
+ .additional_send
+ .as_ref()
+ .map_or(true, |f| f.header().opcode == OpCode::Control(OpCtl::Pong));
+ if empty_or_pong {
+ self.additional_send.replace(add);
+ }
+ }
+}
+
+/// The current connection state.
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+enum WebSocketState {
+ /// The connection is active.
+ Active,
+ /// We initiated a close handshake.
+ ClosedByUs,
+ /// The peer initiated a close handshake.
+ ClosedByPeer,
+ /// The peer replied to our close handshake.
+ CloseAcknowledged,
+ /// The connection does not exist anymore.
+ Terminated,
+}
+
+impl WebSocketState {
+ /// Tell if we're allowed to process normal messages.
+ fn is_active(self) -> bool {
+ matches!(self, WebSocketState::Active)
+ }
+
+ /// Tell if we should process incoming data. Note that if we send a close frame
+ /// but the remote hasn't confirmed, they might have sent data before they receive our
+ /// close frame, so we should still pass those to client code, hence ClosedByUs is valid.
+ fn can_read(self) -> bool {
+ matches!(self, WebSocketState::Active | WebSocketState::ClosedByUs)
+ }
+
+ /// Check if the state is active, return error if not.
+ fn check_not_terminated(self) -> Result<()> {
+ match self {
+ WebSocketState::Terminated => Err(Error::AlreadyClosed),
+ _ => Ok(()),
+ }
+ }
+}
+
+/// Translate "Connection reset by peer" into `ConnectionClosed` if appropriate.
+trait CheckConnectionReset {
+ fn check_connection_reset(self, state: WebSocketState) -> Self;
+}
+
+impl<T> CheckConnectionReset for Result<T> {
+ fn check_connection_reset(self, state: WebSocketState) -> Self {
+ match self {
+ Err(Error::Io(io_error)) => Err({
+ if !state.can_read() && io_error.kind() == io::ErrorKind::ConnectionReset {
+ Error::ConnectionClosed
+ } else {
+ Error::Io(io_error)
+ }
+ }),
+ x => x,
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{Message, Role, WebSocket, WebSocketConfig};
+ use crate::error::{CapacityError, Error};
+
+ use std::{io, io::Cursor};
+
+ struct WriteMoc<Stream>(Stream);
+
+ impl<Stream> io::Write for WriteMoc<Stream> {
+ fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
+ Ok(buf.len())
+ }
+ fn flush(&mut self) -> io::Result<()> {
+ Ok(())
+ }
+ }
+
+ impl<Stream: io::Read> io::Read for WriteMoc<Stream> {
+ fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
+ self.0.read(buf)
+ }
+ }
+
+ #[test]
+ fn receive_messages() {
+ let incoming = Cursor::new(vec![
+ 0x89, 0x02, 0x01, 0x02, 0x8a, 0x01, 0x03, 0x01, 0x07, 0x48, 0x65, 0x6c, 0x6c, 0x6f,
+ 0x2c, 0x20, 0x80, 0x06, 0x57, 0x6f, 0x72, 0x6c, 0x64, 0x21, 0x82, 0x03, 0x01, 0x02,
+ 0x03,
+ ]);
+ let mut socket = WebSocket::from_raw_socket(WriteMoc(incoming), Role::Client, None);
+ assert_eq!(socket.read().unwrap(), Message::Ping(vec![1, 2]));
+ assert_eq!(socket.read().unwrap(), Message::Pong(vec![3]));
+ assert_eq!(socket.read().unwrap(), Message::Text("Hello, World!".into()));
+ assert_eq!(socket.read().unwrap(), Message::Binary(vec![0x01, 0x02, 0x03]));
+ }
+
+ #[test]
+ fn size_limiting_text_fragmented() {
+ let incoming = Cursor::new(vec![
+ 0x01, 0x07, 0x48, 0x65, 0x6c, 0x6c, 0x6f, 0x2c, 0x20, 0x80, 0x06, 0x57, 0x6f, 0x72,
+ 0x6c, 0x64, 0x21,
+ ]);
+ let limit = WebSocketConfig { max_message_size: Some(10), ..WebSocketConfig::default() };
+ let mut socket = WebSocket::from_raw_socket(WriteMoc(incoming), Role::Client, Some(limit));
+
+ assert!(matches!(
+ socket.read(),
+ Err(Error::Capacity(CapacityError::MessageTooLong { size: 13, max_size: 10 }))
+ ));
+ }
+
+ #[test]
+ fn size_limiting_binary() {
+ let incoming = Cursor::new(vec![0x82, 0x03, 0x01, 0x02, 0x03]);
+ let limit = WebSocketConfig { max_message_size: Some(2), ..WebSocketConfig::default() };
+ let mut socket = WebSocket::from_raw_socket(WriteMoc(incoming), Role::Client, Some(limit));
+
+ assert!(matches!(
+ socket.read(),
+ Err(Error::Capacity(CapacityError::MessageTooLong { size: 3, max_size: 2 }))
+ ));
+ }
+}
diff --git a/crates/tungstenite/src/server.rs b/crates/tungstenite/src/server.rs
new file mode 100644
index 0000000..e79bccb
--- /dev/null
+++ b/crates/tungstenite/src/server.rs
@@ -0,0 +1,68 @@
+//! Methods to accept an incoming WebSocket connection on a server.
+
+pub use crate::handshake::server::ServerHandshake;
+
+use crate::handshake::{
+ server::{Callback, NoCallback},
+ HandshakeError,
+};
+
+use crate::protocol::{WebSocket, WebSocketConfig};
+
+use std::io::{Read, Write};
+
+/// Accept the given Stream as a WebSocket.
+///
+/// Uses a configuration provided as an argument. Calling it with `None` will use the default one
+/// used by `accept()`.
+///
+/// This function starts a server WebSocket handshake over the given stream.
+/// If you want TLS support, use `native_tls::TlsStream`, `rustls::Stream` or
+/// `openssl::ssl::SslStream` for the stream here. Any `Read + Write` streams are supported,
+/// including those from `Mio` and others.
+pub fn accept_with_config<S: Read + Write>(
+ stream: S,
+ config: Option<WebSocketConfig>,
+) -> Result<WebSocket<S>, HandshakeError<ServerHandshake<S, NoCallback>>> {
+ accept_hdr_with_config(stream, NoCallback, config)
+}
+
+/// Accept the given Stream as a WebSocket.
+///
+/// This function starts a server WebSocket handshake over the given stream.
+/// If you want TLS support, use `native_tls::TlsStream`, `rustls::Stream` or
+/// `openssl::ssl::SslStream` for the stream here. Any `Read + Write` streams are supported,
+/// including those from `Mio` and others.
+pub fn accept<S: Read + Write>(
+ stream: S,
+) -> Result<WebSocket<S>, HandshakeError<ServerHandshake<S, NoCallback>>> {
+ accept_with_config(stream, None)
+}
+
+/// Accept the given Stream as a WebSocket.
+///
+/// Uses a configuration provided as an argument. Calling it with `None` will use the default one
+/// used by `accept_hdr()`.
+///
+/// This function does the same as `accept()` but accepts an extra callback
+/// for header processing. The callback receives headers of the incoming
+/// requests and is able to add extra headers to the reply.
+pub fn accept_hdr_with_config<S: Read + Write, C: Callback>(
+ stream: S,
+ callback: C,
+ config: Option<WebSocketConfig>,
+) -> Result<WebSocket<S>, HandshakeError<ServerHandshake<S, C>>> {
+ ServerHandshake::start(stream, callback, config).handshake()
+}
+
+/// Accept the given Stream as a WebSocket.
+///
+/// This function does the same as `accept()` but accepts an extra callback
+/// for header processing. The callback receives headers of the incoming
+/// requests and is able to add extra headers to the reply.
+pub fn accept_hdr<S: Read + Write, C: Callback>(
+ stream: S,
+ callback: C,
+) -> Result<WebSocket<S>, HandshakeError<ServerHandshake<S, C>>> {
+ accept_hdr_with_config(stream, callback, None)
+}
diff --git a/crates/tungstenite/src/stream.rs b/crates/tungstenite/src/stream.rs
new file mode 100644
index 0000000..4775230
--- /dev/null
+++ b/crates/tungstenite/src/stream.rs
@@ -0,0 +1,145 @@
+//! Convenience wrapper for streams to switch between plain TCP and TLS at runtime.
+//!
+//! There is no dependency on actual TLS implementations. Everything like
+//! `native_tls` or `openssl` will work as long as there is a TLS stream supporting standard
+//! `Read + Write` traits.
+
+#[cfg(feature = "__rustls-tls")]
+use std::ops::Deref;
+use std::{
+ fmt::{self, Debug},
+ io::{Read, Result as IoResult, Write},
+};
+
+use std::net::TcpStream;
+
+#[cfg(feature = "native-tls")]
+use native_tls_crate::TlsStream;
+#[cfg(feature = "__rustls-tls")]
+use rustls::StreamOwned;
+
+/// Stream mode, either plain TCP or TLS.
+#[derive(Clone, Copy, Debug)]
+pub enum Mode {
+ /// Plain mode (`ws://` URL).
+ Plain,
+ /// TLS mode (`wss://` URL).
+ Tls,
+}
+
+/// Trait to switch TCP_NODELAY.
+pub trait NoDelay {
+ /// Set the TCP_NODELAY option to the given value.
+ fn set_nodelay(&mut self, nodelay: bool) -> IoResult<()>;
+}
+
+impl NoDelay for TcpStream {
+ fn set_nodelay(&mut self, nodelay: bool) -> IoResult<()> {
+ TcpStream::set_nodelay(self, nodelay)
+ }
+}
+
+#[cfg(feature = "native-tls")]
+impl<S: Read + Write + NoDelay> NoDelay for TlsStream<S> {
+ fn set_nodelay(&mut self, nodelay: bool) -> IoResult<()> {
+ self.get_mut().set_nodelay(nodelay)
+ }
+}
+
+#[cfg(feature = "__rustls-tls")]
+impl<S, SD, T> NoDelay for StreamOwned<S, T>
+where
+ S: Deref<Target = rustls::ConnectionCommon<SD>>,
+ SD: rustls::SideData,
+ T: Read + Write + NoDelay,
+{
+ fn set_nodelay(&mut self, nodelay: bool) -> IoResult<()> {
+ self.sock.set_nodelay(nodelay)
+ }
+}
+
+/// A stream that might be protected with TLS.
+#[non_exhaustive]
+pub enum MaybeTlsStream<S: Read + Write> {
+ /// Unencrypted socket stream.
+ Plain(S),
+ #[cfg(feature = "native-tls")]
+ /// Encrypted socket stream using `native-tls`.
+ NativeTls(native_tls_crate::TlsStream<S>),
+ #[cfg(feature = "__rustls-tls")]
+ /// Encrypted socket stream using `rustls`.
+ Rustls(rustls::StreamOwned<rustls::ClientConnection, S>),
+}
+
+impl<S: Read + Write + Debug> Debug for MaybeTlsStream<S> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Self::Plain(s) => f.debug_tuple("MaybeTlsStream::Plain").field(s).finish(),
+ #[cfg(feature = "native-tls")]
+ Self::NativeTls(s) => f.debug_tuple("MaybeTlsStream::NativeTls").field(s).finish(),
+ #[cfg(feature = "__rustls-tls")]
+ Self::Rustls(s) => {
+ struct RustlsStreamDebug<'a, S: Read + Write>(
+ &'a rustls::StreamOwned<rustls::ClientConnection, S>,
+ );
+
+ impl<'a, S: Read + Write + Debug> Debug for RustlsStreamDebug<'a, S> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.debug_struct("StreamOwned")
+ .field("conn", &self.0.conn)
+ .field("sock", &self.0.sock)
+ .finish()
+ }
+ }
+
+ f.debug_tuple("MaybeTlsStream::Rustls").field(&RustlsStreamDebug(s)).finish()
+ }
+ }
+ }
+}
+
+impl<S: Read + Write> Read for MaybeTlsStream<S> {
+ fn read(&mut self, buf: &mut [u8]) -> IoResult<usize> {
+ match *self {
+ MaybeTlsStream::Plain(ref mut s) => s.read(buf),
+ #[cfg(feature = "native-tls")]
+ MaybeTlsStream::NativeTls(ref mut s) => s.read(buf),
+ #[cfg(feature = "__rustls-tls")]
+ MaybeTlsStream::Rustls(ref mut s) => s.read(buf),
+ }
+ }
+}
+
+impl<S: Read + Write> Write for MaybeTlsStream<S> {
+ fn write(&mut self, buf: &[u8]) -> IoResult<usize> {
+ match *self {
+ MaybeTlsStream::Plain(ref mut s) => s.write(buf),
+ #[cfg(feature = "native-tls")]
+ MaybeTlsStream::NativeTls(ref mut s) => s.write(buf),
+ #[cfg(feature = "__rustls-tls")]
+ MaybeTlsStream::Rustls(ref mut s) => s.write(buf),
+ }
+ }
+
+ fn flush(&mut self) -> IoResult<()> {
+ match *self {
+ MaybeTlsStream::Plain(ref mut s) => s.flush(),
+ #[cfg(feature = "native-tls")]
+ MaybeTlsStream::NativeTls(ref mut s) => s.flush(),
+ #[cfg(feature = "__rustls-tls")]
+ MaybeTlsStream::Rustls(ref mut s) => s.flush(),
+ }
+ }
+}
+
+impl<S: Read + Write + NoDelay> NoDelay for MaybeTlsStream<S> {
+ fn set_nodelay(&mut self, nodelay: bool) -> IoResult<()> {
+ match *self {
+ MaybeTlsStream::Plain(ref mut s) => s.set_nodelay(nodelay),
+ #[cfg(feature = "native-tls")]
+ MaybeTlsStream::NativeTls(ref mut s) => s.set_nodelay(nodelay),
+ #[cfg(feature = "__rustls-tls")]
+ MaybeTlsStream::Rustls(ref mut s) => s.set_nodelay(nodelay),
+ }
+ }
+}
diff --git a/crates/tungstenite/src/tls.rs b/crates/tungstenite/src/tls.rs
new file mode 100644
index 0000000..836b7ae
--- /dev/null
+++ b/crates/tungstenite/src/tls.rs
@@ -0,0 +1,228 @@
+//! Connection helper.
+use std::io::{Read, Write};
+
+use crate::{
+ client::{client_with_config, uri_mode, IntoClientRequest},
+ error::UrlError,
+ handshake::client::Response,
+ protocol::WebSocketConfig,
+ stream::MaybeTlsStream,
+ ClientHandshake, Error, HandshakeError, Result, WebSocket,
+};
+
+/// A connector that can be used when establishing connections, allowing to control whether
+/// `native-tls` or `rustls` is used to create a TLS connection. Or TLS can be disabled with the
+/// `Plain` variant.
+#[non_exhaustive]
+#[allow(missing_debug_implementations)]
+pub enum Connector {
+ /// Plain (non-TLS) connector.
+ Plain,
+ /// `native-tls` TLS connector.
+ #[cfg(feature = "native-tls")]
+ NativeTls(native_tls_crate::TlsConnector),
+ /// `rustls` TLS connector.
+ #[cfg(feature = "__rustls-tls")]
+ Rustls(std::sync::Arc<rustls::ClientConfig>),
+}
+
+mod encryption {
+ #[cfg(feature = "native-tls")]
+ pub mod native_tls {
+ use native_tls_crate::{HandshakeError as TlsHandshakeError, TlsConnector};
+
+ use std::io::{Read, Write};
+
+ use crate::{
+ error::TlsError,
+ stream::{MaybeTlsStream, Mode},
+ Error, Result,
+ };
+
+ pub fn wrap_stream<S>(
+ socket: S,
+ domain: &str,
+ mode: Mode,
+ tls_connector: Option<TlsConnector>,
+ ) -> Result<MaybeTlsStream<S>>
+ where
+ S: Read + Write,
+ {
+ match mode {
+ Mode::Plain => Ok(MaybeTlsStream::Plain(socket)),
+ Mode::Tls => {
+ let try_connector = tls_connector.map_or_else(TlsConnector::new, Ok);
+ let connector = try_connector.map_err(TlsError::Native)?;
+ let connected = connector.connect(domain, socket);
+ match connected {
+ Err(e) => match e {
+ TlsHandshakeError::Failure(f) => Err(Error::Tls(f.into())),
+ TlsHandshakeError::WouldBlock(_) => {
+ panic!("Bug: TLS handshake not blocked")
+ }
+ },
+ Ok(s) => Ok(MaybeTlsStream::NativeTls(s)),
+ }
+ }
+ }
+ }
+ }
+
+ #[cfg(feature = "__rustls-tls")]
+ pub mod rustls {
+ use rustls::{ClientConfig, ClientConnection, RootCertStore, StreamOwned};
+ use rustls_pki_types::ServerName;
+
+ use std::{
+ convert::TryFrom,
+ io::{Read, Write},
+ sync::Arc,
+ };
+
+ use crate::{
+ error::TlsError,
+ stream::{MaybeTlsStream, Mode},
+ Result,
+ };
+
+ pub fn wrap_stream<S>(
+ socket: S,
+ domain: &str,
+ mode: Mode,
+ tls_connector: Option<Arc<ClientConfig>>,
+ ) -> Result<MaybeTlsStream<S>>
+ where
+ S: Read + Write,
+ {
+ match mode {
+ Mode::Plain => Ok(MaybeTlsStream::Plain(socket)),
+ Mode::Tls => {
+ let config = match tls_connector {
+ Some(config) => config,
+ None => {
+ #[allow(unused_mut)]
+ let mut root_store = RootCertStore::empty();
+
+ #[cfg(feature = "rustls-tls-native-roots")]
+ {
+ let native_certs = rustls_native_certs::load_native_certs()?;
+ let total_number = native_certs.len();
+ let (number_added, number_ignored) =
+ root_store.add_parsable_certificates(native_certs);
+ log::debug!("Added {number_added}/{total_number} native root certificates (ignored {number_ignored})");
+ }
+ #[cfg(feature = "rustls-tls-webpki-roots")]
+ {
+ root_store.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
+ }
+
+ Arc::new(
+ ClientConfig::builder()
+ .with_root_certificates(root_store)
+ .with_no_client_auth(),
+ )
+ }
+ };
+ let domain = ServerName::try_from(domain)
+ .map_err(|_| TlsError::InvalidDnsName)?
+ .to_owned();
+ let client = ClientConnection::new(config, domain).map_err(TlsError::Rustls)?;
+ let stream = StreamOwned::new(client, socket);
+
+ Ok(MaybeTlsStream::Rustls(stream))
+ }
+ }
+ }
+ }
+
+ pub mod plain {
+ use std::io::{Read, Write};
+
+ use crate::{
+ error::UrlError,
+ stream::{MaybeTlsStream, Mode},
+ Error, Result,
+ };
+
+ pub fn wrap_stream<S>(socket: S, mode: Mode) -> Result<MaybeTlsStream<S>>
+ where
+ S: Read + Write,
+ {
+ match mode {
+ Mode::Plain => Ok(MaybeTlsStream::Plain(socket)),
+ Mode::Tls => Err(Error::Url(UrlError::TlsFeatureNotEnabled)),
+ }
+ }
+ }
+}
+
+type TlsHandshakeError<S> = HandshakeError<ClientHandshake<MaybeTlsStream<S>>>;
+
+/// Creates a WebSocket handshake from a request and a stream,
+/// upgrading the stream to TLS if required.
+pub fn client_tls<R, S>(
+ request: R,
+ stream: S,
+) -> Result<(WebSocket<MaybeTlsStream<S>>, Response), TlsHandshakeError<S>>
+where
+ R: IntoClientRequest,
+ S: Read + Write,
+{
+ client_tls_with_config(request, stream, None, None)
+}
+
+/// The same as [`client_tls()`] but one can specify a websocket configuration,
+/// and an optional connector. If no connector is specified, a default one will
+/// be created.
+///
+/// Please refer to [`client_tls()`] for more details.
+pub fn client_tls_with_config<R, S>(
+ request: R,
+ stream: S,
+ config: Option<WebSocketConfig>,
+ connector: Option<Connector>,
+) -> Result<(WebSocket<MaybeTlsStream<S>>, Response), TlsHandshakeError<S>>
+where
+ R: IntoClientRequest,
+ S: Read + Write,
+{
+ let request = request.into_client_request()?;
+
+ #[cfg(any(feature = "native-tls", feature = "__rustls-tls"))]
+ let domain = match request.uri().host() {
+ Some(d) => Ok(d.to_string()),
+ None => Err(Error::Url(UrlError::NoHostName)),
+ }?;
+
+ let mode = uri_mode(request.uri())?;
+
+ let stream = match connector {
+ Some(conn) => match conn {
+ #[cfg(feature = "native-tls")]
+ Connector::NativeTls(conn) => {
+ self::encryption::native_tls::wrap_stream(stream, &domain, mode, Some(conn))
+ }
+ #[cfg(feature = "__rustls-tls")]
+ Connector::Rustls(conn) => {
+ self::encryption::rustls::wrap_stream(stream, &domain, mode, Some(conn))
+ }
+ Connector::Plain => self::encryption::plain::wrap_stream(stream, mode),
+ },
+ None => {
+ #[cfg(feature = "native-tls")]
+ {
+ self::encryption::native_tls::wrap_stream(stream, &domain, mode, None)
+ }
+ #[cfg(all(feature = "__rustls-tls", not(feature = "native-tls")))]
+ {
+ self::encryption::rustls::wrap_stream(stream, &domain, mode, None)
+ }
+ #[cfg(not(any(feature = "native-tls", feature = "__rustls-tls")))]
+ {
+ self::encryption::plain::wrap_stream(stream, mode)
+ }
+ }
+ }?;
+
+ client_with_config(request, stream, config)
+}
diff --git a/crates/tungstenite/src/util.rs b/crates/tungstenite/src/util.rs
new file mode 100644
index 0000000..f40ca43
--- /dev/null
+++ b/crates/tungstenite/src/util.rs
@@ -0,0 +1,58 @@
+//! Helper traits to ease non-blocking handling.
+
+use std::{
+ io::{Error as IoError, ErrorKind as IoErrorKind},
+ result::Result as StdResult,
+};
+
+use crate::error::Error;
+
+/// Non-blocking IO handling.
+pub trait NonBlockingError: Sized {
+ /// Convert WouldBlock to None and don't touch other errors.
+ fn into_non_blocking(self) -> Option<Self>;
+}
+
+impl NonBlockingError for IoError {
+ fn into_non_blocking(self) -> Option<Self> {
+ match self.kind() {
+ IoErrorKind::WouldBlock => None,
+ _ => Some(self),
+ }
+ }
+}
+
+impl NonBlockingError for Error {
+ fn into_non_blocking(self) -> Option<Self> {
+ match self {
+ Error::Io(e) => e.into_non_blocking().map(|e| e.into()),
+ x => Some(x),
+ }
+ }
+}
+
+/// Non-blocking IO wrapper.
+///
+/// This trait is implemented for `Result<T, E: NonBlockingError>`.
+pub trait NonBlockingResult {
+ /// Type of the converted result: `Result<Option<T>, E>`
+ type Result;
+ /// Perform the non-block conversion.
+ fn no_block(self) -> Self::Result;
+}
+
+impl<T, E> NonBlockingResult for StdResult<T, E>
+where
+ E: NonBlockingError,
+{
+ type Result = StdResult<Option<T>, E>;
+ fn no_block(self) -> Self::Result {
+ match self {
+ Ok(x) => Ok(Some(x)),
+ Err(e) => match e.into_non_blocking() {
+ Some(e) => Err(e),
+ None => Ok(None),
+ },
+ }
+ }
+}
diff --git a/crates/twox-hash/.cargo-checksum.json b/crates/twox-hash/.cargo-checksum.json
new file mode 100644
index 0000000..01b9de5
--- /dev/null
+++ b/crates/twox-hash/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.lock":"cd118ec94064fb986c7addc898d735a438c7b0f59971b4c15e1a5b4405e33824","Cargo.toml":"997419a42f25493d35917bb952faa883a7dbfe449b8351b7055181f4bc827dc9","LICENSE.txt":"f59bcb1c02654665f78a5f290bae76b6358137675f6459f51e6d474a4623d8ea","README.md":"e5b5bf9df5791c8d595384ce6c783e3b7de7a1ae0d486edaf086e33742f9edee","src/bin/hash_file.rs":"dd56cf4a061b399adf39ad65a32f3b9c66806bc69d70c7f8cf30df41f487af62","src/digest_0_10_support.rs":"d375a17242abd244ffb258c61e8b460942d8404c38e20c2a9899f89291f5ec42","src/digest_0_9_support.rs":"d64d83b8ff47ffb2f6cfd4b6a9a8b8119a04825cfe04bfad67b6d6b65f3b7cc8","src/digest_support.rs":"4cca163c09c7148ef8a15012a692effe0b612e0046317a902e074cbd1973f54c","src/lib.rs":"8a5e584e184cd9a7b7fb4ac0670ffa61965e030d0d75b42d0b04802f7db39b94","src/sixty_four.rs":"06fe2c1057f37981434072209be60b6e13a987b2931bb57d1ad4cebf32e5a23d","src/std_support.rs":"dadfcdd38b51d4c06010336230d561d0b5ade9724b212afe705d2672f467a816","src/thirty_two.rs":"9793615c3b9ef9364b5017a13e6b2a7bb43a66754c3d3225301d65c6de1173e6","src/xxh3.rs":"1c1489aab48f78ccca0330f11e76d14c703a06910d2482c6d93ce88ac6541686"},"package":"97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675"}
\ No newline at end of file
diff --git a/crates/twox-hash/Android.bp b/crates/twox-hash/Android.bp
new file mode 100644
index 0000000..1953b81
--- /dev/null
+++ b/crates/twox-hash/Android.bp
@@ -0,0 +1,66 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_twox-hash_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_twox-hash_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libtwox_hash",
+ host_supported: true,
+ crate_name: "twox_hash",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.6.3",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "default",
+ "rand",
+ "std",
+ ],
+ rustlibs: [
+ "libcfg_if",
+ "librand",
+ "libstatic_assertions",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "twox-hash_test_src_lib",
+ host_supported: true,
+ crate_name: "twox_hash",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.6.3",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "rand",
+ "std",
+ ],
+ rustlibs: [
+ "libcfg_if",
+ "librand",
+ "libserde_json",
+ "libstatic_assertions",
+ ],
+}
diff --git a/crates/twox-hash/Cargo.lock b/crates/twox-hash/Cargo.lock
new file mode 100644
index 0000000..e6070db
--- /dev/null
+++ b/crates/twox-hash/Cargo.lock
@@ -0,0 +1,234 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "crypto-common"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "57952ca27b5e3606ff4dd79b0020231aaf9d6aa76dc05fd30137538c50bd3ce8"
+dependencies = [
+ "generic-array 0.14.5",
+ "typenum",
+]
+
+[[package]]
+name = "digest"
+version = "0.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f3d0c8c8752312f9713efd397ff63acb9f85585afbf179282e720e7704954dd5"
+dependencies = [
+ "generic-array 0.12.4",
+]
+
+[[package]]
+name = "digest"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d3dd60d1080a57a05ab032377049e0591415d2b31afd7028356dbf3cc6dcb066"
+dependencies = [
+ "generic-array 0.14.5",
+]
+
+[[package]]
+name = "digest"
+version = "0.10.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2fb860ca6fafa5552fb6d0e816a69c8e49f0908bf524e30a90d97c85892d506"
+dependencies = [
+ "crypto-common",
+]
+
+[[package]]
+name = "generic-array"
+version = "0.12.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ffdf9f34f1447443d37393cc6c2b8313aebddcd96906caf34e54c68d8e57d7bd"
+dependencies = [
+ "typenum",
+]
+
+[[package]]
+name = "generic-array"
+version = "0.14.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fd48d33ec7f05fbfa152300fdad764757cbded343c1aa1cff2fbaf4134851803"
+dependencies = [
+ "typenum",
+ "version_check",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9be70c98951c83b8d2f8f60d7065fa6d5146873094452a1008da8c2f1e4205ad"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1aab8fc367588b89dcee83ab0fd66b72b50b72fa1904d7095045ace2b0c81c35"
+
+[[package]]
+name = "libc"
+version = "0.2.125"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5916d2ae698f6de9bfb891ad7a8d65c09d232dc58cc4ac433c7da3b2fd84bc2b"
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eb9f9e6e233e5c4a35559a617bf40a4ec447db2e84c20b55a6f83167b7e57872"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.37"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec757218438d5fda206afc041538b2f6d889286160d649a86a24d37e1235afd1"
+dependencies = [
+ "unicode-xid",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a1feb54ed693b93a84e14094943b84b7c4eae204c512b7ccb95ab0c66d278ad1"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d34f1408f55294453790c48b2f1ebbb1c5b4b7563eb1f418bcfcfdbb06ebb4e7"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "ryu"
+version = "1.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "73b4b750c782965c211b42f022f59af1fbceabdd026623714f104152f1ec149f"
+
+[[package]]
+name = "serde"
+version = "1.0.137"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61ea8d54c77f8315140a05f4c7237403bf38b72704d031543aa1d16abbf517d1"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.137"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1f26faba0c3959972377d3b2d306ee9f71faee9714294e41bb777f83f88578be"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.81"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b7ce2b32a1aed03c558dc61a5cd328f15aff2dbc17daad8fb8af04d2100e15c"
+dependencies = [
+ "itoa",
+ "ryu",
+ "serde",
+]
+
+[[package]]
+name = "static_assertions"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f"
+
+[[package]]
+name = "syn"
+version = "1.0.92"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ff7c592601f11445996a06f8ad0c27f094a58857c2f89e97974ab9235b92c52"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-xid",
+]
+
+[[package]]
+name = "twox-hash"
+version = "1.6.3"
+dependencies = [
+ "cfg-if",
+ "digest 0.10.3",
+ "digest 0.8.1",
+ "digest 0.9.0",
+ "rand",
+ "serde",
+ "serde_json",
+ "static_assertions",
+]
+
+[[package]]
+name = "typenum"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dcf81ac59edc17cc8697ff311e8f5ef2d99fcbd9817b34cec66f90b6c3dfd987"
+
+[[package]]
+name = "unicode-xid"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "957e51f3646910546462e67d5f7599b9e4fb8acdd304b087a6494730f9eebf04"
+
+[[package]]
+name = "version_check"
+version = "0.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
+
+[[package]]
+name = "wasi"
+version = "0.10.2+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fd6fbd9a79829dd1ad0cc20627bf1ed606756a7f77edff7b66b7064f9cb327c6"
diff --git a/crates/twox-hash/Cargo.toml b/crates/twox-hash/Cargo.toml
new file mode 100644
index 0000000..16aa1f4
--- /dev/null
+++ b/crates/twox-hash/Cargo.toml
@@ -0,0 +1,71 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "twox-hash"
+version = "1.6.3"
+authors = ["Jake Goulding <[email protected]>"]
+description = "A Rust implementation of the XXHash and XXH3 algorithms"
+documentation = "https://docs.rs/twox-hash/"
+readme = "README.md"
+keywords = [
+ "hash",
+ "hasher",
+ "xxhash",
+ "xxh3",
+]
+categories = ["algorithms"]
+license = "MIT"
+repository = "https://github.com/shepmaster/twox-hash"
+
+[dependencies.cfg-if]
+version = ">= 0.1, < 2"
+default-features = false
+
+[dependencies.digest]
+version = "0.8"
+optional = true
+default-features = false
+package = "digest"
+
+[dependencies.digest_0_10]
+version = "0.10"
+optional = true
+default-features = false
+package = "digest"
+
+[dependencies.digest_0_9]
+version = "0.9"
+optional = true
+default-features = false
+package = "digest"
+
+[dependencies.rand]
+version = ">= 0.3.10, < 0.9"
+optional = true
+
+[dependencies.serde]
+version = "1.0"
+features = ["derive"]
+optional = true
+
+[dependencies.static_assertions]
+version = "1.0"
+default-features = false
+
+[dev-dependencies.serde_json]
+version = "1.0"
+
+[features]
+default = ["std"]
+serialize = ["serde"]
+std = ["rand"]
diff --git a/crates/twox-hash/LICENSE b/crates/twox-hash/LICENSE
new file mode 120000
index 0000000..85de3d4
--- /dev/null
+++ b/crates/twox-hash/LICENSE
@@ -0,0 +1 @@
+LICENSE.txt
\ No newline at end of file
diff --git a/crates/twox-hash/LICENSE.txt b/crates/twox-hash/LICENSE.txt
new file mode 100644
index 0000000..a004360
--- /dev/null
+++ b/crates/twox-hash/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jake Goulding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/crates/twox-hash/METADATA b/crates/twox-hash/METADATA
new file mode 100644
index 0000000..7abeec4
--- /dev/null
+++ b/crates/twox-hash/METADATA
@@ -0,0 +1,19 @@
+name: "twox-hash"
+description: "A Rust implementation of the XXHash and XXH3 algorithms"
+third_party {
+ identifier {
+ type: "crates.io"
+ value: "https://crates.io/crates/twox-hash"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/twox-hash/twox-hash-1.6.3.crate"
+ }
+ version: "1.6.3"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 1
+ day: 17
+ }
+}
diff --git a/crates/twox-hash/MODULE_LICENSE_MIT b/crates/twox-hash/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/twox-hash/MODULE_LICENSE_MIT
diff --git a/crates/twox-hash/README.md b/crates/twox-hash/README.md
new file mode 100644
index 0000000..d8656f3
--- /dev/null
+++ b/crates/twox-hash/README.md
@@ -0,0 +1,102 @@
+# TwoX-Hash
+
+A Rust implementation of the [XXHash] algorithm.
+
+[](https://travis-ci.org/shepmaster/twox-hash) [](https://crates.io/crates/twox-hash)
+
+[Documentation](https://docs.rs/twox-hash/)
+
+[XXHash]: https://github.com/Cyan4973/xxHash
+
+## Examples
+
+### With a fixed seed
+
+```rust
+use std::hash::BuildHasherDefault;
+use std::collections::HashMap;
+use twox_hash::XxHash64;
+
+let mut hash: HashMap<_, _, BuildHasherDefault<XxHash64>> = Default::default();
+hash.insert(42, "the answer");
+assert_eq!(hash.get(&42), Some(&"the answer"));
+```
+
+### With a random seed
+
+```rust
+use std::collections::HashMap;
+use twox_hash::RandomXxHashBuilder64;
+
+let mut hash: HashMap<_, _, RandomXxHashBuilder64> = Default::default();
+hash.insert(42, "the answer");
+assert_eq!(hash.get(&42), Some(&"the answer"));
+```
+
+## Benchmarks
+
+### 64-bit
+
+| Bytes | SipHasher (MB/s) | XXHash (MB/s) | Ratio |
+|---------|------------------|---------------|-------|
+| 1 | 52 | 38 | 73% |
+| 4 | 210 | 148 | 70% |
+| 16 | 615 | 615 | 100% |
+| 32 | 914 | 1391 | 152% |
+| 128 | 1347 | 3657 | 271% |
+| 256 | 1414 | 5019 | 355% |
+| 512 | 1546 | 6168 | 399% |
+| 1024 | 1565 | 6206 | 397% |
+| 1048576 | 1592 | 7564 | 475% |
+
+| Bytes | [FnvHasher][fnv] (MB/s) | XXHash (MB/s) | Ratio |
+|---------|-------------------------|---------------|-------|
+| 1 | 1000 | 38 | 4% |
+| 4 | 800 | 148 | 19% |
+| 16 | 761 | 615 | 81% |
+| 32 | 761 | 1391 | 183% |
+| 128 | 727 | 3657 | 503% |
+| 256 | 759 | 5019 | 661% |
+| 512 | 745 | 6168 | 828% |
+| 1024 | 741 | 6206 | 838% |
+| 1048576 | 745 | 7564 | 1015% |
+
+### 32-bit
+
+| Bytes | SipHasher (MB/s) | XXHash32 (MB/s) | Ratio |
+|---------|------------------|-----------------|-------|
+| 1 | 52 | 55 | 106% |
+| 4 | 210 | 210 | 100% |
+| 16 | 615 | 1230 | 200% |
+| 32 | 914 | 1882 | 206% |
+| 128 | 1347 | 3282 | 244% |
+| 256 | 1414 | 3459 | 245% |
+| 512 | 1546 | 3792 | 245% |
+| 1024 | 1565 | 3938 | 252% |
+| 1048576 | 1592 | 4127 | 259% |
+
+| Bytes | [FnvHasher][fnv] (MB/s) | XXHash32 (MB/s) | Ratio |
+|---------|-------------------------|-----------------|-------|
+| 1 | 1000 | 55 | 6% |
+| 4 | 800 | 210 | 26% |
+| 16 | 761 | 1230 | 162% |
+| 32 | 761 | 1882 | 247% |
+| 128 | 727 | 3282 | 451% |
+| 256 | 759 | 3459 | 456% |
+| 512 | 745 | 3792 | 509% |
+| 1024 | 741 | 3938 | 531% |
+| 1048576 | 745 | 4127 | 554% |
+
+
+[fnv]: https://github.com/servo/rust-fnv
+
+## Contributing
+
+1. Fork it ( https://github.com/shepmaster/twox-hash/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add a failing test.
+4. Add code to pass the test.
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Ensure tests pass.
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request
diff --git a/crates/twox-hash/cargo_embargo.json b/crates/twox-hash/cargo_embargo.json
new file mode 100644
index 0000000..abeede5
--- /dev/null
+++ b/crates/twox-hash/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "tests": true,
+ "module_blocklist": ["hash_file"]
+}
diff --git a/crates/twox-hash/src/bin/hash_file.rs b/crates/twox-hash/src/bin/hash_file.rs
new file mode 100644
index 0000000..509b48d
--- /dev/null
+++ b/crates/twox-hash/src/bin/hash_file.rs
@@ -0,0 +1,28 @@
+use std::env;
+use std::fs::File;
+use std::hash::Hasher;
+use std::io::{BufRead, BufReader};
+use twox_hash::XxHash64;
+
+fn main() {
+ for arg in env::args().skip(1) {
+ let f = File::open(&arg).unwrap();
+ let mut f = BufReader::new(f);
+
+ let mut hasher = XxHash64::with_seed(0);
+
+ loop {
+ let consumed = {
+ let bytes = f.fill_buf().unwrap();
+ if bytes.is_empty() {
+ break;
+ }
+ hasher.write(bytes);
+ bytes.len()
+ };
+ f.consume(consumed);
+ }
+
+ println!("{:16x} {}", hasher.finish(), arg);
+ }
+}
diff --git a/crates/twox-hash/src/digest_0_10_support.rs b/crates/twox-hash/src/digest_0_10_support.rs
new file mode 100644
index 0000000..935c096
--- /dev/null
+++ b/crates/twox-hash/src/digest_0_10_support.rs
@@ -0,0 +1,92 @@
+use core::hash::Hasher;
+
+use digest_0_10::{
+ generic_array::typenum::consts::{U16, U4, U8},
+ FixedOutput, HashMarker, Output, OutputSizeUser, Update,
+};
+
+use crate::{xxh3, XxHash32, XxHash64};
+
+// ----------
+
+impl Update for XxHash32 {
+ fn update(&mut self, data: &[u8]) {
+ self.write(data);
+ }
+}
+
+impl OutputSizeUser for XxHash32 {
+ type OutputSize = U4;
+}
+
+impl FixedOutput for XxHash32 {
+ fn finalize_into(self, out: &mut Output<Self>) {
+ let tmp: &mut [u8; 4] = out.as_mut();
+ *tmp = self.finish().to_be_bytes();
+ }
+}
+
+impl HashMarker for XxHash32 {}
+
+// ----------
+
+impl Update for XxHash64 {
+ fn update(&mut self, data: &[u8]) {
+ self.write(data);
+ }
+}
+
+impl OutputSizeUser for XxHash64 {
+ type OutputSize = U8;
+}
+
+impl FixedOutput for XxHash64 {
+ fn finalize_into(self, out: &mut Output<Self>) {
+ let tmp: &mut [u8; 8] = out.as_mut();
+ *tmp = self.finish().to_be_bytes();
+ }
+}
+
+impl HashMarker for XxHash64 {}
+
+// ----------
+
+impl Update for xxh3::Hash64 {
+ fn update(&mut self, data: &[u8]) {
+ self.write(data);
+ }
+}
+
+impl OutputSizeUser for xxh3::Hash64 {
+ type OutputSize = U8;
+}
+
+impl FixedOutput for xxh3::Hash64 {
+ fn finalize_into(self, out: &mut Output<Self>) {
+ let tmp: &mut [u8; 8] = out.as_mut();
+ *tmp = self.finish().to_be_bytes();
+ }
+}
+
+impl HashMarker for xxh3::Hash64 {}
+
+// ----------
+
+impl Update for xxh3::Hash128 {
+ fn update(&mut self, data: &[u8]) {
+ self.write(data);
+ }
+}
+
+impl OutputSizeUser for xxh3::Hash128 {
+ type OutputSize = U16;
+}
+
+impl FixedOutput for xxh3::Hash128 {
+ fn finalize_into(self, out: &mut Output<Self>) {
+ let tmp: &mut [u8; 16] = out.as_mut();
+ *tmp = xxh3::HasherExt::finish_ext(&self).to_be_bytes();
+ }
+}
+
+impl HashMarker for xxh3::Hash128 {}
diff --git a/crates/twox-hash/src/digest_0_9_support.rs b/crates/twox-hash/src/digest_0_9_support.rs
new file mode 100644
index 0000000..67788cd
--- /dev/null
+++ b/crates/twox-hash/src/digest_0_9_support.rs
@@ -0,0 +1,179 @@
+use core::hash::Hasher;
+
+use digest_0_9::{
+ generic_array::{
+ typenum::consts::{U16, U4, U8},
+ GenericArray,
+ },
+ Digest,
+};
+
+use crate::{xxh3, XxHash32, XxHash64};
+
+impl Digest for XxHash32 {
+ type OutputSize = U4;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn update(&mut self, data: impl AsRef<[u8]>) {
+ self.write(data.as_ref());
+ }
+
+ fn chain(mut self, data: impl AsRef<[u8]>) -> Self
+ where
+ Self: Sized,
+ {
+ self.update(data);
+ self
+ }
+
+ fn finalize(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn finalize_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.finalize();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 4
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).finalize()
+ }
+}
+
+impl Digest for XxHash64 {
+ type OutputSize = U8;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn update(&mut self, data: impl AsRef<[u8]>) {
+ self.write(data.as_ref());
+ }
+
+ fn chain(mut self, data: impl AsRef<[u8]>) -> Self
+ where
+ Self: Sized,
+ {
+ self.update(data);
+ self
+ }
+
+ fn finalize(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn finalize_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.finalize();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).finalize()
+ }
+}
+
+impl Digest for xxh3::Hash64 {
+ type OutputSize = U8;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn update(&mut self, data: impl AsRef<[u8]>) {
+ self.write(data.as_ref());
+ }
+
+ fn chain(mut self, data: impl AsRef<[u8]>) -> Self
+ where
+ Self: Sized,
+ {
+ self.update(data);
+ self
+ }
+
+ fn finalize(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn finalize_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.clone().finalize();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).finalize()
+ }
+}
+
+impl Digest for xxh3::Hash128 {
+ type OutputSize = U16;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn update(&mut self, data: impl AsRef<[u8]>) {
+ self.write(data.as_ref());
+ }
+
+ fn chain(mut self, data: impl AsRef<[u8]>) -> Self
+ where
+ Self: Sized,
+ {
+ self.update(data);
+ self
+ }
+
+ fn finalize(self) -> GenericArray<u8, Self::OutputSize> {
+ xxh3::HasherExt::finish_ext(&self).to_be_bytes().into()
+ }
+
+ fn finalize_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.clone().finalize();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).finalize()
+ }
+}
diff --git a/crates/twox-hash/src/digest_support.rs b/crates/twox-hash/src/digest_support.rs
new file mode 100644
index 0000000..7b00b9d
--- /dev/null
+++ b/crates/twox-hash/src/digest_support.rs
@@ -0,0 +1,179 @@
+use core::hash::Hasher;
+
+use digest::{
+ generic_array::{
+ typenum::consts::{U16, U4, U8},
+ GenericArray,
+ },
+ Digest,
+};
+
+use crate::{xxh3, XxHash32, XxHash64};
+
+impl Digest for XxHash32 {
+ type OutputSize = U4;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn input<B: AsRef<[u8]>>(&mut self, data: B) {
+ self.write(data.as_ref());
+ }
+
+ fn chain<B: AsRef<[u8]>>(mut self, data: B) -> Self
+ where
+ Self: Sized,
+ {
+ self.input(data);
+ self
+ }
+
+ fn result(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn result_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.result();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 4
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).result()
+ }
+}
+
+impl Digest for XxHash64 {
+ type OutputSize = U8;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn input<B: AsRef<[u8]>>(&mut self, data: B) {
+ self.write(data.as_ref());
+ }
+
+ fn chain<B: AsRef<[u8]>>(mut self, data: B) -> Self
+ where
+ Self: Sized,
+ {
+ self.input(data);
+ self
+ }
+
+ fn result(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn result_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.result();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).result()
+ }
+}
+
+impl Digest for xxh3::Hash64 {
+ type OutputSize = U8;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn input<B: AsRef<[u8]>>(&mut self, data: B) {
+ self.write(data.as_ref());
+ }
+
+ fn chain<B: AsRef<[u8]>>(mut self, data: B) -> Self
+ where
+ Self: Sized,
+ {
+ self.input(data);
+ self
+ }
+
+ fn result(self) -> GenericArray<u8, Self::OutputSize> {
+ self.finish().to_be_bytes().into()
+ }
+
+ fn result_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.clone().result();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).result()
+ }
+}
+
+impl Digest for xxh3::Hash128 {
+ type OutputSize = U16;
+
+ fn new() -> Self {
+ Self::default()
+ }
+
+ fn input<B: AsRef<[u8]>>(&mut self, data: B) {
+ self.write(data.as_ref());
+ }
+
+ fn chain<B: AsRef<[u8]>>(mut self, data: B) -> Self
+ where
+ Self: Sized,
+ {
+ self.input(data);
+ self
+ }
+
+ fn result(self) -> GenericArray<u8, Self::OutputSize> {
+ xxh3::HasherExt::finish_ext(&self).to_be_bytes().into()
+ }
+
+ fn result_reset(&mut self) -> GenericArray<u8, Self::OutputSize> {
+ let result = self.clone().result();
+ self.reset();
+ result
+ }
+
+ fn reset(&mut self) {
+ *self = Self::default();
+ }
+
+ fn output_size() -> usize {
+ 8
+ }
+
+ fn digest(data: &[u8]) -> GenericArray<u8, Self::OutputSize> {
+ Self::new().chain(data).result()
+ }
+}
diff --git a/crates/twox-hash/src/lib.rs b/crates/twox-hash/src/lib.rs
new file mode 100644
index 0000000..414dc8d
--- /dev/null
+++ b/crates/twox-hash/src/lib.rs
@@ -0,0 +1,121 @@
+//! A Rust implementation of the [XXHash] algorithm.
+//!
+//! [XXHash]: https://github.com/Cyan4973/xxHash
+//!
+//! ### With a fixed seed
+//!
+//! ```rust
+//! use std::hash::BuildHasherDefault;
+//! use std::collections::HashMap;
+//! use twox_hash::XxHash64;
+//!
+//! let mut hash: HashMap<_, _, BuildHasherDefault<XxHash64>> = Default::default();
+//! hash.insert(42, "the answer");
+//! assert_eq!(hash.get(&42), Some(&"the answer"));
+//! ```
+//!
+//! ### With a random seed
+//!
+//! ```rust
+//! use std::collections::HashMap;
+//! use twox_hash::RandomXxHashBuilder64;
+//!
+//! let mut hash: HashMap<_, _, RandomXxHashBuilder64> = Default::default();
+//! hash.insert(42, "the answer");
+//! assert_eq!(hash.get(&42), Some(&"the answer"));
+//! ```
+
+#![no_std]
+
+extern crate alloc;
+
+#[cfg(test)]
+extern crate std;
+
+use core::{marker::PhantomData, mem};
+
+mod sixty_four;
+mod thirty_two;
+pub mod xxh3;
+
+#[cfg(feature = "std")]
+mod std_support;
+#[cfg(feature = "std")]
+pub use std_support::sixty_four::RandomXxHashBuilder64;
+#[cfg(feature = "std")]
+pub use std_support::thirty_two::RandomXxHashBuilder32;
+#[cfg(feature = "std")]
+pub use std_support::xxh3::{
+ RandomHashBuilder128 as RandomXxh3HashBuilder128,
+ RandomHashBuilder64 as RandomXxh3HashBuilder64,
+};
+
+#[cfg(feature = "digest")]
+mod digest_support;
+
+#[cfg(feature = "digest_0_9")]
+mod digest_0_9_support;
+
+#[cfg(feature = "digest_0_10")]
+mod digest_0_10_support;
+
+pub use crate::sixty_four::XxHash64;
+pub use crate::thirty_two::XxHash32;
+pub use crate::xxh3::{Hash128 as Xxh3Hash128, Hash64 as Xxh3Hash64};
+
+/// A backwards compatibility type alias. Consider directly using
+/// `XxHash64` instead.
+pub type XxHash = XxHash64;
+
+#[cfg(feature = "std")]
+/// A backwards compatibility type alias. Consider directly using
+/// `RandomXxHashBuilder64` instead.
+pub type RandomXxHashBuilder = RandomXxHashBuilder64;
+
+/// An unaligned buffer with iteration support for `UnalignedItem`.
+struct UnalignedBuffer<'a, T> {
+ buf: &'a [u8],
+ phantom: PhantomData<T>,
+}
+
+/// Types implementing this trait must be transmutable from a `*const
+/// u8` to `*const Self` at any possible alignment.
+///
+/// The intent is to use this with only primitive integer types (and
+/// tightly-packed arrays of those integers).
+#[allow(clippy::missing_safety_doc)]
+unsafe trait UnalignedItem {}
+
+unsafe impl UnalignedItem for [u64; 4] {}
+unsafe impl UnalignedItem for [u32; 4] {}
+unsafe impl UnalignedItem for u64 {}
+unsafe impl UnalignedItem for u32 {}
+
+impl<'a, T: UnalignedItem> UnalignedBuffer<'a, T> {
+ #[inline]
+ fn new(buf: &'a [u8]) -> Self {
+ Self {
+ buf,
+ phantom: PhantomData,
+ }
+ }
+
+ #[inline]
+ fn remaining(&self) -> &[u8] {
+ self.buf
+ }
+}
+
+impl<'a, T: UnalignedItem> Iterator for UnalignedBuffer<'a, T> {
+ type Item = T;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ let size = mem::size_of::<T>();
+ self.buf.get(size..).map(|remaining| {
+ // `self.buf` has at least `size` bytes that can be read as `T`.
+ let result = unsafe { (self.buf.as_ptr() as *const T).read_unaligned() };
+ self.buf = remaining;
+ result
+ })
+ }
+}
diff --git a/crates/twox-hash/src/sixty_four.rs b/crates/twox-hash/src/sixty_four.rs
new file mode 100644
index 0000000..c151586
--- /dev/null
+++ b/crates/twox-hash/src/sixty_four.rs
@@ -0,0 +1,413 @@
+use crate::UnalignedBuffer;
+use core::{cmp, hash::Hasher};
+
+#[cfg(feature = "serialize")]
+use serde::{Deserialize, Serialize};
+
+const CHUNK_SIZE: usize = 32;
+
+pub const PRIME_1: u64 = 11_400_714_785_074_694_791;
+pub const PRIME_2: u64 = 14_029_467_366_897_019_727;
+pub const PRIME_3: u64 = 1_609_587_929_392_839_161;
+pub const PRIME_4: u64 = 9_650_029_242_287_828_579;
+pub const PRIME_5: u64 = 2_870_177_450_012_600_261;
+
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Copy, Clone, PartialEq)]
+struct XxCore {
+ v1: u64,
+ v2: u64,
+ v3: u64,
+ v4: u64,
+}
+
+/// Calculates the 64-bit hash.
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Debug, Copy, Clone, PartialEq)]
+pub struct XxHash64 {
+ total_len: u64,
+ seed: u64,
+ core: XxCore,
+ #[cfg_attr(feature = "serialize", serde(flatten))]
+ buffer: Buffer,
+}
+
+impl XxCore {
+ fn with_seed(seed: u64) -> XxCore {
+ XxCore {
+ v1: seed.wrapping_add(PRIME_1).wrapping_add(PRIME_2),
+ v2: seed.wrapping_add(PRIME_2),
+ v3: seed,
+ v4: seed.wrapping_sub(PRIME_1),
+ }
+ }
+
+ #[inline(always)]
+ fn ingest_chunks<I>(&mut self, values: I)
+ where
+ I: IntoIterator<Item = [u64; 4]>,
+ {
+ #[inline(always)]
+ fn ingest_one_number(mut current_value: u64, mut value: u64) -> u64 {
+ value = value.wrapping_mul(PRIME_2);
+ current_value = current_value.wrapping_add(value);
+ current_value = current_value.rotate_left(31);
+ current_value.wrapping_mul(PRIME_1)
+ }
+
+ // By drawing these out, we can avoid going back and forth to
+ // memory. It only really helps for large files, when we need
+ // to iterate multiple times here.
+
+ let mut v1 = self.v1;
+ let mut v2 = self.v2;
+ let mut v3 = self.v3;
+ let mut v4 = self.v4;
+
+ for [n1, n2, n3, n4] in values {
+ v1 = ingest_one_number(v1, n1.to_le());
+ v2 = ingest_one_number(v2, n2.to_le());
+ v3 = ingest_one_number(v3, n3.to_le());
+ v4 = ingest_one_number(v4, n4.to_le());
+ }
+
+ self.v1 = v1;
+ self.v2 = v2;
+ self.v3 = v3;
+ self.v4 = v4;
+ }
+
+ #[inline(always)]
+ fn finish(&self) -> u64 {
+ // The original code pulls out local vars for v[1234]
+ // here. Performance tests did not show that to be effective
+ // here, presumably because this method is not called in a
+ // tight loop.
+
+ #[allow(unknown_lints, clippy::needless_late_init)] // keeping things parallel
+ let mut hash;
+
+ hash = self.v1.rotate_left(1);
+ hash = hash.wrapping_add(self.v2.rotate_left(7));
+ hash = hash.wrapping_add(self.v3.rotate_left(12));
+ hash = hash.wrapping_add(self.v4.rotate_left(18));
+
+ #[inline(always)]
+ fn mix_one(mut hash: u64, mut value: u64) -> u64 {
+ value = value.wrapping_mul(PRIME_2);
+ value = value.rotate_left(31);
+ value = value.wrapping_mul(PRIME_1);
+ hash ^= value;
+ hash = hash.wrapping_mul(PRIME_1);
+ hash.wrapping_add(PRIME_4)
+ }
+
+ hash = mix_one(hash, self.v1);
+ hash = mix_one(hash, self.v2);
+ hash = mix_one(hash, self.v3);
+ hash = mix_one(hash, self.v4);
+
+ hash
+ }
+}
+
+impl core::fmt::Debug for XxCore {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
+ write!(
+ f,
+ "XxCore {{ {:016x} {:016x} {:016x} {:016x} }}",
+ self.v1, self.v2, self.v3, self.v4
+ )
+ }
+}
+
+#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[derive(Debug, Copy, Clone, Default, PartialEq)]
+#[repr(align(8))]
+#[cfg_attr(feature = "serialize", serde(transparent))]
+struct AlignToU64<T>(T);
+
+#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[derive(Debug, Copy, Clone, Default, PartialEq)]
+struct Buffer {
+ #[cfg_attr(feature = "serialize", serde(rename = "buffer"))]
+ data: AlignToU64<[u8; CHUNK_SIZE]>,
+ #[cfg_attr(feature = "serialize", serde(rename = "buffer_usage"))]
+ len: usize,
+}
+
+impl Buffer {
+ fn data(&self) -> &[u8] {
+ &self.data.0[..self.len]
+ }
+
+ /// Consumes as much of the parameter as it can, returning the unused part.
+ fn consume<'a>(&mut self, data: &'a [u8]) -> &'a [u8] {
+ let to_use = cmp::min(self.available(), data.len());
+ let (data, remaining) = data.split_at(to_use);
+ self.data.0[self.len..][..to_use].copy_from_slice(data);
+ self.len += to_use;
+ remaining
+ }
+
+ fn set_data(&mut self, data: &[u8]) {
+ debug_assert!(self.is_empty());
+ debug_assert!(data.len() < CHUNK_SIZE);
+ self.data.0[..data.len()].copy_from_slice(data);
+ self.len = data.len();
+ }
+
+ fn available(&self) -> usize {
+ CHUNK_SIZE - self.len
+ }
+
+ fn is_empty(&self) -> bool {
+ self.len == 0
+ }
+
+ fn is_full(&self) -> bool {
+ self.len == CHUNK_SIZE
+ }
+}
+
+impl XxHash64 {
+ /// Constructs the hash with an initial seed
+ pub fn with_seed(seed: u64) -> XxHash64 {
+ XxHash64 {
+ total_len: 0,
+ seed,
+ core: XxCore::with_seed(seed),
+ buffer: Buffer::default(),
+ }
+ }
+
+ pub(crate) fn write(&mut self, bytes: &[u8]) {
+ let remaining = self.maybe_consume_bytes(bytes);
+ if !remaining.is_empty() {
+ let mut remaining = UnalignedBuffer::new(remaining);
+ self.core.ingest_chunks(&mut remaining);
+ self.buffer.set_data(remaining.remaining());
+ }
+ self.total_len += bytes.len() as u64;
+ }
+
+ // Consume bytes and try to make `self.buffer` empty.
+ // If there are not enough bytes, `self.buffer` can be non-empty, and this
+ // function returns an empty slice.
+ fn maybe_consume_bytes<'a>(&mut self, data: &'a [u8]) -> &'a [u8] {
+ if self.buffer.is_empty() {
+ data
+ } else {
+ let data = self.buffer.consume(data);
+ if self.buffer.is_full() {
+ let mut u64s = UnalignedBuffer::new(self.buffer.data());
+ self.core.ingest_chunks(&mut u64s);
+ debug_assert!(u64s.remaining().is_empty());
+ self.buffer.len = 0;
+ }
+ data
+ }
+ }
+
+ pub(crate) fn finish(&self) -> u64 {
+ let mut hash = if self.total_len >= CHUNK_SIZE as u64 {
+ // We have processed at least one full chunk
+ self.core.finish()
+ } else {
+ self.seed.wrapping_add(PRIME_5)
+ };
+
+ hash = hash.wrapping_add(self.total_len);
+
+ let mut buffered_u64s = UnalignedBuffer::<u64>::new(self.buffer.data());
+ for buffered_u64 in &mut buffered_u64s {
+ let mut k1 = buffered_u64.to_le().wrapping_mul(PRIME_2);
+ k1 = k1.rotate_left(31);
+ k1 = k1.wrapping_mul(PRIME_1);
+ hash ^= k1;
+ hash = hash.rotate_left(27);
+ hash = hash.wrapping_mul(PRIME_1);
+ hash = hash.wrapping_add(PRIME_4);
+ }
+
+ let mut buffered_u32s = UnalignedBuffer::<u32>::new(buffered_u64s.remaining());
+ for buffered_u32 in &mut buffered_u32s {
+ let k1 = u64::from(buffered_u32.to_le()).wrapping_mul(PRIME_1);
+ hash ^= k1;
+ hash = hash.rotate_left(23);
+ hash = hash.wrapping_mul(PRIME_2);
+ hash = hash.wrapping_add(PRIME_3);
+ }
+
+ let buffered_u8s = buffered_u32s.remaining();
+ for &buffered_u8 in buffered_u8s {
+ let k1 = u64::from(buffered_u8).wrapping_mul(PRIME_5);
+ hash ^= k1;
+ hash = hash.rotate_left(11);
+ hash = hash.wrapping_mul(PRIME_1);
+ }
+
+ // The final intermixing
+ hash ^= hash >> 33;
+ hash = hash.wrapping_mul(PRIME_2);
+ hash ^= hash >> 29;
+ hash = hash.wrapping_mul(PRIME_3);
+ hash ^= hash >> 32;
+
+ hash
+ }
+
+ pub fn seed(&self) -> u64 {
+ self.seed
+ }
+
+ pub fn total_len(&self) -> u64 {
+ self.total_len
+ }
+}
+
+impl Default for XxHash64 {
+ fn default() -> XxHash64 {
+ XxHash64::with_seed(0)
+ }
+}
+
+impl Hasher for XxHash64 {
+ fn finish(&self) -> u64 {
+ XxHash64::finish(self)
+ }
+
+ fn write(&mut self, bytes: &[u8]) {
+ XxHash64::write(self, bytes)
+ }
+}
+
+#[cfg(feature = "std")]
+pub use crate::std_support::sixty_four::RandomXxHashBuilder64;
+
+#[cfg(test)]
+mod test {
+ use super::{RandomXxHashBuilder64, XxHash64};
+ use std::collections::HashMap;
+ use std::hash::BuildHasherDefault;
+ use std::prelude::v1::*;
+
+ #[test]
+ fn ingesting_byte_by_byte_is_equivalent_to_large_chunks() {
+ let bytes: Vec<_> = (0..32).map(|_| 0).collect();
+
+ let mut byte_by_byte = XxHash64::with_seed(0);
+ for byte in bytes.chunks(1) {
+ byte_by_byte.write(byte);
+ }
+
+ let mut one_chunk = XxHash64::with_seed(0);
+ one_chunk.write(&bytes);
+
+ assert_eq!(byte_by_byte.core, one_chunk.core);
+ }
+
+ #[test]
+ fn hash_of_nothing_matches_c_implementation() {
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(&[]);
+ assert_eq!(hasher.finish(), 0xef46_db37_51d8_e999);
+ }
+
+ #[test]
+ fn hash_of_single_byte_matches_c_implementation() {
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(&[42]);
+ assert_eq!(hasher.finish(), 0x0a9e_dece_beb0_3ae4);
+ }
+
+ #[test]
+ fn hash_of_multiple_bytes_matches_c_implementation() {
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ assert_eq!(hasher.finish(), 0x7b06_c531_ea43_e89f);
+ }
+
+ #[test]
+ fn hash_of_multiple_chunks_matches_c_implementation() {
+ let bytes: Vec<_> = (0..100).collect();
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(&bytes);
+ assert_eq!(hasher.finish(), 0x6ac1_e580_3216_6597);
+ }
+
+ #[test]
+ fn hash_with_different_seed_matches_c_implementation() {
+ let mut hasher = XxHash64::with_seed(0xae05_4331_1b70_2d91);
+ hasher.write(&[]);
+ assert_eq!(hasher.finish(), 0x4b6a_04fc_df7a_4672);
+ }
+
+ #[test]
+ fn hash_with_different_seed_and_multiple_chunks_matches_c_implementation() {
+ let bytes: Vec<_> = (0..100).collect();
+ let mut hasher = XxHash64::with_seed(0xae05_4331_1b70_2d91);
+ hasher.write(&bytes);
+ assert_eq!(hasher.finish(), 0x567e_355e_0682_e1f1);
+ }
+
+ #[test]
+ fn can_be_used_in_a_hashmap_with_a_default_seed() {
+ let mut hash: HashMap<_, _, BuildHasherDefault<XxHash64>> = Default::default();
+ hash.insert(42, "the answer");
+ assert_eq!(hash.get(&42), Some(&"the answer"));
+ }
+
+ #[test]
+ fn can_be_used_in_a_hashmap_with_a_random_seed() {
+ let mut hash: HashMap<_, _, RandomXxHashBuilder64> = Default::default();
+ hash.insert(42, "the answer");
+ assert_eq!(hash.get(&42), Some(&"the answer"));
+ }
+
+ #[cfg(feature = "serialize")]
+ type TestResult<T = ()> = Result<T, Box<dyn std::error::Error>>;
+
+ #[cfg(feature = "serialize")]
+ #[test]
+ fn test_serialization_cycle() -> TestResult {
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ hasher.finish();
+
+ let serialized = serde_json::to_string(&hasher)?;
+ let unserialized: XxHash64 = serde_json::from_str(&serialized)?;
+ assert_eq!(hasher, unserialized);
+ Ok(())
+ }
+
+ #[cfg(feature = "serialize")]
+ #[test]
+ fn test_serialization_stability() -> TestResult {
+ let mut hasher = XxHash64::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ hasher.finish();
+
+ let serialized = r#"{
+ "total_len": 14,
+ "seed": 0,
+ "core": {
+ "v1": 6983438078262162902,
+ "v2": 14029467366897019727,
+ "v3": 0,
+ "v4": 7046029288634856825
+ },
+ "buffer": [
+ 72, 101, 108, 108, 111, 44, 32, 119,
+ 111, 114, 108, 100, 33, 0, 0, 0,
+ 0, 0, 0, 0, 0, 0, 0, 0,
+ 0, 0, 0, 0, 0, 0, 0, 0
+ ],
+ "buffer_usage": 14
+ }"#;
+
+ let unserialized: XxHash64 = serde_json::from_str(serialized).unwrap();
+ assert_eq!(hasher, unserialized);
+ Ok(())
+ }
+}
diff --git a/crates/twox-hash/src/std_support.rs b/crates/twox-hash/src/std_support.rs
new file mode 100644
index 0000000..d79085e
--- /dev/null
+++ b/crates/twox-hash/src/std_support.rs
@@ -0,0 +1,113 @@
+pub mod sixty_four {
+ use crate::XxHash64;
+ use core::hash::BuildHasher;
+ use rand::{self, Rng};
+
+ #[derive(Clone)]
+ /// Constructs a randomized seed and reuses it for multiple hasher instances.
+ pub struct RandomXxHashBuilder64(u64);
+
+ impl RandomXxHashBuilder64 {
+ fn new() -> RandomXxHashBuilder64 {
+ RandomXxHashBuilder64(rand::thread_rng().gen())
+ }
+ }
+
+ impl Default for RandomXxHashBuilder64 {
+ fn default() -> RandomXxHashBuilder64 {
+ RandomXxHashBuilder64::new()
+ }
+ }
+
+ impl BuildHasher for RandomXxHashBuilder64 {
+ type Hasher = XxHash64;
+
+ fn build_hasher(&self) -> XxHash64 {
+ XxHash64::with_seed(self.0)
+ }
+ }
+}
+
+pub mod thirty_two {
+ use crate::XxHash32;
+ use core::hash::BuildHasher;
+ use rand::{self, Rng};
+
+ #[derive(Clone)]
+ /// Constructs a randomized seed and reuses it for multiple hasher instances. See the usage warning on `XxHash32`.
+ pub struct RandomXxHashBuilder32(u32);
+
+ impl RandomXxHashBuilder32 {
+ fn new() -> RandomXxHashBuilder32 {
+ RandomXxHashBuilder32(rand::thread_rng().gen())
+ }
+ }
+
+ impl Default for RandomXxHashBuilder32 {
+ fn default() -> RandomXxHashBuilder32 {
+ RandomXxHashBuilder32::new()
+ }
+ }
+
+ impl BuildHasher for RandomXxHashBuilder32 {
+ type Hasher = XxHash32;
+
+ fn build_hasher(&self) -> XxHash32 {
+ XxHash32::with_seed(self.0)
+ }
+ }
+}
+
+pub mod xxh3 {
+ use crate::xxh3::{Hash128, Hash64};
+ use core::hash::BuildHasher;
+ use rand::{self, Rng};
+
+ #[derive(Clone)]
+ /// Constructs a randomized seed and reuses it for multiple hasher instances.
+ pub struct RandomHashBuilder64(u64);
+
+ impl RandomHashBuilder64 {
+ fn new() -> RandomHashBuilder64 {
+ RandomHashBuilder64(rand::thread_rng().gen())
+ }
+ }
+
+ impl Default for RandomHashBuilder64 {
+ fn default() -> RandomHashBuilder64 {
+ RandomHashBuilder64::new()
+ }
+ }
+
+ impl BuildHasher for RandomHashBuilder64 {
+ type Hasher = Hash64;
+
+ fn build_hasher(&self) -> Hash64 {
+ Hash64::with_seed(self.0)
+ }
+ }
+
+ #[derive(Clone)]
+ /// Constructs a randomized seed and reuses it for multiple hasher instances.
+ pub struct RandomHashBuilder128(u64);
+
+ impl RandomHashBuilder128 {
+ fn new() -> RandomHashBuilder128 {
+ RandomHashBuilder128(rand::thread_rng().gen())
+ }
+ }
+
+ impl Default for RandomHashBuilder128 {
+ fn default() -> RandomHashBuilder128 {
+ RandomHashBuilder128::new()
+ }
+ }
+
+ impl BuildHasher for RandomHashBuilder128 {
+ type Hasher = Hash128;
+
+ fn build_hasher(&self) -> Hash128 {
+ Hash128::with_seed(self.0)
+ }
+ }
+}
diff --git a/crates/twox-hash/src/thirty_two.rs b/crates/twox-hash/src/thirty_two.rs
new file mode 100644
index 0000000..cfa44cd
--- /dev/null
+++ b/crates/twox-hash/src/thirty_two.rs
@@ -0,0 +1,416 @@
+use crate::UnalignedBuffer;
+use core::{cmp, hash::Hasher};
+
+#[cfg(feature = "serialize")]
+use serde::{Deserialize, Serialize};
+
+const CHUNK_SIZE: usize = 16;
+
+pub const PRIME_1: u32 = 2_654_435_761;
+pub const PRIME_2: u32 = 2_246_822_519;
+pub const PRIME_3: u32 = 3_266_489_917;
+pub const PRIME_4: u32 = 668_265_263;
+pub const PRIME_5: u32 = 374_761_393;
+
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Copy, Clone, PartialEq)]
+struct XxCore {
+ v1: u32,
+ v2: u32,
+ v3: u32,
+ v4: u32,
+}
+
+/// Calculates the 32-bit hash. Care should be taken when using this
+/// hash.
+///
+/// Although this struct implements `Hasher`, it only calculates a
+/// 32-bit number, leaving the upper bits as 0. This means it is
+/// unlikely to be correct to use this in places like a `HashMap`.
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Debug, Copy, Clone, PartialEq)]
+pub struct XxHash32 {
+ total_len: u64,
+ seed: u32,
+ core: XxCore,
+ #[cfg_attr(feature = "serialize", serde(flatten))]
+ buffer: Buffer,
+}
+
+impl XxCore {
+ fn with_seed(seed: u32) -> XxCore {
+ XxCore {
+ v1: seed.wrapping_add(PRIME_1).wrapping_add(PRIME_2),
+ v2: seed.wrapping_add(PRIME_2),
+ v3: seed,
+ v4: seed.wrapping_sub(PRIME_1),
+ }
+ }
+
+ #[inline(always)]
+ fn ingest_chunks<I>(&mut self, values: I)
+ where
+ I: IntoIterator<Item = [u32; 4]>,
+ {
+ #[inline(always)]
+ fn ingest_one_number(mut current_value: u32, mut value: u32) -> u32 {
+ value = value.wrapping_mul(PRIME_2);
+ current_value = current_value.wrapping_add(value);
+ current_value = current_value.rotate_left(13);
+ current_value.wrapping_mul(PRIME_1)
+ }
+
+ // By drawing these out, we can avoid going back and forth to
+ // memory. It only really helps for large files, when we need
+ // to iterate multiple times here.
+
+ let mut v1 = self.v1;
+ let mut v2 = self.v2;
+ let mut v3 = self.v3;
+ let mut v4 = self.v4;
+
+ for [n1, n2, n3, n4] in values {
+ v1 = ingest_one_number(v1, n1.to_le());
+ v2 = ingest_one_number(v2, n2.to_le());
+ v3 = ingest_one_number(v3, n3.to_le());
+ v4 = ingest_one_number(v4, n4.to_le());
+ }
+
+ self.v1 = v1;
+ self.v2 = v2;
+ self.v3 = v3;
+ self.v4 = v4;
+ }
+
+ #[inline(always)]
+ fn finish(&self) -> u32 {
+ // The original code pulls out local vars for v[1234]
+ // here. Performance tests did not show that to be effective
+ // here, presumably because this method is not called in a
+ // tight loop.
+
+ #[allow(unknown_lints, clippy::needless_late_init)] // keeping things parallel
+ let mut hash;
+
+ hash = self.v1.rotate_left(1);
+ hash = hash.wrapping_add(self.v2.rotate_left(7));
+ hash = hash.wrapping_add(self.v3.rotate_left(12));
+ hash = hash.wrapping_add(self.v4.rotate_left(18));
+
+ hash
+ }
+}
+
+impl core::fmt::Debug for XxCore {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
+ write!(
+ f,
+ "XxCore {{ {:016x} {:016x} {:016x} {:016x} }}",
+ self.v1, self.v2, self.v3, self.v4
+ )
+ }
+}
+
+#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[derive(Debug, Copy, Clone, Default, PartialEq)]
+#[repr(align(4))]
+#[cfg_attr(feature = "serialize", serde(transparent))]
+struct AlignToU32<T>(T);
+
+#[cfg_attr(feature = "serialize", derive(Serialize, Deserialize))]
+#[derive(Debug, Copy, Clone, Default, PartialEq)]
+struct Buffer {
+ #[cfg_attr(feature = "serialize", serde(rename = "buffer"))]
+ data: AlignToU32<[u8; CHUNK_SIZE]>,
+ #[cfg_attr(feature = "serialize", serde(rename = "buffer_usage"))]
+ len: usize,
+}
+
+impl Buffer {
+ fn data(&self) -> &[u8] {
+ &self.data.0[..self.len]
+ }
+
+ /// Consumes as much of the parameter as it can, returning the unused part.
+ fn consume<'a>(&mut self, data: &'a [u8]) -> &'a [u8] {
+ let to_use = cmp::min(self.available(), data.len());
+ let (data, remaining) = data.split_at(to_use);
+ self.data.0[self.len..][..to_use].copy_from_slice(data);
+ self.len += to_use;
+ remaining
+ }
+
+ fn set_data(&mut self, data: &[u8]) {
+ debug_assert!(self.is_empty());
+ debug_assert!(data.len() < CHUNK_SIZE);
+ self.data.0[..data.len()].copy_from_slice(data);
+ self.len = data.len();
+ }
+
+ fn available(&self) -> usize {
+ CHUNK_SIZE - self.len
+ }
+
+ fn is_empty(&self) -> bool {
+ self.len == 0
+ }
+
+ fn is_full(&self) -> bool {
+ self.len == CHUNK_SIZE
+ }
+}
+
+impl XxHash32 {
+ /// Constructs the hash with an initial seed
+ pub fn with_seed(seed: u32) -> XxHash32 {
+ XxHash32 {
+ total_len: 0,
+ seed,
+ core: XxCore::with_seed(seed),
+ buffer: Buffer::default(),
+ }
+ }
+
+ pub(crate) fn write(&mut self, bytes: &[u8]) {
+ let remaining = self.maybe_consume_bytes(bytes);
+ if !remaining.is_empty() {
+ let mut remaining = UnalignedBuffer::new(remaining);
+ self.core.ingest_chunks(&mut remaining);
+ self.buffer.set_data(remaining.remaining());
+ }
+ self.total_len += bytes.len() as u64;
+ }
+
+ // Consume bytes and try to make `self.buffer` empty.
+ // If there are not enough bytes, `self.buffer` can be non-empty, and this
+ // function returns an empty slice.
+ fn maybe_consume_bytes<'a>(&mut self, data: &'a [u8]) -> &'a [u8] {
+ if self.buffer.is_empty() {
+ data
+ } else {
+ let data = self.buffer.consume(data);
+ if self.buffer.is_full() {
+ let mut u32s = UnalignedBuffer::new(self.buffer.data());
+ self.core.ingest_chunks(&mut u32s);
+ debug_assert!(u32s.remaining().is_empty());
+ self.buffer.len = 0;
+ }
+ data
+ }
+ }
+
+ pub(crate) fn finish(&self) -> u32 {
+ let mut hash = if self.total_len >= CHUNK_SIZE as u64 {
+ // We have processed at least one full chunk
+ self.core.finish()
+ } else {
+ self.seed.wrapping_add(PRIME_5)
+ };
+
+ hash = hash.wrapping_add(self.total_len as u32);
+
+ let mut buffered_u32s = UnalignedBuffer::<u32>::new(self.buffer.data());
+ for buffered_u32 in &mut buffered_u32s {
+ let k1 = buffered_u32.to_le().wrapping_mul(PRIME_3);
+ hash = hash.wrapping_add(k1);
+ hash = hash.rotate_left(17);
+ hash = hash.wrapping_mul(PRIME_4);
+ }
+
+ let buffered_u8s = buffered_u32s.remaining();
+ for &buffered_u8 in buffered_u8s {
+ let k1 = u32::from(buffered_u8).wrapping_mul(PRIME_5);
+ hash = hash.wrapping_add(k1);
+ hash = hash.rotate_left(11);
+ hash = hash.wrapping_mul(PRIME_1);
+ }
+
+ // The final intermixing
+ hash ^= hash >> 15;
+ hash = hash.wrapping_mul(PRIME_2);
+ hash ^= hash >> 13;
+ hash = hash.wrapping_mul(PRIME_3);
+ hash ^= hash >> 16;
+
+ hash
+ }
+
+ pub fn seed(&self) -> u32 {
+ self.seed
+ }
+
+ /// Get the total number of bytes hashed, truncated to 32 bits.
+ /// For the full 64-bit byte count, use `total_len_64`
+ pub fn total_len(&self) -> u32 {
+ self.total_len as u32
+ }
+
+ /// Get the total number of bytes hashed.
+ pub fn total_len_64(&self) -> u64 {
+ self.total_len
+ }
+}
+
+impl Default for XxHash32 {
+ fn default() -> XxHash32 {
+ XxHash32::with_seed(0)
+ }
+}
+
+impl Hasher for XxHash32 {
+ fn finish(&self) -> u64 {
+ u64::from(XxHash32::finish(self))
+ }
+
+ fn write(&mut self, bytes: &[u8]) {
+ XxHash32::write(self, bytes)
+ }
+}
+
+#[cfg(feature = "std")]
+pub use crate::std_support::thirty_two::RandomXxHashBuilder32;
+
+#[cfg(test)]
+mod test {
+ use super::{RandomXxHashBuilder32, XxHash32};
+ use std::collections::HashMap;
+ use std::hash::BuildHasherDefault;
+ use std::prelude::v1::*;
+
+ #[test]
+ fn ingesting_byte_by_byte_is_equivalent_to_large_chunks() {
+ let bytes: Vec<_> = (0..32).map(|_| 0).collect();
+
+ let mut byte_by_byte = XxHash32::with_seed(0);
+ for byte in bytes.chunks(1) {
+ byte_by_byte.write(byte);
+ }
+
+ let mut one_chunk = XxHash32::with_seed(0);
+ one_chunk.write(&bytes);
+
+ assert_eq!(byte_by_byte.core, one_chunk.core);
+ }
+
+ #[test]
+ fn hash_of_nothing_matches_c_implementation() {
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(&[]);
+ assert_eq!(hasher.finish(), 0x02cc_5d05);
+ }
+
+ #[test]
+ fn hash_of_single_byte_matches_c_implementation() {
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(&[42]);
+ assert_eq!(hasher.finish(), 0xe0fe_705f);
+ }
+
+ #[test]
+ fn hash_of_multiple_bytes_matches_c_implementation() {
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ assert_eq!(hasher.finish(), 0x9e5e_7e93);
+ }
+
+ #[test]
+ fn hash_of_multiple_chunks_matches_c_implementation() {
+ let bytes: Vec<_> = (0..100).collect();
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(&bytes);
+ assert_eq!(hasher.finish(), 0x7f89_ba44);
+ }
+
+ #[test]
+ fn hash_with_different_seed_matches_c_implementation() {
+ let mut hasher = XxHash32::with_seed(0x42c9_1977);
+ hasher.write(&[]);
+ assert_eq!(hasher.finish(), 0xd6bf_8459);
+ }
+
+ #[test]
+ fn hash_with_different_seed_and_multiple_chunks_matches_c_implementation() {
+ let bytes: Vec<_> = (0..100).collect();
+ let mut hasher = XxHash32::with_seed(0x42c9_1977);
+ hasher.write(&bytes);
+ assert_eq!(hasher.finish(), 0x6d2f_6c17);
+ }
+
+ #[test]
+ fn can_be_used_in_a_hashmap_with_a_default_seed() {
+ let mut hash: HashMap<_, _, BuildHasherDefault<XxHash32>> = Default::default();
+ hash.insert(42, "the answer");
+ assert_eq!(hash.get(&42), Some(&"the answer"));
+ }
+
+ #[test]
+ fn can_be_used_in_a_hashmap_with_a_random_seed() {
+ let mut hash: HashMap<_, _, RandomXxHashBuilder32> = Default::default();
+ hash.insert(42, "the answer");
+ assert_eq!(hash.get(&42), Some(&"the answer"));
+ }
+
+ #[cfg(feature = "serialize")]
+ type TestResult<T = ()> = Result<T, Box<dyn std::error::Error>>;
+
+ #[cfg(feature = "serialize")]
+ #[test]
+ fn test_serialization_cycle() -> TestResult {
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ hasher.finish();
+
+ let serialized = serde_json::to_string(&hasher)?;
+ let unserialized: XxHash32 = serde_json::from_str(&serialized)?;
+ assert_eq!(hasher, unserialized);
+ Ok(())
+ }
+
+ #[cfg(feature = "serialize")]
+ #[test]
+ fn test_serialization_stability() -> TestResult {
+ let mut hasher = XxHash32::with_seed(0);
+ hasher.write(b"Hello, world!\0");
+ hasher.finish();
+
+ let serialized = r#"{
+ "total_len": 14,
+ "seed": 0,
+ "core": {
+ "v1": 606290984,
+ "v2": 2246822519,
+ "v3": 0,
+ "v4": 1640531535
+ },
+ "buffer": [
+ 72, 101, 108, 108, 111, 44, 32, 119,
+ 111, 114, 108, 100, 33, 0, 0, 0
+ ],
+ "buffer_usage": 14
+ }"#;
+
+ let unserialized: XxHash32 = serde_json::from_str(serialized).unwrap();
+ assert_eq!(hasher, unserialized);
+ Ok(())
+ }
+
+ // This test validates wraparound/truncation behavior for very large inputs
+ // of a 32-bit hash, but runs very slowly in the normal "cargo test"
+ // build config since it hashes 4.3GB of data. It runs reasonably quick
+ // under "cargo test --release".
+ /*
+ #[test]
+ fn len_overflow_32bit() {
+ // Hash 4.3 billion (4_300_000_000) bytes, which overflows a u32.
+ let bytes200: Vec<u8> = (0..200).collect();
+ let mut hasher = XxHash32::with_seed(0);
+ for _ in 0..(4_300_000_000u64 / 200u64) {
+ hasher.write(&bytes200);
+ }
+ assert_eq!(hasher.total_len_64(), 0x0000_0001_004c_cb00);
+ assert_eq!(hasher.total_len(), 0x004c_cb00);
+ // retult is tested against the C implementation
+ assert_eq!(hasher.finish(), 0x1522_4ca7);
+ }
+ */
+}
diff --git a/crates/twox-hash/src/xxh3.rs b/crates/twox-hash/src/xxh3.rs
new file mode 100644
index 0000000..0ffc541
--- /dev/null
+++ b/crates/twox-hash/src/xxh3.rs
@@ -0,0 +1,1666 @@
+//! The in-progress XXH3 algorithm.
+//!
+//! Please read [the notes in original implementation][warning] to
+//! learn about when to use these algorithms. Specifically, the
+//! version of code this crate reproduces says:
+//!
+//! > The algorithm is currently in development, meaning its return
+//! values might still change in future versions. However, the API
+//! is stable, and can be used in production, typically for
+//! generation of ephemeral hashes (produced and consumed in same
+//! session).
+//!
+//! [warning]: https://github.com/Cyan4973/xxHash#new-hash-algorithms
+
+use alloc::vec::Vec;
+
+use core::convert::TryInto;
+use core::hash::Hasher;
+use core::mem;
+use core::ops::{Deref, DerefMut};
+use core::slice;
+
+#[cfg(target_arch = "x86")]
+use core::arch::x86::*;
+#[cfg(target_arch = "x86_64")]
+use core::arch::x86_64::*;
+
+use cfg_if::cfg_if;
+use static_assertions::{const_assert, const_assert_eq};
+
+#[cfg(feature = "serialize")]
+use serde::{Deserialize, Serialize};
+
+use crate::sixty_four::{
+ PRIME_1 as PRIME64_1, PRIME_2 as PRIME64_2, PRIME_3 as PRIME64_3, PRIME_4 as PRIME64_4,
+ PRIME_5 as PRIME64_5,
+};
+use crate::thirty_two::{PRIME_1 as PRIME32_1, PRIME_2 as PRIME32_2, PRIME_3 as PRIME32_3};
+
+#[cfg(feature = "std")]
+pub use crate::std_support::xxh3::{RandomHashBuilder128, RandomHashBuilder64};
+
+#[inline(always)]
+pub fn hash64(data: &[u8]) -> u64 {
+ hash64_with_seed(data, 0)
+}
+
+#[inline(always)]
+pub fn hash64_with_seed(data: &[u8], seed: u64) -> u64 {
+ let len = data.len();
+
+ if len <= 16 {
+ hash_len_0to16_64bits(data, len, &SECRET, seed)
+ } else if len <= 128 {
+ hash_len_17to128_64bits(data, len, &SECRET, seed)
+ } else if len <= MIDSIZE_MAX {
+ hash_len_129to240_64bits(data, len, &SECRET, seed)
+ } else {
+ hash_long_64bits_with_seed(data, len, seed)
+ }
+}
+
+#[inline(always)]
+pub fn hash64_with_secret(data: &[u8], secret: &[u8]) -> u64 {
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let len = data.len();
+
+ if len <= 16 {
+ hash_len_0to16_64bits(data, len, secret, 0)
+ } else if len <= 128 {
+ hash_len_17to128_64bits(data, len, secret, 0)
+ } else if len <= MIDSIZE_MAX {
+ hash_len_129to240_64bits(data, len, secret, 0)
+ } else {
+ hash_long_64bits_with_secret(data, len, secret)
+ }
+}
+
+#[inline(always)]
+pub fn hash128(data: &[u8]) -> u128 {
+ hash128_with_seed(data, 0)
+}
+
+#[inline(always)]
+pub fn hash128_with_seed(data: &[u8], seed: u64) -> u128 {
+ let len = data.len();
+
+ if len <= 16 {
+ hash_len_0to16_128bits(data, len, &SECRET, seed)
+ } else if len <= 128 {
+ hash_len_17to128_128bits(data, len, &SECRET, seed)
+ } else if len <= MIDSIZE_MAX {
+ hash_len_129to240_128bits(data, len, &SECRET, seed)
+ } else {
+ hash_long_128bits_with_seed(data, len, seed)
+ }
+}
+
+#[inline(always)]
+pub fn hash128_with_secret(data: &[u8], secret: &[u8]) -> u128 {
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let len = data.len();
+
+ if len <= 16 {
+ hash_len_0to16_128bits(data, len, secret, 0)
+ } else if len <= 128 {
+ hash_len_17to128_128bits(data, len, secret, 0)
+ } else if len <= MIDSIZE_MAX {
+ hash_len_129to240_128bits(data, len, secret, 0)
+ } else {
+ hash_long_128bits_with_secret(data, len, secret)
+ }
+}
+
+/// Calculates the 64-bit hash.
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Clone, Default)]
+pub struct Hash64(State);
+
+impl Hash64 {
+ pub fn with_seed(seed: u64) -> Self {
+ Self(State::with_seed(seed))
+ }
+
+ pub fn with_secret<S: Into<Vec<u8>>>(secret: S) -> Self {
+ Self(State::with_secret(secret))
+ }
+}
+
+impl Hasher for Hash64 {
+ #[inline(always)]
+ fn finish(&self) -> u64 {
+ self.0.digest64()
+ }
+
+ #[inline(always)]
+ fn write(&mut self, bytes: &[u8]) {
+ self.0.update(bytes, AccWidth::Acc64Bits)
+ }
+}
+
+/// Calculates the 128-bit hash.
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Clone, Default)]
+pub struct Hash128(State);
+
+impl Hash128 {
+ pub fn with_seed(seed: u64) -> Self {
+ Self(State::with_seed(seed))
+ }
+
+ pub fn with_secret<S: Into<Vec<u8>>>(secret: S) -> Self {
+ Self(State::with_secret(secret))
+ }
+}
+
+impl Hasher for Hash128 {
+ #[inline(always)]
+ fn finish(&self) -> u64 {
+ self.0.digest128() as u64
+ }
+
+ #[inline(always)]
+ fn write(&mut self, bytes: &[u8]) {
+ self.0.update(bytes, AccWidth::Acc128Bits)
+ }
+}
+
+pub trait HasherExt: Hasher {
+ fn finish_ext(&self) -> u128;
+}
+
+impl HasherExt for Hash128 {
+ #[inline(always)]
+ fn finish_ext(&self) -> u128 {
+ self.0.digest128()
+ }
+}
+
+/* ==========================================
+ * XXH3 default settings
+ * ========================================== */
+
+const SECRET_DEFAULT_SIZE: usize = 192;
+const SECRET_SIZE_MIN: usize = 136;
+
+const SECRET: Secret = Secret([
+ 0xb8, 0xfe, 0x6c, 0x39, 0x23, 0xa4, 0x4b, 0xbe, 0x7c, 0x01, 0x81, 0x2c, 0xf7, 0x21, 0xad, 0x1c,
+ 0xde, 0xd4, 0x6d, 0xe9, 0x83, 0x90, 0x97, 0xdb, 0x72, 0x40, 0xa4, 0xa4, 0xb7, 0xb3, 0x67, 0x1f,
+ 0xcb, 0x79, 0xe6, 0x4e, 0xcc, 0xc0, 0xe5, 0x78, 0x82, 0x5a, 0xd0, 0x7d, 0xcc, 0xff, 0x72, 0x21,
+ 0xb8, 0x08, 0x46, 0x74, 0xf7, 0x43, 0x24, 0x8e, 0xe0, 0x35, 0x90, 0xe6, 0x81, 0x3a, 0x26, 0x4c,
+ 0x3c, 0x28, 0x52, 0xbb, 0x91, 0xc3, 0x00, 0xcb, 0x88, 0xd0, 0x65, 0x8b, 0x1b, 0x53, 0x2e, 0xa3,
+ 0x71, 0x64, 0x48, 0x97, 0xa2, 0x0d, 0xf9, 0x4e, 0x38, 0x19, 0xef, 0x46, 0xa9, 0xde, 0xac, 0xd8,
+ 0xa8, 0xfa, 0x76, 0x3f, 0xe3, 0x9c, 0x34, 0x3f, 0xf9, 0xdc, 0xbb, 0xc7, 0xc7, 0x0b, 0x4f, 0x1d,
+ 0x8a, 0x51, 0xe0, 0x4b, 0xcd, 0xb4, 0x59, 0x31, 0xc8, 0x9f, 0x7e, 0xc9, 0xd9, 0x78, 0x73, 0x64,
+ 0xea, 0xc5, 0xac, 0x83, 0x34, 0xd3, 0xeb, 0xc3, 0xc5, 0x81, 0xa0, 0xff, 0xfa, 0x13, 0x63, 0xeb,
+ 0x17, 0x0d, 0xdd, 0x51, 0xb7, 0xf0, 0xda, 0x49, 0xd3, 0x16, 0x55, 0x26, 0x29, 0xd4, 0x68, 0x9e,
+ 0x2b, 0x16, 0xbe, 0x58, 0x7d, 0x47, 0xa1, 0xfc, 0x8f, 0xf8, 0xb8, 0xd1, 0x7a, 0xd0, 0x31, 0xce,
+ 0x45, 0xcb, 0x3a, 0x8f, 0x95, 0x16, 0x04, 0x28, 0xaf, 0xd7, 0xfb, 0xca, 0xbb, 0x4b, 0x40, 0x7e,
+]);
+
+#[repr(align(64))]
+#[derive(Clone)]
+struct Secret([u8; SECRET_DEFAULT_SIZE]);
+
+const_assert_eq!(mem::size_of::<Secret>() % 16, 0);
+
+impl Default for Secret {
+ #[inline(always)]
+ fn default() -> Self {
+ SECRET
+ }
+}
+
+impl Deref for Secret {
+ type Target = [u8];
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.0[..]
+ }
+}
+
+cfg_if! {
+ if #[cfg(feature = "serialize")] {
+ impl Serialize for Secret {
+ fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+ where
+ S: serde::Serializer,
+ {
+ serializer.serialize_bytes(self)
+ }
+ }
+
+ impl<'de> Deserialize<'de> for Secret {
+ fn deserialize<D>(deserializer: D) -> Result<Secret, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ deserializer.deserialize_bytes(SecretVisitor)
+ }
+ }
+
+ struct SecretVisitor;
+
+ impl<'de> serde::de::Visitor<'de> for SecretVisitor {
+ type Value = Secret;
+
+ fn expecting(&self, formatter: &mut core::fmt::Formatter) -> core::fmt::Result {
+ formatter.write_str("secret with a bytes array")
+ }
+
+ fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E>
+ where
+ E: serde::de::Error,
+ {
+ if v.len() == SECRET_DEFAULT_SIZE {
+ let mut secret = [0; SECRET_DEFAULT_SIZE];
+
+ secret.copy_from_slice(v);
+
+ Ok(Secret(secret))
+ } else {
+ Err(E::custom("incomplete secret data"))
+ }
+ }
+ }
+ }
+}
+
+impl Secret {
+ #[inline(always)]
+ pub fn with_seed(seed: u64) -> Self {
+ let mut secret = [0; SECRET_DEFAULT_SIZE];
+
+ for off in (0..SECRET_DEFAULT_SIZE).step_by(16) {
+ secret[off..].write_u64_le(SECRET[off..].read_u64_le().wrapping_add(seed));
+ secret[off + 8..].write_u64_le(SECRET[off + 8..].read_u64_le().wrapping_sub(seed));
+ }
+
+ Secret(secret)
+ }
+}
+
+cfg_if! {
+ if #[cfg(target_feature = "avx2")] {
+ #[repr(align(32))]
+ #[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+ #[derive(Clone)]
+ struct Acc([u64; ACC_NB]);
+ } else if #[cfg(target_feature = "sse2")] {
+ #[repr(align(16))]
+ #[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+ #[derive(Clone)]
+ struct Acc([u64; ACC_NB]);
+ } else {
+ #[repr(align(8))]
+ #[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+ #[derive(Clone)]
+ struct Acc([u64; ACC_NB]);
+ }
+}
+
+const ACC_SIZE: usize = mem::size_of::<Acc>();
+
+const_assert_eq!(ACC_SIZE, 64);
+
+impl Default for Acc {
+ #[inline(always)]
+ fn default() -> Self {
+ Acc([
+ u64::from(PRIME32_3),
+ PRIME64_1,
+ PRIME64_2,
+ PRIME64_3,
+ PRIME64_4,
+ u64::from(PRIME32_2),
+ PRIME64_5,
+ u64::from(PRIME32_1),
+ ])
+ }
+}
+
+impl Deref for Acc {
+ type Target = [u64];
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.0
+ }
+}
+
+impl DerefMut for Acc {
+ #[inline(always)]
+ fn deref_mut(&mut self) -> &mut Self::Target {
+ &mut self.0
+ }
+}
+
+trait Buf {
+ fn read_u32_le(&self) -> u32;
+
+ fn read_u64_le(&self) -> u64;
+}
+
+trait BufMut {
+ fn write_u32_le(&mut self, n: u32);
+
+ fn write_u64_le(&mut self, n: u64);
+}
+
+impl Buf for [u8] {
+ #[inline(always)]
+ fn read_u32_le(&self) -> u32 {
+ let buf = &self[..mem::size_of::<u32>()];
+ u32::from_le_bytes(buf.try_into().unwrap())
+ }
+
+ #[inline(always)]
+ fn read_u64_le(&self) -> u64 {
+ let buf = &self[..mem::size_of::<u64>()];
+ u64::from_le_bytes(buf.try_into().unwrap())
+ }
+}
+
+impl BufMut for [u8] {
+ #[inline(always)]
+ fn write_u32_le(&mut self, n: u32) {
+ self[..mem::size_of::<u32>()].copy_from_slice(&n.to_le_bytes()[..]);
+ }
+
+ #[inline(always)]
+ fn write_u64_le(&mut self, n: u64) {
+ self[..mem::size_of::<u64>()].copy_from_slice(&n.to_le_bytes()[..]);
+ }
+}
+
+/* ==========================================
+ * Short keys
+ * ========================================== */
+
+#[inline(always)]
+fn hash_len_0to16_64bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u64 {
+ debug_assert!(len <= 16);
+
+ if len > 8 {
+ hash_len_9to16_64bits(data, len, key, seed)
+ } else if len >= 4 {
+ hash_len_4to8_64bits(data, len, key, seed)
+ } else if len > 0 {
+ hash_len_1to3_64bits(data, len, key, seed)
+ } else {
+ 0
+ }
+}
+
+#[inline(always)]
+fn hash_len_9to16_64bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u64 {
+ debug_assert!((9..=16).contains(&len));
+
+ let ll1 = data.read_u64_le() ^ key.read_u64_le().wrapping_add(seed);
+ let ll2 = data[len - 8..].read_u64_le() ^ key[8..].read_u64_le().wrapping_sub(seed);
+ let acc = (len as u64)
+ .wrapping_add(ll1)
+ .wrapping_add(ll2)
+ .wrapping_add(mul128_fold64(ll1, ll2));
+
+ avalanche(acc)
+}
+
+#[inline(always)]
+fn hash_len_4to8_64bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u64 {
+ debug_assert!((4..=8).contains(&len));
+
+ let in1 = u64::from(data.read_u32_le());
+ let in2 = u64::from(data[len - 4..].read_u32_le());
+ let in64 = in1.wrapping_add(in2 << 32);
+ let keyed = in64 ^ key.read_u64_le().wrapping_add(seed);
+ let mix64 =
+ (len as u64).wrapping_add((keyed ^ (keyed >> 51)).wrapping_mul(u64::from(PRIME32_1)));
+
+ avalanche((mix64 ^ (mix64 >> 47)).wrapping_mul(PRIME64_2))
+}
+
+#[inline(always)]
+fn hash_len_1to3_64bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u64 {
+ debug_assert!((1..=3).contains(&len));
+
+ let c1 = u32::from(data[0]);
+ let c2 = u32::from(data[len >> 1]);
+ let c3 = u32::from(data[len - 1]);
+ let combined = c1 + (c2 << 8) + (c3 << 16) + ((len as u32) << 24);
+ let keyed = u64::from(combined) ^ u64::from(key.read_u32_le()).wrapping_add(seed);
+ let mixed = keyed.wrapping_mul(PRIME64_1);
+
+ avalanche(mixed)
+}
+
+#[inline(always)]
+fn hash_len_17to128_64bits(data: &[u8], len: usize, secret: &[u8], seed: u64) -> u64 {
+ debug_assert!((17..=128).contains(&len));
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let mut acc = PRIME64_1.wrapping_mul(len as u64);
+
+ if len > 32 {
+ if len > 64 {
+ if len > 96 {
+ acc = acc
+ .wrapping_add(mix_16bytes(&data[48..], &secret[96..], seed))
+ .wrapping_add(mix_16bytes(&data[len - 64..], &secret[112..], seed));
+ }
+ acc = acc
+ .wrapping_add(mix_16bytes(&data[32..], &secret[64..], seed))
+ .wrapping_add(mix_16bytes(&data[len - 48..], &secret[80..], seed));
+ }
+
+ acc = acc
+ .wrapping_add(mix_16bytes(&data[16..], &secret[32..], seed))
+ .wrapping_add(mix_16bytes(&data[len - 32..], &secret[48..], seed));
+ }
+
+ acc = acc
+ .wrapping_add(mix_16bytes(data, secret, seed))
+ .wrapping_add(mix_16bytes(&data[len - 16..], &secret[16..], seed));
+
+ avalanche(acc)
+}
+
+const MIDSIZE_MAX: usize = 240;
+const MIDSIZE_STARTOFFSET: usize = 3;
+const MIDSIZE_LASTOFFSET: usize = 17;
+
+#[inline(always)]
+fn hash_len_129to240_64bits(data: &[u8], len: usize, secret: &[u8], seed: u64) -> u64 {
+ debug_assert!((129..=MIDSIZE_MAX).contains(&len));
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let acc = (len as u64).wrapping_mul(PRIME64_1);
+ let acc = (0..8).fold(acc, |acc, i| {
+ acc.wrapping_add(mix_16bytes(&data[16 * i..], &secret[16 * i..], seed))
+ });
+ let acc = avalanche(acc);
+
+ let nb_rounds = len / 16;
+ debug_assert!(nb_rounds >= 8);
+
+ let acc = (8..nb_rounds).fold(acc, |acc, i| {
+ acc.wrapping_add(mix_16bytes(
+ &data[16 * i..],
+ &secret[16 * (i - 8) + MIDSIZE_STARTOFFSET..],
+ seed,
+ ))
+ });
+
+ avalanche(acc.wrapping_add(mix_16bytes(
+ &data[len - 16..],
+ &secret[SECRET_SIZE_MIN - MIDSIZE_LASTOFFSET..],
+ seed,
+ )))
+}
+
+/* ==========================================
+ * Long keys
+ * ========================================== */
+
+const STRIPE_LEN: usize = 64;
+const SECRET_CONSUME_RATE: usize = 8; // nb of secret bytes consumed at each accumulation
+const SECRET_MERGEACCS_START: usize = 11; // do not align on 8, so that secret is different from accumulator
+const SECRET_LASTACC_START: usize = 7; // do not align on 8, so that secret is different from scrambler
+const ACC_NB: usize = STRIPE_LEN / mem::size_of::<u64>();
+
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub(crate) enum AccWidth {
+ Acc64Bits,
+ Acc128Bits,
+}
+
+#[inline(always)]
+fn hash_long_64bits_with_default_secret(data: &[u8], len: usize) -> u64 {
+ hash_long_internal(data, len, &SECRET)
+}
+
+#[inline(always)]
+fn hash_long_64bits_with_secret(data: &[u8], len: usize, secret: &[u8]) -> u64 {
+ hash_long_internal(data, len, secret)
+}
+
+/// Generate a custom key, based on alteration of default kSecret with the seed,
+/// and then use this key for long mode hashing.
+///
+/// This operation is decently fast but nonetheless costs a little bit of time.
+/// Try to avoid it whenever possible (typically when `seed.is_none()`).
+#[inline(always)]
+fn hash_long_64bits_with_seed(data: &[u8], len: usize, seed: u64) -> u64 {
+ if seed == 0 {
+ hash_long_64bits_with_default_secret(data, len)
+ } else {
+ let secret = Secret::with_seed(seed);
+
+ hash_long_internal(data, len, &secret)
+ }
+}
+
+#[inline(always)]
+fn hash_long_internal(data: &[u8], len: usize, secret: &[u8]) -> u64 {
+ let mut acc = Acc::default();
+
+ hash_long_internal_loop(&mut acc, data, len, secret, AccWidth::Acc64Bits);
+
+ merge_accs(
+ &acc,
+ &secret[SECRET_MERGEACCS_START..],
+ (len as u64).wrapping_mul(PRIME64_1),
+ )
+}
+
+#[inline(always)]
+fn hash_long_internal_loop(
+ acc: &mut [u64],
+ data: &[u8],
+ len: usize,
+ secret: &[u8],
+ acc_width: AccWidth,
+) {
+ let secret_len = secret.len();
+ let nb_rounds = (secret_len - STRIPE_LEN) / SECRET_CONSUME_RATE;
+ let block_len = STRIPE_LEN * nb_rounds;
+
+ debug_assert!(secret_len >= SECRET_SIZE_MIN);
+
+ let mut chunks = data.chunks_exact(block_len);
+
+ for chunk in &mut chunks {
+ accumulate(acc, chunk, secret, nb_rounds, acc_width);
+ unsafe {
+ scramble_acc(acc, &secret[secret_len - STRIPE_LEN..]);
+ }
+ }
+
+ /* last partial block */
+ debug_assert!(len > STRIPE_LEN);
+
+ let nb_stripes = (len % block_len) / STRIPE_LEN;
+
+ debug_assert!(nb_stripes < (secret_len / SECRET_CONSUME_RATE));
+
+ accumulate(acc, chunks.remainder(), secret, nb_stripes, acc_width);
+
+ /* last stripe */
+ if (len & (STRIPE_LEN - 1)) != 0 {
+ unsafe {
+ accumulate512(
+ acc,
+ &data[len - STRIPE_LEN..],
+ &secret[secret_len - STRIPE_LEN - SECRET_LASTACC_START..],
+ acc_width,
+ );
+ }
+ }
+}
+
+#[inline(always)]
+fn accumulate(acc: &mut [u64], data: &[u8], secret: &[u8], nb_stripes: usize, acc_width: AccWidth) {
+ for n in 0..nb_stripes {
+ unsafe {
+ accumulate512(
+ acc,
+ &data[n * STRIPE_LEN..],
+ &secret[n * SECRET_CONSUME_RATE..],
+ acc_width,
+ );
+ }
+ }
+}
+
+#[inline(always)]
+const fn _mm_shuffle(z: u32, y: u32, x: u32, w: u32) -> i32 {
+ ((z << 6) | (y << 4) | (x << 2) | w) as i32
+}
+
+#[cfg(target_feature = "avx2")]
+mod avx2 {
+ use super::*;
+
+ #[target_feature(enable = "avx2")]
+ pub(crate) unsafe fn accumulate512(
+ acc: &mut [u64],
+ data: &[u8],
+ keys: &[u8],
+ acc_width: AccWidth,
+ ) {
+ let xacc = acc.as_mut_ptr() as *mut __m256i;
+ let xdata = data.as_ptr() as *const __m256i;
+ let xkey = keys.as_ptr() as *const __m256i;
+
+ for i in 0..STRIPE_LEN / mem::size_of::<__m256i>() {
+ let d = _mm256_loadu_si256(xdata.add(i));
+ let k = _mm256_loadu_si256(xkey.add(i));
+ let dk = _mm256_xor_si256(d, k); // uint32 dk[8] = {d0+k0, d1+k1, d2+k2, d3+k3, ...}
+ let mul = _mm256_mul_epu32(dk, _mm256_shuffle_epi32(dk, 0x31)); // uint64 res[4] = {dk0*dk1, dk2*dk3, ...}
+
+ xacc.add(i).write(if acc_width == AccWidth::Acc128Bits {
+ let dswap = _mm256_shuffle_epi32(d, _mm_shuffle(1, 0, 3, 2));
+ let add = _mm256_add_epi64(xacc.add(i).read(), dswap);
+ _mm256_add_epi64(mul, add)
+ } else {
+ let add = _mm256_add_epi64(xacc.add(i).read(), d);
+ _mm256_add_epi64(mul, add)
+ })
+ }
+ }
+
+ #[target_feature(enable = "avx2")]
+ pub unsafe fn scramble_acc(acc: &mut [u64], key: &[u8]) {
+ let xacc = acc.as_mut_ptr() as *mut __m256i;
+ let xkey = key.as_ptr() as *const __m256i;
+ let prime32 = _mm256_set1_epi32(PRIME32_1 as i32);
+
+ for i in 0..STRIPE_LEN / mem::size_of::<__m256i>() {
+ let data = xacc.add(i).read();
+ let shifted = _mm256_srli_epi64(data, 47);
+ let data = _mm256_xor_si256(data, shifted);
+
+ let k = _mm256_loadu_si256(xkey.add(i));
+ let dk = _mm256_xor_si256(data, k); /* U32 dk[4] = {d0+k0, d1+k1, d2+k2, d3+k3} */
+ let dk1 = _mm256_mul_epu32(dk, prime32);
+
+ let d2 = _mm256_shuffle_epi32(dk, 0x31);
+ let dk2 = _mm256_mul_epu32(d2, prime32);
+ let dk2h = _mm256_slli_epi64(dk2, 32);
+
+ xacc.add(i).write(_mm256_add_epi64(dk1, dk2h));
+ }
+ }
+}
+
+#[cfg(all(target_feature = "sse2", not(target_feature = "avx2")))]
+mod sse2 {
+ use super::*;
+
+ #[target_feature(enable = "sse2")]
+ #[allow(clippy::cast_ptr_alignment)]
+ pub(crate) unsafe fn accumulate512(
+ acc: &mut [u64],
+ data: &[u8],
+ keys: &[u8],
+ acc_width: AccWidth,
+ ) {
+ let xacc = acc.as_mut_ptr() as *mut __m128i;
+ let xdata = data.as_ptr() as *const __m128i;
+ let xkey = keys.as_ptr() as *const __m128i;
+
+ for i in 0..STRIPE_LEN / mem::size_of::<__m128i>() {
+ let d = _mm_loadu_si128(xdata.add(i));
+ let k = _mm_loadu_si128(xkey.add(i));
+ let dk = _mm_xor_si128(d, k); // uint32 dk[4] = {d0+k0, d1+k1, d2+k2, d3+k3} */
+ let mul = _mm_mul_epu32(dk, _mm_shuffle_epi32(dk, 0x31)); // uint64 res[4] = {dk0*dk1, dk2*dk3, ...} */
+ xacc.add(i).write(if acc_width == AccWidth::Acc128Bits {
+ let dswap = _mm_shuffle_epi32(d, _mm_shuffle(1, 0, 3, 2));
+ let add = _mm_add_epi64(xacc.add(i).read(), dswap);
+ _mm_add_epi64(mul, add)
+ } else {
+ let add = _mm_add_epi64(xacc.add(i).read(), d);
+ _mm_add_epi64(mul, add)
+ })
+ }
+ }
+
+ #[target_feature(enable = "sse2")]
+ #[allow(clippy::cast_ptr_alignment)]
+ pub unsafe fn scramble_acc(acc: &mut [u64], key: &[u8]) {
+ let xacc = acc.as_mut_ptr() as *mut __m128i;
+ let xkey = key.as_ptr() as *const __m128i;
+ let prime32 = _mm_set1_epi32(PRIME32_1 as i32);
+
+ for i in 0..STRIPE_LEN / mem::size_of::<__m128i>() {
+ let data = xacc.add(i).read();
+ let shifted = _mm_srli_epi64(data, 47);
+ let data = _mm_xor_si128(data, shifted);
+
+ let k = _mm_loadu_si128(xkey.add(i));
+ let dk = _mm_xor_si128(data, k);
+
+ let dk1 = _mm_mul_epu32(dk, prime32);
+
+ let d2 = _mm_shuffle_epi32(dk, 0x31);
+ let dk2 = _mm_mul_epu32(d2, prime32);
+ let dk2h = _mm_slli_epi64(dk2, 32);
+
+ xacc.add(i).write(_mm_add_epi64(dk1, dk2h));
+ }
+ }
+}
+
+#[cfg(not(any(target_feature = "avx2", target_feature = "sse2")))]
+mod generic {
+ use super::*;
+
+ #[inline(always)]
+ pub(crate) unsafe fn accumulate512(
+ acc: &mut [u64],
+ data: &[u8],
+ key: &[u8],
+ acc_width: AccWidth,
+ ) {
+ for i in (0..ACC_NB).step_by(2) {
+ let in1 = data[8 * i..].read_u64_le();
+ let in2 = data[8 * (i + 1)..].read_u64_le();
+ let key1 = key[8 * i..].read_u64_le();
+ let key2 = key[8 * (i + 1)..].read_u64_le();
+ let data_key1 = key1 ^ in1;
+ let data_key2 = key2 ^ in2;
+ acc[i] = acc[i].wrapping_add(mul32_to64(data_key1, data_key1 >> 32));
+ acc[i + 1] = acc[i + 1].wrapping_add(mul32_to64(data_key2, data_key2 >> 32));
+
+ if acc_width == AccWidth::Acc128Bits {
+ acc[i] = acc[i].wrapping_add(in2);
+ acc[i + 1] = acc[i + 1].wrapping_add(in1);
+ } else {
+ acc[i] = acc[i].wrapping_add(in1);
+ acc[i + 1] = acc[i + 1].wrapping_add(in2);
+ }
+ }
+ }
+
+ #[inline(always)]
+ fn mul32_to64(a: u64, b: u64) -> u64 {
+ (a & 0xFFFFFFFF).wrapping_mul(b & 0xFFFFFFFF)
+ }
+
+ #[inline(always)]
+ pub unsafe fn scramble_acc(acc: &mut [u64], key: &[u8]) {
+ for i in 0..ACC_NB {
+ let key64 = key[8 * i..].read_u64_le();
+ let mut acc64 = acc[i];
+ acc64 ^= acc64 >> 47;
+ acc64 ^= key64;
+ acc64 = acc64.wrapping_mul(u64::from(PRIME32_1));
+ acc[i] = acc64;
+ }
+ }
+}
+
+cfg_if! {
+ if #[cfg(target_feature = "avx2")] {
+ use avx2::{accumulate512, scramble_acc};
+ } else if #[cfg(target_feature = "sse2")] {
+ use sse2::{accumulate512, scramble_acc};
+ } else {
+ use generic::{accumulate512, scramble_acc};
+ }
+}
+
+#[inline(always)]
+fn merge_accs(acc: &[u64], secret: &[u8], start: u64) -> u64 {
+ avalanche(
+ start
+ .wrapping_add(mix2accs(acc, secret))
+ .wrapping_add(mix2accs(&acc[2..], &secret[16..]))
+ .wrapping_add(mix2accs(&acc[4..], &secret[32..]))
+ .wrapping_add(mix2accs(&acc[6..], &secret[48..])),
+ )
+}
+
+#[inline(always)]
+fn mix2accs(acc: &[u64], secret: &[u8]) -> u64 {
+ mul128_fold64(
+ acc[0] ^ secret.read_u64_le(),
+ acc[1] ^ secret[8..].read_u64_le(),
+ )
+}
+
+#[inline(always)]
+fn mix_16bytes(data: &[u8], key: &[u8], seed: u64) -> u64 {
+ let ll1 = data.read_u64_le();
+ let ll2 = data[8..].read_u64_le();
+
+ mul128_fold64(
+ ll1 ^ key.read_u64_le().wrapping_add(seed),
+ ll2 ^ key[8..].read_u64_le().wrapping_sub(seed),
+ )
+}
+
+#[inline(always)]
+fn mul128_fold64(ll1: u64, ll2: u64) -> u64 {
+ let lll = u128::from(ll1).wrapping_mul(u128::from(ll2));
+
+ (lll as u64) ^ ((lll >> 64) as u64)
+}
+
+#[inline(always)]
+fn avalanche(mut h64: u64) -> u64 {
+ h64 ^= h64 >> 37;
+ h64 = h64.wrapping_mul(PRIME64_3);
+ h64 ^ (h64 >> 32)
+}
+
+/* === XXH3 streaming === */
+
+const INTERNAL_BUFFER_SIZE: usize = 256;
+const INTERNAL_BUFFER_STRIPES: usize = INTERNAL_BUFFER_SIZE / STRIPE_LEN;
+
+const_assert!(INTERNAL_BUFFER_SIZE >= MIDSIZE_MAX);
+const_assert_eq!(INTERNAL_BUFFER_SIZE % STRIPE_LEN, 0);
+
+#[repr(align(64))]
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Clone)]
+struct State {
+ acc: Acc,
+ secret: With,
+ buf: Vec<u8>,
+ seed: u64,
+ total_len: usize,
+ nb_stripes_so_far: usize,
+}
+
+#[cfg_attr(feature = "serialize", derive(Deserialize, Serialize))]
+#[derive(Clone)]
+enum With {
+ Default(Secret),
+ Custom(Secret),
+ Ref(Vec<u8>),
+}
+
+impl Deref for With {
+ type Target = [u8];
+
+ fn deref(&self) -> &Self::Target {
+ match self {
+ With::Default(secret) | With::Custom(secret) => &secret.0[..],
+ With::Ref(secret) => secret,
+ }
+ }
+}
+
+impl Default for State {
+ fn default() -> Self {
+ Self::new(0, With::Default(Secret::default()))
+ }
+}
+
+impl State {
+ fn new(seed: u64, secret: With) -> Self {
+ State {
+ acc: Acc::default(),
+ secret,
+ buf: Vec::with_capacity(INTERNAL_BUFFER_SIZE),
+ seed,
+ total_len: 0,
+ nb_stripes_so_far: 0,
+ }
+ }
+
+ fn with_seed(seed: u64) -> Self {
+ Self::new(seed, With::Custom(Secret::with_seed(seed)))
+ }
+
+ fn with_secret<S: Into<Vec<u8>>>(secret: S) -> State {
+ let secret = secret.into();
+
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ Self::new(0, With::Ref(secret))
+ }
+
+ #[inline(always)]
+ fn secret_limit(&self) -> usize {
+ self.secret.len() - STRIPE_LEN
+ }
+
+ #[inline(always)]
+ fn nb_stripes_per_block(&self) -> usize {
+ self.secret_limit() / SECRET_CONSUME_RATE
+ }
+
+ #[inline(always)]
+ fn update(&mut self, mut input: &[u8], acc_width: AccWidth) {
+ let len = input.len();
+
+ if len == 0 {
+ return;
+ }
+
+ self.total_len += len;
+
+ if self.buf.len() + len <= self.buf.capacity() {
+ self.buf.extend_from_slice(input);
+ return;
+ }
+
+ let nb_stripes_per_block = self.nb_stripes_per_block();
+ let secret_limit = self.secret_limit();
+
+ if !self.buf.is_empty() {
+ // some data within internal buffer: fill then consume it
+ let (load, rest) = input.split_at(self.buf.capacity() - self.buf.len());
+ self.buf.extend_from_slice(load);
+ input = rest;
+ self.nb_stripes_so_far = consume_stripes(
+ &mut self.acc,
+ self.nb_stripes_so_far,
+ nb_stripes_per_block,
+ &self.buf,
+ INTERNAL_BUFFER_STRIPES,
+ &self.secret,
+ secret_limit,
+ acc_width,
+ );
+ self.buf.clear();
+ }
+
+ // consume input by full buffer quantities
+ let mut chunks = input.chunks_exact(INTERNAL_BUFFER_SIZE);
+
+ for chunk in &mut chunks {
+ self.nb_stripes_so_far = consume_stripes(
+ &mut self.acc,
+ self.nb_stripes_so_far,
+ nb_stripes_per_block,
+ chunk,
+ INTERNAL_BUFFER_STRIPES,
+ &self.secret,
+ secret_limit,
+ acc_width,
+ );
+ }
+
+ // some remaining input data : buffer it
+ self.buf.extend_from_slice(chunks.remainder())
+ }
+
+ #[inline(always)]
+ fn digest_long(&self, acc_width: AccWidth) -> Acc {
+ let mut acc = self.acc.clone();
+ let secret_limit = self.secret_limit();
+
+ if self.buf.len() >= STRIPE_LEN {
+ // digest locally, state remains unaltered, and can continue ingesting more data afterwards
+ let total_nb_stripes = self.buf.len() / STRIPE_LEN;
+ let _nb_stripes_so_far = consume_stripes(
+ &mut acc,
+ self.nb_stripes_so_far,
+ self.nb_stripes_per_block(),
+ &self.buf,
+ total_nb_stripes,
+ &self.secret,
+ secret_limit,
+ acc_width,
+ );
+ if (self.buf.len() % STRIPE_LEN) != 0 {
+ unsafe {
+ accumulate512(
+ &mut acc,
+ &self.buf[self.buf.len() - STRIPE_LEN..],
+ &self.secret[secret_limit - SECRET_LASTACC_START..],
+ acc_width,
+ );
+ }
+ }
+ } else if !self.buf.is_empty() {
+ // one last stripe
+ let mut last_stripe = [0u8; STRIPE_LEN];
+ let catchup_size = STRIPE_LEN - self.buf.len();
+
+ last_stripe[..catchup_size].copy_from_slice(unsafe {
+ slice::from_raw_parts(
+ self.buf.as_ptr().add(self.buf.capacity() - catchup_size),
+ catchup_size,
+ )
+ });
+ last_stripe[catchup_size..].copy_from_slice(&self.buf);
+
+ unsafe {
+ accumulate512(
+ &mut acc,
+ &last_stripe[..],
+ &self.secret[secret_limit - SECRET_LASTACC_START..],
+ acc_width,
+ );
+ }
+ }
+
+ acc
+ }
+
+ #[inline(always)]
+ fn digest64(&self) -> u64 {
+ if self.total_len > MIDSIZE_MAX {
+ let acc = self.digest_long(AccWidth::Acc64Bits);
+
+ merge_accs(
+ &acc,
+ &self.secret[SECRET_MERGEACCS_START..],
+ (self.total_len as u64).wrapping_mul(PRIME64_1),
+ )
+ } else if self.seed != 0 {
+ hash64_with_seed(&self.buf, self.seed)
+ } else {
+ hash64_with_secret(&self.buf, &self.secret[..self.secret_limit() + STRIPE_LEN])
+ }
+ }
+
+ #[inline(always)]
+ fn digest128(&self) -> u128 {
+ let secret_limit = self.secret_limit();
+
+ if self.total_len > MIDSIZE_MAX {
+ let acc = self.digest_long(AccWidth::Acc128Bits);
+
+ debug_assert!(secret_limit + STRIPE_LEN >= ACC_SIZE + SECRET_MERGEACCS_START);
+
+ let total_len = self.total_len as u64;
+
+ let low64 = merge_accs(
+ &acc,
+ &self.secret[SECRET_MERGEACCS_START..],
+ total_len.wrapping_mul(PRIME64_1),
+ );
+ let high64 = merge_accs(
+ &acc,
+ &self.secret[secret_limit + STRIPE_LEN - ACC_SIZE - SECRET_MERGEACCS_START..],
+ !total_len.wrapping_mul(PRIME64_2),
+ );
+
+ u128::from(low64) + (u128::from(high64) << 64)
+ } else if self.seed != 0 {
+ hash128_with_seed(&self.buf, self.seed)
+ } else {
+ hash128_with_secret(&self.buf, &self.secret[..secret_limit + STRIPE_LEN])
+ }
+ }
+}
+
+#[inline(always)]
+#[allow(clippy::too_many_arguments)]
+fn consume_stripes(
+ acc: &mut [u64],
+ nb_stripes_so_far: usize,
+ nb_stripes_per_block: usize,
+ data: &[u8],
+ total_stripes: usize,
+ secret: &[u8],
+ secret_limit: usize,
+ acc_width: AccWidth,
+) -> usize {
+ debug_assert!(nb_stripes_so_far < nb_stripes_per_block);
+
+ if nb_stripes_per_block - nb_stripes_so_far <= total_stripes {
+ let nb_stripes = nb_stripes_per_block - nb_stripes_so_far;
+
+ accumulate(
+ acc,
+ data,
+ &secret[nb_stripes_so_far * SECRET_CONSUME_RATE..],
+ nb_stripes,
+ acc_width,
+ );
+ unsafe {
+ scramble_acc(acc, &secret[secret_limit..]);
+ }
+ accumulate(
+ acc,
+ &data[nb_stripes * STRIPE_LEN..],
+ secret,
+ total_stripes - nb_stripes,
+ acc_width,
+ );
+
+ total_stripes - nb_stripes
+ } else {
+ accumulate(
+ acc,
+ data,
+ &secret[nb_stripes_so_far * SECRET_CONSUME_RATE..],
+ total_stripes,
+ acc_width,
+ );
+
+ nb_stripes_so_far + total_stripes
+ }
+}
+
+/* ==========================================
+ * XXH3 128 bits (=> XXH128)
+ * ========================================== */
+
+#[inline(always)]
+fn hash_len_0to16_128bits(data: &[u8], len: usize, secret: &[u8], seed: u64) -> u128 {
+ debug_assert!(len <= 16);
+
+ if len > 8 {
+ hash_len_9to16_128bits(data, len, secret, seed)
+ } else if len >= 4 {
+ hash_len_4to8_128bits(data, len, secret, seed)
+ } else if len > 0 {
+ hash_len_1to3_128bits(data, len, secret, seed)
+ } else {
+ 0
+ }
+}
+
+#[inline(always)]
+fn hash_len_1to3_128bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u128 {
+ debug_assert!((1..=3).contains(&len));
+
+ let c1 = u32::from(data[0]);
+ let c2 = u32::from(data[len >> 1]);
+ let c3 = u32::from(data[len - 1]);
+ let combinedl = c1 + (c2 << 8) + (c3 << 16) + ((len as u32) << 24);
+ let combinedh = combinedl.swap_bytes();
+ let keyedl = u64::from(combinedl) ^ u64::from(key.read_u32_le()).wrapping_add(seed);
+ let keyedh = u64::from(combinedh) ^ u64::from(key[4..].read_u32_le()).wrapping_sub(seed);
+ let mixedl = keyedl.wrapping_mul(PRIME64_1);
+ let mixedh = keyedh.wrapping_mul(PRIME64_2);
+
+ u128::from(avalanche(mixedl)) + (u128::from(avalanche(mixedh)) << 64)
+}
+
+#[inline(always)]
+fn hash_len_4to8_128bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u128 {
+ debug_assert!((4..=8).contains(&len));
+
+ let in1 = u64::from(data.read_u32_le());
+ let in2 = u64::from(data[len - 4..].read_u32_le());
+ let in64l = in1.wrapping_add(in2 << 32);
+ let in64h = in64l.swap_bytes();
+ let keyedl = in64l ^ key.read_u64_le().wrapping_add(seed);
+ let keyedh = in64h ^ key[8..].read_u64_le().wrapping_sub(seed);
+ let mix64l1 =
+ (len as u64).wrapping_add((keyedl ^ (keyedl >> 51)).wrapping_mul(u64::from(PRIME32_1)));
+ let mix64l2 = (mix64l1 ^ (mix64l1 >> 47)).wrapping_mul(PRIME64_2);
+ let mix64h1 = (keyedh ^ (keyedh >> 47))
+ .wrapping_mul(PRIME64_1)
+ .wrapping_sub(len as u64);
+ let mix64h2 = (mix64h1 ^ (mix64h1 >> 43)).wrapping_mul(PRIME64_4);
+
+ u128::from(avalanche(mix64l2)) + (u128::from(avalanche(mix64h2)) << 64)
+}
+
+#[inline(always)]
+fn hash_len_9to16_128bits(data: &[u8], len: usize, key: &[u8], seed: u64) -> u128 {
+ debug_assert!((9..=16).contains(&len));
+
+ let ll1 = data.read_u64_le() ^ key.read_u64_le().wrapping_add(seed);
+ let ll2 = data[len - 8..].read_u64_le() ^ key[8..].read_u64_le().wrapping_sub(seed);
+ let inlow = ll1 ^ ll2;
+
+ let m128 = u128::from(inlow).wrapping_mul(u128::from(PRIME64_1));
+ let high64 = ((m128 >> 64) as u64).wrapping_add(ll2.wrapping_mul(PRIME64_1));
+ let low64 = (m128 as u64) ^ (high64 >> 32);
+
+ let h128 = u128::from(low64).wrapping_mul(u128::from(PRIME64_2));
+ let high64 = ((h128 >> 64) as u64).wrapping_add(high64.wrapping_mul(PRIME64_2));
+ let low64 = h128 as u64;
+
+ u128::from(avalanche(low64)) + (u128::from(avalanche(high64)) << 64)
+}
+
+#[inline(always)]
+fn hash_len_17to128_128bits(data: &[u8], len: usize, secret: &[u8], seed: u64) -> u128 {
+ debug_assert!((17..=128).contains(&len));
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let mut acc1 = PRIME64_1.wrapping_mul(len as u64);
+ let mut acc2 = 0u64;
+
+ if len > 32 {
+ if len > 64 {
+ if len > 96 {
+ acc1 = acc1.wrapping_add(mix_16bytes(&data[48..], &secret[96..], seed));
+ acc2 = acc2.wrapping_add(mix_16bytes(&data[len - 64..], &secret[112..], seed));
+ }
+ acc1 = acc1.wrapping_add(mix_16bytes(&data[32..], &secret[64..], seed));
+ acc2 = acc2.wrapping_add(mix_16bytes(&data[len - 48..], &secret[80..], seed));
+ }
+
+ acc1 = acc1.wrapping_add(mix_16bytes(&data[16..], &secret[32..], seed));
+ acc2 = acc2.wrapping_add(mix_16bytes(&data[len - 32..], &secret[48..], seed));
+ }
+
+ acc1 = acc1.wrapping_add(mix_16bytes(data, secret, seed));
+ acc2 = acc2.wrapping_add(mix_16bytes(&data[len - 16..], &secret[16..], seed));
+
+ let low64 = acc1.wrapping_add(acc2);
+ let high64 = acc1
+ .wrapping_mul(PRIME64_1)
+ .wrapping_add(acc2.wrapping_mul(PRIME64_4))
+ .wrapping_add((len as u64).wrapping_sub(seed).wrapping_mul(PRIME64_2));
+
+ u128::from(avalanche(low64)) + (u128::from(0u64.wrapping_sub(avalanche(high64))) << 64)
+}
+
+#[inline(always)]
+fn hash_len_129to240_128bits(data: &[u8], len: usize, secret: &[u8], seed: u64) -> u128 {
+ debug_assert!((129..=MIDSIZE_MAX).contains(&len));
+ debug_assert!(secret.len() >= SECRET_SIZE_MIN);
+
+ let acc1 = (len as u64).wrapping_mul(PRIME64_1);
+ let acc2 = 0u64;
+
+ let (acc1, acc2) = (0..4).fold((acc1, acc2), |(acc1, acc2), i| {
+ (
+ acc1.wrapping_add(mix_16bytes(&data[32 * i..], &secret[32 * i..], seed)),
+ acc2.wrapping_add(mix_16bytes(
+ &data[32 * i + 16..],
+ &secret[32 * i + 16..],
+ 0u64.wrapping_sub(seed),
+ )),
+ )
+ });
+ let acc1 = avalanche(acc1);
+ let acc2 = avalanche(acc2);
+
+ let nb_rounds = len / 32;
+ debug_assert!(nb_rounds >= 4);
+
+ let (acc1, acc2) = (4..nb_rounds).fold((acc1, acc2), |(acc1, acc2), i| {
+ (
+ acc1.wrapping_add(mix_16bytes(
+ &data[32 * i..],
+ &secret[32 * (i - 4) + MIDSIZE_STARTOFFSET..],
+ seed,
+ )),
+ acc2.wrapping_add(mix_16bytes(
+ &data[32 * i + 16..],
+ &secret[32 * (i - 4) + 16 + MIDSIZE_STARTOFFSET..],
+ 0u64.wrapping_sub(seed),
+ )),
+ )
+ });
+
+ // last bytes
+ let acc1 = acc1.wrapping_add(mix_16bytes(
+ &data[len - 16..],
+ &secret[SECRET_SIZE_MIN - MIDSIZE_LASTOFFSET..],
+ seed,
+ ));
+ let acc2 = acc2.wrapping_add(mix_16bytes(
+ &data[len - 32..],
+ &secret[SECRET_SIZE_MIN - MIDSIZE_LASTOFFSET - 16..],
+ 0u64.wrapping_sub(seed),
+ ));
+
+ let low64 = acc1.wrapping_add(acc2);
+ let high64 = acc1
+ .wrapping_mul(PRIME64_1)
+ .wrapping_add(acc2.wrapping_mul(PRIME64_4))
+ .wrapping_add((len as u64).wrapping_sub(seed).wrapping_mul(PRIME64_2));
+
+ u128::from(avalanche(low64)) + (u128::from(0u64.wrapping_sub(avalanche(high64))) << 64)
+}
+
+#[inline]
+fn hash_long_128bits_with_default_secret(data: &[u8], len: usize) -> u128 {
+ hash_long_128bits_internal(data, len, &SECRET)
+}
+
+#[inline]
+fn hash_long_128bits_with_secret(data: &[u8], len: usize, secret: &[u8]) -> u128 {
+ hash_long_128bits_internal(data, len, secret)
+}
+
+#[inline]
+fn hash_long_128bits_with_seed(data: &[u8], len: usize, seed: u64) -> u128 {
+ if seed == 0 {
+ hash_long_128bits_with_default_secret(data, len)
+ } else {
+ let secret = Secret::with_seed(seed);
+
+ hash_long_128bits_internal(data, len, &secret)
+ }
+}
+
+#[inline(always)]
+fn hash_long_128bits_internal(data: &[u8], len: usize, secret: &[u8]) -> u128 {
+ let mut acc = Acc::default();
+
+ hash_long_internal_loop(&mut acc, data, len, secret, AccWidth::Acc128Bits);
+
+ debug_assert!(secret.len() >= acc.len() + SECRET_MERGEACCS_START);
+
+ let low64 = merge_accs(
+ &acc,
+ &secret[SECRET_MERGEACCS_START..],
+ (len as u64).wrapping_mul(PRIME64_1),
+ );
+ let high64 = merge_accs(
+ &acc,
+ &secret[secret.len() - ACC_SIZE - SECRET_MERGEACCS_START..],
+ !(len as u64).wrapping_mul(PRIME64_2),
+ );
+
+ u128::from(low64) + (u128::from(high64) << 64)
+}
+
+/* === XXH3 128-bit streaming === */
+
+/* all the functions are actually the same as for 64-bit streaming variant,
+just the reset one is different (different initial acc values for 0,5,6,7),
+and near the end of the digest function */
+
+#[cfg(test)]
+mod tests {
+ use alloc::vec;
+
+ use super::*;
+
+ const PRIME: u64 = 2654435761;
+ const PRIME64: u64 = 11400714785074694797;
+ const SANITY_BUFFER_SIZE: usize = 2243;
+
+ fn sanity_buffer() -> [u8; SANITY_BUFFER_SIZE] {
+ let mut buf = [0; SANITY_BUFFER_SIZE];
+ let mut byte_gen: u64 = PRIME;
+
+ for b in buf.iter_mut() {
+ *b = (byte_gen >> 56) as u8;
+ byte_gen = byte_gen.wrapping_mul(PRIME64);
+ }
+
+ buf
+ }
+
+ #[test]
+ fn hash_64bits_sanity_check() {
+ let buf = sanity_buffer();
+
+ let test_cases = vec![
+ (&[][..], 0, 0), /* zero-length hash is always 0 */
+ (&[][..], PRIME64, 0),
+ (&buf[..1], 0, 0x7198D737CFE7F386), /* 1 - 3 */
+ (&buf[..1], PRIME64, 0xB70252DB7161C2BD), /* 1 - 3 */
+ (&buf[..6], 0, 0x22CBF5F3E1F6257C), /* 4 - 8 */
+ (&buf[..6], PRIME64, 0x6398631C12AB94CE), /* 4 - 8 */
+ (&buf[..12], 0, 0xD5361CCEEBB5A0CC), /* 9 - 16 */
+ (&buf[..12], PRIME64, 0xC4C125E75A808C3D), /* 9 - 16 */
+ (&buf[..24], 0, 0x46796F3F78B20F6B), /* 17 - 32 */
+ (&buf[..24], PRIME64, 0x60171A7CD0A44C10), /* 17 - 32 */
+ (&buf[..48], 0, 0xD8D4D3590D136E11), /* 33 - 64 */
+ (&buf[..48], PRIME64, 0x05441F2AEC2A1296), /* 33 - 64 */
+ (&buf[..80], 0, 0xA1DC8ADB3145B86A), /* 65 - 96 */
+ (&buf[..80], PRIME64, 0xC9D55256965B7093), /* 65 - 96 */
+ (&buf[..112], 0, 0xE43E5717A61D3759), /* 97 -128 */
+ (&buf[..112], PRIME64, 0x5A5F89A3FECE44A5), /* 97 -128 */
+ (&buf[..195], 0, 0x6F747739CBAC22A5), /* 129-240 */
+ (&buf[..195], PRIME64, 0x33368E23C7F95810), /* 129-240 */
+ (&buf[..403], 0, 0x4834389B15D981E8), /* one block, last stripe is overlapping */
+ (&buf[..403], PRIME64, 0x85CE5DFFC7B07C87), /* one block, last stripe is overlapping */
+ (&buf[..512], 0, 0x6A1B982631F059A8), /* one block, finishing at stripe boundary */
+ (&buf[..512], PRIME64, 0x10086868CF0ADC99), /* one block, finishing at stripe boundary */
+ (&buf[..2048], 0, 0xEFEFD4449323CDD4), /* 2 blocks, finishing at block boundary */
+ (&buf[..2048], PRIME64, 0x01C85E405ECA3F6E), /* 2 blocks, finishing at block boundary */
+ (&buf[..2240], 0, 0x998C0437486672C7), /* 3 blocks, finishing at stripe boundary */
+ (&buf[..2240], PRIME64, 0x4ED38056B87ABC7F), /* 3 blocks, finishing at stripe boundary */
+ (&buf[..2243], 0, 0xA559D20581D742D3), /* 3 blocks, last stripe is overlapping */
+ (&buf[..2243], PRIME64, 0x96E051AB57F21FC8), /* 3 blocks, last stripe is overlapping */
+ ];
+
+ for (buf, seed, result) in test_cases {
+ {
+ let hash = hash64_with_seed(buf, seed);
+
+ assert_eq!(
+ hash,
+ result,
+ "hash64_with_seed(&buf[..{}], seed={}) failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ // streaming API test
+
+ // single ingestio
+ {
+ let mut hasher = Hash64::with_seed(seed);
+ hasher.write(buf);
+ let hash = hasher.finish();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..{}]) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ if buf.len() > 3 {
+ // 2 ingestions
+ let mut hasher = Hash64::with_seed(seed);
+ hasher.write(&buf[..3]);
+ hasher.write(&buf[3..]);
+ let hash = hasher.finish();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..3], &buf[3..{}]) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ // byte by byte ingestion
+ {
+ let mut hasher = Hash64::with_seed(seed);
+
+ for chunk in buf.chunks(1) {
+ hasher.write(chunk);
+ }
+
+ let hash = hasher.finish();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..{}].chunks(1)) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+ }
+ }
+
+ #[test]
+ fn hash_64bits_with_secret_sanity_check() {
+ let buf = sanity_buffer();
+ let secret = &buf[7..7 + SECRET_SIZE_MIN + 11];
+
+ let test_cases = vec![
+ (&[][..], secret, 0), /* zero-length hash is always 0 */
+ (&buf[..1], secret, 0x7F69735D618DB3F0), /* 1 - 3 */
+ (&buf[..6], secret, 0xBFCC7CB1B3554DCE), /* 6 - 8 */
+ (&buf[..12], secret, 0x8C50DC90AC9206FC), /* 9 - 16 */
+ (&buf[..24], secret, 0x1CD2C2EE9B9A0928), /* 17 - 32 */
+ (&buf[..48], secret, 0xA785256D9D65D514), /* 33 - 64 */
+ (&buf[..80], secret, 0x6F3053360D21BBB7), /* 65 - 96 */
+ (&buf[..112], secret, 0x560E82D25684154C), /* 97 -128 */
+ (&buf[..195], secret, 0xBA5BDDBC5A767B11), /* 129-240 */
+ (&buf[..403], secret, 0xFC3911BBA656DB58), /* one block, last stripe is overlapping */
+ (&buf[..512], secret, 0x306137DD875741F1), /* one block, finishing at stripe boundary */
+ (&buf[..2048], secret, 0x2836B83880AD3C0C), /* > one block, at least one scrambling */
+ (&buf[..2243], secret, 0x3446E248A00CB44A), /* > one block, at least one scrambling, last stripe unaligned */
+ ];
+
+ for (buf, secret, result) in test_cases {
+ {
+ let hash = hash64_with_secret(buf, secret);
+
+ assert_eq!(
+ hash,
+ result,
+ "hash64_with_secret(&buf[..{}], secret) failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ hash,
+ result
+ );
+ }
+
+ // streaming API test
+
+ // single ingestio
+ {
+ let mut hasher = Hash64::with_secret(secret);
+ hasher.write(buf);
+ let hash = hasher.finish();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..{}]) with secret failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ hash,
+ result
+ );
+ }
+
+ // byte by byte ingestion
+ {
+ let mut hasher = Hash64::with_secret(secret);
+
+ for chunk in buf.chunks(1) {
+ hasher.write(chunk);
+ }
+
+ let hash = hasher.finish();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..{}].chunks(1)) with secret failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ hash,
+ result
+ );
+ }
+ }
+ }
+
+ #[test]
+ fn hash_128bits_sanity_check() {
+ let buf = sanity_buffer();
+
+ let test_cases = vec![
+ (&[][..], 0, 0u64, 0u64), /* zero-length hash is { seed, -seed } by default */
+ (&[][..], PRIME, 0, 0),
+ (&buf[..1], 0, 0x7198D737CFE7F386, 0x3EE70EA338F3F1E8), /* 1-3 */
+ (&buf[..1], PRIME, 0x8E05996EC27C0F46, 0x90DFC659A8BDCC0C), /* 1-3 */
+ (&buf[..6], 0, 0x22CBF5F3E1F6257C, 0xD4E6C2B94FFC3BFA), /* 4-8 */
+ (&buf[..6], PRIME, 0x97B28D3079F8541F, 0xEFC0B954298E6555), /* 4-8 */
+ (&buf[..12], 0, 0x0E0CD01F05AC2F0D, 0x2B55C95951070D4B), /* 9-16 */
+ (&buf[..12], PRIME, 0xA9DE561CA04CDF37, 0x609E31FDC00A43C9), /* 9-16 */
+ (&buf[..24], 0, 0x46796F3F78B20F6B, 0x58FF55C3926C13FA), /* 17-32 */
+ (&buf[..24], PRIME, 0x30D5C4E9EB415C55, 0x8868344B3A4645D0), /* 17-32 */
+ (&buf[..48], 0, 0xD8D4D3590D136E11, 0x5527A42843020A62), /* 33-64 */
+ (&buf[..48], PRIME, 0x1D8834E1A5407A1C, 0x44375B9FB060F541), /* 33-64 */
+ (&buf[..81], 0, 0x4B9B448ED8DFD3DD, 0xE805A6D1A43D70E5), /* 65-96 */
+ (&buf[..81], PRIME, 0xD2D6B075945617BA, 0xE58BE5736F6E7550), /* 65-96 */
+ (&buf[..103], 0, 0xC5A9F97B29EFA44E, 0x254DB7BE881E125C), /* 97-128 */
+ (&buf[..103], PRIME, 0xFA2086367CDB177F, 0x0AEDEA68C988B0C0), /* 97-128 */
+ (&buf[..192], 0, 0xC3142FDDD9102A3F, 0x06F1747E77185F97), /* 129-240 */
+ (&buf[..192], PRIME, 0xA89F07B35987540F, 0xCF1B35FB2C557F54), /* 129-240 */
+ (&buf[..222], 0, 0xA61AC4EB3295F86B, 0x33FA7B7598C28A07), /* 129-240 */
+ (&buf[..222], PRIME, 0x54135EB88AD8B75E, 0xBC45CE6AE50BCF53), /* 129-240 */
+ (&buf[..403], 0, 0xB0C48E6D18E9D084, 0xB16FC17E992FF45D), /* one block, last stripe is overlapping */
+ (&buf[..403], PRIME64, 0x0A1D320C9520871D, 0xCE11CB376EC93252), /* one block, last stripe is overlapping */
+ (&buf[..512], 0, 0xA03428558AC97327, 0x4ECF51281BA406F7), /* one block, finishing at stripe boundary */
+ (&buf[..512], PRIME64, 0xAF67A482D6C893F2, 0x1382D92F25B84D90), /* one block, finishing at stripe boundary */
+ (&buf[..2048], 0, 0x21901B416B3B9863, 0x212AF8E6326F01E0), /* two blocks, finishing at block boundary */
+ (&buf[..2048], PRIME, 0xBDBB2282577DADEC, 0xF78CDDC2C9A9A692), /* two blocks, finishing at block boundary */
+ (&buf[..2240], 0, 0x00AD52FA9385B6FE, 0xC705BAD3356CE302), /* two blocks, ends at stripe boundary */
+ (&buf[..2240], PRIME, 0x10FD0072EC68BFAA, 0xE1312F3458817F15), /* two blocks, ends at stripe boundary */
+ (&buf[..2237], 0, 0x970C91411533862C, 0x4BBD06FF7BFF0AB1), /* two blocks, ends at stripe boundary */
+ (&buf[..2237], PRIME, 0xD80282846D814431, 0x14EBB157B84D9785), /* two blocks, ends at stripe boundary */
+ ];
+
+ for (buf, seed, lo, hi) in test_cases {
+ let result = u128::from(lo) + (u128::from(hi) << 64);
+
+ {
+ let hash = hash128_with_seed(buf, seed);
+
+ assert_eq!(
+ hash,
+ result,
+ "hash128_with_seed(&buf[..{}], seed={}) failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ // streaming API test
+
+ // single ingestio
+ {
+ let mut hasher = Hash128::with_seed(seed);
+ hasher.write(buf);
+ let hash = hasher.finish_ext();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash128::update(&buf[..{}]) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ if buf.len() > 3 {
+ // 2 ingestions
+ let mut hasher = Hash128::with_seed(seed);
+ hasher.write(&buf[..3]);
+ hasher.write(&buf[3..]);
+ let hash = hasher.finish_ext();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..3], &buf[3..{}]) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+
+ // byte by byte ingestion
+ {
+ let mut hasher = Hash128::with_seed(seed);
+
+ for chunk in buf.chunks(1) {
+ hasher.write(chunk);
+ }
+
+ let hash = hasher.finish_ext();
+
+ assert_eq!(
+ hash,
+ result,
+ "Hash64::update(&buf[..{}].chunks(1)) with seed={} failed, got 0x{:X}, expected 0x{:X}",
+ buf.len(),
+ seed,
+ hash,
+ result
+ );
+ }
+ }
+ }
+}
diff --git a/crates/ucd-trie/.cargo-checksum.json b/crates/ucd-trie/.cargo-checksum.json
new file mode 100644
index 0000000..697b264
--- /dev/null
+++ b/crates/ucd-trie/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"d9da2663b8cbd9a49456a610e15a50d3e6e52768edbf72862c9daeb3c6330306","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"0f96a83840e146e43c0ec96a22ec1f392e0680e6c1226e6f3ba87e0740af850f","README.md":"6687ddcfa8075f52ea4326b3caa756165236ff6f75e3379e55ea9f6841821324","benches/bench.rs":"9b74139d17cfcccb502f2abe80b8a4c15a17037a681f27ec914d51e83ea7e55f","src/general_category.rs":"a28d7d49cffda077e505cabe03ea6d5c6fb328a25912a07da08497bfaa992a86","src/lib.rs":"99bedb2b655b39ac3a2cc7b4b79a381f7d1e086a20558eec52968f556a638ec4","src/owned.rs":"b897f815685f597f3a98613d5f8196153a207a741e61bbb19f48f90c2bf594ae"},"package":"ed646292ffc8188ef8ea4d1e0e0150fb15a5c2e12ad9b8fc191ae7a8a7f3c4b9"}
\ No newline at end of file
diff --git a/crates/ucd-trie/Android.bp b/crates/ucd-trie/Android.bp
new file mode 100644
index 0000000..10e2cf9
--- /dev/null
+++ b/crates/ucd-trie/Android.bp
@@ -0,0 +1,28 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_ucd-trie_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_ucd-trie_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library_host {
+ name: "libucd_trie",
+ crate_name: "ucd_trie",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.6",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ features: [
+ "default",
+ "std",
+ ],
+ compile_multilib: "first",
+}
diff --git a/crates/ucd-trie/Cargo.toml b/crates/ucd-trie/Cargo.toml
new file mode 100644
index 0000000..7ac0b52
--- /dev/null
+++ b/crates/ucd-trie/Cargo.toml
@@ -0,0 +1,38 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+name = "ucd-trie"
+version = "0.1.6"
+authors = ["Andrew Gallant <[email protected]>"]
+description = """
+A trie for storing Unicode codepoint sets and maps.
+"""
+homepage = "https://github.com/BurntSushi/ucd-generate"
+documentation = "https://docs.rs/ucd-trie"
+readme = "README.md"
+keywords = [
+ "unicode",
+ "database",
+ "character",
+ "codepoint",
+ "trie",
+]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/BurntSushi/ucd-generate"
+
+[dev-dependencies.once_cell]
+version = "1"
+
+[features]
+default = ["std"]
+std = []
diff --git a/crates/ucd-trie/LICENSE b/crates/ucd-trie/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/ucd-trie/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/ucd-trie/LICENSE-APACHE b/crates/ucd-trie/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/ucd-trie/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/ucd-trie/LICENSE-MIT b/crates/ucd-trie/LICENSE-MIT
new file mode 100644
index 0000000..3b0a5dc
--- /dev/null
+++ b/crates/ucd-trie/LICENSE-MIT
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Andrew Gallant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/crates/ucd-trie/METADATA b/crates/ucd-trie/METADATA
new file mode 100644
index 0000000..fe89487
--- /dev/null
+++ b/crates/ucd-trie/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/ucd-trie
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "ucd-trie"
+description: "A trie for storing Unicode codepoint sets and maps."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 8
+ }
+ homepage: "https://crates.io/crates/ucd-trie"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/ucd-trie/ucd-trie-0.1.6.crate"
+ version: "0.1.6"
+ }
+}
diff --git a/crates/ucd-trie/MODULE_LICENSE_APACHE2 b/crates/ucd-trie/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/ucd-trie/MODULE_LICENSE_APACHE2
diff --git a/crates/ucd-trie/README.md b/crates/ucd-trie/README.md
new file mode 100644
index 0000000..af09793
--- /dev/null
+++ b/crates/ucd-trie/README.md
@@ -0,0 +1,22 @@
+ucd-trie
+========
+A library that provides compressed trie sets specifically tailored toward
+representing boolean Unicode character properties.
+
+[](https://github.com/BurntSushi/ucd-generate/actions)
+[](https://crates.io/crates/ucd-trie)
+
+
+### Documentation
+
+https://docs.rs/ucd-trie
+
+
+### License
+
+This project is licensed under either of
+ * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
+ https://www.apache.org/licenses/LICENSE-2.0)
+ * MIT license ([LICENSE-MIT](LICENSE-MIT) or
+ https://opensource.org/licenses/MIT)
+at your option.
diff --git a/crates/ucd-trie/benches/bench.rs b/crates/ucd-trie/benches/bench.rs
new file mode 100644
index 0000000..edbbefb
--- /dev/null
+++ b/crates/ucd-trie/benches/bench.rs
@@ -0,0 +1,25 @@
+#![feature(test)]
+
+extern crate test;
+
+use once_cell::sync::Lazy;
+use ucd_trie::TrieSetOwned;
+
+#[bench]
+fn bench_trie_set(b: &mut test::Bencher) {
+ const CHARS: &'static [char] = &['a', 'β', '☃', '😼'];
+ // const CHARS: &'static [char] = &['a'];
+ static SET: Lazy<TrieSetOwned> =
+ Lazy::new(|| TrieSetOwned::from_scalars(CHARS).unwrap());
+
+ let set = Lazy::force(&SET);
+ let mut i = 0;
+ b.iter(|| {
+ let c = CHARS[i];
+ i = (i + 1) % CHARS.len();
+
+ for _ in 0..10000 {
+ assert!(set.contains_char(c));
+ }
+ });
+}
diff --git a/crates/ucd-trie/cargo_embargo.json b/crates/ucd-trie/cargo_embargo.json
new file mode 100644
index 0000000..680a89d
--- /dev/null
+++ b/crates/ucd-trie/cargo_embargo.json
@@ -0,0 +1,9 @@
+{
+ "package": {
+ "ucd-trie": {
+ "device_supported": false,
+ "host_first_multilib": true
+ }
+ },
+ "run_cargo": false
+}
diff --git a/crates/ucd-trie/src/general_category.rs b/crates/ucd-trie/src/general_category.rs
new file mode 100644
index 0000000..dbaff3a
--- /dev/null
+++ b/crates/ucd-trie/src/general_category.rs
@@ -0,0 +1,6544 @@
+// DO NOT EDIT THIS FILE. IT WAS AUTOMATICALLY GENERATED BY:
+//
+// ucd-generate general-category ucd-15.0.0
+//
+// Unicode version: 15.0.0.
+//
+// ucd-generate 0.2.15 is available on crates.io.
+
+pub const BY_NAME: &'static [(&'static str, &'static [(u32, u32)])] = &[
+ ("Cased_Letter", CASED_LETTER),
+ ("Close_Punctuation", CLOSE_PUNCTUATION),
+ ("Connector_Punctuation", CONNECTOR_PUNCTUATION),
+ ("Control", CONTROL),
+ ("Currency_Symbol", CURRENCY_SYMBOL),
+ ("Dash_Punctuation", DASH_PUNCTUATION),
+ ("Decimal_Number", DECIMAL_NUMBER),
+ ("Enclosing_Mark", ENCLOSING_MARK),
+ ("Final_Punctuation", FINAL_PUNCTUATION),
+ ("Format", FORMAT),
+ ("Initial_Punctuation", INITIAL_PUNCTUATION),
+ ("Letter", LETTER),
+ ("Letter_Number", LETTER_NUMBER),
+ ("Line_Separator", LINE_SEPARATOR),
+ ("Lowercase_Letter", LOWERCASE_LETTER),
+ ("Mark", MARK),
+ ("Math_Symbol", MATH_SYMBOL),
+ ("Modifier_Letter", MODIFIER_LETTER),
+ ("Modifier_Symbol", MODIFIER_SYMBOL),
+ ("Nonspacing_Mark", NONSPACING_MARK),
+ ("Number", NUMBER),
+ ("Open_Punctuation", OPEN_PUNCTUATION),
+ ("Other", OTHER),
+ ("Other_Letter", OTHER_LETTER),
+ ("Other_Number", OTHER_NUMBER),
+ ("Other_Punctuation", OTHER_PUNCTUATION),
+ ("Other_Symbol", OTHER_SYMBOL),
+ ("Paragraph_Separator", PARAGRAPH_SEPARATOR),
+ ("Private_Use", PRIVATE_USE),
+ ("Punctuation", PUNCTUATION),
+ ("Separator", SEPARATOR),
+ ("Space_Separator", SPACE_SEPARATOR),
+ ("Spacing_Mark", SPACING_MARK),
+ ("Surrogate", SURROGATE),
+ ("Symbol", SYMBOL),
+ ("Titlecase_Letter", TITLECASE_LETTER),
+ ("Unassigned", UNASSIGNED),
+ ("Uppercase_Letter", UPPERCASE_LETTER),
+];
+
+pub const CASED_LETTER: &'static [(u32, u32)] = &[
+ (65, 90),
+ (97, 122),
+ (181, 181),
+ (192, 214),
+ (216, 246),
+ (248, 442),
+ (444, 447),
+ (452, 659),
+ (661, 687),
+ (880, 883),
+ (886, 887),
+ (891, 893),
+ (895, 895),
+ (902, 902),
+ (904, 906),
+ (908, 908),
+ (910, 929),
+ (931, 1013),
+ (1015, 1153),
+ (1162, 1327),
+ (1329, 1366),
+ (1376, 1416),
+ (4256, 4293),
+ (4295, 4295),
+ (4301, 4301),
+ (4304, 4346),
+ (4349, 4351),
+ (5024, 5109),
+ (5112, 5117),
+ (7296, 7304),
+ (7312, 7354),
+ (7357, 7359),
+ (7424, 7467),
+ (7531, 7543),
+ (7545, 7578),
+ (7680, 7957),
+ (7960, 7965),
+ (7968, 8005),
+ (8008, 8013),
+ (8016, 8023),
+ (8025, 8025),
+ (8027, 8027),
+ (8029, 8029),
+ (8031, 8061),
+ (8064, 8116),
+ (8118, 8124),
+ (8126, 8126),
+ (8130, 8132),
+ (8134, 8140),
+ (8144, 8147),
+ (8150, 8155),
+ (8160, 8172),
+ (8178, 8180),
+ (8182, 8188),
+ (8450, 8450),
+ (8455, 8455),
+ (8458, 8467),
+ (8469, 8469),
+ (8473, 8477),
+ (8484, 8484),
+ (8486, 8486),
+ (8488, 8488),
+ (8490, 8493),
+ (8495, 8500),
+ (8505, 8505),
+ (8508, 8511),
+ (8517, 8521),
+ (8526, 8526),
+ (8579, 8580),
+ (11264, 11387),
+ (11390, 11492),
+ (11499, 11502),
+ (11506, 11507),
+ (11520, 11557),
+ (11559, 11559),
+ (11565, 11565),
+ (42560, 42605),
+ (42624, 42651),
+ (42786, 42863),
+ (42865, 42887),
+ (42891, 42894),
+ (42896, 42954),
+ (42960, 42961),
+ (42963, 42963),
+ (42965, 42969),
+ (42997, 42998),
+ (43002, 43002),
+ (43824, 43866),
+ (43872, 43880),
+ (43888, 43967),
+ (64256, 64262),
+ (64275, 64279),
+ (65313, 65338),
+ (65345, 65370),
+ (66560, 66639),
+ (66736, 66771),
+ (66776, 66811),
+ (66928, 66938),
+ (66940, 66954),
+ (66956, 66962),
+ (66964, 66965),
+ (66967, 66977),
+ (66979, 66993),
+ (66995, 67001),
+ (67003, 67004),
+ (68736, 68786),
+ (68800, 68850),
+ (71840, 71903),
+ (93760, 93823),
+ (119808, 119892),
+ (119894, 119964),
+ (119966, 119967),
+ (119970, 119970),
+ (119973, 119974),
+ (119977, 119980),
+ (119982, 119993),
+ (119995, 119995),
+ (119997, 120003),
+ (120005, 120069),
+ (120071, 120074),
+ (120077, 120084),
+ (120086, 120092),
+ (120094, 120121),
+ (120123, 120126),
+ (120128, 120132),
+ (120134, 120134),
+ (120138, 120144),
+ (120146, 120485),
+ (120488, 120512),
+ (120514, 120538),
+ (120540, 120570),
+ (120572, 120596),
+ (120598, 120628),
+ (120630, 120654),
+ (120656, 120686),
+ (120688, 120712),
+ (120714, 120744),
+ (120746, 120770),
+ (120772, 120779),
+ (122624, 122633),
+ (122635, 122654),
+ (122661, 122666),
+ (125184, 125251),
+];
+
+pub const CLOSE_PUNCTUATION: &'static [(u32, u32)] = &[
+ (41, 41),
+ (93, 93),
+ (125, 125),
+ (3899, 3899),
+ (3901, 3901),
+ (5788, 5788),
+ (8262, 8262),
+ (8318, 8318),
+ (8334, 8334),
+ (8969, 8969),
+ (8971, 8971),
+ (9002, 9002),
+ (10089, 10089),
+ (10091, 10091),
+ (10093, 10093),
+ (10095, 10095),
+ (10097, 10097),
+ (10099, 10099),
+ (10101, 10101),
+ (10182, 10182),
+ (10215, 10215),
+ (10217, 10217),
+ (10219, 10219),
+ (10221, 10221),
+ (10223, 10223),
+ (10628, 10628),
+ (10630, 10630),
+ (10632, 10632),
+ (10634, 10634),
+ (10636, 10636),
+ (10638, 10638),
+ (10640, 10640),
+ (10642, 10642),
+ (10644, 10644),
+ (10646, 10646),
+ (10648, 10648),
+ (10713, 10713),
+ (10715, 10715),
+ (10749, 10749),
+ (11811, 11811),
+ (11813, 11813),
+ (11815, 11815),
+ (11817, 11817),
+ (11862, 11862),
+ (11864, 11864),
+ (11866, 11866),
+ (11868, 11868),
+ (12297, 12297),
+ (12299, 12299),
+ (12301, 12301),
+ (12303, 12303),
+ (12305, 12305),
+ (12309, 12309),
+ (12311, 12311),
+ (12313, 12313),
+ (12315, 12315),
+ (12318, 12319),
+ (64830, 64830),
+ (65048, 65048),
+ (65078, 65078),
+ (65080, 65080),
+ (65082, 65082),
+ (65084, 65084),
+ (65086, 65086),
+ (65088, 65088),
+ (65090, 65090),
+ (65092, 65092),
+ (65096, 65096),
+ (65114, 65114),
+ (65116, 65116),
+ (65118, 65118),
+ (65289, 65289),
+ (65341, 65341),
+ (65373, 65373),
+ (65376, 65376),
+ (65379, 65379),
+];
+
+pub const CONNECTOR_PUNCTUATION: &'static [(u32, u32)] = &[
+ (95, 95),
+ (8255, 8256),
+ (8276, 8276),
+ (65075, 65076),
+ (65101, 65103),
+ (65343, 65343),
+];
+
+pub const CONTROL: &'static [(u32, u32)] = &[(0, 31), (127, 159)];
+
+pub const CURRENCY_SYMBOL: &'static [(u32, u32)] = &[
+ (36, 36),
+ (162, 165),
+ (1423, 1423),
+ (1547, 1547),
+ (2046, 2047),
+ (2546, 2547),
+ (2555, 2555),
+ (2801, 2801),
+ (3065, 3065),
+ (3647, 3647),
+ (6107, 6107),
+ (8352, 8384),
+ (43064, 43064),
+ (65020, 65020),
+ (65129, 65129),
+ (65284, 65284),
+ (65504, 65505),
+ (65509, 65510),
+ (73693, 73696),
+ (123647, 123647),
+ (126128, 126128),
+];
+
+pub const DASH_PUNCTUATION: &'static [(u32, u32)] = &[
+ (45, 45),
+ (1418, 1418),
+ (1470, 1470),
+ (5120, 5120),
+ (6150, 6150),
+ (8208, 8213),
+ (11799, 11799),
+ (11802, 11802),
+ (11834, 11835),
+ (11840, 11840),
+ (11869, 11869),
+ (12316, 12316),
+ (12336, 12336),
+ (12448, 12448),
+ (65073, 65074),
+ (65112, 65112),
+ (65123, 65123),
+ (65293, 65293),
+ (69293, 69293),
+];
+
+pub const DECIMAL_NUMBER: &'static [(u32, u32)] = &[
+ (48, 57),
+ (1632, 1641),
+ (1776, 1785),
+ (1984, 1993),
+ (2406, 2415),
+ (2534, 2543),
+ (2662, 2671),
+ (2790, 2799),
+ (2918, 2927),
+ (3046, 3055),
+ (3174, 3183),
+ (3302, 3311),
+ (3430, 3439),
+ (3558, 3567),
+ (3664, 3673),
+ (3792, 3801),
+ (3872, 3881),
+ (4160, 4169),
+ (4240, 4249),
+ (6112, 6121),
+ (6160, 6169),
+ (6470, 6479),
+ (6608, 6617),
+ (6784, 6793),
+ (6800, 6809),
+ (6992, 7001),
+ (7088, 7097),
+ (7232, 7241),
+ (7248, 7257),
+ (42528, 42537),
+ (43216, 43225),
+ (43264, 43273),
+ (43472, 43481),
+ (43504, 43513),
+ (43600, 43609),
+ (44016, 44025),
+ (65296, 65305),
+ (66720, 66729),
+ (68912, 68921),
+ (69734, 69743),
+ (69872, 69881),
+ (69942, 69951),
+ (70096, 70105),
+ (70384, 70393),
+ (70736, 70745),
+ (70864, 70873),
+ (71248, 71257),
+ (71360, 71369),
+ (71472, 71481),
+ (71904, 71913),
+ (72016, 72025),
+ (72784, 72793),
+ (73040, 73049),
+ (73120, 73129),
+ (73552, 73561),
+ (92768, 92777),
+ (92864, 92873),
+ (93008, 93017),
+ (120782, 120831),
+ (123200, 123209),
+ (123632, 123641),
+ (124144, 124153),
+ (125264, 125273),
+ (130032, 130041),
+];
+
+pub const ENCLOSING_MARK: &'static [(u32, u32)] =
+ &[(1160, 1161), (6846, 6846), (8413, 8416), (8418, 8420), (42608, 42610)];
+
+pub const FINAL_PUNCTUATION: &'static [(u32, u32)] = &[
+ (187, 187),
+ (8217, 8217),
+ (8221, 8221),
+ (8250, 8250),
+ (11779, 11779),
+ (11781, 11781),
+ (11786, 11786),
+ (11789, 11789),
+ (11805, 11805),
+ (11809, 11809),
+];
+
+pub const FORMAT: &'static [(u32, u32)] = &[
+ (173, 173),
+ (1536, 1541),
+ (1564, 1564),
+ (1757, 1757),
+ (1807, 1807),
+ (2192, 2193),
+ (2274, 2274),
+ (6158, 6158),
+ (8203, 8207),
+ (8234, 8238),
+ (8288, 8292),
+ (8294, 8303),
+ (65279, 65279),
+ (65529, 65531),
+ (69821, 69821),
+ (69837, 69837),
+ (78896, 78911),
+ (113824, 113827),
+ (119155, 119162),
+ (917505, 917505),
+ (917536, 917631),
+];
+
+pub const INITIAL_PUNCTUATION: &'static [(u32, u32)] = &[
+ (171, 171),
+ (8216, 8216),
+ (8219, 8220),
+ (8223, 8223),
+ (8249, 8249),
+ (11778, 11778),
+ (11780, 11780),
+ (11785, 11785),
+ (11788, 11788),
+ (11804, 11804),
+ (11808, 11808),
+];
+
+pub const LETTER: &'static [(u32, u32)] = &[
+ (65, 90),
+ (97, 122),
+ (170, 170),
+ (181, 181),
+ (186, 186),
+ (192, 214),
+ (216, 246),
+ (248, 705),
+ (710, 721),
+ (736, 740),
+ (748, 748),
+ (750, 750),
+ (880, 884),
+ (886, 887),
+ (890, 893),
+ (895, 895),
+ (902, 902),
+ (904, 906),
+ (908, 908),
+ (910, 929),
+ (931, 1013),
+ (1015, 1153),
+ (1162, 1327),
+ (1329, 1366),
+ (1369, 1369),
+ (1376, 1416),
+ (1488, 1514),
+ (1519, 1522),
+ (1568, 1610),
+ (1646, 1647),
+ (1649, 1747),
+ (1749, 1749),
+ (1765, 1766),
+ (1774, 1775),
+ (1786, 1788),
+ (1791, 1791),
+ (1808, 1808),
+ (1810, 1839),
+ (1869, 1957),
+ (1969, 1969),
+ (1994, 2026),
+ (2036, 2037),
+ (2042, 2042),
+ (2048, 2069),
+ (2074, 2074),
+ (2084, 2084),
+ (2088, 2088),
+ (2112, 2136),
+ (2144, 2154),
+ (2160, 2183),
+ (2185, 2190),
+ (2208, 2249),
+ (2308, 2361),
+ (2365, 2365),
+ (2384, 2384),
+ (2392, 2401),
+ (2417, 2432),
+ (2437, 2444),
+ (2447, 2448),
+ (2451, 2472),
+ (2474, 2480),
+ (2482, 2482),
+ (2486, 2489),
+ (2493, 2493),
+ (2510, 2510),
+ (2524, 2525),
+ (2527, 2529),
+ (2544, 2545),
+ (2556, 2556),
+ (2565, 2570),
+ (2575, 2576),
+ (2579, 2600),
+ (2602, 2608),
+ (2610, 2611),
+ (2613, 2614),
+ (2616, 2617),
+ (2649, 2652),
+ (2654, 2654),
+ (2674, 2676),
+ (2693, 2701),
+ (2703, 2705),
+ (2707, 2728),
+ (2730, 2736),
+ (2738, 2739),
+ (2741, 2745),
+ (2749, 2749),
+ (2768, 2768),
+ (2784, 2785),
+ (2809, 2809),
+ (2821, 2828),
+ (2831, 2832),
+ (2835, 2856),
+ (2858, 2864),
+ (2866, 2867),
+ (2869, 2873),
+ (2877, 2877),
+ (2908, 2909),
+ (2911, 2913),
+ (2929, 2929),
+ (2947, 2947),
+ (2949, 2954),
+ (2958, 2960),
+ (2962, 2965),
+ (2969, 2970),
+ (2972, 2972),
+ (2974, 2975),
+ (2979, 2980),
+ (2984, 2986),
+ (2990, 3001),
+ (3024, 3024),
+ (3077, 3084),
+ (3086, 3088),
+ (3090, 3112),
+ (3114, 3129),
+ (3133, 3133),
+ (3160, 3162),
+ (3165, 3165),
+ (3168, 3169),
+ (3200, 3200),
+ (3205, 3212),
+ (3214, 3216),
+ (3218, 3240),
+ (3242, 3251),
+ (3253, 3257),
+ (3261, 3261),
+ (3293, 3294),
+ (3296, 3297),
+ (3313, 3314),
+ (3332, 3340),
+ (3342, 3344),
+ (3346, 3386),
+ (3389, 3389),
+ (3406, 3406),
+ (3412, 3414),
+ (3423, 3425),
+ (3450, 3455),
+ (3461, 3478),
+ (3482, 3505),
+ (3507, 3515),
+ (3517, 3517),
+ (3520, 3526),
+ (3585, 3632),
+ (3634, 3635),
+ (3648, 3654),
+ (3713, 3714),
+ (3716, 3716),
+ (3718, 3722),
+ (3724, 3747),
+ (3749, 3749),
+ (3751, 3760),
+ (3762, 3763),
+ (3773, 3773),
+ (3776, 3780),
+ (3782, 3782),
+ (3804, 3807),
+ (3840, 3840),
+ (3904, 3911),
+ (3913, 3948),
+ (3976, 3980),
+ (4096, 4138),
+ (4159, 4159),
+ (4176, 4181),
+ (4186, 4189),
+ (4193, 4193),
+ (4197, 4198),
+ (4206, 4208),
+ (4213, 4225),
+ (4238, 4238),
+ (4256, 4293),
+ (4295, 4295),
+ (4301, 4301),
+ (4304, 4346),
+ (4348, 4680),
+ (4682, 4685),
+ (4688, 4694),
+ (4696, 4696),
+ (4698, 4701),
+ (4704, 4744),
+ (4746, 4749),
+ (4752, 4784),
+ (4786, 4789),
+ (4792, 4798),
+ (4800, 4800),
+ (4802, 4805),
+ (4808, 4822),
+ (4824, 4880),
+ (4882, 4885),
+ (4888, 4954),
+ (4992, 5007),
+ (5024, 5109),
+ (5112, 5117),
+ (5121, 5740),
+ (5743, 5759),
+ (5761, 5786),
+ (5792, 5866),
+ (5873, 5880),
+ (5888, 5905),
+ (5919, 5937),
+ (5952, 5969),
+ (5984, 5996),
+ (5998, 6000),
+ (6016, 6067),
+ (6103, 6103),
+ (6108, 6108),
+ (6176, 6264),
+ (6272, 6276),
+ (6279, 6312),
+ (6314, 6314),
+ (6320, 6389),
+ (6400, 6430),
+ (6480, 6509),
+ (6512, 6516),
+ (6528, 6571),
+ (6576, 6601),
+ (6656, 6678),
+ (6688, 6740),
+ (6823, 6823),
+ (6917, 6963),
+ (6981, 6988),
+ (7043, 7072),
+ (7086, 7087),
+ (7098, 7141),
+ (7168, 7203),
+ (7245, 7247),
+ (7258, 7293),
+ (7296, 7304),
+ (7312, 7354),
+ (7357, 7359),
+ (7401, 7404),
+ (7406, 7411),
+ (7413, 7414),
+ (7418, 7418),
+ (7424, 7615),
+ (7680, 7957),
+ (7960, 7965),
+ (7968, 8005),
+ (8008, 8013),
+ (8016, 8023),
+ (8025, 8025),
+ (8027, 8027),
+ (8029, 8029),
+ (8031, 8061),
+ (8064, 8116),
+ (8118, 8124),
+ (8126, 8126),
+ (8130, 8132),
+ (8134, 8140),
+ (8144, 8147),
+ (8150, 8155),
+ (8160, 8172),
+ (8178, 8180),
+ (8182, 8188),
+ (8305, 8305),
+ (8319, 8319),
+ (8336, 8348),
+ (8450, 8450),
+ (8455, 8455),
+ (8458, 8467),
+ (8469, 8469),
+ (8473, 8477),
+ (8484, 8484),
+ (8486, 8486),
+ (8488, 8488),
+ (8490, 8493),
+ (8495, 8505),
+ (8508, 8511),
+ (8517, 8521),
+ (8526, 8526),
+ (8579, 8580),
+ (11264, 11492),
+ (11499, 11502),
+ (11506, 11507),
+ (11520, 11557),
+ (11559, 11559),
+ (11565, 11565),
+ (11568, 11623),
+ (11631, 11631),
+ (11648, 11670),
+ (11680, 11686),
+ (11688, 11694),
+ (11696, 11702),
+ (11704, 11710),
+ (11712, 11718),
+ (11720, 11726),
+ (11728, 11734),
+ (11736, 11742),
+ (11823, 11823),
+ (12293, 12294),
+ (12337, 12341),
+ (12347, 12348),
+ (12353, 12438),
+ (12445, 12447),
+ (12449, 12538),
+ (12540, 12543),
+ (12549, 12591),
+ (12593, 12686),
+ (12704, 12735),
+ (12784, 12799),
+ (13312, 19903),
+ (19968, 42124),
+ (42192, 42237),
+ (42240, 42508),
+ (42512, 42527),
+ (42538, 42539),
+ (42560, 42606),
+ (42623, 42653),
+ (42656, 42725),
+ (42775, 42783),
+ (42786, 42888),
+ (42891, 42954),
+ (42960, 42961),
+ (42963, 42963),
+ (42965, 42969),
+ (42994, 43009),
+ (43011, 43013),
+ (43015, 43018),
+ (43020, 43042),
+ (43072, 43123),
+ (43138, 43187),
+ (43250, 43255),
+ (43259, 43259),
+ (43261, 43262),
+ (43274, 43301),
+ (43312, 43334),
+ (43360, 43388),
+ (43396, 43442),
+ (43471, 43471),
+ (43488, 43492),
+ (43494, 43503),
+ (43514, 43518),
+ (43520, 43560),
+ (43584, 43586),
+ (43588, 43595),
+ (43616, 43638),
+ (43642, 43642),
+ (43646, 43695),
+ (43697, 43697),
+ (43701, 43702),
+ (43705, 43709),
+ (43712, 43712),
+ (43714, 43714),
+ (43739, 43741),
+ (43744, 43754),
+ (43762, 43764),
+ (43777, 43782),
+ (43785, 43790),
+ (43793, 43798),
+ (43808, 43814),
+ (43816, 43822),
+ (43824, 43866),
+ (43868, 43881),
+ (43888, 44002),
+ (44032, 55203),
+ (55216, 55238),
+ (55243, 55291),
+ (63744, 64109),
+ (64112, 64217),
+ (64256, 64262),
+ (64275, 64279),
+ (64285, 64285),
+ (64287, 64296),
+ (64298, 64310),
+ (64312, 64316),
+ (64318, 64318),
+ (64320, 64321),
+ (64323, 64324),
+ (64326, 64433),
+ (64467, 64829),
+ (64848, 64911),
+ (64914, 64967),
+ (65008, 65019),
+ (65136, 65140),
+ (65142, 65276),
+ (65313, 65338),
+ (65345, 65370),
+ (65382, 65470),
+ (65474, 65479),
+ (65482, 65487),
+ (65490, 65495),
+ (65498, 65500),
+ (65536, 65547),
+ (65549, 65574),
+ (65576, 65594),
+ (65596, 65597),
+ (65599, 65613),
+ (65616, 65629),
+ (65664, 65786),
+ (66176, 66204),
+ (66208, 66256),
+ (66304, 66335),
+ (66349, 66368),
+ (66370, 66377),
+ (66384, 66421),
+ (66432, 66461),
+ (66464, 66499),
+ (66504, 66511),
+ (66560, 66717),
+ (66736, 66771),
+ (66776, 66811),
+ (66816, 66855),
+ (66864, 66915),
+ (66928, 66938),
+ (66940, 66954),
+ (66956, 66962),
+ (66964, 66965),
+ (66967, 66977),
+ (66979, 66993),
+ (66995, 67001),
+ (67003, 67004),
+ (67072, 67382),
+ (67392, 67413),
+ (67424, 67431),
+ (67456, 67461),
+ (67463, 67504),
+ (67506, 67514),
+ (67584, 67589),
+ (67592, 67592),
+ (67594, 67637),
+ (67639, 67640),
+ (67644, 67644),
+ (67647, 67669),
+ (67680, 67702),
+ (67712, 67742),
+ (67808, 67826),
+ (67828, 67829),
+ (67840, 67861),
+ (67872, 67897),
+ (67968, 68023),
+ (68030, 68031),
+ (68096, 68096),
+ (68112, 68115),
+ (68117, 68119),
+ (68121, 68149),
+ (68192, 68220),
+ (68224, 68252),
+ (68288, 68295),
+ (68297, 68324),
+ (68352, 68405),
+ (68416, 68437),
+ (68448, 68466),
+ (68480, 68497),
+ (68608, 68680),
+ (68736, 68786),
+ (68800, 68850),
+ (68864, 68899),
+ (69248, 69289),
+ (69296, 69297),
+ (69376, 69404),
+ (69415, 69415),
+ (69424, 69445),
+ (69488, 69505),
+ (69552, 69572),
+ (69600, 69622),
+ (69635, 69687),
+ (69745, 69746),
+ (69749, 69749),
+ (69763, 69807),
+ (69840, 69864),
+ (69891, 69926),
+ (69956, 69956),
+ (69959, 69959),
+ (69968, 70002),
+ (70006, 70006),
+ (70019, 70066),
+ (70081, 70084),
+ (70106, 70106),
+ (70108, 70108),
+ (70144, 70161),
+ (70163, 70187),
+ (70207, 70208),
+ (70272, 70278),
+ (70280, 70280),
+ (70282, 70285),
+ (70287, 70301),
+ (70303, 70312),
+ (70320, 70366),
+ (70405, 70412),
+ (70415, 70416),
+ (70419, 70440),
+ (70442, 70448),
+ (70450, 70451),
+ (70453, 70457),
+ (70461, 70461),
+ (70480, 70480),
+ (70493, 70497),
+ (70656, 70708),
+ (70727, 70730),
+ (70751, 70753),
+ (70784, 70831),
+ (70852, 70853),
+ (70855, 70855),
+ (71040, 71086),
+ (71128, 71131),
+ (71168, 71215),
+ (71236, 71236),
+ (71296, 71338),
+ (71352, 71352),
+ (71424, 71450),
+ (71488, 71494),
+ (71680, 71723),
+ (71840, 71903),
+ (71935, 71942),
+ (71945, 71945),
+ (71948, 71955),
+ (71957, 71958),
+ (71960, 71983),
+ (71999, 71999),
+ (72001, 72001),
+ (72096, 72103),
+ (72106, 72144),
+ (72161, 72161),
+ (72163, 72163),
+ (72192, 72192),
+ (72203, 72242),
+ (72250, 72250),
+ (72272, 72272),
+ (72284, 72329),
+ (72349, 72349),
+ (72368, 72440),
+ (72704, 72712),
+ (72714, 72750),
+ (72768, 72768),
+ (72818, 72847),
+ (72960, 72966),
+ (72968, 72969),
+ (72971, 73008),
+ (73030, 73030),
+ (73056, 73061),
+ (73063, 73064),
+ (73066, 73097),
+ (73112, 73112),
+ (73440, 73458),
+ (73474, 73474),
+ (73476, 73488),
+ (73490, 73523),
+ (73648, 73648),
+ (73728, 74649),
+ (74880, 75075),
+ (77712, 77808),
+ (77824, 78895),
+ (78913, 78918),
+ (82944, 83526),
+ (92160, 92728),
+ (92736, 92766),
+ (92784, 92862),
+ (92880, 92909),
+ (92928, 92975),
+ (92992, 92995),
+ (93027, 93047),
+ (93053, 93071),
+ (93760, 93823),
+ (93952, 94026),
+ (94032, 94032),
+ (94099, 94111),
+ (94176, 94177),
+ (94179, 94179),
+ (94208, 100343),
+ (100352, 101589),
+ (101632, 101640),
+ (110576, 110579),
+ (110581, 110587),
+ (110589, 110590),
+ (110592, 110882),
+ (110898, 110898),
+ (110928, 110930),
+ (110933, 110933),
+ (110948, 110951),
+ (110960, 111355),
+ (113664, 113770),
+ (113776, 113788),
+ (113792, 113800),
+ (113808, 113817),
+ (119808, 119892),
+ (119894, 119964),
+ (119966, 119967),
+ (119970, 119970),
+ (119973, 119974),
+ (119977, 119980),
+ (119982, 119993),
+ (119995, 119995),
+ (119997, 120003),
+ (120005, 120069),
+ (120071, 120074),
+ (120077, 120084),
+ (120086, 120092),
+ (120094, 120121),
+ (120123, 120126),
+ (120128, 120132),
+ (120134, 120134),
+ (120138, 120144),
+ (120146, 120485),
+ (120488, 120512),
+ (120514, 120538),
+ (120540, 120570),
+ (120572, 120596),
+ (120598, 120628),
+ (120630, 120654),
+ (120656, 120686),
+ (120688, 120712),
+ (120714, 120744),
+ (120746, 120770),
+ (120772, 120779),
+ (122624, 122654),
+ (122661, 122666),
+ (122928, 122989),
+ (123136, 123180),
+ (123191, 123197),
+ (123214, 123214),
+ (123536, 123565),
+ (123584, 123627),
+ (124112, 124139),
+ (124896, 124902),
+ (124904, 124907),
+ (124909, 124910),
+ (124912, 124926),
+ (124928, 125124),
+ (125184, 125251),
+ (125259, 125259),
+ (126464, 126467),
+ (126469, 126495),
+ (126497, 126498),
+ (126500, 126500),
+ (126503, 126503),
+ (126505, 126514),
+ (126516, 126519),
+ (126521, 126521),
+ (126523, 126523),
+ (126530, 126530),
+ (126535, 126535),
+ (126537, 126537),
+ (126539, 126539),
+ (126541, 126543),
+ (126545, 126546),
+ (126548, 126548),
+ (126551, 126551),
+ (126553, 126553),
+ (126555, 126555),
+ (126557, 126557),
+ (126559, 126559),
+ (126561, 126562),
+ (126564, 126564),
+ (126567, 126570),
+ (126572, 126578),
+ (126580, 126583),
+ (126585, 126588),
+ (126590, 126590),
+ (126592, 126601),
+ (126603, 126619),
+ (126625, 126627),
+ (126629, 126633),
+ (126635, 126651),
+ (131072, 173791),
+ (173824, 177977),
+ (177984, 178205),
+ (178208, 183969),
+ (183984, 191456),
+ (194560, 195101),
+ (196608, 201546),
+ (201552, 205743),
+];
+
+pub const LETTER_NUMBER: &'static [(u32, u32)] = &[
+ (5870, 5872),
+ (8544, 8578),
+ (8581, 8584),
+ (12295, 12295),
+ (12321, 12329),
+ (12344, 12346),
+ (42726, 42735),
+ (65856, 65908),
+ (66369, 66369),
+ (66378, 66378),
+ (66513, 66517),
+ (74752, 74862),
+];
+
+pub const LINE_SEPARATOR: &'static [(u32, u32)] = &[(8232, 8232)];
+
+pub const LOWERCASE_LETTER: &'static [(u32, u32)] = &[
+ (97, 122),
+ (181, 181),
+ (223, 246),
+ (248, 255),
+ (257, 257),
+ (259, 259),
+ (261, 261),
+ (263, 263),
+ (265, 265),
+ (267, 267),
+ (269, 269),
+ (271, 271),
+ (273, 273),
+ (275, 275),
+ (277, 277),
+ (279, 279),
+ (281, 281),
+ (283, 283),
+ (285, 285),
+ (287, 287),
+ (289, 289),
+ (291, 291),
+ (293, 293),
+ (295, 295),
+ (297, 297),
+ (299, 299),
+ (301, 301),
+ (303, 303),
+ (305, 305),
+ (307, 307),
+ (309, 309),
+ (311, 312),
+ (314, 314),
+ (316, 316),
+ (318, 318),
+ (320, 320),
+ (322, 322),
+ (324, 324),
+ (326, 326),
+ (328, 329),
+ (331, 331),
+ (333, 333),
+ (335, 335),
+ (337, 337),
+ (339, 339),
+ (341, 341),
+ (343, 343),
+ (345, 345),
+ (347, 347),
+ (349, 349),
+ (351, 351),
+ (353, 353),
+ (355, 355),
+ (357, 357),
+ (359, 359),
+ (361, 361),
+ (363, 363),
+ (365, 365),
+ (367, 367),
+ (369, 369),
+ (371, 371),
+ (373, 373),
+ (375, 375),
+ (378, 378),
+ (380, 380),
+ (382, 384),
+ (387, 387),
+ (389, 389),
+ (392, 392),
+ (396, 397),
+ (402, 402),
+ (405, 405),
+ (409, 411),
+ (414, 414),
+ (417, 417),
+ (419, 419),
+ (421, 421),
+ (424, 424),
+ (426, 427),
+ (429, 429),
+ (432, 432),
+ (436, 436),
+ (438, 438),
+ (441, 442),
+ (445, 447),
+ (454, 454),
+ (457, 457),
+ (460, 460),
+ (462, 462),
+ (464, 464),
+ (466, 466),
+ (468, 468),
+ (470, 470),
+ (472, 472),
+ (474, 474),
+ (476, 477),
+ (479, 479),
+ (481, 481),
+ (483, 483),
+ (485, 485),
+ (487, 487),
+ (489, 489),
+ (491, 491),
+ (493, 493),
+ (495, 496),
+ (499, 499),
+ (501, 501),
+ (505, 505),
+ (507, 507),
+ (509, 509),
+ (511, 511),
+ (513, 513),
+ (515, 515),
+ (517, 517),
+ (519, 519),
+ (521, 521),
+ (523, 523),
+ (525, 525),
+ (527, 527),
+ (529, 529),
+ (531, 531),
+ (533, 533),
+ (535, 535),
+ (537, 537),
+ (539, 539),
+ (541, 541),
+ (543, 543),
+ (545, 545),
+ (547, 547),
+ (549, 549),
+ (551, 551),
+ (553, 553),
+ (555, 555),
+ (557, 557),
+ (559, 559),
+ (561, 561),
+ (563, 569),
+ (572, 572),
+ (575, 576),
+ (578, 578),
+ (583, 583),
+ (585, 585),
+ (587, 587),
+ (589, 589),
+ (591, 659),
+ (661, 687),
+ (881, 881),
+ (883, 883),
+ (887, 887),
+ (891, 893),
+ (912, 912),
+ (940, 974),
+ (976, 977),
+ (981, 983),
+ (985, 985),
+ (987, 987),
+ (989, 989),
+ (991, 991),
+ (993, 993),
+ (995, 995),
+ (997, 997),
+ (999, 999),
+ (1001, 1001),
+ (1003, 1003),
+ (1005, 1005),
+ (1007, 1011),
+ (1013, 1013),
+ (1016, 1016),
+ (1019, 1020),
+ (1072, 1119),
+ (1121, 1121),
+ (1123, 1123),
+ (1125, 1125),
+ (1127, 1127),
+ (1129, 1129),
+ (1131, 1131),
+ (1133, 1133),
+ (1135, 1135),
+ (1137, 1137),
+ (1139, 1139),
+ (1141, 1141),
+ (1143, 1143),
+ (1145, 1145),
+ (1147, 1147),
+ (1149, 1149),
+ (1151, 1151),
+ (1153, 1153),
+ (1163, 1163),
+ (1165, 1165),
+ (1167, 1167),
+ (1169, 1169),
+ (1171, 1171),
+ (1173, 1173),
+ (1175, 1175),
+ (1177, 1177),
+ (1179, 1179),
+ (1181, 1181),
+ (1183, 1183),
+ (1185, 1185),
+ (1187, 1187),
+ (1189, 1189),
+ (1191, 1191),
+ (1193, 1193),
+ (1195, 1195),
+ (1197, 1197),
+ (1199, 1199),
+ (1201, 1201),
+ (1203, 1203),
+ (1205, 1205),
+ (1207, 1207),
+ (1209, 1209),
+ (1211, 1211),
+ (1213, 1213),
+ (1215, 1215),
+ (1218, 1218),
+ (1220, 1220),
+ (1222, 1222),
+ (1224, 1224),
+ (1226, 1226),
+ (1228, 1228),
+ (1230, 1231),
+ (1233, 1233),
+ (1235, 1235),
+ (1237, 1237),
+ (1239, 1239),
+ (1241, 1241),
+ (1243, 1243),
+ (1245, 1245),
+ (1247, 1247),
+ (1249, 1249),
+ (1251, 1251),
+ (1253, 1253),
+ (1255, 1255),
+ (1257, 1257),
+ (1259, 1259),
+ (1261, 1261),
+ (1263, 1263),
+ (1265, 1265),
+ (1267, 1267),
+ (1269, 1269),
+ (1271, 1271),
+ (1273, 1273),
+ (1275, 1275),
+ (1277, 1277),
+ (1279, 1279),
+ (1281, 1281),
+ (1283, 1283),
+ (1285, 1285),
+ (1287, 1287),
+ (1289, 1289),
+ (1291, 1291),
+ (1293, 1293),
+ (1295, 1295),
+ (1297, 1297),
+ (1299, 1299),
+ (1301, 1301),
+ (1303, 1303),
+ (1305, 1305),
+ (1307, 1307),
+ (1309, 1309),
+ (1311, 1311),
+ (1313, 1313),
+ (1315, 1315),
+ (1317, 1317),
+ (1319, 1319),
+ (1321, 1321),
+ (1323, 1323),
+ (1325, 1325),
+ (1327, 1327),
+ (1376, 1416),
+ (4304, 4346),
+ (4349, 4351),
+ (5112, 5117),
+ (7296, 7304),
+ (7424, 7467),
+ (7531, 7543),
+ (7545, 7578),
+ (7681, 7681),
+ (7683, 7683),
+ (7685, 7685),
+ (7687, 7687),
+ (7689, 7689),
+ (7691, 7691),
+ (7693, 7693),
+ (7695, 7695),
+ (7697, 7697),
+ (7699, 7699),
+ (7701, 7701),
+ (7703, 7703),
+ (7705, 7705),
+ (7707, 7707),
+ (7709, 7709),
+ (7711, 7711),
+ (7713, 7713),
+ (7715, 7715),
+ (7717, 7717),
+ (7719, 7719),
+ (7721, 7721),
+ (7723, 7723),
+ (7725, 7725),
+ (7727, 7727),
+ (7729, 7729),
+ (7731, 7731),
+ (7733, 7733),
+ (7735, 7735),
+ (7737, 7737),
+ (7739, 7739),
+ (7741, 7741),
+ (7743, 7743),
+ (7745, 7745),
+ (7747, 7747),
+ (7749, 7749),
+ (7751, 7751),
+ (7753, 7753),
+ (7755, 7755),
+ (7757, 7757),
+ (7759, 7759),
+ (7761, 7761),
+ (7763, 7763),
+ (7765, 7765),
+ (7767, 7767),
+ (7769, 7769),
+ (7771, 7771),
+ (7773, 7773),
+ (7775, 7775),
+ (7777, 7777),
+ (7779, 7779),
+ (7781, 7781),
+ (7783, 7783),
+ (7785, 7785),
+ (7787, 7787),
+ (7789, 7789),
+ (7791, 7791),
+ (7793, 7793),
+ (7795, 7795),
+ (7797, 7797),
+ (7799, 7799),
+ (7801, 7801),
+ (7803, 7803),
+ (7805, 7805),
+ (7807, 7807),
+ (7809, 7809),
+ (7811, 7811),
+ (7813, 7813),
+ (7815, 7815),
+ (7817, 7817),
+ (7819, 7819),
+ (7821, 7821),
+ (7823, 7823),
+ (7825, 7825),
+ (7827, 7827),
+ (7829, 7837),
+ (7839, 7839),
+ (7841, 7841),
+ (7843, 7843),
+ (7845, 7845),
+ (7847, 7847),
+ (7849, 7849),
+ (7851, 7851),
+ (7853, 7853),
+ (7855, 7855),
+ (7857, 7857),
+ (7859, 7859),
+ (7861, 7861),
+ (7863, 7863),
+ (7865, 7865),
+ (7867, 7867),
+ (7869, 7869),
+ (7871, 7871),
+ (7873, 7873),
+ (7875, 7875),
+ (7877, 7877),
+ (7879, 7879),
+ (7881, 7881),
+ (7883, 7883),
+ (7885, 7885),
+ (7887, 7887),
+ (7889, 7889),
+ (7891, 7891),
+ (7893, 7893),
+ (7895, 7895),
+ (7897, 7897),
+ (7899, 7899),
+ (7901, 7901),
+ (7903, 7903),
+ (7905, 7905),
+ (7907, 7907),
+ (7909, 7909),
+ (7911, 7911),
+ (7913, 7913),
+ (7915, 7915),
+ (7917, 7917),
+ (7919, 7919),
+ (7921, 7921),
+ (7923, 7923),
+ (7925, 7925),
+ (7927, 7927),
+ (7929, 7929),
+ (7931, 7931),
+ (7933, 7933),
+ (7935, 7943),
+ (7952, 7957),
+ (7968, 7975),
+ (7984, 7991),
+ (8000, 8005),
+ (8016, 8023),
+ (8032, 8039),
+ (8048, 8061),
+ (8064, 8071),
+ (8080, 8087),
+ (8096, 8103),
+ (8112, 8116),
+ (8118, 8119),
+ (8126, 8126),
+ (8130, 8132),
+ (8134, 8135),
+ (8144, 8147),
+ (8150, 8151),
+ (8160, 8167),
+ (8178, 8180),
+ (8182, 8183),
+ (8458, 8458),
+ (8462, 8463),
+ (8467, 8467),
+ (8495, 8495),
+ (8500, 8500),
+ (8505, 8505),
+ (8508, 8509),
+ (8518, 8521),
+ (8526, 8526),
+ (8580, 8580),
+ (11312, 11359),
+ (11361, 11361),
+ (11365, 11366),
+ (11368, 11368),
+ (11370, 11370),
+ (11372, 11372),
+ (11377, 11377),
+ (11379, 11380),
+ (11382, 11387),
+ (11393, 11393),
+ (11395, 11395),
+ (11397, 11397),
+ (11399, 11399),
+ (11401, 11401),
+ (11403, 11403),
+ (11405, 11405),
+ (11407, 11407),
+ (11409, 11409),
+ (11411, 11411),
+ (11413, 11413),
+ (11415, 11415),
+ (11417, 11417),
+ (11419, 11419),
+ (11421, 11421),
+ (11423, 11423),
+ (11425, 11425),
+ (11427, 11427),
+ (11429, 11429),
+ (11431, 11431),
+ (11433, 11433),
+ (11435, 11435),
+ (11437, 11437),
+ (11439, 11439),
+ (11441, 11441),
+ (11443, 11443),
+ (11445, 11445),
+ (11447, 11447),
+ (11449, 11449),
+ (11451, 11451),
+ (11453, 11453),
+ (11455, 11455),
+ (11457, 11457),
+ (11459, 11459),
+ (11461, 11461),
+ (11463, 11463),
+ (11465, 11465),
+ (11467, 11467),
+ (11469, 11469),
+ (11471, 11471),
+ (11473, 11473),
+ (11475, 11475),
+ (11477, 11477),
+ (11479, 11479),
+ (11481, 11481),
+ (11483, 11483),
+ (11485, 11485),
+ (11487, 11487),
+ (11489, 11489),
+ (11491, 11492),
+ (11500, 11500),
+ (11502, 11502),
+ (11507, 11507),
+ (11520, 11557),
+ (11559, 11559),
+ (11565, 11565),
+ (42561, 42561),
+ (42563, 42563),
+ (42565, 42565),
+ (42567, 42567),
+ (42569, 42569),
+ (42571, 42571),
+ (42573, 42573),
+ (42575, 42575),
+ (42577, 42577),
+ (42579, 42579),
+ (42581, 42581),
+ (42583, 42583),
+ (42585, 42585),
+ (42587, 42587),
+ (42589, 42589),
+ (42591, 42591),
+ (42593, 42593),
+ (42595, 42595),
+ (42597, 42597),
+ (42599, 42599),
+ (42601, 42601),
+ (42603, 42603),
+ (42605, 42605),
+ (42625, 42625),
+ (42627, 42627),
+ (42629, 42629),
+ (42631, 42631),
+ (42633, 42633),
+ (42635, 42635),
+ (42637, 42637),
+ (42639, 42639),
+ (42641, 42641),
+ (42643, 42643),
+ (42645, 42645),
+ (42647, 42647),
+ (42649, 42649),
+ (42651, 42651),
+ (42787, 42787),
+ (42789, 42789),
+ (42791, 42791),
+ (42793, 42793),
+ (42795, 42795),
+ (42797, 42797),
+ (42799, 42801),
+ (42803, 42803),
+ (42805, 42805),
+ (42807, 42807),
+ (42809, 42809),
+ (42811, 42811),
+ (42813, 42813),
+ (42815, 42815),
+ (42817, 42817),
+ (42819, 42819),
+ (42821, 42821),
+ (42823, 42823),
+ (42825, 42825),
+ (42827, 42827),
+ (42829, 42829),
+ (42831, 42831),
+ (42833, 42833),
+ (42835, 42835),
+ (42837, 42837),
+ (42839, 42839),
+ (42841, 42841),
+ (42843, 42843),
+ (42845, 42845),
+ (42847, 42847),
+ (42849, 42849),
+ (42851, 42851),
+ (42853, 42853),
+ (42855, 42855),
+ (42857, 42857),
+ (42859, 42859),
+ (42861, 42861),
+ (42863, 42863),
+ (42865, 42872),
+ (42874, 42874),
+ (42876, 42876),
+ (42879, 42879),
+ (42881, 42881),
+ (42883, 42883),
+ (42885, 42885),
+ (42887, 42887),
+ (42892, 42892),
+ (42894, 42894),
+ (42897, 42897),
+ (42899, 42901),
+ (42903, 42903),
+ (42905, 42905),
+ (42907, 42907),
+ (42909, 42909),
+ (42911, 42911),
+ (42913, 42913),
+ (42915, 42915),
+ (42917, 42917),
+ (42919, 42919),
+ (42921, 42921),
+ (42927, 42927),
+ (42933, 42933),
+ (42935, 42935),
+ (42937, 42937),
+ (42939, 42939),
+ (42941, 42941),
+ (42943, 42943),
+ (42945, 42945),
+ (42947, 42947),
+ (42952, 42952),
+ (42954, 42954),
+ (42961, 42961),
+ (42963, 42963),
+ (42965, 42965),
+ (42967, 42967),
+ (42969, 42969),
+ (42998, 42998),
+ (43002, 43002),
+ (43824, 43866),
+ (43872, 43880),
+ (43888, 43967),
+ (64256, 64262),
+ (64275, 64279),
+ (65345, 65370),
+ (66600, 66639),
+ (66776, 66811),
+ (66967, 66977),
+ (66979, 66993),
+ (66995, 67001),
+ (67003, 67004),
+ (68800, 68850),
+ (71872, 71903),
+ (93792, 93823),
+ (119834, 119859),
+ (119886, 119892),
+ (119894, 119911),
+ (119938, 119963),
+ (119990, 119993),
+ (119995, 119995),
+ (119997, 120003),
+ (120005, 120015),
+ (120042, 120067),
+ (120094, 120119),
+ (120146, 120171),
+ (120198, 120223),
+ (120250, 120275),
+ (120302, 120327),
+ (120354, 120379),
+ (120406, 120431),
+ (120458, 120485),
+ (120514, 120538),
+ (120540, 120545),
+ (120572, 120596),
+ (120598, 120603),
+ (120630, 120654),
+ (120656, 120661),
+ (120688, 120712),
+ (120714, 120719),
+ (120746, 120770),
+ (120772, 120777),
+ (120779, 120779),
+ (122624, 122633),
+ (122635, 122654),
+ (122661, 122666),
+ (125218, 125251),
+];
+
+pub const MARK: &'static [(u32, u32)] = &[
+ (768, 879),
+ (1155, 1161),
+ (1425, 1469),
+ (1471, 1471),
+ (1473, 1474),
+ (1476, 1477),
+ (1479, 1479),
+ (1552, 1562),
+ (1611, 1631),
+ (1648, 1648),
+ (1750, 1756),
+ (1759, 1764),
+ (1767, 1768),
+ (1770, 1773),
+ (1809, 1809),
+ (1840, 1866),
+ (1958, 1968),
+ (2027, 2035),
+ (2045, 2045),
+ (2070, 2073),
+ (2075, 2083),
+ (2085, 2087),
+ (2089, 2093),
+ (2137, 2139),
+ (2200, 2207),
+ (2250, 2273),
+ (2275, 2307),
+ (2362, 2364),
+ (2366, 2383),
+ (2385, 2391),
+ (2402, 2403),
+ (2433, 2435),
+ (2492, 2492),
+ (2494, 2500),
+ (2503, 2504),
+ (2507, 2509),
+ (2519, 2519),
+ (2530, 2531),
+ (2558, 2558),
+ (2561, 2563),
+ (2620, 2620),
+ (2622, 2626),
+ (2631, 2632),
+ (2635, 2637),
+ (2641, 2641),
+ (2672, 2673),
+ (2677, 2677),
+ (2689, 2691),
+ (2748, 2748),
+ (2750, 2757),
+ (2759, 2761),
+ (2763, 2765),
+ (2786, 2787),
+ (2810, 2815),
+ (2817, 2819),
+ (2876, 2876),
+ (2878, 2884),
+ (2887, 2888),
+ (2891, 2893),
+ (2901, 2903),
+ (2914, 2915),
+ (2946, 2946),
+ (3006, 3010),
+ (3014, 3016),
+ (3018, 3021),
+ (3031, 3031),
+ (3072, 3076),
+ (3132, 3132),
+ (3134, 3140),
+ (3142, 3144),
+ (3146, 3149),
+ (3157, 3158),
+ (3170, 3171),
+ (3201, 3203),
+ (3260, 3260),
+ (3262, 3268),
+ (3270, 3272),
+ (3274, 3277),
+ (3285, 3286),
+ (3298, 3299),
+ (3315, 3315),
+ (3328, 3331),
+ (3387, 3388),
+ (3390, 3396),
+ (3398, 3400),
+ (3402, 3405),
+ (3415, 3415),
+ (3426, 3427),
+ (3457, 3459),
+ (3530, 3530),
+ (3535, 3540),
+ (3542, 3542),
+ (3544, 3551),
+ (3570, 3571),
+ (3633, 3633),
+ (3636, 3642),
+ (3655, 3662),
+ (3761, 3761),
+ (3764, 3772),
+ (3784, 3790),
+ (3864, 3865),
+ (3893, 3893),
+ (3895, 3895),
+ (3897, 3897),
+ (3902, 3903),
+ (3953, 3972),
+ (3974, 3975),
+ (3981, 3991),
+ (3993, 4028),
+ (4038, 4038),
+ (4139, 4158),
+ (4182, 4185),
+ (4190, 4192),
+ (4194, 4196),
+ (4199, 4205),
+ (4209, 4212),
+ (4226, 4237),
+ (4239, 4239),
+ (4250, 4253),
+ (4957, 4959),
+ (5906, 5909),
+ (5938, 5940),
+ (5970, 5971),
+ (6002, 6003),
+ (6068, 6099),
+ (6109, 6109),
+ (6155, 6157),
+ (6159, 6159),
+ (6277, 6278),
+ (6313, 6313),
+ (6432, 6443),
+ (6448, 6459),
+ (6679, 6683),
+ (6741, 6750),
+ (6752, 6780),
+ (6783, 6783),
+ (6832, 6862),
+ (6912, 6916),
+ (6964, 6980),
+ (7019, 7027),
+ (7040, 7042),
+ (7073, 7085),
+ (7142, 7155),
+ (7204, 7223),
+ (7376, 7378),
+ (7380, 7400),
+ (7405, 7405),
+ (7412, 7412),
+ (7415, 7417),
+ (7616, 7679),
+ (8400, 8432),
+ (11503, 11505),
+ (11647, 11647),
+ (11744, 11775),
+ (12330, 12335),
+ (12441, 12442),
+ (42607, 42610),
+ (42612, 42621),
+ (42654, 42655),
+ (42736, 42737),
+ (43010, 43010),
+ (43014, 43014),
+ (43019, 43019),
+ (43043, 43047),
+ (43052, 43052),
+ (43136, 43137),
+ (43188, 43205),
+ (43232, 43249),
+ (43263, 43263),
+ (43302, 43309),
+ (43335, 43347),
+ (43392, 43395),
+ (43443, 43456),
+ (43493, 43493),
+ (43561, 43574),
+ (43587, 43587),
+ (43596, 43597),
+ (43643, 43645),
+ (43696, 43696),
+ (43698, 43700),
+ (43703, 43704),
+ (43710, 43711),
+ (43713, 43713),
+ (43755, 43759),
+ (43765, 43766),
+ (44003, 44010),
+ (44012, 44013),
+ (64286, 64286),
+ (65024, 65039),
+ (65056, 65071),
+ (66045, 66045),
+ (66272, 66272),
+ (66422, 66426),
+ (68097, 68099),
+ (68101, 68102),
+ (68108, 68111),
+ (68152, 68154),
+ (68159, 68159),
+ (68325, 68326),
+ (68900, 68903),
+ (69291, 69292),
+ (69373, 69375),
+ (69446, 69456),
+ (69506, 69509),
+ (69632, 69634),
+ (69688, 69702),
+ (69744, 69744),
+ (69747, 69748),
+ (69759, 69762),
+ (69808, 69818),
+ (69826, 69826),
+ (69888, 69890),
+ (69927, 69940),
+ (69957, 69958),
+ (70003, 70003),
+ (70016, 70018),
+ (70067, 70080),
+ (70089, 70092),
+ (70094, 70095),
+ (70188, 70199),
+ (70206, 70206),
+ (70209, 70209),
+ (70367, 70378),
+ (70400, 70403),
+ (70459, 70460),
+ (70462, 70468),
+ (70471, 70472),
+ (70475, 70477),
+ (70487, 70487),
+ (70498, 70499),
+ (70502, 70508),
+ (70512, 70516),
+ (70709, 70726),
+ (70750, 70750),
+ (70832, 70851),
+ (71087, 71093),
+ (71096, 71104),
+ (71132, 71133),
+ (71216, 71232),
+ (71339, 71351),
+ (71453, 71467),
+ (71724, 71738),
+ (71984, 71989),
+ (71991, 71992),
+ (71995, 71998),
+ (72000, 72000),
+ (72002, 72003),
+ (72145, 72151),
+ (72154, 72160),
+ (72164, 72164),
+ (72193, 72202),
+ (72243, 72249),
+ (72251, 72254),
+ (72263, 72263),
+ (72273, 72283),
+ (72330, 72345),
+ (72751, 72758),
+ (72760, 72767),
+ (72850, 72871),
+ (72873, 72886),
+ (73009, 73014),
+ (73018, 73018),
+ (73020, 73021),
+ (73023, 73029),
+ (73031, 73031),
+ (73098, 73102),
+ (73104, 73105),
+ (73107, 73111),
+ (73459, 73462),
+ (73472, 73473),
+ (73475, 73475),
+ (73524, 73530),
+ (73534, 73538),
+ (78912, 78912),
+ (78919, 78933),
+ (92912, 92916),
+ (92976, 92982),
+ (94031, 94031),
+ (94033, 94087),
+ (94095, 94098),
+ (94180, 94180),
+ (94192, 94193),
+ (113821, 113822),
+ (118528, 118573),
+ (118576, 118598),
+ (119141, 119145),
+ (119149, 119154),
+ (119163, 119170),
+ (119173, 119179),
+ (119210, 119213),
+ (119362, 119364),
+ (121344, 121398),
+ (121403, 121452),
+ (121461, 121461),
+ (121476, 121476),
+ (121499, 121503),
+ (121505, 121519),
+ (122880, 122886),
+ (122888, 122904),
+ (122907, 122913),
+ (122915, 122916),
+ (122918, 122922),
+ (123023, 123023),
+ (123184, 123190),
+ (123566, 123566),
+ (123628, 123631),
+ (124140, 124143),
+ (125136, 125142),
+ (125252, 125258),
+ (917760, 917999),
+];
+
+pub const MATH_SYMBOL: &'static [(u32, u32)] = &[
+ (43, 43),
+ (60, 62),
+ (124, 124),
+ (126, 126),
+ (172, 172),
+ (177, 177),
+ (215, 215),
+ (247, 247),
+ (1014, 1014),
+ (1542, 1544),
+ (8260, 8260),
+ (8274, 8274),
+ (8314, 8316),
+ (8330, 8332),
+ (8472, 8472),
+ (8512, 8516),
+ (8523, 8523),
+ (8592, 8596),
+ (8602, 8603),
+ (8608, 8608),
+ (8611, 8611),
+ (8614, 8614),
+ (8622, 8622),
+ (8654, 8655),
+ (8658, 8658),
+ (8660, 8660),
+ (8692, 8959),
+ (8992, 8993),
+ (9084, 9084),
+ (9115, 9139),
+ (9180, 9185),
+ (9655, 9655),
+ (9665, 9665),
+ (9720, 9727),
+ (9839, 9839),
+ (10176, 10180),
+ (10183, 10213),
+ (10224, 10239),
+ (10496, 10626),
+ (10649, 10711),
+ (10716, 10747),
+ (10750, 11007),
+ (11056, 11076),
+ (11079, 11084),
+ (64297, 64297),
+ (65122, 65122),
+ (65124, 65126),
+ (65291, 65291),
+ (65308, 65310),
+ (65372, 65372),
+ (65374, 65374),
+ (65506, 65506),
+ (65513, 65516),
+ (120513, 120513),
+ (120539, 120539),
+ (120571, 120571),
+ (120597, 120597),
+ (120629, 120629),
+ (120655, 120655),
+ (120687, 120687),
+ (120713, 120713),
+ (120745, 120745),
+ (120771, 120771),
+ (126704, 126705),
+];
+
+pub const MODIFIER_LETTER: &'static [(u32, u32)] = &[
+ (688, 705),
+ (710, 721),
+ (736, 740),
+ (748, 748),
+ (750, 750),
+ (884, 884),
+ (890, 890),
+ (1369, 1369),
+ (1600, 1600),
+ (1765, 1766),
+ (2036, 2037),
+ (2042, 2042),
+ (2074, 2074),
+ (2084, 2084),
+ (2088, 2088),
+ (2249, 2249),
+ (2417, 2417),
+ (3654, 3654),
+ (3782, 3782),
+ (4348, 4348),
+ (6103, 6103),
+ (6211, 6211),
+ (6823, 6823),
+ (7288, 7293),
+ (7468, 7530),
+ (7544, 7544),
+ (7579, 7615),
+ (8305, 8305),
+ (8319, 8319),
+ (8336, 8348),
+ (11388, 11389),
+ (11631, 11631),
+ (11823, 11823),
+ (12293, 12293),
+ (12337, 12341),
+ (12347, 12347),
+ (12445, 12446),
+ (12540, 12542),
+ (40981, 40981),
+ (42232, 42237),
+ (42508, 42508),
+ (42623, 42623),
+ (42652, 42653),
+ (42775, 42783),
+ (42864, 42864),
+ (42888, 42888),
+ (42994, 42996),
+ (43000, 43001),
+ (43471, 43471),
+ (43494, 43494),
+ (43632, 43632),
+ (43741, 43741),
+ (43763, 43764),
+ (43868, 43871),
+ (43881, 43881),
+ (65392, 65392),
+ (65438, 65439),
+ (67456, 67461),
+ (67463, 67504),
+ (67506, 67514),
+ (92992, 92995),
+ (94099, 94111),
+ (94176, 94177),
+ (94179, 94179),
+ (110576, 110579),
+ (110581, 110587),
+ (110589, 110590),
+ (122928, 122989),
+ (123191, 123197),
+ (124139, 124139),
+ (125259, 125259),
+];
+
+pub const MODIFIER_SYMBOL: &'static [(u32, u32)] = &[
+ (94, 94),
+ (96, 96),
+ (168, 168),
+ (175, 175),
+ (180, 180),
+ (184, 184),
+ (706, 709),
+ (722, 735),
+ (741, 747),
+ (749, 749),
+ (751, 767),
+ (885, 885),
+ (900, 901),
+ (2184, 2184),
+ (8125, 8125),
+ (8127, 8129),
+ (8141, 8143),
+ (8157, 8159),
+ (8173, 8175),
+ (8189, 8190),
+ (12443, 12444),
+ (42752, 42774),
+ (42784, 42785),
+ (42889, 42890),
+ (43867, 43867),
+ (43882, 43883),
+ (64434, 64450),
+ (65342, 65342),
+ (65344, 65344),
+ (65507, 65507),
+ (127995, 127999),
+];
+
+pub const NONSPACING_MARK: &'static [(u32, u32)] = &[
+ (768, 879),
+ (1155, 1159),
+ (1425, 1469),
+ (1471, 1471),
+ (1473, 1474),
+ (1476, 1477),
+ (1479, 1479),
+ (1552, 1562),
+ (1611, 1631),
+ (1648, 1648),
+ (1750, 1756),
+ (1759, 1764),
+ (1767, 1768),
+ (1770, 1773),
+ (1809, 1809),
+ (1840, 1866),
+ (1958, 1968),
+ (2027, 2035),
+ (2045, 2045),
+ (2070, 2073),
+ (2075, 2083),
+ (2085, 2087),
+ (2089, 2093),
+ (2137, 2139),
+ (2200, 2207),
+ (2250, 2273),
+ (2275, 2306),
+ (2362, 2362),
+ (2364, 2364),
+ (2369, 2376),
+ (2381, 2381),
+ (2385, 2391),
+ (2402, 2403),
+ (2433, 2433),
+ (2492, 2492),
+ (2497, 2500),
+ (2509, 2509),
+ (2530, 2531),
+ (2558, 2558),
+ (2561, 2562),
+ (2620, 2620),
+ (2625, 2626),
+ (2631, 2632),
+ (2635, 2637),
+ (2641, 2641),
+ (2672, 2673),
+ (2677, 2677),
+ (2689, 2690),
+ (2748, 2748),
+ (2753, 2757),
+ (2759, 2760),
+ (2765, 2765),
+ (2786, 2787),
+ (2810, 2815),
+ (2817, 2817),
+ (2876, 2876),
+ (2879, 2879),
+ (2881, 2884),
+ (2893, 2893),
+ (2901, 2902),
+ (2914, 2915),
+ (2946, 2946),
+ (3008, 3008),
+ (3021, 3021),
+ (3072, 3072),
+ (3076, 3076),
+ (3132, 3132),
+ (3134, 3136),
+ (3142, 3144),
+ (3146, 3149),
+ (3157, 3158),
+ (3170, 3171),
+ (3201, 3201),
+ (3260, 3260),
+ (3263, 3263),
+ (3270, 3270),
+ (3276, 3277),
+ (3298, 3299),
+ (3328, 3329),
+ (3387, 3388),
+ (3393, 3396),
+ (3405, 3405),
+ (3426, 3427),
+ (3457, 3457),
+ (3530, 3530),
+ (3538, 3540),
+ (3542, 3542),
+ (3633, 3633),
+ (3636, 3642),
+ (3655, 3662),
+ (3761, 3761),
+ (3764, 3772),
+ (3784, 3790),
+ (3864, 3865),
+ (3893, 3893),
+ (3895, 3895),
+ (3897, 3897),
+ (3953, 3966),
+ (3968, 3972),
+ (3974, 3975),
+ (3981, 3991),
+ (3993, 4028),
+ (4038, 4038),
+ (4141, 4144),
+ (4146, 4151),
+ (4153, 4154),
+ (4157, 4158),
+ (4184, 4185),
+ (4190, 4192),
+ (4209, 4212),
+ (4226, 4226),
+ (4229, 4230),
+ (4237, 4237),
+ (4253, 4253),
+ (4957, 4959),
+ (5906, 5908),
+ (5938, 5939),
+ (5970, 5971),
+ (6002, 6003),
+ (6068, 6069),
+ (6071, 6077),
+ (6086, 6086),
+ (6089, 6099),
+ (6109, 6109),
+ (6155, 6157),
+ (6159, 6159),
+ (6277, 6278),
+ (6313, 6313),
+ (6432, 6434),
+ (6439, 6440),
+ (6450, 6450),
+ (6457, 6459),
+ (6679, 6680),
+ (6683, 6683),
+ (6742, 6742),
+ (6744, 6750),
+ (6752, 6752),
+ (6754, 6754),
+ (6757, 6764),
+ (6771, 6780),
+ (6783, 6783),
+ (6832, 6845),
+ (6847, 6862),
+ (6912, 6915),
+ (6964, 6964),
+ (6966, 6970),
+ (6972, 6972),
+ (6978, 6978),
+ (7019, 7027),
+ (7040, 7041),
+ (7074, 7077),
+ (7080, 7081),
+ (7083, 7085),
+ (7142, 7142),
+ (7144, 7145),
+ (7149, 7149),
+ (7151, 7153),
+ (7212, 7219),
+ (7222, 7223),
+ (7376, 7378),
+ (7380, 7392),
+ (7394, 7400),
+ (7405, 7405),
+ (7412, 7412),
+ (7416, 7417),
+ (7616, 7679),
+ (8400, 8412),
+ (8417, 8417),
+ (8421, 8432),
+ (11503, 11505),
+ (11647, 11647),
+ (11744, 11775),
+ (12330, 12333),
+ (12441, 12442),
+ (42607, 42607),
+ (42612, 42621),
+ (42654, 42655),
+ (42736, 42737),
+ (43010, 43010),
+ (43014, 43014),
+ (43019, 43019),
+ (43045, 43046),
+ (43052, 43052),
+ (43204, 43205),
+ (43232, 43249),
+ (43263, 43263),
+ (43302, 43309),
+ (43335, 43345),
+ (43392, 43394),
+ (43443, 43443),
+ (43446, 43449),
+ (43452, 43453),
+ (43493, 43493),
+ (43561, 43566),
+ (43569, 43570),
+ (43573, 43574),
+ (43587, 43587),
+ (43596, 43596),
+ (43644, 43644),
+ (43696, 43696),
+ (43698, 43700),
+ (43703, 43704),
+ (43710, 43711),
+ (43713, 43713),
+ (43756, 43757),
+ (43766, 43766),
+ (44005, 44005),
+ (44008, 44008),
+ (44013, 44013),
+ (64286, 64286),
+ (65024, 65039),
+ (65056, 65071),
+ (66045, 66045),
+ (66272, 66272),
+ (66422, 66426),
+ (68097, 68099),
+ (68101, 68102),
+ (68108, 68111),
+ (68152, 68154),
+ (68159, 68159),
+ (68325, 68326),
+ (68900, 68903),
+ (69291, 69292),
+ (69373, 69375),
+ (69446, 69456),
+ (69506, 69509),
+ (69633, 69633),
+ (69688, 69702),
+ (69744, 69744),
+ (69747, 69748),
+ (69759, 69761),
+ (69811, 69814),
+ (69817, 69818),
+ (69826, 69826),
+ (69888, 69890),
+ (69927, 69931),
+ (69933, 69940),
+ (70003, 70003),
+ (70016, 70017),
+ (70070, 70078),
+ (70089, 70092),
+ (70095, 70095),
+ (70191, 70193),
+ (70196, 70196),
+ (70198, 70199),
+ (70206, 70206),
+ (70209, 70209),
+ (70367, 70367),
+ (70371, 70378),
+ (70400, 70401),
+ (70459, 70460),
+ (70464, 70464),
+ (70502, 70508),
+ (70512, 70516),
+ (70712, 70719),
+ (70722, 70724),
+ (70726, 70726),
+ (70750, 70750),
+ (70835, 70840),
+ (70842, 70842),
+ (70847, 70848),
+ (70850, 70851),
+ (71090, 71093),
+ (71100, 71101),
+ (71103, 71104),
+ (71132, 71133),
+ (71219, 71226),
+ (71229, 71229),
+ (71231, 71232),
+ (71339, 71339),
+ (71341, 71341),
+ (71344, 71349),
+ (71351, 71351),
+ (71453, 71455),
+ (71458, 71461),
+ (71463, 71467),
+ (71727, 71735),
+ (71737, 71738),
+ (71995, 71996),
+ (71998, 71998),
+ (72003, 72003),
+ (72148, 72151),
+ (72154, 72155),
+ (72160, 72160),
+ (72193, 72202),
+ (72243, 72248),
+ (72251, 72254),
+ (72263, 72263),
+ (72273, 72278),
+ (72281, 72283),
+ (72330, 72342),
+ (72344, 72345),
+ (72752, 72758),
+ (72760, 72765),
+ (72767, 72767),
+ (72850, 72871),
+ (72874, 72880),
+ (72882, 72883),
+ (72885, 72886),
+ (73009, 73014),
+ (73018, 73018),
+ (73020, 73021),
+ (73023, 73029),
+ (73031, 73031),
+ (73104, 73105),
+ (73109, 73109),
+ (73111, 73111),
+ (73459, 73460),
+ (73472, 73473),
+ (73526, 73530),
+ (73536, 73536),
+ (73538, 73538),
+ (78912, 78912),
+ (78919, 78933),
+ (92912, 92916),
+ (92976, 92982),
+ (94031, 94031),
+ (94095, 94098),
+ (94180, 94180),
+ (113821, 113822),
+ (118528, 118573),
+ (118576, 118598),
+ (119143, 119145),
+ (119163, 119170),
+ (119173, 119179),
+ (119210, 119213),
+ (119362, 119364),
+ (121344, 121398),
+ (121403, 121452),
+ (121461, 121461),
+ (121476, 121476),
+ (121499, 121503),
+ (121505, 121519),
+ (122880, 122886),
+ (122888, 122904),
+ (122907, 122913),
+ (122915, 122916),
+ (122918, 122922),
+ (123023, 123023),
+ (123184, 123190),
+ (123566, 123566),
+ (123628, 123631),
+ (124140, 124143),
+ (125136, 125142),
+ (125252, 125258),
+ (917760, 917999),
+];
+
+pub const NUMBER: &'static [(u32, u32)] = &[
+ (48, 57),
+ (178, 179),
+ (185, 185),
+ (188, 190),
+ (1632, 1641),
+ (1776, 1785),
+ (1984, 1993),
+ (2406, 2415),
+ (2534, 2543),
+ (2548, 2553),
+ (2662, 2671),
+ (2790, 2799),
+ (2918, 2927),
+ (2930, 2935),
+ (3046, 3058),
+ (3174, 3183),
+ (3192, 3198),
+ (3302, 3311),
+ (3416, 3422),
+ (3430, 3448),
+ (3558, 3567),
+ (3664, 3673),
+ (3792, 3801),
+ (3872, 3891),
+ (4160, 4169),
+ (4240, 4249),
+ (4969, 4988),
+ (5870, 5872),
+ (6112, 6121),
+ (6128, 6137),
+ (6160, 6169),
+ (6470, 6479),
+ (6608, 6618),
+ (6784, 6793),
+ (6800, 6809),
+ (6992, 7001),
+ (7088, 7097),
+ (7232, 7241),
+ (7248, 7257),
+ (8304, 8304),
+ (8308, 8313),
+ (8320, 8329),
+ (8528, 8578),
+ (8581, 8585),
+ (9312, 9371),
+ (9450, 9471),
+ (10102, 10131),
+ (11517, 11517),
+ (12295, 12295),
+ (12321, 12329),
+ (12344, 12346),
+ (12690, 12693),
+ (12832, 12841),
+ (12872, 12879),
+ (12881, 12895),
+ (12928, 12937),
+ (12977, 12991),
+ (42528, 42537),
+ (42726, 42735),
+ (43056, 43061),
+ (43216, 43225),
+ (43264, 43273),
+ (43472, 43481),
+ (43504, 43513),
+ (43600, 43609),
+ (44016, 44025),
+ (65296, 65305),
+ (65799, 65843),
+ (65856, 65912),
+ (65930, 65931),
+ (66273, 66299),
+ (66336, 66339),
+ (66369, 66369),
+ (66378, 66378),
+ (66513, 66517),
+ (66720, 66729),
+ (67672, 67679),
+ (67705, 67711),
+ (67751, 67759),
+ (67835, 67839),
+ (67862, 67867),
+ (68028, 68029),
+ (68032, 68047),
+ (68050, 68095),
+ (68160, 68168),
+ (68221, 68222),
+ (68253, 68255),
+ (68331, 68335),
+ (68440, 68447),
+ (68472, 68479),
+ (68521, 68527),
+ (68858, 68863),
+ (68912, 68921),
+ (69216, 69246),
+ (69405, 69414),
+ (69457, 69460),
+ (69573, 69579),
+ (69714, 69743),
+ (69872, 69881),
+ (69942, 69951),
+ (70096, 70105),
+ (70113, 70132),
+ (70384, 70393),
+ (70736, 70745),
+ (70864, 70873),
+ (71248, 71257),
+ (71360, 71369),
+ (71472, 71483),
+ (71904, 71922),
+ (72016, 72025),
+ (72784, 72812),
+ (73040, 73049),
+ (73120, 73129),
+ (73552, 73561),
+ (73664, 73684),
+ (74752, 74862),
+ (92768, 92777),
+ (92864, 92873),
+ (93008, 93017),
+ (93019, 93025),
+ (93824, 93846),
+ (119488, 119507),
+ (119520, 119539),
+ (119648, 119672),
+ (120782, 120831),
+ (123200, 123209),
+ (123632, 123641),
+ (124144, 124153),
+ (125127, 125135),
+ (125264, 125273),
+ (126065, 126123),
+ (126125, 126127),
+ (126129, 126132),
+ (126209, 126253),
+ (126255, 126269),
+ (127232, 127244),
+ (130032, 130041),
+];
+
+pub const OPEN_PUNCTUATION: &'static [(u32, u32)] = &[
+ (40, 40),
+ (91, 91),
+ (123, 123),
+ (3898, 3898),
+ (3900, 3900),
+ (5787, 5787),
+ (8218, 8218),
+ (8222, 8222),
+ (8261, 8261),
+ (8317, 8317),
+ (8333, 8333),
+ (8968, 8968),
+ (8970, 8970),
+ (9001, 9001),
+ (10088, 10088),
+ (10090, 10090),
+ (10092, 10092),
+ (10094, 10094),
+ (10096, 10096),
+ (10098, 10098),
+ (10100, 10100),
+ (10181, 10181),
+ (10214, 10214),
+ (10216, 10216),
+ (10218, 10218),
+ (10220, 10220),
+ (10222, 10222),
+ (10627, 10627),
+ (10629, 10629),
+ (10631, 10631),
+ (10633, 10633),
+ (10635, 10635),
+ (10637, 10637),
+ (10639, 10639),
+ (10641, 10641),
+ (10643, 10643),
+ (10645, 10645),
+ (10647, 10647),
+ (10712, 10712),
+ (10714, 10714),
+ (10748, 10748),
+ (11810, 11810),
+ (11812, 11812),
+ (11814, 11814),
+ (11816, 11816),
+ (11842, 11842),
+ (11861, 11861),
+ (11863, 11863),
+ (11865, 11865),
+ (11867, 11867),
+ (12296, 12296),
+ (12298, 12298),
+ (12300, 12300),
+ (12302, 12302),
+ (12304, 12304),
+ (12308, 12308),
+ (12310, 12310),
+ (12312, 12312),
+ (12314, 12314),
+ (12317, 12317),
+ (64831, 64831),
+ (65047, 65047),
+ (65077, 65077),
+ (65079, 65079),
+ (65081, 65081),
+ (65083, 65083),
+ (65085, 65085),
+ (65087, 65087),
+ (65089, 65089),
+ (65091, 65091),
+ (65095, 65095),
+ (65113, 65113),
+ (65115, 65115),
+ (65117, 65117),
+ (65288, 65288),
+ (65339, 65339),
+ (65371, 65371),
+ (65375, 65375),
+ (65378, 65378),
+];
+
+pub const OTHER: &'static [(u32, u32)] = &[
+ (0, 31),
+ (127, 159),
+ (173, 173),
+ (888, 889),
+ (896, 899),
+ (907, 907),
+ (909, 909),
+ (930, 930),
+ (1328, 1328),
+ (1367, 1368),
+ (1419, 1420),
+ (1424, 1424),
+ (1480, 1487),
+ (1515, 1518),
+ (1525, 1541),
+ (1564, 1564),
+ (1757, 1757),
+ (1806, 1807),
+ (1867, 1868),
+ (1970, 1983),
+ (2043, 2044),
+ (2094, 2095),
+ (2111, 2111),
+ (2140, 2141),
+ (2143, 2143),
+ (2155, 2159),
+ (2191, 2199),
+ (2274, 2274),
+ (2436, 2436),
+ (2445, 2446),
+ (2449, 2450),
+ (2473, 2473),
+ (2481, 2481),
+ (2483, 2485),
+ (2490, 2491),
+ (2501, 2502),
+ (2505, 2506),
+ (2511, 2518),
+ (2520, 2523),
+ (2526, 2526),
+ (2532, 2533),
+ (2559, 2560),
+ (2564, 2564),
+ (2571, 2574),
+ (2577, 2578),
+ (2601, 2601),
+ (2609, 2609),
+ (2612, 2612),
+ (2615, 2615),
+ (2618, 2619),
+ (2621, 2621),
+ (2627, 2630),
+ (2633, 2634),
+ (2638, 2640),
+ (2642, 2648),
+ (2653, 2653),
+ (2655, 2661),
+ (2679, 2688),
+ (2692, 2692),
+ (2702, 2702),
+ (2706, 2706),
+ (2729, 2729),
+ (2737, 2737),
+ (2740, 2740),
+ (2746, 2747),
+ (2758, 2758),
+ (2762, 2762),
+ (2766, 2767),
+ (2769, 2783),
+ (2788, 2789),
+ (2802, 2808),
+ (2816, 2816),
+ (2820, 2820),
+ (2829, 2830),
+ (2833, 2834),
+ (2857, 2857),
+ (2865, 2865),
+ (2868, 2868),
+ (2874, 2875),
+ (2885, 2886),
+ (2889, 2890),
+ (2894, 2900),
+ (2904, 2907),
+ (2910, 2910),
+ (2916, 2917),
+ (2936, 2945),
+ (2948, 2948),
+ (2955, 2957),
+ (2961, 2961),
+ (2966, 2968),
+ (2971, 2971),
+ (2973, 2973),
+ (2976, 2978),
+ (2981, 2983),
+ (2987, 2989),
+ (3002, 3005),
+ (3011, 3013),
+ (3017, 3017),
+ (3022, 3023),
+ (3025, 3030),
+ (3032, 3045),
+ (3067, 3071),
+ (3085, 3085),
+ (3089, 3089),
+ (3113, 3113),
+ (3130, 3131),
+ (3141, 3141),
+ (3145, 3145),
+ (3150, 3156),
+ (3159, 3159),
+ (3163, 3164),
+ (3166, 3167),
+ (3172, 3173),
+ (3184, 3190),
+ (3213, 3213),
+ (3217, 3217),
+ (3241, 3241),
+ (3252, 3252),
+ (3258, 3259),
+ (3269, 3269),
+ (3273, 3273),
+ (3278, 3284),
+ (3287, 3292),
+ (3295, 3295),
+ (3300, 3301),
+ (3312, 3312),
+ (3316, 3327),
+ (3341, 3341),
+ (3345, 3345),
+ (3397, 3397),
+ (3401, 3401),
+ (3408, 3411),
+ (3428, 3429),
+ (3456, 3456),
+ (3460, 3460),
+ (3479, 3481),
+ (3506, 3506),
+ (3516, 3516),
+ (3518, 3519),
+ (3527, 3529),
+ (3531, 3534),
+ (3541, 3541),
+ (3543, 3543),
+ (3552, 3557),
+ (3568, 3569),
+ (3573, 3584),
+ (3643, 3646),
+ (3676, 3712),
+ (3715, 3715),
+ (3717, 3717),
+ (3723, 3723),
+ (3748, 3748),
+ (3750, 3750),
+ (3774, 3775),
+ (3781, 3781),
+ (3783, 3783),
+ (3791, 3791),
+ (3802, 3803),
+ (3808, 3839),
+ (3912, 3912),
+ (3949, 3952),
+ (3992, 3992),
+ (4029, 4029),
+ (4045, 4045),
+ (4059, 4095),
+ (4294, 4294),
+ (4296, 4300),
+ (4302, 4303),
+ (4681, 4681),
+ (4686, 4687),
+ (4695, 4695),
+ (4697, 4697),
+ (4702, 4703),
+ (4745, 4745),
+ (4750, 4751),
+ (4785, 4785),
+ (4790, 4791),
+ (4799, 4799),
+ (4801, 4801),
+ (4806, 4807),
+ (4823, 4823),
+ (4881, 4881),
+ (4886, 4887),
+ (4955, 4956),
+ (4989, 4991),
+ (5018, 5023),
+ (5110, 5111),
+ (5118, 5119),
+ (5789, 5791),
+ (5881, 5887),
+ (5910, 5918),
+ (5943, 5951),
+ (5972, 5983),
+ (5997, 5997),
+ (6001, 6001),
+ (6004, 6015),
+ (6110, 6111),
+ (6122, 6127),
+ (6138, 6143),
+ (6158, 6158),
+ (6170, 6175),
+ (6265, 6271),
+ (6315, 6319),
+ (6390, 6399),
+ (6431, 6431),
+ (6444, 6447),
+ (6460, 6463),
+ (6465, 6467),
+ (6510, 6511),
+ (6517, 6527),
+ (6572, 6575),
+ (6602, 6607),
+ (6619, 6621),
+ (6684, 6685),
+ (6751, 6751),
+ (6781, 6782),
+ (6794, 6799),
+ (6810, 6815),
+ (6830, 6831),
+ (6863, 6911),
+ (6989, 6991),
+ (7039, 7039),
+ (7156, 7163),
+ (7224, 7226),
+ (7242, 7244),
+ (7305, 7311),
+ (7355, 7356),
+ (7368, 7375),
+ (7419, 7423),
+ (7958, 7959),
+ (7966, 7967),
+ (8006, 8007),
+ (8014, 8015),
+ (8024, 8024),
+ (8026, 8026),
+ (8028, 8028),
+ (8030, 8030),
+ (8062, 8063),
+ (8117, 8117),
+ (8133, 8133),
+ (8148, 8149),
+ (8156, 8156),
+ (8176, 8177),
+ (8181, 8181),
+ (8191, 8191),
+ (8203, 8207),
+ (8234, 8238),
+ (8288, 8303),
+ (8306, 8307),
+ (8335, 8335),
+ (8349, 8351),
+ (8385, 8399),
+ (8433, 8447),
+ (8588, 8591),
+ (9255, 9279),
+ (9291, 9311),
+ (11124, 11125),
+ (11158, 11158),
+ (11508, 11512),
+ (11558, 11558),
+ (11560, 11564),
+ (11566, 11567),
+ (11624, 11630),
+ (11633, 11646),
+ (11671, 11679),
+ (11687, 11687),
+ (11695, 11695),
+ (11703, 11703),
+ (11711, 11711),
+ (11719, 11719),
+ (11727, 11727),
+ (11735, 11735),
+ (11743, 11743),
+ (11870, 11903),
+ (11930, 11930),
+ (12020, 12031),
+ (12246, 12271),
+ (12284, 12287),
+ (12352, 12352),
+ (12439, 12440),
+ (12544, 12548),
+ (12592, 12592),
+ (12687, 12687),
+ (12772, 12783),
+ (12831, 12831),
+ (42125, 42127),
+ (42183, 42191),
+ (42540, 42559),
+ (42744, 42751),
+ (42955, 42959),
+ (42962, 42962),
+ (42964, 42964),
+ (42970, 42993),
+ (43053, 43055),
+ (43066, 43071),
+ (43128, 43135),
+ (43206, 43213),
+ (43226, 43231),
+ (43348, 43358),
+ (43389, 43391),
+ (43470, 43470),
+ (43482, 43485),
+ (43519, 43519),
+ (43575, 43583),
+ (43598, 43599),
+ (43610, 43611),
+ (43715, 43738),
+ (43767, 43776),
+ (43783, 43784),
+ (43791, 43792),
+ (43799, 43807),
+ (43815, 43815),
+ (43823, 43823),
+ (43884, 43887),
+ (44014, 44015),
+ (44026, 44031),
+ (55204, 55215),
+ (55239, 55242),
+ (55292, 63743),
+ (64110, 64111),
+ (64218, 64255),
+ (64263, 64274),
+ (64280, 64284),
+ (64311, 64311),
+ (64317, 64317),
+ (64319, 64319),
+ (64322, 64322),
+ (64325, 64325),
+ (64451, 64466),
+ (64912, 64913),
+ (64968, 64974),
+ (64976, 65007),
+ (65050, 65055),
+ (65107, 65107),
+ (65127, 65127),
+ (65132, 65135),
+ (65141, 65141),
+ (65277, 65280),
+ (65471, 65473),
+ (65480, 65481),
+ (65488, 65489),
+ (65496, 65497),
+ (65501, 65503),
+ (65511, 65511),
+ (65519, 65531),
+ (65534, 65535),
+ (65548, 65548),
+ (65575, 65575),
+ (65595, 65595),
+ (65598, 65598),
+ (65614, 65615),
+ (65630, 65663),
+ (65787, 65791),
+ (65795, 65798),
+ (65844, 65846),
+ (65935, 65935),
+ (65949, 65951),
+ (65953, 65999),
+ (66046, 66175),
+ (66205, 66207),
+ (66257, 66271),
+ (66300, 66303),
+ (66340, 66348),
+ (66379, 66383),
+ (66427, 66431),
+ (66462, 66462),
+ (66500, 66503),
+ (66518, 66559),
+ (66718, 66719),
+ (66730, 66735),
+ (66772, 66775),
+ (66812, 66815),
+ (66856, 66863),
+ (66916, 66926),
+ (66939, 66939),
+ (66955, 66955),
+ (66963, 66963),
+ (66966, 66966),
+ (66978, 66978),
+ (66994, 66994),
+ (67002, 67002),
+ (67005, 67071),
+ (67383, 67391),
+ (67414, 67423),
+ (67432, 67455),
+ (67462, 67462),
+ (67505, 67505),
+ (67515, 67583),
+ (67590, 67591),
+ (67593, 67593),
+ (67638, 67638),
+ (67641, 67643),
+ (67645, 67646),
+ (67670, 67670),
+ (67743, 67750),
+ (67760, 67807),
+ (67827, 67827),
+ (67830, 67834),
+ (67868, 67870),
+ (67898, 67902),
+ (67904, 67967),
+ (68024, 68027),
+ (68048, 68049),
+ (68100, 68100),
+ (68103, 68107),
+ (68116, 68116),
+ (68120, 68120),
+ (68150, 68151),
+ (68155, 68158),
+ (68169, 68175),
+ (68185, 68191),
+ (68256, 68287),
+ (68327, 68330),
+ (68343, 68351),
+ (68406, 68408),
+ (68438, 68439),
+ (68467, 68471),
+ (68498, 68504),
+ (68509, 68520),
+ (68528, 68607),
+ (68681, 68735),
+ (68787, 68799),
+ (68851, 68857),
+ (68904, 68911),
+ (68922, 69215),
+ (69247, 69247),
+ (69290, 69290),
+ (69294, 69295),
+ (69298, 69372),
+ (69416, 69423),
+ (69466, 69487),
+ (69514, 69551),
+ (69580, 69599),
+ (69623, 69631),
+ (69710, 69713),
+ (69750, 69758),
+ (69821, 69821),
+ (69827, 69839),
+ (69865, 69871),
+ (69882, 69887),
+ (69941, 69941),
+ (69960, 69967),
+ (70007, 70015),
+ (70112, 70112),
+ (70133, 70143),
+ (70162, 70162),
+ (70210, 70271),
+ (70279, 70279),
+ (70281, 70281),
+ (70286, 70286),
+ (70302, 70302),
+ (70314, 70319),
+ (70379, 70383),
+ (70394, 70399),
+ (70404, 70404),
+ (70413, 70414),
+ (70417, 70418),
+ (70441, 70441),
+ (70449, 70449),
+ (70452, 70452),
+ (70458, 70458),
+ (70469, 70470),
+ (70473, 70474),
+ (70478, 70479),
+ (70481, 70486),
+ (70488, 70492),
+ (70500, 70501),
+ (70509, 70511),
+ (70517, 70655),
+ (70748, 70748),
+ (70754, 70783),
+ (70856, 70863),
+ (70874, 71039),
+ (71094, 71095),
+ (71134, 71167),
+ (71237, 71247),
+ (71258, 71263),
+ (71277, 71295),
+ (71354, 71359),
+ (71370, 71423),
+ (71451, 71452),
+ (71468, 71471),
+ (71495, 71679),
+ (71740, 71839),
+ (71923, 71934),
+ (71943, 71944),
+ (71946, 71947),
+ (71956, 71956),
+ (71959, 71959),
+ (71990, 71990),
+ (71993, 71994),
+ (72007, 72015),
+ (72026, 72095),
+ (72104, 72105),
+ (72152, 72153),
+ (72165, 72191),
+ (72264, 72271),
+ (72355, 72367),
+ (72441, 72447),
+ (72458, 72703),
+ (72713, 72713),
+ (72759, 72759),
+ (72774, 72783),
+ (72813, 72815),
+ (72848, 72849),
+ (72872, 72872),
+ (72887, 72959),
+ (72967, 72967),
+ (72970, 72970),
+ (73015, 73017),
+ (73019, 73019),
+ (73022, 73022),
+ (73032, 73039),
+ (73050, 73055),
+ (73062, 73062),
+ (73065, 73065),
+ (73103, 73103),
+ (73106, 73106),
+ (73113, 73119),
+ (73130, 73439),
+ (73465, 73471),
+ (73489, 73489),
+ (73531, 73533),
+ (73562, 73647),
+ (73649, 73663),
+ (73714, 73726),
+ (74650, 74751),
+ (74863, 74863),
+ (74869, 74879),
+ (75076, 77711),
+ (77811, 77823),
+ (78896, 78911),
+ (78934, 82943),
+ (83527, 92159),
+ (92729, 92735),
+ (92767, 92767),
+ (92778, 92781),
+ (92863, 92863),
+ (92874, 92879),
+ (92910, 92911),
+ (92918, 92927),
+ (92998, 93007),
+ (93018, 93018),
+ (93026, 93026),
+ (93048, 93052),
+ (93072, 93759),
+ (93851, 93951),
+ (94027, 94030),
+ (94088, 94094),
+ (94112, 94175),
+ (94181, 94191),
+ (94194, 94207),
+ (100344, 100351),
+ (101590, 101631),
+ (101641, 110575),
+ (110580, 110580),
+ (110588, 110588),
+ (110591, 110591),
+ (110883, 110897),
+ (110899, 110927),
+ (110931, 110932),
+ (110934, 110947),
+ (110952, 110959),
+ (111356, 113663),
+ (113771, 113775),
+ (113789, 113791),
+ (113801, 113807),
+ (113818, 113819),
+ (113824, 118527),
+ (118574, 118575),
+ (118599, 118607),
+ (118724, 118783),
+ (119030, 119039),
+ (119079, 119080),
+ (119155, 119162),
+ (119275, 119295),
+ (119366, 119487),
+ (119508, 119519),
+ (119540, 119551),
+ (119639, 119647),
+ (119673, 119807),
+ (119893, 119893),
+ (119965, 119965),
+ (119968, 119969),
+ (119971, 119972),
+ (119975, 119976),
+ (119981, 119981),
+ (119994, 119994),
+ (119996, 119996),
+ (120004, 120004),
+ (120070, 120070),
+ (120075, 120076),
+ (120085, 120085),
+ (120093, 120093),
+ (120122, 120122),
+ (120127, 120127),
+ (120133, 120133),
+ (120135, 120137),
+ (120145, 120145),
+ (120486, 120487),
+ (120780, 120781),
+ (121484, 121498),
+ (121504, 121504),
+ (121520, 122623),
+ (122655, 122660),
+ (122667, 122879),
+ (122887, 122887),
+ (122905, 122906),
+ (122914, 122914),
+ (122917, 122917),
+ (122923, 122927),
+ (122990, 123022),
+ (123024, 123135),
+ (123181, 123183),
+ (123198, 123199),
+ (123210, 123213),
+ (123216, 123535),
+ (123567, 123583),
+ (123642, 123646),
+ (123648, 124111),
+ (124154, 124895),
+ (124903, 124903),
+ (124908, 124908),
+ (124911, 124911),
+ (124927, 124927),
+ (125125, 125126),
+ (125143, 125183),
+ (125260, 125263),
+ (125274, 125277),
+ (125280, 126064),
+ (126133, 126208),
+ (126270, 126463),
+ (126468, 126468),
+ (126496, 126496),
+ (126499, 126499),
+ (126501, 126502),
+ (126504, 126504),
+ (126515, 126515),
+ (126520, 126520),
+ (126522, 126522),
+ (126524, 126529),
+ (126531, 126534),
+ (126536, 126536),
+ (126538, 126538),
+ (126540, 126540),
+ (126544, 126544),
+ (126547, 126547),
+ (126549, 126550),
+ (126552, 126552),
+ (126554, 126554),
+ (126556, 126556),
+ (126558, 126558),
+ (126560, 126560),
+ (126563, 126563),
+ (126565, 126566),
+ (126571, 126571),
+ (126579, 126579),
+ (126584, 126584),
+ (126589, 126589),
+ (126591, 126591),
+ (126602, 126602),
+ (126620, 126624),
+ (126628, 126628),
+ (126634, 126634),
+ (126652, 126703),
+ (126706, 126975),
+ (127020, 127023),
+ (127124, 127135),
+ (127151, 127152),
+ (127168, 127168),
+ (127184, 127184),
+ (127222, 127231),
+ (127406, 127461),
+ (127491, 127503),
+ (127548, 127551),
+ (127561, 127567),
+ (127570, 127583),
+ (127590, 127743),
+ (128728, 128731),
+ (128749, 128751),
+ (128765, 128767),
+ (128887, 128890),
+ (128986, 128991),
+ (129004, 129007),
+ (129009, 129023),
+ (129036, 129039),
+ (129096, 129103),
+ (129114, 129119),
+ (129160, 129167),
+ (129198, 129199),
+ (129202, 129279),
+ (129620, 129631),
+ (129646, 129647),
+ (129661, 129663),
+ (129673, 129679),
+ (129726, 129726),
+ (129734, 129741),
+ (129756, 129759),
+ (129769, 129775),
+ (129785, 129791),
+ (129939, 129939),
+ (129995, 130031),
+ (130042, 131071),
+ (173792, 173823),
+ (177978, 177983),
+ (178206, 178207),
+ (183970, 183983),
+ (191457, 194559),
+ (195102, 196607),
+ (201547, 201551),
+ (205744, 917759),
+ (918000, 1114111),
+];
+
+pub const OTHER_LETTER: &'static [(u32, u32)] = &[
+ (170, 170),
+ (186, 186),
+ (443, 443),
+ (448, 451),
+ (660, 660),
+ (1488, 1514),
+ (1519, 1522),
+ (1568, 1599),
+ (1601, 1610),
+ (1646, 1647),
+ (1649, 1747),
+ (1749, 1749),
+ (1774, 1775),
+ (1786, 1788),
+ (1791, 1791),
+ (1808, 1808),
+ (1810, 1839),
+ (1869, 1957),
+ (1969, 1969),
+ (1994, 2026),
+ (2048, 2069),
+ (2112, 2136),
+ (2144, 2154),
+ (2160, 2183),
+ (2185, 2190),
+ (2208, 2248),
+ (2308, 2361),
+ (2365, 2365),
+ (2384, 2384),
+ (2392, 2401),
+ (2418, 2432),
+ (2437, 2444),
+ (2447, 2448),
+ (2451, 2472),
+ (2474, 2480),
+ (2482, 2482),
+ (2486, 2489),
+ (2493, 2493),
+ (2510, 2510),
+ (2524, 2525),
+ (2527, 2529),
+ (2544, 2545),
+ (2556, 2556),
+ (2565, 2570),
+ (2575, 2576),
+ (2579, 2600),
+ (2602, 2608),
+ (2610, 2611),
+ (2613, 2614),
+ (2616, 2617),
+ (2649, 2652),
+ (2654, 2654),
+ (2674, 2676),
+ (2693, 2701),
+ (2703, 2705),
+ (2707, 2728),
+ (2730, 2736),
+ (2738, 2739),
+ (2741, 2745),
+ (2749, 2749),
+ (2768, 2768),
+ (2784, 2785),
+ (2809, 2809),
+ (2821, 2828),
+ (2831, 2832),
+ (2835, 2856),
+ (2858, 2864),
+ (2866, 2867),
+ (2869, 2873),
+ (2877, 2877),
+ (2908, 2909),
+ (2911, 2913),
+ (2929, 2929),
+ (2947, 2947),
+ (2949, 2954),
+ (2958, 2960),
+ (2962, 2965),
+ (2969, 2970),
+ (2972, 2972),
+ (2974, 2975),
+ (2979, 2980),
+ (2984, 2986),
+ (2990, 3001),
+ (3024, 3024),
+ (3077, 3084),
+ (3086, 3088),
+ (3090, 3112),
+ (3114, 3129),
+ (3133, 3133),
+ (3160, 3162),
+ (3165, 3165),
+ (3168, 3169),
+ (3200, 3200),
+ (3205, 3212),
+ (3214, 3216),
+ (3218, 3240),
+ (3242, 3251),
+ (3253, 3257),
+ (3261, 3261),
+ (3293, 3294),
+ (3296, 3297),
+ (3313, 3314),
+ (3332, 3340),
+ (3342, 3344),
+ (3346, 3386),
+ (3389, 3389),
+ (3406, 3406),
+ (3412, 3414),
+ (3423, 3425),
+ (3450, 3455),
+ (3461, 3478),
+ (3482, 3505),
+ (3507, 3515),
+ (3517, 3517),
+ (3520, 3526),
+ (3585, 3632),
+ (3634, 3635),
+ (3648, 3653),
+ (3713, 3714),
+ (3716, 3716),
+ (3718, 3722),
+ (3724, 3747),
+ (3749, 3749),
+ (3751, 3760),
+ (3762, 3763),
+ (3773, 3773),
+ (3776, 3780),
+ (3804, 3807),
+ (3840, 3840),
+ (3904, 3911),
+ (3913, 3948),
+ (3976, 3980),
+ (4096, 4138),
+ (4159, 4159),
+ (4176, 4181),
+ (4186, 4189),
+ (4193, 4193),
+ (4197, 4198),
+ (4206, 4208),
+ (4213, 4225),
+ (4238, 4238),
+ (4352, 4680),
+ (4682, 4685),
+ (4688, 4694),
+ (4696, 4696),
+ (4698, 4701),
+ (4704, 4744),
+ (4746, 4749),
+ (4752, 4784),
+ (4786, 4789),
+ (4792, 4798),
+ (4800, 4800),
+ (4802, 4805),
+ (4808, 4822),
+ (4824, 4880),
+ (4882, 4885),
+ (4888, 4954),
+ (4992, 5007),
+ (5121, 5740),
+ (5743, 5759),
+ (5761, 5786),
+ (5792, 5866),
+ (5873, 5880),
+ (5888, 5905),
+ (5919, 5937),
+ (5952, 5969),
+ (5984, 5996),
+ (5998, 6000),
+ (6016, 6067),
+ (6108, 6108),
+ (6176, 6210),
+ (6212, 6264),
+ (6272, 6276),
+ (6279, 6312),
+ (6314, 6314),
+ (6320, 6389),
+ (6400, 6430),
+ (6480, 6509),
+ (6512, 6516),
+ (6528, 6571),
+ (6576, 6601),
+ (6656, 6678),
+ (6688, 6740),
+ (6917, 6963),
+ (6981, 6988),
+ (7043, 7072),
+ (7086, 7087),
+ (7098, 7141),
+ (7168, 7203),
+ (7245, 7247),
+ (7258, 7287),
+ (7401, 7404),
+ (7406, 7411),
+ (7413, 7414),
+ (7418, 7418),
+ (8501, 8504),
+ (11568, 11623),
+ (11648, 11670),
+ (11680, 11686),
+ (11688, 11694),
+ (11696, 11702),
+ (11704, 11710),
+ (11712, 11718),
+ (11720, 11726),
+ (11728, 11734),
+ (11736, 11742),
+ (12294, 12294),
+ (12348, 12348),
+ (12353, 12438),
+ (12447, 12447),
+ (12449, 12538),
+ (12543, 12543),
+ (12549, 12591),
+ (12593, 12686),
+ (12704, 12735),
+ (12784, 12799),
+ (13312, 19903),
+ (19968, 40980),
+ (40982, 42124),
+ (42192, 42231),
+ (42240, 42507),
+ (42512, 42527),
+ (42538, 42539),
+ (42606, 42606),
+ (42656, 42725),
+ (42895, 42895),
+ (42999, 42999),
+ (43003, 43009),
+ (43011, 43013),
+ (43015, 43018),
+ (43020, 43042),
+ (43072, 43123),
+ (43138, 43187),
+ (43250, 43255),
+ (43259, 43259),
+ (43261, 43262),
+ (43274, 43301),
+ (43312, 43334),
+ (43360, 43388),
+ (43396, 43442),
+ (43488, 43492),
+ (43495, 43503),
+ (43514, 43518),
+ (43520, 43560),
+ (43584, 43586),
+ (43588, 43595),
+ (43616, 43631),
+ (43633, 43638),
+ (43642, 43642),
+ (43646, 43695),
+ (43697, 43697),
+ (43701, 43702),
+ (43705, 43709),
+ (43712, 43712),
+ (43714, 43714),
+ (43739, 43740),
+ (43744, 43754),
+ (43762, 43762),
+ (43777, 43782),
+ (43785, 43790),
+ (43793, 43798),
+ (43808, 43814),
+ (43816, 43822),
+ (43968, 44002),
+ (44032, 55203),
+ (55216, 55238),
+ (55243, 55291),
+ (63744, 64109),
+ (64112, 64217),
+ (64285, 64285),
+ (64287, 64296),
+ (64298, 64310),
+ (64312, 64316),
+ (64318, 64318),
+ (64320, 64321),
+ (64323, 64324),
+ (64326, 64433),
+ (64467, 64829),
+ (64848, 64911),
+ (64914, 64967),
+ (65008, 65019),
+ (65136, 65140),
+ (65142, 65276),
+ (65382, 65391),
+ (65393, 65437),
+ (65440, 65470),
+ (65474, 65479),
+ (65482, 65487),
+ (65490, 65495),
+ (65498, 65500),
+ (65536, 65547),
+ (65549, 65574),
+ (65576, 65594),
+ (65596, 65597),
+ (65599, 65613),
+ (65616, 65629),
+ (65664, 65786),
+ (66176, 66204),
+ (66208, 66256),
+ (66304, 66335),
+ (66349, 66368),
+ (66370, 66377),
+ (66384, 66421),
+ (66432, 66461),
+ (66464, 66499),
+ (66504, 66511),
+ (66640, 66717),
+ (66816, 66855),
+ (66864, 66915),
+ (67072, 67382),
+ (67392, 67413),
+ (67424, 67431),
+ (67584, 67589),
+ (67592, 67592),
+ (67594, 67637),
+ (67639, 67640),
+ (67644, 67644),
+ (67647, 67669),
+ (67680, 67702),
+ (67712, 67742),
+ (67808, 67826),
+ (67828, 67829),
+ (67840, 67861),
+ (67872, 67897),
+ (67968, 68023),
+ (68030, 68031),
+ (68096, 68096),
+ (68112, 68115),
+ (68117, 68119),
+ (68121, 68149),
+ (68192, 68220),
+ (68224, 68252),
+ (68288, 68295),
+ (68297, 68324),
+ (68352, 68405),
+ (68416, 68437),
+ (68448, 68466),
+ (68480, 68497),
+ (68608, 68680),
+ (68864, 68899),
+ (69248, 69289),
+ (69296, 69297),
+ (69376, 69404),
+ (69415, 69415),
+ (69424, 69445),
+ (69488, 69505),
+ (69552, 69572),
+ (69600, 69622),
+ (69635, 69687),
+ (69745, 69746),
+ (69749, 69749),
+ (69763, 69807),
+ (69840, 69864),
+ (69891, 69926),
+ (69956, 69956),
+ (69959, 69959),
+ (69968, 70002),
+ (70006, 70006),
+ (70019, 70066),
+ (70081, 70084),
+ (70106, 70106),
+ (70108, 70108),
+ (70144, 70161),
+ (70163, 70187),
+ (70207, 70208),
+ (70272, 70278),
+ (70280, 70280),
+ (70282, 70285),
+ (70287, 70301),
+ (70303, 70312),
+ (70320, 70366),
+ (70405, 70412),
+ (70415, 70416),
+ (70419, 70440),
+ (70442, 70448),
+ (70450, 70451),
+ (70453, 70457),
+ (70461, 70461),
+ (70480, 70480),
+ (70493, 70497),
+ (70656, 70708),
+ (70727, 70730),
+ (70751, 70753),
+ (70784, 70831),
+ (70852, 70853),
+ (70855, 70855),
+ (71040, 71086),
+ (71128, 71131),
+ (71168, 71215),
+ (71236, 71236),
+ (71296, 71338),
+ (71352, 71352),
+ (71424, 71450),
+ (71488, 71494),
+ (71680, 71723),
+ (71935, 71942),
+ (71945, 71945),
+ (71948, 71955),
+ (71957, 71958),
+ (71960, 71983),
+ (71999, 71999),
+ (72001, 72001),
+ (72096, 72103),
+ (72106, 72144),
+ (72161, 72161),
+ (72163, 72163),
+ (72192, 72192),
+ (72203, 72242),
+ (72250, 72250),
+ (72272, 72272),
+ (72284, 72329),
+ (72349, 72349),
+ (72368, 72440),
+ (72704, 72712),
+ (72714, 72750),
+ (72768, 72768),
+ (72818, 72847),
+ (72960, 72966),
+ (72968, 72969),
+ (72971, 73008),
+ (73030, 73030),
+ (73056, 73061),
+ (73063, 73064),
+ (73066, 73097),
+ (73112, 73112),
+ (73440, 73458),
+ (73474, 73474),
+ (73476, 73488),
+ (73490, 73523),
+ (73648, 73648),
+ (73728, 74649),
+ (74880, 75075),
+ (77712, 77808),
+ (77824, 78895),
+ (78913, 78918),
+ (82944, 83526),
+ (92160, 92728),
+ (92736, 92766),
+ (92784, 92862),
+ (92880, 92909),
+ (92928, 92975),
+ (93027, 93047),
+ (93053, 93071),
+ (93952, 94026),
+ (94032, 94032),
+ (94208, 100343),
+ (100352, 101589),
+ (101632, 101640),
+ (110592, 110882),
+ (110898, 110898),
+ (110928, 110930),
+ (110933, 110933),
+ (110948, 110951),
+ (110960, 111355),
+ (113664, 113770),
+ (113776, 113788),
+ (113792, 113800),
+ (113808, 113817),
+ (122634, 122634),
+ (123136, 123180),
+ (123214, 123214),
+ (123536, 123565),
+ (123584, 123627),
+ (124112, 124138),
+ (124896, 124902),
+ (124904, 124907),
+ (124909, 124910),
+ (124912, 124926),
+ (124928, 125124),
+ (126464, 126467),
+ (126469, 126495),
+ (126497, 126498),
+ (126500, 126500),
+ (126503, 126503),
+ (126505, 126514),
+ (126516, 126519),
+ (126521, 126521),
+ (126523, 126523),
+ (126530, 126530),
+ (126535, 126535),
+ (126537, 126537),
+ (126539, 126539),
+ (126541, 126543),
+ (126545, 126546),
+ (126548, 126548),
+ (126551, 126551),
+ (126553, 126553),
+ (126555, 126555),
+ (126557, 126557),
+ (126559, 126559),
+ (126561, 126562),
+ (126564, 126564),
+ (126567, 126570),
+ (126572, 126578),
+ (126580, 126583),
+ (126585, 126588),
+ (126590, 126590),
+ (126592, 126601),
+ (126603, 126619),
+ (126625, 126627),
+ (126629, 126633),
+ (126635, 126651),
+ (131072, 173791),
+ (173824, 177977),
+ (177984, 178205),
+ (178208, 183969),
+ (183984, 191456),
+ (194560, 195101),
+ (196608, 201546),
+ (201552, 205743),
+];
+
+pub const OTHER_NUMBER: &'static [(u32, u32)] = &[
+ (178, 179),
+ (185, 185),
+ (188, 190),
+ (2548, 2553),
+ (2930, 2935),
+ (3056, 3058),
+ (3192, 3198),
+ (3416, 3422),
+ (3440, 3448),
+ (3882, 3891),
+ (4969, 4988),
+ (6128, 6137),
+ (6618, 6618),
+ (8304, 8304),
+ (8308, 8313),
+ (8320, 8329),
+ (8528, 8543),
+ (8585, 8585),
+ (9312, 9371),
+ (9450, 9471),
+ (10102, 10131),
+ (11517, 11517),
+ (12690, 12693),
+ (12832, 12841),
+ (12872, 12879),
+ (12881, 12895),
+ (12928, 12937),
+ (12977, 12991),
+ (43056, 43061),
+ (65799, 65843),
+ (65909, 65912),
+ (65930, 65931),
+ (66273, 66299),
+ (66336, 66339),
+ (67672, 67679),
+ (67705, 67711),
+ (67751, 67759),
+ (67835, 67839),
+ (67862, 67867),
+ (68028, 68029),
+ (68032, 68047),
+ (68050, 68095),
+ (68160, 68168),
+ (68221, 68222),
+ (68253, 68255),
+ (68331, 68335),
+ (68440, 68447),
+ (68472, 68479),
+ (68521, 68527),
+ (68858, 68863),
+ (69216, 69246),
+ (69405, 69414),
+ (69457, 69460),
+ (69573, 69579),
+ (69714, 69733),
+ (70113, 70132),
+ (71482, 71483),
+ (71914, 71922),
+ (72794, 72812),
+ (73664, 73684),
+ (93019, 93025),
+ (93824, 93846),
+ (119488, 119507),
+ (119520, 119539),
+ (119648, 119672),
+ (125127, 125135),
+ (126065, 126123),
+ (126125, 126127),
+ (126129, 126132),
+ (126209, 126253),
+ (126255, 126269),
+ (127232, 127244),
+];
+
+pub const OTHER_PUNCTUATION: &'static [(u32, u32)] = &[
+ (33, 35),
+ (37, 39),
+ (42, 42),
+ (44, 44),
+ (46, 47),
+ (58, 59),
+ (63, 64),
+ (92, 92),
+ (161, 161),
+ (167, 167),
+ (182, 183),
+ (191, 191),
+ (894, 894),
+ (903, 903),
+ (1370, 1375),
+ (1417, 1417),
+ (1472, 1472),
+ (1475, 1475),
+ (1478, 1478),
+ (1523, 1524),
+ (1545, 1546),
+ (1548, 1549),
+ (1563, 1563),
+ (1565, 1567),
+ (1642, 1645),
+ (1748, 1748),
+ (1792, 1805),
+ (2039, 2041),
+ (2096, 2110),
+ (2142, 2142),
+ (2404, 2405),
+ (2416, 2416),
+ (2557, 2557),
+ (2678, 2678),
+ (2800, 2800),
+ (3191, 3191),
+ (3204, 3204),
+ (3572, 3572),
+ (3663, 3663),
+ (3674, 3675),
+ (3844, 3858),
+ (3860, 3860),
+ (3973, 3973),
+ (4048, 4052),
+ (4057, 4058),
+ (4170, 4175),
+ (4347, 4347),
+ (4960, 4968),
+ (5742, 5742),
+ (5867, 5869),
+ (5941, 5942),
+ (6100, 6102),
+ (6104, 6106),
+ (6144, 6149),
+ (6151, 6154),
+ (6468, 6469),
+ (6686, 6687),
+ (6816, 6822),
+ (6824, 6829),
+ (7002, 7008),
+ (7037, 7038),
+ (7164, 7167),
+ (7227, 7231),
+ (7294, 7295),
+ (7360, 7367),
+ (7379, 7379),
+ (8214, 8215),
+ (8224, 8231),
+ (8240, 8248),
+ (8251, 8254),
+ (8257, 8259),
+ (8263, 8273),
+ (8275, 8275),
+ (8277, 8286),
+ (11513, 11516),
+ (11518, 11519),
+ (11632, 11632),
+ (11776, 11777),
+ (11782, 11784),
+ (11787, 11787),
+ (11790, 11798),
+ (11800, 11801),
+ (11803, 11803),
+ (11806, 11807),
+ (11818, 11822),
+ (11824, 11833),
+ (11836, 11839),
+ (11841, 11841),
+ (11843, 11855),
+ (11858, 11860),
+ (12289, 12291),
+ (12349, 12349),
+ (12539, 12539),
+ (42238, 42239),
+ (42509, 42511),
+ (42611, 42611),
+ (42622, 42622),
+ (42738, 42743),
+ (43124, 43127),
+ (43214, 43215),
+ (43256, 43258),
+ (43260, 43260),
+ (43310, 43311),
+ (43359, 43359),
+ (43457, 43469),
+ (43486, 43487),
+ (43612, 43615),
+ (43742, 43743),
+ (43760, 43761),
+ (44011, 44011),
+ (65040, 65046),
+ (65049, 65049),
+ (65072, 65072),
+ (65093, 65094),
+ (65097, 65100),
+ (65104, 65106),
+ (65108, 65111),
+ (65119, 65121),
+ (65128, 65128),
+ (65130, 65131),
+ (65281, 65283),
+ (65285, 65287),
+ (65290, 65290),
+ (65292, 65292),
+ (65294, 65295),
+ (65306, 65307),
+ (65311, 65312),
+ (65340, 65340),
+ (65377, 65377),
+ (65380, 65381),
+ (65792, 65794),
+ (66463, 66463),
+ (66512, 66512),
+ (66927, 66927),
+ (67671, 67671),
+ (67871, 67871),
+ (67903, 67903),
+ (68176, 68184),
+ (68223, 68223),
+ (68336, 68342),
+ (68409, 68415),
+ (68505, 68508),
+ (69461, 69465),
+ (69510, 69513),
+ (69703, 69709),
+ (69819, 69820),
+ (69822, 69825),
+ (69952, 69955),
+ (70004, 70005),
+ (70085, 70088),
+ (70093, 70093),
+ (70107, 70107),
+ (70109, 70111),
+ (70200, 70205),
+ (70313, 70313),
+ (70731, 70735),
+ (70746, 70747),
+ (70749, 70749),
+ (70854, 70854),
+ (71105, 71127),
+ (71233, 71235),
+ (71264, 71276),
+ (71353, 71353),
+ (71484, 71486),
+ (71739, 71739),
+ (72004, 72006),
+ (72162, 72162),
+ (72255, 72262),
+ (72346, 72348),
+ (72350, 72354),
+ (72448, 72457),
+ (72769, 72773),
+ (72816, 72817),
+ (73463, 73464),
+ (73539, 73551),
+ (73727, 73727),
+ (74864, 74868),
+ (77809, 77810),
+ (92782, 92783),
+ (92917, 92917),
+ (92983, 92987),
+ (92996, 92996),
+ (93847, 93850),
+ (94178, 94178),
+ (113823, 113823),
+ (121479, 121483),
+ (125278, 125279),
+];
+
+pub const OTHER_SYMBOL: &'static [(u32, u32)] = &[
+ (166, 166),
+ (169, 169),
+ (174, 174),
+ (176, 176),
+ (1154, 1154),
+ (1421, 1422),
+ (1550, 1551),
+ (1758, 1758),
+ (1769, 1769),
+ (1789, 1790),
+ (2038, 2038),
+ (2554, 2554),
+ (2928, 2928),
+ (3059, 3064),
+ (3066, 3066),
+ (3199, 3199),
+ (3407, 3407),
+ (3449, 3449),
+ (3841, 3843),
+ (3859, 3859),
+ (3861, 3863),
+ (3866, 3871),
+ (3892, 3892),
+ (3894, 3894),
+ (3896, 3896),
+ (4030, 4037),
+ (4039, 4044),
+ (4046, 4047),
+ (4053, 4056),
+ (4254, 4255),
+ (5008, 5017),
+ (5741, 5741),
+ (6464, 6464),
+ (6622, 6655),
+ (7009, 7018),
+ (7028, 7036),
+ (8448, 8449),
+ (8451, 8454),
+ (8456, 8457),
+ (8468, 8468),
+ (8470, 8471),
+ (8478, 8483),
+ (8485, 8485),
+ (8487, 8487),
+ (8489, 8489),
+ (8494, 8494),
+ (8506, 8507),
+ (8522, 8522),
+ (8524, 8525),
+ (8527, 8527),
+ (8586, 8587),
+ (8597, 8601),
+ (8604, 8607),
+ (8609, 8610),
+ (8612, 8613),
+ (8615, 8621),
+ (8623, 8653),
+ (8656, 8657),
+ (8659, 8659),
+ (8661, 8691),
+ (8960, 8967),
+ (8972, 8991),
+ (8994, 9000),
+ (9003, 9083),
+ (9085, 9114),
+ (9140, 9179),
+ (9186, 9254),
+ (9280, 9290),
+ (9372, 9449),
+ (9472, 9654),
+ (9656, 9664),
+ (9666, 9719),
+ (9728, 9838),
+ (9840, 10087),
+ (10132, 10175),
+ (10240, 10495),
+ (11008, 11055),
+ (11077, 11078),
+ (11085, 11123),
+ (11126, 11157),
+ (11159, 11263),
+ (11493, 11498),
+ (11856, 11857),
+ (11904, 11929),
+ (11931, 12019),
+ (12032, 12245),
+ (12272, 12283),
+ (12292, 12292),
+ (12306, 12307),
+ (12320, 12320),
+ (12342, 12343),
+ (12350, 12351),
+ (12688, 12689),
+ (12694, 12703),
+ (12736, 12771),
+ (12800, 12830),
+ (12842, 12871),
+ (12880, 12880),
+ (12896, 12927),
+ (12938, 12976),
+ (12992, 13311),
+ (19904, 19967),
+ (42128, 42182),
+ (43048, 43051),
+ (43062, 43063),
+ (43065, 43065),
+ (43639, 43641),
+ (64832, 64847),
+ (64975, 64975),
+ (65021, 65023),
+ (65508, 65508),
+ (65512, 65512),
+ (65517, 65518),
+ (65532, 65533),
+ (65847, 65855),
+ (65913, 65929),
+ (65932, 65934),
+ (65936, 65948),
+ (65952, 65952),
+ (66000, 66044),
+ (67703, 67704),
+ (68296, 68296),
+ (71487, 71487),
+ (73685, 73692),
+ (73697, 73713),
+ (92988, 92991),
+ (92997, 92997),
+ (113820, 113820),
+ (118608, 118723),
+ (118784, 119029),
+ (119040, 119078),
+ (119081, 119140),
+ (119146, 119148),
+ (119171, 119172),
+ (119180, 119209),
+ (119214, 119274),
+ (119296, 119361),
+ (119365, 119365),
+ (119552, 119638),
+ (120832, 121343),
+ (121399, 121402),
+ (121453, 121460),
+ (121462, 121475),
+ (121477, 121478),
+ (123215, 123215),
+ (126124, 126124),
+ (126254, 126254),
+ (126976, 127019),
+ (127024, 127123),
+ (127136, 127150),
+ (127153, 127167),
+ (127169, 127183),
+ (127185, 127221),
+ (127245, 127405),
+ (127462, 127490),
+ (127504, 127547),
+ (127552, 127560),
+ (127568, 127569),
+ (127584, 127589),
+ (127744, 127994),
+ (128000, 128727),
+ (128732, 128748),
+ (128752, 128764),
+ (128768, 128886),
+ (128891, 128985),
+ (128992, 129003),
+ (129008, 129008),
+ (129024, 129035),
+ (129040, 129095),
+ (129104, 129113),
+ (129120, 129159),
+ (129168, 129197),
+ (129200, 129201),
+ (129280, 129619),
+ (129632, 129645),
+ (129648, 129660),
+ (129664, 129672),
+ (129680, 129725),
+ (129727, 129733),
+ (129742, 129755),
+ (129760, 129768),
+ (129776, 129784),
+ (129792, 129938),
+ (129940, 129994),
+];
+
+pub const PARAGRAPH_SEPARATOR: &'static [(u32, u32)] = &[(8233, 8233)];
+
+pub const PRIVATE_USE: &'static [(u32, u32)] =
+ &[(57344, 63743), (983040, 1048573), (1048576, 1114109)];
+
+pub const PUNCTUATION: &'static [(u32, u32)] = &[
+ (33, 35),
+ (37, 42),
+ (44, 47),
+ (58, 59),
+ (63, 64),
+ (91, 93),
+ (95, 95),
+ (123, 123),
+ (125, 125),
+ (161, 161),
+ (167, 167),
+ (171, 171),
+ (182, 183),
+ (187, 187),
+ (191, 191),
+ (894, 894),
+ (903, 903),
+ (1370, 1375),
+ (1417, 1418),
+ (1470, 1470),
+ (1472, 1472),
+ (1475, 1475),
+ (1478, 1478),
+ (1523, 1524),
+ (1545, 1546),
+ (1548, 1549),
+ (1563, 1563),
+ (1565, 1567),
+ (1642, 1645),
+ (1748, 1748),
+ (1792, 1805),
+ (2039, 2041),
+ (2096, 2110),
+ (2142, 2142),
+ (2404, 2405),
+ (2416, 2416),
+ (2557, 2557),
+ (2678, 2678),
+ (2800, 2800),
+ (3191, 3191),
+ (3204, 3204),
+ (3572, 3572),
+ (3663, 3663),
+ (3674, 3675),
+ (3844, 3858),
+ (3860, 3860),
+ (3898, 3901),
+ (3973, 3973),
+ (4048, 4052),
+ (4057, 4058),
+ (4170, 4175),
+ (4347, 4347),
+ (4960, 4968),
+ (5120, 5120),
+ (5742, 5742),
+ (5787, 5788),
+ (5867, 5869),
+ (5941, 5942),
+ (6100, 6102),
+ (6104, 6106),
+ (6144, 6154),
+ (6468, 6469),
+ (6686, 6687),
+ (6816, 6822),
+ (6824, 6829),
+ (7002, 7008),
+ (7037, 7038),
+ (7164, 7167),
+ (7227, 7231),
+ (7294, 7295),
+ (7360, 7367),
+ (7379, 7379),
+ (8208, 8231),
+ (8240, 8259),
+ (8261, 8273),
+ (8275, 8286),
+ (8317, 8318),
+ (8333, 8334),
+ (8968, 8971),
+ (9001, 9002),
+ (10088, 10101),
+ (10181, 10182),
+ (10214, 10223),
+ (10627, 10648),
+ (10712, 10715),
+ (10748, 10749),
+ (11513, 11516),
+ (11518, 11519),
+ (11632, 11632),
+ (11776, 11822),
+ (11824, 11855),
+ (11858, 11869),
+ (12289, 12291),
+ (12296, 12305),
+ (12308, 12319),
+ (12336, 12336),
+ (12349, 12349),
+ (12448, 12448),
+ (12539, 12539),
+ (42238, 42239),
+ (42509, 42511),
+ (42611, 42611),
+ (42622, 42622),
+ (42738, 42743),
+ (43124, 43127),
+ (43214, 43215),
+ (43256, 43258),
+ (43260, 43260),
+ (43310, 43311),
+ (43359, 43359),
+ (43457, 43469),
+ (43486, 43487),
+ (43612, 43615),
+ (43742, 43743),
+ (43760, 43761),
+ (44011, 44011),
+ (64830, 64831),
+ (65040, 65049),
+ (65072, 65106),
+ (65108, 65121),
+ (65123, 65123),
+ (65128, 65128),
+ (65130, 65131),
+ (65281, 65283),
+ (65285, 65290),
+ (65292, 65295),
+ (65306, 65307),
+ (65311, 65312),
+ (65339, 65341),
+ (65343, 65343),
+ (65371, 65371),
+ (65373, 65373),
+ (65375, 65381),
+ (65792, 65794),
+ (66463, 66463),
+ (66512, 66512),
+ (66927, 66927),
+ (67671, 67671),
+ (67871, 67871),
+ (67903, 67903),
+ (68176, 68184),
+ (68223, 68223),
+ (68336, 68342),
+ (68409, 68415),
+ (68505, 68508),
+ (69293, 69293),
+ (69461, 69465),
+ (69510, 69513),
+ (69703, 69709),
+ (69819, 69820),
+ (69822, 69825),
+ (69952, 69955),
+ (70004, 70005),
+ (70085, 70088),
+ (70093, 70093),
+ (70107, 70107),
+ (70109, 70111),
+ (70200, 70205),
+ (70313, 70313),
+ (70731, 70735),
+ (70746, 70747),
+ (70749, 70749),
+ (70854, 70854),
+ (71105, 71127),
+ (71233, 71235),
+ (71264, 71276),
+ (71353, 71353),
+ (71484, 71486),
+ (71739, 71739),
+ (72004, 72006),
+ (72162, 72162),
+ (72255, 72262),
+ (72346, 72348),
+ (72350, 72354),
+ (72448, 72457),
+ (72769, 72773),
+ (72816, 72817),
+ (73463, 73464),
+ (73539, 73551),
+ (73727, 73727),
+ (74864, 74868),
+ (77809, 77810),
+ (92782, 92783),
+ (92917, 92917),
+ (92983, 92987),
+ (92996, 92996),
+ (93847, 93850),
+ (94178, 94178),
+ (113823, 113823),
+ (121479, 121483),
+ (125278, 125279),
+];
+
+pub const SEPARATOR: &'static [(u32, u32)] = &[
+ (32, 32),
+ (160, 160),
+ (5760, 5760),
+ (8192, 8202),
+ (8232, 8233),
+ (8239, 8239),
+ (8287, 8287),
+ (12288, 12288),
+];
+
+pub const SPACE_SEPARATOR: &'static [(u32, u32)] = &[
+ (32, 32),
+ (160, 160),
+ (5760, 5760),
+ (8192, 8202),
+ (8239, 8239),
+ (8287, 8287),
+ (12288, 12288),
+];
+
+pub const SPACING_MARK: &'static [(u32, u32)] = &[
+ (2307, 2307),
+ (2363, 2363),
+ (2366, 2368),
+ (2377, 2380),
+ (2382, 2383),
+ (2434, 2435),
+ (2494, 2496),
+ (2503, 2504),
+ (2507, 2508),
+ (2519, 2519),
+ (2563, 2563),
+ (2622, 2624),
+ (2691, 2691),
+ (2750, 2752),
+ (2761, 2761),
+ (2763, 2764),
+ (2818, 2819),
+ (2878, 2878),
+ (2880, 2880),
+ (2887, 2888),
+ (2891, 2892),
+ (2903, 2903),
+ (3006, 3007),
+ (3009, 3010),
+ (3014, 3016),
+ (3018, 3020),
+ (3031, 3031),
+ (3073, 3075),
+ (3137, 3140),
+ (3202, 3203),
+ (3262, 3262),
+ (3264, 3268),
+ (3271, 3272),
+ (3274, 3275),
+ (3285, 3286),
+ (3315, 3315),
+ (3330, 3331),
+ (3390, 3392),
+ (3398, 3400),
+ (3402, 3404),
+ (3415, 3415),
+ (3458, 3459),
+ (3535, 3537),
+ (3544, 3551),
+ (3570, 3571),
+ (3902, 3903),
+ (3967, 3967),
+ (4139, 4140),
+ (4145, 4145),
+ (4152, 4152),
+ (4155, 4156),
+ (4182, 4183),
+ (4194, 4196),
+ (4199, 4205),
+ (4227, 4228),
+ (4231, 4236),
+ (4239, 4239),
+ (4250, 4252),
+ (5909, 5909),
+ (5940, 5940),
+ (6070, 6070),
+ (6078, 6085),
+ (6087, 6088),
+ (6435, 6438),
+ (6441, 6443),
+ (6448, 6449),
+ (6451, 6456),
+ (6681, 6682),
+ (6741, 6741),
+ (6743, 6743),
+ (6753, 6753),
+ (6755, 6756),
+ (6765, 6770),
+ (6916, 6916),
+ (6965, 6965),
+ (6971, 6971),
+ (6973, 6977),
+ (6979, 6980),
+ (7042, 7042),
+ (7073, 7073),
+ (7078, 7079),
+ (7082, 7082),
+ (7143, 7143),
+ (7146, 7148),
+ (7150, 7150),
+ (7154, 7155),
+ (7204, 7211),
+ (7220, 7221),
+ (7393, 7393),
+ (7415, 7415),
+ (12334, 12335),
+ (43043, 43044),
+ (43047, 43047),
+ (43136, 43137),
+ (43188, 43203),
+ (43346, 43347),
+ (43395, 43395),
+ (43444, 43445),
+ (43450, 43451),
+ (43454, 43456),
+ (43567, 43568),
+ (43571, 43572),
+ (43597, 43597),
+ (43643, 43643),
+ (43645, 43645),
+ (43755, 43755),
+ (43758, 43759),
+ (43765, 43765),
+ (44003, 44004),
+ (44006, 44007),
+ (44009, 44010),
+ (44012, 44012),
+ (69632, 69632),
+ (69634, 69634),
+ (69762, 69762),
+ (69808, 69810),
+ (69815, 69816),
+ (69932, 69932),
+ (69957, 69958),
+ (70018, 70018),
+ (70067, 70069),
+ (70079, 70080),
+ (70094, 70094),
+ (70188, 70190),
+ (70194, 70195),
+ (70197, 70197),
+ (70368, 70370),
+ (70402, 70403),
+ (70462, 70463),
+ (70465, 70468),
+ (70471, 70472),
+ (70475, 70477),
+ (70487, 70487),
+ (70498, 70499),
+ (70709, 70711),
+ (70720, 70721),
+ (70725, 70725),
+ (70832, 70834),
+ (70841, 70841),
+ (70843, 70846),
+ (70849, 70849),
+ (71087, 71089),
+ (71096, 71099),
+ (71102, 71102),
+ (71216, 71218),
+ (71227, 71228),
+ (71230, 71230),
+ (71340, 71340),
+ (71342, 71343),
+ (71350, 71350),
+ (71456, 71457),
+ (71462, 71462),
+ (71724, 71726),
+ (71736, 71736),
+ (71984, 71989),
+ (71991, 71992),
+ (71997, 71997),
+ (72000, 72000),
+ (72002, 72002),
+ (72145, 72147),
+ (72156, 72159),
+ (72164, 72164),
+ (72249, 72249),
+ (72279, 72280),
+ (72343, 72343),
+ (72751, 72751),
+ (72766, 72766),
+ (72873, 72873),
+ (72881, 72881),
+ (72884, 72884),
+ (73098, 73102),
+ (73107, 73108),
+ (73110, 73110),
+ (73461, 73462),
+ (73475, 73475),
+ (73524, 73525),
+ (73534, 73535),
+ (73537, 73537),
+ (94033, 94087),
+ (94192, 94193),
+ (119141, 119142),
+ (119149, 119154),
+];
+
+pub const SURROGATE: &'static [(u32, u32)] = &[(55296, 57343)];
+
+pub const SYMBOL: &'static [(u32, u32)] = &[
+ (36, 36),
+ (43, 43),
+ (60, 62),
+ (94, 94),
+ (96, 96),
+ (124, 124),
+ (126, 126),
+ (162, 166),
+ (168, 169),
+ (172, 172),
+ (174, 177),
+ (180, 180),
+ (184, 184),
+ (215, 215),
+ (247, 247),
+ (706, 709),
+ (722, 735),
+ (741, 747),
+ (749, 749),
+ (751, 767),
+ (885, 885),
+ (900, 901),
+ (1014, 1014),
+ (1154, 1154),
+ (1421, 1423),
+ (1542, 1544),
+ (1547, 1547),
+ (1550, 1551),
+ (1758, 1758),
+ (1769, 1769),
+ (1789, 1790),
+ (2038, 2038),
+ (2046, 2047),
+ (2184, 2184),
+ (2546, 2547),
+ (2554, 2555),
+ (2801, 2801),
+ (2928, 2928),
+ (3059, 3066),
+ (3199, 3199),
+ (3407, 3407),
+ (3449, 3449),
+ (3647, 3647),
+ (3841, 3843),
+ (3859, 3859),
+ (3861, 3863),
+ (3866, 3871),
+ (3892, 3892),
+ (3894, 3894),
+ (3896, 3896),
+ (4030, 4037),
+ (4039, 4044),
+ (4046, 4047),
+ (4053, 4056),
+ (4254, 4255),
+ (5008, 5017),
+ (5741, 5741),
+ (6107, 6107),
+ (6464, 6464),
+ (6622, 6655),
+ (7009, 7018),
+ (7028, 7036),
+ (8125, 8125),
+ (8127, 8129),
+ (8141, 8143),
+ (8157, 8159),
+ (8173, 8175),
+ (8189, 8190),
+ (8260, 8260),
+ (8274, 8274),
+ (8314, 8316),
+ (8330, 8332),
+ (8352, 8384),
+ (8448, 8449),
+ (8451, 8454),
+ (8456, 8457),
+ (8468, 8468),
+ (8470, 8472),
+ (8478, 8483),
+ (8485, 8485),
+ (8487, 8487),
+ (8489, 8489),
+ (8494, 8494),
+ (8506, 8507),
+ (8512, 8516),
+ (8522, 8525),
+ (8527, 8527),
+ (8586, 8587),
+ (8592, 8967),
+ (8972, 9000),
+ (9003, 9254),
+ (9280, 9290),
+ (9372, 9449),
+ (9472, 10087),
+ (10132, 10180),
+ (10183, 10213),
+ (10224, 10626),
+ (10649, 10711),
+ (10716, 10747),
+ (10750, 11123),
+ (11126, 11157),
+ (11159, 11263),
+ (11493, 11498),
+ (11856, 11857),
+ (11904, 11929),
+ (11931, 12019),
+ (12032, 12245),
+ (12272, 12283),
+ (12292, 12292),
+ (12306, 12307),
+ (12320, 12320),
+ (12342, 12343),
+ (12350, 12351),
+ (12443, 12444),
+ (12688, 12689),
+ (12694, 12703),
+ (12736, 12771),
+ (12800, 12830),
+ (12842, 12871),
+ (12880, 12880),
+ (12896, 12927),
+ (12938, 12976),
+ (12992, 13311),
+ (19904, 19967),
+ (42128, 42182),
+ (42752, 42774),
+ (42784, 42785),
+ (42889, 42890),
+ (43048, 43051),
+ (43062, 43065),
+ (43639, 43641),
+ (43867, 43867),
+ (43882, 43883),
+ (64297, 64297),
+ (64434, 64450),
+ (64832, 64847),
+ (64975, 64975),
+ (65020, 65023),
+ (65122, 65122),
+ (65124, 65126),
+ (65129, 65129),
+ (65284, 65284),
+ (65291, 65291),
+ (65308, 65310),
+ (65342, 65342),
+ (65344, 65344),
+ (65372, 65372),
+ (65374, 65374),
+ (65504, 65510),
+ (65512, 65518),
+ (65532, 65533),
+ (65847, 65855),
+ (65913, 65929),
+ (65932, 65934),
+ (65936, 65948),
+ (65952, 65952),
+ (66000, 66044),
+ (67703, 67704),
+ (68296, 68296),
+ (71487, 71487),
+ (73685, 73713),
+ (92988, 92991),
+ (92997, 92997),
+ (113820, 113820),
+ (118608, 118723),
+ (118784, 119029),
+ (119040, 119078),
+ (119081, 119140),
+ (119146, 119148),
+ (119171, 119172),
+ (119180, 119209),
+ (119214, 119274),
+ (119296, 119361),
+ (119365, 119365),
+ (119552, 119638),
+ (120513, 120513),
+ (120539, 120539),
+ (120571, 120571),
+ (120597, 120597),
+ (120629, 120629),
+ (120655, 120655),
+ (120687, 120687),
+ (120713, 120713),
+ (120745, 120745),
+ (120771, 120771),
+ (120832, 121343),
+ (121399, 121402),
+ (121453, 121460),
+ (121462, 121475),
+ (121477, 121478),
+ (123215, 123215),
+ (123647, 123647),
+ (126124, 126124),
+ (126128, 126128),
+ (126254, 126254),
+ (126704, 126705),
+ (126976, 127019),
+ (127024, 127123),
+ (127136, 127150),
+ (127153, 127167),
+ (127169, 127183),
+ (127185, 127221),
+ (127245, 127405),
+ (127462, 127490),
+ (127504, 127547),
+ (127552, 127560),
+ (127568, 127569),
+ (127584, 127589),
+ (127744, 128727),
+ (128732, 128748),
+ (128752, 128764),
+ (128768, 128886),
+ (128891, 128985),
+ (128992, 129003),
+ (129008, 129008),
+ (129024, 129035),
+ (129040, 129095),
+ (129104, 129113),
+ (129120, 129159),
+ (129168, 129197),
+ (129200, 129201),
+ (129280, 129619),
+ (129632, 129645),
+ (129648, 129660),
+ (129664, 129672),
+ (129680, 129725),
+ (129727, 129733),
+ (129742, 129755),
+ (129760, 129768),
+ (129776, 129784),
+ (129792, 129938),
+ (129940, 129994),
+];
+
+pub const TITLECASE_LETTER: &'static [(u32, u32)] = &[
+ (453, 453),
+ (456, 456),
+ (459, 459),
+ (498, 498),
+ (8072, 8079),
+ (8088, 8095),
+ (8104, 8111),
+ (8124, 8124),
+ (8140, 8140),
+ (8188, 8188),
+];
+
+pub const UNASSIGNED: &'static [(u32, u32)] = &[
+ (888, 889),
+ (896, 899),
+ (907, 907),
+ (909, 909),
+ (930, 930),
+ (1328, 1328),
+ (1367, 1368),
+ (1419, 1420),
+ (1424, 1424),
+ (1480, 1487),
+ (1515, 1518),
+ (1525, 1535),
+ (1806, 1806),
+ (1867, 1868),
+ (1970, 1983),
+ (2043, 2044),
+ (2094, 2095),
+ (2111, 2111),
+ (2140, 2141),
+ (2143, 2143),
+ (2155, 2159),
+ (2191, 2191),
+ (2194, 2199),
+ (2436, 2436),
+ (2445, 2446),
+ (2449, 2450),
+ (2473, 2473),
+ (2481, 2481),
+ (2483, 2485),
+ (2490, 2491),
+ (2501, 2502),
+ (2505, 2506),
+ (2511, 2518),
+ (2520, 2523),
+ (2526, 2526),
+ (2532, 2533),
+ (2559, 2560),
+ (2564, 2564),
+ (2571, 2574),
+ (2577, 2578),
+ (2601, 2601),
+ (2609, 2609),
+ (2612, 2612),
+ (2615, 2615),
+ (2618, 2619),
+ (2621, 2621),
+ (2627, 2630),
+ (2633, 2634),
+ (2638, 2640),
+ (2642, 2648),
+ (2653, 2653),
+ (2655, 2661),
+ (2679, 2688),
+ (2692, 2692),
+ (2702, 2702),
+ (2706, 2706),
+ (2729, 2729),
+ (2737, 2737),
+ (2740, 2740),
+ (2746, 2747),
+ (2758, 2758),
+ (2762, 2762),
+ (2766, 2767),
+ (2769, 2783),
+ (2788, 2789),
+ (2802, 2808),
+ (2816, 2816),
+ (2820, 2820),
+ (2829, 2830),
+ (2833, 2834),
+ (2857, 2857),
+ (2865, 2865),
+ (2868, 2868),
+ (2874, 2875),
+ (2885, 2886),
+ (2889, 2890),
+ (2894, 2900),
+ (2904, 2907),
+ (2910, 2910),
+ (2916, 2917),
+ (2936, 2945),
+ (2948, 2948),
+ (2955, 2957),
+ (2961, 2961),
+ (2966, 2968),
+ (2971, 2971),
+ (2973, 2973),
+ (2976, 2978),
+ (2981, 2983),
+ (2987, 2989),
+ (3002, 3005),
+ (3011, 3013),
+ (3017, 3017),
+ (3022, 3023),
+ (3025, 3030),
+ (3032, 3045),
+ (3067, 3071),
+ (3085, 3085),
+ (3089, 3089),
+ (3113, 3113),
+ (3130, 3131),
+ (3141, 3141),
+ (3145, 3145),
+ (3150, 3156),
+ (3159, 3159),
+ (3163, 3164),
+ (3166, 3167),
+ (3172, 3173),
+ (3184, 3190),
+ (3213, 3213),
+ (3217, 3217),
+ (3241, 3241),
+ (3252, 3252),
+ (3258, 3259),
+ (3269, 3269),
+ (3273, 3273),
+ (3278, 3284),
+ (3287, 3292),
+ (3295, 3295),
+ (3300, 3301),
+ (3312, 3312),
+ (3316, 3327),
+ (3341, 3341),
+ (3345, 3345),
+ (3397, 3397),
+ (3401, 3401),
+ (3408, 3411),
+ (3428, 3429),
+ (3456, 3456),
+ (3460, 3460),
+ (3479, 3481),
+ (3506, 3506),
+ (3516, 3516),
+ (3518, 3519),
+ (3527, 3529),
+ (3531, 3534),
+ (3541, 3541),
+ (3543, 3543),
+ (3552, 3557),
+ (3568, 3569),
+ (3573, 3584),
+ (3643, 3646),
+ (3676, 3712),
+ (3715, 3715),
+ (3717, 3717),
+ (3723, 3723),
+ (3748, 3748),
+ (3750, 3750),
+ (3774, 3775),
+ (3781, 3781),
+ (3783, 3783),
+ (3791, 3791),
+ (3802, 3803),
+ (3808, 3839),
+ (3912, 3912),
+ (3949, 3952),
+ (3992, 3992),
+ (4029, 4029),
+ (4045, 4045),
+ (4059, 4095),
+ (4294, 4294),
+ (4296, 4300),
+ (4302, 4303),
+ (4681, 4681),
+ (4686, 4687),
+ (4695, 4695),
+ (4697, 4697),
+ (4702, 4703),
+ (4745, 4745),
+ (4750, 4751),
+ (4785, 4785),
+ (4790, 4791),
+ (4799, 4799),
+ (4801, 4801),
+ (4806, 4807),
+ (4823, 4823),
+ (4881, 4881),
+ (4886, 4887),
+ (4955, 4956),
+ (4989, 4991),
+ (5018, 5023),
+ (5110, 5111),
+ (5118, 5119),
+ (5789, 5791),
+ (5881, 5887),
+ (5910, 5918),
+ (5943, 5951),
+ (5972, 5983),
+ (5997, 5997),
+ (6001, 6001),
+ (6004, 6015),
+ (6110, 6111),
+ (6122, 6127),
+ (6138, 6143),
+ (6170, 6175),
+ (6265, 6271),
+ (6315, 6319),
+ (6390, 6399),
+ (6431, 6431),
+ (6444, 6447),
+ (6460, 6463),
+ (6465, 6467),
+ (6510, 6511),
+ (6517, 6527),
+ (6572, 6575),
+ (6602, 6607),
+ (6619, 6621),
+ (6684, 6685),
+ (6751, 6751),
+ (6781, 6782),
+ (6794, 6799),
+ (6810, 6815),
+ (6830, 6831),
+ (6863, 6911),
+ (6989, 6991),
+ (7039, 7039),
+ (7156, 7163),
+ (7224, 7226),
+ (7242, 7244),
+ (7305, 7311),
+ (7355, 7356),
+ (7368, 7375),
+ (7419, 7423),
+ (7958, 7959),
+ (7966, 7967),
+ (8006, 8007),
+ (8014, 8015),
+ (8024, 8024),
+ (8026, 8026),
+ (8028, 8028),
+ (8030, 8030),
+ (8062, 8063),
+ (8117, 8117),
+ (8133, 8133),
+ (8148, 8149),
+ (8156, 8156),
+ (8176, 8177),
+ (8181, 8181),
+ (8191, 8191),
+ (8293, 8293),
+ (8306, 8307),
+ (8335, 8335),
+ (8349, 8351),
+ (8385, 8399),
+ (8433, 8447),
+ (8588, 8591),
+ (9255, 9279),
+ (9291, 9311),
+ (11124, 11125),
+ (11158, 11158),
+ (11508, 11512),
+ (11558, 11558),
+ (11560, 11564),
+ (11566, 11567),
+ (11624, 11630),
+ (11633, 11646),
+ (11671, 11679),
+ (11687, 11687),
+ (11695, 11695),
+ (11703, 11703),
+ (11711, 11711),
+ (11719, 11719),
+ (11727, 11727),
+ (11735, 11735),
+ (11743, 11743),
+ (11870, 11903),
+ (11930, 11930),
+ (12020, 12031),
+ (12246, 12271),
+ (12284, 12287),
+ (12352, 12352),
+ (12439, 12440),
+ (12544, 12548),
+ (12592, 12592),
+ (12687, 12687),
+ (12772, 12783),
+ (12831, 12831),
+ (42125, 42127),
+ (42183, 42191),
+ (42540, 42559),
+ (42744, 42751),
+ (42955, 42959),
+ (42962, 42962),
+ (42964, 42964),
+ (42970, 42993),
+ (43053, 43055),
+ (43066, 43071),
+ (43128, 43135),
+ (43206, 43213),
+ (43226, 43231),
+ (43348, 43358),
+ (43389, 43391),
+ (43470, 43470),
+ (43482, 43485),
+ (43519, 43519),
+ (43575, 43583),
+ (43598, 43599),
+ (43610, 43611),
+ (43715, 43738),
+ (43767, 43776),
+ (43783, 43784),
+ (43791, 43792),
+ (43799, 43807),
+ (43815, 43815),
+ (43823, 43823),
+ (43884, 43887),
+ (44014, 44015),
+ (44026, 44031),
+ (55204, 55215),
+ (55239, 55242),
+ (55292, 55295),
+ (64110, 64111),
+ (64218, 64255),
+ (64263, 64274),
+ (64280, 64284),
+ (64311, 64311),
+ (64317, 64317),
+ (64319, 64319),
+ (64322, 64322),
+ (64325, 64325),
+ (64451, 64466),
+ (64912, 64913),
+ (64968, 64974),
+ (64976, 65007),
+ (65050, 65055),
+ (65107, 65107),
+ (65127, 65127),
+ (65132, 65135),
+ (65141, 65141),
+ (65277, 65278),
+ (65280, 65280),
+ (65471, 65473),
+ (65480, 65481),
+ (65488, 65489),
+ (65496, 65497),
+ (65501, 65503),
+ (65511, 65511),
+ (65519, 65528),
+ (65534, 65535),
+ (65548, 65548),
+ (65575, 65575),
+ (65595, 65595),
+ (65598, 65598),
+ (65614, 65615),
+ (65630, 65663),
+ (65787, 65791),
+ (65795, 65798),
+ (65844, 65846),
+ (65935, 65935),
+ (65949, 65951),
+ (65953, 65999),
+ (66046, 66175),
+ (66205, 66207),
+ (66257, 66271),
+ (66300, 66303),
+ (66340, 66348),
+ (66379, 66383),
+ (66427, 66431),
+ (66462, 66462),
+ (66500, 66503),
+ (66518, 66559),
+ (66718, 66719),
+ (66730, 66735),
+ (66772, 66775),
+ (66812, 66815),
+ (66856, 66863),
+ (66916, 66926),
+ (66939, 66939),
+ (66955, 66955),
+ (66963, 66963),
+ (66966, 66966),
+ (66978, 66978),
+ (66994, 66994),
+ (67002, 67002),
+ (67005, 67071),
+ (67383, 67391),
+ (67414, 67423),
+ (67432, 67455),
+ (67462, 67462),
+ (67505, 67505),
+ (67515, 67583),
+ (67590, 67591),
+ (67593, 67593),
+ (67638, 67638),
+ (67641, 67643),
+ (67645, 67646),
+ (67670, 67670),
+ (67743, 67750),
+ (67760, 67807),
+ (67827, 67827),
+ (67830, 67834),
+ (67868, 67870),
+ (67898, 67902),
+ (67904, 67967),
+ (68024, 68027),
+ (68048, 68049),
+ (68100, 68100),
+ (68103, 68107),
+ (68116, 68116),
+ (68120, 68120),
+ (68150, 68151),
+ (68155, 68158),
+ (68169, 68175),
+ (68185, 68191),
+ (68256, 68287),
+ (68327, 68330),
+ (68343, 68351),
+ (68406, 68408),
+ (68438, 68439),
+ (68467, 68471),
+ (68498, 68504),
+ (68509, 68520),
+ (68528, 68607),
+ (68681, 68735),
+ (68787, 68799),
+ (68851, 68857),
+ (68904, 68911),
+ (68922, 69215),
+ (69247, 69247),
+ (69290, 69290),
+ (69294, 69295),
+ (69298, 69372),
+ (69416, 69423),
+ (69466, 69487),
+ (69514, 69551),
+ (69580, 69599),
+ (69623, 69631),
+ (69710, 69713),
+ (69750, 69758),
+ (69827, 69836),
+ (69838, 69839),
+ (69865, 69871),
+ (69882, 69887),
+ (69941, 69941),
+ (69960, 69967),
+ (70007, 70015),
+ (70112, 70112),
+ (70133, 70143),
+ (70162, 70162),
+ (70210, 70271),
+ (70279, 70279),
+ (70281, 70281),
+ (70286, 70286),
+ (70302, 70302),
+ (70314, 70319),
+ (70379, 70383),
+ (70394, 70399),
+ (70404, 70404),
+ (70413, 70414),
+ (70417, 70418),
+ (70441, 70441),
+ (70449, 70449),
+ (70452, 70452),
+ (70458, 70458),
+ (70469, 70470),
+ (70473, 70474),
+ (70478, 70479),
+ (70481, 70486),
+ (70488, 70492),
+ (70500, 70501),
+ (70509, 70511),
+ (70517, 70655),
+ (70748, 70748),
+ (70754, 70783),
+ (70856, 70863),
+ (70874, 71039),
+ (71094, 71095),
+ (71134, 71167),
+ (71237, 71247),
+ (71258, 71263),
+ (71277, 71295),
+ (71354, 71359),
+ (71370, 71423),
+ (71451, 71452),
+ (71468, 71471),
+ (71495, 71679),
+ (71740, 71839),
+ (71923, 71934),
+ (71943, 71944),
+ (71946, 71947),
+ (71956, 71956),
+ (71959, 71959),
+ (71990, 71990),
+ (71993, 71994),
+ (72007, 72015),
+ (72026, 72095),
+ (72104, 72105),
+ (72152, 72153),
+ (72165, 72191),
+ (72264, 72271),
+ (72355, 72367),
+ (72441, 72447),
+ (72458, 72703),
+ (72713, 72713),
+ (72759, 72759),
+ (72774, 72783),
+ (72813, 72815),
+ (72848, 72849),
+ (72872, 72872),
+ (72887, 72959),
+ (72967, 72967),
+ (72970, 72970),
+ (73015, 73017),
+ (73019, 73019),
+ (73022, 73022),
+ (73032, 73039),
+ (73050, 73055),
+ (73062, 73062),
+ (73065, 73065),
+ (73103, 73103),
+ (73106, 73106),
+ (73113, 73119),
+ (73130, 73439),
+ (73465, 73471),
+ (73489, 73489),
+ (73531, 73533),
+ (73562, 73647),
+ (73649, 73663),
+ (73714, 73726),
+ (74650, 74751),
+ (74863, 74863),
+ (74869, 74879),
+ (75076, 77711),
+ (77811, 77823),
+ (78934, 82943),
+ (83527, 92159),
+ (92729, 92735),
+ (92767, 92767),
+ (92778, 92781),
+ (92863, 92863),
+ (92874, 92879),
+ (92910, 92911),
+ (92918, 92927),
+ (92998, 93007),
+ (93018, 93018),
+ (93026, 93026),
+ (93048, 93052),
+ (93072, 93759),
+ (93851, 93951),
+ (94027, 94030),
+ (94088, 94094),
+ (94112, 94175),
+ (94181, 94191),
+ (94194, 94207),
+ (100344, 100351),
+ (101590, 101631),
+ (101641, 110575),
+ (110580, 110580),
+ (110588, 110588),
+ (110591, 110591),
+ (110883, 110897),
+ (110899, 110927),
+ (110931, 110932),
+ (110934, 110947),
+ (110952, 110959),
+ (111356, 113663),
+ (113771, 113775),
+ (113789, 113791),
+ (113801, 113807),
+ (113818, 113819),
+ (113828, 118527),
+ (118574, 118575),
+ (118599, 118607),
+ (118724, 118783),
+ (119030, 119039),
+ (119079, 119080),
+ (119275, 119295),
+ (119366, 119487),
+ (119508, 119519),
+ (119540, 119551),
+ (119639, 119647),
+ (119673, 119807),
+ (119893, 119893),
+ (119965, 119965),
+ (119968, 119969),
+ (119971, 119972),
+ (119975, 119976),
+ (119981, 119981),
+ (119994, 119994),
+ (119996, 119996),
+ (120004, 120004),
+ (120070, 120070),
+ (120075, 120076),
+ (120085, 120085),
+ (120093, 120093),
+ (120122, 120122),
+ (120127, 120127),
+ (120133, 120133),
+ (120135, 120137),
+ (120145, 120145),
+ (120486, 120487),
+ (120780, 120781),
+ (121484, 121498),
+ (121504, 121504),
+ (121520, 122623),
+ (122655, 122660),
+ (122667, 122879),
+ (122887, 122887),
+ (122905, 122906),
+ (122914, 122914),
+ (122917, 122917),
+ (122923, 122927),
+ (122990, 123022),
+ (123024, 123135),
+ (123181, 123183),
+ (123198, 123199),
+ (123210, 123213),
+ (123216, 123535),
+ (123567, 123583),
+ (123642, 123646),
+ (123648, 124111),
+ (124154, 124895),
+ (124903, 124903),
+ (124908, 124908),
+ (124911, 124911),
+ (124927, 124927),
+ (125125, 125126),
+ (125143, 125183),
+ (125260, 125263),
+ (125274, 125277),
+ (125280, 126064),
+ (126133, 126208),
+ (126270, 126463),
+ (126468, 126468),
+ (126496, 126496),
+ (126499, 126499),
+ (126501, 126502),
+ (126504, 126504),
+ (126515, 126515),
+ (126520, 126520),
+ (126522, 126522),
+ (126524, 126529),
+ (126531, 126534),
+ (126536, 126536),
+ (126538, 126538),
+ (126540, 126540),
+ (126544, 126544),
+ (126547, 126547),
+ (126549, 126550),
+ (126552, 126552),
+ (126554, 126554),
+ (126556, 126556),
+ (126558, 126558),
+ (126560, 126560),
+ (126563, 126563),
+ (126565, 126566),
+ (126571, 126571),
+ (126579, 126579),
+ (126584, 126584),
+ (126589, 126589),
+ (126591, 126591),
+ (126602, 126602),
+ (126620, 126624),
+ (126628, 126628),
+ (126634, 126634),
+ (126652, 126703),
+ (126706, 126975),
+ (127020, 127023),
+ (127124, 127135),
+ (127151, 127152),
+ (127168, 127168),
+ (127184, 127184),
+ (127222, 127231),
+ (127406, 127461),
+ (127491, 127503),
+ (127548, 127551),
+ (127561, 127567),
+ (127570, 127583),
+ (127590, 127743),
+ (128728, 128731),
+ (128749, 128751),
+ (128765, 128767),
+ (128887, 128890),
+ (128986, 128991),
+ (129004, 129007),
+ (129009, 129023),
+ (129036, 129039),
+ (129096, 129103),
+ (129114, 129119),
+ (129160, 129167),
+ (129198, 129199),
+ (129202, 129279),
+ (129620, 129631),
+ (129646, 129647),
+ (129661, 129663),
+ (129673, 129679),
+ (129726, 129726),
+ (129734, 129741),
+ (129756, 129759),
+ (129769, 129775),
+ (129785, 129791),
+ (129939, 129939),
+ (129995, 130031),
+ (130042, 131071),
+ (173792, 173823),
+ (177978, 177983),
+ (178206, 178207),
+ (183970, 183983),
+ (191457, 194559),
+ (195102, 196607),
+ (201547, 201551),
+ (205744, 917504),
+ (917506, 917535),
+ (917632, 917759),
+ (918000, 983039),
+ (1048574, 1048575),
+ (1114110, 1114111),
+];
+
+pub const UPPERCASE_LETTER: &'static [(u32, u32)] = &[
+ (65, 90),
+ (192, 214),
+ (216, 222),
+ (256, 256),
+ (258, 258),
+ (260, 260),
+ (262, 262),
+ (264, 264),
+ (266, 266),
+ (268, 268),
+ (270, 270),
+ (272, 272),
+ (274, 274),
+ (276, 276),
+ (278, 278),
+ (280, 280),
+ (282, 282),
+ (284, 284),
+ (286, 286),
+ (288, 288),
+ (290, 290),
+ (292, 292),
+ (294, 294),
+ (296, 296),
+ (298, 298),
+ (300, 300),
+ (302, 302),
+ (304, 304),
+ (306, 306),
+ (308, 308),
+ (310, 310),
+ (313, 313),
+ (315, 315),
+ (317, 317),
+ (319, 319),
+ (321, 321),
+ (323, 323),
+ (325, 325),
+ (327, 327),
+ (330, 330),
+ (332, 332),
+ (334, 334),
+ (336, 336),
+ (338, 338),
+ (340, 340),
+ (342, 342),
+ (344, 344),
+ (346, 346),
+ (348, 348),
+ (350, 350),
+ (352, 352),
+ (354, 354),
+ (356, 356),
+ (358, 358),
+ (360, 360),
+ (362, 362),
+ (364, 364),
+ (366, 366),
+ (368, 368),
+ (370, 370),
+ (372, 372),
+ (374, 374),
+ (376, 377),
+ (379, 379),
+ (381, 381),
+ (385, 386),
+ (388, 388),
+ (390, 391),
+ (393, 395),
+ (398, 401),
+ (403, 404),
+ (406, 408),
+ (412, 413),
+ (415, 416),
+ (418, 418),
+ (420, 420),
+ (422, 423),
+ (425, 425),
+ (428, 428),
+ (430, 431),
+ (433, 435),
+ (437, 437),
+ (439, 440),
+ (444, 444),
+ (452, 452),
+ (455, 455),
+ (458, 458),
+ (461, 461),
+ (463, 463),
+ (465, 465),
+ (467, 467),
+ (469, 469),
+ (471, 471),
+ (473, 473),
+ (475, 475),
+ (478, 478),
+ (480, 480),
+ (482, 482),
+ (484, 484),
+ (486, 486),
+ (488, 488),
+ (490, 490),
+ (492, 492),
+ (494, 494),
+ (497, 497),
+ (500, 500),
+ (502, 504),
+ (506, 506),
+ (508, 508),
+ (510, 510),
+ (512, 512),
+ (514, 514),
+ (516, 516),
+ (518, 518),
+ (520, 520),
+ (522, 522),
+ (524, 524),
+ (526, 526),
+ (528, 528),
+ (530, 530),
+ (532, 532),
+ (534, 534),
+ (536, 536),
+ (538, 538),
+ (540, 540),
+ (542, 542),
+ (544, 544),
+ (546, 546),
+ (548, 548),
+ (550, 550),
+ (552, 552),
+ (554, 554),
+ (556, 556),
+ (558, 558),
+ (560, 560),
+ (562, 562),
+ (570, 571),
+ (573, 574),
+ (577, 577),
+ (579, 582),
+ (584, 584),
+ (586, 586),
+ (588, 588),
+ (590, 590),
+ (880, 880),
+ (882, 882),
+ (886, 886),
+ (895, 895),
+ (902, 902),
+ (904, 906),
+ (908, 908),
+ (910, 911),
+ (913, 929),
+ (931, 939),
+ (975, 975),
+ (978, 980),
+ (984, 984),
+ (986, 986),
+ (988, 988),
+ (990, 990),
+ (992, 992),
+ (994, 994),
+ (996, 996),
+ (998, 998),
+ (1000, 1000),
+ (1002, 1002),
+ (1004, 1004),
+ (1006, 1006),
+ (1012, 1012),
+ (1015, 1015),
+ (1017, 1018),
+ (1021, 1071),
+ (1120, 1120),
+ (1122, 1122),
+ (1124, 1124),
+ (1126, 1126),
+ (1128, 1128),
+ (1130, 1130),
+ (1132, 1132),
+ (1134, 1134),
+ (1136, 1136),
+ (1138, 1138),
+ (1140, 1140),
+ (1142, 1142),
+ (1144, 1144),
+ (1146, 1146),
+ (1148, 1148),
+ (1150, 1150),
+ (1152, 1152),
+ (1162, 1162),
+ (1164, 1164),
+ (1166, 1166),
+ (1168, 1168),
+ (1170, 1170),
+ (1172, 1172),
+ (1174, 1174),
+ (1176, 1176),
+ (1178, 1178),
+ (1180, 1180),
+ (1182, 1182),
+ (1184, 1184),
+ (1186, 1186),
+ (1188, 1188),
+ (1190, 1190),
+ (1192, 1192),
+ (1194, 1194),
+ (1196, 1196),
+ (1198, 1198),
+ (1200, 1200),
+ (1202, 1202),
+ (1204, 1204),
+ (1206, 1206),
+ (1208, 1208),
+ (1210, 1210),
+ (1212, 1212),
+ (1214, 1214),
+ (1216, 1217),
+ (1219, 1219),
+ (1221, 1221),
+ (1223, 1223),
+ (1225, 1225),
+ (1227, 1227),
+ (1229, 1229),
+ (1232, 1232),
+ (1234, 1234),
+ (1236, 1236),
+ (1238, 1238),
+ (1240, 1240),
+ (1242, 1242),
+ (1244, 1244),
+ (1246, 1246),
+ (1248, 1248),
+ (1250, 1250),
+ (1252, 1252),
+ (1254, 1254),
+ (1256, 1256),
+ (1258, 1258),
+ (1260, 1260),
+ (1262, 1262),
+ (1264, 1264),
+ (1266, 1266),
+ (1268, 1268),
+ (1270, 1270),
+ (1272, 1272),
+ (1274, 1274),
+ (1276, 1276),
+ (1278, 1278),
+ (1280, 1280),
+ (1282, 1282),
+ (1284, 1284),
+ (1286, 1286),
+ (1288, 1288),
+ (1290, 1290),
+ (1292, 1292),
+ (1294, 1294),
+ (1296, 1296),
+ (1298, 1298),
+ (1300, 1300),
+ (1302, 1302),
+ (1304, 1304),
+ (1306, 1306),
+ (1308, 1308),
+ (1310, 1310),
+ (1312, 1312),
+ (1314, 1314),
+ (1316, 1316),
+ (1318, 1318),
+ (1320, 1320),
+ (1322, 1322),
+ (1324, 1324),
+ (1326, 1326),
+ (1329, 1366),
+ (4256, 4293),
+ (4295, 4295),
+ (4301, 4301),
+ (5024, 5109),
+ (7312, 7354),
+ (7357, 7359),
+ (7680, 7680),
+ (7682, 7682),
+ (7684, 7684),
+ (7686, 7686),
+ (7688, 7688),
+ (7690, 7690),
+ (7692, 7692),
+ (7694, 7694),
+ (7696, 7696),
+ (7698, 7698),
+ (7700, 7700),
+ (7702, 7702),
+ (7704, 7704),
+ (7706, 7706),
+ (7708, 7708),
+ (7710, 7710),
+ (7712, 7712),
+ (7714, 7714),
+ (7716, 7716),
+ (7718, 7718),
+ (7720, 7720),
+ (7722, 7722),
+ (7724, 7724),
+ (7726, 7726),
+ (7728, 7728),
+ (7730, 7730),
+ (7732, 7732),
+ (7734, 7734),
+ (7736, 7736),
+ (7738, 7738),
+ (7740, 7740),
+ (7742, 7742),
+ (7744, 7744),
+ (7746, 7746),
+ (7748, 7748),
+ (7750, 7750),
+ (7752, 7752),
+ (7754, 7754),
+ (7756, 7756),
+ (7758, 7758),
+ (7760, 7760),
+ (7762, 7762),
+ (7764, 7764),
+ (7766, 7766),
+ (7768, 7768),
+ (7770, 7770),
+ (7772, 7772),
+ (7774, 7774),
+ (7776, 7776),
+ (7778, 7778),
+ (7780, 7780),
+ (7782, 7782),
+ (7784, 7784),
+ (7786, 7786),
+ (7788, 7788),
+ (7790, 7790),
+ (7792, 7792),
+ (7794, 7794),
+ (7796, 7796),
+ (7798, 7798),
+ (7800, 7800),
+ (7802, 7802),
+ (7804, 7804),
+ (7806, 7806),
+ (7808, 7808),
+ (7810, 7810),
+ (7812, 7812),
+ (7814, 7814),
+ (7816, 7816),
+ (7818, 7818),
+ (7820, 7820),
+ (7822, 7822),
+ (7824, 7824),
+ (7826, 7826),
+ (7828, 7828),
+ (7838, 7838),
+ (7840, 7840),
+ (7842, 7842),
+ (7844, 7844),
+ (7846, 7846),
+ (7848, 7848),
+ (7850, 7850),
+ (7852, 7852),
+ (7854, 7854),
+ (7856, 7856),
+ (7858, 7858),
+ (7860, 7860),
+ (7862, 7862),
+ (7864, 7864),
+ (7866, 7866),
+ (7868, 7868),
+ (7870, 7870),
+ (7872, 7872),
+ (7874, 7874),
+ (7876, 7876),
+ (7878, 7878),
+ (7880, 7880),
+ (7882, 7882),
+ (7884, 7884),
+ (7886, 7886),
+ (7888, 7888),
+ (7890, 7890),
+ (7892, 7892),
+ (7894, 7894),
+ (7896, 7896),
+ (7898, 7898),
+ (7900, 7900),
+ (7902, 7902),
+ (7904, 7904),
+ (7906, 7906),
+ (7908, 7908),
+ (7910, 7910),
+ (7912, 7912),
+ (7914, 7914),
+ (7916, 7916),
+ (7918, 7918),
+ (7920, 7920),
+ (7922, 7922),
+ (7924, 7924),
+ (7926, 7926),
+ (7928, 7928),
+ (7930, 7930),
+ (7932, 7932),
+ (7934, 7934),
+ (7944, 7951),
+ (7960, 7965),
+ (7976, 7983),
+ (7992, 7999),
+ (8008, 8013),
+ (8025, 8025),
+ (8027, 8027),
+ (8029, 8029),
+ (8031, 8031),
+ (8040, 8047),
+ (8120, 8123),
+ (8136, 8139),
+ (8152, 8155),
+ (8168, 8172),
+ (8184, 8187),
+ (8450, 8450),
+ (8455, 8455),
+ (8459, 8461),
+ (8464, 8466),
+ (8469, 8469),
+ (8473, 8477),
+ (8484, 8484),
+ (8486, 8486),
+ (8488, 8488),
+ (8490, 8493),
+ (8496, 8499),
+ (8510, 8511),
+ (8517, 8517),
+ (8579, 8579),
+ (11264, 11311),
+ (11360, 11360),
+ (11362, 11364),
+ (11367, 11367),
+ (11369, 11369),
+ (11371, 11371),
+ (11373, 11376),
+ (11378, 11378),
+ (11381, 11381),
+ (11390, 11392),
+ (11394, 11394),
+ (11396, 11396),
+ (11398, 11398),
+ (11400, 11400),
+ (11402, 11402),
+ (11404, 11404),
+ (11406, 11406),
+ (11408, 11408),
+ (11410, 11410),
+ (11412, 11412),
+ (11414, 11414),
+ (11416, 11416),
+ (11418, 11418),
+ (11420, 11420),
+ (11422, 11422),
+ (11424, 11424),
+ (11426, 11426),
+ (11428, 11428),
+ (11430, 11430),
+ (11432, 11432),
+ (11434, 11434),
+ (11436, 11436),
+ (11438, 11438),
+ (11440, 11440),
+ (11442, 11442),
+ (11444, 11444),
+ (11446, 11446),
+ (11448, 11448),
+ (11450, 11450),
+ (11452, 11452),
+ (11454, 11454),
+ (11456, 11456),
+ (11458, 11458),
+ (11460, 11460),
+ (11462, 11462),
+ (11464, 11464),
+ (11466, 11466),
+ (11468, 11468),
+ (11470, 11470),
+ (11472, 11472),
+ (11474, 11474),
+ (11476, 11476),
+ (11478, 11478),
+ (11480, 11480),
+ (11482, 11482),
+ (11484, 11484),
+ (11486, 11486),
+ (11488, 11488),
+ (11490, 11490),
+ (11499, 11499),
+ (11501, 11501),
+ (11506, 11506),
+ (42560, 42560),
+ (42562, 42562),
+ (42564, 42564),
+ (42566, 42566),
+ (42568, 42568),
+ (42570, 42570),
+ (42572, 42572),
+ (42574, 42574),
+ (42576, 42576),
+ (42578, 42578),
+ (42580, 42580),
+ (42582, 42582),
+ (42584, 42584),
+ (42586, 42586),
+ (42588, 42588),
+ (42590, 42590),
+ (42592, 42592),
+ (42594, 42594),
+ (42596, 42596),
+ (42598, 42598),
+ (42600, 42600),
+ (42602, 42602),
+ (42604, 42604),
+ (42624, 42624),
+ (42626, 42626),
+ (42628, 42628),
+ (42630, 42630),
+ (42632, 42632),
+ (42634, 42634),
+ (42636, 42636),
+ (42638, 42638),
+ (42640, 42640),
+ (42642, 42642),
+ (42644, 42644),
+ (42646, 42646),
+ (42648, 42648),
+ (42650, 42650),
+ (42786, 42786),
+ (42788, 42788),
+ (42790, 42790),
+ (42792, 42792),
+ (42794, 42794),
+ (42796, 42796),
+ (42798, 42798),
+ (42802, 42802),
+ (42804, 42804),
+ (42806, 42806),
+ (42808, 42808),
+ (42810, 42810),
+ (42812, 42812),
+ (42814, 42814),
+ (42816, 42816),
+ (42818, 42818),
+ (42820, 42820),
+ (42822, 42822),
+ (42824, 42824),
+ (42826, 42826),
+ (42828, 42828),
+ (42830, 42830),
+ (42832, 42832),
+ (42834, 42834),
+ (42836, 42836),
+ (42838, 42838),
+ (42840, 42840),
+ (42842, 42842),
+ (42844, 42844),
+ (42846, 42846),
+ (42848, 42848),
+ (42850, 42850),
+ (42852, 42852),
+ (42854, 42854),
+ (42856, 42856),
+ (42858, 42858),
+ (42860, 42860),
+ (42862, 42862),
+ (42873, 42873),
+ (42875, 42875),
+ (42877, 42878),
+ (42880, 42880),
+ (42882, 42882),
+ (42884, 42884),
+ (42886, 42886),
+ (42891, 42891),
+ (42893, 42893),
+ (42896, 42896),
+ (42898, 42898),
+ (42902, 42902),
+ (42904, 42904),
+ (42906, 42906),
+ (42908, 42908),
+ (42910, 42910),
+ (42912, 42912),
+ (42914, 42914),
+ (42916, 42916),
+ (42918, 42918),
+ (42920, 42920),
+ (42922, 42926),
+ (42928, 42932),
+ (42934, 42934),
+ (42936, 42936),
+ (42938, 42938),
+ (42940, 42940),
+ (42942, 42942),
+ (42944, 42944),
+ (42946, 42946),
+ (42948, 42951),
+ (42953, 42953),
+ (42960, 42960),
+ (42966, 42966),
+ (42968, 42968),
+ (42997, 42997),
+ (65313, 65338),
+ (66560, 66599),
+ (66736, 66771),
+ (66928, 66938),
+ (66940, 66954),
+ (66956, 66962),
+ (66964, 66965),
+ (68736, 68786),
+ (71840, 71871),
+ (93760, 93791),
+ (119808, 119833),
+ (119860, 119885),
+ (119912, 119937),
+ (119964, 119964),
+ (119966, 119967),
+ (119970, 119970),
+ (119973, 119974),
+ (119977, 119980),
+ (119982, 119989),
+ (120016, 120041),
+ (120068, 120069),
+ (120071, 120074),
+ (120077, 120084),
+ (120086, 120092),
+ (120120, 120121),
+ (120123, 120126),
+ (120128, 120132),
+ (120134, 120134),
+ (120138, 120144),
+ (120172, 120197),
+ (120224, 120249),
+ (120276, 120301),
+ (120328, 120353),
+ (120380, 120405),
+ (120432, 120457),
+ (120488, 120512),
+ (120546, 120570),
+ (120604, 120628),
+ (120662, 120686),
+ (120720, 120744),
+ (120778, 120778),
+ (125184, 125217),
+];
diff --git a/crates/ucd-trie/src/lib.rs b/crates/ucd-trie/src/lib.rs
new file mode 100644
index 0000000..afe0e80
--- /dev/null
+++ b/crates/ucd-trie/src/lib.rs
@@ -0,0 +1,117 @@
+/*!
+The ucd-trie crate provides a compressed trie set specifically tailored for
+Unicode codepoints. The principle use case for such a trie is to represent
+properties defined by Unicode that correspond to sets of Unicode codepoints.
+(These properties are formally called boolean properties or "single valued"
+properties. See
+[UTR#23 S3.3](https://www.unicode.org/reports/tr23/#PropertyTypeDefinitions)
+for more details.)
+
+This crate has two principle types: `TrieSetOwned` and `TrieSetSlice`,
+corresponding to a similar split as there is between `Vec<T>` and `&[T]`.
+`TrieSetOwned` is the only way to construct a trie from a set of Unicode
+codepoints.
+
+The intended use of this library is to embed a static instance of
+`TrieSetSlice` into your source code, and then use its methods as defined in
+this crate to test membership. (The `ucd-generate` tool can likely generate
+this code for you.)
+
+Finally, while this crate uses the standard library by default, it provides
+`no_std` functionality by disabling the `std` feature. When `no_std` is
+enabled, then `TrieSetOwned` is not provided. Instead, only `TrieSetSlice` is
+provided, which means `no_std` crates can still embed tries into their code.
+*/
+
+#![deny(missing_docs)]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+use core::fmt;
+
+#[cfg(feature = "std")]
+pub use crate::owned::{Error, Result, TrieSetOwned};
+
+#[cfg(test)]
+#[allow(dead_code)]
+mod general_category;
+#[cfg(feature = "std")]
+mod owned;
+
+const CHUNK_SIZE: usize = 64;
+
+/// A type alias for `TrieSetSlice<'static>`.
+pub type TrieSet = TrieSetSlice<'static>;
+
+/// A borrowed trie set.
+#[derive(Clone, Copy)]
+pub struct TrieSetSlice<'a> {
+ /// first tree, one level
+ #[doc(hidden)]
+ pub tree1_level1: &'a [u64],
+ /// second tree, first level
+ #[doc(hidden)]
+ pub tree2_level1: &'a [u8],
+ /// second tree, second level
+ #[doc(hidden)]
+ pub tree2_level2: &'a [u64],
+ /// third tree, first level
+ #[doc(hidden)]
+ pub tree3_level1: &'a [u8],
+ /// third tree, second level
+ #[doc(hidden)]
+ pub tree3_level2: &'a [u8],
+ /// third tree, third level
+ #[doc(hidden)]
+ pub tree3_level3: &'a [u64],
+}
+
+impl<'a> fmt::Debug for TrieSetSlice<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "TrieSetSlice(...)")
+ }
+}
+
+impl<'a> TrieSetSlice<'a> {
+ /// Returns true if and only if the given Unicode scalar value is in this
+ /// set.
+ pub fn contains_char(&self, c: char) -> bool {
+ self.contains(c as usize)
+ }
+
+ /// Returns true if and only if the given codepoint is in this set.
+ ///
+ /// If the given value exceeds the codepoint range (i.e., it's greater
+ /// than `0x10FFFF`), then this returns false.
+ pub fn contains_u32(&self, cp: u32) -> bool {
+ if cp > 0x10FFFF {
+ return false;
+ }
+ self.contains(cp as usize)
+ }
+
+ #[inline(always)]
+ fn contains(&self, cp: usize) -> bool {
+ if cp < 0x800 {
+ self.chunk_contains(cp, self.tree1_level1[cp >> 6])
+ } else if cp < 0x10000 {
+ let leaf = match self.tree2_level1.get((cp >> 6) - 0x20) {
+ None => return false,
+ Some(&leaf) => leaf,
+ };
+ self.chunk_contains(cp, self.tree2_level2[leaf as usize])
+ } else {
+ let child = match self.tree3_level1.get((cp >> 12) - 0x10) {
+ None => return false,
+ Some(&child) => child,
+ };
+ let i = ((child as usize) * CHUNK_SIZE) + ((cp >> 6) & 0b111111);
+ let leaf = self.tree3_level2[i];
+ self.chunk_contains(cp, self.tree3_level3[leaf as usize])
+ }
+ }
+
+ #[inline(always)]
+ fn chunk_contains(&self, cp: usize, chunk: u64) -> bool {
+ ((chunk >> (cp & 0b111111)) & 1) == 1
+ }
+}
diff --git a/crates/ucd-trie/src/owned.rs b/crates/ucd-trie/src/owned.rs
new file mode 100644
index 0000000..a621378
--- /dev/null
+++ b/crates/ucd-trie/src/owned.rs
@@ -0,0 +1,371 @@
+use std::borrow::Borrow;
+use std::collections::HashMap;
+use std::error;
+use std::fmt;
+use std::io;
+use std::result;
+
+use super::{TrieSetSlice, CHUNK_SIZE};
+
+// This implementation was pretty much cribbed from raphlinus' contribution
+// to the standard library: https://github.com/rust-lang/rust/pull/33098/files
+//
+// The fundamental principle guiding this implementation is to take advantage
+// of the fact that similar Unicode codepoints are often grouped together, and
+// that most boolean Unicode properties are quite sparse over the entire space
+// of Unicode codepoints.
+//
+// To do this, we represent sets using something like a trie (which gives us
+// prefix compression). The "final" states of the trie are embedded in leaves
+// or "chunks," where each chunk is a 64 bit integer. Each bit position of the
+// integer corresponds to whether a particular codepoint is in the set or not.
+// These chunks are not just a compact representation of the final states of
+// the trie, but are also a form of suffix compression. In particular, if
+// multiple ranges of 64 contiguous codepoints map have the same set membership
+// ordering, then they all map to the exact same chunk in the trie.
+//
+// We organize this structure by partitioning the space of Unicode codepoints
+// into three disjoint sets. The first set corresponds to codepoints
+// [0, 0x800), the second [0x800, 0x1000) and the third [0x10000, 0x110000).
+// These partitions conveniently correspond to the space of 1 or 2 byte UTF-8
+// encoded codepoints, 3 byte UTF-8 encoded codepoints and 4 byte UTF-8 encoded
+// codepoints, respectively.
+//
+// Each partition has its own tree with its own root. The first partition is
+// the simplest, since the tree is completely flat. In particular, to determine
+// the set membership of a Unicode codepoint (that is less than `0x800`), we
+// do the following (where `cp` is the codepoint we're testing):
+//
+// let chunk_address = cp >> 6;
+// let chunk_bit = cp & 0b111111;
+// let chunk = tree1[cp >> 6];
+// let is_member = 1 == ((chunk >> chunk_bit) & 1);
+//
+// We do something similar for the second partition:
+//
+// // we subtract 0x20 since (0x800 >> 6) == 0x20.
+// let child_address = (cp >> 6) - 0x20;
+// let chunk_address = tree2_level1[child_address];
+// let chunk_bit = cp & 0b111111;
+// let chunk = tree2_level2[chunk_address];
+// let is_member = 1 == ((chunk >> chunk_bit) & 1);
+//
+// And so on for the third partition.
+//
+// Note that as a special case, if the second or third partitions are empty,
+// then the trie will store empty slices for those levels. The `contains`
+// check knows to return `false` in those cases.
+
+const CHUNKS: usize = 0x110000 / CHUNK_SIZE;
+
+/// A type alias that maps to `std::result::Result<T, ucd_trie::Error>`.
+pub type Result<T> = result::Result<T, Error>;
+
+/// An error that can occur during construction of a trie.
+#[derive(Clone, Debug)]
+pub enum Error {
+ /// This error is returned when an invalid codepoint is given to
+ /// `TrieSetOwned::from_codepoints`. An invalid codepoint is a `u32` that
+ /// is greater than `0x10FFFF`.
+ InvalidCodepoint(u32),
+ /// This error is returned when a set of Unicode codepoints could not be
+ /// sufficiently compressed into the trie provided by this crate. There is
+ /// no work-around for this error at this time.
+ GaveUp,
+}
+
+impl error::Error for Error {}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ Error::InvalidCodepoint(cp) => write!(
+ f,
+ "could not construct trie set containing an \
+ invalid Unicode codepoint: 0x{:X}",
+ cp
+ ),
+ Error::GaveUp => {
+ write!(f, "could not compress codepoint set into a trie")
+ }
+ }
+ }
+}
+
+impl From<Error> for io::Error {
+ fn from(err: Error) -> io::Error {
+ io::Error::new(io::ErrorKind::Other, err)
+ }
+}
+
+/// An owned trie set.
+#[derive(Clone)]
+pub struct TrieSetOwned {
+ tree1_level1: Vec<u64>,
+ tree2_level1: Vec<u8>,
+ tree2_level2: Vec<u64>,
+ tree3_level1: Vec<u8>,
+ tree3_level2: Vec<u8>,
+ tree3_level3: Vec<u64>,
+}
+
+impl fmt::Debug for TrieSetOwned {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "TrieSetOwned(...)")
+ }
+}
+
+impl TrieSetOwned {
+ fn new(all: &[bool]) -> Result<TrieSetOwned> {
+ let mut bitvectors = Vec::with_capacity(CHUNKS);
+ for i in 0..CHUNKS {
+ let mut bitvector = 0u64;
+ for j in 0..CHUNK_SIZE {
+ if all[i * CHUNK_SIZE + j] {
+ bitvector |= 1 << j;
+ }
+ }
+ bitvectors.push(bitvector);
+ }
+
+ let tree1_level1 =
+ bitvectors.iter().cloned().take(0x800 / CHUNK_SIZE).collect();
+
+ let (mut tree2_level1, mut tree2_level2) = compress_postfix_leaves(
+ &bitvectors[0x800 / CHUNK_SIZE..0x10000 / CHUNK_SIZE],
+ )?;
+ if tree2_level2.len() == 1 && tree2_level2[0] == 0 {
+ tree2_level1.clear();
+ tree2_level2.clear();
+ }
+
+ let (mid, mut tree3_level3) = compress_postfix_leaves(
+ &bitvectors[0x10000 / CHUNK_SIZE..0x110000 / CHUNK_SIZE],
+ )?;
+ let (mut tree3_level1, mut tree3_level2) =
+ compress_postfix_mid(&mid, 64)?;
+ if tree3_level3.len() == 1 && tree3_level3[0] == 0 {
+ tree3_level1.clear();
+ tree3_level2.clear();
+ tree3_level3.clear();
+ }
+
+ Ok(TrieSetOwned {
+ tree1_level1,
+ tree2_level1,
+ tree2_level2,
+ tree3_level1,
+ tree3_level2,
+ tree3_level3,
+ })
+ }
+
+ /// Create a new trie set from a set of Unicode scalar values.
+ ///
+ /// This returns an error if a set could not be sufficiently compressed to
+ /// fit into a trie.
+ pub fn from_scalars<I, C>(scalars: I) -> Result<TrieSetOwned>
+ where
+ I: IntoIterator<Item = C>,
+ C: Borrow<char>,
+ {
+ let mut all = vec![false; 0x110000];
+ for s in scalars {
+ all[*s.borrow() as usize] = true;
+ }
+ TrieSetOwned::new(&all)
+ }
+
+ /// Create a new trie set from a set of Unicode scalar values.
+ ///
+ /// This returns an error if a set could not be sufficiently compressed to
+ /// fit into a trie. This also returns an error if any of the given
+ /// codepoints are greater than `0x10FFFF`.
+ pub fn from_codepoints<I, C>(codepoints: I) -> Result<TrieSetOwned>
+ where
+ I: IntoIterator<Item = C>,
+ C: Borrow<u32>,
+ {
+ let mut all = vec![false; 0x110000];
+ for cp in codepoints {
+ let cp = *cp.borrow();
+ if cp > 0x10FFFF {
+ return Err(Error::InvalidCodepoint(cp));
+ }
+ all[cp as usize] = true;
+ }
+ TrieSetOwned::new(&all)
+ }
+
+ /// Return this set as a slice.
+ #[inline(always)]
+ pub fn as_slice(&self) -> TrieSetSlice<'_> {
+ TrieSetSlice {
+ tree1_level1: &self.tree1_level1,
+ tree2_level1: &self.tree2_level1,
+ tree2_level2: &self.tree2_level2,
+ tree3_level1: &self.tree3_level1,
+ tree3_level2: &self.tree3_level2,
+ tree3_level3: &self.tree3_level3,
+ }
+ }
+
+ /// Returns true if and only if the given Unicode scalar value is in this
+ /// set.
+ pub fn contains_char(&self, c: char) -> bool {
+ self.as_slice().contains_char(c)
+ }
+
+ /// Returns true if and only if the given codepoint is in this set.
+ ///
+ /// If the given value exceeds the codepoint range (i.e., it's greater
+ /// than `0x10FFFF`), then this returns false.
+ pub fn contains_u32(&self, cp: u32) -> bool {
+ self.as_slice().contains_u32(cp)
+ }
+}
+
+fn compress_postfix_leaves(chunks: &[u64]) -> Result<(Vec<u8>, Vec<u64>)> {
+ let mut root = vec![];
+ let mut children = vec![];
+ let mut bychild = HashMap::new();
+ for &chunk in chunks {
+ if !bychild.contains_key(&chunk) {
+ let start = bychild.len();
+ if start > ::std::u8::MAX as usize {
+ return Err(Error::GaveUp);
+ }
+ bychild.insert(chunk, start as u8);
+ children.push(chunk);
+ }
+ root.push(bychild[&chunk]);
+ }
+ Ok((root, children))
+}
+
+fn compress_postfix_mid(
+ chunks: &[u8],
+ chunk_size: usize,
+) -> Result<(Vec<u8>, Vec<u8>)> {
+ let mut root = vec![];
+ let mut children = vec![];
+ let mut bychild = HashMap::new();
+ for i in 0..(chunks.len() / chunk_size) {
+ let chunk = &chunks[i * chunk_size..(i + 1) * chunk_size];
+ if !bychild.contains_key(chunk) {
+ let start = bychild.len();
+ if start > ::std::u8::MAX as usize {
+ return Err(Error::GaveUp);
+ }
+ bychild.insert(chunk, start as u8);
+ children.extend(chunk);
+ }
+ root.push(bychild[chunk]);
+ }
+ Ok((root, children))
+}
+
+#[cfg(test)]
+mod tests {
+ use super::TrieSetOwned;
+ use crate::general_category;
+ use std::collections::HashSet;
+
+ fn mk(scalars: &[char]) -> TrieSetOwned {
+ TrieSetOwned::from_scalars(scalars).unwrap()
+ }
+
+ fn ranges_to_set(ranges: &[(u32, u32)]) -> Vec<u32> {
+ let mut set = vec![];
+ for &(start, end) in ranges {
+ for cp in start..end + 1 {
+ set.push(cp);
+ }
+ }
+ set
+ }
+
+ #[test]
+ fn set1() {
+ let set = mk(&['a']);
+ assert!(set.contains_char('a'));
+ assert!(!set.contains_char('b'));
+ assert!(!set.contains_char('β'));
+ assert!(!set.contains_char('☃'));
+ assert!(!set.contains_char('😼'));
+ }
+
+ #[test]
+ fn set_combined() {
+ let set = mk(&['a', 'b', 'β', '☃', '😼']);
+ assert!(set.contains_char('a'));
+ assert!(set.contains_char('b'));
+ assert!(set.contains_char('β'));
+ assert!(set.contains_char('☃'));
+ assert!(set.contains_char('😼'));
+
+ assert!(!set.contains_char('c'));
+ assert!(!set.contains_char('θ'));
+ assert!(!set.contains_char('⛇'));
+ assert!(!set.contains_char('🐲'));
+ }
+
+ // Basic tests on all of the general category sets. We check that
+ // membership is correct on every Unicode codepoint... because we can.
+
+ macro_rules! category_test {
+ ($name:ident, $ranges:ident) => {
+ #[test]
+ fn $name() {
+ let set = ranges_to_set(general_category::$ranges);
+ let hashset: HashSet<u32> = set.iter().cloned().collect();
+ let trie = TrieSetOwned::from_codepoints(&set).unwrap();
+ for cp in 0..0x110000 {
+ assert!(trie.contains_u32(cp) == hashset.contains(&cp));
+ }
+ // Test that an invalid codepoint is treated correctly.
+ assert!(!trie.contains_u32(0x110000));
+ assert!(!hashset.contains(&0x110000));
+ }
+ };
+ }
+
+ category_test!(gencat_cased_letter, CASED_LETTER);
+ category_test!(gencat_close_punctuation, CLOSE_PUNCTUATION);
+ category_test!(gencat_connector_punctuation, CONNECTOR_PUNCTUATION);
+ category_test!(gencat_control, CONTROL);
+ category_test!(gencat_currency_symbol, CURRENCY_SYMBOL);
+ category_test!(gencat_dash_punctuation, DASH_PUNCTUATION);
+ category_test!(gencat_decimal_number, DECIMAL_NUMBER);
+ category_test!(gencat_enclosing_mark, ENCLOSING_MARK);
+ category_test!(gencat_final_punctuation, FINAL_PUNCTUATION);
+ category_test!(gencat_format, FORMAT);
+ category_test!(gencat_initial_punctuation, INITIAL_PUNCTUATION);
+ category_test!(gencat_letter, LETTER);
+ category_test!(gencat_letter_number, LETTER_NUMBER);
+ category_test!(gencat_line_separator, LINE_SEPARATOR);
+ category_test!(gencat_lowercase_letter, LOWERCASE_LETTER);
+ category_test!(gencat_math_symbol, MATH_SYMBOL);
+ category_test!(gencat_mark, MARK);
+ category_test!(gencat_modifier_letter, MODIFIER_LETTER);
+ category_test!(gencat_modifier_symbol, MODIFIER_SYMBOL);
+ category_test!(gencat_nonspacing_mark, NONSPACING_MARK);
+ category_test!(gencat_number, NUMBER);
+ category_test!(gencat_open_punctuation, OPEN_PUNCTUATION);
+ category_test!(gencat_other, OTHER);
+ category_test!(gencat_other_letter, OTHER_LETTER);
+ category_test!(gencat_other_number, OTHER_NUMBER);
+ category_test!(gencat_other_punctuation, OTHER_PUNCTUATION);
+ category_test!(gencat_other_symbol, OTHER_SYMBOL);
+ category_test!(gencat_paragraph_separator, PARAGRAPH_SEPARATOR);
+ category_test!(gencat_private_use, PRIVATE_USE);
+ category_test!(gencat_punctuation, PUNCTUATION);
+ category_test!(gencat_separator, SEPARATOR);
+ category_test!(gencat_space_separator, SPACE_SEPARATOR);
+ category_test!(gencat_spacing_mark, SPACING_MARK);
+ category_test!(gencat_surrogate, SURROGATE);
+ category_test!(gencat_symbol, SYMBOL);
+ category_test!(gencat_titlecase_letter, TITLECASE_LETTER);
+ category_test!(gencat_unassigned, UNASSIGNED);
+ category_test!(gencat_uppercase_letter, UPPERCASE_LETTER);
+}
diff --git a/crates/unicode-bidi/.cargo-checksum.json b/crates/unicode-bidi/.cargo-checksum.json
new file mode 100644
index 0000000..3628dc8
--- /dev/null
+++ b/crates/unicode-bidi/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"AUTHORS":"1ff3a7c8519b29544bb28ba9b1e7502df0cb764051fb9a1172e60006aa2b8dcc","COPYRIGHT":"edb20b474f6cbd4f4db066b54a9e0f687d0009d309412a63431189b59b8e2a07","Cargo.toml":"9cd0be282dbaeacf5d1fdf07096114c7b3f16f275755f30a0d2e873ab1fbc150","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"7b63ecd5f1902af1b63729947373683c32745c16a10e8e6292e2e2dcd7e90ae0","README.md":"81d3dc6d894a68894d982760b0a907f9dcbb0da179a8063ed9de1d2257518957","src/char_data/mod.rs":"0622df8ce4b4de60aea7e4787635d3187f79f7a3f9001e3d209f58fd07d03887","src/char_data/tables.rs":"50faf4eef73c831a38b735309ff3415e9f65992a0474ff5c055138f91c91ee16","src/data_source.rs":"36fa0785e51c549c1f72f09040cfe515b848d1b23fb30d469770a6b4b17b49df","src/deprecated.rs":"46c5a8bb1e6aa6193eec8269891d4cbbb5fd92214eb55eac7ea5e7ca193386aa","src/explicit.rs":"afa7599674fc8daad2939e5987ec5d937ed9fdbb78b8492b1e137db88d0a3af7","src/format_chars.rs":"678399fec3f4bfaf4093f38cfdb8956288313386dc3511dab9fb58164e8dc01b","src/implicit.rs":"e96484178d1bab97439b2c0cf4b3a8d6ee18459b9de64499aa07607aa304be0c","src/level.rs":"921fb7b8960f6cc703a51936075302db513927b8c5d5d760536b6ff70ddab0dd","src/lib.rs":"ca09c7dedc56ec139fa92fec26c3983346a3b6456992acdfbfe18b324174e0d8","src/prepare.rs":"c4aaad603f5c1be5c4364265aac7590335dc234288a4151e0f30bcefe532e14d","src/utf16.rs":"30d31c4d8c814315b48b56a2dfb755b8b442dde23f76429c6df1af754999fe3b"},"package":"08f95100a766bf4f8f28f90d77e0a5461bbdb219042e7679bebe79004fed8d75"}
\ No newline at end of file
diff --git a/crates/unicode-bidi/AUTHORS b/crates/unicode-bidi/AUTHORS
new file mode 100644
index 0000000..81b0362
--- /dev/null
+++ b/crates/unicode-bidi/AUTHORS
@@ -0,0 +1,4 @@
+This software was written by the following people:
+
+Matt Brubeck <[email protected]>
+Behnam Esfahbod <[email protected]>
diff --git a/crates/unicode-bidi/Android.bp b/crates/unicode-bidi/Android.bp
new file mode 100644
index 0000000..7e46a56
--- /dev/null
+++ b/crates/unicode-bidi/Android.bp
@@ -0,0 +1,57 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_unicode-bidi_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_unicode-bidi_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libunicode_bidi",
+ host_supported: true,
+ crate_name: "unicode_bidi",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.15",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "default",
+ "hardcoded-data",
+ "std",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.resolv",
+ ],
+ product_available: true,
+ vendor_available: true,
+ min_sdk_version: "29",
+}
+
+rust_test {
+ name: "unicode-bidi_test_src_lib",
+ host_supported: true,
+ crate_name: "unicode_bidi",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.15",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "hardcoded-data",
+ "std",
+ ],
+ rustlibs: ["libserde_test"],
+}
diff --git a/crates/unicode-bidi/COPYRIGHT b/crates/unicode-bidi/COPYRIGHT
new file mode 100644
index 0000000..d84c465
--- /dev/null
+++ b/crates/unicode-bidi/COPYRIGHT
@@ -0,0 +1,8 @@
+This project is copyright 2015, The Servo Project Developers (given in the
+file AUTHORS).
+
+Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
+http://opensource.org/licenses/MIT>, at your option. All files in the project
+carrying such notice may not be copied, modified, or distributed except
+according to those terms.
diff --git a/crates/unicode-bidi/Cargo.toml b/crates/unicode-bidi/Cargo.toml
new file mode 100644
index 0000000..80f71ff
--- /dev/null
+++ b/crates/unicode-bidi/Cargo.toml
@@ -0,0 +1,78 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "unicode-bidi"
+version = "0.3.15"
+authors = ["The Servo Project Developers"]
+exclude = [
+ "benches/**",
+ "data/**",
+ "examples/**",
+ "tests/**",
+ "tools/**",
+]
+description = "Implementation of the Unicode Bidirectional Algorithm"
+documentation = "https://docs.rs/unicode-bidi/"
+readme = "README.md"
+keywords = [
+ "rtl",
+ "unicode",
+ "text",
+ "layout",
+ "bidi",
+]
+categories = [
+ "no-std",
+ "encoding",
+ "text-processing",
+]
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/servo/unicode-bidi"
+
+[lib]
+name = "unicode_bidi"
+
+[dependencies.flame]
+version = "0.2"
+optional = true
+
+[dependencies.flamer]
+version = "0.4"
+optional = true
+
+[dependencies.serde]
+version = ">=0.8, <2.0"
+features = ["derive"]
+optional = true
+default-features = false
+
+[dev-dependencies.serde_test]
+version = ">=0.8, <2.0"
+
+[features]
+bench_it = []
+default = [
+ "std",
+ "hardcoded-data",
+]
+flame_it = [
+ "flame",
+ "flamer",
+]
+hardcoded-data = []
+std = []
+unstable = []
+with_serde = ["serde"]
+
+[badges.appveyor]
+repository = "servo/unicode-bidi"
diff --git a/crates/unicode-bidi/LICENSE b/crates/unicode-bidi/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/unicode-bidi/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/unicode-bidi/LICENSE-APACHE b/crates/unicode-bidi/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/unicode-bidi/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/unicode-bidi/LICENSE-MIT b/crates/unicode-bidi/LICENSE-MIT
new file mode 100644
index 0000000..e69282e
--- /dev/null
+++ b/crates/unicode-bidi/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2015 The Rust Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/unicode-bidi/METADATA b/crates/unicode-bidi/METADATA
new file mode 100644
index 0000000..a004976
--- /dev/null
+++ b/crates/unicode-bidi/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/unicode-bidi
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "unicode-bidi"
+description: "Implementation of the Unicode Bidirectional Algorithm"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 5
+ }
+ homepage: "https://crates.io/crates/unicode-bidi"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/unicode-bidi/unicode-bidi-0.3.15.crate"
+ version: "0.3.15"
+ }
+}
diff --git a/crates/unicode-bidi/MODULE_LICENSE_APACHE2 b/crates/unicode-bidi/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/unicode-bidi/MODULE_LICENSE_APACHE2
diff --git a/crates/unicode-bidi/README.md b/crates/unicode-bidi/README.md
new file mode 100644
index 0000000..6c65abc
--- /dev/null
+++ b/crates/unicode-bidi/README.md
@@ -0,0 +1,12 @@
+# unicode-bidi
+
+This crate implements the [Unicode Bidirectional Algorithm][tr9] for display
+of mixed right-to-left and left-to-right text. It is written in safe Rust,
+compatible with the current stable release.
+
+[Documentation](https://docs.rs/unicode-bidi/)
+
+[](https://github.com/servo/unicode-bidi/actions)
+[](https://ci.appveyor.com/project/servo/unicode-bidi)
+
+[tr9]: https://www.unicode.org/reports/tr9/
diff --git a/crates/unicode-bidi/TEST_MAPPING b/crates/unicode-bidi/TEST_MAPPING
new file mode 100644
index 0000000..4688ce8
--- /dev/null
+++ b/crates/unicode-bidi/TEST_MAPPING
@@ -0,0 +1,24 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "external/rust/crates/quiche"
+ },
+ {
+ "path": "external/rust/crates/url"
+ },
+ {
+ "path": "packages/modules/DnsResolver"
+ }
+ ],
+ "presubmit": [
+ {
+ "name": "unicode-bidi_test_src_lib"
+ }
+ ],
+ "presubmit-rust": [
+ {
+ "name": "unicode-bidi_test_src_lib"
+ }
+ ]
+}
diff --git a/crates/unicode-bidi/cargo_embargo.json b/crates/unicode-bidi/cargo_embargo.json
new file mode 100644
index 0000000..b8ed541
--- /dev/null
+++ b/crates/unicode-bidi/cargo_embargo.json
@@ -0,0 +1,9 @@
+{
+ "apex_available": [
+ "//apex_available:platform",
+ "com.android.resolv"
+ ],
+ "min_sdk_version": "29",
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/unicode-bidi/patches/remove_missing_test.patch b/crates/unicode-bidi/patches/remove_missing_test.patch
new file mode 100644
index 0000000..5a69521
--- /dev/null
+++ b/crates/unicode-bidi/patches/remove_missing_test.patch
@@ -0,0 +1,16 @@
+diff --git a/Cargo.toml b/Cargo.toml
+index 02ea8fa..73aff86 100644
+--- a/Cargo.toml
++++ b/Cargo.toml
+@@ -42,11 +42,6 @@ repository = "https://github.com/servo/unicode-bidi"
+ [lib]
+ name = "unicode_bidi"
+
+-[[test]]
+-name = "conformance_tests"
+-path = "tests/conformance_tests.rs"
+-required-features = ["hardcoded-data"]
+-
+ [dependencies.flame]
+ version = "0.2"
+ optional = true
diff --git a/crates/unicode-bidi/src/char_data/mod.rs b/crates/unicode-bidi/src/char_data/mod.rs
new file mode 100644
index 0000000..4edf5b8
--- /dev/null
+++ b/crates/unicode-bidi/src/char_data/mod.rs
@@ -0,0 +1,173 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Accessor for `Bidi_Class` property from Unicode Character Database (UCD)
+
+mod tables;
+
+pub use self::tables::{BidiClass, UNICODE_VERSION};
+#[cfg(feature = "hardcoded-data")]
+use core::char;
+#[cfg(feature = "hardcoded-data")]
+use core::cmp::Ordering::{Equal, Greater, Less};
+
+#[cfg(feature = "hardcoded-data")]
+use self::tables::bidi_class_table;
+use crate::data_source::BidiMatchedOpeningBracket;
+use crate::BidiClass::*;
+#[cfg(feature = "hardcoded-data")]
+use crate::BidiDataSource;
+/// Hardcoded Bidi data that ships with the unicode-bidi crate.
+///
+/// This can be enabled with the default `hardcoded-data` Cargo feature.
+#[cfg(feature = "hardcoded-data")]
+pub struct HardcodedBidiData;
+
+#[cfg(feature = "hardcoded-data")]
+impl BidiDataSource for HardcodedBidiData {
+ fn bidi_class(&self, c: char) -> BidiClass {
+ bsearch_range_value_table(c, bidi_class_table)
+ }
+}
+
+/// Find the `BidiClass` of a single char.
+#[cfg(feature = "hardcoded-data")]
+pub fn bidi_class(c: char) -> BidiClass {
+ bsearch_range_value_table(c, bidi_class_table)
+}
+
+/// If this character is a bracket according to BidiBrackets.txt,
+/// return the corresponding *normalized* *opening bracket* of the pair,
+/// and whether or not it itself is an opening bracket.
+pub(crate) fn bidi_matched_opening_bracket(c: char) -> Option<BidiMatchedOpeningBracket> {
+ for pair in self::tables::bidi_pairs_table {
+ if pair.0 == c || pair.1 == c {
+ let skeleton = pair.2.unwrap_or(pair.0);
+ return Some(BidiMatchedOpeningBracket {
+ opening: skeleton,
+ is_open: pair.0 == c,
+ });
+ }
+ }
+ None
+}
+
+pub fn is_rtl(bidi_class: BidiClass) -> bool {
+ match bidi_class {
+ RLE | RLO | RLI => true,
+ _ => false,
+ }
+}
+
+#[cfg(feature = "hardcoded-data")]
+fn bsearch_range_value_table(c: char, r: &'static [(char, char, BidiClass)]) -> BidiClass {
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi {
+ Equal
+ } else if hi < c {
+ Less
+ } else {
+ Greater
+ }
+ }) {
+ Ok(idx) => {
+ let (_, _, cat) = r[idx];
+ cat
+ }
+ // UCD/extracted/DerivedBidiClass.txt: "All code points not explicitly listed
+ // for Bidi_Class have the value Left_To_Right (L)."
+ Err(_) => L,
+ }
+}
+
+#[cfg(all(test, feature = "hardcoded-data"))]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_ascii() {
+ assert_eq!(bidi_class('\u{0000}'), BN);
+ assert_eq!(bidi_class('\u{0040}'), ON);
+ assert_eq!(bidi_class('\u{0041}'), L);
+ assert_eq!(bidi_class('\u{0062}'), L);
+ assert_eq!(bidi_class('\u{007F}'), BN);
+ }
+
+ #[test]
+ fn test_bmp() {
+ // Hebrew
+ assert_eq!(bidi_class('\u{0590}'), R);
+ assert_eq!(bidi_class('\u{05D0}'), R);
+ assert_eq!(bidi_class('\u{05D1}'), R);
+ assert_eq!(bidi_class('\u{05FF}'), R);
+
+ // Arabic
+ assert_eq!(bidi_class('\u{0600}'), AN);
+ assert_eq!(bidi_class('\u{0627}'), AL);
+ assert_eq!(bidi_class('\u{07BF}'), AL);
+
+ // Default R + Arabic Extras
+ assert_eq!(bidi_class('\u{07C0}'), R);
+ assert_eq!(bidi_class('\u{085F}'), R);
+ assert_eq!(bidi_class('\u{0860}'), AL);
+ assert_eq!(bidi_class('\u{0870}'), AL);
+ assert_eq!(bidi_class('\u{089F}'), NSM);
+ assert_eq!(bidi_class('\u{08A0}'), AL);
+ assert_eq!(bidi_class('\u{089F}'), NSM);
+ assert_eq!(bidi_class('\u{08FF}'), NSM);
+
+ // Default ET
+ assert_eq!(bidi_class('\u{20A0}'), ET);
+ assert_eq!(bidi_class('\u{20CF}'), ET);
+
+ // Arabic Presentation Forms
+ assert_eq!(bidi_class('\u{FB1D}'), R);
+ assert_eq!(bidi_class('\u{FB4F}'), R);
+ assert_eq!(bidi_class('\u{FB50}'), AL);
+ assert_eq!(bidi_class('\u{FDCF}'), ON);
+ assert_eq!(bidi_class('\u{FDF0}'), AL);
+ assert_eq!(bidi_class('\u{FDFF}'), ON);
+ assert_eq!(bidi_class('\u{FE70}'), AL);
+ assert_eq!(bidi_class('\u{FEFE}'), AL);
+ assert_eq!(bidi_class('\u{FEFF}'), BN);
+
+ // noncharacters
+ assert_eq!(bidi_class('\u{FDD0}'), L);
+ assert_eq!(bidi_class('\u{FDD1}'), L);
+ assert_eq!(bidi_class('\u{FDEE}'), L);
+ assert_eq!(bidi_class('\u{FDEF}'), L);
+ assert_eq!(bidi_class('\u{FFFE}'), L);
+ assert_eq!(bidi_class('\u{FFFF}'), L);
+ }
+
+ #[test]
+ fn test_smp() {
+ // Default AL + R
+ assert_eq!(bidi_class('\u{10800}'), R);
+ assert_eq!(bidi_class('\u{10FFF}'), R);
+ assert_eq!(bidi_class('\u{1E800}'), R);
+ assert_eq!(bidi_class('\u{1EDFF}'), R);
+ assert_eq!(bidi_class('\u{1EE00}'), AL);
+ assert_eq!(bidi_class('\u{1EEFF}'), AL);
+ assert_eq!(bidi_class('\u{1EF00}'), R);
+ assert_eq!(bidi_class('\u{1EFFF}'), R);
+ }
+
+ #[test]
+ fn test_unassigned_planes() {
+ assert_eq!(bidi_class('\u{30000}'), L);
+ assert_eq!(bidi_class('\u{40000}'), L);
+ assert_eq!(bidi_class('\u{50000}'), L);
+ assert_eq!(bidi_class('\u{60000}'), L);
+ assert_eq!(bidi_class('\u{70000}'), L);
+ assert_eq!(bidi_class('\u{80000}'), L);
+ assert_eq!(bidi_class('\u{90000}'), L);
+ assert_eq!(bidi_class('\u{a0000}'), L);
+ }
+}
diff --git a/crates/unicode-bidi/src/char_data/tables.rs b/crates/unicode-bidi/src/char_data/tables.rs
new file mode 100644
index 0000000..ecdcf49
--- /dev/null
+++ b/crates/unicode-bidi/src/char_data/tables.rs
@@ -0,0 +1,543 @@
+// NOTE:
+// The following code was generated by "tools/generate.py". do not edit directly
+
+#![allow(missing_docs, non_upper_case_globals, non_snake_case)]
+#![cfg_attr(rustfmt, rustfmt_skip)]
+
+/// The [Unicode version](http://www.unicode.org/versions/) of data
+pub const UNICODE_VERSION: (u64, u64, u64) = (15, 0, 0);
+
+#[allow(non_camel_case_types)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+/// Represents values of the Unicode character property
+/// [`Bidi_Class`](http://www.unicode.org/reports/tr44/#Bidi_Class), also
+/// known as the *bidirectional character type*.
+///
+/// * <http://www.unicode.org/reports/tr9/#Bidirectional_Character_Types>
+/// * <http://www.unicode.org/reports/tr44/#Bidi_Class_Values>
+pub enum BidiClass {
+ AL,
+ AN,
+ B,
+ BN,
+ CS,
+ EN,
+ ES,
+ ET,
+ FSI,
+ L,
+ LRE,
+ LRI,
+ LRO,
+ NSM,
+ ON,
+ PDF,
+ PDI,
+ R,
+ RLE,
+ RLI,
+ RLO,
+ S,
+ WS,
+}
+
+#[cfg(feature = "hardcoded-data")]
+use self::BidiClass::*;
+
+#[cfg(feature = "hardcoded-data")]
+pub const bidi_class_table: &'static [(char, char, BidiClass)] = &[
+ ('\u{0}', '\u{8}', BN), ('\u{9}', '\u{9}', S), ('\u{a}', '\u{a}', B), ('\u{b}', '\u{b}', S),
+ ('\u{c}', '\u{c}', WS), ('\u{d}', '\u{d}', B), ('\u{e}', '\u{1b}', BN), ('\u{1c}', '\u{1e}', B),
+ ('\u{1f}', '\u{1f}', S), ('\u{20}', '\u{20}', WS), ('\u{21}', '\u{22}', ON), ('\u{23}',
+ '\u{25}', ET), ('\u{26}', '\u{2a}', ON), ('\u{2b}', '\u{2b}', ES), ('\u{2c}', '\u{2c}', CS),
+ ('\u{2d}', '\u{2d}', ES), ('\u{2e}', '\u{2f}', CS), ('\u{30}', '\u{39}', EN), ('\u{3a}',
+ '\u{3a}', CS), ('\u{3b}', '\u{40}', ON), ('\u{41}', '\u{5a}', L), ('\u{5b}', '\u{60}', ON),
+ ('\u{61}', '\u{7a}', L), ('\u{7b}', '\u{7e}', ON), ('\u{7f}', '\u{84}', BN), ('\u{85}',
+ '\u{85}', B), ('\u{86}', '\u{9f}', BN), ('\u{a0}', '\u{a0}', CS), ('\u{a1}', '\u{a1}', ON),
+ ('\u{a2}', '\u{a5}', ET), ('\u{a6}', '\u{a9}', ON), ('\u{aa}', '\u{aa}', L), ('\u{ab}',
+ '\u{ac}', ON), ('\u{ad}', '\u{ad}', BN), ('\u{ae}', '\u{af}', ON), ('\u{b0}', '\u{b1}', ET),
+ ('\u{b2}', '\u{b3}', EN), ('\u{b4}', '\u{b4}', ON), ('\u{b5}', '\u{b5}', L), ('\u{b6}',
+ '\u{b8}', ON), ('\u{b9}', '\u{b9}', EN), ('\u{ba}', '\u{ba}', L), ('\u{bb}', '\u{bf}', ON),
+ ('\u{c0}', '\u{d6}', L), ('\u{d7}', '\u{d7}', ON), ('\u{d8}', '\u{f6}', L), ('\u{f7}', '\u{f7}',
+ ON), ('\u{f8}', '\u{2b8}', L), ('\u{2b9}', '\u{2ba}', ON), ('\u{2bb}', '\u{2c1}', L),
+ ('\u{2c2}', '\u{2cf}', ON), ('\u{2d0}', '\u{2d1}', L), ('\u{2d2}', '\u{2df}', ON), ('\u{2e0}',
+ '\u{2e4}', L), ('\u{2e5}', '\u{2ed}', ON), ('\u{2ee}', '\u{2ee}', L), ('\u{2ef}', '\u{2ff}',
+ ON), ('\u{300}', '\u{36f}', NSM), ('\u{370}', '\u{373}', L), ('\u{374}', '\u{375}', ON),
+ ('\u{376}', '\u{377}', L), ('\u{37a}', '\u{37d}', L), ('\u{37e}', '\u{37e}', ON), ('\u{37f}',
+ '\u{37f}', L), ('\u{384}', '\u{385}', ON), ('\u{386}', '\u{386}', L), ('\u{387}', '\u{387}',
+ ON), ('\u{388}', '\u{38a}', L), ('\u{38c}', '\u{38c}', L), ('\u{38e}', '\u{3a1}', L),
+ ('\u{3a3}', '\u{3f5}', L), ('\u{3f6}', '\u{3f6}', ON), ('\u{3f7}', '\u{482}', L), ('\u{483}',
+ '\u{489}', NSM), ('\u{48a}', '\u{52f}', L), ('\u{531}', '\u{556}', L), ('\u{559}', '\u{589}',
+ L), ('\u{58a}', '\u{58a}', ON), ('\u{58d}', '\u{58e}', ON), ('\u{58f}', '\u{58f}', ET),
+ ('\u{590}', '\u{590}', R), ('\u{591}', '\u{5bd}', NSM), ('\u{5be}', '\u{5be}', R), ('\u{5bf}',
+ '\u{5bf}', NSM), ('\u{5c0}', '\u{5c0}', R), ('\u{5c1}', '\u{5c2}', NSM), ('\u{5c3}', '\u{5c3}',
+ R), ('\u{5c4}', '\u{5c5}', NSM), ('\u{5c6}', '\u{5c6}', R), ('\u{5c7}', '\u{5c7}', NSM),
+ ('\u{5c8}', '\u{5ff}', R), ('\u{600}', '\u{605}', AN), ('\u{606}', '\u{607}', ON), ('\u{608}',
+ '\u{608}', AL), ('\u{609}', '\u{60a}', ET), ('\u{60b}', '\u{60b}', AL), ('\u{60c}', '\u{60c}',
+ CS), ('\u{60d}', '\u{60d}', AL), ('\u{60e}', '\u{60f}', ON), ('\u{610}', '\u{61a}', NSM),
+ ('\u{61b}', '\u{64a}', AL), ('\u{64b}', '\u{65f}', NSM), ('\u{660}', '\u{669}', AN), ('\u{66a}',
+ '\u{66a}', ET), ('\u{66b}', '\u{66c}', AN), ('\u{66d}', '\u{66f}', AL), ('\u{670}', '\u{670}',
+ NSM), ('\u{671}', '\u{6d5}', AL), ('\u{6d6}', '\u{6dc}', NSM), ('\u{6dd}', '\u{6dd}', AN),
+ ('\u{6de}', '\u{6de}', ON), ('\u{6df}', '\u{6e4}', NSM), ('\u{6e5}', '\u{6e6}', AL), ('\u{6e7}',
+ '\u{6e8}', NSM), ('\u{6e9}', '\u{6e9}', ON), ('\u{6ea}', '\u{6ed}', NSM), ('\u{6ee}', '\u{6ef}',
+ AL), ('\u{6f0}', '\u{6f9}', EN), ('\u{6fa}', '\u{710}', AL), ('\u{711}', '\u{711}', NSM),
+ ('\u{712}', '\u{72f}', AL), ('\u{730}', '\u{74a}', NSM), ('\u{74b}', '\u{7a5}', AL), ('\u{7a6}',
+ '\u{7b0}', NSM), ('\u{7b1}', '\u{7bf}', AL), ('\u{7c0}', '\u{7ea}', R), ('\u{7eb}', '\u{7f3}',
+ NSM), ('\u{7f4}', '\u{7f5}', R), ('\u{7f6}', '\u{7f9}', ON), ('\u{7fa}', '\u{7fc}', R),
+ ('\u{7fd}', '\u{7fd}', NSM), ('\u{7fe}', '\u{815}', R), ('\u{816}', '\u{819}', NSM), ('\u{81a}',
+ '\u{81a}', R), ('\u{81b}', '\u{823}', NSM), ('\u{824}', '\u{824}', R), ('\u{825}', '\u{827}',
+ NSM), ('\u{828}', '\u{828}', R), ('\u{829}', '\u{82d}', NSM), ('\u{82e}', '\u{858}', R),
+ ('\u{859}', '\u{85b}', NSM), ('\u{85c}', '\u{85f}', R), ('\u{860}', '\u{86a}', AL), ('\u{86b}',
+ '\u{86f}', R), ('\u{870}', '\u{88e}', AL), ('\u{88f}', '\u{88f}', R), ('\u{890}', '\u{891}',
+ AN), ('\u{892}', '\u{897}', R), ('\u{898}', '\u{89f}', NSM), ('\u{8a0}', '\u{8c9}', AL),
+ ('\u{8ca}', '\u{8e1}', NSM), ('\u{8e2}', '\u{8e2}', AN), ('\u{8e3}', '\u{902}', NSM),
+ ('\u{903}', '\u{939}', L), ('\u{93a}', '\u{93a}', NSM), ('\u{93b}', '\u{93b}', L), ('\u{93c}',
+ '\u{93c}', NSM), ('\u{93d}', '\u{940}', L), ('\u{941}', '\u{948}', NSM), ('\u{949}', '\u{94c}',
+ L), ('\u{94d}', '\u{94d}', NSM), ('\u{94e}', '\u{950}', L), ('\u{951}', '\u{957}', NSM),
+ ('\u{958}', '\u{961}', L), ('\u{962}', '\u{963}', NSM), ('\u{964}', '\u{980}', L), ('\u{981}',
+ '\u{981}', NSM), ('\u{982}', '\u{983}', L), ('\u{985}', '\u{98c}', L), ('\u{98f}', '\u{990}',
+ L), ('\u{993}', '\u{9a8}', L), ('\u{9aa}', '\u{9b0}', L), ('\u{9b2}', '\u{9b2}', L), ('\u{9b6}',
+ '\u{9b9}', L), ('\u{9bc}', '\u{9bc}', NSM), ('\u{9bd}', '\u{9c0}', L), ('\u{9c1}', '\u{9c4}',
+ NSM), ('\u{9c7}', '\u{9c8}', L), ('\u{9cb}', '\u{9cc}', L), ('\u{9cd}', '\u{9cd}', NSM),
+ ('\u{9ce}', '\u{9ce}', L), ('\u{9d7}', '\u{9d7}', L), ('\u{9dc}', '\u{9dd}', L), ('\u{9df}',
+ '\u{9e1}', L), ('\u{9e2}', '\u{9e3}', NSM), ('\u{9e6}', '\u{9f1}', L), ('\u{9f2}', '\u{9f3}',
+ ET), ('\u{9f4}', '\u{9fa}', L), ('\u{9fb}', '\u{9fb}', ET), ('\u{9fc}', '\u{9fd}', L),
+ ('\u{9fe}', '\u{9fe}', NSM), ('\u{a01}', '\u{a02}', NSM), ('\u{a03}', '\u{a03}', L), ('\u{a05}',
+ '\u{a0a}', L), ('\u{a0f}', '\u{a10}', L), ('\u{a13}', '\u{a28}', L), ('\u{a2a}', '\u{a30}', L),
+ ('\u{a32}', '\u{a33}', L), ('\u{a35}', '\u{a36}', L), ('\u{a38}', '\u{a39}', L), ('\u{a3c}',
+ '\u{a3c}', NSM), ('\u{a3e}', '\u{a40}', L), ('\u{a41}', '\u{a42}', NSM), ('\u{a47}', '\u{a48}',
+ NSM), ('\u{a4b}', '\u{a4d}', NSM), ('\u{a51}', '\u{a51}', NSM), ('\u{a59}', '\u{a5c}', L),
+ ('\u{a5e}', '\u{a5e}', L), ('\u{a66}', '\u{a6f}', L), ('\u{a70}', '\u{a71}', NSM), ('\u{a72}',
+ '\u{a74}', L), ('\u{a75}', '\u{a75}', NSM), ('\u{a76}', '\u{a76}', L), ('\u{a81}', '\u{a82}',
+ NSM), ('\u{a83}', '\u{a83}', L), ('\u{a85}', '\u{a8d}', L), ('\u{a8f}', '\u{a91}', L),
+ ('\u{a93}', '\u{aa8}', L), ('\u{aaa}', '\u{ab0}', L), ('\u{ab2}', '\u{ab3}', L), ('\u{ab5}',
+ '\u{ab9}', L), ('\u{abc}', '\u{abc}', NSM), ('\u{abd}', '\u{ac0}', L), ('\u{ac1}', '\u{ac5}',
+ NSM), ('\u{ac7}', '\u{ac8}', NSM), ('\u{ac9}', '\u{ac9}', L), ('\u{acb}', '\u{acc}', L),
+ ('\u{acd}', '\u{acd}', NSM), ('\u{ad0}', '\u{ad0}', L), ('\u{ae0}', '\u{ae1}', L), ('\u{ae2}',
+ '\u{ae3}', NSM), ('\u{ae6}', '\u{af0}', L), ('\u{af1}', '\u{af1}', ET), ('\u{af9}', '\u{af9}',
+ L), ('\u{afa}', '\u{aff}', NSM), ('\u{b01}', '\u{b01}', NSM), ('\u{b02}', '\u{b03}', L),
+ ('\u{b05}', '\u{b0c}', L), ('\u{b0f}', '\u{b10}', L), ('\u{b13}', '\u{b28}', L), ('\u{b2a}',
+ '\u{b30}', L), ('\u{b32}', '\u{b33}', L), ('\u{b35}', '\u{b39}', L), ('\u{b3c}', '\u{b3c}',
+ NSM), ('\u{b3d}', '\u{b3e}', L), ('\u{b3f}', '\u{b3f}', NSM), ('\u{b40}', '\u{b40}', L),
+ ('\u{b41}', '\u{b44}', NSM), ('\u{b47}', '\u{b48}', L), ('\u{b4b}', '\u{b4c}', L), ('\u{b4d}',
+ '\u{b4d}', NSM), ('\u{b55}', '\u{b56}', NSM), ('\u{b57}', '\u{b57}', L), ('\u{b5c}', '\u{b5d}',
+ L), ('\u{b5f}', '\u{b61}', L), ('\u{b62}', '\u{b63}', NSM), ('\u{b66}', '\u{b77}', L),
+ ('\u{b82}', '\u{b82}', NSM), ('\u{b83}', '\u{b83}', L), ('\u{b85}', '\u{b8a}', L), ('\u{b8e}',
+ '\u{b90}', L), ('\u{b92}', '\u{b95}', L), ('\u{b99}', '\u{b9a}', L), ('\u{b9c}', '\u{b9c}', L),
+ ('\u{b9e}', '\u{b9f}', L), ('\u{ba3}', '\u{ba4}', L), ('\u{ba8}', '\u{baa}', L), ('\u{bae}',
+ '\u{bb9}', L), ('\u{bbe}', '\u{bbf}', L), ('\u{bc0}', '\u{bc0}', NSM), ('\u{bc1}', '\u{bc2}',
+ L), ('\u{bc6}', '\u{bc8}', L), ('\u{bca}', '\u{bcc}', L), ('\u{bcd}', '\u{bcd}', NSM),
+ ('\u{bd0}', '\u{bd0}', L), ('\u{bd7}', '\u{bd7}', L), ('\u{be6}', '\u{bf2}', L), ('\u{bf3}',
+ '\u{bf8}', ON), ('\u{bf9}', '\u{bf9}', ET), ('\u{bfa}', '\u{bfa}', ON), ('\u{c00}', '\u{c00}',
+ NSM), ('\u{c01}', '\u{c03}', L), ('\u{c04}', '\u{c04}', NSM), ('\u{c05}', '\u{c0c}', L),
+ ('\u{c0e}', '\u{c10}', L), ('\u{c12}', '\u{c28}', L), ('\u{c2a}', '\u{c39}', L), ('\u{c3c}',
+ '\u{c3c}', NSM), ('\u{c3d}', '\u{c3d}', L), ('\u{c3e}', '\u{c40}', NSM), ('\u{c41}', '\u{c44}',
+ L), ('\u{c46}', '\u{c48}', NSM), ('\u{c4a}', '\u{c4d}', NSM), ('\u{c55}', '\u{c56}', NSM),
+ ('\u{c58}', '\u{c5a}', L), ('\u{c5d}', '\u{c5d}', L), ('\u{c60}', '\u{c61}', L), ('\u{c62}',
+ '\u{c63}', NSM), ('\u{c66}', '\u{c6f}', L), ('\u{c77}', '\u{c77}', L), ('\u{c78}', '\u{c7e}',
+ ON), ('\u{c7f}', '\u{c80}', L), ('\u{c81}', '\u{c81}', NSM), ('\u{c82}', '\u{c8c}', L),
+ ('\u{c8e}', '\u{c90}', L), ('\u{c92}', '\u{ca8}', L), ('\u{caa}', '\u{cb3}', L), ('\u{cb5}',
+ '\u{cb9}', L), ('\u{cbc}', '\u{cbc}', NSM), ('\u{cbd}', '\u{cc4}', L), ('\u{cc6}', '\u{cc8}',
+ L), ('\u{cca}', '\u{ccb}', L), ('\u{ccc}', '\u{ccd}', NSM), ('\u{cd5}', '\u{cd6}', L),
+ ('\u{cdd}', '\u{cde}', L), ('\u{ce0}', '\u{ce1}', L), ('\u{ce2}', '\u{ce3}', NSM), ('\u{ce6}',
+ '\u{cef}', L), ('\u{cf1}', '\u{cf3}', L), ('\u{d00}', '\u{d01}', NSM), ('\u{d02}', '\u{d0c}',
+ L), ('\u{d0e}', '\u{d10}', L), ('\u{d12}', '\u{d3a}', L), ('\u{d3b}', '\u{d3c}', NSM),
+ ('\u{d3d}', '\u{d40}', L), ('\u{d41}', '\u{d44}', NSM), ('\u{d46}', '\u{d48}', L), ('\u{d4a}',
+ '\u{d4c}', L), ('\u{d4d}', '\u{d4d}', NSM), ('\u{d4e}', '\u{d4f}', L), ('\u{d54}', '\u{d61}',
+ L), ('\u{d62}', '\u{d63}', NSM), ('\u{d66}', '\u{d7f}', L), ('\u{d81}', '\u{d81}', NSM),
+ ('\u{d82}', '\u{d83}', L), ('\u{d85}', '\u{d96}', L), ('\u{d9a}', '\u{db1}', L), ('\u{db3}',
+ '\u{dbb}', L), ('\u{dbd}', '\u{dbd}', L), ('\u{dc0}', '\u{dc6}', L), ('\u{dca}', '\u{dca}',
+ NSM), ('\u{dcf}', '\u{dd1}', L), ('\u{dd2}', '\u{dd4}', NSM), ('\u{dd6}', '\u{dd6}', NSM),
+ ('\u{dd8}', '\u{ddf}', L), ('\u{de6}', '\u{def}', L), ('\u{df2}', '\u{df4}', L), ('\u{e01}',
+ '\u{e30}', L), ('\u{e31}', '\u{e31}', NSM), ('\u{e32}', '\u{e33}', L), ('\u{e34}', '\u{e3a}',
+ NSM), ('\u{e3f}', '\u{e3f}', ET), ('\u{e40}', '\u{e46}', L), ('\u{e47}', '\u{e4e}', NSM),
+ ('\u{e4f}', '\u{e5b}', L), ('\u{e81}', '\u{e82}', L), ('\u{e84}', '\u{e84}', L), ('\u{e86}',
+ '\u{e8a}', L), ('\u{e8c}', '\u{ea3}', L), ('\u{ea5}', '\u{ea5}', L), ('\u{ea7}', '\u{eb0}', L),
+ ('\u{eb1}', '\u{eb1}', NSM), ('\u{eb2}', '\u{eb3}', L), ('\u{eb4}', '\u{ebc}', NSM), ('\u{ebd}',
+ '\u{ebd}', L), ('\u{ec0}', '\u{ec4}', L), ('\u{ec6}', '\u{ec6}', L), ('\u{ec8}', '\u{ece}',
+ NSM), ('\u{ed0}', '\u{ed9}', L), ('\u{edc}', '\u{edf}', L), ('\u{f00}', '\u{f17}', L),
+ ('\u{f18}', '\u{f19}', NSM), ('\u{f1a}', '\u{f34}', L), ('\u{f35}', '\u{f35}', NSM), ('\u{f36}',
+ '\u{f36}', L), ('\u{f37}', '\u{f37}', NSM), ('\u{f38}', '\u{f38}', L), ('\u{f39}', '\u{f39}',
+ NSM), ('\u{f3a}', '\u{f3d}', ON), ('\u{f3e}', '\u{f47}', L), ('\u{f49}', '\u{f6c}', L),
+ ('\u{f71}', '\u{f7e}', NSM), ('\u{f7f}', '\u{f7f}', L), ('\u{f80}', '\u{f84}', NSM), ('\u{f85}',
+ '\u{f85}', L), ('\u{f86}', '\u{f87}', NSM), ('\u{f88}', '\u{f8c}', L), ('\u{f8d}', '\u{f97}',
+ NSM), ('\u{f99}', '\u{fbc}', NSM), ('\u{fbe}', '\u{fc5}', L), ('\u{fc6}', '\u{fc6}', NSM),
+ ('\u{fc7}', '\u{fcc}', L), ('\u{fce}', '\u{fda}', L), ('\u{1000}', '\u{102c}', L), ('\u{102d}',
+ '\u{1030}', NSM), ('\u{1031}', '\u{1031}', L), ('\u{1032}', '\u{1037}', NSM), ('\u{1038}',
+ '\u{1038}', L), ('\u{1039}', '\u{103a}', NSM), ('\u{103b}', '\u{103c}', L), ('\u{103d}',
+ '\u{103e}', NSM), ('\u{103f}', '\u{1057}', L), ('\u{1058}', '\u{1059}', NSM), ('\u{105a}',
+ '\u{105d}', L), ('\u{105e}', '\u{1060}', NSM), ('\u{1061}', '\u{1070}', L), ('\u{1071}',
+ '\u{1074}', NSM), ('\u{1075}', '\u{1081}', L), ('\u{1082}', '\u{1082}', NSM), ('\u{1083}',
+ '\u{1084}', L), ('\u{1085}', '\u{1086}', NSM), ('\u{1087}', '\u{108c}', L), ('\u{108d}',
+ '\u{108d}', NSM), ('\u{108e}', '\u{109c}', L), ('\u{109d}', '\u{109d}', NSM), ('\u{109e}',
+ '\u{10c5}', L), ('\u{10c7}', '\u{10c7}', L), ('\u{10cd}', '\u{10cd}', L), ('\u{10d0}',
+ '\u{1248}', L), ('\u{124a}', '\u{124d}', L), ('\u{1250}', '\u{1256}', L), ('\u{1258}',
+ '\u{1258}', L), ('\u{125a}', '\u{125d}', L), ('\u{1260}', '\u{1288}', L), ('\u{128a}',
+ '\u{128d}', L), ('\u{1290}', '\u{12b0}', L), ('\u{12b2}', '\u{12b5}', L), ('\u{12b8}',
+ '\u{12be}', L), ('\u{12c0}', '\u{12c0}', L), ('\u{12c2}', '\u{12c5}', L), ('\u{12c8}',
+ '\u{12d6}', L), ('\u{12d8}', '\u{1310}', L), ('\u{1312}', '\u{1315}', L), ('\u{1318}',
+ '\u{135a}', L), ('\u{135d}', '\u{135f}', NSM), ('\u{1360}', '\u{137c}', L), ('\u{1380}',
+ '\u{138f}', L), ('\u{1390}', '\u{1399}', ON), ('\u{13a0}', '\u{13f5}', L), ('\u{13f8}',
+ '\u{13fd}', L), ('\u{1400}', '\u{1400}', ON), ('\u{1401}', '\u{167f}', L), ('\u{1680}',
+ '\u{1680}', WS), ('\u{1681}', '\u{169a}', L), ('\u{169b}', '\u{169c}', ON), ('\u{16a0}',
+ '\u{16f8}', L), ('\u{1700}', '\u{1711}', L), ('\u{1712}', '\u{1714}', NSM), ('\u{1715}',
+ '\u{1715}', L), ('\u{171f}', '\u{1731}', L), ('\u{1732}', '\u{1733}', NSM), ('\u{1734}',
+ '\u{1736}', L), ('\u{1740}', '\u{1751}', L), ('\u{1752}', '\u{1753}', NSM), ('\u{1760}',
+ '\u{176c}', L), ('\u{176e}', '\u{1770}', L), ('\u{1772}', '\u{1773}', NSM), ('\u{1780}',
+ '\u{17b3}', L), ('\u{17b4}', '\u{17b5}', NSM), ('\u{17b6}', '\u{17b6}', L), ('\u{17b7}',
+ '\u{17bd}', NSM), ('\u{17be}', '\u{17c5}', L), ('\u{17c6}', '\u{17c6}', NSM), ('\u{17c7}',
+ '\u{17c8}', L), ('\u{17c9}', '\u{17d3}', NSM), ('\u{17d4}', '\u{17da}', L), ('\u{17db}',
+ '\u{17db}', ET), ('\u{17dc}', '\u{17dc}', L), ('\u{17dd}', '\u{17dd}', NSM), ('\u{17e0}',
+ '\u{17e9}', L), ('\u{17f0}', '\u{17f9}', ON), ('\u{1800}', '\u{180a}', ON), ('\u{180b}',
+ '\u{180d}', NSM), ('\u{180e}', '\u{180e}', BN), ('\u{180f}', '\u{180f}', NSM), ('\u{1810}',
+ '\u{1819}', L), ('\u{1820}', '\u{1878}', L), ('\u{1880}', '\u{1884}', L), ('\u{1885}',
+ '\u{1886}', NSM), ('\u{1887}', '\u{18a8}', L), ('\u{18a9}', '\u{18a9}', NSM), ('\u{18aa}',
+ '\u{18aa}', L), ('\u{18b0}', '\u{18f5}', L), ('\u{1900}', '\u{191e}', L), ('\u{1920}',
+ '\u{1922}', NSM), ('\u{1923}', '\u{1926}', L), ('\u{1927}', '\u{1928}', NSM), ('\u{1929}',
+ '\u{192b}', L), ('\u{1930}', '\u{1931}', L), ('\u{1932}', '\u{1932}', NSM), ('\u{1933}',
+ '\u{1938}', L), ('\u{1939}', '\u{193b}', NSM), ('\u{1940}', '\u{1940}', ON), ('\u{1944}',
+ '\u{1945}', ON), ('\u{1946}', '\u{196d}', L), ('\u{1970}', '\u{1974}', L), ('\u{1980}',
+ '\u{19ab}', L), ('\u{19b0}', '\u{19c9}', L), ('\u{19d0}', '\u{19da}', L), ('\u{19de}',
+ '\u{19ff}', ON), ('\u{1a00}', '\u{1a16}', L), ('\u{1a17}', '\u{1a18}', NSM), ('\u{1a19}',
+ '\u{1a1a}', L), ('\u{1a1b}', '\u{1a1b}', NSM), ('\u{1a1e}', '\u{1a55}', L), ('\u{1a56}',
+ '\u{1a56}', NSM), ('\u{1a57}', '\u{1a57}', L), ('\u{1a58}', '\u{1a5e}', NSM), ('\u{1a60}',
+ '\u{1a60}', NSM), ('\u{1a61}', '\u{1a61}', L), ('\u{1a62}', '\u{1a62}', NSM), ('\u{1a63}',
+ '\u{1a64}', L), ('\u{1a65}', '\u{1a6c}', NSM), ('\u{1a6d}', '\u{1a72}', L), ('\u{1a73}',
+ '\u{1a7c}', NSM), ('\u{1a7f}', '\u{1a7f}', NSM), ('\u{1a80}', '\u{1a89}', L), ('\u{1a90}',
+ '\u{1a99}', L), ('\u{1aa0}', '\u{1aad}', L), ('\u{1ab0}', '\u{1ace}', NSM), ('\u{1b00}',
+ '\u{1b03}', NSM), ('\u{1b04}', '\u{1b33}', L), ('\u{1b34}', '\u{1b34}', NSM), ('\u{1b35}',
+ '\u{1b35}', L), ('\u{1b36}', '\u{1b3a}', NSM), ('\u{1b3b}', '\u{1b3b}', L), ('\u{1b3c}',
+ '\u{1b3c}', NSM), ('\u{1b3d}', '\u{1b41}', L), ('\u{1b42}', '\u{1b42}', NSM), ('\u{1b43}',
+ '\u{1b4c}', L), ('\u{1b50}', '\u{1b6a}', L), ('\u{1b6b}', '\u{1b73}', NSM), ('\u{1b74}',
+ '\u{1b7e}', L), ('\u{1b80}', '\u{1b81}', NSM), ('\u{1b82}', '\u{1ba1}', L), ('\u{1ba2}',
+ '\u{1ba5}', NSM), ('\u{1ba6}', '\u{1ba7}', L), ('\u{1ba8}', '\u{1ba9}', NSM), ('\u{1baa}',
+ '\u{1baa}', L), ('\u{1bab}', '\u{1bad}', NSM), ('\u{1bae}', '\u{1be5}', L), ('\u{1be6}',
+ '\u{1be6}', NSM), ('\u{1be7}', '\u{1be7}', L), ('\u{1be8}', '\u{1be9}', NSM), ('\u{1bea}',
+ '\u{1bec}', L), ('\u{1bed}', '\u{1bed}', NSM), ('\u{1bee}', '\u{1bee}', L), ('\u{1bef}',
+ '\u{1bf1}', NSM), ('\u{1bf2}', '\u{1bf3}', L), ('\u{1bfc}', '\u{1c2b}', L), ('\u{1c2c}',
+ '\u{1c33}', NSM), ('\u{1c34}', '\u{1c35}', L), ('\u{1c36}', '\u{1c37}', NSM), ('\u{1c3b}',
+ '\u{1c49}', L), ('\u{1c4d}', '\u{1c88}', L), ('\u{1c90}', '\u{1cba}', L), ('\u{1cbd}',
+ '\u{1cc7}', L), ('\u{1cd0}', '\u{1cd2}', NSM), ('\u{1cd3}', '\u{1cd3}', L), ('\u{1cd4}',
+ '\u{1ce0}', NSM), ('\u{1ce1}', '\u{1ce1}', L), ('\u{1ce2}', '\u{1ce8}', NSM), ('\u{1ce9}',
+ '\u{1cec}', L), ('\u{1ced}', '\u{1ced}', NSM), ('\u{1cee}', '\u{1cf3}', L), ('\u{1cf4}',
+ '\u{1cf4}', NSM), ('\u{1cf5}', '\u{1cf7}', L), ('\u{1cf8}', '\u{1cf9}', NSM), ('\u{1cfa}',
+ '\u{1cfa}', L), ('\u{1d00}', '\u{1dbf}', L), ('\u{1dc0}', '\u{1dff}', NSM), ('\u{1e00}',
+ '\u{1f15}', L), ('\u{1f18}', '\u{1f1d}', L), ('\u{1f20}', '\u{1f45}', L), ('\u{1f48}',
+ '\u{1f4d}', L), ('\u{1f50}', '\u{1f57}', L), ('\u{1f59}', '\u{1f59}', L), ('\u{1f5b}',
+ '\u{1f5b}', L), ('\u{1f5d}', '\u{1f5d}', L), ('\u{1f5f}', '\u{1f7d}', L), ('\u{1f80}',
+ '\u{1fb4}', L), ('\u{1fb6}', '\u{1fbc}', L), ('\u{1fbd}', '\u{1fbd}', ON), ('\u{1fbe}',
+ '\u{1fbe}', L), ('\u{1fbf}', '\u{1fc1}', ON), ('\u{1fc2}', '\u{1fc4}', L), ('\u{1fc6}',
+ '\u{1fcc}', L), ('\u{1fcd}', '\u{1fcf}', ON), ('\u{1fd0}', '\u{1fd3}', L), ('\u{1fd6}',
+ '\u{1fdb}', L), ('\u{1fdd}', '\u{1fdf}', ON), ('\u{1fe0}', '\u{1fec}', L), ('\u{1fed}',
+ '\u{1fef}', ON), ('\u{1ff2}', '\u{1ff4}', L), ('\u{1ff6}', '\u{1ffc}', L), ('\u{1ffd}',
+ '\u{1ffe}', ON), ('\u{2000}', '\u{200a}', WS), ('\u{200b}', '\u{200d}', BN), ('\u{200e}',
+ '\u{200e}', L), ('\u{200f}', '\u{200f}', R), ('\u{2010}', '\u{2027}', ON), ('\u{2028}',
+ '\u{2028}', WS), ('\u{2029}', '\u{2029}', B), ('\u{202a}', '\u{202a}', LRE), ('\u{202b}',
+ '\u{202b}', RLE), ('\u{202c}', '\u{202c}', PDF), ('\u{202d}', '\u{202d}', LRO), ('\u{202e}',
+ '\u{202e}', RLO), ('\u{202f}', '\u{202f}', CS), ('\u{2030}', '\u{2034}', ET), ('\u{2035}',
+ '\u{2043}', ON), ('\u{2044}', '\u{2044}', CS), ('\u{2045}', '\u{205e}', ON), ('\u{205f}',
+ '\u{205f}', WS), ('\u{2060}', '\u{2064}', BN), ('\u{2066}', '\u{2066}', LRI), ('\u{2067}',
+ '\u{2067}', RLI), ('\u{2068}', '\u{2068}', FSI), ('\u{2069}', '\u{2069}', PDI), ('\u{206a}',
+ '\u{206f}', BN), ('\u{2070}', '\u{2070}', EN), ('\u{2071}', '\u{2071}', L), ('\u{2074}',
+ '\u{2079}', EN), ('\u{207a}', '\u{207b}', ES), ('\u{207c}', '\u{207e}', ON), ('\u{207f}',
+ '\u{207f}', L), ('\u{2080}', '\u{2089}', EN), ('\u{208a}', '\u{208b}', ES), ('\u{208c}',
+ '\u{208e}', ON), ('\u{2090}', '\u{209c}', L), ('\u{20a0}', '\u{20cf}', ET), ('\u{20d0}',
+ '\u{20f0}', NSM), ('\u{2100}', '\u{2101}', ON), ('\u{2102}', '\u{2102}', L), ('\u{2103}',
+ '\u{2106}', ON), ('\u{2107}', '\u{2107}', L), ('\u{2108}', '\u{2109}', ON), ('\u{210a}',
+ '\u{2113}', L), ('\u{2114}', '\u{2114}', ON), ('\u{2115}', '\u{2115}', L), ('\u{2116}',
+ '\u{2118}', ON), ('\u{2119}', '\u{211d}', L), ('\u{211e}', '\u{2123}', ON), ('\u{2124}',
+ '\u{2124}', L), ('\u{2125}', '\u{2125}', ON), ('\u{2126}', '\u{2126}', L), ('\u{2127}',
+ '\u{2127}', ON), ('\u{2128}', '\u{2128}', L), ('\u{2129}', '\u{2129}', ON), ('\u{212a}',
+ '\u{212d}', L), ('\u{212e}', '\u{212e}', ET), ('\u{212f}', '\u{2139}', L), ('\u{213a}',
+ '\u{213b}', ON), ('\u{213c}', '\u{213f}', L), ('\u{2140}', '\u{2144}', ON), ('\u{2145}',
+ '\u{2149}', L), ('\u{214a}', '\u{214d}', ON), ('\u{214e}', '\u{214f}', L), ('\u{2150}',
+ '\u{215f}', ON), ('\u{2160}', '\u{2188}', L), ('\u{2189}', '\u{218b}', ON), ('\u{2190}',
+ '\u{2211}', ON), ('\u{2212}', '\u{2212}', ES), ('\u{2213}', '\u{2213}', ET), ('\u{2214}',
+ '\u{2335}', ON), ('\u{2336}', '\u{237a}', L), ('\u{237b}', '\u{2394}', ON), ('\u{2395}',
+ '\u{2395}', L), ('\u{2396}', '\u{2426}', ON), ('\u{2440}', '\u{244a}', ON), ('\u{2460}',
+ '\u{2487}', ON), ('\u{2488}', '\u{249b}', EN), ('\u{249c}', '\u{24e9}', L), ('\u{24ea}',
+ '\u{26ab}', ON), ('\u{26ac}', '\u{26ac}', L), ('\u{26ad}', '\u{27ff}', ON), ('\u{2800}',
+ '\u{28ff}', L), ('\u{2900}', '\u{2b73}', ON), ('\u{2b76}', '\u{2b95}', ON), ('\u{2b97}',
+ '\u{2bff}', ON), ('\u{2c00}', '\u{2ce4}', L), ('\u{2ce5}', '\u{2cea}', ON), ('\u{2ceb}',
+ '\u{2cee}', L), ('\u{2cef}', '\u{2cf1}', NSM), ('\u{2cf2}', '\u{2cf3}', L), ('\u{2cf9}',
+ '\u{2cff}', ON), ('\u{2d00}', '\u{2d25}', L), ('\u{2d27}', '\u{2d27}', L), ('\u{2d2d}',
+ '\u{2d2d}', L), ('\u{2d30}', '\u{2d67}', L), ('\u{2d6f}', '\u{2d70}', L), ('\u{2d7f}',
+ '\u{2d7f}', NSM), ('\u{2d80}', '\u{2d96}', L), ('\u{2da0}', '\u{2da6}', L), ('\u{2da8}',
+ '\u{2dae}', L), ('\u{2db0}', '\u{2db6}', L), ('\u{2db8}', '\u{2dbe}', L), ('\u{2dc0}',
+ '\u{2dc6}', L), ('\u{2dc8}', '\u{2dce}', L), ('\u{2dd0}', '\u{2dd6}', L), ('\u{2dd8}',
+ '\u{2dde}', L), ('\u{2de0}', '\u{2dff}', NSM), ('\u{2e00}', '\u{2e5d}', ON), ('\u{2e80}',
+ '\u{2e99}', ON), ('\u{2e9b}', '\u{2ef3}', ON), ('\u{2f00}', '\u{2fd5}', ON), ('\u{2ff0}',
+ '\u{2ffb}', ON), ('\u{3000}', '\u{3000}', WS), ('\u{3001}', '\u{3004}', ON), ('\u{3005}',
+ '\u{3007}', L), ('\u{3008}', '\u{3020}', ON), ('\u{3021}', '\u{3029}', L), ('\u{302a}',
+ '\u{302d}', NSM), ('\u{302e}', '\u{302f}', L), ('\u{3030}', '\u{3030}', ON), ('\u{3031}',
+ '\u{3035}', L), ('\u{3036}', '\u{3037}', ON), ('\u{3038}', '\u{303c}', L), ('\u{303d}',
+ '\u{303f}', ON), ('\u{3041}', '\u{3096}', L), ('\u{3099}', '\u{309a}', NSM), ('\u{309b}',
+ '\u{309c}', ON), ('\u{309d}', '\u{309f}', L), ('\u{30a0}', '\u{30a0}', ON), ('\u{30a1}',
+ '\u{30fa}', L), ('\u{30fb}', '\u{30fb}', ON), ('\u{30fc}', '\u{30ff}', L), ('\u{3105}',
+ '\u{312f}', L), ('\u{3131}', '\u{318e}', L), ('\u{3190}', '\u{31bf}', L), ('\u{31c0}',
+ '\u{31e3}', ON), ('\u{31f0}', '\u{321c}', L), ('\u{321d}', '\u{321e}', ON), ('\u{3220}',
+ '\u{324f}', L), ('\u{3250}', '\u{325f}', ON), ('\u{3260}', '\u{327b}', L), ('\u{327c}',
+ '\u{327e}', ON), ('\u{327f}', '\u{32b0}', L), ('\u{32b1}', '\u{32bf}', ON), ('\u{32c0}',
+ '\u{32cb}', L), ('\u{32cc}', '\u{32cf}', ON), ('\u{32d0}', '\u{3376}', L), ('\u{3377}',
+ '\u{337a}', ON), ('\u{337b}', '\u{33dd}', L), ('\u{33de}', '\u{33df}', ON), ('\u{33e0}',
+ '\u{33fe}', L), ('\u{33ff}', '\u{33ff}', ON), ('\u{3400}', '\u{4dbf}', L), ('\u{4dc0}',
+ '\u{4dff}', ON), ('\u{4e00}', '\u{a48c}', L), ('\u{a490}', '\u{a4c6}', ON), ('\u{a4d0}',
+ '\u{a60c}', L), ('\u{a60d}', '\u{a60f}', ON), ('\u{a610}', '\u{a62b}', L), ('\u{a640}',
+ '\u{a66e}', L), ('\u{a66f}', '\u{a672}', NSM), ('\u{a673}', '\u{a673}', ON), ('\u{a674}',
+ '\u{a67d}', NSM), ('\u{a67e}', '\u{a67f}', ON), ('\u{a680}', '\u{a69d}', L), ('\u{a69e}',
+ '\u{a69f}', NSM), ('\u{a6a0}', '\u{a6ef}', L), ('\u{a6f0}', '\u{a6f1}', NSM), ('\u{a6f2}',
+ '\u{a6f7}', L), ('\u{a700}', '\u{a721}', ON), ('\u{a722}', '\u{a787}', L), ('\u{a788}',
+ '\u{a788}', ON), ('\u{a789}', '\u{a7ca}', L), ('\u{a7d0}', '\u{a7d1}', L), ('\u{a7d3}',
+ '\u{a7d3}', L), ('\u{a7d5}', '\u{a7d9}', L), ('\u{a7f2}', '\u{a801}', L), ('\u{a802}',
+ '\u{a802}', NSM), ('\u{a803}', '\u{a805}', L), ('\u{a806}', '\u{a806}', NSM), ('\u{a807}',
+ '\u{a80a}', L), ('\u{a80b}', '\u{a80b}', NSM), ('\u{a80c}', '\u{a824}', L), ('\u{a825}',
+ '\u{a826}', NSM), ('\u{a827}', '\u{a827}', L), ('\u{a828}', '\u{a82b}', ON), ('\u{a82c}',
+ '\u{a82c}', NSM), ('\u{a830}', '\u{a837}', L), ('\u{a838}', '\u{a839}', ET), ('\u{a840}',
+ '\u{a873}', L), ('\u{a874}', '\u{a877}', ON), ('\u{a880}', '\u{a8c3}', L), ('\u{a8c4}',
+ '\u{a8c5}', NSM), ('\u{a8ce}', '\u{a8d9}', L), ('\u{a8e0}', '\u{a8f1}', NSM), ('\u{a8f2}',
+ '\u{a8fe}', L), ('\u{a8ff}', '\u{a8ff}', NSM), ('\u{a900}', '\u{a925}', L), ('\u{a926}',
+ '\u{a92d}', NSM), ('\u{a92e}', '\u{a946}', L), ('\u{a947}', '\u{a951}', NSM), ('\u{a952}',
+ '\u{a953}', L), ('\u{a95f}', '\u{a97c}', L), ('\u{a980}', '\u{a982}', NSM), ('\u{a983}',
+ '\u{a9b2}', L), ('\u{a9b3}', '\u{a9b3}', NSM), ('\u{a9b4}', '\u{a9b5}', L), ('\u{a9b6}',
+ '\u{a9b9}', NSM), ('\u{a9ba}', '\u{a9bb}', L), ('\u{a9bc}', '\u{a9bd}', NSM), ('\u{a9be}',
+ '\u{a9cd}', L), ('\u{a9cf}', '\u{a9d9}', L), ('\u{a9de}', '\u{a9e4}', L), ('\u{a9e5}',
+ '\u{a9e5}', NSM), ('\u{a9e6}', '\u{a9fe}', L), ('\u{aa00}', '\u{aa28}', L), ('\u{aa29}',
+ '\u{aa2e}', NSM), ('\u{aa2f}', '\u{aa30}', L), ('\u{aa31}', '\u{aa32}', NSM), ('\u{aa33}',
+ '\u{aa34}', L), ('\u{aa35}', '\u{aa36}', NSM), ('\u{aa40}', '\u{aa42}', L), ('\u{aa43}',
+ '\u{aa43}', NSM), ('\u{aa44}', '\u{aa4b}', L), ('\u{aa4c}', '\u{aa4c}', NSM), ('\u{aa4d}',
+ '\u{aa4d}', L), ('\u{aa50}', '\u{aa59}', L), ('\u{aa5c}', '\u{aa7b}', L), ('\u{aa7c}',
+ '\u{aa7c}', NSM), ('\u{aa7d}', '\u{aaaf}', L), ('\u{aab0}', '\u{aab0}', NSM), ('\u{aab1}',
+ '\u{aab1}', L), ('\u{aab2}', '\u{aab4}', NSM), ('\u{aab5}', '\u{aab6}', L), ('\u{aab7}',
+ '\u{aab8}', NSM), ('\u{aab9}', '\u{aabd}', L), ('\u{aabe}', '\u{aabf}', NSM), ('\u{aac0}',
+ '\u{aac0}', L), ('\u{aac1}', '\u{aac1}', NSM), ('\u{aac2}', '\u{aac2}', L), ('\u{aadb}',
+ '\u{aaeb}', L), ('\u{aaec}', '\u{aaed}', NSM), ('\u{aaee}', '\u{aaf5}', L), ('\u{aaf6}',
+ '\u{aaf6}', NSM), ('\u{ab01}', '\u{ab06}', L), ('\u{ab09}', '\u{ab0e}', L), ('\u{ab11}',
+ '\u{ab16}', L), ('\u{ab20}', '\u{ab26}', L), ('\u{ab28}', '\u{ab2e}', L), ('\u{ab30}',
+ '\u{ab69}', L), ('\u{ab6a}', '\u{ab6b}', ON), ('\u{ab70}', '\u{abe4}', L), ('\u{abe5}',
+ '\u{abe5}', NSM), ('\u{abe6}', '\u{abe7}', L), ('\u{abe8}', '\u{abe8}', NSM), ('\u{abe9}',
+ '\u{abec}', L), ('\u{abed}', '\u{abed}', NSM), ('\u{abf0}', '\u{abf9}', L), ('\u{ac00}',
+ '\u{d7a3}', L), ('\u{d7b0}', '\u{d7c6}', L), ('\u{d7cb}', '\u{d7fb}', L), ('\u{e000}',
+ '\u{fa6d}', L), ('\u{fa70}', '\u{fad9}', L), ('\u{fb00}', '\u{fb06}', L), ('\u{fb13}',
+ '\u{fb17}', L), ('\u{fb1d}', '\u{fb1d}', R), ('\u{fb1e}', '\u{fb1e}', NSM), ('\u{fb1f}',
+ '\u{fb28}', R), ('\u{fb29}', '\u{fb29}', ES), ('\u{fb2a}', '\u{fb4f}', R), ('\u{fb50}',
+ '\u{fd3d}', AL), ('\u{fd3e}', '\u{fd4f}', ON), ('\u{fd50}', '\u{fdce}', AL), ('\u{fdcf}',
+ '\u{fdcf}', ON), ('\u{fdf0}', '\u{fdfc}', AL), ('\u{fdfd}', '\u{fdff}', ON), ('\u{fe00}',
+ '\u{fe0f}', NSM), ('\u{fe10}', '\u{fe19}', ON), ('\u{fe20}', '\u{fe2f}', NSM), ('\u{fe30}',
+ '\u{fe4f}', ON), ('\u{fe50}', '\u{fe50}', CS), ('\u{fe51}', '\u{fe51}', ON), ('\u{fe52}',
+ '\u{fe52}', CS), ('\u{fe54}', '\u{fe54}', ON), ('\u{fe55}', '\u{fe55}', CS), ('\u{fe56}',
+ '\u{fe5e}', ON), ('\u{fe5f}', '\u{fe5f}', ET), ('\u{fe60}', '\u{fe61}', ON), ('\u{fe62}',
+ '\u{fe63}', ES), ('\u{fe64}', '\u{fe66}', ON), ('\u{fe68}', '\u{fe68}', ON), ('\u{fe69}',
+ '\u{fe6a}', ET), ('\u{fe6b}', '\u{fe6b}', ON), ('\u{fe70}', '\u{fefe}', AL), ('\u{feff}',
+ '\u{feff}', BN), ('\u{ff01}', '\u{ff02}', ON), ('\u{ff03}', '\u{ff05}', ET), ('\u{ff06}',
+ '\u{ff0a}', ON), ('\u{ff0b}', '\u{ff0b}', ES), ('\u{ff0c}', '\u{ff0c}', CS), ('\u{ff0d}',
+ '\u{ff0d}', ES), ('\u{ff0e}', '\u{ff0f}', CS), ('\u{ff10}', '\u{ff19}', EN), ('\u{ff1a}',
+ '\u{ff1a}', CS), ('\u{ff1b}', '\u{ff20}', ON), ('\u{ff21}', '\u{ff3a}', L), ('\u{ff3b}',
+ '\u{ff40}', ON), ('\u{ff41}', '\u{ff5a}', L), ('\u{ff5b}', '\u{ff65}', ON), ('\u{ff66}',
+ '\u{ffbe}', L), ('\u{ffc2}', '\u{ffc7}', L), ('\u{ffca}', '\u{ffcf}', L), ('\u{ffd2}',
+ '\u{ffd7}', L), ('\u{ffda}', '\u{ffdc}', L), ('\u{ffe0}', '\u{ffe1}', ET), ('\u{ffe2}',
+ '\u{ffe4}', ON), ('\u{ffe5}', '\u{ffe6}', ET), ('\u{ffe8}', '\u{ffee}', ON), ('\u{fff9}',
+ '\u{fffd}', ON), ('\u{10000}', '\u{1000b}', L), ('\u{1000d}', '\u{10026}', L), ('\u{10028}',
+ '\u{1003a}', L), ('\u{1003c}', '\u{1003d}', L), ('\u{1003f}', '\u{1004d}', L), ('\u{10050}',
+ '\u{1005d}', L), ('\u{10080}', '\u{100fa}', L), ('\u{10100}', '\u{10100}', L), ('\u{10101}',
+ '\u{10101}', ON), ('\u{10102}', '\u{10102}', L), ('\u{10107}', '\u{10133}', L), ('\u{10137}',
+ '\u{1013f}', L), ('\u{10140}', '\u{1018c}', ON), ('\u{1018d}', '\u{1018e}', L), ('\u{10190}',
+ '\u{1019c}', ON), ('\u{101a0}', '\u{101a0}', ON), ('\u{101d0}', '\u{101fc}', L), ('\u{101fd}',
+ '\u{101fd}', NSM), ('\u{10280}', '\u{1029c}', L), ('\u{102a0}', '\u{102d0}', L), ('\u{102e0}',
+ '\u{102e0}', NSM), ('\u{102e1}', '\u{102fb}', EN), ('\u{10300}', '\u{10323}', L), ('\u{1032d}',
+ '\u{1034a}', L), ('\u{10350}', '\u{10375}', L), ('\u{10376}', '\u{1037a}', NSM), ('\u{10380}',
+ '\u{1039d}', L), ('\u{1039f}', '\u{103c3}', L), ('\u{103c8}', '\u{103d5}', L), ('\u{10400}',
+ '\u{1049d}', L), ('\u{104a0}', '\u{104a9}', L), ('\u{104b0}', '\u{104d3}', L), ('\u{104d8}',
+ '\u{104fb}', L), ('\u{10500}', '\u{10527}', L), ('\u{10530}', '\u{10563}', L), ('\u{1056f}',
+ '\u{1057a}', L), ('\u{1057c}', '\u{1058a}', L), ('\u{1058c}', '\u{10592}', L), ('\u{10594}',
+ '\u{10595}', L), ('\u{10597}', '\u{105a1}', L), ('\u{105a3}', '\u{105b1}', L), ('\u{105b3}',
+ '\u{105b9}', L), ('\u{105bb}', '\u{105bc}', L), ('\u{10600}', '\u{10736}', L), ('\u{10740}',
+ '\u{10755}', L), ('\u{10760}', '\u{10767}', L), ('\u{10780}', '\u{10785}', L), ('\u{10787}',
+ '\u{107b0}', L), ('\u{107b2}', '\u{107ba}', L), ('\u{10800}', '\u{1091e}', R), ('\u{1091f}',
+ '\u{1091f}', ON), ('\u{10920}', '\u{10a00}', R), ('\u{10a01}', '\u{10a03}', NSM), ('\u{10a04}',
+ '\u{10a04}', R), ('\u{10a05}', '\u{10a06}', NSM), ('\u{10a07}', '\u{10a0b}', R), ('\u{10a0c}',
+ '\u{10a0f}', NSM), ('\u{10a10}', '\u{10a37}', R), ('\u{10a38}', '\u{10a3a}', NSM), ('\u{10a3b}',
+ '\u{10a3e}', R), ('\u{10a3f}', '\u{10a3f}', NSM), ('\u{10a40}', '\u{10ae4}', R), ('\u{10ae5}',
+ '\u{10ae6}', NSM), ('\u{10ae7}', '\u{10b38}', R), ('\u{10b39}', '\u{10b3f}', ON), ('\u{10b40}',
+ '\u{10cff}', R), ('\u{10d00}', '\u{10d23}', AL), ('\u{10d24}', '\u{10d27}', NSM), ('\u{10d28}',
+ '\u{10d2f}', R), ('\u{10d30}', '\u{10d39}', AN), ('\u{10d3a}', '\u{10e5f}', R), ('\u{10e60}',
+ '\u{10e7e}', AN), ('\u{10e7f}', '\u{10eaa}', R), ('\u{10eab}', '\u{10eac}', NSM), ('\u{10ead}',
+ '\u{10efc}', R), ('\u{10efd}', '\u{10eff}', NSM), ('\u{10f00}', '\u{10f2f}', R), ('\u{10f30}',
+ '\u{10f45}', AL), ('\u{10f46}', '\u{10f50}', NSM), ('\u{10f51}', '\u{10f59}', AL), ('\u{10f5a}',
+ '\u{10f81}', R), ('\u{10f82}', '\u{10f85}', NSM), ('\u{10f86}', '\u{10fff}', R), ('\u{11000}',
+ '\u{11000}', L), ('\u{11001}', '\u{11001}', NSM), ('\u{11002}', '\u{11037}', L), ('\u{11038}',
+ '\u{11046}', NSM), ('\u{11047}', '\u{1104d}', L), ('\u{11052}', '\u{11065}', ON), ('\u{11066}',
+ '\u{1106f}', L), ('\u{11070}', '\u{11070}', NSM), ('\u{11071}', '\u{11072}', L), ('\u{11073}',
+ '\u{11074}', NSM), ('\u{11075}', '\u{11075}', L), ('\u{1107f}', '\u{11081}', NSM), ('\u{11082}',
+ '\u{110b2}', L), ('\u{110b3}', '\u{110b6}', NSM), ('\u{110b7}', '\u{110b8}', L), ('\u{110b9}',
+ '\u{110ba}', NSM), ('\u{110bb}', '\u{110c1}', L), ('\u{110c2}', '\u{110c2}', NSM), ('\u{110cd}',
+ '\u{110cd}', L), ('\u{110d0}', '\u{110e8}', L), ('\u{110f0}', '\u{110f9}', L), ('\u{11100}',
+ '\u{11102}', NSM), ('\u{11103}', '\u{11126}', L), ('\u{11127}', '\u{1112b}', NSM), ('\u{1112c}',
+ '\u{1112c}', L), ('\u{1112d}', '\u{11134}', NSM), ('\u{11136}', '\u{11147}', L), ('\u{11150}',
+ '\u{11172}', L), ('\u{11173}', '\u{11173}', NSM), ('\u{11174}', '\u{11176}', L), ('\u{11180}',
+ '\u{11181}', NSM), ('\u{11182}', '\u{111b5}', L), ('\u{111b6}', '\u{111be}', NSM), ('\u{111bf}',
+ '\u{111c8}', L), ('\u{111c9}', '\u{111cc}', NSM), ('\u{111cd}', '\u{111ce}', L), ('\u{111cf}',
+ '\u{111cf}', NSM), ('\u{111d0}', '\u{111df}', L), ('\u{111e1}', '\u{111f4}', L), ('\u{11200}',
+ '\u{11211}', L), ('\u{11213}', '\u{1122e}', L), ('\u{1122f}', '\u{11231}', NSM), ('\u{11232}',
+ '\u{11233}', L), ('\u{11234}', '\u{11234}', NSM), ('\u{11235}', '\u{11235}', L), ('\u{11236}',
+ '\u{11237}', NSM), ('\u{11238}', '\u{1123d}', L), ('\u{1123e}', '\u{1123e}', NSM), ('\u{1123f}',
+ '\u{11240}', L), ('\u{11241}', '\u{11241}', NSM), ('\u{11280}', '\u{11286}', L), ('\u{11288}',
+ '\u{11288}', L), ('\u{1128a}', '\u{1128d}', L), ('\u{1128f}', '\u{1129d}', L), ('\u{1129f}',
+ '\u{112a9}', L), ('\u{112b0}', '\u{112de}', L), ('\u{112df}', '\u{112df}', NSM), ('\u{112e0}',
+ '\u{112e2}', L), ('\u{112e3}', '\u{112ea}', NSM), ('\u{112f0}', '\u{112f9}', L), ('\u{11300}',
+ '\u{11301}', NSM), ('\u{11302}', '\u{11303}', L), ('\u{11305}', '\u{1130c}', L), ('\u{1130f}',
+ '\u{11310}', L), ('\u{11313}', '\u{11328}', L), ('\u{1132a}', '\u{11330}', L), ('\u{11332}',
+ '\u{11333}', L), ('\u{11335}', '\u{11339}', L), ('\u{1133b}', '\u{1133c}', NSM), ('\u{1133d}',
+ '\u{1133f}', L), ('\u{11340}', '\u{11340}', NSM), ('\u{11341}', '\u{11344}', L), ('\u{11347}',
+ '\u{11348}', L), ('\u{1134b}', '\u{1134d}', L), ('\u{11350}', '\u{11350}', L), ('\u{11357}',
+ '\u{11357}', L), ('\u{1135d}', '\u{11363}', L), ('\u{11366}', '\u{1136c}', NSM), ('\u{11370}',
+ '\u{11374}', NSM), ('\u{11400}', '\u{11437}', L), ('\u{11438}', '\u{1143f}', NSM), ('\u{11440}',
+ '\u{11441}', L), ('\u{11442}', '\u{11444}', NSM), ('\u{11445}', '\u{11445}', L), ('\u{11446}',
+ '\u{11446}', NSM), ('\u{11447}', '\u{1145b}', L), ('\u{1145d}', '\u{1145d}', L), ('\u{1145e}',
+ '\u{1145e}', NSM), ('\u{1145f}', '\u{11461}', L), ('\u{11480}', '\u{114b2}', L), ('\u{114b3}',
+ '\u{114b8}', NSM), ('\u{114b9}', '\u{114b9}', L), ('\u{114ba}', '\u{114ba}', NSM), ('\u{114bb}',
+ '\u{114be}', L), ('\u{114bf}', '\u{114c0}', NSM), ('\u{114c1}', '\u{114c1}', L), ('\u{114c2}',
+ '\u{114c3}', NSM), ('\u{114c4}', '\u{114c7}', L), ('\u{114d0}', '\u{114d9}', L), ('\u{11580}',
+ '\u{115b1}', L), ('\u{115b2}', '\u{115b5}', NSM), ('\u{115b8}', '\u{115bb}', L), ('\u{115bc}',
+ '\u{115bd}', NSM), ('\u{115be}', '\u{115be}', L), ('\u{115bf}', '\u{115c0}', NSM), ('\u{115c1}',
+ '\u{115db}', L), ('\u{115dc}', '\u{115dd}', NSM), ('\u{11600}', '\u{11632}', L), ('\u{11633}',
+ '\u{1163a}', NSM), ('\u{1163b}', '\u{1163c}', L), ('\u{1163d}', '\u{1163d}', NSM), ('\u{1163e}',
+ '\u{1163e}', L), ('\u{1163f}', '\u{11640}', NSM), ('\u{11641}', '\u{11644}', L), ('\u{11650}',
+ '\u{11659}', L), ('\u{11660}', '\u{1166c}', ON), ('\u{11680}', '\u{116aa}', L), ('\u{116ab}',
+ '\u{116ab}', NSM), ('\u{116ac}', '\u{116ac}', L), ('\u{116ad}', '\u{116ad}', NSM), ('\u{116ae}',
+ '\u{116af}', L), ('\u{116b0}', '\u{116b5}', NSM), ('\u{116b6}', '\u{116b6}', L), ('\u{116b7}',
+ '\u{116b7}', NSM), ('\u{116b8}', '\u{116b9}', L), ('\u{116c0}', '\u{116c9}', L), ('\u{11700}',
+ '\u{1171a}', L), ('\u{1171d}', '\u{1171f}', NSM), ('\u{11720}', '\u{11721}', L), ('\u{11722}',
+ '\u{11725}', NSM), ('\u{11726}', '\u{11726}', L), ('\u{11727}', '\u{1172b}', NSM), ('\u{11730}',
+ '\u{11746}', L), ('\u{11800}', '\u{1182e}', L), ('\u{1182f}', '\u{11837}', NSM), ('\u{11838}',
+ '\u{11838}', L), ('\u{11839}', '\u{1183a}', NSM), ('\u{1183b}', '\u{1183b}', L), ('\u{118a0}',
+ '\u{118f2}', L), ('\u{118ff}', '\u{11906}', L), ('\u{11909}', '\u{11909}', L), ('\u{1190c}',
+ '\u{11913}', L), ('\u{11915}', '\u{11916}', L), ('\u{11918}', '\u{11935}', L), ('\u{11937}',
+ '\u{11938}', L), ('\u{1193b}', '\u{1193c}', NSM), ('\u{1193d}', '\u{1193d}', L), ('\u{1193e}',
+ '\u{1193e}', NSM), ('\u{1193f}', '\u{11942}', L), ('\u{11943}', '\u{11943}', NSM), ('\u{11944}',
+ '\u{11946}', L), ('\u{11950}', '\u{11959}', L), ('\u{119a0}', '\u{119a7}', L), ('\u{119aa}',
+ '\u{119d3}', L), ('\u{119d4}', '\u{119d7}', NSM), ('\u{119da}', '\u{119db}', NSM), ('\u{119dc}',
+ '\u{119df}', L), ('\u{119e0}', '\u{119e0}', NSM), ('\u{119e1}', '\u{119e4}', L), ('\u{11a00}',
+ '\u{11a00}', L), ('\u{11a01}', '\u{11a06}', NSM), ('\u{11a07}', '\u{11a08}', L), ('\u{11a09}',
+ '\u{11a0a}', NSM), ('\u{11a0b}', '\u{11a32}', L), ('\u{11a33}', '\u{11a38}', NSM), ('\u{11a39}',
+ '\u{11a3a}', L), ('\u{11a3b}', '\u{11a3e}', NSM), ('\u{11a3f}', '\u{11a46}', L), ('\u{11a47}',
+ '\u{11a47}', NSM), ('\u{11a50}', '\u{11a50}', L), ('\u{11a51}', '\u{11a56}', NSM), ('\u{11a57}',
+ '\u{11a58}', L), ('\u{11a59}', '\u{11a5b}', NSM), ('\u{11a5c}', '\u{11a89}', L), ('\u{11a8a}',
+ '\u{11a96}', NSM), ('\u{11a97}', '\u{11a97}', L), ('\u{11a98}', '\u{11a99}', NSM), ('\u{11a9a}',
+ '\u{11aa2}', L), ('\u{11ab0}', '\u{11af8}', L), ('\u{11b00}', '\u{11b09}', L), ('\u{11c00}',
+ '\u{11c08}', L), ('\u{11c0a}', '\u{11c2f}', L), ('\u{11c30}', '\u{11c36}', NSM), ('\u{11c38}',
+ '\u{11c3d}', NSM), ('\u{11c3e}', '\u{11c45}', L), ('\u{11c50}', '\u{11c6c}', L), ('\u{11c70}',
+ '\u{11c8f}', L), ('\u{11c92}', '\u{11ca7}', NSM), ('\u{11ca9}', '\u{11ca9}', L), ('\u{11caa}',
+ '\u{11cb0}', NSM), ('\u{11cb1}', '\u{11cb1}', L), ('\u{11cb2}', '\u{11cb3}', NSM), ('\u{11cb4}',
+ '\u{11cb4}', L), ('\u{11cb5}', '\u{11cb6}', NSM), ('\u{11d00}', '\u{11d06}', L), ('\u{11d08}',
+ '\u{11d09}', L), ('\u{11d0b}', '\u{11d30}', L), ('\u{11d31}', '\u{11d36}', NSM), ('\u{11d3a}',
+ '\u{11d3a}', NSM), ('\u{11d3c}', '\u{11d3d}', NSM), ('\u{11d3f}', '\u{11d45}', NSM),
+ ('\u{11d46}', '\u{11d46}', L), ('\u{11d47}', '\u{11d47}', NSM), ('\u{11d50}', '\u{11d59}', L),
+ ('\u{11d60}', '\u{11d65}', L), ('\u{11d67}', '\u{11d68}', L), ('\u{11d6a}', '\u{11d8e}', L),
+ ('\u{11d90}', '\u{11d91}', NSM), ('\u{11d93}', '\u{11d94}', L), ('\u{11d95}', '\u{11d95}', NSM),
+ ('\u{11d96}', '\u{11d96}', L), ('\u{11d97}', '\u{11d97}', NSM), ('\u{11d98}', '\u{11d98}', L),
+ ('\u{11da0}', '\u{11da9}', L), ('\u{11ee0}', '\u{11ef2}', L), ('\u{11ef3}', '\u{11ef4}', NSM),
+ ('\u{11ef5}', '\u{11ef8}', L), ('\u{11f00}', '\u{11f01}', NSM), ('\u{11f02}', '\u{11f10}', L),
+ ('\u{11f12}', '\u{11f35}', L), ('\u{11f36}', '\u{11f3a}', NSM), ('\u{11f3e}', '\u{11f3f}', L),
+ ('\u{11f40}', '\u{11f40}', NSM), ('\u{11f41}', '\u{11f41}', L), ('\u{11f42}', '\u{11f42}', NSM),
+ ('\u{11f43}', '\u{11f59}', L), ('\u{11fb0}', '\u{11fb0}', L), ('\u{11fc0}', '\u{11fd4}', L),
+ ('\u{11fd5}', '\u{11fdc}', ON), ('\u{11fdd}', '\u{11fe0}', ET), ('\u{11fe1}', '\u{11ff1}', ON),
+ ('\u{11fff}', '\u{12399}', L), ('\u{12400}', '\u{1246e}', L), ('\u{12470}', '\u{12474}', L),
+ ('\u{12480}', '\u{12543}', L), ('\u{12f90}', '\u{12ff2}', L), ('\u{13000}', '\u{1343f}', L),
+ ('\u{13440}', '\u{13440}', NSM), ('\u{13441}', '\u{13446}', L), ('\u{13447}', '\u{13455}', NSM),
+ ('\u{14400}', '\u{14646}', L), ('\u{16800}', '\u{16a38}', L), ('\u{16a40}', '\u{16a5e}', L),
+ ('\u{16a60}', '\u{16a69}', L), ('\u{16a6e}', '\u{16abe}', L), ('\u{16ac0}', '\u{16ac9}', L),
+ ('\u{16ad0}', '\u{16aed}', L), ('\u{16af0}', '\u{16af4}', NSM), ('\u{16af5}', '\u{16af5}', L),
+ ('\u{16b00}', '\u{16b2f}', L), ('\u{16b30}', '\u{16b36}', NSM), ('\u{16b37}', '\u{16b45}', L),
+ ('\u{16b50}', '\u{16b59}', L), ('\u{16b5b}', '\u{16b61}', L), ('\u{16b63}', '\u{16b77}', L),
+ ('\u{16b7d}', '\u{16b8f}', L), ('\u{16e40}', '\u{16e9a}', L), ('\u{16f00}', '\u{16f4a}', L),
+ ('\u{16f4f}', '\u{16f4f}', NSM), ('\u{16f50}', '\u{16f87}', L), ('\u{16f8f}', '\u{16f92}', NSM),
+ ('\u{16f93}', '\u{16f9f}', L), ('\u{16fe0}', '\u{16fe1}', L), ('\u{16fe2}', '\u{16fe2}', ON),
+ ('\u{16fe3}', '\u{16fe3}', L), ('\u{16fe4}', '\u{16fe4}', NSM), ('\u{16ff0}', '\u{16ff1}', L),
+ ('\u{17000}', '\u{187f7}', L), ('\u{18800}', '\u{18cd5}', L), ('\u{18d00}', '\u{18d08}', L),
+ ('\u{1aff0}', '\u{1aff3}', L), ('\u{1aff5}', '\u{1affb}', L), ('\u{1affd}', '\u{1affe}', L),
+ ('\u{1b000}', '\u{1b122}', L), ('\u{1b132}', '\u{1b132}', L), ('\u{1b150}', '\u{1b152}', L),
+ ('\u{1b155}', '\u{1b155}', L), ('\u{1b164}', '\u{1b167}', L), ('\u{1b170}', '\u{1b2fb}', L),
+ ('\u{1bc00}', '\u{1bc6a}', L), ('\u{1bc70}', '\u{1bc7c}', L), ('\u{1bc80}', '\u{1bc88}', L),
+ ('\u{1bc90}', '\u{1bc99}', L), ('\u{1bc9c}', '\u{1bc9c}', L), ('\u{1bc9d}', '\u{1bc9e}', NSM),
+ ('\u{1bc9f}', '\u{1bc9f}', L), ('\u{1bca0}', '\u{1bca3}', BN), ('\u{1cf00}', '\u{1cf2d}', NSM),
+ ('\u{1cf30}', '\u{1cf46}', NSM), ('\u{1cf50}', '\u{1cfc3}', L), ('\u{1d000}', '\u{1d0f5}', L),
+ ('\u{1d100}', '\u{1d126}', L), ('\u{1d129}', '\u{1d166}', L), ('\u{1d167}', '\u{1d169}', NSM),
+ ('\u{1d16a}', '\u{1d172}', L), ('\u{1d173}', '\u{1d17a}', BN), ('\u{1d17b}', '\u{1d182}', NSM),
+ ('\u{1d183}', '\u{1d184}', L), ('\u{1d185}', '\u{1d18b}', NSM), ('\u{1d18c}', '\u{1d1a9}', L),
+ ('\u{1d1aa}', '\u{1d1ad}', NSM), ('\u{1d1ae}', '\u{1d1e8}', L), ('\u{1d1e9}', '\u{1d1ea}', ON),
+ ('\u{1d200}', '\u{1d241}', ON), ('\u{1d242}', '\u{1d244}', NSM), ('\u{1d245}', '\u{1d245}', ON),
+ ('\u{1d2c0}', '\u{1d2d3}', L), ('\u{1d2e0}', '\u{1d2f3}', L), ('\u{1d300}', '\u{1d356}', ON),
+ ('\u{1d360}', '\u{1d378}', L), ('\u{1d400}', '\u{1d454}', L), ('\u{1d456}', '\u{1d49c}', L),
+ ('\u{1d49e}', '\u{1d49f}', L), ('\u{1d4a2}', '\u{1d4a2}', L), ('\u{1d4a5}', '\u{1d4a6}', L),
+ ('\u{1d4a9}', '\u{1d4ac}', L), ('\u{1d4ae}', '\u{1d4b9}', L), ('\u{1d4bb}', '\u{1d4bb}', L),
+ ('\u{1d4bd}', '\u{1d4c3}', L), ('\u{1d4c5}', '\u{1d505}', L), ('\u{1d507}', '\u{1d50a}', L),
+ ('\u{1d50d}', '\u{1d514}', L), ('\u{1d516}', '\u{1d51c}', L), ('\u{1d51e}', '\u{1d539}', L),
+ ('\u{1d53b}', '\u{1d53e}', L), ('\u{1d540}', '\u{1d544}', L), ('\u{1d546}', '\u{1d546}', L),
+ ('\u{1d54a}', '\u{1d550}', L), ('\u{1d552}', '\u{1d6a5}', L), ('\u{1d6a8}', '\u{1d6da}', L),
+ ('\u{1d6db}', '\u{1d6db}', ON), ('\u{1d6dc}', '\u{1d714}', L), ('\u{1d715}', '\u{1d715}', ON),
+ ('\u{1d716}', '\u{1d74e}', L), ('\u{1d74f}', '\u{1d74f}', ON), ('\u{1d750}', '\u{1d788}', L),
+ ('\u{1d789}', '\u{1d789}', ON), ('\u{1d78a}', '\u{1d7c2}', L), ('\u{1d7c3}', '\u{1d7c3}', ON),
+ ('\u{1d7c4}', '\u{1d7cb}', L), ('\u{1d7ce}', '\u{1d7ff}', EN), ('\u{1d800}', '\u{1d9ff}', L),
+ ('\u{1da00}', '\u{1da36}', NSM), ('\u{1da37}', '\u{1da3a}', L), ('\u{1da3b}', '\u{1da6c}', NSM),
+ ('\u{1da6d}', '\u{1da74}', L), ('\u{1da75}', '\u{1da75}', NSM), ('\u{1da76}', '\u{1da83}', L),
+ ('\u{1da84}', '\u{1da84}', NSM), ('\u{1da85}', '\u{1da8b}', L), ('\u{1da9b}', '\u{1da9f}', NSM),
+ ('\u{1daa1}', '\u{1daaf}', NSM), ('\u{1df00}', '\u{1df1e}', L), ('\u{1df25}', '\u{1df2a}', L),
+ ('\u{1e000}', '\u{1e006}', NSM), ('\u{1e008}', '\u{1e018}', NSM), ('\u{1e01b}', '\u{1e021}',
+ NSM), ('\u{1e023}', '\u{1e024}', NSM), ('\u{1e026}', '\u{1e02a}', NSM), ('\u{1e030}',
+ '\u{1e06d}', L), ('\u{1e08f}', '\u{1e08f}', NSM), ('\u{1e100}', '\u{1e12c}', L), ('\u{1e130}',
+ '\u{1e136}', NSM), ('\u{1e137}', '\u{1e13d}', L), ('\u{1e140}', '\u{1e149}', L), ('\u{1e14e}',
+ '\u{1e14f}', L), ('\u{1e290}', '\u{1e2ad}', L), ('\u{1e2ae}', '\u{1e2ae}', NSM), ('\u{1e2c0}',
+ '\u{1e2eb}', L), ('\u{1e2ec}', '\u{1e2ef}', NSM), ('\u{1e2f0}', '\u{1e2f9}', L), ('\u{1e2ff}',
+ '\u{1e2ff}', ET), ('\u{1e4d0}', '\u{1e4eb}', L), ('\u{1e4ec}', '\u{1e4ef}', NSM), ('\u{1e4f0}',
+ '\u{1e4f9}', L), ('\u{1e7e0}', '\u{1e7e6}', L), ('\u{1e7e8}', '\u{1e7eb}', L), ('\u{1e7ed}',
+ '\u{1e7ee}', L), ('\u{1e7f0}', '\u{1e7fe}', L), ('\u{1e800}', '\u{1e8cf}', R), ('\u{1e8d0}',
+ '\u{1e8d6}', NSM), ('\u{1e8d7}', '\u{1e943}', R), ('\u{1e944}', '\u{1e94a}', NSM), ('\u{1e94b}',
+ '\u{1ec70}', R), ('\u{1ec71}', '\u{1ecb4}', AL), ('\u{1ecb5}', '\u{1ed00}', R), ('\u{1ed01}',
+ '\u{1ed3d}', AL), ('\u{1ed3e}', '\u{1edff}', R), ('\u{1ee00}', '\u{1eeef}', AL), ('\u{1eef0}',
+ '\u{1eef1}', ON), ('\u{1eef2}', '\u{1eeff}', AL), ('\u{1ef00}', '\u{1efff}', R), ('\u{1f000}',
+ '\u{1f02b}', ON), ('\u{1f030}', '\u{1f093}', ON), ('\u{1f0a0}', '\u{1f0ae}', ON), ('\u{1f0b1}',
+ '\u{1f0bf}', ON), ('\u{1f0c1}', '\u{1f0cf}', ON), ('\u{1f0d1}', '\u{1f0f5}', ON), ('\u{1f100}',
+ '\u{1f10a}', EN), ('\u{1f10b}', '\u{1f10f}', ON), ('\u{1f110}', '\u{1f12e}', L), ('\u{1f12f}',
+ '\u{1f12f}', ON), ('\u{1f130}', '\u{1f169}', L), ('\u{1f16a}', '\u{1f16f}', ON), ('\u{1f170}',
+ '\u{1f1ac}', L), ('\u{1f1ad}', '\u{1f1ad}', ON), ('\u{1f1e6}', '\u{1f202}', L), ('\u{1f210}',
+ '\u{1f23b}', L), ('\u{1f240}', '\u{1f248}', L), ('\u{1f250}', '\u{1f251}', L), ('\u{1f260}',
+ '\u{1f265}', ON), ('\u{1f300}', '\u{1f6d7}', ON), ('\u{1f6dc}', '\u{1f6ec}', ON), ('\u{1f6f0}',
+ '\u{1f6fc}', ON), ('\u{1f700}', '\u{1f776}', ON), ('\u{1f77b}', '\u{1f7d9}', ON), ('\u{1f7e0}',
+ '\u{1f7eb}', ON), ('\u{1f7f0}', '\u{1f7f0}', ON), ('\u{1f800}', '\u{1f80b}', ON), ('\u{1f810}',
+ '\u{1f847}', ON), ('\u{1f850}', '\u{1f859}', ON), ('\u{1f860}', '\u{1f887}', ON), ('\u{1f890}',
+ '\u{1f8ad}', ON), ('\u{1f8b0}', '\u{1f8b1}', ON), ('\u{1f900}', '\u{1fa53}', ON), ('\u{1fa60}',
+ '\u{1fa6d}', ON), ('\u{1fa70}', '\u{1fa7c}', ON), ('\u{1fa80}', '\u{1fa88}', ON), ('\u{1fa90}',
+ '\u{1fabd}', ON), ('\u{1fabf}', '\u{1fac5}', ON), ('\u{1face}', '\u{1fadb}', ON), ('\u{1fae0}',
+ '\u{1fae8}', ON), ('\u{1faf0}', '\u{1faf8}', ON), ('\u{1fb00}', '\u{1fb92}', ON), ('\u{1fb94}',
+ '\u{1fbca}', ON), ('\u{1fbf0}', '\u{1fbf9}', EN), ('\u{20000}', '\u{2a6df}', L), ('\u{2a700}',
+ '\u{2b739}', L), ('\u{2b740}', '\u{2b81d}', L), ('\u{2b820}', '\u{2cea1}', L), ('\u{2ceb0}',
+ '\u{2ebe0}', L), ('\u{2f800}', '\u{2fa1d}', L), ('\u{30000}', '\u{3134a}', L), ('\u{31350}',
+ '\u{323af}', L), ('\u{e0001}', '\u{e0001}', BN), ('\u{e0020}', '\u{e007f}', BN), ('\u{e0100}',
+ '\u{e01ef}', NSM), ('\u{f0000}', '\u{ffffd}', L), ('\u{100000}', '\u{10fffd}', L)
+];
+
+pub const bidi_pairs_table: &'static [(char, char, Option<char>)] = &[
+ ('\u{28}', '\u{29}', None), ('\u{5b}', '\u{5d}', None), ('\u{7b}', '\u{7d}', None), ('\u{f3a}',
+ '\u{f3b}', None), ('\u{f3c}', '\u{f3d}', None), ('\u{169b}', '\u{169c}', None), ('\u{2045}',
+ '\u{2046}', None), ('\u{207d}', '\u{207e}', None), ('\u{208d}', '\u{208e}', None), ('\u{2308}',
+ '\u{2309}', None), ('\u{230a}', '\u{230b}', None), ('\u{2329}', '\u{232a}', Some('\u{3008}')),
+ ('\u{2768}', '\u{2769}', None), ('\u{276a}', '\u{276b}', None), ('\u{276c}', '\u{276d}', None),
+ ('\u{276e}', '\u{276f}', None), ('\u{2770}', '\u{2771}', None), ('\u{2772}', '\u{2773}', None),
+ ('\u{2774}', '\u{2775}', None), ('\u{27c5}', '\u{27c6}', None), ('\u{27e6}', '\u{27e7}', None),
+ ('\u{27e8}', '\u{27e9}', None), ('\u{27ea}', '\u{27eb}', None), ('\u{27ec}', '\u{27ed}', None),
+ ('\u{27ee}', '\u{27ef}', None), ('\u{2983}', '\u{2984}', None), ('\u{2985}', '\u{2986}', None),
+ ('\u{2987}', '\u{2988}', None), ('\u{2989}', '\u{298a}', None), ('\u{298b}', '\u{298c}', None),
+ ('\u{298d}', '\u{2990}', None), ('\u{298f}', '\u{298e}', None), ('\u{2991}', '\u{2992}', None),
+ ('\u{2993}', '\u{2994}', None), ('\u{2995}', '\u{2996}', None), ('\u{2997}', '\u{2998}', None),
+ ('\u{29d8}', '\u{29d9}', None), ('\u{29da}', '\u{29db}', None), ('\u{29fc}', '\u{29fd}', None),
+ ('\u{2e22}', '\u{2e23}', None), ('\u{2e24}', '\u{2e25}', None), ('\u{2e26}', '\u{2e27}', None),
+ ('\u{2e28}', '\u{2e29}', None), ('\u{2e55}', '\u{2e56}', None), ('\u{2e57}', '\u{2e58}', None),
+ ('\u{2e59}', '\u{2e5a}', None), ('\u{2e5b}', '\u{2e5c}', None), ('\u{3008}', '\u{3009}', None),
+ ('\u{300a}', '\u{300b}', None), ('\u{300c}', '\u{300d}', None), ('\u{300e}', '\u{300f}', None),
+ ('\u{3010}', '\u{3011}', None), ('\u{3014}', '\u{3015}', None), ('\u{3016}', '\u{3017}', None),
+ ('\u{3018}', '\u{3019}', None), ('\u{301a}', '\u{301b}', None), ('\u{fe59}', '\u{fe5a}', None),
+ ('\u{fe5b}', '\u{fe5c}', None), ('\u{fe5d}', '\u{fe5e}', None), ('\u{ff08}', '\u{ff09}', None),
+ ('\u{ff3b}', '\u{ff3d}', None), ('\u{ff5b}', '\u{ff5d}', None), ('\u{ff5f}', '\u{ff60}', None),
+ ('\u{ff62}', '\u{ff63}', None)
+];
+
diff --git a/crates/unicode-bidi/src/data_source.rs b/crates/unicode-bidi/src/data_source.rs
new file mode 100644
index 0000000..319ad53
--- /dev/null
+++ b/crates/unicode-bidi/src/data_source.rs
@@ -0,0 +1,46 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::BidiClass;
+
+/// This is the return value of [`BidiDataSource::bidi_matched_opening_bracket()`].
+///
+/// It represents the matching *normalized* opening bracket for a given bracket in a bracket pair,
+/// and whether or not that bracket is opening.
+#[derive(Debug, Copy, Clone)]
+pub struct BidiMatchedOpeningBracket {
+ /// The corresponding opening bracket in this bracket pair, normalized
+ ///
+ /// In case of opening brackets, this will be the bracket itself, except for when the bracket
+ /// is not normalized, in which case it will be the normalized form.
+ pub opening: char,
+ /// Whether or not the requested bracket was an opening bracket. True for opening
+ pub is_open: bool,
+}
+
+/// This trait abstracts over a data source that is able to produce the Unicode Bidi class for a given
+/// character
+pub trait BidiDataSource {
+ fn bidi_class(&self, c: char) -> BidiClass;
+ /// If this character is a bracket according to BidiBrackets.txt,
+ /// return the corresponding *normalized* *opening bracket* of the pair,
+ /// and whether or not it itself is an opening bracket.
+ ///
+ /// This effectively buckets brackets into equivalence classes keyed on the
+ /// normalized opening bracket.
+ ///
+ /// The default implementation will pull in a small amount of hardcoded data,
+ /// regardless of the `hardcoded-data` feature. This is in part for convenience
+ /// (since this data is small and changes less often), and in part so that this method can be
+ /// added without needing a breaking version bump.
+ /// Override this method in your custom data source to prevent the use of hardcoded data.
+ fn bidi_matched_opening_bracket(&self, c: char) -> Option<BidiMatchedOpeningBracket> {
+ crate::char_data::bidi_matched_opening_bracket(c)
+ }
+}
diff --git a/crates/unicode-bidi/src/deprecated.rs b/crates/unicode-bidi/src/deprecated.rs
new file mode 100644
index 0000000..74a24f5
--- /dev/null
+++ b/crates/unicode-bidi/src/deprecated.rs
@@ -0,0 +1,92 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! This module holds deprecated assets only.
+
+use alloc::vec::Vec;
+
+use super::*;
+
+/// Find the level runs within a line and return them in visual order.
+///
+/// NOTE: This implementation is incomplete. The algorithm needs information about the text,
+/// including original `BidiClass` property of each character, to be able to perform correctly.
+/// Please see [`BidiInfo::visual_runs()`](../struct.BidiInfo.html#method.visual_runs) for the
+/// improved implementation.
+///
+/// `line` is a range of bytes indices within `levels`.
+///
+/// <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
+#[deprecated(
+ since = "0.3.0",
+ note = "please use `BidiInfo::visual_runs()` instead."
+)]
+pub fn visual_runs(line: Range<usize>, levels: &[Level]) -> Vec<LevelRun> {
+ assert!(line.start <= levels.len());
+ assert!(line.end <= levels.len());
+
+ let mut runs = Vec::new();
+
+ // Find consecutive level runs.
+ let mut start = line.start;
+ let mut run_level = levels[start];
+ let mut min_level = run_level;
+ let mut max_level = run_level;
+
+ for (i, &new_level) in levels.iter().enumerate().take(line.end).skip(start + 1) {
+ if new_level != run_level {
+ // End of the previous run, start of a new one.
+ runs.push(start..i);
+ start = i;
+ run_level = new_level;
+
+ min_level = cmp::min(run_level, min_level);
+ max_level = cmp::max(run_level, max_level);
+ }
+ }
+ runs.push(start..line.end);
+
+ let run_count = runs.len();
+
+ // Re-order the odd runs.
+ // <http://www.unicode.org/reports/tr9/#L2>
+
+ // Stop at the lowest *odd* level.
+ min_level = min_level.new_lowest_ge_rtl().expect("Level error");
+
+ while max_level >= min_level {
+ // Look for the start of a sequence of consecutive runs of max_level or higher.
+ let mut seq_start = 0;
+ while seq_start < run_count {
+ if levels[runs[seq_start].start] < max_level {
+ seq_start += 1;
+ continue;
+ }
+
+ // Found the start of a sequence. Now find the end.
+ let mut seq_end = seq_start + 1;
+ while seq_end < run_count {
+ if levels[runs[seq_end].start] < max_level {
+ break;
+ }
+ seq_end += 1;
+ }
+
+ // Reverse the runs within this sequence.
+ runs[seq_start..seq_end].reverse();
+
+ seq_start = seq_end;
+ }
+ max_level
+ .lower(1)
+ .expect("Lowering embedding level below zero");
+ }
+
+ runs
+}
diff --git a/crates/unicode-bidi/src/explicit.rs b/crates/unicode-bidi/src/explicit.rs
new file mode 100644
index 0000000..d4ad897
--- /dev/null
+++ b/crates/unicode-bidi/src/explicit.rs
@@ -0,0 +1,210 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! 3.3.2 Explicit Levels and Directions
+//!
+//! <http://www.unicode.org/reports/tr9/#Explicit_Levels_and_Directions>
+
+use alloc::vec::Vec;
+
+use super::char_data::{
+ is_rtl,
+ BidiClass::{self, *},
+};
+use super::level::Level;
+use super::TextSource;
+
+/// Compute explicit embedding levels for one paragraph of text (X1-X8).
+///
+/// `processing_classes[i]` must contain the `BidiClass` of the char at byte index `i`,
+/// for each char in `text`.
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+pub fn compute<'a, T: TextSource<'a> + ?Sized>(
+ text: &'a T,
+ para_level: Level,
+ original_classes: &[BidiClass],
+ levels: &mut [Level],
+ processing_classes: &mut [BidiClass],
+) {
+ assert_eq!(text.len(), original_classes.len());
+
+ // <http://www.unicode.org/reports/tr9/#X1>
+ let mut stack = DirectionalStatusStack::new();
+ stack.push(para_level, OverrideStatus::Neutral);
+
+ let mut overflow_isolate_count = 0u32;
+ let mut overflow_embedding_count = 0u32;
+ let mut valid_isolate_count = 0u32;
+
+ for (i, len) in text.indices_lengths() {
+ match original_classes[i] {
+ // Rules X2-X5c
+ RLE | LRE | RLO | LRO | RLI | LRI | FSI => {
+ let last_level = stack.last().level;
+
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ levels[i] = last_level;
+
+ // X5a-X5c: Isolate initiators get the level of the last entry on the stack.
+ let is_isolate = match original_classes[i] {
+ RLI | LRI | FSI => true,
+ _ => false,
+ };
+ if is_isolate {
+ // Redundant due to "Retaining explicit formatting characters" step.
+ // levels[i] = last_level;
+ match stack.last().status {
+ OverrideStatus::RTL => processing_classes[i] = R,
+ OverrideStatus::LTR => processing_classes[i] = L,
+ _ => {}
+ }
+ }
+
+ let new_level = if is_rtl(original_classes[i]) {
+ last_level.new_explicit_next_rtl()
+ } else {
+ last_level.new_explicit_next_ltr()
+ };
+ if new_level.is_ok() && overflow_isolate_count == 0 && overflow_embedding_count == 0
+ {
+ let new_level = new_level.unwrap();
+ stack.push(
+ new_level,
+ match original_classes[i] {
+ RLO => OverrideStatus::RTL,
+ LRO => OverrideStatus::LTR,
+ RLI | LRI | FSI => OverrideStatus::Isolate,
+ _ => OverrideStatus::Neutral,
+ },
+ );
+ if is_isolate {
+ valid_isolate_count += 1;
+ } else {
+ // The spec doesn't explicitly mention this step, but it is necessary.
+ // See the reference implementations for comparison.
+ levels[i] = new_level;
+ }
+ } else if is_isolate {
+ overflow_isolate_count += 1;
+ } else if overflow_isolate_count == 0 {
+ overflow_embedding_count += 1;
+ }
+
+ if !is_isolate {
+ // X9 +
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // (PDF handled below)
+ processing_classes[i] = BN;
+ }
+ }
+
+ // <http://www.unicode.org/reports/tr9/#X6a>
+ PDI => {
+ if overflow_isolate_count > 0 {
+ overflow_isolate_count -= 1;
+ } else if valid_isolate_count > 0 {
+ overflow_embedding_count = 0;
+ loop {
+ // Pop everything up to and including the last Isolate status.
+ match stack.vec.pop() {
+ None
+ | Some(Status {
+ status: OverrideStatus::Isolate,
+ ..
+ }) => break,
+ _ => continue,
+ }
+ }
+ valid_isolate_count -= 1;
+ }
+ let last = stack.last();
+ levels[i] = last.level;
+ match last.status {
+ OverrideStatus::RTL => processing_classes[i] = R,
+ OverrideStatus::LTR => processing_classes[i] = L,
+ _ => {}
+ }
+ }
+
+ // <http://www.unicode.org/reports/tr9/#X7>
+ PDF => {
+ if overflow_isolate_count > 0 {
+ // do nothing
+ } else if overflow_embedding_count > 0 {
+ overflow_embedding_count -= 1;
+ } else if stack.last().status != OverrideStatus::Isolate && stack.vec.len() >= 2 {
+ stack.vec.pop();
+ }
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ levels[i] = stack.last().level;
+ // X9 part of retaining explicit formatting characters.
+ processing_classes[i] = BN;
+ }
+
+ // Nothing.
+ // BN case moved down to X6, see <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ B => {}
+
+ // <http://www.unicode.org/reports/tr9/#X6>
+ _ => {
+ let last = stack.last();
+ levels[i] = last.level;
+ // This condition is not in the spec, but I am pretty sure that is a spec bug.
+ // https://www.unicode.org/L2/L2023/23014-amd-to-uax9.pdf
+ if original_classes[i] != BN {
+ match last.status {
+ OverrideStatus::RTL => processing_classes[i] = R,
+ OverrideStatus::LTR => processing_classes[i] = L,
+ _ => {}
+ }
+ }
+ }
+ }
+
+ // Handle multi-byte characters.
+ for j in 1..len {
+ levels[i + j] = levels[i];
+ processing_classes[i + j] = processing_classes[i];
+ }
+ }
+}
+
+/// Entries in the directional status stack:
+struct Status {
+ level: Level,
+ status: OverrideStatus,
+}
+
+#[derive(PartialEq)]
+enum OverrideStatus {
+ Neutral,
+ RTL,
+ LTR,
+ Isolate,
+}
+
+struct DirectionalStatusStack {
+ vec: Vec<Status>,
+}
+
+impl DirectionalStatusStack {
+ fn new() -> Self {
+ DirectionalStatusStack {
+ vec: Vec::with_capacity(Level::max_explicit_depth() as usize + 2),
+ }
+ }
+
+ fn push(&mut self, level: Level, status: OverrideStatus) {
+ self.vec.push(Status { level, status });
+ }
+
+ fn last(&self) -> &Status {
+ self.vec.last().unwrap()
+ }
+}
diff --git a/crates/unicode-bidi/src/format_chars.rs b/crates/unicode-bidi/src/format_chars.rs
new file mode 100644
index 0000000..5b19b5e
--- /dev/null
+++ b/crates/unicode-bidi/src/format_chars.rs
@@ -0,0 +1,42 @@
+// Copyright 2017 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Directional Formatting Characters
+//!
+//! <http://www.unicode.org/reports/tr9/#Directional_Formatting_Characters>
+
+// == Implicit ==
+/// ARABIC LETTER MARK
+pub const ALM: char = '\u{061C}';
+/// LEFT-TO-RIGHT MARK
+pub const LRM: char = '\u{200E}';
+/// RIGHT-TO-LEFT MARK
+pub const RLM: char = '\u{200F}';
+
+// == Explicit Isolates ==
+/// LEFT‑TO‑RIGHT ISOLATE
+pub const LRI: char = '\u{2066}';
+/// RIGHT‑TO‑LEFT ISOLATE
+pub const RLI: char = '\u{2067}';
+/// FIRST STRONG ISOLATE
+pub const FSI: char = '\u{2068}';
+/// POP DIRECTIONAL ISOLATE
+pub const PDI: char = '\u{2069}';
+
+// == Explicit Embeddings and Overrides ==
+/// LEFT-TO-RIGHT EMBEDDING
+pub const LRE: char = '\u{202A}';
+/// RIGHT-TO-LEFT EMBEDDING
+pub const RLE: char = '\u{202B}';
+/// POP DIRECTIONAL FORMATTING
+pub const PDF: char = '\u{202C}';
+/// LEFT-TO-RIGHT OVERRIDE
+pub const LRO: char = '\u{202D}';
+/// RIGHT-TO-LEFT OVERRIDE
+pub const RLO: char = '\u{202E}';
diff --git a/crates/unicode-bidi/src/implicit.rs b/crates/unicode-bidi/src/implicit.rs
new file mode 100644
index 0000000..0311053
--- /dev/null
+++ b/crates/unicode-bidi/src/implicit.rs
@@ -0,0 +1,585 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! 3.3.4 - 3.3.6. Resolve implicit levels and types.
+
+use alloc::vec::Vec;
+use core::cmp::max;
+
+use super::char_data::BidiClass::{self, *};
+use super::level::Level;
+use super::prepare::{not_removed_by_x9, IsolatingRunSequence};
+use super::{BidiDataSource, TextSource};
+
+/// 3.3.4 Resolving Weak Types
+///
+/// <http://www.unicode.org/reports/tr9/#Resolving_Weak_Types>
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+pub fn resolve_weak<'a, T: TextSource<'a> + ?Sized>(
+ text: &'a T,
+ sequence: &IsolatingRunSequence,
+ processing_classes: &mut [BidiClass],
+) {
+ // Note: The spec treats these steps as individual passes that are applied one after the other
+ // on the entire IsolatingRunSequence at once. We instead collapse it into a single iteration,
+ // which is straightforward for rules that are based on the state of the current character, but not
+ // for rules that care about surrounding characters. To deal with them, we retain additional state
+ // about previous character classes that may have since been changed by later rules.
+
+ // The previous class for the purposes of rule W4/W6, not tracking changes made after or during W4.
+ let mut prev_class_before_w4 = sequence.sos;
+ // The previous class for the purposes of rule W5.
+ let mut prev_class_before_w5 = sequence.sos;
+ // The previous class for the purposes of rule W1, not tracking changes from any other rules.
+ let mut prev_class_before_w1 = sequence.sos;
+ let mut last_strong_is_al = false;
+ let mut et_run_indices = Vec::new(); // for W5
+ let mut bn_run_indices = Vec::new(); // for W5 + <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+
+ for (run_index, level_run) in sequence.runs.iter().enumerate() {
+ for i in &mut level_run.clone() {
+ if processing_classes[i] == BN {
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // Keeps track of bn runs for W5 in case we see an ET.
+ bn_run_indices.push(i);
+ // BNs aren't real, skip over them.
+ continue;
+ }
+
+ // Store the processing class of all rules before W2/W1.
+ // Used to keep track of the last strong character for W2. W3 is able to insert new strong
+ // characters, so we don't want to be misled by it.
+ let mut w2_processing_class = processing_classes[i];
+
+ // <http://www.unicode.org/reports/tr9/#W1>
+ //
+
+ if processing_classes[i] == NSM {
+ processing_classes[i] = match prev_class_before_w1 {
+ RLI | LRI | FSI | PDI => ON,
+ _ => prev_class_before_w1,
+ };
+ // W1 occurs before W2, update this.
+ w2_processing_class = processing_classes[i];
+ }
+
+ prev_class_before_w1 = processing_classes[i];
+
+ // <http://www.unicode.org/reports/tr9/#W2>
+ // <http://www.unicode.org/reports/tr9/#W3>
+ //
+ match processing_classes[i] {
+ EN => {
+ if last_strong_is_al {
+ // W2. If previous strong char was AL, change EN to AN.
+ processing_classes[i] = AN;
+ }
+ }
+ // W3.
+ AL => processing_classes[i] = R,
+ _ => {}
+ }
+
+ // update last_strong_is_al.
+ match w2_processing_class {
+ L | R => {
+ last_strong_is_al = false;
+ }
+ AL => {
+ last_strong_is_al = true;
+ }
+ _ => {}
+ }
+
+ let class_before_w456 = processing_classes[i];
+
+ // <http://www.unicode.org/reports/tr9/#W4>
+ // <http://www.unicode.org/reports/tr9/#W5>
+ // <http://www.unicode.org/reports/tr9/#W6> (separators only)
+ // (see below for W6 terminator code)
+ //
+ match processing_classes[i] {
+ // <http://www.unicode.org/reports/tr9/#W6>
+ EN => {
+ // W5. If a run of ETs is adjacent to an EN, change the ETs to EN.
+ for j in &et_run_indices {
+ processing_classes[*j] = EN;
+ }
+ et_run_indices.clear();
+ }
+
+ // <http://www.unicode.org/reports/tr9/#W4>
+ // <http://www.unicode.org/reports/tr9/#W6>
+ ES | CS => {
+ // See https://github.com/servo/unicode-bidi/issues/86 for improving this.
+ // We want to make sure we check the correct next character by skipping past the rest
+ // of this one.
+ if let Some((_, char_len)) = text.char_at(i) {
+ let mut next_class = sequence
+ .iter_forwards_from(i + char_len, run_index)
+ .map(|j| processing_classes[j])
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ .find(not_removed_by_x9)
+ .unwrap_or(sequence.eos);
+ if next_class == EN && last_strong_is_al {
+ // Apply W2 to next_class. We know that last_strong_is_al
+ // has no chance of changing on this character so we can still assume its value
+ // will be the same by the time we get to it.
+ next_class = AN;
+ }
+ processing_classes[i] =
+ match (prev_class_before_w4, processing_classes[i], next_class) {
+ // W4
+ (EN, ES, EN) | (EN, CS, EN) => EN,
+ // W4
+ (AN, CS, AN) => AN,
+ // W6 (separators only)
+ (_, _, _) => ON,
+ };
+
+ // W6 + <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // We have to do this before W5 gets its grubby hands on these characters and thinks
+ // they're part of an ET run.
+ // We check for ON to ensure that we had hit the W6 branch above, since this `ES | CS` match
+ // arm handles both W4 and W6.
+ if processing_classes[i] == ON {
+ for idx in sequence.iter_backwards_from(i, run_index) {
+ let class = &mut processing_classes[idx];
+ if *class != BN {
+ break;
+ }
+ *class = ON;
+ }
+ for idx in sequence.iter_forwards_from(i + char_len, run_index) {
+ let class = &mut processing_classes[idx];
+ if *class != BN {
+ break;
+ }
+ *class = ON;
+ }
+ }
+ } else {
+ // We're in the middle of a character, copy over work done for previous bytes
+ // since it's going to be the same answer.
+ processing_classes[i] = processing_classes[i - 1];
+ }
+ }
+ // <http://www.unicode.org/reports/tr9/#W5>
+ ET => {
+ match prev_class_before_w5 {
+ EN => processing_classes[i] = EN,
+ _ => {
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // If there was a BN run before this, that's now a part of this ET run.
+ et_run_indices.extend(&bn_run_indices);
+
+ // In case this is followed by an EN.
+ et_run_indices.push(i);
+ }
+ }
+ }
+ _ => {}
+ }
+
+ // Common loop iteration code
+ //
+
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // BN runs would have already continued the loop, clear them before we get to the next one.
+ bn_run_indices.clear();
+
+ // W6 above only deals with separators, so it doesn't change anything W5 cares about,
+ // so we still can update this after running that part of W6.
+ prev_class_before_w5 = processing_classes[i];
+
+ // <http://www.unicode.org/reports/tr9/#W6> (terminators only)
+ // (see above for W6 separator code)
+ //
+ if prev_class_before_w5 != ET {
+ // W6. If we didn't find an adjacent EN, turn any ETs into ON instead.
+ for j in &et_run_indices {
+ processing_classes[*j] = ON;
+ }
+ et_run_indices.clear();
+ }
+
+ // We stashed this before W4/5/6 could get their grubby hands on it, and it's not
+ // used in the W6 terminator code below so we can update it now.
+ prev_class_before_w4 = class_before_w456;
+ }
+ }
+ // Rerun this check in case we ended with a sequence of BNs (i.e., we'd never
+ // hit the end of the for loop above).
+ // W6. If we didn't find an adjacent EN, turn any ETs into ON instead.
+ for j in &et_run_indices {
+ processing_classes[*j] = ON;
+ }
+ et_run_indices.clear();
+
+ // W7. If the previous strong char was L, change EN to L.
+ let mut last_strong_is_l = sequence.sos == L;
+ for run in &sequence.runs {
+ for i in run.clone() {
+ match processing_classes[i] {
+ EN if last_strong_is_l => {
+ processing_classes[i] = L;
+ }
+ L => {
+ last_strong_is_l = true;
+ }
+ R | AL => {
+ last_strong_is_l = false;
+ }
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // Already scanning past BN here.
+ _ => {}
+ }
+ }
+ }
+}
+
+/// 3.3.5 Resolving Neutral Types
+///
+/// <http://www.unicode.org/reports/tr9/#Resolving_Neutral_Types>
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+pub fn resolve_neutral<'a, D: BidiDataSource, T: TextSource<'a> + ?Sized>(
+ text: &'a T,
+ data_source: &D,
+ sequence: &IsolatingRunSequence,
+ levels: &[Level],
+ original_classes: &[BidiClass],
+ processing_classes: &mut [BidiClass],
+) {
+ // e = embedding direction
+ let e: BidiClass = levels[sequence.runs[0].start].bidi_class();
+ let not_e = if e == BidiClass::L {
+ BidiClass::R
+ } else {
+ BidiClass::L
+ };
+ // N0. Process bracket pairs.
+
+ // > Identify the bracket pairs in the current isolating run sequence according to BD16.
+ // We use processing_classes, not original_classes, due to BD14/BD15
+ let bracket_pairs = identify_bracket_pairs(text, data_source, sequence, processing_classes);
+
+ // > For each bracket-pair element in the list of pairs of text positions
+ //
+ // Note: Rust ranges are interpreted as [start..end), be careful using `pair` directly
+ // for indexing as it will include the opening bracket pair but not the closing one.
+ for pair in bracket_pairs {
+ #[cfg(feature = "std")]
+ debug_assert!(
+ pair.start < processing_classes.len(),
+ "identify_bracket_pairs returned a range that is out of bounds!"
+ );
+ #[cfg(feature = "std")]
+ debug_assert!(
+ pair.end < processing_classes.len(),
+ "identify_bracket_pairs returned a range that is out of bounds!"
+ );
+ let mut found_e = false;
+ let mut found_not_e = false;
+ let mut class_to_set = None;
+
+ let start_char_len =
+ T::char_len(text.subrange(pair.start..pair.end).chars().next().unwrap());
+ // > Inspect the bidirectional types of the characters enclosed within the bracket pair.
+ //
+ // `pair` is [start, end) so we will end up processing the opening character but not the closing one.
+ //
+ for enclosed_i in sequence.iter_forwards_from(pair.start + start_char_len, pair.start_run) {
+ if enclosed_i >= pair.end {
+ #[cfg(feature = "std")]
+ debug_assert!(
+ enclosed_i == pair.end,
+ "If we skipped past this, the iterator is broken"
+ );
+ break;
+ }
+ let class = processing_classes[enclosed_i];
+ if class == e {
+ found_e = true;
+ } else if class == not_e {
+ found_not_e = true;
+ } else if class == BidiClass::EN || class == BidiClass::AN {
+ // > Within this scope, bidirectional types EN and AN are treated as R.
+ if e == BidiClass::L {
+ found_not_e = true;
+ } else {
+ found_e = true;
+ }
+ }
+
+ // If we have found a character with the class of the embedding direction
+ // we can bail early.
+ if found_e {
+ break;
+ }
+ }
+ // > If any strong type (either L or R) matching the embedding direction is found
+ if found_e {
+ // > .. set the type for both brackets in the pair to match the embedding direction
+ class_to_set = Some(e);
+ // > Otherwise, if there is a strong type it must be opposite the embedding direction
+ } else if found_not_e {
+ // > Therefore, test for an established context with a preceding strong type by
+ // > checking backwards before the opening paired bracket
+ // > until the first strong type (L, R, or sos) is found.
+ // (see note above about processing_classes and character boundaries)
+ let mut previous_strong = sequence
+ .iter_backwards_from(pair.start, pair.start_run)
+ .map(|i| processing_classes[i])
+ .find(|class| {
+ *class == BidiClass::L
+ || *class == BidiClass::R
+ || *class == BidiClass::EN
+ || *class == BidiClass::AN
+ })
+ .unwrap_or(sequence.sos);
+
+ // > Within this scope, bidirectional types EN and AN are treated as R.
+ if previous_strong == BidiClass::EN || previous_strong == BidiClass::AN {
+ previous_strong = BidiClass::R;
+ }
+
+ // > If the preceding strong type is also opposite the embedding direction,
+ // > context is established,
+ // > so set the type for both brackets in the pair to that direction.
+ // AND
+ // > Otherwise set the type for both brackets in the pair to the embedding direction.
+ // > Either way it gets set to previous_strong
+ //
+ // Both branches amount to setting the type to the strong type.
+ class_to_set = Some(previous_strong);
+ }
+
+ if let Some(class_to_set) = class_to_set {
+ // Update all processing classes corresponding to the start and end elements, as requested.
+ // We should include all bytes of the character, not the first one.
+ let end_char_len =
+ T::char_len(text.subrange(pair.end..text.len()).chars().next().unwrap());
+ for class in &mut processing_classes[pair.start..pair.start + start_char_len] {
+ *class = class_to_set;
+ }
+ for class in &mut processing_classes[pair.end..pair.end + end_char_len] {
+ *class = class_to_set;
+ }
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ for idx in sequence.iter_backwards_from(pair.start, pair.start_run) {
+ let class = &mut processing_classes[idx];
+ if *class != BN {
+ break;
+ }
+ *class = class_to_set;
+ }
+ // > Any number of characters that had original bidirectional character type NSM prior to the application of
+ // > W1 that immediately follow a paired bracket which changed to L or R under N0 should change to match the type of their preceding bracket.
+
+ // This rule deals with sequences of NSMs, so we can just update them all at once, we don't need to worry
+ // about character boundaries. We do need to be careful to skip the full set of bytes for the parentheses characters.
+ let nsm_start = pair.start + start_char_len;
+ for idx in sequence.iter_forwards_from(nsm_start, pair.start_run) {
+ let class = original_classes[idx];
+ if class == BidiClass::NSM || processing_classes[idx] == BN {
+ processing_classes[idx] = class_to_set;
+ } else {
+ break;
+ }
+ }
+ let nsm_end = pair.end + end_char_len;
+ for idx in sequence.iter_forwards_from(nsm_end, pair.end_run) {
+ let class = original_classes[idx];
+ if class == BidiClass::NSM || processing_classes[idx] == BN {
+ processing_classes[idx] = class_to_set;
+ } else {
+ break;
+ }
+ }
+ }
+ // > Otherwise, there are no strong types within the bracket pair
+ // > Therefore, do not set the type for that bracket pair
+ }
+
+ // N1 and N2.
+ // Indices of every byte in this isolating run sequence
+ let mut indices = sequence.runs.iter().flat_map(Clone::clone);
+ let mut prev_class = sequence.sos;
+ while let Some(mut i) = indices.next() {
+ // Process sequences of NI characters.
+ let mut ni_run = Vec::new();
+ // The BN is for <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ if is_NI(processing_classes[i]) || processing_classes[i] == BN {
+ // Consume a run of consecutive NI characters.
+ ni_run.push(i);
+ let mut next_class;
+ loop {
+ match indices.next() {
+ Some(j) => {
+ i = j;
+ next_class = processing_classes[j];
+ // The BN is for <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ if is_NI(next_class) || next_class == BN {
+ ni_run.push(i);
+ } else {
+ break;
+ }
+ }
+ None => {
+ next_class = sequence.eos;
+ break;
+ }
+ };
+ }
+ // N1-N2.
+ //
+ // <http://www.unicode.org/reports/tr9/#N1>
+ // <http://www.unicode.org/reports/tr9/#N2>
+ let new_class = match (prev_class, next_class) {
+ (L, L) => L,
+ (R, R)
+ | (R, AN)
+ | (R, EN)
+ | (AN, R)
+ | (AN, AN)
+ | (AN, EN)
+ | (EN, R)
+ | (EN, AN)
+ | (EN, EN) => R,
+ (_, _) => e,
+ };
+ for j in &ni_run {
+ processing_classes[*j] = new_class;
+ }
+ ni_run.clear();
+ }
+ prev_class = processing_classes[i];
+ }
+}
+
+struct BracketPair {
+ /// The text-relative index of the opening bracket.
+ start: usize,
+ /// The text-relative index of the closing bracket.
+ end: usize,
+ /// The index of the run (in the run sequence) that the opening bracket is in.
+ start_run: usize,
+ /// The index of the run (in the run sequence) that the closing bracket is in.
+ end_run: usize,
+}
+/// 3.1.3 Identifying Bracket Pairs
+///
+/// Returns all paired brackets in the source, as indices into the
+/// text source.
+///
+/// <https://www.unicode.org/reports/tr9/#BD16>
+fn identify_bracket_pairs<'a, T: TextSource<'a> + ?Sized, D: BidiDataSource>(
+ text: &'a T,
+ data_source: &D,
+ run_sequence: &IsolatingRunSequence,
+ original_classes: &[BidiClass],
+) -> Vec<BracketPair> {
+ let mut ret = vec![];
+ let mut stack = vec![];
+
+ for (run_index, level_run) in run_sequence.runs.iter().enumerate() {
+ for (i, ch) in text.subrange(level_run.clone()).char_indices() {
+ let actual_index = level_run.start + i;
+
+ // All paren characters are ON.
+ // From BidiBrackets.txt:
+ // > The Unicode property value stability policy guarantees that characters
+ // > which have bpt=o or bpt=c also have bc=ON and Bidi_M=Y
+ if original_classes[actual_index] != BidiClass::ON {
+ continue;
+ }
+
+ if let Some(matched) = data_source.bidi_matched_opening_bracket(ch) {
+ if matched.is_open {
+ // > If an opening paired bracket is found ...
+
+ // > ... and there is no room in the stack,
+ // > stop processing BD16 for the remainder of the isolating run sequence.
+ if stack.len() >= 63 {
+ break;
+ }
+ // > ... push its Bidi_Paired_Bracket property value and its text position onto the stack
+ stack.push((matched.opening, actual_index, run_index))
+ } else {
+ // > If a closing paired bracket is found, do the following
+
+ // > Declare a variable that holds a reference to the current stack element
+ // > and initialize it with the top element of the stack.
+ // AND
+ // > Else, if the current stack element is not at the bottom of the stack
+ for (stack_index, element) in stack.iter().enumerate().rev() {
+ // > Compare the closing paired bracket being inspected or its canonical
+ // > equivalent to the bracket in the current stack element.
+ if element.0 == matched.opening {
+ // > If the values match, meaning the two characters form a bracket pair, then
+
+ // > Append the text position in the current stack element together with the
+ // > text position of the closing paired bracket to the list.
+ let pair = BracketPair {
+ start: element.1,
+ end: actual_index,
+ start_run: element.2,
+ end_run: run_index,
+ };
+ ret.push(pair);
+
+ // > Pop the stack through the current stack element inclusively.
+ stack.truncate(stack_index);
+ break;
+ }
+ }
+ }
+ }
+ }
+ }
+ // > Sort the list of pairs of text positions in ascending order based on
+ // > the text position of the opening paired bracket.
+ ret.sort_by_key(|r| r.start);
+ ret
+}
+
+/// 3.3.6 Resolving Implicit Levels
+///
+/// Returns the maximum embedding level in the paragraph.
+///
+/// <http://www.unicode.org/reports/tr9/#Resolving_Implicit_Levels>
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+pub fn resolve_levels(original_classes: &[BidiClass], levels: &mut [Level]) -> Level {
+ let mut max_level = Level::ltr();
+ assert_eq!(original_classes.len(), levels.len());
+ for i in 0..levels.len() {
+ match (levels[i].is_rtl(), original_classes[i]) {
+ (false, AN) | (false, EN) => levels[i].raise(2).expect("Level number error"),
+ (false, R) | (true, L) | (true, EN) | (true, AN) => {
+ levels[i].raise(1).expect("Level number error")
+ }
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters> handled here
+ (_, _) => {}
+ }
+ max_level = max(max_level, levels[i]);
+ }
+
+ max_level
+}
+
+/// Neutral or Isolate formatting character (B, S, WS, ON, FSI, LRI, RLI, PDI)
+///
+/// <http://www.unicode.org/reports/tr9/#NI>
+#[allow(non_snake_case)]
+fn is_NI(class: BidiClass) -> bool {
+ match class {
+ B | S | WS | ON | FSI | LRI | RLI | PDI => true,
+ _ => false,
+ }
+}
diff --git a/crates/unicode-bidi/src/level.rs b/crates/unicode-bidi/src/level.rs
new file mode 100644
index 0000000..ef4f6d9
--- /dev/null
+++ b/crates/unicode-bidi/src/level.rs
@@ -0,0 +1,400 @@
+// Copyright 2017 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Bidi Embedding Level
+//!
+//! See [`Level`](struct.Level.html) for more details.
+//!
+//! <http://www.unicode.org/reports/tr9/#BD2>
+
+use alloc::string::{String, ToString};
+use alloc::vec::Vec;
+use core::convert::{From, Into};
+use core::slice;
+
+use super::char_data::BidiClass;
+
+/// Embedding Level
+///
+/// Embedding Levels are numbers between 0 and 126 (inclusive), where even values denote a
+/// left-to-right (LTR) direction and odd values a right-to-left (RTL) direction.
+///
+/// This struct maintains a *valid* status for level numbers, meaning that creating a new level, or
+/// mutating an existing level, with the value smaller than `0` (before conversion to `u8`) or
+/// larger than 125 results in an `Error`.
+///
+/// <http://www.unicode.org/reports/tr9/#BD2>
+#[derive(Copy, Clone, Debug, Eq, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[repr(transparent)]
+pub struct Level(u8);
+
+pub const LTR_LEVEL: Level = Level(0);
+pub const RTL_LEVEL: Level = Level(1);
+
+const MAX_DEPTH: u8 = 125;
+/// During explicit level resolution, embedding level can go as high as `max_depth`.
+pub const MAX_EXPLICIT_DEPTH: u8 = MAX_DEPTH;
+/// During implicit level resolution, embedding level can go as high as `max_depth + 1`.
+pub const MAX_IMPLICIT_DEPTH: u8 = MAX_DEPTH + 1;
+
+/// Errors that can occur on Level creation or mutation
+#[derive(Debug, PartialEq)]
+pub enum Error {
+ /// Out-of-range (invalid) embedding level number.
+ OutOfRangeNumber,
+}
+
+impl Level {
+ /// New LTR level with smallest number value (0).
+ #[inline]
+ pub fn ltr() -> Level {
+ LTR_LEVEL
+ }
+
+ /// New RTL level with smallest number value (1).
+ #[inline]
+ pub fn rtl() -> Level {
+ RTL_LEVEL
+ }
+
+ /// Maximum depth of the directional status stack during implicit resolutions.
+ pub fn max_implicit_depth() -> u8 {
+ MAX_IMPLICIT_DEPTH
+ }
+
+ /// Maximum depth of the directional status stack during explicit resolutions.
+ pub fn max_explicit_depth() -> u8 {
+ MAX_EXPLICIT_DEPTH
+ }
+
+ // == Inquiries ==
+
+ /// Create new level, fail if number is larger than `max_depth + 1`.
+ #[inline]
+ pub fn new(number: u8) -> Result<Level, Error> {
+ if number <= MAX_IMPLICIT_DEPTH {
+ Ok(Level(number))
+ } else {
+ Err(Error::OutOfRangeNumber)
+ }
+ }
+
+ /// Create new level, fail if number is larger than `max_depth`.
+ #[inline]
+ pub fn new_explicit(number: u8) -> Result<Level, Error> {
+ if number <= MAX_EXPLICIT_DEPTH {
+ Ok(Level(number))
+ } else {
+ Err(Error::OutOfRangeNumber)
+ }
+ }
+
+ // == Inquiries ==
+
+ /// The level number.
+ #[inline]
+ pub fn number(&self) -> u8 {
+ self.0
+ }
+
+ /// If this level is left-to-right.
+ #[inline]
+ pub fn is_ltr(&self) -> bool {
+ self.0 % 2 == 0
+ }
+
+ /// If this level is right-to-left.
+ #[inline]
+ pub fn is_rtl(&self) -> bool {
+ self.0 % 2 == 1
+ }
+
+ // == Mutators ==
+
+ /// Raise level by `amount`, fail if number is larger than `max_depth + 1`.
+ #[inline]
+ pub fn raise(&mut self, amount: u8) -> Result<(), Error> {
+ match self.0.checked_add(amount) {
+ Some(number) => {
+ if number <= MAX_IMPLICIT_DEPTH {
+ self.0 = number;
+ Ok(())
+ } else {
+ Err(Error::OutOfRangeNumber)
+ }
+ }
+ None => Err(Error::OutOfRangeNumber),
+ }
+ }
+
+ /// Raise level by `amount`, fail if number is larger than `max_depth`.
+ #[inline]
+ pub fn raise_explicit(&mut self, amount: u8) -> Result<(), Error> {
+ match self.0.checked_add(amount) {
+ Some(number) => {
+ if number <= MAX_EXPLICIT_DEPTH {
+ self.0 = number;
+ Ok(())
+ } else {
+ Err(Error::OutOfRangeNumber)
+ }
+ }
+ None => Err(Error::OutOfRangeNumber),
+ }
+ }
+
+ /// Lower level by `amount`, fail if number goes below zero.
+ #[inline]
+ pub fn lower(&mut self, amount: u8) -> Result<(), Error> {
+ match self.0.checked_sub(amount) {
+ Some(number) => {
+ self.0 = number;
+ Ok(())
+ }
+ None => Err(Error::OutOfRangeNumber),
+ }
+ }
+
+ // == Helpers ==
+
+ /// The next LTR (even) level greater than this, or fail if number is larger than `max_depth`.
+ #[inline]
+ pub fn new_explicit_next_ltr(&self) -> Result<Level, Error> {
+ Level::new_explicit((self.0 + 2) & !1)
+ }
+
+ /// The next RTL (odd) level greater than this, or fail if number is larger than `max_depth`.
+ #[inline]
+ pub fn new_explicit_next_rtl(&self) -> Result<Level, Error> {
+ Level::new_explicit((self.0 + 1) | 1)
+ }
+
+ /// The lowest RTL (odd) level greater than or equal to this, or fail if number is larger than
+ /// `max_depth + 1`.
+ #[inline]
+ pub fn new_lowest_ge_rtl(&self) -> Result<Level, Error> {
+ Level::new(self.0 | 1)
+ }
+
+ /// Generate a character type based on a level (as specified in steps X10 and N2).
+ #[inline]
+ pub fn bidi_class(&self) -> BidiClass {
+ if self.is_rtl() {
+ BidiClass::R
+ } else {
+ BidiClass::L
+ }
+ }
+
+ pub fn vec(v: &[u8]) -> Vec<Level> {
+ v.iter().map(|&x| x.into()).collect()
+ }
+
+ /// Converts a byte slice to a slice of Levels
+ ///
+ /// Does _not_ check if each level is within bounds (`<=` [`MAX_IMPLICIT_DEPTH`]),
+ /// which is not a requirement for safety but is a requirement for correctness of the algorithm.
+ pub fn from_slice_unchecked(v: &[u8]) -> &[Level] {
+ debug_assert_eq!(core::mem::size_of::<u8>(), core::mem::size_of::<Level>());
+ unsafe {
+ // Safety: The two arrays are the same size and layout-compatible since
+ // Level is `repr(transparent)` over `u8`
+ slice::from_raw_parts(v as *const [u8] as *const u8 as *const Level, v.len())
+ }
+ }
+}
+
+/// If levels has any RTL (odd) level
+///
+/// This information is usually used to skip re-ordering of text when no RTL level is present
+#[inline]
+pub fn has_rtl(levels: &[Level]) -> bool {
+ levels.iter().any(|&lvl| lvl.is_rtl())
+}
+
+impl Into<u8> for Level {
+ /// Convert to the level number
+ #[inline]
+ fn into(self) -> u8 {
+ self.number()
+ }
+}
+
+impl From<u8> for Level {
+ /// Create level by number
+ #[inline]
+ fn from(number: u8) -> Level {
+ Level::new(number).expect("Level number error")
+ }
+}
+
+/// Used for matching levels in conformance tests
+impl<'a> PartialEq<&'a str> for Level {
+ #[inline]
+ fn eq(&self, s: &&'a str) -> bool {
+ *s == "x" || *s == self.0.to_string()
+ }
+}
+
+/// Used for matching levels in conformance tests
+impl<'a> PartialEq<String> for Level {
+ #[inline]
+ fn eq(&self, s: &String) -> bool {
+ self == &s.as_str()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_new() {
+ assert_eq!(Level::new(0), Ok(Level(0)));
+ assert_eq!(Level::new(1), Ok(Level(1)));
+ assert_eq!(Level::new(10), Ok(Level(10)));
+ assert_eq!(Level::new(125), Ok(Level(125)));
+ assert_eq!(Level::new(126), Ok(Level(126)));
+ assert_eq!(Level::new(127), Err(Error::OutOfRangeNumber));
+ assert_eq!(Level::new(255), Err(Error::OutOfRangeNumber));
+ }
+
+ #[test]
+ fn test_new_explicit() {
+ assert_eq!(Level::new_explicit(0), Ok(Level(0)));
+ assert_eq!(Level::new_explicit(1), Ok(Level(1)));
+ assert_eq!(Level::new_explicit(10), Ok(Level(10)));
+ assert_eq!(Level::new_explicit(125), Ok(Level(125)));
+ assert_eq!(Level::new_explicit(126), Err(Error::OutOfRangeNumber));
+ assert_eq!(Level::new_explicit(255), Err(Error::OutOfRangeNumber));
+ }
+
+ #[test]
+ fn test_is_ltr() {
+ assert_eq!(Level(0).is_ltr(), true);
+ assert_eq!(Level(1).is_ltr(), false);
+ assert_eq!(Level(10).is_ltr(), true);
+ assert_eq!(Level(11).is_ltr(), false);
+ assert_eq!(Level(124).is_ltr(), true);
+ assert_eq!(Level(125).is_ltr(), false);
+ }
+
+ #[test]
+ fn test_is_rtl() {
+ assert_eq!(Level(0).is_rtl(), false);
+ assert_eq!(Level(1).is_rtl(), true);
+ assert_eq!(Level(10).is_rtl(), false);
+ assert_eq!(Level(11).is_rtl(), true);
+ assert_eq!(Level(124).is_rtl(), false);
+ assert_eq!(Level(125).is_rtl(), true);
+ }
+
+ #[test]
+ fn test_raise() {
+ let mut level = Level::ltr();
+ assert_eq!(level.number(), 0);
+ assert!(level.raise(100).is_ok());
+ assert_eq!(level.number(), 100);
+ assert!(level.raise(26).is_ok());
+ assert_eq!(level.number(), 126);
+ assert!(level.raise(1).is_err()); // invalid!
+ assert!(level.raise(250).is_err()); // overflow!
+ assert_eq!(level.number(), 126);
+ }
+
+ #[test]
+ fn test_raise_explicit() {
+ let mut level = Level::ltr();
+ assert_eq!(level.number(), 0);
+ assert!(level.raise_explicit(100).is_ok());
+ assert_eq!(level.number(), 100);
+ assert!(level.raise_explicit(25).is_ok());
+ assert_eq!(level.number(), 125);
+ assert!(level.raise_explicit(1).is_err()); // invalid!
+ assert!(level.raise_explicit(250).is_err()); // overflow!
+ assert_eq!(level.number(), 125);
+ }
+
+ #[test]
+ fn test_lower() {
+ let mut level = Level::rtl();
+ assert_eq!(level.number(), 1);
+ assert!(level.lower(1).is_ok());
+ assert_eq!(level.number(), 0);
+ assert!(level.lower(1).is_err()); // underflow!
+ assert!(level.lower(250).is_err()); // underflow!
+ assert_eq!(level.number(), 0);
+ }
+
+ #[test]
+ fn test_has_rtl() {
+ assert_eq!(has_rtl(&Level::vec(&[0, 0, 0])), false);
+ assert_eq!(has_rtl(&Level::vec(&[0, 1, 0])), true);
+ assert_eq!(has_rtl(&Level::vec(&[0, 2, 0])), false);
+ assert_eq!(has_rtl(&Level::vec(&[0, 125, 0])), true);
+ assert_eq!(has_rtl(&Level::vec(&[0, 126, 0])), false);
+ }
+
+ #[test]
+ fn test_into() {
+ let level = Level::rtl();
+ let number: u8 = level.into();
+ assert_eq!(1u8, number);
+ }
+
+ #[test]
+ fn test_vec() {
+ assert_eq!(
+ Level::vec(&[0, 1, 125]),
+ vec![Level(0), Level(1), Level(125)]
+ );
+ }
+
+ #[test]
+ fn test_str_eq() {
+ assert_eq!(Level::vec(&[0, 1, 4, 125]), vec!["0", "1", "x", "125"]);
+ assert_ne!(Level::vec(&[0, 1, 4, 125]), vec!["0", "1", "5", "125"]);
+ }
+
+ #[test]
+ fn test_string_eq() {
+ assert_eq!(
+ Level::vec(&[0, 1, 4, 125]),
+ vec!["0".to_string(), "1".to_string(), "x".to_string(), "125".to_string()]
+ );
+ }
+}
+
+#[cfg(all(feature = "serde", test))]
+mod serde_tests {
+ use super::*;
+ use serde_test::{assert_tokens, Token};
+
+ #[test]
+ fn test_statics() {
+ assert_tokens(
+ &Level::ltr(),
+ &[Token::NewtypeStruct { name: "Level" }, Token::U8(0)],
+ );
+ assert_tokens(
+ &Level::rtl(),
+ &[Token::NewtypeStruct { name: "Level" }, Token::U8(1)],
+ );
+ }
+
+ #[test]
+ fn test_new() {
+ let level = Level::new(42).unwrap();
+ assert_tokens(
+ &level,
+ &[Token::NewtypeStruct { name: "Level" }, Token::U8(42)],
+ );
+ }
+}
diff --git a/crates/unicode-bidi/src/lib.rs b/crates/unicode-bidi/src/lib.rs
new file mode 100644
index 0000000..1072b67
--- /dev/null
+++ b/crates/unicode-bidi/src/lib.rs
@@ -0,0 +1,2242 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! This crate implements the [Unicode Bidirectional Algorithm][tr9] for display of mixed
+//! right-to-left and left-to-right text. It is written in safe Rust, compatible with the
+//! current stable release.
+//!
+//! ## Example
+//!
+//! ```rust
+//! # #[cfg(feature = "hardcoded-data")] {
+//! use unicode_bidi::BidiInfo;
+//!
+//! // This example text is defined using `concat!` because some browsers
+//! // and text editors have trouble displaying bidi strings.
+//! let text = concat![
+//! "א",
+//! "ב",
+//! "ג",
+//! "a",
+//! "b",
+//! "c",
+//! ];
+//!
+//! // Resolve embedding levels within the text. Pass `None` to detect the
+//! // paragraph level automatically.
+//! let bidi_info = BidiInfo::new(&text, None);
+//!
+//! // This paragraph has embedding level 1 because its first strong character is RTL.
+//! assert_eq!(bidi_info.paragraphs.len(), 1);
+//! let para = &bidi_info.paragraphs[0];
+//! assert_eq!(para.level.number(), 1);
+//! assert_eq!(para.level.is_rtl(), true);
+//!
+//! // Re-ordering is done after wrapping each paragraph into a sequence of
+//! // lines. For this example, I'll just use a single line that spans the
+//! // entire paragraph.
+//! let line = para.range.clone();
+//!
+//! let display = bidi_info.reorder_line(para, line);
+//! assert_eq!(display, concat![
+//! "a",
+//! "b",
+//! "c",
+//! "ג",
+//! "ב",
+//! "א",
+//! ]);
+//! # } // feature = "hardcoded-data"
+//! ```
+//!
+//! # Features
+//!
+//! - `std`: Enabled by default, but can be disabled to make `unicode_bidi`
+//! `#![no_std]` + `alloc` compatible.
+//! - `hardcoded-data`: Enabled by default. Includes hardcoded Unicode bidi data and more convenient APIs.
+//! - `serde`: Adds [`serde::Serialize`] and [`serde::Deserialize`]
+//! implementations to relevant types.
+//!
+//! [tr9]: <http://www.unicode.org/reports/tr9/>
+
+#![no_std]
+// We need to link to std to make doc tests work on older Rust versions
+#[cfg(feature = "std")]
+extern crate std;
+#[macro_use]
+extern crate alloc;
+
+pub mod data_source;
+pub mod deprecated;
+pub mod format_chars;
+pub mod level;
+pub mod utf16;
+
+mod char_data;
+mod explicit;
+mod implicit;
+mod prepare;
+
+pub use crate::char_data::{BidiClass, UNICODE_VERSION};
+pub use crate::data_source::BidiDataSource;
+pub use crate::level::{Level, LTR_LEVEL, RTL_LEVEL};
+pub use crate::prepare::LevelRun;
+
+#[cfg(feature = "hardcoded-data")]
+pub use crate::char_data::{bidi_class, HardcodedBidiData};
+
+use alloc::borrow::Cow;
+use alloc::string::String;
+use alloc::vec::Vec;
+use core::char;
+use core::cmp;
+use core::iter::repeat;
+use core::ops::Range;
+use core::str::CharIndices;
+
+use crate::format_chars as chars;
+use crate::BidiClass::*;
+
+/// Trait that abstracts over a text source for use by the bidi algorithms.
+/// We implement this for str (UTF-8) and for [u16] (UTF-16, native-endian).
+/// (For internal unicode-bidi use; API may be unstable.)
+/// This trait is sealed and cannot be implemented for types outside this crate.
+pub trait TextSource<'text>: private::Sealed {
+ type CharIter: Iterator<Item = char>;
+ type CharIndexIter: Iterator<Item = (usize, char)>;
+ type IndexLenIter: Iterator<Item = (usize, usize)>;
+
+ /// Return the length of the text in code units.
+ #[doc(hidden)]
+ fn len(&self) -> usize;
+
+ /// Get the character at a given code unit index, along with its length in code units.
+ /// Returns None if index is out of range, or points inside a multi-code-unit character.
+ /// Returns REPLACEMENT_CHARACTER for any unpaired surrogates in UTF-16.
+ #[doc(hidden)]
+ fn char_at(&self, index: usize) -> Option<(char, usize)>;
+
+ /// Return a subrange of the text, indexed by code units.
+ /// (We don't implement all of the Index trait, just the minimum we use.)
+ #[doc(hidden)]
+ fn subrange(&self, range: Range<usize>) -> &Self;
+
+ /// An iterator over the text returning Unicode characters,
+ /// REPLACEMENT_CHAR for invalid code units.
+ #[doc(hidden)]
+ fn chars(&'text self) -> Self::CharIter;
+
+ /// An iterator over the text returning (index, char) tuples,
+ /// where index is the starting code-unit index of the character,
+ /// and char is its Unicode value (or REPLACEMENT_CHAR if invalid).
+ #[doc(hidden)]
+ fn char_indices(&'text self) -> Self::CharIndexIter;
+
+ /// An iterator over the text returning (index, length) tuples,
+ /// where index is the starting code-unit index of the character,
+ /// and length is its length in code units.
+ #[doc(hidden)]
+ fn indices_lengths(&'text self) -> Self::IndexLenIter;
+
+ /// Number of code units the given character uses.
+ #[doc(hidden)]
+ fn char_len(ch: char) -> usize;
+}
+
+mod private {
+ pub trait Sealed {}
+
+ // Implement for str and [u16] only.
+ impl Sealed for str {}
+ impl Sealed for [u16] {}
+}
+
+#[derive(PartialEq, Debug)]
+pub enum Direction {
+ Ltr,
+ Rtl,
+ Mixed,
+}
+
+/// Bidi information about a single paragraph
+#[derive(Clone, Debug, PartialEq)]
+pub struct ParagraphInfo {
+ /// The paragraphs boundaries within the text, as byte indices.
+ ///
+ /// TODO: Shrink this to only include the starting index?
+ pub range: Range<usize>,
+
+ /// The paragraph embedding level.
+ ///
+ /// <http://www.unicode.org/reports/tr9/#BD4>
+ pub level: Level,
+}
+
+impl ParagraphInfo {
+ /// Gets the length of the paragraph in the source text.
+ pub fn len(&self) -> usize {
+ self.range.end - self.range.start
+ }
+}
+
+/// Initial bidi information of the text.
+///
+/// Contains the text paragraphs and `BidiClass` of its characters.
+#[derive(PartialEq, Debug)]
+pub struct InitialInfo<'text> {
+ /// The text
+ pub text: &'text str,
+
+ /// The BidiClass of the character at each byte in the text.
+ /// If a character is multiple bytes, its class will appear multiple times in the vector.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The boundaries and level of each paragraph within the text.
+ pub paragraphs: Vec<ParagraphInfo>,
+}
+
+impl<'text> InitialInfo<'text> {
+ /// Find the paragraphs and BidiClasses in a string of text.
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ pub fn new(text: &str, default_para_level: Option<Level>) -> InitialInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Find the paragraphs and BidiClasses in a string of text, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`InitialInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature)
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a str,
+ default_para_level: Option<Level>,
+ ) -> InitialInfo<'a> {
+ InitialInfoExt::new_with_data_source(data_source, text, default_para_level).base
+ }
+}
+
+/// Extended version of InitialInfo (not public API).
+#[derive(PartialEq, Debug)]
+struct InitialInfoExt<'text> {
+ /// The base InitialInfo for the text, recording its paragraphs and bidi classes.
+ base: InitialInfo<'text>,
+
+ /// Parallel to base.paragraphs, records whether each paragraph is "pure LTR" that
+ /// requires no further bidi processing (i.e. there are no RTL characters or bidi
+ /// control codes present).
+ pure_ltr: Vec<bool>,
+}
+
+impl<'text> InitialInfoExt<'text> {
+ /// Find the paragraphs and BidiClasses in a string of text, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`InitialInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature)
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a str,
+ default_para_level: Option<Level>,
+ ) -> InitialInfoExt<'a> {
+ let mut paragraphs = Vec::<ParagraphInfo>::new();
+ let mut pure_ltr = Vec::<bool>::new();
+ let (original_classes, _, _) = compute_initial_info(
+ data_source,
+ text,
+ default_para_level,
+ Some((&mut paragraphs, &mut pure_ltr)),
+ );
+
+ InitialInfoExt {
+ base: InitialInfo {
+ text,
+ original_classes,
+ paragraphs,
+ },
+ pure_ltr,
+ }
+ }
+}
+
+/// Implementation of initial-info computation for both BidiInfo and ParagraphBidiInfo.
+/// To treat the text as (potentially) multiple paragraphs, the caller should pass the
+/// pair of optional outparam arrays to receive the ParagraphInfo and pure-ltr flags
+/// for each paragraph. Passing None for split_paragraphs will ignore any paragraph-
+/// separator characters in the text, treating it just as a single paragraph.
+/// Returns the array of BidiClass values for each code unit of the text, along with
+/// the embedding level and pure-ltr flag for the *last* (or only) paragraph.
+fn compute_initial_info<'a, D: BidiDataSource, T: TextSource<'a> + ?Sized>(
+ data_source: &D,
+ text: &'a T,
+ default_para_level: Option<Level>,
+ mut split_paragraphs: Option<(&mut Vec<ParagraphInfo>, &mut Vec<bool>)>,
+) -> (Vec<BidiClass>, Level, bool) {
+ let mut original_classes = Vec::with_capacity(text.len());
+
+ // The stack contains the starting code unit index for each nested isolate we're inside.
+ let mut isolate_stack = Vec::new();
+
+ debug_assert!(
+ if let Some((ref paragraphs, ref pure_ltr)) = split_paragraphs {
+ paragraphs.is_empty() && pure_ltr.is_empty()
+ } else {
+ true
+ }
+ );
+
+ let mut para_start = 0;
+ let mut para_level = default_para_level;
+
+ // Per-paragraph flag: can subsequent processing be skipped? Set to false if any
+ // RTL characters or bidi control characters are encountered in the paragraph.
+ let mut is_pure_ltr = true;
+
+ #[cfg(feature = "flame_it")]
+ flame::start("compute_initial_info(): iter text.char_indices()");
+
+ for (i, c) in text.char_indices() {
+ let class = data_source.bidi_class(c);
+
+ #[cfg(feature = "flame_it")]
+ flame::start("original_classes.extend()");
+
+ let len = T::char_len(c);
+ original_classes.extend(repeat(class).take(len));
+
+ #[cfg(feature = "flame_it")]
+ flame::end("original_classes.extend()");
+
+ match class {
+ B => {
+ if let Some((ref mut paragraphs, ref mut pure_ltr)) = split_paragraphs {
+ // P1. Split the text into separate paragraphs. The paragraph separator is kept
+ // with the previous paragraph.
+ let para_end = i + len;
+ paragraphs.push(ParagraphInfo {
+ range: para_start..para_end,
+ // P3. If no character is found in p2, set the paragraph level to zero.
+ level: para_level.unwrap_or(LTR_LEVEL),
+ });
+ pure_ltr.push(is_pure_ltr);
+ // Reset state for the start of the next paragraph.
+ para_start = para_end;
+ // TODO: Support defaulting to direction of previous paragraph
+ //
+ // <http://www.unicode.org/reports/tr9/#HL1>
+ para_level = default_para_level;
+ is_pure_ltr = true;
+ isolate_stack.clear();
+ }
+ }
+
+ L | R | AL => {
+ if class != L {
+ is_pure_ltr = false;
+ }
+ match isolate_stack.last() {
+ Some(&start) => {
+ if original_classes[start] == FSI {
+ // X5c. If the first strong character between FSI and its matching
+ // PDI is R or AL, treat it as RLI. Otherwise, treat it as LRI.
+ for j in 0..T::char_len(chars::FSI) {
+ original_classes[start + j] = if class == L { LRI } else { RLI };
+ }
+ }
+ }
+
+ None => {
+ if para_level.is_none() {
+ // P2. Find the first character of type L, AL, or R, while skipping
+ // any characters between an isolate initiator and its matching
+ // PDI.
+ para_level = Some(if class != L { RTL_LEVEL } else { LTR_LEVEL });
+ }
+ }
+ }
+ }
+
+ AN | LRE | RLE | LRO | RLO => {
+ is_pure_ltr = false;
+ }
+
+ RLI | LRI | FSI => {
+ is_pure_ltr = false;
+ isolate_stack.push(i);
+ }
+
+ PDI => {
+ isolate_stack.pop();
+ }
+
+ _ => {}
+ }
+ }
+
+ if let Some((paragraphs, pure_ltr)) = split_paragraphs {
+ if para_start < text.len() {
+ paragraphs.push(ParagraphInfo {
+ range: para_start..text.len(),
+ level: para_level.unwrap_or(LTR_LEVEL),
+ });
+ pure_ltr.push(is_pure_ltr);
+ }
+ debug_assert_eq!(paragraphs.len(), pure_ltr.len());
+ }
+ debug_assert_eq!(original_classes.len(), text.len());
+
+ #[cfg(feature = "flame_it")]
+ flame::end("compute_initial_info(): iter text.char_indices()");
+
+ (
+ original_classes,
+ para_level.unwrap_or(LTR_LEVEL),
+ is_pure_ltr,
+ )
+}
+
+/// Bidi information of the text.
+///
+/// The `original_classes` and `levels` vectors are indexed by byte offsets into the text. If a
+/// character is multiple bytes wide, then its class and level will appear multiple times in these
+/// vectors.
+// TODO: Impl `struct StringProperty<T> { values: Vec<T> }` and use instead of Vec<T>
+#[derive(Debug, PartialEq)]
+pub struct BidiInfo<'text> {
+ /// The text
+ pub text: &'text str,
+
+ /// The BidiClass of the character at each byte in the text.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The directional embedding level of each byte in the text.
+ pub levels: Vec<Level>,
+
+ /// The boundaries and paragraph embedding level of each paragraph within the text.
+ ///
+ /// TODO: Use SmallVec or similar to avoid overhead when there are only one or two paragraphs?
+ /// Or just don't include the first paragraph, which always starts at 0?
+ pub paragraphs: Vec<ParagraphInfo>,
+}
+
+impl<'text> BidiInfo<'text> {
+ /// Split the text into paragraphs and determine the bidi embedding levels for each paragraph.
+ ///
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ #[inline]
+ pub fn new(text: &str, default_para_level: Option<Level>) -> BidiInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Split the text into paragraphs and determine the bidi embedding levels for each paragraph, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`BidiInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature).
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a str,
+ default_para_level: Option<Level>,
+ ) -> BidiInfo<'a> {
+ let InitialInfoExt { base, pure_ltr, .. } =
+ InitialInfoExt::new_with_data_source(data_source, text, default_para_level);
+
+ let mut levels = Vec::<Level>::with_capacity(text.len());
+ let mut processing_classes = base.original_classes.clone();
+
+ for (para, is_pure_ltr) in base.paragraphs.iter().zip(pure_ltr.iter()) {
+ let text = &text[para.range.clone()];
+ let original_classes = &base.original_classes[para.range.clone()];
+
+ compute_bidi_info_for_para(
+ data_source,
+ para,
+ *is_pure_ltr,
+ text,
+ original_classes,
+ &mut processing_classes,
+ &mut levels,
+ );
+ }
+
+ BidiInfo {
+ text,
+ original_classes: base.original_classes,
+ paragraphs: base.paragraphs,
+ levels,
+ }
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *byte*
+ /// in the paragraph. The returned vector includes bytes that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// This runs [Rule L1], you can run
+ /// [Rule L2] by calling [`Self::reorder_visual()`].
+ /// If doing so, you may prefer to use [`Self::reordered_levels_per_char()`] instead
+ /// to avoid non-byte indices.
+ ///
+ /// For an all-in-one reordering solution, consider using [`Self::reorder_visual()`].
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels(&self, para: &ParagraphInfo, line: Range<usize>) -> Vec<Level> {
+ assert!(line.start <= self.levels.len());
+ assert!(line.end <= self.levels.len());
+
+ let mut levels = self.levels.clone();
+ let line_classes = &self.original_classes[line.clone()];
+ let line_levels = &mut levels[line.clone()];
+
+ reorder_levels(
+ line_classes,
+ line_levels,
+ self.text.subrange(line),
+ para.level,
+ );
+
+ levels
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *character*
+ /// in the paragraph. The returned vector includes characters that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// This runs [Rule L1], you can run
+ /// [Rule L2] by calling [`Self::reorder_visual()`].
+ /// If doing so, you may prefer to use [`Self::reordered_levels_per_char()`] instead
+ /// to avoid non-byte indices.
+ ///
+ /// For an all-in-one reordering solution, consider using [`Self::reorder_visual()`].
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels_per_char(
+ &self,
+ para: &ParagraphInfo,
+ line: Range<usize>,
+ ) -> Vec<Level> {
+ let levels = self.reordered_levels(para, line);
+ self.text.char_indices().map(|(i, _)| levels[i]).collect()
+ }
+
+ /// Re-order a line based on resolved levels and return the line in display order.
+ ///
+ /// This does not apply [Rule L3] or [Rule L4] around combining characters or mirroring.
+ ///
+ /// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+ /// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reorder_line(&self, para: &ParagraphInfo, line: Range<usize>) -> Cow<'text, str> {
+ if !level::has_rtl(&self.levels[line.clone()]) {
+ return self.text[line].into();
+ }
+ let (levels, runs) = self.visual_runs(para, line.clone());
+ reorder_line(self.text, line, levels, runs)
+ }
+
+ /// Reorders pre-calculated levels of a sequence of characters.
+ ///
+ /// NOTE: This is a convenience method that does not use a `Paragraph` object. It is
+ /// intended to be used when an application has determined the levels of the objects (character sequences)
+ /// and just needs to have them reordered.
+ ///
+ /// the index map will result in `indexMap[visualIndex]==logicalIndex`.
+ ///
+ /// This only runs [Rule L2](http://www.unicode.org/reports/tr9/#L2) as it does not have
+ /// information about the actual text.
+ ///
+ /// Furthermore, if `levels` is an array that is aligned with code units, bytes within a codepoint may be
+ /// reversed. You may need to fix up the map to deal with this. Alternatively, only pass in arrays where each `Level`
+ /// is for a single code point.
+ ///
+ ///
+ /// # # Example
+ /// ```
+ /// use unicode_bidi::BidiInfo;
+ /// use unicode_bidi::Level;
+ ///
+ /// let l0 = Level::from(0);
+ /// let l1 = Level::from(1);
+ /// let l2 = Level::from(2);
+ ///
+ /// let levels = vec![l0, l0, l0, l0];
+ /// let index_map = BidiInfo::reorder_visual(&levels);
+ /// assert_eq!(levels.len(), index_map.len());
+ /// assert_eq!(index_map, [0, 1, 2, 3]);
+ ///
+ /// let levels: Vec<Level> = vec![l0, l0, l0, l1, l1, l1, l2, l2];
+ /// let index_map = BidiInfo::reorder_visual(&levels);
+ /// assert_eq!(levels.len(), index_map.len());
+ /// assert_eq!(index_map, [0, 1, 2, 6, 7, 5, 4, 3]);
+ /// ```
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn reorder_visual(levels: &[Level]) -> Vec<usize> {
+ reorder_visual(levels)
+ }
+
+ /// Find the level runs within a line and return them in visual order.
+ ///
+ /// `line` is a range of bytes indices within `levels`.
+ ///
+ /// The first return value is a vector of levels used by the reordering algorithm,
+ /// i.e. the result of [Rule L1]. The second return value is a vector of level runs,
+ /// the result of [Rule L2], showing the visual order that each level run (a run of text with the
+ /// same level) should be displayed. Within each run, the display order can be checked
+ /// against the Level vector.
+ ///
+ /// This does not handle [Rule L3] (combining characters) or [Rule L4] (mirroring),
+ /// as that should be handled by the engine using this API.
+ ///
+ /// Conceptually, this is the same as running [`Self::reordered_levels()`] followed by
+ /// [`Self::reorder_visual()`], however it returns the result as a list of level runs instead
+ /// of producing a level map, since one may wish to deal with the fact that this is operating on
+ /// byte rather than character indices.
+ ///
+ /// <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ /// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+ /// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn visual_runs(
+ &self,
+ para: &ParagraphInfo,
+ line: Range<usize>,
+ ) -> (Vec<Level>, Vec<LevelRun>) {
+ let levels = self.reordered_levels(para, line.clone());
+ visual_runs_for_line(levels, &line)
+ }
+
+ /// If processed text has any computed RTL levels
+ ///
+ /// This information is usually used to skip re-ordering of text when no RTL level is present
+ #[inline]
+ pub fn has_rtl(&self) -> bool {
+ level::has_rtl(&self.levels)
+ }
+}
+
+/// Bidi information of text treated as a single paragraph.
+///
+/// The `original_classes` and `levels` vectors are indexed by byte offsets into the text. If a
+/// character is multiple bytes wide, then its class and level will appear multiple times in these
+/// vectors.
+#[derive(Debug, PartialEq)]
+pub struct ParagraphBidiInfo<'text> {
+ /// The text
+ pub text: &'text str,
+
+ /// The BidiClass of the character at each byte in the text.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The directional embedding level of each byte in the text.
+ pub levels: Vec<Level>,
+
+ /// The paragraph embedding level.
+ pub paragraph_level: Level,
+
+ /// Whether the paragraph is purely LTR.
+ pub is_pure_ltr: bool,
+}
+
+impl<'text> ParagraphBidiInfo<'text> {
+ /// Determine the bidi embedding level.
+ ///
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ #[inline]
+ pub fn new(text: &str, default_para_level: Option<Level>) -> ParagraphBidiInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Determine the bidi embedding level, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`BidiInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature).
+ ///
+ /// (This is the single-paragraph equivalent of BidiInfo::new_with_data_source,
+ /// and should be kept in sync with it.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a str,
+ default_para_level: Option<Level>,
+ ) -> ParagraphBidiInfo<'a> {
+ // Here we could create a ParagraphInitialInfo struct to parallel the one
+ // used by BidiInfo, but there doesn't seem any compelling reason for it.
+ let (original_classes, paragraph_level, is_pure_ltr) =
+ compute_initial_info(data_source, text, default_para_level, None);
+
+ let mut levels = Vec::<Level>::with_capacity(text.len());
+ let mut processing_classes = original_classes.clone();
+
+ let para_info = ParagraphInfo {
+ range: Range {
+ start: 0,
+ end: text.len(),
+ },
+ level: paragraph_level,
+ };
+
+ compute_bidi_info_for_para(
+ data_source,
+ ¶_info,
+ is_pure_ltr,
+ text,
+ &original_classes,
+ &mut processing_classes,
+ &mut levels,
+ );
+
+ ParagraphBidiInfo {
+ text,
+ original_classes,
+ levels,
+ paragraph_level,
+ is_pure_ltr,
+ }
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *byte*
+ /// in the paragraph. The returned vector includes bytes that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// See BidiInfo::reordered_levels for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reordered_levels.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels(&self, line: Range<usize>) -> Vec<Level> {
+ assert!(line.start <= self.levels.len());
+ assert!(line.end <= self.levels.len());
+
+ let mut levels = self.levels.clone();
+ let line_classes = &self.original_classes[line.clone()];
+ let line_levels = &mut levels[line.clone()];
+
+ reorder_levels(
+ line_classes,
+ line_levels,
+ self.text.subrange(line),
+ self.paragraph_level,
+ );
+
+ levels
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *character*
+ /// in the paragraph. The returned vector includes characters that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// See BidiInfo::reordered_levels_per_char for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reordered_levels_per_char.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels_per_char(&self, line: Range<usize>) -> Vec<Level> {
+ let levels = self.reordered_levels(line);
+ self.text.char_indices().map(|(i, _)| levels[i]).collect()
+ }
+
+ /// Re-order a line based on resolved levels and return the line in display order.
+ ///
+ /// See BidiInfo::reorder_line for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reorder_line.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reorder_line(&self, line: Range<usize>) -> Cow<'text, str> {
+ if !level::has_rtl(&self.levels[line.clone()]) {
+ return self.text[line].into();
+ }
+
+ let (levels, runs) = self.visual_runs(line.clone());
+
+ reorder_line(self.text, line, levels, runs)
+ }
+
+ /// Reorders pre-calculated levels of a sequence of characters.
+ ///
+ /// See BidiInfo::reorder_visual for details.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn reorder_visual(levels: &[Level]) -> Vec<usize> {
+ reorder_visual(levels)
+ }
+
+ /// Find the level runs within a line and return them in visual order.
+ ///
+ /// `line` is a range of bytes indices within `levels`.
+ ///
+ /// See BidiInfo::visual_runs for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::visual_runs.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn visual_runs(&self, line: Range<usize>) -> (Vec<Level>, Vec<LevelRun>) {
+ let levels = self.reordered_levels(line.clone());
+ visual_runs_for_line(levels, &line)
+ }
+
+ /// If processed text has any computed RTL levels
+ ///
+ /// This information is usually used to skip re-ordering of text when no RTL level is present
+ #[inline]
+ pub fn has_rtl(&self) -> bool {
+ !self.is_pure_ltr
+ }
+
+ /// Return the paragraph's Direction (Ltr, Rtl, or Mixed) based on its levels.
+ #[inline]
+ pub fn direction(&self) -> Direction {
+ para_direction(&self.levels)
+ }
+}
+
+/// Return a line of the text in display order based on resolved levels.
+///
+/// `text` the full text passed to the `BidiInfo` or `ParagraphBidiInfo` for analysis
+/// `line` a range of byte indices within `text` corresponding to one line
+/// `levels` array of `Level` values, with `line`'s levels reordered into visual order
+/// `runs` array of `LevelRun`s in visual order
+///
+/// (`levels` and `runs` are the result of calling `BidiInfo::visual_runs()` or
+/// `ParagraphBidiInfo::visual_runs()` for the line of interest.)
+///
+/// Returns: the reordered text of the line.
+///
+/// This does not apply [Rule L3] or [Rule L4] around combining characters or mirroring.
+///
+/// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+/// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+fn reorder_line<'text>(
+ text: &'text str,
+ line: Range<usize>,
+ levels: Vec<Level>,
+ runs: Vec<LevelRun>,
+) -> Cow<'text, str> {
+ // If all isolating run sequences are LTR, no reordering is needed
+ if runs.iter().all(|run| levels[run.start].is_ltr()) {
+ return text[line].into();
+ }
+
+ let mut result = String::with_capacity(line.len());
+ for run in runs {
+ if levels[run.start].is_rtl() {
+ result.extend(text[run].chars().rev());
+ } else {
+ result.push_str(&text[run]);
+ }
+ }
+ result.into()
+}
+
+/// Find the level runs within a line and return them in visual order.
+///
+/// `line` is a range of code-unit indices within `levels`.
+///
+/// The first return value is a vector of levels used by the reordering algorithm,
+/// i.e. the result of [Rule L1]. The second return value is a vector of level runs,
+/// the result of [Rule L2], showing the visual order that each level run (a run of text with the
+/// same level) should be displayed. Within each run, the display order can be checked
+/// against the Level vector.
+///
+/// This does not handle [Rule L3] (combining characters) or [Rule L4] (mirroring),
+/// as that should be handled by the engine using this API.
+///
+/// Conceptually, this is the same as running [`reordered_levels()`] followed by
+/// [`reorder_visual()`], however it returns the result as a list of level runs instead
+/// of producing a level map, since one may wish to deal with the fact that this is operating on
+/// byte rather than character indices.
+///
+/// <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
+///
+/// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+/// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+/// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+/// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+fn visual_runs_for_line(levels: Vec<Level>, line: &Range<usize>) -> (Vec<Level>, Vec<LevelRun>) {
+ // Find consecutive level runs.
+ let mut runs = Vec::new();
+ let mut start = line.start;
+ let mut run_level = levels[start];
+ let mut min_level = run_level;
+ let mut max_level = run_level;
+
+ for (i, &new_level) in levels.iter().enumerate().take(line.end).skip(start + 1) {
+ if new_level != run_level {
+ // End of the previous run, start of a new one.
+ runs.push(start..i);
+ start = i;
+ run_level = new_level;
+ min_level = cmp::min(run_level, min_level);
+ max_level = cmp::max(run_level, max_level);
+ }
+ }
+ runs.push(start..line.end);
+
+ let run_count = runs.len();
+
+ // Re-order the odd runs.
+ // <http://www.unicode.org/reports/tr9/#L2>
+
+ // Stop at the lowest *odd* level.
+ min_level = min_level.new_lowest_ge_rtl().expect("Level error");
+ // This loop goes through contiguous chunks of level runs that have a level
+ // ≥ max_level and reverses their contents, reducing max_level by 1 each time.
+ while max_level >= min_level {
+ // Look for the start of a sequence of consecutive runs of max_level or higher.
+ let mut seq_start = 0;
+ while seq_start < run_count {
+ if levels[runs[seq_start].start] < max_level {
+ seq_start += 1;
+ continue;
+ }
+
+ // Found the start of a sequence. Now find the end.
+ let mut seq_end = seq_start + 1;
+ while seq_end < run_count {
+ if levels[runs[seq_end].start] < max_level {
+ break;
+ }
+ seq_end += 1;
+ }
+ // Reverse the runs within this sequence.
+ runs[seq_start..seq_end].reverse();
+
+ seq_start = seq_end;
+ }
+ max_level
+ .lower(1)
+ .expect("Lowering embedding level below zero");
+ }
+ (levels, runs)
+}
+
+/// Reorders pre-calculated levels of a sequence of characters.
+///
+/// NOTE: This is a convenience method that does not use a `Paragraph` object. It is
+/// intended to be used when an application has determined the levels of the objects (character sequences)
+/// and just needs to have them reordered.
+///
+/// the index map will result in `indexMap[visualIndex]==logicalIndex`.
+///
+/// This only runs [Rule L2](http://www.unicode.org/reports/tr9/#L2) as it does not have
+/// information about the actual text.
+///
+/// Furthermore, if `levels` is an array that is aligned with code units, bytes within a codepoint may be
+/// reversed. You may need to fix up the map to deal with this. Alternatively, only pass in arrays where each `Level`
+/// is for a single code point.
+fn reorder_visual(levels: &[Level]) -> Vec<usize> {
+ // Gets the next range of characters after start_index with a level greater
+ // than or equal to `max`
+ fn next_range(levels: &[level::Level], mut start_index: usize, max: Level) -> Range<usize> {
+ if levels.is_empty() || start_index >= levels.len() {
+ return start_index..start_index;
+ }
+ while let Some(l) = levels.get(start_index) {
+ if *l >= max {
+ break;
+ }
+ start_index += 1;
+ }
+
+ if levels.get(start_index).is_none() {
+ // If at the end of the array, adding one will
+ // produce an out-of-range end element
+ return start_index..start_index;
+ }
+
+ let mut end_index = start_index + 1;
+ while let Some(l) = levels.get(end_index) {
+ if *l < max {
+ return start_index..end_index;
+ }
+ end_index += 1;
+ }
+
+ start_index..end_index
+ }
+
+ // This implementation is similar to the L2 implementation in `visual_runs()`
+ // but it cannot benefit from a precalculated LevelRun vector so needs to be different.
+
+ if levels.is_empty() {
+ return vec![];
+ }
+
+ // Get the min and max levels
+ let (mut min, mut max) = levels
+ .iter()
+ .fold((levels[0], levels[0]), |(min, max), &l| {
+ (cmp::min(min, l), cmp::max(max, l))
+ });
+
+ // Initialize an index map
+ let mut result: Vec<usize> = (0..levels.len()).collect();
+
+ if min == max && min.is_ltr() {
+ // Everything is LTR and at the same level, do nothing
+ return result;
+ }
+
+ // Stop at the lowest *odd* level, since everything below that
+ // is LTR and does not need further reordering
+ min = min.new_lowest_ge_rtl().expect("Level error");
+
+ // For each max level, take all contiguous chunks of
+ // levels ≥ max and reverse them
+ //
+ // We can do this check with the original levels instead of checking reorderings because all
+ // prior reorderings will have been for contiguous chunks of levels >> max, which will
+ // be a subset of these chunks anyway.
+ while min <= max {
+ let mut range = 0..0;
+ loop {
+ range = next_range(levels, range.end, max);
+ result[range.clone()].reverse();
+
+ if range.end >= levels.len() {
+ break;
+ }
+ }
+
+ max.lower(1).expect("Level error");
+ }
+
+ result
+}
+
+/// The core of BidiInfo initialization, factored out into a function that both
+/// the utf-8 and utf-16 versions of BidiInfo can use.
+fn compute_bidi_info_for_para<'a, D: BidiDataSource, T: TextSource<'a> + ?Sized>(
+ data_source: &D,
+ para: &ParagraphInfo,
+ is_pure_ltr: bool,
+ text: &'a T,
+ original_classes: &[BidiClass],
+ processing_classes: &mut [BidiClass],
+ levels: &mut Vec<Level>,
+) {
+ let new_len = levels.len() + para.range.len();
+ levels.resize(new_len, para.level);
+ if para.level == LTR_LEVEL && is_pure_ltr {
+ return;
+ }
+
+ let processing_classes = &mut processing_classes[para.range.clone()];
+ let levels = &mut levels[para.range.clone()];
+
+ explicit::compute(
+ text,
+ para.level,
+ original_classes,
+ levels,
+ processing_classes,
+ );
+
+ let sequences = prepare::isolating_run_sequences(para.level, original_classes, levels);
+ for sequence in &sequences {
+ implicit::resolve_weak(text, sequence, processing_classes);
+ implicit::resolve_neutral(
+ text,
+ data_source,
+ sequence,
+ levels,
+ original_classes,
+ processing_classes,
+ );
+ }
+ implicit::resolve_levels(processing_classes, levels);
+
+ assign_levels_to_removed_chars(para.level, original_classes, levels);
+}
+
+/// Produce the levels for this paragraph as needed for reordering, one level per *code unit*
+/// in the paragraph. The returned vector includes code units that are not included
+/// in the `line`, but will not adjust them.
+///
+/// This runs [Rule L1]
+///
+/// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+fn reorder_levels<'a, T: TextSource<'a> + ?Sized>(
+ line_classes: &[BidiClass],
+ line_levels: &mut [Level],
+ line_text: &'a T,
+ para_level: Level,
+) {
+ // Reset some whitespace chars to paragraph level.
+ // <http://www.unicode.org/reports/tr9/#L1>
+ let mut reset_from: Option<usize> = Some(0);
+ let mut reset_to: Option<usize> = None;
+ let mut prev_level = para_level;
+ for (i, c) in line_text.char_indices() {
+ match line_classes[i] {
+ // Segment separator, Paragraph separator
+ B | S => {
+ assert_eq!(reset_to, None);
+ reset_to = Some(i + T::char_len(c));
+ if reset_from == None {
+ reset_from = Some(i);
+ }
+ }
+ // Whitespace, isolate formatting
+ WS | FSI | LRI | RLI | PDI => {
+ if reset_from == None {
+ reset_from = Some(i);
+ }
+ }
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ // same as above + set the level
+ RLE | LRE | RLO | LRO | PDF | BN => {
+ if reset_from == None {
+ reset_from = Some(i);
+ }
+ // also set the level to previous
+ line_levels[i] = prev_level;
+ }
+ _ => {
+ reset_from = None;
+ }
+ }
+ if let (Some(from), Some(to)) = (reset_from, reset_to) {
+ for level in &mut line_levels[from..to] {
+ *level = para_level;
+ }
+ reset_from = None;
+ reset_to = None;
+ }
+ prev_level = line_levels[i];
+ }
+ if let Some(from) = reset_from {
+ for level in &mut line_levels[from..] {
+ *level = para_level;
+ }
+ }
+}
+
+/// Contains a reference of `BidiInfo` and one of its `paragraphs`.
+/// And it supports all operation in the `Paragraph` that needs also its
+/// `BidiInfo` such as `direction`.
+#[derive(Debug)]
+pub struct Paragraph<'a, 'text> {
+ pub info: &'a BidiInfo<'text>,
+ pub para: &'a ParagraphInfo,
+}
+
+impl<'a, 'text> Paragraph<'a, 'text> {
+ #[inline]
+ pub fn new(info: &'a BidiInfo<'text>, para: &'a ParagraphInfo) -> Paragraph<'a, 'text> {
+ Paragraph { info, para }
+ }
+
+ /// Returns if the paragraph is Left direction, right direction or mixed.
+ #[inline]
+ pub fn direction(&self) -> Direction {
+ para_direction(&self.info.levels[self.para.range.clone()])
+ }
+
+ /// Returns the `Level` of a certain character in the paragraph.
+ #[inline]
+ pub fn level_at(&self, pos: usize) -> Level {
+ let actual_position = self.para.range.start + pos;
+ self.info.levels[actual_position]
+ }
+}
+
+/// Return the directionality of the paragraph (Left, Right or Mixed) from its levels.
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+fn para_direction(levels: &[Level]) -> Direction {
+ let mut ltr = false;
+ let mut rtl = false;
+ for level in levels {
+ if level.is_ltr() {
+ ltr = true;
+ if rtl {
+ return Direction::Mixed;
+ }
+ }
+
+ if level.is_rtl() {
+ rtl = true;
+ if ltr {
+ return Direction::Mixed;
+ }
+ }
+ }
+
+ if ltr {
+ return Direction::Ltr;
+ }
+
+ Direction::Rtl
+}
+
+/// Assign levels to characters removed by rule X9.
+///
+/// The levels assigned to these characters are not specified by the algorithm. This function
+/// assigns each one the level of the previous character, to avoid breaking level runs.
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+fn assign_levels_to_removed_chars(para_level: Level, classes: &[BidiClass], levels: &mut [Level]) {
+ for i in 0..levels.len() {
+ if prepare::removed_by_x9(classes[i]) {
+ levels[i] = if i > 0 { levels[i - 1] } else { para_level };
+ }
+ }
+}
+
+/// Get the base direction of the text provided according to the Unicode Bidirectional Algorithm.
+///
+/// See rules P2 and P3.
+///
+/// The base direction is derived from the first character in the string with bidi character type
+/// L, R, or AL. If the first such character has type L, Direction::Ltr is returned. If the first
+/// such character has type R or AL, Direction::Rtl is returned.
+///
+/// If the string does not contain any character of these types (outside of embedded isolate runs),
+/// then Direction::Mixed is returned (but should be considered as meaning "neutral" or "unknown",
+/// not in fact mixed directions).
+///
+/// This is a lightweight function for use when only the base direction is needed and no further
+/// bidi processing of the text is needed.
+///
+/// If the text contains paragraph separators, this function considers only the first paragraph.
+#[cfg(feature = "hardcoded-data")]
+#[inline]
+pub fn get_base_direction<'a, T: TextSource<'a> + ?Sized>(text: &'a T) -> Direction {
+ get_base_direction_with_data_source(&HardcodedBidiData, text)
+}
+
+/// Get the base direction of the text provided according to the Unicode Bidirectional Algorithm,
+/// considering the full text if the first paragraph is all-neutral.
+///
+/// This is the same as get_base_direction except that it does not stop at the first block
+/// separator, but just resets the embedding level and continues to look for a strongly-
+/// directional character. So the result will be the base direction of the first paragraph
+/// that is not purely neutral characters.
+#[cfg(feature = "hardcoded-data")]
+#[inline]
+pub fn get_base_direction_full<'a, T: TextSource<'a> + ?Sized>(text: &'a T) -> Direction {
+ get_base_direction_full_with_data_source(&HardcodedBidiData, text)
+}
+
+#[inline]
+pub fn get_base_direction_with_data_source<'a, D: BidiDataSource, T: TextSource<'a> + ?Sized>(
+ data_source: &D,
+ text: &'a T,
+) -> Direction {
+ get_base_direction_impl(data_source, text, false)
+}
+
+#[inline]
+pub fn get_base_direction_full_with_data_source<
+ 'a,
+ D: BidiDataSource,
+ T: TextSource<'a> + ?Sized,
+>(
+ data_source: &D,
+ text: &'a T,
+) -> Direction {
+ get_base_direction_impl(data_source, text, true)
+}
+
+fn get_base_direction_impl<'a, D: BidiDataSource, T: TextSource<'a> + ?Sized>(
+ data_source: &D,
+ text: &'a T,
+ use_full_text: bool,
+) -> Direction {
+ let mut isolate_level = 0;
+ for c in text.chars() {
+ match data_source.bidi_class(c) {
+ LRI | RLI | FSI => isolate_level = isolate_level + 1,
+ PDI if isolate_level > 0 => isolate_level = isolate_level - 1,
+ L if isolate_level == 0 => return Direction::Ltr,
+ R | AL if isolate_level == 0 => return Direction::Rtl,
+ B if !use_full_text => break,
+ B if use_full_text => isolate_level = 0,
+ _ => (),
+ }
+ }
+ // If no strong char was found, return Mixed. Normally this will be treated as Ltr by callers
+ // (see rule P3), but we don't map this to Ltr here so that a caller that wants to apply other
+ // heuristics to an all-neutral paragraph can tell the difference.
+ Direction::Mixed
+}
+
+/// Implementation of TextSource for UTF-8 text (a string slice).
+impl<'text> TextSource<'text> for str {
+ type CharIter = core::str::Chars<'text>;
+ type CharIndexIter = core::str::CharIndices<'text>;
+ type IndexLenIter = Utf8IndexLenIter<'text>;
+
+ #[inline]
+ fn len(&self) -> usize {
+ (self as &str).len()
+ }
+ #[inline]
+ fn char_at(&self, index: usize) -> Option<(char, usize)> {
+ if let Some(slice) = self.get(index..) {
+ if let Some(ch) = slice.chars().next() {
+ return Some((ch, ch.len_utf8()));
+ }
+ }
+ None
+ }
+ #[inline]
+ fn subrange(&self, range: Range<usize>) -> &Self {
+ &(self as &str)[range]
+ }
+ #[inline]
+ fn chars(&'text self) -> Self::CharIter {
+ (self as &str).chars()
+ }
+ #[inline]
+ fn char_indices(&'text self) -> Self::CharIndexIter {
+ (self as &str).char_indices()
+ }
+ #[inline]
+ fn indices_lengths(&'text self) -> Self::IndexLenIter {
+ Utf8IndexLenIter::new(&self)
+ }
+ #[inline]
+ fn char_len(ch: char) -> usize {
+ ch.len_utf8()
+ }
+}
+
+/// Iterator over (UTF-8) string slices returning (index, char_len) tuple.
+#[derive(Debug)]
+pub struct Utf8IndexLenIter<'text> {
+ iter: CharIndices<'text>,
+}
+
+impl<'text> Utf8IndexLenIter<'text> {
+ #[inline]
+ pub fn new(text: &'text str) -> Self {
+ Utf8IndexLenIter {
+ iter: text.char_indices(),
+ }
+ }
+}
+
+impl Iterator for Utf8IndexLenIter<'_> {
+ type Item = (usize, usize);
+
+ #[inline]
+ fn next(&mut self) -> Option<Self::Item> {
+ if let Some((pos, ch)) = self.iter.next() {
+ return Some((pos, ch.len_utf8()));
+ }
+ None
+ }
+}
+
+#[cfg(test)]
+fn to_utf16(s: &str) -> Vec<u16> {
+ s.encode_utf16().collect()
+}
+
+#[cfg(test)]
+#[cfg(feature = "hardcoded-data")]
+mod tests {
+ use super::*;
+
+ use utf16::{
+ BidiInfo as BidiInfoU16, InitialInfo as InitialInfoU16, Paragraph as ParagraphU16,
+ ParagraphBidiInfo as ParagraphBidiInfoU16,
+ };
+
+ #[test]
+ fn test_utf16_text_source() {
+ let text: &[u16] =
+ &[0x41, 0xD801, 0xDC01, 0x20, 0xD800, 0x20, 0xDFFF, 0x20, 0xDC00, 0xD800];
+ assert_eq!(text.char_at(0), Some(('A', 1)));
+ assert_eq!(text.char_at(1), Some(('\u{10401}', 2)));
+ assert_eq!(text.char_at(2), None);
+ assert_eq!(text.char_at(3), Some((' ', 1)));
+ assert_eq!(text.char_at(4), Some((char::REPLACEMENT_CHARACTER, 1)));
+ assert_eq!(text.char_at(5), Some((' ', 1)));
+ assert_eq!(text.char_at(6), Some((char::REPLACEMENT_CHARACTER, 1)));
+ assert_eq!(text.char_at(7), Some((' ', 1)));
+ assert_eq!(text.char_at(8), Some((char::REPLACEMENT_CHARACTER, 1)));
+ assert_eq!(text.char_at(9), Some((char::REPLACEMENT_CHARACTER, 1)));
+ assert_eq!(text.char_at(10), None);
+ }
+
+ #[test]
+ fn test_utf16_char_iter() {
+ let text: &[u16] =
+ &[0x41, 0xD801, 0xDC01, 0x20, 0xD800, 0x20, 0xDFFF, 0x20, 0xDC00, 0xD800];
+ assert_eq!(text.len(), 10);
+ assert_eq!(text.chars().count(), 9);
+ let mut chars = text.chars();
+ assert_eq!(chars.next(), Some('A'));
+ assert_eq!(chars.next(), Some('\u{10401}'));
+ assert_eq!(chars.next(), Some(' '));
+ assert_eq!(chars.next(), Some('\u{FFFD}'));
+ assert_eq!(chars.next(), Some(' '));
+ assert_eq!(chars.next(), Some('\u{FFFD}'));
+ assert_eq!(chars.next(), Some(' '));
+ assert_eq!(chars.next(), Some('\u{FFFD}'));
+ assert_eq!(chars.next(), Some('\u{FFFD}'));
+ assert_eq!(chars.next(), None);
+ }
+
+ #[test]
+ fn test_initial_text_info() {
+ let tests = vec![
+ (
+ // text
+ "a1",
+ // expected bidi classes per utf-8 byte
+ vec![L, EN],
+ // expected paragraph-info for utf-8
+ vec![ParagraphInfo {
+ range: 0..2,
+ level: LTR_LEVEL,
+ }],
+ // expected bidi classes per utf-16 code unit
+ vec![L, EN],
+ // expected paragraph-info for utf-16
+ vec![ParagraphInfo {
+ range: 0..2,
+ level: LTR_LEVEL,
+ }],
+ ),
+ (
+ // Arabic, space, Hebrew
+ "\u{0639} \u{05D0}",
+ vec![AL, AL, WS, R, R],
+ vec![ParagraphInfo {
+ range: 0..5,
+ level: RTL_LEVEL,
+ }],
+ vec![AL, WS, R],
+ vec![ParagraphInfo {
+ range: 0..3,
+ level: RTL_LEVEL,
+ }],
+ ),
+ (
+ // SMP characters from Kharoshthi, Cuneiform, Adlam:
+ "\u{10A00}\u{12000}\u{1E900}",
+ vec![R, R, R, R, L, L, L, L, R, R, R, R],
+ vec![ParagraphInfo {
+ range: 0..12,
+ level: RTL_LEVEL,
+ }],
+ vec![R, R, L, L, R, R],
+ vec![ParagraphInfo {
+ range: 0..6,
+ level: RTL_LEVEL,
+ }],
+ ),
+ (
+ "a\u{2029}b",
+ vec![L, B, B, B, L],
+ vec![
+ ParagraphInfo {
+ range: 0..4,
+ level: LTR_LEVEL,
+ },
+ ParagraphInfo {
+ range: 4..5,
+ level: LTR_LEVEL,
+ },
+ ],
+ vec![L, B, L],
+ vec![
+ ParagraphInfo {
+ range: 0..2,
+ level: LTR_LEVEL,
+ },
+ ParagraphInfo {
+ range: 2..3,
+ level: LTR_LEVEL,
+ },
+ ],
+ ),
+ (
+ "\u{2068}א\u{2069}a", // U+2068 FSI, U+2069 PDI
+ vec![RLI, RLI, RLI, R, R, PDI, PDI, PDI, L],
+ vec![ParagraphInfo {
+ range: 0..9,
+ level: LTR_LEVEL,
+ }],
+ vec![RLI, R, PDI, L],
+ vec![ParagraphInfo {
+ range: 0..4,
+ level: LTR_LEVEL,
+ }],
+ ),
+ ];
+
+ for t in tests {
+ assert_eq!(
+ InitialInfo::new(t.0, None),
+ InitialInfo {
+ text: t.0,
+ original_classes: t.1,
+ paragraphs: t.2,
+ }
+ );
+ let text = &to_utf16(t.0);
+ assert_eq!(
+ InitialInfoU16::new(text, None),
+ InitialInfoU16 {
+ text,
+ original_classes: t.3,
+ paragraphs: t.4,
+ }
+ );
+ }
+ }
+
+ #[test]
+ #[cfg(feature = "hardcoded-data")]
+ fn test_process_text() {
+ let tests = vec![
+ (
+ // text
+ "abc123",
+ // base level
+ Some(LTR_LEVEL),
+ // levels
+ Level::vec(&[0, 0, 0, 0, 0, 0]),
+ // original_classes
+ vec![L, L, L, EN, EN, EN],
+ // paragraphs
+ vec![ParagraphInfo {
+ range: 0..6,
+ level: LTR_LEVEL,
+ }],
+ // levels_u16
+ Level::vec(&[0, 0, 0, 0, 0, 0]),
+ // original_classes_u16
+ vec![L, L, L, EN, EN, EN],
+ // paragraphs_u16
+ vec![ParagraphInfo {
+ range: 0..6,
+ level: LTR_LEVEL,
+ }],
+ ),
+ (
+ "abc \u{05D0}\u{05D1}\u{05D2}",
+ Some(LTR_LEVEL),
+ Level::vec(&[0, 0, 0, 0, 1, 1, 1, 1, 1, 1]),
+ vec![L, L, L, WS, R, R, R, R, R, R],
+ vec![ParagraphInfo {
+ range: 0..10,
+ level: LTR_LEVEL,
+ }],
+ Level::vec(&[0, 0, 0, 0, 1, 1, 1]),
+ vec![L, L, L, WS, R, R, R],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: LTR_LEVEL,
+ }],
+ ),
+ (
+ "abc \u{05D0}\u{05D1}\u{05D2}",
+ Some(RTL_LEVEL),
+ Level::vec(&[2, 2, 2, 1, 1, 1, 1, 1, 1, 1]),
+ vec![L, L, L, WS, R, R, R, R, R, R],
+ vec![ParagraphInfo {
+ range: 0..10,
+ level: RTL_LEVEL,
+ }],
+ Level::vec(&[2, 2, 2, 1, 1, 1, 1]),
+ vec![L, L, L, WS, R, R, R],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: RTL_LEVEL,
+ }],
+ ),
+ (
+ "\u{05D0}\u{05D1}\u{05D2} abc",
+ Some(LTR_LEVEL),
+ Level::vec(&[1, 1, 1, 1, 1, 1, 0, 0, 0, 0]),
+ vec![R, R, R, R, R, R, WS, L, L, L],
+ vec![ParagraphInfo {
+ range: 0..10,
+ level: LTR_LEVEL,
+ }],
+ Level::vec(&[1, 1, 1, 0, 0, 0, 0]),
+ vec![R, R, R, WS, L, L, L],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: LTR_LEVEL,
+ }],
+ ),
+ (
+ "\u{05D0}\u{05D1}\u{05D2} abc",
+ None,
+ Level::vec(&[1, 1, 1, 1, 1, 1, 1, 2, 2, 2]),
+ vec![R, R, R, R, R, R, WS, L, L, L],
+ vec![ParagraphInfo {
+ range: 0..10,
+ level: RTL_LEVEL,
+ }],
+ Level::vec(&[1, 1, 1, 1, 2, 2, 2]),
+ vec![R, R, R, WS, L, L, L],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: RTL_LEVEL,
+ }],
+ ),
+ (
+ "\u{063A}2\u{0638} \u{05D0}2\u{05D2}",
+ Some(LTR_LEVEL),
+ Level::vec(&[1, 1, 2, 1, 1, 1, 1, 1, 2, 1, 1]),
+ vec![AL, AL, EN, AL, AL, WS, R, R, EN, R, R],
+ vec![ParagraphInfo {
+ range: 0..11,
+ level: LTR_LEVEL,
+ }],
+ Level::vec(&[1, 2, 1, 1, 1, 2, 1]),
+ vec![AL, EN, AL, WS, R, EN, R],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: LTR_LEVEL,
+ }],
+ ),
+ (
+ "a א.\nג",
+ None,
+ Level::vec(&[0, 0, 1, 1, 0, 0, 1, 1]),
+ vec![L, WS, R, R, CS, B, R, R],
+ vec![
+ ParagraphInfo {
+ range: 0..6,
+ level: LTR_LEVEL,
+ },
+ ParagraphInfo {
+ range: 6..8,
+ level: RTL_LEVEL,
+ },
+ ],
+ Level::vec(&[0, 0, 1, 0, 0, 1]),
+ vec![L, WS, R, CS, B, R],
+ vec![
+ ParagraphInfo {
+ range: 0..5,
+ level: LTR_LEVEL,
+ },
+ ParagraphInfo {
+ range: 5..6,
+ level: RTL_LEVEL,
+ },
+ ],
+ ),
+ // BidiTest:69635 (AL ET EN)
+ (
+ "\u{060B}\u{20CF}\u{06F9}",
+ None,
+ Level::vec(&[1, 1, 1, 1, 1, 2, 2]),
+ vec![AL, AL, ET, ET, ET, EN, EN],
+ vec![ParagraphInfo {
+ range: 0..7,
+ level: RTL_LEVEL,
+ }],
+ Level::vec(&[1, 1, 2]),
+ vec![AL, ET, EN],
+ vec![ParagraphInfo {
+ range: 0..3,
+ level: RTL_LEVEL,
+ }],
+ ),
+ ];
+
+ for t in tests {
+ assert_eq!(
+ BidiInfo::new(t.0, t.1),
+ BidiInfo {
+ text: t.0,
+ levels: t.2.clone(),
+ original_classes: t.3.clone(),
+ paragraphs: t.4.clone(),
+ }
+ );
+ // If it was a single paragraph, also test ParagraphBidiInfo.
+ if t.4.len() == 1 {
+ assert_eq!(
+ ParagraphBidiInfo::new(t.0, t.1),
+ ParagraphBidiInfo {
+ text: t.0,
+ original_classes: t.3,
+ levels: t.2.clone(),
+ paragraph_level: t.4[0].level,
+ is_pure_ltr: !level::has_rtl(&t.2),
+ }
+ )
+ }
+ let text = &to_utf16(t.0);
+ assert_eq!(
+ BidiInfoU16::new(text, t.1),
+ BidiInfoU16 {
+ text,
+ levels: t.5.clone(),
+ original_classes: t.6.clone(),
+ paragraphs: t.7.clone(),
+ }
+ );
+ if t.7.len() == 1 {
+ assert_eq!(
+ ParagraphBidiInfoU16::new(text, t.1),
+ ParagraphBidiInfoU16 {
+ text: text,
+ original_classes: t.6.clone(),
+ levels: t.5.clone(),
+ paragraph_level: t.7[0].level,
+ is_pure_ltr: !level::has_rtl(&t.5),
+ }
+ )
+ }
+ }
+ }
+
+ #[test]
+ #[cfg(feature = "hardcoded-data")]
+ fn test_paragraph_bidi_info() {
+ // Passing text that includes a paragraph break to the ParagraphBidiInfo API:
+ // this is a misuse of the API by the client, but our behavior is safe &
+ // consistent. The embedded paragraph break acts like a separator (tab) would.
+ let tests = vec![
+ (
+ "a א.\nג",
+ None,
+ // utf-8 results:
+ vec![L, WS, R, R, CS, B, R, R],
+ Level::vec(&[0, 0, 1, 1, 1, 1, 1, 1]),
+ // utf-16 results:
+ vec![L, WS, R, CS, B, R],
+ Level::vec(&[0, 0, 1, 1, 1, 1]),
+ // paragraph level; is_pure_ltr
+ LTR_LEVEL,
+ false,
+ ),
+ (
+ "\u{5d1} a.\nb.",
+ None,
+ // utf-8 results:
+ vec![R, R, WS, L, CS, B, L, CS],
+ Level::vec(&[1, 1, 1, 2, 2, 2, 2, 1]),
+ // utf-16 results:
+ vec![R, WS, L, CS, B, L, CS],
+ Level::vec(&[1, 1, 2, 2, 2, 2, 1]),
+ // paragraph level; is_pure_ltr
+ RTL_LEVEL,
+ false,
+ ),
+ (
+ "a א.\tג",
+ None,
+ // utf-8 results:
+ vec![L, WS, R, R, CS, S, R, R],
+ Level::vec(&[0, 0, 1, 1, 1, 1, 1, 1]),
+ // utf-16 results:
+ vec![L, WS, R, CS, S, R],
+ Level::vec(&[0, 0, 1, 1, 1, 1]),
+ // paragraph level; is_pure_ltr
+ LTR_LEVEL,
+ false,
+ ),
+ (
+ "\u{5d1} a.\tb.",
+ None,
+ // utf-8 results:
+ vec![R, R, WS, L, CS, S, L, CS],
+ Level::vec(&[1, 1, 1, 2, 2, 2, 2, 1]),
+ // utf-16 results:
+ vec![R, WS, L, CS, S, L, CS],
+ Level::vec(&[1, 1, 2, 2, 2, 2, 1]),
+ // paragraph level; is_pure_ltr
+ RTL_LEVEL,
+ false,
+ ),
+ ];
+
+ for t in tests {
+ assert_eq!(
+ ParagraphBidiInfo::new(t.0, t.1),
+ ParagraphBidiInfo {
+ text: t.0,
+ original_classes: t.2,
+ levels: t.3,
+ paragraph_level: t.6,
+ is_pure_ltr: t.7,
+ }
+ );
+ let text = &to_utf16(t.0);
+ assert_eq!(
+ ParagraphBidiInfoU16::new(text, t.1),
+ ParagraphBidiInfoU16 {
+ text: text,
+ original_classes: t.4,
+ levels: t.5,
+ paragraph_level: t.6,
+ is_pure_ltr: t.7,
+ }
+ );
+ }
+ }
+
+ #[test]
+ #[cfg(feature = "hardcoded-data")]
+ fn test_bidi_info_has_rtl() {
+ let tests = vec![
+ // ASCII only
+ ("123", None, false),
+ ("123", Some(LTR_LEVEL), false),
+ ("123", Some(RTL_LEVEL), false),
+ ("abc", None, false),
+ ("abc", Some(LTR_LEVEL), false),
+ ("abc", Some(RTL_LEVEL), false),
+ ("abc 123", None, false),
+ ("abc\n123", None, false),
+ // With Hebrew
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2}", None, true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2}", Some(LTR_LEVEL), true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2}", Some(RTL_LEVEL), true),
+ ("abc \u{05D0}\u{05D1}\u{05BC}\u{05D2}", None, true),
+ ("abc\n\u{05D0}\u{05D1}\u{05BC}\u{05D2}", None, true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2} abc", None, true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2}\nabc", None, true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2} 123", None, true),
+ ("\u{05D0}\u{05D1}\u{05BC}\u{05D2}\n123", None, true),
+ ];
+
+ for t in tests {
+ assert_eq!(BidiInfo::new(t.0, t.1).has_rtl(), t.2);
+ assert_eq!(BidiInfoU16::new(&to_utf16(t.0), t.1).has_rtl(), t.2);
+ }
+ }
+
+ #[cfg(feature = "hardcoded-data")]
+ fn reorder_paras(text: &str) -> Vec<Cow<'_, str>> {
+ let bidi_info = BidiInfo::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reorder_line(para, para.range.clone()))
+ .collect()
+ }
+
+ #[cfg(feature = "hardcoded-data")]
+ fn reorder_paras_u16(text: &[u16]) -> Vec<Cow<'_, [u16]>> {
+ let bidi_info = BidiInfoU16::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reorder_line(para, para.range.clone()))
+ .collect()
+ }
+
+ #[test]
+ #[cfg(feature = "hardcoded-data")]
+ fn test_reorder_line() {
+ let tests = vec![
+ // Bidi_Class: L L L B L L L B L L L
+ ("abc\ndef\nghi", vec!["abc\n", "def\n", "ghi"]),
+ // Bidi_Class: L L EN B L L EN B L L EN
+ ("ab1\nde2\ngh3", vec!["ab1\n", "de2\n", "gh3"]),
+ // Bidi_Class: L L L B AL AL AL
+ ("abc\nابج", vec!["abc\n", "جبا"]),
+ // Bidi_Class: AL AL AL B L L L
+ (
+ "\u{0627}\u{0628}\u{062C}\nabc",
+ vec!["\n\u{062C}\u{0628}\u{0627}", "abc"],
+ ),
+ ("1.-2", vec!["1.-2"]),
+ ("1-.2", vec!["1-.2"]),
+ ("abc אבג", vec!["abc גבא"]),
+ // Numbers being weak LTR characters, cannot reorder strong RTL
+ ("123 \u{05D0}\u{05D1}\u{05D2}", vec!["גבא 123"]),
+ ("abc\u{202A}def", vec!["abc\u{202A}def"]),
+ (
+ "abc\u{202A}def\u{202C}ghi",
+ vec!["abc\u{202A}def\u{202C}ghi"],
+ ),
+ (
+ "abc\u{2066}def\u{2069}ghi",
+ vec!["abc\u{2066}def\u{2069}ghi"],
+ ),
+ // Testing for RLE Character
+ ("\u{202B}abc אבג\u{202C}", vec!["\u{202b}גבא abc\u{202c}"]),
+ // Testing neutral characters
+ ("\u{05D0}בג? אבג", vec!["גבא ?גבא"]),
+ // Testing neutral characters with special case
+ ("A אבג?", vec!["A גבא?"]),
+ // Testing neutral characters with Implicit RTL Marker
+ ("A אבג?\u{200F}", vec!["A \u{200F}?גבא"]),
+ ("\u{05D0}בג abc", vec!["abc גבא"]),
+ ("abc\u{2067}.-\u{2069}ghi", vec!["abc\u{2067}-.\u{2069}ghi"]),
+ (
+ "Hello, \u{2068}\u{202E}world\u{202C}\u{2069}!",
+ vec!["Hello, \u{2068}\u{202E}\u{202C}dlrow\u{2069}!"],
+ ),
+ // With mirrorable characters in RTL run
+ ("\u{05D0}(ב)ג.", vec![".ג)ב(א"]),
+ // With mirrorable characters on level boundary
+ ("\u{05D0}ב(גד[&ef].)gh", vec!["gh).]ef&[דג(בא"]),
+ ];
+
+ for t in tests {
+ assert_eq!(reorder_paras(t.0), t.1);
+ let expect_utf16 = t.1.iter().map(|v| to_utf16(v)).collect::<Vec<_>>();
+ assert_eq!(reorder_paras_u16(&to_utf16(t.0)), expect_utf16);
+ }
+ }
+
+ fn reordered_levels_for_paras(text: &str) -> Vec<Vec<Level>> {
+ let bidi_info = BidiInfo::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reordered_levels(para, para.range.clone()))
+ .collect()
+ }
+
+ fn reordered_levels_per_char_for_paras(text: &str) -> Vec<Vec<Level>> {
+ let bidi_info = BidiInfo::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reordered_levels_per_char(para, para.range.clone()))
+ .collect()
+ }
+
+ fn reordered_levels_for_paras_u16(text: &[u16]) -> Vec<Vec<Level>> {
+ let bidi_info = BidiInfoU16::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reordered_levels(para, para.range.clone()))
+ .collect()
+ }
+
+ fn reordered_levels_per_char_for_paras_u16(text: &[u16]) -> Vec<Vec<Level>> {
+ let bidi_info = BidiInfoU16::new(text, None);
+ bidi_info
+ .paragraphs
+ .iter()
+ .map(|para| bidi_info.reordered_levels_per_char(para, para.range.clone()))
+ .collect()
+ }
+
+ #[test]
+ #[cfg(feature = "hardcoded-data")]
+ fn test_reordered_levels() {
+ let tests = vec![
+ // BidiTest:946 (LRI PDI)
+ (
+ "\u{2067}\u{2069}",
+ vec![Level::vec(&[0, 0, 0, 0, 0, 0])],
+ vec![Level::vec(&[0, 0])],
+ vec![Level::vec(&[0, 0])],
+ ),
+ // BidiTest:69635 (AL ET EN)
+ (
+ "\u{060B}\u{20CF}\u{06F9}",
+ vec![Level::vec(&[1, 1, 1, 1, 1, 2, 2])],
+ vec![Level::vec(&[1, 1, 2])],
+ vec![Level::vec(&[1, 1, 2])],
+ ),
+ ];
+
+ for t in tests {
+ assert_eq!(reordered_levels_for_paras(t.0), t.1);
+ assert_eq!(reordered_levels_per_char_for_paras(t.0), t.2);
+ let text = &to_utf16(t.0);
+ assert_eq!(reordered_levels_for_paras_u16(text), t.3);
+ assert_eq!(reordered_levels_per_char_for_paras_u16(text), t.2);
+ }
+
+ let tests = vec![
+ // BidiTest:291284 (AN RLI PDF R)
+ (
+ "\u{0605}\u{2067}\u{202C}\u{0590}",
+ vec![&["2", "2", "0", "0", "0", "x", "x", "x", "1", "1"]],
+ vec![&["2", "0", "x", "1"]],
+ vec![&["2", "0", "x", "1"]],
+ ),
+ ];
+
+ for t in tests {
+ assert_eq!(reordered_levels_for_paras(t.0), t.1);
+ assert_eq!(reordered_levels_per_char_for_paras(t.0), t.2);
+ let text = &to_utf16(t.0);
+ assert_eq!(reordered_levels_for_paras_u16(text), t.3);
+ assert_eq!(reordered_levels_per_char_for_paras_u16(text), t.2);
+ }
+
+ let text = "aa טֶ";
+ let bidi_info = BidiInfo::new(text, None);
+ assert_eq!(
+ bidi_info.reordered_levels(&bidi_info.paragraphs[0], 3..7),
+ Level::vec(&[0, 0, 0, 1, 1, 1, 1]),
+ );
+
+ let text = &to_utf16(text);
+ let bidi_info = BidiInfoU16::new(text, None);
+ assert_eq!(
+ bidi_info.reordered_levels(&bidi_info.paragraphs[0], 1..4),
+ Level::vec(&[0, 0, 0, 1, 1]),
+ );
+ }
+
+ #[test]
+ fn test_paragraph_info_len() {
+ let text = "hello world";
+ let bidi_info = BidiInfo::new(text, None);
+ assert_eq!(bidi_info.paragraphs.len(), 1);
+ assert_eq!(bidi_info.paragraphs[0].len(), text.len());
+
+ let text2 = "How are you";
+ let whole_text = format!("{}\n{}", text, text2);
+ let bidi_info = BidiInfo::new(&whole_text, None);
+ assert_eq!(bidi_info.paragraphs.len(), 2);
+
+ // The first paragraph include the paragraph separator.
+ // TODO: investigate if the paragraph separator character
+ // should not be part of any paragraph.
+ assert_eq!(bidi_info.paragraphs[0].len(), text.len() + 1);
+ assert_eq!(bidi_info.paragraphs[1].len(), text2.len());
+
+ let text = &to_utf16(text);
+ let bidi_info = BidiInfoU16::new(text, None);
+ assert_eq!(bidi_info.paragraphs.len(), 1);
+ assert_eq!(bidi_info.paragraphs[0].len(), text.len());
+
+ let text2 = &to_utf16(text2);
+ let whole_text = &to_utf16(&whole_text);
+ let bidi_info = BidiInfoU16::new(&whole_text, None);
+ assert_eq!(bidi_info.paragraphs.len(), 2);
+
+ assert_eq!(bidi_info.paragraphs[0].len(), text.len() + 1);
+ assert_eq!(bidi_info.paragraphs[1].len(), text2.len());
+ }
+
+ #[test]
+ fn test_direction() {
+ let ltr_text = "hello world";
+ let rtl_text = "أهلا بكم";
+ let all_paragraphs = format!("{}\n{}\n{}{}", ltr_text, rtl_text, ltr_text, rtl_text);
+ let bidi_info = BidiInfo::new(&all_paragraphs, None);
+ assert_eq!(bidi_info.paragraphs.len(), 3);
+ let p_ltr = Paragraph::new(&bidi_info, &bidi_info.paragraphs[0]);
+ let p_rtl = Paragraph::new(&bidi_info, &bidi_info.paragraphs[1]);
+ let p_mixed = Paragraph::new(&bidi_info, &bidi_info.paragraphs[2]);
+ assert_eq!(p_ltr.direction(), Direction::Ltr);
+ assert_eq!(p_rtl.direction(), Direction::Rtl);
+ assert_eq!(p_mixed.direction(), Direction::Mixed);
+
+ let all_paragraphs = &to_utf16(&all_paragraphs);
+ let bidi_info = BidiInfoU16::new(&all_paragraphs, None);
+ assert_eq!(bidi_info.paragraphs.len(), 3);
+ let p_ltr = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[0]);
+ let p_rtl = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[1]);
+ let p_mixed = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[2]);
+ assert_eq!(p_ltr.direction(), Direction::Ltr);
+ assert_eq!(p_rtl.direction(), Direction::Rtl);
+ assert_eq!(p_mixed.direction(), Direction::Mixed);
+ }
+
+ #[test]
+ fn test_edge_cases_direction() {
+ // No paragraphs for empty text.
+ let empty = "";
+ let bidi_info = BidiInfo::new(empty, Option::from(RTL_LEVEL));
+ assert_eq!(bidi_info.paragraphs.len(), 0);
+
+ let empty = &to_utf16(empty);
+ let bidi_info = BidiInfoU16::new(empty, Option::from(RTL_LEVEL));
+ assert_eq!(bidi_info.paragraphs.len(), 0);
+
+ let tests = vec![
+ // The paragraph separator will take the value of the default direction
+ // which is left to right.
+ ("\n", None, Direction::Ltr),
+ // The paragraph separator will take the value of the given initial direction
+ // which is left to right.
+ ("\n", Option::from(LTR_LEVEL), Direction::Ltr),
+ // The paragraph separator will take the value of the given initial direction
+ // which is right to left.
+ ("\n", Option::from(RTL_LEVEL), Direction::Rtl),
+ ];
+
+ for t in tests {
+ let bidi_info = BidiInfo::new(t.0, t.1);
+ assert_eq!(bidi_info.paragraphs.len(), 1);
+ let p = Paragraph::new(&bidi_info, &bidi_info.paragraphs[0]);
+ assert_eq!(p.direction(), t.2);
+ let text = &to_utf16(t.0);
+ let bidi_info = BidiInfoU16::new(text, t.1);
+ let p = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[0]);
+ assert_eq!(p.direction(), t.2);
+ }
+ }
+
+ #[test]
+ fn test_level_at() {
+ let ltr_text = "hello world";
+ let rtl_text = "أهلا بكم";
+ let all_paragraphs = format!("{}\n{}\n{}{}", ltr_text, rtl_text, ltr_text, rtl_text);
+ let bidi_info = BidiInfo::new(&all_paragraphs, None);
+ assert_eq!(bidi_info.paragraphs.len(), 3);
+
+ let p_ltr = Paragraph::new(&bidi_info, &bidi_info.paragraphs[0]);
+ let p_rtl = Paragraph::new(&bidi_info, &bidi_info.paragraphs[1]);
+ let p_mixed = Paragraph::new(&bidi_info, &bidi_info.paragraphs[2]);
+
+ assert_eq!(p_ltr.level_at(0), LTR_LEVEL);
+ assert_eq!(p_rtl.level_at(0), RTL_LEVEL);
+ assert_eq!(p_mixed.level_at(0), LTR_LEVEL);
+ assert_eq!(p_mixed.info.levels.len(), 54);
+ assert_eq!(p_mixed.para.range.start, 28);
+ assert_eq!(p_mixed.level_at(ltr_text.len()), RTL_LEVEL);
+
+ let all_paragraphs = &to_utf16(&all_paragraphs);
+ let bidi_info = BidiInfoU16::new(&all_paragraphs, None);
+ assert_eq!(bidi_info.paragraphs.len(), 3);
+
+ let p_ltr = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[0]);
+ let p_rtl = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[1]);
+ let p_mixed = ParagraphU16::new(&bidi_info, &bidi_info.paragraphs[2]);
+
+ assert_eq!(p_ltr.level_at(0), LTR_LEVEL);
+ assert_eq!(p_rtl.level_at(0), RTL_LEVEL);
+ assert_eq!(p_mixed.level_at(0), LTR_LEVEL);
+ assert_eq!(p_mixed.info.levels.len(), 40);
+ assert_eq!(p_mixed.para.range.start, 21);
+ assert_eq!(p_mixed.level_at(ltr_text.len()), RTL_LEVEL);
+ }
+
+ #[test]
+ fn test_get_base_direction() {
+ let tests = vec![
+ ("", Direction::Mixed), // return Mixed if no strong character found
+ ("123[]-+\u{2019}\u{2060}\u{00bf}?", Direction::Mixed),
+ ("3.14\npi", Direction::Mixed), // only first paragraph is considered
+ ("[123 'abc']", Direction::Ltr),
+ ("[123 '\u{0628}' abc", Direction::Rtl),
+ ("[123 '\u{2066}abc\u{2069}'\u{0628}]", Direction::Rtl), // embedded isolate is ignored
+ ("[123 '\u{2066}abc\u{2068}'\u{0628}]", Direction::Mixed),
+ ];
+
+ for t in tests {
+ assert_eq!(get_base_direction(t.0), t.1);
+ let text = &to_utf16(t.0);
+ assert_eq!(get_base_direction(text.as_slice()), t.1);
+ }
+ }
+
+ #[test]
+ fn test_get_base_direction_full() {
+ let tests = vec![
+ ("", Direction::Mixed), // return Mixed if no strong character found
+ ("123[]-+\u{2019}\u{2060}\u{00bf}?", Direction::Mixed),
+ ("3.14\npi", Direction::Ltr), // direction taken from the second paragraph
+ ("3.14\n\u{05D0}", Direction::Rtl), // direction taken from the second paragraph
+ ("[123 'abc']", Direction::Ltr),
+ ("[123 '\u{0628}' abc", Direction::Rtl),
+ ("[123 '\u{2066}abc\u{2069}'\u{0628}]", Direction::Rtl), // embedded isolate is ignored
+ ("[123 '\u{2066}abc\u{2068}'\u{0628}]", Direction::Mixed),
+ ("[123 '\u{2066}abc\u{2068}'\n\u{0628}]", Direction::Rtl), // \n resets embedding level
+ ];
+
+ for t in tests {
+ assert_eq!(get_base_direction_full(t.0), t.1);
+ let text = &to_utf16(t.0);
+ assert_eq!(get_base_direction_full(text.as_slice()), t.1);
+ }
+ }
+}
+
+#[cfg(all(feature = "serde", feature = "hardcoded-data", test))]
+mod serde_tests {
+ use super::*;
+ use serde_test::{assert_tokens, Token};
+
+ #[test]
+ fn test_levels() {
+ let text = "abc אבג";
+ let bidi_info = BidiInfo::new(text, None);
+ let levels = bidi_info.levels;
+ assert_eq!(text.as_bytes().len(), 10);
+ assert_eq!(levels.len(), 10);
+ assert_tokens(
+ &levels,
+ &[
+ Token::Seq { len: Some(10) },
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(0),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(0),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(0),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(0),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::NewtypeStruct { name: "Level" },
+ Token::U8(1),
+ Token::SeqEnd,
+ ],
+ );
+ }
+}
diff --git a/crates/unicode-bidi/src/prepare.rs b/crates/unicode-bidi/src/prepare.rs
new file mode 100644
index 0000000..9234e1a
--- /dev/null
+++ b/crates/unicode-bidi/src/prepare.rs
@@ -0,0 +1,451 @@
+// Copyright 2015 The Servo Project Developers. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! 3.3.3 Preparations for Implicit Processing
+//!
+//! <http://www.unicode.org/reports/tr9/#Preparations_for_Implicit_Processing>
+
+use alloc::vec::Vec;
+use core::cmp::max;
+use core::ops::Range;
+
+use super::level::Level;
+use super::BidiClass::{self, *};
+
+/// A maximal substring of characters with the same embedding level.
+///
+/// Represented as a range of byte indices.
+pub type LevelRun = Range<usize>;
+
+/// Output of `isolating_run_sequences` (steps X9-X10)
+#[derive(Debug, PartialEq)]
+pub struct IsolatingRunSequence {
+ pub runs: Vec<LevelRun>,
+ pub sos: BidiClass, // Start-of-sequence type.
+ pub eos: BidiClass, // End-of-sequence type.
+}
+
+/// Compute the set of isolating run sequences.
+///
+/// An isolating run sequence is a maximal sequence of level runs such that for all level runs
+/// except the last one in the sequence, the last character of the run is an isolate initiator
+/// whose matching PDI is the first character of the next level run in the sequence.
+///
+/// Note: This function does *not* return the sequences in order by their first characters.
+#[cfg_attr(feature = "flame_it", flamer::flame)]
+pub fn isolating_run_sequences(
+ para_level: Level,
+ original_classes: &[BidiClass],
+ levels: &[Level],
+) -> Vec<IsolatingRunSequence> {
+ let runs = level_runs(levels, original_classes);
+
+ // Compute the set of isolating run sequences.
+ // <http://www.unicode.org/reports/tr9/#BD13>
+ let mut sequences = Vec::with_capacity(runs.len());
+
+ // When we encounter an isolate initiator, we push the current sequence onto the
+ // stack so we can resume it after the matching PDI.
+ let mut stack = vec![Vec::new()];
+
+ for run in runs {
+ assert!(run.len() > 0);
+ assert!(!stack.is_empty());
+
+ let start_class = original_classes[run.start];
+ // > In rule X10, [..] skip over any BNs when [..].
+ // > Do the same when determining if the last character of the sequence is an isolate initiator.
+ //
+ // <https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters>
+ let end_class = original_classes[run.start..run.end]
+ .iter()
+ .copied()
+ .rev()
+ .filter(not_removed_by_x9)
+ .next()
+ .unwrap_or(start_class);
+
+ let mut sequence = if start_class == PDI && stack.len() > 1 {
+ // Continue a previous sequence interrupted by an isolate.
+ stack.pop().unwrap()
+ } else {
+ // Start a new sequence.
+ Vec::new()
+ };
+
+ sequence.push(run);
+
+ if let RLI | LRI | FSI = end_class {
+ // Resume this sequence after the isolate.
+ stack.push(sequence);
+ } else {
+ // This sequence is finished.
+ sequences.push(sequence);
+ }
+ }
+ // Pop any remaning sequences off the stack.
+ sequences.extend(stack.into_iter().rev().filter(|seq| !seq.is_empty()));
+
+ // Determine the `sos` and `eos` class for each sequence.
+ // <http://www.unicode.org/reports/tr9/#X10>
+ sequences
+ .into_iter()
+ .map(|sequence: Vec<LevelRun>| {
+ assert!(!sequence.is_empty());
+
+ let mut result = IsolatingRunSequence {
+ runs: sequence,
+ sos: L,
+ eos: L,
+ };
+
+ let start_of_seq = result.runs[0].start;
+ let runs_len = result.runs.len();
+ let end_of_seq = result.runs[runs_len - 1].end;
+
+ // > (not counting characters removed by X9)
+ let seq_level = result
+ .iter_forwards_from(start_of_seq, 0)
+ .filter(|i| not_removed_by_x9(&original_classes[*i]))
+ .map(|i| levels[i])
+ .next()
+ .unwrap_or(levels[start_of_seq]);
+
+ // XXXManishearth the spec talks of a start and end level,
+ // but for a given IRS the two should be equivalent, yes?
+ let end_level = result
+ .iter_backwards_from(end_of_seq, runs_len - 1)
+ .filter(|i| not_removed_by_x9(&original_classes[*i]))
+ .map(|i| levels[i])
+ .next()
+ .unwrap_or(levels[end_of_seq - 1]);
+
+ #[cfg(test)]
+ for run in result.runs.clone() {
+ for idx in run {
+ if not_removed_by_x9(&original_classes[idx]) {
+ assert_eq!(seq_level, levels[idx]);
+ }
+ }
+ }
+
+ // Get the level of the last non-removed char before the runs.
+ let pred_level = match original_classes[..start_of_seq]
+ .iter()
+ .rposition(not_removed_by_x9)
+ {
+ Some(idx) => levels[idx],
+ None => para_level,
+ };
+
+ // Get the last non-removed character to check if it is an isolate initiator.
+ // The spec calls for an unmatched one, but matched isolate initiators
+ // will never be at the end of a level run (otherwise there would be more to the run).
+ // We unwrap_or(BN) because BN marks removed classes and it won't matter for the check.
+ let last_non_removed = original_classes[..end_of_seq]
+ .iter()
+ .copied()
+ .rev()
+ .find(not_removed_by_x9)
+ .unwrap_or(BN);
+
+ // Get the level of the next non-removed char after the runs.
+ let succ_level = if let RLI | LRI | FSI = last_non_removed {
+ para_level
+ } else {
+ match original_classes[end_of_seq..]
+ .iter()
+ .position(not_removed_by_x9)
+ {
+ Some(idx) => levels[end_of_seq + idx],
+ None => para_level,
+ }
+ };
+
+ result.sos = max(seq_level, pred_level).bidi_class();
+ result.eos = max(end_level, succ_level).bidi_class();
+ result
+ })
+ .collect()
+}
+
+impl IsolatingRunSequence {
+ /// Given a text-relative position `pos` and an index of the level run it is in,
+ /// produce an iterator of all characters after and pos (`pos..`) that are in this
+ /// run sequence
+ pub(crate) fn iter_forwards_from(
+ &self,
+ pos: usize,
+ level_run_index: usize,
+ ) -> impl Iterator<Item = usize> + '_ {
+ let runs = &self.runs[level_run_index..];
+
+ // Check that it is in range
+ // (we can't use contains() since we want an inclusive range)
+ #[cfg(feature = "std")]
+ debug_assert!(runs[0].start <= pos && pos <= runs[0].end);
+
+ (pos..runs[0].end).chain(runs[1..].iter().flat_map(Clone::clone))
+ }
+
+ /// Given a text-relative position `pos` and an index of the level run it is in,
+ /// produce an iterator of all characters before and excludingpos (`..pos`) that are in this
+ /// run sequence
+ pub(crate) fn iter_backwards_from(
+ &self,
+ pos: usize,
+ level_run_index: usize,
+ ) -> impl Iterator<Item = usize> + '_ {
+ let prev_runs = &self.runs[..level_run_index];
+ let current = &self.runs[level_run_index];
+
+ // Check that it is in range
+ // (we can't use contains() since we want an inclusive range)
+ #[cfg(feature = "std")]
+ debug_assert!(current.start <= pos && pos <= current.end);
+
+ (current.start..pos)
+ .rev()
+ .chain(prev_runs.iter().rev().flat_map(Clone::clone))
+ }
+}
+
+/// Finds the level runs in a paragraph.
+///
+/// <http://www.unicode.org/reports/tr9/#BD7>
+fn level_runs(levels: &[Level], original_classes: &[BidiClass]) -> Vec<LevelRun> {
+ assert_eq!(levels.len(), original_classes.len());
+
+ let mut runs = Vec::new();
+ if levels.is_empty() {
+ return runs;
+ }
+
+ let mut current_run_level = levels[0];
+ let mut current_run_start = 0;
+ for i in 1..levels.len() {
+ if !removed_by_x9(original_classes[i]) && levels[i] != current_run_level {
+ // End the last run and start a new one.
+ runs.push(current_run_start..i);
+ current_run_level = levels[i];
+ current_run_start = i;
+ }
+ }
+ runs.push(current_run_start..levels.len());
+
+ runs
+}
+
+/// Should this character be ignored in steps after X9?
+///
+/// <http://www.unicode.org/reports/tr9/#X9>
+pub fn removed_by_x9(class: BidiClass) -> bool {
+ match class {
+ RLE | LRE | RLO | LRO | PDF | BN => true,
+ _ => false,
+ }
+}
+
+// For use as a predicate for `position` / `rposition`
+pub fn not_removed_by_x9(class: &BidiClass) -> bool {
+ !removed_by_x9(*class)
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn test_level_runs() {
+ assert_eq!(level_runs(&Level::vec(&[]), &[]), &[]);
+ assert_eq!(
+ level_runs(&Level::vec(&[0, 0, 0, 1, 1, 2, 0, 0]), &[L; 8]),
+ &[0..3, 3..5, 5..6, 6..8]
+ );
+ }
+
+ // From <http://www.unicode.org/reports/tr9/#BD13>
+ #[rustfmt::skip]
+ #[test]
+ fn test_isolating_run_sequences() {
+
+ // == Example 1 ==
+ // text1·RLE·text2·PDF·RLE·text3·PDF·text4
+ // index 0 1 2 3 4 5 6 7
+ let classes = &[L, RLE, L, PDF, RLE, L, PDF, L];
+ let levels = &[0, 1, 1, 1, 1, 1, 1, 0];
+ let para_level = Level::ltr();
+ let mut sequences = isolating_run_sequences(para_level, classes, &Level::vec(levels));
+ sequences.sort_by(|a, b| a.runs[0].clone().cmp(b.runs[0].clone()));
+ assert_eq!(
+ sequences.iter().map(|s| s.runs.clone()).collect::<Vec<_>>(),
+ vec![vec![0..2], vec![2..7], vec![7..8]]
+ );
+
+ // == Example 2 ==
+ // text1·RLI·text2·PDI·RLI·text3·PDI·text4
+ // index 0 1 2 3 4 5 6 7
+ let classes = &[L, RLI, L, PDI, RLI, L, PDI, L];
+ let levels = &[0, 0, 1, 0, 0, 1, 0, 0];
+ let para_level = Level::ltr();
+ let mut sequences = isolating_run_sequences(para_level, classes, &Level::vec(levels));
+ sequences.sort_by(|a, b| a.runs[0].clone().cmp(b.runs[0].clone()));
+ assert_eq!(
+ sequences.iter().map(|s| s.runs.clone()).collect::<Vec<_>>(),
+ vec![vec![0..2, 3..5, 6..8], vec![2..3], vec![5..6]]
+ );
+
+ // == Example 3 ==
+ // text1·RLI·text2·LRI·text3·RLE·text4·PDF·text5·PDI·text6·PDI·text7
+ // index 0 1 2 3 4 5 6 7 8 9 10 11 12
+ let classes = &[L, RLI, L, LRI, L, RLE, L, PDF, L, PDI, L, PDI, L];
+ let levels = &[0, 0, 1, 1, 2, 3, 3, 3, 2, 1, 1, 0, 0];
+ let para_level = Level::ltr();
+ let mut sequences = isolating_run_sequences(para_level, classes, &Level::vec(levels));
+ sequences.sort_by(|a, b| a.runs[0].clone().cmp(b.runs[0].clone()));
+ assert_eq!(
+ sequences.iter().map(|s| s.runs.clone()).collect::<Vec<_>>(),
+ vec![vec![0..2, 11..13], vec![2..4, 9..11], vec![4..6], vec![6..8], vec![8..9]]
+ );
+ }
+
+ // From <http://www.unicode.org/reports/tr9/#X10>
+ #[rustfmt::skip]
+ #[test]
+ fn test_isolating_run_sequences_sos_and_eos() {
+
+ // == Example 1 ==
+ // text1·RLE·text2·LRE·text3·PDF·text4·PDF·RLE·text5·PDF·text6
+ // index 0 1 2 3 4 5 6 7 8 9 10 11
+ let classes = &[L, RLE, L, LRE, L, PDF, L, PDF, RLE, L, PDF, L];
+ let levels = &[0, 1, 1, 2, 2, 2, 1, 1, 1, 1, 1, 0];
+ let para_level = Level::ltr();
+ let mut sequences = isolating_run_sequences(para_level, classes, &Level::vec(levels));
+ sequences.sort_by(|a, b| a.runs[0].clone().cmp(b.runs[0].clone()));
+
+ // text1
+ assert_eq!(
+ &sequences[0],
+ &IsolatingRunSequence {
+ runs: vec![0..2],
+ sos: L,
+ eos: R,
+ }
+ );
+
+ // text2
+ assert_eq!(
+ &sequences[1],
+ &IsolatingRunSequence {
+ runs: vec![2..4],
+ sos: R,
+ eos: L,
+ }
+ );
+
+ // text3
+ assert_eq!(
+ &sequences[2],
+ &IsolatingRunSequence {
+ runs: vec![4..6],
+ sos: L,
+ eos: L,
+ }
+ );
+
+ // text4 text5
+ assert_eq!(
+ &sequences[3],
+ &IsolatingRunSequence {
+ runs: vec![6..11],
+ sos: L,
+ eos: R,
+ }
+ );
+
+ // text6
+ assert_eq!(
+ &sequences[4],
+ &IsolatingRunSequence {
+ runs: vec![11..12],
+ sos: R,
+ eos: L,
+ }
+ );
+
+ // == Example 2 ==
+ // text1·RLI·text2·LRI·text3·PDI·text4·PDI·RLI·text5·PDI·text6
+ // index 0 1 2 3 4 5 6 7 8 9 10 11
+ let classes = &[L, RLI, L, LRI, L, PDI, L, PDI, RLI, L, PDI, L];
+ let levels = &[0, 0, 1, 1, 2, 1, 1, 0, 0, 1, 0, 0];
+ let para_level = Level::ltr();
+ let mut sequences = isolating_run_sequences(para_level, classes, &Level::vec(levels));
+ sequences.sort_by(|a, b| a.runs[0].clone().cmp(b.runs[0].clone()));
+
+ // text1·RLI·PDI·RLI·PDI·text6
+ assert_eq!(
+ &sequences[0],
+ &IsolatingRunSequence {
+ runs: vec![0..2, 7..9, 10..12],
+ sos: L,
+ eos: L,
+ }
+ );
+
+ // text2·LRI·PDI·text4
+ assert_eq!(
+ &sequences[1],
+ &IsolatingRunSequence {
+ runs: vec![2..4, 5..7],
+ sos: R,
+ eos: R,
+ }
+ );
+
+ // text3
+ assert_eq!(
+ &sequences[2],
+ &IsolatingRunSequence {
+ runs: vec![4..5],
+ sos: L,
+ eos: L,
+ }
+ );
+
+ // text5
+ assert_eq!(
+ &sequences[3],
+ &IsolatingRunSequence {
+ runs: vec![9..10],
+ sos: R,
+ eos: R,
+ }
+ );
+ }
+
+ #[test]
+ fn test_removed_by_x9() {
+ let rem_classes = &[RLE, LRE, RLO, LRO, PDF, BN];
+ let not_classes = &[L, RLI, AL, LRI, PDI];
+ for x in rem_classes {
+ assert_eq!(removed_by_x9(*x), true);
+ }
+ for x in not_classes {
+ assert_eq!(removed_by_x9(*x), false);
+ }
+ }
+
+ #[test]
+ fn test_not_removed_by_x9() {
+ let non_x9_classes = &[L, R, AL, EN, ES, ET, AN, CS, NSM, B, S, WS, ON, LRI, RLI, FSI, PDI];
+ for x in non_x9_classes {
+ assert_eq!(not_removed_by_x9(&x), true);
+ }
+ }
+}
diff --git a/crates/unicode-bidi/src/utf16.rs b/crates/unicode-bidi/src/utf16.rs
new file mode 100644
index 0000000..dcd9baf
--- /dev/null
+++ b/crates/unicode-bidi/src/utf16.rs
@@ -0,0 +1,791 @@
+// Copyright 2023 The Mozilla Foundation. See the
+// COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use super::TextSource;
+
+use alloc::borrow::Cow;
+use alloc::vec::Vec;
+use core::char;
+use core::ops::Range;
+
+use crate::{
+ compute_bidi_info_for_para, compute_initial_info, level, para_direction, reorder_levels,
+ reorder_visual, visual_runs_for_line,
+};
+use crate::{BidiClass, BidiDataSource, Direction, Level, LevelRun, ParagraphInfo};
+
+#[cfg(feature = "hardcoded-data")]
+use crate::HardcodedBidiData;
+
+/// Initial bidi information of the text (UTF-16 version).
+///
+/// Contains the text paragraphs and `BidiClass` of its characters.
+#[derive(PartialEq, Debug)]
+pub struct InitialInfo<'text> {
+ /// The text
+ pub text: &'text [u16],
+
+ /// The BidiClass of the character at each code unit in the text.
+ /// If a character is multiple code units, its class will appear multiple times in the vector.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The boundaries and level of each paragraph within the text.
+ pub paragraphs: Vec<ParagraphInfo>,
+}
+
+impl<'text> InitialInfo<'text> {
+ /// Find the paragraphs and BidiClasses in a string of text.
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ pub fn new(text: &[u16], default_para_level: Option<Level>) -> InitialInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Find the paragraphs and BidiClasses in a string of text, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`InitialInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature)
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a [u16],
+ default_para_level: Option<Level>,
+ ) -> InitialInfo<'a> {
+ InitialInfoExt::new_with_data_source(data_source, text, default_para_level).base
+ }
+}
+
+/// Extended version of InitialInfo (not public API).
+#[derive(PartialEq, Debug)]
+struct InitialInfoExt<'text> {
+ /// The base InitialInfo for the text, recording its paragraphs and bidi classes.
+ base: InitialInfo<'text>,
+
+ /// Parallel to base.paragraphs, records whether each paragraph is "pure LTR" that
+ /// requires no further bidi processing (i.e. there are no RTL characters or bidi
+ /// control codes present).
+ pure_ltr: Vec<bool>,
+}
+
+impl<'text> InitialInfoExt<'text> {
+ /// Find the paragraphs and BidiClasses in a string of text, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`InitialInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature)
+ ///
+ /// <http://www.unicode.org/reports/tr9/#The_Paragraph_Level>
+ ///
+ /// Also sets the class for each First Strong Isolate initiator (FSI) to LRI or RLI if a strong
+ /// character is found before the matching PDI. If no strong character is found, the class will
+ /// remain FSI, and it's up to later stages to treat these as LRI when needed.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a [u16],
+ default_para_level: Option<Level>,
+ ) -> InitialInfoExt<'a> {
+ let mut paragraphs = Vec::<ParagraphInfo>::new();
+ let mut pure_ltr = Vec::<bool>::new();
+ let (original_classes, _, _) = compute_initial_info(
+ data_source,
+ text,
+ default_para_level,
+ Some((&mut paragraphs, &mut pure_ltr)),
+ );
+
+ InitialInfoExt {
+ base: InitialInfo {
+ text,
+ original_classes,
+ paragraphs,
+ },
+ pure_ltr,
+ }
+ }
+}
+
+/// Bidi information of the text (UTF-16 version).
+///
+/// The `original_classes` and `levels` vectors are indexed by code unit offsets into the text. If a
+/// character is multiple code units wide, then its class and level will appear multiple times in these
+/// vectors.
+// TODO: Impl `struct StringProperty<T> { values: Vec<T> }` and use instead of Vec<T>
+#[derive(Debug, PartialEq)]
+pub struct BidiInfo<'text> {
+ /// The text
+ pub text: &'text [u16],
+
+ /// The BidiClass of the character at each byte in the text.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The directional embedding level of each byte in the text.
+ pub levels: Vec<Level>,
+
+ /// The boundaries and paragraph embedding level of each paragraph within the text.
+ ///
+ /// TODO: Use SmallVec or similar to avoid overhead when there are only one or two paragraphs?
+ /// Or just don't include the first paragraph, which always starts at 0?
+ pub paragraphs: Vec<ParagraphInfo>,
+}
+
+impl<'text> BidiInfo<'text> {
+ /// Split the text into paragraphs and determine the bidi embedding levels for each paragraph.
+ ///
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ #[inline]
+ pub fn new(text: &[u16], default_para_level: Option<Level>) -> BidiInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Split the text into paragraphs and determine the bidi embedding levels for each paragraph, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`BidiInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature).
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a [u16],
+ default_para_level: Option<Level>,
+ ) -> BidiInfo<'a> {
+ let InitialInfoExt { base, pure_ltr, .. } =
+ InitialInfoExt::new_with_data_source(data_source, text, default_para_level);
+
+ let mut levels = Vec::<Level>::with_capacity(text.len());
+ let mut processing_classes = base.original_classes.clone();
+
+ for (para, is_pure_ltr) in base.paragraphs.iter().zip(pure_ltr.iter()) {
+ let text = &text[para.range.clone()];
+ let original_classes = &base.original_classes[para.range.clone()];
+
+ compute_bidi_info_for_para(
+ data_source,
+ para,
+ *is_pure_ltr,
+ text,
+ original_classes,
+ &mut processing_classes,
+ &mut levels,
+ );
+ }
+
+ BidiInfo {
+ text,
+ original_classes: base.original_classes,
+ paragraphs: base.paragraphs,
+ levels,
+ }
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *byte*
+ /// in the paragraph. The returned vector includes bytes that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// This runs [Rule L1], you can run
+ /// [Rule L2] by calling [`Self::reorder_visual()`].
+ /// If doing so, you may prefer to use [`Self::reordered_levels_per_char()`] instead
+ /// to avoid non-byte indices.
+ ///
+ /// For an all-in-one reordering solution, consider using [`Self::reorder_visual()`].
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels(&self, para: &ParagraphInfo, line: Range<usize>) -> Vec<Level> {
+ assert!(line.start <= self.levels.len());
+ assert!(line.end <= self.levels.len());
+
+ let mut levels = self.levels.clone();
+ let line_classes = &self.original_classes[line.clone()];
+ let line_levels = &mut levels[line.clone()];
+ let line_str: &[u16] = &self.text[line.clone()];
+
+ reorder_levels(line_classes, line_levels, line_str, para.level);
+
+ levels
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *character*
+ /// in the paragraph. The returned vector includes characters that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// This runs [Rule L1], you can run
+ /// [Rule L2] by calling [`Self::reorder_visual()`].
+ /// If doing so, you may prefer to use [`Self::reordered_levels_per_char()`] instead
+ /// to avoid non-byte indices.
+ ///
+ /// For an all-in-one reordering solution, consider using [`Self::reorder_visual()`].
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels_per_char(
+ &self,
+ para: &ParagraphInfo,
+ line: Range<usize>,
+ ) -> Vec<Level> {
+ let levels = self.reordered_levels(para, line);
+ self.text.char_indices().map(|(i, _)| levels[i]).collect()
+ }
+
+ /// Re-order a line based on resolved levels and return the line in display order.
+ ///
+ /// This does not apply [Rule L3] or [Rule L4] around combining characters or mirroring.
+ ///
+ /// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+ /// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reorder_line(&self, para: &ParagraphInfo, line: Range<usize>) -> Cow<'text, [u16]> {
+ if !level::has_rtl(&self.levels[line.clone()]) {
+ return self.text[line].into();
+ }
+ let (levels, runs) = self.visual_runs(para, line.clone());
+ reorder_line(self.text, line, levels, runs)
+ }
+
+ /// Reorders pre-calculated levels of a sequence of characters.
+ ///
+ /// NOTE: This is a convenience method that does not use a `Paragraph` object. It is
+ /// intended to be used when an application has determined the levels of the objects (character sequences)
+ /// and just needs to have them reordered.
+ ///
+ /// the index map will result in `indexMap[visualIndex]==logicalIndex`.
+ ///
+ /// This only runs [Rule L2](http://www.unicode.org/reports/tr9/#L2) as it does not have
+ /// information about the actual text.
+ ///
+ /// Furthermore, if `levels` is an array that is aligned with code units, bytes within a codepoint may be
+ /// reversed. You may need to fix up the map to deal with this. Alternatively, only pass in arrays where each `Level`
+ /// is for a single code point.
+ ///
+ ///
+ /// # # Example
+ /// ```
+ /// use unicode_bidi::BidiInfo;
+ /// use unicode_bidi::Level;
+ ///
+ /// let l0 = Level::from(0);
+ /// let l1 = Level::from(1);
+ /// let l2 = Level::from(2);
+ ///
+ /// let levels = vec![l0, l0, l0, l0];
+ /// let index_map = BidiInfo::reorder_visual(&levels);
+ /// assert_eq!(levels.len(), index_map.len());
+ /// assert_eq!(index_map, [0, 1, 2, 3]);
+ ///
+ /// let levels: Vec<Level> = vec![l0, l0, l0, l1, l1, l1, l2, l2];
+ /// let index_map = BidiInfo::reorder_visual(&levels);
+ /// assert_eq!(levels.len(), index_map.len());
+ /// assert_eq!(index_map, [0, 1, 2, 6, 7, 5, 4, 3]);
+ /// ```
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn reorder_visual(levels: &[Level]) -> Vec<usize> {
+ reorder_visual(levels)
+ }
+
+ /// Find the level runs within a line and return them in visual order.
+ ///
+ /// `line` is a range of bytes indices within `levels`.
+ ///
+ /// The first return value is a vector of levels used by the reordering algorithm,
+ /// i.e. the result of [Rule L1]. The second return value is a vector of level runs,
+ /// the result of [Rule L2], showing the visual order that each level run (a run of text with the
+ /// same level) should be displayed. Within each run, the display order can be checked
+ /// against the Level vector.
+ ///
+ /// This does not handle [Rule L3] (combining characters) or [Rule L4] (mirroring),
+ /// as that should be handled by the engine using this API.
+ ///
+ /// Conceptually, this is the same as running [`Self::reordered_levels()`] followed by
+ /// [`Self::reorder_visual()`], however it returns the result as a list of level runs instead
+ /// of producing a level map, since one may wish to deal with the fact that this is operating on
+ /// byte rather than character indices.
+ ///
+ /// <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
+ ///
+ /// [Rule L1]: https://www.unicode.org/reports/tr9/#L1
+ /// [Rule L2]: https://www.unicode.org/reports/tr9/#L2
+ /// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+ /// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn visual_runs(
+ &self,
+ para: &ParagraphInfo,
+ line: Range<usize>,
+ ) -> (Vec<Level>, Vec<LevelRun>) {
+ let levels = self.reordered_levels(para, line.clone());
+ visual_runs_for_line(levels, &line)
+ }
+
+ /// If processed text has any computed RTL levels
+ ///
+ /// This information is usually used to skip re-ordering of text when no RTL level is present
+ #[inline]
+ pub fn has_rtl(&self) -> bool {
+ level::has_rtl(&self.levels)
+ }
+}
+
+/// Bidi information of text treated as a single paragraph.
+///
+/// The `original_classes` and `levels` vectors are indexed by code unit offsets into the text. If a
+/// character is multiple code units wide, then its class and level will appear multiple times in these
+/// vectors.
+#[derive(Debug, PartialEq)]
+pub struct ParagraphBidiInfo<'text> {
+ /// The text
+ pub text: &'text [u16],
+
+ /// The BidiClass of the character at each byte in the text.
+ pub original_classes: Vec<BidiClass>,
+
+ /// The directional embedding level of each byte in the text.
+ pub levels: Vec<Level>,
+
+ /// The paragraph embedding level.
+ pub paragraph_level: Level,
+
+ /// Whether the paragraph is purely LTR.
+ pub is_pure_ltr: bool,
+}
+
+impl<'text> ParagraphBidiInfo<'text> {
+ /// Determine the bidi embedding level.
+ ///
+ ///
+ /// The `hardcoded-data` Cargo feature (enabled by default) must be enabled to use this.
+ ///
+ /// TODO: In early steps, check for special cases that allow later steps to be skipped. like
+ /// text that is entirely LTR. See the `nsBidi` class from Gecko for comparison.
+ ///
+ /// TODO: Support auto-RTL base direction
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[cfg(feature = "hardcoded-data")]
+ #[inline]
+ pub fn new(text: &[u16], default_para_level: Option<Level>) -> ParagraphBidiInfo<'_> {
+ Self::new_with_data_source(&HardcodedBidiData, text, default_para_level)
+ }
+
+ /// Determine the bidi embedding level, with a custom [`BidiDataSource`]
+ /// for Bidi data. If you just wish to use the hardcoded Bidi data, please use [`BidiInfo::new()`]
+ /// instead (enabled with tbe default `hardcoded-data` Cargo feature).
+ ///
+ /// (This is the single-paragraph equivalent of BidiInfo::new_with_data_source,
+ /// and should be kept in sync with it.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn new_with_data_source<'a, D: BidiDataSource>(
+ data_source: &D,
+ text: &'a [u16],
+ default_para_level: Option<Level>,
+ ) -> ParagraphBidiInfo<'a> {
+ // Here we could create a ParagraphInitialInfo struct to parallel the one
+ // used by BidiInfo, but there doesn't seem any compelling reason for it.
+ let (original_classes, paragraph_level, is_pure_ltr) =
+ compute_initial_info(data_source, text, default_para_level, None);
+
+ let mut levels = Vec::<Level>::with_capacity(text.len());
+ let mut processing_classes = original_classes.clone();
+
+ let para_info = ParagraphInfo {
+ range: Range {
+ start: 0,
+ end: text.len(),
+ },
+ level: paragraph_level,
+ };
+
+ compute_bidi_info_for_para(
+ data_source,
+ ¶_info,
+ is_pure_ltr,
+ text,
+ &original_classes,
+ &mut processing_classes,
+ &mut levels,
+ );
+
+ ParagraphBidiInfo {
+ text,
+ original_classes,
+ levels,
+ paragraph_level,
+ is_pure_ltr,
+ }
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *code unit*
+ /// in the paragraph. The returned vector includes code units that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// See BidiInfo::reordered_levels for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reordered_levels.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels(&self, line: Range<usize>) -> Vec<Level> {
+ assert!(line.start <= self.levels.len());
+ assert!(line.end <= self.levels.len());
+
+ let mut levels = self.levels.clone();
+ let line_classes = &self.original_classes[line.clone()];
+ let line_levels = &mut levels[line.clone()];
+
+ reorder_levels(
+ line_classes,
+ line_levels,
+ self.text.subrange(line),
+ self.paragraph_level,
+ );
+
+ levels
+ }
+
+ /// Produce the levels for this paragraph as needed for reordering, one level per *character*
+ /// in the paragraph. The returned vector includes characters that are not included
+ /// in the `line`, but will not adjust them.
+ ///
+ /// See BidiInfo::reordered_levels_per_char for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reordered_levels_per_char.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reordered_levels_per_char(&self, line: Range<usize>) -> Vec<Level> {
+ let levels = self.reordered_levels(line);
+ self.text.char_indices().map(|(i, _)| levels[i]).collect()
+ }
+
+ /// Re-order a line based on resolved levels and return the line in display order.
+ ///
+ /// See BidiInfo::reorder_line for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::reorder_line.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ pub fn reorder_line(&self, line: Range<usize>) -> Cow<'text, [u16]> {
+ if !level::has_rtl(&self.levels[line.clone()]) {
+ return self.text[line].into();
+ }
+ let (levels, runs) = self.visual_runs(line.clone());
+ reorder_line(self.text, line, levels, runs)
+ }
+
+ /// Reorders pre-calculated levels of a sequence of characters.
+ ///
+ /// See BidiInfo::reorder_visual for details.
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn reorder_visual(levels: &[Level]) -> Vec<usize> {
+ reorder_visual(levels)
+ }
+
+ /// Find the level runs within a line and return them in visual order.
+ ///
+ /// `line` is a range of code-unit indices within `levels`.
+ ///
+ /// See `BidiInfo::visual_runs` for details.
+ ///
+ /// (This should be kept in sync with BidiInfo::visual_runs.)
+ #[cfg_attr(feature = "flame_it", flamer::flame)]
+ #[inline]
+ pub fn visual_runs(&self, line: Range<usize>) -> (Vec<Level>, Vec<LevelRun>) {
+ let levels = self.reordered_levels(line.clone());
+ visual_runs_for_line(levels, &line)
+ }
+
+ /// If processed text has any computed RTL levels
+ ///
+ /// This information is usually used to skip re-ordering of text when no RTL level is present
+ #[inline]
+ pub fn has_rtl(&self) -> bool {
+ !self.is_pure_ltr
+ }
+
+ /// Return the paragraph's Direction (Ltr, Rtl, or Mixed) based on its levels.
+ #[inline]
+ pub fn direction(&self) -> Direction {
+ para_direction(&self.levels)
+ }
+}
+
+/// Return a line of the text in display order based on resolved levels.
+///
+/// `text` the full text passed to the `BidiInfo` or `ParagraphBidiInfo` for analysis
+/// `line` a range of byte indices within `text` corresponding to one line
+/// `levels` array of `Level` values, with `line`'s levels reordered into visual order
+/// `runs` array of `LevelRun`s in visual order
+///
+/// (`levels` and `runs` are the result of calling `BidiInfo::visual_runs()` or
+/// `ParagraphBidiInfo::visual_runs()` for the line of interest.)
+///
+/// Returns: the reordered text of the line.
+///
+/// This does not apply [Rule L3] or [Rule L4] around combining characters or mirroring.
+///
+/// [Rule L3]: https://www.unicode.org/reports/tr9/#L3
+/// [Rule L4]: https://www.unicode.org/reports/tr9/#L4
+fn reorder_line<'text>(
+ text: &'text [u16],
+ line: Range<usize>,
+ levels: Vec<Level>,
+ runs: Vec<LevelRun>,
+) -> Cow<'text, [u16]> {
+ // If all isolating run sequences are LTR, no reordering is needed
+ if runs.iter().all(|run| levels[run.start].is_ltr()) {
+ return text[line].into();
+ }
+
+ let mut result = Vec::<u16>::with_capacity(line.len());
+ for run in runs {
+ if levels[run.start].is_rtl() {
+ let mut buf = [0; 2];
+ for c in text[run].chars().rev() {
+ result.extend(c.encode_utf16(&mut buf).iter());
+ }
+ } else {
+ result.extend(text[run].iter());
+ }
+ }
+ result.into()
+}
+
+/// Contains a reference of `BidiInfo` and one of its `paragraphs`.
+/// And it supports all operation in the `Paragraph` that needs also its
+/// `BidiInfo` such as `direction`.
+#[derive(Debug)]
+pub struct Paragraph<'a, 'text> {
+ pub info: &'a BidiInfo<'text>,
+ pub para: &'a ParagraphInfo,
+}
+
+impl<'a, 'text> Paragraph<'a, 'text> {
+ #[inline]
+ pub fn new(info: &'a BidiInfo<'text>, para: &'a ParagraphInfo) -> Paragraph<'a, 'text> {
+ Paragraph { info, para }
+ }
+
+ /// Returns if the paragraph is Left direction, right direction or mixed.
+ #[inline]
+ pub fn direction(&self) -> Direction {
+ para_direction(&self.info.levels[self.para.range.clone()])
+ }
+
+ /// Returns the `Level` of a certain character in the paragraph.
+ #[inline]
+ pub fn level_at(&self, pos: usize) -> Level {
+ let actual_position = self.para.range.start + pos;
+ self.info.levels[actual_position]
+ }
+}
+
+/// Implementation of TextSource for UTF-16 text in a [u16] array.
+/// Note that there could be unpaired surrogates present!
+
+// Convenience functions to check whether a UTF16 code unit is a surrogate.
+#[inline]
+fn is_high_surrogate(code: u16) -> bool {
+ (code & 0xFC00) == 0xD800
+}
+#[inline]
+fn is_low_surrogate(code: u16) -> bool {
+ (code & 0xFC00) == 0xDC00
+}
+
+impl<'text> TextSource<'text> for [u16] {
+ type CharIter = Utf16CharIter<'text>;
+ type CharIndexIter = Utf16CharIndexIter<'text>;
+ type IndexLenIter = Utf16IndexLenIter<'text>;
+
+ #[inline]
+ fn len(&self) -> usize {
+ (self as &[u16]).len()
+ }
+ fn char_at(&self, index: usize) -> Option<(char, usize)> {
+ if index >= self.len() {
+ return None;
+ }
+ // Get the indicated code unit and try simply converting it to a char;
+ // this will fail if it is half of a surrogate pair.
+ let c = self[index];
+ if let Some(ch) = char::from_u32(c.into()) {
+ return Some((ch, 1));
+ }
+ // If it's a low surrogate, and was immediately preceded by a high surrogate,
+ // then we're in the middle of a (valid) character, and should return None.
+ if is_low_surrogate(c) && index > 0 && is_high_surrogate(self[index - 1]) {
+ return None;
+ }
+ // Otherwise, try to decode, returning REPLACEMENT_CHARACTER for errors.
+ if let Some(ch) = char::decode_utf16(self[index..].iter().cloned()).next() {
+ if let Ok(ch) = ch {
+ // This must be a surrogate pair, otherwise char::from_u32() above should
+ // have succeeded!
+ debug_assert!(ch.len_utf16() == 2, "BMP should have already been handled");
+ return Some((ch, ch.len_utf16()));
+ }
+ } else {
+ debug_assert!(
+ false,
+ "Why did decode_utf16 return None when we're not at the end?"
+ );
+ return None;
+ }
+ // Failed to decode UTF-16: we must have encountered an unpaired surrogate.
+ // Return REPLACEMENT_CHARACTER (not None), to continue processing the following text
+ // and keep indexing correct.
+ Some((char::REPLACEMENT_CHARACTER, 1))
+ }
+ #[inline]
+ fn subrange(&self, range: Range<usize>) -> &Self {
+ &(self as &[u16])[range]
+ }
+ #[inline]
+ fn chars(&'text self) -> Self::CharIter {
+ Utf16CharIter::new(&self)
+ }
+ #[inline]
+ fn char_indices(&'text self) -> Self::CharIndexIter {
+ Utf16CharIndexIter::new(&self)
+ }
+ #[inline]
+ fn indices_lengths(&'text self) -> Self::IndexLenIter {
+ Utf16IndexLenIter::new(&self)
+ }
+ #[inline]
+ fn char_len(ch: char) -> usize {
+ ch.len_utf16()
+ }
+}
+
+/// Iterator over UTF-16 text in a [u16] slice, returning (index, char_len) tuple.
+#[derive(Debug)]
+pub struct Utf16IndexLenIter<'text> {
+ text: &'text [u16],
+ cur_pos: usize,
+}
+
+impl<'text> Utf16IndexLenIter<'text> {
+ #[inline]
+ pub fn new(text: &'text [u16]) -> Self {
+ Utf16IndexLenIter { text, cur_pos: 0 }
+ }
+}
+
+impl Iterator for Utf16IndexLenIter<'_> {
+ type Item = (usize, usize);
+
+ #[inline]
+ fn next(&mut self) -> Option<Self::Item> {
+ if let Some((_, char_len)) = self.text.char_at(self.cur_pos) {
+ let result = (self.cur_pos, char_len);
+ self.cur_pos += char_len;
+ return Some(result);
+ }
+ None
+ }
+}
+
+/// Iterator over UTF-16 text in a [u16] slice, returning (index, char) tuple.
+#[derive(Debug)]
+pub struct Utf16CharIndexIter<'text> {
+ text: &'text [u16],
+ cur_pos: usize,
+}
+
+impl<'text> Utf16CharIndexIter<'text> {
+ pub fn new(text: &'text [u16]) -> Self {
+ Utf16CharIndexIter { text, cur_pos: 0 }
+ }
+}
+
+impl Iterator for Utf16CharIndexIter<'_> {
+ type Item = (usize, char);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ if let Some((ch, char_len)) = self.text.char_at(self.cur_pos) {
+ let result = (self.cur_pos, ch);
+ self.cur_pos += char_len;
+ return Some(result);
+ }
+ None
+ }
+}
+
+/// Iterator over UTF-16 text in a [u16] slice, returning Unicode chars.
+/// (Unlike the other iterators above, this also supports reverse iteration.)
+#[derive(Debug)]
+pub struct Utf16CharIter<'text> {
+ text: &'text [u16],
+ cur_pos: usize,
+ end_pos: usize,
+}
+
+impl<'text> Utf16CharIter<'text> {
+ pub fn new(text: &'text [u16]) -> Self {
+ Utf16CharIter {
+ text,
+ cur_pos: 0,
+ end_pos: text.len(),
+ }
+ }
+}
+
+impl Iterator for Utf16CharIter<'_> {
+ type Item = char;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ if let Some((ch, char_len)) = self.text.char_at(self.cur_pos) {
+ self.cur_pos += char_len;
+ return Some(ch);
+ }
+ None
+ }
+}
+
+impl DoubleEndedIterator for Utf16CharIter<'_> {
+ fn next_back(&mut self) -> Option<Self::Item> {
+ if self.end_pos <= self.cur_pos {
+ return None;
+ }
+ self.end_pos -= 1;
+ if let Some(ch) = char::from_u32(self.text[self.end_pos] as u32) {
+ return Some(ch);
+ }
+ if self.end_pos > self.cur_pos {
+ if let Some((ch, char_len)) = self.text.char_at(self.end_pos - 1) {
+ if char_len == 2 {
+ self.end_pos -= 1;
+ return Some(ch);
+ }
+ }
+ }
+ Some(char::REPLACEMENT_CHARACTER)
+ }
+}
diff --git a/crates/unicode-normalization/.cargo-checksum.json b/crates/unicode-normalization/.cargo-checksum.json
new file mode 100644
index 0000000..7d29693
--- /dev/null
+++ b/crates/unicode-normalization/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"COPYRIGHT":"23860c2a7b5d96b21569afedf033469bab9fe14a1b24a35068b8641c578ce24d","Cargo.toml":"d43bfc158330a3a780af52ff0e82d88c8b54707ddf0469e6e27749c8ded4d1b7","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"7b63ecd5f1902af1b63729947373683c32745c16a10e8e6292e2e2dcd7e90ae0","README.md":"60162364e07490163f7a8e199c7a0a8ace165ae5aa7e4b6f16ff1617ddef5867","benches/bench.rs":"827e5343b059a732904be29717c2797203bfd0a633edf08042afea65372a3e2c","scripts/unicode.py":"6b1d9025fa9970c23b9721c6704aa085263408d645cf9c469295978010fd7504","src/__test_api.rs":"78e21bfa0b98894f545c8ed3e31cec20d7a48951a7f3ed69a6130c4b3d463aee","src/decompose.rs":"c0eb774843a545356e63bbcd7fb926f80d3c97ef4601ca3701fc34154f2e9905","src/lib.rs":"1983769ea083caa36b0736c87cf2a98e91c2b900f1d5dec64e327360fa862386","src/lookups.rs":"962f9909b32e02b8a2a05836135d9cd39bb1ce01f7c659de99cbd8a3a3c78574","src/no_std_prelude.rs":"602e81e67b8952b6571826f431e3b6787be3073bc10f38a0d3374278f81a6a1f","src/normalize.rs":"de2670b4437d335d42884af844a750f70e541467ecd34077dfe032103cb9b041","src/perfect_hash.rs":"400c84e2f467f61bd55d55d08672da6a9ad7a57c938ce5d0c701a6994b1b273b","src/quick_check.rs":"9756312d75fc31b67fca954e44a4812945a7e436b03ba18b9a2441f6de570f6f","src/recompose.rs":"a6228ad7561a5c7a1ef1d510159bdde1eea8a161007c80e470432e9b844d5536","src/replace.rs":"b24c904f3e00851a78820e30ddfa4ff10c795f8925fd0ee7f5870f31fdfa770b","src/stream_safe.rs":"383d71f0da401af8e735877e43855c7e16cb06deb2263539cdec2a407dbe257d","src/tables.rs":"3d9983a4e24c5b1e5dc272a025cdc729b7107f9a52a1fc89eca598e69af36c3a","src/test.rs":"3af8ad8c6bd2cc1ca44660bd265ad813c88d3074b448df4d9ff376b25fb77d26"},"package":"5c5713f0fc4b5db668a2ac63cdb7bb4469d8c9fed047b1d0292cc7b0ce2ba921"}
\ No newline at end of file
diff --git a/crates/unicode-normalization/Android.bp b/crates/unicode-normalization/Android.bp
new file mode 100644
index 0000000..b2a1ee8
--- /dev/null
+++ b/crates/unicode-normalization/Android.bp
@@ -0,0 +1,56 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_unicode-normalization_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_unicode-normalization_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libunicode_normalization",
+ host_supported: true,
+ crate_name: "unicode_normalization",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.22",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "default",
+ "std",
+ ],
+ rustlibs: ["libtinyvec"],
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.resolv",
+ ],
+ product_available: true,
+ vendor_available: true,
+ min_sdk_version: "29",
+}
+
+rust_test {
+ name: "unicode-normalization_test_src_lib",
+ host_supported: true,
+ crate_name: "unicode_normalization",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.22",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "default",
+ "std",
+ ],
+ rustlibs: ["libtinyvec"],
+}
diff --git a/crates/unicode-normalization/COPYRIGHT b/crates/unicode-normalization/COPYRIGHT
new file mode 100644
index 0000000..b286ec1
--- /dev/null
+++ b/crates/unicode-normalization/COPYRIGHT
@@ -0,0 +1,7 @@
+Licensed under the Apache License, Version 2.0
+<LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT
+license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+at your option. All files in the project carrying such
+notice may not be copied, modified, or distributed except
+according to those terms.
diff --git a/crates/unicode-normalization/Cargo.toml b/crates/unicode-normalization/Cargo.toml
new file mode 100644
index 0000000..1c4d1f5
--- /dev/null
+++ b/crates/unicode-normalization/Cargo.toml
@@ -0,0 +1,52 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "unicode-normalization"
+version = "0.1.22"
+authors = [
+ "kwantam <[email protected]>",
+ "Manish Goregaokar <[email protected]>",
+]
+exclude = [
+ "target/*",
+ "Cargo.lock",
+ "scripts/tmp",
+ "*.txt",
+ "tests/*",
+]
+description = """
+This crate provides functions for normalization of
+Unicode strings, including Canonical and Compatible
+Decomposition and Recomposition, as described in
+Unicode Standard Annex #15.
+"""
+homepage = "https://github.com/unicode-rs/unicode-normalization"
+documentation = "https://docs.rs/unicode-normalization/"
+readme = "README.md"
+keywords = [
+ "text",
+ "unicode",
+ "normalization",
+ "decomposition",
+ "recomposition",
+]
+license = "MIT/Apache-2.0"
+repository = "https://github.com/unicode-rs/unicode-normalization"
+
+[dependencies.tinyvec]
+version = "1"
+features = ["alloc"]
+
+[features]
+default = ["std"]
+std = []
diff --git a/crates/unicode-normalization/LICENSE b/crates/unicode-normalization/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/unicode-normalization/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/unicode-normalization/LICENSE-APACHE b/crates/unicode-normalization/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/unicode-normalization/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/unicode-normalization/LICENSE-MIT b/crates/unicode-normalization/LICENSE-MIT
new file mode 100644
index 0000000..e69282e
--- /dev/null
+++ b/crates/unicode-normalization/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2015 The Rust Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/unicode-normalization/METADATA b/crates/unicode-normalization/METADATA
new file mode 100644
index 0000000..96591fb
--- /dev/null
+++ b/crates/unicode-normalization/METADATA
@@ -0,0 +1,23 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/unicode-normalization
+# For more info, check https://cs.android.com/android/platform/superproject/+/master:tools/external_updater/README.md
+
+name: "unicode-normalization"
+description: "This crate provides functions for normalization of Unicode strings, including Canonical and Compatible Decomposition and Recomposition, as described in Unicode Standard Annex #15."
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/unicode-normalization"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/unicode-normalization/unicode-normalization-0.1.22.crate"
+ }
+ version: "0.1.22"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2022
+ month: 12
+ day: 19
+ }
+}
diff --git a/crates/unicode-normalization/MODULE_LICENSE_APACHE2 b/crates/unicode-normalization/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/unicode-normalization/MODULE_LICENSE_APACHE2
diff --git a/crates/unicode-normalization/README.md b/crates/unicode-normalization/README.md
new file mode 100644
index 0000000..35030e3
--- /dev/null
+++ b/crates/unicode-normalization/README.md
@@ -0,0 +1,39 @@
+# unicode-normalization
+
+[](https://travis-ci.org/unicode-rs/unicode-normalization)
+[](https://docs.rs/unicode-normalization/)
+
+Unicode character composition and decomposition utilities
+as described in
+[Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).
+
+This crate requires Rust 1.36+.
+
+```rust
+extern crate unicode_normalization;
+
+use unicode_normalization::char::compose;
+use unicode_normalization::UnicodeNormalization;
+
+fn main() {
+ assert_eq!(compose('A','\u{30a}'), Some('Å'));
+
+ let s = "ÅΩ";
+ let c = s.nfc().collect::<String>();
+ assert_eq!(c, "ÅΩ");
+}
+```
+
+## crates.io
+
+You can use this package in your project by adding the following
+to your `Cargo.toml`:
+
+```toml
+[dependencies]
+unicode-normalization = "0.1.22"
+```
+
+## `no_std` + `alloc` support
+
+This crate is completely `no_std` + `alloc` compatible. This can be enabled by disabling the `std` feature, i.e. specifying `default-features = false` for this crate on your `Cargo.toml`.
diff --git a/crates/unicode-normalization/TEST_MAPPING b/crates/unicode-normalization/TEST_MAPPING
new file mode 100644
index 0000000..b37ddc0
--- /dev/null
+++ b/crates/unicode-normalization/TEST_MAPPING
@@ -0,0 +1,24 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "external/rust/crates/quiche"
+ },
+ {
+ "path": "external/rust/crates/url"
+ },
+ {
+ "path": "packages/modules/DnsResolver"
+ }
+ ],
+ "presubmit": [
+ {
+ "name": "unicode-normalization_test_src_lib"
+ }
+ ],
+ "presubmit-rust": [
+ {
+ "name": "unicode-normalization_test_src_lib"
+ }
+ ]
+}
diff --git a/crates/unicode-normalization/benches/bench.rs b/crates/unicode-normalization/benches/bench.rs
new file mode 100644
index 0000000..a977156
--- /dev/null
+++ b/crates/unicode-normalization/benches/bench.rs
@@ -0,0 +1,127 @@
+#![feature(test)]
+
+extern crate test;
+extern crate unicode_normalization;
+
+use std::fs;
+use test::Bencher;
+use unicode_normalization::UnicodeNormalization;
+
+const ASCII: &'static str = "all types of normalized";
+const NFC: &'static str = "Introducci\u{00f3}n a Unicode.pdf";
+const NFD: &'static str = "Introduccio\u{0301}n a Unicode.pdf";
+
+#[bench]
+fn bench_is_nfc_ascii(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc(ASCII));
+}
+
+#[bench]
+fn bench_is_nfc_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc(NFC));
+}
+
+#[bench]
+fn bench_is_nfc_not_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc(NFD));
+}
+
+#[bench]
+fn bench_is_nfd_ascii(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd(ASCII));
+}
+
+#[bench]
+fn bench_is_nfd_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd(NFD));
+}
+
+#[bench]
+fn bench_is_nfd_not_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd(NFC));
+}
+
+#[bench]
+fn bench_is_nfc_stream_safe_ascii(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc_stream_safe(ASCII));
+}
+
+#[bench]
+fn bench_is_nfc_stream_safe_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc_stream_safe(NFC));
+}
+
+#[bench]
+fn bench_is_nfc_stream_safe_not_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfc_stream_safe(NFD));
+}
+
+#[bench]
+fn bench_is_nfd_stream_safe_ascii(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd_stream_safe(ASCII));
+}
+
+#[bench]
+fn bench_is_nfd_stream_safe_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd_stream_safe(NFD));
+}
+
+#[bench]
+fn bench_is_nfd_stream_safe_not_normalized(b: &mut Bencher) {
+ b.iter(|| unicode_normalization::is_nfd_stream_safe(NFC));
+}
+
+#[bench]
+fn bench_nfc_ascii(b: &mut Bencher) {
+ b.iter(|| ASCII.nfc().count());
+}
+
+#[bench]
+fn bench_nfd_ascii(b: &mut Bencher) {
+ b.iter(|| ASCII.nfd().count());
+}
+
+#[bench]
+fn bench_nfc_long(b: &mut Bencher) {
+ let long = fs::read_to_string("benches/long.txt").unwrap();
+ b.iter(|| long.nfc().count());
+}
+
+#[bench]
+fn bench_nfd_long(b: &mut Bencher) {
+ let long = fs::read_to_string("benches/long.txt").unwrap();
+ b.iter(|| long.nfd().count());
+}
+
+#[bench]
+fn bench_nfkc_ascii(b: &mut Bencher) {
+ b.iter(|| ASCII.nfkc().count());
+}
+
+#[bench]
+fn bench_nfkd_ascii(b: &mut Bencher) {
+ b.iter(|| ASCII.nfkd().count());
+}
+
+#[bench]
+fn bench_nfkc_long(b: &mut Bencher) {
+ let long = fs::read_to_string("benches/long.txt").unwrap();
+ b.iter(|| long.nfkc().count());
+}
+
+#[bench]
+fn bench_nfkd_long(b: &mut Bencher) {
+ let long = fs::read_to_string("benches/long.txt").unwrap();
+ b.iter(|| long.nfkd().count());
+}
+
+#[bench]
+fn bench_streamsafe_ascii(b: &mut Bencher) {
+ b.iter(|| ASCII.stream_safe().count());
+}
+
+#[bench]
+fn bench_streamsafe_adversarial(b: &mut Bencher) {
+ let s = "bo\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{032e}oom";
+ b.iter(|| s.stream_safe().count());
+}
diff --git a/crates/unicode-normalization/cargo_embargo.json b/crates/unicode-normalization/cargo_embargo.json
new file mode 100644
index 0000000..b8ed541
--- /dev/null
+++ b/crates/unicode-normalization/cargo_embargo.json
@@ -0,0 +1,9 @@
+{
+ "apex_available": [
+ "//apex_available:platform",
+ "com.android.resolv"
+ ],
+ "min_sdk_version": "29",
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/unicode-normalization/scripts/unicode.py b/crates/unicode-normalization/scripts/unicode.py
new file mode 100644
index 0000000..d32d912
--- /dev/null
+++ b/crates/unicode-normalization/scripts/unicode.py
@@ -0,0 +1,621 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2018 The Rust Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution and at
+# http://rust-lang.org/COPYRIGHT.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# This script uses the following Unicode tables:
+# - DerivedNormalizationProps.txt
+# - NormalizationTest.txt
+# - UnicodeData.txt
+# - StandardizedVariants.txt
+#
+# Since this should not require frequent updates, we just store this
+# out-of-line and check the tables.rs and normalization_tests.rs files into git.
+import collections
+import urllib.request
+
+UNICODE_VERSION = "15.0.0"
+UCD_URL = "https://www.unicode.org/Public/%s/ucd/" % UNICODE_VERSION
+
+PREAMBLE = """// Copyright 2012-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+#![allow(missing_docs)]
+"""
+
+NormalizationTest = collections.namedtuple(
+ "NormalizationTest",
+ ["source", "nfc", "nfd", "nfkc", "nfkd"],
+)
+
+# Mapping taken from Table 12 from:
+# http://www.unicode.org/reports/tr44/#General_Category_Values
+expanded_categories = {
+ 'Lu': ['LC', 'L'], 'Ll': ['LC', 'L'], 'Lt': ['LC', 'L'],
+ 'Lm': ['L'], 'Lo': ['L'],
+ 'Mn': ['M'], 'Mc': ['M'], 'Me': ['M'],
+ 'Nd': ['N'], 'Nl': ['N'], 'No': ['No'],
+ 'Pc': ['P'], 'Pd': ['P'], 'Ps': ['P'], 'Pe': ['P'],
+ 'Pi': ['P'], 'Pf': ['P'], 'Po': ['P'],
+ 'Sm': ['S'], 'Sc': ['S'], 'Sk': ['S'], 'So': ['S'],
+ 'Zs': ['Z'], 'Zl': ['Z'], 'Zp': ['Z'],
+ 'Cc': ['C'], 'Cf': ['C'], 'Cs': ['C'], 'Co': ['C'], 'Cn': ['C'],
+}
+
+# Constants from Unicode 9.0.0 Section 3.12 Conjoining Jamo Behavior
+# http://www.unicode.org/versions/Unicode9.0.0/ch03.pdf#M9.32468.Heading.310.Combining.Jamo.Behavior
+S_BASE, L_COUNT, V_COUNT, T_COUNT = 0xAC00, 19, 21, 28
+S_COUNT = L_COUNT * V_COUNT * T_COUNT
+
+class UnicodeData(object):
+ def __init__(self):
+ self._load_unicode_data()
+ self.norm_props = self._load_norm_props()
+ self.norm_tests = self._load_norm_tests()
+
+ self.canon_comp = self._compute_canonical_comp()
+ self.canon_fully_decomp, self.compat_fully_decomp = self._compute_fully_decomposed()
+
+ self.cjk_compat_variants_fully_decomp = {}
+ self._load_cjk_compat_ideograph_variants()
+
+ def stats(name, table):
+ count = sum(len(v) for v in table.values())
+ print("%s: %d chars => %d decomposed chars" % (name, len(table), count))
+
+ print("Decomposition table stats:")
+ stats("Canonical decomp", self.canon_decomp)
+ stats("Compatible decomp", self.compat_decomp)
+ stats("Canonical fully decomp", self.canon_fully_decomp)
+ stats("Compatible fully decomp", self.compat_fully_decomp)
+ stats("CJK Compat Variants fully decomp", self.cjk_compat_variants_fully_decomp)
+
+ self.ss_leading, self.ss_trailing = self._compute_stream_safe_tables()
+
+ def _fetch(self, filename):
+ resp = urllib.request.urlopen(UCD_URL + filename)
+ return resp.read().decode('utf-8')
+
+ def _load_unicode_data(self):
+ self.name_to_char_int = {}
+ self.combining_classes = {}
+ self.compat_decomp = {}
+ self.canon_decomp = {}
+ self.general_category_mark = []
+ self.general_category_public_assigned = []
+
+ assigned_start = 0;
+ prev_char_int = -1;
+ prev_name = "";
+
+ for line in self._fetch("UnicodeData.txt").splitlines():
+ # See ftp://ftp.unicode.org/Public/3.0-Update/UnicodeData-3.0.0.html
+ pieces = line.split(';')
+ assert len(pieces) == 15
+ char, name, category, cc, decomp = pieces[0], pieces[1], pieces[2], pieces[3], pieces[5]
+ char_int = int(char, 16)
+
+ name = pieces[1].strip()
+ self.name_to_char_int[name] = char_int
+
+ if cc != '0':
+ self.combining_classes[char_int] = cc
+
+ if decomp.startswith('<'):
+ self.compat_decomp[char_int] = [int(c, 16) for c in decomp.split()[1:]]
+ elif decomp != '':
+ self.canon_decomp[char_int] = [int(c, 16) for c in decomp.split()]
+
+ if category == 'M' or 'M' in expanded_categories.get(category, []):
+ self.general_category_mark.append(char_int)
+
+ assert category != 'Cn', "Unexpected: Unassigned codepoint in UnicodeData.txt"
+ if category not in ['Co', 'Cs']:
+ if char_int != prev_char_int + 1 and not is_first_and_last(prev_name, name):
+ self.general_category_public_assigned.append((assigned_start, prev_char_int))
+ assigned_start = char_int
+ prev_char_int = char_int
+ prev_name = name;
+
+ self.general_category_public_assigned.append((assigned_start, prev_char_int))
+
+ def _load_cjk_compat_ideograph_variants(self):
+ for line in self._fetch("StandardizedVariants.txt").splitlines():
+ strip_comments = line.split('#', 1)[0].strip()
+ if not strip_comments:
+ continue
+
+ variation_sequence, description, differences = strip_comments.split(';')
+ description = description.strip()
+
+ # Don't use variations that only apply in particular shaping environments.
+ if differences:
+ continue
+
+ # Look for entries where the description field is a codepoint name.
+ if description not in self.name_to_char_int:
+ continue
+
+ # Only consider the CJK Compatibility Ideographs.
+ if not description.startswith('CJK COMPATIBILITY IDEOGRAPH-'):
+ continue
+
+ char_int = self.name_to_char_int[description]
+
+ assert not char_int in self.combining_classes, "Unexpected: CJK compat variant with a combining class"
+ assert not char_int in self.compat_decomp, "Unexpected: CJK compat variant and compatibility decomposition"
+ assert len(self.canon_decomp[char_int]) == 1, "Unexpected: CJK compat variant and non-singleton canonical decomposition"
+ # If we ever need to handle Hangul here, we'll need to handle it separately.
+ assert not (S_BASE <= char_int < S_BASE + S_COUNT)
+
+ cjk_compat_variant_parts = [int(c, 16) for c in variation_sequence.split()]
+ for c in cjk_compat_variant_parts:
+ assert not c in self.canon_decomp, "Unexpected: CJK compat variant is unnormalized (canon)"
+ assert not c in self.compat_decomp, "Unexpected: CJK compat variant is unnormalized (compat)"
+ self.cjk_compat_variants_fully_decomp[char_int] = cjk_compat_variant_parts
+
+ def _load_norm_props(self):
+ props = collections.defaultdict(list)
+
+ for line in self._fetch("DerivedNormalizationProps.txt").splitlines():
+ (prop_data, _, _) = line.partition("#")
+ prop_pieces = prop_data.split(";")
+
+ if len(prop_pieces) < 2:
+ continue
+
+ assert len(prop_pieces) <= 3
+ (low, _, high) = prop_pieces[0].strip().partition("..")
+
+ prop = prop_pieces[1].strip()
+
+ data = None
+ if len(prop_pieces) == 3:
+ data = prop_pieces[2].strip()
+
+ props[prop].append((low, high, data))
+
+ return props
+
+ def _load_norm_tests(self):
+ tests = []
+ for line in self._fetch("NormalizationTest.txt").splitlines():
+ (test_data, _, _) = line.partition("#")
+ test_pieces = test_data.split(";")
+
+ if len(test_pieces) < 5:
+ continue
+
+ source, nfc, nfd, nfkc, nfkd = [[c.strip() for c in p.split()] for p in test_pieces[:5]]
+ tests.append(NormalizationTest(source, nfc, nfd, nfkc, nfkd))
+
+ return tests
+
+ def _compute_canonical_comp(self):
+ canon_comp = {}
+ comp_exclusions = [
+ (int(low, 16), int(high or low, 16))
+ for low, high, _ in self.norm_props["Full_Composition_Exclusion"]
+ ]
+ for char_int, decomp in self.canon_decomp.items():
+ if any(lo <= char_int <= hi for lo, hi in comp_exclusions):
+ continue
+
+ assert len(decomp) == 2
+ assert (decomp[0], decomp[1]) not in canon_comp
+ canon_comp[(decomp[0], decomp[1])] = char_int
+
+ return canon_comp
+
+ def _compute_fully_decomposed(self):
+ """
+ Even though the decomposition algorithm is recursive, it is possible
+ to precompute the recursion at table generation time with modest
+ increase to the table size. Then, for these precomputed tables, we
+ note that 1) compatible decomposition is a subset of canonical
+ decomposition and 2) they mostly agree on their intersection.
+ Therefore, we don't store entries in the compatible table for
+ characters that decompose the same way under canonical decomposition.
+
+ Decomposition table stats:
+ Canonical decomp: 2060 chars => 3085 decomposed chars
+ Compatible decomp: 3662 chars => 5440 decomposed chars
+ Canonical fully decomp: 2060 chars => 3404 decomposed chars
+ Compatible fully decomp: 3678 chars => 5599 decomposed chars
+
+ The upshot is that decomposition code is very simple and easy to inline
+ at mild code size cost.
+ """
+ def _decompose(char_int, compatible):
+ # 7-bit ASCII never decomposes
+ if char_int <= 0x7f:
+ yield char_int
+ return
+
+ # Assert that we're handling Hangul separately.
+ assert not (S_BASE <= char_int < S_BASE + S_COUNT)
+
+ decomp = self.canon_decomp.get(char_int)
+ if decomp is not None:
+ for decomposed_ch in decomp:
+ for fully_decomposed_ch in _decompose(decomposed_ch, compatible):
+ yield fully_decomposed_ch
+ return
+
+ if compatible and char_int in self.compat_decomp:
+ for decomposed_ch in self.compat_decomp[char_int]:
+ for fully_decomposed_ch in _decompose(decomposed_ch, compatible):
+ yield fully_decomposed_ch
+ return
+
+ yield char_int
+ return
+
+ end_codepoint = max(
+ max(self.canon_decomp.keys()),
+ max(self.compat_decomp.keys()),
+ )
+
+ canon_fully_decomp = {}
+ compat_fully_decomp = {}
+
+ for char_int in range(0, end_codepoint + 1):
+ # Always skip Hangul, since it's more efficient to represent its
+ # decomposition programmatically.
+ if S_BASE <= char_int < S_BASE + S_COUNT:
+ continue
+
+ canon = list(_decompose(char_int, False))
+ if not (len(canon) == 1 and canon[0] == char_int):
+ canon_fully_decomp[char_int] = canon
+
+ compat = list(_decompose(char_int, True))
+ if not (len(compat) == 1 and compat[0] == char_int):
+ compat_fully_decomp[char_int] = compat
+
+ # Since canon_fully_decomp is a subset of compat_fully_decomp, we don't
+ # need to store their overlap when they agree. When they don't agree,
+ # store the decomposition in the compatibility table since we'll check
+ # that first when normalizing to NFKD.
+ assert set(canon_fully_decomp) <= set(compat_fully_decomp)
+
+ for ch in set(canon_fully_decomp) & set(compat_fully_decomp):
+ if canon_fully_decomp[ch] == compat_fully_decomp[ch]:
+ del compat_fully_decomp[ch]
+
+ return canon_fully_decomp, compat_fully_decomp
+
+ def _compute_stream_safe_tables(self):
+ """
+ To make a text stream-safe with the Stream-Safe Text Process (UAX15-D4),
+ we need to be able to know the number of contiguous non-starters *after*
+ applying compatibility decomposition to each character.
+
+ We can do this incrementally by computing the number of leading and
+ trailing non-starters for each character's compatibility decomposition
+ with the following rules:
+
+ 1) If a character is not affected by compatibility decomposition, look
+ up its canonical combining class to find out if it's a non-starter.
+ 2) All Hangul characters are starters, even under decomposition.
+ 3) Otherwise, very few decomposing characters have a nonzero count
+ of leading or trailing non-starters, so store these characters
+ with their associated counts in a separate table.
+ """
+ leading_nonstarters = {}
+ trailing_nonstarters = {}
+
+ for c in set(self.canon_fully_decomp) | set(self.compat_fully_decomp):
+ decomposed = self.compat_fully_decomp.get(c) or self.canon_fully_decomp[c]
+
+ num_leading = 0
+ for d in decomposed:
+ if d not in self.combining_classes:
+ break
+ num_leading += 1
+
+ num_trailing = 0
+ for d in reversed(decomposed):
+ if d not in self.combining_classes:
+ break
+ num_trailing += 1
+
+ if num_leading > 0:
+ leading_nonstarters[c] = num_leading
+ if num_trailing > 0:
+ trailing_nonstarters[c] = num_trailing
+
+ return leading_nonstarters, trailing_nonstarters
+
+hexify = lambda c: '{:04X}'.format(c)
+
+# Test whether `first` and `last` are corresponding "<..., First>" and
+# "<..., Last>" markers.
+def is_first_and_last(first, last):
+ if not first.startswith('<') or not first.endswith(', First>'):
+ return False
+ if not last.startswith('<') or not last.endswith(', Last>'):
+ return False
+ return first[1:-8] == last[1:-7]
+
+def gen_mph_data(name, d, kv_type, kv_callback):
+ (salt, keys) = minimal_perfect_hash(d)
+ out.write("pub(crate) const %s_SALT: &[u16] = &[\n" % name.upper())
+ for s in salt:
+ out.write(" 0x{:x},\n".format(s))
+ out.write("];\n")
+ out.write("pub(crate) const {}_KV: &[{}] = &[\n".format(name.upper(), kv_type))
+ for k in keys:
+ out.write(" {},\n".format(kv_callback(k)))
+ out.write("];\n\n")
+
+def gen_combining_class(combining_classes, out):
+ gen_mph_data('canonical_combining_class', combining_classes, 'u32',
+ lambda k: "0x{:X}".format(int(combining_classes[k]) | (k << 8)))
+
+def gen_composition_table(canon_comp, out):
+ table = {}
+ for (c1, c2), c3 in canon_comp.items():
+ if c1 < 0x10000 and c2 < 0x10000:
+ table[(c1 << 16) | c2] = c3
+ (salt, keys) = minimal_perfect_hash(table)
+ gen_mph_data('COMPOSITION_TABLE', table, '(u32, char)',
+ lambda k: "(0x%s, '\\u{%s}')" % (hexify(k), hexify(table[k])))
+
+ out.write("pub(crate) fn composition_table_astral(c1: char, c2: char) -> Option<char> {\n")
+ out.write(" match (c1, c2) {\n")
+ for (c1, c2), c3 in sorted(canon_comp.items()):
+ if c1 >= 0x10000 and c2 >= 0x10000:
+ out.write(" ('\\u{%s}', '\\u{%s}') => Some('\\u{%s}'),\n" % (hexify(c1), hexify(c2), hexify(c3)))
+
+ out.write(" _ => None,\n")
+ out.write(" }\n")
+ out.write("}\n")
+
+def gen_decomposition_tables(canon_decomp, compat_decomp, cjk_compat_variants_decomp, out):
+ tables = [(canon_decomp, 'canonical'), (compat_decomp, 'compatibility'), (cjk_compat_variants_decomp, 'cjk_compat_variants')]
+ for table, name in tables:
+ offsets = {}
+ offset = 0
+ out.write("pub(crate) const %s_DECOMPOSED_CHARS: &[char] = &[\n" % name.upper())
+ for k, v in table.items():
+ offsets[k] = offset
+ offset += len(v)
+ for c in v:
+ out.write(" '\\u{%s}',\n" % hexify(c))
+ # The largest offset must fit in a u16.
+ assert offset < 65536
+ out.write("];\n")
+ gen_mph_data(name + '_decomposed', table, "(u32, (u16, u16))",
+ lambda k: "(0x{:x}, ({}, {}))".format(k, offsets[k], len(table[k])))
+
+def gen_qc_match(prop_table, out):
+ out.write(" match c {\n")
+
+ for low, high, data in prop_table:
+ assert data in ('N', 'M')
+ result = "No" if data == 'N' else "Maybe"
+ if high:
+ out.write(r" '\u{%s}'...'\u{%s}' => %s," % (low, high, result))
+ else:
+ out.write(r" '\u{%s}' => %s," % (low, result))
+ out.write("\n")
+
+ out.write(" _ => Yes,\n")
+ out.write(" }\n")
+
+def gen_nfc_qc(prop_tables, out):
+ out.write("#[inline]\n")
+ out.write("#[allow(ellipsis_inclusive_range_patterns)]\n")
+ out.write("pub fn qc_nfc(c: char) -> IsNormalized {\n")
+ gen_qc_match(prop_tables['NFC_QC'], out)
+ out.write("}\n")
+
+def gen_nfkc_qc(prop_tables, out):
+ out.write("#[inline]\n")
+ out.write("#[allow(ellipsis_inclusive_range_patterns)]\n")
+ out.write("pub fn qc_nfkc(c: char) -> IsNormalized {\n")
+ gen_qc_match(prop_tables['NFKC_QC'], out)
+ out.write("}\n")
+
+def gen_nfd_qc(prop_tables, out):
+ out.write("#[inline]\n")
+ out.write("#[allow(ellipsis_inclusive_range_patterns)]\n")
+ out.write("pub fn qc_nfd(c: char) -> IsNormalized {\n")
+ gen_qc_match(prop_tables['NFD_QC'], out)
+ out.write("}\n")
+
+def gen_nfkd_qc(prop_tables, out):
+ out.write("#[inline]\n")
+ out.write("#[allow(ellipsis_inclusive_range_patterns)]\n")
+ out.write("pub fn qc_nfkd(c: char) -> IsNormalized {\n")
+ gen_qc_match(prop_tables['NFKD_QC'], out)
+ out.write("}\n")
+
+def gen_combining_mark(general_category_mark, out):
+ gen_mph_data('combining_mark', general_category_mark, 'u32',
+ lambda k: '0x{:04x}'.format(k))
+
+def gen_public_assigned(general_category_public_assigned, out):
+ # This could be done as a hash but the table is somewhat small.
+ out.write("#[inline]\n")
+ out.write("pub fn is_public_assigned(c: char) -> bool {\n")
+ out.write(" match c {\n")
+
+ start = True
+ for first, last in general_category_public_assigned:
+ if start:
+ out.write(" ")
+ start = False
+ else:
+ out.write(" | ")
+ if first == last:
+ out.write("'\\u{%s}'\n" % hexify(first))
+ else:
+ out.write("'\\u{%s}'..='\\u{%s}'\n" % (hexify(first), hexify(last)))
+ out.write(" => true,\n")
+
+ out.write(" _ => false,\n")
+ out.write(" }\n")
+ out.write("}\n")
+ out.write("\n")
+
+def gen_stream_safe(leading, trailing, out):
+ # This could be done as a hash but the table is very small.
+ out.write("#[inline]\n")
+ out.write("pub fn stream_safe_leading_nonstarters(c: char) -> usize {\n")
+ out.write(" match c {\n")
+
+ for char, num_leading in sorted(leading.items()):
+ out.write(" '\\u{%s}' => %d,\n" % (hexify(char), num_leading))
+
+ out.write(" _ => 0,\n")
+ out.write(" }\n")
+ out.write("}\n")
+ out.write("\n")
+
+ gen_mph_data('trailing_nonstarters', trailing, 'u32',
+ lambda k: "0x{:X}".format(int(trailing[k]) | (k << 8)))
+
+def gen_tests(tests, out):
+ out.write("""#[derive(Debug)]
+pub struct NormalizationTest {
+ pub source: &'static str,
+ pub nfc: &'static str,
+ pub nfd: &'static str,
+ pub nfkc: &'static str,
+ pub nfkd: &'static str,
+}
+
+""")
+
+ out.write("pub const NORMALIZATION_TESTS: &[NormalizationTest] = &[\n")
+ str_literal = lambda s: '"%s"' % "".join("\\u{%s}" % c for c in s)
+
+ for test in tests:
+ out.write(" NormalizationTest {\n")
+ out.write(" source: %s,\n" % str_literal(test.source))
+ out.write(" nfc: %s,\n" % str_literal(test.nfc))
+ out.write(" nfd: %s,\n" % str_literal(test.nfd))
+ out.write(" nfkc: %s,\n" % str_literal(test.nfkc))
+ out.write(" nfkd: %s,\n" % str_literal(test.nfkd))
+ out.write(" },\n")
+
+ out.write("];\n")
+
+# Guaranteed to be less than n.
+def my_hash(x, salt, n):
+ # This is hash based on the theory that multiplication is efficient
+ mask_32 = 0xffffffff
+ y = ((x + salt) * 2654435769) & mask_32
+ y ^= (x * 0x31415926) & mask_32
+ return (y * n) >> 32
+
+# Compute minimal perfect hash function, d can be either a dict or list of keys.
+def minimal_perfect_hash(d):
+ n = len(d)
+ buckets = dict((h, []) for h in range(n))
+ for key in d:
+ h = my_hash(key, 0, n)
+ buckets[h].append(key)
+ bsorted = [(len(buckets[h]), h) for h in range(n)]
+ bsorted.sort(reverse = True)
+ claimed = [False] * n
+ salts = [0] * n
+ keys = [0] * n
+ for (bucket_size, h) in bsorted:
+ # Note: the traditional perfect hashing approach would also special-case
+ # bucket_size == 1 here and assign any empty slot, rather than iterating
+ # until rehash finds an empty slot. But we're not doing that so we can
+ # avoid the branch.
+ if bucket_size == 0:
+ break
+ else:
+ for salt in range(1, 32768):
+ rehashes = [my_hash(key, salt, n) for key in buckets[h]]
+ # Make sure there are no rehash collisions within this bucket.
+ if all(not claimed[hash] for hash in rehashes):
+ if len(set(rehashes)) < bucket_size:
+ continue
+ salts[h] = salt
+ for key in buckets[h]:
+ rehash = my_hash(key, salt, n)
+ claimed[rehash] = True
+ keys[rehash] = key
+ break
+ if salts[h] == 0:
+ print("minimal perfect hashing failed")
+ # Note: if this happens (because of unfortunate data), then there are
+ # a few things that could be done. First, the hash function could be
+ # tweaked. Second, the bucket order could be scrambled (especially the
+ # singletons). Right now, the buckets are sorted, which has the advantage
+ # of being deterministic.
+ #
+ # As a more extreme approach, the singleton bucket optimization could be
+ # applied (give the direct address for singleton buckets, rather than
+ # relying on a rehash). That is definitely the more standard approach in
+ # the minimal perfect hashing literature, but in testing the branch was a
+ # significant slowdown.
+ exit(1)
+ return (salts, keys)
+
+if __name__ == '__main__':
+ data = UnicodeData()
+ with open("tables.rs", "w", newline = "\n") as out:
+ out.write(PREAMBLE)
+ out.write("use crate::quick_check::IsNormalized;\n")
+ out.write("use crate::quick_check::IsNormalized::*;\n")
+ out.write("\n")
+
+ version = "(%s, %s, %s)" % tuple(UNICODE_VERSION.split("."))
+ out.write("#[allow(unused)]\n")
+ out.write("pub const UNICODE_VERSION: (u8, u8, u8) = %s;\n\n" % version)
+
+ gen_combining_class(data.combining_classes, out)
+ out.write("\n")
+
+ gen_composition_table(data.canon_comp, out)
+ out.write("\n")
+
+ gen_decomposition_tables(data.canon_fully_decomp, data.compat_fully_decomp, data.cjk_compat_variants_fully_decomp, out)
+
+ gen_combining_mark(data.general_category_mark, out)
+ out.write("\n")
+
+ gen_public_assigned(data.general_category_public_assigned, out)
+ out.write("\n")
+
+ gen_nfc_qc(data.norm_props, out)
+ out.write("\n")
+
+ gen_nfkc_qc(data.norm_props, out)
+ out.write("\n")
+
+ gen_nfd_qc(data.norm_props, out)
+ out.write("\n")
+
+ gen_nfkd_qc(data.norm_props, out)
+ out.write("\n")
+
+ gen_stream_safe(data.ss_leading, data.ss_trailing, out)
+ out.write("\n")
+
+ with open("normalization_tests.rs", "w", newline = "\n") as out:
+ out.write(PREAMBLE)
+ gen_tests(data.norm_tests, out)
diff --git a/crates/unicode-normalization/src/__test_api.rs b/crates/unicode-normalization/src/__test_api.rs
new file mode 100644
index 0000000..f1a3f92
--- /dev/null
+++ b/crates/unicode-normalization/src/__test_api.rs
@@ -0,0 +1,18 @@
+// This crate comprises hacks and glue required to test private functions from tests/
+//
+// Keep this as slim as possible.
+//
+// If you're caught using this outside this crates tests/, you get to clean up the mess.
+
+#[cfg(not(feature = "std"))]
+use crate::no_std_prelude::*;
+
+use crate::stream_safe::StreamSafe;
+
+pub fn stream_safe(s: &str) -> String {
+ StreamSafe::new(s.chars()).collect()
+}
+
+pub mod quick_check {
+ pub use crate::quick_check::*;
+}
diff --git a/crates/unicode-normalization/src/decompose.rs b/crates/unicode-normalization/src/decompose.rs
new file mode 100644
index 0000000..23cdb1a
--- /dev/null
+++ b/crates/unicode-normalization/src/decompose.rs
@@ -0,0 +1,161 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+use core::fmt::{self, Write};
+use core::iter::Fuse;
+use core::ops::Range;
+use tinyvec::TinyVec;
+
+#[derive(Clone)]
+enum DecompositionType {
+ Canonical,
+ Compatible,
+}
+
+/// External iterator for a string decomposition's characters.
+#[derive(Clone)]
+pub struct Decompositions<I> {
+ kind: DecompositionType,
+ iter: Fuse<I>,
+
+ // This buffer stores pairs of (canonical combining class, character),
+ // pushed onto the end in text order.
+ //
+ // It's divided into up to three sections:
+ // 1) A prefix that is free space;
+ // 2) "Ready" characters which are sorted and ready to emit on demand;
+ // 3) A "pending" block which stills needs more characters for us to be able
+ // to sort in canonical order and is not safe to emit.
+ buffer: TinyVec<[(u8, char); 4]>,
+ ready: Range<usize>,
+}
+
+#[inline]
+pub fn new_canonical<I: Iterator<Item = char>>(iter: I) -> Decompositions<I> {
+ Decompositions {
+ kind: self::DecompositionType::Canonical,
+ iter: iter.fuse(),
+ buffer: TinyVec::new(),
+ ready: 0..0,
+ }
+}
+
+#[inline]
+pub fn new_compatible<I: Iterator<Item = char>>(iter: I) -> Decompositions<I> {
+ Decompositions {
+ kind: self::DecompositionType::Compatible,
+ iter: iter.fuse(),
+ buffer: TinyVec::new(),
+ ready: 0..0,
+ }
+}
+
+impl<I> Decompositions<I> {
+ #[inline]
+ fn push_back(&mut self, ch: char) {
+ let class = super::char::canonical_combining_class(ch);
+
+ if class == 0 {
+ self.sort_pending();
+ self.buffer.push((class, ch));
+ self.ready.end = self.buffer.len();
+ } else {
+ self.buffer.push((class, ch));
+ }
+ }
+
+ #[inline]
+ fn sort_pending(&mut self) {
+ // NB: `sort_by_key` is stable, so it will preserve the original text's
+ // order within a combining class.
+ self.buffer[self.ready.end..].sort_by_key(|k| k.0);
+ }
+
+ #[inline]
+ fn reset_buffer(&mut self) {
+ // Equivalent to `self.buffer.drain(0..self.ready.end)`
+ // but faster than drain() if the buffer is a SmallVec or TinyVec
+ let pending = self.buffer.len() - self.ready.end;
+ for i in 0..pending {
+ self.buffer[i] = self.buffer[i + self.ready.end];
+ }
+ self.buffer.truncate(pending);
+ self.ready = 0..0;
+ }
+
+ #[inline]
+ fn increment_next_ready(&mut self) {
+ let next = self.ready.start + 1;
+ if next == self.ready.end {
+ self.reset_buffer();
+ } else {
+ self.ready.start = next;
+ }
+ }
+}
+
+impl<I: Iterator<Item = char>> Iterator for Decompositions<I> {
+ type Item = char;
+
+ #[inline]
+ fn next(&mut self) -> Option<char> {
+ while self.ready.end == 0 {
+ match (self.iter.next(), &self.kind) {
+ (Some(ch), &DecompositionType::Canonical) => {
+ super::char::decompose_canonical(ch, |d| self.push_back(d));
+ }
+ (Some(ch), &DecompositionType::Compatible) => {
+ super::char::decompose_compatible(ch, |d| self.push_back(d));
+ }
+ (None, _) => {
+ if self.buffer.is_empty() {
+ return None;
+ } else {
+ self.sort_pending();
+ self.ready.end = self.buffer.len();
+
+ // This implementation means that we can call `next`
+ // on an exhausted iterator; the last outer `next` call
+ // will result in an inner `next` call. To make this
+ // safe, we use `fuse`.
+ break;
+ }
+ }
+ }
+ }
+
+ // We can assume here that, if `self.ready.end` is greater than zero,
+ // it's also greater than `self.ready.start`. That's because we only
+ // increment `self.ready.start` inside `increment_next_ready`, and
+ // whenever it reaches equality with `self.ready.end`, we reset both
+ // to zero, maintaining the invariant that:
+ // self.ready.start < self.ready.end || self.ready.end == self.ready.start == 0
+ //
+ // This less-than-obviously-safe implementation is chosen for performance,
+ // minimizing the number & complexity of branches in `next` in the common
+ // case of buffering then unbuffering a single character with each call.
+ let (_, ch) = self.buffer[self.ready.start];
+ self.increment_next_ready();
+ Some(ch)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let (lower, _) = self.iter.size_hint();
+ (lower, None)
+ }
+}
+
+impl<I: Iterator<Item = char> + Clone> fmt::Display for Decompositions<I> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ for c in self.clone() {
+ f.write_char(c)?;
+ }
+ Ok(())
+ }
+}
diff --git a/crates/unicode-normalization/src/lib.rs b/crates/unicode-normalization/src/lib.rs
new file mode 100644
index 0000000..21c3bf1
--- /dev/null
+++ b/crates/unicode-normalization/src/lib.rs
@@ -0,0 +1,235 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Unicode character composition and decomposition utilities
+//! as described in
+//! [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).
+//!
+//! ```rust
+//! extern crate unicode_normalization;
+//!
+//! use unicode_normalization::char::compose;
+//! use unicode_normalization::UnicodeNormalization;
+//!
+//! fn main() {
+//! assert_eq!(compose('A','\u{30a}'), Some('Å'));
+//!
+//! let s = "ÅΩ";
+//! let c = s.nfc().collect::<String>();
+//! assert_eq!(c, "ÅΩ");
+//! }
+//! ```
+//!
+//! # crates.io
+//!
+//! You can use this package in your project by adding the following
+//! to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! unicode-normalization = "0.1.20"
+//! ```
+
+#![deny(missing_docs, unsafe_code)]
+#![doc(
+ html_logo_url = "https://unicode-rs.github.io/unicode-rs_sm.png",
+ html_favicon_url = "https://unicode-rs.github.io/unicode-rs_sm.png"
+)]
+#![cfg_attr(not(feature = "std"), no_std)]
+
+#[cfg(not(feature = "std"))]
+extern crate alloc;
+
+#[cfg(feature = "std")]
+extern crate core;
+
+extern crate tinyvec;
+
+pub use crate::decompose::Decompositions;
+pub use crate::quick_check::{
+ is_nfc, is_nfc_quick, is_nfc_stream_safe, is_nfc_stream_safe_quick, is_nfd, is_nfd_quick,
+ is_nfd_stream_safe, is_nfd_stream_safe_quick, is_nfkc, is_nfkc_quick, is_nfkd, is_nfkd_quick,
+ IsNormalized,
+};
+pub use crate::recompose::Recompositions;
+pub use crate::replace::Replacements;
+pub use crate::stream_safe::StreamSafe;
+pub use crate::tables::UNICODE_VERSION;
+use core::{
+ str::Chars,
+ option,
+};
+
+mod no_std_prelude;
+
+mod decompose;
+mod lookups;
+mod normalize;
+mod perfect_hash;
+mod quick_check;
+mod recompose;
+mod replace;
+mod stream_safe;
+
+#[rustfmt::skip]
+mod tables;
+
+#[doc(hidden)]
+pub mod __test_api;
+#[cfg(test)]
+mod test;
+
+/// Methods for composing and decomposing characters.
+pub mod char {
+ pub use crate::normalize::{
+ compose, decompose_canonical, decompose_cjk_compat_variants, decompose_compatible,
+ };
+
+ pub use crate::lookups::{canonical_combining_class, is_combining_mark};
+
+ /// Return whether the given character is assigned (`General_Category` != `Unassigned`)
+ /// and not Private-Use (`General_Category` != `Private_Use`), in the supported version
+ /// of Unicode.
+ pub use crate::tables::is_public_assigned;
+}
+
+/// Methods for iterating over strings while applying Unicode normalizations
+/// as described in
+/// [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/).
+pub trait UnicodeNormalization<I: Iterator<Item = char>> {
+ /// Returns an iterator over the string in Unicode Normalization Form D
+ /// (canonical decomposition).
+ fn nfd(self) -> Decompositions<I>;
+
+ /// Returns an iterator over the string in Unicode Normalization Form KD
+ /// (compatibility decomposition).
+ fn nfkd(self) -> Decompositions<I>;
+
+ /// An Iterator over the string in Unicode Normalization Form C
+ /// (canonical decomposition followed by canonical composition).
+ fn nfc(self) -> Recompositions<I>;
+
+ /// An Iterator over the string in Unicode Normalization Form KC
+ /// (compatibility decomposition followed by canonical composition).
+ fn nfkc(self) -> Recompositions<I>;
+
+ /// A transformation which replaces CJK Compatibility Ideograph codepoints
+ /// with normal forms using Standardized Variation Sequences. This is not
+ /// part of the canonical or compatibility decomposition algorithms, but
+ /// performing it before those algorithms produces normalized output which
+ /// better preserves the intent of the original text.
+ ///
+ /// Note that many systems today ignore variation selectors, so these
+ /// may not immediately help text display as intended, but they at
+ /// least preserve the information in a standardized form, giving
+ /// implementations the option to recognize them.
+ fn cjk_compat_variants(self) -> Replacements<I>;
+
+ /// An Iterator over the string with Conjoining Grapheme Joiner characters
+ /// inserted according to the Stream-Safe Text Process (UAX15-D4)
+ fn stream_safe(self) -> StreamSafe<I>;
+}
+
+impl<'a> UnicodeNormalization<Chars<'a>> for &'a str {
+ #[inline]
+ fn nfd(self) -> Decompositions<Chars<'a>> {
+ decompose::new_canonical(self.chars())
+ }
+
+ #[inline]
+ fn nfkd(self) -> Decompositions<Chars<'a>> {
+ decompose::new_compatible(self.chars())
+ }
+
+ #[inline]
+ fn nfc(self) -> Recompositions<Chars<'a>> {
+ recompose::new_canonical(self.chars())
+ }
+
+ #[inline]
+ fn nfkc(self) -> Recompositions<Chars<'a>> {
+ recompose::new_compatible(self.chars())
+ }
+
+ #[inline]
+ fn cjk_compat_variants(self) -> Replacements<Chars<'a>> {
+ replace::new_cjk_compat_variants(self.chars())
+ }
+
+ #[inline]
+ fn stream_safe(self) -> StreamSafe<Chars<'a>> {
+ StreamSafe::new(self.chars())
+ }
+}
+
+
+impl UnicodeNormalization<option::IntoIter<char>> for char {
+ #[inline]
+ fn nfd(self) -> Decompositions<option::IntoIter<char>> {
+ decompose::new_canonical(Some(self).into_iter())
+ }
+
+ #[inline]
+ fn nfkd(self) -> Decompositions<option::IntoIter<char>> {
+ decompose::new_compatible(Some(self).into_iter())
+ }
+
+ #[inline]
+ fn nfc(self) -> Recompositions<option::IntoIter<char>> {
+ recompose::new_canonical(Some(self).into_iter())
+ }
+
+ #[inline]
+ fn nfkc(self) -> Recompositions<option::IntoIter<char>> {
+ recompose::new_compatible(Some(self).into_iter())
+ }
+
+ #[inline]
+ fn cjk_compat_variants(self) -> Replacements<option::IntoIter<char>> {
+ replace::new_cjk_compat_variants(Some(self).into_iter())
+ }
+
+ #[inline]
+ fn stream_safe(self) -> StreamSafe<option::IntoIter<char>> {
+ StreamSafe::new(Some(self).into_iter())
+ }
+}
+
+impl<I: Iterator<Item = char>> UnicodeNormalization<I> for I {
+ #[inline]
+ fn nfd(self) -> Decompositions<I> {
+ decompose::new_canonical(self)
+ }
+
+ #[inline]
+ fn nfkd(self) -> Decompositions<I> {
+ decompose::new_compatible(self)
+ }
+
+ #[inline]
+ fn nfc(self) -> Recompositions<I> {
+ recompose::new_canonical(self)
+ }
+
+ #[inline]
+ fn nfkc(self) -> Recompositions<I> {
+ recompose::new_compatible(self)
+ }
+
+ #[inline]
+ fn cjk_compat_variants(self) -> Replacements<I> {
+ replace::new_cjk_compat_variants(self)
+ }
+
+ #[inline]
+ fn stream_safe(self) -> StreamSafe<I> {
+ StreamSafe::new(self)
+ }
+}
diff --git a/crates/unicode-normalization/src/lookups.rs b/crates/unicode-normalization/src/lookups.rs
new file mode 100644
index 0000000..ea7a96c
--- /dev/null
+++ b/crates/unicode-normalization/src/lookups.rs
@@ -0,0 +1,138 @@
+// Copyright 2019 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Lookups of unicode properties using minimal perfect hashing.
+
+use crate::perfect_hash::mph_lookup;
+use crate::tables::*;
+
+/// Look up the canonical combining class for a codepoint.
+///
+/// The value returned is as defined in the Unicode Character Database.
+pub fn canonical_combining_class(c: char) -> u8 {
+ mph_lookup(
+ c.into(),
+ CANONICAL_COMBINING_CLASS_SALT,
+ CANONICAL_COMBINING_CLASS_KV,
+ u8_lookup_fk,
+ u8_lookup_fv,
+ 0,
+ )
+}
+
+pub(crate) fn composition_table(c1: char, c2: char) -> Option<char> {
+ if c1 < '\u{10000}' && c2 < '\u{10000}' {
+ mph_lookup(
+ (c1 as u32) << 16 | (c2 as u32),
+ COMPOSITION_TABLE_SALT,
+ COMPOSITION_TABLE_KV,
+ pair_lookup_fk,
+ pair_lookup_fv_opt,
+ None,
+ )
+ } else {
+ composition_table_astral(c1, c2)
+ }
+}
+
+pub(crate) fn canonical_fully_decomposed(c: char) -> Option<&'static [char]> {
+ mph_lookup(
+ c.into(),
+ CANONICAL_DECOMPOSED_SALT,
+ CANONICAL_DECOMPOSED_KV,
+ pair_lookup_fk,
+ pair_lookup_fv_opt,
+ None,
+ )
+ .map(|(start, len)| &CANONICAL_DECOMPOSED_CHARS[start as usize..][..len as usize])
+}
+
+pub(crate) fn compatibility_fully_decomposed(c: char) -> Option<&'static [char]> {
+ mph_lookup(
+ c.into(),
+ COMPATIBILITY_DECOMPOSED_SALT,
+ COMPATIBILITY_DECOMPOSED_KV,
+ pair_lookup_fk,
+ pair_lookup_fv_opt,
+ None,
+ )
+ .map(|(start, len)| &COMPATIBILITY_DECOMPOSED_CHARS[start as usize..][..len as usize])
+}
+
+pub(crate) fn cjk_compat_variants_fully_decomposed(c: char) -> Option<&'static [char]> {
+ mph_lookup(
+ c.into(),
+ CJK_COMPAT_VARIANTS_DECOMPOSED_SALT,
+ CJK_COMPAT_VARIANTS_DECOMPOSED_KV,
+ pair_lookup_fk,
+ pair_lookup_fv_opt,
+ None,
+ )
+ .map(|(start, len)| &CJK_COMPAT_VARIANTS_DECOMPOSED_CHARS[start as usize..][..len as usize])
+}
+
+/// Return whether the given character is a combining mark (`General_Category=Mark`)
+pub fn is_combining_mark(c: char) -> bool {
+ mph_lookup(
+ c.into(),
+ COMBINING_MARK_SALT,
+ COMBINING_MARK_KV,
+ bool_lookup_fk,
+ bool_lookup_fv,
+ false,
+ )
+}
+
+pub fn stream_safe_trailing_nonstarters(c: char) -> usize {
+ mph_lookup(
+ c.into(),
+ TRAILING_NONSTARTERS_SALT,
+ TRAILING_NONSTARTERS_KV,
+ u8_lookup_fk,
+ u8_lookup_fv,
+ 0,
+ ) as usize
+}
+
+/// Extract the key in a 24 bit key and 8 bit value packed in a u32.
+#[inline]
+fn u8_lookup_fk(kv: u32) -> u32 {
+ kv >> 8
+}
+
+/// Extract the value in a 24 bit key and 8 bit value packed in a u32.
+#[inline]
+fn u8_lookup_fv(kv: u32) -> u8 {
+ (kv & 0xff) as u8
+}
+
+/// Extract the key for a boolean lookup.
+#[inline]
+fn bool_lookup_fk(kv: u32) -> u32 {
+ kv
+}
+
+/// Extract the value for a boolean lookup.
+#[inline]
+fn bool_lookup_fv(_kv: u32) -> bool {
+ true
+}
+
+/// Extract the key in a pair.
+#[inline]
+fn pair_lookup_fk<T>(kv: (u32, T)) -> u32 {
+ kv.0
+}
+
+/// Extract the value in a pair, returning an option.
+#[inline]
+fn pair_lookup_fv_opt<T>(kv: (u32, T)) -> Option<T> {
+ Some(kv.1)
+}
diff --git a/crates/unicode-normalization/src/no_std_prelude.rs b/crates/unicode-normalization/src/no_std_prelude.rs
new file mode 100755
index 0000000..838d122
--- /dev/null
+++ b/crates/unicode-normalization/src/no_std_prelude.rs
@@ -0,0 +1,6 @@
+#[cfg(not(feature = "std"))]
+pub use alloc::{
+ str::Chars,
+ string::{String, ToString},
+ vec::Vec,
+};
diff --git a/crates/unicode-normalization/src/normalize.rs b/crates/unicode-normalization/src/normalize.rs
new file mode 100644
index 0000000..b144bd7
--- /dev/null
+++ b/crates/unicode-normalization/src/normalize.rs
@@ -0,0 +1,201 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Functions for computing canonical and compatible decompositions for Unicode characters.
+use crate::lookups::{
+ canonical_fully_decomposed, cjk_compat_variants_fully_decomposed,
+ compatibility_fully_decomposed, composition_table,
+};
+
+use core::{char, ops::FnMut};
+
+/// Compute canonical Unicode decomposition for character.
+/// See [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/)
+/// for more information.
+#[inline]
+pub fn decompose_canonical<F>(c: char, emit_char: F)
+where
+ F: FnMut(char),
+{
+ decompose(c, canonical_fully_decomposed, emit_char)
+}
+
+/// Compute canonical or compatible Unicode decomposition for character.
+/// See [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/)
+/// for more information.
+#[inline]
+pub fn decompose_compatible<F: FnMut(char)>(c: char, emit_char: F) {
+ let decompose_char =
+ |c| compatibility_fully_decomposed(c).or_else(|| canonical_fully_decomposed(c));
+ decompose(c, decompose_char, emit_char)
+}
+
+/// Compute standard-variation decomposition for character.
+///
+/// [Standardized Variation Sequences] are used instead of the standard canonical
+/// decompositions, notably for CJK codepoints with singleton canonical decompositions,
+/// to avoid losing information. See the
+/// [Unicode Variation Sequence FAQ](http://unicode.org/faq/vs.html) and the
+/// "Other Enhancements" section of the
+/// [Unicode 6.3 Release Summary](https://www.unicode.org/versions/Unicode6.3.0/#Summary)
+/// for more information.
+#[inline]
+pub fn decompose_cjk_compat_variants<F>(c: char, mut emit_char: F)
+where
+ F: FnMut(char),
+{
+ // 7-bit ASCII never decomposes
+ if c <= '\x7f' {
+ emit_char(c);
+ return;
+ }
+
+ // Don't perform decomposition for Hangul
+
+ if let Some(decomposed) = cjk_compat_variants_fully_decomposed(c) {
+ for &d in decomposed {
+ emit_char(d);
+ }
+ return;
+ }
+
+ // Finally bottom out.
+ emit_char(c);
+}
+
+#[inline]
+fn decompose<D, F>(c: char, decompose_char: D, mut emit_char: F)
+where
+ D: Fn(char) -> Option<&'static [char]>,
+ F: FnMut(char),
+{
+ // 7-bit ASCII never decomposes
+ if c <= '\x7f' {
+ emit_char(c);
+ return;
+ }
+
+ // Perform decomposition for Hangul
+ if is_hangul_syllable(c) {
+ decompose_hangul(c, emit_char);
+ return;
+ }
+
+ if let Some(decomposed) = decompose_char(c) {
+ for &d in decomposed {
+ emit_char(d);
+ }
+ return;
+ }
+
+ // Finally bottom out.
+ emit_char(c);
+}
+
+/// Compose two characters into a single character, if possible.
+/// See [Unicode Standard Annex #15](http://www.unicode.org/reports/tr15/)
+/// for more information.
+pub fn compose(a: char, b: char) -> Option<char> {
+ compose_hangul(a, b).or_else(|| composition_table(a, b))
+}
+
+// Constants from Unicode 9.0.0 Section 3.12 Conjoining Jamo Behavior
+// http://www.unicode.org/versions/Unicode9.0.0/ch03.pdf#M9.32468.Heading.310.Combining.Jamo.Behavior
+const S_BASE: u32 = 0xAC00;
+const L_BASE: u32 = 0x1100;
+const V_BASE: u32 = 0x1161;
+const T_BASE: u32 = 0x11A7;
+const L_COUNT: u32 = 19;
+const V_COUNT: u32 = 21;
+const T_COUNT: u32 = 28;
+const N_COUNT: u32 = V_COUNT * T_COUNT;
+const S_COUNT: u32 = L_COUNT * N_COUNT;
+
+const S_LAST: u32 = S_BASE + S_COUNT - 1;
+const L_LAST: u32 = L_BASE + L_COUNT - 1;
+const V_LAST: u32 = V_BASE + V_COUNT - 1;
+const T_LAST: u32 = T_BASE + T_COUNT - 1;
+
+// Composition only occurs for `TPart`s in `U+11A8 ... U+11C2`,
+// i.e. `T_BASE + 1 ... T_LAST`.
+const T_FIRST: u32 = T_BASE + 1;
+
+pub(crate) fn is_hangul_syllable(c: char) -> bool {
+ (c as u32) >= S_BASE && (c as u32) < (S_BASE + S_COUNT)
+}
+
+// Decompose a precomposed Hangul syllable
+#[allow(unsafe_code)]
+#[inline(always)]
+fn decompose_hangul<F>(s: char, mut emit_char: F)
+where
+ F: FnMut(char),
+{
+ let s_index = s as u32 - S_BASE;
+ let l_index = s_index / N_COUNT;
+ unsafe {
+ emit_char(char::from_u32_unchecked(L_BASE + l_index));
+
+ let v_index = (s_index % N_COUNT) / T_COUNT;
+ emit_char(char::from_u32_unchecked(V_BASE + v_index));
+
+ let t_index = s_index % T_COUNT;
+ if t_index > 0 {
+ emit_char(char::from_u32_unchecked(T_BASE + t_index));
+ }
+ }
+}
+
+#[inline]
+pub(crate) fn hangul_decomposition_length(s: char) -> usize {
+ let si = s as u32 - S_BASE;
+ let ti = si % T_COUNT;
+ if ti > 0 {
+ 3
+ } else {
+ 2
+ }
+}
+
+// Compose a pair of Hangul Jamo
+#[allow(unsafe_code)]
+#[inline(always)]
+#[allow(ellipsis_inclusive_range_patterns)]
+fn compose_hangul(a: char, b: char) -> Option<char> {
+ let (a, b) = (a as u32, b as u32);
+ match (a, b) {
+ // Compose a leading consonant and a vowel together into an LV_Syllable
+ (L_BASE...L_LAST, V_BASE...V_LAST) => {
+ let l_index = a - L_BASE;
+ let v_index = b - V_BASE;
+ let lv_index = l_index * N_COUNT + v_index * T_COUNT;
+ let s = S_BASE + lv_index;
+ Some(unsafe { char::from_u32_unchecked(s) })
+ }
+ // Compose an LV_Syllable and a trailing consonant into an LVT_Syllable
+ (S_BASE...S_LAST, T_FIRST...T_LAST) if (a - S_BASE) % T_COUNT == 0 => {
+ Some(unsafe { char::from_u32_unchecked(a + (b - T_BASE)) })
+ }
+ _ => None,
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::compose_hangul;
+
+ // Regression test from a bugfix where we were composing an LV_Syllable with
+ // T_BASE directly. (We should only compose an LV_Syllable with a character
+ // in the range `T_BASE + 1 ... T_LAST`.)
+ #[test]
+ fn test_hangul_composition() {
+ assert_eq!(compose_hangul('\u{c8e0}', '\u{11a7}'), None);
+ }
+}
diff --git a/crates/unicode-normalization/src/perfect_hash.rs b/crates/unicode-normalization/src/perfect_hash.rs
new file mode 100644
index 0000000..3dbc166
--- /dev/null
+++ b/crates/unicode-normalization/src/perfect_hash.rs
@@ -0,0 +1,50 @@
+// Copyright 2019 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Support for lookups based on minimal perfect hashing.
+
+// This function is based on multiplication being fast and is "good enough". Also
+// it can share some work between the unsalted and salted versions.
+#[inline]
+fn my_hash(key: u32, salt: u32, n: usize) -> usize {
+ let y = key.wrapping_add(salt).wrapping_mul(2654435769);
+ let y = y ^ key.wrapping_mul(0x31415926);
+ (((y as u64) * (n as u64)) >> 32) as usize
+}
+
+/// Do a lookup using minimal perfect hashing.
+///
+/// The table is stored as a sequence of "salt" values, then a sequence of
+/// values that contain packed key/value pairs. The strategy is to hash twice.
+/// The first hash retrieves a salt value that makes the second hash unique.
+/// The hash function doesn't have to be very good, just good enough that the
+/// resulting map is unique.
+#[inline]
+pub(crate) fn mph_lookup<KV, V, FK, FV>(
+ x: u32,
+ salt: &[u16],
+ kv: &[KV],
+ fk: FK,
+ fv: FV,
+ default: V,
+) -> V
+where
+ KV: Copy,
+ FK: Fn(KV) -> u32,
+ FV: Fn(KV) -> V,
+{
+ let s = salt[my_hash(x, 0, salt.len())] as u32;
+ let key_val = kv[my_hash(x, s, salt.len())];
+ if x == fk(key_val) {
+ fv(key_val)
+ } else {
+ default
+ }
+}
diff --git a/crates/unicode-normalization/src/quick_check.rs b/crates/unicode-normalization/src/quick_check.rs
new file mode 100644
index 0000000..4507b2a
--- /dev/null
+++ b/crates/unicode-normalization/src/quick_check.rs
@@ -0,0 +1,187 @@
+use crate::lookups::canonical_combining_class;
+use crate::stream_safe;
+use crate::tables;
+use crate::UnicodeNormalization;
+
+/// The QuickCheck algorithm can quickly determine if a text is or isn't
+/// normalized without any allocations in many cases, but it has to be able to
+/// return `Maybe` when a full decomposition and recomposition is necessary.
+#[derive(Debug, Eq, PartialEq)]
+pub enum IsNormalized {
+ /// The text is definitely normalized.
+ Yes,
+ /// The text is definitely not normalized.
+ No,
+ /// The text may be normalized.
+ Maybe,
+}
+
+// https://unicode.org/reports/tr15/#Detecting_Normalization_Forms
+#[inline]
+fn quick_check<F, I>(s: I, is_allowed: F, stream_safe: bool) -> IsNormalized
+where
+ I: Iterator<Item = char>,
+ F: Fn(char) -> IsNormalized,
+{
+ let mut last_cc = 0u8;
+ let mut nonstarter_count = 0;
+ let mut result = IsNormalized::Yes;
+ for ch in s {
+ // For ASCII we know it's always allowed and a starter
+ if ch <= '\x7f' {
+ last_cc = 0;
+ nonstarter_count = 0;
+ continue;
+ }
+
+ // Otherwise, lookup the combining class and QC property
+ let cc = canonical_combining_class(ch);
+ if last_cc > cc && cc != 0 {
+ return IsNormalized::No;
+ }
+ match is_allowed(ch) {
+ IsNormalized::Yes => (),
+ IsNormalized::No => return IsNormalized::No,
+ IsNormalized::Maybe => {
+ result = IsNormalized::Maybe;
+ }
+ }
+ if stream_safe {
+ let decomp = stream_safe::classify_nonstarters(ch);
+
+ // If we're above `MAX_NONSTARTERS`, we're definitely *not*
+ // stream-safe normalized.
+ if nonstarter_count + decomp.leading_nonstarters > stream_safe::MAX_NONSTARTERS {
+ return IsNormalized::No;
+ }
+ if decomp.leading_nonstarters == decomp.decomposition_len {
+ nonstarter_count += decomp.decomposition_len;
+ } else {
+ nonstarter_count = decomp.trailing_nonstarters;
+ }
+ }
+ last_cc = cc;
+ }
+ result
+}
+
+/// Quickly check if a string is in NFC, potentially returning
+/// `IsNormalized::Maybe` if further checks are necessary. In this case a check
+/// like `s.chars().nfc().eq(s.chars())` should suffice.
+#[inline]
+pub fn is_nfc_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfc, false)
+}
+
+/// Quickly check if a string is in NFKC.
+#[inline]
+pub fn is_nfkc_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfkc, false)
+}
+
+/// Quickly check if a string is in NFD.
+#[inline]
+pub fn is_nfd_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfd, false)
+}
+
+/// Quickly check if a string is in NFKD.
+#[inline]
+pub fn is_nfkd_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfkd, false)
+}
+
+/// Quickly check if a string is Stream-Safe NFC.
+#[inline]
+pub fn is_nfc_stream_safe_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfc, true)
+}
+
+/// Quickly check if a string is Stream-Safe NFD.
+#[inline]
+pub fn is_nfd_stream_safe_quick<I: Iterator<Item = char>>(s: I) -> IsNormalized {
+ quick_check(s, tables::qc_nfd, true)
+}
+
+/// Authoritatively check if a string is in NFC.
+#[inline]
+pub fn is_nfc(s: &str) -> bool {
+ match is_nfc_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().nfc()),
+ }
+}
+
+/// Authoritatively check if a string is in NFKC.
+#[inline]
+pub fn is_nfkc(s: &str) -> bool {
+ match is_nfkc_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().nfkc()),
+ }
+}
+
+/// Authoritatively check if a string is in NFD.
+#[inline]
+pub fn is_nfd(s: &str) -> bool {
+ match is_nfd_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().nfd()),
+ }
+}
+
+/// Authoritatively check if a string is in NFKD.
+#[inline]
+pub fn is_nfkd(s: &str) -> bool {
+ match is_nfkd_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().nfkd()),
+ }
+}
+
+/// Authoritatively check if a string is Stream-Safe NFC.
+#[inline]
+pub fn is_nfc_stream_safe(s: &str) -> bool {
+ match is_nfc_stream_safe_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().stream_safe().nfc()),
+ }
+}
+
+/// Authoritatively check if a string is Stream-Safe NFD.
+#[inline]
+pub fn is_nfd_stream_safe(s: &str) -> bool {
+ match is_nfd_stream_safe_quick(s.chars()) {
+ IsNormalized::Yes => true,
+ IsNormalized::No => false,
+ IsNormalized::Maybe => s.chars().eq(s.chars().stream_safe().nfd()),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{is_nfc_stream_safe_quick, is_nfd_stream_safe_quick, IsNormalized};
+
+ #[test]
+ fn test_stream_safe_nfd() {
+ let okay = "Da\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}ngerzone";
+ assert_eq!(is_nfd_stream_safe_quick(okay.chars()), IsNormalized::Yes);
+
+ let too_much = "Da\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{031e}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}ngerzone";
+ assert_eq!(is_nfd_stream_safe_quick(too_much.chars()), IsNormalized::No);
+ }
+
+ #[test]
+ fn test_stream_safe_nfc() {
+ let okay = "ok\u{e0}\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}y";
+ assert_eq!(is_nfc_stream_safe_quick(okay.chars()), IsNormalized::Maybe);
+
+ let too_much = "not ok\u{e0}\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{031e}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}y";
+ assert_eq!(is_nfc_stream_safe_quick(too_much.chars()), IsNormalized::No);
+ }
+}
diff --git a/crates/unicode-normalization/src/recompose.rs b/crates/unicode-normalization/src/recompose.rs
new file mode 100644
index 0000000..2a1960a
--- /dev/null
+++ b/crates/unicode-normalization/src/recompose.rs
@@ -0,0 +1,154 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::decompose::Decompositions;
+use core::fmt::{self, Write};
+use tinyvec::TinyVec;
+
+#[derive(Clone)]
+enum RecompositionState {
+ Composing,
+ Purging(usize),
+ Finished(usize),
+}
+
+/// External iterator for a string recomposition's characters.
+#[derive(Clone)]
+pub struct Recompositions<I> {
+ iter: Decompositions<I>,
+ state: RecompositionState,
+ buffer: TinyVec<[char; 4]>,
+ composee: Option<char>,
+ last_ccc: Option<u8>,
+}
+
+#[inline]
+pub fn new_canonical<I: Iterator<Item = char>>(iter: I) -> Recompositions<I> {
+ Recompositions {
+ iter: super::decompose::new_canonical(iter),
+ state: self::RecompositionState::Composing,
+ buffer: TinyVec::new(),
+ composee: None,
+ last_ccc: None,
+ }
+}
+
+#[inline]
+pub fn new_compatible<I: Iterator<Item = char>>(iter: I) -> Recompositions<I> {
+ Recompositions {
+ iter: super::decompose::new_compatible(iter),
+ state: self::RecompositionState::Composing,
+ buffer: TinyVec::new(),
+ composee: None,
+ last_ccc: None,
+ }
+}
+
+impl<I: Iterator<Item = char>> Iterator for Recompositions<I> {
+ type Item = char;
+
+ #[inline]
+ fn next(&mut self) -> Option<char> {
+ use self::RecompositionState::*;
+
+ loop {
+ match self.state {
+ Composing => {
+ for ch in self.iter.by_ref() {
+ let ch_class = super::char::canonical_combining_class(ch);
+ let k = match self.composee {
+ None => {
+ if ch_class != 0 {
+ return Some(ch);
+ }
+ self.composee = Some(ch);
+ continue;
+ }
+ Some(k) => k,
+ };
+ match self.last_ccc {
+ None => match super::char::compose(k, ch) {
+ Some(r) => {
+ self.composee = Some(r);
+ continue;
+ }
+ None => {
+ if ch_class == 0 {
+ self.composee = Some(ch);
+ return Some(k);
+ }
+ self.buffer.push(ch);
+ self.last_ccc = Some(ch_class);
+ }
+ },
+ Some(l_class) => {
+ if l_class >= ch_class {
+ // `ch` is blocked from `composee`
+ if ch_class == 0 {
+ self.composee = Some(ch);
+ self.last_ccc = None;
+ self.state = Purging(0);
+ return Some(k);
+ }
+ self.buffer.push(ch);
+ self.last_ccc = Some(ch_class);
+ continue;
+ }
+ match super::char::compose(k, ch) {
+ Some(r) => {
+ self.composee = Some(r);
+ continue;
+ }
+ None => {
+ self.buffer.push(ch);
+ self.last_ccc = Some(ch_class);
+ }
+ }
+ }
+ }
+ }
+ self.state = Finished(0);
+ if self.composee.is_some() {
+ return self.composee.take();
+ }
+ }
+ Purging(next) => match self.buffer.get(next).cloned() {
+ None => {
+ self.buffer.clear();
+ self.state = Composing;
+ }
+ s => {
+ self.state = Purging(next + 1);
+ return s;
+ }
+ },
+ Finished(next) => match self.buffer.get(next).cloned() {
+ None => {
+ self.buffer.clear();
+ return self.composee.take();
+ }
+ s => {
+ self.state = Finished(next + 1);
+ return s;
+ }
+ },
+ }
+ }
+ }
+}
+
+impl<I: Iterator<Item = char> + Clone> fmt::Display for Recompositions<I> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ for c in self.clone() {
+ f.write_char(c)?;
+ }
+ Ok(())
+ }
+}
diff --git a/crates/unicode-normalization/src/replace.rs b/crates/unicode-normalization/src/replace.rs
new file mode 100644
index 0000000..8d8cb42
--- /dev/null
+++ b/crates/unicode-normalization/src/replace.rs
@@ -0,0 +1,61 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+use core::fmt::{self, Write};
+use tinyvec::ArrayVec;
+
+/// External iterator for replacements for a string's characters.
+#[derive(Clone)]
+pub struct Replacements<I> {
+ iter: I,
+ // At this time, the longest replacement sequence has length 2, so we just
+ // need buffer space for 1 codepoint.
+ buffer: Option<char>,
+}
+
+#[inline]
+pub fn new_cjk_compat_variants<I: Iterator<Item = char>>(iter: I) -> Replacements<I> {
+ Replacements { iter, buffer: None }
+}
+
+impl<I: Iterator<Item = char>> Iterator for Replacements<I> {
+ type Item = char;
+
+ #[inline]
+ fn next(&mut self) -> Option<char> {
+ if let Some(c) = self.buffer.take() {
+ return Some(c);
+ }
+
+ match self.iter.next() {
+ Some(ch) => {
+ // At this time, the longest replacement sequence has length 2.
+ let mut buffer = ArrayVec::<[char; 2]>::new();
+ super::char::decompose_cjk_compat_variants(ch, |d| buffer.push(d));
+ self.buffer = buffer.get(1).copied();
+ Some(buffer[0])
+ }
+ None => None,
+ }
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let (lower, _) = self.iter.size_hint();
+ (lower, None)
+ }
+}
+
+impl<I: Iterator<Item = char> + Clone> fmt::Display for Replacements<I> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ for c in self.clone() {
+ f.write_char(c)?;
+ }
+ Ok(())
+ }
+}
diff --git a/crates/unicode-normalization/src/stream_safe.rs b/crates/unicode-normalization/src/stream_safe.rs
new file mode 100644
index 0000000..30fe810
--- /dev/null
+++ b/crates/unicode-normalization/src/stream_safe.rs
@@ -0,0 +1,170 @@
+use crate::lookups::{
+ canonical_combining_class, canonical_fully_decomposed, compatibility_fully_decomposed,
+ stream_safe_trailing_nonstarters,
+};
+use crate::normalize::{hangul_decomposition_length, is_hangul_syllable};
+use crate::tables::stream_safe_leading_nonstarters;
+
+pub(crate) const MAX_NONSTARTERS: usize = 30;
+const COMBINING_GRAPHEME_JOINER: char = '\u{034F}';
+
+/// UAX15-D4: This iterator keeps track of how many non-starters there have been
+/// since the last starter in *NFKD* and will emit a Combining Grapheme Joiner
+/// (U+034F) if the count exceeds 30.
+pub struct StreamSafe<I> {
+ iter: I,
+ nonstarter_count: usize,
+ buffer: Option<char>,
+}
+
+impl<I> StreamSafe<I> {
+ pub(crate) fn new(iter: I) -> Self {
+ Self {
+ iter,
+ nonstarter_count: 0,
+ buffer: None,
+ }
+ }
+}
+
+impl<I: Iterator<Item = char>> Iterator for StreamSafe<I> {
+ type Item = char;
+
+ #[inline]
+ fn next(&mut self) -> Option<char> {
+ let next_ch = match self.buffer.take().or_else(|| self.iter.next()) {
+ None => return None,
+ Some(c) => c,
+ };
+ let d = classify_nonstarters(next_ch);
+ if self.nonstarter_count + d.leading_nonstarters > MAX_NONSTARTERS {
+ // Since we're emitting a CGJ, the suffix of the emitted string in NFKD has no trailing
+ // nonstarters, so we can reset the counter to zero. Put `next_ch` back into the
+ // iterator (via `self.buffer`), and we'll reclassify it next iteration.
+ self.nonstarter_count = 0;
+ self.buffer = Some(next_ch);
+ return Some(COMBINING_GRAPHEME_JOINER);
+ }
+
+ // Is the character all nonstarters in NFKD? If so, increment our counter of contiguous
+ // nonstarters in NKFD.
+ if d.leading_nonstarters == d.decomposition_len {
+ self.nonstarter_count += d.decomposition_len;
+ }
+ // Otherwise, reset the counter to the decomposition's number of trailing nonstarters.
+ else {
+ self.nonstarter_count = d.trailing_nonstarters;
+ }
+ Some(next_ch)
+ }
+}
+
+#[derive(Debug)]
+pub(crate) struct Decomposition {
+ pub(crate) leading_nonstarters: usize,
+ pub(crate) trailing_nonstarters: usize,
+ pub(crate) decomposition_len: usize,
+}
+
+#[inline]
+pub(crate) fn classify_nonstarters(c: char) -> Decomposition {
+ // As usual, fast path for ASCII (which is always a starter)
+ if c <= '\x7f' {
+ return Decomposition {
+ leading_nonstarters: 0,
+ trailing_nonstarters: 0,
+ decomposition_len: 1,
+ };
+ }
+ // Next, special case Hangul, since it's not handled by our tables.
+ if is_hangul_syllable(c) {
+ return Decomposition {
+ leading_nonstarters: 0,
+ trailing_nonstarters: 0,
+ decomposition_len: hangul_decomposition_length(c),
+ };
+ }
+ let decomp = compatibility_fully_decomposed(c).or_else(|| canonical_fully_decomposed(c));
+ match decomp {
+ Some(decomp) => Decomposition {
+ leading_nonstarters: stream_safe_leading_nonstarters(c),
+ trailing_nonstarters: stream_safe_trailing_nonstarters(c),
+ decomposition_len: decomp.len(),
+ },
+ None => {
+ let is_nonstarter = canonical_combining_class(c) != 0;
+ let nonstarter = if is_nonstarter { 1 } else { 0 };
+ Decomposition {
+ leading_nonstarters: nonstarter,
+ trailing_nonstarters: nonstarter,
+ decomposition_len: 1,
+ }
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{classify_nonstarters, StreamSafe};
+ use crate::lookups::canonical_combining_class;
+ use crate::normalize::decompose_compatible;
+
+ #[cfg(not(feature = "std"))]
+ use crate::no_std_prelude::*;
+
+ use core::char;
+
+ fn stream_safe(s: &str) -> String {
+ StreamSafe::new(s.chars()).collect()
+ }
+
+ #[test]
+ fn test_simple() {
+ let technically_okay = "Da\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}ngerzone";
+ assert_eq!(stream_safe(technically_okay), technically_okay);
+
+ let too_much = "Da\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{032e}ngerzone";
+ let fixed_it = "Da\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{034f}\u{032e}ngerzone";
+ assert_eq!(stream_safe(too_much), fixed_it);
+
+ let woah_nelly = "Da\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{032e}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{032e}ngerzone";
+ let its_cool = "Da\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{031d}\u{034f}\u{032e}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{0316}\u{0317}\u{0318}\u{0319}\u{031a}\u{031b}\u{031c}\u{034f}\u{031d}\u{032e}ngerzone";
+ assert_eq!(stream_safe(woah_nelly), its_cool);
+ }
+
+ #[test]
+ fn test_all_nonstarters() {
+ let s = "\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}\u{0300}";
+ let expected = "\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{034F}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}\u{300}";
+ assert_eq!(stream_safe(s), expected);
+ }
+
+ #[test]
+ fn test_classify_nonstarters() {
+ // Highest character in the `compat_fully_decomp` table is 2FA1D
+ for ch in 0..0x2FA1E {
+ let ch = match char::from_u32(ch) {
+ Some(c) => c,
+ None => continue,
+ };
+ let c = classify_nonstarters(ch);
+ let mut s = Vec::new();
+ decompose_compatible(ch, |c| s.push(c));
+
+ assert_eq!(s.len(), c.decomposition_len);
+
+ let num_leading = s
+ .iter()
+ .take_while(|&c| canonical_combining_class(*c) != 0)
+ .count();
+ let num_trailing = s
+ .iter()
+ .rev()
+ .take_while(|&c| canonical_combining_class(*c) != 0)
+ .count();
+
+ assert_eq!(num_leading, c.leading_nonstarters);
+ assert_eq!(num_trailing, c.trailing_nonstarters);
+ }
+ }
+}
diff --git a/crates/unicode-normalization/src/tables.rs b/crates/unicode-normalization/src/tables.rs
new file mode 100644
index 0000000..4c68855
--- /dev/null
+++ b/crates/unicode-normalization/src/tables.rs
@@ -0,0 +1,37863 @@
+// Copyright 2012-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+#![allow(missing_docs)]
+use crate::quick_check::IsNormalized;
+use crate::quick_check::IsNormalized::*;
+
+#[allow(unused)]
+pub const UNICODE_VERSION: (u8, u8, u8) = (15, 0, 0);
+
+pub(crate) const CANONICAL_COMBINING_CLASS_SALT: &[u16] = &[
+ 0x0,
+ 0x1,
+ 0x224,
+ 0x197,
+ 0x4,
+ 0x0,
+ 0x6f,
+ 0x4,
+ 0xaf,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x88,
+ 0xa,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1c,
+ 0x46,
+ 0x1,
+ 0xd,
+ 0x1b,
+ 0x0,
+ 0x15,
+ 0x12,
+ 0x45,
+ 0xec,
+ 0x36,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x94,
+ 0x0,
+ 0x57,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x16,
+ 0x3a,
+ 0x2,
+ 0x23,
+ 0x3,
+ 0x4,
+ 0x1c,
+ 0x1,
+ 0x0,
+ 0x47,
+ 0x11,
+ 0x17,
+ 0x4,
+ 0x1b,
+ 0x0,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x7,
+ 0x4,
+ 0x2e,
+ 0x0,
+ 0x0,
+ 0x2c,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xf,
+ 0x0,
+ 0x0,
+ 0x13,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x1e,
+ 0x0,
+ 0x8,
+ 0x11,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x79,
+ 0x0,
+ 0x4,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x15,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x0,
+ 0x35,
+ 0x3,
+ 0x2,
+ 0x5,
+ 0x6,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x2,
+ 0x1c,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x9,
+ 0x7,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0x12,
+ 0x9,
+ 0x0,
+ 0x39,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x22,
+ 0x2,
+ 0x0,
+ 0x1b,
+ 0x13,
+ 0xc,
+ 0x14,
+ 0x6,
+ 0x4,
+ 0x5,
+ 0x13,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x18,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xf,
+ 0x10,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xf,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0xa,
+ 0xb,
+ 0x9,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x15,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x14,
+ 0x1b,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0xc,
+ 0x0,
+ 0xe,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x10,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x4,
+ 0xd,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x18,
+ 0xa,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x9,
+ 0x11,
+ 0x5,
+ 0x1,
+ 0x5,
+ 0x3,
+ 0x16,
+ 0x7,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x5,
+ 0x41,
+ 0x9,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x11,
+ 0xb,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x18,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0xb,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x4,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x8,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x10,
+ 0x6,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x6,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6,
+ 0x6,
+ 0xc,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x6,
+ 0x2,
+ 0x8,
+ 0x5,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x5,
+ 0x5,
+ 0xe,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x6,
+ 0x5,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x8,
+ 0x8,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x4,
+ 0x7,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0xd,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x7,
+ 0x3,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x8,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x8,
+ 0x4,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+];
+pub(crate) const CANONICAL_COMBINING_CLASS_KV: &[u32] = &[
+ 0x34AE6,
+ 0x2DFAE6,
+ 0x1DFADA,
+ 0x339DC,
+ 0x1DFCE9,
+ 0xA4D09,
+ 0x20D0E6,
+ 0x593E6,
+ 0x102E0DC,
+ 0x1CF4E6,
+ 0x5A2DC,
+ 0xFE26E6,
+ 0x11D4509,
+ 0x5C219,
+ 0x6EADC,
+ 0xA675E6,
+ 0x10F4EDC,
+ 0xA8EBE6,
+ 0x332DC,
+ 0xC4D09,
+ 0x741E6,
+ 0x1D171D8,
+ 0xFE2DDC,
+ 0x1DF2E6,
+ 0x1DDEE6,
+ 0xA8E1E6,
+ 0x5BB14,
+ 0x1DD5E6,
+ 0x8CEE6,
+ 0x1A7BE6,
+ 0xF7484,
+ 0xA8E6E6,
+ 0x6191F,
+ 0x114C307,
+ 0x1A79E6,
+ 0x65DE6,
+ 0x8F11C,
+ 0x1E020E6,
+ 0xA8F1E6,
+ 0x1DFDDC,
+ 0xFE25E6,
+ 0x1E947E6,
+ 0x1A75E6,
+ 0xEBA09,
+ 0x1E02AE6,
+ 0x64B1B,
+ 0x6D9E6,
+ 0x116B609,
+ 0x1DECE6,
+ 0xE3A09,
+ 0x954E6,
+ 0x2DE9E6,
+ 0x1AB3E6,
+ 0x8F3E6,
+ 0x8F7E6,
+ 0xA8E2E6,
+ 0x1E00BE6,
+ 0xFE28DC,
+ 0x20D801,
+ 0xAAB0E6,
+ 0x10F4DDC,
+ 0x825E6,
+ 0x611E6,
+ 0xAABEE6,
+ 0x820E6,
+ 0x8E8E6,
+ 0x306E6,
+ 0x2DE4E6,
+ 0x11F4109,
+ 0x111CA07,
+ 0x2CF0E6,
+ 0x1CD7DC,
+ 0x10A3ADC,
+ 0x1E131E6,
+ 0x103A09,
+ 0x73BDC,
+ 0x358E8,
+ 0x487E6,
+ 0x1AB1E6,
+ 0x11370E6,
+ 0x1CD0E6,
+ 0xA8EEE6,
+ 0x33CDC,
+ 0x20D5E6,
+ 0x819E6,
+ 0x16B30E6,
+ 0x16AF301,
+ 0x9BC07,
+ 0x1DE9E6,
+ 0x1DDAE6,
+ 0x1136BE6,
+ 0x82BE6,
+ 0x173409,
+ 0x1DDBE6,
+ 0x5B40E,
+ 0x1D16DE2,
+ 0x1D16901,
+ 0x34CE6,
+ 0x2DF0E6,
+ 0x33701,
+ 0x11373E6,
+ 0x112E907,
+ 0x1AC0DC,
+ 0x20EA01,
+ 0x33EE6,
+ 0xF7181,
+ 0x1D16801,
+ 0x346E6,
+ 0x1E8D6DC,
+ 0x1E8D0DC,
+ 0xFE2CDC,
+ 0x1CE0E6,
+ 0x8EAE6,
+ 0x20DBE6,
+ 0x16B31E6,
+ 0x735E6,
+ 0x10EFDDC,
+ 0x1D17EDC,
+ 0x11A3409,
+ 0x81FE6,
+ 0x1E01CE6,
+ 0x1DDFE6,
+ 0x20E8DC,
+ 0xABED09,
+ 0x1DE1E6,
+ 0x316DC,
+ 0x1D182DC,
+ 0x20D7E6,
+ 0x64F1F,
+ 0x8F5E6,
+ 0xD4D09,
+ 0x1AC9E6,
+ 0x110B909,
+ 0x1ABCE6,
+ 0xA67AE6,
+ 0x1D1AAE6,
+ 0x1E4EEDC,
+ 0x1E130E6,
+ 0x59FE6,
+ 0x1939DE,
+ 0x357E6,
+ 0x119E009,
+ 0x16FF006,
+ 0x733E6,
+ 0xFE29DC,
+ 0x1CF8E6,
+ 0xF8409,
+ 0x364E6,
+ 0x317DC,
+ 0x483E6,
+ 0x36CE6,
+ 0x5B10B,
+ 0x1CD2E6,
+ 0x307E6,
+ 0x65121,
+ 0x330DC,
+ 0x319DC,
+ 0x656DC,
+ 0x1DE4E6,
+ 0x952DC,
+ 0x345F0,
+ 0x2DF1E6,
+ 0x193BDC,
+ 0x659E6,
+ 0x5ABE6,
+ 0x1B73E6,
+ 0x2CF1E6,
+ 0xABC07,
+ 0xF7C82,
+ 0x1136AE6,
+ 0xA8E4E6,
+ 0x8FBE6,
+ 0x5B20C,
+ 0xFE21E6,
+ 0x2DFBE6,
+ 0x31AE8,
+ 0x738DC,
+ 0x20D301,
+ 0xFE2ADC,
+ 0x11369E6,
+ 0xF7282,
+ 0x1AC2E6,
+ 0x1D17BDC,
+ 0xF86E6,
+ 0x327CA,
+ 0x1DC0E6,
+ 0x10F48E6,
+ 0x1104609,
+ 0x1B6BE6,
+ 0x8E6DC,
+ 0x1E134E6,
+ 0x341E6,
+ 0x1DF6E8,
+ 0xA8ECE6,
+ 0x1D1ABE6,
+ 0x6ECE6,
+ 0x1E2AEE6,
+ 0x5B50F,
+ 0x1AC7E6,
+ 0x1E002E6,
+ 0xFC6DC,
+ 0x1E136E6,
+ 0x8DFE6,
+ 0x64C1C,
+ 0x658E6,
+ 0x6E1E6,
+ 0x2DE7E6,
+ 0x8CFDC,
+ 0x302E6,
+ 0x1AC4DC,
+ 0xAABFE6,
+ 0x5B913,
+ 0x1D18BDC,
+ 0x1172B09,
+ 0x2DF3E6,
+ 0x739DC,
+ 0x2DE0E6,
+ 0x1CDCDC,
+ 0x1107009,
+ 0xA92CDC,
+ 0x823E6,
+ 0x1DF3E6,
+ 0xA67DE6,
+ 0x10F46DC,
+ 0x1DCCE6,
+ 0x6DCE6,
+ 0x11A4709,
+ 0xEB976,
+ 0x36BE6,
+ 0x65EE6,
+ 0x1CF9E6,
+ 0x8D6E6,
+ 0x8E0E6,
+ 0x1B6EE6,
+ 0x8D8E6,
+ 0x1E026E6,
+ 0x343E6,
+ 0x20D901,
+ 0x1E948E6,
+ 0x5B610,
+ 0x1E011E6,
+ 0x1DE8E6,
+ 0x1DF7E4,
+ 0x2DFCE6,
+ 0x11D9709,
+ 0x486E6,
+ 0x1DC1E6,
+ 0x591DC,
+ 0x11D4409,
+ 0xA8C409,
+ 0x1BAA09,
+ 0x10EFFDC,
+ 0x6EDDC,
+ 0x356DC,
+ 0x1DEEE6,
+ 0x2DEDE6,
+ 0x64D1D,
+ 0x17D209,
+ 0xD3C09,
+ 0x1E945E6,
+ 0x114C209,
+ 0x303E6,
+ 0xA6F0E6,
+ 0x302FE0,
+ 0x1E01BE6,
+ 0x11368E6,
+ 0x1163F09,
+ 0x1CE301,
+ 0x5A3DC,
+ 0x8EFDC,
+ 0x596DC,
+ 0x1E028E6,
+ 0x10F4FDC,
+ 0xA82C09,
+ 0x1D172D8,
+ 0x2CEFE6,
+ 0x10F49E6,
+ 0xA8EAE6,
+ 0x32CDC,
+ 0xD3B09,
+ 0x1E00FE6,
+ 0x8EDDC,
+ 0x171409,
+ 0x1ABBE6,
+ 0x1E8D3DC,
+ 0xB3C07,
+ 0x59DE6,
+ 0x10AE6DC,
+ 0x1DFBE6,
+ 0x16FF106,
+ 0x82AE6,
+ 0x20EEDC,
+ 0x1CDFDC,
+ 0x1CDDDC,
+ 0x8D2DC,
+ 0x135FE6,
+ 0xF7A82,
+ 0x610E6,
+ 0x1144209,
+ 0x2DEEE6,
+ 0x1145EE6,
+ 0x73DE6,
+ 0x35DEA,
+ 0xFE2FE6,
+ 0xCBC07,
+ 0x1DC7E6,
+ 0x6E7E6,
+ 0x321CA,
+ 0x5A6DC,
+ 0xA8F0E6,
+ 0x5BA13,
+ 0x2DECE6,
+ 0x8EEDC,
+ 0x16AF201,
+ 0x5C712,
+ 0x612E6,
+ 0x59CE6,
+ 0x11D4207,
+ 0x1ABADC,
+ 0x1AB4E6,
+ 0x1E8D2DC,
+ 0x85BDC,
+ 0x1B72E6,
+ 0x1E000E6,
+ 0x5B00A,
+ 0x5C5DC,
+ 0x10F47DC,
+ 0x1A78E6,
+ 0x1113409,
+ 0x1144607,
+ 0x10D26E6,
+ 0x20DCE6,
+ 0x350E6,
+ 0xF7D82,
+ 0x31FDC,
+ 0x103909,
+ 0x8D3DC,
+ 0x1BE607,
+ 0x731DC,
+ 0x312E6,
+ 0x829E6,
+ 0x8FADC,
+ 0x7EBE6,
+ 0x1DDDE6,
+ 0x1D165D8,
+ 0x20E9E6,
+ 0x1E01EE6,
+ 0x1E135E6,
+ 0x1DEDE6,
+ 0xC565B,
+ 0x1E012E6,
+ 0x2DE3E6,
+ 0xF7B82,
+ 0x1CDEDC,
+ 0x36DE6,
+ 0x8F4E6,
+ 0x1E8D4DC,
+ 0x73CDC,
+ 0x11374E6,
+ 0x5ACE6,
+ 0x1AC8E6,
+ 0x2DEBE6,
+ 0xA92BDC,
+ 0x1117307,
+ 0x111C009,
+ 0x33601,
+ 0xF8082,
+ 0x20D4E6,
+ 0x59BDC,
+ 0x1E001E6,
+ 0x827E6,
+ 0x33401,
+ 0x31BD8,
+ 0x20D201,
+ 0x1E003E6,
+ 0x1DF0E6,
+ 0x31DDC,
+ 0x2DF4E6,
+ 0x11372E6,
+ 0x314E6,
+ 0x18A9E4,
+ 0x1136CE6,
+ 0x2DE5E6,
+ 0x1113309,
+ 0x135DE6,
+ 0x1A77E6,
+ 0xE3967,
+ 0x10D27E6,
+ 0xCCD09,
+ 0x32DDC,
+ 0x592E6,
+ 0x2DEFE6,
+ 0x8CAE6,
+ 0x2DE1E6,
+ 0x657E6,
+ 0x32BDC,
+ 0x10EACE6,
+ 0x309E6,
+ 0x730E6,
+ 0x65FDC,
+ 0x1E014E6,
+ 0x8DEE6,
+ 0x2DFEE6,
+ 0x16B33E6,
+ 0x8CDE6,
+ 0x329DC,
+ 0x8F21D,
+ 0x93C07,
+ 0x747E6,
+ 0x859DC,
+ 0x736E6,
+ 0x10A38E6,
+ 0x81DE6,
+ 0x1CD5DC,
+ 0x743E6,
+ 0x746DC,
+ 0x899DC,
+ 0x61A20,
+ 0x1CE201,
+ 0x301E6,
+ 0x1E944E6,
+ 0x1D186E6,
+ 0x6E0E6,
+ 0x1194307,
+ 0x355DC,
+ 0x6181E,
+ 0xA66FE6,
+ 0x8FFE6,
+ 0x11100E6,
+ 0x33DE6,
+ 0x1DC2DC,
+ 0x615E6,
+ 0x342E6,
+ 0x1A17E6,
+ 0x11367E6,
+ 0x10EABE6,
+ 0x6EBE6,
+ 0x1E01FE6,
+ 0xE4A6B,
+ 0x325DC,
+ 0x349DC,
+ 0xFE23E6,
+ 0x10376E6,
+ 0x2DFFE6,
+ 0x1D16FD8,
+ 0x30FE6,
+ 0x1BAB09,
+ 0x2DE2E6,
+ 0x740E6,
+ 0x1193E09,
+ 0xF39D8,
+ 0x20EFDC,
+ 0x2DE6E6,
+ 0x1D187E6,
+ 0x1DD2E6,
+ 0x10F4AE6,
+ 0x6D8E6,
+ 0x1B3407,
+ 0x2DEAE6,
+ 0xA679E6,
+ 0x10F84E6,
+ 0xF87E6,
+ 0x35FE9,
+ 0x300E6,
+ 0x7EEE6,
+ 0x2DF2E6,
+ 0x11F4209,
+ 0x73AE6,
+ 0x31EDC,
+ 0x1E00DE6,
+ 0x1DCED6,
+ 0x1AB7DC,
+ 0x1D16ED8,
+ 0x352E6,
+ 0x8F6DC,
+ 0xA677E6,
+ 0x1A7CE6,
+ 0x8E7E6,
+ 0x16B32E6,
+ 0x1DD9E6,
+ 0x1DF9DC,
+ 0x8E9DC,
+ 0x11366E6,
+ 0x1AC6E6,
+ 0x1CE701,
+ 0x1CD1E6,
+ 0x35EEA,
+ 0x16AF401,
+ 0x1AB0E6,
+ 0x34BE6,
+ 0x33BDC,
+ 0x67023,
+ 0x366E6,
+ 0x10D25E6,
+ 0x9FEE6,
+ 0xAAB4DC,
+ 0xBCD09,
+ 0x1DC9E6,
+ 0x5BD16,
+ 0x8D0DC,
+ 0x816E6,
+ 0x101FDDC,
+ 0xA3C07,
+ 0x1D17CDC,
+ 0x732E6,
+ 0x826E6,
+ 0x1133B07,
+ 0x1CD9DC,
+ 0x81EE6,
+ 0x10F83DC,
+ 0x313E6,
+ 0x1DFFDC,
+ 0x1D17FDC,
+ 0x1D16701,
+ 0x1A6009,
+ 0x1E949E6,
+ 0x10A0DDC,
+ 0x1183909,
+ 0xF19DC,
+ 0x1DE7E6,
+ 0xB4D09,
+ 0x89CE6,
+ 0x2DFDE6,
+ 0x367E6,
+ 0xA9C009,
+ 0xA67BE6,
+ 0x333DC,
+ 0x5A1E6,
+ 0x8EBE6,
+ 0x1E009E6,
+ 0x1DEFE6,
+ 0x324DC,
+ 0xFE2BDC,
+ 0xFE27DC,
+ 0x10D24E6,
+ 0x81BE6,
+ 0x1E008E6,
+ 0x1E01DE6,
+ 0xA95309,
+ 0x6DBE6,
+ 0xC5554,
+ 0x2D7F09,
+ 0x1CDAE6,
+ 0x5BC15,
+ 0x59ADE,
+ 0xA676E6,
+ 0x2DF8E6,
+ 0x20D6E6,
+ 0x5B30D,
+ 0x1D181DC,
+ 0x1ACADC,
+ 0x953E6,
+ 0x328CA,
+ 0x5A0E6,
+ 0x595E6,
+ 0x8D5E6,
+ 0x308E6,
+ 0xA674E6,
+ 0x30CE6,
+ 0x1A76E6,
+ 0x1DC6E6,
+ 0x6E2E6,
+ 0x10F4CE6,
+ 0x20F0E6,
+ 0x8CBE6,
+ 0x10A0FE6,
+ 0x135EE6,
+ 0x1B6FE6,
+ 0x1AB2E6,
+ 0x1DF8E4,
+ 0x5AADC,
+ 0x10AE5E6,
+ 0x89FE6,
+ 0x1E00CE6,
+ 0x20E501,
+ 0x8FCE6,
+ 0x65020,
+ 0x8ECE6,
+ 0x898E6,
+ 0x1E2EDE6,
+ 0x1DD7E6,
+ 0xE3867,
+ 0x89DE6,
+ 0x1B71E6,
+ 0x85ADC,
+ 0x1DC5E6,
+ 0x1D189E6,
+ 0xA69FE6,
+ 0x348DC,
+ 0x8DBE6,
+ 0x1DC4E6,
+ 0x320DC,
+ 0xA8E3E6,
+ 0x1E946E6,
+ 0x1D170D8,
+ 0xAAF609,
+ 0x1ACCE6,
+ 0x360EA,
+ 0x1ABFDC,
+ 0x1AC1E6,
+ 0x302CE8,
+ 0x2DF7E6,
+ 0xEB876,
+ 0x1E132E6,
+ 0x1DFEE6,
+ 0x33FE6,
+ 0x20EB01,
+ 0x82DE6,
+ 0x347DC,
+ 0x1123607,
+ 0xA6F1E6,
+ 0x749E6,
+ 0x17DDE6,
+ 0x7F1E6,
+ 0x617E6,
+ 0x1ACDE6,
+ 0x1DE6E6,
+ 0x8E4E6,
+ 0x351E6,
+ 0x89EE6,
+ 0x613E6,
+ 0x1DCDEA,
+ 0x655DC,
+ 0x20E1E6,
+ 0x65CDC,
+ 0x1ABDDC,
+ 0x1AB9DC,
+ 0xA678E6,
+ 0x10A3F09,
+ 0x32ADC,
+ 0xA8EDE6,
+ 0x302ADA,
+ 0x20DA01,
+ 0x30DE6,
+ 0x302BE4,
+ 0x8D7E6,
+ 0x8F01B,
+ 0x8DCE6,
+ 0x5B711,
+ 0xA80609,
+ 0x1D1ADE6,
+ 0x6E4E6,
+ 0x1DE0E6,
+ 0x5ADDE,
+ 0x1DF1E6,
+ 0x11102E6,
+ 0x1E8D5DC,
+ 0x30EE6,
+ 0x7EFE6,
+ 0x7F0E6,
+ 0x597E6,
+ 0x1E027E6,
+ 0x1E2ECE6,
+ 0x31CDC,
+ 0x315E8,
+ 0xAAB7E6,
+ 0x616E6,
+ 0x2DF6E6,
+ 0x5BF17,
+ 0x10A3901,
+ 0x653E6,
+ 0x1D166D8,
+ 0x1AC5E6,
+ 0x361EA,
+ 0x8F8E6,
+ 0x1AC3DC,
+ 0x103707,
+ 0x1123509,
+ 0x36EE6,
+ 0x1E004E6,
+ 0x1E023E6,
+ 0x368E6,
+ 0x1DD6E6,
+ 0x344E6,
+ 0x742DC,
+ 0x485E6,
+ 0x110BA07,
+ 0x1CD8DC,
+ 0x1CD401,
+ 0x8FEE6,
+ 0x2DF5E6,
+ 0x1E00EE6,
+ 0xECB7A,
+ 0x94D09,
+ 0x1DEBE6,
+ 0x1133C07,
+ 0x1E4EFE6,
+ 0x359DC,
+ 0x1E010E6,
+ 0x304E6,
+ 0x5A8E6,
+ 0x1CD6DC,
+ 0xAAB3E6,
+ 0x1B70E6,
+ 0x6E8E6,
+ 0xA92DDC,
+ 0x8D9E6,
+ 0x16B34E6,
+ 0xF18DC,
+ 0x30AE6,
+ 0x20EDDC,
+ 0x1E4ECE8,
+ 0x1E2EFE6,
+ 0x1D242E6,
+ 0x354DC,
+ 0x16AF101,
+ 0x35BE6,
+ 0x1DE3E6,
+ 0x73EDC,
+ 0x1E005E6,
+ 0x115BF09,
+ 0x1DC8E6,
+ 0x484E6,
+ 0x81CE6,
+ 0x1E133E6,
+ 0x5B812,
+ 0x340E6,
+ 0x598E6,
+ 0x1BC9E01,
+ 0x1DDCE6,
+ 0x115C007,
+ 0x8E3DC,
+ 0x11C3F09,
+ 0x10F85DC,
+ 0x35CE9,
+ 0x1CDBE6,
+ 0x1D1ACE6,
+ 0x1E8D1DC,
+ 0x1AB5DC,
+ 0xDCA09,
+ 0x322CA,
+ 0x10F4BDC,
+ 0x1DC3E6,
+ 0x35ADC,
+ 0x7ECE6,
+ 0x112EA09,
+ 0xE4B6B,
+ 0x7FDDC,
+ 0x32EDC,
+ 0x65BE6,
+ 0xFE22E6,
+ 0x1DD3E6,
+ 0x89ADC,
+ 0xA8E8E6,
+ 0x8F9DC,
+ 0x36FE6,
+ 0x1B6DE6,
+ 0x8CCE6,
+ 0x1134D09,
+ 0x193AE6,
+ 0x309A08,
+ 0xFE20E6,
+ 0x1DE2E6,
+ 0x1CEDDC,
+ 0x10EFEDC,
+ 0x1E013E6,
+ 0x8D4E6,
+ 0x34EDC,
+ 0x16B35E6,
+ 0x1037AE6,
+ 0x1107F09,
+ 0x8DDE6,
+ 0x1DD1E6,
+ 0x33801,
+ 0xA67CE6,
+ 0x1ACEE6,
+ 0x1E08FE6,
+ 0x1183A07,
+ 0x1D244E6,
+ 0x1E018E6,
+ 0xACD09,
+ 0x5A5DC,
+ 0x64E1E,
+ 0x1CE401,
+ 0xF37DC,
+ 0x745E6,
+ 0xC3C07,
+ 0x65222,
+ 0x305E6,
+ 0x33ADC,
+ 0x1DF5E6,
+ 0x1E017E6,
+ 0x1CE801,
+ 0x1193D09,
+ 0x20D1E6,
+ 0x318DC,
+ 0x822E6,
+ 0x116B707,
+ 0x310E6,
+ 0x821E6,
+ 0x10378E6,
+ 0x5A4DC,
+ 0xF83E6,
+ 0xAAC1E6,
+ 0x1DD0CA,
+ 0x1D185E6,
+ 0x8D1DC,
+ 0x5AFE6,
+ 0x1DE5E6,
+ 0x309908,
+ 0x365E6,
+ 0x951E6,
+ 0x369E6,
+ 0x748DC,
+ 0xEC97A,
+ 0x817E6,
+ 0x6DAE6,
+ 0x1E4EDE8,
+ 0x1CE501,
+ 0x737DC,
+ 0x311E6,
+ 0x6E3DC,
+ 0x1BF309,
+ 0x89BDC,
+ 0x11101E6,
+ 0x5C118,
+ 0x2DE8E6,
+ 0x614E6,
+ 0xFE2EE6,
+ 0x10379E6,
+ 0x1DCFDC,
+ 0x82CE6,
+ 0x32FDC,
+ 0x1B4409,
+ 0x171509,
+ 0x1ACBE6,
+ 0x1B6CDC,
+ 0xECA7A,
+ 0x1E015E6,
+ 0x20E601,
+ 0xFE24E6,
+ 0x1D243E6,
+ 0x1E021E6,
+ 0xE496B,
+ 0x71124,
+ 0x6DFE6,
+ 0xA9B307,
+ 0x65AE6,
+ 0x1A7FDC,
+ 0x8DAE6,
+ 0x8E1E6,
+ 0x11A9909,
+ 0x1D180DC,
+ 0xA8EFE6,
+ 0x1DF4E6,
+ 0x10377E6,
+ 0x362E9,
+ 0x594E6,
+ 0x33501,
+ 0x7F2DC,
+ 0x1D18ADC,
+ 0x1DCBE6,
+ 0x5A9E6,
+ 0x1CE601,
+ 0x34DDC,
+ 0xEC87A,
+ 0x6D7E6,
+ 0x108DDC,
+ 0x5C4E6,
+ 0x36AE6,
+ 0x326DC,
+ 0x1E00AE6,
+ 0xA8E0E6,
+ 0x5A7DC,
+ 0x1DEAE6,
+ 0x6D6E6,
+ 0xA8E7E6,
+ 0x30BE6,
+ 0x16AF001,
+ 0x1C3707,
+ 0x302EE0,
+ 0xE486B,
+ 0x1DD8E6,
+ 0x1AB8DC,
+ 0x1A18DC,
+ 0x2DF9E6,
+ 0xFB1E1A,
+ 0x363E6,
+ 0x74AE6,
+ 0x1E024E6,
+ 0x599E6,
+ 0x59EE6,
+ 0x7F3E6,
+ 0x1BF209,
+ 0x818E6,
+ 0xA8E9E6,
+ 0x16B36E6,
+ 0x10F50DC,
+ 0x1DD4E6,
+ 0xAAB2E6,
+ 0xA8E5E6,
+ 0x744DC,
+ 0x10F82E6,
+ 0x302DDE,
+ 0x331DC,
+ 0x1D188E6,
+ 0x7EDE6,
+ 0x1E006E6,
+ 0xAAB8E6,
+ 0x353DC,
+ 0x1E016E6,
+ 0x1DCADC,
+ 0x73FE6,
+ 0xF35DC,
+ 0xA69EE6,
+ 0x323DC,
+ 0x8E5E6,
+ 0x20ECDC,
+ 0x1E2EEE6,
+ 0x5AEE4,
+ 0x11371E6,
+ 0x1E029E6,
+ 0x734DC,
+ 0x1AB6DC,
+ 0x20E7E6,
+ 0x1D17DDC,
+ 0x8FDE6,
+ 0x9CD09,
+ 0xF82E6,
+ 0x1A7AE6,
+ 0x654E6,
+ 0x1E94A07,
+];
+
+
+pub(crate) const COMPOSITION_TABLE_SALT: &[u16] = &[
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x25d,
+ 0x3,
+ 0x5d,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x4,
+ 0x87,
+ 0x6,
+ 0x135,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0xe1,
+ 0x78,
+ 0x0,
+ 0x2,
+ 0x29,
+ 0x8,
+ 0x8f,
+ 0x24,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x31,
+ 0x0,
+ 0x0,
+ 0x6d,
+ 0x0,
+ 0x33,
+ 0x1,
+ 0x4c,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x7c,
+ 0x6,
+ 0x4c,
+ 0x45,
+ 0x2a,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x59,
+ 0x0,
+ 0x10,
+ 0x3,
+ 0x9,
+ 0xe,
+ 0x6,
+ 0x1,
+ 0xc,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3d,
+ 0x0,
+ 0x0,
+ 0x2a,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x20,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0xe,
+ 0x2,
+ 0x10,
+ 0x22,
+ 0x0,
+ 0x61,
+ 0x0,
+ 0x4,
+ 0x15,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xd,
+ 0x1,
+ 0x1,
+ 0x24,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x18,
+ 0x58,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x19,
+ 0x10,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x12,
+ 0x15,
+ 0x0,
+ 0xc,
+ 0x7,
+ 0x3,
+ 0x0,
+ 0x1a,
+ 0x7,
+ 0xc,
+ 0x1,
+ 0x5,
+ 0x4,
+ 0x21,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x4,
+ 0x9,
+ 0x5,
+ 0xd,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x26,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x0,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x24,
+ 0x1,
+ 0x1d,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x6,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x25,
+ 0x5,
+ 0x0,
+ 0xa,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x6,
+ 0xb,
+ 0x3,
+ 0x6,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0xf,
+ 0xe,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0xf,
+ 0x10,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x19,
+ 0x1,
+ 0xe,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0xa,
+ 0x0,
+ 0x6,
+ 0x9,
+ 0x3,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x1b,
+ 0x1,
+ 0xe,
+ 0x0,
+ 0x8,
+ 0x5,
+ 0x3,
+ 0x15,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0xb,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x16,
+ 0x0,
+ 0x10,
+ 0x3,
+ 0x4,
+ 0x11,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x12,
+ 0x1,
+ 0x4,
+ 0xa,
+ 0xb,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x1,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x6,
+ 0x8,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x13,
+ 0x4,
+ 0x19,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x9,
+ 0x6,
+ 0x4,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x5,
+ 0x8,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xe,
+ 0x10,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0xe,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x6,
+ 0x6,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x4,
+ 0x11,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0xb,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0xa,
+ 0x7,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+];
+pub(crate) const COMPOSITION_TABLE_KV: &[(u32, char)] = &[
+ (0x64A0654, '\u{0626}'),
+ (0x690309, '\u{1EC9}'),
+ (0x650306, '\u{0115}'),
+ (0x423030B, '\u{04F2}'),
+ (0x47030C, '\u{01E6}'),
+ (0x570301, '\u{1E82}'),
+ (0xC50301, '\u{01FA}'),
+ (0x21D20338, '\u{21CF}'),
+ (0x430307, '\u{010A}'),
+ (0x7A0307, '\u{017C}'),
+ (0x49030C, '\u{01CF}'),
+ (0x720307, '\u{1E59}'),
+ (0x304B3099, '\u{304C}'),
+ (0x1F610345, '\u{1FA1}'),
+ (0x410307, '\u{0226}'),
+ (0x6B0323, '\u{1E33}'),
+ (0x3990304, '\u{1FD9}'),
+ (0x1F490301, '\u{1F4D}'),
+ (0x3CA0342, '\u{1FD7}'),
+ (0x550304, '\u{016A}'),
+ (0x30DB309A, '\u{30DD}'),
+ (0x1F6E0345, '\u{1FAE}'),
+ (0x420331, '\u{1E06}'),
+ (0x41E0308, '\u{04E6}'),
+ (0x410325, '\u{1E00}'),
+ (0x520331, '\u{1E5E}'),
+ (0x1FF60345, '\u{1FF7}'),
+ (0x22720338, '\u{2274}'),
+ (0x22480338, '\u{2249}'),
+ (0x1FBF0301, '\u{1FCE}'),
+ (0x30C63099, '\u{30C7}'),
+ (0x760323, '\u{1E7F}'),
+ (0x700307, '\u{1E57}'),
+ (0x1F510301, '\u{1F55}'),
+ (0x750328, '\u{0173}'),
+ (0x305B3099, '\u{305C}'),
+ (0x41030A, '\u{00C5}'),
+ (0x1A10323, '\u{1EE3}'),
+ (0x550311, '\u{0216}'),
+ (0x530307, '\u{1E60}'),
+ (0xDC030C, '\u{01D9}'),
+ (0x4F0300, '\u{00D2}'),
+ (0x6F0307, '\u{022F}'),
+ (0x470301, '\u{01F4}'),
+ (0x610309, '\u{1EA3}'),
+ (0x1F080301, '\u{1F0C}'),
+ (0x3B90301, '\u{03AF}'),
+ (0x4330301, '\u{0453}'),
+ (0x1F200345, '\u{1F90}'),
+ (0x620307, '\u{1E03}'),
+ (0x1F030345, '\u{1F83}'),
+ (0x570308, '\u{1E84}'),
+ (0x5A0307, '\u{017B}'),
+ (0x30C13099, '\u{30C2}'),
+ (0x1A10309, '\u{1EDF}'),
+ (0x6270655, '\u{0625}'),
+ (0x3BF0314, '\u{1F41}'),
+ (0x670301, '\u{01F5}'),
+ (0x39F0301, '\u{038C}'),
+ (0xEA0301, '\u{1EBF}'),
+ (0x63030C, '\u{010D}'),
+ (0x1F000345, '\u{1F80}'),
+ (0x4130301, '\u{0403}'),
+ (0x4B0323, '\u{1E32}'),
+ (0x790301, '\u{00FD}'),
+ (0x770301, '\u{1E83}'),
+ (0x1F0E0345, '\u{1F8E}'),
+ (0x480308, '\u{1E26}'),
+ (0x30A63099, '\u{30F4}'),
+ (0x1020300, '\u{1EB0}'),
+ (0x6C0301, '\u{013A}'),
+ (0x450309, '\u{1EBA}'),
+ (0x1F390301, '\u{1F3D}'),
+ (0x690311, '\u{020B}'),
+ (0x4230304, '\u{04EE}'),
+ (0x61030C, '\u{01CE}'),
+ (0x1F100300, '\u{1F12}'),
+ (0x4380300, '\u{045D}'),
+ (0x480323, '\u{1E24}'),
+ (0x1B111B35, '\u{1B12}'),
+ (0x430301, '\u{0106}'),
+ (0x540323, '\u{1E6C}'),
+ (0x490303, '\u{0128}'),
+ (0x1EA10302, '\u{1EAD}'),
+ (0x4350308, '\u{0451}'),
+ (0x610307, '\u{0227}'),
+ (0x1F000300, '\u{1F02}'),
+ (0x6D0307, '\u{1E41}'),
+ (0x760303, '\u{1E7D}'),
+ (0x730327, '\u{015F}'),
+ (0x470304, '\u{1E20}'),
+ (0x470306, '\u{011E}'),
+ (0x1F6D0345, '\u{1FAD}'),
+ (0x6F0303, '\u{00F5}'),
+ (0x6B0331, '\u{1E35}'),
+ (0x720331, '\u{1E5F}'),
+ (0x1B00300, '\u{1EEB}'),
+ (0x1B0B1B35, '\u{1B0C}'),
+ (0x55032D, '\u{1E76}'),
+ (0x61030A, '\u{00E5}'),
+ (0x30463099, '\u{3094}'),
+ (0x1B3A1B35, '\u{1B3B}'),
+ (0x55030A, '\u{016E}'),
+ (0x928093C, '\u{0929}'),
+ (0x3C90313, '\u{1F60}'),
+ (0x650330, '\u{1E1B}'),
+ (0x590303, '\u{1EF8}'),
+ (0x450330, '\u{1E1A}'),
+ (0x640331, '\u{1E0F}'),
+ (0x3B90308, '\u{03CA}'),
+ (0x309D3099, '\u{309E}'),
+ (0x443030B, '\u{04F3}'),
+ (0xB470B3E, '\u{0B4B}'),
+ (0x6F030F, '\u{020D}'),
+ (0x6E0323, '\u{1E47}'),
+ (0x690308, '\u{00EF}'),
+ (0x65032D, '\u{1E19}'),
+ (0x15A0307, '\u{1E64}'),
+ (0x1F180301, '\u{1F1C}'),
+ (0x1F090301, '\u{1F0D}'),
+ (0x1F270345, '\u{1F97}'),
+ (0x7A0302, '\u{1E91}'),
+ (0x590301, '\u{00DD}'),
+ (0x4C0331, '\u{1E3A}'),
+ (0x1F640345, '\u{1FA4}'),
+ (0x1EB90302, '\u{1EC7}'),
+ (0x1F240345, '\u{1F94}'),
+ (0x1130300, '\u{1E15}'),
+ (0x69030F, '\u{0209}'),
+ (0x740331, '\u{1E6F}'),
+ (0x1F480301, '\u{1F4C}'),
+ (0x7A0331, '\u{1E95}'),
+ (0x1F290345, '\u{1F99}'),
+ (0xD40301, '\u{1ED0}'),
+ (0xC40304, '\u{01DE}'),
+ (0x3970301, '\u{0389}'),
+ (0x72030C, '\u{0159}'),
+ (0x1F110301, '\u{1F15}'),
+ (0xF40309, '\u{1ED5}'),
+ (0x450327, '\u{0228}'),
+ (0x6F031B, '\u{01A1}'),
+ (0xC60304, '\u{01E2}'),
+ (0x3990308, '\u{03AA}'),
+ (0x3CE0345, '\u{1FF4}'),
+ (0x6D0301, '\u{1E3F}'),
+ (0x1030309, '\u{1EB3}'),
+ (0x6F0302, '\u{00F4}'),
+ (0x73030C, '\u{0161}'),
+ (0x750301, '\u{00FA}'),
+ (0x1F690301, '\u{1F6D}'),
+ (0x3A90301, '\u{038F}'),
+ (0x3D0338, '\u{2260}'),
+ (0x1FC60345, '\u{1FC7}'),
+ (0x770300, '\u{1E81}'),
+ (0x2280306, '\u{1E1C}'),
+ (0x6C0331, '\u{1E3B}'),
+ (0x30AD3099, '\u{30AE}'),
+ (0x1EB80302, '\u{1EC6}'),
+ (0x550302, '\u{00DB}'),
+ (0xDD90DCF, '\u{0DDC}'),
+ (0x3A50304, '\u{1FE9}'),
+ (0x3A90314, '\u{1F69}'),
+ (0x740327, '\u{0163}'),
+ (0x530326, '\u{0218}'),
+ (0x55030B, '\u{0170}'),
+ (0x306F309A, '\u{3071}'),
+ (0x6B0327, '\u{0137}'),
+ (0x750330, '\u{1E75}'),
+ (0x730301, '\u{015B}'),
+ (0x1F300342, '\u{1F36}'),
+ (0x470307, '\u{0120}'),
+ (0xCC60CD5, '\u{0CC7}'),
+ (0x1F690300, '\u{1F6B}'),
+ (0x1030301, '\u{1EAF}'),
+ (0x750311, '\u{0217}'),
+ (0x930093C, '\u{0931}'),
+ (0x30613099, '\u{3062}'),
+ (0x770323, '\u{1E89}'),
+ (0xF50301, '\u{1E4D}'),
+ (0xFC0300, '\u{01DC}'),
+ (0x49030F, '\u{0208}'),
+ (0x690302, '\u{00EE}'),
+ (0x1F230345, '\u{1F93}'),
+ (0xF40300, '\u{1ED3}'),
+ (0x44B0308, '\u{04F9}'),
+ (0x1F2E0345, '\u{1F9E}'),
+ (0x650300, '\u{00E8}'),
+ (0x490308, '\u{00CF}'),
+ (0x1F280301, '\u{1F2C}'),
+ (0x1F180300, '\u{1F1A}'),
+ (0x6270653, '\u{0622}'),
+ (0x1F200301, '\u{1F24}'),
+ (0x22030338, '\u{2204}'),
+ (0x790304, '\u{0233}'),
+ (0x1F390300, '\u{1F3B}'),
+ (0x610325, '\u{1E01}'),
+ (0x790309, '\u{1EF7}'),
+ (0x1AF0303, '\u{1EEE}'),
+ (0x6F0301, '\u{00F3}'),
+ (0x640323, '\u{1E0D}'),
+ (0x304F3099, '\u{3050}'),
+ (0x1F010345, '\u{1F81}'),
+ (0xCA0309, '\u{1EC2}'),
+ (0x3D20308, '\u{03D4}'),
+ (0x1F500301, '\u{1F54}'),
+ (0x1F010300, '\u{1F03}'),
+ (0x3A90345, '\u{1FFC}'),
+ (0x4270308, '\u{04F4}'),
+ (0x530302, '\u{015C}'),
+ (0x520301, '\u{0154}'),
+ (0x450306, '\u{0114}'),
+ (0x530323, '\u{1E62}'),
+ (0x670306, '\u{011F}'),
+ (0x22760338, '\u{2278}'),
+ (0x4350300, '\u{0450}'),
+ (0x30B53099, '\u{30B6}'),
+ (0x6F030B, '\u{0151}'),
+ (0x4180304, '\u{04E2}'),
+ (0x630307, '\u{010B}'),
+ (0x3D20301, '\u{03D3}'),
+ (0x227C0338, '\u{22E0}'),
+ (0x610304, '\u{0101}'),
+ (0xA80300, '\u{1FED}'),
+ (0x440331, '\u{1E0E}'),
+ (0x650311, '\u{0207}'),
+ (0xF80301, '\u{01FF}'),
+ (0x75030C, '\u{01D4}'),
+ (0x530327, '\u{015E}'),
+ (0x30573099, '\u{3058}'),
+ (0x3B70345, '\u{1FC3}'),
+ (0x69030C, '\u{01D0}'),
+ (0x6E0327, '\u{0146}'),
+ (0x780307, '\u{1E8B}'),
+ (0x1F000342, '\u{1F06}'),
+ (0x1B00303, '\u{1EEF}'),
+ (0x470327, '\u{0122}'),
+ (0xC20309, '\u{1EA8}'),
+ (0x6C032D, '\u{1E3D}'),
+ (0x304D3099, '\u{304E}'),
+ (0x690303, '\u{0129}'),
+ (0x1AF0323, '\u{1EF0}'),
+ (0x4F0302, '\u{00D4}'),
+ (0x1020301, '\u{1EAE}'),
+ (0x4470308, '\u{04F5}'),
+ (0x22A80338, '\u{22AD}'),
+ (0x3C50300, '\u{1F7A}'),
+ (0x3910313, '\u{1F08}'),
+ (0x64032D, '\u{1E13}'),
+ (0xCF0301, '\u{1E2E}'),
+ (0x61030F, '\u{0201}'),
+ (0x1EA10306, '\u{1EB7}'),
+ (0x790323, '\u{1EF5}'),
+ (0x21900338, '\u{219A}'),
+ (0x1F250345, '\u{1F95}'),
+ (0x4F0304, '\u{014C}'),
+ (0x4F0306, '\u{014E}'),
+ (0x30B33099, '\u{30B4}'),
+ (0x440327, '\u{1E10}'),
+ (0xB920BD7, '\u{0B94}'),
+ (0x550308, '\u{00DC}'),
+ (0x650323, '\u{1EB9}'),
+ (0x307B3099, '\u{307C}'),
+ (0x4F030C, '\u{01D1}'),
+ (0x670304, '\u{1E21}'),
+ (0x6A030C, '\u{01F0}'),
+ (0x550323, '\u{1EE4}'),
+ (0x1A10301, '\u{1EDB}'),
+ (0x590323, '\u{1EF4}'),
+ (0x410300, '\u{00C0}'),
+ (0x30B93099, '\u{30BA}'),
+ (0x4230308, '\u{04F0}'),
+ (0x530301, '\u{015A}'),
+ (0x30D8309A, '\u{30DA}'),
+ (0x750309, '\u{1EE7}'),
+ (0x550330, '\u{1E74}'),
+ (0x520327, '\u{0156}'),
+ (0x4370308, '\u{04DF}'),
+ (0xCA0300, '\u{1EC0}'),
+ (0x21940338, '\u{21AE}'),
+ (0x3B10306, '\u{1FB0}'),
+ (0x1F610342, '\u{1F67}'),
+ (0x223C0338, '\u{2241}'),
+ (0x30D23099, '\u{30D3}'),
+ (0x1F6B0345, '\u{1FAB}'),
+ (0x490307, '\u{0130}'),
+ (0x410323, '\u{1EA0}'),
+ (0x550309, '\u{1EE6}'),
+ (0x75030B, '\u{0171}'),
+ (0x30533099, '\u{3054}'),
+ (0x305D3099, '\u{305E}'),
+ (0x4C0323, '\u{1E36}'),
+ (0x2260304, '\u{01E0}'),
+ (0x475030F, '\u{0477}'),
+ (0x490328, '\u{012E}'),
+ (0x1F210300, '\u{1F23}'),
+ (0x1F610301, '\u{1F65}'),
+ (0x1F210342, '\u{1F27}'),
+ (0x670302, '\u{011D}'),
+ (0x4E0301, '\u{0143}'),
+ (0x4E0303, '\u{00D1}'),
+ (0x3990300, '\u{1FDA}'),
+ (0x3BF0301, '\u{03CC}'),
+ (0x4150300, '\u{0400}'),
+ (0x3C90314, '\u{1F61}'),
+ (0x22A20338, '\u{22AC}'),
+ (0x30DB3099, '\u{30DC}'),
+ (0x3A50314, '\u{1F59}'),
+ (0x52030F, '\u{0210}'),
+ (0x4E0323, '\u{1E46}'),
+ (0x1F0D0345, '\u{1F8D}'),
+ (0x1ECD0302, '\u{1ED9}'),
+ (0xFC030C, '\u{01DA}'),
+ (0xD60304, '\u{022A}'),
+ (0x1F000301, '\u{1F04}'),
+ (0x30CF3099, '\u{30D0}'),
+ (0x4350306, '\u{04D7}'),
+ (0x220B0338, '\u{220C}'),
+ (0x590300, '\u{1EF2}'),
+ (0x4170308, '\u{04DE}'),
+ (0x6E030C, '\u{0148}'),
+ (0x4C030C, '\u{013D}'),
+ (0x1690301, '\u{1E79}'),
+ (0x4100308, '\u{04D2}'),
+ (0x1A00301, '\u{1EDA}'),
+ (0x41030F, '\u{0200}'),
+ (0x720301, '\u{0155}'),
+ (0x450303, '\u{1EBC}'),
+ (0x1B0D1B35, '\u{1B0E}'),
+ (0x1120301, '\u{1E16}'),
+ (0x4A0302, '\u{0134}'),
+ (0x3BF0300, '\u{1F78}'),
+ (0x30593099, '\u{305A}'),
+ (0x4F030B, '\u{0150}'),
+ (0x610328, '\u{0105}'),
+ (0x30D83099, '\u{30D9}'),
+ (0x1F2B0345, '\u{1F9B}'),
+ (0x1F400301, '\u{1F44}'),
+ (0x65030F, '\u{0205}'),
+ (0x3AE0345, '\u{1FC4}'),
+ (0x1680301, '\u{1E78}'),
+ (0x740326, '\u{021B}'),
+ (0x3B90342, '\u{1FD6}'),
+ (0x1F6F0345, '\u{1FAF}'),
+ (0x3A50301, '\u{038E}'),
+ (0x1F090345, '\u{1F89}'),
+ (0x550300, '\u{00D9}'),
+ (0x41030C, '\u{01CD}'),
+ (0x430327, '\u{00C7}'),
+ (0x460307, '\u{1E1E}'),
+ (0x3B50301, '\u{03AD}'),
+ (0xD470D3E, '\u{0D4B}'),
+ (0x610311, '\u{0203}'),
+ (0xD50308, '\u{1E4E}'),
+ (0x3C90300, '\u{1F7C}'),
+ (0x4430306, '\u{045E}'),
+ (0x1FFE0301, '\u{1FDE}'),
+ (0x3990301, '\u{038A}'),
+ (0x790307, '\u{1E8F}'),
+ (0x1E5A0304, '\u{1E5C}'),
+ (0x75030F, '\u{0215}'),
+ (0x9C709BE, '\u{09CB}'),
+ (0x1B071B35, '\u{1B08}'),
+ (0x690330, '\u{1E2D}'),
+ (0x307B309A, '\u{307D}'),
+ (0x30C83099, '\u{30C9}'),
+ (0x22B30338, '\u{22EB}'),
+ (0x1B00301, '\u{1EE9}'),
+ (0x790300, '\u{1EF3}'),
+ (0x570307, '\u{1E86}'),
+ (0x690328, '\u{012F}'),
+ (0x5A0323, '\u{1E92}'),
+ (0x3C50342, '\u{1FE6}'),
+ (0x4F0309, '\u{1ECE}'),
+ (0x1F290342, '\u{1F2F}'),
+ (0x1A00300, '\u{1EDC}'),
+ (0x1F2A0345, '\u{1F9A}'),
+ (0x14D0301, '\u{1E53}'),
+ (0x21D00338, '\u{21CD}'),
+ (0x550328, '\u{0172}'),
+ (0x680331, '\u{1E96}'),
+ (0x68030C, '\u{021F}'),
+ (0x4C0301, '\u{0139}'),
+ (0x22860338, '\u{2288}'),
+ (0x39F0314, '\u{1F49}'),
+ (0x3A50306, '\u{1FE8}'),
+ (0xB470B56, '\u{0B48}'),
+ (0x30753099, '\u{3076}'),
+ (0x1E5B0304, '\u{1E5D}'),
+ (0x1F6A0345, '\u{1FAA}'),
+ (0x540327, '\u{0162}'),
+ (0x1020303, '\u{1EB4}'),
+ (0x39F0313, '\u{1F48}'),
+ (0x1F090342, '\u{1F0F}'),
+ (0x4100306, '\u{04D0}'),
+ (0x14D0300, '\u{1E51}'),
+ (0x4430304, '\u{04EF}'),
+ (0x21920338, '\u{219B}'),
+ (0x22610338, '\u{2262}'),
+ (0xF50304, '\u{022D}'),
+ (0x3B90313, '\u{1F30}'),
+ (0x6F0308, '\u{00F6}'),
+ (0x730307, '\u{1E61}'),
+ (0x75031B, '\u{01B0}'),
+ (0x30B73099, '\u{30B8}'),
+ (0x1E620307, '\u{1E68}'),
+ (0x410306, '\u{0102}'),
+ (0x3970314, '\u{1F29}'),
+ (0x630302, '\u{0109}'),
+ (0x6A0302, '\u{0135}'),
+ (0xE50301, '\u{01FB}'),
+ (0x730326, '\u{0219}'),
+ (0x1F740345, '\u{1FC2}'),
+ (0x650309, '\u{1EBB}'),
+ (0x5A030C, '\u{017D}'),
+ (0x22250338, '\u{2226}'),
+ (0x3A90313, '\u{1F68}'),
+ (0x720327, '\u{0157}'),
+ (0x1F090300, '\u{1F0B}'),
+ (0x4360308, '\u{04DD}'),
+ (0x1F080345, '\u{1F88}'),
+ (0x620331, '\u{1E07}'),
+ (0x22730338, '\u{2275}'),
+ (0x560323, '\u{1E7E}'),
+ (0x4F0323, '\u{1ECC}'),
+ (0x22E0304, '\u{0230}'),
+ (0x6D50654, '\u{06C0}'),
+ (0x3B10313, '\u{1F00}'),
+ (0x4F0303, '\u{00D5}'),
+ (0x1F010301, '\u{1F05}'),
+ (0x650304, '\u{0113}'),
+ (0x450323, '\u{1EB8}'),
+ (0xBC60BBE, '\u{0BCA}'),
+ (0x22650338, '\u{2271}'),
+ (0x3910314, '\u{1F09}'),
+ (0x1120300, '\u{1E14}'),
+ (0x4E0307, '\u{1E44}'),
+ (0x680308, '\u{1E27}'),
+ (0x4F0311, '\u{020E}'),
+ (0x550303, '\u{0168}'),
+ (0x3A10314, '\u{1FEC}'),
+ (0x3B10301, '\u{03AC}'),
+ (0x55030F, '\u{0214}'),
+ (0x3E0338, '\u{226F}'),
+ (0x1610307, '\u{1E67}'),
+ (0x1F040345, '\u{1F84}'),
+ (0x450300, '\u{00C8}'),
+ (0x1B091B35, '\u{1B0A}'),
+ (0x30FD3099, '\u{30FE}'),
+ (0x1F680301, '\u{1F6C}'),
+ (0x650303, '\u{1EBD}'),
+ (0x3B90304, '\u{1FD1}'),
+ (0x9C709D7, '\u{09CC}'),
+ (0x42B0308, '\u{04F8}'),
+ (0x4E0327, '\u{0145}'),
+ (0x1F630345, '\u{1FA3}'),
+ (0x4380306, '\u{0439}'),
+ (0x3B10314, '\u{1F01}'),
+ (0x540326, '\u{021A}'),
+ (0x740307, '\u{1E6B}'),
+ (0x3C90301, '\u{03CE}'),
+ (0x3990314, '\u{1F39}'),
+ (0x30B13099, '\u{30B2}'),
+ (0x750302, '\u{00FB}'),
+ (0xCC60CD6, '\u{0CC8}'),
+ (0x30BD3099, '\u{30BE}'),
+ (0x6E0300, '\u{01F9}'),
+ (0x1F390342, '\u{1F3F}'),
+ (0x2270304, '\u{01E1}'),
+ (0x22080338, '\u{2209}'),
+ (0x4180306, '\u{0419}'),
+ (0x44030C, '\u{010E}'),
+ (0x75030A, '\u{016F}'),
+ (0x6270654, '\u{0623}'),
+ (0x750306, '\u{016D}'),
+ (0x3B70300, '\u{1F74}'),
+ (0x1F660345, '\u{1FA6}'),
+ (0x1F690345, '\u{1FA9}'),
+ (0x15B0307, '\u{1E65}'),
+ (0x1F280342, '\u{1F2E}'),
+ (0x1F700345, '\u{1FB2}'),
+ (0x1F0F0345, '\u{1F8F}'),
+ (0x540331, '\u{1E6E}'),
+ (0x227B0338, '\u{2281}'),
+ (0x22870338, '\u{2289}'),
+ (0x1F010342, '\u{1F07}'),
+ (0x3A50308, '\u{03AB}'),
+ (0x1F650345, '\u{1FA5}'),
+ (0xD40300, '\u{1ED2}'),
+ (0xF60304, '\u{022B}'),
+ (0xCBF0CD5, '\u{0CC0}'),
+ (0x1F380342, '\u{1F3E}'),
+ (0x22B20338, '\u{22EA}'),
+ (0x72030F, '\u{0211}'),
+ (0x30BF3099, '\u{30C0}'),
+ (0x4E90308, '\u{04EB}'),
+ (0x22830338, '\u{2285}'),
+ (0x3CB0300, '\u{1FE2}'),
+ (0xCA0301, '\u{1EBE}'),
+ (0x590304, '\u{0232}'),
+ (0x690301, '\u{00ED}'),
+ (0x305F3099, '\u{3060}'),
+ (0x440307, '\u{1E0A}'),
+ (0x1ECC0302, '\u{1ED8}'),
+ (0x1F210345, '\u{1F91}'),
+ (0x410311, '\u{0202}'),
+ (0x720311, '\u{0213}'),
+ (0x3A50300, '\u{1FEA}'),
+ (0x1F590300, '\u{1F5B}'),
+ (0xE40304, '\u{01DF}'),
+ (0x1F500300, '\u{1F52}'),
+ (0x224D0338, '\u{226D}'),
+ (0x6E0301, '\u{0144}'),
+ (0x75032D, '\u{1E77}'),
+ (0xF40301, '\u{1ED1}'),
+ (0x3C90342, '\u{1FF6}'),
+ (0x3B70301, '\u{03AE}'),
+ (0x6E0307, '\u{1E45}'),
+ (0x410304, '\u{0100}'),
+ (0x1F190301, '\u{1F1D}'),
+ (0x3B10304, '\u{1FB1}'),
+ (0x3078309A, '\u{307A}'),
+ (0x570323, '\u{1E88}'),
+ (0x4430308, '\u{04F1}'),
+ (0x45032D, '\u{1E18}'),
+ (0x4150308, '\u{0401}'),
+ (0x4F0328, '\u{01EA}'),
+ (0x4D90308, '\u{04DB}'),
+ (0x4060308, '\u{0407}'),
+ (0xF40303, '\u{1ED7}'),
+ (0x3B90306, '\u{1FD0}'),
+ (0x650307, '\u{0117}'),
+ (0x1F680342, '\u{1F6E}'),
+ (0x4380304, '\u{04E3}'),
+ (0x1F410300, '\u{1F43}'),
+ (0x1FFE0300, '\u{1FDD}'),
+ (0x4F0301, '\u{00D3}'),
+ (0x640327, '\u{1E11}'),
+ (0x2290306, '\u{1E1D}'),
+ (0x7A0301, '\u{017A}'),
+ (0x620323, '\u{1E05}'),
+ (0x1F7C0345, '\u{1FF2}'),
+ (0x1B00323, '\u{1EF1}'),
+ (0x1F600301, '\u{1F64}'),
+ (0x30663099, '\u{3067}'),
+ (0x22640338, '\u{2270}'),
+ (0x1F310300, '\u{1F33}'),
+ (0x610323, '\u{1EA1}'),
+ (0x1F480300, '\u{1F4A}'),
+ (0x550301, '\u{00DA}'),
+ (0xC460C56, '\u{0C48}'),
+ (0x3CA0300, '\u{1FD2}'),
+ (0x1B7030C, '\u{01EE}'),
+ (0x720323, '\u{1E5B}'),
+ (0x1F200342, '\u{1F26}'),
+ (0x4300308, '\u{04D3}'),
+ (0x22820338, '\u{2284}'),
+ (0x1F590301, '\u{1F5D}'),
+ (0x1F080342, '\u{1F0E}'),
+ (0x440323, '\u{1E0C}'),
+ (0x1025102E, '\u{1026}'),
+ (0x3910304, '\u{1FB9}'),
+ (0x4B0331, '\u{1E34}'),
+ (0x690300, '\u{00EC}'),
+ (0x48032E, '\u{1E2A}'),
+ (0x630301, '\u{0107}'),
+ (0x1F690342, '\u{1F6F}'),
+ (0x3B50313, '\u{1F10}'),
+ (0x30CF309A, '\u{30D1}'),
+ (0x4E030C, '\u{0147}'),
+ (0xB470B57, '\u{0B4C}'),
+ (0x3910301, '\u{0386}'),
+ (0x650328, '\u{0119}'),
+ (0x1FBF0300, '\u{1FCD}'),
+ (0x3B70342, '\u{1FC6}'),
+ (0x450307, '\u{0116}'),
+ (0x1F380301, '\u{1F3C}'),
+ (0x3075309A, '\u{3077}'),
+ (0x4B0301, '\u{1E30}'),
+ (0x1030300, '\u{1EB1}'),
+ (0xE20303, '\u{1EAB}'),
+ (0x410302, '\u{00C2}'),
+ (0x650308, '\u{00EB}'),
+ (0x580307, '\u{1E8A}'),
+ (0x54030C, '\u{0164}'),
+ (0x3C50313, '\u{1F50}'),
+ (0x3B50314, '\u{1F11}'),
+ (0x1B3E1B35, '\u{1B40}'),
+ (0x1F100301, '\u{1F14}'),
+ (0x3072309A, '\u{3074}'),
+ (0x1F280345, '\u{1F98}'),
+ (0x22770338, '\u{2279}'),
+ (0x227A0338, '\u{2280}'),
+ (0x470302, '\u{011C}'),
+ (0x450308, '\u{00CB}'),
+ (0x550324, '\u{1E72}'),
+ (0x1F2C0345, '\u{1F9C}'),
+ (0x4B0327, '\u{0136}'),
+ (0x490302, '\u{00CE}'),
+ (0x680302, '\u{0125}'),
+ (0x520307, '\u{1E58}'),
+ (0x610301, '\u{00E1}'),
+ (0x4B030C, '\u{01E8}'),
+ (0x490309, '\u{1EC8}'),
+ (0x6C030C, '\u{013E}'),
+ (0x4D0307, '\u{1E40}'),
+ (0x1E360304, '\u{1E38}'),
+ (0x3C50304, '\u{1FE1}'),
+ (0x79030A, '\u{1E99}'),
+ (0x3970313, '\u{1F28}'),
+ (0x54032D, '\u{1E70}'),
+ (0x1F490300, '\u{1F4B}'),
+ (0x1B421B35, '\u{1B43}'),
+ (0x3B70313, '\u{1F20}'),
+ (0xEF0301, '\u{1E2F}'),
+ (0xE70301, '\u{1E09}'),
+ (0x16A0308, '\u{1E7A}'),
+ (0xCA0303, '\u{1EC4}'),
+ (0x3B10300, '\u{1F70}'),
+ (0x6D20654, '\u{06D3}'),
+ (0x30D53099, '\u{30D6}'),
+ (0x1F2F0345, '\u{1F9F}'),
+ (0x3B50300, '\u{1F72}'),
+ (0x750324, '\u{1E73}'),
+ (0x4150306, '\u{04D6}'),
+ (0x65030C, '\u{011B}'),
+ (0x570302, '\u{0174}'),
+ (0x1EA00306, '\u{1EB6}'),
+ (0x1F070345, '\u{1F87}'),
+ (0xA80301, '\u{0385}'),
+ (0x790302, '\u{0177}'),
+ (0x6E032D, '\u{1E4B}'),
+ (0x6F030C, '\u{01D2}'),
+ (0x3C90345, '\u{1FF3}'),
+ (0x430302, '\u{0108}'),
+ (0x790303, '\u{1EF9}'),
+ (0x740323, '\u{1E6D}'),
+ (0xE20309, '\u{1EA9}'),
+ (0x1F300300, '\u{1F32}'),
+ (0x6B0301, '\u{1E31}'),
+ (0x22920338, '\u{22E3}'),
+ (0x3950314, '\u{1F19}'),
+ (0x1F290301, '\u{1F2D}'),
+ (0x450328, '\u{0118}'),
+ (0x1FB60345, '\u{1FB7}'),
+ (0xD50304, '\u{022C}'),
+ (0x4300306, '\u{04D1}'),
+ (0xF50308, '\u{1E4F}'),
+ (0x1EA00302, '\u{1EAC}'),
+ (0x1F680300, '\u{1F6A}'),
+ (0x3970300, '\u{1FCA}'),
+ (0x450301, '\u{00C9}'),
+ (0x690304, '\u{012B}'),
+ (0xBC60BD7, '\u{0BCC}'),
+ (0x6F0304, '\u{014D}'),
+ (0x4F0308, '\u{00D6}'),
+ (0xBC70BBE, '\u{0BCB}'),
+ (0x55030C, '\u{01D3}'),
+ (0x3AC0345, '\u{1FB4}'),
+ (0x1FBF0342, '\u{1FCF}'),
+ (0x30D2309A, '\u{30D4}'),
+ (0x660307, '\u{1E1F}'),
+ (0x4E0300, '\u{01F8}'),
+ (0x790308, '\u{00FF}'),
+ (0x68032E, '\u{1E2B}'),
+ (0x64030C, '\u{010F}'),
+ (0x4F0307, '\u{022E}'),
+ (0x1F590342, '\u{1F5F}'),
+ (0x30AF3099, '\u{30B0}'),
+ (0xE60304, '\u{01E3}'),
+ (0x3C50301, '\u{03CD}'),
+ (0x770308, '\u{1E85}'),
+ (0x3B90314, '\u{1F31}'),
+ (0x750323, '\u{1EE5}'),
+ (0x590309, '\u{1EF6}'),
+ (0x292030C, '\u{01EF}'),
+ (0x550306, '\u{016C}'),
+ (0xE60301, '\u{01FD}'),
+ (0x16B0308, '\u{1E7B}'),
+ (0x4F030F, '\u{020C}'),
+ (0x3BF0313, '\u{1F40}'),
+ (0xD80301, '\u{01FE}'),
+ (0xC20303, '\u{1EAA}'),
+ (0x1F510300, '\u{1F53}'),
+ (0x1B00309, '\u{1EED}'),
+ (0x4E032D, '\u{1E4A}'),
+ (0x6F0309, '\u{1ECF}'),
+ (0x4180300, '\u{040D}'),
+ (0x22A90338, '\u{22AE}'),
+ (0x1F680345, '\u{1FA8}'),
+ (0x1B3C1B35, '\u{1B3D}'),
+ (0x1F400300, '\u{1F42}'),
+ (0x1F0B0345, '\u{1F8B}'),
+ (0x3C50306, '\u{1FE0}'),
+ (0x44032D, '\u{1E12}'),
+ (0xCCA0CD5, '\u{0CCB}'),
+ (0xEA0303, '\u{1EC5}'),
+ (0x4230306, '\u{040E}'),
+ (0xC70301, '\u{1E08}'),
+ (0x7A030C, '\u{017E}'),
+ (0x670307, '\u{0121}'),
+ (0x450311, '\u{0206}'),
+ (0x6F0300, '\u{00F2}'),
+ (0x30BB3099, '\u{30BC}'),
+ (0x4180308, '\u{04E4}'),
+ (0x30513099, '\u{3052}'),
+ (0x6C0323, '\u{1E37}'),
+ (0x3B70314, '\u{1F21}'),
+ (0x77030A, '\u{1E98}'),
+ (0x690323, '\u{1ECB}'),
+ (0x610303, '\u{00E3}'),
+ (0x30F13099, '\u{30F9}'),
+ (0x3B10345, '\u{1FB3}'),
+ (0xD460D3E, '\u{0D4A}'),
+ (0x3B90300, '\u{1F76}'),
+ (0x21D40338, '\u{21CE}'),
+ (0x1F620345, '\u{1FA2}'),
+ (0x770302, '\u{0175}'),
+ (0xFC0304, '\u{01D6}'),
+ (0x1130301, '\u{1E17}'),
+ (0x30683099, '\u{3069}'),
+ (0x1F600342, '\u{1F66}'),
+ (0x680323, '\u{1E25}'),
+ (0x3950313, '\u{1F18}'),
+ (0xEA0300, '\u{1EC1}'),
+ (0x3CB0342, '\u{1FE7}'),
+ (0x22430338, '\u{2244}'),
+ (0x30783099, '\u{3079}'),
+ (0x3990313, '\u{1F38}'),
+ (0x490330, '\u{1E2C}'),
+ (0x770307, '\u{1E87}'),
+ (0x650301, '\u{00E9}'),
+ (0x680327, '\u{1E29}'),
+ (0x22B50338, '\u{22ED}'),
+ (0x3B10342, '\u{1FB6}'),
+ (0x3910306, '\u{1FB8}'),
+ (0x4D0301, '\u{1E3E}'),
+ (0x410309, '\u{1EA2}'),
+ (0x1B051B35, '\u{1B06}'),
+ (0x3C0338, '\u{226E}'),
+ (0x590308, '\u{0178}'),
+ (0x1030303, '\u{1EB5}'),
+ (0x480327, '\u{1E28}'),
+ (0x6D0323, '\u{1E43}'),
+ (0x30643099, '\u{3065}'),
+ (0x4560308, '\u{0457}'),
+ (0x590302, '\u{0176}'),
+ (0x6C10654, '\u{06C2}'),
+ (0x43A0301, '\u{045C}'),
+ (0xE20300, '\u{1EA7}'),
+ (0x3950301, '\u{0388}'),
+ (0x630327, '\u{00E7}'),
+ (0x17F0307, '\u{1E9B}'),
+ (0x6480654, '\u{0624}'),
+ (0x30AB3099, '\u{30AC}'),
+ (0x1A00323, '\u{1EE2}'),
+ (0x4D80308, '\u{04DA}'),
+ (0x5A0331, '\u{1E94}'),
+ (0x67030C, '\u{01E7}'),
+ (0x39F0300, '\u{1FF8}'),
+ (0x650327, '\u{0229}'),
+ (0x490323, '\u{1ECA}'),
+ (0x1F110300, '\u{1F13}'),
+ (0x1F510342, '\u{1F57}'),
+ (0x4D0323, '\u{1E42}'),
+ (0x1F300301, '\u{1F34}'),
+ (0x6C0327, '\u{013C}'),
+ (0x1F050345, '\u{1F85}'),
+ (0x1A10300, '\u{1EDD}'),
+ (0x4160308, '\u{04DC}'),
+ (0x640307, '\u{1E0B}'),
+ (0x4C032D, '\u{1E3C}'),
+ (0x3C10314, '\u{1FE5}'),
+ (0x1EA0304, '\u{01EC}'),
+ (0x1F080300, '\u{1F0A}'),
+ (0x650302, '\u{00EA}'),
+ (0x3910300, '\u{1FBA}'),
+ (0x700301, '\u{1E55}'),
+ (0x1F020345, '\u{1F82}'),
+ (0x1020309, '\u{1EB2}'),
+ (0x750303, '\u{0169}'),
+ (0x1F0C0345, '\u{1F8C}'),
+ (0x3CB0301, '\u{03B0}'),
+ (0x740308, '\u{1E97}'),
+ (0x3950300, '\u{1FC8}'),
+ (0x227D0338, '\u{22E1}'),
+ (0x7A0323, '\u{1E93}'),
+ (0x6F0311, '\u{020F}'),
+ (0x6F0328, '\u{01EB}'),
+ (0x1F200300, '\u{1F22}'),
+ (0x1F190300, '\u{1F1B}'),
+ (0x560303, '\u{1E7C}'),
+ (0x6B030C, '\u{01E9}'),
+ (0x4E80308, '\u{04EA}'),
+ (0x3A90300, '\u{1FFA}'),
+ (0xA80342, '\u{1FC1}'),
+ (0x4360306, '\u{04C2}'),
+ (0xDC0301, '\u{01D7}'),
+ (0x750304, '\u{016B}'),
+ (0x22450338, '\u{2247}'),
+ (0x490304, '\u{012A}'),
+ (0x4380308, '\u{04E5}'),
+ (0xD460D57, '\u{0D4C}'),
+ (0x750300, '\u{00F9}'),
+ (0x22B40338, '\u{22EC}'),
+ (0x750308, '\u{00FC}'),
+ (0x3C50314, '\u{1F51}'),
+ (0x1600307, '\u{1E66}'),
+ (0x4160306, '\u{04C1}'),
+ (0x55031B, '\u{01AF}'),
+ (0x22AB0338, '\u{22AF}'),
+ (0x14C0300, '\u{1E50}'),
+ (0x1F310342, '\u{1F37}'),
+ (0x1F260345, '\u{1F96}'),
+ (0x22910338, '\u{22E2}'),
+ (0x500301, '\u{1E54}'),
+ (0x4C0327, '\u{013B}'),
+ (0x5A0301, '\u{0179}'),
+ (0x420307, '\u{1E02}'),
+ (0x3C10313, '\u{1FE4}'),
+ (0x1F410301, '\u{1F45}'),
+ (0x500307, '\u{1E56}'),
+ (0x43030C, '\u{010C}'),
+ (0x730323, '\u{1E63}'),
+ (0x30553099, '\u{3056}'),
+ (0x306F3099, '\u{3070}'),
+ (0x44D0308, '\u{04ED}'),
+ (0x1F670345, '\u{1FA7}'),
+ (0x1AF0301, '\u{1EE8}'),
+ (0x1F290300, '\u{1F2B}'),
+ (0x1B3F1B35, '\u{1B41}'),
+ (0x450302, '\u{00CA}'),
+ (0x6F0306, '\u{014F}'),
+ (0xFC0301, '\u{01D8}'),
+ (0x30F23099, '\u{30FA}'),
+ (0x1F2D0345, '\u{1F9D}'),
+ (0x14C0301, '\u{1E52}'),
+ (0x610308, '\u{00E4}'),
+ (0x1F600345, '\u{1FA0}'),
+ (0x1F0A0345, '\u{1F8A}'),
+ (0x610306, '\u{0103}'),
+ (0x1F600300, '\u{1F62}'),
+ (0x1AF0300, '\u{1EEA}'),
+ (0x43E0308, '\u{04E7}'),
+ (0x22230338, '\u{2224}'),
+ (0x3CA0301, '\u{0390}'),
+ (0x30D5309A, '\u{30D7}'),
+ (0x1F220345, '\u{1F92}'),
+ (0xD50301, '\u{1E4C}'),
+ (0x1F6C0345, '\u{1FAC}'),
+ (0x540307, '\u{1E6A}'),
+ (0x1E370304, '\u{1E39}'),
+ (0xDD90DCA, '\u{0DDA}'),
+ (0x1A10303, '\u{1EE1}'),
+ (0x48030C, '\u{021E}'),
+ (0xEA0309, '\u{1EC3}'),
+ (0x52030C, '\u{0158}'),
+ (0xD40303, '\u{1ED6}'),
+ (0x45030C, '\u{011A}'),
+ (0x30EF3099, '\u{30F7}'),
+ (0x480302, '\u{0124}'),
+ (0x520323, '\u{1E5A}'),
+ (0xC20300, '\u{1EA6}'),
+ (0x74032D, '\u{1E71}'),
+ (0x42D0308, '\u{04EC}'),
+ (0xDD90DDF, '\u{0DDE}'),
+ (0x410308, '\u{00C4}'),
+ (0x474030F, '\u{0476}'),
+ (0xC60301, '\u{01FC}'),
+ (0x1F310301, '\u{1F35}'),
+ (0x1F610300, '\u{1F63}'),
+ (0xCC60CC2, '\u{0CCA}'),
+ (0xC20301, '\u{1EA4}'),
+ (0x3C50308, '\u{03CB}'),
+ (0xE20301, '\u{1EA5}'),
+ (0x1F500342, '\u{1F56}'),
+ (0x610300, '\u{00E0}'),
+ (0x490311, '\u{020A}'),
+ (0x670327, '\u{0123}'),
+ (0x590307, '\u{1E8E}'),
+ (0x3970345, '\u{1FCC}'),
+ (0xD40309, '\u{1ED4}'),
+ (0x1A00303, '\u{1EE0}'),
+ (0x1FFE0342, '\u{1FDF}'),
+ (0x41A0301, '\u{040C}'),
+ (0x74030C, '\u{0165}'),
+ (0xDC0300, '\u{01DB}'),
+ (0x780308, '\u{1E8D}'),
+ (0xDC0304, '\u{01D5}'),
+ (0x610302, '\u{00E2}'),
+ (0x5A0302, '\u{1E90}'),
+ (0x933093C, '\u{0934}'),
+ (0x4F031B, '\u{01A0}'),
+ (0x520311, '\u{0212}'),
+ (0x6E0303, '\u{00F1}'),
+ (0x45030F, '\u{0204}'),
+ (0x1AF0309, '\u{1EEC}'),
+ (0x450304, '\u{0112}'),
+ (0x1F210301, '\u{1F25}'),
+ (0x22F0304, '\u{0231}'),
+ (0x3990306, '\u{1FD8}'),
+ (0x4E0331, '\u{1E48}'),
+ (0x1F380300, '\u{1F3A}'),
+ (0x490306, '\u{012C}'),
+ (0x690306, '\u{012D}'),
+ (0x1F060345, '\u{1F86}'),
+ (0x490301, '\u{00CD}'),
+ (0x570300, '\u{1E80}'),
+ (0x30F03099, '\u{30F8}'),
+ (0x53030C, '\u{0160}'),
+ (0x490300, '\u{00CC}'),
+ (0x30723099, '\u{3073}'),
+ (0x1F280300, '\u{1F2A}'),
+ (0x480307, '\u{1E22}'),
+ (0x1A00309, '\u{1EDE}'),
+ (0x1EB0304, '\u{01ED}'),
+ (0x1E630307, '\u{1E69}'),
+ (0x6F0323, '\u{1ECD}'),
+ (0x410303, '\u{00C3}'),
+ (0x3910345, '\u{1FBC}'),
+ (0x410328, '\u{0104}'),
+ (0x680307, '\u{1E23}'),
+ (0x6E0331, '\u{1E49}'),
+ (0xDDC0DCA, '\u{0DDD}'),
+ (0x580308, '\u{1E8C}'),
+ (0x410301, '\u{00C1}'),
+ (0x30C43099, '\u{30C5}'),
+ (0x420323, '\u{1E04}'),
+ (0x730302, '\u{015D}'),
+];
+
+pub(crate) fn composition_table_astral(c1: char, c2: char) -> Option<char> {
+ match (c1, c2) {
+ ('\u{11099}', '\u{110BA}') => Some('\u{1109A}'),
+ ('\u{1109B}', '\u{110BA}') => Some('\u{1109C}'),
+ ('\u{110A5}', '\u{110BA}') => Some('\u{110AB}'),
+ ('\u{11131}', '\u{11127}') => Some('\u{1112E}'),
+ ('\u{11132}', '\u{11127}') => Some('\u{1112F}'),
+ ('\u{11347}', '\u{1133E}') => Some('\u{1134B}'),
+ ('\u{11347}', '\u{11357}') => Some('\u{1134C}'),
+ ('\u{114B9}', '\u{114B0}') => Some('\u{114BC}'),
+ ('\u{114B9}', '\u{114BA}') => Some('\u{114BB}'),
+ ('\u{114B9}', '\u{114BD}') => Some('\u{114BE}'),
+ ('\u{115B8}', '\u{115AF}') => Some('\u{115BA}'),
+ ('\u{115B9}', '\u{115AF}') => Some('\u{115BB}'),
+ ('\u{11935}', '\u{11930}') => Some('\u{11938}'),
+ _ => None,
+ }
+}
+
+pub(crate) const CANONICAL_DECOMPOSED_CHARS: &[char] = &[
+ '\u{0041}',
+ '\u{0300}',
+ '\u{0041}',
+ '\u{0301}',
+ '\u{0041}',
+ '\u{0302}',
+ '\u{0041}',
+ '\u{0303}',
+ '\u{0041}',
+ '\u{0308}',
+ '\u{0041}',
+ '\u{030A}',
+ '\u{0043}',
+ '\u{0327}',
+ '\u{0045}',
+ '\u{0300}',
+ '\u{0045}',
+ '\u{0301}',
+ '\u{0045}',
+ '\u{0302}',
+ '\u{0045}',
+ '\u{0308}',
+ '\u{0049}',
+ '\u{0300}',
+ '\u{0049}',
+ '\u{0301}',
+ '\u{0049}',
+ '\u{0302}',
+ '\u{0049}',
+ '\u{0308}',
+ '\u{004E}',
+ '\u{0303}',
+ '\u{004F}',
+ '\u{0300}',
+ '\u{004F}',
+ '\u{0301}',
+ '\u{004F}',
+ '\u{0302}',
+ '\u{004F}',
+ '\u{0303}',
+ '\u{004F}',
+ '\u{0308}',
+ '\u{0055}',
+ '\u{0300}',
+ '\u{0055}',
+ '\u{0301}',
+ '\u{0055}',
+ '\u{0302}',
+ '\u{0055}',
+ '\u{0308}',
+ '\u{0059}',
+ '\u{0301}',
+ '\u{0061}',
+ '\u{0300}',
+ '\u{0061}',
+ '\u{0301}',
+ '\u{0061}',
+ '\u{0302}',
+ '\u{0061}',
+ '\u{0303}',
+ '\u{0061}',
+ '\u{0308}',
+ '\u{0061}',
+ '\u{030A}',
+ '\u{0063}',
+ '\u{0327}',
+ '\u{0065}',
+ '\u{0300}',
+ '\u{0065}',
+ '\u{0301}',
+ '\u{0065}',
+ '\u{0302}',
+ '\u{0065}',
+ '\u{0308}',
+ '\u{0069}',
+ '\u{0300}',
+ '\u{0069}',
+ '\u{0301}',
+ '\u{0069}',
+ '\u{0302}',
+ '\u{0069}',
+ '\u{0308}',
+ '\u{006E}',
+ '\u{0303}',
+ '\u{006F}',
+ '\u{0300}',
+ '\u{006F}',
+ '\u{0301}',
+ '\u{006F}',
+ '\u{0302}',
+ '\u{006F}',
+ '\u{0303}',
+ '\u{006F}',
+ '\u{0308}',
+ '\u{0075}',
+ '\u{0300}',
+ '\u{0075}',
+ '\u{0301}',
+ '\u{0075}',
+ '\u{0302}',
+ '\u{0075}',
+ '\u{0308}',
+ '\u{0079}',
+ '\u{0301}',
+ '\u{0079}',
+ '\u{0308}',
+ '\u{0041}',
+ '\u{0304}',
+ '\u{0061}',
+ '\u{0304}',
+ '\u{0041}',
+ '\u{0306}',
+ '\u{0061}',
+ '\u{0306}',
+ '\u{0041}',
+ '\u{0328}',
+ '\u{0061}',
+ '\u{0328}',
+ '\u{0043}',
+ '\u{0301}',
+ '\u{0063}',
+ '\u{0301}',
+ '\u{0043}',
+ '\u{0302}',
+ '\u{0063}',
+ '\u{0302}',
+ '\u{0043}',
+ '\u{0307}',
+ '\u{0063}',
+ '\u{0307}',
+ '\u{0043}',
+ '\u{030C}',
+ '\u{0063}',
+ '\u{030C}',
+ '\u{0044}',
+ '\u{030C}',
+ '\u{0064}',
+ '\u{030C}',
+ '\u{0045}',
+ '\u{0304}',
+ '\u{0065}',
+ '\u{0304}',
+ '\u{0045}',
+ '\u{0306}',
+ '\u{0065}',
+ '\u{0306}',
+ '\u{0045}',
+ '\u{0307}',
+ '\u{0065}',
+ '\u{0307}',
+ '\u{0045}',
+ '\u{0328}',
+ '\u{0065}',
+ '\u{0328}',
+ '\u{0045}',
+ '\u{030C}',
+ '\u{0065}',
+ '\u{030C}',
+ '\u{0047}',
+ '\u{0302}',
+ '\u{0067}',
+ '\u{0302}',
+ '\u{0047}',
+ '\u{0306}',
+ '\u{0067}',
+ '\u{0306}',
+ '\u{0047}',
+ '\u{0307}',
+ '\u{0067}',
+ '\u{0307}',
+ '\u{0047}',
+ '\u{0327}',
+ '\u{0067}',
+ '\u{0327}',
+ '\u{0048}',
+ '\u{0302}',
+ '\u{0068}',
+ '\u{0302}',
+ '\u{0049}',
+ '\u{0303}',
+ '\u{0069}',
+ '\u{0303}',
+ '\u{0049}',
+ '\u{0304}',
+ '\u{0069}',
+ '\u{0304}',
+ '\u{0049}',
+ '\u{0306}',
+ '\u{0069}',
+ '\u{0306}',
+ '\u{0049}',
+ '\u{0328}',
+ '\u{0069}',
+ '\u{0328}',
+ '\u{0049}',
+ '\u{0307}',
+ '\u{004A}',
+ '\u{0302}',
+ '\u{006A}',
+ '\u{0302}',
+ '\u{004B}',
+ '\u{0327}',
+ '\u{006B}',
+ '\u{0327}',
+ '\u{004C}',
+ '\u{0301}',
+ '\u{006C}',
+ '\u{0301}',
+ '\u{004C}',
+ '\u{0327}',
+ '\u{006C}',
+ '\u{0327}',
+ '\u{004C}',
+ '\u{030C}',
+ '\u{006C}',
+ '\u{030C}',
+ '\u{004E}',
+ '\u{0301}',
+ '\u{006E}',
+ '\u{0301}',
+ '\u{004E}',
+ '\u{0327}',
+ '\u{006E}',
+ '\u{0327}',
+ '\u{004E}',
+ '\u{030C}',
+ '\u{006E}',
+ '\u{030C}',
+ '\u{004F}',
+ '\u{0304}',
+ '\u{006F}',
+ '\u{0304}',
+ '\u{004F}',
+ '\u{0306}',
+ '\u{006F}',
+ '\u{0306}',
+ '\u{004F}',
+ '\u{030B}',
+ '\u{006F}',
+ '\u{030B}',
+ '\u{0052}',
+ '\u{0301}',
+ '\u{0072}',
+ '\u{0301}',
+ '\u{0052}',
+ '\u{0327}',
+ '\u{0072}',
+ '\u{0327}',
+ '\u{0052}',
+ '\u{030C}',
+ '\u{0072}',
+ '\u{030C}',
+ '\u{0053}',
+ '\u{0301}',
+ '\u{0073}',
+ '\u{0301}',
+ '\u{0053}',
+ '\u{0302}',
+ '\u{0073}',
+ '\u{0302}',
+ '\u{0053}',
+ '\u{0327}',
+ '\u{0073}',
+ '\u{0327}',
+ '\u{0053}',
+ '\u{030C}',
+ '\u{0073}',
+ '\u{030C}',
+ '\u{0054}',
+ '\u{0327}',
+ '\u{0074}',
+ '\u{0327}',
+ '\u{0054}',
+ '\u{030C}',
+ '\u{0074}',
+ '\u{030C}',
+ '\u{0055}',
+ '\u{0303}',
+ '\u{0075}',
+ '\u{0303}',
+ '\u{0055}',
+ '\u{0304}',
+ '\u{0075}',
+ '\u{0304}',
+ '\u{0055}',
+ '\u{0306}',
+ '\u{0075}',
+ '\u{0306}',
+ '\u{0055}',
+ '\u{030A}',
+ '\u{0075}',
+ '\u{030A}',
+ '\u{0055}',
+ '\u{030B}',
+ '\u{0075}',
+ '\u{030B}',
+ '\u{0055}',
+ '\u{0328}',
+ '\u{0075}',
+ '\u{0328}',
+ '\u{0057}',
+ '\u{0302}',
+ '\u{0077}',
+ '\u{0302}',
+ '\u{0059}',
+ '\u{0302}',
+ '\u{0079}',
+ '\u{0302}',
+ '\u{0059}',
+ '\u{0308}',
+ '\u{005A}',
+ '\u{0301}',
+ '\u{007A}',
+ '\u{0301}',
+ '\u{005A}',
+ '\u{0307}',
+ '\u{007A}',
+ '\u{0307}',
+ '\u{005A}',
+ '\u{030C}',
+ '\u{007A}',
+ '\u{030C}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0041}',
+ '\u{030C}',
+ '\u{0061}',
+ '\u{030C}',
+ '\u{0049}',
+ '\u{030C}',
+ '\u{0069}',
+ '\u{030C}',
+ '\u{004F}',
+ '\u{030C}',
+ '\u{006F}',
+ '\u{030C}',
+ '\u{0055}',
+ '\u{030C}',
+ '\u{0075}',
+ '\u{030C}',
+ '\u{0055}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{0075}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{0055}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{0075}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{0055}',
+ '\u{0308}',
+ '\u{030C}',
+ '\u{0075}',
+ '\u{0308}',
+ '\u{030C}',
+ '\u{0055}',
+ '\u{0308}',
+ '\u{0300}',
+ '\u{0075}',
+ '\u{0308}',
+ '\u{0300}',
+ '\u{0041}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{0061}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{0041}',
+ '\u{0307}',
+ '\u{0304}',
+ '\u{0061}',
+ '\u{0307}',
+ '\u{0304}',
+ '\u{00C6}',
+ '\u{0304}',
+ '\u{00E6}',
+ '\u{0304}',
+ '\u{0047}',
+ '\u{030C}',
+ '\u{0067}',
+ '\u{030C}',
+ '\u{004B}',
+ '\u{030C}',
+ '\u{006B}',
+ '\u{030C}',
+ '\u{004F}',
+ '\u{0328}',
+ '\u{006F}',
+ '\u{0328}',
+ '\u{004F}',
+ '\u{0328}',
+ '\u{0304}',
+ '\u{006F}',
+ '\u{0328}',
+ '\u{0304}',
+ '\u{01B7}',
+ '\u{030C}',
+ '\u{0292}',
+ '\u{030C}',
+ '\u{006A}',
+ '\u{030C}',
+ '\u{0047}',
+ '\u{0301}',
+ '\u{0067}',
+ '\u{0301}',
+ '\u{004E}',
+ '\u{0300}',
+ '\u{006E}',
+ '\u{0300}',
+ '\u{0041}',
+ '\u{030A}',
+ '\u{0301}',
+ '\u{0061}',
+ '\u{030A}',
+ '\u{0301}',
+ '\u{00C6}',
+ '\u{0301}',
+ '\u{00E6}',
+ '\u{0301}',
+ '\u{00D8}',
+ '\u{0301}',
+ '\u{00F8}',
+ '\u{0301}',
+ '\u{0041}',
+ '\u{030F}',
+ '\u{0061}',
+ '\u{030F}',
+ '\u{0041}',
+ '\u{0311}',
+ '\u{0061}',
+ '\u{0311}',
+ '\u{0045}',
+ '\u{030F}',
+ '\u{0065}',
+ '\u{030F}',
+ '\u{0045}',
+ '\u{0311}',
+ '\u{0065}',
+ '\u{0311}',
+ '\u{0049}',
+ '\u{030F}',
+ '\u{0069}',
+ '\u{030F}',
+ '\u{0049}',
+ '\u{0311}',
+ '\u{0069}',
+ '\u{0311}',
+ '\u{004F}',
+ '\u{030F}',
+ '\u{006F}',
+ '\u{030F}',
+ '\u{004F}',
+ '\u{0311}',
+ '\u{006F}',
+ '\u{0311}',
+ '\u{0052}',
+ '\u{030F}',
+ '\u{0072}',
+ '\u{030F}',
+ '\u{0052}',
+ '\u{0311}',
+ '\u{0072}',
+ '\u{0311}',
+ '\u{0055}',
+ '\u{030F}',
+ '\u{0075}',
+ '\u{030F}',
+ '\u{0055}',
+ '\u{0311}',
+ '\u{0075}',
+ '\u{0311}',
+ '\u{0053}',
+ '\u{0326}',
+ '\u{0073}',
+ '\u{0326}',
+ '\u{0054}',
+ '\u{0326}',
+ '\u{0074}',
+ '\u{0326}',
+ '\u{0048}',
+ '\u{030C}',
+ '\u{0068}',
+ '\u{030C}',
+ '\u{0041}',
+ '\u{0307}',
+ '\u{0061}',
+ '\u{0307}',
+ '\u{0045}',
+ '\u{0327}',
+ '\u{0065}',
+ '\u{0327}',
+ '\u{004F}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{006F}',
+ '\u{0308}',
+ '\u{0304}',
+ '\u{004F}',
+ '\u{0303}',
+ '\u{0304}',
+ '\u{006F}',
+ '\u{0303}',
+ '\u{0304}',
+ '\u{004F}',
+ '\u{0307}',
+ '\u{006F}',
+ '\u{0307}',
+ '\u{004F}',
+ '\u{0307}',
+ '\u{0304}',
+ '\u{006F}',
+ '\u{0307}',
+ '\u{0304}',
+ '\u{0059}',
+ '\u{0304}',
+ '\u{0079}',
+ '\u{0304}',
+ '\u{0300}',
+ '\u{0301}',
+ '\u{0313}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{02B9}',
+ '\u{003B}',
+ '\u{00A8}',
+ '\u{0301}',
+ '\u{0391}',
+ '\u{0301}',
+ '\u{00B7}',
+ '\u{0395}',
+ '\u{0301}',
+ '\u{0397}',
+ '\u{0301}',
+ '\u{0399}',
+ '\u{0301}',
+ '\u{039F}',
+ '\u{0301}',
+ '\u{03A5}',
+ '\u{0301}',
+ '\u{03A9}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{0399}',
+ '\u{0308}',
+ '\u{03A5}',
+ '\u{0308}',
+ '\u{03B1}',
+ '\u{0301}',
+ '\u{03B5}',
+ '\u{0301}',
+ '\u{03B7}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0308}',
+ '\u{03C5}',
+ '\u{0308}',
+ '\u{03BF}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0301}',
+ '\u{03C9}',
+ '\u{0301}',
+ '\u{03D2}',
+ '\u{0301}',
+ '\u{03D2}',
+ '\u{0308}',
+ '\u{0415}',
+ '\u{0300}',
+ '\u{0415}',
+ '\u{0308}',
+ '\u{0413}',
+ '\u{0301}',
+ '\u{0406}',
+ '\u{0308}',
+ '\u{041A}',
+ '\u{0301}',
+ '\u{0418}',
+ '\u{0300}',
+ '\u{0423}',
+ '\u{0306}',
+ '\u{0418}',
+ '\u{0306}',
+ '\u{0438}',
+ '\u{0306}',
+ '\u{0435}',
+ '\u{0300}',
+ '\u{0435}',
+ '\u{0308}',
+ '\u{0433}',
+ '\u{0301}',
+ '\u{0456}',
+ '\u{0308}',
+ '\u{043A}',
+ '\u{0301}',
+ '\u{0438}',
+ '\u{0300}',
+ '\u{0443}',
+ '\u{0306}',
+ '\u{0474}',
+ '\u{030F}',
+ '\u{0475}',
+ '\u{030F}',
+ '\u{0416}',
+ '\u{0306}',
+ '\u{0436}',
+ '\u{0306}',
+ '\u{0410}',
+ '\u{0306}',
+ '\u{0430}',
+ '\u{0306}',
+ '\u{0410}',
+ '\u{0308}',
+ '\u{0430}',
+ '\u{0308}',
+ '\u{0415}',
+ '\u{0306}',
+ '\u{0435}',
+ '\u{0306}',
+ '\u{04D8}',
+ '\u{0308}',
+ '\u{04D9}',
+ '\u{0308}',
+ '\u{0416}',
+ '\u{0308}',
+ '\u{0436}',
+ '\u{0308}',
+ '\u{0417}',
+ '\u{0308}',
+ '\u{0437}',
+ '\u{0308}',
+ '\u{0418}',
+ '\u{0304}',
+ '\u{0438}',
+ '\u{0304}',
+ '\u{0418}',
+ '\u{0308}',
+ '\u{0438}',
+ '\u{0308}',
+ '\u{041E}',
+ '\u{0308}',
+ '\u{043E}',
+ '\u{0308}',
+ '\u{04E8}',
+ '\u{0308}',
+ '\u{04E9}',
+ '\u{0308}',
+ '\u{042D}',
+ '\u{0308}',
+ '\u{044D}',
+ '\u{0308}',
+ '\u{0423}',
+ '\u{0304}',
+ '\u{0443}',
+ '\u{0304}',
+ '\u{0423}',
+ '\u{0308}',
+ '\u{0443}',
+ '\u{0308}',
+ '\u{0423}',
+ '\u{030B}',
+ '\u{0443}',
+ '\u{030B}',
+ '\u{0427}',
+ '\u{0308}',
+ '\u{0447}',
+ '\u{0308}',
+ '\u{042B}',
+ '\u{0308}',
+ '\u{044B}',
+ '\u{0308}',
+ '\u{0627}',
+ '\u{0653}',
+ '\u{0627}',
+ '\u{0654}',
+ '\u{0648}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{0655}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D5}',
+ '\u{0654}',
+ '\u{06C1}',
+ '\u{0654}',
+ '\u{06D2}',
+ '\u{0654}',
+ '\u{0928}',
+ '\u{093C}',
+ '\u{0930}',
+ '\u{093C}',
+ '\u{0933}',
+ '\u{093C}',
+ '\u{0915}',
+ '\u{093C}',
+ '\u{0916}',
+ '\u{093C}',
+ '\u{0917}',
+ '\u{093C}',
+ '\u{091C}',
+ '\u{093C}',
+ '\u{0921}',
+ '\u{093C}',
+ '\u{0922}',
+ '\u{093C}',
+ '\u{092B}',
+ '\u{093C}',
+ '\u{092F}',
+ '\u{093C}',
+ '\u{09C7}',
+ '\u{09BE}',
+ '\u{09C7}',
+ '\u{09D7}',
+ '\u{09A1}',
+ '\u{09BC}',
+ '\u{09A2}',
+ '\u{09BC}',
+ '\u{09AF}',
+ '\u{09BC}',
+ '\u{0A32}',
+ '\u{0A3C}',
+ '\u{0A38}',
+ '\u{0A3C}',
+ '\u{0A16}',
+ '\u{0A3C}',
+ '\u{0A17}',
+ '\u{0A3C}',
+ '\u{0A1C}',
+ '\u{0A3C}',
+ '\u{0A2B}',
+ '\u{0A3C}',
+ '\u{0B47}',
+ '\u{0B56}',
+ '\u{0B47}',
+ '\u{0B3E}',
+ '\u{0B47}',
+ '\u{0B57}',
+ '\u{0B21}',
+ '\u{0B3C}',
+ '\u{0B22}',
+ '\u{0B3C}',
+ '\u{0B92}',
+ '\u{0BD7}',
+ '\u{0BC6}',
+ '\u{0BBE}',
+ '\u{0BC7}',
+ '\u{0BBE}',
+ '\u{0BC6}',
+ '\u{0BD7}',
+ '\u{0C46}',
+ '\u{0C56}',
+ '\u{0CBF}',
+ '\u{0CD5}',
+ '\u{0CC6}',
+ '\u{0CD5}',
+ '\u{0CC6}',
+ '\u{0CD6}',
+ '\u{0CC6}',
+ '\u{0CC2}',
+ '\u{0CC6}',
+ '\u{0CC2}',
+ '\u{0CD5}',
+ '\u{0D46}',
+ '\u{0D3E}',
+ '\u{0D47}',
+ '\u{0D3E}',
+ '\u{0D46}',
+ '\u{0D57}',
+ '\u{0DD9}',
+ '\u{0DCA}',
+ '\u{0DD9}',
+ '\u{0DCF}',
+ '\u{0DD9}',
+ '\u{0DCF}',
+ '\u{0DCA}',
+ '\u{0DD9}',
+ '\u{0DDF}',
+ '\u{0F42}',
+ '\u{0FB7}',
+ '\u{0F4C}',
+ '\u{0FB7}',
+ '\u{0F51}',
+ '\u{0FB7}',
+ '\u{0F56}',
+ '\u{0FB7}',
+ '\u{0F5B}',
+ '\u{0FB7}',
+ '\u{0F40}',
+ '\u{0FB5}',
+ '\u{0F71}',
+ '\u{0F72}',
+ '\u{0F71}',
+ '\u{0F74}',
+ '\u{0FB2}',
+ '\u{0F80}',
+ '\u{0FB3}',
+ '\u{0F80}',
+ '\u{0F71}',
+ '\u{0F80}',
+ '\u{0F92}',
+ '\u{0FB7}',
+ '\u{0F9C}',
+ '\u{0FB7}',
+ '\u{0FA1}',
+ '\u{0FB7}',
+ '\u{0FA6}',
+ '\u{0FB7}',
+ '\u{0FAB}',
+ '\u{0FB7}',
+ '\u{0F90}',
+ '\u{0FB5}',
+ '\u{1025}',
+ '\u{102E}',
+ '\u{1B05}',
+ '\u{1B35}',
+ '\u{1B07}',
+ '\u{1B35}',
+ '\u{1B09}',
+ '\u{1B35}',
+ '\u{1B0B}',
+ '\u{1B35}',
+ '\u{1B0D}',
+ '\u{1B35}',
+ '\u{1B11}',
+ '\u{1B35}',
+ '\u{1B3A}',
+ '\u{1B35}',
+ '\u{1B3C}',
+ '\u{1B35}',
+ '\u{1B3E}',
+ '\u{1B35}',
+ '\u{1B3F}',
+ '\u{1B35}',
+ '\u{1B42}',
+ '\u{1B35}',
+ '\u{0041}',
+ '\u{0325}',
+ '\u{0061}',
+ '\u{0325}',
+ '\u{0042}',
+ '\u{0307}',
+ '\u{0062}',
+ '\u{0307}',
+ '\u{0042}',
+ '\u{0323}',
+ '\u{0062}',
+ '\u{0323}',
+ '\u{0042}',
+ '\u{0331}',
+ '\u{0062}',
+ '\u{0331}',
+ '\u{0043}',
+ '\u{0327}',
+ '\u{0301}',
+ '\u{0063}',
+ '\u{0327}',
+ '\u{0301}',
+ '\u{0044}',
+ '\u{0307}',
+ '\u{0064}',
+ '\u{0307}',
+ '\u{0044}',
+ '\u{0323}',
+ '\u{0064}',
+ '\u{0323}',
+ '\u{0044}',
+ '\u{0331}',
+ '\u{0064}',
+ '\u{0331}',
+ '\u{0044}',
+ '\u{0327}',
+ '\u{0064}',
+ '\u{0327}',
+ '\u{0044}',
+ '\u{032D}',
+ '\u{0064}',
+ '\u{032D}',
+ '\u{0045}',
+ '\u{0304}',
+ '\u{0300}',
+ '\u{0065}',
+ '\u{0304}',
+ '\u{0300}',
+ '\u{0045}',
+ '\u{0304}',
+ '\u{0301}',
+ '\u{0065}',
+ '\u{0304}',
+ '\u{0301}',
+ '\u{0045}',
+ '\u{032D}',
+ '\u{0065}',
+ '\u{032D}',
+ '\u{0045}',
+ '\u{0330}',
+ '\u{0065}',
+ '\u{0330}',
+ '\u{0045}',
+ '\u{0327}',
+ '\u{0306}',
+ '\u{0065}',
+ '\u{0327}',
+ '\u{0306}',
+ '\u{0046}',
+ '\u{0307}',
+ '\u{0066}',
+ '\u{0307}',
+ '\u{0047}',
+ '\u{0304}',
+ '\u{0067}',
+ '\u{0304}',
+ '\u{0048}',
+ '\u{0307}',
+ '\u{0068}',
+ '\u{0307}',
+ '\u{0048}',
+ '\u{0323}',
+ '\u{0068}',
+ '\u{0323}',
+ '\u{0048}',
+ '\u{0308}',
+ '\u{0068}',
+ '\u{0308}',
+ '\u{0048}',
+ '\u{0327}',
+ '\u{0068}',
+ '\u{0327}',
+ '\u{0048}',
+ '\u{032E}',
+ '\u{0068}',
+ '\u{032E}',
+ '\u{0049}',
+ '\u{0330}',
+ '\u{0069}',
+ '\u{0330}',
+ '\u{0049}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{0069}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{004B}',
+ '\u{0301}',
+ '\u{006B}',
+ '\u{0301}',
+ '\u{004B}',
+ '\u{0323}',
+ '\u{006B}',
+ '\u{0323}',
+ '\u{004B}',
+ '\u{0331}',
+ '\u{006B}',
+ '\u{0331}',
+ '\u{004C}',
+ '\u{0323}',
+ '\u{006C}',
+ '\u{0323}',
+ '\u{004C}',
+ '\u{0323}',
+ '\u{0304}',
+ '\u{006C}',
+ '\u{0323}',
+ '\u{0304}',
+ '\u{004C}',
+ '\u{0331}',
+ '\u{006C}',
+ '\u{0331}',
+ '\u{004C}',
+ '\u{032D}',
+ '\u{006C}',
+ '\u{032D}',
+ '\u{004D}',
+ '\u{0301}',
+ '\u{006D}',
+ '\u{0301}',
+ '\u{004D}',
+ '\u{0307}',
+ '\u{006D}',
+ '\u{0307}',
+ '\u{004D}',
+ '\u{0323}',
+ '\u{006D}',
+ '\u{0323}',
+ '\u{004E}',
+ '\u{0307}',
+ '\u{006E}',
+ '\u{0307}',
+ '\u{004E}',
+ '\u{0323}',
+ '\u{006E}',
+ '\u{0323}',
+ '\u{004E}',
+ '\u{0331}',
+ '\u{006E}',
+ '\u{0331}',
+ '\u{004E}',
+ '\u{032D}',
+ '\u{006E}',
+ '\u{032D}',
+ '\u{004F}',
+ '\u{0303}',
+ '\u{0301}',
+ '\u{006F}',
+ '\u{0303}',
+ '\u{0301}',
+ '\u{004F}',
+ '\u{0303}',
+ '\u{0308}',
+ '\u{006F}',
+ '\u{0303}',
+ '\u{0308}',
+ '\u{004F}',
+ '\u{0304}',
+ '\u{0300}',
+ '\u{006F}',
+ '\u{0304}',
+ '\u{0300}',
+ '\u{004F}',
+ '\u{0304}',
+ '\u{0301}',
+ '\u{006F}',
+ '\u{0304}',
+ '\u{0301}',
+ '\u{0050}',
+ '\u{0301}',
+ '\u{0070}',
+ '\u{0301}',
+ '\u{0050}',
+ '\u{0307}',
+ '\u{0070}',
+ '\u{0307}',
+ '\u{0052}',
+ '\u{0307}',
+ '\u{0072}',
+ '\u{0307}',
+ '\u{0052}',
+ '\u{0323}',
+ '\u{0072}',
+ '\u{0323}',
+ '\u{0052}',
+ '\u{0323}',
+ '\u{0304}',
+ '\u{0072}',
+ '\u{0323}',
+ '\u{0304}',
+ '\u{0052}',
+ '\u{0331}',
+ '\u{0072}',
+ '\u{0331}',
+ '\u{0053}',
+ '\u{0307}',
+ '\u{0073}',
+ '\u{0307}',
+ '\u{0053}',
+ '\u{0323}',
+ '\u{0073}',
+ '\u{0323}',
+ '\u{0053}',
+ '\u{0301}',
+ '\u{0307}',
+ '\u{0073}',
+ '\u{0301}',
+ '\u{0307}',
+ '\u{0053}',
+ '\u{030C}',
+ '\u{0307}',
+ '\u{0073}',
+ '\u{030C}',
+ '\u{0307}',
+ '\u{0053}',
+ '\u{0323}',
+ '\u{0307}',
+ '\u{0073}',
+ '\u{0323}',
+ '\u{0307}',
+ '\u{0054}',
+ '\u{0307}',
+ '\u{0074}',
+ '\u{0307}',
+ '\u{0054}',
+ '\u{0323}',
+ '\u{0074}',
+ '\u{0323}',
+ '\u{0054}',
+ '\u{0331}',
+ '\u{0074}',
+ '\u{0331}',
+ '\u{0054}',
+ '\u{032D}',
+ '\u{0074}',
+ '\u{032D}',
+ '\u{0055}',
+ '\u{0324}',
+ '\u{0075}',
+ '\u{0324}',
+ '\u{0055}',
+ '\u{0330}',
+ '\u{0075}',
+ '\u{0330}',
+ '\u{0055}',
+ '\u{032D}',
+ '\u{0075}',
+ '\u{032D}',
+ '\u{0055}',
+ '\u{0303}',
+ '\u{0301}',
+ '\u{0075}',
+ '\u{0303}',
+ '\u{0301}',
+ '\u{0055}',
+ '\u{0304}',
+ '\u{0308}',
+ '\u{0075}',
+ '\u{0304}',
+ '\u{0308}',
+ '\u{0056}',
+ '\u{0303}',
+ '\u{0076}',
+ '\u{0303}',
+ '\u{0056}',
+ '\u{0323}',
+ '\u{0076}',
+ '\u{0323}',
+ '\u{0057}',
+ '\u{0300}',
+ '\u{0077}',
+ '\u{0300}',
+ '\u{0057}',
+ '\u{0301}',
+ '\u{0077}',
+ '\u{0301}',
+ '\u{0057}',
+ '\u{0308}',
+ '\u{0077}',
+ '\u{0308}',
+ '\u{0057}',
+ '\u{0307}',
+ '\u{0077}',
+ '\u{0307}',
+ '\u{0057}',
+ '\u{0323}',
+ '\u{0077}',
+ '\u{0323}',
+ '\u{0058}',
+ '\u{0307}',
+ '\u{0078}',
+ '\u{0307}',
+ '\u{0058}',
+ '\u{0308}',
+ '\u{0078}',
+ '\u{0308}',
+ '\u{0059}',
+ '\u{0307}',
+ '\u{0079}',
+ '\u{0307}',
+ '\u{005A}',
+ '\u{0302}',
+ '\u{007A}',
+ '\u{0302}',
+ '\u{005A}',
+ '\u{0323}',
+ '\u{007A}',
+ '\u{0323}',
+ '\u{005A}',
+ '\u{0331}',
+ '\u{007A}',
+ '\u{0331}',
+ '\u{0068}',
+ '\u{0331}',
+ '\u{0074}',
+ '\u{0308}',
+ '\u{0077}',
+ '\u{030A}',
+ '\u{0079}',
+ '\u{030A}',
+ '\u{017F}',
+ '\u{0307}',
+ '\u{0041}',
+ '\u{0323}',
+ '\u{0061}',
+ '\u{0323}',
+ '\u{0041}',
+ '\u{0309}',
+ '\u{0061}',
+ '\u{0309}',
+ '\u{0041}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{0061}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{0041}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{0061}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{0041}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{0061}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{0041}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{0061}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{0041}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{0061}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{0041}',
+ '\u{0306}',
+ '\u{0301}',
+ '\u{0061}',
+ '\u{0306}',
+ '\u{0301}',
+ '\u{0041}',
+ '\u{0306}',
+ '\u{0300}',
+ '\u{0061}',
+ '\u{0306}',
+ '\u{0300}',
+ '\u{0041}',
+ '\u{0306}',
+ '\u{0309}',
+ '\u{0061}',
+ '\u{0306}',
+ '\u{0309}',
+ '\u{0041}',
+ '\u{0306}',
+ '\u{0303}',
+ '\u{0061}',
+ '\u{0306}',
+ '\u{0303}',
+ '\u{0041}',
+ '\u{0323}',
+ '\u{0306}',
+ '\u{0061}',
+ '\u{0323}',
+ '\u{0306}',
+ '\u{0045}',
+ '\u{0323}',
+ '\u{0065}',
+ '\u{0323}',
+ '\u{0045}',
+ '\u{0309}',
+ '\u{0065}',
+ '\u{0309}',
+ '\u{0045}',
+ '\u{0303}',
+ '\u{0065}',
+ '\u{0303}',
+ '\u{0045}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{0065}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{0045}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{0065}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{0045}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{0065}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{0045}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{0065}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{0045}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{0065}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{0049}',
+ '\u{0309}',
+ '\u{0069}',
+ '\u{0309}',
+ '\u{0049}',
+ '\u{0323}',
+ '\u{0069}',
+ '\u{0323}',
+ '\u{004F}',
+ '\u{0323}',
+ '\u{006F}',
+ '\u{0323}',
+ '\u{004F}',
+ '\u{0309}',
+ '\u{006F}',
+ '\u{0309}',
+ '\u{004F}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{006F}',
+ '\u{0302}',
+ '\u{0301}',
+ '\u{004F}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{006F}',
+ '\u{0302}',
+ '\u{0300}',
+ '\u{004F}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{006F}',
+ '\u{0302}',
+ '\u{0309}',
+ '\u{004F}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{006F}',
+ '\u{0302}',
+ '\u{0303}',
+ '\u{004F}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{006F}',
+ '\u{0323}',
+ '\u{0302}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{0301}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0301}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{0300}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0300}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{0309}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0309}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{0303}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0303}',
+ '\u{004F}',
+ '\u{031B}',
+ '\u{0323}',
+ '\u{006F}',
+ '\u{031B}',
+ '\u{0323}',
+ '\u{0055}',
+ '\u{0323}',
+ '\u{0075}',
+ '\u{0323}',
+ '\u{0055}',
+ '\u{0309}',
+ '\u{0075}',
+ '\u{0309}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0301}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0301}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0300}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0300}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0309}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0309}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0303}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0303}',
+ '\u{0055}',
+ '\u{031B}',
+ '\u{0323}',
+ '\u{0075}',
+ '\u{031B}',
+ '\u{0323}',
+ '\u{0059}',
+ '\u{0300}',
+ '\u{0079}',
+ '\u{0300}',
+ '\u{0059}',
+ '\u{0323}',
+ '\u{0079}',
+ '\u{0323}',
+ '\u{0059}',
+ '\u{0309}',
+ '\u{0079}',
+ '\u{0309}',
+ '\u{0059}',
+ '\u{0303}',
+ '\u{0079}',
+ '\u{0303}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03B5}',
+ '\u{0313}',
+ '\u{03B5}',
+ '\u{0314}',
+ '\u{03B5}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03B5}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03B5}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03B5}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0395}',
+ '\u{0313}',
+ '\u{0395}',
+ '\u{0314}',
+ '\u{0395}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0395}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0395}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0395}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03B9}',
+ '\u{0313}',
+ '\u{03B9}',
+ '\u{0314}',
+ '\u{03B9}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03B9}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03B9}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03B9}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0399}',
+ '\u{0313}',
+ '\u{0399}',
+ '\u{0314}',
+ '\u{0399}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0399}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0399}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0399}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0399}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0399}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03BF}',
+ '\u{0313}',
+ '\u{03BF}',
+ '\u{0314}',
+ '\u{03BF}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03BF}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03BF}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03BF}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{039F}',
+ '\u{0313}',
+ '\u{039F}',
+ '\u{0314}',
+ '\u{039F}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{039F}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{039F}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{039F}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0313}',
+ '\u{03C5}',
+ '\u{0314}',
+ '\u{03C5}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03C5}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03C5}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03C5}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03A5}',
+ '\u{0314}',
+ '\u{03A5}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03A5}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03A5}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{03B1}',
+ '\u{0300}',
+ '\u{03B1}',
+ '\u{0301}',
+ '\u{03B5}',
+ '\u{0300}',
+ '\u{03B5}',
+ '\u{0301}',
+ '\u{03B7}',
+ '\u{0300}',
+ '\u{03B7}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0300}',
+ '\u{03B9}',
+ '\u{0301}',
+ '\u{03BF}',
+ '\u{0300}',
+ '\u{03BF}',
+ '\u{0301}',
+ '\u{03C5}',
+ '\u{0300}',
+ '\u{03C5}',
+ '\u{0301}',
+ '\u{03C9}',
+ '\u{0300}',
+ '\u{03C9}',
+ '\u{0301}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0397}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03A9}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0306}',
+ '\u{03B1}',
+ '\u{0304}',
+ '\u{03B1}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B1}',
+ '\u{0342}',
+ '\u{03B1}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0391}',
+ '\u{0306}',
+ '\u{0391}',
+ '\u{0304}',
+ '\u{0391}',
+ '\u{0300}',
+ '\u{0391}',
+ '\u{0301}',
+ '\u{0391}',
+ '\u{0345}',
+ '\u{03B9}',
+ '\u{00A8}',
+ '\u{0342}',
+ '\u{03B7}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03B7}',
+ '\u{0342}',
+ '\u{03B7}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{0395}',
+ '\u{0300}',
+ '\u{0395}',
+ '\u{0301}',
+ '\u{0397}',
+ '\u{0300}',
+ '\u{0397}',
+ '\u{0301}',
+ '\u{0397}',
+ '\u{0345}',
+ '\u{1FBF}',
+ '\u{0300}',
+ '\u{1FBF}',
+ '\u{0301}',
+ '\u{1FBF}',
+ '\u{0342}',
+ '\u{03B9}',
+ '\u{0306}',
+ '\u{03B9}',
+ '\u{0304}',
+ '\u{03B9}',
+ '\u{0308}',
+ '\u{0300}',
+ '\u{03B9}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{03B9}',
+ '\u{0342}',
+ '\u{03B9}',
+ '\u{0308}',
+ '\u{0342}',
+ '\u{0399}',
+ '\u{0306}',
+ '\u{0399}',
+ '\u{0304}',
+ '\u{0399}',
+ '\u{0300}',
+ '\u{0399}',
+ '\u{0301}',
+ '\u{1FFE}',
+ '\u{0300}',
+ '\u{1FFE}',
+ '\u{0301}',
+ '\u{1FFE}',
+ '\u{0342}',
+ '\u{03C5}',
+ '\u{0306}',
+ '\u{03C5}',
+ '\u{0304}',
+ '\u{03C5}',
+ '\u{0308}',
+ '\u{0300}',
+ '\u{03C5}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{03C1}',
+ '\u{0313}',
+ '\u{03C1}',
+ '\u{0314}',
+ '\u{03C5}',
+ '\u{0342}',
+ '\u{03C5}',
+ '\u{0308}',
+ '\u{0342}',
+ '\u{03A5}',
+ '\u{0306}',
+ '\u{03A5}',
+ '\u{0304}',
+ '\u{03A5}',
+ '\u{0300}',
+ '\u{03A5}',
+ '\u{0301}',
+ '\u{03A1}',
+ '\u{0314}',
+ '\u{00A8}',
+ '\u{0300}',
+ '\u{00A8}',
+ '\u{0301}',
+ '\u{0060}',
+ '\u{03C9}',
+ '\u{0300}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0301}',
+ '\u{0345}',
+ '\u{03C9}',
+ '\u{0342}',
+ '\u{03C9}',
+ '\u{0342}',
+ '\u{0345}',
+ '\u{039F}',
+ '\u{0300}',
+ '\u{039F}',
+ '\u{0301}',
+ '\u{03A9}',
+ '\u{0300}',
+ '\u{03A9}',
+ '\u{0301}',
+ '\u{03A9}',
+ '\u{0345}',
+ '\u{00B4}',
+ '\u{2002}',
+ '\u{2003}',
+ '\u{03A9}',
+ '\u{004B}',
+ '\u{0041}',
+ '\u{030A}',
+ '\u{2190}',
+ '\u{0338}',
+ '\u{2192}',
+ '\u{0338}',
+ '\u{2194}',
+ '\u{0338}',
+ '\u{21D0}',
+ '\u{0338}',
+ '\u{21D4}',
+ '\u{0338}',
+ '\u{21D2}',
+ '\u{0338}',
+ '\u{2203}',
+ '\u{0338}',
+ '\u{2208}',
+ '\u{0338}',
+ '\u{220B}',
+ '\u{0338}',
+ '\u{2223}',
+ '\u{0338}',
+ '\u{2225}',
+ '\u{0338}',
+ '\u{223C}',
+ '\u{0338}',
+ '\u{2243}',
+ '\u{0338}',
+ '\u{2245}',
+ '\u{0338}',
+ '\u{2248}',
+ '\u{0338}',
+ '\u{003D}',
+ '\u{0338}',
+ '\u{2261}',
+ '\u{0338}',
+ '\u{224D}',
+ '\u{0338}',
+ '\u{003C}',
+ '\u{0338}',
+ '\u{003E}',
+ '\u{0338}',
+ '\u{2264}',
+ '\u{0338}',
+ '\u{2265}',
+ '\u{0338}',
+ '\u{2272}',
+ '\u{0338}',
+ '\u{2273}',
+ '\u{0338}',
+ '\u{2276}',
+ '\u{0338}',
+ '\u{2277}',
+ '\u{0338}',
+ '\u{227A}',
+ '\u{0338}',
+ '\u{227B}',
+ '\u{0338}',
+ '\u{2282}',
+ '\u{0338}',
+ '\u{2283}',
+ '\u{0338}',
+ '\u{2286}',
+ '\u{0338}',
+ '\u{2287}',
+ '\u{0338}',
+ '\u{22A2}',
+ '\u{0338}',
+ '\u{22A8}',
+ '\u{0338}',
+ '\u{22A9}',
+ '\u{0338}',
+ '\u{22AB}',
+ '\u{0338}',
+ '\u{227C}',
+ '\u{0338}',
+ '\u{227D}',
+ '\u{0338}',
+ '\u{2291}',
+ '\u{0338}',
+ '\u{2292}',
+ '\u{0338}',
+ '\u{22B2}',
+ '\u{0338}',
+ '\u{22B3}',
+ '\u{0338}',
+ '\u{22B4}',
+ '\u{0338}',
+ '\u{22B5}',
+ '\u{0338}',
+ '\u{3008}',
+ '\u{3009}',
+ '\u{2ADD}',
+ '\u{0338}',
+ '\u{304B}',
+ '\u{3099}',
+ '\u{304D}',
+ '\u{3099}',
+ '\u{304F}',
+ '\u{3099}',
+ '\u{3051}',
+ '\u{3099}',
+ '\u{3053}',
+ '\u{3099}',
+ '\u{3055}',
+ '\u{3099}',
+ '\u{3057}',
+ '\u{3099}',
+ '\u{3059}',
+ '\u{3099}',
+ '\u{305B}',
+ '\u{3099}',
+ '\u{305D}',
+ '\u{3099}',
+ '\u{305F}',
+ '\u{3099}',
+ '\u{3061}',
+ '\u{3099}',
+ '\u{3064}',
+ '\u{3099}',
+ '\u{3066}',
+ '\u{3099}',
+ '\u{3068}',
+ '\u{3099}',
+ '\u{306F}',
+ '\u{3099}',
+ '\u{306F}',
+ '\u{309A}',
+ '\u{3072}',
+ '\u{3099}',
+ '\u{3072}',
+ '\u{309A}',
+ '\u{3075}',
+ '\u{3099}',
+ '\u{3075}',
+ '\u{309A}',
+ '\u{3078}',
+ '\u{3099}',
+ '\u{3078}',
+ '\u{309A}',
+ '\u{307B}',
+ '\u{3099}',
+ '\u{307B}',
+ '\u{309A}',
+ '\u{3046}',
+ '\u{3099}',
+ '\u{309D}',
+ '\u{3099}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30AD}',
+ '\u{3099}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30B1}',
+ '\u{3099}',
+ '\u{30B3}',
+ '\u{3099}',
+ '\u{30B5}',
+ '\u{3099}',
+ '\u{30B7}',
+ '\u{3099}',
+ '\u{30B9}',
+ '\u{3099}',
+ '\u{30BB}',
+ '\u{3099}',
+ '\u{30BD}',
+ '\u{3099}',
+ '\u{30BF}',
+ '\u{3099}',
+ '\u{30C1}',
+ '\u{3099}',
+ '\u{30C4}',
+ '\u{3099}',
+ '\u{30C6}',
+ '\u{3099}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30CF}',
+ '\u{3099}',
+ '\u{30CF}',
+ '\u{309A}',
+ '\u{30D2}',
+ '\u{3099}',
+ '\u{30D2}',
+ '\u{309A}',
+ '\u{30D5}',
+ '\u{3099}',
+ '\u{30D5}',
+ '\u{309A}',
+ '\u{30D8}',
+ '\u{3099}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30DB}',
+ '\u{3099}',
+ '\u{30DB}',
+ '\u{309A}',
+ '\u{30A6}',
+ '\u{3099}',
+ '\u{30EF}',
+ '\u{3099}',
+ '\u{30F0}',
+ '\u{3099}',
+ '\u{30F1}',
+ '\u{3099}',
+ '\u{30F2}',
+ '\u{3099}',
+ '\u{30FD}',
+ '\u{3099}',
+ '\u{8C48}',
+ '\u{66F4}',
+ '\u{8ECA}',
+ '\u{8CC8}',
+ '\u{6ED1}',
+ '\u{4E32}',
+ '\u{53E5}',
+ '\u{9F9C}',
+ '\u{9F9C}',
+ '\u{5951}',
+ '\u{91D1}',
+ '\u{5587}',
+ '\u{5948}',
+ '\u{61F6}',
+ '\u{7669}',
+ '\u{7F85}',
+ '\u{863F}',
+ '\u{87BA}',
+ '\u{88F8}',
+ '\u{908F}',
+ '\u{6A02}',
+ '\u{6D1B}',
+ '\u{70D9}',
+ '\u{73DE}',
+ '\u{843D}',
+ '\u{916A}',
+ '\u{99F1}',
+ '\u{4E82}',
+ '\u{5375}',
+ '\u{6B04}',
+ '\u{721B}',
+ '\u{862D}',
+ '\u{9E1E}',
+ '\u{5D50}',
+ '\u{6FEB}',
+ '\u{85CD}',
+ '\u{8964}',
+ '\u{62C9}',
+ '\u{81D8}',
+ '\u{881F}',
+ '\u{5ECA}',
+ '\u{6717}',
+ '\u{6D6A}',
+ '\u{72FC}',
+ '\u{90CE}',
+ '\u{4F86}',
+ '\u{51B7}',
+ '\u{52DE}',
+ '\u{64C4}',
+ '\u{6AD3}',
+ '\u{7210}',
+ '\u{76E7}',
+ '\u{8001}',
+ '\u{8606}',
+ '\u{865C}',
+ '\u{8DEF}',
+ '\u{9732}',
+ '\u{9B6F}',
+ '\u{9DFA}',
+ '\u{788C}',
+ '\u{797F}',
+ '\u{7DA0}',
+ '\u{83C9}',
+ '\u{9304}',
+ '\u{9E7F}',
+ '\u{8AD6}',
+ '\u{58DF}',
+ '\u{5F04}',
+ '\u{7C60}',
+ '\u{807E}',
+ '\u{7262}',
+ '\u{78CA}',
+ '\u{8CC2}',
+ '\u{96F7}',
+ '\u{58D8}',
+ '\u{5C62}',
+ '\u{6A13}',
+ '\u{6DDA}',
+ '\u{6F0F}',
+ '\u{7D2F}',
+ '\u{7E37}',
+ '\u{964B}',
+ '\u{52D2}',
+ '\u{808B}',
+ '\u{51DC}',
+ '\u{51CC}',
+ '\u{7A1C}',
+ '\u{7DBE}',
+ '\u{83F1}',
+ '\u{9675}',
+ '\u{8B80}',
+ '\u{62CF}',
+ '\u{6A02}',
+ '\u{8AFE}',
+ '\u{4E39}',
+ '\u{5BE7}',
+ '\u{6012}',
+ '\u{7387}',
+ '\u{7570}',
+ '\u{5317}',
+ '\u{78FB}',
+ '\u{4FBF}',
+ '\u{5FA9}',
+ '\u{4E0D}',
+ '\u{6CCC}',
+ '\u{6578}',
+ '\u{7D22}',
+ '\u{53C3}',
+ '\u{585E}',
+ '\u{7701}',
+ '\u{8449}',
+ '\u{8AAA}',
+ '\u{6BBA}',
+ '\u{8FB0}',
+ '\u{6C88}',
+ '\u{62FE}',
+ '\u{82E5}',
+ '\u{63A0}',
+ '\u{7565}',
+ '\u{4EAE}',
+ '\u{5169}',
+ '\u{51C9}',
+ '\u{6881}',
+ '\u{7CE7}',
+ '\u{826F}',
+ '\u{8AD2}',
+ '\u{91CF}',
+ '\u{52F5}',
+ '\u{5442}',
+ '\u{5973}',
+ '\u{5EEC}',
+ '\u{65C5}',
+ '\u{6FFE}',
+ '\u{792A}',
+ '\u{95AD}',
+ '\u{9A6A}',
+ '\u{9E97}',
+ '\u{9ECE}',
+ '\u{529B}',
+ '\u{66C6}',
+ '\u{6B77}',
+ '\u{8F62}',
+ '\u{5E74}',
+ '\u{6190}',
+ '\u{6200}',
+ '\u{649A}',
+ '\u{6F23}',
+ '\u{7149}',
+ '\u{7489}',
+ '\u{79CA}',
+ '\u{7DF4}',
+ '\u{806F}',
+ '\u{8F26}',
+ '\u{84EE}',
+ '\u{9023}',
+ '\u{934A}',
+ '\u{5217}',
+ '\u{52A3}',
+ '\u{54BD}',
+ '\u{70C8}',
+ '\u{88C2}',
+ '\u{8AAA}',
+ '\u{5EC9}',
+ '\u{5FF5}',
+ '\u{637B}',
+ '\u{6BAE}',
+ '\u{7C3E}',
+ '\u{7375}',
+ '\u{4EE4}',
+ '\u{56F9}',
+ '\u{5BE7}',
+ '\u{5DBA}',
+ '\u{601C}',
+ '\u{73B2}',
+ '\u{7469}',
+ '\u{7F9A}',
+ '\u{8046}',
+ '\u{9234}',
+ '\u{96F6}',
+ '\u{9748}',
+ '\u{9818}',
+ '\u{4F8B}',
+ '\u{79AE}',
+ '\u{91B4}',
+ '\u{96B8}',
+ '\u{60E1}',
+ '\u{4E86}',
+ '\u{50DA}',
+ '\u{5BEE}',
+ '\u{5C3F}',
+ '\u{6599}',
+ '\u{6A02}',
+ '\u{71CE}',
+ '\u{7642}',
+ '\u{84FC}',
+ '\u{907C}',
+ '\u{9F8D}',
+ '\u{6688}',
+ '\u{962E}',
+ '\u{5289}',
+ '\u{677B}',
+ '\u{67F3}',
+ '\u{6D41}',
+ '\u{6E9C}',
+ '\u{7409}',
+ '\u{7559}',
+ '\u{786B}',
+ '\u{7D10}',
+ '\u{985E}',
+ '\u{516D}',
+ '\u{622E}',
+ '\u{9678}',
+ '\u{502B}',
+ '\u{5D19}',
+ '\u{6DEA}',
+ '\u{8F2A}',
+ '\u{5F8B}',
+ '\u{6144}',
+ '\u{6817}',
+ '\u{7387}',
+ '\u{9686}',
+ '\u{5229}',
+ '\u{540F}',
+ '\u{5C65}',
+ '\u{6613}',
+ '\u{674E}',
+ '\u{68A8}',
+ '\u{6CE5}',
+ '\u{7406}',
+ '\u{75E2}',
+ '\u{7F79}',
+ '\u{88CF}',
+ '\u{88E1}',
+ '\u{91CC}',
+ '\u{96E2}',
+ '\u{533F}',
+ '\u{6EBA}',
+ '\u{541D}',
+ '\u{71D0}',
+ '\u{7498}',
+ '\u{85FA}',
+ '\u{96A3}',
+ '\u{9C57}',
+ '\u{9E9F}',
+ '\u{6797}',
+ '\u{6DCB}',
+ '\u{81E8}',
+ '\u{7ACB}',
+ '\u{7B20}',
+ '\u{7C92}',
+ '\u{72C0}',
+ '\u{7099}',
+ '\u{8B58}',
+ '\u{4EC0}',
+ '\u{8336}',
+ '\u{523A}',
+ '\u{5207}',
+ '\u{5EA6}',
+ '\u{62D3}',
+ '\u{7CD6}',
+ '\u{5B85}',
+ '\u{6D1E}',
+ '\u{66B4}',
+ '\u{8F3B}',
+ '\u{884C}',
+ '\u{964D}',
+ '\u{898B}',
+ '\u{5ED3}',
+ '\u{5140}',
+ '\u{55C0}',
+ '\u{585A}',
+ '\u{6674}',
+ '\u{51DE}',
+ '\u{732A}',
+ '\u{76CA}',
+ '\u{793C}',
+ '\u{795E}',
+ '\u{7965}',
+ '\u{798F}',
+ '\u{9756}',
+ '\u{7CBE}',
+ '\u{7FBD}',
+ '\u{8612}',
+ '\u{8AF8}',
+ '\u{9038}',
+ '\u{90FD}',
+ '\u{98EF}',
+ '\u{98FC}',
+ '\u{9928}',
+ '\u{9DB4}',
+ '\u{90DE}',
+ '\u{96B7}',
+ '\u{4FAE}',
+ '\u{50E7}',
+ '\u{514D}',
+ '\u{52C9}',
+ '\u{52E4}',
+ '\u{5351}',
+ '\u{559D}',
+ '\u{5606}',
+ '\u{5668}',
+ '\u{5840}',
+ '\u{58A8}',
+ '\u{5C64}',
+ '\u{5C6E}',
+ '\u{6094}',
+ '\u{6168}',
+ '\u{618E}',
+ '\u{61F2}',
+ '\u{654F}',
+ '\u{65E2}',
+ '\u{6691}',
+ '\u{6885}',
+ '\u{6D77}',
+ '\u{6E1A}',
+ '\u{6F22}',
+ '\u{716E}',
+ '\u{722B}',
+ '\u{7422}',
+ '\u{7891}',
+ '\u{793E}',
+ '\u{7949}',
+ '\u{7948}',
+ '\u{7950}',
+ '\u{7956}',
+ '\u{795D}',
+ '\u{798D}',
+ '\u{798E}',
+ '\u{7A40}',
+ '\u{7A81}',
+ '\u{7BC0}',
+ '\u{7DF4}',
+ '\u{7E09}',
+ '\u{7E41}',
+ '\u{7F72}',
+ '\u{8005}',
+ '\u{81ED}',
+ '\u{8279}',
+ '\u{8279}',
+ '\u{8457}',
+ '\u{8910}',
+ '\u{8996}',
+ '\u{8B01}',
+ '\u{8B39}',
+ '\u{8CD3}',
+ '\u{8D08}',
+ '\u{8FB6}',
+ '\u{9038}',
+ '\u{96E3}',
+ '\u{97FF}',
+ '\u{983B}',
+ '\u{6075}',
+ '\u{242EE}',
+ '\u{8218}',
+ '\u{4E26}',
+ '\u{51B5}',
+ '\u{5168}',
+ '\u{4F80}',
+ '\u{5145}',
+ '\u{5180}',
+ '\u{52C7}',
+ '\u{52FA}',
+ '\u{559D}',
+ '\u{5555}',
+ '\u{5599}',
+ '\u{55E2}',
+ '\u{585A}',
+ '\u{58B3}',
+ '\u{5944}',
+ '\u{5954}',
+ '\u{5A62}',
+ '\u{5B28}',
+ '\u{5ED2}',
+ '\u{5ED9}',
+ '\u{5F69}',
+ '\u{5FAD}',
+ '\u{60D8}',
+ '\u{614E}',
+ '\u{6108}',
+ '\u{618E}',
+ '\u{6160}',
+ '\u{61F2}',
+ '\u{6234}',
+ '\u{63C4}',
+ '\u{641C}',
+ '\u{6452}',
+ '\u{6556}',
+ '\u{6674}',
+ '\u{6717}',
+ '\u{671B}',
+ '\u{6756}',
+ '\u{6B79}',
+ '\u{6BBA}',
+ '\u{6D41}',
+ '\u{6EDB}',
+ '\u{6ECB}',
+ '\u{6F22}',
+ '\u{701E}',
+ '\u{716E}',
+ '\u{77A7}',
+ '\u{7235}',
+ '\u{72AF}',
+ '\u{732A}',
+ '\u{7471}',
+ '\u{7506}',
+ '\u{753B}',
+ '\u{761D}',
+ '\u{761F}',
+ '\u{76CA}',
+ '\u{76DB}',
+ '\u{76F4}',
+ '\u{774A}',
+ '\u{7740}',
+ '\u{78CC}',
+ '\u{7AB1}',
+ '\u{7BC0}',
+ '\u{7C7B}',
+ '\u{7D5B}',
+ '\u{7DF4}',
+ '\u{7F3E}',
+ '\u{8005}',
+ '\u{8352}',
+ '\u{83EF}',
+ '\u{8779}',
+ '\u{8941}',
+ '\u{8986}',
+ '\u{8996}',
+ '\u{8ABF}',
+ '\u{8AF8}',
+ '\u{8ACB}',
+ '\u{8B01}',
+ '\u{8AFE}',
+ '\u{8AED}',
+ '\u{8B39}',
+ '\u{8B8A}',
+ '\u{8D08}',
+ '\u{8F38}',
+ '\u{9072}',
+ '\u{9199}',
+ '\u{9276}',
+ '\u{967C}',
+ '\u{96E3}',
+ '\u{9756}',
+ '\u{97DB}',
+ '\u{97FF}',
+ '\u{980B}',
+ '\u{983B}',
+ '\u{9B12}',
+ '\u{9F9C}',
+ '\u{2284A}',
+ '\u{22844}',
+ '\u{233D5}',
+ '\u{3B9D}',
+ '\u{4018}',
+ '\u{4039}',
+ '\u{25249}',
+ '\u{25CD0}',
+ '\u{27ED3}',
+ '\u{9F43}',
+ '\u{9F8E}',
+ '\u{05D9}',
+ '\u{05B4}',
+ '\u{05F2}',
+ '\u{05B7}',
+ '\u{05E9}',
+ '\u{05C1}',
+ '\u{05E9}',
+ '\u{05C2}',
+ '\u{05E9}',
+ '\u{05BC}',
+ '\u{05C1}',
+ '\u{05E9}',
+ '\u{05BC}',
+ '\u{05C2}',
+ '\u{05D0}',
+ '\u{05B7}',
+ '\u{05D0}',
+ '\u{05B8}',
+ '\u{05D0}',
+ '\u{05BC}',
+ '\u{05D1}',
+ '\u{05BC}',
+ '\u{05D2}',
+ '\u{05BC}',
+ '\u{05D3}',
+ '\u{05BC}',
+ '\u{05D4}',
+ '\u{05BC}',
+ '\u{05D5}',
+ '\u{05BC}',
+ '\u{05D6}',
+ '\u{05BC}',
+ '\u{05D8}',
+ '\u{05BC}',
+ '\u{05D9}',
+ '\u{05BC}',
+ '\u{05DA}',
+ '\u{05BC}',
+ '\u{05DB}',
+ '\u{05BC}',
+ '\u{05DC}',
+ '\u{05BC}',
+ '\u{05DE}',
+ '\u{05BC}',
+ '\u{05E0}',
+ '\u{05BC}',
+ '\u{05E1}',
+ '\u{05BC}',
+ '\u{05E3}',
+ '\u{05BC}',
+ '\u{05E4}',
+ '\u{05BC}',
+ '\u{05E6}',
+ '\u{05BC}',
+ '\u{05E7}',
+ '\u{05BC}',
+ '\u{05E8}',
+ '\u{05BC}',
+ '\u{05E9}',
+ '\u{05BC}',
+ '\u{05EA}',
+ '\u{05BC}',
+ '\u{05D5}',
+ '\u{05B9}',
+ '\u{05D1}',
+ '\u{05BF}',
+ '\u{05DB}',
+ '\u{05BF}',
+ '\u{05E4}',
+ '\u{05BF}',
+ '\u{11099}',
+ '\u{110BA}',
+ '\u{1109B}',
+ '\u{110BA}',
+ '\u{110A5}',
+ '\u{110BA}',
+ '\u{11131}',
+ '\u{11127}',
+ '\u{11132}',
+ '\u{11127}',
+ '\u{11347}',
+ '\u{1133E}',
+ '\u{11347}',
+ '\u{11357}',
+ '\u{114B9}',
+ '\u{114BA}',
+ '\u{114B9}',
+ '\u{114B0}',
+ '\u{114B9}',
+ '\u{114BD}',
+ '\u{115B8}',
+ '\u{115AF}',
+ '\u{115B9}',
+ '\u{115AF}',
+ '\u{11935}',
+ '\u{11930}',
+ '\u{1D157}',
+ '\u{1D165}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D16E}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D16F}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D170}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D171}',
+ '\u{1D158}',
+ '\u{1D165}',
+ '\u{1D172}',
+ '\u{1D1B9}',
+ '\u{1D165}',
+ '\u{1D1BA}',
+ '\u{1D165}',
+ '\u{1D1B9}',
+ '\u{1D165}',
+ '\u{1D16E}',
+ '\u{1D1BA}',
+ '\u{1D165}',
+ '\u{1D16E}',
+ '\u{1D1B9}',
+ '\u{1D165}',
+ '\u{1D16F}',
+ '\u{1D1BA}',
+ '\u{1D165}',
+ '\u{1D16F}',
+ '\u{4E3D}',
+ '\u{4E38}',
+ '\u{4E41}',
+ '\u{20122}',
+ '\u{4F60}',
+ '\u{4FAE}',
+ '\u{4FBB}',
+ '\u{5002}',
+ '\u{507A}',
+ '\u{5099}',
+ '\u{50E7}',
+ '\u{50CF}',
+ '\u{349E}',
+ '\u{2063A}',
+ '\u{514D}',
+ '\u{5154}',
+ '\u{5164}',
+ '\u{5177}',
+ '\u{2051C}',
+ '\u{34B9}',
+ '\u{5167}',
+ '\u{518D}',
+ '\u{2054B}',
+ '\u{5197}',
+ '\u{51A4}',
+ '\u{4ECC}',
+ '\u{51AC}',
+ '\u{51B5}',
+ '\u{291DF}',
+ '\u{51F5}',
+ '\u{5203}',
+ '\u{34DF}',
+ '\u{523B}',
+ '\u{5246}',
+ '\u{5272}',
+ '\u{5277}',
+ '\u{3515}',
+ '\u{52C7}',
+ '\u{52C9}',
+ '\u{52E4}',
+ '\u{52FA}',
+ '\u{5305}',
+ '\u{5306}',
+ '\u{5317}',
+ '\u{5349}',
+ '\u{5351}',
+ '\u{535A}',
+ '\u{5373}',
+ '\u{537D}',
+ '\u{537F}',
+ '\u{537F}',
+ '\u{537F}',
+ '\u{20A2C}',
+ '\u{7070}',
+ '\u{53CA}',
+ '\u{53DF}',
+ '\u{20B63}',
+ '\u{53EB}',
+ '\u{53F1}',
+ '\u{5406}',
+ '\u{549E}',
+ '\u{5438}',
+ '\u{5448}',
+ '\u{5468}',
+ '\u{54A2}',
+ '\u{54F6}',
+ '\u{5510}',
+ '\u{5553}',
+ '\u{5563}',
+ '\u{5584}',
+ '\u{5584}',
+ '\u{5599}',
+ '\u{55AB}',
+ '\u{55B3}',
+ '\u{55C2}',
+ '\u{5716}',
+ '\u{5606}',
+ '\u{5717}',
+ '\u{5651}',
+ '\u{5674}',
+ '\u{5207}',
+ '\u{58EE}',
+ '\u{57CE}',
+ '\u{57F4}',
+ '\u{580D}',
+ '\u{578B}',
+ '\u{5832}',
+ '\u{5831}',
+ '\u{58AC}',
+ '\u{214E4}',
+ '\u{58F2}',
+ '\u{58F7}',
+ '\u{5906}',
+ '\u{591A}',
+ '\u{5922}',
+ '\u{5962}',
+ '\u{216A8}',
+ '\u{216EA}',
+ '\u{59EC}',
+ '\u{5A1B}',
+ '\u{5A27}',
+ '\u{59D8}',
+ '\u{5A66}',
+ '\u{36EE}',
+ '\u{36FC}',
+ '\u{5B08}',
+ '\u{5B3E}',
+ '\u{5B3E}',
+ '\u{219C8}',
+ '\u{5BC3}',
+ '\u{5BD8}',
+ '\u{5BE7}',
+ '\u{5BF3}',
+ '\u{21B18}',
+ '\u{5BFF}',
+ '\u{5C06}',
+ '\u{5F53}',
+ '\u{5C22}',
+ '\u{3781}',
+ '\u{5C60}',
+ '\u{5C6E}',
+ '\u{5CC0}',
+ '\u{5C8D}',
+ '\u{21DE4}',
+ '\u{5D43}',
+ '\u{21DE6}',
+ '\u{5D6E}',
+ '\u{5D6B}',
+ '\u{5D7C}',
+ '\u{5DE1}',
+ '\u{5DE2}',
+ '\u{382F}',
+ '\u{5DFD}',
+ '\u{5E28}',
+ '\u{5E3D}',
+ '\u{5E69}',
+ '\u{3862}',
+ '\u{22183}',
+ '\u{387C}',
+ '\u{5EB0}',
+ '\u{5EB3}',
+ '\u{5EB6}',
+ '\u{5ECA}',
+ '\u{2A392}',
+ '\u{5EFE}',
+ '\u{22331}',
+ '\u{22331}',
+ '\u{8201}',
+ '\u{5F22}',
+ '\u{5F22}',
+ '\u{38C7}',
+ '\u{232B8}',
+ '\u{261DA}',
+ '\u{5F62}',
+ '\u{5F6B}',
+ '\u{38E3}',
+ '\u{5F9A}',
+ '\u{5FCD}',
+ '\u{5FD7}',
+ '\u{5FF9}',
+ '\u{6081}',
+ '\u{393A}',
+ '\u{391C}',
+ '\u{6094}',
+ '\u{226D4}',
+ '\u{60C7}',
+ '\u{6148}',
+ '\u{614C}',
+ '\u{614E}',
+ '\u{614C}',
+ '\u{617A}',
+ '\u{618E}',
+ '\u{61B2}',
+ '\u{61A4}',
+ '\u{61AF}',
+ '\u{61DE}',
+ '\u{61F2}',
+ '\u{61F6}',
+ '\u{6210}',
+ '\u{621B}',
+ '\u{625D}',
+ '\u{62B1}',
+ '\u{62D4}',
+ '\u{6350}',
+ '\u{22B0C}',
+ '\u{633D}',
+ '\u{62FC}',
+ '\u{6368}',
+ '\u{6383}',
+ '\u{63E4}',
+ '\u{22BF1}',
+ '\u{6422}',
+ '\u{63C5}',
+ '\u{63A9}',
+ '\u{3A2E}',
+ '\u{6469}',
+ '\u{647E}',
+ '\u{649D}',
+ '\u{6477}',
+ '\u{3A6C}',
+ '\u{654F}',
+ '\u{656C}',
+ '\u{2300A}',
+ '\u{65E3}',
+ '\u{66F8}',
+ '\u{6649}',
+ '\u{3B19}',
+ '\u{6691}',
+ '\u{3B08}',
+ '\u{3AE4}',
+ '\u{5192}',
+ '\u{5195}',
+ '\u{6700}',
+ '\u{669C}',
+ '\u{80AD}',
+ '\u{43D9}',
+ '\u{6717}',
+ '\u{671B}',
+ '\u{6721}',
+ '\u{675E}',
+ '\u{6753}',
+ '\u{233C3}',
+ '\u{3B49}',
+ '\u{67FA}',
+ '\u{6785}',
+ '\u{6852}',
+ '\u{6885}',
+ '\u{2346D}',
+ '\u{688E}',
+ '\u{681F}',
+ '\u{6914}',
+ '\u{3B9D}',
+ '\u{6942}',
+ '\u{69A3}',
+ '\u{69EA}',
+ '\u{6AA8}',
+ '\u{236A3}',
+ '\u{6ADB}',
+ '\u{3C18}',
+ '\u{6B21}',
+ '\u{238A7}',
+ '\u{6B54}',
+ '\u{3C4E}',
+ '\u{6B72}',
+ '\u{6B9F}',
+ '\u{6BBA}',
+ '\u{6BBB}',
+ '\u{23A8D}',
+ '\u{21D0B}',
+ '\u{23AFA}',
+ '\u{6C4E}',
+ '\u{23CBC}',
+ '\u{6CBF}',
+ '\u{6CCD}',
+ '\u{6C67}',
+ '\u{6D16}',
+ '\u{6D3E}',
+ '\u{6D77}',
+ '\u{6D41}',
+ '\u{6D69}',
+ '\u{6D78}',
+ '\u{6D85}',
+ '\u{23D1E}',
+ '\u{6D34}',
+ '\u{6E2F}',
+ '\u{6E6E}',
+ '\u{3D33}',
+ '\u{6ECB}',
+ '\u{6EC7}',
+ '\u{23ED1}',
+ '\u{6DF9}',
+ '\u{6F6E}',
+ '\u{23F5E}',
+ '\u{23F8E}',
+ '\u{6FC6}',
+ '\u{7039}',
+ '\u{701E}',
+ '\u{701B}',
+ '\u{3D96}',
+ '\u{704A}',
+ '\u{707D}',
+ '\u{7077}',
+ '\u{70AD}',
+ '\u{20525}',
+ '\u{7145}',
+ '\u{24263}',
+ '\u{719C}',
+ '\u{243AB}',
+ '\u{7228}',
+ '\u{7235}',
+ '\u{7250}',
+ '\u{24608}',
+ '\u{7280}',
+ '\u{7295}',
+ '\u{24735}',
+ '\u{24814}',
+ '\u{737A}',
+ '\u{738B}',
+ '\u{3EAC}',
+ '\u{73A5}',
+ '\u{3EB8}',
+ '\u{3EB8}',
+ '\u{7447}',
+ '\u{745C}',
+ '\u{7471}',
+ '\u{7485}',
+ '\u{74CA}',
+ '\u{3F1B}',
+ '\u{7524}',
+ '\u{24C36}',
+ '\u{753E}',
+ '\u{24C92}',
+ '\u{7570}',
+ '\u{2219F}',
+ '\u{7610}',
+ '\u{24FA1}',
+ '\u{24FB8}',
+ '\u{25044}',
+ '\u{3FFC}',
+ '\u{4008}',
+ '\u{76F4}',
+ '\u{250F3}',
+ '\u{250F2}',
+ '\u{25119}',
+ '\u{25133}',
+ '\u{771E}',
+ '\u{771F}',
+ '\u{771F}',
+ '\u{774A}',
+ '\u{4039}',
+ '\u{778B}',
+ '\u{4046}',
+ '\u{4096}',
+ '\u{2541D}',
+ '\u{784E}',
+ '\u{788C}',
+ '\u{78CC}',
+ '\u{40E3}',
+ '\u{25626}',
+ '\u{7956}',
+ '\u{2569A}',
+ '\u{256C5}',
+ '\u{798F}',
+ '\u{79EB}',
+ '\u{412F}',
+ '\u{7A40}',
+ '\u{7A4A}',
+ '\u{7A4F}',
+ '\u{2597C}',
+ '\u{25AA7}',
+ '\u{25AA7}',
+ '\u{7AEE}',
+ '\u{4202}',
+ '\u{25BAB}',
+ '\u{7BC6}',
+ '\u{7BC9}',
+ '\u{4227}',
+ '\u{25C80}',
+ '\u{7CD2}',
+ '\u{42A0}',
+ '\u{7CE8}',
+ '\u{7CE3}',
+ '\u{7D00}',
+ '\u{25F86}',
+ '\u{7D63}',
+ '\u{4301}',
+ '\u{7DC7}',
+ '\u{7E02}',
+ '\u{7E45}',
+ '\u{4334}',
+ '\u{26228}',
+ '\u{26247}',
+ '\u{4359}',
+ '\u{262D9}',
+ '\u{7F7A}',
+ '\u{2633E}',
+ '\u{7F95}',
+ '\u{7FFA}',
+ '\u{8005}',
+ '\u{264DA}',
+ '\u{26523}',
+ '\u{8060}',
+ '\u{265A8}',
+ '\u{8070}',
+ '\u{2335F}',
+ '\u{43D5}',
+ '\u{80B2}',
+ '\u{8103}',
+ '\u{440B}',
+ '\u{813E}',
+ '\u{5AB5}',
+ '\u{267A7}',
+ '\u{267B5}',
+ '\u{23393}',
+ '\u{2339C}',
+ '\u{8201}',
+ '\u{8204}',
+ '\u{8F9E}',
+ '\u{446B}',
+ '\u{8291}',
+ '\u{828B}',
+ '\u{829D}',
+ '\u{52B3}',
+ '\u{82B1}',
+ '\u{82B3}',
+ '\u{82BD}',
+ '\u{82E6}',
+ '\u{26B3C}',
+ '\u{82E5}',
+ '\u{831D}',
+ '\u{8363}',
+ '\u{83AD}',
+ '\u{8323}',
+ '\u{83BD}',
+ '\u{83E7}',
+ '\u{8457}',
+ '\u{8353}',
+ '\u{83CA}',
+ '\u{83CC}',
+ '\u{83DC}',
+ '\u{26C36}',
+ '\u{26D6B}',
+ '\u{26CD5}',
+ '\u{452B}',
+ '\u{84F1}',
+ '\u{84F3}',
+ '\u{8516}',
+ '\u{273CA}',
+ '\u{8564}',
+ '\u{26F2C}',
+ '\u{455D}',
+ '\u{4561}',
+ '\u{26FB1}',
+ '\u{270D2}',
+ '\u{456B}',
+ '\u{8650}',
+ '\u{865C}',
+ '\u{8667}',
+ '\u{8669}',
+ '\u{86A9}',
+ '\u{8688}',
+ '\u{870E}',
+ '\u{86E2}',
+ '\u{8779}',
+ '\u{8728}',
+ '\u{876B}',
+ '\u{8786}',
+ '\u{45D7}',
+ '\u{87E1}',
+ '\u{8801}',
+ '\u{45F9}',
+ '\u{8860}',
+ '\u{8863}',
+ '\u{27667}',
+ '\u{88D7}',
+ '\u{88DE}',
+ '\u{4635}',
+ '\u{88FA}',
+ '\u{34BB}',
+ '\u{278AE}',
+ '\u{27966}',
+ '\u{46BE}',
+ '\u{46C7}',
+ '\u{8AA0}',
+ '\u{8AED}',
+ '\u{8B8A}',
+ '\u{8C55}',
+ '\u{27CA8}',
+ '\u{8CAB}',
+ '\u{8CC1}',
+ '\u{8D1B}',
+ '\u{8D77}',
+ '\u{27F2F}',
+ '\u{20804}',
+ '\u{8DCB}',
+ '\u{8DBC}',
+ '\u{8DF0}',
+ '\u{208DE}',
+ '\u{8ED4}',
+ '\u{8F38}',
+ '\u{285D2}',
+ '\u{285ED}',
+ '\u{9094}',
+ '\u{90F1}',
+ '\u{9111}',
+ '\u{2872E}',
+ '\u{911B}',
+ '\u{9238}',
+ '\u{92D7}',
+ '\u{92D8}',
+ '\u{927C}',
+ '\u{93F9}',
+ '\u{9415}',
+ '\u{28BFA}',
+ '\u{958B}',
+ '\u{4995}',
+ '\u{95B7}',
+ '\u{28D77}',
+ '\u{49E6}',
+ '\u{96C3}',
+ '\u{5DB2}',
+ '\u{9723}',
+ '\u{29145}',
+ '\u{2921A}',
+ '\u{4A6E}',
+ '\u{4A76}',
+ '\u{97E0}',
+ '\u{2940A}',
+ '\u{4AB2}',
+ '\u{29496}',
+ '\u{980B}',
+ '\u{980B}',
+ '\u{9829}',
+ '\u{295B6}',
+ '\u{98E2}',
+ '\u{4B33}',
+ '\u{9929}',
+ '\u{99A7}',
+ '\u{99C2}',
+ '\u{99FE}',
+ '\u{4BCE}',
+ '\u{29B30}',
+ '\u{9B12}',
+ '\u{9C40}',
+ '\u{9CFD}',
+ '\u{4CCE}',
+ '\u{4CED}',
+ '\u{9D67}',
+ '\u{2A0CE}',
+ '\u{4CF8}',
+ '\u{2A105}',
+ '\u{2A20E}',
+ '\u{2A291}',
+ '\u{9EBB}',
+ '\u{4D56}',
+ '\u{9EF9}',
+ '\u{9EFE}',
+ '\u{9F05}',
+ '\u{9F0F}',
+ '\u{9F16}',
+ '\u{9F3B}',
+ '\u{2A600}',
+];
+pub(crate) const CANONICAL_DECOMPOSED_SALT: &[u16] = &[
+ 0xcae,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x45a,
+ 0x23f,
+ 0x0,
+ 0x1e8,
+ 0x28,
+ 0x280,
+ 0x0,
+ 0x6,
+ 0x14c,
+ 0x201,
+ 0x6,
+ 0x20,
+ 0x3,
+ 0x0,
+ 0x71,
+ 0x18b,
+ 0xd,
+ 0x14d,
+ 0xd3,
+ 0x0,
+ 0x2,
+ 0x85,
+ 0x45,
+ 0xa,
+ 0x4,
+ 0xe9,
+ 0x21,
+ 0x0,
+ 0x0,
+ 0xaa,
+ 0x2,
+ 0x105,
+ 0x0,
+ 0x1b5,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x67,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x47,
+ 0x32,
+ 0x0,
+ 0x0,
+ 0x3c,
+ 0x45,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x10,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xce,
+ 0x2c,
+ 0x0,
+ 0x1d,
+ 0x0,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x3,
+ 0x1c,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x6a,
+ 0x1,
+ 0x16,
+ 0x0,
+ 0x6f,
+ 0x0,
+ 0x1,
+ 0x25,
+ 0x0,
+ 0x27,
+ 0x10,
+ 0x0,
+ 0x22,
+ 0x0,
+ 0xbc,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x15,
+ 0x0,
+ 0x0,
+ 0x13,
+ 0x0,
+ 0x87,
+ 0x0,
+ 0x3a,
+ 0x27,
+ 0x0,
+ 0x5,
+ 0x16,
+ 0x5,
+ 0x14,
+ 0x12,
+ 0x21,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x15,
+ 0x26,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x17,
+ 0x19,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x10,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x22,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x13,
+ 0x0,
+ 0x11,
+ 0x5a,
+ 0x5,
+ 0x13,
+ 0xd,
+ 0x4e,
+ 0x8,
+ 0x4,
+ 0x18,
+ 0x9,
+ 0x64,
+ 0x26,
+ 0x0,
+ 0x11,
+ 0x0,
+ 0x5,
+ 0x30,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3e,
+ 0x46,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x37,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x13,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0xb,
+ 0x1c,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x2f,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x1d,
+ 0x30,
+ 0x0,
+ 0x25,
+ 0x2,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x23,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x18,
+ 0xe,
+ 0x0,
+ 0x11,
+ 0xc,
+ 0x15,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x8,
+ 0x8,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0xe,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x2c,
+ 0x3,
+ 0x1,
+ 0x16,
+ 0x11,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x18,
+ 0x1,
+ 0x30,
+ 0x4,
+ 0xc,
+ 0xe,
+ 0x9,
+ 0x0,
+ 0x3,
+ 0xb,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x10,
+ 0x3,
+ 0x2,
+ 0x6,
+ 0xb,
+ 0x8,
+ 0xa,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x1,
+ 0x25,
+ 0x3,
+ 0x1b,
+ 0x2,
+ 0x12,
+ 0x5,
+ 0x7,
+ 0x12,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x11,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x43,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x5,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x22,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x14,
+ 0x1,
+ 0x31,
+ 0x0,
+ 0x4,
+ 0x20,
+ 0x9,
+ 0x7,
+ 0x1,
+ 0x21,
+ 0x16,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0xe,
+ 0x0,
+ 0x5,
+ 0x12,
+ 0xe,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1d,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1d,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x4,
+ 0x1,
+ 0x3,
+ 0xe,
+ 0x9,
+ 0x10,
+ 0x8,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x22,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x13,
+ 0x11,
+ 0x0,
+ 0x2,
+ 0xd,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0xc,
+ 0x1,
+ 0x16,
+ 0xe,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x15,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0xd,
+ 0x11,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0xd,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0xc,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x27,
+ 0x1c,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x7,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xf,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x16,
+ 0xb,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x8,
+ 0x4,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x18,
+ 0x9,
+ 0x4,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1e,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xa,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x1f,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x24,
+ 0x7,
+ 0x5,
+ 0x2,
+ 0x2,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x2,
+ 0xc,
+ 0xe,
+ 0x1e,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0xd,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0xa,
+ 0x4,
+ 0x0,
+ 0xf,
+ 0x10,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x5,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x17,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x3,
+ 0xd,
+ 0x0,
+ 0x5,
+ 0x7,
+ 0x4,
+ 0x8,
+ 0x0,
+ 0xb,
+ 0x8,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x5,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x13,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x11,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2f,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x15,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1a,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xe,
+ 0x2,
+ 0x2,
+ 0x9,
+ 0x2,
+ 0xb,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x18,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x19,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1c,
+ 0x6,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x16,
+ 0x6,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x9,
+ 0xf,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0xa,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x14,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xe,
+ 0x0,
+ 0x2,
+ 0x17,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0xf,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x1,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0xe,
+ 0x20,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0xa,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x6,
+ 0x8,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x6,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x7,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0xe,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x3,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0xb,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x9,
+ 0x6,
+ 0x0,
+ 0x9,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x10,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0xa,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x5,
+ 0x5,
+ 0x7,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x3,
+ 0x10,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x7,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x2,
+ 0x5,
+ 0x6,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x9,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+];
+pub(crate) const CANONICAL_DECOMPOSED_KV: &[(u32, (u16, u16))] = &[
+ (0x4ee, (666, 2)),
+ (0x2f869, (2969, 1)),
+ (0x30b2, (2217, 2)),
+ (0x1f2e, (1546, 3)),
+ (0x120, (166, 2)),
+ (0xf905, (2278, 1)),
+ (0xf9e8, (2505, 1)),
+ (0x1e3a, (978, 2)),
+ (0xf965, (2374, 1)),
+ (0x1ebd, (1270, 2)),
+ (0x2f83a, (2922, 1)),
+ (0x101, (108, 2)),
+ (0xf986, (2407, 1)),
+ (0xfa57, (2604, 1)),
+ (0x1f91, (1796, 3)),
+ (0x4df, (644, 2)),
+ (0x1e2, (382, 2)),
+ (0x229, (498, 2)),
+ (0x1af, (326, 2)),
+ (0xfa66, (2619, 1)),
+ (0x1f39, (1576, 2)),
+ (0x1e7a, (1124, 3)),
+ (0x1f6c, (1693, 3)),
+ (0xfaa8, (2683, 1)),
+ (0x2f8ce, (3070, 1)),
+ (0x128, (178, 2)),
+ (0xfa4b, (2592, 1)),
+ (0x2f818, (2888, 1)),
+ (0x2f988, (3256, 1)),
+ (0xf974, (2389, 1)),
+ (0x1ea9, (1215, 3)),
+ (0x1f51, (1630, 2)),
+ (0x2f833, (2915, 1)),
+ (0x2f8fc, (3116, 1)),
+ (0x38f, (548, 2)),
+ (0xfa3e, (2579, 1)),
+ (0xfa5e, (2611, 1)),
+ (0xfa1e, (2554, 1)),
+ (0x2f9f7, (3367, 1)),
+ (0x15f, (262, 2)),
+ (0x1e35, (966, 2)),
+ (0xfb47, (2787, 2)),
+ (0x2f962, (3218, 1)),
+ (0xfa86, (2649, 1)),
+ (0xf92f, (2320, 1)),
+ (0x2f8dd, (3085, 1)),
+ (0xf73, (804, 2)),
+ (0x1e15, (895, 3)),
+ (0x1ed0, (1318, 3)),
+ (0xf9ca, (2475, 1)),
+ (0x4e6, (654, 2)),
+ (0x1fa2, (1859, 4)),
+ (0x2f999, (3273, 1)),
+ (0x1fc2, (1943, 3)),
+ (0x2f8c7, (3063, 1)),
+ (0xfabc, (2703, 1)),
+ (0x30b4, (2219, 2)),
+ (0x2f9b9, (3305, 1)),
+ (0x1e73, (1108, 2)),
+ (0xf95b, (2364, 1)),
+ (0x2f952, (3202, 1)),
+ (0xfa5f, (2612, 1)),
+ (0x1b08, (830, 2)),
+ (0x2204, (2077, 2)),
+ (0x1ea2, (1196, 2)),
+ (0x1ea, (394, 2)),
+ (0x129, (180, 2)),
+ (0xf920, (2305, 1)),
+ (0x1f85, (1751, 4)),
+ (0x1e93, (1176, 2)),
+ (0x2f9b2, (3298, 1)),
+ (0x2f821, (2897, 1)),
+ (0x2f9d6, (3334, 1)),
+ (0xfa65, (2618, 1)),
+ (0xf971, (2386, 1)),
+ (0x230, (516, 3)),
+ (0x16d, (286, 2)),
+ (0x21b, (486, 2)),
+ (0x2f9d4, (3332, 1)),
+ (0x1d161, (2836, 3)),
+ (0xfa94, (2663, 1)),
+ (0x403, (586, 2)),
+ (0x16a, (280, 2)),
+ (0x958, (708, 2)),
+ (0x2f922, (3154, 1)),
+ (0xf93d, (2334, 1)),
+ (0x1e39, (975, 3)),
+ (0x2f870, (2976, 1)),
+ (0x1eae, (1230, 3)),
+ (0x1f35, (1565, 3)),
+ (0xfa2f, (2564, 1)),
+ (0x15e, (260, 2)),
+ (0x1e43, (996, 2)),
+ (0x2f842, (2930, 1)),
+ (0xf9b1, (2450, 1)),
+ (0xfa5d, (2610, 1)),
+ (0xf9d2, (2483, 1)),
+ (0x1ed8, (1342, 3)),
+ (0xfaca, (2717, 1)),
+ (0x1edc, (1354, 3)),
+ (0x2f9fd, (3373, 1)),
+ (0x2f90b, (3131, 1)),
+ (0x1ec9, (1304, 2)),
+ (0x2329, (2153, 1)),
+ (0x1e96, (1182, 2)),
+ (0x2f9a0, (3280, 1)),
+ (0xf9d0, (2481, 1)),
+ (0x4ed, (664, 2)),
+ (0xc2, (4, 2)),
+ (0x1e79, (1121, 3)),
+ (0x4f1, (672, 2)),
+ (0x1fd0, (1972, 2)),
+ (0x1ef5, (1422, 2)),
+ (0x125, (176, 2)),
+ (0xfb2c, (2741, 3)),
+ (0x387, (537, 1)),
+ (0xf9ef, (2512, 1)),
+ (0x2f9f5, (3365, 1)),
+ (0x170, (292, 2)),
+ (0x2270, (2105, 2)),
+ (0x2f9cc, (3324, 1)),
+ (0xfa6d, (2626, 1)),
+ (0xf980, (2401, 1)),
+ (0xf907, (2280, 1)),
+ (0x2f857, (2951, 1)),
+ (0x1eb9, (1262, 2)),
+ (0x2f8d5, (3077, 1)),
+ (0xf9f9, (2522, 1)),
+ (0x2f8a2, (3026, 1)),
+ (0xf94b, (2348, 1)),
+ (0x2f87e, (2990, 1)),
+ (0xf91f, (2304, 1)),
+ (0xf9ec, (2509, 1)),
+ (0x4f4, (678, 2)),
+ (0x451, (602, 2)),
+ (0x22ad, (2131, 2)),
+ (0x2f917, (3143, 1)),
+ (0x2f861, (2961, 1)),
+ (0xf91d, (2302, 1)),
+ (0xfa96, (2665, 1)),
+ (0xf6, (92, 2)),
+ (0x1e27, (936, 2)),
+ (0x1f48, (1612, 2)),
+ (0x1feb, (2026, 2)),
+ (0x1ee5, (1380, 2)),
+ (0x2f99f, (3279, 1)),
+ (0x2f8e8, (3096, 1)),
+ (0xf9df, (2496, 1)),
+ (0x1eaf, (1233, 3)),
+ (0xf92a, (2315, 1)),
+ (0xfa78, (2635, 1)),
+ (0xfa6c, (2625, 1)),
+ (0x1e22, (926, 2)),
+ (0x1eea, (1392, 3)),
+ (0x2f850, (2944, 1)),
+ (0x2f9c9, (3321, 1)),
+ (0xf91c, (2301, 1)),
+ (0xa33, (734, 2)),
+ (0xe7, (64, 2)),
+ (0x2f80b, (2875, 1)),
+ (0xfa91, (2660, 1)),
+ (0x9dd, (730, 2)),
+ (0x2f848, (2936, 1)),
+ (0xf966, (2375, 1)),
+ (0xfb36, (2763, 2)),
+ (0xf957, (2360, 1)),
+ (0x2f88a, (3002, 1)),
+ (0x305c, (2173, 2)),
+ (0x2f982, (3250, 1)),
+ (0x122, (170, 2)),
+ (0xf95d, (2366, 1)),
+ (0x2f8cc, (3068, 1)),
+ (0x2f86a, (2970, 1)),
+ (0x1f81, (1736, 3)),
+ (0x212a, (2062, 1)),
+ (0x17e, (320, 2)),
+ (0xf9a9, (2442, 1)),
+ (0xfabd, (2704, 1)),
+ (0x2f91e, (3150, 1)),
+ (0xf9eb, (2508, 1)),
+ (0x2f937, (3175, 1)),
+ (0x2f8a6, (3030, 1)),
+ (0x1e42, (994, 2)),
+ (0x1112f, (2811, 2)),
+ (0x1fa8, (1883, 3)),
+ (0xc0, (0, 2)),
+ (0x2f8da, (3082, 1)),
+ (0x2f9b5, (3301, 1)),
+ (0x2f8c1, (3057, 1)),
+ (0xf9b4, (2453, 1)),
+ (0x171, (294, 2)),
+ (0xf952, (2355, 1)),
+ (0xfa08, (2537, 1)),
+ (0x1fac, (1897, 4)),
+ (0x1fb, (421, 3)),
+ (0xf912, (2291, 1)),
+ (0x1f11, (1478, 2)),
+ (0x201, (434, 2)),
+ (0x2f8b9, (3049, 1)),
+ (0x2fa1c, (3404, 1)),
+ (0x2f8b5, (3045, 1)),
+ (0x1e88, (1154, 2)),
+ (0xfab8, (2699, 1)),
+ (0xfa43, (2584, 1)),
+ (0x144, (218, 2)),
+ (0x1e8b, (1160, 2)),
+ (0x2f9e1, (3345, 1)),
+ (0xf97c, (2397, 1)),
+ (0xf985, (2406, 1)),
+ (0x1f06, (1448, 3)),
+ (0x1fb2, (1917, 3)),
+ (0x2f9db, (3339, 1)),
+ (0x1fe4, (2011, 2)),
+ (0xfac3, (2710, 1)),
+ (0x177, (306, 2)),
+ (0x2f948, (3192, 1)),
+ (0xcb, (20, 2)),
+ (0x1f9f, (1849, 4)),
+ (0xfa99, (2668, 1)),
+ (0x2f942, (3186, 1)),
+ (0x2f976, (3238, 1)),
+ (0xf988, (2409, 1)),
+ (0x1fe6, (2015, 2)),
+ (0x156, (244, 2)),
+ (0x1e8e, (1166, 2)),
+ (0x2f8fe, (3118, 1)),
+ (0x1e46, (1002, 2)),
+ (0x2f81e, (2894, 1)),
+ (0x45d, (610, 2)),
+ (0x1fcf, (1970, 2)),
+ (0x1ecf, (1316, 2)),
+ (0x1e48, (1006, 2)),
+ (0xf9cb, (2476, 1)),
+ (0x2f946, (3190, 1)),
+ (0xfacf, (2722, 1)),
+ (0x109, (124, 2)),
+ (0x22e3, (2143, 2)),
+ (0xf52, (796, 2)),
+ (0x304c, (2157, 2)),
+ (0xf9b2, (2451, 1)),
+ (0x12c, (186, 2)),
+ (0x2f969, (3225, 1)),
+ (0x2f9a5, (3285, 1)),
+ (0x307a, (2201, 2)),
+ (0x2f9be, (3310, 1)),
+ (0x1f1b, (1499, 3)),
+ (0x1f5d, (1655, 3)),
+ (0x2f9ab, (3291, 1)),
+ (0x2f8f1, (3105, 1)),
+ (0xf9be, (2463, 1)),
+ (0xf9b8, (2457, 1)),
+ (0x1fb4, (1922, 3)),
+ (0x1edf, (1363, 3)),
+ (0x22f, (514, 2)),
+ (0x934, (706, 2)),
+ (0x2f98a, (3258, 1)),
+ (0x1fe8, (2020, 2)),
+ (0xfaab, (2686, 1)),
+ (0xfa5b, (2608, 1)),
+ (0x4d3, (628, 2)),
+ (0x2226, (2085, 2)),
+ (0x2fa03, (3379, 1)),
+ (0xfa12, (2544, 1)),
+ (0x1ee4, (1378, 2)),
+ (0x1fd6, (1982, 2)),
+ (0xf931, (2322, 1)),
+ (0xfaa1, (2676, 1)),
+ (0x2f936, (3174, 1)),
+ (0x1fe9, (2022, 2)),
+ (0x1ff4, (2040, 3)),
+ (0x2f86c, (2972, 1)),
+ (0x2f911, (3137, 1)),
+ (0x95f, (722, 2)),
+ (0xcd, (24, 2)),
+ (0x2f95e, (3214, 1)),
+ (0xf98f, (2416, 1)),
+ (0x1e08, (866, 3)),
+ (0x30fa, (2269, 2)),
+ (0x4da, (634, 2)),
+ (0xf9c5, (2470, 1)),
+ (0x1d8, (355, 3)),
+ (0x1ec, (398, 3)),
+ (0xf95e, (2367, 1)),
+ (0xfb4e, (2801, 2)),
+ (0xc5, (10, 2)),
+ (0x2f87d, (2989, 1)),
+ (0x1b0c, (834, 2)),
+ (0x2f9c6, (3318, 1)),
+ (0x2f879, (2985, 1)),
+ (0x2f9f2, (3362, 1)),
+ (0x1ece, (1314, 2)),
+ (0xdda, (783, 2)),
+ (0x1f80, (1733, 3)),
+ (0x3074, (2193, 2)),
+ (0x2289, (2127, 2)),
+ (0x1d0, (336, 2)),
+ (0x1eac, (1224, 3)),
+ (0x2f851, (2945, 1)),
+ (0x22c, (506, 3)),
+ (0x1f9e, (1845, 4)),
+ (0x2f9d2, (3330, 1)),
+ (0xfa05, (2534, 1)),
+ (0x2f88c, (3004, 1)),
+ (0x1ffd, (2058, 1)),
+ (0x1f0b, (1461, 3)),
+ (0xfaba, (2701, 1)),
+ (0x1e82, (1142, 2)),
+ (0x2f8c2, (3058, 1)),
+ (0x1f30, (1552, 2)),
+ (0x1f87, (1759, 4)),
+ (0xfa61, (2614, 1)),
+ (0x1b06, (828, 2)),
+ (0x2f9e8, (3352, 1)),
+ (0x2f80e, (2878, 1)),
+ (0x1f00, (1432, 2)),
+ (0xfa03, (2532, 1)),
+ (0x202, (436, 2)),
+ (0x1ce, (332, 2)),
+ (0x2fa12, (3394, 1)),
+ (0x2f84f, (2943, 1)),
+ (0x4c1, (618, 2)),
+ (0xfa81, (2644, 1)),
+ (0xfac7, (2714, 1)),
+ (0xf9bb, (2460, 1)),
+ (0x16f, (290, 2)),
+ (0x114, (142, 2)),
+ (0xcc7, (768, 2)),
+ (0x1b0e, (836, 2)),
+ (0x2f9d1, (3329, 1)),
+ (0x139, (204, 2)),
+ (0x2f836, (2918, 1)),
+ (0xb48, (746, 2)),
+ (0x30f9, (2267, 2)),
+ (0xfa79, (2636, 1)),
+ (0x3058, (2169, 2)),
+ (0x2f971, (3233, 1)),
+ (0x2f928, (3160, 1)),
+ (0x1fc, (424, 2)),
+ (0x2224, (2083, 2)),
+ (0xfab3, (2694, 1)),
+ (0x2f8e7, (3095, 1)),
+ (0x1fde, (1997, 2)),
+ (0x1e7, (388, 2)),
+ (0x1e13, (890, 2)),
+ (0xfa5a, (2607, 1)),
+ (0x1fce, (1968, 2)),
+ (0x1e58, (1046, 2)),
+ (0x2f964, (3220, 1)),
+ (0xfabe, (2705, 1)),
+ (0x1e0f, (882, 2)),
+ (0x2f938, (3176, 1)),
+ (0x11d, (160, 2)),
+ (0xf994, (2421, 1)),
+ (0xf947, (2344, 1)),
+ (0x3aa, (553, 2)),
+ (0xf981, (2402, 1)),
+ (0x1e30, (956, 2)),
+ (0x1f14, (1486, 3)),
+ (0xf9f1, (2514, 1)),
+ (0x1fa9, (1886, 3)),
+ (0x1e62, (1068, 2)),
+ (0x2f85d, (2957, 1)),
+ (0xfa4e, (2595, 1)),
+ (0x1f22, (1512, 3)),
+ (0x2f838, (2920, 1)),
+ (0x2f9a6, (3286, 1)),
+ (0xf93f, (2336, 1)),
+ (0x2f9f3, (3363, 1)),
+ (0xfaad, (2688, 1)),
+ (0x2f87a, (2986, 1)),
+ (0x2f830, (2912, 1)),
+ (0x2f8c8, (3064, 1)),
+ (0x10a, (126, 2)),
+ (0x20b, (454, 2)),
+ (0x1f77, (1719, 2)),
+ (0xfab4, (2695, 1)),
+ (0x2f985, (3253, 1)),
+ (0xf9f7, (2520, 1)),
+ (0x2f94f, (3199, 1)),
+ (0xfa40, (2581, 1)),
+ (0x2f968, (3224, 1)),
+ (0xfa8c, (2655, 1)),
+ (0xce, (26, 2)),
+ (0xfac0, (2707, 1)),
+ (0x3062, (2179, 2)),
+ (0xf9, (94, 2)),
+ (0x1fb0, (1913, 2)),
+ (0xb94, (756, 2)),
+ (0x2f926, (3158, 1)),
+ (0x1f84, (1747, 4)),
+ (0x4ef, (668, 2)),
+ (0xf9d, (816, 2)),
+ (0x226d, (2099, 2)),
+ (0x1f28, (1530, 2)),
+ (0x2f955, (3205, 1)),
+ (0x2279, (2115, 2)),
+ (0xfab6, (2697, 1)),
+ (0xf935, (2326, 1)),
+ (0x439, (598, 2)),
+ (0x11938, (2827, 2)),
+ (0xee, (78, 2)),
+ (0x17b, (314, 2)),
+ (0x1e0c, (876, 2)),
+ (0x1e6a, (1090, 2)),
+ (0x214, (472, 2)),
+ (0xf57, (798, 2)),
+ (0x2f825, (2901, 1)),
+ (0x114bb, (2817, 2)),
+ (0x100, (106, 2)),
+ (0x1e6, (386, 2)),
+ (0x2f951, (3201, 1)),
+ (0x2f9ce, (3326, 1)),
+ (0x2f984, (3252, 1)),
+ (0x22eb, (2147, 2)),
+ (0x1f6b, (1690, 3)),
+ (0x13b, (208, 2)),
+ (0x2f9e9, (3353, 1)),
+ (0x2f8be, (3054, 1)),
+ (0x2f823, (2899, 1)),
+ (0x2f9d3, (3331, 1)),
+ (0x2f97c, (3244, 1)),
+ (0xfa49, (2590, 1)),
+ (0x1eb1, (1239, 3)),
+ (0x2f998, (3272, 1)),
+ (0x304e, (2159, 2)),
+ (0x1f0d, (1467, 3)),
+ (0xd4a, (777, 2)),
+ (0xfb39, (2767, 2)),
+ (0x305a, (2171, 2)),
+ (0xf9b0, (2449, 1)),
+ (0x2f8ff, (3119, 1)),
+ (0x30ae, (2213, 2)),
+ (0x2f977, (3239, 1)),
+ (0x1fa, (418, 3)),
+ (0x1e20, (922, 2)),
+ (0xf917, (2296, 1)),
+ (0xf989, (2410, 1)),
+ (0xf90e, (2287, 1)),
+ (0xfb34, (2759, 2)),
+ (0x2f889, (3001, 1)),
+ (0x2f866, (2966, 1)),
+ (0x2f865, (2965, 1)),
+ (0x12f, (192, 2)),
+ (0x2fa0e, (3390, 1)),
+ (0x1e61, (1066, 2)),
+ (0x1fd, (426, 2)),
+ (0x2f803, (2867, 1)),
+ (0x1fe3, (2008, 3)),
+ (0xfa44, (2585, 1)),
+ (0x1fa6, (1875, 4)),
+ (0x20f, (462, 2)),
+ (0x1fa4, (1867, 4)),
+ (0xccb, (774, 3)),
+ (0xfa4f, (2596, 1)),
+ (0x2f997, (3271, 1)),
+ (0x1e4b, (1012, 2)),
+ (0xfaa2, (2677, 1)),
+ (0x2f839, (2921, 1)),
+ (0x1f55, (1641, 3)),
+ (0x1e32, (960, 2)),
+ (0xf9f0, (2513, 1)),
+ (0xea, (70, 2)),
+ (0x2f8d4, (3076, 1)),
+ (0xf969, (2378, 1)),
+ (0xfa, (96, 2)),
+ (0x1e33, (962, 2)),
+ (0x1e6f, (1100, 2)),
+ (0xf9aa, (2443, 1)),
+ (0xf938, (2329, 1)),
+ (0x2f826, (2902, 1)),
+ (0xf93c, (2333, 1)),
+ (0x4e2, (646, 2)),
+ (0x1e5f, (1062, 2)),
+ (0x4c2, (620, 2)),
+ (0x4dd, (640, 2)),
+ (0x390, (550, 3)),
+ (0x2f923, (3155, 1)),
+ (0x419, (596, 2)),
+ (0x2f8e9, (3097, 1)),
+ (0x1b3b, (840, 2)),
+ (0x2f860, (2960, 1)),
+ (0x1ec0, (1278, 3)),
+ (0x124, (174, 2)),
+ (0x2f935, (3173, 1)),
+ (0x21cd, (2071, 2)),
+ (0x2f81f, (2895, 1)),
+ (0x1f95, (1811, 4)),
+ (0xfa59, (2606, 1)),
+ (0xfb4a, (2793, 2)),
+ (0x137, (202, 2)),
+ (0x2fa19, (3401, 1)),
+ (0x1e8c, (1162, 2)),
+ (0x2fa11, (3393, 1)),
+ (0xf992, (2419, 1)),
+ (0xf99b, (2428, 1)),
+ (0x226f, (2103, 2)),
+ (0x2f908, (3128, 1)),
+ (0x1ea1, (1194, 2)),
+ (0x30c7, (2237, 2)),
+ (0xf5c, (800, 2)),
+ (0x114bc, (2819, 2)),
+ (0xf91a, (2299, 1)),
+ (0xfb49, (2791, 2)),
+ (0x2f892, (3010, 1)),
+ (0x1d1bb, (2848, 2)),
+ (0x40e, (594, 2)),
+ (0x1e7e, (1134, 2)),
+ (0x1fd3, (1979, 3)),
+ (0x1fb6, (1925, 2)),
+ (0x164, (272, 2)),
+ (0x2f92b, (3163, 1)),
+ (0x1f3d, (1587, 3)),
+ (0x386, (535, 2)),
+ (0x1f24, (1518, 3)),
+ (0xfacd, (2720, 1)),
+ (0xfa17, (2547, 1)),
+ (0x1e17, (901, 3)),
+ (0xfa0b, (2540, 1)),
+ (0x2f980, (3248, 1)),
+ (0xfa2d, (2562, 1)),
+ (0x2f88e, (3006, 1)),
+ (0xfb2e, (2747, 2)),
+ (0xfa31, (2566, 1)),
+ (0x1f09, (1456, 2)),
+ (0x2f815, (2885, 1)),
+ (0x2f9ca, (3322, 1)),
+ (0xfa55, (2602, 1)),
+ (0x2f9f9, (3369, 1)),
+ (0x1f62, (1665, 3)),
+ (0x106, (118, 2)),
+ (0x1ebf, (1275, 3)),
+ (0x1f38, (1574, 2)),
+ (0x1f20, (1508, 2)),
+ (0x2f965, (3221, 1)),
+ (0x2f829, (2905, 1)),
+ (0x1ffb, (2054, 2)),
+ (0xc9, (16, 2)),
+ (0x147, (224, 2)),
+ (0x2f9c3, (3315, 1)),
+ (0x213, (470, 2)),
+ (0x1f9d, (1841, 4)),
+ (0x1f25, (1521, 3)),
+ (0x2f9af, (3295, 1)),
+ (0xfa77, (2634, 1)),
+ (0x2209, (2079, 2)),
+ (0xf76, (808, 2)),
+ (0xf956, (2359, 1)),
+ (0x1fcc, (1964, 2)),
+ (0x1fa0, (1853, 3)),
+ (0x13c, (210, 2)),
+ (0x1eb3, (1245, 3)),
+ (0x1e5a, (1050, 2)),
+ (0xfb35, (2761, 2)),
+ (0xf9b5, (2454, 1)),
+ (0xfa0a, (2539, 1)),
+ (0x1fa5, (1871, 4)),
+ (0x22e, (512, 2)),
+ (0x1eee, (1404, 3)),
+ (0x1d5, (346, 3)),
+ (0x15c, (256, 2)),
+ (0xe3, (58, 2)),
+ (0xfa8b, (2654, 1)),
+ (0x3079, (2199, 2)),
+ (0xfb38, (2765, 2)),
+ (0x2f855, (2949, 1)),
+ (0xfa9e, (2673, 1)),
+ (0x14e, (232, 2)),
+ (0x1e75, (1112, 2)),
+ (0xfa46, (2587, 1)),
+ (0x2fa0a, (3386, 1)),
+ (0x211, (466, 2)),
+ (0x2f8a9, (3033, 1)),
+ (0x115, (144, 2)),
+ (0x30d1, (2243, 2)),
+ (0x1e47, (1004, 2)),
+ (0x2f8e0, (3088, 1)),
+ (0xfa7e, (2641, 1)),
+ (0x1fd8, (1987, 2)),
+ (0x1e92, (1174, 2)),
+ (0x2f867, (2967, 1)),
+ (0xfb1d, (2733, 2)),
+ (0xf97d, (2398, 1)),
+ (0xfab9, (2700, 1)),
+ (0x2f846, (2934, 1)),
+ (0x1e7d, (1132, 2)),
+ (0xfac8, (2715, 1)),
+ (0x104, (114, 2)),
+ (0x4f5, (680, 2)),
+ (0x2fa10, (3392, 1)),
+ (0xf975, (2390, 1)),
+ (0xf96a, (2379, 1)),
+ (0xfa2b, (2560, 1)),
+ (0x1f73, (1711, 2)),
+ (0x2f957, (3207, 1)),
+ (0x1edd, (1357, 3)),
+ (0x3ad, (559, 2)),
+ (0x2f924, (3156, 1)),
+ (0xfad4, (2727, 1)),
+ (0x2f97b, (3243, 1)),
+ (0x2f853, (2947, 1)),
+ (0xfa3f, (2580, 1)),
+ (0xfa8a, (2653, 1)),
+ (0xfb4c, (2797, 2)),
+ (0x1f3b, (1581, 3)),
+ (0xc4, (8, 2)),
+ (0x1109a, (2803, 2)),
+ (0x341, (527, 1)),
+ (0x1e0d, (878, 2)),
+ (0x4dc, (638, 2)),
+ (0xfa10, (2543, 1)),
+ (0x1ef1, (1413, 3)),
+ (0x2f903, (3123, 1)),
+ (0x1fed, (2030, 2)),
+ (0x1fef, (2034, 1)),
+ (0x1ea4, (1200, 3)),
+ (0x21f, (490, 2)),
+ (0xfa92, (2661, 1)),
+ (0x2f8a4, (3028, 1)),
+ (0xf9c8, (2473, 1)),
+ (0xf9a0, (2433, 1)),
+ (0x1e31, (958, 2)),
+ (0xf903, (2276, 1)),
+ (0x3d4, (580, 2)),
+ (0x2f809, (2873, 1)),
+ (0x1e07, (864, 2)),
+ (0x1fb1, (1915, 2)),
+ (0x2f8d1, (3073, 1)),
+ (0x1e11, (886, 2)),
+ (0x1fd2, (1976, 3)),
+ (0x1d15e, (2829, 2)),
+ (0x2f941, (3185, 1)),
+ (0xf962, (2371, 1)),
+ (0x1ef0, (1410, 3)),
+ (0x1ee0, (1366, 3)),
+ (0x3052, (2163, 2)),
+ (0x148, (226, 2)),
+ (0x1f44, (1606, 3)),
+ (0x2f930, (3168, 1)),
+ (0x1e0b, (874, 2)),
+ (0x2f83e, (2926, 1)),
+ (0x3094, (2207, 2)),
+ (0x1e5b, (1052, 2)),
+ (0xfa54, (2601, 1)),
+ (0xf9fc, (2525, 1)),
+ (0x1de, (370, 3)),
+ (0x1e02, (854, 2)),
+ (0x2f9e4, (3348, 1)),
+ (0xf97f, (2400, 1)),
+ (0x1fe1, (2003, 2)),
+ (0x1ecb, (1308, 2)),
+ (0x2f947, (3191, 1)),
+ (0x2f82d, (2909, 1)),
+ (0x1f6d, (1696, 3)),
+ (0x1e4c, (1014, 3)),
+ (0x1e00, (850, 2)),
+ (0x2f93c, (3180, 1)),
+ (0x2f9c4, (3316, 1)),
+ (0x1f2d, (1543, 3)),
+ (0x38c, (544, 2)),
+ (0x115bb, (2825, 2)),
+ (0xfa0c, (2541, 1)),
+ (0x2f986, (3254, 1)),
+ (0x1f0a, (1458, 3)),
+ (0x1f83, (1743, 4)),
+ (0x1ee3, (1375, 3)),
+ (0x2f93e, (3182, 1)),
+ (0x2f8ed, (3101, 1)),
+ (0x2f981, (3249, 1)),
+ (0x1f54, (1638, 3)),
+ (0x1e16, (898, 3)),
+ (0xfa6a, (2623, 1)),
+ (0x179, (310, 2)),
+ (0xfb2d, (2744, 3)),
+ (0xf90b, (2284, 1)),
+ (0xfb3e, (2775, 2)),
+ (0x2f9b0, (3296, 1)),
+ (0xf932, (2323, 1)),
+ (0x1ee6, (1382, 2)),
+ (0x2f85e, (2958, 1)),
+ (0x2f8d7, (3079, 1)),
+ (0x1e40, (990, 2)),
+ (0x22ed, (2151, 2)),
+ (0x1f43, (1603, 3)),
+ (0x4e5, (652, 2)),
+ (0xfaa5, (2680, 1)),
+ (0x1fa3, (1863, 4)),
+ (0x2f967, (3223, 1)),
+ (0xf993, (2420, 1)),
+ (0x2f88d, (3005, 1)),
+ (0xed, (76, 2)),
+ (0x2f906, (3126, 1)),
+ (0xfa98, (2667, 1)),
+ (0x2f901, (3121, 1)),
+ (0x1ff7, (2045, 3)),
+ (0x95c, (716, 2)),
+ (0xfa60, (2613, 1)),
+ (0x3ca, (568, 2)),
+ (0xfa62, (2615, 1)),
+ (0x2f8c3, (3059, 1)),
+ (0x1eca, (1306, 2)),
+ (0xf950, (2353, 1)),
+ (0x173, (298, 2)),
+ (0x2f99a, (3274, 1)),
+ (0x2f970, (3232, 1)),
+ (0x2f85a, (2954, 1)),
+ (0x2fa13, (3395, 1)),
+ (0xf98b, (2412, 1)),
+ (0x2f913, (3139, 1)),
+ (0xfb9, (824, 2)),
+ (0xf919, (2298, 1)),
+ (0x1eba, (1264, 2)),
+ (0x2f890, (3008, 1)),
+ (0xf953, (2356, 1)),
+ (0x1eb2, (1242, 3)),
+ (0xf904, (2277, 1)),
+ (0x1dc, (367, 3)),
+ (0x3ab, (555, 2)),
+ (0xf94e, (2351, 1)),
+ (0x2f8df, (3087, 1)),
+ (0x1f19, (1494, 2)),
+ (0x30bc, (2227, 2)),
+ (0x305e, (2175, 2)),
+ (0x1e87, (1152, 2)),
+ (0xf9fa, (2523, 1)),
+ (0x2f82b, (2907, 1)),
+ (0x2f81d, (2893, 1)),
+ (0x2f8a3, (3027, 1)),
+ (0x2fa04, (3380, 1)),
+ (0xfa3a, (2575, 1)),
+ (0x4e4, (650, 2)),
+ (0x2f9d5, (3333, 1)),
+ (0x2f90d, (3133, 1)),
+ (0xf967, (2376, 1)),
+ (0xfad3, (2726, 1)),
+ (0x1ff2, (2035, 3)),
+ (0x1e86, (1150, 2)),
+ (0xf92d, (2318, 1)),
+ (0x1ef7, (1426, 2)),
+ (0xfa89, (2652, 1)),
+ (0x2f874, (2980, 1)),
+ (0x2f852, (2946, 1)),
+ (0xf9cd, (2478, 1)),
+ (0x2f854, (2948, 1)),
+ (0x1e25, (932, 2)),
+ (0x1ec1, (1281, 3)),
+ (0x1edb, (1351, 3)),
+ (0x205, (442, 2)),
+ (0x2f843, (2931, 1)),
+ (0x2f8b1, (3041, 1)),
+ (0x1fb8, (1930, 2)),
+ (0xbcb, (760, 2)),
+ (0x2f84c, (2940, 1)),
+ (0xfa30, (2565, 1)),
+ (0x9cb, (724, 2)),
+ (0x2f858, (2952, 1)),
+ (0x1f5b, (1652, 3)),
+ (0x6c2, (698, 2)),
+ (0x2f950, (3200, 1)),
+ (0xb5c, (752, 2)),
+ (0xfa4d, (2594, 1)),
+ (0x1f93, (1803, 4)),
+ (0xfa74, (2631, 1)),
+ (0x1f59, (1650, 2)),
+ (0x2fa1d, (3405, 1)),
+ (0xfa70, (2627, 1)),
+ (0xfa18, (2548, 1)),
+ (0x2f888, (3000, 1)),
+ (0x2f8b7, (3047, 1)),
+ (0xf99d, (2430, 1)),
+ (0xf9db, (2492, 1)),
+ (0xf940, (2337, 1)),
+ (0x1f8d, (1781, 4)),
+ (0x1f97, (1819, 4)),
+ (0x1e10, (884, 2)),
+ (0xf997, (2424, 1)),
+ (0x2f956, (3206, 1)),
+ (0x2f9aa, (3290, 1)),
+ (0x1e41, (992, 2)),
+ (0x2f90c, (3132, 1)),
+ (0x2f862, (2962, 1)),
+ (0x1e66, (1078, 3)),
+ (0x1ef8, (1428, 2)),
+ (0x2f849, (2937, 1)),
+ (0x2f894, (3012, 1)),
+ (0x1e7f, (1136, 2)),
+ (0x1f29, (1532, 2)),
+ (0xfa1c, (2552, 1)),
+ (0x1eb0, (1236, 3)),
+ (0x1f74, (1713, 2)),
+ (0x1ee9, (1389, 3)),
+ (0x1fbb, (1936, 2)),
+ (0x162, (268, 2)),
+ (0xd2, (32, 2)),
+ (0xfa97, (2666, 1)),
+ (0x2f824, (2900, 1)),
+ (0x233, (524, 2)),
+ (0x22af, (2135, 2)),
+ (0x1fec, (2028, 2)),
+ (0xfa7f, (2642, 1)),
+ (0x2f94a, (3194, 1)),
+ (0x2f887, (2999, 1)),
+ (0x2fa17, (3399, 1)),
+ (0x931, (704, 2)),
+ (0x130, (194, 2)),
+ (0x135, (198, 2)),
+ (0x3076, (2195, 2)),
+ (0xfa2, (818, 2)),
+ (0x4f8, (682, 2)),
+ (0x1f27, (1527, 3)),
+ (0xf963, (2372, 1)),
+ (0xf94d, (2350, 1)),
+ (0x340, (526, 1)),
+ (0x2f9cd, (3325, 1)),
+ (0x1e01, (852, 2)),
+ (0x1ed3, (1327, 3)),
+ (0x103, (112, 2)),
+ (0x200, (432, 2)),
+ (0x17c, (316, 2)),
+ (0xf92c, (2317, 1)),
+ (0x1e12, (888, 2)),
+ (0xfb33, (2757, 2)),
+ (0xfa93, (2662, 1)),
+ (0xf5, (90, 2)),
+ (0x30f8, (2265, 2)),
+ (0x210, (464, 2)),
+ (0xf3, (86, 2)),
+ (0x2f804, (2868, 1)),
+ (0x2f8c0, (3056, 1)),
+ (0x21a, (484, 2)),
+ (0x1e1c, (912, 3)),
+ (0x11e, (162, 2)),
+ (0x1f8f, (1789, 4)),
+ (0xfa4c, (2593, 1)),
+ (0x95b, (714, 2)),
+ (0xfa45, (2586, 1)),
+ (0xfad5, (2728, 1)),
+ (0x2f82e, (2910, 1)),
+ (0xfa5c, (2609, 1)),
+ (0xf9b7, (2456, 1)),
+ (0x206, (444, 2)),
+ (0x1fc7, (1953, 3)),
+ (0x3cb, (570, 2)),
+ (0xf9dc, (2493, 1)),
+ (0x22b, (503, 3)),
+ (0xf92e, (2319, 1)),
+ (0x1ee2, (1372, 3)),
+ (0x2f88f, (3007, 1)),
+ (0x2f94c, (3196, 1)),
+ (0xfa84, (2647, 1)),
+ (0x2f9e3, (3347, 1)),
+ (0xf9d6, (2487, 1)),
+ (0x15d, (258, 2)),
+ (0x1e24, (930, 2)),
+ (0x2f95c, (3212, 1)),
+ (0x1ea6, (1206, 3)),
+ (0x1ea8, (1212, 3)),
+ (0x30f7, (2263, 2)),
+ (0xf977, (2392, 1)),
+ (0xfac4, (2711, 1)),
+ (0xfa3b, (2576, 1)),
+ (0x2f904, (3124, 1)),
+ (0xf9ab, (2444, 1)),
+ (0x4eb, (660, 2)),
+ (0xfa20, (2555, 1)),
+ (0x2f907, (3127, 1)),
+ (0x1ec6, (1296, 3)),
+ (0x2fa05, (3381, 1)),
+ (0x110ab, (2807, 2)),
+ (0x1e3f, (988, 2)),
+ (0x2285, (2123, 2)),
+ (0x343, (528, 1)),
+ (0xf9da, (2491, 1)),
+ (0x2fa07, (3383, 1)),
+ (0x2fa15, (3397, 1)),
+ (0x4f3, (676, 2)),
+ (0x113, (140, 2)),
+ (0x1f7b, (1727, 2)),
+ (0x21cf, (2075, 2)),
+ (0x1f7a, (1725, 2)),
+ (0xe5, (62, 2)),
+ (0x307d, (2205, 2)),
+ (0x2fa14, (3396, 1)),
+ (0x2f891, (3009, 1)),
+ (0x2f9e5, (3349, 1)),
+ (0x2f983, (3251, 1)),
+ (0x1f90, (1793, 3)),
+ (0x1e85, (1148, 2)),
+ (0xd4, (36, 2)),
+ (0x22e0, (2137, 2)),
+ (0x3ae, (561, 2)),
+ (0x2f8ae, (3038, 1)),
+ (0xf9fb, (2524, 1)),
+ (0xf99c, (2429, 1)),
+ (0x217, (478, 2)),
+ (0x1eb7, (1257, 3)),
+ (0x2f8aa, (3034, 1)),
+ (0x385, (533, 2)),
+ (0xfa16, (2546, 1)),
+ (0x2f9e2, (3346, 1)),
+ (0x1e1, (379, 3)),
+ (0x2fa00, (3376, 1)),
+ (0x154, (240, 2)),
+ (0x1fb7, (1927, 3)),
+ (0x1eef, (1407, 3)),
+ (0xfa02, (2531, 1)),
+ (0x2f990, (3264, 1)),
+ (0x1e52, (1032, 3)),
+ (0x624, (690, 2)),
+ (0x2f99d, (3277, 1)),
+ (0x2f883, (2995, 1)),
+ (0x1fd7, (1984, 3)),
+ (0xf9cc, (2477, 1)),
+ (0xf926, (2311, 1)),
+ (0x1e56, (1042, 2)),
+ (0xfa06, (2535, 1)),
+ (0xfa51, (2598, 1)),
+ (0x1ef4, (1420, 2)),
+ (0x2f9da, (3338, 1)),
+ (0x1e36, (968, 2)),
+ (0x6d3, (700, 2)),
+ (0x2f9ff, (3375, 1)),
+ (0x2f8e2, (3090, 1)),
+ (0x1eaa, (1218, 3)),
+ (0x2f8ad, (3037, 1)),
+ (0xfa07, (2536, 1)),
+ (0x2f97a, (3242, 1)),
+ (0x2f966, (3222, 1)),
+ (0x1e80, (1138, 2)),
+ (0x1d2, (340, 2)),
+ (0x1f63, (1668, 3)),
+ (0x1fad, (1901, 4)),
+ (0xf91e, (2303, 1)),
+ (0xfaa0, (2675, 1)),
+ (0x2f863, (2963, 1)),
+ (0x30dd, (2259, 2)),
+ (0x45e, (612, 2)),
+ (0x2f91a, (3146, 1)),
+ (0x1e05, (860, 2)),
+ (0x11a, (154, 2)),
+ (0x1f61, (1663, 2)),
+ (0x2fa1b, (3403, 1)),
+ (0x2f9e0, (3344, 1)),
+ (0x13d, (212, 2)),
+ (0xfb32, (2755, 2)),
+ (0x1ea5, (1203, 3)),
+ (0xddd, (787, 3)),
+ (0x118, (150, 2)),
+ (0x207, (446, 2)),
+ (0x1ffa, (2052, 2)),
+ (0x2f93f, (3183, 1)),
+ (0x2f886, (2998, 1)),
+ (0xf9e0, (2497, 1)),
+ (0xf970, (2385, 1)),
+ (0x2f97e, (3246, 1)),
+ (0xf972, (2387, 1)),
+ (0x136, (200, 2)),
+ (0x1b0a, (832, 2)),
+ (0x3073, (2191, 2)),
+ (0xf916, (2295, 1)),
+ (0x22e2, (2141, 2)),
+ (0x2f921, (3153, 1)),
+ (0x2260, (2095, 2)),
+ (0x1f66, (1677, 3)),
+ (0x2f80f, (2879, 1)),
+ (0x2001, (2060, 1)),
+ (0x1f88, (1763, 3)),
+ (0xfaa6, (2681, 1)),
+ (0x1fae, (1905, 4)),
+ (0xfaa4, (2679, 1)),
+ (0x1f3a, (1578, 3)),
+ (0xfac1, (2708, 1)),
+ (0xfa8f, (2658, 1)),
+ (0x95d, (718, 2)),
+ (0xf9d1, (2482, 1)),
+ (0x1b41, (846, 2)),
+ (0xf948, (2345, 1)),
+ (0x1e3c, (982, 2)),
+ (0xfad9, (2732, 1)),
+ (0x400, (582, 2)),
+ (0xf96d, (2382, 1)),
+ (0x1e7c, (1130, 2)),
+ (0x3d3, (578, 2)),
+ (0x172, (296, 2)),
+ (0x1e1f, (920, 2)),
+ (0xfa9f, (2674, 1)),
+ (0x226e, (2101, 2)),
+ (0x2f822, (2898, 1)),
+ (0xf75, (806, 2)),
+ (0x2f871, (2977, 1)),
+ (0x2f812, (2882, 1)),
+ (0x2275, (2111, 2)),
+ (0x1f3f, (1593, 3)),
+ (0x30d7, (2251, 2)),
+ (0xd9, (42, 2)),
+ (0x2f8ab, (3035, 1)),
+ (0xfa7a, (2637, 1)),
+ (0xf915, (2294, 1)),
+ (0x1e1d, (915, 3)),
+ (0x1eb, (396, 2)),
+ (0x2f808, (2872, 1)),
+ (0x2f98e, (3262, 1)),
+ (0xfa53, (2600, 1)),
+ (0xf9a6, (2439, 1)),
+ (0x2f80c, (2876, 1)),
+ (0x2f8f5, (3109, 1)),
+ (0x2fa02, (3378, 1)),
+ (0x1e81, (1140, 2)),
+ (0xf930, (2321, 1)),
+ (0x3060, (2177, 2)),
+ (0x1fea, (2024, 2)),
+ (0x38a, (542, 2)),
+ (0x2f85c, (2956, 1)),
+ (0x1fc9, (1958, 2)),
+ (0x2f86f, (2975, 1)),
+ (0x2f90a, (3130, 1)),
+ (0x2f902, (3122, 1)),
+ (0x2f835, (2917, 1)),
+ (0x14d, (230, 2)),
+ (0x1d162, (2839, 3)),
+ (0xf923, (2308, 1)),
+ (0x2f896, (3014, 1)),
+ (0x22d, (509, 3)),
+ (0xf9f2, (2515, 1)),
+ (0x30c2, (2233, 2)),
+ (0x30d4, (2247, 2)),
+ (0xf97e, (2399, 1)),
+ (0x1fe2, (2005, 3)),
+ (0xec, (74, 2)),
+ (0x1f49, (1614, 2)),
+ (0xfa8d, (2656, 1)),
+ (0x2f898, (3016, 1)),
+ (0x1eb5, (1251, 3)),
+ (0x2f994, (3268, 1)),
+ (0x12b, (184, 2)),
+ (0x20e, (460, 2)),
+ (0x168, (276, 2)),
+ (0x1f56, (1644, 3)),
+ (0x2f8a0, (3024, 1)),
+ (0xfa52, (2599, 1)),
+ (0x2f93d, (3181, 1)),
+ (0xda, (44, 2)),
+ (0x1ec4, (1290, 3)),
+ (0x1e95, (1180, 2)),
+ (0x1f67, (1680, 3)),
+ (0x2f9c1, (3313, 1)),
+ (0xf9de, (2495, 1)),
+ (0x2f83d, (2925, 1)),
+ (0xf9ed, (2510, 1)),
+ (0xfabf, (2706, 1)),
+ (0x457, (606, 2)),
+ (0xfa0d, (2542, 1)),
+ (0xfab1, (2692, 1)),
+ (0x2f8fa, (3114, 1)),
+ (0x1e49, (1008, 2)),
+ (0xf91b, (2300, 1)),
+ (0x1e50, (1026, 3)),
+ (0xf94a, (2347, 1)),
+ (0xfa90, (2659, 1)),
+ (0x2284, (2121, 2)),
+ (0x1ea0, (1192, 2)),
+ (0x169, (278, 2)),
+ (0xf900, (2273, 1)),
+ (0x1eeb, (1395, 3)),
+ (0xf9e5, (2502, 1)),
+ (0x2f9ea, (3354, 1)),
+ (0x2f8ac, (3036, 1)),
+ (0x2f8f8, (3112, 1)),
+ (0xcc8, (770, 2)),
+ (0x2f8f6, (3110, 1)),
+ (0xf968, (2377, 1)),
+ (0x1e6c, (1094, 2)),
+ (0x2f8d8, (3080, 1)),
+ (0x1eb6, (1254, 3)),
+ (0x2f899, (3017, 1)),
+ (0xc3, (6, 2)),
+ (0x1b0, (328, 2)),
+ (0x1f13, (1483, 3)),
+ (0x1e63, (1070, 2)),
+ (0x112, (138, 2)),
+ (0x2f920, (3152, 1)),
+ (0xfa04, (2533, 1)),
+ (0x2f8d9, (3081, 1)),
+ (0x1e38, (972, 3)),
+ (0x1f94, (1807, 4)),
+ (0x2f940, (3184, 1)),
+ (0x2f97d, (3245, 1)),
+ (0x2f84e, (2942, 1)),
+ (0xf9a5, (2438, 1)),
+ (0x9dc, (728, 2)),
+ (0xfc, (100, 2)),
+ (0x1eec, (1398, 3)),
+ (0x1a0, (322, 2)),
+ (0x2f9b4, (3300, 1)),
+ (0xbca, (758, 2)),
+ (0x2f834, (2916, 1)),
+ (0x2fa0b, (3387, 1)),
+ (0xfad8, (2731, 1)),
+ (0x30c5, (2235, 2)),
+ (0xf9f5, (2518, 1)),
+ (0x2f84b, (2939, 1)),
+ (0x1e5e, (1060, 2)),
+ (0x2f8c6, (3062, 1)),
+ (0x2f93b, (3179, 1)),
+ (0x151, (238, 2)),
+ (0x1ffc, (2056, 2)),
+ (0xfa39, (2574, 1)),
+ (0x1e09, (869, 3)),
+ (0xf999, (2426, 1)),
+ (0x2f8e6, (3094, 1)),
+ (0x2f8ba, (3050, 1)),
+ (0x2f876, (2982, 1)),
+ (0x123, (172, 2)),
+ (0xfb3c, (2773, 2)),
+ (0xf996, (2423, 1)),
+ (0x1e8d, (1164, 2)),
+ (0x10c, (130, 2)),
+ (0x2f8ee, (3102, 1)),
+ (0xf909, (2282, 1)),
+ (0xfa4a, (2591, 1)),
+ (0x2f9a9, (3289, 1)),
+ (0x2f806, (2870, 1)),
+ (0x30d0, (2241, 2)),
+ (0x2f9bb, (3307, 1)),
+ (0x2f975, (3237, 1)),
+ (0x2fa18, (3400, 1)),
+ (0x2f989, (3257, 1)),
+ (0xf987, (2408, 1)),
+ (0x2f80a, (2874, 1)),
+ (0xf998, (2425, 1)),
+ (0xf979, (2394, 1)),
+ (0xf90d, (2286, 1)),
+ (0xf922, (2307, 1)),
+ (0x1f8c, (1777, 4)),
+ (0x1f37, (1571, 3)),
+ (0xfb48, (2789, 2)),
+ (0x3067, (2183, 2)),
+ (0x2f932, (3170, 1)),
+ (0x1ed2, (1324, 3)),
+ (0xd1, (30, 2)),
+ (0x1e28, (938, 2)),
+ (0x178, (308, 2)),
+ (0x2f9ac, (3292, 1)),
+ (0x161, (266, 2)),
+ (0xfad0, (2723, 1)),
+ (0x401, (584, 2)),
+ (0x2241, (2087, 2)),
+ (0xf9bd, (2462, 1)),
+ (0x2f8f0, (3104, 1)),
+ (0x1e45, (1000, 2)),
+ (0xf9d9, (2490, 1)),
+ (0xfaa9, (2684, 1)),
+ (0xfa35, (2570, 1)),
+ (0x4d2, (626, 2)),
+ (0x1e34, (964, 2)),
+ (0xf927, (2312, 1)),
+ (0x1ec3, (1287, 3)),
+ (0x2f8de, (3086, 1)),
+ (0x2f9a2, (3282, 1)),
+ (0xf943, (2340, 1)),
+ (0x1e8f, (1168, 2)),
+ (0xf9d5, (2486, 1)),
+ (0xf982, (2403, 1)),
+ (0x1f50, (1628, 2)),
+ (0x1f92, (1799, 4)),
+ (0xf81, (812, 2)),
+ (0xfa87, (2650, 1)),
+ (0x2f94e, (3198, 1)),
+ (0x1fab, (1893, 4)),
+ (0xfa3d, (2578, 1)),
+ (0x1d9, (358, 3)),
+ (0x2f996, (3270, 1)),
+ (0x1e8a, (1158, 2)),
+ (0xfa58, (2605, 1)),
+ (0x1fc1, (1941, 2)),
+ (0x2f961, (3217, 1)),
+ (0x344, (529, 2)),
+ (0x1f34, (1562, 3)),
+ (0xf9a8, (2441, 1)),
+ (0x163, (270, 2)),
+ (0xfb4b, (2795, 2)),
+ (0x9cc, (726, 2)),
+ (0x1e71, (1104, 2)),
+ (0xe2, (56, 2)),
+ (0xf9f3, (2516, 1)),
+ (0x2f89e, (3022, 1)),
+ (0x2f8b3, (3043, 1)),
+ (0x1f4d, (1625, 3)),
+ (0x1ef9, (1430, 2)),
+ (0x2f82f, (2911, 1)),
+ (0xfa2e, (2563, 1)),
+ (0x2f814, (2884, 1)),
+ (0xfad1, (2724, 1)),
+ (0x1ec5, (1293, 3)),
+ (0x9df, (732, 2)),
+ (0x2f8a1, (3025, 1)),
+ (0xf939, (2330, 1)),
+ (0x228, (496, 2)),
+ (0x2f8d2, (3074, 1)),
+ (0x1d1bd, (2852, 3)),
+ (0x1f86, (1755, 4)),
+ (0x2f868, (2968, 1)),
+ (0x22a, (500, 3)),
+ (0x2f8e3, (3091, 1)),
+ (0xa5a, (740, 2)),
+ (0x1fc8, (1956, 2)),
+ (0xfa22, (2556, 1)),
+ (0x1ed, (401, 3)),
+ (0xf99f, (2432, 1)),
+ (0x2f9b8, (3304, 1)),
+ (0x2f9e7, (3351, 1)),
+ (0xfabb, (2702, 1)),
+ (0x1d6, (349, 3)),
+ (0xfb31, (2753, 2)),
+ (0x146, (222, 2)),
+ (0x1ef2, (1416, 2)),
+ (0x1fa1, (1856, 3)),
+ (0x1e18, (904, 2)),
+ (0xfa9b, (2670, 1)),
+ (0xfa80, (2643, 1)),
+ (0xfacc, (2719, 1)),
+ (0x17a, (312, 2)),
+ (0x1e3b, (980, 2)),
+ (0x1e74, (1110, 2)),
+ (0x2f86b, (2971, 1)),
+ (0x1e23, (928, 2)),
+ (0x175, (302, 2)),
+ (0x1e3e, (986, 2)),
+ (0x4db, (636, 2)),
+ (0x219b, (2067, 2)),
+ (0x1e84, (1146, 2)),
+ (0xf9cf, (2480, 1)),
+ (0x1e44, (998, 2)),
+ (0x1e1a, (908, 2)),
+ (0x1f65, (1674, 3)),
+ (0xf929, (2314, 1)),
+ (0x2247, (2091, 2)),
+ (0x4f2, (674, 2)),
+ (0x2f87c, (2988, 1)),
+ (0x1e2f, (953, 3)),
+ (0x2f84a, (2938, 1)),
+ (0x2f98c, (3260, 1)),
+ (0x2f9a1, (3281, 1)),
+ (0x1ec8, (1302, 2)),
+ (0x157, (246, 2)),
+ (0x2f8bf, (3055, 1)),
+ (0xfb41, (2779, 2)),
+ (0x4f9, (684, 2)),
+ (0x2f995, (3269, 1)),
+ (0x12e, (190, 2)),
+ (0xf9b6, (2455, 1)),
+ (0x1ebc, (1268, 2)),
+ (0x1e21, (924, 2)),
+ (0x2f841, (2929, 1)),
+ (0x116, (146, 2)),
+ (0x453, (604, 2)),
+ (0x2f992, (3266, 1)),
+ (0x1d164, (2845, 3)),
+ (0x2f8e1, (3089, 1)),
+ (0xfa75, (2632, 1)),
+ (0xf902, (2275, 1)),
+ (0xf908, (2281, 1)),
+ (0x2f817, (2887, 1)),
+ (0xf95f, (2368, 1)),
+ (0x2f83b, (2923, 1)),
+ (0x10f, (136, 2)),
+ (0xd3, (34, 2)),
+ (0x3069, (2185, 2)),
+ (0x1e65, (1075, 3)),
+ (0xfb43, (2781, 2)),
+ (0x30ba, (2225, 2)),
+ (0x1f9b, (1833, 4)),
+ (0x16c, (284, 2)),
+ (0xc7, (12, 2)),
+ (0x2f96b, (3227, 1)),
+ (0xf9f8, (2521, 1)),
+ (0x158, (248, 2)),
+ (0x1d163, (2842, 3)),
+ (0x1ea7, (1209, 3)),
+ (0x2288, (2125, 2)),
+ (0xfacb, (2718, 1)),
+ (0xf901, (2274, 1)),
+ (0x1f8e, (1785, 4)),
+ (0x2fa09, (3385, 1)),
+ (0x2f9c8, (3320, 1)),
+ (0x1e0e, (880, 2)),
+ (0xf949, (2346, 1)),
+ (0xe8, (66, 2)),
+ (0xfa3c, (2577, 1)),
+ (0x2f8ec, (3100, 1)),
+ (0x2f8db, (3083, 1)),
+ (0x218, (480, 2)),
+ (0x3065, (2181, 2)),
+ (0xfa7c, (2639, 1)),
+ (0x1f82, (1739, 4)),
+ (0x1e9b, (1190, 2)),
+ (0x209, (450, 2)),
+ (0x1fd1, (1974, 2)),
+ (0x2f9fa, (3370, 1)),
+ (0x30f4, (2261, 2)),
+ (0x1f1a, (1496, 3)),
+ (0x1e5c, (1054, 3)),
+ (0xfa6b, (2624, 1)),
+ (0x2f9de, (3342, 1)),
+ (0xf9c6, (2471, 1)),
+ (0x1da, (361, 3)),
+ (0x1f0e, (1470, 3)),
+ (0xf97b, (2396, 1)),
+ (0xf9c3, (2468, 1)),
+ (0x117, (148, 2)),
+ (0xf945, (2342, 1)),
+ (0x2f9fe, (3374, 1)),
+ (0x1ed6, (1336, 3)),
+ (0x625, (692, 2)),
+ (0x2f9bc, (3308, 1)),
+ (0x2249, (2093, 2)),
+ (0x1d4, (344, 2)),
+ (0x2f9f0, (3360, 1)),
+ (0x2f931, (3169, 1)),
+ (0x2f92a, (3162, 1)),
+ (0x1fdb, (1993, 2)),
+ (0xfa7b, (2638, 1)),
+ (0x2f882, (2994, 1)),
+ (0x2f8ef, (3103, 1)),
+ (0xf94f, (2352, 1)),
+ (0xf93, (814, 2)),
+ (0x2f945, (3189, 1)),
+ (0x3056, (2167, 2)),
+ (0x959, (710, 2)),
+ (0x22ac, (2129, 2)),
+ (0x1ff6, (2043, 2)),
+ (0x2f801, (2865, 1)),
+ (0xf921, (2306, 1)),
+ (0xfa41, (2582, 1)),
+ (0xf9fe, (2527, 1)),
+ (0xfaa3, (2678, 1)),
+ (0x2f8b4, (3044, 1)),
+ (0x20c, (456, 2)),
+ (0xf9c1, (2466, 1)),
+ (0x2000, (2059, 1)),
+ (0x2f905, (3125, 1)),
+ (0x40d, (592, 2)),
+ (0x1f79, (1723, 2)),
+ (0x2f95b, (3211, 1)),
+ (0x1e72, (1106, 2)),
+ (0x2f91b, (3147, 1)),
+ (0xf9e1, (2498, 1)),
+ (0x2f9cb, (3323, 1)),
+ (0x2f84d, (2941, 1)),
+ (0x2f8a7, (3031, 1)),
+ (0x1f05, (1445, 3)),
+ (0xfb30, (2751, 2)),
+ (0xfa01, (2530, 1)),
+ (0xef, (80, 2)),
+ (0x1d1c0, (2861, 3)),
+ (0x2f819, (2889, 1)),
+ (0xca, (18, 2)),
+ (0x21ae, (2069, 2)),
+ (0x1e2e, (950, 3)),
+ (0x30da, (2255, 2)),
+ (0x2f880, (2992, 1)),
+ (0x2f832, (2914, 1)),
+ (0x1db, (364, 3)),
+ (0x4e7, (656, 2)),
+ (0x2f85b, (2955, 1)),
+ (0x1f0, (408, 2)),
+ (0x2f9c7, (3319, 1)),
+ (0x1e68, (1084, 3)),
+ (0xf90c, (2285, 1)),
+ (0xfb4d, (2799, 2)),
+ (0x2f8f4, (3108, 1)),
+ (0x3b0, (565, 3)),
+ (0xf90f, (2288, 1)),
+ (0x2f89f, (3023, 1)),
+ (0x1f9a, (1829, 4)),
+ (0xfa88, (2651, 1)),
+ (0x1d1bf, (2858, 3)),
+ (0x3071, (2189, 2)),
+ (0xfa69, (2622, 1)),
+ (0x1026, (826, 2)),
+ (0xfa1a, (2550, 1)),
+ (0x1e03, (856, 2)),
+ (0xf928, (2313, 1)),
+ (0x2f974, (3236, 1)),
+ (0xb4b, (748, 2)),
+ (0x1f1d, (1505, 3)),
+ (0x165, (274, 2)),
+ (0xfad2, (2725, 1)),
+ (0xfac9, (2716, 1)),
+ (0x2f897, (3015, 1)),
+ (0x2fa0f, (3391, 1)),
+ (0x2f9ae, (3294, 1)),
+ (0xc8, (14, 2)),
+ (0x2f8bc, (3052, 1)),
+ (0x2f96a, (3226, 1)),
+ (0x2f9fb, (3371, 1)),
+ (0x2f8cd, (3069, 1)),
+ (0xfb1f, (2735, 2)),
+ (0x2f94b, (3195, 1)),
+ (0x2f811, (2881, 1)),
+ (0x95a, (712, 2)),
+ (0x30dc, (2257, 2)),
+ (0xf78, (810, 2)),
+ (0x2f909, (3129, 1)),
+ (0x22ae, (2133, 2)),
+ (0xf9d8, (2489, 1)),
+ (0xfa8e, (2657, 1)),
+ (0x1e2a, (942, 2)),
+ (0x108, (122, 2)),
+ (0x2f9cf, (3327, 1)),
+ (0x1e7b, (1127, 3)),
+ (0x2f8cb, (3067, 1)),
+ (0xfac2, (2709, 1)),
+ (0x1d15f, (2831, 2)),
+ (0xf924, (2309, 1)),
+ (0xf96f, (2384, 1)),
+ (0x1ede, (1360, 3)),
+ (0x2f987, (3255, 1)),
+ (0x1f72, (1709, 2)),
+ (0x1ed4, (1330, 3)),
+ (0x2f8b2, (3042, 1)),
+ (0xfa42, (2583, 1)),
+ (0x626, (694, 2)),
+ (0xfa9d, (2672, 1)),
+ (0x2f9b3, (3299, 1)),
+ (0x2f919, (3145, 1)),
+ (0xf9d3, (2484, 1)),
+ (0xfa71, (2628, 1)),
+ (0x1f2f, (1549, 3)),
+ (0x1ed9, (1345, 3)),
+ (0xfb2f, (2749, 2)),
+ (0x2f8dc, (3084, 1)),
+ (0x1eb4, (1248, 3)),
+ (0xfa25, (2557, 1)),
+ (0x2f86d, (2973, 1)),
+ (0x4ea, (658, 2)),
+ (0x1ecd, (1312, 2)),
+ (0x1f01, (1434, 2)),
+ (0x2f8d0, (3072, 1)),
+ (0x2f93a, (3178, 1)),
+ (0x40c, (590, 2)),
+ (0xf93a, (2331, 1)),
+ (0xf9ff, (2528, 1)),
+ (0x1e26, (934, 2)),
+ (0x1f08, (1454, 2)),
+ (0x1f03, (1439, 3)),
+ (0xfad7, (2730, 1)),
+ (0x2f884, (2996, 1)),
+ (0x2f845, (2933, 1)),
+ (0x38e, (546, 2)),
+ (0x4d0, (622, 2)),
+ (0x30be, (2229, 2)),
+ (0x1f32, (1556, 3)),
+ (0x2fa08, (3384, 1)),
+ (0x17d, (318, 2)),
+ (0x1e3d, (984, 2)),
+ (0xfa2c, (2561, 1)),
+ (0x2f95f, (3215, 1)),
+ (0x2f99c, (3276, 1)),
+ (0x1f6f, (1702, 3)),
+ (0xf937, (2328, 1)),
+ (0xfa34, (2569, 1)),
+ (0x1f2a, (1534, 3)),
+ (0xf69, (802, 2)),
+ (0xe0, (52, 2)),
+ (0x2f978, (3240, 1)),
+ (0x2f97f, (3247, 1)),
+ (0x1ef, (406, 2)),
+ (0x1b43, (848, 2)),
+ (0x155, (242, 2)),
+ (0x1fc6, (1951, 2)),
+ (0x20a, (452, 2)),
+ (0x3077, (2197, 2)),
+ (0x1e1b, (910, 2)),
+ (0x2f885, (2997, 1)),
+ (0x20d, (458, 2)),
+ (0xf9c4, (2469, 1)),
+ (0xf9a7, (2440, 1)),
+ (0xf98e, (2415, 1)),
+ (0xf4d, (794, 2)),
+ (0x2f805, (2869, 1)),
+ (0x159, (250, 2)),
+ (0xf4, (88, 2)),
+ (0x1f40, (1596, 2)),
+ (0xfa00, (2529, 1)),
+ (0x2f9f6, (3366, 1)),
+ (0xfaae, (2689, 1)),
+ (0xfa15, (2545, 1)),
+ (0x212b, (2063, 2)),
+ (0x2fa06, (3382, 1)),
+ (0xd5, (38, 2)),
+ (0x1e2d, (948, 2)),
+ (0x1f0f, (1473, 3)),
+ (0x2271, (2107, 2)),
+ (0x1f71, (1707, 2)),
+ (0xfa47, (2588, 1)),
+ (0xd4b, (779, 2)),
+ (0x2f81c, (2892, 1)),
+ (0x1fb9, (1932, 2)),
+ (0xfa26, (2558, 1)),
+ (0x1ff9, (2050, 2)),
+ (0x134, (196, 2)),
+ (0xf991, (2418, 1)),
+ (0x1d160, (2833, 3)),
+ (0xf9ac, (2445, 1)),
+ (0x2f828, (2904, 1)),
+ (0x1fd9, (1989, 2)),
+ (0x2f8eb, (3099, 1)),
+ (0x2f88b, (3003, 1)),
+ (0x2f9b1, (3297, 1)),
+ (0xf9bc, (2461, 1)),
+ (0xfa2a, (2559, 1)),
+ (0x307c, (2203, 2)),
+ (0x1f5, (412, 2)),
+ (0x1f78, (1721, 2)),
+ (0xfa72, (2629, 1)),
+ (0x2280, (2117, 2)),
+ (0x2f918, (3144, 1)),
+ (0xe4, (60, 2)),
+ (0x2f802, (2866, 1)),
+ (0x2f8d6, (3078, 1)),
+ (0x388, (538, 2)),
+ (0xfac5, (2712, 1)),
+ (0x10d, (132, 2)),
+ (0xf958, (2361, 1)),
+ (0x1ebe, (1272, 3)),
+ (0xf90a, (2283, 1)),
+ (0x1f9, (416, 2)),
+ (0xb4c, (750, 2)),
+ (0x1f57, (1647, 3)),
+ (0x1e06, (862, 2)),
+ (0x1ed1, (1321, 3)),
+ (0x1ff3, (2038, 2)),
+ (0x1e2b, (944, 2)),
+ (0x1eb8, (1260, 2)),
+ (0x2f875, (2981, 1)),
+ (0xf942, (2339, 1)),
+ (0x1f6a, (1687, 3)),
+ (0x1e0, (376, 3)),
+ (0x2f94d, (3197, 1)),
+ (0xc48, (764, 2)),
+ (0x2f810, (2880, 1)),
+ (0x1f36, (1568, 3)),
+ (0x2f8f3, (3107, 1)),
+ (0xfd, (102, 2)),
+ (0xf961, (2370, 1)),
+ (0x2f873, (2979, 1)),
+ (0x37e, (532, 1)),
+ (0xf911, (2290, 1)),
+ (0xfac6, (2713, 1)),
+ (0x2f89d, (3021, 1)),
+ (0x2f960, (3216, 1)),
+ (0xfa82, (2645, 1)),
+ (0x2f96f, (3231, 1)),
+ (0x1f33, (1559, 3)),
+ (0x1f5f, (1658, 3)),
+ (0x1e67, (1081, 3)),
+ (0x30d9, (2253, 2)),
+ (0xf99a, (2427, 1)),
+ (0x22ec, (2149, 2)),
+ (0x204, (440, 2)),
+ (0xdc, (48, 2)),
+ (0x2f925, (3157, 1)),
+ (0xfa68, (2621, 1)),
+ (0x2f840, (2928, 1)),
+ (0x3cd, (574, 2)),
+ (0x1e90, (1170, 2)),
+ (0x1f75, (1715, 2)),
+ (0xddc, (785, 2)),
+ (0x2f83f, (2927, 1)),
+ (0xf976, (2391, 1)),
+ (0x2f86e, (2974, 1)),
+ (0x150, (236, 2)),
+ (0x1e99, (1188, 2)),
+ (0x1d1, (338, 2)),
+ (0x2f916, (3142, 1)),
+ (0x2f929, (3161, 1)),
+ (0x1f04, (1442, 3)),
+ (0x1fa7, (1879, 4)),
+ (0x1df, (373, 3)),
+ (0xfb44, (2783, 2)),
+ (0x11c, (158, 2)),
+ (0x13a, (206, 2)),
+ (0x1f10, (1476, 2)),
+ (0x2f8c4, (3060, 1)),
+ (0x1e97, (1184, 2)),
+ (0xf954, (2357, 1)),
+ (0x2f900, (3120, 1)),
+ (0x30fe, (2271, 2)),
+ (0x30b6, (2221, 2)),
+ (0x1f69, (1685, 2)),
+ (0xf9ad, (2446, 1)),
+ (0x1e77, (1116, 2)),
+ (0xfa37, (2572, 1)),
+ (0xf934, (2325, 1)),
+ (0xfab0, (2691, 1)),
+ (0x22ea, (2145, 2)),
+ (0x2f89c, (3020, 1)),
+ (0x227, (494, 2)),
+ (0x1f2b, (1537, 3)),
+ (0x2f979, (3241, 1)),
+ (0x2f954, (3204, 1)),
+ (0x1e1e, (918, 2)),
+ (0xf9ae, (2447, 1)),
+ (0x2f8e5, (3093, 1)),
+ (0x3af, (563, 2)),
+ (0x1f4c, (1622, 3)),
+ (0xf941, (2338, 1)),
+ (0x2f934, (3172, 1)),
+ (0xf9a3, (2436, 1)),
+ (0x929, (702, 2)),
+ (0x2f89b, (3019, 1)),
+ (0x2f8b0, (3040, 1)),
+ (0x1e83, (1144, 2)),
+ (0x2f9ec, (3356, 1)),
+ (0x1f60, (1661, 2)),
+ (0x623, (688, 2)),
+ (0x1e6e, (1098, 2)),
+ (0x1112e, (2809, 2)),
+ (0xb5d, (754, 2)),
+ (0x215, (474, 2)),
+ (0x2f9bd, (3309, 1)),
+ (0x176, (304, 2)),
+ (0x1eab, (1221, 3)),
+ (0x2f9e6, (3350, 1)),
+ (0x2f864, (2964, 1)),
+ (0x1f31, (1554, 2)),
+ (0x2f92f, (3167, 1)),
+ (0x2f820, (2896, 1)),
+ (0x1fda, (1991, 2)),
+ (0x2f82c, (2908, 1)),
+ (0x1f45, (1609, 3)),
+ (0x1f7c, (1729, 2)),
+ (0x1e53, (1035, 3)),
+ (0x2f972, (3234, 1)),
+ (0x2fa1a, (3402, 1)),
+ (0xf960, (2369, 1)),
+ (0x1d7, (352, 3)),
+ (0x1ee8, (1386, 3)),
+ (0xcca, (772, 2)),
+ (0x1f42, (1600, 3)),
+ (0x2f95d, (3213, 1)),
+ (0x1ee, (404, 2)),
+ (0x2f8d3, (3075, 1)),
+ (0x1e4d, (1017, 3)),
+ (0xd6, (40, 2)),
+ (0x1f96, (1815, 4)),
+ (0xf918, (2297, 1)),
+ (0xf9af, (2448, 1)),
+ (0x2f8fb, (3115, 1)),
+ (0x1e60, (1064, 2)),
+ (0x1b12, (838, 2)),
+ (0xf9fd, (2526, 1)),
+ (0x2f9eb, (3355, 1)),
+ (0x1e64, (1072, 3)),
+ (0xfb2b, (2739, 2)),
+ (0x1fe0, (2001, 2)),
+ (0x2f915, (3141, 1)),
+ (0x2f81b, (2891, 1)),
+ (0x1fdd, (1995, 2)),
+ (0x2f8b6, (3046, 1)),
+ (0x1e89, (1156, 2)),
+ (0xf9b9, (2458, 1)),
+ (0x1fb3, (1920, 2)),
+ (0x1e3, (384, 2)),
+ (0x4e3, (648, 2)),
+ (0xcf, (28, 2)),
+ (0xf1, (82, 2)),
+ (0x2f9bf, (3311, 1)),
+ (0x2f8c9, (3065, 1)),
+ (0x2f8a8, (3032, 1)),
+ (0x2f95a, (3210, 1)),
+ (0x2f9a8, (3288, 1)),
+ (0x1a1, (324, 2)),
+ (0xf99e, (2431, 1)),
+ (0xfb46, (2785, 2)),
+ (0xf9c7, (2472, 1)),
+ (0x476, (614, 2)),
+ (0x1cd, (330, 2)),
+ (0xf9bf, (2464, 1)),
+ (0x1ead, (1227, 3)),
+ (0x105, (116, 2)),
+ (0x2f9a4, (3284, 1)),
+ (0x15b, (254, 2)),
+ (0xf9c9, (2474, 1)),
+ (0x119, (152, 2)),
+ (0xf946, (2343, 1)),
+ (0x3054, (2165, 2)),
+ (0x2fa0c, (3388, 1)),
+ (0x1cf, (334, 2)),
+ (0xfa7d, (2640, 1)),
+ (0xf944, (2341, 1)),
+ (0xfa1d, (2553, 1)),
+ (0x2f9c2, (3314, 1)),
+ (0xf964, (2373, 1)),
+ (0x219, (482, 2)),
+ (0xf9dd, (2494, 1)),
+ (0x1f8b, (1773, 4)),
+ (0x2262, (2097, 2)),
+ (0xf9b3, (2452, 1)),
+ (0xf9a2, (2435, 1)),
+ (0x3050, (2161, 2)),
+ (0x1e8, (390, 2)),
+ (0x30d3, (2245, 2)),
+ (0x30c9, (2239, 2)),
+ (0xf95a, (2363, 1)),
+ (0xf98a, (2411, 1)),
+ (0xfa76, (2633, 1)),
+ (0x2f816, (2886, 1)),
+ (0x1b40, (844, 2)),
+ (0x212, (468, 2)),
+ (0x1e91, (1172, 2)),
+ (0xf9e4, (2501, 1)),
+ (0x1f98, (1823, 3)),
+ (0xf910, (2289, 1)),
+ (0x2f9d8, (3336, 1)),
+ (0x2f91d, (3149, 1)),
+ (0x1f9c, (1837, 4)),
+ (0xdb, (46, 2)),
+ (0x232, (522, 2)),
+ (0xf995, (2422, 1)),
+ (0xf9e2, (2499, 1)),
+ (0x1f23, (1515, 3)),
+ (0xdde, (790, 2)),
+ (0xf9ce, (2479, 1)),
+ (0x1eed, (1401, 3)),
+ (0x1f0c, (1464, 3)),
+ (0x2f91c, (3148, 1)),
+ (0x30b0, (2215, 2)),
+ (0xf990, (2417, 1)),
+ (0x1f68, (1683, 2)),
+ (0x1fbc, (1938, 2)),
+ (0x2f9b7, (3303, 1)),
+ (0xf96b, (2380, 1)),
+ (0xfa09, (2538, 1)),
+ (0x1ff, (430, 2)),
+ (0x2f910, (3136, 1)),
+ (0x2f9f4, (3364, 1)),
+ (0x2f87f, (2991, 1)),
+ (0x1e59, (1048, 2)),
+ (0x114be, (2821, 2)),
+ (0xf96c, (2381, 1)),
+ (0xfac, (822, 2)),
+ (0xf913, (2292, 1)),
+ (0x2f80d, (2877, 1)),
+ (0x2f927, (3159, 1)),
+ (0x2f837, (2919, 1)),
+ (0x30ac, (2211, 2)),
+ (0x1fee, (2032, 2)),
+ (0xf9a1, (2434, 1)),
+ (0x1e54, (1038, 2)),
+ (0x1f6e, (1699, 3)),
+ (0xfab7, (2698, 1)),
+ (0xfb3b, (2771, 2)),
+ (0x2f9f1, (3361, 1)),
+ (0xa36, (736, 2)),
+ (0x1f89, (1766, 3)),
+ (0x1ecc, (1310, 2)),
+ (0x2f958, (3208, 1)),
+ (0x16b, (282, 2)),
+ (0x2f944, (3188, 1)),
+ (0x2f8f9, (3113, 1)),
+ (0x407, (588, 2)),
+ (0x1ef6, (1424, 2)),
+ (0x2f9a3, (3283, 1)),
+ (0x2f881, (2993, 1)),
+ (0x1134c, (2815, 2)),
+ (0x2f81a, (2890, 1)),
+ (0x2f9dd, (3341, 1)),
+ (0xfa64, (2617, 1)),
+ (0x2f8af, (3039, 1)),
+ (0x2f9ed, (3357, 1)),
+ (0xf9ea, (2507, 1)),
+ (0x1109c, (2805, 2)),
+ (0x14f, (234, 2)),
+ (0xf97a, (2395, 1)),
+ (0x2f949, (3193, 1)),
+ (0xa5b, (742, 2)),
+ (0xf936, (2327, 1)),
+ (0xa5e, (744, 2)),
+ (0x2f89a, (3018, 1)),
+ (0x1f4b, (1619, 3)),
+ (0xf984, (2405, 1)),
+ (0x1e6d, (1096, 2)),
+ (0x2f90e, (3134, 1)),
+ (0x232a, (2154, 1)),
+ (0x2fa0d, (3389, 1)),
+ (0xfab2, (2693, 1)),
+ (0x450, (600, 2)),
+ (0x1f02, (1436, 3)),
+ (0xfa32, (2567, 1)),
+ (0x1f76, (1717, 2)),
+ (0x2f96d, (3229, 1)),
+ (0x2f9a7, (3287, 1)),
+ (0x1ea3, (1198, 2)),
+ (0xf9ba, (2459, 1)),
+ (0x1f15, (1489, 3)),
+ (0x1faf, (1909, 4)),
+ (0x160, (264, 2)),
+ (0x2f963, (3219, 1)),
+ (0xf925, (2310, 1)),
+ (0xf9f6, (2519, 1)),
+ (0x30c0, (2231, 2)),
+ (0x21e, (488, 2)),
+ (0xfa9c, (2671, 1)),
+ (0xfb3a, (2769, 2)),
+ (0x1fba, (1934, 2)),
+ (0x374, (531, 1)),
+ (0x2adc, (2155, 2)),
+ (0x2f91f, (3151, 1)),
+ (0xcc0, (766, 2)),
+ (0x1ef3, (1418, 2)),
+ (0x1fc3, (1946, 2)),
+ (0x2f8bd, (3053, 1)),
+ (0x11f, (164, 2)),
+ (0xfa7, (820, 2)),
+ (0xf9f4, (2517, 1)),
+ (0xbcc, (762, 2)),
+ (0x2f847, (2935, 1)),
+ (0x1f4a, (1616, 3)),
+ (0x2f98f, (3263, 1)),
+ (0xf96e, (2383, 1)),
+ (0xf9e6, (2503, 1)),
+ (0xf9e3, (2500, 1)),
+ (0x2f844, (2932, 1)),
+ (0x2f813, (2883, 1)),
+ (0xfab5, (2696, 1)),
+ (0x1faa, (1889, 4)),
+ (0xc1, (2, 2)),
+ (0x1e6b, (1092, 2)),
+ (0x1fe5, (2013, 2)),
+ (0x2f807, (2871, 1)),
+ (0x2f85f, (2959, 1)),
+ (0xf93b, (2332, 1)),
+ (0x1f8, (414, 2)),
+ (0x1e69, (1087, 3)),
+ (0x1fe7, (2017, 3)),
+ (0x1e57, (1044, 2)),
+ (0xcc, (22, 2)),
+ (0x2f99b, (3275, 1)),
+ (0x4f0, (670, 2)),
+ (0x2f8fd, (3117, 1)),
+ (0x121, (168, 2)),
+ (0xf2, (84, 2)),
+ (0xfa9a, (2669, 1)),
+ (0x2f9ef, (3359, 1)),
+ (0x2f878, (2984, 1)),
+ (0xf959, (2362, 1)),
+ (0x1134b, (2813, 2)),
+ (0x1fbe, (1940, 1)),
+ (0xfa56, (2603, 1)),
+ (0x1d1be, (2855, 3)),
+ (0x2f8bb, (3051, 1)),
+ (0x2f8e4, (3092, 1)),
+ (0x1e19, (906, 2)),
+ (0x2f92d, (3165, 1)),
+ (0x1f2c, (1540, 3)),
+ (0xe1, (54, 2)),
+ (0x2f9b6, (3302, 1)),
+ (0xf98d, (2414, 1)),
+ (0xf914, (2293, 1)),
+ (0xfa19, (2549, 1)),
+ (0xface, (2721, 1)),
+ (0x15a, (252, 2)),
+ (0x2274, (2109, 2)),
+ (0xf94c, (2349, 1)),
+ (0x1fc4, (1948, 3)),
+ (0x115ba, (2823, 2)),
+ (0x2f8b8, (3048, 1)),
+ (0x2fa01, (3377, 1)),
+ (0x2f8ea, (3098, 1)),
+ (0x1e98, (1186, 2)),
+ (0x2f98b, (3259, 1)),
+ (0x2f9dc, (3340, 1)),
+ (0x1f99, (1826, 3)),
+ (0x1f8a, (1769, 4)),
+ (0x1f1c, (1502, 3)),
+ (0xfa38, (2573, 1)),
+ (0x2f953, (3203, 1)),
+ (0x2f8f7, (3111, 1)),
+ (0x1f41, (1598, 2)),
+ (0x1ec7, (1299, 3)),
+ (0x2fa16, (3398, 1)),
+ (0x2f859, (2953, 1)),
+ (0x2f959, (3209, 1)),
+ (0x2f8cf, (3071, 1)),
+ (0x14c, (228, 2)),
+ (0x2f993, (3267, 1)),
+ (0x13e, (214, 2)),
+ (0x12a, (182, 2)),
+ (0x2f991, (3265, 1)),
+ (0x1fca, (1960, 2)),
+ (0x389, (540, 2)),
+ (0xfa73, (2630, 1)),
+ (0x2f9d9, (3337, 1)),
+ (0x143, (216, 2)),
+ (0x2f893, (3011, 1)),
+ (0x2f827, (2903, 1)),
+ (0xfa63, (2616, 1)),
+ (0x3ac, (557, 2)),
+ (0x1f07, (1451, 3)),
+ (0x1ebb, (1266, 2)),
+ (0x2f943, (3187, 1)),
+ (0xfa67, (2620, 1)),
+ (0x4d6, (630, 2)),
+ (0x1f12, (1480, 3)),
+ (0x1f4, (410, 2)),
+ (0x1e37, (970, 2)),
+ (0x2f90f, (3135, 1)),
+ (0x1f18, (1492, 2)),
+ (0x477, (616, 2)),
+ (0x102, (110, 2)),
+ (0x2f800, (2864, 1)),
+ (0xfaaf, (2690, 1)),
+ (0x6c0, (696, 2)),
+ (0xeb, (72, 2)),
+ (0x1eda, (1348, 3)),
+ (0x1f7d, (1731, 2)),
+ (0xa59, (738, 2)),
+ (0x2f8f2, (3106, 1)),
+ (0x309e, (2209, 2)),
+ (0x30d6, (2249, 2)),
+ (0x2f92e, (3166, 1)),
+ (0xf933, (2324, 1)),
+ (0x2f96e, (3230, 1)),
+ (0x1e55, (1040, 2)),
+ (0x2281, (2119, 2)),
+ (0x1e4e, (1020, 3)),
+ (0x2f872, (2978, 1)),
+ (0x2f9fc, (3372, 1)),
+ (0x1d1bc, (2850, 2)),
+ (0xfa50, (2597, 1)),
+ (0x2f92c, (3164, 1)),
+ (0x3070, (2187, 2)),
+ (0xf9e9, (2506, 1)),
+ (0x2f83c, (2924, 1)),
+ (0x2f9f8, (3368, 1)),
+ (0x1f52, (1632, 3)),
+ (0xfaac, (2687, 1)),
+ (0x1e94, (1178, 2)),
+ (0xfad6, (2729, 1)),
+ (0x1fcb, (1962, 2)),
+ (0xfa33, (2568, 1)),
+ (0xfa1b, (2551, 1)),
+ (0xf9ee, (2511, 1)),
+ (0x1e2c, (946, 2)),
+ (0x203, (438, 2)),
+ (0x2f877, (2983, 1)),
+ (0x1ff8, (2048, 2)),
+ (0x1e9, (392, 2)),
+ (0x1fe, (428, 2)),
+ (0x2f96c, (3228, 1)),
+ (0x1e51, (1029, 3)),
+ (0x4de, (642, 2)),
+ (0xf9a4, (2437, 1)),
+ (0xfb40, (2777, 2)),
+ (0x622, (686, 2)),
+ (0x3cc, (572, 2)),
+ (0x2f99e, (3278, 1)),
+ (0xf92b, (2316, 1)),
+ (0x22e1, (2139, 2)),
+ (0x174, (300, 2)),
+ (0x1e4a, (1010, 2)),
+ (0x2f939, (3177, 1)),
+ (0x3ce, (576, 2)),
+ (0xfaa7, (2682, 1)),
+ (0xfa85, (2648, 1)),
+ (0xf9e7, (2504, 1)),
+ (0x107, (120, 2)),
+ (0xfa95, (2664, 1)),
+ (0xf973, (2388, 1)),
+ (0x2f933, (3171, 1)),
+ (0xf9c2, (2467, 1)),
+ (0x1ee1, (1369, 3)),
+ (0x1d3, (342, 2)),
+ (0x2f9d0, (3328, 1)),
+ (0xfb2a, (2737, 2)),
+ (0xfb, (98, 2)),
+ (0x1e4f, (1023, 3)),
+ (0x1f26, (1524, 3)),
+ (0xdd, (50, 2)),
+ (0x226, (492, 2)),
+ (0x2f831, (2913, 1)),
+ (0x2f9ee, (3358, 1)),
+ (0xf955, (2358, 1)),
+ (0x16e, (288, 2)),
+ (0x2f8a5, (3029, 1)),
+ (0x11b, (156, 2)),
+ (0x1e76, (1114, 2)),
+ (0xd4c, (781, 2)),
+ (0x1f3c, (1584, 3)),
+ (0x1e0a, (872, 2)),
+ (0x1e78, (1118, 3)),
+ (0x2f82a, (2906, 1)),
+ (0x12d, (188, 2)),
+ (0x2f8c5, (3061, 1)),
+ (0x1f3e, (1590, 3)),
+ (0xf95c, (2365, 1)),
+ (0x1f21, (1510, 2)),
+ (0x2f9d7, (3335, 1)),
+ (0x1f70, (1705, 2)),
+ (0x2f914, (3140, 1)),
+ (0xfa83, (2646, 1)),
+ (0x1ed5, (1333, 3)),
+ (0x1ee7, (1384, 2)),
+ (0x2278, (2113, 2)),
+ (0xf9c0, (2465, 1)),
+ (0x1ed7, (1339, 3)),
+ (0x2f8ca, (3066, 1)),
+ (0x1b3d, (842, 2)),
+ (0x2f9ad, (3293, 1)),
+ (0x95e, (720, 2)),
+ (0x220c, (2081, 2)),
+ (0x1fdf, (1999, 2)),
+ (0xfa48, (2589, 1)),
+ (0x1e04, (858, 2)),
+ (0x4d7, (632, 2)),
+ (0x216, (476, 2)),
+ (0x1e70, (1102, 2)),
+ (0x2f856, (2950, 1)),
+ (0xe9, (68, 2)),
+ (0xf951, (2354, 1)),
+ (0x231, (519, 3)),
+ (0x1f53, (1635, 3)),
+ (0x1e14, (892, 3)),
+ (0xf983, (2404, 1)),
+ (0xf9d4, (2485, 1)),
+ (0x2f973, (3235, 1)),
+ (0x2f9df, (3343, 1)),
+ (0xf98c, (2413, 1)),
+ (0x208, (448, 2)),
+ (0x2f895, (3013, 1)),
+ (0xfaaa, (2685, 1)),
+ (0x45c, (608, 2)),
+ (0x30b8, (2223, 2)),
+ (0x2244, (2089, 2)),
+ (0xff, (104, 2)),
+ (0x4d1, (624, 2)),
+ (0x2126, (2061, 1)),
+ (0x10b, (128, 2)),
+ (0x145, (220, 2)),
+ (0xf978, (2393, 1)),
+ (0x1fcd, (1966, 2)),
+ (0x2f912, (3138, 1)),
+ (0xfa36, (2571, 1)),
+ (0x2f9c0, (3312, 1)),
+ (0x4ec, (662, 2)),
+ (0x10e, (134, 2)),
+ (0x2f98d, (3261, 1)),
+ (0x1e5d, (1057, 3)),
+ (0xf43, (792, 2)),
+ (0x1e29, (940, 2)),
+ (0xf93e, (2335, 1)),
+ (0x2f9c5, (3317, 1)),
+ (0x21ce, (2073, 2)),
+ (0x2f87b, (2987, 1)),
+ (0x2f9ba, (3306, 1)),
+ (0x1ec2, (1284, 3)),
+ (0x219a, (2065, 2)),
+ (0x1f64, (1671, 3)),
+ (0xf906, (2279, 1)),
+ (0xf9d7, (2488, 1)),
+];
+
+pub(crate) const COMPATIBILITY_DECOMPOSED_CHARS: &[char] = &[
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0308}',
+ '\u{0061}',
+ '\u{0020}',
+ '\u{0304}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0020}',
+ '\u{0301}',
+ '\u{03BC}',
+ '\u{0020}',
+ '\u{0327}',
+ '\u{0031}',
+ '\u{006F}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0034}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{2044}',
+ '\u{0034}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{004C}',
+ '\u{00B7}',
+ '\u{006C}',
+ '\u{00B7}',
+ '\u{02BC}',
+ '\u{006E}',
+ '\u{0073}',
+ '\u{0044}',
+ '\u{005A}',
+ '\u{030C}',
+ '\u{0044}',
+ '\u{007A}',
+ '\u{030C}',
+ '\u{0064}',
+ '\u{007A}',
+ '\u{030C}',
+ '\u{004C}',
+ '\u{004A}',
+ '\u{004C}',
+ '\u{006A}',
+ '\u{006C}',
+ '\u{006A}',
+ '\u{004E}',
+ '\u{004A}',
+ '\u{004E}',
+ '\u{006A}',
+ '\u{006E}',
+ '\u{006A}',
+ '\u{0044}',
+ '\u{005A}',
+ '\u{0044}',
+ '\u{007A}',
+ '\u{0064}',
+ '\u{007A}',
+ '\u{0068}',
+ '\u{0266}',
+ '\u{006A}',
+ '\u{0072}',
+ '\u{0279}',
+ '\u{027B}',
+ '\u{0281}',
+ '\u{0077}',
+ '\u{0079}',
+ '\u{0020}',
+ '\u{0306}',
+ '\u{0020}',
+ '\u{0307}',
+ '\u{0020}',
+ '\u{030A}',
+ '\u{0020}',
+ '\u{0328}',
+ '\u{0020}',
+ '\u{0303}',
+ '\u{0020}',
+ '\u{030B}',
+ '\u{0263}',
+ '\u{006C}',
+ '\u{0073}',
+ '\u{0078}',
+ '\u{0295}',
+ '\u{0020}',
+ '\u{0345}',
+ '\u{0020}',
+ '\u{0301}',
+ '\u{0020}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{03B2}',
+ '\u{03B8}',
+ '\u{03A5}',
+ '\u{03A5}',
+ '\u{0301}',
+ '\u{03A5}',
+ '\u{0308}',
+ '\u{03C6}',
+ '\u{03C0}',
+ '\u{03BA}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{0398}',
+ '\u{03B5}',
+ '\u{03A3}',
+ '\u{0565}',
+ '\u{0582}',
+ '\u{0627}',
+ '\u{0674}',
+ '\u{0648}',
+ '\u{0674}',
+ '\u{06C7}',
+ '\u{0674}',
+ '\u{064A}',
+ '\u{0674}',
+ '\u{0E4D}',
+ '\u{0E32}',
+ '\u{0ECD}',
+ '\u{0EB2}',
+ '\u{0EAB}',
+ '\u{0E99}',
+ '\u{0EAB}',
+ '\u{0EA1}',
+ '\u{0F0B}',
+ '\u{0FB2}',
+ '\u{0F71}',
+ '\u{0F80}',
+ '\u{0FB3}',
+ '\u{0F71}',
+ '\u{0F80}',
+ '\u{10DC}',
+ '\u{0041}',
+ '\u{00C6}',
+ '\u{0042}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{018E}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0222}',
+ '\u{0050}',
+ '\u{0052}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0057}',
+ '\u{0061}',
+ '\u{0250}',
+ '\u{0251}',
+ '\u{1D02}',
+ '\u{0062}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0259}',
+ '\u{025B}',
+ '\u{025C}',
+ '\u{0067}',
+ '\u{006B}',
+ '\u{006D}',
+ '\u{014B}',
+ '\u{006F}',
+ '\u{0254}',
+ '\u{1D16}',
+ '\u{1D17}',
+ '\u{0070}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{1D1D}',
+ '\u{026F}',
+ '\u{0076}',
+ '\u{1D25}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{0069}',
+ '\u{0072}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03C1}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{043D}',
+ '\u{0252}',
+ '\u{0063}',
+ '\u{0255}',
+ '\u{00F0}',
+ '\u{025C}',
+ '\u{0066}',
+ '\u{025F}',
+ '\u{0261}',
+ '\u{0265}',
+ '\u{0268}',
+ '\u{0269}',
+ '\u{026A}',
+ '\u{1D7B}',
+ '\u{029D}',
+ '\u{026D}',
+ '\u{1D85}',
+ '\u{029F}',
+ '\u{0271}',
+ '\u{0270}',
+ '\u{0272}',
+ '\u{0273}',
+ '\u{0274}',
+ '\u{0275}',
+ '\u{0278}',
+ '\u{0282}',
+ '\u{0283}',
+ '\u{01AB}',
+ '\u{0289}',
+ '\u{028A}',
+ '\u{1D1C}',
+ '\u{028B}',
+ '\u{028C}',
+ '\u{007A}',
+ '\u{0290}',
+ '\u{0291}',
+ '\u{0292}',
+ '\u{03B8}',
+ '\u{0061}',
+ '\u{02BE}',
+ '\u{0073}',
+ '\u{0307}',
+ '\u{0020}',
+ '\u{0313}',
+ '\u{0020}',
+ '\u{0313}',
+ '\u{0020}',
+ '\u{0342}',
+ '\u{0020}',
+ '\u{0308}',
+ '\u{0342}',
+ '\u{0020}',
+ '\u{0313}',
+ '\u{0300}',
+ '\u{0020}',
+ '\u{0313}',
+ '\u{0301}',
+ '\u{0020}',
+ '\u{0313}',
+ '\u{0342}',
+ '\u{0020}',
+ '\u{0314}',
+ '\u{0300}',
+ '\u{0020}',
+ '\u{0314}',
+ '\u{0301}',
+ '\u{0020}',
+ '\u{0314}',
+ '\u{0342}',
+ '\u{0020}',
+ '\u{0308}',
+ '\u{0300}',
+ '\u{0020}',
+ '\u{0308}',
+ '\u{0301}',
+ '\u{0020}',
+ '\u{0301}',
+ '\u{0020}',
+ '\u{0314}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{0020}',
+ '\u{2010}',
+ '\u{0020}',
+ '\u{0333}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{0020}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2035}',
+ '\u{2035}',
+ '\u{2035}',
+ '\u{2035}',
+ '\u{2035}',
+ '\u{0021}',
+ '\u{0021}',
+ '\u{0020}',
+ '\u{0305}',
+ '\u{003F}',
+ '\u{003F}',
+ '\u{003F}',
+ '\u{0021}',
+ '\u{0021}',
+ '\u{003F}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{2032}',
+ '\u{0020}',
+ '\u{0030}',
+ '\u{0069}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{002B}',
+ '\u{2212}',
+ '\u{003D}',
+ '\u{0028}',
+ '\u{0029}',
+ '\u{006E}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{002B}',
+ '\u{2212}',
+ '\u{003D}',
+ '\u{0028}',
+ '\u{0029}',
+ '\u{0061}',
+ '\u{0065}',
+ '\u{006F}',
+ '\u{0078}',
+ '\u{0259}',
+ '\u{0068}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{0070}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0052}',
+ '\u{0073}',
+ '\u{0061}',
+ '\u{002F}',
+ '\u{0063}',
+ '\u{0061}',
+ '\u{002F}',
+ '\u{0073}',
+ '\u{0043}',
+ '\u{00B0}',
+ '\u{0043}',
+ '\u{0063}',
+ '\u{002F}',
+ '\u{006F}',
+ '\u{0063}',
+ '\u{002F}',
+ '\u{0075}',
+ '\u{0190}',
+ '\u{00B0}',
+ '\u{0046}',
+ '\u{0067}',
+ '\u{0048}',
+ '\u{0048}',
+ '\u{0048}',
+ '\u{0068}',
+ '\u{0127}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{004C}',
+ '\u{006C}',
+ '\u{004E}',
+ '\u{004E}',
+ '\u{006F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0052}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{004D}',
+ '\u{0054}',
+ '\u{0045}',
+ '\u{004C}',
+ '\u{0054}',
+ '\u{004D}',
+ '\u{005A}',
+ '\u{005A}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0065}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{004D}',
+ '\u{006F}',
+ '\u{05D0}',
+ '\u{05D1}',
+ '\u{05D2}',
+ '\u{05D3}',
+ '\u{0069}',
+ '\u{0046}',
+ '\u{0041}',
+ '\u{0058}',
+ '\u{03C0}',
+ '\u{03B3}',
+ '\u{0393}',
+ '\u{03A0}',
+ '\u{2211}',
+ '\u{0044}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0037}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0039}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0033}',
+ '\u{0032}',
+ '\u{2044}',
+ '\u{0033}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0035}',
+ '\u{0032}',
+ '\u{2044}',
+ '\u{0035}',
+ '\u{0033}',
+ '\u{2044}',
+ '\u{0035}',
+ '\u{0034}',
+ '\u{2044}',
+ '\u{0035}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0036}',
+ '\u{0035}',
+ '\u{2044}',
+ '\u{0036}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0038}',
+ '\u{0033}',
+ '\u{2044}',
+ '\u{0038}',
+ '\u{0035}',
+ '\u{2044}',
+ '\u{0038}',
+ '\u{0037}',
+ '\u{2044}',
+ '\u{0038}',
+ '\u{0031}',
+ '\u{2044}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0056}',
+ '\u{0056}',
+ '\u{0056}',
+ '\u{0049}',
+ '\u{0056}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0056}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{0058}',
+ '\u{0058}',
+ '\u{0058}',
+ '\u{0049}',
+ '\u{0058}',
+ '\u{0049}',
+ '\u{0049}',
+ '\u{004C}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{004D}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0076}',
+ '\u{0076}',
+ '\u{0076}',
+ '\u{0069}',
+ '\u{0076}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0076}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{0078}',
+ '\u{0078}',
+ '\u{0078}',
+ '\u{0069}',
+ '\u{0078}',
+ '\u{0069}',
+ '\u{0069}',
+ '\u{006C}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{006D}',
+ '\u{0030}',
+ '\u{2044}',
+ '\u{0033}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222E}',
+ '\u{222E}',
+ '\u{222E}',
+ '\u{222E}',
+ '\u{222E}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{0031}',
+ '\u{0035}',
+ '\u{0031}',
+ '\u{0036}',
+ '\u{0031}',
+ '\u{0037}',
+ '\u{0031}',
+ '\u{0038}',
+ '\u{0031}',
+ '\u{0039}',
+ '\u{0032}',
+ '\u{0030}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0032}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0033}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0034}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0035}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0036}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0037}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0038}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0039}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0035}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0036}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0037}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0038}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0031}',
+ '\u{0039}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0032}',
+ '\u{0030}',
+ '\u{0029}',
+ '\u{0031}',
+ '\u{002E}',
+ '\u{0032}',
+ '\u{002E}',
+ '\u{0033}',
+ '\u{002E}',
+ '\u{0034}',
+ '\u{002E}',
+ '\u{0035}',
+ '\u{002E}',
+ '\u{0036}',
+ '\u{002E}',
+ '\u{0037}',
+ '\u{002E}',
+ '\u{0038}',
+ '\u{002E}',
+ '\u{0039}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0035}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0036}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0037}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0038}',
+ '\u{002E}',
+ '\u{0031}',
+ '\u{0039}',
+ '\u{002E}',
+ '\u{0032}',
+ '\u{0030}',
+ '\u{002E}',
+ '\u{0028}',
+ '\u{0061}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0062}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0063}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0064}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0065}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0066}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0067}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0068}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0069}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006A}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006B}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006C}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{006F}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0070}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0071}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0072}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0073}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0074}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0075}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0076}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0077}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0078}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0079}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{007A}',
+ '\u{0029}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0030}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{222B}',
+ '\u{003A}',
+ '\u{003A}',
+ '\u{003D}',
+ '\u{003D}',
+ '\u{003D}',
+ '\u{003D}',
+ '\u{003D}',
+ '\u{003D}',
+ '\u{006A}',
+ '\u{0056}',
+ '\u{2D61}',
+ '\u{6BCD}',
+ '\u{9F9F}',
+ '\u{4E00}',
+ '\u{4E28}',
+ '\u{4E36}',
+ '\u{4E3F}',
+ '\u{4E59}',
+ '\u{4E85}',
+ '\u{4E8C}',
+ '\u{4EA0}',
+ '\u{4EBA}',
+ '\u{513F}',
+ '\u{5165}',
+ '\u{516B}',
+ '\u{5182}',
+ '\u{5196}',
+ '\u{51AB}',
+ '\u{51E0}',
+ '\u{51F5}',
+ '\u{5200}',
+ '\u{529B}',
+ '\u{52F9}',
+ '\u{5315}',
+ '\u{531A}',
+ '\u{5338}',
+ '\u{5341}',
+ '\u{535C}',
+ '\u{5369}',
+ '\u{5382}',
+ '\u{53B6}',
+ '\u{53C8}',
+ '\u{53E3}',
+ '\u{56D7}',
+ '\u{571F}',
+ '\u{58EB}',
+ '\u{5902}',
+ '\u{590A}',
+ '\u{5915}',
+ '\u{5927}',
+ '\u{5973}',
+ '\u{5B50}',
+ '\u{5B80}',
+ '\u{5BF8}',
+ '\u{5C0F}',
+ '\u{5C22}',
+ '\u{5C38}',
+ '\u{5C6E}',
+ '\u{5C71}',
+ '\u{5DDB}',
+ '\u{5DE5}',
+ '\u{5DF1}',
+ '\u{5DFE}',
+ '\u{5E72}',
+ '\u{5E7A}',
+ '\u{5E7F}',
+ '\u{5EF4}',
+ '\u{5EFE}',
+ '\u{5F0B}',
+ '\u{5F13}',
+ '\u{5F50}',
+ '\u{5F61}',
+ '\u{5F73}',
+ '\u{5FC3}',
+ '\u{6208}',
+ '\u{6236}',
+ '\u{624B}',
+ '\u{652F}',
+ '\u{6534}',
+ '\u{6587}',
+ '\u{6597}',
+ '\u{65A4}',
+ '\u{65B9}',
+ '\u{65E0}',
+ '\u{65E5}',
+ '\u{66F0}',
+ '\u{6708}',
+ '\u{6728}',
+ '\u{6B20}',
+ '\u{6B62}',
+ '\u{6B79}',
+ '\u{6BB3}',
+ '\u{6BCB}',
+ '\u{6BD4}',
+ '\u{6BDB}',
+ '\u{6C0F}',
+ '\u{6C14}',
+ '\u{6C34}',
+ '\u{706B}',
+ '\u{722A}',
+ '\u{7236}',
+ '\u{723B}',
+ '\u{723F}',
+ '\u{7247}',
+ '\u{7259}',
+ '\u{725B}',
+ '\u{72AC}',
+ '\u{7384}',
+ '\u{7389}',
+ '\u{74DC}',
+ '\u{74E6}',
+ '\u{7518}',
+ '\u{751F}',
+ '\u{7528}',
+ '\u{7530}',
+ '\u{758B}',
+ '\u{7592}',
+ '\u{7676}',
+ '\u{767D}',
+ '\u{76AE}',
+ '\u{76BF}',
+ '\u{76EE}',
+ '\u{77DB}',
+ '\u{77E2}',
+ '\u{77F3}',
+ '\u{793A}',
+ '\u{79B8}',
+ '\u{79BE}',
+ '\u{7A74}',
+ '\u{7ACB}',
+ '\u{7AF9}',
+ '\u{7C73}',
+ '\u{7CF8}',
+ '\u{7F36}',
+ '\u{7F51}',
+ '\u{7F8A}',
+ '\u{7FBD}',
+ '\u{8001}',
+ '\u{800C}',
+ '\u{8012}',
+ '\u{8033}',
+ '\u{807F}',
+ '\u{8089}',
+ '\u{81E3}',
+ '\u{81EA}',
+ '\u{81F3}',
+ '\u{81FC}',
+ '\u{820C}',
+ '\u{821B}',
+ '\u{821F}',
+ '\u{826E}',
+ '\u{8272}',
+ '\u{8278}',
+ '\u{864D}',
+ '\u{866B}',
+ '\u{8840}',
+ '\u{884C}',
+ '\u{8863}',
+ '\u{897E}',
+ '\u{898B}',
+ '\u{89D2}',
+ '\u{8A00}',
+ '\u{8C37}',
+ '\u{8C46}',
+ '\u{8C55}',
+ '\u{8C78}',
+ '\u{8C9D}',
+ '\u{8D64}',
+ '\u{8D70}',
+ '\u{8DB3}',
+ '\u{8EAB}',
+ '\u{8ECA}',
+ '\u{8F9B}',
+ '\u{8FB0}',
+ '\u{8FB5}',
+ '\u{9091}',
+ '\u{9149}',
+ '\u{91C6}',
+ '\u{91CC}',
+ '\u{91D1}',
+ '\u{9577}',
+ '\u{9580}',
+ '\u{961C}',
+ '\u{96B6}',
+ '\u{96B9}',
+ '\u{96E8}',
+ '\u{9751}',
+ '\u{975E}',
+ '\u{9762}',
+ '\u{9769}',
+ '\u{97CB}',
+ '\u{97ED}',
+ '\u{97F3}',
+ '\u{9801}',
+ '\u{98A8}',
+ '\u{98DB}',
+ '\u{98DF}',
+ '\u{9996}',
+ '\u{9999}',
+ '\u{99AC}',
+ '\u{9AA8}',
+ '\u{9AD8}',
+ '\u{9ADF}',
+ '\u{9B25}',
+ '\u{9B2F}',
+ '\u{9B32}',
+ '\u{9B3C}',
+ '\u{9B5A}',
+ '\u{9CE5}',
+ '\u{9E75}',
+ '\u{9E7F}',
+ '\u{9EA5}',
+ '\u{9EBB}',
+ '\u{9EC3}',
+ '\u{9ECD}',
+ '\u{9ED1}',
+ '\u{9EF9}',
+ '\u{9EFD}',
+ '\u{9F0E}',
+ '\u{9F13}',
+ '\u{9F20}',
+ '\u{9F3B}',
+ '\u{9F4A}',
+ '\u{9F52}',
+ '\u{9F8D}',
+ '\u{9F9C}',
+ '\u{9FA0}',
+ '\u{0020}',
+ '\u{3012}',
+ '\u{5341}',
+ '\u{5344}',
+ '\u{5345}',
+ '\u{0020}',
+ '\u{3099}',
+ '\u{0020}',
+ '\u{309A}',
+ '\u{3088}',
+ '\u{308A}',
+ '\u{30B3}',
+ '\u{30C8}',
+ '\u{1100}',
+ '\u{1101}',
+ '\u{11AA}',
+ '\u{1102}',
+ '\u{11AC}',
+ '\u{11AD}',
+ '\u{1103}',
+ '\u{1104}',
+ '\u{1105}',
+ '\u{11B0}',
+ '\u{11B1}',
+ '\u{11B2}',
+ '\u{11B3}',
+ '\u{11B4}',
+ '\u{11B5}',
+ '\u{111A}',
+ '\u{1106}',
+ '\u{1107}',
+ '\u{1108}',
+ '\u{1121}',
+ '\u{1109}',
+ '\u{110A}',
+ '\u{110B}',
+ '\u{110C}',
+ '\u{110D}',
+ '\u{110E}',
+ '\u{110F}',
+ '\u{1110}',
+ '\u{1111}',
+ '\u{1112}',
+ '\u{1161}',
+ '\u{1162}',
+ '\u{1163}',
+ '\u{1164}',
+ '\u{1165}',
+ '\u{1166}',
+ '\u{1167}',
+ '\u{1168}',
+ '\u{1169}',
+ '\u{116A}',
+ '\u{116B}',
+ '\u{116C}',
+ '\u{116D}',
+ '\u{116E}',
+ '\u{116F}',
+ '\u{1170}',
+ '\u{1171}',
+ '\u{1172}',
+ '\u{1173}',
+ '\u{1174}',
+ '\u{1175}',
+ '\u{1160}',
+ '\u{1114}',
+ '\u{1115}',
+ '\u{11C7}',
+ '\u{11C8}',
+ '\u{11CC}',
+ '\u{11CE}',
+ '\u{11D3}',
+ '\u{11D7}',
+ '\u{11D9}',
+ '\u{111C}',
+ '\u{11DD}',
+ '\u{11DF}',
+ '\u{111D}',
+ '\u{111E}',
+ '\u{1120}',
+ '\u{1122}',
+ '\u{1123}',
+ '\u{1127}',
+ '\u{1129}',
+ '\u{112B}',
+ '\u{112C}',
+ '\u{112D}',
+ '\u{112E}',
+ '\u{112F}',
+ '\u{1132}',
+ '\u{1136}',
+ '\u{1140}',
+ '\u{1147}',
+ '\u{114C}',
+ '\u{11F1}',
+ '\u{11F2}',
+ '\u{1157}',
+ '\u{1158}',
+ '\u{1159}',
+ '\u{1184}',
+ '\u{1185}',
+ '\u{1188}',
+ '\u{1191}',
+ '\u{1192}',
+ '\u{1194}',
+ '\u{119E}',
+ '\u{11A1}',
+ '\u{4E00}',
+ '\u{4E8C}',
+ '\u{4E09}',
+ '\u{56DB}',
+ '\u{4E0A}',
+ '\u{4E2D}',
+ '\u{4E0B}',
+ '\u{7532}',
+ '\u{4E59}',
+ '\u{4E19}',
+ '\u{4E01}',
+ '\u{5929}',
+ '\u{5730}',
+ '\u{4EBA}',
+ '\u{0028}',
+ '\u{1100}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1102}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1103}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1105}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1106}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1107}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1109}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110B}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110C}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110F}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1110}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1111}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1112}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1100}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1102}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1103}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1105}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1106}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1107}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1109}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110B}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110C}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110E}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110F}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1110}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1111}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{1112}',
+ '\u{1161}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110C}',
+ '\u{116E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110B}',
+ '\u{1169}',
+ '\u{110C}',
+ '\u{1165}',
+ '\u{11AB}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{110B}',
+ '\u{1169}',
+ '\u{1112}',
+ '\u{116E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E00}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E8C}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E09}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{56DB}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E94}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{516D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E03}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{516B}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4E5D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{5341}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{6708}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{706B}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{6C34}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{6728}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{91D1}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{571F}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{65E5}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{682A}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{6709}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{793E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{540D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{7279}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{8CA1}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{795D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{52B4}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4EE3}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{547C}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{5B66}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{76E3}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4F01}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{8CC7}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{5354}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{796D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{4F11}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{81EA}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{81F3}',
+ '\u{0029}',
+ '\u{554F}',
+ '\u{5E7C}',
+ '\u{6587}',
+ '\u{7B8F}',
+ '\u{0050}',
+ '\u{0054}',
+ '\u{0045}',
+ '\u{0032}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0032}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0032}',
+ '\u{0034}',
+ '\u{0032}',
+ '\u{0035}',
+ '\u{0032}',
+ '\u{0036}',
+ '\u{0032}',
+ '\u{0037}',
+ '\u{0032}',
+ '\u{0038}',
+ '\u{0032}',
+ '\u{0039}',
+ '\u{0033}',
+ '\u{0030}',
+ '\u{0033}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0033}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0033}',
+ '\u{0035}',
+ '\u{1100}',
+ '\u{1102}',
+ '\u{1103}',
+ '\u{1105}',
+ '\u{1106}',
+ '\u{1107}',
+ '\u{1109}',
+ '\u{110B}',
+ '\u{110C}',
+ '\u{110E}',
+ '\u{110F}',
+ '\u{1110}',
+ '\u{1111}',
+ '\u{1112}',
+ '\u{1100}',
+ '\u{1161}',
+ '\u{1102}',
+ '\u{1161}',
+ '\u{1103}',
+ '\u{1161}',
+ '\u{1105}',
+ '\u{1161}',
+ '\u{1106}',
+ '\u{1161}',
+ '\u{1107}',
+ '\u{1161}',
+ '\u{1109}',
+ '\u{1161}',
+ '\u{110B}',
+ '\u{1161}',
+ '\u{110C}',
+ '\u{1161}',
+ '\u{110E}',
+ '\u{1161}',
+ '\u{110F}',
+ '\u{1161}',
+ '\u{1110}',
+ '\u{1161}',
+ '\u{1111}',
+ '\u{1161}',
+ '\u{1112}',
+ '\u{1161}',
+ '\u{110E}',
+ '\u{1161}',
+ '\u{11B7}',
+ '\u{1100}',
+ '\u{1169}',
+ '\u{110C}',
+ '\u{116E}',
+ '\u{110B}',
+ '\u{1174}',
+ '\u{110B}',
+ '\u{116E}',
+ '\u{4E00}',
+ '\u{4E8C}',
+ '\u{4E09}',
+ '\u{56DB}',
+ '\u{4E94}',
+ '\u{516D}',
+ '\u{4E03}',
+ '\u{516B}',
+ '\u{4E5D}',
+ '\u{5341}',
+ '\u{6708}',
+ '\u{706B}',
+ '\u{6C34}',
+ '\u{6728}',
+ '\u{91D1}',
+ '\u{571F}',
+ '\u{65E5}',
+ '\u{682A}',
+ '\u{6709}',
+ '\u{793E}',
+ '\u{540D}',
+ '\u{7279}',
+ '\u{8CA1}',
+ '\u{795D}',
+ '\u{52B4}',
+ '\u{79D8}',
+ '\u{7537}',
+ '\u{5973}',
+ '\u{9069}',
+ '\u{512A}',
+ '\u{5370}',
+ '\u{6CE8}',
+ '\u{9805}',
+ '\u{4F11}',
+ '\u{5199}',
+ '\u{6B63}',
+ '\u{4E0A}',
+ '\u{4E2D}',
+ '\u{4E0B}',
+ '\u{5DE6}',
+ '\u{53F3}',
+ '\u{533B}',
+ '\u{5B97}',
+ '\u{5B66}',
+ '\u{76E3}',
+ '\u{4F01}',
+ '\u{8CC7}',
+ '\u{5354}',
+ '\u{591C}',
+ '\u{0033}',
+ '\u{0036}',
+ '\u{0033}',
+ '\u{0037}',
+ '\u{0033}',
+ '\u{0038}',
+ '\u{0033}',
+ '\u{0039}',
+ '\u{0034}',
+ '\u{0030}',
+ '\u{0034}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{0032}',
+ '\u{0034}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0034}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0034}',
+ '\u{0036}',
+ '\u{0034}',
+ '\u{0037}',
+ '\u{0034}',
+ '\u{0038}',
+ '\u{0034}',
+ '\u{0039}',
+ '\u{0035}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{6708}',
+ '\u{0032}',
+ '\u{6708}',
+ '\u{0033}',
+ '\u{6708}',
+ '\u{0034}',
+ '\u{6708}',
+ '\u{0035}',
+ '\u{6708}',
+ '\u{0036}',
+ '\u{6708}',
+ '\u{0037}',
+ '\u{6708}',
+ '\u{0038}',
+ '\u{6708}',
+ '\u{0039}',
+ '\u{6708}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{6708}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{6708}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{6708}',
+ '\u{0048}',
+ '\u{0067}',
+ '\u{0065}',
+ '\u{0072}',
+ '\u{0067}',
+ '\u{0065}',
+ '\u{0056}',
+ '\u{004C}',
+ '\u{0054}',
+ '\u{0044}',
+ '\u{30A2}',
+ '\u{30A4}',
+ '\u{30A6}',
+ '\u{30A8}',
+ '\u{30AA}',
+ '\u{30AB}',
+ '\u{30AD}',
+ '\u{30AF}',
+ '\u{30B1}',
+ '\u{30B3}',
+ '\u{30B5}',
+ '\u{30B7}',
+ '\u{30B9}',
+ '\u{30BB}',
+ '\u{30BD}',
+ '\u{30BF}',
+ '\u{30C1}',
+ '\u{30C4}',
+ '\u{30C6}',
+ '\u{30C8}',
+ '\u{30CA}',
+ '\u{30CB}',
+ '\u{30CC}',
+ '\u{30CD}',
+ '\u{30CE}',
+ '\u{30CF}',
+ '\u{30D2}',
+ '\u{30D5}',
+ '\u{30D8}',
+ '\u{30DB}',
+ '\u{30DE}',
+ '\u{30DF}',
+ '\u{30E0}',
+ '\u{30E1}',
+ '\u{30E2}',
+ '\u{30E4}',
+ '\u{30E6}',
+ '\u{30E8}',
+ '\u{30E9}',
+ '\u{30EA}',
+ '\u{30EB}',
+ '\u{30EC}',
+ '\u{30ED}',
+ '\u{30EF}',
+ '\u{30F0}',
+ '\u{30F1}',
+ '\u{30F2}',
+ '\u{4EE4}',
+ '\u{548C}',
+ '\u{30A2}',
+ '\u{30CF}',
+ '\u{309A}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{30A2}',
+ '\u{30EB}',
+ '\u{30D5}',
+ '\u{30A1}',
+ '\u{30A2}',
+ '\u{30F3}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30A2}',
+ '\u{30A2}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30A4}',
+ '\u{30CB}',
+ '\u{30F3}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30A4}',
+ '\u{30F3}',
+ '\u{30C1}',
+ '\u{30A6}',
+ '\u{30A9}',
+ '\u{30F3}',
+ '\u{30A8}',
+ '\u{30B9}',
+ '\u{30AF}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30A8}',
+ '\u{30FC}',
+ '\u{30AB}',
+ '\u{30FC}',
+ '\u{30AA}',
+ '\u{30F3}',
+ '\u{30B9}',
+ '\u{30AA}',
+ '\u{30FC}',
+ '\u{30E0}',
+ '\u{30AB}',
+ '\u{30A4}',
+ '\u{30EA}',
+ '\u{30AB}',
+ '\u{30E9}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{30AB}',
+ '\u{30ED}',
+ '\u{30EA}',
+ '\u{30FC}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30ED}',
+ '\u{30F3}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30F3}',
+ '\u{30DE}',
+ '\u{30AD}',
+ '\u{3099}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30AD}',
+ '\u{3099}',
+ '\u{30CB}',
+ '\u{30FC}',
+ '\u{30AD}',
+ '\u{30E5}',
+ '\u{30EA}',
+ '\u{30FC}',
+ '\u{30AD}',
+ '\u{3099}',
+ '\u{30EB}',
+ '\u{30BF}',
+ '\u{3099}',
+ '\u{30FC}',
+ '\u{30AD}',
+ '\u{30ED}',
+ '\u{30AD}',
+ '\u{30ED}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30E9}',
+ '\u{30E0}',
+ '\u{30AD}',
+ '\u{30ED}',
+ '\u{30E1}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{30EB}',
+ '\u{30AD}',
+ '\u{30ED}',
+ '\u{30EF}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30E9}',
+ '\u{30E0}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30E9}',
+ '\u{30E0}',
+ '\u{30C8}',
+ '\u{30F3}',
+ '\u{30AF}',
+ '\u{30EB}',
+ '\u{30BB}',
+ '\u{3099}',
+ '\u{30A4}',
+ '\u{30ED}',
+ '\u{30AF}',
+ '\u{30ED}',
+ '\u{30FC}',
+ '\u{30CD}',
+ '\u{30B1}',
+ '\u{30FC}',
+ '\u{30B9}',
+ '\u{30B3}',
+ '\u{30EB}',
+ '\u{30CA}',
+ '\u{30B3}',
+ '\u{30FC}',
+ '\u{30DB}',
+ '\u{309A}',
+ '\u{30B5}',
+ '\u{30A4}',
+ '\u{30AF}',
+ '\u{30EB}',
+ '\u{30B5}',
+ '\u{30F3}',
+ '\u{30C1}',
+ '\u{30FC}',
+ '\u{30E0}',
+ '\u{30B7}',
+ '\u{30EA}',
+ '\u{30F3}',
+ '\u{30AF}',
+ '\u{3099}',
+ '\u{30BB}',
+ '\u{30F3}',
+ '\u{30C1}',
+ '\u{30BB}',
+ '\u{30F3}',
+ '\u{30C8}',
+ '\u{30BF}',
+ '\u{3099}',
+ '\u{30FC}',
+ '\u{30B9}',
+ '\u{30C6}',
+ '\u{3099}',
+ '\u{30B7}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30EB}',
+ '\u{30C8}',
+ '\u{30F3}',
+ '\u{30CA}',
+ '\u{30CE}',
+ '\u{30CE}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{30CF}',
+ '\u{30A4}',
+ '\u{30C4}',
+ '\u{30CF}',
+ '\u{309A}',
+ '\u{30FC}',
+ '\u{30BB}',
+ '\u{30F3}',
+ '\u{30C8}',
+ '\u{30CF}',
+ '\u{309A}',
+ '\u{30FC}',
+ '\u{30C4}',
+ '\u{30CF}',
+ '\u{3099}',
+ '\u{30FC}',
+ '\u{30EC}',
+ '\u{30EB}',
+ '\u{30D2}',
+ '\u{309A}',
+ '\u{30A2}',
+ '\u{30B9}',
+ '\u{30C8}',
+ '\u{30EB}',
+ '\u{30D2}',
+ '\u{309A}',
+ '\u{30AF}',
+ '\u{30EB}',
+ '\u{30D2}',
+ '\u{309A}',
+ '\u{30B3}',
+ '\u{30D2}',
+ '\u{3099}',
+ '\u{30EB}',
+ '\u{30D5}',
+ '\u{30A1}',
+ '\u{30E9}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30D5}',
+ '\u{30A3}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{30D5}',
+ '\u{3099}',
+ '\u{30C3}',
+ '\u{30B7}',
+ '\u{30A7}',
+ '\u{30EB}',
+ '\u{30D5}',
+ '\u{30E9}',
+ '\u{30F3}',
+ '\u{30D8}',
+ '\u{30AF}',
+ '\u{30BF}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30BD}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30CB}',
+ '\u{30D2}',
+ '\u{30D8}',
+ '\u{30EB}',
+ '\u{30C4}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30F3}',
+ '\u{30B9}',
+ '\u{30D8}',
+ '\u{309A}',
+ '\u{30FC}',
+ '\u{30B7}',
+ '\u{3099}',
+ '\u{30D8}',
+ '\u{3099}',
+ '\u{30FC}',
+ '\u{30BF}',
+ '\u{30DB}',
+ '\u{309A}',
+ '\u{30A4}',
+ '\u{30F3}',
+ '\u{30C8}',
+ '\u{30DB}',
+ '\u{3099}',
+ '\u{30EB}',
+ '\u{30C8}',
+ '\u{30DB}',
+ '\u{30F3}',
+ '\u{30DB}',
+ '\u{309A}',
+ '\u{30F3}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30DB}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30DB}',
+ '\u{30FC}',
+ '\u{30F3}',
+ '\u{30DE}',
+ '\u{30A4}',
+ '\u{30AF}',
+ '\u{30ED}',
+ '\u{30DE}',
+ '\u{30A4}',
+ '\u{30EB}',
+ '\u{30DE}',
+ '\u{30C3}',
+ '\u{30CF}',
+ '\u{30DE}',
+ '\u{30EB}',
+ '\u{30AF}',
+ '\u{30DE}',
+ '\u{30F3}',
+ '\u{30B7}',
+ '\u{30E7}',
+ '\u{30F3}',
+ '\u{30DF}',
+ '\u{30AF}',
+ '\u{30ED}',
+ '\u{30F3}',
+ '\u{30DF}',
+ '\u{30EA}',
+ '\u{30DF}',
+ '\u{30EA}',
+ '\u{30CF}',
+ '\u{3099}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30E1}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30E1}',
+ '\u{30AB}',
+ '\u{3099}',
+ '\u{30C8}',
+ '\u{30F3}',
+ '\u{30E1}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{30EB}',
+ '\u{30E4}',
+ '\u{30FC}',
+ '\u{30C8}',
+ '\u{3099}',
+ '\u{30E4}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30E6}',
+ '\u{30A2}',
+ '\u{30F3}',
+ '\u{30EA}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{30EB}',
+ '\u{30EA}',
+ '\u{30E9}',
+ '\u{30EB}',
+ '\u{30D2}',
+ '\u{309A}',
+ '\u{30FC}',
+ '\u{30EB}',
+ '\u{30FC}',
+ '\u{30D5}',
+ '\u{3099}',
+ '\u{30EB}',
+ '\u{30EC}',
+ '\u{30E0}',
+ '\u{30EC}',
+ '\u{30F3}',
+ '\u{30C8}',
+ '\u{30B1}',
+ '\u{3099}',
+ '\u{30F3}',
+ '\u{30EF}',
+ '\u{30C3}',
+ '\u{30C8}',
+ '\u{0030}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{70B9}',
+ '\u{0033}',
+ '\u{70B9}',
+ '\u{0034}',
+ '\u{70B9}',
+ '\u{0035}',
+ '\u{70B9}',
+ '\u{0036}',
+ '\u{70B9}',
+ '\u{0037}',
+ '\u{70B9}',
+ '\u{0038}',
+ '\u{70B9}',
+ '\u{0039}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0035}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0036}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0037}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0038}',
+ '\u{70B9}',
+ '\u{0031}',
+ '\u{0039}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{0030}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{0031}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{0032}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{70B9}',
+ '\u{0032}',
+ '\u{0034}',
+ '\u{70B9}',
+ '\u{0068}',
+ '\u{0050}',
+ '\u{0061}',
+ '\u{0064}',
+ '\u{0061}',
+ '\u{0041}',
+ '\u{0055}',
+ '\u{0062}',
+ '\u{0061}',
+ '\u{0072}',
+ '\u{006F}',
+ '\u{0056}',
+ '\u{0070}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{006D}',
+ '\u{0064}',
+ '\u{006D}',
+ '\u{0032}',
+ '\u{0064}',
+ '\u{006D}',
+ '\u{0033}',
+ '\u{0049}',
+ '\u{0055}',
+ '\u{5E73}',
+ '\u{6210}',
+ '\u{662D}',
+ '\u{548C}',
+ '\u{5927}',
+ '\u{6B63}',
+ '\u{660E}',
+ '\u{6CBB}',
+ '\u{682A}',
+ '\u{5F0F}',
+ '\u{4F1A}',
+ '\u{793E}',
+ '\u{0070}',
+ '\u{0041}',
+ '\u{006E}',
+ '\u{0041}',
+ '\u{03BC}',
+ '\u{0041}',
+ '\u{006D}',
+ '\u{0041}',
+ '\u{006B}',
+ '\u{0041}',
+ '\u{004B}',
+ '\u{0042}',
+ '\u{004D}',
+ '\u{0042}',
+ '\u{0047}',
+ '\u{0042}',
+ '\u{0063}',
+ '\u{0061}',
+ '\u{006C}',
+ '\u{006B}',
+ '\u{0063}',
+ '\u{0061}',
+ '\u{006C}',
+ '\u{0070}',
+ '\u{0046}',
+ '\u{006E}',
+ '\u{0046}',
+ '\u{03BC}',
+ '\u{0046}',
+ '\u{03BC}',
+ '\u{0067}',
+ '\u{006D}',
+ '\u{0067}',
+ '\u{006B}',
+ '\u{0067}',
+ '\u{0048}',
+ '\u{007A}',
+ '\u{006B}',
+ '\u{0048}',
+ '\u{007A}',
+ '\u{004D}',
+ '\u{0048}',
+ '\u{007A}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{007A}',
+ '\u{0054}',
+ '\u{0048}',
+ '\u{007A}',
+ '\u{03BC}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006C}',
+ '\u{0064}',
+ '\u{006C}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{0066}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006D}',
+ '\u{03BC}',
+ '\u{006D}',
+ '\u{006D}',
+ '\u{006D}',
+ '\u{0063}',
+ '\u{006D}',
+ '\u{006B}',
+ '\u{006D}',
+ '\u{006D}',
+ '\u{006D}',
+ '\u{0032}',
+ '\u{0063}',
+ '\u{006D}',
+ '\u{0032}',
+ '\u{006D}',
+ '\u{0032}',
+ '\u{006B}',
+ '\u{006D}',
+ '\u{0032}',
+ '\u{006D}',
+ '\u{006D}',
+ '\u{0033}',
+ '\u{0063}',
+ '\u{006D}',
+ '\u{0033}',
+ '\u{006D}',
+ '\u{0033}',
+ '\u{006B}',
+ '\u{006D}',
+ '\u{0033}',
+ '\u{006D}',
+ '\u{2215}',
+ '\u{0073}',
+ '\u{006D}',
+ '\u{2215}',
+ '\u{0073}',
+ '\u{0032}',
+ '\u{0050}',
+ '\u{0061}',
+ '\u{006B}',
+ '\u{0050}',
+ '\u{0061}',
+ '\u{004D}',
+ '\u{0050}',
+ '\u{0061}',
+ '\u{0047}',
+ '\u{0050}',
+ '\u{0061}',
+ '\u{0072}',
+ '\u{0061}',
+ '\u{0064}',
+ '\u{0072}',
+ '\u{0061}',
+ '\u{0064}',
+ '\u{2215}',
+ '\u{0073}',
+ '\u{0072}',
+ '\u{0061}',
+ '\u{0064}',
+ '\u{2215}',
+ '\u{0073}',
+ '\u{0032}',
+ '\u{0070}',
+ '\u{0073}',
+ '\u{006E}',
+ '\u{0073}',
+ '\u{03BC}',
+ '\u{0073}',
+ '\u{006D}',
+ '\u{0073}',
+ '\u{0070}',
+ '\u{0056}',
+ '\u{006E}',
+ '\u{0056}',
+ '\u{03BC}',
+ '\u{0056}',
+ '\u{006D}',
+ '\u{0056}',
+ '\u{006B}',
+ '\u{0056}',
+ '\u{004D}',
+ '\u{0056}',
+ '\u{0070}',
+ '\u{0057}',
+ '\u{006E}',
+ '\u{0057}',
+ '\u{03BC}',
+ '\u{0057}',
+ '\u{006D}',
+ '\u{0057}',
+ '\u{006B}',
+ '\u{0057}',
+ '\u{004D}',
+ '\u{0057}',
+ '\u{006B}',
+ '\u{03A9}',
+ '\u{004D}',
+ '\u{03A9}',
+ '\u{0061}',
+ '\u{002E}',
+ '\u{006D}',
+ '\u{002E}',
+ '\u{0042}',
+ '\u{0071}',
+ '\u{0063}',
+ '\u{0063}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0043}',
+ '\u{2215}',
+ '\u{006B}',
+ '\u{0067}',
+ '\u{0043}',
+ '\u{006F}',
+ '\u{002E}',
+ '\u{0064}',
+ '\u{0042}',
+ '\u{0047}',
+ '\u{0079}',
+ '\u{0068}',
+ '\u{0061}',
+ '\u{0048}',
+ '\u{0050}',
+ '\u{0069}',
+ '\u{006E}',
+ '\u{004B}',
+ '\u{004B}',
+ '\u{004B}',
+ '\u{004D}',
+ '\u{006B}',
+ '\u{0074}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006C}',
+ '\u{006E}',
+ '\u{006C}',
+ '\u{006F}',
+ '\u{0067}',
+ '\u{006C}',
+ '\u{0078}',
+ '\u{006D}',
+ '\u{0062}',
+ '\u{006D}',
+ '\u{0069}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006F}',
+ '\u{006C}',
+ '\u{0050}',
+ '\u{0048}',
+ '\u{0070}',
+ '\u{002E}',
+ '\u{006D}',
+ '\u{002E}',
+ '\u{0050}',
+ '\u{0050}',
+ '\u{004D}',
+ '\u{0050}',
+ '\u{0052}',
+ '\u{0073}',
+ '\u{0072}',
+ '\u{0053}',
+ '\u{0076}',
+ '\u{0057}',
+ '\u{0062}',
+ '\u{0056}',
+ '\u{2215}',
+ '\u{006D}',
+ '\u{0041}',
+ '\u{2215}',
+ '\u{006D}',
+ '\u{0031}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{65E5}',
+ '\u{0033}',
+ '\u{65E5}',
+ '\u{0034}',
+ '\u{65E5}',
+ '\u{0035}',
+ '\u{65E5}',
+ '\u{0036}',
+ '\u{65E5}',
+ '\u{0037}',
+ '\u{65E5}',
+ '\u{0038}',
+ '\u{65E5}',
+ '\u{0039}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0030}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0031}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0033}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0034}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0035}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0036}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0037}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0038}',
+ '\u{65E5}',
+ '\u{0031}',
+ '\u{0039}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0030}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0031}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0032}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0034}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0035}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0036}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0037}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0038}',
+ '\u{65E5}',
+ '\u{0032}',
+ '\u{0039}',
+ '\u{65E5}',
+ '\u{0033}',
+ '\u{0030}',
+ '\u{65E5}',
+ '\u{0033}',
+ '\u{0031}',
+ '\u{65E5}',
+ '\u{0067}',
+ '\u{0061}',
+ '\u{006C}',
+ '\u{044A}',
+ '\u{044C}',
+ '\u{A76F}',
+ '\u{0043}',
+ '\u{0046}',
+ '\u{0051}',
+ '\u{0126}',
+ '\u{0153}',
+ '\u{A727}',
+ '\u{AB37}',
+ '\u{026B}',
+ '\u{AB52}',
+ '\u{028D}',
+ '\u{0066}',
+ '\u{0066}',
+ '\u{0066}',
+ '\u{0069}',
+ '\u{0066}',
+ '\u{006C}',
+ '\u{0066}',
+ '\u{0066}',
+ '\u{0069}',
+ '\u{0066}',
+ '\u{0066}',
+ '\u{006C}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0574}',
+ '\u{0576}',
+ '\u{0574}',
+ '\u{0565}',
+ '\u{0574}',
+ '\u{056B}',
+ '\u{057E}',
+ '\u{0576}',
+ '\u{0574}',
+ '\u{056D}',
+ '\u{05E2}',
+ '\u{05D0}',
+ '\u{05D3}',
+ '\u{05D4}',
+ '\u{05DB}',
+ '\u{05DC}',
+ '\u{05DD}',
+ '\u{05E8}',
+ '\u{05EA}',
+ '\u{002B}',
+ '\u{05D0}',
+ '\u{05DC}',
+ '\u{0671}',
+ '\u{0671}',
+ '\u{067B}',
+ '\u{067B}',
+ '\u{067B}',
+ '\u{067B}',
+ '\u{067E}',
+ '\u{067E}',
+ '\u{067E}',
+ '\u{067E}',
+ '\u{0680}',
+ '\u{0680}',
+ '\u{0680}',
+ '\u{0680}',
+ '\u{067A}',
+ '\u{067A}',
+ '\u{067A}',
+ '\u{067A}',
+ '\u{067F}',
+ '\u{067F}',
+ '\u{067F}',
+ '\u{067F}',
+ '\u{0679}',
+ '\u{0679}',
+ '\u{0679}',
+ '\u{0679}',
+ '\u{06A4}',
+ '\u{06A4}',
+ '\u{06A4}',
+ '\u{06A4}',
+ '\u{06A6}',
+ '\u{06A6}',
+ '\u{06A6}',
+ '\u{06A6}',
+ '\u{0684}',
+ '\u{0684}',
+ '\u{0684}',
+ '\u{0684}',
+ '\u{0683}',
+ '\u{0683}',
+ '\u{0683}',
+ '\u{0683}',
+ '\u{0686}',
+ '\u{0686}',
+ '\u{0686}',
+ '\u{0686}',
+ '\u{0687}',
+ '\u{0687}',
+ '\u{0687}',
+ '\u{0687}',
+ '\u{068D}',
+ '\u{068D}',
+ '\u{068C}',
+ '\u{068C}',
+ '\u{068E}',
+ '\u{068E}',
+ '\u{0688}',
+ '\u{0688}',
+ '\u{0698}',
+ '\u{0698}',
+ '\u{0691}',
+ '\u{0691}',
+ '\u{06A9}',
+ '\u{06A9}',
+ '\u{06A9}',
+ '\u{06A9}',
+ '\u{06AF}',
+ '\u{06AF}',
+ '\u{06AF}',
+ '\u{06AF}',
+ '\u{06B3}',
+ '\u{06B3}',
+ '\u{06B3}',
+ '\u{06B3}',
+ '\u{06B1}',
+ '\u{06B1}',
+ '\u{06B1}',
+ '\u{06B1}',
+ '\u{06BA}',
+ '\u{06BA}',
+ '\u{06BB}',
+ '\u{06BB}',
+ '\u{06BB}',
+ '\u{06BB}',
+ '\u{06D5}',
+ '\u{0654}',
+ '\u{06D5}',
+ '\u{0654}',
+ '\u{06C1}',
+ '\u{06C1}',
+ '\u{06C1}',
+ '\u{06C1}',
+ '\u{06BE}',
+ '\u{06BE}',
+ '\u{06BE}',
+ '\u{06BE}',
+ '\u{06D2}',
+ '\u{06D2}',
+ '\u{06D2}',
+ '\u{0654}',
+ '\u{06D2}',
+ '\u{0654}',
+ '\u{06AD}',
+ '\u{06AD}',
+ '\u{06AD}',
+ '\u{06AD}',
+ '\u{06C7}',
+ '\u{06C7}',
+ '\u{06C6}',
+ '\u{06C6}',
+ '\u{06C8}',
+ '\u{06C8}',
+ '\u{06C7}',
+ '\u{0674}',
+ '\u{06CB}',
+ '\u{06CB}',
+ '\u{06C5}',
+ '\u{06C5}',
+ '\u{06C9}',
+ '\u{06C9}',
+ '\u{06D0}',
+ '\u{06D0}',
+ '\u{06D0}',
+ '\u{06D0}',
+ '\u{0649}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D5}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D5}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0648}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0648}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C7}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C7}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C6}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C6}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C8}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06C8}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D0}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D0}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{06D0}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0649}',
+ '\u{06CC}',
+ '\u{06CC}',
+ '\u{06CC}',
+ '\u{06CC}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{064A}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{0628}',
+ '\u{062D}',
+ '\u{0628}',
+ '\u{062E}',
+ '\u{0628}',
+ '\u{0645}',
+ '\u{0628}',
+ '\u{0649}',
+ '\u{0628}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{062C}',
+ '\u{062A}',
+ '\u{062D}',
+ '\u{062A}',
+ '\u{062E}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{0649}',
+ '\u{062A}',
+ '\u{064A}',
+ '\u{062B}',
+ '\u{062C}',
+ '\u{062B}',
+ '\u{0645}',
+ '\u{062B}',
+ '\u{0649}',
+ '\u{062B}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{062C}',
+ '\u{062E}',
+ '\u{062D}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{062C}',
+ '\u{0633}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{062E}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{0635}',
+ '\u{062D}',
+ '\u{0635}',
+ '\u{0645}',
+ '\u{0636}',
+ '\u{062C}',
+ '\u{0636}',
+ '\u{062D}',
+ '\u{0636}',
+ '\u{062E}',
+ '\u{0636}',
+ '\u{0645}',
+ '\u{0637}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{0638}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{062C}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{063A}',
+ '\u{062C}',
+ '\u{063A}',
+ '\u{0645}',
+ '\u{0641}',
+ '\u{062C}',
+ '\u{0641}',
+ '\u{062D}',
+ '\u{0641}',
+ '\u{062E}',
+ '\u{0641}',
+ '\u{0645}',
+ '\u{0641}',
+ '\u{0649}',
+ '\u{0641}',
+ '\u{064A}',
+ '\u{0642}',
+ '\u{062D}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{0642}',
+ '\u{0649}',
+ '\u{0642}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0627}',
+ '\u{0643}',
+ '\u{062C}',
+ '\u{0643}',
+ '\u{062D}',
+ '\u{0643}',
+ '\u{062E}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0643}',
+ '\u{0649}',
+ '\u{0643}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{0644}',
+ '\u{062E}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{0649}',
+ '\u{0644}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{0646}',
+ '\u{062D}',
+ '\u{0646}',
+ '\u{062E}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0649}',
+ '\u{0646}',
+ '\u{064A}',
+ '\u{0647}',
+ '\u{062C}',
+ '\u{0647}',
+ '\u{0645}',
+ '\u{0647}',
+ '\u{0649}',
+ '\u{0647}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{0630}',
+ '\u{0670}',
+ '\u{0631}',
+ '\u{0670}',
+ '\u{0649}',
+ '\u{0670}',
+ '\u{0020}',
+ '\u{064C}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{064D}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{064E}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{064F}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{0650}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{0651}',
+ '\u{0670}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0631}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0632}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0646}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{064A}',
+ '\u{0628}',
+ '\u{0631}',
+ '\u{0628}',
+ '\u{0632}',
+ '\u{0628}',
+ '\u{0645}',
+ '\u{0628}',
+ '\u{0646}',
+ '\u{0628}',
+ '\u{0649}',
+ '\u{0628}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{0631}',
+ '\u{062A}',
+ '\u{0632}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{0646}',
+ '\u{062A}',
+ '\u{0649}',
+ '\u{062A}',
+ '\u{064A}',
+ '\u{062B}',
+ '\u{0631}',
+ '\u{062B}',
+ '\u{0632}',
+ '\u{062B}',
+ '\u{0645}',
+ '\u{062B}',
+ '\u{0646}',
+ '\u{062B}',
+ '\u{0649}',
+ '\u{062B}',
+ '\u{064A}',
+ '\u{0641}',
+ '\u{0649}',
+ '\u{0641}',
+ '\u{064A}',
+ '\u{0642}',
+ '\u{0649}',
+ '\u{0642}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0627}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0643}',
+ '\u{0649}',
+ '\u{0643}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{0649}',
+ '\u{0644}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{0627}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0631}',
+ '\u{0646}',
+ '\u{0632}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0646}',
+ '\u{0646}',
+ '\u{0649}',
+ '\u{0646}',
+ '\u{064A}',
+ '\u{0649}',
+ '\u{0670}',
+ '\u{064A}',
+ '\u{0631}',
+ '\u{064A}',
+ '\u{0632}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{064A}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0647}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{0628}',
+ '\u{062D}',
+ '\u{0628}',
+ '\u{062E}',
+ '\u{0628}',
+ '\u{0645}',
+ '\u{0628}',
+ '\u{0647}',
+ '\u{062A}',
+ '\u{062C}',
+ '\u{062A}',
+ '\u{062D}',
+ '\u{062A}',
+ '\u{062E}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{0647}',
+ '\u{062B}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{062C}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{062C}',
+ '\u{0633}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{062E}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{0635}',
+ '\u{062D}',
+ '\u{0635}',
+ '\u{062E}',
+ '\u{0635}',
+ '\u{0645}',
+ '\u{0636}',
+ '\u{062C}',
+ '\u{0636}',
+ '\u{062D}',
+ '\u{0636}',
+ '\u{062E}',
+ '\u{0636}',
+ '\u{0645}',
+ '\u{0637}',
+ '\u{062D}',
+ '\u{0638}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{062C}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{063A}',
+ '\u{062C}',
+ '\u{063A}',
+ '\u{0645}',
+ '\u{0641}',
+ '\u{062C}',
+ '\u{0641}',
+ '\u{062D}',
+ '\u{0641}',
+ '\u{062E}',
+ '\u{0641}',
+ '\u{0645}',
+ '\u{0642}',
+ '\u{062D}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{0643}',
+ '\u{062C}',
+ '\u{0643}',
+ '\u{062D}',
+ '\u{0643}',
+ '\u{062E}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{0644}',
+ '\u{062E}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{0647}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{0646}',
+ '\u{062D}',
+ '\u{0646}',
+ '\u{062E}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0647}',
+ '\u{0647}',
+ '\u{062C}',
+ '\u{0647}',
+ '\u{0645}',
+ '\u{0647}',
+ '\u{0670}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0647}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0647}',
+ '\u{0628}',
+ '\u{0645}',
+ '\u{0628}',
+ '\u{0647}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{0647}',
+ '\u{062B}',
+ '\u{0645}',
+ '\u{062B}',
+ '\u{0647}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{0647}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{0647}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0647}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0647}',
+ '\u{0640}',
+ '\u{064E}',
+ '\u{0651}',
+ '\u{0640}',
+ '\u{064F}',
+ '\u{0651}',
+ '\u{0640}',
+ '\u{0650}',
+ '\u{0651}',
+ '\u{0637}',
+ '\u{0649}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0639}',
+ '\u{0649}',
+ '\u{0639}',
+ '\u{064A}',
+ '\u{063A}',
+ '\u{0649}',
+ '\u{063A}',
+ '\u{064A}',
+ '\u{0633}',
+ '\u{0649}',
+ '\u{0633}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{0649}',
+ '\u{0634}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{0649}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{062E}',
+ '\u{0649}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0635}',
+ '\u{0649}',
+ '\u{0635}',
+ '\u{064A}',
+ '\u{0636}',
+ '\u{0649}',
+ '\u{0636}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{062C}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0634}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{0631}',
+ '\u{0633}',
+ '\u{0631}',
+ '\u{0635}',
+ '\u{0631}',
+ '\u{0636}',
+ '\u{0631}',
+ '\u{0637}',
+ '\u{0649}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0639}',
+ '\u{0649}',
+ '\u{0639}',
+ '\u{064A}',
+ '\u{063A}',
+ '\u{0649}',
+ '\u{063A}',
+ '\u{064A}',
+ '\u{0633}',
+ '\u{0649}',
+ '\u{0633}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{0649}',
+ '\u{0634}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{0649}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{062E}',
+ '\u{0649}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0635}',
+ '\u{0649}',
+ '\u{0635}',
+ '\u{064A}',
+ '\u{0636}',
+ '\u{0649}',
+ '\u{0636}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{062C}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0634}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{0631}',
+ '\u{0633}',
+ '\u{0631}',
+ '\u{0635}',
+ '\u{0631}',
+ '\u{0636}',
+ '\u{0631}',
+ '\u{0634}',
+ '\u{062C}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0634}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{0647}',
+ '\u{0634}',
+ '\u{0647}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{062C}',
+ '\u{0633}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{062C}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0634}',
+ '\u{062E}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{0638}',
+ '\u{0645}',
+ '\u{0627}',
+ '\u{064B}',
+ '\u{0627}',
+ '\u{064B}',
+ '\u{062A}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{062A}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{062A}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{0633}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{0633}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{062C}',
+ '\u{0649}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0635}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{0635}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{0635}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0634}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0636}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{0636}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0636}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0637}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0639}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{063A}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{063A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{063A}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{0641}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0641}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{062E}',
+ '\u{0647}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0647}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{0649}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0628}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{062C}',
+ '\u{0649}',
+ '\u{062A}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{062E}',
+ '\u{0649}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{062A}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0649}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0649}',
+ '\u{0633}',
+ '\u{062E}',
+ '\u{0649}',
+ '\u{0635}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0634}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0636}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0642}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0644}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0644}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{062D}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0641}',
+ '\u{0645}',
+ '\u{064A}',
+ '\u{0628}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0639}',
+ '\u{062C}',
+ '\u{0645}',
+ '\u{0635}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0633}',
+ '\u{062E}',
+ '\u{064A}',
+ '\u{0646}',
+ '\u{062C}',
+ '\u{064A}',
+ '\u{0635}',
+ '\u{0644}',
+ '\u{06D2}',
+ '\u{0642}',
+ '\u{0644}',
+ '\u{06D2}',
+ '\u{0627}',
+ '\u{0644}',
+ '\u{0644}',
+ '\u{0647}',
+ '\u{0627}',
+ '\u{0643}',
+ '\u{0628}',
+ '\u{0631}',
+ '\u{0645}',
+ '\u{062D}',
+ '\u{0645}',
+ '\u{062F}',
+ '\u{0635}',
+ '\u{0644}',
+ '\u{0639}',
+ '\u{0645}',
+ '\u{0631}',
+ '\u{0633}',
+ '\u{0648}',
+ '\u{0644}',
+ '\u{0639}',
+ '\u{0644}',
+ '\u{064A}',
+ '\u{0647}',
+ '\u{0648}',
+ '\u{0633}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0635}',
+ '\u{0644}',
+ '\u{0649}',
+ '\u{0635}',
+ '\u{0644}',
+ '\u{0649}',
+ '\u{0020}',
+ '\u{0627}',
+ '\u{0644}',
+ '\u{0644}',
+ '\u{0647}',
+ '\u{0020}',
+ '\u{0639}',
+ '\u{0644}',
+ '\u{064A}',
+ '\u{0647}',
+ '\u{0020}',
+ '\u{0648}',
+ '\u{0633}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{0020}',
+ '\u{062C}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0644}',
+ '\u{0647}',
+ '\u{0631}',
+ '\u{06CC}',
+ '\u{0627}',
+ '\u{0644}',
+ '\u{002C}',
+ '\u{3001}',
+ '\u{3002}',
+ '\u{003A}',
+ '\u{003B}',
+ '\u{0021}',
+ '\u{003F}',
+ '\u{3016}',
+ '\u{3017}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{002E}',
+ '\u{2014}',
+ '\u{2013}',
+ '\u{005F}',
+ '\u{005F}',
+ '\u{0028}',
+ '\u{0029}',
+ '\u{007B}',
+ '\u{007D}',
+ '\u{3014}',
+ '\u{3015}',
+ '\u{3010}',
+ '\u{3011}',
+ '\u{300A}',
+ '\u{300B}',
+ '\u{3008}',
+ '\u{3009}',
+ '\u{300C}',
+ '\u{300D}',
+ '\u{300E}',
+ '\u{300F}',
+ '\u{005B}',
+ '\u{005D}',
+ '\u{0020}',
+ '\u{0305}',
+ '\u{0020}',
+ '\u{0305}',
+ '\u{0020}',
+ '\u{0305}',
+ '\u{0020}',
+ '\u{0305}',
+ '\u{005F}',
+ '\u{005F}',
+ '\u{005F}',
+ '\u{002C}',
+ '\u{3001}',
+ '\u{002E}',
+ '\u{003B}',
+ '\u{003A}',
+ '\u{003F}',
+ '\u{0021}',
+ '\u{2014}',
+ '\u{0028}',
+ '\u{0029}',
+ '\u{007B}',
+ '\u{007D}',
+ '\u{3014}',
+ '\u{3015}',
+ '\u{0023}',
+ '\u{0026}',
+ '\u{002A}',
+ '\u{002B}',
+ '\u{002D}',
+ '\u{003C}',
+ '\u{003E}',
+ '\u{003D}',
+ '\u{005C}',
+ '\u{0024}',
+ '\u{0025}',
+ '\u{0040}',
+ '\u{0020}',
+ '\u{064B}',
+ '\u{0640}',
+ '\u{064B}',
+ '\u{0020}',
+ '\u{064C}',
+ '\u{0020}',
+ '\u{064D}',
+ '\u{0020}',
+ '\u{064E}',
+ '\u{0640}',
+ '\u{064E}',
+ '\u{0020}',
+ '\u{064F}',
+ '\u{0640}',
+ '\u{064F}',
+ '\u{0020}',
+ '\u{0650}',
+ '\u{0640}',
+ '\u{0650}',
+ '\u{0020}',
+ '\u{0651}',
+ '\u{0640}',
+ '\u{0651}',
+ '\u{0020}',
+ '\u{0652}',
+ '\u{0640}',
+ '\u{0652}',
+ '\u{0621}',
+ '\u{0627}',
+ '\u{0653}',
+ '\u{0627}',
+ '\u{0653}',
+ '\u{0627}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{0654}',
+ '\u{0648}',
+ '\u{0654}',
+ '\u{0648}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{0655}',
+ '\u{0627}',
+ '\u{0655}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{064A}',
+ '\u{0654}',
+ '\u{0627}',
+ '\u{0627}',
+ '\u{0628}',
+ '\u{0628}',
+ '\u{0628}',
+ '\u{0628}',
+ '\u{0629}',
+ '\u{0629}',
+ '\u{062A}',
+ '\u{062A}',
+ '\u{062A}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062B}',
+ '\u{062B}',
+ '\u{062B}',
+ '\u{062C}',
+ '\u{062C}',
+ '\u{062C}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{062D}',
+ '\u{062E}',
+ '\u{062E}',
+ '\u{062E}',
+ '\u{062E}',
+ '\u{062F}',
+ '\u{062F}',
+ '\u{0630}',
+ '\u{0630}',
+ '\u{0631}',
+ '\u{0631}',
+ '\u{0632}',
+ '\u{0632}',
+ '\u{0633}',
+ '\u{0633}',
+ '\u{0633}',
+ '\u{0633}',
+ '\u{0634}',
+ '\u{0634}',
+ '\u{0634}',
+ '\u{0634}',
+ '\u{0635}',
+ '\u{0635}',
+ '\u{0635}',
+ '\u{0635}',
+ '\u{0636}',
+ '\u{0636}',
+ '\u{0636}',
+ '\u{0636}',
+ '\u{0637}',
+ '\u{0637}',
+ '\u{0637}',
+ '\u{0637}',
+ '\u{0638}',
+ '\u{0638}',
+ '\u{0638}',
+ '\u{0638}',
+ '\u{0639}',
+ '\u{0639}',
+ '\u{0639}',
+ '\u{0639}',
+ '\u{063A}',
+ '\u{063A}',
+ '\u{063A}',
+ '\u{063A}',
+ '\u{0641}',
+ '\u{0641}',
+ '\u{0641}',
+ '\u{0641}',
+ '\u{0642}',
+ '\u{0642}',
+ '\u{0642}',
+ '\u{0642}',
+ '\u{0643}',
+ '\u{0643}',
+ '\u{0643}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0644}',
+ '\u{0644}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0646}',
+ '\u{0646}',
+ '\u{0646}',
+ '\u{0647}',
+ '\u{0647}',
+ '\u{0647}',
+ '\u{0647}',
+ '\u{0648}',
+ '\u{0648}',
+ '\u{0649}',
+ '\u{0649}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0653}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0653}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0654}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0654}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0655}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0655}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0644}',
+ '\u{0627}',
+ '\u{0021}',
+ '\u{0022}',
+ '\u{0023}',
+ '\u{0024}',
+ '\u{0025}',
+ '\u{0026}',
+ '\u{0027}',
+ '\u{0028}',
+ '\u{0029}',
+ '\u{002A}',
+ '\u{002B}',
+ '\u{002C}',
+ '\u{002D}',
+ '\u{002E}',
+ '\u{002F}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{003A}',
+ '\u{003B}',
+ '\u{003C}',
+ '\u{003D}',
+ '\u{003E}',
+ '\u{003F}',
+ '\u{0040}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{005B}',
+ '\u{005C}',
+ '\u{005D}',
+ '\u{005E}',
+ '\u{005F}',
+ '\u{0060}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{007B}',
+ '\u{007C}',
+ '\u{007D}',
+ '\u{007E}',
+ '\u{2985}',
+ '\u{2986}',
+ '\u{3002}',
+ '\u{300C}',
+ '\u{300D}',
+ '\u{3001}',
+ '\u{30FB}',
+ '\u{30F2}',
+ '\u{30A1}',
+ '\u{30A3}',
+ '\u{30A5}',
+ '\u{30A7}',
+ '\u{30A9}',
+ '\u{30E3}',
+ '\u{30E5}',
+ '\u{30E7}',
+ '\u{30C3}',
+ '\u{30FC}',
+ '\u{30A2}',
+ '\u{30A4}',
+ '\u{30A6}',
+ '\u{30A8}',
+ '\u{30AA}',
+ '\u{30AB}',
+ '\u{30AD}',
+ '\u{30AF}',
+ '\u{30B1}',
+ '\u{30B3}',
+ '\u{30B5}',
+ '\u{30B7}',
+ '\u{30B9}',
+ '\u{30BB}',
+ '\u{30BD}',
+ '\u{30BF}',
+ '\u{30C1}',
+ '\u{30C4}',
+ '\u{30C6}',
+ '\u{30C8}',
+ '\u{30CA}',
+ '\u{30CB}',
+ '\u{30CC}',
+ '\u{30CD}',
+ '\u{30CE}',
+ '\u{30CF}',
+ '\u{30D2}',
+ '\u{30D5}',
+ '\u{30D8}',
+ '\u{30DB}',
+ '\u{30DE}',
+ '\u{30DF}',
+ '\u{30E0}',
+ '\u{30E1}',
+ '\u{30E2}',
+ '\u{30E4}',
+ '\u{30E6}',
+ '\u{30E8}',
+ '\u{30E9}',
+ '\u{30EA}',
+ '\u{30EB}',
+ '\u{30EC}',
+ '\u{30ED}',
+ '\u{30EF}',
+ '\u{30F3}',
+ '\u{3099}',
+ '\u{309A}',
+ '\u{1160}',
+ '\u{1100}',
+ '\u{1101}',
+ '\u{11AA}',
+ '\u{1102}',
+ '\u{11AC}',
+ '\u{11AD}',
+ '\u{1103}',
+ '\u{1104}',
+ '\u{1105}',
+ '\u{11B0}',
+ '\u{11B1}',
+ '\u{11B2}',
+ '\u{11B3}',
+ '\u{11B4}',
+ '\u{11B5}',
+ '\u{111A}',
+ '\u{1106}',
+ '\u{1107}',
+ '\u{1108}',
+ '\u{1121}',
+ '\u{1109}',
+ '\u{110A}',
+ '\u{110B}',
+ '\u{110C}',
+ '\u{110D}',
+ '\u{110E}',
+ '\u{110F}',
+ '\u{1110}',
+ '\u{1111}',
+ '\u{1112}',
+ '\u{1161}',
+ '\u{1162}',
+ '\u{1163}',
+ '\u{1164}',
+ '\u{1165}',
+ '\u{1166}',
+ '\u{1167}',
+ '\u{1168}',
+ '\u{1169}',
+ '\u{116A}',
+ '\u{116B}',
+ '\u{116C}',
+ '\u{116D}',
+ '\u{116E}',
+ '\u{116F}',
+ '\u{1170}',
+ '\u{1171}',
+ '\u{1172}',
+ '\u{1173}',
+ '\u{1174}',
+ '\u{1175}',
+ '\u{00A2}',
+ '\u{00A3}',
+ '\u{00AC}',
+ '\u{0020}',
+ '\u{0304}',
+ '\u{00A6}',
+ '\u{00A5}',
+ '\u{20A9}',
+ '\u{2502}',
+ '\u{2190}',
+ '\u{2191}',
+ '\u{2192}',
+ '\u{2193}',
+ '\u{25A0}',
+ '\u{25CB}',
+ '\u{02D0}',
+ '\u{02D1}',
+ '\u{00E6}',
+ '\u{0299}',
+ '\u{0253}',
+ '\u{02A3}',
+ '\u{AB66}',
+ '\u{02A5}',
+ '\u{02A4}',
+ '\u{0256}',
+ '\u{0257}',
+ '\u{1D91}',
+ '\u{0258}',
+ '\u{025E}',
+ '\u{02A9}',
+ '\u{0264}',
+ '\u{0262}',
+ '\u{0260}',
+ '\u{029B}',
+ '\u{0127}',
+ '\u{029C}',
+ '\u{0267}',
+ '\u{0284}',
+ '\u{02AA}',
+ '\u{02AB}',
+ '\u{026C}',
+ '\u{1DF04}',
+ '\u{A78E}',
+ '\u{026E}',
+ '\u{1DF05}',
+ '\u{028E}',
+ '\u{1DF06}',
+ '\u{00F8}',
+ '\u{0276}',
+ '\u{0277}',
+ '\u{0071}',
+ '\u{027A}',
+ '\u{1DF08}',
+ '\u{027D}',
+ '\u{027E}',
+ '\u{0280}',
+ '\u{02A8}',
+ '\u{02A6}',
+ '\u{AB67}',
+ '\u{02A7}',
+ '\u{0288}',
+ '\u{2C71}',
+ '\u{028F}',
+ '\u{02A1}',
+ '\u{02A2}',
+ '\u{0298}',
+ '\u{01C0}',
+ '\u{01C1}',
+ '\u{01C2}',
+ '\u{1DF0A}',
+ '\u{1DF1E}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0047}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0066}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004F}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0061}',
+ '\u{0062}',
+ '\u{0063}',
+ '\u{0064}',
+ '\u{0065}',
+ '\u{0066}',
+ '\u{0067}',
+ '\u{0068}',
+ '\u{0069}',
+ '\u{006A}',
+ '\u{006B}',
+ '\u{006C}',
+ '\u{006D}',
+ '\u{006E}',
+ '\u{006F}',
+ '\u{0070}',
+ '\u{0071}',
+ '\u{0072}',
+ '\u{0073}',
+ '\u{0074}',
+ '\u{0075}',
+ '\u{0076}',
+ '\u{0077}',
+ '\u{0078}',
+ '\u{0079}',
+ '\u{007A}',
+ '\u{0131}',
+ '\u{0237}',
+ '\u{0391}',
+ '\u{0392}',
+ '\u{0393}',
+ '\u{0394}',
+ '\u{0395}',
+ '\u{0396}',
+ '\u{0397}',
+ '\u{0398}',
+ '\u{0399}',
+ '\u{039A}',
+ '\u{039B}',
+ '\u{039C}',
+ '\u{039D}',
+ '\u{039E}',
+ '\u{039F}',
+ '\u{03A0}',
+ '\u{03A1}',
+ '\u{0398}',
+ '\u{03A3}',
+ '\u{03A4}',
+ '\u{03A5}',
+ '\u{03A6}',
+ '\u{03A7}',
+ '\u{03A8}',
+ '\u{03A9}',
+ '\u{2207}',
+ '\u{03B1}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03B5}',
+ '\u{03B6}',
+ '\u{03B7}',
+ '\u{03B8}',
+ '\u{03B9}',
+ '\u{03BA}',
+ '\u{03BB}',
+ '\u{03BC}',
+ '\u{03BD}',
+ '\u{03BE}',
+ '\u{03BF}',
+ '\u{03C0}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{03C3}',
+ '\u{03C4}',
+ '\u{03C5}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{03C8}',
+ '\u{03C9}',
+ '\u{2202}',
+ '\u{03B5}',
+ '\u{03B8}',
+ '\u{03BA}',
+ '\u{03C6}',
+ '\u{03C1}',
+ '\u{03C0}',
+ '\u{0391}',
+ '\u{0392}',
+ '\u{0393}',
+ '\u{0394}',
+ '\u{0395}',
+ '\u{0396}',
+ '\u{0397}',
+ '\u{0398}',
+ '\u{0399}',
+ '\u{039A}',
+ '\u{039B}',
+ '\u{039C}',
+ '\u{039D}',
+ '\u{039E}',
+ '\u{039F}',
+ '\u{03A0}',
+ '\u{03A1}',
+ '\u{0398}',
+ '\u{03A3}',
+ '\u{03A4}',
+ '\u{03A5}',
+ '\u{03A6}',
+ '\u{03A7}',
+ '\u{03A8}',
+ '\u{03A9}',
+ '\u{2207}',
+ '\u{03B1}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03B5}',
+ '\u{03B6}',
+ '\u{03B7}',
+ '\u{03B8}',
+ '\u{03B9}',
+ '\u{03BA}',
+ '\u{03BB}',
+ '\u{03BC}',
+ '\u{03BD}',
+ '\u{03BE}',
+ '\u{03BF}',
+ '\u{03C0}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{03C3}',
+ '\u{03C4}',
+ '\u{03C5}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{03C8}',
+ '\u{03C9}',
+ '\u{2202}',
+ '\u{03B5}',
+ '\u{03B8}',
+ '\u{03BA}',
+ '\u{03C6}',
+ '\u{03C1}',
+ '\u{03C0}',
+ '\u{0391}',
+ '\u{0392}',
+ '\u{0393}',
+ '\u{0394}',
+ '\u{0395}',
+ '\u{0396}',
+ '\u{0397}',
+ '\u{0398}',
+ '\u{0399}',
+ '\u{039A}',
+ '\u{039B}',
+ '\u{039C}',
+ '\u{039D}',
+ '\u{039E}',
+ '\u{039F}',
+ '\u{03A0}',
+ '\u{03A1}',
+ '\u{0398}',
+ '\u{03A3}',
+ '\u{03A4}',
+ '\u{03A5}',
+ '\u{03A6}',
+ '\u{03A7}',
+ '\u{03A8}',
+ '\u{03A9}',
+ '\u{2207}',
+ '\u{03B1}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03B5}',
+ '\u{03B6}',
+ '\u{03B7}',
+ '\u{03B8}',
+ '\u{03B9}',
+ '\u{03BA}',
+ '\u{03BB}',
+ '\u{03BC}',
+ '\u{03BD}',
+ '\u{03BE}',
+ '\u{03BF}',
+ '\u{03C0}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{03C3}',
+ '\u{03C4}',
+ '\u{03C5}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{03C8}',
+ '\u{03C9}',
+ '\u{2202}',
+ '\u{03B5}',
+ '\u{03B8}',
+ '\u{03BA}',
+ '\u{03C6}',
+ '\u{03C1}',
+ '\u{03C0}',
+ '\u{0391}',
+ '\u{0392}',
+ '\u{0393}',
+ '\u{0394}',
+ '\u{0395}',
+ '\u{0396}',
+ '\u{0397}',
+ '\u{0398}',
+ '\u{0399}',
+ '\u{039A}',
+ '\u{039B}',
+ '\u{039C}',
+ '\u{039D}',
+ '\u{039E}',
+ '\u{039F}',
+ '\u{03A0}',
+ '\u{03A1}',
+ '\u{0398}',
+ '\u{03A3}',
+ '\u{03A4}',
+ '\u{03A5}',
+ '\u{03A6}',
+ '\u{03A7}',
+ '\u{03A8}',
+ '\u{03A9}',
+ '\u{2207}',
+ '\u{03B1}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03B5}',
+ '\u{03B6}',
+ '\u{03B7}',
+ '\u{03B8}',
+ '\u{03B9}',
+ '\u{03BA}',
+ '\u{03BB}',
+ '\u{03BC}',
+ '\u{03BD}',
+ '\u{03BE}',
+ '\u{03BF}',
+ '\u{03C0}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{03C3}',
+ '\u{03C4}',
+ '\u{03C5}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{03C8}',
+ '\u{03C9}',
+ '\u{2202}',
+ '\u{03B5}',
+ '\u{03B8}',
+ '\u{03BA}',
+ '\u{03C6}',
+ '\u{03C1}',
+ '\u{03C0}',
+ '\u{0391}',
+ '\u{0392}',
+ '\u{0393}',
+ '\u{0394}',
+ '\u{0395}',
+ '\u{0396}',
+ '\u{0397}',
+ '\u{0398}',
+ '\u{0399}',
+ '\u{039A}',
+ '\u{039B}',
+ '\u{039C}',
+ '\u{039D}',
+ '\u{039E}',
+ '\u{039F}',
+ '\u{03A0}',
+ '\u{03A1}',
+ '\u{0398}',
+ '\u{03A3}',
+ '\u{03A4}',
+ '\u{03A5}',
+ '\u{03A6}',
+ '\u{03A7}',
+ '\u{03A8}',
+ '\u{03A9}',
+ '\u{2207}',
+ '\u{03B1}',
+ '\u{03B2}',
+ '\u{03B3}',
+ '\u{03B4}',
+ '\u{03B5}',
+ '\u{03B6}',
+ '\u{03B7}',
+ '\u{03B8}',
+ '\u{03B9}',
+ '\u{03BA}',
+ '\u{03BB}',
+ '\u{03BC}',
+ '\u{03BD}',
+ '\u{03BE}',
+ '\u{03BF}',
+ '\u{03C0}',
+ '\u{03C1}',
+ '\u{03C2}',
+ '\u{03C3}',
+ '\u{03C4}',
+ '\u{03C5}',
+ '\u{03C6}',
+ '\u{03C7}',
+ '\u{03C8}',
+ '\u{03C9}',
+ '\u{2202}',
+ '\u{03B5}',
+ '\u{03B8}',
+ '\u{03BA}',
+ '\u{03C6}',
+ '\u{03C1}',
+ '\u{03C0}',
+ '\u{03DC}',
+ '\u{03DD}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+ '\u{0430}',
+ '\u{0431}',
+ '\u{0432}',
+ '\u{0433}',
+ '\u{0434}',
+ '\u{0435}',
+ '\u{0436}',
+ '\u{0437}',
+ '\u{0438}',
+ '\u{043A}',
+ '\u{043B}',
+ '\u{043C}',
+ '\u{043E}',
+ '\u{043F}',
+ '\u{0440}',
+ '\u{0441}',
+ '\u{0442}',
+ '\u{0443}',
+ '\u{0444}',
+ '\u{0445}',
+ '\u{0446}',
+ '\u{0447}',
+ '\u{0448}',
+ '\u{044B}',
+ '\u{044D}',
+ '\u{044E}',
+ '\u{A689}',
+ '\u{04D9}',
+ '\u{0456}',
+ '\u{0458}',
+ '\u{04E9}',
+ '\u{04AF}',
+ '\u{04CF}',
+ '\u{0430}',
+ '\u{0431}',
+ '\u{0432}',
+ '\u{0433}',
+ '\u{0434}',
+ '\u{0435}',
+ '\u{0436}',
+ '\u{0437}',
+ '\u{0438}',
+ '\u{043A}',
+ '\u{043B}',
+ '\u{043E}',
+ '\u{043F}',
+ '\u{0441}',
+ '\u{0443}',
+ '\u{0444}',
+ '\u{0445}',
+ '\u{0446}',
+ '\u{0447}',
+ '\u{0448}',
+ '\u{044A}',
+ '\u{044B}',
+ '\u{0491}',
+ '\u{0456}',
+ '\u{0455}',
+ '\u{045F}',
+ '\u{04AB}',
+ '\u{A651}',
+ '\u{04B1}',
+ '\u{0627}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{062F}',
+ '\u{0648}',
+ '\u{0632}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0641}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0631}',
+ '\u{0634}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062E}',
+ '\u{0630}',
+ '\u{0636}',
+ '\u{0638}',
+ '\u{063A}',
+ '\u{066E}',
+ '\u{06BA}',
+ '\u{06A1}',
+ '\u{066F}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{0647}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0641}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0634}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062E}',
+ '\u{0636}',
+ '\u{063A}',
+ '\u{062C}',
+ '\u{062D}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0634}',
+ '\u{062E}',
+ '\u{0636}',
+ '\u{063A}',
+ '\u{06BA}',
+ '\u{066F}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{0647}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0643}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0641}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0634}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062E}',
+ '\u{0636}',
+ '\u{0638}',
+ '\u{063A}',
+ '\u{066E}',
+ '\u{06A1}',
+ '\u{0627}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{062F}',
+ '\u{0647}',
+ '\u{0648}',
+ '\u{0632}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0641}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0631}',
+ '\u{0634}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062E}',
+ '\u{0630}',
+ '\u{0636}',
+ '\u{0638}',
+ '\u{063A}',
+ '\u{0628}',
+ '\u{062C}',
+ '\u{062F}',
+ '\u{0648}',
+ '\u{0632}',
+ '\u{062D}',
+ '\u{0637}',
+ '\u{064A}',
+ '\u{0644}',
+ '\u{0645}',
+ '\u{0646}',
+ '\u{0633}',
+ '\u{0639}',
+ '\u{0641}',
+ '\u{0635}',
+ '\u{0642}',
+ '\u{0631}',
+ '\u{0634}',
+ '\u{062A}',
+ '\u{062B}',
+ '\u{062E}',
+ '\u{0630}',
+ '\u{0636}',
+ '\u{0638}',
+ '\u{063A}',
+ '\u{0030}',
+ '\u{002E}',
+ '\u{0030}',
+ '\u{002C}',
+ '\u{0031}',
+ '\u{002C}',
+ '\u{0032}',
+ '\u{002C}',
+ '\u{0033}',
+ '\u{002C}',
+ '\u{0034}',
+ '\u{002C}',
+ '\u{0035}',
+ '\u{002C}',
+ '\u{0036}',
+ '\u{002C}',
+ '\u{0037}',
+ '\u{002C}',
+ '\u{0038}',
+ '\u{002C}',
+ '\u{0039}',
+ '\u{002C}',
+ '\u{0028}',
+ '\u{0041}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0042}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0043}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0044}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0045}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0046}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0047}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0048}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0049}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004A}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004B}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004C}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004D}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004E}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{004F}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0050}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0051}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0052}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0053}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0054}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0055}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0056}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0057}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0058}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{0059}',
+ '\u{0029}',
+ '\u{0028}',
+ '\u{005A}',
+ '\u{0029}',
+ '\u{3014}',
+ '\u{0053}',
+ '\u{3015}',
+ '\u{0043}',
+ '\u{0052}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0057}',
+ '\u{005A}',
+ '\u{0041}',
+ '\u{0042}',
+ '\u{0043}',
+ '\u{0044}',
+ '\u{0045}',
+ '\u{0046}',
+ '\u{0047}',
+ '\u{0048}',
+ '\u{0049}',
+ '\u{004A}',
+ '\u{004B}',
+ '\u{004C}',
+ '\u{004D}',
+ '\u{004E}',
+ '\u{004F}',
+ '\u{0050}',
+ '\u{0051}',
+ '\u{0052}',
+ '\u{0053}',
+ '\u{0054}',
+ '\u{0055}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0058}',
+ '\u{0059}',
+ '\u{005A}',
+ '\u{0048}',
+ '\u{0056}',
+ '\u{004D}',
+ '\u{0056}',
+ '\u{0053}',
+ '\u{0044}',
+ '\u{0053}',
+ '\u{0053}',
+ '\u{0050}',
+ '\u{0050}',
+ '\u{0056}',
+ '\u{0057}',
+ '\u{0043}',
+ '\u{004D}',
+ '\u{0043}',
+ '\u{004D}',
+ '\u{0044}',
+ '\u{004D}',
+ '\u{0052}',
+ '\u{0044}',
+ '\u{004A}',
+ '\u{307B}',
+ '\u{304B}',
+ '\u{30B3}',
+ '\u{30B3}',
+ '\u{30B5}',
+ '\u{624B}',
+ '\u{5B57}',
+ '\u{53CC}',
+ '\u{30C6}',
+ '\u{3099}',
+ '\u{4E8C}',
+ '\u{591A}',
+ '\u{89E3}',
+ '\u{5929}',
+ '\u{4EA4}',
+ '\u{6620}',
+ '\u{7121}',
+ '\u{6599}',
+ '\u{524D}',
+ '\u{5F8C}',
+ '\u{518D}',
+ '\u{65B0}',
+ '\u{521D}',
+ '\u{7D42}',
+ '\u{751F}',
+ '\u{8CA9}',
+ '\u{58F0}',
+ '\u{5439}',
+ '\u{6F14}',
+ '\u{6295}',
+ '\u{6355}',
+ '\u{4E00}',
+ '\u{4E09}',
+ '\u{904A}',
+ '\u{5DE6}',
+ '\u{4E2D}',
+ '\u{53F3}',
+ '\u{6307}',
+ '\u{8D70}',
+ '\u{6253}',
+ '\u{7981}',
+ '\u{7A7A}',
+ '\u{5408}',
+ '\u{6E80}',
+ '\u{6709}',
+ '\u{6708}',
+ '\u{7533}',
+ '\u{5272}',
+ '\u{55B6}',
+ '\u{914D}',
+ '\u{3014}',
+ '\u{672C}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{4E09}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{4E8C}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{5B89}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{70B9}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{6253}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{76D7}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{52DD}',
+ '\u{3015}',
+ '\u{3014}',
+ '\u{6557}',
+ '\u{3015}',
+ '\u{5F97}',
+ '\u{53EF}',
+ '\u{0030}',
+ '\u{0031}',
+ '\u{0032}',
+ '\u{0033}',
+ '\u{0034}',
+ '\u{0035}',
+ '\u{0036}',
+ '\u{0037}',
+ '\u{0038}',
+ '\u{0039}',
+];
+pub(crate) const COMPATIBILITY_DECOMPOSED_SALT: &[u16] = &[
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x16c,
+ 0xe,
+ 0x4ef,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x97,
+ 0x165,
+ 0x0,
+ 0x0,
+ 0x185,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3f4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x91,
+ 0x0,
+ 0xdd,
+ 0x1,
+ 0x26c,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0xe0,
+ 0xbc,
+ 0x3,
+ 0x213,
+ 0x1,
+ 0x0,
+ 0xc8,
+ 0x3,
+ 0x1c,
+ 0xfc,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x132,
+ 0x0,
+ 0x0,
+ 0x10b,
+ 0x90,
+ 0x474,
+ 0xd6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xd,
+ 0x5,
+ 0x0,
+ 0x6,
+ 0x19,
+ 0x54,
+ 0x132,
+ 0x4c,
+ 0x17,
+ 0x6,
+ 0x48,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0xc,
+ 0x3,
+ 0x0,
+ 0xb1,
+ 0x1,
+ 0x8c,
+ 0x0,
+ 0x1b,
+ 0xc0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x1be,
+ 0xc8,
+ 0x0,
+ 0x7d,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0xb4,
+ 0x2,
+ 0x8,
+ 0x5,
+ 0x144,
+ 0xdb,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x14,
+ 0x0,
+ 0x4f,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x32,
+ 0x0,
+ 0x5,
+ 0xe,
+ 0x7c,
+ 0x2c,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x5f,
+ 0x5,
+ 0xf,
+ 0x67,
+ 0x0,
+ 0x1,
+ 0x34,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x90,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x1e,
+ 0x4c,
+ 0x89,
+ 0xa8,
+ 0x0,
+ 0x4,
+ 0x1f,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x99,
+ 0x18,
+ 0xd,
+ 0x3,
+ 0x7,
+ 0x5,
+ 0x19,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x3,
+ 0x90,
+ 0xb,
+ 0x29,
+ 0x55,
+ 0x0,
+ 0x51,
+ 0x0,
+ 0x2,
+ 0xd0,
+ 0x7a,
+ 0x66,
+ 0x0,
+ 0x95,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x8d,
+ 0xf,
+ 0x21,
+ 0x56,
+ 0xa,
+ 0x1b,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x7,
+ 0x7c,
+ 0x5,
+ 0x0,
+ 0x62,
+ 0x2,
+ 0x13,
+ 0x6,
+ 0x0,
+ 0x4f,
+ 0x0,
+ 0x0,
+ 0x32,
+ 0x2f,
+ 0x4,
+ 0xd,
+ 0xa0,
+ 0x4,
+ 0x8,
+ 0x24,
+ 0x1f,
+ 0x0,
+ 0x0,
+ 0x82,
+ 0x45,
+ 0x0,
+ 0x61,
+ 0x0,
+ 0x1d,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x17,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x8,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x3d,
+ 0x0,
+ 0x96,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x2c,
+ 0x0,
+ 0x0,
+ 0x14,
+ 0x24,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x12,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x25,
+ 0xa,
+ 0x1,
+ 0x66,
+ 0xb,
+ 0x8,
+ 0x0,
+ 0xc,
+ 0x10,
+ 0x2,
+ 0x3,
+ 0x8,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x4,
+ 0xe3,
+ 0x23,
+ 0x20,
+ 0x7,
+ 0x0,
+ 0xf,
+ 0x1e,
+ 0x23,
+ 0x3d,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x25,
+ 0x0,
+ 0x1,
+ 0x31,
+ 0x9d,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x26,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1b,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0xc,
+ 0xc,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x11,
+ 0x4,
+ 0x3d,
+ 0x2,
+ 0x1b,
+ 0x2,
+ 0x0,
+ 0xc,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x2c,
+ 0x0,
+ 0x9,
+ 0x37,
+ 0x2d,
+ 0x0,
+ 0x12,
+ 0x23,
+ 0x0,
+ 0x0,
+ 0x1c,
+ 0x0,
+ 0x26,
+ 0x10,
+ 0x15,
+ 0x2,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0x14,
+ 0x5,
+ 0x13,
+ 0x7,
+ 0x1c,
+ 0x3,
+ 0x36,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x19,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x8,
+ 0x2,
+ 0xa,
+ 0x6,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2f,
+ 0x1,
+ 0x0,
+ 0x16,
+ 0x5,
+ 0xc,
+ 0xc,
+ 0x1,
+ 0x10,
+ 0x3,
+ 0xe,
+ 0x0,
+ 0x1,
+ 0xd,
+ 0x28,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x10,
+ 0x21,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x23,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6b,
+ 0x0,
+ 0x14,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x12,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2a,
+ 0x1,
+ 0xb,
+ 0x1,
+ 0x6,
+ 0x9,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x2b,
+ 0x0,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0xf,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x44,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x19,
+ 0x25,
+ 0x2,
+ 0x1f,
+ 0xf,
+ 0xc,
+ 0x1,
+ 0x1f,
+ 0xa,
+ 0x0,
+ 0x38,
+ 0xe,
+ 0xf,
+ 0xc,
+ 0x25,
+ 0x0,
+ 0x6,
+ 0xe,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x15,
+ 0x62,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3d,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x29,
+ 0x4,
+ 0x2c,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x22,
+ 0x0,
+ 0x14,
+ 0x28,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0xd,
+ 0x2a,
+ 0x0,
+ 0x0,
+ 0x44,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1c,
+ 0x5,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x11,
+ 0x6,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x28,
+ 0x7,
+ 0x1d,
+ 0xb,
+ 0x5,
+ 0x2e,
+ 0x11,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x7,
+ 0x2f,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0xa,
+ 0x0,
+ 0x8,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x8,
+ 0x20,
+ 0xc,
+ 0x0,
+ 0x1a,
+ 0x5,
+ 0x0,
+ 0x26,
+ 0x26,
+ 0x2,
+ 0xb,
+ 0x8,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x12,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x9,
+ 0x1,
+ 0x3,
+ 0x15,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x16,
+ 0x0,
+ 0x10,
+ 0x3,
+ 0x0,
+ 0x1b,
+ 0x2,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0xc,
+ 0x26,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0xc,
+ 0x1e,
+ 0x0,
+ 0x1,
+ 0x36,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x2,
+ 0x7,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x8,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x10,
+ 0xb,
+ 0x7,
+ 0x0,
+ 0xf,
+ 0x11,
+ 0x0,
+ 0x18,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x18,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x26,
+ 0x3,
+ 0x0,
+ 0x1b,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0xb,
+ 0x1b,
+ 0x9,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x9,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0xe,
+ 0x23,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x8,
+ 0x22,
+ 0xe,
+ 0x10,
+ 0x7,
+ 0x3,
+ 0xc,
+ 0x19,
+ 0x1,
+ 0xa,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x18,
+ 0x1,
+ 0x16,
+ 0xa,
+ 0x0,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x23,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0xd,
+ 0x1b,
+ 0x0,
+ 0x4,
+ 0x38,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x21,
+ 0x13,
+ 0x2,
+ 0x18,
+ 0x4,
+ 0x1,
+ 0x10,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x14,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x20,
+ 0x1d,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x24,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x13,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x9,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x14,
+ 0x7,
+ 0xa,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x14,
+ 0x1,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x19,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0x8,
+ 0xd,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x14,
+ 0x17,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x15,
+ 0x1,
+ 0x19,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x11,
+ 0x5,
+ 0x0,
+ 0x4,
+ 0xc,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x3,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x8,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xd,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x9,
+ 0xa,
+ 0x8,
+ 0x1,
+ 0x7,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x13,
+ 0x6,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x7,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1b,
+ 0x3,
+ 0x2,
+ 0x9,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0xf,
+ 0x1,
+ 0x6,
+ 0x8,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xb,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x13,
+ 0x13,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x21,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x10,
+ 0x22,
+ 0xb,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x1a,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x12,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x21,
+ 0x0,
+ 0x2,
+ 0xd,
+ 0x1,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0xc,
+ 0x10,
+ 0x0,
+ 0x24,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6,
+ 0x1b,
+ 0x1,
+ 0xd,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x24,
+ 0x6,
+ 0x1,
+ 0xe,
+ 0x0,
+ 0xb,
+ 0xe,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x18,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x14,
+ 0x6,
+ 0xb,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x7,
+ 0x11,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x2,
+ 0x2,
+ 0x8,
+ 0x6,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x8,
+ 0x1,
+ 0x7,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0xe,
+ 0x2,
+ 0x2,
+ 0x32,
+ 0x7,
+ 0xb,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x1b,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0xf,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xe,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x11,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x20,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x12,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0xf,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x2,
+ 0x12,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x17,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x7,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x8,
+ 0x1,
+ 0xd,
+ 0xb,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x11,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x17,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0xb,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x6,
+ 0x1d,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x9,
+ 0x2,
+ 0xf,
+ 0x14,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x13,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x1,
+ 0x6,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xd,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0xa,
+ 0x0,
+ 0xb,
+ 0x1,
+ 0x6,
+ 0x22,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x12,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x8,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0xa,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xe,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x17,
+ 0x4,
+ 0x0,
+ 0xb,
+ 0x3,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0xf,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0xd,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0x2,
+ 0xa,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x9,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0xa,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x7,
+ 0x9,
+ 0x0,
+ 0x10,
+ 0x1c,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0xd,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x7,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x8,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0xa,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x13,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0xe,
+ 0x1,
+ 0xc,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0xc,
+ 0xc,
+ 0x3,
+ 0x0,
+ 0xc,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0xa,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x1c,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0xf,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0xb,
+ 0x4,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0xd,
+ 0x4,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x13,
+ 0x6,
+ 0x0,
+ 0x7,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x5,
+ 0x10,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0xa,
+ 0x11,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x10,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0xb,
+ 0xb,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x5,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0xb,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0xc,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x18,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x14,
+ 0x4,
+ 0xb,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0xb,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x10,
+ 0xd,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x4,
+ 0x2,
+ 0x6,
+ 0x9,
+ 0x5,
+ 0x0,
+ 0x16,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0xb,
+ 0x6,
+ 0xa,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x19,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x7,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x6,
+ 0x9,
+ 0x0,
+ 0x2,
+ 0x1b,
+ 0x2,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0xb,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x5,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xb,
+ 0x3,
+ 0x2,
+ 0x13,
+ 0x1,
+ 0x1,
+ 0x8,
+ 0x3,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0xe,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x9,
+ 0x7,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x8,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x5,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0xa,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x9,
+ 0x1,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x9,
+ 0x2,
+ 0x4,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x9,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x3,
+ 0xb,
+ 0xb,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x8,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x15,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x7,
+ 0x3,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x4,
+ 0x8,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0xf,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x7,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0xf,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x5,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x8,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x11,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0xf,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x7,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xd,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0xd,
+ 0x4,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x8,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x6,
+ 0x1,
+ 0x2,
+ 0x7,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x8,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0xc,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+];
+pub(crate) const COMPATIBILITY_DECOMPOSED_KV: &[(u32, (u16, u16))] = &[
+ (0x1d5e5, (4752, 1)),
+ (0x1d430, (4339, 1)),
+ (0xfca0, (3015, 2)),
+ (0x1d769, (5138, 1)),
+ (0xfe55, (3808, 1)),
+ (0xfd72, (3438, 3)),
+ (0xb2, (6, 1)),
+ (0x333b, (1909, 5)),
+ (0xfbae, (2585, 1)),
+ (0x1d727, (5072, 1)),
+ (0x246d, (573, 2)),
+ (0x332c, (1846, 4)),
+ (0x1d79a, (5187, 1)),
+ (0xfd81, (3483, 3)),
+ (0xff07, (4015, 1)),
+ (0x1d76b, (5140, 1)),
+ (0x2fb1, (1034, 1)),
+ (0x1d4ef, (4518, 1)),
+ (0x3193, (1179, 1)),
+ (0xfbec, (2621, 3)),
+ (0x1d410, (4307, 1)),
+ (0x2177, (527, 4)),
+ (0xfcfa, (3200, 2)),
+ (0x1ee8e, (5451, 1)),
+ (0xfed8, (3958, 1)),
+ (0x32b8, (1568, 2)),
+ (0xfb7f, (2536, 1)),
+ (0x1d5f4, (4767, 1)),
+ (0x33e0, (2351, 2)),
+ (0x1e055, (5324, 1)),
+ (0xffac, (4180, 1)),
+ (0x1e9a, (234, 2)),
+ (0xfdf7, (3716, 4)),
+ (0x1d493, (4437, 1)),
+ (0x2085, (340, 1)),
+ (0x2148, (433, 1)),
+ (0x1d4e9, (4512, 1)),
+ (0x1d73c, (5093, 1)),
+ (0x1da8, (210, 1)),
+ (0xfeba, (3928, 1)),
+ (0x1d48e, (4432, 1)),
+ (0x1ee6c, (5422, 1)),
+ (0x1d628, (4819, 1)),
+ (0x1d6d1, (4986, 1)),
+ (0x2130, (413, 1)),
+ (0xff6c, (4116, 1)),
+ (0x1d7b4, (5213, 1)),
+ (0x1da4, (206, 1)),
+ (0x1e061, (5336, 1)),
+ (0x3224, (1319, 3)),
+ (0x3229, (1334, 3)),
+ (0x1d7ff, (5286, 1)),
+ (0x1d657, (4866, 1)),
+ (0xfee9, (3975, 1)),
+ (0x32f6, (1659, 1)),
+ (0xfc13, (2716, 2)),
+ (0x1d46e, (4400, 1)),
+ (0x2472, (583, 2)),
+ (0x1d6ba, (4963, 1)),
+ (0xfd05, (3222, 2)),
+ (0x33d7, (2328, 2)),
+ (0xfc17, (2724, 2)),
+ (0x2170, (513, 1)),
+ (0xfd1c, (3268, 2)),
+ (0x3382, (2123, 2)),
+ (0x1d764, (5133, 1)),
+ (0x1ee95, (5458, 1)),
+ (0x2f24, (893, 1)),
+ (0x32e5, (1642, 1)),
+ (0x1d409, (4300, 1)),
+ (0x1d43, (157, 1)),
+ (0x1d597, (4674, 1)),
+ (0x2f81, (986, 1)),
+ (0xfc4a, (2826, 2)),
+ (0x1d713, (5052, 1)),
+ (0x1d7a1, (5194, 1)),
+ (0xff74, (4124, 1)),
+ (0xff7d, (4133, 1)),
+ (0x2483, (638, 4)),
+ (0x3323, (1817, 3)),
+ (0x1e059, (5328, 1)),
+ (0x1d558, (4611, 1)),
+ (0xfc37, (2788, 2)),
+ (0x2f64, (957, 1)),
+ (0xfe58, (3811, 1)),
+ (0x32ee, (1651, 1)),
+ (0xfc6a, (2902, 2)),
+ (0x1d466, (4392, 1)),
+ (0x207e, (333, 1)),
+ (0x1e050, (5319, 1)),
+ (0x1d5ed, (4760, 1)),
+ (0xfc97, (2992, 3)),
+ (0x1d791, (5178, 1)),
+ (0x1d7bd, (5222, 1)),
+ (0x314d, (1112, 1)),
+ (0x33aa, (2219, 3)),
+ (0xfc0c, (2702, 2)),
+ (0x2f47, (928, 1)),
+ (0x3230, (1355, 3)),
+ (0xfdc6, (3684, 3)),
+ (0x1d614, (4799, 1)),
+ (0x3291, (1522, 1)),
+ (0xfe31, (3771, 1)),
+ (0x1d706, (5039, 1)),
+ (0xfe78, (3842, 2)),
+ (0x325a, (1440, 2)),
+ (0x2f84, (989, 1)),
+ (0xfca1, (3017, 2)),
+ (0x24bb, (792, 1)),
+ (0x2094, (354, 1)),
+ (0x1d4f8, (4527, 1)),
+ (0xfcfe, (3208, 2)),
+ (0x1d487, (4425, 1)),
+ (0x1d6fd, (5030, 1)),
+ (0x1d559, (4612, 1)),
+ (0x2074, (323, 1)),
+ (0x2112, (391, 1)),
+ (0xfcd5, (3121, 2)),
+ (0x2f06, (863, 1)),
+ (0x107ba, (4290, 1)),
+ (0xa7f4, (2443, 1)),
+ (0x24bf, (796, 1)),
+ (0x1d49c, (4446, 1)),
+ (0x1d63c, (4839, 1)),
+ (0x32a2, (1539, 1)),
+ (0x1f220, (5668, 1)),
+ (0x1d60f, (4794, 1)),
+ (0x32d5, (1626, 1)),
+ (0xfcec, (3169, 2)),
+ (0xfc49, (2824, 2)),
+ (0xfe70, (3830, 2)),
+ (0x2f45, (926, 1)),
+ (0x33b8, (2258, 2)),
+ (0x2e2, (85, 1)),
+ (0x2fba, (1043, 1)),
+ (0x32c6, (1596, 2)),
+ (0x1ee87, (5445, 1)),
+ (0xffb3, (4187, 1)),
+ (0xfb71, (2522, 1)),
+ (0xff0b, (4019, 1)),
+ (0xfd26, (3288, 2)),
+ (0xfc63, (2881, 3)),
+ (0x3131, (1084, 1)),
+ (0xff6f, (4119, 1)),
+ (0x24b9, (790, 1)),
+ (0x32b1, (1554, 2)),
+ (0xfda0, (3570, 3)),
+ (0x1d72e, (5079, 1)),
+ (0x1d64d, (4856, 1)),
+ (0xfb8f, (2552, 1)),
+ (0x1e03c, (5299, 1)),
+ (0xfd39, (3326, 2)),
+ (0xfd8b, (3513, 3)),
+ (0x1079a, (4259, 1)),
+ (0xfb95, (2558, 1)),
+ (0x107af, (4280, 1)),
+ (0x1f16c, (5642, 2)),
+ (0x1d793, (5180, 1)),
+ (0x1d437, (4346, 1)),
+ (0x3282, (1507, 1)),
+ (0xbe, (21, 3)),
+ (0x2c7d, (853, 1)),
+ (0xfec8, (3942, 1)),
+ (0xfc99, (2998, 3)),
+ (0x337d, (2111, 2)),
+ (0x3290, (1521, 1)),
+ (0x2f0d, (870, 1)),
+ (0x1d6be, (4967, 1)),
+ (0x1d5c6, (4721, 1)),
+ (0xff38, (4064, 1)),
+ (0xfda9, (3597, 3)),
+ (0x1d690, (4923, 1)),
+ (0x1d42d, (4336, 1)),
+ (0x1d524, (4566, 1)),
+ (0x3f5, (108, 1)),
+ (0x1d68f, (4922, 1)),
+ (0x1d5af, (4698, 1)),
+ (0xfd5e, (3378, 3)),
+ (0xfef7, (3993, 3)),
+ (0x33e8, (2367, 2)),
+ (0x1d4cc, (4483, 1)),
+ (0x1d42f, (4338, 1)),
+ (0xfe10, (3757, 1)),
+ (0x1d57e, (4649, 1)),
+ (0x107b7, (4287, 1)),
+ (0x1d499, (4443, 1)),
+ (0x1ee0f, (5363, 1)),
+ (0xfc96, (2990, 2)),
+ (0x1d4d2, (4489, 1)),
+ (0xffe9, (4229, 1)),
+ (0xffa5, (4173, 1)),
+ (0x3299, (1530, 1)),
+ (0x1d5c4, (4719, 1)),
+ (0xfe5c, (3815, 1)),
+ (0x17f, (34, 1)),
+ (0x1d7ea, (5265, 1)),
+ (0x1d4b0, (4458, 1)),
+ (0x1d5be, (4713, 1)),
+ (0x33d9, (2334, 3)),
+ (0x32e7, (1644, 1)),
+ (0x1d6e2, (5003, 1)),
+ (0xffad, (4181, 1)),
+ (0xfcae, (3043, 2)),
+ (0xfcda, (3131, 2)),
+ (0xfc1b, (2732, 2)),
+ (0x2f62, (955, 1)),
+ (0x320a, (1222, 3)),
+ (0x3f9, (109, 1)),
+ (0xfdc1, (3669, 3)),
+ (0x2f72, (971, 1)),
+ (0x316d, (1144, 1)),
+ (0x322b, (1340, 3)),
+ (0x2157, (457, 3)),
+ (0x1d659, (4868, 1)),
+ (0x1d3c, (150, 1)),
+ (0x333e, (1923, 4)),
+ (0x217e, (541, 1)),
+ (0x1f11b, (5545, 3)),
+ (0x1ee74, (5429, 1)),
+ (0x1d458, (4378, 1)),
+ (0xfbfa, (2663, 3)),
+ (0xfeb3, (3921, 1)),
+ (0xfb5f, (2504, 1)),
+ (0x2fc9, (1058, 1)),
+ (0x315a, (1125, 1)),
+ (0x1d4a9, (4452, 1)),
+ (0xfd31, (3310, 2)),
+ (0x3139, (1092, 1)),
+ (0x1db0, (218, 1)),
+ (0x1d4f3, (4522, 1)),
+ (0xfccf, (3109, 2)),
+ (0xfb80, (2537, 1)),
+ (0xfc6e, (2910, 2)),
+ (0x1d768, (5137, 1)),
+ (0x2b6, (68, 1)),
+ (0x333a, (1905, 4)),
+ (0x1d7c9, (5234, 1)),
+ (0x1f13c, (5611, 1)),
+ (0x1d6a2, (4941, 1)),
+ (0x2006, (281, 1)),
+ (0x1d445, (4360, 1)),
+ (0x1d763, (5132, 1)),
+ (0x1d5fa, (4773, 1)),
+ (0x3241, (1406, 3)),
+ (0xfe4a, (3795, 2)),
+ (0x326d, (1465, 1)),
+ (0x1d6c2, (4971, 1)),
+ (0xfd7d, (3471, 3)),
+ (0x3370, (2080, 3)),
+ (0x1d6bb, (4964, 1)),
+ (0x1d78f, (5176, 1)),
+ (0x1d4e6, (4509, 1)),
+ (0xff12, (4026, 1)),
+ (0xfb05, (2463, 2)),
+ (0x1ee1b, (5375, 1)),
+ (0x1d609, (4788, 1)),
+ (0xfe79, (3844, 2)),
+ (0xfbf6, (2651, 3)),
+ (0x1d780, (5161, 1)),
+ (0xfd38, (3324, 2)),
+ (0x1d4de, (4501, 1)),
+ (0x3182, (1165, 1)),
+ (0xfe48, (3792, 1)),
+ (0xfe5e, (3817, 1)),
+ (0x1ee1c, (5376, 1)),
+ (0x3319, (1774, 6)),
+ (0x323f, (1400, 3)),
+ (0x2f03, (860, 1)),
+ (0x1d566, (4625, 1)),
+ (0xfcf3, (3184, 3)),
+ (0x1d581, (4652, 1)),
+ (0x1d6eb, (5012, 1)),
+ (0x1e047, (5310, 1)),
+ (0x3301, (1675, 4)),
+ (0x2fa8, (1025, 1)),
+ (0x249b, (706, 3)),
+ (0xff70, (4120, 1)),
+ (0x1f219, (5661, 1)),
+ (0x1d441, (4356, 1)),
+ (0xfce9, (3163, 2)),
+ (0x32cd, (1613, 3)),
+ (0x1d70d, (5046, 1)),
+ (0xff61, (4105, 1)),
+ (0x2496, (691, 3)),
+ (0x1d416, (4313, 1)),
+ (0x3390, (2154, 2)),
+ (0x1d756, (5119, 1)),
+ (0x1e04a, (5313, 1)),
+ (0xfc6b, (2904, 2)),
+ (0xfc50, (2838, 2)),
+ (0x1d572, (4637, 1)),
+ (0xffce, (4209, 1)),
+ (0x2f12, (875, 1)),
+ (0xff95, (4157, 1)),
+ (0xfb99, (2562, 1)),
+ (0xff46, (4078, 1)),
+ (0xfdb7, (3639, 3)),
+ (0x2156, (454, 3)),
+ (0xff52, (4090, 1)),
+ (0x1f241, (5699, 3)),
+ (0x1d40f, (4306, 1)),
+ (0x1d440, (4355, 1)),
+ (0x3f1, (105, 1)),
+ (0x2078, (327, 1)),
+ (0x1d66c, (4887, 1)),
+ (0x1f13e, (5613, 1)),
+ (0xfc24, (2750, 2)),
+ (0xfe96, (3892, 1)),
+ (0x1d460, (4386, 1)),
+ (0x1d6c9, (4978, 1)),
+ (0x3330, (1865, 3)),
+ (0x2f95, (1006, 1)),
+ (0x1d71e, (5063, 1)),
+ (0x1d51e, (4560, 1)),
+ (0x10782, (4236, 1)),
+ (0xfc26, (2754, 2)),
+ (0xfd1e, (3272, 2)),
+ (0x2145, (430, 1)),
+ (0x327b, (1492, 2)),
+ (0xfcbc, (3071, 2)),
+ (0xff39, (4065, 1)),
+ (0xfc9c, (3007, 2)),
+ (0xfe62, (3821, 1)),
+ (0x1d41c, (4319, 1)),
+ (0x1d691, (4924, 1)),
+ (0x1d488, (4426, 1)),
+ (0x1ee4f, (5406, 1)),
+ (0x1d5e4, (4751, 1)),
+ (0x1e03d, (5300, 1)),
+ (0xfd55, (3351, 3)),
+ (0xfcbd, (3073, 2)),
+ (0x3297, (1528, 1)),
+ (0x1d5e0, (4747, 1)),
+ (0x3192, (1178, 1)),
+ (0x32d2, (1623, 1)),
+ (0x2f9e, (1015, 1)),
+ (0xfd1a, (3264, 2)),
+ (0x32e6, (1643, 1)),
+ (0x1eeaf, (5477, 1)),
+ (0x24d6, (819, 1)),
+ (0xfef4, (3986, 1)),
+ (0x1ee72, (5428, 1)),
+ (0x1d5d3, (4734, 1)),
+ (0xfd0c, (3236, 2)),
+ (0x1d66b, (4886, 1)),
+ (0xff5a, (4098, 1)),
+ (0xfe57, (3810, 1)),
+ (0xfb6a, (2515, 1)),
+ (0x1d44c, (4367, 1)),
+ (0x2474, (587, 3)),
+ (0xfdb3, (3627, 3)),
+ (0xfb92, (2555, 1)),
+ (0x2098, (358, 1)),
+ (0x1d5a9, (4692, 1)),
+ (0x24b6, (787, 1)),
+ (0x1d626, (4817, 1)),
+ (0xab69, (2450, 1)),
+ (0x1d630, (4827, 1)),
+ (0xfb6c, (2517, 1)),
+ (0x1d76f, (5144, 1)),
+ (0x3155, (1120, 1)),
+ (0xfe97, (3893, 1)),
+ (0x1dbb, (229, 1)),
+ (0x33bd, (2268, 2)),
+ (0x1d54c, (4600, 1)),
+ (0x2124, (408, 1)),
+ (0x33d2, (2315, 3)),
+ (0x3236, (1373, 3)),
+ (0x1f112, (5518, 3)),
+ (0x1d37, (146, 1)),
+ (0x132, (24, 2)),
+ (0x329e, (1535, 1)),
+ (0x1d65a, (4869, 1)),
+ (0xfdf8, (3720, 4)),
+ (0x385, (92, 3)),
+ (0x2f71, (970, 1)),
+ (0x1ee61, (5415, 1)),
+ (0xfe3d, (3783, 1)),
+ (0x3153, (1118, 1)),
+ (0xfccc, (3103, 2)),
+ (0x3203, (1201, 3)),
+ (0xfe3f, (3785, 1)),
+ (0x1d550, (4604, 1)),
+ (0x1d6e9, (5010, 1)),
+ (0x1d675, (4896, 1)),
+ (0x3f4, (107, 1)),
+ (0x1d53e, (4591, 1)),
+ (0x315c, (1127, 1)),
+ (0x32ac, (1549, 1)),
+ (0x24cd, (810, 1)),
+ (0xffe6, (4227, 1)),
+ (0x3166, (1137, 1)),
+ (0x1ee6d, (5423, 1)),
+ (0x24d3, (816, 1)),
+ (0xffee, (4234, 1)),
+ (0x1d777, (5152, 1)),
+ (0xff55, (4093, 1)),
+ (0x1d5de, (4745, 1)),
+ (0x1d593, (4670, 1)),
+ (0x1ee2b, (5386, 1)),
+ (0x1d486, (4424, 1)),
+ (0xfd71, (3435, 3)),
+ (0xfef9, (3999, 3)),
+ (0x326a, (1462, 1)),
+ (0x33d6, (2325, 3)),
+ (0x3345, (1947, 3)),
+ (0x2d9, (73, 2)),
+ (0xfbe4, (2609, 1)),
+ (0x3149, (1108, 1)),
+ (0x1d40d, (4304, 1)),
+ (0x1f235, (5689, 1)),
+ (0x1d6de, (4999, 1)),
+ (0x677, (116, 2)),
+ (0x1d656, (4865, 1)),
+ (0x1d3d, (151, 1)),
+ (0x1d6f0, (5017, 1)),
+ (0xfe34, (3774, 1)),
+ (0x1d69c, (4935, 1)),
+ (0xfe76, (3838, 2)),
+ (0x1daf, (217, 1)),
+ (0x1c5, (38, 3)),
+ (0x1d739, (5090, 1)),
+ (0x33e4, (2359, 2)),
+ (0x1d6ed, (5014, 1)),
+ (0x1d6d8, (4993, 1)),
+ (0xfc81, (2948, 2)),
+ (0xfecd, (3947, 1)),
+ (0x1d726, (5071, 1)),
+ (0x1e051, (5320, 1)),
+ (0xfc2c, (2766, 2)),
+ (0x1d6f3, (5020, 1)),
+ (0xfc3b, (2796, 2)),
+ (0xfce7, (3159, 2)),
+ (0x33b1, (2244, 2)),
+ (0x2161, (484, 2)),
+ (0xfe89, (3875, 2)),
+ (0x1d63f, (4842, 1)),
+ (0x1d5c9, (4724, 1)),
+ (0x3266, (1458, 1)),
+ (0xfd00, (3212, 2)),
+ (0x1d4c, (166, 1)),
+ (0x1d7e3, (5258, 1)),
+ (0x1d62b, (4822, 1)),
+ (0xfdae, (3612, 3)),
+ (0x339c, (2182, 2)),
+ (0xfc8c, (2970, 2)),
+ (0x1d449, (4364, 1)),
+ (0xffe2, (4222, 1)),
+ (0x222f, (551, 2)),
+ (0xfc62, (2878, 3)),
+ (0x1d70a, (5043, 1)),
+ (0x2fb3, (1036, 1)),
+ (0x1f239, (5693, 1)),
+ (0x32dc, (1633, 1)),
+ (0x1d7ad, (5206, 1)),
+ (0x3303, (1684, 3)),
+ (0x248b, (664, 2)),
+ (0x3168, (1139, 1)),
+ (0xfdf0, (3690, 3)),
+ (0xff8b, (4147, 1)),
+ (0x1d5c1, (4716, 1)),
+ (0x320f, (1238, 4)),
+ (0x1f145, (5620, 1)),
+ (0x1f118, (5536, 3)),
+ (0xffa0, (4168, 1)),
+ (0x335a, (2022, 2)),
+ (0x1d632, (4829, 1)),
+ (0x33eb, (2375, 3)),
+ (0x2120, (401, 2)),
+ (0x24da, (823, 1)),
+ (0xff28, (4048, 1)),
+ (0xfeaa, (3912, 1)),
+ (0x2fad, (1030, 1)),
+ (0x20a8, (363, 2)),
+ (0x33f3, (2399, 3)),
+ (0x32e2, (1639, 1)),
+ (0x3318, (1770, 4)),
+ (0x1ee35, (5395, 1)),
+ (0x1d5cd, (4728, 1)),
+ (0x325f, (1450, 2)),
+ (0x3365, (2047, 3)),
+ (0x1d4f, (168, 1)),
+ (0x24e7, (836, 1)),
+ (0xfc76, (2926, 2)),
+ (0xfedd, (3963, 1)),
+ (0xfcca, (3099, 2)),
+ (0x208b, (346, 1)),
+ (0x1f14e, (5633, 3)),
+ (0x1ee89, (5447, 1)),
+ (0x217d, (540, 1)),
+ (0x1d770, (5145, 1)),
+ (0x1d4b8, (4466, 1)),
+ (0xfca5, (3025, 2)),
+ (0x1d701, (5034, 1)),
+ (0x3253, (1426, 2)),
+ (0xfe8e, (3884, 1)),
+ (0xfc56, (2850, 2)),
+ (0x1d469, (4395, 1)),
+ (0x3394, (2165, 3)),
+ (0xfbe2, (2607, 1)),
+ (0x2048, (312, 2)),
+ (0xfcf9, (3198, 2)),
+ (0xeb3, (122, 2)),
+ (0x2fc7, (1056, 1)),
+ (0x3376, (2095, 2)),
+ (0x10784, (4238, 1)),
+ (0x1d6ad, (4950, 1)),
+ (0xff80, (4136, 1)),
+ (0x1d498, (4442, 1)),
+ (0x1f141, (5616, 1)),
+ (0x33a5, (2205, 2)),
+ (0x1d683, (4910, 1)),
+ (0xfdba, (3648, 3)),
+ (0x2110, (389, 1)),
+ (0x1d6dc, (4997, 1)),
+ (0x1d4bf, (4471, 1)),
+ (0x1d7d6, (5245, 1)),
+ (0x1f226, (5674, 1)),
+ (0x1d60d, (4792, 1)),
+ (0x2025, (290, 2)),
+ (0x1f247, (5717, 3)),
+ (0xfe90, (3886, 1)),
+ (0x330d, (1721, 4)),
+ (0xfb5a, (2499, 1)),
+ (0x2fa7, (1024, 1)),
+ (0x33bb, (2264, 2)),
+ (0x1d70b, (5044, 1)),
+ (0x2dd, (81, 2)),
+ (0x1d795, (5182, 1)),
+ (0x2488, (658, 2)),
+ (0xfc4c, (2830, 2)),
+ (0x1d599, (4676, 1)),
+ (0xfce3, (3151, 2)),
+ (0x1d5bb, (4710, 1)),
+ (0x2f8c, (997, 1)),
+ (0x1d7fe, (5285, 1)),
+ (0x1d42c, (4335, 1)),
+ (0xff78, (4128, 1)),
+ (0x1d67a, (4901, 1)),
+ (0x1d72c, (5077, 1)),
+ (0xff68, (4112, 1)),
+ (0x317a, (1157, 1)),
+ (0x1d70f, (5048, 1)),
+ (0x32c9, (1602, 3)),
+ (0xedd, (126, 2)),
+ (0x1d5f1, (4764, 1)),
+ (0x1d4c2, (4474, 1)),
+ (0xff24, (4044, 1)),
+ (0xff9a, (4162, 1)),
+ (0x1d671, (4892, 1)),
+ (0xffcf, (4210, 1)),
+ (0x2f0b, (868, 1)),
+ (0x32cc, (1611, 2)),
+ (0x1d6fa, (5027, 1)),
+ (0x1d616, (4801, 1)),
+ (0xfb15, (2471, 2)),
+ (0xfee7, (3973, 1)),
+ (0xff96, (4158, 1)),
+ (0x3d2, (97, 1)),
+ (0x1d5d9, (4740, 1)),
+ (0x1ffd, (271, 2)),
+ (0xfbb1, (2589, 2)),
+ (0xfca3, (3021, 2)),
+ (0x2f7f, (984, 1)),
+ (0x2f42, (923, 1)),
+ (0xfc27, (2756, 2)),
+ (0x1eea7, (5470, 1)),
+ (0x212d, (411, 1)),
+ (0x1d35, (144, 1)),
+ (0x1e05c, (5331, 1)),
+ (0xfcb2, (3051, 2)),
+ (0xfc7e, (2942, 2)),
+ (0x2f9d, (1014, 1)),
+ (0x33f9, (2417, 3)),
+ (0x1d606, (4785, 1)),
+ (0x1d55b, (4614, 1)),
+ (0x1d62f, (4826, 1)),
+ (0x2f9f, (1016, 1)),
+ (0x1dbc, (230, 1)),
+ (0xff3b, (4067, 1)),
+ (0x32d8, (1629, 1)),
+ (0x1d568, (4627, 1)),
+ (0x33e5, (2361, 2)),
+ (0x2f82, (987, 1)),
+ (0xfea7, (3909, 1)),
+ (0x1d55d, (4616, 1)),
+ (0x1d4ac, (4455, 1)),
+ (0x24b2, (775, 3)),
+ (0xfd37, (3322, 2)),
+ (0x2f80, (985, 1)),
+ (0x1d4df, (4502, 1)),
+ (0xfb73, (2524, 1)),
+ (0xfdc7, (3687, 3)),
+ (0x1d48, (162, 1)),
+ (0xfbb0, (2587, 2)),
+ (0x1d704, (5037, 1)),
+ (0x1d481, (4419, 1)),
+ (0x2f5b, (948, 1)),
+ (0x1e034, (5291, 1)),
+ (0x2b2, (64, 1)),
+ (0x1d41d, (4320, 1)),
+ (0xfcce, (3107, 2)),
+ (0x33a8, (2213, 4)),
+ (0x1d6e4, (5005, 1)),
+ (0x1d7c7, (5232, 1)),
+ (0x32b6, (1564, 2)),
+ (0x3218, (1274, 4)),
+ (0xfdf9, (3724, 3)),
+ (0xfd07, (3226, 2)),
+ (0xff69, (4113, 1)),
+ (0x3196, (1182, 1)),
+ (0x1d7ec, (5267, 1)),
+ (0xfcde, (3139, 2)),
+ (0x3274, (1478, 2)),
+ (0xfd11, (3246, 2)),
+ (0xfdb9, (3645, 3)),
+ (0xfccd, (3105, 2)),
+ (0x2fa2, (1019, 1)),
+ (0xfb21, (2478, 1)),
+ (0x1d401, (4292, 1)),
+ (0x1ee0d, (5361, 1)),
+ (0x338d, (2148, 2)),
+ (0xfd36, (3320, 2)),
+ (0xfc44, (2814, 2)),
+ (0x1d573, (4638, 1)),
+ (0x327c, (1494, 5)),
+ (0x1d787, (5168, 1)),
+ (0x2f1d, (886, 1)),
+ (0x1d4ca, (4481, 1)),
+ (0x2f32, (907, 1)),
+ (0x1d443, (4358, 1)),
+ (0xfec5, (3939, 1)),
+ (0x1f237, (5691, 1)),
+ (0xfb9f, (2568, 1)),
+ (0x332e, (1855, 6)),
+ (0x24cc, (809, 1)),
+ (0x2162, (486, 3)),
+ (0xffb6, (4190, 1)),
+ (0xfb9b, (2564, 1)),
+ (0x1fce, (250, 3)),
+ (0x318e, (1177, 1)),
+ (0x32fa, (1663, 1)),
+ (0x32db, (1632, 1)),
+ (0xfee5, (3971, 1)),
+ (0xfe41, (3787, 1)),
+ (0x1d5df, (4746, 1)),
+ (0x33f6, (2408, 3)),
+ (0x1d585, (4656, 1)),
+ (0xfd92, (3528, 3)),
+ (0x1d5b, (180, 1)),
+ (0x1078a, (4243, 1)),
+ (0x337a, (2105, 2)),
+ (0xfdc3, (3675, 3)),
+ (0x1078e, (4247, 1)),
+ (0xff63, (4107, 1)),
+ (0xfedf, (3965, 1)),
+ (0xfd5c, (3372, 3)),
+ (0x1e043, (5306, 1)),
+ (0x1d47b, (4413, 1)),
+ (0xfe18, (3765, 1)),
+ (0x1d7c5, (5230, 1)),
+ (0xfbda, (2598, 1)),
+ (0x1d59d, (4680, 1)),
+ (0x1e058, (5327, 1)),
+ (0x216a, (504, 2)),
+ (0x1d798, (5185, 1)),
+ (0x1ee37, (5397, 1)),
+ (0xfc22, (2746, 2)),
+ (0x3171, (1148, 1)),
+ (0xfd66, (3402, 3)),
+ (0x1eea2, (5466, 1)),
+ (0xfb88, (2545, 1)),
+ (0x1d6b4, (4957, 1)),
+ (0x32e3, (1640, 1)),
+ (0x208e, (349, 1)),
+ (0x3223, (1316, 3)),
+ (0x3137, (1090, 1)),
+ (0x222c, (546, 2)),
+ (0x2f8b, (996, 1)),
+ (0x1f11a, (5542, 3)),
+ (0xfc4f, (2836, 2)),
+ (0x1d52b, (4573, 1)),
+ (0xfba5, (2575, 2)),
+ (0x1d465, (4391, 1)),
+ (0xff50, (4088, 1)),
+ (0xff2b, (4051, 1)),
+ (0xfc60, (2872, 3)),
+ (0x326e, (1466, 2)),
+ (0xfb78, (2529, 1)),
+ (0x2080, (335, 1)),
+ (0xfe37, (3777, 1)),
+ (0x1f243, (5705, 3)),
+ (0xfb01, (2453, 2)),
+ (0x32a1, (1538, 1)),
+ (0x1d6d9, (4994, 1)),
+ (0x2007, (282, 1)),
+ (0x321a, (1282, 4)),
+ (0x1d730, (5081, 1)),
+ (0xfb7a, (2531, 1)),
+ (0x3175, (1152, 1)),
+ (0x2136, (418, 1)),
+ (0x3355, (2007, 2)),
+ (0x32b5, (1562, 2)),
+ (0xfe3b, (3781, 1)),
+ (0xfd2a, (3296, 2)),
+ (0x24ad, (760, 3)),
+ (0x1d471, (4403, 1)),
+ (0x3272, (1474, 2)),
+ (0x1d77b, (5156, 1)),
+ (0xfd68, (3408, 3)),
+ (0x1d65d, (4872, 1)),
+ (0x1f138, (5607, 1)),
+ (0x1e066, (5341, 1)),
+ (0x217c, (539, 1)),
+ (0x1d586, (4657, 1)),
+ (0x1d785, (5166, 1)),
+ (0x1d73d, (5094, 1)),
+ (0xfd53, (3345, 3)),
+ (0x208c, (347, 1)),
+ (0x3326, (1827, 3)),
+ (0x1d517, (4554, 1)),
+ (0x1ee6f, (5425, 1)),
+ (0xfcb0, (3047, 2)),
+ (0xfe19, (3766, 3)),
+ (0xfb25, (2482, 1)),
+ (0xff3c, (4068, 1)),
+ (0xfc7f, (2944, 2)),
+ (0x1d680, (4907, 1)),
+ (0xff47, (4079, 1)),
+ (0x3361, (2036, 2)),
+ (0x1d5e7, (4754, 1)),
+ (0x1e031, (5288, 1)),
+ (0x10791, (4250, 1)),
+ (0x1f125, (5575, 3)),
+ (0x1d716, (5055, 1)),
+ (0xfe11, (3758, 1)),
+ (0x1d7cb, (5236, 1)),
+ (0x316a, (1141, 1)),
+ (0x1f16a, (5638, 2)),
+ (0x1d7af, (5208, 1)),
+ (0xfc2b, (2764, 2)),
+ (0xff1e, (4038, 1)),
+ (0x2fa6, (1023, 1)),
+ (0xfd6c, (3420, 3)),
+ (0x2116, (394, 2)),
+ (0x3327, (1830, 2)),
+ (0xfc21, (2744, 2)),
+ (0x1d30, (139, 1)),
+ (0x1d6fe, (5031, 1)),
+ (0xfc3c, (2798, 2)),
+ (0xfbf7, (2654, 3)),
+ (0x1d66e, (4889, 1)),
+ (0xfe36, (3776, 1)),
+ (0x1d600, (4779, 1)),
+ (0x32c4, (1592, 2)),
+ (0xfcee, (3173, 2)),
+ (0xfea8, (3910, 1)),
+ (0x1d7cf, (5238, 1)),
+ (0x1e05d, (5332, 1)),
+ (0x1d682, (4909, 1)),
+ (0x2498, (697, 3)),
+ (0xfedc, (3962, 1)),
+ (0x1d6ec, (5013, 1)),
+ (0x2f1e, (887, 1)),
+ (0x1d69d, (4936, 1)),
+ (0xfc55, (2848, 2)),
+ (0x1ee97, (5460, 1)),
+ (0x1d5bf, (4714, 1)),
+ (0x207f, (334, 1)),
+ (0x1eeb4, (5482, 1)),
+ (0xfc38, (2790, 2)),
+ (0x1da7, (209, 1)),
+ (0x1d705, (5038, 1)),
+ (0x1d720, (5065, 1)),
+ (0x215b, (469, 3)),
+ (0x1d4fc, (4531, 1)),
+ (0x1e03f, (5302, 1)),
+ (0x1d59a, (4677, 1)),
+ (0xfcfd, (3206, 2)),
+ (0x10781, (4235, 1)),
+ (0x2f9c, (1013, 1)),
+ (0x1d5b3, (4702, 1)),
+ (0x1d7a4, (5197, 1)),
+ (0x107a7, (4272, 1)),
+ (0xfb90, (2553, 1)),
+ (0x1d490, (4434, 1)),
+ (0x1d543, (4595, 1)),
+ (0x2f6a, (963, 1)),
+ (0x3366, (2050, 3)),
+ (0x1d414, (4311, 1)),
+ (0x1d633, (4830, 1)),
+ (0x335f, (2032, 2)),
+ (0x32a8, (1545, 1)),
+ (0x33cf, (2309, 2)),
+ (0xfefc, (4007, 2)),
+ (0x1d6a3, (4942, 1)),
+ (0xffba, (4194, 1)),
+ (0x1078d, (4246, 1)),
+ (0x1d6c4, (4973, 1)),
+ (0x1e044, (5307, 1)),
+ (0x1d4aa, (4453, 1)),
+ (0x1d595, (4672, 1)),
+ (0x3331, (1868, 3)),
+ (0x1d7f7, (5278, 1)),
+ (0x1d6fb, (5028, 1)),
+ (0x1d49, (163, 1)),
+ (0x1d49e, (4447, 1)),
+ (0x1d411, (4308, 1)),
+ (0x2107, (380, 1)),
+ (0x205f, (320, 1)),
+ (0x1e038, (5295, 1)),
+ (0xfb4f, (2487, 2)),
+ (0x1ee9a, (5463, 1)),
+ (0x1d43c, (4351, 1)),
+ (0x32ad, (1550, 1)),
+ (0x1d468, (4394, 1)),
+ (0x3184, (1167, 1)),
+ (0x3162, (1133, 1)),
+ (0x2f69, (962, 1)),
+ (0xfe81, (3859, 2)),
+ (0x1ee05, (5353, 1)),
+ (0xfea5, (3907, 1)),
+ (0x32ba, (1572, 2)),
+ (0x32f0, (1653, 1)),
+ (0x1d7d9, (5248, 1)),
+ (0x1d4c0, (4472, 1)),
+ (0xfea3, (3905, 1)),
+ (0x321d, (1294, 7)),
+ (0x1d6c7, (4976, 1)),
+ (0x1fcf, (253, 3)),
+ (0x33bf, (2272, 2)),
+ (0x1d718, (5057, 1)),
+ (0x10790, (4249, 1)),
+ (0x1d501, (4536, 1)),
+ (0x1d610, (4795, 1)),
+ (0x32e0, (1637, 1)),
+ (0xfd21, (3278, 2)),
+ (0x1d6db, (4996, 1)),
+ (0x1f13d, (5612, 1)),
+ (0x3038, (1073, 1)),
+ (0x33a7, (2210, 3)),
+ (0xfd25, (3286, 2)),
+ (0x1d7e1, (5256, 1)),
+ (0xffbd, (4197, 1)),
+ (0x1ee8c, (5449, 1)),
+ (0x1ee08, (5356, 1)),
+ (0x33c3, (2282, 2)),
+ (0x1d51a, (4557, 1)),
+ (0x32bf, (1582, 2)),
+ (0x249e, (715, 3)),
+ (0x33c8, (2295, 2)),
+ (0x1f210, (5651, 1)),
+ (0x2179, (533, 1)),
+ (0x3222, (1313, 3)),
+ (0x1d782, (5163, 1)),
+ (0x10789, (4242, 1)),
+ (0x3305, (1692, 3)),
+ (0xfe3a, (3780, 1)),
+ (0x1d631, (4828, 1)),
+ (0x3199, (1185, 1)),
+ (0xffd4, (4213, 1)),
+ (0x209c, (362, 1)),
+ (0x3247, (1418, 1)),
+ (0xfc88, (2962, 2)),
+ (0xffb9, (4193, 1)),
+ (0x1d46c, (4398, 1)),
+ (0x1d636, (4833, 1)),
+ (0x315f, (1130, 1)),
+ (0xfb8b, (2548, 1)),
+ (0xb5, (10, 1)),
+ (0x1d419, (4316, 1)),
+ (0xfed5, (3955, 1)),
+ (0x1d6ca, (4979, 1)),
+ (0x339e, (2186, 2)),
+ (0x1d641, (4844, 1)),
+ (0x1d6af, (4952, 1)),
+ (0x3288, (1513, 1)),
+ (0x2154, (448, 3)),
+ (0xfe8d, (3883, 1)),
+ (0x1d40b, (4302, 1)),
+ (0x1d607, (4786, 1)),
+ (0xff26, (4046, 1)),
+ (0x1d758, (5121, 1)),
+ (0xfc4e, (2834, 2)),
+ (0x3364, (2044, 3)),
+ (0x1d4f5, (4524, 1)),
+ (0x2fc6, (1055, 1)),
+ (0x1d5dc, (4743, 1)),
+ (0xfc5e, (2866, 3)),
+ (0xff36, (4062, 1)),
+ (0x24c5, (802, 1)),
+ (0x1d587, (4658, 1)),
+ (0x2091, (351, 1)),
+ (0x1d750, (5113, 1)),
+ (0x24b0, (769, 3)),
+ (0x1f122, (5566, 3)),
+ (0x3339, (1902, 3)),
+ (0x1e054, (5323, 1)),
+ (0x1d511, (4549, 1)),
+ (0x3335, (1887, 3)),
+ (0xffaa, (4178, 1)),
+ (0x1f240, (5696, 3)),
+ (0x1d612, (4797, 1)),
+ (0x1d553, (4606, 1)),
+ (0x1d5aa, (4693, 1)),
+ (0xaa, (3, 1)),
+ (0xff62, (4106, 1)),
+ (0x24de, (827, 1)),
+ (0x1d7e2, (5257, 1)),
+ (0xfe6a, (3828, 1)),
+ (0x2f6f, (968, 1)),
+ (0xfd59, (3363, 3)),
+ (0x1f1, (56, 2)),
+ (0x1d33, (142, 1)),
+ (0x1078f, (4248, 1)),
+ (0x1d536, (4584, 1)),
+ (0x2f0a, (867, 1)),
+ (0x3244, (1415, 1)),
+ (0x246e, (575, 2)),
+ (0xfc85, (2956, 2)),
+ (0x32f3, (1656, 1)),
+ (0x1fbf4, (5729, 1)),
+ (0x1d643, (4846, 1)),
+ (0xfba0, (2569, 1)),
+ (0x1db1, (219, 1)),
+ (0x1d457, (4377, 1)),
+ (0x1d7d7, (5246, 1)),
+ (0x3172, (1149, 1)),
+ (0x33b2, (2246, 2)),
+ (0x107aa, (4275, 1)),
+ (0x2f16, (879, 1)),
+ (0x1d731, (5082, 1)),
+ (0x1d725, (5070, 1)),
+ (0xfbf4, (2645, 3)),
+ (0x33f5, (2405, 3)),
+ (0x339d, (2184, 2)),
+ (0xfcc4, (3087, 2)),
+ (0xfc1c, (2734, 2)),
+ (0xff11, (4025, 1)),
+ (0x1d76d, (5142, 1)),
+ (0x1d61c, (4807, 1)),
+ (0x1d733, (5084, 1)),
+ (0x1d5c7, (4722, 1)),
+ (0xff81, (4137, 1)),
+ (0x2122, (406, 2)),
+ (0x1d4ae, (4456, 1)),
+ (0x1f21d, (5665, 1)),
+ (0x1d47f, (4417, 1)),
+ (0x1d757, (5120, 1)),
+ (0xbc, (15, 3)),
+ (0x1d621, (4812, 1)),
+ (0xffe4, (4225, 1)),
+ (0xfec9, (3943, 1)),
+ (0x1ee84, (5442, 1)),
+ (0xfd98, (3546, 3)),
+ (0x3161, (1132, 1)),
+ (0x213f, (428, 1)),
+ (0x1d9e, (200, 1)),
+ (0x1d619, (4804, 1)),
+ (0x1d4d6, (4493, 1)),
+ (0x1d5c0, (4715, 1)),
+ (0x2f7b, (980, 1)),
+ (0x1ee0b, (5359, 1)),
+ (0x1d746, (5103, 1)),
+ (0xfceb, (3167, 2)),
+ (0xfef3, (3985, 1)),
+ (0xfcf4, (3187, 3)),
+ (0xfe7a, (3846, 2)),
+ (0x215c, (472, 3)),
+ (0x1d4fd, (4532, 1)),
+ (0xfba7, (2578, 1)),
+ (0xfd3c, (3332, 2)),
+ (0x1d46a, (4396, 1)),
+ (0x2163, (489, 2)),
+ (0x1ee64, (5417, 1)),
+ (0x1d692, (4925, 1)),
+ (0x1d648, (4851, 1)),
+ (0x1d482, (4420, 1)),
+ (0x1d576, (4641, 1)),
+ (0x1d717, (5056, 1)),
+ (0xfe30, (3769, 2)),
+ (0x1f232, (5686, 1)),
+ (0xfc77, (2928, 2)),
+ (0x1d668, (4883, 1)),
+ (0x2146, (431, 1)),
+ (0xa8, (1, 2)),
+ (0xfb93, (2556, 1)),
+ (0x1d5ef, (4762, 1)),
+ (0xfbfd, (2670, 1)),
+ (0x107ab, (4276, 1)),
+ (0x1e063, (5338, 1)),
+ (0x1d470, (4402, 1)),
+ (0x3356, (2009, 6)),
+ (0x1d4c5, (4476, 1)),
+ (0xfbe7, (2612, 1)),
+ (0x24ea, (839, 1)),
+ (0x1d519, (4556, 1)),
+ (0x1d654, (4863, 1)),
+ (0x2f6d, (966, 1)),
+ (0x1d518, (4555, 1)),
+ (0x1d639, (4836, 1)),
+ (0xfd52, (3342, 3)),
+ (0x1d79f, (5192, 1)),
+ (0x1d775, (5150, 1)),
+ (0x3371, (2083, 3)),
+ (0x1e048, (5311, 1)),
+ (0x1d7ce, (5237, 1)),
+ (0xff65, (4109, 1)),
+ (0x33a0, (2191, 3)),
+ (0x313e, (1097, 1)),
+ (0x1d60a, (4789, 1)),
+ (0x1d591, (4668, 1)),
+ (0x1e04d, (5316, 1)),
+ (0x1d5c5, (4720, 1)),
+ (0x327a, (1490, 2)),
+ (0x1d68, (193, 1)),
+ (0xff71, (4121, 1)),
+ (0x1d42e, (4337, 1)),
+ (0x1d77a, (5155, 1)),
+ (0xfe44, (3790, 1)),
+ (0x1f132, (5601, 1)),
+ (0x1d5f6, (4769, 1)),
+ (0x1d77c, (5157, 1)),
+ (0x1d66f, (4890, 1)),
+ (0x1d7f5, (5276, 1)),
+ (0xfcd7, (3125, 2)),
+ (0x3188, (1171, 1)),
+ (0x1d7a0, (5193, 1)),
+ (0xfbe5, (2610, 1)),
+ (0xff8d, (4149, 1)),
+ (0x107a1, (4266, 1)),
+ (0x1d44e, (4369, 1)),
+ (0x1d528, (4570, 1)),
+ (0x2fc4, (1053, 1)),
+ (0x2024, (289, 1)),
+ (0x10fc, (135, 1)),
+ (0xfdb0, (3618, 3)),
+ (0xfcb4, (3055, 2)),
+ (0x330c, (1717, 4)),
+ (0x316b, (1142, 1)),
+ (0x1f111, (5515, 3)),
+ (0x2fb8, (1041, 1)),
+ (0x3385, (2129, 2)),
+ (0x1da9, (211, 1)),
+ (0x1d73a, (5091, 1)),
+ (0x3293, (1524, 1)),
+ (0x1d4cf, (4486, 1)),
+ (0x32d6, (1627, 1)),
+ (0x338b, (2144, 2)),
+ (0x314a, (1109, 1)),
+ (0x1f14d, (5631, 2)),
+ (0x1e9b, (236, 2)),
+ (0x1d64a, (4853, 1)),
+ (0x1d7da, (5249, 1)),
+ (0xfb17, (2475, 2)),
+ (0x1d761, (5130, 1)),
+ (0x2097, (357, 1)),
+ (0x1fc0, (242, 2)),
+ (0x33e3, (2357, 2)),
+ (0x1d6b3, (4956, 1)),
+ (0x1d5b4, (4703, 1)),
+ (0xfd17, (3258, 2)),
+ (0xfc2a, (2762, 2)),
+ (0x1d76a, (5139, 1)),
+ (0x1d68a, (4917, 1)),
+ (0x1e039, (5296, 1)),
+ (0xfbe9, (2614, 1)),
+ (0x1f107, (5504, 2)),
+ (0x107a4, (4269, 1)),
+ (0x216d, (510, 1)),
+ (0x2092, (352, 1)),
+ (0xff3d, (4069, 1)),
+ (0x107b3, (4283, 1)),
+ (0x2f51, (938, 1)),
+ (0xfc59, (2856, 2)),
+ (0x1d529, (4571, 1)),
+ (0x3237, (1376, 3)),
+ (0x3215, (1262, 4)),
+ (0x2465, (561, 1)),
+ (0x1d735, (5086, 1)),
+ (0x107b9, (4289, 1)),
+ (0xfed3, (3953, 1)),
+ (0x203c, (306, 2)),
+ (0x2f9b, (1012, 1)),
+ (0x2f66, (959, 1)),
+ (0xfd75, (3447, 3)),
+ (0x1d634, (4831, 1)),
+ (0xe33, (120, 2)),
+ (0x1dba, (228, 1)),
+ (0xfd5a, (3366, 3)),
+ (0x2494, (685, 3)),
+ (0x315d, (1128, 1)),
+ (0x1d509, (4543, 1)),
+ (0x1d797, (5184, 1)),
+ (0x334f, (1986, 3)),
+ (0x1d7fb, (5282, 1)),
+ (0x2463, (559, 1)),
+ (0xff02, (4010, 1)),
+ (0xfb61, (2506, 1)),
+ (0x33ec, (2378, 3)),
+ (0x1d5f7, (4770, 1)),
+ (0x33ae, (2231, 5)),
+ (0xfc89, (2964, 2)),
+ (0x1d738, (5089, 1)),
+ (0x1e030, (5287, 1)),
+ (0x1f22a, (5678, 1)),
+ (0x2f4b, (932, 1)),
+ (0x3302, (1679, 5)),
+ (0x1d4d, (167, 1)),
+ (0x1d4d7, (4494, 1)),
+ (0xfc4d, (2832, 2)),
+ (0x1d4e5, (4508, 1)),
+ (0x1d542, (4594, 1)),
+ (0x3336, (1890, 5)),
+ (0x2fb6, (1039, 1)),
+ (0x2fa1, (1018, 1)),
+ (0x1d71a, (5059, 1)),
+ (0xfca4, (3023, 2)),
+ (0x1d618, (4803, 1)),
+ (0xfcc2, (3083, 2)),
+ (0x1dac, (214, 1)),
+ (0xfcb8, (3063, 2)),
+ (0xfb7c, (2533, 1)),
+ (0x317f, (1162, 1)),
+ (0x1d7e0, (5255, 1)),
+ (0xffc6, (4203, 1)),
+ (0x3150, (1115, 1)),
+ (0x3276, (1482, 2)),
+ (0x328d, (1518, 1)),
+ (0x32bc, (1576, 2)),
+ (0x133, (26, 2)),
+ (0x1f245, (5711, 3)),
+ (0x213e, (427, 1)),
+ (0xfb66, (2511, 1)),
+ (0x2f89, (994, 1)),
+ (0x1f12e, (5597, 2)),
+ (0x1d4f1, (4520, 1)),
+ (0xfc91, (2980, 2)),
+ (0xff53, (4091, 1)),
+ (0x3306, (1695, 3)),
+ (0x2473, (585, 2)),
+ (0x1dae, (216, 1)),
+ (0xfbac, (2583, 1)),
+ (0x33b4, (2250, 2)),
+ (0x3214, (1258, 4)),
+ (0x32c2, (1588, 2)),
+ (0x24ca, (807, 1)),
+ (0x1d533, (4581, 1)),
+ (0x33f8, (2414, 3)),
+ (0xff44, (4076, 1)),
+ (0x1d4f7, (4526, 1)),
+ (0x1078c, (4245, 1)),
+ (0xffca, (4205, 1)),
+ (0xfe17, (3764, 1)),
+ (0xfbe1, (2606, 1)),
+ (0xfc32, (2778, 2)),
+ (0x1d625, (4816, 1)),
+ (0x140, (30, 2)),
+ (0xfeab, (3913, 1)),
+ (0x1d6d3, (4988, 1)),
+ (0x1d7a8, (5201, 1)),
+ (0xfb5d, (2502, 1)),
+ (0x3220, (1307, 3)),
+ (0x24a5, (736, 3)),
+ (0x1d4b3, (4461, 1)),
+ (0x107ad, (4278, 1)),
+ (0x3399, (2176, 2)),
+ (0x2f36, (911, 1)),
+ (0xfc74, (2922, 2)),
+ (0x1d5a5, (4688, 1)),
+ (0x2fc3, (1052, 1)),
+ (0x1e06c, (5347, 1)),
+ (0x32d9, (1630, 1)),
+ (0x1d544, (4596, 1)),
+ (0x3221, (1310, 3)),
+ (0x1d512, (4550, 1)),
+ (0xfece, (3948, 1)),
+ (0xfcf7, (3194, 2)),
+ (0xfb82, (2539, 1)),
+ (0x1d6b8, (4961, 1)),
+ (0x3194, (1180, 1)),
+ (0xffe5, (4226, 1)),
+ (0x32e8, (1645, 1)),
+ (0x24af, (766, 3)),
+ (0x1fbf1, (5726, 1)),
+ (0xfbfc, (2669, 1)),
+ (0xb3, (7, 1)),
+ (0x24c6, (803, 1)),
+ (0x1d749, (5106, 1)),
+ (0xfd9a, (3552, 3)),
+ (0x1d4b5, (4463, 1)),
+ (0xfede, (3964, 1)),
+ (0x1d6e7, (5008, 1)),
+ (0x2f48, (929, 1)),
+ (0x1d4e3, (4506, 1)),
+ (0x1eea6, (5469, 1)),
+ (0x2f97, (1008, 1)),
+ (0x24a8, (745, 3)),
+ (0x1d562, (4621, 1)),
+ (0x2102, (371, 1)),
+ (0x1d61b, (4806, 1)),
+ (0x3176, (1153, 1)),
+ (0x1d60, (185, 1)),
+ (0x1d698, (4931, 1)),
+ (0xfed9, (3959, 1)),
+ (0x1d61f, (4810, 1)),
+ (0x1ee6a, (5421, 1)),
+ (0xfd09, (3230, 2)),
+ (0x1d561, (4620, 1)),
+ (0x1d4e1, (4504, 1)),
+ (0x1d7f4, (5275, 1)),
+ (0x2f68, (961, 1)),
+ (0x1eeb3, (5481, 1)),
+ (0x1e062, (5337, 1)),
+ (0x2fbe, (1047, 1)),
+ (0x2047, (310, 2)),
+ (0xff23, (4043, 1)),
+ (0xfe77, (3840, 2)),
+ (0x1d75b, (5124, 1)),
+ (0x1d4b9, (4467, 1)),
+ (0x33ba, (2262, 2)),
+ (0x2482, (634, 4)),
+ (0xffb0, (4184, 1)),
+ (0x3164, (1135, 1)),
+ (0x24d1, (814, 1)),
+ (0x24db, (824, 1)),
+ (0x1d5bc, (4711, 1)),
+ (0x3396, (2170, 2)),
+ (0x1d590, (4667, 1)),
+ (0x1d5da, (4741, 1)),
+ (0x1d454, (4375, 1)),
+ (0x1ee24, (5382, 1)),
+ (0x2134, (416, 1)),
+ (0x1d7a5, (5198, 1)),
+ (0x1e056, (5325, 1)),
+ (0x32f7, (1660, 1)),
+ (0xfe72, (3834, 2)),
+ (0x1e04c, (5315, 1)),
+ (0xfef0, (3982, 1)),
+ (0x2f0f, (872, 1)),
+ (0x2f88, (993, 1)),
+ (0x1d4cd, (4484, 1)),
+ (0x1d54b, (4599, 1)),
+ (0x1d7ba, (5219, 1)),
+ (0x1fbf, (240, 2)),
+ (0xffeb, (4231, 1)),
+ (0x1d5ee, (4761, 1)),
+ (0xff72, (4122, 1)),
+ (0x1f218, (5660, 1)),
+ (0x3234, (1367, 3)),
+ (0x1d7ef, (5270, 1)),
+ (0x1d425, (4328, 1)),
+ (0x1d6ce, (4983, 1)),
+ (0x1ee83, (5441, 1)),
+ (0x1e04f, (5318, 1)),
+ (0x1d483, (4421, 1)),
+ (0xff73, (4123, 1)),
+ (0xff1c, (4036, 1)),
+ (0x33f2, (2396, 3)),
+ (0x217b, (536, 3)),
+ (0x2004, (279, 1)),
+ (0x1d6a4, (4943, 1)),
+ (0x326f, (1468, 2)),
+ (0xfc57, (2852, 2)),
+ (0x32f2, (1655, 1)),
+ (0x1d646, (4849, 1)),
+ (0x1d412, (4309, 1)),
+ (0x249a, (703, 3)),
+ (0x1f127, (5581, 3)),
+ (0x330b, (1714, 3)),
+ (0xfc5c, (2862, 2)),
+ (0x2f46, (927, 1)),
+ (0x1d40a, (4301, 1)),
+ (0x24d8, (821, 1)),
+ (0x1d77e, (5159, 1)),
+ (0xfd3a, (3328, 2)),
+ (0x1d64, (189, 1)),
+ (0x315e, (1129, 1)),
+ (0x319d, (1189, 1)),
+ (0x1ee3b, (5399, 1)),
+ (0xfb26, (2483, 1)),
+ (0x1d4fe, (4533, 1)),
+ (0x2480, (626, 4)),
+ (0x216e, (511, 1)),
+ (0x1e03b, (5298, 1)),
+ (0x1d6b6, (4959, 1)),
+ (0xbd, (18, 3)),
+ (0x1d42, (156, 1)),
+ (0x24a1, (724, 3)),
+ (0x33df, (2348, 3)),
+ (0xffb5, (4189, 1)),
+ (0x1e042, (5305, 1)),
+ (0xfc9a, (3001, 3)),
+ (0x1d5eb, (4758, 1)),
+ (0xfcbf, (3077, 2)),
+ (0xfd58, (3360, 3)),
+ (0x2464, (560, 1)),
+ (0xfe3c, (3782, 1)),
+ (0x3246, (1417, 1)),
+ (0x2a0c, (840, 4)),
+ (0xfdb4, (3630, 3)),
+ (0xfd96, (3540, 3)),
+ (0x1d407, (4298, 1)),
+ (0x3257, (1434, 2)),
+ (0x207a, (329, 1)),
+ (0x3d5, (102, 1)),
+ (0x336b, (2065, 3)),
+ (0x32d0, (1621, 1)),
+ (0x1eeae, (5476, 1)),
+ (0x1d5d5, (4736, 1)),
+ (0x1eead, (5475, 1)),
+ (0x2f1a, (883, 1)),
+ (0xfee0, (3966, 1)),
+ (0x2fa3, (1020, 1)),
+ (0x1eeb2, (5480, 1)),
+ (0xfbf5, (2648, 3)),
+ (0x1e067, (5342, 1)),
+ (0x3174, (1151, 1)),
+ (0xfbe0, (2605, 1)),
+ (0x1ee51, (5407, 1)),
+ (0xff3f, (4071, 1)),
+ (0x3165, (1136, 1)),
+ (0x323d, (1394, 3)),
+ (0x1d72d, (5078, 1)),
+ (0x1d79b, (5188, 1)),
+ (0x1d4b6, (4464, 1)),
+ (0xfc54, (2846, 2)),
+ (0x2fb0, (1033, 1)),
+ (0x3228, (1331, 3)),
+ (0x1d3a, (149, 1)),
+ (0x3213, (1254, 4)),
+ (0x1e065, (5340, 1)),
+ (0x1d4ff, (4534, 1)),
+ (0x1d734, (5085, 1)),
+ (0x1d78b, (5172, 1)),
+ (0xa69d, (2439, 1)),
+ (0x2f96, (1007, 1)),
+ (0xfc39, (2792, 2)),
+ (0x1f14c, (5629, 2)),
+ (0xfedb, (3961, 1)),
+ (0x2495, (688, 3)),
+ (0x1f124, (5572, 3)),
+ (0x1d7dc, (5251, 1)),
+ (0x1e053, (5322, 1)),
+ (0x2f9a, (1011, 1)),
+ (0xfd61, (3387, 3)),
+ (0xfd02, (3216, 2)),
+ (0x1eeab, (5473, 1)),
+ (0x1079f, (4264, 1)),
+ (0x1ee86, (5444, 1)),
+ (0xfd9b, (3555, 3)),
+ (0x1d50f, (4547, 1)),
+ (0xfc8e, (2974, 2)),
+ (0x1d513, (4551, 1)),
+ (0x1d54f, (4603, 1)),
+ (0x2173, (519, 2)),
+ (0x2f5a, (947, 1)),
+ (0x1d78c, (5173, 1)),
+ (0x1d767, (5136, 1)),
+ (0xfdab, (3603, 3)),
+ (0x2f01, (858, 1)),
+ (0xfc3f, (2804, 2)),
+ (0x33c6, (2288, 4)),
+ (0x1d6c0, (4969, 1)),
+ (0xfb98, (2561, 1)),
+ (0x3151, (1116, 1)),
+ (0x1ee09, (5357, 1)),
+ (0xfd8a, (3510, 3)),
+ (0xff4d, (4085, 1)),
+ (0x1d729, (5074, 1)),
+ (0xfeb4, (3922, 1)),
+ (0xfba4, (2573, 2)),
+ (0x1d6b9, (4962, 1)),
+ (0x1d6d0, (4985, 1)),
+ (0x318d, (1176, 1)),
+ (0x1f10a, (5510, 2)),
+ (0x2017, (287, 2)),
+ (0x1f121, (5563, 3)),
+ (0x1d41f, (4322, 1)),
+ (0x1d415, (4312, 1)),
+ (0x319b, (1187, 1)),
+ (0x1d6dd, (4998, 1)),
+ (0x337f, (2115, 4)),
+ (0x3260, (1452, 1)),
+ (0x1fbf6, (5731, 1)),
+ (0xfb7b, (2532, 1)),
+ (0x1d752, (5115, 1)),
+ (0x2f50, (937, 1)),
+ (0xfebf, (3933, 1)),
+ (0x1d658, (4867, 1)),
+ (0xfdfa, (3727, 18)),
+ (0x336e, (2074, 3)),
+ (0xff51, (4089, 1)),
+ (0xfc16, (2722, 2)),
+ (0x1d5d, (182, 1)),
+ (0x24b8, (789, 1)),
+ (0xab5d, (2447, 1)),
+ (0x1d41b, (4318, 1)),
+ (0xfb68, (2513, 1)),
+ (0x1f103, (5496, 2)),
+ (0x2f53, (940, 1)),
+ (0x3352, (1996, 2)),
+ (0x1d5f9, (4772, 1)),
+ (0x1d494, (4438, 1)),
+ (0x1d52c, (4574, 1)),
+ (0x24e6, (835, 1)),
+ (0x2faf, (1032, 1)),
+ (0x32c1, (1586, 2)),
+ (0x2b3, (65, 1)),
+ (0xfec1, (3935, 1)),
+ (0x1f147, (5622, 1)),
+ (0x384, (90, 2)),
+ (0x24ba, (791, 1)),
+ (0xff87, (4143, 1)),
+ (0x1d669, (4884, 1)),
+ (0xff35, (4061, 1)),
+ (0xfefb, (4005, 2)),
+ (0x1d7fa, (5281, 1)),
+ (0x1d50, (169, 1)),
+ (0xfef2, (3984, 1)),
+ (0x3245, (1416, 1)),
+ (0x1d78a, (5171, 1)),
+ (0xfb75, (2526, 1)),
+ (0x1ee91, (5454, 1)),
+ (0x33e9, (2369, 3)),
+ (0x2139, (421, 1)),
+ (0x3258, (1436, 2)),
+ (0x3287, (1512, 1)),
+ (0x317d, (1160, 1)),
+ (0x24ae, (763, 3)),
+ (0xff98, (4160, 1)),
+ (0x1d596, (4673, 1)),
+ (0x1d6b0, (4953, 1)),
+ (0x1e069, (5344, 1)),
+ (0x1f22c, (5680, 1)),
+ (0xff42, (4074, 1)),
+ (0xffbb, (4195, 1)),
+ (0xff1d, (4037, 1)),
+ (0x1d503, (4538, 1)),
+ (0x1d6e1, (5002, 1)),
+ (0xfcc7, (3093, 2)),
+ (0xff60, (4104, 1)),
+ (0x1ee5d, (5413, 1)),
+ (0x1f115, (5527, 3)),
+ (0x1d4c9, (4480, 1)),
+ (0x1d567, (4626, 1)),
+ (0x1d67e, (4905, 1)),
+ (0x33ed, (2381, 3)),
+ (0x1e068, (5343, 1)),
+ (0xfda6, (3588, 3)),
+ (0x33ca, (2299, 2)),
+ (0x1d7f8, (5279, 1)),
+ (0x33ef, (2387, 3)),
+ (0xfd50, (3336, 3)),
+ (0x248e, (670, 2)),
+ (0xfcd4, (3119, 2)),
+ (0xfe98, (3894, 1)),
+ (0x32a7, (1544, 1)),
+ (0xffa9, (4177, 1)),
+ (0x2172, (516, 3)),
+ (0x1d5a, (179, 1)),
+ (0xff27, (4047, 1)),
+ (0x1dad, (215, 1)),
+ (0x1d766, (5135, 1)),
+ (0x24df, (828, 1)),
+ (0xfeae, (3916, 1)),
+ (0xfe35, (3775, 1)),
+ (0x1d5a3, (4686, 1)),
+ (0x1d650, (4859, 1)),
+ (0x1d62a, (4821, 1)),
+ (0x1d4dd, (4500, 1)),
+ (0xff5b, (4099, 1)),
+ (0x1d464, (4390, 1)),
+ (0xfc34, (2782, 2)),
+ (0x1d6bc, (4965, 1)),
+ (0x1d71c, (5061, 1)),
+ (0x2128, (409, 1)),
+ (0xfb74, (2525, 1)),
+ (0xfced, (3171, 2)),
+ (0xa69c, (2438, 1)),
+ (0x2a74, (844, 3)),
+ (0xfef8, (3996, 3)),
+ (0x1d63a, (4837, 1)),
+ (0xfcb5, (3057, 2)),
+ (0x1d435, (4344, 1)),
+ (0x1ee69, (5420, 1)),
+ (0x2036, (301, 2)),
+ (0x1fbd, (238, 2)),
+ (0x1d5fb, (4774, 1)),
+ (0x1d5b9, (4708, 1)),
+ (0xfd57, (3357, 3)),
+ (0x318b, (1174, 1)),
+ (0xfdf5, (3708, 4)),
+ (0xfe7c, (3850, 2)),
+ (0xfc9b, (3004, 3)),
+ (0xfd14, (3252, 2)),
+ (0x1d51b, (4558, 1)),
+ (0x1ee67, (5418, 1)),
+ (0x338a, (2142, 2)),
+ (0xff40, (4072, 1)),
+ (0xfb50, (2489, 1)),
+ (0x1d4c7, (4478, 1)),
+ (0x1079c, (4261, 1)),
+ (0x1ee17, (5371, 1)),
+ (0x1f190, (5644, 2)),
+ (0x1d5f0, (4763, 1)),
+ (0x32b3, (1558, 2)),
+ (0x1d7d5, (5244, 1)),
+ (0xfe64, (3823, 1)),
+ (0xfb8e, (2551, 1)),
+ (0xfc07, (2692, 2)),
+ (0xfb58, (2497, 1)),
+ (0x1d75c, (5125, 1)),
+ (0x2168, (501, 2)),
+ (0x1d745, (5102, 1)),
+ (0x1ee4e, (5405, 1)),
+ (0x2fcc, (1061, 1)),
+ (0x1d781, (5162, 1)),
+ (0x313c, (1095, 1)),
+ (0x1fde, (259, 3)),
+ (0x2fbd, (1046, 1)),
+ (0x1d5d4, (4735, 1)),
+ (0x1d500, (4535, 1)),
+ (0xfc80, (2946, 2)),
+ (0x33a3, (2199, 3)),
+ (0x1d502, (4537, 1)),
+ (0x32d1, (1622, 1)),
+ (0xfd97, (3543, 3)),
+ (0x1d489, (4427, 1)),
+ (0xffd6, (4215, 1)),
+ (0xfcc3, (3085, 2)),
+ (0x2493, (682, 3)),
+ (0x1d6c6, (4975, 1)),
+ (0x208d, (348, 1)),
+ (0xfb06, (2465, 2)),
+ (0x319c, (1188, 1)),
+ (0x1da1, (203, 1)),
+ (0xff1b, (4035, 1)),
+ (0xfee1, (3967, 1)),
+ (0xfc65, (2887, 3)),
+ (0xfc14, (2718, 2)),
+ (0xfea2, (3904, 1)),
+ (0xfb91, (2554, 1)),
+ (0x3350, (1989, 3)),
+ (0x1d6c8, (4977, 1)),
+ (0x1d677, (4898, 1)),
+ (0x10783, (4237, 1)),
+ (0x1da3, (205, 1)),
+ (0x1d51, (170, 1)),
+ (0x3261, (1453, 1)),
+ (0xfc78, (2930, 2)),
+ (0x3363, (2041, 3)),
+ (0x2f3c, (917, 1)),
+ (0x2f27, (896, 1)),
+ (0x32a3, (1540, 1)),
+ (0x1fbf5, (5730, 1)),
+ (0x2b4, (66, 1)),
+ (0x3286, (1511, 1)),
+ (0x2f17, (880, 1)),
+ (0x1d5cc, (4727, 1)),
+ (0x1f230, (5684, 1)),
+ (0xfb03, (2457, 3)),
+ (0x24ce, (811, 1)),
+ (0x2f30, (905, 1)),
+ (0xfd60, (3384, 3)),
+ (0x1f123, (5569, 3)),
+ (0x1d532, (4580, 1)),
+ (0x1f21e, (5666, 1)),
+ (0x3353, (1998, 4)),
+ (0x1d9b, (197, 1)),
+ (0x1f104, (5498, 2)),
+ (0x1f21b, (5663, 1)),
+ (0xfe52, (3806, 1)),
+ (0xfd3b, (3330, 2)),
+ (0x2f61, (954, 1)),
+ (0xfc00, (2673, 3)),
+ (0x1ee71, (5427, 1)),
+ (0x3f0, (104, 1)),
+ (0x1d7e4, (5259, 1)),
+ (0xfc5d, (2864, 2)),
+ (0x1d670, (4891, 1)),
+ (0xfe33, (3773, 1)),
+ (0x1d57d, (4648, 1)),
+ (0xfe6b, (3829, 1)),
+ (0x3233, (1364, 3)),
+ (0x2f21, (890, 1)),
+ (0xfc15, (2720, 2)),
+ (0x1d55f, (4618, 1)),
+ (0xfd64, (3396, 3)),
+ (0x1d49a, (4444, 1)),
+ (0xfe7b, (3848, 2)),
+ (0x1d762, (5131, 1)),
+ (0x1d6e0, (5001, 1)),
+ (0xfeb5, (3923, 1)),
+ (0x1d46b, (4397, 1)),
+ (0x1db6, (224, 1)),
+ (0x3141, (1100, 1)),
+ (0xfe9c, (3898, 1)),
+ (0x1d484, (4422, 1)),
+ (0x329d, (1534, 1)),
+ (0x1d530, (4578, 1)),
+ (0xfd32, (3312, 2)),
+ (0xfc5f, (2869, 3)),
+ (0x1ee7b, (5435, 1)),
+ (0xf0c, (128, 1)),
+ (0x1d56f, (4634, 1)),
+ (0x1d6aa, (4947, 1)),
+ (0x33dc, (2341, 2)),
+ (0x24e3, (832, 1)),
+ (0x1f22e, (5682, 1)),
+ (0x1d4b7, (4465, 1)),
+ (0x1d5d1, (4732, 1)),
+ (0x1d7a6, (5199, 1)),
+ (0x2f4e, (935, 1)),
+ (0x1d6ae, (4951, 1)),
+ (0x3f2, (106, 1)),
+ (0x3280, (1505, 1)),
+ (0x1d3e, (152, 1)),
+ (0xfbef, (2630, 3)),
+ (0x1f102, (5494, 2)),
+ (0xfe54, (3807, 1)),
+ (0x3263, (1455, 1)),
+ (0xff9b, (4163, 1)),
+ (0x1d584, (4655, 1)),
+ (0x3351, (1992, 4)),
+ (0x3156, (1121, 1)),
+ (0xfbf2, (2639, 3)),
+ (0xfb02, (2455, 2)),
+ (0x317b, (1158, 1)),
+ (0x314c, (1111, 1)),
+ (0x1c6, (41, 3)),
+ (0x1d73f, (5096, 1)),
+ (0x1ee4d, (5404, 1)),
+ (0x1d53, (172, 1)),
+ (0x33d1, (2313, 2)),
+ (0x1d58a, (4661, 1)),
+ (0xfd83, (3489, 3)),
+ (0x2178, (531, 2)),
+ (0x1d751, (5114, 1)),
+ (0xfd77, (3453, 3)),
+ (0x1d479, (4411, 1)),
+ (0x215d, (475, 3)),
+ (0xfd87, (3501, 3)),
+ (0x318a, (1173, 1)),
+ (0x1d43f, (4354, 1)),
+ (0x2fcd, (1062, 1)),
+ (0x1d4f0, (4519, 1)),
+ (0x1d59, (178, 1)),
+ (0x1d65f, (4874, 1)),
+ (0x3393, (2162, 3)),
+ (0x1ee92, (5455, 1)),
+ (0xa770, (2440, 1)),
+ (0xfd0b, (3234, 2)),
+ (0x208a, (345, 1)),
+ (0xfe80, (3858, 1)),
+ (0x1d7f3, (5274, 1)),
+ (0xfd0d, (3238, 2)),
+ (0x1d54a, (4598, 1)),
+ (0x1d699, (4932, 1)),
+ (0xfe92, (3888, 1)),
+ (0xfe4c, (3799, 2)),
+ (0x1d653, (4862, 1)),
+ (0x1e04b, (5314, 1)),
+ (0x1d5b8, (4707, 1)),
+ (0x1d45a, (4380, 1)),
+ (0x335b, (2024, 2)),
+ (0x1d789, (5170, 1)),
+ (0xa7f2, (2441, 1)),
+ (0x1eea3, (5467, 1)),
+ (0xff7c, (4132, 1)),
+ (0x2176, (524, 3)),
+ (0xffa6, (4174, 1)),
+ (0xff57, (4095, 1)),
+ (0x1ee79, (5433, 1)),
+ (0x1d5ae, (4697, 1)),
+ (0x1d46f, (4401, 1)),
+ (0x2da, (75, 2)),
+ (0x2f4d, (934, 1)),
+ (0xfdc5, (3681, 3)),
+ (0x3384, (2127, 2)),
+ (0x24c0, (797, 1)),
+ (0x1d57c, (4647, 1)),
+ (0x1d7b0, (5209, 1)),
+ (0x1d5cb, (4726, 1)),
+ (0x1d783, (5164, 1)),
+ (0x1d4e8, (4511, 1)),
+ (0x1d58e, (4665, 1)),
+ (0xff0d, (4021, 1)),
+ (0x1d644, (4847, 1)),
+ (0x24c4, (801, 1)),
+ (0x2f52, (939, 1)),
+ (0x1d68e, (4921, 1)),
+ (0x1d50d, (4545, 1)),
+ (0xfb6b, (2516, 1)),
+ (0x2fcb, (1060, 1)),
+ (0xff32, (4058, 1)),
+ (0xffab, (4179, 1)),
+ (0x316c, (1143, 1)),
+ (0x2070, (321, 1)),
+ (0xfd8d, (3519, 3)),
+ (0xfe74, (3836, 2)),
+ (0x2131, (414, 1)),
+ (0xff64, (4108, 1)),
+ (0x339b, (2180, 2)),
+ (0x1e06a, (5345, 1)),
+ (0x1f224, (5672, 1)),
+ (0x1d405, (4296, 1)),
+ (0xff49, (4081, 1)),
+ (0xff37, (4063, 1)),
+ (0x2075, (324, 1)),
+ (0xfebe, (3932, 1)),
+ (0xfee8, (3974, 1)),
+ (0xa7f8, (2444, 1)),
+ (0x1d7be, (5223, 1)),
+ (0x1d9d, (199, 1)),
+ (0x107b6, (4286, 1)),
+ (0x2f79, (978, 1)),
+ (0x1f212, (5653, 1)),
+ (0xfcdf, (3141, 3)),
+ (0x1d5a1, (4684, 1)),
+ (0xfcc9, (3097, 2)),
+ (0x1ee11, (5365, 1)),
+ (0x339f, (2188, 3)),
+ (0xfb83, (2540, 1)),
+ (0x1f131, (5600, 1)),
+ (0xff08, (4016, 1)),
+ (0xfe9e, (3900, 1)),
+ (0xfe39, (3779, 1)),
+ (0x3386, (2131, 2)),
+ (0xfd6f, (3429, 3)),
+ (0x1d58b, (4662, 1)),
+ (0x1d5f3, (4766, 1)),
+ (0x1d5f, (184, 1)),
+ (0xfc30, (2774, 2)),
+ (0x33fa, (2420, 3)),
+ (0x1ee5b, (5412, 1)),
+ (0x2478, (599, 3)),
+ (0x1d747, (5104, 1)),
+ (0xfcf8, (3196, 2)),
+ (0x1d667, (4882, 1)),
+ (0x1d796, (5183, 1)),
+ (0x2011, (286, 1)),
+ (0x1f144, (5619, 1)),
+ (0xfd3d, (3334, 2)),
+ (0x3270, (1470, 2)),
+ (0x326c, (1464, 1)),
+ (0x1d5c8, (4723, 1)),
+ (0x1d68c, (4919, 1)),
+ (0xfdfb, (3745, 8)),
+ (0xfdb6, (3636, 3)),
+ (0x2095, (355, 1)),
+ (0x3219, (1278, 4)),
+ (0x2499, (700, 3)),
+ (0x1ee52, (5408, 1)),
+ (0x2dc, (79, 2)),
+ (0x210e, (387, 1)),
+ (0x1d5ce, (4729, 1)),
+ (0x1d687, (4914, 1)),
+ (0x1d702, (5035, 1)),
+ (0x2093, (353, 1)),
+ (0x1d615, (4800, 1)),
+ (0x2f0c, (869, 1)),
+ (0x3185, (1168, 1)),
+ (0x1d42a, (4333, 1)),
+ (0x247b, (608, 3)),
+ (0xfeee, (3980, 1)),
+ (0x10785, (4239, 1)),
+ (0x209a, (360, 1)),
+ (0xfb72, (2523, 1)),
+ (0x33e2, (2355, 2)),
+ (0xfc75, (2924, 2)),
+ (0x24d2, (815, 1)),
+ (0x1e05b, (5330, 1)),
+ (0x212c, (410, 1)),
+ (0x247f, (622, 4)),
+ (0x1d45e, (4384, 1)),
+ (0xfee3, (3969, 1)),
+ (0x2f19, (882, 1)),
+ (0x321e, (1301, 6)),
+ (0x2f05, (862, 1)),
+ (0xfb16, (2473, 2)),
+ (0x3142, (1101, 1)),
+ (0x107a5, (4270, 1)),
+ (0x2001, (276, 1)),
+ (0xfc84, (2954, 2)),
+ (0x1d55c, (4615, 1)),
+ (0x1d7c4, (5229, 1)),
+ (0x2fa0, (1017, 1)),
+ (0x1f143, (5618, 1)),
+ (0x2f8f, (1000, 1)),
+ (0x24c9, (806, 1)),
+ (0x32c5, (1594, 2)),
+ (0x248f, (672, 2)),
+ (0xff84, (4140, 1)),
+ (0x3324, (1820, 4)),
+ (0xfcb7, (3061, 2)),
+ (0x1e041, (5304, 1)),
+ (0x24d9, (822, 1)),
+ (0xfd16, (3256, 2)),
+ (0x3251, (1422, 2)),
+ (0xfc92, (2982, 2)),
+ (0xfe8f, (3885, 1)),
+ (0xfdc4, (3678, 3)),
+ (0x2f1c, (885, 1)),
+ (0x1f22b, (5679, 1)),
+ (0x1d5db, (4742, 1)),
+ (0x2f41, (922, 1)),
+ (0xfd1b, (3266, 2)),
+ (0x3217, (1270, 4)),
+ (0x1f250, (5723, 1)),
+ (0x3321, (1809, 5)),
+ (0x2f40, (921, 1)),
+ (0x2fca, (1059, 1)),
+ (0x107a6, (4271, 1)),
+ (0x1d589, (4660, 1)),
+ (0x3136, (1089, 1)),
+ (0xfc7d, (2940, 2)),
+ (0xfb87, (2544, 1)),
+ (0xfc0e, (2706, 2)),
+ (0x1f106, (5502, 2)),
+ (0x2f65, (958, 1)),
+ (0xfe56, (3809, 1)),
+ (0xfb9c, (2565, 1)),
+ (0xfee4, (3970, 1)),
+ (0x1ee06, (5354, 1)),
+ (0x1d6d2, (4987, 1)),
+ (0x1d45d, (4383, 1)),
+ (0x1d660, (4875, 1)),
+ (0x1f216, (5658, 1)),
+ (0x1d400, (4291, 1)),
+ (0xfb13, (2467, 2)),
+ (0xfc6f, (2912, 2)),
+ (0xfca7, (3029, 2)),
+ (0xfe13, (3760, 1)),
+ (0xfe4b, (3797, 2)),
+ (0x1d78d, (5174, 1)),
+ (0xff2e, (4054, 1)),
+ (0x2f6b, (964, 1)),
+ (0xfbe6, (2611, 1)),
+ (0x1d4f6, (4525, 1)),
+ (0x107a8, (4273, 1)),
+ (0x328b, (1516, 1)),
+ (0x1d5c, (181, 1)),
+ (0x246a, (567, 2)),
+ (0xfcb9, (3065, 2)),
+ (0xfbd6, (2594, 1)),
+ (0x33f7, (2411, 3)),
+ (0xfd08, (3228, 2)),
+ (0x32c7, (1598, 2)),
+ (0x1d684, (4911, 1)),
+ (0x1eea1, (5465, 1)),
+ (0xfd78, (3456, 3)),
+ (0x1ee80, (5438, 1)),
+ (0x1f225, (5673, 1)),
+ (0x1eeb6, (5484, 1)),
+ (0x1ee0c, (5360, 1)),
+ (0xab5c, (2446, 1)),
+ (0xfb5c, (2501, 1)),
+ (0x322e, (1349, 3)),
+ (0xfc4b, (2828, 2)),
+ (0x24c7, (804, 1)),
+ (0x3360, (2034, 2)),
+ (0x1d737, (5088, 1)),
+ (0x33d0, (2311, 2)),
+ (0xfc90, (2978, 2)),
+ (0x1eeb0, (5478, 1)),
+ (0xfda1, (3573, 3)),
+ (0x3375, (2093, 2)),
+ (0x2f00, (857, 1)),
+ (0xfb9a, (2563, 1)),
+ (0x322a, (1337, 3)),
+ (0x32a9, (1546, 1)),
+ (0x1d472, (4404, 1)),
+ (0x1d4d4, (4491, 1)),
+ (0x1f221, (5669, 1)),
+ (0xff7b, (4131, 1)),
+ (0x1d46, (160, 1)),
+ (0xffb1, (4185, 1)),
+ (0x1d436, (4345, 1)),
+ (0x3298, (1529, 1)),
+ (0xfc43, (2812, 2)),
+ (0xfc31, (2776, 2)),
+ (0x1d679, (4900, 1)),
+ (0x315b, (1126, 1)),
+ (0x1d712, (5051, 1)),
+ (0xfe99, (3895, 1)),
+ (0xfed1, (3951, 1)),
+ (0x339a, (2178, 2)),
+ (0x1d4a6, (4451, 1)),
+ (0xfbd5, (2593, 1)),
+ (0x210a, (383, 1)),
+ (0xfb96, (2559, 1)),
+ (0x2f8e, (999, 1)),
+ (0x1d7a9, (5202, 1)),
+ (0xfb5e, (2503, 1)),
+ (0x10793, (4252, 1)),
+ (0x2f56, (943, 1)),
+ (0x207d, (332, 1)),
+ (0x1f227, (5675, 1)),
+ (0xfc94, (2986, 2)),
+ (0x1d4d3, (4490, 1)),
+ (0xfd67, (3405, 3)),
+ (0xff09, (4017, 1)),
+ (0x1d5a4, (4687, 1)),
+ (0x1e06d, (5348, 1)),
+ (0x1d39, (148, 1)),
+ (0x3210, (1242, 4)),
+ (0x1d721, (5066, 1)),
+ (0xff91, (4153, 1)),
+ (0x1d62d, (4824, 1)),
+ (0x1d7c0, (5225, 1)),
+ (0x1f213, (5654, 2)),
+ (0x1f130, (5599, 1)),
+ (0x1d4d5, (4492, 1)),
+ (0x1db2, (220, 1)),
+ (0x2f98, (1009, 1)),
+ (0x1d56a, (4629, 1)),
+ (0x2477, (596, 3)),
+ (0x1d526, (4568, 1)),
+ (0x2475, (590, 3)),
+ (0x107b8, (4288, 1)),
+ (0x1f242, (5702, 3)),
+ (0x587, (110, 2)),
+ (0x1d7b3, (5212, 1)),
+ (0x2076, (325, 1)),
+ (0x1d6f2, (5019, 1)),
+ (0xfdbc, (3654, 3)),
+ (0x24a6, (739, 3)),
+ (0x33d4, (2320, 2)),
+ (0x1d4d8, (4495, 1)),
+ (0x320c, (1228, 3)),
+ (0x1d57b, (4646, 1)),
+ (0x1ee15, (5369, 1)),
+ (0x24a4, (733, 3)),
+ (0x2149, (434, 1)),
+ (0xfbf8, (2657, 3)),
+ (0x2f04, (861, 1)),
+ (0x1d5ca, (4725, 1)),
+ (0x1d57, (176, 1)),
+ (0xff22, (4042, 1)),
+ (0x1d68b, (4918, 1)),
+ (0x1d7b5, (5214, 1)),
+ (0x1d4c8, (4479, 1)),
+ (0x2088, (343, 1)),
+ (0x3340, (1929, 5)),
+ (0x1d507, (4541, 1)),
+ (0x325d, (1446, 2)),
+ (0x1d5fe, (4777, 1)),
+ (0x317c, (1159, 1)),
+ (0x1ee47, (5401, 1)),
+ (0x33b0, (2242, 2)),
+ (0x1d786, (5167, 1)),
+ (0xfc83, (2952, 2)),
+ (0x1d444, (4359, 1)),
+ (0x32f1, (1654, 1)),
+ (0x3152, (1117, 1)),
+ (0xff13, (4027, 1)),
+ (0xfe38, (3778, 1)),
+ (0x1d4ec, (4515, 1)),
+ (0xfd7e, (3474, 3)),
+ (0x336f, (2077, 3)),
+ (0x3d0, (95, 1)),
+ (0x1d7f1, (5272, 1)),
+ (0x1f251, (5724, 1)),
+ (0x1db3, (221, 1)),
+ (0x1d514, (4552, 1)),
+ (0x33fb, (2423, 3)),
+ (0xfbf1, (2636, 3)),
+ (0xfd84, (3492, 3)),
+ (0x1fbf3, (5728, 1)),
+ (0x328a, (1515, 1)),
+ (0x24ab, (754, 3)),
+ (0x1d7e7, (5262, 1)),
+ (0x335c, (2026, 2)),
+ (0xff85, (4141, 1)),
+ (0x1d4bd, (4469, 1)),
+ (0xfdb5, (3633, 3)),
+ (0xfdf2, (3696, 4)),
+ (0xfe83, (3863, 2)),
+ (0x1fdd, (256, 3)),
+ (0xfc7b, (2936, 2)),
+ (0x319a, (1186, 1)),
+ (0x3275, (1480, 2)),
+ (0xfd20, (3276, 2)),
+ (0x1d402, (4293, 1)),
+ (0xff67, (4111, 1)),
+ (0x1d7dd, (5252, 1)),
+ (0xfc2e, (2770, 2)),
+ (0xff04, (4012, 1)),
+ (0x1eeb1, (5479, 1)),
+ (0x3317, (1765, 5)),
+ (0x3367, (2053, 3)),
+ (0x1d652, (4861, 1)),
+ (0x337e, (2113, 2)),
+ (0x1d9c, (198, 1)),
+ (0x1079e, (4263, 1)),
+ (0x2f5f, (952, 1)),
+ (0xfea6, (3908, 1)),
+ (0x1d66, (191, 1)),
+ (0x1ee90, (5453, 1)),
+ (0x1d723, (5068, 1)),
+ (0x247e, (618, 4)),
+ (0x216b, (506, 3)),
+ (0x1d74c, (5109, 1)),
+ (0x1d68d, (4920, 1)),
+ (0x3211, (1246, 4)),
+ (0x1d77f, (5160, 1)),
+ (0xff86, (4142, 1)),
+ (0x2f18, (881, 1)),
+ (0x3347, (1953, 5)),
+ (0xfc72, (2918, 2)),
+ (0x1d496, (4440, 1)),
+ (0x1f129, (5587, 3)),
+ (0x210d, (386, 1)),
+ (0x1d40e, (4305, 1)),
+ (0x1d4e0, (4503, 1)),
+ (0x1d571, (4636, 1)),
+ (0x200a, (285, 1)),
+ (0x1d53d, (4590, 1)),
+ (0x2099, (359, 1)),
+ (0x2a75, (847, 2)),
+ (0xfe40, (3786, 1)),
+ (0xfebd, (3931, 1)),
+ (0x1d44b, (4366, 1)),
+ (0x32d3, (1624, 1)),
+ (0x1d666, (4881, 1)),
+ (0xfbaa, (2581, 1)),
+ (0x2f7e, (983, 1)),
+ (0xff77, (4127, 1)),
+ (0xff25, (4045, 1)),
+ (0x1d693, (4926, 1)),
+ (0xfeb6, (3924, 1)),
+ (0x1d695, (4928, 1)),
+ (0xffd5, (4214, 1)),
+ (0x1d491, (4435, 1)),
+ (0x3359, (2020, 2)),
+ (0x1d57f, (4650, 1)),
+ (0xffd7, (4216, 1)),
+ (0x1ee32, (5393, 1)),
+ (0x3267, (1459, 1)),
+ (0xfd30, (3308, 2)),
+ (0xfbed, (2624, 3)),
+ (0xfd94, (3534, 3)),
+ (0x3278, (1486, 2)),
+ (0xff97, (4159, 1)),
+ (0x1d686, (4913, 1)),
+ (0x1f108, (5506, 2)),
+ (0x2f2c, (901, 1)),
+ (0xfcd1, (3113, 2)),
+ (0x2468, (564, 1)),
+ (0xfe3e, (3784, 1)),
+ (0xff66, (4110, 1)),
+ (0xff14, (4028, 1)),
+ (0x1d74d, (5110, 1)),
+ (0x32f5, (1658, 1)),
+ (0x33cd, (2305, 2)),
+ (0x2469, (565, 2)),
+ (0x32b4, (1560, 2)),
+ (0x1d65b, (4870, 1)),
+ (0x1f113, (5521, 3)),
+ (0x2155, (451, 3)),
+ (0x1daa, (212, 1)),
+ (0xfed6, (3956, 1)),
+ (0x1d5bd, (4712, 1)),
+ (0x1e045, (5308, 1)),
+ (0xfdf3, (3700, 4)),
+ (0xfb8c, (2549, 1)),
+ (0x1d7d4, (5243, 1)),
+ (0x2b8, (70, 1)),
+ (0x1d565, (4624, 1)),
+ (0x2fd5, (1070, 1)),
+ (0x1d4af, (4457, 1)),
+ (0xfcf2, (3181, 3)),
+ (0x1f142, (5617, 1)),
+ (0x3195, (1181, 1)),
+ (0x1d56c, (4631, 1)),
+ (0xfd0e, (3240, 2)),
+ (0x1eeb7, (5485, 1)),
+ (0xff54, (4092, 1)),
+ (0x678, (118, 2)),
+ (0xfbee, (2627, 3)),
+ (0x1d540, (4592, 1)),
+ (0x33be, (2270, 2)),
+ (0xfead, (3915, 1)),
+ (0x1d40c, (4303, 1)),
+ (0xfb23, (2480, 1)),
+ (0xfee6, (3972, 1)),
+ (0xffa1, (4169, 1)),
+ (0x1d674, (4895, 1)),
+ (0x1d36, (145, 1)),
+ (0x2106, (377, 3)),
+ (0x3231, (1358, 3)),
+ (0x1ee59, (5411, 1)),
+ (0x3338, (1898, 4)),
+ (0x1d7c3, (5228, 1)),
+ (0x107b5, (4285, 1)),
+ (0x2b0, (62, 1)),
+ (0xfc36, (2786, 2)),
+ (0x1f234, (5688, 1)),
+ (0x1d473, (4405, 1)),
+ (0x313f, (1098, 1)),
+ (0xfd7b, (3465, 3)),
+ (0x3154, (1119, 1)),
+ (0x1ee31, (5392, 1)),
+ (0xffae, (4182, 1)),
+ (0x1d4b, (165, 1)),
+ (0x1ee4b, (5403, 1)),
+ (0x1d672, (4893, 1)),
+ (0x313b, (1094, 1)),
+ (0x1d7ae, (5207, 1)),
+ (0xfd35, (3318, 2)),
+ (0x3200, (1192, 3)),
+ (0xff19, (4033, 1)),
+ (0x1d538, (4586, 1)),
+ (0x1f105, (5500, 2)),
+ (0x2f3a, (915, 1)),
+ (0xff2d, (4053, 1)),
+ (0x1ee03, (5352, 1)),
+ (0x2fc5, (1054, 1)),
+ (0xfc19, (2728, 2)),
+ (0xfb27, (2484, 1)),
+ (0x2f31, (906, 1)),
+ (0x2a76, (849, 3)),
+ (0x1d655, (4864, 1)),
+ (0x1d47e, (4416, 1)),
+ (0x246f, (577, 2)),
+ (0x2f13, (876, 1)),
+ (0x1f233, (5687, 1)),
+ (0x1d59f, (4682, 1)),
+ (0x2497, (694, 3)),
+ (0x2e9f, (855, 1)),
+ (0x32dd, (1634, 1)),
+ (0xfd28, (3292, 2)),
+ (0x1d7bb, (5220, 1)),
+ (0x1d7d2, (5241, 1)),
+ (0x32e1, (1638, 1)),
+ (0x1d69b, (4934, 1)),
+ (0x107ac, (4277, 1)),
+ (0xfc93, (2984, 2)),
+ (0x2f34, (909, 1)),
+ (0x2490, (674, 2)),
+ (0xfb6e, (2519, 1)),
+ (0x1f12d, (5595, 2)),
+ (0xfba1, (2570, 1)),
+ (0x1d48d, (4431, 1)),
+ (0x1f228, (5676, 1)),
+ (0x2471, (581, 2)),
+ (0xfb59, (2498, 1)),
+ (0xfec3, (3937, 1)),
+ (0x329a, (1531, 1)),
+ (0x33c9, (2297, 2)),
+ (0x1dbd, (231, 1)),
+ (0x1d474, (4406, 1)),
+ (0x1d673, (4894, 1)),
+ (0xffe1, (4221, 1)),
+ (0x1d4c3, (4475, 1)),
+ (0x1d649, (4852, 1)),
+ (0xfed2, (3952, 1)),
+ (0x3205, (1207, 3)),
+ (0x1d537, (4585, 1)),
+ (0xfcd9, (3129, 2)),
+ (0x3140, (1099, 1)),
+ (0x309f, (1080, 2)),
+ (0xff58, (4096, 1)),
+ (0x1d707, (5040, 1)),
+ (0x1d5d8, (4739, 1)),
+ (0x2f5e, (951, 1)),
+ (0x329c, (1533, 1)),
+ (0x1ee8f, (5452, 1)),
+ (0x1f21a, (5662, 1)),
+ (0x1fc1, (244, 3)),
+ (0x1d71b, (5060, 1)),
+ (0x1ee29, (5384, 1)),
+ (0x2f5d, (950, 1)),
+ (0x3346, (1950, 3)),
+ (0x33cc, (2303, 2)),
+ (0x1d676, (4897, 1)),
+ (0x2fc1, (1050, 1)),
+ (0x1d604, (4783, 1)),
+ (0x1d4ed, (4516, 1)),
+ (0x1d508, (4542, 1)),
+ (0xfd5d, (3375, 3)),
+ (0x1d5a7, (4690, 1)),
+ (0x1e033, (5290, 1)),
+ (0xb8, (11, 2)),
+ (0xffda, (4217, 1)),
+ (0x3273, (1476, 2)),
+ (0xff21, (4041, 1)),
+ (0x24cf, (812, 1)),
+ (0x3332, (1871, 6)),
+ (0x1d413, (4310, 1)),
+ (0x249c, (709, 3)),
+ (0xff30, (4056, 1)),
+ (0x1ee68, (5419, 1)),
+ (0x1d5b0, (4699, 1)),
+ (0xfbd7, (2595, 1)),
+ (0x3133, (1086, 1)),
+ (0xfd33, (3314, 2)),
+ (0xfc12, (2714, 2)),
+ (0x334a, (1964, 6)),
+ (0x1d48f, (4433, 1)),
+ (0xff17, (4031, 1)),
+ (0x13f, (28, 2)),
+ (0x32c8, (1600, 2)),
+ (0xfe63, (3822, 1)),
+ (0x1d6f7, (5024, 1)),
+ (0x33e6, (2363, 2)),
+ (0x1d689, (4916, 1)),
+ (0x1d7fc, (5283, 1)),
+ (0x2167, (497, 4)),
+ (0x1da2, (204, 1)),
+ (0x1eea8, (5471, 1)),
+ (0x3169, (1140, 1)),
+ (0xaf, (4, 2)),
+ (0xfcb6, (3059, 2)),
+ (0xfbeb, (2618, 3)),
+ (0xfe61, (3820, 1)),
+ (0x1d6f5, (5022, 1)),
+ (0x3277, (1484, 2)),
+ (0x321b, (1286, 4)),
+ (0xfc28, (2758, 2)),
+ (0x1d51c, (4559, 1)),
+ (0xff92, (4154, 1)),
+ (0x3395, (2168, 2)),
+ (0x1d5fd, (4776, 1)),
+ (0x1d722, (5067, 1)),
+ (0x2f99, (1010, 1)),
+ (0x33a4, (2202, 3)),
+ (0x3d6, (103, 1)),
+ (0x24e8, (837, 1)),
+ (0x212f, (412, 1)),
+ (0x1f201, (5648, 2)),
+ (0xfec0, (3934, 1)),
+ (0x1d67d, (4904, 1)),
+ (0x33a1, (2194, 2)),
+ (0xfca6, (3027, 2)),
+ (0x2f85, (990, 1)),
+ (0x37a, (88, 2)),
+ (0x32cf, (1618, 3)),
+ (0x1f200, (5646, 2)),
+ (0x2e4, (87, 1)),
+ (0x1d75e, (5127, 1)),
+ (0x1d4a5, (4450, 1)),
+ (0xfed0, (3950, 1)),
+ (0x3269, (1461, 1)),
+ (0x1d55e, (4617, 1)),
+ (0x1d439, (4348, 1)),
+ (0x1d5b5, (4704, 1)),
+ (0xfc64, (2884, 3)),
+ (0xfeb0, (3918, 1)),
+ (0xfbd8, (2596, 1)),
+ (0x3147, (1106, 1)),
+ (0xfbe3, (2608, 1)),
+ (0x2113, (392, 1)),
+ (0x1e05f, (5334, 1)),
+ (0x3368, (2056, 3)),
+ (0xff4e, (4086, 1)),
+ (0x1d6a9, (4946, 1)),
+ (0xfb6d, (2518, 1)),
+ (0x332b, (1840, 6)),
+ (0x334c, (1973, 5)),
+ (0xfb52, (2491, 1)),
+ (0x1d426, (4329, 1)),
+ (0xab5f, (2449, 1)),
+ (0xfe5d, (3816, 1)),
+ (0x1d6bf, (4968, 1)),
+ (0x1d6b5, (4958, 1)),
+ (0xfba6, (2577, 1)),
+ (0x1ffe, (273, 2)),
+ (0xfbd4, (2592, 1)),
+ (0xfc6d, (2908, 2)),
+ (0xff20, (4040, 1)),
+ (0x1d5ab, (4694, 1)),
+ (0x1d5f2, (4765, 1)),
+ (0x325c, (1444, 2)),
+ (0xfe42, (3788, 1)),
+ (0x3383, (2125, 2)),
+ (0xfb22, (2479, 1)),
+ (0x1d5ec, (4759, 1)),
+ (0x1d63e, (4841, 1)),
+ (0xfc7a, (2934, 2)),
+ (0x1d4cb, (4482, 1)),
+ (0xfd9f, (3567, 3)),
+ (0x319f, (1191, 1)),
+ (0x1d521, (4563, 1)),
+ (0x217f, (542, 1)),
+ (0x3238, (1379, 3)),
+ (0x1d438, (4347, 1)),
+ (0xffa4, (4172, 1)),
+ (0x24aa, (751, 3)),
+ (0xba, (14, 1)),
+ (0xfc79, (2932, 2)),
+ (0xfe5b, (3814, 1)),
+ (0x1ee02, (5351, 1)),
+ (0x32fb, (1664, 1)),
+ (0x2d8, (71, 2)),
+ (0x32da, (1631, 1)),
+ (0x338c, (2146, 2)),
+ (0xfd2b, (3298, 2)),
+ (0xfd06, (3224, 2)),
+ (0x32b0, (1553, 1)),
+ (0x1e03e, (5301, 1)),
+ (0x2fab, (1028, 1)),
+ (0x210c, (385, 1)),
+ (0xfcd6, (3123, 2)),
+ (0x2164, (491, 1)),
+ (0xff83, (4139, 1)),
+ (0x24b4, (781, 3)),
+ (0x2f94, (1005, 1)),
+ (0x32ed, (1650, 1)),
+ (0x3232, (1361, 3)),
+ (0x2f59, (946, 1)),
+ (0xff33, (4059, 1)),
+ (0x3262, (1454, 1)),
+ (0x330e, (1725, 4)),
+ (0x2489, (660, 2)),
+ (0x2fb5, (1038, 1)),
+ (0xfeea, (3976, 1)),
+ (0x2fc8, (1057, 1)),
+ (0x215e, (478, 3)),
+ (0xff05, (4013, 1)),
+ (0x2f8a, (995, 1)),
+ (0x1ee1d, (5377, 1)),
+ (0xfebb, (3929, 1)),
+ (0x1d67f, (4906, 1)),
+ (0xfe93, (3889, 1)),
+ (0xfecf, (3949, 1)),
+ (0xfbfb, (2666, 3)),
+ (0x1d6d6, (4991, 1)),
+ (0x2152, (441, 4)),
+ (0x1db7, (225, 1)),
+ (0x1f14a, (5625, 2)),
+ (0xfbdc, (2600, 1)),
+ (0x1d694, (4927, 1)),
+ (0x2158, (460, 3)),
+ (0x1d63d, (4840, 1)),
+ (0x2101, (368, 3)),
+ (0x2137, (419, 1)),
+ (0xfdc0, (3666, 3)),
+ (0x1d7a3, (5196, 1)),
+ (0x1d54, (173, 1)),
+ (0x10797, (4256, 1)),
+ (0x3268, (1460, 1)),
+ (0x10795, (4254, 1)),
+ (0x33b9, (2260, 2)),
+ (0xfc02, (2679, 3)),
+ (0x332f, (1861, 4)),
+ (0x213d, (426, 1)),
+ (0x3283, (1508, 1)),
+ (0x2f15, (878, 1)),
+ (0x1d453, (4374, 1)),
+ (0x107b0, (4281, 1)),
+ (0x2f33, (908, 1)),
+ (0xfe7f, (3856, 2)),
+ (0x1d7eb, (5266, 1)),
+ (0x32ca, (1605, 3)),
+ (0xedc, (124, 2)),
+ (0xffed, (4233, 1)),
+ (0x1d7ca, (5235, 1)),
+ (0x3265, (1457, 1)),
+ (0x3389, (2138, 4)),
+ (0xfcaf, (3045, 2)),
+ (0xfd69, (3411, 3)),
+ (0x32a4, (1541, 1)),
+ (0x2f75, (974, 1)),
+ (0x2c7c, (852, 1)),
+ (0x2fae, (1031, 1)),
+ (0xff2c, (4052, 1)),
+ (0xfdf1, (3693, 3)),
+ (0x1d613, (4798, 1)),
+ (0xfc73, (2920, 2)),
+ (0x1d495, (4439, 1)),
+ (0x1d4ea, (4513, 1)),
+ (0xa7f3, (2442, 1)),
+ (0x1d7e5, (5260, 1)),
+ (0xfe85, (3867, 2)),
+ (0x1d4f2, (4521, 1)),
+ (0x1d65e, (4873, 1)),
+ (0x1d7c6, (5231, 1)),
+ (0x2103, (372, 2)),
+ (0x2083, (338, 1)),
+ (0xfc33, (2780, 2)),
+ (0x333d, (1918, 5)),
+ (0xfcef, (3175, 2)),
+ (0xfeb8, (3926, 1)),
+ (0x32fd, (1666, 1)),
+ (0x1d74b, (5108, 1)),
+ (0x247c, (611, 3)),
+ (0x1079d, (4262, 1)),
+ (0x1e052, (5321, 1)),
+ (0x1ee10, (5364, 1)),
+ (0x2f7d, (982, 1)),
+ (0xfda4, (3582, 3)),
+ (0x323a, (1385, 3)),
+ (0x3157, (1122, 1)),
+ (0x33c0, (2274, 2)),
+ (0x1f3, (60, 2)),
+ (0xfc51, (2840, 2)),
+ (0xfe15, (3762, 1)),
+ (0x3204, (1204, 3)),
+ (0x3397, (2172, 2)),
+ (0x1d4e2, (4505, 1)),
+ (0x32ce, (1616, 2)),
+ (0xfb69, (2514, 1)),
+ (0x1d6fc, (5029, 1)),
+ (0x32a5, (1542, 1)),
+ (0xfe9a, (3896, 1)),
+ (0x1dbe, (232, 1)),
+ (0x2090, (350, 1)),
+ (0xfbd9, (2597, 1)),
+ (0x1d778, (5153, 1)),
+ (0x1d6d7, (4992, 1)),
+ (0x1d7bf, (5224, 1)),
+ (0xfda8, (3594, 3)),
+ (0x3391, (2156, 3)),
+ (0xfc5b, (2860, 2)),
+ (0x2467, (563, 1)),
+ (0x1d7f0, (5271, 1)),
+ (0x3186, (1169, 1)),
+ (0x2f10, (873, 1)),
+ (0x1d5e3, (4750, 1)),
+ (0xfce5, (3155, 2)),
+ (0x1d75a, (5123, 1)),
+ (0xa7f9, (2445, 1)),
+ (0x1d580, (4651, 1)),
+ (0x1d49b, (4445, 1)),
+ (0x2151, (438, 3)),
+ (0x1f23b, (5695, 1)),
+ (0xfcad, (3041, 2)),
+ (0x32b7, (1566, 2)),
+ (0x1d5cf, (4730, 1)),
+ (0x1d790, (5177, 1)),
+ (0x1d6cd, (4982, 1)),
+ (0xffcc, (4207, 1)),
+ (0x3307, (1698, 6)),
+ (0x1d7df, (5254, 1)),
+ (0x2f07, (864, 1)),
+ (0x24d5, (818, 1)),
+ (0x1d5a0, (4683, 1)),
+ (0xfb85, (2542, 1)),
+ (0x1d520, (4562, 1)),
+ (0x1d4d1, (4488, 1)),
+ (0x2461, (557, 1)),
+ (0x1d452, (4373, 1)),
+ (0xfb70, (2521, 1)),
+ (0x1d69f, (4938, 1)),
+ (0x1d594, (4671, 1)),
+ (0x3271, (1472, 2)),
+ (0x1e057, (5326, 1)),
+ (0x1d40, (154, 1)),
+ (0x1ee27, (5383, 1)),
+ (0xfd34, (3316, 2)),
+ (0x209b, (361, 1)),
+ (0x1d578, (4643, 1)),
+ (0xff56, (4094, 1)),
+ (0x2121, (403, 3)),
+ (0x3148, (1107, 1)),
+ (0x2f3d, (918, 1)),
+ (0x1d724, (5069, 1)),
+ (0x2166, (494, 3)),
+ (0x2f1b, (884, 1)),
+ (0x1d5ea, (4757, 1)),
+ (0xfc05, (2688, 2)),
+ (0x336a, (2062, 3)),
+ (0x24a3, (730, 3)),
+ (0x3320, (1804, 5)),
+ (0x1ee82, (5440, 1)),
+ (0x3344, (1944, 3)),
+ (0x210b, (384, 1)),
+ (0x1d560, (4619, 1)),
+ (0x1ee30, (5391, 1)),
+ (0x24e5, (834, 1)),
+ (0xffea, (4230, 1)),
+ (0x1f236, (5690, 1)),
+ (0x2037, (303, 3)),
+ (0x1e05a, (5329, 1)),
+ (0x2000, (275, 1)),
+ (0x1d7e6, (5261, 1)),
+ (0xff6d, (4117, 1)),
+ (0x3036, (1072, 1)),
+ (0x1d6f4, (5021, 1)),
+ (0x1ee18, (5372, 1)),
+ (0x1ee00, (5349, 1)),
+ (0xffb4, (4188, 1)),
+ (0x1d6a8, (4945, 1)),
+ (0x3362, (2038, 3)),
+ (0xfec2, (3936, 1)),
+ (0x2f26, (895, 1)),
+ (0x33fe, (2432, 3)),
+ (0x2034, (298, 3)),
+ (0x1cc, (54, 2)),
+ (0x33e1, (2353, 2)),
+ (0xfcc0, (3079, 2)),
+ (0x33de, (2345, 3)),
+ (0x1d5ba, (4709, 1)),
+ (0x1d47d, (4415, 1)),
+ (0xff76, (4126, 1)),
+ (0xfce2, (3149, 2)),
+ (0x217a, (534, 2)),
+ (0xfc29, (2760, 2)),
+ (0x1d6e6, (5007, 1)),
+ (0x1f139, (5608, 1)),
+ (0xff2f, (4055, 1)),
+ (0x1d7a2, (5195, 1)),
+ (0x3000, (1071, 1)),
+ (0x1d6b2, (4955, 1)),
+ (0x107a9, (4274, 1)),
+ (0xfecb, (3945, 1)),
+ (0x2f09, (866, 1)),
+ (0xfe16, (3763, 1)),
+ (0x2100, (365, 3)),
+ (0x3369, (2059, 3)),
+ (0x3322, (1814, 3)),
+ (0xfca8, (3031, 2)),
+ (0x2e0, (83, 1)),
+ (0x1d6c3, (4972, 1)),
+ (0x2147, (432, 1)),
+ (0x1d57a, (4645, 1)),
+ (0x1d6ff, (5032, 1)),
+ (0x1d5d7, (4738, 1)),
+ (0xff0f, (4023, 1)),
+ (0x3259, (1438, 2)),
+ (0x1d45, (159, 1)),
+ (0xfef5, (3987, 3)),
+ (0x1ee94, (5457, 1)),
+ (0x1d76c, (5141, 1)),
+ (0x316f, (1146, 1)),
+ (0x2f11, (874, 1)),
+ (0xff1f, (4039, 1)),
+ (0x3212, (1250, 4)),
+ (0x32c0, (1584, 2)),
+ (0xffb8, (4192, 1)),
+ (0xfc0b, (2700, 2)),
+ (0xfc04, (2685, 3)),
+ (0x1d651, (4860, 1)),
+ (0x1f215, (5657, 1)),
+ (0x3325, (1824, 3)),
+ (0x1d753, (5116, 1)),
+ (0x2fbf, (1048, 1)),
+ (0x1d73e, (5095, 1)),
+ (0xff06, (4014, 1)),
+ (0xfb67, (2512, 1)),
+ (0x3242, (1409, 3)),
+ (0x1d6c1, (4970, 1)),
+ (0xfe14, (3761, 1)),
+ (0x1d743, (5100, 1)),
+ (0xfeca, (3944, 1)),
+ (0xfe43, (3789, 1)),
+ (0x1d7d1, (5240, 1)),
+ (0x1d563, (4622, 1)),
+ (0x1f21f, (5667, 1)),
+ (0xfc0d, (2704, 2)),
+ (0x2f7c, (981, 1)),
+ (0xff82, (4138, 1)),
+ (0x3250, (1419, 3)),
+ (0x1d6df, (5000, 1)),
+ (0x1d7c1, (5226, 1)),
+ (0xfcfb, (3202, 2)),
+ (0xfd51, (3339, 3)),
+ (0x3159, (1124, 1)),
+ (0x1d422, (4325, 1)),
+ (0xfb04, (2460, 3)),
+ (0x313a, (1093, 1)),
+ (0x1d638, (4835, 1)),
+ (0x33cb, (2301, 2)),
+ (0x107a0, (4265, 1)),
+ (0x1d492, (4436, 1)),
+ (0x2460, (556, 1)),
+ (0x1d510, (4548, 1)),
+ (0x3374, (2090, 3)),
+ (0x1e032, (5289, 1)),
+ (0xfb29, (2486, 1)),
+ (0x1ee01, (5350, 1)),
+ (0x1d623, (4814, 1)),
+ (0x331d, (1793, 3)),
+ (0xffe8, (4228, 1)),
+ (0x1d531, (4579, 1)),
+ (0x1ee2a, (5385, 1)),
+ (0x2fb9, (1042, 1)),
+ (0x24e9, (838, 1)),
+ (0xfcf0, (3177, 2)),
+ (0x1d4e7, (4510, 1)),
+ (0x2fd3, (1068, 1)),
+ (0xfd62, (3390, 3)),
+ (0x1d7de, (5253, 1)),
+ (0x1ee1e, (5378, 1)),
+ (0xfdb2, (3624, 3)),
+ (0x2fb4, (1037, 1)),
+ (0xffc2, (4199, 1)),
+ (0x322c, (1343, 3)),
+ (0xfe8c, (3881, 2)),
+ (0x1d6ef, (5016, 1)),
+ (0x329f, (1536, 1)),
+ (0x10796, (4255, 1)),
+ (0x1d38, (147, 1)),
+ (0x331e, (1796, 4)),
+ (0x1d65c, (4871, 1)),
+ (0xfb76, (2527, 1)),
+ (0x1f11d, (5551, 3)),
+ (0xfc95, (2988, 2)),
+ (0x1f12c, (5594, 1)),
+ (0x1d588, (4659, 1)),
+ (0x33ee, (2384, 3)),
+ (0x24a9, (748, 3)),
+ (0x3209, (1219, 3)),
+ (0x3202, (1198, 3)),
+ (0x1d72a, (5075, 1)),
+ (0x2230, (553, 3)),
+ (0x1ee21, (5380, 1)),
+ (0x3177, (1154, 1)),
+ (0x335e, (2030, 2)),
+ (0xfeed, (3979, 1)),
+ (0x3312, (1741, 4)),
+ (0x3392, (2159, 3)),
+ (0x1d41e, (4321, 1)),
+ (0x1d5a8, (4691, 1)),
+ (0xff6b, (4115, 1)),
+ (0xfef1, (3983, 1)),
+ (0x329b, (1532, 1)),
+ (0xfb9d, (2566, 1)),
+ (0x1d69a, (4933, 1)),
+ (0x32c3, (1590, 2)),
+ (0x32b2, (1556, 2)),
+ (0xfc8f, (2976, 2)),
+ (0x216c, (509, 1)),
+ (0x1ee99, (5462, 1)),
+ (0xfdbe, (3660, 3)),
+ (0x2fb7, (1040, 1)),
+ (0x1d760, (5129, 1)),
+ (0x33c4, (2284, 2)),
+ (0xfc8a, (2966, 2)),
+ (0x1d7f9, (5280, 1)),
+ (0x1d53c, (4589, 1)),
+ (0x32cb, (1608, 3)),
+ (0xfd29, (3294, 2)),
+ (0x1f128, (5584, 3)),
+ (0x1da0, (202, 1)),
+ (0xfe9f, (3901, 1)),
+ (0x2171, (514, 2)),
+ (0x1d56b, (4630, 1)),
+ (0x1d64e, (4857, 1)),
+ (0x1d432, (4341, 1)),
+ (0x3315, (1753, 6)),
+ (0xfb64, (2509, 1)),
+ (0x3284, (1509, 1)),
+ (0x3357, (2015, 3)),
+ (0xfc35, (2784, 2)),
+ (0x2f92, (1003, 1)),
+ (0x216f, (512, 1)),
+ (0x33ab, (2222, 3)),
+ (0x1d434, (4343, 1)),
+ (0x1d4c1, (4473, 1)),
+ (0xfdbd, (3657, 3)),
+ (0x1d6bd, (4966, 1)),
+ (0x1ee34, (5394, 1)),
+ (0x1d6cc, (4981, 1)),
+ (0x1f135, (5604, 1)),
+ (0xfc9f, (3013, 2)),
+ (0x1d556, (4609, 1)),
+ (0x33c7, (2292, 3)),
+ (0xfb00, (2451, 2)),
+ (0x1d765, (5134, 1)),
+ (0x1d748, (5105, 1)),
+ (0x2084, (339, 1)),
+ (0x1d44a, (4365, 1)),
+ (0x1d62, (187, 1)),
+ (0x318c, (1175, 1)),
+ (0x2049, (314, 2)),
+ (0x32e4, (1641, 1)),
+ (0x1d552, (4605, 1)),
+ (0x1d546, (4597, 1)),
+ (0x1d624, (4815, 1)),
+ (0x1eeb9, (5487, 1)),
+ (0x1d4da, (4497, 1)),
+ (0x1ca, (50, 2)),
+ (0x3240, (1403, 3)),
+ (0xfba8, (2579, 1)),
+ (0xffdc, (4219, 1)),
+ (0x3225, (1322, 3)),
+ (0x1d799, (5186, 1)),
+ (0x1d622, (4813, 1)),
+ (0xfb28, (2485, 1)),
+ (0x303a, (1075, 1)),
+ (0xffb2, (4186, 1)),
+ (0x1d592, (4669, 1)),
+ (0x207b, (330, 1)),
+ (0x1f12a, (5590, 3)),
+ (0xfd1f, (3274, 2)),
+ (0x1f217, (5659, 1)),
+ (0x1d575, (4640, 1)),
+ (0xfcf1, (3179, 2)),
+ (0xfd6e, (3426, 3)),
+ (0x24dd, (826, 1)),
+ (0x1d605, (4784, 1)),
+ (0x1ee2f, (5390, 1)),
+ (0xfd27, (3290, 2)),
+ (0x1d52e, (4576, 1)),
+ (0x1d428, (4331, 1)),
+ (0x1ee36, (5396, 1)),
+ (0x32eb, (1648, 1)),
+ (0x1d678, (4899, 1)),
+ (0xfb14, (2469, 2)),
+ (0xff10, (4024, 1)),
+ (0x1d60e, (4793, 1)),
+ (0xfbad, (2584, 1)),
+ (0x1d570, (4635, 1)),
+ (0x2f38, (913, 1)),
+ (0x2f4a, (931, 1)),
+ (0xff3a, (4066, 1)),
+ (0x1d741, (5098, 1)),
+ (0x1d788, (5169, 1)),
+ (0x320d, (1231, 3)),
+ (0x1d64b, (4854, 1)),
+ (0x2b1, (63, 1)),
+ (0x33a6, (2207, 3)),
+ (0x1d774, (5149, 1)),
+ (0xfd2c, (3300, 2)),
+ (0x2109, (381, 2)),
+ (0x1f100, (5490, 2)),
+ (0xfc03, (2682, 3)),
+ (0x1d61, (186, 1)),
+ (0x1d7f2, (5273, 1)),
+ (0xfbab, (2582, 1)),
+ (0xffa7, (4175, 1)),
+ (0x1d664, (4879, 1)),
+ (0xfcdd, (3137, 2)),
+ (0x1d4be, (4470, 1)),
+ (0x33da, (2337, 2)),
+ (0x1d67, (192, 1)),
+ (0x2f60, (953, 1)),
+ (0x24a0, (721, 3)),
+ (0xfb56, (2495, 1)),
+ (0x24bd, (794, 1)),
+ (0xfbdf, (2604, 1)),
+ (0xffb7, (4191, 1)),
+ (0x1d77d, (5158, 1)),
+ (0x3296, (1527, 1)),
+ (0x1d5b7, (4706, 1)),
+ (0x1f23a, (5694, 1)),
+ (0x316e, (1145, 1)),
+ (0x336d, (2071, 3)),
+ (0xff7e, (4134, 1)),
+ (0x1d534, (4582, 1)),
+ (0x32a6, (1543, 1)),
+ (0x1ee7c, (5436, 1)),
+ (0x1ee2d, (5388, 1)),
+ (0xfd5b, (3369, 3)),
+ (0x331a, (1780, 6)),
+ (0x32f4, (1657, 1)),
+ (0x32bb, (1574, 2)),
+ (0x3343, (1940, 4)),
+ (0x2fd4, (1069, 1)),
+ (0xfcd2, (3115, 2)),
+ (0x2189, (543, 3)),
+ (0x107ae, (4279, 1)),
+ (0xffd3, (4212, 1)),
+ (0x2f2d, (902, 1)),
+ (0xfd56, (3354, 3)),
+ (0x2105, (374, 3)),
+ (0xfbff, (2672, 1)),
+ (0xfbea, (2615, 3)),
+ (0x1d71d, (5062, 1)),
+ (0x1ee42, (5400, 1)),
+ (0xfdfc, (3753, 4)),
+ (0x33d8, (2330, 4)),
+ (0x675, (112, 2)),
+ (0x1cb, (52, 2)),
+ (0xfd6b, (3417, 3)),
+ (0x332a, (1837, 3)),
+ (0x1d7a7, (5200, 1)),
+ (0xfb51, (2490, 1)),
+ (0x33fd, (2429, 3)),
+ (0x1ee57, (5410, 1)),
+ (0xa0, (0, 1)),
+ (0x2f2b, (900, 1)),
+ (0x1d404, (4295, 1)),
+ (0x2081, (336, 1)),
+ (0xf79, (132, 3)),
+ (0xfeec, (3978, 1)),
+ (0xfc2f, (2772, 2)),
+ (0x1d52, (171, 1)),
+ (0xff41, (4073, 1)),
+ (0x1d5ad, (4696, 1)),
+ (0x2133, (415, 1)),
+ (0x1d7ab, (5204, 1)),
+ (0x1d463, (4389, 1)),
+ (0xfe71, (3832, 2)),
+ (0xfbaf, (2586, 1)),
+ (0x1d736, (5087, 1)),
+ (0x1d5e, (183, 1)),
+ (0x2e3, (86, 1)),
+ (0xfea4, (3906, 1)),
+ (0x1e035, (5292, 1)),
+ (0x3354, (2002, 5)),
+ (0x211a, (397, 1)),
+ (0xfe8b, (3879, 2)),
+ (0x1ee5f, (5414, 1)),
+ (0x1d74f, (5112, 1)),
+ (0x1d78, (196, 1)),
+ (0x1f13f, (5614, 1)),
+ (0xffc7, (4204, 1)),
+ (0x314b, (1110, 1)),
+ (0x1d5a6, (4689, 1)),
+ (0xfd0a, (3232, 2)),
+ (0x2476, (593, 3)),
+ (0x1e037, (5294, 1)),
+ (0x1d63, (188, 1)),
+ (0xfb62, (2507, 1)),
+ (0xfdf6, (3712, 4)),
+ (0xfd7a, (3462, 3)),
+ (0xffa2, (4170, 1)),
+ (0x1c4, (35, 3)),
+ (0x1d4f4, (4523, 1)),
+ (0x3388, (2135, 3)),
+ (0x1d5a2, (4685, 1)),
+ (0x2f90, (1001, 1)),
+ (0x3281, (1506, 1)),
+ (0x1d4b2, (4460, 1)),
+ (0x1d61a, (4805, 1)),
+ (0xfcc8, (3095, 2)),
+ (0x1d61e, (4809, 1)),
+ (0xfcb3, (3053, 2)),
+ (0xfd86, (3498, 3)),
+ (0x2096, (356, 1)),
+ (0x1d714, (5053, 1)),
+ (0xfed7, (3957, 1)),
+ (0xff8c, (4148, 1)),
+ (0x2f77, (976, 1)),
+ (0x107b4, (4284, 1)),
+ (0x2089, (344, 1)),
+ (0x3207, (1213, 3)),
+ (0xfd15, (3254, 2)),
+ (0x1d6b7, (4960, 1)),
+ (0x1f134, (5603, 1)),
+ (0xfe59, (3812, 1)),
+ (0x1d6d4, (4989, 1)),
+ (0x1d708, (5041, 1)),
+ (0x1d7f6, (5277, 1)),
+ (0x1d74e, (5111, 1)),
+ (0x1d7db, (5250, 1)),
+ (0xfcbe, (3075, 2)),
+ (0x2f86, (991, 1)),
+ (0x2f35, (910, 1)),
+ (0xfb81, (2538, 1)),
+ (0x1d569, (4628, 1)),
+ (0x3189, (1172, 1)),
+ (0xfc71, (2916, 2)),
+ (0x1d45b, (4381, 1)),
+ (0xff4b, (4083, 1)),
+ (0xfbdb, (2599, 1)),
+ (0x3243, (1412, 3)),
+ (0x2b5, (67, 1)),
+ (0x1d564, (4623, 1)),
+ (0x3170, (1147, 1)),
+ (0xfbdd, (2601, 2)),
+ (0x2fce, (1063, 1)),
+ (0x215a, (466, 3)),
+ (0x2175, (522, 2)),
+ (0xfd7f, (3477, 3)),
+ (0x3380, (2119, 2)),
+ (0xff4c, (4084, 1)),
+ (0x1d6cb, (4980, 1)),
+ (0xfee2, (3968, 1)),
+ (0xffc5, (4202, 1)),
+ (0x32ae, (1551, 1)),
+ (0xfe69, (3827, 1)),
+ (0x3235, (1370, 3)),
+ (0x24bc, (793, 1)),
+ (0x2fbb, (1044, 1)),
+ (0xffa3, (4171, 1)),
+ (0x3316, (1759, 6)),
+ (0x1f12b, (5593, 1)),
+ (0xfc11, (2712, 2)),
+ (0x2f44, (925, 1)),
+ (0xfbd3, (2591, 1)),
+ (0x1d63b, (4838, 1)),
+ (0xfd0f, (3242, 2)),
+ (0x1f146, (5621, 1)),
+ (0x328e, (1519, 1)),
+ (0x309c, (1078, 2)),
+ (0x1da6, (208, 1)),
+ (0x32bd, (1578, 2)),
+ (0xfba2, (2571, 1)),
+ (0x1d527, (4569, 1)),
+ (0xfcc5, (3089, 2)),
+ (0x332d, (1850, 5)),
+ (0xfe5a, (3813, 1)),
+ (0x1d60c, (4791, 1)),
+ (0x2481, (630, 4)),
+ (0xfe4e, (3802, 1)),
+ (0xff45, (4077, 1)),
+ (0x32ef, (1652, 1)),
+ (0x1d2d, (137, 1)),
+ (0x3135, (1088, 1)),
+ (0x3342, (1937, 3)),
+ (0x1f117, (5533, 3)),
+ (0x1d72b, (5076, 1)),
+ (0x1d41, (155, 1)),
+ (0xff5d, (4101, 1)),
+ (0xfd03, (3218, 2)),
+ (0xfecc, (3946, 1)),
+ (0x1d52f, (4577, 1)),
+ (0xfc23, (2748, 2)),
+ (0x1d522, (4564, 1)),
+ (0x32f8, (1661, 1)),
+ (0x3143, (1102, 1)),
+ (0x1d450, (4371, 1)),
+ (0x2db, (77, 2)),
+ (0xfccb, (3101, 2)),
+ (0x24b1, (772, 3)),
+ (0x1d7ee, (5269, 1)),
+ (0x1d52d, (4575, 1)),
+ (0x1d792, (5179, 1)),
+ (0x2fa9, (1026, 1)),
+ (0x3206, (1210, 3)),
+ (0x2f22, (891, 1)),
+ (0x2f14, (877, 1)),
+ (0x309b, (1076, 2)),
+ (0x1eea9, (5472, 1)),
+ (0xfd74, (3444, 3)),
+ (0x1d6a, (195, 1)),
+ (0x1e05e, (5333, 1)),
+ (0x1d5d6, (4737, 1)),
+ (0x1d504, (4539, 1)),
+ (0xfc9e, (3011, 2)),
+ (0x2153, (445, 3)),
+ (0x1d421, (4324, 1)),
+ (0x1eea5, (5468, 1)),
+ (0x2f67, (960, 1)),
+ (0x3d4, (100, 2)),
+ (0xfc82, (2950, 2)),
+ (0x1ee98, (5461, 1)),
+ (0x2f1f, (888, 1)),
+ (0x1d7d3, (5242, 1)),
+ (0x3313, (1745, 6)),
+ (0x325e, (1448, 2)),
+ (0x2f74, (973, 1)),
+ (0x336c, (2068, 3)),
+ (0x2484, (642, 4)),
+ (0xfe66, (3825, 1)),
+ (0x1078b, (4244, 1)),
+ (0xfef6, (3990, 3)),
+ (0xfd85, (3495, 3)),
+ (0x1d48b, (4429, 1)),
+ (0x2487, (654, 4)),
+ (0x1d64f, (4858, 1)),
+ (0xfe7d, (3852, 2)),
+ (0xfd7c, (3468, 3)),
+ (0xfcc1, (3081, 2)),
+ (0x1d4a2, (4449, 1)),
+ (0x203e, (308, 2)),
+ (0x1d598, (4675, 1)),
+ (0x323c, (1391, 3)),
+ (0x247a, (605, 3)),
+ (0xfd12, (3248, 2)),
+ (0x1d429, (4332, 1)),
+ (0x1ee13, (5367, 1)),
+ (0xfc8d, (2972, 2)),
+ (0x2f29, (898, 1)),
+ (0x1d6a1, (4940, 1)),
+ (0x1f110, (5512, 3)),
+ (0x1d2c, (136, 1)),
+ (0x1d7b8, (5217, 1)),
+ (0x32ec, (1649, 1)),
+ (0x3145, (1104, 1)),
+ (0xfdbf, (3663, 3)),
+ (0x1d54d, (4601, 1)),
+ (0x3181, (1164, 1)),
+ (0xfc67, (2893, 3)),
+ (0xff34, (4060, 1)),
+ (0x1d6e3, (5004, 1)),
+ (0xfd70, (3432, 3)),
+ (0x1d608, (4787, 1)),
+ (0x1d711, (5050, 1)),
+ (0xff9d, (4165, 1)),
+ (0x1d51f, (4561, 1)),
+ (0x1d773, (5148, 1)),
+ (0xfd95, (3537, 3)),
+ (0xff5f, (4103, 1)),
+ (0x2174, (521, 1)),
+ (0xfec4, (3938, 1)),
+ (0x1d523, (4565, 1)),
+ (0x207c, (331, 1)),
+ (0x2faa, (1027, 1)),
+ (0x1d69e, (4937, 1)),
+ (0x2f55, (942, 1)),
+ (0x1d582, (4653, 1)),
+ (0x1d601, (4780, 1)),
+ (0x1d7aa, (5203, 1)),
+ (0x215f, (481, 2)),
+ (0xff4a, (4082, 1)),
+ (0x1d477, (4409, 1)),
+ (0x1d525, (4567, 1)),
+ (0xfda2, (3576, 3)),
+ (0xff94, (4156, 1)),
+ (0xff8e, (4150, 1)),
+ (0x1d43b, (4350, 1)),
+ (0x1d709, (5042, 1)),
+ (0x1d56d, (4632, 1)),
+ (0x33ea, (2372, 3)),
+ (0x1ee77, (5432, 1)),
+ (0x1eeac, (5474, 1)),
+ (0x334d, (1978, 4)),
+ (0x1d6a5, (4944, 1)),
+ (0x33c2, (2278, 4)),
+ (0x1d661, (4876, 1)),
+ (0xfd01, (3214, 2)),
+ (0x1d5d2, (4733, 1)),
+ (0x2008, (283, 1)),
+ (0xfd8f, (3525, 3)),
+ (0x3227, (1328, 3)),
+ (0x1d447, (4362, 1)),
+ (0x249d, (712, 3)),
+ (0x1f14b, (5627, 2)),
+ (0x1d5fc, (4775, 1)),
+ (0x1d50a, (4544, 1)),
+ (0xfb86, (2543, 1)),
+ (0x1d719, (5058, 1)),
+ (0x330f, (1729, 4)),
+ (0xfd6a, (3414, 3)),
+ (0xfc9d, (3009, 2)),
+ (0xfc3e, (2802, 2)),
+ (0x1e064, (5339, 1)),
+ (0x3d1, (96, 1)),
+ (0xffaf, (4183, 1)),
+ (0x1d433, (4342, 1)),
+ (0xfbfe, (2671, 1)),
+ (0x1d4dc, (4499, 1)),
+ (0xfbf0, (2633, 3)),
+ (0x33dd, (2343, 2)),
+ (0xfcf5, (3190, 2)),
+ (0xfce6, (3157, 2)),
+ (0x1d554, (4607, 1)),
+ (0x1fdf, (262, 3)),
+ (0x2082, (337, 1)),
+ (0xfeaf, (3917, 1)),
+ (0x1d43d, (4352, 1)),
+ (0x1c9, (48, 2)),
+ (0x1e060, (5335, 1)),
+ (0xff29, (4049, 1)),
+ (0x33b6, (2254, 2)),
+ (0xfb57, (2496, 1)),
+ (0xfeb2, (3920, 1)),
+ (0x1d703, (5036, 1)),
+ (0x1d5e9, (4756, 1)),
+ (0x24e1, (830, 1)),
+ (0x10794, (4253, 1)),
+ (0x328f, (1520, 1)),
+ (0x1e049, (5312, 1)),
+ (0x1d58c, (4663, 1)),
+ (0x335d, (2028, 2)),
+ (0x3039, (1074, 1)),
+ (0x1d46d, (4399, 1)),
+ (0x2f49, (930, 1)),
+ (0x1f222, (5670, 1)),
+ (0x32fe, (1667, 1)),
+ (0x1d79c, (5189, 1)),
+ (0x3179, (1156, 1)),
+ (0x1d697, (4930, 1)),
+ (0x1c8, (46, 2)),
+ (0x2138, (420, 1)),
+ (0x1d6ac, (4949, 1)),
+ (0xfc20, (2742, 2)),
+ (0x327e, (1503, 2)),
+ (0xfd24, (3284, 2)),
+ (0x32df, (1636, 1)),
+ (0xfc53, (2844, 2)),
+ (0xfeb9, (3927, 1)),
+ (0x1d76e, (5143, 1)),
+ (0x3378, (2099, 3)),
+ (0xff9f, (4167, 1)),
+ (0x1ee19, (5373, 1)),
+ (0x1f119, (5539, 3)),
+ (0x1d480, (4418, 1)),
+ (0xfc1d, (2736, 2)),
+ (0x30ff, (1082, 2)),
+ (0xfb63, (2508, 1)),
+ (0x1f13a, (5609, 1)),
+ (0x333c, (1914, 4)),
+ (0xfc87, (2960, 2)),
+ (0x1d45c, (4382, 1)),
+ (0xfea9, (3911, 1)),
+ (0x1d41a, (4317, 1)),
+ (0x1eebb, (5489, 1)),
+ (0x1d54e, (4602, 1)),
+ (0xffc4, (4201, 1)),
+ (0x1d423, (4326, 1)),
+ (0xfcdc, (3135, 2)),
+ (0x1d58f, (4666, 1)),
+ (0x1d456, (4376, 1)),
+ (0xfd8c, (3516, 3)),
+ (0x1d5c2, (4717, 1)),
+ (0xfdbb, (3651, 3)),
+ (0x1d67c, (4903, 1)),
+ (0x1d4ab, (4454, 1)),
+ (0x1d557, (4610, 1)),
+ (0xfce4, (3153, 2)),
+ (0x322f, (1352, 3)),
+ (0x33bc, (2266, 2)),
+ (0xfe7e, (3854, 2)),
+ (0x1d44f, (4370, 1)),
+ (0x1d74a, (5107, 1)),
+ (0x3167, (1138, 1)),
+ (0xfb9e, (2567, 1)),
+ (0xff6e, (4118, 1)),
+ (0xff90, (4152, 1)),
+ (0x1d700, (5033, 1)),
+ (0x1d431, (4340, 1)),
+ (0x1d459, (4379, 1)),
+ (0x213b, (422, 3)),
+ (0x1d779, (5154, 1)),
+ (0xfc46, (2818, 2)),
+ (0x334b, (1970, 3)),
+ (0xfc41, (2808, 2)),
+ (0x3279, (1488, 2)),
+ (0x3294, (1525, 1)),
+ (0x1d4eb, (4514, 1)),
+ (0x1d71f, (5064, 1)),
+ (0x2f28, (897, 1)),
+ (0xfbe8, (2613, 1)),
+ (0x24a2, (727, 3)),
+ (0x1d759, (5122, 1)),
+ (0xfcba, (3067, 2)),
+ (0x1d2e, (138, 1)),
+ (0xfb97, (2560, 1)),
+ (0x248c, (666, 2)),
+ (0x1da5, (207, 1)),
+ (0x33d3, (2318, 2)),
+ (0xfdf4, (3704, 4)),
+ (0x107a3, (4268, 1)),
+ (0x2f8d, (998, 1)),
+ (0x1fbf7, (5732, 1)),
+ (0x1ee7e, (5437, 1)),
+ (0xff31, (4057, 1)),
+ (0xfd04, (3220, 2)),
+ (0x323e, (1397, 3)),
+ (0x246c, (571, 2)),
+ (0x1d7e9, (5264, 1)),
+ (0xfd76, (3450, 3)),
+ (0x3328, (1832, 2)),
+ (0x1d602, (4781, 1)),
+ (0xfe60, (3819, 1)),
+ (0x1d58, (177, 1)),
+ (0xfd8e, (3522, 3)),
+ (0x320b, (1225, 3)),
+ (0x2fa4, (1021, 1)),
+ (0xfcd8, (3127, 2)),
+ (0xfcd3, (3117, 2)),
+ (0x1d446, (4361, 1)),
+ (0x3310, (1733, 4)),
+ (0x1d66a, (4885, 1)),
+ (0x33ce, (2307, 2)),
+ (0xf77, (129, 3)),
+ (0x1d7b7, (5216, 1)),
+ (0xfb8a, (2547, 1)),
+ (0x2f2f, (904, 1)),
+ (0x3372, (2086, 2)),
+ (0x2479, (602, 3)),
+ (0x24c8, (805, 1)),
+ (0x1d485, (4423, 1)),
+ (0x1d476, (4408, 1)),
+ (0x33c1, (2276, 2)),
+ (0x2f7a, (979, 1)),
+ (0x1d6f9, (5026, 1)),
+ (0x1d42b, (4334, 1)),
+ (0x1d475, (4407, 1)),
+ (0xfe51, (3805, 1)),
+ (0x1dbf, (233, 1)),
+ (0x3180, (1163, 1)),
+ (0x1d427, (4330, 1)),
+ (0x2f08, (865, 1)),
+ (0x1e03a, (5297, 1)),
+ (0x3381, (2121, 2)),
+ (0xff5e, (4102, 1)),
+ (0x1d75f, (5128, 1)),
+ (0x1f2, (58, 2)),
+ (0x1d539, (4587, 1)),
+ (0x1d4f9, (4528, 1)),
+ (0x2f43, (924, 1)),
+ (0xfd1d, (3270, 2)),
+ (0xfc1f, (2740, 2)),
+ (0x247d, (614, 4)),
+ (0xff3e, (4070, 1)),
+ (0x1d776, (5151, 1)),
+ (0x1d9f, (201, 1)),
+ (0x1ee16, (5370, 1)),
+ (0x3256, (1432, 2)),
+ (0xff7a, (4130, 1)),
+ (0x1d629, (4820, 1)),
+ (0x1ee54, (5409, 1)),
+ (0xff59, (4097, 1)),
+ (0x1d6cf, (4984, 1)),
+ (0x1d6f6, (5023, 1)),
+ (0x33b5, (2252, 2)),
+ (0x1d7b9, (5218, 1)),
+ (0xffd2, (4211, 1)),
+ (0x3358, (2018, 2)),
+ (0x2f2a, (899, 1)),
+ (0x2e1, (84, 1)),
+ (0xfc68, (2896, 3)),
+ (0x3329, (1834, 3)),
+ (0xfce1, (3147, 2)),
+ (0x1d732, (5083, 1)),
+ (0xfb54, (2493, 1)),
+ (0x1d4e4, (4507, 1)),
+ (0x222d, (548, 3)),
+ (0xfdb1, (3621, 3)),
+ (0x1d794, (5181, 1)),
+ (0xfe88, (3873, 2)),
+ (0x1d7c8, (5233, 1)),
+ (0xff43, (4075, 1)),
+ (0x1d420, (4323, 1)),
+ (0xfc3d, (2800, 2)),
+ (0xfd18, (3260, 2)),
+ (0xfe87, (3871, 2)),
+ (0x2fd0, (1065, 1)),
+ (0xfbf9, (2660, 3)),
+ (0x323b, (1388, 3)),
+ (0x1d685, (4912, 1)),
+ (0x2087, (342, 1)),
+ (0x1d75d, (5126, 1)),
+ (0x1d47, (161, 1)),
+ (0xfc42, (2810, 2)),
+ (0x2f3f, (920, 1)),
+ (0xfe82, (3861, 2)),
+ (0x1d6c5, (4974, 1)),
+ (0x1ee88, (5446, 1)),
+ (0x32e9, (1646, 1)),
+ (0x1d44d, (4368, 1)),
+ (0xfc52, (2842, 2)),
+ (0x321c, (1290, 4)),
+ (0x1fee, (268, 3)),
+ (0x1d448, (4363, 1)),
+ (0x3349, (1962, 2)),
+ (0x1d5e2, (4749, 1)),
+ (0x1f214, (5656, 1)),
+ (0x3239, (1382, 3)),
+ (0x2005, (280, 1)),
+ (0x1f11e, (5554, 3)),
+ (0x1f238, (5692, 1)),
+ (0x2f3b, (916, 1)),
+ (0xfdaf, (3615, 3)),
+ (0x1d6da, (4995, 1)),
+ (0xffec, (4232, 1)),
+ (0x1d62c, (4823, 1)),
+ (0x3226, (1325, 3)),
+ (0xff93, (4155, 1)),
+ (0x3314, (1751, 2)),
+ (0x2079, (328, 1)),
+ (0xff8f, (4151, 1)),
+ (0x3173, (1150, 1)),
+ (0x1d583, (4654, 1)),
+ (0x1fbf9, (5734, 1)),
+ (0xb4, (8, 2)),
+ (0xfdc2, (3672, 3)),
+ (0x1d32, (141, 1)),
+ (0x1d418, (4315, 1)),
+ (0xff7f, (4135, 1)),
+ (0x1f133, (5602, 1)),
+ (0x32a0, (1537, 1)),
+ (0xfd63, (3393, 3)),
+ (0x1d771, (5146, 1)),
+ (0x33ad, (2228, 3)),
+ (0x2b7, (69, 1)),
+ (0x1f211, (5652, 1)),
+ (0x1f16b, (5640, 2)),
+ (0xfb77, (2528, 1)),
+ (0xfefa, (4002, 3)),
+ (0x1d461, (4387, 1)),
+ (0x32ea, (1647, 1)),
+ (0x1d555, (4608, 1)),
+ (0x1dab, (213, 1)),
+ (0xfebc, (3930, 1)),
+ (0x1d6b1, (4954, 1)),
+ (0x317e, (1161, 1)),
+ (0x1d5b1, (4700, 1)),
+ (0xfe95, (3891, 1)),
+ (0x331f, (1800, 4)),
+ (0x1d70c, (5045, 1)),
+ (0x1d662, (4877, 1)),
+ (0x1d70e, (5047, 1)),
+ (0x1d417, (4314, 1)),
+ (0xfc10, (2710, 2)),
+ (0xfc1a, (2730, 2)),
+ (0x1d755, (5118, 1)),
+ (0x3134, (1087, 1)),
+ (0x3308, (1704, 4)),
+ (0x1d541, (4593, 1)),
+ (0x10787, (4240, 1)),
+ (0xfeac, (3914, 1)),
+ (0x1f229, (5677, 1)),
+ (0x1e046, (5309, 1)),
+ (0x24c3, (800, 1)),
+ (0x2026, (292, 3)),
+ (0x149, (32, 2)),
+ (0x33e7, (2365, 2)),
+ (0x211c, (399, 1)),
+ (0x2f58, (945, 1)),
+ (0x1d5ff, (4778, 1)),
+ (0xfe9b, (3897, 1)),
+ (0xfd2f, (3306, 2)),
+ (0x1d710, (5049, 1)),
+ (0x1d65, (190, 1)),
+ (0xfc1e, (2738, 2)),
+ (0xfd9d, (3561, 3)),
+ (0x2077, (326, 1)),
+ (0x24cb, (808, 1)),
+ (0x1eeba, (5488, 1)),
+ (0xff0e, (4022, 1)),
+ (0xfb7e, (2535, 1)),
+ (0x3337, (1895, 3)),
+ (0x248d, (668, 2)),
+ (0xfd99, (3549, 3)),
+ (0xfd65, (3399, 3)),
+ (0x1d7ac, (5205, 1)),
+ (0x1f11c, (5548, 3)),
+ (0x32ff, (1668, 2)),
+ (0x1ee7a, (5434, 1)),
+ (0x1e06b, (5346, 1)),
+ (0xfe47, (3791, 1)),
+ (0x1d637, (4834, 1)),
+ (0x3264, (1456, 1)),
+ (0xfc58, (2854, 2)),
+ (0x1d603, (4782, 1)),
+ (0x1d478, (4410, 1)),
+ (0xff0a, (4018, 1)),
+ (0xfda3, (3579, 3)),
+ (0x1d44, (158, 1)),
+ (0x24d0, (813, 1)),
+ (0xab5e, (2448, 1)),
+ (0xfcfc, (3204, 2)),
+ (0xffe0, (4220, 1)),
+ (0x1ee0a, (5358, 1)),
+ (0x313d, (1096, 1)),
+ (0x3398, (2174, 2)),
+ (0xfcd0, (3111, 2)),
+ (0x2f6e, (967, 1)),
+ (0x202f, (295, 1)),
+ (0xfcaa, (3035, 2)),
+ (0x1d43a, (4349, 1)),
+ (0xfd23, (3282, 2)),
+ (0x2ef3, (856, 1)),
+ (0xfe5f, (3818, 1)),
+ (0x2f93, (1004, 1)),
+ (0x2086, (341, 1)),
+ (0xfd6d, (3423, 3)),
+ (0x249f, (718, 3)),
+ (0x1d424, (4327, 1)),
+ (0x1fbf8, (5733, 1)),
+ (0x1d462, (4388, 1)),
+ (0xfe4d, (3801, 1)),
+ (0x1d53b, (4588, 1)),
+ (0xfe49, (3793, 2)),
+ (0x1d6ab, (4948, 1)),
+ (0x3132, (1085, 1)),
+ (0x1d7c2, (5227, 1)),
+ (0xfd9c, (3558, 3)),
+ (0x2fc2, (1051, 1)),
+ (0x33f4, (2402, 3)),
+ (0x213c, (425, 1)),
+ (0x1d7e8, (5263, 1)),
+ (0xff88, (4144, 1)),
+ (0x1d79d, (5190, 1)),
+ (0x24c1, (798, 1)),
+ (0x24e0, (829, 1)),
+ (0x1eeb8, (5486, 1)),
+ (0xfc70, (2914, 2)),
+ (0xfc6c, (2906, 2)),
+ (0x2fac, (1029, 1)),
+ (0x1f202, (5650, 1)),
+ (0xfbf3, (2642, 3)),
+ (0x2f78, (977, 1)),
+ (0x3255, (1430, 2)),
+ (0x2f2e, (903, 1)),
+ (0xfb24, (2481, 1)),
+ (0x32af, (1552, 1)),
+ (0x1d4a, (164, 1)),
+ (0x2f25, (894, 1)),
+ (0x1ee6e, (5424, 1)),
+ (0xfd2d, (3302, 2)),
+ (0xff6a, (4114, 1)),
+ (0x2466, (562, 1)),
+ (0x1d579, (4644, 1)),
+ (0x1f231, (5685, 1)),
+ (0xfc61, (2875, 3)),
+ (0x1d7fd, (5284, 1)),
+ (0xfd5f, (3381, 3)),
+ (0x1ee1a, (5374, 1)),
+ (0x3348, (1958, 4)),
+ (0xfba9, (2580, 1)),
+ (0x1d45f, (4385, 1)),
+ (0x1d66d, (4888, 1)),
+ (0xfce8, (3161, 2)),
+ (0xfb5b, (2500, 1)),
+ (0x1ee62, (5416, 1)),
+ (0x3146, (1105, 1)),
+ (0x33ac, (2225, 3)),
+ (0x1f149, (5624, 1)),
+ (0x3295, (1526, 1)),
+ (0x3333, (1877, 4)),
+ (0xfc0f, (2708, 2)),
+ (0xff8a, (4146, 1)),
+ (0x3387, (2133, 2)),
+ (0x676, (114, 2)),
+ (0xffcd, (4208, 1)),
+ (0xfe86, (3869, 2)),
+ (0x1d6e8, (5009, 1)),
+ (0xfc40, (2806, 2)),
+ (0xfc0a, (2698, 2)),
+ (0x10788, (4241, 1)),
+ (0x2fc0, (1049, 1)),
+ (0x1d5b6, (4705, 1)),
+ (0xffa8, (4176, 1)),
+ (0x3289, (1514, 1)),
+ (0xfd79, (3459, 3)),
+ (0x3300, (1670, 5)),
+ (0x1d55, (174, 1)),
+ (0x24b5, (784, 3)),
+ (0x2f4c, (933, 1)),
+ (0x3163, (1134, 1)),
+ (0x2002, (277, 1)),
+ (0x2f57, (944, 1)),
+ (0xfcdb, (3133, 2)),
+ (0x1d49f, (4448, 1)),
+ (0x1d688, (4915, 1)),
+ (0xff18, (4032, 1)),
+ (0x2f54, (941, 1)),
+ (0x1ee85, (5443, 1)),
+ (0x2fd1, (1066, 1)),
+ (0x33c5, (2286, 2)),
+ (0xfb53, (2492, 1)),
+ (0x3197, (1183, 1)),
+ (0x2fcf, (1064, 1)),
+ (0x1d516, (4553, 1)),
+ (0x3201, (1195, 3)),
+ (0xfd82, (3486, 3)),
+ (0xff16, (4030, 1)),
+ (0x2150, (435, 3)),
+ (0x1f109, (5508, 2)),
+ (0xfe9d, (3899, 1)),
+ (0x210f, (388, 1)),
+ (0x320e, (1234, 4)),
+ (0x1e040, (5303, 1)),
+ (0x330a, (1711, 3)),
+ (0x1ee0e, (5362, 1)),
+ (0xfc45, (2816, 2)),
+ (0xff48, (4080, 1)),
+ (0xfc47, (2820, 2)),
+ (0x1d505, (4540, 1)),
+ (0x2169, (503, 1)),
+ (0x24dc, (825, 1)),
+ (0x1d7d8, (5247, 1)),
+ (0xfb55, (2494, 1)),
+ (0xfe84, (3865, 2)),
+ (0x1ee22, (5381, 1)),
+ (0x1d772, (5147, 1)),
+ (0x33f0, (2390, 3)),
+ (0x1d4b1, (4459, 1)),
+ (0xff99, (4161, 1)),
+ (0xfd2e, (3304, 2)),
+ (0x2159, (463, 3)),
+ (0x1d58d, (4664, 1)),
+ (0x1d627, (4818, 1)),
+ (0xfeeb, (3977, 1)),
+ (0x3334, (1881, 6)),
+ (0x1f126, (5578, 3)),
+ (0x3144, (1103, 1)),
+ (0x1e036, (5293, 1)),
+ (0x1db9, (227, 1)),
+ (0x1d6ea, (5011, 1)),
+ (0x1d6ee, (5015, 1)),
+ (0xfec6, (3940, 1)),
+ (0x1d64c, (4855, 1)),
+ (0xfcbb, (3069, 2)),
+ (0x2033, (296, 2)),
+ (0x2009, (284, 1)),
+ (0x3377, (2097, 2)),
+ (0x3160, (1131, 1)),
+ (0x1d48c, (4430, 1)),
+ (0x24b3, (778, 3)),
+ (0x1d4d0, (4487, 1)),
+ (0xffcb, (4206, 1)),
+ (0xfdad, (3609, 3)),
+ (0x1ee8b, (5448, 1)),
+ (0xfeb1, (3919, 1)),
+ (0xfcea, (3165, 2)),
+ (0x2f76, (975, 1)),
+ (0x32be, (1580, 2)),
+ (0x1d7b1, (5210, 1)),
+ (0x1d5f8, (4771, 1)),
+ (0xfd73, (3441, 3)),
+ (0xff1a, (4034, 1)),
+ (0xfca2, (3019, 2)),
+ (0x211b, (398, 1)),
+ (0x1d5b2, (4701, 1)),
+ (0xfb60, (2505, 1)),
+ (0x1ee2e, (5389, 1)),
+ (0x2071, (322, 1)),
+ (0x1d4bb, (4468, 1)),
+ (0x33fc, (2426, 3)),
+ (0xfeef, (3981, 1)),
+ (0x1d4fb, (4530, 1)),
+ (0x1d728, (5073, 1)),
+ (0xfcff, (3210, 2)),
+ (0x1d6f8, (5025, 1)),
+ (0x1d535, (4583, 1)),
+ (0x1d34, (143, 1)),
+ (0x2165, (492, 2)),
+ (0x1ee2c, (5387, 1)),
+ (0x1d5dd, (4744, 1)),
+ (0x2140, (429, 1)),
+ (0x322d, (1346, 3)),
+ (0x1ee96, (5459, 1)),
+ (0xffbe, (4198, 1)),
+ (0x1eeb5, (5483, 1)),
+ (0x3311, (1737, 4)),
+ (0xfd89, (3507, 3)),
+ (0x32d7, (1628, 1)),
+ (0x2f91, (1002, 1)),
+ (0x10798, (4257, 1)),
+ (0x246b, (569, 2)),
+ (0x24c2, (799, 1)),
+ (0x1d50e, (4546, 1)),
+ (0xffbc, (4196, 1)),
+ (0xfd9e, (3564, 3)),
+ (0x2115, (393, 1)),
+ (0x1d715, (5054, 1)),
+ (0xfcac, (3039, 2)),
+ (0xfc98, (2995, 3)),
+ (0xfc66, (2890, 3)),
+ (0x2d6f, (854, 1)),
+ (0x1d59c, (4679, 1)),
+ (0xfc01, (2676, 3)),
+ (0x1ee49, (5402, 1)),
+ (0x2119, (396, 1)),
+ (0x24d7, (820, 1)),
+ (0x1d642, (4845, 1)),
+ (0x3304, (1687, 5)),
+ (0x3198, (1184, 1)),
+ (0xfed4, (3954, 1)),
+ (0x2f6c, (965, 1)),
+ (0x1d406, (4297, 1)),
+ (0x1d61d, (4808, 1)),
+ (0x33d5, (2322, 3)),
+ (0x1ee07, (5355, 1)),
+ (0x1d4ce, (4485, 1)),
+ (0x1f101, (5492, 2)),
+ (0x10792, (4251, 1)),
+ (0x24be, (795, 1)),
+ (0x2fbc, (1045, 1)),
+ (0x1f14f, (5636, 2)),
+ (0xfe12, (3759, 1)),
+ (0xfec7, (3941, 1)),
+ (0xfc2d, (2768, 2)),
+ (0x248a, (662, 2)),
+ (0x1fed, (265, 3)),
+ (0x1d6d5, (4990, 1)),
+ (0x2fb2, (1035, 1)),
+ (0xfc8b, (2968, 2)),
+ (0x3158, (1123, 1)),
+ (0xffe3, (4223, 2)),
+ (0xfb84, (2541, 1)),
+ (0xfb65, (2510, 1)),
+ (0x1ee93, (5456, 1)),
+ (0x3208, (1216, 3)),
+ (0x32fc, (1665, 1)),
+ (0xfe94, (3890, 1)),
+ (0x2f4f, (936, 1)),
+ (0x2f87, (992, 1)),
+ (0x1ee75, (5430, 1)),
+ (0x2057, (316, 4)),
+ (0x1d617, (4802, 1)),
+ (0x1d5e1, (4748, 1)),
+ (0xfdac, (3606, 3)),
+ (0x2f0e, (871, 1)),
+ (0x211d, (400, 1)),
+ (0x331c, (1790, 3)),
+ (0x2f83, (988, 1)),
+ (0x1d5c3, (4718, 1)),
+ (0x3373, (2088, 2)),
+ (0x1f13b, (5610, 1)),
+ (0x2486, (650, 4)),
+ (0x1d665, (4880, 1)),
+ (0xfce0, (3144, 3)),
+ (0x3d3, (98, 2)),
+ (0x1d403, (4294, 1)),
+ (0x1d640, (4843, 1)),
+ (0x24ac, (757, 3)),
+ (0x2f39, (914, 1)),
+ (0x1f140, (5615, 1)),
+ (0xfb6f, (2520, 1)),
+ (0xfd13, (3250, 2)),
+ (0x1d4c6, (4477, 1)),
+ (0x1f248, (5720, 3)),
+ (0x3183, (1166, 1)),
+ (0x1d62e, (4825, 1)),
+ (0x1f148, (5623, 1)),
+ (0xfb89, (2546, 1)),
+ (0x1ee81, (5439, 1)),
+ (0xfc25, (2752, 2)),
+ (0x1f223, (5671, 1)),
+ (0x334e, (1982, 4)),
+ (0x2fd2, (1067, 1)),
+ (0xfd54, (3348, 3)),
+ (0xff01, (4009, 1)),
+ (0x1d740, (5097, 1)),
+ (0x1d7bc, (5221, 1)),
+ (0x1db4, (222, 1)),
+ (0x1d43e, (4353, 1)),
+ (0xfca9, (3033, 2)),
+ (0xfd22, (3280, 2)),
+ (0x2f23, (892, 1)),
+ (0x314e, (1113, 1)),
+ (0xfe8a, (3877, 2)),
+ (0xff03, (4011, 1)),
+ (0x3292, (1523, 1)),
+ (0xfcf6, (3192, 2)),
+ (0x1d3f, (153, 1)),
+ (0x1db8, (226, 1)),
+ (0xfe68, (3826, 1)),
+ (0x1d69, (194, 1)),
+ (0x1079b, (4260, 1)),
+ (0x331b, (1786, 4)),
+ (0xfda7, (3591, 3)),
+ (0xffdb, (4218, 1)),
+ (0xfc7c, (2938, 2)),
+ (0xfda5, (3585, 3)),
+ (0x3341, (1934, 3)),
+ (0x24a7, (742, 3)),
+ (0x3216, (1266, 4)),
+ (0x2f3e, (919, 1)),
+ (0xff9c, (4164, 1)),
+ (0xfb20, (2477, 1)),
+ (0x1f116, (5530, 3)),
+ (0x325b, (1442, 2)),
+ (0x1d5e6, (4753, 1)),
+ (0x1d79e, (5191, 1)),
+ (0x1ee14, (5368, 1)),
+ (0x333f, (1927, 2)),
+ (0x32d4, (1625, 1)),
+ (0x1f22d, (5681, 1)),
+ (0xfd88, (3504, 3)),
+ (0x1d4d9, (4496, 1)),
+ (0xfdaa, (3600, 3)),
+ (0xfcc6, (3091, 2)),
+ (0x1d56e, (4633, 1)),
+ (0x1ee39, (5398, 1)),
+ (0x1d48a, (4428, 1)),
+ (0x1d7d0, (5239, 1)),
+ (0xb9, (13, 1)),
+ (0x1f120, (5560, 3)),
+ (0x1d60b, (4790, 1)),
+ (0x2f70, (969, 1)),
+ (0x1d4fa, (4529, 1)),
+ (0x2f5c, (949, 1)),
+ (0x32ab, (1548, 1)),
+ (0xfba3, (2572, 1)),
+ (0x2f02, (859, 1)),
+ (0x1f11f, (5557, 3)),
+ (0xfc69, (2899, 3)),
+ (0x24d4, (817, 1)),
+ (0x2491, (676, 3)),
+ (0x326b, (1463, 1)),
+ (0xfc08, (2694, 2)),
+ (0x1d7b2, (5211, 1)),
+ (0x33ff, (2435, 3)),
+ (0xfb8d, (2550, 1)),
+ (0x1fbf0, (5725, 1)),
+ (0x3252, (1424, 2)),
+ (0x1d6e5, (5006, 1)),
+ (0x1d5ac, (4695, 1)),
+ (0xfb94, (2557, 1)),
+ (0x2f63, (956, 1)),
+ (0x107a2, (4267, 1)),
+ (0xfc06, (2690, 2)),
+ (0xfc5a, (2858, 2)),
+ (0xff75, (4125, 1)),
+ (0xfeda, (3960, 1)),
+ (0xff79, (4129, 1)),
+ (0x2462, (558, 1)),
+ (0xfc09, (2696, 2)),
+ (0x2111, (390, 1)),
+ (0x319e, (1190, 1)),
+ (0x1d451, (4372, 1)),
+ (0x2f20, (889, 1)),
+ (0x1d6a0, (4939, 1)),
+ (0x1d577, (4642, 1)),
+ (0x1d7b6, (5215, 1)),
+ (0xff15, (4029, 1)),
+ (0x1d744, (5101, 1)),
+ (0x1f21c, (5664, 1)),
+ (0x1fbf2, (5727, 1)),
+ (0xfc3a, (2794, 2)),
+ (0x337b, (2107, 2)),
+ (0xfdb8, (3642, 3)),
+ (0xffc3, (4200, 1)),
+ (0x33db, (2339, 2)),
+ (0xff0c, (4020, 1)),
+ (0x1d52a, (4572, 1)),
+ (0x1ee9b, (5464, 1)),
+ (0x24e2, (831, 1)),
+ (0xff9e, (4166, 1)),
+ (0x32de, (1635, 1)),
+ (0x1d574, (4639, 1)),
+ (0x1ee76, (5431, 1)),
+ (0x1d59e, (4681, 1)),
+ (0x1f244, (5708, 3)),
+ (0x1f137, (5606, 1)),
+ (0xfea0, (3902, 1)),
+ (0xff2a, (4050, 1)),
+ (0x314f, (1114, 1)),
+ (0x1d47c, (4414, 1)),
+ (0x1d467, (4393, 1)),
+ (0xff4f, (4087, 1)),
+ (0xfea1, (3903, 1)),
+ (0x33a9, (2217, 2)),
+ (0x10799, (4258, 1)),
+ (0x1ee12, (5366, 1)),
+ (0x2492, (679, 3)),
+ (0x1d696, (4929, 1)),
+ (0xfcab, (3037, 2)),
+ (0xfd19, (3262, 2)),
+ (0x1d5e8, (4755, 1)),
+ (0x1ee1f, (5379, 1)),
+ (0xfe91, (3887, 1)),
+ (0x1c7, (44, 2)),
+ (0x1d681, (4908, 1)),
+ (0x24b7, (788, 1)),
+ (0x1d784, (5165, 1)),
+ (0x1d742, (5099, 1)),
+ (0x33a2, (2196, 3)),
+ (0x1d645, (4848, 1)),
+ (0x1ee70, (5426, 1)),
+ (0x1d611, (4796, 1)),
+ (0x337c, (2109, 2)),
+ (0x1d442, (4357, 1)),
+ (0xfe32, (3772, 1)),
+ (0x1d31, (140, 1)),
+ (0x3138, (1091, 1)),
+ (0x2485, (646, 4)),
+ (0x1f114, (5524, 3)),
+ (0x1d5d0, (4731, 1)),
+ (0x1d635, (4832, 1)),
+ (0x3309, (1708, 3)),
+ (0x1d408, (4299, 1)),
+ (0xfe50, (3804, 1)),
+ (0x1ee8d, (5450, 1)),
+ (0xfd93, (3531, 3)),
+ (0x1d67b, (4902, 1)),
+ (0x1d4db, (4498, 1)),
+ (0x1f136, (5605, 1)),
+ (0x1f22f, (5683, 1)),
+ (0x1d7ed, (5268, 1)),
+ (0x32f9, (1662, 1)),
+ (0x32aa, (1547, 1)),
+ (0x33af, (2236, 6)),
+ (0x24e4, (833, 1)),
+ (0x2003, (278, 1)),
+ (0xfd80, (3480, 3)),
+ (0x1e04e, (5317, 1)),
+ (0x1d59b, (4678, 1)),
+ (0x3285, (1510, 1)),
+ (0x1d78e, (5175, 1)),
+ (0x3379, (2102, 3)),
+ (0x107b2, (4282, 1)),
+ (0xfeb7, (3925, 1)),
+ (0x2470, (579, 2)),
+ (0x1d620, (4811, 1)),
+ (0x1d4b4, (4462, 1)),
+ (0x1d754, (5117, 1)),
+ (0x1f246, (5714, 3)),
+ (0x2160, (483, 1)),
+ (0x1d72f, (5080, 1)),
+ (0xfe4f, (3803, 1)),
+ (0x1d47a, (4412, 1)),
+ (0x1fcd, (247, 3)),
+ (0x327d, (1499, 4)),
+ (0x338e, (2150, 2)),
+ (0x33b3, (2248, 2)),
+ (0xfd10, (3244, 2)),
+ (0x2f37, (912, 1)),
+ (0x3187, (1170, 1)),
+ (0xff5c, (4100, 1)),
+ (0x2135, (417, 1)),
+ (0x1d73b, (5092, 1)),
+ (0x3178, (1155, 1)),
+ (0xfc86, (2958, 2)),
+ (0x2fa5, (1022, 1)),
+ (0x1d6f1, (5018, 1)),
+ (0x1db5, (223, 1)),
+ (0xfb7d, (2534, 1)),
+ (0xfc48, (2822, 2)),
+ (0x1d56, (175, 1)),
+ (0x1d647, (4850, 1)),
+ (0xfe65, (3824, 1)),
+ (0xfc18, (2726, 2)),
+ (0x33f1, (2393, 3)),
+ (0x328c, (1517, 1)),
+ (0x32b9, (1570, 2)),
+ (0xfb79, (2530, 1)),
+ (0x1d4ee, (4517, 1)),
+ (0x338f, (2152, 2)),
+ (0x1d663, (4878, 1)),
+ (0x33b7, (2256, 2)),
+ (0x1d55a, (4613, 1)),
+ (0xfcb1, (3049, 2)),
+ (0x3254, (1428, 2)),
+ (0xfbde, (2603, 1)),
+ (0x2f73, (972, 1)),
+ (0x1d497, (4441, 1)),
+ (0xff89, (4145, 1)),
+ (0x1d5f5, (4768, 1)),
+];
+
+pub(crate) const CJK_COMPAT_VARIANTS_DECOMPOSED_CHARS: &[char] = &[
+ '\u{349E}',
+ '\u{FE00}',
+ '\u{34B9}',
+ '\u{FE00}',
+ '\u{34BB}',
+ '\u{FE00}',
+ '\u{34DF}',
+ '\u{FE00}',
+ '\u{3515}',
+ '\u{FE00}',
+ '\u{36EE}',
+ '\u{FE00}',
+ '\u{36FC}',
+ '\u{FE00}',
+ '\u{3781}',
+ '\u{FE00}',
+ '\u{382F}',
+ '\u{FE00}',
+ '\u{3862}',
+ '\u{FE00}',
+ '\u{387C}',
+ '\u{FE00}',
+ '\u{38C7}',
+ '\u{FE00}',
+ '\u{38E3}',
+ '\u{FE00}',
+ '\u{391C}',
+ '\u{FE00}',
+ '\u{393A}',
+ '\u{FE00}',
+ '\u{3A2E}',
+ '\u{FE00}',
+ '\u{3A6C}',
+ '\u{FE00}',
+ '\u{3AE4}',
+ '\u{FE00}',
+ '\u{3B08}',
+ '\u{FE00}',
+ '\u{3B19}',
+ '\u{FE00}',
+ '\u{3B49}',
+ '\u{FE00}',
+ '\u{3B9D}',
+ '\u{FE00}',
+ '\u{3B9D}',
+ '\u{FE01}',
+ '\u{3C18}',
+ '\u{FE00}',
+ '\u{3C4E}',
+ '\u{FE00}',
+ '\u{3D33}',
+ '\u{FE00}',
+ '\u{3D96}',
+ '\u{FE00}',
+ '\u{3EAC}',
+ '\u{FE00}',
+ '\u{3EB8}',
+ '\u{FE00}',
+ '\u{3EB8}',
+ '\u{FE01}',
+ '\u{3F1B}',
+ '\u{FE00}',
+ '\u{3FFC}',
+ '\u{FE00}',
+ '\u{4008}',
+ '\u{FE00}',
+ '\u{4018}',
+ '\u{FE00}',
+ '\u{4039}',
+ '\u{FE00}',
+ '\u{4039}',
+ '\u{FE01}',
+ '\u{4046}',
+ '\u{FE00}',
+ '\u{4096}',
+ '\u{FE00}',
+ '\u{40E3}',
+ '\u{FE00}',
+ '\u{412F}',
+ '\u{FE00}',
+ '\u{4202}',
+ '\u{FE00}',
+ '\u{4227}',
+ '\u{FE00}',
+ '\u{42A0}',
+ '\u{FE00}',
+ '\u{4301}',
+ '\u{FE00}',
+ '\u{4334}',
+ '\u{FE00}',
+ '\u{4359}',
+ '\u{FE00}',
+ '\u{43D5}',
+ '\u{FE00}',
+ '\u{43D9}',
+ '\u{FE00}',
+ '\u{440B}',
+ '\u{FE00}',
+ '\u{446B}',
+ '\u{FE00}',
+ '\u{452B}',
+ '\u{FE00}',
+ '\u{455D}',
+ '\u{FE00}',
+ '\u{4561}',
+ '\u{FE00}',
+ '\u{456B}',
+ '\u{FE00}',
+ '\u{45D7}',
+ '\u{FE00}',
+ '\u{45F9}',
+ '\u{FE00}',
+ '\u{4635}',
+ '\u{FE00}',
+ '\u{46BE}',
+ '\u{FE00}',
+ '\u{46C7}',
+ '\u{FE00}',
+ '\u{4995}',
+ '\u{FE00}',
+ '\u{49E6}',
+ '\u{FE00}',
+ '\u{4A6E}',
+ '\u{FE00}',
+ '\u{4A76}',
+ '\u{FE00}',
+ '\u{4AB2}',
+ '\u{FE00}',
+ '\u{4B33}',
+ '\u{FE00}',
+ '\u{4BCE}',
+ '\u{FE00}',
+ '\u{4CCE}',
+ '\u{FE00}',
+ '\u{4CED}',
+ '\u{FE00}',
+ '\u{4CF8}',
+ '\u{FE00}',
+ '\u{4D56}',
+ '\u{FE00}',
+ '\u{4E0D}',
+ '\u{FE00}',
+ '\u{4E26}',
+ '\u{FE00}',
+ '\u{4E32}',
+ '\u{FE00}',
+ '\u{4E38}',
+ '\u{FE00}',
+ '\u{4E39}',
+ '\u{FE00}',
+ '\u{4E3D}',
+ '\u{FE00}',
+ '\u{4E41}',
+ '\u{FE00}',
+ '\u{4E82}',
+ '\u{FE00}',
+ '\u{4E86}',
+ '\u{FE00}',
+ '\u{4EAE}',
+ '\u{FE00}',
+ '\u{4EC0}',
+ '\u{FE00}',
+ '\u{4ECC}',
+ '\u{FE00}',
+ '\u{4EE4}',
+ '\u{FE00}',
+ '\u{4F60}',
+ '\u{FE00}',
+ '\u{4F80}',
+ '\u{FE00}',
+ '\u{4F86}',
+ '\u{FE00}',
+ '\u{4F8B}',
+ '\u{FE00}',
+ '\u{4FAE}',
+ '\u{FE00}',
+ '\u{4FAE}',
+ '\u{FE01}',
+ '\u{4FBB}',
+ '\u{FE00}',
+ '\u{4FBF}',
+ '\u{FE00}',
+ '\u{5002}',
+ '\u{FE00}',
+ '\u{502B}',
+ '\u{FE00}',
+ '\u{507A}',
+ '\u{FE00}',
+ '\u{5099}',
+ '\u{FE00}',
+ '\u{50CF}',
+ '\u{FE00}',
+ '\u{50DA}',
+ '\u{FE00}',
+ '\u{50E7}',
+ '\u{FE00}',
+ '\u{50E7}',
+ '\u{FE01}',
+ '\u{5140}',
+ '\u{FE00}',
+ '\u{5145}',
+ '\u{FE00}',
+ '\u{514D}',
+ '\u{FE00}',
+ '\u{514D}',
+ '\u{FE01}',
+ '\u{5154}',
+ '\u{FE00}',
+ '\u{5164}',
+ '\u{FE00}',
+ '\u{5167}',
+ '\u{FE00}',
+ '\u{5168}',
+ '\u{FE00}',
+ '\u{5169}',
+ '\u{FE00}',
+ '\u{516D}',
+ '\u{FE00}',
+ '\u{5177}',
+ '\u{FE00}',
+ '\u{5180}',
+ '\u{FE00}',
+ '\u{518D}',
+ '\u{FE00}',
+ '\u{5192}',
+ '\u{FE00}',
+ '\u{5195}',
+ '\u{FE00}',
+ '\u{5197}',
+ '\u{FE00}',
+ '\u{51A4}',
+ '\u{FE00}',
+ '\u{51AC}',
+ '\u{FE00}',
+ '\u{51B5}',
+ '\u{FE00}',
+ '\u{51B5}',
+ '\u{FE01}',
+ '\u{51B7}',
+ '\u{FE00}',
+ '\u{51C9}',
+ '\u{FE00}',
+ '\u{51CC}',
+ '\u{FE00}',
+ '\u{51DC}',
+ '\u{FE00}',
+ '\u{51DE}',
+ '\u{FE00}',
+ '\u{51F5}',
+ '\u{FE00}',
+ '\u{5203}',
+ '\u{FE00}',
+ '\u{5207}',
+ '\u{FE00}',
+ '\u{5207}',
+ '\u{FE01}',
+ '\u{5217}',
+ '\u{FE00}',
+ '\u{5229}',
+ '\u{FE00}',
+ '\u{523A}',
+ '\u{FE00}',
+ '\u{523B}',
+ '\u{FE00}',
+ '\u{5246}',
+ '\u{FE00}',
+ '\u{5272}',
+ '\u{FE00}',
+ '\u{5277}',
+ '\u{FE00}',
+ '\u{5289}',
+ '\u{FE00}',
+ '\u{529B}',
+ '\u{FE00}',
+ '\u{52A3}',
+ '\u{FE00}',
+ '\u{52B3}',
+ '\u{FE00}',
+ '\u{52C7}',
+ '\u{FE00}',
+ '\u{52C7}',
+ '\u{FE01}',
+ '\u{52C9}',
+ '\u{FE00}',
+ '\u{52C9}',
+ '\u{FE01}',
+ '\u{52D2}',
+ '\u{FE00}',
+ '\u{52DE}',
+ '\u{FE00}',
+ '\u{52E4}',
+ '\u{FE00}',
+ '\u{52E4}',
+ '\u{FE01}',
+ '\u{52F5}',
+ '\u{FE00}',
+ '\u{52FA}',
+ '\u{FE00}',
+ '\u{52FA}',
+ '\u{FE01}',
+ '\u{5305}',
+ '\u{FE00}',
+ '\u{5306}',
+ '\u{FE00}',
+ '\u{5317}',
+ '\u{FE00}',
+ '\u{5317}',
+ '\u{FE01}',
+ '\u{533F}',
+ '\u{FE00}',
+ '\u{5349}',
+ '\u{FE00}',
+ '\u{5351}',
+ '\u{FE00}',
+ '\u{5351}',
+ '\u{FE01}',
+ '\u{535A}',
+ '\u{FE00}',
+ '\u{5373}',
+ '\u{FE00}',
+ '\u{5375}',
+ '\u{FE00}',
+ '\u{537D}',
+ '\u{FE00}',
+ '\u{537F}',
+ '\u{FE00}',
+ '\u{537F}',
+ '\u{FE01}',
+ '\u{537F}',
+ '\u{FE02}',
+ '\u{53C3}',
+ '\u{FE00}',
+ '\u{53CA}',
+ '\u{FE00}',
+ '\u{53DF}',
+ '\u{FE00}',
+ '\u{53E5}',
+ '\u{FE00}',
+ '\u{53EB}',
+ '\u{FE00}',
+ '\u{53F1}',
+ '\u{FE00}',
+ '\u{5406}',
+ '\u{FE00}',
+ '\u{540F}',
+ '\u{FE00}',
+ '\u{541D}',
+ '\u{FE00}',
+ '\u{5438}',
+ '\u{FE00}',
+ '\u{5442}',
+ '\u{FE00}',
+ '\u{5448}',
+ '\u{FE00}',
+ '\u{5468}',
+ '\u{FE00}',
+ '\u{549E}',
+ '\u{FE00}',
+ '\u{54A2}',
+ '\u{FE00}',
+ '\u{54BD}',
+ '\u{FE00}',
+ '\u{54F6}',
+ '\u{FE00}',
+ '\u{5510}',
+ '\u{FE00}',
+ '\u{5553}',
+ '\u{FE00}',
+ '\u{5555}',
+ '\u{FE00}',
+ '\u{5563}',
+ '\u{FE00}',
+ '\u{5584}',
+ '\u{FE00}',
+ '\u{5584}',
+ '\u{FE01}',
+ '\u{5587}',
+ '\u{FE00}',
+ '\u{5599}',
+ '\u{FE00}',
+ '\u{5599}',
+ '\u{FE01}',
+ '\u{559D}',
+ '\u{FE00}',
+ '\u{559D}',
+ '\u{FE01}',
+ '\u{55AB}',
+ '\u{FE00}',
+ '\u{55B3}',
+ '\u{FE00}',
+ '\u{55C0}',
+ '\u{FE00}',
+ '\u{55C2}',
+ '\u{FE00}',
+ '\u{55E2}',
+ '\u{FE00}',
+ '\u{5606}',
+ '\u{FE00}',
+ '\u{5606}',
+ '\u{FE01}',
+ '\u{5651}',
+ '\u{FE00}',
+ '\u{5668}',
+ '\u{FE00}',
+ '\u{5674}',
+ '\u{FE00}',
+ '\u{56F9}',
+ '\u{FE00}',
+ '\u{5716}',
+ '\u{FE00}',
+ '\u{5717}',
+ '\u{FE00}',
+ '\u{578B}',
+ '\u{FE00}',
+ '\u{57CE}',
+ '\u{FE00}',
+ '\u{57F4}',
+ '\u{FE00}',
+ '\u{580D}',
+ '\u{FE00}',
+ '\u{5831}',
+ '\u{FE00}',
+ '\u{5832}',
+ '\u{FE00}',
+ '\u{5840}',
+ '\u{FE00}',
+ '\u{585A}',
+ '\u{FE00}',
+ '\u{585A}',
+ '\u{FE01}',
+ '\u{585E}',
+ '\u{FE00}',
+ '\u{58A8}',
+ '\u{FE00}',
+ '\u{58AC}',
+ '\u{FE00}',
+ '\u{58B3}',
+ '\u{FE00}',
+ '\u{58D8}',
+ '\u{FE00}',
+ '\u{58DF}',
+ '\u{FE00}',
+ '\u{58EE}',
+ '\u{FE00}',
+ '\u{58F2}',
+ '\u{FE00}',
+ '\u{58F7}',
+ '\u{FE00}',
+ '\u{5906}',
+ '\u{FE00}',
+ '\u{591A}',
+ '\u{FE00}',
+ '\u{5922}',
+ '\u{FE00}',
+ '\u{5944}',
+ '\u{FE00}',
+ '\u{5948}',
+ '\u{FE00}',
+ '\u{5951}',
+ '\u{FE00}',
+ '\u{5954}',
+ '\u{FE00}',
+ '\u{5962}',
+ '\u{FE00}',
+ '\u{5973}',
+ '\u{FE00}',
+ '\u{59D8}',
+ '\u{FE00}',
+ '\u{59EC}',
+ '\u{FE00}',
+ '\u{5A1B}',
+ '\u{FE00}',
+ '\u{5A27}',
+ '\u{FE00}',
+ '\u{5A62}',
+ '\u{FE00}',
+ '\u{5A66}',
+ '\u{FE00}',
+ '\u{5AB5}',
+ '\u{FE00}',
+ '\u{5B08}',
+ '\u{FE00}',
+ '\u{5B28}',
+ '\u{FE00}',
+ '\u{5B3E}',
+ '\u{FE00}',
+ '\u{5B3E}',
+ '\u{FE01}',
+ '\u{5B85}',
+ '\u{FE00}',
+ '\u{5BC3}',
+ '\u{FE00}',
+ '\u{5BD8}',
+ '\u{FE00}',
+ '\u{5BE7}',
+ '\u{FE00}',
+ '\u{5BE7}',
+ '\u{FE01}',
+ '\u{5BE7}',
+ '\u{FE02}',
+ '\u{5BEE}',
+ '\u{FE00}',
+ '\u{5BF3}',
+ '\u{FE00}',
+ '\u{5BFF}',
+ '\u{FE00}',
+ '\u{5C06}',
+ '\u{FE00}',
+ '\u{5C22}',
+ '\u{FE00}',
+ '\u{5C3F}',
+ '\u{FE00}',
+ '\u{5C60}',
+ '\u{FE00}',
+ '\u{5C62}',
+ '\u{FE00}',
+ '\u{5C64}',
+ '\u{FE00}',
+ '\u{5C65}',
+ '\u{FE00}',
+ '\u{5C6E}',
+ '\u{FE00}',
+ '\u{5C6E}',
+ '\u{FE01}',
+ '\u{5C8D}',
+ '\u{FE00}',
+ '\u{5CC0}',
+ '\u{FE00}',
+ '\u{5D19}',
+ '\u{FE00}',
+ '\u{5D43}',
+ '\u{FE00}',
+ '\u{5D50}',
+ '\u{FE00}',
+ '\u{5D6B}',
+ '\u{FE00}',
+ '\u{5D6E}',
+ '\u{FE00}',
+ '\u{5D7C}',
+ '\u{FE00}',
+ '\u{5DB2}',
+ '\u{FE00}',
+ '\u{5DBA}',
+ '\u{FE00}',
+ '\u{5DE1}',
+ '\u{FE00}',
+ '\u{5DE2}',
+ '\u{FE00}',
+ '\u{5DFD}',
+ '\u{FE00}',
+ '\u{5E28}',
+ '\u{FE00}',
+ '\u{5E3D}',
+ '\u{FE00}',
+ '\u{5E69}',
+ '\u{FE00}',
+ '\u{5E74}',
+ '\u{FE00}',
+ '\u{5EA6}',
+ '\u{FE00}',
+ '\u{5EB0}',
+ '\u{FE00}',
+ '\u{5EB3}',
+ '\u{FE00}',
+ '\u{5EB6}',
+ '\u{FE00}',
+ '\u{5EC9}',
+ '\u{FE00}',
+ '\u{5ECA}',
+ '\u{FE00}',
+ '\u{5ECA}',
+ '\u{FE01}',
+ '\u{5ED2}',
+ '\u{FE00}',
+ '\u{5ED3}',
+ '\u{FE00}',
+ '\u{5ED9}',
+ '\u{FE00}',
+ '\u{5EEC}',
+ '\u{FE00}',
+ '\u{5EFE}',
+ '\u{FE00}',
+ '\u{5F04}',
+ '\u{FE00}',
+ '\u{5F22}',
+ '\u{FE00}',
+ '\u{5F22}',
+ '\u{FE01}',
+ '\u{5F53}',
+ '\u{FE00}',
+ '\u{5F62}',
+ '\u{FE00}',
+ '\u{5F69}',
+ '\u{FE00}',
+ '\u{5F6B}',
+ '\u{FE00}',
+ '\u{5F8B}',
+ '\u{FE00}',
+ '\u{5F9A}',
+ '\u{FE00}',
+ '\u{5FA9}',
+ '\u{FE00}',
+ '\u{5FAD}',
+ '\u{FE00}',
+ '\u{5FCD}',
+ '\u{FE00}',
+ '\u{5FD7}',
+ '\u{FE00}',
+ '\u{5FF5}',
+ '\u{FE00}',
+ '\u{5FF9}',
+ '\u{FE00}',
+ '\u{6012}',
+ '\u{FE00}',
+ '\u{601C}',
+ '\u{FE00}',
+ '\u{6075}',
+ '\u{FE00}',
+ '\u{6081}',
+ '\u{FE00}',
+ '\u{6094}',
+ '\u{FE00}',
+ '\u{6094}',
+ '\u{FE01}',
+ '\u{60C7}',
+ '\u{FE00}',
+ '\u{60D8}',
+ '\u{FE00}',
+ '\u{60E1}',
+ '\u{FE00}',
+ '\u{6108}',
+ '\u{FE00}',
+ '\u{6144}',
+ '\u{FE00}',
+ '\u{6148}',
+ '\u{FE00}',
+ '\u{614C}',
+ '\u{FE00}',
+ '\u{614C}',
+ '\u{FE01}',
+ '\u{614E}',
+ '\u{FE00}',
+ '\u{614E}',
+ '\u{FE01}',
+ '\u{6160}',
+ '\u{FE00}',
+ '\u{6168}',
+ '\u{FE00}',
+ '\u{617A}',
+ '\u{FE00}',
+ '\u{618E}',
+ '\u{FE00}',
+ '\u{618E}',
+ '\u{FE01}',
+ '\u{618E}',
+ '\u{FE02}',
+ '\u{6190}',
+ '\u{FE00}',
+ '\u{61A4}',
+ '\u{FE00}',
+ '\u{61AF}',
+ '\u{FE00}',
+ '\u{61B2}',
+ '\u{FE00}',
+ '\u{61DE}',
+ '\u{FE00}',
+ '\u{61F2}',
+ '\u{FE00}',
+ '\u{61F2}',
+ '\u{FE01}',
+ '\u{61F2}',
+ '\u{FE02}',
+ '\u{61F6}',
+ '\u{FE00}',
+ '\u{61F6}',
+ '\u{FE01}',
+ '\u{6200}',
+ '\u{FE00}',
+ '\u{6210}',
+ '\u{FE00}',
+ '\u{621B}',
+ '\u{FE00}',
+ '\u{622E}',
+ '\u{FE00}',
+ '\u{6234}',
+ '\u{FE00}',
+ '\u{625D}',
+ '\u{FE00}',
+ '\u{62B1}',
+ '\u{FE00}',
+ '\u{62C9}',
+ '\u{FE00}',
+ '\u{62CF}',
+ '\u{FE00}',
+ '\u{62D3}',
+ '\u{FE00}',
+ '\u{62D4}',
+ '\u{FE00}',
+ '\u{62FC}',
+ '\u{FE00}',
+ '\u{62FE}',
+ '\u{FE00}',
+ '\u{633D}',
+ '\u{FE00}',
+ '\u{6350}',
+ '\u{FE00}',
+ '\u{6368}',
+ '\u{FE00}',
+ '\u{637B}',
+ '\u{FE00}',
+ '\u{6383}',
+ '\u{FE00}',
+ '\u{63A0}',
+ '\u{FE00}',
+ '\u{63A9}',
+ '\u{FE00}',
+ '\u{63C4}',
+ '\u{FE00}',
+ '\u{63C5}',
+ '\u{FE00}',
+ '\u{63E4}',
+ '\u{FE00}',
+ '\u{641C}',
+ '\u{FE00}',
+ '\u{6422}',
+ '\u{FE00}',
+ '\u{6452}',
+ '\u{FE00}',
+ '\u{6469}',
+ '\u{FE00}',
+ '\u{6477}',
+ '\u{FE00}',
+ '\u{647E}',
+ '\u{FE00}',
+ '\u{649A}',
+ '\u{FE00}',
+ '\u{649D}',
+ '\u{FE00}',
+ '\u{64C4}',
+ '\u{FE00}',
+ '\u{654F}',
+ '\u{FE00}',
+ '\u{654F}',
+ '\u{FE01}',
+ '\u{6556}',
+ '\u{FE00}',
+ '\u{656C}',
+ '\u{FE00}',
+ '\u{6578}',
+ '\u{FE00}',
+ '\u{6599}',
+ '\u{FE00}',
+ '\u{65C5}',
+ '\u{FE00}',
+ '\u{65E2}',
+ '\u{FE00}',
+ '\u{65E3}',
+ '\u{FE00}',
+ '\u{6613}',
+ '\u{FE00}',
+ '\u{6649}',
+ '\u{FE00}',
+ '\u{6674}',
+ '\u{FE00}',
+ '\u{6674}',
+ '\u{FE01}',
+ '\u{6688}',
+ '\u{FE00}',
+ '\u{6691}',
+ '\u{FE00}',
+ '\u{6691}',
+ '\u{FE01}',
+ '\u{669C}',
+ '\u{FE00}',
+ '\u{66B4}',
+ '\u{FE00}',
+ '\u{66C6}',
+ '\u{FE00}',
+ '\u{66F4}',
+ '\u{FE00}',
+ '\u{66F8}',
+ '\u{FE00}',
+ '\u{6700}',
+ '\u{FE00}',
+ '\u{6717}',
+ '\u{FE00}',
+ '\u{6717}',
+ '\u{FE01}',
+ '\u{6717}',
+ '\u{FE02}',
+ '\u{671B}',
+ '\u{FE00}',
+ '\u{671B}',
+ '\u{FE01}',
+ '\u{6721}',
+ '\u{FE00}',
+ '\u{674E}',
+ '\u{FE00}',
+ '\u{6753}',
+ '\u{FE00}',
+ '\u{6756}',
+ '\u{FE00}',
+ '\u{675E}',
+ '\u{FE00}',
+ '\u{677B}',
+ '\u{FE00}',
+ '\u{6785}',
+ '\u{FE00}',
+ '\u{6797}',
+ '\u{FE00}',
+ '\u{67F3}',
+ '\u{FE00}',
+ '\u{67FA}',
+ '\u{FE00}',
+ '\u{6817}',
+ '\u{FE00}',
+ '\u{681F}',
+ '\u{FE00}',
+ '\u{6852}',
+ '\u{FE00}',
+ '\u{6881}',
+ '\u{FE00}',
+ '\u{6885}',
+ '\u{FE00}',
+ '\u{6885}',
+ '\u{FE01}',
+ '\u{688E}',
+ '\u{FE00}',
+ '\u{68A8}',
+ '\u{FE00}',
+ '\u{6914}',
+ '\u{FE00}',
+ '\u{6942}',
+ '\u{FE00}',
+ '\u{69A3}',
+ '\u{FE00}',
+ '\u{69EA}',
+ '\u{FE00}',
+ '\u{6A02}',
+ '\u{FE00}',
+ '\u{6A02}',
+ '\u{FE01}',
+ '\u{6A02}',
+ '\u{FE02}',
+ '\u{6A13}',
+ '\u{FE00}',
+ '\u{6AA8}',
+ '\u{FE00}',
+ '\u{6AD3}',
+ '\u{FE00}',
+ '\u{6ADB}',
+ '\u{FE00}',
+ '\u{6B04}',
+ '\u{FE00}',
+ '\u{6B21}',
+ '\u{FE00}',
+ '\u{6B54}',
+ '\u{FE00}',
+ '\u{6B72}',
+ '\u{FE00}',
+ '\u{6B77}',
+ '\u{FE00}',
+ '\u{6B79}',
+ '\u{FE00}',
+ '\u{6B9F}',
+ '\u{FE00}',
+ '\u{6BAE}',
+ '\u{FE00}',
+ '\u{6BBA}',
+ '\u{FE00}',
+ '\u{6BBA}',
+ '\u{FE01}',
+ '\u{6BBA}',
+ '\u{FE02}',
+ '\u{6BBB}',
+ '\u{FE00}',
+ '\u{6C4E}',
+ '\u{FE00}',
+ '\u{6C67}',
+ '\u{FE00}',
+ '\u{6C88}',
+ '\u{FE00}',
+ '\u{6CBF}',
+ '\u{FE00}',
+ '\u{6CCC}',
+ '\u{FE00}',
+ '\u{6CCD}',
+ '\u{FE00}',
+ '\u{6CE5}',
+ '\u{FE00}',
+ '\u{6D16}',
+ '\u{FE00}',
+ '\u{6D1B}',
+ '\u{FE00}',
+ '\u{6D1E}',
+ '\u{FE00}',
+ '\u{6D34}',
+ '\u{FE00}',
+ '\u{6D3E}',
+ '\u{FE00}',
+ '\u{6D41}',
+ '\u{FE00}',
+ '\u{6D41}',
+ '\u{FE01}',
+ '\u{6D41}',
+ '\u{FE02}',
+ '\u{6D69}',
+ '\u{FE00}',
+ '\u{6D6A}',
+ '\u{FE00}',
+ '\u{6D77}',
+ '\u{FE00}',
+ '\u{6D77}',
+ '\u{FE01}',
+ '\u{6D78}',
+ '\u{FE00}',
+ '\u{6D85}',
+ '\u{FE00}',
+ '\u{6DCB}',
+ '\u{FE00}',
+ '\u{6DDA}',
+ '\u{FE00}',
+ '\u{6DEA}',
+ '\u{FE00}',
+ '\u{6DF9}',
+ '\u{FE00}',
+ '\u{6E1A}',
+ '\u{FE00}',
+ '\u{6E2F}',
+ '\u{FE00}',
+ '\u{6E6E}',
+ '\u{FE00}',
+ '\u{6E9C}',
+ '\u{FE00}',
+ '\u{6EBA}',
+ '\u{FE00}',
+ '\u{6EC7}',
+ '\u{FE00}',
+ '\u{6ECB}',
+ '\u{FE00}',
+ '\u{6ECB}',
+ '\u{FE01}',
+ '\u{6ED1}',
+ '\u{FE00}',
+ '\u{6EDB}',
+ '\u{FE00}',
+ '\u{6F0F}',
+ '\u{FE00}',
+ '\u{6F22}',
+ '\u{FE00}',
+ '\u{6F22}',
+ '\u{FE01}',
+ '\u{6F23}',
+ '\u{FE00}',
+ '\u{6F6E}',
+ '\u{FE00}',
+ '\u{6FC6}',
+ '\u{FE00}',
+ '\u{6FEB}',
+ '\u{FE00}',
+ '\u{6FFE}',
+ '\u{FE00}',
+ '\u{701B}',
+ '\u{FE00}',
+ '\u{701E}',
+ '\u{FE00}',
+ '\u{701E}',
+ '\u{FE01}',
+ '\u{7039}',
+ '\u{FE00}',
+ '\u{704A}',
+ '\u{FE00}',
+ '\u{7070}',
+ '\u{FE00}',
+ '\u{7077}',
+ '\u{FE00}',
+ '\u{707D}',
+ '\u{FE00}',
+ '\u{7099}',
+ '\u{FE00}',
+ '\u{70AD}',
+ '\u{FE00}',
+ '\u{70C8}',
+ '\u{FE00}',
+ '\u{70D9}',
+ '\u{FE00}',
+ '\u{7145}',
+ '\u{FE00}',
+ '\u{7149}',
+ '\u{FE00}',
+ '\u{716E}',
+ '\u{FE00}',
+ '\u{716E}',
+ '\u{FE01}',
+ '\u{719C}',
+ '\u{FE00}',
+ '\u{71CE}',
+ '\u{FE00}',
+ '\u{71D0}',
+ '\u{FE00}',
+ '\u{7210}',
+ '\u{FE00}',
+ '\u{721B}',
+ '\u{FE00}',
+ '\u{7228}',
+ '\u{FE00}',
+ '\u{722B}',
+ '\u{FE00}',
+ '\u{7235}',
+ '\u{FE00}',
+ '\u{7235}',
+ '\u{FE01}',
+ '\u{7250}',
+ '\u{FE00}',
+ '\u{7262}',
+ '\u{FE00}',
+ '\u{7280}',
+ '\u{FE00}',
+ '\u{7295}',
+ '\u{FE00}',
+ '\u{72AF}',
+ '\u{FE00}',
+ '\u{72C0}',
+ '\u{FE00}',
+ '\u{72FC}',
+ '\u{FE00}',
+ '\u{732A}',
+ '\u{FE00}',
+ '\u{732A}',
+ '\u{FE01}',
+ '\u{7375}',
+ '\u{FE00}',
+ '\u{737A}',
+ '\u{FE00}',
+ '\u{7387}',
+ '\u{FE00}',
+ '\u{7387}',
+ '\u{FE01}',
+ '\u{738B}',
+ '\u{FE00}',
+ '\u{73A5}',
+ '\u{FE00}',
+ '\u{73B2}',
+ '\u{FE00}',
+ '\u{73DE}',
+ '\u{FE00}',
+ '\u{7406}',
+ '\u{FE00}',
+ '\u{7409}',
+ '\u{FE00}',
+ '\u{7422}',
+ '\u{FE00}',
+ '\u{7447}',
+ '\u{FE00}',
+ '\u{745C}',
+ '\u{FE00}',
+ '\u{7469}',
+ '\u{FE00}',
+ '\u{7471}',
+ '\u{FE00}',
+ '\u{7471}',
+ '\u{FE01}',
+ '\u{7485}',
+ '\u{FE00}',
+ '\u{7489}',
+ '\u{FE00}',
+ '\u{7498}',
+ '\u{FE00}',
+ '\u{74CA}',
+ '\u{FE00}',
+ '\u{7506}',
+ '\u{FE00}',
+ '\u{7524}',
+ '\u{FE00}',
+ '\u{753B}',
+ '\u{FE00}',
+ '\u{753E}',
+ '\u{FE00}',
+ '\u{7559}',
+ '\u{FE00}',
+ '\u{7565}',
+ '\u{FE00}',
+ '\u{7570}',
+ '\u{FE00}',
+ '\u{7570}',
+ '\u{FE01}',
+ '\u{75E2}',
+ '\u{FE00}',
+ '\u{7610}',
+ '\u{FE00}',
+ '\u{761D}',
+ '\u{FE00}',
+ '\u{761F}',
+ '\u{FE00}',
+ '\u{7642}',
+ '\u{FE00}',
+ '\u{7669}',
+ '\u{FE00}',
+ '\u{76CA}',
+ '\u{FE00}',
+ '\u{76CA}',
+ '\u{FE01}',
+ '\u{76DB}',
+ '\u{FE00}',
+ '\u{76E7}',
+ '\u{FE00}',
+ '\u{76F4}',
+ '\u{FE00}',
+ '\u{76F4}',
+ '\u{FE01}',
+ '\u{7701}',
+ '\u{FE00}',
+ '\u{771E}',
+ '\u{FE00}',
+ '\u{771F}',
+ '\u{FE00}',
+ '\u{771F}',
+ '\u{FE01}',
+ '\u{7740}',
+ '\u{FE00}',
+ '\u{774A}',
+ '\u{FE00}',
+ '\u{774A}',
+ '\u{FE01}',
+ '\u{778B}',
+ '\u{FE00}',
+ '\u{77A7}',
+ '\u{FE00}',
+ '\u{784E}',
+ '\u{FE00}',
+ '\u{786B}',
+ '\u{FE00}',
+ '\u{788C}',
+ '\u{FE00}',
+ '\u{788C}',
+ '\u{FE01}',
+ '\u{7891}',
+ '\u{FE00}',
+ '\u{78CA}',
+ '\u{FE00}',
+ '\u{78CC}',
+ '\u{FE00}',
+ '\u{78CC}',
+ '\u{FE01}',
+ '\u{78FB}',
+ '\u{FE00}',
+ '\u{792A}',
+ '\u{FE00}',
+ '\u{793C}',
+ '\u{FE00}',
+ '\u{793E}',
+ '\u{FE00}',
+ '\u{7948}',
+ '\u{FE00}',
+ '\u{7949}',
+ '\u{FE00}',
+ '\u{7950}',
+ '\u{FE00}',
+ '\u{7956}',
+ '\u{FE00}',
+ '\u{7956}',
+ '\u{FE01}',
+ '\u{795D}',
+ '\u{FE00}',
+ '\u{795E}',
+ '\u{FE00}',
+ '\u{7965}',
+ '\u{FE00}',
+ '\u{797F}',
+ '\u{FE00}',
+ '\u{798D}',
+ '\u{FE00}',
+ '\u{798E}',
+ '\u{FE00}',
+ '\u{798F}',
+ '\u{FE00}',
+ '\u{798F}',
+ '\u{FE01}',
+ '\u{79AE}',
+ '\u{FE00}',
+ '\u{79CA}',
+ '\u{FE00}',
+ '\u{79EB}',
+ '\u{FE00}',
+ '\u{7A1C}',
+ '\u{FE00}',
+ '\u{7A40}',
+ '\u{FE00}',
+ '\u{7A40}',
+ '\u{FE01}',
+ '\u{7A4A}',
+ '\u{FE00}',
+ '\u{7A4F}',
+ '\u{FE00}',
+ '\u{7A81}',
+ '\u{FE00}',
+ '\u{7AB1}',
+ '\u{FE00}',
+ '\u{7ACB}',
+ '\u{FE00}',
+ '\u{7AEE}',
+ '\u{FE00}',
+ '\u{7B20}',
+ '\u{FE00}',
+ '\u{7BC0}',
+ '\u{FE00}',
+ '\u{7BC0}',
+ '\u{FE01}',
+ '\u{7BC6}',
+ '\u{FE00}',
+ '\u{7BC9}',
+ '\u{FE00}',
+ '\u{7C3E}',
+ '\u{FE00}',
+ '\u{7C60}',
+ '\u{FE00}',
+ '\u{7C7B}',
+ '\u{FE00}',
+ '\u{7C92}',
+ '\u{FE00}',
+ '\u{7CBE}',
+ '\u{FE00}',
+ '\u{7CD2}',
+ '\u{FE00}',
+ '\u{7CD6}',
+ '\u{FE00}',
+ '\u{7CE3}',
+ '\u{FE00}',
+ '\u{7CE7}',
+ '\u{FE00}',
+ '\u{7CE8}',
+ '\u{FE00}',
+ '\u{7D00}',
+ '\u{FE00}',
+ '\u{7D10}',
+ '\u{FE00}',
+ '\u{7D22}',
+ '\u{FE00}',
+ '\u{7D2F}',
+ '\u{FE00}',
+ '\u{7D5B}',
+ '\u{FE00}',
+ '\u{7D63}',
+ '\u{FE00}',
+ '\u{7DA0}',
+ '\u{FE00}',
+ '\u{7DBE}',
+ '\u{FE00}',
+ '\u{7DC7}',
+ '\u{FE00}',
+ '\u{7DF4}',
+ '\u{FE00}',
+ '\u{7DF4}',
+ '\u{FE01}',
+ '\u{7DF4}',
+ '\u{FE02}',
+ '\u{7E02}',
+ '\u{FE00}',
+ '\u{7E09}',
+ '\u{FE00}',
+ '\u{7E37}',
+ '\u{FE00}',
+ '\u{7E41}',
+ '\u{FE00}',
+ '\u{7E45}',
+ '\u{FE00}',
+ '\u{7F3E}',
+ '\u{FE00}',
+ '\u{7F72}',
+ '\u{FE00}',
+ '\u{7F79}',
+ '\u{FE00}',
+ '\u{7F7A}',
+ '\u{FE00}',
+ '\u{7F85}',
+ '\u{FE00}',
+ '\u{7F95}',
+ '\u{FE00}',
+ '\u{7F9A}',
+ '\u{FE00}',
+ '\u{7FBD}',
+ '\u{FE00}',
+ '\u{7FFA}',
+ '\u{FE00}',
+ '\u{8001}',
+ '\u{FE00}',
+ '\u{8005}',
+ '\u{FE00}',
+ '\u{8005}',
+ '\u{FE01}',
+ '\u{8005}',
+ '\u{FE02}',
+ '\u{8046}',
+ '\u{FE00}',
+ '\u{8060}',
+ '\u{FE00}',
+ '\u{806F}',
+ '\u{FE00}',
+ '\u{8070}',
+ '\u{FE00}',
+ '\u{807E}',
+ '\u{FE00}',
+ '\u{808B}',
+ '\u{FE00}',
+ '\u{80AD}',
+ '\u{FE00}',
+ '\u{80B2}',
+ '\u{FE00}',
+ '\u{8103}',
+ '\u{FE00}',
+ '\u{813E}',
+ '\u{FE00}',
+ '\u{81D8}',
+ '\u{FE00}',
+ '\u{81E8}',
+ '\u{FE00}',
+ '\u{81ED}',
+ '\u{FE00}',
+ '\u{8201}',
+ '\u{FE00}',
+ '\u{8201}',
+ '\u{FE01}',
+ '\u{8204}',
+ '\u{FE00}',
+ '\u{8218}',
+ '\u{FE00}',
+ '\u{826F}',
+ '\u{FE00}',
+ '\u{8279}',
+ '\u{FE00}',
+ '\u{8279}',
+ '\u{FE01}',
+ '\u{828B}',
+ '\u{FE00}',
+ '\u{8291}',
+ '\u{FE00}',
+ '\u{829D}',
+ '\u{FE00}',
+ '\u{82B1}',
+ '\u{FE00}',
+ '\u{82B3}',
+ '\u{FE00}',
+ '\u{82BD}',
+ '\u{FE00}',
+ '\u{82E5}',
+ '\u{FE00}',
+ '\u{82E5}',
+ '\u{FE01}',
+ '\u{82E6}',
+ '\u{FE00}',
+ '\u{831D}',
+ '\u{FE00}',
+ '\u{8323}',
+ '\u{FE00}',
+ '\u{8336}',
+ '\u{FE00}',
+ '\u{8352}',
+ '\u{FE00}',
+ '\u{8353}',
+ '\u{FE00}',
+ '\u{8363}',
+ '\u{FE00}',
+ '\u{83AD}',
+ '\u{FE00}',
+ '\u{83BD}',
+ '\u{FE00}',
+ '\u{83C9}',
+ '\u{FE00}',
+ '\u{83CA}',
+ '\u{FE00}',
+ '\u{83CC}',
+ '\u{FE00}',
+ '\u{83DC}',
+ '\u{FE00}',
+ '\u{83E7}',
+ '\u{FE00}',
+ '\u{83EF}',
+ '\u{FE00}',
+ '\u{83F1}',
+ '\u{FE00}',
+ '\u{843D}',
+ '\u{FE00}',
+ '\u{8449}',
+ '\u{FE00}',
+ '\u{8457}',
+ '\u{FE00}',
+ '\u{8457}',
+ '\u{FE01}',
+ '\u{84EE}',
+ '\u{FE00}',
+ '\u{84F1}',
+ '\u{FE00}',
+ '\u{84F3}',
+ '\u{FE00}',
+ '\u{84FC}',
+ '\u{FE00}',
+ '\u{8516}',
+ '\u{FE00}',
+ '\u{8564}',
+ '\u{FE00}',
+ '\u{85CD}',
+ '\u{FE00}',
+ '\u{85FA}',
+ '\u{FE00}',
+ '\u{8606}',
+ '\u{FE00}',
+ '\u{8612}',
+ '\u{FE00}',
+ '\u{862D}',
+ '\u{FE00}',
+ '\u{863F}',
+ '\u{FE00}',
+ '\u{8650}',
+ '\u{FE00}',
+ '\u{865C}',
+ '\u{FE00}',
+ '\u{865C}',
+ '\u{FE01}',
+ '\u{8667}',
+ '\u{FE00}',
+ '\u{8669}',
+ '\u{FE00}',
+ '\u{8688}',
+ '\u{FE00}',
+ '\u{86A9}',
+ '\u{FE00}',
+ '\u{86E2}',
+ '\u{FE00}',
+ '\u{870E}',
+ '\u{FE00}',
+ '\u{8728}',
+ '\u{FE00}',
+ '\u{876B}',
+ '\u{FE00}',
+ '\u{8779}',
+ '\u{FE00}',
+ '\u{8779}',
+ '\u{FE01}',
+ '\u{8786}',
+ '\u{FE00}',
+ '\u{87BA}',
+ '\u{FE00}',
+ '\u{87E1}',
+ '\u{FE00}',
+ '\u{8801}',
+ '\u{FE00}',
+ '\u{881F}',
+ '\u{FE00}',
+ '\u{884C}',
+ '\u{FE00}',
+ '\u{8860}',
+ '\u{FE00}',
+ '\u{8863}',
+ '\u{FE00}',
+ '\u{88C2}',
+ '\u{FE00}',
+ '\u{88CF}',
+ '\u{FE00}',
+ '\u{88D7}',
+ '\u{FE00}',
+ '\u{88DE}',
+ '\u{FE00}',
+ '\u{88E1}',
+ '\u{FE00}',
+ '\u{88F8}',
+ '\u{FE00}',
+ '\u{88FA}',
+ '\u{FE00}',
+ '\u{8910}',
+ '\u{FE00}',
+ '\u{8941}',
+ '\u{FE00}',
+ '\u{8964}',
+ '\u{FE00}',
+ '\u{8986}',
+ '\u{FE00}',
+ '\u{898B}',
+ '\u{FE00}',
+ '\u{8996}',
+ '\u{FE00}',
+ '\u{8996}',
+ '\u{FE01}',
+ '\u{8AA0}',
+ '\u{FE00}',
+ '\u{8AAA}',
+ '\u{FE00}',
+ '\u{8AAA}',
+ '\u{FE01}',
+ '\u{8ABF}',
+ '\u{FE00}',
+ '\u{8ACB}',
+ '\u{FE00}',
+ '\u{8AD2}',
+ '\u{FE00}',
+ '\u{8AD6}',
+ '\u{FE00}',
+ '\u{8AED}',
+ '\u{FE00}',
+ '\u{8AED}',
+ '\u{FE01}',
+ '\u{8AF8}',
+ '\u{FE00}',
+ '\u{8AF8}',
+ '\u{FE01}',
+ '\u{8AFE}',
+ '\u{FE00}',
+ '\u{8AFE}',
+ '\u{FE01}',
+ '\u{8B01}',
+ '\u{FE00}',
+ '\u{8B01}',
+ '\u{FE01}',
+ '\u{8B39}',
+ '\u{FE00}',
+ '\u{8B39}',
+ '\u{FE01}',
+ '\u{8B58}',
+ '\u{FE00}',
+ '\u{8B80}',
+ '\u{FE00}',
+ '\u{8B8A}',
+ '\u{FE00}',
+ '\u{8B8A}',
+ '\u{FE01}',
+ '\u{8C48}',
+ '\u{FE00}',
+ '\u{8C55}',
+ '\u{FE00}',
+ '\u{8CAB}',
+ '\u{FE00}',
+ '\u{8CC1}',
+ '\u{FE00}',
+ '\u{8CC2}',
+ '\u{FE00}',
+ '\u{8CC8}',
+ '\u{FE00}',
+ '\u{8CD3}',
+ '\u{FE00}',
+ '\u{8D08}',
+ '\u{FE00}',
+ '\u{8D08}',
+ '\u{FE01}',
+ '\u{8D1B}',
+ '\u{FE00}',
+ '\u{8D77}',
+ '\u{FE00}',
+ '\u{8DBC}',
+ '\u{FE00}',
+ '\u{8DCB}',
+ '\u{FE00}',
+ '\u{8DEF}',
+ '\u{FE00}',
+ '\u{8DF0}',
+ '\u{FE00}',
+ '\u{8ECA}',
+ '\u{FE00}',
+ '\u{8ED4}',
+ '\u{FE00}',
+ '\u{8F26}',
+ '\u{FE00}',
+ '\u{8F2A}',
+ '\u{FE00}',
+ '\u{8F38}',
+ '\u{FE00}',
+ '\u{8F38}',
+ '\u{FE01}',
+ '\u{8F3B}',
+ '\u{FE00}',
+ '\u{8F62}',
+ '\u{FE00}',
+ '\u{8F9E}',
+ '\u{FE00}',
+ '\u{8FB0}',
+ '\u{FE00}',
+ '\u{8FB6}',
+ '\u{FE00}',
+ '\u{9023}',
+ '\u{FE00}',
+ '\u{9038}',
+ '\u{FE00}',
+ '\u{9038}',
+ '\u{FE01}',
+ '\u{9072}',
+ '\u{FE00}',
+ '\u{907C}',
+ '\u{FE00}',
+ '\u{908F}',
+ '\u{FE00}',
+ '\u{9094}',
+ '\u{FE00}',
+ '\u{90CE}',
+ '\u{FE00}',
+ '\u{90DE}',
+ '\u{FE00}',
+ '\u{90F1}',
+ '\u{FE00}',
+ '\u{90FD}',
+ '\u{FE00}',
+ '\u{9111}',
+ '\u{FE00}',
+ '\u{911B}',
+ '\u{FE00}',
+ '\u{916A}',
+ '\u{FE00}',
+ '\u{9199}',
+ '\u{FE00}',
+ '\u{91B4}',
+ '\u{FE00}',
+ '\u{91CC}',
+ '\u{FE00}',
+ '\u{91CF}',
+ '\u{FE00}',
+ '\u{91D1}',
+ '\u{FE00}',
+ '\u{9234}',
+ '\u{FE00}',
+ '\u{9238}',
+ '\u{FE00}',
+ '\u{9276}',
+ '\u{FE00}',
+ '\u{927C}',
+ '\u{FE00}',
+ '\u{92D7}',
+ '\u{FE00}',
+ '\u{92D8}',
+ '\u{FE00}',
+ '\u{9304}',
+ '\u{FE00}',
+ '\u{934A}',
+ '\u{FE00}',
+ '\u{93F9}',
+ '\u{FE00}',
+ '\u{9415}',
+ '\u{FE00}',
+ '\u{958B}',
+ '\u{FE00}',
+ '\u{95AD}',
+ '\u{FE00}',
+ '\u{95B7}',
+ '\u{FE00}',
+ '\u{962E}',
+ '\u{FE00}',
+ '\u{964B}',
+ '\u{FE00}',
+ '\u{964D}',
+ '\u{FE00}',
+ '\u{9675}',
+ '\u{FE00}',
+ '\u{9678}',
+ '\u{FE00}',
+ '\u{967C}',
+ '\u{FE00}',
+ '\u{9686}',
+ '\u{FE00}',
+ '\u{96A3}',
+ '\u{FE00}',
+ '\u{96B7}',
+ '\u{FE00}',
+ '\u{96B8}',
+ '\u{FE00}',
+ '\u{96C3}',
+ '\u{FE00}',
+ '\u{96E2}',
+ '\u{FE00}',
+ '\u{96E3}',
+ '\u{FE00}',
+ '\u{96E3}',
+ '\u{FE01}',
+ '\u{96F6}',
+ '\u{FE00}',
+ '\u{96F7}',
+ '\u{FE00}',
+ '\u{9723}',
+ '\u{FE00}',
+ '\u{9732}',
+ '\u{FE00}',
+ '\u{9748}',
+ '\u{FE00}',
+ '\u{9756}',
+ '\u{FE00}',
+ '\u{9756}',
+ '\u{FE01}',
+ '\u{97DB}',
+ '\u{FE00}',
+ '\u{97E0}',
+ '\u{FE00}',
+ '\u{97FF}',
+ '\u{FE00}',
+ '\u{97FF}',
+ '\u{FE01}',
+ '\u{980B}',
+ '\u{FE00}',
+ '\u{980B}',
+ '\u{FE01}',
+ '\u{980B}',
+ '\u{FE02}',
+ '\u{9818}',
+ '\u{FE00}',
+ '\u{9829}',
+ '\u{FE00}',
+ '\u{983B}',
+ '\u{FE00}',
+ '\u{983B}',
+ '\u{FE01}',
+ '\u{985E}',
+ '\u{FE00}',
+ '\u{98E2}',
+ '\u{FE00}',
+ '\u{98EF}',
+ '\u{FE00}',
+ '\u{98FC}',
+ '\u{FE00}',
+ '\u{9928}',
+ '\u{FE00}',
+ '\u{9929}',
+ '\u{FE00}',
+ '\u{99A7}',
+ '\u{FE00}',
+ '\u{99C2}',
+ '\u{FE00}',
+ '\u{99F1}',
+ '\u{FE00}',
+ '\u{99FE}',
+ '\u{FE00}',
+ '\u{9A6A}',
+ '\u{FE00}',
+ '\u{9B12}',
+ '\u{FE00}',
+ '\u{9B12}',
+ '\u{FE01}',
+ '\u{9B6F}',
+ '\u{FE00}',
+ '\u{9C40}',
+ '\u{FE00}',
+ '\u{9C57}',
+ '\u{FE00}',
+ '\u{9CFD}',
+ '\u{FE00}',
+ '\u{9D67}',
+ '\u{FE00}',
+ '\u{9DB4}',
+ '\u{FE00}',
+ '\u{9DFA}',
+ '\u{FE00}',
+ '\u{9E1E}',
+ '\u{FE00}',
+ '\u{9E7F}',
+ '\u{FE00}',
+ '\u{9E97}',
+ '\u{FE00}',
+ '\u{9E9F}',
+ '\u{FE00}',
+ '\u{9EBB}',
+ '\u{FE00}',
+ '\u{9ECE}',
+ '\u{FE00}',
+ '\u{9EF9}',
+ '\u{FE00}',
+ '\u{9EFE}',
+ '\u{FE00}',
+ '\u{9F05}',
+ '\u{FE00}',
+ '\u{9F0F}',
+ '\u{FE00}',
+ '\u{9F16}',
+ '\u{FE00}',
+ '\u{9F3B}',
+ '\u{FE00}',
+ '\u{9F43}',
+ '\u{FE00}',
+ '\u{9F8D}',
+ '\u{FE00}',
+ '\u{9F8E}',
+ '\u{FE00}',
+ '\u{9F9C}',
+ '\u{FE00}',
+ '\u{9F9C}',
+ '\u{FE01}',
+ '\u{9F9C}',
+ '\u{FE02}',
+ '\u{20122}',
+ '\u{FE00}',
+ '\u{2051C}',
+ '\u{FE00}',
+ '\u{20525}',
+ '\u{FE00}',
+ '\u{2054B}',
+ '\u{FE00}',
+ '\u{2063A}',
+ '\u{FE00}',
+ '\u{20804}',
+ '\u{FE00}',
+ '\u{208DE}',
+ '\u{FE00}',
+ '\u{20A2C}',
+ '\u{FE00}',
+ '\u{20B63}',
+ '\u{FE00}',
+ '\u{214E4}',
+ '\u{FE00}',
+ '\u{216A8}',
+ '\u{FE00}',
+ '\u{216EA}',
+ '\u{FE00}',
+ '\u{219C8}',
+ '\u{FE00}',
+ '\u{21B18}',
+ '\u{FE00}',
+ '\u{21D0B}',
+ '\u{FE00}',
+ '\u{21DE4}',
+ '\u{FE00}',
+ '\u{21DE6}',
+ '\u{FE00}',
+ '\u{22183}',
+ '\u{FE00}',
+ '\u{2219F}',
+ '\u{FE00}',
+ '\u{22331}',
+ '\u{FE00}',
+ '\u{22331}',
+ '\u{FE01}',
+ '\u{226D4}',
+ '\u{FE00}',
+ '\u{22844}',
+ '\u{FE00}',
+ '\u{2284A}',
+ '\u{FE00}',
+ '\u{22B0C}',
+ '\u{FE00}',
+ '\u{22BF1}',
+ '\u{FE00}',
+ '\u{2300A}',
+ '\u{FE00}',
+ '\u{232B8}',
+ '\u{FE00}',
+ '\u{2335F}',
+ '\u{FE00}',
+ '\u{23393}',
+ '\u{FE00}',
+ '\u{2339C}',
+ '\u{FE00}',
+ '\u{233C3}',
+ '\u{FE00}',
+ '\u{233D5}',
+ '\u{FE00}',
+ '\u{2346D}',
+ '\u{FE00}',
+ '\u{236A3}',
+ '\u{FE00}',
+ '\u{238A7}',
+ '\u{FE00}',
+ '\u{23A8D}',
+ '\u{FE00}',
+ '\u{23AFA}',
+ '\u{FE00}',
+ '\u{23CBC}',
+ '\u{FE00}',
+ '\u{23D1E}',
+ '\u{FE00}',
+ '\u{23ED1}',
+ '\u{FE00}',
+ '\u{23F5E}',
+ '\u{FE00}',
+ '\u{23F8E}',
+ '\u{FE00}',
+ '\u{24263}',
+ '\u{FE00}',
+ '\u{242EE}',
+ '\u{FE00}',
+ '\u{243AB}',
+ '\u{FE00}',
+ '\u{24608}',
+ '\u{FE00}',
+ '\u{24735}',
+ '\u{FE00}',
+ '\u{24814}',
+ '\u{FE00}',
+ '\u{24C36}',
+ '\u{FE00}',
+ '\u{24C92}',
+ '\u{FE00}',
+ '\u{24FA1}',
+ '\u{FE00}',
+ '\u{24FB8}',
+ '\u{FE00}',
+ '\u{25044}',
+ '\u{FE00}',
+ '\u{250F2}',
+ '\u{FE00}',
+ '\u{250F3}',
+ '\u{FE00}',
+ '\u{25119}',
+ '\u{FE00}',
+ '\u{25133}',
+ '\u{FE00}',
+ '\u{25249}',
+ '\u{FE00}',
+ '\u{2541D}',
+ '\u{FE00}',
+ '\u{25626}',
+ '\u{FE00}',
+ '\u{2569A}',
+ '\u{FE00}',
+ '\u{256C5}',
+ '\u{FE00}',
+ '\u{2597C}',
+ '\u{FE00}',
+ '\u{25AA7}',
+ '\u{FE00}',
+ '\u{25AA7}',
+ '\u{FE01}',
+ '\u{25BAB}',
+ '\u{FE00}',
+ '\u{25C80}',
+ '\u{FE00}',
+ '\u{25CD0}',
+ '\u{FE00}',
+ '\u{25F86}',
+ '\u{FE00}',
+ '\u{261DA}',
+ '\u{FE00}',
+ '\u{26228}',
+ '\u{FE00}',
+ '\u{26247}',
+ '\u{FE00}',
+ '\u{262D9}',
+ '\u{FE00}',
+ '\u{2633E}',
+ '\u{FE00}',
+ '\u{264DA}',
+ '\u{FE00}',
+ '\u{26523}',
+ '\u{FE00}',
+ '\u{265A8}',
+ '\u{FE00}',
+ '\u{267A7}',
+ '\u{FE00}',
+ '\u{267B5}',
+ '\u{FE00}',
+ '\u{26B3C}',
+ '\u{FE00}',
+ '\u{26C36}',
+ '\u{FE00}',
+ '\u{26CD5}',
+ '\u{FE00}',
+ '\u{26D6B}',
+ '\u{FE00}',
+ '\u{26F2C}',
+ '\u{FE00}',
+ '\u{26FB1}',
+ '\u{FE00}',
+ '\u{270D2}',
+ '\u{FE00}',
+ '\u{273CA}',
+ '\u{FE00}',
+ '\u{27667}',
+ '\u{FE00}',
+ '\u{278AE}',
+ '\u{FE00}',
+ '\u{27966}',
+ '\u{FE00}',
+ '\u{27CA8}',
+ '\u{FE00}',
+ '\u{27ED3}',
+ '\u{FE00}',
+ '\u{27F2F}',
+ '\u{FE00}',
+ '\u{285D2}',
+ '\u{FE00}',
+ '\u{285ED}',
+ '\u{FE00}',
+ '\u{2872E}',
+ '\u{FE00}',
+ '\u{28BFA}',
+ '\u{FE00}',
+ '\u{28D77}',
+ '\u{FE00}',
+ '\u{29145}',
+ '\u{FE00}',
+ '\u{291DF}',
+ '\u{FE00}',
+ '\u{2921A}',
+ '\u{FE00}',
+ '\u{2940A}',
+ '\u{FE00}',
+ '\u{29496}',
+ '\u{FE00}',
+ '\u{295B6}',
+ '\u{FE00}',
+ '\u{29B30}',
+ '\u{FE00}',
+ '\u{2A0CE}',
+ '\u{FE00}',
+ '\u{2A105}',
+ '\u{FE00}',
+ '\u{2A20E}',
+ '\u{FE00}',
+ '\u{2A291}',
+ '\u{FE00}',
+ '\u{2A392}',
+ '\u{FE00}',
+ '\u{2A600}',
+ '\u{FE00}',
+];
+pub(crate) const CJK_COMPAT_VARIANTS_DECOMPOSED_SALT: &[u16] = &[
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x162,
+ 0x14,
+ 0xb6,
+ 0x0,
+ 0x183,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x35,
+ 0x11,
+ 0x7,
+ 0x0,
+ 0x1c,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xd3,
+ 0xb,
+ 0xa,
+ 0xe1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x48,
+ 0x72,
+ 0xc7,
+ 0x2,
+ 0x21,
+ 0x15,
+ 0x2c,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1f,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x7,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4e,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x11,
+ 0x14,
+ 0x4,
+ 0x1a,
+ 0x2,
+ 0x58,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x16,
+ 0x20,
+ 0x4,
+ 0x0,
+ 0x1e,
+ 0x30,
+ 0x0,
+ 0x24,
+ 0x1a,
+ 0x17,
+ 0x0,
+ 0xa0,
+ 0x29,
+ 0x34,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x23,
+ 0x29,
+ 0x21,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x20,
+ 0x1,
+ 0x7,
+ 0x8,
+ 0x9,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x1d,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x29,
+ 0xd,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xe,
+ 0x9,
+ 0x4,
+ 0xc,
+ 0x1,
+ 0x13,
+ 0x5,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0xa,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x29,
+ 0x0,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x9,
+ 0x10,
+ 0xf,
+ 0x0,
+ 0x11,
+ 0xf,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x26,
+ 0x5,
+ 0x39,
+ 0x8,
+ 0x1,
+ 0x17,
+ 0xd,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xe,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x35,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x11,
+ 0x0,
+ 0xd,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x2,
+ 0xb,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x12,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xb,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2f,
+ 0x1,
+ 0x13,
+ 0xb,
+ 0x4,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0xb,
+ 0x4,
+ 0x0,
+ 0xb,
+ 0x4,
+ 0xd,
+ 0xc,
+ 0x0,
+ 0x1e,
+ 0x0,
+ 0x21,
+ 0xd,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x20,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1f,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x11,
+ 0x2,
+ 0x8,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0xe,
+ 0x23,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x8,
+ 0x10,
+ 0x2,
+ 0x0,
+ 0x13,
+ 0xd,
+ 0x0,
+ 0xb,
+ 0x9,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0xc,
+ 0xa,
+ 0x4,
+ 0x1a,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0xa,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x8,
+ 0x8,
+ 0x3,
+ 0x19,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x15,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x12,
+ 0x4,
+ 0x3,
+ 0xc,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x10,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0xc,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x3,
+ 0xf,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0xa,
+ 0x9,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x1f,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x11,
+ 0x5,
+ 0x3,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x19,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x5,
+ 0x6,
+ 0x0,
+ 0x11,
+ 0xe,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x1a,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x17,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0xf,
+ 0x1,
+ 0x6,
+ 0x9,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x17,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x15,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x9,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0xf,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x4,
+ 0x9,
+ 0x2,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0xb,
+ 0x4,
+ 0xd,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x18,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0xa,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x1,
+ 0xc,
+ 0x1,
+ 0x9,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0xa,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x6,
+ 0x4,
+ 0x3,
+ 0xd,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x8,
+ 0x5,
+ 0x7,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+];
+pub(crate) const CJK_COMPAT_VARIANTS_DECOMPOSED_KV: &[(u32, (u16, u16))] = &[
+ (0xfa08, (1448, 2)),
+ (0x2f825, (280, 2)),
+ (0x2f838, (1796, 2)),
+ (0x2f95b, (1192, 2)),
+ (0x2f8fb, (1856, 2)),
+ (0x2f83a, (340, 2)),
+ (0x2f8a7, (636, 2)),
+ (0x2f856, (422, 2)),
+ (0x2f810, (208, 2)),
+ (0xfa8b, (668, 2)),
+ (0xfa7a, (378, 2)),
+ (0x2f9ef, (118, 2)),
+ (0x2f959, (1188, 2)),
+ (0xf9c8, (804, 2)),
+ (0xf9c4, (1770, 2)),
+ (0x2f833, (328, 2)),
+ (0xf96c, (430, 2)),
+ (0xf9a1, (1486, 2)),
+ (0xf906, (336, 2)),
+ (0x2fa01, (1988, 2)),
+ (0xf94c, (844, 2)),
+ (0xf90f, (1274, 2)),
+ (0x2f8dd, (1842, 2)),
+ (0xfa55, (1194, 2)),
+ (0x2f860, (1800, 2)),
+ (0x2f999, (1350, 2)),
+ (0xfabc, (1510, 2)),
+ (0x2f9b9, (1428, 2)),
+ (0xf943, (582, 2)),
+ (0x2f952, (1900, 2)),
+ (0x2f8f1, (856, 2)),
+ (0xf99c, (256, 2)),
+ (0xf969, (748, 2)),
+ (0xf98d, (1568, 2)),
+ (0xfa7f, (460, 2)),
+ (0x2f9d6, (1542, 2)),
+ (0x2f81b, (236, 2)),
+ (0xfa9d, (1126, 2)),
+ (0x2f8e4, (826, 2)),
+ (0xfa94, (800, 2)),
+ (0x2f890, (580, 2)),
+ (0xf93d, (1244, 2)),
+ (0x2f924, (1016, 2)),
+ (0x2f983, (1308, 2)),
+ (0xfa2f, (1656, 2)),
+ (0x2f891, (1818, 2)),
+ (0x2f934, (1072, 2)),
+ (0x2f835, (972, 2)),
+ (0x2f899, (590, 2)),
+ (0x2f8ae, (660, 2)),
+ (0xf9d6, (922, 2)),
+ (0x2f9a0, (1358, 2)),
+ (0xfac2, (1562, 2)),
+ (0x2f851, (442, 2)),
+ (0x2f804, (166, 2)),
+ (0x2f90d, (1860, 2)),
+ (0xf95e, (148, 2)),
+ (0x2f8da, (794, 2)),
+ (0x2f885, (550, 2)),
+ (0x2f96a, (1232, 2)),
+ (0xf907, (1774, 2)),
+ (0xf9f9, (1218, 2)),
+ (0xf94b, (514, 2)),
+ (0x2f915, (962, 2)),
+ (0xf9f1, (1654, 2)),
+ (0x2f86d, (490, 2)),
+ (0x2f921, (1010, 2)),
+ (0xfa96, (870, 2)),
+ (0xf9e0, (758, 2)),
+ (0xf921, (532, 2)),
+ (0x2f99f, (1386, 2)),
+ (0x2f8b2, (678, 2)),
+ (0xfab1, (1266, 2)),
+ (0xfa6c, (1868, 2)),
+ (0x2f819, (162, 2)),
+ (0x2f910, (1862, 2)),
+ (0x2f8dc, (798, 2)),
+ (0x2f9d3, (1962, 2)),
+ (0x2f8a3, (622, 2)),
+ (0xf915, (892, 2)),
+ (0x2f88a, (20, 2)),
+ (0xf9f6, (1314, 2)),
+ (0x2f9f1, (1976, 2)),
+ (0xf98e, (556, 2)),
+ (0xfad5, (1896, 2)),
+ (0xf93b, (1132, 2)),
+ (0x2f91e, (994, 2)),
+ (0xf9eb, (308, 2)),
+ (0xfa42, (754, 2)),
+ (0x2f958, (78, 2)),
+ (0xfa19, (1164, 2)),
+ (0xfaaa, (1118, 2)),
+ (0x2f949, (70, 2)),
+ (0x2f978, (1276, 2)),
+ (0x2f8a9, (638, 2)),
+ (0x2f90a, (50, 2)),
+ (0x2f89a, (594, 2)),
+ (0x2f8b5, (688, 2)),
+ (0x2f94c, (74, 2)),
+ (0xfa43, (768, 2)),
+ (0xf997, (1296, 2)),
+ (0x2f8ba, (698, 2)),
+ (0xfa00, (252, 2)),
+ (0xfac3, (1582, 2)),
+ (0x2f948, (1122, 2)),
+ (0x2f9f4, (540, 2)),
+ (0xfa99, (938, 2)),
+ (0x2f976, (1272, 2)),
+ (0xf978, (214, 2)),
+ (0x2f8fe, (878, 2)),
+ (0x2f8e3, (1846, 2)),
+ (0xf919, (1602, 2)),
+ (0x2f8ef, (854, 2)),
+ (0xf939, (1730, 2)),
+ (0x2f8c9, (746, 2)),
+ (0x2f844, (370, 2)),
+ (0xfabb, (1490, 2)),
+ (0x2f9c4, (1452, 2)),
+ (0x2f984, (96, 2)),
+ (0x2f802, (152, 2)),
+ (0xfa15, (246, 2)),
+ (0xf9be, (750, 2)),
+ (0xf942, (440, 2)),
+ (0x2f852, (414, 2)),
+ (0xfaae, (1216, 2)),
+ (0x2fa17, (1756, 2)),
+ (0x2f92d, (58, 2)),
+ (0x2f83f, (354, 2)),
+ (0xf90c, (456, 2)),
+ (0xf931, (848, 2)),
+ (0xf9c1, (1094, 2)),
+ (0x2f873, (506, 2)),
+ (0x2f965, (1914, 2)),
+ (0xf902, (1554, 2)),
+ (0x2f805, (176, 2)),
+ (0x2f8ca, (1832, 2)),
+ (0xf9c7, (270, 2)),
+ (0x2f8f4, (864, 2)),
+ (0xfa0d, (390, 2)),
+ (0xfa5c, (1316, 2)),
+ (0xfa4c, (1150, 2)),
+ (0x2f865, (466, 2)),
+ (0x2f876, (14, 2)),
+ (0x2f9d7, (1544, 2)),
+ (0xf975, (712, 2)),
+ (0x2f9bb, (1436, 2)),
+ (0x2f9d2, (1526, 2)),
+ (0xf9ed, (346, 2)),
+ (0x2f9b4, (1416, 2)),
+ (0xfa6d, (1324, 2)),
+ (0xf9e5, (1086, 2)),
+ (0x2f8d8, (788, 2)),
+ (0x2f93d, (1886, 2)),
+ (0xfa03, (1224, 2)),
+ (0xf9a0, (1454, 2)),
+ (0x2fa12, (1994, 2)),
+ (0xfa63, (1512, 2)),
+ (0xf920, (1744, 2)),
+ (0xf91f, (1408, 2)),
+ (0x2f97d, (1294, 2)),
+ (0xf990, (676, 2)),
+ (0xfa57, (1252, 2)),
+ (0x2f975, (1926, 2)),
+ (0xfad8, (1768, 2)),
+ (0xfab3, (1356, 2)),
+ (0x2f9f3, (1660, 2)),
+ (0xf9fb, (978, 2)),
+ (0xf918, (1380, 2)),
+ (0x2f8c3, (728, 2)),
+ (0xf9ca, (900, 2)),
+ (0xf952, (286, 2)),
+ (0x2fa0b, (1732, 2)),
+ (0x2f941, (1890, 2)),
+ (0x2f862, (468, 2)),
+ (0x2f8ff, (890, 2)),
+ (0x2f85d, (450, 2)),
+ (0xf9d9, (632, 2)),
+ (0x2f855, (412, 2)),
+ (0x2f98f, (1334, 2)),
+ (0xf9d4, (184, 2)),
+ (0xf99e, (360, 2)),
+ (0x2f850, (254, 2)),
+ (0xfa22, (1500, 2)),
+ (0x2f94f, (1134, 2)),
+ (0xfaa9, (1120, 2)),
+ (0xfa71, (234, 2)),
+ (0xf95d, (1504, 2)),
+ (0x2f8bd, (720, 2)),
+ (0x2fa02, (1706, 2)),
+ (0x2f93f, (64, 2)),
+ (0x2f808, (186, 2)),
+ (0x2f950, (1142, 2)),
+ (0x2f933, (60, 2)),
+ (0x2f853, (416, 2)),
+ (0x2f8f0, (1850, 2)),
+ (0xf967, (140, 2)),
+ (0xfa16, (1026, 2)),
+ (0xfaa6, (1100, 2)),
+ (0x2f8b3, (680, 2)),
+ (0x2f9f7, (1982, 2)),
+ (0xf986, (1636, 2)),
+ (0x2f99d, (1364, 2)),
+ (0x2f9b8, (1422, 2)),
+ (0xf998, (1558, 2)),
+ (0x2f82b, (306, 2)),
+ (0x2f872, (504, 2)),
+ (0xfab9, (1488, 2)),
+ (0xfa9b, (964, 2)),
+ (0xf9b0, (1292, 2)),
+ (0xf98b, (776, 2)),
+ (0xfad1, (1844, 2)),
+ (0xf917, (1044, 2)),
+ (0x2f989, (1838, 2)),
+ (0x2f866, (476, 2)),
+ (0xf932, (1000, 2)),
+ (0x2fa0e, (134, 2)),
+ (0xfa07, (1566, 2)),
+ (0xf9bd, (510, 2)),
+ (0x2f88c, (562, 2)),
+ (0xfa56, (1204, 2)),
+ (0xfa64, (1536, 2)),
+ (0xfa04, (488, 2)),
+ (0xfa9e, (1008, 2)),
+ (0x2f9e0, (1968, 2)),
+ (0x2f89d, (604, 2)),
+ (0x2f9ee, (1634, 2)),
+ (0xf9db, (1036, 2)),
+ (0xf923, (1400, 2)),
+ (0x2f841, (362, 2)),
+ (0x2f81a, (232, 2)),
+ (0xf911, (1440, 2)),
+ (0xfaad, (1206, 2)),
+ (0xfac1, (1540, 2)),
+ (0x2f928, (1032, 2)),
+ (0x2f935, (1878, 2)),
+ (0x2f8d5, (772, 2)),
+ (0xf92e, (238, 2)),
+ (0xfa59, (1262, 2)),
+ (0x2f96b, (1918, 2)),
+ (0x2f8b9, (702, 2)),
+ (0x2f877, (512, 2)),
+ (0x2fa00, (1698, 2)),
+ (0xfa05, (894, 2)),
+ (0xf9e8, (1462, 2)),
+ (0x2f8c6, (730, 2)),
+ (0xf97a, (820, 2)),
+ (0x2f9ea, (1620, 2)),
+ (0xf944, (1214, 2)),
+ (0x2f8c4, (732, 2)),
+ (0x2f9cd, (114, 2)),
+ (0x2f8e5, (816, 2)),
+ (0x2f9d9, (1790, 2)),
+ (0x2f980, (1836, 2)),
+ (0x2f9a8, (1390, 2)),
+ (0x2f92f, (1054, 2)),
+ (0x2f951, (76, 2)),
+ (0x2f9f9, (124, 2)),
+ (0xfab4, (1376, 2)),
+ (0xf985, (1146, 2)),
+ (0x2f829, (300, 2)),
+ (0x2f8a2, (26, 2)),
+ (0x2f9c3, (1450, 2)),
+ (0x2f936, (1076, 2)),
+ (0x2f9af, (104, 2)),
+ (0xfa77, (296, 2)),
+ (0xf956, (1184, 2)),
+ (0xfa5f, (1384, 2)),
+ (0x2f93b, (1882, 2)),
+ (0xf914, (838, 2)),
+ (0x2f994, (1340, 2)),
+ (0x2f91b, (1784, 2)),
+ (0x2f880, (538, 2)),
+ (0x2f956, (1176, 2)),
+ (0xf958, (1378, 2)),
+ (0x2f99b, (1362, 2)),
+ (0x2fa06, (1718, 2)),
+ (0xfabf, (1514, 2)),
+ (0x2f8b6, (696, 2)),
+ (0x2f8a0, (618, 2)),
+ (0xfa87, (640, 2)),
+ (0x2f8ea, (836, 2)),
+ (0x2f867, (10, 2)),
+ (0xf97d, (1492, 2)),
+ (0xf968, (884, 2)),
+ (0xfa5a, (1268, 2)),
+ (0xf97b, (1228, 2)),
+ (0x2fa10, (1992, 2)),
+ (0xfa2b, (1710, 2)),
+ (0xfa75, (220, 2)),
+ (0xf94d, (920, 2)),
+ (0xfad4, (68, 2)),
+ (0x2f8cc, (780, 2)),
+ (0xfa8a, (644, 2)),
+ (0xf9f4, (808, 2)),
+ (0xfac6, (1650, 2)),
+ (0xfa9c, (992, 2)),
+ (0xfa10, (426, 2)),
+ (0xf9e2, (828, 2)),
+ (0xf947, (1138, 2)),
+ (0xf941, (1494, 2)),
+ (0xfa4e, (1152, 2)),
+ (0x2f9da, (1548, 2)),
+ (0x2f893, (1318, 2)),
+ (0xf96f, (1484, 2)),
+ (0xf983, (752, 2)),
+ (0xf9f5, (918, 2)),
+ (0xf962, (1082, 2)),
+ (0x2f968, (1230, 2)),
+ (0x2f923, (1872, 2)),
+ (0x2fa18, (1758, 2)),
+ (0x2f930, (1060, 2)),
+ (0xfa90, (744, 2)),
+ (0xfa54, (1186, 2)),
+ (0xf9d8, (596, 2)),
+ (0x2f9e4, (1598, 2)),
+ (0x2fa05, (1716, 2)),
+ (0x2f964, (82, 2)),
+ (0xf99f, (982, 2)),
+ (0x2f94b, (72, 2)),
+ (0x2f9a9, (1392, 2)),
+ (0xfa0c, (198, 2)),
+ (0x2f986, (478, 2)),
+ (0xfa85, (602, 2)),
+ (0x2f95f, (1200, 2)),
+ (0xf9f8, (1202, 2)),
+ (0xf9b4, (1696, 2)),
+ (0x2f82e, (316, 2)),
+ (0xfad9, (1772, 2)),
+ (0x2f937, (1880, 2)),
+ (0xf9cf, (1234, 2)),
+ (0xfaa1, (1058, 2)),
+ (0x2f917, (970, 2)),
+ (0xfaa5, (1092, 2)),
+ (0xfa3b, (516, 2)),
+ (0x2f88d, (564, 2)),
+ (0x2f906, (1858, 2)),
+ (0x2f901, (912, 2)),
+ (0x2f97a, (1290, 2)),
+ (0xfa60, (1468, 2)),
+ (0x2f92c, (56, 2)),
+ (0x2f80a, (196, 2)),
+ (0x2f99a, (1360, 2)),
+ (0x2fa13, (1996, 2)),
+ (0x2f938, (1084, 2)),
+ (0x2f813, (2, 2)),
+ (0x2f831, (324, 2)),
+ (0xfa1c, (1678, 2)),
+ (0xfacc, (1702, 2)),
+ (0xfa5e, (1330, 2)),
+ (0x2f995, (1342, 2)),
+ (0x2f8d3, (226, 2)),
+ (0xfacd, (1726, 2)),
+ (0x2f81d, (248, 2)),
+ (0x2f97b, (1930, 2)),
+ (0xfa3a, (432, 2)),
+ (0xf9c6, (1640, 2)),
+ (0xfabd, (1506, 2)),
+ (0xf92d, (170, 2)),
+ (0xf99b, (1628, 2)),
+ (0xf91d, (852, 2)),
+ (0x2f84d, (410, 2)),
+ (0x2f8ad, (658, 2)),
+ (0xf9d3, (1648, 2)),
+ (0x2f843, (366, 2)),
+ (0xf97c, (1326, 2)),
+ (0xfa30, (174, 2)),
+ (0x2f858, (434, 2)),
+ (0x2f8a5, (624, 2)),
+ (0x2f988, (1938, 2)),
+ (0x2f9e1, (1970, 2)),
+ (0xfa74, (200, 2)),
+ (0x2f882, (546, 2)),
+ (0x2f879, (526, 2)),
+ (0x2f8b7, (704, 2)),
+ (0xf940, (1746, 2)),
+ (0x2f9e5, (1972, 2)),
+ (0x2f9cf, (1482, 2)),
+ (0xfa8e, (722, 2)),
+ (0x2f90c, (936, 2)),
+ (0x2f985, (1310, 2)),
+ (0x2f849, (388, 2)),
+ (0x2f960, (80, 2)),
+ (0x2f8c2, (30, 2)),
+ (0x2f85f, (462, 2)),
+ (0x2f916, (52, 2)),
+ (0xf9fa, (1022, 2)),
+ (0x2f824, (8, 2)),
+ (0xf936, (1414, 2)),
+ (0x2f94a, (1124, 2)),
+ (0x2f80e, (204, 2)),
+ (0x2f913, (968, 2)),
+ (0x2f94d, (1898, 2)),
+ (0xf999, (1388, 2)),
+ (0x2f979, (1282, 2)),
+ (0x2f926, (1874, 2)),
+ (0xf9ea, (1662, 2)),
+ (0xfa3f, (650, 2)),
+ (0x2f83b, (342, 2)),
+ (0xfa5b, (1286, 2)),
+ (0xfa93, (790, 2)),
+ (0xf913, (1586, 2)),
+ (0xf98c, (860, 2)),
+ (0x2f8c0, (718, 2)),
+ (0xfad7, (1964, 2)),
+ (0xf98a, (272, 2)),
+ (0xfa26, (1596, 2)),
+ (0xfabe, (1496, 2)),
+ (0x2f977, (1928, 2)),
+ (0xf954, (244, 2)),
+ (0xf91a, (1720, 2)),
+ (0x2f8cd, (760, 2)),
+ (0x2f8a4, (1822, 2)),
+ (0xfa84, (592, 2)),
+ (0x2f85e, (452, 2)),
+ (0xfa9f, (1020, 2)),
+ (0xf9b1, (1614, 2)),
+ (0x2f9ca, (4, 2)),
+ (0xfac4, (1604, 2)),
+ (0xf927, (1446, 2)),
+ (0xfa01, (558, 2)),
+ (0xf929, (784, 2)),
+ (0xf9f3, (1750, 2)),
+ (0x2f9e6, (1600, 2)),
+ (0xfa70, (142, 2)),
+ (0x2f820, (262, 2)),
+ (0xf9a9, (406, 2)),
+ (0x2f9bf, (108, 2)),
+ (0x2f922, (1012, 2)),
+ (0x2f9de, (1556, 2)),
+ (0x2f8ec, (1848, 2)),
+ (0xf9b5, (172, 2)),
+ (0x2f9b7, (1424, 2)),
+ (0x2f981, (92, 2)),
+ (0xfa31, (194, 2)),
+ (0x2f9c1, (1444, 2)),
+ (0x2f874, (588, 2)),
+ (0xf9d0, (1704, 2)),
+ (0xf94a, (438, 2)),
+ (0x2f998, (1346, 2)),
+ (0x2f91c, (986, 2)),
+ (0x2f9df, (1564, 2)),
+ (0x2f859, (1798, 2)),
+ (0x2f883, (16, 2)),
+ (0xf9cc, (1048, 2)),
+ (0x2f9b5, (1418, 2)),
+ (0x2f970, (1264, 2)),
+ (0x2f814, (210, 2)),
+ (0x2f9ff, (1694, 2)),
+ (0x2f84c, (398, 2)),
+ (0x2f9a4, (1942, 2)),
+ (0x2f966, (1222, 2)),
+ (0xfa1e, (1280, 2)),
+ (0x2fa0c, (1736, 2)),
+ (0x2f863, (470, 2)),
+ (0xfaa2, (1070, 2)),
+ (0x2f91a, (980, 2)),
+ (0x2f8f8, (1808, 2)),
+ (0x2f8a6, (634, 2)),
+ (0x2f895, (586, 2)),
+ (0xf90b, (376, 2)),
+ (0x2f993, (1338, 2)),
+ (0x2f8be, (1830, 2)),
+ (0xf948, (1532, 2)),
+ (0x2f80d, (1788, 2)),
+ (0x2f81f, (6, 2)),
+ (0xf9e4, (1046, 2)),
+ (0x2f823, (268, 2)),
+ (0x2f9fa, (1684, 2)),
+ (0x2f8fa, (876, 2)),
+ (0xfa6a, (1700, 2)),
+ (0x2f9f0, (1638, 2)),
+ (0x2f967, (84, 2)),
+ (0xfa8f, (726, 2)),
+ (0xfa06, (774, 2)),
+ (0xf982, (578, 2)),
+ (0xf989, (1754, 2)),
+ (0x2f990, (1332, 2)),
+ (0xfac9, (1682, 2)),
+ (0x2f8ed, (850, 2)),
+ (0x2f822, (266, 2)),
+ (0xf9cb, (932, 2)),
+ (0xfa4d, (1154, 2)),
+ (0x2f944, (1894, 2)),
+ (0x2f9e8, (1622, 2)),
+ (0x2f8d2, (224, 2)),
+ (0x2f97c, (1932, 2)),
+ (0xfa68, (1664, 2)),
+ (0xfa53, (1172, 2)),
+ (0x2f8f5, (872, 2)),
+ (0x2f945, (1112, 2)),
+ (0xfa95, (862, 2)),
+ (0xfa2e, (1592, 2)),
+ (0xf91b, (154, 2)),
+ (0x2f837, (334, 2)),
+ (0x2f894, (584, 2)),
+ (0x2fa09, (1990, 2)),
+ (0x2f974, (90, 2)),
+ (0xf9ba, (156, 2)),
+ (0x2f80b, (190, 2)),
+ (0xfaca, (1688, 2)),
+ (0x2f969, (1226, 2)),
+ (0x2f8b1, (674, 2)),
+ (0x2f8d1, (34, 2)),
+ (0x2f91d, (1866, 2)),
+ (0x2f9d4, (1528, 2)),
+ (0x2fa15, (1752, 2)),
+ (0x2f954, (1902, 2)),
+ (0xfa81, (482, 2)),
+ (0x2f9a5, (1946, 2)),
+ (0x2f90f, (954, 2)),
+ (0xf92a, (908, 2)),
+ (0x2fa19, (1760, 2)),
+ (0x2f943, (1892, 2)),
+ (0x2f947, (1116, 2)),
+ (0x2fa0a, (1728, 2)),
+ (0x2f963, (1210, 2)),
+ (0xf9bb, (192, 2)),
+ (0x2f8ac, (662, 2)),
+ (0xf9c5, (766, 2)),
+ (0x2f97e, (1934, 2)),
+ (0x2f889, (1814, 2)),
+ (0x2f8e9, (834, 2)),
+ (0xf9da, (814, 2)),
+ (0xface, (1778, 2)),
+ (0x2f920, (1004, 2)),
+ (0xf951, (1642, 2)),
+ (0xf9bc, (500, 2)),
+ (0x2f940, (1108, 2)),
+ (0x2f84e, (400, 2)),
+ (0xfa48, (990, 2)),
+ (0x2fa08, (130, 2)),
+ (0xf9e6, (1270, 2)),
+ (0x2f8c8, (742, 2)),
+ (0xf912, (1464, 2)),
+ (0x2f8f7, (1852, 2)),
+ (0x2f904, (914, 2)),
+ (0xfa76, (278, 2)),
+ (0x2f8e8, (832, 2)),
+ (0x2f9e2, (1588, 2)),
+ (0xf903, (1534, 2)),
+ (0xfa9a, (950, 2)),
+ (0xf996, (1250, 2)),
+ (0x2f8db, (802, 2)),
+ (0xfa4a, (1050, 2)),
+ (0xfa6b, (616, 2)),
+ (0x2f8fd, (886, 2)),
+ (0xfa79, (368, 2)),
+ (0xf987, (1724, 2)),
+ (0x2f8f2, (48, 2)),
+ (0xf90d, (672, 2)),
+ (0xf922, (958, 2)),
+ (0xfa88, (630, 2)),
+ (0xf91c, (320, 2)),
+ (0x2f870, (502, 2)),
+ (0x2f9ac, (1398, 2)),
+ (0x2f839, (338, 2)),
+ (0x2fa03, (128, 2)),
+ (0x2f854, (418, 2)),
+ (0x2f92a, (54, 2)),
+ (0xfa35, (312, 2)),
+ (0x2f9e7, (1616, 2)),
+ (0x2f9a6, (1944, 2)),
+ (0xfaaf, (1240, 2)),
+ (0x2f911, (1864, 2)),
+ (0x2f95d, (1908, 2)),
+ (0x2f89c, (598, 2)),
+ (0xfa45, (910, 2)),
+ (0xfa1b, (1174, 2)),
+ (0xfa3d, (620, 2)),
+ (0xf980, (350, 2)),
+ (0xfa8c, (684, 2)),
+ (0x2f9e9, (1624, 2)),
+ (0x2f9f8, (122, 2)),
+ (0x2f902, (904, 2)),
+ (0x2fa1d, (2002, 2)),
+ (0xfab6, (1470, 2)),
+ (0xf995, (1180, 2)),
+ (0x2f832, (326, 2)),
+ (0x2f955, (1904, 2)),
+ (0x2f8fc, (882, 2)),
+ (0x2f875, (508, 2)),
+ (0x2f82a, (302, 2)),
+ (0x2f811, (218, 2)),
+ (0x2f868, (12, 2)),
+ (0x2f925, (1018, 2)),
+ (0xfa20, (1406, 2)),
+ (0x2f83e, (352, 2)),
+ (0xf9af, (1278, 2)),
+ (0x2f997, (1940, 2)),
+ (0x2f9ec, (1632, 2)),
+ (0xf9ab, (542, 2)),
+ (0xf935, (1404, 2)),
+ (0xfa80, (474, 2)),
+ (0x2f95c, (1906, 2)),
+ (0xfa92, (786, 2)),
+ (0xf95b, (692, 2)),
+ (0xf93e, (1366, 2)),
+ (0xf9de, (344, 2)),
+ (0xf9f0, (1402, 2)),
+ (0x2f847, (380, 2)),
+ (0xfa98, (944, 2)),
+ (0xf90e, (1096, 2)),
+ (0xfa4f, (1156, 2)),
+ (0xfaa4, (1090, 2)),
+ (0x2f9c0, (1442, 2)),
+ (0x2f8bf, (724, 2)),
+ (0xfa62, (1508, 2)),
+ (0xf9b6, (1178, 2)),
+ (0x2f826, (284, 2)),
+ (0xf9c9, (810, 2)),
+ (0x2f992, (276, 2)),
+ (0x2f8e1, (818, 2)),
+ (0xf959, (1646, 2)),
+ (0x2f892, (1820, 2)),
+ (0xfa18, (1148, 2)),
+ (0x2f87d, (1812, 2)),
+ (0xf970, (868, 2)),
+ (0x2f92b, (1040, 2)),
+ (0x2fa04, (1714, 2)),
+ (0xfa89, (652, 2)),
+ (0x2f9e3, (1594, 2)),
+ (0x2f9c2, (110, 2)),
+ (0xfacb, (1690, 2)),
+ (0x2f9c8, (112, 2)),
+ (0x2f908, (928, 2)),
+ (0x2f86f, (498, 2)),
+ (0x2f98a, (1840, 2)),
+ (0xf9a8, (164, 2)),
+ (0x2f8c7, (32, 2)),
+ (0x2fa16, (138, 2)),
+ (0xfa4b, (1136, 2)),
+ (0x2f878, (522, 2)),
+ (0x2f8bb, (706, 2)),
+ (0x2f816, (1786, 2)),
+ (0x2f86a, (484, 2)),
+ (0xf9c3, (1584, 2)),
+ (0xf945, (1300, 2)),
+ (0x2f9fe, (1692, 2)),
+ (0xfa86, (626, 2)),
+ (0x2f82c, (310, 2)),
+ (0xf988, (1748, 2)),
+ (0xfac5, (1618, 2)),
+ (0xfa66, (1574, 2)),
+ (0x2f840, (358, 2)),
+ (0xf9ee, (998, 2)),
+ (0x2f830, (322, 2)),
+ (0x2f914, (966, 2)),
+ (0x2f942, (1888, 2)),
+ (0xfaa3, (1074, 2)),
+ (0xf974, (1344, 2)),
+ (0x2f807, (182, 2)),
+ (0x2f905, (916, 2)),
+ (0x2f9b2, (106, 2)),
+ (0x2f887, (554, 2)),
+ (0x2f912, (956, 2)),
+ (0xf9ae, (1056, 2)),
+ (0xf96a, (1236, 2)),
+ (0xf9b7, (1606, 2)),
+ (0x2f932, (1068, 2)),
+ (0x2f98d, (1570, 2)),
+ (0xfa25, (1578, 2)),
+ (0xf993, (988, 2)),
+ (0x2f9f5, (1672, 2)),
+ (0xf9df, (518, 2)),
+ (0x2f9c7, (1460, 2)),
+ (0x2f996, (1348, 2)),
+ (0x2f842, (364, 2)),
+ (0x2f869, (480, 2)),
+ (0x2f861, (1802, 2)),
+ (0x2f8af, (664, 2)),
+ (0x2f8c5, (736, 2)),
+ (0x2f962, (1208, 2)),
+ (0x2f98b, (1320, 2)),
+ (0x2f9a1, (1368, 2)),
+ (0xfad2, (42, 2)),
+ (0x2f9ae, (102, 2)),
+ (0x2f8bc, (710, 2)),
+ (0xf9b3, (1676, 2)),
+ (0x2f88f, (2000, 2)),
+ (0xf965, (180, 2)),
+ (0x2f953, (1160, 2)),
+ (0x2f84b, (408, 2)),
+ (0x2f90b, (940, 2)),
+ (0x2f834, (1794, 2)),
+ (0xfa2d, (1740, 2)),
+ (0x2f8e6, (830, 2)),
+ (0xf971, (1572, 2)),
+ (0x2fa1c, (1766, 2)),
+ (0xfa61, (1478, 2)),
+ (0x2f98e, (98, 2)),
+ (0x2f9c9, (1466, 2)),
+ (0xfa0b, (574, 2)),
+ (0x2f86b, (486, 2)),
+ (0xf949, (1670, 2)),
+ (0xfac7, (1666, 2)),
+ (0xf96e, (1382, 2)),
+ (0xf966, (600, 2)),
+ (0xf955, (242, 2)),
+ (0x2f8d0, (36, 2)),
+ (0x2f93a, (1088, 2)),
+ (0xf9ff, (260, 2)),
+ (0xfac8, (1680, 2)),
+ (0xf93c, (1168, 2)),
+ (0x2f845, (372, 2)),
+ (0x2f9ce, (116, 2)),
+ (0xfad6, (1916, 2)),
+ (0x2f95a, (1190, 2)),
+ (0xf9e9, (1608, 2)),
+ (0x2f91f, (1870, 2)),
+ (0xf950, (1260, 2)),
+ (0x2f8c1, (714, 2)),
+ (0x2f9ad, (1948, 2)),
+ (0x2f97f, (1298, 2)),
+ (0xfa83, (576, 2)),
+ (0x2f82d, (314, 2)),
+ (0x2f8df, (812, 2)),
+ (0x2f87c, (530, 2)),
+ (0xfa58, (1258, 2)),
+ (0x2f846, (374, 2)),
+ (0xfa37, (396, 2)),
+ (0xfa78, (384, 2)),
+ (0x2f9f6, (1978, 2)),
+ (0x2f99e, (1374, 2)),
+ (0xfad3, (66, 2)),
+ (0xfad0, (1824, 2)),
+ (0xf9d5, (528, 2)),
+ (0xfab7, (1474, 2)),
+ (0xfa09, (1644, 2)),
+ (0x2f8ce, (38, 2)),
+ (0xf957, (1246, 2)),
+ (0xf991, (734, 2)),
+ (0xfab8, (1480, 2)),
+ (0x2f8eb, (846, 2)),
+ (0x2f9b1, (1952, 2)),
+ (0xfa2a, (1708, 2)),
+ (0x2f93c, (1884, 2)),
+ (0xfa72, (212, 2)),
+ (0x2f96f, (1256, 2)),
+ (0x2f8d6, (1304, 2)),
+ (0x2f886, (552, 2)),
+ (0xf9fd, (160, 2)),
+ (0xf9c0, (996, 2)),
+ (0x2f9be, (1438, 2)),
+ (0xf9b8, (1658, 2)),
+ (0x2f81e, (250, 2)),
+ (0xf900, (1524, 2)),
+ (0x2f98c, (1322, 2)),
+ (0x2f93e, (62, 2)),
+ (0xfaa0, (1028, 2)),
+ (0x2f8f3, (858, 2)),
+ (0xf961, (1034, 2)),
+ (0x2f83d, (348, 2)),
+ (0x2f8f6, (874, 2)),
+ (0xf9d2, (682, 2)),
+ (0x2f84a, (392, 2)),
+ (0xf9e1, (796, 2)),
+ (0xfa7c, (428, 2)),
+ (0x2f9aa, (1396, 2)),
+ (0xfa51, (1162, 2)),
+ (0x2f8b8, (1828, 2)),
+ (0x2f931, (1062, 2)),
+ (0xfa7e, (454, 2)),
+ (0xf9a6, (1212, 2)),
+ (0xf976, (1080, 2)),
+ (0xfa97, (902, 2)),
+ (0x2f8e7, (44, 2)),
+ (0x2f88b, (560, 2)),
+ (0x2f9c6, (1458, 2)),
+ (0x2f8d9, (792, 2)),
+ (0xfa52, (1170, 2)),
+ (0x2fa0d, (132, 2)),
+ (0x2f900, (898, 2)),
+ (0x2f836, (332, 2)),
+ (0xf9ad, (1042, 2)),
+ (0xf934, (1284, 2)),
+ (0xfab0, (1254, 2)),
+ (0x2f809, (188, 2)),
+ (0x2f9f2, (120, 2)),
+ (0x2f86c, (1804, 2)),
+ (0xf9fc, (1516, 2)),
+ (0x2f95e, (1910, 2)),
+ (0xf9a3, (608, 2)),
+ (0x2f971, (88, 2)),
+ (0x2f89b, (24, 2)),
+ (0xf977, (158, 2)),
+ (0xfa1a, (1166, 2)),
+ (0xfa3c, (520, 2)),
+ (0x2f9bd, (1432, 2)),
+ (0xf928, (568, 2)),
+ (0x2f864, (472, 2)),
+ (0x2f9d1, (1522, 2)),
+ (0x2f982, (1306, 2)),
+ (0xf9dc, (1652, 2)),
+ (0x2f972, (1922, 2)),
+ (0x2f8cb, (756, 2)),
+ (0xf960, (612, 2)),
+ (0xf992, (952, 2)),
+ (0x2f8b4, (686, 2)),
+ (0x2f803, (1780, 2)),
+ (0x2f818, (230, 2)),
+ (0xf9f7, (1198, 2)),
+ (0x2f827, (292, 2)),
+ (0x2f9fb, (1984, 2)),
+ (0x2f987, (1936, 2)),
+ (0xfaab, (1140, 2)),
+ (0xfa39, (424, 2)),
+ (0x2fa07, (1722, 2)),
+ (0xf9b9, (628, 2)),
+ (0x2f86e, (492, 2)),
+ (0x2f8e0, (806, 2)),
+ (0xfaa7, (1102, 2)),
+ (0x2f8a8, (642, 2)),
+ (0xfa0a, (1476, 2)),
+ (0x2fa14, (1998, 2)),
+ (0x2f888, (18, 2)),
+ (0x2f9a2, (1370, 2)),
+ (0x2f848, (386, 2)),
+ (0xfaa8, (1106, 2)),
+ (0xfa67, (1580, 2)),
+ (0xf946, (1014, 2)),
+ (0x2f946, (1114, 2)),
+ (0xfa7d, (436, 2)),
+ (0xfa1d, (1220, 2)),
+ (0x2fa11, (136, 2)),
+ (0xfa2c, (1712, 2)),
+ (0xf924, (1472, 2)),
+ (0x2f96e, (1248, 2)),
+ (0xf96d, (1110, 2)),
+ (0xf95a, (1518, 2)),
+ (0x2f85c, (448, 2)),
+ (0xf92b, (1024, 2)),
+ (0xfac0, (1520, 2)),
+ (0xfa8d, (716, 2)),
+ (0x2f9d8, (1966, 2)),
+ (0xf938, (1674, 2)),
+ (0x2f821, (264, 2)),
+ (0xf9aa, (496, 2)),
+ (0xf9ce, (1130, 2)),
+ (0xfa47, (948, 2)),
+ (0x2f8aa, (648, 2)),
+ (0x2f918, (976, 2)),
+ (0x2f8ee, (46, 2)),
+ (0xf96b, (330, 2)),
+ (0xf909, (458, 2)),
+ (0x2f87f, (534, 2)),
+ (0xf908, (1776, 2)),
+ (0xfa5d, (1328, 2)),
+ (0xf9ac, (614, 2)),
+ (0x2f896, (22, 2)),
+ (0x2f9b0, (1950, 2)),
+ (0xf9a7, (1030, 2)),
+ (0xf99d, (274, 2)),
+ (0x2f957, (1182, 2)),
+ (0xf905, (144, 2)),
+ (0x2f9bc, (1430, 2)),
+ (0x2f8f9, (1854, 2)),
+ (0x2f8b0, (670, 2)),
+ (0x2f881, (544, 2)),
+ (0x2fa1b, (1764, 2)),
+ (0x2f9dd, (1792, 2)),
+ (0x2f9ed, (1974, 2)),
+ (0x2f871, (1806, 2)),
+ (0x2f8ab, (654, 2)),
+ (0x2f812, (1782, 2)),
+ (0xf933, (1104, 2)),
+ (0xf9f2, (1734, 2)),
+ (0xf984, (960, 2)),
+ (0x2f90e, (924, 2)),
+ (0xfab2, (1288, 2)),
+ (0xfa32, (202, 2)),
+ (0x2f96d, (86, 2)),
+ (0x2f9a7, (100, 2)),
+ (0xf94f, (1238, 2)),
+ (0x2fa0f, (1738, 2)),
+ (0xf925, (690, 2)),
+ (0xfa91, (764, 2)),
+ (0xf972, (880, 2)),
+ (0xf90a, (1612, 2)),
+ (0xfa02, (694, 2)),
+ (0xf92f, (288, 2)),
+ (0xf9dd, (258, 2)),
+ (0xfa17, (1098, 2)),
+ (0xf93f, (1626, 2)),
+ (0x2f898, (1920, 2)),
+ (0x2f907, (896, 2)),
+ (0xf9ec, (934, 2)),
+ (0xf9e3, (888, 2)),
+ (0xfab5, (1434, 2)),
+ (0xfa40, (666, 2)),
+ (0x2f815, (222, 2)),
+ (0x2f9db, (1546, 2)),
+ (0xf91e, (1002, 2)),
+ (0xf92c, (1590, 2)),
+ (0x2f884, (548, 2)),
+ (0xfa46, (926, 2)),
+ (0x2f9b3, (1412, 2)),
+ (0x2f85b, (446, 2)),
+ (0xf9cd, (1078, 2)),
+ (0xf93a, (1742, 2)),
+ (0xf97e, (1610, 2)),
+ (0xfa3e, (646, 2)),
+ (0x2f9eb, (1630, 2)),
+ (0x2f8e2, (824, 2)),
+ (0x2f9b6, (1420, 2)),
+ (0xf916, (984, 2)),
+ (0x2f8de, (40, 2)),
+ (0xf98f, (656, 2)),
+ (0xfa12, (762, 2)),
+ (0xfa44, (822, 2)),
+ (0xf981, (464, 2)),
+ (0x2f9dc, (1552, 2)),
+ (0xf95c, (840, 2)),
+ (0xf937, (1550, 2)),
+ (0x2f87a, (524, 2)),
+ (0x2f903, (906, 2)),
+ (0x2f9c5, (1956, 2)),
+ (0x2f8cf, (770, 2)),
+ (0x2f909, (930, 2)),
+ (0x2f991, (1336, 2)),
+ (0xfa65, (1538, 2)),
+ (0xfa73, (168, 2)),
+ (0x2f88e, (570, 2)),
+ (0xf9ef, (1066, 2)),
+ (0x2f9cb, (1958, 2)),
+ (0x2f9a3, (1372, 2)),
+ (0x2f99c, (1352, 2)),
+ (0x2f919, (974, 2)),
+ (0x2f857, (420, 2)),
+ (0x2f96c, (1242, 2)),
+ (0x2f800, (150, 2)),
+ (0x2fa1a, (1762, 2)),
+ (0xf97f, (294, 2)),
+ (0xfaba, (1502, 2)),
+ (0xfa82, (572, 2)),
+ (0x2f92e, (1052, 2)),
+ (0xf9fe, (1354, 2)),
+ (0xf994, (1064, 2)),
+ (0x2f83c, (356, 2)),
+ (0xfa50, (1158, 2)),
+ (0x2f817, (228, 2)),
+ (0xfa38, (402, 2)),
+ (0xfa69, (1686, 2)),
+ (0xfaac, (1196, 2)),
+ (0xf901, (778, 2)),
+ (0xfa33, (282, 2)),
+ (0xf9bf, (842, 2)),
+ (0xf9d1, (216, 2)),
+ (0xf95f, (494, 2)),
+ (0x2f82f, (318, 2)),
+ (0xf9a4, (708, 2)),
+ (0x2f89e, (606, 2)),
+ (0x2f801, (146, 2)),
+ (0x2f84f, (404, 2)),
+ (0x2f961, (1912, 2)),
+ (0x2f87e, (536, 2)),
+ (0x2f9d5, (1530, 2)),
+ (0xf9e7, (1456, 2)),
+ (0xf973, (700, 2)),
+ (0xf9c2, (1394, 2)),
+ (0x2f9d0, (1498, 2)),
+ (0xf9a5, (866, 2)),
+ (0x2f80c, (0, 2)),
+ (0xf930, (738, 2)),
+ (0x2f8a1, (28, 2)),
+ (0x2f828, (298, 2)),
+ (0x2f89f, (610, 2)),
+ (0xf964, (1144, 2)),
+ (0xf94e, (946, 2)),
+ (0x2f8d7, (94, 2)),
+ (0x2f806, (178, 2)),
+ (0x2f9cc, (1960, 2)),
+ (0x2f94e, (1128, 2)),
+ (0x2f929, (1038, 2)),
+ (0xfa34, (290, 2)),
+ (0x2f939, (1816, 2)),
+ (0xf910, (1410, 2)),
+ (0xf926, (1312, 2)),
+ (0xf9a2, (566, 2)),
+ (0xfa49, (1006, 2)),
+ (0xf953, (1302, 2)),
+ (0x2f80f, (206, 2)),
+ (0xf963, (304, 2)),
+ (0x2f8d4, (782, 2)),
+ (0xf9b2, (1668, 2)),
+ (0x2f973, (1924, 2)),
+ (0x2f897, (1834, 2)),
+ (0x2f9fc, (126, 2)),
+ (0xf99a, (1576, 2)),
+ (0x2f85a, (444, 2)),
+ (0xfacf, (1826, 2)),
+ (0x2f9ab, (1954, 2)),
+ (0x2f927, (1876, 2)),
+ (0x2f9fd, (1986, 2)),
+ (0xfa36, (382, 2)),
+ (0xf904, (942, 2)),
+ (0x2f81c, (1980, 2)),
+ (0xfa7b, (394, 2)),
+ (0xfa41, (740, 2)),
+ (0x2f87b, (1810, 2)),
+ (0x2f9ba, (1426, 2)),
+ (0xf979, (240, 2)),
+ (0xf9d7, (1560, 2)),
+];
+
+pub(crate) const COMBINING_MARK_SALT: &[u16] = &[
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x4,
+ 0xc,
+ 0x5,
+ 0x689,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xab,
+ 0x0,
+ 0x158,
+ 0x0,
+ 0x5a,
+ 0x1c6,
+ 0x143,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x92,
+ 0x0,
+ 0x0,
+ 0x24d,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x7f,
+ 0xc,
+ 0x0,
+ 0xc7,
+ 0x0,
+ 0x16d,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xda,
+ 0x4,
+ 0x19,
+ 0x5,
+ 0x0,
+ 0x93,
+ 0x6,
+ 0x7c,
+ 0x13,
+ 0x11b,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x58,
+ 0x0,
+ 0x5c,
+ 0xa5,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x79,
+ 0x7,
+ 0x0,
+ 0xa0,
+ 0x37,
+ 0x0,
+ 0x7,
+ 0x36,
+ 0x5,
+ 0x39,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x73,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3d,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x54,
+ 0x1,
+ 0x0,
+ 0x27,
+ 0x4d,
+ 0xfa,
+ 0x4d,
+ 0x3,
+ 0x1c,
+ 0xdd,
+ 0x6,
+ 0x1,
+ 0x24,
+ 0x41,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0xb6,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x1,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x9e,
+ 0x1,
+ 0x0,
+ 0x21,
+ 0x0,
+ 0x25,
+ 0x4,
+ 0x10,
+ 0x4,
+ 0x15,
+ 0x2,
+ 0x1,
+ 0x23,
+ 0x5,
+ 0x84,
+ 0x0,
+ 0x0,
+ 0xf,
+ 0xa,
+ 0x2,
+ 0x37,
+ 0x1,
+ 0x0,
+ 0x46,
+ 0xd,
+ 0x12,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x24,
+ 0xc,
+ 0x4a,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x42,
+ 0x0,
+ 0x4,
+ 0x13,
+ 0x2,
+ 0x13,
+ 0x7b,
+ 0x3e,
+ 0x0,
+ 0x11,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x31,
+ 0x3,
+ 0x0,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x35,
+ 0x6,
+ 0xe,
+ 0x1e,
+ 0xc1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x1c,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x9,
+ 0x3,
+ 0x8d,
+ 0x70,
+ 0x54,
+ 0x23,
+ 0x11,
+ 0x1f,
+ 0x5,
+ 0x17,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x47,
+ 0x17,
+ 0xc,
+ 0x2a,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x38,
+ 0x11,
+ 0x15,
+ 0x39,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x53,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0xf,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x28,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x2e,
+ 0x6,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x15,
+ 0x2e,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3f,
+ 0x8,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1a,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x0,
+ 0x14,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x19,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x6,
+ 0x10,
+ 0x12,
+ 0x1,
+ 0x16,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x21,
+ 0x1,
+ 0x3,
+ 0x13,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x38,
+ 0x2,
+ 0x20,
+ 0x3,
+ 0x0,
+ 0xa,
+ 0xe,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x18,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1b,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x20,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x16,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x8,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1f,
+ 0xa,
+ 0x28,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0xd,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3a,
+ 0x4,
+ 0x8,
+ 0xb,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x22,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x17,
+ 0x7,
+ 0x9,
+ 0x27,
+ 0x0,
+ 0x1,
+ 0x11,
+ 0x7,
+ 0x23,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x8,
+ 0x2,
+ 0x27,
+ 0x8,
+ 0x0,
+ 0x17,
+ 0xc,
+ 0x3b,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2e,
+ 0x5,
+ 0x7,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0xf,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0xf,
+ 0x0,
+ 0x1,
+ 0x12,
+ 0x24,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x1f,
+ 0x15,
+ 0xd,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x1,
+ 0xe,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2e,
+ 0x0,
+ 0x11,
+ 0x0,
+ 0x1b,
+ 0xa,
+ 0x13,
+ 0x12,
+ 0x2,
+ 0x9,
+ 0x1,
+ 0xd,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0xb,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x13,
+ 0x16,
+ 0xd,
+ 0xe,
+ 0x4,
+ 0xf,
+ 0xb,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0xd,
+ 0x2,
+ 0xb,
+ 0x0,
+ 0x1d,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x6,
+ 0xe,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x14,
+ 0x0,
+ 0x0,
+ 0x15,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x17,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x7,
+ 0x2,
+ 0x1f,
+ 0x9,
+ 0x0,
+ 0x4,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x17,
+ 0x6,
+ 0xf,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x9,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x12,
+ 0x4,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x18,
+ 0x0,
+ 0x3,
+ 0xc,
+ 0x0,
+ 0x2,
+ 0x26,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0x8,
+ 0x16,
+ 0x1,
+ 0x3,
+ 0x11,
+ 0x0,
+ 0x13,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x1a,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x9,
+ 0x4,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0xf,
+ 0x4,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x9,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x15,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x11,
+ 0x6,
+ 0x6,
+ 0xd,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x20,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x11,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x19,
+ 0x4,
+ 0x1,
+ 0x13,
+ 0x1,
+ 0x2,
+ 0x9,
+ 0xb,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1a,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x10,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x12,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x13,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x6,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x15,
+ 0x0,
+ 0x1,
+ 0x9,
+ 0xe,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0xe,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0xb,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x9,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0xd,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x2c,
+ 0xa,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x27,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x15,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0xa,
+ 0x9,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0xf,
+ 0x0,
+ 0x3,
+ 0xa,
+ 0x3,
+ 0x4,
+ 0xd,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x1e,
+ 0x1,
+ 0x1,
+ 0xa,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x7,
+ 0x3,
+ 0xe,
+ 0x3,
+ 0x4,
+ 0xf,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x10,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0xb,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0xa,
+ 0xa,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x2,
+ 0xb,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0xc,
+ 0xc,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x7,
+ 0x5,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0xc,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x9,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x4,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x10,
+ 0x7,
+ 0x1,
+ 0x5,
+ 0xe,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x7,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x6,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x14,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0xb,
+ 0x5,
+ 0x0,
+ 0xf,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x9,
+ 0x1,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x6,
+ 0xb,
+ 0x7,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0xa,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x6,
+ 0x2,
+ 0x14,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x6,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0xa,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x5,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x12,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xf,
+ 0x3,
+ 0x2,
+ 0xe,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x11,
+ 0x0,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x3,
+ 0x5,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x8,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0xb,
+ 0x2,
+ 0x2,
+ 0xf,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0xc,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0xb,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x5,
+ 0x2,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0xa,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x7,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0xa,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x6,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0xa,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x4,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0xa,
+ 0x6,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0xe,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x6,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x5,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x4,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x11,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0xa,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0xb,
+ 0x1,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0xf,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+];
+pub(crate) const COMBINING_MARK_KV: &[u32] = &[
+ 0xe01cb,
+ 0x115dd,
+ 0x0e3a,
+ 0x11441,
+ 0xe0134,
+ 0x11cb1,
+ 0x115bd,
+ 0x0faf,
+ 0xe01dc,
+ 0x11181,
+ 0x11934,
+ 0x11374,
+ 0x0823,
+ 0xa67c,
+ 0x0a4d,
+ 0xa952,
+ 0x1e003,
+ 0x0e49,
+ 0x17b5,
+ 0x1074,
+ 0x2dfe,
+ 0xa8be,
+ 0x101fd,
+ 0x102e0,
+ 0x0fb1,
+ 0xa9ba,
+ 0x0c00,
+ 0x1daa6,
+ 0x05a2,
+ 0xfe26,
+ 0x0a41,
+ 0x07a6,
+ 0x0898,
+ 0x0b82,
+ 0x0afb,
+ 0x0fbb,
+ 0x1a7a,
+ 0x1cf1a,
+ 0x16f6b,
+ 0xa675,
+ 0x1cf45,
+ 0xe012f,
+ 0xe014f,
+ 0x11c3b,
+ 0x2df7,
+ 0xa9bf,
+ 0xa8eb,
+ 0x1bc9e,
+ 0x1a74,
+ 0x0eb8,
+ 0x302c,
+ 0x0c4d,
+ 0x064f,
+ 0x105e,
+ 0x0741,
+ 0x1da44,
+ 0x0b44,
+ 0x1924,
+ 0x1da1d,
+ 0x09c0,
+ 0xfe2d,
+ 0x0330,
+ 0xe01c3,
+ 0x109d,
+ 0x0322,
+ 0x1cf18,
+ 0x0c02,
+ 0xe0128,
+ 0x17cb,
+ 0x1acb,
+ 0xe01e3,
+ 0xa802,
+ 0x16f72,
+ 0x11001,
+ 0x11634,
+ 0x1da9b,
+ 0x08ce,
+ 0x0eb7,
+ 0x11041,
+ 0x1a7b,
+ 0x1057,
+ 0xe0150,
+ 0x1b6d,
+ 0x0ce2,
+ 0xa8e6,
+ 0x1103e,
+ 0x0619,
+ 0x11081,
+ 0x0fa3,
+ 0x114c3,
+ 0x11a90,
+ 0x082c,
+ 0x11173,
+ 0x1a66,
+ 0x1e8d4,
+ 0x1d16e,
+ 0x111b8,
+ 0x1934,
+ 0x1cf0c,
+ 0xe01ce,
+ 0x1cf39,
+ 0x111be,
+ 0xe01d2,
+ 0x1da08,
+ 0xe0141,
+ 0x11236,
+ 0x110c2,
+ 0xfe25,
+ 0x16b36,
+ 0x0657,
+ 0x0749,
+ 0x0311,
+ 0xe01c4,
+ 0x20d3,
+ 0x1da21,
+ 0x1be9,
+ 0x1cf0e,
+ 0x16f5d,
+ 0x1d182,
+ 0x1cf41,
+ 0x08fe,
+ 0xfe05,
+ 0x11a59,
+ 0x1de6,
+ 0x1ac6,
+ 0xe0120,
+ 0x11a38,
+ 0x110b7,
+ 0x1dec,
+ 0x0351,
+ 0x0309,
+ 0x1dcd,
+ 0x115bc,
+ 0x114b5,
+ 0x16f80,
+ 0x11182,
+ 0x16f6e,
+ 0x11caa,
+ 0xe0198,
+ 0x0dd8,
+ 0xa80b,
+ 0x0eca,
+ 0x1df0,
+ 0xa8c5,
+ 0x0fbc,
+ 0x1136c,
+ 0x1064,
+ 0x1c29,
+ 0x114c0,
+ 0x1030,
+ 0x1abd,
+ 0x0e4c,
+ 0x0a02,
+ 0x1143d,
+ 0x1e4ed,
+ 0x20d8,
+ 0x11a04,
+ 0x1cf26,
+ 0xe0116,
+ 0x0acc,
+ 0x10f4d,
+ 0xaaed,
+ 0x07aa,
+ 0x0902,
+ 0x11442,
+ 0xe012c,
+ 0x0ac7,
+ 0xaabe,
+ 0x1921,
+ 0x11c9c,
+ 0x11f3e,
+ 0x11102,
+ 0x0953,
+ 0x1da5b,
+ 0xa8e9,
+ 0x11044,
+ 0x16b33,
+ 0x08e3,
+ 0xe0158,
+ 0xa826,
+ 0x11f41,
+ 0x0f19,
+ 0x1058,
+ 0xe01ef,
+ 0xe011d,
+ 0x17bb,
+ 0x1171f,
+ 0x11232,
+ 0x1cd7,
+ 0x0364,
+ 0x1c35,
+ 0x0a3f,
+ 0x1a5a,
+ 0x13453,
+ 0x11a55,
+ 0x1def,
+ 0x0342,
+ 0x0b4c,
+ 0xe01ea,
+ 0x1cf32,
+ 0x1082,
+ 0x0b63,
+ 0x1ac5,
+ 0x11635,
+ 0x1a69,
+ 0x0487,
+ 0xe0164,
+ 0x1da33,
+ 0xe0107,
+ 0x0bc0,
+ 0x11c3e,
+ 0xe01c1,
+ 0x1daae,
+ 0x0fa1,
+ 0x11c95,
+ 0xa671,
+ 0x1c36,
+ 0x1b71,
+ 0x1b80,
+ 0x033c,
+ 0x20d5,
+ 0x116ae,
+ 0x1da54,
+ 0x0819,
+ 0x1e01f,
+ 0x0301,
+ 0x119dc,
+ 0x11726,
+ 0x031c,
+ 0x17b8,
+ 0xe015b,
+ 0x1dd0,
+ 0x0f9e,
+ 0x0f94,
+ 0x0f7f,
+ 0x11d32,
+ 0x11a8b,
+ 0x1dda,
+ 0xe017a,
+ 0x116b6,
+ 0x11c9b,
+ 0x0f8e,
+ 0x11720,
+ 0xaa7d,
+ 0x10f82,
+ 0xa9b6,
+ 0x0744,
+ 0x11f01,
+ 0x16f73,
+ 0x11632,
+ 0x0e38,
+ 0x0bcc,
+ 0x11f37,
+ 0x07f1,
+ 0x0340,
+ 0x116b3,
+ 0x11002,
+ 0x1e946,
+ 0x1cf1d,
+ 0x1da49,
+ 0x1da2e,
+ 0x1b3e,
+ 0xe010a,
+ 0x09e2,
+ 0x1cf2d,
+ 0x0b03,
+ 0x094f,
+ 0x11373,
+ 0x13449,
+ 0x11838,
+ 0xaa36,
+ 0x0ccc,
+ 0xe01b0,
+ 0x07ad,
+ 0x1df1,
+ 0x17cd,
+ 0x13455,
+ 0x0ae2,
+ 0x1cf3c,
+ 0x1cf27,
+ 0x16f85,
+ 0x1e00a,
+ 0x11c9f,
+ 0x1d168,
+ 0x119de,
+ 0x11932,
+ 0x1dc0,
+ 0x110b0,
+ 0x1e948,
+ 0x1da27,
+ 0x10378,
+ 0x0310,
+ 0x0df2,
+ 0x11038,
+ 0x114b4,
+ 0x093a,
+ 0x1ce0,
+ 0x094c,
+ 0x16f64,
+ 0xa8ec,
+ 0x111bf,
+ 0x11133,
+ 0x1bec,
+ 0x1da35,
+ 0xa94d,
+ 0x1cf00,
+ 0x032f,
+ 0xa928,
+ 0x05c7,
+ 0x1a19,
+ 0x0354,
+ 0x11942,
+ 0x1cf34,
+ 0x07b0,
+ 0x0afa,
+ 0x1c32,
+ 0x1da0d,
+ 0x1cf25,
+ 0x11d8b,
+ 0x116b4,
+ 0x1ac7,
+ 0xa9bc,
+ 0x1d18a,
+ 0xfe21,
+ 0xe0183,
+ 0x07ac,
+ 0x13450,
+ 0xe012d,
+ 0x119d6,
+ 0x1de1,
+ 0x0cbe,
+ 0x065b,
+ 0x0316,
+ 0x1a59,
+ 0x1e004,
+ 0xa670,
+ 0x1da4b,
+ 0x17dd,
+ 0x1e008,
+ 0xe0191,
+ 0x0f18,
+ 0x1143f,
+ 0xe0190,
+ 0xabe3,
+ 0x1da4d,
+ 0x0cd5,
+ 0x0dda,
+ 0x0d63,
+ 0x0e35,
+ 0x1cf1e,
+ 0x1da1e,
+ 0xe01e8,
+ 0x114bf,
+ 0x0746,
+ 0x1cd1,
+ 0x1da75,
+ 0x1e2ec,
+ 0x0596,
+ 0x1dfa,
+ 0x0334,
+ 0x16f77,
+ 0x09e3,
+ 0xe019f,
+ 0x17ba,
+ 0x0ac1,
+ 0x1de3,
+ 0x1e130,
+ 0x1ba1,
+ 0xe01a8,
+ 0x1ac3,
+ 0x11c38,
+ 0x111b3,
+ 0x0357,
+ 0xe012a,
+ 0x116ac,
+ 0x0f76,
+ 0x119e0,
+ 0x1a72,
+ 0x0fa2,
+ 0x1772,
+ 0x05b3,
+ 0x1df7,
+ 0x11cb6,
+ 0x1da63,
+ 0x16f70,
+ 0x1cf8,
+ 0x0747,
+ 0x112e4,
+ 0x1e8d3,
+ 0xaa31,
+ 0x0cc3,
+ 0xfe0d,
+ 0x11a37,
+ 0x1dcb,
+ 0x0317,
+ 0x1dc8,
+ 0x1c2b,
+ 0x0eba,
+ 0x085a,
+ 0x11835,
+ 0x036c,
+ 0x05af,
+ 0x1143b,
+ 0x1da10,
+ 0x11c9e,
+ 0xa8e1,
+ 0x035c,
+ 0x1b03,
+ 0x0366,
+ 0x05c4,
+ 0x1cf0d,
+ 0x11a8a,
+ 0xe01c8,
+ 0xe01a9,
+ 0x06e1,
+ 0xfe24,
+ 0xa926,
+ 0xa824,
+ 0xa92d,
+ 0x111bc,
+ 0xabea,
+ 0x0afc,
+ 0x1ded,
+ 0x065a,
+ 0x0952,
+ 0x1da5d,
+ 0x0956,
+ 0x1ce1,
+ 0x11933,
+ 0x1d167,
+ 0xa69f,
+ 0x0d3e,
+ 0x110b5,
+ 0x116b2,
+ 0x1e017,
+ 0xe013e,
+ 0x1d180,
+ 0x1da67,
+ 0xaaeb,
+ 0x1dd1,
+ 0xaab8,
+ 0x1cf22,
+ 0x2cf1,
+ 0x06d7,
+ 0x1930,
+ 0x1da34,
+ 0x0326,
+ 0x1032,
+ 0x1be7,
+ 0x09c4,
+ 0x1da57,
+ 0x1136a,
+ 0x1daa1,
+ 0xe0179,
+ 0x0cc1,
+ 0x11129,
+ 0x10f83,
+ 0x1034,
+ 0x0a82,
+ 0xa951,
+ 0x1344b,
+ 0x2d7f,
+ 0x09c7,
+ 0x11f39,
+ 0x11f34,
+ 0x16f5b,
+ 0x0bbe,
+ 0x031a,
+ 0x11d8e,
+ 0x1e949,
+ 0x1ab6,
+ 0x1b40,
+ 0x1d16d,
+ 0x0d82,
+ 0x1134c,
+ 0x033f,
+ 0x11d3f,
+ 0x0dd6,
+ 0x11445,
+ 0x1a58,
+ 0x08de,
+ 0x1ac2,
+ 0x1b34,
+ 0x11ef4,
+ 0x11d35,
+ 0xe0195,
+ 0x1c37,
+ 0xa9e5,
+ 0xa980,
+ 0xe0185,
+ 0xe018e,
+ 0xa8ba,
+ 0x193b,
+ 0x1da3b,
+ 0x094b,
+ 0x10f48,
+ 0x0d3c,
+ 0x1dc9,
+ 0x11046,
+ 0x1926,
+ 0x05b0,
+ 0x0c55,
+ 0x11c3c,
+ 0x08e6,
+ 0x0617,
+ 0xe0109,
+ 0x1e134,
+ 0xfe2c,
+ 0xabe6,
+ 0xfe0f,
+ 0x1df6,
+ 0x1ac9,
+ 0x103c,
+ 0x093c,
+ 0xe0154,
+ 0x0ddb,
+ 0x1cf13,
+ 0x114c2,
+ 0x20ea,
+ 0xe01de,
+ 0x06ec,
+ 0x105f,
+ 0x1d16f,
+ 0xfe27,
+ 0xe01c5,
+ 0xe0182,
+ 0x05b5,
+ 0xe0104,
+ 0xa9be,
+ 0x1e002,
+ 0x0cbf,
+ 0x1886,
+ 0x1b82,
+ 0x0fc6,
+ 0x032a,
+ 0x0670,
+ 0x0981,
+ 0x0595,
+ 0x08df,
+ 0x08ca,
+ 0x1715,
+ 0x0b41,
+ 0x0658,
+ 0x1dc2,
+ 0x065c,
+ 0xe0130,
+ 0x1bac,
+ 0x1c24,
+ 0x20de,
+ 0x111bd,
+ 0xa8b4,
+ 0x0486,
+ 0x0302,
+ 0xe0102,
+ 0x1145e,
+ 0x1da3d,
+ 0x1cf11,
+ 0xe0151,
+ 0xe01b4,
+ 0x05b7,
+ 0x1ab4,
+ 0x1ba2,
+ 0x1d1ad,
+ 0x1182d,
+ 0x1d18b,
+ 0x17bd,
+ 0x1cf1f,
+ 0x0ac9,
+ 0x11ca7,
+ 0x1deb,
+ 0x1d17b,
+ 0x1da68,
+ 0x0ecc,
+ 0x1c30,
+ 0x116b5,
+ 0xa8e7,
+ 0x1112a,
+ 0x11a3d,
+ 0x1136b,
+ 0x05c5,
+ 0x11363,
+ 0x08f6,
+ 0x1ab0,
+ 0x1163d,
+ 0x0c82,
+ 0x1cf40,
+ 0x0f3f,
+ 0xe0100,
+ 0x0dd3,
+ 0x1035,
+ 0x1a76,
+ 0x1daa4,
+ 0x0314,
+ 0x10f46,
+ 0x16f79,
+ 0xe0159,
+ 0x0f9c,
+ 0xe013c,
+ 0x1183a,
+ 0x1e000,
+ 0x1da41,
+ 0x11a47,
+ 0x0733,
+ 0x1da60,
+ 0x11440,
+ 0x1b72,
+ 0x07af,
+ 0x0f73,
+ 0xa827,
+ 0xe01e9,
+ 0x11a96,
+ 0x1e012,
+ 0x11830,
+ 0x1da46,
+ 0x2de6,
+ 0x1cdb,
+ 0x0616,
+ 0xfe01,
+ 0x11300,
+ 0x0951,
+ 0x0abc,
+ 0xaa29,
+ 0x1931,
+ 0x1da17,
+ 0x1a6d,
+ 0x11723,
+ 0x10f4a,
+ 0xe011e,
+ 0x06e4,
+ 0x0343,
+ 0x1cd2,
+ 0x20d9,
+ 0x1163e,
+ 0x05a8,
+ 0x1122e,
+ 0x1de0,
+ 0x103e,
+ 0x102d,
+ 0x1da0b,
+ 0xaac1,
+ 0x16f7c,
+ 0x20da,
+ 0xa948,
+ 0xa67a,
+ 0x1cf23,
+ 0xaa35,
+ 0xa8bc,
+ 0x1da55,
+ 0xe01b3,
+ 0x16f57,
+ 0x10a05,
+ 0x1172a,
+ 0x1a77,
+ 0x116b1,
+ 0x1dc1,
+ 0x1cf06,
+ 0x0a75,
+ 0x16f75,
+ 0x11d45,
+ 0x1b3c,
+ 0x1037,
+ 0xe01be,
+ 0xe01a5,
+ 0x11833,
+ 0x0954,
+ 0xfe0b,
+ 0x16f6f,
+ 0x10eff,
+ 0x064e,
+ 0x0320,
+ 0x1dcf,
+ 0xfe29,
+ 0x09be,
+ 0x0f35,
+ 0x0cd6,
+ 0x0489,
+ 0x0d4a,
+ 0x17b7,
+ 0x1dfc,
+ 0xabe8,
+ 0x1dce,
+ 0x1b6c,
+ 0x0ddf,
+ 0x16f90,
+ 0x11633,
+ 0x11a94,
+ 0xa94f,
+ 0x11837,
+ 0x0d00,
+ 0x1d171,
+ 0x108b,
+ 0x0732,
+ 0x11a99,
+ 0x1d186,
+ 0x0303,
+ 0x10377,
+ 0x114b3,
+ 0x1e015,
+ 0x0f9f,
+ 0x0acd,
+ 0xa8c1,
+ 0x1daa3,
+ 0x11c98,
+ 0x115ba,
+ 0xe017b,
+ 0x0bc7,
+ 0x11368,
+ 0x08e7,
+ 0x0ae3,
+ 0x0c4c,
+ 0x1cf37,
+ 0x1cf3d,
+ 0x112e3,
+ 0x1bf1,
+ 0x112e2,
+ 0x1d170,
+ 0xa9b3,
+ 0x0362,
+ 0x0f84,
+ 0xe013f,
+ 0x0483,
+ 0x05b2,
+ 0xe0160,
+ 0x11cae,
+ 0x10f4f,
+ 0x16f61,
+ 0xaaef,
+ 0xe01d8,
+ 0x11a06,
+ 0x0339,
+ 0x11636,
+ 0x114b2,
+ 0x11c2f,
+ 0x0b3e,
+ 0x1163a,
+ 0x10f49,
+ 0xa8ea,
+ 0x0c41,
+ 0x0655,
+ 0x11234,
+ 0x032c,
+ 0xe01af,
+ 0x1d17f,
+ 0x0d3b,
+ 0x1da23,
+ 0xfb1e,
+ 0x0ac2,
+ 0x1bad,
+ 0x1163c,
+ 0x0f95,
+ 0xa8bf,
+ 0x1cf28,
+ 0xe0139,
+ 0x10f85,
+ 0x1abb,
+ 0x1da29,
+ 0x1cf4,
+ 0x06e8,
+ 0x1e8d1,
+ 0x0b3c,
+ 0xe011c,
+ 0x1e013,
+ 0x1ace,
+ 0x05ab,
+ 0x10ae6,
+ 0x20e1,
+ 0x1cf3f,
+ 0x1dfb,
+ 0x08cd,
+ 0x11c36,
+ 0x073b,
+ 0x082a,
+ 0x17b6,
+ 0x0e48,
+ 0x20ee,
+ 0x11937,
+ 0x1cdf,
+ 0xe0162,
+ 0x1cf3a,
+ 0x08d9,
+ 0x11637,
+ 0x2dfb,
+ 0xe018c,
+ 0x1df9,
+ 0x11073,
+ 0x135f,
+ 0x08d7,
+ 0x1773,
+ 0x08e0,
+ 0x16af3,
+ 0x0610,
+ 0xe019c,
+ 0x0901,
+ 0x1e018,
+ 0x1e027,
+ 0x1da2c,
+ 0x0b43,
+ 0x180c,
+ 0x1753,
+ 0x114b1,
+ 0x115b2,
+ 0xabe7,
+ 0x031d,
+ 0x0c01,
+ 0x111b4,
+ 0xe01e2,
+ 0x08f5,
+ 0x11cb5,
+ 0x0cbc,
+ 0x1a1a,
+ 0x1da14,
+ 0x1dc7,
+ 0x1a18,
+ 0x0d62,
+ 0x0742,
+ 0x1da58,
+ 0x111b9,
+ 0x11a35,
+ 0x115b9,
+ 0x0369,
+ 0x05a6,
+ 0xa8f0,
+ 0xe0169,
+ 0x116ab,
+ 0x0ecb,
+ 0x0599,
+ 0x1da59,
+ 0x2dec,
+ 0x11c99,
+ 0x0358,
+ 0x11128,
+ 0xa8b5,
+ 0x1cf17,
+ 0x16af2,
+ 0x1133c,
+ 0x0711,
+ 0x11369,
+ 0x1a70,
+ 0x1062,
+ 0xa94e,
+ 0x1da11,
+ 0x059c,
+ 0x0fb9,
+ 0x11d42,
+ 0xa92a,
+ 0x11d91,
+ 0x1aba,
+ 0x1a6b,
+ 0x1122c,
+ 0xe0136,
+ 0x1086,
+ 0x1067,
+ 0xe01a2,
+ 0x0afd,
+ 0x1da15,
+ 0x16f83,
+ 0x1da2a,
+ 0x1cf29,
+ 0x1da28,
+ 0x1b70,
+ 0x17b4,
+ 0x0ebb,
+ 0x0947,
+ 0x11371,
+ 0x1a1b,
+ 0x0361,
+ 0x11d34,
+ 0x1cd4,
+ 0x1cf3e,
+ 0x11935,
+ 0x11130,
+ 0x1a5b,
+ 0x11134,
+ 0xe0149,
+ 0x11446,
+ 0x0363,
+ 0xe0180,
+ 0xfe0c,
+ 0x11c35,
+ 0x0eb6,
+ 0x0fa4,
+ 0x0fa0,
+ 0x08ff,
+ 0x114ba,
+ 0x11439,
+ 0xe0170,
+ 0x0d40,
+ 0xe015f,
+ 0x06dc,
+ 0x111c9,
+ 0x0c48,
+ 0x1734,
+ 0x1da43,
+ 0xaa2c,
+ 0x0ecd,
+ 0xe01b1,
+ 0x1e023,
+ 0x16f60,
+ 0x089d,
+ 0x0e4d,
+ 0x07ee,
+ 0x0312,
+ 0xa8c4,
+ 0x034c,
+ 0x1103c,
+ 0x0829,
+ 0x1cf42,
+ 0x1daa2,
+ 0x11729,
+ 0x0957,
+ 0x119d1,
+ 0x1dc6,
+ 0x1cf08,
+ 0x1abf,
+ 0x059e,
+ 0x0d81,
+ 0xe01d3,
+ 0x1da09,
+ 0x1d17d,
+ 0x112e5,
+ 0x11d90,
+ 0x1e01e,
+ 0x1e135,
+ 0x030f,
+ 0x110b2,
+ 0x111ce,
+ 0x17c6,
+ 0xa8e3,
+ 0x16f66,
+ 0x0a3e,
+ 0x1e132,
+ 0xe0155,
+ 0x1e4ee,
+ 0x07ab,
+ 0x20ed,
+ 0x0963,
+ 0xe01d0,
+ 0xe01bf,
+ 0x08d3,
+ 0x1cde,
+ 0x1ba4,
+ 0x0ce3,
+ 0x11437,
+ 0x0b02,
+ 0x0c40,
+ 0x08f4,
+ 0x11f38,
+ 0x1088,
+ 0xa950,
+ 0x1bee,
+ 0xa881,
+ 0xe01a0,
+ 0x0900,
+ 0x1e8d6,
+ 0x1171e,
+ 0xe01b5,
+ 0x05ac,
+ 0xe0125,
+ 0x20ef,
+ 0x05b6,
+ 0xe01a7,
+ 0x11d8d,
+ 0xe017c,
+ 0x0ccb,
+ 0x1b3f,
+ 0x20eb,
+ 0x0a3c,
+ 0xe0157,
+ 0x1a57,
+ 0x1d1ac,
+ 0xa8ef,
+ 0x0598,
+ 0x112e0,
+ 0xe012b,
+ 0x0f80,
+ 0x1ddc,
+ 0x034b,
+ 0x1a68,
+ 0xa6f0,
+ 0x059b,
+ 0x1b81,
+ 0x16b32,
+ 0x0faa,
+ 0x109c,
+ 0x034d,
+ 0xe010c,
+ 0x0319,
+ 0x1925,
+ 0x11a3b,
+ 0x031b,
+ 0x1a64,
+ 0x08d4,
+ 0xa677,
+ 0x0b62,
+ 0x11045,
+ 0x0acb,
+ 0x1112f,
+ 0xe01d4,
+ 0x1da0a,
+ 0x115af,
+ 0x0613,
+ 0xaaf5,
+ 0x08f1,
+ 0x11a56,
+ 0x0bbf,
+ 0xaa4c,
+ 0x1037a,
+ 0x1dff,
+ 0x0abe,
+ 0x302e,
+ 0x1b39,
+ 0x1da9d,
+ 0x1a6a,
+ 0x11ef6,
+ 0xe01aa,
+ 0x112ea,
+ 0x1e01c,
+ 0x1039,
+ 0x05b8,
+ 0x11c34,
+ 0x20db,
+ 0x11230,
+ 0x0c83,
+ 0x1036,
+ 0x0948,
+ 0x119db,
+ 0xe01ed,
+ 0x1c31,
+ 0x10a3f,
+ 0x1ab5,
+ 0x11d94,
+ 0xa983,
+ 0x0ccd,
+ 0x17c4,
+ 0x11931,
+ 0x11f42,
+ 0x1c28,
+ 0x1da32,
+ 0x11145,
+ 0x302a,
+ 0xe0135,
+ 0x0ac8,
+ 0x0cc7,
+ 0xe01ad,
+ 0x1da00,
+ 0x1b37,
+ 0x036f,
+ 0x11d43,
+ 0x116ad,
+ 0x11ef5,
+ 0xa8ff,
+ 0x1da19,
+ 0x030a,
+ 0x09cc,
+ 0x10eac,
+ 0x11d8c,
+ 0x11a0a,
+ 0xaab4,
+ 0xfe2f,
+ 0x0ac0,
+ 0xe0194,
+ 0x065f,
+ 0x11a07,
+ 0xe015a,
+ 0xe0173,
+ 0x1c27,
+ 0x17c8,
+ 0x0820,
+ 0x065d,
+ 0x0bcb,
+ 0xe01dd,
+ 0x11343,
+ 0x1e009,
+ 0x0941,
+ 0x1752,
+ 0x1ce4,
+ 0x0329,
+ 0x1713,
+ 0xe0118,
+ 0x119da,
+ 0x1da6a,
+ 0x08f2,
+ 0x0f71,
+ 0x16f51,
+ 0x089e,
+ 0x2df8,
+ 0x10a0e,
+ 0x2de4,
+ 0xaa2a,
+ 0xe0192,
+ 0x0dd2,
+ 0x0c81,
+ 0xe01c7,
+ 0x10a38,
+ 0xe0176,
+ 0x20e9,
+ 0xe019d,
+ 0x20e7,
+ 0x032e,
+ 0x1e01d,
+ 0x1cf24,
+ 0x0731,
+ 0x0ac4,
+ 0xe017d,
+ 0x16f7b,
+ 0x1c34,
+ 0x115b5,
+ 0x0306,
+ 0x16f76,
+ 0x0bc8,
+ 0x061a,
+ 0xa949,
+ 0x08f0,
+ 0x11cb2,
+ 0x1133f,
+ 0x111b5,
+ 0x11344,
+ 0x082d,
+ 0x1dd3,
+ 0x1d172,
+ 0xe010b,
+ 0x2df6,
+ 0x06e0,
+ 0x1107f,
+ 0x16f74,
+ 0x11d47,
+ 0x11943,
+ 0x16b30,
+ 0x11a01,
+ 0x0d4b,
+ 0xaa7b,
+ 0x1da22,
+ 0xe01ec,
+ 0x13447,
+ 0x1cf0b,
+ 0x11c9a,
+ 0x2dfa,
+ 0xe01c2,
+ 0x11724,
+ 0x0485,
+ 0x11a52,
+ 0xe01cd,
+ 0x1da03,
+ 0xa8bb,
+ 0x11722,
+ 0x11930,
+ 0x06ed,
+ 0x0615,
+ 0x1daa8,
+ 0xe0132,
+ 0x1cf33,
+ 0x11042,
+ 0x1cd8,
+ 0x1a17,
+ 0xe0171,
+ 0x089f,
+ 0x119dd,
+ 0x1da5e,
+ 0x1d1aa,
+ 0x1da24,
+ 0x0b01,
+ 0x1a5e,
+ 0x11d3d,
+ 0xe0165,
+ 0x0367,
+ 0x110b6,
+ 0x11074,
+ 0x1cf38,
+ 0x11237,
+ 0x1df3,
+ 0x1de5,
+ 0xe0140,
+ 0xa672,
+ 0x074a,
+ 0x10376,
+ 0x180d,
+ 0xe01c9,
+ 0x0c63,
+ 0x064c,
+ 0x1ba8,
+ 0x0f7c,
+ 0x16f55,
+ 0xe010d,
+ 0x0484,
+ 0x11caf,
+ 0xe0106,
+ 0x0318,
+ 0x119e4,
+ 0x032b,
+ 0xe016e,
+ 0x11438,
+ 0x116af,
+ 0x17cf,
+ 0x1344d,
+ 0x1e4ef,
+ 0x11f03,
+ 0x1da47,
+ 0x106d,
+ 0x1ddf,
+ 0x0d47,
+ 0x0c4a,
+ 0x0a4c,
+ 0x1cda,
+ 0x0591,
+ 0x0b56,
+ 0x1d187,
+ 0x0a47,
+ 0x10a0c,
+ 0x0a81,
+ 0xa8b6,
+ 0x11d95,
+ 0x0cc0,
+ 0x0a83,
+ 0x1927,
+ 0x06d8,
+ 0xe011b,
+ 0x06d6,
+ 0x2dea,
+ 0x1a61,
+ 0xe0117,
+ 0x20e4,
+ 0xa9b8,
+ 0x10f84,
+ 0x08dd,
+ 0xe01bb,
+ 0x1dd2,
+ 0x1da05,
+ 0x0f87,
+ 0x1bea,
+ 0x17d1,
+ 0x11728,
+ 0x1dc3,
+ 0x114b0,
+ 0xa8b9,
+ 0x073c,
+ 0x0a48,
+ 0x094e,
+ 0xa94b,
+ 0x0fb6,
+ 0x17c1,
+ 0x05a7,
+ 0x1df2,
+ 0x0bd7,
+ 0x0d83,
+ 0x1cf3b,
+ 0x16fe4,
+ 0x10efd,
+ 0x0365,
+ 0x089a,
+ 0x0fa6,
+ 0x1da3c,
+ 0x11c9d,
+ 0xe0114,
+ 0x1ab7,
+ 0x081f,
+ 0xa8e8,
+ 0x1193b,
+ 0x0eb1,
+ 0x032d,
+ 0x1cf2c,
+ 0xa8e4,
+ 0xe01d7,
+ 0x059d,
+ 0xabed,
+ 0x16f78,
+ 0x1b04,
+ 0x08f3,
+ 0x11101,
+ 0x115be,
+ 0x11d31,
+ 0x1c33,
+ 0x1cf07,
+ 0x0307,
+ 0x0651,
+ 0x1ce5,
+ 0x1dd9,
+ 0x115b8,
+ 0xe01ac,
+ 0x033e,
+ 0x1920,
+ 0x08e9,
+ 0x2df9,
+ 0x16f58,
+ 0xe01d5,
+ 0x16f6d,
+ 0xe014a,
+ 0x0d4d,
+ 0x11ca0,
+ 0x1cf0a,
+ 0x1ce8,
+ 0x1060,
+ 0x11c96,
+ 0x035e,
+ 0xe0186,
+ 0x115bb,
+ 0x119d7,
+ 0x16af4,
+ 0x1daa9,
+ 0x0982,
+ 0x11cb3,
+ 0x1cf2a,
+ 0x11ca4,
+ 0x033b,
+ 0x135d,
+ 0x11435,
+ 0x114b8,
+ 0x09bc,
+ 0x1e005,
+ 0x11082,
+ 0x1d1ab,
+ 0x10a03,
+ 0xa8f1,
+ 0x0e4a,
+ 0x11ca2,
+ 0xabec,
+ 0x081c,
+ 0x1ce2,
+ 0x1da0e,
+ 0x06df,
+ 0xfe22,
+ 0x1ce6,
+ 0x1087,
+ 0x0f8f,
+ 0x11a8f,
+ 0x09c2,
+ 0x1da4e,
+ 0x1e006,
+ 0x08d0,
+ 0x1dd8,
+ 0x1714,
+ 0x0a40,
+ 0xe0126,
+ 0x11a53,
+ 0x13451,
+ 0x1059,
+ 0x1da61,
+ 0x1e2ed,
+ 0x1d17c,
+ 0xa678,
+ 0x3099,
+ 0x16f65,
+ 0xe0131,
+ 0x0826,
+ 0x11c3d,
+ 0x0df3,
+ 0x180f,
+ 0x1a56,
+ 0x11d8a,
+ 0x1cd9,
+ 0xa8e0,
+ 0xe0129,
+ 0x1938,
+ 0x11f00,
+ 0x0345,
+ 0x1b02,
+ 0xa9bd,
+ 0x11443,
+ 0xa806,
+ 0xa9b9,
+ 0x1da0c,
+ 0xe01d6,
+ 0x1e00f,
+ 0x1932,
+ 0x13454,
+ 0x1134b,
+ 0x192a,
+ 0x0f79,
+ 0x1a60,
+ 0x0659,
+ 0x11f3a,
+ 0x1e8d5,
+ 0x0d01,
+ 0x0734,
+ 0x11146,
+ 0xe0108,
+ 0xe0153,
+ 0x06eb,
+ 0xe013b,
+ 0x1a73,
+ 0xe0167,
+ 0x11a98,
+ 0x0f72,
+ 0x11831,
+ 0x1dcc,
+ 0x0f81,
+ 0x119d5,
+ 0x16f68,
+ 0x0f90,
+ 0x114bb,
+ 0x2dfd,
+ 0xfe00,
+ 0x08f7,
+ 0x1da56,
+ 0xe0187,
+ 0xa9c0,
+ 0x0f93,
+ 0xa67b,
+ 0x0344,
+ 0x20e2,
+ 0x08fa,
+ 0x082b,
+ 0x05a1,
+ 0x1ba3,
+ 0x1da42,
+ 0x0313,
+ 0x11366,
+ 0x1a6c,
+ 0xe01db,
+ 0xa929,
+ 0xe01e5,
+ 0x1da1b,
+ 0x116b0,
+ 0x0324,
+ 0x17be,
+ 0x17c0,
+ 0x20dd,
+ 0x11836,
+ 0x10f50,
+ 0x073d,
+ 0xe01bd,
+ 0x0dd1,
+ 0x1933,
+ 0x1cf1b,
+ 0x081b,
+ 0xaa43,
+ 0xe01ee,
+ 0x115dc,
+ 0x1de4,
+ 0x0349,
+ 0x11c32,
+ 0xe0184,
+ 0xa953,
+ 0x20ec,
+ 0xe0147,
+ 0x1cf31,
+ 0xaa2d,
+ 0x0b47,
+ 0x08cf,
+ 0xa92c,
+ 0x1e024,
+ 0x1e01b,
+ 0x1acd,
+ 0xe0181,
+ 0xe0124,
+ 0x1a62,
+ 0x09bf,
+ 0x059a,
+ 0x0d4c,
+ 0x11727,
+ 0x109b,
+ 0x115c0,
+ 0x2def,
+ 0xe010e,
+ 0x1ced,
+ 0xaa30,
+ 0x1baa,
+ 0xaabf,
+ 0x1da18,
+ 0x1daaf,
+ 0x1da1a,
+ 0x1d181,
+ 0x1ba6,
+ 0x1cf02,
+ 0x11ca9,
+ 0xe01ba,
+ 0x0903,
+ 0x1cf05,
+ 0x0abf,
+ 0x108c,
+ 0x115bf,
+ 0x0d46,
+ 0xe0111,
+ 0x05a0,
+ 0x11c3a,
+ 0x11725,
+ 0x0c04,
+ 0x08d5,
+ 0x10379,
+ 0x0308,
+ 0x1e020,
+ 0x0f9a,
+ 0x17c3,
+ 0xfe06,
+ 0x1a55,
+ 0x115b0,
+ 0x111b7,
+ 0x20d4,
+ 0x16f87,
+ 0x0a03,
+ 0xe0163,
+ 0x102b,
+ 0x06e2,
+ 0xa9bb,
+ 0x07a9,
+ 0xaa4d,
+ 0x10f4c,
+ 0x11d97,
+ 0x114bc,
+ 0x2cf0,
+ 0x1ab8,
+ 0x1a67,
+ 0x106b,
+ 0x0f75,
+ 0x11348,
+ 0x1cf9,
+ 0x11070,
+ 0x065e,
+ 0xe0199,
+ 0x0f7b,
+ 0xa679,
+ 0x11a05,
+ 0x1ab2,
+ 0x034a,
+ 0xa82c,
+ 0x1e136,
+ 0x10f4b,
+ 0x20d2,
+ 0x1cf46,
+ 0x1da9e,
+ 0x08db,
+ 0x0f39,
+ 0x111bb,
+ 0x1da26,
+ 0x10d26,
+ 0x1e00c,
+ 0x102c,
+ 0x16f86,
+ 0xe012e,
+ 0x1e944,
+ 0x0fb7,
+ 0x1b36,
+ 0x0c47,
+ 0x180b,
+ 0x0654,
+ 0x11cad,
+ 0x08ec,
+ 0x16f6c,
+ 0x1b44,
+ 0x0ece,
+ 0x0ddc,
+ 0xe01e7,
+ 0xe0177,
+ 0x1dd7,
+ 0xe015e,
+ 0x0b55,
+ 0x0aff,
+ 0x0cca,
+ 0x1163b,
+ 0x1b01,
+ 0x112e7,
+ 0x10a01,
+ 0x0f99,
+ 0x11a3e,
+ 0x1da01,
+ 0x1143c,
+ 0x11a97,
+ 0xe019e,
+ 0xe019a,
+ 0x135e,
+ 0xe018b,
+ 0x034f,
+ 0x1193d,
+ 0x0368,
+ 0xaaee,
+ 0xaa2b,
+ 0x10f47,
+ 0x10f4e,
+ 0x0f91,
+ 0xe0112,
+ 0x11640,
+ 0x08ee,
+ 0x11080,
+ 0x11c33,
+ 0x16f7f,
+ 0x1dde,
+ 0x1daab,
+ 0xe017e,
+ 0x0945,
+ 0x0593,
+ 0x1da5a,
+ 0x05bb,
+ 0x0942,
+ 0x1da30,
+ 0xaaf6,
+ 0x1da50,
+ 0x16ff0,
+ 0xa8b7,
+ 0x11940,
+ 0x0360,
+ 0x2df5,
+ 0x073f,
+ 0x1a78,
+ 0x09fe,
+ 0x08e5,
+ 0x17ce,
+ 0x16f52,
+ 0xfe2e,
+ 0x1c2f,
+ 0x1182e,
+ 0xe017f,
+ 0x2df4,
+ 0xe01a3,
+ 0x11631,
+ 0x07f0,
+ 0x11ef3,
+ 0x05bd,
+ 0x1dfe,
+ 0x1133e,
+ 0x11a02,
+ 0xe0110,
+ 0x0afe,
+ 0x2dee,
+ 0x05a5,
+ 0x0594,
+ 0x1da04,
+ 0x08ef,
+ 0xe0145,
+ 0x030e,
+ 0x0347,
+ 0x0c62,
+ 0xfe09,
+ 0x1133b,
+ 0x114bd,
+ 0x111b6,
+ 0x1cf10,
+ 0x1da3e,
+ 0xe01b9,
+ 0x1da48,
+ 0x0b4d,
+ 0x1dc5,
+ 0x0dd4,
+ 0x1e945,
+ 0x0618,
+ 0x0f74,
+ 0x11043,
+ 0x1a7f,
+ 0x08d6,
+ 0x1e08f,
+ 0x11c30,
+ 0x11a8c,
+ 0xe01ca,
+ 0x0332,
+ 0x16af0,
+ 0x0dde,
+ 0x16f7a,
+ 0x10a0f,
+ 0x20d0,
+ 0x11362,
+ 0x1e00d,
+ 0x1112b,
+ 0x05a3,
+ 0x0a70,
+ 0x1da65,
+ 0x11a5b,
+ 0xa9b7,
+ 0x11ca3,
+ 0x0fb8,
+ 0x1033,
+ 0x111cf,
+ 0xe011a,
+ 0x0822,
+ 0x05c2,
+ 0x1733,
+ 0xe0175,
+ 0x1ab9,
+ 0xe014e,
+ 0x1e02a,
+ 0x0f3e,
+ 0x106c,
+ 0x093b,
+ 0x2de5,
+ 0x17cc,
+ 0x20e3,
+ 0x1da9f,
+ 0x11938,
+ 0x0736,
+ 0x1e029,
+ 0x0d03,
+ 0x0bcd,
+ 0x11cab,
+ 0x11039,
+ 0x1e4ec,
+ 0x1cf03,
+ 0x030d,
+ 0x1089,
+ 0x302b,
+ 0x11301,
+ 0x11131,
+ 0xa92b,
+ 0x1d17e,
+ 0x111ca,
+ 0x1e8d0,
+ 0x0650,
+ 0x2df3,
+ 0x08dc,
+ 0x102e,
+ 0xa94c,
+ 0x0c03,
+ 0xaab2,
+ 0x0eb5,
+ 0xa8e2,
+ 0x0f77,
+ 0xe0138,
+ 0x1bed,
+ 0xe01cf,
+ 0x112e9,
+ 0xe0144,
+ 0x11d33,
+ 0x1ac0,
+ 0xe01b6,
+ 0x17c2,
+ 0x0ac5,
+ 0x11d44,
+ 0x0739,
+ 0x11839,
+ 0x1885,
+ 0x11100,
+ 0x064b,
+ 0x1ba5,
+ 0x110b3,
+ 0x0e47,
+ 0x08d2,
+ 0x07ef,
+ 0x0335,
+ 0x0f86,
+ 0x1a5d,
+ 0x030c,
+ 0xa67d,
+ 0x1d165,
+ 0x11cb0,
+ 0x033d,
+ 0x1beb,
+ 0x16f8f,
+ 0x11a5a,
+ 0x10ae5,
+ 0x1da13,
+ 0x103d,
+ 0x1cf12,
+ 0x0e36,
+ 0x11630,
+ 0x0944,
+ 0xaab7,
+ 0x10a3a,
+ 0x1da31,
+ 0x1cf30,
+ 0x07f2,
+ 0x1cf09,
+ 0xe014c,
+ 0x1cf15,
+ 0x0d42,
+ 0x0946,
+ 0x1da40,
+ 0x0cc6,
+ 0x09c1,
+ 0x06e7,
+ 0x0fa9,
+ 0x1ba7,
+ 0x0cf3,
+ 0x0341,
+ 0x05ba,
+ 0x1acc,
+ 0x0bc6,
+ 0x1ddb,
+ 0x0327,
+ 0x1da2d,
+ 0xe0178,
+ 0x2dff,
+ 0x16b34,
+ 0x0bca,
+ 0x1939,
+ 0x1be6,
+ 0x0fad,
+ 0x119d3,
+ 0xa9b4,
+ 0x11d3a,
+ 0x0488,
+ 0x20e0,
+ 0x1cf36,
+ 0x0337,
+ 0x1abe,
+ 0x1031,
+ 0x1dd4,
+ 0x09d7,
+ 0x1163f,
+ 0x1cf21,
+ 0x1dc4,
+ 0xfe04,
+ 0xe0189,
+ 0x036a,
+ 0x1ddd,
+ 0x114b6,
+ 0x11180,
+ 0xe016a,
+ 0x16f6a,
+ 0x16ff1,
+ 0xe0127,
+ 0x11231,
+ 0x11241,
+ 0x0656,
+ 0xe0161,
+ 0x0346,
+ 0x1143a,
+ 0x1cd6,
+ 0x0949,
+ 0x1c26,
+ 0x110b1,
+ 0x11436,
+ 0x11a03,
+ 0x11367,
+ 0x1e2ae,
+ 0xfe0a,
+ 0x1e00e,
+ 0x0325,
+ 0x1da9c,
+ 0x1a65,
+ 0x0983,
+ 0x11a08,
+ 0x17b9,
+ 0x0c4b,
+ 0xe0174,
+ 0x1d244,
+ 0x1344f,
+ 0x2de7,
+ 0x1b38,
+ 0xe013a,
+ 0x20dc,
+ 0xe011f,
+ 0x1cf19,
+ 0x08d1,
+ 0x1e010,
+ 0x0955,
+ 0x16f69,
+ 0x10eab,
+ 0x17c7,
+ 0x11340,
+ 0x081d,
+ 0x0328,
+ 0x1e028,
+ 0x17bc,
+ 0xaab3,
+ 0xe01b7,
+ 0x0e4e,
+ 0x1abc,
+ 0x1da66,
+ 0x1732,
+ 0xe01ae,
+ 0x1cf43,
+ 0x1d243,
+ 0x1712,
+ 0x0c42,
+ 0x0b3f,
+ 0x302d,
+ 0xe01e6,
+ 0x1da1c,
+ 0x2ded,
+ 0x1b41,
+ 0x11cb4,
+ 0xe0148,
+ 0xe0123,
+ 0x11d93,
+ 0x1072,
+ 0x1936,
+ 0x1063,
+ 0x0c56,
+ 0x11a39,
+ 0x1e2ef,
+ 0xe01ab,
+ 0x17d0,
+ 0x1d242,
+ 0x0359,
+ 0x1123e,
+ 0x11639,
+ 0x1b73,
+ 0xe0152,
+ 0x11a8d,
+ 0x16af1,
+ 0x035b,
+ 0x0bc2,
+ 0x1da12,
+ 0xe01da,
+ 0x11c93,
+ 0x094a,
+ 0x073e,
+ 0x11372,
+ 0x0d48,
+ 0x1de9,
+ 0x114c1,
+ 0x07ae,
+ 0x11a54,
+ 0x10a39,
+ 0x11638,
+ 0x2deb,
+ 0x073a,
+ 0x1cf0f,
+ 0x0fab,
+ 0x1aca,
+ 0xa8c3,
+ 0xa981,
+ 0x1ac4,
+ 0x1e133,
+ 0xabe5,
+ 0x1da52,
+ 0x0e37,
+ 0xe0105,
+ 0x11357,
+ 0x0336,
+ 0x0c3e,
+ 0xe010f,
+ 0xe0188,
+ 0x111cb,
+ 0x11444,
+ 0x0940,
+ 0x11cac,
+ 0xa8ed,
+ 0x114b7,
+ 0x11832,
+ 0x0743,
+ 0x08d8,
+ 0x1e026,
+ 0x1da53,
+ 0x11c3f,
+ 0x1da06,
+ 0xe019b,
+ 0x119d2,
+ 0xaa34,
+ 0x1b00,
+ 0x0730,
+ 0x13440,
+ 0x0cc4,
+ 0xe0146,
+ 0x1c25,
+ 0x030b,
+ 0x11a95,
+ 0x0323,
+ 0x1e00b,
+ 0x0943,
+ 0x0f8d,
+ 0x0dca,
+ 0x10d25,
+ 0x2de9,
+ 0x1bab,
+ 0x115b1,
+ 0x1da2b,
+ 0x0ebc,
+ 0x1e131,
+ 0xe018a,
+ 0x1923,
+ 0x05c1,
+ 0x20df,
+ 0x1103d,
+ 0xa927,
+ 0x1c2e,
+ 0x07ec,
+ 0x16f82,
+ 0xe01e4,
+ 0x1da25,
+ 0x0f7a,
+ 0x1cf20,
+ 0x1171d,
+ 0x11347,
+ 0x112e6,
+ 0x1d188,
+ 0x11d41,
+ 0x1068,
+ 0x089c,
+ 0x11f36,
+ 0x11341,
+ 0xaa2f,
+ 0x0356,
+ 0xe0137,
+ 0x1344c,
+ 0x0fb0,
+ 0xe016b,
+ 0x1df4,
+ 0x1112d,
+ 0x1de2,
+ 0x1103b,
+ 0x08f9,
+ 0xe01c0,
+ 0x11f40,
+ 0x119df,
+ 0x1083,
+ 0xaa33,
+ 0x13448,
+ 0x0fb4,
+ 0x0ac3,
+ 0xabe4,
+ 0x11a3c,
+ 0x1134d,
+ 0x114b9,
+ 0x103a,
+ 0x1da20,
+ 0x08da,
+ 0x16f56,
+ 0x309a,
+ 0x11127,
+ 0x11a93,
+ 0x192b,
+ 0x0f97,
+ 0x1cd5,
+ 0x1da5f,
+ 0x1084,
+ 0x0eb4,
+ 0x11370,
+ 0x10efe,
+ 0x1069,
+ 0x111c0,
+ 0x11834,
+ 0x119d4,
+ 0x1193c,
+ 0x1cf1c,
+ 0x1928,
+ 0x17bf,
+ 0x1da6c,
+ 0xe0156,
+ 0x1bf2,
+ 0x0304,
+ 0x11ca1,
+ 0x11233,
+ 0x0859,
+ 0x0a42,
+ 0x1c2d,
+ 0x0738,
+ 0x0592,
+ 0x1b6f,
+ 0x0355,
+ 0x0ddd,
+ 0x1a71,
+ 0x0bc1,
+ 0x112df,
+ 0x1344e,
+ 0x1daac,
+ 0x1e014,
+ 0x0d44,
+ 0x1df8,
+ 0x16f4f,
+ 0xe01e0,
+ 0x1da16,
+ 0x11721,
+ 0x0d02,
+ 0x20e5,
+ 0x115b4,
+ 0x1b42,
+ 0x1b43,
+ 0x0b40,
+ 0xe016c,
+ 0x08ed,
+ 0x109a,
+ 0x11303,
+ 0x1cf35,
+ 0x1344a,
+ 0x17c5,
+ 0x11c39,
+ 0xa66f,
+ 0x093f,
+ 0x20d7,
+ 0x05ae,
+ 0x1cf14,
+ 0x1e016,
+ 0x08eb,
+ 0x16f53,
+ 0x0745,
+ 0x0353,
+ 0x0c3c,
+ 0x0315,
+ 0x16f54,
+ 0x0eb9,
+ 0x114be,
+ 0x08cb,
+ 0x16f81,
+ 0x06db,
+ 0x07a7,
+ 0x0a4b,
+ 0x20e6,
+ 0x1df5,
+ 0xe01a4,
+ 0xfe23,
+ 0x1172b,
+ 0x0dd9,
+ 0x1929,
+ 0x302f,
+ 0x064d,
+ 0x0a01,
+ 0x09c8,
+ 0x20d1,
+ 0xe018f,
+ 0xa8e5,
+ 0xa8c2,
+ 0x16b31,
+ 0xa6f1,
+ 0x0f92,
+ 0x07fd,
+ 0x094d,
+ 0x0e4b,
+ 0x1193e,
+ 0xe0115,
+ 0x093e,
+ 0x0821,
+ 0x1cd0,
+ 0x1c2a,
+ 0x0735,
+ 0xa823,
+ 0x05a4,
+ 0xe0121,
+ 0xe015c,
+ 0x1a79,
+ 0x0f83,
+ 0x112e1,
+ 0xa947,
+ 0x16f5e,
+ 0x10a06,
+ 0x17d3,
+ 0x1d185,
+ 0x0d57,
+ 0x16f62,
+ 0x0f96,
+ 0x115b3,
+ 0x11f35,
+ 0xe0119,
+ 0x16f7d,
+ 0xfe02,
+ 0x0c46,
+ 0x1cf44,
+ 0x2de0,
+ 0xaa2e,
+ 0x111ba,
+ 0x110b4,
+ 0x1e8d2,
+ 0x11c92,
+ 0x1d169,
+ 0x035f,
+ 0x0740,
+ 0x1cdc,
+ 0x1122d,
+ 0x2de8,
+ 0x0748,
+ 0x0ec9,
+ 0x1a63,
+ 0x1da5c,
+ 0x1b35,
+ 0x0cc2,
+ 0x1112c,
+ 0xe0113,
+ 0x06da,
+ 0x1922,
+ 0x2de3,
+ 0x18a9,
+ 0x1ba9,
+ 0x08cc,
+ 0x11a57,
+ 0x102f,
+ 0x0737,
+ 0x0652,
+ 0x10a0d,
+ 0x05b4,
+ 0x11000,
+ 0x0fa7,
+ 0x06e3,
+ 0x1bf3,
+ 0xe01a6,
+ 0x0352,
+ 0x0305,
+ 0x0f82,
+ 0xe0172,
+ 0x11235,
+ 0x0d43,
+ 0x106a,
+ 0x20e8,
+ 0x11c94,
+ 0x1b6e,
+ 0x05b1,
+ 0x0614,
+ 0x08fb,
+ 0x11132,
+ 0x103b,
+ 0x110b9,
+ 0x112e8,
+ 0x1b6b,
+ 0x1da6b,
+ 0x1c2c,
+ 0x1b3a,
+ 0xe01bc,
+ 0x1da64,
+ 0x1085,
+ 0x1da45,
+ 0x11d36,
+ 0x20f0,
+ 0x1da0f,
+ 0x0899,
+ 0xe01d9,
+ 0x031e,
+ 0x0fa5,
+ 0x1182c,
+ 0xe01a1,
+ 0xe01c6,
+ 0x0350,
+ 0x13452,
+ 0x1ce3,
+ 0x2de1,
+ 0x2dfc,
+ 0x1da4a,
+ 0x1cf04,
+ 0x16f63,
+ 0x1d189,
+ 0xe0101,
+ 0xe014d,
+ 0x11a92,
+ 0x0817,
+ 0x11c31,
+ 0x11040,
+ 0xe01df,
+ 0x1e021,
+ 0x11302,
+ 0xe01e1,
+ 0xe0166,
+ 0x11a34,
+ 0x111cc,
+ 0xaaec,
+ 0x0962,
+ 0xfe07,
+ 0x1cf16,
+ 0x1bef,
+ 0x08ea,
+ 0x1e011,
+ 0x0f7e,
+ 0x1daa7,
+ 0x1937,
+ 0xe016d,
+ 0x1dee,
+ 0xfe28,
+ 0x085b,
+ 0xa94a,
+ 0x1dd5,
+ 0x1dea,
+ 0x1a6f,
+ 0xfe03,
+ 0x1a75,
+ 0x06ea,
+ 0x16f7e,
+ 0x0f37,
+ 0x1182f,
+ 0x059f,
+ 0x1da69,
+ 0x0fac,
+ 0x0c3f,
+ 0x0d41,
+ 0x16f84,
+ 0x0fae,
+ 0xe0168,
+ 0x0c44,
+ 0x034e,
+ 0x08fc,
+ 0x05bf,
+ 0x0dd0,
+ 0x1bf0,
+ 0x2cef,
+ 0x1ab3,
+ 0x0d3f,
+ 0x1cf2b,
+ 0xa8c0,
+ 0x1a5c,
+ 0x16f67,
+ 0x1daaa,
+ 0xe016f,
+ 0x1da84,
+ 0x2df2,
+ 0x05a9,
+ 0xe013d,
+ 0x0c43,
+ 0x1da36,
+ 0xe0103,
+ 0x08fd,
+ 0x0fba,
+ 0x0ec8,
+ 0x1da1f,
+ 0xa9b5,
+ 0x1be8,
+ 0xfe2b,
+ 0x108d,
+ 0x06d9,
+ 0x1cdd,
+ 0x0816,
+ 0xa676,
+ 0x0818,
+ 0x16f5f,
+ 0x0fa8,
+ 0x0f9b,
+ 0x0f9d,
+ 0x0e31,
+ 0x11a91,
+ 0x0611,
+ 0x0b4b,
+ 0x0b57,
+ 0xe015d,
+ 0x108f,
+ 0x1e001,
+ 0x17ca,
+ 0x08e1,
+ 0x1bc9d,
+ 0x2df1,
+ 0x0b42,
+ 0x081e,
+ 0x16f59,
+ 0xfe20,
+ 0x0597,
+ 0x1cf01,
+ 0x1038,
+ 0x035a,
+ 0xe0196,
+ 0x1a6e,
+ 0x1daa5,
+ 0x0321,
+ 0x1da51,
+ 0x17d2,
+ 0x1daad,
+ 0x033a,
+ 0x1056,
+ 0x1ab1,
+ 0x0dcf,
+ 0x1e947,
+ 0x0300,
+ 0x10d24,
+ 0x10a02,
+ 0x11342,
+ 0x1ce7,
+ 0x031f,
+ 0x1073,
+ 0x0653,
+ 0x0fb2,
+ 0x11a33,
+ 0xe01cc,
+ 0x1da02,
+ 0xe0133,
+ 0x2de2,
+ 0x0333,
+ 0x0a71,
+ 0xe01eb,
+ 0x11d96,
+ 0x0612,
+ 0xa8b8,
+ 0x08e8,
+ 0x11ca6,
+ 0x1de8,
+ 0x1da4f,
+ 0x07a8,
+ 0x0e39,
+ 0xa982,
+ 0x036e,
+ 0x193a,
+ 0x16f91,
+ 0x10d27,
+ 0x0f78,
+ 0x035d,
+ 0x1da2f,
+ 0x11a36,
+ 0xaab0,
+ 0xfe0e,
+ 0x05ad,
+ 0x1dd6,
+ 0xe0142,
+ 0x1dfd,
+ 0x1122f,
+ 0x08e4,
+ 0xaa7c,
+ 0x1b3b,
+ 0x0b48,
+ 0x05bc,
+ 0xa8ee,
+ 0x11c97,
+ 0x110b8,
+ 0xe01b2,
+ 0xe0122,
+ 0x11a8e,
+ 0x11a58,
+ 0x036b,
+ 0x0331,
+ 0x16f71,
+ 0x1143e,
+ 0x110ba,
+ 0x1112e,
+ 0x089b,
+ 0x1ac1,
+ 0xe0143,
+ 0x07ed,
+ 0xa674,
+ 0x2df0,
+ 0x1da62,
+ 0xa8bd,
+ 0x1b3d,
+ 0x11d3c,
+ 0xe014b,
+ 0xaa32,
+ 0x11a51,
+ 0x16f92,
+ 0x1d166,
+ 0x0cc8,
+ 0x1dca,
+ 0xe01b8,
+ 0x1ac8,
+ 0x17c9,
+ 0xfe08,
+ 0x0338,
+ 0x1de7,
+ 0xe018d,
+ 0xa69e,
+ 0x1da4c,
+ 0x07f3,
+ 0x16b35,
+ 0x0a51,
+ 0xa825,
+ 0x1071,
+ 0x11f3f,
+ 0x0348,
+ 0x116b7,
+ 0x09c3,
+ 0x1e2ee,
+ 0x0e34,
+ 0x036d,
+ 0xabe9,
+ 0x1cf7,
+ 0x1935,
+ 0x05aa,
+ 0x1103f,
+ 0x11a09,
+ 0x1da3f,
+ 0x108a,
+ 0x16f5c,
+ 0x20d6,
+ 0x07eb,
+ 0xfe2a,
+ 0xe0193,
+ 0x11d40,
+ 0x05b9,
+ 0x0f7d,
+ 0x16f5a,
+ 0xe0197,
+ 0x09cd,
+ 0x0fb5,
+ 0x1da07,
+ 0xe01d1,
+ 0xa880,
+ 0x1a7c,
+ 0x11ca5,
+ 0x09cb,
+ 0x0fb3,
+ 0x0825,
+ 0x1103a,
+ 0x0827,
+ 0x1e94a,
+ 0x08f8,
+];
+
+
+#[inline]
+pub fn is_public_assigned(c: char) -> bool {
+ match c {
+ '\u{0000}'..='\u{0377}'
+ | '\u{037A}'..='\u{037F}'
+ | '\u{0384}'..='\u{038A}'
+ | '\u{038C}'
+ | '\u{038E}'..='\u{03A1}'
+ | '\u{03A3}'..='\u{052F}'
+ | '\u{0531}'..='\u{0556}'
+ | '\u{0559}'..='\u{058A}'
+ | '\u{058D}'..='\u{058F}'
+ | '\u{0591}'..='\u{05C7}'
+ | '\u{05D0}'..='\u{05EA}'
+ | '\u{05EF}'..='\u{05F4}'
+ | '\u{0600}'..='\u{070D}'
+ | '\u{070F}'..='\u{074A}'
+ | '\u{074D}'..='\u{07B1}'
+ | '\u{07C0}'..='\u{07FA}'
+ | '\u{07FD}'..='\u{082D}'
+ | '\u{0830}'..='\u{083E}'
+ | '\u{0840}'..='\u{085B}'
+ | '\u{085E}'
+ | '\u{0860}'..='\u{086A}'
+ | '\u{0870}'..='\u{088E}'
+ | '\u{0890}'..='\u{0891}'
+ | '\u{0898}'..='\u{0983}'
+ | '\u{0985}'..='\u{098C}'
+ | '\u{098F}'..='\u{0990}'
+ | '\u{0993}'..='\u{09A8}'
+ | '\u{09AA}'..='\u{09B0}'
+ | '\u{09B2}'
+ | '\u{09B6}'..='\u{09B9}'
+ | '\u{09BC}'..='\u{09C4}'
+ | '\u{09C7}'..='\u{09C8}'
+ | '\u{09CB}'..='\u{09CE}'
+ | '\u{09D7}'
+ | '\u{09DC}'..='\u{09DD}'
+ | '\u{09DF}'..='\u{09E3}'
+ | '\u{09E6}'..='\u{09FE}'
+ | '\u{0A01}'..='\u{0A03}'
+ | '\u{0A05}'..='\u{0A0A}'
+ | '\u{0A0F}'..='\u{0A10}'
+ | '\u{0A13}'..='\u{0A28}'
+ | '\u{0A2A}'..='\u{0A30}'
+ | '\u{0A32}'..='\u{0A33}'
+ | '\u{0A35}'..='\u{0A36}'
+ | '\u{0A38}'..='\u{0A39}'
+ | '\u{0A3C}'
+ | '\u{0A3E}'..='\u{0A42}'
+ | '\u{0A47}'..='\u{0A48}'
+ | '\u{0A4B}'..='\u{0A4D}'
+ | '\u{0A51}'
+ | '\u{0A59}'..='\u{0A5C}'
+ | '\u{0A5E}'
+ | '\u{0A66}'..='\u{0A76}'
+ | '\u{0A81}'..='\u{0A83}'
+ | '\u{0A85}'..='\u{0A8D}'
+ | '\u{0A8F}'..='\u{0A91}'
+ | '\u{0A93}'..='\u{0AA8}'
+ | '\u{0AAA}'..='\u{0AB0}'
+ | '\u{0AB2}'..='\u{0AB3}'
+ | '\u{0AB5}'..='\u{0AB9}'
+ | '\u{0ABC}'..='\u{0AC5}'
+ | '\u{0AC7}'..='\u{0AC9}'
+ | '\u{0ACB}'..='\u{0ACD}'
+ | '\u{0AD0}'
+ | '\u{0AE0}'..='\u{0AE3}'
+ | '\u{0AE6}'..='\u{0AF1}'
+ | '\u{0AF9}'..='\u{0AFF}'
+ | '\u{0B01}'..='\u{0B03}'
+ | '\u{0B05}'..='\u{0B0C}'
+ | '\u{0B0F}'..='\u{0B10}'
+ | '\u{0B13}'..='\u{0B28}'
+ | '\u{0B2A}'..='\u{0B30}'
+ | '\u{0B32}'..='\u{0B33}'
+ | '\u{0B35}'..='\u{0B39}'
+ | '\u{0B3C}'..='\u{0B44}'
+ | '\u{0B47}'..='\u{0B48}'
+ | '\u{0B4B}'..='\u{0B4D}'
+ | '\u{0B55}'..='\u{0B57}'
+ | '\u{0B5C}'..='\u{0B5D}'
+ | '\u{0B5F}'..='\u{0B63}'
+ | '\u{0B66}'..='\u{0B77}'
+ | '\u{0B82}'..='\u{0B83}'
+ | '\u{0B85}'..='\u{0B8A}'
+ | '\u{0B8E}'..='\u{0B90}'
+ | '\u{0B92}'..='\u{0B95}'
+ | '\u{0B99}'..='\u{0B9A}'
+ | '\u{0B9C}'
+ | '\u{0B9E}'..='\u{0B9F}'
+ | '\u{0BA3}'..='\u{0BA4}'
+ | '\u{0BA8}'..='\u{0BAA}'
+ | '\u{0BAE}'..='\u{0BB9}'
+ | '\u{0BBE}'..='\u{0BC2}'
+ | '\u{0BC6}'..='\u{0BC8}'
+ | '\u{0BCA}'..='\u{0BCD}'
+ | '\u{0BD0}'
+ | '\u{0BD7}'
+ | '\u{0BE6}'..='\u{0BFA}'
+ | '\u{0C00}'..='\u{0C0C}'
+ | '\u{0C0E}'..='\u{0C10}'
+ | '\u{0C12}'..='\u{0C28}'
+ | '\u{0C2A}'..='\u{0C39}'
+ | '\u{0C3C}'..='\u{0C44}'
+ | '\u{0C46}'..='\u{0C48}'
+ | '\u{0C4A}'..='\u{0C4D}'
+ | '\u{0C55}'..='\u{0C56}'
+ | '\u{0C58}'..='\u{0C5A}'
+ | '\u{0C5D}'
+ | '\u{0C60}'..='\u{0C63}'
+ | '\u{0C66}'..='\u{0C6F}'
+ | '\u{0C77}'..='\u{0C8C}'
+ | '\u{0C8E}'..='\u{0C90}'
+ | '\u{0C92}'..='\u{0CA8}'
+ | '\u{0CAA}'..='\u{0CB3}'
+ | '\u{0CB5}'..='\u{0CB9}'
+ | '\u{0CBC}'..='\u{0CC4}'
+ | '\u{0CC6}'..='\u{0CC8}'
+ | '\u{0CCA}'..='\u{0CCD}'
+ | '\u{0CD5}'..='\u{0CD6}'
+ | '\u{0CDD}'..='\u{0CDE}'
+ | '\u{0CE0}'..='\u{0CE3}'
+ | '\u{0CE6}'..='\u{0CEF}'
+ | '\u{0CF1}'..='\u{0CF3}'
+ | '\u{0D00}'..='\u{0D0C}'
+ | '\u{0D0E}'..='\u{0D10}'
+ | '\u{0D12}'..='\u{0D44}'
+ | '\u{0D46}'..='\u{0D48}'
+ | '\u{0D4A}'..='\u{0D4F}'
+ | '\u{0D54}'..='\u{0D63}'
+ | '\u{0D66}'..='\u{0D7F}'
+ | '\u{0D81}'..='\u{0D83}'
+ | '\u{0D85}'..='\u{0D96}'
+ | '\u{0D9A}'..='\u{0DB1}'
+ | '\u{0DB3}'..='\u{0DBB}'
+ | '\u{0DBD}'
+ | '\u{0DC0}'..='\u{0DC6}'
+ | '\u{0DCA}'
+ | '\u{0DCF}'..='\u{0DD4}'
+ | '\u{0DD6}'
+ | '\u{0DD8}'..='\u{0DDF}'
+ | '\u{0DE6}'..='\u{0DEF}'
+ | '\u{0DF2}'..='\u{0DF4}'
+ | '\u{0E01}'..='\u{0E3A}'
+ | '\u{0E3F}'..='\u{0E5B}'
+ | '\u{0E81}'..='\u{0E82}'
+ | '\u{0E84}'
+ | '\u{0E86}'..='\u{0E8A}'
+ | '\u{0E8C}'..='\u{0EA3}'
+ | '\u{0EA5}'
+ | '\u{0EA7}'..='\u{0EBD}'
+ | '\u{0EC0}'..='\u{0EC4}'
+ | '\u{0EC6}'
+ | '\u{0EC8}'..='\u{0ECE}'
+ | '\u{0ED0}'..='\u{0ED9}'
+ | '\u{0EDC}'..='\u{0EDF}'
+ | '\u{0F00}'..='\u{0F47}'
+ | '\u{0F49}'..='\u{0F6C}'
+ | '\u{0F71}'..='\u{0F97}'
+ | '\u{0F99}'..='\u{0FBC}'
+ | '\u{0FBE}'..='\u{0FCC}'
+ | '\u{0FCE}'..='\u{0FDA}'
+ | '\u{1000}'..='\u{10C5}'
+ | '\u{10C7}'
+ | '\u{10CD}'
+ | '\u{10D0}'..='\u{1248}'
+ | '\u{124A}'..='\u{124D}'
+ | '\u{1250}'..='\u{1256}'
+ | '\u{1258}'
+ | '\u{125A}'..='\u{125D}'
+ | '\u{1260}'..='\u{1288}'
+ | '\u{128A}'..='\u{128D}'
+ | '\u{1290}'..='\u{12B0}'
+ | '\u{12B2}'..='\u{12B5}'
+ | '\u{12B8}'..='\u{12BE}'
+ | '\u{12C0}'
+ | '\u{12C2}'..='\u{12C5}'
+ | '\u{12C8}'..='\u{12D6}'
+ | '\u{12D8}'..='\u{1310}'
+ | '\u{1312}'..='\u{1315}'
+ | '\u{1318}'..='\u{135A}'
+ | '\u{135D}'..='\u{137C}'
+ | '\u{1380}'..='\u{1399}'
+ | '\u{13A0}'..='\u{13F5}'
+ | '\u{13F8}'..='\u{13FD}'
+ | '\u{1400}'..='\u{169C}'
+ | '\u{16A0}'..='\u{16F8}'
+ | '\u{1700}'..='\u{1715}'
+ | '\u{171F}'..='\u{1736}'
+ | '\u{1740}'..='\u{1753}'
+ | '\u{1760}'..='\u{176C}'
+ | '\u{176E}'..='\u{1770}'
+ | '\u{1772}'..='\u{1773}'
+ | '\u{1780}'..='\u{17DD}'
+ | '\u{17E0}'..='\u{17E9}'
+ | '\u{17F0}'..='\u{17F9}'
+ | '\u{1800}'..='\u{1819}'
+ | '\u{1820}'..='\u{1878}'
+ | '\u{1880}'..='\u{18AA}'
+ | '\u{18B0}'..='\u{18F5}'
+ | '\u{1900}'..='\u{191E}'
+ | '\u{1920}'..='\u{192B}'
+ | '\u{1930}'..='\u{193B}'
+ | '\u{1940}'
+ | '\u{1944}'..='\u{196D}'
+ | '\u{1970}'..='\u{1974}'
+ | '\u{1980}'..='\u{19AB}'
+ | '\u{19B0}'..='\u{19C9}'
+ | '\u{19D0}'..='\u{19DA}'
+ | '\u{19DE}'..='\u{1A1B}'
+ | '\u{1A1E}'..='\u{1A5E}'
+ | '\u{1A60}'..='\u{1A7C}'
+ | '\u{1A7F}'..='\u{1A89}'
+ | '\u{1A90}'..='\u{1A99}'
+ | '\u{1AA0}'..='\u{1AAD}'
+ | '\u{1AB0}'..='\u{1ACE}'
+ | '\u{1B00}'..='\u{1B4C}'
+ | '\u{1B50}'..='\u{1B7E}'
+ | '\u{1B80}'..='\u{1BF3}'
+ | '\u{1BFC}'..='\u{1C37}'
+ | '\u{1C3B}'..='\u{1C49}'
+ | '\u{1C4D}'..='\u{1C88}'
+ | '\u{1C90}'..='\u{1CBA}'
+ | '\u{1CBD}'..='\u{1CC7}'
+ | '\u{1CD0}'..='\u{1CFA}'
+ | '\u{1D00}'..='\u{1F15}'
+ | '\u{1F18}'..='\u{1F1D}'
+ | '\u{1F20}'..='\u{1F45}'
+ | '\u{1F48}'..='\u{1F4D}'
+ | '\u{1F50}'..='\u{1F57}'
+ | '\u{1F59}'
+ | '\u{1F5B}'
+ | '\u{1F5D}'
+ | '\u{1F5F}'..='\u{1F7D}'
+ | '\u{1F80}'..='\u{1FB4}'
+ | '\u{1FB6}'..='\u{1FC4}'
+ | '\u{1FC6}'..='\u{1FD3}'
+ | '\u{1FD6}'..='\u{1FDB}'
+ | '\u{1FDD}'..='\u{1FEF}'
+ | '\u{1FF2}'..='\u{1FF4}'
+ | '\u{1FF6}'..='\u{1FFE}'
+ | '\u{2000}'..='\u{2064}'
+ | '\u{2066}'..='\u{2071}'
+ | '\u{2074}'..='\u{208E}'
+ | '\u{2090}'..='\u{209C}'
+ | '\u{20A0}'..='\u{20C0}'
+ | '\u{20D0}'..='\u{20F0}'
+ | '\u{2100}'..='\u{218B}'
+ | '\u{2190}'..='\u{2426}'
+ | '\u{2440}'..='\u{244A}'
+ | '\u{2460}'..='\u{2B73}'
+ | '\u{2B76}'..='\u{2B95}'
+ | '\u{2B97}'..='\u{2CF3}'
+ | '\u{2CF9}'..='\u{2D25}'
+ | '\u{2D27}'
+ | '\u{2D2D}'
+ | '\u{2D30}'..='\u{2D67}'
+ | '\u{2D6F}'..='\u{2D70}'
+ | '\u{2D7F}'..='\u{2D96}'
+ | '\u{2DA0}'..='\u{2DA6}'
+ | '\u{2DA8}'..='\u{2DAE}'
+ | '\u{2DB0}'..='\u{2DB6}'
+ | '\u{2DB8}'..='\u{2DBE}'
+ | '\u{2DC0}'..='\u{2DC6}'
+ | '\u{2DC8}'..='\u{2DCE}'
+ | '\u{2DD0}'..='\u{2DD6}'
+ | '\u{2DD8}'..='\u{2DDE}'
+ | '\u{2DE0}'..='\u{2E5D}'
+ | '\u{2E80}'..='\u{2E99}'
+ | '\u{2E9B}'..='\u{2EF3}'
+ | '\u{2F00}'..='\u{2FD5}'
+ | '\u{2FF0}'..='\u{2FFB}'
+ | '\u{3000}'..='\u{303F}'
+ | '\u{3041}'..='\u{3096}'
+ | '\u{3099}'..='\u{30FF}'
+ | '\u{3105}'..='\u{312F}'
+ | '\u{3131}'..='\u{318E}'
+ | '\u{3190}'..='\u{31E3}'
+ | '\u{31F0}'..='\u{321E}'
+ | '\u{3220}'..='\u{A48C}'
+ | '\u{A490}'..='\u{A4C6}'
+ | '\u{A4D0}'..='\u{A62B}'
+ | '\u{A640}'..='\u{A6F7}'
+ | '\u{A700}'..='\u{A7CA}'
+ | '\u{A7D0}'..='\u{A7D1}'
+ | '\u{A7D3}'
+ | '\u{A7D5}'..='\u{A7D9}'
+ | '\u{A7F2}'..='\u{A82C}'
+ | '\u{A830}'..='\u{A839}'
+ | '\u{A840}'..='\u{A877}'
+ | '\u{A880}'..='\u{A8C5}'
+ | '\u{A8CE}'..='\u{A8D9}'
+ | '\u{A8E0}'..='\u{A953}'
+ | '\u{A95F}'..='\u{A97C}'
+ | '\u{A980}'..='\u{A9CD}'
+ | '\u{A9CF}'..='\u{A9D9}'
+ | '\u{A9DE}'..='\u{A9FE}'
+ | '\u{AA00}'..='\u{AA36}'
+ | '\u{AA40}'..='\u{AA4D}'
+ | '\u{AA50}'..='\u{AA59}'
+ | '\u{AA5C}'..='\u{AAC2}'
+ | '\u{AADB}'..='\u{AAF6}'
+ | '\u{AB01}'..='\u{AB06}'
+ | '\u{AB09}'..='\u{AB0E}'
+ | '\u{AB11}'..='\u{AB16}'
+ | '\u{AB20}'..='\u{AB26}'
+ | '\u{AB28}'..='\u{AB2E}'
+ | '\u{AB30}'..='\u{AB6B}'
+ | '\u{AB70}'..='\u{ABED}'
+ | '\u{ABF0}'..='\u{ABF9}'
+ | '\u{AC00}'..='\u{D7A3}'
+ | '\u{D7B0}'..='\u{D7C6}'
+ | '\u{D7CB}'..='\u{D7FB}'
+ | '\u{F900}'..='\u{FA6D}'
+ | '\u{FA70}'..='\u{FAD9}'
+ | '\u{FB00}'..='\u{FB06}'
+ | '\u{FB13}'..='\u{FB17}'
+ | '\u{FB1D}'..='\u{FB36}'
+ | '\u{FB38}'..='\u{FB3C}'
+ | '\u{FB3E}'
+ | '\u{FB40}'..='\u{FB41}'
+ | '\u{FB43}'..='\u{FB44}'
+ | '\u{FB46}'..='\u{FBC2}'
+ | '\u{FBD3}'..='\u{FD8F}'
+ | '\u{FD92}'..='\u{FDC7}'
+ | '\u{FDCF}'
+ | '\u{FDF0}'..='\u{FE19}'
+ | '\u{FE20}'..='\u{FE52}'
+ | '\u{FE54}'..='\u{FE66}'
+ | '\u{FE68}'..='\u{FE6B}'
+ | '\u{FE70}'..='\u{FE74}'
+ | '\u{FE76}'..='\u{FEFC}'
+ | '\u{FEFF}'
+ | '\u{FF01}'..='\u{FFBE}'
+ | '\u{FFC2}'..='\u{FFC7}'
+ | '\u{FFCA}'..='\u{FFCF}'
+ | '\u{FFD2}'..='\u{FFD7}'
+ | '\u{FFDA}'..='\u{FFDC}'
+ | '\u{FFE0}'..='\u{FFE6}'
+ | '\u{FFE8}'..='\u{FFEE}'
+ | '\u{FFF9}'..='\u{FFFD}'
+ | '\u{10000}'..='\u{1000B}'
+ | '\u{1000D}'..='\u{10026}'
+ | '\u{10028}'..='\u{1003A}'
+ | '\u{1003C}'..='\u{1003D}'
+ | '\u{1003F}'..='\u{1004D}'
+ | '\u{10050}'..='\u{1005D}'
+ | '\u{10080}'..='\u{100FA}'
+ | '\u{10100}'..='\u{10102}'
+ | '\u{10107}'..='\u{10133}'
+ | '\u{10137}'..='\u{1018E}'
+ | '\u{10190}'..='\u{1019C}'
+ | '\u{101A0}'
+ | '\u{101D0}'..='\u{101FD}'
+ | '\u{10280}'..='\u{1029C}'
+ | '\u{102A0}'..='\u{102D0}'
+ | '\u{102E0}'..='\u{102FB}'
+ | '\u{10300}'..='\u{10323}'
+ | '\u{1032D}'..='\u{1034A}'
+ | '\u{10350}'..='\u{1037A}'
+ | '\u{10380}'..='\u{1039D}'
+ | '\u{1039F}'..='\u{103C3}'
+ | '\u{103C8}'..='\u{103D5}'
+ | '\u{10400}'..='\u{1049D}'
+ | '\u{104A0}'..='\u{104A9}'
+ | '\u{104B0}'..='\u{104D3}'
+ | '\u{104D8}'..='\u{104FB}'
+ | '\u{10500}'..='\u{10527}'
+ | '\u{10530}'..='\u{10563}'
+ | '\u{1056F}'..='\u{1057A}'
+ | '\u{1057C}'..='\u{1058A}'
+ | '\u{1058C}'..='\u{10592}'
+ | '\u{10594}'..='\u{10595}'
+ | '\u{10597}'..='\u{105A1}'
+ | '\u{105A3}'..='\u{105B1}'
+ | '\u{105B3}'..='\u{105B9}'
+ | '\u{105BB}'..='\u{105BC}'
+ | '\u{10600}'..='\u{10736}'
+ | '\u{10740}'..='\u{10755}'
+ | '\u{10760}'..='\u{10767}'
+ | '\u{10780}'..='\u{10785}'
+ | '\u{10787}'..='\u{107B0}'
+ | '\u{107B2}'..='\u{107BA}'
+ | '\u{10800}'..='\u{10805}'
+ | '\u{10808}'
+ | '\u{1080A}'..='\u{10835}'
+ | '\u{10837}'..='\u{10838}'
+ | '\u{1083C}'
+ | '\u{1083F}'..='\u{10855}'
+ | '\u{10857}'..='\u{1089E}'
+ | '\u{108A7}'..='\u{108AF}'
+ | '\u{108E0}'..='\u{108F2}'
+ | '\u{108F4}'..='\u{108F5}'
+ | '\u{108FB}'..='\u{1091B}'
+ | '\u{1091F}'..='\u{10939}'
+ | '\u{1093F}'
+ | '\u{10980}'..='\u{109B7}'
+ | '\u{109BC}'..='\u{109CF}'
+ | '\u{109D2}'..='\u{10A03}'
+ | '\u{10A05}'..='\u{10A06}'
+ | '\u{10A0C}'..='\u{10A13}'
+ | '\u{10A15}'..='\u{10A17}'
+ | '\u{10A19}'..='\u{10A35}'
+ | '\u{10A38}'..='\u{10A3A}'
+ | '\u{10A3F}'..='\u{10A48}'
+ | '\u{10A50}'..='\u{10A58}'
+ | '\u{10A60}'..='\u{10A9F}'
+ | '\u{10AC0}'..='\u{10AE6}'
+ | '\u{10AEB}'..='\u{10AF6}'
+ | '\u{10B00}'..='\u{10B35}'
+ | '\u{10B39}'..='\u{10B55}'
+ | '\u{10B58}'..='\u{10B72}'
+ | '\u{10B78}'..='\u{10B91}'
+ | '\u{10B99}'..='\u{10B9C}'
+ | '\u{10BA9}'..='\u{10BAF}'
+ | '\u{10C00}'..='\u{10C48}'
+ | '\u{10C80}'..='\u{10CB2}'
+ | '\u{10CC0}'..='\u{10CF2}'
+ | '\u{10CFA}'..='\u{10D27}'
+ | '\u{10D30}'..='\u{10D39}'
+ | '\u{10E60}'..='\u{10E7E}'
+ | '\u{10E80}'..='\u{10EA9}'
+ | '\u{10EAB}'..='\u{10EAD}'
+ | '\u{10EB0}'..='\u{10EB1}'
+ | '\u{10EFD}'..='\u{10F27}'
+ | '\u{10F30}'..='\u{10F59}'
+ | '\u{10F70}'..='\u{10F89}'
+ | '\u{10FB0}'..='\u{10FCB}'
+ | '\u{10FE0}'..='\u{10FF6}'
+ | '\u{11000}'..='\u{1104D}'
+ | '\u{11052}'..='\u{11075}'
+ | '\u{1107F}'..='\u{110C2}'
+ | '\u{110CD}'
+ | '\u{110D0}'..='\u{110E8}'
+ | '\u{110F0}'..='\u{110F9}'
+ | '\u{11100}'..='\u{11134}'
+ | '\u{11136}'..='\u{11147}'
+ | '\u{11150}'..='\u{11176}'
+ | '\u{11180}'..='\u{111DF}'
+ | '\u{111E1}'..='\u{111F4}'
+ | '\u{11200}'..='\u{11211}'
+ | '\u{11213}'..='\u{11241}'
+ | '\u{11280}'..='\u{11286}'
+ | '\u{11288}'
+ | '\u{1128A}'..='\u{1128D}'
+ | '\u{1128F}'..='\u{1129D}'
+ | '\u{1129F}'..='\u{112A9}'
+ | '\u{112B0}'..='\u{112EA}'
+ | '\u{112F0}'..='\u{112F9}'
+ | '\u{11300}'..='\u{11303}'
+ | '\u{11305}'..='\u{1130C}'
+ | '\u{1130F}'..='\u{11310}'
+ | '\u{11313}'..='\u{11328}'
+ | '\u{1132A}'..='\u{11330}'
+ | '\u{11332}'..='\u{11333}'
+ | '\u{11335}'..='\u{11339}'
+ | '\u{1133B}'..='\u{11344}'
+ | '\u{11347}'..='\u{11348}'
+ | '\u{1134B}'..='\u{1134D}'
+ | '\u{11350}'
+ | '\u{11357}'
+ | '\u{1135D}'..='\u{11363}'
+ | '\u{11366}'..='\u{1136C}'
+ | '\u{11370}'..='\u{11374}'
+ | '\u{11400}'..='\u{1145B}'
+ | '\u{1145D}'..='\u{11461}'
+ | '\u{11480}'..='\u{114C7}'
+ | '\u{114D0}'..='\u{114D9}'
+ | '\u{11580}'..='\u{115B5}'
+ | '\u{115B8}'..='\u{115DD}'
+ | '\u{11600}'..='\u{11644}'
+ | '\u{11650}'..='\u{11659}'
+ | '\u{11660}'..='\u{1166C}'
+ | '\u{11680}'..='\u{116B9}'
+ | '\u{116C0}'..='\u{116C9}'
+ | '\u{11700}'..='\u{1171A}'
+ | '\u{1171D}'..='\u{1172B}'
+ | '\u{11730}'..='\u{11746}'
+ | '\u{11800}'..='\u{1183B}'
+ | '\u{118A0}'..='\u{118F2}'
+ | '\u{118FF}'..='\u{11906}'
+ | '\u{11909}'
+ | '\u{1190C}'..='\u{11913}'
+ | '\u{11915}'..='\u{11916}'
+ | '\u{11918}'..='\u{11935}'
+ | '\u{11937}'..='\u{11938}'
+ | '\u{1193B}'..='\u{11946}'
+ | '\u{11950}'..='\u{11959}'
+ | '\u{119A0}'..='\u{119A7}'
+ | '\u{119AA}'..='\u{119D7}'
+ | '\u{119DA}'..='\u{119E4}'
+ | '\u{11A00}'..='\u{11A47}'
+ | '\u{11A50}'..='\u{11AA2}'
+ | '\u{11AB0}'..='\u{11AF8}'
+ | '\u{11B00}'..='\u{11B09}'
+ | '\u{11C00}'..='\u{11C08}'
+ | '\u{11C0A}'..='\u{11C36}'
+ | '\u{11C38}'..='\u{11C45}'
+ | '\u{11C50}'..='\u{11C6C}'
+ | '\u{11C70}'..='\u{11C8F}'
+ | '\u{11C92}'..='\u{11CA7}'
+ | '\u{11CA9}'..='\u{11CB6}'
+ | '\u{11D00}'..='\u{11D06}'
+ | '\u{11D08}'..='\u{11D09}'
+ | '\u{11D0B}'..='\u{11D36}'
+ | '\u{11D3A}'
+ | '\u{11D3C}'..='\u{11D3D}'
+ | '\u{11D3F}'..='\u{11D47}'
+ | '\u{11D50}'..='\u{11D59}'
+ | '\u{11D60}'..='\u{11D65}'
+ | '\u{11D67}'..='\u{11D68}'
+ | '\u{11D6A}'..='\u{11D8E}'
+ | '\u{11D90}'..='\u{11D91}'
+ | '\u{11D93}'..='\u{11D98}'
+ | '\u{11DA0}'..='\u{11DA9}'
+ | '\u{11EE0}'..='\u{11EF8}'
+ | '\u{11F00}'..='\u{11F10}'
+ | '\u{11F12}'..='\u{11F3A}'
+ | '\u{11F3E}'..='\u{11F59}'
+ | '\u{11FB0}'
+ | '\u{11FC0}'..='\u{11FF1}'
+ | '\u{11FFF}'..='\u{12399}'
+ | '\u{12400}'..='\u{1246E}'
+ | '\u{12470}'..='\u{12474}'
+ | '\u{12480}'..='\u{12543}'
+ | '\u{12F90}'..='\u{12FF2}'
+ | '\u{13000}'..='\u{13455}'
+ | '\u{14400}'..='\u{14646}'
+ | '\u{16800}'..='\u{16A38}'
+ | '\u{16A40}'..='\u{16A5E}'
+ | '\u{16A60}'..='\u{16A69}'
+ | '\u{16A6E}'..='\u{16ABE}'
+ | '\u{16AC0}'..='\u{16AC9}'
+ | '\u{16AD0}'..='\u{16AED}'
+ | '\u{16AF0}'..='\u{16AF5}'
+ | '\u{16B00}'..='\u{16B45}'
+ | '\u{16B50}'..='\u{16B59}'
+ | '\u{16B5B}'..='\u{16B61}'
+ | '\u{16B63}'..='\u{16B77}'
+ | '\u{16B7D}'..='\u{16B8F}'
+ | '\u{16E40}'..='\u{16E9A}'
+ | '\u{16F00}'..='\u{16F4A}'
+ | '\u{16F4F}'..='\u{16F87}'
+ | '\u{16F8F}'..='\u{16F9F}'
+ | '\u{16FE0}'..='\u{16FE4}'
+ | '\u{16FF0}'..='\u{16FF1}'
+ | '\u{17000}'..='\u{187F7}'
+ | '\u{18800}'..='\u{18CD5}'
+ | '\u{18D00}'..='\u{18D08}'
+ | '\u{1AFF0}'..='\u{1AFF3}'
+ | '\u{1AFF5}'..='\u{1AFFB}'
+ | '\u{1AFFD}'..='\u{1AFFE}'
+ | '\u{1B000}'..='\u{1B122}'
+ | '\u{1B132}'
+ | '\u{1B150}'..='\u{1B152}'
+ | '\u{1B155}'
+ | '\u{1B164}'..='\u{1B167}'
+ | '\u{1B170}'..='\u{1B2FB}'
+ | '\u{1BC00}'..='\u{1BC6A}'
+ | '\u{1BC70}'..='\u{1BC7C}'
+ | '\u{1BC80}'..='\u{1BC88}'
+ | '\u{1BC90}'..='\u{1BC99}'
+ | '\u{1BC9C}'..='\u{1BCA3}'
+ | '\u{1CF00}'..='\u{1CF2D}'
+ | '\u{1CF30}'..='\u{1CF46}'
+ | '\u{1CF50}'..='\u{1CFC3}'
+ | '\u{1D000}'..='\u{1D0F5}'
+ | '\u{1D100}'..='\u{1D126}'
+ | '\u{1D129}'..='\u{1D1EA}'
+ | '\u{1D200}'..='\u{1D245}'
+ | '\u{1D2C0}'..='\u{1D2D3}'
+ | '\u{1D2E0}'..='\u{1D2F3}'
+ | '\u{1D300}'..='\u{1D356}'
+ | '\u{1D360}'..='\u{1D378}'
+ | '\u{1D400}'..='\u{1D454}'
+ | '\u{1D456}'..='\u{1D49C}'
+ | '\u{1D49E}'..='\u{1D49F}'
+ | '\u{1D4A2}'
+ | '\u{1D4A5}'..='\u{1D4A6}'
+ | '\u{1D4A9}'..='\u{1D4AC}'
+ | '\u{1D4AE}'..='\u{1D4B9}'
+ | '\u{1D4BB}'
+ | '\u{1D4BD}'..='\u{1D4C3}'
+ | '\u{1D4C5}'..='\u{1D505}'
+ | '\u{1D507}'..='\u{1D50A}'
+ | '\u{1D50D}'..='\u{1D514}'
+ | '\u{1D516}'..='\u{1D51C}'
+ | '\u{1D51E}'..='\u{1D539}'
+ | '\u{1D53B}'..='\u{1D53E}'
+ | '\u{1D540}'..='\u{1D544}'
+ | '\u{1D546}'
+ | '\u{1D54A}'..='\u{1D550}'
+ | '\u{1D552}'..='\u{1D6A5}'
+ | '\u{1D6A8}'..='\u{1D7CB}'
+ | '\u{1D7CE}'..='\u{1DA8B}'
+ | '\u{1DA9B}'..='\u{1DA9F}'
+ | '\u{1DAA1}'..='\u{1DAAF}'
+ | '\u{1DF00}'..='\u{1DF1E}'
+ | '\u{1DF25}'..='\u{1DF2A}'
+ | '\u{1E000}'..='\u{1E006}'
+ | '\u{1E008}'..='\u{1E018}'
+ | '\u{1E01B}'..='\u{1E021}'
+ | '\u{1E023}'..='\u{1E024}'
+ | '\u{1E026}'..='\u{1E02A}'
+ | '\u{1E030}'..='\u{1E06D}'
+ | '\u{1E08F}'
+ | '\u{1E100}'..='\u{1E12C}'
+ | '\u{1E130}'..='\u{1E13D}'
+ | '\u{1E140}'..='\u{1E149}'
+ | '\u{1E14E}'..='\u{1E14F}'
+ | '\u{1E290}'..='\u{1E2AE}'
+ | '\u{1E2C0}'..='\u{1E2F9}'
+ | '\u{1E2FF}'
+ | '\u{1E4D0}'..='\u{1E4F9}'
+ | '\u{1E7E0}'..='\u{1E7E6}'
+ | '\u{1E7E8}'..='\u{1E7EB}'
+ | '\u{1E7ED}'..='\u{1E7EE}'
+ | '\u{1E7F0}'..='\u{1E7FE}'
+ | '\u{1E800}'..='\u{1E8C4}'
+ | '\u{1E8C7}'..='\u{1E8D6}'
+ | '\u{1E900}'..='\u{1E94B}'
+ | '\u{1E950}'..='\u{1E959}'
+ | '\u{1E95E}'..='\u{1E95F}'
+ | '\u{1EC71}'..='\u{1ECB4}'
+ | '\u{1ED01}'..='\u{1ED3D}'
+ | '\u{1EE00}'..='\u{1EE03}'
+ | '\u{1EE05}'..='\u{1EE1F}'
+ | '\u{1EE21}'..='\u{1EE22}'
+ | '\u{1EE24}'
+ | '\u{1EE27}'
+ | '\u{1EE29}'..='\u{1EE32}'
+ | '\u{1EE34}'..='\u{1EE37}'
+ | '\u{1EE39}'
+ | '\u{1EE3B}'
+ | '\u{1EE42}'
+ | '\u{1EE47}'
+ | '\u{1EE49}'
+ | '\u{1EE4B}'
+ | '\u{1EE4D}'..='\u{1EE4F}'
+ | '\u{1EE51}'..='\u{1EE52}'
+ | '\u{1EE54}'
+ | '\u{1EE57}'
+ | '\u{1EE59}'
+ | '\u{1EE5B}'
+ | '\u{1EE5D}'
+ | '\u{1EE5F}'
+ | '\u{1EE61}'..='\u{1EE62}'
+ | '\u{1EE64}'
+ | '\u{1EE67}'..='\u{1EE6A}'
+ | '\u{1EE6C}'..='\u{1EE72}'
+ | '\u{1EE74}'..='\u{1EE77}'
+ | '\u{1EE79}'..='\u{1EE7C}'
+ | '\u{1EE7E}'
+ | '\u{1EE80}'..='\u{1EE89}'
+ | '\u{1EE8B}'..='\u{1EE9B}'
+ | '\u{1EEA1}'..='\u{1EEA3}'
+ | '\u{1EEA5}'..='\u{1EEA9}'
+ | '\u{1EEAB}'..='\u{1EEBB}'
+ | '\u{1EEF0}'..='\u{1EEF1}'
+ | '\u{1F000}'..='\u{1F02B}'
+ | '\u{1F030}'..='\u{1F093}'
+ | '\u{1F0A0}'..='\u{1F0AE}'
+ | '\u{1F0B1}'..='\u{1F0BF}'
+ | '\u{1F0C1}'..='\u{1F0CF}'
+ | '\u{1F0D1}'..='\u{1F0F5}'
+ | '\u{1F100}'..='\u{1F1AD}'
+ | '\u{1F1E6}'..='\u{1F202}'
+ | '\u{1F210}'..='\u{1F23B}'
+ | '\u{1F240}'..='\u{1F248}'
+ | '\u{1F250}'..='\u{1F251}'
+ | '\u{1F260}'..='\u{1F265}'
+ | '\u{1F300}'..='\u{1F6D7}'
+ | '\u{1F6DC}'..='\u{1F6EC}'
+ | '\u{1F6F0}'..='\u{1F6FC}'
+ | '\u{1F700}'..='\u{1F776}'
+ | '\u{1F77B}'..='\u{1F7D9}'
+ | '\u{1F7E0}'..='\u{1F7EB}'
+ | '\u{1F7F0}'
+ | '\u{1F800}'..='\u{1F80B}'
+ | '\u{1F810}'..='\u{1F847}'
+ | '\u{1F850}'..='\u{1F859}'
+ | '\u{1F860}'..='\u{1F887}'
+ | '\u{1F890}'..='\u{1F8AD}'
+ | '\u{1F8B0}'..='\u{1F8B1}'
+ | '\u{1F900}'..='\u{1FA53}'
+ | '\u{1FA60}'..='\u{1FA6D}'
+ | '\u{1FA70}'..='\u{1FA7C}'
+ | '\u{1FA80}'..='\u{1FA88}'
+ | '\u{1FA90}'..='\u{1FABD}'
+ | '\u{1FABF}'..='\u{1FAC5}'
+ | '\u{1FACE}'..='\u{1FADB}'
+ | '\u{1FAE0}'..='\u{1FAE8}'
+ | '\u{1FAF0}'..='\u{1FAF8}'
+ | '\u{1FB00}'..='\u{1FB92}'
+ | '\u{1FB94}'..='\u{1FBCA}'
+ | '\u{1FBF0}'..='\u{1FBF9}'
+ | '\u{20000}'..='\u{2A6DF}'
+ | '\u{2A700}'..='\u{2B739}'
+ | '\u{2B740}'..='\u{2B81D}'
+ | '\u{2B820}'..='\u{2CEA1}'
+ | '\u{2CEB0}'..='\u{2EBE0}'
+ | '\u{2F800}'..='\u{2FA1D}'
+ | '\u{30000}'..='\u{3134A}'
+ | '\u{31350}'..='\u{323AF}'
+ | '\u{E0001}'
+ | '\u{E0020}'..='\u{E007F}'
+ | '\u{E0100}'..='\u{E01EF}'
+ => true,
+ _ => false,
+ }
+}
+
+
+#[inline]
+#[allow(ellipsis_inclusive_range_patterns)]
+pub fn qc_nfc(c: char) -> IsNormalized {
+ match c {
+ '\u{0340}'...'\u{0341}' => No,
+ '\u{0343}'...'\u{0344}' => No,
+ '\u{0374}' => No,
+ '\u{037E}' => No,
+ '\u{0387}' => No,
+ '\u{0958}'...'\u{095F}' => No,
+ '\u{09DC}'...'\u{09DD}' => No,
+ '\u{09DF}' => No,
+ '\u{0A33}' => No,
+ '\u{0A36}' => No,
+ '\u{0A59}'...'\u{0A5B}' => No,
+ '\u{0A5E}' => No,
+ '\u{0B5C}'...'\u{0B5D}' => No,
+ '\u{0F43}' => No,
+ '\u{0F4D}' => No,
+ '\u{0F52}' => No,
+ '\u{0F57}' => No,
+ '\u{0F5C}' => No,
+ '\u{0F69}' => No,
+ '\u{0F73}' => No,
+ '\u{0F75}'...'\u{0F76}' => No,
+ '\u{0F78}' => No,
+ '\u{0F81}' => No,
+ '\u{0F93}' => No,
+ '\u{0F9D}' => No,
+ '\u{0FA2}' => No,
+ '\u{0FA7}' => No,
+ '\u{0FAC}' => No,
+ '\u{0FB9}' => No,
+ '\u{1F71}' => No,
+ '\u{1F73}' => No,
+ '\u{1F75}' => No,
+ '\u{1F77}' => No,
+ '\u{1F79}' => No,
+ '\u{1F7B}' => No,
+ '\u{1F7D}' => No,
+ '\u{1FBB}' => No,
+ '\u{1FBE}' => No,
+ '\u{1FC9}' => No,
+ '\u{1FCB}' => No,
+ '\u{1FD3}' => No,
+ '\u{1FDB}' => No,
+ '\u{1FE3}' => No,
+ '\u{1FEB}' => No,
+ '\u{1FEE}'...'\u{1FEF}' => No,
+ '\u{1FF9}' => No,
+ '\u{1FFB}' => No,
+ '\u{1FFD}' => No,
+ '\u{2000}'...'\u{2001}' => No,
+ '\u{2126}' => No,
+ '\u{212A}'...'\u{212B}' => No,
+ '\u{2329}' => No,
+ '\u{232A}' => No,
+ '\u{2ADC}' => No,
+ '\u{F900}'...'\u{FA0D}' => No,
+ '\u{FA10}' => No,
+ '\u{FA12}' => No,
+ '\u{FA15}'...'\u{FA1E}' => No,
+ '\u{FA20}' => No,
+ '\u{FA22}' => No,
+ '\u{FA25}'...'\u{FA26}' => No,
+ '\u{FA2A}'...'\u{FA6D}' => No,
+ '\u{FA70}'...'\u{FAD9}' => No,
+ '\u{FB1D}' => No,
+ '\u{FB1F}' => No,
+ '\u{FB2A}'...'\u{FB36}' => No,
+ '\u{FB38}'...'\u{FB3C}' => No,
+ '\u{FB3E}' => No,
+ '\u{FB40}'...'\u{FB41}' => No,
+ '\u{FB43}'...'\u{FB44}' => No,
+ '\u{FB46}'...'\u{FB4E}' => No,
+ '\u{1D15E}'...'\u{1D164}' => No,
+ '\u{1D1BB}'...'\u{1D1C0}' => No,
+ '\u{2F800}'...'\u{2FA1D}' => No,
+ '\u{0300}'...'\u{0304}' => Maybe,
+ '\u{0306}'...'\u{030C}' => Maybe,
+ '\u{030F}' => Maybe,
+ '\u{0311}' => Maybe,
+ '\u{0313}'...'\u{0314}' => Maybe,
+ '\u{031B}' => Maybe,
+ '\u{0323}'...'\u{0328}' => Maybe,
+ '\u{032D}'...'\u{032E}' => Maybe,
+ '\u{0330}'...'\u{0331}' => Maybe,
+ '\u{0338}' => Maybe,
+ '\u{0342}' => Maybe,
+ '\u{0345}' => Maybe,
+ '\u{0653}'...'\u{0655}' => Maybe,
+ '\u{093C}' => Maybe,
+ '\u{09BE}' => Maybe,
+ '\u{09D7}' => Maybe,
+ '\u{0B3E}' => Maybe,
+ '\u{0B56}' => Maybe,
+ '\u{0B57}' => Maybe,
+ '\u{0BBE}' => Maybe,
+ '\u{0BD7}' => Maybe,
+ '\u{0C56}' => Maybe,
+ '\u{0CC2}' => Maybe,
+ '\u{0CD5}'...'\u{0CD6}' => Maybe,
+ '\u{0D3E}' => Maybe,
+ '\u{0D57}' => Maybe,
+ '\u{0DCA}' => Maybe,
+ '\u{0DCF}' => Maybe,
+ '\u{0DDF}' => Maybe,
+ '\u{102E}' => Maybe,
+ '\u{1161}'...'\u{1175}' => Maybe,
+ '\u{11A8}'...'\u{11C2}' => Maybe,
+ '\u{1B35}' => Maybe,
+ '\u{3099}'...'\u{309A}' => Maybe,
+ '\u{110BA}' => Maybe,
+ '\u{11127}' => Maybe,
+ '\u{1133E}' => Maybe,
+ '\u{11357}' => Maybe,
+ '\u{114B0}' => Maybe,
+ '\u{114BA}' => Maybe,
+ '\u{114BD}' => Maybe,
+ '\u{115AF}' => Maybe,
+ '\u{11930}' => Maybe,
+ _ => Yes,
+ }
+}
+
+#[inline]
+#[allow(ellipsis_inclusive_range_patterns)]
+pub fn qc_nfkc(c: char) -> IsNormalized {
+ match c {
+ '\u{00A0}' => No,
+ '\u{00A8}' => No,
+ '\u{00AA}' => No,
+ '\u{00AF}' => No,
+ '\u{00B2}'...'\u{00B3}' => No,
+ '\u{00B4}' => No,
+ '\u{00B5}' => No,
+ '\u{00B8}' => No,
+ '\u{00B9}' => No,
+ '\u{00BA}' => No,
+ '\u{00BC}'...'\u{00BE}' => No,
+ '\u{0132}'...'\u{0133}' => No,
+ '\u{013F}'...'\u{0140}' => No,
+ '\u{0149}' => No,
+ '\u{017F}' => No,
+ '\u{01C4}'...'\u{01CC}' => No,
+ '\u{01F1}'...'\u{01F3}' => No,
+ '\u{02B0}'...'\u{02B8}' => No,
+ '\u{02D8}'...'\u{02DD}' => No,
+ '\u{02E0}'...'\u{02E4}' => No,
+ '\u{0340}'...'\u{0341}' => No,
+ '\u{0343}'...'\u{0344}' => No,
+ '\u{0374}' => No,
+ '\u{037A}' => No,
+ '\u{037E}' => No,
+ '\u{0384}'...'\u{0385}' => No,
+ '\u{0387}' => No,
+ '\u{03D0}'...'\u{03D6}' => No,
+ '\u{03F0}'...'\u{03F2}' => No,
+ '\u{03F4}'...'\u{03F5}' => No,
+ '\u{03F9}' => No,
+ '\u{0587}' => No,
+ '\u{0675}'...'\u{0678}' => No,
+ '\u{0958}'...'\u{095F}' => No,
+ '\u{09DC}'...'\u{09DD}' => No,
+ '\u{09DF}' => No,
+ '\u{0A33}' => No,
+ '\u{0A36}' => No,
+ '\u{0A59}'...'\u{0A5B}' => No,
+ '\u{0A5E}' => No,
+ '\u{0B5C}'...'\u{0B5D}' => No,
+ '\u{0E33}' => No,
+ '\u{0EB3}' => No,
+ '\u{0EDC}'...'\u{0EDD}' => No,
+ '\u{0F0C}' => No,
+ '\u{0F43}' => No,
+ '\u{0F4D}' => No,
+ '\u{0F52}' => No,
+ '\u{0F57}' => No,
+ '\u{0F5C}' => No,
+ '\u{0F69}' => No,
+ '\u{0F73}' => No,
+ '\u{0F75}'...'\u{0F79}' => No,
+ '\u{0F81}' => No,
+ '\u{0F93}' => No,
+ '\u{0F9D}' => No,
+ '\u{0FA2}' => No,
+ '\u{0FA7}' => No,
+ '\u{0FAC}' => No,
+ '\u{0FB9}' => No,
+ '\u{10FC}' => No,
+ '\u{1D2C}'...'\u{1D2E}' => No,
+ '\u{1D30}'...'\u{1D3A}' => No,
+ '\u{1D3C}'...'\u{1D4D}' => No,
+ '\u{1D4F}'...'\u{1D6A}' => No,
+ '\u{1D78}' => No,
+ '\u{1D9B}'...'\u{1DBF}' => No,
+ '\u{1E9A}'...'\u{1E9B}' => No,
+ '\u{1F71}' => No,
+ '\u{1F73}' => No,
+ '\u{1F75}' => No,
+ '\u{1F77}' => No,
+ '\u{1F79}' => No,
+ '\u{1F7B}' => No,
+ '\u{1F7D}' => No,
+ '\u{1FBB}' => No,
+ '\u{1FBD}' => No,
+ '\u{1FBE}' => No,
+ '\u{1FBF}'...'\u{1FC1}' => No,
+ '\u{1FC9}' => No,
+ '\u{1FCB}' => No,
+ '\u{1FCD}'...'\u{1FCF}' => No,
+ '\u{1FD3}' => No,
+ '\u{1FDB}' => No,
+ '\u{1FDD}'...'\u{1FDF}' => No,
+ '\u{1FE3}' => No,
+ '\u{1FEB}' => No,
+ '\u{1FED}'...'\u{1FEF}' => No,
+ '\u{1FF9}' => No,
+ '\u{1FFB}' => No,
+ '\u{1FFD}'...'\u{1FFE}' => No,
+ '\u{2000}'...'\u{200A}' => No,
+ '\u{2011}' => No,
+ '\u{2017}' => No,
+ '\u{2024}'...'\u{2026}' => No,
+ '\u{202F}' => No,
+ '\u{2033}'...'\u{2034}' => No,
+ '\u{2036}'...'\u{2037}' => No,
+ '\u{203C}' => No,
+ '\u{203E}' => No,
+ '\u{2047}'...'\u{2049}' => No,
+ '\u{2057}' => No,
+ '\u{205F}' => No,
+ '\u{2070}' => No,
+ '\u{2071}' => No,
+ '\u{2074}'...'\u{2079}' => No,
+ '\u{207A}'...'\u{207C}' => No,
+ '\u{207D}' => No,
+ '\u{207E}' => No,
+ '\u{207F}' => No,
+ '\u{2080}'...'\u{2089}' => No,
+ '\u{208A}'...'\u{208C}' => No,
+ '\u{208D}' => No,
+ '\u{208E}' => No,
+ '\u{2090}'...'\u{209C}' => No,
+ '\u{20A8}' => No,
+ '\u{2100}'...'\u{2101}' => No,
+ '\u{2102}' => No,
+ '\u{2103}' => No,
+ '\u{2105}'...'\u{2106}' => No,
+ '\u{2107}' => No,
+ '\u{2109}' => No,
+ '\u{210A}'...'\u{2113}' => No,
+ '\u{2115}' => No,
+ '\u{2116}' => No,
+ '\u{2119}'...'\u{211D}' => No,
+ '\u{2120}'...'\u{2122}' => No,
+ '\u{2124}' => No,
+ '\u{2126}' => No,
+ '\u{2128}' => No,
+ '\u{212A}'...'\u{212D}' => No,
+ '\u{212F}'...'\u{2131}' => No,
+ '\u{2133}'...'\u{2134}' => No,
+ '\u{2135}'...'\u{2138}' => No,
+ '\u{2139}' => No,
+ '\u{213B}' => No,
+ '\u{213C}'...'\u{213F}' => No,
+ '\u{2140}' => No,
+ '\u{2145}'...'\u{2149}' => No,
+ '\u{2150}'...'\u{215F}' => No,
+ '\u{2160}'...'\u{217F}' => No,
+ '\u{2189}' => No,
+ '\u{222C}'...'\u{222D}' => No,
+ '\u{222F}'...'\u{2230}' => No,
+ '\u{2329}' => No,
+ '\u{232A}' => No,
+ '\u{2460}'...'\u{249B}' => No,
+ '\u{249C}'...'\u{24E9}' => No,
+ '\u{24EA}' => No,
+ '\u{2A0C}' => No,
+ '\u{2A74}'...'\u{2A76}' => No,
+ '\u{2ADC}' => No,
+ '\u{2C7C}'...'\u{2C7D}' => No,
+ '\u{2D6F}' => No,
+ '\u{2E9F}' => No,
+ '\u{2EF3}' => No,
+ '\u{2F00}'...'\u{2FD5}' => No,
+ '\u{3000}' => No,
+ '\u{3036}' => No,
+ '\u{3038}'...'\u{303A}' => No,
+ '\u{309B}'...'\u{309C}' => No,
+ '\u{309F}' => No,
+ '\u{30FF}' => No,
+ '\u{3131}'...'\u{318E}' => No,
+ '\u{3192}'...'\u{3195}' => No,
+ '\u{3196}'...'\u{319F}' => No,
+ '\u{3200}'...'\u{321E}' => No,
+ '\u{3220}'...'\u{3229}' => No,
+ '\u{322A}'...'\u{3247}' => No,
+ '\u{3250}' => No,
+ '\u{3251}'...'\u{325F}' => No,
+ '\u{3260}'...'\u{327E}' => No,
+ '\u{3280}'...'\u{3289}' => No,
+ '\u{328A}'...'\u{32B0}' => No,
+ '\u{32B1}'...'\u{32BF}' => No,
+ '\u{32C0}'...'\u{33FF}' => No,
+ '\u{A69C}'...'\u{A69D}' => No,
+ '\u{A770}' => No,
+ '\u{A7F2}'...'\u{A7F4}' => No,
+ '\u{A7F8}'...'\u{A7F9}' => No,
+ '\u{AB5C}'...'\u{AB5F}' => No,
+ '\u{AB69}' => No,
+ '\u{F900}'...'\u{FA0D}' => No,
+ '\u{FA10}' => No,
+ '\u{FA12}' => No,
+ '\u{FA15}'...'\u{FA1E}' => No,
+ '\u{FA20}' => No,
+ '\u{FA22}' => No,
+ '\u{FA25}'...'\u{FA26}' => No,
+ '\u{FA2A}'...'\u{FA6D}' => No,
+ '\u{FA70}'...'\u{FAD9}' => No,
+ '\u{FB00}'...'\u{FB06}' => No,
+ '\u{FB13}'...'\u{FB17}' => No,
+ '\u{FB1D}' => No,
+ '\u{FB1F}'...'\u{FB28}' => No,
+ '\u{FB29}' => No,
+ '\u{FB2A}'...'\u{FB36}' => No,
+ '\u{FB38}'...'\u{FB3C}' => No,
+ '\u{FB3E}' => No,
+ '\u{FB40}'...'\u{FB41}' => No,
+ '\u{FB43}'...'\u{FB44}' => No,
+ '\u{FB46}'...'\u{FBB1}' => No,
+ '\u{FBD3}'...'\u{FD3D}' => No,
+ '\u{FD50}'...'\u{FD8F}' => No,
+ '\u{FD92}'...'\u{FDC7}' => No,
+ '\u{FDF0}'...'\u{FDFB}' => No,
+ '\u{FDFC}' => No,
+ '\u{FE10}'...'\u{FE16}' => No,
+ '\u{FE17}' => No,
+ '\u{FE18}' => No,
+ '\u{FE19}' => No,
+ '\u{FE30}' => No,
+ '\u{FE31}'...'\u{FE32}' => No,
+ '\u{FE33}'...'\u{FE34}' => No,
+ '\u{FE35}' => No,
+ '\u{FE36}' => No,
+ '\u{FE37}' => No,
+ '\u{FE38}' => No,
+ '\u{FE39}' => No,
+ '\u{FE3A}' => No,
+ '\u{FE3B}' => No,
+ '\u{FE3C}' => No,
+ '\u{FE3D}' => No,
+ '\u{FE3E}' => No,
+ '\u{FE3F}' => No,
+ '\u{FE40}' => No,
+ '\u{FE41}' => No,
+ '\u{FE42}' => No,
+ '\u{FE43}' => No,
+ '\u{FE44}' => No,
+ '\u{FE47}' => No,
+ '\u{FE48}' => No,
+ '\u{FE49}'...'\u{FE4C}' => No,
+ '\u{FE4D}'...'\u{FE4F}' => No,
+ '\u{FE50}'...'\u{FE52}' => No,
+ '\u{FE54}'...'\u{FE57}' => No,
+ '\u{FE58}' => No,
+ '\u{FE59}' => No,
+ '\u{FE5A}' => No,
+ '\u{FE5B}' => No,
+ '\u{FE5C}' => No,
+ '\u{FE5D}' => No,
+ '\u{FE5E}' => No,
+ '\u{FE5F}'...'\u{FE61}' => No,
+ '\u{FE62}' => No,
+ '\u{FE63}' => No,
+ '\u{FE64}'...'\u{FE66}' => No,
+ '\u{FE68}' => No,
+ '\u{FE69}' => No,
+ '\u{FE6A}'...'\u{FE6B}' => No,
+ '\u{FE70}'...'\u{FE72}' => No,
+ '\u{FE74}' => No,
+ '\u{FE76}'...'\u{FEFC}' => No,
+ '\u{FF01}'...'\u{FF03}' => No,
+ '\u{FF04}' => No,
+ '\u{FF05}'...'\u{FF07}' => No,
+ '\u{FF08}' => No,
+ '\u{FF09}' => No,
+ '\u{FF0A}' => No,
+ '\u{FF0B}' => No,
+ '\u{FF0C}' => No,
+ '\u{FF0D}' => No,
+ '\u{FF0E}'...'\u{FF0F}' => No,
+ '\u{FF10}'...'\u{FF19}' => No,
+ '\u{FF1A}'...'\u{FF1B}' => No,
+ '\u{FF1C}'...'\u{FF1E}' => No,
+ '\u{FF1F}'...'\u{FF20}' => No,
+ '\u{FF21}'...'\u{FF3A}' => No,
+ '\u{FF3B}' => No,
+ '\u{FF3C}' => No,
+ '\u{FF3D}' => No,
+ '\u{FF3E}' => No,
+ '\u{FF3F}' => No,
+ '\u{FF40}' => No,
+ '\u{FF41}'...'\u{FF5A}' => No,
+ '\u{FF5B}' => No,
+ '\u{FF5C}' => No,
+ '\u{FF5D}' => No,
+ '\u{FF5E}' => No,
+ '\u{FF5F}' => No,
+ '\u{FF60}' => No,
+ '\u{FF61}' => No,
+ '\u{FF62}' => No,
+ '\u{FF63}' => No,
+ '\u{FF64}'...'\u{FF65}' => No,
+ '\u{FF66}'...'\u{FF6F}' => No,
+ '\u{FF70}' => No,
+ '\u{FF71}'...'\u{FF9D}' => No,
+ '\u{FF9E}'...'\u{FF9F}' => No,
+ '\u{FFA0}'...'\u{FFBE}' => No,
+ '\u{FFC2}'...'\u{FFC7}' => No,
+ '\u{FFCA}'...'\u{FFCF}' => No,
+ '\u{FFD2}'...'\u{FFD7}' => No,
+ '\u{FFDA}'...'\u{FFDC}' => No,
+ '\u{FFE0}'...'\u{FFE1}' => No,
+ '\u{FFE2}' => No,
+ '\u{FFE3}' => No,
+ '\u{FFE4}' => No,
+ '\u{FFE5}'...'\u{FFE6}' => No,
+ '\u{FFE8}' => No,
+ '\u{FFE9}'...'\u{FFEC}' => No,
+ '\u{FFED}'...'\u{FFEE}' => No,
+ '\u{10781}'...'\u{10785}' => No,
+ '\u{10787}'...'\u{107B0}' => No,
+ '\u{107B2}'...'\u{107BA}' => No,
+ '\u{1D15E}'...'\u{1D164}' => No,
+ '\u{1D1BB}'...'\u{1D1C0}' => No,
+ '\u{1D400}'...'\u{1D454}' => No,
+ '\u{1D456}'...'\u{1D49C}' => No,
+ '\u{1D49E}'...'\u{1D49F}' => No,
+ '\u{1D4A2}' => No,
+ '\u{1D4A5}'...'\u{1D4A6}' => No,
+ '\u{1D4A9}'...'\u{1D4AC}' => No,
+ '\u{1D4AE}'...'\u{1D4B9}' => No,
+ '\u{1D4BB}' => No,
+ '\u{1D4BD}'...'\u{1D4C3}' => No,
+ '\u{1D4C5}'...'\u{1D505}' => No,
+ '\u{1D507}'...'\u{1D50A}' => No,
+ '\u{1D50D}'...'\u{1D514}' => No,
+ '\u{1D516}'...'\u{1D51C}' => No,
+ '\u{1D51E}'...'\u{1D539}' => No,
+ '\u{1D53B}'...'\u{1D53E}' => No,
+ '\u{1D540}'...'\u{1D544}' => No,
+ '\u{1D546}' => No,
+ '\u{1D54A}'...'\u{1D550}' => No,
+ '\u{1D552}'...'\u{1D6A5}' => No,
+ '\u{1D6A8}'...'\u{1D6C0}' => No,
+ '\u{1D6C1}' => No,
+ '\u{1D6C2}'...'\u{1D6DA}' => No,
+ '\u{1D6DB}' => No,
+ '\u{1D6DC}'...'\u{1D6FA}' => No,
+ '\u{1D6FB}' => No,
+ '\u{1D6FC}'...'\u{1D714}' => No,
+ '\u{1D715}' => No,
+ '\u{1D716}'...'\u{1D734}' => No,
+ '\u{1D735}' => No,
+ '\u{1D736}'...'\u{1D74E}' => No,
+ '\u{1D74F}' => No,
+ '\u{1D750}'...'\u{1D76E}' => No,
+ '\u{1D76F}' => No,
+ '\u{1D770}'...'\u{1D788}' => No,
+ '\u{1D789}' => No,
+ '\u{1D78A}'...'\u{1D7A8}' => No,
+ '\u{1D7A9}' => No,
+ '\u{1D7AA}'...'\u{1D7C2}' => No,
+ '\u{1D7C3}' => No,
+ '\u{1D7C4}'...'\u{1D7CB}' => No,
+ '\u{1D7CE}'...'\u{1D7FF}' => No,
+ '\u{1E030}'...'\u{1E06D}' => No,
+ '\u{1EE00}'...'\u{1EE03}' => No,
+ '\u{1EE05}'...'\u{1EE1F}' => No,
+ '\u{1EE21}'...'\u{1EE22}' => No,
+ '\u{1EE24}' => No,
+ '\u{1EE27}' => No,
+ '\u{1EE29}'...'\u{1EE32}' => No,
+ '\u{1EE34}'...'\u{1EE37}' => No,
+ '\u{1EE39}' => No,
+ '\u{1EE3B}' => No,
+ '\u{1EE42}' => No,
+ '\u{1EE47}' => No,
+ '\u{1EE49}' => No,
+ '\u{1EE4B}' => No,
+ '\u{1EE4D}'...'\u{1EE4F}' => No,
+ '\u{1EE51}'...'\u{1EE52}' => No,
+ '\u{1EE54}' => No,
+ '\u{1EE57}' => No,
+ '\u{1EE59}' => No,
+ '\u{1EE5B}' => No,
+ '\u{1EE5D}' => No,
+ '\u{1EE5F}' => No,
+ '\u{1EE61}'...'\u{1EE62}' => No,
+ '\u{1EE64}' => No,
+ '\u{1EE67}'...'\u{1EE6A}' => No,
+ '\u{1EE6C}'...'\u{1EE72}' => No,
+ '\u{1EE74}'...'\u{1EE77}' => No,
+ '\u{1EE79}'...'\u{1EE7C}' => No,
+ '\u{1EE7E}' => No,
+ '\u{1EE80}'...'\u{1EE89}' => No,
+ '\u{1EE8B}'...'\u{1EE9B}' => No,
+ '\u{1EEA1}'...'\u{1EEA3}' => No,
+ '\u{1EEA5}'...'\u{1EEA9}' => No,
+ '\u{1EEAB}'...'\u{1EEBB}' => No,
+ '\u{1F100}'...'\u{1F10A}' => No,
+ '\u{1F110}'...'\u{1F12E}' => No,
+ '\u{1F130}'...'\u{1F14F}' => No,
+ '\u{1F16A}'...'\u{1F16C}' => No,
+ '\u{1F190}' => No,
+ '\u{1F200}'...'\u{1F202}' => No,
+ '\u{1F210}'...'\u{1F23B}' => No,
+ '\u{1F240}'...'\u{1F248}' => No,
+ '\u{1F250}'...'\u{1F251}' => No,
+ '\u{1FBF0}'...'\u{1FBF9}' => No,
+ '\u{2F800}'...'\u{2FA1D}' => No,
+ '\u{0300}'...'\u{0304}' => Maybe,
+ '\u{0306}'...'\u{030C}' => Maybe,
+ '\u{030F}' => Maybe,
+ '\u{0311}' => Maybe,
+ '\u{0313}'...'\u{0314}' => Maybe,
+ '\u{031B}' => Maybe,
+ '\u{0323}'...'\u{0328}' => Maybe,
+ '\u{032D}'...'\u{032E}' => Maybe,
+ '\u{0330}'...'\u{0331}' => Maybe,
+ '\u{0338}' => Maybe,
+ '\u{0342}' => Maybe,
+ '\u{0345}' => Maybe,
+ '\u{0653}'...'\u{0655}' => Maybe,
+ '\u{093C}' => Maybe,
+ '\u{09BE}' => Maybe,
+ '\u{09D7}' => Maybe,
+ '\u{0B3E}' => Maybe,
+ '\u{0B56}' => Maybe,
+ '\u{0B57}' => Maybe,
+ '\u{0BBE}' => Maybe,
+ '\u{0BD7}' => Maybe,
+ '\u{0C56}' => Maybe,
+ '\u{0CC2}' => Maybe,
+ '\u{0CD5}'...'\u{0CD6}' => Maybe,
+ '\u{0D3E}' => Maybe,
+ '\u{0D57}' => Maybe,
+ '\u{0DCA}' => Maybe,
+ '\u{0DCF}' => Maybe,
+ '\u{0DDF}' => Maybe,
+ '\u{102E}' => Maybe,
+ '\u{1161}'...'\u{1175}' => Maybe,
+ '\u{11A8}'...'\u{11C2}' => Maybe,
+ '\u{1B35}' => Maybe,
+ '\u{3099}'...'\u{309A}' => Maybe,
+ '\u{110BA}' => Maybe,
+ '\u{11127}' => Maybe,
+ '\u{1133E}' => Maybe,
+ '\u{11357}' => Maybe,
+ '\u{114B0}' => Maybe,
+ '\u{114BA}' => Maybe,
+ '\u{114BD}' => Maybe,
+ '\u{115AF}' => Maybe,
+ '\u{11930}' => Maybe,
+ _ => Yes,
+ }
+}
+
+#[inline]
+#[allow(ellipsis_inclusive_range_patterns)]
+pub fn qc_nfd(c: char) -> IsNormalized {
+ match c {
+ '\u{00C0}'...'\u{00C5}' => No,
+ '\u{00C7}'...'\u{00CF}' => No,
+ '\u{00D1}'...'\u{00D6}' => No,
+ '\u{00D9}'...'\u{00DD}' => No,
+ '\u{00E0}'...'\u{00E5}' => No,
+ '\u{00E7}'...'\u{00EF}' => No,
+ '\u{00F1}'...'\u{00F6}' => No,
+ '\u{00F9}'...'\u{00FD}' => No,
+ '\u{00FF}'...'\u{010F}' => No,
+ '\u{0112}'...'\u{0125}' => No,
+ '\u{0128}'...'\u{0130}' => No,
+ '\u{0134}'...'\u{0137}' => No,
+ '\u{0139}'...'\u{013E}' => No,
+ '\u{0143}'...'\u{0148}' => No,
+ '\u{014C}'...'\u{0151}' => No,
+ '\u{0154}'...'\u{0165}' => No,
+ '\u{0168}'...'\u{017E}' => No,
+ '\u{01A0}'...'\u{01A1}' => No,
+ '\u{01AF}'...'\u{01B0}' => No,
+ '\u{01CD}'...'\u{01DC}' => No,
+ '\u{01DE}'...'\u{01E3}' => No,
+ '\u{01E6}'...'\u{01F0}' => No,
+ '\u{01F4}'...'\u{01F5}' => No,
+ '\u{01F8}'...'\u{021B}' => No,
+ '\u{021E}'...'\u{021F}' => No,
+ '\u{0226}'...'\u{0233}' => No,
+ '\u{0340}'...'\u{0341}' => No,
+ '\u{0343}'...'\u{0344}' => No,
+ '\u{0374}' => No,
+ '\u{037E}' => No,
+ '\u{0385}' => No,
+ '\u{0386}' => No,
+ '\u{0387}' => No,
+ '\u{0388}'...'\u{038A}' => No,
+ '\u{038C}' => No,
+ '\u{038E}'...'\u{0390}' => No,
+ '\u{03AA}'...'\u{03B0}' => No,
+ '\u{03CA}'...'\u{03CE}' => No,
+ '\u{03D3}'...'\u{03D4}' => No,
+ '\u{0400}'...'\u{0401}' => No,
+ '\u{0403}' => No,
+ '\u{0407}' => No,
+ '\u{040C}'...'\u{040E}' => No,
+ '\u{0419}' => No,
+ '\u{0439}' => No,
+ '\u{0450}'...'\u{0451}' => No,
+ '\u{0453}' => No,
+ '\u{0457}' => No,
+ '\u{045C}'...'\u{045E}' => No,
+ '\u{0476}'...'\u{0477}' => No,
+ '\u{04C1}'...'\u{04C2}' => No,
+ '\u{04D0}'...'\u{04D3}' => No,
+ '\u{04D6}'...'\u{04D7}' => No,
+ '\u{04DA}'...'\u{04DF}' => No,
+ '\u{04E2}'...'\u{04E7}' => No,
+ '\u{04EA}'...'\u{04F5}' => No,
+ '\u{04F8}'...'\u{04F9}' => No,
+ '\u{0622}'...'\u{0626}' => No,
+ '\u{06C0}' => No,
+ '\u{06C2}' => No,
+ '\u{06D3}' => No,
+ '\u{0929}' => No,
+ '\u{0931}' => No,
+ '\u{0934}' => No,
+ '\u{0958}'...'\u{095F}' => No,
+ '\u{09CB}'...'\u{09CC}' => No,
+ '\u{09DC}'...'\u{09DD}' => No,
+ '\u{09DF}' => No,
+ '\u{0A33}' => No,
+ '\u{0A36}' => No,
+ '\u{0A59}'...'\u{0A5B}' => No,
+ '\u{0A5E}' => No,
+ '\u{0B48}' => No,
+ '\u{0B4B}'...'\u{0B4C}' => No,
+ '\u{0B5C}'...'\u{0B5D}' => No,
+ '\u{0B94}' => No,
+ '\u{0BCA}'...'\u{0BCC}' => No,
+ '\u{0C48}' => No,
+ '\u{0CC0}' => No,
+ '\u{0CC7}'...'\u{0CC8}' => No,
+ '\u{0CCA}'...'\u{0CCB}' => No,
+ '\u{0D4A}'...'\u{0D4C}' => No,
+ '\u{0DDA}' => No,
+ '\u{0DDC}'...'\u{0DDE}' => No,
+ '\u{0F43}' => No,
+ '\u{0F4D}' => No,
+ '\u{0F52}' => No,
+ '\u{0F57}' => No,
+ '\u{0F5C}' => No,
+ '\u{0F69}' => No,
+ '\u{0F73}' => No,
+ '\u{0F75}'...'\u{0F76}' => No,
+ '\u{0F78}' => No,
+ '\u{0F81}' => No,
+ '\u{0F93}' => No,
+ '\u{0F9D}' => No,
+ '\u{0FA2}' => No,
+ '\u{0FA7}' => No,
+ '\u{0FAC}' => No,
+ '\u{0FB9}' => No,
+ '\u{1026}' => No,
+ '\u{1B06}' => No,
+ '\u{1B08}' => No,
+ '\u{1B0A}' => No,
+ '\u{1B0C}' => No,
+ '\u{1B0E}' => No,
+ '\u{1B12}' => No,
+ '\u{1B3B}' => No,
+ '\u{1B3D}' => No,
+ '\u{1B40}'...'\u{1B41}' => No,
+ '\u{1B43}' => No,
+ '\u{1E00}'...'\u{1E99}' => No,
+ '\u{1E9B}' => No,
+ '\u{1EA0}'...'\u{1EF9}' => No,
+ '\u{1F00}'...'\u{1F15}' => No,
+ '\u{1F18}'...'\u{1F1D}' => No,
+ '\u{1F20}'...'\u{1F45}' => No,
+ '\u{1F48}'...'\u{1F4D}' => No,
+ '\u{1F50}'...'\u{1F57}' => No,
+ '\u{1F59}' => No,
+ '\u{1F5B}' => No,
+ '\u{1F5D}' => No,
+ '\u{1F5F}'...'\u{1F7D}' => No,
+ '\u{1F80}'...'\u{1FB4}' => No,
+ '\u{1FB6}'...'\u{1FBC}' => No,
+ '\u{1FBE}' => No,
+ '\u{1FC1}' => No,
+ '\u{1FC2}'...'\u{1FC4}' => No,
+ '\u{1FC6}'...'\u{1FCC}' => No,
+ '\u{1FCD}'...'\u{1FCF}' => No,
+ '\u{1FD0}'...'\u{1FD3}' => No,
+ '\u{1FD6}'...'\u{1FDB}' => No,
+ '\u{1FDD}'...'\u{1FDF}' => No,
+ '\u{1FE0}'...'\u{1FEC}' => No,
+ '\u{1FED}'...'\u{1FEF}' => No,
+ '\u{1FF2}'...'\u{1FF4}' => No,
+ '\u{1FF6}'...'\u{1FFC}' => No,
+ '\u{1FFD}' => No,
+ '\u{2000}'...'\u{2001}' => No,
+ '\u{2126}' => No,
+ '\u{212A}'...'\u{212B}' => No,
+ '\u{219A}'...'\u{219B}' => No,
+ '\u{21AE}' => No,
+ '\u{21CD}' => No,
+ '\u{21CE}'...'\u{21CF}' => No,
+ '\u{2204}' => No,
+ '\u{2209}' => No,
+ '\u{220C}' => No,
+ '\u{2224}' => No,
+ '\u{2226}' => No,
+ '\u{2241}' => No,
+ '\u{2244}' => No,
+ '\u{2247}' => No,
+ '\u{2249}' => No,
+ '\u{2260}' => No,
+ '\u{2262}' => No,
+ '\u{226D}'...'\u{2271}' => No,
+ '\u{2274}'...'\u{2275}' => No,
+ '\u{2278}'...'\u{2279}' => No,
+ '\u{2280}'...'\u{2281}' => No,
+ '\u{2284}'...'\u{2285}' => No,
+ '\u{2288}'...'\u{2289}' => No,
+ '\u{22AC}'...'\u{22AF}' => No,
+ '\u{22E0}'...'\u{22E3}' => No,
+ '\u{22EA}'...'\u{22ED}' => No,
+ '\u{2329}' => No,
+ '\u{232A}' => No,
+ '\u{2ADC}' => No,
+ '\u{304C}' => No,
+ '\u{304E}' => No,
+ '\u{3050}' => No,
+ '\u{3052}' => No,
+ '\u{3054}' => No,
+ '\u{3056}' => No,
+ '\u{3058}' => No,
+ '\u{305A}' => No,
+ '\u{305C}' => No,
+ '\u{305E}' => No,
+ '\u{3060}' => No,
+ '\u{3062}' => No,
+ '\u{3065}' => No,
+ '\u{3067}' => No,
+ '\u{3069}' => No,
+ '\u{3070}'...'\u{3071}' => No,
+ '\u{3073}'...'\u{3074}' => No,
+ '\u{3076}'...'\u{3077}' => No,
+ '\u{3079}'...'\u{307A}' => No,
+ '\u{307C}'...'\u{307D}' => No,
+ '\u{3094}' => No,
+ '\u{309E}' => No,
+ '\u{30AC}' => No,
+ '\u{30AE}' => No,
+ '\u{30B0}' => No,
+ '\u{30B2}' => No,
+ '\u{30B4}' => No,
+ '\u{30B6}' => No,
+ '\u{30B8}' => No,
+ '\u{30BA}' => No,
+ '\u{30BC}' => No,
+ '\u{30BE}' => No,
+ '\u{30C0}' => No,
+ '\u{30C2}' => No,
+ '\u{30C5}' => No,
+ '\u{30C7}' => No,
+ '\u{30C9}' => No,
+ '\u{30D0}'...'\u{30D1}' => No,
+ '\u{30D3}'...'\u{30D4}' => No,
+ '\u{30D6}'...'\u{30D7}' => No,
+ '\u{30D9}'...'\u{30DA}' => No,
+ '\u{30DC}'...'\u{30DD}' => No,
+ '\u{30F4}' => No,
+ '\u{30F7}'...'\u{30FA}' => No,
+ '\u{30FE}' => No,
+ '\u{AC00}'...'\u{D7A3}' => No,
+ '\u{F900}'...'\u{FA0D}' => No,
+ '\u{FA10}' => No,
+ '\u{FA12}' => No,
+ '\u{FA15}'...'\u{FA1E}' => No,
+ '\u{FA20}' => No,
+ '\u{FA22}' => No,
+ '\u{FA25}'...'\u{FA26}' => No,
+ '\u{FA2A}'...'\u{FA6D}' => No,
+ '\u{FA70}'...'\u{FAD9}' => No,
+ '\u{FB1D}' => No,
+ '\u{FB1F}' => No,
+ '\u{FB2A}'...'\u{FB36}' => No,
+ '\u{FB38}'...'\u{FB3C}' => No,
+ '\u{FB3E}' => No,
+ '\u{FB40}'...'\u{FB41}' => No,
+ '\u{FB43}'...'\u{FB44}' => No,
+ '\u{FB46}'...'\u{FB4E}' => No,
+ '\u{1109A}' => No,
+ '\u{1109C}' => No,
+ '\u{110AB}' => No,
+ '\u{1112E}'...'\u{1112F}' => No,
+ '\u{1134B}'...'\u{1134C}' => No,
+ '\u{114BB}'...'\u{114BC}' => No,
+ '\u{114BE}' => No,
+ '\u{115BA}'...'\u{115BB}' => No,
+ '\u{11938}' => No,
+ '\u{1D15E}'...'\u{1D164}' => No,
+ '\u{1D1BB}'...'\u{1D1C0}' => No,
+ '\u{2F800}'...'\u{2FA1D}' => No,
+ _ => Yes,
+ }
+}
+
+#[inline]
+#[allow(ellipsis_inclusive_range_patterns)]
+pub fn qc_nfkd(c: char) -> IsNormalized {
+ match c {
+ '\u{00A0}' => No,
+ '\u{00A8}' => No,
+ '\u{00AA}' => No,
+ '\u{00AF}' => No,
+ '\u{00B2}'...'\u{00B3}' => No,
+ '\u{00B4}' => No,
+ '\u{00B5}' => No,
+ '\u{00B8}' => No,
+ '\u{00B9}' => No,
+ '\u{00BA}' => No,
+ '\u{00BC}'...'\u{00BE}' => No,
+ '\u{00C0}'...'\u{00C5}' => No,
+ '\u{00C7}'...'\u{00CF}' => No,
+ '\u{00D1}'...'\u{00D6}' => No,
+ '\u{00D9}'...'\u{00DD}' => No,
+ '\u{00E0}'...'\u{00E5}' => No,
+ '\u{00E7}'...'\u{00EF}' => No,
+ '\u{00F1}'...'\u{00F6}' => No,
+ '\u{00F9}'...'\u{00FD}' => No,
+ '\u{00FF}'...'\u{010F}' => No,
+ '\u{0112}'...'\u{0125}' => No,
+ '\u{0128}'...'\u{0130}' => No,
+ '\u{0132}'...'\u{0137}' => No,
+ '\u{0139}'...'\u{0140}' => No,
+ '\u{0143}'...'\u{0149}' => No,
+ '\u{014C}'...'\u{0151}' => No,
+ '\u{0154}'...'\u{0165}' => No,
+ '\u{0168}'...'\u{017F}' => No,
+ '\u{01A0}'...'\u{01A1}' => No,
+ '\u{01AF}'...'\u{01B0}' => No,
+ '\u{01C4}'...'\u{01DC}' => No,
+ '\u{01DE}'...'\u{01E3}' => No,
+ '\u{01E6}'...'\u{01F5}' => No,
+ '\u{01F8}'...'\u{021B}' => No,
+ '\u{021E}'...'\u{021F}' => No,
+ '\u{0226}'...'\u{0233}' => No,
+ '\u{02B0}'...'\u{02B8}' => No,
+ '\u{02D8}'...'\u{02DD}' => No,
+ '\u{02E0}'...'\u{02E4}' => No,
+ '\u{0340}'...'\u{0341}' => No,
+ '\u{0343}'...'\u{0344}' => No,
+ '\u{0374}' => No,
+ '\u{037A}' => No,
+ '\u{037E}' => No,
+ '\u{0384}'...'\u{0385}' => No,
+ '\u{0386}' => No,
+ '\u{0387}' => No,
+ '\u{0388}'...'\u{038A}' => No,
+ '\u{038C}' => No,
+ '\u{038E}'...'\u{0390}' => No,
+ '\u{03AA}'...'\u{03B0}' => No,
+ '\u{03CA}'...'\u{03CE}' => No,
+ '\u{03D0}'...'\u{03D6}' => No,
+ '\u{03F0}'...'\u{03F2}' => No,
+ '\u{03F4}'...'\u{03F5}' => No,
+ '\u{03F9}' => No,
+ '\u{0400}'...'\u{0401}' => No,
+ '\u{0403}' => No,
+ '\u{0407}' => No,
+ '\u{040C}'...'\u{040E}' => No,
+ '\u{0419}' => No,
+ '\u{0439}' => No,
+ '\u{0450}'...'\u{0451}' => No,
+ '\u{0453}' => No,
+ '\u{0457}' => No,
+ '\u{045C}'...'\u{045E}' => No,
+ '\u{0476}'...'\u{0477}' => No,
+ '\u{04C1}'...'\u{04C2}' => No,
+ '\u{04D0}'...'\u{04D3}' => No,
+ '\u{04D6}'...'\u{04D7}' => No,
+ '\u{04DA}'...'\u{04DF}' => No,
+ '\u{04E2}'...'\u{04E7}' => No,
+ '\u{04EA}'...'\u{04F5}' => No,
+ '\u{04F8}'...'\u{04F9}' => No,
+ '\u{0587}' => No,
+ '\u{0622}'...'\u{0626}' => No,
+ '\u{0675}'...'\u{0678}' => No,
+ '\u{06C0}' => No,
+ '\u{06C2}' => No,
+ '\u{06D3}' => No,
+ '\u{0929}' => No,
+ '\u{0931}' => No,
+ '\u{0934}' => No,
+ '\u{0958}'...'\u{095F}' => No,
+ '\u{09CB}'...'\u{09CC}' => No,
+ '\u{09DC}'...'\u{09DD}' => No,
+ '\u{09DF}' => No,
+ '\u{0A33}' => No,
+ '\u{0A36}' => No,
+ '\u{0A59}'...'\u{0A5B}' => No,
+ '\u{0A5E}' => No,
+ '\u{0B48}' => No,
+ '\u{0B4B}'...'\u{0B4C}' => No,
+ '\u{0B5C}'...'\u{0B5D}' => No,
+ '\u{0B94}' => No,
+ '\u{0BCA}'...'\u{0BCC}' => No,
+ '\u{0C48}' => No,
+ '\u{0CC0}' => No,
+ '\u{0CC7}'...'\u{0CC8}' => No,
+ '\u{0CCA}'...'\u{0CCB}' => No,
+ '\u{0D4A}'...'\u{0D4C}' => No,
+ '\u{0DDA}' => No,
+ '\u{0DDC}'...'\u{0DDE}' => No,
+ '\u{0E33}' => No,
+ '\u{0EB3}' => No,
+ '\u{0EDC}'...'\u{0EDD}' => No,
+ '\u{0F0C}' => No,
+ '\u{0F43}' => No,
+ '\u{0F4D}' => No,
+ '\u{0F52}' => No,
+ '\u{0F57}' => No,
+ '\u{0F5C}' => No,
+ '\u{0F69}' => No,
+ '\u{0F73}' => No,
+ '\u{0F75}'...'\u{0F79}' => No,
+ '\u{0F81}' => No,
+ '\u{0F93}' => No,
+ '\u{0F9D}' => No,
+ '\u{0FA2}' => No,
+ '\u{0FA7}' => No,
+ '\u{0FAC}' => No,
+ '\u{0FB9}' => No,
+ '\u{1026}' => No,
+ '\u{10FC}' => No,
+ '\u{1B06}' => No,
+ '\u{1B08}' => No,
+ '\u{1B0A}' => No,
+ '\u{1B0C}' => No,
+ '\u{1B0E}' => No,
+ '\u{1B12}' => No,
+ '\u{1B3B}' => No,
+ '\u{1B3D}' => No,
+ '\u{1B40}'...'\u{1B41}' => No,
+ '\u{1B43}' => No,
+ '\u{1D2C}'...'\u{1D2E}' => No,
+ '\u{1D30}'...'\u{1D3A}' => No,
+ '\u{1D3C}'...'\u{1D4D}' => No,
+ '\u{1D4F}'...'\u{1D6A}' => No,
+ '\u{1D78}' => No,
+ '\u{1D9B}'...'\u{1DBF}' => No,
+ '\u{1E00}'...'\u{1E9B}' => No,
+ '\u{1EA0}'...'\u{1EF9}' => No,
+ '\u{1F00}'...'\u{1F15}' => No,
+ '\u{1F18}'...'\u{1F1D}' => No,
+ '\u{1F20}'...'\u{1F45}' => No,
+ '\u{1F48}'...'\u{1F4D}' => No,
+ '\u{1F50}'...'\u{1F57}' => No,
+ '\u{1F59}' => No,
+ '\u{1F5B}' => No,
+ '\u{1F5D}' => No,
+ '\u{1F5F}'...'\u{1F7D}' => No,
+ '\u{1F80}'...'\u{1FB4}' => No,
+ '\u{1FB6}'...'\u{1FBC}' => No,
+ '\u{1FBD}' => No,
+ '\u{1FBE}' => No,
+ '\u{1FBF}'...'\u{1FC1}' => No,
+ '\u{1FC2}'...'\u{1FC4}' => No,
+ '\u{1FC6}'...'\u{1FCC}' => No,
+ '\u{1FCD}'...'\u{1FCF}' => No,
+ '\u{1FD0}'...'\u{1FD3}' => No,
+ '\u{1FD6}'...'\u{1FDB}' => No,
+ '\u{1FDD}'...'\u{1FDF}' => No,
+ '\u{1FE0}'...'\u{1FEC}' => No,
+ '\u{1FED}'...'\u{1FEF}' => No,
+ '\u{1FF2}'...'\u{1FF4}' => No,
+ '\u{1FF6}'...'\u{1FFC}' => No,
+ '\u{1FFD}'...'\u{1FFE}' => No,
+ '\u{2000}'...'\u{200A}' => No,
+ '\u{2011}' => No,
+ '\u{2017}' => No,
+ '\u{2024}'...'\u{2026}' => No,
+ '\u{202F}' => No,
+ '\u{2033}'...'\u{2034}' => No,
+ '\u{2036}'...'\u{2037}' => No,
+ '\u{203C}' => No,
+ '\u{203E}' => No,
+ '\u{2047}'...'\u{2049}' => No,
+ '\u{2057}' => No,
+ '\u{205F}' => No,
+ '\u{2070}' => No,
+ '\u{2071}' => No,
+ '\u{2074}'...'\u{2079}' => No,
+ '\u{207A}'...'\u{207C}' => No,
+ '\u{207D}' => No,
+ '\u{207E}' => No,
+ '\u{207F}' => No,
+ '\u{2080}'...'\u{2089}' => No,
+ '\u{208A}'...'\u{208C}' => No,
+ '\u{208D}' => No,
+ '\u{208E}' => No,
+ '\u{2090}'...'\u{209C}' => No,
+ '\u{20A8}' => No,
+ '\u{2100}'...'\u{2101}' => No,
+ '\u{2102}' => No,
+ '\u{2103}' => No,
+ '\u{2105}'...'\u{2106}' => No,
+ '\u{2107}' => No,
+ '\u{2109}' => No,
+ '\u{210A}'...'\u{2113}' => No,
+ '\u{2115}' => No,
+ '\u{2116}' => No,
+ '\u{2119}'...'\u{211D}' => No,
+ '\u{2120}'...'\u{2122}' => No,
+ '\u{2124}' => No,
+ '\u{2126}' => No,
+ '\u{2128}' => No,
+ '\u{212A}'...'\u{212D}' => No,
+ '\u{212F}'...'\u{2131}' => No,
+ '\u{2133}'...'\u{2134}' => No,
+ '\u{2135}'...'\u{2138}' => No,
+ '\u{2139}' => No,
+ '\u{213B}' => No,
+ '\u{213C}'...'\u{213F}' => No,
+ '\u{2140}' => No,
+ '\u{2145}'...'\u{2149}' => No,
+ '\u{2150}'...'\u{215F}' => No,
+ '\u{2160}'...'\u{217F}' => No,
+ '\u{2189}' => No,
+ '\u{219A}'...'\u{219B}' => No,
+ '\u{21AE}' => No,
+ '\u{21CD}' => No,
+ '\u{21CE}'...'\u{21CF}' => No,
+ '\u{2204}' => No,
+ '\u{2209}' => No,
+ '\u{220C}' => No,
+ '\u{2224}' => No,
+ '\u{2226}' => No,
+ '\u{222C}'...'\u{222D}' => No,
+ '\u{222F}'...'\u{2230}' => No,
+ '\u{2241}' => No,
+ '\u{2244}' => No,
+ '\u{2247}' => No,
+ '\u{2249}' => No,
+ '\u{2260}' => No,
+ '\u{2262}' => No,
+ '\u{226D}'...'\u{2271}' => No,
+ '\u{2274}'...'\u{2275}' => No,
+ '\u{2278}'...'\u{2279}' => No,
+ '\u{2280}'...'\u{2281}' => No,
+ '\u{2284}'...'\u{2285}' => No,
+ '\u{2288}'...'\u{2289}' => No,
+ '\u{22AC}'...'\u{22AF}' => No,
+ '\u{22E0}'...'\u{22E3}' => No,
+ '\u{22EA}'...'\u{22ED}' => No,
+ '\u{2329}' => No,
+ '\u{232A}' => No,
+ '\u{2460}'...'\u{249B}' => No,
+ '\u{249C}'...'\u{24E9}' => No,
+ '\u{24EA}' => No,
+ '\u{2A0C}' => No,
+ '\u{2A74}'...'\u{2A76}' => No,
+ '\u{2ADC}' => No,
+ '\u{2C7C}'...'\u{2C7D}' => No,
+ '\u{2D6F}' => No,
+ '\u{2E9F}' => No,
+ '\u{2EF3}' => No,
+ '\u{2F00}'...'\u{2FD5}' => No,
+ '\u{3000}' => No,
+ '\u{3036}' => No,
+ '\u{3038}'...'\u{303A}' => No,
+ '\u{304C}' => No,
+ '\u{304E}' => No,
+ '\u{3050}' => No,
+ '\u{3052}' => No,
+ '\u{3054}' => No,
+ '\u{3056}' => No,
+ '\u{3058}' => No,
+ '\u{305A}' => No,
+ '\u{305C}' => No,
+ '\u{305E}' => No,
+ '\u{3060}' => No,
+ '\u{3062}' => No,
+ '\u{3065}' => No,
+ '\u{3067}' => No,
+ '\u{3069}' => No,
+ '\u{3070}'...'\u{3071}' => No,
+ '\u{3073}'...'\u{3074}' => No,
+ '\u{3076}'...'\u{3077}' => No,
+ '\u{3079}'...'\u{307A}' => No,
+ '\u{307C}'...'\u{307D}' => No,
+ '\u{3094}' => No,
+ '\u{309B}'...'\u{309C}' => No,
+ '\u{309E}' => No,
+ '\u{309F}' => No,
+ '\u{30AC}' => No,
+ '\u{30AE}' => No,
+ '\u{30B0}' => No,
+ '\u{30B2}' => No,
+ '\u{30B4}' => No,
+ '\u{30B6}' => No,
+ '\u{30B8}' => No,
+ '\u{30BA}' => No,
+ '\u{30BC}' => No,
+ '\u{30BE}' => No,
+ '\u{30C0}' => No,
+ '\u{30C2}' => No,
+ '\u{30C5}' => No,
+ '\u{30C7}' => No,
+ '\u{30C9}' => No,
+ '\u{30D0}'...'\u{30D1}' => No,
+ '\u{30D3}'...'\u{30D4}' => No,
+ '\u{30D6}'...'\u{30D7}' => No,
+ '\u{30D9}'...'\u{30DA}' => No,
+ '\u{30DC}'...'\u{30DD}' => No,
+ '\u{30F4}' => No,
+ '\u{30F7}'...'\u{30FA}' => No,
+ '\u{30FE}' => No,
+ '\u{30FF}' => No,
+ '\u{3131}'...'\u{318E}' => No,
+ '\u{3192}'...'\u{3195}' => No,
+ '\u{3196}'...'\u{319F}' => No,
+ '\u{3200}'...'\u{321E}' => No,
+ '\u{3220}'...'\u{3229}' => No,
+ '\u{322A}'...'\u{3247}' => No,
+ '\u{3250}' => No,
+ '\u{3251}'...'\u{325F}' => No,
+ '\u{3260}'...'\u{327E}' => No,
+ '\u{3280}'...'\u{3289}' => No,
+ '\u{328A}'...'\u{32B0}' => No,
+ '\u{32B1}'...'\u{32BF}' => No,
+ '\u{32C0}'...'\u{33FF}' => No,
+ '\u{A69C}'...'\u{A69D}' => No,
+ '\u{A770}' => No,
+ '\u{A7F2}'...'\u{A7F4}' => No,
+ '\u{A7F8}'...'\u{A7F9}' => No,
+ '\u{AB5C}'...'\u{AB5F}' => No,
+ '\u{AB69}' => No,
+ '\u{AC00}'...'\u{D7A3}' => No,
+ '\u{F900}'...'\u{FA0D}' => No,
+ '\u{FA10}' => No,
+ '\u{FA12}' => No,
+ '\u{FA15}'...'\u{FA1E}' => No,
+ '\u{FA20}' => No,
+ '\u{FA22}' => No,
+ '\u{FA25}'...'\u{FA26}' => No,
+ '\u{FA2A}'...'\u{FA6D}' => No,
+ '\u{FA70}'...'\u{FAD9}' => No,
+ '\u{FB00}'...'\u{FB06}' => No,
+ '\u{FB13}'...'\u{FB17}' => No,
+ '\u{FB1D}' => No,
+ '\u{FB1F}'...'\u{FB28}' => No,
+ '\u{FB29}' => No,
+ '\u{FB2A}'...'\u{FB36}' => No,
+ '\u{FB38}'...'\u{FB3C}' => No,
+ '\u{FB3E}' => No,
+ '\u{FB40}'...'\u{FB41}' => No,
+ '\u{FB43}'...'\u{FB44}' => No,
+ '\u{FB46}'...'\u{FBB1}' => No,
+ '\u{FBD3}'...'\u{FD3D}' => No,
+ '\u{FD50}'...'\u{FD8F}' => No,
+ '\u{FD92}'...'\u{FDC7}' => No,
+ '\u{FDF0}'...'\u{FDFB}' => No,
+ '\u{FDFC}' => No,
+ '\u{FE10}'...'\u{FE16}' => No,
+ '\u{FE17}' => No,
+ '\u{FE18}' => No,
+ '\u{FE19}' => No,
+ '\u{FE30}' => No,
+ '\u{FE31}'...'\u{FE32}' => No,
+ '\u{FE33}'...'\u{FE34}' => No,
+ '\u{FE35}' => No,
+ '\u{FE36}' => No,
+ '\u{FE37}' => No,
+ '\u{FE38}' => No,
+ '\u{FE39}' => No,
+ '\u{FE3A}' => No,
+ '\u{FE3B}' => No,
+ '\u{FE3C}' => No,
+ '\u{FE3D}' => No,
+ '\u{FE3E}' => No,
+ '\u{FE3F}' => No,
+ '\u{FE40}' => No,
+ '\u{FE41}' => No,
+ '\u{FE42}' => No,
+ '\u{FE43}' => No,
+ '\u{FE44}' => No,
+ '\u{FE47}' => No,
+ '\u{FE48}' => No,
+ '\u{FE49}'...'\u{FE4C}' => No,
+ '\u{FE4D}'...'\u{FE4F}' => No,
+ '\u{FE50}'...'\u{FE52}' => No,
+ '\u{FE54}'...'\u{FE57}' => No,
+ '\u{FE58}' => No,
+ '\u{FE59}' => No,
+ '\u{FE5A}' => No,
+ '\u{FE5B}' => No,
+ '\u{FE5C}' => No,
+ '\u{FE5D}' => No,
+ '\u{FE5E}' => No,
+ '\u{FE5F}'...'\u{FE61}' => No,
+ '\u{FE62}' => No,
+ '\u{FE63}' => No,
+ '\u{FE64}'...'\u{FE66}' => No,
+ '\u{FE68}' => No,
+ '\u{FE69}' => No,
+ '\u{FE6A}'...'\u{FE6B}' => No,
+ '\u{FE70}'...'\u{FE72}' => No,
+ '\u{FE74}' => No,
+ '\u{FE76}'...'\u{FEFC}' => No,
+ '\u{FF01}'...'\u{FF03}' => No,
+ '\u{FF04}' => No,
+ '\u{FF05}'...'\u{FF07}' => No,
+ '\u{FF08}' => No,
+ '\u{FF09}' => No,
+ '\u{FF0A}' => No,
+ '\u{FF0B}' => No,
+ '\u{FF0C}' => No,
+ '\u{FF0D}' => No,
+ '\u{FF0E}'...'\u{FF0F}' => No,
+ '\u{FF10}'...'\u{FF19}' => No,
+ '\u{FF1A}'...'\u{FF1B}' => No,
+ '\u{FF1C}'...'\u{FF1E}' => No,
+ '\u{FF1F}'...'\u{FF20}' => No,
+ '\u{FF21}'...'\u{FF3A}' => No,
+ '\u{FF3B}' => No,
+ '\u{FF3C}' => No,
+ '\u{FF3D}' => No,
+ '\u{FF3E}' => No,
+ '\u{FF3F}' => No,
+ '\u{FF40}' => No,
+ '\u{FF41}'...'\u{FF5A}' => No,
+ '\u{FF5B}' => No,
+ '\u{FF5C}' => No,
+ '\u{FF5D}' => No,
+ '\u{FF5E}' => No,
+ '\u{FF5F}' => No,
+ '\u{FF60}' => No,
+ '\u{FF61}' => No,
+ '\u{FF62}' => No,
+ '\u{FF63}' => No,
+ '\u{FF64}'...'\u{FF65}' => No,
+ '\u{FF66}'...'\u{FF6F}' => No,
+ '\u{FF70}' => No,
+ '\u{FF71}'...'\u{FF9D}' => No,
+ '\u{FF9E}'...'\u{FF9F}' => No,
+ '\u{FFA0}'...'\u{FFBE}' => No,
+ '\u{FFC2}'...'\u{FFC7}' => No,
+ '\u{FFCA}'...'\u{FFCF}' => No,
+ '\u{FFD2}'...'\u{FFD7}' => No,
+ '\u{FFDA}'...'\u{FFDC}' => No,
+ '\u{FFE0}'...'\u{FFE1}' => No,
+ '\u{FFE2}' => No,
+ '\u{FFE3}' => No,
+ '\u{FFE4}' => No,
+ '\u{FFE5}'...'\u{FFE6}' => No,
+ '\u{FFE8}' => No,
+ '\u{FFE9}'...'\u{FFEC}' => No,
+ '\u{FFED}'...'\u{FFEE}' => No,
+ '\u{10781}'...'\u{10785}' => No,
+ '\u{10787}'...'\u{107B0}' => No,
+ '\u{107B2}'...'\u{107BA}' => No,
+ '\u{1109A}' => No,
+ '\u{1109C}' => No,
+ '\u{110AB}' => No,
+ '\u{1112E}'...'\u{1112F}' => No,
+ '\u{1134B}'...'\u{1134C}' => No,
+ '\u{114BB}'...'\u{114BC}' => No,
+ '\u{114BE}' => No,
+ '\u{115BA}'...'\u{115BB}' => No,
+ '\u{11938}' => No,
+ '\u{1D15E}'...'\u{1D164}' => No,
+ '\u{1D1BB}'...'\u{1D1C0}' => No,
+ '\u{1D400}'...'\u{1D454}' => No,
+ '\u{1D456}'...'\u{1D49C}' => No,
+ '\u{1D49E}'...'\u{1D49F}' => No,
+ '\u{1D4A2}' => No,
+ '\u{1D4A5}'...'\u{1D4A6}' => No,
+ '\u{1D4A9}'...'\u{1D4AC}' => No,
+ '\u{1D4AE}'...'\u{1D4B9}' => No,
+ '\u{1D4BB}' => No,
+ '\u{1D4BD}'...'\u{1D4C3}' => No,
+ '\u{1D4C5}'...'\u{1D505}' => No,
+ '\u{1D507}'...'\u{1D50A}' => No,
+ '\u{1D50D}'...'\u{1D514}' => No,
+ '\u{1D516}'...'\u{1D51C}' => No,
+ '\u{1D51E}'...'\u{1D539}' => No,
+ '\u{1D53B}'...'\u{1D53E}' => No,
+ '\u{1D540}'...'\u{1D544}' => No,
+ '\u{1D546}' => No,
+ '\u{1D54A}'...'\u{1D550}' => No,
+ '\u{1D552}'...'\u{1D6A5}' => No,
+ '\u{1D6A8}'...'\u{1D6C0}' => No,
+ '\u{1D6C1}' => No,
+ '\u{1D6C2}'...'\u{1D6DA}' => No,
+ '\u{1D6DB}' => No,
+ '\u{1D6DC}'...'\u{1D6FA}' => No,
+ '\u{1D6FB}' => No,
+ '\u{1D6FC}'...'\u{1D714}' => No,
+ '\u{1D715}' => No,
+ '\u{1D716}'...'\u{1D734}' => No,
+ '\u{1D735}' => No,
+ '\u{1D736}'...'\u{1D74E}' => No,
+ '\u{1D74F}' => No,
+ '\u{1D750}'...'\u{1D76E}' => No,
+ '\u{1D76F}' => No,
+ '\u{1D770}'...'\u{1D788}' => No,
+ '\u{1D789}' => No,
+ '\u{1D78A}'...'\u{1D7A8}' => No,
+ '\u{1D7A9}' => No,
+ '\u{1D7AA}'...'\u{1D7C2}' => No,
+ '\u{1D7C3}' => No,
+ '\u{1D7C4}'...'\u{1D7CB}' => No,
+ '\u{1D7CE}'...'\u{1D7FF}' => No,
+ '\u{1E030}'...'\u{1E06D}' => No,
+ '\u{1EE00}'...'\u{1EE03}' => No,
+ '\u{1EE05}'...'\u{1EE1F}' => No,
+ '\u{1EE21}'...'\u{1EE22}' => No,
+ '\u{1EE24}' => No,
+ '\u{1EE27}' => No,
+ '\u{1EE29}'...'\u{1EE32}' => No,
+ '\u{1EE34}'...'\u{1EE37}' => No,
+ '\u{1EE39}' => No,
+ '\u{1EE3B}' => No,
+ '\u{1EE42}' => No,
+ '\u{1EE47}' => No,
+ '\u{1EE49}' => No,
+ '\u{1EE4B}' => No,
+ '\u{1EE4D}'...'\u{1EE4F}' => No,
+ '\u{1EE51}'...'\u{1EE52}' => No,
+ '\u{1EE54}' => No,
+ '\u{1EE57}' => No,
+ '\u{1EE59}' => No,
+ '\u{1EE5B}' => No,
+ '\u{1EE5D}' => No,
+ '\u{1EE5F}' => No,
+ '\u{1EE61}'...'\u{1EE62}' => No,
+ '\u{1EE64}' => No,
+ '\u{1EE67}'...'\u{1EE6A}' => No,
+ '\u{1EE6C}'...'\u{1EE72}' => No,
+ '\u{1EE74}'...'\u{1EE77}' => No,
+ '\u{1EE79}'...'\u{1EE7C}' => No,
+ '\u{1EE7E}' => No,
+ '\u{1EE80}'...'\u{1EE89}' => No,
+ '\u{1EE8B}'...'\u{1EE9B}' => No,
+ '\u{1EEA1}'...'\u{1EEA3}' => No,
+ '\u{1EEA5}'...'\u{1EEA9}' => No,
+ '\u{1EEAB}'...'\u{1EEBB}' => No,
+ '\u{1F100}'...'\u{1F10A}' => No,
+ '\u{1F110}'...'\u{1F12E}' => No,
+ '\u{1F130}'...'\u{1F14F}' => No,
+ '\u{1F16A}'...'\u{1F16C}' => No,
+ '\u{1F190}' => No,
+ '\u{1F200}'...'\u{1F202}' => No,
+ '\u{1F210}'...'\u{1F23B}' => No,
+ '\u{1F240}'...'\u{1F248}' => No,
+ '\u{1F250}'...'\u{1F251}' => No,
+ '\u{1FBF0}'...'\u{1FBF9}' => No,
+ '\u{2F800}'...'\u{2FA1D}' => No,
+ _ => Yes,
+ }
+}
+
+#[inline]
+pub fn stream_safe_leading_nonstarters(c: char) -> usize {
+ match c {
+ '\u{0340}' => 1,
+ '\u{0341}' => 1,
+ '\u{0343}' => 1,
+ '\u{0344}' => 2,
+ '\u{0F73}' => 2,
+ '\u{0F75}' => 2,
+ '\u{0F81}' => 2,
+ '\u{FF9E}' => 1,
+ '\u{FF9F}' => 1,
+ _ => 0,
+ }
+}
+
+pub(crate) const TRAILING_NONSTARTERS_SALT: &[u16] = &[
+ 0x1bb,
+ 0x0,
+ 0x8,
+ 0x162,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x75,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x18,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x90,
+ 0x0,
+ 0x2,
+ 0x5f,
+ 0xc6,
+ 0x0,
+ 0x0,
+ 0x20,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x39,
+ 0x0,
+ 0x0,
+ 0x48,
+ 0x3,
+ 0x0,
+ 0x95,
+ 0xaf,
+ 0x30,
+ 0x6f,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x8,
+ 0x10b,
+ 0x13,
+ 0x0,
+ 0x2f,
+ 0x16,
+ 0x6d,
+ 0x1,
+ 0x3,
+ 0xe,
+ 0x0,
+ 0x2c,
+ 0x83,
+ 0x37,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x2,
+ 0x46,
+ 0xa,
+ 0xb,
+ 0x16,
+ 0x4c,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xe,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0xf,
+ 0x26,
+ 0x2,
+ 0xb,
+ 0xb,
+ 0x3,
+ 0x6,
+ 0x1a,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x5,
+ 0x5c,
+ 0x6,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x59,
+ 0x9,
+ 0x20,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x1a,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x23,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x29,
+ 0x1a,
+ 0x20,
+ 0x6,
+ 0x15,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x13,
+ 0x14,
+ 0x3,
+ 0x1,
+ 0x14,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x8,
+ 0x3,
+ 0x2,
+ 0x1c,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x17,
+ 0x0,
+ 0x0,
+ 0x1b,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x3a,
+ 0x0,
+ 0x23,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x2d,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x14,
+ 0x0,
+ 0x0,
+ 0x16,
+ 0x2,
+ 0x3,
+ 0x9,
+ 0x0,
+ 0x56,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x4,
+ 0xd,
+ 0x0,
+ 0x2,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x23,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x13,
+ 0x10,
+ 0xd,
+ 0x5c,
+ 0x0,
+ 0x9,
+ 0xe,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0xd,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x13,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0xc,
+ 0xb,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0xf,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x4,
+ 0x3,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x11,
+ 0x11,
+ 0xc,
+ 0x5,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x2,
+ 0xc,
+ 0x0,
+ 0x0,
+ 0x11,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x12,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xc,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x2,
+ 0x2,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x13,
+ 0x7,
+ 0xc,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x3a,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x4,
+ 0x12,
+ 0x0,
+ 0x7,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x12,
+ 0x2,
+ 0x1,
+ 0x6,
+ 0x1a,
+ 0x4,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x9,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x5,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0xa,
+ 0x0,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0xa,
+ 0x5,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0x1c,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x1a,
+ 0x9,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x4,
+ 0xe,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0x8,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0xf,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x10,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x5,
+ 0x1,
+ 0x6,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0xa,
+ 0x1,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2b,
+ 0x8,
+ 0x1,
+ 0x0,
+ 0xe,
+ 0xa,
+ 0x0,
+ 0xb,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0xb,
+ 0x6,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x6,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1e,
+ 0x5,
+ 0xa,
+ 0x5,
+ 0x7,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xa,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x4,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x5,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x6,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x9,
+ 0x1,
+ 0xb,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0xa,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x8,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0xc,
+ 0x2,
+ 0x2,
+ 0x8,
+ 0xd,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0xb,
+ 0x3,
+ 0x8,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x7,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0xd,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x4,
+ 0x8,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x9,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x7,
+ 0x6,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x7,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x5,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x5,
+ 0xa,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x4,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x9,
+ 0x3,
+ 0x0,
+ 0x4,
+ 0x1,
+ 0x1,
+ 0xc,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0xa,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x8,
+ 0x2,
+ 0x5,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x6,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x4,
+ 0x0,
+ 0x7,
+ 0x3,
+ 0x0,
+ 0xb,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x6,
+ 0x6,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x12,
+ 0x0,
+ 0x9,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x7,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x3,
+ 0x2,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x6,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x7,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x3,
+ 0x3,
+ 0x4,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x8,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x1,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x3,
+ 0x0,
+ 0xe,
+ 0x4,
+ 0x5,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x7,
+ 0x1,
+ 0x7,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x2,
+ 0x3,
+ 0x3,
+ 0x5,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x6,
+ 0x3,
+ 0x6,
+ 0x4,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x2,
+ 0x4,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x0,
+ 0x8,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x7,
+ 0x6,
+ 0x3,
+ 0x9,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x6,
+ 0x0,
+ 0x1,
+ 0x4,
+ 0x8,
+ 0x0,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x3,
+ 0x3,
+ 0x1,
+ 0x4,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x2,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x2,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x3,
+ 0x4,
+ 0x0,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x1,
+ 0x0,
+ 0x5,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x3,
+ 0x0,
+ 0x0,
+ 0x1,
+ 0x0,
+ 0x0,
+ 0x2,
+ 0x1,
+ 0x5,
+ 0x0,
+ 0x4,
+ 0x2,
+ 0x1,
+ 0x4,
+ 0x3,
+ 0x1,
+ 0x0,
+ 0x1,
+ 0x2,
+ 0x4,
+];
+pub(crate) const TRAILING_NONSTARTERS_KV: &[u32] = &[
+ 0x4EE01,
+ 0x1E4B01,
+ 0x1F1D02,
+ 0x1E3C01,
+ 0x224901,
+ 0x1FB101,
+ 0x1E6902,
+ 0xFE8401,
+ 0x1E1A01,
+ 0x22901,
+ 0xFC6202,
+ 0xFE7101,
+ 0x1E5A01,
+ 0xEC01,
+ 0x15001,
+ 0x1E8901,
+ 0x21CF01,
+ 0x1F1101,
+ 0x1E5002,
+ 0x1E7201,
+ 0x1FB901,
+ 0x34301,
+ 0x1FD901,
+ 0x1FF801,
+ 0x1F8C03,
+ 0xDA01,
+ 0x1E5302,
+ 0x1FA203,
+ 0x1FC202,
+ 0x334E01,
+ 0x1F4502,
+ 0x12B01,
+ 0xFB4401,
+ 0x220401,
+ 0x13E01,
+ 0x12901,
+ 0x1E9301,
+ 0x1F001,
+ 0x307701,
+ 0xFE7D01,
+ 0x21B01,
+ 0x1EA802,
+ 0x1E6402,
+ 0x40301,
+ 0x95801,
+ 0x1E3902,
+ 0x30AC01,
+ 0x1F3502,
+ 0x4F501,
+ 0x1E7101,
+ 0x4E701,
+ 0x10801,
+ 0x334B01,
+ 0x14E01,
+ 0x1EC901,
+ 0x1FA02,
+ 0x4ED01,
+ 0x4EB01,
+ 0x21701,
+ 0x1FD001,
+ 0x14601,
+ 0x1D101,
+ 0x34101,
+ 0x1E3401,
+ 0x304C01,
+ 0xE901,
+ 0x1F9403,
+ 0x330701,
+ 0x1E4001,
+ 0x1E3601,
+ 0x1E3101,
+ 0x22AD01,
+ 0x1E0701,
+ 0x1F5202,
+ 0xF601,
+ 0x1FEB01,
+ 0x1EE501,
+ 0x1F7201,
+ 0x1EAF02,
+ 0x1F6D02,
+ 0x1E2201,
+ 0x1EEA02,
+ 0x1E4D02,
+ 0xA3301,
+ 0x4F901,
+ 0x17401,
+ 0x11D01,
+ 0xFB3601,
+ 0x305C01,
+ 0x12201,
+ 0x1F8802,
+ 0x1E5D02,
+ 0x1EC102,
+ 0x13D01,
+ 0x1EF102,
+ 0x30F401,
+ 0x40701,
+ 0x1FA802,
+ 0x1EB402,
+ 0x1E5801,
+ 0x1E0501,
+ 0xE001,
+ 0xFB3301,
+ 0xEB01,
+ 0xA5E01,
+ 0x1F3202,
+ 0x20A01,
+ 0x20801,
+ 0x1FF702,
+ 0x1FC901,
+ 0x228001,
+ 0xE401,
+ 0x1F2101,
+ 0x21CE01,
+ 0xCB01,
+ 0x1F9F03,
+ 0x14301,
+ 0x306701,
+ 0x1E601,
+ 0x1E4601,
+ 0x45D01,
+ 0x1E1001,
+ 0x1E4801,
+ 0x1FF402,
+ 0x30D701,
+ 0x22E301,
+ 0x1EB801,
+ 0x12C01,
+ 0x331E01,
+ 0x1F7001,
+ 0x1F5D02,
+ 0x21901,
+ 0x10D01,
+ 0x1FB402,
+ 0xA801,
+ 0x1FE801,
+ 0x15401,
+ 0x4D301,
+ 0xFC01,
+ 0x1EE401,
+ 0x1F0901,
+ 0x16B01,
+ 0x1E1201,
+ 0x1E2E02,
+ 0x4C201,
+ 0xFB1F01,
+ 0x1F5602,
+ 0x4DA01,
+ 0x1EC02,
+ 0x228801,
+ 0x1ECB01,
+ 0x16101,
+ 0x1E9101,
+ 0x1ECE01,
+ 0x1F8002,
+ 0x307401,
+ 0xFE4901,
+ 0x307101,
+ 0x1D16202,
+ 0x1FC001,
+ 0x3CB01,
+ 0x1FCF02,
+ 0x1FBF01,
+ 0x1FBD01,
+ 0xFB3501,
+ 0x1D15E01,
+ 0xFE7F01,
+ 0x22E01,
+ 0x1E7701,
+ 0xFBB001,
+ 0xE101,
+ 0x30B001,
+ 0x22EA01,
+ 0x1F3F02,
+ 0x1C601,
+ 0x1E1E01,
+ 0x9DC01,
+ 0x1F6302,
+ 0x1FC01,
+ 0x4D001,
+ 0x1FDE02,
+ 0x1E1301,
+ 0x1FCE02,
+ 0x4F101,
+ 0x228101,
+ 0x1F0101,
+ 0xFB1D01,
+ 0xDB01,
+ 0x1E8701,
+ 0x224101,
+ 0xFB3A01,
+ 0x40101,
+ 0x1FC402,
+ 0xFE7B01,
+ 0x30BA01,
+ 0xFBA501,
+ 0x30F701,
+ 0x1FF301,
+ 0x14C01,
+ 0x1D16302,
+ 0x15701,
+ 0x17801,
+ 0x1F7901,
+ 0x306201,
+ 0x1EAE02,
+ 0x30B801,
+ 0x1F2302,
+ 0x1F4D02,
+ 0x17C01,
+ 0x15601,
+ 0x22D02,
+ 0xFC9001,
+ 0x1E3B01,
+ 0x1E6A01,
+ 0x1EBE02,
+ 0x17301,
+ 0x22ED01,
+ 0x10E01,
+ 0x1E8A01,
+ 0x1F6B02,
+ 0x6C201,
+ 0xFEF901,
+ 0x1EB901,
+ 0x1EB102,
+ 0x1F5702,
+ 0x1F0D02,
+ 0x305A01,
+ 0x1FD702,
+ 0x30AE01,
+ 0x1E2001,
+ 0x17601,
+ 0xFB3401,
+ 0x1F8E03,
+ 0xFB4D01,
+ 0xFE8101,
+ 0x1E6101,
+ 0x1FE302,
+ 0x1D201,
+ 0x1FA403,
+ 0x1EE002,
+ 0x1F7A01,
+ 0xFB2F01,
+ 0x1F5502,
+ 0xFEFA01,
+ 0x1D602,
+ 0xFA01,
+ 0xFE8501,
+ 0x22F01,
+ 0x4DB01,
+ 0x1E5F01,
+ 0x1E2701,
+ 0x39002,
+ 0x41901,
+ 0x30F801,
+ 0x16C01,
+ 0x12401,
+ 0xC701,
+ 0x1F9503,
+ 0x228401,
+ 0x1E8C01,
+ 0xF7502,
+ 0x1FC301,
+ 0x1F7C01,
+ 0xFE7201,
+ 0x20C01,
+ 0xFB4901,
+ 0x1FBB01,
+ 0x10F01,
+ 0x1FB601,
+ 0x1F8902,
+ 0x1FF01,
+ 0x1F2402,
+ 0x1F5302,
+ 0x1E1702,
+ 0x1D802,
+ 0x309E01,
+ 0xFE7A01,
+ 0x305E01,
+ 0x226E01,
+ 0x1FE702,
+ 0x1EBF02,
+ 0x1F3801,
+ 0x1E3201,
+ 0x1FFB01,
+ 0x1E6B01,
+ 0x1F9D03,
+ 0x222401,
+ 0x201701,
+ 0xF7601,
+ 0x1FCC01,
+ 0x1FA002,
+ 0x1F7401,
+ 0x1F2C02,
+ 0x40D01,
+ 0x1EEE02,
+ 0x15C01,
+ 0xE301,
+ 0xCC01,
+ 0xFB3801,
+ 0x333201,
+ 0x1E7501,
+ 0x334001,
+ 0x11501,
+ 0x1E3001,
+ 0x34402,
+ 0x17701,
+ 0x1E9201,
+ 0x1E2D01,
+ 0xCA01,
+ 0x1E7D01,
+ 0x13001,
+ 0x1F6801,
+ 0x3AA01,
+ 0x309C01,
+ 0x1F4001,
+ 0x3AC01,
+ 0x1EBA01,
+ 0x43901,
+ 0xFB4C01,
+ 0x1E201,
+ 0x1109A01,
+ 0x1DB02,
+ 0x1E4101,
+ 0x1FE001,
+ 0xCE01,
+ 0x21F01,
+ 0x4DF01,
+ 0x47701,
+ 0x1F0302,
+ 0x3D401,
+ 0x23201,
+ 0x1E1101,
+ 0x1FD202,
+ 0x14401,
+ 0x1F4C02,
+ 0x1EF301,
+ 0x10C01,
+ 0x30D001,
+ 0x1E4C02,
+ 0x1E2C01,
+ 0x1F1C02,
+ 0xFC5F02,
+ 0x1FE101,
+ 0x1EC502,
+ 0x22801,
+ 0x22E101,
+ 0x1EC002,
+ 0xEA01,
+ 0x1E0802,
+ 0x95A01,
+ 0x1F8303,
+ 0x1EE302,
+ 0x306901,
+ 0x17101,
+ 0x1E1602,
+ 0x212B01,
+ 0x1E6001,
+ 0x22EC01,
+ 0x219B01,
+ 0x1E8F01,
+ 0x1F4302,
+ 0x4E501,
+ 0x1FA303,
+ 0x1F3C02,
+ 0x16D01,
+ 0x30BE01,
+ 0x1FA603,
+ 0x1E9601,
+ 0xFD01,
+ 0x1F0602,
+ 0x1ED402,
+ 0x1D502,
+ 0x1A001,
+ 0x222601,
+ 0x9DF01,
+ 0xFB3201,
+ 0xFB4701,
+ 0x1E6301,
+ 0x1DC02,
+ 0x1E4701,
+ 0x30BC01,
+ 0x1D1BB01,
+ 0x1FC702,
+ 0x1D1BC01,
+ 0x309B01,
+ 0xF7702,
+ 0xFF9E01,
+ 0x1EA702,
+ 0x95901,
+ 0xE501,
+ 0x30B601,
+ 0xFCF402,
+ 0x21601,
+ 0x4EA01,
+ 0x20501,
+ 0x4F001,
+ 0xC4801,
+ 0x14701,
+ 0x1EF801,
+ 0x1F5B02,
+ 0x1EA001,
+ 0xE201,
+ 0x1F9303,
+ 0x1F5901,
+ 0xFB4B01,
+ 0x1F3001,
+ 0x1E8401,
+ 0x62401,
+ 0x1F9703,
+ 0xDC01,
+ 0x1E8B01,
+ 0x1EDF02,
+ 0x3B002,
+ 0x1C401,
+ 0x1ED502,
+ 0x1F2901,
+ 0x1F7D01,
+ 0x1EE902,
+ 0x30DA01,
+ 0xD201,
+ 0x1F6A02,
+ 0x1EA402,
+ 0x1EB01,
+ 0xFEF801,
+ 0x93101,
+ 0x307601,
+ 0x1F0A02,
+ 0x1F2702,
+ 0x1FD601,
+ 0x3AB01,
+ 0x1E0101,
+ 0xFB2C02,
+ 0x11C01,
+ 0x203E01,
+ 0x16001,
+ 0x21001,
+ 0x1E0B01,
+ 0xFE8901,
+ 0x1E1C02,
+ 0x1E1801,
+ 0x1F9102,
+ 0x1E9501,
+ 0x11901,
+ 0x45C01,
+ 0x30DC01,
+ 0xFB2D02,
+ 0x22B02,
+ 0x2D901,
+ 0x1D001,
+ 0xDDA01,
+ 0x15D01,
+ 0x1E6E01,
+ 0x1EA602,
+ 0x1E4A01,
+ 0x1EDA02,
+ 0x306501,
+ 0x4F401,
+ 0x306001,
+ 0x110AB01,
+ 0x228501,
+ 0x1E8E01,
+ 0x227801,
+ 0x4F301,
+ 0x1F0502,
+ 0x1F7101,
+ 0x1E5C02,
+ 0xAF01,
+ 0x1EC302,
+ 0xFE8C01,
+ 0x1E8501,
+ 0x1F9802,
+ 0x1EA01,
+ 0xFB4801,
+ 0xC801,
+ 0xFE7901,
+ 0x62501,
+ 0x16501,
+ 0xF101,
+ 0x11601,
+ 0x1FDF02,
+ 0x1FEC01,
+ 0x1F3E02,
+ 0x331001,
+ 0xE701,
+ 0x1FB202,
+ 0x22601,
+ 0x6D301,
+ 0x1EAA02,
+ 0x1E1B01,
+ 0x12301,
+ 0x1F7701,
+ 0x1FAD03,
+ 0x1EDC02,
+ 0x11401,
+ 0x1F8B03,
+ 0x14501,
+ 0x1FBC01,
+ 0x1E7902,
+ 0x95F01,
+ 0x1F2801,
+ 0xDDD01,
+ 0x1FFA01,
+ 0x1CD01,
+ 0xFE4A01,
+ 0xFE7E01,
+ 0x1AF01,
+ 0x17E01,
+ 0x1F8603,
+ 0x227401,
+ 0x1FB301,
+ 0x13401,
+ 0xFB4A01,
+ 0x1F2502,
+ 0x1FD302,
+ 0x1F21301,
+ 0x20B01,
+ 0x38C01,
+ 0xFE8701,
+ 0x1F3101,
+ 0x1F1402,
+ 0x1E1F01,
+ 0x1FB02,
+ 0x1E7E01,
+ 0x1E0201,
+ 0xFE4B01,
+ 0xD901,
+ 0x1F0001,
+ 0xF7302,
+ 0xC501,
+ 0x4E401,
+ 0xFCF302,
+ 0x1F5101,
+ 0x1FE601,
+ 0x30C001,
+ 0x4F801,
+ 0x12801,
+ 0x1EB202,
+ 0x1E0A01,
+ 0x1E0C01,
+ 0x1E4401,
+ 0xEE01,
+ 0x30C201,
+ 0x16F01,
+ 0x1EA502,
+ 0x30FA01,
+ 0x1EB502,
+ 0x1D1BE02,
+ 0x22E001,
+ 0x22E201,
+ 0x1D1C002,
+ 0x1EC402,
+ 0x1F6702,
+ 0x30FE01,
+ 0x1F3402,
+ 0xFE7001,
+ 0x1E2101,
+ 0x1F5F02,
+ 0x220C01,
+ 0x1D902,
+ 0x1E0601,
+ 0x13B01,
+ 0x1ED802,
+ 0x1EEB02,
+ 0xC201,
+ 0x45001,
+ 0x1FDD02,
+ 0x1E7601,
+ 0x1D16402,
+ 0x1B001,
+ 0x20401,
+ 0x11201,
+ 0x21301,
+ 0x3D301,
+ 0x1EC202,
+ 0x1EAB02,
+ 0x1FAE03,
+ 0x1EE01,
+ 0x1ED602,
+ 0x1E3701,
+ 0x309401,
+ 0xD401,
+ 0x1E5E01,
+ 0x1E0D01,
+ 0x30D601,
+ 0x1ED702,
+ 0x1F5001,
+ 0x1D401,
+ 0x1FFD01,
+ 0xFB3C01,
+ 0x1E8D01,
+ 0x21501,
+ 0x3AF01,
+ 0x224701,
+ 0x1ECA01,
+ 0x305801,
+ 0x1E7F01,
+ 0x22AC01,
+ 0x15B01,
+ 0x4D601,
+ 0x17A01,
+ 0x1ED02,
+ 0x1E6702,
+ 0x1E2801,
+ 0x20D01,
+ 0x1EBD01,
+ 0x1FD01,
+ 0xFB2E01,
+ 0x1E4501,
+ 0x1EF701,
+ 0x45E01,
+ 0x1F3B02,
+ 0x20001,
+ 0x1FCD02,
+ 0x38502,
+ 0x13601,
+ 0x20301,
+ 0x21201,
+ 0x1E9B01,
+ 0x1F401,
+ 0x1E8001,
+ 0x1FC102,
+ 0x1F7601,
+ 0x3CA01,
+ 0x16301,
+ 0x1FCB01,
+ 0x95C01,
+ 0x21101,
+ 0x1EF901,
+ 0x1E7B02,
+ 0x1E901,
+ 0x1E1D02,
+ 0x1EDE02,
+ 0x15F01,
+ 0x1F6402,
+ 0x10001,
+ 0x20F01,
+ 0x1E6602,
+ 0x40E01,
+ 0x38E01,
+ 0x1F0801,
+ 0x11801,
+ 0xFB3101,
+ 0x1D702,
+ 0x1ED102,
+ 0x305201,
+ 0x1E2A01,
+ 0x227001,
+ 0x1F8503,
+ 0x1FFE01,
+ 0x1EF002,
+ 0x4DD01,
+ 0x95D01,
+ 0x1F6502,
+ 0xF401,
+ 0x4D701,
+ 0x38601,
+ 0x2D801,
+ 0x1EC801,
+ 0x45701,
+ 0xFF01,
+ 0x22AF01,
+ 0x1EBC01,
+ 0x11E01,
+ 0x45301,
+ 0xFE7801,
+ 0x21E01,
+ 0xB5D01,
+ 0x12A01,
+ 0xF501,
+ 0xD301,
+ 0x1E6502,
+ 0x21A01,
+ 0x1F6E02,
+ 0x1FB001,
+ 0x62201,
+ 0x333B01,
+ 0x30D301,
+ 0x1EA101,
+ 0x226F01,
+ 0x1E0E01,
+ 0x15E01,
+ 0x1FF202,
+ 0x21801,
+ 0x1F8203,
+ 0x20901,
+ 0x1FD101,
+ 0x2DB01,
+ 0xF201,
+ 0xF7902,
+ 0xA5A01,
+ 0x1F0E02,
+ 0x1F1801,
+ 0x307C01,
+ 0xFC5C01,
+ 0x2ADC01,
+ 0xE801,
+ 0x15801,
+ 0x1FDB01,
+ 0x1F6C02,
+ 0x1EB002,
+ 0x1E2301,
+ 0x1F1502,
+ 0x11F01,
+ 0xFC6002,
+ 0x1FA902,
+ 0x1E5501,
+ 0x23102,
+ 0x1FE01,
+ 0x1E3D01,
+ 0x21AE01,
+ 0xFD3C01,
+ 0x38401,
+ 0x1EE701,
+ 0x13701,
+ 0xFB3001,
+ 0xEF01,
+ 0x1FA703,
+ 0x10A01,
+ 0x1F2B02,
+ 0x1D16002,
+ 0xF901,
+ 0xFEF501,
+ 0x40C01,
+ 0x22A02,
+ 0xF301,
+ 0x12D01,
+ 0x1F9A03,
+ 0x1E4201,
+ 0x1E102,
+ 0xA5B01,
+ 0x1EAC02,
+ 0x1E1502,
+ 0x1F9E03,
+ 0x1FD801,
+ 0x1F4A02,
+ 0x20201,
+ 0x1E9801,
+ 0x1E2401,
+ 0x1EE601,
+ 0x304E01,
+ 0x1E6C01,
+ 0xFE8A01,
+ 0xFB4001,
+ 0x1F2D02,
+ 0xFD3D01,
+ 0x1FC801,
+ 0x1FB801,
+ 0x1F3D02,
+ 0x1EF501,
+ 0x13901,
+ 0x1E8101,
+ 0x1F9C03,
+ 0x10301,
+ 0xA5901,
+ 0x1F9002,
+ 0x1ED902,
+ 0x1EF201,
+ 0x4E301,
+ 0xFEF701,
+ 0x1ECD01,
+ 0x11A01,
+ 0xFB2A01,
+ 0x1E301,
+ 0x1F6602,
+ 0x1FB702,
+ 0x1E2501,
+ 0x30C701,
+ 0x1F8102,
+ 0xCF01,
+ 0x1EEF02,
+ 0x1E9701,
+ 0x1F6F02,
+ 0x1F2A02,
+ 0x10901,
+ 0x1E5601,
+ 0x1E0001,
+ 0xFB4E01,
+ 0x1FC601,
+ 0xC001,
+ 0x220901,
+ 0xFE8801,
+ 0x1CE01,
+ 0xED01,
+ 0x15901,
+ 0x15A01,
+ 0x37A01,
+ 0x227501,
+ 0xD501,
+ 0x4C101,
+ 0x1E1901,
+ 0x30D101,
+ 0x10701,
+ 0x1FAC03,
+ 0x1EA301,
+ 0x1F2E02,
+ 0x14D01,
+ 0x1F4901,
+ 0x1E8801,
+ 0x1EB302,
+ 0x20701,
+ 0x1F7801,
+ 0x1F8D03,
+ 0xFBA401,
+ 0x1F9902,
+ 0x38801,
+ 0x1F2001,
+ 0xFB4101,
+ 0x1EC602,
+ 0x40001,
+ 0x1EB602,
+ 0x1E2B01,
+ 0x1E3A01,
+ 0x1C501,
+ 0x16201,
+ 0x17D01,
+ 0x1E8201,
+ 0x1F1B02,
+ 0x17001,
+ 0x224401,
+ 0x23301,
+ 0x1E2601,
+ 0x1F3302,
+ 0x10401,
+ 0x30D901,
+ 0x30F901,
+ 0x1F8A03,
+ 0x93401,
+ 0x3CD01,
+ 0x1FFC01,
+ 0x10101,
+ 0x1F5402,
+ 0xFB4601,
+ 0x3AD01,
+ 0x1F0402,
+ 0x1FF601,
+ 0x30B201,
+ 0x1F1001,
+ 0x1E7301,
+ 0x20E01,
+ 0x1E0301,
+ 0x1F6901,
+ 0xFEF601,
+ 0x95B01,
+ 0x227101,
+ 0x22701,
+ 0x1E3501,
+ 0x34001,
+ 0x1F0B02,
+ 0x1E701,
+ 0x1ED302,
+ 0x1F8403,
+ 0x1F2F02,
+ 0x1E8301,
+ 0x1F6001,
+ 0x62301,
+ 0xFC5D01,
+ 0x226001,
+ 0x22C02,
+ 0x1E3F01,
+ 0x1F7501,
+ 0x226201,
+ 0x1FDA01,
+ 0x20601,
+ 0xFE7701,
+ 0x305601,
+ 0x12101,
+ 0x1F2602,
+ 0x1E9001,
+ 0x95E01,
+ 0x12F01,
+ 0x1F9603,
+ 0x1E4901,
+ 0x10B01,
+ 0x1DF02,
+ 0x1D16102,
+ 0xFB2B01,
+ 0x1E0902,
+ 0x11701,
+ 0xFF9F01,
+ 0x1F7B01,
+ 0x1E9901,
+ 0x1F9203,
+ 0x1FCA01,
+ 0xB801,
+ 0x1A101,
+ 0x1F3901,
+ 0xFE7401,
+ 0xFC6102,
+ 0x1E5B01,
+ 0x92901,
+ 0xFE8301,
+ 0x1FE202,
+ 0x305401,
+ 0x1CF01,
+ 0x2DC01,
+ 0xFB01,
+ 0x307A01,
+ 0xFB3901,
+ 0x17501,
+ 0x305001,
+ 0x1E801,
+ 0x1FE901,
+ 0x1D301,
+ 0x307D01,
+ 0x1E2F02,
+ 0xFE4C01,
+ 0xF8102,
+ 0x1FA503,
+ 0x1FAB03,
+ 0x1EDB02,
+ 0x1F4801,
+ 0x1EED02,
+ 0x1F4402,
+ 0x1DA02,
+ 0xD101,
+ 0x1E6802,
+ 0x2DA01,
+ 0x30B401,
+ 0x1ECF01,
+ 0x1E5901,
+ 0x1E002,
+ 0x1E5701,
+ 0x1F0F02,
+ 0x17201,
+ 0x1FEE02,
+ 0x1E5401,
+ 0xC901,
+ 0xA3601,
+ 0x228901,
+ 0x1ECC01,
+ 0xB401,
+ 0x16901,
+ 0x1EF601,
+ 0x10501,
+ 0x1E7C01,
+ 0x1F8F03,
+ 0x1E3301,
+ 0x14F01,
+ 0x1EE802,
+ 0x1F4202,
+ 0x1E3E01,
+ 0xFC6302,
+ 0x1F501,
+ 0x16401,
+ 0x4F201,
+ 0x1F0202,
+ 0x1E0F01,
+ 0x1FEA01,
+ 0x1F1901,
+ 0xFC5B01,
+ 0x1D1BD02,
+ 0xC101,
+ 0x38A01,
+ 0x1EE102,
+ 0xD601,
+ 0x1E7802,
+ 0x1F7301,
+ 0x1E7A02,
+ 0x1EA902,
+ 0xFCD901,
+ 0x1F9B03,
+ 0x1F2202,
+ 0x10601,
+ 0x38F01,
+ 0xF7801,
+ 0x1D15F01,
+ 0x1F8703,
+ 0x1FE501,
+ 0x1EE202,
+ 0x1F801,
+ 0x307901,
+ 0xFE8201,
+ 0x1ED002,
+ 0x4E201,
+ 0x13501,
+ 0x1109C01,
+ 0xFCF202,
+ 0x1E6F01,
+ 0x21CD01,
+ 0x1EB702,
+ 0x4EF01,
+ 0x1E6201,
+ 0x1EDD02,
+ 0xFC5E02,
+ 0xDD01,
+ 0x1F6202,
+ 0x1F4B02,
+ 0x4E601,
+ 0x14801,
+ 0x1F3A02,
+ 0x1FAF03,
+ 0xC401,
+ 0x1EEC02,
+ 0x1F4101,
+ 0x1EC702,
+ 0x4DC01,
+ 0x16E01,
+ 0x1F1A02,
+ 0x307301,
+ 0x22AE01,
+ 0x38901,
+ 0x23002,
+ 0x13C01,
+ 0x1FF901,
+ 0x1F0702,
+ 0x1EBB01,
+ 0x12501,
+ 0x1F1202,
+ 0x1E2901,
+ 0x1E4301,
+ 0x10201,
+ 0x330401,
+ 0x6C001,
+ 0x11301,
+ 0x1EA201,
+ 0x1F3702,
+ 0x1FED02,
+ 0x4D201,
+ 0xFFE301,
+ 0x30D401,
+ 0x15101,
+ 0x307001,
+ 0x3AE01,
+ 0x1F901,
+ 0x1FA102,
+ 0x1E9401,
+ 0x332101,
+ 0xC301,
+ 0x17901,
+ 0x1DE02,
+ 0xFB3E01,
+ 0x1E5102,
+ 0x4DE01,
+ 0x62601,
+ 0x3CC01,
+ 0x2DD01,
+ 0x1F6101,
+ 0x15501,
+ 0x3CE01,
+ 0x30C901,
+ 0x1E7001,
+ 0x227901,
+ 0x30C501,
+ 0x12001,
+ 0xFE8601,
+ 0x1E4F02,
+ 0x13A01,
+ 0x1E7401,
+ 0x1F1302,
+ 0x1D1BF02,
+ 0x11B01,
+ 0x9DD01,
+ 0x22EB01,
+ 0x1E6D01,
+ 0x1E5202,
+ 0x1ED202,
+ 0x1F3602,
+ 0x1EAD02,
+ 0x1FE401,
+ 0xB5C01,
+ 0x1FBA01,
+ 0x1E4E02,
+ 0x16801,
+ 0xFE7C01,
+ 0x1FAA03,
+ 0x1E0401,
+ 0x20101,
+ 0x1EF01,
+ 0x12E01,
+ 0x1F0C02,
+ 0x1E1402,
+ 0xFE7601,
+ 0x1E3802,
+ 0xFB3B01,
+ 0xCD01,
+ 0x226D01,
+ 0x4D101,
+ 0x1E8601,
+ 0x45101,
+ 0x17B01,
+ 0x47601,
+ 0x4EC01,
+ 0x21401,
+ 0x1EF401,
+ 0x16A01,
+ 0x30DD01,
+ 0xFE8B01,
+ 0xFBB101,
+ 0x219A01,
+ 0xFB4301,
+];
+
+
diff --git a/crates/unicode-normalization/src/test.rs b/crates/unicode-normalization/src/test.rs
new file mode 100644
index 0000000..4c37149
--- /dev/null
+++ b/crates/unicode-normalization/src/test.rs
@@ -0,0 +1,130 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use super::char::is_combining_mark;
+use super::UnicodeNormalization;
+use core::char;
+
+#[cfg(not(feature = "std"))]
+use crate::no_std_prelude::*;
+
+#[test]
+fn test_nfd() {
+ macro_rules! t {
+ ($input: expr, $expected: expr) => {
+ assert_eq!($input.nfd().to_string(), $expected);
+ // A dummy iterator that is not std::str::Chars directly;
+ // note that `id_func` is used to ensure `Clone` implementation
+ assert_eq!(
+ $input.chars().map(|c| c).nfd().collect::<String>(),
+ $expected
+ );
+ };
+ }
+ t!("abc", "abc");
+ t!("\u{1e0b}\u{1c4}", "d\u{307}\u{1c4}");
+ t!("\u{2026}", "\u{2026}");
+ t!("\u{2126}", "\u{3a9}");
+ t!("\u{1e0b}\u{323}", "d\u{323}\u{307}");
+ t!("\u{1e0d}\u{307}", "d\u{323}\u{307}");
+ t!("a\u{301}", "a\u{301}");
+ t!("\u{301}a", "\u{301}a");
+ t!("\u{d4db}", "\u{1111}\u{1171}\u{11b6}");
+ t!("\u{ac1c}", "\u{1100}\u{1162}");
+}
+
+#[test]
+fn test_nfkd() {
+ macro_rules! t {
+ ($input: expr, $expected: expr) => {
+ assert_eq!($input.nfkd().to_string(), $expected);
+ };
+ }
+ t!("abc", "abc");
+ t!("\u{1e0b}\u{1c4}", "d\u{307}DZ\u{30c}");
+ t!("\u{2026}", "...");
+ t!("\u{2126}", "\u{3a9}");
+ t!("\u{1e0b}\u{323}", "d\u{323}\u{307}");
+ t!("\u{1e0d}\u{307}", "d\u{323}\u{307}");
+ t!("a\u{301}", "a\u{301}");
+ t!("\u{301}a", "\u{301}a");
+ t!("\u{d4db}", "\u{1111}\u{1171}\u{11b6}");
+ t!("\u{ac1c}", "\u{1100}\u{1162}");
+}
+
+#[test]
+fn test_nfc() {
+ macro_rules! t {
+ ($input: expr, $expected: expr) => {
+ assert_eq!($input.nfc().to_string(), $expected);
+ };
+ }
+ t!("abc", "abc");
+ t!("\u{1e0b}\u{1c4}", "\u{1e0b}\u{1c4}");
+ t!("\u{2026}", "\u{2026}");
+ t!("\u{2126}", "\u{3a9}");
+ t!("\u{1e0b}\u{323}", "\u{1e0d}\u{307}");
+ t!("\u{1e0d}\u{307}", "\u{1e0d}\u{307}");
+ t!("a\u{301}", "\u{e1}");
+ t!("\u{301}a", "\u{301}a");
+ t!("\u{d4db}", "\u{d4db}");
+ t!("\u{ac1c}", "\u{ac1c}");
+ t!(
+ "a\u{300}\u{305}\u{315}\u{5ae}b",
+ "\u{e0}\u{5ae}\u{305}\u{315}b"
+ );
+}
+
+#[test]
+fn test_nfkc() {
+ macro_rules! t {
+ ($input: expr, $expected: expr) => {
+ assert_eq!($input.nfkc().to_string(), $expected);
+ };
+ }
+ t!("abc", "abc");
+ t!("\u{1e0b}\u{1c4}", "\u{1e0b}D\u{17d}");
+ t!("\u{2026}", "...");
+ t!("\u{2126}", "\u{3a9}");
+ t!("\u{1e0b}\u{323}", "\u{1e0d}\u{307}");
+ t!("\u{1e0d}\u{307}", "\u{1e0d}\u{307}");
+ t!("a\u{301}", "\u{e1}");
+ t!("\u{301}a", "\u{301}a");
+ t!("\u{d4db}", "\u{d4db}");
+ t!("\u{ac1c}", "\u{ac1c}");
+ t!(
+ "a\u{300}\u{305}\u{315}\u{5ae}b",
+ "\u{e0}\u{5ae}\u{305}\u{315}b"
+ );
+}
+
+#[test]
+fn test_normalize_char() {
+ assert_eq!('\u{2126}'.nfd().to_string(), "\u{3a9}")
+}
+
+#[test]
+fn test_is_combining_mark_ascii() {
+ for cp in 0..0x7f {
+ assert!(!is_combining_mark(char::from_u32(cp).unwrap()));
+ }
+}
+
+#[test]
+fn test_is_combining_mark_misc() {
+ // https://github.com/unicode-rs/unicode-normalization/issues/16
+ // U+11C3A BHAIKSUKI VOWEL SIGN O
+ // Category: Mark, Nonspacing [Mn]
+ assert!(is_combining_mark('\u{11C3A}'));
+
+ // U+11C3F BHAIKSUKI SIGN VIRAMA
+ // Category: Mark, Nonspacing [Mn]
+ assert!(is_combining_mark('\u{11C3F}'));
+}
diff --git a/crates/unicode-segmentation/.cargo-checksum.json b/crates/unicode-segmentation/.cargo-checksum.json
new file mode 100644
index 0000000..faa4000
--- /dev/null
+++ b/crates/unicode-segmentation/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"COPYRIGHT":"23860c2a7b5d96b21569afedf033469bab9fe14a1b24a35068b8641c578ce24d","Cargo.toml":"3de4086a8d886795bd6f4322b3f42ee8b84eb1c9ab6651fb95c0469d1cf508f1","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"7b63ecd5f1902af1b63729947373683c32745c16a10e8e6292e2e2dcd7e90ae0","README.md":"8d05f9f7aafc8af56853b802e14d0e2e73a56021d8b5481b69e169fd3e2c44cc","benches/graphemes.rs":"88a9f672ea7a03cc15fae36ce544a6e7234e532359402483978858ccda47db3d","benches/unicode_words.rs":"42df2c8e9bfb54baf31c8327e27915683c25b90d55dc04311c28a0c2a9d185e3","benches/word_bounds.rs":"0453e37477134063178e104305b0a5f27ce74aa342234a6208095623c45de0d4","scripts/unicode.py":"e38d564c2f778aeb2cd17ce6c4395e5f5abd85ff8dd5292d76a93c16f4e38eb9","scripts/unicode_gen_breaktests.py":"ee96982d8959bec75c2382233cfca7e239f12a89a1be5fbf942601a215bb9283","src/grapheme.rs":"b5a32bdbb529e9417e8ada8d92656339b6ffb4e9bed8e6d32a0409c13a03050b","src/lib.rs":"572789173717edd0fe037ae656530663406951636c548e6793711b7d5caad910","src/sentence.rs":"aac52f69207e0b68925ab0c6c18cc36ed3da8e918006d96d724f0f19d4d9d643","src/tables.rs":"547636e4d6d685286f98c7f1db5ebde8e254ec811dbec4b7c2edf74c1454740d","src/test.rs":"f039fa285d510244672a067bdbe98ce7ff940e4f2ff82926466e012ac48ad95a","src/testdata.rs":"533c02ecace1bec3d46b65d101c7619bc83a2fb2c187a2c960346533c09a0e3e","src/word.rs":"6eeea9351c12f0a4404606596a487e0e8aa948ba4b134c7cb827ee41557a39fe"},"package":"1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36"}
\ No newline at end of file
diff --git a/crates/unicode-segmentation/Android.bp b/crates/unicode-segmentation/Android.bp
new file mode 100644
index 0000000..5688b65
--- /dev/null
+++ b/crates/unicode-segmentation/Android.bp
@@ -0,0 +1,30 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_unicode-segmentation_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_unicode-segmentation_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libunicode_segmentation",
+ host_supported: true,
+ crate_name: "unicode_segmentation",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.10.1",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/unicode-segmentation/COPYRIGHT b/crates/unicode-segmentation/COPYRIGHT
new file mode 100644
index 0000000..b286ec1
--- /dev/null
+++ b/crates/unicode-segmentation/COPYRIGHT
@@ -0,0 +1,7 @@
+Licensed under the Apache License, Version 2.0
+<LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT
+license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+at your option. All files in the project carrying such
+notice may not be copied, modified, or distributed except
+according to those terms.
diff --git a/crates/unicode-segmentation/Cargo.toml b/crates/unicode-segmentation/Cargo.toml
new file mode 100644
index 0000000..83dea28
--- /dev/null
+++ b/crates/unicode-segmentation/Cargo.toml
@@ -0,0 +1,63 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "unicode-segmentation"
+version = "1.10.1"
+authors = [
+ "kwantam <[email protected]>",
+ "Manish Goregaokar <[email protected]>",
+]
+exclude = [
+ "target/*",
+ "Cargo.lock",
+ "scripts/tmp",
+ "benches/texts/*",
+ "*.txt",
+]
+description = """
+This crate provides Grapheme Cluster, Word and Sentence boundaries
+according to Unicode Standard Annex #29 rules.
+"""
+homepage = "https://github.com/unicode-rs/unicode-segmentation"
+documentation = "https://unicode-rs.github.io/unicode-segmentation"
+readme = "README.md"
+keywords = [
+ "text",
+ "unicode",
+ "grapheme",
+ "word",
+ "boundary",
+]
+license = "MIT/Apache-2.0"
+repository = "https://github.com/unicode-rs/unicode-segmentation"
+
+[[bench]]
+name = "graphemes"
+harness = false
+
+[[bench]]
+name = "unicode_words"
+harness = false
+
+[[bench]]
+name = "word_bounds"
+harness = false
+
+[dev-dependencies.criterion]
+version = "0.3"
+
+[dev-dependencies.quickcheck]
+version = "0.7"
+
+[features]
+no_std = []
diff --git a/crates/unicode-segmentation/LICENSE b/crates/unicode-segmentation/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/unicode-segmentation/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/unicode-segmentation/LICENSE-APACHE b/crates/unicode-segmentation/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/unicode-segmentation/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/unicode-segmentation/LICENSE-MIT b/crates/unicode-segmentation/LICENSE-MIT
new file mode 100644
index 0000000..e69282e
--- /dev/null
+++ b/crates/unicode-segmentation/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2015 The Rust Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/unicode-segmentation/METADATA b/crates/unicode-segmentation/METADATA
new file mode 100644
index 0000000..860e2a9
--- /dev/null
+++ b/crates/unicode-segmentation/METADATA
@@ -0,0 +1,23 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/unicode-segmentation
+# For more info, check https://cs.android.com/android/platform/superproject/+/master:tools/external_updater/README.md
+
+name: "unicode-segmentation"
+description: "This crate provides Grapheme Cluster, Word and Sentence boundaries according to Unicode Standard Annex #29 rules."
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/unicode-segmentation"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/unicode-segmentation/unicode-segmentation-1.10.1.crate"
+ }
+ version: "1.10.1"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 2
+ day: 17
+ }
+}
diff --git a/crates/unicode-segmentation/MODULE_LICENSE_APACHE2 b/crates/unicode-segmentation/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/unicode-segmentation/MODULE_LICENSE_APACHE2
diff --git a/crates/unicode-segmentation/NOTICE b/crates/unicode-segmentation/NOTICE
new file mode 120000
index 0000000..7a694c9
--- /dev/null
+++ b/crates/unicode-segmentation/NOTICE
@@ -0,0 +1 @@
+LICENSE
\ No newline at end of file
diff --git a/crates/unicode-segmentation/README.md b/crates/unicode-segmentation/README.md
new file mode 100644
index 0000000..ef61ebd
--- /dev/null
+++ b/crates/unicode-segmentation/README.md
@@ -0,0 +1,99 @@
+Iterators which split strings on Grapheme Cluster or Word boundaries, according
+to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules.
+
+[](https://travis-ci.org/unicode-rs/unicode-segmentation)
+
+[Documentation](https://unicode-rs.github.io/unicode-segmentation/unicode_segmentation/index.html)
+
+```rust
+use unicode_segmentation::UnicodeSegmentation;
+
+fn main() {
+ let s = "a̐éö̲\r\n";
+ let g = s.graphemes(true).collect::<Vec<&str>>();
+ let b: &[_] = &["a̐", "é", "ö̲", "\r\n"];
+ assert_eq!(g, b);
+
+ let s = "The quick (\"brown\") fox can't jump 32.3 feet, right?";
+ let w = s.unicode_words().collect::<Vec<&str>>();
+ let b: &[_] = &["The", "quick", "brown", "fox", "can't", "jump", "32.3", "feet", "right"];
+ assert_eq!(w, b);
+
+ let s = "The quick (\"brown\") fox";
+ let w = s.split_word_bounds().collect::<Vec<&str>>();
+ let b: &[_] = &["The", " ", "quick", " ", "(", "\"", "brown", "\"", ")", " ", " ", "fox"];
+ assert_eq!(w, b);
+}
+```
+
+# no_std
+
+unicode-segmentation does not depend on libstd, so it can be used in crates
+with the `#![no_std]` attribute.
+
+# crates.io
+
+You can use this package in your project by adding the following
+to your `Cargo.toml`:
+
+```toml
+[dependencies]
+unicode-segmentation = "1.10.1"
+```
+
+# Change Log
+
+## 1.7.1
+
+* Update docs on version number
+
+## 1.7.0
+
+* [#87](https://github.com/unicode-rs/unicode-segmentation/pull/87) Upgrade to Unicode 13
+* [#79](https://github.com/unicode-rs/unicode-segmentation/pull/79) Implement a special-case lookup for ascii grapheme categories
+* [#77](https://github.com/unicode-rs/unicode-segmentation/pull/77) Optimization for grapheme iteration
+
+## 1.6.0
+
+* [#72](https://github.com/unicode-rs/unicode-segmentation/pull/72) Upgrade to Unicode 12
+
+## 1.5.0
+
+* [#68](https://github.com/unicode-rs/unicode-segmentation/pull/68) Upgrade to Unicode 11
+
+## 1.4.0
+
+* [#56](https://github.com/unicode-rs/unicode-segmentation/pull/56) Upgrade to Unicode 10
+
+## 1.3.0
+
+* [#24](https://github.com/unicode-rs/unicode-segmentation/pull/24) Add support for sentence boundaries
+* [#44](https://github.com/unicode-rs/unicode-segmentation/pull/44) Treat `gc=No` as a subset of `gc=N`
+
+## 1.2.1
+
+* [#37](https://github.com/unicode-rs/unicode-segmentation/pull/37):
+ Fix panic in `provide_context`.
+* [#40](https://github.com/unicode-rs/unicode-segmentation/pull/40):
+ Fix crash in `prev_boundary`.
+
+## 1.2.0
+
+* New `GraphemeCursor` API allows random access and bidirectional iteration.
+* Fixed incorrect splitting of certain emoji modifier sequences.
+
+## 1.1.0
+
+* Add `as_str` methods to the iterator types.
+
+## 1.0.3
+
+* Code cleanup and additional tests.
+
+## 1.0.1
+
+* Fix a bug affecting some grapheme clusters containing Prepend characters.
+
+## 1.0.0
+
+* Upgrade to Unicode 9.0.0.
diff --git a/crates/unicode-segmentation/TEST_MAPPING b/crates/unicode-segmentation/TEST_MAPPING
new file mode 100644
index 0000000..9ff8107
--- /dev/null
+++ b/crates/unicode-segmentation/TEST_MAPPING
@@ -0,0 +1,50 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "external/rust/crates/argh"
+ },
+ {
+ "path": "external/rust/crates/base64"
+ },
+ {
+ "path": "external/rust/crates/heck"
+ },
+ {
+ "path": "external/rust/crates/heck/0.3.3"
+ },
+ {
+ "path": "external/rust/crates/libsqlite3-sys"
+ },
+ {
+ "path": "packages/modules/Virtualization/apkdmverity"
+ },
+ {
+ "path": "packages/modules/Virtualization/authfs"
+ },
+ {
+ "path": "packages/modules/Virtualization/avmd"
+ },
+ {
+ "path": "packages/modules/Virtualization/encryptedstore"
+ },
+ {
+ "path": "packages/modules/Virtualization/virtualizationmanager"
+ },
+ {
+ "path": "packages/modules/Virtualization/vm"
+ },
+ {
+ "path": "packages/modules/Virtualization/zipfuse"
+ },
+ {
+ "path": "system/security/diced"
+ },
+ {
+ "path": "system/security/keystore2"
+ },
+ {
+ "path": "system/security/keystore2/legacykeystore"
+ }
+ ]
+}
diff --git a/crates/unicode-segmentation/benches/graphemes.rs b/crates/unicode-segmentation/benches/graphemes.rs
new file mode 100644
index 0000000..3a0b9b7
--- /dev/null
+++ b/crates/unicode-segmentation/benches/graphemes.rs
@@ -0,0 +1,63 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use unicode_segmentation;
+
+use std::fs;
+use unicode_segmentation::UnicodeSegmentation;
+
+fn graphemes(c: &mut Criterion, lang: &str, path: &str) {
+ let text = fs::read_to_string(path).unwrap();
+
+ c.bench_function(&format!("graphemes_{}", lang), |bench| {
+ bench.iter(|| {
+ for g in UnicodeSegmentation::graphemes(black_box(&*text), true) {
+ black_box(g);
+ }
+ })
+ });
+}
+
+fn graphemes_arabic(c: &mut Criterion) {
+ graphemes(c, "arabic", "benches/texts/arabic.txt");
+}
+
+fn graphemes_english(c: &mut Criterion) {
+ graphemes(c, "english", "benches/texts/english.txt");
+}
+
+fn graphemes_hindi(c: &mut Criterion) {
+ graphemes(c, "hindi", "benches/texts/hindi.txt");
+}
+
+fn graphemes_japanese(c: &mut Criterion) {
+ graphemes(c, "japanese", "benches/texts/japanese.txt");
+}
+
+fn graphemes_korean(c: &mut Criterion) {
+ graphemes(c, "korean", "benches/texts/korean.txt");
+}
+
+fn graphemes_mandarin(c: &mut Criterion) {
+ graphemes(c, "mandarin", "benches/texts/mandarin.txt");
+}
+
+fn graphemes_russian(c: &mut Criterion) {
+ graphemes(c, "russian", "benches/texts/russian.txt");
+}
+
+fn graphemes_source_code(c: &mut Criterion) {
+ graphemes(c, "source_code", "benches/texts/source_code.txt");
+}
+
+criterion_group!(
+ benches,
+ graphemes_arabic,
+ graphemes_english,
+ graphemes_hindi,
+ graphemes_japanese,
+ graphemes_korean,
+ graphemes_mandarin,
+ graphemes_russian,
+ graphemes_source_code,
+);
+
+criterion_main!(benches);
diff --git a/crates/unicode-segmentation/benches/unicode_words.rs b/crates/unicode-segmentation/benches/unicode_words.rs
new file mode 100644
index 0000000..a7f8f41
--- /dev/null
+++ b/crates/unicode-segmentation/benches/unicode_words.rs
@@ -0,0 +1,61 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+use std::fs;
+use unicode_segmentation::UnicodeSegmentation;
+
+fn unicode_words(c: &mut Criterion, lang: &str, path: &str) {
+ let text = fs::read_to_string(path).unwrap();
+ c.bench_function(&format!("unicode_words_{}", lang), |bench| {
+ bench.iter(|| {
+ for w in text.unicode_words() {
+ black_box(w);
+ }
+ })
+ });
+}
+
+fn unicode_words_arabic(c: &mut Criterion) {
+ unicode_words(c, "arabic", "benches/texts/arabic.txt");
+}
+
+fn unicode_words_english(c: &mut Criterion) {
+ unicode_words(c, "english", "benches/texts/english.txt");
+}
+
+fn unicode_words_hindi(c: &mut Criterion) {
+ unicode_words(c, "hindi", "benches/texts/hindi.txt");
+}
+
+fn unicode_words_japanese(c: &mut Criterion) {
+ unicode_words(c, "japanese", "benches/texts/japanese.txt");
+}
+
+fn unicode_words_korean(c: &mut Criterion) {
+ unicode_words(c, "korean", "benches/texts/korean.txt");
+}
+
+fn unicode_words_mandarin(c: &mut Criterion) {
+ unicode_words(c, "mandarin", "benches/texts/mandarin.txt");
+}
+
+fn unicode_words_russian(c: &mut Criterion) {
+ unicode_words(c, "russian", "benches/texts/russian.txt");
+}
+
+fn unicode_words_source_code(c: &mut Criterion) {
+ unicode_words(c, "source_code", "benches/texts/source_code.txt");
+}
+
+criterion_group!(
+ benches,
+ unicode_words_arabic,
+ unicode_words_english,
+ unicode_words_hindi,
+ unicode_words_japanese,
+ unicode_words_korean,
+ unicode_words_mandarin,
+ unicode_words_russian,
+ unicode_words_source_code,
+);
+
+criterion_main!(benches);
diff --git a/crates/unicode-segmentation/benches/word_bounds.rs b/crates/unicode-segmentation/benches/word_bounds.rs
new file mode 100644
index 0000000..cae7a88
--- /dev/null
+++ b/crates/unicode-segmentation/benches/word_bounds.rs
@@ -0,0 +1,61 @@
+use criterion::{black_box, criterion_group, criterion_main, Criterion};
+
+use std::fs;
+use unicode_segmentation::UnicodeSegmentation;
+
+fn word_bounds(c: &mut Criterion, lang: &str, path: &str) {
+ let text = fs::read_to_string(path).unwrap();
+ c.bench_function(&format!("word_bounds_{}", lang), |bench| {
+ bench.iter(|| {
+ for w in text.split_word_bounds() {
+ black_box(w);
+ }
+ });
+ });
+}
+
+fn word_bounds_arabic(c: &mut Criterion) {
+ word_bounds(c, "arabic", "benches/texts/arabic.txt");
+}
+
+fn word_bounds_english(c: &mut Criterion) {
+ word_bounds(c, "english", "benches/texts/english.txt");
+}
+
+fn word_bounds_hindi(c: &mut Criterion) {
+ word_bounds(c, "hindi", "benches/texts/hindi.txt");
+}
+
+fn word_bounds_japanese(c: &mut Criterion) {
+ word_bounds(c, "japanese", "benches/texts/japanese.txt");
+}
+
+fn word_bounds_korean(c: &mut Criterion) {
+ word_bounds(c, "korean", "benches/texts/korean.txt");
+}
+
+fn word_bounds_mandarin(c: &mut Criterion) {
+ word_bounds(c, "mandarin", "benches/texts/mandarin.txt");
+}
+
+fn word_bounds_russian(c: &mut Criterion) {
+ word_bounds(c, "russian", "benches/texts/russian.txt");
+}
+
+fn word_bounds_source_code(c: &mut Criterion) {
+ word_bounds(c, "source_code", "benches/texts/source_code.txt");
+}
+
+criterion_group!(
+ benches,
+ word_bounds_arabic,
+ word_bounds_english,
+ word_bounds_hindi,
+ word_bounds_japanese,
+ word_bounds_korean,
+ word_bounds_mandarin,
+ word_bounds_russian,
+ word_bounds_source_code,
+);
+
+criterion_main!(benches);
diff --git a/crates/unicode-segmentation/cargo_embargo.json b/crates/unicode-segmentation/cargo_embargo.json
new file mode 100644
index 0000000..cb908d7
--- /dev/null
+++ b/crates/unicode-segmentation/cargo_embargo.json
@@ -0,0 +1,3 @@
+{
+ "run_cargo": false
+}
diff --git a/crates/unicode-segmentation/patches/std.diff b/crates/unicode-segmentation/patches/std.diff
new file mode 100644
index 0000000..4ed51cb
--- /dev/null
+++ b/crates/unicode-segmentation/patches/std.diff
@@ -0,0 +1,13 @@
+diff --git a/src/lib.rs b/src/lib.rs
+index f2f2962..83f3a22 100644
+--- a/src/lib.rs
++++ b/src/lib.rs
+@@ -55,7 +55,7 @@
+
+ #![no_std]
+
+-#[cfg(test)]
++// ANDROID: Always import std to enable building as a dylib
+ #[macro_use]
+ extern crate std;
+
diff --git a/crates/unicode-segmentation/scripts/unicode.py b/crates/unicode-segmentation/scripts/unicode.py
new file mode 100755
index 0000000..18cea99
--- /dev/null
+++ b/crates/unicode-segmentation/scripts/unicode.py
@@ -0,0 +1,433 @@
+#!/usr/bin/env python
+#
+# Copyright 2011-2015 The Rust Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution and at
+# http://rust-lang.org/COPYRIGHT.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# This script uses the following Unicode tables:
+# - DerivedCoreProperties.txt
+# - auxiliary/GraphemeBreakProperty.txt
+# - auxiliary/WordBreakProperty.txt
+# - ReadMe.txt
+# - UnicodeData.txt
+#
+# Since this should not require frequent updates, we just store this
+# out-of-line and check the unicode.rs file into git.
+
+import fileinput, re, os, sys
+
+preamble = '''// Copyright 2012-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+#![allow(missing_docs, non_upper_case_globals, non_snake_case)]
+'''
+
+# Mapping taken from Table 12 from:
+# http://www.unicode.org/reports/tr44/#General_Category_Values
+expanded_categories = {
+ 'Lu': ['LC', 'L'], 'Ll': ['LC', 'L'], 'Lt': ['LC', 'L'],
+ 'Lm': ['L'], 'Lo': ['L'],
+ 'Mn': ['M'], 'Mc': ['M'], 'Me': ['M'],
+ 'Nd': ['N'], 'Nl': ['N'], 'No': ['N'],
+ 'Pc': ['P'], 'Pd': ['P'], 'Ps': ['P'], 'Pe': ['P'],
+ 'Pi': ['P'], 'Pf': ['P'], 'Po': ['P'],
+ 'Sm': ['S'], 'Sc': ['S'], 'Sk': ['S'], 'So': ['S'],
+ 'Zs': ['Z'], 'Zl': ['Z'], 'Zp': ['Z'],
+ 'Cc': ['C'], 'Cf': ['C'], 'Cs': ['C'], 'Co': ['C'], 'Cn': ['C'],
+}
+
+# these are the surrogate codepoints, which are not valid rust characters
+surrogate_codepoints = (0xd800, 0xdfff)
+
+UNICODE_VERSION = (15, 0, 0)
+
+UNICODE_VERSION_NUMBER = "%s.%s.%s" %UNICODE_VERSION
+
+def is_surrogate(n):
+ return surrogate_codepoints[0] <= n <= surrogate_codepoints[1]
+
+def fetch(f):
+ if not os.path.exists(os.path.basename(f)):
+ if "emoji" in f:
+ os.system("curl -O https://www.unicode.org/Public/%s/ucd/emoji/%s"
+ % (UNICODE_VERSION_NUMBER, f))
+ else:
+ os.system("curl -O https://www.unicode.org/Public/%s/ucd/%s"
+ % (UNICODE_VERSION_NUMBER, f))
+
+ if not os.path.exists(os.path.basename(f)):
+ sys.stderr.write("cannot load %s" % f)
+ exit(1)
+
+def load_gencats(f):
+ fetch(f)
+ gencats = {}
+
+ udict = {};
+ range_start = -1;
+ for line in fileinput.input(f):
+ data = line.split(';');
+ if len(data) != 15:
+ continue
+ cp = int(data[0], 16);
+ if is_surrogate(cp):
+ continue
+ if range_start >= 0:
+ for i in range(range_start, cp):
+ udict[i] = data;
+ range_start = -1;
+ if data[1].endswith(", First>"):
+ range_start = cp;
+ continue;
+ udict[cp] = data;
+
+ for code in udict:
+ [code_org, name, gencat, combine, bidi,
+ decomp, deci, digit, num, mirror,
+ old, iso, upcase, lowcase, titlecase ] = udict[code];
+
+ # place letter in categories as appropriate
+ for cat in [gencat, "Assigned"] + expanded_categories.get(gencat, []):
+ if cat not in gencats:
+ gencats[cat] = []
+ gencats[cat].append(code)
+
+ gencats = group_cats(gencats)
+ return gencats
+
+def group_cats(cats):
+ cats_out = {}
+ for cat in cats:
+ cats_out[cat] = group_cat(cats[cat])
+ return cats_out
+
+def group_cat(cat):
+ cat_out = []
+ letters = sorted(set(cat))
+ cur_start = letters.pop(0)
+ cur_end = cur_start
+ for letter in letters:
+ assert letter > cur_end, \
+ "cur_end: %s, letter: %s" % (hex(cur_end), hex(letter))
+ if letter == cur_end + 1:
+ cur_end = letter
+ else:
+ cat_out.append((cur_start, cur_end))
+ cur_start = cur_end = letter
+ cat_out.append((cur_start, cur_end))
+ return cat_out
+
+def ungroup_cat(cat):
+ cat_out = []
+ for (lo, hi) in cat:
+ while lo <= hi:
+ cat_out.append(lo)
+ lo += 1
+ return cat_out
+
+def format_table_content(f, content, indent):
+ line = " "*indent
+ first = True
+ for chunk in content.split(","):
+ if len(line) + len(chunk) < 98:
+ if first:
+ line += chunk
+ else:
+ line += ", " + chunk
+ first = False
+ else:
+ f.write(line + ",\n")
+ line = " "*indent + chunk
+ f.write(line)
+
+def load_properties(f, interestingprops):
+ fetch(f)
+ props = {}
+ re1 = re.compile(r"^ *([0-9A-F]+) *; *(\w+)")
+ re2 = re.compile(r"^ *([0-9A-F]+)\.\.([0-9A-F]+) *; *(\w+)")
+
+ for line in fileinput.input(os.path.basename(f)):
+ prop = None
+ d_lo = 0
+ d_hi = 0
+ m = re1.match(line)
+ if m:
+ d_lo = m.group(1)
+ d_hi = m.group(1)
+ prop = m.group(2)
+ else:
+ m = re2.match(line)
+ if m:
+ d_lo = m.group(1)
+ d_hi = m.group(2)
+ prop = m.group(3)
+ else:
+ continue
+ if interestingprops and prop not in interestingprops:
+ continue
+ d_lo = int(d_lo, 16)
+ d_hi = int(d_hi, 16)
+ if prop not in props:
+ props[prop] = []
+ props[prop].append((d_lo, d_hi))
+
+ # optimize if possible
+ for prop in props:
+ props[prop] = group_cat(ungroup_cat(props[prop]))
+
+ return props
+
+def escape_char(c):
+ return "'\\u{%x}'" % c
+
+def emit_table(f, name, t_data, t_type = "&'static [(char, char)]", is_pub=True,
+ pfun=lambda x: "(%s,%s)" % (escape_char(x[0]), escape_char(x[1])), is_const=True):
+ pub_string = "const"
+ if not is_const:
+ pub_string = "let"
+ if is_pub:
+ pub_string = "pub " + pub_string
+ f.write(" %s %s: %s = &[\n" % (pub_string, name, t_type))
+ data = ""
+ first = True
+ for dat in t_data:
+ if not first:
+ data += ","
+ first = False
+ data += pfun(dat)
+ format_table_content(f, data, 8)
+ f.write("\n ];\n\n")
+
+def emit_util_mod(f):
+ f.write("""
+pub mod util {
+ #[inline]
+ pub fn bsearch_range_table(c: char, r: &'static [(char,char)]) -> bool {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ r.binary_search_by(|&(lo,hi)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }).is_ok()
+ }
+
+ #[inline]
+ fn is_alphabetic(c: char) -> bool {
+ match c {
+ 'a' ..= 'z' | 'A' ..= 'Z' => true,
+ c if c > '\x7f' => super::derived_property::Alphabetic(c),
+ _ => false,
+ }
+ }
+
+ #[inline]
+ fn is_numeric(c: char) -> bool {
+ match c {
+ '0' ..= '9' => true,
+ c if c > '\x7f' => super::general_category::N(c),
+ _ => false,
+ }
+ }
+
+ #[inline]
+ pub fn is_alphanumeric(c: char) -> bool {
+ is_alphabetic(c) || is_numeric(c)
+ }
+}
+
+""")
+
+def emit_property_module(f, mod, tbl, emit):
+ f.write("mod %s {\n" % mod)
+ for cat in sorted(emit):
+ emit_table(f, "%s_table" % cat, tbl[cat], is_pub=False)
+ f.write(" #[inline]\n")
+ f.write(" pub fn %s(c: char) -> bool {\n" % cat)
+ f.write(" super::util::bsearch_range_table(c, %s_table)\n" % cat)
+ f.write(" }\n\n")
+ f.write("}\n\n")
+
+def emit_break_module(f, break_table, break_cats, name):
+ Name = name.capitalize()
+ f.write("""pub mod %s {
+ use core::result::Result::{Ok, Err};
+
+ pub use self::%sCat::*;
+
+ #[allow(non_camel_case_types)]
+ #[derive(Clone, Copy, PartialEq, Eq, Debug)]
+ pub enum %sCat {
+""" % (name, Name, Name))
+
+ # We don't want the lookup table to be too large so choose a reasonable
+ # cutoff. 0x20000 is selected because most of the range table entries are
+ # within the interval of [0x0, 0x20000]
+ lookup_value_cutoff = 0x20000
+
+ # Length of lookup table. It has to be a divisor of `lookup_value_cutoff`.
+ lookup_table_len = 0x400
+
+ lookup_interval = round(lookup_value_cutoff / lookup_table_len)
+
+ # Lookup table is a mapping from `character code / lookup_interval` to
+ # the index in the range table that covers the `character code`.
+ lookup_table = [0] * lookup_table_len
+ j = 0
+ for i in range(0, lookup_table_len):
+ lookup_from = i * lookup_interval
+ while j < len(break_table):
+ (_, entry_to, _) = break_table[j]
+ if entry_to >= lookup_from:
+ break
+ j += 1
+ lookup_table[i] = j
+
+ break_cats.append("Any")
+ break_cats.sort()
+ for cat in break_cats:
+ f.write((" %sC_" % Name[0]) + cat + ",\n")
+ f.write(""" }
+
+ fn bsearch_range_value_table(c: char, r: &'static [(char, char, %sCat)], default_lower: u32, default_upper: u32) -> (u32, u32, %sCat) {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }) {
+ Ok(idx) => {
+ let (lower, upper, cat) = r[idx];
+ (lower as u32, upper as u32, cat)
+ }
+ Err(idx) => {
+ (
+ if idx > 0 { r[idx-1].1 as u32 + 1 } else { default_lower },
+ r.get(idx).map(|c|c.0 as u32 - 1).unwrap_or(default_upper),
+ %sC_Any,
+ )
+ }
+ }
+ }
+
+ pub fn %s_category(c: char) -> (u32, u32, %sCat) {
+ // Perform a quick O(1) lookup in a precomputed table to determine
+ // the slice of the range table to search in.
+ let lookup_interval = 0x%x;
+ let idx = (c as u32 / lookup_interval) as usize;
+ let range = %s_cat_lookup.get(idx..(idx + 2)).map_or(
+ // If the `idx` is outside of the precomputed table - use the slice
+ // starting from the last covered index in the precomputed table and
+ // ending with the length of the range table.
+ %d..%d,
+ |r| (r[0] as usize)..((r[1] + 1) as usize)
+ );
+
+ // Compute pessimistic default lower and upper bounds on the category.
+ // If character doesn't map to any range and there is no adjacent range
+ // in the table slice - these bounds has to apply.
+ let lower = idx as u32 * lookup_interval;
+ let upper = lower + lookup_interval - 1;
+ bsearch_range_value_table(c, &%s_cat_table[range], lower, upper)
+ }
+
+""" % (Name, Name, Name[0], name, Name, lookup_interval, name, j, len(break_table), name))
+
+
+ if len(break_table) <= 0xff:
+ lookup_type = "u8"
+ elif len(break_table) <= 0xffff:
+ lookup_type = "u16"
+ else:
+ lookup_type = "u32"
+
+ emit_table(f, "%s_cat_lookup" % name, lookup_table, "&'static [%s]" % lookup_type,
+ pfun=lambda x: "%d" % x,
+ is_pub=False, is_const=True)
+
+ emit_table(f, "%s_cat_table" % name, break_table, "&'static [(char, char, %sCat)]" % Name,
+ pfun=lambda x: "(%s,%s,%sC_%s)" % (escape_char(x[0]), escape_char(x[1]), Name[0], x[2]),
+ is_pub=False, is_const=True)
+ f.write("}\n")
+
+if __name__ == "__main__":
+ r = "tables.rs"
+ if os.path.exists(r):
+ os.remove(r)
+ with open(r, "w") as rf:
+ # write the file's preamble
+ rf.write(preamble)
+ rf.write("""
+/// The version of [Unicode](http://www.unicode.org/)
+/// that this version of unicode-segmentation is based on.
+pub const UNICODE_VERSION: (u64, u64, u64) = (%s, %s, %s);
+""" % UNICODE_VERSION)
+
+ # download and parse all the data
+ gencats = load_gencats("UnicodeData.txt")
+ derived = load_properties("DerivedCoreProperties.txt", ["Alphabetic"])
+
+ emit_util_mod(rf)
+ for (name, cat, pfuns) in ("general_category", gencats, ["N"]), \
+ ("derived_property", derived, ["Alphabetic"]):
+ emit_property_module(rf, name, cat, pfuns)
+
+ ### grapheme cluster module
+ # from http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Break_Property_Values
+ grapheme_cats = load_properties("auxiliary/GraphemeBreakProperty.txt", [])
+
+ # Control
+ # Note:
+ # This category also includes Cs (surrogate codepoints), but Rust's `char`s are
+ # Unicode Scalar Values only, and surrogates are thus invalid `char`s.
+ # Thus, we have to remove Cs from the Control category
+ grapheme_cats["Control"] = group_cat(list(
+ set(ungroup_cat(grapheme_cats["Control"]))
+ - set(ungroup_cat([surrogate_codepoints]))))
+
+ grapheme_table = []
+ for cat in grapheme_cats:
+ grapheme_table.extend([(x, y, cat) for (x, y) in grapheme_cats[cat]])
+ emoji_props = load_properties("emoji-data.txt", ["Extended_Pictographic"])
+ grapheme_table.extend([(x, y, "Extended_Pictographic") for (x, y) in emoji_props["Extended_Pictographic"]])
+ grapheme_table.sort(key=lambda w: w[0])
+ last = -1
+ for chars in grapheme_table:
+ if chars[0] <= last:
+ raise "Grapheme tables and Extended_Pictographic values overlap; need to store these separately!"
+ last = chars[1]
+ emit_break_module(rf, grapheme_table, list(grapheme_cats.keys()) + ["Extended_Pictographic"], "grapheme")
+ rf.write("\n")
+
+ word_cats = load_properties("auxiliary/WordBreakProperty.txt", [])
+ word_table = []
+ for cat in word_cats:
+ word_table.extend([(x, y, cat) for (x, y) in word_cats[cat]])
+ word_table.sort(key=lambda w: w[0])
+ emit_break_module(rf, word_table, list(word_cats.keys()), "word")
+
+ # There are some emoji which are also ALetter, so this needs to be stored separately
+ # For efficiency, we could still merge the two tables and produce an ALetterEP state
+ emoji_table = [(x, y, "Extended_Pictographic") for (x, y) in emoji_props["Extended_Pictographic"]]
+ emit_break_module(rf, emoji_table, ["Extended_Pictographic"], "emoji")
+
+ sentence_cats = load_properties("auxiliary/SentenceBreakProperty.txt", [])
+ sentence_table = []
+ for cat in sentence_cats:
+ sentence_table.extend([(x, y, cat) for (x, y) in sentence_cats[cat]])
+ sentence_table.sort(key=lambda w: w[0])
+ emit_break_module(rf, sentence_table, list(sentence_cats.keys()), "sentence")
diff --git a/crates/unicode-segmentation/scripts/unicode_gen_breaktests.py b/crates/unicode-segmentation/scripts/unicode_gen_breaktests.py
new file mode 100755
index 0000000..113afa9
--- /dev/null
+++ b/crates/unicode-segmentation/scripts/unicode_gen_breaktests.py
@@ -0,0 +1,212 @@
+#!/usr/bin/env python
+# -*- coding: utf-8
+#
+# Copyright 2015 The Rust Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution and at
+# http://rust-lang.org/COPYRIGHT.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# This script uses the following Unicode tables:
+# - auxiliary/GraphemeBreakTest.txt
+# - auxiliary/WordBreakTest.txt
+#
+# Since this should not require frequent updates, we just store this
+# out-of-line and check the unicode.rs file into git.
+from __future__ import print_function
+
+import unicode, re, os, fileinput
+
+def load_test_data(f, optsplit=[]):
+ testRe1 = re.compile(r"^÷\s+([^\s].*[^\s])\s+÷\s+#\s+÷\s+\[0.2\].*?([÷×].*)\s+÷\s+\[0.3\]\s*$")
+
+ unicode.fetch(f)
+ data = []
+ for line in fileinput.input(os.path.basename(f)):
+ # lines that include a test start with the ÷ character
+ if len(line) < 2 or not line.startswith('÷'):
+ continue
+
+ m = testRe1.match(line)
+ if not m:
+ print("error: no match on line where test was expected: %s" % line)
+ continue
+
+ # process the characters in this test case
+ chars = process_split_string(m.group(1))
+ # skip test case if it contains invalid characters (viz., surrogates)
+ if not chars:
+ continue
+
+ # now process test cases
+ (chars, info) = process_split_info(m.group(2), chars, optsplit)
+
+ # make sure that we have break info for each break!
+ assert len(chars) - 1 == len(info)
+
+ data.append((chars, info))
+
+ return data
+
+def process_split_info(s, c, o):
+ outcs = []
+ outis = []
+ workcs = c.pop(0)
+
+ # are we on a × or a ÷?
+ isX = False
+ if s.startswith('×'):
+ isX = True
+
+ # find each instance of '(÷|×) [x.y] '
+ while s:
+ # find the currently considered rule number
+ sInd = s.index('[') + 1
+ eInd = s.index(']')
+
+ # if it's '× [a.b]' where 'a.b' is in o, then
+ # we consider it a split even though it's not
+ # marked as one
+ # if it's ÷ then it's always a split
+ if not isX or s[sInd:eInd] in o:
+ outis.append(s[sInd:eInd])
+ outcs.append(workcs)
+ workcs = c.pop(0)
+ else:
+ workcs.extend(c.pop(0))
+
+ idx = 1
+ while idx < len(s):
+ if s[idx:].startswith('×'):
+ isX = True
+ break
+ if s[idx:].startswith('÷'):
+ isX = False
+ break
+ idx += 1
+ s = s[idx:]
+
+ outcs.append(workcs)
+ return (outcs, outis)
+
+def process_split_string(s):
+ outls = []
+ workls = []
+
+ inls = s.split()
+
+ for i in inls:
+ if i == '÷' or i == '×':
+ outls.append(workls)
+ workls = []
+ continue
+
+ ival = int(i,16)
+
+ if unicode.is_surrogate(ival):
+ return []
+
+ workls.append(ival)
+
+ if workls:
+ outls.append(workls)
+
+ return outls
+
+def showfun(x):
+ outstr = '("'
+ for c in x[0]:
+ outstr += "\\u{%x}" % c
+ outstr += '",&['
+ xfirst = True
+ for xx in x[1:]:
+ if not xfirst:
+ outstr += '],&['
+ xfirst = False
+ sfirst = True
+ for sp in xx:
+ if not sfirst:
+ outstr += ','
+ sfirst = False
+ outstr += '"'
+ for c in sp:
+ outstr += "\\u{%x}" % c
+ outstr += '"'
+ outstr += '])'
+ return outstr
+
+def create_grapheme_data(f):
+ # rules 9.1 and 9.2 are for extended graphemes only
+ optsplits = ['9.1','9.2']
+ d = load_test_data("auxiliary/GraphemeBreakTest.txt", optsplits)
+
+ test_same = []
+ test_diff = []
+
+ for (c, i) in d:
+ allchars = [cn for s in c for cn in s]
+ extgraphs = []
+ extwork = []
+
+ extwork.extend(c[0])
+ for n in range(0,len(i)):
+ if i[n] in optsplits:
+ extwork.extend(c[n+1])
+ else:
+ extgraphs.append(extwork)
+ extwork = []
+ extwork.extend(c[n+1])
+
+ # these are the extended grapheme clusters
+ extgraphs.append(extwork)
+
+ if extgraphs == c:
+ test_same.append((allchars, c))
+ else:
+ test_diff.append((allchars, extgraphs, c))
+
+ stype = "&'static [(&'static str, &'static [&'static str])]"
+ dtype = "&'static [(&'static str, &'static [&'static str], &'static [&'static str])]"
+ f.write(" // official Unicode test data\n")
+ f.write(" // http://www.unicode.org/Public/%s/ucd/auxiliary/GraphemeBreakTest.txt\n" % unicode.UNICODE_VERSION_NUMBER)
+ unicode.emit_table(f, "TEST_SAME", test_same, stype, True, showfun, True)
+ unicode.emit_table(f, "TEST_DIFF", test_diff, dtype, True, showfun, True)
+
+def create_words_data(f):
+ d = load_test_data("auxiliary/WordBreakTest.txt")
+
+ test = []
+
+ for (c, i) in d:
+ allchars = [cn for s in c for cn in s]
+ test.append((allchars, c))
+
+ wtype = "&'static [(&'static str, &'static [&'static str])]"
+ f.write(" // official Unicode test data\n")
+ f.write(" // http://www.unicode.org/Public/%s/ucd/auxiliary/WordBreakTest.txt\n" % unicode.UNICODE_VERSION_NUMBER)
+ unicode.emit_table(f, "TEST_WORD", test, wtype, True, showfun, True)
+
+def create_sentence_data(f):
+ d = load_test_data("auxiliary/SentenceBreakTest.txt")
+
+ test = []
+
+ for (c, i) in d:
+ allchars = [cn for s in c for cn in s]
+ test.append((allchars, c))
+
+ wtype = "&'static [(&'static str, &'static [&'static str])]"
+ f.write(" // official Unicode test data\n")
+ f.write(" // http://www.unicode.org/Public/%s/ucd/auxiliary/SentenceBreakTest.txt\n" % unicode.UNICODE_VERSION_NUMBER)
+ unicode.emit_table(f, "TEST_SENTENCE", test, wtype, True, showfun, True)
+
+if __name__ == "__main__":
+ with open("testdata.rs", "w") as rf:
+ rf.write(unicode.preamble)
+ create_grapheme_data(rf)
+ create_words_data(rf)
+ create_sentence_data(rf)
diff --git a/crates/unicode-segmentation/src/grapheme.rs b/crates/unicode-segmentation/src/grapheme.rs
new file mode 100644
index 0000000..eb554c9
--- /dev/null
+++ b/crates/unicode-segmentation/src/grapheme.rs
@@ -0,0 +1,801 @@
+// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use core::cmp;
+
+use crate::tables::grapheme::GraphemeCat;
+
+/// External iterator for grapheme clusters and byte offsets.
+///
+/// This struct is created by the [`grapheme_indices`] method on the [`UnicodeSegmentation`]
+/// trait. See its documentation for more.
+///
+/// [`grapheme_indices`]: trait.UnicodeSegmentation.html#tymethod.grapheme_indices
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct GraphemeIndices<'a> {
+ start_offset: usize,
+ iter: Graphemes<'a>,
+}
+
+impl<'a> GraphemeIndices<'a> {
+ #[inline]
+ /// View the underlying data (the part yet to be iterated) as a slice of the original string.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::UnicodeSegmentation;
+ /// let mut iter = "abc".grapheme_indices(true);
+ /// assert_eq!(iter.as_str(), "abc");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "bc");
+ /// iter.next();
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "");
+ /// ```
+ pub fn as_str(&self) -> &'a str {
+ self.iter.as_str()
+ }
+}
+
+impl<'a> Iterator for GraphemeIndices<'a> {
+ type Item = (usize, &'a str);
+
+ #[inline]
+ fn next(&mut self) -> Option<(usize, &'a str)> {
+ self.iter
+ .next()
+ .map(|s| (s.as_ptr() as usize - self.start_offset, s))
+ }
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.iter.size_hint()
+ }
+}
+
+impl<'a> DoubleEndedIterator for GraphemeIndices<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<(usize, &'a str)> {
+ self.iter
+ .next_back()
+ .map(|s| (s.as_ptr() as usize - self.start_offset, s))
+ }
+}
+
+/// External iterator for a string's
+/// [grapheme clusters](http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries).
+///
+/// This struct is created by the [`graphemes`] method on the [`UnicodeSegmentation`] trait. See its
+/// documentation for more.
+///
+/// [`graphemes`]: trait.UnicodeSegmentation.html#tymethod.graphemes
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone, Debug)]
+pub struct Graphemes<'a> {
+ string: &'a str,
+ cursor: GraphemeCursor,
+ cursor_back: GraphemeCursor,
+}
+
+impl<'a> Graphemes<'a> {
+ #[inline]
+ /// View the underlying data (the part yet to be iterated) as a slice of the original string.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::UnicodeSegmentation;
+ /// let mut iter = "abc".graphemes(true);
+ /// assert_eq!(iter.as_str(), "abc");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "bc");
+ /// iter.next();
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "");
+ /// ```
+ pub fn as_str(&self) -> &'a str {
+ &self.string[self.cursor.cur_cursor()..self.cursor_back.cur_cursor()]
+ }
+}
+
+impl<'a> Iterator for Graphemes<'a> {
+ type Item = &'a str;
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let slen = self.cursor_back.cur_cursor() - self.cursor.cur_cursor();
+ (cmp::min(slen, 1), Some(slen))
+ }
+
+ #[inline]
+ fn next(&mut self) -> Option<&'a str> {
+ let start = self.cursor.cur_cursor();
+ if start == self.cursor_back.cur_cursor() {
+ return None;
+ }
+ let next = self.cursor.next_boundary(self.string, 0).unwrap().unwrap();
+ Some(&self.string[start..next])
+ }
+}
+
+impl<'a> DoubleEndedIterator for Graphemes<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<&'a str> {
+ let end = self.cursor_back.cur_cursor();
+ if end == self.cursor.cur_cursor() {
+ return None;
+ }
+ let prev = self
+ .cursor_back
+ .prev_boundary(self.string, 0)
+ .unwrap()
+ .unwrap();
+ Some(&self.string[prev..end])
+ }
+}
+
+#[inline]
+pub fn new_graphemes<'b>(s: &'b str, is_extended: bool) -> Graphemes<'b> {
+ let len = s.len();
+ Graphemes {
+ string: s,
+ cursor: GraphemeCursor::new(0, len, is_extended),
+ cursor_back: GraphemeCursor::new(len, len, is_extended),
+ }
+}
+
+#[inline]
+pub fn new_grapheme_indices<'b>(s: &'b str, is_extended: bool) -> GraphemeIndices<'b> {
+ GraphemeIndices {
+ start_offset: s.as_ptr() as usize,
+ iter: new_graphemes(s, is_extended),
+ }
+}
+
+// maybe unify with PairResult?
+// An enum describing information about a potential boundary.
+#[derive(PartialEq, Eq, Clone, Debug)]
+enum GraphemeState {
+ // No information is known.
+ Unknown,
+ // It is known to not be a boundary.
+ NotBreak,
+ // It is known to be a boundary.
+ Break,
+ // The codepoint after is a Regional Indicator Symbol, so a boundary iff
+ // it is preceded by an even number of RIS codepoints. (GB12, GB13)
+ Regional,
+ // The codepoint after is Extended_Pictographic,
+ // so whether it's a boundary depends on pre-context according to GB11.
+ Emoji,
+}
+
+/// Cursor-based segmenter for grapheme clusters.
+///
+/// This allows working with ropes and other datastructures where the string is not contiguous or
+/// fully known at initialization time.
+#[derive(Clone, Debug)]
+pub struct GraphemeCursor {
+ // Current cursor position.
+ offset: usize,
+ // Total length of the string.
+ len: usize,
+ // A config flag indicating whether this cursor computes legacy or extended
+ // grapheme cluster boundaries (enables GB9a and GB9b if set).
+ is_extended: bool,
+ // Information about the potential boundary at `offset`
+ state: GraphemeState,
+ // Category of codepoint immediately preceding cursor, if known.
+ cat_before: Option<GraphemeCat>,
+ // Category of codepoint immediately after cursor, if known.
+ cat_after: Option<GraphemeCat>,
+ // If set, at least one more codepoint immediately preceding this offset
+ // is needed to resolve whether there's a boundary at `offset`.
+ pre_context_offset: Option<usize>,
+ // The number of RIS codepoints preceding `offset`. If `pre_context_offset`
+ // is set, then counts the number of RIS between that and `offset`, otherwise
+ // is an accurate count relative to the string.
+ ris_count: Option<usize>,
+ // Set if a call to `prev_boundary` or `next_boundary` was suspended due
+ // to needing more input.
+ resuming: bool,
+ // Cached grapheme category and associated scalar value range.
+ grapheme_cat_cache: (u32, u32, GraphemeCat),
+}
+
+/// An error return indicating that not enough content was available in the
+/// provided chunk to satisfy the query, and that more content must be provided.
+#[derive(PartialEq, Eq, Debug)]
+pub enum GraphemeIncomplete {
+ /// More pre-context is needed. The caller should call `provide_context`
+ /// with a chunk ending at the offset given, then retry the query. This
+ /// will only be returned if the `chunk_start` parameter is nonzero.
+ PreContext(usize),
+
+ /// When requesting `prev_boundary`, the cursor is moving past the beginning
+ /// of the current chunk, so the chunk before that is requested. This will
+ /// only be returned if the `chunk_start` parameter is nonzero.
+ PrevChunk,
+
+ /// When requesting `next_boundary`, the cursor is moving past the end of the
+ /// current chunk, so the chunk after that is requested. This will only be
+ /// returned if the chunk ends before the `len` parameter provided on
+ /// creation of the cursor.
+ NextChunk, // requesting chunk following the one given
+
+ /// An error returned when the chunk given does not contain the cursor position.
+ InvalidOffset,
+}
+
+// An enum describing the result from lookup of a pair of categories.
+#[derive(PartialEq, Eq)]
+enum PairResult {
+ NotBreak, // definitely not a break
+ Break, // definitely a break
+ Extended, // a break iff not in extended mode
+ Regional, // a break if preceded by an even number of RIS
+ Emoji, // a break if preceded by emoji base and (Extend)*
+}
+
+#[inline]
+fn check_pair(before: GraphemeCat, after: GraphemeCat) -> PairResult {
+ use self::PairResult::*;
+ use crate::tables::grapheme::GraphemeCat::*;
+ match (before, after) {
+ (GC_CR, GC_LF) => NotBreak, // GB3
+ (GC_Control, _) => Break, // GB4
+ (GC_CR, _) => Break, // GB4
+ (GC_LF, _) => Break, // GB4
+ (_, GC_Control) => Break, // GB5
+ (_, GC_CR) => Break, // GB5
+ (_, GC_LF) => Break, // GB5
+ (GC_L, GC_L) => NotBreak, // GB6
+ (GC_L, GC_V) => NotBreak, // GB6
+ (GC_L, GC_LV) => NotBreak, // GB6
+ (GC_L, GC_LVT) => NotBreak, // GB6
+ (GC_LV, GC_V) => NotBreak, // GB7
+ (GC_LV, GC_T) => NotBreak, // GB7
+ (GC_V, GC_V) => NotBreak, // GB7
+ (GC_V, GC_T) => NotBreak, // GB7
+ (GC_LVT, GC_T) => NotBreak, // GB8
+ (GC_T, GC_T) => NotBreak, // GB8
+ (_, GC_Extend) => NotBreak, // GB9
+ (_, GC_ZWJ) => NotBreak, // GB9
+ (_, GC_SpacingMark) => Extended, // GB9a
+ (GC_Prepend, _) => Extended, // GB9b
+ (GC_ZWJ, GC_Extended_Pictographic) => Emoji, // GB11
+ (GC_Regional_Indicator, GC_Regional_Indicator) => Regional, // GB12, GB13
+ (_, _) => Break, // GB999
+ }
+}
+
+impl GraphemeCursor {
+ /// Create a new cursor. The string and initial offset are given at creation
+ /// time, but the contents of the string are not. The `is_extended` parameter
+ /// controls whether extended grapheme clusters are selected.
+ ///
+ /// The `offset` parameter must be on a codepoint boundary.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// let s = "हिन्दी";
+ /// let mut legacy = GraphemeCursor::new(0, s.len(), false);
+ /// assert_eq!(legacy.next_boundary(s, 0), Ok(Some("ह".len())));
+ /// let mut extended = GraphemeCursor::new(0, s.len(), true);
+ /// assert_eq!(extended.next_boundary(s, 0), Ok(Some("हि".len())));
+ /// ```
+ pub fn new(offset: usize, len: usize, is_extended: bool) -> GraphemeCursor {
+ let state = if offset == 0 || offset == len {
+ GraphemeState::Break
+ } else {
+ GraphemeState::Unknown
+ };
+ GraphemeCursor {
+ offset: offset,
+ len: len,
+ state: state,
+ is_extended: is_extended,
+ cat_before: None,
+ cat_after: None,
+ pre_context_offset: None,
+ ris_count: None,
+ resuming: false,
+ grapheme_cat_cache: (0, 0, GraphemeCat::GC_Control),
+ }
+ }
+
+ fn grapheme_category(&mut self, ch: char) -> GraphemeCat {
+ use crate::tables::grapheme as gr;
+ use crate::tables::grapheme::GraphemeCat::*;
+
+ if ch <= '\u{7e}' {
+ // Special-case optimization for ascii, except U+007F. This
+ // improves performance even for many primarily non-ascii texts,
+ // due to use of punctuation and white space characters from the
+ // ascii range.
+ if ch >= '\u{20}' {
+ GC_Any
+ } else if ch == '\n' {
+ GC_LF
+ } else if ch == '\r' {
+ GC_CR
+ } else {
+ GC_Control
+ }
+ } else {
+ // If this char isn't within the cached range, update the cache to the
+ // range that includes it.
+ if (ch as u32) < self.grapheme_cat_cache.0 || (ch as u32) > self.grapheme_cat_cache.1 {
+ self.grapheme_cat_cache = gr::grapheme_category(ch);
+ }
+ self.grapheme_cat_cache.2
+ }
+ }
+
+ // Not sure I'm gonna keep this, the advantage over new() seems thin.
+
+ /// Set the cursor to a new location in the same string.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// let s = "abcd";
+ /// let mut cursor = GraphemeCursor::new(0, s.len(), false);
+ /// assert_eq!(cursor.cur_cursor(), 0);
+ /// cursor.set_cursor(2);
+ /// assert_eq!(cursor.cur_cursor(), 2);
+ /// ```
+ pub fn set_cursor(&mut self, offset: usize) {
+ if offset != self.offset {
+ self.offset = offset;
+ self.state = if offset == 0 || offset == self.len {
+ GraphemeState::Break
+ } else {
+ GraphemeState::Unknown
+ };
+ // reset state derived from text around cursor
+ self.cat_before = None;
+ self.cat_after = None;
+ self.ris_count = None;
+ }
+ }
+
+ #[inline]
+ /// The current offset of the cursor. Equal to the last value provided to
+ /// `new()` or `set_cursor()`, or returned from `next_boundary()` or
+ /// `prev_boundary()`.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// // Two flags (🇷🇸🇮🇴), each flag is two RIS codepoints, each RIS is 4 bytes.
+ /// let flags = "\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}";
+ /// let mut cursor = GraphemeCursor::new(4, flags.len(), false);
+ /// assert_eq!(cursor.cur_cursor(), 4);
+ /// assert_eq!(cursor.next_boundary(flags, 0), Ok(Some(8)));
+ /// assert_eq!(cursor.cur_cursor(), 8);
+ /// ```
+ pub fn cur_cursor(&self) -> usize {
+ self.offset
+ }
+
+ /// Provide additional pre-context when it is needed to decide a boundary.
+ /// The end of the chunk must coincide with the value given in the
+ /// `GraphemeIncomplete::PreContext` request.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::{GraphemeCursor, GraphemeIncomplete};
+ /// let flags = "\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}";
+ /// let mut cursor = GraphemeCursor::new(8, flags.len(), false);
+ /// // Not enough pre-context to decide if there's a boundary between the two flags.
+ /// assert_eq!(cursor.is_boundary(&flags[8..], 8), Err(GraphemeIncomplete::PreContext(8)));
+ /// // Provide one more Regional Indicator Symbol of pre-context
+ /// cursor.provide_context(&flags[4..8], 4);
+ /// // Still not enough context to decide.
+ /// assert_eq!(cursor.is_boundary(&flags[8..], 8), Err(GraphemeIncomplete::PreContext(4)));
+ /// // Provide additional requested context.
+ /// cursor.provide_context(&flags[0..4], 0);
+ /// // That's enough to decide (it always is when context goes to the start of the string)
+ /// assert_eq!(cursor.is_boundary(&flags[8..], 8), Ok(true));
+ /// ```
+ pub fn provide_context(&mut self, chunk: &str, chunk_start: usize) {
+ use crate::tables::grapheme as gr;
+ assert!(chunk_start + chunk.len() == self.pre_context_offset.unwrap());
+ self.pre_context_offset = None;
+ if self.is_extended && chunk_start + chunk.len() == self.offset {
+ let ch = chunk.chars().rev().next().unwrap();
+ if self.grapheme_category(ch) == gr::GC_Prepend {
+ self.decide(false); // GB9b
+ return;
+ }
+ }
+ match self.state {
+ GraphemeState::Regional => self.handle_regional(chunk, chunk_start),
+ GraphemeState::Emoji => self.handle_emoji(chunk, chunk_start),
+ _ => {
+ if self.cat_before.is_none() && self.offset == chunk.len() + chunk_start {
+ let ch = chunk.chars().rev().next().unwrap();
+ self.cat_before = Some(self.grapheme_category(ch));
+ }
+ }
+ }
+ }
+
+ #[inline]
+ fn decide(&mut self, is_break: bool) {
+ self.state = if is_break {
+ GraphemeState::Break
+ } else {
+ GraphemeState::NotBreak
+ };
+ }
+
+ #[inline]
+ fn decision(&mut self, is_break: bool) -> Result<bool, GraphemeIncomplete> {
+ self.decide(is_break);
+ Ok(is_break)
+ }
+
+ #[inline]
+ fn is_boundary_result(&self) -> Result<bool, GraphemeIncomplete> {
+ if self.state == GraphemeState::Break {
+ Ok(true)
+ } else if self.state == GraphemeState::NotBreak {
+ Ok(false)
+ } else if let Some(pre_context_offset) = self.pre_context_offset {
+ Err(GraphemeIncomplete::PreContext(pre_context_offset))
+ } else {
+ unreachable!("inconsistent state");
+ }
+ }
+
+ #[inline]
+ fn handle_regional(&mut self, chunk: &str, chunk_start: usize) {
+ use crate::tables::grapheme as gr;
+ let mut ris_count = self.ris_count.unwrap_or(0);
+ for ch in chunk.chars().rev() {
+ if self.grapheme_category(ch) != gr::GC_Regional_Indicator {
+ self.ris_count = Some(ris_count);
+ self.decide((ris_count % 2) == 0);
+ return;
+ }
+ ris_count += 1;
+ }
+ self.ris_count = Some(ris_count);
+ if chunk_start == 0 {
+ self.decide((ris_count % 2) == 0);
+ return;
+ }
+ self.pre_context_offset = Some(chunk_start);
+ self.state = GraphemeState::Regional;
+ }
+
+ #[inline]
+ fn handle_emoji(&mut self, chunk: &str, chunk_start: usize) {
+ use crate::tables::grapheme as gr;
+ let mut iter = chunk.chars().rev();
+ if let Some(ch) = iter.next() {
+ if self.grapheme_category(ch) != gr::GC_ZWJ {
+ self.decide(true);
+ return;
+ }
+ }
+ for ch in iter {
+ match self.grapheme_category(ch) {
+ gr::GC_Extend => (),
+ gr::GC_Extended_Pictographic => {
+ self.decide(false);
+ return;
+ }
+ _ => {
+ self.decide(true);
+ return;
+ }
+ }
+ }
+ if chunk_start == 0 {
+ self.decide(true);
+ return;
+ }
+ self.pre_context_offset = Some(chunk_start);
+ self.state = GraphemeState::Emoji;
+ }
+
+ #[inline]
+ /// Determine whether the current cursor location is a grapheme cluster boundary.
+ /// Only a part of the string need be supplied. If `chunk_start` is nonzero or
+ /// the length of `chunk` is not equal to `len` on creation, then this method
+ /// may return `GraphemeIncomplete::PreContext`. The caller should then
+ /// call `provide_context` with the requested chunk, then retry calling this
+ /// method.
+ ///
+ /// For partial chunks, if the cursor is not at the beginning or end of the
+ /// string, the chunk should contain at least the codepoint following the cursor.
+ /// If the string is nonempty, the chunk must be nonempty.
+ ///
+ /// All calls should have consistent chunk contents (ie, if a chunk provides
+ /// content for a given slice, all further chunks covering that slice must have
+ /// the same content for it).
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// let flags = "\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}";
+ /// let mut cursor = GraphemeCursor::new(8, flags.len(), false);
+ /// assert_eq!(cursor.is_boundary(flags, 0), Ok(true));
+ /// cursor.set_cursor(12);
+ /// assert_eq!(cursor.is_boundary(flags, 0), Ok(false));
+ /// ```
+ pub fn is_boundary(
+ &mut self,
+ chunk: &str,
+ chunk_start: usize,
+ ) -> Result<bool, GraphemeIncomplete> {
+ use crate::tables::grapheme as gr;
+ if self.state == GraphemeState::Break {
+ return Ok(true);
+ }
+ if self.state == GraphemeState::NotBreak {
+ return Ok(false);
+ }
+ if self.offset < chunk_start || self.offset >= chunk_start + chunk.len() {
+ if self.offset > chunk_start + chunk.len() || self.cat_after.is_none() {
+ return Err(GraphemeIncomplete::InvalidOffset);
+ }
+ }
+ if let Some(pre_context_offset) = self.pre_context_offset {
+ return Err(GraphemeIncomplete::PreContext(pre_context_offset));
+ }
+ let offset_in_chunk = self.offset - chunk_start;
+ if self.cat_after.is_none() {
+ let ch = chunk[offset_in_chunk..].chars().next().unwrap();
+ self.cat_after = Some(self.grapheme_category(ch));
+ }
+ if self.offset == chunk_start {
+ let mut need_pre_context = true;
+ match self.cat_after.unwrap() {
+ gr::GC_Regional_Indicator => self.state = GraphemeState::Regional,
+ gr::GC_Extended_Pictographic => self.state = GraphemeState::Emoji,
+ _ => need_pre_context = self.cat_before.is_none(),
+ }
+ if need_pre_context {
+ self.pre_context_offset = Some(chunk_start);
+ return Err(GraphemeIncomplete::PreContext(chunk_start));
+ }
+ }
+ if self.cat_before.is_none() {
+ let ch = chunk[..offset_in_chunk].chars().rev().next().unwrap();
+ self.cat_before = Some(self.grapheme_category(ch));
+ }
+ match check_pair(self.cat_before.unwrap(), self.cat_after.unwrap()) {
+ PairResult::NotBreak => return self.decision(false),
+ PairResult::Break => return self.decision(true),
+ PairResult::Extended => {
+ let is_extended = self.is_extended;
+ return self.decision(!is_extended);
+ }
+ PairResult::Regional => {
+ if let Some(ris_count) = self.ris_count {
+ return self.decision((ris_count % 2) == 0);
+ }
+ self.handle_regional(&chunk[..offset_in_chunk], chunk_start);
+ self.is_boundary_result()
+ }
+ PairResult::Emoji => {
+ self.handle_emoji(&chunk[..offset_in_chunk], chunk_start);
+ self.is_boundary_result()
+ }
+ }
+ }
+
+ #[inline]
+ /// Find the next boundary after the current cursor position. Only a part of
+ /// the string need be supplied. If the chunk is incomplete, then this
+ /// method might return `GraphemeIncomplete::PreContext` or
+ /// `GraphemeIncomplete::NextChunk`. In the former case, the caller should
+ /// call `provide_context` with the requested chunk, then retry. In the
+ /// latter case, the caller should provide the chunk following the one
+ /// given, then retry.
+ ///
+ /// See `is_boundary` for expectations on the provided chunk.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// let flags = "\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}";
+ /// let mut cursor = GraphemeCursor::new(4, flags.len(), false);
+ /// assert_eq!(cursor.next_boundary(flags, 0), Ok(Some(8)));
+ /// assert_eq!(cursor.next_boundary(flags, 0), Ok(Some(16)));
+ /// assert_eq!(cursor.next_boundary(flags, 0), Ok(None));
+ /// ```
+ ///
+ /// And an example that uses partial strings:
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::{GraphemeCursor, GraphemeIncomplete};
+ /// let s = "abcd";
+ /// let mut cursor = GraphemeCursor::new(0, s.len(), false);
+ /// assert_eq!(cursor.next_boundary(&s[..2], 0), Ok(Some(1)));
+ /// assert_eq!(cursor.next_boundary(&s[..2], 0), Err(GraphemeIncomplete::NextChunk));
+ /// assert_eq!(cursor.next_boundary(&s[2..4], 2), Ok(Some(2)));
+ /// assert_eq!(cursor.next_boundary(&s[2..4], 2), Ok(Some(3)));
+ /// assert_eq!(cursor.next_boundary(&s[2..4], 2), Ok(Some(4)));
+ /// assert_eq!(cursor.next_boundary(&s[2..4], 2), Ok(None));
+ /// ```
+ pub fn next_boundary(
+ &mut self,
+ chunk: &str,
+ chunk_start: usize,
+ ) -> Result<Option<usize>, GraphemeIncomplete> {
+ if self.offset == self.len {
+ return Ok(None);
+ }
+ let mut iter = chunk[self.offset - chunk_start..].chars();
+ let mut ch = iter.next().unwrap();
+ loop {
+ if self.resuming {
+ if self.cat_after.is_none() {
+ self.cat_after = Some(self.grapheme_category(ch));
+ }
+ } else {
+ self.offset += ch.len_utf8();
+ self.state = GraphemeState::Unknown;
+ self.cat_before = self.cat_after.take();
+ if self.cat_before.is_none() {
+ self.cat_before = Some(self.grapheme_category(ch));
+ }
+ if self.cat_before.unwrap() == GraphemeCat::GC_Regional_Indicator {
+ self.ris_count = self.ris_count.map(|c| c + 1);
+ } else {
+ self.ris_count = Some(0);
+ }
+ if let Some(next_ch) = iter.next() {
+ ch = next_ch;
+ self.cat_after = Some(self.grapheme_category(ch));
+ } else if self.offset == self.len {
+ self.decide(true);
+ } else {
+ self.resuming = true;
+ return Err(GraphemeIncomplete::NextChunk);
+ }
+ }
+ self.resuming = true;
+ if self.is_boundary(chunk, chunk_start)? {
+ self.resuming = false;
+ return Ok(Some(self.offset));
+ }
+ self.resuming = false;
+ }
+ }
+
+ /// Find the previous boundary after the current cursor position. Only a part
+ /// of the string need be supplied. If the chunk is incomplete, then this
+ /// method might return `GraphemeIncomplete::PreContext` or
+ /// `GraphemeIncomplete::PrevChunk`. In the former case, the caller should
+ /// call `provide_context` with the requested chunk, then retry. In the
+ /// latter case, the caller should provide the chunk preceding the one
+ /// given, then retry.
+ ///
+ /// See `is_boundary` for expectations on the provided chunk.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::GraphemeCursor;
+ /// let flags = "\u{1F1F7}\u{1F1F8}\u{1F1EE}\u{1F1F4}";
+ /// let mut cursor = GraphemeCursor::new(12, flags.len(), false);
+ /// assert_eq!(cursor.prev_boundary(flags, 0), Ok(Some(8)));
+ /// assert_eq!(cursor.prev_boundary(flags, 0), Ok(Some(0)));
+ /// assert_eq!(cursor.prev_boundary(flags, 0), Ok(None));
+ /// ```
+ ///
+ /// And an example that uses partial strings (note the exact return is not
+ /// guaranteed, and may be `PrevChunk` or `PreContext` arbitrarily):
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::{GraphemeCursor, GraphemeIncomplete};
+ /// let s = "abcd";
+ /// let mut cursor = GraphemeCursor::new(4, s.len(), false);
+ /// assert_eq!(cursor.prev_boundary(&s[2..4], 2), Ok(Some(3)));
+ /// assert_eq!(cursor.prev_boundary(&s[2..4], 2), Err(GraphemeIncomplete::PrevChunk));
+ /// assert_eq!(cursor.prev_boundary(&s[0..2], 0), Ok(Some(2)));
+ /// assert_eq!(cursor.prev_boundary(&s[0..2], 0), Ok(Some(1)));
+ /// assert_eq!(cursor.prev_boundary(&s[0..2], 0), Ok(Some(0)));
+ /// assert_eq!(cursor.prev_boundary(&s[0..2], 0), Ok(None));
+ /// ```
+ pub fn prev_boundary(
+ &mut self,
+ chunk: &str,
+ chunk_start: usize,
+ ) -> Result<Option<usize>, GraphemeIncomplete> {
+ if self.offset == 0 {
+ return Ok(None);
+ }
+ if self.offset == chunk_start {
+ return Err(GraphemeIncomplete::PrevChunk);
+ }
+ let mut iter = chunk[..self.offset - chunk_start].chars().rev();
+ let mut ch = iter.next().unwrap();
+ loop {
+ if self.offset == chunk_start {
+ self.resuming = true;
+ return Err(GraphemeIncomplete::PrevChunk);
+ }
+ if self.resuming {
+ self.cat_before = Some(self.grapheme_category(ch));
+ } else {
+ self.offset -= ch.len_utf8();
+ self.cat_after = self.cat_before.take();
+ self.state = GraphemeState::Unknown;
+ if let Some(ris_count) = self.ris_count {
+ self.ris_count = if ris_count > 0 {
+ Some(ris_count - 1)
+ } else {
+ None
+ };
+ }
+ if let Some(prev_ch) = iter.next() {
+ ch = prev_ch;
+ self.cat_before = Some(self.grapheme_category(ch));
+ } else if self.offset == 0 {
+ self.decide(true);
+ } else {
+ self.resuming = true;
+ self.cat_after = Some(self.grapheme_category(ch));
+ return Err(GraphemeIncomplete::PrevChunk);
+ }
+ }
+ self.resuming = true;
+ if self.is_boundary(chunk, chunk_start)? {
+ self.resuming = false;
+ return Ok(Some(self.offset));
+ }
+ self.resuming = false;
+ }
+ }
+}
+
+#[test]
+fn test_grapheme_cursor_ris_precontext() {
+ let s = "\u{1f1fa}\u{1f1f8}\u{1f1fa}\u{1f1f8}\u{1f1fa}\u{1f1f8}";
+ let mut c = GraphemeCursor::new(8, s.len(), true);
+ assert_eq!(
+ c.is_boundary(&s[4..], 4),
+ Err(GraphemeIncomplete::PreContext(4))
+ );
+ c.provide_context(&s[..4], 0);
+ assert_eq!(c.is_boundary(&s[4..], 4), Ok(true));
+}
+
+#[test]
+fn test_grapheme_cursor_chunk_start_require_precontext() {
+ let s = "\r\n";
+ let mut c = GraphemeCursor::new(1, s.len(), true);
+ assert_eq!(
+ c.is_boundary(&s[1..], 1),
+ Err(GraphemeIncomplete::PreContext(1))
+ );
+ c.provide_context(&s[..1], 0);
+ assert_eq!(c.is_boundary(&s[1..], 1), Ok(false));
+}
+
+#[test]
+fn test_grapheme_cursor_prev_boundary() {
+ let s = "abcd";
+ let mut c = GraphemeCursor::new(3, s.len(), true);
+ assert_eq!(
+ c.prev_boundary(&s[2..], 2),
+ Err(GraphemeIncomplete::PrevChunk)
+ );
+ assert_eq!(c.prev_boundary(&s[..2], 0), Ok(Some(2)));
+}
+
+#[test]
+fn test_grapheme_cursor_prev_boundary_chunk_start() {
+ let s = "abcd";
+ let mut c = GraphemeCursor::new(2, s.len(), true);
+ assert_eq!(
+ c.prev_boundary(&s[2..], 2),
+ Err(GraphemeIncomplete::PrevChunk)
+ );
+ assert_eq!(c.prev_boundary(&s[..2], 0), Ok(Some(1)));
+}
diff --git a/crates/unicode-segmentation/src/lib.rs b/crates/unicode-segmentation/src/lib.rs
new file mode 100644
index 0000000..8c27fbb
--- /dev/null
+++ b/crates/unicode-segmentation/src/lib.rs
@@ -0,0 +1,307 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Iterators which split strings on Grapheme Cluster, Word or Sentence boundaries, according
+//! to the [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/) rules.
+//!
+//! ```rust
+//! extern crate unicode_segmentation;
+//!
+//! use unicode_segmentation::UnicodeSegmentation;
+//!
+//! fn main() {
+//! let s = "a̐éö̲\r\n";
+//! let g = UnicodeSegmentation::graphemes(s, true).collect::<Vec<&str>>();
+//! let b: &[_] = &["a̐", "é", "ö̲", "\r\n"];
+//! assert_eq!(g, b);
+//!
+//! let s = "The quick (\"brown\") fox can't jump 32.3 feet, right?";
+//! let w = s.unicode_words().collect::<Vec<&str>>();
+//! let b: &[_] = &["The", "quick", "brown", "fox", "can't", "jump", "32.3", "feet", "right"];
+//! assert_eq!(w, b);
+//!
+//! let s = "The quick (\"brown\") fox";
+//! let w = s.split_word_bounds().collect::<Vec<&str>>();
+//! let b: &[_] = &["The", " ", "quick", " ", "(", "\"", "brown", "\"", ")", " ", "fox"];
+//! assert_eq!(w, b);
+//! }
+//! ```
+//!
+//! # no_std
+//!
+//! unicode-segmentation does not depend on libstd, so it can be used in crates
+//! with the `#![no_std]` attribute.
+//!
+//! # crates.io
+//!
+//! You can use this package in your project by adding the following
+//! to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! unicode-segmentation = "1.9.0"
+//! ```
+
+#![deny(missing_docs, unsafe_code)]
+#![doc(
+ html_logo_url = "https://unicode-rs.github.io/unicode-rs_sm.png",
+ html_favicon_url = "https://unicode-rs.github.io/unicode-rs_sm.png"
+)]
+#![no_std]
+
+// ANDROID: Always import std to enable building as a dylib
+#[macro_use]
+extern crate std;
+
+#[cfg(test)]
+#[macro_use]
+extern crate quickcheck;
+
+pub use grapheme::{GraphemeCursor, GraphemeIncomplete};
+pub use grapheme::{GraphemeIndices, Graphemes};
+pub use sentence::{USentenceBoundIndices, USentenceBounds, UnicodeSentences};
+pub use tables::UNICODE_VERSION;
+pub use word::{UWordBoundIndices, UWordBounds, UnicodeWordIndices, UnicodeWords};
+
+mod grapheme;
+#[rustfmt::skip]
+mod tables;
+mod sentence;
+mod word;
+
+#[cfg(test)]
+mod test;
+#[cfg(test)]
+mod testdata;
+
+/// Methods for segmenting strings according to
+/// [Unicode Standard Annex #29](http://www.unicode.org/reports/tr29/).
+pub trait UnicodeSegmentation {
+ /// Returns an iterator over the [grapheme clusters][graphemes] of `self`.
+ ///
+ /// [graphemes]: http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries
+ ///
+ /// If `is_extended` is true, the iterator is over the
+ /// *extended grapheme clusters*;
+ /// otherwise, the iterator is over the *legacy grapheme clusters*.
+ /// [UAX#29](http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries)
+ /// recommends extended grapheme cluster boundaries for general processing.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let gr1 = UnicodeSegmentation::graphemes("a\u{310}e\u{301}o\u{308}\u{332}", true)
+ /// .collect::<Vec<&str>>();
+ /// let b: &[_] = &["a\u{310}", "e\u{301}", "o\u{308}\u{332}"];
+ ///
+ /// assert_eq!(&gr1[..], b);
+ ///
+ /// let gr2 = UnicodeSegmentation::graphemes("a\r\nb🇷🇺🇸🇹", true).collect::<Vec<&str>>();
+ /// let b: &[_] = &["a", "\r\n", "b", "🇷🇺", "🇸🇹"];
+ ///
+ /// assert_eq!(&gr2[..], b);
+ /// ```
+ fn graphemes<'a>(&'a self, is_extended: bool) -> Graphemes<'a>;
+
+ /// Returns an iterator over the grapheme clusters of `self` and their
+ /// byte offsets. See `graphemes()` for more information.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let gr_inds = UnicodeSegmentation::grapheme_indices("a̐éö̲\r\n", true)
+ /// .collect::<Vec<(usize, &str)>>();
+ /// let b: &[_] = &[(0, "a̐"), (3, "é"), (6, "ö̲"), (11, "\r\n")];
+ ///
+ /// assert_eq!(&gr_inds[..], b);
+ /// ```
+ fn grapheme_indices<'a>(&'a self, is_extended: bool) -> GraphemeIndices<'a>;
+
+ /// Returns an iterator over the words of `self`, separated on
+ /// [UAX#29 word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries).
+ ///
+ /// Here, "words" are just those substrings which, after splitting on
+ /// UAX#29 word boundaries, contain any alphanumeric characters. That is, the
+ /// substring must contain at least one character with the
+ /// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+ /// property, or with
+ /// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let uws = "The quick (\"brown\") fox can't jump 32.3 feet, right?";
+ /// let uw1 = uws.unicode_words().collect::<Vec<&str>>();
+ /// let b: &[_] = &["The", "quick", "brown", "fox", "can't", "jump", "32.3", "feet", "right"];
+ ///
+ /// assert_eq!(&uw1[..], b);
+ /// ```
+ fn unicode_words<'a>(&'a self) -> UnicodeWords<'a>;
+
+ /// Returns an iterator over the words of `self`, separated on
+ /// [UAX#29 word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries), and their
+ /// offsets.
+ ///
+ /// Here, "words" are just those substrings which, after splitting on
+ /// UAX#29 word boundaries, contain any alphanumeric characters. That is, the
+ /// substring must contain at least one character with the
+ /// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+ /// property, or with
+ /// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let uwis = "The quick (\"brown\") fox can't jump 32.3 feet, right?";
+ /// let uwi1 = uwis.unicode_word_indices().collect::<Vec<(usize, &str)>>();
+ /// let b: &[_] = &[(0, "The"), (4, "quick"), (12, "brown"), (20, "fox"), (24, "can't"),
+ /// (30, "jump"), (35, "32.3"), (40, "feet"), (46, "right")];
+ ///
+ /// assert_eq!(&uwi1[..], b);
+ /// ```
+ fn unicode_word_indices<'a>(&'a self) -> UnicodeWordIndices<'a>;
+
+ /// Returns an iterator over substrings of `self` separated on
+ /// [UAX#29 word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries).
+ ///
+ /// The concatenation of the substrings returned by this function is just the original string.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let swu1 = "The quick (\"brown\") fox".split_word_bounds().collect::<Vec<&str>>();
+ /// let b: &[_] = &["The", " ", "quick", " ", "(", "\"", "brown", "\"", ")", " ", "fox"];
+ ///
+ /// assert_eq!(&swu1[..], b);
+ /// ```
+ fn split_word_bounds<'a>(&'a self) -> UWordBounds<'a>;
+
+ /// Returns an iterator over substrings of `self`, split on UAX#29 word boundaries,
+ /// and their offsets. See `split_word_bounds()` for more information.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let swi1 = "Brr, it's 29.3°F!".split_word_bound_indices().collect::<Vec<(usize, &str)>>();
+ /// let b: &[_] = &[(0, "Brr"), (3, ","), (4, " "), (5, "it's"), (9, " "), (10, "29.3"),
+ /// (14, "°"), (16, "F"), (17, "!")];
+ ///
+ /// assert_eq!(&swi1[..], b);
+ /// ```
+ fn split_word_bound_indices<'a>(&'a self) -> UWordBoundIndices<'a>;
+
+ /// Returns an iterator over substrings of `self` separated on
+ /// [UAX#29 sentence boundaries](http://www.unicode.org/reports/tr29/#Sentence_Boundaries).
+ ///
+ /// Here, "sentences" are just those substrings which, after splitting on
+ /// UAX#29 sentence boundaries, contain any alphanumeric characters. That is, the
+ /// substring must contain at least one character with the
+ /// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+ /// property, or with
+ /// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let uss = "Mr. Fox jumped. [...] The dog was too lazy.";
+ /// let us1 = uss.unicode_sentences().collect::<Vec<&str>>();
+ /// let b: &[_] = &["Mr. ", "Fox jumped. ", "The dog was too lazy."];
+ ///
+ /// assert_eq!(&us1[..], b);
+ /// ```
+ fn unicode_sentences<'a>(&'a self) -> UnicodeSentences<'a>;
+
+ /// Returns an iterator over substrings of `self` separated on
+ /// [UAX#29 sentence boundaries](http://www.unicode.org/reports/tr29/#Sentence_Boundaries).
+ ///
+ /// The concatenation of the substrings returned by this function is just the original string.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let ssbs = "Mr. Fox jumped. [...] The dog was too lazy.";
+ /// let ssb1 = ssbs.split_sentence_bounds().collect::<Vec<&str>>();
+ /// let b: &[_] = &["Mr. ", "Fox jumped. ", "[...] ", "The dog was too lazy."];
+ ///
+ /// assert_eq!(&ssb1[..], b);
+ /// ```
+ fn split_sentence_bounds<'a>(&'a self) -> USentenceBounds<'a>;
+
+ /// Returns an iterator over substrings of `self`, split on UAX#29 sentence boundaries,
+ /// and their offsets. See `split_sentence_bounds()` for more information.
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// # use self::unicode_segmentation::UnicodeSegmentation;
+ /// let ssis = "Mr. Fox jumped. [...] The dog was too lazy.";
+ /// let ssi1 = ssis.split_sentence_bound_indices().collect::<Vec<(usize, &str)>>();
+ /// let b: &[_] = &[(0, "Mr. "), (4, "Fox jumped. "), (16, "[...] "),
+ /// (22, "The dog was too lazy.")];
+ ///
+ /// assert_eq!(&ssi1[..], b);
+ /// ```
+ fn split_sentence_bound_indices<'a>(&'a self) -> USentenceBoundIndices<'a>;
+}
+
+impl UnicodeSegmentation for str {
+ #[inline]
+ fn graphemes(&self, is_extended: bool) -> Graphemes {
+ grapheme::new_graphemes(self, is_extended)
+ }
+
+ #[inline]
+ fn grapheme_indices(&self, is_extended: bool) -> GraphemeIndices {
+ grapheme::new_grapheme_indices(self, is_extended)
+ }
+
+ #[inline]
+ fn unicode_words(&self) -> UnicodeWords {
+ word::new_unicode_words(self)
+ }
+
+ #[inline]
+ fn unicode_word_indices(&self) -> UnicodeWordIndices {
+ word::new_unicode_word_indices(self)
+ }
+
+ #[inline]
+ fn split_word_bounds(&self) -> UWordBounds {
+ word::new_word_bounds(self)
+ }
+
+ #[inline]
+ fn split_word_bound_indices(&self) -> UWordBoundIndices {
+ word::new_word_bound_indices(self)
+ }
+
+ #[inline]
+ fn unicode_sentences(&self) -> UnicodeSentences {
+ sentence::new_unicode_sentences(self)
+ }
+
+ #[inline]
+ fn split_sentence_bounds(&self) -> USentenceBounds {
+ sentence::new_sentence_bounds(self)
+ }
+
+ #[inline]
+ fn split_sentence_bound_indices(&self) -> USentenceBoundIndices {
+ sentence::new_sentence_bound_indices(self)
+ }
+}
diff --git a/crates/unicode-segmentation/src/sentence.rs b/crates/unicode-segmentation/src/sentence.rs
new file mode 100644
index 0000000..78d87b4
--- /dev/null
+++ b/crates/unicode-segmentation/src/sentence.rs
@@ -0,0 +1,415 @@
+// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use core::cmp;
+use core::iter::Filter;
+
+// All of the logic for forward iteration over sentences
+mod fwd {
+ use crate::tables::sentence::SentenceCat;
+ use core::cmp;
+
+ // Describe a parsed part of source string as described in this table:
+ // https://unicode.org/reports/tr29/#Default_Sentence_Boundaries
+ #[derive(Clone, Copy, PartialEq, Eq)]
+ enum StatePart {
+ Sot,
+ Eot,
+ Other,
+ CR,
+ LF,
+ Sep,
+ ATerm,
+ UpperLower,
+ ClosePlus,
+ SpPlus,
+ STerm,
+ }
+
+ #[derive(Clone, PartialEq, Eq)]
+ struct SentenceBreaksState(pub [StatePart; 4]);
+
+ const INITIAL_STATE: SentenceBreaksState = SentenceBreaksState([
+ StatePart::Sot,
+ StatePart::Sot,
+ StatePart::Sot,
+ StatePart::Sot,
+ ]);
+
+ #[derive(Clone)]
+ pub struct SentenceBreaks<'a> {
+ pub string: &'a str,
+ pos: usize,
+ state: SentenceBreaksState,
+ }
+
+ impl SentenceBreaksState {
+ // Attempt to advance the internal state by one part
+ // Whitespace and some punctutation will be collapsed
+ fn next(&self, cat: SentenceCat) -> SentenceBreaksState {
+ let &SentenceBreaksState(parts) = self;
+ let parts = match (parts[3], cat) {
+ (StatePart::ClosePlus, SentenceCat::SC_Close) => parts,
+ (StatePart::SpPlus, SentenceCat::SC_Sp) => parts,
+ _ => [
+ parts[1],
+ parts[2],
+ parts[3],
+ match cat {
+ SentenceCat::SC_CR => StatePart::CR,
+ SentenceCat::SC_LF => StatePart::LF,
+ SentenceCat::SC_Sep => StatePart::Sep,
+ SentenceCat::SC_ATerm => StatePart::ATerm,
+ SentenceCat::SC_Upper | SentenceCat::SC_Lower => StatePart::UpperLower,
+ SentenceCat::SC_Close => StatePart::ClosePlus,
+ SentenceCat::SC_Sp => StatePart::SpPlus,
+ SentenceCat::SC_STerm => StatePart::STerm,
+ _ => StatePart::Other,
+ },
+ ],
+ };
+ SentenceBreaksState(parts)
+ }
+
+ fn end(&self) -> SentenceBreaksState {
+ let &SentenceBreaksState(parts) = self;
+ SentenceBreaksState([parts[1], parts[2], parts[3], StatePart::Eot])
+ }
+
+ // Helper function to check if state head matches a single `StatePart`
+ fn match1(&self, part: StatePart) -> bool {
+ let &SentenceBreaksState(parts) = self;
+ part == parts[3]
+ }
+
+ // Helper function to check if first two `StateParts` in state match
+ // the given two
+ fn match2(&self, part1: StatePart, part2: StatePart) -> bool {
+ let &SentenceBreaksState(parts) = self;
+ part1 == parts[2] && part2 == parts[3]
+ }
+ }
+
+ // https://unicode.org/reports/tr29/#SB8
+ // TODO cache this, it is currently quadratic
+ fn match_sb8(state: &SentenceBreaksState, ahead: &str) -> bool {
+ let &SentenceBreaksState(parts) = state;
+ let mut idx = if parts[3] == StatePart::SpPlus { 2 } else { 3 };
+ if parts[idx] == StatePart::ClosePlus {
+ idx -= 1
+ }
+
+ if parts[idx] == StatePart::ATerm {
+ use crate::tables::sentence as se;
+
+ for next_char in ahead.chars() {
+ //( ¬(OLetter | Upper | Lower | ParaSep | SATerm) )* Lower
+ match se::sentence_category(next_char).2 {
+ se::SC_Lower => return true,
+ se::SC_OLetter
+ | se::SC_Upper
+ | se::SC_Sep
+ | se::SC_CR
+ | se::SC_LF
+ | se::SC_STerm
+ | se::SC_ATerm => return false,
+ _ => continue,
+ }
+ }
+ }
+
+ false
+ }
+
+ // https://unicode.org/reports/tr29/#SB8a
+ fn match_sb8a(state: &SentenceBreaksState) -> bool {
+ // SATerm Close* Sp*
+ let &SentenceBreaksState(parts) = state;
+ let mut idx = if parts[3] == StatePart::SpPlus { 2 } else { 3 };
+ if parts[idx] == StatePart::ClosePlus {
+ idx -= 1
+ }
+ parts[idx] == StatePart::STerm || parts[idx] == StatePart::ATerm
+ }
+
+ // https://unicode.org/reports/tr29/#SB9
+ fn match_sb9(state: &SentenceBreaksState) -> bool {
+ // SATerm Close*
+ let &SentenceBreaksState(parts) = state;
+ let idx = if parts[3] == StatePart::ClosePlus {
+ 2
+ } else {
+ 3
+ };
+ parts[idx] == StatePart::STerm || parts[idx] == StatePart::ATerm
+ }
+
+ // https://unicode.org/reports/tr29/#SB11
+ fn match_sb11(state: &SentenceBreaksState) -> bool {
+ // SATerm Close* Sp* ParaSep?
+ let &SentenceBreaksState(parts) = state;
+ let mut idx = match parts[3] {
+ StatePart::Sep | StatePart::CR | StatePart::LF => 2,
+ _ => 3,
+ };
+
+ if parts[idx] == StatePart::SpPlus {
+ idx -= 1
+ }
+ if parts[idx] == StatePart::ClosePlus {
+ idx -= 1
+ }
+
+ parts[idx] == StatePart::STerm || parts[idx] == StatePart::ATerm
+ }
+
+ impl<'a> Iterator for SentenceBreaks<'a> {
+ // Returns the index of the character which follows a break
+ type Item = usize;
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let slen = self.string.len();
+ // A sentence could be one character
+ (cmp::min(slen, 2), Some(slen + 1))
+ }
+
+ #[inline]
+ fn next(&mut self) -> Option<usize> {
+ use crate::tables::sentence as se;
+
+ for next_char in self.string[self.pos..].chars() {
+ let position_before = self.pos;
+ let state_before = self.state.clone();
+
+ let next_cat = se::sentence_category(next_char).2;
+
+ self.pos += next_char.len_utf8();
+ self.state = self.state.next(next_cat);
+
+ match next_cat {
+ // SB1 https://unicode.org/reports/tr29/#SB1
+ _ if state_before.match1(StatePart::Sot) => return Some(position_before),
+
+ // SB2 is handled when inner iterator (chars) is finished
+
+ // SB3 https://unicode.org/reports/tr29/#SB3
+ SentenceCat::SC_LF if state_before.match1(StatePart::CR) => continue,
+
+ // SB4 https://unicode.org/reports/tr29/#SB4
+ _ if state_before.match1(StatePart::Sep)
+ || state_before.match1(StatePart::CR)
+ || state_before.match1(StatePart::LF) =>
+ {
+ return Some(position_before)
+ }
+
+ // SB5 https://unicode.org/reports/tr29/#SB5
+ SentenceCat::SC_Extend | SentenceCat::SC_Format => self.state = state_before,
+
+ // SB6 https://unicode.org/reports/tr29/#SB6
+ SentenceCat::SC_Numeric if state_before.match1(StatePart::ATerm) => continue,
+
+ // SB7 https://unicode.org/reports/tr29/#SB7
+ SentenceCat::SC_Upper
+ if state_before.match2(StatePart::UpperLower, StatePart::ATerm) =>
+ {
+ continue
+ }
+
+ // SB8 https://unicode.org/reports/tr29/#SB8
+ _ if match_sb8(&state_before, &self.string[position_before..]) => continue,
+
+ // SB8a https://unicode.org/reports/tr29/#SB8a
+ SentenceCat::SC_SContinue | SentenceCat::SC_STerm | SentenceCat::SC_ATerm
+ if match_sb8a(&state_before) =>
+ {
+ continue
+ }
+
+ // SB9 https://unicode.org/reports/tr29/#SB9
+ SentenceCat::SC_Close
+ | SentenceCat::SC_Sp
+ | SentenceCat::SC_Sep
+ | SentenceCat::SC_CR
+ | SentenceCat::SC_LF
+ if match_sb9(&state_before) =>
+ {
+ continue
+ }
+
+ // SB10 https://unicode.org/reports/tr29/#SB10
+ SentenceCat::SC_Sp
+ | SentenceCat::SC_Sep
+ | SentenceCat::SC_CR
+ | SentenceCat::SC_LF
+ if match_sb8a(&state_before) =>
+ {
+ continue
+ }
+
+ // SB11 https://unicode.org/reports/tr29/#SB11
+ _ if match_sb11(&state_before) => return Some(position_before),
+
+ // SB998 https://unicode.org/reports/tr29/#SB998
+ _ => continue,
+ }
+ }
+
+ // SB2 https://unicode.org/reports/tr29/#SB2
+ if self.state.match1(StatePart::Sot) {
+ None
+ } else if self.state.match1(StatePart::Eot) {
+ None
+ } else {
+ self.state = self.state.end();
+ Some(self.pos)
+ }
+ }
+ }
+
+ pub fn new_sentence_breaks<'a>(source: &'a str) -> SentenceBreaks<'a> {
+ SentenceBreaks {
+ string: source,
+ pos: 0,
+ state: INITIAL_STATE,
+ }
+ }
+}
+
+/// An iterator over the substrings of a string which, after splitting the string on
+/// [sentence boundaries](http://www.unicode.org/reports/tr29/#Sentence_Boundaries),
+/// contain any characters with the
+/// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+/// property, or with
+/// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+///
+/// This struct is created by the [`unicode_sentences`] method on the [`UnicodeSegmentation`]
+/// trait. See its documentation for more.
+///
+/// [`unicode_sentences`]: trait.UnicodeSegmentation.html#tymethod.unicode_sentences
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct UnicodeSentences<'a> {
+ inner: Filter<USentenceBounds<'a>, fn(&&str) -> bool>,
+}
+
+/// External iterator for a string's
+/// [sentence boundaries](http://www.unicode.org/reports/tr29/#Sentence_Boundaries).
+///
+/// This struct is created by the [`split_sentence_bounds`] method on the [`UnicodeSegmentation`]
+/// trait. See its documentation for more.
+///
+/// [`split_sentence_bounds`]: trait.UnicodeSegmentation.html#tymethod.split_sentence_bounds
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct USentenceBounds<'a> {
+ iter: fwd::SentenceBreaks<'a>,
+ sentence_start: Option<usize>,
+}
+
+/// External iterator for sentence boundaries and byte offsets.
+///
+/// This struct is created by the [`split_sentence_bound_indices`] method on the
+/// [`UnicodeSegmentation`] trait. See its documentation for more.
+///
+/// [`split_sentence_bound_indices`]: trait.UnicodeSegmentation.html#tymethod.split_sentence_bound_indices
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct USentenceBoundIndices<'a> {
+ start_offset: usize,
+ iter: USentenceBounds<'a>,
+}
+
+#[inline]
+pub fn new_sentence_bounds<'a>(source: &'a str) -> USentenceBounds<'a> {
+ USentenceBounds {
+ iter: fwd::new_sentence_breaks(source),
+ sentence_start: None,
+ }
+}
+
+#[inline]
+pub fn new_sentence_bound_indices<'a>(source: &'a str) -> USentenceBoundIndices<'a> {
+ USentenceBoundIndices {
+ start_offset: source.as_ptr() as usize,
+ iter: new_sentence_bounds(source),
+ }
+}
+
+#[inline]
+pub fn new_unicode_sentences<'b>(s: &'b str) -> UnicodeSentences<'b> {
+ use super::UnicodeSegmentation;
+ use crate::tables::util::is_alphanumeric;
+
+ fn has_alphanumeric(s: &&str) -> bool {
+ s.chars().any(|c| is_alphanumeric(c))
+ }
+ let has_alphanumeric: fn(&&str) -> bool = has_alphanumeric; // coerce to fn pointer
+
+ UnicodeSentences {
+ inner: s.split_sentence_bounds().filter(has_alphanumeric),
+ }
+}
+
+impl<'a> Iterator for UnicodeSentences<'a> {
+ type Item = &'a str;
+
+ #[inline]
+ fn next(&mut self) -> Option<&'a str> {
+ self.inner.next()
+ }
+}
+
+impl<'a> Iterator for USentenceBounds<'a> {
+ type Item = &'a str;
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let (lower, upper) = self.iter.size_hint();
+ (cmp::max(0, lower - 1), upper.map(|u| cmp::max(0, u - 1)))
+ }
+
+ #[inline]
+ fn next(&mut self) -> Option<&'a str> {
+ if self.sentence_start == None {
+ if let Some(start_pos) = self.iter.next() {
+ self.sentence_start = Some(start_pos)
+ } else {
+ return None;
+ }
+ }
+
+ if let Some(break_pos) = self.iter.next() {
+ let start_pos = self.sentence_start.unwrap();
+ let sentence = &self.iter.string[start_pos..break_pos];
+ self.sentence_start = Some(break_pos);
+ Some(sentence)
+ } else {
+ None
+ }
+ }
+}
+
+impl<'a> Iterator for USentenceBoundIndices<'a> {
+ type Item = (usize, &'a str);
+
+ #[inline]
+ fn next(&mut self) -> Option<(usize, &'a str)> {
+ self.iter
+ .next()
+ .map(|s| (s.as_ptr() as usize - self.start_offset, s))
+ }
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.iter.size_hint()
+ }
+}
diff --git a/crates/unicode-segmentation/src/tables.rs b/crates/unicode-segmentation/src/tables.rs
new file mode 100644
index 0000000..ca83b50
--- /dev/null
+++ b/crates/unicode-segmentation/src/tables.rs
@@ -0,0 +1,2989 @@
+// Copyright 2012-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+#![allow(missing_docs, non_upper_case_globals, non_snake_case)]
+
+/// The version of [Unicode](http://www.unicode.org/)
+/// that this version of unicode-segmentation is based on.
+pub const UNICODE_VERSION: (u64, u64, u64) = (15, 0, 0);
+
+pub mod util {
+ #[inline]
+ pub fn bsearch_range_table(c: char, r: &'static [(char,char)]) -> bool {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ r.binary_search_by(|&(lo,hi)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }).is_ok()
+ }
+
+ #[inline]
+ fn is_alphabetic(c: char) -> bool {
+ match c {
+ 'a' ..= 'z' | 'A' ..= 'Z' => true,
+ c if c > '' => super::derived_property::Alphabetic(c),
+ _ => false,
+ }
+ }
+
+ #[inline]
+ fn is_numeric(c: char) -> bool {
+ match c {
+ '0' ..= '9' => true,
+ c if c > '' => super::general_category::N(c),
+ _ => false,
+ }
+ }
+
+ #[inline]
+ pub fn is_alphanumeric(c: char) -> bool {
+ is_alphabetic(c) || is_numeric(c)
+ }
+}
+
+mod general_category {
+ const N_table: &'static [(char, char)] = &[
+ ('\u{30}', '\u{39}'), ('\u{b2}', '\u{b3}'), ('\u{b9}', '\u{b9}'), ('\u{bc}', '\u{be}'),
+ ('\u{660}', '\u{669}'), ('\u{6f0}', '\u{6f9}'), ('\u{7c0}', '\u{7c9}'), ('\u{966}',
+ '\u{96f}'), ('\u{9e6}', '\u{9ef}'), ('\u{9f4}', '\u{9f9}'), ('\u{a66}', '\u{a6f}'),
+ ('\u{ae6}', '\u{aef}'), ('\u{b66}', '\u{b6f}'), ('\u{b72}', '\u{b77}'), ('\u{be6}',
+ '\u{bf2}'), ('\u{c66}', '\u{c6f}'), ('\u{c78}', '\u{c7e}'), ('\u{ce6}', '\u{cef}'),
+ ('\u{d58}', '\u{d5e}'), ('\u{d66}', '\u{d78}'), ('\u{de6}', '\u{def}'), ('\u{e50}',
+ '\u{e59}'), ('\u{ed0}', '\u{ed9}'), ('\u{f20}', '\u{f33}'), ('\u{1040}', '\u{1049}'),
+ ('\u{1090}', '\u{1099}'), ('\u{1369}', '\u{137c}'), ('\u{16ee}', '\u{16f0}'), ('\u{17e0}',
+ '\u{17e9}'), ('\u{17f0}', '\u{17f9}'), ('\u{1810}', '\u{1819}'), ('\u{1946}', '\u{194f}'),
+ ('\u{19d0}', '\u{19da}'), ('\u{1a80}', '\u{1a89}'), ('\u{1a90}', '\u{1a99}'), ('\u{1b50}',
+ '\u{1b59}'), ('\u{1bb0}', '\u{1bb9}'), ('\u{1c40}', '\u{1c49}'), ('\u{1c50}', '\u{1c59}'),
+ ('\u{2070}', '\u{2070}'), ('\u{2074}', '\u{2079}'), ('\u{2080}', '\u{2089}'), ('\u{2150}',
+ '\u{2182}'), ('\u{2185}', '\u{2189}'), ('\u{2460}', '\u{249b}'), ('\u{24ea}', '\u{24ff}'),
+ ('\u{2776}', '\u{2793}'), ('\u{2cfd}', '\u{2cfd}'), ('\u{3007}', '\u{3007}'), ('\u{3021}',
+ '\u{3029}'), ('\u{3038}', '\u{303a}'), ('\u{3192}', '\u{3195}'), ('\u{3220}', '\u{3229}'),
+ ('\u{3248}', '\u{324f}'), ('\u{3251}', '\u{325f}'), ('\u{3280}', '\u{3289}'), ('\u{32b1}',
+ '\u{32bf}'), ('\u{a620}', '\u{a629}'), ('\u{a6e6}', '\u{a6ef}'), ('\u{a830}', '\u{a835}'),
+ ('\u{a8d0}', '\u{a8d9}'), ('\u{a900}', '\u{a909}'), ('\u{a9d0}', '\u{a9d9}'), ('\u{a9f0}',
+ '\u{a9f9}'), ('\u{aa50}', '\u{aa59}'), ('\u{abf0}', '\u{abf9}'), ('\u{ff10}', '\u{ff19}'),
+ ('\u{10107}', '\u{10133}'), ('\u{10140}', '\u{10178}'), ('\u{1018a}', '\u{1018b}'),
+ ('\u{102e1}', '\u{102fb}'), ('\u{10320}', '\u{10323}'), ('\u{10341}', '\u{10341}'),
+ ('\u{1034a}', '\u{1034a}'), ('\u{103d1}', '\u{103d5}'), ('\u{104a0}', '\u{104a9}'),
+ ('\u{10858}', '\u{1085f}'), ('\u{10879}', '\u{1087f}'), ('\u{108a7}', '\u{108af}'),
+ ('\u{108fb}', '\u{108ff}'), ('\u{10916}', '\u{1091b}'), ('\u{109bc}', '\u{109bd}'),
+ ('\u{109c0}', '\u{109cf}'), ('\u{109d2}', '\u{109ff}'), ('\u{10a40}', '\u{10a48}'),
+ ('\u{10a7d}', '\u{10a7e}'), ('\u{10a9d}', '\u{10a9f}'), ('\u{10aeb}', '\u{10aef}'),
+ ('\u{10b58}', '\u{10b5f}'), ('\u{10b78}', '\u{10b7f}'), ('\u{10ba9}', '\u{10baf}'),
+ ('\u{10cfa}', '\u{10cff}'), ('\u{10d30}', '\u{10d39}'), ('\u{10e60}', '\u{10e7e}'),
+ ('\u{10f1d}', '\u{10f26}'), ('\u{10f51}', '\u{10f54}'), ('\u{10fc5}', '\u{10fcb}'),
+ ('\u{11052}', '\u{1106f}'), ('\u{110f0}', '\u{110f9}'), ('\u{11136}', '\u{1113f}'),
+ ('\u{111d0}', '\u{111d9}'), ('\u{111e1}', '\u{111f4}'), ('\u{112f0}', '\u{112f9}'),
+ ('\u{11450}', '\u{11459}'), ('\u{114d0}', '\u{114d9}'), ('\u{11650}', '\u{11659}'),
+ ('\u{116c0}', '\u{116c9}'), ('\u{11730}', '\u{1173b}'), ('\u{118e0}', '\u{118f2}'),
+ ('\u{11950}', '\u{11959}'), ('\u{11c50}', '\u{11c6c}'), ('\u{11d50}', '\u{11d59}'),
+ ('\u{11da0}', '\u{11da9}'), ('\u{11f50}', '\u{11f59}'), ('\u{11fc0}', '\u{11fd4}'),
+ ('\u{12400}', '\u{1246e}'), ('\u{16a60}', '\u{16a69}'), ('\u{16ac0}', '\u{16ac9}'),
+ ('\u{16b50}', '\u{16b59}'), ('\u{16b5b}', '\u{16b61}'), ('\u{16e80}', '\u{16e96}'),
+ ('\u{1d2c0}', '\u{1d2d3}'), ('\u{1d2e0}', '\u{1d2f3}'), ('\u{1d360}', '\u{1d378}'),
+ ('\u{1d7ce}', '\u{1d7ff}'), ('\u{1e140}', '\u{1e149}'), ('\u{1e2f0}', '\u{1e2f9}'),
+ ('\u{1e4f0}', '\u{1e4f9}'), ('\u{1e8c7}', '\u{1e8cf}'), ('\u{1e950}', '\u{1e959}'),
+ ('\u{1ec71}', '\u{1ecab}'), ('\u{1ecad}', '\u{1ecaf}'), ('\u{1ecb1}', '\u{1ecb4}'),
+ ('\u{1ed01}', '\u{1ed2d}'), ('\u{1ed2f}', '\u{1ed3d}'), ('\u{1f100}', '\u{1f10c}'),
+ ('\u{1fbf0}', '\u{1fbf9}')
+ ];
+
+ #[inline]
+ pub fn N(c: char) -> bool {
+ super::util::bsearch_range_table(c, N_table)
+ }
+
+}
+
+mod derived_property {
+ const Alphabetic_table: &'static [(char, char)] = &[
+ ('\u{41}', '\u{5a}'), ('\u{61}', '\u{7a}'), ('\u{aa}', '\u{aa}'), ('\u{b5}', '\u{b5}'),
+ ('\u{ba}', '\u{ba}'), ('\u{c0}', '\u{d6}'), ('\u{d8}', '\u{f6}'), ('\u{f8}', '\u{2c1}'),
+ ('\u{2c6}', '\u{2d1}'), ('\u{2e0}', '\u{2e4}'), ('\u{2ec}', '\u{2ec}'), ('\u{2ee}',
+ '\u{2ee}'), ('\u{345}', '\u{345}'), ('\u{370}', '\u{374}'), ('\u{376}', '\u{377}'),
+ ('\u{37a}', '\u{37d}'), ('\u{37f}', '\u{37f}'), ('\u{386}', '\u{386}'), ('\u{388}',
+ '\u{38a}'), ('\u{38c}', '\u{38c}'), ('\u{38e}', '\u{3a1}'), ('\u{3a3}', '\u{3f5}'),
+ ('\u{3f7}', '\u{481}'), ('\u{48a}', '\u{52f}'), ('\u{531}', '\u{556}'), ('\u{559}',
+ '\u{559}'), ('\u{560}', '\u{588}'), ('\u{5b0}', '\u{5bd}'), ('\u{5bf}', '\u{5bf}'),
+ ('\u{5c1}', '\u{5c2}'), ('\u{5c4}', '\u{5c5}'), ('\u{5c7}', '\u{5c7}'), ('\u{5d0}',
+ '\u{5ea}'), ('\u{5ef}', '\u{5f2}'), ('\u{610}', '\u{61a}'), ('\u{620}', '\u{657}'),
+ ('\u{659}', '\u{65f}'), ('\u{66e}', '\u{6d3}'), ('\u{6d5}', '\u{6dc}'), ('\u{6e1}',
+ '\u{6e8}'), ('\u{6ed}', '\u{6ef}'), ('\u{6fa}', '\u{6fc}'), ('\u{6ff}', '\u{6ff}'),
+ ('\u{710}', '\u{73f}'), ('\u{74d}', '\u{7b1}'), ('\u{7ca}', '\u{7ea}'), ('\u{7f4}',
+ '\u{7f5}'), ('\u{7fa}', '\u{7fa}'), ('\u{800}', '\u{817}'), ('\u{81a}', '\u{82c}'),
+ ('\u{840}', '\u{858}'), ('\u{860}', '\u{86a}'), ('\u{870}', '\u{887}'), ('\u{889}',
+ '\u{88e}'), ('\u{8a0}', '\u{8c9}'), ('\u{8d4}', '\u{8df}'), ('\u{8e3}', '\u{8e9}'),
+ ('\u{8f0}', '\u{93b}'), ('\u{93d}', '\u{94c}'), ('\u{94e}', '\u{950}'), ('\u{955}',
+ '\u{963}'), ('\u{971}', '\u{983}'), ('\u{985}', '\u{98c}'), ('\u{98f}', '\u{990}'),
+ ('\u{993}', '\u{9a8}'), ('\u{9aa}', '\u{9b0}'), ('\u{9b2}', '\u{9b2}'), ('\u{9b6}',
+ '\u{9b9}'), ('\u{9bd}', '\u{9c4}'), ('\u{9c7}', '\u{9c8}'), ('\u{9cb}', '\u{9cc}'),
+ ('\u{9ce}', '\u{9ce}'), ('\u{9d7}', '\u{9d7}'), ('\u{9dc}', '\u{9dd}'), ('\u{9df}',
+ '\u{9e3}'), ('\u{9f0}', '\u{9f1}'), ('\u{9fc}', '\u{9fc}'), ('\u{a01}', '\u{a03}'),
+ ('\u{a05}', '\u{a0a}'), ('\u{a0f}', '\u{a10}'), ('\u{a13}', '\u{a28}'), ('\u{a2a}',
+ '\u{a30}'), ('\u{a32}', '\u{a33}'), ('\u{a35}', '\u{a36}'), ('\u{a38}', '\u{a39}'),
+ ('\u{a3e}', '\u{a42}'), ('\u{a47}', '\u{a48}'), ('\u{a4b}', '\u{a4c}'), ('\u{a51}',
+ '\u{a51}'), ('\u{a59}', '\u{a5c}'), ('\u{a5e}', '\u{a5e}'), ('\u{a70}', '\u{a75}'),
+ ('\u{a81}', '\u{a83}'), ('\u{a85}', '\u{a8d}'), ('\u{a8f}', '\u{a91}'), ('\u{a93}',
+ '\u{aa8}'), ('\u{aaa}', '\u{ab0}'), ('\u{ab2}', '\u{ab3}'), ('\u{ab5}', '\u{ab9}'),
+ ('\u{abd}', '\u{ac5}'), ('\u{ac7}', '\u{ac9}'), ('\u{acb}', '\u{acc}'), ('\u{ad0}',
+ '\u{ad0}'), ('\u{ae0}', '\u{ae3}'), ('\u{af9}', '\u{afc}'), ('\u{b01}', '\u{b03}'),
+ ('\u{b05}', '\u{b0c}'), ('\u{b0f}', '\u{b10}'), ('\u{b13}', '\u{b28}'), ('\u{b2a}',
+ '\u{b30}'), ('\u{b32}', '\u{b33}'), ('\u{b35}', '\u{b39}'), ('\u{b3d}', '\u{b44}'),
+ ('\u{b47}', '\u{b48}'), ('\u{b4b}', '\u{b4c}'), ('\u{b56}', '\u{b57}'), ('\u{b5c}',
+ '\u{b5d}'), ('\u{b5f}', '\u{b63}'), ('\u{b71}', '\u{b71}'), ('\u{b82}', '\u{b83}'),
+ ('\u{b85}', '\u{b8a}'), ('\u{b8e}', '\u{b90}'), ('\u{b92}', '\u{b95}'), ('\u{b99}',
+ '\u{b9a}'), ('\u{b9c}', '\u{b9c}'), ('\u{b9e}', '\u{b9f}'), ('\u{ba3}', '\u{ba4}'),
+ ('\u{ba8}', '\u{baa}'), ('\u{bae}', '\u{bb9}'), ('\u{bbe}', '\u{bc2}'), ('\u{bc6}',
+ '\u{bc8}'), ('\u{bca}', '\u{bcc}'), ('\u{bd0}', '\u{bd0}'), ('\u{bd7}', '\u{bd7}'),
+ ('\u{c00}', '\u{c0c}'), ('\u{c0e}', '\u{c10}'), ('\u{c12}', '\u{c28}'), ('\u{c2a}',
+ '\u{c39}'), ('\u{c3d}', '\u{c44}'), ('\u{c46}', '\u{c48}'), ('\u{c4a}', '\u{c4c}'),
+ ('\u{c55}', '\u{c56}'), ('\u{c58}', '\u{c5a}'), ('\u{c5d}', '\u{c5d}'), ('\u{c60}',
+ '\u{c63}'), ('\u{c80}', '\u{c83}'), ('\u{c85}', '\u{c8c}'), ('\u{c8e}', '\u{c90}'),
+ ('\u{c92}', '\u{ca8}'), ('\u{caa}', '\u{cb3}'), ('\u{cb5}', '\u{cb9}'), ('\u{cbd}',
+ '\u{cc4}'), ('\u{cc6}', '\u{cc8}'), ('\u{cca}', '\u{ccc}'), ('\u{cd5}', '\u{cd6}'),
+ ('\u{cdd}', '\u{cde}'), ('\u{ce0}', '\u{ce3}'), ('\u{cf1}', '\u{cf3}'), ('\u{d00}',
+ '\u{d0c}'), ('\u{d0e}', '\u{d10}'), ('\u{d12}', '\u{d3a}'), ('\u{d3d}', '\u{d44}'),
+ ('\u{d46}', '\u{d48}'), ('\u{d4a}', '\u{d4c}'), ('\u{d4e}', '\u{d4e}'), ('\u{d54}',
+ '\u{d57}'), ('\u{d5f}', '\u{d63}'), ('\u{d7a}', '\u{d7f}'), ('\u{d81}', '\u{d83}'),
+ ('\u{d85}', '\u{d96}'), ('\u{d9a}', '\u{db1}'), ('\u{db3}', '\u{dbb}'), ('\u{dbd}',
+ '\u{dbd}'), ('\u{dc0}', '\u{dc6}'), ('\u{dcf}', '\u{dd4}'), ('\u{dd6}', '\u{dd6}'),
+ ('\u{dd8}', '\u{ddf}'), ('\u{df2}', '\u{df3}'), ('\u{e01}', '\u{e3a}'), ('\u{e40}',
+ '\u{e46}'), ('\u{e4d}', '\u{e4d}'), ('\u{e81}', '\u{e82}'), ('\u{e84}', '\u{e84}'),
+ ('\u{e86}', '\u{e8a}'), ('\u{e8c}', '\u{ea3}'), ('\u{ea5}', '\u{ea5}'), ('\u{ea7}',
+ '\u{eb9}'), ('\u{ebb}', '\u{ebd}'), ('\u{ec0}', '\u{ec4}'), ('\u{ec6}', '\u{ec6}'),
+ ('\u{ecd}', '\u{ecd}'), ('\u{edc}', '\u{edf}'), ('\u{f00}', '\u{f00}'), ('\u{f40}',
+ '\u{f47}'), ('\u{f49}', '\u{f6c}'), ('\u{f71}', '\u{f83}'), ('\u{f88}', '\u{f97}'),
+ ('\u{f99}', '\u{fbc}'), ('\u{1000}', '\u{1036}'), ('\u{1038}', '\u{1038}'), ('\u{103b}',
+ '\u{103f}'), ('\u{1050}', '\u{108f}'), ('\u{109a}', '\u{109d}'), ('\u{10a0}', '\u{10c5}'),
+ ('\u{10c7}', '\u{10c7}'), ('\u{10cd}', '\u{10cd}'), ('\u{10d0}', '\u{10fa}'), ('\u{10fc}',
+ '\u{1248}'), ('\u{124a}', '\u{124d}'), ('\u{1250}', '\u{1256}'), ('\u{1258}', '\u{1258}'),
+ ('\u{125a}', '\u{125d}'), ('\u{1260}', '\u{1288}'), ('\u{128a}', '\u{128d}'), ('\u{1290}',
+ '\u{12b0}'), ('\u{12b2}', '\u{12b5}'), ('\u{12b8}', '\u{12be}'), ('\u{12c0}', '\u{12c0}'),
+ ('\u{12c2}', '\u{12c5}'), ('\u{12c8}', '\u{12d6}'), ('\u{12d8}', '\u{1310}'), ('\u{1312}',
+ '\u{1315}'), ('\u{1318}', '\u{135a}'), ('\u{1380}', '\u{138f}'), ('\u{13a0}', '\u{13f5}'),
+ ('\u{13f8}', '\u{13fd}'), ('\u{1401}', '\u{166c}'), ('\u{166f}', '\u{167f}'), ('\u{1681}',
+ '\u{169a}'), ('\u{16a0}', '\u{16ea}'), ('\u{16ee}', '\u{16f8}'), ('\u{1700}', '\u{1713}'),
+ ('\u{171f}', '\u{1733}'), ('\u{1740}', '\u{1753}'), ('\u{1760}', '\u{176c}'), ('\u{176e}',
+ '\u{1770}'), ('\u{1772}', '\u{1773}'), ('\u{1780}', '\u{17b3}'), ('\u{17b6}', '\u{17c8}'),
+ ('\u{17d7}', '\u{17d7}'), ('\u{17dc}', '\u{17dc}'), ('\u{1820}', '\u{1878}'), ('\u{1880}',
+ '\u{18aa}'), ('\u{18b0}', '\u{18f5}'), ('\u{1900}', '\u{191e}'), ('\u{1920}', '\u{192b}'),
+ ('\u{1930}', '\u{1938}'), ('\u{1950}', '\u{196d}'), ('\u{1970}', '\u{1974}'), ('\u{1980}',
+ '\u{19ab}'), ('\u{19b0}', '\u{19c9}'), ('\u{1a00}', '\u{1a1b}'), ('\u{1a20}', '\u{1a5e}'),
+ ('\u{1a61}', '\u{1a74}'), ('\u{1aa7}', '\u{1aa7}'), ('\u{1abf}', '\u{1ac0}'), ('\u{1acc}',
+ '\u{1ace}'), ('\u{1b00}', '\u{1b33}'), ('\u{1b35}', '\u{1b43}'), ('\u{1b45}', '\u{1b4c}'),
+ ('\u{1b80}', '\u{1ba9}'), ('\u{1bac}', '\u{1baf}'), ('\u{1bba}', '\u{1be5}'), ('\u{1be7}',
+ '\u{1bf1}'), ('\u{1c00}', '\u{1c36}'), ('\u{1c4d}', '\u{1c4f}'), ('\u{1c5a}', '\u{1c7d}'),
+ ('\u{1c80}', '\u{1c88}'), ('\u{1c90}', '\u{1cba}'), ('\u{1cbd}', '\u{1cbf}'), ('\u{1ce9}',
+ '\u{1cec}'), ('\u{1cee}', '\u{1cf3}'), ('\u{1cf5}', '\u{1cf6}'), ('\u{1cfa}', '\u{1cfa}'),
+ ('\u{1d00}', '\u{1dbf}'), ('\u{1de7}', '\u{1df4}'), ('\u{1e00}', '\u{1f15}'), ('\u{1f18}',
+ '\u{1f1d}'), ('\u{1f20}', '\u{1f45}'), ('\u{1f48}', '\u{1f4d}'), ('\u{1f50}', '\u{1f57}'),
+ ('\u{1f59}', '\u{1f59}'), ('\u{1f5b}', '\u{1f5b}'), ('\u{1f5d}', '\u{1f5d}'), ('\u{1f5f}',
+ '\u{1f7d}'), ('\u{1f80}', '\u{1fb4}'), ('\u{1fb6}', '\u{1fbc}'), ('\u{1fbe}', '\u{1fbe}'),
+ ('\u{1fc2}', '\u{1fc4}'), ('\u{1fc6}', '\u{1fcc}'), ('\u{1fd0}', '\u{1fd3}'), ('\u{1fd6}',
+ '\u{1fdb}'), ('\u{1fe0}', '\u{1fec}'), ('\u{1ff2}', '\u{1ff4}'), ('\u{1ff6}', '\u{1ffc}'),
+ ('\u{2071}', '\u{2071}'), ('\u{207f}', '\u{207f}'), ('\u{2090}', '\u{209c}'), ('\u{2102}',
+ '\u{2102}'), ('\u{2107}', '\u{2107}'), ('\u{210a}', '\u{2113}'), ('\u{2115}', '\u{2115}'),
+ ('\u{2119}', '\u{211d}'), ('\u{2124}', '\u{2124}'), ('\u{2126}', '\u{2126}'), ('\u{2128}',
+ '\u{2128}'), ('\u{212a}', '\u{212d}'), ('\u{212f}', '\u{2139}'), ('\u{213c}', '\u{213f}'),
+ ('\u{2145}', '\u{2149}'), ('\u{214e}', '\u{214e}'), ('\u{2160}', '\u{2188}'), ('\u{24b6}',
+ '\u{24e9}'), ('\u{2c00}', '\u{2ce4}'), ('\u{2ceb}', '\u{2cee}'), ('\u{2cf2}', '\u{2cf3}'),
+ ('\u{2d00}', '\u{2d25}'), ('\u{2d27}', '\u{2d27}'), ('\u{2d2d}', '\u{2d2d}'), ('\u{2d30}',
+ '\u{2d67}'), ('\u{2d6f}', '\u{2d6f}'), ('\u{2d80}', '\u{2d96}'), ('\u{2da0}', '\u{2da6}'),
+ ('\u{2da8}', '\u{2dae}'), ('\u{2db0}', '\u{2db6}'), ('\u{2db8}', '\u{2dbe}'), ('\u{2dc0}',
+ '\u{2dc6}'), ('\u{2dc8}', '\u{2dce}'), ('\u{2dd0}', '\u{2dd6}'), ('\u{2dd8}', '\u{2dde}'),
+ ('\u{2de0}', '\u{2dff}'), ('\u{2e2f}', '\u{2e2f}'), ('\u{3005}', '\u{3007}'), ('\u{3021}',
+ '\u{3029}'), ('\u{3031}', '\u{3035}'), ('\u{3038}', '\u{303c}'), ('\u{3041}', '\u{3096}'),
+ ('\u{309d}', '\u{309f}'), ('\u{30a1}', '\u{30fa}'), ('\u{30fc}', '\u{30ff}'), ('\u{3105}',
+ '\u{312f}'), ('\u{3131}', '\u{318e}'), ('\u{31a0}', '\u{31bf}'), ('\u{31f0}', '\u{31ff}'),
+ ('\u{3400}', '\u{4dbf}'), ('\u{4e00}', '\u{a48c}'), ('\u{a4d0}', '\u{a4fd}'), ('\u{a500}',
+ '\u{a60c}'), ('\u{a610}', '\u{a61f}'), ('\u{a62a}', '\u{a62b}'), ('\u{a640}', '\u{a66e}'),
+ ('\u{a674}', '\u{a67b}'), ('\u{a67f}', '\u{a6ef}'), ('\u{a717}', '\u{a71f}'), ('\u{a722}',
+ '\u{a788}'), ('\u{a78b}', '\u{a7ca}'), ('\u{a7d0}', '\u{a7d1}'), ('\u{a7d3}', '\u{a7d3}'),
+ ('\u{a7d5}', '\u{a7d9}'), ('\u{a7f2}', '\u{a805}'), ('\u{a807}', '\u{a827}'), ('\u{a840}',
+ '\u{a873}'), ('\u{a880}', '\u{a8c3}'), ('\u{a8c5}', '\u{a8c5}'), ('\u{a8f2}', '\u{a8f7}'),
+ ('\u{a8fb}', '\u{a8fb}'), ('\u{a8fd}', '\u{a8ff}'), ('\u{a90a}', '\u{a92a}'), ('\u{a930}',
+ '\u{a952}'), ('\u{a960}', '\u{a97c}'), ('\u{a980}', '\u{a9b2}'), ('\u{a9b4}', '\u{a9bf}'),
+ ('\u{a9cf}', '\u{a9cf}'), ('\u{a9e0}', '\u{a9ef}'), ('\u{a9fa}', '\u{a9fe}'), ('\u{aa00}',
+ '\u{aa36}'), ('\u{aa40}', '\u{aa4d}'), ('\u{aa60}', '\u{aa76}'), ('\u{aa7a}', '\u{aabe}'),
+ ('\u{aac0}', '\u{aac0}'), ('\u{aac2}', '\u{aac2}'), ('\u{aadb}', '\u{aadd}'), ('\u{aae0}',
+ '\u{aaef}'), ('\u{aaf2}', '\u{aaf5}'), ('\u{ab01}', '\u{ab06}'), ('\u{ab09}', '\u{ab0e}'),
+ ('\u{ab11}', '\u{ab16}'), ('\u{ab20}', '\u{ab26}'), ('\u{ab28}', '\u{ab2e}'), ('\u{ab30}',
+ '\u{ab5a}'), ('\u{ab5c}', '\u{ab69}'), ('\u{ab70}', '\u{abea}'), ('\u{ac00}', '\u{d7a3}'),
+ ('\u{d7b0}', '\u{d7c6}'), ('\u{d7cb}', '\u{d7fb}'), ('\u{f900}', '\u{fa6d}'), ('\u{fa70}',
+ '\u{fad9}'), ('\u{fb00}', '\u{fb06}'), ('\u{fb13}', '\u{fb17}'), ('\u{fb1d}', '\u{fb28}'),
+ ('\u{fb2a}', '\u{fb36}'), ('\u{fb38}', '\u{fb3c}'), ('\u{fb3e}', '\u{fb3e}'), ('\u{fb40}',
+ '\u{fb41}'), ('\u{fb43}', '\u{fb44}'), ('\u{fb46}', '\u{fbb1}'), ('\u{fbd3}', '\u{fd3d}'),
+ ('\u{fd50}', '\u{fd8f}'), ('\u{fd92}', '\u{fdc7}'), ('\u{fdf0}', '\u{fdfb}'), ('\u{fe70}',
+ '\u{fe74}'), ('\u{fe76}', '\u{fefc}'), ('\u{ff21}', '\u{ff3a}'), ('\u{ff41}', '\u{ff5a}'),
+ ('\u{ff66}', '\u{ffbe}'), ('\u{ffc2}', '\u{ffc7}'), ('\u{ffca}', '\u{ffcf}'), ('\u{ffd2}',
+ '\u{ffd7}'), ('\u{ffda}', '\u{ffdc}'), ('\u{10000}', '\u{1000b}'), ('\u{1000d}',
+ '\u{10026}'), ('\u{10028}', '\u{1003a}'), ('\u{1003c}', '\u{1003d}'), ('\u{1003f}',
+ '\u{1004d}'), ('\u{10050}', '\u{1005d}'), ('\u{10080}', '\u{100fa}'), ('\u{10140}',
+ '\u{10174}'), ('\u{10280}', '\u{1029c}'), ('\u{102a0}', '\u{102d0}'), ('\u{10300}',
+ '\u{1031f}'), ('\u{1032d}', '\u{1034a}'), ('\u{10350}', '\u{1037a}'), ('\u{10380}',
+ '\u{1039d}'), ('\u{103a0}', '\u{103c3}'), ('\u{103c8}', '\u{103cf}'), ('\u{103d1}',
+ '\u{103d5}'), ('\u{10400}', '\u{1049d}'), ('\u{104b0}', '\u{104d3}'), ('\u{104d8}',
+ '\u{104fb}'), ('\u{10500}', '\u{10527}'), ('\u{10530}', '\u{10563}'), ('\u{10570}',
+ '\u{1057a}'), ('\u{1057c}', '\u{1058a}'), ('\u{1058c}', '\u{10592}'), ('\u{10594}',
+ '\u{10595}'), ('\u{10597}', '\u{105a1}'), ('\u{105a3}', '\u{105b1}'), ('\u{105b3}',
+ '\u{105b9}'), ('\u{105bb}', '\u{105bc}'), ('\u{10600}', '\u{10736}'), ('\u{10740}',
+ '\u{10755}'), ('\u{10760}', '\u{10767}'), ('\u{10780}', '\u{10785}'), ('\u{10787}',
+ '\u{107b0}'), ('\u{107b2}', '\u{107ba}'), ('\u{10800}', '\u{10805}'), ('\u{10808}',
+ '\u{10808}'), ('\u{1080a}', '\u{10835}'), ('\u{10837}', '\u{10838}'), ('\u{1083c}',
+ '\u{1083c}'), ('\u{1083f}', '\u{10855}'), ('\u{10860}', '\u{10876}'), ('\u{10880}',
+ '\u{1089e}'), ('\u{108e0}', '\u{108f2}'), ('\u{108f4}', '\u{108f5}'), ('\u{10900}',
+ '\u{10915}'), ('\u{10920}', '\u{10939}'), ('\u{10980}', '\u{109b7}'), ('\u{109be}',
+ '\u{109bf}'), ('\u{10a00}', '\u{10a03}'), ('\u{10a05}', '\u{10a06}'), ('\u{10a0c}',
+ '\u{10a13}'), ('\u{10a15}', '\u{10a17}'), ('\u{10a19}', '\u{10a35}'), ('\u{10a60}',
+ '\u{10a7c}'), ('\u{10a80}', '\u{10a9c}'), ('\u{10ac0}', '\u{10ac7}'), ('\u{10ac9}',
+ '\u{10ae4}'), ('\u{10b00}', '\u{10b35}'), ('\u{10b40}', '\u{10b55}'), ('\u{10b60}',
+ '\u{10b72}'), ('\u{10b80}', '\u{10b91}'), ('\u{10c00}', '\u{10c48}'), ('\u{10c80}',
+ '\u{10cb2}'), ('\u{10cc0}', '\u{10cf2}'), ('\u{10d00}', '\u{10d27}'), ('\u{10e80}',
+ '\u{10ea9}'), ('\u{10eab}', '\u{10eac}'), ('\u{10eb0}', '\u{10eb1}'), ('\u{10f00}',
+ '\u{10f1c}'), ('\u{10f27}', '\u{10f27}'), ('\u{10f30}', '\u{10f45}'), ('\u{10f70}',
+ '\u{10f81}'), ('\u{10fb0}', '\u{10fc4}'), ('\u{10fe0}', '\u{10ff6}'), ('\u{11000}',
+ '\u{11045}'), ('\u{11071}', '\u{11075}'), ('\u{11080}', '\u{110b8}'), ('\u{110c2}',
+ '\u{110c2}'), ('\u{110d0}', '\u{110e8}'), ('\u{11100}', '\u{11132}'), ('\u{11144}',
+ '\u{11147}'), ('\u{11150}', '\u{11172}'), ('\u{11176}', '\u{11176}'), ('\u{11180}',
+ '\u{111bf}'), ('\u{111c1}', '\u{111c4}'), ('\u{111ce}', '\u{111cf}'), ('\u{111da}',
+ '\u{111da}'), ('\u{111dc}', '\u{111dc}'), ('\u{11200}', '\u{11211}'), ('\u{11213}',
+ '\u{11234}'), ('\u{11237}', '\u{11237}'), ('\u{1123e}', '\u{11241}'), ('\u{11280}',
+ '\u{11286}'), ('\u{11288}', '\u{11288}'), ('\u{1128a}', '\u{1128d}'), ('\u{1128f}',
+ '\u{1129d}'), ('\u{1129f}', '\u{112a8}'), ('\u{112b0}', '\u{112e8}'), ('\u{11300}',
+ '\u{11303}'), ('\u{11305}', '\u{1130c}'), ('\u{1130f}', '\u{11310}'), ('\u{11313}',
+ '\u{11328}'), ('\u{1132a}', '\u{11330}'), ('\u{11332}', '\u{11333}'), ('\u{11335}',
+ '\u{11339}'), ('\u{1133d}', '\u{11344}'), ('\u{11347}', '\u{11348}'), ('\u{1134b}',
+ '\u{1134c}'), ('\u{11350}', '\u{11350}'), ('\u{11357}', '\u{11357}'), ('\u{1135d}',
+ '\u{11363}'), ('\u{11400}', '\u{11441}'), ('\u{11443}', '\u{11445}'), ('\u{11447}',
+ '\u{1144a}'), ('\u{1145f}', '\u{11461}'), ('\u{11480}', '\u{114c1}'), ('\u{114c4}',
+ '\u{114c5}'), ('\u{114c7}', '\u{114c7}'), ('\u{11580}', '\u{115b5}'), ('\u{115b8}',
+ '\u{115be}'), ('\u{115d8}', '\u{115dd}'), ('\u{11600}', '\u{1163e}'), ('\u{11640}',
+ '\u{11640}'), ('\u{11644}', '\u{11644}'), ('\u{11680}', '\u{116b5}'), ('\u{116b8}',
+ '\u{116b8}'), ('\u{11700}', '\u{1171a}'), ('\u{1171d}', '\u{1172a}'), ('\u{11740}',
+ '\u{11746}'), ('\u{11800}', '\u{11838}'), ('\u{118a0}', '\u{118df}'), ('\u{118ff}',
+ '\u{11906}'), ('\u{11909}', '\u{11909}'), ('\u{1190c}', '\u{11913}'), ('\u{11915}',
+ '\u{11916}'), ('\u{11918}', '\u{11935}'), ('\u{11937}', '\u{11938}'), ('\u{1193b}',
+ '\u{1193c}'), ('\u{1193f}', '\u{11942}'), ('\u{119a0}', '\u{119a7}'), ('\u{119aa}',
+ '\u{119d7}'), ('\u{119da}', '\u{119df}'), ('\u{119e1}', '\u{119e1}'), ('\u{119e3}',
+ '\u{119e4}'), ('\u{11a00}', '\u{11a32}'), ('\u{11a35}', '\u{11a3e}'), ('\u{11a50}',
+ '\u{11a97}'), ('\u{11a9d}', '\u{11a9d}'), ('\u{11ab0}', '\u{11af8}'), ('\u{11c00}',
+ '\u{11c08}'), ('\u{11c0a}', '\u{11c36}'), ('\u{11c38}', '\u{11c3e}'), ('\u{11c40}',
+ '\u{11c40}'), ('\u{11c72}', '\u{11c8f}'), ('\u{11c92}', '\u{11ca7}'), ('\u{11ca9}',
+ '\u{11cb6}'), ('\u{11d00}', '\u{11d06}'), ('\u{11d08}', '\u{11d09}'), ('\u{11d0b}',
+ '\u{11d36}'), ('\u{11d3a}', '\u{11d3a}'), ('\u{11d3c}', '\u{11d3d}'), ('\u{11d3f}',
+ '\u{11d41}'), ('\u{11d43}', '\u{11d43}'), ('\u{11d46}', '\u{11d47}'), ('\u{11d60}',
+ '\u{11d65}'), ('\u{11d67}', '\u{11d68}'), ('\u{11d6a}', '\u{11d8e}'), ('\u{11d90}',
+ '\u{11d91}'), ('\u{11d93}', '\u{11d96}'), ('\u{11d98}', '\u{11d98}'), ('\u{11ee0}',
+ '\u{11ef6}'), ('\u{11f00}', '\u{11f10}'), ('\u{11f12}', '\u{11f3a}'), ('\u{11f3e}',
+ '\u{11f40}'), ('\u{11fb0}', '\u{11fb0}'), ('\u{12000}', '\u{12399}'), ('\u{12400}',
+ '\u{1246e}'), ('\u{12480}', '\u{12543}'), ('\u{12f90}', '\u{12ff0}'), ('\u{13000}',
+ '\u{1342f}'), ('\u{13441}', '\u{13446}'), ('\u{14400}', '\u{14646}'), ('\u{16800}',
+ '\u{16a38}'), ('\u{16a40}', '\u{16a5e}'), ('\u{16a70}', '\u{16abe}'), ('\u{16ad0}',
+ '\u{16aed}'), ('\u{16b00}', '\u{16b2f}'), ('\u{16b40}', '\u{16b43}'), ('\u{16b63}',
+ '\u{16b77}'), ('\u{16b7d}', '\u{16b8f}'), ('\u{16e40}', '\u{16e7f}'), ('\u{16f00}',
+ '\u{16f4a}'), ('\u{16f4f}', '\u{16f87}'), ('\u{16f8f}', '\u{16f9f}'), ('\u{16fe0}',
+ '\u{16fe1}'), ('\u{16fe3}', '\u{16fe3}'), ('\u{16ff0}', '\u{16ff1}'), ('\u{17000}',
+ '\u{187f7}'), ('\u{18800}', '\u{18cd5}'), ('\u{18d00}', '\u{18d08}'), ('\u{1aff0}',
+ '\u{1aff3}'), ('\u{1aff5}', '\u{1affb}'), ('\u{1affd}', '\u{1affe}'), ('\u{1b000}',
+ '\u{1b122}'), ('\u{1b132}', '\u{1b132}'), ('\u{1b150}', '\u{1b152}'), ('\u{1b155}',
+ '\u{1b155}'), ('\u{1b164}', '\u{1b167}'), ('\u{1b170}', '\u{1b2fb}'), ('\u{1bc00}',
+ '\u{1bc6a}'), ('\u{1bc70}', '\u{1bc7c}'), ('\u{1bc80}', '\u{1bc88}'), ('\u{1bc90}',
+ '\u{1bc99}'), ('\u{1bc9e}', '\u{1bc9e}'), ('\u{1d400}', '\u{1d454}'), ('\u{1d456}',
+ '\u{1d49c}'), ('\u{1d49e}', '\u{1d49f}'), ('\u{1d4a2}', '\u{1d4a2}'), ('\u{1d4a5}',
+ '\u{1d4a6}'), ('\u{1d4a9}', '\u{1d4ac}'), ('\u{1d4ae}', '\u{1d4b9}'), ('\u{1d4bb}',
+ '\u{1d4bb}'), ('\u{1d4bd}', '\u{1d4c3}'), ('\u{1d4c5}', '\u{1d505}'), ('\u{1d507}',
+ '\u{1d50a}'), ('\u{1d50d}', '\u{1d514}'), ('\u{1d516}', '\u{1d51c}'), ('\u{1d51e}',
+ '\u{1d539}'), ('\u{1d53b}', '\u{1d53e}'), ('\u{1d540}', '\u{1d544}'), ('\u{1d546}',
+ '\u{1d546}'), ('\u{1d54a}', '\u{1d550}'), ('\u{1d552}', '\u{1d6a5}'), ('\u{1d6a8}',
+ '\u{1d6c0}'), ('\u{1d6c2}', '\u{1d6da}'), ('\u{1d6dc}', '\u{1d6fa}'), ('\u{1d6fc}',
+ '\u{1d714}'), ('\u{1d716}', '\u{1d734}'), ('\u{1d736}', '\u{1d74e}'), ('\u{1d750}',
+ '\u{1d76e}'), ('\u{1d770}', '\u{1d788}'), ('\u{1d78a}', '\u{1d7a8}'), ('\u{1d7aa}',
+ '\u{1d7c2}'), ('\u{1d7c4}', '\u{1d7cb}'), ('\u{1df00}', '\u{1df1e}'), ('\u{1df25}',
+ '\u{1df2a}'), ('\u{1e000}', '\u{1e006}'), ('\u{1e008}', '\u{1e018}'), ('\u{1e01b}',
+ '\u{1e021}'), ('\u{1e023}', '\u{1e024}'), ('\u{1e026}', '\u{1e02a}'), ('\u{1e030}',
+ '\u{1e06d}'), ('\u{1e08f}', '\u{1e08f}'), ('\u{1e100}', '\u{1e12c}'), ('\u{1e137}',
+ '\u{1e13d}'), ('\u{1e14e}', '\u{1e14e}'), ('\u{1e290}', '\u{1e2ad}'), ('\u{1e2c0}',
+ '\u{1e2eb}'), ('\u{1e4d0}', '\u{1e4eb}'), ('\u{1e7e0}', '\u{1e7e6}'), ('\u{1e7e8}',
+ '\u{1e7eb}'), ('\u{1e7ed}', '\u{1e7ee}'), ('\u{1e7f0}', '\u{1e7fe}'), ('\u{1e800}',
+ '\u{1e8c4}'), ('\u{1e900}', '\u{1e943}'), ('\u{1e947}', '\u{1e947}'), ('\u{1e94b}',
+ '\u{1e94b}'), ('\u{1ee00}', '\u{1ee03}'), ('\u{1ee05}', '\u{1ee1f}'), ('\u{1ee21}',
+ '\u{1ee22}'), ('\u{1ee24}', '\u{1ee24}'), ('\u{1ee27}', '\u{1ee27}'), ('\u{1ee29}',
+ '\u{1ee32}'), ('\u{1ee34}', '\u{1ee37}'), ('\u{1ee39}', '\u{1ee39}'), ('\u{1ee3b}',
+ '\u{1ee3b}'), ('\u{1ee42}', '\u{1ee42}'), ('\u{1ee47}', '\u{1ee47}'), ('\u{1ee49}',
+ '\u{1ee49}'), ('\u{1ee4b}', '\u{1ee4b}'), ('\u{1ee4d}', '\u{1ee4f}'), ('\u{1ee51}',
+ '\u{1ee52}'), ('\u{1ee54}', '\u{1ee54}'), ('\u{1ee57}', '\u{1ee57}'), ('\u{1ee59}',
+ '\u{1ee59}'), ('\u{1ee5b}', '\u{1ee5b}'), ('\u{1ee5d}', '\u{1ee5d}'), ('\u{1ee5f}',
+ '\u{1ee5f}'), ('\u{1ee61}', '\u{1ee62}'), ('\u{1ee64}', '\u{1ee64}'), ('\u{1ee67}',
+ '\u{1ee6a}'), ('\u{1ee6c}', '\u{1ee72}'), ('\u{1ee74}', '\u{1ee77}'), ('\u{1ee79}',
+ '\u{1ee7c}'), ('\u{1ee7e}', '\u{1ee7e}'), ('\u{1ee80}', '\u{1ee89}'), ('\u{1ee8b}',
+ '\u{1ee9b}'), ('\u{1eea1}', '\u{1eea3}'), ('\u{1eea5}', '\u{1eea9}'), ('\u{1eeab}',
+ '\u{1eebb}'), ('\u{1f130}', '\u{1f149}'), ('\u{1f150}', '\u{1f169}'), ('\u{1f170}',
+ '\u{1f189}'), ('\u{20000}', '\u{2a6df}'), ('\u{2a700}', '\u{2b739}'), ('\u{2b740}',
+ '\u{2b81d}'), ('\u{2b820}', '\u{2cea1}'), ('\u{2ceb0}', '\u{2ebe0}'), ('\u{2f800}',
+ '\u{2fa1d}'), ('\u{30000}', '\u{3134a}'), ('\u{31350}', '\u{323af}')
+ ];
+
+ #[inline]
+ pub fn Alphabetic(c: char) -> bool {
+ super::util::bsearch_range_table(c, Alphabetic_table)
+ }
+
+}
+
+pub mod grapheme {
+ use core::result::Result::{Ok, Err};
+
+ pub use self::GraphemeCat::*;
+
+ #[allow(non_camel_case_types)]
+ #[derive(Clone, Copy, PartialEq, Eq, Debug)]
+ pub enum GraphemeCat {
+ GC_Any,
+ GC_CR,
+ GC_Control,
+ GC_Extend,
+ GC_Extended_Pictographic,
+ GC_L,
+ GC_LF,
+ GC_LV,
+ GC_LVT,
+ GC_Prepend,
+ GC_Regional_Indicator,
+ GC_SpacingMark,
+ GC_T,
+ GC_V,
+ GC_ZWJ,
+ }
+
+ fn bsearch_range_value_table(c: char, r: &'static [(char, char, GraphemeCat)], default_lower: u32, default_upper: u32) -> (u32, u32, GraphemeCat) {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }) {
+ Ok(idx) => {
+ let (lower, upper, cat) = r[idx];
+ (lower as u32, upper as u32, cat)
+ }
+ Err(idx) => {
+ (
+ if idx > 0 { r[idx-1].1 as u32 + 1 } else { default_lower },
+ r.get(idx).map(|c|c.0 as u32 - 1).unwrap_or(default_upper),
+ GC_Any,
+ )
+ }
+ }
+ }
+
+ pub fn grapheme_category(c: char) -> (u32, u32, GraphemeCat) {
+ // Perform a quick O(1) lookup in a precomputed table to determine
+ // the slice of the range table to search in.
+ let lookup_interval = 0x80;
+ let idx = (c as u32 / lookup_interval) as usize;
+ let range = grapheme_cat_lookup.get(idx..(idx + 2)).map_or(
+ // If the `idx` is outside of the precomputed table - use the slice
+ // starting from the last covered index in the precomputed table and
+ // ending with the length of the range table.
+ 1443..1449,
+ |r| (r[0] as usize)..((r[1] + 1) as usize)
+ );
+
+ // Compute pessimistic default lower and upper bounds on the category.
+ // If character doesn't map to any range and there is no adjacent range
+ // in the table slice - these bounds has to apply.
+ let lower = idx as u32 * lookup_interval;
+ let upper = lower + lookup_interval - 1;
+ bsearch_range_value_table(c, &grapheme_cat_table[range], lower, upper)
+ }
+
+ const grapheme_cat_lookup: &'static [u16] = &[
+ 0, 5, 9, 9, 9, 9, 9, 10, 10, 10, 11, 11, 16, 21, 26, 29, 32, 37, 41, 53, 65, 75, 86, 97,
+ 106, 116, 131, 143, 153, 157, 161, 168, 173, 183, 188, 189, 191, 191, 191, 192, 192, 192,
+ 192, 192, 192, 192, 192, 198, 206, 209, 211, 219, 219, 232, 233, 242, 258, 262, 270, 270,
+ 271, 271, 271, 271, 271, 279, 280, 282, 284, 284, 284, 286, 290, 290, 291, 291, 295, 297,
+ 298, 313, 317, 317, 317, 318, 318, 318, 318, 322, 322, 322, 323, 324, 325, 325, 325, 325,
+ 325, 328, 329, 329, 329, 329, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331, 331,
+ 331, 331, 331, 333, 335, 335, 335, 342, 347, 351, 360, 369, 379, 379, 386, 395, 405, 413,
+ 423, 431, 441, 450, 459, 469, 477, 487, 495, 505, 514, 523, 533, 541, 551, 559, 569, 578,
+ 587, 597, 605, 615, 623, 633, 642, 651, 661, 669, 679, 687, 697, 706, 715, 725, 733, 743,
+ 751, 761, 770, 779, 789, 797, 807, 815, 825, 834, 843, 853, 861, 871, 879, 889, 898, 907,
+ 917, 925, 935, 943, 953, 962, 971, 981, 989, 999, 1007, 1017, 1026, 1035, 1045, 1053, 1063,
+ 1071, 1081, 1090, 1099, 1109, 1117, 1127, 1135, 1145, 1154, 1163, 1173, 1181, 1186, 1186,
+ 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186,
+ 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186,
+ 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186,
+ 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186,
+ 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1186, 1187, 1187, 1187, 1187, 1187, 1187,
+ 1189, 1190, 1190, 1192, 1192, 1192, 1192, 1193, 1193, 1194, 1195, 1195, 1195, 1195, 1195,
+ 1195, 1195, 1195, 1195, 1195, 1195, 1195, 1195, 1195, 1200, 1201, 1201, 1201, 1201, 1201,
+ 1202, 1202, 1202, 1204, 1205, 1206, 1212, 1221, 1227, 1236, 1244, 1247, 1260, 1260, 1267,
+ 1278, 1278, 1286, 1292, 1299, 1303, 1303, 1307, 1307, 1318, 1324, 1333, 1337, 1337, 1337,
+ 1342, 1349, 1355, 1361, 1361, 1363, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372,
+ 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372,
+ 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372, 1372,
+ 1372, 1372, 1372, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1375,
+ 1375, 1375, 1375, 1375, 1375, 1375, 1375, 1376, 1377, 1377, 1377, 1377, 1377, 1377, 1377,
+ 1377, 1378, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382, 1382,
+ 1382, 1382, 1382, 1382, 1382, 1382, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384,
+ 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384,
+ 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1384, 1386, 1386,
+ 1386, 1386, 1392, 1395, 1396, 1396, 1396, 1396, 1396, 1396, 1396, 1396, 1396, 1396, 1396,
+ 1396, 1396, 1396, 1396, 1396, 1399, 1402, 1402, 1402, 1402, 1402, 1402, 1402, 1402, 1402,
+ 1402, 1402, 1407, 1408, 1409, 1409, 1409, 1411, 1411, 1411, 1411, 1412, 1412, 1412, 1412,
+ 1412, 1412, 1412, 1412, 1413, 1414, 1414, 1414, 1414, 1414, 1414, 1414, 1414, 1414, 1414,
+ 1414, 1414, 1414, 1414, 1414, 1415, 1419, 1423, 1428, 1428, 1428, 1430, 1430, 1430, 1431,
+ 1431, 1432, 1433, 1434, 1435, 1438, 1440, 1442, 1442, 1442, 1443, 1443, 1443, 1443, 1443,
+ 1443, 1443, 1443, 1443, 1443
+ ];
+
+ const grapheme_cat_table: &'static [(char, char, GraphemeCat)] = &[
+ ('\u{0}', '\u{9}', GC_Control), ('\u{a}', '\u{a}', GC_LF), ('\u{b}', '\u{c}', GC_Control),
+ ('\u{d}', '\u{d}', GC_CR), ('\u{e}', '\u{1f}', GC_Control), ('\u{7f}', '\u{9f}',
+ GC_Control), ('\u{a9}', '\u{a9}', GC_Extended_Pictographic), ('\u{ad}', '\u{ad}',
+ GC_Control), ('\u{ae}', '\u{ae}', GC_Extended_Pictographic), ('\u{300}', '\u{36f}',
+ GC_Extend), ('\u{483}', '\u{489}', GC_Extend), ('\u{591}', '\u{5bd}', GC_Extend),
+ ('\u{5bf}', '\u{5bf}', GC_Extend), ('\u{5c1}', '\u{5c2}', GC_Extend), ('\u{5c4}', '\u{5c5}',
+ GC_Extend), ('\u{5c7}', '\u{5c7}', GC_Extend), ('\u{600}', '\u{605}', GC_Prepend),
+ ('\u{610}', '\u{61a}', GC_Extend), ('\u{61c}', '\u{61c}', GC_Control), ('\u{64b}',
+ '\u{65f}', GC_Extend), ('\u{670}', '\u{670}', GC_Extend), ('\u{6d6}', '\u{6dc}', GC_Extend),
+ ('\u{6dd}', '\u{6dd}', GC_Prepend), ('\u{6df}', '\u{6e4}', GC_Extend), ('\u{6e7}',
+ '\u{6e8}', GC_Extend), ('\u{6ea}', '\u{6ed}', GC_Extend), ('\u{70f}', '\u{70f}',
+ GC_Prepend), ('\u{711}', '\u{711}', GC_Extend), ('\u{730}', '\u{74a}', GC_Extend),
+ ('\u{7a6}', '\u{7b0}', GC_Extend), ('\u{7eb}', '\u{7f3}', GC_Extend), ('\u{7fd}', '\u{7fd}',
+ GC_Extend), ('\u{816}', '\u{819}', GC_Extend), ('\u{81b}', '\u{823}', GC_Extend),
+ ('\u{825}', '\u{827}', GC_Extend), ('\u{829}', '\u{82d}', GC_Extend), ('\u{859}', '\u{85b}',
+ GC_Extend), ('\u{890}', '\u{891}', GC_Prepend), ('\u{898}', '\u{89f}', GC_Extend),
+ ('\u{8ca}', '\u{8e1}', GC_Extend), ('\u{8e2}', '\u{8e2}', GC_Prepend), ('\u{8e3}',
+ '\u{902}', GC_Extend), ('\u{903}', '\u{903}', GC_SpacingMark), ('\u{93a}', '\u{93a}',
+ GC_Extend), ('\u{93b}', '\u{93b}', GC_SpacingMark), ('\u{93c}', '\u{93c}', GC_Extend),
+ ('\u{93e}', '\u{940}', GC_SpacingMark), ('\u{941}', '\u{948}', GC_Extend), ('\u{949}',
+ '\u{94c}', GC_SpacingMark), ('\u{94d}', '\u{94d}', GC_Extend), ('\u{94e}', '\u{94f}',
+ GC_SpacingMark), ('\u{951}', '\u{957}', GC_Extend), ('\u{962}', '\u{963}', GC_Extend),
+ ('\u{981}', '\u{981}', GC_Extend), ('\u{982}', '\u{983}', GC_SpacingMark), ('\u{9bc}',
+ '\u{9bc}', GC_Extend), ('\u{9be}', '\u{9be}', GC_Extend), ('\u{9bf}', '\u{9c0}',
+ GC_SpacingMark), ('\u{9c1}', '\u{9c4}', GC_Extend), ('\u{9c7}', '\u{9c8}', GC_SpacingMark),
+ ('\u{9cb}', '\u{9cc}', GC_SpacingMark), ('\u{9cd}', '\u{9cd}', GC_Extend), ('\u{9d7}',
+ '\u{9d7}', GC_Extend), ('\u{9e2}', '\u{9e3}', GC_Extend), ('\u{9fe}', '\u{9fe}', GC_Extend),
+ ('\u{a01}', '\u{a02}', GC_Extend), ('\u{a03}', '\u{a03}', GC_SpacingMark), ('\u{a3c}',
+ '\u{a3c}', GC_Extend), ('\u{a3e}', '\u{a40}', GC_SpacingMark), ('\u{a41}', '\u{a42}',
+ GC_Extend), ('\u{a47}', '\u{a48}', GC_Extend), ('\u{a4b}', '\u{a4d}', GC_Extend),
+ ('\u{a51}', '\u{a51}', GC_Extend), ('\u{a70}', '\u{a71}', GC_Extend), ('\u{a75}', '\u{a75}',
+ GC_Extend), ('\u{a81}', '\u{a82}', GC_Extend), ('\u{a83}', '\u{a83}', GC_SpacingMark),
+ ('\u{abc}', '\u{abc}', GC_Extend), ('\u{abe}', '\u{ac0}', GC_SpacingMark), ('\u{ac1}',
+ '\u{ac5}', GC_Extend), ('\u{ac7}', '\u{ac8}', GC_Extend), ('\u{ac9}', '\u{ac9}',
+ GC_SpacingMark), ('\u{acb}', '\u{acc}', GC_SpacingMark), ('\u{acd}', '\u{acd}', GC_Extend),
+ ('\u{ae2}', '\u{ae3}', GC_Extend), ('\u{afa}', '\u{aff}', GC_Extend), ('\u{b01}', '\u{b01}',
+ GC_Extend), ('\u{b02}', '\u{b03}', GC_SpacingMark), ('\u{b3c}', '\u{b3c}', GC_Extend),
+ ('\u{b3e}', '\u{b3f}', GC_Extend), ('\u{b40}', '\u{b40}', GC_SpacingMark), ('\u{b41}',
+ '\u{b44}', GC_Extend), ('\u{b47}', '\u{b48}', GC_SpacingMark), ('\u{b4b}', '\u{b4c}',
+ GC_SpacingMark), ('\u{b4d}', '\u{b4d}', GC_Extend), ('\u{b55}', '\u{b57}', GC_Extend),
+ ('\u{b62}', '\u{b63}', GC_Extend), ('\u{b82}', '\u{b82}', GC_Extend), ('\u{bbe}', '\u{bbe}',
+ GC_Extend), ('\u{bbf}', '\u{bbf}', GC_SpacingMark), ('\u{bc0}', '\u{bc0}', GC_Extend),
+ ('\u{bc1}', '\u{bc2}', GC_SpacingMark), ('\u{bc6}', '\u{bc8}', GC_SpacingMark), ('\u{bca}',
+ '\u{bcc}', GC_SpacingMark), ('\u{bcd}', '\u{bcd}', GC_Extend), ('\u{bd7}', '\u{bd7}',
+ GC_Extend), ('\u{c00}', '\u{c00}', GC_Extend), ('\u{c01}', '\u{c03}', GC_SpacingMark),
+ ('\u{c04}', '\u{c04}', GC_Extend), ('\u{c3c}', '\u{c3c}', GC_Extend), ('\u{c3e}', '\u{c40}',
+ GC_Extend), ('\u{c41}', '\u{c44}', GC_SpacingMark), ('\u{c46}', '\u{c48}', GC_Extend),
+ ('\u{c4a}', '\u{c4d}', GC_Extend), ('\u{c55}', '\u{c56}', GC_Extend), ('\u{c62}', '\u{c63}',
+ GC_Extend), ('\u{c81}', '\u{c81}', GC_Extend), ('\u{c82}', '\u{c83}', GC_SpacingMark),
+ ('\u{cbc}', '\u{cbc}', GC_Extend), ('\u{cbe}', '\u{cbe}', GC_SpacingMark), ('\u{cbf}',
+ '\u{cbf}', GC_Extend), ('\u{cc0}', '\u{cc1}', GC_SpacingMark), ('\u{cc2}', '\u{cc2}',
+ GC_Extend), ('\u{cc3}', '\u{cc4}', GC_SpacingMark), ('\u{cc6}', '\u{cc6}', GC_Extend),
+ ('\u{cc7}', '\u{cc8}', GC_SpacingMark), ('\u{cca}', '\u{ccb}', GC_SpacingMark), ('\u{ccc}',
+ '\u{ccd}', GC_Extend), ('\u{cd5}', '\u{cd6}', GC_Extend), ('\u{ce2}', '\u{ce3}', GC_Extend),
+ ('\u{cf3}', '\u{cf3}', GC_SpacingMark), ('\u{d00}', '\u{d01}', GC_Extend), ('\u{d02}',
+ '\u{d03}', GC_SpacingMark), ('\u{d3b}', '\u{d3c}', GC_Extend), ('\u{d3e}', '\u{d3e}',
+ GC_Extend), ('\u{d3f}', '\u{d40}', GC_SpacingMark), ('\u{d41}', '\u{d44}', GC_Extend),
+ ('\u{d46}', '\u{d48}', GC_SpacingMark), ('\u{d4a}', '\u{d4c}', GC_SpacingMark), ('\u{d4d}',
+ '\u{d4d}', GC_Extend), ('\u{d4e}', '\u{d4e}', GC_Prepend), ('\u{d57}', '\u{d57}',
+ GC_Extend), ('\u{d62}', '\u{d63}', GC_Extend), ('\u{d81}', '\u{d81}', GC_Extend),
+ ('\u{d82}', '\u{d83}', GC_SpacingMark), ('\u{dca}', '\u{dca}', GC_Extend), ('\u{dcf}',
+ '\u{dcf}', GC_Extend), ('\u{dd0}', '\u{dd1}', GC_SpacingMark), ('\u{dd2}', '\u{dd4}',
+ GC_Extend), ('\u{dd6}', '\u{dd6}', GC_Extend), ('\u{dd8}', '\u{dde}', GC_SpacingMark),
+ ('\u{ddf}', '\u{ddf}', GC_Extend), ('\u{df2}', '\u{df3}', GC_SpacingMark), ('\u{e31}',
+ '\u{e31}', GC_Extend), ('\u{e33}', '\u{e33}', GC_SpacingMark), ('\u{e34}', '\u{e3a}',
+ GC_Extend), ('\u{e47}', '\u{e4e}', GC_Extend), ('\u{eb1}', '\u{eb1}', GC_Extend),
+ ('\u{eb3}', '\u{eb3}', GC_SpacingMark), ('\u{eb4}', '\u{ebc}', GC_Extend), ('\u{ec8}',
+ '\u{ece}', GC_Extend), ('\u{f18}', '\u{f19}', GC_Extend), ('\u{f35}', '\u{f35}', GC_Extend),
+ ('\u{f37}', '\u{f37}', GC_Extend), ('\u{f39}', '\u{f39}', GC_Extend), ('\u{f3e}', '\u{f3f}',
+ GC_SpacingMark), ('\u{f71}', '\u{f7e}', GC_Extend), ('\u{f7f}', '\u{f7f}', GC_SpacingMark),
+ ('\u{f80}', '\u{f84}', GC_Extend), ('\u{f86}', '\u{f87}', GC_Extend), ('\u{f8d}', '\u{f97}',
+ GC_Extend), ('\u{f99}', '\u{fbc}', GC_Extend), ('\u{fc6}', '\u{fc6}', GC_Extend),
+ ('\u{102d}', '\u{1030}', GC_Extend), ('\u{1031}', '\u{1031}', GC_SpacingMark), ('\u{1032}',
+ '\u{1037}', GC_Extend), ('\u{1039}', '\u{103a}', GC_Extend), ('\u{103b}', '\u{103c}',
+ GC_SpacingMark), ('\u{103d}', '\u{103e}', GC_Extend), ('\u{1056}', '\u{1057}',
+ GC_SpacingMark), ('\u{1058}', '\u{1059}', GC_Extend), ('\u{105e}', '\u{1060}', GC_Extend),
+ ('\u{1071}', '\u{1074}', GC_Extend), ('\u{1082}', '\u{1082}', GC_Extend), ('\u{1084}',
+ '\u{1084}', GC_SpacingMark), ('\u{1085}', '\u{1086}', GC_Extend), ('\u{108d}', '\u{108d}',
+ GC_Extend), ('\u{109d}', '\u{109d}', GC_Extend), ('\u{1100}', '\u{115f}', GC_L),
+ ('\u{1160}', '\u{11a7}', GC_V), ('\u{11a8}', '\u{11ff}', GC_T), ('\u{135d}', '\u{135f}',
+ GC_Extend), ('\u{1712}', '\u{1714}', GC_Extend), ('\u{1715}', '\u{1715}', GC_SpacingMark),
+ ('\u{1732}', '\u{1733}', GC_Extend), ('\u{1734}', '\u{1734}', GC_SpacingMark), ('\u{1752}',
+ '\u{1753}', GC_Extend), ('\u{1772}', '\u{1773}', GC_Extend), ('\u{17b4}', '\u{17b5}',
+ GC_Extend), ('\u{17b6}', '\u{17b6}', GC_SpacingMark), ('\u{17b7}', '\u{17bd}', GC_Extend),
+ ('\u{17be}', '\u{17c5}', GC_SpacingMark), ('\u{17c6}', '\u{17c6}', GC_Extend), ('\u{17c7}',
+ '\u{17c8}', GC_SpacingMark), ('\u{17c9}', '\u{17d3}', GC_Extend), ('\u{17dd}', '\u{17dd}',
+ GC_Extend), ('\u{180b}', '\u{180d}', GC_Extend), ('\u{180e}', '\u{180e}', GC_Control),
+ ('\u{180f}', '\u{180f}', GC_Extend), ('\u{1885}', '\u{1886}', GC_Extend), ('\u{18a9}',
+ '\u{18a9}', GC_Extend), ('\u{1920}', '\u{1922}', GC_Extend), ('\u{1923}', '\u{1926}',
+ GC_SpacingMark), ('\u{1927}', '\u{1928}', GC_Extend), ('\u{1929}', '\u{192b}',
+ GC_SpacingMark), ('\u{1930}', '\u{1931}', GC_SpacingMark), ('\u{1932}', '\u{1932}',
+ GC_Extend), ('\u{1933}', '\u{1938}', GC_SpacingMark), ('\u{1939}', '\u{193b}', GC_Extend),
+ ('\u{1a17}', '\u{1a18}', GC_Extend), ('\u{1a19}', '\u{1a1a}', GC_SpacingMark), ('\u{1a1b}',
+ '\u{1a1b}', GC_Extend), ('\u{1a55}', '\u{1a55}', GC_SpacingMark), ('\u{1a56}', '\u{1a56}',
+ GC_Extend), ('\u{1a57}', '\u{1a57}', GC_SpacingMark), ('\u{1a58}', '\u{1a5e}', GC_Extend),
+ ('\u{1a60}', '\u{1a60}', GC_Extend), ('\u{1a62}', '\u{1a62}', GC_Extend), ('\u{1a65}',
+ '\u{1a6c}', GC_Extend), ('\u{1a6d}', '\u{1a72}', GC_SpacingMark), ('\u{1a73}', '\u{1a7c}',
+ GC_Extend), ('\u{1a7f}', '\u{1a7f}', GC_Extend), ('\u{1ab0}', '\u{1ace}', GC_Extend),
+ ('\u{1b00}', '\u{1b03}', GC_Extend), ('\u{1b04}', '\u{1b04}', GC_SpacingMark), ('\u{1b34}',
+ '\u{1b3a}', GC_Extend), ('\u{1b3b}', '\u{1b3b}', GC_SpacingMark), ('\u{1b3c}', '\u{1b3c}',
+ GC_Extend), ('\u{1b3d}', '\u{1b41}', GC_SpacingMark), ('\u{1b42}', '\u{1b42}', GC_Extend),
+ ('\u{1b43}', '\u{1b44}', GC_SpacingMark), ('\u{1b6b}', '\u{1b73}', GC_Extend), ('\u{1b80}',
+ '\u{1b81}', GC_Extend), ('\u{1b82}', '\u{1b82}', GC_SpacingMark), ('\u{1ba1}', '\u{1ba1}',
+ GC_SpacingMark), ('\u{1ba2}', '\u{1ba5}', GC_Extend), ('\u{1ba6}', '\u{1ba7}',
+ GC_SpacingMark), ('\u{1ba8}', '\u{1ba9}', GC_Extend), ('\u{1baa}', '\u{1baa}',
+ GC_SpacingMark), ('\u{1bab}', '\u{1bad}', GC_Extend), ('\u{1be6}', '\u{1be6}', GC_Extend),
+ ('\u{1be7}', '\u{1be7}', GC_SpacingMark), ('\u{1be8}', '\u{1be9}', GC_Extend), ('\u{1bea}',
+ '\u{1bec}', GC_SpacingMark), ('\u{1bed}', '\u{1bed}', GC_Extend), ('\u{1bee}', '\u{1bee}',
+ GC_SpacingMark), ('\u{1bef}', '\u{1bf1}', GC_Extend), ('\u{1bf2}', '\u{1bf3}',
+ GC_SpacingMark), ('\u{1c24}', '\u{1c2b}', GC_SpacingMark), ('\u{1c2c}', '\u{1c33}',
+ GC_Extend), ('\u{1c34}', '\u{1c35}', GC_SpacingMark), ('\u{1c36}', '\u{1c37}', GC_Extend),
+ ('\u{1cd0}', '\u{1cd2}', GC_Extend), ('\u{1cd4}', '\u{1ce0}', GC_Extend), ('\u{1ce1}',
+ '\u{1ce1}', GC_SpacingMark), ('\u{1ce2}', '\u{1ce8}', GC_Extend), ('\u{1ced}', '\u{1ced}',
+ GC_Extend), ('\u{1cf4}', '\u{1cf4}', GC_Extend), ('\u{1cf7}', '\u{1cf7}', GC_SpacingMark),
+ ('\u{1cf8}', '\u{1cf9}', GC_Extend), ('\u{1dc0}', '\u{1dff}', GC_Extend), ('\u{200b}',
+ '\u{200b}', GC_Control), ('\u{200c}', '\u{200c}', GC_Extend), ('\u{200d}', '\u{200d}',
+ GC_ZWJ), ('\u{200e}', '\u{200f}', GC_Control), ('\u{2028}', '\u{202e}', GC_Control),
+ ('\u{203c}', '\u{203c}', GC_Extended_Pictographic), ('\u{2049}', '\u{2049}',
+ GC_Extended_Pictographic), ('\u{2060}', '\u{206f}', GC_Control), ('\u{20d0}', '\u{20f0}',
+ GC_Extend), ('\u{2122}', '\u{2122}', GC_Extended_Pictographic), ('\u{2139}', '\u{2139}',
+ GC_Extended_Pictographic), ('\u{2194}', '\u{2199}', GC_Extended_Pictographic), ('\u{21a9}',
+ '\u{21aa}', GC_Extended_Pictographic), ('\u{231a}', '\u{231b}', GC_Extended_Pictographic),
+ ('\u{2328}', '\u{2328}', GC_Extended_Pictographic), ('\u{2388}', '\u{2388}',
+ GC_Extended_Pictographic), ('\u{23cf}', '\u{23cf}', GC_Extended_Pictographic), ('\u{23e9}',
+ '\u{23f3}', GC_Extended_Pictographic), ('\u{23f8}', '\u{23fa}', GC_Extended_Pictographic),
+ ('\u{24c2}', '\u{24c2}', GC_Extended_Pictographic), ('\u{25aa}', '\u{25ab}',
+ GC_Extended_Pictographic), ('\u{25b6}', '\u{25b6}', GC_Extended_Pictographic), ('\u{25c0}',
+ '\u{25c0}', GC_Extended_Pictographic), ('\u{25fb}', '\u{25fe}', GC_Extended_Pictographic),
+ ('\u{2600}', '\u{2605}', GC_Extended_Pictographic), ('\u{2607}', '\u{2612}',
+ GC_Extended_Pictographic), ('\u{2614}', '\u{2685}', GC_Extended_Pictographic), ('\u{2690}',
+ '\u{2705}', GC_Extended_Pictographic), ('\u{2708}', '\u{2712}', GC_Extended_Pictographic),
+ ('\u{2714}', '\u{2714}', GC_Extended_Pictographic), ('\u{2716}', '\u{2716}',
+ GC_Extended_Pictographic), ('\u{271d}', '\u{271d}', GC_Extended_Pictographic), ('\u{2721}',
+ '\u{2721}', GC_Extended_Pictographic), ('\u{2728}', '\u{2728}', GC_Extended_Pictographic),
+ ('\u{2733}', '\u{2734}', GC_Extended_Pictographic), ('\u{2744}', '\u{2744}',
+ GC_Extended_Pictographic), ('\u{2747}', '\u{2747}', GC_Extended_Pictographic), ('\u{274c}',
+ '\u{274c}', GC_Extended_Pictographic), ('\u{274e}', '\u{274e}', GC_Extended_Pictographic),
+ ('\u{2753}', '\u{2755}', GC_Extended_Pictographic), ('\u{2757}', '\u{2757}',
+ GC_Extended_Pictographic), ('\u{2763}', '\u{2767}', GC_Extended_Pictographic), ('\u{2795}',
+ '\u{2797}', GC_Extended_Pictographic), ('\u{27a1}', '\u{27a1}', GC_Extended_Pictographic),
+ ('\u{27b0}', '\u{27b0}', GC_Extended_Pictographic), ('\u{27bf}', '\u{27bf}',
+ GC_Extended_Pictographic), ('\u{2934}', '\u{2935}', GC_Extended_Pictographic), ('\u{2b05}',
+ '\u{2b07}', GC_Extended_Pictographic), ('\u{2b1b}', '\u{2b1c}', GC_Extended_Pictographic),
+ ('\u{2b50}', '\u{2b50}', GC_Extended_Pictographic), ('\u{2b55}', '\u{2b55}',
+ GC_Extended_Pictographic), ('\u{2cef}', '\u{2cf1}', GC_Extend), ('\u{2d7f}', '\u{2d7f}',
+ GC_Extend), ('\u{2de0}', '\u{2dff}', GC_Extend), ('\u{302a}', '\u{302f}', GC_Extend),
+ ('\u{3030}', '\u{3030}', GC_Extended_Pictographic), ('\u{303d}', '\u{303d}',
+ GC_Extended_Pictographic), ('\u{3099}', '\u{309a}', GC_Extend), ('\u{3297}', '\u{3297}',
+ GC_Extended_Pictographic), ('\u{3299}', '\u{3299}', GC_Extended_Pictographic), ('\u{a66f}',
+ '\u{a672}', GC_Extend), ('\u{a674}', '\u{a67d}', GC_Extend), ('\u{a69e}', '\u{a69f}',
+ GC_Extend), ('\u{a6f0}', '\u{a6f1}', GC_Extend), ('\u{a802}', '\u{a802}', GC_Extend),
+ ('\u{a806}', '\u{a806}', GC_Extend), ('\u{a80b}', '\u{a80b}', GC_Extend), ('\u{a823}',
+ '\u{a824}', GC_SpacingMark), ('\u{a825}', '\u{a826}', GC_Extend), ('\u{a827}', '\u{a827}',
+ GC_SpacingMark), ('\u{a82c}', '\u{a82c}', GC_Extend), ('\u{a880}', '\u{a881}',
+ GC_SpacingMark), ('\u{a8b4}', '\u{a8c3}', GC_SpacingMark), ('\u{a8c4}', '\u{a8c5}',
+ GC_Extend), ('\u{a8e0}', '\u{a8f1}', GC_Extend), ('\u{a8ff}', '\u{a8ff}', GC_Extend),
+ ('\u{a926}', '\u{a92d}', GC_Extend), ('\u{a947}', '\u{a951}', GC_Extend), ('\u{a952}',
+ '\u{a953}', GC_SpacingMark), ('\u{a960}', '\u{a97c}', GC_L), ('\u{a980}', '\u{a982}',
+ GC_Extend), ('\u{a983}', '\u{a983}', GC_SpacingMark), ('\u{a9b3}', '\u{a9b3}', GC_Extend),
+ ('\u{a9b4}', '\u{a9b5}', GC_SpacingMark), ('\u{a9b6}', '\u{a9b9}', GC_Extend), ('\u{a9ba}',
+ '\u{a9bb}', GC_SpacingMark), ('\u{a9bc}', '\u{a9bd}', GC_Extend), ('\u{a9be}', '\u{a9c0}',
+ GC_SpacingMark), ('\u{a9e5}', '\u{a9e5}', GC_Extend), ('\u{aa29}', '\u{aa2e}', GC_Extend),
+ ('\u{aa2f}', '\u{aa30}', GC_SpacingMark), ('\u{aa31}', '\u{aa32}', GC_Extend), ('\u{aa33}',
+ '\u{aa34}', GC_SpacingMark), ('\u{aa35}', '\u{aa36}', GC_Extend), ('\u{aa43}', '\u{aa43}',
+ GC_Extend), ('\u{aa4c}', '\u{aa4c}', GC_Extend), ('\u{aa4d}', '\u{aa4d}', GC_SpacingMark),
+ ('\u{aa7c}', '\u{aa7c}', GC_Extend), ('\u{aab0}', '\u{aab0}', GC_Extend), ('\u{aab2}',
+ '\u{aab4}', GC_Extend), ('\u{aab7}', '\u{aab8}', GC_Extend), ('\u{aabe}', '\u{aabf}',
+ GC_Extend), ('\u{aac1}', '\u{aac1}', GC_Extend), ('\u{aaeb}', '\u{aaeb}', GC_SpacingMark),
+ ('\u{aaec}', '\u{aaed}', GC_Extend), ('\u{aaee}', '\u{aaef}', GC_SpacingMark), ('\u{aaf5}',
+ '\u{aaf5}', GC_SpacingMark), ('\u{aaf6}', '\u{aaf6}', GC_Extend), ('\u{abe3}', '\u{abe4}',
+ GC_SpacingMark), ('\u{abe5}', '\u{abe5}', GC_Extend), ('\u{abe6}', '\u{abe7}',
+ GC_SpacingMark), ('\u{abe8}', '\u{abe8}', GC_Extend), ('\u{abe9}', '\u{abea}',
+ GC_SpacingMark), ('\u{abec}', '\u{abec}', GC_SpacingMark), ('\u{abed}', '\u{abed}',
+ GC_Extend), ('\u{ac00}', '\u{ac00}', GC_LV), ('\u{ac01}', '\u{ac1b}', GC_LVT), ('\u{ac1c}',
+ '\u{ac1c}', GC_LV), ('\u{ac1d}', '\u{ac37}', GC_LVT), ('\u{ac38}', '\u{ac38}', GC_LV),
+ ('\u{ac39}', '\u{ac53}', GC_LVT), ('\u{ac54}', '\u{ac54}', GC_LV), ('\u{ac55}', '\u{ac6f}',
+ GC_LVT), ('\u{ac70}', '\u{ac70}', GC_LV), ('\u{ac71}', '\u{ac8b}', GC_LVT), ('\u{ac8c}',
+ '\u{ac8c}', GC_LV), ('\u{ac8d}', '\u{aca7}', GC_LVT), ('\u{aca8}', '\u{aca8}', GC_LV),
+ ('\u{aca9}', '\u{acc3}', GC_LVT), ('\u{acc4}', '\u{acc4}', GC_LV), ('\u{acc5}', '\u{acdf}',
+ GC_LVT), ('\u{ace0}', '\u{ace0}', GC_LV), ('\u{ace1}', '\u{acfb}', GC_LVT), ('\u{acfc}',
+ '\u{acfc}', GC_LV), ('\u{acfd}', '\u{ad17}', GC_LVT), ('\u{ad18}', '\u{ad18}', GC_LV),
+ ('\u{ad19}', '\u{ad33}', GC_LVT), ('\u{ad34}', '\u{ad34}', GC_LV), ('\u{ad35}', '\u{ad4f}',
+ GC_LVT), ('\u{ad50}', '\u{ad50}', GC_LV), ('\u{ad51}', '\u{ad6b}', GC_LVT), ('\u{ad6c}',
+ '\u{ad6c}', GC_LV), ('\u{ad6d}', '\u{ad87}', GC_LVT), ('\u{ad88}', '\u{ad88}', GC_LV),
+ ('\u{ad89}', '\u{ada3}', GC_LVT), ('\u{ada4}', '\u{ada4}', GC_LV), ('\u{ada5}', '\u{adbf}',
+ GC_LVT), ('\u{adc0}', '\u{adc0}', GC_LV), ('\u{adc1}', '\u{addb}', GC_LVT), ('\u{addc}',
+ '\u{addc}', GC_LV), ('\u{addd}', '\u{adf7}', GC_LVT), ('\u{adf8}', '\u{adf8}', GC_LV),
+ ('\u{adf9}', '\u{ae13}', GC_LVT), ('\u{ae14}', '\u{ae14}', GC_LV), ('\u{ae15}', '\u{ae2f}',
+ GC_LVT), ('\u{ae30}', '\u{ae30}', GC_LV), ('\u{ae31}', '\u{ae4b}', GC_LVT), ('\u{ae4c}',
+ '\u{ae4c}', GC_LV), ('\u{ae4d}', '\u{ae67}', GC_LVT), ('\u{ae68}', '\u{ae68}', GC_LV),
+ ('\u{ae69}', '\u{ae83}', GC_LVT), ('\u{ae84}', '\u{ae84}', GC_LV), ('\u{ae85}', '\u{ae9f}',
+ GC_LVT), ('\u{aea0}', '\u{aea0}', GC_LV), ('\u{aea1}', '\u{aebb}', GC_LVT), ('\u{aebc}',
+ '\u{aebc}', GC_LV), ('\u{aebd}', '\u{aed7}', GC_LVT), ('\u{aed8}', '\u{aed8}', GC_LV),
+ ('\u{aed9}', '\u{aef3}', GC_LVT), ('\u{aef4}', '\u{aef4}', GC_LV), ('\u{aef5}', '\u{af0f}',
+ GC_LVT), ('\u{af10}', '\u{af10}', GC_LV), ('\u{af11}', '\u{af2b}', GC_LVT), ('\u{af2c}',
+ '\u{af2c}', GC_LV), ('\u{af2d}', '\u{af47}', GC_LVT), ('\u{af48}', '\u{af48}', GC_LV),
+ ('\u{af49}', '\u{af63}', GC_LVT), ('\u{af64}', '\u{af64}', GC_LV), ('\u{af65}', '\u{af7f}',
+ GC_LVT), ('\u{af80}', '\u{af80}', GC_LV), ('\u{af81}', '\u{af9b}', GC_LVT), ('\u{af9c}',
+ '\u{af9c}', GC_LV), ('\u{af9d}', '\u{afb7}', GC_LVT), ('\u{afb8}', '\u{afb8}', GC_LV),
+ ('\u{afb9}', '\u{afd3}', GC_LVT), ('\u{afd4}', '\u{afd4}', GC_LV), ('\u{afd5}', '\u{afef}',
+ GC_LVT), ('\u{aff0}', '\u{aff0}', GC_LV), ('\u{aff1}', '\u{b00b}', GC_LVT), ('\u{b00c}',
+ '\u{b00c}', GC_LV), ('\u{b00d}', '\u{b027}', GC_LVT), ('\u{b028}', '\u{b028}', GC_LV),
+ ('\u{b029}', '\u{b043}', GC_LVT), ('\u{b044}', '\u{b044}', GC_LV), ('\u{b045}', '\u{b05f}',
+ GC_LVT), ('\u{b060}', '\u{b060}', GC_LV), ('\u{b061}', '\u{b07b}', GC_LVT), ('\u{b07c}',
+ '\u{b07c}', GC_LV), ('\u{b07d}', '\u{b097}', GC_LVT), ('\u{b098}', '\u{b098}', GC_LV),
+ ('\u{b099}', '\u{b0b3}', GC_LVT), ('\u{b0b4}', '\u{b0b4}', GC_LV), ('\u{b0b5}', '\u{b0cf}',
+ GC_LVT), ('\u{b0d0}', '\u{b0d0}', GC_LV), ('\u{b0d1}', '\u{b0eb}', GC_LVT), ('\u{b0ec}',
+ '\u{b0ec}', GC_LV), ('\u{b0ed}', '\u{b107}', GC_LVT), ('\u{b108}', '\u{b108}', GC_LV),
+ ('\u{b109}', '\u{b123}', GC_LVT), ('\u{b124}', '\u{b124}', GC_LV), ('\u{b125}', '\u{b13f}',
+ GC_LVT), ('\u{b140}', '\u{b140}', GC_LV), ('\u{b141}', '\u{b15b}', GC_LVT), ('\u{b15c}',
+ '\u{b15c}', GC_LV), ('\u{b15d}', '\u{b177}', GC_LVT), ('\u{b178}', '\u{b178}', GC_LV),
+ ('\u{b179}', '\u{b193}', GC_LVT), ('\u{b194}', '\u{b194}', GC_LV), ('\u{b195}', '\u{b1af}',
+ GC_LVT), ('\u{b1b0}', '\u{b1b0}', GC_LV), ('\u{b1b1}', '\u{b1cb}', GC_LVT), ('\u{b1cc}',
+ '\u{b1cc}', GC_LV), ('\u{b1cd}', '\u{b1e7}', GC_LVT), ('\u{b1e8}', '\u{b1e8}', GC_LV),
+ ('\u{b1e9}', '\u{b203}', GC_LVT), ('\u{b204}', '\u{b204}', GC_LV), ('\u{b205}', '\u{b21f}',
+ GC_LVT), ('\u{b220}', '\u{b220}', GC_LV), ('\u{b221}', '\u{b23b}', GC_LVT), ('\u{b23c}',
+ '\u{b23c}', GC_LV), ('\u{b23d}', '\u{b257}', GC_LVT), ('\u{b258}', '\u{b258}', GC_LV),
+ ('\u{b259}', '\u{b273}', GC_LVT), ('\u{b274}', '\u{b274}', GC_LV), ('\u{b275}', '\u{b28f}',
+ GC_LVT), ('\u{b290}', '\u{b290}', GC_LV), ('\u{b291}', '\u{b2ab}', GC_LVT), ('\u{b2ac}',
+ '\u{b2ac}', GC_LV), ('\u{b2ad}', '\u{b2c7}', GC_LVT), ('\u{b2c8}', '\u{b2c8}', GC_LV),
+ ('\u{b2c9}', '\u{b2e3}', GC_LVT), ('\u{b2e4}', '\u{b2e4}', GC_LV), ('\u{b2e5}', '\u{b2ff}',
+ GC_LVT), ('\u{b300}', '\u{b300}', GC_LV), ('\u{b301}', '\u{b31b}', GC_LVT), ('\u{b31c}',
+ '\u{b31c}', GC_LV), ('\u{b31d}', '\u{b337}', GC_LVT), ('\u{b338}', '\u{b338}', GC_LV),
+ ('\u{b339}', '\u{b353}', GC_LVT), ('\u{b354}', '\u{b354}', GC_LV), ('\u{b355}', '\u{b36f}',
+ GC_LVT), ('\u{b370}', '\u{b370}', GC_LV), ('\u{b371}', '\u{b38b}', GC_LVT), ('\u{b38c}',
+ '\u{b38c}', GC_LV), ('\u{b38d}', '\u{b3a7}', GC_LVT), ('\u{b3a8}', '\u{b3a8}', GC_LV),
+ ('\u{b3a9}', '\u{b3c3}', GC_LVT), ('\u{b3c4}', '\u{b3c4}', GC_LV), ('\u{b3c5}', '\u{b3df}',
+ GC_LVT), ('\u{b3e0}', '\u{b3e0}', GC_LV), ('\u{b3e1}', '\u{b3fb}', GC_LVT), ('\u{b3fc}',
+ '\u{b3fc}', GC_LV), ('\u{b3fd}', '\u{b417}', GC_LVT), ('\u{b418}', '\u{b418}', GC_LV),
+ ('\u{b419}', '\u{b433}', GC_LVT), ('\u{b434}', '\u{b434}', GC_LV), ('\u{b435}', '\u{b44f}',
+ GC_LVT), ('\u{b450}', '\u{b450}', GC_LV), ('\u{b451}', '\u{b46b}', GC_LVT), ('\u{b46c}',
+ '\u{b46c}', GC_LV), ('\u{b46d}', '\u{b487}', GC_LVT), ('\u{b488}', '\u{b488}', GC_LV),
+ ('\u{b489}', '\u{b4a3}', GC_LVT), ('\u{b4a4}', '\u{b4a4}', GC_LV), ('\u{b4a5}', '\u{b4bf}',
+ GC_LVT), ('\u{b4c0}', '\u{b4c0}', GC_LV), ('\u{b4c1}', '\u{b4db}', GC_LVT), ('\u{b4dc}',
+ '\u{b4dc}', GC_LV), ('\u{b4dd}', '\u{b4f7}', GC_LVT), ('\u{b4f8}', '\u{b4f8}', GC_LV),
+ ('\u{b4f9}', '\u{b513}', GC_LVT), ('\u{b514}', '\u{b514}', GC_LV), ('\u{b515}', '\u{b52f}',
+ GC_LVT), ('\u{b530}', '\u{b530}', GC_LV), ('\u{b531}', '\u{b54b}', GC_LVT), ('\u{b54c}',
+ '\u{b54c}', GC_LV), ('\u{b54d}', '\u{b567}', GC_LVT), ('\u{b568}', '\u{b568}', GC_LV),
+ ('\u{b569}', '\u{b583}', GC_LVT), ('\u{b584}', '\u{b584}', GC_LV), ('\u{b585}', '\u{b59f}',
+ GC_LVT), ('\u{b5a0}', '\u{b5a0}', GC_LV), ('\u{b5a1}', '\u{b5bb}', GC_LVT), ('\u{b5bc}',
+ '\u{b5bc}', GC_LV), ('\u{b5bd}', '\u{b5d7}', GC_LVT), ('\u{b5d8}', '\u{b5d8}', GC_LV),
+ ('\u{b5d9}', '\u{b5f3}', GC_LVT), ('\u{b5f4}', '\u{b5f4}', GC_LV), ('\u{b5f5}', '\u{b60f}',
+ GC_LVT), ('\u{b610}', '\u{b610}', GC_LV), ('\u{b611}', '\u{b62b}', GC_LVT), ('\u{b62c}',
+ '\u{b62c}', GC_LV), ('\u{b62d}', '\u{b647}', GC_LVT), ('\u{b648}', '\u{b648}', GC_LV),
+ ('\u{b649}', '\u{b663}', GC_LVT), ('\u{b664}', '\u{b664}', GC_LV), ('\u{b665}', '\u{b67f}',
+ GC_LVT), ('\u{b680}', '\u{b680}', GC_LV), ('\u{b681}', '\u{b69b}', GC_LVT), ('\u{b69c}',
+ '\u{b69c}', GC_LV), ('\u{b69d}', '\u{b6b7}', GC_LVT), ('\u{b6b8}', '\u{b6b8}', GC_LV),
+ ('\u{b6b9}', '\u{b6d3}', GC_LVT), ('\u{b6d4}', '\u{b6d4}', GC_LV), ('\u{b6d5}', '\u{b6ef}',
+ GC_LVT), ('\u{b6f0}', '\u{b6f0}', GC_LV), ('\u{b6f1}', '\u{b70b}', GC_LVT), ('\u{b70c}',
+ '\u{b70c}', GC_LV), ('\u{b70d}', '\u{b727}', GC_LVT), ('\u{b728}', '\u{b728}', GC_LV),
+ ('\u{b729}', '\u{b743}', GC_LVT), ('\u{b744}', '\u{b744}', GC_LV), ('\u{b745}', '\u{b75f}',
+ GC_LVT), ('\u{b760}', '\u{b760}', GC_LV), ('\u{b761}', '\u{b77b}', GC_LVT), ('\u{b77c}',
+ '\u{b77c}', GC_LV), ('\u{b77d}', '\u{b797}', GC_LVT), ('\u{b798}', '\u{b798}', GC_LV),
+ ('\u{b799}', '\u{b7b3}', GC_LVT), ('\u{b7b4}', '\u{b7b4}', GC_LV), ('\u{b7b5}', '\u{b7cf}',
+ GC_LVT), ('\u{b7d0}', '\u{b7d0}', GC_LV), ('\u{b7d1}', '\u{b7eb}', GC_LVT), ('\u{b7ec}',
+ '\u{b7ec}', GC_LV), ('\u{b7ed}', '\u{b807}', GC_LVT), ('\u{b808}', '\u{b808}', GC_LV),
+ ('\u{b809}', '\u{b823}', GC_LVT), ('\u{b824}', '\u{b824}', GC_LV), ('\u{b825}', '\u{b83f}',
+ GC_LVT), ('\u{b840}', '\u{b840}', GC_LV), ('\u{b841}', '\u{b85b}', GC_LVT), ('\u{b85c}',
+ '\u{b85c}', GC_LV), ('\u{b85d}', '\u{b877}', GC_LVT), ('\u{b878}', '\u{b878}', GC_LV),
+ ('\u{b879}', '\u{b893}', GC_LVT), ('\u{b894}', '\u{b894}', GC_LV), ('\u{b895}', '\u{b8af}',
+ GC_LVT), ('\u{b8b0}', '\u{b8b0}', GC_LV), ('\u{b8b1}', '\u{b8cb}', GC_LVT), ('\u{b8cc}',
+ '\u{b8cc}', GC_LV), ('\u{b8cd}', '\u{b8e7}', GC_LVT), ('\u{b8e8}', '\u{b8e8}', GC_LV),
+ ('\u{b8e9}', '\u{b903}', GC_LVT), ('\u{b904}', '\u{b904}', GC_LV), ('\u{b905}', '\u{b91f}',
+ GC_LVT), ('\u{b920}', '\u{b920}', GC_LV), ('\u{b921}', '\u{b93b}', GC_LVT), ('\u{b93c}',
+ '\u{b93c}', GC_LV), ('\u{b93d}', '\u{b957}', GC_LVT), ('\u{b958}', '\u{b958}', GC_LV),
+ ('\u{b959}', '\u{b973}', GC_LVT), ('\u{b974}', '\u{b974}', GC_LV), ('\u{b975}', '\u{b98f}',
+ GC_LVT), ('\u{b990}', '\u{b990}', GC_LV), ('\u{b991}', '\u{b9ab}', GC_LVT), ('\u{b9ac}',
+ '\u{b9ac}', GC_LV), ('\u{b9ad}', '\u{b9c7}', GC_LVT), ('\u{b9c8}', '\u{b9c8}', GC_LV),
+ ('\u{b9c9}', '\u{b9e3}', GC_LVT), ('\u{b9e4}', '\u{b9e4}', GC_LV), ('\u{b9e5}', '\u{b9ff}',
+ GC_LVT), ('\u{ba00}', '\u{ba00}', GC_LV), ('\u{ba01}', '\u{ba1b}', GC_LVT), ('\u{ba1c}',
+ '\u{ba1c}', GC_LV), ('\u{ba1d}', '\u{ba37}', GC_LVT), ('\u{ba38}', '\u{ba38}', GC_LV),
+ ('\u{ba39}', '\u{ba53}', GC_LVT), ('\u{ba54}', '\u{ba54}', GC_LV), ('\u{ba55}', '\u{ba6f}',
+ GC_LVT), ('\u{ba70}', '\u{ba70}', GC_LV), ('\u{ba71}', '\u{ba8b}', GC_LVT), ('\u{ba8c}',
+ '\u{ba8c}', GC_LV), ('\u{ba8d}', '\u{baa7}', GC_LVT), ('\u{baa8}', '\u{baa8}', GC_LV),
+ ('\u{baa9}', '\u{bac3}', GC_LVT), ('\u{bac4}', '\u{bac4}', GC_LV), ('\u{bac5}', '\u{badf}',
+ GC_LVT), ('\u{bae0}', '\u{bae0}', GC_LV), ('\u{bae1}', '\u{bafb}', GC_LVT), ('\u{bafc}',
+ '\u{bafc}', GC_LV), ('\u{bafd}', '\u{bb17}', GC_LVT), ('\u{bb18}', '\u{bb18}', GC_LV),
+ ('\u{bb19}', '\u{bb33}', GC_LVT), ('\u{bb34}', '\u{bb34}', GC_LV), ('\u{bb35}', '\u{bb4f}',
+ GC_LVT), ('\u{bb50}', '\u{bb50}', GC_LV), ('\u{bb51}', '\u{bb6b}', GC_LVT), ('\u{bb6c}',
+ '\u{bb6c}', GC_LV), ('\u{bb6d}', '\u{bb87}', GC_LVT), ('\u{bb88}', '\u{bb88}', GC_LV),
+ ('\u{bb89}', '\u{bba3}', GC_LVT), ('\u{bba4}', '\u{bba4}', GC_LV), ('\u{bba5}', '\u{bbbf}',
+ GC_LVT), ('\u{bbc0}', '\u{bbc0}', GC_LV), ('\u{bbc1}', '\u{bbdb}', GC_LVT), ('\u{bbdc}',
+ '\u{bbdc}', GC_LV), ('\u{bbdd}', '\u{bbf7}', GC_LVT), ('\u{bbf8}', '\u{bbf8}', GC_LV),
+ ('\u{bbf9}', '\u{bc13}', GC_LVT), ('\u{bc14}', '\u{bc14}', GC_LV), ('\u{bc15}', '\u{bc2f}',
+ GC_LVT), ('\u{bc30}', '\u{bc30}', GC_LV), ('\u{bc31}', '\u{bc4b}', GC_LVT), ('\u{bc4c}',
+ '\u{bc4c}', GC_LV), ('\u{bc4d}', '\u{bc67}', GC_LVT), ('\u{bc68}', '\u{bc68}', GC_LV),
+ ('\u{bc69}', '\u{bc83}', GC_LVT), ('\u{bc84}', '\u{bc84}', GC_LV), ('\u{bc85}', '\u{bc9f}',
+ GC_LVT), ('\u{bca0}', '\u{bca0}', GC_LV), ('\u{bca1}', '\u{bcbb}', GC_LVT), ('\u{bcbc}',
+ '\u{bcbc}', GC_LV), ('\u{bcbd}', '\u{bcd7}', GC_LVT), ('\u{bcd8}', '\u{bcd8}', GC_LV),
+ ('\u{bcd9}', '\u{bcf3}', GC_LVT), ('\u{bcf4}', '\u{bcf4}', GC_LV), ('\u{bcf5}', '\u{bd0f}',
+ GC_LVT), ('\u{bd10}', '\u{bd10}', GC_LV), ('\u{bd11}', '\u{bd2b}', GC_LVT), ('\u{bd2c}',
+ '\u{bd2c}', GC_LV), ('\u{bd2d}', '\u{bd47}', GC_LVT), ('\u{bd48}', '\u{bd48}', GC_LV),
+ ('\u{bd49}', '\u{bd63}', GC_LVT), ('\u{bd64}', '\u{bd64}', GC_LV), ('\u{bd65}', '\u{bd7f}',
+ GC_LVT), ('\u{bd80}', '\u{bd80}', GC_LV), ('\u{bd81}', '\u{bd9b}', GC_LVT), ('\u{bd9c}',
+ '\u{bd9c}', GC_LV), ('\u{bd9d}', '\u{bdb7}', GC_LVT), ('\u{bdb8}', '\u{bdb8}', GC_LV),
+ ('\u{bdb9}', '\u{bdd3}', GC_LVT), ('\u{bdd4}', '\u{bdd4}', GC_LV), ('\u{bdd5}', '\u{bdef}',
+ GC_LVT), ('\u{bdf0}', '\u{bdf0}', GC_LV), ('\u{bdf1}', '\u{be0b}', GC_LVT), ('\u{be0c}',
+ '\u{be0c}', GC_LV), ('\u{be0d}', '\u{be27}', GC_LVT), ('\u{be28}', '\u{be28}', GC_LV),
+ ('\u{be29}', '\u{be43}', GC_LVT), ('\u{be44}', '\u{be44}', GC_LV), ('\u{be45}', '\u{be5f}',
+ GC_LVT), ('\u{be60}', '\u{be60}', GC_LV), ('\u{be61}', '\u{be7b}', GC_LVT), ('\u{be7c}',
+ '\u{be7c}', GC_LV), ('\u{be7d}', '\u{be97}', GC_LVT), ('\u{be98}', '\u{be98}', GC_LV),
+ ('\u{be99}', '\u{beb3}', GC_LVT), ('\u{beb4}', '\u{beb4}', GC_LV), ('\u{beb5}', '\u{becf}',
+ GC_LVT), ('\u{bed0}', '\u{bed0}', GC_LV), ('\u{bed1}', '\u{beeb}', GC_LVT), ('\u{beec}',
+ '\u{beec}', GC_LV), ('\u{beed}', '\u{bf07}', GC_LVT), ('\u{bf08}', '\u{bf08}', GC_LV),
+ ('\u{bf09}', '\u{bf23}', GC_LVT), ('\u{bf24}', '\u{bf24}', GC_LV), ('\u{bf25}', '\u{bf3f}',
+ GC_LVT), ('\u{bf40}', '\u{bf40}', GC_LV), ('\u{bf41}', '\u{bf5b}', GC_LVT), ('\u{bf5c}',
+ '\u{bf5c}', GC_LV), ('\u{bf5d}', '\u{bf77}', GC_LVT), ('\u{bf78}', '\u{bf78}', GC_LV),
+ ('\u{bf79}', '\u{bf93}', GC_LVT), ('\u{bf94}', '\u{bf94}', GC_LV), ('\u{bf95}', '\u{bfaf}',
+ GC_LVT), ('\u{bfb0}', '\u{bfb0}', GC_LV), ('\u{bfb1}', '\u{bfcb}', GC_LVT), ('\u{bfcc}',
+ '\u{bfcc}', GC_LV), ('\u{bfcd}', '\u{bfe7}', GC_LVT), ('\u{bfe8}', '\u{bfe8}', GC_LV),
+ ('\u{bfe9}', '\u{c003}', GC_LVT), ('\u{c004}', '\u{c004}', GC_LV), ('\u{c005}', '\u{c01f}',
+ GC_LVT), ('\u{c020}', '\u{c020}', GC_LV), ('\u{c021}', '\u{c03b}', GC_LVT), ('\u{c03c}',
+ '\u{c03c}', GC_LV), ('\u{c03d}', '\u{c057}', GC_LVT), ('\u{c058}', '\u{c058}', GC_LV),
+ ('\u{c059}', '\u{c073}', GC_LVT), ('\u{c074}', '\u{c074}', GC_LV), ('\u{c075}', '\u{c08f}',
+ GC_LVT), ('\u{c090}', '\u{c090}', GC_LV), ('\u{c091}', '\u{c0ab}', GC_LVT), ('\u{c0ac}',
+ '\u{c0ac}', GC_LV), ('\u{c0ad}', '\u{c0c7}', GC_LVT), ('\u{c0c8}', '\u{c0c8}', GC_LV),
+ ('\u{c0c9}', '\u{c0e3}', GC_LVT), ('\u{c0e4}', '\u{c0e4}', GC_LV), ('\u{c0e5}', '\u{c0ff}',
+ GC_LVT), ('\u{c100}', '\u{c100}', GC_LV), ('\u{c101}', '\u{c11b}', GC_LVT), ('\u{c11c}',
+ '\u{c11c}', GC_LV), ('\u{c11d}', '\u{c137}', GC_LVT), ('\u{c138}', '\u{c138}', GC_LV),
+ ('\u{c139}', '\u{c153}', GC_LVT), ('\u{c154}', '\u{c154}', GC_LV), ('\u{c155}', '\u{c16f}',
+ GC_LVT), ('\u{c170}', '\u{c170}', GC_LV), ('\u{c171}', '\u{c18b}', GC_LVT), ('\u{c18c}',
+ '\u{c18c}', GC_LV), ('\u{c18d}', '\u{c1a7}', GC_LVT), ('\u{c1a8}', '\u{c1a8}', GC_LV),
+ ('\u{c1a9}', '\u{c1c3}', GC_LVT), ('\u{c1c4}', '\u{c1c4}', GC_LV), ('\u{c1c5}', '\u{c1df}',
+ GC_LVT), ('\u{c1e0}', '\u{c1e0}', GC_LV), ('\u{c1e1}', '\u{c1fb}', GC_LVT), ('\u{c1fc}',
+ '\u{c1fc}', GC_LV), ('\u{c1fd}', '\u{c217}', GC_LVT), ('\u{c218}', '\u{c218}', GC_LV),
+ ('\u{c219}', '\u{c233}', GC_LVT), ('\u{c234}', '\u{c234}', GC_LV), ('\u{c235}', '\u{c24f}',
+ GC_LVT), ('\u{c250}', '\u{c250}', GC_LV), ('\u{c251}', '\u{c26b}', GC_LVT), ('\u{c26c}',
+ '\u{c26c}', GC_LV), ('\u{c26d}', '\u{c287}', GC_LVT), ('\u{c288}', '\u{c288}', GC_LV),
+ ('\u{c289}', '\u{c2a3}', GC_LVT), ('\u{c2a4}', '\u{c2a4}', GC_LV), ('\u{c2a5}', '\u{c2bf}',
+ GC_LVT), ('\u{c2c0}', '\u{c2c0}', GC_LV), ('\u{c2c1}', '\u{c2db}', GC_LVT), ('\u{c2dc}',
+ '\u{c2dc}', GC_LV), ('\u{c2dd}', '\u{c2f7}', GC_LVT), ('\u{c2f8}', '\u{c2f8}', GC_LV),
+ ('\u{c2f9}', '\u{c313}', GC_LVT), ('\u{c314}', '\u{c314}', GC_LV), ('\u{c315}', '\u{c32f}',
+ GC_LVT), ('\u{c330}', '\u{c330}', GC_LV), ('\u{c331}', '\u{c34b}', GC_LVT), ('\u{c34c}',
+ '\u{c34c}', GC_LV), ('\u{c34d}', '\u{c367}', GC_LVT), ('\u{c368}', '\u{c368}', GC_LV),
+ ('\u{c369}', '\u{c383}', GC_LVT), ('\u{c384}', '\u{c384}', GC_LV), ('\u{c385}', '\u{c39f}',
+ GC_LVT), ('\u{c3a0}', '\u{c3a0}', GC_LV), ('\u{c3a1}', '\u{c3bb}', GC_LVT), ('\u{c3bc}',
+ '\u{c3bc}', GC_LV), ('\u{c3bd}', '\u{c3d7}', GC_LVT), ('\u{c3d8}', '\u{c3d8}', GC_LV),
+ ('\u{c3d9}', '\u{c3f3}', GC_LVT), ('\u{c3f4}', '\u{c3f4}', GC_LV), ('\u{c3f5}', '\u{c40f}',
+ GC_LVT), ('\u{c410}', '\u{c410}', GC_LV), ('\u{c411}', '\u{c42b}', GC_LVT), ('\u{c42c}',
+ '\u{c42c}', GC_LV), ('\u{c42d}', '\u{c447}', GC_LVT), ('\u{c448}', '\u{c448}', GC_LV),
+ ('\u{c449}', '\u{c463}', GC_LVT), ('\u{c464}', '\u{c464}', GC_LV), ('\u{c465}', '\u{c47f}',
+ GC_LVT), ('\u{c480}', '\u{c480}', GC_LV), ('\u{c481}', '\u{c49b}', GC_LVT), ('\u{c49c}',
+ '\u{c49c}', GC_LV), ('\u{c49d}', '\u{c4b7}', GC_LVT), ('\u{c4b8}', '\u{c4b8}', GC_LV),
+ ('\u{c4b9}', '\u{c4d3}', GC_LVT), ('\u{c4d4}', '\u{c4d4}', GC_LV), ('\u{c4d5}', '\u{c4ef}',
+ GC_LVT), ('\u{c4f0}', '\u{c4f0}', GC_LV), ('\u{c4f1}', '\u{c50b}', GC_LVT), ('\u{c50c}',
+ '\u{c50c}', GC_LV), ('\u{c50d}', '\u{c527}', GC_LVT), ('\u{c528}', '\u{c528}', GC_LV),
+ ('\u{c529}', '\u{c543}', GC_LVT), ('\u{c544}', '\u{c544}', GC_LV), ('\u{c545}', '\u{c55f}',
+ GC_LVT), ('\u{c560}', '\u{c560}', GC_LV), ('\u{c561}', '\u{c57b}', GC_LVT), ('\u{c57c}',
+ '\u{c57c}', GC_LV), ('\u{c57d}', '\u{c597}', GC_LVT), ('\u{c598}', '\u{c598}', GC_LV),
+ ('\u{c599}', '\u{c5b3}', GC_LVT), ('\u{c5b4}', '\u{c5b4}', GC_LV), ('\u{c5b5}', '\u{c5cf}',
+ GC_LVT), ('\u{c5d0}', '\u{c5d0}', GC_LV), ('\u{c5d1}', '\u{c5eb}', GC_LVT), ('\u{c5ec}',
+ '\u{c5ec}', GC_LV), ('\u{c5ed}', '\u{c607}', GC_LVT), ('\u{c608}', '\u{c608}', GC_LV),
+ ('\u{c609}', '\u{c623}', GC_LVT), ('\u{c624}', '\u{c624}', GC_LV), ('\u{c625}', '\u{c63f}',
+ GC_LVT), ('\u{c640}', '\u{c640}', GC_LV), ('\u{c641}', '\u{c65b}', GC_LVT), ('\u{c65c}',
+ '\u{c65c}', GC_LV), ('\u{c65d}', '\u{c677}', GC_LVT), ('\u{c678}', '\u{c678}', GC_LV),
+ ('\u{c679}', '\u{c693}', GC_LVT), ('\u{c694}', '\u{c694}', GC_LV), ('\u{c695}', '\u{c6af}',
+ GC_LVT), ('\u{c6b0}', '\u{c6b0}', GC_LV), ('\u{c6b1}', '\u{c6cb}', GC_LVT), ('\u{c6cc}',
+ '\u{c6cc}', GC_LV), ('\u{c6cd}', '\u{c6e7}', GC_LVT), ('\u{c6e8}', '\u{c6e8}', GC_LV),
+ ('\u{c6e9}', '\u{c703}', GC_LVT), ('\u{c704}', '\u{c704}', GC_LV), ('\u{c705}', '\u{c71f}',
+ GC_LVT), ('\u{c720}', '\u{c720}', GC_LV), ('\u{c721}', '\u{c73b}', GC_LVT), ('\u{c73c}',
+ '\u{c73c}', GC_LV), ('\u{c73d}', '\u{c757}', GC_LVT), ('\u{c758}', '\u{c758}', GC_LV),
+ ('\u{c759}', '\u{c773}', GC_LVT), ('\u{c774}', '\u{c774}', GC_LV), ('\u{c775}', '\u{c78f}',
+ GC_LVT), ('\u{c790}', '\u{c790}', GC_LV), ('\u{c791}', '\u{c7ab}', GC_LVT), ('\u{c7ac}',
+ '\u{c7ac}', GC_LV), ('\u{c7ad}', '\u{c7c7}', GC_LVT), ('\u{c7c8}', '\u{c7c8}', GC_LV),
+ ('\u{c7c9}', '\u{c7e3}', GC_LVT), ('\u{c7e4}', '\u{c7e4}', GC_LV), ('\u{c7e5}', '\u{c7ff}',
+ GC_LVT), ('\u{c800}', '\u{c800}', GC_LV), ('\u{c801}', '\u{c81b}', GC_LVT), ('\u{c81c}',
+ '\u{c81c}', GC_LV), ('\u{c81d}', '\u{c837}', GC_LVT), ('\u{c838}', '\u{c838}', GC_LV),
+ ('\u{c839}', '\u{c853}', GC_LVT), ('\u{c854}', '\u{c854}', GC_LV), ('\u{c855}', '\u{c86f}',
+ GC_LVT), ('\u{c870}', '\u{c870}', GC_LV), ('\u{c871}', '\u{c88b}', GC_LVT), ('\u{c88c}',
+ '\u{c88c}', GC_LV), ('\u{c88d}', '\u{c8a7}', GC_LVT), ('\u{c8a8}', '\u{c8a8}', GC_LV),
+ ('\u{c8a9}', '\u{c8c3}', GC_LVT), ('\u{c8c4}', '\u{c8c4}', GC_LV), ('\u{c8c5}', '\u{c8df}',
+ GC_LVT), ('\u{c8e0}', '\u{c8e0}', GC_LV), ('\u{c8e1}', '\u{c8fb}', GC_LVT), ('\u{c8fc}',
+ '\u{c8fc}', GC_LV), ('\u{c8fd}', '\u{c917}', GC_LVT), ('\u{c918}', '\u{c918}', GC_LV),
+ ('\u{c919}', '\u{c933}', GC_LVT), ('\u{c934}', '\u{c934}', GC_LV), ('\u{c935}', '\u{c94f}',
+ GC_LVT), ('\u{c950}', '\u{c950}', GC_LV), ('\u{c951}', '\u{c96b}', GC_LVT), ('\u{c96c}',
+ '\u{c96c}', GC_LV), ('\u{c96d}', '\u{c987}', GC_LVT), ('\u{c988}', '\u{c988}', GC_LV),
+ ('\u{c989}', '\u{c9a3}', GC_LVT), ('\u{c9a4}', '\u{c9a4}', GC_LV), ('\u{c9a5}', '\u{c9bf}',
+ GC_LVT), ('\u{c9c0}', '\u{c9c0}', GC_LV), ('\u{c9c1}', '\u{c9db}', GC_LVT), ('\u{c9dc}',
+ '\u{c9dc}', GC_LV), ('\u{c9dd}', '\u{c9f7}', GC_LVT), ('\u{c9f8}', '\u{c9f8}', GC_LV),
+ ('\u{c9f9}', '\u{ca13}', GC_LVT), ('\u{ca14}', '\u{ca14}', GC_LV), ('\u{ca15}', '\u{ca2f}',
+ GC_LVT), ('\u{ca30}', '\u{ca30}', GC_LV), ('\u{ca31}', '\u{ca4b}', GC_LVT), ('\u{ca4c}',
+ '\u{ca4c}', GC_LV), ('\u{ca4d}', '\u{ca67}', GC_LVT), ('\u{ca68}', '\u{ca68}', GC_LV),
+ ('\u{ca69}', '\u{ca83}', GC_LVT), ('\u{ca84}', '\u{ca84}', GC_LV), ('\u{ca85}', '\u{ca9f}',
+ GC_LVT), ('\u{caa0}', '\u{caa0}', GC_LV), ('\u{caa1}', '\u{cabb}', GC_LVT), ('\u{cabc}',
+ '\u{cabc}', GC_LV), ('\u{cabd}', '\u{cad7}', GC_LVT), ('\u{cad8}', '\u{cad8}', GC_LV),
+ ('\u{cad9}', '\u{caf3}', GC_LVT), ('\u{caf4}', '\u{caf4}', GC_LV), ('\u{caf5}', '\u{cb0f}',
+ GC_LVT), ('\u{cb10}', '\u{cb10}', GC_LV), ('\u{cb11}', '\u{cb2b}', GC_LVT), ('\u{cb2c}',
+ '\u{cb2c}', GC_LV), ('\u{cb2d}', '\u{cb47}', GC_LVT), ('\u{cb48}', '\u{cb48}', GC_LV),
+ ('\u{cb49}', '\u{cb63}', GC_LVT), ('\u{cb64}', '\u{cb64}', GC_LV), ('\u{cb65}', '\u{cb7f}',
+ GC_LVT), ('\u{cb80}', '\u{cb80}', GC_LV), ('\u{cb81}', '\u{cb9b}', GC_LVT), ('\u{cb9c}',
+ '\u{cb9c}', GC_LV), ('\u{cb9d}', '\u{cbb7}', GC_LVT), ('\u{cbb8}', '\u{cbb8}', GC_LV),
+ ('\u{cbb9}', '\u{cbd3}', GC_LVT), ('\u{cbd4}', '\u{cbd4}', GC_LV), ('\u{cbd5}', '\u{cbef}',
+ GC_LVT), ('\u{cbf0}', '\u{cbf0}', GC_LV), ('\u{cbf1}', '\u{cc0b}', GC_LVT), ('\u{cc0c}',
+ '\u{cc0c}', GC_LV), ('\u{cc0d}', '\u{cc27}', GC_LVT), ('\u{cc28}', '\u{cc28}', GC_LV),
+ ('\u{cc29}', '\u{cc43}', GC_LVT), ('\u{cc44}', '\u{cc44}', GC_LV), ('\u{cc45}', '\u{cc5f}',
+ GC_LVT), ('\u{cc60}', '\u{cc60}', GC_LV), ('\u{cc61}', '\u{cc7b}', GC_LVT), ('\u{cc7c}',
+ '\u{cc7c}', GC_LV), ('\u{cc7d}', '\u{cc97}', GC_LVT), ('\u{cc98}', '\u{cc98}', GC_LV),
+ ('\u{cc99}', '\u{ccb3}', GC_LVT), ('\u{ccb4}', '\u{ccb4}', GC_LV), ('\u{ccb5}', '\u{cccf}',
+ GC_LVT), ('\u{ccd0}', '\u{ccd0}', GC_LV), ('\u{ccd1}', '\u{cceb}', GC_LVT), ('\u{ccec}',
+ '\u{ccec}', GC_LV), ('\u{cced}', '\u{cd07}', GC_LVT), ('\u{cd08}', '\u{cd08}', GC_LV),
+ ('\u{cd09}', '\u{cd23}', GC_LVT), ('\u{cd24}', '\u{cd24}', GC_LV), ('\u{cd25}', '\u{cd3f}',
+ GC_LVT), ('\u{cd40}', '\u{cd40}', GC_LV), ('\u{cd41}', '\u{cd5b}', GC_LVT), ('\u{cd5c}',
+ '\u{cd5c}', GC_LV), ('\u{cd5d}', '\u{cd77}', GC_LVT), ('\u{cd78}', '\u{cd78}', GC_LV),
+ ('\u{cd79}', '\u{cd93}', GC_LVT), ('\u{cd94}', '\u{cd94}', GC_LV), ('\u{cd95}', '\u{cdaf}',
+ GC_LVT), ('\u{cdb0}', '\u{cdb0}', GC_LV), ('\u{cdb1}', '\u{cdcb}', GC_LVT), ('\u{cdcc}',
+ '\u{cdcc}', GC_LV), ('\u{cdcd}', '\u{cde7}', GC_LVT), ('\u{cde8}', '\u{cde8}', GC_LV),
+ ('\u{cde9}', '\u{ce03}', GC_LVT), ('\u{ce04}', '\u{ce04}', GC_LV), ('\u{ce05}', '\u{ce1f}',
+ GC_LVT), ('\u{ce20}', '\u{ce20}', GC_LV), ('\u{ce21}', '\u{ce3b}', GC_LVT), ('\u{ce3c}',
+ '\u{ce3c}', GC_LV), ('\u{ce3d}', '\u{ce57}', GC_LVT), ('\u{ce58}', '\u{ce58}', GC_LV),
+ ('\u{ce59}', '\u{ce73}', GC_LVT), ('\u{ce74}', '\u{ce74}', GC_LV), ('\u{ce75}', '\u{ce8f}',
+ GC_LVT), ('\u{ce90}', '\u{ce90}', GC_LV), ('\u{ce91}', '\u{ceab}', GC_LVT), ('\u{ceac}',
+ '\u{ceac}', GC_LV), ('\u{cead}', '\u{cec7}', GC_LVT), ('\u{cec8}', '\u{cec8}', GC_LV),
+ ('\u{cec9}', '\u{cee3}', GC_LVT), ('\u{cee4}', '\u{cee4}', GC_LV), ('\u{cee5}', '\u{ceff}',
+ GC_LVT), ('\u{cf00}', '\u{cf00}', GC_LV), ('\u{cf01}', '\u{cf1b}', GC_LVT), ('\u{cf1c}',
+ '\u{cf1c}', GC_LV), ('\u{cf1d}', '\u{cf37}', GC_LVT), ('\u{cf38}', '\u{cf38}', GC_LV),
+ ('\u{cf39}', '\u{cf53}', GC_LVT), ('\u{cf54}', '\u{cf54}', GC_LV), ('\u{cf55}', '\u{cf6f}',
+ GC_LVT), ('\u{cf70}', '\u{cf70}', GC_LV), ('\u{cf71}', '\u{cf8b}', GC_LVT), ('\u{cf8c}',
+ '\u{cf8c}', GC_LV), ('\u{cf8d}', '\u{cfa7}', GC_LVT), ('\u{cfa8}', '\u{cfa8}', GC_LV),
+ ('\u{cfa9}', '\u{cfc3}', GC_LVT), ('\u{cfc4}', '\u{cfc4}', GC_LV), ('\u{cfc5}', '\u{cfdf}',
+ GC_LVT), ('\u{cfe0}', '\u{cfe0}', GC_LV), ('\u{cfe1}', '\u{cffb}', GC_LVT), ('\u{cffc}',
+ '\u{cffc}', GC_LV), ('\u{cffd}', '\u{d017}', GC_LVT), ('\u{d018}', '\u{d018}', GC_LV),
+ ('\u{d019}', '\u{d033}', GC_LVT), ('\u{d034}', '\u{d034}', GC_LV), ('\u{d035}', '\u{d04f}',
+ GC_LVT), ('\u{d050}', '\u{d050}', GC_LV), ('\u{d051}', '\u{d06b}', GC_LVT), ('\u{d06c}',
+ '\u{d06c}', GC_LV), ('\u{d06d}', '\u{d087}', GC_LVT), ('\u{d088}', '\u{d088}', GC_LV),
+ ('\u{d089}', '\u{d0a3}', GC_LVT), ('\u{d0a4}', '\u{d0a4}', GC_LV), ('\u{d0a5}', '\u{d0bf}',
+ GC_LVT), ('\u{d0c0}', '\u{d0c0}', GC_LV), ('\u{d0c1}', '\u{d0db}', GC_LVT), ('\u{d0dc}',
+ '\u{d0dc}', GC_LV), ('\u{d0dd}', '\u{d0f7}', GC_LVT), ('\u{d0f8}', '\u{d0f8}', GC_LV),
+ ('\u{d0f9}', '\u{d113}', GC_LVT), ('\u{d114}', '\u{d114}', GC_LV), ('\u{d115}', '\u{d12f}',
+ GC_LVT), ('\u{d130}', '\u{d130}', GC_LV), ('\u{d131}', '\u{d14b}', GC_LVT), ('\u{d14c}',
+ '\u{d14c}', GC_LV), ('\u{d14d}', '\u{d167}', GC_LVT), ('\u{d168}', '\u{d168}', GC_LV),
+ ('\u{d169}', '\u{d183}', GC_LVT), ('\u{d184}', '\u{d184}', GC_LV), ('\u{d185}', '\u{d19f}',
+ GC_LVT), ('\u{d1a0}', '\u{d1a0}', GC_LV), ('\u{d1a1}', '\u{d1bb}', GC_LVT), ('\u{d1bc}',
+ '\u{d1bc}', GC_LV), ('\u{d1bd}', '\u{d1d7}', GC_LVT), ('\u{d1d8}', '\u{d1d8}', GC_LV),
+ ('\u{d1d9}', '\u{d1f3}', GC_LVT), ('\u{d1f4}', '\u{d1f4}', GC_LV), ('\u{d1f5}', '\u{d20f}',
+ GC_LVT), ('\u{d210}', '\u{d210}', GC_LV), ('\u{d211}', '\u{d22b}', GC_LVT), ('\u{d22c}',
+ '\u{d22c}', GC_LV), ('\u{d22d}', '\u{d247}', GC_LVT), ('\u{d248}', '\u{d248}', GC_LV),
+ ('\u{d249}', '\u{d263}', GC_LVT), ('\u{d264}', '\u{d264}', GC_LV), ('\u{d265}', '\u{d27f}',
+ GC_LVT), ('\u{d280}', '\u{d280}', GC_LV), ('\u{d281}', '\u{d29b}', GC_LVT), ('\u{d29c}',
+ '\u{d29c}', GC_LV), ('\u{d29d}', '\u{d2b7}', GC_LVT), ('\u{d2b8}', '\u{d2b8}', GC_LV),
+ ('\u{d2b9}', '\u{d2d3}', GC_LVT), ('\u{d2d4}', '\u{d2d4}', GC_LV), ('\u{d2d5}', '\u{d2ef}',
+ GC_LVT), ('\u{d2f0}', '\u{d2f0}', GC_LV), ('\u{d2f1}', '\u{d30b}', GC_LVT), ('\u{d30c}',
+ '\u{d30c}', GC_LV), ('\u{d30d}', '\u{d327}', GC_LVT), ('\u{d328}', '\u{d328}', GC_LV),
+ ('\u{d329}', '\u{d343}', GC_LVT), ('\u{d344}', '\u{d344}', GC_LV), ('\u{d345}', '\u{d35f}',
+ GC_LVT), ('\u{d360}', '\u{d360}', GC_LV), ('\u{d361}', '\u{d37b}', GC_LVT), ('\u{d37c}',
+ '\u{d37c}', GC_LV), ('\u{d37d}', '\u{d397}', GC_LVT), ('\u{d398}', '\u{d398}', GC_LV),
+ ('\u{d399}', '\u{d3b3}', GC_LVT), ('\u{d3b4}', '\u{d3b4}', GC_LV), ('\u{d3b5}', '\u{d3cf}',
+ GC_LVT), ('\u{d3d0}', '\u{d3d0}', GC_LV), ('\u{d3d1}', '\u{d3eb}', GC_LVT), ('\u{d3ec}',
+ '\u{d3ec}', GC_LV), ('\u{d3ed}', '\u{d407}', GC_LVT), ('\u{d408}', '\u{d408}', GC_LV),
+ ('\u{d409}', '\u{d423}', GC_LVT), ('\u{d424}', '\u{d424}', GC_LV), ('\u{d425}', '\u{d43f}',
+ GC_LVT), ('\u{d440}', '\u{d440}', GC_LV), ('\u{d441}', '\u{d45b}', GC_LVT), ('\u{d45c}',
+ '\u{d45c}', GC_LV), ('\u{d45d}', '\u{d477}', GC_LVT), ('\u{d478}', '\u{d478}', GC_LV),
+ ('\u{d479}', '\u{d493}', GC_LVT), ('\u{d494}', '\u{d494}', GC_LV), ('\u{d495}', '\u{d4af}',
+ GC_LVT), ('\u{d4b0}', '\u{d4b0}', GC_LV), ('\u{d4b1}', '\u{d4cb}', GC_LVT), ('\u{d4cc}',
+ '\u{d4cc}', GC_LV), ('\u{d4cd}', '\u{d4e7}', GC_LVT), ('\u{d4e8}', '\u{d4e8}', GC_LV),
+ ('\u{d4e9}', '\u{d503}', GC_LVT), ('\u{d504}', '\u{d504}', GC_LV), ('\u{d505}', '\u{d51f}',
+ GC_LVT), ('\u{d520}', '\u{d520}', GC_LV), ('\u{d521}', '\u{d53b}', GC_LVT), ('\u{d53c}',
+ '\u{d53c}', GC_LV), ('\u{d53d}', '\u{d557}', GC_LVT), ('\u{d558}', '\u{d558}', GC_LV),
+ ('\u{d559}', '\u{d573}', GC_LVT), ('\u{d574}', '\u{d574}', GC_LV), ('\u{d575}', '\u{d58f}',
+ GC_LVT), ('\u{d590}', '\u{d590}', GC_LV), ('\u{d591}', '\u{d5ab}', GC_LVT), ('\u{d5ac}',
+ '\u{d5ac}', GC_LV), ('\u{d5ad}', '\u{d5c7}', GC_LVT), ('\u{d5c8}', '\u{d5c8}', GC_LV),
+ ('\u{d5c9}', '\u{d5e3}', GC_LVT), ('\u{d5e4}', '\u{d5e4}', GC_LV), ('\u{d5e5}', '\u{d5ff}',
+ GC_LVT), ('\u{d600}', '\u{d600}', GC_LV), ('\u{d601}', '\u{d61b}', GC_LVT), ('\u{d61c}',
+ '\u{d61c}', GC_LV), ('\u{d61d}', '\u{d637}', GC_LVT), ('\u{d638}', '\u{d638}', GC_LV),
+ ('\u{d639}', '\u{d653}', GC_LVT), ('\u{d654}', '\u{d654}', GC_LV), ('\u{d655}', '\u{d66f}',
+ GC_LVT), ('\u{d670}', '\u{d670}', GC_LV), ('\u{d671}', '\u{d68b}', GC_LVT), ('\u{d68c}',
+ '\u{d68c}', GC_LV), ('\u{d68d}', '\u{d6a7}', GC_LVT), ('\u{d6a8}', '\u{d6a8}', GC_LV),
+ ('\u{d6a9}', '\u{d6c3}', GC_LVT), ('\u{d6c4}', '\u{d6c4}', GC_LV), ('\u{d6c5}', '\u{d6df}',
+ GC_LVT), ('\u{d6e0}', '\u{d6e0}', GC_LV), ('\u{d6e1}', '\u{d6fb}', GC_LVT), ('\u{d6fc}',
+ '\u{d6fc}', GC_LV), ('\u{d6fd}', '\u{d717}', GC_LVT), ('\u{d718}', '\u{d718}', GC_LV),
+ ('\u{d719}', '\u{d733}', GC_LVT), ('\u{d734}', '\u{d734}', GC_LV), ('\u{d735}', '\u{d74f}',
+ GC_LVT), ('\u{d750}', '\u{d750}', GC_LV), ('\u{d751}', '\u{d76b}', GC_LVT), ('\u{d76c}',
+ '\u{d76c}', GC_LV), ('\u{d76d}', '\u{d787}', GC_LVT), ('\u{d788}', '\u{d788}', GC_LV),
+ ('\u{d789}', '\u{d7a3}', GC_LVT), ('\u{d7b0}', '\u{d7c6}', GC_V), ('\u{d7cb}', '\u{d7fb}',
+ GC_T), ('\u{fb1e}', '\u{fb1e}', GC_Extend), ('\u{fe00}', '\u{fe0f}', GC_Extend),
+ ('\u{fe20}', '\u{fe2f}', GC_Extend), ('\u{feff}', '\u{feff}', GC_Control), ('\u{ff9e}',
+ '\u{ff9f}', GC_Extend), ('\u{fff0}', '\u{fffb}', GC_Control), ('\u{101fd}', '\u{101fd}',
+ GC_Extend), ('\u{102e0}', '\u{102e0}', GC_Extend), ('\u{10376}', '\u{1037a}', GC_Extend),
+ ('\u{10a01}', '\u{10a03}', GC_Extend), ('\u{10a05}', '\u{10a06}', GC_Extend), ('\u{10a0c}',
+ '\u{10a0f}', GC_Extend), ('\u{10a38}', '\u{10a3a}', GC_Extend), ('\u{10a3f}', '\u{10a3f}',
+ GC_Extend), ('\u{10ae5}', '\u{10ae6}', GC_Extend), ('\u{10d24}', '\u{10d27}', GC_Extend),
+ ('\u{10eab}', '\u{10eac}', GC_Extend), ('\u{10efd}', '\u{10eff}', GC_Extend), ('\u{10f46}',
+ '\u{10f50}', GC_Extend), ('\u{10f82}', '\u{10f85}', GC_Extend), ('\u{11000}', '\u{11000}',
+ GC_SpacingMark), ('\u{11001}', '\u{11001}', GC_Extend), ('\u{11002}', '\u{11002}',
+ GC_SpacingMark), ('\u{11038}', '\u{11046}', GC_Extend), ('\u{11070}', '\u{11070}',
+ GC_Extend), ('\u{11073}', '\u{11074}', GC_Extend), ('\u{1107f}', '\u{11081}', GC_Extend),
+ ('\u{11082}', '\u{11082}', GC_SpacingMark), ('\u{110b0}', '\u{110b2}', GC_SpacingMark),
+ ('\u{110b3}', '\u{110b6}', GC_Extend), ('\u{110b7}', '\u{110b8}', GC_SpacingMark),
+ ('\u{110b9}', '\u{110ba}', GC_Extend), ('\u{110bd}', '\u{110bd}', GC_Prepend), ('\u{110c2}',
+ '\u{110c2}', GC_Extend), ('\u{110cd}', '\u{110cd}', GC_Prepend), ('\u{11100}', '\u{11102}',
+ GC_Extend), ('\u{11127}', '\u{1112b}', GC_Extend), ('\u{1112c}', '\u{1112c}',
+ GC_SpacingMark), ('\u{1112d}', '\u{11134}', GC_Extend), ('\u{11145}', '\u{11146}',
+ GC_SpacingMark), ('\u{11173}', '\u{11173}', GC_Extend), ('\u{11180}', '\u{11181}',
+ GC_Extend), ('\u{11182}', '\u{11182}', GC_SpacingMark), ('\u{111b3}', '\u{111b5}',
+ GC_SpacingMark), ('\u{111b6}', '\u{111be}', GC_Extend), ('\u{111bf}', '\u{111c0}',
+ GC_SpacingMark), ('\u{111c2}', '\u{111c3}', GC_Prepend), ('\u{111c9}', '\u{111cc}',
+ GC_Extend), ('\u{111ce}', '\u{111ce}', GC_SpacingMark), ('\u{111cf}', '\u{111cf}',
+ GC_Extend), ('\u{1122c}', '\u{1122e}', GC_SpacingMark), ('\u{1122f}', '\u{11231}',
+ GC_Extend), ('\u{11232}', '\u{11233}', GC_SpacingMark), ('\u{11234}', '\u{11234}',
+ GC_Extend), ('\u{11235}', '\u{11235}', GC_SpacingMark), ('\u{11236}', '\u{11237}',
+ GC_Extend), ('\u{1123e}', '\u{1123e}', GC_Extend), ('\u{11241}', '\u{11241}', GC_Extend),
+ ('\u{112df}', '\u{112df}', GC_Extend), ('\u{112e0}', '\u{112e2}', GC_SpacingMark),
+ ('\u{112e3}', '\u{112ea}', GC_Extend), ('\u{11300}', '\u{11301}', GC_Extend), ('\u{11302}',
+ '\u{11303}', GC_SpacingMark), ('\u{1133b}', '\u{1133c}', GC_Extend), ('\u{1133e}',
+ '\u{1133e}', GC_Extend), ('\u{1133f}', '\u{1133f}', GC_SpacingMark), ('\u{11340}',
+ '\u{11340}', GC_Extend), ('\u{11341}', '\u{11344}', GC_SpacingMark), ('\u{11347}',
+ '\u{11348}', GC_SpacingMark), ('\u{1134b}', '\u{1134d}', GC_SpacingMark), ('\u{11357}',
+ '\u{11357}', GC_Extend), ('\u{11362}', '\u{11363}', GC_SpacingMark), ('\u{11366}',
+ '\u{1136c}', GC_Extend), ('\u{11370}', '\u{11374}', GC_Extend), ('\u{11435}', '\u{11437}',
+ GC_SpacingMark), ('\u{11438}', '\u{1143f}', GC_Extend), ('\u{11440}', '\u{11441}',
+ GC_SpacingMark), ('\u{11442}', '\u{11444}', GC_Extend), ('\u{11445}', '\u{11445}',
+ GC_SpacingMark), ('\u{11446}', '\u{11446}', GC_Extend), ('\u{1145e}', '\u{1145e}',
+ GC_Extend), ('\u{114b0}', '\u{114b0}', GC_Extend), ('\u{114b1}', '\u{114b2}',
+ GC_SpacingMark), ('\u{114b3}', '\u{114b8}', GC_Extend), ('\u{114b9}', '\u{114b9}',
+ GC_SpacingMark), ('\u{114ba}', '\u{114ba}', GC_Extend), ('\u{114bb}', '\u{114bc}',
+ GC_SpacingMark), ('\u{114bd}', '\u{114bd}', GC_Extend), ('\u{114be}', '\u{114be}',
+ GC_SpacingMark), ('\u{114bf}', '\u{114c0}', GC_Extend), ('\u{114c1}', '\u{114c1}',
+ GC_SpacingMark), ('\u{114c2}', '\u{114c3}', GC_Extend), ('\u{115af}', '\u{115af}',
+ GC_Extend), ('\u{115b0}', '\u{115b1}', GC_SpacingMark), ('\u{115b2}', '\u{115b5}',
+ GC_Extend), ('\u{115b8}', '\u{115bb}', GC_SpacingMark), ('\u{115bc}', '\u{115bd}',
+ GC_Extend), ('\u{115be}', '\u{115be}', GC_SpacingMark), ('\u{115bf}', '\u{115c0}',
+ GC_Extend), ('\u{115dc}', '\u{115dd}', GC_Extend), ('\u{11630}', '\u{11632}',
+ GC_SpacingMark), ('\u{11633}', '\u{1163a}', GC_Extend), ('\u{1163b}', '\u{1163c}',
+ GC_SpacingMark), ('\u{1163d}', '\u{1163d}', GC_Extend), ('\u{1163e}', '\u{1163e}',
+ GC_SpacingMark), ('\u{1163f}', '\u{11640}', GC_Extend), ('\u{116ab}', '\u{116ab}',
+ GC_Extend), ('\u{116ac}', '\u{116ac}', GC_SpacingMark), ('\u{116ad}', '\u{116ad}',
+ GC_Extend), ('\u{116ae}', '\u{116af}', GC_SpacingMark), ('\u{116b0}', '\u{116b5}',
+ GC_Extend), ('\u{116b6}', '\u{116b6}', GC_SpacingMark), ('\u{116b7}', '\u{116b7}',
+ GC_Extend), ('\u{1171d}', '\u{1171f}', GC_Extend), ('\u{11722}', '\u{11725}', GC_Extend),
+ ('\u{11726}', '\u{11726}', GC_SpacingMark), ('\u{11727}', '\u{1172b}', GC_Extend),
+ ('\u{1182c}', '\u{1182e}', GC_SpacingMark), ('\u{1182f}', '\u{11837}', GC_Extend),
+ ('\u{11838}', '\u{11838}', GC_SpacingMark), ('\u{11839}', '\u{1183a}', GC_Extend),
+ ('\u{11930}', '\u{11930}', GC_Extend), ('\u{11931}', '\u{11935}', GC_SpacingMark),
+ ('\u{11937}', '\u{11938}', GC_SpacingMark), ('\u{1193b}', '\u{1193c}', GC_Extend),
+ ('\u{1193d}', '\u{1193d}', GC_SpacingMark), ('\u{1193e}', '\u{1193e}', GC_Extend),
+ ('\u{1193f}', '\u{1193f}', GC_Prepend), ('\u{11940}', '\u{11940}', GC_SpacingMark),
+ ('\u{11941}', '\u{11941}', GC_Prepend), ('\u{11942}', '\u{11942}', GC_SpacingMark),
+ ('\u{11943}', '\u{11943}', GC_Extend), ('\u{119d1}', '\u{119d3}', GC_SpacingMark),
+ ('\u{119d4}', '\u{119d7}', GC_Extend), ('\u{119da}', '\u{119db}', GC_Extend), ('\u{119dc}',
+ '\u{119df}', GC_SpacingMark), ('\u{119e0}', '\u{119e0}', GC_Extend), ('\u{119e4}',
+ '\u{119e4}', GC_SpacingMark), ('\u{11a01}', '\u{11a0a}', GC_Extend), ('\u{11a33}',
+ '\u{11a38}', GC_Extend), ('\u{11a39}', '\u{11a39}', GC_SpacingMark), ('\u{11a3a}',
+ '\u{11a3a}', GC_Prepend), ('\u{11a3b}', '\u{11a3e}', GC_Extend), ('\u{11a47}', '\u{11a47}',
+ GC_Extend), ('\u{11a51}', '\u{11a56}', GC_Extend), ('\u{11a57}', '\u{11a58}',
+ GC_SpacingMark), ('\u{11a59}', '\u{11a5b}', GC_Extend), ('\u{11a84}', '\u{11a89}',
+ GC_Prepend), ('\u{11a8a}', '\u{11a96}', GC_Extend), ('\u{11a97}', '\u{11a97}',
+ GC_SpacingMark), ('\u{11a98}', '\u{11a99}', GC_Extend), ('\u{11c2f}', '\u{11c2f}',
+ GC_SpacingMark), ('\u{11c30}', '\u{11c36}', GC_Extend), ('\u{11c38}', '\u{11c3d}',
+ GC_Extend), ('\u{11c3e}', '\u{11c3e}', GC_SpacingMark), ('\u{11c3f}', '\u{11c3f}',
+ GC_Extend), ('\u{11c92}', '\u{11ca7}', GC_Extend), ('\u{11ca9}', '\u{11ca9}',
+ GC_SpacingMark), ('\u{11caa}', '\u{11cb0}', GC_Extend), ('\u{11cb1}', '\u{11cb1}',
+ GC_SpacingMark), ('\u{11cb2}', '\u{11cb3}', GC_Extend), ('\u{11cb4}', '\u{11cb4}',
+ GC_SpacingMark), ('\u{11cb5}', '\u{11cb6}', GC_Extend), ('\u{11d31}', '\u{11d36}',
+ GC_Extend), ('\u{11d3a}', '\u{11d3a}', GC_Extend), ('\u{11d3c}', '\u{11d3d}', GC_Extend),
+ ('\u{11d3f}', '\u{11d45}', GC_Extend), ('\u{11d46}', '\u{11d46}', GC_Prepend), ('\u{11d47}',
+ '\u{11d47}', GC_Extend), ('\u{11d8a}', '\u{11d8e}', GC_SpacingMark), ('\u{11d90}',
+ '\u{11d91}', GC_Extend), ('\u{11d93}', '\u{11d94}', GC_SpacingMark), ('\u{11d95}',
+ '\u{11d95}', GC_Extend), ('\u{11d96}', '\u{11d96}', GC_SpacingMark), ('\u{11d97}',
+ '\u{11d97}', GC_Extend), ('\u{11ef3}', '\u{11ef4}', GC_Extend), ('\u{11ef5}', '\u{11ef6}',
+ GC_SpacingMark), ('\u{11f00}', '\u{11f01}', GC_Extend), ('\u{11f02}', '\u{11f02}',
+ GC_Prepend), ('\u{11f03}', '\u{11f03}', GC_SpacingMark), ('\u{11f34}', '\u{11f35}',
+ GC_SpacingMark), ('\u{11f36}', '\u{11f3a}', GC_Extend), ('\u{11f3e}', '\u{11f3f}',
+ GC_SpacingMark), ('\u{11f40}', '\u{11f40}', GC_Extend), ('\u{11f41}', '\u{11f41}',
+ GC_SpacingMark), ('\u{11f42}', '\u{11f42}', GC_Extend), ('\u{13430}', '\u{1343f}',
+ GC_Control), ('\u{13440}', '\u{13440}', GC_Extend), ('\u{13447}', '\u{13455}', GC_Extend),
+ ('\u{16af0}', '\u{16af4}', GC_Extend), ('\u{16b30}', '\u{16b36}', GC_Extend), ('\u{16f4f}',
+ '\u{16f4f}', GC_Extend), ('\u{16f51}', '\u{16f87}', GC_SpacingMark), ('\u{16f8f}',
+ '\u{16f92}', GC_Extend), ('\u{16fe4}', '\u{16fe4}', GC_Extend), ('\u{16ff0}', '\u{16ff1}',
+ GC_SpacingMark), ('\u{1bc9d}', '\u{1bc9e}', GC_Extend), ('\u{1bca0}', '\u{1bca3}',
+ GC_Control), ('\u{1cf00}', '\u{1cf2d}', GC_Extend), ('\u{1cf30}', '\u{1cf46}', GC_Extend),
+ ('\u{1d165}', '\u{1d165}', GC_Extend), ('\u{1d166}', '\u{1d166}', GC_SpacingMark),
+ ('\u{1d167}', '\u{1d169}', GC_Extend), ('\u{1d16d}', '\u{1d16d}', GC_SpacingMark),
+ ('\u{1d16e}', '\u{1d172}', GC_Extend), ('\u{1d173}', '\u{1d17a}', GC_Control), ('\u{1d17b}',
+ '\u{1d182}', GC_Extend), ('\u{1d185}', '\u{1d18b}', GC_Extend), ('\u{1d1aa}', '\u{1d1ad}',
+ GC_Extend), ('\u{1d242}', '\u{1d244}', GC_Extend), ('\u{1da00}', '\u{1da36}', GC_Extend),
+ ('\u{1da3b}', '\u{1da6c}', GC_Extend), ('\u{1da75}', '\u{1da75}', GC_Extend), ('\u{1da84}',
+ '\u{1da84}', GC_Extend), ('\u{1da9b}', '\u{1da9f}', GC_Extend), ('\u{1daa1}', '\u{1daaf}',
+ GC_Extend), ('\u{1e000}', '\u{1e006}', GC_Extend), ('\u{1e008}', '\u{1e018}', GC_Extend),
+ ('\u{1e01b}', '\u{1e021}', GC_Extend), ('\u{1e023}', '\u{1e024}', GC_Extend), ('\u{1e026}',
+ '\u{1e02a}', GC_Extend), ('\u{1e08f}', '\u{1e08f}', GC_Extend), ('\u{1e130}', '\u{1e136}',
+ GC_Extend), ('\u{1e2ae}', '\u{1e2ae}', GC_Extend), ('\u{1e2ec}', '\u{1e2ef}', GC_Extend),
+ ('\u{1e4ec}', '\u{1e4ef}', GC_Extend), ('\u{1e8d0}', '\u{1e8d6}', GC_Extend), ('\u{1e944}',
+ '\u{1e94a}', GC_Extend), ('\u{1f000}', '\u{1f0ff}', GC_Extended_Pictographic), ('\u{1f10d}',
+ '\u{1f10f}', GC_Extended_Pictographic), ('\u{1f12f}', '\u{1f12f}',
+ GC_Extended_Pictographic), ('\u{1f16c}', '\u{1f171}', GC_Extended_Pictographic),
+ ('\u{1f17e}', '\u{1f17f}', GC_Extended_Pictographic), ('\u{1f18e}', '\u{1f18e}',
+ GC_Extended_Pictographic), ('\u{1f191}', '\u{1f19a}', GC_Extended_Pictographic),
+ ('\u{1f1ad}', '\u{1f1e5}', GC_Extended_Pictographic), ('\u{1f1e6}', '\u{1f1ff}',
+ GC_Regional_Indicator), ('\u{1f201}', '\u{1f20f}', GC_Extended_Pictographic), ('\u{1f21a}',
+ '\u{1f21a}', GC_Extended_Pictographic), ('\u{1f22f}', '\u{1f22f}',
+ GC_Extended_Pictographic), ('\u{1f232}', '\u{1f23a}', GC_Extended_Pictographic),
+ ('\u{1f23c}', '\u{1f23f}', GC_Extended_Pictographic), ('\u{1f249}', '\u{1f3fa}',
+ GC_Extended_Pictographic), ('\u{1f3fb}', '\u{1f3ff}', GC_Extend), ('\u{1f400}', '\u{1f53d}',
+ GC_Extended_Pictographic), ('\u{1f546}', '\u{1f64f}', GC_Extended_Pictographic),
+ ('\u{1f680}', '\u{1f6ff}', GC_Extended_Pictographic), ('\u{1f774}', '\u{1f77f}',
+ GC_Extended_Pictographic), ('\u{1f7d5}', '\u{1f7ff}', GC_Extended_Pictographic),
+ ('\u{1f80c}', '\u{1f80f}', GC_Extended_Pictographic), ('\u{1f848}', '\u{1f84f}',
+ GC_Extended_Pictographic), ('\u{1f85a}', '\u{1f85f}', GC_Extended_Pictographic),
+ ('\u{1f888}', '\u{1f88f}', GC_Extended_Pictographic), ('\u{1f8ae}', '\u{1f8ff}',
+ GC_Extended_Pictographic), ('\u{1f90c}', '\u{1f93a}', GC_Extended_Pictographic),
+ ('\u{1f93c}', '\u{1f945}', GC_Extended_Pictographic), ('\u{1f947}', '\u{1faff}',
+ GC_Extended_Pictographic), ('\u{1fc00}', '\u{1fffd}', GC_Extended_Pictographic),
+ ('\u{e0000}', '\u{e001f}', GC_Control), ('\u{e0020}', '\u{e007f}', GC_Extend), ('\u{e0080}',
+ '\u{e00ff}', GC_Control), ('\u{e0100}', '\u{e01ef}', GC_Extend), ('\u{e01f0}', '\u{e0fff}',
+ GC_Control)
+ ];
+
+}
+
+pub mod word {
+ use core::result::Result::{Ok, Err};
+
+ pub use self::WordCat::*;
+
+ #[allow(non_camel_case_types)]
+ #[derive(Clone, Copy, PartialEq, Eq, Debug)]
+ pub enum WordCat {
+ WC_ALetter,
+ WC_Any,
+ WC_CR,
+ WC_Double_Quote,
+ WC_Extend,
+ WC_ExtendNumLet,
+ WC_Format,
+ WC_Hebrew_Letter,
+ WC_Katakana,
+ WC_LF,
+ WC_MidLetter,
+ WC_MidNum,
+ WC_MidNumLet,
+ WC_Newline,
+ WC_Numeric,
+ WC_Regional_Indicator,
+ WC_Single_Quote,
+ WC_WSegSpace,
+ WC_ZWJ,
+ }
+
+ fn bsearch_range_value_table(c: char, r: &'static [(char, char, WordCat)], default_lower: u32, default_upper: u32) -> (u32, u32, WordCat) {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }) {
+ Ok(idx) => {
+ let (lower, upper, cat) = r[idx];
+ (lower as u32, upper as u32, cat)
+ }
+ Err(idx) => {
+ (
+ if idx > 0 { r[idx-1].1 as u32 + 1 } else { default_lower },
+ r.get(idx).map(|c|c.0 as u32 - 1).unwrap_or(default_upper),
+ WC_Any,
+ )
+ }
+ }
+ }
+
+ pub fn word_category(c: char) -> (u32, u32, WordCat) {
+ // Perform a quick O(1) lookup in a precomputed table to determine
+ // the slice of the range table to search in.
+ let lookup_interval = 0x80;
+ let idx = (c as u32 / lookup_interval) as usize;
+ let range = word_cat_lookup.get(idx..(idx + 2)).map_or(
+ // If the `idx` is outside of the precomputed table - use the slice
+ // starting from the last covered index in the precomputed table and
+ // ending with the length of the range table.
+ 1050..1053,
+ |r| (r[0] as usize)..((r[1] + 1) as usize)
+ );
+
+ // Compute pessimistic default lower and upper bounds on the category.
+ // If character doesn't map to any range and there is no adjacent range
+ // in the table slice - these bounds has to apply.
+ let lower = idx as u32 * lookup_interval;
+ let upper = lower + lookup_interval - 1;
+ bsearch_range_value_table(c, &word_cat_table[range], lower, upper)
+ }
+
+ const word_cat_lookup: &'static [u16] = &[
+ 0, 14, 22, 22, 22, 22, 24, 30, 36, 36, 38, 43, 55, 66, 78, 83, 93, 104, 111, 121, 143, 162,
+ 180, 198, 215, 231, 250, 266, 278, 282, 286, 295, 301, 308, 316, 316, 316, 321, 329, 333,
+ 336, 336, 336, 336, 336, 338, 342, 351, 354, 359, 365, 369, 370, 375, 378, 384, 391, 397,
+ 409, 409, 411, 411, 411, 420, 430, 449, 451, 464, 465, 465, 465, 465, 465, 465, 466, 466,
+ 466, 466, 466, 466, 466, 466, 466, 466, 466, 466, 466, 466, 466, 466, 470, 476, 486, 487,
+ 487, 487, 487, 492, 496, 497, 500, 500, 501, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502, 502,
+ 502, 502, 504, 504, 504, 511, 515, 515, 519, 529, 538, 544, 551, 559, 568, 574, 578, 578,
+ 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578,
+ 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578,
+ 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578,
+ 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578,
+ 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 578, 581, 581, 581, 581,
+ 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581,
+ 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581,
+ 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581,
+ 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 581, 592, 593, 593, 593, 594,
+ 597, 609, 611, 620, 628, 634, 635, 636, 637, 637, 640, 644, 648, 648, 652, 655, 662, 662,
+ 662, 665, 668, 675, 678, 680, 682, 692, 696, 699, 700, 701, 703, 706, 706, 706, 710, 714,
+ 718, 726, 734, 744, 753, 759, 767, 785, 785, 791, 796, 796, 801, 805, 809, 811, 811, 813,
+ 815, 828, 835, 844, 848, 848, 848, 854, 857, 869, 875, 875, 877, 885, 886, 886, 886, 886,
+ 886, 886, 886, 886, 887, 888, 888, 889, 889, 889, 889, 889, 889, 889, 889, 889, 889, 889,
+ 889, 889, 889, 889, 889, 889, 889, 889, 889, 889, 890, 890, 890, 890, 890, 890, 890, 890,
+ 890, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895,
+ 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895, 895,
+ 895, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896,
+ 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896,
+ 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896,
+ 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896, 896,
+ 896, 899, 903, 908, 909, 909, 909, 909, 909, 910, 910, 913, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920,
+ 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 920, 923, 924, 924, 927,
+ 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927, 927,
+ 927, 927, 927, 929, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933,
+ 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933, 933,
+ 933, 933, 933, 933, 933, 935, 935, 935, 935, 938, 941, 942, 942, 942, 942, 943, 951, 960,
+ 960, 960, 964, 968, 973, 973, 973, 973, 973, 976, 979, 979, 979, 979, 979, 979, 979, 979,
+ 979, 981, 981, 987, 988, 993, 993, 993, 998, 998, 998, 998, 1001, 1001, 1001, 1001, 1001,
+ 1001, 1005, 1005, 1007, 1011, 1011, 1011, 1011, 1011, 1011, 1011, 1011, 1011, 1011, 1039,
+ 1044, 1044, 1044, 1044, 1044, 1046, 1048, 1048, 1048, 1048, 1049, 1049, 1049, 1049, 1049,
+ 1049, 1049, 1049, 1049, 1049, 1049, 1049, 1049, 1049, 1049, 1049, 1050, 1050, 1050, 1050,
+ 1050, 1050, 1050, 1050
+ ];
+
+ const word_cat_table: &'static [(char, char, WordCat)] = &[
+ ('\u{a}', '\u{a}', WC_LF), ('\u{b}', '\u{c}', WC_Newline), ('\u{d}', '\u{d}', WC_CR),
+ ('\u{20}', '\u{20}', WC_WSegSpace), ('\u{22}', '\u{22}', WC_Double_Quote), ('\u{27}',
+ '\u{27}', WC_Single_Quote), ('\u{2c}', '\u{2c}', WC_MidNum), ('\u{2e}', '\u{2e}',
+ WC_MidNumLet), ('\u{30}', '\u{39}', WC_Numeric), ('\u{3a}', '\u{3a}', WC_MidLetter),
+ ('\u{3b}', '\u{3b}', WC_MidNum), ('\u{41}', '\u{5a}', WC_ALetter), ('\u{5f}', '\u{5f}',
+ WC_ExtendNumLet), ('\u{61}', '\u{7a}', WC_ALetter), ('\u{85}', '\u{85}', WC_Newline),
+ ('\u{aa}', '\u{aa}', WC_ALetter), ('\u{ad}', '\u{ad}', WC_Format), ('\u{b5}', '\u{b5}',
+ WC_ALetter), ('\u{b7}', '\u{b7}', WC_MidLetter), ('\u{ba}', '\u{ba}', WC_ALetter),
+ ('\u{c0}', '\u{d6}', WC_ALetter), ('\u{d8}', '\u{f6}', WC_ALetter), ('\u{f8}', '\u{2d7}',
+ WC_ALetter), ('\u{2de}', '\u{2ff}', WC_ALetter), ('\u{300}', '\u{36f}', WC_Extend),
+ ('\u{370}', '\u{374}', WC_ALetter), ('\u{376}', '\u{377}', WC_ALetter), ('\u{37a}',
+ '\u{37d}', WC_ALetter), ('\u{37e}', '\u{37e}', WC_MidNum), ('\u{37f}', '\u{37f}',
+ WC_ALetter), ('\u{386}', '\u{386}', WC_ALetter), ('\u{387}', '\u{387}', WC_MidLetter),
+ ('\u{388}', '\u{38a}', WC_ALetter), ('\u{38c}', '\u{38c}', WC_ALetter), ('\u{38e}',
+ '\u{3a1}', WC_ALetter), ('\u{3a3}', '\u{3f5}', WC_ALetter), ('\u{3f7}', '\u{481}',
+ WC_ALetter), ('\u{483}', '\u{489}', WC_Extend), ('\u{48a}', '\u{52f}', WC_ALetter),
+ ('\u{531}', '\u{556}', WC_ALetter), ('\u{559}', '\u{55c}', WC_ALetter), ('\u{55e}',
+ '\u{55e}', WC_ALetter), ('\u{55f}', '\u{55f}', WC_MidLetter), ('\u{560}', '\u{588}',
+ WC_ALetter), ('\u{589}', '\u{589}', WC_MidNum), ('\u{58a}', '\u{58a}', WC_ALetter),
+ ('\u{591}', '\u{5bd}', WC_Extend), ('\u{5bf}', '\u{5bf}', WC_Extend), ('\u{5c1}', '\u{5c2}',
+ WC_Extend), ('\u{5c4}', '\u{5c5}', WC_Extend), ('\u{5c7}', '\u{5c7}', WC_Extend),
+ ('\u{5d0}', '\u{5ea}', WC_Hebrew_Letter), ('\u{5ef}', '\u{5f2}', WC_Hebrew_Letter),
+ ('\u{5f3}', '\u{5f3}', WC_ALetter), ('\u{5f4}', '\u{5f4}', WC_MidLetter), ('\u{600}',
+ '\u{605}', WC_Format), ('\u{60c}', '\u{60d}', WC_MidNum), ('\u{610}', '\u{61a}', WC_Extend),
+ ('\u{61c}', '\u{61c}', WC_Format), ('\u{620}', '\u{64a}', WC_ALetter), ('\u{64b}',
+ '\u{65f}', WC_Extend), ('\u{660}', '\u{669}', WC_Numeric), ('\u{66b}', '\u{66b}',
+ WC_Numeric), ('\u{66c}', '\u{66c}', WC_MidNum), ('\u{66e}', '\u{66f}', WC_ALetter),
+ ('\u{670}', '\u{670}', WC_Extend), ('\u{671}', '\u{6d3}', WC_ALetter), ('\u{6d5}',
+ '\u{6d5}', WC_ALetter), ('\u{6d6}', '\u{6dc}', WC_Extend), ('\u{6dd}', '\u{6dd}',
+ WC_Format), ('\u{6df}', '\u{6e4}', WC_Extend), ('\u{6e5}', '\u{6e6}', WC_ALetter),
+ ('\u{6e7}', '\u{6e8}', WC_Extend), ('\u{6ea}', '\u{6ed}', WC_Extend), ('\u{6ee}', '\u{6ef}',
+ WC_ALetter), ('\u{6f0}', '\u{6f9}', WC_Numeric), ('\u{6fa}', '\u{6fc}', WC_ALetter),
+ ('\u{6ff}', '\u{6ff}', WC_ALetter), ('\u{70f}', '\u{70f}', WC_Format), ('\u{710}',
+ '\u{710}', WC_ALetter), ('\u{711}', '\u{711}', WC_Extend), ('\u{712}', '\u{72f}',
+ WC_ALetter), ('\u{730}', '\u{74a}', WC_Extend), ('\u{74d}', '\u{7a5}', WC_ALetter),
+ ('\u{7a6}', '\u{7b0}', WC_Extend), ('\u{7b1}', '\u{7b1}', WC_ALetter), ('\u{7c0}',
+ '\u{7c9}', WC_Numeric), ('\u{7ca}', '\u{7ea}', WC_ALetter), ('\u{7eb}', '\u{7f3}',
+ WC_Extend), ('\u{7f4}', '\u{7f5}', WC_ALetter), ('\u{7f8}', '\u{7f8}', WC_MidNum),
+ ('\u{7fa}', '\u{7fa}', WC_ALetter), ('\u{7fd}', '\u{7fd}', WC_Extend), ('\u{800}',
+ '\u{815}', WC_ALetter), ('\u{816}', '\u{819}', WC_Extend), ('\u{81a}', '\u{81a}',
+ WC_ALetter), ('\u{81b}', '\u{823}', WC_Extend), ('\u{824}', '\u{824}', WC_ALetter),
+ ('\u{825}', '\u{827}', WC_Extend), ('\u{828}', '\u{828}', WC_ALetter), ('\u{829}',
+ '\u{82d}', WC_Extend), ('\u{840}', '\u{858}', WC_ALetter), ('\u{859}', '\u{85b}',
+ WC_Extend), ('\u{860}', '\u{86a}', WC_ALetter), ('\u{870}', '\u{887}', WC_ALetter),
+ ('\u{889}', '\u{88e}', WC_ALetter), ('\u{890}', '\u{891}', WC_Format), ('\u{898}',
+ '\u{89f}', WC_Extend), ('\u{8a0}', '\u{8c9}', WC_ALetter), ('\u{8ca}', '\u{8e1}',
+ WC_Extend), ('\u{8e2}', '\u{8e2}', WC_Format), ('\u{8e3}', '\u{903}', WC_Extend),
+ ('\u{904}', '\u{939}', WC_ALetter), ('\u{93a}', '\u{93c}', WC_Extend), ('\u{93d}',
+ '\u{93d}', WC_ALetter), ('\u{93e}', '\u{94f}', WC_Extend), ('\u{950}', '\u{950}',
+ WC_ALetter), ('\u{951}', '\u{957}', WC_Extend), ('\u{958}', '\u{961}', WC_ALetter),
+ ('\u{962}', '\u{963}', WC_Extend), ('\u{966}', '\u{96f}', WC_Numeric), ('\u{971}',
+ '\u{980}', WC_ALetter), ('\u{981}', '\u{983}', WC_Extend), ('\u{985}', '\u{98c}',
+ WC_ALetter), ('\u{98f}', '\u{990}', WC_ALetter), ('\u{993}', '\u{9a8}', WC_ALetter),
+ ('\u{9aa}', '\u{9b0}', WC_ALetter), ('\u{9b2}', '\u{9b2}', WC_ALetter), ('\u{9b6}',
+ '\u{9b9}', WC_ALetter), ('\u{9bc}', '\u{9bc}', WC_Extend), ('\u{9bd}', '\u{9bd}',
+ WC_ALetter), ('\u{9be}', '\u{9c4}', WC_Extend), ('\u{9c7}', '\u{9c8}', WC_Extend),
+ ('\u{9cb}', '\u{9cd}', WC_Extend), ('\u{9ce}', '\u{9ce}', WC_ALetter), ('\u{9d7}',
+ '\u{9d7}', WC_Extend), ('\u{9dc}', '\u{9dd}', WC_ALetter), ('\u{9df}', '\u{9e1}',
+ WC_ALetter), ('\u{9e2}', '\u{9e3}', WC_Extend), ('\u{9e6}', '\u{9ef}', WC_Numeric),
+ ('\u{9f0}', '\u{9f1}', WC_ALetter), ('\u{9fc}', '\u{9fc}', WC_ALetter), ('\u{9fe}',
+ '\u{9fe}', WC_Extend), ('\u{a01}', '\u{a03}', WC_Extend), ('\u{a05}', '\u{a0a}',
+ WC_ALetter), ('\u{a0f}', '\u{a10}', WC_ALetter), ('\u{a13}', '\u{a28}', WC_ALetter),
+ ('\u{a2a}', '\u{a30}', WC_ALetter), ('\u{a32}', '\u{a33}', WC_ALetter), ('\u{a35}',
+ '\u{a36}', WC_ALetter), ('\u{a38}', '\u{a39}', WC_ALetter), ('\u{a3c}', '\u{a3c}',
+ WC_Extend), ('\u{a3e}', '\u{a42}', WC_Extend), ('\u{a47}', '\u{a48}', WC_Extend),
+ ('\u{a4b}', '\u{a4d}', WC_Extend), ('\u{a51}', '\u{a51}', WC_Extend), ('\u{a59}', '\u{a5c}',
+ WC_ALetter), ('\u{a5e}', '\u{a5e}', WC_ALetter), ('\u{a66}', '\u{a6f}', WC_Numeric),
+ ('\u{a70}', '\u{a71}', WC_Extend), ('\u{a72}', '\u{a74}', WC_ALetter), ('\u{a75}',
+ '\u{a75}', WC_Extend), ('\u{a81}', '\u{a83}', WC_Extend), ('\u{a85}', '\u{a8d}',
+ WC_ALetter), ('\u{a8f}', '\u{a91}', WC_ALetter), ('\u{a93}', '\u{aa8}', WC_ALetter),
+ ('\u{aaa}', '\u{ab0}', WC_ALetter), ('\u{ab2}', '\u{ab3}', WC_ALetter), ('\u{ab5}',
+ '\u{ab9}', WC_ALetter), ('\u{abc}', '\u{abc}', WC_Extend), ('\u{abd}', '\u{abd}',
+ WC_ALetter), ('\u{abe}', '\u{ac5}', WC_Extend), ('\u{ac7}', '\u{ac9}', WC_Extend),
+ ('\u{acb}', '\u{acd}', WC_Extend), ('\u{ad0}', '\u{ad0}', WC_ALetter), ('\u{ae0}',
+ '\u{ae1}', WC_ALetter), ('\u{ae2}', '\u{ae3}', WC_Extend), ('\u{ae6}', '\u{aef}',
+ WC_Numeric), ('\u{af9}', '\u{af9}', WC_ALetter), ('\u{afa}', '\u{aff}', WC_Extend),
+ ('\u{b01}', '\u{b03}', WC_Extend), ('\u{b05}', '\u{b0c}', WC_ALetter), ('\u{b0f}',
+ '\u{b10}', WC_ALetter), ('\u{b13}', '\u{b28}', WC_ALetter), ('\u{b2a}', '\u{b30}',
+ WC_ALetter), ('\u{b32}', '\u{b33}', WC_ALetter), ('\u{b35}', '\u{b39}', WC_ALetter),
+ ('\u{b3c}', '\u{b3c}', WC_Extend), ('\u{b3d}', '\u{b3d}', WC_ALetter), ('\u{b3e}',
+ '\u{b44}', WC_Extend), ('\u{b47}', '\u{b48}', WC_Extend), ('\u{b4b}', '\u{b4d}', WC_Extend),
+ ('\u{b55}', '\u{b57}', WC_Extend), ('\u{b5c}', '\u{b5d}', WC_ALetter), ('\u{b5f}',
+ '\u{b61}', WC_ALetter), ('\u{b62}', '\u{b63}', WC_Extend), ('\u{b66}', '\u{b6f}',
+ WC_Numeric), ('\u{b71}', '\u{b71}', WC_ALetter), ('\u{b82}', '\u{b82}', WC_Extend),
+ ('\u{b83}', '\u{b83}', WC_ALetter), ('\u{b85}', '\u{b8a}', WC_ALetter), ('\u{b8e}',
+ '\u{b90}', WC_ALetter), ('\u{b92}', '\u{b95}', WC_ALetter), ('\u{b99}', '\u{b9a}',
+ WC_ALetter), ('\u{b9c}', '\u{b9c}', WC_ALetter), ('\u{b9e}', '\u{b9f}', WC_ALetter),
+ ('\u{ba3}', '\u{ba4}', WC_ALetter), ('\u{ba8}', '\u{baa}', WC_ALetter), ('\u{bae}',
+ '\u{bb9}', WC_ALetter), ('\u{bbe}', '\u{bc2}', WC_Extend), ('\u{bc6}', '\u{bc8}',
+ WC_Extend), ('\u{bca}', '\u{bcd}', WC_Extend), ('\u{bd0}', '\u{bd0}', WC_ALetter),
+ ('\u{bd7}', '\u{bd7}', WC_Extend), ('\u{be6}', '\u{bef}', WC_Numeric), ('\u{c00}',
+ '\u{c04}', WC_Extend), ('\u{c05}', '\u{c0c}', WC_ALetter), ('\u{c0e}', '\u{c10}',
+ WC_ALetter), ('\u{c12}', '\u{c28}', WC_ALetter), ('\u{c2a}', '\u{c39}', WC_ALetter),
+ ('\u{c3c}', '\u{c3c}', WC_Extend), ('\u{c3d}', '\u{c3d}', WC_ALetter), ('\u{c3e}',
+ '\u{c44}', WC_Extend), ('\u{c46}', '\u{c48}', WC_Extend), ('\u{c4a}', '\u{c4d}', WC_Extend),
+ ('\u{c55}', '\u{c56}', WC_Extend), ('\u{c58}', '\u{c5a}', WC_ALetter), ('\u{c5d}',
+ '\u{c5d}', WC_ALetter), ('\u{c60}', '\u{c61}', WC_ALetter), ('\u{c62}', '\u{c63}',
+ WC_Extend), ('\u{c66}', '\u{c6f}', WC_Numeric), ('\u{c80}', '\u{c80}', WC_ALetter),
+ ('\u{c81}', '\u{c83}', WC_Extend), ('\u{c85}', '\u{c8c}', WC_ALetter), ('\u{c8e}',
+ '\u{c90}', WC_ALetter), ('\u{c92}', '\u{ca8}', WC_ALetter), ('\u{caa}', '\u{cb3}',
+ WC_ALetter), ('\u{cb5}', '\u{cb9}', WC_ALetter), ('\u{cbc}', '\u{cbc}', WC_Extend),
+ ('\u{cbd}', '\u{cbd}', WC_ALetter), ('\u{cbe}', '\u{cc4}', WC_Extend), ('\u{cc6}',
+ '\u{cc8}', WC_Extend), ('\u{cca}', '\u{ccd}', WC_Extend), ('\u{cd5}', '\u{cd6}', WC_Extend),
+ ('\u{cdd}', '\u{cde}', WC_ALetter), ('\u{ce0}', '\u{ce1}', WC_ALetter), ('\u{ce2}',
+ '\u{ce3}', WC_Extend), ('\u{ce6}', '\u{cef}', WC_Numeric), ('\u{cf1}', '\u{cf2}',
+ WC_ALetter), ('\u{cf3}', '\u{cf3}', WC_Extend), ('\u{d00}', '\u{d03}', WC_Extend),
+ ('\u{d04}', '\u{d0c}', WC_ALetter), ('\u{d0e}', '\u{d10}', WC_ALetter), ('\u{d12}',
+ '\u{d3a}', WC_ALetter), ('\u{d3b}', '\u{d3c}', WC_Extend), ('\u{d3d}', '\u{d3d}',
+ WC_ALetter), ('\u{d3e}', '\u{d44}', WC_Extend), ('\u{d46}', '\u{d48}', WC_Extend),
+ ('\u{d4a}', '\u{d4d}', WC_Extend), ('\u{d4e}', '\u{d4e}', WC_ALetter), ('\u{d54}',
+ '\u{d56}', WC_ALetter), ('\u{d57}', '\u{d57}', WC_Extend), ('\u{d5f}', '\u{d61}',
+ WC_ALetter), ('\u{d62}', '\u{d63}', WC_Extend), ('\u{d66}', '\u{d6f}', WC_Numeric),
+ ('\u{d7a}', '\u{d7f}', WC_ALetter), ('\u{d81}', '\u{d83}', WC_Extend), ('\u{d85}',
+ '\u{d96}', WC_ALetter), ('\u{d9a}', '\u{db1}', WC_ALetter), ('\u{db3}', '\u{dbb}',
+ WC_ALetter), ('\u{dbd}', '\u{dbd}', WC_ALetter), ('\u{dc0}', '\u{dc6}', WC_ALetter),
+ ('\u{dca}', '\u{dca}', WC_Extend), ('\u{dcf}', '\u{dd4}', WC_Extend), ('\u{dd6}', '\u{dd6}',
+ WC_Extend), ('\u{dd8}', '\u{ddf}', WC_Extend), ('\u{de6}', '\u{def}', WC_Numeric),
+ ('\u{df2}', '\u{df3}', WC_Extend), ('\u{e31}', '\u{e31}', WC_Extend), ('\u{e34}', '\u{e3a}',
+ WC_Extend), ('\u{e47}', '\u{e4e}', WC_Extend), ('\u{e50}', '\u{e59}', WC_Numeric),
+ ('\u{eb1}', '\u{eb1}', WC_Extend), ('\u{eb4}', '\u{ebc}', WC_Extend), ('\u{ec8}', '\u{ece}',
+ WC_Extend), ('\u{ed0}', '\u{ed9}', WC_Numeric), ('\u{f00}', '\u{f00}', WC_ALetter),
+ ('\u{f18}', '\u{f19}', WC_Extend), ('\u{f20}', '\u{f29}', WC_Numeric), ('\u{f35}',
+ '\u{f35}', WC_Extend), ('\u{f37}', '\u{f37}', WC_Extend), ('\u{f39}', '\u{f39}', WC_Extend),
+ ('\u{f3e}', '\u{f3f}', WC_Extend), ('\u{f40}', '\u{f47}', WC_ALetter), ('\u{f49}',
+ '\u{f6c}', WC_ALetter), ('\u{f71}', '\u{f84}', WC_Extend), ('\u{f86}', '\u{f87}',
+ WC_Extend), ('\u{f88}', '\u{f8c}', WC_ALetter), ('\u{f8d}', '\u{f97}', WC_Extend),
+ ('\u{f99}', '\u{fbc}', WC_Extend), ('\u{fc6}', '\u{fc6}', WC_Extend), ('\u{102b}',
+ '\u{103e}', WC_Extend), ('\u{1040}', '\u{1049}', WC_Numeric), ('\u{1056}', '\u{1059}',
+ WC_Extend), ('\u{105e}', '\u{1060}', WC_Extend), ('\u{1062}', '\u{1064}', WC_Extend),
+ ('\u{1067}', '\u{106d}', WC_Extend), ('\u{1071}', '\u{1074}', WC_Extend), ('\u{1082}',
+ '\u{108d}', WC_Extend), ('\u{108f}', '\u{108f}', WC_Extend), ('\u{1090}', '\u{1099}',
+ WC_Numeric), ('\u{109a}', '\u{109d}', WC_Extend), ('\u{10a0}', '\u{10c5}', WC_ALetter),
+ ('\u{10c7}', '\u{10c7}', WC_ALetter), ('\u{10cd}', '\u{10cd}', WC_ALetter), ('\u{10d0}',
+ '\u{10fa}', WC_ALetter), ('\u{10fc}', '\u{1248}', WC_ALetter), ('\u{124a}', '\u{124d}',
+ WC_ALetter), ('\u{1250}', '\u{1256}', WC_ALetter), ('\u{1258}', '\u{1258}', WC_ALetter),
+ ('\u{125a}', '\u{125d}', WC_ALetter), ('\u{1260}', '\u{1288}', WC_ALetter), ('\u{128a}',
+ '\u{128d}', WC_ALetter), ('\u{1290}', '\u{12b0}', WC_ALetter), ('\u{12b2}', '\u{12b5}',
+ WC_ALetter), ('\u{12b8}', '\u{12be}', WC_ALetter), ('\u{12c0}', '\u{12c0}', WC_ALetter),
+ ('\u{12c2}', '\u{12c5}', WC_ALetter), ('\u{12c8}', '\u{12d6}', WC_ALetter), ('\u{12d8}',
+ '\u{1310}', WC_ALetter), ('\u{1312}', '\u{1315}', WC_ALetter), ('\u{1318}', '\u{135a}',
+ WC_ALetter), ('\u{135d}', '\u{135f}', WC_Extend), ('\u{1380}', '\u{138f}', WC_ALetter),
+ ('\u{13a0}', '\u{13f5}', WC_ALetter), ('\u{13f8}', '\u{13fd}', WC_ALetter), ('\u{1401}',
+ '\u{166c}', WC_ALetter), ('\u{166f}', '\u{167f}', WC_ALetter), ('\u{1680}', '\u{1680}',
+ WC_WSegSpace), ('\u{1681}', '\u{169a}', WC_ALetter), ('\u{16a0}', '\u{16ea}', WC_ALetter),
+ ('\u{16ee}', '\u{16f8}', WC_ALetter), ('\u{1700}', '\u{1711}', WC_ALetter), ('\u{1712}',
+ '\u{1715}', WC_Extend), ('\u{171f}', '\u{1731}', WC_ALetter), ('\u{1732}', '\u{1734}',
+ WC_Extend), ('\u{1740}', '\u{1751}', WC_ALetter), ('\u{1752}', '\u{1753}', WC_Extend),
+ ('\u{1760}', '\u{176c}', WC_ALetter), ('\u{176e}', '\u{1770}', WC_ALetter), ('\u{1772}',
+ '\u{1773}', WC_Extend), ('\u{17b4}', '\u{17d3}', WC_Extend), ('\u{17dd}', '\u{17dd}',
+ WC_Extend), ('\u{17e0}', '\u{17e9}', WC_Numeric), ('\u{180b}', '\u{180d}', WC_Extend),
+ ('\u{180e}', '\u{180e}', WC_Format), ('\u{180f}', '\u{180f}', WC_Extend), ('\u{1810}',
+ '\u{1819}', WC_Numeric), ('\u{1820}', '\u{1878}', WC_ALetter), ('\u{1880}', '\u{1884}',
+ WC_ALetter), ('\u{1885}', '\u{1886}', WC_Extend), ('\u{1887}', '\u{18a8}', WC_ALetter),
+ ('\u{18a9}', '\u{18a9}', WC_Extend), ('\u{18aa}', '\u{18aa}', WC_ALetter), ('\u{18b0}',
+ '\u{18f5}', WC_ALetter), ('\u{1900}', '\u{191e}', WC_ALetter), ('\u{1920}', '\u{192b}',
+ WC_Extend), ('\u{1930}', '\u{193b}', WC_Extend), ('\u{1946}', '\u{194f}', WC_Numeric),
+ ('\u{19d0}', '\u{19d9}', WC_Numeric), ('\u{1a00}', '\u{1a16}', WC_ALetter), ('\u{1a17}',
+ '\u{1a1b}', WC_Extend), ('\u{1a55}', '\u{1a5e}', WC_Extend), ('\u{1a60}', '\u{1a7c}',
+ WC_Extend), ('\u{1a7f}', '\u{1a7f}', WC_Extend), ('\u{1a80}', '\u{1a89}', WC_Numeric),
+ ('\u{1a90}', '\u{1a99}', WC_Numeric), ('\u{1ab0}', '\u{1ace}', WC_Extend), ('\u{1b00}',
+ '\u{1b04}', WC_Extend), ('\u{1b05}', '\u{1b33}', WC_ALetter), ('\u{1b34}', '\u{1b44}',
+ WC_Extend), ('\u{1b45}', '\u{1b4c}', WC_ALetter), ('\u{1b50}', '\u{1b59}', WC_Numeric),
+ ('\u{1b6b}', '\u{1b73}', WC_Extend), ('\u{1b80}', '\u{1b82}', WC_Extend), ('\u{1b83}',
+ '\u{1ba0}', WC_ALetter), ('\u{1ba1}', '\u{1bad}', WC_Extend), ('\u{1bae}', '\u{1baf}',
+ WC_ALetter), ('\u{1bb0}', '\u{1bb9}', WC_Numeric), ('\u{1bba}', '\u{1be5}', WC_ALetter),
+ ('\u{1be6}', '\u{1bf3}', WC_Extend), ('\u{1c00}', '\u{1c23}', WC_ALetter), ('\u{1c24}',
+ '\u{1c37}', WC_Extend), ('\u{1c40}', '\u{1c49}', WC_Numeric), ('\u{1c4d}', '\u{1c4f}',
+ WC_ALetter), ('\u{1c50}', '\u{1c59}', WC_Numeric), ('\u{1c5a}', '\u{1c7d}', WC_ALetter),
+ ('\u{1c80}', '\u{1c88}', WC_ALetter), ('\u{1c90}', '\u{1cba}', WC_ALetter), ('\u{1cbd}',
+ '\u{1cbf}', WC_ALetter), ('\u{1cd0}', '\u{1cd2}', WC_Extend), ('\u{1cd4}', '\u{1ce8}',
+ WC_Extend), ('\u{1ce9}', '\u{1cec}', WC_ALetter), ('\u{1ced}', '\u{1ced}', WC_Extend),
+ ('\u{1cee}', '\u{1cf3}', WC_ALetter), ('\u{1cf4}', '\u{1cf4}', WC_Extend), ('\u{1cf5}',
+ '\u{1cf6}', WC_ALetter), ('\u{1cf7}', '\u{1cf9}', WC_Extend), ('\u{1cfa}', '\u{1cfa}',
+ WC_ALetter), ('\u{1d00}', '\u{1dbf}', WC_ALetter), ('\u{1dc0}', '\u{1dff}', WC_Extend),
+ ('\u{1e00}', '\u{1f15}', WC_ALetter), ('\u{1f18}', '\u{1f1d}', WC_ALetter), ('\u{1f20}',
+ '\u{1f45}', WC_ALetter), ('\u{1f48}', '\u{1f4d}', WC_ALetter), ('\u{1f50}', '\u{1f57}',
+ WC_ALetter), ('\u{1f59}', '\u{1f59}', WC_ALetter), ('\u{1f5b}', '\u{1f5b}', WC_ALetter),
+ ('\u{1f5d}', '\u{1f5d}', WC_ALetter), ('\u{1f5f}', '\u{1f7d}', WC_ALetter), ('\u{1f80}',
+ '\u{1fb4}', WC_ALetter), ('\u{1fb6}', '\u{1fbc}', WC_ALetter), ('\u{1fbe}', '\u{1fbe}',
+ WC_ALetter), ('\u{1fc2}', '\u{1fc4}', WC_ALetter), ('\u{1fc6}', '\u{1fcc}', WC_ALetter),
+ ('\u{1fd0}', '\u{1fd3}', WC_ALetter), ('\u{1fd6}', '\u{1fdb}', WC_ALetter), ('\u{1fe0}',
+ '\u{1fec}', WC_ALetter), ('\u{1ff2}', '\u{1ff4}', WC_ALetter), ('\u{1ff6}', '\u{1ffc}',
+ WC_ALetter), ('\u{2000}', '\u{2006}', WC_WSegSpace), ('\u{2008}', '\u{200a}', WC_WSegSpace),
+ ('\u{200c}', '\u{200c}', WC_Extend), ('\u{200d}', '\u{200d}', WC_ZWJ), ('\u{200e}',
+ '\u{200f}', WC_Format), ('\u{2018}', '\u{2019}', WC_MidNumLet), ('\u{2024}', '\u{2024}',
+ WC_MidNumLet), ('\u{2027}', '\u{2027}', WC_MidLetter), ('\u{2028}', '\u{2029}', WC_Newline),
+ ('\u{202a}', '\u{202e}', WC_Format), ('\u{202f}', '\u{202f}', WC_ExtendNumLet), ('\u{203f}',
+ '\u{2040}', WC_ExtendNumLet), ('\u{2044}', '\u{2044}', WC_MidNum), ('\u{2054}', '\u{2054}',
+ WC_ExtendNumLet), ('\u{205f}', '\u{205f}', WC_WSegSpace), ('\u{2060}', '\u{2064}',
+ WC_Format), ('\u{2066}', '\u{206f}', WC_Format), ('\u{2071}', '\u{2071}', WC_ALetter),
+ ('\u{207f}', '\u{207f}', WC_ALetter), ('\u{2090}', '\u{209c}', WC_ALetter), ('\u{20d0}',
+ '\u{20f0}', WC_Extend), ('\u{2102}', '\u{2102}', WC_ALetter), ('\u{2107}', '\u{2107}',
+ WC_ALetter), ('\u{210a}', '\u{2113}', WC_ALetter), ('\u{2115}', '\u{2115}', WC_ALetter),
+ ('\u{2119}', '\u{211d}', WC_ALetter), ('\u{2124}', '\u{2124}', WC_ALetter), ('\u{2126}',
+ '\u{2126}', WC_ALetter), ('\u{2128}', '\u{2128}', WC_ALetter), ('\u{212a}', '\u{212d}',
+ WC_ALetter), ('\u{212f}', '\u{2139}', WC_ALetter), ('\u{213c}', '\u{213f}', WC_ALetter),
+ ('\u{2145}', '\u{2149}', WC_ALetter), ('\u{214e}', '\u{214e}', WC_ALetter), ('\u{2160}',
+ '\u{2188}', WC_ALetter), ('\u{24b6}', '\u{24e9}', WC_ALetter), ('\u{2c00}', '\u{2ce4}',
+ WC_ALetter), ('\u{2ceb}', '\u{2cee}', WC_ALetter), ('\u{2cef}', '\u{2cf1}', WC_Extend),
+ ('\u{2cf2}', '\u{2cf3}', WC_ALetter), ('\u{2d00}', '\u{2d25}', WC_ALetter), ('\u{2d27}',
+ '\u{2d27}', WC_ALetter), ('\u{2d2d}', '\u{2d2d}', WC_ALetter), ('\u{2d30}', '\u{2d67}',
+ WC_ALetter), ('\u{2d6f}', '\u{2d6f}', WC_ALetter), ('\u{2d7f}', '\u{2d7f}', WC_Extend),
+ ('\u{2d80}', '\u{2d96}', WC_ALetter), ('\u{2da0}', '\u{2da6}', WC_ALetter), ('\u{2da8}',
+ '\u{2dae}', WC_ALetter), ('\u{2db0}', '\u{2db6}', WC_ALetter), ('\u{2db8}', '\u{2dbe}',
+ WC_ALetter), ('\u{2dc0}', '\u{2dc6}', WC_ALetter), ('\u{2dc8}', '\u{2dce}', WC_ALetter),
+ ('\u{2dd0}', '\u{2dd6}', WC_ALetter), ('\u{2dd8}', '\u{2dde}', WC_ALetter), ('\u{2de0}',
+ '\u{2dff}', WC_Extend), ('\u{2e2f}', '\u{2e2f}', WC_ALetter), ('\u{3000}', '\u{3000}',
+ WC_WSegSpace), ('\u{3005}', '\u{3005}', WC_ALetter), ('\u{302a}', '\u{302f}', WC_Extend),
+ ('\u{3031}', '\u{3035}', WC_Katakana), ('\u{303b}', '\u{303c}', WC_ALetter), ('\u{3099}',
+ '\u{309a}', WC_Extend), ('\u{309b}', '\u{309c}', WC_Katakana), ('\u{30a0}', '\u{30fa}',
+ WC_Katakana), ('\u{30fc}', '\u{30ff}', WC_Katakana), ('\u{3105}', '\u{312f}', WC_ALetter),
+ ('\u{3131}', '\u{318e}', WC_ALetter), ('\u{31a0}', '\u{31bf}', WC_ALetter), ('\u{31f0}',
+ '\u{31ff}', WC_Katakana), ('\u{32d0}', '\u{32fe}', WC_Katakana), ('\u{3300}', '\u{3357}',
+ WC_Katakana), ('\u{a000}', '\u{a48c}', WC_ALetter), ('\u{a4d0}', '\u{a4fd}', WC_ALetter),
+ ('\u{a500}', '\u{a60c}', WC_ALetter), ('\u{a610}', '\u{a61f}', WC_ALetter), ('\u{a620}',
+ '\u{a629}', WC_Numeric), ('\u{a62a}', '\u{a62b}', WC_ALetter), ('\u{a640}', '\u{a66e}',
+ WC_ALetter), ('\u{a66f}', '\u{a672}', WC_Extend), ('\u{a674}', '\u{a67d}', WC_Extend),
+ ('\u{a67f}', '\u{a69d}', WC_ALetter), ('\u{a69e}', '\u{a69f}', WC_Extend), ('\u{a6a0}',
+ '\u{a6ef}', WC_ALetter), ('\u{a6f0}', '\u{a6f1}', WC_Extend), ('\u{a708}', '\u{a7ca}',
+ WC_ALetter), ('\u{a7d0}', '\u{a7d1}', WC_ALetter), ('\u{a7d3}', '\u{a7d3}', WC_ALetter),
+ ('\u{a7d5}', '\u{a7d9}', WC_ALetter), ('\u{a7f2}', '\u{a801}', WC_ALetter), ('\u{a802}',
+ '\u{a802}', WC_Extend), ('\u{a803}', '\u{a805}', WC_ALetter), ('\u{a806}', '\u{a806}',
+ WC_Extend), ('\u{a807}', '\u{a80a}', WC_ALetter), ('\u{a80b}', '\u{a80b}', WC_Extend),
+ ('\u{a80c}', '\u{a822}', WC_ALetter), ('\u{a823}', '\u{a827}', WC_Extend), ('\u{a82c}',
+ '\u{a82c}', WC_Extend), ('\u{a840}', '\u{a873}', WC_ALetter), ('\u{a880}', '\u{a881}',
+ WC_Extend), ('\u{a882}', '\u{a8b3}', WC_ALetter), ('\u{a8b4}', '\u{a8c5}', WC_Extend),
+ ('\u{a8d0}', '\u{a8d9}', WC_Numeric), ('\u{a8e0}', '\u{a8f1}', WC_Extend), ('\u{a8f2}',
+ '\u{a8f7}', WC_ALetter), ('\u{a8fb}', '\u{a8fb}', WC_ALetter), ('\u{a8fd}', '\u{a8fe}',
+ WC_ALetter), ('\u{a8ff}', '\u{a8ff}', WC_Extend), ('\u{a900}', '\u{a909}', WC_Numeric),
+ ('\u{a90a}', '\u{a925}', WC_ALetter), ('\u{a926}', '\u{a92d}', WC_Extend), ('\u{a930}',
+ '\u{a946}', WC_ALetter), ('\u{a947}', '\u{a953}', WC_Extend), ('\u{a960}', '\u{a97c}',
+ WC_ALetter), ('\u{a980}', '\u{a983}', WC_Extend), ('\u{a984}', '\u{a9b2}', WC_ALetter),
+ ('\u{a9b3}', '\u{a9c0}', WC_Extend), ('\u{a9cf}', '\u{a9cf}', WC_ALetter), ('\u{a9d0}',
+ '\u{a9d9}', WC_Numeric), ('\u{a9e5}', '\u{a9e5}', WC_Extend), ('\u{a9f0}', '\u{a9f9}',
+ WC_Numeric), ('\u{aa00}', '\u{aa28}', WC_ALetter), ('\u{aa29}', '\u{aa36}', WC_Extend),
+ ('\u{aa40}', '\u{aa42}', WC_ALetter), ('\u{aa43}', '\u{aa43}', WC_Extend), ('\u{aa44}',
+ '\u{aa4b}', WC_ALetter), ('\u{aa4c}', '\u{aa4d}', WC_Extend), ('\u{aa50}', '\u{aa59}',
+ WC_Numeric), ('\u{aa7b}', '\u{aa7d}', WC_Extend), ('\u{aab0}', '\u{aab0}', WC_Extend),
+ ('\u{aab2}', '\u{aab4}', WC_Extend), ('\u{aab7}', '\u{aab8}', WC_Extend), ('\u{aabe}',
+ '\u{aabf}', WC_Extend), ('\u{aac1}', '\u{aac1}', WC_Extend), ('\u{aae0}', '\u{aaea}',
+ WC_ALetter), ('\u{aaeb}', '\u{aaef}', WC_Extend), ('\u{aaf2}', '\u{aaf4}', WC_ALetter),
+ ('\u{aaf5}', '\u{aaf6}', WC_Extend), ('\u{ab01}', '\u{ab06}', WC_ALetter), ('\u{ab09}',
+ '\u{ab0e}', WC_ALetter), ('\u{ab11}', '\u{ab16}', WC_ALetter), ('\u{ab20}', '\u{ab26}',
+ WC_ALetter), ('\u{ab28}', '\u{ab2e}', WC_ALetter), ('\u{ab30}', '\u{ab69}', WC_ALetter),
+ ('\u{ab70}', '\u{abe2}', WC_ALetter), ('\u{abe3}', '\u{abea}', WC_Extend), ('\u{abec}',
+ '\u{abed}', WC_Extend), ('\u{abf0}', '\u{abf9}', WC_Numeric), ('\u{ac00}', '\u{d7a3}',
+ WC_ALetter), ('\u{d7b0}', '\u{d7c6}', WC_ALetter), ('\u{d7cb}', '\u{d7fb}', WC_ALetter),
+ ('\u{fb00}', '\u{fb06}', WC_ALetter), ('\u{fb13}', '\u{fb17}', WC_ALetter), ('\u{fb1d}',
+ '\u{fb1d}', WC_Hebrew_Letter), ('\u{fb1e}', '\u{fb1e}', WC_Extend), ('\u{fb1f}', '\u{fb28}',
+ WC_Hebrew_Letter), ('\u{fb2a}', '\u{fb36}', WC_Hebrew_Letter), ('\u{fb38}', '\u{fb3c}',
+ WC_Hebrew_Letter), ('\u{fb3e}', '\u{fb3e}', WC_Hebrew_Letter), ('\u{fb40}', '\u{fb41}',
+ WC_Hebrew_Letter), ('\u{fb43}', '\u{fb44}', WC_Hebrew_Letter), ('\u{fb46}', '\u{fb4f}',
+ WC_Hebrew_Letter), ('\u{fb50}', '\u{fbb1}', WC_ALetter), ('\u{fbd3}', '\u{fd3d}',
+ WC_ALetter), ('\u{fd50}', '\u{fd8f}', WC_ALetter), ('\u{fd92}', '\u{fdc7}', WC_ALetter),
+ ('\u{fdf0}', '\u{fdfb}', WC_ALetter), ('\u{fe00}', '\u{fe0f}', WC_Extend), ('\u{fe10}',
+ '\u{fe10}', WC_MidNum), ('\u{fe13}', '\u{fe13}', WC_MidLetter), ('\u{fe14}', '\u{fe14}',
+ WC_MidNum), ('\u{fe20}', '\u{fe2f}', WC_Extend), ('\u{fe33}', '\u{fe34}', WC_ExtendNumLet),
+ ('\u{fe4d}', '\u{fe4f}', WC_ExtendNumLet), ('\u{fe50}', '\u{fe50}', WC_MidNum), ('\u{fe52}',
+ '\u{fe52}', WC_MidNumLet), ('\u{fe54}', '\u{fe54}', WC_MidNum), ('\u{fe55}', '\u{fe55}',
+ WC_MidLetter), ('\u{fe70}', '\u{fe74}', WC_ALetter), ('\u{fe76}', '\u{fefc}', WC_ALetter),
+ ('\u{feff}', '\u{feff}', WC_Format), ('\u{ff07}', '\u{ff07}', WC_MidNumLet), ('\u{ff0c}',
+ '\u{ff0c}', WC_MidNum), ('\u{ff0e}', '\u{ff0e}', WC_MidNumLet), ('\u{ff10}', '\u{ff19}',
+ WC_Numeric), ('\u{ff1a}', '\u{ff1a}', WC_MidLetter), ('\u{ff1b}', '\u{ff1b}', WC_MidNum),
+ ('\u{ff21}', '\u{ff3a}', WC_ALetter), ('\u{ff3f}', '\u{ff3f}', WC_ExtendNumLet),
+ ('\u{ff41}', '\u{ff5a}', WC_ALetter), ('\u{ff66}', '\u{ff9d}', WC_Katakana), ('\u{ff9e}',
+ '\u{ff9f}', WC_Extend), ('\u{ffa0}', '\u{ffbe}', WC_ALetter), ('\u{ffc2}', '\u{ffc7}',
+ WC_ALetter), ('\u{ffca}', '\u{ffcf}', WC_ALetter), ('\u{ffd2}', '\u{ffd7}', WC_ALetter),
+ ('\u{ffda}', '\u{ffdc}', WC_ALetter), ('\u{fff9}', '\u{fffb}', WC_Format), ('\u{10000}',
+ '\u{1000b}', WC_ALetter), ('\u{1000d}', '\u{10026}', WC_ALetter), ('\u{10028}', '\u{1003a}',
+ WC_ALetter), ('\u{1003c}', '\u{1003d}', WC_ALetter), ('\u{1003f}', '\u{1004d}', WC_ALetter),
+ ('\u{10050}', '\u{1005d}', WC_ALetter), ('\u{10080}', '\u{100fa}', WC_ALetter),
+ ('\u{10140}', '\u{10174}', WC_ALetter), ('\u{101fd}', '\u{101fd}', WC_Extend), ('\u{10280}',
+ '\u{1029c}', WC_ALetter), ('\u{102a0}', '\u{102d0}', WC_ALetter), ('\u{102e0}', '\u{102e0}',
+ WC_Extend), ('\u{10300}', '\u{1031f}', WC_ALetter), ('\u{1032d}', '\u{1034a}', WC_ALetter),
+ ('\u{10350}', '\u{10375}', WC_ALetter), ('\u{10376}', '\u{1037a}', WC_Extend), ('\u{10380}',
+ '\u{1039d}', WC_ALetter), ('\u{103a0}', '\u{103c3}', WC_ALetter), ('\u{103c8}', '\u{103cf}',
+ WC_ALetter), ('\u{103d1}', '\u{103d5}', WC_ALetter), ('\u{10400}', '\u{1049d}', WC_ALetter),
+ ('\u{104a0}', '\u{104a9}', WC_Numeric), ('\u{104b0}', '\u{104d3}', WC_ALetter),
+ ('\u{104d8}', '\u{104fb}', WC_ALetter), ('\u{10500}', '\u{10527}', WC_ALetter),
+ ('\u{10530}', '\u{10563}', WC_ALetter), ('\u{10570}', '\u{1057a}', WC_ALetter),
+ ('\u{1057c}', '\u{1058a}', WC_ALetter), ('\u{1058c}', '\u{10592}', WC_ALetter),
+ ('\u{10594}', '\u{10595}', WC_ALetter), ('\u{10597}', '\u{105a1}', WC_ALetter),
+ ('\u{105a3}', '\u{105b1}', WC_ALetter), ('\u{105b3}', '\u{105b9}', WC_ALetter),
+ ('\u{105bb}', '\u{105bc}', WC_ALetter), ('\u{10600}', '\u{10736}', WC_ALetter),
+ ('\u{10740}', '\u{10755}', WC_ALetter), ('\u{10760}', '\u{10767}', WC_ALetter),
+ ('\u{10780}', '\u{10785}', WC_ALetter), ('\u{10787}', '\u{107b0}', WC_ALetter),
+ ('\u{107b2}', '\u{107ba}', WC_ALetter), ('\u{10800}', '\u{10805}', WC_ALetter),
+ ('\u{10808}', '\u{10808}', WC_ALetter), ('\u{1080a}', '\u{10835}', WC_ALetter),
+ ('\u{10837}', '\u{10838}', WC_ALetter), ('\u{1083c}', '\u{1083c}', WC_ALetter),
+ ('\u{1083f}', '\u{10855}', WC_ALetter), ('\u{10860}', '\u{10876}', WC_ALetter),
+ ('\u{10880}', '\u{1089e}', WC_ALetter), ('\u{108e0}', '\u{108f2}', WC_ALetter),
+ ('\u{108f4}', '\u{108f5}', WC_ALetter), ('\u{10900}', '\u{10915}', WC_ALetter),
+ ('\u{10920}', '\u{10939}', WC_ALetter), ('\u{10980}', '\u{109b7}', WC_ALetter),
+ ('\u{109be}', '\u{109bf}', WC_ALetter), ('\u{10a00}', '\u{10a00}', WC_ALetter),
+ ('\u{10a01}', '\u{10a03}', WC_Extend), ('\u{10a05}', '\u{10a06}', WC_Extend), ('\u{10a0c}',
+ '\u{10a0f}', WC_Extend), ('\u{10a10}', '\u{10a13}', WC_ALetter), ('\u{10a15}', '\u{10a17}',
+ WC_ALetter), ('\u{10a19}', '\u{10a35}', WC_ALetter), ('\u{10a38}', '\u{10a3a}', WC_Extend),
+ ('\u{10a3f}', '\u{10a3f}', WC_Extend), ('\u{10a60}', '\u{10a7c}', WC_ALetter), ('\u{10a80}',
+ '\u{10a9c}', WC_ALetter), ('\u{10ac0}', '\u{10ac7}', WC_ALetter), ('\u{10ac9}', '\u{10ae4}',
+ WC_ALetter), ('\u{10ae5}', '\u{10ae6}', WC_Extend), ('\u{10b00}', '\u{10b35}', WC_ALetter),
+ ('\u{10b40}', '\u{10b55}', WC_ALetter), ('\u{10b60}', '\u{10b72}', WC_ALetter),
+ ('\u{10b80}', '\u{10b91}', WC_ALetter), ('\u{10c00}', '\u{10c48}', WC_ALetter),
+ ('\u{10c80}', '\u{10cb2}', WC_ALetter), ('\u{10cc0}', '\u{10cf2}', WC_ALetter),
+ ('\u{10d00}', '\u{10d23}', WC_ALetter), ('\u{10d24}', '\u{10d27}', WC_Extend), ('\u{10d30}',
+ '\u{10d39}', WC_Numeric), ('\u{10e80}', '\u{10ea9}', WC_ALetter), ('\u{10eab}', '\u{10eac}',
+ WC_Extend), ('\u{10eb0}', '\u{10eb1}', WC_ALetter), ('\u{10efd}', '\u{10eff}', WC_Extend),
+ ('\u{10f00}', '\u{10f1c}', WC_ALetter), ('\u{10f27}', '\u{10f27}', WC_ALetter),
+ ('\u{10f30}', '\u{10f45}', WC_ALetter), ('\u{10f46}', '\u{10f50}', WC_Extend), ('\u{10f70}',
+ '\u{10f81}', WC_ALetter), ('\u{10f82}', '\u{10f85}', WC_Extend), ('\u{10fb0}', '\u{10fc4}',
+ WC_ALetter), ('\u{10fe0}', '\u{10ff6}', WC_ALetter), ('\u{11000}', '\u{11002}', WC_Extend),
+ ('\u{11003}', '\u{11037}', WC_ALetter), ('\u{11038}', '\u{11046}', WC_Extend), ('\u{11066}',
+ '\u{1106f}', WC_Numeric), ('\u{11070}', '\u{11070}', WC_Extend), ('\u{11071}', '\u{11072}',
+ WC_ALetter), ('\u{11073}', '\u{11074}', WC_Extend), ('\u{11075}', '\u{11075}', WC_ALetter),
+ ('\u{1107f}', '\u{11082}', WC_Extend), ('\u{11083}', '\u{110af}', WC_ALetter), ('\u{110b0}',
+ '\u{110ba}', WC_Extend), ('\u{110bd}', '\u{110bd}', WC_Format), ('\u{110c2}', '\u{110c2}',
+ WC_Extend), ('\u{110cd}', '\u{110cd}', WC_Format), ('\u{110d0}', '\u{110e8}', WC_ALetter),
+ ('\u{110f0}', '\u{110f9}', WC_Numeric), ('\u{11100}', '\u{11102}', WC_Extend), ('\u{11103}',
+ '\u{11126}', WC_ALetter), ('\u{11127}', '\u{11134}', WC_Extend), ('\u{11136}', '\u{1113f}',
+ WC_Numeric), ('\u{11144}', '\u{11144}', WC_ALetter), ('\u{11145}', '\u{11146}', WC_Extend),
+ ('\u{11147}', '\u{11147}', WC_ALetter), ('\u{11150}', '\u{11172}', WC_ALetter),
+ ('\u{11173}', '\u{11173}', WC_Extend), ('\u{11176}', '\u{11176}', WC_ALetter), ('\u{11180}',
+ '\u{11182}', WC_Extend), ('\u{11183}', '\u{111b2}', WC_ALetter), ('\u{111b3}', '\u{111c0}',
+ WC_Extend), ('\u{111c1}', '\u{111c4}', WC_ALetter), ('\u{111c9}', '\u{111cc}', WC_Extend),
+ ('\u{111ce}', '\u{111cf}', WC_Extend), ('\u{111d0}', '\u{111d9}', WC_Numeric), ('\u{111da}',
+ '\u{111da}', WC_ALetter), ('\u{111dc}', '\u{111dc}', WC_ALetter), ('\u{11200}', '\u{11211}',
+ WC_ALetter), ('\u{11213}', '\u{1122b}', WC_ALetter), ('\u{1122c}', '\u{11237}', WC_Extend),
+ ('\u{1123e}', '\u{1123e}', WC_Extend), ('\u{1123f}', '\u{11240}', WC_ALetter), ('\u{11241}',
+ '\u{11241}', WC_Extend), ('\u{11280}', '\u{11286}', WC_ALetter), ('\u{11288}', '\u{11288}',
+ WC_ALetter), ('\u{1128a}', '\u{1128d}', WC_ALetter), ('\u{1128f}', '\u{1129d}', WC_ALetter),
+ ('\u{1129f}', '\u{112a8}', WC_ALetter), ('\u{112b0}', '\u{112de}', WC_ALetter),
+ ('\u{112df}', '\u{112ea}', WC_Extend), ('\u{112f0}', '\u{112f9}', WC_Numeric), ('\u{11300}',
+ '\u{11303}', WC_Extend), ('\u{11305}', '\u{1130c}', WC_ALetter), ('\u{1130f}', '\u{11310}',
+ WC_ALetter), ('\u{11313}', '\u{11328}', WC_ALetter), ('\u{1132a}', '\u{11330}', WC_ALetter),
+ ('\u{11332}', '\u{11333}', WC_ALetter), ('\u{11335}', '\u{11339}', WC_ALetter),
+ ('\u{1133b}', '\u{1133c}', WC_Extend), ('\u{1133d}', '\u{1133d}', WC_ALetter), ('\u{1133e}',
+ '\u{11344}', WC_Extend), ('\u{11347}', '\u{11348}', WC_Extend), ('\u{1134b}', '\u{1134d}',
+ WC_Extend), ('\u{11350}', '\u{11350}', WC_ALetter), ('\u{11357}', '\u{11357}', WC_Extend),
+ ('\u{1135d}', '\u{11361}', WC_ALetter), ('\u{11362}', '\u{11363}', WC_Extend), ('\u{11366}',
+ '\u{1136c}', WC_Extend), ('\u{11370}', '\u{11374}', WC_Extend), ('\u{11400}', '\u{11434}',
+ WC_ALetter), ('\u{11435}', '\u{11446}', WC_Extend), ('\u{11447}', '\u{1144a}', WC_ALetter),
+ ('\u{11450}', '\u{11459}', WC_Numeric), ('\u{1145e}', '\u{1145e}', WC_Extend), ('\u{1145f}',
+ '\u{11461}', WC_ALetter), ('\u{11480}', '\u{114af}', WC_ALetter), ('\u{114b0}', '\u{114c3}',
+ WC_Extend), ('\u{114c4}', '\u{114c5}', WC_ALetter), ('\u{114c7}', '\u{114c7}', WC_ALetter),
+ ('\u{114d0}', '\u{114d9}', WC_Numeric), ('\u{11580}', '\u{115ae}', WC_ALetter),
+ ('\u{115af}', '\u{115b5}', WC_Extend), ('\u{115b8}', '\u{115c0}', WC_Extend), ('\u{115d8}',
+ '\u{115db}', WC_ALetter), ('\u{115dc}', '\u{115dd}', WC_Extend), ('\u{11600}', '\u{1162f}',
+ WC_ALetter), ('\u{11630}', '\u{11640}', WC_Extend), ('\u{11644}', '\u{11644}', WC_ALetter),
+ ('\u{11650}', '\u{11659}', WC_Numeric), ('\u{11680}', '\u{116aa}', WC_ALetter),
+ ('\u{116ab}', '\u{116b7}', WC_Extend), ('\u{116b8}', '\u{116b8}', WC_ALetter), ('\u{116c0}',
+ '\u{116c9}', WC_Numeric), ('\u{1171d}', '\u{1172b}', WC_Extend), ('\u{11730}', '\u{11739}',
+ WC_Numeric), ('\u{11800}', '\u{1182b}', WC_ALetter), ('\u{1182c}', '\u{1183a}', WC_Extend),
+ ('\u{118a0}', '\u{118df}', WC_ALetter), ('\u{118e0}', '\u{118e9}', WC_Numeric),
+ ('\u{118ff}', '\u{11906}', WC_ALetter), ('\u{11909}', '\u{11909}', WC_ALetter),
+ ('\u{1190c}', '\u{11913}', WC_ALetter), ('\u{11915}', '\u{11916}', WC_ALetter),
+ ('\u{11918}', '\u{1192f}', WC_ALetter), ('\u{11930}', '\u{11935}', WC_Extend), ('\u{11937}',
+ '\u{11938}', WC_Extend), ('\u{1193b}', '\u{1193e}', WC_Extend), ('\u{1193f}', '\u{1193f}',
+ WC_ALetter), ('\u{11940}', '\u{11940}', WC_Extend), ('\u{11941}', '\u{11941}', WC_ALetter),
+ ('\u{11942}', '\u{11943}', WC_Extend), ('\u{11950}', '\u{11959}', WC_Numeric), ('\u{119a0}',
+ '\u{119a7}', WC_ALetter), ('\u{119aa}', '\u{119d0}', WC_ALetter), ('\u{119d1}', '\u{119d7}',
+ WC_Extend), ('\u{119da}', '\u{119e0}', WC_Extend), ('\u{119e1}', '\u{119e1}', WC_ALetter),
+ ('\u{119e3}', '\u{119e3}', WC_ALetter), ('\u{119e4}', '\u{119e4}', WC_Extend), ('\u{11a00}',
+ '\u{11a00}', WC_ALetter), ('\u{11a01}', '\u{11a0a}', WC_Extend), ('\u{11a0b}', '\u{11a32}',
+ WC_ALetter), ('\u{11a33}', '\u{11a39}', WC_Extend), ('\u{11a3a}', '\u{11a3a}', WC_ALetter),
+ ('\u{11a3b}', '\u{11a3e}', WC_Extend), ('\u{11a47}', '\u{11a47}', WC_Extend), ('\u{11a50}',
+ '\u{11a50}', WC_ALetter), ('\u{11a51}', '\u{11a5b}', WC_Extend), ('\u{11a5c}', '\u{11a89}',
+ WC_ALetter), ('\u{11a8a}', '\u{11a99}', WC_Extend), ('\u{11a9d}', '\u{11a9d}', WC_ALetter),
+ ('\u{11ab0}', '\u{11af8}', WC_ALetter), ('\u{11c00}', '\u{11c08}', WC_ALetter),
+ ('\u{11c0a}', '\u{11c2e}', WC_ALetter), ('\u{11c2f}', '\u{11c36}', WC_Extend), ('\u{11c38}',
+ '\u{11c3f}', WC_Extend), ('\u{11c40}', '\u{11c40}', WC_ALetter), ('\u{11c50}', '\u{11c59}',
+ WC_Numeric), ('\u{11c72}', '\u{11c8f}', WC_ALetter), ('\u{11c92}', '\u{11ca7}', WC_Extend),
+ ('\u{11ca9}', '\u{11cb6}', WC_Extend), ('\u{11d00}', '\u{11d06}', WC_ALetter), ('\u{11d08}',
+ '\u{11d09}', WC_ALetter), ('\u{11d0b}', '\u{11d30}', WC_ALetter), ('\u{11d31}', '\u{11d36}',
+ WC_Extend), ('\u{11d3a}', '\u{11d3a}', WC_Extend), ('\u{11d3c}', '\u{11d3d}', WC_Extend),
+ ('\u{11d3f}', '\u{11d45}', WC_Extend), ('\u{11d46}', '\u{11d46}', WC_ALetter), ('\u{11d47}',
+ '\u{11d47}', WC_Extend), ('\u{11d50}', '\u{11d59}', WC_Numeric), ('\u{11d60}', '\u{11d65}',
+ WC_ALetter), ('\u{11d67}', '\u{11d68}', WC_ALetter), ('\u{11d6a}', '\u{11d89}', WC_ALetter),
+ ('\u{11d8a}', '\u{11d8e}', WC_Extend), ('\u{11d90}', '\u{11d91}', WC_Extend), ('\u{11d93}',
+ '\u{11d97}', WC_Extend), ('\u{11d98}', '\u{11d98}', WC_ALetter), ('\u{11da0}', '\u{11da9}',
+ WC_Numeric), ('\u{11ee0}', '\u{11ef2}', WC_ALetter), ('\u{11ef3}', '\u{11ef6}', WC_Extend),
+ ('\u{11f00}', '\u{11f01}', WC_Extend), ('\u{11f02}', '\u{11f02}', WC_ALetter), ('\u{11f03}',
+ '\u{11f03}', WC_Extend), ('\u{11f04}', '\u{11f10}', WC_ALetter), ('\u{11f12}', '\u{11f33}',
+ WC_ALetter), ('\u{11f34}', '\u{11f3a}', WC_Extend), ('\u{11f3e}', '\u{11f42}', WC_Extend),
+ ('\u{11f50}', '\u{11f59}', WC_Numeric), ('\u{11fb0}', '\u{11fb0}', WC_ALetter),
+ ('\u{12000}', '\u{12399}', WC_ALetter), ('\u{12400}', '\u{1246e}', WC_ALetter),
+ ('\u{12480}', '\u{12543}', WC_ALetter), ('\u{12f90}', '\u{12ff0}', WC_ALetter),
+ ('\u{13000}', '\u{1342f}', WC_ALetter), ('\u{13430}', '\u{1343f}', WC_Format), ('\u{13440}',
+ '\u{13440}', WC_Extend), ('\u{13441}', '\u{13446}', WC_ALetter), ('\u{13447}', '\u{13455}',
+ WC_Extend), ('\u{14400}', '\u{14646}', WC_ALetter), ('\u{16800}', '\u{16a38}', WC_ALetter),
+ ('\u{16a40}', '\u{16a5e}', WC_ALetter), ('\u{16a60}', '\u{16a69}', WC_Numeric),
+ ('\u{16a70}', '\u{16abe}', WC_ALetter), ('\u{16ac0}', '\u{16ac9}', WC_Numeric),
+ ('\u{16ad0}', '\u{16aed}', WC_ALetter), ('\u{16af0}', '\u{16af4}', WC_Extend), ('\u{16b00}',
+ '\u{16b2f}', WC_ALetter), ('\u{16b30}', '\u{16b36}', WC_Extend), ('\u{16b40}', '\u{16b43}',
+ WC_ALetter), ('\u{16b50}', '\u{16b59}', WC_Numeric), ('\u{16b63}', '\u{16b77}', WC_ALetter),
+ ('\u{16b7d}', '\u{16b8f}', WC_ALetter), ('\u{16e40}', '\u{16e7f}', WC_ALetter),
+ ('\u{16f00}', '\u{16f4a}', WC_ALetter), ('\u{16f4f}', '\u{16f4f}', WC_Extend), ('\u{16f50}',
+ '\u{16f50}', WC_ALetter), ('\u{16f51}', '\u{16f87}', WC_Extend), ('\u{16f8f}', '\u{16f92}',
+ WC_Extend), ('\u{16f93}', '\u{16f9f}', WC_ALetter), ('\u{16fe0}', '\u{16fe1}', WC_ALetter),
+ ('\u{16fe3}', '\u{16fe3}', WC_ALetter), ('\u{16fe4}', '\u{16fe4}', WC_Extend), ('\u{16ff0}',
+ '\u{16ff1}', WC_Extend), ('\u{1aff0}', '\u{1aff3}', WC_Katakana), ('\u{1aff5}', '\u{1affb}',
+ WC_Katakana), ('\u{1affd}', '\u{1affe}', WC_Katakana), ('\u{1b000}', '\u{1b000}',
+ WC_Katakana), ('\u{1b120}', '\u{1b122}', WC_Katakana), ('\u{1b155}', '\u{1b155}',
+ WC_Katakana), ('\u{1b164}', '\u{1b167}', WC_Katakana), ('\u{1bc00}', '\u{1bc6a}',
+ WC_ALetter), ('\u{1bc70}', '\u{1bc7c}', WC_ALetter), ('\u{1bc80}', '\u{1bc88}', WC_ALetter),
+ ('\u{1bc90}', '\u{1bc99}', WC_ALetter), ('\u{1bc9d}', '\u{1bc9e}', WC_Extend), ('\u{1bca0}',
+ '\u{1bca3}', WC_Format), ('\u{1cf00}', '\u{1cf2d}', WC_Extend), ('\u{1cf30}', '\u{1cf46}',
+ WC_Extend), ('\u{1d165}', '\u{1d169}', WC_Extend), ('\u{1d16d}', '\u{1d172}', WC_Extend),
+ ('\u{1d173}', '\u{1d17a}', WC_Format), ('\u{1d17b}', '\u{1d182}', WC_Extend), ('\u{1d185}',
+ '\u{1d18b}', WC_Extend), ('\u{1d1aa}', '\u{1d1ad}', WC_Extend), ('\u{1d242}', '\u{1d244}',
+ WC_Extend), ('\u{1d400}', '\u{1d454}', WC_ALetter), ('\u{1d456}', '\u{1d49c}', WC_ALetter),
+ ('\u{1d49e}', '\u{1d49f}', WC_ALetter), ('\u{1d4a2}', '\u{1d4a2}', WC_ALetter),
+ ('\u{1d4a5}', '\u{1d4a6}', WC_ALetter), ('\u{1d4a9}', '\u{1d4ac}', WC_ALetter),
+ ('\u{1d4ae}', '\u{1d4b9}', WC_ALetter), ('\u{1d4bb}', '\u{1d4bb}', WC_ALetter),
+ ('\u{1d4bd}', '\u{1d4c3}', WC_ALetter), ('\u{1d4c5}', '\u{1d505}', WC_ALetter),
+ ('\u{1d507}', '\u{1d50a}', WC_ALetter), ('\u{1d50d}', '\u{1d514}', WC_ALetter),
+ ('\u{1d516}', '\u{1d51c}', WC_ALetter), ('\u{1d51e}', '\u{1d539}', WC_ALetter),
+ ('\u{1d53b}', '\u{1d53e}', WC_ALetter), ('\u{1d540}', '\u{1d544}', WC_ALetter),
+ ('\u{1d546}', '\u{1d546}', WC_ALetter), ('\u{1d54a}', '\u{1d550}', WC_ALetter),
+ ('\u{1d552}', '\u{1d6a5}', WC_ALetter), ('\u{1d6a8}', '\u{1d6c0}', WC_ALetter),
+ ('\u{1d6c2}', '\u{1d6da}', WC_ALetter), ('\u{1d6dc}', '\u{1d6fa}', WC_ALetter),
+ ('\u{1d6fc}', '\u{1d714}', WC_ALetter), ('\u{1d716}', '\u{1d734}', WC_ALetter),
+ ('\u{1d736}', '\u{1d74e}', WC_ALetter), ('\u{1d750}', '\u{1d76e}', WC_ALetter),
+ ('\u{1d770}', '\u{1d788}', WC_ALetter), ('\u{1d78a}', '\u{1d7a8}', WC_ALetter),
+ ('\u{1d7aa}', '\u{1d7c2}', WC_ALetter), ('\u{1d7c4}', '\u{1d7cb}', WC_ALetter),
+ ('\u{1d7ce}', '\u{1d7ff}', WC_Numeric), ('\u{1da00}', '\u{1da36}', WC_Extend), ('\u{1da3b}',
+ '\u{1da6c}', WC_Extend), ('\u{1da75}', '\u{1da75}', WC_Extend), ('\u{1da84}', '\u{1da84}',
+ WC_Extend), ('\u{1da9b}', '\u{1da9f}', WC_Extend), ('\u{1daa1}', '\u{1daaf}', WC_Extend),
+ ('\u{1df00}', '\u{1df1e}', WC_ALetter), ('\u{1df25}', '\u{1df2a}', WC_ALetter),
+ ('\u{1e000}', '\u{1e006}', WC_Extend), ('\u{1e008}', '\u{1e018}', WC_Extend), ('\u{1e01b}',
+ '\u{1e021}', WC_Extend), ('\u{1e023}', '\u{1e024}', WC_Extend), ('\u{1e026}', '\u{1e02a}',
+ WC_Extend), ('\u{1e030}', '\u{1e06d}', WC_ALetter), ('\u{1e08f}', '\u{1e08f}', WC_Extend),
+ ('\u{1e100}', '\u{1e12c}', WC_ALetter), ('\u{1e130}', '\u{1e136}', WC_Extend), ('\u{1e137}',
+ '\u{1e13d}', WC_ALetter), ('\u{1e140}', '\u{1e149}', WC_Numeric), ('\u{1e14e}', '\u{1e14e}',
+ WC_ALetter), ('\u{1e290}', '\u{1e2ad}', WC_ALetter), ('\u{1e2ae}', '\u{1e2ae}', WC_Extend),
+ ('\u{1e2c0}', '\u{1e2eb}', WC_ALetter), ('\u{1e2ec}', '\u{1e2ef}', WC_Extend), ('\u{1e2f0}',
+ '\u{1e2f9}', WC_Numeric), ('\u{1e4d0}', '\u{1e4eb}', WC_ALetter), ('\u{1e4ec}', '\u{1e4ef}',
+ WC_Extend), ('\u{1e4f0}', '\u{1e4f9}', WC_Numeric), ('\u{1e7e0}', '\u{1e7e6}', WC_ALetter),
+ ('\u{1e7e8}', '\u{1e7eb}', WC_ALetter), ('\u{1e7ed}', '\u{1e7ee}', WC_ALetter),
+ ('\u{1e7f0}', '\u{1e7fe}', WC_ALetter), ('\u{1e800}', '\u{1e8c4}', WC_ALetter),
+ ('\u{1e8d0}', '\u{1e8d6}', WC_Extend), ('\u{1e900}', '\u{1e943}', WC_ALetter), ('\u{1e944}',
+ '\u{1e94a}', WC_Extend), ('\u{1e94b}', '\u{1e94b}', WC_ALetter), ('\u{1e950}', '\u{1e959}',
+ WC_Numeric), ('\u{1ee00}', '\u{1ee03}', WC_ALetter), ('\u{1ee05}', '\u{1ee1f}', WC_ALetter),
+ ('\u{1ee21}', '\u{1ee22}', WC_ALetter), ('\u{1ee24}', '\u{1ee24}', WC_ALetter),
+ ('\u{1ee27}', '\u{1ee27}', WC_ALetter), ('\u{1ee29}', '\u{1ee32}', WC_ALetter),
+ ('\u{1ee34}', '\u{1ee37}', WC_ALetter), ('\u{1ee39}', '\u{1ee39}', WC_ALetter),
+ ('\u{1ee3b}', '\u{1ee3b}', WC_ALetter), ('\u{1ee42}', '\u{1ee42}', WC_ALetter),
+ ('\u{1ee47}', '\u{1ee47}', WC_ALetter), ('\u{1ee49}', '\u{1ee49}', WC_ALetter),
+ ('\u{1ee4b}', '\u{1ee4b}', WC_ALetter), ('\u{1ee4d}', '\u{1ee4f}', WC_ALetter),
+ ('\u{1ee51}', '\u{1ee52}', WC_ALetter), ('\u{1ee54}', '\u{1ee54}', WC_ALetter),
+ ('\u{1ee57}', '\u{1ee57}', WC_ALetter), ('\u{1ee59}', '\u{1ee59}', WC_ALetter),
+ ('\u{1ee5b}', '\u{1ee5b}', WC_ALetter), ('\u{1ee5d}', '\u{1ee5d}', WC_ALetter),
+ ('\u{1ee5f}', '\u{1ee5f}', WC_ALetter), ('\u{1ee61}', '\u{1ee62}', WC_ALetter),
+ ('\u{1ee64}', '\u{1ee64}', WC_ALetter), ('\u{1ee67}', '\u{1ee6a}', WC_ALetter),
+ ('\u{1ee6c}', '\u{1ee72}', WC_ALetter), ('\u{1ee74}', '\u{1ee77}', WC_ALetter),
+ ('\u{1ee79}', '\u{1ee7c}', WC_ALetter), ('\u{1ee7e}', '\u{1ee7e}', WC_ALetter),
+ ('\u{1ee80}', '\u{1ee89}', WC_ALetter), ('\u{1ee8b}', '\u{1ee9b}', WC_ALetter),
+ ('\u{1eea1}', '\u{1eea3}', WC_ALetter), ('\u{1eea5}', '\u{1eea9}', WC_ALetter),
+ ('\u{1eeab}', '\u{1eebb}', WC_ALetter), ('\u{1f130}', '\u{1f149}', WC_ALetter),
+ ('\u{1f150}', '\u{1f169}', WC_ALetter), ('\u{1f170}', '\u{1f189}', WC_ALetter),
+ ('\u{1f1e6}', '\u{1f1ff}', WC_Regional_Indicator), ('\u{1f3fb}', '\u{1f3ff}', WC_Extend),
+ ('\u{1fbf0}', '\u{1fbf9}', WC_Numeric), ('\u{e0001}', '\u{e0001}', WC_Format), ('\u{e0020}',
+ '\u{e007f}', WC_Extend), ('\u{e0100}', '\u{e01ef}', WC_Extend)
+ ];
+
+}
+pub mod emoji {
+ use core::result::Result::{Ok, Err};
+
+ pub use self::EmojiCat::*;
+
+ #[allow(non_camel_case_types)]
+ #[derive(Clone, Copy, PartialEq, Eq, Debug)]
+ pub enum EmojiCat {
+ EC_Any,
+ EC_Extended_Pictographic,
+ }
+
+ fn bsearch_range_value_table(c: char, r: &'static [(char, char, EmojiCat)], default_lower: u32, default_upper: u32) -> (u32, u32, EmojiCat) {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }) {
+ Ok(idx) => {
+ let (lower, upper, cat) = r[idx];
+ (lower as u32, upper as u32, cat)
+ }
+ Err(idx) => {
+ (
+ if idx > 0 { r[idx-1].1 as u32 + 1 } else { default_lower },
+ r.get(idx).map(|c|c.0 as u32 - 1).unwrap_or(default_upper),
+ EC_Any,
+ )
+ }
+ }
+ }
+
+ pub fn emoji_category(c: char) -> (u32, u32, EmojiCat) {
+ // Perform a quick O(1) lookup in a precomputed table to determine
+ // the slice of the range table to search in.
+ let lookup_interval = 0x80;
+ let idx = (c as u32 / lookup_interval) as usize;
+ let range = emoji_cat_lookup.get(idx..(idx + 2)).map_or(
+ // If the `idx` is outside of the precomputed table - use the slice
+ // starting from the last covered index in the precomputed table and
+ // ending with the length of the range table.
+ 77..78,
+ |r| (r[0] as usize)..((r[1] + 1) as usize)
+ );
+
+ // Compute pessimistic default lower and upper bounds on the category.
+ // If character doesn't map to any range and there is no adjacent range
+ // in the table slice - these bounds has to apply.
+ let lower = idx as u32 * lookup_interval;
+ let upper = lower + lookup_interval - 1;
+ bsearch_range_value_table(c, &emoji_cat_table[range], lower, upper)
+ }
+
+ const emoji_cat_lookup: &'static [u8] = &[
+ 0, 0, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
+ 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
+ 2, 2, 2, 4, 4, 6, 8, 8, 8, 10, 14, 14, 15, 15, 19, 21, 22, 37, 41, 41, 41, 42, 42, 42, 42,
+ 46, 46, 46, 46, 46, 46, 46, 46, 46, 46, 48, 48, 48, 48, 48, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 50,
+ 50, 50, 50, 50, 50, 50, 50, 50, 50, 50, 51, 55, 58, 63, 63, 63, 64, 64, 64, 65, 65, 66, 67,
+ 68, 69, 72, 74, 76, 76, 76, 77, 77, 77, 77, 77, 77, 77, 77, 77, 77
+ ];
+
+ const emoji_cat_table: &'static [(char, char, EmojiCat)] = &[
+ ('\u{a9}', '\u{a9}', EC_Extended_Pictographic), ('\u{ae}', '\u{ae}',
+ EC_Extended_Pictographic), ('\u{203c}', '\u{203c}', EC_Extended_Pictographic), ('\u{2049}',
+ '\u{2049}', EC_Extended_Pictographic), ('\u{2122}', '\u{2122}', EC_Extended_Pictographic),
+ ('\u{2139}', '\u{2139}', EC_Extended_Pictographic), ('\u{2194}', '\u{2199}',
+ EC_Extended_Pictographic), ('\u{21a9}', '\u{21aa}', EC_Extended_Pictographic), ('\u{231a}',
+ '\u{231b}', EC_Extended_Pictographic), ('\u{2328}', '\u{2328}', EC_Extended_Pictographic),
+ ('\u{2388}', '\u{2388}', EC_Extended_Pictographic), ('\u{23cf}', '\u{23cf}',
+ EC_Extended_Pictographic), ('\u{23e9}', '\u{23f3}', EC_Extended_Pictographic), ('\u{23f8}',
+ '\u{23fa}', EC_Extended_Pictographic), ('\u{24c2}', '\u{24c2}', EC_Extended_Pictographic),
+ ('\u{25aa}', '\u{25ab}', EC_Extended_Pictographic), ('\u{25b6}', '\u{25b6}',
+ EC_Extended_Pictographic), ('\u{25c0}', '\u{25c0}', EC_Extended_Pictographic), ('\u{25fb}',
+ '\u{25fe}', EC_Extended_Pictographic), ('\u{2600}', '\u{2605}', EC_Extended_Pictographic),
+ ('\u{2607}', '\u{2612}', EC_Extended_Pictographic), ('\u{2614}', '\u{2685}',
+ EC_Extended_Pictographic), ('\u{2690}', '\u{2705}', EC_Extended_Pictographic), ('\u{2708}',
+ '\u{2712}', EC_Extended_Pictographic), ('\u{2714}', '\u{2714}', EC_Extended_Pictographic),
+ ('\u{2716}', '\u{2716}', EC_Extended_Pictographic), ('\u{271d}', '\u{271d}',
+ EC_Extended_Pictographic), ('\u{2721}', '\u{2721}', EC_Extended_Pictographic), ('\u{2728}',
+ '\u{2728}', EC_Extended_Pictographic), ('\u{2733}', '\u{2734}', EC_Extended_Pictographic),
+ ('\u{2744}', '\u{2744}', EC_Extended_Pictographic), ('\u{2747}', '\u{2747}',
+ EC_Extended_Pictographic), ('\u{274c}', '\u{274c}', EC_Extended_Pictographic), ('\u{274e}',
+ '\u{274e}', EC_Extended_Pictographic), ('\u{2753}', '\u{2755}', EC_Extended_Pictographic),
+ ('\u{2757}', '\u{2757}', EC_Extended_Pictographic), ('\u{2763}', '\u{2767}',
+ EC_Extended_Pictographic), ('\u{2795}', '\u{2797}', EC_Extended_Pictographic), ('\u{27a1}',
+ '\u{27a1}', EC_Extended_Pictographic), ('\u{27b0}', '\u{27b0}', EC_Extended_Pictographic),
+ ('\u{27bf}', '\u{27bf}', EC_Extended_Pictographic), ('\u{2934}', '\u{2935}',
+ EC_Extended_Pictographic), ('\u{2b05}', '\u{2b07}', EC_Extended_Pictographic), ('\u{2b1b}',
+ '\u{2b1c}', EC_Extended_Pictographic), ('\u{2b50}', '\u{2b50}', EC_Extended_Pictographic),
+ ('\u{2b55}', '\u{2b55}', EC_Extended_Pictographic), ('\u{3030}', '\u{3030}',
+ EC_Extended_Pictographic), ('\u{303d}', '\u{303d}', EC_Extended_Pictographic), ('\u{3297}',
+ '\u{3297}', EC_Extended_Pictographic), ('\u{3299}', '\u{3299}', EC_Extended_Pictographic),
+ ('\u{1f000}', '\u{1f0ff}', EC_Extended_Pictographic), ('\u{1f10d}', '\u{1f10f}',
+ EC_Extended_Pictographic), ('\u{1f12f}', '\u{1f12f}', EC_Extended_Pictographic),
+ ('\u{1f16c}', '\u{1f171}', EC_Extended_Pictographic), ('\u{1f17e}', '\u{1f17f}',
+ EC_Extended_Pictographic), ('\u{1f18e}', '\u{1f18e}', EC_Extended_Pictographic),
+ ('\u{1f191}', '\u{1f19a}', EC_Extended_Pictographic), ('\u{1f1ad}', '\u{1f1e5}',
+ EC_Extended_Pictographic), ('\u{1f201}', '\u{1f20f}', EC_Extended_Pictographic),
+ ('\u{1f21a}', '\u{1f21a}', EC_Extended_Pictographic), ('\u{1f22f}', '\u{1f22f}',
+ EC_Extended_Pictographic), ('\u{1f232}', '\u{1f23a}', EC_Extended_Pictographic),
+ ('\u{1f23c}', '\u{1f23f}', EC_Extended_Pictographic), ('\u{1f249}', '\u{1f3fa}',
+ EC_Extended_Pictographic), ('\u{1f400}', '\u{1f53d}', EC_Extended_Pictographic),
+ ('\u{1f546}', '\u{1f64f}', EC_Extended_Pictographic), ('\u{1f680}', '\u{1f6ff}',
+ EC_Extended_Pictographic), ('\u{1f774}', '\u{1f77f}', EC_Extended_Pictographic),
+ ('\u{1f7d5}', '\u{1f7ff}', EC_Extended_Pictographic), ('\u{1f80c}', '\u{1f80f}',
+ EC_Extended_Pictographic), ('\u{1f848}', '\u{1f84f}', EC_Extended_Pictographic),
+ ('\u{1f85a}', '\u{1f85f}', EC_Extended_Pictographic), ('\u{1f888}', '\u{1f88f}',
+ EC_Extended_Pictographic), ('\u{1f8ae}', '\u{1f8ff}', EC_Extended_Pictographic),
+ ('\u{1f90c}', '\u{1f93a}', EC_Extended_Pictographic), ('\u{1f93c}', '\u{1f945}',
+ EC_Extended_Pictographic), ('\u{1f947}', '\u{1faff}', EC_Extended_Pictographic),
+ ('\u{1fc00}', '\u{1fffd}', EC_Extended_Pictographic)
+ ];
+
+}
+pub mod sentence {
+ use core::result::Result::{Ok, Err};
+
+ pub use self::SentenceCat::*;
+
+ #[allow(non_camel_case_types)]
+ #[derive(Clone, Copy, PartialEq, Eq, Debug)]
+ pub enum SentenceCat {
+ SC_ATerm,
+ SC_Any,
+ SC_CR,
+ SC_Close,
+ SC_Extend,
+ SC_Format,
+ SC_LF,
+ SC_Lower,
+ SC_Numeric,
+ SC_OLetter,
+ SC_SContinue,
+ SC_STerm,
+ SC_Sep,
+ SC_Sp,
+ SC_Upper,
+ }
+
+ fn bsearch_range_value_table(c: char, r: &'static [(char, char, SentenceCat)], default_lower: u32, default_upper: u32) -> (u32, u32, SentenceCat) {
+ use core::cmp::Ordering::{Equal, Less, Greater};
+ match r.binary_search_by(|&(lo, hi, _)| {
+ if lo <= c && c <= hi { Equal }
+ else if hi < c { Less }
+ else { Greater }
+ }) {
+ Ok(idx) => {
+ let (lower, upper, cat) = r[idx];
+ (lower as u32, upper as u32, cat)
+ }
+ Err(idx) => {
+ (
+ if idx > 0 { r[idx-1].1 as u32 + 1 } else { default_lower },
+ r.get(idx).map(|c|c.0 as u32 - 1).unwrap_or(default_upper),
+ SC_Any,
+ )
+ }
+ }
+ }
+
+ pub fn sentence_category(c: char) -> (u32, u32, SentenceCat) {
+ // Perform a quick O(1) lookup in a precomputed table to determine
+ // the slice of the range table to search in.
+ let lookup_interval = 0x80;
+ let idx = (c as u32 / lookup_interval) as usize;
+ let range = sentence_cat_lookup.get(idx..(idx + 2)).map_or(
+ // If the `idx` is outside of the precomputed table - use the slice
+ // starting from the last covered index in the precomputed table and
+ // ending with the length of the range table.
+ 2410..2421,
+ |r| (r[0] as usize)..((r[1] + 1) as usize)
+ );
+
+ // Compute pessimistic default lower and upper bounds on the category.
+ // If character doesn't map to any range and there is no adjacent range
+ // in the table slice - these bounds has to apply.
+ let lower = idx as u32 * lookup_interval;
+ let upper = lower + lookup_interval - 1;
+ bsearch_range_value_table(c, &sentence_cat_table[range], lower, upper)
+ }
+
+ const sentence_cat_lookup: &'static [u16] = &[
+ 0, 19, 31, 154, 247, 314, 323, 333, 375, 409, 528, 579, 588, 599, 612, 618, 629, 643, 650,
+ 661, 683, 702, 720, 738, 755, 771, 790, 806, 818, 825, 840, 850, 856, 871, 882, 882, 882,
+ 887, 895, 901, 904, 904, 904, 904, 904, 907, 912, 922, 928, 937, 943, 950, 953, 959, 964,
+ 973, 980, 988, 1000, 1000, 1002, 1130, 1249, 1267, 1288, 1308, 1311, 1336, 1340, 1340, 1340,
+ 1342, 1342, 1342, 1344, 1344, 1344, 1344, 1344, 1346, 1348, 1348, 1348, 1348, 1351, 1351,
+ 1351, 1351, 1351, 1369, 1476, 1482, 1492, 1501, 1501, 1501, 1501, 1512, 1517, 1518, 1521,
+ 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521,
+ 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521,
+ 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521,
+ 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1521, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522, 1522,
+ 1522, 1522, 1522, 1522, 1525, 1525, 1525, 1580, 1613, 1696, 1769, 1780, 1790, 1797, 1808,
+ 1819, 1836, 1843, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849, 1849,
+ 1849, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852,
+ 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852,
+ 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852,
+ 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852,
+ 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1852, 1853, 1854, 1864, 1865, 1865,
+ 1865, 1867, 1870, 1886, 1888, 1905, 1913, 1919, 1920, 1921, 1922, 1922, 1925, 1929, 1933,
+ 1935, 1939, 1942, 1949, 1949, 1949, 1952, 1957, 1964, 1967, 1969, 1971, 1982, 1986, 1989,
+ 1990, 1991, 1993, 1996, 1996, 1996, 2000, 2005, 2010, 2019, 2028, 2039, 2051, 2059, 2068,
+ 2086, 2086, 2093, 2098, 2098, 2105, 2110, 2114, 2119, 2119, 2121, 2124, 2139, 2146, 2156,
+ 2161, 2161, 2161, 2168, 2171, 2183, 2189, 2189, 2192, 2201, 2202, 2202, 2202, 2202, 2202,
+ 2202, 2202, 2202, 2203, 2204, 2204, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205,
+ 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2205, 2206, 2206, 2206,
+ 2206, 2206, 2206, 2206, 2206, 2206, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211,
+ 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211,
+ 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2211, 2212, 2212, 2212,
+ 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212,
+ 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212,
+ 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212,
+ 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212,
+ 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2212, 2216, 2221, 2228, 2229, 2229, 2229,
+ 2229, 2229, 2231, 2232, 2235, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242,
+ 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242,
+ 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242,
+ 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2242, 2243, 2243, 2243, 2243, 2243, 2243, 2243,
+ 2243, 2243, 2243, 2244, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245,
+ 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245,
+ 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245,
+ 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245,
+ 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2245, 2248, 2248,
+ 2248, 2253, 2253, 2253, 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2254,
+ 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2254, 2256, 2261, 2261, 2261, 2261, 2261, 2261,
+ 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261,
+ 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261, 2261,
+ 2261, 2263, 2263, 2263, 2263, 2266, 2269, 2270, 2270, 2270, 2270, 2275, 2288, 2300, 2305,
+ 2310, 2316, 2322, 2330, 2330, 2330, 2330, 2330, 2333, 2337, 2337, 2337, 2337, 2337, 2337,
+ 2337, 2337, 2337, 2341, 2341, 2347, 2348, 2353, 2353, 2353, 2358, 2358, 2358, 2358, 2361,
+ 2361, 2361, 2361, 2361, 2361, 2365, 2365, 2367, 2372, 2372, 2372, 2372, 2372, 2372, 2372,
+ 2372, 2372, 2372, 2400, 2405, 2405, 2405, 2405, 2405, 2407, 2408, 2408, 2408, 2408, 2408,
+ 2408, 2408, 2408, 2408, 2409, 2409, 2409, 2409, 2409, 2409, 2409, 2409, 2409, 2409, 2409,
+ 2410, 2410, 2410, 2410, 2410, 2410, 2410, 2410
+ ];
+
+ const sentence_cat_table: &'static [(char, char, SentenceCat)] = &[
+ ('\u{9}', '\u{9}', SC_Sp), ('\u{a}', '\u{a}', SC_LF), ('\u{b}', '\u{c}', SC_Sp), ('\u{d}',
+ '\u{d}', SC_CR), ('\u{20}', '\u{20}', SC_Sp), ('\u{21}', '\u{21}', SC_STerm), ('\u{22}',
+ '\u{22}', SC_Close), ('\u{27}', '\u{29}', SC_Close), ('\u{2c}', '\u{2d}', SC_SContinue),
+ ('\u{2e}', '\u{2e}', SC_ATerm), ('\u{30}', '\u{39}', SC_Numeric), ('\u{3a}', '\u{3a}',
+ SC_SContinue), ('\u{3f}', '\u{3f}', SC_STerm), ('\u{41}', '\u{5a}', SC_Upper), ('\u{5b}',
+ '\u{5b}', SC_Close), ('\u{5d}', '\u{5d}', SC_Close), ('\u{61}', '\u{7a}', SC_Lower),
+ ('\u{7b}', '\u{7b}', SC_Close), ('\u{7d}', '\u{7d}', SC_Close), ('\u{85}', '\u{85}',
+ SC_Sep), ('\u{a0}', '\u{a0}', SC_Sp), ('\u{aa}', '\u{aa}', SC_Lower), ('\u{ab}', '\u{ab}',
+ SC_Close), ('\u{ad}', '\u{ad}', SC_Format), ('\u{b5}', '\u{b5}', SC_Lower), ('\u{ba}',
+ '\u{ba}', SC_Lower), ('\u{bb}', '\u{bb}', SC_Close), ('\u{c0}', '\u{d6}', SC_Upper),
+ ('\u{d8}', '\u{de}', SC_Upper), ('\u{df}', '\u{f6}', SC_Lower), ('\u{f8}', '\u{ff}',
+ SC_Lower), ('\u{100}', '\u{100}', SC_Upper), ('\u{101}', '\u{101}', SC_Lower), ('\u{102}',
+ '\u{102}', SC_Upper), ('\u{103}', '\u{103}', SC_Lower), ('\u{104}', '\u{104}', SC_Upper),
+ ('\u{105}', '\u{105}', SC_Lower), ('\u{106}', '\u{106}', SC_Upper), ('\u{107}', '\u{107}',
+ SC_Lower), ('\u{108}', '\u{108}', SC_Upper), ('\u{109}', '\u{109}', SC_Lower), ('\u{10a}',
+ '\u{10a}', SC_Upper), ('\u{10b}', '\u{10b}', SC_Lower), ('\u{10c}', '\u{10c}', SC_Upper),
+ ('\u{10d}', '\u{10d}', SC_Lower), ('\u{10e}', '\u{10e}', SC_Upper), ('\u{10f}', '\u{10f}',
+ SC_Lower), ('\u{110}', '\u{110}', SC_Upper), ('\u{111}', '\u{111}', SC_Lower), ('\u{112}',
+ '\u{112}', SC_Upper), ('\u{113}', '\u{113}', SC_Lower), ('\u{114}', '\u{114}', SC_Upper),
+ ('\u{115}', '\u{115}', SC_Lower), ('\u{116}', '\u{116}', SC_Upper), ('\u{117}', '\u{117}',
+ SC_Lower), ('\u{118}', '\u{118}', SC_Upper), ('\u{119}', '\u{119}', SC_Lower), ('\u{11a}',
+ '\u{11a}', SC_Upper), ('\u{11b}', '\u{11b}', SC_Lower), ('\u{11c}', '\u{11c}', SC_Upper),
+ ('\u{11d}', '\u{11d}', SC_Lower), ('\u{11e}', '\u{11e}', SC_Upper), ('\u{11f}', '\u{11f}',
+ SC_Lower), ('\u{120}', '\u{120}', SC_Upper), ('\u{121}', '\u{121}', SC_Lower), ('\u{122}',
+ '\u{122}', SC_Upper), ('\u{123}', '\u{123}', SC_Lower), ('\u{124}', '\u{124}', SC_Upper),
+ ('\u{125}', '\u{125}', SC_Lower), ('\u{126}', '\u{126}', SC_Upper), ('\u{127}', '\u{127}',
+ SC_Lower), ('\u{128}', '\u{128}', SC_Upper), ('\u{129}', '\u{129}', SC_Lower), ('\u{12a}',
+ '\u{12a}', SC_Upper), ('\u{12b}', '\u{12b}', SC_Lower), ('\u{12c}', '\u{12c}', SC_Upper),
+ ('\u{12d}', '\u{12d}', SC_Lower), ('\u{12e}', '\u{12e}', SC_Upper), ('\u{12f}', '\u{12f}',
+ SC_Lower), ('\u{130}', '\u{130}', SC_Upper), ('\u{131}', '\u{131}', SC_Lower), ('\u{132}',
+ '\u{132}', SC_Upper), ('\u{133}', '\u{133}', SC_Lower), ('\u{134}', '\u{134}', SC_Upper),
+ ('\u{135}', '\u{135}', SC_Lower), ('\u{136}', '\u{136}', SC_Upper), ('\u{137}', '\u{138}',
+ SC_Lower), ('\u{139}', '\u{139}', SC_Upper), ('\u{13a}', '\u{13a}', SC_Lower), ('\u{13b}',
+ '\u{13b}', SC_Upper), ('\u{13c}', '\u{13c}', SC_Lower), ('\u{13d}', '\u{13d}', SC_Upper),
+ ('\u{13e}', '\u{13e}', SC_Lower), ('\u{13f}', '\u{13f}', SC_Upper), ('\u{140}', '\u{140}',
+ SC_Lower), ('\u{141}', '\u{141}', SC_Upper), ('\u{142}', '\u{142}', SC_Lower), ('\u{143}',
+ '\u{143}', SC_Upper), ('\u{144}', '\u{144}', SC_Lower), ('\u{145}', '\u{145}', SC_Upper),
+ ('\u{146}', '\u{146}', SC_Lower), ('\u{147}', '\u{147}', SC_Upper), ('\u{148}', '\u{149}',
+ SC_Lower), ('\u{14a}', '\u{14a}', SC_Upper), ('\u{14b}', '\u{14b}', SC_Lower), ('\u{14c}',
+ '\u{14c}', SC_Upper), ('\u{14d}', '\u{14d}', SC_Lower), ('\u{14e}', '\u{14e}', SC_Upper),
+ ('\u{14f}', '\u{14f}', SC_Lower), ('\u{150}', '\u{150}', SC_Upper), ('\u{151}', '\u{151}',
+ SC_Lower), ('\u{152}', '\u{152}', SC_Upper), ('\u{153}', '\u{153}', SC_Lower), ('\u{154}',
+ '\u{154}', SC_Upper), ('\u{155}', '\u{155}', SC_Lower), ('\u{156}', '\u{156}', SC_Upper),
+ ('\u{157}', '\u{157}', SC_Lower), ('\u{158}', '\u{158}', SC_Upper), ('\u{159}', '\u{159}',
+ SC_Lower), ('\u{15a}', '\u{15a}', SC_Upper), ('\u{15b}', '\u{15b}', SC_Lower), ('\u{15c}',
+ '\u{15c}', SC_Upper), ('\u{15d}', '\u{15d}', SC_Lower), ('\u{15e}', '\u{15e}', SC_Upper),
+ ('\u{15f}', '\u{15f}', SC_Lower), ('\u{160}', '\u{160}', SC_Upper), ('\u{161}', '\u{161}',
+ SC_Lower), ('\u{162}', '\u{162}', SC_Upper), ('\u{163}', '\u{163}', SC_Lower), ('\u{164}',
+ '\u{164}', SC_Upper), ('\u{165}', '\u{165}', SC_Lower), ('\u{166}', '\u{166}', SC_Upper),
+ ('\u{167}', '\u{167}', SC_Lower), ('\u{168}', '\u{168}', SC_Upper), ('\u{169}', '\u{169}',
+ SC_Lower), ('\u{16a}', '\u{16a}', SC_Upper), ('\u{16b}', '\u{16b}', SC_Lower), ('\u{16c}',
+ '\u{16c}', SC_Upper), ('\u{16d}', '\u{16d}', SC_Lower), ('\u{16e}', '\u{16e}', SC_Upper),
+ ('\u{16f}', '\u{16f}', SC_Lower), ('\u{170}', '\u{170}', SC_Upper), ('\u{171}', '\u{171}',
+ SC_Lower), ('\u{172}', '\u{172}', SC_Upper), ('\u{173}', '\u{173}', SC_Lower), ('\u{174}',
+ '\u{174}', SC_Upper), ('\u{175}', '\u{175}', SC_Lower), ('\u{176}', '\u{176}', SC_Upper),
+ ('\u{177}', '\u{177}', SC_Lower), ('\u{178}', '\u{179}', SC_Upper), ('\u{17a}', '\u{17a}',
+ SC_Lower), ('\u{17b}', '\u{17b}', SC_Upper), ('\u{17c}', '\u{17c}', SC_Lower), ('\u{17d}',
+ '\u{17d}', SC_Upper), ('\u{17e}', '\u{180}', SC_Lower), ('\u{181}', '\u{182}', SC_Upper),
+ ('\u{183}', '\u{183}', SC_Lower), ('\u{184}', '\u{184}', SC_Upper), ('\u{185}', '\u{185}',
+ SC_Lower), ('\u{186}', '\u{187}', SC_Upper), ('\u{188}', '\u{188}', SC_Lower), ('\u{189}',
+ '\u{18b}', SC_Upper), ('\u{18c}', '\u{18d}', SC_Lower), ('\u{18e}', '\u{191}', SC_Upper),
+ ('\u{192}', '\u{192}', SC_Lower), ('\u{193}', '\u{194}', SC_Upper), ('\u{195}', '\u{195}',
+ SC_Lower), ('\u{196}', '\u{198}', SC_Upper), ('\u{199}', '\u{19b}', SC_Lower), ('\u{19c}',
+ '\u{19d}', SC_Upper), ('\u{19e}', '\u{19e}', SC_Lower), ('\u{19f}', '\u{1a0}', SC_Upper),
+ ('\u{1a1}', '\u{1a1}', SC_Lower), ('\u{1a2}', '\u{1a2}', SC_Upper), ('\u{1a3}', '\u{1a3}',
+ SC_Lower), ('\u{1a4}', '\u{1a4}', SC_Upper), ('\u{1a5}', '\u{1a5}', SC_Lower), ('\u{1a6}',
+ '\u{1a7}', SC_Upper), ('\u{1a8}', '\u{1a8}', SC_Lower), ('\u{1a9}', '\u{1a9}', SC_Upper),
+ ('\u{1aa}', '\u{1ab}', SC_Lower), ('\u{1ac}', '\u{1ac}', SC_Upper), ('\u{1ad}', '\u{1ad}',
+ SC_Lower), ('\u{1ae}', '\u{1af}', SC_Upper), ('\u{1b0}', '\u{1b0}', SC_Lower), ('\u{1b1}',
+ '\u{1b3}', SC_Upper), ('\u{1b4}', '\u{1b4}', SC_Lower), ('\u{1b5}', '\u{1b5}', SC_Upper),
+ ('\u{1b6}', '\u{1b6}', SC_Lower), ('\u{1b7}', '\u{1b8}', SC_Upper), ('\u{1b9}', '\u{1ba}',
+ SC_Lower), ('\u{1bb}', '\u{1bb}', SC_OLetter), ('\u{1bc}', '\u{1bc}', SC_Upper), ('\u{1bd}',
+ '\u{1bf}', SC_Lower), ('\u{1c0}', '\u{1c3}', SC_OLetter), ('\u{1c4}', '\u{1c5}', SC_Upper),
+ ('\u{1c6}', '\u{1c6}', SC_Lower), ('\u{1c7}', '\u{1c8}', SC_Upper), ('\u{1c9}', '\u{1c9}',
+ SC_Lower), ('\u{1ca}', '\u{1cb}', SC_Upper), ('\u{1cc}', '\u{1cc}', SC_Lower), ('\u{1cd}',
+ '\u{1cd}', SC_Upper), ('\u{1ce}', '\u{1ce}', SC_Lower), ('\u{1cf}', '\u{1cf}', SC_Upper),
+ ('\u{1d0}', '\u{1d0}', SC_Lower), ('\u{1d1}', '\u{1d1}', SC_Upper), ('\u{1d2}', '\u{1d2}',
+ SC_Lower), ('\u{1d3}', '\u{1d3}', SC_Upper), ('\u{1d4}', '\u{1d4}', SC_Lower), ('\u{1d5}',
+ '\u{1d5}', SC_Upper), ('\u{1d6}', '\u{1d6}', SC_Lower), ('\u{1d7}', '\u{1d7}', SC_Upper),
+ ('\u{1d8}', '\u{1d8}', SC_Lower), ('\u{1d9}', '\u{1d9}', SC_Upper), ('\u{1da}', '\u{1da}',
+ SC_Lower), ('\u{1db}', '\u{1db}', SC_Upper), ('\u{1dc}', '\u{1dd}', SC_Lower), ('\u{1de}',
+ '\u{1de}', SC_Upper), ('\u{1df}', '\u{1df}', SC_Lower), ('\u{1e0}', '\u{1e0}', SC_Upper),
+ ('\u{1e1}', '\u{1e1}', SC_Lower), ('\u{1e2}', '\u{1e2}', SC_Upper), ('\u{1e3}', '\u{1e3}',
+ SC_Lower), ('\u{1e4}', '\u{1e4}', SC_Upper), ('\u{1e5}', '\u{1e5}', SC_Lower), ('\u{1e6}',
+ '\u{1e6}', SC_Upper), ('\u{1e7}', '\u{1e7}', SC_Lower), ('\u{1e8}', '\u{1e8}', SC_Upper),
+ ('\u{1e9}', '\u{1e9}', SC_Lower), ('\u{1ea}', '\u{1ea}', SC_Upper), ('\u{1eb}', '\u{1eb}',
+ SC_Lower), ('\u{1ec}', '\u{1ec}', SC_Upper), ('\u{1ed}', '\u{1ed}', SC_Lower), ('\u{1ee}',
+ '\u{1ee}', SC_Upper), ('\u{1ef}', '\u{1f0}', SC_Lower), ('\u{1f1}', '\u{1f2}', SC_Upper),
+ ('\u{1f3}', '\u{1f3}', SC_Lower), ('\u{1f4}', '\u{1f4}', SC_Upper), ('\u{1f5}', '\u{1f5}',
+ SC_Lower), ('\u{1f6}', '\u{1f8}', SC_Upper), ('\u{1f9}', '\u{1f9}', SC_Lower), ('\u{1fa}',
+ '\u{1fa}', SC_Upper), ('\u{1fb}', '\u{1fb}', SC_Lower), ('\u{1fc}', '\u{1fc}', SC_Upper),
+ ('\u{1fd}', '\u{1fd}', SC_Lower), ('\u{1fe}', '\u{1fe}', SC_Upper), ('\u{1ff}', '\u{1ff}',
+ SC_Lower), ('\u{200}', '\u{200}', SC_Upper), ('\u{201}', '\u{201}', SC_Lower), ('\u{202}',
+ '\u{202}', SC_Upper), ('\u{203}', '\u{203}', SC_Lower), ('\u{204}', '\u{204}', SC_Upper),
+ ('\u{205}', '\u{205}', SC_Lower), ('\u{206}', '\u{206}', SC_Upper), ('\u{207}', '\u{207}',
+ SC_Lower), ('\u{208}', '\u{208}', SC_Upper), ('\u{209}', '\u{209}', SC_Lower), ('\u{20a}',
+ '\u{20a}', SC_Upper), ('\u{20b}', '\u{20b}', SC_Lower), ('\u{20c}', '\u{20c}', SC_Upper),
+ ('\u{20d}', '\u{20d}', SC_Lower), ('\u{20e}', '\u{20e}', SC_Upper), ('\u{20f}', '\u{20f}',
+ SC_Lower), ('\u{210}', '\u{210}', SC_Upper), ('\u{211}', '\u{211}', SC_Lower), ('\u{212}',
+ '\u{212}', SC_Upper), ('\u{213}', '\u{213}', SC_Lower), ('\u{214}', '\u{214}', SC_Upper),
+ ('\u{215}', '\u{215}', SC_Lower), ('\u{216}', '\u{216}', SC_Upper), ('\u{217}', '\u{217}',
+ SC_Lower), ('\u{218}', '\u{218}', SC_Upper), ('\u{219}', '\u{219}', SC_Lower), ('\u{21a}',
+ '\u{21a}', SC_Upper), ('\u{21b}', '\u{21b}', SC_Lower), ('\u{21c}', '\u{21c}', SC_Upper),
+ ('\u{21d}', '\u{21d}', SC_Lower), ('\u{21e}', '\u{21e}', SC_Upper), ('\u{21f}', '\u{21f}',
+ SC_Lower), ('\u{220}', '\u{220}', SC_Upper), ('\u{221}', '\u{221}', SC_Lower), ('\u{222}',
+ '\u{222}', SC_Upper), ('\u{223}', '\u{223}', SC_Lower), ('\u{224}', '\u{224}', SC_Upper),
+ ('\u{225}', '\u{225}', SC_Lower), ('\u{226}', '\u{226}', SC_Upper), ('\u{227}', '\u{227}',
+ SC_Lower), ('\u{228}', '\u{228}', SC_Upper), ('\u{229}', '\u{229}', SC_Lower), ('\u{22a}',
+ '\u{22a}', SC_Upper), ('\u{22b}', '\u{22b}', SC_Lower), ('\u{22c}', '\u{22c}', SC_Upper),
+ ('\u{22d}', '\u{22d}', SC_Lower), ('\u{22e}', '\u{22e}', SC_Upper), ('\u{22f}', '\u{22f}',
+ SC_Lower), ('\u{230}', '\u{230}', SC_Upper), ('\u{231}', '\u{231}', SC_Lower), ('\u{232}',
+ '\u{232}', SC_Upper), ('\u{233}', '\u{239}', SC_Lower), ('\u{23a}', '\u{23b}', SC_Upper),
+ ('\u{23c}', '\u{23c}', SC_Lower), ('\u{23d}', '\u{23e}', SC_Upper), ('\u{23f}', '\u{240}',
+ SC_Lower), ('\u{241}', '\u{241}', SC_Upper), ('\u{242}', '\u{242}', SC_Lower), ('\u{243}',
+ '\u{246}', SC_Upper), ('\u{247}', '\u{247}', SC_Lower), ('\u{248}', '\u{248}', SC_Upper),
+ ('\u{249}', '\u{249}', SC_Lower), ('\u{24a}', '\u{24a}', SC_Upper), ('\u{24b}', '\u{24b}',
+ SC_Lower), ('\u{24c}', '\u{24c}', SC_Upper), ('\u{24d}', '\u{24d}', SC_Lower), ('\u{24e}',
+ '\u{24e}', SC_Upper), ('\u{24f}', '\u{293}', SC_Lower), ('\u{294}', '\u{294}', SC_OLetter),
+ ('\u{295}', '\u{2b8}', SC_Lower), ('\u{2b9}', '\u{2bf}', SC_OLetter), ('\u{2c0}', '\u{2c1}',
+ SC_Lower), ('\u{2c6}', '\u{2d1}', SC_OLetter), ('\u{2e0}', '\u{2e4}', SC_Lower), ('\u{2ec}',
+ '\u{2ec}', SC_OLetter), ('\u{2ee}', '\u{2ee}', SC_OLetter), ('\u{300}', '\u{36f}',
+ SC_Extend), ('\u{370}', '\u{370}', SC_Upper), ('\u{371}', '\u{371}', SC_Lower), ('\u{372}',
+ '\u{372}', SC_Upper), ('\u{373}', '\u{373}', SC_Lower), ('\u{374}', '\u{374}', SC_OLetter),
+ ('\u{376}', '\u{376}', SC_Upper), ('\u{377}', '\u{377}', SC_Lower), ('\u{37a}', '\u{37d}',
+ SC_Lower), ('\u{37f}', '\u{37f}', SC_Upper), ('\u{386}', '\u{386}', SC_Upper), ('\u{388}',
+ '\u{38a}', SC_Upper), ('\u{38c}', '\u{38c}', SC_Upper), ('\u{38e}', '\u{38f}', SC_Upper),
+ ('\u{390}', '\u{390}', SC_Lower), ('\u{391}', '\u{3a1}', SC_Upper), ('\u{3a3}', '\u{3ab}',
+ SC_Upper), ('\u{3ac}', '\u{3ce}', SC_Lower), ('\u{3cf}', '\u{3cf}', SC_Upper), ('\u{3d0}',
+ '\u{3d1}', SC_Lower), ('\u{3d2}', '\u{3d4}', SC_Upper), ('\u{3d5}', '\u{3d7}', SC_Lower),
+ ('\u{3d8}', '\u{3d8}', SC_Upper), ('\u{3d9}', '\u{3d9}', SC_Lower), ('\u{3da}', '\u{3da}',
+ SC_Upper), ('\u{3db}', '\u{3db}', SC_Lower), ('\u{3dc}', '\u{3dc}', SC_Upper), ('\u{3dd}',
+ '\u{3dd}', SC_Lower), ('\u{3de}', '\u{3de}', SC_Upper), ('\u{3df}', '\u{3df}', SC_Lower),
+ ('\u{3e0}', '\u{3e0}', SC_Upper), ('\u{3e1}', '\u{3e1}', SC_Lower), ('\u{3e2}', '\u{3e2}',
+ SC_Upper), ('\u{3e3}', '\u{3e3}', SC_Lower), ('\u{3e4}', '\u{3e4}', SC_Upper), ('\u{3e5}',
+ '\u{3e5}', SC_Lower), ('\u{3e6}', '\u{3e6}', SC_Upper), ('\u{3e7}', '\u{3e7}', SC_Lower),
+ ('\u{3e8}', '\u{3e8}', SC_Upper), ('\u{3e9}', '\u{3e9}', SC_Lower), ('\u{3ea}', '\u{3ea}',
+ SC_Upper), ('\u{3eb}', '\u{3eb}', SC_Lower), ('\u{3ec}', '\u{3ec}', SC_Upper), ('\u{3ed}',
+ '\u{3ed}', SC_Lower), ('\u{3ee}', '\u{3ee}', SC_Upper), ('\u{3ef}', '\u{3f3}', SC_Lower),
+ ('\u{3f4}', '\u{3f4}', SC_Upper), ('\u{3f5}', '\u{3f5}', SC_Lower), ('\u{3f7}', '\u{3f7}',
+ SC_Upper), ('\u{3f8}', '\u{3f8}', SC_Lower), ('\u{3f9}', '\u{3fa}', SC_Upper), ('\u{3fb}',
+ '\u{3fc}', SC_Lower), ('\u{3fd}', '\u{42f}', SC_Upper), ('\u{430}', '\u{45f}', SC_Lower),
+ ('\u{460}', '\u{460}', SC_Upper), ('\u{461}', '\u{461}', SC_Lower), ('\u{462}', '\u{462}',
+ SC_Upper), ('\u{463}', '\u{463}', SC_Lower), ('\u{464}', '\u{464}', SC_Upper), ('\u{465}',
+ '\u{465}', SC_Lower), ('\u{466}', '\u{466}', SC_Upper), ('\u{467}', '\u{467}', SC_Lower),
+ ('\u{468}', '\u{468}', SC_Upper), ('\u{469}', '\u{469}', SC_Lower), ('\u{46a}', '\u{46a}',
+ SC_Upper), ('\u{46b}', '\u{46b}', SC_Lower), ('\u{46c}', '\u{46c}', SC_Upper), ('\u{46d}',
+ '\u{46d}', SC_Lower), ('\u{46e}', '\u{46e}', SC_Upper), ('\u{46f}', '\u{46f}', SC_Lower),
+ ('\u{470}', '\u{470}', SC_Upper), ('\u{471}', '\u{471}', SC_Lower), ('\u{472}', '\u{472}',
+ SC_Upper), ('\u{473}', '\u{473}', SC_Lower), ('\u{474}', '\u{474}', SC_Upper), ('\u{475}',
+ '\u{475}', SC_Lower), ('\u{476}', '\u{476}', SC_Upper), ('\u{477}', '\u{477}', SC_Lower),
+ ('\u{478}', '\u{478}', SC_Upper), ('\u{479}', '\u{479}', SC_Lower), ('\u{47a}', '\u{47a}',
+ SC_Upper), ('\u{47b}', '\u{47b}', SC_Lower), ('\u{47c}', '\u{47c}', SC_Upper), ('\u{47d}',
+ '\u{47d}', SC_Lower), ('\u{47e}', '\u{47e}', SC_Upper), ('\u{47f}', '\u{47f}', SC_Lower),
+ ('\u{480}', '\u{480}', SC_Upper), ('\u{481}', '\u{481}', SC_Lower), ('\u{483}', '\u{489}',
+ SC_Extend), ('\u{48a}', '\u{48a}', SC_Upper), ('\u{48b}', '\u{48b}', SC_Lower), ('\u{48c}',
+ '\u{48c}', SC_Upper), ('\u{48d}', '\u{48d}', SC_Lower), ('\u{48e}', '\u{48e}', SC_Upper),
+ ('\u{48f}', '\u{48f}', SC_Lower), ('\u{490}', '\u{490}', SC_Upper), ('\u{491}', '\u{491}',
+ SC_Lower), ('\u{492}', '\u{492}', SC_Upper), ('\u{493}', '\u{493}', SC_Lower), ('\u{494}',
+ '\u{494}', SC_Upper), ('\u{495}', '\u{495}', SC_Lower), ('\u{496}', '\u{496}', SC_Upper),
+ ('\u{497}', '\u{497}', SC_Lower), ('\u{498}', '\u{498}', SC_Upper), ('\u{499}', '\u{499}',
+ SC_Lower), ('\u{49a}', '\u{49a}', SC_Upper), ('\u{49b}', '\u{49b}', SC_Lower), ('\u{49c}',
+ '\u{49c}', SC_Upper), ('\u{49d}', '\u{49d}', SC_Lower), ('\u{49e}', '\u{49e}', SC_Upper),
+ ('\u{49f}', '\u{49f}', SC_Lower), ('\u{4a0}', '\u{4a0}', SC_Upper), ('\u{4a1}', '\u{4a1}',
+ SC_Lower), ('\u{4a2}', '\u{4a2}', SC_Upper), ('\u{4a3}', '\u{4a3}', SC_Lower), ('\u{4a4}',
+ '\u{4a4}', SC_Upper), ('\u{4a5}', '\u{4a5}', SC_Lower), ('\u{4a6}', '\u{4a6}', SC_Upper),
+ ('\u{4a7}', '\u{4a7}', SC_Lower), ('\u{4a8}', '\u{4a8}', SC_Upper), ('\u{4a9}', '\u{4a9}',
+ SC_Lower), ('\u{4aa}', '\u{4aa}', SC_Upper), ('\u{4ab}', '\u{4ab}', SC_Lower), ('\u{4ac}',
+ '\u{4ac}', SC_Upper), ('\u{4ad}', '\u{4ad}', SC_Lower), ('\u{4ae}', '\u{4ae}', SC_Upper),
+ ('\u{4af}', '\u{4af}', SC_Lower), ('\u{4b0}', '\u{4b0}', SC_Upper), ('\u{4b1}', '\u{4b1}',
+ SC_Lower), ('\u{4b2}', '\u{4b2}', SC_Upper), ('\u{4b3}', '\u{4b3}', SC_Lower), ('\u{4b4}',
+ '\u{4b4}', SC_Upper), ('\u{4b5}', '\u{4b5}', SC_Lower), ('\u{4b6}', '\u{4b6}', SC_Upper),
+ ('\u{4b7}', '\u{4b7}', SC_Lower), ('\u{4b8}', '\u{4b8}', SC_Upper), ('\u{4b9}', '\u{4b9}',
+ SC_Lower), ('\u{4ba}', '\u{4ba}', SC_Upper), ('\u{4bb}', '\u{4bb}', SC_Lower), ('\u{4bc}',
+ '\u{4bc}', SC_Upper), ('\u{4bd}', '\u{4bd}', SC_Lower), ('\u{4be}', '\u{4be}', SC_Upper),
+ ('\u{4bf}', '\u{4bf}', SC_Lower), ('\u{4c0}', '\u{4c1}', SC_Upper), ('\u{4c2}', '\u{4c2}',
+ SC_Lower), ('\u{4c3}', '\u{4c3}', SC_Upper), ('\u{4c4}', '\u{4c4}', SC_Lower), ('\u{4c5}',
+ '\u{4c5}', SC_Upper), ('\u{4c6}', '\u{4c6}', SC_Lower), ('\u{4c7}', '\u{4c7}', SC_Upper),
+ ('\u{4c8}', '\u{4c8}', SC_Lower), ('\u{4c9}', '\u{4c9}', SC_Upper), ('\u{4ca}', '\u{4ca}',
+ SC_Lower), ('\u{4cb}', '\u{4cb}', SC_Upper), ('\u{4cc}', '\u{4cc}', SC_Lower), ('\u{4cd}',
+ '\u{4cd}', SC_Upper), ('\u{4ce}', '\u{4cf}', SC_Lower), ('\u{4d0}', '\u{4d0}', SC_Upper),
+ ('\u{4d1}', '\u{4d1}', SC_Lower), ('\u{4d2}', '\u{4d2}', SC_Upper), ('\u{4d3}', '\u{4d3}',
+ SC_Lower), ('\u{4d4}', '\u{4d4}', SC_Upper), ('\u{4d5}', '\u{4d5}', SC_Lower), ('\u{4d6}',
+ '\u{4d6}', SC_Upper), ('\u{4d7}', '\u{4d7}', SC_Lower), ('\u{4d8}', '\u{4d8}', SC_Upper),
+ ('\u{4d9}', '\u{4d9}', SC_Lower), ('\u{4da}', '\u{4da}', SC_Upper), ('\u{4db}', '\u{4db}',
+ SC_Lower), ('\u{4dc}', '\u{4dc}', SC_Upper), ('\u{4dd}', '\u{4dd}', SC_Lower), ('\u{4de}',
+ '\u{4de}', SC_Upper), ('\u{4df}', '\u{4df}', SC_Lower), ('\u{4e0}', '\u{4e0}', SC_Upper),
+ ('\u{4e1}', '\u{4e1}', SC_Lower), ('\u{4e2}', '\u{4e2}', SC_Upper), ('\u{4e3}', '\u{4e3}',
+ SC_Lower), ('\u{4e4}', '\u{4e4}', SC_Upper), ('\u{4e5}', '\u{4e5}', SC_Lower), ('\u{4e6}',
+ '\u{4e6}', SC_Upper), ('\u{4e7}', '\u{4e7}', SC_Lower), ('\u{4e8}', '\u{4e8}', SC_Upper),
+ ('\u{4e9}', '\u{4e9}', SC_Lower), ('\u{4ea}', '\u{4ea}', SC_Upper), ('\u{4eb}', '\u{4eb}',
+ SC_Lower), ('\u{4ec}', '\u{4ec}', SC_Upper), ('\u{4ed}', '\u{4ed}', SC_Lower), ('\u{4ee}',
+ '\u{4ee}', SC_Upper), ('\u{4ef}', '\u{4ef}', SC_Lower), ('\u{4f0}', '\u{4f0}', SC_Upper),
+ ('\u{4f1}', '\u{4f1}', SC_Lower), ('\u{4f2}', '\u{4f2}', SC_Upper), ('\u{4f3}', '\u{4f3}',
+ SC_Lower), ('\u{4f4}', '\u{4f4}', SC_Upper), ('\u{4f5}', '\u{4f5}', SC_Lower), ('\u{4f6}',
+ '\u{4f6}', SC_Upper), ('\u{4f7}', '\u{4f7}', SC_Lower), ('\u{4f8}', '\u{4f8}', SC_Upper),
+ ('\u{4f9}', '\u{4f9}', SC_Lower), ('\u{4fa}', '\u{4fa}', SC_Upper), ('\u{4fb}', '\u{4fb}',
+ SC_Lower), ('\u{4fc}', '\u{4fc}', SC_Upper), ('\u{4fd}', '\u{4fd}', SC_Lower), ('\u{4fe}',
+ '\u{4fe}', SC_Upper), ('\u{4ff}', '\u{4ff}', SC_Lower), ('\u{500}', '\u{500}', SC_Upper),
+ ('\u{501}', '\u{501}', SC_Lower), ('\u{502}', '\u{502}', SC_Upper), ('\u{503}', '\u{503}',
+ SC_Lower), ('\u{504}', '\u{504}', SC_Upper), ('\u{505}', '\u{505}', SC_Lower), ('\u{506}',
+ '\u{506}', SC_Upper), ('\u{507}', '\u{507}', SC_Lower), ('\u{508}', '\u{508}', SC_Upper),
+ ('\u{509}', '\u{509}', SC_Lower), ('\u{50a}', '\u{50a}', SC_Upper), ('\u{50b}', '\u{50b}',
+ SC_Lower), ('\u{50c}', '\u{50c}', SC_Upper), ('\u{50d}', '\u{50d}', SC_Lower), ('\u{50e}',
+ '\u{50e}', SC_Upper), ('\u{50f}', '\u{50f}', SC_Lower), ('\u{510}', '\u{510}', SC_Upper),
+ ('\u{511}', '\u{511}', SC_Lower), ('\u{512}', '\u{512}', SC_Upper), ('\u{513}', '\u{513}',
+ SC_Lower), ('\u{514}', '\u{514}', SC_Upper), ('\u{515}', '\u{515}', SC_Lower), ('\u{516}',
+ '\u{516}', SC_Upper), ('\u{517}', '\u{517}', SC_Lower), ('\u{518}', '\u{518}', SC_Upper),
+ ('\u{519}', '\u{519}', SC_Lower), ('\u{51a}', '\u{51a}', SC_Upper), ('\u{51b}', '\u{51b}',
+ SC_Lower), ('\u{51c}', '\u{51c}', SC_Upper), ('\u{51d}', '\u{51d}', SC_Lower), ('\u{51e}',
+ '\u{51e}', SC_Upper), ('\u{51f}', '\u{51f}', SC_Lower), ('\u{520}', '\u{520}', SC_Upper),
+ ('\u{521}', '\u{521}', SC_Lower), ('\u{522}', '\u{522}', SC_Upper), ('\u{523}', '\u{523}',
+ SC_Lower), ('\u{524}', '\u{524}', SC_Upper), ('\u{525}', '\u{525}', SC_Lower), ('\u{526}',
+ '\u{526}', SC_Upper), ('\u{527}', '\u{527}', SC_Lower), ('\u{528}', '\u{528}', SC_Upper),
+ ('\u{529}', '\u{529}', SC_Lower), ('\u{52a}', '\u{52a}', SC_Upper), ('\u{52b}', '\u{52b}',
+ SC_Lower), ('\u{52c}', '\u{52c}', SC_Upper), ('\u{52d}', '\u{52d}', SC_Lower), ('\u{52e}',
+ '\u{52e}', SC_Upper), ('\u{52f}', '\u{52f}', SC_Lower), ('\u{531}', '\u{556}', SC_Upper),
+ ('\u{559}', '\u{559}', SC_OLetter), ('\u{55d}', '\u{55d}', SC_SContinue), ('\u{560}',
+ '\u{588}', SC_Lower), ('\u{589}', '\u{589}', SC_STerm), ('\u{591}', '\u{5bd}', SC_Extend),
+ ('\u{5bf}', '\u{5bf}', SC_Extend), ('\u{5c1}', '\u{5c2}', SC_Extend), ('\u{5c4}', '\u{5c5}',
+ SC_Extend), ('\u{5c7}', '\u{5c7}', SC_Extend), ('\u{5d0}', '\u{5ea}', SC_OLetter),
+ ('\u{5ef}', '\u{5f3}', SC_OLetter), ('\u{600}', '\u{605}', SC_Format), ('\u{60c}',
+ '\u{60d}', SC_SContinue), ('\u{610}', '\u{61a}', SC_Extend), ('\u{61c}', '\u{61c}',
+ SC_Format), ('\u{61d}', '\u{61f}', SC_STerm), ('\u{620}', '\u{64a}', SC_OLetter),
+ ('\u{64b}', '\u{65f}', SC_Extend), ('\u{660}', '\u{669}', SC_Numeric), ('\u{66b}',
+ '\u{66c}', SC_Numeric), ('\u{66e}', '\u{66f}', SC_OLetter), ('\u{670}', '\u{670}',
+ SC_Extend), ('\u{671}', '\u{6d3}', SC_OLetter), ('\u{6d4}', '\u{6d4}', SC_STerm),
+ ('\u{6d5}', '\u{6d5}', SC_OLetter), ('\u{6d6}', '\u{6dc}', SC_Extend), ('\u{6dd}',
+ '\u{6dd}', SC_Format), ('\u{6df}', '\u{6e4}', SC_Extend), ('\u{6e5}', '\u{6e6}',
+ SC_OLetter), ('\u{6e7}', '\u{6e8}', SC_Extend), ('\u{6ea}', '\u{6ed}', SC_Extend),
+ ('\u{6ee}', '\u{6ef}', SC_OLetter), ('\u{6f0}', '\u{6f9}', SC_Numeric), ('\u{6fa}',
+ '\u{6fc}', SC_OLetter), ('\u{6ff}', '\u{6ff}', SC_OLetter), ('\u{700}', '\u{702}',
+ SC_STerm), ('\u{70f}', '\u{70f}', SC_Format), ('\u{710}', '\u{710}', SC_OLetter),
+ ('\u{711}', '\u{711}', SC_Extend), ('\u{712}', '\u{72f}', SC_OLetter), ('\u{730}',
+ '\u{74a}', SC_Extend), ('\u{74d}', '\u{7a5}', SC_OLetter), ('\u{7a6}', '\u{7b0}',
+ SC_Extend), ('\u{7b1}', '\u{7b1}', SC_OLetter), ('\u{7c0}', '\u{7c9}', SC_Numeric),
+ ('\u{7ca}', '\u{7ea}', SC_OLetter), ('\u{7eb}', '\u{7f3}', SC_Extend), ('\u{7f4}',
+ '\u{7f5}', SC_OLetter), ('\u{7f8}', '\u{7f8}', SC_SContinue), ('\u{7f9}', '\u{7f9}',
+ SC_STerm), ('\u{7fa}', '\u{7fa}', SC_OLetter), ('\u{7fd}', '\u{7fd}', SC_Extend),
+ ('\u{800}', '\u{815}', SC_OLetter), ('\u{816}', '\u{819}', SC_Extend), ('\u{81a}',
+ '\u{81a}', SC_OLetter), ('\u{81b}', '\u{823}', SC_Extend), ('\u{824}', '\u{824}',
+ SC_OLetter), ('\u{825}', '\u{827}', SC_Extend), ('\u{828}', '\u{828}', SC_OLetter),
+ ('\u{829}', '\u{82d}', SC_Extend), ('\u{837}', '\u{837}', SC_STerm), ('\u{839}', '\u{839}',
+ SC_STerm), ('\u{83d}', '\u{83e}', SC_STerm), ('\u{840}', '\u{858}', SC_OLetter), ('\u{859}',
+ '\u{85b}', SC_Extend), ('\u{860}', '\u{86a}', SC_OLetter), ('\u{870}', '\u{887}',
+ SC_OLetter), ('\u{889}', '\u{88e}', SC_OLetter), ('\u{890}', '\u{891}', SC_Format),
+ ('\u{898}', '\u{89f}', SC_Extend), ('\u{8a0}', '\u{8c9}', SC_OLetter), ('\u{8ca}',
+ '\u{8e1}', SC_Extend), ('\u{8e2}', '\u{8e2}', SC_Format), ('\u{8e3}', '\u{903}', SC_Extend),
+ ('\u{904}', '\u{939}', SC_OLetter), ('\u{93a}', '\u{93c}', SC_Extend), ('\u{93d}',
+ '\u{93d}', SC_OLetter), ('\u{93e}', '\u{94f}', SC_Extend), ('\u{950}', '\u{950}',
+ SC_OLetter), ('\u{951}', '\u{957}', SC_Extend), ('\u{958}', '\u{961}', SC_OLetter),
+ ('\u{962}', '\u{963}', SC_Extend), ('\u{964}', '\u{965}', SC_STerm), ('\u{966}', '\u{96f}',
+ SC_Numeric), ('\u{971}', '\u{980}', SC_OLetter), ('\u{981}', '\u{983}', SC_Extend),
+ ('\u{985}', '\u{98c}', SC_OLetter), ('\u{98f}', '\u{990}', SC_OLetter), ('\u{993}',
+ '\u{9a8}', SC_OLetter), ('\u{9aa}', '\u{9b0}', SC_OLetter), ('\u{9b2}', '\u{9b2}',
+ SC_OLetter), ('\u{9b6}', '\u{9b9}', SC_OLetter), ('\u{9bc}', '\u{9bc}', SC_Extend),
+ ('\u{9bd}', '\u{9bd}', SC_OLetter), ('\u{9be}', '\u{9c4}', SC_Extend), ('\u{9c7}',
+ '\u{9c8}', SC_Extend), ('\u{9cb}', '\u{9cd}', SC_Extend), ('\u{9ce}', '\u{9ce}',
+ SC_OLetter), ('\u{9d7}', '\u{9d7}', SC_Extend), ('\u{9dc}', '\u{9dd}', SC_OLetter),
+ ('\u{9df}', '\u{9e1}', SC_OLetter), ('\u{9e2}', '\u{9e3}', SC_Extend), ('\u{9e6}',
+ '\u{9ef}', SC_Numeric), ('\u{9f0}', '\u{9f1}', SC_OLetter), ('\u{9fc}', '\u{9fc}',
+ SC_OLetter), ('\u{9fe}', '\u{9fe}', SC_Extend), ('\u{a01}', '\u{a03}', SC_Extend),
+ ('\u{a05}', '\u{a0a}', SC_OLetter), ('\u{a0f}', '\u{a10}', SC_OLetter), ('\u{a13}',
+ '\u{a28}', SC_OLetter), ('\u{a2a}', '\u{a30}', SC_OLetter), ('\u{a32}', '\u{a33}',
+ SC_OLetter), ('\u{a35}', '\u{a36}', SC_OLetter), ('\u{a38}', '\u{a39}', SC_OLetter),
+ ('\u{a3c}', '\u{a3c}', SC_Extend), ('\u{a3e}', '\u{a42}', SC_Extend), ('\u{a47}', '\u{a48}',
+ SC_Extend), ('\u{a4b}', '\u{a4d}', SC_Extend), ('\u{a51}', '\u{a51}', SC_Extend),
+ ('\u{a59}', '\u{a5c}', SC_OLetter), ('\u{a5e}', '\u{a5e}', SC_OLetter), ('\u{a66}',
+ '\u{a6f}', SC_Numeric), ('\u{a70}', '\u{a71}', SC_Extend), ('\u{a72}', '\u{a74}',
+ SC_OLetter), ('\u{a75}', '\u{a75}', SC_Extend), ('\u{a81}', '\u{a83}', SC_Extend),
+ ('\u{a85}', '\u{a8d}', SC_OLetter), ('\u{a8f}', '\u{a91}', SC_OLetter), ('\u{a93}',
+ '\u{aa8}', SC_OLetter), ('\u{aaa}', '\u{ab0}', SC_OLetter), ('\u{ab2}', '\u{ab3}',
+ SC_OLetter), ('\u{ab5}', '\u{ab9}', SC_OLetter), ('\u{abc}', '\u{abc}', SC_Extend),
+ ('\u{abd}', '\u{abd}', SC_OLetter), ('\u{abe}', '\u{ac5}', SC_Extend), ('\u{ac7}',
+ '\u{ac9}', SC_Extend), ('\u{acb}', '\u{acd}', SC_Extend), ('\u{ad0}', '\u{ad0}',
+ SC_OLetter), ('\u{ae0}', '\u{ae1}', SC_OLetter), ('\u{ae2}', '\u{ae3}', SC_Extend),
+ ('\u{ae6}', '\u{aef}', SC_Numeric), ('\u{af9}', '\u{af9}', SC_OLetter), ('\u{afa}',
+ '\u{aff}', SC_Extend), ('\u{b01}', '\u{b03}', SC_Extend), ('\u{b05}', '\u{b0c}',
+ SC_OLetter), ('\u{b0f}', '\u{b10}', SC_OLetter), ('\u{b13}', '\u{b28}', SC_OLetter),
+ ('\u{b2a}', '\u{b30}', SC_OLetter), ('\u{b32}', '\u{b33}', SC_OLetter), ('\u{b35}',
+ '\u{b39}', SC_OLetter), ('\u{b3c}', '\u{b3c}', SC_Extend), ('\u{b3d}', '\u{b3d}',
+ SC_OLetter), ('\u{b3e}', '\u{b44}', SC_Extend), ('\u{b47}', '\u{b48}', SC_Extend),
+ ('\u{b4b}', '\u{b4d}', SC_Extend), ('\u{b55}', '\u{b57}', SC_Extend), ('\u{b5c}', '\u{b5d}',
+ SC_OLetter), ('\u{b5f}', '\u{b61}', SC_OLetter), ('\u{b62}', '\u{b63}', SC_Extend),
+ ('\u{b66}', '\u{b6f}', SC_Numeric), ('\u{b71}', '\u{b71}', SC_OLetter), ('\u{b82}',
+ '\u{b82}', SC_Extend), ('\u{b83}', '\u{b83}', SC_OLetter), ('\u{b85}', '\u{b8a}',
+ SC_OLetter), ('\u{b8e}', '\u{b90}', SC_OLetter), ('\u{b92}', '\u{b95}', SC_OLetter),
+ ('\u{b99}', '\u{b9a}', SC_OLetter), ('\u{b9c}', '\u{b9c}', SC_OLetter), ('\u{b9e}',
+ '\u{b9f}', SC_OLetter), ('\u{ba3}', '\u{ba4}', SC_OLetter), ('\u{ba8}', '\u{baa}',
+ SC_OLetter), ('\u{bae}', '\u{bb9}', SC_OLetter), ('\u{bbe}', '\u{bc2}', SC_Extend),
+ ('\u{bc6}', '\u{bc8}', SC_Extend), ('\u{bca}', '\u{bcd}', SC_Extend), ('\u{bd0}', '\u{bd0}',
+ SC_OLetter), ('\u{bd7}', '\u{bd7}', SC_Extend), ('\u{be6}', '\u{bef}', SC_Numeric),
+ ('\u{c00}', '\u{c04}', SC_Extend), ('\u{c05}', '\u{c0c}', SC_OLetter), ('\u{c0e}',
+ '\u{c10}', SC_OLetter), ('\u{c12}', '\u{c28}', SC_OLetter), ('\u{c2a}', '\u{c39}',
+ SC_OLetter), ('\u{c3c}', '\u{c3c}', SC_Extend), ('\u{c3d}', '\u{c3d}', SC_OLetter),
+ ('\u{c3e}', '\u{c44}', SC_Extend), ('\u{c46}', '\u{c48}', SC_Extend), ('\u{c4a}', '\u{c4d}',
+ SC_Extend), ('\u{c55}', '\u{c56}', SC_Extend), ('\u{c58}', '\u{c5a}', SC_OLetter),
+ ('\u{c5d}', '\u{c5d}', SC_OLetter), ('\u{c60}', '\u{c61}', SC_OLetter), ('\u{c62}',
+ '\u{c63}', SC_Extend), ('\u{c66}', '\u{c6f}', SC_Numeric), ('\u{c80}', '\u{c80}',
+ SC_OLetter), ('\u{c81}', '\u{c83}', SC_Extend), ('\u{c85}', '\u{c8c}', SC_OLetter),
+ ('\u{c8e}', '\u{c90}', SC_OLetter), ('\u{c92}', '\u{ca8}', SC_OLetter), ('\u{caa}',
+ '\u{cb3}', SC_OLetter), ('\u{cb5}', '\u{cb9}', SC_OLetter), ('\u{cbc}', '\u{cbc}',
+ SC_Extend), ('\u{cbd}', '\u{cbd}', SC_OLetter), ('\u{cbe}', '\u{cc4}', SC_Extend),
+ ('\u{cc6}', '\u{cc8}', SC_Extend), ('\u{cca}', '\u{ccd}', SC_Extend), ('\u{cd5}', '\u{cd6}',
+ SC_Extend), ('\u{cdd}', '\u{cde}', SC_OLetter), ('\u{ce0}', '\u{ce1}', SC_OLetter),
+ ('\u{ce2}', '\u{ce3}', SC_Extend), ('\u{ce6}', '\u{cef}', SC_Numeric), ('\u{cf1}',
+ '\u{cf2}', SC_OLetter), ('\u{cf3}', '\u{cf3}', SC_Extend), ('\u{d00}', '\u{d03}',
+ SC_Extend), ('\u{d04}', '\u{d0c}', SC_OLetter), ('\u{d0e}', '\u{d10}', SC_OLetter),
+ ('\u{d12}', '\u{d3a}', SC_OLetter), ('\u{d3b}', '\u{d3c}', SC_Extend), ('\u{d3d}',
+ '\u{d3d}', SC_OLetter), ('\u{d3e}', '\u{d44}', SC_Extend), ('\u{d46}', '\u{d48}',
+ SC_Extend), ('\u{d4a}', '\u{d4d}', SC_Extend), ('\u{d4e}', '\u{d4e}', SC_OLetter),
+ ('\u{d54}', '\u{d56}', SC_OLetter), ('\u{d57}', '\u{d57}', SC_Extend), ('\u{d5f}',
+ '\u{d61}', SC_OLetter), ('\u{d62}', '\u{d63}', SC_Extend), ('\u{d66}', '\u{d6f}',
+ SC_Numeric), ('\u{d7a}', '\u{d7f}', SC_OLetter), ('\u{d81}', '\u{d83}', SC_Extend),
+ ('\u{d85}', '\u{d96}', SC_OLetter), ('\u{d9a}', '\u{db1}', SC_OLetter), ('\u{db3}',
+ '\u{dbb}', SC_OLetter), ('\u{dbd}', '\u{dbd}', SC_OLetter), ('\u{dc0}', '\u{dc6}',
+ SC_OLetter), ('\u{dca}', '\u{dca}', SC_Extend), ('\u{dcf}', '\u{dd4}', SC_Extend),
+ ('\u{dd6}', '\u{dd6}', SC_Extend), ('\u{dd8}', '\u{ddf}', SC_Extend), ('\u{de6}', '\u{def}',
+ SC_Numeric), ('\u{df2}', '\u{df3}', SC_Extend), ('\u{e01}', '\u{e30}', SC_OLetter),
+ ('\u{e31}', '\u{e31}', SC_Extend), ('\u{e32}', '\u{e33}', SC_OLetter), ('\u{e34}',
+ '\u{e3a}', SC_Extend), ('\u{e40}', '\u{e46}', SC_OLetter), ('\u{e47}', '\u{e4e}',
+ SC_Extend), ('\u{e50}', '\u{e59}', SC_Numeric), ('\u{e81}', '\u{e82}', SC_OLetter),
+ ('\u{e84}', '\u{e84}', SC_OLetter), ('\u{e86}', '\u{e8a}', SC_OLetter), ('\u{e8c}',
+ '\u{ea3}', SC_OLetter), ('\u{ea5}', '\u{ea5}', SC_OLetter), ('\u{ea7}', '\u{eb0}',
+ SC_OLetter), ('\u{eb1}', '\u{eb1}', SC_Extend), ('\u{eb2}', '\u{eb3}', SC_OLetter),
+ ('\u{eb4}', '\u{ebc}', SC_Extend), ('\u{ebd}', '\u{ebd}', SC_OLetter), ('\u{ec0}',
+ '\u{ec4}', SC_OLetter), ('\u{ec6}', '\u{ec6}', SC_OLetter), ('\u{ec8}', '\u{ece}',
+ SC_Extend), ('\u{ed0}', '\u{ed9}', SC_Numeric), ('\u{edc}', '\u{edf}', SC_OLetter),
+ ('\u{f00}', '\u{f00}', SC_OLetter), ('\u{f18}', '\u{f19}', SC_Extend), ('\u{f20}',
+ '\u{f29}', SC_Numeric), ('\u{f35}', '\u{f35}', SC_Extend), ('\u{f37}', '\u{f37}',
+ SC_Extend), ('\u{f39}', '\u{f39}', SC_Extend), ('\u{f3a}', '\u{f3d}', SC_Close), ('\u{f3e}',
+ '\u{f3f}', SC_Extend), ('\u{f40}', '\u{f47}', SC_OLetter), ('\u{f49}', '\u{f6c}',
+ SC_OLetter), ('\u{f71}', '\u{f84}', SC_Extend), ('\u{f86}', '\u{f87}', SC_Extend),
+ ('\u{f88}', '\u{f8c}', SC_OLetter), ('\u{f8d}', '\u{f97}', SC_Extend), ('\u{f99}',
+ '\u{fbc}', SC_Extend), ('\u{fc6}', '\u{fc6}', SC_Extend), ('\u{1000}', '\u{102a}',
+ SC_OLetter), ('\u{102b}', '\u{103e}', SC_Extend), ('\u{103f}', '\u{103f}', SC_OLetter),
+ ('\u{1040}', '\u{1049}', SC_Numeric), ('\u{104a}', '\u{104b}', SC_STerm), ('\u{1050}',
+ '\u{1055}', SC_OLetter), ('\u{1056}', '\u{1059}', SC_Extend), ('\u{105a}', '\u{105d}',
+ SC_OLetter), ('\u{105e}', '\u{1060}', SC_Extend), ('\u{1061}', '\u{1061}', SC_OLetter),
+ ('\u{1062}', '\u{1064}', SC_Extend), ('\u{1065}', '\u{1066}', SC_OLetter), ('\u{1067}',
+ '\u{106d}', SC_Extend), ('\u{106e}', '\u{1070}', SC_OLetter), ('\u{1071}', '\u{1074}',
+ SC_Extend), ('\u{1075}', '\u{1081}', SC_OLetter), ('\u{1082}', '\u{108d}', SC_Extend),
+ ('\u{108e}', '\u{108e}', SC_OLetter), ('\u{108f}', '\u{108f}', SC_Extend), ('\u{1090}',
+ '\u{1099}', SC_Numeric), ('\u{109a}', '\u{109d}', SC_Extend), ('\u{10a0}', '\u{10c5}',
+ SC_Upper), ('\u{10c7}', '\u{10c7}', SC_Upper), ('\u{10cd}', '\u{10cd}', SC_Upper),
+ ('\u{10d0}', '\u{10fa}', SC_OLetter), ('\u{10fc}', '\u{10fc}', SC_Lower), ('\u{10fd}',
+ '\u{1248}', SC_OLetter), ('\u{124a}', '\u{124d}', SC_OLetter), ('\u{1250}', '\u{1256}',
+ SC_OLetter), ('\u{1258}', '\u{1258}', SC_OLetter), ('\u{125a}', '\u{125d}', SC_OLetter),
+ ('\u{1260}', '\u{1288}', SC_OLetter), ('\u{128a}', '\u{128d}', SC_OLetter), ('\u{1290}',
+ '\u{12b0}', SC_OLetter), ('\u{12b2}', '\u{12b5}', SC_OLetter), ('\u{12b8}', '\u{12be}',
+ SC_OLetter), ('\u{12c0}', '\u{12c0}', SC_OLetter), ('\u{12c2}', '\u{12c5}', SC_OLetter),
+ ('\u{12c8}', '\u{12d6}', SC_OLetter), ('\u{12d8}', '\u{1310}', SC_OLetter), ('\u{1312}',
+ '\u{1315}', SC_OLetter), ('\u{1318}', '\u{135a}', SC_OLetter), ('\u{135d}', '\u{135f}',
+ SC_Extend), ('\u{1362}', '\u{1362}', SC_STerm), ('\u{1367}', '\u{1368}', SC_STerm),
+ ('\u{1380}', '\u{138f}', SC_OLetter), ('\u{13a0}', '\u{13f5}', SC_Upper), ('\u{13f8}',
+ '\u{13fd}', SC_Lower), ('\u{1401}', '\u{166c}', SC_OLetter), ('\u{166e}', '\u{166e}',
+ SC_STerm), ('\u{166f}', '\u{167f}', SC_OLetter), ('\u{1680}', '\u{1680}', SC_Sp),
+ ('\u{1681}', '\u{169a}', SC_OLetter), ('\u{169b}', '\u{169c}', SC_Close), ('\u{16a0}',
+ '\u{16ea}', SC_OLetter), ('\u{16ee}', '\u{16f8}', SC_OLetter), ('\u{1700}', '\u{1711}',
+ SC_OLetter), ('\u{1712}', '\u{1715}', SC_Extend), ('\u{171f}', '\u{1731}', SC_OLetter),
+ ('\u{1732}', '\u{1734}', SC_Extend), ('\u{1735}', '\u{1736}', SC_STerm), ('\u{1740}',
+ '\u{1751}', SC_OLetter), ('\u{1752}', '\u{1753}', SC_Extend), ('\u{1760}', '\u{176c}',
+ SC_OLetter), ('\u{176e}', '\u{1770}', SC_OLetter), ('\u{1772}', '\u{1773}', SC_Extend),
+ ('\u{1780}', '\u{17b3}', SC_OLetter), ('\u{17b4}', '\u{17d3}', SC_Extend), ('\u{17d7}',
+ '\u{17d7}', SC_OLetter), ('\u{17dc}', '\u{17dc}', SC_OLetter), ('\u{17dd}', '\u{17dd}',
+ SC_Extend), ('\u{17e0}', '\u{17e9}', SC_Numeric), ('\u{1802}', '\u{1802}', SC_SContinue),
+ ('\u{1803}', '\u{1803}', SC_STerm), ('\u{1808}', '\u{1808}', SC_SContinue), ('\u{1809}',
+ '\u{1809}', SC_STerm), ('\u{180b}', '\u{180d}', SC_Extend), ('\u{180e}', '\u{180e}',
+ SC_Format), ('\u{180f}', '\u{180f}', SC_Extend), ('\u{1810}', '\u{1819}', SC_Numeric),
+ ('\u{1820}', '\u{1878}', SC_OLetter), ('\u{1880}', '\u{1884}', SC_OLetter), ('\u{1885}',
+ '\u{1886}', SC_Extend), ('\u{1887}', '\u{18a8}', SC_OLetter), ('\u{18a9}', '\u{18a9}',
+ SC_Extend), ('\u{18aa}', '\u{18aa}', SC_OLetter), ('\u{18b0}', '\u{18f5}', SC_OLetter),
+ ('\u{1900}', '\u{191e}', SC_OLetter), ('\u{1920}', '\u{192b}', SC_Extend), ('\u{1930}',
+ '\u{193b}', SC_Extend), ('\u{1944}', '\u{1945}', SC_STerm), ('\u{1946}', '\u{194f}',
+ SC_Numeric), ('\u{1950}', '\u{196d}', SC_OLetter), ('\u{1970}', '\u{1974}', SC_OLetter),
+ ('\u{1980}', '\u{19ab}', SC_OLetter), ('\u{19b0}', '\u{19c9}', SC_OLetter), ('\u{19d0}',
+ '\u{19d9}', SC_Numeric), ('\u{1a00}', '\u{1a16}', SC_OLetter), ('\u{1a17}', '\u{1a1b}',
+ SC_Extend), ('\u{1a20}', '\u{1a54}', SC_OLetter), ('\u{1a55}', '\u{1a5e}', SC_Extend),
+ ('\u{1a60}', '\u{1a7c}', SC_Extend), ('\u{1a7f}', '\u{1a7f}', SC_Extend), ('\u{1a80}',
+ '\u{1a89}', SC_Numeric), ('\u{1a90}', '\u{1a99}', SC_Numeric), ('\u{1aa7}', '\u{1aa7}',
+ SC_OLetter), ('\u{1aa8}', '\u{1aab}', SC_STerm), ('\u{1ab0}', '\u{1ace}', SC_Extend),
+ ('\u{1b00}', '\u{1b04}', SC_Extend), ('\u{1b05}', '\u{1b33}', SC_OLetter), ('\u{1b34}',
+ '\u{1b44}', SC_Extend), ('\u{1b45}', '\u{1b4c}', SC_OLetter), ('\u{1b50}', '\u{1b59}',
+ SC_Numeric), ('\u{1b5a}', '\u{1b5b}', SC_STerm), ('\u{1b5e}', '\u{1b5f}', SC_STerm),
+ ('\u{1b6b}', '\u{1b73}', SC_Extend), ('\u{1b7d}', '\u{1b7e}', SC_STerm), ('\u{1b80}',
+ '\u{1b82}', SC_Extend), ('\u{1b83}', '\u{1ba0}', SC_OLetter), ('\u{1ba1}', '\u{1bad}',
+ SC_Extend), ('\u{1bae}', '\u{1baf}', SC_OLetter), ('\u{1bb0}', '\u{1bb9}', SC_Numeric),
+ ('\u{1bba}', '\u{1be5}', SC_OLetter), ('\u{1be6}', '\u{1bf3}', SC_Extend), ('\u{1c00}',
+ '\u{1c23}', SC_OLetter), ('\u{1c24}', '\u{1c37}', SC_Extend), ('\u{1c3b}', '\u{1c3c}',
+ SC_STerm), ('\u{1c40}', '\u{1c49}', SC_Numeric), ('\u{1c4d}', '\u{1c4f}', SC_OLetter),
+ ('\u{1c50}', '\u{1c59}', SC_Numeric), ('\u{1c5a}', '\u{1c7d}', SC_OLetter), ('\u{1c7e}',
+ '\u{1c7f}', SC_STerm), ('\u{1c80}', '\u{1c88}', SC_Lower), ('\u{1c90}', '\u{1cba}',
+ SC_OLetter), ('\u{1cbd}', '\u{1cbf}', SC_OLetter), ('\u{1cd0}', '\u{1cd2}', SC_Extend),
+ ('\u{1cd4}', '\u{1ce8}', SC_Extend), ('\u{1ce9}', '\u{1cec}', SC_OLetter), ('\u{1ced}',
+ '\u{1ced}', SC_Extend), ('\u{1cee}', '\u{1cf3}', SC_OLetter), ('\u{1cf4}', '\u{1cf4}',
+ SC_Extend), ('\u{1cf5}', '\u{1cf6}', SC_OLetter), ('\u{1cf7}', '\u{1cf9}', SC_Extend),
+ ('\u{1cfa}', '\u{1cfa}', SC_OLetter), ('\u{1d00}', '\u{1dbf}', SC_Lower), ('\u{1dc0}',
+ '\u{1dff}', SC_Extend), ('\u{1e00}', '\u{1e00}', SC_Upper), ('\u{1e01}', '\u{1e01}',
+ SC_Lower), ('\u{1e02}', '\u{1e02}', SC_Upper), ('\u{1e03}', '\u{1e03}', SC_Lower),
+ ('\u{1e04}', '\u{1e04}', SC_Upper), ('\u{1e05}', '\u{1e05}', SC_Lower), ('\u{1e06}',
+ '\u{1e06}', SC_Upper), ('\u{1e07}', '\u{1e07}', SC_Lower), ('\u{1e08}', '\u{1e08}',
+ SC_Upper), ('\u{1e09}', '\u{1e09}', SC_Lower), ('\u{1e0a}', '\u{1e0a}', SC_Upper),
+ ('\u{1e0b}', '\u{1e0b}', SC_Lower), ('\u{1e0c}', '\u{1e0c}', SC_Upper), ('\u{1e0d}',
+ '\u{1e0d}', SC_Lower), ('\u{1e0e}', '\u{1e0e}', SC_Upper), ('\u{1e0f}', '\u{1e0f}',
+ SC_Lower), ('\u{1e10}', '\u{1e10}', SC_Upper), ('\u{1e11}', '\u{1e11}', SC_Lower),
+ ('\u{1e12}', '\u{1e12}', SC_Upper), ('\u{1e13}', '\u{1e13}', SC_Lower), ('\u{1e14}',
+ '\u{1e14}', SC_Upper), ('\u{1e15}', '\u{1e15}', SC_Lower), ('\u{1e16}', '\u{1e16}',
+ SC_Upper), ('\u{1e17}', '\u{1e17}', SC_Lower), ('\u{1e18}', '\u{1e18}', SC_Upper),
+ ('\u{1e19}', '\u{1e19}', SC_Lower), ('\u{1e1a}', '\u{1e1a}', SC_Upper), ('\u{1e1b}',
+ '\u{1e1b}', SC_Lower), ('\u{1e1c}', '\u{1e1c}', SC_Upper), ('\u{1e1d}', '\u{1e1d}',
+ SC_Lower), ('\u{1e1e}', '\u{1e1e}', SC_Upper), ('\u{1e1f}', '\u{1e1f}', SC_Lower),
+ ('\u{1e20}', '\u{1e20}', SC_Upper), ('\u{1e21}', '\u{1e21}', SC_Lower), ('\u{1e22}',
+ '\u{1e22}', SC_Upper), ('\u{1e23}', '\u{1e23}', SC_Lower), ('\u{1e24}', '\u{1e24}',
+ SC_Upper), ('\u{1e25}', '\u{1e25}', SC_Lower), ('\u{1e26}', '\u{1e26}', SC_Upper),
+ ('\u{1e27}', '\u{1e27}', SC_Lower), ('\u{1e28}', '\u{1e28}', SC_Upper), ('\u{1e29}',
+ '\u{1e29}', SC_Lower), ('\u{1e2a}', '\u{1e2a}', SC_Upper), ('\u{1e2b}', '\u{1e2b}',
+ SC_Lower), ('\u{1e2c}', '\u{1e2c}', SC_Upper), ('\u{1e2d}', '\u{1e2d}', SC_Lower),
+ ('\u{1e2e}', '\u{1e2e}', SC_Upper), ('\u{1e2f}', '\u{1e2f}', SC_Lower), ('\u{1e30}',
+ '\u{1e30}', SC_Upper), ('\u{1e31}', '\u{1e31}', SC_Lower), ('\u{1e32}', '\u{1e32}',
+ SC_Upper), ('\u{1e33}', '\u{1e33}', SC_Lower), ('\u{1e34}', '\u{1e34}', SC_Upper),
+ ('\u{1e35}', '\u{1e35}', SC_Lower), ('\u{1e36}', '\u{1e36}', SC_Upper), ('\u{1e37}',
+ '\u{1e37}', SC_Lower), ('\u{1e38}', '\u{1e38}', SC_Upper), ('\u{1e39}', '\u{1e39}',
+ SC_Lower), ('\u{1e3a}', '\u{1e3a}', SC_Upper), ('\u{1e3b}', '\u{1e3b}', SC_Lower),
+ ('\u{1e3c}', '\u{1e3c}', SC_Upper), ('\u{1e3d}', '\u{1e3d}', SC_Lower), ('\u{1e3e}',
+ '\u{1e3e}', SC_Upper), ('\u{1e3f}', '\u{1e3f}', SC_Lower), ('\u{1e40}', '\u{1e40}',
+ SC_Upper), ('\u{1e41}', '\u{1e41}', SC_Lower), ('\u{1e42}', '\u{1e42}', SC_Upper),
+ ('\u{1e43}', '\u{1e43}', SC_Lower), ('\u{1e44}', '\u{1e44}', SC_Upper), ('\u{1e45}',
+ '\u{1e45}', SC_Lower), ('\u{1e46}', '\u{1e46}', SC_Upper), ('\u{1e47}', '\u{1e47}',
+ SC_Lower), ('\u{1e48}', '\u{1e48}', SC_Upper), ('\u{1e49}', '\u{1e49}', SC_Lower),
+ ('\u{1e4a}', '\u{1e4a}', SC_Upper), ('\u{1e4b}', '\u{1e4b}', SC_Lower), ('\u{1e4c}',
+ '\u{1e4c}', SC_Upper), ('\u{1e4d}', '\u{1e4d}', SC_Lower), ('\u{1e4e}', '\u{1e4e}',
+ SC_Upper), ('\u{1e4f}', '\u{1e4f}', SC_Lower), ('\u{1e50}', '\u{1e50}', SC_Upper),
+ ('\u{1e51}', '\u{1e51}', SC_Lower), ('\u{1e52}', '\u{1e52}', SC_Upper), ('\u{1e53}',
+ '\u{1e53}', SC_Lower), ('\u{1e54}', '\u{1e54}', SC_Upper), ('\u{1e55}', '\u{1e55}',
+ SC_Lower), ('\u{1e56}', '\u{1e56}', SC_Upper), ('\u{1e57}', '\u{1e57}', SC_Lower),
+ ('\u{1e58}', '\u{1e58}', SC_Upper), ('\u{1e59}', '\u{1e59}', SC_Lower), ('\u{1e5a}',
+ '\u{1e5a}', SC_Upper), ('\u{1e5b}', '\u{1e5b}', SC_Lower), ('\u{1e5c}', '\u{1e5c}',
+ SC_Upper), ('\u{1e5d}', '\u{1e5d}', SC_Lower), ('\u{1e5e}', '\u{1e5e}', SC_Upper),
+ ('\u{1e5f}', '\u{1e5f}', SC_Lower), ('\u{1e60}', '\u{1e60}', SC_Upper), ('\u{1e61}',
+ '\u{1e61}', SC_Lower), ('\u{1e62}', '\u{1e62}', SC_Upper), ('\u{1e63}', '\u{1e63}',
+ SC_Lower), ('\u{1e64}', '\u{1e64}', SC_Upper), ('\u{1e65}', '\u{1e65}', SC_Lower),
+ ('\u{1e66}', '\u{1e66}', SC_Upper), ('\u{1e67}', '\u{1e67}', SC_Lower), ('\u{1e68}',
+ '\u{1e68}', SC_Upper), ('\u{1e69}', '\u{1e69}', SC_Lower), ('\u{1e6a}', '\u{1e6a}',
+ SC_Upper), ('\u{1e6b}', '\u{1e6b}', SC_Lower), ('\u{1e6c}', '\u{1e6c}', SC_Upper),
+ ('\u{1e6d}', '\u{1e6d}', SC_Lower), ('\u{1e6e}', '\u{1e6e}', SC_Upper), ('\u{1e6f}',
+ '\u{1e6f}', SC_Lower), ('\u{1e70}', '\u{1e70}', SC_Upper), ('\u{1e71}', '\u{1e71}',
+ SC_Lower), ('\u{1e72}', '\u{1e72}', SC_Upper), ('\u{1e73}', '\u{1e73}', SC_Lower),
+ ('\u{1e74}', '\u{1e74}', SC_Upper), ('\u{1e75}', '\u{1e75}', SC_Lower), ('\u{1e76}',
+ '\u{1e76}', SC_Upper), ('\u{1e77}', '\u{1e77}', SC_Lower), ('\u{1e78}', '\u{1e78}',
+ SC_Upper), ('\u{1e79}', '\u{1e79}', SC_Lower), ('\u{1e7a}', '\u{1e7a}', SC_Upper),
+ ('\u{1e7b}', '\u{1e7b}', SC_Lower), ('\u{1e7c}', '\u{1e7c}', SC_Upper), ('\u{1e7d}',
+ '\u{1e7d}', SC_Lower), ('\u{1e7e}', '\u{1e7e}', SC_Upper), ('\u{1e7f}', '\u{1e7f}',
+ SC_Lower), ('\u{1e80}', '\u{1e80}', SC_Upper), ('\u{1e81}', '\u{1e81}', SC_Lower),
+ ('\u{1e82}', '\u{1e82}', SC_Upper), ('\u{1e83}', '\u{1e83}', SC_Lower), ('\u{1e84}',
+ '\u{1e84}', SC_Upper), ('\u{1e85}', '\u{1e85}', SC_Lower), ('\u{1e86}', '\u{1e86}',
+ SC_Upper), ('\u{1e87}', '\u{1e87}', SC_Lower), ('\u{1e88}', '\u{1e88}', SC_Upper),
+ ('\u{1e89}', '\u{1e89}', SC_Lower), ('\u{1e8a}', '\u{1e8a}', SC_Upper), ('\u{1e8b}',
+ '\u{1e8b}', SC_Lower), ('\u{1e8c}', '\u{1e8c}', SC_Upper), ('\u{1e8d}', '\u{1e8d}',
+ SC_Lower), ('\u{1e8e}', '\u{1e8e}', SC_Upper), ('\u{1e8f}', '\u{1e8f}', SC_Lower),
+ ('\u{1e90}', '\u{1e90}', SC_Upper), ('\u{1e91}', '\u{1e91}', SC_Lower), ('\u{1e92}',
+ '\u{1e92}', SC_Upper), ('\u{1e93}', '\u{1e93}', SC_Lower), ('\u{1e94}', '\u{1e94}',
+ SC_Upper), ('\u{1e95}', '\u{1e9d}', SC_Lower), ('\u{1e9e}', '\u{1e9e}', SC_Upper),
+ ('\u{1e9f}', '\u{1e9f}', SC_Lower), ('\u{1ea0}', '\u{1ea0}', SC_Upper), ('\u{1ea1}',
+ '\u{1ea1}', SC_Lower), ('\u{1ea2}', '\u{1ea2}', SC_Upper), ('\u{1ea3}', '\u{1ea3}',
+ SC_Lower), ('\u{1ea4}', '\u{1ea4}', SC_Upper), ('\u{1ea5}', '\u{1ea5}', SC_Lower),
+ ('\u{1ea6}', '\u{1ea6}', SC_Upper), ('\u{1ea7}', '\u{1ea7}', SC_Lower), ('\u{1ea8}',
+ '\u{1ea8}', SC_Upper), ('\u{1ea9}', '\u{1ea9}', SC_Lower), ('\u{1eaa}', '\u{1eaa}',
+ SC_Upper), ('\u{1eab}', '\u{1eab}', SC_Lower), ('\u{1eac}', '\u{1eac}', SC_Upper),
+ ('\u{1ead}', '\u{1ead}', SC_Lower), ('\u{1eae}', '\u{1eae}', SC_Upper), ('\u{1eaf}',
+ '\u{1eaf}', SC_Lower), ('\u{1eb0}', '\u{1eb0}', SC_Upper), ('\u{1eb1}', '\u{1eb1}',
+ SC_Lower), ('\u{1eb2}', '\u{1eb2}', SC_Upper), ('\u{1eb3}', '\u{1eb3}', SC_Lower),
+ ('\u{1eb4}', '\u{1eb4}', SC_Upper), ('\u{1eb5}', '\u{1eb5}', SC_Lower), ('\u{1eb6}',
+ '\u{1eb6}', SC_Upper), ('\u{1eb7}', '\u{1eb7}', SC_Lower), ('\u{1eb8}', '\u{1eb8}',
+ SC_Upper), ('\u{1eb9}', '\u{1eb9}', SC_Lower), ('\u{1eba}', '\u{1eba}', SC_Upper),
+ ('\u{1ebb}', '\u{1ebb}', SC_Lower), ('\u{1ebc}', '\u{1ebc}', SC_Upper), ('\u{1ebd}',
+ '\u{1ebd}', SC_Lower), ('\u{1ebe}', '\u{1ebe}', SC_Upper), ('\u{1ebf}', '\u{1ebf}',
+ SC_Lower), ('\u{1ec0}', '\u{1ec0}', SC_Upper), ('\u{1ec1}', '\u{1ec1}', SC_Lower),
+ ('\u{1ec2}', '\u{1ec2}', SC_Upper), ('\u{1ec3}', '\u{1ec3}', SC_Lower), ('\u{1ec4}',
+ '\u{1ec4}', SC_Upper), ('\u{1ec5}', '\u{1ec5}', SC_Lower), ('\u{1ec6}', '\u{1ec6}',
+ SC_Upper), ('\u{1ec7}', '\u{1ec7}', SC_Lower), ('\u{1ec8}', '\u{1ec8}', SC_Upper),
+ ('\u{1ec9}', '\u{1ec9}', SC_Lower), ('\u{1eca}', '\u{1eca}', SC_Upper), ('\u{1ecb}',
+ '\u{1ecb}', SC_Lower), ('\u{1ecc}', '\u{1ecc}', SC_Upper), ('\u{1ecd}', '\u{1ecd}',
+ SC_Lower), ('\u{1ece}', '\u{1ece}', SC_Upper), ('\u{1ecf}', '\u{1ecf}', SC_Lower),
+ ('\u{1ed0}', '\u{1ed0}', SC_Upper), ('\u{1ed1}', '\u{1ed1}', SC_Lower), ('\u{1ed2}',
+ '\u{1ed2}', SC_Upper), ('\u{1ed3}', '\u{1ed3}', SC_Lower), ('\u{1ed4}', '\u{1ed4}',
+ SC_Upper), ('\u{1ed5}', '\u{1ed5}', SC_Lower), ('\u{1ed6}', '\u{1ed6}', SC_Upper),
+ ('\u{1ed7}', '\u{1ed7}', SC_Lower), ('\u{1ed8}', '\u{1ed8}', SC_Upper), ('\u{1ed9}',
+ '\u{1ed9}', SC_Lower), ('\u{1eda}', '\u{1eda}', SC_Upper), ('\u{1edb}', '\u{1edb}',
+ SC_Lower), ('\u{1edc}', '\u{1edc}', SC_Upper), ('\u{1edd}', '\u{1edd}', SC_Lower),
+ ('\u{1ede}', '\u{1ede}', SC_Upper), ('\u{1edf}', '\u{1edf}', SC_Lower), ('\u{1ee0}',
+ '\u{1ee0}', SC_Upper), ('\u{1ee1}', '\u{1ee1}', SC_Lower), ('\u{1ee2}', '\u{1ee2}',
+ SC_Upper), ('\u{1ee3}', '\u{1ee3}', SC_Lower), ('\u{1ee4}', '\u{1ee4}', SC_Upper),
+ ('\u{1ee5}', '\u{1ee5}', SC_Lower), ('\u{1ee6}', '\u{1ee6}', SC_Upper), ('\u{1ee7}',
+ '\u{1ee7}', SC_Lower), ('\u{1ee8}', '\u{1ee8}', SC_Upper), ('\u{1ee9}', '\u{1ee9}',
+ SC_Lower), ('\u{1eea}', '\u{1eea}', SC_Upper), ('\u{1eeb}', '\u{1eeb}', SC_Lower),
+ ('\u{1eec}', '\u{1eec}', SC_Upper), ('\u{1eed}', '\u{1eed}', SC_Lower), ('\u{1eee}',
+ '\u{1eee}', SC_Upper), ('\u{1eef}', '\u{1eef}', SC_Lower), ('\u{1ef0}', '\u{1ef0}',
+ SC_Upper), ('\u{1ef1}', '\u{1ef1}', SC_Lower), ('\u{1ef2}', '\u{1ef2}', SC_Upper),
+ ('\u{1ef3}', '\u{1ef3}', SC_Lower), ('\u{1ef4}', '\u{1ef4}', SC_Upper), ('\u{1ef5}',
+ '\u{1ef5}', SC_Lower), ('\u{1ef6}', '\u{1ef6}', SC_Upper), ('\u{1ef7}', '\u{1ef7}',
+ SC_Lower), ('\u{1ef8}', '\u{1ef8}', SC_Upper), ('\u{1ef9}', '\u{1ef9}', SC_Lower),
+ ('\u{1efa}', '\u{1efa}', SC_Upper), ('\u{1efb}', '\u{1efb}', SC_Lower), ('\u{1efc}',
+ '\u{1efc}', SC_Upper), ('\u{1efd}', '\u{1efd}', SC_Lower), ('\u{1efe}', '\u{1efe}',
+ SC_Upper), ('\u{1eff}', '\u{1f07}', SC_Lower), ('\u{1f08}', '\u{1f0f}', SC_Upper),
+ ('\u{1f10}', '\u{1f15}', SC_Lower), ('\u{1f18}', '\u{1f1d}', SC_Upper), ('\u{1f20}',
+ '\u{1f27}', SC_Lower), ('\u{1f28}', '\u{1f2f}', SC_Upper), ('\u{1f30}', '\u{1f37}',
+ SC_Lower), ('\u{1f38}', '\u{1f3f}', SC_Upper), ('\u{1f40}', '\u{1f45}', SC_Lower),
+ ('\u{1f48}', '\u{1f4d}', SC_Upper), ('\u{1f50}', '\u{1f57}', SC_Lower), ('\u{1f59}',
+ '\u{1f59}', SC_Upper), ('\u{1f5b}', '\u{1f5b}', SC_Upper), ('\u{1f5d}', '\u{1f5d}',
+ SC_Upper), ('\u{1f5f}', '\u{1f5f}', SC_Upper), ('\u{1f60}', '\u{1f67}', SC_Lower),
+ ('\u{1f68}', '\u{1f6f}', SC_Upper), ('\u{1f70}', '\u{1f7d}', SC_Lower), ('\u{1f80}',
+ '\u{1f87}', SC_Lower), ('\u{1f88}', '\u{1f8f}', SC_Upper), ('\u{1f90}', '\u{1f97}',
+ SC_Lower), ('\u{1f98}', '\u{1f9f}', SC_Upper), ('\u{1fa0}', '\u{1fa7}', SC_Lower),
+ ('\u{1fa8}', '\u{1faf}', SC_Upper), ('\u{1fb0}', '\u{1fb4}', SC_Lower), ('\u{1fb6}',
+ '\u{1fb7}', SC_Lower), ('\u{1fb8}', '\u{1fbc}', SC_Upper), ('\u{1fbe}', '\u{1fbe}',
+ SC_Lower), ('\u{1fc2}', '\u{1fc4}', SC_Lower), ('\u{1fc6}', '\u{1fc7}', SC_Lower),
+ ('\u{1fc8}', '\u{1fcc}', SC_Upper), ('\u{1fd0}', '\u{1fd3}', SC_Lower), ('\u{1fd6}',
+ '\u{1fd7}', SC_Lower), ('\u{1fd8}', '\u{1fdb}', SC_Upper), ('\u{1fe0}', '\u{1fe7}',
+ SC_Lower), ('\u{1fe8}', '\u{1fec}', SC_Upper), ('\u{1ff2}', '\u{1ff4}', SC_Lower),
+ ('\u{1ff6}', '\u{1ff7}', SC_Lower), ('\u{1ff8}', '\u{1ffc}', SC_Upper), ('\u{2000}',
+ '\u{200a}', SC_Sp), ('\u{200b}', '\u{200b}', SC_Format), ('\u{200c}', '\u{200d}',
+ SC_Extend), ('\u{200e}', '\u{200f}', SC_Format), ('\u{2013}', '\u{2014}', SC_SContinue),
+ ('\u{2018}', '\u{201f}', SC_Close), ('\u{2024}', '\u{2024}', SC_ATerm), ('\u{2028}',
+ '\u{2029}', SC_Sep), ('\u{202a}', '\u{202e}', SC_Format), ('\u{202f}', '\u{202f}', SC_Sp),
+ ('\u{2039}', '\u{203a}', SC_Close), ('\u{203c}', '\u{203d}', SC_STerm), ('\u{2045}',
+ '\u{2046}', SC_Close), ('\u{2047}', '\u{2049}', SC_STerm), ('\u{205f}', '\u{205f}', SC_Sp),
+ ('\u{2060}', '\u{2064}', SC_Format), ('\u{2066}', '\u{206f}', SC_Format), ('\u{2071}',
+ '\u{2071}', SC_Lower), ('\u{207d}', '\u{207e}', SC_Close), ('\u{207f}', '\u{207f}',
+ SC_Lower), ('\u{208d}', '\u{208e}', SC_Close), ('\u{2090}', '\u{209c}', SC_Lower),
+ ('\u{20d0}', '\u{20f0}', SC_Extend), ('\u{2102}', '\u{2102}', SC_Upper), ('\u{2107}',
+ '\u{2107}', SC_Upper), ('\u{210a}', '\u{210a}', SC_Lower), ('\u{210b}', '\u{210d}',
+ SC_Upper), ('\u{210e}', '\u{210f}', SC_Lower), ('\u{2110}', '\u{2112}', SC_Upper),
+ ('\u{2113}', '\u{2113}', SC_Lower), ('\u{2115}', '\u{2115}', SC_Upper), ('\u{2119}',
+ '\u{211d}', SC_Upper), ('\u{2124}', '\u{2124}', SC_Upper), ('\u{2126}', '\u{2126}',
+ SC_Upper), ('\u{2128}', '\u{2128}', SC_Upper), ('\u{212a}', '\u{212d}', SC_Upper),
+ ('\u{212f}', '\u{212f}', SC_Lower), ('\u{2130}', '\u{2133}', SC_Upper), ('\u{2134}',
+ '\u{2134}', SC_Lower), ('\u{2135}', '\u{2138}', SC_OLetter), ('\u{2139}', '\u{2139}',
+ SC_Lower), ('\u{213c}', '\u{213d}', SC_Lower), ('\u{213e}', '\u{213f}', SC_Upper),
+ ('\u{2145}', '\u{2145}', SC_Upper), ('\u{2146}', '\u{2149}', SC_Lower), ('\u{214e}',
+ '\u{214e}', SC_Lower), ('\u{2160}', '\u{216f}', SC_Upper), ('\u{2170}', '\u{217f}',
+ SC_Lower), ('\u{2180}', '\u{2182}', SC_OLetter), ('\u{2183}', '\u{2183}', SC_Upper),
+ ('\u{2184}', '\u{2184}', SC_Lower), ('\u{2185}', '\u{2188}', SC_OLetter), ('\u{2308}',
+ '\u{230b}', SC_Close), ('\u{2329}', '\u{232a}', SC_Close), ('\u{24b6}', '\u{24cf}',
+ SC_Upper), ('\u{24d0}', '\u{24e9}', SC_Lower), ('\u{275b}', '\u{2760}', SC_Close),
+ ('\u{2768}', '\u{2775}', SC_Close), ('\u{27c5}', '\u{27c6}', SC_Close), ('\u{27e6}',
+ '\u{27ef}', SC_Close), ('\u{2983}', '\u{2998}', SC_Close), ('\u{29d8}', '\u{29db}',
+ SC_Close), ('\u{29fc}', '\u{29fd}', SC_Close), ('\u{2c00}', '\u{2c2f}', SC_Upper),
+ ('\u{2c30}', '\u{2c5f}', SC_Lower), ('\u{2c60}', '\u{2c60}', SC_Upper), ('\u{2c61}',
+ '\u{2c61}', SC_Lower), ('\u{2c62}', '\u{2c64}', SC_Upper), ('\u{2c65}', '\u{2c66}',
+ SC_Lower), ('\u{2c67}', '\u{2c67}', SC_Upper), ('\u{2c68}', '\u{2c68}', SC_Lower),
+ ('\u{2c69}', '\u{2c69}', SC_Upper), ('\u{2c6a}', '\u{2c6a}', SC_Lower), ('\u{2c6b}',
+ '\u{2c6b}', SC_Upper), ('\u{2c6c}', '\u{2c6c}', SC_Lower), ('\u{2c6d}', '\u{2c70}',
+ SC_Upper), ('\u{2c71}', '\u{2c71}', SC_Lower), ('\u{2c72}', '\u{2c72}', SC_Upper),
+ ('\u{2c73}', '\u{2c74}', SC_Lower), ('\u{2c75}', '\u{2c75}', SC_Upper), ('\u{2c76}',
+ '\u{2c7d}', SC_Lower), ('\u{2c7e}', '\u{2c80}', SC_Upper), ('\u{2c81}', '\u{2c81}',
+ SC_Lower), ('\u{2c82}', '\u{2c82}', SC_Upper), ('\u{2c83}', '\u{2c83}', SC_Lower),
+ ('\u{2c84}', '\u{2c84}', SC_Upper), ('\u{2c85}', '\u{2c85}', SC_Lower), ('\u{2c86}',
+ '\u{2c86}', SC_Upper), ('\u{2c87}', '\u{2c87}', SC_Lower), ('\u{2c88}', '\u{2c88}',
+ SC_Upper), ('\u{2c89}', '\u{2c89}', SC_Lower), ('\u{2c8a}', '\u{2c8a}', SC_Upper),
+ ('\u{2c8b}', '\u{2c8b}', SC_Lower), ('\u{2c8c}', '\u{2c8c}', SC_Upper), ('\u{2c8d}',
+ '\u{2c8d}', SC_Lower), ('\u{2c8e}', '\u{2c8e}', SC_Upper), ('\u{2c8f}', '\u{2c8f}',
+ SC_Lower), ('\u{2c90}', '\u{2c90}', SC_Upper), ('\u{2c91}', '\u{2c91}', SC_Lower),
+ ('\u{2c92}', '\u{2c92}', SC_Upper), ('\u{2c93}', '\u{2c93}', SC_Lower), ('\u{2c94}',
+ '\u{2c94}', SC_Upper), ('\u{2c95}', '\u{2c95}', SC_Lower), ('\u{2c96}', '\u{2c96}',
+ SC_Upper), ('\u{2c97}', '\u{2c97}', SC_Lower), ('\u{2c98}', '\u{2c98}', SC_Upper),
+ ('\u{2c99}', '\u{2c99}', SC_Lower), ('\u{2c9a}', '\u{2c9a}', SC_Upper), ('\u{2c9b}',
+ '\u{2c9b}', SC_Lower), ('\u{2c9c}', '\u{2c9c}', SC_Upper), ('\u{2c9d}', '\u{2c9d}',
+ SC_Lower), ('\u{2c9e}', '\u{2c9e}', SC_Upper), ('\u{2c9f}', '\u{2c9f}', SC_Lower),
+ ('\u{2ca0}', '\u{2ca0}', SC_Upper), ('\u{2ca1}', '\u{2ca1}', SC_Lower), ('\u{2ca2}',
+ '\u{2ca2}', SC_Upper), ('\u{2ca3}', '\u{2ca3}', SC_Lower), ('\u{2ca4}', '\u{2ca4}',
+ SC_Upper), ('\u{2ca5}', '\u{2ca5}', SC_Lower), ('\u{2ca6}', '\u{2ca6}', SC_Upper),
+ ('\u{2ca7}', '\u{2ca7}', SC_Lower), ('\u{2ca8}', '\u{2ca8}', SC_Upper), ('\u{2ca9}',
+ '\u{2ca9}', SC_Lower), ('\u{2caa}', '\u{2caa}', SC_Upper), ('\u{2cab}', '\u{2cab}',
+ SC_Lower), ('\u{2cac}', '\u{2cac}', SC_Upper), ('\u{2cad}', '\u{2cad}', SC_Lower),
+ ('\u{2cae}', '\u{2cae}', SC_Upper), ('\u{2caf}', '\u{2caf}', SC_Lower), ('\u{2cb0}',
+ '\u{2cb0}', SC_Upper), ('\u{2cb1}', '\u{2cb1}', SC_Lower), ('\u{2cb2}', '\u{2cb2}',
+ SC_Upper), ('\u{2cb3}', '\u{2cb3}', SC_Lower), ('\u{2cb4}', '\u{2cb4}', SC_Upper),
+ ('\u{2cb5}', '\u{2cb5}', SC_Lower), ('\u{2cb6}', '\u{2cb6}', SC_Upper), ('\u{2cb7}',
+ '\u{2cb7}', SC_Lower), ('\u{2cb8}', '\u{2cb8}', SC_Upper), ('\u{2cb9}', '\u{2cb9}',
+ SC_Lower), ('\u{2cba}', '\u{2cba}', SC_Upper), ('\u{2cbb}', '\u{2cbb}', SC_Lower),
+ ('\u{2cbc}', '\u{2cbc}', SC_Upper), ('\u{2cbd}', '\u{2cbd}', SC_Lower), ('\u{2cbe}',
+ '\u{2cbe}', SC_Upper), ('\u{2cbf}', '\u{2cbf}', SC_Lower), ('\u{2cc0}', '\u{2cc0}',
+ SC_Upper), ('\u{2cc1}', '\u{2cc1}', SC_Lower), ('\u{2cc2}', '\u{2cc2}', SC_Upper),
+ ('\u{2cc3}', '\u{2cc3}', SC_Lower), ('\u{2cc4}', '\u{2cc4}', SC_Upper), ('\u{2cc5}',
+ '\u{2cc5}', SC_Lower), ('\u{2cc6}', '\u{2cc6}', SC_Upper), ('\u{2cc7}', '\u{2cc7}',
+ SC_Lower), ('\u{2cc8}', '\u{2cc8}', SC_Upper), ('\u{2cc9}', '\u{2cc9}', SC_Lower),
+ ('\u{2cca}', '\u{2cca}', SC_Upper), ('\u{2ccb}', '\u{2ccb}', SC_Lower), ('\u{2ccc}',
+ '\u{2ccc}', SC_Upper), ('\u{2ccd}', '\u{2ccd}', SC_Lower), ('\u{2cce}', '\u{2cce}',
+ SC_Upper), ('\u{2ccf}', '\u{2ccf}', SC_Lower), ('\u{2cd0}', '\u{2cd0}', SC_Upper),
+ ('\u{2cd1}', '\u{2cd1}', SC_Lower), ('\u{2cd2}', '\u{2cd2}', SC_Upper), ('\u{2cd3}',
+ '\u{2cd3}', SC_Lower), ('\u{2cd4}', '\u{2cd4}', SC_Upper), ('\u{2cd5}', '\u{2cd5}',
+ SC_Lower), ('\u{2cd6}', '\u{2cd6}', SC_Upper), ('\u{2cd7}', '\u{2cd7}', SC_Lower),
+ ('\u{2cd8}', '\u{2cd8}', SC_Upper), ('\u{2cd9}', '\u{2cd9}', SC_Lower), ('\u{2cda}',
+ '\u{2cda}', SC_Upper), ('\u{2cdb}', '\u{2cdb}', SC_Lower), ('\u{2cdc}', '\u{2cdc}',
+ SC_Upper), ('\u{2cdd}', '\u{2cdd}', SC_Lower), ('\u{2cde}', '\u{2cde}', SC_Upper),
+ ('\u{2cdf}', '\u{2cdf}', SC_Lower), ('\u{2ce0}', '\u{2ce0}', SC_Upper), ('\u{2ce1}',
+ '\u{2ce1}', SC_Lower), ('\u{2ce2}', '\u{2ce2}', SC_Upper), ('\u{2ce3}', '\u{2ce4}',
+ SC_Lower), ('\u{2ceb}', '\u{2ceb}', SC_Upper), ('\u{2cec}', '\u{2cec}', SC_Lower),
+ ('\u{2ced}', '\u{2ced}', SC_Upper), ('\u{2cee}', '\u{2cee}', SC_Lower), ('\u{2cef}',
+ '\u{2cf1}', SC_Extend), ('\u{2cf2}', '\u{2cf2}', SC_Upper), ('\u{2cf3}', '\u{2cf3}',
+ SC_Lower), ('\u{2d00}', '\u{2d25}', SC_Lower), ('\u{2d27}', '\u{2d27}', SC_Lower),
+ ('\u{2d2d}', '\u{2d2d}', SC_Lower), ('\u{2d30}', '\u{2d67}', SC_OLetter), ('\u{2d6f}',
+ '\u{2d6f}', SC_OLetter), ('\u{2d7f}', '\u{2d7f}', SC_Extend), ('\u{2d80}', '\u{2d96}',
+ SC_OLetter), ('\u{2da0}', '\u{2da6}', SC_OLetter), ('\u{2da8}', '\u{2dae}', SC_OLetter),
+ ('\u{2db0}', '\u{2db6}', SC_OLetter), ('\u{2db8}', '\u{2dbe}', SC_OLetter), ('\u{2dc0}',
+ '\u{2dc6}', SC_OLetter), ('\u{2dc8}', '\u{2dce}', SC_OLetter), ('\u{2dd0}', '\u{2dd6}',
+ SC_OLetter), ('\u{2dd8}', '\u{2dde}', SC_OLetter), ('\u{2de0}', '\u{2dff}', SC_Extend),
+ ('\u{2e00}', '\u{2e0d}', SC_Close), ('\u{2e1c}', '\u{2e1d}', SC_Close), ('\u{2e20}',
+ '\u{2e29}', SC_Close), ('\u{2e2e}', '\u{2e2e}', SC_STerm), ('\u{2e2f}', '\u{2e2f}',
+ SC_OLetter), ('\u{2e3c}', '\u{2e3c}', SC_STerm), ('\u{2e42}', '\u{2e42}', SC_Close),
+ ('\u{2e53}', '\u{2e54}', SC_STerm), ('\u{2e55}', '\u{2e5c}', SC_Close), ('\u{3000}',
+ '\u{3000}', SC_Sp), ('\u{3001}', '\u{3001}', SC_SContinue), ('\u{3002}', '\u{3002}',
+ SC_STerm), ('\u{3005}', '\u{3007}', SC_OLetter), ('\u{3008}', '\u{3011}', SC_Close),
+ ('\u{3014}', '\u{301b}', SC_Close), ('\u{301d}', '\u{301f}', SC_Close), ('\u{3021}',
+ '\u{3029}', SC_OLetter), ('\u{302a}', '\u{302f}', SC_Extend), ('\u{3031}', '\u{3035}',
+ SC_OLetter), ('\u{3038}', '\u{303c}', SC_OLetter), ('\u{3041}', '\u{3096}', SC_OLetter),
+ ('\u{3099}', '\u{309a}', SC_Extend), ('\u{309d}', '\u{309f}', SC_OLetter), ('\u{30a1}',
+ '\u{30fa}', SC_OLetter), ('\u{30fc}', '\u{30ff}', SC_OLetter), ('\u{3105}', '\u{312f}',
+ SC_OLetter), ('\u{3131}', '\u{318e}', SC_OLetter), ('\u{31a0}', '\u{31bf}', SC_OLetter),
+ ('\u{31f0}', '\u{31ff}', SC_OLetter), ('\u{3400}', '\u{4dbf}', SC_OLetter), ('\u{4e00}',
+ '\u{a48c}', SC_OLetter), ('\u{a4d0}', '\u{a4fd}', SC_OLetter), ('\u{a4ff}', '\u{a4ff}',
+ SC_STerm), ('\u{a500}', '\u{a60c}', SC_OLetter), ('\u{a60e}', '\u{a60f}', SC_STerm),
+ ('\u{a610}', '\u{a61f}', SC_OLetter), ('\u{a620}', '\u{a629}', SC_Numeric), ('\u{a62a}',
+ '\u{a62b}', SC_OLetter), ('\u{a640}', '\u{a640}', SC_Upper), ('\u{a641}', '\u{a641}',
+ SC_Lower), ('\u{a642}', '\u{a642}', SC_Upper), ('\u{a643}', '\u{a643}', SC_Lower),
+ ('\u{a644}', '\u{a644}', SC_Upper), ('\u{a645}', '\u{a645}', SC_Lower), ('\u{a646}',
+ '\u{a646}', SC_Upper), ('\u{a647}', '\u{a647}', SC_Lower), ('\u{a648}', '\u{a648}',
+ SC_Upper), ('\u{a649}', '\u{a649}', SC_Lower), ('\u{a64a}', '\u{a64a}', SC_Upper),
+ ('\u{a64b}', '\u{a64b}', SC_Lower), ('\u{a64c}', '\u{a64c}', SC_Upper), ('\u{a64d}',
+ '\u{a64d}', SC_Lower), ('\u{a64e}', '\u{a64e}', SC_Upper), ('\u{a64f}', '\u{a64f}',
+ SC_Lower), ('\u{a650}', '\u{a650}', SC_Upper), ('\u{a651}', '\u{a651}', SC_Lower),
+ ('\u{a652}', '\u{a652}', SC_Upper), ('\u{a653}', '\u{a653}', SC_Lower), ('\u{a654}',
+ '\u{a654}', SC_Upper), ('\u{a655}', '\u{a655}', SC_Lower), ('\u{a656}', '\u{a656}',
+ SC_Upper), ('\u{a657}', '\u{a657}', SC_Lower), ('\u{a658}', '\u{a658}', SC_Upper),
+ ('\u{a659}', '\u{a659}', SC_Lower), ('\u{a65a}', '\u{a65a}', SC_Upper), ('\u{a65b}',
+ '\u{a65b}', SC_Lower), ('\u{a65c}', '\u{a65c}', SC_Upper), ('\u{a65d}', '\u{a65d}',
+ SC_Lower), ('\u{a65e}', '\u{a65e}', SC_Upper), ('\u{a65f}', '\u{a65f}', SC_Lower),
+ ('\u{a660}', '\u{a660}', SC_Upper), ('\u{a661}', '\u{a661}', SC_Lower), ('\u{a662}',
+ '\u{a662}', SC_Upper), ('\u{a663}', '\u{a663}', SC_Lower), ('\u{a664}', '\u{a664}',
+ SC_Upper), ('\u{a665}', '\u{a665}', SC_Lower), ('\u{a666}', '\u{a666}', SC_Upper),
+ ('\u{a667}', '\u{a667}', SC_Lower), ('\u{a668}', '\u{a668}', SC_Upper), ('\u{a669}',
+ '\u{a669}', SC_Lower), ('\u{a66a}', '\u{a66a}', SC_Upper), ('\u{a66b}', '\u{a66b}',
+ SC_Lower), ('\u{a66c}', '\u{a66c}', SC_Upper), ('\u{a66d}', '\u{a66d}', SC_Lower),
+ ('\u{a66e}', '\u{a66e}', SC_OLetter), ('\u{a66f}', '\u{a672}', SC_Extend), ('\u{a674}',
+ '\u{a67d}', SC_Extend), ('\u{a67f}', '\u{a67f}', SC_OLetter), ('\u{a680}', '\u{a680}',
+ SC_Upper), ('\u{a681}', '\u{a681}', SC_Lower), ('\u{a682}', '\u{a682}', SC_Upper),
+ ('\u{a683}', '\u{a683}', SC_Lower), ('\u{a684}', '\u{a684}', SC_Upper), ('\u{a685}',
+ '\u{a685}', SC_Lower), ('\u{a686}', '\u{a686}', SC_Upper), ('\u{a687}', '\u{a687}',
+ SC_Lower), ('\u{a688}', '\u{a688}', SC_Upper), ('\u{a689}', '\u{a689}', SC_Lower),
+ ('\u{a68a}', '\u{a68a}', SC_Upper), ('\u{a68b}', '\u{a68b}', SC_Lower), ('\u{a68c}',
+ '\u{a68c}', SC_Upper), ('\u{a68d}', '\u{a68d}', SC_Lower), ('\u{a68e}', '\u{a68e}',
+ SC_Upper), ('\u{a68f}', '\u{a68f}', SC_Lower), ('\u{a690}', '\u{a690}', SC_Upper),
+ ('\u{a691}', '\u{a691}', SC_Lower), ('\u{a692}', '\u{a692}', SC_Upper), ('\u{a693}',
+ '\u{a693}', SC_Lower), ('\u{a694}', '\u{a694}', SC_Upper), ('\u{a695}', '\u{a695}',
+ SC_Lower), ('\u{a696}', '\u{a696}', SC_Upper), ('\u{a697}', '\u{a697}', SC_Lower),
+ ('\u{a698}', '\u{a698}', SC_Upper), ('\u{a699}', '\u{a699}', SC_Lower), ('\u{a69a}',
+ '\u{a69a}', SC_Upper), ('\u{a69b}', '\u{a69d}', SC_Lower), ('\u{a69e}', '\u{a69f}',
+ SC_Extend), ('\u{a6a0}', '\u{a6ef}', SC_OLetter), ('\u{a6f0}', '\u{a6f1}', SC_Extend),
+ ('\u{a6f3}', '\u{a6f3}', SC_STerm), ('\u{a6f7}', '\u{a6f7}', SC_STerm), ('\u{a717}',
+ '\u{a71f}', SC_OLetter), ('\u{a722}', '\u{a722}', SC_Upper), ('\u{a723}', '\u{a723}',
+ SC_Lower), ('\u{a724}', '\u{a724}', SC_Upper), ('\u{a725}', '\u{a725}', SC_Lower),
+ ('\u{a726}', '\u{a726}', SC_Upper), ('\u{a727}', '\u{a727}', SC_Lower), ('\u{a728}',
+ '\u{a728}', SC_Upper), ('\u{a729}', '\u{a729}', SC_Lower), ('\u{a72a}', '\u{a72a}',
+ SC_Upper), ('\u{a72b}', '\u{a72b}', SC_Lower), ('\u{a72c}', '\u{a72c}', SC_Upper),
+ ('\u{a72d}', '\u{a72d}', SC_Lower), ('\u{a72e}', '\u{a72e}', SC_Upper), ('\u{a72f}',
+ '\u{a731}', SC_Lower), ('\u{a732}', '\u{a732}', SC_Upper), ('\u{a733}', '\u{a733}',
+ SC_Lower), ('\u{a734}', '\u{a734}', SC_Upper), ('\u{a735}', '\u{a735}', SC_Lower),
+ ('\u{a736}', '\u{a736}', SC_Upper), ('\u{a737}', '\u{a737}', SC_Lower), ('\u{a738}',
+ '\u{a738}', SC_Upper), ('\u{a739}', '\u{a739}', SC_Lower), ('\u{a73a}', '\u{a73a}',
+ SC_Upper), ('\u{a73b}', '\u{a73b}', SC_Lower), ('\u{a73c}', '\u{a73c}', SC_Upper),
+ ('\u{a73d}', '\u{a73d}', SC_Lower), ('\u{a73e}', '\u{a73e}', SC_Upper), ('\u{a73f}',
+ '\u{a73f}', SC_Lower), ('\u{a740}', '\u{a740}', SC_Upper), ('\u{a741}', '\u{a741}',
+ SC_Lower), ('\u{a742}', '\u{a742}', SC_Upper), ('\u{a743}', '\u{a743}', SC_Lower),
+ ('\u{a744}', '\u{a744}', SC_Upper), ('\u{a745}', '\u{a745}', SC_Lower), ('\u{a746}',
+ '\u{a746}', SC_Upper), ('\u{a747}', '\u{a747}', SC_Lower), ('\u{a748}', '\u{a748}',
+ SC_Upper), ('\u{a749}', '\u{a749}', SC_Lower), ('\u{a74a}', '\u{a74a}', SC_Upper),
+ ('\u{a74b}', '\u{a74b}', SC_Lower), ('\u{a74c}', '\u{a74c}', SC_Upper), ('\u{a74d}',
+ '\u{a74d}', SC_Lower), ('\u{a74e}', '\u{a74e}', SC_Upper), ('\u{a74f}', '\u{a74f}',
+ SC_Lower), ('\u{a750}', '\u{a750}', SC_Upper), ('\u{a751}', '\u{a751}', SC_Lower),
+ ('\u{a752}', '\u{a752}', SC_Upper), ('\u{a753}', '\u{a753}', SC_Lower), ('\u{a754}',
+ '\u{a754}', SC_Upper), ('\u{a755}', '\u{a755}', SC_Lower), ('\u{a756}', '\u{a756}',
+ SC_Upper), ('\u{a757}', '\u{a757}', SC_Lower), ('\u{a758}', '\u{a758}', SC_Upper),
+ ('\u{a759}', '\u{a759}', SC_Lower), ('\u{a75a}', '\u{a75a}', SC_Upper), ('\u{a75b}',
+ '\u{a75b}', SC_Lower), ('\u{a75c}', '\u{a75c}', SC_Upper), ('\u{a75d}', '\u{a75d}',
+ SC_Lower), ('\u{a75e}', '\u{a75e}', SC_Upper), ('\u{a75f}', '\u{a75f}', SC_Lower),
+ ('\u{a760}', '\u{a760}', SC_Upper), ('\u{a761}', '\u{a761}', SC_Lower), ('\u{a762}',
+ '\u{a762}', SC_Upper), ('\u{a763}', '\u{a763}', SC_Lower), ('\u{a764}', '\u{a764}',
+ SC_Upper), ('\u{a765}', '\u{a765}', SC_Lower), ('\u{a766}', '\u{a766}', SC_Upper),
+ ('\u{a767}', '\u{a767}', SC_Lower), ('\u{a768}', '\u{a768}', SC_Upper), ('\u{a769}',
+ '\u{a769}', SC_Lower), ('\u{a76a}', '\u{a76a}', SC_Upper), ('\u{a76b}', '\u{a76b}',
+ SC_Lower), ('\u{a76c}', '\u{a76c}', SC_Upper), ('\u{a76d}', '\u{a76d}', SC_Lower),
+ ('\u{a76e}', '\u{a76e}', SC_Upper), ('\u{a76f}', '\u{a778}', SC_Lower), ('\u{a779}',
+ '\u{a779}', SC_Upper), ('\u{a77a}', '\u{a77a}', SC_Lower), ('\u{a77b}', '\u{a77b}',
+ SC_Upper), ('\u{a77c}', '\u{a77c}', SC_Lower), ('\u{a77d}', '\u{a77e}', SC_Upper),
+ ('\u{a77f}', '\u{a77f}', SC_Lower), ('\u{a780}', '\u{a780}', SC_Upper), ('\u{a781}',
+ '\u{a781}', SC_Lower), ('\u{a782}', '\u{a782}', SC_Upper), ('\u{a783}', '\u{a783}',
+ SC_Lower), ('\u{a784}', '\u{a784}', SC_Upper), ('\u{a785}', '\u{a785}', SC_Lower),
+ ('\u{a786}', '\u{a786}', SC_Upper), ('\u{a787}', '\u{a787}', SC_Lower), ('\u{a788}',
+ '\u{a788}', SC_OLetter), ('\u{a78b}', '\u{a78b}', SC_Upper), ('\u{a78c}', '\u{a78c}',
+ SC_Lower), ('\u{a78d}', '\u{a78d}', SC_Upper), ('\u{a78e}', '\u{a78e}', SC_Lower),
+ ('\u{a78f}', '\u{a78f}', SC_OLetter), ('\u{a790}', '\u{a790}', SC_Upper), ('\u{a791}',
+ '\u{a791}', SC_Lower), ('\u{a792}', '\u{a792}', SC_Upper), ('\u{a793}', '\u{a795}',
+ SC_Lower), ('\u{a796}', '\u{a796}', SC_Upper), ('\u{a797}', '\u{a797}', SC_Lower),
+ ('\u{a798}', '\u{a798}', SC_Upper), ('\u{a799}', '\u{a799}', SC_Lower), ('\u{a79a}',
+ '\u{a79a}', SC_Upper), ('\u{a79b}', '\u{a79b}', SC_Lower), ('\u{a79c}', '\u{a79c}',
+ SC_Upper), ('\u{a79d}', '\u{a79d}', SC_Lower), ('\u{a79e}', '\u{a79e}', SC_Upper),
+ ('\u{a79f}', '\u{a79f}', SC_Lower), ('\u{a7a0}', '\u{a7a0}', SC_Upper), ('\u{a7a1}',
+ '\u{a7a1}', SC_Lower), ('\u{a7a2}', '\u{a7a2}', SC_Upper), ('\u{a7a3}', '\u{a7a3}',
+ SC_Lower), ('\u{a7a4}', '\u{a7a4}', SC_Upper), ('\u{a7a5}', '\u{a7a5}', SC_Lower),
+ ('\u{a7a6}', '\u{a7a6}', SC_Upper), ('\u{a7a7}', '\u{a7a7}', SC_Lower), ('\u{a7a8}',
+ '\u{a7a8}', SC_Upper), ('\u{a7a9}', '\u{a7a9}', SC_Lower), ('\u{a7aa}', '\u{a7ae}',
+ SC_Upper), ('\u{a7af}', '\u{a7af}', SC_Lower), ('\u{a7b0}', '\u{a7b4}', SC_Upper),
+ ('\u{a7b5}', '\u{a7b5}', SC_Lower), ('\u{a7b6}', '\u{a7b6}', SC_Upper), ('\u{a7b7}',
+ '\u{a7b7}', SC_Lower), ('\u{a7b8}', '\u{a7b8}', SC_Upper), ('\u{a7b9}', '\u{a7b9}',
+ SC_Lower), ('\u{a7ba}', '\u{a7ba}', SC_Upper), ('\u{a7bb}', '\u{a7bb}', SC_Lower),
+ ('\u{a7bc}', '\u{a7bc}', SC_Upper), ('\u{a7bd}', '\u{a7bd}', SC_Lower), ('\u{a7be}',
+ '\u{a7be}', SC_Upper), ('\u{a7bf}', '\u{a7bf}', SC_Lower), ('\u{a7c0}', '\u{a7c0}',
+ SC_Upper), ('\u{a7c1}', '\u{a7c1}', SC_Lower), ('\u{a7c2}', '\u{a7c2}', SC_Upper),
+ ('\u{a7c3}', '\u{a7c3}', SC_Lower), ('\u{a7c4}', '\u{a7c7}', SC_Upper), ('\u{a7c8}',
+ '\u{a7c8}', SC_Lower), ('\u{a7c9}', '\u{a7c9}', SC_Upper), ('\u{a7ca}', '\u{a7ca}',
+ SC_Lower), ('\u{a7d0}', '\u{a7d0}', SC_Upper), ('\u{a7d1}', '\u{a7d1}', SC_Lower),
+ ('\u{a7d3}', '\u{a7d3}', SC_Lower), ('\u{a7d5}', '\u{a7d5}', SC_Lower), ('\u{a7d6}',
+ '\u{a7d6}', SC_Upper), ('\u{a7d7}', '\u{a7d7}', SC_Lower), ('\u{a7d8}', '\u{a7d8}',
+ SC_Upper), ('\u{a7d9}', '\u{a7d9}', SC_Lower), ('\u{a7f2}', '\u{a7f4}', SC_Lower),
+ ('\u{a7f5}', '\u{a7f5}', SC_Upper), ('\u{a7f6}', '\u{a7f6}', SC_Lower), ('\u{a7f7}',
+ '\u{a7f7}', SC_OLetter), ('\u{a7f8}', '\u{a7fa}', SC_Lower), ('\u{a7fb}', '\u{a801}',
+ SC_OLetter), ('\u{a802}', '\u{a802}', SC_Extend), ('\u{a803}', '\u{a805}', SC_OLetter),
+ ('\u{a806}', '\u{a806}', SC_Extend), ('\u{a807}', '\u{a80a}', SC_OLetter), ('\u{a80b}',
+ '\u{a80b}', SC_Extend), ('\u{a80c}', '\u{a822}', SC_OLetter), ('\u{a823}', '\u{a827}',
+ SC_Extend), ('\u{a82c}', '\u{a82c}', SC_Extend), ('\u{a840}', '\u{a873}', SC_OLetter),
+ ('\u{a876}', '\u{a877}', SC_STerm), ('\u{a880}', '\u{a881}', SC_Extend), ('\u{a882}',
+ '\u{a8b3}', SC_OLetter), ('\u{a8b4}', '\u{a8c5}', SC_Extend), ('\u{a8ce}', '\u{a8cf}',
+ SC_STerm), ('\u{a8d0}', '\u{a8d9}', SC_Numeric), ('\u{a8e0}', '\u{a8f1}', SC_Extend),
+ ('\u{a8f2}', '\u{a8f7}', SC_OLetter), ('\u{a8fb}', '\u{a8fb}', SC_OLetter), ('\u{a8fd}',
+ '\u{a8fe}', SC_OLetter), ('\u{a8ff}', '\u{a8ff}', SC_Extend), ('\u{a900}', '\u{a909}',
+ SC_Numeric), ('\u{a90a}', '\u{a925}', SC_OLetter), ('\u{a926}', '\u{a92d}', SC_Extend),
+ ('\u{a92f}', '\u{a92f}', SC_STerm), ('\u{a930}', '\u{a946}', SC_OLetter), ('\u{a947}',
+ '\u{a953}', SC_Extend), ('\u{a960}', '\u{a97c}', SC_OLetter), ('\u{a980}', '\u{a983}',
+ SC_Extend), ('\u{a984}', '\u{a9b2}', SC_OLetter), ('\u{a9b3}', '\u{a9c0}', SC_Extend),
+ ('\u{a9c8}', '\u{a9c9}', SC_STerm), ('\u{a9cf}', '\u{a9cf}', SC_OLetter), ('\u{a9d0}',
+ '\u{a9d9}', SC_Numeric), ('\u{a9e0}', '\u{a9e4}', SC_OLetter), ('\u{a9e5}', '\u{a9e5}',
+ SC_Extend), ('\u{a9e6}', '\u{a9ef}', SC_OLetter), ('\u{a9f0}', '\u{a9f9}', SC_Numeric),
+ ('\u{a9fa}', '\u{a9fe}', SC_OLetter), ('\u{aa00}', '\u{aa28}', SC_OLetter), ('\u{aa29}',
+ '\u{aa36}', SC_Extend), ('\u{aa40}', '\u{aa42}', SC_OLetter), ('\u{aa43}', '\u{aa43}',
+ SC_Extend), ('\u{aa44}', '\u{aa4b}', SC_OLetter), ('\u{aa4c}', '\u{aa4d}', SC_Extend),
+ ('\u{aa50}', '\u{aa59}', SC_Numeric), ('\u{aa5d}', '\u{aa5f}', SC_STerm), ('\u{aa60}',
+ '\u{aa76}', SC_OLetter), ('\u{aa7a}', '\u{aa7a}', SC_OLetter), ('\u{aa7b}', '\u{aa7d}',
+ SC_Extend), ('\u{aa7e}', '\u{aaaf}', SC_OLetter), ('\u{aab0}', '\u{aab0}', SC_Extend),
+ ('\u{aab1}', '\u{aab1}', SC_OLetter), ('\u{aab2}', '\u{aab4}', SC_Extend), ('\u{aab5}',
+ '\u{aab6}', SC_OLetter), ('\u{aab7}', '\u{aab8}', SC_Extend), ('\u{aab9}', '\u{aabd}',
+ SC_OLetter), ('\u{aabe}', '\u{aabf}', SC_Extend), ('\u{aac0}', '\u{aac0}', SC_OLetter),
+ ('\u{aac1}', '\u{aac1}', SC_Extend), ('\u{aac2}', '\u{aac2}', SC_OLetter), ('\u{aadb}',
+ '\u{aadd}', SC_OLetter), ('\u{aae0}', '\u{aaea}', SC_OLetter), ('\u{aaeb}', '\u{aaef}',
+ SC_Extend), ('\u{aaf0}', '\u{aaf1}', SC_STerm), ('\u{aaf2}', '\u{aaf4}', SC_OLetter),
+ ('\u{aaf5}', '\u{aaf6}', SC_Extend), ('\u{ab01}', '\u{ab06}', SC_OLetter), ('\u{ab09}',
+ '\u{ab0e}', SC_OLetter), ('\u{ab11}', '\u{ab16}', SC_OLetter), ('\u{ab20}', '\u{ab26}',
+ SC_OLetter), ('\u{ab28}', '\u{ab2e}', SC_OLetter), ('\u{ab30}', '\u{ab5a}', SC_Lower),
+ ('\u{ab5c}', '\u{ab69}', SC_Lower), ('\u{ab70}', '\u{abbf}', SC_Lower), ('\u{abc0}',
+ '\u{abe2}', SC_OLetter), ('\u{abe3}', '\u{abea}', SC_Extend), ('\u{abeb}', '\u{abeb}',
+ SC_STerm), ('\u{abec}', '\u{abed}', SC_Extend), ('\u{abf0}', '\u{abf9}', SC_Numeric),
+ ('\u{ac00}', '\u{d7a3}', SC_OLetter), ('\u{d7b0}', '\u{d7c6}', SC_OLetter), ('\u{d7cb}',
+ '\u{d7fb}', SC_OLetter), ('\u{f900}', '\u{fa6d}', SC_OLetter), ('\u{fa70}', '\u{fad9}',
+ SC_OLetter), ('\u{fb00}', '\u{fb06}', SC_Lower), ('\u{fb13}', '\u{fb17}', SC_Lower),
+ ('\u{fb1d}', '\u{fb1d}', SC_OLetter), ('\u{fb1e}', '\u{fb1e}', SC_Extend), ('\u{fb1f}',
+ '\u{fb28}', SC_OLetter), ('\u{fb2a}', '\u{fb36}', SC_OLetter), ('\u{fb38}', '\u{fb3c}',
+ SC_OLetter), ('\u{fb3e}', '\u{fb3e}', SC_OLetter), ('\u{fb40}', '\u{fb41}', SC_OLetter),
+ ('\u{fb43}', '\u{fb44}', SC_OLetter), ('\u{fb46}', '\u{fbb1}', SC_OLetter), ('\u{fbd3}',
+ '\u{fd3d}', SC_OLetter), ('\u{fd3e}', '\u{fd3f}', SC_Close), ('\u{fd50}', '\u{fd8f}',
+ SC_OLetter), ('\u{fd92}', '\u{fdc7}', SC_OLetter), ('\u{fdf0}', '\u{fdfb}', SC_OLetter),
+ ('\u{fe00}', '\u{fe0f}', SC_Extend), ('\u{fe10}', '\u{fe11}', SC_SContinue), ('\u{fe13}',
+ '\u{fe13}', SC_SContinue), ('\u{fe17}', '\u{fe18}', SC_Close), ('\u{fe20}', '\u{fe2f}',
+ SC_Extend), ('\u{fe31}', '\u{fe32}', SC_SContinue), ('\u{fe35}', '\u{fe44}', SC_Close),
+ ('\u{fe47}', '\u{fe48}', SC_Close), ('\u{fe50}', '\u{fe51}', SC_SContinue), ('\u{fe52}',
+ '\u{fe52}', SC_ATerm), ('\u{fe55}', '\u{fe55}', SC_SContinue), ('\u{fe56}', '\u{fe57}',
+ SC_STerm), ('\u{fe58}', '\u{fe58}', SC_SContinue), ('\u{fe59}', '\u{fe5e}', SC_Close),
+ ('\u{fe63}', '\u{fe63}', SC_SContinue), ('\u{fe70}', '\u{fe74}', SC_OLetter), ('\u{fe76}',
+ '\u{fefc}', SC_OLetter), ('\u{feff}', '\u{feff}', SC_Format), ('\u{ff01}', '\u{ff01}',
+ SC_STerm), ('\u{ff08}', '\u{ff09}', SC_Close), ('\u{ff0c}', '\u{ff0d}', SC_SContinue),
+ ('\u{ff0e}', '\u{ff0e}', SC_ATerm), ('\u{ff10}', '\u{ff19}', SC_Numeric), ('\u{ff1a}',
+ '\u{ff1a}', SC_SContinue), ('\u{ff1f}', '\u{ff1f}', SC_STerm), ('\u{ff21}', '\u{ff3a}',
+ SC_Upper), ('\u{ff3b}', '\u{ff3b}', SC_Close), ('\u{ff3d}', '\u{ff3d}', SC_Close),
+ ('\u{ff41}', '\u{ff5a}', SC_Lower), ('\u{ff5b}', '\u{ff5b}', SC_Close), ('\u{ff5d}',
+ '\u{ff5d}', SC_Close), ('\u{ff5f}', '\u{ff60}', SC_Close), ('\u{ff61}', '\u{ff61}',
+ SC_STerm), ('\u{ff62}', '\u{ff63}', SC_Close), ('\u{ff64}', '\u{ff64}', SC_SContinue),
+ ('\u{ff66}', '\u{ff9d}', SC_OLetter), ('\u{ff9e}', '\u{ff9f}', SC_Extend), ('\u{ffa0}',
+ '\u{ffbe}', SC_OLetter), ('\u{ffc2}', '\u{ffc7}', SC_OLetter), ('\u{ffca}', '\u{ffcf}',
+ SC_OLetter), ('\u{ffd2}', '\u{ffd7}', SC_OLetter), ('\u{ffda}', '\u{ffdc}', SC_OLetter),
+ ('\u{fff9}', '\u{fffb}', SC_Format), ('\u{10000}', '\u{1000b}', SC_OLetter), ('\u{1000d}',
+ '\u{10026}', SC_OLetter), ('\u{10028}', '\u{1003a}', SC_OLetter), ('\u{1003c}', '\u{1003d}',
+ SC_OLetter), ('\u{1003f}', '\u{1004d}', SC_OLetter), ('\u{10050}', '\u{1005d}', SC_OLetter),
+ ('\u{10080}', '\u{100fa}', SC_OLetter), ('\u{10140}', '\u{10174}', SC_OLetter),
+ ('\u{101fd}', '\u{101fd}', SC_Extend), ('\u{10280}', '\u{1029c}', SC_OLetter), ('\u{102a0}',
+ '\u{102d0}', SC_OLetter), ('\u{102e0}', '\u{102e0}', SC_Extend), ('\u{10300}', '\u{1031f}',
+ SC_OLetter), ('\u{1032d}', '\u{1034a}', SC_OLetter), ('\u{10350}', '\u{10375}', SC_OLetter),
+ ('\u{10376}', '\u{1037a}', SC_Extend), ('\u{10380}', '\u{1039d}', SC_OLetter), ('\u{103a0}',
+ '\u{103c3}', SC_OLetter), ('\u{103c8}', '\u{103cf}', SC_OLetter), ('\u{103d1}', '\u{103d5}',
+ SC_OLetter), ('\u{10400}', '\u{10427}', SC_Upper), ('\u{10428}', '\u{1044f}', SC_Lower),
+ ('\u{10450}', '\u{1049d}', SC_OLetter), ('\u{104a0}', '\u{104a9}', SC_Numeric),
+ ('\u{104b0}', '\u{104d3}', SC_Upper), ('\u{104d8}', '\u{104fb}', SC_Lower), ('\u{10500}',
+ '\u{10527}', SC_OLetter), ('\u{10530}', '\u{10563}', SC_OLetter), ('\u{10570}', '\u{1057a}',
+ SC_Upper), ('\u{1057c}', '\u{1058a}', SC_Upper), ('\u{1058c}', '\u{10592}', SC_Upper),
+ ('\u{10594}', '\u{10595}', SC_Upper), ('\u{10597}', '\u{105a1}', SC_Lower), ('\u{105a3}',
+ '\u{105b1}', SC_Lower), ('\u{105b3}', '\u{105b9}', SC_Lower), ('\u{105bb}', '\u{105bc}',
+ SC_Lower), ('\u{10600}', '\u{10736}', SC_OLetter), ('\u{10740}', '\u{10755}', SC_OLetter),
+ ('\u{10760}', '\u{10767}', SC_OLetter), ('\u{10780}', '\u{10780}', SC_Lower), ('\u{10781}',
+ '\u{10782}', SC_OLetter), ('\u{10783}', '\u{10785}', SC_Lower), ('\u{10787}', '\u{107b0}',
+ SC_Lower), ('\u{107b2}', '\u{107ba}', SC_Lower), ('\u{10800}', '\u{10805}', SC_OLetter),
+ ('\u{10808}', '\u{10808}', SC_OLetter), ('\u{1080a}', '\u{10835}', SC_OLetter),
+ ('\u{10837}', '\u{10838}', SC_OLetter), ('\u{1083c}', '\u{1083c}', SC_OLetter),
+ ('\u{1083f}', '\u{10855}', SC_OLetter), ('\u{10860}', '\u{10876}', SC_OLetter),
+ ('\u{10880}', '\u{1089e}', SC_OLetter), ('\u{108e0}', '\u{108f2}', SC_OLetter),
+ ('\u{108f4}', '\u{108f5}', SC_OLetter), ('\u{10900}', '\u{10915}', SC_OLetter),
+ ('\u{10920}', '\u{10939}', SC_OLetter), ('\u{10980}', '\u{109b7}', SC_OLetter),
+ ('\u{109be}', '\u{109bf}', SC_OLetter), ('\u{10a00}', '\u{10a00}', SC_OLetter),
+ ('\u{10a01}', '\u{10a03}', SC_Extend), ('\u{10a05}', '\u{10a06}', SC_Extend), ('\u{10a0c}',
+ '\u{10a0f}', SC_Extend), ('\u{10a10}', '\u{10a13}', SC_OLetter), ('\u{10a15}', '\u{10a17}',
+ SC_OLetter), ('\u{10a19}', '\u{10a35}', SC_OLetter), ('\u{10a38}', '\u{10a3a}', SC_Extend),
+ ('\u{10a3f}', '\u{10a3f}', SC_Extend), ('\u{10a56}', '\u{10a57}', SC_STerm), ('\u{10a60}',
+ '\u{10a7c}', SC_OLetter), ('\u{10a80}', '\u{10a9c}', SC_OLetter), ('\u{10ac0}', '\u{10ac7}',
+ SC_OLetter), ('\u{10ac9}', '\u{10ae4}', SC_OLetter), ('\u{10ae5}', '\u{10ae6}', SC_Extend),
+ ('\u{10b00}', '\u{10b35}', SC_OLetter), ('\u{10b40}', '\u{10b55}', SC_OLetter),
+ ('\u{10b60}', '\u{10b72}', SC_OLetter), ('\u{10b80}', '\u{10b91}', SC_OLetter),
+ ('\u{10c00}', '\u{10c48}', SC_OLetter), ('\u{10c80}', '\u{10cb2}', SC_Upper), ('\u{10cc0}',
+ '\u{10cf2}', SC_Lower), ('\u{10d00}', '\u{10d23}', SC_OLetter), ('\u{10d24}', '\u{10d27}',
+ SC_Extend), ('\u{10d30}', '\u{10d39}', SC_Numeric), ('\u{10e80}', '\u{10ea9}', SC_OLetter),
+ ('\u{10eab}', '\u{10eac}', SC_Extend), ('\u{10eb0}', '\u{10eb1}', SC_OLetter), ('\u{10efd}',
+ '\u{10eff}', SC_Extend), ('\u{10f00}', '\u{10f1c}', SC_OLetter), ('\u{10f27}', '\u{10f27}',
+ SC_OLetter), ('\u{10f30}', '\u{10f45}', SC_OLetter), ('\u{10f46}', '\u{10f50}', SC_Extend),
+ ('\u{10f55}', '\u{10f59}', SC_STerm), ('\u{10f70}', '\u{10f81}', SC_OLetter), ('\u{10f82}',
+ '\u{10f85}', SC_Extend), ('\u{10f86}', '\u{10f89}', SC_STerm), ('\u{10fb0}', '\u{10fc4}',
+ SC_OLetter), ('\u{10fe0}', '\u{10ff6}', SC_OLetter), ('\u{11000}', '\u{11002}', SC_Extend),
+ ('\u{11003}', '\u{11037}', SC_OLetter), ('\u{11038}', '\u{11046}', SC_Extend), ('\u{11047}',
+ '\u{11048}', SC_STerm), ('\u{11066}', '\u{1106f}', SC_Numeric), ('\u{11070}', '\u{11070}',
+ SC_Extend), ('\u{11071}', '\u{11072}', SC_OLetter), ('\u{11073}', '\u{11074}', SC_Extend),
+ ('\u{11075}', '\u{11075}', SC_OLetter), ('\u{1107f}', '\u{11082}', SC_Extend), ('\u{11083}',
+ '\u{110af}', SC_OLetter), ('\u{110b0}', '\u{110ba}', SC_Extend), ('\u{110bd}', '\u{110bd}',
+ SC_Format), ('\u{110be}', '\u{110c1}', SC_STerm), ('\u{110c2}', '\u{110c2}', SC_Extend),
+ ('\u{110cd}', '\u{110cd}', SC_Format), ('\u{110d0}', '\u{110e8}', SC_OLetter), ('\u{110f0}',
+ '\u{110f9}', SC_Numeric), ('\u{11100}', '\u{11102}', SC_Extend), ('\u{11103}', '\u{11126}',
+ SC_OLetter), ('\u{11127}', '\u{11134}', SC_Extend), ('\u{11136}', '\u{1113f}', SC_Numeric),
+ ('\u{11141}', '\u{11143}', SC_STerm), ('\u{11144}', '\u{11144}', SC_OLetter), ('\u{11145}',
+ '\u{11146}', SC_Extend), ('\u{11147}', '\u{11147}', SC_OLetter), ('\u{11150}', '\u{11172}',
+ SC_OLetter), ('\u{11173}', '\u{11173}', SC_Extend), ('\u{11176}', '\u{11176}', SC_OLetter),
+ ('\u{11180}', '\u{11182}', SC_Extend), ('\u{11183}', '\u{111b2}', SC_OLetter), ('\u{111b3}',
+ '\u{111c0}', SC_Extend), ('\u{111c1}', '\u{111c4}', SC_OLetter), ('\u{111c5}', '\u{111c6}',
+ SC_STerm), ('\u{111c9}', '\u{111cc}', SC_Extend), ('\u{111cd}', '\u{111cd}', SC_STerm),
+ ('\u{111ce}', '\u{111cf}', SC_Extend), ('\u{111d0}', '\u{111d9}', SC_Numeric), ('\u{111da}',
+ '\u{111da}', SC_OLetter), ('\u{111dc}', '\u{111dc}', SC_OLetter), ('\u{111de}', '\u{111df}',
+ SC_STerm), ('\u{11200}', '\u{11211}', SC_OLetter), ('\u{11213}', '\u{1122b}', SC_OLetter),
+ ('\u{1122c}', '\u{11237}', SC_Extend), ('\u{11238}', '\u{11239}', SC_STerm), ('\u{1123b}',
+ '\u{1123c}', SC_STerm), ('\u{1123e}', '\u{1123e}', SC_Extend), ('\u{1123f}', '\u{11240}',
+ SC_OLetter), ('\u{11241}', '\u{11241}', SC_Extend), ('\u{11280}', '\u{11286}', SC_OLetter),
+ ('\u{11288}', '\u{11288}', SC_OLetter), ('\u{1128a}', '\u{1128d}', SC_OLetter),
+ ('\u{1128f}', '\u{1129d}', SC_OLetter), ('\u{1129f}', '\u{112a8}', SC_OLetter),
+ ('\u{112a9}', '\u{112a9}', SC_STerm), ('\u{112b0}', '\u{112de}', SC_OLetter), ('\u{112df}',
+ '\u{112ea}', SC_Extend), ('\u{112f0}', '\u{112f9}', SC_Numeric), ('\u{11300}', '\u{11303}',
+ SC_Extend), ('\u{11305}', '\u{1130c}', SC_OLetter), ('\u{1130f}', '\u{11310}', SC_OLetter),
+ ('\u{11313}', '\u{11328}', SC_OLetter), ('\u{1132a}', '\u{11330}', SC_OLetter),
+ ('\u{11332}', '\u{11333}', SC_OLetter), ('\u{11335}', '\u{11339}', SC_OLetter),
+ ('\u{1133b}', '\u{1133c}', SC_Extend), ('\u{1133d}', '\u{1133d}', SC_OLetter), ('\u{1133e}',
+ '\u{11344}', SC_Extend), ('\u{11347}', '\u{11348}', SC_Extend), ('\u{1134b}', '\u{1134d}',
+ SC_Extend), ('\u{11350}', '\u{11350}', SC_OLetter), ('\u{11357}', '\u{11357}', SC_Extend),
+ ('\u{1135d}', '\u{11361}', SC_OLetter), ('\u{11362}', '\u{11363}', SC_Extend), ('\u{11366}',
+ '\u{1136c}', SC_Extend), ('\u{11370}', '\u{11374}', SC_Extend), ('\u{11400}', '\u{11434}',
+ SC_OLetter), ('\u{11435}', '\u{11446}', SC_Extend), ('\u{11447}', '\u{1144a}', SC_OLetter),
+ ('\u{1144b}', '\u{1144c}', SC_STerm), ('\u{11450}', '\u{11459}', SC_Numeric), ('\u{1145e}',
+ '\u{1145e}', SC_Extend), ('\u{1145f}', '\u{11461}', SC_OLetter), ('\u{11480}', '\u{114af}',
+ SC_OLetter), ('\u{114b0}', '\u{114c3}', SC_Extend), ('\u{114c4}', '\u{114c5}', SC_OLetter),
+ ('\u{114c7}', '\u{114c7}', SC_OLetter), ('\u{114d0}', '\u{114d9}', SC_Numeric),
+ ('\u{11580}', '\u{115ae}', SC_OLetter), ('\u{115af}', '\u{115b5}', SC_Extend), ('\u{115b8}',
+ '\u{115c0}', SC_Extend), ('\u{115c2}', '\u{115c3}', SC_STerm), ('\u{115c9}', '\u{115d7}',
+ SC_STerm), ('\u{115d8}', '\u{115db}', SC_OLetter), ('\u{115dc}', '\u{115dd}', SC_Extend),
+ ('\u{11600}', '\u{1162f}', SC_OLetter), ('\u{11630}', '\u{11640}', SC_Extend), ('\u{11641}',
+ '\u{11642}', SC_STerm), ('\u{11644}', '\u{11644}', SC_OLetter), ('\u{11650}', '\u{11659}',
+ SC_Numeric), ('\u{11680}', '\u{116aa}', SC_OLetter), ('\u{116ab}', '\u{116b7}', SC_Extend),
+ ('\u{116b8}', '\u{116b8}', SC_OLetter), ('\u{116c0}', '\u{116c9}', SC_Numeric),
+ ('\u{11700}', '\u{1171a}', SC_OLetter), ('\u{1171d}', '\u{1172b}', SC_Extend), ('\u{11730}',
+ '\u{11739}', SC_Numeric), ('\u{1173c}', '\u{1173e}', SC_STerm), ('\u{11740}', '\u{11746}',
+ SC_OLetter), ('\u{11800}', '\u{1182b}', SC_OLetter), ('\u{1182c}', '\u{1183a}', SC_Extend),
+ ('\u{118a0}', '\u{118bf}', SC_Upper), ('\u{118c0}', '\u{118df}', SC_Lower), ('\u{118e0}',
+ '\u{118e9}', SC_Numeric), ('\u{118ff}', '\u{11906}', SC_OLetter), ('\u{11909}', '\u{11909}',
+ SC_OLetter), ('\u{1190c}', '\u{11913}', SC_OLetter), ('\u{11915}', '\u{11916}', SC_OLetter),
+ ('\u{11918}', '\u{1192f}', SC_OLetter), ('\u{11930}', '\u{11935}', SC_Extend), ('\u{11937}',
+ '\u{11938}', SC_Extend), ('\u{1193b}', '\u{1193e}', SC_Extend), ('\u{1193f}', '\u{1193f}',
+ SC_OLetter), ('\u{11940}', '\u{11940}', SC_Extend), ('\u{11941}', '\u{11941}', SC_OLetter),
+ ('\u{11942}', '\u{11943}', SC_Extend), ('\u{11944}', '\u{11944}', SC_STerm), ('\u{11946}',
+ '\u{11946}', SC_STerm), ('\u{11950}', '\u{11959}', SC_Numeric), ('\u{119a0}', '\u{119a7}',
+ SC_OLetter), ('\u{119aa}', '\u{119d0}', SC_OLetter), ('\u{119d1}', '\u{119d7}', SC_Extend),
+ ('\u{119da}', '\u{119e0}', SC_Extend), ('\u{119e1}', '\u{119e1}', SC_OLetter), ('\u{119e3}',
+ '\u{119e3}', SC_OLetter), ('\u{119e4}', '\u{119e4}', SC_Extend), ('\u{11a00}', '\u{11a00}',
+ SC_OLetter), ('\u{11a01}', '\u{11a0a}', SC_Extend), ('\u{11a0b}', '\u{11a32}', SC_OLetter),
+ ('\u{11a33}', '\u{11a39}', SC_Extend), ('\u{11a3a}', '\u{11a3a}', SC_OLetter), ('\u{11a3b}',
+ '\u{11a3e}', SC_Extend), ('\u{11a42}', '\u{11a43}', SC_STerm), ('\u{11a47}', '\u{11a47}',
+ SC_Extend), ('\u{11a50}', '\u{11a50}', SC_OLetter), ('\u{11a51}', '\u{11a5b}', SC_Extend),
+ ('\u{11a5c}', '\u{11a89}', SC_OLetter), ('\u{11a8a}', '\u{11a99}', SC_Extend), ('\u{11a9b}',
+ '\u{11a9c}', SC_STerm), ('\u{11a9d}', '\u{11a9d}', SC_OLetter), ('\u{11ab0}', '\u{11af8}',
+ SC_OLetter), ('\u{11c00}', '\u{11c08}', SC_OLetter), ('\u{11c0a}', '\u{11c2e}', SC_OLetter),
+ ('\u{11c2f}', '\u{11c36}', SC_Extend), ('\u{11c38}', '\u{11c3f}', SC_Extend), ('\u{11c40}',
+ '\u{11c40}', SC_OLetter), ('\u{11c41}', '\u{11c42}', SC_STerm), ('\u{11c50}', '\u{11c59}',
+ SC_Numeric), ('\u{11c72}', '\u{11c8f}', SC_OLetter), ('\u{11c92}', '\u{11ca7}', SC_Extend),
+ ('\u{11ca9}', '\u{11cb6}', SC_Extend), ('\u{11d00}', '\u{11d06}', SC_OLetter), ('\u{11d08}',
+ '\u{11d09}', SC_OLetter), ('\u{11d0b}', '\u{11d30}', SC_OLetter), ('\u{11d31}', '\u{11d36}',
+ SC_Extend), ('\u{11d3a}', '\u{11d3a}', SC_Extend), ('\u{11d3c}', '\u{11d3d}', SC_Extend),
+ ('\u{11d3f}', '\u{11d45}', SC_Extend), ('\u{11d46}', '\u{11d46}', SC_OLetter), ('\u{11d47}',
+ '\u{11d47}', SC_Extend), ('\u{11d50}', '\u{11d59}', SC_Numeric), ('\u{11d60}', '\u{11d65}',
+ SC_OLetter), ('\u{11d67}', '\u{11d68}', SC_OLetter), ('\u{11d6a}', '\u{11d89}', SC_OLetter),
+ ('\u{11d8a}', '\u{11d8e}', SC_Extend), ('\u{11d90}', '\u{11d91}', SC_Extend), ('\u{11d93}',
+ '\u{11d97}', SC_Extend), ('\u{11d98}', '\u{11d98}', SC_OLetter), ('\u{11da0}', '\u{11da9}',
+ SC_Numeric), ('\u{11ee0}', '\u{11ef2}', SC_OLetter), ('\u{11ef3}', '\u{11ef6}', SC_Extend),
+ ('\u{11ef7}', '\u{11ef8}', SC_STerm), ('\u{11f00}', '\u{11f01}', SC_Extend), ('\u{11f02}',
+ '\u{11f02}', SC_OLetter), ('\u{11f03}', '\u{11f03}', SC_Extend), ('\u{11f04}', '\u{11f10}',
+ SC_OLetter), ('\u{11f12}', '\u{11f33}', SC_OLetter), ('\u{11f34}', '\u{11f3a}', SC_Extend),
+ ('\u{11f3e}', '\u{11f42}', SC_Extend), ('\u{11f43}', '\u{11f44}', SC_STerm), ('\u{11f50}',
+ '\u{11f59}', SC_Numeric), ('\u{11fb0}', '\u{11fb0}', SC_OLetter), ('\u{12000}', '\u{12399}',
+ SC_OLetter), ('\u{12400}', '\u{1246e}', SC_OLetter), ('\u{12480}', '\u{12543}', SC_OLetter),
+ ('\u{12f90}', '\u{12ff0}', SC_OLetter), ('\u{13000}', '\u{1342f}', SC_OLetter),
+ ('\u{13430}', '\u{1343f}', SC_Format), ('\u{13440}', '\u{13440}', SC_Extend), ('\u{13441}',
+ '\u{13446}', SC_OLetter), ('\u{13447}', '\u{13455}', SC_Extend), ('\u{14400}', '\u{14646}',
+ SC_OLetter), ('\u{16800}', '\u{16a38}', SC_OLetter), ('\u{16a40}', '\u{16a5e}', SC_OLetter),
+ ('\u{16a60}', '\u{16a69}', SC_Numeric), ('\u{16a6e}', '\u{16a6f}', SC_STerm), ('\u{16a70}',
+ '\u{16abe}', SC_OLetter), ('\u{16ac0}', '\u{16ac9}', SC_Numeric), ('\u{16ad0}', '\u{16aed}',
+ SC_OLetter), ('\u{16af0}', '\u{16af4}', SC_Extend), ('\u{16af5}', '\u{16af5}', SC_STerm),
+ ('\u{16b00}', '\u{16b2f}', SC_OLetter), ('\u{16b30}', '\u{16b36}', SC_Extend), ('\u{16b37}',
+ '\u{16b38}', SC_STerm), ('\u{16b40}', '\u{16b43}', SC_OLetter), ('\u{16b44}', '\u{16b44}',
+ SC_STerm), ('\u{16b50}', '\u{16b59}', SC_Numeric), ('\u{16b63}', '\u{16b77}', SC_OLetter),
+ ('\u{16b7d}', '\u{16b8f}', SC_OLetter), ('\u{16e40}', '\u{16e5f}', SC_Upper), ('\u{16e60}',
+ '\u{16e7f}', SC_Lower), ('\u{16e98}', '\u{16e98}', SC_STerm), ('\u{16f00}', '\u{16f4a}',
+ SC_OLetter), ('\u{16f4f}', '\u{16f4f}', SC_Extend), ('\u{16f50}', '\u{16f50}', SC_OLetter),
+ ('\u{16f51}', '\u{16f87}', SC_Extend), ('\u{16f8f}', '\u{16f92}', SC_Extend), ('\u{16f93}',
+ '\u{16f9f}', SC_OLetter), ('\u{16fe0}', '\u{16fe1}', SC_OLetter), ('\u{16fe3}', '\u{16fe3}',
+ SC_OLetter), ('\u{16fe4}', '\u{16fe4}', SC_Extend), ('\u{16ff0}', '\u{16ff1}', SC_Extend),
+ ('\u{17000}', '\u{187f7}', SC_OLetter), ('\u{18800}', '\u{18cd5}', SC_OLetter),
+ ('\u{18d00}', '\u{18d08}', SC_OLetter), ('\u{1aff0}', '\u{1aff3}', SC_OLetter),
+ ('\u{1aff5}', '\u{1affb}', SC_OLetter), ('\u{1affd}', '\u{1affe}', SC_OLetter),
+ ('\u{1b000}', '\u{1b122}', SC_OLetter), ('\u{1b132}', '\u{1b132}', SC_OLetter),
+ ('\u{1b150}', '\u{1b152}', SC_OLetter), ('\u{1b155}', '\u{1b155}', SC_OLetter),
+ ('\u{1b164}', '\u{1b167}', SC_OLetter), ('\u{1b170}', '\u{1b2fb}', SC_OLetter),
+ ('\u{1bc00}', '\u{1bc6a}', SC_OLetter), ('\u{1bc70}', '\u{1bc7c}', SC_OLetter),
+ ('\u{1bc80}', '\u{1bc88}', SC_OLetter), ('\u{1bc90}', '\u{1bc99}', SC_OLetter),
+ ('\u{1bc9d}', '\u{1bc9e}', SC_Extend), ('\u{1bc9f}', '\u{1bc9f}', SC_STerm), ('\u{1bca0}',
+ '\u{1bca3}', SC_Format), ('\u{1cf00}', '\u{1cf2d}', SC_Extend), ('\u{1cf30}', '\u{1cf46}',
+ SC_Extend), ('\u{1d165}', '\u{1d169}', SC_Extend), ('\u{1d16d}', '\u{1d172}', SC_Extend),
+ ('\u{1d173}', '\u{1d17a}', SC_Format), ('\u{1d17b}', '\u{1d182}', SC_Extend), ('\u{1d185}',
+ '\u{1d18b}', SC_Extend), ('\u{1d1aa}', '\u{1d1ad}', SC_Extend), ('\u{1d242}', '\u{1d244}',
+ SC_Extend), ('\u{1d400}', '\u{1d419}', SC_Upper), ('\u{1d41a}', '\u{1d433}', SC_Lower),
+ ('\u{1d434}', '\u{1d44d}', SC_Upper), ('\u{1d44e}', '\u{1d454}', SC_Lower), ('\u{1d456}',
+ '\u{1d467}', SC_Lower), ('\u{1d468}', '\u{1d481}', SC_Upper), ('\u{1d482}', '\u{1d49b}',
+ SC_Lower), ('\u{1d49c}', '\u{1d49c}', SC_Upper), ('\u{1d49e}', '\u{1d49f}', SC_Upper),
+ ('\u{1d4a2}', '\u{1d4a2}', SC_Upper), ('\u{1d4a5}', '\u{1d4a6}', SC_Upper), ('\u{1d4a9}',
+ '\u{1d4ac}', SC_Upper), ('\u{1d4ae}', '\u{1d4b5}', SC_Upper), ('\u{1d4b6}', '\u{1d4b9}',
+ SC_Lower), ('\u{1d4bb}', '\u{1d4bb}', SC_Lower), ('\u{1d4bd}', '\u{1d4c3}', SC_Lower),
+ ('\u{1d4c5}', '\u{1d4cf}', SC_Lower), ('\u{1d4d0}', '\u{1d4e9}', SC_Upper), ('\u{1d4ea}',
+ '\u{1d503}', SC_Lower), ('\u{1d504}', '\u{1d505}', SC_Upper), ('\u{1d507}', '\u{1d50a}',
+ SC_Upper), ('\u{1d50d}', '\u{1d514}', SC_Upper), ('\u{1d516}', '\u{1d51c}', SC_Upper),
+ ('\u{1d51e}', '\u{1d537}', SC_Lower), ('\u{1d538}', '\u{1d539}', SC_Upper), ('\u{1d53b}',
+ '\u{1d53e}', SC_Upper), ('\u{1d540}', '\u{1d544}', SC_Upper), ('\u{1d546}', '\u{1d546}',
+ SC_Upper), ('\u{1d54a}', '\u{1d550}', SC_Upper), ('\u{1d552}', '\u{1d56b}', SC_Lower),
+ ('\u{1d56c}', '\u{1d585}', SC_Upper), ('\u{1d586}', '\u{1d59f}', SC_Lower), ('\u{1d5a0}',
+ '\u{1d5b9}', SC_Upper), ('\u{1d5ba}', '\u{1d5d3}', SC_Lower), ('\u{1d5d4}', '\u{1d5ed}',
+ SC_Upper), ('\u{1d5ee}', '\u{1d607}', SC_Lower), ('\u{1d608}', '\u{1d621}', SC_Upper),
+ ('\u{1d622}', '\u{1d63b}', SC_Lower), ('\u{1d63c}', '\u{1d655}', SC_Upper), ('\u{1d656}',
+ '\u{1d66f}', SC_Lower), ('\u{1d670}', '\u{1d689}', SC_Upper), ('\u{1d68a}', '\u{1d6a5}',
+ SC_Lower), ('\u{1d6a8}', '\u{1d6c0}', SC_Upper), ('\u{1d6c2}', '\u{1d6da}', SC_Lower),
+ ('\u{1d6dc}', '\u{1d6e1}', SC_Lower), ('\u{1d6e2}', '\u{1d6fa}', SC_Upper), ('\u{1d6fc}',
+ '\u{1d714}', SC_Lower), ('\u{1d716}', '\u{1d71b}', SC_Lower), ('\u{1d71c}', '\u{1d734}',
+ SC_Upper), ('\u{1d736}', '\u{1d74e}', SC_Lower), ('\u{1d750}', '\u{1d755}', SC_Lower),
+ ('\u{1d756}', '\u{1d76e}', SC_Upper), ('\u{1d770}', '\u{1d788}', SC_Lower), ('\u{1d78a}',
+ '\u{1d78f}', SC_Lower), ('\u{1d790}', '\u{1d7a8}', SC_Upper), ('\u{1d7aa}', '\u{1d7c2}',
+ SC_Lower), ('\u{1d7c4}', '\u{1d7c9}', SC_Lower), ('\u{1d7ca}', '\u{1d7ca}', SC_Upper),
+ ('\u{1d7cb}', '\u{1d7cb}', SC_Lower), ('\u{1d7ce}', '\u{1d7ff}', SC_Numeric), ('\u{1da00}',
+ '\u{1da36}', SC_Extend), ('\u{1da3b}', '\u{1da6c}', SC_Extend), ('\u{1da75}', '\u{1da75}',
+ SC_Extend), ('\u{1da84}', '\u{1da84}', SC_Extend), ('\u{1da88}', '\u{1da88}', SC_STerm),
+ ('\u{1da9b}', '\u{1da9f}', SC_Extend), ('\u{1daa1}', '\u{1daaf}', SC_Extend), ('\u{1df00}',
+ '\u{1df09}', SC_Lower), ('\u{1df0a}', '\u{1df0a}', SC_OLetter), ('\u{1df0b}', '\u{1df1e}',
+ SC_Lower), ('\u{1df25}', '\u{1df2a}', SC_Lower), ('\u{1e000}', '\u{1e006}', SC_Extend),
+ ('\u{1e008}', '\u{1e018}', SC_Extend), ('\u{1e01b}', '\u{1e021}', SC_Extend), ('\u{1e023}',
+ '\u{1e024}', SC_Extend), ('\u{1e026}', '\u{1e02a}', SC_Extend), ('\u{1e030}', '\u{1e06d}',
+ SC_Lower), ('\u{1e08f}', '\u{1e08f}', SC_Extend), ('\u{1e100}', '\u{1e12c}', SC_OLetter),
+ ('\u{1e130}', '\u{1e136}', SC_Extend), ('\u{1e137}', '\u{1e13d}', SC_OLetter), ('\u{1e140}',
+ '\u{1e149}', SC_Numeric), ('\u{1e14e}', '\u{1e14e}', SC_OLetter), ('\u{1e290}', '\u{1e2ad}',
+ SC_OLetter), ('\u{1e2ae}', '\u{1e2ae}', SC_Extend), ('\u{1e2c0}', '\u{1e2eb}', SC_OLetter),
+ ('\u{1e2ec}', '\u{1e2ef}', SC_Extend), ('\u{1e2f0}', '\u{1e2f9}', SC_Numeric), ('\u{1e4d0}',
+ '\u{1e4eb}', SC_OLetter), ('\u{1e4ec}', '\u{1e4ef}', SC_Extend), ('\u{1e4f0}', '\u{1e4f9}',
+ SC_Numeric), ('\u{1e7e0}', '\u{1e7e6}', SC_OLetter), ('\u{1e7e8}', '\u{1e7eb}', SC_OLetter),
+ ('\u{1e7ed}', '\u{1e7ee}', SC_OLetter), ('\u{1e7f0}', '\u{1e7fe}', SC_OLetter),
+ ('\u{1e800}', '\u{1e8c4}', SC_OLetter), ('\u{1e8d0}', '\u{1e8d6}', SC_Extend), ('\u{1e900}',
+ '\u{1e921}', SC_Upper), ('\u{1e922}', '\u{1e943}', SC_Lower), ('\u{1e944}', '\u{1e94a}',
+ SC_Extend), ('\u{1e94b}', '\u{1e94b}', SC_OLetter), ('\u{1e950}', '\u{1e959}', SC_Numeric),
+ ('\u{1ee00}', '\u{1ee03}', SC_OLetter), ('\u{1ee05}', '\u{1ee1f}', SC_OLetter),
+ ('\u{1ee21}', '\u{1ee22}', SC_OLetter), ('\u{1ee24}', '\u{1ee24}', SC_OLetter),
+ ('\u{1ee27}', '\u{1ee27}', SC_OLetter), ('\u{1ee29}', '\u{1ee32}', SC_OLetter),
+ ('\u{1ee34}', '\u{1ee37}', SC_OLetter), ('\u{1ee39}', '\u{1ee39}', SC_OLetter),
+ ('\u{1ee3b}', '\u{1ee3b}', SC_OLetter), ('\u{1ee42}', '\u{1ee42}', SC_OLetter),
+ ('\u{1ee47}', '\u{1ee47}', SC_OLetter), ('\u{1ee49}', '\u{1ee49}', SC_OLetter),
+ ('\u{1ee4b}', '\u{1ee4b}', SC_OLetter), ('\u{1ee4d}', '\u{1ee4f}', SC_OLetter),
+ ('\u{1ee51}', '\u{1ee52}', SC_OLetter), ('\u{1ee54}', '\u{1ee54}', SC_OLetter),
+ ('\u{1ee57}', '\u{1ee57}', SC_OLetter), ('\u{1ee59}', '\u{1ee59}', SC_OLetter),
+ ('\u{1ee5b}', '\u{1ee5b}', SC_OLetter), ('\u{1ee5d}', '\u{1ee5d}', SC_OLetter),
+ ('\u{1ee5f}', '\u{1ee5f}', SC_OLetter), ('\u{1ee61}', '\u{1ee62}', SC_OLetter),
+ ('\u{1ee64}', '\u{1ee64}', SC_OLetter), ('\u{1ee67}', '\u{1ee6a}', SC_OLetter),
+ ('\u{1ee6c}', '\u{1ee72}', SC_OLetter), ('\u{1ee74}', '\u{1ee77}', SC_OLetter),
+ ('\u{1ee79}', '\u{1ee7c}', SC_OLetter), ('\u{1ee7e}', '\u{1ee7e}', SC_OLetter),
+ ('\u{1ee80}', '\u{1ee89}', SC_OLetter), ('\u{1ee8b}', '\u{1ee9b}', SC_OLetter),
+ ('\u{1eea1}', '\u{1eea3}', SC_OLetter), ('\u{1eea5}', '\u{1eea9}', SC_OLetter),
+ ('\u{1eeab}', '\u{1eebb}', SC_OLetter), ('\u{1f130}', '\u{1f149}', SC_Upper), ('\u{1f150}',
+ '\u{1f169}', SC_Upper), ('\u{1f170}', '\u{1f189}', SC_Upper), ('\u{1f676}', '\u{1f678}',
+ SC_Close), ('\u{1fbf0}', '\u{1fbf9}', SC_Numeric), ('\u{20000}', '\u{2a6df}', SC_OLetter),
+ ('\u{2a700}', '\u{2b739}', SC_OLetter), ('\u{2b740}', '\u{2b81d}', SC_OLetter),
+ ('\u{2b820}', '\u{2cea1}', SC_OLetter), ('\u{2ceb0}', '\u{2ebe0}', SC_OLetter),
+ ('\u{2f800}', '\u{2fa1d}', SC_OLetter), ('\u{30000}', '\u{3134a}', SC_OLetter),
+ ('\u{31350}', '\u{323af}', SC_OLetter), ('\u{e0001}', '\u{e0001}', SC_Format), ('\u{e0020}',
+ '\u{e007f}', SC_Extend), ('\u{e0100}', '\u{e01ef}', SC_Extend)
+ ];
+
+}
diff --git a/crates/unicode-segmentation/src/test.rs b/crates/unicode-segmentation/src/test.rs
new file mode 100644
index 0000000..bc642a5
--- /dev/null
+++ b/crates/unicode-segmentation/src/test.rs
@@ -0,0 +1,247 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use super::UnicodeSegmentation;
+
+use std::prelude::v1::*;
+
+#[test]
+fn test_graphemes() {
+ use crate::testdata::{TEST_DIFF, TEST_SAME};
+
+ pub const EXTRA_DIFF: &'static [(
+ &'static str,
+ &'static [&'static str],
+ &'static [&'static str],
+ )] = &[
+ // Official test suite doesn't include two Prepend chars between two other chars.
+ (
+ "\u{20}\u{600}\u{600}\u{20}",
+ &["\u{20}", "\u{600}\u{600}\u{20}"],
+ &["\u{20}", "\u{600}", "\u{600}", "\u{20}"],
+ ),
+ // Test for Prepend followed by two Any chars
+ (
+ "\u{600}\u{20}\u{20}",
+ &["\u{600}\u{20}", "\u{20}"],
+ &["\u{600}", "\u{20}", "\u{20}"],
+ ),
+ ];
+
+ pub const EXTRA_SAME: &'static [(&'static str, &'static [&'static str])] = &[
+ // family emoji (more than two emoji joined by ZWJ)
+ (
+ "\u{1f468}\u{200d}\u{1f467}\u{200d}\u{1f466}",
+ &["\u{1f468}\u{200d}\u{1f467}\u{200d}\u{1f466}"],
+ ),
+ // cartwheel emoji followed by two fitzpatrick skin tone modifiers
+ // (test case from issue #19)
+ (
+ "\u{1F938}\u{1F3FE}\u{1F3FE}",
+ &["\u{1F938}\u{1F3FE}\u{1F3FE}"],
+ ),
+ ];
+
+ for &(s, g) in TEST_SAME.iter().chain(EXTRA_SAME) {
+ // test forward iterator
+ assert!(UnicodeSegmentation::graphemes(s, true).eq(g.iter().cloned()));
+ assert!(UnicodeSegmentation::graphemes(s, false).eq(g.iter().cloned()));
+
+ // test reverse iterator
+ assert!(UnicodeSegmentation::graphemes(s, true)
+ .rev()
+ .eq(g.iter().rev().cloned()));
+ assert!(UnicodeSegmentation::graphemes(s, false)
+ .rev()
+ .eq(g.iter().rev().cloned()));
+ }
+
+ for &(s, gt, gf) in TEST_DIFF.iter().chain(EXTRA_DIFF) {
+ // test forward iterator
+ assert!(UnicodeSegmentation::graphemes(s, true).eq(gt.iter().cloned()));
+ assert!(UnicodeSegmentation::graphemes(s, false).eq(gf.iter().cloned()));
+
+ // test reverse iterator
+ assert!(UnicodeSegmentation::graphemes(s, true)
+ .rev()
+ .eq(gt.iter().rev().cloned()));
+ assert!(UnicodeSegmentation::graphemes(s, false)
+ .rev()
+ .eq(gf.iter().rev().cloned()));
+ }
+
+ // test the indices iterators
+ let s = "a̐éö̲\r\n";
+ let gr_inds = UnicodeSegmentation::grapheme_indices(s, true).collect::<Vec<(usize, &str)>>();
+ let b: &[_] = &[(0, "a̐"), (3, "é"), (6, "ö̲"), (11, "\r\n")];
+ assert_eq!(gr_inds, b);
+ let gr_inds = UnicodeSegmentation::grapheme_indices(s, true)
+ .rev()
+ .collect::<Vec<(usize, &str)>>();
+ let b: &[_] = &[(11, "\r\n"), (6, "ö̲"), (3, "é"), (0, "a̐")];
+ assert_eq!(gr_inds, b);
+ let mut gr_inds_iter = UnicodeSegmentation::grapheme_indices(s, true);
+ {
+ let gr_inds = gr_inds_iter.by_ref();
+ let e1 = gr_inds.size_hint();
+ assert_eq!(e1, (1, Some(13)));
+ let c = gr_inds.count();
+ assert_eq!(c, 4);
+ }
+ let e2 = gr_inds_iter.size_hint();
+ assert_eq!(e2, (0, Some(0)));
+
+ // make sure the reverse iterator does the right thing with "\n" at beginning of string
+ let s = "\n\r\n\r";
+ let gr = UnicodeSegmentation::graphemes(s, true)
+ .rev()
+ .collect::<Vec<&str>>();
+ let b: &[_] = &["\r", "\r\n", "\n"];
+ assert_eq!(gr, b);
+}
+
+#[test]
+fn test_words() {
+ use crate::testdata::TEST_WORD;
+
+ // Unicode's official tests don't really test longer chains of flag emoji
+ // TODO This could be improved with more tests like flag emoji with interspersed Extend chars and ZWJ
+ const EXTRA_TESTS: &'static [(&'static str, &'static [&'static str])] = &[
+ (
+ "🇦🇫🇦🇽🇦🇱🇩🇿🇦🇸🇦🇩🇦🇴",
+ &["🇦🇫", "🇦🇽", "🇦🇱", "🇩🇿", "🇦🇸", "🇦🇩", "🇦🇴"],
+ ),
+ ("🇦🇫🇦🇽🇦🇱🇩🇿🇦🇸🇦🇩🇦", &["🇦🇫", "🇦🇽", "🇦🇱", "🇩🇿", "🇦🇸", "🇦🇩", "🇦"]),
+ (
+ "🇦a🇫🇦🇽a🇦🇱🇩🇿🇦🇸🇦🇩🇦",
+ &["🇦", "a", "🇫🇦", "🇽", "a", "🇦🇱", "🇩🇿", "🇦🇸", "🇦🇩", "🇦"],
+ ),
+ (
+ "\u{1f468}\u{200d}\u{1f468}\u{200d}\u{1f466}",
+ &["\u{1f468}\u{200d}\u{1f468}\u{200d}\u{1f466}"],
+ ),
+ ("😌👎🏼", &["😌", "👎🏼"]),
+ // perhaps wrong, spaces should not be included?
+ ("hello world", &["hello", " ", "world"]),
+ ("🇨🇦🇨🇭🇿🇲🇿 hi", &["🇨🇦", "🇨🇭", "🇿🇲", "🇿", " ", "hi"]),
+ ];
+ for &(s, w) in TEST_WORD.iter().chain(EXTRA_TESTS.iter()) {
+ macro_rules! assert_ {
+ ($test:expr, $exp:expr, $name:expr) => {
+ // collect into vector for better diagnostics in failure case
+ let testing = $test.collect::<Vec<_>>();
+ let expected = $exp.collect::<Vec<_>>();
+ assert_eq!(
+ testing, expected,
+ "{} test for testcase ({:?}, {:?}) failed.",
+ $name, s, w
+ )
+ };
+ }
+ // test forward iterator
+ assert_!(
+ s.split_word_bounds(),
+ w.iter().cloned(),
+ "Forward word boundaries"
+ );
+
+ // test reverse iterator
+ assert_!(
+ s.split_word_bounds().rev(),
+ w.iter().rev().cloned(),
+ "Reverse word boundaries"
+ );
+
+ // generate offsets from word string lengths
+ let mut indices = vec![0];
+ for i in w.iter().cloned().map(|s| s.len()).scan(0, |t, n| {
+ *t += n;
+ Some(*t)
+ }) {
+ indices.push(i);
+ }
+ indices.pop();
+ let indices = indices;
+
+ // test forward indices iterator
+ assert_!(
+ s.split_word_bound_indices().map(|(l, _)| l),
+ indices.iter().cloned(),
+ "Forward word indices"
+ );
+
+ // test backward indices iterator
+ assert_!(
+ s.split_word_bound_indices().rev().map(|(l, _)| l),
+ indices.iter().rev().cloned(),
+ "Reverse word indices"
+ );
+ }
+}
+
+#[test]
+fn test_sentences() {
+ use crate::testdata::TEST_SENTENCE;
+
+ for &(s, w) in TEST_SENTENCE.iter() {
+ macro_rules! assert_ {
+ ($test:expr, $exp:expr, $name:expr) => {
+ // collect into vector for better diagnostics in failure case
+ let testing = $test.collect::<Vec<_>>();
+ let expected = $exp.collect::<Vec<_>>();
+ assert_eq!(
+ testing, expected,
+ "{} test for testcase ({:?}, {:?}) failed.",
+ $name, s, w
+ )
+ };
+ }
+
+ assert_!(
+ s.split_sentence_bounds(),
+ w.iter().cloned(),
+ "Forward sentence boundaries"
+ );
+ }
+}
+
+quickcheck! {
+ fn quickcheck_forward_reverse_graphemes_extended(s: String) -> bool {
+ let a = s.graphemes(true).collect::<Vec<_>>();
+ let mut b = s.graphemes(true).rev().collect::<Vec<_>>();
+ b.reverse();
+ a == b
+ }
+
+ fn quickcheck_forward_reverse_graphemes_legacy(s: String) -> bool {
+ let a = s.graphemes(false).collect::<Vec<_>>();
+ let mut b = s.graphemes(false).rev().collect::<Vec<_>>();
+ b.reverse();
+ a == b
+ }
+
+ fn quickcheck_join_graphemes(s: String) -> bool {
+ let a = s.graphemes(true).collect::<String>();
+ let b = s.graphemes(false).collect::<String>();
+ a == s && b == s
+ }
+
+ fn quickcheck_forward_reverse_words(s: String) -> bool {
+ let a = s.split_word_bounds().collect::<Vec<_>>();
+ let mut b = s.split_word_bounds().rev().collect::<Vec<_>>();
+ b.reverse();
+ a == b
+ }
+
+ fn quickcheck_join_words(s: String) -> bool {
+ let a = s.split_word_bounds().collect::<String>();
+ a == s
+ }
+}
diff --git a/crates/unicode-segmentation/src/testdata.rs b/crates/unicode-segmentation/src/testdata.rs
new file mode 100644
index 0000000..8a675aa
--- /dev/null
+++ b/crates/unicode-segmentation/src/testdata.rs
@@ -0,0 +1,5250 @@
+// Copyright 2012-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+#![allow(missing_docs, non_upper_case_globals, non_snake_case)]
+// official Unicode test data
+// http://www.unicode.org/Public/15.0.0/ucd/auxiliary/GraphemeBreakTest.txt
+pub const TEST_SAME: &'static [(&'static str, &'static [&'static str])] = &[
+ ("\u{20}\u{20}", &["\u{20}", "\u{20}"]),
+ ("\u{20}\u{308}\u{20}", &["\u{20}\u{308}", "\u{20}"]),
+ ("\u{20}\u{d}", &["\u{20}", "\u{d}"]),
+ ("\u{20}\u{308}\u{d}", &["\u{20}\u{308}", "\u{d}"]),
+ ("\u{20}\u{a}", &["\u{20}", "\u{a}"]),
+ ("\u{20}\u{308}\u{a}", &["\u{20}\u{308}", "\u{a}"]),
+ ("\u{20}\u{1}", &["\u{20}", "\u{1}"]),
+ ("\u{20}\u{308}\u{1}", &["\u{20}\u{308}", "\u{1}"]),
+ ("\u{20}\u{34f}", &["\u{20}\u{34f}"]),
+ ("\u{20}\u{308}\u{34f}", &["\u{20}\u{308}\u{34f}"]),
+ ("\u{20}\u{1f1e6}", &["\u{20}", "\u{1f1e6}"]),
+ ("\u{20}\u{308}\u{1f1e6}", &["\u{20}\u{308}", "\u{1f1e6}"]),
+ ("\u{20}\u{600}", &["\u{20}", "\u{600}"]),
+ ("\u{20}\u{308}\u{600}", &["\u{20}\u{308}", "\u{600}"]),
+ ("\u{20}\u{1100}", &["\u{20}", "\u{1100}"]),
+ ("\u{20}\u{308}\u{1100}", &["\u{20}\u{308}", "\u{1100}"]),
+ ("\u{20}\u{1160}", &["\u{20}", "\u{1160}"]),
+ ("\u{20}\u{308}\u{1160}", &["\u{20}\u{308}", "\u{1160}"]),
+ ("\u{20}\u{11a8}", &["\u{20}", "\u{11a8}"]),
+ ("\u{20}\u{308}\u{11a8}", &["\u{20}\u{308}", "\u{11a8}"]),
+ ("\u{20}\u{ac00}", &["\u{20}", "\u{ac00}"]),
+ ("\u{20}\u{308}\u{ac00}", &["\u{20}\u{308}", "\u{ac00}"]),
+ ("\u{20}\u{ac01}", &["\u{20}", "\u{ac01}"]),
+ ("\u{20}\u{308}\u{ac01}", &["\u{20}\u{308}", "\u{ac01}"]),
+ ("\u{20}\u{231a}", &["\u{20}", "\u{231a}"]),
+ ("\u{20}\u{308}\u{231a}", &["\u{20}\u{308}", "\u{231a}"]),
+ ("\u{20}\u{300}", &["\u{20}\u{300}"]),
+ ("\u{20}\u{308}\u{300}", &["\u{20}\u{308}\u{300}"]),
+ ("\u{20}\u{200d}", &["\u{20}\u{200d}"]),
+ ("\u{20}\u{308}\u{200d}", &["\u{20}\u{308}\u{200d}"]),
+ ("\u{20}\u{378}", &["\u{20}", "\u{378}"]),
+ ("\u{20}\u{308}\u{378}", &["\u{20}\u{308}", "\u{378}"]),
+ ("\u{d}\u{20}", &["\u{d}", "\u{20}"]),
+ ("\u{d}\u{308}\u{20}", &["\u{d}", "\u{308}", "\u{20}"]),
+ ("\u{d}\u{d}", &["\u{d}", "\u{d}"]),
+ ("\u{d}\u{308}\u{d}", &["\u{d}", "\u{308}", "\u{d}"]),
+ ("\u{d}\u{a}", &["\u{d}\u{a}"]),
+ ("\u{d}\u{308}\u{a}", &["\u{d}", "\u{308}", "\u{a}"]),
+ ("\u{d}\u{1}", &["\u{d}", "\u{1}"]),
+ ("\u{d}\u{308}\u{1}", &["\u{d}", "\u{308}", "\u{1}"]),
+ ("\u{d}\u{34f}", &["\u{d}", "\u{34f}"]),
+ ("\u{d}\u{308}\u{34f}", &["\u{d}", "\u{308}\u{34f}"]),
+ ("\u{d}\u{1f1e6}", &["\u{d}", "\u{1f1e6}"]),
+ ("\u{d}\u{308}\u{1f1e6}", &["\u{d}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{d}\u{600}", &["\u{d}", "\u{600}"]),
+ ("\u{d}\u{308}\u{600}", &["\u{d}", "\u{308}", "\u{600}"]),
+ ("\u{d}\u{903}", &["\u{d}", "\u{903}"]),
+ ("\u{d}\u{1100}", &["\u{d}", "\u{1100}"]),
+ ("\u{d}\u{308}\u{1100}", &["\u{d}", "\u{308}", "\u{1100}"]),
+ ("\u{d}\u{1160}", &["\u{d}", "\u{1160}"]),
+ ("\u{d}\u{308}\u{1160}", &["\u{d}", "\u{308}", "\u{1160}"]),
+ ("\u{d}\u{11a8}", &["\u{d}", "\u{11a8}"]),
+ ("\u{d}\u{308}\u{11a8}", &["\u{d}", "\u{308}", "\u{11a8}"]),
+ ("\u{d}\u{ac00}", &["\u{d}", "\u{ac00}"]),
+ ("\u{d}\u{308}\u{ac00}", &["\u{d}", "\u{308}", "\u{ac00}"]),
+ ("\u{d}\u{ac01}", &["\u{d}", "\u{ac01}"]),
+ ("\u{d}\u{308}\u{ac01}", &["\u{d}", "\u{308}", "\u{ac01}"]),
+ ("\u{d}\u{231a}", &["\u{d}", "\u{231a}"]),
+ ("\u{d}\u{308}\u{231a}", &["\u{d}", "\u{308}", "\u{231a}"]),
+ ("\u{d}\u{300}", &["\u{d}", "\u{300}"]),
+ ("\u{d}\u{308}\u{300}", &["\u{d}", "\u{308}\u{300}"]),
+ ("\u{d}\u{200d}", &["\u{d}", "\u{200d}"]),
+ ("\u{d}\u{308}\u{200d}", &["\u{d}", "\u{308}\u{200d}"]),
+ ("\u{d}\u{378}", &["\u{d}", "\u{378}"]),
+ ("\u{d}\u{308}\u{378}", &["\u{d}", "\u{308}", "\u{378}"]),
+ ("\u{a}\u{20}", &["\u{a}", "\u{20}"]),
+ ("\u{a}\u{308}\u{20}", &["\u{a}", "\u{308}", "\u{20}"]),
+ ("\u{a}\u{d}", &["\u{a}", "\u{d}"]),
+ ("\u{a}\u{308}\u{d}", &["\u{a}", "\u{308}", "\u{d}"]),
+ ("\u{a}\u{a}", &["\u{a}", "\u{a}"]),
+ ("\u{a}\u{308}\u{a}", &["\u{a}", "\u{308}", "\u{a}"]),
+ ("\u{a}\u{1}", &["\u{a}", "\u{1}"]),
+ ("\u{a}\u{308}\u{1}", &["\u{a}", "\u{308}", "\u{1}"]),
+ ("\u{a}\u{34f}", &["\u{a}", "\u{34f}"]),
+ ("\u{a}\u{308}\u{34f}", &["\u{a}", "\u{308}\u{34f}"]),
+ ("\u{a}\u{1f1e6}", &["\u{a}", "\u{1f1e6}"]),
+ ("\u{a}\u{308}\u{1f1e6}", &["\u{a}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{a}\u{600}", &["\u{a}", "\u{600}"]),
+ ("\u{a}\u{308}\u{600}", &["\u{a}", "\u{308}", "\u{600}"]),
+ ("\u{a}\u{903}", &["\u{a}", "\u{903}"]),
+ ("\u{a}\u{1100}", &["\u{a}", "\u{1100}"]),
+ ("\u{a}\u{308}\u{1100}", &["\u{a}", "\u{308}", "\u{1100}"]),
+ ("\u{a}\u{1160}", &["\u{a}", "\u{1160}"]),
+ ("\u{a}\u{308}\u{1160}", &["\u{a}", "\u{308}", "\u{1160}"]),
+ ("\u{a}\u{11a8}", &["\u{a}", "\u{11a8}"]),
+ ("\u{a}\u{308}\u{11a8}", &["\u{a}", "\u{308}", "\u{11a8}"]),
+ ("\u{a}\u{ac00}", &["\u{a}", "\u{ac00}"]),
+ ("\u{a}\u{308}\u{ac00}", &["\u{a}", "\u{308}", "\u{ac00}"]),
+ ("\u{a}\u{ac01}", &["\u{a}", "\u{ac01}"]),
+ ("\u{a}\u{308}\u{ac01}", &["\u{a}", "\u{308}", "\u{ac01}"]),
+ ("\u{a}\u{231a}", &["\u{a}", "\u{231a}"]),
+ ("\u{a}\u{308}\u{231a}", &["\u{a}", "\u{308}", "\u{231a}"]),
+ ("\u{a}\u{300}", &["\u{a}", "\u{300}"]),
+ ("\u{a}\u{308}\u{300}", &["\u{a}", "\u{308}\u{300}"]),
+ ("\u{a}\u{200d}", &["\u{a}", "\u{200d}"]),
+ ("\u{a}\u{308}\u{200d}", &["\u{a}", "\u{308}\u{200d}"]),
+ ("\u{a}\u{378}", &["\u{a}", "\u{378}"]),
+ ("\u{a}\u{308}\u{378}", &["\u{a}", "\u{308}", "\u{378}"]),
+ ("\u{1}\u{20}", &["\u{1}", "\u{20}"]),
+ ("\u{1}\u{308}\u{20}", &["\u{1}", "\u{308}", "\u{20}"]),
+ ("\u{1}\u{d}", &["\u{1}", "\u{d}"]),
+ ("\u{1}\u{308}\u{d}", &["\u{1}", "\u{308}", "\u{d}"]),
+ ("\u{1}\u{a}", &["\u{1}", "\u{a}"]),
+ ("\u{1}\u{308}\u{a}", &["\u{1}", "\u{308}", "\u{a}"]),
+ ("\u{1}\u{1}", &["\u{1}", "\u{1}"]),
+ ("\u{1}\u{308}\u{1}", &["\u{1}", "\u{308}", "\u{1}"]),
+ ("\u{1}\u{34f}", &["\u{1}", "\u{34f}"]),
+ ("\u{1}\u{308}\u{34f}", &["\u{1}", "\u{308}\u{34f}"]),
+ ("\u{1}\u{1f1e6}", &["\u{1}", "\u{1f1e6}"]),
+ ("\u{1}\u{308}\u{1f1e6}", &["\u{1}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{1}\u{600}", &["\u{1}", "\u{600}"]),
+ ("\u{1}\u{308}\u{600}", &["\u{1}", "\u{308}", "\u{600}"]),
+ ("\u{1}\u{903}", &["\u{1}", "\u{903}"]),
+ ("\u{1}\u{1100}", &["\u{1}", "\u{1100}"]),
+ ("\u{1}\u{308}\u{1100}", &["\u{1}", "\u{308}", "\u{1100}"]),
+ ("\u{1}\u{1160}", &["\u{1}", "\u{1160}"]),
+ ("\u{1}\u{308}\u{1160}", &["\u{1}", "\u{308}", "\u{1160}"]),
+ ("\u{1}\u{11a8}", &["\u{1}", "\u{11a8}"]),
+ ("\u{1}\u{308}\u{11a8}", &["\u{1}", "\u{308}", "\u{11a8}"]),
+ ("\u{1}\u{ac00}", &["\u{1}", "\u{ac00}"]),
+ ("\u{1}\u{308}\u{ac00}", &["\u{1}", "\u{308}", "\u{ac00}"]),
+ ("\u{1}\u{ac01}", &["\u{1}", "\u{ac01}"]),
+ ("\u{1}\u{308}\u{ac01}", &["\u{1}", "\u{308}", "\u{ac01}"]),
+ ("\u{1}\u{231a}", &["\u{1}", "\u{231a}"]),
+ ("\u{1}\u{308}\u{231a}", &["\u{1}", "\u{308}", "\u{231a}"]),
+ ("\u{1}\u{300}", &["\u{1}", "\u{300}"]),
+ ("\u{1}\u{308}\u{300}", &["\u{1}", "\u{308}\u{300}"]),
+ ("\u{1}\u{200d}", &["\u{1}", "\u{200d}"]),
+ ("\u{1}\u{308}\u{200d}", &["\u{1}", "\u{308}\u{200d}"]),
+ ("\u{1}\u{378}", &["\u{1}", "\u{378}"]),
+ ("\u{1}\u{308}\u{378}", &["\u{1}", "\u{308}", "\u{378}"]),
+ ("\u{34f}\u{20}", &["\u{34f}", "\u{20}"]),
+ ("\u{34f}\u{308}\u{20}", &["\u{34f}\u{308}", "\u{20}"]),
+ ("\u{34f}\u{d}", &["\u{34f}", "\u{d}"]),
+ ("\u{34f}\u{308}\u{d}", &["\u{34f}\u{308}", "\u{d}"]),
+ ("\u{34f}\u{a}", &["\u{34f}", "\u{a}"]),
+ ("\u{34f}\u{308}\u{a}", &["\u{34f}\u{308}", "\u{a}"]),
+ ("\u{34f}\u{1}", &["\u{34f}", "\u{1}"]),
+ ("\u{34f}\u{308}\u{1}", &["\u{34f}\u{308}", "\u{1}"]),
+ ("\u{34f}\u{34f}", &["\u{34f}\u{34f}"]),
+ ("\u{34f}\u{308}\u{34f}", &["\u{34f}\u{308}\u{34f}"]),
+ ("\u{34f}\u{1f1e6}", &["\u{34f}", "\u{1f1e6}"]),
+ ("\u{34f}\u{308}\u{1f1e6}", &["\u{34f}\u{308}", "\u{1f1e6}"]),
+ ("\u{34f}\u{600}", &["\u{34f}", "\u{600}"]),
+ ("\u{34f}\u{308}\u{600}", &["\u{34f}\u{308}", "\u{600}"]),
+ ("\u{34f}\u{1100}", &["\u{34f}", "\u{1100}"]),
+ ("\u{34f}\u{308}\u{1100}", &["\u{34f}\u{308}", "\u{1100}"]),
+ ("\u{34f}\u{1160}", &["\u{34f}", "\u{1160}"]),
+ ("\u{34f}\u{308}\u{1160}", &["\u{34f}\u{308}", "\u{1160}"]),
+ ("\u{34f}\u{11a8}", &["\u{34f}", "\u{11a8}"]),
+ ("\u{34f}\u{308}\u{11a8}", &["\u{34f}\u{308}", "\u{11a8}"]),
+ ("\u{34f}\u{ac00}", &["\u{34f}", "\u{ac00}"]),
+ ("\u{34f}\u{308}\u{ac00}", &["\u{34f}\u{308}", "\u{ac00}"]),
+ ("\u{34f}\u{ac01}", &["\u{34f}", "\u{ac01}"]),
+ ("\u{34f}\u{308}\u{ac01}", &["\u{34f}\u{308}", "\u{ac01}"]),
+ ("\u{34f}\u{231a}", &["\u{34f}", "\u{231a}"]),
+ ("\u{34f}\u{308}\u{231a}", &["\u{34f}\u{308}", "\u{231a}"]),
+ ("\u{34f}\u{300}", &["\u{34f}\u{300}"]),
+ ("\u{34f}\u{308}\u{300}", &["\u{34f}\u{308}\u{300}"]),
+ ("\u{34f}\u{200d}", &["\u{34f}\u{200d}"]),
+ ("\u{34f}\u{308}\u{200d}", &["\u{34f}\u{308}\u{200d}"]),
+ ("\u{34f}\u{378}", &["\u{34f}", "\u{378}"]),
+ ("\u{34f}\u{308}\u{378}", &["\u{34f}\u{308}", "\u{378}"]),
+ ("\u{1f1e6}\u{20}", &["\u{1f1e6}", "\u{20}"]),
+ ("\u{1f1e6}\u{308}\u{20}", &["\u{1f1e6}\u{308}", "\u{20}"]),
+ ("\u{1f1e6}\u{d}", &["\u{1f1e6}", "\u{d}"]),
+ ("\u{1f1e6}\u{308}\u{d}", &["\u{1f1e6}\u{308}", "\u{d}"]),
+ ("\u{1f1e6}\u{a}", &["\u{1f1e6}", "\u{a}"]),
+ ("\u{1f1e6}\u{308}\u{a}", &["\u{1f1e6}\u{308}", "\u{a}"]),
+ ("\u{1f1e6}\u{1}", &["\u{1f1e6}", "\u{1}"]),
+ ("\u{1f1e6}\u{308}\u{1}", &["\u{1f1e6}\u{308}", "\u{1}"]),
+ ("\u{1f1e6}\u{34f}", &["\u{1f1e6}\u{34f}"]),
+ ("\u{1f1e6}\u{308}\u{34f}", &["\u{1f1e6}\u{308}\u{34f}"]),
+ ("\u{1f1e6}\u{1f1e6}", &["\u{1f1e6}\u{1f1e6}"]),
+ (
+ "\u{1f1e6}\u{308}\u{1f1e6}",
+ &["\u{1f1e6}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{1f1e6}\u{600}", &["\u{1f1e6}", "\u{600}"]),
+ ("\u{1f1e6}\u{308}\u{600}", &["\u{1f1e6}\u{308}", "\u{600}"]),
+ ("\u{1f1e6}\u{1100}", &["\u{1f1e6}", "\u{1100}"]),
+ (
+ "\u{1f1e6}\u{308}\u{1100}",
+ &["\u{1f1e6}\u{308}", "\u{1100}"],
+ ),
+ ("\u{1f1e6}\u{1160}", &["\u{1f1e6}", "\u{1160}"]),
+ (
+ "\u{1f1e6}\u{308}\u{1160}",
+ &["\u{1f1e6}\u{308}", "\u{1160}"],
+ ),
+ ("\u{1f1e6}\u{11a8}", &["\u{1f1e6}", "\u{11a8}"]),
+ (
+ "\u{1f1e6}\u{308}\u{11a8}",
+ &["\u{1f1e6}\u{308}", "\u{11a8}"],
+ ),
+ ("\u{1f1e6}\u{ac00}", &["\u{1f1e6}", "\u{ac00}"]),
+ (
+ "\u{1f1e6}\u{308}\u{ac00}",
+ &["\u{1f1e6}\u{308}", "\u{ac00}"],
+ ),
+ ("\u{1f1e6}\u{ac01}", &["\u{1f1e6}", "\u{ac01}"]),
+ (
+ "\u{1f1e6}\u{308}\u{ac01}",
+ &["\u{1f1e6}\u{308}", "\u{ac01}"],
+ ),
+ ("\u{1f1e6}\u{231a}", &["\u{1f1e6}", "\u{231a}"]),
+ (
+ "\u{1f1e6}\u{308}\u{231a}",
+ &["\u{1f1e6}\u{308}", "\u{231a}"],
+ ),
+ ("\u{1f1e6}\u{300}", &["\u{1f1e6}\u{300}"]),
+ ("\u{1f1e6}\u{308}\u{300}", &["\u{1f1e6}\u{308}\u{300}"]),
+ ("\u{1f1e6}\u{200d}", &["\u{1f1e6}\u{200d}"]),
+ ("\u{1f1e6}\u{308}\u{200d}", &["\u{1f1e6}\u{308}\u{200d}"]),
+ ("\u{1f1e6}\u{378}", &["\u{1f1e6}", "\u{378}"]),
+ ("\u{1f1e6}\u{308}\u{378}", &["\u{1f1e6}\u{308}", "\u{378}"]),
+ ("\u{600}\u{308}\u{20}", &["\u{600}\u{308}", "\u{20}"]),
+ ("\u{600}\u{d}", &["\u{600}", "\u{d}"]),
+ ("\u{600}\u{308}\u{d}", &["\u{600}\u{308}", "\u{d}"]),
+ ("\u{600}\u{a}", &["\u{600}", "\u{a}"]),
+ ("\u{600}\u{308}\u{a}", &["\u{600}\u{308}", "\u{a}"]),
+ ("\u{600}\u{1}", &["\u{600}", "\u{1}"]),
+ ("\u{600}\u{308}\u{1}", &["\u{600}\u{308}", "\u{1}"]),
+ ("\u{600}\u{34f}", &["\u{600}\u{34f}"]),
+ ("\u{600}\u{308}\u{34f}", &["\u{600}\u{308}\u{34f}"]),
+ ("\u{600}\u{308}\u{1f1e6}", &["\u{600}\u{308}", "\u{1f1e6}"]),
+ ("\u{600}\u{308}\u{600}", &["\u{600}\u{308}", "\u{600}"]),
+ ("\u{600}\u{308}\u{1100}", &["\u{600}\u{308}", "\u{1100}"]),
+ ("\u{600}\u{308}\u{1160}", &["\u{600}\u{308}", "\u{1160}"]),
+ ("\u{600}\u{308}\u{11a8}", &["\u{600}\u{308}", "\u{11a8}"]),
+ ("\u{600}\u{308}\u{ac00}", &["\u{600}\u{308}", "\u{ac00}"]),
+ ("\u{600}\u{308}\u{ac01}", &["\u{600}\u{308}", "\u{ac01}"]),
+ ("\u{600}\u{308}\u{231a}", &["\u{600}\u{308}", "\u{231a}"]),
+ ("\u{600}\u{300}", &["\u{600}\u{300}"]),
+ ("\u{600}\u{308}\u{300}", &["\u{600}\u{308}\u{300}"]),
+ ("\u{600}\u{200d}", &["\u{600}\u{200d}"]),
+ ("\u{600}\u{308}\u{200d}", &["\u{600}\u{308}\u{200d}"]),
+ ("\u{600}\u{308}\u{378}", &["\u{600}\u{308}", "\u{378}"]),
+ ("\u{903}\u{20}", &["\u{903}", "\u{20}"]),
+ ("\u{903}\u{308}\u{20}", &["\u{903}\u{308}", "\u{20}"]),
+ ("\u{903}\u{d}", &["\u{903}", "\u{d}"]),
+ ("\u{903}\u{308}\u{d}", &["\u{903}\u{308}", "\u{d}"]),
+ ("\u{903}\u{a}", &["\u{903}", "\u{a}"]),
+ ("\u{903}\u{308}\u{a}", &["\u{903}\u{308}", "\u{a}"]),
+ ("\u{903}\u{1}", &["\u{903}", "\u{1}"]),
+ ("\u{903}\u{308}\u{1}", &["\u{903}\u{308}", "\u{1}"]),
+ ("\u{903}\u{34f}", &["\u{903}\u{34f}"]),
+ ("\u{903}\u{308}\u{34f}", &["\u{903}\u{308}\u{34f}"]),
+ ("\u{903}\u{1f1e6}", &["\u{903}", "\u{1f1e6}"]),
+ ("\u{903}\u{308}\u{1f1e6}", &["\u{903}\u{308}", "\u{1f1e6}"]),
+ ("\u{903}\u{600}", &["\u{903}", "\u{600}"]),
+ ("\u{903}\u{308}\u{600}", &["\u{903}\u{308}", "\u{600}"]),
+ ("\u{903}\u{1100}", &["\u{903}", "\u{1100}"]),
+ ("\u{903}\u{308}\u{1100}", &["\u{903}\u{308}", "\u{1100}"]),
+ ("\u{903}\u{1160}", &["\u{903}", "\u{1160}"]),
+ ("\u{903}\u{308}\u{1160}", &["\u{903}\u{308}", "\u{1160}"]),
+ ("\u{903}\u{11a8}", &["\u{903}", "\u{11a8}"]),
+ ("\u{903}\u{308}\u{11a8}", &["\u{903}\u{308}", "\u{11a8}"]),
+ ("\u{903}\u{ac00}", &["\u{903}", "\u{ac00}"]),
+ ("\u{903}\u{308}\u{ac00}", &["\u{903}\u{308}", "\u{ac00}"]),
+ ("\u{903}\u{ac01}", &["\u{903}", "\u{ac01}"]),
+ ("\u{903}\u{308}\u{ac01}", &["\u{903}\u{308}", "\u{ac01}"]),
+ ("\u{903}\u{231a}", &["\u{903}", "\u{231a}"]),
+ ("\u{903}\u{308}\u{231a}", &["\u{903}\u{308}", "\u{231a}"]),
+ ("\u{903}\u{300}", &["\u{903}\u{300}"]),
+ ("\u{903}\u{308}\u{300}", &["\u{903}\u{308}\u{300}"]),
+ ("\u{903}\u{200d}", &["\u{903}\u{200d}"]),
+ ("\u{903}\u{308}\u{200d}", &["\u{903}\u{308}\u{200d}"]),
+ ("\u{903}\u{378}", &["\u{903}", "\u{378}"]),
+ ("\u{903}\u{308}\u{378}", &["\u{903}\u{308}", "\u{378}"]),
+ ("\u{1100}\u{20}", &["\u{1100}", "\u{20}"]),
+ ("\u{1100}\u{308}\u{20}", &["\u{1100}\u{308}", "\u{20}"]),
+ ("\u{1100}\u{d}", &["\u{1100}", "\u{d}"]),
+ ("\u{1100}\u{308}\u{d}", &["\u{1100}\u{308}", "\u{d}"]),
+ ("\u{1100}\u{a}", &["\u{1100}", "\u{a}"]),
+ ("\u{1100}\u{308}\u{a}", &["\u{1100}\u{308}", "\u{a}"]),
+ ("\u{1100}\u{1}", &["\u{1100}", "\u{1}"]),
+ ("\u{1100}\u{308}\u{1}", &["\u{1100}\u{308}", "\u{1}"]),
+ ("\u{1100}\u{34f}", &["\u{1100}\u{34f}"]),
+ ("\u{1100}\u{308}\u{34f}", &["\u{1100}\u{308}\u{34f}"]),
+ ("\u{1100}\u{1f1e6}", &["\u{1100}", "\u{1f1e6}"]),
+ (
+ "\u{1100}\u{308}\u{1f1e6}",
+ &["\u{1100}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{1100}\u{600}", &["\u{1100}", "\u{600}"]),
+ ("\u{1100}\u{308}\u{600}", &["\u{1100}\u{308}", "\u{600}"]),
+ ("\u{1100}\u{1100}", &["\u{1100}\u{1100}"]),
+ ("\u{1100}\u{308}\u{1100}", &["\u{1100}\u{308}", "\u{1100}"]),
+ ("\u{1100}\u{1160}", &["\u{1100}\u{1160}"]),
+ ("\u{1100}\u{308}\u{1160}", &["\u{1100}\u{308}", "\u{1160}"]),
+ ("\u{1100}\u{11a8}", &["\u{1100}", "\u{11a8}"]),
+ ("\u{1100}\u{308}\u{11a8}", &["\u{1100}\u{308}", "\u{11a8}"]),
+ ("\u{1100}\u{ac00}", &["\u{1100}\u{ac00}"]),
+ ("\u{1100}\u{308}\u{ac00}", &["\u{1100}\u{308}", "\u{ac00}"]),
+ ("\u{1100}\u{ac01}", &["\u{1100}\u{ac01}"]),
+ ("\u{1100}\u{308}\u{ac01}", &["\u{1100}\u{308}", "\u{ac01}"]),
+ ("\u{1100}\u{231a}", &["\u{1100}", "\u{231a}"]),
+ ("\u{1100}\u{308}\u{231a}", &["\u{1100}\u{308}", "\u{231a}"]),
+ ("\u{1100}\u{300}", &["\u{1100}\u{300}"]),
+ ("\u{1100}\u{308}\u{300}", &["\u{1100}\u{308}\u{300}"]),
+ ("\u{1100}\u{200d}", &["\u{1100}\u{200d}"]),
+ ("\u{1100}\u{308}\u{200d}", &["\u{1100}\u{308}\u{200d}"]),
+ ("\u{1100}\u{378}", &["\u{1100}", "\u{378}"]),
+ ("\u{1100}\u{308}\u{378}", &["\u{1100}\u{308}", "\u{378}"]),
+ ("\u{1160}\u{20}", &["\u{1160}", "\u{20}"]),
+ ("\u{1160}\u{308}\u{20}", &["\u{1160}\u{308}", "\u{20}"]),
+ ("\u{1160}\u{d}", &["\u{1160}", "\u{d}"]),
+ ("\u{1160}\u{308}\u{d}", &["\u{1160}\u{308}", "\u{d}"]),
+ ("\u{1160}\u{a}", &["\u{1160}", "\u{a}"]),
+ ("\u{1160}\u{308}\u{a}", &["\u{1160}\u{308}", "\u{a}"]),
+ ("\u{1160}\u{1}", &["\u{1160}", "\u{1}"]),
+ ("\u{1160}\u{308}\u{1}", &["\u{1160}\u{308}", "\u{1}"]),
+ ("\u{1160}\u{34f}", &["\u{1160}\u{34f}"]),
+ ("\u{1160}\u{308}\u{34f}", &["\u{1160}\u{308}\u{34f}"]),
+ ("\u{1160}\u{1f1e6}", &["\u{1160}", "\u{1f1e6}"]),
+ (
+ "\u{1160}\u{308}\u{1f1e6}",
+ &["\u{1160}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{1160}\u{600}", &["\u{1160}", "\u{600}"]),
+ ("\u{1160}\u{308}\u{600}", &["\u{1160}\u{308}", "\u{600}"]),
+ ("\u{1160}\u{1100}", &["\u{1160}", "\u{1100}"]),
+ ("\u{1160}\u{308}\u{1100}", &["\u{1160}\u{308}", "\u{1100}"]),
+ ("\u{1160}\u{1160}", &["\u{1160}\u{1160}"]),
+ ("\u{1160}\u{308}\u{1160}", &["\u{1160}\u{308}", "\u{1160}"]),
+ ("\u{1160}\u{11a8}", &["\u{1160}\u{11a8}"]),
+ ("\u{1160}\u{308}\u{11a8}", &["\u{1160}\u{308}", "\u{11a8}"]),
+ ("\u{1160}\u{ac00}", &["\u{1160}", "\u{ac00}"]),
+ ("\u{1160}\u{308}\u{ac00}", &["\u{1160}\u{308}", "\u{ac00}"]),
+ ("\u{1160}\u{ac01}", &["\u{1160}", "\u{ac01}"]),
+ ("\u{1160}\u{308}\u{ac01}", &["\u{1160}\u{308}", "\u{ac01}"]),
+ ("\u{1160}\u{231a}", &["\u{1160}", "\u{231a}"]),
+ ("\u{1160}\u{308}\u{231a}", &["\u{1160}\u{308}", "\u{231a}"]),
+ ("\u{1160}\u{300}", &["\u{1160}\u{300}"]),
+ ("\u{1160}\u{308}\u{300}", &["\u{1160}\u{308}\u{300}"]),
+ ("\u{1160}\u{200d}", &["\u{1160}\u{200d}"]),
+ ("\u{1160}\u{308}\u{200d}", &["\u{1160}\u{308}\u{200d}"]),
+ ("\u{1160}\u{378}", &["\u{1160}", "\u{378}"]),
+ ("\u{1160}\u{308}\u{378}", &["\u{1160}\u{308}", "\u{378}"]),
+ ("\u{11a8}\u{20}", &["\u{11a8}", "\u{20}"]),
+ ("\u{11a8}\u{308}\u{20}", &["\u{11a8}\u{308}", "\u{20}"]),
+ ("\u{11a8}\u{d}", &["\u{11a8}", "\u{d}"]),
+ ("\u{11a8}\u{308}\u{d}", &["\u{11a8}\u{308}", "\u{d}"]),
+ ("\u{11a8}\u{a}", &["\u{11a8}", "\u{a}"]),
+ ("\u{11a8}\u{308}\u{a}", &["\u{11a8}\u{308}", "\u{a}"]),
+ ("\u{11a8}\u{1}", &["\u{11a8}", "\u{1}"]),
+ ("\u{11a8}\u{308}\u{1}", &["\u{11a8}\u{308}", "\u{1}"]),
+ ("\u{11a8}\u{34f}", &["\u{11a8}\u{34f}"]),
+ ("\u{11a8}\u{308}\u{34f}", &["\u{11a8}\u{308}\u{34f}"]),
+ ("\u{11a8}\u{1f1e6}", &["\u{11a8}", "\u{1f1e6}"]),
+ (
+ "\u{11a8}\u{308}\u{1f1e6}",
+ &["\u{11a8}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{11a8}\u{600}", &["\u{11a8}", "\u{600}"]),
+ ("\u{11a8}\u{308}\u{600}", &["\u{11a8}\u{308}", "\u{600}"]),
+ ("\u{11a8}\u{1100}", &["\u{11a8}", "\u{1100}"]),
+ ("\u{11a8}\u{308}\u{1100}", &["\u{11a8}\u{308}", "\u{1100}"]),
+ ("\u{11a8}\u{1160}", &["\u{11a8}", "\u{1160}"]),
+ ("\u{11a8}\u{308}\u{1160}", &["\u{11a8}\u{308}", "\u{1160}"]),
+ ("\u{11a8}\u{11a8}", &["\u{11a8}\u{11a8}"]),
+ ("\u{11a8}\u{308}\u{11a8}", &["\u{11a8}\u{308}", "\u{11a8}"]),
+ ("\u{11a8}\u{ac00}", &["\u{11a8}", "\u{ac00}"]),
+ ("\u{11a8}\u{308}\u{ac00}", &["\u{11a8}\u{308}", "\u{ac00}"]),
+ ("\u{11a8}\u{ac01}", &["\u{11a8}", "\u{ac01}"]),
+ ("\u{11a8}\u{308}\u{ac01}", &["\u{11a8}\u{308}", "\u{ac01}"]),
+ ("\u{11a8}\u{231a}", &["\u{11a8}", "\u{231a}"]),
+ ("\u{11a8}\u{308}\u{231a}", &["\u{11a8}\u{308}", "\u{231a}"]),
+ ("\u{11a8}\u{300}", &["\u{11a8}\u{300}"]),
+ ("\u{11a8}\u{308}\u{300}", &["\u{11a8}\u{308}\u{300}"]),
+ ("\u{11a8}\u{200d}", &["\u{11a8}\u{200d}"]),
+ ("\u{11a8}\u{308}\u{200d}", &["\u{11a8}\u{308}\u{200d}"]),
+ ("\u{11a8}\u{378}", &["\u{11a8}", "\u{378}"]),
+ ("\u{11a8}\u{308}\u{378}", &["\u{11a8}\u{308}", "\u{378}"]),
+ ("\u{ac00}\u{20}", &["\u{ac00}", "\u{20}"]),
+ ("\u{ac00}\u{308}\u{20}", &["\u{ac00}\u{308}", "\u{20}"]),
+ ("\u{ac00}\u{d}", &["\u{ac00}", "\u{d}"]),
+ ("\u{ac00}\u{308}\u{d}", &["\u{ac00}\u{308}", "\u{d}"]),
+ ("\u{ac00}\u{a}", &["\u{ac00}", "\u{a}"]),
+ ("\u{ac00}\u{308}\u{a}", &["\u{ac00}\u{308}", "\u{a}"]),
+ ("\u{ac00}\u{1}", &["\u{ac00}", "\u{1}"]),
+ ("\u{ac00}\u{308}\u{1}", &["\u{ac00}\u{308}", "\u{1}"]),
+ ("\u{ac00}\u{34f}", &["\u{ac00}\u{34f}"]),
+ ("\u{ac00}\u{308}\u{34f}", &["\u{ac00}\u{308}\u{34f}"]),
+ ("\u{ac00}\u{1f1e6}", &["\u{ac00}", "\u{1f1e6}"]),
+ (
+ "\u{ac00}\u{308}\u{1f1e6}",
+ &["\u{ac00}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{ac00}\u{600}", &["\u{ac00}", "\u{600}"]),
+ ("\u{ac00}\u{308}\u{600}", &["\u{ac00}\u{308}", "\u{600}"]),
+ ("\u{ac00}\u{1100}", &["\u{ac00}", "\u{1100}"]),
+ ("\u{ac00}\u{308}\u{1100}", &["\u{ac00}\u{308}", "\u{1100}"]),
+ ("\u{ac00}\u{1160}", &["\u{ac00}\u{1160}"]),
+ ("\u{ac00}\u{308}\u{1160}", &["\u{ac00}\u{308}", "\u{1160}"]),
+ ("\u{ac00}\u{11a8}", &["\u{ac00}\u{11a8}"]),
+ ("\u{ac00}\u{308}\u{11a8}", &["\u{ac00}\u{308}", "\u{11a8}"]),
+ ("\u{ac00}\u{ac00}", &["\u{ac00}", "\u{ac00}"]),
+ ("\u{ac00}\u{308}\u{ac00}", &["\u{ac00}\u{308}", "\u{ac00}"]),
+ ("\u{ac00}\u{ac01}", &["\u{ac00}", "\u{ac01}"]),
+ ("\u{ac00}\u{308}\u{ac01}", &["\u{ac00}\u{308}", "\u{ac01}"]),
+ ("\u{ac00}\u{231a}", &["\u{ac00}", "\u{231a}"]),
+ ("\u{ac00}\u{308}\u{231a}", &["\u{ac00}\u{308}", "\u{231a}"]),
+ ("\u{ac00}\u{300}", &["\u{ac00}\u{300}"]),
+ ("\u{ac00}\u{308}\u{300}", &["\u{ac00}\u{308}\u{300}"]),
+ ("\u{ac00}\u{200d}", &["\u{ac00}\u{200d}"]),
+ ("\u{ac00}\u{308}\u{200d}", &["\u{ac00}\u{308}\u{200d}"]),
+ ("\u{ac00}\u{378}", &["\u{ac00}", "\u{378}"]),
+ ("\u{ac00}\u{308}\u{378}", &["\u{ac00}\u{308}", "\u{378}"]),
+ ("\u{ac01}\u{20}", &["\u{ac01}", "\u{20}"]),
+ ("\u{ac01}\u{308}\u{20}", &["\u{ac01}\u{308}", "\u{20}"]),
+ ("\u{ac01}\u{d}", &["\u{ac01}", "\u{d}"]),
+ ("\u{ac01}\u{308}\u{d}", &["\u{ac01}\u{308}", "\u{d}"]),
+ ("\u{ac01}\u{a}", &["\u{ac01}", "\u{a}"]),
+ ("\u{ac01}\u{308}\u{a}", &["\u{ac01}\u{308}", "\u{a}"]),
+ ("\u{ac01}\u{1}", &["\u{ac01}", "\u{1}"]),
+ ("\u{ac01}\u{308}\u{1}", &["\u{ac01}\u{308}", "\u{1}"]),
+ ("\u{ac01}\u{34f}", &["\u{ac01}\u{34f}"]),
+ ("\u{ac01}\u{308}\u{34f}", &["\u{ac01}\u{308}\u{34f}"]),
+ ("\u{ac01}\u{1f1e6}", &["\u{ac01}", "\u{1f1e6}"]),
+ (
+ "\u{ac01}\u{308}\u{1f1e6}",
+ &["\u{ac01}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{ac01}\u{600}", &["\u{ac01}", "\u{600}"]),
+ ("\u{ac01}\u{308}\u{600}", &["\u{ac01}\u{308}", "\u{600}"]),
+ ("\u{ac01}\u{1100}", &["\u{ac01}", "\u{1100}"]),
+ ("\u{ac01}\u{308}\u{1100}", &["\u{ac01}\u{308}", "\u{1100}"]),
+ ("\u{ac01}\u{1160}", &["\u{ac01}", "\u{1160}"]),
+ ("\u{ac01}\u{308}\u{1160}", &["\u{ac01}\u{308}", "\u{1160}"]),
+ ("\u{ac01}\u{11a8}", &["\u{ac01}\u{11a8}"]),
+ ("\u{ac01}\u{308}\u{11a8}", &["\u{ac01}\u{308}", "\u{11a8}"]),
+ ("\u{ac01}\u{ac00}", &["\u{ac01}", "\u{ac00}"]),
+ ("\u{ac01}\u{308}\u{ac00}", &["\u{ac01}\u{308}", "\u{ac00}"]),
+ ("\u{ac01}\u{ac01}", &["\u{ac01}", "\u{ac01}"]),
+ ("\u{ac01}\u{308}\u{ac01}", &["\u{ac01}\u{308}", "\u{ac01}"]),
+ ("\u{ac01}\u{231a}", &["\u{ac01}", "\u{231a}"]),
+ ("\u{ac01}\u{308}\u{231a}", &["\u{ac01}\u{308}", "\u{231a}"]),
+ ("\u{ac01}\u{300}", &["\u{ac01}\u{300}"]),
+ ("\u{ac01}\u{308}\u{300}", &["\u{ac01}\u{308}\u{300}"]),
+ ("\u{ac01}\u{200d}", &["\u{ac01}\u{200d}"]),
+ ("\u{ac01}\u{308}\u{200d}", &["\u{ac01}\u{308}\u{200d}"]),
+ ("\u{ac01}\u{378}", &["\u{ac01}", "\u{378}"]),
+ ("\u{ac01}\u{308}\u{378}", &["\u{ac01}\u{308}", "\u{378}"]),
+ ("\u{231a}\u{20}", &["\u{231a}", "\u{20}"]),
+ ("\u{231a}\u{308}\u{20}", &["\u{231a}\u{308}", "\u{20}"]),
+ ("\u{231a}\u{d}", &["\u{231a}", "\u{d}"]),
+ ("\u{231a}\u{308}\u{d}", &["\u{231a}\u{308}", "\u{d}"]),
+ ("\u{231a}\u{a}", &["\u{231a}", "\u{a}"]),
+ ("\u{231a}\u{308}\u{a}", &["\u{231a}\u{308}", "\u{a}"]),
+ ("\u{231a}\u{1}", &["\u{231a}", "\u{1}"]),
+ ("\u{231a}\u{308}\u{1}", &["\u{231a}\u{308}", "\u{1}"]),
+ ("\u{231a}\u{34f}", &["\u{231a}\u{34f}"]),
+ ("\u{231a}\u{308}\u{34f}", &["\u{231a}\u{308}\u{34f}"]),
+ ("\u{231a}\u{1f1e6}", &["\u{231a}", "\u{1f1e6}"]),
+ (
+ "\u{231a}\u{308}\u{1f1e6}",
+ &["\u{231a}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{231a}\u{600}", &["\u{231a}", "\u{600}"]),
+ ("\u{231a}\u{308}\u{600}", &["\u{231a}\u{308}", "\u{600}"]),
+ ("\u{231a}\u{1100}", &["\u{231a}", "\u{1100}"]),
+ ("\u{231a}\u{308}\u{1100}", &["\u{231a}\u{308}", "\u{1100}"]),
+ ("\u{231a}\u{1160}", &["\u{231a}", "\u{1160}"]),
+ ("\u{231a}\u{308}\u{1160}", &["\u{231a}\u{308}", "\u{1160}"]),
+ ("\u{231a}\u{11a8}", &["\u{231a}", "\u{11a8}"]),
+ ("\u{231a}\u{308}\u{11a8}", &["\u{231a}\u{308}", "\u{11a8}"]),
+ ("\u{231a}\u{ac00}", &["\u{231a}", "\u{ac00}"]),
+ ("\u{231a}\u{308}\u{ac00}", &["\u{231a}\u{308}", "\u{ac00}"]),
+ ("\u{231a}\u{ac01}", &["\u{231a}", "\u{ac01}"]),
+ ("\u{231a}\u{308}\u{ac01}", &["\u{231a}\u{308}", "\u{ac01}"]),
+ ("\u{231a}\u{231a}", &["\u{231a}", "\u{231a}"]),
+ ("\u{231a}\u{308}\u{231a}", &["\u{231a}\u{308}", "\u{231a}"]),
+ ("\u{231a}\u{300}", &["\u{231a}\u{300}"]),
+ ("\u{231a}\u{308}\u{300}", &["\u{231a}\u{308}\u{300}"]),
+ ("\u{231a}\u{200d}", &["\u{231a}\u{200d}"]),
+ ("\u{231a}\u{308}\u{200d}", &["\u{231a}\u{308}\u{200d}"]),
+ ("\u{231a}\u{378}", &["\u{231a}", "\u{378}"]),
+ ("\u{231a}\u{308}\u{378}", &["\u{231a}\u{308}", "\u{378}"]),
+ ("\u{300}\u{20}", &["\u{300}", "\u{20}"]),
+ ("\u{300}\u{308}\u{20}", &["\u{300}\u{308}", "\u{20}"]),
+ ("\u{300}\u{d}", &["\u{300}", "\u{d}"]),
+ ("\u{300}\u{308}\u{d}", &["\u{300}\u{308}", "\u{d}"]),
+ ("\u{300}\u{a}", &["\u{300}", "\u{a}"]),
+ ("\u{300}\u{308}\u{a}", &["\u{300}\u{308}", "\u{a}"]),
+ ("\u{300}\u{1}", &["\u{300}", "\u{1}"]),
+ ("\u{300}\u{308}\u{1}", &["\u{300}\u{308}", "\u{1}"]),
+ ("\u{300}\u{34f}", &["\u{300}\u{34f}"]),
+ ("\u{300}\u{308}\u{34f}", &["\u{300}\u{308}\u{34f}"]),
+ ("\u{300}\u{1f1e6}", &["\u{300}", "\u{1f1e6}"]),
+ ("\u{300}\u{308}\u{1f1e6}", &["\u{300}\u{308}", "\u{1f1e6}"]),
+ ("\u{300}\u{600}", &["\u{300}", "\u{600}"]),
+ ("\u{300}\u{308}\u{600}", &["\u{300}\u{308}", "\u{600}"]),
+ ("\u{300}\u{1100}", &["\u{300}", "\u{1100}"]),
+ ("\u{300}\u{308}\u{1100}", &["\u{300}\u{308}", "\u{1100}"]),
+ ("\u{300}\u{1160}", &["\u{300}", "\u{1160}"]),
+ ("\u{300}\u{308}\u{1160}", &["\u{300}\u{308}", "\u{1160}"]),
+ ("\u{300}\u{11a8}", &["\u{300}", "\u{11a8}"]),
+ ("\u{300}\u{308}\u{11a8}", &["\u{300}\u{308}", "\u{11a8}"]),
+ ("\u{300}\u{ac00}", &["\u{300}", "\u{ac00}"]),
+ ("\u{300}\u{308}\u{ac00}", &["\u{300}\u{308}", "\u{ac00}"]),
+ ("\u{300}\u{ac01}", &["\u{300}", "\u{ac01}"]),
+ ("\u{300}\u{308}\u{ac01}", &["\u{300}\u{308}", "\u{ac01}"]),
+ ("\u{300}\u{231a}", &["\u{300}", "\u{231a}"]),
+ ("\u{300}\u{308}\u{231a}", &["\u{300}\u{308}", "\u{231a}"]),
+ ("\u{300}\u{300}", &["\u{300}\u{300}"]),
+ ("\u{300}\u{308}\u{300}", &["\u{300}\u{308}\u{300}"]),
+ ("\u{300}\u{200d}", &["\u{300}\u{200d}"]),
+ ("\u{300}\u{308}\u{200d}", &["\u{300}\u{308}\u{200d}"]),
+ ("\u{300}\u{378}", &["\u{300}", "\u{378}"]),
+ ("\u{300}\u{308}\u{378}", &["\u{300}\u{308}", "\u{378}"]),
+ ("\u{200d}\u{20}", &["\u{200d}", "\u{20}"]),
+ ("\u{200d}\u{308}\u{20}", &["\u{200d}\u{308}", "\u{20}"]),
+ ("\u{200d}\u{d}", &["\u{200d}", "\u{d}"]),
+ ("\u{200d}\u{308}\u{d}", &["\u{200d}\u{308}", "\u{d}"]),
+ ("\u{200d}\u{a}", &["\u{200d}", "\u{a}"]),
+ ("\u{200d}\u{308}\u{a}", &["\u{200d}\u{308}", "\u{a}"]),
+ ("\u{200d}\u{1}", &["\u{200d}", "\u{1}"]),
+ ("\u{200d}\u{308}\u{1}", &["\u{200d}\u{308}", "\u{1}"]),
+ ("\u{200d}\u{34f}", &["\u{200d}\u{34f}"]),
+ ("\u{200d}\u{308}\u{34f}", &["\u{200d}\u{308}\u{34f}"]),
+ ("\u{200d}\u{1f1e6}", &["\u{200d}", "\u{1f1e6}"]),
+ (
+ "\u{200d}\u{308}\u{1f1e6}",
+ &["\u{200d}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{200d}\u{600}", &["\u{200d}", "\u{600}"]),
+ ("\u{200d}\u{308}\u{600}", &["\u{200d}\u{308}", "\u{600}"]),
+ ("\u{200d}\u{1100}", &["\u{200d}", "\u{1100}"]),
+ ("\u{200d}\u{308}\u{1100}", &["\u{200d}\u{308}", "\u{1100}"]),
+ ("\u{200d}\u{1160}", &["\u{200d}", "\u{1160}"]),
+ ("\u{200d}\u{308}\u{1160}", &["\u{200d}\u{308}", "\u{1160}"]),
+ ("\u{200d}\u{11a8}", &["\u{200d}", "\u{11a8}"]),
+ ("\u{200d}\u{308}\u{11a8}", &["\u{200d}\u{308}", "\u{11a8}"]),
+ ("\u{200d}\u{ac00}", &["\u{200d}", "\u{ac00}"]),
+ ("\u{200d}\u{308}\u{ac00}", &["\u{200d}\u{308}", "\u{ac00}"]),
+ ("\u{200d}\u{ac01}", &["\u{200d}", "\u{ac01}"]),
+ ("\u{200d}\u{308}\u{ac01}", &["\u{200d}\u{308}", "\u{ac01}"]),
+ ("\u{200d}\u{231a}", &["\u{200d}", "\u{231a}"]),
+ ("\u{200d}\u{308}\u{231a}", &["\u{200d}\u{308}", "\u{231a}"]),
+ ("\u{200d}\u{300}", &["\u{200d}\u{300}"]),
+ ("\u{200d}\u{308}\u{300}", &["\u{200d}\u{308}\u{300}"]),
+ ("\u{200d}\u{200d}", &["\u{200d}\u{200d}"]),
+ ("\u{200d}\u{308}\u{200d}", &["\u{200d}\u{308}\u{200d}"]),
+ ("\u{200d}\u{378}", &["\u{200d}", "\u{378}"]),
+ ("\u{200d}\u{308}\u{378}", &["\u{200d}\u{308}", "\u{378}"]),
+ ("\u{378}\u{20}", &["\u{378}", "\u{20}"]),
+ ("\u{378}\u{308}\u{20}", &["\u{378}\u{308}", "\u{20}"]),
+ ("\u{378}\u{d}", &["\u{378}", "\u{d}"]),
+ ("\u{378}\u{308}\u{d}", &["\u{378}\u{308}", "\u{d}"]),
+ ("\u{378}\u{a}", &["\u{378}", "\u{a}"]),
+ ("\u{378}\u{308}\u{a}", &["\u{378}\u{308}", "\u{a}"]),
+ ("\u{378}\u{1}", &["\u{378}", "\u{1}"]),
+ ("\u{378}\u{308}\u{1}", &["\u{378}\u{308}", "\u{1}"]),
+ ("\u{378}\u{34f}", &["\u{378}\u{34f}"]),
+ ("\u{378}\u{308}\u{34f}", &["\u{378}\u{308}\u{34f}"]),
+ ("\u{378}\u{1f1e6}", &["\u{378}", "\u{1f1e6}"]),
+ ("\u{378}\u{308}\u{1f1e6}", &["\u{378}\u{308}", "\u{1f1e6}"]),
+ ("\u{378}\u{600}", &["\u{378}", "\u{600}"]),
+ ("\u{378}\u{308}\u{600}", &["\u{378}\u{308}", "\u{600}"]),
+ ("\u{378}\u{1100}", &["\u{378}", "\u{1100}"]),
+ ("\u{378}\u{308}\u{1100}", &["\u{378}\u{308}", "\u{1100}"]),
+ ("\u{378}\u{1160}", &["\u{378}", "\u{1160}"]),
+ ("\u{378}\u{308}\u{1160}", &["\u{378}\u{308}", "\u{1160}"]),
+ ("\u{378}\u{11a8}", &["\u{378}", "\u{11a8}"]),
+ ("\u{378}\u{308}\u{11a8}", &["\u{378}\u{308}", "\u{11a8}"]),
+ ("\u{378}\u{ac00}", &["\u{378}", "\u{ac00}"]),
+ ("\u{378}\u{308}\u{ac00}", &["\u{378}\u{308}", "\u{ac00}"]),
+ ("\u{378}\u{ac01}", &["\u{378}", "\u{ac01}"]),
+ ("\u{378}\u{308}\u{ac01}", &["\u{378}\u{308}", "\u{ac01}"]),
+ ("\u{378}\u{231a}", &["\u{378}", "\u{231a}"]),
+ ("\u{378}\u{308}\u{231a}", &["\u{378}\u{308}", "\u{231a}"]),
+ ("\u{378}\u{300}", &["\u{378}\u{300}"]),
+ ("\u{378}\u{308}\u{300}", &["\u{378}\u{308}\u{300}"]),
+ ("\u{378}\u{200d}", &["\u{378}\u{200d}"]),
+ ("\u{378}\u{308}\u{200d}", &["\u{378}\u{308}\u{200d}"]),
+ ("\u{378}\u{378}", &["\u{378}", "\u{378}"]),
+ ("\u{378}\u{308}\u{378}", &["\u{378}\u{308}", "\u{378}"]),
+ (
+ "\u{d}\u{a}\u{61}\u{a}\u{308}",
+ &["\u{d}\u{a}", "\u{61}", "\u{a}", "\u{308}"],
+ ),
+ ("\u{61}\u{308}", &["\u{61}\u{308}"]),
+ ("\u{20}\u{200d}\u{646}", &["\u{20}\u{200d}", "\u{646}"]),
+ ("\u{646}\u{200d}\u{20}", &["\u{646}\u{200d}", "\u{20}"]),
+ ("\u{1100}\u{1100}", &["\u{1100}\u{1100}"]),
+ (
+ "\u{ac00}\u{11a8}\u{1100}",
+ &["\u{ac00}\u{11a8}", "\u{1100}"],
+ ),
+ (
+ "\u{ac01}\u{11a8}\u{1100}",
+ &["\u{ac01}\u{11a8}", "\u{1100}"],
+ ),
+ (
+ "\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{62}",
+ &["\u{1f1e6}\u{1f1e7}", "\u{1f1e8}", "\u{62}"],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{62}",
+ &["\u{61}", "\u{1f1e6}\u{1f1e7}", "\u{1f1e8}", "\u{62}"],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{200d}\u{1f1e8}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{1f1e7}\u{200d}",
+ "\u{1f1e8}",
+ "\u{62}",
+ ],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{200d}\u{1f1e7}\u{1f1e8}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{200d}",
+ "\u{1f1e7}\u{1f1e8}",
+ "\u{62}",
+ ],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{1f1e9}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{1f1e7}",
+ "\u{1f1e8}\u{1f1e9}",
+ "\u{62}",
+ ],
+ ),
+ ("\u{61}\u{200d}", &["\u{61}\u{200d}"]),
+ ("\u{61}\u{308}\u{62}", &["\u{61}\u{308}", "\u{62}"]),
+ (
+ "\u{1f476}\u{1f3ff}\u{1f476}",
+ &["\u{1f476}\u{1f3ff}", "\u{1f476}"],
+ ),
+ (
+ "\u{61}\u{1f3ff}\u{1f476}",
+ &["\u{61}\u{1f3ff}", "\u{1f476}"],
+ ),
+ (
+ "\u{61}\u{1f3ff}\u{1f476}\u{200d}\u{1f6d1}",
+ &["\u{61}\u{1f3ff}", "\u{1f476}\u{200d}\u{1f6d1}"],
+ ),
+ (
+ "\u{1f476}\u{1f3ff}\u{308}\u{200d}\u{1f476}\u{1f3ff}",
+ &["\u{1f476}\u{1f3ff}\u{308}\u{200d}\u{1f476}\u{1f3ff}"],
+ ),
+ (
+ "\u{1f6d1}\u{200d}\u{1f6d1}",
+ &["\u{1f6d1}\u{200d}\u{1f6d1}"],
+ ),
+ ("\u{61}\u{200d}\u{1f6d1}", &["\u{61}\u{200d}", "\u{1f6d1}"]),
+ ("\u{2701}\u{200d}\u{2701}", &["\u{2701}\u{200d}\u{2701}"]),
+ ("\u{61}\u{200d}\u{2701}", &["\u{61}\u{200d}", "\u{2701}"]),
+];
+
+pub const TEST_DIFF: &'static [(
+ &'static str,
+ &'static [&'static str],
+ &'static [&'static str],
+)] = &[
+ ("\u{20}\u{903}", &["\u{20}\u{903}"], &["\u{20}", "\u{903}"]),
+ (
+ "\u{20}\u{308}\u{903}",
+ &["\u{20}\u{308}\u{903}"],
+ &["\u{20}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{d}\u{308}\u{903}",
+ &["\u{d}", "\u{308}\u{903}"],
+ &["\u{d}", "\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{a}\u{308}\u{903}",
+ &["\u{a}", "\u{308}\u{903}"],
+ &["\u{a}", "\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{1}\u{308}\u{903}",
+ &["\u{1}", "\u{308}\u{903}"],
+ &["\u{1}", "\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{34f}\u{903}",
+ &["\u{34f}\u{903}"],
+ &["\u{34f}", "\u{903}"],
+ ),
+ (
+ "\u{34f}\u{308}\u{903}",
+ &["\u{34f}\u{308}\u{903}"],
+ &["\u{34f}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{1f1e6}\u{903}",
+ &["\u{1f1e6}\u{903}"],
+ &["\u{1f1e6}", "\u{903}"],
+ ),
+ (
+ "\u{1f1e6}\u{308}\u{903}",
+ &["\u{1f1e6}\u{308}\u{903}"],
+ &["\u{1f1e6}\u{308}", "\u{903}"],
+ ),
+ ("\u{600}\u{20}", &["\u{600}\u{20}"], &["\u{600}", "\u{20}"]),
+ (
+ "\u{600}\u{1f1e6}",
+ &["\u{600}\u{1f1e6}"],
+ &["\u{600}", "\u{1f1e6}"],
+ ),
+ (
+ "\u{600}\u{600}",
+ &["\u{600}\u{600}"],
+ &["\u{600}", "\u{600}"],
+ ),
+ (
+ "\u{600}\u{903}",
+ &["\u{600}\u{903}"],
+ &["\u{600}", "\u{903}"],
+ ),
+ (
+ "\u{600}\u{308}\u{903}",
+ &["\u{600}\u{308}\u{903}"],
+ &["\u{600}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{600}\u{1100}",
+ &["\u{600}\u{1100}"],
+ &["\u{600}", "\u{1100}"],
+ ),
+ (
+ "\u{600}\u{1160}",
+ &["\u{600}\u{1160}"],
+ &["\u{600}", "\u{1160}"],
+ ),
+ (
+ "\u{600}\u{11a8}",
+ &["\u{600}\u{11a8}"],
+ &["\u{600}", "\u{11a8}"],
+ ),
+ (
+ "\u{600}\u{ac00}",
+ &["\u{600}\u{ac00}"],
+ &["\u{600}", "\u{ac00}"],
+ ),
+ (
+ "\u{600}\u{ac01}",
+ &["\u{600}\u{ac01}"],
+ &["\u{600}", "\u{ac01}"],
+ ),
+ (
+ "\u{600}\u{231a}",
+ &["\u{600}\u{231a}"],
+ &["\u{600}", "\u{231a}"],
+ ),
+ (
+ "\u{600}\u{378}",
+ &["\u{600}\u{378}"],
+ &["\u{600}", "\u{378}"],
+ ),
+ (
+ "\u{903}\u{903}",
+ &["\u{903}\u{903}"],
+ &["\u{903}", "\u{903}"],
+ ),
+ (
+ "\u{903}\u{308}\u{903}",
+ &["\u{903}\u{308}\u{903}"],
+ &["\u{903}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{1100}\u{903}",
+ &["\u{1100}\u{903}"],
+ &["\u{1100}", "\u{903}"],
+ ),
+ (
+ "\u{1100}\u{308}\u{903}",
+ &["\u{1100}\u{308}\u{903}"],
+ &["\u{1100}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{1160}\u{903}",
+ &["\u{1160}\u{903}"],
+ &["\u{1160}", "\u{903}"],
+ ),
+ (
+ "\u{1160}\u{308}\u{903}",
+ &["\u{1160}\u{308}\u{903}"],
+ &["\u{1160}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{11a8}\u{903}",
+ &["\u{11a8}\u{903}"],
+ &["\u{11a8}", "\u{903}"],
+ ),
+ (
+ "\u{11a8}\u{308}\u{903}",
+ &["\u{11a8}\u{308}\u{903}"],
+ &["\u{11a8}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{ac00}\u{903}",
+ &["\u{ac00}\u{903}"],
+ &["\u{ac00}", "\u{903}"],
+ ),
+ (
+ "\u{ac00}\u{308}\u{903}",
+ &["\u{ac00}\u{308}\u{903}"],
+ &["\u{ac00}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{ac01}\u{903}",
+ &["\u{ac01}\u{903}"],
+ &["\u{ac01}", "\u{903}"],
+ ),
+ (
+ "\u{ac01}\u{308}\u{903}",
+ &["\u{ac01}\u{308}\u{903}"],
+ &["\u{ac01}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{231a}\u{903}",
+ &["\u{231a}\u{903}"],
+ &["\u{231a}", "\u{903}"],
+ ),
+ (
+ "\u{231a}\u{308}\u{903}",
+ &["\u{231a}\u{308}\u{903}"],
+ &["\u{231a}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{300}\u{903}",
+ &["\u{300}\u{903}"],
+ &["\u{300}", "\u{903}"],
+ ),
+ (
+ "\u{300}\u{308}\u{903}",
+ &["\u{300}\u{308}\u{903}"],
+ &["\u{300}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{200d}\u{903}",
+ &["\u{200d}\u{903}"],
+ &["\u{200d}", "\u{903}"],
+ ),
+ (
+ "\u{200d}\u{308}\u{903}",
+ &["\u{200d}\u{308}\u{903}"],
+ &["\u{200d}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{378}\u{903}",
+ &["\u{378}\u{903}"],
+ &["\u{378}", "\u{903}"],
+ ),
+ (
+ "\u{378}\u{308}\u{903}",
+ &["\u{378}\u{308}\u{903}"],
+ &["\u{378}\u{308}", "\u{903}"],
+ ),
+ (
+ "\u{61}\u{903}\u{62}",
+ &["\u{61}\u{903}", "\u{62}"],
+ &["\u{61}", "\u{903}", "\u{62}"],
+ ),
+ (
+ "\u{61}\u{600}\u{62}",
+ &["\u{61}", "\u{600}\u{62}"],
+ &["\u{61}", "\u{600}", "\u{62}"],
+ ),
+];
+
+// official Unicode test data
+// http://www.unicode.org/Public/15.0.0/ucd/auxiliary/WordBreakTest.txt
+pub const TEST_WORD: &'static [(&'static str, &'static [&'static str])] = &[
+ ("\u{1}\u{1}", &["\u{1}", "\u{1}"]),
+ ("\u{1}\u{308}\u{1}", &["\u{1}\u{308}", "\u{1}"]),
+ ("\u{1}\u{d}", &["\u{1}", "\u{d}"]),
+ ("\u{1}\u{308}\u{d}", &["\u{1}\u{308}", "\u{d}"]),
+ ("\u{1}\u{a}", &["\u{1}", "\u{a}"]),
+ ("\u{1}\u{308}\u{a}", &["\u{1}\u{308}", "\u{a}"]),
+ ("\u{1}\u{b}", &["\u{1}", "\u{b}"]),
+ ("\u{1}\u{308}\u{b}", &["\u{1}\u{308}", "\u{b}"]),
+ ("\u{1}\u{3031}", &["\u{1}", "\u{3031}"]),
+ ("\u{1}\u{308}\u{3031}", &["\u{1}\u{308}", "\u{3031}"]),
+ ("\u{1}\u{41}", &["\u{1}", "\u{41}"]),
+ ("\u{1}\u{308}\u{41}", &["\u{1}\u{308}", "\u{41}"]),
+ ("\u{1}\u{3a}", &["\u{1}", "\u{3a}"]),
+ ("\u{1}\u{308}\u{3a}", &["\u{1}\u{308}", "\u{3a}"]),
+ ("\u{1}\u{2c}", &["\u{1}", "\u{2c}"]),
+ ("\u{1}\u{308}\u{2c}", &["\u{1}\u{308}", "\u{2c}"]),
+ ("\u{1}\u{2e}", &["\u{1}", "\u{2e}"]),
+ ("\u{1}\u{308}\u{2e}", &["\u{1}\u{308}", "\u{2e}"]),
+ ("\u{1}\u{30}", &["\u{1}", "\u{30}"]),
+ ("\u{1}\u{308}\u{30}", &["\u{1}\u{308}", "\u{30}"]),
+ ("\u{1}\u{5f}", &["\u{1}", "\u{5f}"]),
+ ("\u{1}\u{308}\u{5f}", &["\u{1}\u{308}", "\u{5f}"]),
+ ("\u{1}\u{1f1e6}", &["\u{1}", "\u{1f1e6}"]),
+ ("\u{1}\u{308}\u{1f1e6}", &["\u{1}\u{308}", "\u{1f1e6}"]),
+ ("\u{1}\u{5d0}", &["\u{1}", "\u{5d0}"]),
+ ("\u{1}\u{308}\u{5d0}", &["\u{1}\u{308}", "\u{5d0}"]),
+ ("\u{1}\u{22}", &["\u{1}", "\u{22}"]),
+ ("\u{1}\u{308}\u{22}", &["\u{1}\u{308}", "\u{22}"]),
+ ("\u{1}\u{27}", &["\u{1}", "\u{27}"]),
+ ("\u{1}\u{308}\u{27}", &["\u{1}\u{308}", "\u{27}"]),
+ ("\u{1}\u{231a}", &["\u{1}", "\u{231a}"]),
+ ("\u{1}\u{308}\u{231a}", &["\u{1}\u{308}", "\u{231a}"]),
+ ("\u{1}\u{20}", &["\u{1}", "\u{20}"]),
+ ("\u{1}\u{308}\u{20}", &["\u{1}\u{308}", "\u{20}"]),
+ ("\u{1}\u{ad}", &["\u{1}\u{ad}"]),
+ ("\u{1}\u{308}\u{ad}", &["\u{1}\u{308}\u{ad}"]),
+ ("\u{1}\u{300}", &["\u{1}\u{300}"]),
+ ("\u{1}\u{308}\u{300}", &["\u{1}\u{308}\u{300}"]),
+ ("\u{1}\u{200d}", &["\u{1}\u{200d}"]),
+ ("\u{1}\u{308}\u{200d}", &["\u{1}\u{308}\u{200d}"]),
+ ("\u{1}\u{61}\u{2060}", &["\u{1}", "\u{61}\u{2060}"]),
+ (
+ "\u{1}\u{308}\u{61}\u{2060}",
+ &["\u{1}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{1}\u{61}\u{3a}", &["\u{1}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{1}\u{308}\u{61}\u{3a}",
+ &["\u{1}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{1}\u{61}\u{27}", &["\u{1}", "\u{61}", "\u{27}"]),
+ (
+ "\u{1}\u{308}\u{61}\u{27}",
+ &["\u{1}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{1}\u{61}\u{27}\u{2060}",
+ &["\u{1}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{1}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{1}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{1}\u{61}\u{2c}", &["\u{1}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{1}\u{308}\u{61}\u{2c}",
+ &["\u{1}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{1}\u{31}\u{3a}", &["\u{1}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{1}\u{308}\u{31}\u{3a}",
+ &["\u{1}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{1}\u{31}\u{27}", &["\u{1}", "\u{31}", "\u{27}"]),
+ (
+ "\u{1}\u{308}\u{31}\u{27}",
+ &["\u{1}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{1}\u{31}\u{2c}", &["\u{1}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{1}\u{308}\u{31}\u{2c}",
+ &["\u{1}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{1}\u{31}\u{2e}\u{2060}",
+ &["\u{1}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{1}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{1}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{d}\u{1}", &["\u{d}", "\u{1}"]),
+ ("\u{d}\u{308}\u{1}", &["\u{d}", "\u{308}", "\u{1}"]),
+ ("\u{d}\u{d}", &["\u{d}", "\u{d}"]),
+ ("\u{d}\u{308}\u{d}", &["\u{d}", "\u{308}", "\u{d}"]),
+ ("\u{d}\u{a}", &["\u{d}\u{a}"]),
+ ("\u{d}\u{308}\u{a}", &["\u{d}", "\u{308}", "\u{a}"]),
+ ("\u{d}\u{b}", &["\u{d}", "\u{b}"]),
+ ("\u{d}\u{308}\u{b}", &["\u{d}", "\u{308}", "\u{b}"]),
+ ("\u{d}\u{3031}", &["\u{d}", "\u{3031}"]),
+ ("\u{d}\u{308}\u{3031}", &["\u{d}", "\u{308}", "\u{3031}"]),
+ ("\u{d}\u{41}", &["\u{d}", "\u{41}"]),
+ ("\u{d}\u{308}\u{41}", &["\u{d}", "\u{308}", "\u{41}"]),
+ ("\u{d}\u{3a}", &["\u{d}", "\u{3a}"]),
+ ("\u{d}\u{308}\u{3a}", &["\u{d}", "\u{308}", "\u{3a}"]),
+ ("\u{d}\u{2c}", &["\u{d}", "\u{2c}"]),
+ ("\u{d}\u{308}\u{2c}", &["\u{d}", "\u{308}", "\u{2c}"]),
+ ("\u{d}\u{2e}", &["\u{d}", "\u{2e}"]),
+ ("\u{d}\u{308}\u{2e}", &["\u{d}", "\u{308}", "\u{2e}"]),
+ ("\u{d}\u{30}", &["\u{d}", "\u{30}"]),
+ ("\u{d}\u{308}\u{30}", &["\u{d}", "\u{308}", "\u{30}"]),
+ ("\u{d}\u{5f}", &["\u{d}", "\u{5f}"]),
+ ("\u{d}\u{308}\u{5f}", &["\u{d}", "\u{308}", "\u{5f}"]),
+ ("\u{d}\u{1f1e6}", &["\u{d}", "\u{1f1e6}"]),
+ ("\u{d}\u{308}\u{1f1e6}", &["\u{d}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{d}\u{5d0}", &["\u{d}", "\u{5d0}"]),
+ ("\u{d}\u{308}\u{5d0}", &["\u{d}", "\u{308}", "\u{5d0}"]),
+ ("\u{d}\u{22}", &["\u{d}", "\u{22}"]),
+ ("\u{d}\u{308}\u{22}", &["\u{d}", "\u{308}", "\u{22}"]),
+ ("\u{d}\u{27}", &["\u{d}", "\u{27}"]),
+ ("\u{d}\u{308}\u{27}", &["\u{d}", "\u{308}", "\u{27}"]),
+ ("\u{d}\u{231a}", &["\u{d}", "\u{231a}"]),
+ ("\u{d}\u{308}\u{231a}", &["\u{d}", "\u{308}", "\u{231a}"]),
+ ("\u{d}\u{20}", &["\u{d}", "\u{20}"]),
+ ("\u{d}\u{308}\u{20}", &["\u{d}", "\u{308}", "\u{20}"]),
+ ("\u{d}\u{ad}", &["\u{d}", "\u{ad}"]),
+ ("\u{d}\u{308}\u{ad}", &["\u{d}", "\u{308}\u{ad}"]),
+ ("\u{d}\u{300}", &["\u{d}", "\u{300}"]),
+ ("\u{d}\u{308}\u{300}", &["\u{d}", "\u{308}\u{300}"]),
+ ("\u{d}\u{200d}", &["\u{d}", "\u{200d}"]),
+ ("\u{d}\u{308}\u{200d}", &["\u{d}", "\u{308}\u{200d}"]),
+ ("\u{d}\u{61}\u{2060}", &["\u{d}", "\u{61}\u{2060}"]),
+ (
+ "\u{d}\u{308}\u{61}\u{2060}",
+ &["\u{d}", "\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{d}\u{61}\u{3a}", &["\u{d}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{d}\u{308}\u{61}\u{3a}",
+ &["\u{d}", "\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{d}\u{61}\u{27}", &["\u{d}", "\u{61}", "\u{27}"]),
+ (
+ "\u{d}\u{308}\u{61}\u{27}",
+ &["\u{d}", "\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{d}\u{61}\u{27}\u{2060}",
+ &["\u{d}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{d}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{d}", "\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{d}\u{61}\u{2c}", &["\u{d}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{d}\u{308}\u{61}\u{2c}",
+ &["\u{d}", "\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{d}\u{31}\u{3a}", &["\u{d}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{d}\u{308}\u{31}\u{3a}",
+ &["\u{d}", "\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{d}\u{31}\u{27}", &["\u{d}", "\u{31}", "\u{27}"]),
+ (
+ "\u{d}\u{308}\u{31}\u{27}",
+ &["\u{d}", "\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{d}\u{31}\u{2c}", &["\u{d}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{d}\u{308}\u{31}\u{2c}",
+ &["\u{d}", "\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{d}\u{31}\u{2e}\u{2060}",
+ &["\u{d}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{d}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{d}", "\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{a}\u{1}", &["\u{a}", "\u{1}"]),
+ ("\u{a}\u{308}\u{1}", &["\u{a}", "\u{308}", "\u{1}"]),
+ ("\u{a}\u{d}", &["\u{a}", "\u{d}"]),
+ ("\u{a}\u{308}\u{d}", &["\u{a}", "\u{308}", "\u{d}"]),
+ ("\u{a}\u{a}", &["\u{a}", "\u{a}"]),
+ ("\u{a}\u{308}\u{a}", &["\u{a}", "\u{308}", "\u{a}"]),
+ ("\u{a}\u{b}", &["\u{a}", "\u{b}"]),
+ ("\u{a}\u{308}\u{b}", &["\u{a}", "\u{308}", "\u{b}"]),
+ ("\u{a}\u{3031}", &["\u{a}", "\u{3031}"]),
+ ("\u{a}\u{308}\u{3031}", &["\u{a}", "\u{308}", "\u{3031}"]),
+ ("\u{a}\u{41}", &["\u{a}", "\u{41}"]),
+ ("\u{a}\u{308}\u{41}", &["\u{a}", "\u{308}", "\u{41}"]),
+ ("\u{a}\u{3a}", &["\u{a}", "\u{3a}"]),
+ ("\u{a}\u{308}\u{3a}", &["\u{a}", "\u{308}", "\u{3a}"]),
+ ("\u{a}\u{2c}", &["\u{a}", "\u{2c}"]),
+ ("\u{a}\u{308}\u{2c}", &["\u{a}", "\u{308}", "\u{2c}"]),
+ ("\u{a}\u{2e}", &["\u{a}", "\u{2e}"]),
+ ("\u{a}\u{308}\u{2e}", &["\u{a}", "\u{308}", "\u{2e}"]),
+ ("\u{a}\u{30}", &["\u{a}", "\u{30}"]),
+ ("\u{a}\u{308}\u{30}", &["\u{a}", "\u{308}", "\u{30}"]),
+ ("\u{a}\u{5f}", &["\u{a}", "\u{5f}"]),
+ ("\u{a}\u{308}\u{5f}", &["\u{a}", "\u{308}", "\u{5f}"]),
+ ("\u{a}\u{1f1e6}", &["\u{a}", "\u{1f1e6}"]),
+ ("\u{a}\u{308}\u{1f1e6}", &["\u{a}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{a}\u{5d0}", &["\u{a}", "\u{5d0}"]),
+ ("\u{a}\u{308}\u{5d0}", &["\u{a}", "\u{308}", "\u{5d0}"]),
+ ("\u{a}\u{22}", &["\u{a}", "\u{22}"]),
+ ("\u{a}\u{308}\u{22}", &["\u{a}", "\u{308}", "\u{22}"]),
+ ("\u{a}\u{27}", &["\u{a}", "\u{27}"]),
+ ("\u{a}\u{308}\u{27}", &["\u{a}", "\u{308}", "\u{27}"]),
+ ("\u{a}\u{231a}", &["\u{a}", "\u{231a}"]),
+ ("\u{a}\u{308}\u{231a}", &["\u{a}", "\u{308}", "\u{231a}"]),
+ ("\u{a}\u{20}", &["\u{a}", "\u{20}"]),
+ ("\u{a}\u{308}\u{20}", &["\u{a}", "\u{308}", "\u{20}"]),
+ ("\u{a}\u{ad}", &["\u{a}", "\u{ad}"]),
+ ("\u{a}\u{308}\u{ad}", &["\u{a}", "\u{308}\u{ad}"]),
+ ("\u{a}\u{300}", &["\u{a}", "\u{300}"]),
+ ("\u{a}\u{308}\u{300}", &["\u{a}", "\u{308}\u{300}"]),
+ ("\u{a}\u{200d}", &["\u{a}", "\u{200d}"]),
+ ("\u{a}\u{308}\u{200d}", &["\u{a}", "\u{308}\u{200d}"]),
+ ("\u{a}\u{61}\u{2060}", &["\u{a}", "\u{61}\u{2060}"]),
+ (
+ "\u{a}\u{308}\u{61}\u{2060}",
+ &["\u{a}", "\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{a}\u{61}\u{3a}", &["\u{a}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{a}\u{308}\u{61}\u{3a}",
+ &["\u{a}", "\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{a}\u{61}\u{27}", &["\u{a}", "\u{61}", "\u{27}"]),
+ (
+ "\u{a}\u{308}\u{61}\u{27}",
+ &["\u{a}", "\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{a}\u{61}\u{27}\u{2060}",
+ &["\u{a}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{a}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{a}", "\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{a}\u{61}\u{2c}", &["\u{a}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{a}\u{308}\u{61}\u{2c}",
+ &["\u{a}", "\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{a}\u{31}\u{3a}", &["\u{a}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{a}\u{308}\u{31}\u{3a}",
+ &["\u{a}", "\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{a}\u{31}\u{27}", &["\u{a}", "\u{31}", "\u{27}"]),
+ (
+ "\u{a}\u{308}\u{31}\u{27}",
+ &["\u{a}", "\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{a}\u{31}\u{2c}", &["\u{a}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{a}\u{308}\u{31}\u{2c}",
+ &["\u{a}", "\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{a}\u{31}\u{2e}\u{2060}",
+ &["\u{a}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{a}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{a}", "\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{b}\u{1}", &["\u{b}", "\u{1}"]),
+ ("\u{b}\u{308}\u{1}", &["\u{b}", "\u{308}", "\u{1}"]),
+ ("\u{b}\u{d}", &["\u{b}", "\u{d}"]),
+ ("\u{b}\u{308}\u{d}", &["\u{b}", "\u{308}", "\u{d}"]),
+ ("\u{b}\u{a}", &["\u{b}", "\u{a}"]),
+ ("\u{b}\u{308}\u{a}", &["\u{b}", "\u{308}", "\u{a}"]),
+ ("\u{b}\u{b}", &["\u{b}", "\u{b}"]),
+ ("\u{b}\u{308}\u{b}", &["\u{b}", "\u{308}", "\u{b}"]),
+ ("\u{b}\u{3031}", &["\u{b}", "\u{3031}"]),
+ ("\u{b}\u{308}\u{3031}", &["\u{b}", "\u{308}", "\u{3031}"]),
+ ("\u{b}\u{41}", &["\u{b}", "\u{41}"]),
+ ("\u{b}\u{308}\u{41}", &["\u{b}", "\u{308}", "\u{41}"]),
+ ("\u{b}\u{3a}", &["\u{b}", "\u{3a}"]),
+ ("\u{b}\u{308}\u{3a}", &["\u{b}", "\u{308}", "\u{3a}"]),
+ ("\u{b}\u{2c}", &["\u{b}", "\u{2c}"]),
+ ("\u{b}\u{308}\u{2c}", &["\u{b}", "\u{308}", "\u{2c}"]),
+ ("\u{b}\u{2e}", &["\u{b}", "\u{2e}"]),
+ ("\u{b}\u{308}\u{2e}", &["\u{b}", "\u{308}", "\u{2e}"]),
+ ("\u{b}\u{30}", &["\u{b}", "\u{30}"]),
+ ("\u{b}\u{308}\u{30}", &["\u{b}", "\u{308}", "\u{30}"]),
+ ("\u{b}\u{5f}", &["\u{b}", "\u{5f}"]),
+ ("\u{b}\u{308}\u{5f}", &["\u{b}", "\u{308}", "\u{5f}"]),
+ ("\u{b}\u{1f1e6}", &["\u{b}", "\u{1f1e6}"]),
+ ("\u{b}\u{308}\u{1f1e6}", &["\u{b}", "\u{308}", "\u{1f1e6}"]),
+ ("\u{b}\u{5d0}", &["\u{b}", "\u{5d0}"]),
+ ("\u{b}\u{308}\u{5d0}", &["\u{b}", "\u{308}", "\u{5d0}"]),
+ ("\u{b}\u{22}", &["\u{b}", "\u{22}"]),
+ ("\u{b}\u{308}\u{22}", &["\u{b}", "\u{308}", "\u{22}"]),
+ ("\u{b}\u{27}", &["\u{b}", "\u{27}"]),
+ ("\u{b}\u{308}\u{27}", &["\u{b}", "\u{308}", "\u{27}"]),
+ ("\u{b}\u{231a}", &["\u{b}", "\u{231a}"]),
+ ("\u{b}\u{308}\u{231a}", &["\u{b}", "\u{308}", "\u{231a}"]),
+ ("\u{b}\u{20}", &["\u{b}", "\u{20}"]),
+ ("\u{b}\u{308}\u{20}", &["\u{b}", "\u{308}", "\u{20}"]),
+ ("\u{b}\u{ad}", &["\u{b}", "\u{ad}"]),
+ ("\u{b}\u{308}\u{ad}", &["\u{b}", "\u{308}\u{ad}"]),
+ ("\u{b}\u{300}", &["\u{b}", "\u{300}"]),
+ ("\u{b}\u{308}\u{300}", &["\u{b}", "\u{308}\u{300}"]),
+ ("\u{b}\u{200d}", &["\u{b}", "\u{200d}"]),
+ ("\u{b}\u{308}\u{200d}", &["\u{b}", "\u{308}\u{200d}"]),
+ ("\u{b}\u{61}\u{2060}", &["\u{b}", "\u{61}\u{2060}"]),
+ (
+ "\u{b}\u{308}\u{61}\u{2060}",
+ &["\u{b}", "\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{b}\u{61}\u{3a}", &["\u{b}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{b}\u{308}\u{61}\u{3a}",
+ &["\u{b}", "\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{b}\u{61}\u{27}", &["\u{b}", "\u{61}", "\u{27}"]),
+ (
+ "\u{b}\u{308}\u{61}\u{27}",
+ &["\u{b}", "\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{b}\u{61}\u{27}\u{2060}",
+ &["\u{b}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{b}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{b}", "\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{b}\u{61}\u{2c}", &["\u{b}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{b}\u{308}\u{61}\u{2c}",
+ &["\u{b}", "\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{b}\u{31}\u{3a}", &["\u{b}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{b}\u{308}\u{31}\u{3a}",
+ &["\u{b}", "\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{b}\u{31}\u{27}", &["\u{b}", "\u{31}", "\u{27}"]),
+ (
+ "\u{b}\u{308}\u{31}\u{27}",
+ &["\u{b}", "\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{b}\u{31}\u{2c}", &["\u{b}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{b}\u{308}\u{31}\u{2c}",
+ &["\u{b}", "\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{b}\u{31}\u{2e}\u{2060}",
+ &["\u{b}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{b}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{b}", "\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{3031}\u{1}", &["\u{3031}", "\u{1}"]),
+ ("\u{3031}\u{308}\u{1}", &["\u{3031}\u{308}", "\u{1}"]),
+ ("\u{3031}\u{d}", &["\u{3031}", "\u{d}"]),
+ ("\u{3031}\u{308}\u{d}", &["\u{3031}\u{308}", "\u{d}"]),
+ ("\u{3031}\u{a}", &["\u{3031}", "\u{a}"]),
+ ("\u{3031}\u{308}\u{a}", &["\u{3031}\u{308}", "\u{a}"]),
+ ("\u{3031}\u{b}", &["\u{3031}", "\u{b}"]),
+ ("\u{3031}\u{308}\u{b}", &["\u{3031}\u{308}", "\u{b}"]),
+ ("\u{3031}\u{3031}", &["\u{3031}\u{3031}"]),
+ ("\u{3031}\u{308}\u{3031}", &["\u{3031}\u{308}\u{3031}"]),
+ ("\u{3031}\u{41}", &["\u{3031}", "\u{41}"]),
+ ("\u{3031}\u{308}\u{41}", &["\u{3031}\u{308}", "\u{41}"]),
+ ("\u{3031}\u{3a}", &["\u{3031}", "\u{3a}"]),
+ ("\u{3031}\u{308}\u{3a}", &["\u{3031}\u{308}", "\u{3a}"]),
+ ("\u{3031}\u{2c}", &["\u{3031}", "\u{2c}"]),
+ ("\u{3031}\u{308}\u{2c}", &["\u{3031}\u{308}", "\u{2c}"]),
+ ("\u{3031}\u{2e}", &["\u{3031}", "\u{2e}"]),
+ ("\u{3031}\u{308}\u{2e}", &["\u{3031}\u{308}", "\u{2e}"]),
+ ("\u{3031}\u{30}", &["\u{3031}", "\u{30}"]),
+ ("\u{3031}\u{308}\u{30}", &["\u{3031}\u{308}", "\u{30}"]),
+ ("\u{3031}\u{5f}", &["\u{3031}\u{5f}"]),
+ ("\u{3031}\u{308}\u{5f}", &["\u{3031}\u{308}\u{5f}"]),
+ ("\u{3031}\u{1f1e6}", &["\u{3031}", "\u{1f1e6}"]),
+ (
+ "\u{3031}\u{308}\u{1f1e6}",
+ &["\u{3031}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{3031}\u{5d0}", &["\u{3031}", "\u{5d0}"]),
+ ("\u{3031}\u{308}\u{5d0}", &["\u{3031}\u{308}", "\u{5d0}"]),
+ ("\u{3031}\u{22}", &["\u{3031}", "\u{22}"]),
+ ("\u{3031}\u{308}\u{22}", &["\u{3031}\u{308}", "\u{22}"]),
+ ("\u{3031}\u{27}", &["\u{3031}", "\u{27}"]),
+ ("\u{3031}\u{308}\u{27}", &["\u{3031}\u{308}", "\u{27}"]),
+ ("\u{3031}\u{231a}", &["\u{3031}", "\u{231a}"]),
+ ("\u{3031}\u{308}\u{231a}", &["\u{3031}\u{308}", "\u{231a}"]),
+ ("\u{3031}\u{20}", &["\u{3031}", "\u{20}"]),
+ ("\u{3031}\u{308}\u{20}", &["\u{3031}\u{308}", "\u{20}"]),
+ ("\u{3031}\u{ad}", &["\u{3031}\u{ad}"]),
+ ("\u{3031}\u{308}\u{ad}", &["\u{3031}\u{308}\u{ad}"]),
+ ("\u{3031}\u{300}", &["\u{3031}\u{300}"]),
+ ("\u{3031}\u{308}\u{300}", &["\u{3031}\u{308}\u{300}"]),
+ ("\u{3031}\u{200d}", &["\u{3031}\u{200d}"]),
+ ("\u{3031}\u{308}\u{200d}", &["\u{3031}\u{308}\u{200d}"]),
+ ("\u{3031}\u{61}\u{2060}", &["\u{3031}", "\u{61}\u{2060}"]),
+ (
+ "\u{3031}\u{308}\u{61}\u{2060}",
+ &["\u{3031}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{3031}\u{61}\u{3a}", &["\u{3031}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{3031}\u{308}\u{61}\u{3a}",
+ &["\u{3031}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{3031}\u{61}\u{27}", &["\u{3031}", "\u{61}", "\u{27}"]),
+ (
+ "\u{3031}\u{308}\u{61}\u{27}",
+ &["\u{3031}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{3031}\u{61}\u{27}\u{2060}",
+ &["\u{3031}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{3031}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{3031}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{3031}\u{61}\u{2c}", &["\u{3031}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{3031}\u{308}\u{61}\u{2c}",
+ &["\u{3031}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{3031}\u{31}\u{3a}", &["\u{3031}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{3031}\u{308}\u{31}\u{3a}",
+ &["\u{3031}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{3031}\u{31}\u{27}", &["\u{3031}", "\u{31}", "\u{27}"]),
+ (
+ "\u{3031}\u{308}\u{31}\u{27}",
+ &["\u{3031}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{3031}\u{31}\u{2c}", &["\u{3031}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{3031}\u{308}\u{31}\u{2c}",
+ &["\u{3031}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{3031}\u{31}\u{2e}\u{2060}",
+ &["\u{3031}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{3031}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{3031}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{41}\u{1}", &["\u{41}", "\u{1}"]),
+ ("\u{41}\u{308}\u{1}", &["\u{41}\u{308}", "\u{1}"]),
+ ("\u{41}\u{d}", &["\u{41}", "\u{d}"]),
+ ("\u{41}\u{308}\u{d}", &["\u{41}\u{308}", "\u{d}"]),
+ ("\u{41}\u{a}", &["\u{41}", "\u{a}"]),
+ ("\u{41}\u{308}\u{a}", &["\u{41}\u{308}", "\u{a}"]),
+ ("\u{41}\u{b}", &["\u{41}", "\u{b}"]),
+ ("\u{41}\u{308}\u{b}", &["\u{41}\u{308}", "\u{b}"]),
+ ("\u{41}\u{3031}", &["\u{41}", "\u{3031}"]),
+ ("\u{41}\u{308}\u{3031}", &["\u{41}\u{308}", "\u{3031}"]),
+ ("\u{41}\u{41}", &["\u{41}\u{41}"]),
+ ("\u{41}\u{308}\u{41}", &["\u{41}\u{308}\u{41}"]),
+ ("\u{41}\u{3a}", &["\u{41}", "\u{3a}"]),
+ ("\u{41}\u{308}\u{3a}", &["\u{41}\u{308}", "\u{3a}"]),
+ ("\u{41}\u{2c}", &["\u{41}", "\u{2c}"]),
+ ("\u{41}\u{308}\u{2c}", &["\u{41}\u{308}", "\u{2c}"]),
+ ("\u{41}\u{2e}", &["\u{41}", "\u{2e}"]),
+ ("\u{41}\u{308}\u{2e}", &["\u{41}\u{308}", "\u{2e}"]),
+ ("\u{41}\u{30}", &["\u{41}\u{30}"]),
+ ("\u{41}\u{308}\u{30}", &["\u{41}\u{308}\u{30}"]),
+ ("\u{41}\u{5f}", &["\u{41}\u{5f}"]),
+ ("\u{41}\u{308}\u{5f}", &["\u{41}\u{308}\u{5f}"]),
+ ("\u{41}\u{1f1e6}", &["\u{41}", "\u{1f1e6}"]),
+ ("\u{41}\u{308}\u{1f1e6}", &["\u{41}\u{308}", "\u{1f1e6}"]),
+ ("\u{41}\u{5d0}", &["\u{41}\u{5d0}"]),
+ ("\u{41}\u{308}\u{5d0}", &["\u{41}\u{308}\u{5d0}"]),
+ ("\u{41}\u{22}", &["\u{41}", "\u{22}"]),
+ ("\u{41}\u{308}\u{22}", &["\u{41}\u{308}", "\u{22}"]),
+ ("\u{41}\u{27}", &["\u{41}", "\u{27}"]),
+ ("\u{41}\u{308}\u{27}", &["\u{41}\u{308}", "\u{27}"]),
+ ("\u{41}\u{231a}", &["\u{41}", "\u{231a}"]),
+ ("\u{41}\u{308}\u{231a}", &["\u{41}\u{308}", "\u{231a}"]),
+ ("\u{41}\u{20}", &["\u{41}", "\u{20}"]),
+ ("\u{41}\u{308}\u{20}", &["\u{41}\u{308}", "\u{20}"]),
+ ("\u{41}\u{ad}", &["\u{41}\u{ad}"]),
+ ("\u{41}\u{308}\u{ad}", &["\u{41}\u{308}\u{ad}"]),
+ ("\u{41}\u{300}", &["\u{41}\u{300}"]),
+ ("\u{41}\u{308}\u{300}", &["\u{41}\u{308}\u{300}"]),
+ ("\u{41}\u{200d}", &["\u{41}\u{200d}"]),
+ ("\u{41}\u{308}\u{200d}", &["\u{41}\u{308}\u{200d}"]),
+ ("\u{41}\u{61}\u{2060}", &["\u{41}\u{61}\u{2060}"]),
+ (
+ "\u{41}\u{308}\u{61}\u{2060}",
+ &["\u{41}\u{308}\u{61}\u{2060}"],
+ ),
+ ("\u{41}\u{61}\u{3a}", &["\u{41}\u{61}", "\u{3a}"]),
+ (
+ "\u{41}\u{308}\u{61}\u{3a}",
+ &["\u{41}\u{308}\u{61}", "\u{3a}"],
+ ),
+ ("\u{41}\u{61}\u{27}", &["\u{41}\u{61}", "\u{27}"]),
+ (
+ "\u{41}\u{308}\u{61}\u{27}",
+ &["\u{41}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{41}\u{61}\u{27}\u{2060}",
+ &["\u{41}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{41}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{41}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{41}\u{61}\u{2c}", &["\u{41}\u{61}", "\u{2c}"]),
+ (
+ "\u{41}\u{308}\u{61}\u{2c}",
+ &["\u{41}\u{308}\u{61}", "\u{2c}"],
+ ),
+ ("\u{41}\u{31}\u{3a}", &["\u{41}\u{31}", "\u{3a}"]),
+ (
+ "\u{41}\u{308}\u{31}\u{3a}",
+ &["\u{41}\u{308}\u{31}", "\u{3a}"],
+ ),
+ ("\u{41}\u{31}\u{27}", &["\u{41}\u{31}", "\u{27}"]),
+ (
+ "\u{41}\u{308}\u{31}\u{27}",
+ &["\u{41}\u{308}\u{31}", "\u{27}"],
+ ),
+ ("\u{41}\u{31}\u{2c}", &["\u{41}\u{31}", "\u{2c}"]),
+ (
+ "\u{41}\u{308}\u{31}\u{2c}",
+ &["\u{41}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{41}\u{31}\u{2e}\u{2060}",
+ &["\u{41}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{41}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{41}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{3a}\u{1}", &["\u{3a}", "\u{1}"]),
+ ("\u{3a}\u{308}\u{1}", &["\u{3a}\u{308}", "\u{1}"]),
+ ("\u{3a}\u{d}", &["\u{3a}", "\u{d}"]),
+ ("\u{3a}\u{308}\u{d}", &["\u{3a}\u{308}", "\u{d}"]),
+ ("\u{3a}\u{a}", &["\u{3a}", "\u{a}"]),
+ ("\u{3a}\u{308}\u{a}", &["\u{3a}\u{308}", "\u{a}"]),
+ ("\u{3a}\u{b}", &["\u{3a}", "\u{b}"]),
+ ("\u{3a}\u{308}\u{b}", &["\u{3a}\u{308}", "\u{b}"]),
+ ("\u{3a}\u{3031}", &["\u{3a}", "\u{3031}"]),
+ ("\u{3a}\u{308}\u{3031}", &["\u{3a}\u{308}", "\u{3031}"]),
+ ("\u{3a}\u{41}", &["\u{3a}", "\u{41}"]),
+ ("\u{3a}\u{308}\u{41}", &["\u{3a}\u{308}", "\u{41}"]),
+ ("\u{3a}\u{3a}", &["\u{3a}", "\u{3a}"]),
+ ("\u{3a}\u{308}\u{3a}", &["\u{3a}\u{308}", "\u{3a}"]),
+ ("\u{3a}\u{2c}", &["\u{3a}", "\u{2c}"]),
+ ("\u{3a}\u{308}\u{2c}", &["\u{3a}\u{308}", "\u{2c}"]),
+ ("\u{3a}\u{2e}", &["\u{3a}", "\u{2e}"]),
+ ("\u{3a}\u{308}\u{2e}", &["\u{3a}\u{308}", "\u{2e}"]),
+ ("\u{3a}\u{30}", &["\u{3a}", "\u{30}"]),
+ ("\u{3a}\u{308}\u{30}", &["\u{3a}\u{308}", "\u{30}"]),
+ ("\u{3a}\u{5f}", &["\u{3a}", "\u{5f}"]),
+ ("\u{3a}\u{308}\u{5f}", &["\u{3a}\u{308}", "\u{5f}"]),
+ ("\u{3a}\u{1f1e6}", &["\u{3a}", "\u{1f1e6}"]),
+ ("\u{3a}\u{308}\u{1f1e6}", &["\u{3a}\u{308}", "\u{1f1e6}"]),
+ ("\u{3a}\u{5d0}", &["\u{3a}", "\u{5d0}"]),
+ ("\u{3a}\u{308}\u{5d0}", &["\u{3a}\u{308}", "\u{5d0}"]),
+ ("\u{3a}\u{22}", &["\u{3a}", "\u{22}"]),
+ ("\u{3a}\u{308}\u{22}", &["\u{3a}\u{308}", "\u{22}"]),
+ ("\u{3a}\u{27}", &["\u{3a}", "\u{27}"]),
+ ("\u{3a}\u{308}\u{27}", &["\u{3a}\u{308}", "\u{27}"]),
+ ("\u{3a}\u{231a}", &["\u{3a}", "\u{231a}"]),
+ ("\u{3a}\u{308}\u{231a}", &["\u{3a}\u{308}", "\u{231a}"]),
+ ("\u{3a}\u{20}", &["\u{3a}", "\u{20}"]),
+ ("\u{3a}\u{308}\u{20}", &["\u{3a}\u{308}", "\u{20}"]),
+ ("\u{3a}\u{ad}", &["\u{3a}\u{ad}"]),
+ ("\u{3a}\u{308}\u{ad}", &["\u{3a}\u{308}\u{ad}"]),
+ ("\u{3a}\u{300}", &["\u{3a}\u{300}"]),
+ ("\u{3a}\u{308}\u{300}", &["\u{3a}\u{308}\u{300}"]),
+ ("\u{3a}\u{200d}", &["\u{3a}\u{200d}"]),
+ ("\u{3a}\u{308}\u{200d}", &["\u{3a}\u{308}\u{200d}"]),
+ ("\u{3a}\u{61}\u{2060}", &["\u{3a}", "\u{61}\u{2060}"]),
+ (
+ "\u{3a}\u{308}\u{61}\u{2060}",
+ &["\u{3a}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{3a}\u{61}\u{3a}", &["\u{3a}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{3a}\u{308}\u{61}\u{3a}",
+ &["\u{3a}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{3a}\u{61}\u{27}", &["\u{3a}", "\u{61}", "\u{27}"]),
+ (
+ "\u{3a}\u{308}\u{61}\u{27}",
+ &["\u{3a}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{3a}\u{61}\u{27}\u{2060}",
+ &["\u{3a}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{3a}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{3a}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{3a}\u{61}\u{2c}", &["\u{3a}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{3a}\u{308}\u{61}\u{2c}",
+ &["\u{3a}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{3a}\u{31}\u{3a}", &["\u{3a}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{3a}\u{308}\u{31}\u{3a}",
+ &["\u{3a}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{3a}\u{31}\u{27}", &["\u{3a}", "\u{31}", "\u{27}"]),
+ (
+ "\u{3a}\u{308}\u{31}\u{27}",
+ &["\u{3a}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{3a}\u{31}\u{2c}", &["\u{3a}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{3a}\u{308}\u{31}\u{2c}",
+ &["\u{3a}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{3a}\u{31}\u{2e}\u{2060}",
+ &["\u{3a}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{3a}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{3a}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{2c}\u{1}", &["\u{2c}", "\u{1}"]),
+ ("\u{2c}\u{308}\u{1}", &["\u{2c}\u{308}", "\u{1}"]),
+ ("\u{2c}\u{d}", &["\u{2c}", "\u{d}"]),
+ ("\u{2c}\u{308}\u{d}", &["\u{2c}\u{308}", "\u{d}"]),
+ ("\u{2c}\u{a}", &["\u{2c}", "\u{a}"]),
+ ("\u{2c}\u{308}\u{a}", &["\u{2c}\u{308}", "\u{a}"]),
+ ("\u{2c}\u{b}", &["\u{2c}", "\u{b}"]),
+ ("\u{2c}\u{308}\u{b}", &["\u{2c}\u{308}", "\u{b}"]),
+ ("\u{2c}\u{3031}", &["\u{2c}", "\u{3031}"]),
+ ("\u{2c}\u{308}\u{3031}", &["\u{2c}\u{308}", "\u{3031}"]),
+ ("\u{2c}\u{41}", &["\u{2c}", "\u{41}"]),
+ ("\u{2c}\u{308}\u{41}", &["\u{2c}\u{308}", "\u{41}"]),
+ ("\u{2c}\u{3a}", &["\u{2c}", "\u{3a}"]),
+ ("\u{2c}\u{308}\u{3a}", &["\u{2c}\u{308}", "\u{3a}"]),
+ ("\u{2c}\u{2c}", &["\u{2c}", "\u{2c}"]),
+ ("\u{2c}\u{308}\u{2c}", &["\u{2c}\u{308}", "\u{2c}"]),
+ ("\u{2c}\u{2e}", &["\u{2c}", "\u{2e}"]),
+ ("\u{2c}\u{308}\u{2e}", &["\u{2c}\u{308}", "\u{2e}"]),
+ ("\u{2c}\u{30}", &["\u{2c}", "\u{30}"]),
+ ("\u{2c}\u{308}\u{30}", &["\u{2c}\u{308}", "\u{30}"]),
+ ("\u{2c}\u{5f}", &["\u{2c}", "\u{5f}"]),
+ ("\u{2c}\u{308}\u{5f}", &["\u{2c}\u{308}", "\u{5f}"]),
+ ("\u{2c}\u{1f1e6}", &["\u{2c}", "\u{1f1e6}"]),
+ ("\u{2c}\u{308}\u{1f1e6}", &["\u{2c}\u{308}", "\u{1f1e6}"]),
+ ("\u{2c}\u{5d0}", &["\u{2c}", "\u{5d0}"]),
+ ("\u{2c}\u{308}\u{5d0}", &["\u{2c}\u{308}", "\u{5d0}"]),
+ ("\u{2c}\u{22}", &["\u{2c}", "\u{22}"]),
+ ("\u{2c}\u{308}\u{22}", &["\u{2c}\u{308}", "\u{22}"]),
+ ("\u{2c}\u{27}", &["\u{2c}", "\u{27}"]),
+ ("\u{2c}\u{308}\u{27}", &["\u{2c}\u{308}", "\u{27}"]),
+ ("\u{2c}\u{231a}", &["\u{2c}", "\u{231a}"]),
+ ("\u{2c}\u{308}\u{231a}", &["\u{2c}\u{308}", "\u{231a}"]),
+ ("\u{2c}\u{20}", &["\u{2c}", "\u{20}"]),
+ ("\u{2c}\u{308}\u{20}", &["\u{2c}\u{308}", "\u{20}"]),
+ ("\u{2c}\u{ad}", &["\u{2c}\u{ad}"]),
+ ("\u{2c}\u{308}\u{ad}", &["\u{2c}\u{308}\u{ad}"]),
+ ("\u{2c}\u{300}", &["\u{2c}\u{300}"]),
+ ("\u{2c}\u{308}\u{300}", &["\u{2c}\u{308}\u{300}"]),
+ ("\u{2c}\u{200d}", &["\u{2c}\u{200d}"]),
+ ("\u{2c}\u{308}\u{200d}", &["\u{2c}\u{308}\u{200d}"]),
+ ("\u{2c}\u{61}\u{2060}", &["\u{2c}", "\u{61}\u{2060}"]),
+ (
+ "\u{2c}\u{308}\u{61}\u{2060}",
+ &["\u{2c}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{2c}\u{61}\u{3a}", &["\u{2c}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{2c}\u{308}\u{61}\u{3a}",
+ &["\u{2c}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{2c}\u{61}\u{27}", &["\u{2c}", "\u{61}", "\u{27}"]),
+ (
+ "\u{2c}\u{308}\u{61}\u{27}",
+ &["\u{2c}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{2c}\u{61}\u{27}\u{2060}",
+ &["\u{2c}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{2c}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{2c}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{2c}\u{61}\u{2c}", &["\u{2c}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{2c}\u{308}\u{61}\u{2c}",
+ &["\u{2c}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{2c}\u{31}\u{3a}", &["\u{2c}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{2c}\u{308}\u{31}\u{3a}",
+ &["\u{2c}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{2c}\u{31}\u{27}", &["\u{2c}", "\u{31}", "\u{27}"]),
+ (
+ "\u{2c}\u{308}\u{31}\u{27}",
+ &["\u{2c}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{2c}\u{31}\u{2c}", &["\u{2c}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{2c}\u{308}\u{31}\u{2c}",
+ &["\u{2c}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{2c}\u{31}\u{2e}\u{2060}",
+ &["\u{2c}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{2c}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{2c}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{2e}\u{1}", &["\u{2e}", "\u{1}"]),
+ ("\u{2e}\u{308}\u{1}", &["\u{2e}\u{308}", "\u{1}"]),
+ ("\u{2e}\u{d}", &["\u{2e}", "\u{d}"]),
+ ("\u{2e}\u{308}\u{d}", &["\u{2e}\u{308}", "\u{d}"]),
+ ("\u{2e}\u{a}", &["\u{2e}", "\u{a}"]),
+ ("\u{2e}\u{308}\u{a}", &["\u{2e}\u{308}", "\u{a}"]),
+ ("\u{2e}\u{b}", &["\u{2e}", "\u{b}"]),
+ ("\u{2e}\u{308}\u{b}", &["\u{2e}\u{308}", "\u{b}"]),
+ ("\u{2e}\u{3031}", &["\u{2e}", "\u{3031}"]),
+ ("\u{2e}\u{308}\u{3031}", &["\u{2e}\u{308}", "\u{3031}"]),
+ ("\u{2e}\u{41}", &["\u{2e}", "\u{41}"]),
+ ("\u{2e}\u{308}\u{41}", &["\u{2e}\u{308}", "\u{41}"]),
+ ("\u{2e}\u{3a}", &["\u{2e}", "\u{3a}"]),
+ ("\u{2e}\u{308}\u{3a}", &["\u{2e}\u{308}", "\u{3a}"]),
+ ("\u{2e}\u{2c}", &["\u{2e}", "\u{2c}"]),
+ ("\u{2e}\u{308}\u{2c}", &["\u{2e}\u{308}", "\u{2c}"]),
+ ("\u{2e}\u{2e}", &["\u{2e}", "\u{2e}"]),
+ ("\u{2e}\u{308}\u{2e}", &["\u{2e}\u{308}", "\u{2e}"]),
+ ("\u{2e}\u{30}", &["\u{2e}", "\u{30}"]),
+ ("\u{2e}\u{308}\u{30}", &["\u{2e}\u{308}", "\u{30}"]),
+ ("\u{2e}\u{5f}", &["\u{2e}", "\u{5f}"]),
+ ("\u{2e}\u{308}\u{5f}", &["\u{2e}\u{308}", "\u{5f}"]),
+ ("\u{2e}\u{1f1e6}", &["\u{2e}", "\u{1f1e6}"]),
+ ("\u{2e}\u{308}\u{1f1e6}", &["\u{2e}\u{308}", "\u{1f1e6}"]),
+ ("\u{2e}\u{5d0}", &["\u{2e}", "\u{5d0}"]),
+ ("\u{2e}\u{308}\u{5d0}", &["\u{2e}\u{308}", "\u{5d0}"]),
+ ("\u{2e}\u{22}", &["\u{2e}", "\u{22}"]),
+ ("\u{2e}\u{308}\u{22}", &["\u{2e}\u{308}", "\u{22}"]),
+ ("\u{2e}\u{27}", &["\u{2e}", "\u{27}"]),
+ ("\u{2e}\u{308}\u{27}", &["\u{2e}\u{308}", "\u{27}"]),
+ ("\u{2e}\u{231a}", &["\u{2e}", "\u{231a}"]),
+ ("\u{2e}\u{308}\u{231a}", &["\u{2e}\u{308}", "\u{231a}"]),
+ ("\u{2e}\u{20}", &["\u{2e}", "\u{20}"]),
+ ("\u{2e}\u{308}\u{20}", &["\u{2e}\u{308}", "\u{20}"]),
+ ("\u{2e}\u{ad}", &["\u{2e}\u{ad}"]),
+ ("\u{2e}\u{308}\u{ad}", &["\u{2e}\u{308}\u{ad}"]),
+ ("\u{2e}\u{300}", &["\u{2e}\u{300}"]),
+ ("\u{2e}\u{308}\u{300}", &["\u{2e}\u{308}\u{300}"]),
+ ("\u{2e}\u{200d}", &["\u{2e}\u{200d}"]),
+ ("\u{2e}\u{308}\u{200d}", &["\u{2e}\u{308}\u{200d}"]),
+ ("\u{2e}\u{61}\u{2060}", &["\u{2e}", "\u{61}\u{2060}"]),
+ (
+ "\u{2e}\u{308}\u{61}\u{2060}",
+ &["\u{2e}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{2e}\u{61}\u{3a}", &["\u{2e}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{2e}\u{308}\u{61}\u{3a}",
+ &["\u{2e}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{2e}\u{61}\u{27}", &["\u{2e}", "\u{61}", "\u{27}"]),
+ (
+ "\u{2e}\u{308}\u{61}\u{27}",
+ &["\u{2e}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{2e}\u{61}\u{27}\u{2060}",
+ &["\u{2e}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{2e}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{2e}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{2e}\u{61}\u{2c}", &["\u{2e}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{2e}\u{308}\u{61}\u{2c}",
+ &["\u{2e}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{2e}\u{31}\u{3a}", &["\u{2e}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{2e}\u{308}\u{31}\u{3a}",
+ &["\u{2e}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{2e}\u{31}\u{27}", &["\u{2e}", "\u{31}", "\u{27}"]),
+ (
+ "\u{2e}\u{308}\u{31}\u{27}",
+ &["\u{2e}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{2e}\u{31}\u{2c}", &["\u{2e}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{2e}\u{308}\u{31}\u{2c}",
+ &["\u{2e}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{2e}\u{31}\u{2e}\u{2060}",
+ &["\u{2e}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{2e}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{2e}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{30}\u{1}", &["\u{30}", "\u{1}"]),
+ ("\u{30}\u{308}\u{1}", &["\u{30}\u{308}", "\u{1}"]),
+ ("\u{30}\u{d}", &["\u{30}", "\u{d}"]),
+ ("\u{30}\u{308}\u{d}", &["\u{30}\u{308}", "\u{d}"]),
+ ("\u{30}\u{a}", &["\u{30}", "\u{a}"]),
+ ("\u{30}\u{308}\u{a}", &["\u{30}\u{308}", "\u{a}"]),
+ ("\u{30}\u{b}", &["\u{30}", "\u{b}"]),
+ ("\u{30}\u{308}\u{b}", &["\u{30}\u{308}", "\u{b}"]),
+ ("\u{30}\u{3031}", &["\u{30}", "\u{3031}"]),
+ ("\u{30}\u{308}\u{3031}", &["\u{30}\u{308}", "\u{3031}"]),
+ ("\u{30}\u{41}", &["\u{30}\u{41}"]),
+ ("\u{30}\u{308}\u{41}", &["\u{30}\u{308}\u{41}"]),
+ ("\u{30}\u{3a}", &["\u{30}", "\u{3a}"]),
+ ("\u{30}\u{308}\u{3a}", &["\u{30}\u{308}", "\u{3a}"]),
+ ("\u{30}\u{2c}", &["\u{30}", "\u{2c}"]),
+ ("\u{30}\u{308}\u{2c}", &["\u{30}\u{308}", "\u{2c}"]),
+ ("\u{30}\u{2e}", &["\u{30}", "\u{2e}"]),
+ ("\u{30}\u{308}\u{2e}", &["\u{30}\u{308}", "\u{2e}"]),
+ ("\u{30}\u{30}", &["\u{30}\u{30}"]),
+ ("\u{30}\u{308}\u{30}", &["\u{30}\u{308}\u{30}"]),
+ ("\u{30}\u{5f}", &["\u{30}\u{5f}"]),
+ ("\u{30}\u{308}\u{5f}", &["\u{30}\u{308}\u{5f}"]),
+ ("\u{30}\u{1f1e6}", &["\u{30}", "\u{1f1e6}"]),
+ ("\u{30}\u{308}\u{1f1e6}", &["\u{30}\u{308}", "\u{1f1e6}"]),
+ ("\u{30}\u{5d0}", &["\u{30}\u{5d0}"]),
+ ("\u{30}\u{308}\u{5d0}", &["\u{30}\u{308}\u{5d0}"]),
+ ("\u{30}\u{22}", &["\u{30}", "\u{22}"]),
+ ("\u{30}\u{308}\u{22}", &["\u{30}\u{308}", "\u{22}"]),
+ ("\u{30}\u{27}", &["\u{30}", "\u{27}"]),
+ ("\u{30}\u{308}\u{27}", &["\u{30}\u{308}", "\u{27}"]),
+ ("\u{30}\u{231a}", &["\u{30}", "\u{231a}"]),
+ ("\u{30}\u{308}\u{231a}", &["\u{30}\u{308}", "\u{231a}"]),
+ ("\u{30}\u{20}", &["\u{30}", "\u{20}"]),
+ ("\u{30}\u{308}\u{20}", &["\u{30}\u{308}", "\u{20}"]),
+ ("\u{30}\u{ad}", &["\u{30}\u{ad}"]),
+ ("\u{30}\u{308}\u{ad}", &["\u{30}\u{308}\u{ad}"]),
+ ("\u{30}\u{300}", &["\u{30}\u{300}"]),
+ ("\u{30}\u{308}\u{300}", &["\u{30}\u{308}\u{300}"]),
+ ("\u{30}\u{200d}", &["\u{30}\u{200d}"]),
+ ("\u{30}\u{308}\u{200d}", &["\u{30}\u{308}\u{200d}"]),
+ ("\u{30}\u{61}\u{2060}", &["\u{30}\u{61}\u{2060}"]),
+ (
+ "\u{30}\u{308}\u{61}\u{2060}",
+ &["\u{30}\u{308}\u{61}\u{2060}"],
+ ),
+ ("\u{30}\u{61}\u{3a}", &["\u{30}\u{61}", "\u{3a}"]),
+ (
+ "\u{30}\u{308}\u{61}\u{3a}",
+ &["\u{30}\u{308}\u{61}", "\u{3a}"],
+ ),
+ ("\u{30}\u{61}\u{27}", &["\u{30}\u{61}", "\u{27}"]),
+ (
+ "\u{30}\u{308}\u{61}\u{27}",
+ &["\u{30}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{30}\u{61}\u{27}\u{2060}",
+ &["\u{30}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{30}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{30}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{30}\u{61}\u{2c}", &["\u{30}\u{61}", "\u{2c}"]),
+ (
+ "\u{30}\u{308}\u{61}\u{2c}",
+ &["\u{30}\u{308}\u{61}", "\u{2c}"],
+ ),
+ ("\u{30}\u{31}\u{3a}", &["\u{30}\u{31}", "\u{3a}"]),
+ (
+ "\u{30}\u{308}\u{31}\u{3a}",
+ &["\u{30}\u{308}\u{31}", "\u{3a}"],
+ ),
+ ("\u{30}\u{31}\u{27}", &["\u{30}\u{31}", "\u{27}"]),
+ (
+ "\u{30}\u{308}\u{31}\u{27}",
+ &["\u{30}\u{308}\u{31}", "\u{27}"],
+ ),
+ ("\u{30}\u{31}\u{2c}", &["\u{30}\u{31}", "\u{2c}"]),
+ (
+ "\u{30}\u{308}\u{31}\u{2c}",
+ &["\u{30}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{30}\u{31}\u{2e}\u{2060}",
+ &["\u{30}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{30}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{30}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{5f}\u{1}", &["\u{5f}", "\u{1}"]),
+ ("\u{5f}\u{308}\u{1}", &["\u{5f}\u{308}", "\u{1}"]),
+ ("\u{5f}\u{d}", &["\u{5f}", "\u{d}"]),
+ ("\u{5f}\u{308}\u{d}", &["\u{5f}\u{308}", "\u{d}"]),
+ ("\u{5f}\u{a}", &["\u{5f}", "\u{a}"]),
+ ("\u{5f}\u{308}\u{a}", &["\u{5f}\u{308}", "\u{a}"]),
+ ("\u{5f}\u{b}", &["\u{5f}", "\u{b}"]),
+ ("\u{5f}\u{308}\u{b}", &["\u{5f}\u{308}", "\u{b}"]),
+ ("\u{5f}\u{3031}", &["\u{5f}\u{3031}"]),
+ ("\u{5f}\u{308}\u{3031}", &["\u{5f}\u{308}\u{3031}"]),
+ ("\u{5f}\u{41}", &["\u{5f}\u{41}"]),
+ ("\u{5f}\u{308}\u{41}", &["\u{5f}\u{308}\u{41}"]),
+ ("\u{5f}\u{3a}", &["\u{5f}", "\u{3a}"]),
+ ("\u{5f}\u{308}\u{3a}", &["\u{5f}\u{308}", "\u{3a}"]),
+ ("\u{5f}\u{2c}", &["\u{5f}", "\u{2c}"]),
+ ("\u{5f}\u{308}\u{2c}", &["\u{5f}\u{308}", "\u{2c}"]),
+ ("\u{5f}\u{2e}", &["\u{5f}", "\u{2e}"]),
+ ("\u{5f}\u{308}\u{2e}", &["\u{5f}\u{308}", "\u{2e}"]),
+ ("\u{5f}\u{30}", &["\u{5f}\u{30}"]),
+ ("\u{5f}\u{308}\u{30}", &["\u{5f}\u{308}\u{30}"]),
+ ("\u{5f}\u{5f}", &["\u{5f}\u{5f}"]),
+ ("\u{5f}\u{308}\u{5f}", &["\u{5f}\u{308}\u{5f}"]),
+ ("\u{5f}\u{1f1e6}", &["\u{5f}", "\u{1f1e6}"]),
+ ("\u{5f}\u{308}\u{1f1e6}", &["\u{5f}\u{308}", "\u{1f1e6}"]),
+ ("\u{5f}\u{5d0}", &["\u{5f}\u{5d0}"]),
+ ("\u{5f}\u{308}\u{5d0}", &["\u{5f}\u{308}\u{5d0}"]),
+ ("\u{5f}\u{22}", &["\u{5f}", "\u{22}"]),
+ ("\u{5f}\u{308}\u{22}", &["\u{5f}\u{308}", "\u{22}"]),
+ ("\u{5f}\u{27}", &["\u{5f}", "\u{27}"]),
+ ("\u{5f}\u{308}\u{27}", &["\u{5f}\u{308}", "\u{27}"]),
+ ("\u{5f}\u{231a}", &["\u{5f}", "\u{231a}"]),
+ ("\u{5f}\u{308}\u{231a}", &["\u{5f}\u{308}", "\u{231a}"]),
+ ("\u{5f}\u{20}", &["\u{5f}", "\u{20}"]),
+ ("\u{5f}\u{308}\u{20}", &["\u{5f}\u{308}", "\u{20}"]),
+ ("\u{5f}\u{ad}", &["\u{5f}\u{ad}"]),
+ ("\u{5f}\u{308}\u{ad}", &["\u{5f}\u{308}\u{ad}"]),
+ ("\u{5f}\u{300}", &["\u{5f}\u{300}"]),
+ ("\u{5f}\u{308}\u{300}", &["\u{5f}\u{308}\u{300}"]),
+ ("\u{5f}\u{200d}", &["\u{5f}\u{200d}"]),
+ ("\u{5f}\u{308}\u{200d}", &["\u{5f}\u{308}\u{200d}"]),
+ ("\u{5f}\u{61}\u{2060}", &["\u{5f}\u{61}\u{2060}"]),
+ (
+ "\u{5f}\u{308}\u{61}\u{2060}",
+ &["\u{5f}\u{308}\u{61}\u{2060}"],
+ ),
+ ("\u{5f}\u{61}\u{3a}", &["\u{5f}\u{61}", "\u{3a}"]),
+ (
+ "\u{5f}\u{308}\u{61}\u{3a}",
+ &["\u{5f}\u{308}\u{61}", "\u{3a}"],
+ ),
+ ("\u{5f}\u{61}\u{27}", &["\u{5f}\u{61}", "\u{27}"]),
+ (
+ "\u{5f}\u{308}\u{61}\u{27}",
+ &["\u{5f}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{5f}\u{61}\u{27}\u{2060}",
+ &["\u{5f}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{5f}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{5f}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{5f}\u{61}\u{2c}", &["\u{5f}\u{61}", "\u{2c}"]),
+ (
+ "\u{5f}\u{308}\u{61}\u{2c}",
+ &["\u{5f}\u{308}\u{61}", "\u{2c}"],
+ ),
+ ("\u{5f}\u{31}\u{3a}", &["\u{5f}\u{31}", "\u{3a}"]),
+ (
+ "\u{5f}\u{308}\u{31}\u{3a}",
+ &["\u{5f}\u{308}\u{31}", "\u{3a}"],
+ ),
+ ("\u{5f}\u{31}\u{27}", &["\u{5f}\u{31}", "\u{27}"]),
+ (
+ "\u{5f}\u{308}\u{31}\u{27}",
+ &["\u{5f}\u{308}\u{31}", "\u{27}"],
+ ),
+ ("\u{5f}\u{31}\u{2c}", &["\u{5f}\u{31}", "\u{2c}"]),
+ (
+ "\u{5f}\u{308}\u{31}\u{2c}",
+ &["\u{5f}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{5f}\u{31}\u{2e}\u{2060}",
+ &["\u{5f}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{5f}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{5f}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{1f1e6}\u{1}", &["\u{1f1e6}", "\u{1}"]),
+ ("\u{1f1e6}\u{308}\u{1}", &["\u{1f1e6}\u{308}", "\u{1}"]),
+ ("\u{1f1e6}\u{d}", &["\u{1f1e6}", "\u{d}"]),
+ ("\u{1f1e6}\u{308}\u{d}", &["\u{1f1e6}\u{308}", "\u{d}"]),
+ ("\u{1f1e6}\u{a}", &["\u{1f1e6}", "\u{a}"]),
+ ("\u{1f1e6}\u{308}\u{a}", &["\u{1f1e6}\u{308}", "\u{a}"]),
+ ("\u{1f1e6}\u{b}", &["\u{1f1e6}", "\u{b}"]),
+ ("\u{1f1e6}\u{308}\u{b}", &["\u{1f1e6}\u{308}", "\u{b}"]),
+ ("\u{1f1e6}\u{3031}", &["\u{1f1e6}", "\u{3031}"]),
+ (
+ "\u{1f1e6}\u{308}\u{3031}",
+ &["\u{1f1e6}\u{308}", "\u{3031}"],
+ ),
+ ("\u{1f1e6}\u{41}", &["\u{1f1e6}", "\u{41}"]),
+ ("\u{1f1e6}\u{308}\u{41}", &["\u{1f1e6}\u{308}", "\u{41}"]),
+ ("\u{1f1e6}\u{3a}", &["\u{1f1e6}", "\u{3a}"]),
+ ("\u{1f1e6}\u{308}\u{3a}", &["\u{1f1e6}\u{308}", "\u{3a}"]),
+ ("\u{1f1e6}\u{2c}", &["\u{1f1e6}", "\u{2c}"]),
+ ("\u{1f1e6}\u{308}\u{2c}", &["\u{1f1e6}\u{308}", "\u{2c}"]),
+ ("\u{1f1e6}\u{2e}", &["\u{1f1e6}", "\u{2e}"]),
+ ("\u{1f1e6}\u{308}\u{2e}", &["\u{1f1e6}\u{308}", "\u{2e}"]),
+ ("\u{1f1e6}\u{30}", &["\u{1f1e6}", "\u{30}"]),
+ ("\u{1f1e6}\u{308}\u{30}", &["\u{1f1e6}\u{308}", "\u{30}"]),
+ ("\u{1f1e6}\u{5f}", &["\u{1f1e6}", "\u{5f}"]),
+ ("\u{1f1e6}\u{308}\u{5f}", &["\u{1f1e6}\u{308}", "\u{5f}"]),
+ ("\u{1f1e6}\u{1f1e6}", &["\u{1f1e6}\u{1f1e6}"]),
+ ("\u{1f1e6}\u{308}\u{1f1e6}", &["\u{1f1e6}\u{308}\u{1f1e6}"]),
+ ("\u{1f1e6}\u{5d0}", &["\u{1f1e6}", "\u{5d0}"]),
+ ("\u{1f1e6}\u{308}\u{5d0}", &["\u{1f1e6}\u{308}", "\u{5d0}"]),
+ ("\u{1f1e6}\u{22}", &["\u{1f1e6}", "\u{22}"]),
+ ("\u{1f1e6}\u{308}\u{22}", &["\u{1f1e6}\u{308}", "\u{22}"]),
+ ("\u{1f1e6}\u{27}", &["\u{1f1e6}", "\u{27}"]),
+ ("\u{1f1e6}\u{308}\u{27}", &["\u{1f1e6}\u{308}", "\u{27}"]),
+ ("\u{1f1e6}\u{231a}", &["\u{1f1e6}", "\u{231a}"]),
+ (
+ "\u{1f1e6}\u{308}\u{231a}",
+ &["\u{1f1e6}\u{308}", "\u{231a}"],
+ ),
+ ("\u{1f1e6}\u{20}", &["\u{1f1e6}", "\u{20}"]),
+ ("\u{1f1e6}\u{308}\u{20}", &["\u{1f1e6}\u{308}", "\u{20}"]),
+ ("\u{1f1e6}\u{ad}", &["\u{1f1e6}\u{ad}"]),
+ ("\u{1f1e6}\u{308}\u{ad}", &["\u{1f1e6}\u{308}\u{ad}"]),
+ ("\u{1f1e6}\u{300}", &["\u{1f1e6}\u{300}"]),
+ ("\u{1f1e6}\u{308}\u{300}", &["\u{1f1e6}\u{308}\u{300}"]),
+ ("\u{1f1e6}\u{200d}", &["\u{1f1e6}\u{200d}"]),
+ ("\u{1f1e6}\u{308}\u{200d}", &["\u{1f1e6}\u{308}\u{200d}"]),
+ ("\u{1f1e6}\u{61}\u{2060}", &["\u{1f1e6}", "\u{61}\u{2060}"]),
+ (
+ "\u{1f1e6}\u{308}\u{61}\u{2060}",
+ &["\u{1f1e6}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{1f1e6}\u{61}\u{3a}", &["\u{1f1e6}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{1f1e6}\u{308}\u{61}\u{3a}",
+ &["\u{1f1e6}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{1f1e6}\u{61}\u{27}", &["\u{1f1e6}", "\u{61}", "\u{27}"]),
+ (
+ "\u{1f1e6}\u{308}\u{61}\u{27}",
+ &["\u{1f1e6}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{1f1e6}\u{61}\u{27}\u{2060}",
+ &["\u{1f1e6}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{1f1e6}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{1f1e6}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{1f1e6}\u{61}\u{2c}", &["\u{1f1e6}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{1f1e6}\u{308}\u{61}\u{2c}",
+ &["\u{1f1e6}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{1f1e6}\u{31}\u{3a}", &["\u{1f1e6}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{1f1e6}\u{308}\u{31}\u{3a}",
+ &["\u{1f1e6}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{1f1e6}\u{31}\u{27}", &["\u{1f1e6}", "\u{31}", "\u{27}"]),
+ (
+ "\u{1f1e6}\u{308}\u{31}\u{27}",
+ &["\u{1f1e6}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{1f1e6}\u{31}\u{2c}", &["\u{1f1e6}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{1f1e6}\u{308}\u{31}\u{2c}",
+ &["\u{1f1e6}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{1f1e6}\u{31}\u{2e}\u{2060}",
+ &["\u{1f1e6}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{1f1e6}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{1f1e6}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{5d0}\u{1}", &["\u{5d0}", "\u{1}"]),
+ ("\u{5d0}\u{308}\u{1}", &["\u{5d0}\u{308}", "\u{1}"]),
+ ("\u{5d0}\u{d}", &["\u{5d0}", "\u{d}"]),
+ ("\u{5d0}\u{308}\u{d}", &["\u{5d0}\u{308}", "\u{d}"]),
+ ("\u{5d0}\u{a}", &["\u{5d0}", "\u{a}"]),
+ ("\u{5d0}\u{308}\u{a}", &["\u{5d0}\u{308}", "\u{a}"]),
+ ("\u{5d0}\u{b}", &["\u{5d0}", "\u{b}"]),
+ ("\u{5d0}\u{308}\u{b}", &["\u{5d0}\u{308}", "\u{b}"]),
+ ("\u{5d0}\u{3031}", &["\u{5d0}", "\u{3031}"]),
+ ("\u{5d0}\u{308}\u{3031}", &["\u{5d0}\u{308}", "\u{3031}"]),
+ ("\u{5d0}\u{41}", &["\u{5d0}\u{41}"]),
+ ("\u{5d0}\u{308}\u{41}", &["\u{5d0}\u{308}\u{41}"]),
+ ("\u{5d0}\u{3a}", &["\u{5d0}", "\u{3a}"]),
+ ("\u{5d0}\u{308}\u{3a}", &["\u{5d0}\u{308}", "\u{3a}"]),
+ ("\u{5d0}\u{2c}", &["\u{5d0}", "\u{2c}"]),
+ ("\u{5d0}\u{308}\u{2c}", &["\u{5d0}\u{308}", "\u{2c}"]),
+ ("\u{5d0}\u{2e}", &["\u{5d0}", "\u{2e}"]),
+ ("\u{5d0}\u{308}\u{2e}", &["\u{5d0}\u{308}", "\u{2e}"]),
+ ("\u{5d0}\u{30}", &["\u{5d0}\u{30}"]),
+ ("\u{5d0}\u{308}\u{30}", &["\u{5d0}\u{308}\u{30}"]),
+ ("\u{5d0}\u{5f}", &["\u{5d0}\u{5f}"]),
+ ("\u{5d0}\u{308}\u{5f}", &["\u{5d0}\u{308}\u{5f}"]),
+ ("\u{5d0}\u{1f1e6}", &["\u{5d0}", "\u{1f1e6}"]),
+ ("\u{5d0}\u{308}\u{1f1e6}", &["\u{5d0}\u{308}", "\u{1f1e6}"]),
+ ("\u{5d0}\u{5d0}", &["\u{5d0}\u{5d0}"]),
+ ("\u{5d0}\u{308}\u{5d0}", &["\u{5d0}\u{308}\u{5d0}"]),
+ ("\u{5d0}\u{22}", &["\u{5d0}", "\u{22}"]),
+ ("\u{5d0}\u{308}\u{22}", &["\u{5d0}\u{308}", "\u{22}"]),
+ ("\u{5d0}\u{27}", &["\u{5d0}\u{27}"]),
+ ("\u{5d0}\u{308}\u{27}", &["\u{5d0}\u{308}\u{27}"]),
+ ("\u{5d0}\u{231a}", &["\u{5d0}", "\u{231a}"]),
+ ("\u{5d0}\u{308}\u{231a}", &["\u{5d0}\u{308}", "\u{231a}"]),
+ ("\u{5d0}\u{20}", &["\u{5d0}", "\u{20}"]),
+ ("\u{5d0}\u{308}\u{20}", &["\u{5d0}\u{308}", "\u{20}"]),
+ ("\u{5d0}\u{ad}", &["\u{5d0}\u{ad}"]),
+ ("\u{5d0}\u{308}\u{ad}", &["\u{5d0}\u{308}\u{ad}"]),
+ ("\u{5d0}\u{300}", &["\u{5d0}\u{300}"]),
+ ("\u{5d0}\u{308}\u{300}", &["\u{5d0}\u{308}\u{300}"]),
+ ("\u{5d0}\u{200d}", &["\u{5d0}\u{200d}"]),
+ ("\u{5d0}\u{308}\u{200d}", &["\u{5d0}\u{308}\u{200d}"]),
+ ("\u{5d0}\u{61}\u{2060}", &["\u{5d0}\u{61}\u{2060}"]),
+ (
+ "\u{5d0}\u{308}\u{61}\u{2060}",
+ &["\u{5d0}\u{308}\u{61}\u{2060}"],
+ ),
+ ("\u{5d0}\u{61}\u{3a}", &["\u{5d0}\u{61}", "\u{3a}"]),
+ (
+ "\u{5d0}\u{308}\u{61}\u{3a}",
+ &["\u{5d0}\u{308}\u{61}", "\u{3a}"],
+ ),
+ ("\u{5d0}\u{61}\u{27}", &["\u{5d0}\u{61}", "\u{27}"]),
+ (
+ "\u{5d0}\u{308}\u{61}\u{27}",
+ &["\u{5d0}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{5d0}\u{61}\u{27}\u{2060}",
+ &["\u{5d0}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{5d0}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{5d0}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{5d0}\u{61}\u{2c}", &["\u{5d0}\u{61}", "\u{2c}"]),
+ (
+ "\u{5d0}\u{308}\u{61}\u{2c}",
+ &["\u{5d0}\u{308}\u{61}", "\u{2c}"],
+ ),
+ ("\u{5d0}\u{31}\u{3a}", &["\u{5d0}\u{31}", "\u{3a}"]),
+ (
+ "\u{5d0}\u{308}\u{31}\u{3a}",
+ &["\u{5d0}\u{308}\u{31}", "\u{3a}"],
+ ),
+ ("\u{5d0}\u{31}\u{27}", &["\u{5d0}\u{31}", "\u{27}"]),
+ (
+ "\u{5d0}\u{308}\u{31}\u{27}",
+ &["\u{5d0}\u{308}\u{31}", "\u{27}"],
+ ),
+ ("\u{5d0}\u{31}\u{2c}", &["\u{5d0}\u{31}", "\u{2c}"]),
+ (
+ "\u{5d0}\u{308}\u{31}\u{2c}",
+ &["\u{5d0}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{5d0}\u{31}\u{2e}\u{2060}",
+ &["\u{5d0}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{5d0}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{5d0}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{22}\u{1}", &["\u{22}", "\u{1}"]),
+ ("\u{22}\u{308}\u{1}", &["\u{22}\u{308}", "\u{1}"]),
+ ("\u{22}\u{d}", &["\u{22}", "\u{d}"]),
+ ("\u{22}\u{308}\u{d}", &["\u{22}\u{308}", "\u{d}"]),
+ ("\u{22}\u{a}", &["\u{22}", "\u{a}"]),
+ ("\u{22}\u{308}\u{a}", &["\u{22}\u{308}", "\u{a}"]),
+ ("\u{22}\u{b}", &["\u{22}", "\u{b}"]),
+ ("\u{22}\u{308}\u{b}", &["\u{22}\u{308}", "\u{b}"]),
+ ("\u{22}\u{3031}", &["\u{22}", "\u{3031}"]),
+ ("\u{22}\u{308}\u{3031}", &["\u{22}\u{308}", "\u{3031}"]),
+ ("\u{22}\u{41}", &["\u{22}", "\u{41}"]),
+ ("\u{22}\u{308}\u{41}", &["\u{22}\u{308}", "\u{41}"]),
+ ("\u{22}\u{3a}", &["\u{22}", "\u{3a}"]),
+ ("\u{22}\u{308}\u{3a}", &["\u{22}\u{308}", "\u{3a}"]),
+ ("\u{22}\u{2c}", &["\u{22}", "\u{2c}"]),
+ ("\u{22}\u{308}\u{2c}", &["\u{22}\u{308}", "\u{2c}"]),
+ ("\u{22}\u{2e}", &["\u{22}", "\u{2e}"]),
+ ("\u{22}\u{308}\u{2e}", &["\u{22}\u{308}", "\u{2e}"]),
+ ("\u{22}\u{30}", &["\u{22}", "\u{30}"]),
+ ("\u{22}\u{308}\u{30}", &["\u{22}\u{308}", "\u{30}"]),
+ ("\u{22}\u{5f}", &["\u{22}", "\u{5f}"]),
+ ("\u{22}\u{308}\u{5f}", &["\u{22}\u{308}", "\u{5f}"]),
+ ("\u{22}\u{1f1e6}", &["\u{22}", "\u{1f1e6}"]),
+ ("\u{22}\u{308}\u{1f1e6}", &["\u{22}\u{308}", "\u{1f1e6}"]),
+ ("\u{22}\u{5d0}", &["\u{22}", "\u{5d0}"]),
+ ("\u{22}\u{308}\u{5d0}", &["\u{22}\u{308}", "\u{5d0}"]),
+ ("\u{22}\u{22}", &["\u{22}", "\u{22}"]),
+ ("\u{22}\u{308}\u{22}", &["\u{22}\u{308}", "\u{22}"]),
+ ("\u{22}\u{27}", &["\u{22}", "\u{27}"]),
+ ("\u{22}\u{308}\u{27}", &["\u{22}\u{308}", "\u{27}"]),
+ ("\u{22}\u{231a}", &["\u{22}", "\u{231a}"]),
+ ("\u{22}\u{308}\u{231a}", &["\u{22}\u{308}", "\u{231a}"]),
+ ("\u{22}\u{20}", &["\u{22}", "\u{20}"]),
+ ("\u{22}\u{308}\u{20}", &["\u{22}\u{308}", "\u{20}"]),
+ ("\u{22}\u{ad}", &["\u{22}\u{ad}"]),
+ ("\u{22}\u{308}\u{ad}", &["\u{22}\u{308}\u{ad}"]),
+ ("\u{22}\u{300}", &["\u{22}\u{300}"]),
+ ("\u{22}\u{308}\u{300}", &["\u{22}\u{308}\u{300}"]),
+ ("\u{22}\u{200d}", &["\u{22}\u{200d}"]),
+ ("\u{22}\u{308}\u{200d}", &["\u{22}\u{308}\u{200d}"]),
+ ("\u{22}\u{61}\u{2060}", &["\u{22}", "\u{61}\u{2060}"]),
+ (
+ "\u{22}\u{308}\u{61}\u{2060}",
+ &["\u{22}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{22}\u{61}\u{3a}", &["\u{22}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{22}\u{308}\u{61}\u{3a}",
+ &["\u{22}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{22}\u{61}\u{27}", &["\u{22}", "\u{61}", "\u{27}"]),
+ (
+ "\u{22}\u{308}\u{61}\u{27}",
+ &["\u{22}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{22}\u{61}\u{27}\u{2060}",
+ &["\u{22}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{22}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{22}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{22}\u{61}\u{2c}", &["\u{22}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{22}\u{308}\u{61}\u{2c}",
+ &["\u{22}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{22}\u{31}\u{3a}", &["\u{22}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{22}\u{308}\u{31}\u{3a}",
+ &["\u{22}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{22}\u{31}\u{27}", &["\u{22}", "\u{31}", "\u{27}"]),
+ (
+ "\u{22}\u{308}\u{31}\u{27}",
+ &["\u{22}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{22}\u{31}\u{2c}", &["\u{22}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{22}\u{308}\u{31}\u{2c}",
+ &["\u{22}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{22}\u{31}\u{2e}\u{2060}",
+ &["\u{22}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{22}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{22}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{27}\u{1}", &["\u{27}", "\u{1}"]),
+ ("\u{27}\u{308}\u{1}", &["\u{27}\u{308}", "\u{1}"]),
+ ("\u{27}\u{d}", &["\u{27}", "\u{d}"]),
+ ("\u{27}\u{308}\u{d}", &["\u{27}\u{308}", "\u{d}"]),
+ ("\u{27}\u{a}", &["\u{27}", "\u{a}"]),
+ ("\u{27}\u{308}\u{a}", &["\u{27}\u{308}", "\u{a}"]),
+ ("\u{27}\u{b}", &["\u{27}", "\u{b}"]),
+ ("\u{27}\u{308}\u{b}", &["\u{27}\u{308}", "\u{b}"]),
+ ("\u{27}\u{3031}", &["\u{27}", "\u{3031}"]),
+ ("\u{27}\u{308}\u{3031}", &["\u{27}\u{308}", "\u{3031}"]),
+ ("\u{27}\u{41}", &["\u{27}", "\u{41}"]),
+ ("\u{27}\u{308}\u{41}", &["\u{27}\u{308}", "\u{41}"]),
+ ("\u{27}\u{3a}", &["\u{27}", "\u{3a}"]),
+ ("\u{27}\u{308}\u{3a}", &["\u{27}\u{308}", "\u{3a}"]),
+ ("\u{27}\u{2c}", &["\u{27}", "\u{2c}"]),
+ ("\u{27}\u{308}\u{2c}", &["\u{27}\u{308}", "\u{2c}"]),
+ ("\u{27}\u{2e}", &["\u{27}", "\u{2e}"]),
+ ("\u{27}\u{308}\u{2e}", &["\u{27}\u{308}", "\u{2e}"]),
+ ("\u{27}\u{30}", &["\u{27}", "\u{30}"]),
+ ("\u{27}\u{308}\u{30}", &["\u{27}\u{308}", "\u{30}"]),
+ ("\u{27}\u{5f}", &["\u{27}", "\u{5f}"]),
+ ("\u{27}\u{308}\u{5f}", &["\u{27}\u{308}", "\u{5f}"]),
+ ("\u{27}\u{1f1e6}", &["\u{27}", "\u{1f1e6}"]),
+ ("\u{27}\u{308}\u{1f1e6}", &["\u{27}\u{308}", "\u{1f1e6}"]),
+ ("\u{27}\u{5d0}", &["\u{27}", "\u{5d0}"]),
+ ("\u{27}\u{308}\u{5d0}", &["\u{27}\u{308}", "\u{5d0}"]),
+ ("\u{27}\u{22}", &["\u{27}", "\u{22}"]),
+ ("\u{27}\u{308}\u{22}", &["\u{27}\u{308}", "\u{22}"]),
+ ("\u{27}\u{27}", &["\u{27}", "\u{27}"]),
+ ("\u{27}\u{308}\u{27}", &["\u{27}\u{308}", "\u{27}"]),
+ ("\u{27}\u{231a}", &["\u{27}", "\u{231a}"]),
+ ("\u{27}\u{308}\u{231a}", &["\u{27}\u{308}", "\u{231a}"]),
+ ("\u{27}\u{20}", &["\u{27}", "\u{20}"]),
+ ("\u{27}\u{308}\u{20}", &["\u{27}\u{308}", "\u{20}"]),
+ ("\u{27}\u{ad}", &["\u{27}\u{ad}"]),
+ ("\u{27}\u{308}\u{ad}", &["\u{27}\u{308}\u{ad}"]),
+ ("\u{27}\u{300}", &["\u{27}\u{300}"]),
+ ("\u{27}\u{308}\u{300}", &["\u{27}\u{308}\u{300}"]),
+ ("\u{27}\u{200d}", &["\u{27}\u{200d}"]),
+ ("\u{27}\u{308}\u{200d}", &["\u{27}\u{308}\u{200d}"]),
+ ("\u{27}\u{61}\u{2060}", &["\u{27}", "\u{61}\u{2060}"]),
+ (
+ "\u{27}\u{308}\u{61}\u{2060}",
+ &["\u{27}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{27}\u{61}\u{3a}", &["\u{27}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{27}\u{308}\u{61}\u{3a}",
+ &["\u{27}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{27}\u{61}\u{27}", &["\u{27}", "\u{61}", "\u{27}"]),
+ (
+ "\u{27}\u{308}\u{61}\u{27}",
+ &["\u{27}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{27}\u{61}\u{27}\u{2060}",
+ &["\u{27}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{27}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{27}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{27}\u{61}\u{2c}", &["\u{27}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{27}\u{308}\u{61}\u{2c}",
+ &["\u{27}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{27}\u{31}\u{3a}", &["\u{27}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{27}\u{308}\u{31}\u{3a}",
+ &["\u{27}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{27}\u{31}\u{27}", &["\u{27}", "\u{31}", "\u{27}"]),
+ (
+ "\u{27}\u{308}\u{31}\u{27}",
+ &["\u{27}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{27}\u{31}\u{2c}", &["\u{27}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{27}\u{308}\u{31}\u{2c}",
+ &["\u{27}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{27}\u{31}\u{2e}\u{2060}",
+ &["\u{27}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{27}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{27}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{231a}\u{1}", &["\u{231a}", "\u{1}"]),
+ ("\u{231a}\u{308}\u{1}", &["\u{231a}\u{308}", "\u{1}"]),
+ ("\u{231a}\u{d}", &["\u{231a}", "\u{d}"]),
+ ("\u{231a}\u{308}\u{d}", &["\u{231a}\u{308}", "\u{d}"]),
+ ("\u{231a}\u{a}", &["\u{231a}", "\u{a}"]),
+ ("\u{231a}\u{308}\u{a}", &["\u{231a}\u{308}", "\u{a}"]),
+ ("\u{231a}\u{b}", &["\u{231a}", "\u{b}"]),
+ ("\u{231a}\u{308}\u{b}", &["\u{231a}\u{308}", "\u{b}"]),
+ ("\u{231a}\u{3031}", &["\u{231a}", "\u{3031}"]),
+ ("\u{231a}\u{308}\u{3031}", &["\u{231a}\u{308}", "\u{3031}"]),
+ ("\u{231a}\u{41}", &["\u{231a}", "\u{41}"]),
+ ("\u{231a}\u{308}\u{41}", &["\u{231a}\u{308}", "\u{41}"]),
+ ("\u{231a}\u{3a}", &["\u{231a}", "\u{3a}"]),
+ ("\u{231a}\u{308}\u{3a}", &["\u{231a}\u{308}", "\u{3a}"]),
+ ("\u{231a}\u{2c}", &["\u{231a}", "\u{2c}"]),
+ ("\u{231a}\u{308}\u{2c}", &["\u{231a}\u{308}", "\u{2c}"]),
+ ("\u{231a}\u{2e}", &["\u{231a}", "\u{2e}"]),
+ ("\u{231a}\u{308}\u{2e}", &["\u{231a}\u{308}", "\u{2e}"]),
+ ("\u{231a}\u{30}", &["\u{231a}", "\u{30}"]),
+ ("\u{231a}\u{308}\u{30}", &["\u{231a}\u{308}", "\u{30}"]),
+ ("\u{231a}\u{5f}", &["\u{231a}", "\u{5f}"]),
+ ("\u{231a}\u{308}\u{5f}", &["\u{231a}\u{308}", "\u{5f}"]),
+ ("\u{231a}\u{1f1e6}", &["\u{231a}", "\u{1f1e6}"]),
+ (
+ "\u{231a}\u{308}\u{1f1e6}",
+ &["\u{231a}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{231a}\u{5d0}", &["\u{231a}", "\u{5d0}"]),
+ ("\u{231a}\u{308}\u{5d0}", &["\u{231a}\u{308}", "\u{5d0}"]),
+ ("\u{231a}\u{22}", &["\u{231a}", "\u{22}"]),
+ ("\u{231a}\u{308}\u{22}", &["\u{231a}\u{308}", "\u{22}"]),
+ ("\u{231a}\u{27}", &["\u{231a}", "\u{27}"]),
+ ("\u{231a}\u{308}\u{27}", &["\u{231a}\u{308}", "\u{27}"]),
+ ("\u{231a}\u{231a}", &["\u{231a}", "\u{231a}"]),
+ ("\u{231a}\u{308}\u{231a}", &["\u{231a}\u{308}", "\u{231a}"]),
+ ("\u{231a}\u{20}", &["\u{231a}", "\u{20}"]),
+ ("\u{231a}\u{308}\u{20}", &["\u{231a}\u{308}", "\u{20}"]),
+ ("\u{231a}\u{ad}", &["\u{231a}\u{ad}"]),
+ ("\u{231a}\u{308}\u{ad}", &["\u{231a}\u{308}\u{ad}"]),
+ ("\u{231a}\u{300}", &["\u{231a}\u{300}"]),
+ ("\u{231a}\u{308}\u{300}", &["\u{231a}\u{308}\u{300}"]),
+ ("\u{231a}\u{200d}", &["\u{231a}\u{200d}"]),
+ ("\u{231a}\u{308}\u{200d}", &["\u{231a}\u{308}\u{200d}"]),
+ ("\u{231a}\u{61}\u{2060}", &["\u{231a}", "\u{61}\u{2060}"]),
+ (
+ "\u{231a}\u{308}\u{61}\u{2060}",
+ &["\u{231a}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{231a}\u{61}\u{3a}", &["\u{231a}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{231a}\u{308}\u{61}\u{3a}",
+ &["\u{231a}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{231a}\u{61}\u{27}", &["\u{231a}", "\u{61}", "\u{27}"]),
+ (
+ "\u{231a}\u{308}\u{61}\u{27}",
+ &["\u{231a}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{231a}\u{61}\u{27}\u{2060}",
+ &["\u{231a}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{231a}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{231a}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{231a}\u{61}\u{2c}", &["\u{231a}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{231a}\u{308}\u{61}\u{2c}",
+ &["\u{231a}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{231a}\u{31}\u{3a}", &["\u{231a}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{231a}\u{308}\u{31}\u{3a}",
+ &["\u{231a}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{231a}\u{31}\u{27}", &["\u{231a}", "\u{31}", "\u{27}"]),
+ (
+ "\u{231a}\u{308}\u{31}\u{27}",
+ &["\u{231a}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{231a}\u{31}\u{2c}", &["\u{231a}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{231a}\u{308}\u{31}\u{2c}",
+ &["\u{231a}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{231a}\u{31}\u{2e}\u{2060}",
+ &["\u{231a}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{231a}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{231a}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{20}\u{1}", &["\u{20}", "\u{1}"]),
+ ("\u{20}\u{308}\u{1}", &["\u{20}\u{308}", "\u{1}"]),
+ ("\u{20}\u{d}", &["\u{20}", "\u{d}"]),
+ ("\u{20}\u{308}\u{d}", &["\u{20}\u{308}", "\u{d}"]),
+ ("\u{20}\u{a}", &["\u{20}", "\u{a}"]),
+ ("\u{20}\u{308}\u{a}", &["\u{20}\u{308}", "\u{a}"]),
+ ("\u{20}\u{b}", &["\u{20}", "\u{b}"]),
+ ("\u{20}\u{308}\u{b}", &["\u{20}\u{308}", "\u{b}"]),
+ ("\u{20}\u{3031}", &["\u{20}", "\u{3031}"]),
+ ("\u{20}\u{308}\u{3031}", &["\u{20}\u{308}", "\u{3031}"]),
+ ("\u{20}\u{41}", &["\u{20}", "\u{41}"]),
+ ("\u{20}\u{308}\u{41}", &["\u{20}\u{308}", "\u{41}"]),
+ ("\u{20}\u{3a}", &["\u{20}", "\u{3a}"]),
+ ("\u{20}\u{308}\u{3a}", &["\u{20}\u{308}", "\u{3a}"]),
+ ("\u{20}\u{2c}", &["\u{20}", "\u{2c}"]),
+ ("\u{20}\u{308}\u{2c}", &["\u{20}\u{308}", "\u{2c}"]),
+ ("\u{20}\u{2e}", &["\u{20}", "\u{2e}"]),
+ ("\u{20}\u{308}\u{2e}", &["\u{20}\u{308}", "\u{2e}"]),
+ ("\u{20}\u{30}", &["\u{20}", "\u{30}"]),
+ ("\u{20}\u{308}\u{30}", &["\u{20}\u{308}", "\u{30}"]),
+ ("\u{20}\u{5f}", &["\u{20}", "\u{5f}"]),
+ ("\u{20}\u{308}\u{5f}", &["\u{20}\u{308}", "\u{5f}"]),
+ ("\u{20}\u{1f1e6}", &["\u{20}", "\u{1f1e6}"]),
+ ("\u{20}\u{308}\u{1f1e6}", &["\u{20}\u{308}", "\u{1f1e6}"]),
+ ("\u{20}\u{5d0}", &["\u{20}", "\u{5d0}"]),
+ ("\u{20}\u{308}\u{5d0}", &["\u{20}\u{308}", "\u{5d0}"]),
+ ("\u{20}\u{22}", &["\u{20}", "\u{22}"]),
+ ("\u{20}\u{308}\u{22}", &["\u{20}\u{308}", "\u{22}"]),
+ ("\u{20}\u{27}", &["\u{20}", "\u{27}"]),
+ ("\u{20}\u{308}\u{27}", &["\u{20}\u{308}", "\u{27}"]),
+ ("\u{20}\u{231a}", &["\u{20}", "\u{231a}"]),
+ ("\u{20}\u{308}\u{231a}", &["\u{20}\u{308}", "\u{231a}"]),
+ ("\u{20}\u{20}", &["\u{20}\u{20}"]),
+ ("\u{20}\u{308}\u{20}", &["\u{20}\u{308}", "\u{20}"]),
+ ("\u{20}\u{ad}", &["\u{20}\u{ad}"]),
+ ("\u{20}\u{308}\u{ad}", &["\u{20}\u{308}\u{ad}"]),
+ ("\u{20}\u{300}", &["\u{20}\u{300}"]),
+ ("\u{20}\u{308}\u{300}", &["\u{20}\u{308}\u{300}"]),
+ ("\u{20}\u{200d}", &["\u{20}\u{200d}"]),
+ ("\u{20}\u{308}\u{200d}", &["\u{20}\u{308}\u{200d}"]),
+ ("\u{20}\u{61}\u{2060}", &["\u{20}", "\u{61}\u{2060}"]),
+ (
+ "\u{20}\u{308}\u{61}\u{2060}",
+ &["\u{20}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{20}\u{61}\u{3a}", &["\u{20}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{20}\u{308}\u{61}\u{3a}",
+ &["\u{20}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{20}\u{61}\u{27}", &["\u{20}", "\u{61}", "\u{27}"]),
+ (
+ "\u{20}\u{308}\u{61}\u{27}",
+ &["\u{20}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{20}\u{61}\u{27}\u{2060}",
+ &["\u{20}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{20}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{20}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{20}\u{61}\u{2c}", &["\u{20}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{20}\u{308}\u{61}\u{2c}",
+ &["\u{20}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{20}\u{31}\u{3a}", &["\u{20}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{20}\u{308}\u{31}\u{3a}",
+ &["\u{20}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{20}\u{31}\u{27}", &["\u{20}", "\u{31}", "\u{27}"]),
+ (
+ "\u{20}\u{308}\u{31}\u{27}",
+ &["\u{20}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{20}\u{31}\u{2c}", &["\u{20}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{20}\u{308}\u{31}\u{2c}",
+ &["\u{20}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{20}\u{31}\u{2e}\u{2060}",
+ &["\u{20}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{20}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{20}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{ad}\u{1}", &["\u{ad}", "\u{1}"]),
+ ("\u{ad}\u{308}\u{1}", &["\u{ad}\u{308}", "\u{1}"]),
+ ("\u{ad}\u{d}", &["\u{ad}", "\u{d}"]),
+ ("\u{ad}\u{308}\u{d}", &["\u{ad}\u{308}", "\u{d}"]),
+ ("\u{ad}\u{a}", &["\u{ad}", "\u{a}"]),
+ ("\u{ad}\u{308}\u{a}", &["\u{ad}\u{308}", "\u{a}"]),
+ ("\u{ad}\u{b}", &["\u{ad}", "\u{b}"]),
+ ("\u{ad}\u{308}\u{b}", &["\u{ad}\u{308}", "\u{b}"]),
+ ("\u{ad}\u{3031}", &["\u{ad}", "\u{3031}"]),
+ ("\u{ad}\u{308}\u{3031}", &["\u{ad}\u{308}", "\u{3031}"]),
+ ("\u{ad}\u{41}", &["\u{ad}", "\u{41}"]),
+ ("\u{ad}\u{308}\u{41}", &["\u{ad}\u{308}", "\u{41}"]),
+ ("\u{ad}\u{3a}", &["\u{ad}", "\u{3a}"]),
+ ("\u{ad}\u{308}\u{3a}", &["\u{ad}\u{308}", "\u{3a}"]),
+ ("\u{ad}\u{2c}", &["\u{ad}", "\u{2c}"]),
+ ("\u{ad}\u{308}\u{2c}", &["\u{ad}\u{308}", "\u{2c}"]),
+ ("\u{ad}\u{2e}", &["\u{ad}", "\u{2e}"]),
+ ("\u{ad}\u{308}\u{2e}", &["\u{ad}\u{308}", "\u{2e}"]),
+ ("\u{ad}\u{30}", &["\u{ad}", "\u{30}"]),
+ ("\u{ad}\u{308}\u{30}", &["\u{ad}\u{308}", "\u{30}"]),
+ ("\u{ad}\u{5f}", &["\u{ad}", "\u{5f}"]),
+ ("\u{ad}\u{308}\u{5f}", &["\u{ad}\u{308}", "\u{5f}"]),
+ ("\u{ad}\u{1f1e6}", &["\u{ad}", "\u{1f1e6}"]),
+ ("\u{ad}\u{308}\u{1f1e6}", &["\u{ad}\u{308}", "\u{1f1e6}"]),
+ ("\u{ad}\u{5d0}", &["\u{ad}", "\u{5d0}"]),
+ ("\u{ad}\u{308}\u{5d0}", &["\u{ad}\u{308}", "\u{5d0}"]),
+ ("\u{ad}\u{22}", &["\u{ad}", "\u{22}"]),
+ ("\u{ad}\u{308}\u{22}", &["\u{ad}\u{308}", "\u{22}"]),
+ ("\u{ad}\u{27}", &["\u{ad}", "\u{27}"]),
+ ("\u{ad}\u{308}\u{27}", &["\u{ad}\u{308}", "\u{27}"]),
+ ("\u{ad}\u{231a}", &["\u{ad}", "\u{231a}"]),
+ ("\u{ad}\u{308}\u{231a}", &["\u{ad}\u{308}", "\u{231a}"]),
+ ("\u{ad}\u{20}", &["\u{ad}", "\u{20}"]),
+ ("\u{ad}\u{308}\u{20}", &["\u{ad}\u{308}", "\u{20}"]),
+ ("\u{ad}\u{ad}", &["\u{ad}\u{ad}"]),
+ ("\u{ad}\u{308}\u{ad}", &["\u{ad}\u{308}\u{ad}"]),
+ ("\u{ad}\u{300}", &["\u{ad}\u{300}"]),
+ ("\u{ad}\u{308}\u{300}", &["\u{ad}\u{308}\u{300}"]),
+ ("\u{ad}\u{200d}", &["\u{ad}\u{200d}"]),
+ ("\u{ad}\u{308}\u{200d}", &["\u{ad}\u{308}\u{200d}"]),
+ ("\u{ad}\u{61}\u{2060}", &["\u{ad}", "\u{61}\u{2060}"]),
+ (
+ "\u{ad}\u{308}\u{61}\u{2060}",
+ &["\u{ad}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{ad}\u{61}\u{3a}", &["\u{ad}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{ad}\u{308}\u{61}\u{3a}",
+ &["\u{ad}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{ad}\u{61}\u{27}", &["\u{ad}", "\u{61}", "\u{27}"]),
+ (
+ "\u{ad}\u{308}\u{61}\u{27}",
+ &["\u{ad}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{ad}\u{61}\u{27}\u{2060}",
+ &["\u{ad}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{ad}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{ad}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{ad}\u{61}\u{2c}", &["\u{ad}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{ad}\u{308}\u{61}\u{2c}",
+ &["\u{ad}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{ad}\u{31}\u{3a}", &["\u{ad}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{ad}\u{308}\u{31}\u{3a}",
+ &["\u{ad}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{ad}\u{31}\u{27}", &["\u{ad}", "\u{31}", "\u{27}"]),
+ (
+ "\u{ad}\u{308}\u{31}\u{27}",
+ &["\u{ad}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{ad}\u{31}\u{2c}", &["\u{ad}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{ad}\u{308}\u{31}\u{2c}",
+ &["\u{ad}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{ad}\u{31}\u{2e}\u{2060}",
+ &["\u{ad}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{ad}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{ad}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{300}\u{1}", &["\u{300}", "\u{1}"]),
+ ("\u{300}\u{308}\u{1}", &["\u{300}\u{308}", "\u{1}"]),
+ ("\u{300}\u{d}", &["\u{300}", "\u{d}"]),
+ ("\u{300}\u{308}\u{d}", &["\u{300}\u{308}", "\u{d}"]),
+ ("\u{300}\u{a}", &["\u{300}", "\u{a}"]),
+ ("\u{300}\u{308}\u{a}", &["\u{300}\u{308}", "\u{a}"]),
+ ("\u{300}\u{b}", &["\u{300}", "\u{b}"]),
+ ("\u{300}\u{308}\u{b}", &["\u{300}\u{308}", "\u{b}"]),
+ ("\u{300}\u{3031}", &["\u{300}", "\u{3031}"]),
+ ("\u{300}\u{308}\u{3031}", &["\u{300}\u{308}", "\u{3031}"]),
+ ("\u{300}\u{41}", &["\u{300}", "\u{41}"]),
+ ("\u{300}\u{308}\u{41}", &["\u{300}\u{308}", "\u{41}"]),
+ ("\u{300}\u{3a}", &["\u{300}", "\u{3a}"]),
+ ("\u{300}\u{308}\u{3a}", &["\u{300}\u{308}", "\u{3a}"]),
+ ("\u{300}\u{2c}", &["\u{300}", "\u{2c}"]),
+ ("\u{300}\u{308}\u{2c}", &["\u{300}\u{308}", "\u{2c}"]),
+ ("\u{300}\u{2e}", &["\u{300}", "\u{2e}"]),
+ ("\u{300}\u{308}\u{2e}", &["\u{300}\u{308}", "\u{2e}"]),
+ ("\u{300}\u{30}", &["\u{300}", "\u{30}"]),
+ ("\u{300}\u{308}\u{30}", &["\u{300}\u{308}", "\u{30}"]),
+ ("\u{300}\u{5f}", &["\u{300}", "\u{5f}"]),
+ ("\u{300}\u{308}\u{5f}", &["\u{300}\u{308}", "\u{5f}"]),
+ ("\u{300}\u{1f1e6}", &["\u{300}", "\u{1f1e6}"]),
+ ("\u{300}\u{308}\u{1f1e6}", &["\u{300}\u{308}", "\u{1f1e6}"]),
+ ("\u{300}\u{5d0}", &["\u{300}", "\u{5d0}"]),
+ ("\u{300}\u{308}\u{5d0}", &["\u{300}\u{308}", "\u{5d0}"]),
+ ("\u{300}\u{22}", &["\u{300}", "\u{22}"]),
+ ("\u{300}\u{308}\u{22}", &["\u{300}\u{308}", "\u{22}"]),
+ ("\u{300}\u{27}", &["\u{300}", "\u{27}"]),
+ ("\u{300}\u{308}\u{27}", &["\u{300}\u{308}", "\u{27}"]),
+ ("\u{300}\u{231a}", &["\u{300}", "\u{231a}"]),
+ ("\u{300}\u{308}\u{231a}", &["\u{300}\u{308}", "\u{231a}"]),
+ ("\u{300}\u{20}", &["\u{300}", "\u{20}"]),
+ ("\u{300}\u{308}\u{20}", &["\u{300}\u{308}", "\u{20}"]),
+ ("\u{300}\u{ad}", &["\u{300}\u{ad}"]),
+ ("\u{300}\u{308}\u{ad}", &["\u{300}\u{308}\u{ad}"]),
+ ("\u{300}\u{300}", &["\u{300}\u{300}"]),
+ ("\u{300}\u{308}\u{300}", &["\u{300}\u{308}\u{300}"]),
+ ("\u{300}\u{200d}", &["\u{300}\u{200d}"]),
+ ("\u{300}\u{308}\u{200d}", &["\u{300}\u{308}\u{200d}"]),
+ ("\u{300}\u{61}\u{2060}", &["\u{300}", "\u{61}\u{2060}"]),
+ (
+ "\u{300}\u{308}\u{61}\u{2060}",
+ &["\u{300}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{300}\u{61}\u{3a}", &["\u{300}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{300}\u{308}\u{61}\u{3a}",
+ &["\u{300}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{300}\u{61}\u{27}", &["\u{300}", "\u{61}", "\u{27}"]),
+ (
+ "\u{300}\u{308}\u{61}\u{27}",
+ &["\u{300}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{300}\u{61}\u{27}\u{2060}",
+ &["\u{300}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{300}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{300}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{300}\u{61}\u{2c}", &["\u{300}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{300}\u{308}\u{61}\u{2c}",
+ &["\u{300}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{300}\u{31}\u{3a}", &["\u{300}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{300}\u{308}\u{31}\u{3a}",
+ &["\u{300}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{300}\u{31}\u{27}", &["\u{300}", "\u{31}", "\u{27}"]),
+ (
+ "\u{300}\u{308}\u{31}\u{27}",
+ &["\u{300}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{300}\u{31}\u{2c}", &["\u{300}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{300}\u{308}\u{31}\u{2c}",
+ &["\u{300}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{300}\u{31}\u{2e}\u{2060}",
+ &["\u{300}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{300}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{300}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{200d}\u{1}", &["\u{200d}", "\u{1}"]),
+ ("\u{200d}\u{308}\u{1}", &["\u{200d}\u{308}", "\u{1}"]),
+ ("\u{200d}\u{d}", &["\u{200d}", "\u{d}"]),
+ ("\u{200d}\u{308}\u{d}", &["\u{200d}\u{308}", "\u{d}"]),
+ ("\u{200d}\u{a}", &["\u{200d}", "\u{a}"]),
+ ("\u{200d}\u{308}\u{a}", &["\u{200d}\u{308}", "\u{a}"]),
+ ("\u{200d}\u{b}", &["\u{200d}", "\u{b}"]),
+ ("\u{200d}\u{308}\u{b}", &["\u{200d}\u{308}", "\u{b}"]),
+ ("\u{200d}\u{3031}", &["\u{200d}", "\u{3031}"]),
+ ("\u{200d}\u{308}\u{3031}", &["\u{200d}\u{308}", "\u{3031}"]),
+ ("\u{200d}\u{41}", &["\u{200d}", "\u{41}"]),
+ ("\u{200d}\u{308}\u{41}", &["\u{200d}\u{308}", "\u{41}"]),
+ ("\u{200d}\u{3a}", &["\u{200d}", "\u{3a}"]),
+ ("\u{200d}\u{308}\u{3a}", &["\u{200d}\u{308}", "\u{3a}"]),
+ ("\u{200d}\u{2c}", &["\u{200d}", "\u{2c}"]),
+ ("\u{200d}\u{308}\u{2c}", &["\u{200d}\u{308}", "\u{2c}"]),
+ ("\u{200d}\u{2e}", &["\u{200d}", "\u{2e}"]),
+ ("\u{200d}\u{308}\u{2e}", &["\u{200d}\u{308}", "\u{2e}"]),
+ ("\u{200d}\u{30}", &["\u{200d}", "\u{30}"]),
+ ("\u{200d}\u{308}\u{30}", &["\u{200d}\u{308}", "\u{30}"]),
+ ("\u{200d}\u{5f}", &["\u{200d}", "\u{5f}"]),
+ ("\u{200d}\u{308}\u{5f}", &["\u{200d}\u{308}", "\u{5f}"]),
+ ("\u{200d}\u{1f1e6}", &["\u{200d}", "\u{1f1e6}"]),
+ (
+ "\u{200d}\u{308}\u{1f1e6}",
+ &["\u{200d}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{200d}\u{5d0}", &["\u{200d}", "\u{5d0}"]),
+ ("\u{200d}\u{308}\u{5d0}", &["\u{200d}\u{308}", "\u{5d0}"]),
+ ("\u{200d}\u{22}", &["\u{200d}", "\u{22}"]),
+ ("\u{200d}\u{308}\u{22}", &["\u{200d}\u{308}", "\u{22}"]),
+ ("\u{200d}\u{27}", &["\u{200d}", "\u{27}"]),
+ ("\u{200d}\u{308}\u{27}", &["\u{200d}\u{308}", "\u{27}"]),
+ ("\u{200d}\u{231a}", &["\u{200d}\u{231a}"]),
+ ("\u{200d}\u{308}\u{231a}", &["\u{200d}\u{308}", "\u{231a}"]),
+ ("\u{200d}\u{20}", &["\u{200d}", "\u{20}"]),
+ ("\u{200d}\u{308}\u{20}", &["\u{200d}\u{308}", "\u{20}"]),
+ ("\u{200d}\u{ad}", &["\u{200d}\u{ad}"]),
+ ("\u{200d}\u{308}\u{ad}", &["\u{200d}\u{308}\u{ad}"]),
+ ("\u{200d}\u{300}", &["\u{200d}\u{300}"]),
+ ("\u{200d}\u{308}\u{300}", &["\u{200d}\u{308}\u{300}"]),
+ ("\u{200d}\u{200d}", &["\u{200d}\u{200d}"]),
+ ("\u{200d}\u{308}\u{200d}", &["\u{200d}\u{308}\u{200d}"]),
+ ("\u{200d}\u{61}\u{2060}", &["\u{200d}", "\u{61}\u{2060}"]),
+ (
+ "\u{200d}\u{308}\u{61}\u{2060}",
+ &["\u{200d}\u{308}", "\u{61}\u{2060}"],
+ ),
+ ("\u{200d}\u{61}\u{3a}", &["\u{200d}", "\u{61}", "\u{3a}"]),
+ (
+ "\u{200d}\u{308}\u{61}\u{3a}",
+ &["\u{200d}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ ("\u{200d}\u{61}\u{27}", &["\u{200d}", "\u{61}", "\u{27}"]),
+ (
+ "\u{200d}\u{308}\u{61}\u{27}",
+ &["\u{200d}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{200d}\u{61}\u{27}\u{2060}",
+ &["\u{200d}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{200d}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{200d}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ ("\u{200d}\u{61}\u{2c}", &["\u{200d}", "\u{61}", "\u{2c}"]),
+ (
+ "\u{200d}\u{308}\u{61}\u{2c}",
+ &["\u{200d}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ ("\u{200d}\u{31}\u{3a}", &["\u{200d}", "\u{31}", "\u{3a}"]),
+ (
+ "\u{200d}\u{308}\u{31}\u{3a}",
+ &["\u{200d}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ ("\u{200d}\u{31}\u{27}", &["\u{200d}", "\u{31}", "\u{27}"]),
+ (
+ "\u{200d}\u{308}\u{31}\u{27}",
+ &["\u{200d}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ ("\u{200d}\u{31}\u{2c}", &["\u{200d}", "\u{31}", "\u{2c}"]),
+ (
+ "\u{200d}\u{308}\u{31}\u{2c}",
+ &["\u{200d}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{200d}\u{31}\u{2e}\u{2060}",
+ &["\u{200d}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{200d}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{200d}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{61}\u{2060}\u{1}", &["\u{61}\u{2060}", "\u{1}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{1}",
+ &["\u{61}\u{2060}\u{308}", "\u{1}"],
+ ),
+ ("\u{61}\u{2060}\u{d}", &["\u{61}\u{2060}", "\u{d}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{d}",
+ &["\u{61}\u{2060}\u{308}", "\u{d}"],
+ ),
+ ("\u{61}\u{2060}\u{a}", &["\u{61}\u{2060}", "\u{a}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{a}",
+ &["\u{61}\u{2060}\u{308}", "\u{a}"],
+ ),
+ ("\u{61}\u{2060}\u{b}", &["\u{61}\u{2060}", "\u{b}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{b}",
+ &["\u{61}\u{2060}\u{308}", "\u{b}"],
+ ),
+ ("\u{61}\u{2060}\u{3031}", &["\u{61}\u{2060}", "\u{3031}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{3031}",
+ &["\u{61}\u{2060}\u{308}", "\u{3031}"],
+ ),
+ ("\u{61}\u{2060}\u{41}", &["\u{61}\u{2060}\u{41}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{41}",
+ &["\u{61}\u{2060}\u{308}\u{41}"],
+ ),
+ ("\u{61}\u{2060}\u{3a}", &["\u{61}\u{2060}", "\u{3a}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{3a}",
+ &["\u{61}\u{2060}\u{308}", "\u{3a}"],
+ ),
+ ("\u{61}\u{2060}\u{2c}", &["\u{61}\u{2060}", "\u{2c}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{2c}",
+ &["\u{61}\u{2060}\u{308}", "\u{2c}"],
+ ),
+ ("\u{61}\u{2060}\u{2e}", &["\u{61}\u{2060}", "\u{2e}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{2e}",
+ &["\u{61}\u{2060}\u{308}", "\u{2e}"],
+ ),
+ ("\u{61}\u{2060}\u{30}", &["\u{61}\u{2060}\u{30}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{30}",
+ &["\u{61}\u{2060}\u{308}\u{30}"],
+ ),
+ ("\u{61}\u{2060}\u{5f}", &["\u{61}\u{2060}\u{5f}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{5f}",
+ &["\u{61}\u{2060}\u{308}\u{5f}"],
+ ),
+ ("\u{61}\u{2060}\u{1f1e6}", &["\u{61}\u{2060}", "\u{1f1e6}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{1f1e6}",
+ &["\u{61}\u{2060}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{61}\u{2060}\u{5d0}", &["\u{61}\u{2060}\u{5d0}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{5d0}",
+ &["\u{61}\u{2060}\u{308}\u{5d0}"],
+ ),
+ ("\u{61}\u{2060}\u{22}", &["\u{61}\u{2060}", "\u{22}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{22}",
+ &["\u{61}\u{2060}\u{308}", "\u{22}"],
+ ),
+ ("\u{61}\u{2060}\u{27}", &["\u{61}\u{2060}", "\u{27}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{27}",
+ &["\u{61}\u{2060}\u{308}", "\u{27}"],
+ ),
+ ("\u{61}\u{2060}\u{231a}", &["\u{61}\u{2060}", "\u{231a}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{231a}",
+ &["\u{61}\u{2060}\u{308}", "\u{231a}"],
+ ),
+ ("\u{61}\u{2060}\u{20}", &["\u{61}\u{2060}", "\u{20}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{20}",
+ &["\u{61}\u{2060}\u{308}", "\u{20}"],
+ ),
+ ("\u{61}\u{2060}\u{ad}", &["\u{61}\u{2060}\u{ad}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{ad}",
+ &["\u{61}\u{2060}\u{308}\u{ad}"],
+ ),
+ ("\u{61}\u{2060}\u{300}", &["\u{61}\u{2060}\u{300}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{300}",
+ &["\u{61}\u{2060}\u{308}\u{300}"],
+ ),
+ ("\u{61}\u{2060}\u{200d}", &["\u{61}\u{2060}\u{200d}"]),
+ (
+ "\u{61}\u{2060}\u{308}\u{200d}",
+ &["\u{61}\u{2060}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{61}\u{2060}",
+ &["\u{61}\u{2060}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{61}\u{2060}",
+ &["\u{61}\u{2060}\u{308}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{61}\u{3a}",
+ &["\u{61}\u{2060}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{61}\u{3a}",
+ &["\u{61}\u{2060}\u{308}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{61}\u{27}",
+ &["\u{61}\u{2060}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{61}\u{27}",
+ &["\u{61}\u{2060}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{2060}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{2060}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{61}\u{2c}",
+ &["\u{61}\u{2060}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{61}\u{2c}",
+ &["\u{61}\u{2060}\u{308}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{31}\u{3a}",
+ &["\u{61}\u{2060}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{31}\u{3a}",
+ &["\u{61}\u{2060}\u{308}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{31}\u{27}",
+ &["\u{61}\u{2060}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{31}\u{27}",
+ &["\u{61}\u{2060}\u{308}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{31}\u{2c}",
+ &["\u{61}\u{2060}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{31}\u{2c}",
+ &["\u{61}\u{2060}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{31}\u{2e}\u{2060}",
+ &["\u{61}\u{2060}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2060}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{61}\u{2060}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{61}\u{3a}\u{1}", &["\u{61}", "\u{3a}", "\u{1}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{1}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{1}"],
+ ),
+ ("\u{61}\u{3a}\u{d}", &["\u{61}", "\u{3a}", "\u{d}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{d}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{d}"],
+ ),
+ ("\u{61}\u{3a}\u{a}", &["\u{61}", "\u{3a}", "\u{a}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{a}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{a}"],
+ ),
+ ("\u{61}\u{3a}\u{b}", &["\u{61}", "\u{3a}", "\u{b}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{b}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{b}"],
+ ),
+ ("\u{61}\u{3a}\u{3031}", &["\u{61}", "\u{3a}", "\u{3031}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{3031}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{3031}"],
+ ),
+ ("\u{61}\u{3a}\u{41}", &["\u{61}\u{3a}\u{41}"]),
+ ("\u{61}\u{3a}\u{308}\u{41}", &["\u{61}\u{3a}\u{308}\u{41}"]),
+ ("\u{61}\u{3a}\u{3a}", &["\u{61}", "\u{3a}", "\u{3a}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{3a}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{3a}"],
+ ),
+ ("\u{61}\u{3a}\u{2c}", &["\u{61}", "\u{3a}", "\u{2c}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{2c}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{2c}"],
+ ),
+ ("\u{61}\u{3a}\u{2e}", &["\u{61}", "\u{3a}", "\u{2e}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{2e}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{2e}"],
+ ),
+ ("\u{61}\u{3a}\u{30}", &["\u{61}", "\u{3a}", "\u{30}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{30}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{30}"],
+ ),
+ ("\u{61}\u{3a}\u{5f}", &["\u{61}", "\u{3a}", "\u{5f}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{5f}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{5f}"],
+ ),
+ ("\u{61}\u{3a}\u{1f1e6}", &["\u{61}", "\u{3a}", "\u{1f1e6}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{1f1e6}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{61}\u{3a}\u{5d0}", &["\u{61}\u{3a}\u{5d0}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{5d0}",
+ &["\u{61}\u{3a}\u{308}\u{5d0}"],
+ ),
+ ("\u{61}\u{3a}\u{22}", &["\u{61}", "\u{3a}", "\u{22}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{22}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{22}"],
+ ),
+ ("\u{61}\u{3a}\u{27}", &["\u{61}", "\u{3a}", "\u{27}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{27}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{27}"],
+ ),
+ ("\u{61}\u{3a}\u{231a}", &["\u{61}", "\u{3a}", "\u{231a}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{231a}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{231a}"],
+ ),
+ ("\u{61}\u{3a}\u{20}", &["\u{61}", "\u{3a}", "\u{20}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{20}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{20}"],
+ ),
+ ("\u{61}\u{3a}\u{ad}", &["\u{61}", "\u{3a}\u{ad}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{ad}",
+ &["\u{61}", "\u{3a}\u{308}\u{ad}"],
+ ),
+ ("\u{61}\u{3a}\u{300}", &["\u{61}", "\u{3a}\u{300}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{300}",
+ &["\u{61}", "\u{3a}\u{308}\u{300}"],
+ ),
+ ("\u{61}\u{3a}\u{200d}", &["\u{61}", "\u{3a}\u{200d}"]),
+ (
+ "\u{61}\u{3a}\u{308}\u{200d}",
+ &["\u{61}", "\u{3a}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{61}\u{2060}",
+ &["\u{61}\u{3a}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{61}\u{2060}",
+ &["\u{61}\u{3a}\u{308}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{61}\u{3a}",
+ &["\u{61}\u{3a}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{61}\u{3a}",
+ &["\u{61}\u{3a}\u{308}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{61}\u{27}",
+ &["\u{61}\u{3a}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{61}\u{27}",
+ &["\u{61}\u{3a}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{3a}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{3a}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{61}\u{2c}",
+ &["\u{61}\u{3a}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{61}\u{2c}",
+ &["\u{61}\u{3a}\u{308}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{31}\u{3a}",
+ &["\u{61}", "\u{3a}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{31}\u{3a}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{31}\u{27}",
+ &["\u{61}", "\u{3a}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{31}\u{27}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{31}\u{2c}",
+ &["\u{61}", "\u{3a}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{31}\u{2c}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{3a}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{3a}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{61}\u{27}\u{1}", &["\u{61}", "\u{27}", "\u{1}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{1}",
+ &["\u{61}", "\u{27}\u{308}", "\u{1}"],
+ ),
+ ("\u{61}\u{27}\u{d}", &["\u{61}", "\u{27}", "\u{d}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{d}",
+ &["\u{61}", "\u{27}\u{308}", "\u{d}"],
+ ),
+ ("\u{61}\u{27}\u{a}", &["\u{61}", "\u{27}", "\u{a}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{a}",
+ &["\u{61}", "\u{27}\u{308}", "\u{a}"],
+ ),
+ ("\u{61}\u{27}\u{b}", &["\u{61}", "\u{27}", "\u{b}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{b}",
+ &["\u{61}", "\u{27}\u{308}", "\u{b}"],
+ ),
+ ("\u{61}\u{27}\u{3031}", &["\u{61}", "\u{27}", "\u{3031}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{3031}",
+ &["\u{61}", "\u{27}\u{308}", "\u{3031}"],
+ ),
+ ("\u{61}\u{27}\u{41}", &["\u{61}\u{27}\u{41}"]),
+ ("\u{61}\u{27}\u{308}\u{41}", &["\u{61}\u{27}\u{308}\u{41}"]),
+ ("\u{61}\u{27}\u{3a}", &["\u{61}", "\u{27}", "\u{3a}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{3a}",
+ &["\u{61}", "\u{27}\u{308}", "\u{3a}"],
+ ),
+ ("\u{61}\u{27}\u{2c}", &["\u{61}", "\u{27}", "\u{2c}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{2c}",
+ &["\u{61}", "\u{27}\u{308}", "\u{2c}"],
+ ),
+ ("\u{61}\u{27}\u{2e}", &["\u{61}", "\u{27}", "\u{2e}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{2e}",
+ &["\u{61}", "\u{27}\u{308}", "\u{2e}"],
+ ),
+ ("\u{61}\u{27}\u{30}", &["\u{61}", "\u{27}", "\u{30}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{30}",
+ &["\u{61}", "\u{27}\u{308}", "\u{30}"],
+ ),
+ ("\u{61}\u{27}\u{5f}", &["\u{61}", "\u{27}", "\u{5f}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{5f}",
+ &["\u{61}", "\u{27}\u{308}", "\u{5f}"],
+ ),
+ ("\u{61}\u{27}\u{1f1e6}", &["\u{61}", "\u{27}", "\u{1f1e6}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{1f1e6}",
+ &["\u{61}", "\u{27}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{61}\u{27}\u{5d0}", &["\u{61}\u{27}\u{5d0}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{5d0}",
+ &["\u{61}\u{27}\u{308}\u{5d0}"],
+ ),
+ ("\u{61}\u{27}\u{22}", &["\u{61}", "\u{27}", "\u{22}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{22}",
+ &["\u{61}", "\u{27}\u{308}", "\u{22}"],
+ ),
+ ("\u{61}\u{27}\u{27}", &["\u{61}", "\u{27}", "\u{27}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{27}",
+ &["\u{61}", "\u{27}\u{308}", "\u{27}"],
+ ),
+ ("\u{61}\u{27}\u{231a}", &["\u{61}", "\u{27}", "\u{231a}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{231a}",
+ &["\u{61}", "\u{27}\u{308}", "\u{231a}"],
+ ),
+ ("\u{61}\u{27}\u{20}", &["\u{61}", "\u{27}", "\u{20}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{20}",
+ &["\u{61}", "\u{27}\u{308}", "\u{20}"],
+ ),
+ ("\u{61}\u{27}\u{ad}", &["\u{61}", "\u{27}\u{ad}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{ad}",
+ &["\u{61}", "\u{27}\u{308}\u{ad}"],
+ ),
+ ("\u{61}\u{27}\u{300}", &["\u{61}", "\u{27}\u{300}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{300}",
+ &["\u{61}", "\u{27}\u{308}\u{300}"],
+ ),
+ ("\u{61}\u{27}\u{200d}", &["\u{61}", "\u{27}\u{200d}"]),
+ (
+ "\u{61}\u{27}\u{308}\u{200d}",
+ &["\u{61}", "\u{27}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{27}\u{61}\u{2060}",
+ &["\u{61}\u{27}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{61}\u{2060}",
+ &["\u{61}\u{27}\u{308}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{61}\u{3a}",
+ &["\u{61}\u{27}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{61}\u{3a}",
+ &["\u{61}\u{27}\u{308}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{61}\u{27}",
+ &["\u{61}\u{27}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{61}\u{27}",
+ &["\u{61}\u{27}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{27}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{27}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{61}\u{2c}",
+ &["\u{61}\u{27}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{61}\u{2c}",
+ &["\u{61}\u{27}\u{308}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{31}\u{3a}",
+ &["\u{61}", "\u{27}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{31}\u{3a}",
+ &["\u{61}", "\u{27}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{31}\u{27}",
+ &["\u{61}", "\u{27}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{31}\u{27}",
+ &["\u{61}", "\u{27}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{31}\u{2c}",
+ &["\u{61}", "\u{27}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{31}\u{2c}",
+ &["\u{61}", "\u{27}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{27}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{27}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{1}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{1}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{1}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{1}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{d}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{d}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{d}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{d}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{a}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{a}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{b}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{b}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{b}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{b}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{3031}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{3031}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{3031}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{3031}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{41}",
+ &["\u{61}\u{27}\u{2060}\u{41}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{41}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{41}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{3a}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{3a}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{2c}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{2c}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{2e}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{2e}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{2e}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{2e}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{30}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{30}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{30}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{30}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{5f}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{5f}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{5f}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{5f}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{1f1e6}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{1f1e6}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{1f1e6}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{1f1e6}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{5d0}",
+ &["\u{61}\u{27}\u{2060}\u{5d0}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{5d0}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{5d0}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{22}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{22}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{22}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{22}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{27}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{27}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{231a}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{231a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{231a}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{231a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{20}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{20}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{20}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{20}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{ad}",
+ &["\u{61}", "\u{27}\u{2060}\u{ad}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{ad}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}\u{ad}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{300}",
+ &["\u{61}", "\u{27}\u{2060}\u{300}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{300}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}\u{300}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{200d}",
+ &["\u{61}", "\u{27}\u{2060}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{200d}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{61}\u{2060}",
+ &["\u{61}\u{27}\u{2060}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{61}\u{2060}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{61}\u{3a}",
+ &["\u{61}\u{27}\u{2060}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{61}\u{3a}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{61}\u{27}",
+ &["\u{61}\u{27}\u{2060}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{61}\u{27}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{27}\u{2060}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{61}\u{2c}",
+ &["\u{61}\u{27}\u{2060}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{61}\u{2c}",
+ &["\u{61}\u{27}\u{2060}\u{308}\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{31}\u{3a}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{31}\u{3a}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{31}\u{27}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{31}\u{27}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{31}\u{2c}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{31}\u{2c}",
+ &["\u{61}", "\u{27}\u{2060}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{27}\u{2060}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{27}\u{2060}\u{308}\u{31}\u{2e}\u{2060}",
+ &[
+ "\u{61}",
+ "\u{27}\u{2060}\u{308}",
+ "\u{31}",
+ "\u{2e}\u{2060}",
+ ],
+ ),
+ ("\u{61}\u{2c}\u{1}", &["\u{61}", "\u{2c}", "\u{1}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{1}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{1}"],
+ ),
+ ("\u{61}\u{2c}\u{d}", &["\u{61}", "\u{2c}", "\u{d}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{d}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{d}"],
+ ),
+ ("\u{61}\u{2c}\u{a}", &["\u{61}", "\u{2c}", "\u{a}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{a}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{a}"],
+ ),
+ ("\u{61}\u{2c}\u{b}", &["\u{61}", "\u{2c}", "\u{b}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{b}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{b}"],
+ ),
+ ("\u{61}\u{2c}\u{3031}", &["\u{61}", "\u{2c}", "\u{3031}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{3031}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{3031}"],
+ ),
+ ("\u{61}\u{2c}\u{41}", &["\u{61}", "\u{2c}", "\u{41}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{41}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{41}"],
+ ),
+ ("\u{61}\u{2c}\u{3a}", &["\u{61}", "\u{2c}", "\u{3a}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{3a}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{3a}"],
+ ),
+ ("\u{61}\u{2c}\u{2c}", &["\u{61}", "\u{2c}", "\u{2c}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{2c}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{2c}"],
+ ),
+ ("\u{61}\u{2c}\u{2e}", &["\u{61}", "\u{2c}", "\u{2e}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{2e}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{2e}"],
+ ),
+ ("\u{61}\u{2c}\u{30}", &["\u{61}", "\u{2c}", "\u{30}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{30}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{30}"],
+ ),
+ ("\u{61}\u{2c}\u{5f}", &["\u{61}", "\u{2c}", "\u{5f}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{5f}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{5f}"],
+ ),
+ ("\u{61}\u{2c}\u{1f1e6}", &["\u{61}", "\u{2c}", "\u{1f1e6}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{1f1e6}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{61}\u{2c}\u{5d0}", &["\u{61}", "\u{2c}", "\u{5d0}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{5d0}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{5d0}"],
+ ),
+ ("\u{61}\u{2c}\u{22}", &["\u{61}", "\u{2c}", "\u{22}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{22}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{22}"],
+ ),
+ ("\u{61}\u{2c}\u{27}", &["\u{61}", "\u{2c}", "\u{27}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{27}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{27}"],
+ ),
+ ("\u{61}\u{2c}\u{231a}", &["\u{61}", "\u{2c}", "\u{231a}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{231a}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{231a}"],
+ ),
+ ("\u{61}\u{2c}\u{20}", &["\u{61}", "\u{2c}", "\u{20}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{20}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{20}"],
+ ),
+ ("\u{61}\u{2c}\u{ad}", &["\u{61}", "\u{2c}\u{ad}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{ad}",
+ &["\u{61}", "\u{2c}\u{308}\u{ad}"],
+ ),
+ ("\u{61}\u{2c}\u{300}", &["\u{61}", "\u{2c}\u{300}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{300}",
+ &["\u{61}", "\u{2c}\u{308}\u{300}"],
+ ),
+ ("\u{61}\u{2c}\u{200d}", &["\u{61}", "\u{2c}\u{200d}"]),
+ (
+ "\u{61}\u{2c}\u{308}\u{200d}",
+ &["\u{61}", "\u{2c}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{61}\u{2060}",
+ &["\u{61}", "\u{2c}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{61}\u{2060}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{61}\u{3a}",
+ &["\u{61}", "\u{2c}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{61}\u{3a}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{61}\u{27}",
+ &["\u{61}", "\u{2c}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{61}\u{27}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{61}\u{27}\u{2060}",
+ &["\u{61}", "\u{2c}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{61}\u{2c}",
+ &["\u{61}", "\u{2c}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{61}\u{2c}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{31}\u{3a}",
+ &["\u{61}", "\u{2c}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{31}\u{3a}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{31}\u{27}",
+ &["\u{61}", "\u{2c}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{31}\u{27}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{31}\u{2c}",
+ &["\u{61}", "\u{2c}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{31}\u{2c}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{2c}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{61}", "\u{2c}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{31}\u{3a}\u{1}", &["\u{31}", "\u{3a}", "\u{1}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{1}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{1}"],
+ ),
+ ("\u{31}\u{3a}\u{d}", &["\u{31}", "\u{3a}", "\u{d}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{d}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{d}"],
+ ),
+ ("\u{31}\u{3a}\u{a}", &["\u{31}", "\u{3a}", "\u{a}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{a}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{a}"],
+ ),
+ ("\u{31}\u{3a}\u{b}", &["\u{31}", "\u{3a}", "\u{b}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{b}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{b}"],
+ ),
+ ("\u{31}\u{3a}\u{3031}", &["\u{31}", "\u{3a}", "\u{3031}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{3031}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{3031}"],
+ ),
+ ("\u{31}\u{3a}\u{41}", &["\u{31}", "\u{3a}", "\u{41}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{41}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{41}"],
+ ),
+ ("\u{31}\u{3a}\u{3a}", &["\u{31}", "\u{3a}", "\u{3a}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{3a}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{3a}"],
+ ),
+ ("\u{31}\u{3a}\u{2c}", &["\u{31}", "\u{3a}", "\u{2c}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{2c}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{2c}"],
+ ),
+ ("\u{31}\u{3a}\u{2e}", &["\u{31}", "\u{3a}", "\u{2e}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{2e}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{2e}"],
+ ),
+ ("\u{31}\u{3a}\u{30}", &["\u{31}", "\u{3a}", "\u{30}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{30}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{30}"],
+ ),
+ ("\u{31}\u{3a}\u{5f}", &["\u{31}", "\u{3a}", "\u{5f}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{5f}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{5f}"],
+ ),
+ ("\u{31}\u{3a}\u{1f1e6}", &["\u{31}", "\u{3a}", "\u{1f1e6}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{1f1e6}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{31}\u{3a}\u{5d0}", &["\u{31}", "\u{3a}", "\u{5d0}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{5d0}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{5d0}"],
+ ),
+ ("\u{31}\u{3a}\u{22}", &["\u{31}", "\u{3a}", "\u{22}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{22}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{22}"],
+ ),
+ ("\u{31}\u{3a}\u{27}", &["\u{31}", "\u{3a}", "\u{27}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{27}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{27}"],
+ ),
+ ("\u{31}\u{3a}\u{231a}", &["\u{31}", "\u{3a}", "\u{231a}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{231a}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{231a}"],
+ ),
+ ("\u{31}\u{3a}\u{20}", &["\u{31}", "\u{3a}", "\u{20}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{20}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{20}"],
+ ),
+ ("\u{31}\u{3a}\u{ad}", &["\u{31}", "\u{3a}\u{ad}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{ad}",
+ &["\u{31}", "\u{3a}\u{308}\u{ad}"],
+ ),
+ ("\u{31}\u{3a}\u{300}", &["\u{31}", "\u{3a}\u{300}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{300}",
+ &["\u{31}", "\u{3a}\u{308}\u{300}"],
+ ),
+ ("\u{31}\u{3a}\u{200d}", &["\u{31}", "\u{3a}\u{200d}"]),
+ (
+ "\u{31}\u{3a}\u{308}\u{200d}",
+ &["\u{31}", "\u{3a}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{61}\u{2060}",
+ &["\u{31}", "\u{3a}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{61}\u{2060}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{61}\u{3a}",
+ &["\u{31}", "\u{3a}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{61}\u{3a}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{61}\u{27}",
+ &["\u{31}", "\u{3a}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{61}\u{27}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{3a}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{61}\u{2c}",
+ &["\u{31}", "\u{3a}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{61}\u{2c}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{31}\u{3a}",
+ &["\u{31}", "\u{3a}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{31}\u{3a}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{31}\u{27}",
+ &["\u{31}", "\u{3a}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{31}\u{27}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{31}\u{2c}",
+ &["\u{31}", "\u{3a}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{31}\u{2c}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{31}\u{2e}\u{2060}",
+ &["\u{31}", "\u{3a}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{31}", "\u{3a}\u{308}", "\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{31}\u{27}\u{1}", &["\u{31}", "\u{27}", "\u{1}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{1}",
+ &["\u{31}", "\u{27}\u{308}", "\u{1}"],
+ ),
+ ("\u{31}\u{27}\u{d}", &["\u{31}", "\u{27}", "\u{d}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{d}",
+ &["\u{31}", "\u{27}\u{308}", "\u{d}"],
+ ),
+ ("\u{31}\u{27}\u{a}", &["\u{31}", "\u{27}", "\u{a}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{a}",
+ &["\u{31}", "\u{27}\u{308}", "\u{a}"],
+ ),
+ ("\u{31}\u{27}\u{b}", &["\u{31}", "\u{27}", "\u{b}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{b}",
+ &["\u{31}", "\u{27}\u{308}", "\u{b}"],
+ ),
+ ("\u{31}\u{27}\u{3031}", &["\u{31}", "\u{27}", "\u{3031}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{3031}",
+ &["\u{31}", "\u{27}\u{308}", "\u{3031}"],
+ ),
+ ("\u{31}\u{27}\u{41}", &["\u{31}", "\u{27}", "\u{41}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{41}",
+ &["\u{31}", "\u{27}\u{308}", "\u{41}"],
+ ),
+ ("\u{31}\u{27}\u{3a}", &["\u{31}", "\u{27}", "\u{3a}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{3a}",
+ &["\u{31}", "\u{27}\u{308}", "\u{3a}"],
+ ),
+ ("\u{31}\u{27}\u{2c}", &["\u{31}", "\u{27}", "\u{2c}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{2c}",
+ &["\u{31}", "\u{27}\u{308}", "\u{2c}"],
+ ),
+ ("\u{31}\u{27}\u{2e}", &["\u{31}", "\u{27}", "\u{2e}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{2e}",
+ &["\u{31}", "\u{27}\u{308}", "\u{2e}"],
+ ),
+ ("\u{31}\u{27}\u{30}", &["\u{31}\u{27}\u{30}"]),
+ ("\u{31}\u{27}\u{308}\u{30}", &["\u{31}\u{27}\u{308}\u{30}"]),
+ ("\u{31}\u{27}\u{5f}", &["\u{31}", "\u{27}", "\u{5f}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{5f}",
+ &["\u{31}", "\u{27}\u{308}", "\u{5f}"],
+ ),
+ ("\u{31}\u{27}\u{1f1e6}", &["\u{31}", "\u{27}", "\u{1f1e6}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{1f1e6}",
+ &["\u{31}", "\u{27}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{31}\u{27}\u{5d0}", &["\u{31}", "\u{27}", "\u{5d0}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{5d0}",
+ &["\u{31}", "\u{27}\u{308}", "\u{5d0}"],
+ ),
+ ("\u{31}\u{27}\u{22}", &["\u{31}", "\u{27}", "\u{22}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{22}",
+ &["\u{31}", "\u{27}\u{308}", "\u{22}"],
+ ),
+ ("\u{31}\u{27}\u{27}", &["\u{31}", "\u{27}", "\u{27}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{27}",
+ &["\u{31}", "\u{27}\u{308}", "\u{27}"],
+ ),
+ ("\u{31}\u{27}\u{231a}", &["\u{31}", "\u{27}", "\u{231a}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{231a}",
+ &["\u{31}", "\u{27}\u{308}", "\u{231a}"],
+ ),
+ ("\u{31}\u{27}\u{20}", &["\u{31}", "\u{27}", "\u{20}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{20}",
+ &["\u{31}", "\u{27}\u{308}", "\u{20}"],
+ ),
+ ("\u{31}\u{27}\u{ad}", &["\u{31}", "\u{27}\u{ad}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{ad}",
+ &["\u{31}", "\u{27}\u{308}\u{ad}"],
+ ),
+ ("\u{31}\u{27}\u{300}", &["\u{31}", "\u{27}\u{300}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{300}",
+ &["\u{31}", "\u{27}\u{308}\u{300}"],
+ ),
+ ("\u{31}\u{27}\u{200d}", &["\u{31}", "\u{27}\u{200d}"]),
+ (
+ "\u{31}\u{27}\u{308}\u{200d}",
+ &["\u{31}", "\u{27}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{31}\u{27}\u{61}\u{2060}",
+ &["\u{31}", "\u{27}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{61}\u{2060}",
+ &["\u{31}", "\u{27}\u{308}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{27}\u{61}\u{3a}",
+ &["\u{31}", "\u{27}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{61}\u{3a}",
+ &["\u{31}", "\u{27}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{27}\u{61}\u{27}",
+ &["\u{31}", "\u{27}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{61}\u{27}",
+ &["\u{31}", "\u{27}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{27}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{27}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{27}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{27}\u{61}\u{2c}",
+ &["\u{31}", "\u{27}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{61}\u{2c}",
+ &["\u{31}", "\u{27}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{27}\u{31}\u{3a}",
+ &["\u{31}\u{27}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{31}\u{3a}",
+ &["\u{31}\u{27}\u{308}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{27}\u{31}\u{27}",
+ &["\u{31}\u{27}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{31}\u{27}",
+ &["\u{31}\u{27}\u{308}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{27}\u{31}\u{2c}",
+ &["\u{31}\u{27}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{31}\u{2c}",
+ &["\u{31}\u{27}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{27}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{27}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{27}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{27}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ ("\u{31}\u{2c}\u{1}", &["\u{31}", "\u{2c}", "\u{1}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{1}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{1}"],
+ ),
+ ("\u{31}\u{2c}\u{d}", &["\u{31}", "\u{2c}", "\u{d}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{d}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{d}"],
+ ),
+ ("\u{31}\u{2c}\u{a}", &["\u{31}", "\u{2c}", "\u{a}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{a}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{a}"],
+ ),
+ ("\u{31}\u{2c}\u{b}", &["\u{31}", "\u{2c}", "\u{b}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{b}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{b}"],
+ ),
+ ("\u{31}\u{2c}\u{3031}", &["\u{31}", "\u{2c}", "\u{3031}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{3031}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{3031}"],
+ ),
+ ("\u{31}\u{2c}\u{41}", &["\u{31}", "\u{2c}", "\u{41}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{41}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{41}"],
+ ),
+ ("\u{31}\u{2c}\u{3a}", &["\u{31}", "\u{2c}", "\u{3a}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{3a}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{3a}"],
+ ),
+ ("\u{31}\u{2c}\u{2c}", &["\u{31}", "\u{2c}", "\u{2c}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{2c}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{2c}"],
+ ),
+ ("\u{31}\u{2c}\u{2e}", &["\u{31}", "\u{2c}", "\u{2e}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{2e}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{2e}"],
+ ),
+ ("\u{31}\u{2c}\u{30}", &["\u{31}\u{2c}\u{30}"]),
+ ("\u{31}\u{2c}\u{308}\u{30}", &["\u{31}\u{2c}\u{308}\u{30}"]),
+ ("\u{31}\u{2c}\u{5f}", &["\u{31}", "\u{2c}", "\u{5f}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{5f}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{5f}"],
+ ),
+ ("\u{31}\u{2c}\u{1f1e6}", &["\u{31}", "\u{2c}", "\u{1f1e6}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{1f1e6}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{1f1e6}"],
+ ),
+ ("\u{31}\u{2c}\u{5d0}", &["\u{31}", "\u{2c}", "\u{5d0}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{5d0}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{5d0}"],
+ ),
+ ("\u{31}\u{2c}\u{22}", &["\u{31}", "\u{2c}", "\u{22}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{22}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{22}"],
+ ),
+ ("\u{31}\u{2c}\u{27}", &["\u{31}", "\u{2c}", "\u{27}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{27}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{27}"],
+ ),
+ ("\u{31}\u{2c}\u{231a}", &["\u{31}", "\u{2c}", "\u{231a}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{231a}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{231a}"],
+ ),
+ ("\u{31}\u{2c}\u{20}", &["\u{31}", "\u{2c}", "\u{20}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{20}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{20}"],
+ ),
+ ("\u{31}\u{2c}\u{ad}", &["\u{31}", "\u{2c}\u{ad}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{ad}",
+ &["\u{31}", "\u{2c}\u{308}\u{ad}"],
+ ),
+ ("\u{31}\u{2c}\u{300}", &["\u{31}", "\u{2c}\u{300}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{300}",
+ &["\u{31}", "\u{2c}\u{308}\u{300}"],
+ ),
+ ("\u{31}\u{2c}\u{200d}", &["\u{31}", "\u{2c}\u{200d}"]),
+ (
+ "\u{31}\u{2c}\u{308}\u{200d}",
+ &["\u{31}", "\u{2c}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{61}\u{2060}",
+ &["\u{31}", "\u{2c}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{61}\u{2060}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{61}\u{3a}",
+ &["\u{31}", "\u{2c}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{61}\u{3a}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{61}\u{27}",
+ &["\u{31}", "\u{2c}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{61}\u{27}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{2c}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{61}\u{2c}",
+ &["\u{31}", "\u{2c}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{61}\u{2c}",
+ &["\u{31}", "\u{2c}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{31}\u{3a}",
+ &["\u{31}\u{2c}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{31}\u{3a}",
+ &["\u{31}\u{2c}\u{308}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{31}\u{27}",
+ &["\u{31}\u{2c}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{31}\u{27}",
+ &["\u{31}\u{2c}\u{308}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{31}\u{2c}",
+ &["\u{31}\u{2c}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{31}\u{2c}",
+ &["\u{31}\u{2c}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{2c}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{2c}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{1}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{1}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{1}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{1}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{d}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{d}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{d}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{d}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{a}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{a}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{b}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{b}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{b}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{b}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{3031}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{3031}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{3031}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{3031}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{41}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{41}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{41}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{41}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{3a}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{3a}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{2c}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{2c}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{2e}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{2e}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{2e}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{2e}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{30}",
+ &["\u{31}\u{2e}\u{2060}\u{30}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{30}",
+ &["\u{31}\u{2e}\u{2060}\u{308}\u{30}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{5f}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{5f}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{5f}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{5f}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{1f1e6}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{1f1e6}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{1f1e6}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{1f1e6}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{5d0}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{5d0}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{5d0}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{5d0}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{22}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{22}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{22}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{22}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{27}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{27}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{231a}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{231a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{231a}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{231a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{20}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{20}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{20}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{20}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{ad}",
+ &["\u{31}", "\u{2e}\u{2060}\u{ad}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{ad}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}\u{ad}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{300}",
+ &["\u{31}", "\u{2e}\u{2060}\u{300}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{300}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}\u{300}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{200d}",
+ &["\u{31}", "\u{2e}\u{2060}\u{200d}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{200d}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}\u{200d}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{61}\u{2060}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{61}\u{2060}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{61}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{61}\u{3a}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{61}\u{3a}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{61}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{61}\u{27}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{61}\u{27}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{61}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{61}\u{27}\u{2060}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{61}", "\u{27}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{61}\u{27}\u{2060}",
+ &[
+ "\u{31}",
+ "\u{2e}\u{2060}\u{308}",
+ "\u{61}",
+ "\u{27}\u{2060}",
+ ],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{61}\u{2c}",
+ &["\u{31}", "\u{2e}\u{2060}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{61}\u{2c}",
+ &["\u{31}", "\u{2e}\u{2060}\u{308}", "\u{61}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{31}\u{3a}",
+ &["\u{31}\u{2e}\u{2060}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{31}\u{3a}",
+ &["\u{31}\u{2e}\u{2060}\u{308}\u{31}", "\u{3a}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{31}\u{27}",
+ &["\u{31}\u{2e}\u{2060}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{31}\u{27}",
+ &["\u{31}\u{2e}\u{2060}\u{308}\u{31}", "\u{27}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{31}\u{2c}",
+ &["\u{31}\u{2e}\u{2060}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{31}\u{2c}",
+ &["\u{31}\u{2e}\u{2060}\u{308}\u{31}", "\u{2c}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{2e}\u{2060}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2060}\u{308}\u{31}\u{2e}\u{2060}",
+ &["\u{31}\u{2e}\u{2060}\u{308}\u{31}", "\u{2e}\u{2060}"],
+ ),
+ (
+ "\u{d}\u{a}\u{61}\u{a}\u{308}",
+ &["\u{d}\u{a}", "\u{61}", "\u{a}", "\u{308}"],
+ ),
+ ("\u{61}\u{308}", &["\u{61}\u{308}"]),
+ ("\u{20}\u{200d}\u{646}", &["\u{20}\u{200d}", "\u{646}"]),
+ ("\u{646}\u{200d}\u{20}", &["\u{646}\u{200d}", "\u{20}"]),
+ ("\u{41}\u{41}\u{41}", &["\u{41}\u{41}\u{41}"]),
+ ("\u{41}\u{3a}\u{41}", &["\u{41}\u{3a}\u{41}"]),
+ (
+ "\u{41}\u{3a}\u{3a}\u{41}",
+ &["\u{41}", "\u{3a}", "\u{3a}", "\u{41}"],
+ ),
+ ("\u{5d0}\u{27}", &["\u{5d0}\u{27}"]),
+ ("\u{5d0}\u{22}\u{5d0}", &["\u{5d0}\u{22}\u{5d0}"]),
+ ("\u{41}\u{30}\u{30}\u{41}", &["\u{41}\u{30}\u{30}\u{41}"]),
+ ("\u{30}\u{2c}\u{30}", &["\u{30}\u{2c}\u{30}"]),
+ (
+ "\u{30}\u{2c}\u{2c}\u{30}",
+ &["\u{30}", "\u{2c}", "\u{2c}", "\u{30}"],
+ ),
+ ("\u{3031}\u{3031}", &["\u{3031}\u{3031}"]),
+ (
+ "\u{41}\u{5f}\u{30}\u{5f}\u{3031}\u{5f}",
+ &["\u{41}\u{5f}\u{30}\u{5f}\u{3031}\u{5f}"],
+ ),
+ ("\u{41}\u{5f}\u{5f}\u{41}", &["\u{41}\u{5f}\u{5f}\u{41}"]),
+ (
+ "\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{62}",
+ &["\u{1f1e6}\u{1f1e7}", "\u{1f1e8}", "\u{62}"],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{62}",
+ &["\u{61}", "\u{1f1e6}\u{1f1e7}", "\u{1f1e8}", "\u{62}"],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{200d}\u{1f1e8}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{1f1e7}\u{200d}",
+ "\u{1f1e8}",
+ "\u{62}",
+ ],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{200d}\u{1f1e7}\u{1f1e8}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{200d}\u{1f1e7}",
+ "\u{1f1e8}",
+ "\u{62}",
+ ],
+ ),
+ (
+ "\u{61}\u{1f1e6}\u{1f1e7}\u{1f1e8}\u{1f1e9}\u{62}",
+ &[
+ "\u{61}",
+ "\u{1f1e6}\u{1f1e7}",
+ "\u{1f1e8}\u{1f1e9}",
+ "\u{62}",
+ ],
+ ),
+ (
+ "\u{1f476}\u{1f3ff}\u{1f476}",
+ &["\u{1f476}\u{1f3ff}", "\u{1f476}"],
+ ),
+ (
+ "\u{1f6d1}\u{200d}\u{1f6d1}",
+ &["\u{1f6d1}\u{200d}\u{1f6d1}"],
+ ),
+ ("\u{61}\u{200d}\u{1f6d1}", &["\u{61}\u{200d}\u{1f6d1}"]),
+ ("\u{2701}\u{200d}\u{2701}", &["\u{2701}\u{200d}\u{2701}"]),
+ ("\u{61}\u{200d}\u{2701}", &["\u{61}\u{200d}\u{2701}"]),
+ (
+ "\u{1f476}\u{1f3ff}\u{308}\u{200d}\u{1f476}\u{1f3ff}",
+ &["\u{1f476}\u{1f3ff}\u{308}\u{200d}\u{1f476}\u{1f3ff}"],
+ ),
+ ("\u{1f6d1}\u{1f3ff}", &["\u{1f6d1}\u{1f3ff}"]),
+ (
+ "\u{200d}\u{1f6d1}\u{1f3ff}",
+ &["\u{200d}\u{1f6d1}\u{1f3ff}"],
+ ),
+ ("\u{200d}\u{1f6d1}", &["\u{200d}\u{1f6d1}"]),
+ ("\u{200d}\u{1f6d1}", &["\u{200d}\u{1f6d1}"]),
+ ("\u{1f6d1}\u{1f6d1}", &["\u{1f6d1}", "\u{1f6d1}"]),
+ (
+ "\u{61}\u{308}\u{200d}\u{308}\u{62}",
+ &["\u{61}\u{308}\u{200d}\u{308}\u{62}"],
+ ),
+ (
+ "\u{61}\u{20}\u{20}\u{62}",
+ &["\u{61}", "\u{20}\u{20}", "\u{62}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{3a}\u{31}",
+ &["\u{31}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{3a}\u{61}",
+ &["\u{31}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{2e}\u{31}",
+ &["\u{31}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{2e}\u{61}",
+ &["\u{31}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{2c}\u{31}",
+ &["\u{31}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{3a}\u{2c}\u{61}",
+ &["\u{31}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{3a}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{3a}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{3a}\u{31}",
+ &["\u{31}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{3a}\u{61}",
+ &["\u{31}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2e}\u{31}",
+ &["\u{31}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2e}\u{61}",
+ &["\u{31}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2c}\u{31}",
+ &["\u{31}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2e}\u{2c}\u{61}",
+ &["\u{31}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2e}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2e}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{3a}\u{31}",
+ &["\u{31}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{3a}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{3a}\u{61}",
+ &["\u{31}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{3a}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{2e}\u{31}",
+ &["\u{31}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{2e}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{2e}\u{61}",
+ &["\u{31}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{2e}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{2c}\u{31}",
+ &["\u{31}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{2c}\u{31}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{31}\u{2c}\u{2c}\u{61}",
+ &["\u{31}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{31}\u{2c}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{31}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{31}\u{5f}\u{61}\u{2c}\u{2c}\u{61}",
+ &["\u{31}\u{5f}\u{61}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{3a}\u{31}",
+ &["\u{61}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{3a}\u{61}",
+ &["\u{61}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{2e}\u{31}",
+ &["\u{61}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{2e}\u{61}",
+ &["\u{61}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{2c}\u{31}",
+ &["\u{61}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{3a}\u{2c}\u{61}",
+ &["\u{61}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{3a}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{3a}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{3a}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{3a}\u{31}",
+ &["\u{61}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{3a}\u{61}",
+ &["\u{61}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{2e}\u{31}",
+ &["\u{61}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{2e}\u{61}",
+ &["\u{61}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{2c}\u{31}",
+ &["\u{61}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2e}\u{2c}\u{61}",
+ &["\u{61}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2e}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2e}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2e}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{3a}\u{31}",
+ &["\u{61}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{3a}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{3a}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{3a}\u{61}",
+ &["\u{61}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{3a}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{3a}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{2e}\u{31}",
+ &["\u{61}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{2e}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{2e}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{2e}\u{61}",
+ &["\u{61}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{2e}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{2e}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{2c}\u{31}",
+ &["\u{61}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{2c}\u{31}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{2c}", "\u{31}"],
+ ),
+ (
+ "\u{61}\u{2c}\u{2c}\u{61}",
+ &["\u{61}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{31}\u{2c}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{31}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+ (
+ "\u{61}\u{5f}\u{61}\u{2c}\u{2c}\u{61}",
+ &["\u{61}\u{5f}\u{61}", "\u{2c}", "\u{2c}", "\u{61}"],
+ ),
+];
+
+// official Unicode test data
+// http://www.unicode.org/Public/15.0.0/ucd/auxiliary/SentenceBreakTest.txt
+pub const TEST_SENTENCE: &'static [(&'static str, &'static [&'static str])] = &[
+ ("\u{1}\u{1}", &["\u{1}\u{1}"]), ("\u{1}\u{308}\u{1}", &["\u{1}\u{308}\u{1}"]),
+ ("\u{1}\u{d}", &["\u{1}\u{d}"]), ("\u{1}\u{308}\u{d}", &["\u{1}\u{308}\u{d}"]),
+ ("\u{1}\u{a}", &["\u{1}\u{a}"]), ("\u{1}\u{308}\u{a}", &["\u{1}\u{308}\u{a}"]),
+ ("\u{1}\u{85}", &["\u{1}\u{85}"]), ("\u{1}\u{308}\u{85}", &["\u{1}\u{308}\u{85}"]),
+ ("\u{1}\u{9}", &["\u{1}\u{9}"]), ("\u{1}\u{308}\u{9}", &["\u{1}\u{308}\u{9}"]),
+ ("\u{1}\u{61}", &["\u{1}\u{61}"]), ("\u{1}\u{308}\u{61}", &["\u{1}\u{308}\u{61}"]),
+ ("\u{1}\u{41}", &["\u{1}\u{41}"]), ("\u{1}\u{308}\u{41}", &["\u{1}\u{308}\u{41}"]),
+ ("\u{1}\u{1bb}", &["\u{1}\u{1bb}"]), ("\u{1}\u{308}\u{1bb}", &["\u{1}\u{308}\u{1bb}"]),
+ ("\u{1}\u{30}", &["\u{1}\u{30}"]), ("\u{1}\u{308}\u{30}", &["\u{1}\u{308}\u{30}"]),
+ ("\u{1}\u{2e}", &["\u{1}\u{2e}"]), ("\u{1}\u{308}\u{2e}", &["\u{1}\u{308}\u{2e}"]),
+ ("\u{1}\u{21}", &["\u{1}\u{21}"]), ("\u{1}\u{308}\u{21}", &["\u{1}\u{308}\u{21}"]),
+ ("\u{1}\u{22}", &["\u{1}\u{22}"]), ("\u{1}\u{308}\u{22}", &["\u{1}\u{308}\u{22}"]),
+ ("\u{1}\u{2c}", &["\u{1}\u{2c}"]), ("\u{1}\u{308}\u{2c}", &["\u{1}\u{308}\u{2c}"]),
+ ("\u{1}\u{ad}", &["\u{1}\u{ad}"]), ("\u{1}\u{308}\u{ad}", &["\u{1}\u{308}\u{ad}"]),
+ ("\u{1}\u{300}", &["\u{1}\u{300}"]), ("\u{1}\u{308}\u{300}", &["\u{1}\u{308}\u{300}"]),
+ ("\u{d}\u{1}", &["\u{d}", "\u{1}"]), ("\u{d}\u{308}\u{1}", &["\u{d}", "\u{308}\u{1}"]),
+ ("\u{d}\u{d}", &["\u{d}", "\u{d}"]), ("\u{d}\u{308}\u{d}", &["\u{d}", "\u{308}\u{d}"]),
+ ("\u{d}\u{a}", &["\u{d}\u{a}"]), ("\u{d}\u{308}\u{a}", &["\u{d}", "\u{308}\u{a}"]),
+ ("\u{d}\u{85}", &["\u{d}", "\u{85}"]), ("\u{d}\u{308}\u{85}", &["\u{d}", "\u{308}\u{85}"]),
+ ("\u{d}\u{9}", &["\u{d}", "\u{9}"]), ("\u{d}\u{308}\u{9}", &["\u{d}", "\u{308}\u{9}"]),
+ ("\u{d}\u{61}", &["\u{d}", "\u{61}"]), ("\u{d}\u{308}\u{61}", &["\u{d}", "\u{308}\u{61}"]),
+ ("\u{d}\u{41}", &["\u{d}", "\u{41}"]), ("\u{d}\u{308}\u{41}", &["\u{d}", "\u{308}\u{41}"]),
+ ("\u{d}\u{1bb}", &["\u{d}", "\u{1bb}"]), ("\u{d}\u{308}\u{1bb}", &["\u{d}",
+ "\u{308}\u{1bb}"]), ("\u{d}\u{30}", &["\u{d}", "\u{30}"]), ("\u{d}\u{308}\u{30}", &["\u{d}",
+ "\u{308}\u{30}"]), ("\u{d}\u{2e}", &["\u{d}", "\u{2e}"]), ("\u{d}\u{308}\u{2e}", &["\u{d}",
+ "\u{308}\u{2e}"]), ("\u{d}\u{21}", &["\u{d}", "\u{21}"]), ("\u{d}\u{308}\u{21}", &["\u{d}",
+ "\u{308}\u{21}"]), ("\u{d}\u{22}", &["\u{d}", "\u{22}"]), ("\u{d}\u{308}\u{22}", &["\u{d}",
+ "\u{308}\u{22}"]), ("\u{d}\u{2c}", &["\u{d}", "\u{2c}"]), ("\u{d}\u{308}\u{2c}", &["\u{d}",
+ "\u{308}\u{2c}"]), ("\u{d}\u{ad}", &["\u{d}", "\u{ad}"]), ("\u{d}\u{308}\u{ad}", &["\u{d}",
+ "\u{308}\u{ad}"]), ("\u{d}\u{300}", &["\u{d}", "\u{300}"]), ("\u{d}\u{308}\u{300}",
+ &["\u{d}", "\u{308}\u{300}"]), ("\u{a}\u{1}", &["\u{a}", "\u{1}"]), ("\u{a}\u{308}\u{1}",
+ &["\u{a}", "\u{308}\u{1}"]), ("\u{a}\u{d}", &["\u{a}", "\u{d}"]), ("\u{a}\u{308}\u{d}",
+ &["\u{a}", "\u{308}\u{d}"]), ("\u{a}\u{a}", &["\u{a}", "\u{a}"]), ("\u{a}\u{308}\u{a}",
+ &["\u{a}", "\u{308}\u{a}"]), ("\u{a}\u{85}", &["\u{a}", "\u{85}"]), ("\u{a}\u{308}\u{85}",
+ &["\u{a}", "\u{308}\u{85}"]), ("\u{a}\u{9}", &["\u{a}", "\u{9}"]), ("\u{a}\u{308}\u{9}",
+ &["\u{a}", "\u{308}\u{9}"]), ("\u{a}\u{61}", &["\u{a}", "\u{61}"]), ("\u{a}\u{308}\u{61}",
+ &["\u{a}", "\u{308}\u{61}"]), ("\u{a}\u{41}", &["\u{a}", "\u{41}"]), ("\u{a}\u{308}\u{41}",
+ &["\u{a}", "\u{308}\u{41}"]), ("\u{a}\u{1bb}", &["\u{a}", "\u{1bb}"]),
+ ("\u{a}\u{308}\u{1bb}", &["\u{a}", "\u{308}\u{1bb}"]), ("\u{a}\u{30}", &["\u{a}",
+ "\u{30}"]), ("\u{a}\u{308}\u{30}", &["\u{a}", "\u{308}\u{30}"]), ("\u{a}\u{2e}", &["\u{a}",
+ "\u{2e}"]), ("\u{a}\u{308}\u{2e}", &["\u{a}", "\u{308}\u{2e}"]), ("\u{a}\u{21}", &["\u{a}",
+ "\u{21}"]), ("\u{a}\u{308}\u{21}", &["\u{a}", "\u{308}\u{21}"]), ("\u{a}\u{22}", &["\u{a}",
+ "\u{22}"]), ("\u{a}\u{308}\u{22}", &["\u{a}", "\u{308}\u{22}"]), ("\u{a}\u{2c}", &["\u{a}",
+ "\u{2c}"]), ("\u{a}\u{308}\u{2c}", &["\u{a}", "\u{308}\u{2c}"]), ("\u{a}\u{ad}", &["\u{a}",
+ "\u{ad}"]), ("\u{a}\u{308}\u{ad}", &["\u{a}", "\u{308}\u{ad}"]), ("\u{a}\u{300}", &["\u{a}",
+ "\u{300}"]), ("\u{a}\u{308}\u{300}", &["\u{a}", "\u{308}\u{300}"]), ("\u{85}\u{1}",
+ &["\u{85}", "\u{1}"]), ("\u{85}\u{308}\u{1}", &["\u{85}", "\u{308}\u{1}"]), ("\u{85}\u{d}",
+ &["\u{85}", "\u{d}"]), ("\u{85}\u{308}\u{d}", &["\u{85}", "\u{308}\u{d}"]), ("\u{85}\u{a}",
+ &["\u{85}", "\u{a}"]), ("\u{85}\u{308}\u{a}", &["\u{85}", "\u{308}\u{a}"]), ("\u{85}\u{85}",
+ &["\u{85}", "\u{85}"]), ("\u{85}\u{308}\u{85}", &["\u{85}", "\u{308}\u{85}"]),
+ ("\u{85}\u{9}", &["\u{85}", "\u{9}"]), ("\u{85}\u{308}\u{9}", &["\u{85}", "\u{308}\u{9}"]),
+ ("\u{85}\u{61}", &["\u{85}", "\u{61}"]), ("\u{85}\u{308}\u{61}", &["\u{85}",
+ "\u{308}\u{61}"]), ("\u{85}\u{41}", &["\u{85}", "\u{41}"]), ("\u{85}\u{308}\u{41}",
+ &["\u{85}", "\u{308}\u{41}"]), ("\u{85}\u{1bb}", &["\u{85}", "\u{1bb}"]),
+ ("\u{85}\u{308}\u{1bb}", &["\u{85}", "\u{308}\u{1bb}"]), ("\u{85}\u{30}", &["\u{85}",
+ "\u{30}"]), ("\u{85}\u{308}\u{30}", &["\u{85}", "\u{308}\u{30}"]), ("\u{85}\u{2e}",
+ &["\u{85}", "\u{2e}"]), ("\u{85}\u{308}\u{2e}", &["\u{85}", "\u{308}\u{2e}"]),
+ ("\u{85}\u{21}", &["\u{85}", "\u{21}"]), ("\u{85}\u{308}\u{21}", &["\u{85}",
+ "\u{308}\u{21}"]), ("\u{85}\u{22}", &["\u{85}", "\u{22}"]), ("\u{85}\u{308}\u{22}",
+ &["\u{85}", "\u{308}\u{22}"]), ("\u{85}\u{2c}", &["\u{85}", "\u{2c}"]),
+ ("\u{85}\u{308}\u{2c}", &["\u{85}", "\u{308}\u{2c}"]), ("\u{85}\u{ad}", &["\u{85}",
+ "\u{ad}"]), ("\u{85}\u{308}\u{ad}", &["\u{85}", "\u{308}\u{ad}"]), ("\u{85}\u{300}",
+ &["\u{85}", "\u{300}"]), ("\u{85}\u{308}\u{300}", &["\u{85}", "\u{308}\u{300}"]),
+ ("\u{9}\u{1}", &["\u{9}\u{1}"]), ("\u{9}\u{308}\u{1}", &["\u{9}\u{308}\u{1}"]),
+ ("\u{9}\u{d}", &["\u{9}\u{d}"]), ("\u{9}\u{308}\u{d}", &["\u{9}\u{308}\u{d}"]),
+ ("\u{9}\u{a}", &["\u{9}\u{a}"]), ("\u{9}\u{308}\u{a}", &["\u{9}\u{308}\u{a}"]),
+ ("\u{9}\u{85}", &["\u{9}\u{85}"]), ("\u{9}\u{308}\u{85}", &["\u{9}\u{308}\u{85}"]),
+ ("\u{9}\u{9}", &["\u{9}\u{9}"]), ("\u{9}\u{308}\u{9}", &["\u{9}\u{308}\u{9}"]),
+ ("\u{9}\u{61}", &["\u{9}\u{61}"]), ("\u{9}\u{308}\u{61}", &["\u{9}\u{308}\u{61}"]),
+ ("\u{9}\u{41}", &["\u{9}\u{41}"]), ("\u{9}\u{308}\u{41}", &["\u{9}\u{308}\u{41}"]),
+ ("\u{9}\u{1bb}", &["\u{9}\u{1bb}"]), ("\u{9}\u{308}\u{1bb}", &["\u{9}\u{308}\u{1bb}"]),
+ ("\u{9}\u{30}", &["\u{9}\u{30}"]), ("\u{9}\u{308}\u{30}", &["\u{9}\u{308}\u{30}"]),
+ ("\u{9}\u{2e}", &["\u{9}\u{2e}"]), ("\u{9}\u{308}\u{2e}", &["\u{9}\u{308}\u{2e}"]),
+ ("\u{9}\u{21}", &["\u{9}\u{21}"]), ("\u{9}\u{308}\u{21}", &["\u{9}\u{308}\u{21}"]),
+ ("\u{9}\u{22}", &["\u{9}\u{22}"]), ("\u{9}\u{308}\u{22}", &["\u{9}\u{308}\u{22}"]),
+ ("\u{9}\u{2c}", &["\u{9}\u{2c}"]), ("\u{9}\u{308}\u{2c}", &["\u{9}\u{308}\u{2c}"]),
+ ("\u{9}\u{ad}", &["\u{9}\u{ad}"]), ("\u{9}\u{308}\u{ad}", &["\u{9}\u{308}\u{ad}"]),
+ ("\u{9}\u{300}", &["\u{9}\u{300}"]), ("\u{9}\u{308}\u{300}", &["\u{9}\u{308}\u{300}"]),
+ ("\u{61}\u{1}", &["\u{61}\u{1}"]), ("\u{61}\u{308}\u{1}", &["\u{61}\u{308}\u{1}"]),
+ ("\u{61}\u{d}", &["\u{61}\u{d}"]), ("\u{61}\u{308}\u{d}", &["\u{61}\u{308}\u{d}"]),
+ ("\u{61}\u{a}", &["\u{61}\u{a}"]), ("\u{61}\u{308}\u{a}", &["\u{61}\u{308}\u{a}"]),
+ ("\u{61}\u{85}", &["\u{61}\u{85}"]), ("\u{61}\u{308}\u{85}", &["\u{61}\u{308}\u{85}"]),
+ ("\u{61}\u{9}", &["\u{61}\u{9}"]), ("\u{61}\u{308}\u{9}", &["\u{61}\u{308}\u{9}"]),
+ ("\u{61}\u{61}", &["\u{61}\u{61}"]), ("\u{61}\u{308}\u{61}", &["\u{61}\u{308}\u{61}"]),
+ ("\u{61}\u{41}", &["\u{61}\u{41}"]), ("\u{61}\u{308}\u{41}", &["\u{61}\u{308}\u{41}"]),
+ ("\u{61}\u{1bb}", &["\u{61}\u{1bb}"]), ("\u{61}\u{308}\u{1bb}", &["\u{61}\u{308}\u{1bb}"]),
+ ("\u{61}\u{30}", &["\u{61}\u{30}"]), ("\u{61}\u{308}\u{30}", &["\u{61}\u{308}\u{30}"]),
+ ("\u{61}\u{2e}", &["\u{61}\u{2e}"]), ("\u{61}\u{308}\u{2e}", &["\u{61}\u{308}\u{2e}"]),
+ ("\u{61}\u{21}", &["\u{61}\u{21}"]), ("\u{61}\u{308}\u{21}", &["\u{61}\u{308}\u{21}"]),
+ ("\u{61}\u{22}", &["\u{61}\u{22}"]), ("\u{61}\u{308}\u{22}", &["\u{61}\u{308}\u{22}"]),
+ ("\u{61}\u{2c}", &["\u{61}\u{2c}"]), ("\u{61}\u{308}\u{2c}", &["\u{61}\u{308}\u{2c}"]),
+ ("\u{61}\u{ad}", &["\u{61}\u{ad}"]), ("\u{61}\u{308}\u{ad}", &["\u{61}\u{308}\u{ad}"]),
+ ("\u{61}\u{300}", &["\u{61}\u{300}"]), ("\u{61}\u{308}\u{300}", &["\u{61}\u{308}\u{300}"]),
+ ("\u{41}\u{1}", &["\u{41}\u{1}"]), ("\u{41}\u{308}\u{1}", &["\u{41}\u{308}\u{1}"]),
+ ("\u{41}\u{d}", &["\u{41}\u{d}"]), ("\u{41}\u{308}\u{d}", &["\u{41}\u{308}\u{d}"]),
+ ("\u{41}\u{a}", &["\u{41}\u{a}"]), ("\u{41}\u{308}\u{a}", &["\u{41}\u{308}\u{a}"]),
+ ("\u{41}\u{85}", &["\u{41}\u{85}"]), ("\u{41}\u{308}\u{85}", &["\u{41}\u{308}\u{85}"]),
+ ("\u{41}\u{9}", &["\u{41}\u{9}"]), ("\u{41}\u{308}\u{9}", &["\u{41}\u{308}\u{9}"]),
+ ("\u{41}\u{61}", &["\u{41}\u{61}"]), ("\u{41}\u{308}\u{61}", &["\u{41}\u{308}\u{61}"]),
+ ("\u{41}\u{41}", &["\u{41}\u{41}"]), ("\u{41}\u{308}\u{41}", &["\u{41}\u{308}\u{41}"]),
+ ("\u{41}\u{1bb}", &["\u{41}\u{1bb}"]), ("\u{41}\u{308}\u{1bb}", &["\u{41}\u{308}\u{1bb}"]),
+ ("\u{41}\u{30}", &["\u{41}\u{30}"]), ("\u{41}\u{308}\u{30}", &["\u{41}\u{308}\u{30}"]),
+ ("\u{41}\u{2e}", &["\u{41}\u{2e}"]), ("\u{41}\u{308}\u{2e}", &["\u{41}\u{308}\u{2e}"]),
+ ("\u{41}\u{21}", &["\u{41}\u{21}"]), ("\u{41}\u{308}\u{21}", &["\u{41}\u{308}\u{21}"]),
+ ("\u{41}\u{22}", &["\u{41}\u{22}"]), ("\u{41}\u{308}\u{22}", &["\u{41}\u{308}\u{22}"]),
+ ("\u{41}\u{2c}", &["\u{41}\u{2c}"]), ("\u{41}\u{308}\u{2c}", &["\u{41}\u{308}\u{2c}"]),
+ ("\u{41}\u{ad}", &["\u{41}\u{ad}"]), ("\u{41}\u{308}\u{ad}", &["\u{41}\u{308}\u{ad}"]),
+ ("\u{41}\u{300}", &["\u{41}\u{300}"]), ("\u{41}\u{308}\u{300}", &["\u{41}\u{308}\u{300}"]),
+ ("\u{1bb}\u{1}", &["\u{1bb}\u{1}"]), ("\u{1bb}\u{308}\u{1}", &["\u{1bb}\u{308}\u{1}"]),
+ ("\u{1bb}\u{d}", &["\u{1bb}\u{d}"]), ("\u{1bb}\u{308}\u{d}", &["\u{1bb}\u{308}\u{d}"]),
+ ("\u{1bb}\u{a}", &["\u{1bb}\u{a}"]), ("\u{1bb}\u{308}\u{a}", &["\u{1bb}\u{308}\u{a}"]),
+ ("\u{1bb}\u{85}", &["\u{1bb}\u{85}"]), ("\u{1bb}\u{308}\u{85}", &["\u{1bb}\u{308}\u{85}"]),
+ ("\u{1bb}\u{9}", &["\u{1bb}\u{9}"]), ("\u{1bb}\u{308}\u{9}", &["\u{1bb}\u{308}\u{9}"]),
+ ("\u{1bb}\u{61}", &["\u{1bb}\u{61}"]), ("\u{1bb}\u{308}\u{61}", &["\u{1bb}\u{308}\u{61}"]),
+ ("\u{1bb}\u{41}", &["\u{1bb}\u{41}"]), ("\u{1bb}\u{308}\u{41}", &["\u{1bb}\u{308}\u{41}"]),
+ ("\u{1bb}\u{1bb}", &["\u{1bb}\u{1bb}"]), ("\u{1bb}\u{308}\u{1bb}",
+ &["\u{1bb}\u{308}\u{1bb}"]), ("\u{1bb}\u{30}", &["\u{1bb}\u{30}"]), ("\u{1bb}\u{308}\u{30}",
+ &["\u{1bb}\u{308}\u{30}"]), ("\u{1bb}\u{2e}", &["\u{1bb}\u{2e}"]), ("\u{1bb}\u{308}\u{2e}",
+ &["\u{1bb}\u{308}\u{2e}"]), ("\u{1bb}\u{21}", &["\u{1bb}\u{21}"]), ("\u{1bb}\u{308}\u{21}",
+ &["\u{1bb}\u{308}\u{21}"]), ("\u{1bb}\u{22}", &["\u{1bb}\u{22}"]), ("\u{1bb}\u{308}\u{22}",
+ &["\u{1bb}\u{308}\u{22}"]), ("\u{1bb}\u{2c}", &["\u{1bb}\u{2c}"]), ("\u{1bb}\u{308}\u{2c}",
+ &["\u{1bb}\u{308}\u{2c}"]), ("\u{1bb}\u{ad}", &["\u{1bb}\u{ad}"]), ("\u{1bb}\u{308}\u{ad}",
+ &["\u{1bb}\u{308}\u{ad}"]), ("\u{1bb}\u{300}", &["\u{1bb}\u{300}"]),
+ ("\u{1bb}\u{308}\u{300}", &["\u{1bb}\u{308}\u{300}"]), ("\u{30}\u{1}", &["\u{30}\u{1}"]),
+ ("\u{30}\u{308}\u{1}", &["\u{30}\u{308}\u{1}"]), ("\u{30}\u{d}", &["\u{30}\u{d}"]),
+ ("\u{30}\u{308}\u{d}", &["\u{30}\u{308}\u{d}"]), ("\u{30}\u{a}", &["\u{30}\u{a}"]),
+ ("\u{30}\u{308}\u{a}", &["\u{30}\u{308}\u{a}"]), ("\u{30}\u{85}", &["\u{30}\u{85}"]),
+ ("\u{30}\u{308}\u{85}", &["\u{30}\u{308}\u{85}"]), ("\u{30}\u{9}", &["\u{30}\u{9}"]),
+ ("\u{30}\u{308}\u{9}", &["\u{30}\u{308}\u{9}"]), ("\u{30}\u{61}", &["\u{30}\u{61}"]),
+ ("\u{30}\u{308}\u{61}", &["\u{30}\u{308}\u{61}"]), ("\u{30}\u{41}", &["\u{30}\u{41}"]),
+ ("\u{30}\u{308}\u{41}", &["\u{30}\u{308}\u{41}"]), ("\u{30}\u{1bb}", &["\u{30}\u{1bb}"]),
+ ("\u{30}\u{308}\u{1bb}", &["\u{30}\u{308}\u{1bb}"]), ("\u{30}\u{30}", &["\u{30}\u{30}"]),
+ ("\u{30}\u{308}\u{30}", &["\u{30}\u{308}\u{30}"]), ("\u{30}\u{2e}", &["\u{30}\u{2e}"]),
+ ("\u{30}\u{308}\u{2e}", &["\u{30}\u{308}\u{2e}"]), ("\u{30}\u{21}", &["\u{30}\u{21}"]),
+ ("\u{30}\u{308}\u{21}", &["\u{30}\u{308}\u{21}"]), ("\u{30}\u{22}", &["\u{30}\u{22}"]),
+ ("\u{30}\u{308}\u{22}", &["\u{30}\u{308}\u{22}"]), ("\u{30}\u{2c}", &["\u{30}\u{2c}"]),
+ ("\u{30}\u{308}\u{2c}", &["\u{30}\u{308}\u{2c}"]), ("\u{30}\u{ad}", &["\u{30}\u{ad}"]),
+ ("\u{30}\u{308}\u{ad}", &["\u{30}\u{308}\u{ad}"]), ("\u{30}\u{300}", &["\u{30}\u{300}"]),
+ ("\u{30}\u{308}\u{300}", &["\u{30}\u{308}\u{300}"]), ("\u{2e}\u{1}", &["\u{2e}", "\u{1}"]),
+ ("\u{2e}\u{308}\u{1}", &["\u{2e}\u{308}", "\u{1}"]), ("\u{2e}\u{d}", &["\u{2e}\u{d}"]),
+ ("\u{2e}\u{308}\u{d}", &["\u{2e}\u{308}\u{d}"]), ("\u{2e}\u{a}", &["\u{2e}\u{a}"]),
+ ("\u{2e}\u{308}\u{a}", &["\u{2e}\u{308}\u{a}"]), ("\u{2e}\u{85}", &["\u{2e}\u{85}"]),
+ ("\u{2e}\u{308}\u{85}", &["\u{2e}\u{308}\u{85}"]), ("\u{2e}\u{9}", &["\u{2e}\u{9}"]),
+ ("\u{2e}\u{308}\u{9}", &["\u{2e}\u{308}\u{9}"]), ("\u{2e}\u{61}", &["\u{2e}\u{61}"]),
+ ("\u{2e}\u{308}\u{61}", &["\u{2e}\u{308}\u{61}"]), ("\u{2e}\u{41}", &["\u{2e}", "\u{41}"]),
+ ("\u{2e}\u{308}\u{41}", &["\u{2e}\u{308}", "\u{41}"]), ("\u{2e}\u{1bb}", &["\u{2e}",
+ "\u{1bb}"]), ("\u{2e}\u{308}\u{1bb}", &["\u{2e}\u{308}", "\u{1bb}"]), ("\u{2e}\u{30}",
+ &["\u{2e}\u{30}"]), ("\u{2e}\u{308}\u{30}", &["\u{2e}\u{308}\u{30}"]), ("\u{2e}\u{2e}",
+ &["\u{2e}\u{2e}"]), ("\u{2e}\u{308}\u{2e}", &["\u{2e}\u{308}\u{2e}"]), ("\u{2e}\u{21}",
+ &["\u{2e}\u{21}"]), ("\u{2e}\u{308}\u{21}", &["\u{2e}\u{308}\u{21}"]), ("\u{2e}\u{22}",
+ &["\u{2e}\u{22}"]), ("\u{2e}\u{308}\u{22}", &["\u{2e}\u{308}\u{22}"]), ("\u{2e}\u{2c}",
+ &["\u{2e}\u{2c}"]), ("\u{2e}\u{308}\u{2c}", &["\u{2e}\u{308}\u{2c}"]), ("\u{2e}\u{ad}",
+ &["\u{2e}\u{ad}"]), ("\u{2e}\u{308}\u{ad}", &["\u{2e}\u{308}\u{ad}"]), ("\u{2e}\u{300}",
+ &["\u{2e}\u{300}"]), ("\u{2e}\u{308}\u{300}", &["\u{2e}\u{308}\u{300}"]), ("\u{21}\u{1}",
+ &["\u{21}", "\u{1}"]), ("\u{21}\u{308}\u{1}", &["\u{21}\u{308}", "\u{1}"]), ("\u{21}\u{d}",
+ &["\u{21}\u{d}"]), ("\u{21}\u{308}\u{d}", &["\u{21}\u{308}\u{d}"]), ("\u{21}\u{a}",
+ &["\u{21}\u{a}"]), ("\u{21}\u{308}\u{a}", &["\u{21}\u{308}\u{a}"]), ("\u{21}\u{85}",
+ &["\u{21}\u{85}"]), ("\u{21}\u{308}\u{85}", &["\u{21}\u{308}\u{85}"]), ("\u{21}\u{9}",
+ &["\u{21}\u{9}"]), ("\u{21}\u{308}\u{9}", &["\u{21}\u{308}\u{9}"]), ("\u{21}\u{61}",
+ &["\u{21}", "\u{61}"]), ("\u{21}\u{308}\u{61}", &["\u{21}\u{308}", "\u{61}"]),
+ ("\u{21}\u{41}", &["\u{21}", "\u{41}"]), ("\u{21}\u{308}\u{41}", &["\u{21}\u{308}",
+ "\u{41}"]), ("\u{21}\u{1bb}", &["\u{21}", "\u{1bb}"]), ("\u{21}\u{308}\u{1bb}",
+ &["\u{21}\u{308}", "\u{1bb}"]), ("\u{21}\u{30}", &["\u{21}", "\u{30}"]),
+ ("\u{21}\u{308}\u{30}", &["\u{21}\u{308}", "\u{30}"]), ("\u{21}\u{2e}", &["\u{21}\u{2e}"]),
+ ("\u{21}\u{308}\u{2e}", &["\u{21}\u{308}\u{2e}"]), ("\u{21}\u{21}", &["\u{21}\u{21}"]),
+ ("\u{21}\u{308}\u{21}", &["\u{21}\u{308}\u{21}"]), ("\u{21}\u{22}", &["\u{21}\u{22}"]),
+ ("\u{21}\u{308}\u{22}", &["\u{21}\u{308}\u{22}"]), ("\u{21}\u{2c}", &["\u{21}\u{2c}"]),
+ ("\u{21}\u{308}\u{2c}", &["\u{21}\u{308}\u{2c}"]), ("\u{21}\u{ad}", &["\u{21}\u{ad}"]),
+ ("\u{21}\u{308}\u{ad}", &["\u{21}\u{308}\u{ad}"]), ("\u{21}\u{300}", &["\u{21}\u{300}"]),
+ ("\u{21}\u{308}\u{300}", &["\u{21}\u{308}\u{300}"]), ("\u{22}\u{1}", &["\u{22}\u{1}"]),
+ ("\u{22}\u{308}\u{1}", &["\u{22}\u{308}\u{1}"]), ("\u{22}\u{d}", &["\u{22}\u{d}"]),
+ ("\u{22}\u{308}\u{d}", &["\u{22}\u{308}\u{d}"]), ("\u{22}\u{a}", &["\u{22}\u{a}"]),
+ ("\u{22}\u{308}\u{a}", &["\u{22}\u{308}\u{a}"]), ("\u{22}\u{85}", &["\u{22}\u{85}"]),
+ ("\u{22}\u{308}\u{85}", &["\u{22}\u{308}\u{85}"]), ("\u{22}\u{9}", &["\u{22}\u{9}"]),
+ ("\u{22}\u{308}\u{9}", &["\u{22}\u{308}\u{9}"]), ("\u{22}\u{61}", &["\u{22}\u{61}"]),
+ ("\u{22}\u{308}\u{61}", &["\u{22}\u{308}\u{61}"]), ("\u{22}\u{41}", &["\u{22}\u{41}"]),
+ ("\u{22}\u{308}\u{41}", &["\u{22}\u{308}\u{41}"]), ("\u{22}\u{1bb}", &["\u{22}\u{1bb}"]),
+ ("\u{22}\u{308}\u{1bb}", &["\u{22}\u{308}\u{1bb}"]), ("\u{22}\u{30}", &["\u{22}\u{30}"]),
+ ("\u{22}\u{308}\u{30}", &["\u{22}\u{308}\u{30}"]), ("\u{22}\u{2e}", &["\u{22}\u{2e}"]),
+ ("\u{22}\u{308}\u{2e}", &["\u{22}\u{308}\u{2e}"]), ("\u{22}\u{21}", &["\u{22}\u{21}"]),
+ ("\u{22}\u{308}\u{21}", &["\u{22}\u{308}\u{21}"]), ("\u{22}\u{22}", &["\u{22}\u{22}"]),
+ ("\u{22}\u{308}\u{22}", &["\u{22}\u{308}\u{22}"]), ("\u{22}\u{2c}", &["\u{22}\u{2c}"]),
+ ("\u{22}\u{308}\u{2c}", &["\u{22}\u{308}\u{2c}"]), ("\u{22}\u{ad}", &["\u{22}\u{ad}"]),
+ ("\u{22}\u{308}\u{ad}", &["\u{22}\u{308}\u{ad}"]), ("\u{22}\u{300}", &["\u{22}\u{300}"]),
+ ("\u{22}\u{308}\u{300}", &["\u{22}\u{308}\u{300}"]), ("\u{2c}\u{1}", &["\u{2c}\u{1}"]),
+ ("\u{2c}\u{308}\u{1}", &["\u{2c}\u{308}\u{1}"]), ("\u{2c}\u{d}", &["\u{2c}\u{d}"]),
+ ("\u{2c}\u{308}\u{d}", &["\u{2c}\u{308}\u{d}"]), ("\u{2c}\u{a}", &["\u{2c}\u{a}"]),
+ ("\u{2c}\u{308}\u{a}", &["\u{2c}\u{308}\u{a}"]), ("\u{2c}\u{85}", &["\u{2c}\u{85}"]),
+ ("\u{2c}\u{308}\u{85}", &["\u{2c}\u{308}\u{85}"]), ("\u{2c}\u{9}", &["\u{2c}\u{9}"]),
+ ("\u{2c}\u{308}\u{9}", &["\u{2c}\u{308}\u{9}"]), ("\u{2c}\u{61}", &["\u{2c}\u{61}"]),
+ ("\u{2c}\u{308}\u{61}", &["\u{2c}\u{308}\u{61}"]), ("\u{2c}\u{41}", &["\u{2c}\u{41}"]),
+ ("\u{2c}\u{308}\u{41}", &["\u{2c}\u{308}\u{41}"]), ("\u{2c}\u{1bb}", &["\u{2c}\u{1bb}"]),
+ ("\u{2c}\u{308}\u{1bb}", &["\u{2c}\u{308}\u{1bb}"]), ("\u{2c}\u{30}", &["\u{2c}\u{30}"]),
+ ("\u{2c}\u{308}\u{30}", &["\u{2c}\u{308}\u{30}"]), ("\u{2c}\u{2e}", &["\u{2c}\u{2e}"]),
+ ("\u{2c}\u{308}\u{2e}", &["\u{2c}\u{308}\u{2e}"]), ("\u{2c}\u{21}", &["\u{2c}\u{21}"]),
+ ("\u{2c}\u{308}\u{21}", &["\u{2c}\u{308}\u{21}"]), ("\u{2c}\u{22}", &["\u{2c}\u{22}"]),
+ ("\u{2c}\u{308}\u{22}", &["\u{2c}\u{308}\u{22}"]), ("\u{2c}\u{2c}", &["\u{2c}\u{2c}"]),
+ ("\u{2c}\u{308}\u{2c}", &["\u{2c}\u{308}\u{2c}"]), ("\u{2c}\u{ad}", &["\u{2c}\u{ad}"]),
+ ("\u{2c}\u{308}\u{ad}", &["\u{2c}\u{308}\u{ad}"]), ("\u{2c}\u{300}", &["\u{2c}\u{300}"]),
+ ("\u{2c}\u{308}\u{300}", &["\u{2c}\u{308}\u{300}"]), ("\u{ad}\u{1}", &["\u{ad}\u{1}"]),
+ ("\u{ad}\u{308}\u{1}", &["\u{ad}\u{308}\u{1}"]), ("\u{ad}\u{d}", &["\u{ad}\u{d}"]),
+ ("\u{ad}\u{308}\u{d}", &["\u{ad}\u{308}\u{d}"]), ("\u{ad}\u{a}", &["\u{ad}\u{a}"]),
+ ("\u{ad}\u{308}\u{a}", &["\u{ad}\u{308}\u{a}"]), ("\u{ad}\u{85}", &["\u{ad}\u{85}"]),
+ ("\u{ad}\u{308}\u{85}", &["\u{ad}\u{308}\u{85}"]), ("\u{ad}\u{9}", &["\u{ad}\u{9}"]),
+ ("\u{ad}\u{308}\u{9}", &["\u{ad}\u{308}\u{9}"]), ("\u{ad}\u{61}", &["\u{ad}\u{61}"]),
+ ("\u{ad}\u{308}\u{61}", &["\u{ad}\u{308}\u{61}"]), ("\u{ad}\u{41}", &["\u{ad}\u{41}"]),
+ ("\u{ad}\u{308}\u{41}", &["\u{ad}\u{308}\u{41}"]), ("\u{ad}\u{1bb}", &["\u{ad}\u{1bb}"]),
+ ("\u{ad}\u{308}\u{1bb}", &["\u{ad}\u{308}\u{1bb}"]), ("\u{ad}\u{30}", &["\u{ad}\u{30}"]),
+ ("\u{ad}\u{308}\u{30}", &["\u{ad}\u{308}\u{30}"]), ("\u{ad}\u{2e}", &["\u{ad}\u{2e}"]),
+ ("\u{ad}\u{308}\u{2e}", &["\u{ad}\u{308}\u{2e}"]), ("\u{ad}\u{21}", &["\u{ad}\u{21}"]),
+ ("\u{ad}\u{308}\u{21}", &["\u{ad}\u{308}\u{21}"]), ("\u{ad}\u{22}", &["\u{ad}\u{22}"]),
+ ("\u{ad}\u{308}\u{22}", &["\u{ad}\u{308}\u{22}"]), ("\u{ad}\u{2c}", &["\u{ad}\u{2c}"]),
+ ("\u{ad}\u{308}\u{2c}", &["\u{ad}\u{308}\u{2c}"]), ("\u{ad}\u{ad}", &["\u{ad}\u{ad}"]),
+ ("\u{ad}\u{308}\u{ad}", &["\u{ad}\u{308}\u{ad}"]), ("\u{ad}\u{300}", &["\u{ad}\u{300}"]),
+ ("\u{ad}\u{308}\u{300}", &["\u{ad}\u{308}\u{300}"]), ("\u{300}\u{1}", &["\u{300}\u{1}"]),
+ ("\u{300}\u{308}\u{1}", &["\u{300}\u{308}\u{1}"]), ("\u{300}\u{d}", &["\u{300}\u{d}"]),
+ ("\u{300}\u{308}\u{d}", &["\u{300}\u{308}\u{d}"]), ("\u{300}\u{a}", &["\u{300}\u{a}"]),
+ ("\u{300}\u{308}\u{a}", &["\u{300}\u{308}\u{a}"]), ("\u{300}\u{85}", &["\u{300}\u{85}"]),
+ ("\u{300}\u{308}\u{85}", &["\u{300}\u{308}\u{85}"]), ("\u{300}\u{9}", &["\u{300}\u{9}"]),
+ ("\u{300}\u{308}\u{9}", &["\u{300}\u{308}\u{9}"]), ("\u{300}\u{61}", &["\u{300}\u{61}"]),
+ ("\u{300}\u{308}\u{61}", &["\u{300}\u{308}\u{61}"]), ("\u{300}\u{41}", &["\u{300}\u{41}"]),
+ ("\u{300}\u{308}\u{41}", &["\u{300}\u{308}\u{41}"]), ("\u{300}\u{1bb}",
+ &["\u{300}\u{1bb}"]), ("\u{300}\u{308}\u{1bb}", &["\u{300}\u{308}\u{1bb}"]),
+ ("\u{300}\u{30}", &["\u{300}\u{30}"]), ("\u{300}\u{308}\u{30}", &["\u{300}\u{308}\u{30}"]),
+ ("\u{300}\u{2e}", &["\u{300}\u{2e}"]), ("\u{300}\u{308}\u{2e}", &["\u{300}\u{308}\u{2e}"]),
+ ("\u{300}\u{21}", &["\u{300}\u{21}"]), ("\u{300}\u{308}\u{21}", &["\u{300}\u{308}\u{21}"]),
+ ("\u{300}\u{22}", &["\u{300}\u{22}"]), ("\u{300}\u{308}\u{22}", &["\u{300}\u{308}\u{22}"]),
+ ("\u{300}\u{2c}", &["\u{300}\u{2c}"]), ("\u{300}\u{308}\u{2c}", &["\u{300}\u{308}\u{2c}"]),
+ ("\u{300}\u{ad}", &["\u{300}\u{ad}"]), ("\u{300}\u{308}\u{ad}", &["\u{300}\u{308}\u{ad}"]),
+ ("\u{300}\u{300}", &["\u{300}\u{300}"]), ("\u{300}\u{308}\u{300}",
+ &["\u{300}\u{308}\u{300}"]), ("\u{d}\u{a}\u{61}\u{a}\u{308}", &["\u{d}\u{a}", "\u{61}\u{a}",
+ "\u{308}"]), ("\u{61}\u{308}", &["\u{61}\u{308}"]), ("\u{20}\u{200d}\u{646}",
+ &["\u{20}\u{200d}\u{646}"]), ("\u{646}\u{200d}\u{20}", &["\u{646}\u{200d}\u{20}"]),
+ ("\u{28}\u{22}\u{47}\u{6f}\u{2e}\u{22}\u{29}\u{20}\u{28}\u{48}\u{65}\u{20}\u{64}\u{69}\u{64}\u{2e}\u{29}",
+ &["\u{28}\u{22}\u{47}\u{6f}\u{2e}\u{22}\u{29}\u{20}",
+ "\u{28}\u{48}\u{65}\u{20}\u{64}\u{69}\u{64}\u{2e}\u{29}"]),
+ ("\u{28}\u{201c}\u{47}\u{6f}\u{3f}\u{201d}\u{29}\u{20}\u{28}\u{48}\u{65}\u{20}\u{64}\u{69}\u{64}\u{2e}\u{29}",
+ &["\u{28}\u{201c}\u{47}\u{6f}\u{3f}\u{201d}\u{29}\u{20}",
+ "\u{28}\u{48}\u{65}\u{20}\u{64}\u{69}\u{64}\u{2e}\u{29}"]),
+ ("\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{2e}\u{20}\u{69}\u{73}",
+ &["\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{2e}\u{20}\u{69}\u{73}"]),
+ ("\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{3f}\u{20}\u{48}\u{65}",
+ &["\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{3f}\u{20}", "\u{48}\u{65}"]),
+ ("\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{2e}",
+ &["\u{55}\u{2e}\u{53}\u{2e}\u{41}\u{300}\u{2e}"]), ("\u{33}\u{2e}\u{34}",
+ &["\u{33}\u{2e}\u{34}"]), ("\u{63}\u{2e}\u{64}", &["\u{63}\u{2e}\u{64}"]),
+ ("\u{43}\u{2e}\u{64}", &["\u{43}\u{2e}\u{64}"]), ("\u{63}\u{2e}\u{44}",
+ &["\u{63}\u{2e}\u{44}"]), ("\u{43}\u{2e}\u{44}", &["\u{43}\u{2e}\u{44}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{74}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{74}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{54}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}", "\u{54}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{2018}\u{28}\u{74}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{2018}\u{28}\u{74}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{2018}\u{28}\u{54}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}", "\u{2018}\u{28}\u{54}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{308}\u{74}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{308}\u{74}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{308}\u{54}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{a0}\u{308}", "\u{54}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{308}\u{54}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{2019}\u{308}", "\u{54}\u{68}\u{65}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{29}\u{a}\u{308}\u{54}\u{68}\u{65}",
+ &["\u{65}\u{74}\u{63}\u{2e}\u{29}\u{a}", "\u{308}\u{54}\u{68}\u{65}"]),
+ ("\u{74}\u{68}\u{65}\u{20}\u{72}\u{65}\u{73}\u{70}\u{2e}\u{20}\u{6c}\u{65}\u{61}\u{64}\u{65}\u{72}\u{73}\u{20}\u{61}\u{72}\u{65}",
+ &["\u{74}\u{68}\u{65}\u{20}\u{72}\u{65}\u{73}\u{70}\u{2e}\u{20}\u{6c}\u{65}\u{61}\u{64}\u{65}\u{72}\u{73}\u{20}\u{61}\u{72}\u{65}"]),
+ ("\u{5b57}\u{2e}\u{5b57}", &["\u{5b57}\u{2e}", "\u{5b57}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{5b83}", &["\u{65}\u{74}\u{63}\u{2e}", "\u{5b83}"]),
+ ("\u{65}\u{74}\u{63}\u{2e}\u{3002}", &["\u{65}\u{74}\u{63}\u{2e}\u{3002}"]),
+ ("\u{5b57}\u{3002}\u{5b83}", &["\u{5b57}\u{3002}", "\u{5b83}"]), ("\u{21}\u{20}\u{20}",
+ &["\u{21}\u{20}\u{20}"]),
+ ("\u{2060}\u{28}\u{2060}\u{22}\u{2060}\u{47}\u{2060}\u{6f}\u{2060}\u{2e}\u{2060}\u{22}\u{2060}\u{29}\u{2060}\u{20}\u{2060}\u{28}\u{2060}\u{48}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{64}\u{2060}\u{69}\u{2060}\u{64}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2060}",
+ &["\u{2060}\u{28}\u{2060}\u{22}\u{2060}\u{47}\u{2060}\u{6f}\u{2060}\u{2e}\u{2060}\u{22}\u{2060}\u{29}\u{2060}\u{20}\u{2060}",
+ "\u{28}\u{2060}\u{48}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{64}\u{2060}\u{69}\u{2060}\u{64}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{28}\u{2060}\u{201c}\u{2060}\u{47}\u{2060}\u{6f}\u{2060}\u{3f}\u{2060}\u{201d}\u{2060}\u{29}\u{2060}\u{20}\u{2060}\u{28}\u{2060}\u{48}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{64}\u{2060}\u{69}\u{2060}\u{64}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2060}",
+ &["\u{2060}\u{28}\u{2060}\u{201c}\u{2060}\u{47}\u{2060}\u{6f}\u{2060}\u{3f}\u{2060}\u{201d}\u{2060}\u{29}\u{2060}\u{20}\u{2060}",
+ "\u{28}\u{2060}\u{48}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{64}\u{2060}\u{69}\u{2060}\u{64}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{2e}\u{2060}\u{20}\u{2060}\u{69}\u{2060}\u{73}\u{2060}\u{2060}",
+ &["\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{2e}\u{2060}\u{20}\u{2060}\u{69}\u{2060}\u{73}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{3f}\u{2060}\u{20}\u{2060}\u{48}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{3f}\u{2060}\u{20}\u{2060}",
+ "\u{48}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{2e}\u{2060}\u{2060}",
+ &["\u{2060}\u{55}\u{2060}\u{2e}\u{2060}\u{53}\u{2060}\u{2e}\u{2060}\u{41}\u{2060}\u{300}\u{2e}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{33}\u{2060}\u{2e}\u{2060}\u{34}\u{2060}\u{2060}",
+ &["\u{2060}\u{33}\u{2060}\u{2e}\u{2060}\u{34}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{64}\u{2060}\u{2060}",
+ &["\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{64}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{43}\u{2060}\u{2e}\u{2060}\u{64}\u{2060}\u{2060}",
+ &["\u{2060}\u{43}\u{2060}\u{2e}\u{2060}\u{64}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{44}\u{2060}\u{2060}",
+ &["\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{44}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{43}\u{2060}\u{2e}\u{2060}\u{44}\u{2060}\u{2060}",
+ &["\u{2060}\u{43}\u{2060}\u{2e}\u{2060}\u{44}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}",
+ "\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{2018}\u{2060}\u{28}\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{2018}\u{2060}\u{28}\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{2018}\u{2060}\u{28}\u{2060}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}",
+ "\u{2018}\u{2060}\u{28}\u{2060}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{308}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{308}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{308}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{a0}\u{2060}\u{308}",
+ "\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{308}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{2019}\u{2060}\u{308}",
+ "\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{a}\u{2060}\u{308}\u{2060}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{29}\u{2060}\u{a}",
+ "\u{2060}\u{308}\u{2060}\u{54}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{72}\u{2060}\u{65}\u{2060}\u{73}\u{2060}\u{70}\u{2060}\u{2e}\u{2060}\u{20}\u{2060}\u{6c}\u{2060}\u{65}\u{2060}\u{61}\u{2060}\u{64}\u{2060}\u{65}\u{2060}\u{72}\u{2060}\u{73}\u{2060}\u{20}\u{2060}\u{61}\u{2060}\u{72}\u{2060}\u{65}\u{2060}\u{2060}",
+ &["\u{2060}\u{74}\u{2060}\u{68}\u{2060}\u{65}\u{2060}\u{20}\u{2060}\u{72}\u{2060}\u{65}\u{2060}\u{73}\u{2060}\u{70}\u{2060}\u{2e}\u{2060}\u{20}\u{2060}\u{6c}\u{2060}\u{65}\u{2060}\u{61}\u{2060}\u{64}\u{2060}\u{65}\u{2060}\u{72}\u{2060}\u{73}\u{2060}\u{20}\u{2060}\u{61}\u{2060}\u{72}\u{2060}\u{65}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{5b57}\u{2060}\u{2e}\u{2060}\u{5b57}\u{2060}\u{2060}",
+ &["\u{2060}\u{5b57}\u{2060}\u{2e}\u{2060}", "\u{5b57}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{5b83}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}",
+ "\u{5b83}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{3002}\u{2060}\u{2060}",
+ &["\u{2060}\u{65}\u{2060}\u{74}\u{2060}\u{63}\u{2060}\u{2e}\u{2060}\u{3002}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{5b57}\u{2060}\u{3002}\u{2060}\u{5b83}\u{2060}\u{2060}",
+ &["\u{2060}\u{5b57}\u{2060}\u{3002}\u{2060}", "\u{5b83}\u{2060}\u{2060}"]),
+ ("\u{2060}\u{21}\u{2060}\u{20}\u{2060}\u{20}\u{2060}\u{2060}",
+ &["\u{2060}\u{21}\u{2060}\u{20}\u{2060}\u{20}\u{2060}\u{2060}"])
+ ];
diff --git a/crates/unicode-segmentation/src/word.rs b/crates/unicode-segmentation/src/word.rs
new file mode 100644
index 0000000..16dfafd
--- /dev/null
+++ b/crates/unicode-segmentation/src/word.rs
@@ -0,0 +1,754 @@
+// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use core::cmp;
+use core::iter::Filter;
+
+use crate::tables::word::WordCat;
+
+/// An iterator over the substrings of a string which, after splitting the string on
+/// [word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries),
+/// contain any characters with the
+/// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+/// property, or with
+/// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+///
+/// This struct is created by the [`unicode_words`] method on the [`UnicodeSegmentation`] trait. See
+/// its documentation for more.
+///
+/// [`unicode_words`]: trait.UnicodeSegmentation.html#tymethod.unicode_words
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+pub struct UnicodeWords<'a> {
+ inner: Filter<UWordBounds<'a>, fn(&&str) -> bool>,
+}
+
+impl<'a> Iterator for UnicodeWords<'a> {
+ type Item = &'a str;
+
+ #[inline]
+ fn next(&mut self) -> Option<&'a str> {
+ self.inner.next()
+ }
+}
+impl<'a> DoubleEndedIterator for UnicodeWords<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<&'a str> {
+ self.inner.next_back()
+ }
+}
+
+/// An iterator over the substrings of a string which, after splitting the string on
+/// [word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries),
+/// contain any characters with the
+/// [Alphabetic](http://unicode.org/reports/tr44/#Alphabetic)
+/// property, or with
+/// [General_Category=Number](http://unicode.org/reports/tr44/#General_Category_Values).
+/// This iterator also provides the byte offsets for each substring.
+///
+/// This struct is created by the [`unicode_word_indices`] method on the [`UnicodeSegmentation`] trait. See
+/// its documentation for more.
+///
+/// [`unicode_word_indices`]: trait.UnicodeSegmentation.html#tymethod.unicode_word_indices
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+pub struct UnicodeWordIndices<'a> {
+ inner: Filter<UWordBoundIndices<'a>, fn(&(usize, &str)) -> bool>,
+}
+
+impl<'a> Iterator for UnicodeWordIndices<'a> {
+ type Item = (usize, &'a str);
+
+ #[inline]
+ fn next(&mut self) -> Option<(usize, &'a str)> {
+ self.inner.next()
+ }
+}
+impl<'a> DoubleEndedIterator for UnicodeWordIndices<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<(usize, &'a str)> {
+ self.inner.next_back()
+ }
+}
+
+/// External iterator for a string's
+/// [word boundaries](http://www.unicode.org/reports/tr29/#Word_Boundaries).
+///
+/// This struct is created by the [`split_word_bounds`] method on the [`UnicodeSegmentation`]
+/// trait. See its documentation for more.
+///
+/// [`split_word_bounds`]: trait.UnicodeSegmentation.html#tymethod.split_word_bounds
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct UWordBounds<'a> {
+ string: &'a str,
+ cat: Option<WordCat>,
+ catb: Option<WordCat>,
+}
+
+/// External iterator for word boundaries and byte offsets.
+///
+/// This struct is created by the [`split_word_bound_indices`] method on the
+/// [`UnicodeSegmentation`] trait. See its documentation for more.
+///
+/// [`split_word_bound_indices`]: trait.UnicodeSegmentation.html#tymethod.split_word_bound_indices
+/// [`UnicodeSegmentation`]: trait.UnicodeSegmentation.html
+#[derive(Clone)]
+pub struct UWordBoundIndices<'a> {
+ start_offset: usize,
+ iter: UWordBounds<'a>,
+}
+
+impl<'a> UWordBoundIndices<'a> {
+ #[inline]
+ /// View the underlying data (the part yet to be iterated) as a slice of the original string.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::UnicodeSegmentation;
+ /// let mut iter = "Hello world".split_word_bound_indices();
+ /// assert_eq!(iter.as_str(), "Hello world");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), " world");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "world");
+ /// ```
+ pub fn as_str(&self) -> &'a str {
+ self.iter.as_str()
+ }
+}
+
+impl<'a> Iterator for UWordBoundIndices<'a> {
+ type Item = (usize, &'a str);
+
+ #[inline]
+ fn next(&mut self) -> Option<(usize, &'a str)> {
+ self.iter
+ .next()
+ .map(|s| (s.as_ptr() as usize - self.start_offset, s))
+ }
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.iter.size_hint()
+ }
+}
+
+impl<'a> DoubleEndedIterator for UWordBoundIndices<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<(usize, &'a str)> {
+ self.iter
+ .next_back()
+ .map(|s| (s.as_ptr() as usize - self.start_offset, s))
+ }
+}
+
+// state machine for word boundary rules
+#[derive(Clone, Copy, PartialEq, Eq, Debug)]
+enum UWordBoundsState {
+ Start,
+ Letter,
+ HLetter,
+ Numeric,
+ Katakana,
+ ExtendNumLet,
+ Regional(RegionalState),
+ FormatExtend(FormatExtendType),
+ Zwj,
+ Emoji,
+ WSegSpace,
+}
+
+// subtypes for FormatExtend state in UWordBoundsState
+#[derive(Clone, Copy, PartialEq, Eq, Debug)]
+enum FormatExtendType {
+ AcceptAny,
+ AcceptNone,
+ RequireLetter,
+ RequireHLetter,
+ AcceptQLetter,
+ RequireNumeric,
+}
+
+#[derive(Clone, Copy, PartialEq, Eq, Debug)]
+enum RegionalState {
+ Half,
+ Full,
+ Unknown,
+}
+
+fn is_emoji(ch: char) -> bool {
+ use crate::tables::emoji;
+ emoji::emoji_category(ch).2 == emoji::EmojiCat::EC_Extended_Pictographic
+}
+
+impl<'a> Iterator for UWordBounds<'a> {
+ type Item = &'a str;
+
+ #[inline]
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ let slen = self.string.len();
+ (cmp::min(slen, 1), Some(slen))
+ }
+
+ #[inline]
+ fn next(&mut self) -> Option<&'a str> {
+ use self::FormatExtendType::*;
+ use self::UWordBoundsState::*;
+ use crate::tables::word as wd;
+ if self.string.len() == 0 {
+ return None;
+ }
+
+ let mut take_curr = true;
+ let mut take_cat = true;
+ let mut idx = 0;
+ let mut saveidx = 0;
+ let mut state = Start;
+ let mut cat = wd::WC_Any;
+ let mut savecat = wd::WC_Any;
+
+ // If extend/format/zwj were skipped. Handles precedence of WB3d over WB4
+ let mut skipped_format_extend = false;
+ for (curr, ch) in self.string.char_indices() {
+ idx = curr;
+ // Whether or not the previous category was ZWJ
+ // ZWJs get collapsed, so this handles precedence of WB3c over WB4
+ let prev_zwj = cat == wd::WC_ZWJ;
+ // if there's a category cached, grab it
+ cat = match self.cat {
+ None => wd::word_category(ch).2,
+ _ => self.cat.take().unwrap(),
+ };
+ take_cat = true;
+
+ // handle rule WB4
+ // just skip all format, extend, and zwj chars
+ // note that Start is a special case: if there's a bunch of Format | Extend
+ // characters at the beginning of a block of text, dump them out as one unit.
+ //
+ // (This is not obvious from the wording of UAX#29, but if you look at the
+ // test cases http://www.unicode.org/Public/UNIDATA/auxiliary/WordBreakTest.txt
+ // then the "correct" interpretation of WB4 becomes apparent.)
+ if state != Start {
+ match cat {
+ wd::WC_Extend | wd::WC_Format | wd::WC_ZWJ => {
+ skipped_format_extend = true;
+ continue;
+ }
+ _ => {}
+ }
+ }
+
+ // rule WB3c
+ // WB4 makes all ZWJs collapse into the previous state
+ // but you can still be in a Zwj state if you started with Zwj
+ //
+ // This means that an EP + Zwj will collapse into EP, which is wrong,
+ // since EP+EP is not a boundary but EP+ZWJ+EP is
+ //
+ // Thus, we separately keep track of whether or not the last character
+ // was a ZWJ. This is an additional bit of state tracked outside of the
+ // state enum; the state enum represents the last non-zwj state encountered.
+ // When prev_zwj is true, for the purposes of WB3c, we are in the Zwj state,
+ // however we are in the previous state for the purposes of all other rules.
+ if prev_zwj {
+ if is_emoji(ch) {
+ state = Emoji;
+ continue;
+ }
+ }
+ // Don't use `continue` in this match without updating `cat`
+ state = match state {
+ Start if cat == wd::WC_CR => {
+ idx += match self.get_next_cat(idx) {
+ Some(ncat) if ncat == wd::WC_LF => 1, // rule WB3
+ _ => 0,
+ };
+ break; // rule WB3a
+ }
+ Start => match cat {
+ wd::WC_ALetter => Letter, // rule WB5, WB6, WB9, WB13a
+ wd::WC_Hebrew_Letter => HLetter, // rule WB5, WB6, WB7a, WB7b, WB9, WB13a
+ wd::WC_Numeric => Numeric, // rule WB8, WB10, WB12, WB13a
+ wd::WC_Katakana => Katakana, // rule WB13, WB13a
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a, WB13b
+ wd::WC_Regional_Indicator => Regional(RegionalState::Half), // rule WB13c
+ wd::WC_LF | wd::WC_Newline => break, // rule WB3a
+ wd::WC_ZWJ => Zwj, // rule WB3c
+ wd::WC_WSegSpace => WSegSpace, // rule WB3d
+ _ => {
+ if let Some(ncat) = self.get_next_cat(idx) {
+ // rule WB4
+ if ncat == wd::WC_Format || ncat == wd::WC_Extend || ncat == wd::WC_ZWJ
+ {
+ state = FormatExtend(AcceptNone);
+ self.cat = Some(ncat);
+ continue;
+ }
+ }
+ break; // rule WB999
+ }
+ },
+ WSegSpace => match cat {
+ wd::WC_WSegSpace if !skipped_format_extend => WSegSpace,
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Zwj => {
+ // We already handle WB3c above.
+ take_curr = false;
+ break;
+ }
+ Letter | HLetter => match cat {
+ wd::WC_ALetter => Letter, // rule WB5
+ wd::WC_Hebrew_Letter => HLetter, // rule WB5
+ wd::WC_Numeric => Numeric, // rule WB9
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ wd::WC_Double_Quote if state == HLetter => {
+ savecat = cat;
+ saveidx = idx;
+ FormatExtend(RequireHLetter) // rule WB7b
+ }
+ wd::WC_Single_Quote if state == HLetter => {
+ FormatExtend(AcceptQLetter) // rule WB7a
+ }
+ wd::WC_MidLetter | wd::WC_MidNumLet | wd::WC_Single_Quote => {
+ savecat = cat;
+ saveidx = idx;
+ FormatExtend(RequireLetter) // rule WB6
+ }
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Numeric => match cat {
+ wd::WC_Numeric => Numeric, // rule WB8
+ wd::WC_ALetter => Letter, // rule WB10
+ wd::WC_Hebrew_Letter => HLetter, // rule WB10
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ wd::WC_MidNum | wd::WC_MidNumLet | wd::WC_Single_Quote => {
+ savecat = cat;
+ saveidx = idx;
+ FormatExtend(RequireNumeric) // rule WB12
+ }
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Katakana => match cat {
+ wd::WC_Katakana => Katakana, // rule WB13
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ ExtendNumLet => match cat {
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ wd::WC_ALetter => Letter, // rule WB13b
+ wd::WC_Hebrew_Letter => HLetter, // rule WB13b
+ wd::WC_Numeric => Numeric, // rule WB13b
+ wd::WC_Katakana => Katakana, // rule WB13b
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Regional(RegionalState::Full) => {
+ // if it reaches here we've gone too far,
+ // a full flag can only compose with ZWJ/Extend/Format
+ // proceeding it.
+ take_curr = false;
+ break;
+ }
+ Regional(RegionalState::Half) => match cat {
+ wd::WC_Regional_Indicator => Regional(RegionalState::Full), // rule WB13c
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Regional(_) => {
+ unreachable!("RegionalState::Unknown should not occur on forward iteration")
+ }
+ Emoji => {
+ // We already handle WB3c above. If you've reached this point, the emoji sequence is over.
+ take_curr = false;
+ break;
+ }
+ FormatExtend(t) => match t {
+ // handle FormatExtends depending on what type
+ RequireNumeric if cat == wd::WC_Numeric => Numeric, // rule WB11
+ RequireLetter | AcceptQLetter if cat == wd::WC_ALetter => Letter, // rule WB7
+ RequireLetter | AcceptQLetter if cat == wd::WC_Hebrew_Letter => HLetter, // WB7a
+ RequireHLetter if cat == wd::WC_Hebrew_Letter => HLetter, // rule WB7b
+ AcceptNone | AcceptQLetter => {
+ take_curr = false; // emit all the Format|Extend characters
+ take_cat = false;
+ break;
+ }
+ _ => break, // rewind (in if statement below)
+ },
+ }
+ }
+
+ if let FormatExtend(t) = state {
+ // we were looking for something and didn't find it; we have to back up
+ if t == RequireLetter || t == RequireHLetter || t == RequireNumeric {
+ idx = saveidx;
+ cat = savecat;
+ take_curr = false;
+ }
+ }
+
+ self.cat = if take_curr {
+ idx = idx + self.string[idx..].chars().next().unwrap().len_utf8();
+ None
+ } else if take_cat {
+ Some(cat)
+ } else {
+ None
+ };
+
+ let retstr = &self.string[..idx];
+ self.string = &self.string[idx..];
+ Some(retstr)
+ }
+}
+
+impl<'a> DoubleEndedIterator for UWordBounds<'a> {
+ #[inline]
+ fn next_back(&mut self) -> Option<&'a str> {
+ use self::FormatExtendType::*;
+ use self::UWordBoundsState::*;
+ use crate::tables::word as wd;
+ if self.string.len() == 0 {
+ return None;
+ }
+
+ let mut take_curr = true;
+ let mut take_cat = true;
+ let mut idx = self.string.len();
+ idx -= self.string.chars().next_back().unwrap().len_utf8();
+ let mut previdx = idx;
+ let mut saveidx = idx;
+ let mut state = Start;
+ let mut savestate = Start;
+ let mut cat = wd::WC_Any;
+
+ let mut skipped_format_extend = false;
+
+ for (curr, ch) in self.string.char_indices().rev() {
+ previdx = idx;
+ idx = curr;
+
+ // if there's a category cached, grab it
+ cat = match self.catb {
+ None => wd::word_category(ch).2,
+ _ => self.catb.take().unwrap(),
+ };
+ take_cat = true;
+
+ // backward iterator over word boundaries. Mostly the same as the forward
+ // iterator, with two weirdnesses:
+ // (1) If we encounter a single quote in the Start state, we have to check for a
+ // Hebrew Letter immediately before it.
+ // (2) Format and Extend char handling takes some gymnastics.
+
+ if cat == wd::WC_Extend || cat == wd::WC_Format || (cat == wd::WC_ZWJ && state != Zwj) {
+ // WB3c has more priority so we should not
+ // fold in that case
+ if match state {
+ FormatExtend(_) | Start => false,
+ _ => true,
+ } {
+ saveidx = previdx;
+ savestate = state;
+ state = FormatExtend(AcceptNone);
+ }
+
+ if state != Start {
+ continue;
+ }
+ } else if state == FormatExtend(AcceptNone) {
+ // finished a scan of some Format|Extend chars, restore previous state
+ state = savestate;
+ previdx = saveidx;
+ take_cat = false;
+ skipped_format_extend = true;
+ }
+
+ // Don't use `continue` in this match without updating `catb`
+ state = match state {
+ Start | FormatExtend(AcceptAny) => match cat {
+ _ if is_emoji(ch) => Zwj,
+ wd::WC_ALetter => Letter, // rule WB5, WB7, WB10, WB13b
+ wd::WC_Hebrew_Letter => HLetter, // rule WB5, WB7, WB7c, WB10, WB13b
+ wd::WC_Numeric => Numeric, // rule WB8, WB9, WB11, WB13b
+ wd::WC_Katakana => Katakana, // rule WB13, WB13b
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ wd::WC_Regional_Indicator => Regional(RegionalState::Unknown), // rule WB13c
+ // rule WB4:
+ wd::WC_Extend | wd::WC_Format | wd::WC_ZWJ => FormatExtend(AcceptAny),
+ wd::WC_Single_Quote => {
+ saveidx = idx;
+ FormatExtend(AcceptQLetter) // rule WB7a
+ }
+ wd::WC_WSegSpace => WSegSpace,
+ wd::WC_CR | wd::WC_LF | wd::WC_Newline => {
+ if state == Start {
+ if cat == wd::WC_LF {
+ idx -= match self.get_prev_cat(idx) {
+ Some(pcat) if pcat == wd::WC_CR => 1, // rule WB3
+ _ => 0,
+ };
+ }
+ } else {
+ take_curr = false;
+ }
+ break; // rule WB3a
+ }
+ _ => break, // rule WB999
+ },
+ Zwj => match cat {
+ // rule WB3c
+ wd::WC_ZWJ => FormatExtend(AcceptAny),
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ WSegSpace => match cat {
+ // rule WB3d
+ wd::WC_WSegSpace if !skipped_format_extend => WSegSpace,
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Letter | HLetter => match cat {
+ wd::WC_ALetter => Letter, // rule WB5
+ wd::WC_Hebrew_Letter => HLetter, // rule WB5
+ wd::WC_Numeric => Numeric, // rule WB10
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13b
+ wd::WC_Double_Quote if state == HLetter => {
+ saveidx = previdx;
+ FormatExtend(RequireHLetter) // rule WB7c
+ }
+ wd::WC_MidLetter | wd::WC_MidNumLet | wd::WC_Single_Quote => {
+ saveidx = previdx;
+ FormatExtend(RequireLetter) // rule WB7
+ }
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Numeric => match cat {
+ wd::WC_Numeric => Numeric, // rule WB8
+ wd::WC_ALetter => Letter, // rule WB9
+ wd::WC_Hebrew_Letter => HLetter, // rule WB9
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13b
+ wd::WC_MidNum | wd::WC_MidNumLet | wd::WC_Single_Quote => {
+ saveidx = previdx;
+ FormatExtend(RequireNumeric) // rule WB11
+ }
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Katakana => match cat {
+ wd::WC_Katakana => Katakana, // rule WB13
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13b
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ ExtendNumLet => match cat {
+ wd::WC_ExtendNumLet => ExtendNumLet, // rule WB13a
+ wd::WC_ALetter => Letter, // rule WB13a
+ wd::WC_Hebrew_Letter => HLetter, // rule WB13a
+ wd::WC_Numeric => Numeric, // rule WB13a
+ wd::WC_Katakana => Katakana, // rule WB13a
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Regional(mut regional_state) => match cat {
+ // rule WB13c
+ wd::WC_Regional_Indicator => {
+ if regional_state == RegionalState::Unknown {
+ let count = self.string[..previdx]
+ .chars()
+ .rev()
+ .map(|c| wd::word_category(c).2)
+ .filter(|&c| {
+ !(c == wd::WC_ZWJ || c == wd::WC_Extend || c == wd::WC_Format)
+ })
+ .take_while(|&c| c == wd::WC_Regional_Indicator)
+ .count();
+ regional_state = if count % 2 == 0 {
+ RegionalState::Full
+ } else {
+ RegionalState::Half
+ };
+ }
+ if regional_state == RegionalState::Full {
+ take_curr = false;
+ break;
+ } else {
+ Regional(RegionalState::Full)
+ }
+ }
+ _ => {
+ take_curr = false;
+ break;
+ }
+ },
+ Emoji => {
+ if is_emoji(ch) {
+ // rule WB3c
+ Zwj
+ } else {
+ take_curr = false;
+ break;
+ }
+ }
+ FormatExtend(t) => match t {
+ RequireNumeric if cat == wd::WC_Numeric => Numeric, // rule WB12
+ RequireLetter if cat == wd::WC_ALetter => Letter, // rule WB6
+ RequireLetter if cat == wd::WC_Hebrew_Letter => HLetter, // rule WB6
+ AcceptQLetter if cat == wd::WC_Hebrew_Letter => HLetter, // rule WB7a
+ RequireHLetter if cat == wd::WC_Hebrew_Letter => HLetter, // rule WB7b
+ _ => break, // backtrack will happens
+ },
+ }
+ }
+
+ if let FormatExtend(t) = state {
+ // if we required something but didn't find it, backtrack
+ if t == RequireLetter
+ || t == RequireHLetter
+ || t == RequireNumeric
+ || t == AcceptNone
+ || t == AcceptQLetter
+ {
+ previdx = saveidx;
+ take_cat = false;
+ take_curr = false;
+ }
+ }
+
+ self.catb = if take_curr {
+ None
+ } else {
+ idx = previdx;
+ if take_cat {
+ Some(cat)
+ } else {
+ None
+ }
+ };
+
+ let retstr = &self.string[idx..];
+ self.string = &self.string[..idx];
+ Some(retstr)
+ }
+}
+
+impl<'a> UWordBounds<'a> {
+ #[inline]
+ /// View the underlying data (the part yet to be iterated) as a slice of the original string.
+ ///
+ /// ```rust
+ /// # use unicode_segmentation::UnicodeSegmentation;
+ /// let mut iter = "Hello world".split_word_bounds();
+ /// assert_eq!(iter.as_str(), "Hello world");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), " world");
+ /// iter.next();
+ /// assert_eq!(iter.as_str(), "world");
+ /// ```
+ pub fn as_str(&self) -> &'a str {
+ self.string
+ }
+
+ #[inline]
+ fn get_next_cat(&self, idx: usize) -> Option<WordCat> {
+ use crate::tables::word as wd;
+ let nidx = idx + self.string[idx..].chars().next().unwrap().len_utf8();
+ if nidx < self.string.len() {
+ let nch = self.string[nidx..].chars().next().unwrap();
+ Some(wd::word_category(nch).2)
+ } else {
+ None
+ }
+ }
+
+ #[inline]
+ fn get_prev_cat(&self, idx: usize) -> Option<WordCat> {
+ use crate::tables::word as wd;
+ if idx > 0 {
+ let nch = self.string[..idx].chars().next_back().unwrap();
+ Some(wd::word_category(nch).2)
+ } else {
+ None
+ }
+ }
+}
+
+#[inline]
+pub fn new_word_bounds<'b>(s: &'b str) -> UWordBounds<'b> {
+ UWordBounds {
+ string: s,
+ cat: None,
+ catb: None,
+ }
+}
+
+#[inline]
+pub fn new_word_bound_indices<'b>(s: &'b str) -> UWordBoundIndices<'b> {
+ UWordBoundIndices {
+ start_offset: s.as_ptr() as usize,
+ iter: new_word_bounds(s),
+ }
+}
+
+#[inline]
+fn has_alphanumeric(s: &&str) -> bool {
+ use crate::tables::util::is_alphanumeric;
+
+ s.chars().any(|c| is_alphanumeric(c))
+}
+
+#[inline]
+pub fn new_unicode_words<'b>(s: &'b str) -> UnicodeWords<'b> {
+ use super::UnicodeSegmentation;
+
+ UnicodeWords {
+ inner: s.split_word_bounds().filter(has_alphanumeric),
+ }
+}
+
+#[inline]
+pub fn new_unicode_word_indices<'b>(s: &'b str) -> UnicodeWordIndices<'b> {
+ use super::UnicodeSegmentation;
+
+ UnicodeWordIndices {
+ inner: s
+ .split_word_bound_indices()
+ .filter(|(_, c)| has_alphanumeric(c)),
+ }
+}
diff --git a/crates/unicode-width/.cargo-checksum.json b/crates/unicode-width/.cargo-checksum.json
new file mode 100644
index 0000000..c1608bd
--- /dev/null
+++ b/crates/unicode-width/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"COPYRIGHT":"23860c2a7b5d96b21569afedf033469bab9fe14a1b24a35068b8641c578ce24d","Cargo.toml":"09233bddd9dcdd71355ad523e7293bc8764bb96f891e8968bea9b8aaf86ed314","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"7b63ecd5f1902af1b63729947373683c32745c16a10e8e6292e2e2dcd7e90ae0","README.md":"8a041a4305fb318f5c2cb284046f8480796521d0e829023b0441b5e8469490eb","scripts/unicode.py":"d7884ff41ca9c54cbe97a8f9c909b0a8cd74bc8e6190b0c89bf3001a38d9d763","src/lib.rs":"baa30ab3913bde7d8e766a2fbccfda96f06dd499bebda899249fc7495d5ad6f7","src/tables.rs":"7201dff937e3b0f61f4fcad9cfb230fb0c44bb9082301e566351b95d7525605e","src/tests.rs":"ff9f331210861ba78040f119a0f6ccfacf5b2ca1ebee430784de0858fad01860"},"package":"e51733f11c9c4f72aa0c160008246859e340b00807569a0da0e7a1079b27ba85"}
\ No newline at end of file
diff --git a/crates/unicode-width/Android.bp b/crates/unicode-width/Android.bp
new file mode 100644
index 0000000..5401a6f
--- /dev/null
+++ b/crates/unicode-width/Android.bp
@@ -0,0 +1,47 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_unicode-width_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_unicode-width_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libunicode_width",
+ host_supported: true,
+ crate_name: "unicode_width",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.11",
+ crate_root: "src/lib.rs",
+ edition: "2015",
+ features: ["default"],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "unicode-width_test_src_lib",
+ host_supported: true,
+ crate_name: "unicode_width",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.1.11",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2015",
+ features: ["default"],
+}
diff --git a/crates/unicode-width/COPYRIGHT b/crates/unicode-width/COPYRIGHT
new file mode 100644
index 0000000..b286ec1
--- /dev/null
+++ b/crates/unicode-width/COPYRIGHT
@@ -0,0 +1,7 @@
+Licensed under the Apache License, Version 2.0
+<LICENSE-APACHE or
+http://www.apache.org/licenses/LICENSE-2.0> or the MIT
+license <LICENSE-MIT or http://opensource.org/licenses/MIT>,
+at your option. All files in the project carrying such
+notice may not be copied, modified, or distributed except
+according to those terms.
diff --git a/crates/unicode-width/Cargo.toml b/crates/unicode-width/Cargo.toml
new file mode 100644
index 0000000..6dcfacd
--- /dev/null
+++ b/crates/unicode-width/Cargo.toml
@@ -0,0 +1,60 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+name = "unicode-width"
+version = "0.1.11"
+authors = [
+ "kwantam <[email protected]>",
+ "Manish Goregaokar <[email protected]>",
+]
+exclude = [
+ "target/*",
+ "Cargo.lock",
+]
+description = """
+Determine displayed width of `char` and `str` types
+according to Unicode Standard Annex #11 rules.
+"""
+homepage = "https://github.com/unicode-rs/unicode-width"
+documentation = "https://unicode-rs.github.io/unicode-width"
+readme = "README.md"
+keywords = [
+ "text",
+ "width",
+ "unicode",
+]
+license = "MIT/Apache-2.0"
+repository = "https://github.com/unicode-rs/unicode-width"
+
+[dependencies.compiler_builtins]
+version = "0.1"
+optional = true
+
+[dependencies.core]
+version = "1.0"
+optional = true
+package = "rustc-std-workspace-core"
+
+[dependencies.std]
+version = "1.0"
+optional = true
+package = "rustc-std-workspace-std"
+
+[features]
+bench = []
+default = []
+no_std = []
+rustc-dep-of-std = [
+ "std",
+ "core",
+ "compiler_builtins",
+]
diff --git a/crates/unicode-width/LICENSE b/crates/unicode-width/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/unicode-width/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/unicode-width/LICENSE-APACHE b/crates/unicode-width/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/unicode-width/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/unicode-width/LICENSE-MIT b/crates/unicode-width/LICENSE-MIT
new file mode 100644
index 0000000..e69282e
--- /dev/null
+++ b/crates/unicode-width/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2015 The Rust Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/unicode-width/METADATA b/crates/unicode-width/METADATA
new file mode 100644
index 0000000..7f184b6
--- /dev/null
+++ b/crates/unicode-width/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/unicode-width
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "unicode-width"
+description: "Determine displayed width of `char` and `str` types according to Unicode Standard Annex #11 rules."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 5
+ }
+ homepage: "https://crates.io/crates/unicode-width"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/unicode-width/unicode-width-0.1.11.crate"
+ version: "0.1.11"
+ }
+}
diff --git a/crates/unicode-width/MODULE_LICENSE_APACHE2 b/crates/unicode-width/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/unicode-width/MODULE_LICENSE_APACHE2
diff --git a/crates/unicode-width/NOTICE b/crates/unicode-width/NOTICE
new file mode 120000
index 0000000..7a694c9
--- /dev/null
+++ b/crates/unicode-width/NOTICE
@@ -0,0 +1 @@
+LICENSE
\ No newline at end of file
diff --git a/crates/unicode-width/README.md b/crates/unicode-width/README.md
new file mode 100644
index 0000000..595e163
--- /dev/null
+++ b/crates/unicode-width/README.md
@@ -0,0 +1,58 @@
+# unicode-width
+
+Determine displayed width of `char` and `str` types according to
+[Unicode Standard Annex #11][UAX11] rules.
+
+[UAX11]: http://www.unicode.org/reports/tr11/
+
+[](https://travis-ci.org/unicode-rs/unicode-width)
+
+[Documentation](https://unicode-rs.github.io/unicode-width/unicode_width/index.html)
+
+```rust
+extern crate unicode_width;
+
+use unicode_width::UnicodeWidthStr;
+
+fn main() {
+ let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
+ let width = UnicodeWidthStr::width(teststr);
+ println!("{}", teststr);
+ println!("The above string is {} columns wide.", width);
+ let width = teststr.width_cjk();
+ println!("The above string is {} columns wide (CJK).", width);
+}
+```
+
+**NOTE:** The computed width values may not match the actual rendered column
+width. For example, the woman scientist emoji comprises of a woman emoji, a
+zero-width joiner and a microscope emoji.
+
+```rust
+extern crate unicode_width;
+use unicode_width::UnicodeWidthStr;
+
+fn main() {
+ assert_eq!(UnicodeWidthStr::width("👩"), 2); // Woman
+ assert_eq!(UnicodeWidthStr::width("🔬"), 2); // Microscope
+ assert_eq!(UnicodeWidthStr::width("👩🔬"), 4); // Woman scientist
+}
+```
+
+See [Unicode Standard Annex #11][UAX11] for precise details on what is and isn't
+covered by this crate.
+
+## features
+
+unicode-width does not depend on libstd, so it can be used in crates
+with the `#![no_std]` attribute.
+
+## crates.io
+
+You can use this package in your project by adding the following
+to your `Cargo.toml`:
+
+```toml
+[dependencies]
+unicode-width = "0.1.7"
+```
diff --git a/crates/unicode-width/TEST_MAPPING b/crates/unicode-width/TEST_MAPPING
new file mode 100644
index 0000000..3480b99
--- /dev/null
+++ b/crates/unicode-width/TEST_MAPPING
@@ -0,0 +1,27 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "packages/modules/Virtualization/virtualizationmanager"
+ },
+ {
+ "path": "system/security/diced"
+ },
+ {
+ "path": "system/security/keystore2"
+ },
+ {
+ "path": "system/security/keystore2/legacykeystore"
+ }
+ ],
+ "presubmit": [
+ {
+ "name": "unicode-width_test_src_lib"
+ }
+ ],
+ "presubmit-rust": [
+ {
+ "name": "unicode-width_test_src_lib"
+ }
+ ]
+}
diff --git a/crates/unicode-width/cargo_embargo.json b/crates/unicode-width/cargo_embargo.json
new file mode 100644
index 0000000..c8842d1
--- /dev/null
+++ b/crates/unicode-width/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/unicode-width/patches/std.diff b/crates/unicode-width/patches/std.diff
new file mode 100644
index 0000000..43da129
--- /dev/null
+++ b/crates/unicode-width/patches/std.diff
@@ -0,0 +1,13 @@
+Index: unicode-width/src/lib.rs
+===================================================================
+--- unicode-width.orig/src/lib.rs
++++ unicode-width/src/lib.rs
+@@ -49,7 +49,7 @@
+ #![cfg_attr(feature = "bench", feature(test))]
+ #![no_std]
+
+-#[cfg(test)]
++// ANDROID: Unconditionally use std to allow building as a dylib.
+ #[macro_use]
+ extern crate std;
+
diff --git a/crates/unicode-width/scripts/unicode.py b/crates/unicode-width/scripts/unicode.py
new file mode 100755
index 0000000..a6d58c5
--- /dev/null
+++ b/crates/unicode-width/scripts/unicode.py
@@ -0,0 +1,505 @@
+#!/usr/bin/env python3
+#
+# Copyright 2011-2022 The Rust Project Developers. See the COPYRIGHT
+# file at the top-level directory of this distribution and at
+# http://rust-lang.org/COPYRIGHT.
+#
+# Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+# http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+# <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+# option. This file may not be copied, modified, or distributed
+# except according to those terms.
+
+# This script uses the following Unicode tables:
+# - EastAsianWidth.txt
+# - ReadMe.txt
+# - UnicodeData.txt
+#
+# Since this should not require frequent updates, we just store this
+# out-of-line and check the generated module into git.
+
+import enum
+import math
+import os
+import re
+import sys
+
+NUM_CODEPOINTS = 0x110000
+"""An upper bound for which `range(0, NUM_CODEPOINTS)` contains Unicode's codespace."""
+
+MAX_CODEPOINT_BITS = math.ceil(math.log2(NUM_CODEPOINTS - 1))
+"""The maximum number of bits required to represent a Unicode codepoint."""
+
+
+class OffsetType(enum.IntEnum):
+ """Represents the data type of a lookup table's offsets. Each variant's value represents the
+ number of bits required to represent that variant's type."""
+
+ U2 = 2
+ """Offsets are 2-bit unsigned integers, packed four-per-byte."""
+ U4 = 4
+ """Offsets are 4-bit unsigned integers, packed two-per-byte."""
+ U8 = 8
+ """Each offset is a single byte (u8)."""
+
+
+TABLE_CFGS = [
+ (13, MAX_CODEPOINT_BITS, OffsetType.U8),
+ (6, 13, OffsetType.U8),
+ (0, 6, OffsetType.U2),
+]
+"""Represents the format of each level of the multi-level lookup table.
+A level's entry is of the form `(low_bit, cap_bit, offset_type)`.
+This means that every sub-table in that level is indexed by bits `low_bit..cap_bit` of the
+codepoint and those tables offsets are stored according to `offset_type`.
+
+If this is edited, you must ensure that `emit_module` reflects your changes."""
+
+MODULE_FILENAME = "tables.rs"
+"""The filename of the emitted Rust module (will be created in the working directory)"""
+
+Codepoint = int
+BitPos = int
+
+
+def fetch_open(filename: str):
+ """Opens `filename` and return its corresponding file object. If `filename` isn't on disk,
+ fetches it from `http://www.unicode.org/Public/UNIDATA/`. Exits with code 1 on failure."""
+ if not os.path.exists(os.path.basename(filename)):
+ os.system(f"curl -O http://www.unicode.org/Public/UNIDATA/{filename}")
+ try:
+ return open(filename, encoding="utf-8")
+ except OSError:
+ sys.stderr.write(f"cannot load {filename}")
+ sys.exit(1)
+
+
+def load_unicode_version() -> "tuple[int, int, int]":
+ """Returns the current Unicode version by fetching and processing `ReadMe.txt`."""
+ with fetch_open("ReadMe.txt") as readme:
+ pattern = r"for Version (\d+)\.(\d+)\.(\d+) of the Unicode"
+ return tuple(map(int, re.search(pattern, readme.read()).groups()))
+
+
+class EffectiveWidth(enum.IntEnum):
+ """Represents the width of a Unicode character. All East Asian Width classes resolve into
+ either `EffectiveWidth.NARROW`, `EffectiveWidth.WIDE`, or `EffectiveWidth.AMBIGUOUS`."""
+
+ ZERO = 0
+ """ Zero columns wide. """
+ NARROW = 1
+ """ One column wide. """
+ WIDE = 2
+ """ Two columns wide. """
+ AMBIGUOUS = 3
+ """ Two columns wide in a CJK context. One column wide in all other contexts. """
+
+
+def load_east_asian_widths() -> "list[EffectiveWidth]":
+ """Return a list of effective widths, indexed by codepoint.
+ Widths are determined by fetching and parsing `EastAsianWidth.txt`.
+
+ `Neutral`, `Narrow`, and `Halfwidth` characters are assigned `EffectiveWidth.NARROW`.
+
+ `Wide` and `Fullwidth` characters are assigned `EffectiveWidth.WIDE`.
+
+ `Ambiguous` chracters are assigned `EffectiveWidth.AMBIGUOUS`."""
+ with fetch_open("EastAsianWidth.txt") as eaw:
+ # matches a width assignment for a single codepoint, i.e. "1F336;N # ..."
+ single = re.compile(r"^([0-9A-F]+)\s+;\s+(\w+) +# (\w+)")
+ # matches a width assignment for a range of codepoints, i.e. "3001..3003;W # ..."
+ multiple = re.compile(r"^([0-9A-F]+)\.\.([0-9A-F]+)\s+;\s+(\w+) +# (\w+)")
+ # map between width category code and condensed width
+ width_codes = {
+ **{c: EffectiveWidth.NARROW for c in ["N", "Na", "H"]},
+ **{c: EffectiveWidth.WIDE for c in ["W", "F"]},
+ "A": EffectiveWidth.AMBIGUOUS,
+ }
+
+ width_map = []
+ current = 0
+ for line in eaw.readlines():
+ raw_data = None # (low, high, width)
+ if match := single.match(line):
+ raw_data = (match.group(1), match.group(1), match.group(2))
+ elif match := multiple.match(line):
+ raw_data = (match.group(1), match.group(2), match.group(3))
+ else:
+ continue
+ low = int(raw_data[0], 16)
+ high = int(raw_data[1], 16)
+ width = width_codes[raw_data[2]]
+
+ assert current <= high
+ while current <= high:
+ # Some codepoints don't fall into any of the ranges in EastAsianWidth.txt.
+ # All such codepoints are implicitly given Neural width (resolves to narrow)
+ width_map.append(EffectiveWidth.NARROW if current < low else width)
+ current += 1
+
+ while len(width_map) < NUM_CODEPOINTS:
+ # Catch any leftover codepoints and assign them implicit Neutral/narrow width.
+ width_map.append(EffectiveWidth.NARROW)
+
+ return width_map
+
+
+def load_zero_widths() -> "list[bool]":
+ """Returns a list `l` where `l[c]` is true if codepoint `c` is considered a zero-width
+ character. `c` is considered a zero-width character if `c` is in general categories
+ `Cc`, `Cf`, `Mn`, or `Me` (determined by fetching and processing `UnicodeData.txt`)."""
+ with fetch_open("UnicodeData.txt") as categories:
+ zw_map = []
+ current = 0
+ for line in categories.readlines():
+ if len(raw_data := line.split(";")) != 15:
+ continue
+ [codepoint, name, cat_code] = [
+ int(raw_data[0], 16),
+ raw_data[1],
+ raw_data[2],
+ ]
+ zero_width = cat_code in ["Cc", "Cf", "Mn", "Me"]
+
+ assert current <= codepoint
+ while current <= codepoint:
+ if name.endswith(", Last>") or current == codepoint:
+ # if name ends with Last, we backfill the width value to all codepoints since
+ # the previous codepoint (aka the start of the range)
+ zw_map.append(zero_width)
+ else:
+ # unassigned characters are implicitly given Neutral width, which is nonzero
+ zw_map.append(False)
+ current += 1
+
+ while len(zw_map) < NUM_CODEPOINTS:
+ # Catch any leftover codepoints. They must be unassigned (so nonzero width)
+ zw_map.append(False)
+
+ return zw_map
+
+
+class Bucket:
+ """A bucket contains a group of codepoints and an ordered width list. If one bucket's width
+ list overlaps with another's width list, those buckets can be merged via `try_extend`."""
+
+ def __init__(self):
+ """Creates an empty bucket."""
+ self.entry_set = set()
+ self.widths = []
+
+ def append(self, codepoint: Codepoint, width: EffectiveWidth):
+ """Adds a codepoint/width pair to the bucket, and appends `width` to the width list."""
+ self.entry_set.add((codepoint, width))
+ self.widths.append(width)
+
+ def try_extend(self, attempt: "Bucket") -> bool:
+ """If either `self` or `attempt`'s width list starts with the other bucket's width list,
+ set `self`'s width list to the longer of the two, add all of `attempt`'s codepoints
+ into `self`, and return `True`. Otherwise, return `False`."""
+ (less, more) = (self.widths, attempt.widths)
+ if len(self.widths) > len(attempt.widths):
+ (less, more) = (attempt.widths, self.widths)
+ if less != more[: len(less)]:
+ return False
+ self.entry_set |= attempt.entry_set
+ self.widths = more
+ return True
+
+ def entries(self) -> "list[tuple[Codepoint, EffectiveWidth]]":
+ """Return a list of the codepoint/width pairs in this bucket, sorted by codepoint."""
+ result = list(self.entry_set)
+ result.sort()
+ return result
+
+ def width(self) -> "EffectiveWidth":
+ """If all codepoints in this bucket have the same width, return that width; otherwise,
+ return `None`."""
+ if len(self.widths) == 0:
+ return None
+ potential_width = self.widths[0]
+ for width in self.widths[1:]:
+ if potential_width != width:
+ return None
+ return potential_width
+
+
+def make_buckets(entries, low_bit: BitPos, cap_bit: BitPos) -> "list[Bucket]":
+ """Partitions the `(Codepoint, EffectiveWidth)` tuples in `entries` into `Bucket`s. All
+ codepoints with identical bits from `low_bit` to `cap_bit` (exclusive) are placed in the
+ same bucket. Returns a list of the buckets in increasing order of those bits."""
+ num_bits = cap_bit - low_bit
+ assert num_bits > 0
+ buckets = [Bucket() for _ in range(0, 2 ** num_bits)]
+ mask = (1 << num_bits) - 1
+ for (codepoint, width) in entries:
+ buckets[(codepoint >> low_bit) & mask].append(codepoint, width)
+ return buckets
+
+
+class Table:
+ """Represents a lookup table. Each table contains a certain number of subtables; each
+ subtable is indexed by a contiguous bit range of the codepoint and contains a list
+ of `2**(number of bits in bit range)` entries. (The bit range is the same for all subtables.)
+
+ Typically, tables contain a list of buckets of codepoints. Bucket `i`'s codepoints should
+ be indexed by sub-table `i` in the next-level lookup table. The entries of this table are
+ indexes into the bucket list (~= indexes into the sub-tables of the next-level table.) The
+ key to compression is that two different buckets in two different sub-tables may have the
+ same width list, which means that they can be merged into the same bucket.
+
+ If no bucket contains two codepoints with different widths, calling `indices_to_widths` will
+ discard the buckets and convert the entries into `EffectiveWidth` values."""
+
+ def __init__(
+ self, entry_groups, low_bit: BitPos, cap_bit: BitPos, offset_type: OffsetType
+ ):
+ """Create a lookup table with a sub-table for each `(Codepoint, EffectiveWidth)` iterator
+ in `entry_groups`. Each sub-table is indexed by codepoint bits in `low_bit..cap_bit`,
+ and each table entry is represented in the format specified by `offset_type`. Asserts
+ that this table is actually representable with `offset_type`."""
+ self.low_bit = low_bit
+ self.cap_bit = cap_bit
+ self.offset_type = offset_type
+ self.entries = []
+ self.indexed = []
+
+ buckets = []
+ for entries in entry_groups:
+ buckets.extend(make_buckets(entries, self.low_bit, self.cap_bit))
+
+ for bucket in buckets:
+ for (i, existing) in enumerate(self.indexed):
+ if existing.try_extend(bucket):
+ self.entries.append(i)
+ break
+ else:
+ self.entries.append(len(self.indexed))
+ self.indexed.append(bucket)
+
+ # Validate offset type
+ for index in self.entries:
+ assert index < (1 << int(self.offset_type))
+
+ def indices_to_widths(self):
+ """Destructively converts the indices in this table to the `EffectiveWidth` values of
+ their buckets. Assumes that no bucket contains codepoints with different widths."""
+ self.entries = list(map(lambda i: int(self.indexed[i].width()), self.entries))
+ del self.indexed
+
+ def buckets(self):
+ """Returns an iterator over this table's buckets."""
+ return self.indexed
+
+ def to_bytes(self) -> "list[int]":
+ """Returns this table's entries as a list of bytes. The bytes are formatted according to
+ the `OffsetType` which the table was created with, converting any `EffectiveWidth` entries
+ to their enum variant's integer value. For example, with `OffsetType.U2`, each byte will
+ contain four packed 2-bit entries."""
+ entries_per_byte = 8 // int(self.offset_type)
+ byte_array = []
+ for i in range(0, len(self.entries), entries_per_byte):
+ byte = 0
+ for j in range(0, entries_per_byte):
+ byte |= self.entries[i + j] << (j * int(self.offset_type))
+ byte_array.append(byte)
+ return byte_array
+
+
+def make_tables(
+ table_cfgs: "list[tuple[BitPos, BitPos, OffsetType]]", entries
+) -> "list[Table]":
+ """Creates a table for each configuration in `table_cfgs`, with the first config corresponding
+ to the top-level lookup table, the second config corresponding to the second-level lookup
+ table, and so forth. `entries` is an iterator over the `(Codepoint, EffectiveWidth)` pairs
+ to include in the top-level table."""
+ tables = []
+ entry_groups = [entries]
+ for (low_bit, cap_bit, offset_type) in table_cfgs:
+ table = Table(entry_groups, low_bit, cap_bit, offset_type)
+ entry_groups = map(lambda bucket: bucket.entries(), table.buckets())
+ tables.append(table)
+ return tables
+
+
+def emit_module(
+ out_name: str, unicode_version: "tuple[int, int, int]", tables: "list[Table]"
+):
+ """Outputs a Rust module to `out_name` using table data from `tables`.
+ If `TABLE_CFGS` is edited, you may need to edit the included code for `lookup_width`."""
+ if os.path.exists(out_name):
+ os.remove(out_name)
+ with open(out_name, "w", newline="\n", encoding="utf-8") as module:
+ module.write(
+ """// Copyright 2012-2022 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+"""
+ )
+ module.write(
+ f"""
+/// The version of [Unicode](http://www.unicode.org/)
+/// that this version of unicode-width is based on.
+pub const UNICODE_VERSION: (u8, u8, u8) = {unicode_version};
+"""
+ )
+
+ module.write(
+ """
+pub mod charwidth {
+ use core::option::Option::{self, None, Some};
+
+ /// Returns the [UAX #11](https://www.unicode.org/reports/tr11/) based width of `c` by
+ /// consulting a multi-level lookup table.
+ /// If `is_cjk == true`, ambiguous width characters are treated as double width; otherwise,
+ /// they're treated as single width.
+ ///
+ /// # Maintenance
+ /// The tables themselves are autogenerated but this function is hardcoded. You should have
+ /// nothing to worry about if you re-run `unicode.py` (for example, when updating Unicode.)
+ /// However, if you change the *actual structure* of the lookup tables (perhaps by editing the
+ /// `TABLE_CFGS` global in `unicode.py`) you must ensure that this code reflects those changes.
+ #[inline]
+ fn lookup_width(c: char, is_cjk: bool) -> usize {
+ let cp = c as usize;
+
+ let t1_offset = TABLES_0[cp >> 13 & 0xFF];
+
+ // Each sub-table in TABLES_1 is 7 bits, and each stored entry is a byte,
+ // so each sub-table is 128 bytes in size.
+ // (Sub-tables are selected using the computed offset from the previous table.)
+ let t2_offset = TABLES_1[128 * usize::from(t1_offset) + (cp >> 6 & 0x7F)];
+
+ // Each sub-table in TABLES_2 is 6 bits, but each stored entry is 2 bits.
+ // This is accomplished by packing four stored entries into one byte.
+ // So each sub-table is 2**(6-2) == 16 bytes in size.
+ // Since this is the last table, each entry represents an encoded width.
+ let packed_widths = TABLES_2[16 * usize::from(t2_offset) + (cp >> 2 & 0xF)];
+
+ // Extract the packed width
+ let width = packed_widths >> (2 * (cp & 0b11)) & 0b11;
+
+ // A width of 3 signifies that the codepoint is ambiguous width.
+ if width == 3 {
+ if is_cjk {
+ 2
+ } else {
+ 1
+ }
+ } else {
+ width.into()
+ }
+ }
+"""
+ )
+
+ module.write(
+ """
+ /// Returns the [UAX #11](https://www.unicode.org/reports/tr11/) based width of `c`, or
+ /// `None` if `c` is a control character other than `'\\x00'`.
+ /// If `is_cjk == true`, ambiguous width characters are treated as double width; otherwise,
+ /// they're treated as single width.
+ #[inline]
+ pub fn width(c: char, is_cjk: bool) -> Option<usize> {
+ if c < '\\u{7F}' {
+ if c >= '\\u{20}' {
+ // U+0020 to U+007F (exclusive) are single-width ASCII codepoints
+ Some(1)
+ } else if c == '\\0' {
+ // U+0000 *is* a control code, but it's special-cased
+ Some(0)
+ } else {
+ // U+0001 to U+0020 (exclusive) are control codes
+ None
+ }
+ } else if c >= '\\u{A0}' {
+ // No characters >= U+00A0 are control codes, so we can consult the lookup tables
+ Some(lookup_width(c, is_cjk))
+ } else {
+ // U+007F to U+00A0 (exclusive) are control codes
+ None
+ }
+ }
+"""
+ )
+
+ subtable_count = 1
+ for (i, table) in enumerate(tables):
+ new_subtable_count = len(table.buckets())
+ if i == len(tables) - 1:
+ table.indices_to_widths() # for the last table, indices == widths
+ byte_array = table.to_bytes()
+ module.write(
+ f"""
+ /// Autogenerated. {subtable_count} sub-table(s). Consult [`lookup_width`] for layout info.
+ static TABLES_{i}: [u8; {len(byte_array)}] = ["""
+ )
+ for (j, byte) in enumerate(byte_array):
+ # Add line breaks for every 15th entry (chosen to match what rustfmt does)
+ if j % 15 == 0:
+ module.write("\n ")
+ module.write(f" 0x{byte:02X},")
+ module.write("\n ];\n")
+ subtable_count = new_subtable_count
+ module.write("}\n")
+
+
+def main(module_filename: str):
+ """Obtain character data from the latest version of Unicode, transform it into a multi-level
+ lookup table for character width, and write a Rust module utilizing that table to
+ `module_filename`.
+
+ We obey the following rules in decreasing order of importance:
+ - The soft hyphen (`U+00AD`) is single-width.
+ - Hangul Jamo medial vowels & final consonants (`U+1160..=U+11FF`) are zero-width.
+ - All codepoints in general categories `Cc`, `Cf`, `Mn`, and `Me` are zero-width.
+ - All codepoints with an East Asian Width of `Ambigous` are ambiguous-width.
+ - All codepoints with an East Asian Width of `Wide` or `Fullwidth` are double-width.
+ - All other codepoints (including unassigned codepoints and codepoints with an East Asian Width
+ of `Neutral`, `Narrow`, or `Halfwidth`) are single-width.
+
+ These rules are based off of Markus Kuhn's free `wcwidth()` implementation:
+ http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c"""
+ version = load_unicode_version()
+ print(f"Generating module for Unicode {version[0]}.{version[1]}.{version[2]}")
+
+ eaw_map = load_east_asian_widths()
+ zw_map = load_zero_widths()
+
+ # Characters marked as zero-width in zw_map should be zero-width in the final map
+ width_map = list(
+ map(lambda x: EffectiveWidth.ZERO if x[1] else x[0], zip(eaw_map, zw_map))
+ )
+
+ # Override for soft hyphen
+ width_map[0x00AD] = EffectiveWidth.NARROW
+
+ # Override for Hangul Jamo medial vowels & final consonants
+ for i in range(0x1160, 0x11FF + 1):
+ width_map[i] = EffectiveWidth.ZERO
+
+ tables = make_tables(TABLE_CFGS, enumerate(width_map))
+
+ print("------------------------")
+ total_size = 0
+ for (i, table) in enumerate(tables):
+ size_bytes = len(table.to_bytes())
+ print(f"Table {i} Size: {size_bytes} bytes")
+ total_size += size_bytes
+ print("------------------------")
+ print(f" Total Size: {total_size} bytes")
+
+ emit_module(module_filename, version, tables)
+ print(f'Wrote to "{module_filename}"')
+
+
+if __name__ == "__main__":
+ main(MODULE_FILENAME)
diff --git a/crates/unicode-width/src/lib.rs b/crates/unicode-width/src/lib.rs
new file mode 100644
index 0000000..f2a50bf
--- /dev/null
+++ b/crates/unicode-width/src/lib.rs
@@ -0,0 +1,129 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Determine displayed width of `char` and `str` types according to
+//! [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
+//! rules.
+//!
+//! ```rust
+//! extern crate unicode_width;
+//!
+//! use unicode_width::UnicodeWidthStr;
+//!
+//! fn main() {
+//! let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
+//! let width = UnicodeWidthStr::width(teststr);
+//! println!("{}", teststr);
+//! println!("The above string is {} columns wide.", width);
+//! let width = teststr.width_cjk();
+//! println!("The above string is {} columns wide (CJK).", width);
+//! }
+//! ```
+//!
+//! # features
+//!
+//! unicode-width supports a `no_std` feature. This eliminates dependence
+//! on std, and instead uses equivalent functions from core.
+//!
+//! # crates.io
+//!
+//! You can use this package in your project by adding the following
+//! to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies]
+//! unicode-width = "0.1.5"
+//! ```
+
+#![deny(missing_docs, unsafe_code)]
+#![doc(html_logo_url = "https://unicode-rs.github.io/unicode-rs_sm.png",
+ html_favicon_url = "https://unicode-rs.github.io/unicode-rs_sm.png")]
+
+#![cfg_attr(feature = "bench", feature(test))]
+#![no_std]
+
+// ANDROID: Unconditionally use std to allow building as a dylib.
+#[macro_use]
+extern crate std;
+
+#[cfg(feature = "bench")]
+extern crate test;
+
+use tables::charwidth as cw;
+pub use tables::UNICODE_VERSION;
+
+mod tables;
+
+#[cfg(test)]
+mod tests;
+
+/// Methods for determining displayed width of Unicode characters.
+pub trait UnicodeWidthChar {
+ /// Returns the character's displayed width in columns, or `None` if the
+ /// character is a control character other than `'\x00'`.
+ ///
+ /// This function treats characters in the Ambiguous category according
+ /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
+ /// as 1 column wide. This is consistent with the recommendations for non-CJK
+ /// contexts, or when the context cannot be reliably determined.
+ fn width(self) -> Option<usize>;
+
+ /// Returns the character's displayed width in columns, or `None` if the
+ /// character is a control character other than `'\x00'`.
+ ///
+ /// This function treats characters in the Ambiguous category according
+ /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
+ /// as 2 columns wide. This is consistent with the recommendations for
+ /// CJK contexts.
+ fn width_cjk(self) -> Option<usize>;
+}
+
+impl UnicodeWidthChar for char {
+ #[inline]
+ fn width(self) -> Option<usize> { cw::width(self, false) }
+
+ #[inline]
+ fn width_cjk(self) -> Option<usize> { cw::width(self, true) }
+}
+
+/// Methods for determining displayed width of Unicode strings.
+pub trait UnicodeWidthStr {
+ /// Returns the string's displayed width in columns.
+ ///
+ /// Control characters are treated as having zero width.
+ ///
+ /// This function treats characters in the Ambiguous category according
+ /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
+ /// as 1 column wide. This is consistent with the recommendations for
+ /// non-CJK contexts, or when the context cannot be reliably determined.
+ fn width<'a>(&'a self) -> usize;
+
+ /// Returns the string's displayed width in columns.
+ ///
+ /// Control characters are treated as having zero width.
+ ///
+ /// This function treats characters in the Ambiguous category according
+ /// to [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
+ /// as 2 column wide. This is consistent with the recommendations for
+ /// CJK contexts.
+ fn width_cjk<'a>(&'a self) -> usize;
+}
+
+impl UnicodeWidthStr for str {
+ #[inline]
+ fn width(&self) -> usize {
+ self.chars().map(|c| cw::width(c, false).unwrap_or(0)).sum()
+ }
+
+ #[inline]
+ fn width_cjk(&self) -> usize {
+ self.chars().map(|c| cw::width(c, true).unwrap_or(0)).sum()
+ }
+}
diff --git a/crates/unicode-width/src/tables.rs b/crates/unicode-width/src/tables.rs
new file mode 100644
index 0000000..791d7a8
--- /dev/null
+++ b/crates/unicode-width/src/tables.rs
@@ -0,0 +1,540 @@
+// Copyright 2012-2022 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+// NOTE: The following code was generated by "scripts/unicode.py", do not edit directly
+
+/// The version of [Unicode](http://www.unicode.org/)
+/// that this version of unicode-width is based on.
+pub const UNICODE_VERSION: (u8, u8, u8) = (15, 1, 0);
+
+pub mod charwidth {
+ use core::option::Option::{self, None, Some};
+
+ /// Returns the [UAX #11](https://www.unicode.org/reports/tr11/) based width of `c` by
+ /// consulting a multi-level lookup table.
+ /// If `is_cjk == true`, ambiguous width characters are treated as double width; otherwise,
+ /// they're treated as single width.
+ ///
+ /// # Maintenance
+ /// The tables themselves are autogenerated but this function is hardcoded. You should have
+ /// nothing to worry about if you re-run `unicode.py` (for example, when updating Unicode.)
+ /// However, if you change the *actual structure* of the lookup tables (perhaps by editing the
+ /// `TABLE_CFGS` global in `unicode.py`) you must ensure that this code reflects those changes.
+ #[inline]
+ fn lookup_width(c: char, is_cjk: bool) -> usize {
+ let cp = c as usize;
+
+ let t1_offset = TABLES_0[cp >> 13 & 0xFF];
+
+ // Each sub-table in TABLES_1 is 7 bits, and each stored entry is a byte,
+ // so each sub-table is 128 bytes in size.
+ // (Sub-tables are selected using the computed offset from the previous table.)
+ let t2_offset = TABLES_1[128 * usize::from(t1_offset) + (cp >> 6 & 0x7F)];
+
+ // Each sub-table in TABLES_2 is 6 bits, but each stored entry is 2 bits.
+ // This is accomplished by packing four stored entries into one byte.
+ // So each sub-table is 2**(6-2) == 16 bytes in size.
+ // Since this is the last table, each entry represents an encoded width.
+ let packed_widths = TABLES_2[16 * usize::from(t2_offset) + (cp >> 2 & 0xF)];
+
+ // Extract the packed width
+ let width = packed_widths >> (2 * (cp & 0b11)) & 0b11;
+
+ // A width of 3 signifies that the codepoint is ambiguous width.
+ if width == 3 {
+ if is_cjk {
+ 2
+ } else {
+ 1
+ }
+ } else {
+ width.into()
+ }
+ }
+
+ /// Returns the [UAX #11](https://www.unicode.org/reports/tr11/) based width of `c`, or
+ /// `None` if `c` is a control character other than `'\x00'`.
+ /// If `is_cjk == true`, ambiguous width characters are treated as double width; otherwise,
+ /// they're treated as single width.
+ #[inline]
+ pub fn width(c: char, is_cjk: bool) -> Option<usize> {
+ if c < '\u{7F}' {
+ if c >= '\u{20}' {
+ // U+0020 to U+007F (exclusive) are single-width ASCII codepoints
+ Some(1)
+ } else if c == '\0' {
+ // U+0000 *is* a control code, but it's special-cased
+ Some(0)
+ } else {
+ // U+0001 to U+0020 (exclusive) are control codes
+ None
+ }
+ } else if c >= '\u{A0}' {
+ // No characters >= U+00A0 are control codes, so we can consult the lookup tables
+ Some(lookup_width(c, is_cjk))
+ } else {
+ // U+007F to U+00A0 (exclusive) are control codes
+ None
+ }
+ }
+
+ /// Autogenerated. 1 sub-table(s). Consult [`lookup_width`] for layout info.
+ static TABLES_0: [u8; 256] = [
+ 0x00, 0x01, 0x02, 0x03, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D,
+ 0x0E, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03, 0x0F, 0x03, 0x03, 0x03, 0x03, 0x03, 0x03,
+ 0x03, 0x0F, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x10, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09, 0x09,
+ 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x12, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11, 0x11,
+ 0x12, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00,
+ ];
+
+ /// Autogenerated. 19 sub-table(s). Consult [`lookup_width`] for layout info.
+ static TABLES_1: [u8; 2432] = [
+ 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x06, 0x08, 0x06, 0x09, 0x0A, 0x0B, 0x0C,
+ 0x0D, 0x0E, 0x0F, 0x10, 0x06, 0x06, 0x06, 0x11, 0x12, 0x13, 0x14, 0x06, 0x15, 0x16, 0x17,
+ 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20, 0x21, 0x22, 0x23, 0x22, 0x24, 0x25,
+ 0x26, 0x27, 0x28, 0x29, 0x2A, 0x25, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30, 0x31, 0x32, 0x33,
+ 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3A, 0x06, 0x3B, 0x3C, 0x0A, 0x0A, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x3D, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x3E, 0x3F, 0x40, 0x41, 0x42, 0x06, 0x43, 0x06, 0x44, 0x06, 0x06, 0x06, 0x45,
+ 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x06, 0x06, 0x4E, 0x06, 0x06, 0x06, 0x0A,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x4F, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55,
+ 0x56, 0x57, 0x58, 0x59, 0x06, 0x5A, 0x06, 0x06, 0x5B, 0x06, 0x5C, 0x5D, 0x5E, 0x5D, 0x5F,
+ 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x69, 0x6A, 0x06, 0x06, 0x06, 0x06, 0x06, 0x6B,
+ 0x06, 0x01, 0x06, 0x6C, 0x06, 0x06, 0x6D, 0x6E, 0x3B, 0x3B, 0x3B, 0x6F, 0x70, 0x71, 0x72,
+ 0x3B, 0x73, 0x3B, 0x74, 0x75, 0x76, 0x77, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x06, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x78, 0x79, 0x06, 0x06, 0x06, 0x06, 0x06, 0x7A, 0x7B, 0x7C,
+ 0x06, 0x06, 0x06, 0x06, 0x7D, 0x06, 0x06, 0x7E, 0x7F, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85,
+ 0x86, 0x06, 0x06, 0x06, 0x87, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x88,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x89, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x8A, 0x8B, 0x06, 0x01, 0x71, 0x8C, 0x06, 0x8D, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x8E, 0x06, 0x06, 0x06, 0x8F, 0x06, 0x90, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x91, 0x06, 0x06, 0x92, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x93, 0x06, 0x06, 0x06, 0x06, 0x06, 0x94, 0x95, 0x06, 0x96, 0x97, 0x06,
+ 0x98, 0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F, 0xA0, 0x2E, 0x06, 0xA1, 0x2C, 0xA2, 0x06,
+ 0x06, 0xA3, 0xA4, 0xA5, 0xA6, 0x06, 0x06, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0x06, 0xAC, 0x06,
+ 0x06, 0x06, 0xAD, 0x06, 0x06, 0x06, 0xAE, 0xAF, 0x06, 0xB0, 0xB1, 0xB2, 0xB3, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0xB4, 0x06, 0xB5, 0x06, 0xB6, 0xB7, 0xB8, 0x06, 0x06, 0x06, 0x06, 0xB9,
+ 0xBA, 0xBB, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x47, 0xBC, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0xBD, 0xBE, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xBF, 0xC0, 0xC1, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0xC2,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0xC3, 0xC4, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xC5, 0x3B, 0x3B, 0x3B, 0x3B, 0xC6,
+ 0xC7, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0xC8, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0xC9, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xCA,
+ 0xCB, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xCC, 0xCD, 0x06, 0x06, 0xCE, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xCF, 0xD0,
+ 0xD1, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xD2, 0x06, 0xBF, 0x06, 0xBE, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0xD3, 0xD4, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xD4, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xD5, 0x06, 0xD6,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0xD7, 0x06, 0x06, 0xD8,
+ 0xD9, 0xDA, 0xDB, 0x06, 0xDC, 0xDD, 0x06, 0x06, 0xDE, 0xDF, 0xE0, 0xE1, 0xE2, 0xE3, 0x3B,
+ 0xE4, 0xE5, 0xE6, 0xE7, 0xE8, 0x3B, 0xE9, 0x3B, 0xEA, 0x06, 0x06, 0x06, 0xEB, 0x06, 0x06,
+ 0x06, 0x06, 0xEC, 0xED, 0x3B, 0x3B, 0x06, 0xEE, 0xEF, 0xF0, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B,
+ 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0x3B, 0xE5, 0xF1, 0x0A, 0x06, 0x06, 0x0A, 0x0A, 0x0A,
+ 0x0B, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06, 0x06,
+ 0x06, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D, 0x5D,
+ 0x5D, 0xF2,
+ ];
+
+ /// Autogenerated. 243 sub-table(s). Consult [`lookup_width`] for layout info.
+ static TABLES_2: [u8; 3888] = [
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x15, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x5D, 0xD7, 0x77, 0x75, 0xFF,
+ 0xF7, 0x7F, 0xFF, 0x55, 0x75, 0x55, 0x55, 0x57, 0xD5, 0x57, 0xF5, 0x5F, 0x75, 0x7F, 0x5F,
+ 0xF7, 0xD5, 0x7F, 0x77, 0x5D, 0x55, 0x55, 0x55, 0xDD, 0x55, 0xD5, 0x55, 0x55, 0xF5, 0xD5,
+ 0x55, 0xFD, 0x55, 0x57, 0xD5, 0x7F, 0x57, 0xFF, 0x5D, 0xF5, 0x55, 0x55, 0x55, 0x55, 0xF5,
+ 0xD5, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x75, 0x77, 0x77, 0x77, 0x57,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x5D, 0x55, 0x55,
+ 0x55, 0x5D, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xD7, 0xFD, 0x5D, 0x57, 0x55,
+ 0xFF, 0xDD, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0xFD, 0xFF, 0xFF, 0xFF, 0xDF, 0xFF, 0x5F, 0x55, 0xFD, 0xFF, 0xFF, 0xFF, 0xDF, 0xFF,
+ 0x5F, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x5D,
+ 0x55, 0x55, 0x55, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0x5D, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x15, 0x00, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x10, 0x41, 0x10, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x00, 0x50, 0x55, 0x55, 0x00, 0x00, 0x40, 0x54, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x00, 0x00, 0x00, 0x00, 0x55, 0x55,
+ 0x55, 0x55, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x00, 0x10, 0x00,
+ 0x14, 0x04, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x51, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x05, 0x00, 0x00, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x00, 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x05, 0x10, 0x00, 0x00, 0x01, 0x01, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x01, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x50, 0x55, 0x00, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45,
+ 0x54, 0x01, 0x00, 0x54, 0x51, 0x01, 0x00, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x54, 0x01, 0x54, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x45, 0x41, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x54, 0x41, 0x15, 0x14, 0x50, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x50, 0x51, 0x55, 0x55, 0x01, 0x10, 0x54, 0x51, 0x55, 0x55, 0x55, 0x55, 0x05,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x00, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x14, 0x01, 0x54, 0x55, 0x51, 0x55, 0x41, 0x55,
+ 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54, 0x55, 0x55, 0x51, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54, 0x54, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x04, 0x54, 0x05, 0x04,
+ 0x50, 0x55, 0x41, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45,
+ 0x55, 0x50, 0x55, 0x55, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x54,
+ 0x01, 0x54, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x45, 0x55, 0x05, 0x44, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x51, 0x00, 0x40, 0x55, 0x55, 0x15, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x51, 0x00, 0x00, 0x54, 0x55, 0x55, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x11, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x00, 0x00, 0x40, 0x00, 0x04, 0x55, 0x01, 0x00, 0x00,
+ 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x54, 0x55, 0x45, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x04, 0x00, 0x41, 0x41, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x50, 0x05, 0x54, 0x55, 0x55, 0x55, 0x01, 0x54, 0x55, 0x55, 0x45, 0x41,
+ 0x55, 0x51, 0x55, 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x10, 0x00, 0x50, 0x55, 0x45, 0x01, 0x00, 0x00, 0x55, 0x55, 0x51, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x41, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x40, 0x15, 0x54, 0x55, 0x45, 0x55, 0x01, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15,
+ 0x14, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x45, 0x00, 0x40, 0x44, 0x01, 0x00, 0x54, 0x15, 0x00, 0x00, 0x14, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x04, 0x40, 0x54, 0x45,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x00, 0x55, 0x55, 0x55,
+ 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x50, 0x10, 0x50, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45, 0x50, 0x11, 0x50, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00,
+ 0x05, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x40, 0x00, 0x00, 0x00, 0x04, 0x00, 0x54, 0x51,
+ 0x55, 0x54, 0x50, 0x55, 0x55, 0x55, 0x15, 0x00, 0xD7, 0x7F, 0x5F, 0x5F, 0x7F, 0xFF, 0x05,
+ 0x40, 0xF7, 0x5D, 0xD5, 0x75, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x04,
+ 0x00, 0x00, 0x55, 0x57, 0x55, 0xD5, 0xFD, 0x57, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x57, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x54, 0x55, 0x55, 0x55, 0xD5, 0x5D, 0x5D, 0x55, 0xD5, 0x75, 0x55,
+ 0x55, 0x7D, 0x75, 0xD5, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xD5, 0x57,
+ 0xD5, 0x7F, 0xFF, 0xFF, 0xFF, 0x55, 0xFF, 0xFF, 0x5F, 0x55, 0x55, 0x55, 0x5D, 0x55, 0xFF,
+ 0xFF, 0x5F, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x5F, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x75, 0x57, 0x55, 0x55, 0x55, 0xD5, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xF7, 0xD5, 0xD7,
+ 0xD5, 0x5D, 0x5D, 0x75, 0xFD, 0xD7, 0xDD, 0xFF, 0x77, 0x55, 0xFF, 0x55, 0x5F, 0x55, 0x55,
+ 0x57, 0x57, 0x75, 0x55, 0x55, 0x55, 0x5F, 0xFF, 0xF5, 0xF5, 0x55, 0x55, 0x55, 0x55, 0xF5,
+ 0xF5, 0x55, 0x55, 0x55, 0x5D, 0x5D, 0x55, 0x55, 0x5D, 0x55, 0x55, 0x55, 0x55, 0x55, 0xD5,
+ 0x55, 0x55, 0x55, 0x55, 0x75, 0x55, 0xA5, 0x55, 0x55, 0x55, 0x69, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xA9, 0x56, 0x96, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xDF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0x55, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0x55, 0x55, 0x55, 0xFF, 0xFF, 0xFF, 0xFF, 0xF5, 0x5F, 0x55, 0x55, 0xDF,
+ 0xFF, 0x5F, 0x55, 0xF5, 0xF5, 0x55, 0x5F, 0x5F, 0xF5, 0xD7, 0xF5, 0x5F, 0x55, 0x55, 0x55,
+ 0xF5, 0x5F, 0x55, 0xD5, 0x55, 0x55, 0x55, 0x69, 0x55, 0x7D, 0x5D, 0xF5, 0x55, 0x5A, 0x55,
+ 0x77, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x77, 0x55, 0xAA, 0xAA, 0xAA, 0x55,
+ 0x55, 0x55, 0xDF, 0xDF, 0x7F, 0xDF, 0x55, 0x55, 0x55, 0x95, 0x55, 0x55, 0x55, 0x55, 0x95,
+ 0x55, 0x55, 0xF5, 0x59, 0x55, 0xA5, 0x55, 0x55, 0x55, 0x55, 0xE9, 0x55, 0xFA, 0xFF, 0xEF,
+ 0xFF, 0xFE, 0xFF, 0xFF, 0xDF, 0x55, 0xEF, 0xFF, 0xAF, 0xFB, 0xEF, 0xFB, 0x55, 0x59, 0xA5,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x56, 0x55, 0x55, 0x55, 0x55, 0x5D, 0x55, 0x55,
+ 0x55, 0x66, 0x95, 0x9A, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xF5, 0xFF, 0xFF, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0xA9, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x56, 0x55, 0x55, 0x95,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x95, 0x56, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x56, 0xF9, 0x5F, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x50,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x9A, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x5A, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0x0A, 0xA0, 0xAA, 0xAA, 0xAA, 0x6A, 0xA9, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A,
+ 0x81, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0xA9, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xA9, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x95, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xFF, 0xFF, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0x56, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0x6A, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x40,
+ 0x00, 0x00, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x50, 0x55, 0x55, 0x55, 0x45, 0x45, 0x15, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x41,
+ 0x55, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00,
+ 0x00, 0x00, 0x00, 0x50, 0x55, 0x55, 0x15, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x05, 0x00, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x00, 0x50, 0x55, 0x55,
+ 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x56, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x05, 0x50, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x40, 0x41, 0x41, 0x55, 0x55, 0x15, 0x55, 0x55,
+ 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x04, 0x14, 0x54, 0x05, 0x51,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50, 0x55, 0x45, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x51, 0x54, 0x51, 0x55, 0x55, 0x55,
+ 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0xAA, 0xAA, 0x5A, 0x55, 0x00, 0x00, 0x00, 0x00,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A, 0xAA,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x56, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA,
+ 0x6A, 0x55, 0x55, 0x55, 0x55, 0x01, 0x5D, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x40, 0x55, 0x01, 0x41, 0x55, 0x00, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x40, 0x15, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x41, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01,
+ 0x55, 0x05, 0x00, 0x00, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x05, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x00, 0x00, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x14, 0x54, 0x55, 0x15, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x15, 0x40, 0x41, 0x51, 0x45, 0x55, 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x15, 0x00, 0x01, 0x00, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x15, 0x55, 0x55, 0x55, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x00, 0x40, 0x55, 0x55, 0x01, 0x14, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x50, 0x04, 0x55, 0x45, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x15, 0x15, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x00, 0x54, 0x00, 0x54, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x05,
+ 0x44, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x44,
+ 0x15, 0x04, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x05,
+ 0x50, 0x55, 0x10, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x15, 0x00, 0x40, 0x11, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x15, 0x51, 0x00, 0x10, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01,
+ 0x05, 0x10, 0x00, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x00, 0x41, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x44, 0x15, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x00, 0x05, 0x55, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01, 0x00, 0x40,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x14, 0x40, 0x55, 0x15,
+ 0x55, 0x55, 0x01, 0x40, 0x01, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x05, 0x00, 0x00, 0x40, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x40, 0x00,
+ 0x10, 0x55, 0x55, 0x55, 0x55, 0x05, 0x00, 0x00, 0x00, 0x00, 0x00, 0x05, 0x00, 0x04, 0x41,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x01,
+ 0x40, 0x45, 0x10, 0x00, 0x10, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x50, 0x11, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x15, 0x54, 0x55, 0x55, 0x50, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x05, 0x40, 0x55, 0x44, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x54, 0x15, 0x00, 0x00, 0x00, 0x50, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x54, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x15,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x15, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA, 0x54, 0x55, 0x55, 0x5A, 0x55, 0x55, 0x55, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x5A, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0xAA, 0xAA, 0x56, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA,
+ 0xA9, 0xAA, 0x69, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A, 0x55, 0x55, 0x55,
+ 0x65, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x6A, 0x59, 0x55, 0x55, 0x55, 0xAA, 0x55,
+ 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x41, 0x00,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x50, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x15, 0x50, 0x55, 0x15, 0x00, 0x00, 0x00, 0x40, 0x01, 0x00, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x05, 0x50, 0x55, 0x55, 0x55, 0x55, 0x05, 0x54, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x40, 0x15, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x54, 0x55, 0x51, 0x55, 0x55, 0x55,
+ 0x54, 0x55, 0x55, 0x55, 0x55, 0x15, 0x00, 0x01, 0x00, 0x00, 0x00, 0x55, 0x55, 0x55, 0x55,
+ 0x00, 0x40, 0x00, 0x00, 0x00, 0x00, 0x14, 0x00, 0x10, 0x04, 0x40, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x45, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x40, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x56, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x95, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xFF, 0xFF, 0x7F, 0x55, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0x5F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0x5F, 0x55, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xEF, 0xAB, 0xAA,
+ 0xEA, 0xFF, 0xFF, 0xFF, 0xFF, 0x57, 0x55, 0x55, 0x55, 0x55, 0x6A, 0x55, 0x55, 0x55, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0xAA, 0xAA, 0x56, 0x55,
+ 0x5A, 0x55, 0x55, 0x55, 0xAA, 0x5A, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x56, 0x55, 0x55, 0xA9, 0xAA, 0x9A, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xA6, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0x6A, 0x95, 0xAA, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0x56, 0x56, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0x6A, 0xA6, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0x96, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0x5A, 0x55, 0x55, 0x95, 0x6A, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA,
+ 0x55, 0x55, 0x55, 0x55, 0x65, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x69, 0x55, 0x55, 0x55,
+ 0x56, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x95, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA, 0x5A, 0x55, 0x56, 0x6A, 0xA9,
+ 0x55, 0xAA, 0x55, 0x55, 0x95, 0x56, 0x55, 0xAA, 0xAA, 0x56, 0x55, 0x55, 0x55, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0x55, 0x56, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x6A, 0xAA, 0xAA, 0x9A, 0xAA,
+ 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x55, 0x55,
+ 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0xAA, 0xAA, 0xAA, 0x56, 0xAA,
+ 0xAA, 0x56, 0x55, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0xAA, 0x9A,
+ 0xAA, 0x5A, 0x55, 0xA5, 0xAA, 0xAA, 0xAA, 0x55, 0xAA, 0xAA, 0x56, 0x55, 0xAA, 0xAA, 0x56,
+ 0x55, 0x51, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x55, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0x5F,
+ ];
+}
diff --git a/crates/unicode-width/src/tests.rs b/crates/unicode-width/src/tests.rs
new file mode 100644
index 0000000..e49b1bf
--- /dev/null
+++ b/crates/unicode-width/src/tests.rs
@@ -0,0 +1,191 @@
+// Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution and at
+// http://rust-lang.org/COPYRIGHT.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+#[cfg(feature = "bench")]
+use std::iter;
+#[cfg(feature = "bench")]
+use test::{self, Bencher};
+#[cfg(feature = "bench")]
+use super::{UnicodeWidthChar, UnicodeWidthStr};
+
+use std::prelude::v1::*;
+
+#[cfg(feature = "bench")]
+#[bench]
+fn cargo(b: &mut Bencher) {
+ let string = iter::repeat('a').take(4096).collect::<String>();
+
+ b.iter(|| {
+ for c in string.chars() {
+ test::black_box(UnicodeWidthChar::width(c));
+ }
+ });
+}
+
+#[cfg(feature = "bench")]
+#[bench]
+#[allow(deprecated)]
+fn stdlib(b: &mut Bencher) {
+ let string = iter::repeat('a').take(4096).collect::<String>();
+
+ b.iter(|| {
+ for c in string.chars() {
+ test::black_box(c.width());
+ }
+ });
+}
+
+#[cfg(feature = "bench")]
+#[bench]
+fn simple_if(b: &mut Bencher) {
+ let string = iter::repeat('a').take(4096).collect::<String>();
+
+ b.iter(|| {
+ for c in string.chars() {
+ test::black_box(simple_width_if(c));
+ }
+ });
+}
+
+#[cfg(feature = "bench")]
+#[bench]
+fn simple_match(b: &mut Bencher) {
+ let string = iter::repeat('a').take(4096).collect::<String>();
+
+ b.iter(|| {
+ for c in string.chars() {
+ test::black_box(simple_width_match(c));
+ }
+ });
+}
+
+#[cfg(feature = "bench")]
+#[inline]
+fn simple_width_if(c: char) -> Option<usize> {
+ let cu = c as u32;
+ if cu < 127 {
+ if cu > 31 {
+ Some(1)
+ } else if cu == 0 {
+ Some(0)
+ } else {
+ None
+ }
+ } else {
+ UnicodeWidthChar::width(c)
+ }
+}
+
+#[cfg(feature = "bench")]
+#[inline]
+fn simple_width_match(c: char) -> Option<usize> {
+ match c as u32 {
+ cu if cu == 0 => Some(0),
+ cu if cu < 0x20 => None,
+ cu if cu < 0x7f => Some(1),
+ _ => UnicodeWidthChar::width(c)
+ }
+}
+#[cfg(all(feature = "bench", not(feature = "no_std")))]
+#[bench]
+fn enwik8(b: &mut Bencher) {
+ // To benchmark, download & unzip `enwik8` from https://data.deepai.org/enwik8.zip
+ let data_path = "bench_data/enwik8";
+ let string = std::fs::read_to_string(data_path).unwrap_or_default();
+ b.iter(|| test::black_box(UnicodeWidthStr::width(string.as_str())));
+}
+#[cfg(all(feature = "bench", not(feature = "no_std")))]
+#[bench]
+fn jawiki(b: &mut Bencher) {
+ // To benchmark, download & extract `jawiki-20220501-pages-articles-multistream-index.txt` from
+ // https://dumps.wikimedia.org/jawiki/20220501/jawiki-20220501-pages-articles-multistream-index.txt.bz2
+ let data_path = "bench_data/jawiki-20220501-pages-articles-multistream-index.txt";
+ let string = std::fs::read_to_string(data_path).unwrap_or_default();
+ b.iter(|| test::black_box(UnicodeWidthStr::width(string.as_str())));
+}
+#[test]
+fn test_str() {
+ use super::UnicodeWidthStr;
+
+ assert_eq!(UnicodeWidthStr::width("ｈｅｌｌｏ"), 10);
+ assert_eq!("ｈｅｌｌｏ".width_cjk(), 10);
+ assert_eq!(UnicodeWidthStr::width("\0\0\0\x01\x01"), 0);
+ assert_eq!("\0\0\0\x01\x01".width_cjk(), 0);
+ assert_eq!(UnicodeWidthStr::width(""), 0);
+ assert_eq!("".width_cjk(), 0);
+ assert_eq!(UnicodeWidthStr::width("\u{2081}\u{2082}\u{2083}\u{2084}"), 4);
+ assert_eq!("\u{2081}\u{2082}\u{2083}\u{2084}".width_cjk(), 8);
+}
+
+#[test]
+fn test_emoji() {
+ // Example from the README.
+ use super::UnicodeWidthStr;
+
+ assert_eq!(UnicodeWidthStr::width("👩"), 2); // Woman
+ assert_eq!(UnicodeWidthStr::width("🔬"), 2); // Microscope
+ assert_eq!(UnicodeWidthStr::width("👩🔬"), 4); // Woman scientist
+}
+
+#[test]
+fn test_char() {
+ use super::UnicodeWidthChar;
+ #[cfg(feature = "no_std")]
+ use core::option::Option::{Some, None};
+
+ assert_eq!(UnicodeWidthChar::width('ｈ'), Some(2));
+ assert_eq!('ｈ'.width_cjk(), Some(2));
+ assert_eq!(UnicodeWidthChar::width('\x00'), Some(0));
+ assert_eq!('\x00'.width_cjk(), Some(0));
+ assert_eq!(UnicodeWidthChar::width('\x01'), None);
+ assert_eq!('\x01'.width_cjk(), None);
+ assert_eq!(UnicodeWidthChar::width('\u{2081}'), Some(1));
+ assert_eq!('\u{2081}'.width_cjk(), Some(2));
+}
+
+#[test]
+fn test_char2() {
+ use super::UnicodeWidthChar;
+ #[cfg(feature = "no_std")]
+ use core::option::Option::{Some, None};
+
+ assert_eq!(UnicodeWidthChar::width('\x00'),Some(0));
+ assert_eq!('\x00'.width_cjk(),Some(0));
+
+ assert_eq!(UnicodeWidthChar::width('\x0A'),None);
+ assert_eq!('\x0A'.width_cjk(),None);
+
+ assert_eq!(UnicodeWidthChar::width('w'),Some(1));
+ assert_eq!('w'.width_cjk(),Some(1));
+
+ assert_eq!(UnicodeWidthChar::width('ｈ'),Some(2));
+ assert_eq!('ｈ'.width_cjk(),Some(2));
+
+ assert_eq!(UnicodeWidthChar::width('\u{AD}'),Some(1));
+ assert_eq!('\u{AD}'.width_cjk(),Some(1));
+
+ assert_eq!(UnicodeWidthChar::width('\u{1160}'),Some(0));
+ assert_eq!('\u{1160}'.width_cjk(),Some(0));
+
+ assert_eq!(UnicodeWidthChar::width('\u{a1}'),Some(1));
+ assert_eq!('\u{a1}'.width_cjk(),Some(2));
+
+ assert_eq!(UnicodeWidthChar::width('\u{300}'),Some(0));
+ assert_eq!('\u{300}'.width_cjk(),Some(0));
+}
+
+#[test]
+fn unicode_12() {
+ use super::UnicodeWidthChar;
+ #[cfg(feature = "no_std")]
+ use core::option::Option::{Some, None};
+
+ assert_eq!(UnicodeWidthChar::width('\u{1F971}'), Some(2));
+}
diff --git a/crates/unsafe-libyaml/.cargo-checksum.json b/crates/unsafe-libyaml/.cargo-checksum.json
new file mode 100644
index 0000000..c9d5928
--- /dev/null
+++ b/crates/unsafe-libyaml/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.lock":"92c411cc2400eb0f728c361d6c034c5c35bfbf3529c35d3073eaad77ff20236b","Cargo.toml":"334907672c5fa362f494100bc4e8a2c541ea8fa905bd176c77620e48d125a573","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"ad60144882a003bb1f20a3bf286e518c8335f0301e7d06c101ef1bd5668e11dd","src/api.rs":"85b2fd0cf09ec7560e0a58215a05af3f44a4403bcf0c1eb91603ec149d67dfc0","src/bin/cstr/mod.rs":"ea7d6c8c1376c7cae56afc2ed365d16e5aabe6a0dda06e01954b90bb7ba8d038","src/bin/run-emitter-test-suite.rs":"55653f89cfc86f23237d84cadfa32119f5c0bad5f04374109254d359ae5116f6","src/bin/run-parser-test-suite.rs":"62390b5be838cb94c078024187274978290789df4f82144aabfca0c653fbb1b0","src/dumper.rs":"7baffe3c964bd99e9984dbc1ee8256ef990a4e93b4e1feb1767f45f522c65c9b","src/emitter.rs":"e2e5741bad8714f1772f83c77d7bf9b793763808aedc19cf6afd6b50983ac8da","src/lib.rs":"a49ca5a8362c86ad0779c08d32c0a7c3387ae7fb01dd3bbe601e8f7225cc2272","src/loader.rs":"a4b1def1986adace844b499bedd568bdf3ec0bbeceab02e42808d848d89a4115","src/macros.rs":"fb383fe61179b9bdbc77da57539b8211d7b7bc6775b6d7ce7d0d75249f63508a","src/ops.rs":"9716b7e16a430e7b45f3196e9659fa369fcda4e5117e18d2595f8ea75ce2340d","src/parser.rs":"27125c0a61b3df054b726a574ed883954ba8afbb91680dd371f4faff0dddd4b7","src/reader.rs":"3cff2f6aea01188f2d8ea8c6b210c5831b4316fed16ed96b0f3d79da048fb297","src/scanner.rs":"81ce9cc00232c6c0ba91694a24ed3cd9fb415281bcda5e25aa8309dda6058f5a","src/success.rs":"f1fe294ed595c7c5cf82cc113e6debbe970129878794ab1f1a5aab77e08f99f4","src/writer.rs":"9ce5f7fcaeaae73bcde9a7d8022dfbace4e8eb1867461d6b8af1f42688494dcb","src/yaml.rs":"a4ebf4cd39c46ef764a609b9502844e135a61337b7c106c7d3568e524c3ddbf3","tests/bin/mod.rs":"8b159a2bcfc7c59e18f1e2378959797384cca307b6a2b6940af79e26b27ea988","tests/ignorelist/libyaml-emitter":"3cdaa69d21c87bb3988536cf95747547793a5875e374cfe91c0b12fb2eaf2c15","tests/ignorelist/libyaml-parser":"60cf936e4e2acfd34ad397fab1c004c79f5bce7778eba2c5e89f1cf2478f6008","tests/ignorelist/libyaml-parser-error":"e57811f1660f02e7a58dd9394d0121b8ba8b8e3ba0553b906b82536bcdb80edf","tests/test_emitter.rs":"f49a1161370571c1ca9ad8a6c0bd21e7086c013a349eae2d121e7612b8d28222","tests/test_parser.rs":"0e33a9d27fb4b9d6c6f854f7bfd54d37cf8f6a049253226edbb2a0e0e674295a","tests/test_parser_error.rs":"bb0db7534704a7317bb1f987eaaac0852633f47e979c0cf00720cac5cea3bdf3"},"package":"ab4c90930b95a82d00dc9e9ac071b4991924390d46cbd0dfe566148667605e4b"}
\ No newline at end of file
diff --git a/crates/unsafe-libyaml/Android.bp b/crates/unsafe-libyaml/Android.bp
new file mode 100644
index 0000000..0f01014
--- /dev/null
+++ b/crates/unsafe-libyaml/Android.bp
@@ -0,0 +1,43 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_unsafe-libyaml_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_unsafe-libyaml_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library_host_rlib {
+ name: "libunsafe_libyaml",
+ crate_name: "unsafe_libyaml",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.10",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+}
+
+rust_binary_host {
+ name: "run_emitter_test_suite",
+ crate_name: "run_emitter_test_suite",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.10",
+ crate_root: "src/bin/run-emitter-test-suite.rs",
+ edition: "2021",
+ rustlibs: ["libunsafe_libyaml"],
+}
+
+rust_binary_host {
+ name: "run_parser_test_suite",
+ crate_name: "run_parser_test_suite",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.10",
+ crate_root: "src/bin/run-parser-test-suite.rs",
+ edition: "2021",
+ rustlibs: ["libunsafe_libyaml"],
+}
diff --git a/crates/unsafe-libyaml/Cargo.lock b/crates/unsafe-libyaml/Cargo.lock
new file mode 100644
index 0000000..d23197c
--- /dev/null
+++ b/crates/unsafe-libyaml/Cargo.lock
@@ -0,0 +1,32 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "diff"
+version = "0.1.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8"
+
+[[package]]
+name = "pretty_assertions"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "af7cee1a6c8a5b9208b3cb1061f10c0cb689087b3d8ce85fb9d2dd7a29b6ba66"
+dependencies = [
+ "diff",
+ "yansi",
+]
+
+[[package]]
+name = "unsafe-libyaml"
+version = "0.2.10"
+dependencies = [
+ "pretty_assertions",
+]
+
+[[package]]
+name = "yansi"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec"
diff --git a/crates/unsafe-libyaml/Cargo.toml b/crates/unsafe-libyaml/Cargo.toml
new file mode 100644
index 0000000..81e8a39
--- /dev/null
+++ b/crates/unsafe-libyaml/Cargo.toml
@@ -0,0 +1,38 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.56"
+name = "unsafe-libyaml"
+version = "0.2.10"
+authors = ["David Tolnay <[email protected]>"]
+description = "libyaml transpiled to rust by c2rust"
+documentation = "https://docs.rs/unsafe-libyaml"
+readme = "README.md"
+keywords = ["yaml"]
+categories = [
+ "encoding",
+ "parser-implementations",
+ "no-std",
+]
+license = "MIT"
+repository = "https://github.com/dtolnay/unsafe-libyaml"
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[lib]
+doc-scrape-examples = false
+
+[dev-dependencies.pretty_assertions]
+version = "1.0"
diff --git a/crates/unsafe-libyaml/LICENSE b/crates/unsafe-libyaml/LICENSE
new file mode 120000
index 0000000..7f9a88e
--- /dev/null
+++ b/crates/unsafe-libyaml/LICENSE
@@ -0,0 +1 @@
+LICENSE-MIT
\ No newline at end of file
diff --git a/crates/unsafe-libyaml/LICENSE-MIT b/crates/unsafe-libyaml/LICENSE-MIT
new file mode 100644
index 0000000..31aa793
--- /dev/null
+++ b/crates/unsafe-libyaml/LICENSE-MIT
@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/unsafe-libyaml/METADATA b/crates/unsafe-libyaml/METADATA
new file mode 100644
index 0000000..3bb4995
--- /dev/null
+++ b/crates/unsafe-libyaml/METADATA
@@ -0,0 +1,24 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/unsafe-libyaml
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "unsafe-libyaml"
+description: "libyaml transpiled to rust by c2rust"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 7
+ }
+ identifier {
+ type: "crates.io"
+ value: "https://static.crates.io/crates/unsafe-libyaml/unsafe-libyaml-0.2.10.crate"
+ version: "0.2.10"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/unsafe-libyaml/unsafe-libyaml-0.2.9.crate"
+ version: "0.2.10"
+ }
+}
diff --git a/crates/unsafe-libyaml/MODULE_LICENSE_MIT b/crates/unsafe-libyaml/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/unsafe-libyaml/MODULE_LICENSE_MIT
diff --git a/crates/unsafe-libyaml/README.md b/crates/unsafe-libyaml/README.md
new file mode 100644
index 0000000..bfe37a7
--- /dev/null
+++ b/crates/unsafe-libyaml/README.md
@@ -0,0 +1,24 @@
+unsafe-libyaml
+==============
+
+[<img alt="github" src="https://img.shields.io/badge/github-dtolnay/unsafe--libyaml-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/unsafe-libyaml)
+[<img alt="crates.io" src="https://img.shields.io/crates/v/unsafe-libyaml.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/unsafe-libyaml)
+[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-unsafe--libyaml-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" height="20">](https://docs.rs/unsafe-libyaml)
+[<img alt="build status" src="https://img.shields.io/github/actions/workflow/status/dtolnay/unsafe-libyaml/ci.yml?branch=master&style=for-the-badge" height="20">](https://github.com/dtolnay/unsafe-libyaml/actions?query=branch%3Amaster)
+
+This library is [libyaml] translated from C to unsafe Rust with the assistance
+of [c2rust].
+
+[libyaml]: https://github.com/yaml/libyaml/tree/2c891fc7a770e8ba2fec34fc6b545c672beb37e6
+[c2rust]: https://github.com/immunant/c2rust
+
+```toml
+[dependencies]
+unsafe-libyaml = "0.2"
+```
+
+*Compiler support: requires rustc 1.56+*
+
+## License
+
+<a href="LICENSE-MIT">MIT license</a>, same as libyaml.
diff --git a/crates/unsafe-libyaml/cargo_embargo.json b/crates/unsafe-libyaml/cargo_embargo.json
new file mode 100644
index 0000000..b7aeb95
--- /dev/null
+++ b/crates/unsafe-libyaml/cargo_embargo.json
@@ -0,0 +1,9 @@
+{
+ "package": {
+ "unsafe-libyaml": {
+ "device_supported": false,
+ "force_rlib": true
+ }
+ },
+ "run_cargo": false
+}
diff --git a/crates/unsafe-libyaml/src/api.rs b/crates/unsafe-libyaml/src/api.rs
new file mode 100644
index 0000000..c8bbcba
--- /dev/null
+++ b/crates/unsafe-libyaml/src/api.rs
@@ -0,0 +1,1549 @@
+use crate::externs::{free, malloc, memcpy, memmove, memset, realloc, strdup, strlen};
+use crate::ops::{ForceAdd as _, ForceMul as _};
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{size_t, yaml_char_t};
+use crate::{
+ libc, yaml_break_t, yaml_document_t, yaml_emitter_state_t, yaml_emitter_t, yaml_encoding_t,
+ yaml_event_t, yaml_mapping_style_t, yaml_mark_t, yaml_node_item_t, yaml_node_pair_t,
+ yaml_node_t, yaml_parser_state_t, yaml_parser_t, yaml_read_handler_t, yaml_scalar_style_t,
+ yaml_sequence_style_t, yaml_simple_key_t, yaml_tag_directive_t, yaml_token_t,
+ yaml_version_directive_t, yaml_write_handler_t, PointerExt, YAML_ALIAS_EVENT, YAML_ALIAS_TOKEN,
+ YAML_ANCHOR_TOKEN, YAML_ANY_ENCODING, YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_START_EVENT,
+ YAML_MAPPING_END_EVENT, YAML_MAPPING_NODE, YAML_MAPPING_START_EVENT, YAML_SCALAR_EVENT,
+ YAML_SCALAR_NODE, YAML_SCALAR_TOKEN, YAML_SEQUENCE_END_EVENT, YAML_SEQUENCE_NODE,
+ YAML_SEQUENCE_START_EVENT, YAML_STREAM_END_EVENT, YAML_STREAM_START_EVENT,
+ YAML_TAG_DIRECTIVE_TOKEN, YAML_TAG_TOKEN,
+};
+use core::mem::{size_of, MaybeUninit};
+use core::ptr::{self, addr_of_mut};
+
+const INPUT_RAW_BUFFER_SIZE: usize = 16384;
+const INPUT_BUFFER_SIZE: usize = INPUT_RAW_BUFFER_SIZE * 3;
+const OUTPUT_BUFFER_SIZE: usize = 16384;
+const OUTPUT_RAW_BUFFER_SIZE: usize = OUTPUT_BUFFER_SIZE * 2 + 2;
+
+pub(crate) unsafe fn yaml_malloc(size: size_t) -> *mut libc::c_void {
+ malloc(size)
+}
+
+pub(crate) unsafe fn yaml_realloc(ptr: *mut libc::c_void, size: size_t) -> *mut libc::c_void {
+ if !ptr.is_null() {
+ realloc(ptr, size)
+ } else {
+ malloc(size)
+ }
+}
+
+pub(crate) unsafe fn yaml_free(ptr: *mut libc::c_void) {
+ if !ptr.is_null() {
+ free(ptr);
+ }
+}
+
+pub(crate) unsafe fn yaml_strdup(str: *const yaml_char_t) -> *mut yaml_char_t {
+ if str.is_null() {
+ return ptr::null_mut::<yaml_char_t>();
+ }
+ strdup(str as *mut libc::c_char) as *mut yaml_char_t
+}
+
+pub(crate) unsafe fn yaml_string_extend(
+ start: *mut *mut yaml_char_t,
+ pointer: *mut *mut yaml_char_t,
+ end: *mut *mut yaml_char_t,
+) {
+ let new_start: *mut yaml_char_t = yaml_realloc(
+ *start as *mut libc::c_void,
+ (((*end).c_offset_from(*start) as libc::c_long).force_mul(2_i64)) as size_t,
+ ) as *mut yaml_char_t;
+ memset(
+ new_start.wrapping_offset((*end).c_offset_from(*start) as libc::c_long as isize)
+ as *mut libc::c_void,
+ 0,
+ (*end).c_offset_from(*start) as libc::c_ulong,
+ );
+ *pointer = new_start.wrapping_offset((*pointer).c_offset_from(*start) as libc::c_long as isize);
+ *end = new_start.wrapping_offset(
+ (((*end).c_offset_from(*start) as libc::c_long).force_mul(2_i64)) as isize,
+ );
+ *start = new_start;
+}
+
+pub(crate) unsafe fn yaml_string_join(
+ a_start: *mut *mut yaml_char_t,
+ a_pointer: *mut *mut yaml_char_t,
+ a_end: *mut *mut yaml_char_t,
+ b_start: *mut *mut yaml_char_t,
+ b_pointer: *mut *mut yaml_char_t,
+ _b_end: *mut *mut yaml_char_t,
+) {
+ if *b_start == *b_pointer {
+ return;
+ }
+ while (*a_end).c_offset_from(*a_pointer) as libc::c_long
+ <= (*b_pointer).c_offset_from(*b_start) as libc::c_long
+ {
+ yaml_string_extend(a_start, a_pointer, a_end);
+ }
+ memcpy(
+ *a_pointer as *mut libc::c_void,
+ *b_start as *const libc::c_void,
+ (*b_pointer).c_offset_from(*b_start) as libc::c_ulong,
+ );
+ *a_pointer =
+ (*a_pointer).wrapping_offset((*b_pointer).c_offset_from(*b_start) as libc::c_long as isize);
+}
+
+pub(crate) unsafe fn yaml_stack_extend(
+ start: *mut *mut libc::c_void,
+ top: *mut *mut libc::c_void,
+ end: *mut *mut libc::c_void,
+) {
+ let new_start: *mut libc::c_void = yaml_realloc(
+ *start,
+ (((*end as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char) as libc::c_long)
+ .force_mul(2_i64)) as size_t,
+ );
+ *top = (new_start as *mut libc::c_char).wrapping_offset(
+ (*top as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char) as libc::c_long
+ as isize,
+ ) as *mut libc::c_void;
+ *end = (new_start as *mut libc::c_char).wrapping_offset(
+ (((*end as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char) as libc::c_long)
+ .force_mul(2_i64)) as isize,
+ ) as *mut libc::c_void;
+ *start = new_start;
+}
+
+pub(crate) unsafe fn yaml_queue_extend(
+ start: *mut *mut libc::c_void,
+ head: *mut *mut libc::c_void,
+ tail: *mut *mut libc::c_void,
+ end: *mut *mut libc::c_void,
+) {
+ if *start == *head && *tail == *end {
+ let new_start: *mut libc::c_void = yaml_realloc(
+ *start,
+ (((*end as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char)
+ as libc::c_long)
+ .force_mul(2_i64)) as size_t,
+ );
+ *head = (new_start as *mut libc::c_char).wrapping_offset(
+ (*head as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char) as libc::c_long
+ as isize,
+ ) as *mut libc::c_void;
+ *tail = (new_start as *mut libc::c_char).wrapping_offset(
+ (*tail as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char) as libc::c_long
+ as isize,
+ ) as *mut libc::c_void;
+ *end = (new_start as *mut libc::c_char).wrapping_offset(
+ (((*end as *mut libc::c_char).c_offset_from(*start as *mut libc::c_char)
+ as libc::c_long)
+ .force_mul(2_i64)) as isize,
+ ) as *mut libc::c_void;
+ *start = new_start;
+ }
+ if *tail == *end {
+ if *head != *tail {
+ memmove(
+ *start,
+ *head,
+ (*tail as *mut libc::c_char).c_offset_from(*head as *mut libc::c_char)
+ as libc::c_ulong,
+ );
+ }
+ *tail = (*start as *mut libc::c_char).wrapping_offset(
+ (*tail as *mut libc::c_char).c_offset_from(*head as *mut libc::c_char) as libc::c_long
+ as isize,
+ ) as *mut libc::c_void;
+ *head = *start;
+ }
+}
+
+/// Initialize a parser.
+///
+/// This function creates a new parser object. An application is responsible
+/// for destroying the object using the yaml_parser_delete() function.
+pub unsafe fn yaml_parser_initialize(parser: *mut yaml_parser_t) -> Success {
+ __assert!(!parser.is_null());
+ memset(
+ parser as *mut libc::c_void,
+ 0,
+ size_of::<yaml_parser_t>() as libc::c_ulong,
+ );
+ BUFFER_INIT!((*parser).raw_buffer, INPUT_RAW_BUFFER_SIZE);
+ BUFFER_INIT!((*parser).buffer, INPUT_BUFFER_SIZE);
+ QUEUE_INIT!((*parser).tokens, yaml_token_t);
+ STACK_INIT!((*parser).indents, libc::c_int);
+ STACK_INIT!((*parser).simple_keys, yaml_simple_key_t);
+ STACK_INIT!((*parser).states, yaml_parser_state_t);
+ STACK_INIT!((*parser).marks, yaml_mark_t);
+ STACK_INIT!((*parser).tag_directives, yaml_tag_directive_t);
+ OK
+}
+
+/// Destroy a parser.
+pub unsafe fn yaml_parser_delete(parser: *mut yaml_parser_t) {
+ __assert!(!parser.is_null());
+ BUFFER_DEL!((*parser).raw_buffer);
+ BUFFER_DEL!((*parser).buffer);
+ while !QUEUE_EMPTY!((*parser).tokens) {
+ yaml_token_delete(addr_of_mut!(DEQUEUE!((*parser).tokens)));
+ }
+ QUEUE_DEL!((*parser).tokens);
+ STACK_DEL!((*parser).indents);
+ STACK_DEL!((*parser).simple_keys);
+ STACK_DEL!((*parser).states);
+ STACK_DEL!((*parser).marks);
+ while !STACK_EMPTY!((*parser).tag_directives) {
+ let tag_directive = POP!((*parser).tag_directives);
+ yaml_free(tag_directive.handle as *mut libc::c_void);
+ yaml_free(tag_directive.prefix as *mut libc::c_void);
+ }
+ STACK_DEL!((*parser).tag_directives);
+ memset(
+ parser as *mut libc::c_void,
+ 0,
+ size_of::<yaml_parser_t>() as libc::c_ulong,
+ );
+}
+
+unsafe fn yaml_string_read_handler(
+ data: *mut libc::c_void,
+ buffer: *mut libc::c_uchar,
+ mut size: size_t,
+ size_read: *mut size_t,
+) -> libc::c_int {
+ let parser: *mut yaml_parser_t = data as *mut yaml_parser_t;
+ if (*parser).input.string.current == (*parser).input.string.end {
+ *size_read = 0_u64;
+ return 1;
+ }
+ if size
+ > (*parser)
+ .input
+ .string
+ .end
+ .c_offset_from((*parser).input.string.current) as size_t
+ {
+ size = (*parser)
+ .input
+ .string
+ .end
+ .c_offset_from((*parser).input.string.current) as size_t;
+ }
+ memcpy(
+ buffer as *mut libc::c_void,
+ (*parser).input.string.current as *const libc::c_void,
+ size,
+ );
+ let fresh80 = addr_of_mut!((*parser).input.string.current);
+ *fresh80 = (*fresh80).wrapping_offset(size as isize);
+ *size_read = size;
+ 1
+}
+
+/// Set a string input.
+///
+/// Note that the `input` pointer must be valid while the `parser` object
+/// exists. The application is responsible for destroying `input` after
+/// destroying the `parser`.
+pub unsafe fn yaml_parser_set_input_string(
+ parser: *mut yaml_parser_t,
+ input: *const libc::c_uchar,
+ size: size_t,
+) {
+ __assert!(!parser.is_null());
+ __assert!(((*parser).read_handler).is_none());
+ __assert!(!input.is_null());
+ let fresh81 = addr_of_mut!((*parser).read_handler);
+ *fresh81 = Some(
+ yaml_string_read_handler
+ as unsafe fn(*mut libc::c_void, *mut libc::c_uchar, size_t, *mut size_t) -> libc::c_int,
+ );
+ let fresh82 = addr_of_mut!((*parser).read_handler_data);
+ *fresh82 = parser as *mut libc::c_void;
+ let fresh83 = addr_of_mut!((*parser).input.string.start);
+ *fresh83 = input;
+ let fresh84 = addr_of_mut!((*parser).input.string.current);
+ *fresh84 = input;
+ let fresh85 = addr_of_mut!((*parser).input.string.end);
+ *fresh85 = input.wrapping_offset(size as isize);
+}
+
+/// Set a generic input handler.
+pub unsafe fn yaml_parser_set_input(
+ parser: *mut yaml_parser_t,
+ handler: yaml_read_handler_t,
+ data: *mut libc::c_void,
+) {
+ __assert!(!parser.is_null());
+ __assert!(((*parser).read_handler).is_none());
+ let fresh89 = addr_of_mut!((*parser).read_handler);
+ *fresh89 = Some(handler);
+ let fresh90 = addr_of_mut!((*parser).read_handler_data);
+ *fresh90 = data;
+}
+
+/// Set the source encoding.
+pub unsafe fn yaml_parser_set_encoding(parser: *mut yaml_parser_t, encoding: yaml_encoding_t) {
+ __assert!(!parser.is_null());
+ __assert!((*parser).encoding == YAML_ANY_ENCODING);
+ (*parser).encoding = encoding;
+}
+
+/// Initialize an emitter.
+///
+/// This function creates a new emitter object. An application is responsible
+/// for destroying the object using the yaml_emitter_delete() function.
+pub unsafe fn yaml_emitter_initialize(emitter: *mut yaml_emitter_t) -> Success {
+ __assert!(!emitter.is_null());
+ memset(
+ emitter as *mut libc::c_void,
+ 0,
+ size_of::<yaml_emitter_t>() as libc::c_ulong,
+ );
+ BUFFER_INIT!((*emitter).buffer, OUTPUT_BUFFER_SIZE);
+ BUFFER_INIT!((*emitter).raw_buffer, OUTPUT_RAW_BUFFER_SIZE);
+ STACK_INIT!((*emitter).states, yaml_emitter_state_t);
+ QUEUE_INIT!((*emitter).events, yaml_event_t);
+ STACK_INIT!((*emitter).indents, libc::c_int);
+ STACK_INIT!((*emitter).tag_directives, yaml_tag_directive_t);
+ OK
+}
+
+/// Destroy an emitter.
+pub unsafe fn yaml_emitter_delete(emitter: *mut yaml_emitter_t) {
+ __assert!(!emitter.is_null());
+ BUFFER_DEL!((*emitter).buffer);
+ BUFFER_DEL!((*emitter).raw_buffer);
+ STACK_DEL!((*emitter).states);
+ while !QUEUE_EMPTY!((*emitter).events) {
+ yaml_event_delete(addr_of_mut!(DEQUEUE!((*emitter).events)));
+ }
+ QUEUE_DEL!((*emitter).events);
+ STACK_DEL!((*emitter).indents);
+ while !STACK_EMPTY!((*emitter).tag_directives) {
+ let tag_directive = POP!((*emitter).tag_directives);
+ yaml_free(tag_directive.handle as *mut libc::c_void);
+ yaml_free(tag_directive.prefix as *mut libc::c_void);
+ }
+ STACK_DEL!((*emitter).tag_directives);
+ yaml_free((*emitter).anchors as *mut libc::c_void);
+ memset(
+ emitter as *mut libc::c_void,
+ 0,
+ size_of::<yaml_emitter_t>() as libc::c_ulong,
+ );
+}
+
+unsafe fn yaml_string_write_handler(
+ data: *mut libc::c_void,
+ buffer: *mut libc::c_uchar,
+ size: size_t,
+) -> libc::c_int {
+ let emitter: *mut yaml_emitter_t = data as *mut yaml_emitter_t;
+ if (*emitter)
+ .output
+ .string
+ .size
+ .wrapping_sub(*(*emitter).output.string.size_written)
+ < size
+ {
+ memcpy(
+ (*emitter)
+ .output
+ .string
+ .buffer
+ .wrapping_offset(*(*emitter).output.string.size_written as isize)
+ as *mut libc::c_void,
+ buffer as *const libc::c_void,
+ (*emitter)
+ .output
+ .string
+ .size
+ .wrapping_sub(*(*emitter).output.string.size_written),
+ );
+ *(*emitter).output.string.size_written = (*emitter).output.string.size;
+ return 0;
+ }
+ memcpy(
+ (*emitter)
+ .output
+ .string
+ .buffer
+ .wrapping_offset(*(*emitter).output.string.size_written as isize)
+ as *mut libc::c_void,
+ buffer as *const libc::c_void,
+ size,
+ );
+ let fresh153 = addr_of_mut!((*(*emitter).output.string.size_written));
+ *fresh153 = (*fresh153 as libc::c_ulong).force_add(size) as size_t;
+ 1
+}
+
+/// Set a string output.
+///
+/// The emitter will write the output characters to the `output` buffer of the
+/// size `size`. The emitter will set `size_written` to the number of written
+/// bytes. If the buffer is smaller than required, the emitter produces the
+/// YAML_WRITE_ERROR error.
+pub unsafe fn yaml_emitter_set_output_string(
+ emitter: *mut yaml_emitter_t,
+ output: *mut libc::c_uchar,
+ size: size_t,
+ size_written: *mut size_t,
+) {
+ __assert!(!emitter.is_null());
+ __assert!(((*emitter).write_handler).is_none());
+ __assert!(!output.is_null());
+ let fresh154 = addr_of_mut!((*emitter).write_handler);
+ *fresh154 = Some(
+ yaml_string_write_handler
+ as unsafe fn(*mut libc::c_void, *mut libc::c_uchar, size_t) -> libc::c_int,
+ );
+ let fresh155 = addr_of_mut!((*emitter).write_handler_data);
+ *fresh155 = emitter as *mut libc::c_void;
+ let fresh156 = addr_of_mut!((*emitter).output.string.buffer);
+ *fresh156 = output;
+ (*emitter).output.string.size = size;
+ let fresh157 = addr_of_mut!((*emitter).output.string.size_written);
+ *fresh157 = size_written;
+ *size_written = 0_u64;
+}
+
+/// Set a generic output handler.
+pub unsafe fn yaml_emitter_set_output(
+ emitter: *mut yaml_emitter_t,
+ handler: yaml_write_handler_t,
+ data: *mut libc::c_void,
+) {
+ __assert!(!emitter.is_null());
+ __assert!(((*emitter).write_handler).is_none());
+ let fresh161 = addr_of_mut!((*emitter).write_handler);
+ *fresh161 = Some(handler);
+ let fresh162 = addr_of_mut!((*emitter).write_handler_data);
+ *fresh162 = data;
+}
+
+/// Set the output encoding.
+pub unsafe fn yaml_emitter_set_encoding(emitter: *mut yaml_emitter_t, encoding: yaml_encoding_t) {
+ __assert!(!emitter.is_null());
+ __assert!((*emitter).encoding == YAML_ANY_ENCODING);
+ (*emitter).encoding = encoding;
+}
+
+/// Set if the output should be in the "canonical" format as in the YAML
+/// specification.
+pub unsafe fn yaml_emitter_set_canonical(emitter: *mut yaml_emitter_t, canonical: bool) {
+ __assert!(!emitter.is_null());
+ (*emitter).canonical = canonical;
+}
+
+/// Set the indentation increment.
+pub unsafe fn yaml_emitter_set_indent(emitter: *mut yaml_emitter_t, indent: libc::c_int) {
+ __assert!(!emitter.is_null());
+ (*emitter).best_indent = if 1 < indent && indent < 10 { indent } else { 2 };
+}
+
+/// Set the preferred line width. -1 means unlimited.
+pub unsafe fn yaml_emitter_set_width(emitter: *mut yaml_emitter_t, width: libc::c_int) {
+ __assert!(!emitter.is_null());
+ (*emitter).best_width = if width >= 0 { width } else { -1 };
+}
+
+/// Set if unescaped non-ASCII characters are allowed.
+pub unsafe fn yaml_emitter_set_unicode(emitter: *mut yaml_emitter_t, unicode: bool) {
+ __assert!(!emitter.is_null());
+ (*emitter).unicode = unicode;
+}
+
+/// Set the preferred line break.
+pub unsafe fn yaml_emitter_set_break(emitter: *mut yaml_emitter_t, line_break: yaml_break_t) {
+ __assert!(!emitter.is_null());
+ (*emitter).line_break = line_break;
+}
+
+/// Free any memory allocated for a token object.
+pub unsafe fn yaml_token_delete(token: *mut yaml_token_t) {
+ __assert!(!token.is_null());
+ match (*token).type_ {
+ YAML_TAG_DIRECTIVE_TOKEN => {
+ yaml_free((*token).data.tag_directive.handle as *mut libc::c_void);
+ yaml_free((*token).data.tag_directive.prefix as *mut libc::c_void);
+ }
+ YAML_ALIAS_TOKEN => {
+ yaml_free((*token).data.alias.value as *mut libc::c_void);
+ }
+ YAML_ANCHOR_TOKEN => {
+ yaml_free((*token).data.anchor.value as *mut libc::c_void);
+ }
+ YAML_TAG_TOKEN => {
+ yaml_free((*token).data.tag.handle as *mut libc::c_void);
+ yaml_free((*token).data.tag.suffix as *mut libc::c_void);
+ }
+ YAML_SCALAR_TOKEN => {
+ yaml_free((*token).data.scalar.value as *mut libc::c_void);
+ }
+ _ => {}
+ }
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+}
+
+unsafe fn yaml_check_utf8(start: *const yaml_char_t, length: size_t) -> Success {
+ let end: *const yaml_char_t = start.wrapping_offset(length as isize);
+ let mut pointer: *const yaml_char_t = start;
+ while pointer < end {
+ let mut octet: libc::c_uchar;
+ let mut value: libc::c_uint;
+ let mut k: size_t;
+ octet = *pointer;
+ let width: libc::c_uint = if octet & 0x80 == 0 {
+ 1
+ } else if octet & 0xE0 == 0xC0 {
+ 2
+ } else if octet & 0xF0 == 0xE0 {
+ 3
+ } else if octet & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ } as libc::c_uint;
+ value = if octet & 0x80 == 0 {
+ octet & 0x7F
+ } else if octet & 0xE0 == 0xC0 {
+ octet & 0x1F
+ } else if octet & 0xF0 == 0xE0 {
+ octet & 0xF
+ } else if octet & 0xF8 == 0xF0 {
+ octet & 0x7
+ } else {
+ 0
+ } as libc::c_uint;
+ if width == 0 {
+ return FAIL;
+ }
+ if pointer.wrapping_offset(width as isize) > end {
+ return FAIL;
+ }
+ k = 1_u64;
+ while k < width as libc::c_ulong {
+ octet = *pointer.wrapping_offset(k as isize);
+ if octet & 0xC0 != 0x80 {
+ return FAIL;
+ }
+ value = (value << 6).force_add((octet & 0x3F) as libc::c_uint);
+ k = k.force_add(1);
+ }
+ if !(width == 1
+ || width == 2 && value >= 0x80
+ || width == 3 && value >= 0x800
+ || width == 4 && value >= 0x10000)
+ {
+ return FAIL;
+ }
+ pointer = pointer.wrapping_offset(width as isize);
+ }
+ OK
+}
+
+/// Create the STREAM-START event.
+pub unsafe fn yaml_stream_start_event_initialize(
+ event: *mut yaml_event_t,
+ encoding: yaml_encoding_t,
+) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.stream_start.encoding = encoding;
+ OK
+}
+
+/// Create the STREAM-END event.
+pub unsafe fn yaml_stream_end_event_initialize(event: *mut yaml_event_t) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ OK
+}
+
+/// Create the DOCUMENT-START event.
+///
+/// The `implicit` argument is considered as a stylistic parameter and may be
+/// ignored by the emitter.
+pub unsafe fn yaml_document_start_event_initialize(
+ event: *mut yaml_event_t,
+ version_directive: *mut yaml_version_directive_t,
+ tag_directives_start: *mut yaml_tag_directive_t,
+ tag_directives_end: *mut yaml_tag_directive_t,
+ implicit: bool,
+) -> Success {
+ let current_block: u64;
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut version_directive_copy: *mut yaml_version_directive_t =
+ ptr::null_mut::<yaml_version_directive_t>();
+ struct TagDirectivesCopy {
+ start: *mut yaml_tag_directive_t,
+ end: *mut yaml_tag_directive_t,
+ top: *mut yaml_tag_directive_t,
+ }
+ let mut tag_directives_copy = TagDirectivesCopy {
+ start: ptr::null_mut::<yaml_tag_directive_t>(),
+ end: ptr::null_mut::<yaml_tag_directive_t>(),
+ top: ptr::null_mut::<yaml_tag_directive_t>(),
+ };
+ let mut value = yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ };
+ __assert!(!event.is_null());
+ __assert!(
+ !tag_directives_start.is_null() && !tag_directives_end.is_null()
+ || tag_directives_start == tag_directives_end
+ );
+ if !version_directive.is_null() {
+ version_directive_copy = yaml_malloc(size_of::<yaml_version_directive_t>() as libc::c_ulong)
+ as *mut yaml_version_directive_t;
+ (*version_directive_copy).major = (*version_directive).major;
+ (*version_directive_copy).minor = (*version_directive).minor;
+ }
+ if tag_directives_start != tag_directives_end {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ STACK_INIT!(tag_directives_copy, yaml_tag_directive_t);
+ tag_directive = tag_directives_start;
+ loop {
+ if !(tag_directive != tag_directives_end) {
+ current_block = 16203760046146113240;
+ break;
+ }
+ __assert!(!((*tag_directive).handle).is_null());
+ __assert!(!((*tag_directive).prefix).is_null());
+ if yaml_check_utf8(
+ (*tag_directive).handle,
+ strlen((*tag_directive).handle as *mut libc::c_char),
+ )
+ .fail
+ {
+ current_block = 14964981520188694172;
+ break;
+ }
+ if yaml_check_utf8(
+ (*tag_directive).prefix,
+ strlen((*tag_directive).prefix as *mut libc::c_char),
+ )
+ .fail
+ {
+ current_block = 14964981520188694172;
+ break;
+ }
+ value.handle = yaml_strdup((*tag_directive).handle);
+ value.prefix = yaml_strdup((*tag_directive).prefix);
+ if value.handle.is_null() || value.prefix.is_null() {
+ current_block = 14964981520188694172;
+ break;
+ }
+ PUSH!(tag_directives_copy, value);
+ value.handle = ptr::null_mut::<yaml_char_t>();
+ value.prefix = ptr::null_mut::<yaml_char_t>();
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ } else {
+ current_block = 16203760046146113240;
+ }
+ if current_block != 14964981520188694172 {
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh164 = addr_of_mut!((*event).data.document_start.version_directive);
+ *fresh164 = version_directive_copy;
+ let fresh165 = addr_of_mut!((*event).data.document_start.tag_directives.start);
+ *fresh165 = tag_directives_copy.start;
+ let fresh166 = addr_of_mut!((*event).data.document_start.tag_directives.end);
+ *fresh166 = tag_directives_copy.top;
+ (*event).data.document_start.implicit = implicit;
+ return OK;
+ }
+ yaml_free(version_directive_copy as *mut libc::c_void);
+ while !STACK_EMPTY!(tag_directives_copy) {
+ let value = POP!(tag_directives_copy);
+ yaml_free(value.handle as *mut libc::c_void);
+ yaml_free(value.prefix as *mut libc::c_void);
+ }
+ STACK_DEL!(tag_directives_copy);
+ yaml_free(value.handle as *mut libc::c_void);
+ yaml_free(value.prefix as *mut libc::c_void);
+ FAIL
+}
+
+/// Create the DOCUMENT-END event.
+///
+/// The `implicit` argument is considered as a stylistic parameter and may be
+/// ignored by the emitter.
+pub unsafe fn yaml_document_end_event_initialize(
+ event: *mut yaml_event_t,
+ implicit: bool,
+) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.document_end.implicit = implicit;
+ OK
+}
+
+/// Create an ALIAS event.
+pub unsafe fn yaml_alias_event_initialize(
+ event: *mut yaml_event_t,
+ anchor: *const yaml_char_t,
+) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ __assert!(!anchor.is_null());
+ if yaml_check_utf8(anchor, strlen(anchor as *mut libc::c_char)).fail {
+ return FAIL;
+ }
+ let anchor_copy: *mut yaml_char_t = yaml_strdup(anchor);
+ if anchor_copy.is_null() {
+ return FAIL;
+ }
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_ALIAS_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh167 = addr_of_mut!((*event).data.alias.anchor);
+ *fresh167 = anchor_copy;
+ OK
+}
+
+/// Create a SCALAR event.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Either the `tag` attribute or one of the `plain_implicit` and
+/// `quoted_implicit` flags must be set.
+///
+pub unsafe fn yaml_scalar_event_initialize(
+ event: *mut yaml_event_t,
+ anchor: *const yaml_char_t,
+ tag: *const yaml_char_t,
+ value: *const yaml_char_t,
+ mut length: libc::c_int,
+ plain_implicit: bool,
+ quoted_implicit: bool,
+ style: yaml_scalar_style_t,
+) -> Success {
+ let mut current_block: u64;
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut anchor_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut value_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ __assert!(!event.is_null());
+ __assert!(!value.is_null());
+ if !anchor.is_null() {
+ if yaml_check_utf8(anchor, strlen(anchor as *mut libc::c_char)).fail {
+ current_block = 16285396129609901221;
+ } else {
+ anchor_copy = yaml_strdup(anchor);
+ if anchor_copy.is_null() {
+ current_block = 16285396129609901221;
+ } else {
+ current_block = 8515828400728868193;
+ }
+ }
+ } else {
+ current_block = 8515828400728868193;
+ }
+ if current_block == 8515828400728868193 {
+ if !tag.is_null() {
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).fail {
+ current_block = 16285396129609901221;
+ } else {
+ tag_copy = yaml_strdup(tag);
+ if tag_copy.is_null() {
+ current_block = 16285396129609901221;
+ } else {
+ current_block = 12800627514080957624;
+ }
+ }
+ } else {
+ current_block = 12800627514080957624;
+ }
+ if current_block != 16285396129609901221 {
+ if length < 0 {
+ length = strlen(value as *mut libc::c_char) as libc::c_int;
+ }
+ if yaml_check_utf8(value, length as size_t).ok {
+ value_copy = yaml_malloc(length.force_add(1) as size_t) as *mut yaml_char_t;
+ memcpy(
+ value_copy as *mut libc::c_void,
+ value as *const libc::c_void,
+ length as libc::c_ulong,
+ );
+ *value_copy.wrapping_offset(length as isize) = b'\0';
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SCALAR_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh168 = addr_of_mut!((*event).data.scalar.anchor);
+ *fresh168 = anchor_copy;
+ let fresh169 = addr_of_mut!((*event).data.scalar.tag);
+ *fresh169 = tag_copy;
+ let fresh170 = addr_of_mut!((*event).data.scalar.value);
+ *fresh170 = value_copy;
+ (*event).data.scalar.length = length as size_t;
+ (*event).data.scalar.plain_implicit = plain_implicit;
+ (*event).data.scalar.quoted_implicit = quoted_implicit;
+ (*event).data.scalar.style = style;
+ return OK;
+ }
+ }
+ }
+ yaml_free(anchor_copy as *mut libc::c_void);
+ yaml_free(tag_copy as *mut libc::c_void);
+ yaml_free(value_copy as *mut libc::c_void);
+ FAIL
+}
+
+/// Create a SEQUENCE-START event.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Either the `tag` attribute or the `implicit` flag must be set.
+pub unsafe fn yaml_sequence_start_event_initialize(
+ event: *mut yaml_event_t,
+ anchor: *const yaml_char_t,
+ tag: *const yaml_char_t,
+ implicit: bool,
+ style: yaml_sequence_style_t,
+) -> Success {
+ let mut current_block: u64;
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut anchor_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ __assert!(!event.is_null());
+ if !anchor.is_null() {
+ if yaml_check_utf8(anchor, strlen(anchor as *mut libc::c_char)).fail {
+ current_block = 8817775685815971442;
+ } else {
+ anchor_copy = yaml_strdup(anchor);
+ if anchor_copy.is_null() {
+ current_block = 8817775685815971442;
+ } else {
+ current_block = 11006700562992250127;
+ }
+ }
+ } else {
+ current_block = 11006700562992250127;
+ }
+ match current_block {
+ 11006700562992250127 => {
+ if !tag.is_null() {
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).fail {
+ current_block = 8817775685815971442;
+ } else {
+ tag_copy = yaml_strdup(tag);
+ if tag_copy.is_null() {
+ current_block = 8817775685815971442;
+ } else {
+ current_block = 7651349459974463963;
+ }
+ }
+ } else {
+ current_block = 7651349459974463963;
+ }
+ if current_block != 8817775685815971442 {
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh171 = addr_of_mut!((*event).data.sequence_start.anchor);
+ *fresh171 = anchor_copy;
+ let fresh172 = addr_of_mut!((*event).data.sequence_start.tag);
+ *fresh172 = tag_copy;
+ (*event).data.sequence_start.implicit = implicit;
+ (*event).data.sequence_start.style = style;
+ return OK;
+ }
+ }
+ _ => {}
+ }
+ yaml_free(anchor_copy as *mut libc::c_void);
+ yaml_free(tag_copy as *mut libc::c_void);
+ FAIL
+}
+
+/// Create a SEQUENCE-END event.
+pub unsafe fn yaml_sequence_end_event_initialize(event: *mut yaml_event_t) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ OK
+}
+
+/// Create a MAPPING-START event.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Either the `tag` attribute or the `implicit` flag must be set.
+pub unsafe fn yaml_mapping_start_event_initialize(
+ event: *mut yaml_event_t,
+ anchor: *const yaml_char_t,
+ tag: *const yaml_char_t,
+ implicit: bool,
+ style: yaml_mapping_style_t,
+) -> Success {
+ let mut current_block: u64;
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut anchor_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ __assert!(!event.is_null());
+ if !anchor.is_null() {
+ if yaml_check_utf8(anchor, strlen(anchor as *mut libc::c_char)).fail {
+ current_block = 14748279734549812740;
+ } else {
+ anchor_copy = yaml_strdup(anchor);
+ if anchor_copy.is_null() {
+ current_block = 14748279734549812740;
+ } else {
+ current_block = 11006700562992250127;
+ }
+ }
+ } else {
+ current_block = 11006700562992250127;
+ }
+ if current_block == 11006700562992250127 {
+ if !tag.is_null() {
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).fail {
+ current_block = 14748279734549812740;
+ } else {
+ tag_copy = yaml_strdup(tag);
+ if tag_copy.is_null() {
+ current_block = 14748279734549812740;
+ } else {
+ current_block = 7651349459974463963;
+ }
+ }
+ } else {
+ current_block = 7651349459974463963;
+ }
+ if current_block != 14748279734549812740 {
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh173 = addr_of_mut!((*event).data.mapping_start.anchor);
+ *fresh173 = anchor_copy;
+ let fresh174 = addr_of_mut!((*event).data.mapping_start.tag);
+ *fresh174 = tag_copy;
+ (*event).data.mapping_start.implicit = implicit;
+ (*event).data.mapping_start.style = style;
+ return OK;
+ }
+ }
+ yaml_free(anchor_copy as *mut libc::c_void);
+ yaml_free(tag_copy as *mut libc::c_void);
+ FAIL
+}
+
+/// Create a MAPPING-END event.
+pub unsafe fn yaml_mapping_end_event_initialize(event: *mut yaml_event_t) -> Success {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ OK
+}
+
+/// Free any memory allocated for an event object.
+pub unsafe fn yaml_event_delete(event: *mut yaml_event_t) {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ __assert!(!event.is_null());
+ match (*event).type_ {
+ YAML_DOCUMENT_START_EVENT => {
+ yaml_free((*event).data.document_start.version_directive as *mut libc::c_void);
+ tag_directive = (*event).data.document_start.tag_directives.start;
+ while tag_directive != (*event).data.document_start.tag_directives.end {
+ yaml_free((*tag_directive).handle as *mut libc::c_void);
+ yaml_free((*tag_directive).prefix as *mut libc::c_void);
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ yaml_free((*event).data.document_start.tag_directives.start as *mut libc::c_void);
+ }
+ YAML_ALIAS_EVENT => {
+ yaml_free((*event).data.alias.anchor as *mut libc::c_void);
+ }
+ YAML_SCALAR_EVENT => {
+ yaml_free((*event).data.scalar.anchor as *mut libc::c_void);
+ yaml_free((*event).data.scalar.tag as *mut libc::c_void);
+ yaml_free((*event).data.scalar.value as *mut libc::c_void);
+ }
+ YAML_SEQUENCE_START_EVENT => {
+ yaml_free((*event).data.sequence_start.anchor as *mut libc::c_void);
+ yaml_free((*event).data.sequence_start.tag as *mut libc::c_void);
+ }
+ YAML_MAPPING_START_EVENT => {
+ yaml_free((*event).data.mapping_start.anchor as *mut libc::c_void);
+ yaml_free((*event).data.mapping_start.tag as *mut libc::c_void);
+ }
+ _ => {}
+ }
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+}
+
+/// Create a YAML document.
+pub unsafe fn yaml_document_initialize(
+ document: *mut yaml_document_t,
+ version_directive: *mut yaml_version_directive_t,
+ tag_directives_start: *mut yaml_tag_directive_t,
+ tag_directives_end: *mut yaml_tag_directive_t,
+ start_implicit: bool,
+ end_implicit: bool,
+) -> Success {
+ let current_block: u64;
+ struct Nodes {
+ start: *mut yaml_node_t,
+ end: *mut yaml_node_t,
+ top: *mut yaml_node_t,
+ }
+ let mut nodes = Nodes {
+ start: ptr::null_mut::<yaml_node_t>(),
+ end: ptr::null_mut::<yaml_node_t>(),
+ top: ptr::null_mut::<yaml_node_t>(),
+ };
+ let mut version_directive_copy: *mut yaml_version_directive_t =
+ ptr::null_mut::<yaml_version_directive_t>();
+ struct TagDirectivesCopy {
+ start: *mut yaml_tag_directive_t,
+ end: *mut yaml_tag_directive_t,
+ top: *mut yaml_tag_directive_t,
+ }
+ let mut tag_directives_copy = TagDirectivesCopy {
+ start: ptr::null_mut::<yaml_tag_directive_t>(),
+ end: ptr::null_mut::<yaml_tag_directive_t>(),
+ top: ptr::null_mut::<yaml_tag_directive_t>(),
+ };
+ let mut value = yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ };
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!document.is_null());
+ __assert!(
+ !tag_directives_start.is_null() && !tag_directives_end.is_null()
+ || tag_directives_start == tag_directives_end
+ );
+ STACK_INIT!(nodes, yaml_node_t);
+ if !version_directive.is_null() {
+ version_directive_copy = yaml_malloc(size_of::<yaml_version_directive_t>() as libc::c_ulong)
+ as *mut yaml_version_directive_t;
+ (*version_directive_copy).major = (*version_directive).major;
+ (*version_directive_copy).minor = (*version_directive).minor;
+ }
+ if tag_directives_start != tag_directives_end {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ STACK_INIT!(tag_directives_copy, yaml_tag_directive_t);
+ tag_directive = tag_directives_start;
+ loop {
+ if !(tag_directive != tag_directives_end) {
+ current_block = 14818589718467733107;
+ break;
+ }
+ __assert!(!((*tag_directive).handle).is_null());
+ __assert!(!((*tag_directive).prefix).is_null());
+ if yaml_check_utf8(
+ (*tag_directive).handle,
+ strlen((*tag_directive).handle as *mut libc::c_char),
+ )
+ .fail
+ {
+ current_block = 8142820162064489797;
+ break;
+ }
+ if yaml_check_utf8(
+ (*tag_directive).prefix,
+ strlen((*tag_directive).prefix as *mut libc::c_char),
+ )
+ .fail
+ {
+ current_block = 8142820162064489797;
+ break;
+ }
+ value.handle = yaml_strdup((*tag_directive).handle);
+ value.prefix = yaml_strdup((*tag_directive).prefix);
+ if value.handle.is_null() || value.prefix.is_null() {
+ current_block = 8142820162064489797;
+ break;
+ }
+ PUSH!(tag_directives_copy, value);
+ value.handle = ptr::null_mut::<yaml_char_t>();
+ value.prefix = ptr::null_mut::<yaml_char_t>();
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ } else {
+ current_block = 14818589718467733107;
+ }
+ if current_block != 8142820162064489797 {
+ memset(
+ document as *mut libc::c_void,
+ 0,
+ size_of::<yaml_document_t>() as libc::c_ulong,
+ );
+ let fresh176 = addr_of_mut!((*document).nodes.start);
+ *fresh176 = nodes.start;
+ let fresh177 = addr_of_mut!((*document).nodes.end);
+ *fresh177 = nodes.end;
+ let fresh178 = addr_of_mut!((*document).nodes.top);
+ *fresh178 = nodes.start;
+ let fresh179 = addr_of_mut!((*document).version_directive);
+ *fresh179 = version_directive_copy;
+ let fresh180 = addr_of_mut!((*document).tag_directives.start);
+ *fresh180 = tag_directives_copy.start;
+ let fresh181 = addr_of_mut!((*document).tag_directives.end);
+ *fresh181 = tag_directives_copy.top;
+ (*document).start_implicit = start_implicit;
+ (*document).end_implicit = end_implicit;
+ (*document).start_mark = mark;
+ (*document).end_mark = mark;
+ return OK;
+ }
+ STACK_DEL!(nodes);
+ yaml_free(version_directive_copy as *mut libc::c_void);
+ while !STACK_EMPTY!(tag_directives_copy) {
+ let value = POP!(tag_directives_copy);
+ yaml_free(value.handle as *mut libc::c_void);
+ yaml_free(value.prefix as *mut libc::c_void);
+ }
+ STACK_DEL!(tag_directives_copy);
+ yaml_free(value.handle as *mut libc::c_void);
+ yaml_free(value.prefix as *mut libc::c_void);
+ FAIL
+}
+
+/// Delete a YAML document and all its nodes.
+pub unsafe fn yaml_document_delete(document: *mut yaml_document_t) {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ __assert!(!document.is_null());
+ while !STACK_EMPTY!((*document).nodes) {
+ let mut node = POP!((*document).nodes);
+ yaml_free(node.tag as *mut libc::c_void);
+ match node.type_ {
+ YAML_SCALAR_NODE => {
+ yaml_free(node.data.scalar.value as *mut libc::c_void);
+ }
+ YAML_SEQUENCE_NODE => {
+ STACK_DEL!(node.data.sequence.items);
+ }
+ YAML_MAPPING_NODE => {
+ STACK_DEL!(node.data.mapping.pairs);
+ }
+ _ => {
+ __assert!(false);
+ }
+ }
+ }
+ STACK_DEL!((*document).nodes);
+ yaml_free((*document).version_directive as *mut libc::c_void);
+ tag_directive = (*document).tag_directives.start;
+ while tag_directive != (*document).tag_directives.end {
+ yaml_free((*tag_directive).handle as *mut libc::c_void);
+ yaml_free((*tag_directive).prefix as *mut libc::c_void);
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ yaml_free((*document).tag_directives.start as *mut libc::c_void);
+ memset(
+ document as *mut libc::c_void,
+ 0,
+ size_of::<yaml_document_t>() as libc::c_ulong,
+ );
+}
+
+/// Get a node of a YAML document.
+///
+/// The pointer returned by this function is valid until any of the functions
+/// modifying the documents are called.
+///
+/// Returns the node objct or NULL if `node_id` is out of range.
+pub unsafe fn yaml_document_get_node(
+ document: *mut yaml_document_t,
+ index: libc::c_int,
+) -> *mut yaml_node_t {
+ __assert!(!document.is_null());
+ if index > 0 && (*document).nodes.start.wrapping_offset(index as isize) <= (*document).nodes.top
+ {
+ return (*document)
+ .nodes
+ .start
+ .wrapping_offset(index as isize)
+ .wrapping_offset(-1_isize);
+ }
+ ptr::null_mut::<yaml_node_t>()
+}
+
+/// Get the root of a YAML document node.
+///
+/// The root object is the first object added to the document.
+///
+/// The pointer returned by this function is valid until any of the functions
+/// modifying the documents are called.
+///
+/// An empty document produced by the parser signifies the end of a YAML stream.
+///
+/// Returns the node object or NULL if the document is empty.
+pub unsafe fn yaml_document_get_root_node(document: *mut yaml_document_t) -> *mut yaml_node_t {
+ __assert!(!document.is_null());
+ if (*document).nodes.top != (*document).nodes.start {
+ return (*document).nodes.start;
+ }
+ ptr::null_mut::<yaml_node_t>()
+}
+
+/// Create a SCALAR node and attach it to the document.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Returns the node id or 0 on error.
+#[must_use]
+pub unsafe fn yaml_document_add_scalar(
+ document: *mut yaml_document_t,
+ mut tag: *const yaml_char_t,
+ value: *const yaml_char_t,
+ mut length: libc::c_int,
+ style: yaml_scalar_style_t,
+) -> libc::c_int {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut value_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ __assert!(!document.is_null());
+ __assert!(!value.is_null());
+ if tag.is_null() {
+ tag = b"tag:yaml.org,2002:str\0" as *const u8 as *const libc::c_char as *mut yaml_char_t;
+ }
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).ok {
+ tag_copy = yaml_strdup(tag);
+ if !tag_copy.is_null() {
+ if length < 0 {
+ length = strlen(value as *mut libc::c_char) as libc::c_int;
+ }
+ if yaml_check_utf8(value, length as size_t).ok {
+ value_copy = yaml_malloc(length.force_add(1) as size_t) as *mut yaml_char_t;
+ memcpy(
+ value_copy as *mut libc::c_void,
+ value as *const libc::c_void,
+ length as libc::c_ulong,
+ );
+ *value_copy.wrapping_offset(length as isize) = b'\0';
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_SCALAR_NODE;
+ (*node).tag = tag_copy;
+ (*node).start_mark = mark;
+ (*node).end_mark = mark;
+ (*node).data.scalar.value = value_copy;
+ (*node).data.scalar.length = length as size_t;
+ (*node).data.scalar.style = style;
+ PUSH!((*document).nodes, *node);
+ return (*document).nodes.top.c_offset_from((*document).nodes.start) as libc::c_int;
+ }
+ }
+ }
+ yaml_free(tag_copy as *mut libc::c_void);
+ yaml_free(value_copy as *mut libc::c_void);
+ 0
+}
+
+/// Create a SEQUENCE node and attach it to the document.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Returns the node id or 0 on error.
+#[must_use]
+pub unsafe fn yaml_document_add_sequence(
+ document: *mut yaml_document_t,
+ mut tag: *const yaml_char_t,
+ style: yaml_sequence_style_t,
+) -> libc::c_int {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ struct Items {
+ start: *mut yaml_node_item_t,
+ end: *mut yaml_node_item_t,
+ top: *mut yaml_node_item_t,
+ }
+ let mut items = Items {
+ start: ptr::null_mut::<yaml_node_item_t>(),
+ end: ptr::null_mut::<yaml_node_item_t>(),
+ top: ptr::null_mut::<yaml_node_item_t>(),
+ };
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ __assert!(!document.is_null());
+ if tag.is_null() {
+ tag = b"tag:yaml.org,2002:seq\0" as *const u8 as *const libc::c_char as *mut yaml_char_t;
+ }
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).ok {
+ tag_copy = yaml_strdup(tag);
+ if !tag_copy.is_null() {
+ STACK_INIT!(items, yaml_node_item_t);
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_SEQUENCE_NODE;
+ (*node).tag = tag_copy;
+ (*node).start_mark = mark;
+ (*node).end_mark = mark;
+ (*node).data.sequence.items.start = items.start;
+ (*node).data.sequence.items.end = items.end;
+ (*node).data.sequence.items.top = items.start;
+ (*node).data.sequence.style = style;
+ PUSH!((*document).nodes, *node);
+ return (*document).nodes.top.c_offset_from((*document).nodes.start) as libc::c_int;
+ }
+ }
+ STACK_DEL!(items);
+ yaml_free(tag_copy as *mut libc::c_void);
+ 0
+}
+
+/// Create a MAPPING node and attach it to the document.
+///
+/// The `style` argument may be ignored by the emitter.
+///
+/// Returns the node id or 0 on error.
+#[must_use]
+pub unsafe fn yaml_document_add_mapping(
+ document: *mut yaml_document_t,
+ mut tag: *const yaml_char_t,
+ style: yaml_mapping_style_t,
+) -> libc::c_int {
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let mut tag_copy: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ struct Pairs {
+ start: *mut yaml_node_pair_t,
+ end: *mut yaml_node_pair_t,
+ top: *mut yaml_node_pair_t,
+ }
+ let mut pairs = Pairs {
+ start: ptr::null_mut::<yaml_node_pair_t>(),
+ end: ptr::null_mut::<yaml_node_pair_t>(),
+ top: ptr::null_mut::<yaml_node_pair_t>(),
+ };
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ __assert!(!document.is_null());
+ if tag.is_null() {
+ tag = b"tag:yaml.org,2002:map\0" as *const u8 as *const libc::c_char as *mut yaml_char_t;
+ }
+ if yaml_check_utf8(tag, strlen(tag as *mut libc::c_char)).ok {
+ tag_copy = yaml_strdup(tag);
+ if !tag_copy.is_null() {
+ STACK_INIT!(pairs, yaml_node_pair_t);
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_MAPPING_NODE;
+ (*node).tag = tag_copy;
+ (*node).start_mark = mark;
+ (*node).end_mark = mark;
+ (*node).data.mapping.pairs.start = pairs.start;
+ (*node).data.mapping.pairs.end = pairs.end;
+ (*node).data.mapping.pairs.top = pairs.start;
+ (*node).data.mapping.style = style;
+ PUSH!((*document).nodes, *node);
+ return (*document).nodes.top.c_offset_from((*document).nodes.start) as libc::c_int;
+ }
+ }
+ STACK_DEL!(pairs);
+ yaml_free(tag_copy as *mut libc::c_void);
+ 0
+}
+
+/// Add an item to a SEQUENCE node.
+pub unsafe fn yaml_document_append_sequence_item(
+ document: *mut yaml_document_t,
+ sequence: libc::c_int,
+ item: libc::c_int,
+) -> Success {
+ __assert!(!document.is_null());
+ __assert!(
+ sequence > 0
+ && ((*document).nodes.start).wrapping_offset(sequence as isize)
+ <= (*document).nodes.top
+ );
+ __assert!(
+ (*((*document).nodes.start).wrapping_offset((sequence - 1) as isize)).type_
+ == YAML_SEQUENCE_NODE
+ );
+ __assert!(
+ item > 0
+ && ((*document).nodes.start).wrapping_offset(item as isize) <= (*document).nodes.top
+ );
+ PUSH!(
+ (*((*document).nodes.start).wrapping_offset((sequence - 1) as isize))
+ .data
+ .sequence
+ .items,
+ item
+ );
+ OK
+}
+
+/// Add a pair of a key and a value to a MAPPING node.
+pub unsafe fn yaml_document_append_mapping_pair(
+ document: *mut yaml_document_t,
+ mapping: libc::c_int,
+ key: libc::c_int,
+ value: libc::c_int,
+) -> Success {
+ __assert!(!document.is_null());
+ __assert!(
+ mapping > 0
+ && ((*document).nodes.start).wrapping_offset(mapping as isize) <= (*document).nodes.top
+ );
+ __assert!(
+ (*((*document).nodes.start).wrapping_offset((mapping - 1) as isize)).type_
+ == YAML_MAPPING_NODE
+ );
+ __assert!(
+ key > 0 && ((*document).nodes.start).wrapping_offset(key as isize) <= (*document).nodes.top
+ );
+ __assert!(
+ value > 0
+ && ((*document).nodes.start).wrapping_offset(value as isize) <= (*document).nodes.top
+ );
+ let pair = yaml_node_pair_t { key, value };
+ PUSH!(
+ (*((*document).nodes.start).wrapping_offset((mapping - 1) as isize))
+ .data
+ .mapping
+ .pairs,
+ pair
+ );
+ OK
+}
diff --git a/crates/unsafe-libyaml/src/bin/cstr/mod.rs b/crates/unsafe-libyaml/src/bin/cstr/mod.rs
new file mode 100644
index 0000000..7054c46
--- /dev/null
+++ b/crates/unsafe-libyaml/src/bin/cstr/mod.rs
@@ -0,0 +1,47 @@
+use std::fmt::{self, Display, Write as _};
+use std::slice;
+use std::str;
+
+#[allow(non_camel_case_types)]
+type c_char = i8;
+
+pub struct CStr {
+ ptr: *const u8,
+}
+
+impl CStr {
+ pub unsafe fn from_ptr(ptr: *const c_char) -> Self {
+ CStr { ptr: ptr.cast() }
+ }
+}
+
+impl Display for CStr {
+ fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
+ let len = unsafe { strlen(self.ptr) };
+ let mut bytes = unsafe { slice::from_raw_parts(self.ptr, len) };
+ loop {
+ match str::from_utf8(bytes) {
+ Ok(valid) => return formatter.write_str(valid),
+ Err(utf8_error) => {
+ let valid_up_to = utf8_error.valid_up_to();
+ let valid = unsafe { str::from_utf8_unchecked(&bytes[..valid_up_to]) };
+ formatter.write_str(valid)?;
+ formatter.write_char(char::REPLACEMENT_CHARACTER)?;
+ if let Some(error_len) = utf8_error.error_len() {
+ bytes = &bytes[valid_up_to + error_len..];
+ } else {
+ return Ok(());
+ }
+ }
+ }
+ }
+ }
+}
+
+unsafe fn strlen(s: *const u8) -> usize {
+ let mut end = s;
+ while *end != 0 {
+ end = end.add(1);
+ }
+ end.offset_from(s) as usize
+}
diff --git a/crates/unsafe-libyaml/src/bin/run-emitter-test-suite.rs b/crates/unsafe-libyaml/src/bin/run-emitter-test-suite.rs
new file mode 100644
index 0000000..0c51b9c
--- /dev/null
+++ b/crates/unsafe-libyaml/src/bin/run-emitter-test-suite.rs
@@ -0,0 +1,307 @@
+#![warn(clippy::pedantic)]
+#![allow(
+ clippy::cast_lossless,
+ clippy::cast_possible_truncation,
+ clippy::cast_possible_wrap,
+ clippy::cast_sign_loss,
+ clippy::items_after_statements,
+ clippy::let_underscore_untyped,
+ clippy::missing_errors_doc,
+ clippy::missing_safety_doc,
+ clippy::ptr_as_ptr,
+ clippy::single_match_else,
+ clippy::too_many_lines,
+ clippy::unreadable_literal
+)]
+
+mod cstr;
+
+use self::cstr::CStr;
+use std::env;
+use std::error::Error;
+use std::ffi::c_void;
+use std::fs::File;
+use std::io::{self, Read, Write};
+use std::mem::MaybeUninit;
+use std::process::{self, ExitCode};
+use std::ptr::{self, addr_of_mut};
+use std::slice;
+use unsafe_libyaml::{
+ yaml_alias_event_initialize, yaml_document_end_event_initialize,
+ yaml_document_start_event_initialize, yaml_emitter_delete, yaml_emitter_emit,
+ yaml_emitter_initialize, yaml_emitter_set_canonical, yaml_emitter_set_output,
+ yaml_emitter_set_unicode, yaml_emitter_t, yaml_event_t, yaml_mapping_end_event_initialize,
+ yaml_mapping_start_event_initialize, yaml_scalar_event_initialize, yaml_scalar_style_t,
+ yaml_sequence_end_event_initialize, yaml_sequence_start_event_initialize,
+ yaml_stream_end_event_initialize, yaml_stream_start_event_initialize, yaml_tag_directive_t,
+ yaml_version_directive_t, YAML_ANY_SCALAR_STYLE, YAML_BLOCK_MAPPING_STYLE,
+ YAML_BLOCK_SEQUENCE_STYLE, YAML_DOUBLE_QUOTED_SCALAR_STYLE, YAML_EMITTER_ERROR,
+ YAML_FOLDED_SCALAR_STYLE, YAML_LITERAL_SCALAR_STYLE, YAML_MEMORY_ERROR,
+ YAML_PLAIN_SCALAR_STYLE, YAML_SINGLE_QUOTED_SCALAR_STYLE, YAML_UTF8_ENCODING,
+ YAML_WRITER_ERROR,
+};
+
+pub(crate) unsafe fn unsafe_main(
+ stdin: &mut dyn Read,
+ mut stdout: &mut dyn Write,
+) -> Result<(), Box<dyn Error>> {
+ let mut emitter = MaybeUninit::<yaml_emitter_t>::uninit();
+ let emitter = emitter.as_mut_ptr();
+ if yaml_emitter_initialize(emitter).fail {
+ return Err("Could not initalize the emitter object".into());
+ }
+
+ unsafe fn write_to_stdio(data: *mut c_void, buffer: *mut u8, size: u64) -> i32 {
+ let stdout: *mut &mut dyn Write = data.cast();
+ let bytes = slice::from_raw_parts(buffer.cast(), size as usize);
+ match (*stdout).write(bytes) {
+ Ok(n) => n as i32,
+ Err(_) => 0,
+ }
+ }
+
+ yaml_emitter_set_output(emitter, write_to_stdio, addr_of_mut!(stdout).cast());
+ yaml_emitter_set_canonical(emitter, false);
+ yaml_emitter_set_unicode(emitter, false);
+
+ let mut buf = ReadBuf::new();
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let result = loop {
+ let line = match buf.get_line(stdin) {
+ Some(line) => line,
+ None => break Ok(()),
+ };
+
+ let mut anchor = [0u8; 256];
+ let mut tag = [0u8; 256];
+ let result = if line.starts_with(b"+STR") {
+ yaml_stream_start_event_initialize(event, YAML_UTF8_ENCODING)
+ } else if line.starts_with(b"-STR") {
+ yaml_stream_end_event_initialize(event)
+ } else if line.starts_with(b"+DOC") {
+ let implicit = !line[4..].starts_with(b" ---");
+ yaml_document_start_event_initialize(
+ event,
+ ptr::null_mut::<yaml_version_directive_t>(),
+ ptr::null_mut::<yaml_tag_directive_t>(),
+ ptr::null_mut::<yaml_tag_directive_t>(),
+ implicit,
+ )
+ } else if line.starts_with(b"-DOC") {
+ let implicit = !line[4..].starts_with(b" ...");
+ yaml_document_end_event_initialize(event, implicit)
+ } else if line.starts_with(b"+MAP") {
+ yaml_mapping_start_event_initialize(
+ event,
+ get_anchor(b'&', line, anchor.as_mut_ptr()),
+ get_tag(line, tag.as_mut_ptr()),
+ false,
+ YAML_BLOCK_MAPPING_STYLE,
+ )
+ } else if line.starts_with(b"-MAP") {
+ yaml_mapping_end_event_initialize(event)
+ } else if line.starts_with(b"+SEQ") {
+ yaml_sequence_start_event_initialize(
+ event,
+ get_anchor(b'&', line, anchor.as_mut_ptr()),
+ get_tag(line, tag.as_mut_ptr()),
+ false,
+ YAML_BLOCK_SEQUENCE_STYLE,
+ )
+ } else if line.starts_with(b"-SEQ") {
+ yaml_sequence_end_event_initialize(event)
+ } else if line.starts_with(b"=VAL") {
+ let mut value = [0i8; 1024];
+ let mut style = YAML_ANY_SCALAR_STYLE;
+ get_value(line, value.as_mut_ptr(), &mut style);
+ let implicit = get_tag(line, tag.as_mut_ptr()).is_null();
+ yaml_scalar_event_initialize(
+ event,
+ get_anchor(b'&', line, anchor.as_mut_ptr()),
+ get_tag(line, tag.as_mut_ptr()),
+ value.as_mut_ptr() as *mut u8,
+ -1,
+ implicit,
+ implicit,
+ style,
+ )
+ } else if line.starts_with(b"=ALI") {
+ yaml_alias_event_initialize(event, get_anchor(b'*', line, anchor.as_mut_ptr()))
+ } else {
+ let line = line as *mut [u8] as *mut i8;
+ break Err(format!("Unknown event: '{}'", CStr::from_ptr(line)).into());
+ };
+
+ if result.fail {
+ break Err("Memory error: Not enough memory for creating an event".into());
+ }
+ if yaml_emitter_emit(emitter, event).fail {
+ break Err(match (*emitter).error {
+ YAML_MEMORY_ERROR => "Memory error: Not enough memory for emitting".into(),
+ YAML_WRITER_ERROR => {
+ format!("Writer error: {}", CStr::from_ptr((*emitter).problem)).into()
+ }
+ YAML_EMITTER_ERROR => {
+ format!("Emitter error: {}", CStr::from_ptr((*emitter).problem)).into()
+ }
+ // Couldn't happen.
+ _ => "Internal error".into(),
+ });
+ }
+ };
+
+ yaml_emitter_delete(emitter);
+ result
+}
+
+struct ReadBuf {
+ buf: [u8; 1024],
+ offset: usize,
+ filled: usize,
+}
+
+impl ReadBuf {
+ fn new() -> Self {
+ ReadBuf {
+ buf: [0; 1024],
+ offset: 0,
+ filled: 0,
+ }
+ }
+
+ fn get_line(&mut self, input: &mut dyn Read) -> Option<&mut [u8]> {
+ loop {
+ for i in self.offset..self.offset + self.filled {
+ if self.buf[i] == b'\n' {
+ self.buf[i] = b'\0';
+ let line = &mut self.buf[self.offset..=i];
+ self.offset = i + 1;
+ self.filled -= line.len();
+ return Some(line);
+ }
+ }
+ let mut remainder = &mut self.buf[self.offset + self.filled..];
+ if remainder.is_empty() {
+ if self.offset == 0 {
+ let _ = writeln!(
+ io::stderr(),
+ "Line too long: '{}'",
+ String::from_utf8_lossy(&self.buf),
+ );
+ process::abort();
+ }
+ self.buf.copy_within(self.offset.., 0);
+ self.offset = 0;
+ remainder = &mut self.buf;
+ }
+ let n = input.read(remainder).ok()?;
+ self.filled += n;
+ if n == 0 {
+ return None;
+ }
+ }
+ }
+}
+
+unsafe fn get_anchor(sigil: u8, line: &[u8], anchor: *mut u8) -> *mut u8 {
+ let start = match line.iter().position(|ch| *ch == sigil) {
+ Some(offset) => offset + 1,
+ None => return ptr::null_mut::<u8>(),
+ };
+ let end = match line[start..].iter().position(|ch| *ch == b' ') {
+ Some(offset) => start + offset,
+ None => line.len(),
+ };
+ ptr::copy_nonoverlapping(line[start..end].as_ptr(), anchor, end - start);
+ *anchor.add(end - start) = b'\0';
+ anchor
+}
+
+unsafe fn get_tag(line: &[u8], tag: *mut u8) -> *mut u8 {
+ let start = match line.iter().position(|ch| *ch == b'<') {
+ Some(offset) => offset + 1,
+ None => return ptr::null_mut::<u8>(),
+ };
+ let end = match line[start..].iter().position(|ch| *ch == b'>') {
+ Some(offset) => start + offset,
+ None => return ptr::null_mut::<u8>(),
+ };
+ ptr::copy_nonoverlapping(line[start..end].as_ptr(), tag, end - start);
+ *tag.add(end - start) = b'\0';
+ tag
+}
+
+unsafe fn get_value(line: &[u8], value: *mut i8, style: *mut yaml_scalar_style_t) {
+ let line_len = line.len();
+ let line = line as *const [u8] as *mut i8;
+ let mut start = ptr::null_mut::<i8>();
+ let end = line.add(line_len);
+ let mut c = line.offset(4);
+ while c < end {
+ if *c as u8 == b' ' {
+ start = c.offset(1);
+ *style = match *start as u8 {
+ b':' => YAML_PLAIN_SCALAR_STYLE,
+ b'\'' => YAML_SINGLE_QUOTED_SCALAR_STYLE,
+ b'"' => YAML_DOUBLE_QUOTED_SCALAR_STYLE,
+ b'|' => YAML_LITERAL_SCALAR_STYLE,
+ b'>' => YAML_FOLDED_SCALAR_STYLE,
+ _ => {
+ start = ptr::null_mut::<i8>();
+ c = c.offset(1);
+ continue;
+ }
+ };
+ start = start.offset(1);
+ break;
+ }
+ c = c.offset(1);
+ }
+ if start.is_null() {
+ process::abort();
+ }
+
+ let mut i = 0;
+ c = start;
+ while c < end {
+ *value.offset(i) = if *c as u8 == b'\\' {
+ c = c.offset(1);
+ match *c as u8 {
+ b'\\' => b'\\' as i8,
+ b'0' => b'\0' as i8,
+ b'b' => b'\x08' as i8,
+ b'n' => b'\n' as i8,
+ b'r' => b'\r' as i8,
+ b't' => b'\t' as i8,
+ _ => process::abort(),
+ }
+ } else {
+ *c
+ };
+ i += 1;
+ c = c.offset(1);
+ }
+ *value.offset(i) = b'\0' as i8;
+}
+
+fn main() -> ExitCode {
+ let args = env::args_os().skip(1);
+ if args.len() == 0 {
+ let _ = writeln!(
+ io::stderr(),
+ "Usage: run-emitter-test-suite <test.event>...",
+ );
+ return ExitCode::FAILURE;
+ }
+ for arg in args {
+ let mut stdin = File::open(arg).unwrap();
+ let mut stdout = io::stdout();
+ let result = unsafe { unsafe_main(&mut stdin, &mut stdout) };
+ if let Err(err) = result {
+ let _ = writeln!(io::stderr(), "{}", err);
+ return ExitCode::FAILURE;
+ }
+ }
+ ExitCode::SUCCESS
+}
diff --git a/crates/unsafe-libyaml/src/bin/run-parser-test-suite.rs b/crates/unsafe-libyaml/src/bin/run-parser-test-suite.rs
new file mode 100644
index 0000000..439ee03
--- /dev/null
+++ b/crates/unsafe-libyaml/src/bin/run-parser-test-suite.rs
@@ -0,0 +1,222 @@
+#![warn(clippy::pedantic)]
+#![allow(
+ clippy::cast_lossless,
+ clippy::cast_possible_truncation,
+ clippy::cast_possible_wrap,
+ clippy::cast_sign_loss,
+ clippy::items_after_statements,
+ clippy::let_underscore_untyped,
+ clippy::missing_errors_doc,
+ clippy::missing_safety_doc,
+ clippy::too_many_lines
+)]
+
+mod cstr;
+
+use self::cstr::CStr;
+use std::env;
+use std::error::Error;
+use std::ffi::c_void;
+use std::fmt::Write as _;
+use std::fs::File;
+use std::io::{self, Read, Write};
+use std::mem::MaybeUninit;
+use std::process::{self, ExitCode};
+use std::ptr::addr_of_mut;
+use std::slice;
+use unsafe_libyaml::{
+ yaml_event_delete, yaml_event_t, yaml_event_type_t, yaml_parser_delete, yaml_parser_initialize,
+ yaml_parser_parse, yaml_parser_set_input, yaml_parser_t, YAML_ALIAS_EVENT,
+ YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_START_EVENT, YAML_DOUBLE_QUOTED_SCALAR_STYLE,
+ YAML_FOLDED_SCALAR_STYLE, YAML_LITERAL_SCALAR_STYLE, YAML_MAPPING_END_EVENT,
+ YAML_MAPPING_START_EVENT, YAML_NO_EVENT, YAML_PLAIN_SCALAR_STYLE, YAML_SCALAR_EVENT,
+ YAML_SEQUENCE_END_EVENT, YAML_SEQUENCE_START_EVENT, YAML_SINGLE_QUOTED_SCALAR_STYLE,
+ YAML_STREAM_END_EVENT, YAML_STREAM_START_EVENT,
+};
+
+pub(crate) unsafe fn unsafe_main(
+ mut stdin: &mut dyn Read,
+ stdout: &mut dyn Write,
+) -> Result<(), Box<dyn Error>> {
+ let mut parser = MaybeUninit::<yaml_parser_t>::uninit();
+ let parser = parser.as_mut_ptr();
+ if yaml_parser_initialize(parser).fail {
+ return Err("Could not initialize the parser object".into());
+ }
+
+ unsafe fn read_from_stdio(
+ data: *mut c_void,
+ buffer: *mut u8,
+ size: u64,
+ size_read: *mut u64,
+ ) -> i32 {
+ let stdin: *mut &mut dyn Read = data.cast();
+ let slice = slice::from_raw_parts_mut(buffer.cast(), size as usize);
+ match (*stdin).read(slice) {
+ Ok(n) => {
+ *size_read = n as u64;
+ 1
+ }
+ Err(_) => 0,
+ }
+ }
+
+ yaml_parser_set_input(parser, read_from_stdio, addr_of_mut!(stdin).cast());
+
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ loop {
+ if yaml_parser_parse(parser, event).fail {
+ let mut error = format!("Parse error: {}", CStr::from_ptr((*parser).problem));
+ if (*parser).problem_mark.line != 0 || (*parser).problem_mark.column != 0 {
+ let _ = write!(
+ error,
+ "\nLine: {} Column: {}",
+ ((*parser).problem_mark.line).wrapping_add(1_u64),
+ ((*parser).problem_mark.column).wrapping_add(1_u64),
+ );
+ }
+ yaml_parser_delete(parser);
+ return Err(error.into());
+ }
+
+ let type_: yaml_event_type_t = (*event).type_;
+ if type_ == YAML_NO_EVENT {
+ let _ = writeln!(stdout, "???");
+ } else if type_ == YAML_STREAM_START_EVENT {
+ let _ = writeln!(stdout, "+STR");
+ } else if type_ == YAML_STREAM_END_EVENT {
+ let _ = writeln!(stdout, "-STR");
+ } else if type_ == YAML_DOCUMENT_START_EVENT {
+ let _ = write!(stdout, "+DOC");
+ if !(*event).data.document_start.implicit {
+ let _ = write!(stdout, " ---");
+ }
+ let _ = writeln!(stdout);
+ } else if type_ == YAML_DOCUMENT_END_EVENT {
+ let _ = write!(stdout, "-DOC");
+ if !(*event).data.document_end.implicit {
+ let _ = write!(stdout, " ...");
+ }
+ let _ = writeln!(stdout);
+ } else if type_ == YAML_MAPPING_START_EVENT {
+ let _ = write!(stdout, "+MAP");
+ if !(*event).data.mapping_start.anchor.is_null() {
+ let _ = write!(
+ stdout,
+ " &{}",
+ CStr::from_ptr((*event).data.mapping_start.anchor as *const i8),
+ );
+ }
+ if !(*event).data.mapping_start.tag.is_null() {
+ let _ = write!(
+ stdout,
+ " <{}>",
+ CStr::from_ptr((*event).data.mapping_start.tag as *const i8),
+ );
+ }
+ let _ = writeln!(stdout);
+ } else if type_ == YAML_MAPPING_END_EVENT {
+ let _ = writeln!(stdout, "-MAP");
+ } else if type_ == YAML_SEQUENCE_START_EVENT {
+ let _ = write!(stdout, "+SEQ");
+ if !(*event).data.sequence_start.anchor.is_null() {
+ let _ = write!(
+ stdout,
+ " &{}",
+ CStr::from_ptr((*event).data.sequence_start.anchor as *const i8),
+ );
+ }
+ if !(*event).data.sequence_start.tag.is_null() {
+ let _ = write!(
+ stdout,
+ " <{}>",
+ CStr::from_ptr((*event).data.sequence_start.tag as *const i8),
+ );
+ }
+ let _ = writeln!(stdout);
+ } else if type_ == YAML_SEQUENCE_END_EVENT {
+ let _ = writeln!(stdout, "-SEQ");
+ } else if type_ == YAML_SCALAR_EVENT {
+ let _ = write!(stdout, "=VAL");
+ if !(*event).data.scalar.anchor.is_null() {
+ let _ = write!(
+ stdout,
+ " &{}",
+ CStr::from_ptr((*event).data.scalar.anchor as *const i8),
+ );
+ }
+ if !(*event).data.scalar.tag.is_null() {
+ let _ = write!(
+ stdout,
+ " <{}>",
+ CStr::from_ptr((*event).data.scalar.tag as *const i8),
+ );
+ }
+ let _ = stdout.write_all(match (*event).data.scalar.style {
+ YAML_PLAIN_SCALAR_STYLE => b" :",
+ YAML_SINGLE_QUOTED_SCALAR_STYLE => b" '",
+ YAML_DOUBLE_QUOTED_SCALAR_STYLE => b" \"",
+ YAML_LITERAL_SCALAR_STYLE => b" |",
+ YAML_FOLDED_SCALAR_STYLE => b" >",
+ _ => process::abort(),
+ });
+ print_escaped(
+ stdout,
+ (*event).data.scalar.value,
+ (*event).data.scalar.length,
+ );
+ let _ = writeln!(stdout);
+ } else if type_ == YAML_ALIAS_EVENT {
+ let _ = writeln!(
+ stdout,
+ "=ALI *{}",
+ CStr::from_ptr((*event).data.alias.anchor as *const i8),
+ );
+ } else {
+ process::abort();
+ }
+
+ yaml_event_delete(event);
+ if type_ == YAML_STREAM_END_EVENT {
+ break;
+ }
+ }
+ yaml_parser_delete(parser);
+ Ok(())
+}
+
+unsafe fn print_escaped(stdout: &mut dyn Write, mut str: *mut u8, length: u64) {
+ let end = str.offset(length as isize);
+ while str < end {
+ let repr = match &*str {
+ b'\\' => b"\\\\",
+ b'\0' => b"\\0",
+ b'\x08' => b"\\b",
+ b'\n' => b"\\n",
+ b'\r' => b"\\r",
+ b'\t' => b"\\t",
+ c => slice::from_ref(c),
+ };
+ let _ = stdout.write_all(repr);
+ str = str.offset(1);
+ }
+}
+
+fn main() -> ExitCode {
+ let args = env::args_os().skip(1);
+ if args.len() == 0 {
+ let _ = writeln!(io::stderr(), "Usage: run-parser-test-suite <in.yaml>...");
+ return ExitCode::FAILURE;
+ }
+ for arg in args {
+ let mut stdin = File::open(arg).unwrap();
+ let mut stdout = io::stdout();
+ let result = unsafe { unsafe_main(&mut stdin, &mut stdout) };
+ if let Err(err) = result {
+ let _ = writeln!(io::stderr(), "{}", err);
+ return ExitCode::FAILURE;
+ }
+ }
+ ExitCode::SUCCESS
+}
diff --git a/crates/unsafe-libyaml/src/dumper.rs b/crates/unsafe-libyaml/src/dumper.rs
new file mode 100644
index 0000000..7d00cd8
--- /dev/null
+++ b/crates/unsafe-libyaml/src/dumper.rs
@@ -0,0 +1,450 @@
+use crate::api::{yaml_free, yaml_malloc};
+use crate::externs::{memset, strcmp};
+use crate::fmt::WriteToPtr;
+use crate::ops::ForceMul as _;
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{
+ yaml_anchors_t, yaml_char_t, yaml_document_t, yaml_emitter_t, yaml_event_t, yaml_mark_t,
+ yaml_node_item_t, yaml_node_pair_t, yaml_node_t, YAML_ALIAS_EVENT, YAML_ANY_ENCODING,
+ YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_START_EVENT, YAML_MAPPING_END_EVENT, YAML_MAPPING_NODE,
+ YAML_MAPPING_START_EVENT, YAML_SCALAR_EVENT, YAML_SCALAR_NODE, YAML_SEQUENCE_END_EVENT,
+ YAML_SEQUENCE_NODE, YAML_SEQUENCE_START_EVENT, YAML_STREAM_END_EVENT, YAML_STREAM_START_EVENT,
+};
+use crate::{libc, yaml_document_delete, yaml_emitter_emit, PointerExt};
+use core::mem::{size_of, MaybeUninit};
+use core::ptr::{self, addr_of_mut};
+
+/// Start a YAML stream.
+///
+/// This function should be used before yaml_emitter_dump() is called.
+pub unsafe fn yaml_emitter_open(emitter: *mut yaml_emitter_t) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!emitter.is_null());
+ __assert!(!(*emitter).opened);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.stream_start.encoding = YAML_ANY_ENCODING;
+ if yaml_emitter_emit(emitter, event).fail {
+ return FAIL;
+ }
+ (*emitter).opened = true;
+ OK
+}
+
+/// Finish a YAML stream.
+///
+/// This function should be used after yaml_emitter_dump() is called.
+pub unsafe fn yaml_emitter_close(emitter: *mut yaml_emitter_t) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!emitter.is_null());
+ __assert!((*emitter).opened);
+ if (*emitter).closed {
+ return OK;
+ }
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ if yaml_emitter_emit(emitter, event).fail {
+ return FAIL;
+ }
+ (*emitter).closed = true;
+ OK
+}
+
+/// Emit a YAML document.
+///
+/// The documen object may be generated using the yaml_parser_load() function or
+/// the yaml_document_initialize() function. The emitter takes the
+/// responsibility for the document object and destroys its content after it is
+/// emitted. The document object is destroyed even if the function fails.
+pub unsafe fn yaml_emitter_dump(
+ emitter: *mut yaml_emitter_t,
+ document: *mut yaml_document_t,
+) -> Success {
+ let current_block: u64;
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ __assert!(!emitter.is_null());
+ __assert!(!document.is_null());
+ let fresh0 = addr_of_mut!((*emitter).document);
+ *fresh0 = document;
+ if !(*emitter).opened {
+ if yaml_emitter_open(emitter).fail {
+ current_block = 5018439318894558507;
+ } else {
+ current_block = 15619007995458559411;
+ }
+ } else {
+ current_block = 15619007995458559411;
+ }
+ match current_block {
+ 15619007995458559411 => {
+ if STACK_EMPTY!((*document).nodes) {
+ if yaml_emitter_close(emitter).ok {
+ yaml_emitter_delete_document_and_anchors(emitter);
+ return OK;
+ }
+ } else {
+ __assert!((*emitter).opened);
+ let fresh1 = addr_of_mut!((*emitter).anchors);
+ *fresh1 = yaml_malloc(
+ (size_of::<yaml_anchors_t>() as libc::c_ulong)
+ .force_mul((*document).nodes.top.c_offset_from((*document).nodes.start)
+ as libc::c_ulong),
+ ) as *mut yaml_anchors_t;
+ memset(
+ (*emitter).anchors as *mut libc::c_void,
+ 0,
+ (size_of::<yaml_anchors_t>() as libc::c_ulong)
+ .force_mul((*document).nodes.top.c_offset_from((*document).nodes.start)
+ as libc::c_ulong),
+ );
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.document_start.version_directive = (*document).version_directive;
+ (*event).data.document_start.tag_directives.start =
+ (*document).tag_directives.start;
+ (*event).data.document_start.tag_directives.end = (*document).tag_directives.end;
+ (*event).data.document_start.implicit = (*document).start_implicit;
+ if yaml_emitter_emit(emitter, event).ok {
+ yaml_emitter_anchor_node(emitter, 1);
+ if yaml_emitter_dump_node(emitter, 1).ok {
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.document_end.implicit = (*document).end_implicit;
+ if yaml_emitter_emit(emitter, event).ok {
+ yaml_emitter_delete_document_and_anchors(emitter);
+ return OK;
+ }
+ }
+ }
+ }
+ }
+ _ => {}
+ }
+ yaml_emitter_delete_document_and_anchors(emitter);
+ FAIL
+}
+
+unsafe fn yaml_emitter_delete_document_and_anchors(emitter: *mut yaml_emitter_t) {
+ let mut index: libc::c_int;
+ if (*emitter).anchors.is_null() {
+ yaml_document_delete((*emitter).document);
+ let fresh2 = addr_of_mut!((*emitter).document);
+ *fresh2 = ptr::null_mut::<yaml_document_t>();
+ return;
+ }
+ index = 0;
+ while (*(*emitter).document)
+ .nodes
+ .start
+ .wrapping_offset(index as isize)
+ < (*(*emitter).document).nodes.top
+ {
+ let mut node: yaml_node_t = *(*(*emitter).document)
+ .nodes
+ .start
+ .wrapping_offset(index as isize);
+ if !(*(*emitter).anchors.wrapping_offset(index as isize)).serialized {
+ yaml_free(node.tag as *mut libc::c_void);
+ if node.type_ == YAML_SCALAR_NODE {
+ yaml_free(node.data.scalar.value as *mut libc::c_void);
+ }
+ }
+ if node.type_ == YAML_SEQUENCE_NODE {
+ STACK_DEL!(node.data.sequence.items);
+ }
+ if node.type_ == YAML_MAPPING_NODE {
+ STACK_DEL!(node.data.mapping.pairs);
+ }
+ index += 1;
+ }
+ STACK_DEL!((*(*emitter).document).nodes);
+ yaml_free((*emitter).anchors as *mut libc::c_void);
+ let fresh6 = addr_of_mut!((*emitter).anchors);
+ *fresh6 = ptr::null_mut::<yaml_anchors_t>();
+ (*emitter).last_anchor_id = 0;
+ let fresh7 = addr_of_mut!((*emitter).document);
+ *fresh7 = ptr::null_mut::<yaml_document_t>();
+}
+
+unsafe fn yaml_emitter_anchor_node_sub(emitter: *mut yaml_emitter_t, index: libc::c_int) {
+ (*((*emitter).anchors).offset((index - 1) as isize)).references += 1;
+ if (*(*emitter).anchors.offset((index - 1) as isize)).references == 2 {
+ (*emitter).last_anchor_id += 1;
+ (*(*emitter).anchors.offset((index - 1) as isize)).anchor = (*emitter).last_anchor_id;
+ }
+}
+
+unsafe fn yaml_emitter_anchor_node(emitter: *mut yaml_emitter_t, index: libc::c_int) {
+ let node: *mut yaml_node_t = (*(*emitter).document)
+ .nodes
+ .start
+ .wrapping_offset(index as isize)
+ .wrapping_offset(-1_isize);
+ let mut item: *mut yaml_node_item_t;
+ let mut pair: *mut yaml_node_pair_t;
+ let fresh8 =
+ addr_of_mut!((*((*emitter).anchors).wrapping_offset((index - 1) as isize)).references);
+ *fresh8 += 1;
+ if (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).references == 1 {
+ match (*node).type_ {
+ YAML_SEQUENCE_NODE => {
+ item = (*node).data.sequence.items.start;
+ while item < (*node).data.sequence.items.top {
+ yaml_emitter_anchor_node_sub(emitter, *item);
+ item = item.wrapping_offset(1);
+ }
+ }
+ YAML_MAPPING_NODE => {
+ pair = (*node).data.mapping.pairs.start;
+ while pair < (*node).data.mapping.pairs.top {
+ yaml_emitter_anchor_node_sub(emitter, (*pair).key);
+ yaml_emitter_anchor_node_sub(emitter, (*pair).value);
+ pair = pair.wrapping_offset(1);
+ }
+ }
+ _ => {}
+ }
+ } else if (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).references == 2 {
+ let fresh9 = addr_of_mut!((*emitter).last_anchor_id);
+ *fresh9 += 1;
+ (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).anchor = *fresh9;
+ }
+}
+
+unsafe fn yaml_emitter_generate_anchor(
+ _emitter: *mut yaml_emitter_t,
+ anchor_id: libc::c_int,
+) -> *mut yaml_char_t {
+ let anchor: *mut yaml_char_t = yaml_malloc(16_u64) as *mut yaml_char_t;
+ write!(WriteToPtr::new(anchor), "id{:03}\0", anchor_id);
+ anchor
+}
+
+unsafe fn yaml_emitter_dump_node(emitter: *mut yaml_emitter_t, index: libc::c_int) -> Success {
+ let node: *mut yaml_node_t = (*(*emitter).document)
+ .nodes
+ .start
+ .wrapping_offset(index as isize)
+ .wrapping_offset(-1_isize);
+ let anchor_id: libc::c_int = (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).anchor;
+ let mut anchor: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ if anchor_id != 0 {
+ anchor = yaml_emitter_generate_anchor(emitter, anchor_id);
+ }
+ if (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).serialized {
+ return yaml_emitter_dump_alias(emitter, anchor);
+ }
+ (*(*emitter).anchors.wrapping_offset((index - 1) as isize)).serialized = true;
+ match (*node).type_ {
+ YAML_SCALAR_NODE => yaml_emitter_dump_scalar(emitter, node, anchor),
+ YAML_SEQUENCE_NODE => yaml_emitter_dump_sequence(emitter, node, anchor),
+ YAML_MAPPING_NODE => yaml_emitter_dump_mapping(emitter, node, anchor),
+ _ => __assert!(false),
+ }
+}
+
+unsafe fn yaml_emitter_dump_alias(
+ emitter: *mut yaml_emitter_t,
+ anchor: *mut yaml_char_t,
+) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_ALIAS_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.alias.anchor = anchor;
+ yaml_emitter_emit(emitter, event)
+}
+
+unsafe fn yaml_emitter_dump_scalar(
+ emitter: *mut yaml_emitter_t,
+ node: *mut yaml_node_t,
+ anchor: *mut yaml_char_t,
+) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let plain_implicit = strcmp(
+ (*node).tag as *mut libc::c_char,
+ b"tag:yaml.org,2002:str\0" as *const u8 as *const libc::c_char,
+ ) == 0;
+ let quoted_implicit = strcmp(
+ (*node).tag as *mut libc::c_char,
+ b"tag:yaml.org,2002:str\0" as *const u8 as *const libc::c_char,
+ ) == 0;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SCALAR_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.scalar.anchor = anchor;
+ (*event).data.scalar.tag = (*node).tag;
+ (*event).data.scalar.value = (*node).data.scalar.value;
+ (*event).data.scalar.length = (*node).data.scalar.length;
+ (*event).data.scalar.plain_implicit = plain_implicit;
+ (*event).data.scalar.quoted_implicit = quoted_implicit;
+ (*event).data.scalar.style = (*node).data.scalar.style;
+ yaml_emitter_emit(emitter, event)
+}
+
+unsafe fn yaml_emitter_dump_sequence(
+ emitter: *mut yaml_emitter_t,
+ node: *mut yaml_node_t,
+ anchor: *mut yaml_char_t,
+) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let implicit = strcmp(
+ (*node).tag as *mut libc::c_char,
+ b"tag:yaml.org,2002:seq\0" as *const u8 as *const libc::c_char,
+ ) == 0;
+ let mut item: *mut yaml_node_item_t;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.sequence_start.anchor = anchor;
+ (*event).data.sequence_start.tag = (*node).tag;
+ (*event).data.sequence_start.implicit = implicit;
+ (*event).data.sequence_start.style = (*node).data.sequence.style;
+ if yaml_emitter_emit(emitter, event).fail {
+ return FAIL;
+ }
+ item = (*node).data.sequence.items.start;
+ while item < (*node).data.sequence.items.top {
+ if yaml_emitter_dump_node(emitter, *item).fail {
+ return FAIL;
+ }
+ item = item.wrapping_offset(1);
+ }
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ yaml_emitter_emit(emitter, event)
+}
+
+unsafe fn yaml_emitter_dump_mapping(
+ emitter: *mut yaml_emitter_t,
+ node: *mut yaml_node_t,
+ anchor: *mut yaml_char_t,
+) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ let mark = yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ };
+ let implicit = strcmp(
+ (*node).tag as *mut libc::c_char,
+ b"tag:yaml.org,2002:map\0" as *const u8 as *const libc::c_char,
+ ) == 0;
+ let mut pair: *mut yaml_node_pair_t;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_START_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ (*event).data.mapping_start.anchor = anchor;
+ (*event).data.mapping_start.tag = (*node).tag;
+ (*event).data.mapping_start.implicit = implicit;
+ (*event).data.mapping_start.style = (*node).data.mapping.style;
+ if yaml_emitter_emit(emitter, event).fail {
+ return FAIL;
+ }
+ pair = (*node).data.mapping.pairs.start;
+ while pair < (*node).data.mapping.pairs.top {
+ if yaml_emitter_dump_node(emitter, (*pair).key).fail {
+ return FAIL;
+ }
+ if yaml_emitter_dump_node(emitter, (*pair).value).fail {
+ return FAIL;
+ }
+ pair = pair.wrapping_offset(1);
+ }
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_END_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ yaml_emitter_emit(emitter, event)
+}
diff --git a/crates/unsafe-libyaml/src/emitter.rs b/crates/unsafe-libyaml/src/emitter.rs
new file mode 100644
index 0000000..a223b32
--- /dev/null
+++ b/crates/unsafe-libyaml/src/emitter.rs
@@ -0,0 +1,2376 @@
+use crate::api::{yaml_free, yaml_queue_extend, yaml_stack_extend, yaml_strdup};
+use crate::externs::{strcmp, strlen, strncmp};
+use crate::ops::{ForceAdd as _, ForceMul as _};
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{size_t, yaml_char_t, yaml_string_t};
+use crate::{
+ libc, yaml_emitter_flush, yaml_emitter_t, yaml_event_delete, yaml_event_t, yaml_scalar_style_t,
+ yaml_tag_directive_t, yaml_version_directive_t, PointerExt, YAML_ALIAS_EVENT, YAML_ANY_BREAK,
+ YAML_ANY_ENCODING, YAML_ANY_SCALAR_STYLE, YAML_CRLN_BREAK, YAML_CR_BREAK,
+ YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_START_EVENT, YAML_DOUBLE_QUOTED_SCALAR_STYLE,
+ YAML_EMITTER_ERROR, YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE, YAML_EMIT_BLOCK_MAPPING_KEY_STATE,
+ YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE, YAML_EMIT_BLOCK_MAPPING_VALUE_STATE,
+ YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE, YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE,
+ YAML_EMIT_DOCUMENT_CONTENT_STATE, YAML_EMIT_DOCUMENT_END_STATE, YAML_EMIT_DOCUMENT_START_STATE,
+ YAML_EMIT_END_STATE, YAML_EMIT_FIRST_DOCUMENT_START_STATE,
+ YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE, YAML_EMIT_FLOW_MAPPING_KEY_STATE,
+ YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE, YAML_EMIT_FLOW_MAPPING_VALUE_STATE,
+ YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE, YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE,
+ YAML_EMIT_STREAM_START_STATE, YAML_FLOW_MAPPING_STYLE, YAML_FLOW_SEQUENCE_STYLE,
+ YAML_FOLDED_SCALAR_STYLE, YAML_LITERAL_SCALAR_STYLE, YAML_LN_BREAK, YAML_MAPPING_END_EVENT,
+ YAML_MAPPING_START_EVENT, YAML_PLAIN_SCALAR_STYLE, YAML_SCALAR_EVENT, YAML_SEQUENCE_END_EVENT,
+ YAML_SEQUENCE_START_EVENT, YAML_SINGLE_QUOTED_SCALAR_STYLE, YAML_STREAM_END_EVENT,
+ YAML_STREAM_START_EVENT, YAML_UTF8_ENCODING,
+};
+use core::ptr::{self, addr_of_mut};
+
+unsafe fn FLUSH(emitter: *mut yaml_emitter_t) -> Success {
+ if (*emitter).buffer.pointer.wrapping_offset(5_isize) < (*emitter).buffer.end {
+ OK
+ } else {
+ yaml_emitter_flush(emitter)
+ }
+}
+
+unsafe fn PUT(emitter: *mut yaml_emitter_t, value: u8) -> Success {
+ if FLUSH(emitter).fail {
+ return FAIL;
+ }
+ let fresh40 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh41 = *fresh40;
+ *fresh40 = (*fresh40).wrapping_offset(1);
+ *fresh41 = value;
+ let fresh42 = addr_of_mut!((*emitter).column);
+ *fresh42 += 1;
+ OK
+}
+
+unsafe fn PUT_BREAK(emitter: *mut yaml_emitter_t) -> Success {
+ if FLUSH(emitter).fail {
+ return FAIL;
+ }
+ if (*emitter).line_break == YAML_CR_BREAK {
+ let fresh62 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh63 = *fresh62;
+ *fresh62 = (*fresh62).wrapping_offset(1);
+ *fresh63 = b'\r';
+ } else if (*emitter).line_break == YAML_LN_BREAK {
+ let fresh64 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh65 = *fresh64;
+ *fresh64 = (*fresh64).wrapping_offset(1);
+ *fresh65 = b'\n';
+ } else if (*emitter).line_break == YAML_CRLN_BREAK {
+ let fresh66 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh67 = *fresh66;
+ *fresh66 = (*fresh66).wrapping_offset(1);
+ *fresh67 = b'\r';
+ let fresh68 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh69 = *fresh68;
+ *fresh68 = (*fresh68).wrapping_offset(1);
+ *fresh69 = b'\n';
+ };
+ (*emitter).column = 0;
+ let fresh70 = addr_of_mut!((*emitter).line);
+ *fresh70 += 1;
+ OK
+}
+
+unsafe fn WRITE(emitter: *mut yaml_emitter_t, string: *mut yaml_string_t) -> Success {
+ if FLUSH(emitter).fail {
+ return FAIL;
+ }
+ COPY!((*emitter).buffer, *string);
+ let fresh107 = addr_of_mut!((*emitter).column);
+ *fresh107 += 1;
+ OK
+}
+
+unsafe fn WRITE_BREAK(emitter: *mut yaml_emitter_t, string: *mut yaml_string_t) -> Success {
+ if FLUSH(emitter).fail {
+ return FAIL;
+ }
+ if CHECK!(*string, b'\n') {
+ let _ = PUT_BREAK(emitter);
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ } else {
+ COPY!((*emitter).buffer, *string);
+ (*emitter).column = 0;
+ let fresh300 = addr_of_mut!((*emitter).line);
+ *fresh300 += 1;
+ }
+ OK
+}
+
+macro_rules! WRITE {
+ ($emitter:expr, $string:expr) => {
+ WRITE($emitter, addr_of_mut!($string))
+ };
+}
+
+macro_rules! WRITE_BREAK {
+ ($emitter:expr, $string:expr) => {
+ WRITE_BREAK($emitter, addr_of_mut!($string))
+ };
+}
+
+unsafe fn yaml_emitter_set_emitter_error(
+ emitter: *mut yaml_emitter_t,
+ problem: *const libc::c_char,
+) -> Success {
+ (*emitter).error = YAML_EMITTER_ERROR;
+ let fresh0 = addr_of_mut!((*emitter).problem);
+ *fresh0 = problem;
+ FAIL
+}
+
+/// Emit an event.
+///
+/// The event object may be generated using the yaml_parser_parse() function.
+/// The emitter takes the responsibility for the event object and destroys its
+/// content after it is emitted. The event object is destroyed even if the
+/// function fails.
+pub unsafe fn yaml_emitter_emit(emitter: *mut yaml_emitter_t, event: *mut yaml_event_t) -> Success {
+ ENQUEUE!((*emitter).events, *event);
+ while yaml_emitter_need_more_events(emitter).fail {
+ if yaml_emitter_analyze_event(emitter, (*emitter).events.head).fail {
+ return FAIL;
+ }
+ if yaml_emitter_state_machine(emitter, (*emitter).events.head).fail {
+ return FAIL;
+ }
+ yaml_event_delete(addr_of_mut!(DEQUEUE!((*emitter).events)));
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_need_more_events(emitter: *mut yaml_emitter_t) -> Success {
+ let mut level: libc::c_int = 0;
+ let mut event: *mut yaml_event_t;
+ if QUEUE_EMPTY!((*emitter).events) {
+ return OK;
+ }
+ let accumulate = match (*(*emitter).events.head).type_ {
+ YAML_DOCUMENT_START_EVENT => 1,
+ YAML_SEQUENCE_START_EVENT => 2,
+ YAML_MAPPING_START_EVENT => 3,
+ _ => return FAIL,
+ };
+ if (*emitter).events.tail.c_offset_from((*emitter).events.head) as libc::c_long
+ > accumulate as libc::c_long
+ {
+ return FAIL;
+ }
+ event = (*emitter).events.head;
+ while event != (*emitter).events.tail {
+ match (*event).type_ {
+ YAML_STREAM_START_EVENT
+ | YAML_DOCUMENT_START_EVENT
+ | YAML_SEQUENCE_START_EVENT
+ | YAML_MAPPING_START_EVENT => {
+ level += 1;
+ }
+ YAML_STREAM_END_EVENT
+ | YAML_DOCUMENT_END_EVENT
+ | YAML_SEQUENCE_END_EVENT
+ | YAML_MAPPING_END_EVENT => {
+ level -= 1;
+ }
+ _ => {}
+ }
+ if level == 0 {
+ return FAIL;
+ }
+ event = event.wrapping_offset(1);
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_append_tag_directive(
+ emitter: *mut yaml_emitter_t,
+ value: yaml_tag_directive_t,
+ allow_duplicates: bool,
+) -> Success {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ let mut copy = yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ };
+ tag_directive = (*emitter).tag_directives.start;
+ while tag_directive != (*emitter).tag_directives.top {
+ if strcmp(
+ value.handle as *mut libc::c_char,
+ (*tag_directive).handle as *mut libc::c_char,
+ ) == 0
+ {
+ if allow_duplicates {
+ return OK;
+ }
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"duplicate %TAG directive\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ copy.handle = yaml_strdup(value.handle);
+ copy.prefix = yaml_strdup(value.prefix);
+ PUSH!((*emitter).tag_directives, copy);
+ OK
+}
+
+unsafe fn yaml_emitter_increase_indent(emitter: *mut yaml_emitter_t, flow: bool, indentless: bool) {
+ PUSH!((*emitter).indents, (*emitter).indent);
+ if (*emitter).indent < 0 {
+ (*emitter).indent = if flow { (*emitter).best_indent } else { 0 };
+ } else if !indentless {
+ (*emitter).indent += (*emitter).best_indent;
+ }
+}
+
+unsafe fn yaml_emitter_state_machine(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ match (*emitter).state {
+ YAML_EMIT_STREAM_START_STATE => yaml_emitter_emit_stream_start(emitter, event),
+ YAML_EMIT_FIRST_DOCUMENT_START_STATE => {
+ yaml_emitter_emit_document_start(emitter, event, true)
+ }
+ YAML_EMIT_DOCUMENT_START_STATE => yaml_emitter_emit_document_start(emitter, event, false),
+ YAML_EMIT_DOCUMENT_CONTENT_STATE => yaml_emitter_emit_document_content(emitter, event),
+ YAML_EMIT_DOCUMENT_END_STATE => yaml_emitter_emit_document_end(emitter, event),
+ YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE => {
+ yaml_emitter_emit_flow_sequence_item(emitter, event, true)
+ }
+ YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE => {
+ yaml_emitter_emit_flow_sequence_item(emitter, event, false)
+ }
+ YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE => {
+ yaml_emitter_emit_flow_mapping_key(emitter, event, true)
+ }
+ YAML_EMIT_FLOW_MAPPING_KEY_STATE => {
+ yaml_emitter_emit_flow_mapping_key(emitter, event, false)
+ }
+ YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE => {
+ yaml_emitter_emit_flow_mapping_value(emitter, event, true)
+ }
+ YAML_EMIT_FLOW_MAPPING_VALUE_STATE => {
+ yaml_emitter_emit_flow_mapping_value(emitter, event, false)
+ }
+ YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE => {
+ yaml_emitter_emit_block_sequence_item(emitter, event, true)
+ }
+ YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE => {
+ yaml_emitter_emit_block_sequence_item(emitter, event, false)
+ }
+ YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE => {
+ yaml_emitter_emit_block_mapping_key(emitter, event, true)
+ }
+ YAML_EMIT_BLOCK_MAPPING_KEY_STATE => {
+ yaml_emitter_emit_block_mapping_key(emitter, event, false)
+ }
+ YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE => {
+ yaml_emitter_emit_block_mapping_value(emitter, event, true)
+ }
+ YAML_EMIT_BLOCK_MAPPING_VALUE_STATE => {
+ yaml_emitter_emit_block_mapping_value(emitter, event, false)
+ }
+ YAML_EMIT_END_STATE => yaml_emitter_set_emitter_error(
+ emitter,
+ b"expected nothing after STREAM-END\0" as *const u8 as *const libc::c_char,
+ ),
+ }
+}
+
+unsafe fn yaml_emitter_emit_stream_start(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ (*emitter).open_ended = 0;
+ if (*event).type_ == YAML_STREAM_START_EVENT {
+ if (*emitter).encoding == YAML_ANY_ENCODING {
+ (*emitter).encoding = (*event).data.stream_start.encoding;
+ }
+ if (*emitter).encoding == YAML_ANY_ENCODING {
+ (*emitter).encoding = YAML_UTF8_ENCODING;
+ }
+ if (*emitter).best_indent < 2 || (*emitter).best_indent > 9 {
+ (*emitter).best_indent = 2;
+ }
+ if (*emitter).best_width >= 0
+ && (*emitter).best_width <= (*emitter).best_indent.force_mul(2)
+ {
+ (*emitter).best_width = 80;
+ }
+ if (*emitter).best_width < 0 {
+ (*emitter).best_width = libc::c_int::MAX;
+ }
+ if (*emitter).line_break == YAML_ANY_BREAK {
+ (*emitter).line_break = YAML_LN_BREAK;
+ }
+ (*emitter).indent = -1;
+ (*emitter).line = 0;
+ (*emitter).column = 0;
+ (*emitter).whitespace = true;
+ (*emitter).indention = true;
+ if (*emitter).encoding != YAML_UTF8_ENCODING {
+ if yaml_emitter_write_bom(emitter).fail {
+ return FAIL;
+ }
+ }
+ (*emitter).state = YAML_EMIT_FIRST_DOCUMENT_START_STATE;
+ return OK;
+ }
+ yaml_emitter_set_emitter_error(
+ emitter,
+ b"expected STREAM-START\0" as *const u8 as *const libc::c_char,
+ )
+}
+
+unsafe fn yaml_emitter_emit_document_start(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ if (*event).type_ == YAML_DOCUMENT_START_EVENT {
+ let mut default_tag_directives: [yaml_tag_directive_t; 3] = [
+ yaml_tag_directive_t {
+ handle: b"!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ prefix: b"!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ },
+ yaml_tag_directive_t {
+ handle: b"!!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ prefix: b"tag:yaml.org,2002:\0" as *const u8 as *const libc::c_char
+ as *mut yaml_char_t,
+ },
+ yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ },
+ ];
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ let mut implicit;
+ if !(*event).data.document_start.version_directive.is_null() {
+ if yaml_emitter_analyze_version_directive(
+ emitter,
+ *(*event).data.document_start.version_directive,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ tag_directive = (*event).data.document_start.tag_directives.start;
+ while tag_directive != (*event).data.document_start.tag_directives.end {
+ if yaml_emitter_analyze_tag_directive(emitter, *tag_directive).fail {
+ return FAIL;
+ }
+ if yaml_emitter_append_tag_directive(emitter, *tag_directive, false).fail {
+ return FAIL;
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ tag_directive = default_tag_directives.as_mut_ptr();
+ while !(*tag_directive).handle.is_null() {
+ if yaml_emitter_append_tag_directive(emitter, *tag_directive, true).fail {
+ return FAIL;
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ implicit = (*event).data.document_start.implicit;
+ if !first || (*emitter).canonical {
+ implicit = false;
+ }
+ if (!(*event).data.document_start.version_directive.is_null()
+ || (*event).data.document_start.tag_directives.start
+ != (*event).data.document_start.tag_directives.end)
+ && (*emitter).open_ended != 0
+ {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"...\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ (*emitter).open_ended = 0;
+ if !(*event).data.document_start.version_directive.is_null() {
+ implicit = false;
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"%YAML\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if (*(*event).data.document_start.version_directive).minor == 1 {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"1.1\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ } else if yaml_emitter_write_indicator(
+ emitter,
+ b"1.2\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if (*event).data.document_start.tag_directives.start
+ != (*event).data.document_start.tag_directives.end
+ {
+ implicit = false;
+ tag_directive = (*event).data.document_start.tag_directives.start;
+ while tag_directive != (*event).data.document_start.tag_directives.end {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"%TAG\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_tag_handle(
+ emitter,
+ (*tag_directive).handle,
+ strlen((*tag_directive).handle as *mut libc::c_char),
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_tag_content(
+ emitter,
+ (*tag_directive).prefix,
+ strlen((*tag_directive).prefix as *mut libc::c_char),
+ true,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ }
+ if yaml_emitter_check_empty_document(emitter) {
+ implicit = false;
+ }
+ if !implicit {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"---\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if (*emitter).canonical {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ }
+ (*emitter).state = YAML_EMIT_DOCUMENT_CONTENT_STATE;
+ (*emitter).open_ended = 0;
+ return OK;
+ } else if (*event).type_ == YAML_STREAM_END_EVENT {
+ if (*emitter).open_ended == 2 {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"...\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).open_ended = 0;
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if yaml_emitter_flush(emitter).fail {
+ return FAIL;
+ }
+ (*emitter).state = YAML_EMIT_END_STATE;
+ return OK;
+ }
+ yaml_emitter_set_emitter_error(
+ emitter,
+ b"expected DOCUMENT-START or STREAM-END\0" as *const u8 as *const libc::c_char,
+ )
+}
+
+unsafe fn yaml_emitter_emit_document_content(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ PUSH!((*emitter).states, YAML_EMIT_DOCUMENT_END_STATE);
+ yaml_emitter_emit_node(emitter, event, true, false, false, false)
+}
+
+unsafe fn yaml_emitter_emit_document_end(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ if (*event).type_ == YAML_DOCUMENT_END_EVENT {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if !(*event).data.document_end.implicit {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"...\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).open_ended = 0;
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ } else if (*emitter).open_ended == 0 {
+ (*emitter).open_ended = 1;
+ }
+ if yaml_emitter_flush(emitter).fail {
+ return FAIL;
+ }
+ (*emitter).state = YAML_EMIT_DOCUMENT_START_STATE;
+ while !STACK_EMPTY!((*emitter).tag_directives) {
+ let tag_directive = POP!((*emitter).tag_directives);
+ yaml_free(tag_directive.handle as *mut libc::c_void);
+ yaml_free(tag_directive.prefix as *mut libc::c_void);
+ }
+ return OK;
+ }
+ yaml_emitter_set_emitter_error(
+ emitter,
+ b"expected DOCUMENT-END\0" as *const u8 as *const libc::c_char,
+ )
+}
+
+unsafe fn yaml_emitter_emit_flow_sequence_item(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ if first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"[\0" as *const u8 as *const libc::c_char,
+ true,
+ true,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ yaml_emitter_increase_indent(emitter, true, false);
+ let fresh12 = addr_of_mut!((*emitter).flow_level);
+ *fresh12 += 1;
+ }
+ if (*event).type_ == YAML_SEQUENCE_END_EVENT {
+ let fresh13 = addr_of_mut!((*emitter).flow_level);
+ *fresh13 -= 1;
+ (*emitter).indent = POP!((*emitter).indents);
+ if (*emitter).canonical && !first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b",\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"]\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).state = POP!((*emitter).states);
+ return OK;
+ }
+ if !first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b",\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if (*emitter).canonical || (*emitter).column > (*emitter).best_width {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ PUSH!((*emitter).states, YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE);
+ yaml_emitter_emit_node(emitter, event, false, true, false, false)
+}
+
+unsafe fn yaml_emitter_emit_flow_mapping_key(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ if first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"{\0" as *const u8 as *const libc::c_char,
+ true,
+ true,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ yaml_emitter_increase_indent(emitter, true, false);
+ let fresh18 = addr_of_mut!((*emitter).flow_level);
+ *fresh18 += 1;
+ }
+ if (*event).type_ == YAML_MAPPING_END_EVENT {
+ if STACK_EMPTY!((*emitter).indents) {
+ return FAIL;
+ }
+ let fresh19 = addr_of_mut!((*emitter).flow_level);
+ *fresh19 -= 1;
+ (*emitter).indent = POP!((*emitter).indents);
+ if (*emitter).canonical && !first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b",\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"}\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).state = POP!((*emitter).states);
+ return OK;
+ }
+ if !first {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b",\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if (*emitter).canonical || (*emitter).column > (*emitter).best_width {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if !(*emitter).canonical && yaml_emitter_check_simple_key(emitter) {
+ PUSH!((*emitter).states, YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE);
+ yaml_emitter_emit_node(emitter, event, false, false, true, true)
+ } else {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"?\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ PUSH!((*emitter).states, YAML_EMIT_FLOW_MAPPING_VALUE_STATE);
+ yaml_emitter_emit_node(emitter, event, false, false, true, false)
+ }
+}
+
+unsafe fn yaml_emitter_emit_flow_mapping_value(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ simple: bool,
+) -> Success {
+ if simple {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b":\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ } else {
+ if (*emitter).canonical || (*emitter).column > (*emitter).best_width {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b":\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ PUSH!((*emitter).states, YAML_EMIT_FLOW_MAPPING_KEY_STATE);
+ yaml_emitter_emit_node(emitter, event, false, false, true, false)
+}
+
+unsafe fn yaml_emitter_emit_block_sequence_item(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ if first {
+ yaml_emitter_increase_indent(
+ emitter,
+ false,
+ (*emitter).mapping_context && !(*emitter).indention,
+ );
+ }
+ if (*event).type_ == YAML_SEQUENCE_END_EVENT {
+ (*emitter).indent = POP!((*emitter).indents);
+ (*emitter).state = POP!((*emitter).states);
+ return OK;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"-\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ true,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ PUSH!((*emitter).states, YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE);
+ yaml_emitter_emit_node(emitter, event, false, true, false, false)
+}
+
+unsafe fn yaml_emitter_emit_block_mapping_key(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ if first {
+ yaml_emitter_increase_indent(emitter, false, false);
+ }
+ if (*event).type_ == YAML_MAPPING_END_EVENT {
+ (*emitter).indent = POP!((*emitter).indents);
+ (*emitter).state = POP!((*emitter).states);
+ return OK;
+ }
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_check_simple_key(emitter) {
+ PUSH!(
+ (*emitter).states,
+ YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE
+ );
+ yaml_emitter_emit_node(emitter, event, false, false, true, true)
+ } else {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"?\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ true,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ PUSH!((*emitter).states, YAML_EMIT_BLOCK_MAPPING_VALUE_STATE);
+ yaml_emitter_emit_node(emitter, event, false, false, true, false)
+ }
+}
+
+unsafe fn yaml_emitter_emit_block_mapping_value(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ simple: bool,
+) -> Success {
+ if simple {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b":\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ } else {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b":\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ true,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ PUSH!((*emitter).states, YAML_EMIT_BLOCK_MAPPING_KEY_STATE);
+ yaml_emitter_emit_node(emitter, event, false, false, true, false)
+}
+
+unsafe fn yaml_emitter_emit_node(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+ root: bool,
+ sequence: bool,
+ mapping: bool,
+ simple_key: bool,
+) -> Success {
+ (*emitter).root_context = root;
+ (*emitter).sequence_context = sequence;
+ (*emitter).mapping_context = mapping;
+ (*emitter).simple_key_context = simple_key;
+ match (*event).type_ {
+ YAML_ALIAS_EVENT => yaml_emitter_emit_alias(emitter, event),
+ YAML_SCALAR_EVENT => yaml_emitter_emit_scalar(emitter, event),
+ YAML_SEQUENCE_START_EVENT => yaml_emitter_emit_sequence_start(emitter, event),
+ YAML_MAPPING_START_EVENT => yaml_emitter_emit_mapping_start(emitter, event),
+ _ => yaml_emitter_set_emitter_error(
+ emitter,
+ b"expected SCALAR, SEQUENCE-START, MAPPING-START, or ALIAS\0" as *const u8
+ as *const libc::c_char,
+ ),
+ }
+}
+
+unsafe fn yaml_emitter_emit_alias(
+ emitter: *mut yaml_emitter_t,
+ _event: *mut yaml_event_t,
+) -> Success {
+ if yaml_emitter_process_anchor(emitter).fail {
+ return FAIL;
+ }
+ if (*emitter).simple_key_context {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ (*emitter).state = POP!((*emitter).states);
+ OK
+}
+
+unsafe fn yaml_emitter_emit_scalar(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ if yaml_emitter_select_scalar_style(emitter, event).fail {
+ return FAIL;
+ }
+ if yaml_emitter_process_anchor(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_process_tag(emitter).fail {
+ return FAIL;
+ }
+ yaml_emitter_increase_indent(emitter, true, false);
+ if yaml_emitter_process_scalar(emitter).fail {
+ return FAIL;
+ }
+ (*emitter).indent = POP!((*emitter).indents);
+ (*emitter).state = POP!((*emitter).states);
+ OK
+}
+
+unsafe fn yaml_emitter_emit_sequence_start(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ if yaml_emitter_process_anchor(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_process_tag(emitter).fail {
+ return FAIL;
+ }
+ if (*emitter).flow_level != 0
+ || (*emitter).canonical
+ || (*event).data.sequence_start.style == YAML_FLOW_SEQUENCE_STYLE
+ || yaml_emitter_check_empty_sequence(emitter)
+ {
+ (*emitter).state = YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE;
+ } else {
+ (*emitter).state = YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE;
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_emit_mapping_start(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ if yaml_emitter_process_anchor(emitter).fail {
+ return FAIL;
+ }
+ if yaml_emitter_process_tag(emitter).fail {
+ return FAIL;
+ }
+ if (*emitter).flow_level != 0
+ || (*emitter).canonical
+ || (*event).data.mapping_start.style == YAML_FLOW_MAPPING_STYLE
+ || yaml_emitter_check_empty_mapping(emitter)
+ {
+ (*emitter).state = YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE;
+ } else {
+ (*emitter).state = YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE;
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_check_empty_document(_emitter: *mut yaml_emitter_t) -> bool {
+ false
+}
+
+unsafe fn yaml_emitter_check_empty_sequence(emitter: *mut yaml_emitter_t) -> bool {
+ if ((*emitter).events.tail.c_offset_from((*emitter).events.head) as libc::c_long) < 2_i64 {
+ return false;
+ }
+ (*(*emitter).events.head).type_ == YAML_SEQUENCE_START_EVENT
+ && (*(*emitter).events.head.wrapping_offset(1_isize)).type_ == YAML_SEQUENCE_END_EVENT
+}
+
+unsafe fn yaml_emitter_check_empty_mapping(emitter: *mut yaml_emitter_t) -> bool {
+ if ((*emitter).events.tail.c_offset_from((*emitter).events.head) as libc::c_long) < 2_i64 {
+ return false;
+ }
+ (*(*emitter).events.head).type_ == YAML_MAPPING_START_EVENT
+ && (*(*emitter).events.head.wrapping_offset(1_isize)).type_ == YAML_MAPPING_END_EVENT
+}
+
+unsafe fn yaml_emitter_check_simple_key(emitter: *mut yaml_emitter_t) -> bool {
+ let event: *mut yaml_event_t = (*emitter).events.head;
+ let mut length: size_t = 0_u64;
+ match (*event).type_ {
+ YAML_ALIAS_EVENT => {
+ length =
+ (length as libc::c_ulong).force_add((*emitter).anchor_data.anchor_length) as size_t;
+ }
+ YAML_SCALAR_EVENT => {
+ if (*emitter).scalar_data.multiline {
+ return false;
+ }
+ length = (length as libc::c_ulong)
+ .force_add((*emitter).anchor_data.anchor_length)
+ .force_add((*emitter).tag_data.handle_length)
+ .force_add((*emitter).tag_data.suffix_length)
+ .force_add((*emitter).scalar_data.length) as size_t;
+ }
+ YAML_SEQUENCE_START_EVENT => {
+ if !yaml_emitter_check_empty_sequence(emitter) {
+ return false;
+ }
+ length = (length as libc::c_ulong)
+ .force_add((*emitter).anchor_data.anchor_length)
+ .force_add((*emitter).tag_data.handle_length)
+ .force_add((*emitter).tag_data.suffix_length) as size_t;
+ }
+ YAML_MAPPING_START_EVENT => {
+ if !yaml_emitter_check_empty_mapping(emitter) {
+ return false;
+ }
+ length = (length as libc::c_ulong)
+ .force_add((*emitter).anchor_data.anchor_length)
+ .force_add((*emitter).tag_data.handle_length)
+ .force_add((*emitter).tag_data.suffix_length) as size_t;
+ }
+ _ => return false,
+ }
+ if length > 128_u64 {
+ return false;
+ }
+ true
+}
+
+unsafe fn yaml_emitter_select_scalar_style(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut style: yaml_scalar_style_t = (*event).data.scalar.style;
+ let no_tag = (*emitter).tag_data.handle.is_null() && (*emitter).tag_data.suffix.is_null();
+ if no_tag && !(*event).data.scalar.plain_implicit && !(*event).data.scalar.quoted_implicit {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"neither tag nor implicit flags are specified\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ if style == YAML_ANY_SCALAR_STYLE {
+ style = YAML_PLAIN_SCALAR_STYLE;
+ }
+ if (*emitter).canonical {
+ style = YAML_DOUBLE_QUOTED_SCALAR_STYLE;
+ }
+ if (*emitter).simple_key_context && (*emitter).scalar_data.multiline {
+ style = YAML_DOUBLE_QUOTED_SCALAR_STYLE;
+ }
+ if style == YAML_PLAIN_SCALAR_STYLE {
+ if (*emitter).flow_level != 0 && !(*emitter).scalar_data.flow_plain_allowed
+ || (*emitter).flow_level == 0 && !(*emitter).scalar_data.block_plain_allowed
+ {
+ style = YAML_SINGLE_QUOTED_SCALAR_STYLE;
+ }
+ if (*emitter).scalar_data.length == 0
+ && ((*emitter).flow_level != 0 || (*emitter).simple_key_context)
+ {
+ style = YAML_SINGLE_QUOTED_SCALAR_STYLE;
+ }
+ if no_tag && !(*event).data.scalar.plain_implicit {
+ style = YAML_SINGLE_QUOTED_SCALAR_STYLE;
+ }
+ }
+ if style == YAML_SINGLE_QUOTED_SCALAR_STYLE {
+ if !(*emitter).scalar_data.single_quoted_allowed {
+ style = YAML_DOUBLE_QUOTED_SCALAR_STYLE;
+ }
+ }
+ if style == YAML_LITERAL_SCALAR_STYLE || style == YAML_FOLDED_SCALAR_STYLE {
+ if !(*emitter).scalar_data.block_allowed
+ || (*emitter).flow_level != 0
+ || (*emitter).simple_key_context
+ {
+ style = YAML_DOUBLE_QUOTED_SCALAR_STYLE;
+ }
+ }
+ if no_tag && !(*event).data.scalar.quoted_implicit && style != YAML_PLAIN_SCALAR_STYLE {
+ let fresh46 = addr_of_mut!((*emitter).tag_data.handle);
+ *fresh46 = b"!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t;
+ (*emitter).tag_data.handle_length = 1_u64;
+ }
+ (*emitter).scalar_data.style = style;
+ OK
+}
+
+unsafe fn yaml_emitter_process_anchor(emitter: *mut yaml_emitter_t) -> Success {
+ if (*emitter).anchor_data.anchor.is_null() {
+ return OK;
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ if (*emitter).anchor_data.alias {
+ b"*\0" as *const u8 as *const libc::c_char
+ } else {
+ b"&\0" as *const u8 as *const libc::c_char
+ },
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ yaml_emitter_write_anchor(
+ emitter,
+ (*emitter).anchor_data.anchor,
+ (*emitter).anchor_data.anchor_length,
+ )
+}
+
+unsafe fn yaml_emitter_process_tag(emitter: *mut yaml_emitter_t) -> Success {
+ if (*emitter).tag_data.handle.is_null() && (*emitter).tag_data.suffix.is_null() {
+ return OK;
+ }
+ if !(*emitter).tag_data.handle.is_null() {
+ if yaml_emitter_write_tag_handle(
+ emitter,
+ (*emitter).tag_data.handle,
+ (*emitter).tag_data.handle_length,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if !(*emitter).tag_data.suffix.is_null() {
+ if yaml_emitter_write_tag_content(
+ emitter,
+ (*emitter).tag_data.suffix,
+ (*emitter).tag_data.suffix_length,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ } else {
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"!<\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_tag_content(
+ emitter,
+ (*emitter).tag_data.suffix,
+ (*emitter).tag_data.suffix_length,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b">\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_process_scalar(emitter: *mut yaml_emitter_t) -> Success {
+ match (*emitter).scalar_data.style {
+ YAML_PLAIN_SCALAR_STYLE => {
+ return yaml_emitter_write_plain_scalar(
+ emitter,
+ (*emitter).scalar_data.value,
+ (*emitter).scalar_data.length,
+ !(*emitter).simple_key_context,
+ );
+ }
+ YAML_SINGLE_QUOTED_SCALAR_STYLE => {
+ return yaml_emitter_write_single_quoted_scalar(
+ emitter,
+ (*emitter).scalar_data.value,
+ (*emitter).scalar_data.length,
+ !(*emitter).simple_key_context,
+ );
+ }
+ YAML_DOUBLE_QUOTED_SCALAR_STYLE => {
+ return yaml_emitter_write_double_quoted_scalar(
+ emitter,
+ (*emitter).scalar_data.value,
+ (*emitter).scalar_data.length,
+ !(*emitter).simple_key_context,
+ );
+ }
+ YAML_LITERAL_SCALAR_STYLE => {
+ return yaml_emitter_write_literal_scalar(
+ emitter,
+ (*emitter).scalar_data.value,
+ (*emitter).scalar_data.length,
+ );
+ }
+ YAML_FOLDED_SCALAR_STYLE => {
+ return yaml_emitter_write_folded_scalar(
+ emitter,
+ (*emitter).scalar_data.value,
+ (*emitter).scalar_data.length,
+ );
+ }
+ _ => {}
+ }
+ FAIL
+}
+
+unsafe fn yaml_emitter_analyze_version_directive(
+ emitter: *mut yaml_emitter_t,
+ version_directive: yaml_version_directive_t,
+) -> Success {
+ if version_directive.major != 1 || version_directive.minor != 1 && version_directive.minor != 2
+ {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"incompatible %YAML directive\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_analyze_tag_directive(
+ emitter: *mut yaml_emitter_t,
+ tag_directive: yaml_tag_directive_t,
+) -> Success {
+ let handle_length: size_t = strlen(tag_directive.handle as *mut libc::c_char);
+ let prefix_length: size_t = strlen(tag_directive.prefix as *mut libc::c_char);
+ let mut handle = STRING_ASSIGN!(tag_directive.handle, handle_length);
+ let prefix = STRING_ASSIGN!(tag_directive.prefix, prefix_length);
+ if handle.start == handle.end {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag handle must not be empty\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ if *handle.start != b'!' {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag handle must start with '!'\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ if *handle.end.wrapping_offset(-1_isize) != b'!' {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag handle must end with '!'\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ handle.pointer = handle.pointer.wrapping_offset(1);
+ while handle.pointer < handle.end.wrapping_offset(-1_isize) {
+ if !IS_ALPHA!(handle) {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag handle must contain alphanumerical characters only\0" as *const u8
+ as *const libc::c_char,
+ );
+ }
+ MOVE!(handle);
+ }
+ if prefix.start == prefix.end {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag prefix must not be empty\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_analyze_anchor(
+ emitter: *mut yaml_emitter_t,
+ anchor: *mut yaml_char_t,
+ alias: bool,
+) -> Success {
+ let anchor_length: size_t = strlen(anchor as *mut libc::c_char);
+ let mut string = STRING_ASSIGN!(anchor, anchor_length);
+ if string.start == string.end {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ if alias {
+ b"alias value must not be empty\0" as *const u8 as *const libc::c_char
+ } else {
+ b"anchor value must not be empty\0" as *const u8 as *const libc::c_char
+ },
+ );
+ }
+ while string.pointer != string.end {
+ if !IS_ALPHA!(string) {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ if alias {
+ b"alias value must contain alphanumerical characters only\0" as *const u8
+ as *const libc::c_char
+ } else {
+ b"anchor value must contain alphanumerical characters only\0" as *const u8
+ as *const libc::c_char
+ },
+ );
+ }
+ MOVE!(string);
+ }
+ let fresh47 = addr_of_mut!((*emitter).anchor_data.anchor);
+ *fresh47 = string.start;
+ (*emitter).anchor_data.anchor_length = string.end.c_offset_from(string.start) as size_t;
+ (*emitter).anchor_data.alias = alias;
+ OK
+}
+
+unsafe fn yaml_emitter_analyze_tag(emitter: *mut yaml_emitter_t, tag: *mut yaml_char_t) -> Success {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ let tag_length: size_t = strlen(tag as *mut libc::c_char);
+ let string = STRING_ASSIGN!(tag, tag_length);
+ if string.start == string.end {
+ return yaml_emitter_set_emitter_error(
+ emitter,
+ b"tag value must not be empty\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ tag_directive = (*emitter).tag_directives.start;
+ while tag_directive != (*emitter).tag_directives.top {
+ let prefix_length: size_t = strlen((*tag_directive).prefix as *mut libc::c_char);
+ if prefix_length < string.end.c_offset_from(string.start) as size_t
+ && strncmp(
+ (*tag_directive).prefix as *mut libc::c_char,
+ string.start as *mut libc::c_char,
+ prefix_length,
+ ) == 0
+ {
+ let fresh48 = addr_of_mut!((*emitter).tag_data.handle);
+ *fresh48 = (*tag_directive).handle;
+ (*emitter).tag_data.handle_length =
+ strlen((*tag_directive).handle as *mut libc::c_char);
+ let fresh49 = addr_of_mut!((*emitter).tag_data.suffix);
+ *fresh49 = string.start.wrapping_offset(prefix_length as isize);
+ (*emitter).tag_data.suffix_length = (string.end.c_offset_from(string.start)
+ as libc::c_ulong)
+ .wrapping_sub(prefix_length);
+ return OK;
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ let fresh50 = addr_of_mut!((*emitter).tag_data.suffix);
+ *fresh50 = string.start;
+ (*emitter).tag_data.suffix_length = string.end.c_offset_from(string.start) as size_t;
+ OK
+}
+
+unsafe fn yaml_emitter_analyze_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+) -> Success {
+ let mut block_indicators = false;
+ let mut flow_indicators = false;
+ let mut line_breaks = false;
+ let mut special_characters = false;
+ let mut leading_space = false;
+ let mut leading_break = false;
+ let mut trailing_space = false;
+ let mut trailing_break = false;
+ let mut break_space = false;
+ let mut space_break = false;
+ let mut preceded_by_whitespace;
+ let mut followed_by_whitespace;
+ let mut previous_space = false;
+ let mut previous_break = false;
+ let mut string = STRING_ASSIGN!(value, length);
+ let fresh51 = addr_of_mut!((*emitter).scalar_data.value);
+ *fresh51 = value;
+ (*emitter).scalar_data.length = length;
+ if string.start == string.end {
+ (*emitter).scalar_data.multiline = false;
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ (*emitter).scalar_data.block_plain_allowed = true;
+ (*emitter).scalar_data.single_quoted_allowed = true;
+ (*emitter).scalar_data.block_allowed = false;
+ return OK;
+ }
+ if CHECK_AT!(string, b'-', 0) && CHECK_AT!(string, b'-', 1) && CHECK_AT!(string, b'-', 2)
+ || CHECK_AT!(string, b'.', 0) && CHECK_AT!(string, b'.', 1) && CHECK_AT!(string, b'.', 2)
+ {
+ block_indicators = true;
+ flow_indicators = true;
+ }
+ preceded_by_whitespace = true;
+ followed_by_whitespace = IS_BLANKZ_AT!(string, WIDTH!(string));
+ while string.pointer != string.end {
+ if string.start == string.pointer {
+ if CHECK!(string, b'#')
+ || CHECK!(string, b',')
+ || CHECK!(string, b'[')
+ || CHECK!(string, b']')
+ || CHECK!(string, b'{')
+ || CHECK!(string, b'}')
+ || CHECK!(string, b'&')
+ || CHECK!(string, b'*')
+ || CHECK!(string, b'!')
+ || CHECK!(string, b'|')
+ || CHECK!(string, b'>')
+ || CHECK!(string, b'\'')
+ || CHECK!(string, b'"')
+ || CHECK!(string, b'%')
+ || CHECK!(string, b'@')
+ || CHECK!(string, b'`')
+ {
+ flow_indicators = true;
+ block_indicators = true;
+ }
+ if CHECK!(string, b'?') || CHECK!(string, b':') {
+ flow_indicators = true;
+ if followed_by_whitespace {
+ block_indicators = true;
+ }
+ }
+ if CHECK!(string, b'-') && followed_by_whitespace {
+ flow_indicators = true;
+ block_indicators = true;
+ }
+ } else {
+ if CHECK!(string, b',')
+ || CHECK!(string, b'?')
+ || CHECK!(string, b'[')
+ || CHECK!(string, b']')
+ || CHECK!(string, b'{')
+ || CHECK!(string, b'}')
+ {
+ flow_indicators = true;
+ }
+ if CHECK!(string, b':') {
+ flow_indicators = true;
+ if followed_by_whitespace {
+ block_indicators = true;
+ }
+ }
+ if CHECK!(string, b'#') && preceded_by_whitespace {
+ flow_indicators = true;
+ block_indicators = true;
+ }
+ }
+ if !IS_PRINTABLE!(string) || !IS_ASCII!(string) && !(*emitter).unicode {
+ special_characters = true;
+ }
+ if IS_BREAK!(string) {
+ line_breaks = true;
+ }
+ if IS_SPACE!(string) {
+ if string.start == string.pointer {
+ leading_space = true;
+ }
+ if string.pointer.wrapping_offset(WIDTH!(string) as isize) == string.end {
+ trailing_space = true;
+ }
+ if previous_break {
+ break_space = true;
+ }
+ previous_space = true;
+ previous_break = false;
+ } else if IS_BREAK!(string) {
+ if string.start == string.pointer {
+ leading_break = true;
+ }
+ if string.pointer.wrapping_offset(WIDTH!(string) as isize) == string.end {
+ trailing_break = true;
+ }
+ if previous_space {
+ space_break = true;
+ }
+ previous_space = false;
+ previous_break = true;
+ } else {
+ previous_space = false;
+ previous_break = false;
+ }
+ preceded_by_whitespace = IS_BLANKZ!(string);
+ MOVE!(string);
+ if string.pointer != string.end {
+ followed_by_whitespace = IS_BLANKZ_AT!(string, WIDTH!(string));
+ }
+ }
+ (*emitter).scalar_data.multiline = line_breaks;
+ (*emitter).scalar_data.flow_plain_allowed = true;
+ (*emitter).scalar_data.block_plain_allowed = true;
+ (*emitter).scalar_data.single_quoted_allowed = true;
+ (*emitter).scalar_data.block_allowed = true;
+ if leading_space || leading_break || trailing_space || trailing_break {
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ (*emitter).scalar_data.block_plain_allowed = false;
+ }
+ if trailing_space {
+ (*emitter).scalar_data.block_allowed = false;
+ }
+ if break_space {
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ (*emitter).scalar_data.block_plain_allowed = false;
+ (*emitter).scalar_data.single_quoted_allowed = false;
+ }
+ if space_break || special_characters {
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ (*emitter).scalar_data.block_plain_allowed = false;
+ (*emitter).scalar_data.single_quoted_allowed = false;
+ (*emitter).scalar_data.block_allowed = false;
+ }
+ if line_breaks {
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ (*emitter).scalar_data.block_plain_allowed = false;
+ }
+ if flow_indicators {
+ (*emitter).scalar_data.flow_plain_allowed = false;
+ }
+ if block_indicators {
+ (*emitter).scalar_data.block_plain_allowed = false;
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_analyze_event(
+ emitter: *mut yaml_emitter_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let fresh52 = addr_of_mut!((*emitter).anchor_data.anchor);
+ *fresh52 = ptr::null_mut::<yaml_char_t>();
+ (*emitter).anchor_data.anchor_length = 0_u64;
+ let fresh53 = addr_of_mut!((*emitter).tag_data.handle);
+ *fresh53 = ptr::null_mut::<yaml_char_t>();
+ (*emitter).tag_data.handle_length = 0_u64;
+ let fresh54 = addr_of_mut!((*emitter).tag_data.suffix);
+ *fresh54 = ptr::null_mut::<yaml_char_t>();
+ (*emitter).tag_data.suffix_length = 0_u64;
+ let fresh55 = addr_of_mut!((*emitter).scalar_data.value);
+ *fresh55 = ptr::null_mut::<yaml_char_t>();
+ (*emitter).scalar_data.length = 0_u64;
+ match (*event).type_ {
+ YAML_ALIAS_EVENT => yaml_emitter_analyze_anchor(emitter, (*event).data.alias.anchor, true),
+ YAML_SCALAR_EVENT => {
+ if !(*event).data.scalar.anchor.is_null() {
+ if yaml_emitter_analyze_anchor(emitter, (*event).data.scalar.anchor, false).fail {
+ return FAIL;
+ }
+ }
+ if !(*event).data.scalar.tag.is_null()
+ && ((*emitter).canonical
+ || !(*event).data.scalar.plain_implicit
+ && !(*event).data.scalar.quoted_implicit)
+ {
+ if yaml_emitter_analyze_tag(emitter, (*event).data.scalar.tag).fail {
+ return FAIL;
+ }
+ }
+ yaml_emitter_analyze_scalar(
+ emitter,
+ (*event).data.scalar.value,
+ (*event).data.scalar.length,
+ )
+ }
+ YAML_SEQUENCE_START_EVENT => {
+ if !(*event).data.sequence_start.anchor.is_null() {
+ if yaml_emitter_analyze_anchor(emitter, (*event).data.sequence_start.anchor, false)
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if !(*event).data.sequence_start.tag.is_null()
+ && ((*emitter).canonical || !(*event).data.sequence_start.implicit)
+ {
+ if yaml_emitter_analyze_tag(emitter, (*event).data.sequence_start.tag).fail {
+ return FAIL;
+ }
+ }
+ OK
+ }
+ YAML_MAPPING_START_EVENT => {
+ if !(*event).data.mapping_start.anchor.is_null() {
+ if yaml_emitter_analyze_anchor(emitter, (*event).data.mapping_start.anchor, false)
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if !(*event).data.mapping_start.tag.is_null()
+ && ((*emitter).canonical || !(*event).data.mapping_start.implicit)
+ {
+ if yaml_emitter_analyze_tag(emitter, (*event).data.mapping_start.tag).fail {
+ return FAIL;
+ }
+ }
+ OK
+ }
+ _ => OK,
+ }
+}
+
+unsafe fn yaml_emitter_write_bom(emitter: *mut yaml_emitter_t) -> Success {
+ if FLUSH(emitter).fail {
+ return FAIL;
+ }
+ let fresh56 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh57 = *fresh56;
+ *fresh56 = (*fresh56).wrapping_offset(1);
+ *fresh57 = b'\xEF';
+ let fresh58 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh59 = *fresh58;
+ *fresh58 = (*fresh58).wrapping_offset(1);
+ *fresh59 = b'\xBB';
+ let fresh60 = addr_of_mut!((*emitter).buffer.pointer);
+ let fresh61 = *fresh60;
+ *fresh60 = (*fresh60).wrapping_offset(1);
+ *fresh61 = b'\xBF';
+ OK
+}
+
+unsafe fn yaml_emitter_write_indent(emitter: *mut yaml_emitter_t) -> Success {
+ let indent: libc::c_int = if (*emitter).indent >= 0 {
+ (*emitter).indent
+ } else {
+ 0
+ };
+ if !(*emitter).indention
+ || (*emitter).column > indent
+ || (*emitter).column == indent && !(*emitter).whitespace
+ {
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ }
+ while (*emitter).column < indent {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ (*emitter).whitespace = true;
+ (*emitter).indention = true;
+ OK
+}
+
+unsafe fn yaml_emitter_write_indicator(
+ emitter: *mut yaml_emitter_t,
+ indicator: *const libc::c_char,
+ need_whitespace: bool,
+ is_whitespace: bool,
+ is_indention: bool,
+) -> Success {
+ let indicator_length: size_t = strlen(indicator);
+ let mut string = STRING_ASSIGN!(indicator as *mut yaml_char_t, indicator_length);
+ if need_whitespace && !(*emitter).whitespace {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ while string.pointer != string.end {
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ }
+ (*emitter).whitespace = is_whitespace;
+ (*emitter).indention = (*emitter).indention && is_indention;
+ OK
+}
+
+unsafe fn yaml_emitter_write_anchor(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+) -> Success {
+ let mut string = STRING_ASSIGN!(value, length);
+ while string.pointer != string.end {
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_tag_handle(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+) -> Success {
+ let mut string = STRING_ASSIGN!(value, length);
+ if !(*emitter).whitespace {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ while string.pointer != string.end {
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_tag_content(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+ need_whitespace: bool,
+) -> Success {
+ let mut string = STRING_ASSIGN!(value, length);
+ if need_whitespace && !(*emitter).whitespace {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ while string.pointer != string.end {
+ if IS_ALPHA!(string)
+ || CHECK!(string, b';')
+ || CHECK!(string, b'/')
+ || CHECK!(string, b'?')
+ || CHECK!(string, b':')
+ || CHECK!(string, b'@')
+ || CHECK!(string, b'&')
+ || CHECK!(string, b'=')
+ || CHECK!(string, b'+')
+ || CHECK!(string, b'$')
+ || CHECK!(string, b',')
+ || CHECK!(string, b'_')
+ || CHECK!(string, b'.')
+ || CHECK!(string, b'~')
+ || CHECK!(string, b'*')
+ || CHECK!(string, b'\'')
+ || CHECK!(string, b'(')
+ || CHECK!(string, b')')
+ || CHECK!(string, b'[')
+ || CHECK!(string, b']')
+ {
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ } else {
+ let mut width = WIDTH!(string);
+ loop {
+ let fresh207 = width;
+ width -= 1;
+ if !(fresh207 != 0) {
+ break;
+ }
+ let fresh208 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ let value = *fresh208;
+ if PUT(emitter, b'%').fail {
+ return FAIL;
+ }
+ if PUT(
+ emitter,
+ (value >> 4).force_add(if (value >> 4) < 10 { b'0' } else { b'A' - 10 }),
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if PUT(
+ emitter,
+ (value & 0x0F).force_add(if (value & 0x0F) < 10 { b'0' } else { b'A' - 10 }),
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ }
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_plain_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+ allow_breaks: bool,
+) -> Success {
+ let mut spaces = false;
+ let mut breaks = false;
+ let mut string = STRING_ASSIGN!(value, length);
+ if !(*emitter).whitespace && (length != 0 || (*emitter).flow_level != 0) {
+ if PUT(emitter, b' ').fail {
+ return FAIL;
+ }
+ }
+ while string.pointer != string.end {
+ if IS_SPACE!(string) {
+ if allow_breaks
+ && !spaces
+ && (*emitter).column > (*emitter).best_width
+ && !IS_SPACE_AT!(string, 1)
+ {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ MOVE!(string);
+ } else if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ spaces = true;
+ } else if IS_BREAK!(string) {
+ if !breaks && CHECK!(string, b'\n') {
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ }
+ if WRITE_BREAK!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ breaks = true;
+ } else {
+ if breaks {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = false;
+ spaces = false;
+ breaks = false;
+ }
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_single_quoted_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+ allow_breaks: bool,
+) -> Success {
+ let mut spaces = false;
+ let mut breaks = false;
+ let mut string = STRING_ASSIGN!(value, length);
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"'\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ while string.pointer != string.end {
+ if IS_SPACE!(string) {
+ if allow_breaks
+ && !spaces
+ && (*emitter).column > (*emitter).best_width
+ && string.pointer != string.start
+ && string.pointer != string.end.wrapping_offset(-1_isize)
+ && !IS_SPACE_AT!(string, 1)
+ {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ MOVE!(string);
+ } else if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ spaces = true;
+ } else if IS_BREAK!(string) {
+ if !breaks && CHECK!(string, b'\n') {
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ }
+ if WRITE_BREAK!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ breaks = true;
+ } else {
+ if breaks {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if CHECK!(string, b'\'') {
+ if PUT(emitter, b'\'').fail {
+ return FAIL;
+ }
+ }
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = false;
+ spaces = false;
+ breaks = false;
+ }
+ }
+ if breaks {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"'\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_double_quoted_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+ allow_breaks: bool,
+) -> Success {
+ let mut spaces = false;
+ let mut string = STRING_ASSIGN!(value, length);
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"\"\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ while string.pointer != string.end {
+ if !IS_PRINTABLE!(string)
+ || !(*emitter).unicode && !IS_ASCII!(string)
+ || IS_BOM!(string)
+ || IS_BREAK!(string)
+ || CHECK!(string, b'"')
+ || CHECK!(string, b'\\')
+ {
+ let mut octet: libc::c_uchar;
+ let mut width: libc::c_uint;
+ let mut value_0: libc::c_uint;
+ let mut k: libc::c_int;
+ octet = *string.pointer;
+ width = if octet & 0x80 == 0x00 {
+ 1
+ } else if octet & 0xE0 == 0xC0 {
+ 2
+ } else if octet & 0xF0 == 0xE0 {
+ 3
+ } else if octet & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ };
+ value_0 = if octet & 0x80 == 0 {
+ octet & 0x7F
+ } else if octet & 0xE0 == 0xC0 {
+ octet & 0x1F
+ } else if octet & 0xF0 == 0xE0 {
+ octet & 0x0F
+ } else if octet & 0xF8 == 0xF0 {
+ octet & 0x07
+ } else {
+ 0
+ } as libc::c_uint;
+ k = 1;
+ while k < width as libc::c_int {
+ octet = *string.pointer.wrapping_offset(k as isize);
+ value_0 = (value_0 << 6).force_add((octet & 0x3F) as libc::c_uint);
+ k += 1;
+ }
+ string.pointer = string.pointer.wrapping_offset(width as isize);
+ if PUT(emitter, b'\\').fail {
+ return FAIL;
+ }
+ match value_0 {
+ 0x00 => {
+ if PUT(emitter, b'0').fail {
+ return FAIL;
+ }
+ }
+ 0x07 => {
+ if PUT(emitter, b'a').fail {
+ return FAIL;
+ }
+ }
+ 0x08 => {
+ if PUT(emitter, b'b').fail {
+ return FAIL;
+ }
+ }
+ 0x09 => {
+ if PUT(emitter, b't').fail {
+ return FAIL;
+ }
+ }
+ 0x0A => {
+ if PUT(emitter, b'n').fail {
+ return FAIL;
+ }
+ }
+ 0x0B => {
+ if PUT(emitter, b'v').fail {
+ return FAIL;
+ }
+ }
+ 0x0C => {
+ if PUT(emitter, b'f').fail {
+ return FAIL;
+ }
+ }
+ 0x0D => {
+ if PUT(emitter, b'r').fail {
+ return FAIL;
+ }
+ }
+ 0x1B => {
+ if PUT(emitter, b'e').fail {
+ return FAIL;
+ }
+ }
+ 0x22 => {
+ if PUT(emitter, b'"').fail {
+ return FAIL;
+ }
+ }
+ 0x5C => {
+ if PUT(emitter, b'\\').fail {
+ return FAIL;
+ }
+ }
+ 0x85 => {
+ if PUT(emitter, b'N').fail {
+ return FAIL;
+ }
+ }
+ 0xA0 => {
+ if PUT(emitter, b'_').fail {
+ return FAIL;
+ }
+ }
+ 0x2028 => {
+ if PUT(emitter, b'L').fail {
+ return FAIL;
+ }
+ }
+ 0x2029 => {
+ if PUT(emitter, b'P').fail {
+ return FAIL;
+ }
+ }
+ _ => {
+ if value_0 <= 0xFF {
+ if PUT(emitter, b'x').fail {
+ return FAIL;
+ }
+ width = 2;
+ } else if value_0 <= 0xFFFF {
+ if PUT(emitter, b'u').fail {
+ return FAIL;
+ }
+ width = 4;
+ } else {
+ if PUT(emitter, b'U').fail {
+ return FAIL;
+ }
+ width = 8;
+ }
+ k = width.wrapping_sub(1).wrapping_mul(4) as libc::c_int;
+ while k >= 0 {
+ let digit: libc::c_int = (value_0 >> k & 0x0F) as libc::c_int;
+ if PUT(
+ emitter,
+ (digit + if digit < 10 { b'0' } else { b'A' - 10 } as i32) as u8,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ k -= 4;
+ }
+ }
+ }
+ spaces = false;
+ } else if IS_SPACE!(string) {
+ if allow_breaks
+ && !spaces
+ && (*emitter).column > (*emitter).best_width
+ && string.pointer != string.start
+ && string.pointer != string.end.wrapping_offset(-1_isize)
+ {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ if IS_SPACE_AT!(string, 1) {
+ if PUT(emitter, b'\\').fail {
+ return FAIL;
+ }
+ }
+ MOVE!(string);
+ } else if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ spaces = true;
+ } else {
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ spaces = false;
+ }
+ }
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"\"\0" as *const u8 as *const libc::c_char,
+ false,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*emitter).whitespace = false;
+ (*emitter).indention = false;
+ OK
+}
+
+unsafe fn yaml_emitter_write_block_scalar_hints(
+ emitter: *mut yaml_emitter_t,
+ mut string: yaml_string_t,
+) -> Success {
+ let mut indent_hint: [libc::c_char; 2] = [0; 2];
+ let mut chomp_hint: *const libc::c_char = ptr::null::<libc::c_char>();
+ if IS_SPACE!(string) || IS_BREAK!(string) {
+ indent_hint[0] = (b'0' as libc::c_int + (*emitter).best_indent) as libc::c_char;
+ indent_hint[1] = '\0' as libc::c_char;
+ if yaml_emitter_write_indicator(emitter, indent_hint.as_mut_ptr(), false, false, false).fail
+ {
+ return FAIL;
+ }
+ }
+ (*emitter).open_ended = 0;
+ string.pointer = string.end;
+ if string.start == string.pointer {
+ chomp_hint = b"-\0" as *const u8 as *const libc::c_char;
+ } else {
+ loop {
+ string.pointer = string.pointer.wrapping_offset(-1);
+ if !(*string.pointer & 0xC0 == 0x80) {
+ break;
+ }
+ }
+ if !IS_BREAK!(string) {
+ chomp_hint = b"-\0" as *const u8 as *const libc::c_char;
+ } else if string.start == string.pointer {
+ chomp_hint = b"+\0" as *const u8 as *const libc::c_char;
+ (*emitter).open_ended = 2;
+ } else {
+ loop {
+ string.pointer = string.pointer.wrapping_offset(-1);
+ if !(*string.pointer & 0xC0 == 0x80) {
+ break;
+ }
+ }
+ if IS_BREAK!(string) {
+ chomp_hint = b"+\0" as *const u8 as *const libc::c_char;
+ (*emitter).open_ended = 2;
+ }
+ }
+ }
+ if !chomp_hint.is_null() {
+ if yaml_emitter_write_indicator(emitter, chomp_hint, false, false, false).fail {
+ return FAIL;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_write_literal_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+) -> Success {
+ let mut breaks = true;
+ let mut string = STRING_ASSIGN!(value, length);
+ if yaml_emitter_write_indicator(
+ emitter,
+ b"|\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_block_scalar_hints(emitter, string).fail {
+ return FAIL;
+ }
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ (*emitter).whitespace = true;
+ while string.pointer != string.end {
+ if IS_BREAK!(string) {
+ if WRITE_BREAK!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ breaks = true;
+ } else {
+ if breaks {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ }
+ if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = false;
+ breaks = false;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_emitter_write_folded_scalar(
+ emitter: *mut yaml_emitter_t,
+ value: *mut yaml_char_t,
+ length: size_t,
+) -> Success {
+ let mut breaks = true;
+ let mut leading_spaces = true;
+ let mut string = STRING_ASSIGN!(value, length);
+ if yaml_emitter_write_indicator(
+ emitter,
+ b">\0" as *const u8 as *const libc::c_char,
+ true,
+ false,
+ false,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ if yaml_emitter_write_block_scalar_hints(emitter, string).fail {
+ return FAIL;
+ }
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ (*emitter).whitespace = true;
+ while string.pointer != string.end {
+ if IS_BREAK!(string) {
+ if !breaks && !leading_spaces && CHECK!(string, b'\n') {
+ let mut k: libc::c_int = 0;
+ while IS_BREAK_AT!(string, k as isize) {
+ k += WIDTH_AT!(string, k as isize);
+ }
+ if !IS_BLANKZ_AT!(string, k) {
+ if PUT_BREAK(emitter).fail {
+ return FAIL;
+ }
+ }
+ }
+ if WRITE_BREAK!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = true;
+ breaks = true;
+ } else {
+ if breaks {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ leading_spaces = IS_BLANK!(string);
+ }
+ if !breaks
+ && IS_SPACE!(string)
+ && !IS_SPACE_AT!(string, 1)
+ && (*emitter).column > (*emitter).best_width
+ {
+ if yaml_emitter_write_indent(emitter).fail {
+ return FAIL;
+ }
+ MOVE!(string);
+ } else if WRITE!(emitter, string).fail {
+ return FAIL;
+ }
+ (*emitter).indention = false;
+ breaks = false;
+ }
+ }
+ OK
+}
diff --git a/crates/unsafe-libyaml/src/lib.rs b/crates/unsafe-libyaml/src/lib.rs
new file mode 100644
index 0000000..dc842af
--- /dev/null
+++ b/crates/unsafe-libyaml/src/lib.rs
@@ -0,0 +1,324 @@
+//! [![github]](https://github.com/dtolnay/unsafe-libyaml) [![crates-io]](https://crates.io/crates/unsafe-libyaml) [![docs-rs]](https://docs.rs/unsafe-libyaml)
+//!
+//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
+//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
+//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
+
+#![no_std]
+#![doc(html_root_url = "https://docs.rs/unsafe-libyaml/0.2.10")]
+#![allow(non_camel_case_types, non_snake_case)]
+#![warn(clippy::pedantic)]
+#![allow(
+ clippy::bool_to_int_with_if,
+ clippy::cast_lossless,
+ clippy::cast_possible_truncation,
+ clippy::cast_possible_wrap,
+ clippy::cast_ptr_alignment,
+ clippy::cast_sign_loss,
+ clippy::collapsible_if,
+ clippy::doc_markdown,
+ clippy::fn_params_excessive_bools,
+ clippy::if_not_else,
+ clippy::items_after_statements,
+ clippy::let_underscore_untyped,
+ clippy::manual_range_contains,
+ clippy::manual_swap,
+ clippy::missing_panics_doc,
+ clippy::missing_safety_doc,
+ clippy::module_name_repetitions,
+ clippy::must_use_candidate,
+ clippy::nonminimal_bool,
+ clippy::ptr_as_ptr,
+ clippy::redundant_else,
+ clippy::similar_names,
+ clippy::single_match,
+ clippy::single_match_else,
+ clippy::too_many_arguments,
+ clippy::too_many_lines,
+ clippy::unnecessary_cast,
+ clippy::unreadable_literal,
+ clippy::while_immutable_condition, // https://github.com/rust-lang/rust-clippy/issues/3548
+)]
+
+extern crate alloc;
+
+use core::mem::size_of;
+
+mod libc {
+ pub use core::ffi::c_void;
+ pub use core::primitive::{
+ i32 as c_int, i64 as c_long, i8 as c_char, u32 as c_uint, u64 as c_ulong, u8 as c_uchar,
+ };
+}
+
+#[macro_use]
+mod externs {
+ use crate::libc;
+ use crate::ops::{die, ForceAdd as _, ForceInto as _};
+ use alloc::alloc::{self as rust, Layout};
+ use core::mem::{self, MaybeUninit};
+ use core::ptr;
+ use core::slice;
+
+ const HEADER: usize = {
+ let need_len = mem::size_of::<usize>();
+ // Round up to multiple of MALLOC_ALIGN.
+ (need_len + MALLOC_ALIGN - 1) & !(MALLOC_ALIGN - 1)
+ };
+
+ // `max_align_t` may be bigger than this, but libyaml does not use `long
+ // double` or u128.
+ const MALLOC_ALIGN: usize = {
+ let int_align = mem::align_of::<libc::c_ulong>();
+ let ptr_align = mem::align_of::<usize>();
+ if int_align >= ptr_align {
+ int_align
+ } else {
+ ptr_align
+ }
+ };
+
+ pub unsafe fn malloc(size: libc::c_ulong) -> *mut libc::c_void {
+ let size = HEADER.force_add(size.force_into());
+ let layout = Layout::from_size_align(size, MALLOC_ALIGN)
+ .ok()
+ .unwrap_or_else(die);
+ let memory = rust::alloc(layout);
+ if memory.is_null() {
+ rust::handle_alloc_error(layout);
+ }
+ memory.cast::<usize>().write(size);
+ memory.add(HEADER).cast()
+ }
+
+ pub unsafe fn realloc(ptr: *mut libc::c_void, new_size: libc::c_ulong) -> *mut libc::c_void {
+ let mut memory = ptr.cast::<u8>().sub(HEADER);
+ let size = memory.cast::<usize>().read();
+ let layout = Layout::from_size_align_unchecked(size, MALLOC_ALIGN);
+ let new_size = HEADER.force_add(new_size.force_into());
+ let new_layout = Layout::from_size_align(new_size, MALLOC_ALIGN)
+ .ok()
+ .unwrap_or_else(die);
+ memory = rust::realloc(memory, layout, new_size);
+ if memory.is_null() {
+ rust::handle_alloc_error(new_layout);
+ }
+ memory.cast::<usize>().write(new_size);
+ memory.add(HEADER).cast()
+ }
+
+ pub unsafe fn free(ptr: *mut libc::c_void) {
+ let memory = ptr.cast::<u8>().sub(HEADER);
+ let size = memory.cast::<usize>().read();
+ let layout = Layout::from_size_align_unchecked(size, MALLOC_ALIGN);
+ rust::dealloc(memory, layout);
+ }
+
+ pub unsafe fn memcmp(
+ lhs: *const libc::c_void,
+ rhs: *const libc::c_void,
+ count: libc::c_ulong,
+ ) -> libc::c_int {
+ let lhs = slice::from_raw_parts(lhs.cast::<u8>(), count as usize);
+ let rhs = slice::from_raw_parts(rhs.cast::<u8>(), count as usize);
+ lhs.cmp(rhs) as libc::c_int
+ }
+
+ pub unsafe fn memcpy(
+ dest: *mut libc::c_void,
+ src: *const libc::c_void,
+ count: libc::c_ulong,
+ ) -> *mut libc::c_void {
+ ptr::copy_nonoverlapping(
+ src.cast::<MaybeUninit<u8>>(),
+ dest.cast::<MaybeUninit<u8>>(),
+ count as usize,
+ );
+ dest
+ }
+
+ pub unsafe fn memmove(
+ dest: *mut libc::c_void,
+ src: *const libc::c_void,
+ count: libc::c_ulong,
+ ) -> *mut libc::c_void {
+ ptr::copy(
+ src.cast::<MaybeUninit<u8>>(),
+ dest.cast::<MaybeUninit<u8>>(),
+ count as usize,
+ );
+ dest
+ }
+
+ pub unsafe fn memset(
+ dest: *mut libc::c_void,
+ ch: libc::c_int,
+ count: libc::c_ulong,
+ ) -> *mut libc::c_void {
+ ptr::write_bytes(dest.cast::<u8>(), ch as u8, count as usize);
+ dest
+ }
+
+ pub unsafe fn strcmp(lhs: *const libc::c_char, rhs: *const libc::c_char) -> libc::c_int {
+ let lhs = slice::from_raw_parts(lhs.cast::<u8>(), strlen(lhs) as usize);
+ let rhs = slice::from_raw_parts(rhs.cast::<u8>(), strlen(rhs) as usize);
+ lhs.cmp(rhs) as libc::c_int
+ }
+
+ pub unsafe fn strdup(src: *const libc::c_char) -> *mut libc::c_char {
+ let len = strlen(src);
+ let dest = malloc(len + 1);
+ memcpy(dest, src.cast(), len + 1);
+ dest.cast()
+ }
+
+ pub unsafe fn strlen(str: *const libc::c_char) -> libc::c_ulong {
+ let mut end = str;
+ while *end != 0 {
+ end = end.add(1);
+ }
+ end.offset_from(str) as libc::c_ulong
+ }
+
+ pub unsafe fn strncmp(
+ lhs: *const libc::c_char,
+ rhs: *const libc::c_char,
+ mut count: libc::c_ulong,
+ ) -> libc::c_int {
+ let mut lhs = lhs.cast::<u8>();
+ let mut rhs = rhs.cast::<u8>();
+ while count > 0 && *lhs != 0 && *lhs == *rhs {
+ lhs = lhs.add(1);
+ rhs = rhs.add(1);
+ count -= 1;
+ }
+ if count == 0 {
+ 0
+ } else {
+ (*lhs).cmp(&*rhs) as libc::c_int
+ }
+ }
+
+ macro_rules! __assert {
+ (false $(,)?) => {
+ $crate::externs::__assert_fail(stringify!(false), file!(), line!())
+ };
+ ($assertion:expr $(,)?) => {
+ if !$assertion {
+ $crate::externs::__assert_fail(stringify!($assertion), file!(), line!());
+ }
+ };
+ }
+
+ pub(crate) unsafe fn __assert_fail(
+ __assertion: &'static str,
+ __file: &'static str,
+ __line: u32,
+ ) -> ! {
+ struct Abort;
+ impl Drop for Abort {
+ fn drop(&mut self) {
+ panic!();
+ }
+ }
+ let _abort_on_panic = Abort;
+ panic!("{}:{}: Assertion `{}` failed.", __file, __line, __assertion);
+ }
+}
+
+mod fmt {
+ use crate::yaml::yaml_char_t;
+ use core::fmt::{self, Write};
+ use core::ptr;
+
+ pub struct WriteToPtr {
+ ptr: *mut yaml_char_t,
+ }
+
+ impl WriteToPtr {
+ pub unsafe fn new(ptr: *mut yaml_char_t) -> Self {
+ WriteToPtr { ptr }
+ }
+
+ pub fn write_fmt(&mut self, args: fmt::Arguments) {
+ let _ = Write::write_fmt(self, args);
+ }
+ }
+
+ impl Write for WriteToPtr {
+ fn write_str(&mut self, s: &str) -> fmt::Result {
+ unsafe {
+ ptr::copy_nonoverlapping(s.as_ptr(), self.ptr, s.len());
+ self.ptr = self.ptr.add(s.len());
+ }
+ Ok(())
+ }
+ }
+}
+
+trait PointerExt: Sized {
+ fn c_offset_from(self, origin: Self) -> isize;
+}
+
+impl<T> PointerExt for *const T {
+ fn c_offset_from(self, origin: *const T) -> isize {
+ (self as isize - origin as isize) / size_of::<T>() as isize
+ }
+}
+
+impl<T> PointerExt for *mut T {
+ fn c_offset_from(self, origin: *mut T) -> isize {
+ (self as isize - origin as isize) / size_of::<T>() as isize
+ }
+}
+
+#[macro_use]
+mod macros;
+
+mod api;
+mod dumper;
+mod emitter;
+mod loader;
+mod ops;
+mod parser;
+mod reader;
+mod scanner;
+mod success;
+mod writer;
+mod yaml;
+
+pub use crate::api::{
+ yaml_alias_event_initialize, yaml_document_add_mapping, yaml_document_add_scalar,
+ yaml_document_add_sequence, yaml_document_append_mapping_pair,
+ yaml_document_append_sequence_item, yaml_document_delete, yaml_document_end_event_initialize,
+ yaml_document_get_node, yaml_document_get_root_node, yaml_document_initialize,
+ yaml_document_start_event_initialize, yaml_emitter_delete, yaml_emitter_initialize,
+ yaml_emitter_set_break, yaml_emitter_set_canonical, yaml_emitter_set_encoding,
+ yaml_emitter_set_indent, yaml_emitter_set_output, yaml_emitter_set_output_string,
+ yaml_emitter_set_unicode, yaml_emitter_set_width, yaml_event_delete,
+ yaml_mapping_end_event_initialize, yaml_mapping_start_event_initialize, yaml_parser_delete,
+ yaml_parser_initialize, yaml_parser_set_encoding, yaml_parser_set_input,
+ yaml_parser_set_input_string, yaml_scalar_event_initialize, yaml_sequence_end_event_initialize,
+ yaml_sequence_start_event_initialize, yaml_stream_end_event_initialize,
+ yaml_stream_start_event_initialize, yaml_token_delete,
+};
+pub use crate::dumper::{yaml_emitter_close, yaml_emitter_dump, yaml_emitter_open};
+pub use crate::emitter::yaml_emitter_emit;
+pub use crate::loader::yaml_parser_load;
+pub use crate::parser::yaml_parser_parse;
+pub use crate::scanner::yaml_parser_scan;
+pub use crate::writer::yaml_emitter_flush;
+pub use crate::yaml::{
+ yaml_alias_data_t, yaml_break_t, yaml_document_t, yaml_emitter_state_t, yaml_emitter_t,
+ yaml_encoding_t, yaml_error_type_t, yaml_event_t, yaml_event_type_t, yaml_mapping_style_t,
+ yaml_mark_t, yaml_node_item_t, yaml_node_pair_t, yaml_node_t, yaml_node_type_t,
+ yaml_parser_state_t, yaml_parser_t, yaml_read_handler_t, yaml_scalar_style_t,
+ yaml_sequence_style_t, yaml_simple_key_t, yaml_stack_t, yaml_tag_directive_t, yaml_token_t,
+ yaml_token_type_t, yaml_version_directive_t, yaml_write_handler_t,
+};
+#[doc(hidden)]
+pub use crate::yaml::{
+ yaml_break_t::*, yaml_emitter_state_t::*, yaml_encoding_t::*, yaml_error_type_t::*,
+ yaml_event_type_t::*, yaml_mapping_style_t::*, yaml_node_type_t::*, yaml_parser_state_t::*,
+ yaml_scalar_style_t::*, yaml_sequence_style_t::*, yaml_token_type_t::*,
+};
diff --git a/crates/unsafe-libyaml/src/loader.rs b/crates/unsafe-libyaml/src/loader.rs
new file mode 100644
index 0000000..6d562c0
--- /dev/null
+++ b/crates/unsafe-libyaml/src/loader.rs
@@ -0,0 +1,579 @@
+use crate::api::{yaml_free, yaml_malloc, yaml_stack_extend, yaml_strdup};
+use crate::externs::{memset, strcmp};
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::yaml_char_t;
+use crate::{
+ libc, yaml_alias_data_t, yaml_document_delete, yaml_document_t, yaml_event_t, yaml_mark_t,
+ yaml_node_item_t, yaml_node_pair_t, yaml_node_t, yaml_parser_parse, yaml_parser_t, PointerExt,
+ YAML_ALIAS_EVENT, YAML_COMPOSER_ERROR, YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_START_EVENT,
+ YAML_MAPPING_END_EVENT, YAML_MAPPING_NODE, YAML_MAPPING_START_EVENT, YAML_MEMORY_ERROR,
+ YAML_SCALAR_EVENT, YAML_SCALAR_NODE, YAML_SEQUENCE_END_EVENT, YAML_SEQUENCE_NODE,
+ YAML_SEQUENCE_START_EVENT, YAML_STREAM_END_EVENT, YAML_STREAM_START_EVENT,
+};
+use core::mem::{size_of, MaybeUninit};
+use core::ptr::{self, addr_of_mut};
+
+#[repr(C)]
+struct loader_ctx {
+ start: *mut libc::c_int,
+ end: *mut libc::c_int,
+ top: *mut libc::c_int,
+}
+
+/// Parse the input stream and produce the next YAML document.
+///
+/// Call this function subsequently to produce a sequence of documents
+/// constituting the input stream.
+///
+/// If the produced document has no root node, it means that the document end
+/// has been reached.
+///
+/// An application is responsible for freeing any data associated with the
+/// produced document object using the yaml_document_delete() function.
+///
+/// An application must not alternate the calls of yaml_parser_load() with the
+/// calls of yaml_parser_scan() or yaml_parser_parse(). Doing this will break
+/// the parser.
+pub unsafe fn yaml_parser_load(
+ parser: *mut yaml_parser_t,
+ document: *mut yaml_document_t,
+) -> Success {
+ let current_block: u64;
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ __assert!(!parser.is_null());
+ __assert!(!document.is_null());
+ memset(
+ document as *mut libc::c_void,
+ 0,
+ size_of::<yaml_document_t>() as libc::c_ulong,
+ );
+ STACK_INIT!((*document).nodes, yaml_node_t);
+ if !(*parser).stream_start_produced {
+ if yaml_parser_parse(parser, event).fail {
+ current_block = 6234624449317607669;
+ } else {
+ __assert!((*event).type_ == YAML_STREAM_START_EVENT);
+ current_block = 7815301370352969686;
+ }
+ } else {
+ current_block = 7815301370352969686;
+ }
+ if current_block != 6234624449317607669 {
+ if (*parser).stream_end_produced {
+ return OK;
+ }
+ if yaml_parser_parse(parser, event).ok {
+ if (*event).type_ == YAML_STREAM_END_EVENT {
+ return OK;
+ }
+ STACK_INIT!((*parser).aliases, yaml_alias_data_t);
+ let fresh6 = addr_of_mut!((*parser).document);
+ *fresh6 = document;
+ if yaml_parser_load_document(parser, event).ok {
+ yaml_parser_delete_aliases(parser);
+ let fresh7 = addr_of_mut!((*parser).document);
+ *fresh7 = ptr::null_mut::<yaml_document_t>();
+ return OK;
+ }
+ }
+ }
+ yaml_parser_delete_aliases(parser);
+ yaml_document_delete(document);
+ let fresh8 = addr_of_mut!((*parser).document);
+ *fresh8 = ptr::null_mut::<yaml_document_t>();
+ FAIL
+}
+
+unsafe fn yaml_parser_set_composer_error(
+ parser: *mut yaml_parser_t,
+ problem: *const libc::c_char,
+ problem_mark: yaml_mark_t,
+) -> Success {
+ (*parser).error = YAML_COMPOSER_ERROR;
+ let fresh9 = addr_of_mut!((*parser).problem);
+ *fresh9 = problem;
+ (*parser).problem_mark = problem_mark;
+ FAIL
+}
+
+unsafe fn yaml_parser_set_composer_error_context(
+ parser: *mut yaml_parser_t,
+ context: *const libc::c_char,
+ context_mark: yaml_mark_t,
+ problem: *const libc::c_char,
+ problem_mark: yaml_mark_t,
+) -> Success {
+ (*parser).error = YAML_COMPOSER_ERROR;
+ let fresh10 = addr_of_mut!((*parser).context);
+ *fresh10 = context;
+ (*parser).context_mark = context_mark;
+ let fresh11 = addr_of_mut!((*parser).problem);
+ *fresh11 = problem;
+ (*parser).problem_mark = problem_mark;
+ FAIL
+}
+
+unsafe fn yaml_parser_delete_aliases(parser: *mut yaml_parser_t) {
+ while !STACK_EMPTY!((*parser).aliases) {
+ yaml_free(POP!((*parser).aliases).anchor as *mut libc::c_void);
+ }
+ STACK_DEL!((*parser).aliases);
+}
+
+unsafe fn yaml_parser_load_document(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut ctx = loader_ctx {
+ start: ptr::null_mut::<libc::c_int>(),
+ end: ptr::null_mut::<libc::c_int>(),
+ top: ptr::null_mut::<libc::c_int>(),
+ };
+ __assert!((*event).type_ == YAML_DOCUMENT_START_EVENT);
+ let fresh16 = addr_of_mut!((*(*parser).document).version_directive);
+ *fresh16 = (*event).data.document_start.version_directive;
+ let fresh17 = addr_of_mut!((*(*parser).document).tag_directives.start);
+ *fresh17 = (*event).data.document_start.tag_directives.start;
+ let fresh18 = addr_of_mut!((*(*parser).document).tag_directives.end);
+ *fresh18 = (*event).data.document_start.tag_directives.end;
+ (*(*parser).document).start_implicit = (*event).data.document_start.implicit;
+ (*(*parser).document).start_mark = (*event).start_mark;
+ STACK_INIT!(ctx, libc::c_int);
+ if yaml_parser_load_nodes(parser, addr_of_mut!(ctx)).fail {
+ STACK_DEL!(ctx);
+ return FAIL;
+ }
+ STACK_DEL!(ctx);
+ OK
+}
+
+unsafe fn yaml_parser_load_nodes(parser: *mut yaml_parser_t, ctx: *mut loader_ctx) -> Success {
+ let mut event = MaybeUninit::<yaml_event_t>::uninit();
+ let event = event.as_mut_ptr();
+ loop {
+ if yaml_parser_parse(parser, event).fail {
+ return FAIL;
+ }
+ match (*event).type_ {
+ YAML_ALIAS_EVENT => {
+ if yaml_parser_load_alias(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_SCALAR_EVENT => {
+ if yaml_parser_load_scalar(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_SEQUENCE_START_EVENT => {
+ if yaml_parser_load_sequence(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_SEQUENCE_END_EVENT => {
+ if yaml_parser_load_sequence_end(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_MAPPING_START_EVENT => {
+ if yaml_parser_load_mapping(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_MAPPING_END_EVENT => {
+ if yaml_parser_load_mapping_end(parser, event, ctx).fail {
+ return FAIL;
+ }
+ }
+ YAML_DOCUMENT_END_EVENT => {}
+ _ => {
+ __assert!(false);
+ }
+ }
+ if (*event).type_ == YAML_DOCUMENT_END_EVENT {
+ break;
+ }
+ }
+ (*(*parser).document).end_implicit = (*event).data.document_end.implicit;
+ (*(*parser).document).end_mark = (*event).end_mark;
+ OK
+}
+
+unsafe fn yaml_parser_register_anchor(
+ parser: *mut yaml_parser_t,
+ index: libc::c_int,
+ anchor: *mut yaml_char_t,
+) -> Success {
+ let mut data = MaybeUninit::<yaml_alias_data_t>::uninit();
+ let data = data.as_mut_ptr();
+ let mut alias_data: *mut yaml_alias_data_t;
+ if anchor.is_null() {
+ return OK;
+ }
+ (*data).anchor = anchor;
+ (*data).index = index;
+ (*data).mark = (*(*(*parser).document)
+ .nodes
+ .start
+ .wrapping_offset((index - 1) as isize))
+ .start_mark;
+ alias_data = (*parser).aliases.start;
+ while alias_data != (*parser).aliases.top {
+ if strcmp(
+ (*alias_data).anchor as *mut libc::c_char,
+ anchor as *mut libc::c_char,
+ ) == 0
+ {
+ yaml_free(anchor as *mut libc::c_void);
+ return yaml_parser_set_composer_error_context(
+ parser,
+ b"found duplicate anchor; first occurrence\0" as *const u8 as *const libc::c_char,
+ (*alias_data).mark,
+ b"second occurrence\0" as *const u8 as *const libc::c_char,
+ (*data).mark,
+ );
+ }
+ alias_data = alias_data.wrapping_offset(1);
+ }
+ PUSH!((*parser).aliases, *data);
+ OK
+}
+
+unsafe fn yaml_parser_load_node_add(
+ parser: *mut yaml_parser_t,
+ ctx: *mut loader_ctx,
+ index: libc::c_int,
+) -> Success {
+ if STACK_EMPTY!(*ctx) {
+ return OK;
+ }
+ let parent_index: libc::c_int = *(*ctx).top.wrapping_offset(-1_isize);
+ let parent: *mut yaml_node_t = addr_of_mut!(
+ *((*(*parser).document).nodes.start).wrapping_offset((parent_index - 1) as isize)
+ );
+ let current_block_17: u64;
+ match (*parent).type_ {
+ YAML_SEQUENCE_NODE => {
+ if STACK_LIMIT!(parser, (*parent).data.sequence.items).fail {
+ return FAIL;
+ }
+ PUSH!((*parent).data.sequence.items, index);
+ }
+ YAML_MAPPING_NODE => {
+ let mut pair = MaybeUninit::<yaml_node_pair_t>::uninit();
+ let pair = pair.as_mut_ptr();
+ if !STACK_EMPTY!((*parent).data.mapping.pairs) {
+ let p: *mut yaml_node_pair_t =
+ (*parent).data.mapping.pairs.top.wrapping_offset(-1_isize);
+ if (*p).key != 0 && (*p).value == 0 {
+ (*p).value = index;
+ current_block_17 = 11307063007268554308;
+ } else {
+ current_block_17 = 17407779659766490442;
+ }
+ } else {
+ current_block_17 = 17407779659766490442;
+ }
+ match current_block_17 {
+ 11307063007268554308 => {}
+ _ => {
+ (*pair).key = index;
+ (*pair).value = 0;
+ if STACK_LIMIT!(parser, (*parent).data.mapping.pairs).fail {
+ return FAIL;
+ }
+ PUSH!((*parent).data.mapping.pairs, *pair);
+ }
+ }
+ }
+ _ => {
+ __assert!(false);
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_parser_load_alias(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ let anchor: *mut yaml_char_t = (*event).data.alias.anchor;
+ let mut alias_data: *mut yaml_alias_data_t;
+ alias_data = (*parser).aliases.start;
+ while alias_data != (*parser).aliases.top {
+ if strcmp(
+ (*alias_data).anchor as *mut libc::c_char,
+ anchor as *mut libc::c_char,
+ ) == 0
+ {
+ yaml_free(anchor as *mut libc::c_void);
+ return yaml_parser_load_node_add(parser, ctx, (*alias_data).index);
+ }
+ alias_data = alias_data.wrapping_offset(1);
+ }
+ yaml_free(anchor as *mut libc::c_void);
+ yaml_parser_set_composer_error(
+ parser,
+ b"found undefined alias\0" as *const u8 as *const libc::c_char,
+ (*event).start_mark,
+ )
+}
+
+unsafe fn yaml_parser_load_scalar(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ let current_block: u64;
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ let index: libc::c_int;
+ let mut tag: *mut yaml_char_t = (*event).data.scalar.tag;
+ if STACK_LIMIT!(parser, (*(*parser).document).nodes).ok {
+ if tag.is_null()
+ || strcmp(
+ tag as *mut libc::c_char,
+ b"!\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ yaml_free(tag as *mut libc::c_void);
+ tag = yaml_strdup(
+ b"tag:yaml.org,2002:str\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ );
+ if tag.is_null() {
+ current_block = 10579931339944277179;
+ } else {
+ current_block = 11006700562992250127;
+ }
+ } else {
+ current_block = 11006700562992250127;
+ }
+ if current_block != 10579931339944277179 {
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_SCALAR_NODE;
+ (*node).tag = tag;
+ (*node).start_mark = (*event).start_mark;
+ (*node).end_mark = (*event).end_mark;
+ (*node).data.scalar.value = (*event).data.scalar.value;
+ (*node).data.scalar.length = (*event).data.scalar.length;
+ (*node).data.scalar.style = (*event).data.scalar.style;
+ PUSH!((*(*parser).document).nodes, *node);
+ index = (*(*parser).document)
+ .nodes
+ .top
+ .c_offset_from((*(*parser).document).nodes.start)
+ as libc::c_int;
+ if yaml_parser_register_anchor(parser, index, (*event).data.scalar.anchor).fail {
+ return FAIL;
+ }
+ return yaml_parser_load_node_add(parser, ctx, index);
+ }
+ }
+ yaml_free(tag as *mut libc::c_void);
+ yaml_free((*event).data.scalar.anchor as *mut libc::c_void);
+ yaml_free((*event).data.scalar.value as *mut libc::c_void);
+ FAIL
+}
+
+unsafe fn yaml_parser_load_sequence(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ let current_block: u64;
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ struct Items {
+ start: *mut yaml_node_item_t,
+ end: *mut yaml_node_item_t,
+ top: *mut yaml_node_item_t,
+ }
+ let mut items = Items {
+ start: ptr::null_mut::<yaml_node_item_t>(),
+ end: ptr::null_mut::<yaml_node_item_t>(),
+ top: ptr::null_mut::<yaml_node_item_t>(),
+ };
+ let index: libc::c_int;
+ let mut tag: *mut yaml_char_t = (*event).data.sequence_start.tag;
+ if STACK_LIMIT!(parser, (*(*parser).document).nodes).ok {
+ if tag.is_null()
+ || strcmp(
+ tag as *mut libc::c_char,
+ b"!\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ yaml_free(tag as *mut libc::c_void);
+ tag = yaml_strdup(
+ b"tag:yaml.org,2002:seq\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ );
+ if tag.is_null() {
+ current_block = 13474536459355229096;
+ } else {
+ current_block = 6937071982253665452;
+ }
+ } else {
+ current_block = 6937071982253665452;
+ }
+ if current_block != 13474536459355229096 {
+ STACK_INIT!(items, yaml_node_item_t);
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_SEQUENCE_NODE;
+ (*node).tag = tag;
+ (*node).start_mark = (*event).start_mark;
+ (*node).end_mark = (*event).end_mark;
+ (*node).data.sequence.items.start = items.start;
+ (*node).data.sequence.items.end = items.end;
+ (*node).data.sequence.items.top = items.start;
+ (*node).data.sequence.style = (*event).data.sequence_start.style;
+ PUSH!((*(*parser).document).nodes, *node);
+ index = (*(*parser).document)
+ .nodes
+ .top
+ .c_offset_from((*(*parser).document).nodes.start)
+ as libc::c_int;
+ if yaml_parser_register_anchor(parser, index, (*event).data.sequence_start.anchor).fail
+ {
+ return FAIL;
+ }
+ if yaml_parser_load_node_add(parser, ctx, index).fail {
+ return FAIL;
+ }
+ if STACK_LIMIT!(parser, *ctx).fail {
+ return FAIL;
+ }
+ PUSH!(*ctx, index);
+ return OK;
+ }
+ }
+ yaml_free(tag as *mut libc::c_void);
+ yaml_free((*event).data.sequence_start.anchor as *mut libc::c_void);
+ FAIL
+}
+
+unsafe fn yaml_parser_load_sequence_end(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ __assert!(((*ctx).top).c_offset_from((*ctx).start) as libc::c_long > 0_i64);
+ let index: libc::c_int = *(*ctx).top.wrapping_offset(-1_isize);
+ __assert!(
+ (*((*(*parser).document).nodes.start).wrapping_offset((index - 1) as isize)).type_
+ == YAML_SEQUENCE_NODE
+ );
+ (*(*(*parser).document)
+ .nodes
+ .start
+ .wrapping_offset((index - 1) as isize))
+ .end_mark = (*event).end_mark;
+ let _ = POP!(*ctx);
+ OK
+}
+
+unsafe fn yaml_parser_load_mapping(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ let current_block: u64;
+ let mut node = MaybeUninit::<yaml_node_t>::uninit();
+ let node = node.as_mut_ptr();
+ struct Pairs {
+ start: *mut yaml_node_pair_t,
+ end: *mut yaml_node_pair_t,
+ top: *mut yaml_node_pair_t,
+ }
+ let mut pairs = Pairs {
+ start: ptr::null_mut::<yaml_node_pair_t>(),
+ end: ptr::null_mut::<yaml_node_pair_t>(),
+ top: ptr::null_mut::<yaml_node_pair_t>(),
+ };
+ let index: libc::c_int;
+ let mut tag: *mut yaml_char_t = (*event).data.mapping_start.tag;
+ if STACK_LIMIT!(parser, (*(*parser).document).nodes).ok {
+ if tag.is_null()
+ || strcmp(
+ tag as *mut libc::c_char,
+ b"!\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ yaml_free(tag as *mut libc::c_void);
+ tag = yaml_strdup(
+ b"tag:yaml.org,2002:map\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ );
+ if tag.is_null() {
+ current_block = 13635467803606088781;
+ } else {
+ current_block = 6937071982253665452;
+ }
+ } else {
+ current_block = 6937071982253665452;
+ }
+ if current_block != 13635467803606088781 {
+ STACK_INIT!(pairs, yaml_node_pair_t);
+ memset(
+ node as *mut libc::c_void,
+ 0,
+ size_of::<yaml_node_t>() as libc::c_ulong,
+ );
+ (*node).type_ = YAML_MAPPING_NODE;
+ (*node).tag = tag;
+ (*node).start_mark = (*event).start_mark;
+ (*node).end_mark = (*event).end_mark;
+ (*node).data.mapping.pairs.start = pairs.start;
+ (*node).data.mapping.pairs.end = pairs.end;
+ (*node).data.mapping.pairs.top = pairs.start;
+ (*node).data.mapping.style = (*event).data.mapping_start.style;
+ PUSH!((*(*parser).document).nodes, *node);
+ index = (*(*parser).document)
+ .nodes
+ .top
+ .c_offset_from((*(*parser).document).nodes.start)
+ as libc::c_int;
+ if yaml_parser_register_anchor(parser, index, (*event).data.mapping_start.anchor).fail {
+ return FAIL;
+ }
+ if yaml_parser_load_node_add(parser, ctx, index).fail {
+ return FAIL;
+ }
+ if STACK_LIMIT!(parser, *ctx).fail {
+ return FAIL;
+ }
+ PUSH!(*ctx, index);
+ return OK;
+ }
+ }
+ yaml_free(tag as *mut libc::c_void);
+ yaml_free((*event).data.mapping_start.anchor as *mut libc::c_void);
+ FAIL
+}
+
+unsafe fn yaml_parser_load_mapping_end(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ ctx: *mut loader_ctx,
+) -> Success {
+ __assert!(((*ctx).top).c_offset_from((*ctx).start) as libc::c_long > 0_i64);
+ let index: libc::c_int = *(*ctx).top.wrapping_offset(-1_isize);
+ __assert!(
+ (*((*(*parser).document).nodes.start).wrapping_offset((index - 1) as isize)).type_
+ == YAML_MAPPING_NODE
+ );
+ (*(*(*parser).document)
+ .nodes
+ .start
+ .wrapping_offset((index - 1) as isize))
+ .end_mark = (*event).end_mark;
+ let _ = POP!(*ctx);
+ OK
+}
diff --git a/crates/unsafe-libyaml/src/macros.rs b/crates/unsafe-libyaml/src/macros.rs
new file mode 100644
index 0000000..9668929
--- /dev/null
+++ b/crates/unsafe-libyaml/src/macros.rs
@@ -0,0 +1,514 @@
+macro_rules! BUFFER_INIT {
+ ($buffer:expr, $size:expr) => {{
+ let start = addr_of_mut!($buffer.start);
+ *start = yaml_malloc($size as size_t) as *mut yaml_char_t;
+ let pointer = addr_of_mut!($buffer.pointer);
+ *pointer = $buffer.start;
+ let last = addr_of_mut!($buffer.last);
+ *last = *pointer;
+ let end = addr_of_mut!($buffer.end);
+ *end = $buffer.start.wrapping_add($size as usize);
+ }};
+}
+
+macro_rules! BUFFER_DEL {
+ ($buffer:expr) => {{
+ yaml_free($buffer.start as *mut libc::c_void);
+ let end = addr_of_mut!($buffer.end);
+ *end = ptr::null_mut::<yaml_char_t>();
+ let pointer = addr_of_mut!($buffer.pointer);
+ *pointer = *end;
+ let start = addr_of_mut!($buffer.start);
+ *start = *pointer;
+ }};
+}
+
+macro_rules! STRING_ASSIGN {
+ ($string:expr, $length:expr) => {
+ yaml_string_t {
+ start: $string,
+ end: $string.wrapping_offset($length as isize),
+ pointer: $string,
+ }
+ };
+}
+
+macro_rules! STRING_INIT {
+ ($string:expr) => {{
+ $string.start = yaml_malloc(16) as *mut yaml_char_t;
+ $string.pointer = $string.start;
+ $string.end = $string.start.wrapping_add(16);
+ memset($string.start as *mut libc::c_void, 0, 16);
+ }};
+}
+
+macro_rules! STRING_DEL {
+ ($string:expr) => {{
+ yaml_free($string.start as *mut libc::c_void);
+ $string.end = ptr::null_mut::<yaml_char_t>();
+ $string.pointer = $string.end;
+ $string.start = $string.pointer;
+ }};
+}
+
+macro_rules! STRING_EXTEND {
+ ($string:expr) => {
+ if $string.pointer.wrapping_add(5) >= $string.end {
+ yaml_string_extend(
+ addr_of_mut!($string.start),
+ addr_of_mut!($string.pointer),
+ addr_of_mut!($string.end),
+ );
+ }
+ };
+}
+
+macro_rules! CLEAR {
+ ($string:expr) => {{
+ $string.pointer = $string.start;
+ memset(
+ $string.start as *mut libc::c_void,
+ 0,
+ $string.end.c_offset_from($string.start) as libc::c_ulong,
+ );
+ }};
+}
+
+macro_rules! JOIN {
+ ($string_a:expr, $string_b:expr) => {{
+ yaml_string_join(
+ addr_of_mut!($string_a.start),
+ addr_of_mut!($string_a.pointer),
+ addr_of_mut!($string_a.end),
+ addr_of_mut!($string_b.start),
+ addr_of_mut!($string_b.pointer),
+ addr_of_mut!($string_b.end),
+ );
+ $string_b.pointer = $string_b.start;
+ }};
+}
+
+macro_rules! CHECK_AT {
+ ($string:expr, $octet:expr, $offset:expr) => {
+ *$string.pointer.offset($offset as isize) == $octet
+ };
+}
+
+macro_rules! CHECK {
+ ($string:expr, $octet:expr) => {
+ *$string.pointer == $octet
+ };
+}
+
+macro_rules! IS_ALPHA {
+ ($string:expr) => {
+ *$string.pointer >= b'0' && *$string.pointer <= b'9'
+ || *$string.pointer >= b'A' && *$string.pointer <= b'Z'
+ || *$string.pointer >= b'a' && *$string.pointer <= b'z'
+ || *$string.pointer == b'_'
+ || *$string.pointer == b'-'
+ };
+}
+
+macro_rules! IS_DIGIT {
+ ($string:expr) => {
+ *$string.pointer >= b'0' && *$string.pointer <= b'9'
+ };
+}
+
+macro_rules! AS_DIGIT {
+ ($string:expr) => {
+ (*$string.pointer - b'0') as libc::c_int
+ };
+}
+
+macro_rules! IS_HEX_AT {
+ ($string:expr, $offset:expr) => {
+ *$string.pointer.wrapping_offset($offset) >= b'0'
+ && *$string.pointer.wrapping_offset($offset) <= b'9'
+ || *$string.pointer.wrapping_offset($offset) >= b'A'
+ && *$string.pointer.wrapping_offset($offset) <= b'F'
+ || *$string.pointer.wrapping_offset($offset) >= b'a'
+ && *$string.pointer.wrapping_offset($offset) <= b'f'
+ };
+}
+
+macro_rules! AS_HEX_AT {
+ ($string:expr, $offset:expr) => {
+ if *$string.pointer.wrapping_offset($offset) >= b'A'
+ && *$string.pointer.wrapping_offset($offset) <= b'F'
+ {
+ *$string.pointer.wrapping_offset($offset) - b'A' + 10
+ } else if *$string.pointer.wrapping_offset($offset) >= b'a'
+ && *$string.pointer.wrapping_offset($offset) <= b'f'
+ {
+ *$string.pointer.wrapping_offset($offset) - b'a' + 10
+ } else {
+ *$string.pointer.wrapping_offset($offset) - b'0'
+ } as libc::c_int
+ };
+}
+
+macro_rules! IS_ASCII {
+ ($string:expr) => {
+ *$string.pointer <= b'\x7F'
+ };
+}
+
+macro_rules! IS_PRINTABLE {
+ ($string:expr) => {
+ match *$string.pointer {
+ // ASCII
+ 0x0A | 0x20..=0x7E => true,
+ // U+A0 ... U+BF
+ 0xC2 => match *$string.pointer.wrapping_offset(1) {
+ 0xA0..=0xBF => true,
+ _ => false,
+ },
+ // U+C0 ... U+CFFF
+ 0xC3..=0xEC => true,
+ // U+D000 ... U+D7FF
+ 0xED => match *$string.pointer.wrapping_offset(1) {
+ 0x00..=0x9F => true,
+ _ => false,
+ },
+ // U+E000 ... U+EFFF
+ 0xEE => true,
+ // U+F000 ... U+FFFD
+ 0xEF => match *$string.pointer.wrapping_offset(1) {
+ 0xBB => match *$string.pointer.wrapping_offset(2) {
+ // except U+FEFF
+ 0xBF => false,
+ _ => true,
+ },
+ 0xBF => match *$string.pointer.wrapping_offset(2) {
+ 0xBE | 0xBF => false,
+ _ => true,
+ },
+ _ => true,
+ },
+ // U+10000 ... U+10FFFF
+ 0xF0..=0xF4 => true,
+ _ => false,
+ }
+ };
+}
+
+macro_rules! IS_Z_AT {
+ ($string:expr, $offset:expr) => {
+ CHECK_AT!($string, b'\0', $offset)
+ };
+}
+
+macro_rules! IS_Z {
+ ($string:expr) => {
+ IS_Z_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_BOM {
+ ($string:expr) => {
+ CHECK_AT!($string, b'\xEF', 0)
+ && CHECK_AT!($string, b'\xBB', 1)
+ && CHECK_AT!($string, b'\xBF', 2)
+ };
+}
+
+macro_rules! IS_SPACE_AT {
+ ($string:expr, $offset:expr) => {
+ CHECK_AT!($string, b' ', $offset)
+ };
+}
+
+macro_rules! IS_SPACE {
+ ($string:expr) => {
+ IS_SPACE_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_TAB_AT {
+ ($string:expr, $offset:expr) => {
+ CHECK_AT!($string, b'\t', $offset)
+ };
+}
+
+macro_rules! IS_TAB {
+ ($string:expr) => {
+ IS_TAB_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_BLANK_AT {
+ ($string:expr, $offset:expr) => {
+ IS_SPACE_AT!($string, $offset) || IS_TAB_AT!($string, $offset)
+ };
+}
+
+macro_rules! IS_BLANK {
+ ($string:expr) => {
+ IS_BLANK_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_BREAK_AT {
+ ($string:expr, $offset:expr) => {
+ CHECK_AT!($string, b'\r', $offset)
+ || CHECK_AT!($string, b'\n', $offset)
+ || CHECK_AT!($string, b'\xC2', $offset) && CHECK_AT!($string, b'\x85', $offset + 1)
+ || CHECK_AT!($string, b'\xE2', $offset)
+ && CHECK_AT!($string, b'\x80', $offset + 1)
+ && CHECK_AT!($string, b'\xA8', $offset + 2)
+ || CHECK_AT!($string, b'\xE2', $offset)
+ && CHECK_AT!($string, b'\x80', $offset + 1)
+ && CHECK_AT!($string, b'\xA9', $offset + 2)
+ };
+}
+
+macro_rules! IS_BREAK {
+ ($string:expr) => {
+ IS_BREAK_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_CRLF {
+ ($string:expr) => {
+ CHECK_AT!($string, b'\r', 0) && CHECK_AT!($string, b'\n', 1)
+ };
+}
+
+macro_rules! IS_BREAKZ_AT {
+ ($string:expr, $offset:expr) => {
+ IS_BREAK_AT!($string, $offset) || IS_Z_AT!($string, $offset)
+ };
+}
+
+macro_rules! IS_BREAKZ {
+ ($string:expr) => {
+ IS_BREAKZ_AT!($string, 0)
+ };
+}
+
+macro_rules! IS_BLANKZ_AT {
+ ($string:expr, $offset:expr) => {
+ IS_BLANK_AT!($string, $offset) || IS_BREAKZ_AT!($string, $offset)
+ };
+}
+
+macro_rules! IS_BLANKZ {
+ ($string:expr) => {
+ IS_BLANKZ_AT!($string, 0)
+ };
+}
+
+macro_rules! WIDTH_AT {
+ ($string:expr, $offset:expr) => {
+ if *$string.pointer.wrapping_offset($offset as isize) & 0x80 == 0x00 {
+ 1
+ } else if *$string.pointer.wrapping_offset($offset as isize) & 0xE0 == 0xC0 {
+ 2
+ } else if *$string.pointer.wrapping_offset($offset as isize) & 0xF0 == 0xE0 {
+ 3
+ } else if *$string.pointer.wrapping_offset($offset as isize) & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ }
+ };
+}
+
+macro_rules! WIDTH {
+ ($string:expr) => {
+ WIDTH_AT!($string, 0)
+ };
+}
+
+macro_rules! MOVE {
+ ($string:expr) => {
+ $string.pointer = $string.pointer.wrapping_offset(WIDTH!($string) as isize)
+ };
+}
+
+macro_rules! COPY {
+ ($string_a:expr, $string_b:expr) => {
+ if *$string_b.pointer & 0x80 == 0x00 {
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ } else if *$string_b.pointer & 0xE0 == 0xC0 {
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ } else if *$string_b.pointer & 0xF0 == 0xE0 {
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ } else if *$string_b.pointer & 0xF8 == 0xF0 {
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ *$string_a.pointer = *$string_b.pointer;
+ $string_a.pointer = $string_a.pointer.wrapping_offset(1);
+ $string_b.pointer = $string_b.pointer.wrapping_offset(1);
+ }
+ };
+}
+
+macro_rules! STACK_INIT {
+ ($stack:expr, $type:ty) => {{
+ $stack.start = yaml_malloc(16 * size_of::<$type>() as libc::c_ulong) as *mut $type;
+ $stack.top = $stack.start;
+ $stack.end = $stack.start.offset(16_isize);
+ }};
+}
+
+macro_rules! STACK_DEL {
+ ($stack:expr) => {
+ yaml_free($stack.start as *mut libc::c_void);
+ $stack.end = ptr::null_mut();
+ $stack.top = ptr::null_mut();
+ $stack.start = ptr::null_mut();
+ };
+}
+
+macro_rules! STACK_EMPTY {
+ ($stack:expr) => {
+ $stack.start == $stack.top
+ };
+}
+
+macro_rules! STACK_LIMIT {
+ ($context:expr, $stack:expr) => {
+ if $stack.top.c_offset_from($stack.start) < libc::c_int::MAX as isize - 1 {
+ OK
+ } else {
+ (*$context).error = YAML_MEMORY_ERROR;
+ FAIL
+ }
+ };
+}
+
+macro_rules! PUSH {
+ (do $stack:expr, $push:expr) => {{
+ if $stack.top == $stack.end {
+ yaml_stack_extend(
+ addr_of_mut!($stack.start) as *mut *mut libc::c_void,
+ addr_of_mut!($stack.top) as *mut *mut libc::c_void,
+ addr_of_mut!($stack.end) as *mut *mut libc::c_void,
+ );
+ }
+ $push;
+ $stack.top = $stack.top.wrapping_offset(1);
+ }};
+ ($stack:expr, *$value:expr) => {
+ PUSH!(do $stack, ptr::copy_nonoverlapping($value, $stack.top, 1))
+ };
+ ($stack:expr, $value:expr) => {
+ PUSH!(do $stack, ptr::write($stack.top, $value))
+ };
+}
+
+macro_rules! POP {
+ ($stack:expr) => {
+ *{
+ $stack.top = $stack.top.offset(-1);
+ $stack.top
+ }
+ };
+}
+
+macro_rules! QUEUE_INIT {
+ ($queue:expr, $type:ty) => {{
+ $queue.start = yaml_malloc(16 * size_of::<$type>() as libc::c_ulong) as *mut $type;
+ $queue.tail = $queue.start;
+ $queue.head = $queue.tail;
+ $queue.end = $queue.start.offset(16_isize);
+ }};
+}
+
+macro_rules! QUEUE_DEL {
+ ($queue:expr) => {
+ yaml_free($queue.start as *mut libc::c_void);
+ $queue.end = ptr::null_mut();
+ $queue.tail = ptr::null_mut();
+ $queue.head = ptr::null_mut();
+ $queue.start = ptr::null_mut();
+ };
+}
+
+macro_rules! QUEUE_EMPTY {
+ ($queue:expr) => {
+ $queue.head == $queue.tail
+ };
+}
+
+macro_rules! ENQUEUE {
+ (do $queue:expr, $enqueue:expr) => {{
+ if $queue.tail == $queue.end {
+ yaml_queue_extend(
+ addr_of_mut!($queue.start) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.head) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.tail) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.end) as *mut *mut libc::c_void,
+ );
+ }
+ $enqueue;
+ $queue.tail = $queue.tail.wrapping_offset(1);
+ }};
+ ($queue:expr, *$value:expr) => {
+ ENQUEUE!(do $queue, ptr::copy_nonoverlapping($value, $queue.tail, 1))
+ };
+ ($queue:expr, $value:expr) => {
+ ENQUEUE!(do $queue, ptr::write($queue.tail, $value))
+ };
+}
+
+macro_rules! DEQUEUE {
+ ($queue:expr) => {
+ *{
+ let head = $queue.head;
+ $queue.head = $queue.head.wrapping_offset(1);
+ head
+ }
+ };
+}
+
+macro_rules! QUEUE_INSERT {
+ ($queue:expr, $index:expr, $value:expr) => {{
+ if $queue.tail == $queue.end {
+ yaml_queue_extend(
+ addr_of_mut!($queue.start) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.head) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.tail) as *mut *mut libc::c_void,
+ addr_of_mut!($queue.end) as *mut *mut libc::c_void,
+ );
+ }
+ memmove(
+ $queue
+ .head
+ .wrapping_offset($index as isize)
+ .wrapping_offset(1_isize) as *mut libc::c_void,
+ $queue.head.wrapping_offset($index as isize) as *const libc::c_void,
+ ($queue.tail.c_offset_from($queue.head) as libc::c_ulong)
+ .wrapping_sub($index)
+ .wrapping_mul(size_of::<yaml_token_t>() as libc::c_ulong),
+ );
+ *$queue.head.wrapping_offset($index as isize) = $value;
+ let fresh14 = addr_of_mut!($queue.tail);
+ *fresh14 = (*fresh14).wrapping_offset(1);
+ }};
+}
diff --git a/crates/unsafe-libyaml/src/ops.rs b/crates/unsafe-libyaml/src/ops.rs
new file mode 100644
index 0000000..4597d3d
--- /dev/null
+++ b/crates/unsafe-libyaml/src/ops.rs
@@ -0,0 +1,111 @@
+pub(crate) trait ForceAdd: Sized {
+ fn force_add(self, rhs: Self) -> Self;
+}
+
+impl ForceAdd for u8 {
+ fn force_add(self, rhs: Self) -> Self {
+ self.checked_add(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceAdd for i32 {
+ fn force_add(self, rhs: Self) -> Self {
+ self.checked_add(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceAdd for u32 {
+ fn force_add(self, rhs: Self) -> Self {
+ self.checked_add(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceAdd for u64 {
+ fn force_add(self, rhs: Self) -> Self {
+ self.checked_add(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceAdd for usize {
+ fn force_add(self, rhs: Self) -> Self {
+ self.checked_add(rhs).unwrap_or_else(die)
+ }
+}
+
+pub(crate) trait ForceMul: Sized {
+ fn force_mul(self, rhs: Self) -> Self;
+}
+
+impl ForceMul for i32 {
+ fn force_mul(self, rhs: Self) -> Self {
+ self.checked_mul(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceMul for i64 {
+ fn force_mul(self, rhs: Self) -> Self {
+ self.checked_mul(rhs).unwrap_or_else(die)
+ }
+}
+
+impl ForceMul for u64 {
+ fn force_mul(self, rhs: Self) -> Self {
+ self.checked_mul(rhs).unwrap_or_else(die)
+ }
+}
+
+pub(crate) trait ForceInto {
+ fn force_into<U>(self) -> U
+ where
+ Self: TryInto<U>;
+}
+
+impl<T> ForceInto for T {
+ fn force_into<U>(self) -> U
+ where
+ Self: TryInto<U>,
+ {
+ <Self as TryInto<U>>::try_into(self)
+ .ok()
+ .unwrap_or_else(die)
+ }
+}
+
+// Deterministically abort on arithmetic overflow, instead of wrapping and
+// continuing with invalid behavior.
+//
+// This is impossible or nearly impossible to hit as the arithmetic computations
+// in libyaml are all related to either:
+//
+// - small integer processing (ascii, hex digits)
+// - allocation sizing
+//
+// and the only allocations in libyaml are for fixed-sized objects and
+// geometrically growing buffers with a growth factor of 2. So in order for an
+// allocation computation to overflow usize, the previous allocation for that
+// container must have been filled to a size of usize::MAX/2, which is an
+// allocation that would have failed in the allocator. But we check for this to
+// be pedantic and to find out if it ever does happen.
+//
+// No-std abort is implemented using a double panic. On most platforms the
+// current mechanism for this is for core::intrinsics::abort to invoke an
+// invalid instruction. On Unix, the process will probably terminate with a
+// signal like SIGABRT, SIGILL, SIGTRAP, SIGSEGV or SIGBUS. The precise
+// behaviour is not guaranteed and not stable, but is safe.
+#[cold]
+pub(crate) fn die<T>() -> T {
+ struct PanicAgain;
+
+ impl Drop for PanicAgain {
+ fn drop(&mut self) {
+ panic!("arithmetic overflow");
+ }
+ }
+
+ fn do_die() -> ! {
+ let _panic_again = PanicAgain;
+ panic!("arithmetic overflow");
+ }
+
+ do_die();
+}
diff --git a/crates/unsafe-libyaml/src/parser.rs b/crates/unsafe-libyaml/src/parser.rs
new file mode 100644
index 0000000..d40e5d2
--- /dev/null
+++ b/crates/unsafe-libyaml/src/parser.rs
@@ -0,0 +1,1352 @@
+use crate::api::{yaml_free, yaml_malloc, yaml_stack_extend, yaml_strdup};
+use crate::externs::{memcpy, memset, strcmp, strlen};
+use crate::ops::ForceAdd as _;
+use crate::scanner::yaml_parser_fetch_more_tokens;
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{size_t, yaml_char_t};
+use crate::{
+ libc, yaml_event_t, yaml_mark_t, yaml_parser_t, yaml_tag_directive_t, yaml_token_t,
+ yaml_version_directive_t, YAML_ALIAS_EVENT, YAML_ALIAS_TOKEN, YAML_ANCHOR_TOKEN,
+ YAML_BLOCK_END_TOKEN, YAML_BLOCK_ENTRY_TOKEN, YAML_BLOCK_MAPPING_START_TOKEN,
+ YAML_BLOCK_MAPPING_STYLE, YAML_BLOCK_SEQUENCE_START_TOKEN, YAML_BLOCK_SEQUENCE_STYLE,
+ YAML_DOCUMENT_END_EVENT, YAML_DOCUMENT_END_TOKEN, YAML_DOCUMENT_START_EVENT,
+ YAML_DOCUMENT_START_TOKEN, YAML_FLOW_ENTRY_TOKEN, YAML_FLOW_MAPPING_END_TOKEN,
+ YAML_FLOW_MAPPING_START_TOKEN, YAML_FLOW_MAPPING_STYLE, YAML_FLOW_SEQUENCE_END_TOKEN,
+ YAML_FLOW_SEQUENCE_START_TOKEN, YAML_FLOW_SEQUENCE_STYLE, YAML_KEY_TOKEN,
+ YAML_MAPPING_END_EVENT, YAML_MAPPING_START_EVENT, YAML_NO_ERROR, YAML_PARSER_ERROR,
+ YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE, YAML_PARSE_BLOCK_MAPPING_KEY_STATE,
+ YAML_PARSE_BLOCK_MAPPING_VALUE_STATE, YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE,
+ YAML_PARSE_BLOCK_NODE_STATE, YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE,
+ YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE, YAML_PARSE_DOCUMENT_CONTENT_STATE,
+ YAML_PARSE_DOCUMENT_END_STATE, YAML_PARSE_DOCUMENT_START_STATE, YAML_PARSE_END_STATE,
+ YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE, YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE,
+ YAML_PARSE_FLOW_MAPPING_KEY_STATE, YAML_PARSE_FLOW_MAPPING_VALUE_STATE,
+ YAML_PARSE_FLOW_NODE_STATE, YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE,
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE,
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE, YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE,
+ YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE, YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE,
+ YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE, YAML_PARSE_STREAM_START_STATE,
+ YAML_PLAIN_SCALAR_STYLE, YAML_SCALAR_EVENT, YAML_SCALAR_TOKEN, YAML_SEQUENCE_END_EVENT,
+ YAML_SEQUENCE_START_EVENT, YAML_STREAM_END_EVENT, YAML_STREAM_END_TOKEN,
+ YAML_STREAM_START_EVENT, YAML_STREAM_START_TOKEN, YAML_TAG_DIRECTIVE_TOKEN, YAML_TAG_TOKEN,
+ YAML_VALUE_TOKEN, YAML_VERSION_DIRECTIVE_TOKEN,
+};
+use core::mem::size_of;
+use core::ptr::{self, addr_of_mut};
+
+unsafe fn PEEK_TOKEN(parser: *mut yaml_parser_t) -> *mut yaml_token_t {
+ if (*parser).token_available || yaml_parser_fetch_more_tokens(parser).ok {
+ (*parser).tokens.head
+ } else {
+ ptr::null_mut::<yaml_token_t>()
+ }
+}
+
+unsafe fn SKIP_TOKEN(parser: *mut yaml_parser_t) {
+ (*parser).token_available = false;
+ let fresh3 = addr_of_mut!((*parser).tokens_parsed);
+ *fresh3 = (*fresh3).wrapping_add(1);
+ (*parser).stream_end_produced = (*(*parser).tokens.head).type_ == YAML_STREAM_END_TOKEN;
+ let fresh4 = addr_of_mut!((*parser).tokens.head);
+ *fresh4 = (*fresh4).wrapping_offset(1);
+}
+
+/// Parse the input stream and produce the next parsing event.
+///
+/// Call the function subsequently to produce a sequence of events corresponding
+/// to the input stream. The initial event has the type YAML_STREAM_START_EVENT
+/// while the ending event has the type YAML_STREAM_END_EVENT.
+///
+/// An application is responsible for freeing any buffers associated with the
+/// produced event object using the yaml_event_delete() function.
+///
+/// An application must not alternate the calls of yaml_parser_parse() with the
+/// calls of yaml_parser_scan() or yaml_parser_load(). Doing this will break the
+/// parser.
+pub unsafe fn yaml_parser_parse(parser: *mut yaml_parser_t, event: *mut yaml_event_t) -> Success {
+ __assert!(!parser.is_null());
+ __assert!(!event.is_null());
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ if (*parser).stream_end_produced
+ || (*parser).error != YAML_NO_ERROR
+ || (*parser).state == YAML_PARSE_END_STATE
+ {
+ return OK;
+ }
+ yaml_parser_state_machine(parser, event)
+}
+
+unsafe fn yaml_parser_set_parser_error(
+ parser: *mut yaml_parser_t,
+ problem: *const libc::c_char,
+ problem_mark: yaml_mark_t,
+) {
+ (*parser).error = YAML_PARSER_ERROR;
+ let fresh0 = addr_of_mut!((*parser).problem);
+ *fresh0 = problem;
+ (*parser).problem_mark = problem_mark;
+}
+
+unsafe fn yaml_parser_set_parser_error_context(
+ parser: *mut yaml_parser_t,
+ context: *const libc::c_char,
+ context_mark: yaml_mark_t,
+ problem: *const libc::c_char,
+ problem_mark: yaml_mark_t,
+) {
+ (*parser).error = YAML_PARSER_ERROR;
+ let fresh1 = addr_of_mut!((*parser).context);
+ *fresh1 = context;
+ (*parser).context_mark = context_mark;
+ let fresh2 = addr_of_mut!((*parser).problem);
+ *fresh2 = problem;
+ (*parser).problem_mark = problem_mark;
+}
+
+unsafe fn yaml_parser_state_machine(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ match (*parser).state {
+ YAML_PARSE_STREAM_START_STATE => yaml_parser_parse_stream_start(parser, event),
+ YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE => {
+ yaml_parser_parse_document_start(parser, event, true)
+ }
+ YAML_PARSE_DOCUMENT_START_STATE => yaml_parser_parse_document_start(parser, event, false),
+ YAML_PARSE_DOCUMENT_CONTENT_STATE => yaml_parser_parse_document_content(parser, event),
+ YAML_PARSE_DOCUMENT_END_STATE => yaml_parser_parse_document_end(parser, event),
+ YAML_PARSE_BLOCK_NODE_STATE => yaml_parser_parse_node(parser, event, true, false),
+ YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE => {
+ yaml_parser_parse_node(parser, event, true, true)
+ }
+ YAML_PARSE_FLOW_NODE_STATE => yaml_parser_parse_node(parser, event, false, false),
+ YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE => {
+ yaml_parser_parse_block_sequence_entry(parser, event, true)
+ }
+ YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE => {
+ yaml_parser_parse_block_sequence_entry(parser, event, false)
+ }
+ YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE => {
+ yaml_parser_parse_indentless_sequence_entry(parser, event)
+ }
+ YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE => {
+ yaml_parser_parse_block_mapping_key(parser, event, true)
+ }
+ YAML_PARSE_BLOCK_MAPPING_KEY_STATE => {
+ yaml_parser_parse_block_mapping_key(parser, event, false)
+ }
+ YAML_PARSE_BLOCK_MAPPING_VALUE_STATE => {
+ yaml_parser_parse_block_mapping_value(parser, event)
+ }
+ YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE => {
+ yaml_parser_parse_flow_sequence_entry(parser, event, true)
+ }
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE => {
+ yaml_parser_parse_flow_sequence_entry(parser, event, false)
+ }
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE => {
+ yaml_parser_parse_flow_sequence_entry_mapping_key(parser, event)
+ }
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE => {
+ yaml_parser_parse_flow_sequence_entry_mapping_value(parser, event)
+ }
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE => {
+ yaml_parser_parse_flow_sequence_entry_mapping_end(parser, event)
+ }
+ YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE => {
+ yaml_parser_parse_flow_mapping_key(parser, event, true)
+ }
+ YAML_PARSE_FLOW_MAPPING_KEY_STATE => {
+ yaml_parser_parse_flow_mapping_key(parser, event, false)
+ }
+ YAML_PARSE_FLOW_MAPPING_VALUE_STATE => {
+ yaml_parser_parse_flow_mapping_value(parser, event, false)
+ }
+ YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE => {
+ yaml_parser_parse_flow_mapping_value(parser, event, true)
+ }
+ _ => FAIL,
+ }
+}
+
+unsafe fn yaml_parser_parse_stream_start(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let token: *mut yaml_token_t = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_STREAM_START_TOKEN {
+ yaml_parser_set_parser_error(
+ parser,
+ b"did not find expected <stream-start>\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ return FAIL;
+ }
+ (*parser).state = YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_START_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).start_mark;
+ (*event).data.stream_start.encoding = (*token).data.stream_start.encoding;
+ SKIP_TOKEN(parser);
+ OK
+}
+
+unsafe fn yaml_parser_parse_document_start(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ implicit: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ let mut version_directive: *mut yaml_version_directive_t =
+ ptr::null_mut::<yaml_version_directive_t>();
+ struct TagDirectives {
+ start: *mut yaml_tag_directive_t,
+ end: *mut yaml_tag_directive_t,
+ }
+ let mut tag_directives = TagDirectives {
+ start: ptr::null_mut::<yaml_tag_directive_t>(),
+ end: ptr::null_mut::<yaml_tag_directive_t>(),
+ };
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if !implicit {
+ while (*token).type_ == YAML_DOCUMENT_END_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ }
+ }
+ if implicit
+ && (*token).type_ != YAML_VERSION_DIRECTIVE_TOKEN
+ && (*token).type_ != YAML_TAG_DIRECTIVE_TOKEN
+ && (*token).type_ != YAML_DOCUMENT_START_TOKEN
+ && (*token).type_ != YAML_STREAM_END_TOKEN
+ {
+ if yaml_parser_process_directives(
+ parser,
+ ptr::null_mut::<*mut yaml_version_directive_t>(),
+ ptr::null_mut::<*mut yaml_tag_directive_t>(),
+ ptr::null_mut::<*mut yaml_tag_directive_t>(),
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ PUSH!((*parser).states, YAML_PARSE_DOCUMENT_END_STATE);
+ (*parser).state = YAML_PARSE_BLOCK_NODE_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_START_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).start_mark;
+ let fresh9 = addr_of_mut!((*event).data.document_start.version_directive);
+ *fresh9 = ptr::null_mut::<yaml_version_directive_t>();
+ let fresh10 = addr_of_mut!((*event).data.document_start.tag_directives.start);
+ *fresh10 = ptr::null_mut::<yaml_tag_directive_t>();
+ let fresh11 = addr_of_mut!((*event).data.document_start.tag_directives.end);
+ *fresh11 = ptr::null_mut::<yaml_tag_directive_t>();
+ (*event).data.document_start.implicit = true;
+ OK
+ } else if (*token).type_ != YAML_STREAM_END_TOKEN {
+ let end_mark: yaml_mark_t;
+ let start_mark: yaml_mark_t = (*token).start_mark;
+ if yaml_parser_process_directives(
+ parser,
+ addr_of_mut!(version_directive),
+ addr_of_mut!(tag_directives.start),
+ addr_of_mut!(tag_directives.end),
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ token = PEEK_TOKEN(parser);
+ if !token.is_null() {
+ if (*token).type_ != YAML_DOCUMENT_START_TOKEN {
+ yaml_parser_set_parser_error(
+ parser,
+ b"did not find expected <document start>\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ } else {
+ PUSH!((*parser).states, YAML_PARSE_DOCUMENT_END_STATE);
+ (*parser).state = YAML_PARSE_DOCUMENT_CONTENT_STATE;
+ end_mark = (*token).end_mark;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh14 = addr_of_mut!((*event).data.document_start.version_directive);
+ *fresh14 = version_directive;
+ let fresh15 = addr_of_mut!((*event).data.document_start.tag_directives.start);
+ *fresh15 = tag_directives.start;
+ let fresh16 = addr_of_mut!((*event).data.document_start.tag_directives.end);
+ *fresh16 = tag_directives.end;
+ (*event).data.document_start.implicit = false;
+ SKIP_TOKEN(parser);
+ tag_directives.end = ptr::null_mut::<yaml_tag_directive_t>();
+ tag_directives.start = tag_directives.end;
+ return OK;
+ }
+ }
+ yaml_free(version_directive as *mut libc::c_void);
+ while tag_directives.start != tag_directives.end {
+ yaml_free((*tag_directives.end.wrapping_offset(-1_isize)).handle as *mut libc::c_void);
+ yaml_free((*tag_directives.end.wrapping_offset(-1_isize)).prefix as *mut libc::c_void);
+ tag_directives.end = tag_directives.end.wrapping_offset(-1);
+ }
+ yaml_free(tag_directives.start as *mut libc::c_void);
+ FAIL
+ } else {
+ (*parser).state = YAML_PARSE_END_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_STREAM_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ OK
+ }
+}
+
+unsafe fn yaml_parser_parse_document_content(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let token: *mut yaml_token_t = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_VERSION_DIRECTIVE_TOKEN
+ || (*token).type_ == YAML_TAG_DIRECTIVE_TOKEN
+ || (*token).type_ == YAML_DOCUMENT_START_TOKEN
+ || (*token).type_ == YAML_DOCUMENT_END_TOKEN
+ || (*token).type_ == YAML_STREAM_END_TOKEN
+ {
+ (*parser).state = POP!((*parser).states);
+ yaml_parser_process_empty_scalar(event, (*token).start_mark)
+ } else {
+ yaml_parser_parse_node(parser, event, true, false)
+ }
+}
+
+unsafe fn yaml_parser_parse_document_end(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut end_mark: yaml_mark_t;
+ let mut implicit = true;
+ let token: *mut yaml_token_t = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ end_mark = (*token).start_mark;
+ let start_mark: yaml_mark_t = end_mark;
+ if (*token).type_ == YAML_DOCUMENT_END_TOKEN {
+ end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ implicit = false;
+ }
+ while !STACK_EMPTY!((*parser).tag_directives) {
+ let tag_directive = POP!((*parser).tag_directives);
+ yaml_free(tag_directive.handle as *mut libc::c_void);
+ yaml_free(tag_directive.prefix as *mut libc::c_void);
+ }
+ (*parser).state = YAML_PARSE_DOCUMENT_START_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_DOCUMENT_END_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ (*event).data.document_end.implicit = implicit;
+ OK
+}
+
+unsafe fn yaml_parser_parse_node(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ block: bool,
+ indentless_sequence: bool,
+) -> Success {
+ let mut current_block: u64;
+ let mut token: *mut yaml_token_t;
+ let mut anchor: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag_handle: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag_suffix: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut tag: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut start_mark: yaml_mark_t;
+ let mut end_mark: yaml_mark_t;
+ let mut tag_mark = yaml_mark_t {
+ index: 0,
+ line: 0,
+ column: 0,
+ };
+ let implicit;
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_ALIAS_TOKEN {
+ (*parser).state = POP!((*parser).states);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_ALIAS_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ let fresh26 = addr_of_mut!((*event).data.alias.anchor);
+ *fresh26 = (*token).data.alias.value;
+ SKIP_TOKEN(parser);
+ OK
+ } else {
+ end_mark = (*token).start_mark;
+ start_mark = end_mark;
+ if (*token).type_ == YAML_ANCHOR_TOKEN {
+ anchor = (*token).data.anchor.value;
+ start_mark = (*token).start_mark;
+ end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ current_block = 17786380918591080555;
+ } else if (*token).type_ == YAML_TAG_TOKEN {
+ tag_handle = (*token).data.tag.handle;
+ tag_suffix = (*token).data.tag.suffix;
+ tag_mark = (*token).start_mark;
+ end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ current_block = 17786380918591080555;
+ } else {
+ current_block = 11743904203796629665;
+ }
+ } else {
+ current_block = 11743904203796629665;
+ }
+ } else if (*token).type_ == YAML_TAG_TOKEN {
+ tag_handle = (*token).data.tag.handle;
+ tag_suffix = (*token).data.tag.suffix;
+ tag_mark = (*token).start_mark;
+ start_mark = tag_mark;
+ end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ current_block = 17786380918591080555;
+ } else if (*token).type_ == YAML_ANCHOR_TOKEN {
+ anchor = (*token).data.anchor.value;
+ end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ current_block = 17786380918591080555;
+ } else {
+ current_block = 11743904203796629665;
+ }
+ } else {
+ current_block = 11743904203796629665;
+ }
+ } else {
+ current_block = 11743904203796629665;
+ }
+ if current_block == 11743904203796629665 {
+ if !tag_handle.is_null() {
+ if *tag_handle == 0 {
+ tag = tag_suffix;
+ yaml_free(tag_handle as *mut libc::c_void);
+ tag_suffix = ptr::null_mut::<yaml_char_t>();
+ tag_handle = tag_suffix;
+ current_block = 9437013279121998969;
+ } else {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ tag_directive = (*parser).tag_directives.start;
+ loop {
+ if !(tag_directive != (*parser).tag_directives.top) {
+ current_block = 17728966195399430138;
+ break;
+ }
+ if strcmp(
+ (*tag_directive).handle as *mut libc::c_char,
+ tag_handle as *mut libc::c_char,
+ ) == 0
+ {
+ let prefix_len: size_t =
+ strlen((*tag_directive).prefix as *mut libc::c_char);
+ let suffix_len: size_t = strlen(tag_suffix as *mut libc::c_char);
+ tag = yaml_malloc(prefix_len.force_add(suffix_len).force_add(1_u64))
+ as *mut yaml_char_t;
+ memcpy(
+ tag as *mut libc::c_void,
+ (*tag_directive).prefix as *const libc::c_void,
+ prefix_len,
+ );
+ memcpy(
+ tag.wrapping_offset(prefix_len as isize) as *mut libc::c_void,
+ tag_suffix as *const libc::c_void,
+ suffix_len,
+ );
+ *tag.wrapping_offset(prefix_len.force_add(suffix_len) as isize) = b'\0';
+ yaml_free(tag_handle as *mut libc::c_void);
+ yaml_free(tag_suffix as *mut libc::c_void);
+ tag_suffix = ptr::null_mut::<yaml_char_t>();
+ tag_handle = tag_suffix;
+ current_block = 17728966195399430138;
+ break;
+ } else {
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ }
+ if current_block != 17786380918591080555 {
+ if tag.is_null() {
+ yaml_parser_set_parser_error_context(
+ parser,
+ b"while parsing a node\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found undefined tag handle\0" as *const u8 as *const libc::c_char,
+ tag_mark,
+ );
+ current_block = 17786380918591080555;
+ } else {
+ current_block = 9437013279121998969;
+ }
+ }
+ }
+ } else {
+ current_block = 9437013279121998969;
+ }
+ if current_block != 17786380918591080555 {
+ implicit = tag.is_null() || *tag == 0;
+ if indentless_sequence && (*token).type_ == YAML_BLOCK_ENTRY_TOKEN {
+ end_mark = (*token).end_mark;
+ (*parser).state = YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh37 = addr_of_mut!((*event).data.sequence_start.anchor);
+ *fresh37 = anchor;
+ let fresh38 = addr_of_mut!((*event).data.sequence_start.tag);
+ *fresh38 = tag;
+ (*event).data.sequence_start.implicit = implicit;
+ (*event).data.sequence_start.style = YAML_BLOCK_SEQUENCE_STYLE;
+ return OK;
+ } else if (*token).type_ == YAML_SCALAR_TOKEN {
+ let mut plain_implicit = false;
+ let mut quoted_implicit = false;
+ end_mark = (*token).end_mark;
+ if (*token).data.scalar.style == YAML_PLAIN_SCALAR_STYLE && tag.is_null()
+ || !tag.is_null()
+ && strcmp(
+ tag as *mut libc::c_char,
+ b"!\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ plain_implicit = true;
+ } else if tag.is_null() {
+ quoted_implicit = true;
+ }
+ (*parser).state = POP!((*parser).states);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SCALAR_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh40 = addr_of_mut!((*event).data.scalar.anchor);
+ *fresh40 = anchor;
+ let fresh41 = addr_of_mut!((*event).data.scalar.tag);
+ *fresh41 = tag;
+ let fresh42 = addr_of_mut!((*event).data.scalar.value);
+ *fresh42 = (*token).data.scalar.value;
+ (*event).data.scalar.length = (*token).data.scalar.length;
+ (*event).data.scalar.plain_implicit = plain_implicit;
+ (*event).data.scalar.quoted_implicit = quoted_implicit;
+ (*event).data.scalar.style = (*token).data.scalar.style;
+ SKIP_TOKEN(parser);
+ return OK;
+ } else if (*token).type_ == YAML_FLOW_SEQUENCE_START_TOKEN {
+ end_mark = (*token).end_mark;
+ (*parser).state = YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh45 = addr_of_mut!((*event).data.sequence_start.anchor);
+ *fresh45 = anchor;
+ let fresh46 = addr_of_mut!((*event).data.sequence_start.tag);
+ *fresh46 = tag;
+ (*event).data.sequence_start.implicit = implicit;
+ (*event).data.sequence_start.style = YAML_FLOW_SEQUENCE_STYLE;
+ return OK;
+ } else if (*token).type_ == YAML_FLOW_MAPPING_START_TOKEN {
+ end_mark = (*token).end_mark;
+ (*parser).state = YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh47 = addr_of_mut!((*event).data.mapping_start.anchor);
+ *fresh47 = anchor;
+ let fresh48 = addr_of_mut!((*event).data.mapping_start.tag);
+ *fresh48 = tag;
+ (*event).data.mapping_start.implicit = implicit;
+ (*event).data.mapping_start.style = YAML_FLOW_MAPPING_STYLE;
+ return OK;
+ } else if block && (*token).type_ == YAML_BLOCK_SEQUENCE_START_TOKEN {
+ end_mark = (*token).end_mark;
+ (*parser).state = YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh49 = addr_of_mut!((*event).data.sequence_start.anchor);
+ *fresh49 = anchor;
+ let fresh50 = addr_of_mut!((*event).data.sequence_start.tag);
+ *fresh50 = tag;
+ (*event).data.sequence_start.implicit = implicit;
+ (*event).data.sequence_start.style = YAML_BLOCK_SEQUENCE_STYLE;
+ return OK;
+ } else if block && (*token).type_ == YAML_BLOCK_MAPPING_START_TOKEN {
+ end_mark = (*token).end_mark;
+ (*parser).state = YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_START_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh51 = addr_of_mut!((*event).data.mapping_start.anchor);
+ *fresh51 = anchor;
+ let fresh52 = addr_of_mut!((*event).data.mapping_start.tag);
+ *fresh52 = tag;
+ (*event).data.mapping_start.implicit = implicit;
+ (*event).data.mapping_start.style = YAML_BLOCK_MAPPING_STYLE;
+ return OK;
+ } else if !anchor.is_null() || !tag.is_null() {
+ let value: *mut yaml_char_t = yaml_malloc(1_u64) as *mut yaml_char_t;
+ *value = b'\0';
+ (*parser).state = POP!((*parser).states);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SCALAR_EVENT;
+ (*event).start_mark = start_mark;
+ (*event).end_mark = end_mark;
+ let fresh54 = addr_of_mut!((*event).data.scalar.anchor);
+ *fresh54 = anchor;
+ let fresh55 = addr_of_mut!((*event).data.scalar.tag);
+ *fresh55 = tag;
+ let fresh56 = addr_of_mut!((*event).data.scalar.value);
+ *fresh56 = value;
+ (*event).data.scalar.length = 0_u64;
+ (*event).data.scalar.plain_implicit = implicit;
+ (*event).data.scalar.quoted_implicit = false;
+ (*event).data.scalar.style = YAML_PLAIN_SCALAR_STYLE;
+ return OK;
+ } else {
+ yaml_parser_set_parser_error_context(
+ parser,
+ if block {
+ b"while parsing a block node\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while parsing a flow node\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"did not find expected node content\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ }
+ }
+ }
+ yaml_free(anchor as *mut libc::c_void);
+ yaml_free(tag_handle as *mut libc::c_void);
+ yaml_free(tag_suffix as *mut libc::c_void);
+ yaml_free(tag as *mut libc::c_void);
+ FAIL
+ }
+}
+
+unsafe fn yaml_parser_parse_block_sequence_entry(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ if first {
+ token = PEEK_TOKEN(parser);
+ PUSH!((*parser).marks, (*token).start_mark);
+ SKIP_TOKEN(parser);
+ }
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_BLOCK_ENTRY_TOKEN {
+ let mark: yaml_mark_t = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_BLOCK_ENTRY_TOKEN && (*token).type_ != YAML_BLOCK_END_TOKEN {
+ PUSH!((*parser).states, YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE);
+ yaml_parser_parse_node(parser, event, true, false)
+ } else {
+ (*parser).state = YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE;
+ yaml_parser_process_empty_scalar(event, mark)
+ }
+ } else if (*token).type_ == YAML_BLOCK_END_TOKEN {
+ (*parser).state = POP!((*parser).states);
+ let _ = POP!((*parser).marks);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ OK
+ } else {
+ yaml_parser_set_parser_error_context(
+ parser,
+ b"while parsing a block collection\0" as *const u8 as *const libc::c_char,
+ POP!((*parser).marks),
+ b"did not find expected '-' indicator\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ FAIL
+ }
+}
+
+unsafe fn yaml_parser_parse_indentless_sequence_entry(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_BLOCK_ENTRY_TOKEN {
+ let mark: yaml_mark_t = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_BLOCK_ENTRY_TOKEN
+ && (*token).type_ != YAML_KEY_TOKEN
+ && (*token).type_ != YAML_VALUE_TOKEN
+ && (*token).type_ != YAML_BLOCK_END_TOKEN
+ {
+ PUSH!((*parser).states, YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE);
+ yaml_parser_parse_node(parser, event, true, false)
+ } else {
+ (*parser).state = YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE;
+ yaml_parser_process_empty_scalar(event, mark)
+ }
+ } else {
+ (*parser).state = POP!((*parser).states);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).start_mark;
+ OK
+ }
+}
+
+unsafe fn yaml_parser_parse_block_mapping_key(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ if first {
+ token = PEEK_TOKEN(parser);
+ PUSH!((*parser).marks, (*token).start_mark);
+ SKIP_TOKEN(parser);
+ }
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_KEY_TOKEN {
+ let mark: yaml_mark_t = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_KEY_TOKEN
+ && (*token).type_ != YAML_VALUE_TOKEN
+ && (*token).type_ != YAML_BLOCK_END_TOKEN
+ {
+ PUSH!((*parser).states, YAML_PARSE_BLOCK_MAPPING_VALUE_STATE);
+ yaml_parser_parse_node(parser, event, true, true)
+ } else {
+ (*parser).state = YAML_PARSE_BLOCK_MAPPING_VALUE_STATE;
+ yaml_parser_process_empty_scalar(event, mark)
+ }
+ } else if (*token).type_ == YAML_BLOCK_END_TOKEN {
+ (*parser).state = POP!((*parser).states);
+ let _ = POP!((*parser).marks);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ OK
+ } else {
+ yaml_parser_set_parser_error_context(
+ parser,
+ b"while parsing a block mapping\0" as *const u8 as *const libc::c_char,
+ POP!((*parser).marks),
+ b"did not find expected key\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ FAIL
+ }
+}
+
+unsafe fn yaml_parser_parse_block_mapping_value(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_VALUE_TOKEN {
+ let mark: yaml_mark_t = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_KEY_TOKEN
+ && (*token).type_ != YAML_VALUE_TOKEN
+ && (*token).type_ != YAML_BLOCK_END_TOKEN
+ {
+ PUSH!((*parser).states, YAML_PARSE_BLOCK_MAPPING_KEY_STATE);
+ yaml_parser_parse_node(parser, event, true, true)
+ } else {
+ (*parser).state = YAML_PARSE_BLOCK_MAPPING_KEY_STATE;
+ yaml_parser_process_empty_scalar(event, mark)
+ }
+ } else {
+ (*parser).state = YAML_PARSE_BLOCK_MAPPING_KEY_STATE;
+ yaml_parser_process_empty_scalar(event, (*token).start_mark)
+ }
+}
+
+unsafe fn yaml_parser_parse_flow_sequence_entry(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ if first {
+ token = PEEK_TOKEN(parser);
+ PUSH!((*parser).marks, (*token).start_mark);
+ SKIP_TOKEN(parser);
+ }
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_FLOW_SEQUENCE_END_TOKEN {
+ if !first {
+ if (*token).type_ == YAML_FLOW_ENTRY_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ } else {
+ yaml_parser_set_parser_error_context(
+ parser,
+ b"while parsing a flow sequence\0" as *const u8 as *const libc::c_char,
+ POP!((*parser).marks),
+ b"did not find expected ',' or ']'\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ return FAIL;
+ }
+ }
+ if (*token).type_ == YAML_KEY_TOKEN {
+ (*parser).state = YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_START_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ let fresh99 = addr_of_mut!((*event).data.mapping_start.anchor);
+ *fresh99 = ptr::null_mut::<yaml_char_t>();
+ let fresh100 = addr_of_mut!((*event).data.mapping_start.tag);
+ *fresh100 = ptr::null_mut::<yaml_char_t>();
+ (*event).data.mapping_start.implicit = true;
+ (*event).data.mapping_start.style = YAML_FLOW_MAPPING_STYLE;
+ SKIP_TOKEN(parser);
+ return OK;
+ } else if (*token).type_ != YAML_FLOW_SEQUENCE_END_TOKEN {
+ PUSH!((*parser).states, YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE);
+ return yaml_parser_parse_node(parser, event, false, false);
+ }
+ }
+ (*parser).state = POP!((*parser).states);
+ let _ = POP!((*parser).marks);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SEQUENCE_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ OK
+}
+
+unsafe fn yaml_parser_parse_flow_sequence_entry_mapping_key(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let token: *mut yaml_token_t = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_VALUE_TOKEN
+ && (*token).type_ != YAML_FLOW_ENTRY_TOKEN
+ && (*token).type_ != YAML_FLOW_SEQUENCE_END_TOKEN
+ {
+ PUSH!(
+ (*parser).states,
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE
+ );
+ yaml_parser_parse_node(parser, event, false, false)
+ } else {
+ let mark: yaml_mark_t = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ (*parser).state = YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE;
+ yaml_parser_process_empty_scalar(event, mark)
+ }
+}
+
+unsafe fn yaml_parser_parse_flow_sequence_entry_mapping_value(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ == YAML_VALUE_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_FLOW_ENTRY_TOKEN && (*token).type_ != YAML_FLOW_SEQUENCE_END_TOKEN
+ {
+ PUSH!(
+ (*parser).states,
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE
+ );
+ return yaml_parser_parse_node(parser, event, false, false);
+ }
+ }
+ (*parser).state = YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE;
+ yaml_parser_process_empty_scalar(event, (*token).start_mark)
+}
+
+unsafe fn yaml_parser_parse_flow_sequence_entry_mapping_end(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+) -> Success {
+ let token: *mut yaml_token_t = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ (*parser).state = YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE;
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).start_mark;
+ OK
+}
+
+unsafe fn yaml_parser_parse_flow_mapping_key(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ first: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ if first {
+ token = PEEK_TOKEN(parser);
+ PUSH!((*parser).marks, (*token).start_mark);
+ SKIP_TOKEN(parser);
+ }
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_FLOW_MAPPING_END_TOKEN {
+ if !first {
+ if (*token).type_ == YAML_FLOW_ENTRY_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ } else {
+ yaml_parser_set_parser_error_context(
+ parser,
+ b"while parsing a flow mapping\0" as *const u8 as *const libc::c_char,
+ POP!((*parser).marks),
+ b"did not find expected ',' or '}'\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ return FAIL;
+ }
+ }
+ if (*token).type_ == YAML_KEY_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_VALUE_TOKEN
+ && (*token).type_ != YAML_FLOW_ENTRY_TOKEN
+ && (*token).type_ != YAML_FLOW_MAPPING_END_TOKEN
+ {
+ PUSH!((*parser).states, YAML_PARSE_FLOW_MAPPING_VALUE_STATE);
+ return yaml_parser_parse_node(parser, event, false, false);
+ } else {
+ (*parser).state = YAML_PARSE_FLOW_MAPPING_VALUE_STATE;
+ return yaml_parser_process_empty_scalar(event, (*token).start_mark);
+ }
+ } else if (*token).type_ != YAML_FLOW_MAPPING_END_TOKEN {
+ PUSH!((*parser).states, YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE);
+ return yaml_parser_parse_node(parser, event, false, false);
+ }
+ }
+ (*parser).state = POP!((*parser).states);
+ let _ = POP!((*parser).marks);
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_MAPPING_END_EVENT;
+ (*event).start_mark = (*token).start_mark;
+ (*event).end_mark = (*token).end_mark;
+ SKIP_TOKEN(parser);
+ OK
+}
+
+unsafe fn yaml_parser_parse_flow_mapping_value(
+ parser: *mut yaml_parser_t,
+ event: *mut yaml_event_t,
+ empty: bool,
+) -> Success {
+ let mut token: *mut yaml_token_t;
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if empty {
+ (*parser).state = YAML_PARSE_FLOW_MAPPING_KEY_STATE;
+ return yaml_parser_process_empty_scalar(event, (*token).start_mark);
+ }
+ if (*token).type_ == YAML_VALUE_TOKEN {
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ return FAIL;
+ }
+ if (*token).type_ != YAML_FLOW_ENTRY_TOKEN && (*token).type_ != YAML_FLOW_MAPPING_END_TOKEN
+ {
+ PUSH!((*parser).states, YAML_PARSE_FLOW_MAPPING_KEY_STATE);
+ return yaml_parser_parse_node(parser, event, false, false);
+ }
+ }
+ (*parser).state = YAML_PARSE_FLOW_MAPPING_KEY_STATE;
+ yaml_parser_process_empty_scalar(event, (*token).start_mark)
+}
+
+unsafe fn yaml_parser_process_empty_scalar(event: *mut yaml_event_t, mark: yaml_mark_t) -> Success {
+ let value: *mut yaml_char_t = yaml_malloc(1_u64) as *mut yaml_char_t;
+ *value = b'\0';
+ memset(
+ event as *mut libc::c_void,
+ 0,
+ size_of::<yaml_event_t>() as libc::c_ulong,
+ );
+ (*event).type_ = YAML_SCALAR_EVENT;
+ (*event).start_mark = mark;
+ (*event).end_mark = mark;
+ let fresh138 = addr_of_mut!((*event).data.scalar.anchor);
+ *fresh138 = ptr::null_mut::<yaml_char_t>();
+ let fresh139 = addr_of_mut!((*event).data.scalar.tag);
+ *fresh139 = ptr::null_mut::<yaml_char_t>();
+ let fresh140 = addr_of_mut!((*event).data.scalar.value);
+ *fresh140 = value;
+ (*event).data.scalar.length = 0_u64;
+ (*event).data.scalar.plain_implicit = true;
+ (*event).data.scalar.quoted_implicit = false;
+ (*event).data.scalar.style = YAML_PLAIN_SCALAR_STYLE;
+ OK
+}
+
+unsafe fn yaml_parser_process_directives(
+ parser: *mut yaml_parser_t,
+ version_directive_ref: *mut *mut yaml_version_directive_t,
+ tag_directives_start_ref: *mut *mut yaml_tag_directive_t,
+ tag_directives_end_ref: *mut *mut yaml_tag_directive_t,
+) -> Success {
+ let mut current_block: u64;
+ let mut default_tag_directives: [yaml_tag_directive_t; 3] = [
+ yaml_tag_directive_t {
+ handle: b"!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ prefix: b"!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ },
+ yaml_tag_directive_t {
+ handle: b"!!\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ prefix: b"tag:yaml.org,2002:\0" as *const u8 as *const libc::c_char as *mut yaml_char_t,
+ },
+ yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ },
+ ];
+ let mut default_tag_directive: *mut yaml_tag_directive_t;
+ let mut version_directive: *mut yaml_version_directive_t =
+ ptr::null_mut::<yaml_version_directive_t>();
+ struct TagDirectives {
+ start: *mut yaml_tag_directive_t,
+ end: *mut yaml_tag_directive_t,
+ top: *mut yaml_tag_directive_t,
+ }
+ let mut tag_directives = TagDirectives {
+ start: ptr::null_mut::<yaml_tag_directive_t>(),
+ end: ptr::null_mut::<yaml_tag_directive_t>(),
+ top: ptr::null_mut::<yaml_tag_directive_t>(),
+ };
+ let mut token: *mut yaml_token_t;
+ STACK_INIT!(tag_directives, yaml_tag_directive_t);
+ token = PEEK_TOKEN(parser);
+ if !token.is_null() {
+ loop {
+ if !((*token).type_ == YAML_VERSION_DIRECTIVE_TOKEN
+ || (*token).type_ == YAML_TAG_DIRECTIVE_TOKEN)
+ {
+ current_block = 16924917904204750491;
+ break;
+ }
+ if (*token).type_ == YAML_VERSION_DIRECTIVE_TOKEN {
+ if !version_directive.is_null() {
+ yaml_parser_set_parser_error(
+ parser,
+ b"found duplicate %YAML directive\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ current_block = 17143798186130252483;
+ break;
+ } else if (*token).data.version_directive.major != 1
+ || (*token).data.version_directive.minor != 1
+ && (*token).data.version_directive.minor != 2
+ {
+ yaml_parser_set_parser_error(
+ parser,
+ b"found incompatible YAML document\0" as *const u8 as *const libc::c_char,
+ (*token).start_mark,
+ );
+ current_block = 17143798186130252483;
+ break;
+ } else {
+ version_directive =
+ yaml_malloc(size_of::<yaml_version_directive_t>() as libc::c_ulong)
+ as *mut yaml_version_directive_t;
+ (*version_directive).major = (*token).data.version_directive.major;
+ (*version_directive).minor = (*token).data.version_directive.minor;
+ }
+ } else if (*token).type_ == YAML_TAG_DIRECTIVE_TOKEN {
+ let value = yaml_tag_directive_t {
+ handle: (*token).data.tag_directive.handle,
+ prefix: (*token).data.tag_directive.prefix,
+ };
+ if yaml_parser_append_tag_directive(parser, value, false, (*token).start_mark).fail
+ {
+ current_block = 17143798186130252483;
+ break;
+ }
+ PUSH!(tag_directives, value);
+ }
+ SKIP_TOKEN(parser);
+ token = PEEK_TOKEN(parser);
+ if token.is_null() {
+ current_block = 17143798186130252483;
+ break;
+ }
+ }
+ if current_block != 17143798186130252483 {
+ default_tag_directive = default_tag_directives.as_mut_ptr();
+ loop {
+ if (*default_tag_directive).handle.is_null() {
+ current_block = 18377268871191777778;
+ break;
+ }
+ if yaml_parser_append_tag_directive(
+ parser,
+ *default_tag_directive,
+ true,
+ (*token).start_mark,
+ )
+ .fail
+ {
+ current_block = 17143798186130252483;
+ break;
+ }
+ default_tag_directive = default_tag_directive.wrapping_offset(1);
+ }
+ if current_block != 17143798186130252483 {
+ if !version_directive_ref.is_null() {
+ *version_directive_ref = version_directive;
+ }
+ if !tag_directives_start_ref.is_null() {
+ if STACK_EMPTY!(tag_directives) {
+ *tag_directives_end_ref = ptr::null_mut::<yaml_tag_directive_t>();
+ *tag_directives_start_ref = *tag_directives_end_ref;
+ STACK_DEL!(tag_directives);
+ } else {
+ *tag_directives_start_ref = tag_directives.start;
+ *tag_directives_end_ref = tag_directives.top;
+ }
+ } else {
+ STACK_DEL!(tag_directives);
+ }
+ if version_directive_ref.is_null() {
+ yaml_free(version_directive as *mut libc::c_void);
+ }
+ return OK;
+ }
+ }
+ }
+ yaml_free(version_directive as *mut libc::c_void);
+ while !STACK_EMPTY!(tag_directives) {
+ let tag_directive = POP!(tag_directives);
+ yaml_free(tag_directive.handle as *mut libc::c_void);
+ yaml_free(tag_directive.prefix as *mut libc::c_void);
+ }
+ STACK_DEL!(tag_directives);
+ FAIL
+}
+
+unsafe fn yaml_parser_append_tag_directive(
+ parser: *mut yaml_parser_t,
+ value: yaml_tag_directive_t,
+ allow_duplicates: bool,
+ mark: yaml_mark_t,
+) -> Success {
+ let mut tag_directive: *mut yaml_tag_directive_t;
+ let mut copy = yaml_tag_directive_t {
+ handle: ptr::null_mut::<yaml_char_t>(),
+ prefix: ptr::null_mut::<yaml_char_t>(),
+ };
+ tag_directive = (*parser).tag_directives.start;
+ while tag_directive != (*parser).tag_directives.top {
+ if strcmp(
+ value.handle as *mut libc::c_char,
+ (*tag_directive).handle as *mut libc::c_char,
+ ) == 0
+ {
+ if allow_duplicates {
+ return OK;
+ }
+ yaml_parser_set_parser_error(
+ parser,
+ b"found duplicate %TAG directive\0" as *const u8 as *const libc::c_char,
+ mark,
+ );
+ return FAIL;
+ }
+ tag_directive = tag_directive.wrapping_offset(1);
+ }
+ copy.handle = yaml_strdup(value.handle);
+ copy.prefix = yaml_strdup(value.prefix);
+ PUSH!((*parser).tag_directives, copy);
+ OK
+}
diff --git a/crates/unsafe-libyaml/src/reader.rs b/crates/unsafe-libyaml/src/reader.rs
new file mode 100644
index 0000000..5adc54a
--- /dev/null
+++ b/crates/unsafe-libyaml/src/reader.rs
@@ -0,0 +1,468 @@
+use crate::externs::{memcmp, memmove};
+use crate::ops::ForceAdd as _;
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{size_t, yaml_char_t};
+use crate::{
+ libc, yaml_parser_t, PointerExt, YAML_ANY_ENCODING, YAML_READER_ERROR, YAML_UTF16BE_ENCODING,
+ YAML_UTF16LE_ENCODING, YAML_UTF8_ENCODING,
+};
+use core::ptr::addr_of_mut;
+
+unsafe fn yaml_parser_set_reader_error(
+ parser: *mut yaml_parser_t,
+ problem: *const libc::c_char,
+ offset: size_t,
+ value: libc::c_int,
+) -> Success {
+ (*parser).error = YAML_READER_ERROR;
+ let fresh0 = addr_of_mut!((*parser).problem);
+ *fresh0 = problem;
+ (*parser).problem_offset = offset;
+ (*parser).problem_value = value;
+ FAIL
+}
+
+const BOM_UTF8: *const libc::c_char = b"\xEF\xBB\xBF\0" as *const u8 as *const libc::c_char;
+const BOM_UTF16LE: *const libc::c_char = b"\xFF\xFE\0" as *const u8 as *const libc::c_char;
+const BOM_UTF16BE: *const libc::c_char = b"\xFE\xFF\0" as *const u8 as *const libc::c_char;
+
+unsafe fn yaml_parser_determine_encoding(parser: *mut yaml_parser_t) -> Success {
+ while !(*parser).eof
+ && ((*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer) as libc::c_long)
+ < 3_i64
+ {
+ if yaml_parser_update_raw_buffer(parser).fail {
+ return FAIL;
+ }
+ }
+ if (*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer) as libc::c_long
+ >= 2_i64
+ && memcmp(
+ (*parser).raw_buffer.pointer as *const libc::c_void,
+ BOM_UTF16LE as *const libc::c_void,
+ 2_u64,
+ ) == 0
+ {
+ (*parser).encoding = YAML_UTF16LE_ENCODING;
+ let fresh1 = addr_of_mut!((*parser).raw_buffer.pointer);
+ *fresh1 = (*fresh1).wrapping_offset(2_isize);
+ let fresh2 = addr_of_mut!((*parser).offset);
+ *fresh2 = (*fresh2 as libc::c_ulong).force_add(2_u64) as size_t;
+ } else if (*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer) as libc::c_long
+ >= 2_i64
+ && memcmp(
+ (*parser).raw_buffer.pointer as *const libc::c_void,
+ BOM_UTF16BE as *const libc::c_void,
+ 2_u64,
+ ) == 0
+ {
+ (*parser).encoding = YAML_UTF16BE_ENCODING;
+ let fresh3 = addr_of_mut!((*parser).raw_buffer.pointer);
+ *fresh3 = (*fresh3).wrapping_offset(2_isize);
+ let fresh4 = addr_of_mut!((*parser).offset);
+ *fresh4 = (*fresh4 as libc::c_ulong).force_add(2_u64) as size_t;
+ } else if (*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer) as libc::c_long
+ >= 3_i64
+ && memcmp(
+ (*parser).raw_buffer.pointer as *const libc::c_void,
+ BOM_UTF8 as *const libc::c_void,
+ 3_u64,
+ ) == 0
+ {
+ (*parser).encoding = YAML_UTF8_ENCODING;
+ let fresh5 = addr_of_mut!((*parser).raw_buffer.pointer);
+ *fresh5 = (*fresh5).wrapping_offset(3_isize);
+ let fresh6 = addr_of_mut!((*parser).offset);
+ *fresh6 = (*fresh6 as libc::c_ulong).force_add(3_u64) as size_t;
+ } else {
+ (*parser).encoding = YAML_UTF8_ENCODING;
+ }
+ OK
+}
+
+unsafe fn yaml_parser_update_raw_buffer(parser: *mut yaml_parser_t) -> Success {
+ let mut size_read: size_t = 0_u64;
+ if (*parser).raw_buffer.start == (*parser).raw_buffer.pointer
+ && (*parser).raw_buffer.last == (*parser).raw_buffer.end
+ {
+ return OK;
+ }
+ if (*parser).eof {
+ return OK;
+ }
+ if (*parser).raw_buffer.start < (*parser).raw_buffer.pointer
+ && (*parser).raw_buffer.pointer < (*parser).raw_buffer.last
+ {
+ memmove(
+ (*parser).raw_buffer.start as *mut libc::c_void,
+ (*parser).raw_buffer.pointer as *const libc::c_void,
+ (*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer) as libc::c_long
+ as libc::c_ulong,
+ );
+ }
+ let fresh7 = addr_of_mut!((*parser).raw_buffer.last);
+ *fresh7 = (*fresh7).wrapping_offset(
+ -((*parser)
+ .raw_buffer
+ .pointer
+ .c_offset_from((*parser).raw_buffer.start) as libc::c_long as isize),
+ );
+ let fresh8 = addr_of_mut!((*parser).raw_buffer.pointer);
+ *fresh8 = (*parser).raw_buffer.start;
+ if (*parser).read_handler.expect("non-null function pointer")(
+ (*parser).read_handler_data,
+ (*parser).raw_buffer.last,
+ (*parser)
+ .raw_buffer
+ .end
+ .c_offset_from((*parser).raw_buffer.last) as size_t,
+ addr_of_mut!(size_read),
+ ) == 0
+ {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"input error\0" as *const u8 as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ let fresh9 = addr_of_mut!((*parser).raw_buffer.last);
+ *fresh9 = (*fresh9).wrapping_offset(size_read as isize);
+ if size_read == 0 {
+ (*parser).eof = true;
+ }
+ OK
+}
+
+pub(crate) unsafe fn yaml_parser_update_buffer(
+ parser: *mut yaml_parser_t,
+ length: size_t,
+) -> Success {
+ let mut first = true;
+ __assert!(((*parser).read_handler).is_some());
+ if (*parser).eof && (*parser).raw_buffer.pointer == (*parser).raw_buffer.last {
+ return OK;
+ }
+ if (*parser).unread >= length {
+ return OK;
+ }
+ if (*parser).encoding == YAML_ANY_ENCODING {
+ if yaml_parser_determine_encoding(parser).fail {
+ return FAIL;
+ }
+ }
+ if (*parser).buffer.start < (*parser).buffer.pointer
+ && (*parser).buffer.pointer < (*parser).buffer.last
+ {
+ let size: size_t = (*parser)
+ .buffer
+ .last
+ .c_offset_from((*parser).buffer.pointer) as size_t;
+ memmove(
+ (*parser).buffer.start as *mut libc::c_void,
+ (*parser).buffer.pointer as *const libc::c_void,
+ size,
+ );
+ let fresh10 = addr_of_mut!((*parser).buffer.pointer);
+ *fresh10 = (*parser).buffer.start;
+ let fresh11 = addr_of_mut!((*parser).buffer.last);
+ *fresh11 = (*parser).buffer.start.wrapping_offset(size as isize);
+ } else if (*parser).buffer.pointer == (*parser).buffer.last {
+ let fresh12 = addr_of_mut!((*parser).buffer.pointer);
+ *fresh12 = (*parser).buffer.start;
+ let fresh13 = addr_of_mut!((*parser).buffer.last);
+ *fresh13 = (*parser).buffer.start;
+ }
+ while (*parser).unread < length {
+ if !first || (*parser).raw_buffer.pointer == (*parser).raw_buffer.last {
+ if yaml_parser_update_raw_buffer(parser).fail {
+ return FAIL;
+ }
+ }
+ first = false;
+ while (*parser).raw_buffer.pointer != (*parser).raw_buffer.last {
+ let mut value: libc::c_uint = 0;
+ let value2: libc::c_uint;
+ let mut incomplete = false;
+ let mut octet: libc::c_uchar;
+ let mut width: libc::c_uint = 0;
+ let low: libc::c_int;
+ let high: libc::c_int;
+ let mut k: size_t;
+ let raw_unread: size_t = (*parser)
+ .raw_buffer
+ .last
+ .c_offset_from((*parser).raw_buffer.pointer)
+ as size_t;
+ match (*parser).encoding {
+ YAML_UTF8_ENCODING => {
+ octet = *(*parser).raw_buffer.pointer;
+ width = if octet & 0x80 == 0 {
+ 1
+ } else if octet & 0xE0 == 0xC0 {
+ 2
+ } else if octet & 0xF0 == 0xE0 {
+ 3
+ } else if octet & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ } as libc::c_uint;
+ if width == 0 {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"invalid leading UTF-8 octet\0" as *const u8 as *const libc::c_char,
+ (*parser).offset,
+ octet as libc::c_int,
+ );
+ }
+ if width as libc::c_ulong > raw_unread {
+ if (*parser).eof {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"incomplete UTF-8 octet sequence\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ incomplete = true;
+ } else {
+ value = if octet & 0x80 == 0 {
+ octet & 0x7F
+ } else if octet & 0xE0 == 0xC0 {
+ octet & 0x1F
+ } else if octet & 0xF0 == 0xE0 {
+ octet & 0xF
+ } else if octet & 0xF8 == 0xF0 {
+ octet & 0x7
+ } else {
+ 0
+ } as libc::c_uint;
+ k = 1_u64;
+ while k < width as libc::c_ulong {
+ octet = *(*parser).raw_buffer.pointer.wrapping_offset(k as isize);
+ if octet & 0xC0 != 0x80 {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"invalid trailing UTF-8 octet\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset.force_add(k),
+ octet as libc::c_int,
+ );
+ }
+ value = (value << 6).force_add((octet & 0x3F) as libc::c_uint);
+ k = k.force_add(1);
+ }
+ if !(width == 1
+ || width == 2 && value >= 0x80
+ || width == 3 && value >= 0x800
+ || width == 4 && value >= 0x10000)
+ {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"invalid length of a UTF-8 sequence\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ if value >= 0xD800 && value <= 0xDFFF || value > 0x10FFFF {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"invalid Unicode character\0" as *const u8 as *const libc::c_char,
+ (*parser).offset,
+ value as libc::c_int,
+ );
+ }
+ }
+ }
+ YAML_UTF16LE_ENCODING | YAML_UTF16BE_ENCODING => {
+ low = if (*parser).encoding == YAML_UTF16LE_ENCODING {
+ 0
+ } else {
+ 1
+ };
+ high = if (*parser).encoding == YAML_UTF16LE_ENCODING {
+ 1
+ } else {
+ 0
+ };
+ if raw_unread < 2_u64 {
+ if (*parser).eof {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"incomplete UTF-16 character\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ incomplete = true;
+ } else {
+ value = (*(*parser).raw_buffer.pointer.wrapping_offset(low as isize)
+ as libc::c_int
+ + ((*(*parser).raw_buffer.pointer.wrapping_offset(high as isize)
+ as libc::c_int)
+ << 8)) as libc::c_uint;
+ if value & 0xFC00 == 0xDC00 {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"unexpected low surrogate area\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset,
+ value as libc::c_int,
+ );
+ }
+ if value & 0xFC00 == 0xD800 {
+ width = 4;
+ if raw_unread < 4_u64 {
+ if (*parser).eof {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"incomplete UTF-16 surrogate pair\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ incomplete = true;
+ } else {
+ value2 = (*(*parser)
+ .raw_buffer
+ .pointer
+ .wrapping_offset((low + 2) as isize)
+ as libc::c_int
+ + ((*(*parser)
+ .raw_buffer
+ .pointer
+ .wrapping_offset((high + 2) as isize)
+ as libc::c_int)
+ << 8))
+ as libc::c_uint;
+ if value2 & 0xFC00 != 0xDC00 {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"expected low surrogate area\0" as *const u8
+ as *const libc::c_char,
+ (*parser).offset.force_add(2_u64),
+ value2 as libc::c_int,
+ );
+ }
+ value = 0x10000_u32
+ .force_add((value & 0x3FF) << 10)
+ .force_add(value2 & 0x3FF);
+ }
+ } else {
+ width = 2;
+ }
+ }
+ }
+ _ => {}
+ }
+ if incomplete {
+ break;
+ }
+ if !(value == 0x9
+ || value == 0xA
+ || value == 0xD
+ || value >= 0x20 && value <= 0x7E
+ || value == 0x85
+ || value >= 0xA0 && value <= 0xD7FF
+ || value >= 0xE000 && value <= 0xFFFD
+ || value >= 0x10000 && value <= 0x10FFFF)
+ {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"control characters are not allowed\0" as *const u8 as *const libc::c_char,
+ (*parser).offset,
+ value as libc::c_int,
+ );
+ }
+ let fresh14 = addr_of_mut!((*parser).raw_buffer.pointer);
+ *fresh14 = (*fresh14).wrapping_offset(width as isize);
+ let fresh15 = addr_of_mut!((*parser).offset);
+ *fresh15 = (*fresh15 as libc::c_ulong).force_add(width as libc::c_ulong) as size_t;
+ if value <= 0x7F {
+ let fresh16 = addr_of_mut!((*parser).buffer.last);
+ let fresh17 = *fresh16;
+ *fresh16 = (*fresh16).wrapping_offset(1);
+ *fresh17 = value as yaml_char_t;
+ } else if value <= 0x7FF {
+ let fresh18 = addr_of_mut!((*parser).buffer.last);
+ let fresh19 = *fresh18;
+ *fresh18 = (*fresh18).wrapping_offset(1);
+ *fresh19 = 0xC0_u32.force_add(value >> 6) as yaml_char_t;
+ let fresh20 = addr_of_mut!((*parser).buffer.last);
+ let fresh21 = *fresh20;
+ *fresh20 = (*fresh20).wrapping_offset(1);
+ *fresh21 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ } else if value <= 0xFFFF {
+ let fresh22 = addr_of_mut!((*parser).buffer.last);
+ let fresh23 = *fresh22;
+ *fresh22 = (*fresh22).wrapping_offset(1);
+ *fresh23 = 0xE0_u32.force_add(value >> 12) as yaml_char_t;
+ let fresh24 = addr_of_mut!((*parser).buffer.last);
+ let fresh25 = *fresh24;
+ *fresh24 = (*fresh24).wrapping_offset(1);
+ *fresh25 = 0x80_u32.force_add(value >> 6 & 0x3F) as yaml_char_t;
+ let fresh26 = addr_of_mut!((*parser).buffer.last);
+ let fresh27 = *fresh26;
+ *fresh26 = (*fresh26).wrapping_offset(1);
+ *fresh27 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ } else {
+ let fresh28 = addr_of_mut!((*parser).buffer.last);
+ let fresh29 = *fresh28;
+ *fresh28 = (*fresh28).wrapping_offset(1);
+ *fresh29 = 0xF0_u32.force_add(value >> 18) as yaml_char_t;
+ let fresh30 = addr_of_mut!((*parser).buffer.last);
+ let fresh31 = *fresh30;
+ *fresh30 = (*fresh30).wrapping_offset(1);
+ *fresh31 = 0x80_u32.force_add(value >> 12 & 0x3F) as yaml_char_t;
+ let fresh32 = addr_of_mut!((*parser).buffer.last);
+ let fresh33 = *fresh32;
+ *fresh32 = (*fresh32).wrapping_offset(1);
+ *fresh33 = 0x80_u32.force_add(value >> 6 & 0x3F) as yaml_char_t;
+ let fresh34 = addr_of_mut!((*parser).buffer.last);
+ let fresh35 = *fresh34;
+ *fresh34 = (*fresh34).wrapping_offset(1);
+ *fresh35 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ }
+ let fresh36 = addr_of_mut!((*parser).unread);
+ *fresh36 = (*fresh36).force_add(1);
+ }
+ if (*parser).eof {
+ let fresh37 = addr_of_mut!((*parser).buffer.last);
+ let fresh38 = *fresh37;
+ *fresh37 = (*fresh37).wrapping_offset(1);
+ *fresh38 = b'\0';
+ let fresh39 = addr_of_mut!((*parser).unread);
+ *fresh39 = (*fresh39).force_add(1);
+ return OK;
+ }
+ }
+ if (*parser).offset >= (!0_u64).wrapping_div(2_u64) {
+ return yaml_parser_set_reader_error(
+ parser,
+ b"input is too long\0" as *const u8 as *const libc::c_char,
+ (*parser).offset,
+ -1,
+ );
+ }
+ OK
+}
diff --git a/crates/unsafe-libyaml/src/scanner.rs b/crates/unsafe-libyaml/src/scanner.rs
new file mode 100644
index 0000000..4e53dad
--- /dev/null
+++ b/crates/unsafe-libyaml/src/scanner.rs
@@ -0,0 +1,2660 @@
+use crate::api::{
+ yaml_free, yaml_malloc, yaml_queue_extend, yaml_stack_extend, yaml_string_extend,
+ yaml_string_join,
+};
+use crate::externs::{memcpy, memmove, memset, strcmp, strlen};
+use crate::ops::{ForceAdd as _, ForceMul as _};
+use crate::reader::yaml_parser_update_buffer;
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::{ptrdiff_t, size_t, yaml_char_t, yaml_string_t, NULL_STRING};
+use crate::{
+ libc, yaml_mark_t, yaml_parser_t, yaml_simple_key_t, yaml_token_t, yaml_token_type_t,
+ PointerExt, YAML_ALIAS_TOKEN, YAML_ANCHOR_TOKEN, YAML_BLOCK_END_TOKEN, YAML_BLOCK_ENTRY_TOKEN,
+ YAML_BLOCK_MAPPING_START_TOKEN, YAML_BLOCK_SEQUENCE_START_TOKEN, YAML_DOCUMENT_END_TOKEN,
+ YAML_DOCUMENT_START_TOKEN, YAML_DOUBLE_QUOTED_SCALAR_STYLE, YAML_FLOW_ENTRY_TOKEN,
+ YAML_FLOW_MAPPING_END_TOKEN, YAML_FLOW_MAPPING_START_TOKEN, YAML_FLOW_SEQUENCE_END_TOKEN,
+ YAML_FLOW_SEQUENCE_START_TOKEN, YAML_FOLDED_SCALAR_STYLE, YAML_KEY_TOKEN,
+ YAML_LITERAL_SCALAR_STYLE, YAML_MEMORY_ERROR, YAML_NO_ERROR, YAML_PLAIN_SCALAR_STYLE,
+ YAML_SCALAR_TOKEN, YAML_SCANNER_ERROR, YAML_SINGLE_QUOTED_SCALAR_STYLE, YAML_STREAM_END_TOKEN,
+ YAML_STREAM_START_TOKEN, YAML_TAG_DIRECTIVE_TOKEN, YAML_TAG_TOKEN, YAML_VALUE_TOKEN,
+ YAML_VERSION_DIRECTIVE_TOKEN,
+};
+use core::mem::{size_of, MaybeUninit};
+use core::ptr::{self, addr_of_mut};
+
+unsafe fn CACHE(parser: *mut yaml_parser_t, length: size_t) -> Success {
+ if (*parser).unread >= length {
+ OK
+ } else {
+ yaml_parser_update_buffer(parser, length)
+ }
+}
+
+unsafe fn SKIP(parser: *mut yaml_parser_t) {
+ let width = WIDTH!((*parser).buffer);
+ (*parser).mark.index = (*parser).mark.index.force_add(width as u64);
+ (*parser).mark.column = (*parser).mark.column.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(width as isize);
+}
+
+unsafe fn SKIP_LINE(parser: *mut yaml_parser_t) {
+ if IS_CRLF!((*parser).buffer) {
+ (*parser).mark.index = (*parser).mark.index.force_add(2);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(2);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(2);
+ } else if IS_BREAK!((*parser).buffer) {
+ let width = WIDTH!((*parser).buffer);
+ (*parser).mark.index = (*parser).mark.index.force_add(width as u64);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(width as isize);
+ };
+}
+
+unsafe fn READ(parser: *mut yaml_parser_t, string: *mut yaml_string_t) {
+ STRING_EXTEND!(*string);
+ let width = WIDTH!((*parser).buffer);
+ COPY!(*string, (*parser).buffer);
+ (*parser).mark.index = (*parser).mark.index.force_add(width as u64);
+ (*parser).mark.column = (*parser).mark.column.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+}
+
+unsafe fn READ_LINE(parser: *mut yaml_parser_t, string: *mut yaml_string_t) {
+ STRING_EXTEND!(*string);
+ if CHECK_AT!((*parser).buffer, b'\r', 0) && CHECK_AT!((*parser).buffer, b'\n', 1) {
+ *(*string).pointer = b'\n';
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(2);
+ (*parser).mark.index = (*parser).mark.index.force_add(2);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(2);
+ } else if CHECK_AT!((*parser).buffer, b'\r', 0) || CHECK_AT!((*parser).buffer, b'\n', 0) {
+ *(*string).pointer = b'\n';
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(1);
+ (*parser).mark.index = (*parser).mark.index.force_add(1);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+ } else if CHECK_AT!((*parser).buffer, b'\xC2', 0) && CHECK_AT!((*parser).buffer, b'\x85', 1) {
+ *(*string).pointer = b'\n';
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(2);
+ (*parser).mark.index = (*parser).mark.index.force_add(2);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+ } else if CHECK_AT!((*parser).buffer, b'\xE2', 0)
+ && CHECK_AT!((*parser).buffer, b'\x80', 1)
+ && (CHECK_AT!((*parser).buffer, b'\xA8', 2) || CHECK_AT!((*parser).buffer, b'\xA9', 2))
+ {
+ *(*string).pointer = *(*parser).buffer.pointer;
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(1);
+ *(*string).pointer = *(*parser).buffer.pointer;
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(1);
+ *(*string).pointer = *(*parser).buffer.pointer;
+ (*string).pointer = (*string).pointer.wrapping_offset(1);
+ (*parser).buffer.pointer = (*parser).buffer.pointer.wrapping_offset(1);
+ (*parser).mark.index = (*parser).mark.index.force_add(3);
+ (*parser).mark.column = 0;
+ (*parser).mark.line = (*parser).mark.line.force_add(1);
+ (*parser).unread = (*parser).unread.wrapping_sub(1);
+ };
+}
+
+macro_rules! READ {
+ ($parser:expr, $string:expr) => {
+ READ($parser, addr_of_mut!($string))
+ };
+}
+
+macro_rules! READ_LINE {
+ ($parser:expr, $string:expr) => {
+ READ_LINE($parser, addr_of_mut!($string))
+ };
+}
+
+/// Scan the input stream and produce the next token.
+///
+/// Call the function subsequently to produce a sequence of tokens corresponding
+/// to the input stream. The initial token has the type YAML_STREAM_START_TOKEN
+/// while the ending token has the type YAML_STREAM_END_TOKEN.
+///
+/// An application is responsible for freeing any buffers associated with the
+/// produced token object using the yaml_token_delete function.
+///
+/// An application must not alternate the calls of yaml_parser_scan() with the
+/// calls of yaml_parser_parse() or yaml_parser_load(). Doing this will break
+/// the parser.
+pub unsafe fn yaml_parser_scan(parser: *mut yaml_parser_t, token: *mut yaml_token_t) -> Success {
+ __assert!(!parser.is_null());
+ __assert!(!token.is_null());
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ if (*parser).stream_end_produced || (*parser).error != YAML_NO_ERROR {
+ return OK;
+ }
+ if !(*parser).token_available {
+ if yaml_parser_fetch_more_tokens(parser).fail {
+ return FAIL;
+ }
+ }
+ *token = DEQUEUE!((*parser).tokens);
+ (*parser).token_available = false;
+ let fresh2 = addr_of_mut!((*parser).tokens_parsed);
+ *fresh2 = (*fresh2).force_add(1);
+ if (*token).type_ == YAML_STREAM_END_TOKEN {
+ (*parser).stream_end_produced = true;
+ }
+ OK
+}
+
+unsafe fn yaml_parser_set_scanner_error(
+ parser: *mut yaml_parser_t,
+ context: *const libc::c_char,
+ context_mark: yaml_mark_t,
+ problem: *const libc::c_char,
+) {
+ (*parser).error = YAML_SCANNER_ERROR;
+ let fresh3 = addr_of_mut!((*parser).context);
+ *fresh3 = context;
+ (*parser).context_mark = context_mark;
+ let fresh4 = addr_of_mut!((*parser).problem);
+ *fresh4 = problem;
+ (*parser).problem_mark = (*parser).mark;
+}
+
+pub(crate) unsafe fn yaml_parser_fetch_more_tokens(parser: *mut yaml_parser_t) -> Success {
+ let mut need_more_tokens;
+ loop {
+ need_more_tokens = false;
+ if (*parser).tokens.head == (*parser).tokens.tail {
+ need_more_tokens = true;
+ } else {
+ let mut simple_key: *mut yaml_simple_key_t;
+ if yaml_parser_stale_simple_keys(parser).fail {
+ return FAIL;
+ }
+ simple_key = (*parser).simple_keys.start;
+ while simple_key != (*parser).simple_keys.top {
+ if (*simple_key).possible && (*simple_key).token_number == (*parser).tokens_parsed {
+ need_more_tokens = true;
+ break;
+ } else {
+ simple_key = simple_key.wrapping_offset(1);
+ }
+ }
+ }
+ if !need_more_tokens {
+ break;
+ }
+ if yaml_parser_fetch_next_token(parser).fail {
+ return FAIL;
+ }
+ }
+ (*parser).token_available = true;
+ OK
+}
+
+unsafe fn yaml_parser_fetch_next_token(parser: *mut yaml_parser_t) -> Success {
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ if !(*parser).stream_start_produced {
+ yaml_parser_fetch_stream_start(parser);
+ return OK;
+ }
+ if yaml_parser_scan_to_next_token(parser).fail {
+ return FAIL;
+ }
+ if yaml_parser_stale_simple_keys(parser).fail {
+ return FAIL;
+ }
+ yaml_parser_unroll_indent(parser, (*parser).mark.column as ptrdiff_t);
+ if CACHE(parser, 4_u64).fail {
+ return FAIL;
+ }
+ if IS_Z!((*parser).buffer) {
+ return yaml_parser_fetch_stream_end(parser);
+ }
+ if (*parser).mark.column == 0_u64 && CHECK!((*parser).buffer, b'%') {
+ return yaml_parser_fetch_directive(parser);
+ }
+ if (*parser).mark.column == 0_u64
+ && CHECK_AT!((*parser).buffer, b'-', 0)
+ && CHECK_AT!((*parser).buffer, b'-', 1)
+ && CHECK_AT!((*parser).buffer, b'-', 2)
+ && IS_BLANKZ_AT!((*parser).buffer, 3)
+ {
+ return yaml_parser_fetch_document_indicator(parser, YAML_DOCUMENT_START_TOKEN);
+ }
+ if (*parser).mark.column == 0_u64
+ && CHECK_AT!((*parser).buffer, b'.', 0)
+ && CHECK_AT!((*parser).buffer, b'.', 1)
+ && CHECK_AT!((*parser).buffer, b'.', 2)
+ && IS_BLANKZ_AT!((*parser).buffer, 3)
+ {
+ return yaml_parser_fetch_document_indicator(parser, YAML_DOCUMENT_END_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b'[') {
+ return yaml_parser_fetch_flow_collection_start(parser, YAML_FLOW_SEQUENCE_START_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b'{') {
+ return yaml_parser_fetch_flow_collection_start(parser, YAML_FLOW_MAPPING_START_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b']') {
+ return yaml_parser_fetch_flow_collection_end(parser, YAML_FLOW_SEQUENCE_END_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b'}') {
+ return yaml_parser_fetch_flow_collection_end(parser, YAML_FLOW_MAPPING_END_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b',') {
+ return yaml_parser_fetch_flow_entry(parser);
+ }
+ if CHECK!((*parser).buffer, b'-') && IS_BLANKZ_AT!((*parser).buffer, 1) {
+ return yaml_parser_fetch_block_entry(parser);
+ }
+ if CHECK!((*parser).buffer, b'?')
+ && ((*parser).flow_level != 0 || IS_BLANKZ_AT!((*parser).buffer, 1))
+ {
+ return yaml_parser_fetch_key(parser);
+ }
+ if CHECK!((*parser).buffer, b':')
+ && ((*parser).flow_level != 0 || IS_BLANKZ_AT!((*parser).buffer, 1))
+ {
+ return yaml_parser_fetch_value(parser);
+ }
+ if CHECK!((*parser).buffer, b'*') {
+ return yaml_parser_fetch_anchor(parser, YAML_ALIAS_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b'&') {
+ return yaml_parser_fetch_anchor(parser, YAML_ANCHOR_TOKEN);
+ }
+ if CHECK!((*parser).buffer, b'!') {
+ return yaml_parser_fetch_tag(parser);
+ }
+ if CHECK!((*parser).buffer, b'|') && (*parser).flow_level == 0 {
+ return yaml_parser_fetch_block_scalar(parser, true);
+ }
+ if CHECK!((*parser).buffer, b'>') && (*parser).flow_level == 0 {
+ return yaml_parser_fetch_block_scalar(parser, false);
+ }
+ if CHECK!((*parser).buffer, b'\'') {
+ return yaml_parser_fetch_flow_scalar(parser, true);
+ }
+ if CHECK!((*parser).buffer, b'"') {
+ return yaml_parser_fetch_flow_scalar(parser, false);
+ }
+ if !(IS_BLANKZ!((*parser).buffer)
+ || CHECK!((*parser).buffer, b'-')
+ || CHECK!((*parser).buffer, b'?')
+ || CHECK!((*parser).buffer, b':')
+ || CHECK!((*parser).buffer, b',')
+ || CHECK!((*parser).buffer, b'[')
+ || CHECK!((*parser).buffer, b']')
+ || CHECK!((*parser).buffer, b'{')
+ || CHECK!((*parser).buffer, b'}')
+ || CHECK!((*parser).buffer, b'#')
+ || CHECK!((*parser).buffer, b'&')
+ || CHECK!((*parser).buffer, b'*')
+ || CHECK!((*parser).buffer, b'!')
+ || CHECK!((*parser).buffer, b'|')
+ || CHECK!((*parser).buffer, b'>')
+ || CHECK!((*parser).buffer, b'\'')
+ || CHECK!((*parser).buffer, b'"')
+ || CHECK!((*parser).buffer, b'%')
+ || CHECK!((*parser).buffer, b'@')
+ || CHECK!((*parser).buffer, b'`'))
+ || CHECK!((*parser).buffer, b'-') && !IS_BLANK_AT!((*parser).buffer, 1)
+ || (*parser).flow_level == 0
+ && (CHECK!((*parser).buffer, b'?') || CHECK!((*parser).buffer, b':'))
+ && !IS_BLANKZ_AT!((*parser).buffer, 1)
+ {
+ return yaml_parser_fetch_plain_scalar(parser);
+ }
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning for the next token\0" as *const u8 as *const libc::c_char,
+ (*parser).mark,
+ b"found character that cannot start any token\0" as *const u8 as *const libc::c_char,
+ );
+ FAIL
+}
+
+unsafe fn yaml_parser_stale_simple_keys(parser: *mut yaml_parser_t) -> Success {
+ let mut simple_key: *mut yaml_simple_key_t;
+ simple_key = (*parser).simple_keys.start;
+ while simple_key != (*parser).simple_keys.top {
+ if (*simple_key).possible
+ && ((*simple_key).mark.line < (*parser).mark.line
+ || (*simple_key).mark.index.force_add(1024_u64) < (*parser).mark.index)
+ {
+ if (*simple_key).required {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a simple key\0" as *const u8 as *const libc::c_char,
+ (*simple_key).mark,
+ b"could not find expected ':'\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ (*simple_key).possible = false;
+ }
+ simple_key = simple_key.wrapping_offset(1);
+ }
+ OK
+}
+
+unsafe fn yaml_parser_save_simple_key(parser: *mut yaml_parser_t) -> Success {
+ let required = (*parser).flow_level == 0
+ && (*parser).indent as libc::c_long == (*parser).mark.column as ptrdiff_t;
+ if (*parser).simple_key_allowed {
+ let simple_key = yaml_simple_key_t {
+ possible: true,
+ required,
+ token_number: (*parser).tokens_parsed.force_add(
+ (*parser).tokens.tail.c_offset_from((*parser).tokens.head) as libc::c_ulong,
+ ),
+ mark: (*parser).mark,
+ };
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ *(*parser).simple_keys.top.wrapping_offset(-1_isize) = simple_key;
+ }
+ OK
+}
+
+unsafe fn yaml_parser_remove_simple_key(parser: *mut yaml_parser_t) -> Success {
+ let simple_key: *mut yaml_simple_key_t = (*parser).simple_keys.top.wrapping_offset(-1_isize);
+ if (*simple_key).possible {
+ if (*simple_key).required {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a simple key\0" as *const u8 as *const libc::c_char,
+ (*simple_key).mark,
+ b"could not find expected ':'\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ }
+ (*simple_key).possible = false;
+ OK
+}
+
+unsafe fn yaml_parser_increase_flow_level(parser: *mut yaml_parser_t) -> Success {
+ let empty_simple_key = yaml_simple_key_t {
+ possible: false,
+ required: false,
+ token_number: 0_u64,
+ mark: yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ },
+ };
+ PUSH!((*parser).simple_keys, empty_simple_key);
+ if (*parser).flow_level == libc::c_int::MAX {
+ (*parser).error = YAML_MEMORY_ERROR;
+ return FAIL;
+ }
+ let fresh7 = addr_of_mut!((*parser).flow_level);
+ *fresh7 += 1;
+ OK
+}
+
+unsafe fn yaml_parser_decrease_flow_level(parser: *mut yaml_parser_t) {
+ if (*parser).flow_level != 0 {
+ let fresh8 = addr_of_mut!((*parser).flow_level);
+ *fresh8 -= 1;
+ let _ = POP!((*parser).simple_keys);
+ }
+}
+
+unsafe fn yaml_parser_roll_indent(
+ parser: *mut yaml_parser_t,
+ column: ptrdiff_t,
+ number: ptrdiff_t,
+ type_: yaml_token_type_t,
+ mark: yaml_mark_t,
+) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if (*parser).flow_level != 0 {
+ return OK;
+ }
+ if ((*parser).indent as libc::c_long) < column {
+ PUSH!((*parser).indents, (*parser).indent);
+ if column > ptrdiff_t::from(libc::c_int::MAX) {
+ (*parser).error = YAML_MEMORY_ERROR;
+ return FAIL;
+ }
+ (*parser).indent = column as libc::c_int;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = type_;
+ (*token).start_mark = mark;
+ (*token).end_mark = mark;
+ if number == -1_i64 {
+ ENQUEUE!((*parser).tokens, *token);
+ } else {
+ QUEUE_INSERT!(
+ (*parser).tokens,
+ (number as libc::c_ulong).wrapping_sub((*parser).tokens_parsed),
+ *token
+ );
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_parser_unroll_indent(parser: *mut yaml_parser_t, column: ptrdiff_t) {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if (*parser).flow_level != 0 {
+ return;
+ }
+ while (*parser).indent as libc::c_long > column {
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_BLOCK_END_TOKEN;
+ (*token).start_mark = (*parser).mark;
+ (*token).end_mark = (*parser).mark;
+ ENQUEUE!((*parser).tokens, *token);
+ (*parser).indent = POP!((*parser).indents);
+ }
+}
+
+unsafe fn yaml_parser_fetch_stream_start(parser: *mut yaml_parser_t) {
+ let simple_key = yaml_simple_key_t {
+ possible: false,
+ required: false,
+ token_number: 0_u64,
+ mark: yaml_mark_t {
+ index: 0_u64,
+ line: 0_u64,
+ column: 0_u64,
+ },
+ };
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ (*parser).indent = -1;
+ PUSH!((*parser).simple_keys, simple_key);
+ (*parser).simple_key_allowed = true;
+ (*parser).stream_start_produced = true;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_STREAM_START_TOKEN;
+ (*token).start_mark = (*parser).mark;
+ (*token).end_mark = (*parser).mark;
+ (*token).data.stream_start.encoding = (*parser).encoding;
+ ENQUEUE!((*parser).tokens, *token);
+}
+
+unsafe fn yaml_parser_fetch_stream_end(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if (*parser).mark.column != 0_u64 {
+ (*parser).mark.column = 0_u64;
+ let fresh22 = addr_of_mut!((*parser).mark.line);
+ *fresh22 = (*fresh22).force_add(1);
+ }
+ yaml_parser_unroll_indent(parser, -1_i64);
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_STREAM_END_TOKEN;
+ (*token).start_mark = (*parser).mark;
+ (*token).end_mark = (*parser).mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_directive(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ yaml_parser_unroll_indent(parser, -1_i64);
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ if yaml_parser_scan_directive(parser, token).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_document_indicator(
+ parser: *mut yaml_parser_t,
+ type_: yaml_token_type_t,
+) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ yaml_parser_unroll_indent(parser, -1_i64);
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ SKIP(parser);
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = type_;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_flow_collection_start(
+ parser: *mut yaml_parser_t,
+ type_: yaml_token_type_t,
+) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_save_simple_key(parser).fail {
+ return FAIL;
+ }
+ if yaml_parser_increase_flow_level(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = true;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = type_;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_flow_collection_end(
+ parser: *mut yaml_parser_t,
+ type_: yaml_token_type_t,
+) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ yaml_parser_decrease_flow_level(parser);
+ (*parser).simple_key_allowed = false;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = type_;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_flow_entry(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = true;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_FLOW_ENTRY_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_block_entry(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if (*parser).flow_level == 0 {
+ if !(*parser).simple_key_allowed {
+ yaml_parser_set_scanner_error(
+ parser,
+ ptr::null::<libc::c_char>(),
+ (*parser).mark,
+ b"block sequence entries are not allowed in this context\0" as *const u8
+ as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ if yaml_parser_roll_indent(
+ parser,
+ (*parser).mark.column as ptrdiff_t,
+ -1_i64,
+ YAML_BLOCK_SEQUENCE_START_TOKEN,
+ (*parser).mark,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = true;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_BLOCK_ENTRY_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_key(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if (*parser).flow_level == 0 {
+ if !(*parser).simple_key_allowed {
+ yaml_parser_set_scanner_error(
+ parser,
+ ptr::null::<libc::c_char>(),
+ (*parser).mark,
+ b"mapping keys are not allowed in this context\0" as *const u8
+ as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ if yaml_parser_roll_indent(
+ parser,
+ (*parser).mark.column as ptrdiff_t,
+ -1_i64,
+ YAML_BLOCK_MAPPING_START_TOKEN,
+ (*parser).mark,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = (*parser).flow_level == 0;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_KEY_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_value(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ let simple_key: *mut yaml_simple_key_t = (*parser).simple_keys.top.wrapping_offset(-1_isize);
+ if (*simple_key).possible {
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_KEY_TOKEN;
+ (*token).start_mark = (*simple_key).mark;
+ (*token).end_mark = (*simple_key).mark;
+ QUEUE_INSERT!(
+ (*parser).tokens,
+ ((*simple_key).token_number).wrapping_sub((*parser).tokens_parsed),
+ *token
+ );
+ if yaml_parser_roll_indent(
+ parser,
+ (*simple_key).mark.column as ptrdiff_t,
+ (*simple_key).token_number as ptrdiff_t,
+ YAML_BLOCK_MAPPING_START_TOKEN,
+ (*simple_key).mark,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ (*simple_key).possible = false;
+ (*parser).simple_key_allowed = false;
+ } else {
+ if (*parser).flow_level == 0 {
+ if !(*parser).simple_key_allowed {
+ yaml_parser_set_scanner_error(
+ parser,
+ ptr::null::<libc::c_char>(),
+ (*parser).mark,
+ b"mapping values are not allowed in this context\0" as *const u8
+ as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ if yaml_parser_roll_indent(
+ parser,
+ (*parser).mark.column as ptrdiff_t,
+ -1_i64,
+ YAML_BLOCK_MAPPING_START_TOKEN,
+ (*parser).mark,
+ )
+ .fail
+ {
+ return FAIL;
+ }
+ }
+ (*parser).simple_key_allowed = (*parser).flow_level == 0;
+ }
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ let end_mark: yaml_mark_t = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_VALUE_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_anchor(
+ parser: *mut yaml_parser_t,
+ type_: yaml_token_type_t,
+) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_save_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ if yaml_parser_scan_anchor(parser, token, type_).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_tag(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_save_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ if yaml_parser_scan_tag(parser, token).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_block_scalar(parser: *mut yaml_parser_t, literal: bool) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_remove_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = true;
+ if yaml_parser_scan_block_scalar(parser, token, literal).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_flow_scalar(parser: *mut yaml_parser_t, single: bool) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_save_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ if yaml_parser_scan_flow_scalar(parser, token, single).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_fetch_plain_scalar(parser: *mut yaml_parser_t) -> Success {
+ let mut token = MaybeUninit::<yaml_token_t>::uninit();
+ let token = token.as_mut_ptr();
+ if yaml_parser_save_simple_key(parser).fail {
+ return FAIL;
+ }
+ (*parser).simple_key_allowed = false;
+ if yaml_parser_scan_plain_scalar(parser, token).fail {
+ return FAIL;
+ }
+ ENQUEUE!((*parser).tokens, *token);
+ OK
+}
+
+unsafe fn yaml_parser_scan_to_next_token(parser: *mut yaml_parser_t) -> Success {
+ loop {
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ if (*parser).mark.column == 0_u64 && IS_BOM!((*parser).buffer) {
+ SKIP(parser);
+ }
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ while CHECK!((*parser).buffer, b' ')
+ || ((*parser).flow_level != 0 || !(*parser).simple_key_allowed)
+ && CHECK!((*parser).buffer, b'\t')
+ {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ }
+ if CHECK!((*parser).buffer, b'#') {
+ while !IS_BREAKZ!((*parser).buffer) {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ }
+ }
+ if !IS_BREAK!((*parser).buffer) {
+ break;
+ }
+ if CACHE(parser, 2_u64).fail {
+ return FAIL;
+ }
+ SKIP_LINE(parser);
+ if (*parser).flow_level == 0 {
+ (*parser).simple_key_allowed = true;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_parser_scan_directive(
+ parser: *mut yaml_parser_t,
+ token: *mut yaml_token_t,
+) -> Success {
+ let mut current_block: u64;
+ let end_mark: yaml_mark_t;
+ let mut name: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut major: libc::c_int = 0;
+ let mut minor: libc::c_int = 0;
+ let mut handle: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut prefix: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ if yaml_parser_scan_directive_name(parser, start_mark, addr_of_mut!(name)).ok {
+ if strcmp(
+ name as *mut libc::c_char,
+ b"YAML\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ if yaml_parser_scan_version_directive_value(
+ parser,
+ start_mark,
+ addr_of_mut!(major),
+ addr_of_mut!(minor),
+ )
+ .fail
+ {
+ current_block = 11397968426844348457;
+ } else {
+ end_mark = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_VERSION_DIRECTIVE_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ (*token).data.version_directive.major = major;
+ (*token).data.version_directive.minor = minor;
+ current_block = 17407779659766490442;
+ }
+ } else if strcmp(
+ name as *mut libc::c_char,
+ b"TAG\0" as *const u8 as *const libc::c_char,
+ ) == 0
+ {
+ if yaml_parser_scan_tag_directive_value(
+ parser,
+ start_mark,
+ addr_of_mut!(handle),
+ addr_of_mut!(prefix),
+ )
+ .fail
+ {
+ current_block = 11397968426844348457;
+ } else {
+ end_mark = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_TAG_DIRECTIVE_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh112 = addr_of_mut!((*token).data.tag_directive.handle);
+ *fresh112 = handle;
+ let fresh113 = addr_of_mut!((*token).data.tag_directive.prefix);
+ *fresh113 = prefix;
+ current_block = 17407779659766490442;
+ }
+ } else {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found unknown directive name\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 11397968426844348457;
+ }
+ if current_block != 11397968426844348457 {
+ if CACHE(parser, 1_u64).ok {
+ loop {
+ if !IS_BLANK!((*parser).buffer) {
+ current_block = 11584701595673473500;
+ break;
+ }
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 11397968426844348457;
+ break;
+ }
+ }
+ if current_block != 11397968426844348457 {
+ if CHECK!((*parser).buffer, b'#') {
+ loop {
+ if IS_BREAKZ!((*parser).buffer) {
+ current_block = 6669252993407410313;
+ break;
+ }
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 11397968426844348457;
+ break;
+ }
+ }
+ } else {
+ current_block = 6669252993407410313;
+ }
+ if current_block != 11397968426844348457 {
+ if !IS_BREAKZ!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find expected comment or line break\0" as *const u8
+ as *const libc::c_char,
+ );
+ } else {
+ if IS_BREAK!((*parser).buffer) {
+ if CACHE(parser, 2_u64).fail {
+ current_block = 11397968426844348457;
+ } else {
+ SKIP_LINE(parser);
+ current_block = 652864300344834934;
+ }
+ } else {
+ current_block = 652864300344834934;
+ }
+ if current_block != 11397968426844348457 {
+ yaml_free(name as *mut libc::c_void);
+ return OK;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ yaml_free(prefix as *mut libc::c_void);
+ yaml_free(handle as *mut libc::c_void);
+ yaml_free(name as *mut libc::c_void);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_directive_name(
+ parser: *mut yaml_parser_t,
+ start_mark: yaml_mark_t,
+ name: *mut *mut yaml_char_t,
+) -> Success {
+ let current_block: u64;
+ let mut string = NULL_STRING;
+ STRING_INIT!(string);
+ if CACHE(parser, 1_u64).ok {
+ loop {
+ if !IS_ALPHA!((*parser).buffer) {
+ current_block = 10879442775620481940;
+ break;
+ }
+ READ!(parser, string);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 8318012024179131575;
+ break;
+ }
+ }
+ if current_block != 8318012024179131575 {
+ if string.start == string.pointer {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"could not find expected directive name\0" as *const u8 as *const libc::c_char,
+ );
+ } else if !IS_BLANKZ!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found unexpected non-alphabetical character\0" as *const u8
+ as *const libc::c_char,
+ );
+ } else {
+ *name = string.start;
+ return OK;
+ }
+ }
+ }
+ STRING_DEL!(string);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_version_directive_value(
+ parser: *mut yaml_parser_t,
+ start_mark: yaml_mark_t,
+ major: *mut libc::c_int,
+ minor: *mut libc::c_int,
+) -> Success {
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ while IS_BLANK!((*parser).buffer) {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ }
+ if yaml_parser_scan_version_directive_number(parser, start_mark, major).fail {
+ return FAIL;
+ }
+ if !CHECK!((*parser).buffer, b'.') {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a %YAML directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find expected digit or '.' character\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ SKIP(parser);
+ yaml_parser_scan_version_directive_number(parser, start_mark, minor)
+}
+
+const MAX_NUMBER_LENGTH: u64 = 9_u64;
+
+unsafe fn yaml_parser_scan_version_directive_number(
+ parser: *mut yaml_parser_t,
+ start_mark: yaml_mark_t,
+ number: *mut libc::c_int,
+) -> Success {
+ let mut value: libc::c_int = 0;
+ let mut length: size_t = 0_u64;
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ while IS_DIGIT!((*parser).buffer) {
+ length = length.force_add(1);
+ if length > MAX_NUMBER_LENGTH {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a %YAML directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found extremely long version number\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ value = value.force_mul(10).force_add(AS_DIGIT!((*parser).buffer));
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ }
+ if length == 0 {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a %YAML directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find expected version number\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ *number = value;
+ OK
+}
+
+unsafe fn yaml_parser_scan_tag_directive_value(
+ parser: *mut yaml_parser_t,
+ start_mark: yaml_mark_t,
+ handle: *mut *mut yaml_char_t,
+ prefix: *mut *mut yaml_char_t,
+) -> Success {
+ let mut current_block: u64;
+ let mut handle_value: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut prefix_value: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5231181710497607163;
+ } else {
+ current_block = 14916268686031723178;
+ }
+ 'c_34337: loop {
+ match current_block {
+ 5231181710497607163 => {
+ yaml_free(handle_value as *mut libc::c_void);
+ yaml_free(prefix_value as *mut libc::c_void);
+ return FAIL;
+ }
+ _ => {
+ if IS_BLANK!((*parser).buffer) {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5231181710497607163;
+ } else {
+ current_block = 14916268686031723178;
+ }
+ } else {
+ if yaml_parser_scan_tag_handle(
+ parser,
+ true,
+ start_mark,
+ addr_of_mut!(handle_value),
+ )
+ .fail
+ {
+ current_block = 5231181710497607163;
+ continue;
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5231181710497607163;
+ continue;
+ }
+ if !IS_BLANK!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a %TAG directive\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"did not find expected whitespace\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 5231181710497607163;
+ } else {
+ while IS_BLANK!((*parser).buffer) {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5231181710497607163;
+ continue 'c_34337;
+ }
+ }
+ if yaml_parser_scan_tag_uri(
+ parser,
+ true,
+ true,
+ ptr::null_mut::<yaml_char_t>(),
+ start_mark,
+ addr_of_mut!(prefix_value),
+ )
+ .fail
+ {
+ current_block = 5231181710497607163;
+ continue;
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5231181710497607163;
+ continue;
+ }
+ if !IS_BLANKZ!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a %TAG directive\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"did not find expected whitespace or line break\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 5231181710497607163;
+ } else {
+ *handle = handle_value;
+ *prefix = prefix_value;
+ return OK;
+ }
+ }
+ }
+ }
+ }
+ }
+}
+
+unsafe fn yaml_parser_scan_anchor(
+ parser: *mut yaml_parser_t,
+ token: *mut yaml_token_t,
+ type_: yaml_token_type_t,
+) -> Success {
+ let current_block: u64;
+ let mut length: libc::c_int = 0;
+ let end_mark: yaml_mark_t;
+ let mut string = NULL_STRING;
+ STRING_INIT!(string);
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ if CACHE(parser, 1_u64).ok {
+ loop {
+ if !IS_ALPHA!((*parser).buffer) {
+ current_block = 2868539653012386629;
+ break;
+ }
+ READ!(parser, string);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 5883759901342942623;
+ break;
+ }
+ length += 1;
+ }
+ if current_block != 5883759901342942623 {
+ end_mark = (*parser).mark;
+ if length == 0
+ || !(IS_BLANKZ!((*parser).buffer)
+ || CHECK!((*parser).buffer, b'?')
+ || CHECK!((*parser).buffer, b':')
+ || CHECK!((*parser).buffer, b',')
+ || CHECK!((*parser).buffer, b']')
+ || CHECK!((*parser).buffer, b'}')
+ || CHECK!((*parser).buffer, b'%')
+ || CHECK!((*parser).buffer, b'@')
+ || CHECK!((*parser).buffer, b'`'))
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ if type_ == YAML_ANCHOR_TOKEN {
+ b"while scanning an anchor\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while scanning an alias\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"did not find expected alphabetic or numeric character\0" as *const u8
+ as *const libc::c_char,
+ );
+ } else {
+ if type_ == YAML_ANCHOR_TOKEN {
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_ANCHOR_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh220 = addr_of_mut!((*token).data.anchor.value);
+ *fresh220 = string.start;
+ } else {
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_ALIAS_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh221 = addr_of_mut!((*token).data.alias.value);
+ *fresh221 = string.start;
+ }
+ return OK;
+ }
+ }
+ }
+ STRING_DEL!(string);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_tag(parser: *mut yaml_parser_t, token: *mut yaml_token_t) -> Success {
+ let mut current_block: u64;
+ let mut handle: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let mut suffix: *mut yaml_char_t = ptr::null_mut::<yaml_char_t>();
+ let end_mark: yaml_mark_t;
+ let start_mark: yaml_mark_t = (*parser).mark;
+ if CACHE(parser, 2_u64).ok {
+ if CHECK_AT!((*parser).buffer, b'<', 1) {
+ handle = yaml_malloc(1_u64) as *mut yaml_char_t;
+ *handle = b'\0';
+ SKIP(parser);
+ SKIP(parser);
+ if yaml_parser_scan_tag_uri(
+ parser,
+ true,
+ false,
+ ptr::null_mut::<yaml_char_t>(),
+ start_mark,
+ addr_of_mut!(suffix),
+ )
+ .fail
+ {
+ current_block = 17708497480799081542;
+ } else if !CHECK!((*parser).buffer, b'>') {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a tag\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find the expected '>'\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 17708497480799081542;
+ } else {
+ SKIP(parser);
+ current_block = 4488286894823169796;
+ }
+ } else if yaml_parser_scan_tag_handle(parser, false, start_mark, addr_of_mut!(handle)).fail
+ {
+ current_block = 17708497480799081542;
+ } else if *handle == b'!'
+ && *handle.wrapping_offset(1_isize) != b'\0'
+ && *handle
+ .wrapping_offset(strlen(handle as *mut libc::c_char).wrapping_sub(1_u64) as isize)
+ == b'!'
+ {
+ if yaml_parser_scan_tag_uri(
+ parser,
+ false,
+ false,
+ ptr::null_mut::<yaml_char_t>(),
+ start_mark,
+ addr_of_mut!(suffix),
+ )
+ .fail
+ {
+ current_block = 17708497480799081542;
+ } else {
+ current_block = 4488286894823169796;
+ }
+ } else if yaml_parser_scan_tag_uri(
+ parser,
+ false,
+ false,
+ handle,
+ start_mark,
+ addr_of_mut!(suffix),
+ )
+ .fail
+ {
+ current_block = 17708497480799081542;
+ } else {
+ yaml_free(handle as *mut libc::c_void);
+ handle = yaml_malloc(2_u64) as *mut yaml_char_t;
+ *handle = b'!';
+ *handle.wrapping_offset(1_isize) = b'\0';
+ if *suffix == b'\0' {
+ let tmp: *mut yaml_char_t = handle;
+ handle = suffix;
+ suffix = tmp;
+ }
+ current_block = 4488286894823169796;
+ }
+ if current_block != 17708497480799081542 {
+ if CACHE(parser, 1_u64).ok {
+ if !IS_BLANKZ!((*parser).buffer) {
+ if (*parser).flow_level == 0 || !CHECK!((*parser).buffer, b',') {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a tag\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find expected whitespace or line break\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 17708497480799081542;
+ } else {
+ current_block = 7333393191927787629;
+ }
+ } else {
+ current_block = 7333393191927787629;
+ }
+ if current_block != 17708497480799081542 {
+ end_mark = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_TAG_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh234 = addr_of_mut!((*token).data.tag.handle);
+ *fresh234 = handle;
+ let fresh235 = addr_of_mut!((*token).data.tag.suffix);
+ *fresh235 = suffix;
+ return OK;
+ }
+ }
+ }
+ }
+ yaml_free(handle as *mut libc::c_void);
+ yaml_free(suffix as *mut libc::c_void);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_tag_handle(
+ parser: *mut yaml_parser_t,
+ directive: bool,
+ start_mark: yaml_mark_t,
+ handle: *mut *mut yaml_char_t,
+) -> Success {
+ let mut current_block: u64;
+ let mut string = NULL_STRING;
+ STRING_INIT!(string);
+ if CACHE(parser, 1_u64).ok {
+ if !CHECK!((*parser).buffer, b'!') {
+ yaml_parser_set_scanner_error(
+ parser,
+ if directive {
+ b"while scanning a tag directive\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while scanning a tag\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"did not find expected '!'\0" as *const u8 as *const libc::c_char,
+ );
+ } else {
+ READ!(parser, string);
+ if CACHE(parser, 1_u64).ok {
+ loop {
+ if !IS_ALPHA!((*parser).buffer) {
+ current_block = 7651349459974463963;
+ break;
+ }
+ READ!(parser, string);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 1771849829115608806;
+ break;
+ }
+ }
+ if current_block != 1771849829115608806 {
+ if CHECK!((*parser).buffer, b'!') {
+ READ!(parser, string);
+ current_block = 5689001924483802034;
+ } else if directive
+ && !(*string.start == b'!'
+ && *string.start.wrapping_offset(1_isize) == b'\0')
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while parsing a tag directive\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"did not find expected '!'\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 1771849829115608806;
+ } else {
+ current_block = 5689001924483802034;
+ }
+ if current_block != 1771849829115608806 {
+ *handle = string.start;
+ return OK;
+ }
+ }
+ }
+ }
+ }
+ STRING_DEL!(string);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_tag_uri(
+ parser: *mut yaml_parser_t,
+ uri_char: bool,
+ directive: bool,
+ head: *mut yaml_char_t,
+ start_mark: yaml_mark_t,
+ uri: *mut *mut yaml_char_t,
+) -> Success {
+ let mut current_block: u64;
+ let mut length: size_t = if !head.is_null() {
+ strlen(head as *mut libc::c_char)
+ } else {
+ 0_u64
+ };
+ let mut string = NULL_STRING;
+ STRING_INIT!(string);
+ current_block = 14916268686031723178;
+ 'c_21953: loop {
+ match current_block {
+ 15265153392498847348 => {
+ STRING_DEL!(string);
+ return FAIL;
+ }
+ _ => {
+ if string.end.c_offset_from(string.start) as size_t <= length {
+ yaml_string_extend(
+ addr_of_mut!(string.start),
+ addr_of_mut!(string.pointer),
+ addr_of_mut!(string.end),
+ );
+ current_block = 14916268686031723178;
+ continue;
+ } else {
+ if length > 1_u64 {
+ memcpy(
+ string.start as *mut libc::c_void,
+ head.wrapping_offset(1_isize) as *const libc::c_void,
+ length.wrapping_sub(1_u64),
+ );
+ string.pointer = string
+ .pointer
+ .wrapping_offset(length.wrapping_sub(1_u64) as isize);
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 15265153392498847348;
+ continue;
+ }
+ while IS_ALPHA!((*parser).buffer)
+ || CHECK!((*parser).buffer, b';')
+ || CHECK!((*parser).buffer, b'/')
+ || CHECK!((*parser).buffer, b'?')
+ || CHECK!((*parser).buffer, b':')
+ || CHECK!((*parser).buffer, b'@')
+ || CHECK!((*parser).buffer, b'&')
+ || CHECK!((*parser).buffer, b'=')
+ || CHECK!((*parser).buffer, b'+')
+ || CHECK!((*parser).buffer, b'$')
+ || CHECK!((*parser).buffer, b'.')
+ || CHECK!((*parser).buffer, b'%')
+ || CHECK!((*parser).buffer, b'!')
+ || CHECK!((*parser).buffer, b'~')
+ || CHECK!((*parser).buffer, b'*')
+ || CHECK!((*parser).buffer, b'\'')
+ || CHECK!((*parser).buffer, b'(')
+ || CHECK!((*parser).buffer, b')')
+ || uri_char
+ && (CHECK!((*parser).buffer, b',')
+ || CHECK!((*parser).buffer, b'[')
+ || CHECK!((*parser).buffer, b']'))
+ {
+ if CHECK!((*parser).buffer, b'%') {
+ STRING_EXTEND!(string);
+ if yaml_parser_scan_uri_escapes(
+ parser,
+ directive,
+ start_mark,
+ addr_of_mut!(string),
+ )
+ .fail
+ {
+ current_block = 15265153392498847348;
+ continue 'c_21953;
+ }
+ } else {
+ READ!(parser, string);
+ }
+ length = length.force_add(1);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 15265153392498847348;
+ continue 'c_21953;
+ }
+ }
+ if length == 0 {
+ STRING_EXTEND!(string);
+ yaml_parser_set_scanner_error(
+ parser,
+ if directive {
+ b"while parsing a %TAG directive\0" as *const u8
+ as *const libc::c_char
+ } else {
+ b"while parsing a tag\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"did not find expected tag URI\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 15265153392498847348;
+ } else {
+ *uri = string.start;
+ return OK;
+ }
+ }
+ }
+ }
+ }
+}
+
+unsafe fn yaml_parser_scan_uri_escapes(
+ parser: *mut yaml_parser_t,
+ directive: bool,
+ start_mark: yaml_mark_t,
+ string: *mut yaml_string_t,
+) -> Success {
+ let mut width: libc::c_int = 0;
+ loop {
+ if CACHE(parser, 3_u64).fail {
+ return FAIL;
+ }
+ if !(CHECK!((*parser).buffer, b'%')
+ && IS_HEX_AT!((*parser).buffer, 1)
+ && IS_HEX_AT!((*parser).buffer, 2))
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ if directive {
+ b"while parsing a %TAG directive\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while parsing a tag\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"did not find URI escaped octet\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ let octet: libc::c_uchar = ((AS_HEX_AT!((*parser).buffer, 1) << 4)
+ + AS_HEX_AT!((*parser).buffer, 2)) as libc::c_uchar;
+ if width == 0 {
+ width = if octet & 0x80 == 0 {
+ 1
+ } else if octet & 0xE0 == 0xC0 {
+ 2
+ } else if octet & 0xF0 == 0xE0 {
+ 3
+ } else if octet & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ };
+ if width == 0 {
+ yaml_parser_set_scanner_error(
+ parser,
+ if directive {
+ b"while parsing a %TAG directive\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while parsing a tag\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"found an incorrect leading UTF-8 octet\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ } else if octet & 0xC0 != 0x80 {
+ yaml_parser_set_scanner_error(
+ parser,
+ if directive {
+ b"while parsing a %TAG directive\0" as *const u8 as *const libc::c_char
+ } else {
+ b"while parsing a tag\0" as *const u8 as *const libc::c_char
+ },
+ start_mark,
+ b"found an incorrect trailing UTF-8 octet\0" as *const u8 as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ let fresh368 = addr_of_mut!((*string).pointer);
+ let fresh369 = *fresh368;
+ *fresh368 = (*fresh368).wrapping_offset(1);
+ *fresh369 = octet;
+ SKIP(parser);
+ SKIP(parser);
+ SKIP(parser);
+ width -= 1;
+ if !(width != 0) {
+ break;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_parser_scan_block_scalar(
+ parser: *mut yaml_parser_t,
+ token: *mut yaml_token_t,
+ literal: bool,
+) -> Success {
+ let mut current_block: u64;
+ let mut end_mark: yaml_mark_t;
+ let mut string = NULL_STRING;
+ let mut leading_break = NULL_STRING;
+ let mut trailing_breaks = NULL_STRING;
+ let mut chomping: libc::c_int = 0;
+ let mut increment: libc::c_int = 0;
+ let mut indent: libc::c_int = 0;
+ let mut leading_blank: libc::c_int = 0;
+ let mut trailing_blank: libc::c_int;
+ STRING_INIT!(string);
+ STRING_INIT!(leading_break);
+ STRING_INIT!(trailing_breaks);
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ if CACHE(parser, 1_u64).ok {
+ if CHECK!((*parser).buffer, b'+') || CHECK!((*parser).buffer, b'-') {
+ chomping = if CHECK!((*parser).buffer, b'+') {
+ 1
+ } else {
+ -1
+ };
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 14984465786483313892;
+ } else if IS_DIGIT!((*parser).buffer) {
+ if CHECK!((*parser).buffer, b'0') {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a block scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found an indentation indicator equal to 0\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 14984465786483313892;
+ } else {
+ increment = AS_DIGIT!((*parser).buffer);
+ SKIP(parser);
+ current_block = 11913429853522160501;
+ }
+ } else {
+ current_block = 11913429853522160501;
+ }
+ } else if IS_DIGIT!((*parser).buffer) {
+ if CHECK!((*parser).buffer, b'0') {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a block scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found an indentation indicator equal to 0\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 14984465786483313892;
+ } else {
+ increment = AS_DIGIT!((*parser).buffer);
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 14984465786483313892;
+ } else {
+ if CHECK!((*parser).buffer, b'+') || CHECK!((*parser).buffer, b'-') {
+ chomping = if CHECK!((*parser).buffer, b'+') {
+ 1
+ } else {
+ -1
+ };
+ SKIP(parser);
+ }
+ current_block = 11913429853522160501;
+ }
+ }
+ } else {
+ current_block = 11913429853522160501;
+ }
+ if current_block != 14984465786483313892 {
+ if CACHE(parser, 1_u64).ok {
+ loop {
+ if !IS_BLANK!((*parser).buffer) {
+ current_block = 4090602189656566074;
+ break;
+ }
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 14984465786483313892;
+ break;
+ }
+ }
+ if current_block != 14984465786483313892 {
+ if CHECK!((*parser).buffer, b'#') {
+ loop {
+ if IS_BREAKZ!((*parser).buffer) {
+ current_block = 12997042908615822766;
+ break;
+ }
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 14984465786483313892;
+ break;
+ }
+ }
+ } else {
+ current_block = 12997042908615822766;
+ }
+ if current_block != 14984465786483313892 {
+ if !IS_BREAKZ!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a block scalar\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"did not find expected comment or line break\0" as *const u8
+ as *const libc::c_char,
+ );
+ } else {
+ if IS_BREAK!((*parser).buffer) {
+ if CACHE(parser, 2_u64).fail {
+ current_block = 14984465786483313892;
+ } else {
+ SKIP_LINE(parser);
+ current_block = 13619784596304402172;
+ }
+ } else {
+ current_block = 13619784596304402172;
+ }
+ if current_block != 14984465786483313892 {
+ end_mark = (*parser).mark;
+ if increment != 0 {
+ indent = if (*parser).indent >= 0 {
+ (*parser).indent + increment
+ } else {
+ increment
+ };
+ }
+ if yaml_parser_scan_block_scalar_breaks(
+ parser,
+ addr_of_mut!(indent),
+ addr_of_mut!(trailing_breaks),
+ start_mark,
+ addr_of_mut!(end_mark),
+ )
+ .ok
+ {
+ if CACHE(parser, 1_u64).ok {
+ 's_281: loop {
+ if !((*parser).mark.column as libc::c_int == indent
+ && !IS_Z!((*parser).buffer))
+ {
+ current_block = 5793491756164225964;
+ break;
+ }
+ trailing_blank =
+ IS_BLANK!((*parser).buffer) as libc::c_int;
+ if !literal
+ && *leading_break.start == b'\n'
+ && leading_blank == 0
+ && trailing_blank == 0
+ {
+ if *trailing_breaks.start == b'\0' {
+ STRING_EXTEND!(string);
+ let fresh418 = string.pointer;
+ string.pointer =
+ string.pointer.wrapping_offset(1);
+ *fresh418 = b' ';
+ }
+ CLEAR!(leading_break);
+ } else {
+ JOIN!(string, leading_break);
+ CLEAR!(leading_break);
+ }
+ JOIN!(string, trailing_breaks);
+ CLEAR!(trailing_breaks);
+ leading_blank =
+ IS_BLANK!((*parser).buffer) as libc::c_int;
+ while !IS_BREAKZ!((*parser).buffer) {
+ READ!(parser, string);
+ if CACHE(parser, 1_u64).fail {
+ current_block = 14984465786483313892;
+ break 's_281;
+ }
+ }
+ if CACHE(parser, 2_u64).fail {
+ current_block = 14984465786483313892;
+ break;
+ }
+ READ_LINE!(parser, leading_break);
+ if yaml_parser_scan_block_scalar_breaks(
+ parser,
+ addr_of_mut!(indent),
+ addr_of_mut!(trailing_breaks),
+ start_mark,
+ addr_of_mut!(end_mark),
+ )
+ .fail
+ {
+ current_block = 14984465786483313892;
+ break;
+ }
+ }
+ if current_block != 14984465786483313892 {
+ if chomping != -1 {
+ JOIN!(string, leading_break);
+ current_block = 17787701279558130514;
+ } else {
+ current_block = 17787701279558130514;
+ }
+ if current_block != 14984465786483313892 {
+ if chomping == 1 {
+ JOIN!(string, trailing_breaks);
+ }
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_SCALAR_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh479 =
+ addr_of_mut!((*token).data.scalar.value);
+ *fresh479 = string.start;
+ (*token).data.scalar.length =
+ string.pointer.c_offset_from(string.start)
+ as size_t;
+ (*token).data.scalar.style = if literal {
+ YAML_LITERAL_SCALAR_STYLE
+ } else {
+ YAML_FOLDED_SCALAR_STYLE
+ };
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ return OK;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ STRING_DEL!(string);
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_block_scalar_breaks(
+ parser: *mut yaml_parser_t,
+ indent: *mut libc::c_int,
+ breaks: *mut yaml_string_t,
+ start_mark: yaml_mark_t,
+ end_mark: *mut yaml_mark_t,
+) -> Success {
+ let mut max_indent: libc::c_int = 0;
+ *end_mark = (*parser).mark;
+ loop {
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ while (*indent == 0 || ((*parser).mark.column as libc::c_int) < *indent)
+ && IS_SPACE!((*parser).buffer)
+ {
+ SKIP(parser);
+ if CACHE(parser, 1_u64).fail {
+ return FAIL;
+ }
+ }
+ if (*parser).mark.column as libc::c_int > max_indent {
+ max_indent = (*parser).mark.column as libc::c_int;
+ }
+ if (*indent == 0 || ((*parser).mark.column as libc::c_int) < *indent)
+ && IS_TAB!((*parser).buffer)
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a block scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found a tab character where an indentation space is expected\0" as *const u8
+ as *const libc::c_char,
+ );
+ return FAIL;
+ }
+ if !IS_BREAK!((*parser).buffer) {
+ break;
+ }
+ if CACHE(parser, 2_u64).fail {
+ return FAIL;
+ }
+ READ_LINE!(parser, *breaks);
+ *end_mark = (*parser).mark;
+ }
+ if *indent == 0 {
+ *indent = max_indent;
+ if *indent < (*parser).indent + 1 {
+ *indent = (*parser).indent + 1;
+ }
+ if *indent < 1 {
+ *indent = 1;
+ }
+ }
+ OK
+}
+
+unsafe fn yaml_parser_scan_flow_scalar(
+ parser: *mut yaml_parser_t,
+ token: *mut yaml_token_t,
+ single: bool,
+) -> Success {
+ let current_block: u64;
+ let end_mark: yaml_mark_t;
+ let mut string = NULL_STRING;
+ let mut leading_break = NULL_STRING;
+ let mut trailing_breaks = NULL_STRING;
+ let mut whitespaces = NULL_STRING;
+ let mut leading_blanks;
+ STRING_INIT!(string);
+ STRING_INIT!(leading_break);
+ STRING_INIT!(trailing_breaks);
+ STRING_INIT!(whitespaces);
+ let start_mark: yaml_mark_t = (*parser).mark;
+ SKIP(parser);
+ 's_58: loop {
+ if CACHE(parser, 4_u64).fail {
+ current_block = 8114179180390253173;
+ break;
+ }
+ if (*parser).mark.column == 0_u64
+ && (CHECK_AT!((*parser).buffer, b'-', 0)
+ && CHECK_AT!((*parser).buffer, b'-', 1)
+ && CHECK_AT!((*parser).buffer, b'-', 2)
+ || CHECK_AT!((*parser).buffer, b'.', 0)
+ && CHECK_AT!((*parser).buffer, b'.', 1)
+ && CHECK_AT!((*parser).buffer, b'.', 2))
+ && IS_BLANKZ_AT!((*parser).buffer, 3)
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a quoted scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found unexpected document indicator\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 8114179180390253173;
+ break;
+ } else if IS_Z!((*parser).buffer) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a quoted scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found unexpected end of stream\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 8114179180390253173;
+ break;
+ } else {
+ if CACHE(parser, 2_u64).fail {
+ current_block = 8114179180390253173;
+ break;
+ }
+ leading_blanks = false;
+ while !IS_BLANKZ!((*parser).buffer) {
+ if single
+ && CHECK_AT!((*parser).buffer, b'\'', 0)
+ && CHECK_AT!((*parser).buffer, b'\'', 1)
+ {
+ STRING_EXTEND!(string);
+ let fresh521 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh521 = b'\'';
+ SKIP(parser);
+ SKIP(parser);
+ } else {
+ if CHECK!((*parser).buffer, if single { b'\'' } else { b'"' }) {
+ break;
+ }
+ if !single
+ && CHECK!((*parser).buffer, b'\\')
+ && IS_BREAK_AT!((*parser).buffer, 1)
+ {
+ if CACHE(parser, 3_u64).fail {
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ SKIP(parser);
+ SKIP_LINE(parser);
+ leading_blanks = true;
+ break;
+ } else if !single && CHECK!((*parser).buffer, b'\\') {
+ let mut code_length: size_t = 0_u64;
+ STRING_EXTEND!(string);
+ match *(*parser).buffer.pointer.wrapping_offset(1_isize) {
+ b'0' => {
+ let fresh542 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh542 = b'\0';
+ }
+ b'a' => {
+ let fresh543 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh543 = b'\x07';
+ }
+ b'b' => {
+ let fresh544 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh544 = b'\x08';
+ }
+ b't' | b'\t' => {
+ let fresh545 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh545 = b'\t';
+ }
+ b'n' => {
+ let fresh546 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh546 = b'\n';
+ }
+ b'v' => {
+ let fresh547 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh547 = b'\x0B';
+ }
+ b'f' => {
+ let fresh548 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh548 = b'\x0C';
+ }
+ b'r' => {
+ let fresh549 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh549 = b'\r';
+ }
+ b'e' => {
+ let fresh550 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh550 = b'\x1B';
+ }
+ b' ' => {
+ let fresh551 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh551 = b' ';
+ }
+ b'"' => {
+ let fresh552 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh552 = b'"';
+ }
+ b'/' => {
+ let fresh553 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh553 = b'/';
+ }
+ b'\\' => {
+ let fresh554 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh554 = b'\\';
+ }
+ // NEL (#x85)
+ b'N' => {
+ let fresh555 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh555 = b'\xC2';
+ let fresh556 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh556 = b'\x85';
+ }
+ // #xA0
+ b'_' => {
+ let fresh557 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh557 = b'\xC2';
+ let fresh558 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh558 = b'\xA0';
+ }
+ // LS (#x2028)
+ b'L' => {
+ let fresh559 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh559 = b'\xE2';
+ let fresh560 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh560 = b'\x80';
+ let fresh561 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh561 = b'\xA8';
+ }
+ // PS (#x2029)
+ b'P' => {
+ let fresh562 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh562 = b'\xE2';
+ let fresh563 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh563 = b'\x80';
+ let fresh564 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh564 = b'\xA9';
+ }
+ b'x' => {
+ code_length = 2_u64;
+ }
+ b'u' => {
+ code_length = 4_u64;
+ }
+ b'U' => {
+ code_length = 8_u64;
+ }
+ _ => {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while parsing a quoted scalar\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"found unknown escape character\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ }
+ SKIP(parser);
+ SKIP(parser);
+ if code_length != 0 {
+ let mut value: libc::c_uint = 0;
+ let mut k: size_t;
+ if CACHE(parser, code_length).fail {
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ k = 0_u64;
+ while k < code_length {
+ if !IS_HEX_AT!((*parser).buffer, k as isize) {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while parsing a quoted scalar\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"did not find expected hexdecimal number\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 8114179180390253173;
+ break 's_58;
+ } else {
+ value = (value << 4).force_add(AS_HEX_AT!(
+ (*parser).buffer,
+ k as isize
+ )
+ as libc::c_uint);
+ k = k.force_add(1);
+ }
+ }
+ if value >= 0xD800 && value <= 0xDFFF || value > 0x10FFFF {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while parsing a quoted scalar\0" as *const u8
+ as *const libc::c_char,
+ start_mark,
+ b"found invalid Unicode character escape code\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 8114179180390253173;
+ break 's_58;
+ } else {
+ if value <= 0x7F {
+ let fresh573 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh573 = value as yaml_char_t;
+ } else if value <= 0x7FF {
+ let fresh574 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh574 = 0xC0_u32.force_add(value >> 6) as yaml_char_t;
+ let fresh575 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh575 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ } else if value <= 0xFFFF {
+ let fresh576 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh576 = 0xE0_u32.force_add(value >> 12) as yaml_char_t;
+ let fresh577 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh577 =
+ 0x80_u32.force_add(value >> 6 & 0x3F) as yaml_char_t;
+ let fresh578 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh578 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ } else {
+ let fresh579 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh579 = 0xF0_u32.force_add(value >> 18) as yaml_char_t;
+ let fresh580 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh580 =
+ 0x80_u32.force_add(value >> 12 & 0x3F) as yaml_char_t;
+ let fresh581 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh581 =
+ 0x80_u32.force_add(value >> 6 & 0x3F) as yaml_char_t;
+ let fresh582 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh582 = 0x80_u32.force_add(value & 0x3F) as yaml_char_t;
+ }
+ k = 0_u64;
+ while k < code_length {
+ SKIP(parser);
+ k = k.force_add(1);
+ }
+ }
+ }
+ } else {
+ READ!(parser, string);
+ }
+ }
+ if CACHE(parser, 2_u64).fail {
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 8114179180390253173;
+ break;
+ }
+ if CHECK!((*parser).buffer, if single { b'\'' } else { b'"' }) {
+ current_block = 7468767852762055642;
+ break;
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 8114179180390253173;
+ break;
+ }
+ while IS_BLANK!((*parser).buffer) || IS_BREAK!((*parser).buffer) {
+ if IS_BLANK!((*parser).buffer) {
+ if !leading_blanks {
+ READ!(parser, whitespaces);
+ } else {
+ SKIP(parser);
+ }
+ } else {
+ if CACHE(parser, 2_u64).fail {
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ if !leading_blanks {
+ CLEAR!(whitespaces);
+ READ_LINE!(parser, leading_break);
+ leading_blanks = true;
+ } else {
+ READ_LINE!(parser, trailing_breaks);
+ }
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 8114179180390253173;
+ break 's_58;
+ }
+ }
+ if leading_blanks {
+ if *leading_break.start == b'\n' {
+ if *trailing_breaks.start == b'\0' {
+ STRING_EXTEND!(string);
+ let fresh711 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh711 = b' ';
+ } else {
+ JOIN!(string, trailing_breaks);
+ CLEAR!(trailing_breaks);
+ }
+ CLEAR!(leading_break);
+ } else {
+ JOIN!(string, leading_break);
+ JOIN!(string, trailing_breaks);
+ CLEAR!(leading_break);
+ CLEAR!(trailing_breaks);
+ }
+ } else {
+ JOIN!(string, whitespaces);
+ CLEAR!(whitespaces);
+ }
+ }
+ }
+ if current_block != 8114179180390253173 {
+ SKIP(parser);
+ end_mark = (*parser).mark;
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_SCALAR_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh716 = addr_of_mut!((*token).data.scalar.value);
+ *fresh716 = string.start;
+ (*token).data.scalar.length = string.pointer.c_offset_from(string.start) as size_t;
+ (*token).data.scalar.style = if single {
+ YAML_SINGLE_QUOTED_SCALAR_STYLE
+ } else {
+ YAML_DOUBLE_QUOTED_SCALAR_STYLE
+ };
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ STRING_DEL!(whitespaces);
+ return OK;
+ }
+ STRING_DEL!(string);
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ STRING_DEL!(whitespaces);
+ FAIL
+}
+
+unsafe fn yaml_parser_scan_plain_scalar(
+ parser: *mut yaml_parser_t,
+ token: *mut yaml_token_t,
+) -> Success {
+ let current_block: u64;
+ let mut end_mark: yaml_mark_t;
+ let mut string = NULL_STRING;
+ let mut leading_break = NULL_STRING;
+ let mut trailing_breaks = NULL_STRING;
+ let mut whitespaces = NULL_STRING;
+ let mut leading_blanks = false;
+ let indent: libc::c_int = (*parser).indent + 1;
+ STRING_INIT!(string);
+ STRING_INIT!(leading_break);
+ STRING_INIT!(trailing_breaks);
+ STRING_INIT!(whitespaces);
+ end_mark = (*parser).mark;
+ let start_mark: yaml_mark_t = end_mark;
+ 's_57: loop {
+ if CACHE(parser, 4_u64).fail {
+ current_block = 16642808987012640029;
+ break;
+ }
+ if (*parser).mark.column == 0_u64
+ && (CHECK_AT!((*parser).buffer, b'-', 0)
+ && CHECK_AT!((*parser).buffer, b'-', 1)
+ && CHECK_AT!((*parser).buffer, b'-', 2)
+ || CHECK_AT!((*parser).buffer, b'.', 0)
+ && CHECK_AT!((*parser).buffer, b'.', 1)
+ && CHECK_AT!((*parser).buffer, b'.', 2))
+ && IS_BLANKZ_AT!((*parser).buffer, 3)
+ {
+ current_block = 6281126495347172768;
+ break;
+ }
+ if CHECK!((*parser).buffer, b'#') {
+ current_block = 6281126495347172768;
+ break;
+ }
+ while !IS_BLANKZ!((*parser).buffer) {
+ if (*parser).flow_level != 0
+ && CHECK!((*parser).buffer, b':')
+ && (CHECK_AT!((*parser).buffer, b',', 1)
+ || CHECK_AT!((*parser).buffer, b'?', 1)
+ || CHECK_AT!((*parser).buffer, b'[', 1)
+ || CHECK_AT!((*parser).buffer, b']', 1)
+ || CHECK_AT!((*parser).buffer, b'{', 1)
+ || CHECK_AT!((*parser).buffer, b'}', 1))
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a plain scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found unexpected ':'\0" as *const u8 as *const libc::c_char,
+ );
+ current_block = 16642808987012640029;
+ break 's_57;
+ } else {
+ if CHECK!((*parser).buffer, b':') && IS_BLANKZ_AT!((*parser).buffer, 1)
+ || (*parser).flow_level != 0
+ && (CHECK!((*parser).buffer, b',')
+ || CHECK!((*parser).buffer, b'[')
+ || CHECK!((*parser).buffer, b']')
+ || CHECK!((*parser).buffer, b'{')
+ || CHECK!((*parser).buffer, b'}'))
+ {
+ break;
+ }
+ if leading_blanks || whitespaces.start != whitespaces.pointer {
+ if leading_blanks {
+ if *leading_break.start == b'\n' {
+ if *trailing_breaks.start == b'\0' {
+ STRING_EXTEND!(string);
+ let fresh717 = string.pointer;
+ string.pointer = string.pointer.wrapping_offset(1);
+ *fresh717 = b' ';
+ } else {
+ JOIN!(string, trailing_breaks);
+ CLEAR!(trailing_breaks);
+ }
+ CLEAR!(leading_break);
+ } else {
+ JOIN!(string, leading_break);
+ JOIN!(string, trailing_breaks);
+ CLEAR!(leading_break);
+ CLEAR!(trailing_breaks);
+ }
+ leading_blanks = false;
+ } else {
+ JOIN!(string, whitespaces);
+ CLEAR!(whitespaces);
+ }
+ }
+ READ!(parser, string);
+ end_mark = (*parser).mark;
+ if CACHE(parser, 2_u64).fail {
+ current_block = 16642808987012640029;
+ break 's_57;
+ }
+ }
+ }
+ if !(IS_BLANK!((*parser).buffer) || IS_BREAK!((*parser).buffer)) {
+ current_block = 6281126495347172768;
+ break;
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 16642808987012640029;
+ break;
+ }
+ while IS_BLANK!((*parser).buffer) || IS_BREAK!((*parser).buffer) {
+ if IS_BLANK!((*parser).buffer) {
+ if leading_blanks
+ && ((*parser).mark.column as libc::c_int) < indent
+ && IS_TAB!((*parser).buffer)
+ {
+ yaml_parser_set_scanner_error(
+ parser,
+ b"while scanning a plain scalar\0" as *const u8 as *const libc::c_char,
+ start_mark,
+ b"found a tab character that violates indentation\0" as *const u8
+ as *const libc::c_char,
+ );
+ current_block = 16642808987012640029;
+ break 's_57;
+ } else if !leading_blanks {
+ READ!(parser, whitespaces);
+ } else {
+ SKIP(parser);
+ }
+ } else {
+ if CACHE(parser, 2_u64).fail {
+ current_block = 16642808987012640029;
+ break 's_57;
+ }
+ if !leading_blanks {
+ CLEAR!(whitespaces);
+ READ_LINE!(parser, leading_break);
+ leading_blanks = true;
+ } else {
+ READ_LINE!(parser, trailing_breaks);
+ }
+ }
+ if CACHE(parser, 1_u64).fail {
+ current_block = 16642808987012640029;
+ break 's_57;
+ }
+ }
+ if (*parser).flow_level == 0 && ((*parser).mark.column as libc::c_int) < indent {
+ current_block = 6281126495347172768;
+ break;
+ }
+ }
+ if current_block != 16642808987012640029 {
+ memset(
+ token as *mut libc::c_void,
+ 0,
+ size_of::<yaml_token_t>() as libc::c_ulong,
+ );
+ (*token).type_ = YAML_SCALAR_TOKEN;
+ (*token).start_mark = start_mark;
+ (*token).end_mark = end_mark;
+ let fresh842 = addr_of_mut!((*token).data.scalar.value);
+ *fresh842 = string.start;
+ (*token).data.scalar.length = string.pointer.c_offset_from(string.start) as size_t;
+ (*token).data.scalar.style = YAML_PLAIN_SCALAR_STYLE;
+ if leading_blanks {
+ (*parser).simple_key_allowed = true;
+ }
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ STRING_DEL!(whitespaces);
+ return OK;
+ }
+ STRING_DEL!(string);
+ STRING_DEL!(leading_break);
+ STRING_DEL!(trailing_breaks);
+ STRING_DEL!(whitespaces);
+ FAIL
+}
diff --git a/crates/unsafe-libyaml/src/success.rs b/crates/unsafe-libyaml/src/success.rs
new file mode 100644
index 0000000..c004d17
--- /dev/null
+++ b/crates/unsafe-libyaml/src/success.rs
@@ -0,0 +1,25 @@
+use core::ops::Deref;
+
+pub const OK: Success = Success { ok: true };
+pub const FAIL: Success = Success { ok: false };
+
+#[must_use]
+pub struct Success {
+ pub ok: bool,
+}
+
+pub struct Failure {
+ pub fail: bool,
+}
+
+impl Deref for Success {
+ type Target = Failure;
+
+ fn deref(&self) -> &Self::Target {
+ if self.ok {
+ &Failure { fail: false }
+ } else {
+ &Failure { fail: true }
+ }
+ }
+}
diff --git a/crates/unsafe-libyaml/src/writer.rs b/crates/unsafe-libyaml/src/writer.rs
new file mode 100644
index 0000000..730c927
--- /dev/null
+++ b/crates/unsafe-libyaml/src/writer.rs
@@ -0,0 +1,149 @@
+use crate::ops::ForceAdd as _;
+use crate::success::{Success, FAIL, OK};
+use crate::yaml::size_t;
+use crate::{
+ libc, yaml_emitter_t, PointerExt, YAML_ANY_ENCODING, YAML_UTF16LE_ENCODING, YAML_UTF8_ENCODING,
+ YAML_WRITER_ERROR,
+};
+use core::ptr::addr_of_mut;
+
+unsafe fn yaml_emitter_set_writer_error(
+ emitter: *mut yaml_emitter_t,
+ problem: *const libc::c_char,
+) -> Success {
+ (*emitter).error = YAML_WRITER_ERROR;
+ let fresh0 = addr_of_mut!((*emitter).problem);
+ *fresh0 = problem;
+ FAIL
+}
+
+/// Flush the accumulated characters to the output.
+pub unsafe fn yaml_emitter_flush(emitter: *mut yaml_emitter_t) -> Success {
+ __assert!(!emitter.is_null());
+ __assert!(((*emitter).write_handler).is_some());
+ __assert!((*emitter).encoding != YAML_ANY_ENCODING);
+ let fresh1 = addr_of_mut!((*emitter).buffer.last);
+ *fresh1 = (*emitter).buffer.pointer;
+ let fresh2 = addr_of_mut!((*emitter).buffer.pointer);
+ *fresh2 = (*emitter).buffer.start;
+ if (*emitter).buffer.start == (*emitter).buffer.last {
+ return OK;
+ }
+ if (*emitter).encoding == YAML_UTF8_ENCODING {
+ if (*emitter).write_handler.expect("non-null function pointer")(
+ (*emitter).write_handler_data,
+ (*emitter).buffer.start,
+ (*emitter)
+ .buffer
+ .last
+ .c_offset_from((*emitter).buffer.start) as size_t,
+ ) != 0
+ {
+ let fresh3 = addr_of_mut!((*emitter).buffer.last);
+ *fresh3 = (*emitter).buffer.start;
+ let fresh4 = addr_of_mut!((*emitter).buffer.pointer);
+ *fresh4 = (*emitter).buffer.start;
+ return OK;
+ } else {
+ return yaml_emitter_set_writer_error(
+ emitter,
+ b"write error\0" as *const u8 as *const libc::c_char,
+ );
+ }
+ }
+ let low: libc::c_int = if (*emitter).encoding == YAML_UTF16LE_ENCODING {
+ 0
+ } else {
+ 1
+ };
+ let high: libc::c_int = if (*emitter).encoding == YAML_UTF16LE_ENCODING {
+ 1
+ } else {
+ 0
+ };
+ while (*emitter).buffer.pointer != (*emitter).buffer.last {
+ let mut octet: libc::c_uchar;
+ let mut value: libc::c_uint;
+ let mut k: size_t;
+ octet = *(*emitter).buffer.pointer;
+ let width: libc::c_uint = if octet & 0x80 == 0 {
+ 1
+ } else if octet & 0xE0 == 0xC0 {
+ 2
+ } else if octet & 0xF0 == 0xE0 {
+ 3
+ } else if octet & 0xF8 == 0xF0 {
+ 4
+ } else {
+ 0
+ } as libc::c_uint;
+ value = if octet & 0x80 == 0 {
+ octet & 0x7F
+ } else if octet & 0xE0 == 0xC0 {
+ octet & 0x1F
+ } else if octet & 0xF0 == 0xE0 {
+ octet & 0xF
+ } else if octet & 0xF8 == 0xF0 {
+ octet & 0x7
+ } else {
+ 0
+ } as libc::c_uint;
+ k = 1_u64;
+ while k < width as libc::c_ulong {
+ octet = *(*emitter).buffer.pointer.wrapping_offset(k as isize);
+ value = (value << 6).force_add((octet & 0x3F) as libc::c_uint);
+ k = k.force_add(1);
+ }
+ let fresh5 = addr_of_mut!((*emitter).buffer.pointer);
+ *fresh5 = (*fresh5).wrapping_offset(width as isize);
+ if value < 0x10000 {
+ *(*emitter).raw_buffer.last.wrapping_offset(high as isize) =
+ (value >> 8) as libc::c_uchar;
+ *(*emitter).raw_buffer.last.wrapping_offset(low as isize) =
+ (value & 0xFF) as libc::c_uchar;
+ let fresh6 = addr_of_mut!((*emitter).raw_buffer.last);
+ *fresh6 = (*fresh6).wrapping_offset(2_isize);
+ } else {
+ value = value.wrapping_sub(0x10000);
+ *(*emitter).raw_buffer.last.wrapping_offset(high as isize) =
+ 0xD8_u32.force_add(value >> 18) as libc::c_uchar;
+ *(*emitter).raw_buffer.last.wrapping_offset(low as isize) =
+ (value >> 10 & 0xFF) as libc::c_uchar;
+ *(*emitter)
+ .raw_buffer
+ .last
+ .wrapping_offset((high + 2) as isize) =
+ 0xDC_u32.force_add(value >> 8 & 0xFF) as libc::c_uchar;
+ *(*emitter)
+ .raw_buffer
+ .last
+ .wrapping_offset((low + 2) as isize) = (value & 0xFF) as libc::c_uchar;
+ let fresh7 = addr_of_mut!((*emitter).raw_buffer.last);
+ *fresh7 = (*fresh7).wrapping_offset(4_isize);
+ }
+ }
+ if (*emitter).write_handler.expect("non-null function pointer")(
+ (*emitter).write_handler_data,
+ (*emitter).raw_buffer.start,
+ (*emitter)
+ .raw_buffer
+ .last
+ .c_offset_from((*emitter).raw_buffer.start) as size_t,
+ ) != 0
+ {
+ let fresh8 = addr_of_mut!((*emitter).buffer.last);
+ *fresh8 = (*emitter).buffer.start;
+ let fresh9 = addr_of_mut!((*emitter).buffer.pointer);
+ *fresh9 = (*emitter).buffer.start;
+ let fresh10 = addr_of_mut!((*emitter).raw_buffer.last);
+ *fresh10 = (*emitter).raw_buffer.start;
+ let fresh11 = addr_of_mut!((*emitter).raw_buffer.pointer);
+ *fresh11 = (*emitter).raw_buffer.start;
+ OK
+ } else {
+ yaml_emitter_set_writer_error(
+ emitter,
+ b"write error\0" as *const u8 as *const libc::c_char,
+ )
+ }
+}
diff --git a/crates/unsafe-libyaml/src/yaml.rs b/crates/unsafe-libyaml/src/yaml.rs
new file mode 100644
index 0000000..ec05a80
--- /dev/null
+++ b/crates/unsafe-libyaml/src/yaml.rs
@@ -0,0 +1,1280 @@
+use crate::libc;
+use core::ops::Deref;
+use core::ptr::{self, addr_of};
+
+pub use self::{yaml_encoding_t::*, yaml_event_type_t::*, yaml_node_type_t::*};
+pub use core::primitive::{i64 as ptrdiff_t, u64 as size_t, u8 as yaml_char_t};
+
+/// The version directive data.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_version_directive_t {
+ /// The major version number.
+ pub major: libc::c_int,
+ /// The minor version number.
+ pub minor: libc::c_int,
+}
+
+/// The tag directive data.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_tag_directive_t {
+ /// The tag handle.
+ pub handle: *mut yaml_char_t,
+ /// The tag prefix.
+ pub prefix: *mut yaml_char_t,
+}
+
+/// The stream encoding.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_encoding_t {
+ /// Let the parser choose the encoding.
+ YAML_ANY_ENCODING = 0,
+ /// The default UTF-8 encoding.
+ YAML_UTF8_ENCODING = 1,
+ /// The UTF-16-LE encoding with BOM.
+ YAML_UTF16LE_ENCODING = 2,
+ /// The UTF-16-BE encoding with BOM.
+ YAML_UTF16BE_ENCODING = 3,
+}
+
+/// Line break type.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_break_t {
+ /// Let the parser choose the break type.
+ YAML_ANY_BREAK = 0,
+ /// Use CR for line breaks (Mac style).
+ YAML_CR_BREAK = 1,
+ /// Use LN for line breaks (Unix style).
+ YAML_LN_BREAK = 2,
+ /// Use CR LN for line breaks (DOS style).
+ YAML_CRLN_BREAK = 3,
+}
+
+/// Many bad things could happen with the parser and emitter.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_error_type_t {
+ /// No error is produced.
+ YAML_NO_ERROR = 0,
+ /// Cannot allocate or reallocate a block of memory.
+ YAML_MEMORY_ERROR = 1,
+ /// Cannot read or decode the input stream.
+ YAML_READER_ERROR = 2,
+ /// Cannot scan the input stream.
+ YAML_SCANNER_ERROR = 3,
+ /// Cannot parse the input stream.
+ YAML_PARSER_ERROR = 4,
+ /// Cannot compose a YAML document.
+ YAML_COMPOSER_ERROR = 5,
+ /// Cannot write to the output stream.
+ YAML_WRITER_ERROR = 6,
+ /// Cannot emit a YAML stream.
+ YAML_EMITTER_ERROR = 7,
+}
+
+/// The pointer position.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_mark_t {
+ /// The position index.
+ pub index: size_t,
+ /// The position line.
+ pub line: size_t,
+ /// The position column.
+ pub column: size_t,
+}
+
+/// Scalar styles.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_scalar_style_t {
+ /// Let the emitter choose the style.
+ YAML_ANY_SCALAR_STYLE = 0,
+ /// The plain scalar style.
+ YAML_PLAIN_SCALAR_STYLE = 1,
+ /// The single-quoted scalar style.
+ YAML_SINGLE_QUOTED_SCALAR_STYLE = 2,
+ /// The double-quoted scalar style.
+ YAML_DOUBLE_QUOTED_SCALAR_STYLE = 3,
+ /// The literal scalar style.
+ YAML_LITERAL_SCALAR_STYLE = 4,
+ /// The folded scalar style.
+ YAML_FOLDED_SCALAR_STYLE = 5,
+}
+
+/// Sequence styles.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_sequence_style_t {
+ /// Let the emitter choose the style.
+ YAML_ANY_SEQUENCE_STYLE = 0,
+ /// The block sequence style.
+ YAML_BLOCK_SEQUENCE_STYLE = 1,
+ /// The flow sequence style.
+ YAML_FLOW_SEQUENCE_STYLE = 2,
+}
+
+/// Mapping styles.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_mapping_style_t {
+ /// Let the emitter choose the style.
+ YAML_ANY_MAPPING_STYLE = 0,
+ /// The block mapping style.
+ YAML_BLOCK_MAPPING_STYLE = 1,
+ /// The flow mapping style.
+ YAML_FLOW_MAPPING_STYLE = 2,
+}
+
+/// Token types.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_token_type_t {
+ /// An empty token.
+ YAML_NO_TOKEN = 0,
+ /// A STREAM-START token.
+ YAML_STREAM_START_TOKEN = 1,
+ /// A STREAM-END token.
+ YAML_STREAM_END_TOKEN = 2,
+ /// A VERSION-DIRECTIVE token.
+ YAML_VERSION_DIRECTIVE_TOKEN = 3,
+ /// A TAG-DIRECTIVE token.
+ YAML_TAG_DIRECTIVE_TOKEN = 4,
+ /// A DOCUMENT-START token.
+ YAML_DOCUMENT_START_TOKEN = 5,
+ /// A DOCUMENT-END token.
+ YAML_DOCUMENT_END_TOKEN = 6,
+ /// A BLOCK-SEQUENCE-START token.
+ YAML_BLOCK_SEQUENCE_START_TOKEN = 7,
+ /// A BLOCK-MAPPING-START token.
+ YAML_BLOCK_MAPPING_START_TOKEN = 8,
+ /// A BLOCK-END token.
+ YAML_BLOCK_END_TOKEN = 9,
+ /// A FLOW-SEQUENCE-START token.
+ YAML_FLOW_SEQUENCE_START_TOKEN = 10,
+ /// A FLOW-SEQUENCE-END token.
+ YAML_FLOW_SEQUENCE_END_TOKEN = 11,
+ /// A FLOW-MAPPING-START token.
+ YAML_FLOW_MAPPING_START_TOKEN = 12,
+ /// A FLOW-MAPPING-END token.
+ YAML_FLOW_MAPPING_END_TOKEN = 13,
+ /// A BLOCK-ENTRY token.
+ YAML_BLOCK_ENTRY_TOKEN = 14,
+ /// A FLOW-ENTRY token.
+ YAML_FLOW_ENTRY_TOKEN = 15,
+ /// A KEY token.
+ YAML_KEY_TOKEN = 16,
+ /// A VALUE token.
+ YAML_VALUE_TOKEN = 17,
+ /// An ALIAS token.
+ YAML_ALIAS_TOKEN = 18,
+ /// An ANCHOR token.
+ YAML_ANCHOR_TOKEN = 19,
+ /// A TAG token.
+ YAML_TAG_TOKEN = 20,
+ /// A SCALAR token.
+ YAML_SCALAR_TOKEN = 21,
+}
+
+/// The token structure.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_token_t {
+ /// The token type.
+ pub type_: yaml_token_type_t,
+ /// The token data.
+ ///
+ /// ```
+ /// # const _: &str = stringify! {
+ /// union {
+ /// /// The stream start (for YAML_STREAM_START_TOKEN).
+ /// stream_start: struct {
+ /// /// The stream encoding.
+ /// encoding: yaml_encoding_t,
+ /// },
+ /// /// The alias (for YAML_ALIAS_TOKEN).
+ /// alias: struct {
+ /// /// The alias value.
+ /// value: *mut u8,
+ /// },
+ /// /// The anchor (for YAML_ANCHOR_TOKEN).
+ /// anchor: struct {
+ /// /// The anchor value.
+ /// value: *mut u8,
+ /// },
+ /// /// The tag (for YAML_TAG_TOKEN).
+ /// tag: struct {
+ /// /// The tag handle.
+ /// handle: *mut u8,
+ /// /// The tag suffix.
+ /// suffix: *mut u8,
+ /// },
+ /// /// The scalar value (for YAML_SCALAR_TOKEN).
+ /// scalar: struct {
+ /// /// The scalar value.
+ /// value: *mut u8,
+ /// /// The length of the scalar value.
+ /// length: u64,
+ /// /// The scalar style.
+ /// style: yaml_scalar_style_t,
+ /// },
+ /// /// The version directive (for YAML_VERSION_DIRECTIVE_TOKEN).
+ /// version_directive: struct {
+ /// /// The major version number.
+ /// major: i32,
+ /// /// The minor version number.
+ /// minor: i32,
+ /// },
+ /// /// The tag directive (for YAML_TAG_DIRECTIVE_TOKEN).
+ /// tag_directive: struct {
+ /// /// The tag handle.
+ /// handle: *mut u8,
+ /// /// The tag prefix.
+ /// prefix: *mut u8,
+ /// },
+ /// }
+ /// # };
+ /// ```
+ pub data: unnamed_yaml_token_t_data,
+ /// The beginning of the token.
+ pub start_mark: yaml_mark_t,
+ /// The end of the token.
+ pub end_mark: yaml_mark_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub union unnamed_yaml_token_t_data {
+ /// The stream start (for YAML_STREAM_START_TOKEN).
+ pub stream_start: unnamed_yaml_token_t_data_stream_start,
+ /// The alias (for YAML_ALIAS_TOKEN).
+ pub alias: unnamed_yaml_token_t_data_alias,
+ /// The anchor (for YAML_ANCHOR_TOKEN).
+ pub anchor: unnamed_yaml_token_t_data_anchor,
+ /// The tag (for YAML_TAG_TOKEN).
+ pub tag: unnamed_yaml_token_t_data_tag,
+ /// The scalar value (for YAML_SCALAR_TOKEN).
+ pub scalar: unnamed_yaml_token_t_data_scalar,
+ /// The version directive (for YAML_VERSION_DIRECTIVE_TOKEN).
+ pub version_directive: unnamed_yaml_token_t_data_version_directive,
+ /// The tag directive (for YAML_TAG_DIRECTIVE_TOKEN).
+ pub tag_directive: unnamed_yaml_token_t_data_tag_directive,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_stream_start {
+ /// The stream encoding.
+ pub encoding: yaml_encoding_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_alias {
+ /// The alias value.
+ pub value: *mut yaml_char_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_anchor {
+ /// The anchor value.
+ pub value: *mut yaml_char_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_tag {
+ /// The tag handle.
+ pub handle: *mut yaml_char_t,
+ /// The tag suffix.
+ pub suffix: *mut yaml_char_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_scalar {
+ /// The scalar value.
+ pub value: *mut yaml_char_t,
+ /// The length of the scalar value.
+ pub length: size_t,
+ /// The scalar style.
+ pub style: yaml_scalar_style_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_version_directive {
+ /// The major version number.
+ pub major: libc::c_int,
+ /// The minor version number.
+ pub minor: libc::c_int,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_token_t_data_tag_directive {
+ /// The tag handle.
+ pub handle: *mut yaml_char_t,
+ /// The tag prefix.
+ pub prefix: *mut yaml_char_t,
+}
+
+/// Event types.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_event_type_t {
+ /// An empty event.
+ YAML_NO_EVENT = 0,
+ /// A STREAM-START event.
+ YAML_STREAM_START_EVENT = 1,
+ /// A STREAM-END event.
+ YAML_STREAM_END_EVENT = 2,
+ /// A DOCUMENT-START event.
+ YAML_DOCUMENT_START_EVENT = 3,
+ /// A DOCUMENT-END event.
+ YAML_DOCUMENT_END_EVENT = 4,
+ /// An ALIAS event.
+ YAML_ALIAS_EVENT = 5,
+ /// A SCALAR event.
+ YAML_SCALAR_EVENT = 6,
+ /// A SEQUENCE-START event.
+ YAML_SEQUENCE_START_EVENT = 7,
+ /// A SEQUENCE-END event.
+ YAML_SEQUENCE_END_EVENT = 8,
+ /// A MAPPING-START event.
+ YAML_MAPPING_START_EVENT = 9,
+ /// A MAPPING-END event.
+ YAML_MAPPING_END_EVENT = 10,
+}
+
+/// The event structure.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_event_t {
+ /// The event type.
+ pub type_: yaml_event_type_t,
+ /// The event data.
+ ///
+ /// ```
+ /// # const _: &str = stringify! {
+ /// union {
+ /// /// The stream parameters (for YAML_STREAM_START_EVENT).
+ /// stream_start: struct {
+ /// /// The document encoding.
+ /// encoding: yaml_encoding_t,
+ /// },
+ /// /// The document parameters (for YAML_DOCUMENT_START_EVENT).
+ /// document_start: struct {
+ /// /// The version directive.
+ /// version_directive: *mut yaml_version_directive_t,
+ /// /// The list of tag directives.
+ /// tag_directives: struct {
+ /// /// The beginning of the tag directives list.
+ /// start: *mut yaml_tag_directive_t,
+ /// /// The end of the tag directives list.
+ /// end: *mut yaml_tag_directive_t,
+ /// },
+ /// /// Is the document indicator implicit?
+ /// implicit: i32,
+ /// },
+ /// /// The document end parameters (for YAML_DOCUMENT_END_EVENT).
+ /// document_end: struct {
+ /// /// Is the document end indicator implicit?
+ /// implicit: i32,
+ /// },
+ /// /// The alias parameters (for YAML_ALIAS_EVENT).
+ /// alias: struct {
+ /// /// The anchor.
+ /// anchor: *mut u8,
+ /// },
+ /// /// The scalar parameters (for YAML_SCALAR_EVENT).
+ /// scalar: struct {
+ /// /// The anchor.
+ /// anchor: *mut u8,
+ /// /// The tag.
+ /// tag: *mut u8,
+ /// /// The scalar value.
+ /// value: *mut u8,
+ /// /// The length of the scalar value.
+ /// length: u64,
+ /// /// Is the tag optional for the plain style?
+ /// plain_implicit: i32,
+ /// /// Is the tag optional for any non-plain style?
+ /// quoted_implicit: i32,
+ /// /// The scalar style.
+ /// style: yaml_scalar_style_t,
+ /// },
+ /// /// The sequence parameters (for YAML_SEQUENCE_START_EVENT).
+ /// sequence_start: struct {
+ /// /// The anchor.
+ /// anchor: *mut u8,
+ /// /// The tag.
+ /// tag: *mut u8,
+ /// /// Is the tag optional?
+ /// implicit: i32,
+ /// /// The sequence style.
+ /// style: yaml_sequence_style_t,
+ /// },
+ /// /// The mapping parameters (for YAML_MAPPING_START_EVENT).
+ /// mapping_start: struct {
+ /// /// The anchor.
+ /// anchor: *mut u8,
+ /// /// The tag.
+ /// tag: *mut u8,
+ /// /// Is the tag optional?
+ /// implicit: i32,
+ /// /// The mapping style.
+ /// style: yaml_mapping_style_t,
+ /// },
+ /// }
+ /// # };
+ /// ```
+ pub data: unnamed_yaml_event_t_data,
+ /// The beginning of the event.
+ pub start_mark: yaml_mark_t,
+ /// The end of the event.
+ pub end_mark: yaml_mark_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub union unnamed_yaml_event_t_data {
+ /// The stream parameters (for YAML_STREAM_START_EVENT).
+ pub stream_start: unnamed_yaml_event_t_data_stream_start,
+ /// The document parameters (for YAML_DOCUMENT_START_EVENT).
+ pub document_start: unnamed_yaml_event_t_data_document_start,
+ /// The document end parameters (for YAML_DOCUMENT_END_EVENT).
+ pub document_end: unnamed_yaml_event_t_data_document_end,
+ /// The alias parameters (for YAML_ALIAS_EVENT).
+ pub alias: unnamed_yaml_event_t_data_alias,
+ /// The scalar parameters (for YAML_SCALAR_EVENT).
+ pub scalar: unnamed_yaml_event_t_data_scalar,
+ /// The sequence parameters (for YAML_SEQUENCE_START_EVENT).
+ pub sequence_start: unnamed_yaml_event_t_data_sequence_start,
+ /// The mapping parameters (for YAML_MAPPING_START_EVENT).
+ pub mapping_start: unnamed_yaml_event_t_data_mapping_start,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_stream_start {
+ /// The document encoding.
+ pub encoding: yaml_encoding_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_document_start {
+ /// The version directive.
+ pub version_directive: *mut yaml_version_directive_t,
+ /// The list of tag directives.
+ pub tag_directives: unnamed_yaml_event_t_data_document_start_tag_directives,
+ /// Is the document indicator implicit?
+ pub implicit: bool,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_document_start_tag_directives {
+ /// The beginning of the tag directives list.
+ pub start: *mut yaml_tag_directive_t,
+ /// The end of the tag directives list.
+ pub end: *mut yaml_tag_directive_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_document_end {
+ /// Is the document end indicator implicit?
+ pub implicit: bool,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_alias {
+ /// The anchor.
+ pub anchor: *mut yaml_char_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_scalar {
+ /// The anchor.
+ pub anchor: *mut yaml_char_t,
+ /// The tag.
+ pub tag: *mut yaml_char_t,
+ /// The scalar value.
+ pub value: *mut yaml_char_t,
+ /// The length of the scalar value.
+ pub length: size_t,
+ /// Is the tag optional for the plain style?
+ pub plain_implicit: bool,
+ /// Is the tag optional for any non-plain style?
+ pub quoted_implicit: bool,
+ /// The scalar style.
+ pub style: yaml_scalar_style_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_sequence_start {
+ /// The anchor.
+ pub anchor: *mut yaml_char_t,
+ /// The tag.
+ pub tag: *mut yaml_char_t,
+ /// Is the tag optional?
+ pub implicit: bool,
+ /// The sequence style.
+ pub style: yaml_sequence_style_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_event_t_data_mapping_start {
+ /// The anchor.
+ pub anchor: *mut yaml_char_t,
+ /// The tag.
+ pub tag: *mut yaml_char_t,
+ /// Is the tag optional?
+ pub implicit: bool,
+ /// The mapping style.
+ pub style: yaml_mapping_style_t,
+}
+
+/// Node types.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_node_type_t {
+ /// An empty node.
+ YAML_NO_NODE = 0,
+ /// A scalar node.
+ YAML_SCALAR_NODE = 1,
+ /// A sequence node.
+ YAML_SEQUENCE_NODE = 2,
+ /// A mapping node.
+ YAML_MAPPING_NODE = 3,
+}
+
+/// The node structure.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_node_t {
+ /// The node type.
+ pub type_: yaml_node_type_t,
+ /// The node tag.
+ pub tag: *mut yaml_char_t,
+ /// The node data.
+ ///
+ /// ```
+ /// # const _: &str = stringify! {
+ /// union {
+ /// /// The scalar parameters (for YAML_SCALAR_NODE).
+ /// scalar: struct {
+ /// /// The scalar value.
+ /// value: *mut u8,
+ /// /// The length of the scalar value.
+ /// length: u64,
+ /// /// The scalar style.
+ /// style: yaml_scalar_style_t,
+ /// },
+ /// /// The sequence parameters (for YAML_SEQUENCE_NODE).
+ /// sequence: struct {
+ /// /// The stack of sequence items.
+ /// items: yaml_stack_t<yaml_node_item_t>,
+ /// /// The sequence style.
+ /// style: yaml_sequence_style_t,
+ /// },
+ /// /// The mapping parameters (for YAML_MAPPING_NODE).
+ /// mapping: struct {
+ /// /// The stack of mapping pairs (key, value).
+ /// pairs: yaml_stack_t<yaml_node_pair_t>,
+ /// /// The mapping style.
+ /// style: yaml_mapping_style_t,
+ /// },
+ /// }
+ /// # };
+ /// ```
+ pub data: unnamed_yaml_node_t_data,
+ /// The beginning of the node.
+ pub start_mark: yaml_mark_t,
+ /// The end of the node.
+ pub end_mark: yaml_mark_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub union unnamed_yaml_node_t_data {
+ /// The scalar parameters (for YAML_SCALAR_NODE).
+ pub scalar: unnamed_yaml_node_t_data_scalar,
+ /// The sequence parameters (for YAML_SEQUENCE_NODE).
+ pub sequence: unnamed_yaml_node_t_data_sequence,
+ /// The mapping parameters (for YAML_MAPPING_NODE).
+ pub mapping: unnamed_yaml_node_t_data_mapping,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_node_t_data_scalar {
+ /// The scalar value.
+ pub value: *mut yaml_char_t,
+ /// The length of the scalar value.
+ pub length: size_t,
+ /// The scalar style.
+ pub style: yaml_scalar_style_t,
+}
+
+/// An element of a sequence node.
+pub type yaml_node_item_t = libc::c_int;
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_node_t_data_sequence {
+ /// The stack of sequence items.
+ pub items: yaml_stack_t<yaml_node_item_t>,
+ /// The sequence style.
+ pub style: yaml_sequence_style_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_node_t_data_mapping {
+ /// The stack of mapping pairs (key, value).
+ pub pairs: yaml_stack_t<yaml_node_pair_t>,
+ /// The mapping style.
+ pub style: yaml_mapping_style_t,
+}
+
+/// An element of a mapping node.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_node_pair_t {
+ /// The key of the element.
+ pub key: libc::c_int,
+ /// The value of the element.
+ pub value: libc::c_int,
+}
+
+/// The document structure.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_document_t {
+ /// The document nodes.
+ pub nodes: yaml_stack_t<yaml_node_t>,
+ /// The version directive.
+ pub version_directive: *mut yaml_version_directive_t,
+ /// The list of tag directives.
+ ///
+ /// ```
+ /// # const _: &str = stringify! {
+ /// struct {
+ /// /// The beginning of the tag directives list.
+ /// start: *mut yaml_tag_directive_t,
+ /// /// The end of the tag directives list.
+ /// end: *mut yaml_tag_directive_t,
+ /// }
+ /// # };
+ /// ```
+ pub tag_directives: unnamed_yaml_document_t_tag_directives,
+ /// Is the document start indicator implicit?
+ pub start_implicit: bool,
+ /// Is the document end indicator implicit?
+ pub end_implicit: bool,
+ /// The beginning of the document.
+ pub start_mark: yaml_mark_t,
+ /// The end of the document.
+ pub end_mark: yaml_mark_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct unnamed_yaml_document_t_tag_directives {
+ /// The beginning of the tag directives list.
+ pub start: *mut yaml_tag_directive_t,
+ /// The end of the tag directives list.
+ pub end: *mut yaml_tag_directive_t,
+}
+
+/// The prototype of a read handler.
+///
+/// The read handler is called when the parser needs to read more bytes from the
+/// source. The handler should write not more than `size` bytes to the `buffer`.
+/// The number of written bytes should be set to the `length` variable.
+///
+/// On success, the handler should return 1. If the handler failed, the returned
+/// value should be 0. On EOF, the handler should set the `size_read` to 0 and
+/// return 1.
+pub type yaml_read_handler_t = unsafe fn(
+ data: *mut libc::c_void,
+ buffer: *mut libc::c_uchar,
+ size: size_t,
+ size_read: *mut size_t,
+) -> libc::c_int;
+
+/// This structure holds information about a potential simple key.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_simple_key_t {
+ /// Is a simple key possible?
+ pub possible: bool,
+ /// Is a simple key required?
+ pub required: bool,
+ /// The number of the token.
+ pub token_number: size_t,
+ /// The position mark.
+ pub mark: yaml_mark_t,
+}
+
+/// The states of the parser.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_parser_state_t {
+ /// Expect STREAM-START.
+ YAML_PARSE_STREAM_START_STATE = 0,
+ /// Expect the beginning of an implicit document.
+ YAML_PARSE_IMPLICIT_DOCUMENT_START_STATE = 1,
+ /// Expect DOCUMENT-START.
+ YAML_PARSE_DOCUMENT_START_STATE = 2,
+ /// Expect the content of a document.
+ YAML_PARSE_DOCUMENT_CONTENT_STATE = 3,
+ /// Expect DOCUMENT-END.
+ YAML_PARSE_DOCUMENT_END_STATE = 4,
+ /// Expect a block node.
+ YAML_PARSE_BLOCK_NODE_STATE = 5,
+ /// Expect a block node or indentless sequence.
+ YAML_PARSE_BLOCK_NODE_OR_INDENTLESS_SEQUENCE_STATE = 6,
+ /// Expect a flow node.
+ YAML_PARSE_FLOW_NODE_STATE = 7,
+ /// Expect the first entry of a block sequence.
+ YAML_PARSE_BLOCK_SEQUENCE_FIRST_ENTRY_STATE = 8,
+ /// Expect an entry of a block sequence.
+ YAML_PARSE_BLOCK_SEQUENCE_ENTRY_STATE = 9,
+ /// Expect an entry of an indentless sequence.
+ YAML_PARSE_INDENTLESS_SEQUENCE_ENTRY_STATE = 10,
+ /// Expect the first key of a block mapping.
+ YAML_PARSE_BLOCK_MAPPING_FIRST_KEY_STATE = 11,
+ /// Expect a block mapping key.
+ YAML_PARSE_BLOCK_MAPPING_KEY_STATE = 12,
+ /// Expect a block mapping value.
+ YAML_PARSE_BLOCK_MAPPING_VALUE_STATE = 13,
+ /// Expect the first entry of a flow sequence.
+ YAML_PARSE_FLOW_SEQUENCE_FIRST_ENTRY_STATE = 14,
+ /// Expect an entry of a flow sequence.
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_STATE = 15,
+ /// Expect a key of an ordered mapping.
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_KEY_STATE = 16,
+ /// Expect a value of an ordered mapping.
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_VALUE_STATE = 17,
+ /// Expect the and of an ordered mapping entry.
+ YAML_PARSE_FLOW_SEQUENCE_ENTRY_MAPPING_END_STATE = 18,
+ /// Expect the first key of a flow mapping.
+ YAML_PARSE_FLOW_MAPPING_FIRST_KEY_STATE = 19,
+ /// Expect a key of a flow mapping.
+ YAML_PARSE_FLOW_MAPPING_KEY_STATE = 20,
+ /// Expect a value of a flow mapping.
+ YAML_PARSE_FLOW_MAPPING_VALUE_STATE = 21,
+ /// Expect an empty value of a flow mapping.
+ YAML_PARSE_FLOW_MAPPING_EMPTY_VALUE_STATE = 22,
+ /// Expect nothing.
+ YAML_PARSE_END_STATE = 23,
+}
+
+/// This structure holds aliases data.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_alias_data_t {
+ /// The anchor.
+ pub anchor: *mut yaml_char_t,
+ /// The node id.
+ pub index: libc::c_int,
+ /// The anchor mark.
+ pub mark: yaml_mark_t,
+}
+
+/// The parser structure.
+///
+/// All members are internal. Manage the structure using the `yaml_parser_`
+/// family of functions.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_parser_t {
+ /// Error type.
+ #[cfg(doc)]
+ pub error: yaml_error_type_t,
+ #[cfg(not(doc))]
+ pub(crate) error: yaml_error_type_t,
+ /// Error description.
+ #[cfg(doc)]
+ pub problem: *const libc::c_char,
+ #[cfg(not(doc))]
+ pub(crate) problem: *const libc::c_char,
+ /// The byte about which the problem occured.
+ #[cfg(doc)]
+ pub problem_offset: size_t,
+ #[cfg(not(doc))]
+ pub(crate) problem_offset: size_t,
+ /// The problematic value (-1 is none).
+ #[cfg(doc)]
+ pub problem_value: libc::c_int,
+ #[cfg(not(doc))]
+ pub(crate) problem_value: libc::c_int,
+ /// The problem position.
+ #[cfg(doc)]
+ pub problem_mark: yaml_mark_t,
+ #[cfg(not(doc))]
+ pub(crate) problem_mark: yaml_mark_t,
+ /// The error context.
+ #[cfg(doc)]
+ pub context: *const libc::c_char,
+ #[cfg(not(doc))]
+ pub(crate) context: *const libc::c_char,
+ /// The context position.
+ #[cfg(doc)]
+ pub context_mark: yaml_mark_t,
+ #[cfg(not(doc))]
+ pub(crate) context_mark: yaml_mark_t,
+ /// Read handler.
+ pub(crate) read_handler: Option<yaml_read_handler_t>,
+ /// A pointer for passing to the read handler.
+ pub(crate) read_handler_data: *mut libc::c_void,
+ /// Standard (string or file) input data.
+ pub(crate) input: unnamed_yaml_parser_t_input,
+ /// EOF flag
+ pub(crate) eof: bool,
+ /// The working buffer.
+ pub(crate) buffer: yaml_buffer_t<yaml_char_t>,
+ /// The number of unread characters in the buffer.
+ pub(crate) unread: size_t,
+ /// The raw buffer.
+ pub(crate) raw_buffer: yaml_buffer_t<libc::c_uchar>,
+ /// The input encoding.
+ pub(crate) encoding: yaml_encoding_t,
+ /// The offset of the current position (in bytes).
+ pub(crate) offset: size_t,
+ /// The mark of the current position.
+ pub(crate) mark: yaml_mark_t,
+ /// Have we started to scan the input stream?
+ pub(crate) stream_start_produced: bool,
+ /// Have we reached the end of the input stream?
+ pub(crate) stream_end_produced: bool,
+ /// The number of unclosed '[' and '{' indicators.
+ pub(crate) flow_level: libc::c_int,
+ /// The tokens queue.
+ pub(crate) tokens: yaml_queue_t<yaml_token_t>,
+ /// The number of tokens fetched from the queue.
+ pub(crate) tokens_parsed: size_t,
+ /// Does the tokens queue contain a token ready for dequeueing.
+ pub(crate) token_available: bool,
+ /// The indentation levels stack.
+ pub(crate) indents: yaml_stack_t<libc::c_int>,
+ /// The current indentation level.
+ pub(crate) indent: libc::c_int,
+ /// May a simple key occur at the current position?
+ pub(crate) simple_key_allowed: bool,
+ /// The stack of simple keys.
+ pub(crate) simple_keys: yaml_stack_t<yaml_simple_key_t>,
+ /// The parser states stack.
+ pub(crate) states: yaml_stack_t<yaml_parser_state_t>,
+ /// The current parser state.
+ pub(crate) state: yaml_parser_state_t,
+ /// The stack of marks.
+ pub(crate) marks: yaml_stack_t<yaml_mark_t>,
+ /// The list of TAG directives.
+ pub(crate) tag_directives: yaml_stack_t<yaml_tag_directive_t>,
+ /// The alias data.
+ pub(crate) aliases: yaml_stack_t<yaml_alias_data_t>,
+ /// The currently parsed document.
+ pub(crate) document: *mut yaml_document_t,
+}
+
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_parser_t_prefix {
+ /// Error type.
+ pub error: yaml_error_type_t,
+ /// Error description.
+ pub problem: *const libc::c_char,
+ /// The byte about which the problem occured.
+ pub problem_offset: size_t,
+ /// The problematic value (-1 is none).
+ pub problem_value: libc::c_int,
+ /// The problem position.
+ pub problem_mark: yaml_mark_t,
+ /// The error context.
+ pub context: *const libc::c_char,
+ /// The context position.
+ pub context_mark: yaml_mark_t,
+}
+
+#[doc(hidden)]
+impl Deref for yaml_parser_t {
+ type Target = yaml_parser_t_prefix;
+ fn deref(&self) -> &Self::Target {
+ unsafe { &*addr_of!(*self).cast() }
+ }
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) union unnamed_yaml_parser_t_input {
+ /// String input data.
+ pub string: unnamed_yaml_parser_t_input_string,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct unnamed_yaml_parser_t_input_string {
+ /// The string start pointer.
+ pub start: *const libc::c_uchar,
+ /// The string end pointer.
+ pub end: *const libc::c_uchar,
+ /// The string current position.
+ pub current: *const libc::c_uchar,
+}
+
+/// The prototype of a write handler.
+///
+/// The write handler is called when the emitter needs to flush the accumulated
+/// characters to the output. The handler should write `size` bytes of the
+/// `buffer` to the output.
+///
+/// On success, the handler should return 1. If the handler failed, the returned
+/// value should be 0.
+pub type yaml_write_handler_t =
+ unsafe fn(data: *mut libc::c_void, buffer: *mut libc::c_uchar, size: size_t) -> libc::c_int;
+
+/// The emitter states.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
+#[repr(u32)]
+#[non_exhaustive]
+pub enum yaml_emitter_state_t {
+ /// Expect STREAM-START.
+ YAML_EMIT_STREAM_START_STATE = 0,
+ /// Expect the first DOCUMENT-START or STREAM-END.
+ YAML_EMIT_FIRST_DOCUMENT_START_STATE = 1,
+ /// Expect DOCUMENT-START or STREAM-END.
+ YAML_EMIT_DOCUMENT_START_STATE = 2,
+ /// Expect the content of a document.
+ YAML_EMIT_DOCUMENT_CONTENT_STATE = 3,
+ /// Expect DOCUMENT-END.
+ YAML_EMIT_DOCUMENT_END_STATE = 4,
+ /// Expect the first item of a flow sequence.
+ YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE = 5,
+ /// Expect an item of a flow sequence.
+ YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE = 6,
+ /// Expect the first key of a flow mapping.
+ YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE = 7,
+ /// Expect a key of a flow mapping.
+ YAML_EMIT_FLOW_MAPPING_KEY_STATE = 8,
+ /// Expect a value for a simple key of a flow mapping.
+ YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE = 9,
+ /// Expect a value of a flow mapping.
+ YAML_EMIT_FLOW_MAPPING_VALUE_STATE = 10,
+ /// Expect the first item of a block sequence.
+ YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE = 11,
+ /// Expect an item of a block sequence.
+ YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE = 12,
+ /// Expect the first key of a block mapping.
+ YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE = 13,
+ /// Expect the key of a block mapping.
+ YAML_EMIT_BLOCK_MAPPING_KEY_STATE = 14,
+ /// Expect a value for a simple key of a block mapping.
+ YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE = 15,
+ /// Expect a value of a block mapping.
+ YAML_EMIT_BLOCK_MAPPING_VALUE_STATE = 16,
+ /// Expect nothing.
+ YAML_EMIT_END_STATE = 17,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct yaml_anchors_t {
+ /// The number of references.
+ pub references: libc::c_int,
+ /// The anchor id.
+ pub anchor: libc::c_int,
+ /// If the node has been emitted?
+ pub serialized: bool,
+}
+
+/// The emitter structure.
+///
+/// All members are internal. Manage the structure using the `yaml_emitter_`
+/// family of functions.
+#[derive(Copy, Clone)]
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_emitter_t {
+ /// Error type.
+ #[cfg(doc)]
+ pub error: yaml_error_type_t,
+ #[cfg(not(doc))]
+ pub(crate) error: yaml_error_type_t,
+ /// Error description.
+ #[cfg(doc)]
+ pub problem: *const libc::c_char,
+ #[cfg(not(doc))]
+ pub(crate) problem: *const libc::c_char,
+ /// Write handler.
+ pub(crate) write_handler: Option<yaml_write_handler_t>,
+ /// A pointer for passing to the write handler.
+ pub(crate) write_handler_data: *mut libc::c_void,
+ /// Standard (string or file) output data.
+ pub(crate) output: unnamed_yaml_emitter_t_output,
+ /// The working buffer.
+ pub(crate) buffer: yaml_buffer_t<yaml_char_t>,
+ /// The raw buffer.
+ pub(crate) raw_buffer: yaml_buffer_t<libc::c_uchar>,
+ /// The stream encoding.
+ pub(crate) encoding: yaml_encoding_t,
+ /// If the output is in the canonical style?
+ pub(crate) canonical: bool,
+ /// The number of indentation spaces.
+ pub(crate) best_indent: libc::c_int,
+ /// The preferred width of the output lines.
+ pub(crate) best_width: libc::c_int,
+ /// Allow unescaped non-ASCII characters?
+ pub(crate) unicode: bool,
+ /// The preferred line break.
+ pub(crate) line_break: yaml_break_t,
+ /// The stack of states.
+ pub(crate) states: yaml_stack_t<yaml_emitter_state_t>,
+ /// The current emitter state.
+ pub(crate) state: yaml_emitter_state_t,
+ /// The event queue.
+ pub(crate) events: yaml_queue_t<yaml_event_t>,
+ /// The stack of indentation levels.
+ pub(crate) indents: yaml_stack_t<libc::c_int>,
+ /// The list of tag directives.
+ pub(crate) tag_directives: yaml_stack_t<yaml_tag_directive_t>,
+ /// The current indentation level.
+ pub(crate) indent: libc::c_int,
+ /// The current flow level.
+ pub(crate) flow_level: libc::c_int,
+ /// Is it the document root context?
+ pub(crate) root_context: bool,
+ /// Is it a sequence context?
+ pub(crate) sequence_context: bool,
+ /// Is it a mapping context?
+ pub(crate) mapping_context: bool,
+ /// Is it a simple mapping key context?
+ pub(crate) simple_key_context: bool,
+ /// The current line.
+ pub(crate) line: libc::c_int,
+ /// The current column.
+ pub(crate) column: libc::c_int,
+ /// If the last character was a whitespace?
+ pub(crate) whitespace: bool,
+ /// If the last character was an indentation character (' ', '-', '?', ':')?
+ pub(crate) indention: bool,
+ /// If an explicit document end is required?
+ pub(crate) open_ended: libc::c_int,
+ /// Anchor analysis.
+ pub(crate) anchor_data: unnamed_yaml_emitter_t_anchor_data,
+ /// Tag analysis.
+ pub(crate) tag_data: unnamed_yaml_emitter_t_tag_data,
+ /// Scalar analysis.
+ pub(crate) scalar_data: unnamed_yaml_emitter_t_scalar_data,
+ /// If the stream was already opened?
+ pub(crate) opened: bool,
+ /// If the stream was already closed?
+ pub(crate) closed: bool,
+ /// The information associated with the document nodes.
+ pub(crate) anchors: *mut yaml_anchors_t,
+ /// The last assigned anchor id.
+ pub(crate) last_anchor_id: libc::c_int,
+ /// The currently emitted document.
+ pub(crate) document: *mut yaml_document_t,
+}
+
+#[repr(C)]
+#[non_exhaustive]
+pub struct yaml_emitter_t_prefix {
+ /// Error type.
+ pub error: yaml_error_type_t,
+ /// Error description.
+ pub problem: *const libc::c_char,
+}
+
+#[doc(hidden)]
+impl Deref for yaml_emitter_t {
+ type Target = yaml_emitter_t_prefix;
+ fn deref(&self) -> &Self::Target {
+ unsafe { &*addr_of!(*self).cast() }
+ }
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) union unnamed_yaml_emitter_t_output {
+ /// String output data.
+ pub string: unnamed_yaml_emitter_t_output_string,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct unnamed_yaml_emitter_t_output_string {
+ /// The buffer pointer.
+ pub buffer: *mut libc::c_uchar,
+ /// The buffer size.
+ pub size: size_t,
+ /// The number of written bytes.
+ pub size_written: *mut size_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct unnamed_yaml_emitter_t_anchor_data {
+ /// The anchor value.
+ pub anchor: *mut yaml_char_t,
+ /// The anchor length.
+ pub anchor_length: size_t,
+ /// Is it an alias?
+ pub alias: bool,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct unnamed_yaml_emitter_t_tag_data {
+ /// The tag handle.
+ pub handle: *mut yaml_char_t,
+ /// The tag handle length.
+ pub handle_length: size_t,
+ /// The tag suffix.
+ pub suffix: *mut yaml_char_t,
+ /// The tag suffix length.
+ pub suffix_length: size_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct unnamed_yaml_emitter_t_scalar_data {
+ /// The scalar value.
+ pub value: *mut yaml_char_t,
+ /// The scalar length.
+ pub length: size_t,
+ /// Does the scalar contain line breaks?
+ pub multiline: bool,
+ /// Can the scalar be expessed in the flow plain style?
+ pub flow_plain_allowed: bool,
+ /// Can the scalar be expressed in the block plain style?
+ pub block_plain_allowed: bool,
+ /// Can the scalar be expressed in the single quoted style?
+ pub single_quoted_allowed: bool,
+ /// Can the scalar be expressed in the literal or folded styles?
+ pub block_allowed: bool,
+ /// The output style.
+ pub style: yaml_scalar_style_t,
+}
+
+#[derive(Copy, Clone)]
+#[repr(C)]
+pub(crate) struct yaml_string_t {
+ pub start: *mut yaml_char_t,
+ pub end: *mut yaml_char_t,
+ pub pointer: *mut yaml_char_t,
+}
+
+pub(crate) const NULL_STRING: yaml_string_t = yaml_string_t {
+ start: ptr::null_mut::<yaml_char_t>(),
+ end: ptr::null_mut::<yaml_char_t>(),
+ pointer: ptr::null_mut::<yaml_char_t>(),
+};
+
+#[repr(C)]
+pub(crate) struct yaml_buffer_t<T> {
+ /// The beginning of the buffer.
+ pub start: *mut T,
+ /// The end of the buffer.
+ pub end: *mut T,
+ /// The current position of the buffer.
+ pub pointer: *mut T,
+ /// The last filled position of the buffer.
+ pub last: *mut T,
+}
+
+impl<T> Copy for yaml_buffer_t<T> {}
+impl<T> Clone for yaml_buffer_t<T> {
+ fn clone(&self) -> Self {
+ *self
+ }
+}
+
+#[repr(C)]
+pub struct yaml_stack_t<T> {
+ /// The beginning of the stack.
+ pub start: *mut T,
+ /// The end of the stack.
+ pub end: *mut T,
+ /// The top of the stack.
+ pub top: *mut T,
+}
+
+impl<T> Copy for yaml_stack_t<T> {}
+impl<T> Clone for yaml_stack_t<T> {
+ fn clone(&self) -> Self {
+ *self
+ }
+}
+
+#[repr(C)]
+pub(crate) struct yaml_queue_t<T> {
+ /// The beginning of the queue.
+ pub start: *mut T,
+ /// The end of the queue.
+ pub end: *mut T,
+ /// The head of the queue.
+ pub head: *mut T,
+ /// The tail of the queue.
+ pub tail: *mut T,
+}
+
+impl<T> Copy for yaml_queue_t<T> {}
+impl<T> Clone for yaml_queue_t<T> {
+ fn clone(&self) -> Self {
+ *self
+ }
+}
diff --git a/crates/unsafe-libyaml/tests/bin/mod.rs b/crates/unsafe-libyaml/tests/bin/mod.rs
new file mode 100644
index 0000000..0500980
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/bin/mod.rs
@@ -0,0 +1,48 @@
+use std::error::Error;
+use std::fs::File;
+use std::io::{Read, Write};
+use std::path::Path;
+use std::process::{Command, Stdio};
+
+pub struct Output {
+ pub success: bool,
+ pub stdout: Vec<u8>,
+ pub stderr: Vec<u8>,
+}
+
+pub fn run(
+ compiled: &str,
+ unsafe_main: unsafe fn(
+ stdin: &mut dyn Read,
+ stdout: &mut dyn Write,
+ ) -> Result<(), Box<dyn Error>>,
+ input: &Path,
+) -> Output {
+ if cfg!(miri) {
+ let mut input = File::open(input).unwrap();
+ let mut stdout = Vec::new();
+ let result = unsafe { unsafe_main(&mut input, &mut stdout) };
+
+ Output {
+ success: result.is_ok(),
+ stdout,
+ stderr: result
+ .err()
+ .as_ref()
+ .map_or_else(String::new, ToString::to_string)
+ .into(),
+ }
+ } else {
+ let output = Command::new(compiled)
+ .arg(input)
+ .stdin(Stdio::null())
+ .output()
+ .unwrap();
+
+ Output {
+ success: output.status.success(),
+ stdout: output.stdout,
+ stderr: output.stderr,
+ }
+ }
+}
diff --git a/crates/unsafe-libyaml/tests/ignorelist/libyaml-emitter b/crates/unsafe-libyaml/tests/ignorelist/libyaml-emitter
new file mode 100644
index 0000000..b52000f
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/ignorelist/libyaml-emitter
@@ -0,0 +1,72 @@
+26DV: Whitespace around colon in mappings
+2EBW: Allowed characters in keys
+2JQS: Block Mapping with Missing Keys
+2LFX: Spec Example 6.13. Reserved Directives [1.3]
+2SXE: Anchors With Colon in Name
+2XXW: Spec Example 2.25. Unordered Sets
+3MYT: Plain Scalar looking like key, comment, anchor and tag
+4ABK: Spec Example 7.17. Flow Mapping Separate Values
+4MUZ: Flow mapping colon on line after key
+4QFQ: Spec Example 8.2. Block Indentation Indicator [1.3]
+52DL: Explicit Non-Specific Tag [1.3]
+565N: Construct Binary
+5TYM: Spec Example 6.21. Local Tag Prefix
+5WE3: Spec Example 8.17. Explicit Block Mapping Entries
+6CK3: Spec Example 6.26. Tag Shorthands
+6FWR: Block Scalar Keep
+6KGN: Anchor for empty node
+6M2F: Aliases in Explicit Block Mapping
+6PBE: Zero-indented sequences in explicit mapping keys
+6SLA: Allowed characters in quoted mapping key
+6WLZ: Spec Example 6.18. Primary Tag Handle [1.3]
+6WPF: Spec Example 6.8. Flow Folding [1.3]
+6XDY: Two document start markers
+6ZKB: Spec Example 9.6. Stream
+7T8X: Spec Example 8.10. Folded Lines - 8.13. Final Empty Lines
+7W2P: Block Mapping with Missing Values
+7Z25: Bare document after document end marker
+8KB6: Multiline plain flow mapping key without value
+8XYN: Anchor with unicode character
+9BXH: Multiline doublequoted flow mapping key without value
+8MK2: Explicit Non-Specific Tag
+9DXL: Spec Example 9.6. Stream [1.3]
+9MMW: Spec Example 7.21. Single Pair Implicit Entries [1.3
+9TFX: Spec Example 7.6. Double Quoted Lines [1.3]
+B3HG: Spec Example 8.9. Folded Scalar [1.3]
+C2DT: Spec Example 7.18. Flow Mapping Adjacent Values
+DFF7: Spec Example 7.16. Flow Mapping Entries
+E76Z: Aliases in Implicit Block Mapping
+EX5H: Multiline Scalar at Top Level [1.3]
+EXG3: Three dashes and content without space [1.3]
+FBC9: Allowed characters in plain scalars
+FH7J: Tags on Empty Scalars
+FRK4: Spec Example 7.3. Completely Empty Flow Nodes
+J3BT: Spec Example 5.12. Tabs and Spaces
+JDH8: Plain Scalar looking like key, comment, anchor and tag [1.3]
+JTV5: Block Mapping with Multiline Scalars
+K54U: Tab after document header
+KK5P: Various combinations of explicit block mappings
+KSS4: Scalars on --- line
+KZN9: Spec Example 7.21. Single Pair Implicit Entries
+LE5A: Spec Example 7.24. Flow Nodes
+M7A3: Spec Example 9.3. Bare Documents
+M9B4: Spec Example 8.7. Literal Scalar
+NAT4: Various empty or newline only quoted strings
+NHX8: Empty Lines at End of Document
+PUW8: Document start on last line
+PW8X: Anchors on Empty Scalars
+Q8AD: Spec Example 7.5. Double Quoted Line Breaks [1.3]
+S3PD: Spec Example 8.18. Implicit Block Mapping Entries
+S4JQ: Spec Example 6.28. Non-Specific Tags
+T26H: Spec Example 8.8. Literal Content [1.3]
+T4YY: Spec Example 7.9. Single Quoted Lines [1.3]
+T5N4: Spec Example 8.7. Literal Scalar [1.3]
+UT92: Spec Example 9.4. Explicit Documents
+W42U: Spec Example 8.15. Block Sequence Entry Types
+W4TN: Spec Example 9.5. Directives Documents
+W5VH: Allowed characters in alias
+WZ62: Spec Example 7.2. Empty Content
+X38W: Aliases in Flow Objects
+XLQ9: Multiline scalar that looks like a YAML directive
+Y2GN: Anchor with colon in the middle
+ZWK4: Key with anchor after missing explicit mapping value
diff --git a/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser b/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser
new file mode 100644
index 0000000..94029f6
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser
@@ -0,0 +1,34 @@
+2JQS: Block Mapping with Missing Keys
+2LFX: Spec Example 6.13. Reserved Directives [1.3]
+2SXE: Anchors With Colon in Name
+4ABK: Spec Example 7.17. Flow Mapping Separate Values
+4MUZ: Flow mapping colon on line after key
+5MUD: Colon and adjacent value on next line
+6BCT: Spec Example 6.3. Separation Spaces
+6LVF: Spec Example 6.13. Reserved Directives
+6M2F: Aliases in Explicit Block Mapping
+7Z25: Bare document after document end marker
+8XYN: Anchor with unicode character
+9MMW: Spec Example 7.21. Single Pair Implicit Entries [1.3
+9SA2: Multiline double quoted flow mapping key
+A2M4: Spec Example 6.2. Indentation Indicators
+BEC7: Spec Example 6.14. “YAML” directive
+DBG4: Spec Example 7.10. Plain Characters
+DK3J: Zero indented block scalar with line that looks like a comment
+FP8R: Zero indented block scalar
+FRK4: Spec Example 7.3. Completely Empty Flow Nodes
+HWV9: Document-end marker
+K3WX: Colon and adjacent value after comment on next line
+KZN9: Spec Example 7.21. Single Pair Implicit Entries
+M7A3: Spec Example 9.3. Bare Documents
+NHX8: Empty Lines at End of Document
+NJ66: Multiline plain flow mapping key
+Q5MG: Tab at beginning of line followed by a flow mapping
+QT73: Comment and document-end marker
+R4YG: Spec Example 8.2. Block Indentation Indicator
+S3PD: Spec Example 8.18. Implicit Block Mapping Entries
+UT92: Spec Example 9.4. Explicit Documents
+W4TN: Spec Example 9.5. Directives Documents
+W5VH: Allowed characters in alias
+WZ62: Spec Example 7.2. Empty Content
+Y2GN: Anchor with colon in the middle
diff --git a/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser-error b/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser-error
new file mode 100644
index 0000000..aa83f1a
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/ignorelist/libyaml-parser-error
@@ -0,0 +1,10 @@
+9C9N: Wrong indented flow sequence
+9HCY: Need document footer before directives
+9JBA: Invalid comment after end of flow sequence
+CVW2: Invalid comment after comma
+EB22: Missing document-end marker before directive
+QB6E: Wrong indented multiline quoted scalar
+RHX7: YAML directive without document end marker
+S98Z: Block scalar with more spaces than first content line
+SU5Z: Comment without whitespace after doublequoted scalar
+X4QW: Comment without whitespace after block scalar indicator
diff --git a/crates/unsafe-libyaml/tests/test_emitter.rs b/crates/unsafe-libyaml/tests/test_emitter.rs
new file mode 100644
index 0000000..852be2c
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/test_emitter.rs
@@ -0,0 +1,37 @@
+#![allow(clippy::type_complexity)]
+
+mod bin;
+#[path = "../src/bin/run-emitter-test-suite.rs"]
+#[allow(dead_code)]
+mod run_emitter_test_suite;
+
+use std::fs;
+use std::path::Path;
+
+fn test(id: &str) {
+ let dir = Path::new("tests")
+ .join("data")
+ .join("yaml-test-suite")
+ .join(id);
+
+ let output = bin::run(
+ env!("CARGO_BIN_EXE_run-emitter-test-suite"),
+ run_emitter_test_suite::unsafe_main,
+ &dir.join("test.event"),
+ );
+
+ let stdout = String::from_utf8_lossy(&output.stdout);
+ let stderr = String::from_utf8_lossy(&output.stderr);
+ eprint!("{}", stderr);
+
+ let out = if dir.join("out.yaml").exists() {
+ dir.join("out.yaml")
+ } else {
+ dir.join("in.yaml")
+ };
+ let expected = fs::read_to_string(out).unwrap();
+ pretty_assertions::assert_str_eq!(expected, stdout);
+ assert!(output.success);
+}
+
+unsafe_libyaml_test_suite::test_emitter!();
diff --git a/crates/unsafe-libyaml/tests/test_parser.rs b/crates/unsafe-libyaml/tests/test_parser.rs
new file mode 100644
index 0000000..190db26
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/test_parser.rs
@@ -0,0 +1,32 @@
+#![allow(clippy::type_complexity)]
+
+mod bin;
+#[path = "../src/bin/run-parser-test-suite.rs"]
+#[allow(dead_code)]
+mod run_parser_test_suite;
+
+use std::fs;
+use std::path::Path;
+
+fn test(id: &str) {
+ let dir = Path::new("tests")
+ .join("data")
+ .join("yaml-test-suite")
+ .join(id);
+
+ let output = bin::run(
+ env!("CARGO_BIN_EXE_run-parser-test-suite"),
+ run_parser_test_suite::unsafe_main,
+ &dir.join("in.yaml"),
+ );
+
+ let stdout = String::from_utf8_lossy(&output.stdout);
+ let stderr = String::from_utf8_lossy(&output.stderr);
+ eprint!("{}", stderr);
+
+ let expected = fs::read_to_string(dir.join("test.event")).unwrap();
+ pretty_assertions::assert_str_eq!(expected, stdout);
+ assert!(output.success);
+}
+
+unsafe_libyaml_test_suite::test_parser!();
diff --git a/crates/unsafe-libyaml/tests/test_parser_error.rs b/crates/unsafe-libyaml/tests/test_parser_error.rs
new file mode 100644
index 0000000..9473de8
--- /dev/null
+++ b/crates/unsafe-libyaml/tests/test_parser_error.rs
@@ -0,0 +1,31 @@
+#![allow(clippy::type_complexity)]
+
+mod bin;
+#[path = "../src/bin/run-parser-test-suite.rs"]
+#[allow(dead_code)]
+mod run_parser_test_suite;
+
+use std::path::Path;
+
+fn test(id: &str) {
+ let dir = Path::new("tests")
+ .join("data")
+ .join("yaml-test-suite")
+ .join(id);
+
+ let output = bin::run(
+ env!("CARGO_BIN_EXE_run-parser-test-suite"),
+ run_parser_test_suite::unsafe_main,
+ &dir.join("in.yaml"),
+ );
+
+ if output.success {
+ let stdout = String::from_utf8_lossy(&output.stdout);
+ let stderr = String::from_utf8_lossy(&output.stderr);
+ eprint!("{}", stdout);
+ eprint!("{}", stderr);
+ panic!("expected parse to fail");
+ }
+}
+
+unsafe_libyaml_test_suite::test_parser_error!();
diff --git a/crates/userfaultfd/.cargo-checksum.json b/crates/userfaultfd/.cargo-checksum.json
new file mode 100644
index 0000000..134cb1f
--- /dev/null
+++ b/crates/userfaultfd/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"24c349af44513c6b6203528abfa52cb005cfc2a981f38dd02232164a4e3946d0","Cargo.lock":"3cf3621a6c16698afea83cdaf4dbe26dc9c8d9c6bd0e28872ecd1c9abe2acafc","Cargo.toml":"0afefada80af75eddf1efa4f5b7a6115e92ea2f3d2990d0f7cf0d9add0918373","LICENSE-APACHE":"62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"b74b3340c43ac4cb62222f7227679ae126932dc2a2bc3531db90f19c979b1f2c","SECURITY.md":"3b5277e9f160125b292f3b89495b4c415c9e0bb7e408cdaf74e962771b44bd20","examples/manpage.rs":"874a315962c0fa25d57fcdd36c3e017db0c5a6f1fe0e54c66150dd78995e065c","src/builder.rs":"aff3fd9d56cd55f7600ff4344d36d906770052fdc0249b2ea4836bfa91bad7c1","src/error.rs":"19ecfa61b7c1a5e7ae538f4600397306590cca0a69ff763d7c2782e08dbd9f5b","src/event.rs":"487969707beecfadc24341cdd9f875af53621c30562a4e07aff4c01dbd198919","src/lib.rs":"ade7645789182453a991996abeb1479452809020658e30cf8b3af67f4acbc4e8","src/raw.rs":"1f87cc5209b9942491a848e6834f6e3bde3d98c86b553b6f4907bf860cd9992a","tests/manpage_example.rs":"8bf6d190b6b21243e85118133dafd698009cad9509be229a29e0a75889205751"},"package":"b6a38c7e24af201e66f02659492f86ccd5efa9fd62f2c851fff3961a60e81966"}
\ No newline at end of file
diff --git a/crates/userfaultfd/Android.bp b/crates/userfaultfd/Android.bp
new file mode 100644
index 0000000..073ed2c
--- /dev/null
+++ b/crates/userfaultfd/Android.bp
@@ -0,0 +1,39 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_userfaultfd_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_userfaultfd_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libuserfaultfd",
+ host_supported: true,
+ crate_name: "userfaultfd",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.7.0",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: ["default"],
+ rustlibs: [
+ "libbitflags",
+ "libcfg_if",
+ "liblibc",
+ "libnix",
+ "libthiserror",
+ "libuserfaultfd_sys",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/userfaultfd/CHANGELOG.md b/crates/userfaultfd/CHANGELOG.md
new file mode 100755
index 0000000..b0797ad
--- /dev/null
+++ b/crates/userfaultfd/CHANGELOG.md
@@ -0,0 +1,49 @@
+### Unreleased
+
+- Added `Uffd::read_events` that can read multiple events from the userfaultfd file descriptor.
+- Updated `bitflags` dependency to `2.2.1`.
+- Use `/dev/userfaultfd` as the default API for creating userfaultfd file descriptors.
+
+ Since Linux 5.11 a process can select if it wants to handle page faults triggered in kernel space
+ or not. Under this mechanism, processes that wish to handle those, need to have `CAP_SYS_PTRACE`
+ capability. `CAP_SYS_PTRACE` allows a process to do much more than create userfault fds, so with
+ 6.1 Linux introduces `/dev/userfaultfd`, a special character device that allows creating
+ userfault file descriptors using the `USERFAULTFD_IOC_NEW` `ioctl`. Access to this device is
+ granted via file system permissions and does not require `CAP_SYS_PTRACE` to handle kernel
+ triggered page faults.
+
+ We now default to using `/dev/userfaultfd` for creating the descriptors and only if that file is
+ not present, we fall back to using the syscall.
+
+### 0.3.1 (2021-02-17)
+
+- Added support for the `UFFD_FEATURE_THREAD_ID` flag when compiled with the `linux4_14` Cargo
+ feature.
+
+### 0.3.0 (2021-02-03)
+
+- Update `bindgen` dependency of `userfaultfd-sys` to `0.57`. Thank you @jgowans
+
+### 0.2.1 (2020-11-20)
+
+- Make `ReadWrite` public. Thank you @electroCutie
+
+### 0.2.0 (2020-04-10)
+
+- Removed the compile-time Linux version check, and replaced it with a Cargo feature.
+
+ The Linux version check was overly restrictive, even on systems that did have the right kernel
+ version installed but had older headers in `/usr/include/linux`. Beyond that, this check made it
+ more difficult to compile on a different host than what's targeted.
+
+ There is now a `linux4_14` feature flag on `userfaultfd-sys`, which turns on and tests the extra
+ constants available in that version. Since `userfaultfd` did not make use of any of those newer
+ features, it doesn't have a feature flag yet.
+
+ Applications should take care when initializing with `UffdBuilder` to specify the features and
+ ioctls they require, so that an unsupported version will be detected at runtime.
+
+
+### 0.1.0 (2020-04-07)
+
+- Initial public release of userfaultfd-rs.
diff --git a/crates/userfaultfd/Cargo.lock b/crates/userfaultfd/Cargo.lock
new file mode 100644
index 0000000..13fbad0
--- /dev/null
+++ b/crates/userfaultfd/Cargo.lock
@@ -0,0 +1,287 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "aho-corasick"
+version = "1.0.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0c378d78423fdad8089616f827526ee33c19f2fddbd5de1629152c9593ba4783"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "bindgen"
+version = "0.68.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "726e4313eb6ec35d2730258ad4e15b547ee75d6afaa1361a922e78e59b7d8078"
+dependencies = [
+ "bitflags",
+ "cexpr",
+ "clang-sys",
+ "lazy_static",
+ "lazycell",
+ "peeking_take_while",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "rustc-hash",
+ "shlex",
+ "syn",
+]
+
+[[package]]
+name = "bitflags"
+version = "2.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b4682ae6287fcf752ecaabbfcc7b6f9b72aa33933dc23a554d853aea8eea8635"
+
+[[package]]
+name = "cc"
+version = "1.0.83"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f1174fb0b6ec23863f8b971027804a42614e347eafb0a95bf0b12cdae21fc4d0"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "cexpr"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6fac387a98bb7c37292057cffc56d62ecb629900026402633ae9160df93a8766"
+dependencies = [
+ "nom",
+]
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "clang-sys"
+version = "1.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c688fc74432808e3eb684cae8830a86be1d66a2bd58e1f248ed0960a590baf6f"
+dependencies = [
+ "glob",
+ "libc",
+ "libloading",
+]
+
+[[package]]
+name = "glob"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
+
+[[package]]
+name = "lazy_static"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+
+[[package]]
+name = "lazycell"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
+
+[[package]]
+name = "libc"
+version = "0.2.147"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b4668fb0ea861c1df094127ac5f1da3409a82116a4ba74fca2e58ef927159bb3"
+
+[[package]]
+name = "libloading"
+version = "0.7.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b67380fd3b2fbe7527a606e18729d21c6f3951633d0500574c4dc22d2d638b9f"
+dependencies = [
+ "cfg-if",
+ "winapi",
+]
+
+[[package]]
+name = "memchr"
+version = "2.6.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f478948fd84d9f8e86967bf432640e46adfb5a4bd4f14ef7e864ab38220534ae"
+
+[[package]]
+name = "minimal-lexical"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
+
+[[package]]
+name = "nix"
+version = "0.27.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2eb04e9c688eff1c89d72b407f168cf79bb9e867a9d3323ed6c01519eb9cc053"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "libc",
+]
+
+[[package]]
+name = "nom"
+version = "7.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d273983c5a657a70a3e8f2a01329822f3b8c8172b73826411a55751e404a0a4a"
+dependencies = [
+ "memchr",
+ "minimal-lexical",
+]
+
+[[package]]
+name = "peeking_take_while"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19b17cddbe7ec3f8bc800887bab5e717348c95ea2ca0b1bf0837fb964dc67099"
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.66"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "18fb31db3f9bddb2ea821cde30a9f70117e3f119938b5ee630b7403aa6e2ead9"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.33"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5267fca4496028628a95160fc423a33e8b2e6af8a5302579e322e4b520293cae"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "regex"
+version = "1.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "12de2eff854e5fa4b1295edd650e227e9d8fb0c9e90b12e7f36d6a6811791a29"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-automata",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-automata"
+version = "0.3.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49530408a136e16e5b486e883fbb6ba058e8e4e8ae6621a77b048b314336e629"
+dependencies = [
+ "aho-corasick",
+ "memchr",
+ "regex-syntax",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.7.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dbb5fb1acd8a1a18b3dd5be62d25485eb770e05afb408a9627d14d451bae12da"
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
+[[package]]
+name = "shlex"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "43b2853a4d09f215c24cc5489c992ce46052d359b5109343cbafbf26bc62f8a3"
+
+[[package]]
+name = "syn"
+version = "2.0.29"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c324c494eba9d92503e6f1ef2e6df781e78f6a7705a0202d9801b198807d518a"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "thiserror"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "97a802ec30afc17eee47b2855fc72e0c4cd62be9b4efe6591edde0ec5bd68d8f"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "1.0.47"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6bb623b56e39ab7dcd4b1b98bb6c8f8d907ed255b18de254088016b27a8ee19b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "301abaae475aa91687eb82514b328ab47a211a533026cb25fc3e519b86adfc3c"
+
+[[package]]
+name = "userfaultfd"
+version = "0.7.0"
+dependencies = [
+ "bitflags",
+ "cfg-if",
+ "libc",
+ "nix",
+ "thiserror",
+ "userfaultfd-sys",
+]
+
+[[package]]
+name = "userfaultfd-sys"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d75595d2a62b7db16bd47f5a1ce14e1fe05ccbe27d6c96721a958e0a027cad41"
+dependencies = [
+ "bindgen",
+ "cc",
+ "cfg-if",
+]
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
diff --git a/crates/userfaultfd/Cargo.toml b/crates/userfaultfd/Cargo.toml
new file mode 100644
index 0000000..a43c013
--- /dev/null
+++ b/crates/userfaultfd/Cargo.toml
@@ -0,0 +1,55 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "userfaultfd"
+version = "0.7.0"
+authors = ["The Wasmtime Project Developers"]
+description = "Rust bindings for the Linux userfaultfd functionality"
+readme = "README.md"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/bytecodealliance/userfaultfd-rs"
+
+[dependencies.bitflags]
+version = "2.2.1"
+
+[dependencies.cfg-if]
+version = "^1.0.0"
+
+[dependencies.libc]
+version = "0.2.65"
+
+[dependencies.nix]
+version = "0.27"
+features = ["ioctl"]
+
+[dependencies.thiserror]
+version = "1.0.4"
+
+[dependencies.userfaultfd-sys]
+version = "^0.5.0"
+
+[dev-dependencies.nix]
+version = "0.27"
+features = [
+ "poll",
+ "mman",
+ "feature",
+]
+
+[features]
+default = []
+linux4_14 = [
+ "userfaultfd-sys/linux4_14",
+ "nix/process",
+]
+linux5_7 = ["userfaultfd-sys/linux5_7"]
diff --git a/crates/userfaultfd/LICENSE b/crates/userfaultfd/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/userfaultfd/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/userfaultfd/LICENSE-APACHE b/crates/userfaultfd/LICENSE-APACHE
new file mode 100644
index 0000000..1b5ec8b
--- /dev/null
+++ b/crates/userfaultfd/LICENSE-APACHE
@@ -0,0 +1,176 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
diff --git a/crates/userfaultfd/LICENSE-MIT b/crates/userfaultfd/LICENSE-MIT
new file mode 100644
index 0000000..31aa793
--- /dev/null
+++ b/crates/userfaultfd/LICENSE-MIT
@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/userfaultfd/METADATA b/crates/userfaultfd/METADATA
new file mode 100644
index 0000000..08e2200
--- /dev/null
+++ b/crates/userfaultfd/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/userfaultfd
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "userfaultfd"
+description: "Rust bindings for the Linux userfaultfd functionality"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 12
+ day: 16
+ }
+ homepage: "https://crates.io/crates/userfaultfd"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/userfaultfd/userfaultfd-0.7.0.crate"
+ version: "0.7.0"
+ }
+}
diff --git a/crates/userfaultfd/MODULE_LICENSE_APACHE2 b/crates/userfaultfd/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/userfaultfd/MODULE_LICENSE_APACHE2
diff --git a/crates/userfaultfd/README.md b/crates/userfaultfd/README.md
new file mode 100644
index 0000000..d485743
--- /dev/null
+++ b/crates/userfaultfd/README.md
@@ -0,0 +1,11 @@
+
+
+# Userfaultfd-rs
+Rust bindings for Linux's userfaultfd functionality.
+
+## License
+
+This software is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
+
+See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT).
+
diff --git a/crates/userfaultfd/SECURITY.md b/crates/userfaultfd/SECURITY.md
new file mode 100644
index 0000000..555ec87
--- /dev/null
+++ b/crates/userfaultfd/SECURITY.md
@@ -0,0 +1,9 @@
+## Report a security issue
+
+Fastly welcomes security reports and is committed to providing prompt attention to security issues. Security issues should be reported privately via [Fastly’s security issue reporting process](https://www.fastly.com/security/report-security-issue).
+
+## Security advisories
+
+Remediation of security vulnerabilities is prioritized. The project team endeavors to coordinate remediation with third-party stakeholders, and is committed to transparency in the disclosure process. The team announces security issues via release notes as well as the [RustSec advisory database](https://github.com/RustSec/advisory-db) (i.e. `cargo-audit`) on a best-effort basis.
+
+Note that communications related to security issues in Fastly-maintained OSS as described here are distinct from [Fastly Security Advisories](https://www.fastly.com/security-advisories).
diff --git a/crates/userfaultfd/cargo_embargo.json b/crates/userfaultfd/cargo_embargo.json
new file mode 100644
index 0000000..cb908d7
--- /dev/null
+++ b/crates/userfaultfd/cargo_embargo.json
@@ -0,0 +1,3 @@
+{
+ "run_cargo": false
+}
diff --git a/crates/userfaultfd/examples/manpage.rs b/crates/userfaultfd/examples/manpage.rs
new file mode 100644
index 0000000..1de593e
--- /dev/null
+++ b/crates/userfaultfd/examples/manpage.rs
@@ -0,0 +1,134 @@
+//! Port of the example from the `userfaultfd` manpage.
+use libc::{self, c_void};
+use nix::poll::{poll, PollFd, PollFlags};
+use nix::sys::mman::{mmap, MapFlags, ProtFlags};
+use nix::unistd::{sysconf, SysconfVar};
+use std::{convert::TryInto, env};
+use userfaultfd::{Event, Uffd, UffdBuilder};
+
+fn fault_handler_thread(uffd: Uffd) {
+ let page_size = sysconf(SysconfVar::PAGE_SIZE).unwrap().unwrap() as usize;
+
+ // Create a page that will be copied into the faulting region
+
+ let page = unsafe {
+ mmap(
+ None,
+ page_size.try_into().unwrap(),
+ ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
+ MapFlags::MAP_PRIVATE | MapFlags::MAP_ANONYMOUS,
+ None::<std::os::fd::BorrowedFd>,
+ 0,
+ )
+ .expect("mmap")
+ };
+
+ // Loop, handling incoming events on the userfaultfd file descriptor
+
+ let mut fault_cnt = 0;
+ loop {
+ // See what poll() tells us about the userfaultfd
+
+ let pollfd = PollFd::new(&uffd, PollFlags::POLLIN);
+ let nready = poll(&mut [pollfd], -1).expect("poll");
+
+ println!("\nfault_handler_thread():");
+ let revents = pollfd.revents().unwrap();
+ println!(
+ " poll() returns: nready = {}; POLLIN = {}; POLLERR = {}",
+ nready,
+ revents.contains(PollFlags::POLLIN),
+ revents.contains(PollFlags::POLLERR),
+ );
+
+ // Read an event from the userfaultfd
+ let event = uffd
+ .read_event()
+ .expect("read uffd_msg")
+ .expect("uffd_msg ready");
+
+ // We expect only one kind of event; verify that assumption
+
+ if let Event::Pagefault { addr, .. } = event {
+ // Display info about the page-fault event
+
+ println!(" UFFD_EVENT_PAGEFAULT event: {:?}", event);
+
+ // Copy the page pointed to by 'page' into the faulting region. Vary the contents that are
+ // copied in, so that it is more obvious that each fault is handled separately.
+
+ for c in unsafe { std::slice::from_raw_parts_mut(page as *mut u8, page_size) } {
+ *c = b'A' + fault_cnt % 20;
+ }
+ fault_cnt += 1;
+
+ let dst = (addr as usize & !(page_size - 1)) as *mut c_void;
+ let copy = unsafe { uffd.copy(page, dst, page_size, true).expect("uffd copy") };
+
+ println!(" (uffdio_copy.copy returned {})", copy);
+ } else {
+ panic!("Unexpected event on userfaultfd");
+ }
+ }
+}
+
+fn main() {
+ let num_pages = env::args()
+ .nth(1)
+ .expect("Usage: manpage <num_pages>")
+ .parse::<usize>()
+ .unwrap();
+
+ let page_size = sysconf(SysconfVar::PAGE_SIZE).unwrap().unwrap() as usize;
+ let len = num_pages * page_size;
+
+ // Create and enable userfaultfd object
+
+ let uffd = UffdBuilder::new()
+ .close_on_exec(true)
+ .non_blocking(true)
+ .user_mode_only(true)
+ .create()
+ .expect("uffd creation");
+
+ // Create a private anonymous mapping. The memory will be demand-zero paged--that is, not yet
+ // allocated. When we actually touch the memory, it will be allocated via the userfaultfd.
+
+ let addr = unsafe {
+ mmap(
+ None,
+ len.try_into().unwrap(),
+ ProtFlags::PROT_READ | ProtFlags::PROT_WRITE,
+ MapFlags::MAP_PRIVATE | MapFlags::MAP_ANONYMOUS,
+ None::<std::os::fd::BorrowedFd>,
+ 0,
+ )
+ .expect("mmap")
+ };
+
+ println!("Address returned by mmap() = {:p}", addr);
+
+ // Register the memory range of the mapping we just created for handling by the userfaultfd
+ // object. In mode, we request to track missing pages (i.e., pages that have not yet been
+ // faulted in).
+
+ uffd.register(addr, len).expect("uffd.register()");
+
+ // Create a thread that will process the userfaultfd events
+ let _s = std::thread::spawn(move || fault_handler_thread(uffd));
+
+ // Main thread now touches memory in the mapping, touching locations 1024 bytes apart. This will
+ // trigger userfaultfd events for all pages in the region.
+
+ // Ensure that faulting address is not on a page boundary, in order to test that we correctly
+ // handle that case in fault_handling_thread()
+ let mut l = 0xf;
+
+ while l < len {
+ let ptr = (addr as usize + l) as *mut u8;
+ let c = unsafe { *ptr };
+ println!("Read address {:p} in main(): {:?}", ptr, c as char);
+ l += 1024;
+ std::thread::sleep(std::time::Duration::from_micros(100000));
+ }
+}
diff --git a/crates/userfaultfd/src/builder.rs b/crates/userfaultfd/src/builder.rs
new file mode 100644
index 0000000..a200148
--- /dev/null
+++ b/crates/userfaultfd/src/builder.rs
@@ -0,0 +1,198 @@
+use crate::error::{Error, Result};
+use crate::raw;
+use crate::{IoctlFlags, Uffd};
+use bitflags::bitflags;
+use nix::errno::Errno;
+use std::fs::{File, OpenOptions};
+use std::io::ErrorKind;
+use std::os::fd::AsRawFd;
+
+const UFFD_DEVICE_PATH: &str = "/dev/userfaultfd";
+
+cfg_if::cfg_if! {
+ if #[cfg(any(feature = "linux5_7", feature = "linux4_14"))] {
+ bitflags! {
+ /// Used with `UffdBuilder` to determine which features are available in the current kernel.
+ #[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+ pub struct FeatureFlags: u64 {
+ const PAGEFAULT_FLAG_WP = raw::UFFD_FEATURE_PAGEFAULT_FLAG_WP;
+ const EVENT_FORK = raw::UFFD_FEATURE_EVENT_FORK;
+ const EVENT_REMAP = raw::UFFD_FEATURE_EVENT_REMAP;
+ const EVENT_REMOVE = raw::UFFD_FEATURE_EVENT_REMOVE;
+ const MISSING_HUGETLBFS = raw::UFFD_FEATURE_MISSING_HUGETLBFS;
+ const MISSING_SHMEM = raw::UFFD_FEATURE_MISSING_SHMEM;
+ const EVENT_UNMAP = raw::UFFD_FEATURE_EVENT_UNMAP;
+ const SIGBUS = raw::UFFD_FEATURE_SIGBUS;
+ const THREAD_ID = raw::UFFD_FEATURE_THREAD_ID;
+ }
+ }
+ } else {
+ bitflags! {
+ /// Used with `UffdBuilder` to determine which features are available in the current kernel.
+ #[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+ pub struct FeatureFlags: u64 {
+ const PAGEFAULT_FLAG_WP = raw::UFFD_FEATURE_PAGEFAULT_FLAG_WP;
+ const EVENT_FORK = raw::UFFD_FEATURE_EVENT_FORK;
+ const EVENT_REMAP = raw::UFFD_FEATURE_EVENT_REMAP;
+ const EVENT_REMOVE = raw::UFFD_FEATURE_EVENT_REMOVE;
+ const MISSING_HUGETLBFS = raw::UFFD_FEATURE_MISSING_HUGETLBFS;
+ const MISSING_SHMEM = raw::UFFD_FEATURE_MISSING_SHMEM;
+ const EVENT_UNMAP = raw::UFFD_FEATURE_EVENT_UNMAP;
+ }
+ }
+ }
+}
+/// A builder for initializing `Uffd` objects.
+///
+/// ```
+/// use userfaultfd::UffdBuilder;
+///
+/// let uffd = UffdBuilder::new()
+/// .close_on_exec(true)
+/// .non_blocking(true)
+/// .user_mode_only(true)
+/// .create();
+/// assert!(uffd.is_ok());
+/// ```
+pub struct UffdBuilder {
+ close_on_exec: bool,
+ non_blocking: bool,
+ user_mode_only: bool,
+ req_features: FeatureFlags,
+ req_ioctls: IoctlFlags,
+}
+
+impl UffdBuilder {
+ /// Create a new builder with no required features or ioctls, `close_on_exec` and
+ /// `non_blocking` both set to `false`, and `user_mode_only` set to `true`.
+ pub fn new() -> UffdBuilder {
+ UffdBuilder {
+ close_on_exec: false,
+ non_blocking: false,
+ user_mode_only: true,
+ req_features: FeatureFlags::empty(),
+ req_ioctls: IoctlFlags::empty(),
+ }
+ }
+
+ /// Enable the close-on-exec flag for the new userfaultfd object (see the description of
+ /// `O_CLOEXEC` in [`open(2)`](http://man7.org/linux/man-pages/man2/open.2.html)).
+ pub fn close_on_exec(&mut self, close_on_exec: bool) -> &mut Self {
+ self.close_on_exec = close_on_exec;
+ self
+ }
+
+ /// Enable non-blocking operation for the userfaultfd object.
+ ///
+ /// If this is set to `false`, `Uffd::read_event()` will block until an event is available to
+ /// read. Otherwise, it will immediately return `None` if no event is available.
+ pub fn non_blocking(&mut self, non_blocking: bool) -> &mut Self {
+ self.non_blocking = non_blocking;
+ self
+ }
+
+ /// Enable user-mode only flag for the userfaultfd object.
+ ///
+ /// If set to `false`, the process must have the `CAP_SYS_PTRACE` capability starting with Linux 5.11
+ /// or object creation will fail with EPERM. When set to `true`, userfaultfd can't be used
+ /// to handle kernel-mode page faults such as when kernel tries copying data to userspace.
+ ///
+ /// When used with kernels older than 5.11, this has no effect; the process doesn't need
+ /// `CAP_SYS_PTRACE` and can handle kernel-mode page faults.
+ pub fn user_mode_only(&mut self, user_mode_only: bool) -> &mut Self {
+ self.user_mode_only = user_mode_only;
+ self
+ }
+
+ /// Add a requirement that a particular feature or set of features is available.
+ ///
+ /// If a required feature is unavailable, `UffdBuilder.create()` will return an error.
+ pub fn require_features(&mut self, feature: FeatureFlags) -> &mut Self {
+ self.req_features |= feature;
+ self
+ }
+
+ /// Add a requirement that a particular ioctl or set of ioctls is available.
+ ///
+ /// If a required ioctl is unavailable, `UffdBuilder.create()` will return an error.
+ pub fn require_ioctls(&mut self, ioctls: IoctlFlags) -> &mut Self {
+ self.req_ioctls |= ioctls;
+ self
+ }
+
+ fn uffd_from_dev(&self, file: &mut File, flags: i32) -> Result<Uffd> {
+ match unsafe { raw::new_uffd(file.as_raw_fd(), flags) } {
+ Err(err) => Err(err.into()),
+ Ok(fd) => Ok(Uffd { fd }),
+ }
+ }
+
+ fn uffd_from_syscall(&self, flags: i32) -> Result<Uffd> {
+ let fd = match Errno::result(unsafe { raw::userfaultfd(flags) }) {
+ Ok(fd) => fd,
+ // setting the USER_MODE_ONLY flag on kernel pre-5.11 causes it to return EINVAL.
+ // If the user asks for the flag, we first try with it set, and if kernel gives
+ // EINVAL we try again without the flag set.
+ Err(Errno::EINVAL) if self.user_mode_only => Errno::result(unsafe {
+ raw::userfaultfd(flags & !raw::UFFD_USER_MODE_ONLY as i32)
+ })?,
+ Err(e) => return Err(e.into()),
+ };
+
+ // Wrap the fd up so that a failure in this function body closes it with the drop.
+ Ok(Uffd { fd })
+ }
+
+ // Try to get a UFFD file descriptor using `/dev/userfaultfd`. If that fails
+ // fall back to calling the system call.
+ fn open_file_descriptor(&self, flags: i32) -> Result<Uffd> {
+ // If `/dev/userfaultfd` exists we'll try to get the file descriptor from it. If the file
+ // doesn't exist we will fall back to calling the system call. This means, that if the
+ // device exists but the calling process does not have access rights to it, this will fail,
+ // i.e. we will not fall back to calling the system call.
+ match OpenOptions::new()
+ .read(true)
+ .write(true)
+ .open(UFFD_DEVICE_PATH)
+ {
+ Ok(mut file) => self.uffd_from_dev(&mut file, flags),
+ Err(err) if err.kind() == ErrorKind::NotFound => self.uffd_from_syscall(flags),
+ Err(err) => Err(Error::OpenDevUserfaultfd(err)),
+ }
+ }
+
+ /// Create a `Uffd` object with the current settings of this builder.
+ pub fn create(&self) -> Result<Uffd> {
+ // first do the syscall to get the file descriptor
+ let mut flags = 0;
+ if self.close_on_exec {
+ flags |= libc::O_CLOEXEC;
+ }
+ if self.non_blocking {
+ flags |= libc::O_NONBLOCK;
+ }
+
+ if self.user_mode_only {
+ flags |= raw::UFFD_USER_MODE_ONLY as i32;
+ }
+
+ let uffd = self.open_file_descriptor(flags)?;
+
+ // then do the UFFDIO_API ioctl to set up and ensure features and other ioctls are available
+ let mut api = raw::uffdio_api {
+ api: raw::UFFD_API,
+ features: self.req_features.bits(),
+ ioctls: 0,
+ };
+ unsafe {
+ raw::api(uffd.fd, &mut api as *mut raw::uffdio_api)?;
+ }
+ let supported =
+ IoctlFlags::from_bits(api.ioctls).ok_or(Error::UnrecognizedIoctls(api.ioctls))?;
+ if !supported.contains(self.req_ioctls) {
+ Err(Error::UnsupportedIoctls(supported))
+ } else {
+ Ok(uffd)
+ }
+ }
+}
diff --git a/crates/userfaultfd/src/error.rs b/crates/userfaultfd/src/error.rs
new file mode 100644
index 0000000..f66806a
--- /dev/null
+++ b/crates/userfaultfd/src/error.rs
@@ -0,0 +1,62 @@
+use std::io;
+
+use crate::IoctlFlags;
+use nix::errno::Errno;
+use thiserror::Error;
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+/// Errors for this crate.
+///
+/// Several of these errors contain an underlying `Errno` value; see
+/// [`userfaultfd(2)`](http://man7.org/linux/man-pages/man2/userfaultfd.2.html) and
+/// [`ioctl_userfaultfd(2)`](http://man7.org/linux/man-pages/man2/ioctl_userfaultfd.2.html) for more
+/// details on how to interpret these errors.
+#[derive(Debug, Error)]
+pub enum Error {
+ /// Copy ioctl failure with `errno` value.
+ #[error("Copy failed")]
+ CopyFailed(Errno),
+
+ /// Copy ioctl failure with copied length.
+ #[error("Copy partially succeeded")]
+ PartiallyCopied(usize),
+
+ /// Failure to read a full `uffd_msg` struct from the underlying file descriptor.
+ #[error("Incomplete uffd_msg; read only {read}/{expected} bytes")]
+ IncompleteMsg { read: usize, expected: usize },
+
+ /// Generic system error.
+ #[error("System error")]
+ SystemError(#[source] nix::Error),
+
+ /// End-of-file was read from the underlying file descriptor.
+ #[error("EOF when reading file descriptor")]
+ ReadEof,
+
+ /// An unrecognized event code was found in a `uffd_msg` struct.
+ #[error("Unrecognized event in uffd_msg: {0}")]
+ UnrecognizedEvent(u8),
+
+ /// An unrecognized ioctl bit was set in the result of API initialization or registration.
+ #[error("Unrecognized ioctl flags: {0}")]
+ UnrecognizedIoctls(u64),
+
+ /// Requested ioctls were not available when initializing the API.
+ #[error("Requested ioctls unsupported; supported: {0:?}")]
+ UnsupportedIoctls(IoctlFlags),
+
+ /// Zeropage ioctl failure with `errno` value.
+ #[error("Zeropage failed: {0}")]
+ ZeropageFailed(Errno),
+
+ /// Could not open /dev/userfaultfd even though it exists
+ #[error("Error accessing /dev/userfaultfd: {0}")]
+ OpenDevUserfaultfd(io::Error),
+}
+
+impl From<nix::Error> for Error {
+ fn from(e: nix::Error) -> Error {
+ Error::SystemError(e)
+ }
+}
diff --git a/crates/userfaultfd/src/event.rs b/crates/userfaultfd/src/event.rs
new file mode 100644
index 0000000..8ea75f2
--- /dev/null
+++ b/crates/userfaultfd/src/event.rs
@@ -0,0 +1,148 @@
+use crate::error::{Error, Result};
+use crate::raw;
+use crate::Uffd;
+use libc::c_void;
+#[cfg(feature = "linux4_14")]
+use nix::unistd::Pid;
+use std::os::unix::io::{FromRawFd, RawFd};
+
+/// Whether a page fault event was for a read or write.
+#[derive(Clone, Copy, Debug, PartialEq)]
+pub enum ReadWrite {
+ Read,
+ Write,
+}
+
+/// The kind of fault for a page fault event.
+#[derive(Clone, Copy, Debug, PartialEq)]
+pub enum FaultKind {
+ /// The fault was a read or write on a missing page.
+ Missing,
+ /// The fault was a write on a write-protected page.
+ #[cfg(feature = "linux5_7")]
+ WriteProtected,
+}
+
+/// Events from the userfaultfd object that are read by `Uffd::read_event()`.
+#[derive(Debug)]
+pub enum Event {
+ /// A pagefault event.
+ Pagefault {
+ /// The kind of fault.
+ kind: FaultKind,
+ /// Whether the fault is on a read or a write.
+ rw: ReadWrite,
+ /// The address that triggered the fault.
+ addr: *mut c_void,
+ /// The thread that triggered the fault, if [`FeatureFlags::THREAD_ID`] is enabled.
+ ///
+ /// If the thread ID feature is not enabled, the value of this field is undefined. It would
+ /// not be undefined behavior to use it, strictly speaking, but the [`Pid`] will not
+ /// necessarily point to a real thread.
+ ///
+ /// This requires this crate to be compiled with the `linux4_14` feature.
+ #[cfg(feature = "linux4_14")]
+ thread_id: Pid,
+ },
+ /// Generated when the faulting process invokes `fork(2)` (or `clone(2)` without the `CLONE_VM`
+ /// flag).
+ Fork {
+ /// The `Uffd` object created for the child by `fork(2)`
+ uffd: Uffd,
+ },
+ /// Generated when the faulting process invokes `mremap(2)`.
+ Remap {
+ /// The original address of the memory range that was remapped.
+ from: *mut c_void,
+ /// The new address of the memory range that was remapped.
+ to: *mut c_void,
+ /// The original length of the memory range that was remapped.
+ len: usize,
+ },
+ /// Generated when the faulting process invokes `madvise(2)` with `MADV_DONTNEED` or
+ /// `MADV_REMOVE` advice.
+ Remove {
+ /// The start address of the memory range that was freed.
+ start: *mut c_void,
+ /// The end address of the memory range that was freed.
+ end: *mut c_void,
+ },
+ /// Generated when the faulting process unmaps a meomry range, either explicitly using
+ /// `munmap(2)` or implicitly during `mmap(2)` or `mremap(2)`.
+ Unmap {
+ /// The start address of the memory range that was unmapped.
+ start: *mut c_void,
+ /// The end address of the memory range that was unmapped.
+ end: *mut c_void,
+ },
+}
+
+impl Event {
+ pub(crate) fn from_uffd_msg(msg: &raw::uffd_msg) -> Result<Event> {
+ match msg.event {
+ raw::UFFD_EVENT_PAGEFAULT => {
+ let pagefault = unsafe { msg.arg.pagefault };
+ cfg_if::cfg_if!(
+ if #[cfg(feature = "linux5_7")] {
+ let kind = if pagefault.flags & raw::UFFD_PAGEFAULT_FLAG_WP != 0 {
+ FaultKind::WriteProtected
+ } else {
+ FaultKind::Missing
+ };
+ } else {
+ let kind = FaultKind::Missing;
+ }
+ );
+
+ let rw = if pagefault.flags & raw::UFFD_PAGEFAULT_FLAG_WRITE == 0 {
+ ReadWrite::Read
+ } else {
+ ReadWrite::Write
+ };
+ // Converting the ptid to i32 is safe because the maximum pid in
+ // Linux is 2^22, which is about 4 million.
+ //
+ // Reference:
+ // https://github.com/torvalds/linux/blob/2d338201d5311bcd79d42f66df4cecbcbc5f4f2c/include/linux/threads.h
+ #[cfg(feature = "linux4_14")]
+ let thread_id = Pid::from_raw(unsafe { pagefault.feat.ptid } as i32);
+ Ok(Event::Pagefault {
+ kind,
+ rw,
+ addr: pagefault.address as *mut c_void,
+ #[cfg(feature = "linux4_14")]
+ thread_id,
+ })
+ }
+ raw::UFFD_EVENT_FORK => {
+ let fork = unsafe { msg.arg.fork };
+ Ok(Event::Fork {
+ uffd: unsafe { Uffd::from_raw_fd(fork.ufd as RawFd) },
+ })
+ }
+ raw::UFFD_EVENT_REMAP => {
+ let remap = unsafe { msg.arg.remap };
+ Ok(Event::Remap {
+ from: remap.from as *mut c_void,
+ to: remap.to as *mut c_void,
+ len: remap.len as usize,
+ })
+ }
+ raw::UFFD_EVENT_REMOVE => {
+ let remove = unsafe { msg.arg.remove };
+ Ok(Event::Remove {
+ start: remove.start as *mut c_void,
+ end: remove.end as *mut c_void,
+ })
+ }
+ raw::UFFD_EVENT_UNMAP => {
+ let remove = unsafe { msg.arg.remove };
+ Ok(Event::Unmap {
+ start: remove.start as *mut c_void,
+ end: remove.end as *mut c_void,
+ })
+ }
+ _ => Err(Error::UnrecognizedEvent(msg.event)),
+ }
+ }
+}
diff --git a/crates/userfaultfd/src/lib.rs b/crates/userfaultfd/src/lib.rs
new file mode 100644
index 0000000..e18ef3c
--- /dev/null
+++ b/crates/userfaultfd/src/lib.rs
@@ -0,0 +1,673 @@
+//! A Linux mechanism for handling page faults in user space.
+//!
+//! The main way to interact with this library is to create a `Uffd` object with a `UffdBuilder`,
+//! then use the methods of `Uffd` from a worker thread.
+//!
+//! See [`userfaultfd(2)`](http://man7.org/linux/man-pages/man2/userfaultfd.2.html) and
+//! [`ioctl_userfaultfd(2)`](http://man7.org/linux/man-pages/man2/ioctl_userfaultfd.2.html) for more
+//! details.
+
+mod builder;
+mod error;
+mod event;
+mod raw;
+
+pub use crate::builder::{FeatureFlags, UffdBuilder};
+pub use crate::error::{Error, Result};
+pub use crate::event::{Event, FaultKind, ReadWrite};
+
+use bitflags::bitflags;
+use libc::{self, c_void};
+use nix::errno::Errno;
+use nix::unistd::read;
+use std::mem;
+use std::os::fd::{AsFd, BorrowedFd};
+use std::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd, RawFd};
+
+/// Represents an opaque buffer where userfaultfd events are stored.
+///
+/// This is used in conjunction with [`Uffd::read_events`].
+pub struct EventBuffer(Vec<raw::uffd_msg>);
+
+impl EventBuffer {
+ /// Creates a new buffer for `size` number of events.
+ ///
+ /// [`Uffd::read_events`] will read up to this many events at a time.
+ pub fn new(size: usize) -> Self {
+ Self(vec![unsafe { mem::zeroed() }; size])
+ }
+}
+
+/// The userfaultfd object.
+///
+/// The userspace representation of the object is a file descriptor, so this type implements
+/// `AsRawFd`, `FromRawFd`, and `IntoRawFd`. These methods should be used with caution, but can be
+/// essential for using functions like `poll` on a worker thread.
+#[derive(Debug)]
+pub struct Uffd {
+ fd: RawFd,
+}
+
+impl Drop for Uffd {
+ fn drop(&mut self) {
+ unsafe { libc::close(self.fd) };
+ }
+}
+
+impl AsFd for Uffd {
+ fn as_fd(&self) -> BorrowedFd<'_> {
+ unsafe { BorrowedFd::borrow_raw(self.as_raw_fd()) }
+ }
+}
+
+impl AsRawFd for Uffd {
+ fn as_raw_fd(&self) -> RawFd {
+ self.fd
+ }
+}
+
+impl IntoRawFd for Uffd {
+ fn into_raw_fd(self) -> RawFd {
+ self.fd
+ }
+}
+
+impl FromRawFd for Uffd {
+ unsafe fn from_raw_fd(fd: RawFd) -> Self {
+ Uffd { fd }
+ }
+}
+
+bitflags! {
+ /// The registration mode used when registering an address range with `Uffd`.
+ #[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+ pub struct RegisterMode: u64 {
+ /// Registers the range for missing page faults.
+ const MISSING = raw::UFFDIO_REGISTER_MODE_MISSING;
+ /// Registers the range for write faults.
+ #[cfg(feature = "linux5_7")]
+ const WRITE_PROTECT = raw::UFFDIO_REGISTER_MODE_WP;
+ }
+}
+
+impl Uffd {
+ /// Register a memory address range with the userfaultfd object, and returns the `IoctlFlags`
+ /// that are available for the selected range.
+ ///
+ /// This method only registers the given range for missing page faults.
+ pub fn register(&self, start: *mut c_void, len: usize) -> Result<IoctlFlags> {
+ self.register_with_mode(start, len, RegisterMode::MISSING)
+ }
+
+ /// Register a memory address range with the userfaultfd object for the given mode and
+ /// returns the `IoctlFlags` that are available for the selected range.
+ pub fn register_with_mode(
+ &self,
+ start: *mut c_void,
+ len: usize,
+ mode: RegisterMode,
+ ) -> Result<IoctlFlags> {
+ let mut register = raw::uffdio_register {
+ range: raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ },
+ mode: mode.bits(),
+ ioctls: 0,
+ };
+ unsafe {
+ raw::register(self.as_raw_fd(), &mut register as *mut raw::uffdio_register)?;
+ }
+ IoctlFlags::from_bits(register.ioctls).ok_or(Error::UnrecognizedIoctls(register.ioctls))
+ }
+
+ /// Unregister a memory address range from the userfaultfd object.
+ pub fn unregister(&self, start: *mut c_void, len: usize) -> Result<()> {
+ let mut range = raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ };
+ unsafe {
+ raw::unregister(self.as_raw_fd(), &mut range as *mut raw::uffdio_range)?;
+ }
+ Ok(())
+ }
+
+ /// Atomically copy a continuous memory chunk into the userfaultfd-registered range, and return
+ /// the number of bytes that were successfully copied.
+ ///
+ /// If `wake` is `true`, wake up the thread waiting for page fault resolution on the memory
+ /// range.
+ pub unsafe fn copy(
+ &self,
+ src: *const c_void,
+ dst: *mut c_void,
+ len: usize,
+ wake: bool,
+ ) -> Result<usize> {
+ let mut copy = raw::uffdio_copy {
+ src: src as u64,
+ dst: dst as u64,
+ len: len as u64,
+ mode: if wake {
+ 0
+ } else {
+ raw::UFFDIO_COPY_MODE_DONTWAKE
+ },
+ copy: 0,
+ };
+
+ let _ =
+ raw::copy(self.as_raw_fd(), &mut copy as *mut raw::uffdio_copy).map_err(|errno| {
+ match errno {
+ Errno::EAGAIN => Error::PartiallyCopied(copy.copy as usize),
+ _ => Error::CopyFailed(errno),
+ }
+ })?;
+ if copy.copy < 0 {
+ // shouldn't ever get here, as errno should be caught above
+ Err(Error::CopyFailed(Errno::from_i32(-copy.copy as i32)))
+ } else {
+ Ok(copy.copy as usize)
+ }
+ }
+
+ /// Zero out a memory address range registered with userfaultfd, and return the number of bytes
+ /// that were successfully zeroed.
+ ///
+ /// If `wake` is `true`, wake up the thread waiting for page fault resolution on the memory
+ /// address range.
+ pub unsafe fn zeropage(&self, start: *mut c_void, len: usize, wake: bool) -> Result<usize> {
+ let mut zeropage = raw::uffdio_zeropage {
+ range: raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ },
+ mode: if wake {
+ 0
+ } else {
+ raw::UFFDIO_ZEROPAGE_MODE_DONTWAKE
+ },
+ zeropage: 0,
+ };
+
+ let _ = raw::zeropage(self.as_raw_fd(), &mut zeropage as &mut raw::uffdio_zeropage)
+ .map_err(Error::ZeropageFailed)?;
+ if zeropage.zeropage < 0 {
+ // shouldn't ever get here, as errno should be caught above
+ Err(Error::ZeropageFailed(Errno::from_i32(
+ -zeropage.zeropage as i32,
+ )))
+ } else {
+ Ok(zeropage.zeropage as usize)
+ }
+ }
+
+ /// Wake up the thread waiting for page fault resolution on the specified memory address range.
+ pub fn wake(&self, start: *mut c_void, len: usize) -> Result<()> {
+ let mut range = raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ };
+ unsafe {
+ raw::wake(self.as_raw_fd(), &mut range as *mut raw::uffdio_range)?;
+ }
+ Ok(())
+ }
+
+ /// Makes a range write-protected.
+ #[cfg(feature = "linux5_7")]
+ pub fn write_protect(&self, start: *mut c_void, len: usize) -> Result<()> {
+ let mut ioctl = raw::uffdio_writeprotect {
+ range: raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ },
+ mode: raw::UFFDIO_WRITEPROTECT_MODE_WP,
+ };
+
+ unsafe {
+ raw::write_protect(
+ self.as_raw_fd(),
+ &mut ioctl as *mut raw::uffdio_writeprotect,
+ )?;
+ }
+
+ Ok(())
+ }
+
+ /// Removes the write-protection for a range.
+ ///
+ /// If `wake` is `true`, wake up the thread waiting for page fault resolution on the memory
+ /// address range.
+ #[cfg(feature = "linux5_7")]
+ pub fn remove_write_protection(
+ &self,
+ start: *mut c_void,
+ len: usize,
+ wake: bool,
+ ) -> Result<()> {
+ let mut ioctl = raw::uffdio_writeprotect {
+ range: raw::uffdio_range {
+ start: start as u64,
+ len: len as u64,
+ },
+ mode: if wake {
+ 0
+ } else {
+ raw::UFFDIO_WRITEPROTECT_MODE_DONTWAKE
+ },
+ };
+
+ unsafe {
+ raw::write_protect(
+ self.as_raw_fd(),
+ &mut ioctl as *mut raw::uffdio_writeprotect,
+ )?;
+ }
+
+ Ok(())
+ }
+
+ /// Read an `Event` from the userfaultfd object.
+ ///
+ /// If the `Uffd` object was created with `non_blocking` set to `false`, this will block until
+ /// an event is successfully read (returning `Some(event)`, or an error is returned.
+ ///
+ /// If `non_blocking` was `true`, this will immediately return `None` if no event is ready to
+ /// read.
+ ///
+ /// Note that while this method doesn't require a mutable reference to the `Uffd` object, it
+ /// does consume bytes (thread-safely) from the underlying file descriptor.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// # use userfaultfd::{Uffd, Result};
+ /// fn read_event(uffd: &Uffd) -> Result<()> {
+ /// // Read a single event
+ /// match uffd.read_event()? {
+ /// Some(e) => {
+ /// // Do something with the event
+ /// },
+ /// None => {
+ /// // This was a non-blocking read and the descriptor was not ready for read
+ /// },
+ /// }
+ /// Ok(())
+ /// }
+ /// ```
+ pub fn read_event(&self) -> Result<Option<Event>> {
+ let mut buf = [unsafe { std::mem::zeroed() }; 1];
+ let mut iter = self.read(&mut buf)?;
+ let event = iter.next().transpose()?;
+ assert!(iter.next().is_none());
+ Ok(event)
+ }
+
+ /// Read multiple events from the userfaultfd object using the given event buffer.
+ ///
+ /// If the `Uffd` object was created with `non_blocking` set to `false`, this will block until
+ /// an event is successfully read or an error is returned.
+ ///
+ /// If `non_blocking` was `true`, this will immediately return an empty iterator if the file
+ /// descriptor is not ready for reading.
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// # use userfaultfd::{Uffd, EventBuffer};
+ /// fn read_events(uffd: &Uffd) -> userfaultfd::Result<()> {
+ /// // Read up to 100 events at a time
+ /// let mut buf = EventBuffer::new(100);
+ /// for event in uffd.read_events(&mut buf)? {
+ /// let event = event?;
+ /// // Do something with the event...
+ /// }
+ /// Ok(())
+ /// }
+ /// ```
+ pub fn read_events<'a>(
+ &self,
+ buf: &'a mut EventBuffer,
+ ) -> Result<impl Iterator<Item = Result<Event>> + 'a> {
+ self.read(&mut buf.0)
+ }
+
+ fn read<'a>(
+ &self,
+ msgs: &'a mut [raw::uffd_msg],
+ ) -> Result<impl Iterator<Item = Result<Event>> + 'a> {
+ const MSG_SIZE: usize = std::mem::size_of::<raw::uffd_msg>();
+
+ let buf = unsafe {
+ std::slice::from_raw_parts_mut(msgs.as_mut_ptr() as _, msgs.len() * MSG_SIZE)
+ };
+
+ let count = match read(self.as_raw_fd(), buf) {
+ Err(e) if e == Errno::EAGAIN => 0,
+ Err(e) => return Err(Error::SystemError(e)),
+ Ok(0) => return Err(Error::ReadEof),
+ Ok(bytes_read) => {
+ let remainder = bytes_read % MSG_SIZE;
+ if remainder != 0 {
+ return Err(Error::IncompleteMsg {
+ read: remainder,
+ expected: MSG_SIZE,
+ });
+ }
+
+ bytes_read / MSG_SIZE
+ }
+ };
+
+ Ok(msgs.iter().take(count).map(|msg| Event::from_uffd_msg(msg)))
+ }
+}
+
+bitflags! {
+ /// Used with `UffdBuilder` and `Uffd::register()` to determine which operations are available.
+ #[derive(Copy, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
+ pub struct IoctlFlags: u64 {
+ const REGISTER = 1 << raw::_UFFDIO_REGISTER;
+ const UNREGISTER = 1 << raw::_UFFDIO_UNREGISTER;
+ const WAKE = 1 << raw::_UFFDIO_WAKE;
+ const COPY = 1 << raw::_UFFDIO_COPY;
+ const ZEROPAGE = 1 << raw::_UFFDIO_ZEROPAGE;
+ #[cfg(feature = "linux5_7")]
+ const WRITE_PROTECT = 1 << raw::_UFFDIO_WRITEPROTECT;
+ const API = 1 << raw::_UFFDIO_API;
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use std::ptr;
+ use std::thread;
+
+ #[test]
+ fn test_read_event() -> Result<()> {
+ const PAGE_SIZE: usize = 4096;
+
+ unsafe {
+ let uffd = UffdBuilder::new().close_on_exec(true).create()?;
+
+ let mapping = libc::mmap(
+ ptr::null_mut(),
+ PAGE_SIZE,
+ libc::PROT_READ | libc::PROT_WRITE,
+ libc::MAP_PRIVATE | libc::MAP_ANON,
+ -1,
+ 0,
+ );
+
+ assert!(!mapping.is_null());
+
+ uffd.register(mapping, PAGE_SIZE)?;
+
+ let ptr = mapping as usize;
+ let thread = thread::spawn(move || {
+ let ptr = ptr as *mut u8;
+ *ptr = 1;
+ });
+
+ match uffd.read_event()? {
+ Some(Event::Pagefault {
+ rw: ReadWrite::Write,
+ addr,
+ ..
+ }) => {
+ assert_eq!(addr, mapping);
+ uffd.zeropage(addr, PAGE_SIZE, true)?;
+ }
+ _ => panic!("unexpected event"),
+ }
+
+ thread.join().expect("failed to join thread");
+
+ uffd.unregister(mapping, PAGE_SIZE)?;
+
+ assert_eq!(libc::munmap(mapping, PAGE_SIZE), 0);
+ }
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_nonblocking_read_event() -> Result<()> {
+ const PAGE_SIZE: usize = 4096;
+
+ unsafe {
+ let uffd = UffdBuilder::new()
+ .close_on_exec(true)
+ .non_blocking(true)
+ .create()?;
+
+ let mapping = libc::mmap(
+ ptr::null_mut(),
+ PAGE_SIZE,
+ libc::PROT_READ | libc::PROT_WRITE,
+ libc::MAP_PRIVATE | libc::MAP_ANON,
+ -1,
+ 0,
+ );
+
+ assert!(!mapping.is_null());
+
+ uffd.register(mapping, PAGE_SIZE)?;
+
+ assert!(uffd.read_event()?.is_none());
+
+ let ptr = mapping as usize;
+ let thread = thread::spawn(move || {
+ let ptr = ptr as *mut u8;
+ *ptr = 1;
+ });
+
+ loop {
+ match uffd.read_event()? {
+ Some(Event::Pagefault {
+ rw: ReadWrite::Write,
+ addr,
+ ..
+ }) => {
+ assert_eq!(addr, mapping);
+ uffd.zeropage(addr, PAGE_SIZE, true)?;
+ break;
+ }
+ Some(_) => panic!("unexpected event"),
+ None => thread::sleep(std::time::Duration::from_millis(50)),
+ }
+ }
+
+ thread.join().expect("failed to join thread");
+
+ uffd.unregister(mapping, PAGE_SIZE)?;
+
+ assert_eq!(libc::munmap(mapping, PAGE_SIZE), 0);
+ }
+
+ Ok(())
+ }
+
+ #[test]
+ fn test_read_events() -> Result<()> {
+ unsafe {
+ const MAX_THREADS: usize = 5;
+ const PAGE_SIZE: usize = 4096;
+ const MEM_SIZE: usize = PAGE_SIZE * MAX_THREADS;
+
+ let uffd = UffdBuilder::new().close_on_exec(true).create()?;
+
+ let mapping = libc::mmap(
+ ptr::null_mut(),
+ MEM_SIZE,
+ libc::PROT_READ | libc::PROT_WRITE,
+ libc::MAP_PRIVATE | libc::MAP_ANON,
+ -1,
+ 0,
+ );
+
+ assert!(!mapping.is_null());
+
+ uffd.register(mapping, MEM_SIZE)?;
+
+ // As accessing the memory will suspend each thread with a page fault event,
+ // there is no way to signal that the operations the test thread is waiting on to
+ // complete have been performed.
+ //
+ // Therefore, this is inherently racy. The best we can do is simply sleep-wait for
+ // all threads to have signaled that the operation is *about to be performed*.
+ let mut seen = [false; MAX_THREADS];
+ let mut threads = Vec::new();
+ for i in 0..MAX_THREADS {
+ let seen = &mut seen[i] as *mut _ as usize;
+ let ptr = (mapping as *mut u8).add(PAGE_SIZE * i) as usize;
+ threads.push(thread::spawn(move || {
+ let seen = seen as *mut bool;
+ let ptr = ptr as *mut u8;
+ *seen = true;
+ *ptr = 1;
+ }));
+ }
+
+ loop {
+ // Sleep even if all threads have "signaled", just in case any
+ // thread is preempted prior to faulting the memory access.
+ // Still, there's no guarantee that the call to `read_events` below will
+ // read all the events at once, but this should be "good enough".
+ let done = seen.iter().all(|b| *b);
+ thread::sleep(std::time::Duration::from_millis(50));
+ if done {
+ break;
+ }
+ }
+
+ // Read all the events at once
+ let mut buf = EventBuffer::new(MAX_THREADS);
+ let mut iter = uffd.read_events(&mut buf)?;
+
+ let mut seen = [false; MAX_THREADS];
+ for _ in 0..MAX_THREADS {
+ match iter
+ .next()
+ .transpose()?
+ .expect("failed to read all events; potential race condition was hit")
+ {
+ Event::Pagefault {
+ rw: ReadWrite::Write,
+ addr,
+ ..
+ } => {
+ let index = (addr as usize - mapping as usize) / PAGE_SIZE;
+ assert_eq!(seen[index], false);
+ seen[index] = true;
+ uffd.zeropage(addr, PAGE_SIZE, true)?;
+ }
+ _ => panic!("unexpected event"),
+ }
+ }
+
+ assert!(seen.iter().all(|b| *b));
+
+ for thread in threads {
+ thread.join().expect("failed to join thread");
+ }
+
+ uffd.unregister(mapping, MEM_SIZE)?;
+
+ assert_eq!(libc::munmap(mapping, MEM_SIZE), 0);
+ }
+
+ Ok(())
+ }
+
+ #[cfg(feature = "linux5_7")]
+ #[test]
+ fn test_write_protect() -> Result<()> {
+ const PAGE_SIZE: usize = 4096;
+
+ unsafe {
+ let uffd = UffdBuilder::new()
+ .require_features(FeatureFlags::PAGEFAULT_FLAG_WP)
+ .close_on_exec(true)
+ .create()?;
+
+ let mapping = libc::mmap(
+ ptr::null_mut(),
+ PAGE_SIZE,
+ libc::PROT_READ | libc::PROT_WRITE,
+ libc::MAP_PRIVATE | libc::MAP_ANON,
+ -1,
+ 0,
+ );
+
+ assert!(!mapping.is_null());
+
+ // This test uses both missing and write-protect modes for a reason.
+ // The `uffdio_writeprotect` ioctl can only be used on a range *after*
+ // the missing fault is handled, it seems. This means we either need to
+ // read/write the page *before* we protect it or handle the missing
+ // page fault by changing the protection level *after* we zero the page.
+ assert!(uffd
+ .register_with_mode(
+ mapping,
+ PAGE_SIZE,
+ RegisterMode::MISSING | RegisterMode::WRITE_PROTECT
+ )?
+ .contains(IoctlFlags::WRITE_PROTECT));
+
+ let ptr = mapping as usize;
+ let thread = thread::spawn(move || {
+ let ptr = ptr as *mut u8;
+ *ptr = 1;
+ *ptr = 2;
+ });
+
+ loop {
+ match uffd.read_event()? {
+ Some(Event::Pagefault {
+ kind,
+ rw: ReadWrite::Write,
+ addr,
+ ..
+ }) => match kind {
+ FaultKind::WriteProtected => {
+ assert_eq!(addr, mapping);
+ assert_eq!(*(addr as *const u8), 0);
+ // Remove the protection and wake the page
+ uffd.remove_write_protection(mapping, PAGE_SIZE, true)?;
+ break;
+ }
+ FaultKind::Missing => {
+ assert_eq!(addr, mapping);
+ uffd.zeropage(mapping, PAGE_SIZE, false)?;
+
+ // Technically, we already know it was a write that triggered
+ // the missing page fault, so there's little point in immediately
+ // write-protecting the page to cause another fault; in the real
+ // world, a missing fault with `rw` being `ReadWrite::Write` would
+ // be enough to mark the page as "dirty". For this test, however,
+ // we do it this way to ensure a write-protected fault is read.
+ assert_eq!(*(addr as *const u8), 0);
+ uffd.write_protect(mapping, PAGE_SIZE)?;
+ uffd.wake(mapping, PAGE_SIZE)?;
+ }
+ },
+ _ => panic!("unexpected event"),
+ }
+ }
+
+ thread.join().expect("failed to join thread");
+
+ assert_eq!(*(mapping as *const u8), 2);
+
+ uffd.unregister(mapping, PAGE_SIZE)?;
+
+ assert_eq!(libc::munmap(mapping, PAGE_SIZE), 0);
+ }
+
+ Ok(())
+ }
+}
diff --git a/crates/userfaultfd/src/raw.rs b/crates/userfaultfd/src/raw.rs
new file mode 100644
index 0000000..28039c7
--- /dev/null
+++ b/crates/userfaultfd/src/raw.rs
@@ -0,0 +1,40 @@
+use libc::{c_int, c_long, syscall, SYS_userfaultfd, INT_MAX};
+pub use userfaultfd_sys::*;
+
+pub unsafe fn userfaultfd(flags: c_int) -> c_int {
+ let fd = syscall(SYS_userfaultfd, flags as c_long);
+ if fd > INT_MAX as c_long {
+ panic!("fd doesn't fit in a c_int");
+ } else {
+ fd as c_int
+ }
+}
+
+nix::ioctl_readwrite!(api, UFFDIO, _UFFDIO_API, uffdio_api);
+nix::ioctl_readwrite!(register, UFFDIO, _UFFDIO_REGISTER, uffdio_register);
+nix::ioctl_read!(unregister, UFFDIO, _UFFDIO_UNREGISTER, uffdio_range);
+nix::ioctl_read!(wake, UFFDIO, _UFFDIO_WAKE, uffdio_range);
+nix::ioctl_readwrite!(copy, UFFDIO, _UFFDIO_COPY, uffdio_copy);
+nix::ioctl_readwrite!(zeropage, UFFDIO, _UFFDIO_ZEROPAGE, uffdio_zeropage);
+#[cfg(feature = "linux5_7")]
+nix::ioctl_readwrite!(
+ write_protect,
+ UFFDIO,
+ _UFFDIO_WRITEPROTECT,
+ uffdio_writeprotect
+);
+
+// ioctls for /dev/userfaultfd
+
+// This is the `/dev/userfaultfd` ioctl() from creating a new userfault file descriptor.
+// It is a "bad" ioctl in the sense that it is defined as an _IOC:
+// https://elixir.bootlin.com/linux/latest/source/include/uapi/linux/userfaultfd.h#L17,
+// aka `nix::ioctl_none`, however it does receive an integer argument:
+// https://elixir.bootlin.com/linux/latest/source/fs/userfaultfd.c#L2186. That is the same argument
+// that the userfaultfd() system call receives.
+nix::ioctl_write_int_bad!(
+ /// Create a new userfault file descriptor from the `/dev/userfaultfd`
+ /// device. This receives the same arguments as the userfaultfd system call.
+ new_uffd,
+ nix::request_code_none!(USERFAULTFD_IOC, 0x00)
+);
diff --git a/crates/userfaultfd/tests/manpage_example.rs b/crates/userfaultfd/tests/manpage_example.rs
new file mode 100644
index 0000000..49a061f
--- /dev/null
+++ b/crates/userfaultfd/tests/manpage_example.rs
@@ -0,0 +1,8 @@
+#[test]
+fn run_manpage_example() {
+ let output = std::process::Command::new("cargo")
+ .args(&["run", "--example", "manpage", "--", "3"])
+ .output()
+ .expect("manpage example failed to start");
+ assert!(output.status.success(), "manpage example succeeded");
+}
diff --git a/crates/utf-8/.cargo-checksum.json b/crates/utf-8/.cargo-checksum.json
new file mode 100644
index 0000000..b31e50c
--- /dev/null
+++ b/crates/utf-8/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"e0009dd2e366cbb98b75dbadb9de9e5662c5f3fe971e99dd98eaa9adb7ecb648","LICENSE-APACHE":"62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a","LICENSE-MIT":"23f18e03dc49df91622fe2a76176497404e46ced8a715d9d2b67a7446571cca3","README.md":"e5cd8b3b67c2962e13b0aa95fc2af9152999e1bd333df8be8a3be5eab53e540a","benches/from_utf8_lossy.rs":"ed57fc9fca84d160a70fa06bcf6658adca9f4518cb6e0be6a52accc291736b0e","src/lib.rs":"32e657c72a7a895b26288f271e3194270002548692368bdb1ef32b5698975395","src/lossy.rs":"c7d3f193fe04b60145a5e32f5e6c55c181664f82309ef59bb15533194d69e345","src/read.rs":"6eae22954e18a5afa8f62c876498a643563c5b68d03329a417aa354a28108046","tests/unit.rs":"9e920a552549009191d61147d60196fcce9cbc7f2065d33b6d9c757e258a9edd"},"package":"09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9"}
\ No newline at end of file
diff --git a/crates/utf-8/Android.bp b/crates/utf-8/Android.bp
new file mode 100644
index 0000000..bf00462
--- /dev/null
+++ b/crates/utf-8/Android.bp
@@ -0,0 +1,46 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_utf-8_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_utf-8_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libutf8",
+ host_supported: true,
+ crate_name: "utf8",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.7.6",
+ crate_root: "src/lib.rs",
+ edition: "2015",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "utf-8_test_tests_unit",
+ host_supported: true,
+ crate_name: "unit",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.7.6",
+ crate_root: "tests/unit.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2015",
+ rustlibs: ["libutf8"],
+}
diff --git a/crates/utf-8/Cargo.toml b/crates/utf-8/Cargo.toml
new file mode 100644
index 0000000..c01a69d
--- /dev/null
+++ b/crates/utf-8/Cargo.toml
@@ -0,0 +1,29 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+name = "utf-8"
+version = "0.7.6"
+authors = ["Simon Sapin <[email protected]>"]
+description = "Incremental, zero-copy UTF-8 decoding with error handling"
+license = "MIT OR Apache-2.0"
+repository = "https://github.com/SimonSapin/rust-utf8"
+[profile.bench]
+
+[profile.test]
+
+[lib]
+name = "utf8"
+test = false
+bench = false
+
+[dependencies]
diff --git a/crates/utf-8/LICENSE b/crates/utf-8/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/utf-8/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/utf-8/LICENSE-APACHE b/crates/utf-8/LICENSE-APACHE
new file mode 100644
index 0000000..1b5ec8b
--- /dev/null
+++ b/crates/utf-8/LICENSE-APACHE
@@ -0,0 +1,176 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
diff --git a/crates/utf-8/LICENSE-MIT b/crates/utf-8/LICENSE-MIT
new file mode 100644
index 0000000..31aa793
--- /dev/null
+++ b/crates/utf-8/LICENSE-MIT
@@ -0,0 +1,23 @@
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/utf-8/METADATA b/crates/utf-8/METADATA
new file mode 100644
index 0000000..178a89e
--- /dev/null
+++ b/crates/utf-8/METADATA
@@ -0,0 +1,20 @@
+name: "utf-8"
+description: "Incremental, zero-copy UTF-8 decoding with error handling"
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/utf-8"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/utf-8/utf-8-0.7.6.crate"
+ }
+ version: "0.7.6"
+ # Dual-licensed, using the least restrictive per go/thirdpartylicenses#same.
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 6
+ day: 2
+ }
+}
diff --git a/crates/utf-8/MODULE_LICENSE_APACHE2 b/crates/utf-8/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/utf-8/MODULE_LICENSE_APACHE2
diff --git a/crates/utf-8/README.md b/crates/utf-8/README.md
new file mode 100644
index 0000000..145889b
--- /dev/null
+++ b/crates/utf-8/README.md
@@ -0,0 +1,5 @@
+# rust-utf8
+
+Incremental, zero-copy UTF-8 decoding for Rust
+
+[Documentation](https://docs.rs/utf-8/)
diff --git a/crates/utf-8/benches/from_utf8_lossy.rs b/crates/utf-8/benches/from_utf8_lossy.rs
new file mode 100644
index 0000000..95d9edf
--- /dev/null
+++ b/crates/utf-8/benches/from_utf8_lossy.rs
@@ -0,0 +1,30 @@
+#![feature(test)]
+
+extern crate test;
+extern crate utf8;
+
+#[path = "../tests/shared/data.rs"]
+mod data;
+
+#[path = "../tests/shared/string_from_utf8_lossy.rs"]
+mod string_from_utf8_lossy;
+
+#[bench]
+fn bench_our_string_from_utf8_lossy(bencher: &mut test::Bencher) {
+ bencher.bytes = data::DECODED_LOSSY.iter().map(|&(input, _expected)| input.len() as u64).sum();
+ bencher.iter(|| {
+ for &(input, _expected) in data::DECODED_LOSSY {
+ test::black_box(string_from_utf8_lossy::string_from_utf8_lossy(input));
+ }
+ })
+}
+
+#[bench]
+fn bench_std_string_from_utf8_lossy(bencher: &mut test::Bencher) {
+ bencher.bytes = data::DECODED_LOSSY.iter().map(|&(input, _expected)| input.len() as u64).sum();
+ bencher.iter(|| {
+ for &(input, _expected) in data::DECODED_LOSSY {
+ test::black_box(String::from_utf8_lossy(input));
+ }
+ })
+}
diff --git a/crates/utf-8/cargo_embargo.json b/crates/utf-8/cargo_embargo.json
new file mode 100644
index 0000000..c8842d1
--- /dev/null
+++ b/crates/utf-8/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "run_cargo": false,
+ "tests": true
+}
diff --git a/crates/utf-8/src/lib.rs b/crates/utf-8/src/lib.rs
new file mode 100644
index 0000000..ec223f2
--- /dev/null
+++ b/crates/utf-8/src/lib.rs
@@ -0,0 +1,186 @@
+mod lossy;
+mod read;
+
+pub use lossy::LossyDecoder;
+pub use read::{BufReadDecoder, BufReadDecoderError};
+
+use std::cmp;
+use std::error::Error;
+use std::fmt;
+use std::str;
+
+/// The replacement character, U+FFFD. In lossy decoding, insert it for every decoding error.
+pub const REPLACEMENT_CHARACTER: &'static str = "\u{FFFD}";
+
+#[derive(Debug, Copy, Clone)]
+pub enum DecodeError<'a> {
+ /// In lossy decoding insert `valid_prefix`, then `"\u{FFFD}"`,
+ /// then call `decode()` again with `remaining_input`.
+ Invalid {
+ valid_prefix: &'a str,
+ invalid_sequence: &'a [u8],
+ remaining_input: &'a [u8],
+ },
+
+ /// Call the `incomplete_suffix.try_complete` method with more input when available.
+ /// If no more input is available, this is an invalid byte sequence.
+ Incomplete {
+ valid_prefix: &'a str,
+ incomplete_suffix: Incomplete,
+ },
+}
+
+impl<'a> fmt::Display for DecodeError<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ DecodeError::Invalid {
+ valid_prefix,
+ invalid_sequence,
+ remaining_input,
+ } => write!(
+ f,
+ "found invalid byte sequence {invalid_sequence:02x?} after \
+ {valid_byte_count} valid bytes, followed by {unprocessed_byte_count} more \
+ unprocessed bytes",
+ invalid_sequence = invalid_sequence,
+ valid_byte_count = valid_prefix.len(),
+ unprocessed_byte_count = remaining_input.len()
+ ),
+ DecodeError::Incomplete {
+ valid_prefix,
+ incomplete_suffix,
+ } => write!(
+ f,
+ "found incomplete byte sequence {incomplete_suffix:02x?} after \
+ {valid_byte_count} bytes",
+ incomplete_suffix = incomplete_suffix,
+ valid_byte_count = valid_prefix.len()
+ ),
+ }
+ }
+}
+
+impl<'a> Error for DecodeError<'a> {}
+
+#[derive(Debug, Copy, Clone)]
+pub struct Incomplete {
+ pub buffer: [u8; 4],
+ pub buffer_len: u8,
+}
+
+pub fn decode(input: &[u8]) -> Result<&str, DecodeError> {
+ let error = match str::from_utf8(input) {
+ Ok(valid) => return Ok(valid),
+ Err(error) => error,
+ };
+
+ // FIXME: separate function from here to guide inlining?
+ let (valid, after_valid) = input.split_at(error.valid_up_to());
+ let valid = unsafe {
+ str::from_utf8_unchecked(valid)
+ };
+
+ match error.error_len() {
+ Some(invalid_sequence_length) => {
+ let (invalid, rest) = after_valid.split_at(invalid_sequence_length);
+ Err(DecodeError::Invalid {
+ valid_prefix: valid,
+ invalid_sequence: invalid,
+ remaining_input: rest
+ })
+ }
+ None => {
+ Err(DecodeError::Incomplete {
+ valid_prefix: valid,
+ incomplete_suffix: Incomplete::new(after_valid),
+ })
+ }
+ }
+}
+
+impl Incomplete {
+ pub fn empty() -> Self {
+ Incomplete {
+ buffer: [0, 0, 0, 0],
+ buffer_len: 0,
+ }
+ }
+
+ pub fn is_empty(&self) -> bool {
+ self.buffer_len == 0
+ }
+
+ pub fn new(bytes: &[u8]) -> Self {
+ let mut buffer = [0, 0, 0, 0];
+ let len = bytes.len();
+ buffer[..len].copy_from_slice(bytes);
+ Incomplete {
+ buffer: buffer,
+ buffer_len: len as u8,
+ }
+ }
+
+ /// * `None`: still incomplete, call `try_complete` again with more input.
+ /// If no more input is available, this is invalid byte sequence.
+ /// * `Some((result, remaining_input))`: We’re done with this `Incomplete`.
+ /// To keep decoding, pass `remaining_input` to `decode()`.
+ pub fn try_complete<'input>(&mut self, input: &'input [u8])
+ -> Option<(Result<&str, &[u8]>, &'input [u8])> {
+ let (consumed, opt_result) = self.try_complete_offsets(input);
+ let result = opt_result?;
+ let remaining_input = &input[consumed..];
+ let result_bytes = self.take_buffer();
+ let result = match result {
+ Ok(()) => Ok(unsafe { str::from_utf8_unchecked(result_bytes) }),
+ Err(()) => Err(result_bytes),
+ };
+ Some((result, remaining_input))
+ }
+
+ fn take_buffer(&mut self) -> &[u8] {
+ let len = self.buffer_len as usize;
+ self.buffer_len = 0;
+ &self.buffer[..len as usize]
+ }
+
+ /// (consumed_from_input, None): not enough input
+ /// (consumed_from_input, Some(Err(()))): error bytes in buffer
+ /// (consumed_from_input, Some(Ok(()))): UTF-8 string in buffer
+ fn try_complete_offsets(&mut self, input: &[u8]) -> (usize, Option<Result<(), ()>>) {
+ let initial_buffer_len = self.buffer_len as usize;
+ let copied_from_input;
+ {
+ let unwritten = &mut self.buffer[initial_buffer_len..];
+ copied_from_input = cmp::min(unwritten.len(), input.len());
+ unwritten[..copied_from_input].copy_from_slice(&input[..copied_from_input]);
+ }
+ let spliced = &self.buffer[..initial_buffer_len + copied_from_input];
+ match str::from_utf8(spliced) {
+ Ok(_) => {
+ self.buffer_len = spliced.len() as u8;
+ (copied_from_input, Some(Ok(())))
+ }
+ Err(error) => {
+ let valid_up_to = error.valid_up_to();
+ if valid_up_to > 0 {
+ let consumed = valid_up_to.checked_sub(initial_buffer_len).unwrap();
+ self.buffer_len = valid_up_to as u8;
+ (consumed, Some(Ok(())))
+ } else {
+ match error.error_len() {
+ Some(invalid_sequence_length) => {
+ let consumed = invalid_sequence_length
+ .checked_sub(initial_buffer_len).unwrap();
+ self.buffer_len = invalid_sequence_length as u8;
+ (consumed, Some(Err(())))
+ }
+ None => {
+ self.buffer_len = spliced.len() as u8;
+ (copied_from_input, None)
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/crates/utf-8/src/lossy.rs b/crates/utf-8/src/lossy.rs
new file mode 100644
index 0000000..00bcdec
--- /dev/null
+++ b/crates/utf-8/src/lossy.rs
@@ -0,0 +1,92 @@
+use super::*;
+
+/// A push-based, lossy decoder for UTF-8.
+/// Errors are replaced with the U+FFFD replacement character.
+///
+/// Users “push” bytes into the decoder, which in turn “pushes” `&str` slices into a callback.
+///
+/// For example, `String::from_utf8_lossy` (but returning `String` instead of `Cow`)
+/// can be rewritten as:
+///
+/// ```rust
+/// fn string_from_utf8_lossy(input: &[u8]) -> String {
+/// let mut string = String::new();
+/// utf8::LossyDecoder::new(|s| string.push_str(s)).feed(input);
+/// string
+/// }
+/// ```
+///
+/// **Note:** Dropping the decoder signals the end of the input:
+/// If the last input chunk ended with an incomplete byte sequence for a code point,
+/// this is an error and a replacement character is emitted.
+/// Use `std::mem::forget` to inhibit this behavior.
+pub struct LossyDecoder<F: FnMut(&str)> {
+ push_str: F,
+ incomplete: Incomplete,
+}
+
+impl<F: FnMut(&str)> LossyDecoder<F> {
+ /// Create a new decoder from a callback.
+ #[inline]
+ pub fn new(push_str: F) -> Self {
+ LossyDecoder {
+ push_str: push_str,
+ incomplete: Incomplete {
+ buffer: [0, 0, 0, 0],
+ buffer_len: 0,
+ },
+ }
+ }
+
+ /// Feed one chunk of input into the decoder.
+ ///
+ /// The input is decoded lossily
+ /// and the callback called once or more with `&str` string slices.
+ ///
+ /// If the UTF-8 byte sequence for one code point was split into this bytes chunk
+ /// and previous bytes chunks, it will be correctly pieced back together.
+ pub fn feed(&mut self, mut input: &[u8]) {
+ if self.incomplete.buffer_len > 0 {
+ match self.incomplete.try_complete(input) {
+ Some((Ok(s), remaining)) => {
+ (self.push_str)(s);
+ input = remaining
+ }
+ Some((Err(_), remaining)) => {
+ (self.push_str)(REPLACEMENT_CHARACTER);
+ input = remaining
+ }
+ None => {
+ return
+ }
+ }
+ }
+ loop {
+ match decode(input) {
+ Ok(s) => {
+ (self.push_str)(s);
+ return
+ }
+ Err(DecodeError::Incomplete { valid_prefix, incomplete_suffix }) => {
+ (self.push_str)(valid_prefix);
+ self.incomplete = incomplete_suffix;
+ return
+ }
+ Err(DecodeError::Invalid { valid_prefix, remaining_input, .. }) => {
+ (self.push_str)(valid_prefix);
+ (self.push_str)(REPLACEMENT_CHARACTER);
+ input = remaining_input
+ }
+ }
+ }
+ }
+}
+
+impl<F: FnMut(&str)> Drop for LossyDecoder<F> {
+ #[inline]
+ fn drop(&mut self) {
+ if self.incomplete.buffer_len > 0 {
+ (self.push_str)(REPLACEMENT_CHARACTER)
+ }
+ }
+}
diff --git a/crates/utf-8/src/read.rs b/crates/utf-8/src/read.rs
new file mode 100644
index 0000000..5e38f54
--- /dev/null
+++ b/crates/utf-8/src/read.rs
@@ -0,0 +1,167 @@
+use std::io::{self, BufRead};
+use std::error::Error;
+use std::fmt;
+use std::str;
+use super::*;
+
+/// Wraps a `std::io::BufRead` buffered byte stream and decode it as UTF-8.
+pub struct BufReadDecoder<B: BufRead> {
+ buf_read: B,
+ bytes_consumed: usize,
+ incomplete: Incomplete,
+}
+
+#[derive(Debug)]
+pub enum BufReadDecoderError<'a> {
+ /// Represents one UTF-8 error in the byte stream.
+ ///
+ /// In lossy decoding, each such error should be replaced with U+FFFD.
+ /// (See `BufReadDecoder::next_lossy` and `BufReadDecoderError::lossy`.)
+ InvalidByteSequence(&'a [u8]),
+
+ /// An I/O error from the underlying byte stream
+ Io(io::Error),
+}
+
+impl<'a> BufReadDecoderError<'a> {
+ /// Replace UTF-8 errors with U+FFFD
+ pub fn lossy(self) -> Result<&'static str, io::Error> {
+ match self {
+ BufReadDecoderError::Io(error) => Err(error),
+ BufReadDecoderError::InvalidByteSequence(_) => Ok(REPLACEMENT_CHARACTER),
+ }
+ }
+}
+
+impl<'a> fmt::Display for BufReadDecoderError<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match *self {
+ BufReadDecoderError::InvalidByteSequence(bytes) => {
+ write!(f, "invalid byte sequence: {:02x?}", bytes)
+ }
+ BufReadDecoderError::Io(ref err) => write!(f, "underlying bytestream error: {}", err),
+ }
+ }
+}
+
+impl<'a> Error for BufReadDecoderError<'a> {
+ fn source(&self) -> Option<&(dyn Error + 'static)> {
+ match *self {
+ BufReadDecoderError::InvalidByteSequence(_) => None,
+ BufReadDecoderError::Io(ref err) => Some(err),
+ }
+ }
+}
+
+impl<B: BufRead> BufReadDecoder<B> {
+ /// This is to `Read::read_to_string` what `String::from_utf8_lossy` is to `String::from_utf8`.
+ pub fn read_to_string_lossy(buf_read: B) -> io::Result<String> {
+ let mut decoder = Self::new(buf_read);
+ let mut string = String::new();
+ while let Some(result) = decoder.next_lossy() {
+ string.push_str(result?)
+ }
+ Ok(string)
+ }
+
+ pub fn new(buf_read: B) -> Self {
+ Self {
+ buf_read,
+ bytes_consumed: 0,
+ incomplete: Incomplete::empty(),
+ }
+ }
+
+ /// Same as `BufReadDecoder::next_strict`, but replace UTF-8 errors with U+FFFD.
+ pub fn next_lossy(&mut self) -> Option<io::Result<&str>> {
+ self.next_strict().map(|result| result.or_else(|e| e.lossy()))
+ }
+
+ /// Decode and consume the next chunk of UTF-8 input.
+ ///
+ /// This method is intended to be called repeatedly until it returns `None`,
+ /// which represents EOF from the underlying byte stream.
+ /// This is similar to `Iterator::next`,
+ /// except that decoded chunks borrow the decoder (~iterator)
+ /// so they need to be handled or copied before the next chunk can start decoding.
+ pub fn next_strict(&mut self) -> Option<Result<&str, BufReadDecoderError>> {
+ enum BytesSource {
+ BufRead(usize),
+ Incomplete,
+ }
+ macro_rules! try_io {
+ ($io_result: expr) => {
+ match $io_result {
+ Ok(value) => value,
+ Err(error) => return Some(Err(BufReadDecoderError::Io(error)))
+ }
+ }
+ }
+ let (source, result) = loop {
+ if self.bytes_consumed > 0 {
+ self.buf_read.consume(self.bytes_consumed);
+ self.bytes_consumed = 0;
+ }
+ let buf = try_io!(self.buf_read.fill_buf());
+
+ // Force loop iteration to go through an explicit `continue`
+ enum Unreachable {}
+ let _: Unreachable = if self.incomplete.is_empty() {
+ if buf.is_empty() {
+ return None // EOF
+ }
+ match str::from_utf8(buf) {
+ Ok(_) => {
+ break (BytesSource::BufRead(buf.len()), Ok(()))
+ }
+ Err(error) => {
+ let valid_up_to = error.valid_up_to();
+ if valid_up_to > 0 {
+ break (BytesSource::BufRead(valid_up_to), Ok(()))
+ }
+ match error.error_len() {
+ Some(invalid_sequence_length) => {
+ break (BytesSource::BufRead(invalid_sequence_length), Err(()))
+ }
+ None => {
+ self.bytes_consumed = buf.len();
+ self.incomplete = Incomplete::new(buf);
+ // need more input bytes
+ continue
+ }
+ }
+ }
+ }
+ } else {
+ if buf.is_empty() {
+ break (BytesSource::Incomplete, Err(())) // EOF with incomplete code point
+ }
+ let (consumed, opt_result) = self.incomplete.try_complete_offsets(buf);
+ self.bytes_consumed = consumed;
+ match opt_result {
+ None => {
+ // need more input bytes
+ continue
+ }
+ Some(result) => {
+ break (BytesSource::Incomplete, result)
+ }
+ }
+ };
+ };
+ let bytes = match source {
+ BytesSource::BufRead(byte_count) => {
+ self.bytes_consumed = byte_count;
+ let buf = try_io!(self.buf_read.fill_buf());
+ &buf[..byte_count]
+ }
+ BytesSource::Incomplete => {
+ self.incomplete.take_buffer()
+ }
+ };
+ match result {
+ Ok(()) => Some(Ok(unsafe { str::from_utf8_unchecked(bytes) })),
+ Err(()) => Some(Err(BufReadDecoderError::InvalidByteSequence(bytes))),
+ }
+ }
+}
diff --git a/crates/utf-8/tests/unit.rs b/crates/utf-8/tests/unit.rs
new file mode 100644
index 0000000..6839e84
--- /dev/null
+++ b/crates/utf-8/tests/unit.rs
@@ -0,0 +1,197 @@
+extern crate utf8;
+
+use std::borrow::Cow;
+use std::collections::VecDeque;
+use std::io;
+use utf8::*;
+
+/// A re-implementation of std::str::from_utf8
+pub fn str_from_utf8(input: &[u8]) -> Result<&str, usize> {
+ match decode(input) {
+ Ok(s) => return Ok(s),
+ Err(DecodeError::Invalid { valid_prefix, .. }) |
+ Err(DecodeError::Incomplete { valid_prefix, .. }) => Err(valid_prefix.len()),
+ }
+}
+
+#[test]
+fn test_str_from_utf8() {
+ let xs = b"hello";
+ assert_eq!(str_from_utf8(xs), Ok("hello"));
+
+ let xs = "ศไทย中华Việt Nam".as_bytes();
+ assert_eq!(str_from_utf8(xs), Ok("ศไทย中华Việt Nam"));
+
+ let xs = b"hello\xFF";
+ assert!(str_from_utf8(xs).is_err());
+}
+
+#[test]
+fn test_is_utf8() {
+ // Chars of 1, 2, 3, and 4 bytes
+ assert!(str_from_utf8("eé€\u{10000}".as_bytes()).is_ok());
+ // invalid prefix
+ assert!(str_from_utf8(&[0x80]).is_err());
+ // invalid 2 byte prefix
+ assert!(str_from_utf8(&[0xc0]).is_err());
+ assert!(str_from_utf8(&[0xc0, 0x10]).is_err());
+ // invalid 3 byte prefix
+ assert!(str_from_utf8(&[0xe0]).is_err());
+ assert!(str_from_utf8(&[0xe0, 0x10]).is_err());
+ assert!(str_from_utf8(&[0xe0, 0xff, 0x10]).is_err());
+ // invalid 4 byte prefix
+ assert!(str_from_utf8(&[0xf0]).is_err());
+ assert!(str_from_utf8(&[0xf0, 0x10]).is_err());
+ assert!(str_from_utf8(&[0xf0, 0xff, 0x10]).is_err());
+ assert!(str_from_utf8(&[0xf0, 0xff, 0xff, 0x10]).is_err());
+
+ // deny overlong encodings
+ assert!(str_from_utf8(&[0xc0, 0x80]).is_err());
+ assert!(str_from_utf8(&[0xc0, 0xae]).is_err());
+ assert!(str_from_utf8(&[0xe0, 0x80, 0x80]).is_err());
+ assert!(str_from_utf8(&[0xe0, 0x80, 0xaf]).is_err());
+ assert!(str_from_utf8(&[0xe0, 0x81, 0x81]).is_err());
+ assert!(str_from_utf8(&[0xf0, 0x82, 0x82, 0xac]).is_err());
+ assert!(str_from_utf8(&[0xf4, 0x90, 0x80, 0x80]).is_err());
+
+ // deny surrogates
+ assert!(str_from_utf8(&[0xED, 0xA0, 0x80]).is_err());
+ assert!(str_from_utf8(&[0xED, 0xBF, 0xBF]).is_err());
+
+ assert!(str_from_utf8(&[0xC2, 0x80]).is_ok());
+ assert!(str_from_utf8(&[0xDF, 0xBF]).is_ok());
+ assert!(str_from_utf8(&[0xE0, 0xA0, 0x80]).is_ok());
+ assert!(str_from_utf8(&[0xED, 0x9F, 0xBF]).is_ok());
+ assert!(str_from_utf8(&[0xEE, 0x80, 0x80]).is_ok());
+ assert!(str_from_utf8(&[0xEF, 0xBF, 0xBF]).is_ok());
+ assert!(str_from_utf8(&[0xF0, 0x90, 0x80, 0x80]).is_ok());
+ assert!(str_from_utf8(&[0xF4, 0x8F, 0xBF, 0xBF]).is_ok());
+}
+
+/// A re-implementation of String::from_utf8_lossy
+pub fn string_from_utf8_lossy(input: &[u8]) -> Cow<str> {
+ let mut result = decode(input);
+ if let Ok(s) = result {
+ return s.into()
+ }
+ let mut string = String::with_capacity(input.len() + REPLACEMENT_CHARACTER.len());
+ loop {
+ match result {
+ Ok(s) => {
+ string.push_str(s);
+ return string.into()
+ }
+ Err(DecodeError::Incomplete { valid_prefix, .. }) => {
+ string.push_str(valid_prefix);
+ string.push_str(REPLACEMENT_CHARACTER);
+ return string.into()
+ }
+ Err(DecodeError::Invalid { valid_prefix, remaining_input, .. }) => {
+ string.push_str(valid_prefix);
+ string.push_str(REPLACEMENT_CHARACTER);
+ result = decode(remaining_input);
+ }
+ }
+ }
+}
+
+pub const DECODED_LOSSY: &'static [(&'static [u8], &'static str)] = &[
+ (b"hello", "hello"),
+ (b"\xe0\xb8\xa8\xe0\xb9\x84\xe0\xb8\x97\xe0\xb8\xa2\xe4\xb8\xad\xe5\x8d\x8e", "ศไทย中华"),
+ (b"Vi\xe1\xbb\x87t Nam", "Việt Nam"),
+ (b"Hello\xC2 There\xFF ", "Hello\u{FFFD} There\u{FFFD} "),
+ (b"Hello\xC0\x80 There", "Hello\u{FFFD}\u{FFFD} There"),
+ (b"\xE6\x83 Goodbye", "\u{FFFD} Goodbye"),
+ (b"\xF5foo\xF5\x80bar", "\u{FFFD}foo\u{FFFD}\u{FFFD}bar"),
+ (b"\xF5foo\xF5\xC2", "\u{FFFD}foo\u{FFFD}\u{FFFD}"),
+ (b"\xF1foo\xF1\x80bar\xF1\x80\x80baz", "\u{FFFD}foo\u{FFFD}bar\u{FFFD}baz"),
+ (b"\xF4foo\xF4\x80bar\xF4\xBFbaz", "\u{FFFD}foo\u{FFFD}bar\u{FFFD}\u{FFFD}baz"),
+ (b"\xF0\x80\x80\x80foo\xF0\x90\x80\x80bar", "\u{FFFD}\u{FFFD}\u{FFFD}\u{FFFD}foo\u{10000}bar"),
+ (b"\xF0\x90\x80foo", "\u{FFFD}foo"),
+ // surrogates
+ (b"\xED\xA0\x80foo\xED\xBF\xBFbar", "\u{FFFD}\u{FFFD}\u{FFFD}foo\u{FFFD}\u{FFFD}\u{FFFD}bar"),
+];
+
+#[test]
+fn test_string_from_utf8_lossy() {
+ for &(input, expected) in DECODED_LOSSY {
+ assert_eq!(string_from_utf8_lossy(input), expected);
+ }
+}
+
+pub fn all_partitions<'a, F>(input: &'a [u8], f: F)
+ where F: Fn(&[&[u8]])
+{
+
+ fn all_partitions_inner<'a, F>(chunks: &mut Vec<&'a [u8]>, input: &'a [u8], f: &F)
+ where F: Fn(&[&[u8]])
+ {
+ if input.is_empty() {
+ f(chunks)
+ }
+ for i in 1..(input.len() + 1) {
+ chunks.push(&input[..i]);
+ all_partitions_inner(chunks, &input[i..], f);
+ chunks.pop();
+ }
+ }
+
+ let mut chunks = Vec::new();
+ all_partitions_inner(&mut chunks, input, &f);
+ assert_eq!(chunks.len(), 0);
+}
+
+#[test]
+fn test_incremental_decoder() {
+ for &(input, expected) in DECODED_LOSSY {
+ all_partitions(input, |chunks| {
+ let mut string = String::new();
+ {
+ let mut decoder = LossyDecoder::new(|s| string.push_str(s));
+ for &chunk in &*chunks {
+ decoder.feed(chunk);
+ }
+ }
+ assert_eq!(string, expected);
+ });
+ }
+}
+
+#[test]
+fn test_bufread_decoder() {
+ for &(input, expected) in DECODED_LOSSY {
+ all_partitions(input, |chunks| {
+ let chunks = Chunks(chunks.to_vec().into());
+ let string = BufReadDecoder::read_to_string_lossy(chunks).unwrap();
+ assert_eq!(string, expected)
+ });
+ }
+}
+
+struct Chunks<'a>(VecDeque<&'a [u8]>);
+
+impl<'a> io::Read for Chunks<'a> {
+ fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
+ unimplemented!()
+ }
+}
+
+impl<'a> io::BufRead for Chunks<'a> {
+ fn fill_buf(&mut self) -> io::Result<&[u8]> {
+ Ok(*self.0.front().unwrap())
+ }
+
+ fn consume(&mut self, bytes: usize) {
+ {
+ let front = self.0.front_mut().unwrap();
+ *front = &front[bytes..];
+ if !front.is_empty() {
+ return
+ }
+ }
+ if self.0.len() > 1 {
+ self.0.pop_front();
+ }
+ }
+
+}
diff --git a/crates/uuid/.cargo-checksum.json b/crates/uuid/.cargo-checksum.json
new file mode 100644
index 0000000..63a4c55
--- /dev/null
+++ b/crates/uuid/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"97148562e0953fb78f1a174448530dc5fefedf983ca46c21c4bffb06fd997351","LICENSE-APACHE":"a60eea817514531668d7e00765731449fe14d059d3249e0bc93b36de45f759f2","LICENSE-MIT":"436bc5a105d8e57dcd8778730f3754f7bf39c14d2f530e4cde4bd2d17a83ec3d","README.md":"5ce601f007d7c2c3b13068a7e9938e08aca71944cb0b4179c627196b06a70a7a","src/builder.rs":"2d6e3bf66fc87e36c44b1a8c108dca70f01f6296ac0d50d0a788b69b5a3dff88","src/error.rs":"621799694111aab9d6e570290f4d1b341fe6be58d2b3425fa7891ada7575cab7","src/external.rs":"a0640bdb98de1c24fcc9851a438a5abe6f7e3acb195885c817a64fac25521b9d","src/external/arbitrary_support.rs":"7e7fbcc4b8af5878b71858a1f5fa31e85d84fc2fd159614f8d450ba1fe06ac28","src/external/borsh_support.rs":"b49d82a59653445ba26db46a1515294b1ab480c0671dbe5499dfd1fb02588b3b","src/external/serde_support.rs":"1263176b9916bf61fe3ab32140c22e2e757ea29ffff6f5459b1b720acbe2ed9d","src/external/slog_support.rs":"53c6251e424bdc9b6ba35defb4c723d4d34d44053badbf98e1c7c3e7c83fbb5e","src/fmt.rs":"3bf88d68d838bef81380a1e669a86eee46f24a8113effbd7b4e92da714ec97c7","src/lib.rs":"96d77474e7d9312cc287c5fad2fa44caf775ef0ce7da825e90c736cbcee615d4","src/macros.rs":"8fa9380a39e9952f6adc9eb858264fc09219a97215f4e54768d9e0ec7f520db7","src/md5.rs":"316d65b760ffa58beb6aa678be24359eb21a744e9e143bc99c11fe1907659245","src/parser.rs":"3f30a776ed1792107fed88c15fb393167283cc487efc647fb6504824a4fc3afb","src/rng.rs":"b9f69610560aa5b5d9b2eaa16fb2239515bd163da126cf5c392e5fb9b0296c3e","src/sha1.rs":"e1a9657e11f1ed1ede33c0655f9c2641059b7c24f17be4ac425c930cc216e019","src/timestamp.rs":"2b50321ee768cd9c3ad5bdf1e4924e8e5deaa8d1a031d24dcfaf2fec44530429","src/v1.rs":"123c4b23d0458e77e6c3ed6235e0c786436e53f53d1c8074cf80d77c2ae40611","src/v3.rs":"b7d605c4d2f56a9e57bfe779ef2488fa612c7cb28568f68252093f48ac2edef4","src/v4.rs":"4f06567460871348df0ff2825e9faad9d950a9337e409cb2b568c86118addb97","src/v5.rs":"64e3feb673c8411954f930188e756803b90b57d13ec36652cd2c669e81654333","src/v6.rs":"2dd938c5bf6d1960f4fb7d179a6163c1cfd76ab24f98aaca85d0f74940184645","src/v7.rs":"e46924c0c9c9b1ac6746180d78cd3531920fbd8379f1629abdcec7914bae36c8","src/v8.rs":"8705405fef52e4706c7cf99f7ed231dde733b7cd08ced79be9e29c949be2280f"},"package":"f00cc9702ca12d3c81455259621e676d0f7251cec66a21e98fe2e9a37db93b2a"}
\ No newline at end of file
diff --git a/crates/uuid/Android.bp b/crates/uuid/Android.bp
new file mode 100644
index 0000000..5d7f1fc
--- /dev/null
+++ b/crates/uuid/Android.bp
@@ -0,0 +1,99 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_uuid_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_uuid_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libuuid",
+ host_supported: true,
+ crate_name: "uuid",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.7.0",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "atomic",
+ "rng",
+ "serde",
+ "std",
+ "v1",
+ "v4",
+ ],
+ rustlibs: [
+ "libatomic_rust",
+ "libgetrandom",
+ "libserde",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "uuid_test_src_lib",
+ host_supported: true,
+ crate_name: "uuid",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.7.0",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "atomic",
+ "rng",
+ "serde",
+ "std",
+ "v1",
+ "v4",
+ ],
+ rustlibs: [
+ "libatomic_rust",
+ "libbincode",
+ "libgetrandom",
+ "libserde",
+ "libserde_json",
+ "libserde_test",
+ ],
+ proc_macros: [
+ "librustversion",
+ "libserde_derive",
+ ],
+}
+
+rust_library_rlib {
+ name: "libuuid_nostd",
+ crate_name: "uuid",
+ cargo_env_compat: true,
+ cargo_pkg_version: "1.7.0",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ prefer_rlib: true,
+ no_stdlibs: true,
+ stdlibs: [
+ "libcompiler_builtins.rust_sysroot",
+ "libcore.rust_sysroot",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/uuid/Cargo.toml b/crates/uuid/Cargo.toml
new file mode 100644
index 0000000..320fd4c
--- /dev/null
+++ b/crates/uuid/Cargo.toml
@@ -0,0 +1,208 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.60.0"
+name = "uuid"
+version = "1.7.0"
+authors = [
+ "Ashley Mannix<[email protected]>",
+ "Christopher Armstrong",
+ "Dylan DPC<[email protected]>",
+ "Hunar Roop Kahlon<[email protected]>",
+]
+include = [
+ "src",
+ "README.md",
+ "LICENSE-APACHE",
+ "LICENSE-MIT",
+]
+description = "A library to generate and parse UUIDs."
+homepage = "https://github.com/uuid-rs/uuid"
+documentation = "https://docs.rs/uuid"
+readme = "README.md"
+keywords = [
+ "guid",
+ "unique",
+ "uuid",
+]
+categories = [
+ "data-structures",
+ "no-std",
+ "parser-implementations",
+ "wasm",
+]
+license = "Apache-2.0 OR MIT"
+repository = "https://github.com/uuid-rs/uuid"
+
+[package.metadata.docs.rs]
+features = [
+ "serde",
+ "arbitrary",
+ "slog",
+ "borsh",
+ "v1",
+ "v3",
+ "v4",
+ "v5",
+ "v6",
+ "v7",
+ "v8",
+]
+rustc-args = [
+ "--cfg",
+ "uuid_unstable",
+]
+rustdoc-args = [
+ "--cfg",
+ "uuid_unstable",
+]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[package.metadata.playground]
+features = [
+ "serde",
+ "v1",
+ "v3",
+ "v4",
+ "v5",
+ "v6",
+ "v7",
+ "v8",
+]
+
+[dependencies.arbitrary]
+version = "1.1.3"
+optional = true
+
+[dependencies.atomic]
+version = "0.5"
+optional = true
+default-features = false
+
+[dependencies.borsh]
+version = "1"
+optional = true
+default-features = false
+
+[dependencies.borsh-derive]
+version = "1"
+optional = true
+default-features = false
+
+[dependencies.bytemuck]
+version = "1.14.0"
+features = ["derive"]
+optional = true
+
+[dependencies.getrandom]
+version = "0.2"
+optional = true
+
+[dependencies.md-5]
+version = "0.10"
+optional = true
+default-features = false
+
+[dependencies.rand]
+version = "0.8"
+optional = true
+
+[dependencies.serde]
+version = "1.0.56"
+optional = true
+default-features = false
+
+[dependencies.sha1_smol]
+version = "1"
+optional = true
+default-features = false
+
+[dependencies.slog]
+version = "2"
+optional = true
+
+[dependencies.uuid-macro-internal]
+version = "1.7.0"
+optional = true
+
+[dependencies.wasm-bindgen]
+version = "0.2"
+optional = true
+
+[dependencies.zerocopy]
+version = "0.6"
+optional = true
+
+[dev-dependencies.bincode]
+version = "1.0"
+
+[dev-dependencies.rustversion]
+version = "1"
+
+[dev-dependencies.serde_derive]
+version = "1.0.79"
+
+[dev-dependencies.serde_json]
+version = "1.0"
+
+[dev-dependencies.serde_test]
+version = "1.0.56"
+
+[dev-dependencies.trybuild]
+version = "1.0.52"
+
+[features]
+atomic = ["dep:atomic"]
+borsh = [
+ "dep:borsh",
+ "dep:borsh-derive",
+]
+default = ["std"]
+fast-rng = [
+ "rng",
+ "dep:rand",
+]
+js = [
+ "dep:wasm-bindgen",
+ "getrandom?/js",
+]
+macro-diagnostics = ["dep:uuid-macro-internal"]
+md5 = ["dep:md-5"]
+rng = ["dep:getrandom"]
+sha1 = ["dep:sha1_smol"]
+std = []
+v1 = ["atomic"]
+v3 = ["md5"]
+v4 = ["rng"]
+v5 = ["sha1"]
+v6 = ["atomic"]
+v7 = [
+ "atomic",
+ "rng",
+]
+v8 = []
+
+[target."cfg(all(target_arch = \"wasm32\", target_vendor = \"unknown\", target_os = \"unknown\"))".dev-dependencies.wasm-bindgen-test]
+version = "0.3"
+
+[target."cfg(target = \"wasm32-unknown-unknown\")".dev-dependencies.wasm-bindgen]
+version = "0.2"
+
+[badges.is-it-maintained-issue-resolution]
+repository = "uuid-rs/uuid"
+
+[badges.is-it-maintained-open-issues]
+repository = "uuid-rs/uuid"
+
+[badges.maintenance]
+status = "actively-developed"
diff --git a/crates/uuid/LICENSE b/crates/uuid/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/uuid/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/uuid/LICENSE-APACHE b/crates/uuid/LICENSE-APACHE
new file mode 100644
index 0000000..16fe87b
--- /dev/null
+++ b/crates/uuid/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/uuid/LICENSE-MIT b/crates/uuid/LICENSE-MIT
new file mode 100644
index 0000000..99a3078
--- /dev/null
+++ b/crates/uuid/LICENSE-MIT
@@ -0,0 +1,26 @@
+Copyright (c) 2014 The Rust Project Developers
+Copyright (c) 2018 Ashley Mannix, Christopher Armstrong, Dylan DPC, Hunar Roop Kahlon
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/uuid/METADATA b/crates/uuid/METADATA
new file mode 100644
index 0000000..51da58e
--- /dev/null
+++ b/crates/uuid/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/uuid
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "uuid"
+description: "A library to generate and parse UUIDs."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 7
+ }
+ homepage: "https://crates.io/crates/uuid"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/uuid/uuid-1.7.0.crate"
+ version: "1.7.0"
+ }
+}
diff --git a/crates/uuid/MODULE_LICENSE_APACHE2 b/crates/uuid/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/uuid/MODULE_LICENSE_APACHE2
diff --git a/crates/uuid/README.md b/crates/uuid/README.md
new file mode 100644
index 0000000..a1aba43
--- /dev/null
+++ b/crates/uuid/README.md
@@ -0,0 +1,93 @@
+# `uuid`
+
+[](https://crates.io/crates/uuid)
+[](https://github.com/uuid-rs/uuid/actions/workflows/ci.yml)
+
+Here's an example of a UUID:
+
+```text
+67e55044-10b1-426f-9247-bb680e5fe0c8
+```
+
+A UUID is a unique 128-bit value, stored as 16 octets, and regularly
+formatted as a hex string in five groups. UUIDs are used to assign unique
+identifiers to entities without requiring a central allocating authority.
+
+They are particularly useful in distributed systems, though can be used in
+disparate areas, such as databases and network protocols. Typically a UUID
+is displayed in a readable string form as a sequence of hexadecimal digits,
+separated into groups by hyphens.
+
+The uniqueness property is not strictly guaranteed, however for all
+practical purposes, it can be assumed that an unintentional collision would
+be extremely unlikely.
+
+## Getting started
+
+Add the following to your `Cargo.toml`:
+
+```toml
+[dependencies.uuid]
+version = "1.7.0"
+features = [
+ "v4", # Lets you generate random UUIDs
+ "fast-rng", # Use a faster (but still sufficiently random) RNG
+ "macro-diagnostics", # Enable better diagnostics for compile-time UUIDs
+]
+```
+
+When you want a UUID, you can generate one:
+
+```rust
+use uuid::Uuid;
+
+let id = Uuid::new_v4();
+```
+
+If you have a UUID value, you can use its string literal form inline:
+
+```rust
+use uuid::{uuid, Uuid};
+
+const ID: Uuid = uuid!("67e55044-10b1-426f-9247-bb680e5fe0c8");
+```
+
+You can also parse UUIDs without needing any crate features:
+
+```rust
+use uuid::{Uuid, Version};
+
+let my_uuid = Uuid::parse_str("67e55044-10b1-426f-9247-bb680e5fe0c8")?;
+
+assert_eq!(Some(Version::Random), my_uuid.get_version());
+```
+
+If you'd like to parse UUIDs _really_ fast, check out the [`uuid-simd`](https://github.com/nugine/uuid-simd)
+library.
+
+For more details on using `uuid`, [see the library documentation](https://docs.rs/uuid/1.7.0/uuid).
+
+## References
+
+* [`uuid` library docs](https://docs.rs/uuid/1.7.0/uuid).
+* [Wikipedia: Universally Unique Identifier](http://en.wikipedia.org/wiki/Universally_unique_identifier).
+* [RFC4122: A Universally Unique IDentifier (UUID) URN Namespace](http://tools.ietf.org/html/rfc4122).
+
+---
+# License
+
+Licensed under either of
+
+* Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
+* MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)
+
+at your option.
+
+
+[](https://app.fossa.com/projects/git%2Bgithub.com%2Fuuid-rs%2Fuuid?ref=badge_large)
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall
+be dual licensed as above, without any additional terms or conditions.
diff --git a/crates/uuid/TEST_MAPPING b/crates/uuid/TEST_MAPPING
new file mode 100644
index 0000000..f5960e5
--- /dev/null
+++ b/crates/uuid/TEST_MAPPING
@@ -0,0 +1,26 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "packages/modules/Virtualization/apkdmverity"
+ },
+ {
+ "path": "packages/modules/Virtualization/authfs"
+ },
+ {
+ "path": "packages/modules/Virtualization/encryptedstore"
+ },
+ {
+ "path": "packages/modules/Virtualization/libs/devicemapper"
+ },
+ {
+ "path": "packages/modules/Virtualization/microdroid_manager"
+ },
+ {
+ "path": "packages/modules/Virtualization/virtualizationmanager"
+ },
+ {
+ "path": "packages/modules/Virtualization/zipfuse"
+ }
+ ]
+}
diff --git a/crates/uuid/cargo_embargo.json b/crates/uuid/cargo_embargo.json
new file mode 100644
index 0000000..bb60a33
--- /dev/null
+++ b/crates/uuid/cargo_embargo.json
@@ -0,0 +1,32 @@
+{
+ "run_cargo": false,
+ "package": {
+ "uuid": {
+ "dep_blocklist": ["libtrybuild"]
+ }
+ },
+ "variants": [
+ {
+ "tests": true,
+ "features": [
+ "serde",
+ "std",
+ "v1",
+ "v4"
+ ]
+ },
+ {
+ "features": [],
+ "module_name_overrides": {
+ "libuuid": "libuuid_nostd"
+ },
+ "package": {
+ "uuid": {
+ "force_rlib": true,
+ "host_supported": false,
+ "no_std": true
+ }
+ }
+ }
+ ]
+}
diff --git a/crates/uuid/src/builder.rs b/crates/uuid/src/builder.rs
new file mode 100644
index 0000000..2dd68a2
--- /dev/null
+++ b/crates/uuid/src/builder.rs
@@ -0,0 +1,903 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! A Builder type for [`Uuid`]s.
+//!
+//! [`Uuid`]: ../struct.Uuid.html
+
+use crate::{error::*, timestamp, Bytes, Uuid, Variant, Version};
+
+/// A builder for creating a UUID.
+///
+/// This type is useful if you need to mutate individual fields of a [`Uuid`]
+/// while constructing it. Since the [`Uuid`] type is `Copy`, it doesn't offer
+/// any methods to mutate in place. They live on the `Builder` instead.
+///
+/// The `Builder` type also always exposes APIs to construct [`Uuid`]s for any
+/// version without needing crate features or additional dependencies. It's a
+/// lower-level API than the methods on [`Uuid`].
+///
+/// # Examples
+///
+/// Creating a version 4 UUID from externally generated random bytes:
+///
+/// ```
+/// # use uuid::{Builder, Version, Variant};
+/// # let rng = || [
+/// # 70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90,
+/// # 145, 63, 62,
+/// # ];
+/// let random_bytes = rng();
+///
+/// let uuid = Builder::from_random_bytes(random_bytes).into_uuid();
+///
+/// assert_eq!(Some(Version::Random), uuid.get_version());
+/// assert_eq!(Variant::RFC4122, uuid.get_variant());
+/// ```
+#[allow(missing_copy_implementations)]
+#[derive(Debug)]
+pub struct Builder(Uuid);
+
+impl Uuid {
+ /// The 'nil UUID' (all zeros).
+ ///
+ /// The nil UUID is a special form of UUID that is specified to have all
+ /// 128 bits set to zero.
+ ///
+ /// # References
+ ///
+ /// * [Nil UUID in RFC4122](https://tools.ietf.org/html/rfc4122.html#section-4.1.7)
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let uuid = Uuid::nil();
+ ///
+ /// assert_eq!(
+ /// "00000000-0000-0000-0000-000000000000",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn nil() -> Self {
+ Uuid::from_bytes([0; 16])
+ }
+
+ /// The 'max UUID' (all ones).
+ ///
+ /// The max UUID is a special form of UUID that is specified to have all
+ /// 128 bits set to one.
+ ///
+ /// # References
+ ///
+ /// * [Max UUID in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-5.4)
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let uuid = Uuid::max();
+ ///
+ /// assert_eq!(
+ /// "ffffffff-ffff-ffff-ffff-ffffffffffff",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn max() -> Self {
+ Uuid::from_bytes([0xFF; 16])
+ }
+
+ /// Creates a UUID from four field values.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let d1 = 0xa1a2a3a4;
+ /// let d2 = 0xb1b2;
+ /// let d3 = 0xc1c2;
+ /// let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+ ///
+ /// let uuid = Uuid::from_fields(d1, d2, d3, &d4);
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8; 8]) -> Uuid {
+ Uuid::from_bytes([
+ (d1 >> 24) as u8,
+ (d1 >> 16) as u8,
+ (d1 >> 8) as u8,
+ d1 as u8,
+ (d2 >> 8) as u8,
+ d2 as u8,
+ (d3 >> 8) as u8,
+ d3 as u8,
+ d4[0],
+ d4[1],
+ d4[2],
+ d4[3],
+ d4[4],
+ d4[5],
+ d4[6],
+ d4[7],
+ ])
+ }
+
+ /// Creates a UUID from four field values in little-endian order.
+ ///
+ /// The bytes in the `d1`, `d2` and `d3` fields will be flipped to convert
+ /// into big-endian order. This is based on the endianness of the UUID,
+ /// rather than the target environment so bytes will be flipped on both
+ /// big and little endian machines.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let d1 = 0xa1a2a3a4;
+ /// let d2 = 0xb1b2;
+ /// let d3 = 0xc1c2;
+ /// let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+ ///
+ /// let uuid = Uuid::from_fields_le(d1, d2, d3, &d4);
+ ///
+ /// assert_eq!(
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_fields_le(d1: u32, d2: u16, d3: u16, d4: &[u8; 8]) -> Uuid {
+ Uuid::from_bytes([
+ d1 as u8,
+ (d1 >> 8) as u8,
+ (d1 >> 16) as u8,
+ (d1 >> 24) as u8,
+ (d2) as u8,
+ (d2 >> 8) as u8,
+ d3 as u8,
+ (d3 >> 8) as u8,
+ d4[0],
+ d4[1],
+ d4[2],
+ d4[3],
+ d4[4],
+ d4[5],
+ d4[6],
+ d4[7],
+ ])
+ }
+
+ /// Creates a UUID from a 128bit value.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let v = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8u128;
+ ///
+ /// let uuid = Uuid::from_u128(v);
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_u128(v: u128) -> Self {
+ Uuid::from_bytes([
+ (v >> 120) as u8,
+ (v >> 112) as u8,
+ (v >> 104) as u8,
+ (v >> 96) as u8,
+ (v >> 88) as u8,
+ (v >> 80) as u8,
+ (v >> 72) as u8,
+ (v >> 64) as u8,
+ (v >> 56) as u8,
+ (v >> 48) as u8,
+ (v >> 40) as u8,
+ (v >> 32) as u8,
+ (v >> 24) as u8,
+ (v >> 16) as u8,
+ (v >> 8) as u8,
+ v as u8,
+ ])
+ }
+
+ /// Creates a UUID from a 128bit value in little-endian order.
+ ///
+ /// The entire value will be flipped to convert into big-endian order.
+ /// This is based on the endianness of the UUID, rather than the target
+ /// environment so bytes will be flipped on both big and little endian
+ /// machines.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let v = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8u128;
+ ///
+ /// let uuid = Uuid::from_u128_le(v);
+ ///
+ /// assert_eq!(
+ /// "d8d7d6d5-d4d3-d2d1-c2c1-b2b1a4a3a2a1",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_u128_le(v: u128) -> Self {
+ Uuid::from_bytes([
+ v as u8,
+ (v >> 8) as u8,
+ (v >> 16) as u8,
+ (v >> 24) as u8,
+ (v >> 32) as u8,
+ (v >> 40) as u8,
+ (v >> 48) as u8,
+ (v >> 56) as u8,
+ (v >> 64) as u8,
+ (v >> 72) as u8,
+ (v >> 80) as u8,
+ (v >> 88) as u8,
+ (v >> 96) as u8,
+ (v >> 104) as u8,
+ (v >> 112) as u8,
+ (v >> 120) as u8,
+ ])
+ }
+
+ /// Creates a UUID from two 64bit values.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let hi = 0xa1a2a3a4b1b2c1c2u64;
+ /// let lo = 0xd1d2d3d4d5d6d7d8u64;
+ ///
+ /// let uuid = Uuid::from_u64_pair(hi, lo);
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_u64_pair(high_bits: u64, low_bits: u64) -> Self {
+ Uuid::from_bytes([
+ (high_bits >> 56) as u8,
+ (high_bits >> 48) as u8,
+ (high_bits >> 40) as u8,
+ (high_bits >> 32) as u8,
+ (high_bits >> 24) as u8,
+ (high_bits >> 16) as u8,
+ (high_bits >> 8) as u8,
+ high_bits as u8,
+ (low_bits >> 56) as u8,
+ (low_bits >> 48) as u8,
+ (low_bits >> 40) as u8,
+ (low_bits >> 32) as u8,
+ (low_bits >> 24) as u8,
+ (low_bits >> 16) as u8,
+ (low_bits >> 8) as u8,
+ low_bits as u8,
+ ])
+ }
+
+ /// Creates a UUID using the supplied bytes.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an error if `b` has any length other than 16.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Uuid::from_slice(&bytes)?;
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn from_slice(b: &[u8]) -> Result<Uuid, Error> {
+ if b.len() != 16 {
+ return Err(Error(ErrorKind::ByteLength { len: b.len() }));
+ }
+
+ let mut bytes: Bytes = [0; 16];
+ bytes.copy_from_slice(b);
+ Ok(Uuid::from_bytes(bytes))
+ }
+
+ /// Creates a UUID using the supplied bytes in little endian order.
+ ///
+ /// The individual fields encoded in the buffer will be flipped.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an error if `b` has any length other than 16.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Uuid::from_slice_le(&bytes)?;
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8"
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn from_slice_le(b: &[u8]) -> Result<Uuid, Error> {
+ if b.len() != 16 {
+ return Err(Error(ErrorKind::ByteLength { len: b.len() }));
+ }
+
+ let mut bytes: Bytes = [0; 16];
+ bytes.copy_from_slice(b);
+ Ok(Uuid::from_bytes_le(bytes))
+ }
+
+ /// Creates a UUID using the supplied bytes.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Uuid::from_bytes(bytes);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ #[inline]
+ pub const fn from_bytes(bytes: Bytes) -> Uuid {
+ Uuid(bytes)
+ }
+
+ /// Creates a UUID using the supplied bytes in little endian order.
+ ///
+ /// The individual fields encoded in the buffer will be flipped.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Uuid::from_bytes_le(bytes);
+ ///
+ /// assert_eq!(
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn from_bytes_le(b: Bytes) -> Uuid {
+ Uuid([
+ b[3], b[2], b[1], b[0], b[5], b[4], b[7], b[6], b[8], b[9], b[10], b[11], b[12], b[13],
+ b[14], b[15],
+ ])
+ }
+
+ /// Creates a reference to a UUID from a reference to the supplied bytes.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Uuid::from_bytes_ref(&bytes);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
+ /// );
+ ///
+ /// assert!(std::ptr::eq(
+ /// uuid as *const Uuid as *const u8,
+ /// &bytes as *const [u8; 16] as *const u8,
+ /// ));
+ /// # Ok(())
+ /// # }
+ /// ```
+ #[inline]
+ pub fn from_bytes_ref(bytes: &Bytes) -> &Uuid {
+ // SAFETY: `Bytes` and `Uuid` have the same ABI
+ unsafe { &*(bytes as *const Bytes as *const Uuid) }
+ }
+
+ // NOTE: There is no `from_u128_ref` because in little-endian
+ // environments the value isn't properly encoded. Callers would
+ // need to use `.to_be()` themselves.
+}
+
+impl Builder {
+ /// Creates a `Builder` using the supplied bytes.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Builder::from_bytes(bytes).into_uuid();
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_bytes(b: Bytes) -> Self {
+ Builder(Uuid::from_bytes(b))
+ }
+
+ /// Creates a `Builder` using the supplied bytes in little endian order.
+ ///
+ /// The individual fields encoded in the buffer will be flipped.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// # use uuid::{Builder, Uuid};
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Builder::from_bytes_le(bytes).into_uuid();
+ ///
+ /// assert_eq!(
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn from_bytes_le(b: Bytes) -> Self {
+ Builder(Uuid::from_bytes_le(b))
+ }
+
+ /// Creates a `Builder` for a version 1 UUID using the supplied timestamp and node ID.
+ pub const fn from_rfc4122_timestamp(ticks: u64, counter: u16, node_id: &[u8; 6]) -> Self {
+ Builder(timestamp::encode_rfc4122_timestamp(ticks, counter, node_id))
+ }
+
+ /// Creates a `Builder` for a version 3 UUID using the supplied MD5 hashed bytes.
+ pub const fn from_md5_bytes(md5_bytes: Bytes) -> Self {
+ Builder(Uuid::from_bytes(md5_bytes))
+ .with_variant(Variant::RFC4122)
+ .with_version(Version::Md5)
+ }
+
+ /// Creates a `Builder` for a version 4 UUID using the supplied random bytes.
+ ///
+ /// This method assumes the bytes are already sufficiently random, it will only
+ /// set the appropriate bits for the UUID version and variant.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::{Builder, Variant, Version};
+ /// # let rng = || [
+ /// # 70, 235, 208, 238, 14, 109, 67, 201, 185, 13, 204, 195, 90,
+ /// # 145, 63, 62,
+ /// # ];
+ /// let random_bytes = rng();
+ /// let uuid = Builder::from_random_bytes(random_bytes).into_uuid();
+ ///
+ /// assert_eq!(Some(Version::Random), uuid.get_version());
+ /// assert_eq!(Variant::RFC4122, uuid.get_variant());
+ /// ```
+ pub const fn from_random_bytes(random_bytes: Bytes) -> Self {
+ Builder(Uuid::from_bytes(random_bytes))
+ .with_variant(Variant::RFC4122)
+ .with_version(Version::Random)
+ }
+
+ /// Creates a `Builder` for a version 5 UUID using the supplied SHA-1 hashed bytes.
+ ///
+ /// This method assumes the bytes are already a SHA-1 hash, it will only set the appropriate
+ /// bits for the UUID version and variant.
+ pub const fn from_sha1_bytes(sha1_bytes: Bytes) -> Self {
+ Builder(Uuid::from_bytes(sha1_bytes))
+ .with_variant(Variant::RFC4122)
+ .with_version(Version::Sha1)
+ }
+
+ /// Creates a `Builder` for a version 6 UUID using the supplied timestamp and node ID.
+ ///
+ /// This method will encode the ticks, counter, and node ID in a sortable UUID.
+ pub const fn from_sorted_rfc4122_timestamp(
+ ticks: u64,
+ counter: u16,
+ node_id: &[u8; 6],
+ ) -> Self {
+ Builder(timestamp::encode_sorted_rfc4122_timestamp(
+ ticks, counter, node_id,
+ ))
+ }
+
+ /// Creates a `Builder` for a version 7 UUID using the supplied Unix timestamp and random bytes.
+ ///
+ /// This method assumes the bytes are already sufficiently random.
+ ///
+ /// # Examples
+ ///
+ /// Creating a UUID using the current system timestamp:
+ ///
+ /// ```
+ /// # use std::convert::TryInto;
+ /// use std::time::{Duration, SystemTime};
+ /// # fn main() -> Result<(), Box<dyn std::error::Error>> {
+ /// # use uuid::{Builder, Uuid, Variant, Version, Timestamp, NoContext};
+ /// # let rng = || [
+ /// # 70, 235, 208, 238, 14, 109, 67, 201, 185, 13
+ /// # ];
+ /// let ts = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;
+ ///
+ /// let random_bytes = rng();
+ ///
+ /// let uuid = Builder::from_unix_timestamp_millis(ts.as_millis().try_into()?, &random_bytes).into_uuid();
+ ///
+ /// assert_eq!(Some(Version::SortRand), uuid.get_version());
+ /// assert_eq!(Variant::RFC4122, uuid.get_variant());
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn from_unix_timestamp_millis(millis: u64, random_bytes: &[u8; 10]) -> Self {
+ Builder(timestamp::encode_unix_timestamp_millis(
+ millis,
+ random_bytes,
+ ))
+ }
+
+ /// Creates a `Builder` for a version 8 UUID using the supplied user-defined bytes.
+ ///
+ /// This method won't interpret the given bytes in any way, except to set the appropriate
+ /// bits for the UUID version and variant.
+ pub const fn from_custom_bytes(custom_bytes: Bytes) -> Self {
+ Builder::from_bytes(custom_bytes)
+ .with_variant(Variant::RFC4122)
+ .with_version(Version::Custom)
+ }
+
+ /// Creates a `Builder` using the supplied bytes.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an error if `b` has any length other than 16.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Builder::from_slice(&bytes)?.into_uuid();
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn from_slice(b: &[u8]) -> Result<Self, Error> {
+ Ok(Builder(Uuid::from_slice(b)?))
+ }
+
+ /// Creates a `Builder` using the supplied bytes in little endian order.
+ ///
+ /// The individual fields encoded in the buffer will be flipped.
+ ///
+ /// # Errors
+ ///
+ /// This function will return an error if `b` has any length other than 16.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ ///
+ /// let uuid = Builder::from_slice_le(&bytes)?.into_uuid();
+ ///
+ /// assert_eq!(
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn from_slice_le(b: &[u8]) -> Result<Self, Error> {
+ Ok(Builder(Uuid::from_slice_le(b)?))
+ }
+
+ /// Creates a `Builder` from four field values.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let d1 = 0xa1a2a3a4;
+ /// let d2 = 0xb1b2;
+ /// let d3 = 0xc1c2;
+ /// let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+ ///
+ /// let uuid = Builder::from_fields(d1, d2, d3, &d4).into_uuid();
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8"
+ /// );
+ /// ```
+ pub const fn from_fields(d1: u32, d2: u16, d3: u16, d4: &[u8; 8]) -> Self {
+ Builder(Uuid::from_fields(d1, d2, d3, d4))
+ }
+
+ /// Creates a `Builder` from four field values.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let d1 = 0xa1a2a3a4;
+ /// let d2 = 0xb1b2;
+ /// let d3 = 0xc1c2;
+ /// let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+ ///
+ /// let uuid = Builder::from_fields_le(d1, d2, d3, &d4).into_uuid();
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "a4a3a2a1-b2b1-c2c1-d1d2-d3d4d5d6d7d8"
+ /// );
+ /// ```
+ pub const fn from_fields_le(d1: u32, d2: u16, d3: u16, d4: &[u8; 8]) -> Self {
+ Builder(Uuid::from_fields_le(d1, d2, d3, d4))
+ }
+
+ /// Creates a `Builder` from a 128bit value.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let v = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8u128;
+ ///
+ /// let uuid = Builder::from_u128(v).into_uuid();
+ ///
+ /// assert_eq!(
+ /// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_u128(v: u128) -> Self {
+ Builder(Uuid::from_u128(v))
+ }
+
+ /// Creates a UUID from a 128bit value in little-endian order.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let v = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8u128;
+ ///
+ /// let uuid = Builder::from_u128_le(v).into_uuid();
+ ///
+ /// assert_eq!(
+ /// "d8d7d6d5-d4d3-d2d1-c2c1-b2b1a4a3a2a1",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn from_u128_le(v: u128) -> Self {
+ Builder(Uuid::from_u128_le(v))
+ }
+
+ /// Creates a `Builder` with an initial [`Uuid::nil`].
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let uuid = Builder::nil().into_uuid();
+ ///
+ /// assert_eq!(
+ /// "00000000-0000-0000-0000-000000000000",
+ /// uuid.hyphenated().to_string(),
+ /// );
+ /// ```
+ pub const fn nil() -> Self {
+ Builder(Uuid::nil())
+ }
+
+ /// Specifies the variant of the UUID.
+ pub fn set_variant(&mut self, v: Variant) -> &mut Self {
+ *self = Builder(self.0).with_variant(v);
+ self
+ }
+
+ /// Specifies the variant of the UUID.
+ pub const fn with_variant(mut self, v: Variant) -> Self {
+ let byte = (self.0).0[8];
+
+ (self.0).0[8] = match v {
+ Variant::NCS => byte & 0x7f,
+ Variant::RFC4122 => (byte & 0x3f) | 0x80,
+ Variant::Microsoft => (byte & 0x1f) | 0xc0,
+ Variant::Future => byte | 0xe0,
+ };
+
+ self
+ }
+
+ /// Specifies the version number of the UUID.
+ pub fn set_version(&mut self, v: Version) -> &mut Self {
+ *self = Builder(self.0).with_version(v);
+ self
+ }
+
+ /// Specifies the version number of the UUID.
+ pub const fn with_version(mut self, v: Version) -> Self {
+ (self.0).0[6] = ((self.0).0[6] & 0x0f) | ((v as u8) << 4);
+
+ self
+ }
+
+ /// Get a reference to the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let builder = Builder::nil();
+ ///
+ /// let uuid1 = builder.as_uuid();
+ /// let uuid2 = builder.as_uuid();
+ ///
+ /// assert_eq!(uuid1, uuid2);
+ /// ```
+ pub const fn as_uuid(&self) -> &Uuid {
+ &self.0
+ }
+
+ /// Convert the builder into a [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Builder;
+ /// let uuid = Builder::nil().into_uuid();
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "00000000-0000-0000-0000-000000000000"
+ /// );
+ /// ```
+ pub const fn into_uuid(self) -> Uuid {
+ self.0
+ }
+}
diff --git a/crates/uuid/src/error.rs b/crates/uuid/src/error.rs
new file mode 100644
index 0000000..e9aecbf
--- /dev/null
+++ b/crates/uuid/src/error.rs
@@ -0,0 +1,172 @@
+use crate::std::fmt;
+
+/// A general error that can occur when working with UUIDs.
+#[derive(Clone, Debug, Eq, Hash, PartialEq)]
+pub struct Error(pub(crate) ErrorKind);
+
+#[derive(Clone, Debug, Eq, Hash, PartialEq)]
+pub(crate) enum ErrorKind {
+ /// Invalid character in the [`Uuid`] string.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ Char { character: char, index: usize },
+ /// A simple [`Uuid`] didn't contain 32 characters.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ SimpleLength { len: usize },
+ /// A byte array didn't contain 16 bytes
+ ByteLength { len: usize },
+ /// A hyphenated [`Uuid`] didn't contain 5 groups
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ GroupCount { count: usize },
+ /// A hyphenated [`Uuid`] had a group that wasn't the right length
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ GroupLength {
+ group: usize,
+ len: usize,
+ index: usize,
+ },
+ /// The input was not a valid UTF8 string
+ InvalidUTF8,
+ /// Some other error occurred.
+ Other,
+}
+
+/// A string that is guaranteed to fail to parse to a [`Uuid`].
+///
+/// This type acts as a lightweight error indicator, suggesting
+/// that the string cannot be parsed but offering no error
+/// details. To get details, use `InvalidUuid::into_err`.
+///
+/// [`Uuid`]: ../struct.Uuid.html
+#[derive(Clone, Debug, Eq, Hash, PartialEq)]
+pub struct InvalidUuid<'a>(pub(crate) &'a [u8]);
+
+impl<'a> InvalidUuid<'a> {
+ /// Converts the lightweight error type into detailed diagnostics.
+ pub fn into_err(self) -> Error {
+ // Check whether or not the input was ever actually a valid UTF8 string
+ let input_str = match std::str::from_utf8(self.0) {
+ Ok(s) => s,
+ Err(_) => return Error(ErrorKind::InvalidUTF8),
+ };
+
+ let (uuid_str, offset, simple) = match input_str.as_bytes() {
+ [b'{', s @ .., b'}'] => (s, 1, false),
+ [b'u', b'r', b'n', b':', b'u', b'u', b'i', b'd', b':', s @ ..] => {
+ (s, "urn:uuid:".len(), false)
+ }
+ s => (s, 0, true),
+ };
+
+ let mut hyphen_count = 0;
+ let mut group_bounds = [0; 4];
+
+ // SAFETY: the byte array came from a valid utf8 string,
+ // and is aligned along char boundaries.
+ let uuid_str = unsafe { std::str::from_utf8_unchecked(uuid_str) };
+
+ for (index, character) in uuid_str.char_indices() {
+ let byte = character as u8;
+ if character as u32 - byte as u32 > 0 {
+ // Multibyte char
+ return Error(ErrorKind::Char {
+ character,
+ index: index + offset + 1,
+ });
+ } else if byte == b'-' {
+ // While we search, also count group breaks
+ if hyphen_count < 4 {
+ group_bounds[hyphen_count] = index;
+ }
+ hyphen_count += 1;
+ } else if !matches!(byte, b'0'..=b'9' | b'a'..=b'f' | b'A'..=b'F') {
+ // Non-hex char
+ return Error(ErrorKind::Char {
+ character: byte as char,
+ index: index + offset + 1,
+ });
+ }
+ }
+
+ if hyphen_count == 0 && simple {
+ // This means that we tried and failed to parse a simple uuid.
+ // Since we verified that all the characters are valid, this means
+ // that it MUST have an invalid length.
+ Error(ErrorKind::SimpleLength {
+ len: input_str.len(),
+ })
+ } else if hyphen_count != 4 {
+ // We tried to parse a hyphenated variant, but there weren't
+ // 5 groups (4 hyphen splits).
+ Error(ErrorKind::GroupCount {
+ count: hyphen_count + 1,
+ })
+ } else {
+ // There are 5 groups, one of them has an incorrect length
+ const BLOCK_STARTS: [usize; 5] = [0, 9, 14, 19, 24];
+ for i in 0..4 {
+ if group_bounds[i] != BLOCK_STARTS[i + 1] - 1 {
+ return Error(ErrorKind::GroupLength {
+ group: i,
+ len: group_bounds[i] - BLOCK_STARTS[i],
+ index: offset + BLOCK_STARTS[i] + 1,
+ });
+ }
+ }
+
+ // The last group must be too long
+ Error(ErrorKind::GroupLength {
+ group: 4,
+ len: input_str.len() - BLOCK_STARTS[4],
+ index: offset + BLOCK_STARTS[4] + 1,
+ })
+ }
+ }
+}
+
+// NOTE: This impl is part of the public API. Breaking changes to it should be carefully considered
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ match self.0 {
+ ErrorKind::Char {
+ character, index, ..
+ } => {
+ write!(f, "invalid character: expected an optional prefix of `urn:uuid:` followed by [0-9a-fA-F-], found `{}` at {}", character, index)
+ }
+ ErrorKind::SimpleLength { len } => {
+ write!(
+ f,
+ "invalid length: expected length 32 for simple format, found {}",
+ len
+ )
+ }
+ ErrorKind::ByteLength { len } => {
+ write!(f, "invalid length: expected 16 bytes, found {}", len)
+ }
+ ErrorKind::GroupCount { count } => {
+ write!(f, "invalid group count: expected 5, found {}", count)
+ }
+ ErrorKind::GroupLength { group, len, .. } => {
+ let expected = [8, 4, 4, 4, 12][group];
+ write!(
+ f,
+ "invalid group length in group {}: expected {}, found {}",
+ group, expected, len
+ )
+ }
+ ErrorKind::InvalidUTF8 => write!(f, "non-UTF8 input"),
+ ErrorKind::Other => write!(f, "failed to parse a UUID"),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+mod std_support {
+ use super::*;
+ use crate::std::error;
+
+ impl error::Error for Error {}
+}
diff --git a/crates/uuid/src/external.rs b/crates/uuid/src/external.rs
new file mode 100644
index 0000000..6f20d8f
--- /dev/null
+++ b/crates/uuid/src/external.rs
@@ -0,0 +1,8 @@
+#[cfg(feature = "arbitrary")]
+pub(crate) mod arbitrary_support;
+#[cfg(feature = "borsh")]
+pub(crate) mod borsh_support;
+#[cfg(feature = "serde")]
+pub(crate) mod serde_support;
+#[cfg(feature = "slog")]
+pub(crate) mod slog_support;
diff --git a/crates/uuid/src/external/arbitrary_support.rs b/crates/uuid/src/external/arbitrary_support.rs
new file mode 100644
index 0000000..40c11f5
--- /dev/null
+++ b/crates/uuid/src/external/arbitrary_support.rs
@@ -0,0 +1,45 @@
+use crate::{std::convert::TryInto, Builder, Uuid};
+
+use arbitrary::{Arbitrary, Unstructured};
+
+impl Arbitrary<'_> for Uuid {
+ fn arbitrary(u: &mut Unstructured<'_>) -> arbitrary::Result<Self> {
+ let b = u
+ .bytes(16)?
+ .try_into()
+ .map_err(|_| arbitrary::Error::NotEnoughData)?;
+
+ Ok(Builder::from_random_bytes(b).into_uuid())
+ }
+
+ fn size_hint(_: usize) -> (usize, Option<usize>) {
+ (16, Some(16))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ use crate::{Variant, Version};
+
+ #[test]
+ fn test_arbitrary() {
+ let mut bytes = Unstructured::new(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]);
+
+ let uuid = Uuid::arbitrary(&mut bytes).unwrap();
+
+ assert_eq!(Some(Version::Random), uuid.get_version());
+ assert_eq!(Variant::RFC4122, uuid.get_variant());
+ }
+
+ #[test]
+ fn test_arbitrary_empty() {
+ let mut bytes = Unstructured::new(&[]);
+
+ // Ensure we don't panic when building an arbitrary `Uuid`
+ let uuid = Uuid::arbitrary(&mut bytes);
+
+ assert!(uuid.is_err());
+ }
+}
diff --git a/crates/uuid/src/external/borsh_support.rs b/crates/uuid/src/external/borsh_support.rs
new file mode 100644
index 0000000..f6f93c7
--- /dev/null
+++ b/crates/uuid/src/external/borsh_support.rs
@@ -0,0 +1,23 @@
+#[cfg(test)]
+mod borsh_tests {
+ use crate::Uuid;
+ use std::string::ToString;
+
+ #[test]
+ fn test_serialize() {
+ let uuid_str = "f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
+ let uuid = Uuid::parse_str(uuid_str).unwrap();
+ let uuid_bytes = uuid.as_bytes().to_vec();
+ let borsh_bytes = borsh::to_vec(&uuid).unwrap();
+ assert_eq!(uuid_bytes, borsh_bytes);
+ }
+
+ #[test]
+ fn test_deserialize() {
+ let uuid_str = "f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
+ let uuid = Uuid::parse_str(uuid_str).unwrap();
+ let uuid_bytes = uuid.as_bytes().to_vec();
+ let deserialized = borsh::from_slice::<Uuid>(&uuid_bytes).unwrap().to_string();
+ assert_eq!(uuid_str, deserialized);
+ }
+}
diff --git a/crates/uuid/src/external/serde_support.rs b/crates/uuid/src/external/serde_support.rs
new file mode 100644
index 0000000..5228daf
--- /dev/null
+++ b/crates/uuid/src/external/serde_support.rs
@@ -0,0 +1,313 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::{
+ error::*,
+ fmt::{Braced, Hyphenated, Simple, Urn},
+ std::fmt,
+ Uuid,
+};
+use serde::{
+ de::{self, Error as _},
+ Deserialize, Deserializer, Serialize, Serializer,
+};
+
+impl Serialize for Uuid {
+ fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+ if serializer.is_human_readable() {
+ serializer.serialize_str(self.hyphenated().encode_lower(&mut Uuid::encode_buffer()))
+ } else {
+ serializer.serialize_bytes(self.as_bytes())
+ }
+ }
+}
+
+impl Serialize for Hyphenated {
+ fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+ serializer.serialize_str(self.encode_lower(&mut Uuid::encode_buffer()))
+ }
+}
+
+impl Serialize for Simple {
+ fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+ serializer.serialize_str(self.encode_lower(&mut Uuid::encode_buffer()))
+ }
+}
+
+impl Serialize for Urn {
+ fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+ serializer.serialize_str(self.encode_lower(&mut Uuid::encode_buffer()))
+ }
+}
+
+impl Serialize for Braced {
+ fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
+ serializer.serialize_str(self.encode_lower(&mut Uuid::encode_buffer()))
+ }
+}
+
+impl<'de> Deserialize<'de> for Uuid {
+ fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
+ fn de_error<E: de::Error>(e: Error) -> E {
+ E::custom(format_args!("UUID parsing failed: {}", e))
+ }
+
+ if deserializer.is_human_readable() {
+ struct UuidVisitor;
+
+ impl<'vi> de::Visitor<'vi> for UuidVisitor {
+ type Value = Uuid;
+
+ fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(formatter, "a UUID string")
+ }
+
+ fn visit_str<E: de::Error>(self, value: &str) -> Result<Uuid, E> {
+ value.parse::<Uuid>().map_err(de_error)
+ }
+
+ fn visit_bytes<E: de::Error>(self, value: &[u8]) -> Result<Uuid, E> {
+ Uuid::from_slice(value).map_err(de_error)
+ }
+
+ fn visit_seq<A>(self, mut seq: A) -> Result<Uuid, A::Error>
+ where
+ A: de::SeqAccess<'vi>,
+ {
+ #[rustfmt::skip]
+ let bytes = [
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ match seq.next_element()? { Some(e) => e, None => return Err(A::Error::invalid_length(16, &self)) },
+ ];
+
+ Ok(Uuid::from_bytes(bytes))
+ }
+ }
+
+ deserializer.deserialize_str(UuidVisitor)
+ } else {
+ struct UuidBytesVisitor;
+
+ impl<'vi> de::Visitor<'vi> for UuidBytesVisitor {
+ type Value = Uuid;
+
+ fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(formatter, "bytes")
+ }
+
+ fn visit_bytes<E: de::Error>(self, value: &[u8]) -> Result<Uuid, E> {
+ Uuid::from_slice(value).map_err(de_error)
+ }
+ }
+
+ deserializer.deserialize_bytes(UuidBytesVisitor)
+ }
+ }
+}
+
+pub mod compact {
+ //! Serialize a [`Uuid`] as a `[u8; 16]`.
+ //!
+ //! [`Uuid`]: ../../struct.Uuid.html
+
+ /// Serialize from a [`Uuid`] as a `[u8; 16]`
+ ///
+ /// [`Uuid`]: ../../struct.Uuid.html
+ pub fn serialize<S>(u: &crate::Uuid, serializer: S) -> Result<S::Ok, S::Error>
+ where
+ S: serde::Serializer,
+ {
+ serde::Serialize::serialize(u.as_bytes(), serializer)
+ }
+
+ /// Deserialize a `[u8; 16]` as a [`Uuid`]
+ ///
+ /// [`Uuid`]: ../../struct.Uuid.html
+ pub fn deserialize<'de, D>(deserializer: D) -> Result<crate::Uuid, D::Error>
+ where
+ D: serde::Deserializer<'de>,
+ {
+ let bytes: [u8; 16] = serde::Deserialize::deserialize(deserializer)?;
+
+ Ok(crate::Uuid::from_bytes(bytes))
+ }
+
+ #[cfg(test)]
+ mod tests {
+ use serde_derive::*;
+ use serde_test::{self, Configure};
+
+ #[test]
+ fn test_serialize_compact() {
+ #[derive(Serialize, Debug, Deserialize, PartialEq)]
+ struct UuidContainer {
+ #[serde(with = "crate::serde::compact")]
+ u: crate::Uuid,
+ }
+
+ let uuid_bytes = b"F9168C5E-CEB2-4F";
+ let container = UuidContainer {
+ u: crate::Uuid::from_slice(uuid_bytes).unwrap(),
+ };
+
+ // more complex because of the struct wrapping the actual UUID
+ // serialization
+ serde_test::assert_tokens(
+ &container.compact(),
+ &[
+ serde_test::Token::Struct {
+ name: "UuidContainer",
+ len: 1,
+ },
+ serde_test::Token::Str("u"),
+ serde_test::Token::Tuple { len: 16 },
+ serde_test::Token::U8(uuid_bytes[0]),
+ serde_test::Token::U8(uuid_bytes[1]),
+ serde_test::Token::U8(uuid_bytes[2]),
+ serde_test::Token::U8(uuid_bytes[3]),
+ serde_test::Token::U8(uuid_bytes[4]),
+ serde_test::Token::U8(uuid_bytes[5]),
+ serde_test::Token::U8(uuid_bytes[6]),
+ serde_test::Token::U8(uuid_bytes[7]),
+ serde_test::Token::U8(uuid_bytes[8]),
+ serde_test::Token::U8(uuid_bytes[9]),
+ serde_test::Token::U8(uuid_bytes[10]),
+ serde_test::Token::U8(uuid_bytes[11]),
+ serde_test::Token::U8(uuid_bytes[12]),
+ serde_test::Token::U8(uuid_bytes[13]),
+ serde_test::Token::U8(uuid_bytes[14]),
+ serde_test::Token::U8(uuid_bytes[15]),
+ serde_test::Token::TupleEnd,
+ serde_test::Token::StructEnd,
+ ],
+ )
+ }
+ }
+}
+
+#[cfg(test)]
+mod serde_tests {
+ use super::*;
+
+ use serde_test::{Compact, Configure, Readable, Token};
+
+ #[test]
+ fn test_serialize_readable_string() {
+ let uuid_str = "f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
+ let u = Uuid::parse_str(uuid_str).unwrap();
+ serde_test::assert_tokens(&u.readable(), &[Token::Str(uuid_str)]);
+ }
+
+ #[test]
+ fn test_deserialize_readable_compact() {
+ let uuid_bytes = b"F9168C5E-CEB2-4F";
+ let u = Uuid::from_slice(uuid_bytes).unwrap();
+
+ serde_test::assert_de_tokens(
+ &u.readable(),
+ &[
+ serde_test::Token::Tuple { len: 16 },
+ serde_test::Token::U8(uuid_bytes[0]),
+ serde_test::Token::U8(uuid_bytes[1]),
+ serde_test::Token::U8(uuid_bytes[2]),
+ serde_test::Token::U8(uuid_bytes[3]),
+ serde_test::Token::U8(uuid_bytes[4]),
+ serde_test::Token::U8(uuid_bytes[5]),
+ serde_test::Token::U8(uuid_bytes[6]),
+ serde_test::Token::U8(uuid_bytes[7]),
+ serde_test::Token::U8(uuid_bytes[8]),
+ serde_test::Token::U8(uuid_bytes[9]),
+ serde_test::Token::U8(uuid_bytes[10]),
+ serde_test::Token::U8(uuid_bytes[11]),
+ serde_test::Token::U8(uuid_bytes[12]),
+ serde_test::Token::U8(uuid_bytes[13]),
+ serde_test::Token::U8(uuid_bytes[14]),
+ serde_test::Token::U8(uuid_bytes[15]),
+ serde_test::Token::TupleEnd,
+ ],
+ );
+ }
+
+ #[test]
+ fn test_deserialize_readable_bytes() {
+ let uuid_bytes = b"F9168C5E-CEB2-4F";
+ let u = Uuid::from_slice(uuid_bytes).unwrap();
+
+ serde_test::assert_de_tokens(&u.readable(), &[serde_test::Token::Bytes(uuid_bytes)]);
+ }
+
+ #[test]
+ fn test_serialize_hyphenated() {
+ let uuid_str = "f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
+ let u = Uuid::parse_str(uuid_str).unwrap();
+ serde_test::assert_ser_tokens(&u.hyphenated(), &[Token::Str(uuid_str)]);
+ }
+
+ #[test]
+ fn test_serialize_simple() {
+ let uuid_str = "f9168c5eceb24faab6bf329bf39fa1e4";
+ let u = Uuid::parse_str(uuid_str).unwrap();
+ serde_test::assert_ser_tokens(&u.simple(), &[Token::Str(uuid_str)]);
+ }
+
+ #[test]
+ fn test_serialize_urn() {
+ let uuid_str = "urn:uuid:f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4";
+ let u = Uuid::parse_str(uuid_str).unwrap();
+ serde_test::assert_ser_tokens(&u.urn(), &[Token::Str(uuid_str)]);
+ }
+
+ #[test]
+ fn test_serialize_braced() {
+ let uuid_str = "{f9168c5e-ceb2-4faa-b6bf-329bf39fa1e4}";
+ let u = Uuid::parse_str(uuid_str).unwrap();
+ serde_test::assert_ser_tokens(&u.braced(), &[Token::Str(uuid_str)]);
+ }
+
+ #[test]
+ fn test_serialize_non_human_readable() {
+ let uuid_bytes = b"F9168C5E-CEB2-4F";
+ let u = Uuid::from_slice(uuid_bytes).unwrap();
+ serde_test::assert_tokens(
+ &u.compact(),
+ &[serde_test::Token::Bytes(&[
+ 70, 57, 49, 54, 56, 67, 53, 69, 45, 67, 69, 66, 50, 45, 52, 70,
+ ])],
+ );
+ }
+
+ #[test]
+ fn test_de_failure() {
+ serde_test::assert_de_tokens_error::<Readable<Uuid>>(
+ &[Token::Str("hello_world")],
+ "UUID parsing failed: invalid character: expected an optional prefix of `urn:uuid:` followed by [0-9a-fA-F-], found `h` at 1",
+ );
+
+ serde_test::assert_de_tokens_error::<Compact<Uuid>>(
+ &[Token::Bytes(b"hello_world")],
+ "UUID parsing failed: invalid length: expected 16 bytes, found 11",
+ );
+ }
+}
diff --git a/crates/uuid/src/external/slog_support.rs b/crates/uuid/src/external/slog_support.rs
new file mode 100644
index 0000000..2d6e817
--- /dev/null
+++ b/crates/uuid/src/external/slog_support.rs
@@ -0,0 +1,37 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::Uuid;
+
+impl slog::Value for Uuid {
+ fn serialize(
+ &self,
+ _: &slog::Record<'_>,
+ key: slog::Key,
+ serializer: &mut dyn slog::Serializer,
+ ) -> Result<(), slog::Error> {
+ serializer.emit_arguments(key, &format_args!("{}", self))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::tests::new;
+
+ use slog::{self, crit, Drain};
+
+ #[test]
+ fn test_slog_kv() {
+ let root = slog::Logger::root(slog::Discard.fuse(), slog::o!());
+ let u1 = new();
+ crit!(root, "test"; "u1" => u1);
+ }
+}
diff --git a/crates/uuid/src/fmt.rs b/crates/uuid/src/fmt.rs
new file mode 100644
index 0000000..1dda31b
--- /dev/null
+++ b/crates/uuid/src/fmt.rs
@@ -0,0 +1,1040 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Adapters for alternative string formats.
+
+use crate::{
+ std::{borrow::Borrow, fmt, ptr, str},
+ Uuid, Variant,
+};
+
+#[cfg(feature = "std")]
+use crate::std::string::{String, ToString};
+
+impl std::fmt::Debug for Uuid {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::LowerHex::fmt(self, f)
+ }
+}
+
+impl fmt::Display for Uuid {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::LowerHex::fmt(self, f)
+ }
+}
+
+#[cfg(feature = "std")]
+impl From<Uuid> for String {
+ fn from(uuid: Uuid) -> Self {
+ uuid.to_string()
+ }
+}
+
+impl fmt::Display for Variant {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ Variant::NCS => write!(f, "NCS"),
+ Variant::RFC4122 => write!(f, "RFC4122"),
+ Variant::Microsoft => write!(f, "Microsoft"),
+ Variant::Future => write!(f, "Future"),
+ }
+ }
+}
+
+impl fmt::LowerHex for Uuid {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::LowerHex::fmt(self.as_hyphenated(), f)
+ }
+}
+
+impl fmt::UpperHex for Uuid {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::UpperHex::fmt(self.as_hyphenated(), f)
+ }
+}
+
+/// Format a [`Uuid`] as a hyphenated string, like
+/// `67e55044-10b1-426f-9247-bb680e5fe0c8`.
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[repr(transparent)]
+pub struct Hyphenated(Uuid);
+
+/// Format a [`Uuid`] as a simple string, like
+/// `67e5504410b1426f9247bb680e5fe0c8`.
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[repr(transparent)]
+pub struct Simple(Uuid);
+
+/// Format a [`Uuid`] as a URN string, like
+/// `urn:uuid:67e55044-10b1-426f-9247-bb680e5fe0c8`.
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[repr(transparent)]
+pub struct Urn(Uuid);
+
+/// Format a [`Uuid`] as a braced hyphenated string, like
+/// `{67e55044-10b1-426f-9247-bb680e5fe0c8}`.
+#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[repr(transparent)]
+pub struct Braced(Uuid);
+
+impl Uuid {
+ /// Get a [`Hyphenated`] formatter.
+ #[inline]
+ pub const fn hyphenated(self) -> Hyphenated {
+ Hyphenated(self)
+ }
+
+ /// Get a borrowed [`Hyphenated`] formatter.
+ #[inline]
+ pub fn as_hyphenated(&self) -> &Hyphenated {
+ // SAFETY: `Uuid` and `Hyphenated` have the same ABI
+ unsafe { &*(self as *const Uuid as *const Hyphenated) }
+ }
+
+ /// Get a [`Simple`] formatter.
+ #[inline]
+ pub const fn simple(self) -> Simple {
+ Simple(self)
+ }
+
+ /// Get a borrowed [`Simple`] formatter.
+ #[inline]
+ pub fn as_simple(&self) -> &Simple {
+ // SAFETY: `Uuid` and `Simple` have the same ABI
+ unsafe { &*(self as *const Uuid as *const Simple) }
+ }
+
+ /// Get a [`Urn`] formatter.
+ #[inline]
+ pub const fn urn(self) -> Urn {
+ Urn(self)
+ }
+
+ /// Get a borrowed [`Urn`] formatter.
+ #[inline]
+ pub fn as_urn(&self) -> &Urn {
+ // SAFETY: `Uuid` and `Urn` have the same ABI
+ unsafe { &*(self as *const Uuid as *const Urn) }
+ }
+
+ /// Get a [`Braced`] formatter.
+ #[inline]
+ pub const fn braced(self) -> Braced {
+ Braced(self)
+ }
+
+ /// Get a borrowed [`Braced`] formatter.
+ #[inline]
+ pub fn as_braced(&self) -> &Braced {
+ // SAFETY: `Uuid` and `Braced` have the same ABI
+ unsafe { &*(self as *const Uuid as *const Braced) }
+ }
+}
+
+const UPPER: [u8; 16] = [
+ b'0', b'1', b'2', b'3', b'4', b'5', b'6', b'7', b'8', b'9', b'A', b'B', b'C', b'D', b'E', b'F',
+];
+const LOWER: [u8; 16] = [
+ b'0', b'1', b'2', b'3', b'4', b'5', b'6', b'7', b'8', b'9', b'a', b'b', b'c', b'd', b'e', b'f',
+];
+
+#[inline]
+const fn format_simple(src: &[u8; 16], upper: bool) -> [u8; 32] {
+ let lut = if upper { &UPPER } else { &LOWER };
+ let mut dst = [0; 32];
+ let mut i = 0;
+ while i < 16 {
+ let x = src[i];
+ dst[i * 2] = lut[(x >> 4) as usize];
+ dst[i * 2 + 1] = lut[(x & 0x0f) as usize];
+ i += 1;
+ }
+ dst
+}
+
+#[inline]
+const fn format_hyphenated(src: &[u8; 16], upper: bool) -> [u8; 36] {
+ let lut = if upper { &UPPER } else { &LOWER };
+ let groups = [(0, 8), (9, 13), (14, 18), (19, 23), (24, 36)];
+ let mut dst = [0; 36];
+
+ let mut group_idx = 0;
+ let mut i = 0;
+ while group_idx < 5 {
+ let (start, end) = groups[group_idx];
+ let mut j = start;
+ while j < end {
+ let x = src[i];
+ i += 1;
+
+ dst[j] = lut[(x >> 4) as usize];
+ dst[j + 1] = lut[(x & 0x0f) as usize];
+ j += 2;
+ }
+ if group_idx < 4 {
+ dst[end] = b'-';
+ }
+ group_idx += 1;
+ }
+ dst
+}
+
+#[inline]
+fn encode_simple<'b>(src: &[u8; 16], buffer: &'b mut [u8], upper: bool) -> &'b mut str {
+ let buf = &mut buffer[..Simple::LENGTH];
+ let dst = buf.as_mut_ptr();
+
+ // SAFETY: `buf` is guaranteed to be at least `LEN` bytes
+ // SAFETY: The encoded buffer is ASCII encoded
+ unsafe {
+ ptr::write(dst.cast(), format_simple(src, upper));
+ str::from_utf8_unchecked_mut(buf)
+ }
+}
+
+#[inline]
+fn encode_hyphenated<'b>(src: &[u8; 16], buffer: &'b mut [u8], upper: bool) -> &'b mut str {
+ let buf = &mut buffer[..Hyphenated::LENGTH];
+ let dst = buf.as_mut_ptr();
+
+ // SAFETY: `buf` is guaranteed to be at least `LEN` bytes
+ // SAFETY: The encoded buffer is ASCII encoded
+ unsafe {
+ ptr::write(dst.cast(), format_hyphenated(src, upper));
+ str::from_utf8_unchecked_mut(buf)
+ }
+}
+
+#[inline]
+fn encode_braced<'b>(src: &[u8; 16], buffer: &'b mut [u8], upper: bool) -> &'b mut str {
+ let buf = &mut buffer[..Braced::LENGTH];
+ buf[0] = b'{';
+ buf[Braced::LENGTH - 1] = b'}';
+
+ // SAFETY: `buf` is guaranteed to be at least `LEN` bytes
+ // SAFETY: The encoded buffer is ASCII encoded
+ unsafe {
+ let dst = buf.as_mut_ptr().add(1);
+
+ ptr::write(dst.cast(), format_hyphenated(src, upper));
+ str::from_utf8_unchecked_mut(buf)
+ }
+}
+
+#[inline]
+fn encode_urn<'b>(src: &[u8; 16], buffer: &'b mut [u8], upper: bool) -> &'b mut str {
+ let buf = &mut buffer[..Urn::LENGTH];
+ buf[..9].copy_from_slice(b"urn:uuid:");
+
+ // SAFETY: `buf` is guaranteed to be at least `LEN` bytes
+ // SAFETY: The encoded buffer is ASCII encoded
+ unsafe {
+ let dst = buf.as_mut_ptr().add(9);
+
+ ptr::write(dst.cast(), format_hyphenated(src, upper));
+ str::from_utf8_unchecked_mut(buf)
+ }
+}
+
+impl Hyphenated {
+ /// The length of a hyphenated [`Uuid`] string.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ pub const LENGTH: usize = 36;
+
+ /// Creates a [`Hyphenated`] from a [`Uuid`].
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ /// [`Hyphenated`]: struct.Hyphenated.html
+ pub const fn from_uuid(uuid: Uuid) -> Self {
+ Hyphenated(uuid)
+ }
+
+ /// Writes the [`Uuid`] as a lower-case hyphenated string to
+ /// `buffer`, and returns the subslice of the buffer that contains the
+ /// encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.hyphenated()
+ /// .encode_lower(&mut Uuid::encode_buffer()),
+ /// "936da01f-9abd-4d9d-80c7-02af85c822a8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 40];
+ /// uuid.hyphenated().encode_lower(&mut buf);
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"936da01f-9abd-4d9d-80c7-02af85c822a8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_lower<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_hyphenated(self.0.as_bytes(), buffer, false)
+ }
+
+ /// Writes the [`Uuid`] as an upper-case hyphenated string to
+ /// `buffer`, and returns the subslice of the buffer that contains the
+ /// encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.hyphenated()
+ /// .encode_upper(&mut Uuid::encode_buffer()),
+ /// "936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 40];
+ /// uuid.hyphenated().encode_upper(&mut buf);
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"936DA01F-9ABD-4D9D-80C7-02AF85C822A8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_upper<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_hyphenated(self.0.as_bytes(), buffer, true)
+ }
+
+ /// Get a reference to the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let hyphenated = Uuid::nil().hyphenated();
+ /// assert_eq!(*hyphenated.as_uuid(), Uuid::nil());
+ /// ```
+ pub const fn as_uuid(&self) -> &Uuid {
+ &self.0
+ }
+
+ /// Consumes the [`Hyphenated`], returning the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let hyphenated = Uuid::nil().hyphenated();
+ /// assert_eq!(hyphenated.into_uuid(), Uuid::nil());
+ /// ```
+ pub const fn into_uuid(self) -> Uuid {
+ self.0
+ }
+}
+
+impl Braced {
+ /// The length of a braced [`Uuid`] string.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ pub const LENGTH: usize = 38;
+
+ /// Creates a [`Braced`] from a [`Uuid`].
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ /// [`Braced`]: struct.Braced.html
+ pub const fn from_uuid(uuid: Uuid) -> Self {
+ Braced(uuid)
+ }
+
+ /// Writes the [`Uuid`] as a lower-case hyphenated string surrounded by
+ /// braces to `buffer`, and returns the subslice of the buffer that contains
+ /// the encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.braced()
+ /// .encode_lower(&mut Uuid::encode_buffer()),
+ /// "{936da01f-9abd-4d9d-80c7-02af85c822a8}"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 40];
+ /// uuid.braced().encode_lower(&mut buf);
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"{936da01f-9abd-4d9d-80c7-02af85c822a8}!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_lower<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_braced(self.0.as_bytes(), buffer, false)
+ }
+
+ /// Writes the [`Uuid`] as an upper-case hyphenated string surrounded by
+ /// braces to `buffer`, and returns the subslice of the buffer that contains
+ /// the encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.braced()
+ /// .encode_upper(&mut Uuid::encode_buffer()),
+ /// "{936DA01F-9ABD-4D9D-80C7-02AF85C822A8}"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 40];
+ /// uuid.braced().encode_upper(&mut buf);
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"{936DA01F-9ABD-4D9D-80C7-02AF85C822A8}!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_upper<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_braced(self.0.as_bytes(), buffer, true)
+ }
+
+ /// Get a reference to the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let braced = Uuid::nil().braced();
+ /// assert_eq!(*braced.as_uuid(), Uuid::nil());
+ /// ```
+ pub const fn as_uuid(&self) -> &Uuid {
+ &self.0
+ }
+
+ /// Consumes the [`Braced`], returning the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let braced = Uuid::nil().braced();
+ /// assert_eq!(braced.into_uuid(), Uuid::nil());
+ /// ```
+ pub const fn into_uuid(self) -> Uuid {
+ self.0
+ }
+}
+
+impl Simple {
+ /// The length of a simple [`Uuid`] string.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ pub const LENGTH: usize = 32;
+
+ /// Creates a [`Simple`] from a [`Uuid`].
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ /// [`Simple`]: struct.Simple.html
+ pub const fn from_uuid(uuid: Uuid) -> Self {
+ Simple(uuid)
+ }
+
+ /// Writes the [`Uuid`] as a lower-case simple string to `buffer`,
+ /// and returns the subslice of the buffer that contains the encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.simple().encode_lower(&mut Uuid::encode_buffer()),
+ /// "936da01f9abd4d9d80c702af85c822a8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 36];
+ /// assert_eq!(
+ /// uuid.simple().encode_lower(&mut buf),
+ /// "936da01f9abd4d9d80c702af85c822a8"
+ /// );
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"936da01f9abd4d9d80c702af85c822a8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_lower<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_simple(self.0.as_bytes(), buffer, false)
+ }
+
+ /// Writes the [`Uuid`] as an upper-case simple string to `buffer`,
+ /// and returns the subslice of the buffer that contains the encoded UUID.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.simple().encode_upper(&mut Uuid::encode_buffer()),
+ /// "936DA01F9ABD4D9D80C702AF85C822A8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 36];
+ /// assert_eq!(
+ /// uuid.simple().encode_upper(&mut buf),
+ /// "936DA01F9ABD4D9D80C702AF85C822A8"
+ /// );
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"936DA01F9ABD4D9D80C702AF85C822A8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_upper<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_simple(self.0.as_bytes(), buffer, true)
+ }
+
+ /// Get a reference to the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let simple = Uuid::nil().simple();
+ /// assert_eq!(*simple.as_uuid(), Uuid::nil());
+ /// ```
+ pub const fn as_uuid(&self) -> &Uuid {
+ &self.0
+ }
+
+ /// Consumes the [`Simple`], returning the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let simple = Uuid::nil().simple();
+ /// assert_eq!(simple.into_uuid(), Uuid::nil());
+ /// ```
+ pub const fn into_uuid(self) -> Uuid {
+ self.0
+ }
+}
+
+impl Urn {
+ /// The length of a URN [`Uuid`] string.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ pub const LENGTH: usize = 45;
+
+ /// Creates a [`Urn`] from a [`Uuid`].
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ /// [`Urn`]: struct.Urn.html
+ pub const fn from_uuid(uuid: Uuid) -> Self {
+ Urn(uuid)
+ }
+
+ /// Writes the [`Uuid`] as a lower-case URN string to
+ /// `buffer`, and returns the subslice of the buffer that contains the
+ /// encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936DA01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.urn().encode_lower(&mut Uuid::encode_buffer()),
+ /// "urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 49];
+ /// uuid.urn().encode_lower(&mut buf);
+ /// assert_eq!(
+ /// uuid.urn().encode_lower(&mut buf),
+ /// "urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8"
+ /// );
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"urn:uuid:936da01f-9abd-4d9d-80c7-02af85c822a8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_lower<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_urn(self.0.as_bytes(), buffer, false)
+ }
+
+ /// Writes the [`Uuid`] as an upper-case URN string to
+ /// `buffer`, and returns the subslice of the buffer that contains the
+ /// encoded UUID.
+ ///
+ /// This is slightly more efficient than using the formatting
+ /// infrastructure as it avoids virtual calls, and may avoid
+ /// double buffering.
+ ///
+ /// [`Uuid`]: ../struct.Uuid.html
+ ///
+ /// # Panics
+ ///
+ /// Panics if the buffer is not large enough: it must have length at least
+ /// [`LENGTH`]. [`Uuid::encode_buffer`] can be used to get a
+ /// sufficiently-large temporary buffer.
+ ///
+ /// [`LENGTH`]: #associatedconstant.LENGTH
+ /// [`Uuid::encode_buffer`]: ../struct.Uuid.html#method.encode_buffer
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("936da01f9abd4d9d80c702af85c822a8")?;
+ ///
+ /// // the encoded portion is returned
+ /// assert_eq!(
+ /// uuid.urn().encode_upper(&mut Uuid::encode_buffer()),
+ /// "urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
+ /// );
+ ///
+ /// // the buffer is mutated directly, and trailing contents remains
+ /// let mut buf = [b'!'; 49];
+ /// assert_eq!(
+ /// uuid.urn().encode_upper(&mut buf),
+ /// "urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
+ /// );
+ /// assert_eq!(
+ /// &buf as &[_],
+ /// b"urn:uuid:936DA01F-9ABD-4D9D-80C7-02AF85C822A8!!!!" as &[_]
+ /// );
+ ///
+ /// Ok(())
+ /// }
+ /// ```
+ /// */
+ #[inline]
+ pub fn encode_upper<'buf>(&self, buffer: &'buf mut [u8]) -> &'buf mut str {
+ encode_urn(self.0.as_bytes(), buffer, true)
+ }
+
+ /// Get a reference to the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let urn = Uuid::nil().urn();
+ /// assert_eq!(*urn.as_uuid(), Uuid::nil());
+ /// ```
+ pub const fn as_uuid(&self) -> &Uuid {
+ &self.0
+ }
+
+ /// Consumes the [`Urn`], returning the underlying [`Uuid`].
+ ///
+ /// # Examples
+ ///
+ /// ```rust
+ /// use uuid::Uuid;
+ ///
+ /// let urn = Uuid::nil().urn();
+ /// assert_eq!(urn.into_uuid(), Uuid::nil());
+ /// ```
+ pub const fn into_uuid(self) -> Uuid {
+ self.0
+ }
+}
+
+macro_rules! impl_fmt_traits {
+ ($($T:ident<$($a:lifetime),*>),+) => {$(
+ impl<$($a),*> fmt::Display for $T<$($a),*> {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::LowerHex::fmt(self, f)
+ }
+ }
+
+ impl<$($a),*> fmt::LowerHex for $T<$($a),*> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str(self.encode_lower(&mut [0; Self::LENGTH]))
+ }
+ }
+
+ impl<$($a),*> fmt::UpperHex for $T<$($a),*> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str(self.encode_upper(&mut [0; Self::LENGTH]))
+ }
+ }
+
+ impl_fmt_from!($T<$($a),*>);
+ )+}
+}
+
+macro_rules! impl_fmt_from {
+ ($T:ident<>) => {
+ impl From<Uuid> for $T {
+ #[inline]
+ fn from(f: Uuid) -> Self {
+ $T(f)
+ }
+ }
+
+ impl From<$T> for Uuid {
+ #[inline]
+ fn from(f: $T) -> Self {
+ f.into_uuid()
+ }
+ }
+
+ impl AsRef<Uuid> for $T {
+ #[inline]
+ fn as_ref(&self) -> &Uuid {
+ &self.0
+ }
+ }
+
+ impl Borrow<Uuid> for $T {
+ #[inline]
+ fn borrow(&self) -> &Uuid {
+ &self.0
+ }
+ }
+ };
+ ($T:ident<$a:lifetime>) => {
+ impl<$a> From<&$a Uuid> for $T<$a> {
+ #[inline]
+ fn from(f: &$a Uuid) -> Self {
+ $T::from_uuid_ref(f)
+ }
+ }
+
+ impl<$a> From<$T<$a>> for &$a Uuid {
+ #[inline]
+ fn from(f: $T<$a>) -> &$a Uuid {
+ f.0
+ }
+ }
+
+ impl<$a> AsRef<Uuid> for $T<$a> {
+ #[inline]
+ fn as_ref(&self) -> &Uuid {
+ self.0
+ }
+ }
+
+ impl<$a> Borrow<Uuid> for $T<$a> {
+ #[inline]
+ fn borrow(&self) -> &Uuid {
+ self.0
+ }
+ }
+ };
+}
+
+impl_fmt_traits! {
+ Hyphenated<>,
+ Simple<>,
+ Urn<>,
+ Braced<>
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn hyphenated_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().hyphenated().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Hyphenated::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn hyphenated_ref_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().as_hyphenated().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Hyphenated::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn simple_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().simple().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Simple::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn simple_ref_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().as_simple().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Simple::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn urn_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().urn().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Urn::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn urn_ref_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().as_urn().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Urn::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn braced_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().braced().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Braced::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ fn braced_ref_trailing() {
+ let mut buf = [b'x'; 100];
+ let len = Uuid::nil().as_braced().encode_lower(&mut buf).len();
+ assert_eq!(len, super::Braced::LENGTH);
+ assert!(buf[len..].iter().all(|x| *x == b'x'));
+ }
+
+ #[test]
+ #[should_panic]
+ fn hyphenated_too_small() {
+ Uuid::nil().hyphenated().encode_lower(&mut [0; 35]);
+ }
+
+ #[test]
+ #[should_panic]
+ fn simple_too_small() {
+ Uuid::nil().simple().encode_lower(&mut [0; 31]);
+ }
+
+ #[test]
+ #[should_panic]
+ fn urn_too_small() {
+ Uuid::nil().urn().encode_lower(&mut [0; 44]);
+ }
+
+ #[test]
+ #[should_panic]
+ fn braced_too_small() {
+ Uuid::nil().braced().encode_lower(&mut [0; 37]);
+ }
+
+ #[test]
+ fn hyphenated_to_inner() {
+ let hyphenated = Uuid::nil().hyphenated();
+ assert_eq!(Uuid::from(hyphenated), Uuid::nil());
+ }
+
+ #[test]
+ fn simple_to_inner() {
+ let simple = Uuid::nil().simple();
+ assert_eq!(Uuid::from(simple), Uuid::nil());
+ }
+
+ #[test]
+ fn urn_to_inner() {
+ let urn = Uuid::nil().urn();
+ assert_eq!(Uuid::from(urn), Uuid::nil());
+ }
+
+ #[test]
+ fn braced_to_inner() {
+ let braced = Uuid::nil().braced();
+ assert_eq!(Uuid::from(braced), Uuid::nil());
+ }
+}
diff --git a/crates/uuid/src/lib.rs b/crates/uuid/src/lib.rs
new file mode 100644
index 0000000..4c3c9b9
--- /dev/null
+++ b/crates/uuid/src/lib.rs
@@ -0,0 +1,1845 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Generate and parse universally unique identifiers (UUIDs).
+//!
+//! Here's an example of a UUID:
+//!
+//! ```text
+//! 67e55044-10b1-426f-9247-bb680e5fe0c8
+//! ```
+//!
+//! A UUID is a unique 128-bit value, stored as 16 octets, and regularly
+//! formatted as a hex string in five groups. UUIDs are used to assign unique
+//! identifiers to entities without requiring a central allocating authority.
+//!
+//! They are particularly useful in distributed systems, though can be used in
+//! disparate areas, such as databases and network protocols. Typically a UUID
+//! is displayed in a readable string form as a sequence of hexadecimal digits,
+//! separated into groups by hyphens.
+//!
+//! The uniqueness property is not strictly guaranteed, however for all
+//! practical purposes, it can be assumed that an unintentional collision would
+//! be extremely unlikely.
+//!
+//! UUIDs have a number of standardized encodings that are specified in [RFC4122](http://tools.ietf.org/html/rfc4122),
+//! with recent additions [in draft](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04).
+//!
+//! # Getting started
+//!
+//! Add the following to your `Cargo.toml`:
+//!
+//! ```toml
+//! [dependencies.uuid]
+//! version = "1.7.0"
+//! features = [
+//! "v4", # Lets you generate random UUIDs
+//! "fast-rng", # Use a faster (but still sufficiently random) RNG
+//! "macro-diagnostics", # Enable better diagnostics for compile-time UUIDs
+//! ]
+//! ```
+//!
+//! When you want a UUID, you can generate one:
+//!
+//! ```
+//! # fn main() {
+//! # #[cfg(feature = "v4")]
+//! # {
+//! use uuid::Uuid;
+//!
+//! let id = Uuid::new_v4();
+//! # }
+//! # }
+//! ```
+//!
+//! If you have a UUID value, you can use its string literal form inline:
+//!
+//! ```
+//! use uuid::{uuid, Uuid};
+//!
+//! const ID: Uuid = uuid!("67e55044-10b1-426f-9247-bb680e5fe0c8");
+//! ```
+//!
+//! # Working with different UUID versions
+//!
+//! This library supports all standardized methods for generating UUIDs through individual Cargo features.
+//!
+//! By default, this crate depends on nothing but the Rust standard library and can parse and format
+//! UUIDs, but cannot generate them. Depending on the kind of UUID you'd like to work with, there
+//! are Cargo features that enable generating them:
+//!
+//! * `v1` - Version 1 UUIDs using a timestamp and monotonic counter.
+//! * `v3` - Version 3 UUIDs based on the MD5 hash of some data.
+//! * `v4` - Version 4 UUIDs with random data.
+//! * `v5` - Version 5 UUIDs based on the SHA1 hash of some data.
+//! * `v6` - Version 6 UUIDs using a timestamp and monotonic counter.
+//! * `v7` - Version 7 UUIDs using a Unix timestamp.
+//! * `v8` - Version 8 UUIDs using user-defined data.
+//!
+//! Versions that are in draft are also supported. See the _unstable features_ section for details.
+//!
+//! This library also includes a [`Builder`] type that can be used to help construct UUIDs of any
+//! version without any additional dependencies or features. It's a lower-level API than [`Uuid`]
+//! that can be used when you need control over implicit requirements on things like a source
+//! of randomness.
+//!
+//! ## Which UUID version should I use?
+//!
+//! If you just want to generate unique identifiers then consider version 4 (`v4`) UUIDs. If you want
+//! to use UUIDs as database keys or need to sort them then consider version 7 (`v7`) UUIDs.
+//! Other versions should generally be avoided unless there's an existing need for them.
+//!
+//! Some UUID versions supersede others. Prefer version 6 over version 1 and version 5 over version 3.
+//!
+//! # Other features
+//!
+//! Other crate features can also be useful beyond the version support:
+//!
+//! * `macro-diagnostics` - enhances the diagnostics of `uuid!` macro.
+//! * `serde` - adds the ability to serialize and deserialize a UUID using
+//! `serde`.
+//! * `borsh` - adds the ability to serialize and deserialize a UUID using
+//! `borsh`.
+//! * `arbitrary` - adds an `Arbitrary` trait implementation to `Uuid` for
+//! fuzzing.
+//! * `fast-rng` - uses a faster algorithm for generating random UUIDs.
+//! This feature requires more dependencies to compile, but is just as suitable for
+//! UUIDs as the default algorithm.
+//! * `bytemuck` - adds a `Pod` trait implementation to `Uuid` for byte manipulation
+//!
+//! # Unstable features
+//!
+//! Some features are unstable. They may be incomplete or depend on other
+//! unstable libraries. These include:
+//!
+//! * `zerocopy` - adds support for zero-copy deserialization using the
+//! `zerocopy` library.
+//!
+//! Unstable features may break between minor releases.
+//!
+//! To allow unstable features, you'll need to enable the Cargo feature as
+//! normal, but also pass an additional flag through your environment to opt-in
+//! to unstable `uuid` features:
+//!
+//! ```text
+//! RUSTFLAGS="--cfg uuid_unstable"
+//! ```
+//!
+//! # Building for other targets
+//!
+//! ## WebAssembly
+//!
+//! For WebAssembly, enable the `js` feature:
+//!
+//! ```toml
+//! [dependencies.uuid]
+//! version = "1.7.0"
+//! features = [
+//! "v4",
+//! "v7",
+//! "js",
+//! ]
+//! ```
+//!
+//! ## Embedded
+//!
+//! For embedded targets without the standard library, you'll need to
+//! disable default features when building `uuid`:
+//!
+//! ```toml
+//! [dependencies.uuid]
+//! version = "1.7.0"
+//! default-features = false
+//! ```
+//!
+//! Some additional features are supported in no-std environments:
+//!
+//! * `v1`, `v3`, `v5`, `v6`, and `v8`.
+//! * `serde`.
+//!
+//! If you need to use `v4` or `v7` in a no-std environment, you'll need to
+//! follow [`getrandom`'s docs] on configuring a source of randomness
+//! on currently unsupported targets. Alternatively, you can produce
+//! random bytes yourself and then pass them to [`Builder::from_random_bytes`]
+//! without enabling the `v4` or `v7` features.
+//!
+//! # Examples
+//!
+//! Parse a UUID given in the simple format and print it as a URN:
+//!
+//! ```
+//! # use uuid::Uuid;
+//! # fn main() -> Result<(), uuid::Error> {
+//! let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
+//!
+//! println!("{}", my_uuid.urn());
+//! # Ok(())
+//! # }
+//! ```
+//!
+//! Generate a random UUID and print it out in hexadecimal form:
+//!
+//! ```
+//! // Note that this requires the `v4` feature to be enabled.
+//! # use uuid::Uuid;
+//! # fn main() {
+//! # #[cfg(feature = "v4")] {
+//! let my_uuid = Uuid::new_v4();
+//!
+//! println!("{}", my_uuid);
+//! # }
+//! # }
+//! ```
+//!
+//! # References
+//!
+//! * [Wikipedia: Universally Unique Identifier](http://en.wikipedia.org/wiki/Universally_unique_identifier)
+//! * [RFC4122: A Universally Unique Identifier (UUID) URN Namespace](http://tools.ietf.org/html/rfc4122)
+//! * [Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04)
+//!
+//! [`wasm-bindgen`]: https://crates.io/crates/wasm-bindgen
+//! [`cargo-web`]: https://crates.io/crates/cargo-web
+//! [`getrandom`'s docs]: https://docs.rs/getrandom
+
+#![no_std]
+#![deny(missing_debug_implementations, missing_docs)]
+#![doc(
+ html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
+ html_favicon_url = "https://www.rust-lang.org/favicon.ico",
+ html_root_url = "https://docs.rs/uuid/1.7.0"
+)]
+
+#[cfg(any(feature = "std", test))]
+#[macro_use]
+extern crate std;
+
+#[cfg(all(not(feature = "std"), not(test)))]
+#[macro_use]
+extern crate core as std;
+
+#[cfg(all(uuid_unstable, feature = "zerocopy"))]
+use zerocopy::{AsBytes, FromBytes, Unaligned};
+
+mod builder;
+mod error;
+mod parser;
+
+pub mod fmt;
+pub mod timestamp;
+
+pub use timestamp::{context::NoContext, ClockSequence, Timestamp};
+
+#[cfg(any(feature = "v1", feature = "v6"))]
+pub use timestamp::context::Context;
+
+#[cfg(feature = "v1")]
+#[doc(hidden)]
+// Soft-deprecated (Rust doesn't support deprecating re-exports)
+// Use `Context` from the crate root instead
+pub mod v1;
+#[cfg(feature = "v3")]
+mod v3;
+#[cfg(feature = "v4")]
+mod v4;
+#[cfg(feature = "v5")]
+mod v5;
+#[cfg(feature = "v6")]
+mod v6;
+#[cfg(feature = "v7")]
+mod v7;
+#[cfg(feature = "v8")]
+mod v8;
+
+#[cfg(feature = "md5")]
+mod md5;
+#[cfg(feature = "rng")]
+mod rng;
+#[cfg(feature = "sha1")]
+mod sha1;
+
+mod external;
+
+#[macro_use]
+mod macros;
+
+#[doc(hidden)]
+#[cfg(feature = "macro-diagnostics")]
+pub extern crate uuid_macro_internal;
+
+#[doc(hidden)]
+pub mod __macro_support {
+ pub use crate::std::result::Result::{Err, Ok};
+}
+
+use crate::std::convert;
+
+pub use crate::{builder::Builder, error::Error};
+
+/// A 128-bit (16 byte) buffer containing the UUID.
+///
+/// # ABI
+///
+/// The `Bytes` type is always guaranteed to be have the same ABI as [`Uuid`].
+pub type Bytes = [u8; 16];
+
+/// The version of the UUID, denoting the generating algorithm.
+///
+/// # References
+///
+/// * [Version in RFC4122](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.3)
+#[derive(Clone, Copy, Debug, PartialEq)]
+#[non_exhaustive]
+#[repr(u8)]
+pub enum Version {
+ /// The "nil" (all zeros) UUID.
+ Nil = 0u8,
+ /// Version 1: Timestamp and node ID.
+ Mac = 1,
+ /// Version 2: DCE Security.
+ Dce = 2,
+ /// Version 3: MD5 hash.
+ Md5 = 3,
+ /// Version 4: Random.
+ Random = 4,
+ /// Version 5: SHA-1 hash.
+ Sha1 = 5,
+ /// Version 6: Sortable Timestamp and node ID.
+ SortMac = 6,
+ /// Version 7: Timestamp and random.
+ SortRand = 7,
+ /// Version 8: Custom.
+ Custom = 8,
+ /// The "max" (all ones) UUID.
+ Max = 0xff,
+}
+
+/// The reserved variants of UUIDs.
+///
+/// # References
+///
+/// * [Variant in RFC4122](http://tools.ietf.org/html/rfc4122#section-4.1.1)
+#[derive(Clone, Copy, Debug, PartialEq)]
+#[non_exhaustive]
+#[repr(u8)]
+pub enum Variant {
+ /// Reserved by the NCS for backward compatibility.
+ NCS = 0u8,
+ /// As described in the RFC4122 Specification (default).
+ RFC4122,
+ /// Reserved by Microsoft for backward compatibility.
+ Microsoft,
+ /// Reserved for future expansion.
+ Future,
+}
+
+/// A Universally Unique Identifier (UUID).
+///
+/// # Examples
+///
+/// Parse a UUID given in the simple format and print it as a urn:
+///
+/// ```
+/// # use uuid::Uuid;
+/// # fn main() -> Result<(), uuid::Error> {
+/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
+///
+/// println!("{}", my_uuid.urn());
+/// # Ok(())
+/// # }
+/// ```
+///
+/// Create a new random (V4) UUID and print it out in hexadecimal form:
+///
+/// ```
+/// // Note that this requires the `v4` feature enabled in the uuid crate.
+/// # use uuid::Uuid;
+/// # fn main() {
+/// # #[cfg(feature = "v4")] {
+/// let my_uuid = Uuid::new_v4();
+///
+/// println!("{}", my_uuid);
+/// # }
+/// # }
+/// ```
+///
+/// # Formatting
+///
+/// A UUID can be formatted in one of a few ways:
+///
+/// * [`simple`](#method.simple): `a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8`.
+/// * [`hyphenated`](#method.hyphenated):
+/// `a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8`.
+/// * [`urn`](#method.urn): `urn:uuid:A1A2A3A4-B1B2-C1C2-D1D2-D3D4D5D6D7D8`.
+/// * [`braced`](#method.braced): `{a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8}`.
+///
+/// The default representation when formatting a UUID with `Display` is
+/// hyphenated:
+///
+/// ```
+/// # use uuid::Uuid;
+/// # fn main() -> Result<(), uuid::Error> {
+/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
+///
+/// assert_eq!(
+/// "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+/// my_uuid.to_string(),
+/// );
+/// # Ok(())
+/// # }
+/// ```
+///
+/// Other formats can be specified using adapter methods on the UUID:
+///
+/// ```
+/// # use uuid::Uuid;
+/// # fn main() -> Result<(), uuid::Error> {
+/// let my_uuid = Uuid::parse_str("a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8")?;
+///
+/// assert_eq!(
+/// "urn:uuid:a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
+/// my_uuid.urn().to_string(),
+/// );
+/// # Ok(())
+/// # }
+/// ```
+///
+/// # Endianness
+///
+/// The specification for UUIDs encodes the integer fields that make up the
+/// value in big-endian order. This crate assumes integer inputs are already in
+/// the correct order by default, regardless of the endianness of the
+/// environment. Most methods that accept integers have a `_le` variant (such as
+/// `from_fields_le`) that assumes any integer values will need to have their
+/// bytes flipped, regardless of the endianness of the environment.
+///
+/// Most users won't need to worry about endianness unless they need to operate
+/// on individual fields (such as when converting between Microsoft GUIDs). The
+/// important things to remember are:
+///
+/// - The endianness is in terms of the fields of the UUID, not the environment.
+/// - The endianness is assumed to be big-endian when there's no `_le` suffix
+/// somewhere.
+/// - Byte-flipping in `_le` methods applies to each integer.
+/// - Endianness roundtrips, so if you create a UUID with `from_fields_le`
+/// you'll get the same values back out with `to_fields_le`.
+///
+/// # ABI
+///
+/// The `Uuid` type is always guaranteed to be have the same ABI as [`Bytes`].
+#[derive(Clone, Copy, Eq, Hash, Ord, PartialEq, PartialOrd)]
+#[cfg_attr(
+ all(uuid_unstable, feature = "zerocopy"),
+ derive(AsBytes, FromBytes, Unaligned)
+)]
+#[cfg_attr(
+ feature = "borsh",
+ derive(borsh_derive::BorshDeserialize, borsh_derive::BorshSerialize)
+)]
+#[repr(transparent)]
+#[cfg_attr(
+ feature = "bytemuck",
+ derive(bytemuck::Zeroable, bytemuck::Pod, bytemuck::TransparentWrapper)
+)]
+pub struct Uuid(Bytes);
+
+impl Uuid {
+ /// UUID namespace for Domain Name System (DNS).
+ pub const NAMESPACE_DNS: Self = Uuid([
+ 0x6b, 0xa7, 0xb8, 0x10, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30,
+ 0xc8,
+ ]);
+
+ /// UUID namespace for ISO Object Identifiers (OIDs).
+ pub const NAMESPACE_OID: Self = Uuid([
+ 0x6b, 0xa7, 0xb8, 0x12, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30,
+ 0xc8,
+ ]);
+
+ /// UUID namespace for Uniform Resource Locators (URLs).
+ pub const NAMESPACE_URL: Self = Uuid([
+ 0x6b, 0xa7, 0xb8, 0x11, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30,
+ 0xc8,
+ ]);
+
+ /// UUID namespace for X.500 Distinguished Names (DNs).
+ pub const NAMESPACE_X500: Self = Uuid([
+ 0x6b, 0xa7, 0xb8, 0x14, 0x9d, 0xad, 0x11, 0xd1, 0x80, 0xb4, 0x00, 0xc0, 0x4f, 0xd4, 0x30,
+ 0xc8,
+ ]);
+
+ /// Returns the variant of the UUID structure.
+ ///
+ /// This determines the interpretation of the structure of the UUID.
+ /// This method simply reads the value of the variant byte. It doesn't
+ /// validate the rest of the UUID as conforming to that variant.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Variant};
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
+ ///
+ /// assert_eq!(Variant::RFC4122, my_uuid.get_variant());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Variant in RFC4122](http://tools.ietf.org/html/rfc4122#section-4.1.1)
+ pub const fn get_variant(&self) -> Variant {
+ match self.as_bytes()[8] {
+ x if x & 0x80 == 0x00 => Variant::NCS,
+ x if x & 0xc0 == 0x80 => Variant::RFC4122,
+ x if x & 0xe0 == 0xc0 => Variant::Microsoft,
+ x if x & 0xe0 == 0xe0 => Variant::Future,
+ // The above match arms are actually exhaustive
+ // We just return `Future` here because we can't
+ // use `unreachable!()` in a `const fn`
+ _ => Variant::Future,
+ }
+ }
+
+ /// Returns the version number of the UUID.
+ ///
+ /// This represents the algorithm used to generate the value.
+ /// This method is the future-proof alternative to [`Uuid::get_version`].
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
+ ///
+ /// assert_eq!(3, my_uuid.get_version_num());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version in RFC4122](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.3)
+ pub const fn get_version_num(&self) -> usize {
+ (self.as_bytes()[6] >> 4) as usize
+ }
+
+ /// Returns the version of the UUID.
+ ///
+ /// This represents the algorithm used to generate the value.
+ /// If the version field doesn't contain a recognized version then `None`
+ /// is returned. If you're trying to read the version for a future extension
+ /// you can also use [`Uuid::get_version_num`] to unconditionally return a
+ /// number. Future extensions may start to return `Some` once they're
+ /// standardized and supported.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version};
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let my_uuid = Uuid::parse_str("02f09a3f-1624-3b1d-8409-44eff7708208")?;
+ ///
+ /// assert_eq!(Some(Version::Md5), my_uuid.get_version());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version in RFC4122](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.3)
+ pub const fn get_version(&self) -> Option<Version> {
+ match self.get_version_num() {
+ 0 if self.is_nil() => Some(Version::Nil),
+ 1 => Some(Version::Mac),
+ 2 => Some(Version::Dce),
+ 3 => Some(Version::Md5),
+ 4 => Some(Version::Random),
+ 5 => Some(Version::Sha1),
+ 6 => Some(Version::SortMac),
+ 7 => Some(Version::SortRand),
+ 8 => Some(Version::Custom),
+ 0xf => Some(Version::Max),
+ _ => None,
+ }
+ }
+
+ /// Returns the four field values of the UUID.
+ ///
+ /// These values can be passed to the [`Uuid::from_fields`] method to get
+ /// the original `Uuid` back.
+ ///
+ /// * The first field value represents the first group of (eight) hex
+ /// digits, taken as a big-endian `u32` value. For V1 UUIDs, this field
+ /// represents the low 32 bits of the timestamp.
+ /// * The second field value represents the second group of (four) hex
+ /// digits, taken as a big-endian `u16` value. For V1 UUIDs, this field
+ /// represents the middle 16 bits of the timestamp.
+ /// * The third field value represents the third group of (four) hex digits,
+ /// taken as a big-endian `u16` value. The 4 most significant bits give
+ /// the UUID version, and for V1 UUIDs, the last 12 bits represent the
+ /// high 12 bits of the timestamp.
+ /// * The last field value represents the last two groups of four and twelve
+ /// hex digits, taken in order. The first 1-3 bits of this indicate the
+ /// UUID variant, and for V1 UUIDs, the next 13-15 bits indicate the clock
+ /// sequence and the last 48 bits indicate the node ID.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::nil();
+ ///
+ /// assert_eq!(uuid.as_fields(), (0, 0, 0, &[0u8; 8]));
+ ///
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ ///
+ /// assert_eq!(
+ /// uuid.as_fields(),
+ /// (
+ /// 0xa1a2a3a4,
+ /// 0xb1b2,
+ /// 0xc1c2,
+ /// &[0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8],
+ /// )
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn as_fields(&self) -> (u32, u16, u16, &[u8; 8]) {
+ let bytes = self.as_bytes();
+
+ let d1 = (bytes[0] as u32) << 24
+ | (bytes[1] as u32) << 16
+ | (bytes[2] as u32) << 8
+ | (bytes[3] as u32);
+
+ let d2 = (bytes[4] as u16) << 8 | (bytes[5] as u16);
+
+ let d3 = (bytes[6] as u16) << 8 | (bytes[7] as u16);
+
+ let d4: &[u8; 8] = convert::TryInto::try_into(&bytes[8..16]).unwrap();
+ (d1, d2, d3, d4)
+ }
+
+ /// Returns the four field values of the UUID in little-endian order.
+ ///
+ /// The bytes in the returned integer fields will be converted from
+ /// big-endian order. This is based on the endianness of the UUID,
+ /// rather than the target environment so bytes will be flipped on both
+ /// big and little endian machines.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use uuid::Uuid;
+ ///
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ ///
+ /// assert_eq!(
+ /// uuid.to_fields_le(),
+ /// (
+ /// 0xa4a3a2a1,
+ /// 0xb2b1,
+ /// 0xc2c1,
+ /// &[0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8],
+ /// )
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub fn to_fields_le(&self) -> (u32, u16, u16, &[u8; 8]) {
+ let d1 = (self.as_bytes()[0] as u32)
+ | (self.as_bytes()[1] as u32) << 8
+ | (self.as_bytes()[2] as u32) << 16
+ | (self.as_bytes()[3] as u32) << 24;
+
+ let d2 = (self.as_bytes()[4] as u16) | (self.as_bytes()[5] as u16) << 8;
+
+ let d3 = (self.as_bytes()[6] as u16) | (self.as_bytes()[7] as u16) << 8;
+
+ let d4: &[u8; 8] = convert::TryInto::try_into(&self.as_bytes()[8..16]).unwrap();
+ (d1, d2, d3, d4)
+ }
+
+ /// Returns a 128bit value containing the value.
+ ///
+ /// The bytes in the UUID will be packed directly into a `u128`.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ ///
+ /// assert_eq!(
+ /// uuid.as_u128(),
+ /// 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8,
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn as_u128(&self) -> u128 {
+ u128::from_be_bytes(*self.as_bytes())
+ }
+
+ /// Returns a 128bit little-endian value containing the value.
+ ///
+ /// The bytes in the `u128` will be flipped to convert into big-endian
+ /// order. This is based on the endianness of the UUID, rather than the
+ /// target environment so bytes will be flipped on both big and little
+ /// endian machines.
+ ///
+ /// Note that this will produce a different result than
+ /// [`Uuid::to_fields_le`], because the entire UUID is reversed, rather
+ /// than reversing the individual fields in-place.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ ///
+ /// assert_eq!(
+ /// uuid.to_u128_le(),
+ /// 0xd8d7d6d5d4d3d2d1c2c1b2b1a4a3a2a1,
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn to_u128_le(&self) -> u128 {
+ u128::from_le_bytes(*self.as_bytes())
+ }
+
+ /// Returns two 64bit values containing the value.
+ ///
+ /// The bytes in the UUID will be split into two `u64`.
+ /// The first u64 represents the 64 most significant bits,
+ /// the second one represents the 64 least significant.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ /// assert_eq!(
+ /// uuid.as_u64_pair(),
+ /// (0xa1a2a3a4b1b2c1c2, 0xd1d2d3d4d5d6d7d8),
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn as_u64_pair(&self) -> (u64, u64) {
+ let value = self.as_u128();
+ ((value >> 64) as u64, value as u64)
+ }
+
+ /// Returns a slice of 16 octets containing the value.
+ ///
+ /// This method borrows the underlying byte value of the UUID.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let bytes1 = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ /// let uuid1 = Uuid::from_bytes_ref(&bytes1);
+ ///
+ /// let bytes2 = uuid1.as_bytes();
+ /// let uuid2 = Uuid::from_bytes_ref(bytes2);
+ ///
+ /// assert_eq!(uuid1, uuid2);
+ ///
+ /// assert!(std::ptr::eq(
+ /// uuid2 as *const Uuid as *const u8,
+ /// &bytes1 as *const [u8; 16] as *const u8,
+ /// ));
+ /// ```
+ #[inline]
+ pub const fn as_bytes(&self) -> &Bytes {
+ &self.0
+ }
+
+ /// Consumes self and returns the underlying byte value of the UUID.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let bytes = [
+ /// 0xa1, 0xa2, 0xa3, 0xa4,
+ /// 0xb1, 0xb2,
+ /// 0xc1, 0xc2,
+ /// 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8,
+ /// ];
+ /// let uuid = Uuid::from_bytes(bytes);
+ /// assert_eq!(bytes, uuid.into_bytes());
+ /// ```
+ #[inline]
+ pub const fn into_bytes(self) -> Bytes {
+ self.0
+ }
+
+ /// Returns the bytes of the UUID in little-endian order.
+ ///
+ /// The bytes will be flipped to convert into little-endian order. This is
+ /// based on the endianness of the UUID, rather than the target environment
+ /// so bytes will be flipped on both big and little endian machines.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use uuid::Uuid;
+ ///
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8")?;
+ ///
+ /// assert_eq!(
+ /// uuid.to_bytes_le(),
+ /// ([
+ /// 0xa4, 0xa3, 0xa2, 0xa1, 0xb2, 0xb1, 0xc2, 0xc1, 0xd1, 0xd2,
+ /// 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8
+ /// ])
+ /// );
+ /// # Ok(())
+ /// # }
+ /// ```
+ pub const fn to_bytes_le(&self) -> Bytes {
+ [
+ self.0[3], self.0[2], self.0[1], self.0[0], self.0[5], self.0[4], self.0[7], self.0[6],
+ self.0[8], self.0[9], self.0[10], self.0[11], self.0[12], self.0[13], self.0[14],
+ self.0[15],
+ ]
+ }
+
+ /// Tests if the UUID is nil (all zeros).
+ pub const fn is_nil(&self) -> bool {
+ self.as_u128() == u128::MIN
+ }
+
+ /// Tests if the UUID is max (all ones).
+ pub const fn is_max(&self) -> bool {
+ self.as_u128() == u128::MAX
+ }
+
+ /// A buffer that can be used for `encode_...` calls, that is
+ /// guaranteed to be long enough for any of the format adapters.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// # use uuid::Uuid;
+ /// let uuid = Uuid::nil();
+ ///
+ /// assert_eq!(
+ /// uuid.simple().encode_lower(&mut Uuid::encode_buffer()),
+ /// "00000000000000000000000000000000"
+ /// );
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated()
+ /// .encode_lower(&mut Uuid::encode_buffer()),
+ /// "00000000-0000-0000-0000-000000000000"
+ /// );
+ ///
+ /// assert_eq!(
+ /// uuid.urn().encode_lower(&mut Uuid::encode_buffer()),
+ /// "urn:uuid:00000000-0000-0000-0000-000000000000"
+ /// );
+ /// ```
+ pub const fn encode_buffer() -> [u8; fmt::Urn::LENGTH] {
+ [0; fmt::Urn::LENGTH]
+ }
+
+ /// If the UUID is the correct version (v1, v6, or v7) this will return
+ /// the timestamp and counter portion parsed from a V1 UUID.
+ ///
+ /// Returns `None` if the supplied UUID is not V1.
+ ///
+ /// The V1 timestamp format defined in RFC4122 specifies a 60-bit
+ /// integer representing the number of 100-nanosecond intervals
+ /// since 00:00:00.00, 15 Oct 1582.
+ ///
+ /// [`Timestamp`] offers several options for converting the raw RFC4122
+ /// value into more commonly-used formats, such as a unix timestamp.
+ ///
+ /// # Roundtripping
+ ///
+ /// This method is unlikely to roundtrip a timestamp in a UUID due to the way
+ /// UUIDs encode timestamps. The timestamp returned from this method will be truncated to
+ /// 100ns precision for version 1 and 6 UUIDs, and to millisecond precision for version 7 UUIDs.
+ ///
+ /// [`Timestamp`]: v1/struct.Timestamp.html
+ pub const fn get_timestamp(&self) -> Option<Timestamp> {
+ match self.get_version() {
+ Some(Version::Mac) => {
+ let (ticks, counter) = timestamp::decode_rfc4122_timestamp(self);
+
+ Some(Timestamp::from_rfc4122(ticks, counter))
+ }
+ Some(Version::SortMac) => {
+ let (ticks, counter) = timestamp::decode_sorted_rfc4122_timestamp(self);
+
+ Some(Timestamp::from_rfc4122(ticks, counter))
+ }
+ Some(Version::SortRand) => {
+ let millis = timestamp::decode_unix_timestamp_millis(self);
+
+ let seconds = millis / 1000;
+ let nanos = ((millis % 1000) * 1_000_000) as u32;
+
+ Some(Timestamp {
+ seconds,
+ nanos,
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ counter: 0,
+ })
+ }
+ _ => None,
+ }
+ }
+}
+
+impl Default for Uuid {
+ #[inline]
+ fn default() -> Self {
+ Uuid::nil()
+ }
+}
+
+impl AsRef<[u8]> for Uuid {
+ #[inline]
+ fn as_ref(&self) -> &[u8] {
+ &self.0
+ }
+}
+
+#[cfg(feature = "std")]
+impl From<Uuid> for std::vec::Vec<u8> {
+ fn from(value: Uuid) -> Self {
+ value.0.to_vec()
+ }
+}
+
+#[cfg(feature = "std")]
+impl std::convert::TryFrom<std::vec::Vec<u8>> for Uuid {
+ type Error = Error;
+
+ fn try_from(value: std::vec::Vec<u8>) -> Result<Self, Self::Error> {
+ Uuid::from_slice(&value)
+ }
+}
+
+#[cfg(feature = "serde")]
+pub mod serde {
+ //! Adapters for alternative `serde` formats.
+ //!
+ //! This module contains adapters you can use with [`#[serde(with)]`](https://serde.rs/field-attrs.html#with)
+ //! to change the way a [`Uuid`](../struct.Uuid.html) is serialized
+ //! and deserialized.
+
+ pub use crate::external::serde_support::compact;
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ use crate::std::string::{String, ToString};
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ macro_rules! check {
+ ($buf:ident, $format:expr, $target:expr, $len:expr, $cond:expr) => {
+ $buf.clear();
+ write!($buf, $format, $target).unwrap();
+ assert!($buf.len() == $len);
+ assert!($buf.chars().all($cond), "{}", $buf);
+ };
+ }
+
+ pub const fn new() -> Uuid {
+ Uuid::from_bytes([
+ 0xF9, 0x16, 0x8C, 0x5E, 0xCE, 0xB2, 0x4F, 0xAA, 0xB6, 0xBF, 0x32, 0x9B, 0xF3, 0x9F,
+ 0xA1, 0xE4,
+ ])
+ }
+
+ pub const fn new2() -> Uuid {
+ Uuid::from_bytes([
+ 0xF9, 0x16, 0x8C, 0x5E, 0xCE, 0xB2, 0x4F, 0xAB, 0xB6, 0xBF, 0x32, 0x9B, 0xF3, 0x9F,
+ 0xA1, 0xE4,
+ ])
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_compare() {
+ let uuid1 = new();
+ let uuid2 = new2();
+
+ assert_eq!(uuid1, uuid1);
+ assert_eq!(uuid2, uuid2);
+
+ assert_ne!(uuid1, uuid2);
+ assert_ne!(uuid2, uuid1);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_default() {
+ let default_uuid = Uuid::default();
+ let nil_uuid = Uuid::nil();
+
+ assert_eq!(default_uuid, nil_uuid);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_display() {
+ use crate::std::fmt::Write;
+
+ let uuid = new();
+ let s = uuid.to_string();
+ let mut buffer = String::new();
+
+ assert_eq!(s, uuid.hyphenated().to_string());
+
+ check!(buffer, "{}", uuid, 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_lowerhex() {
+ use crate::std::fmt::Write;
+
+ let mut buffer = String::new();
+ let uuid = new();
+
+ check!(buffer, "{:x}", uuid, 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ }
+
+ // noinspection RsAssertEqual
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_operator_eq() {
+ let uuid1 = new();
+ let uuid1_dup = uuid1.clone();
+ let uuid2 = new2();
+
+ assert!(uuid1 == uuid1);
+ assert!(uuid1 == uuid1_dup);
+ assert!(uuid1_dup == uuid1);
+
+ assert!(uuid1 != uuid2);
+ assert!(uuid2 != uuid1);
+ assert!(uuid1_dup != uuid2);
+ assert!(uuid2 != uuid1_dup);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_uuid_to_string() {
+ use crate::std::fmt::Write;
+
+ let uuid = new();
+ let s = uuid.to_string();
+ let mut buffer = String::new();
+
+ assert_eq!(s.len(), 36);
+
+ check!(buffer, "{}", s, 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_non_conforming() {
+ let from_bytes =
+ Uuid::from_bytes([4, 54, 67, 12, 43, 2, 2, 76, 32, 50, 87, 5, 1, 33, 43, 87]);
+
+ assert_eq!(from_bytes.get_version(), None);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_nil() {
+ let nil = Uuid::nil();
+ let not_nil = new();
+
+ assert!(nil.is_nil());
+ assert!(!not_nil.is_nil());
+
+ assert_eq!(nil.get_version(), Some(Version::Nil));
+ assert_eq!(not_nil.get_version(), Some(Version::Random));
+
+ assert_eq!(
+ nil,
+ Builder::from_bytes([0; 16])
+ .with_version(Version::Nil)
+ .into_uuid()
+ );
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_max() {
+ let max = Uuid::max();
+ let not_max = new();
+
+ assert!(max.is_max());
+ assert!(!not_max.is_max());
+
+ assert_eq!(max.get_version(), Some(Version::Max));
+ assert_eq!(not_max.get_version(), Some(Version::Random));
+
+ assert_eq!(
+ max,
+ Builder::from_bytes([0xff; 16])
+ .with_version(Version::Max)
+ .into_uuid()
+ );
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_predefined_namespaces() {
+ assert_eq!(
+ Uuid::NAMESPACE_DNS.hyphenated().to_string(),
+ "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+ );
+ assert_eq!(
+ Uuid::NAMESPACE_URL.hyphenated().to_string(),
+ "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
+ );
+ assert_eq!(
+ Uuid::NAMESPACE_OID.hyphenated().to_string(),
+ "6ba7b812-9dad-11d1-80b4-00c04fd430c8"
+ );
+ assert_eq!(
+ Uuid::NAMESPACE_X500.hyphenated().to_string(),
+ "6ba7b814-9dad-11d1-80b4-00c04fd430c8"
+ );
+ }
+
+ #[cfg(feature = "v3")]
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_get_version_v3() {
+ let uuid = Uuid::new_v3(&Uuid::NAMESPACE_DNS, "rust-lang.org".as_bytes());
+
+ assert_eq!(uuid.get_version().unwrap(), Version::Md5);
+ assert_eq!(uuid.get_version_num(), 3);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_get_variant() {
+ let uuid1 = new();
+ let uuid2 = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").unwrap();
+ let uuid3 = Uuid::parse_str("67e55044-10b1-426f-9247-bb680e5fe0c8").unwrap();
+ let uuid4 = Uuid::parse_str("936DA01F9ABD4d9dC0C702AF85C822A8").unwrap();
+ let uuid5 = Uuid::parse_str("F9168C5E-CEB2-4faa-D6BF-329BF39FA1E4").unwrap();
+ let uuid6 = Uuid::parse_str("f81d4fae-7dec-11d0-7765-00a0c91e6bf6").unwrap();
+
+ assert_eq!(uuid1.get_variant(), Variant::RFC4122);
+ assert_eq!(uuid2.get_variant(), Variant::RFC4122);
+ assert_eq!(uuid3.get_variant(), Variant::RFC4122);
+ assert_eq!(uuid4.get_variant(), Variant::Microsoft);
+ assert_eq!(uuid5.get_variant(), Variant::Microsoft);
+ assert_eq!(uuid6.get_variant(), Variant::NCS);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_to_simple_string() {
+ let uuid1 = new();
+ let s = uuid1.simple().to_string();
+
+ assert_eq!(s.len(), 32);
+ assert!(s.chars().all(|c| c.is_digit(16)));
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_hyphenated_string() {
+ let uuid1 = new();
+ let s = uuid1.hyphenated().to_string();
+
+ assert_eq!(36, s.len());
+ assert!(s.chars().all(|c| c.is_digit(16) || c == '-'));
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_upper_lower_hex() {
+ use std::fmt::Write;
+
+ let mut buf = String::new();
+ let u = new();
+
+ macro_rules! check {
+ ($buf:ident, $format:expr, $target:expr, $len:expr, $cond:expr) => {
+ $buf.clear();
+ write!($buf, $format, $target).unwrap();
+ assert_eq!($len, buf.len());
+ assert!($buf.chars().all($cond), "{}", $buf);
+ };
+ }
+
+ check!(buf, "{:x}", u, 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:X}", u, 36, |c| c.is_uppercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:#x}", u, 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:#X}", u, 36, |c| c.is_uppercase()
+ || c.is_digit(10)
+ || c == '-');
+
+ check!(buf, "{:X}", u.hyphenated(), 36, |c| c.is_uppercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:X}", u.simple(), 32, |c| c.is_uppercase()
+ || c.is_digit(10));
+ check!(buf, "{:#X}", u.hyphenated(), 36, |c| c.is_uppercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:#X}", u.simple(), 32, |c| c.is_uppercase()
+ || c.is_digit(10));
+
+ check!(buf, "{:x}", u.hyphenated(), 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:x}", u.simple(), 32, |c| c.is_lowercase()
+ || c.is_digit(10));
+ check!(buf, "{:#x}", u.hyphenated(), 36, |c| c.is_lowercase()
+ || c.is_digit(10)
+ || c == '-');
+ check!(buf, "{:#x}", u.simple(), 32, |c| c.is_lowercase()
+ || c.is_digit(10));
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_to_urn_string() {
+ let uuid1 = new();
+ let ss = uuid1.urn().to_string();
+ let s = &ss[9..];
+
+ assert!(ss.starts_with("urn:uuid:"));
+ assert_eq!(s.len(), 36);
+ assert!(s.chars().all(|c| c.is_digit(16) || c == '-'));
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_to_simple_string_matching() {
+ let uuid1 = new();
+
+ let hs = uuid1.hyphenated().to_string();
+ let ss = uuid1.simple().to_string();
+
+ let hsn = hs.chars().filter(|&c| c != '-').collect::<String>();
+
+ assert_eq!(hsn, ss);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_string_roundtrip() {
+ let uuid = new();
+
+ let hs = uuid.hyphenated().to_string();
+ let uuid_hs = Uuid::parse_str(&hs).unwrap();
+ assert_eq!(uuid_hs, uuid);
+
+ let ss = uuid.to_string();
+ let uuid_ss = Uuid::parse_str(&ss).unwrap();
+ assert_eq!(uuid_ss, uuid);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_fields() {
+ let d1: u32 = 0xa1a2a3a4;
+ let d2: u16 = 0xb1b2;
+ let d3: u16 = 0xc1c2;
+ let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+
+ let u = Uuid::from_fields(d1, d2, d3, &d4);
+
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+ let result = u.simple().to_string();
+ assert_eq!(result, expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_fields_le() {
+ let d1: u32 = 0xa4a3a2a1;
+ let d2: u16 = 0xb2b1;
+ let d3: u16 = 0xc2c1;
+ let d4 = [0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+
+ let u = Uuid::from_fields_le(d1, d2, d3, &d4);
+
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+ let result = u.simple().to_string();
+ assert_eq!(result, expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_as_fields() {
+ let u = new();
+ let (d1, d2, d3, d4) = u.as_fields();
+
+ assert_ne!(d1, 0);
+ assert_ne!(d2, 0);
+ assert_ne!(d3, 0);
+ assert_eq!(d4.len(), 8);
+ assert!(!d4.iter().all(|&b| b == 0));
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_fields_roundtrip() {
+ let d1_in: u32 = 0xa1a2a3a4;
+ let d2_in: u16 = 0xb1b2;
+ let d3_in: u16 = 0xc1c2;
+ let d4_in = &[0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+
+ let u = Uuid::from_fields(d1_in, d2_in, d3_in, d4_in);
+ let (d1_out, d2_out, d3_out, d4_out) = u.as_fields();
+
+ assert_eq!(d1_in, d1_out);
+ assert_eq!(d2_in, d2_out);
+ assert_eq!(d3_in, d3_out);
+ assert_eq!(d4_in, d4_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_fields_le_roundtrip() {
+ let d1_in: u32 = 0xa4a3a2a1;
+ let d2_in: u16 = 0xb2b1;
+ let d3_in: u16 = 0xc2c1;
+ let d4_in = &[0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+
+ let u = Uuid::from_fields_le(d1_in, d2_in, d3_in, d4_in);
+ let (d1_out, d2_out, d3_out, d4_out) = u.to_fields_le();
+
+ assert_eq!(d1_in, d1_out);
+ assert_eq!(d2_in, d2_out);
+ assert_eq!(d3_in, d3_out);
+ assert_eq!(d4_in, d4_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_fields_le_are_actually_le() {
+ let d1_in: u32 = 0xa1a2a3a4;
+ let d2_in: u16 = 0xb1b2;
+ let d3_in: u16 = 0xc1c2;
+ let d4_in = &[0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8];
+
+ let u = Uuid::from_fields(d1_in, d2_in, d3_in, d4_in);
+ let (d1_out, d2_out, d3_out, d4_out) = u.to_fields_le();
+
+ assert_eq!(d1_in, d1_out.swap_bytes());
+ assert_eq!(d2_in, d2_out.swap_bytes());
+ assert_eq!(d3_in, d3_out.swap_bytes());
+ assert_eq!(d4_in, d4_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_u128() {
+ let v_in: u128 = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8;
+
+ let u = Uuid::from_u128(v_in);
+
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+ let result = u.simple().to_string();
+ assert_eq!(result, expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_u128_le() {
+ let v_in: u128 = 0xd8d7d6d5d4d3d2d1c2c1b2b1a4a3a2a1;
+
+ let u = Uuid::from_u128_le(v_in);
+
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+ let result = u.simple().to_string();
+ assert_eq!(result, expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_u64_pair() {
+ let high_in: u64 = 0xa1a2a3a4b1b2c1c2;
+ let low_in: u64 = 0xd1d2d3d4d5d6d7d8;
+
+ let u = Uuid::from_u64_pair(high_in, low_in);
+
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+ let result = u.simple().to_string();
+ assert_eq!(result, expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_u128_roundtrip() {
+ let v_in: u128 = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8;
+
+ let u = Uuid::from_u128(v_in);
+ let v_out = u.as_u128();
+
+ assert_eq!(v_in, v_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_u128_le_roundtrip() {
+ let v_in: u128 = 0xd8d7d6d5d4d3d2d1c2c1b2b1a4a3a2a1;
+
+ let u = Uuid::from_u128_le(v_in);
+ let v_out = u.to_u128_le();
+
+ assert_eq!(v_in, v_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_u64_pair_roundtrip() {
+ let high_in: u64 = 0xa1a2a3a4b1b2c1c2;
+ let low_in: u64 = 0xd1d2d3d4d5d6d7d8;
+
+ let u = Uuid::from_u64_pair(high_in, low_in);
+ let (high_out, low_out) = u.as_u64_pair();
+
+ assert_eq!(high_in, high_out);
+ assert_eq!(low_in, low_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_u128_le_is_actually_le() {
+ let v_in: u128 = 0xa1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8;
+
+ let u = Uuid::from_u128(v_in);
+ let v_out = u.to_u128_le();
+
+ assert_eq!(v_in, v_out.swap_bytes());
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_slice() {
+ let b = [
+ 0xa1, 0xa2, 0xa3, 0xa4, 0xb1, 0xb2, 0xc1, 0xc2, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6,
+ 0xd7, 0xd8,
+ ];
+
+ let u = Uuid::from_slice(&b).unwrap();
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+
+ assert_eq!(u.simple().to_string(), expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_from_bytes() {
+ let b = [
+ 0xa1, 0xa2, 0xa3, 0xa4, 0xb1, 0xb2, 0xc1, 0xc2, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6,
+ 0xd7, 0xd8,
+ ];
+
+ let u = Uuid::from_bytes(b);
+ let expected = "a1a2a3a4b1b2c1c2d1d2d3d4d5d6d7d8";
+
+ assert_eq!(u.simple().to_string(), expected);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_as_bytes() {
+ let u = new();
+ let ub = u.as_bytes();
+ let ur = u.as_ref();
+
+ assert_eq!(ub.len(), 16);
+ assert_eq!(ur.len(), 16);
+ assert!(!ub.iter().all(|&b| b == 0));
+ assert!(!ur.iter().all(|&b| b == 0));
+ }
+
+ #[test]
+ #[cfg(feature = "std")]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_convert_vec() {
+ use crate::std::{convert::TryInto, vec::Vec};
+
+ let u = new();
+ let ub = u.as_ref();
+
+ let v: Vec<u8> = u.into();
+
+ assert_eq!(&v, ub);
+
+ let uv: Uuid = v.try_into().unwrap();
+
+ assert_eq!(uv, u);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_bytes_roundtrip() {
+ let b_in: crate::Bytes = [
+ 0xa1, 0xa2, 0xa3, 0xa4, 0xb1, 0xb2, 0xc1, 0xc2, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6,
+ 0xd7, 0xd8,
+ ];
+
+ let u = Uuid::from_slice(&b_in).unwrap();
+
+ let b_out = u.as_bytes();
+
+ assert_eq!(&b_in, b_out);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_bytes_le_roundtrip() {
+ let b = [
+ 0xa1, 0xa2, 0xa3, 0xa4, 0xb1, 0xb2, 0xc1, 0xc2, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6,
+ 0xd7, 0xd8,
+ ];
+
+ let u1 = Uuid::from_bytes(b);
+
+ let b_le = u1.to_bytes_le();
+
+ let u2 = Uuid::from_bytes_le(b_le);
+
+ assert_eq!(u1, u2);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_iterbytes_impl_for_uuid() {
+ let mut set = std::collections::HashSet::new();
+ let id1 = new();
+ let id2 = new2();
+ set.insert(id1.clone());
+
+ assert!(set.contains(&id1));
+ assert!(!set.contains(&id2));
+ }
+}
diff --git a/crates/uuid/src/macros.rs b/crates/uuid/src/macros.rs
new file mode 100644
index 0000000..eb95725
--- /dev/null
+++ b/crates/uuid/src/macros.rs
@@ -0,0 +1,92 @@
+macro_rules! define_uuid_macro {
+ {$(#[$doc:meta])*} => {
+ $(#[$doc])*
+ #[cfg(feature = "macro-diagnostics")]
+ #[macro_export]
+ macro_rules! uuid {
+ ($uuid:literal) => {{
+ $crate::Uuid::from_bytes($crate::uuid_macro_internal::parse_lit!($uuid))
+ }};
+ }
+
+ $(#[$doc])*
+ #[cfg(not(feature = "macro-diagnostics"))]
+ #[macro_export]
+ macro_rules! uuid {
+ ($uuid:literal) => {{
+ const OUTPUT: $crate::Uuid = match $crate::Uuid::try_parse($uuid) {
+ $crate::__macro_support::Ok(u) => u,
+ $crate::__macro_support::Err(_) => panic!("invalid UUID"),
+ };
+ OUTPUT
+ }};
+ }
+ }
+}
+
+define_uuid_macro! {
+/// Parse [`Uuid`][uuid::Uuid]s from string literals at compile time.
+///
+/// ## Usage
+///
+/// This macro transforms the string literal representation of a
+/// [`Uuid`][uuid::Uuid] into the bytes representation, raising a compilation
+/// error if it cannot properly be parsed.
+///
+/// ## Examples
+///
+/// Setting a global constant:
+///
+/// ```
+/// # use uuid::{uuid, Uuid};
+/// pub const SCHEMA_ATTR_CLASS: Uuid = uuid!("00000000-0000-0000-0000-ffff00000000");
+/// pub const SCHEMA_ATTR_UUID: Uuid = uuid!("00000000-0000-0000-0000-ffff00000001");
+/// pub const SCHEMA_ATTR_NAME: Uuid = uuid!("00000000-0000-0000-0000-ffff00000002");
+/// ```
+///
+/// Defining a local variable:
+///
+/// ```
+/// # use uuid::uuid;
+/// let uuid = uuid!("urn:uuid:F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4");
+/// ```
+///
+/// ## Compilation Failures
+///
+/// Invalid UUIDs are rejected:
+///
+/// ```compile_fail
+/// # use uuid::uuid;
+/// let uuid = uuid!("F9168C5E-ZEB2-4FAA-B6BF-329BF39FA1E4");
+/// ```
+///
+/// Enable the feature `macro-diagnostics` to see the error messages below.
+///
+/// Provides the following compilation error:
+///
+/// ```txt
+/// error: invalid character: expected an optional prefix of `urn:uuid:` followed by [0-9a-fA-F-], found Z at 9
+/// |
+/// | let id = uuid!("F9168C5E-ZEB2-4FAA-B6BF-329BF39FA1E4");
+/// | ^
+/// ```
+///
+/// Tokens that aren't string literals are also rejected:
+///
+/// ```compile_fail
+/// # use uuid::uuid;
+/// let uuid_str: &str = "550e8400e29b41d4a716446655440000";
+/// let uuid = uuid!(uuid_str);
+/// ```
+///
+/// Provides the following compilation error:
+///
+/// ```txt
+/// error: expected string literal
+/// |
+/// | let uuid = uuid!(uuid_str);
+/// | ^^^^^^^^
+/// ```
+///
+/// [uuid::Uuid]: https://docs.rs/uuid/*/uuid/struct.Uuid.html
+}
diff --git a/crates/uuid/src/md5.rs b/crates/uuid/src/md5.rs
new file mode 100644
index 0000000..a746f22
--- /dev/null
+++ b/crates/uuid/src/md5.rs
@@ -0,0 +1,14 @@
+#[cfg(feature = "v3")]
+pub(crate) fn hash(ns: &[u8], src: &[u8]) -> [u8; 16] {
+ use md5::{Digest, Md5};
+
+ let mut hasher = Md5::new();
+
+ hasher.update(ns);
+ hasher.update(src);
+
+ let mut bytes = [0; 16];
+ bytes.copy_from_slice(&hasher.finalize()[..16]);
+
+ bytes
+}
diff --git a/crates/uuid/src/parser.rs b/crates/uuid/src/parser.rs
new file mode 100644
index 0000000..0eabcfe
--- /dev/null
+++ b/crates/uuid/src/parser.rs
@@ -0,0 +1,529 @@
+// Copyright 2013-2014 The Rust Project Developers.
+// Copyright 2018 The Uuid Project Developers.
+//
+// See the COPYRIGHT file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! [`Uuid`] parsing constructs and utilities.
+//!
+//! [`Uuid`]: ../struct.Uuid.html
+
+use crate::{
+ error::*,
+ std::{convert::TryFrom, str},
+ Uuid,
+};
+
+impl str::FromStr for Uuid {
+ type Err = Error;
+
+ fn from_str(uuid_str: &str) -> Result<Self, Self::Err> {
+ Uuid::parse_str(uuid_str)
+ }
+}
+
+impl TryFrom<&'_ str> for Uuid {
+ type Error = Error;
+
+ fn try_from(uuid_str: &'_ str) -> Result<Self, Self::Error> {
+ Uuid::parse_str(uuid_str)
+ }
+}
+
+impl Uuid {
+ /// Parses a `Uuid` from a string of hexadecimal digits with optional
+ /// hyphens.
+ ///
+ /// Any of the formats generated by this module (simple, hyphenated, urn,
+ /// Microsoft GUID) are supported by this parsing function.
+ ///
+ /// Prefer [`try_parse`] unless you need detailed user-facing diagnostics.
+ /// This method will be eventually deprecated in favor of `try_parse`.
+ ///
+ /// # Examples
+ ///
+ /// Parse a hyphenated UUID:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version, Variant};
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000")?;
+ ///
+ /// assert_eq!(Some(Version::Random), uuid.get_version());
+ /// assert_eq!(Variant::RFC4122, uuid.get_variant());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`try_parse`]: #method.try_parse
+ pub fn parse_str(input: &str) -> Result<Uuid, Error> {
+ try_parse(input.as_bytes())
+ .map(Uuid::from_bytes)
+ .map_err(InvalidUuid::into_err)
+ }
+
+ /// Parses a `Uuid` from a string of hexadecimal digits with optional
+ /// hyphens.
+ ///
+ /// This function is similar to [`parse_str`], in fact `parse_str` shares
+ /// the same underlying parser. The difference is that if `try_parse`
+ /// fails, it won't generate very useful error messages. The `parse_str`
+ /// function will eventually be deprecated in favor or `try_parse`.
+ ///
+ /// To parse a UUID from a byte stream instead of a UTF8 string, see
+ /// [`try_parse_ascii`].
+ ///
+ /// # Examples
+ ///
+ /// Parse a hyphenated UUID:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version, Variant};
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::try_parse("550e8400-e29b-41d4-a716-446655440000")?;
+ ///
+ /// assert_eq!(Some(Version::Random), uuid.get_version());
+ /// assert_eq!(Variant::RFC4122, uuid.get_variant());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`parse_str`]: #method.parse_str
+ /// [`try_parse_ascii`]: #method.try_parse_ascii
+ pub const fn try_parse(input: &str) -> Result<Uuid, Error> {
+ Self::try_parse_ascii(input.as_bytes())
+ }
+
+ /// Parses a `Uuid` from a string of hexadecimal digits with optional
+ /// hyphens.
+ ///
+ /// The input is expected to be a string of ASCII characters. This method
+ /// can be more convenient than [`try_parse`] if the UUID is being
+ /// parsed from a byte stream instead of from a UTF8 string.
+ ///
+ /// # Examples
+ ///
+ /// Parse a hyphenated UUID:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version, Variant};
+ /// # fn main() -> Result<(), uuid::Error> {
+ /// let uuid = Uuid::try_parse_ascii(b"550e8400-e29b-41d4-a716-446655440000")?;
+ ///
+ /// assert_eq!(Some(Version::Random), uuid.get_version());
+ /// assert_eq!(Variant::RFC4122, uuid.get_variant());
+ /// # Ok(())
+ /// # }
+ /// ```
+ ///
+ /// [`try_parse`]: #method.try_parse
+ pub const fn try_parse_ascii(input: &[u8]) -> Result<Uuid, Error> {
+ match try_parse(input) {
+ Ok(bytes) => Ok(Uuid::from_bytes(bytes)),
+ // If parsing fails then we don't know exactly what went wrong
+ // In this case, we just return a generic error
+ Err(_) => Err(Error(ErrorKind::Other)),
+ }
+ }
+}
+
+const fn try_parse(input: &[u8]) -> Result<[u8; 16], InvalidUuid> {
+ let result = match (input.len(), input) {
+ // Inputs of 32 bytes must be a non-hyphenated UUID
+ (32, s) => parse_simple(s),
+ // Hyphenated UUIDs may be wrapped in various ways:
+ // - `{UUID}` for braced UUIDs
+ // - `urn:uuid:UUID` for URNs
+ // - `UUID` for a regular hyphenated UUID
+ (36, s)
+ | (38, [b'{', s @ .., b'}'])
+ | (45, [b'u', b'r', b'n', b':', b'u', b'u', b'i', b'd', b':', s @ ..]) => {
+ parse_hyphenated(s)
+ }
+ // Any other shaped input is immediately invalid
+ _ => Err(()),
+ };
+
+ match result {
+ Ok(b) => Ok(b),
+ Err(()) => Err(InvalidUuid(input)),
+ }
+}
+
+#[inline]
+const fn parse_simple(s: &[u8]) -> Result<[u8; 16], ()> {
+ // This length check here removes all other bounds
+ // checks in this function
+ if s.len() != 32 {
+ return Err(());
+ }
+
+ let mut buf: [u8; 16] = [0; 16];
+ let mut i = 0;
+
+ while i < 16 {
+ // Convert a two-char hex value (like `A8`)
+ // into a byte (like `10101000`)
+ let h1 = HEX_TABLE[s[i * 2] as usize];
+ let h2 = HEX_TABLE[s[i * 2 + 1] as usize];
+
+ // We use `0xff` as a sentinel value to indicate
+ // an invalid hex character sequence (like the letter `G`)
+ if h1 | h2 == 0xff {
+ return Err(());
+ }
+
+ // The upper nibble needs to be shifted into position
+ // to produce the final byte value
+ buf[i] = SHL4_TABLE[h1 as usize] | h2;
+ i += 1;
+ }
+
+ Ok(buf)
+}
+
+#[inline]
+const fn parse_hyphenated(s: &[u8]) -> Result<[u8; 16], ()> {
+ // This length check here removes all other bounds
+ // checks in this function
+ if s.len() != 36 {
+ return Err(());
+ }
+
+ // We look at two hex-encoded values (4 chars) at a time because
+ // that's the size of the smallest group in a hyphenated UUID.
+ // The indexes we're interested in are:
+ //
+ // uuid : 936da01f-9abd-4d9d-80c7-02af85c822a8
+ // | | || || || || | |
+ // hyphens : | | 8| 13| 18| 23| | |
+ // positions: 0 4 9 14 19 24 28 32
+
+ // First, ensure the hyphens appear in the right places
+ match [s[8], s[13], s[18], s[23]] {
+ [b'-', b'-', b'-', b'-'] => {}
+ _ => return Err(()),
+ }
+
+ let positions: [u8; 8] = [0, 4, 9, 14, 19, 24, 28, 32];
+ let mut buf: [u8; 16] = [0; 16];
+ let mut j = 0;
+
+ while j < 8 {
+ let i = positions[j];
+
+ // The decoding here is the same as the simple case
+ // We're just dealing with two values instead of one
+ let h1 = HEX_TABLE[s[i as usize] as usize];
+ let h2 = HEX_TABLE[s[(i + 1) as usize] as usize];
+ let h3 = HEX_TABLE[s[(i + 2) as usize] as usize];
+ let h4 = HEX_TABLE[s[(i + 3) as usize] as usize];
+
+ if h1 | h2 | h3 | h4 == 0xff {
+ return Err(());
+ }
+
+ buf[j * 2] = SHL4_TABLE[h1 as usize] | h2;
+ buf[j * 2 + 1] = SHL4_TABLE[h3 as usize] | h4;
+ j += 1;
+ }
+
+ Ok(buf)
+}
+
+const HEX_TABLE: &[u8; 256] = &{
+ let mut buf = [0; 256];
+ let mut i: u8 = 0;
+
+ loop {
+ buf[i as usize] = match i {
+ b'0'..=b'9' => i - b'0',
+ b'a'..=b'f' => i - b'a' + 10,
+ b'A'..=b'F' => i - b'A' + 10,
+ _ => 0xff,
+ };
+
+ if i == 255 {
+ break buf;
+ }
+
+ i += 1
+ }
+};
+
+const SHL4_TABLE: &[u8; 256] = &{
+ let mut buf = [0; 256];
+ let mut i: u8 = 0;
+
+ loop {
+ buf[i as usize] = i.wrapping_shl(4);
+
+ if i == 255 {
+ break buf;
+ }
+
+ i += 1;
+ }
+};
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{std::string::ToString, tests::new};
+
+ #[test]
+ fn test_parse_uuid_v4_valid() {
+ let from_hyphenated = Uuid::parse_str("67e55044-10b1-426f-9247-bb680e5fe0c8").unwrap();
+ let from_simple = Uuid::parse_str("67e5504410b1426f9247bb680e5fe0c8").unwrap();
+ let from_urn = Uuid::parse_str("urn:uuid:67e55044-10b1-426f-9247-bb680e5fe0c8").unwrap();
+ let from_guid = Uuid::parse_str("{67e55044-10b1-426f-9247-bb680e5fe0c8}").unwrap();
+
+ assert_eq!(from_hyphenated, from_simple);
+ assert_eq!(from_hyphenated, from_urn);
+ assert_eq!(from_hyphenated, from_guid);
+
+ assert!(Uuid::parse_str("00000000000000000000000000000000").is_ok());
+ assert!(Uuid::parse_str("67e55044-10b1-426f-9247-bb680e5fe0c8").is_ok());
+ assert!(Uuid::parse_str("F9168C5E-CEB2-4faa-B6BF-329BF39FA1E4").is_ok());
+ assert!(Uuid::parse_str("67e5504410b1426f9247bb680e5fe0c8").is_ok());
+ assert!(Uuid::parse_str("01020304-1112-2122-3132-414243444546").is_ok());
+ assert!(Uuid::parse_str("urn:uuid:67e55044-10b1-426f-9247-bb680e5fe0c8").is_ok());
+ assert!(Uuid::parse_str("{6d93bade-bd9f-4e13-8914-9474e1e3567b}").is_ok());
+
+ // Nil
+ let nil = Uuid::nil();
+ assert_eq!(
+ Uuid::parse_str("00000000000000000000000000000000").unwrap(),
+ nil
+ );
+ assert_eq!(
+ Uuid::parse_str("00000000-0000-0000-0000-000000000000").unwrap(),
+ nil
+ );
+ }
+
+ #[test]
+ fn test_parse_uuid_v4_invalid() {
+ // Invalid
+ assert_eq!(
+ Uuid::parse_str(""),
+ Err(Error(ErrorKind::SimpleLength { len: 0 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("!"),
+ Err(Error(ErrorKind::Char {
+ character: '!',
+ index: 1,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa-B6BF-329BF39FA1E45"),
+ Err(Error(ErrorKind::GroupLength {
+ group: 4,
+ len: 13,
+ index: 25,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa-BBF-329BF39FA1E4"),
+ Err(Error(ErrorKind::GroupLength {
+ group: 3,
+ len: 3,
+ index: 20,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa-BGBF-329BF39FA1E4"),
+ Err(Error(ErrorKind::Char {
+ character: 'G',
+ index: 21,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2F4faaFB6BFF329BF39FA1E4"),
+ Err(Error(ErrorKind::GroupCount { count: 2 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faaFB6BFF329BF39FA1E4"),
+ Err(Error(ErrorKind::GroupCount { count: 3 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa-B6BFF329BF39FA1E4"),
+ Err(Error(ErrorKind::GroupCount { count: 4 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa"),
+ Err(Error(ErrorKind::GroupCount { count: 3 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faaXB6BFF329BF39FA1E4"),
+ Err(Error(ErrorKind::Char {
+ character: 'X',
+ index: 19,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("{F9168C5E-CEB2-4faa9B6BFF329BF39FA1E41"),
+ Err(Error(ErrorKind::Char {
+ character: '{',
+ index: 1,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("{F9168C5E-CEB2-4faa9B6BFF329BF39FA1E41}"),
+ Err(Error(ErrorKind::GroupCount { count: 3 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB-24fa-eB6BFF32-BF39FA1E4"),
+ Err(Error(ErrorKind::GroupLength {
+ group: 1,
+ len: 3,
+ index: 10,
+ }))
+ );
+
+ // // (group, found, expecting)
+ // //
+ assert_eq!(
+ Uuid::parse_str("01020304-1112-2122-3132-41424344"),
+ Err(Error(ErrorKind::GroupLength {
+ group: 4,
+ len: 8,
+ index: 25,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e5504410b1426f9247bb680e5fe0c"),
+ Err(Error(ErrorKind::SimpleLength { len: 31 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e5504410b1426f9247bb680e5fe0c88"),
+ Err(Error(ErrorKind::SimpleLength { len: 33 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e5504410b1426f9247bb680e5fe0cg8"),
+ Err(Error(ErrorKind::Char {
+ character: 'g',
+ index: 32,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e5504410b1426%9247bb680e5fe0c8"),
+ Err(Error(ErrorKind::Char {
+ character: '%',
+ index: 16,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("231231212212423424324323477343246663"),
+ Err(Error(ErrorKind::SimpleLength { len: 36 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("{00000000000000000000000000000000}"),
+ Err(Error(ErrorKind::GroupCount { count: 1 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e5504410b1426f9247bb680e5fe0c"),
+ Err(Error(ErrorKind::SimpleLength { len: 31 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e550X410b1426f9247bb680e5fe0cd"),
+ Err(Error(ErrorKind::Char {
+ character: 'X',
+ index: 7,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("67e550-4105b1426f9247bb680e5fe0c"),
+ Err(Error(ErrorKind::GroupCount { count: 2 }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("F9168C5E-CEB2-4faa-B6BF1-02BF39FA1E4"),
+ Err(Error(ErrorKind::GroupLength {
+ group: 3,
+ len: 5,
+ index: 20,
+ }))
+ );
+
+ assert_eq!(
+ Uuid::parse_str("\u{bcf3c}"),
+ Err(Error(ErrorKind::Char {
+ character: '\u{bcf3c}',
+ index: 1
+ }))
+ );
+ }
+
+ #[test]
+ fn test_roundtrip_default() {
+ let uuid_orig = new();
+ let orig_str = uuid_orig.to_string();
+ let uuid_out = Uuid::parse_str(&orig_str).unwrap();
+ assert_eq!(uuid_orig, uuid_out);
+ }
+
+ #[test]
+ fn test_roundtrip_hyphenated() {
+ let uuid_orig = new();
+ let orig_str = uuid_orig.hyphenated().to_string();
+ let uuid_out = Uuid::parse_str(&orig_str).unwrap();
+ assert_eq!(uuid_orig, uuid_out);
+ }
+
+ #[test]
+ fn test_roundtrip_simple() {
+ let uuid_orig = new();
+ let orig_str = uuid_orig.simple().to_string();
+ let uuid_out = Uuid::parse_str(&orig_str).unwrap();
+ assert_eq!(uuid_orig, uuid_out);
+ }
+
+ #[test]
+ fn test_roundtrip_urn() {
+ let uuid_orig = new();
+ let orig_str = uuid_orig.urn().to_string();
+ let uuid_out = Uuid::parse_str(&orig_str).unwrap();
+ assert_eq!(uuid_orig, uuid_out);
+ }
+
+ #[test]
+ fn test_roundtrip_braced() {
+ let uuid_orig = new();
+ let orig_str = uuid_orig.braced().to_string();
+ let uuid_out = Uuid::parse_str(&orig_str).unwrap();
+ assert_eq!(uuid_orig, uuid_out);
+ }
+
+ #[test]
+ fn test_try_parse_ascii_non_utf8() {
+ assert!(Uuid::try_parse_ascii(b"67e55044-10b1-426f-9247-bb680e5\0e0c8").is_err());
+ }
+}
diff --git a/crates/uuid/src/rng.rs b/crates/uuid/src/rng.rs
new file mode 100644
index 0000000..dcfbb8d
--- /dev/null
+++ b/crates/uuid/src/rng.rs
@@ -0,0 +1,39 @@
+#[cfg(any(feature = "v4", feature = "v7"))]
+pub(crate) fn bytes() -> [u8; 16] {
+ #[cfg(not(feature = "fast-rng"))]
+ {
+ let mut bytes = [0u8; 16];
+
+ getrandom::getrandom(&mut bytes).unwrap_or_else(|err| {
+ // NB: getrandom::Error has no source; this is adequate display
+ panic!("could not retrieve random bytes for uuid: {}", err)
+ });
+
+ bytes
+ }
+
+ #[cfg(feature = "fast-rng")]
+ {
+ rand::random()
+ }
+}
+
+#[cfg(any(feature = "v1", feature = "v6"))]
+pub(crate) fn u16() -> u16 {
+ #[cfg(not(feature = "fast-rng"))]
+ {
+ let mut bytes = [0u8; 2];
+
+ getrandom::getrandom(&mut bytes).unwrap_or_else(|err| {
+ // NB: getrandom::Error has no source; this is adequate display
+ panic!("could not retrieve random bytes for uuid: {}", err)
+ });
+
+ ((bytes[0] as u16) << 8) | (bytes[1] as u16)
+ }
+
+ #[cfg(feature = "fast-rng")]
+ {
+ rand::random()
+ }
+}
diff --git a/crates/uuid/src/sha1.rs b/crates/uuid/src/sha1.rs
new file mode 100644
index 0000000..14ca302
--- /dev/null
+++ b/crates/uuid/src/sha1.rs
@@ -0,0 +1,14 @@
+#[cfg(feature = "v5")]
+pub(crate) fn hash(ns: &[u8], src: &[u8]) -> [u8; 16] {
+ use sha1_smol::Sha1;
+
+ let mut hasher = Sha1::new();
+
+ hasher.update(ns);
+ hasher.update(src);
+
+ let mut bytes = [0; 16];
+ bytes.copy_from_slice(&hasher.digest().bytes()[..16]);
+
+ bytes
+}
diff --git a/crates/uuid/src/timestamp.rs b/crates/uuid/src/timestamp.rs
new file mode 100644
index 0000000..27112d1
--- /dev/null
+++ b/crates/uuid/src/timestamp.rs
@@ -0,0 +1,468 @@
+//! Generating UUIDs from timestamps.
+//!
+//! Timestamps are used in a few UUID versions as a source of decentralized
+//! uniqueness (as in versions 1 and 6), and as a way to enable sorting (as
+//! in versions 6 and 7). Timestamps aren't encoded the same way by all UUID
+//! versions so this module provides a single [`Timestamp`] type that can
+//! convert between them.
+//!
+//! # Timestamp representations in UUIDs
+//!
+//! Versions 1 and 6 UUIDs use a bespoke timestamp that consists of the
+//! number of 100ns ticks since `1582-10-15 00:00:00`, along with
+//! a counter value to avoid duplicates.
+//!
+//! Version 7 UUIDs use a more standard timestamp that consists of the
+//! number of millisecond ticks since the Unix epoch (`1970-01-01 00:00:00`).
+//!
+//! # References
+//!
+//! * [Timestamp in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.1.4)
+//! * [Timestamp in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-6.1)
+
+use crate::Uuid;
+
+/// The number of 100 nanosecond ticks between the RFC4122 epoch
+/// (`1582-10-15 00:00:00`) and the Unix epoch (`1970-01-01 00:00:00`).
+pub const UUID_TICKS_BETWEEN_EPOCHS: u64 = 0x01B2_1DD2_1381_4000;
+
+/// A timestamp that can be encoded into a UUID.
+///
+/// This type abstracts the specific encoding, so versions 1, 6, and 7
+/// UUIDs can both be supported through the same type, even
+/// though they have a different representation of a timestamp.
+///
+/// # References
+///
+/// * [Timestamp in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.1.4)
+/// * [Timestamp in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-6.1)
+/// * [Clock Sequence in RFC4122](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.5)
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
+pub struct Timestamp {
+ pub(crate) seconds: u64,
+ pub(crate) nanos: u32,
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ pub(crate) counter: u16,
+}
+
+impl Timestamp {
+ /// Get a timestamp representing the current system time.
+ ///
+ /// This method defers to the standard library's `SystemTime` type.
+ ///
+ /// # Panics
+ ///
+ /// This method will panic if calculating the elapsed time since the Unix epoch fails.
+ #[cfg(feature = "std")]
+ pub fn now(context: impl ClockSequence<Output = u16>) -> Self {
+ #[cfg(not(any(feature = "v1", feature = "v6")))]
+ {
+ let _ = context;
+ }
+
+ let (seconds, nanos) = now();
+
+ Timestamp {
+ seconds,
+ nanos,
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ counter: context.generate_sequence(seconds, nanos),
+ }
+ }
+
+ /// Construct a `Timestamp` from an RFC4122 timestamp and counter, as used
+ /// in versions 1 and 6 UUIDs.
+ ///
+ /// # Overflow
+ ///
+ /// If conversion from RFC4122 ticks to the internal timestamp format would overflow
+ /// it will wrap.
+ pub const fn from_rfc4122(ticks: u64, counter: u16) -> Self {
+ #[cfg(not(any(feature = "v1", feature = "v6")))]
+ {
+ let _ = counter;
+ }
+
+ let (seconds, nanos) = Self::rfc4122_to_unix(ticks);
+
+ Timestamp {
+ seconds,
+ nanos,
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ counter,
+ }
+ }
+
+ /// Construct a `Timestamp` from a Unix timestamp, as used in version 7 UUIDs.
+ ///
+ /// # Overflow
+ ///
+ /// If conversion from RFC4122 ticks to the internal timestamp format would overflow
+ /// it will wrap.
+ pub fn from_unix(context: impl ClockSequence<Output = u16>, seconds: u64, nanos: u32) -> Self {
+ #[cfg(not(any(feature = "v1", feature = "v6")))]
+ {
+ let _ = context;
+
+ Timestamp { seconds, nanos }
+ }
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ {
+ let counter = context.generate_sequence(seconds, nanos);
+
+ Timestamp {
+ seconds,
+ nanos,
+ counter,
+ }
+ }
+ }
+
+ /// Get the value of the timestamp as an RFC4122 timestamp and counter,
+ /// as used in versions 1 and 6 UUIDs.
+ ///
+ /// # Overflow
+ ///
+ /// If conversion from RFC4122 ticks to the internal timestamp format would overflow
+ /// it will wrap.
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ pub const fn to_rfc4122(&self) -> (u64, u16) {
+ (
+ Self::unix_to_rfc4122_ticks(self.seconds, self.nanos),
+ self.counter,
+ )
+ }
+
+ /// Get the value of the timestamp as a Unix timestamp, as used in version 7 UUIDs.
+ ///
+ /// # Overflow
+ ///
+ /// If conversion from RFC4122 ticks to the internal timestamp format would overflow
+ /// it will wrap.
+ pub const fn to_unix(&self) -> (u64, u32) {
+ (self.seconds, self.nanos)
+ }
+
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ const fn unix_to_rfc4122_ticks(seconds: u64, nanos: u32) -> u64 {
+ UUID_TICKS_BETWEEN_EPOCHS
+ .wrapping_add(seconds.wrapping_mul(10_000_000))
+ .wrapping_add(nanos as u64 / 100)
+ }
+
+ const fn rfc4122_to_unix(ticks: u64) -> (u64, u32) {
+ (
+ ticks.wrapping_sub(UUID_TICKS_BETWEEN_EPOCHS) / 10_000_000,
+ (ticks.wrapping_sub(UUID_TICKS_BETWEEN_EPOCHS) % 10_000_000) as u32 * 100,
+ )
+ }
+
+ #[deprecated(note = "use `to_unix` instead; this method will be removed in a future release")]
+ /// Get the number of fractional nanoseconds in the Unix timestamp.
+ ///
+ /// This method is deprecated and probably doesn't do what you're expecting it to.
+ /// It doesn't return the timestamp as nanoseconds since the Unix epoch, it returns
+ /// the fractional seconds of the timestamp.
+ pub const fn to_unix_nanos(&self) -> u32 {
+ panic!("`Timestamp::to_unix_nanos` is deprecated and will be removed: use `Timestamp::to_unix` instead")
+ }
+}
+
+pub(crate) const fn encode_rfc4122_timestamp(ticks: u64, counter: u16, node_id: &[u8; 6]) -> Uuid {
+ let time_low = (ticks & 0xFFFF_FFFF) as u32;
+ let time_mid = ((ticks >> 32) & 0xFFFF) as u16;
+ let time_high_and_version = (((ticks >> 48) & 0x0FFF) as u16) | (1 << 12);
+
+ let mut d4 = [0; 8];
+
+ d4[0] = (((counter & 0x3F00) >> 8) as u8) | 0x80;
+ d4[1] = (counter & 0xFF) as u8;
+ d4[2] = node_id[0];
+ d4[3] = node_id[1];
+ d4[4] = node_id[2];
+ d4[5] = node_id[3];
+ d4[6] = node_id[4];
+ d4[7] = node_id[5];
+
+ Uuid::from_fields(time_low, time_mid, time_high_and_version, &d4)
+}
+
+pub(crate) const fn decode_rfc4122_timestamp(uuid: &Uuid) -> (u64, u16) {
+ let bytes = uuid.as_bytes();
+
+ let ticks: u64 = ((bytes[6] & 0x0F) as u64) << 56
+ | (bytes[7] as u64) << 48
+ | (bytes[4] as u64) << 40
+ | (bytes[5] as u64) << 32
+ | (bytes[0] as u64) << 24
+ | (bytes[1] as u64) << 16
+ | (bytes[2] as u64) << 8
+ | (bytes[3] as u64);
+
+ let counter: u16 = ((bytes[8] & 0x3F) as u16) << 8 | (bytes[9] as u16);
+
+ (ticks, counter)
+}
+
+pub(crate) const fn encode_sorted_rfc4122_timestamp(
+ ticks: u64,
+ counter: u16,
+ node_id: &[u8; 6],
+) -> Uuid {
+ let time_high = ((ticks >> 28) & 0xFFFF_FFFF) as u32;
+ let time_mid = ((ticks >> 12) & 0xFFFF) as u16;
+ let time_low_and_version = ((ticks & 0x0FFF) as u16) | (0x6 << 12);
+
+ let mut d4 = [0; 8];
+
+ d4[0] = (((counter & 0x3F00) >> 8) as u8) | 0x80;
+ d4[1] = (counter & 0xFF) as u8;
+ d4[2] = node_id[0];
+ d4[3] = node_id[1];
+ d4[4] = node_id[2];
+ d4[5] = node_id[3];
+ d4[6] = node_id[4];
+ d4[7] = node_id[5];
+
+ Uuid::from_fields(time_high, time_mid, time_low_and_version, &d4)
+}
+
+pub(crate) const fn decode_sorted_rfc4122_timestamp(uuid: &Uuid) -> (u64, u16) {
+ let bytes = uuid.as_bytes();
+
+ let ticks: u64 = ((bytes[0]) as u64) << 52
+ | (bytes[1] as u64) << 44
+ | (bytes[2] as u64) << 36
+ | (bytes[3] as u64) << 28
+ | (bytes[4] as u64) << 20
+ | (bytes[5] as u64) << 12
+ | ((bytes[6] & 0xF) as u64) << 8
+ | (bytes[7] as u64);
+
+ let counter: u16 = ((bytes[8] & 0x3F) as u16) << 8 | (bytes[9] as u16);
+
+ (ticks, counter)
+}
+
+pub(crate) const fn encode_unix_timestamp_millis(millis: u64, random_bytes: &[u8; 10]) -> Uuid {
+ let millis_high = ((millis >> 16) & 0xFFFF_FFFF) as u32;
+ let millis_low = (millis & 0xFFFF) as u16;
+
+ let random_and_version =
+ (random_bytes[1] as u16 | ((random_bytes[0] as u16) << 8) & 0x0FFF) | (0x7 << 12);
+
+ let mut d4 = [0; 8];
+
+ d4[0] = (random_bytes[2] & 0x3F) | 0x80;
+ d4[1] = random_bytes[3];
+ d4[2] = random_bytes[4];
+ d4[3] = random_bytes[5];
+ d4[4] = random_bytes[6];
+ d4[5] = random_bytes[7];
+ d4[6] = random_bytes[8];
+ d4[7] = random_bytes[9];
+
+ Uuid::from_fields(millis_high, millis_low, random_and_version, &d4)
+}
+
+pub(crate) const fn decode_unix_timestamp_millis(uuid: &Uuid) -> u64 {
+ let bytes = uuid.as_bytes();
+
+ let millis: u64 = (bytes[0] as u64) << 40
+ | (bytes[1] as u64) << 32
+ | (bytes[2] as u64) << 24
+ | (bytes[3] as u64) << 16
+ | (bytes[4] as u64) << 8
+ | (bytes[5] as u64);
+
+ millis
+}
+
+#[cfg(all(
+ feature = "std",
+ feature = "js",
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ )
+))]
+fn now() -> (u64, u32) {
+ use wasm_bindgen::prelude::*;
+
+ #[wasm_bindgen]
+ extern "C" {
+ // NOTE: This signature works around https://bugzilla.mozilla.org/show_bug.cgi?id=1787770
+ #[wasm_bindgen(js_namespace = Date, catch)]
+ fn now() -> Result<f64, JsValue>;
+ }
+
+ let now = now().unwrap_throw();
+
+ let secs = (now / 1_000.0) as u64;
+ let nanos = ((now % 1_000.0) * 1_000_000.0) as u32;
+
+ (secs, nanos)
+}
+
+#[cfg(all(
+ feature = "std",
+ any(
+ not(feature = "js"),
+ not(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))
+ )
+))]
+fn now() -> (u64, u32) {
+ let dur = std::time::SystemTime::UNIX_EPOCH.elapsed().expect(
+ "Getting elapsed time since UNIX_EPOCH. If this fails, we've somehow violated causality",
+ );
+
+ (dur.as_secs(), dur.subsec_nanos())
+}
+
+/// A counter that can be used by version 1 and version 6 UUIDs to support
+/// the uniqueness of timestamps.
+///
+/// # References
+///
+/// * [Clock Sequence in RFC4122](https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.5)
+pub trait ClockSequence {
+ /// The type of sequence returned by this counter.
+ type Output;
+
+ /// Get the next value in the sequence to feed into a timestamp.
+ ///
+ /// This method will be called each time a [`Timestamp`] is constructed.
+ fn generate_sequence(&self, seconds: u64, subsec_nanos: u32) -> Self::Output;
+}
+
+impl<'a, T: ClockSequence + ?Sized> ClockSequence for &'a T {
+ type Output = T::Output;
+ fn generate_sequence(&self, seconds: u64, subsec_nanos: u32) -> Self::Output {
+ (**self).generate_sequence(seconds, subsec_nanos)
+ }
+}
+
+/// Default implementations for the [`ClockSequence`] trait.
+pub mod context {
+ use super::ClockSequence;
+
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ use atomic::{Atomic, Ordering};
+
+ /// An empty counter that will always return the value `0`.
+ ///
+ /// This type should be used when constructing timestamps for version 7 UUIDs,
+ /// since they don't need a counter for uniqueness.
+ #[derive(Debug, Clone, Copy, Default)]
+ pub struct NoContext;
+
+ impl ClockSequence for NoContext {
+ type Output = u16;
+
+ fn generate_sequence(&self, _seconds: u64, _nanos: u32) -> Self::Output {
+ 0
+ }
+ }
+
+ #[cfg(all(any(feature = "v1", feature = "v6"), feature = "std", feature = "rng"))]
+ static CONTEXT: Context = Context {
+ count: Atomic::new(0),
+ };
+
+ #[cfg(all(any(feature = "v1", feature = "v6"), feature = "std", feature = "rng"))]
+ static CONTEXT_INITIALIZED: Atomic<bool> = Atomic::new(false);
+
+ #[cfg(all(any(feature = "v1", feature = "v6"), feature = "std", feature = "rng"))]
+ pub(crate) fn shared_context() -> &'static Context {
+ // If the context is in its initial state then assign it to a random value
+ // It doesn't matter if multiple threads observe `false` here and initialize the context
+ if CONTEXT_INITIALIZED
+ .compare_exchange(false, true, Ordering::Relaxed, Ordering::Relaxed)
+ .is_ok()
+ {
+ CONTEXT.count.store(crate::rng::u16(), Ordering::Release);
+ }
+
+ &CONTEXT
+ }
+
+ /// A thread-safe, wrapping counter that produces 14-bit numbers.
+ ///
+ /// This type should be used when constructing version 1 and version 6 UUIDs.
+ #[derive(Debug)]
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ pub struct Context {
+ count: Atomic<u16>,
+ }
+
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ impl Context {
+ /// Construct a new context that's initialized with the given value.
+ ///
+ /// The starting value should be a random number, so that UUIDs from
+ /// different systems with the same timestamps are less likely to collide.
+ /// When the `rng` feature is enabled, prefer the [`Context::new_random`] method.
+ pub const fn new(count: u16) -> Self {
+ Self {
+ count: Atomic::<u16>::new(count),
+ }
+ }
+
+ /// Construct a new context that's initialized with a random value.
+ #[cfg(feature = "rng")]
+ pub fn new_random() -> Self {
+ Self {
+ count: Atomic::<u16>::new(crate::rng::u16()),
+ }
+ }
+ }
+
+ #[cfg(any(feature = "v1", feature = "v6"))]
+ impl ClockSequence for Context {
+ type Output = u16;
+
+ fn generate_sequence(&self, _seconds: u64, _nanos: u32) -> Self::Output {
+ // RFC4122 reserves 2 bits of the clock sequence so the actual
+ // maximum value is smaller than `u16::MAX`. Since we unconditionally
+ // increment the clock sequence we want to wrap once it becomes larger
+ // than what we can represent in a "u14". Otherwise there'd be patches
+ // where the clock sequence doesn't change regardless of the timestamp
+ self.count.fetch_add(1, Ordering::AcqRel) & (u16::MAX >> 2)
+ }
+ }
+}
+
+#[cfg(all(test, any(feature = "v1", feature = "v6")))]
+mod tests {
+ use super::*;
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn rfc4122_unix_does_not_panic() {
+ // Ensure timestamp conversions never panic
+ Timestamp::unix_to_rfc4122_ticks(u64::MAX, 0);
+ Timestamp::unix_to_rfc4122_ticks(0, u32::MAX);
+ Timestamp::unix_to_rfc4122_ticks(u64::MAX, u32::MAX);
+
+ Timestamp::rfc4122_to_unix(u64::MAX);
+ }
+}
diff --git a/crates/uuid/src/v1.rs b/crates/uuid/src/v1.rs
new file mode 100644
index 0000000..41febab
--- /dev/null
+++ b/crates/uuid/src/v1.rs
@@ -0,0 +1,200 @@
+//! The implementation for Version 1 UUIDs.
+//!
+//! This module is soft-deprecated. Instead of using the `Context` type re-exported here,
+//! use the one from the crate root.
+
+use crate::{Builder, Uuid};
+
+#[deprecated(note = "use types from the crate root instead")]
+pub use crate::{timestamp::context::Context, Timestamp};
+
+impl Uuid {
+ /// Create a new version 1 UUID using the current system time and node ID.
+ ///
+ /// This method is only available if both the `std` and `rng` features are enabled.
+ ///
+ /// This method is a convenient alternative to [`Uuid::new_v1`] that uses the current system time
+ /// as the source timestamp.
+ ///
+ /// Note that usage of this method requires the `v1`, `std`, and `rng` features of this crate
+ /// to be enabled.
+ #[cfg(all(feature = "std", feature = "rng"))]
+ pub fn now_v1(node_id: &[u8; 6]) -> Self {
+ let ts = Timestamp::now(crate::timestamp::context::shared_context());
+
+ Self::new_v1(ts, node_id)
+ }
+
+ /// Create a new version 1 UUID using the given timestamp and node ID.
+ ///
+ /// Also see [`Uuid::now_v1`] for a convenient way to generate version 1
+ /// UUIDs using the current system time.
+ ///
+ /// When generating [`Timestamp`]s using a [`ClockSequence`], this function
+ /// is only guaranteed to produce unique values if the following conditions
+ /// hold:
+ ///
+ /// 1. The *node ID* is unique for this process,
+ /// 2. The *context* is shared across all threads which are generating version 1
+ /// UUIDs,
+ /// 3. The [`ClockSequence`] implementation reliably returns unique
+ /// clock sequences (this crate provides [`Context`] for this
+ /// purpose. However you can create your own [`ClockSequence`]
+ /// implementation, if [`Context`] does not meet your needs).
+ ///
+ /// Note that usage of this method requires the `v1` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// A UUID can be created from a unix [`Timestamp`] with a
+ /// [`ClockSequence`]. RFC4122 requires the clock sequence
+ /// is seeded with a random value:
+ ///
+ /// ```
+ /// # use uuid::{Timestamp, Context};
+ /// # use uuid::Uuid;
+ /// # fn random_seed() -> u16 { 42 }
+ /// let context = Context::new(random_seed());
+ /// let ts = Timestamp::from_unix(&context, 1497624119, 1234);
+ ///
+ /// let uuid = Uuid::new_v1(ts, &[1, 2, 3, 4, 5, 6]);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "f3b4958c-52a1-11e7-802a-010203040506"
+ /// );
+ /// ```
+ ///
+ /// The timestamp can also be created manually as per RFC4122:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Timestamp, Context, ClockSequence};
+ /// let context = Context::new(42);
+ /// let ts = Timestamp::from_rfc4122(14976234442241191232, context.generate_sequence(0, 0));
+ ///
+ /// let uuid = Uuid::new_v1(ts, &[1, 2, 3, 4, 5, 6]);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "b2c1ad40-45e0-1fd6-802a-010203040506"
+ /// );
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 1 UUIDs in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.2)
+ ///
+ /// [`Timestamp`]: v1/struct.Timestamp.html
+ /// [`ClockSequence`]: v1/trait.ClockSequence.html
+ /// [`Context`]: v1/struct.Context.html
+ pub fn new_v1(ts: Timestamp, node_id: &[u8; 6]) -> Self {
+ let (ticks, counter) = ts.to_rfc4122();
+
+ Builder::from_rfc4122_timestamp(ticks, counter, node_id).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ use crate::{std::string::ToString, Variant, Version};
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ let time: u64 = 1_496_854_535;
+ let time_fraction: u32 = 812_946_000;
+ let node = [1, 2, 3, 4, 5, 6];
+ let context = Context::new(0);
+
+ let uuid = Uuid::new_v1(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ assert_eq!(uuid.get_version(), Some(Version::Mac));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ assert_eq!(
+ uuid.hyphenated().to_string(),
+ "20616934-4ba2-11e7-8000-010203040506"
+ );
+
+ let ts = uuid.get_timestamp().unwrap().to_rfc4122();
+
+ assert_eq!(ts.0 - 0x01B2_1DD2_1381_4000, 14_968_545_358_129_460);
+
+ // Ensure parsing the same UUID produces the same timestamp
+ let parsed = Uuid::parse_str("20616934-4ba2-11e7-8000-010203040506").unwrap();
+
+ assert_eq!(
+ uuid.get_timestamp().unwrap(),
+ parsed.get_timestamp().unwrap()
+ );
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ #[cfg(all(feature = "std", feature = "rng"))]
+ fn test_now() {
+ let node = [1, 2, 3, 4, 5, 6];
+
+ let uuid = Uuid::now_v1(&node);
+
+ assert_eq!(uuid.get_version(), Some(Version::Mac));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new_context() {
+ let time: u64 = 1_496_854_535;
+ let time_fraction: u32 = 812_946_000;
+ let node = [1, 2, 3, 4, 5, 6];
+
+ // This context will wrap
+ let context = Context::new(u16::MAX >> 2);
+
+ let uuid1 = Uuid::new_v1(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ let time: u64 = 1_496_854_536;
+
+ let uuid2 = Uuid::new_v1(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ assert_eq!(uuid1.get_timestamp().unwrap().to_rfc4122().1, 16383);
+ assert_eq!(uuid2.get_timestamp().unwrap().to_rfc4122().1, 0);
+
+ let time = 1_496_854_535;
+
+ let uuid3 = Uuid::new_v1(Timestamp::from_unix(&context, time, time_fraction), &node);
+ let uuid4 = Uuid::new_v1(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ assert_eq!(uuid3.get_timestamp().unwrap().to_rfc4122().1, 1);
+ assert_eq!(uuid4.get_timestamp().unwrap().to_rfc4122().1, 2);
+ }
+}
diff --git a/crates/uuid/src/v3.rs b/crates/uuid/src/v3.rs
new file mode 100644
index 0000000..ed356d4
--- /dev/null
+++ b/crates/uuid/src/v3.rs
@@ -0,0 +1,169 @@
+use crate::Uuid;
+
+impl Uuid {
+ /// Creates a UUID using a name from a namespace, based on the MD5
+ /// hash.
+ ///
+ /// A number of namespaces are available as constants in this crate:
+ ///
+ /// * [`NAMESPACE_DNS`]
+ /// * [`NAMESPACE_OID`]
+ /// * [`NAMESPACE_URL`]
+ /// * [`NAMESPACE_X500`]
+ ///
+ /// Note that usage of this method requires the `v3` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// Generating a MD5 DNS UUID for `rust-lang.org`:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version};
+ /// let uuid = Uuid::new_v3(&Uuid::NAMESPACE_DNS, b"rust-lang.org");
+ ///
+ /// assert_eq!(Some(Version::Md5), uuid.get_version());
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 3 and 5 UUIDs in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.3)
+ ///
+ /// [`NAMESPACE_DNS`]: #associatedconstant.NAMESPACE_DNS
+ /// [`NAMESPACE_OID`]: #associatedconstant.NAMESPACE_OID
+ /// [`NAMESPACE_URL`]: #associatedconstant.NAMESPACE_URL
+ /// [`NAMESPACE_X500`]: #associatedconstant.NAMESPACE_X500
+ pub fn new_v3(namespace: &Uuid, name: &[u8]) -> Uuid {
+ crate::Builder::from_md5_bytes(crate::md5::hash(namespace.as_bytes(), name)).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ use crate::{std::string::ToString, Variant, Version};
+
+ static FIXTURE: &'static [(&'static Uuid, &'static str, &'static str)] = &[
+ (
+ &Uuid::NAMESPACE_DNS,
+ "example.org",
+ "04738bdf-b25a-3829-a801-b21a1d25095b",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "rust-lang.org",
+ "c6db027c-615c-3b4d-959e-1a917747ca5a",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "42",
+ "5aab6e0c-b7d3-379c-92e3-2bfbb5572511",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "lorem ipsum",
+ "4f8772e9-b59c-3cc9-91a9-5c823df27281",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "example.org",
+ "39682ca1-9168-3da2-a1bb-f4dbcde99bf9",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "rust-lang.org",
+ "7ed45aaf-e75b-3130-8e33-ee4d9253b19f",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "42",
+ "08998a0c-fcf4-34a9-b444-f2bfc15731dc",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "lorem ipsum",
+ "e55ad2e6-fb89-34e8-b012-c5dde3cd67f0",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "example.org",
+ "f14eec63-2812-3110-ad06-1625e5a4a5b2",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "rust-lang.org",
+ "6506a0ec-4d79-3e18-8c2b-f2b6b34f2b6d",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "42",
+ "ce6925a5-2cd7-327b-ab1c-4b375ac044e4",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "lorem ipsum",
+ "5dd8654f-76ba-3d47-bc2e-4d6d3a78cb09",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "example.org",
+ "64606f3f-bd63-363e-b946-fca13611b6f7",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "rust-lang.org",
+ "bcee7a9c-52f1-30c6-a3cc-8c72ba634990",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "42",
+ "c1073fa2-d4a6-3104-b21d-7a6bdcf39a23",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "lorem ipsum",
+ "02f09a3f-1624-3b1d-8409-44eff7708208",
+ ),
+ ];
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ for &(ref ns, ref name, _) in FIXTURE {
+ let uuid = Uuid::new_v3(*ns, name.as_bytes());
+ assert_eq!(uuid.get_version(), Some(Version::Md5));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ }
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_hyphenated_string() {
+ for &(ref ns, ref name, ref expected) in FIXTURE {
+ let uuid = Uuid::new_v3(*ns, name.as_bytes());
+ assert_eq!(uuid.hyphenated().to_string(), *expected);
+ }
+ }
+}
diff --git a/crates/uuid/src/v4.rs b/crates/uuid/src/v4.rs
new file mode 100644
index 0000000..3c42473
--- /dev/null
+++ b/crates/uuid/src/v4.rs
@@ -0,0 +1,81 @@
+use crate::Uuid;
+
+impl Uuid {
+ /// Creates a random UUID.
+ ///
+ /// This uses the [`getrandom`] crate to utilise the operating system's RNG
+ /// as the source of random numbers. If you'd like to use a custom
+ /// generator, don't use this method: generate random bytes using your
+ /// custom generator and pass them to the
+ /// [`uuid::Builder::from_random_bytes`][from_random_bytes] function
+ /// instead.
+ ///
+ /// Note that usage of this method requires the `v4` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version};
+ /// let uuid = Uuid::new_v4();
+ ///
+ /// assert_eq!(Some(Version::Random), uuid.get_version());
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 4 UUIDs in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.4)
+ ///
+ /// [`getrandom`]: https://crates.io/crates/getrandom
+ /// [from_random_bytes]: struct.Builder.html#method.from_random_bytes
+ pub fn new_v4() -> Uuid {
+ crate::Builder::from_random_bytes(crate::rng::bytes()).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{Variant, Version};
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ let uuid = Uuid::new_v4();
+
+ assert_eq!(uuid.get_version(), Some(Version::Random));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_get_version() {
+ let uuid = Uuid::new_v4();
+
+ assert_eq!(uuid.get_version(), Some(Version::Random));
+ assert_eq!(uuid.get_version_num(), 4)
+ }
+}
diff --git a/crates/uuid/src/v5.rs b/crates/uuid/src/v5.rs
new file mode 100644
index 0000000..265aa1a
--- /dev/null
+++ b/crates/uuid/src/v5.rs
@@ -0,0 +1,187 @@
+use crate::Uuid;
+
+impl Uuid {
+ /// Creates a UUID using a name from a namespace, based on the SHA-1 hash.
+ ///
+ /// A number of namespaces are available as constants in this crate:
+ ///
+ /// * [`NAMESPACE_DNS`]
+ /// * [`NAMESPACE_OID`]
+ /// * [`NAMESPACE_URL`]
+ /// * [`NAMESPACE_X500`]
+ ///
+ /// Note that usage of this method requires the `v5` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// Generating a SHA1 DNS UUID for `rust-lang.org`:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version};
+ /// let uuid = Uuid::new_v5(&Uuid::NAMESPACE_DNS, b"rust-lang.org");
+ ///
+ /// assert_eq!(Some(Version::Sha1), uuid.get_version());
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 3 and 5 UUIDs in RFC4122](https://www.rfc-editor.org/rfc/rfc4122#section-4.3)
+ ///
+ /// [`NAMESPACE_DNS`]: struct.Uuid.html#associatedconst.NAMESPACE_DNS
+ /// [`NAMESPACE_OID`]: struct.Uuid.html#associatedconst.NAMESPACE_OID
+ /// [`NAMESPACE_URL`]: struct.Uuid.html#associatedconst.NAMESPACE_URL
+ /// [`NAMESPACE_X500`]: struct.Uuid.html#associatedconst.NAMESPACE_X500
+ pub fn new_v5(namespace: &Uuid, name: &[u8]) -> Uuid {
+ crate::Builder::from_sha1_bytes(crate::sha1::hash(namespace.as_bytes(), name)).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ use crate::{std::string::ToString, Variant, Version};
+
+ static FIXTURE: &'static [(&'static Uuid, &'static str, &'static str)] = &[
+ (
+ &Uuid::NAMESPACE_DNS,
+ "example.org",
+ "aad03681-8b63-5304-89e0-8ca8f49461b5",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "rust-lang.org",
+ "c66bbb60-d62e-5f17-a399-3a0bd237c503",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "42",
+ "7c411b5e-9d3f-50b5-9c28-62096e41c4ed",
+ ),
+ (
+ &Uuid::NAMESPACE_DNS,
+ "lorem ipsum",
+ "97886a05-8a68-5743-ad55-56ab2d61cf7b",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "example.org",
+ "54a35416-963c-5dd6-a1e2-5ab7bb5bafc7",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "rust-lang.org",
+ "c48d927f-4122-5413-968c-598b1780e749",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "42",
+ "5c2b23de-4bad-58ee-a4b3-f22f3b9cfd7d",
+ ),
+ (
+ &Uuid::NAMESPACE_URL,
+ "lorem ipsum",
+ "15c67689-4b85-5253-86b4-49fbb138569f",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "example.org",
+ "34784df9-b065-5094-92c7-00bb3da97a30",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "rust-lang.org",
+ "8ef61ecb-977a-5844-ab0f-c25ef9b8d5d6",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "42",
+ "ba293c61-ad33-57b9-9671-f3319f57d789",
+ ),
+ (
+ &Uuid::NAMESPACE_OID,
+ "lorem ipsum",
+ "6485290d-f79e-5380-9e64-cb4312c7b4a6",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "example.org",
+ "e3635e86-f82b-5bbc-a54a-da97923e5c76",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "rust-lang.org",
+ "26c9c3e9-49b7-56da-8b9f-a0fb916a71a3",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "42",
+ "e4b88014-47c6-5fe0-a195-13710e5f6e27",
+ ),
+ (
+ &Uuid::NAMESPACE_X500,
+ "lorem ipsum",
+ "b11f79a5-1e6d-57ce-a4b5-ba8531ea03d0",
+ ),
+ ];
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_get_version() {
+ let uuid = Uuid::new_v5(&Uuid::NAMESPACE_DNS, "rust-lang.org".as_bytes());
+
+ assert_eq!(uuid.get_version(), Some(Version::Sha1));
+ assert_eq!(uuid.get_version_num(), 5);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_hyphenated() {
+ for &(ref ns, ref name, ref expected) in FIXTURE {
+ let uuid = Uuid::new_v5(*ns, name.as_bytes());
+
+ assert_eq!(uuid.hyphenated().to_string(), *expected)
+ }
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ for &(ref ns, ref name, ref u) in FIXTURE {
+ let uuid = Uuid::new_v5(*ns, name.as_bytes());
+
+ assert_eq!(uuid.get_version(), Some(Version::Sha1));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ assert_eq!(Ok(uuid), u.parse());
+ }
+ }
+}
diff --git a/crates/uuid/src/v6.rs b/crates/uuid/src/v6.rs
new file mode 100644
index 0000000..09c156f
--- /dev/null
+++ b/crates/uuid/src/v6.rs
@@ -0,0 +1,202 @@
+//! The implementation for Version 6 UUIDs.
+//!
+//! Note that you need to enable the `v6` Cargo feature
+//! in order to use this module.
+
+use crate::{Builder, Timestamp, Uuid};
+
+impl Uuid {
+ /// Create a new version 6 UUID using the current system time and node ID.
+ ///
+ /// This method is only available if the `std` feature is enabled.
+ ///
+ /// This method is a convenient alternative to [`Uuid::new_v6`] that uses the current system time
+ /// as the source timestamp.
+ ///
+ /// Note that usage of this method requires the `v6`, `std`, and `rng` features of this crate
+ /// to be enabled.
+ #[cfg(all(feature = "std", feature = "rng"))]
+ pub fn now_v6(node_id: &[u8; 6]) -> Self {
+ let ts = Timestamp::now(crate::timestamp::context::shared_context());
+
+ Self::new_v6(ts, node_id)
+ }
+
+ /// Create a new version 6 UUID using the given timestamp and a node ID.
+ ///
+ /// This is similar to version 1 UUIDs, except that it is lexicographically sortable by timestamp.
+ ///
+ /// Also see [`Uuid::now_v6`] for a convenient way to generate version 6
+ /// UUIDs using the current system time.
+ ///
+ /// When generating [`Timestamp`]s using a [`ClockSequence`], this function
+ /// is only guaranteed to produce unique values if the following conditions
+ /// hold:
+ ///
+ /// 1. The *node ID* is unique for this process,
+ /// 2. The *context* is shared across all threads which are generating version 6
+ /// UUIDs,
+ /// 3. The [`ClockSequence`] implementation reliably returns unique
+ /// clock sequences (this crate provides [`Context`] for this
+ /// purpose. However you can create your own [`ClockSequence`]
+ /// implementation, if [`Context`] does not meet your needs).
+ ///
+ /// The NodeID must be exactly 6 bytes long.
+ ///
+ /// Note that usage of this method requires the `v6` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// A UUID can be created from a unix [`Timestamp`] with a
+ /// [`ClockSequence`]. RFC4122 requires the clock sequence
+ /// is seeded with a random value:
+ ///
+ /// ```rust
+ /// # use uuid::{Uuid, Timestamp, Context};
+ /// # fn random_seed() -> u16 { 42 }
+ /// let context = Context::new(random_seed());
+ /// let ts = Timestamp::from_unix(context, 1497624119, 1234);
+ ///
+ /// let uuid = Uuid::new_v6(ts, &[1, 2, 3, 4, 5, 6]);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "1e752a1f-3b49-658c-802a-010203040506"
+ /// );
+ /// ```
+ ///
+ /// The timestamp can also be created manually as per RFC4122:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Timestamp, Context, ClockSequence};
+ /// # fn random_seed() -> u16 { 42 }
+ /// let context = Context::new(random_seed());
+ /// let ts = Timestamp::from_rfc4122(14976241191231231313, context.generate_sequence(0, 0) );
+ ///
+ /// let uuid = Uuid::new_v6(ts, &[1, 2, 3, 4, 5, 6]);
+ ///
+ /// assert_eq!(
+ /// uuid.hyphenated().to_string(),
+ /// "fd64c041-1e91-6551-802a-010203040506"
+ /// );
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 6 UUIDs in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-5.1)
+ ///
+ /// [`Timestamp`]: timestamp/struct.Timestamp.html
+ /// [`ClockSequence`]: timestamp/trait.ClockSequence.html
+ /// [`Context`]: timestamp/context/struct.Context.html
+ pub fn new_v6(ts: Timestamp, node_id: &[u8; 6]) -> Self {
+ let (ticks, counter) = ts.to_rfc4122();
+
+ Builder::from_sorted_rfc4122_timestamp(ticks, counter, node_id).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{Context, Variant, Version};
+ use std::string::ToString;
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ let time: u64 = 1_496_854_535;
+ let time_fraction: u32 = 812_946_000;
+ let node = [1, 2, 3, 4, 5, 6];
+ let context = Context::new(0);
+
+ let uuid = Uuid::new_v6(Timestamp::from_unix(context, time, time_fraction), &node);
+
+ assert_eq!(uuid.get_version(), Some(Version::SortMac));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ assert_eq!(
+ uuid.hyphenated().to_string(),
+ "1e74ba22-0616-6934-8000-010203040506"
+ );
+
+ let ts = uuid.get_timestamp().unwrap().to_rfc4122();
+
+ assert_eq!(ts.0 - 0x01B2_1DD2_1381_4000, 14_968_545_358_129_460);
+
+ // Ensure parsing the same UUID produces the same timestamp
+ let parsed = Uuid::parse_str("1e74ba22-0616-6934-8000-010203040506").unwrap();
+
+ assert_eq!(
+ uuid.get_timestamp().unwrap(),
+ parsed.get_timestamp().unwrap()
+ );
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ #[cfg(all(feature = "std", feature = "rng"))]
+ fn test_now() {
+ let node = [1, 2, 3, 4, 5, 6];
+
+ let uuid = Uuid::now_v6(&node);
+
+ assert_eq!(uuid.get_version(), Some(Version::SortMac));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new_context() {
+ let time: u64 = 1_496_854_535;
+ let time_fraction: u32 = 812_946_000;
+ let node = [1, 2, 3, 4, 5, 6];
+
+ // This context will wrap
+ let context = Context::new(u16::MAX >> 2);
+
+ let uuid1 = Uuid::new_v6(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ let time: u64 = 1_496_854_536;
+
+ let uuid2 = Uuid::new_v6(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ assert_eq!(uuid1.get_timestamp().unwrap().to_rfc4122().1, 16383);
+ assert_eq!(uuid2.get_timestamp().unwrap().to_rfc4122().1, 0);
+
+ let time = 1_496_854_535;
+
+ let uuid3 = Uuid::new_v6(Timestamp::from_unix(&context, time, time_fraction), &node);
+ let uuid4 = Uuid::new_v6(Timestamp::from_unix(&context, time, time_fraction), &node);
+
+ assert_eq!(uuid3.get_timestamp().unwrap().counter, 1);
+ assert_eq!(uuid4.get_timestamp().unwrap().counter, 2);
+ }
+}
diff --git a/crates/uuid/src/v7.rs b/crates/uuid/src/v7.rs
new file mode 100644
index 0000000..ea8f474
--- /dev/null
+++ b/crates/uuid/src/v7.rs
@@ -0,0 +1,156 @@
+//! The implementation for Version 7 UUIDs.
+//!
+//! Note that you need to enable the `v7` Cargo feature
+//! in order to use this module.
+
+use crate::{rng, std::convert::TryInto, timestamp::Timestamp, Builder, Uuid};
+
+impl Uuid {
+ /// Create a new version 7 UUID using the current time value and random bytes.
+ ///
+ /// This method is a convenient alternative to [`Uuid::new_v7`] that uses the current system time
+ /// as the source timestamp.
+ #[cfg(feature = "std")]
+ pub fn now_v7() -> Self {
+ Self::new_v7(Timestamp::now(crate::NoContext))
+ }
+
+ /// Create a new version 7 UUID using a time value and random bytes.
+ ///
+ /// When the `std` feature is enabled, you can also use [`Uuid::now_v7`].
+ ///
+ /// Note that usage of this method requires the `v7` feature of this crate
+ /// to be enabled.
+ ///
+ /// Also see [`Uuid::now_v7`] for a convenient way to generate version 7
+ /// UUIDs using the current system time.
+ ///
+ /// # Examples
+ ///
+ /// A v7 UUID can be created from a unix [`Timestamp`] plus a 128 bit
+ /// random number. When supplied as such, the data will be
+ ///
+ /// ```rust
+ /// # use uuid::{Uuid, Timestamp, NoContext};
+ /// let ts = Timestamp::from_unix(NoContext, 1497624119, 1234);
+ ///
+ /// let uuid = Uuid::new_v7(ts);
+ ///
+ /// assert!(
+ /// uuid.hyphenated().to_string().starts_with("015cb15a-86d8-7")
+ /// );
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 7 UUIDs in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-5.2)
+ pub fn new_v7(ts: Timestamp) -> Self {
+ let (secs, nanos) = ts.to_unix();
+ let millis = (secs * 1000).saturating_add(nanos as u64 / 1_000_000);
+
+ Builder::from_unix_timestamp_millis(millis, &rng::bytes()[..10].try_into().unwrap())
+ .into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{std::string::ToString, NoContext, Variant, Version};
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ let ts: u64 = 1645557742000;
+
+ let seconds = ts / 1000;
+ let nanos = ((ts % 1000) * 1_000_000) as u32;
+
+ let uuid = Uuid::new_v7(Timestamp::from_unix(NoContext, seconds, nanos));
+ let uustr = uuid.hyphenated().to_string();
+
+ assert_eq!(uuid.get_version(), Some(Version::SortRand));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ assert!(uuid.hyphenated().to_string().starts_with("017f22e2-79b0-7"));
+
+ // Ensure parsing the same UUID produces the same timestamp
+ let parsed = Uuid::parse_str(uustr.as_str()).unwrap();
+
+ assert_eq!(uuid, parsed);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ #[cfg(feature = "std")]
+ fn test_now() {
+ let uuid = Uuid::now_v7();
+
+ assert_eq!(uuid.get_version(), Some(Version::SortRand));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_sorting() {
+ let time1: u64 = 1_496_854_535;
+ let time_fraction1: u32 = 812_000_000;
+
+ let time2 = time1 + 4000;
+ let time_fraction2 = time_fraction1;
+
+ let uuid1 = Uuid::new_v7(Timestamp::from_unix(NoContext, time1, time_fraction1));
+ let uuid2 = Uuid::new_v7(Timestamp::from_unix(NoContext, time2, time_fraction2));
+
+ assert!(uuid1.as_bytes() < uuid2.as_bytes());
+ assert!(uuid1.to_string() < uuid2.to_string());
+ }
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new_timestamp_roundtrip() {
+ let time: u64 = 1_496_854_535;
+ let time_fraction: u32 = 812_000_000;
+
+ let ts = Timestamp::from_unix(NoContext, time, time_fraction);
+
+ let uuid = Uuid::new_v7(ts);
+
+ let decoded_ts = uuid.get_timestamp().unwrap();
+
+ assert_eq!(ts.to_unix(), decoded_ts.to_unix());
+ }
+}
diff --git a/crates/uuid/src/v8.rs b/crates/uuid/src/v8.rs
new file mode 100644
index 0000000..b853ac7
--- /dev/null
+++ b/crates/uuid/src/v8.rs
@@ -0,0 +1,68 @@
+use crate::{Builder, Uuid};
+
+impl Uuid {
+ /// Creates a custom UUID comprised almost entirely of user-supplied bytes.
+ ///
+ /// This will inject the UUID Version at 4 bits starting at the 48th bit
+ /// and the Variant into 2 bits 64th bit. Any existing bits in the user-supplied bytes
+ /// at those locations will be overridden.
+ ///
+ /// Note that usage of this method requires the `v8` feature of this crate
+ /// to be enabled.
+ ///
+ /// # Examples
+ ///
+ /// Basic usage:
+ ///
+ /// ```
+ /// # use uuid::{Uuid, Version};
+ /// let buf: [u8; 16] = *b"abcdefghijklmnop";
+ /// let uuid = Uuid::new_v8(buf);
+ ///
+ /// assert_eq!(Some(Version::Custom), uuid.get_version());
+ /// ```
+ ///
+ /// # References
+ ///
+ /// * [Version 8 UUIDs in Draft RFC: New UUID Formats, Version 4](https://datatracker.ietf.org/doc/html/draft-peabody-dispatch-new-uuid-format-04#section-5.3)
+ pub fn new_v8(buf: [u8; 16]) -> Uuid {
+ Builder::from_custom_bytes(buf).into_uuid()
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::{Variant, Version};
+ use std::string::ToString;
+
+ #[cfg(all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ))]
+ use wasm_bindgen_test::*;
+
+ #[test]
+ #[cfg_attr(
+ all(
+ target_arch = "wasm32",
+ target_vendor = "unknown",
+ target_os = "unknown"
+ ),
+ wasm_bindgen_test
+ )]
+ fn test_new() {
+ let buf: [u8; 16] = [
+ 0xf, 0xe, 0xd, 0xc, 0xb, 0xa, 0x9, 0x8, 0x7, 0x6, 0x5, 0x4, 0x3, 0x2, 0x1, 0x0,
+ ];
+ let uuid = Uuid::new_v8(buf);
+ assert_eq!(uuid.get_version(), Some(Version::Custom));
+ assert_eq!(uuid.get_variant(), Variant::RFC4122);
+ assert_eq!(uuid.get_version_num(), 8);
+ assert_eq!(
+ uuid.hyphenated().to_string(),
+ "0f0e0d0c-0b0a-8908-8706-050403020100"
+ );
+ }
+}
diff --git a/crates/weak-table/.cargo-checksum.json b/crates/weak-table/.cargo-checksum.json
new file mode 100644
index 0000000..13dec12
--- /dev/null
+++ b/crates/weak-table/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"a6279f7c877ebad9c10bc8c1b964d0f82fdf32f5bc498d7e7dd409ac439dad19","CMakeLists.txt":"7c204e615f24b62039acc1c05ffd3473bf486c964436c578b2fc98d2a97b4603","Cargo.toml":"510ec919ac3fe47ac1f5fd54c6727a16ea51e52ceda3c5fe79b1fe209eb7a9a0","LICENSE":"c94d1aee4aa4e9bd6f4fef11b12149950539abab0a1d53b06cb46a797d67a75c","Makefile":"5823ca25be9ef753923bb448afafe7cc7d03e83b456ff6cc3624f9848eb2920d","README.md":"a280369446caaf219f77dc2b031b5d41e858a983f57258b8fc4e1d176715a17c","release.toml":"dfe67ff02e78f914518d5633bfc918b8b481ad58334dbeab244d87e312f06988","src/by_ptr.rs":"8d9dc115e8bf990365a0d7ade49f5b2764f97612b1565672496f3492eb553f99","src/compat.rs":"f2d950819186084fa3b50e6ba9ecde7f8b7b95248174329d9fb4b935d0119c2f","src/lib.rs":"ef511775e7f2fd4e4a01058963cb64959844898fd90770a52bf41a19c60c66f7","src/ptr_weak_hash_set.rs":"68f6a57259c60f66c9f728686b9464824ff44cd9ff22f0ccbd566d25ad029e09","src/ptr_weak_key_hash_map.rs":"06fc10a1a6d314d213a51346b2852f14595957dbc07a841e1fe0ddc5ffb3fb8d","src/ptr_weak_weak_hash_map.rs":"0c64e4292a4f0d8b90ec98af998b344db3ecf9efa2e2175fedb4d4495e6e11e7","src/size_policy.rs":"fff79f91364af4813cf684401be748e7076901cb9259d33bd6cbb3608c88b699","src/traits.rs":"4b76f56dc8504baee77d6605248a3755bd08d58e16b2acc8ed32b8f103689bf1","src/util.rs":"2e022f850b5eb420b970c5fc40c9eed68805fc72c333b4937c829df2cfbd00f6","src/weak_hash_set.rs":"db2e646f5c960f61dd254722a5ebd31ebfec9f4b94a1ead17fd3f7dbc36f9f0c","src/weak_key_hash_map.rs":"63b82d8e0df9444038be872b1d35e1d7af298b70b7ad5965caa89abd27e2bf1a","src/weak_value_hash_map.rs":"f1f8fb63a71636a1b8352e067a28732e5153c67b4c89dce1324c2ff00b04a6f6","src/weak_weak_hash_map.rs":"b7685f891b168f6d5d17863e9312f7fe43ff9af82d3cebed02812e7a50a340a4","tests/symbols.rs":"5c03372ab9fec96cf21de694796930ad47c7a8623c4395259022592989aee533","tests/weak_key_hash_map.rs":"193ebc4f89bccdbeec1d3a0bf9f4dba4106b3a93b8b2adec3ec4171dcbabbc3e"},"package":"323f4da9523e9a669e1eaf9c6e763892769b1d38c623913647bfdc1532fe4549"}
\ No newline at end of file
diff --git a/crates/weak-table/Android.bp b/crates/weak-table/Android.bp
new file mode 100644
index 0000000..75c197a
--- /dev/null
+++ b/crates/weak-table/Android.bp
@@ -0,0 +1,34 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_weak-table_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_weak-table_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libweak_table",
+ host_supported: true,
+ crate_name: "weak_table",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.3.2",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "default",
+ "std",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/weak-table/CHANGELOG.md b/crates/weak-table/CHANGELOG.md
new file mode 100644
index 0000000..68c526e
--- /dev/null
+++ b/crates/weak-table/CHANGELOG.md
@@ -0,0 +1,89 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog] and this project adheres to
+[Semantic Versioning].
+
+[Keep a Changelog]: http://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: http://semver.org/spec/v2.0.0.html
+
+## [Next Release]
+
+## [0.3.2] - 2021-12-01
+
+## [0.3.1] - 2021-11-30
+
+### Added
+- `no_std` compatibility (h/t @tsao-chi)
+
+## [0.2.4] - 2020-06-27
+
+### Fixed
+- Bad bucket selection on collision (h/t Andrew Browne
+ `<[email protected]>`).
+
+## [0.2.3] - 2018-05-30
+
+### Fixed
+- Use `Rc::ptr_eq` to compare `Rc`s by address.
+
+## [0.2.2] - 2018-05-22
+
+### Fixed
+- Weak–weak submap operations were missing a line of code.
+
+### Added
+- `{PtrWeakHashSet,PtrWeakKeyHashMap}::is_empty()` methods.
+
+## [0.2.1] - 2018-05-22
+
+### Fixed
+- documentation
+- a test that was breaking on an older `rustc`
+
+## [0.2.0] - 2018-05-22
+
+### Renamed
+- from `WeakElement::expired` to `WeakElement::is_expired`
+
+### Improved
+- documentation
+
+## [0.1.3] - 2018-05-22
+
+### Added
+- documentation of minimum supported `rustc`
+- a test
+
+## [0.1.2] - 2018-05-21
+
+### Added
+- `WeakKeyHashMap::{get_key, get_both, get_both_mut}` methods
+- `WeakWeakHashMap::{get_key, get_both}` methods
+- `WeakHashSet::get` method
+
+### Changed
+- Values stored behind `Rc`s can now be `?Sized`.
+
+### Removed
+- `struct RcKey<K>`
+
+### Improved
+- documentation
+
+## [0.1.1] - 2018-03-05
+
+Initial release.
+
+[Next Release]: <https://github.com/tov/weak-table-rs/compare/v0.3.2...HEAD>
+[0.3.2]: <https://github.com/tov/weak-table-rs/compare/v0.3.1...v0.3.2>
+[0.3.1]: <https://github.com/tov/weak-table-rs/compare/v0.3.1-alpha.0...v0.3.1>
+[0.2.4]: <https://github.com/tov/weak-table-rs/compare/0.2.3...0.2.4>
+[0.2.3]: <https://github.com/tov/weak-table-rs/compare/0.2.2...0.2.3>
+[0.2.2]: <https://github.com/tov/weak-table-rs/compare/0.2.1...0.2.2>
+[0.2.1]: <https://github.com/tov/weak-table-rs/compare/0.2.0...0.2.1>
+[0.2.0]: <https://github.com/tov/weak-table-rs/compare/0.1.3...0.2.0>
+[0.1.3]: <https://github.com/tov/weak-table-rs/compare/0.1.2...0.1.3>
+[0.1.2]: <https://github.com/tov/weak-table-rs/compare/0.1.1...0.1.2>
+[0.1.1]: <https://github.com/tov/weak-table-rs/tree/0.1.1>
diff --git a/crates/weak-table/CMakeLists.txt b/crates/weak-table/CMakeLists.txt
new file mode 100644
index 0000000..68d8985
--- /dev/null
+++ b/crates/weak-table/CMakeLists.txt
@@ -0,0 +1 @@
+# This file is here to make CLion happy.
diff --git a/crates/weak-table/Cargo.toml b/crates/weak-table/Cargo.toml
new file mode 100644
index 0000000..b2e6cc8
--- /dev/null
+++ b/crates/weak-table/Cargo.toml
@@ -0,0 +1,35 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "weak-table"
+version = "0.3.2"
+authors = ["Jesse A. Tov <[email protected]>"]
+description = "Weak hash maps and sets"
+readme = "README.md"
+keywords = ["containers", "Rc", "Arc", "weak", "no_std"]
+license = "MIT"
+repository = "https://github.com/tov/weak-table-rs"
+[dependencies.ahash]
+version = "0.7.6"
+features = []
+optional = true
+[dev-dependencies.quickcheck]
+version = "1"
+
+[dev-dependencies.rand]
+version = "0.8.4"
+
+[features]
+alloc = []
+default = ["std"]
+std = []
diff --git a/crates/weak-table/LICENSE b/crates/weak-table/LICENSE
new file mode 100644
index 0000000..99d8eb6
--- /dev/null
+++ b/crates/weak-table/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jesse A. Tov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/crates/weak-table/METADATA b/crates/weak-table/METADATA
new file mode 100644
index 0000000..3317bcc
--- /dev/null
+++ b/crates/weak-table/METADATA
@@ -0,0 +1,19 @@
+name: "weak-table"
+description: "Weak hash maps and sets"
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/weak-table"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/weak-table/weak-table-0.3.2.crate"
+ }
+ version: "0.3.2"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2022
+ month: 3
+ day: 1
+ }
+}
diff --git a/crates/weak-table/MODULE_LICENSE_MIT b/crates/weak-table/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/weak-table/MODULE_LICENSE_MIT
diff --git a/crates/weak-table/Makefile b/crates/weak-table/Makefile
new file mode 100644
index 0000000..6720eab
--- /dev/null
+++ b/crates/weak-table/Makefile
@@ -0,0 +1,26 @@
+default: build
+hard: test
+
+CRATE = weak_table
+REPO = weak-table-rs
+
+build:
+ clear
+ cargo build
+ make doc
+
+clippy:
+ rustup run nightly cargo build --features=clippy
+
+doc:
+ cargo doc
+ echo "<meta http-equiv='refresh' content='0;url=$(CRATE)/'>" > target/doc/index.html
+
+test:
+ clear
+ cargo test
+
+upload-doc:
+ make doc
+ ghp-import -n target/doc
+ git push -f https://github.com/tov/$(REPO).git gh-pages
diff --git a/crates/weak-table/README.md b/crates/weak-table/README.md
new file mode 100644
index 0000000..9d4ac80
--- /dev/null
+++ b/crates/weak-table/README.md
@@ -0,0 +1,110 @@
+# weak-table: weak hash maps and sets for Rust
+
+[](https://github.com/tov/weak-table-rs/actions)
+[](https://crates.io/crates/weak-table)
+[](LICENSE-MIT)
+
+This crate defines several kinds of weak hash maps and sets. See
+the [full API documentation](http://docs.rs/weak-table/) for details.
+
+### Rust version support
+
+This crate supports Rust version 1.46 and later.
+
+### Crate features
+
+`weak-table` is built with the `std` feature, which enables
+functionality dependent on the `std` library, enabled by default.
+Optionally, the following dependency may be enabled:
+
+ - `ahash`: use `ahash`’s hasher rather than the `std` hasher
+
+If the `std` feature is disabled (for no_std) then the `ahash` dependency **must** be enabled.
+
+### Examples
+
+Here we create a weak hash map and demonstrate that it forgets mappings
+whose keys expire:
+
+```rust
+use weak_table::WeakKeyHashMap;
+use std::sync::{Arc, Weak};
+
+let mut table = <WeakKeyHashMap<Weak<str>, u32>>::new();
+let one = Arc::<str>::from("one");
+let two = Arc::<str>::from("two");
+
+table.insert(one.clone(), 1);
+
+assert_eq!( table.get("one"), Some(&1) );
+assert_eq!( table.get("two"), None );
+
+table.insert(two.clone(), 2);
+*table.get_mut(&one).unwrap() += 10;
+
+assert_eq!( table.get("one"), Some(&11) );
+assert_eq!( table.get("two"), Some(&2) );
+
+drop(one);
+
+assert_eq!( table.get("one"), None );
+assert_eq!( table.get("two"), Some(&2) );
+```
+
+Here we use a weak hash set to implement a simple string interning facility:
+
+```rust
+use weak_table::WeakHashSet;
+use std::ops::Deref;
+use std::rc::{Rc, Weak};
+
+#[derive(Clone, Debug)]
+pub struct Symbol(Rc<str>);
+
+impl PartialEq for Symbol {
+ fn eq(&self, other: &Symbol) -> bool {
+ Rc::ptr_eq(&self.0, &other.0)
+ }
+}
+
+impl Eq for Symbol {}
+
+impl Deref for Symbol {
+ type Target = str;
+ fn deref(&self) -> &str {
+ &self.0
+ }
+}
+
+#[derive(Debug, Default)]
+pub struct SymbolTable(WeakHashSet<Weak<str>>);
+
+impl SymbolTable {
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ pub fn intern(&mut self, name: &str) -> Symbol {
+ if let Some(rc) = self.0.get(name) {
+ Symbol(rc)
+ } else {
+ let rc = Rc::<str>::from(name);
+ self.0.insert(Rc::clone(&rc));
+ Symbol(rc)
+ }
+ }
+}
+
+#[test]
+fn interning() {
+ let mut tab = SymbolTable::new();
+
+ let a0 = tab.intern("a");
+ let a1 = tab.intern("a");
+ let b = tab.intern("b");
+
+ assert_eq!(a0, a1);
+ assert_ne!(a0, b);
+}
+```
+
diff --git a/crates/weak-table/cargo_embargo.json b/crates/weak-table/cargo_embargo.json
new file mode 100644
index 0000000..cb908d7
--- /dev/null
+++ b/crates/weak-table/cargo_embargo.json
@@ -0,0 +1,3 @@
+{
+ "run_cargo": false
+}
diff --git a/crates/weak-table/release.toml b/crates/weak-table/release.toml
new file mode 100644
index 0000000..03d6f0d
--- /dev/null
+++ b/crates/weak-table/release.toml
@@ -0,0 +1,17 @@
+tag-name = "v{{version}}"
+
+[[pre-release-replacements]]
+file = "src/lib.rs"
+search = "https://docs[.]rs/weak-table/[0-9.]*"
+replace = "https://docs.rs/weak-table/{{version}}"
+
+[[pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "## \\[Next Release\\]"
+replace = "## [Next Release]\n\n## [{{version}}] - {{date}}"
+
+[[pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "\\[Next Release\\]: <https://github.com/tov/weak-table-rs/compare/v*[0-9.]*[.][.][.]HEAD>"
+replace = '''[Next Release]: <https://github.com/tov/weak-table-rs/compare/v{{version}}...HEAD>
+[{{version}}]: <https://github.com/tov/weak-table-rs/compare/v{{prev_version}}...v{{version}}>'''
diff --git a/crates/weak-table/src/by_ptr.rs b/crates/weak-table/src/by_ptr.rs
new file mode 100644
index 0000000..7dc4c77
--- /dev/null
+++ b/crates/weak-table/src/by_ptr.rs
@@ -0,0 +1,33 @@
+use crate::compat::*;
+
+use super::traits::*;
+
+/// Wrapper struct for using pointer equality and hashes rather
+/// than pointed-to value equality and hashes.
+#[derive(Clone, Debug)]
+pub struct ByPtr<K>(K);
+
+impl<K: WeakElement> WeakElement for ByPtr<K> {
+ type Strong = K::Strong;
+
+ fn new(view: &Self::Strong) -> Self {
+ ByPtr(K::new(view))
+ }
+
+ fn view(&self) -> Option<Self::Strong> {
+ self.0.view()
+ }
+}
+
+impl<K: WeakElement> WeakKey for ByPtr<K>
+ where K::Strong: Deref
+{
+ type Key = *const <K::Strong as Deref>::Target;
+
+ fn with_key<F, R>(view: &Self::Strong, f: F) -> R
+ where F: FnOnce(&Self::Key) -> R
+ {
+ f(&(view.deref() as *const _))
+ }
+}
+
diff --git a/crates/weak-table/src/compat.rs b/crates/weak-table/src/compat.rs
new file mode 100644
index 0000000..4644b17
--- /dev/null
+++ b/crates/weak-table/src/compat.rs
@@ -0,0 +1,56 @@
+//! `no_std` compatibility
+
+// If we depend on `ahash`, use its hasher.
+#[cfg(feature = "ahash")]
+pub use ahash::RandomState;
+
+// Use the `std` hasher if we don’t depend on `ahash` but do depend on
+// `std`.
+#[cfg(all(not(feature = "ahash"), feature = "std"))]
+pub use std::collections::hash_map::RandomState;
+
+// If we depend on neither `ahash` nor `std` then it’s an error.
+#[cfg(not(any(feature = "ahash", feature = "std")))]
+compile_error!("weak-table: no_std requires that you enable the `ahash` feature.");
+
+// If we depend on `std`, alias `lib` to `std`.
+#[cfg(feature = "std")]
+mod lib {
+ extern crate std;
+ pub use std::*;
+}
+
+// Otherwise, we are `no_std`, so alias `lib` to `alloc`.
+#[cfg(not(feature = "std"))]
+mod lib {
+ extern crate alloc;
+ pub use alloc::*;
+}
+
+// Stuff from `std`/`alloc` that we use often.
+pub use lib::{
+ boxed::Box,
+ rc,
+ slice,
+ string::String,
+ sync,
+ vec::{self, Vec},
+};
+
+// Stuff from `core` that we use often:
+pub use core::{
+ borrow::Borrow,
+ cmp::max,
+ hash::{BuildHasher, Hash, Hasher},
+ iter::{self, FromIterator},
+ fmt::{self, Debug, Formatter},
+ mem,
+ ops::{self, Deref, Index, IndexMut},
+};
+
+// When testing, we need the `eprintln` macro from `std`:
+#[cfg(test)]
+extern crate std;
+
+#[cfg(test)]
+pub use std::eprintln;
diff --git a/crates/weak-table/src/lib.rs b/crates/weak-table/src/lib.rs
new file mode 100644
index 0000000..6851e7b
--- /dev/null
+++ b/crates/weak-table/src/lib.rs
@@ -0,0 +1,266 @@
+//! This library offers a variety of weak hash tables:
+//!
+//! - For a hash map where the keys are held by weak pointers and compared by key value, see
+//! [`WeakKeyHashMap`](struct.WeakKeyHashMap.html).
+//!
+//! - For a hash map where the keys are held by weak pointers and compared by pointer, see
+//! [`PtrWeakKeyHashMap`](struct.PtrWeakKeyHashMap.html).
+//!
+//! - For a hash map where the values are held by weak pointers, see
+//! [`WeakValueHashMap`](struct.WeakValueHashMap.html).
+//!
+//! - For a hash map where the keys and values are both held by weak pointers and the keys are
+//! compared by value, see
+//! [`WeakWeakHashMap`](struct.WeakWeakHashMap.html).
+//!
+//! - For a hash map where the keys and values are both held by weak pointers and the keys are
+//! compared by pointer, see
+//! [`PtrWeakWeakHashMap`](struct.PtrWeakWeakHashMap.html).
+//!
+//! - For a hash set where the elements are held by weak pointers and compared by element value, see
+//! [`WeakHashSet`](struct.WeakHashSet.html).
+//!
+//! - For a hash set where the elements are held by weak pointers and compared by pointer, see
+//! [`PtrWeakHashSet`](struct.PtrWeakHashSet.html).
+//!
+//! To add support for your own weak pointers, see
+//! [the traits `WeakElement` and `WeakKey`](traits/).
+//!
+//! ## Rust version support
+//!
+//! This crate supports Rust version 1.46 and later.
+//!
+//! ## Asymptotic complexity
+//!
+//! Most operations have documented asymptotic time complexities. When time complexities are
+//! given in big-*O* notation, the following parameters are used consistently:
+//!
+//! - *n*: the *capacity* of the map or set being accessed or constructed
+//!
+//! - *m*: the *capacity* of a second map/set involved in a submap/subset operation
+//!
+//! - *p*: the length of the probe sequence for the key in question
+//!
+//! Note that *p* ∈ *O*(*n*), but we expect it to be *O*(1).
+//!
+//! # Crate features
+//!
+//! `weak-table` is built with the `std` feature, which enables
+//! functionality dependent on the `std` library, enabled by default.
+//! Optionally, the following dependency may be enabled:
+//!
+//! - `ahash`: use `ahash`’s hasher rather than the `std` hasher
+//!
+//! If the `std` feature is disabled (for no_std) then the `ahash` dependency **must** be enabled.
+//!
+//! # Examples
+//!
+//! Here we create a weak hash table mapping strings to integers.
+//! Note that after dropping `one`, the key `"one"` is no longer present in the map.
+//! This is because the map holds the strings as `std::sync::Weak<str>`s.
+//!
+//! ```
+//! use weak_table::WeakKeyHashMap;
+//! use std::sync::{Arc, Weak};
+//!
+//! let mut table = <WeakKeyHashMap<Weak<str>, u32>>::new();
+//! let one = Arc::<str>::from("one");
+//! let two = Arc::<str>::from("two");
+//!
+//! table.insert(one.clone(), 1);
+//!
+//! assert_eq!( table.get("one"), Some(&1) );
+//! assert_eq!( table.get("two"), None );
+//!
+//! table.insert(two.clone(), 2);
+//! *table.get_mut(&one).unwrap() += 10;
+//!
+//! assert_eq!( table.get("one"), Some(&11) );
+//! assert_eq!( table.get("two"), Some(&2) );
+//!
+//! drop(one);
+//!
+//! assert_eq!( table.get("one"), None );
+//! assert_eq!( table.get("two"), Some(&2) );
+//! ```
+//!
+//! Here we use a weak hash set to implement a simple string interning facility:
+//!
+//! ```
+//! use weak_table::WeakHashSet;
+//! use std::ops::Deref;
+//! use std::rc::{Rc, Weak};
+//!
+//! #[derive(Clone, Debug)]
+//! pub struct Symbol(Rc<str>);
+//!
+//! impl PartialEq for Symbol {
+//! fn eq(&self, other: &Symbol) -> bool {
+//! Rc::ptr_eq(&self.0, &other.0)
+//! }
+//! }
+//!
+//! impl Eq for Symbol {}
+//!
+//! impl Deref for Symbol {
+//! type Target = str;
+//! fn deref(&self) -> &str {
+//! &self.0
+//! }
+//! }
+//!
+//! #[derive(Debug, Default)]
+//! pub struct SymbolTable(WeakHashSet<Weak<str>>);
+//!
+//! impl SymbolTable {
+//! pub fn new() -> Self {
+//! Self::default()
+//! }
+//!
+//! pub fn intern(&mut self, name: &str) -> Symbol {
+//! if let Some(rc) = self.0.get(name) {
+//! Symbol(rc)
+//! } else {
+//! let rc = Rc::<str>::from(name);
+//! self.0.insert(Rc::clone(&rc));
+//! Symbol(rc)
+//! }
+//! }
+//! }
+//!
+//! #[test]
+//! fn interning() {
+//! let mut tab = SymbolTable::new();
+//!
+//! let a0 = tab.intern("a");
+//! let a1 = tab.intern("a");
+//! let b = tab.intern("b");
+//!
+//! assert_eq!(a0, a1);
+//! assert_ne!(a0, b);
+//! }
+//! ```
+
+#![doc(html_root_url = "https://docs.rs/weak-table/0.3.2")]
+
+#![cfg_attr(not(feature = "std"), no_std)]
+
+use self::compat::*;
+
+pub mod traits;
+pub mod weak_key_hash_map;
+pub mod ptr_weak_key_hash_map;
+pub mod weak_value_hash_map;
+pub mod weak_weak_hash_map;
+pub mod ptr_weak_weak_hash_map;
+pub mod weak_hash_set;
+pub mod ptr_weak_hash_set;
+
+mod compat;
+mod util;
+mod by_ptr;
+mod size_policy;
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+struct HashCode(u64);
+
+type FullBucket<K, V> = (K, V, HashCode);
+type Bucket<K, V> = Option<FullBucket<K, V>>;
+type TablePtr<K, V> = Box<[Bucket<K, V>]>;
+
+/// A hash map with weak keys, hashed on key value.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct WeakKeyHashMap<K, V, S = RandomState> {
+ hash_builder: S,
+ inner: WeakKeyInnerMap<K, V>,
+}
+
+#[derive(Clone)]
+struct WeakKeyInnerMap<K, V> {
+ buckets: TablePtr<K, V>,
+ len: usize,
+}
+
+/// A hash map with weak keys, hashed on key pointer.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+///
+/// # Examples
+///
+/// ```
+/// use weak_table::PtrWeakKeyHashMap;
+/// use std::rc::{Rc, Weak};
+///
+/// type Table = PtrWeakKeyHashMap<Weak<str>, usize>;
+///
+/// let mut map = Table::new();
+/// let a = Rc::<str>::from("hello");
+/// let b = Rc::<str>::from("hello");
+///
+/// map.insert(a.clone(), 5);
+///
+/// assert_eq!( map.get(&a), Some(&5) );
+/// assert_eq!( map.get(&b), None );
+///
+/// map.insert(b.clone(), 7);
+///
+/// assert_eq!( map.get(&a), Some(&5) );
+/// assert_eq!( map.get(&b), Some(&7) );
+/// ```
+#[derive(Clone)]
+pub struct PtrWeakKeyHashMap<K, V, S = RandomState>(
+ WeakKeyHashMap<by_ptr::ByPtr<K>, V, S>
+);
+
+/// A hash map with weak values.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct WeakValueHashMap<K, V, S = RandomState> {
+ hash_builder: S,
+ inner: WeakValueInnerMap<K, V>,
+}
+
+#[derive(Clone)]
+struct WeakValueInnerMap<K, V> {
+ buckets: TablePtr<K, V>,
+ len: usize,
+}
+
+/// A hash map with weak keys and weak values, hashed on key value.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct WeakWeakHashMap<K, V, S = RandomState> {
+ hash_builder: S,
+ inner: WeakWeakInnerMap<K, V>,
+}
+
+#[derive(Clone)]
+struct WeakWeakInnerMap<K, V> {
+ buckets: TablePtr<K, V>,
+ len: usize,
+}
+
+/// A hash map with weak keys and weak values, hashed on key pointer.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct PtrWeakWeakHashMap<K, V, S = RandomState>(
+ WeakWeakHashMap<by_ptr::ByPtr<K>, V, S>
+);
+
+/// A hash set with weak elements, hashed on element value.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct WeakHashSet<T, S = RandomState>(WeakKeyHashMap<T, (), S>);
+
+/// A hash set with weak elements, hashed on element pointer.
+///
+/// When a weak pointer expires, its mapping is lazily removed.
+#[derive(Clone)]
+pub struct PtrWeakHashSet<T, S = RandomState>(PtrWeakKeyHashMap<T, (), S>);
+
diff --git a/crates/weak-table/src/ptr_weak_hash_set.rs b/crates/weak-table/src/ptr_weak_hash_set.rs
new file mode 100644
index 0000000..9f6cb71
--- /dev/null
+++ b/crates/weak-table/src/ptr_weak_hash_set.rs
@@ -0,0 +1,301 @@
+//! A hash set where the elements are held by weak pointers and compared by pointer.
+
+use crate::compat::*;
+
+use super::traits::*;
+use super::ptr_weak_key_hash_map as base;
+use super::by_ptr::ByPtr;
+
+pub use super::PtrWeakHashSet;
+
+impl <T: WeakElement> PtrWeakHashSet<T, RandomState>
+ where T::Strong: Deref
+{
+ /// Creates an empty `PtrWeakHashSet`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::new())
+ }
+
+ /// Creates an empty `PtrWeakHashSet` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::with_capacity(capacity))
+ }
+}
+
+impl <T: WeakElement, S: BuildHasher> PtrWeakHashSet<T, S>
+ where T::Strong: Deref
+{
+ /// Creates an empty `PtrWeakHashSet` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::with_hasher(hash_builder))
+ }
+
+ /// Creates an empty `PtrWeakHashSet` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::with_capacity_and_hasher(capacity, hash_builder))
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ self.0.hasher()
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.0.remove_expired()
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ self.0.reserve(additional_capacity)
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.0.shrink_to_fit()
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.0.len()
+ }
+
+ /// Is the set known to be empty?
+ ///
+ /// This could answer `false` for an empty set whose elements have
+ /// expired but have yet to be collected.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired elements.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ self.0.load_factor()
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.0.clear()
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains(&self, key: &T::Strong) -> bool {
+ self.0.contains_key(key)
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present. Does not
+ /// replace the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: T::Strong) -> bool {
+ self.0.insert(key, ()).is_some()
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(&mut self, key: &T::Strong) -> bool {
+ self.0.remove(key).is_some()
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, mut f: F)
+ where F: FnMut(T::Strong) -> bool
+ {
+ self.0.retain(|k, _| f(k))
+ }
+
+ /// Is self a subset of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_subset<S1>(&self, other: &PtrWeakHashSet<T, S1>) -> bool
+ where S1: BuildHasher
+ {
+ self.0.domain_is_subset(&other.0)
+ }
+}
+
+/// An iterator over the elements of a set.
+pub struct Iter<'a, T: 'a>(base::Keys<'a, ByPtr<T>, ()>);
+
+impl<'a, T: WeakElement> Iterator for Iter<'a, T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next()
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// An iterator over the elements of a set.
+pub struct IntoIter<T>(base::IntoIter<ByPtr<T>, ()>);
+
+impl<T: WeakElement> Iterator for IntoIter<T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|pair| pair.0)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// A draining iterator over the elements of a set.
+pub struct Drain<'a, T: 'a>(base::Drain<'a, ByPtr<T>, ()>);
+
+impl<'a, T: WeakElement> Iterator for Drain<'a, T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|pair| pair.0)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+impl<T: WeakElement, S> PtrWeakHashSet<T, S>
+ where T::Strong: Deref
+{
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<T> {
+ Iter(self.0.keys())
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<T> {
+ Drain(self.0.drain())
+ }
+}
+
+impl<T, S, S1> PartialEq<PtrWeakHashSet<T, S1>> for PtrWeakHashSet<T, S>
+ where T: WeakElement,
+ T::Strong: Deref,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &PtrWeakHashSet<T, S1>) -> bool {
+ self.0 == other.0
+ }
+}
+
+impl<T: WeakElement, S: BuildHasher> Eq for PtrWeakHashSet<T, S>
+ where T::Strong: Deref
+{ }
+
+impl<T: WeakElement, S: BuildHasher + Default> Default for PtrWeakHashSet<T, S>
+ where T::Strong: Deref
+{
+ fn default() -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::<T, (), S>::default())
+ }
+}
+
+impl<T, S> FromIterator<T::Strong> for PtrWeakHashSet<T, S>
+ where T: WeakElement,
+ T::Strong: Deref,
+ S: BuildHasher + Default
+{
+ fn from_iter<I: IntoIterator<Item=T::Strong>>(iter: I) -> Self {
+ PtrWeakHashSet(base::PtrWeakKeyHashMap::<T, (), S>::from_iter(
+ iter.into_iter().map(|k| (k, ()))))
+ }
+}
+
+impl<T, S> Extend<T::Strong> for PtrWeakHashSet<T, S>
+ where T: WeakElement,
+ T::Strong: Deref,
+ S: BuildHasher
+{
+ fn extend<I: IntoIterator<Item=T::Strong>>(&mut self, iter: I) {
+ self.0.extend(iter.into_iter().map(|k| (k, ())))
+ }
+}
+
+impl<T, S> Debug for PtrWeakHashSet<T, S>
+ where T: WeakElement,
+ T::Strong: Debug
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<T: WeakElement, S> IntoIterator for PtrWeakHashSet<T, S> {
+ type Item = T::Strong;
+ type IntoIter = IntoIter<T>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter(self.0.into_iter())
+ }
+}
+
+impl<'a, T: WeakElement, S> IntoIterator for &'a PtrWeakHashSet<T, S>
+ where T::Strong: Deref
+{
+ type Item = T::Strong;
+ type IntoIter = Iter<'a, T>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ Iter(self.0.keys())
+ }
+}
+
diff --git a/crates/weak-table/src/ptr_weak_key_hash_map.rs b/crates/weak-table/src/ptr_weak_key_hash_map.rs
new file mode 100644
index 0000000..2cd5591
--- /dev/null
+++ b/crates/weak-table/src/ptr_weak_key_hash_map.rs
@@ -0,0 +1,423 @@
+//! A hash map where the keys are held by weak pointers and compared by pointer.
+
+use crate::compat::*;
+
+use super::by_ptr::*;
+use super::traits::*;
+use super::weak_key_hash_map as base;
+
+pub use super::PtrWeakKeyHashMap;
+pub use super::weak_key_hash_map::{Entry, Iter, IterMut, Keys, Values, ValuesMut, Drain, IntoIter};
+
+impl <K: WeakElement, V> PtrWeakKeyHashMap<K, V, RandomState>
+ where K::Strong: Deref
+{
+ /// Creates an empty `PtrWeakKeyHashMap`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::new())
+ }
+
+ /// Creates an empty `PtrWeakKeyHashMap` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::with_capacity(capacity))
+ }
+}
+
+impl <K: WeakElement, V, S: BuildHasher> PtrWeakKeyHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ /// Creates an empty `PtrWeakKeyHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::with_hasher(hash_builder))
+ }
+
+ /// Creates an empty `PtrWeakKeyHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::with_capacity_and_hasher(capacity, hash_builder))
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ self.0.hasher()
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.0.remove_expired()
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ self.0.reserve(additional_capacity)
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.0.shrink_to_fit()
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.0.len()
+ }
+
+ /// Is the map known to be empty?
+ ///
+ /// This could answer `false` for an empty map whose keys have
+ /// expired but have yet to be collected.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired keys.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ self.0.load_factor()
+ }
+
+ /// Gets the requested entry.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn entry(&mut self, key: K::Strong) -> Entry<ByPtr<K>, V> {
+ self.0.entry(key)
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.0.clear()
+ }
+
+ /// Returns a reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get(&self, key: &K::Strong) -> Option<&V> {
+ self.0.get(&(key.deref() as *const _))
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains_key(&self, key:&K::Strong) -> bool {
+ self.0.contains_key(&(key.deref() as *const _))
+ }
+
+ /// Returns a mutable reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_mut(&mut self, key: &K::Strong) -> Option<&mut V> {
+ self.0.get_mut(&(key.deref() as *const _))
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present. Does not
+ /// replace the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: K::Strong, value: V) -> Option<V> {
+ self.0.insert(key, value)
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(&mut self, key: &K::Strong) -> Option<V> {
+ self.0.remove(&(key.deref() as *const _))
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, f: F)
+ where F: FnMut(K::Strong, &mut V) -> bool
+ {
+ self.0.retain(f)
+ }
+
+ /// Is this map a submap of the other, using the given value comparison.
+ ///
+ /// In particular, all the keys of self must be in other and the values must compare true with
+ /// value_equal.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn submap_with<F, S1, V1>(&self, other: &PtrWeakKeyHashMap<K, V1, S1>, value_equal: F) -> bool
+ where F: FnMut(&V, &V1) -> bool,
+ S1: BuildHasher
+ {
+ self.0.is_submap_with(&other.0, value_equal)
+ }
+
+ /// Is self a submap of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap<V1, S1>(&self, other: &PtrWeakKeyHashMap<K, V1, S1>) -> bool
+ where V: PartialEq<V1>,
+ S1: BuildHasher
+ {
+ self.0.is_submap(&other.0)
+ }
+
+ /// Are the keys of self a subset of the keys of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn domain_is_subset<V1, S1>(&self, other: &PtrWeakKeyHashMap<K, V1, S1>) -> bool
+ where S1: BuildHasher
+ {
+ self.0.domain_is_subset(&other.0)
+ }
+}
+
+impl<K: WeakElement, V, S> PtrWeakKeyHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<ByPtr<K>, V> {
+ self.0.iter()
+ }
+
+ /// Gets an iterator over the keys.
+ ///
+ /// *O*(1) time
+ pub fn keys(&self) -> Keys<ByPtr<K>, V> {
+ self.0.keys()
+ }
+
+ /// Gets an iterator over the values.
+ ///
+ /// *O*(1) time
+ pub fn values(&self) -> Values<ByPtr<K>, V> {
+ self.0.values()
+ }
+
+ /// Gets an iterator over the keys and mutable values.
+ ///
+ /// *O*(1) time
+ pub fn iter_mut(&mut self) -> IterMut<ByPtr<K>, V> {
+ self.0.iter_mut()
+ }
+
+ /// Gets an iterator over the mutable values.
+ ///
+ /// *O*(1) time
+ pub fn values_mut(&mut self) -> ValuesMut<ByPtr<K>, V> {
+ self.0.values_mut()
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<ByPtr<K>, V> {
+ self.0.drain()
+ }
+}
+
+impl<K, V, V1, S, S1> PartialEq<PtrWeakKeyHashMap<K, V1, S1>>
+ for PtrWeakKeyHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ V: PartialEq<V1>,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &PtrWeakKeyHashMap<K, V1, S1>) -> bool {
+ self.0 == other.0
+ }
+}
+
+impl<K: WeakElement, V: Eq, S: BuildHasher> Eq for PtrWeakKeyHashMap<K, V, S>
+ where K::Strong: Deref
+{ }
+
+impl<K: WeakElement, V, S: BuildHasher + Default> Default for PtrWeakKeyHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ fn default() -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::<ByPtr<K>, V, S>::default())
+ }
+}
+
+impl<'a, K, V, S> Index<&'a K::Strong> for PtrWeakKeyHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ S: BuildHasher
+{
+ type Output = V;
+
+ fn index(&self, index: &'a K::Strong) -> &Self::Output {
+ self.0.index(&(index.deref() as *const _))
+ }
+}
+
+impl<'a, K, V, S> IndexMut<&'a K::Strong> for PtrWeakKeyHashMap<K, V, S>
+ where
+ K: WeakElement,
+ K::Strong: Deref,
+ S: BuildHasher
+{
+ fn index_mut(&mut self, index: &'a K::Strong) -> &mut Self::Output {
+ self.0.index_mut(&(index.deref() as *const _))
+ }
+}
+
+impl<K, V, S> FromIterator<(K::Strong, V)> for PtrWeakKeyHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ S: BuildHasher + Default
+{
+ fn from_iter<T: IntoIterator<Item=(K::Strong, V)>>(iter: T) -> Self {
+ PtrWeakKeyHashMap(base::WeakKeyHashMap::<ByPtr<K>, V, S>::from_iter(iter))
+ }
+}
+
+impl<K, V, S> Extend<(K::Strong, V)> for PtrWeakKeyHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(K::Strong, V)>>(&mut self, iter: T) {
+ self.0.extend(iter)
+ }
+}
+
+impl<'a, K, V, S> Extend<(&'a K::Strong, &'a V)> for PtrWeakKeyHashMap<K, V, S>
+ where K: 'a + WeakElement,
+ K::Strong: Clone + Deref,
+ V: 'a + Clone,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(&'a K::Strong, &'a V)>>(&mut self, iter: T) {
+ self.0.extend(iter)
+ }
+}
+
+impl<K, V: Debug, S> Debug for PtrWeakKeyHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Debug
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<K: WeakElement, V, S> IntoIterator for PtrWeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, V);
+ type IntoIter = IntoIter<ByPtr<K>, V>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ self.0.into_iter()
+ }
+}
+
+impl<'a, K: WeakElement, V, S> IntoIterator for &'a PtrWeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, &'a V);
+ type IntoIter = Iter<'a, ByPtr<K>, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ (&self.0).into_iter()
+ }
+}
+
+impl<'a, K: WeakElement, V, S> IntoIterator for &'a mut PtrWeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, &'a mut V);
+ type IntoIter = IterMut<'a, ByPtr<K>, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ (&mut self.0).into_iter()
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use crate::compat::{
+ eprintln,
+ rc::{Rc, Weak},
+ Vec,
+ };
+ use super::{Entry, PtrWeakKeyHashMap};
+
+// fn show_me(weakmap: &PtrWeakKeyHashMap<Weak<u32>, f32>) {
+// for (key, _) in weakmap {
+// eprint!(" {:2}", *key);
+// }
+// eprintln!();
+// }
+
+ // From https://github.com/tov/weak-table-rs/issues/1#issuecomment-461858060
+ #[test]
+ fn insert_and_check() {
+ let mut rcs: Vec<Rc<u32>> = Vec::new();
+
+ for i in 0 .. 200 {
+ rcs.push(Rc::new(i));
+ }
+
+ let mut weakmap: PtrWeakKeyHashMap<Weak<u32>, f32> = PtrWeakKeyHashMap::new();
+
+ for item in rcs.iter().cloned() {
+ let f = *item as f32 + 0.1;
+ weakmap.insert(item, f);
+ }
+
+ let mut count = 0;
+
+ for item in &rcs {
+ assert!(weakmap.contains_key(item));
+
+ match weakmap.entry(Rc::clone(item)) {
+ Entry::Occupied(_) => count += 1,
+ Entry::Vacant(_) => eprintln!("PointerWeakKeyHashMap: missing: {}", *item),
+ }
+ }
+
+ assert_eq!( count, rcs.len() );
+ }
+}
diff --git a/crates/weak-table/src/ptr_weak_weak_hash_map.rs b/crates/weak-table/src/ptr_weak_weak_hash_map.rs
new file mode 100644
index 0000000..fb49ae7
--- /dev/null
+++ b/crates/weak-table/src/ptr_weak_weak_hash_map.rs
@@ -0,0 +1,374 @@
+//! A hash map where the keys and values are both held by weak pointers, and keys are compared by
+//! pointer.
+
+use crate::compat::*;
+
+use super::by_ptr::*;
+use super::traits::*;
+use super::weak_weak_hash_map as base;
+
+pub use super::PtrWeakWeakHashMap;
+pub use super::weak_weak_hash_map::{Entry, Iter, Keys, Values, Drain, IntoIter};
+
+impl <K: WeakElement, V: WeakElement> PtrWeakWeakHashMap<K, V, RandomState>
+ where K::Strong: Deref
+{
+ /// Creates an empty `PtrWeakWeakHashMap`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::new())
+ }
+
+ /// Creates an empty `PtrWeakWeakHashMap` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::with_capacity(capacity))
+ }
+}
+
+impl <K: WeakElement, V: WeakElement, S: BuildHasher> PtrWeakWeakHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ /// Creates an empty `PtrWeakWeakHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::with_hasher(hash_builder))
+ }
+
+ /// Creates an empty `PtrWeakWeakHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::with_capacity_and_hasher(capacity, hash_builder))
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ self.0.hasher()
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.0.remove_expired()
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ self.0.reserve(additional_capacity)
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.0.shrink_to_fit()
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.0.len()
+ }
+
+ /// Is the map empty?
+ ///
+ /// Note that this may return false even if all keys in the map have
+ /// expired, if they haven't been collected yet.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.0.is_empty()
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired keys.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ self.0.load_factor()
+ }
+
+ /// Gets the requested entry.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn entry(&mut self, key: K::Strong) -> Entry<ByPtr<K>, V> {
+ self.0.entry(key)
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.0.clear()
+ }
+
+ /// Returns a reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get(&self, key: &K::Strong) -> Option<V::Strong> {
+ self.0.get(&(key.deref() as *const _))
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains_key(&self, key: &K::Strong) -> bool {
+ self.0.contains_key(&(key.deref() as *const _))
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present. Does not
+ /// replace the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: K::Strong, value: V::Strong) -> Option<V::Strong> {
+ self.0.insert(key, value)
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(&mut self, key: &K::Strong) -> Option<V::Strong> {
+ self.0.remove(&(key.deref() as *const _))
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, f: F)
+ where F: FnMut(K::Strong, V::Strong) -> bool
+ {
+ self.0.retain(f)
+ }
+
+ /// Is this map a submap of the other, using the given value comparison.
+ ///
+ /// In particular, all the keys of self must be in other and the values must compare true with
+ /// value_equal.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn submap_with<F, S1, V1>(&self, other: &PtrWeakWeakHashMap<K, V1, S1>, value_equal: F) -> bool
+ where F: FnMut(V::Strong, V1::Strong) -> bool,
+ V1: WeakElement,
+ S1: BuildHasher
+ {
+ self.0.is_submap_with(&other.0, value_equal)
+ }
+
+ /// Is self a submap of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap<V1, S1>(&self, other: &PtrWeakWeakHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S1: BuildHasher
+ {
+ self.0.is_submap(&other.0)
+ }
+
+ /// Are the keys of self a subset of the keys of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn domain_is_subset<V1, S1>(&self, other: &PtrWeakWeakHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ S1: BuildHasher
+ {
+ self.0.domain_is_subset(&other.0)
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S> PtrWeakWeakHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<ByPtr<K>, V> {
+ self.0.iter()
+ }
+
+ /// Gets an iterator over the keys.
+ ///
+ /// *O*(1) time
+ pub fn keys(&self) -> Keys<ByPtr<K>, V> {
+ self.0.keys()
+ }
+
+ /// Gets an iterator over the values.
+ ///
+ /// *O*(1) time
+ pub fn values(&self) -> Values<ByPtr<K>, V> {
+ self.0.values()
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<ByPtr<K>, V> {
+ self.0.drain()
+ }
+}
+
+impl<K, V, V1, S, S1> PartialEq<PtrWeakWeakHashMap<K, V1, S1>>
+ for PtrWeakWeakHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ V: WeakElement,
+ V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &PtrWeakWeakHashMap<K, V1, S1>) -> bool {
+ self.0 == other.0
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S: BuildHasher> Eq for PtrWeakWeakHashMap<K, V, S>
+ where K::Strong: Deref,
+ V::Strong: Eq
+{ }
+
+impl<K: WeakElement, V: WeakElement, S: BuildHasher + Default> Default for PtrWeakWeakHashMap<K, V, S>
+ where K::Strong: Deref
+{
+ fn default() -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::<ByPtr<K>, V, S>::default())
+ }
+}
+
+impl<K, V, S> FromIterator<(K::Strong, V::Strong)> for PtrWeakWeakHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ V: WeakElement,
+ S: BuildHasher + Default
+{
+ fn from_iter<T: IntoIterator<Item=(K::Strong, V::Strong)>>(iter: T) -> Self {
+ PtrWeakWeakHashMap(base::WeakWeakHashMap::<ByPtr<K>, V, S>::from_iter(iter))
+ }
+}
+
+impl<K, V, S> Extend<(K::Strong, V::Strong)> for PtrWeakWeakHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Deref,
+ V: WeakElement,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(K::Strong, V::Strong)>>(&mut self, iter: T) {
+ self.0.extend(iter)
+ }
+}
+
+impl<K, V, S> Debug for PtrWeakWeakHashMap<K, V, S>
+ where K: WeakElement,
+ K::Strong: Debug,
+ V: WeakElement,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S> IntoIterator for PtrWeakWeakHashMap<K, V, S> {
+ type Item = (K::Strong, V::Strong);
+ type IntoIter = IntoIter<ByPtr<K>, V>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ self.0.into_iter()
+ }
+}
+
+impl<'a, K: WeakElement, V: WeakElement, S> IntoIterator for &'a PtrWeakWeakHashMap<K, V, S> {
+ type Item = (K::Strong, V::Strong);
+ type IntoIter = Iter<'a, ByPtr<K>, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ (&self.0).into_iter()
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use crate::compat::{
+ eprintln,
+ rc::{Rc, Weak},
+ Vec,
+ };
+ use super::{Entry, PtrWeakWeakHashMap};
+
+// fn show_me(weakmap: &PtrWeakWeakHashMap<Weak<u32>, Weak<f32>>) {
+// for (key, _) in weakmap {
+// eprint!(" {:2}", *key);
+// }
+// eprintln!();
+// }
+
+ // From https://github.com/tov/weak-table-rs/issues/1#issuecomment-461858060
+ #[test]
+ fn insert_and_check() {
+ let mut rcs: Vec<(Rc<u32>, Rc<f32>)> = Vec::new();
+
+ for i in 0 .. 200 {
+ rcs.push((Rc::new(i), Rc::new(i as f32 + 0.1)));
+ }
+
+ let mut weakmap: PtrWeakWeakHashMap<Weak<u32>, Weak<f32>> = PtrWeakWeakHashMap::new();
+
+ for (key, value) in rcs.iter().cloned() {
+ weakmap.insert(key, value);
+// show_me(&weakmap);
+ }
+
+ let mut count = 0;
+
+ for (key, value) in &rcs {
+ assert!(weakmap.contains_key(key));
+
+ match weakmap.entry(Rc::clone(key)) {
+ Entry::Occupied(occ) => {
+ assert_eq!( occ.get(), value );
+ count += 1;
+ }
+ Entry::Vacant(_) => {
+ eprintln!("PointerWeakWeakHashMap: missing: {}", *key);
+ }
+ }
+ }
+
+ assert_eq!( count, rcs.len() );
+ }
+}
+
+
diff --git a/crates/weak-table/src/size_policy.rs b/crates/weak-table/src/size_policy.rs
new file mode 100644
index 0000000..7eb5c6a
--- /dev/null
+++ b/crates/weak-table/src/size_policy.rs
@@ -0,0 +1,14 @@
+/// No reason for this number as of now.
+pub const DEFAULT_INITIAL_CAPACITY: usize = 8;
+
+/// When the approximate load factor reaches `COLLECT_LOAD_FACTOR`, we remove
+/// all the expired pointers and then consider resizing.
+pub const COLLECT_LOAD_FACTOR: f32 = 0.9;
+
+/// If, after collection, the load factor is above `GROW_LOAD_FACTOR`, we grow.
+pub const GROW_LOAD_FACTOR: f32 = 0.75;
+
+/// If, after collection, the load factor is below `SHRINK_LOAD_FACTOR`, we shrink.
+pub const SHRINK_LOAD_FACTOR: f32 = 0.25;
+
+
diff --git a/crates/weak-table/src/traits.rs b/crates/weak-table/src/traits.rs
new file mode 100644
index 0000000..878e5a3
--- /dev/null
+++ b/crates/weak-table/src/traits.rs
@@ -0,0 +1,139 @@
+//! Traits for describing strong and weak pointers and their use as elements and keys.
+//!
+//! These traits provide mechanisms for converting between weak and strong pointers
+//! ([`WeakElement`](trait.WeakElement.html)) and for dereferencing strong pointers
+//! ([`WeakKey`](trait.WeakKey.html)). Implementations of these traits are provided for
+//! `std::rc::Weak` and `std::sync::Weak`. If you would like to use your own pointer type
+//! as a weak element, you need to implement `WeakElement` for your weak pointer type; to use it
+//! as a weak key, implement `WeakKey` as well.
+
+use crate::compat::*;
+
+/// Interface for elements that can be stored in weak hash tables.
+///
+/// This trait applies to the weak version of a reference-counted pointer; it can be used to
+/// convert a weak pointer into a strong pointer and back. For example, the impl for
+/// `std::rc::Weak<T>` defines the `Strong` associated type as `std::rc::Rc<T>`. Then method
+/// `new` can be used to downgrade an `Rc<T>` to a `Weak<T>`, and method `view` can be used to
+/// upgrade a `Weak<T>` into an `Rc<T>`, if it's still alive. If we think of the weak pointer as
+/// what is stored, then the strong pointer is a temporary view of it.
+pub trait WeakElement {
+ /// The type at which a weak element can be viewed.
+ ///
+ /// For example, for `std::rc::Weak<T>`, this will be `std::rc::Rc<T>`.
+ type Strong;
+
+ /// Constructs a weak pointer from a strong pointer.
+ ///
+ /// This is usually implemented by a `downgrade` method.
+ fn new(view: &Self::Strong) -> Self;
+
+ /// Acquires a strong pointer from a weak pointer.
+ ///
+ /// This is usually implemented by an `upgrade` method.
+ fn view(&self) -> Option<Self::Strong>;
+
+ /// Is the given weak element expired?
+ ///
+ /// The default implemention checks whether a strong pointer can be obtained via `view`.
+ fn is_expired(&self) -> bool {
+ self.view().is_none()
+ }
+
+ /// Clones a strong pointer.
+ ///
+ /// The default implementation uses `new` and `view`; you should override it.
+ fn clone(view: &Self::Strong) -> Self::Strong
+ where Self: Sized
+ {
+ Self::new(view).view().expect("WeakElement::clone")
+ }
+}
+
+/// Interface for elements that can act as keys in weak hash tables.
+///
+/// To use an element as a weak hash map key or weak hash set element), the hash table
+/// needs to be able to view the actual key values to hash and compare them. This trait
+/// provides the necessary mechanism.
+pub trait WeakKey : WeakElement {
+ /// The underlying key type.
+ ///
+ /// For example, for `std::rc::Weak<T>`, this will be `T`.
+ type Key: ?Sized + Eq + Hash;
+
+ /// Allows borrowing a view of the key, via a callback.
+ ///
+ /// Rather than returning a borrowed reference to the actual key, this method passes a
+ /// reference to the key to a callback with an implicit higher-order lifetime bound. This is
+ /// necessary to get the lifetimes right in cases where the key is not actually store in the
+ /// strong pointer.
+ fn with_key<F, R>(view: &Self::Strong, f: F) -> R
+ where F: FnOnce(&Self::Key) -> R;
+
+ /// Hashes the key `view` into the given `Hasher`.
+ fn hash<H: Hasher>(view: &Self::Strong, h: &mut H) {
+ Self::with_key(view, |k| k.hash(h));
+ }
+
+ /// Returns whether the key `view` equals the given `key`.
+ fn equals<Q>(view: &Self::Strong, key: &Q) -> bool
+ where Q: ?Sized + Eq,
+ Self::Key: Borrow<Q>
+ {
+ Self::with_key(view, |k| k.borrow() == key)
+ }
+}
+
+impl<T: ?Sized> WeakElement for rc::Weak<T> {
+ type Strong = rc::Rc<T>;
+
+ fn new(view: &Self::Strong) -> Self {
+ rc::Rc::<T>::downgrade(view)
+ }
+
+ fn view(&self) -> Option<Self::Strong> {
+ self.upgrade()
+ }
+
+ fn clone(view: &Self::Strong) -> Self::Strong {
+ view.clone()
+ }
+}
+
+impl<T: ?Sized + Eq + Hash> WeakKey for rc::Weak<T> {
+ type Key = T;
+
+ fn with_key<F, R>(view: &Self::Strong, f: F) -> R
+ where F: FnOnce(&Self::Key) -> R
+ {
+ f(view)
+ }
+}
+
+impl<T: ?Sized> WeakElement for sync::Weak<T> {
+ type Strong = sync::Arc<T>;
+
+ fn new(view: &Self::Strong) -> Self {
+ sync::Arc::<T>::downgrade(view)
+ }
+
+ fn view(&self) -> Option<Self::Strong> {
+ self.upgrade()
+ }
+
+ fn clone(view: &Self::Strong) -> Self::Strong {
+ view.clone()
+ }
+}
+
+impl<T: ?Sized + Eq + Hash> WeakKey for sync::Weak<T>
+{
+ type Key = T;
+
+ fn with_key<F, R>(view: &Self::Strong, f: F) -> R
+ where F: FnOnce(&Self::Key) -> R
+ {
+ f(view)
+ }
+}
+
diff --git a/crates/weak-table/src/util.rs b/crates/weak-table/src/util.rs
new file mode 100644
index 0000000..9affd7f
--- /dev/null
+++ b/crates/weak-table/src/util.rs
@@ -0,0 +1,9 @@
+use crate::compat::*;
+
+pub fn new_boxed_option_slice<T>(size: usize) -> Box<[Option<T>]> {
+ let mut vector = Vec::with_capacity(size);
+ for _ in 0 .. size {
+ vector.push(None)
+ }
+ vector.into_boxed_slice()
+}
diff --git a/crates/weak-table/src/weak_hash_set.rs b/crates/weak-table/src/weak_hash_set.rs
new file mode 100644
index 0000000..bbff3b8
--- /dev/null
+++ b/crates/weak-table/src/weak_hash_set.rs
@@ -0,0 +1,316 @@
+//! A hash set where the elements are held by weak pointers and compared by value.
+
+use crate::compat::*;
+
+use super::traits::*;
+use super::weak_key_hash_map as base;
+
+pub use super::WeakHashSet;
+
+impl <T: WeakKey> WeakHashSet<T, RandomState> {
+ /// Creates an empty `WeakHashSet`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ WeakHashSet(base::WeakKeyHashMap::new())
+ }
+
+ /// Creates an empty `WeakHashSet` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ WeakHashSet(base::WeakKeyHashMap::with_capacity(capacity))
+ }
+}
+
+impl <T: WeakKey, S: BuildHasher> WeakHashSet<T, S> {
+ /// Creates an empty `WeakHashSet` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ WeakHashSet(base::WeakKeyHashMap::with_hasher(hash_builder))
+ }
+
+ /// Creates an empty `WeakHashSet` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ WeakHashSet(base::WeakKeyHashMap::with_capacity_and_hasher(capacity, hash_builder))
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ self.0.hasher()
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.0.remove_expired()
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ self.0.reserve(additional_capacity)
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.0.shrink_to_fit()
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.0.len()
+ }
+
+ /// Is the set empty?
+ ///
+ /// Note that this may return false even if all keys in the set have
+ /// expired, if they haven't been collected yet.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.0.is_empty()
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired elements.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ self.0.load_factor()
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.0.clear()
+ }
+
+ // Non-ptr WeakHashSet should probably have `get` method.
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains<Q>(&self, key: &Q) -> bool
+ where Q: ?Sized + Eq + Hash,
+ T::Key: Borrow<Q>
+ {
+ self.0.contains_key(key)
+ }
+
+ /// Gets a strong reference to the given key, if found.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use weak_table::WeakHashSet;
+ /// use std::rc::{Rc, Weak};
+ /// use std::ops::Deref;
+ ///
+ /// let mut set: WeakHashSet<Weak<String>> = WeakHashSet::new();
+ ///
+ /// let a = Rc::new("a".to_owned());
+ /// set.insert(a.clone());
+ ///
+ /// let also_a = set.get("a").unwrap();
+ ///
+ /// assert!(Rc::ptr_eq( &a, &also_a ));
+ /// ```
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get<Q>(&self, key: &Q) -> Option<T::Strong>
+ where Q: ?Sized + Eq + Hash,
+ T::Key: Borrow<Q>
+ {
+ self.0.get_key(key)
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present. Does not
+ /// replace the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: T::Strong) -> bool {
+ self.0.insert(key, ()).is_some()
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove<Q>(&mut self, key: &Q) -> bool
+ where Q: ?Sized + Eq + Hash,
+ T::Key: Borrow<Q>
+ {
+ self.0.remove(key).is_some()
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, mut f: F)
+ where F: FnMut(T::Strong) -> bool
+ {
+ self.0.retain(|k, _| f(k))
+ }
+
+ /// Is self a subset of other?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_subset<S1>(&self, other: &WeakHashSet<T, S1>) -> bool
+ where S1: BuildHasher
+ {
+ self.0.domain_is_subset(&other.0)
+ }
+}
+
+/// An iterator over the elements of a set.
+pub struct Iter<'a, T: 'a>(base::Keys<'a, T, ()>);
+
+impl<'a, T: WeakElement> Iterator for Iter<'a, T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next()
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// An iterator over the elements of a set.
+pub struct IntoIter<T>(base::IntoIter<T, ()>);
+
+impl<T: WeakElement> Iterator for IntoIter<T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|pair| pair.0)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// A draining iterator over the elements of a set.
+pub struct Drain<'a, T: 'a>(base::Drain<'a, T, ()>);
+
+impl<'a, T: WeakElement> Iterator for Drain<'a, T> {
+ type Item = T::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|pair| pair.0)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+impl<T: WeakKey, S> WeakHashSet<T, S> {
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<T> {
+ Iter(self.0.keys())
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<T> {
+ Drain(self.0.drain())
+ }
+}
+
+impl<T, S, S1> PartialEq<WeakHashSet<T, S1>> for WeakHashSet<T, S>
+ where T: WeakKey,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &WeakHashSet<T, S1>) -> bool {
+ self.0 == other.0
+ }
+}
+
+impl<T: WeakKey, S: BuildHasher> Eq for WeakHashSet<T, S>
+ where T::Key: Eq
+{ }
+
+impl<T: WeakKey, S: BuildHasher + Default> Default for WeakHashSet<T, S> {
+ fn default() -> Self {
+ WeakHashSet(base::WeakKeyHashMap::<T, (), S>::default())
+ }
+}
+
+impl<T, S> FromIterator<T::Strong> for WeakHashSet<T, S>
+ where T: WeakKey,
+ S: BuildHasher + Default
+{
+ fn from_iter<I: IntoIterator<Item=T::Strong>>(iter: I) -> Self {
+ WeakHashSet(base::WeakKeyHashMap::<T, (), S>::from_iter(
+ iter.into_iter().map(|k| (k, ()))))
+ }
+}
+
+impl<T: WeakKey, S: BuildHasher> Extend<T::Strong> for WeakHashSet<T, S> {
+ fn extend<I: IntoIterator<Item=T::Strong>>(&mut self, iter: I) {
+ self.0.extend(iter.into_iter().map(|k| (k, ())))
+ }
+}
+
+impl<T: WeakKey, S> Debug for WeakHashSet<T, S>
+ where T::Strong: Debug
+{
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<T: WeakKey, S> IntoIterator for WeakHashSet<T, S> {
+ type Item = T::Strong;
+ type IntoIter = IntoIter<T>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter(self.0.into_iter())
+ }
+}
+
+impl<'a, T: WeakKey, S> IntoIterator for &'a WeakHashSet<T, S> {
+ type Item = T::Strong;
+ type IntoIter = Iter<'a, T>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ Iter(self.0.keys())
+ }
+}
diff --git a/crates/weak-table/src/weak_key_hash_map.rs b/crates/weak-table/src/weak_key_hash_map.rs
new file mode 100644
index 0000000..7dcb8c4
--- /dev/null
+++ b/crates/weak-table/src/weak_key_hash_map.rs
@@ -0,0 +1,1165 @@
+//! A hash map where the keys are held by weak pointers and compared by key value.
+
+use super::*;
+use super::size_policy::*;
+use super::traits::*;
+use super::util::*;
+
+pub use super::WeakKeyHashMap;
+
+/// Represents an entry in the table which may be occupied or vacant.
+pub enum Entry<'a, K: 'a + WeakKey, V: 'a> {
+ Occupied(OccupiedEntry<'a, K, V>),
+ Vacant(VacantEntry<'a, K, V>),
+}
+
+/// An occupied entry, which can be removed or viewed.
+pub struct OccupiedEntry<'a, K: 'a + WeakKey, V: 'a>(InnerEntry<'a, K, V>);
+
+/// A vacant entry, which can be inserted in or viewed.
+pub struct VacantEntry<'a, K: 'a + WeakKey, V: 'a>(InnerEntry<'a, K, V>);
+
+struct InnerEntry<'a, K: 'a + WeakKey, V: 'a> {
+ map: &'a mut WeakKeyInnerMap<K, V>,
+ pos: usize,
+ key: K::Strong,
+ hash_code: HashCode,
+}
+
+/// An iterator over the keys and values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Iter<'a, K: 'a, V: 'a> {
+ base: slice::Iter<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K: WeakElement, V> Iterator for Iter<'a, K, V> {
+ type Item = (K::Strong, &'a V);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((ref weak_ptr, ref value, _)) = *bucket {
+ self.size -= 1;
+ if let Some(strong_ptr) = weak_ptr.view() {
+ return Some((strong_ptr, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+#[derive(Debug)]
+/// An iterator over the keys and mutable values of the weak hash map.
+pub struct IterMut<'a, K: 'a, V: 'a> {
+ base: slice::IterMut<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K: WeakElement, V> Iterator for IterMut<'a, K, V> {
+ type Item = (K::Strong, &'a mut V);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((ref weak_ptr, ref mut value, _)) = *bucket {
+ self.size -= 1;
+ if let Some(strong_ptr) = weak_ptr.view() {
+ return Some((strong_ptr, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+/// An iterator over the keys of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Keys<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K: WeakElement, V> Iterator for Keys<'a, K, V> {
+ type Item = K::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(k, _)| k)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// An iterator over the values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Values<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K: WeakElement, V> Iterator for Values<'a, K, V> {
+ type Item = &'a V;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(_, v)| v)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+#[derive(Debug)]
+/// An iterator over the mutable values of the weak hash map.
+pub struct ValuesMut<'a, K: 'a, V: 'a>(IterMut<'a, K, V>);
+
+impl<'a, K: WeakElement, V> Iterator for ValuesMut<'a, K, V> {
+ type Item = &'a mut V;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(_, v)| v)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+#[derive(Debug)]
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct Drain<'a, K: 'a, V: 'a> {
+ base: slice::IterMut<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K: WeakElement, V> Iterator for Drain<'a, K, V> {
+ type Item = (K::Strong, V);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((weak_ptr, value, _)) = bucket.take() {
+ self.size -= 1;
+ if let Some(strong_ptr) = weak_ptr.view() {
+ return Some((strong_ptr, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<'a, K, V> Drop for Drain<'a, K, V> {
+ fn drop(&mut self) {
+ for option in &mut self.base {
+ *option = None;
+ }
+ }
+}
+
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct IntoIter<K, V> {
+ base: vec::IntoIter<Bucket<K, V>>,
+ size: usize,
+}
+
+impl<K: WeakElement, V> Iterator for IntoIter<K, V> {
+ type Item = (K::Strong, V);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for (weak_ptr, value, _) in (&mut self.base).flatten() {
+ self.size -= 1;
+ if let Some(strong_ptr) = weak_ptr.view() {
+ return Some((strong_ptr, value));
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<K: WeakKey, V> WeakKeyHashMap<K, V, RandomState>
+{
+ /// Creates an empty `WeakKeyHashMap`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ Self::with_capacity(DEFAULT_INITIAL_CAPACITY)
+ }
+
+ /// Creates an empty `WeakKeyHashMap` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ Self::with_capacity_and_hasher(capacity, Default::default())
+ }
+}
+
+impl<K: WeakKey, V, S: BuildHasher> WeakKeyHashMap<K, V, S>
+{
+ /// Creates an empty `WeakKeyHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ Self::with_capacity_and_hasher(DEFAULT_INITIAL_CAPACITY, hash_builder)
+ }
+
+ /// Creates an empty `WeakKeyHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ WeakKeyHashMap {
+ hash_builder,
+ inner: WeakKeyInnerMap {
+ buckets: new_boxed_option_slice(capacity),
+ len: 0,
+ }
+ }
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ &self.hash_builder
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+
+ /// This has some preconditions.
+ fn resize(&mut self, capacity: usize) {
+ let old_buckets = mem::replace(&mut self.inner.buckets,
+ new_boxed_option_slice(capacity));
+
+ let iter = IntoIter {
+ base: old_buckets.into_vec().into_iter(),
+ size: self.inner.len,
+ };
+
+ self.inner.len = 0;
+
+ for (key, value) in iter {
+ self.entry_no_grow(key).or_insert(value);
+ }
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.retain(|_, _| true)
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ let new_capacity = additional_capacity + self.capacity();
+ self.resize(new_capacity);
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.remove_expired();
+ let new_capacity = (self.len() as f32 / COLLECT_LOAD_FACTOR).ceil() as usize;
+ self.resize(new_capacity);
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.inner.len
+ }
+
+ /// Is the map empty?
+ ///
+ /// Note that this may return false even if all keys in the map have
+ /// expired, if they haven't been collected yet.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired keys.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ (self.len() as f32 + 1.0) / self.capacity() as f32
+ }
+
+ fn maybe_adjust_size(&mut self) {
+ if self.load_factor() > COLLECT_LOAD_FACTOR {
+ self.remove_expired();
+
+ let load_factor = self.load_factor();
+ let capacity = self.capacity();
+ if load_factor > GROW_LOAD_FACTOR {
+ self.resize(max(1, capacity * 2));
+ } else if load_factor < SHRINK_LOAD_FACTOR && capacity > DEFAULT_INITIAL_CAPACITY {
+ self.resize(max(1, capacity / 2));
+ }
+ }
+ }
+
+ /// Gets the requested entry.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn entry(&mut self, key: K::Strong) -> Entry<K, V> {
+ self.maybe_adjust_size();
+ self.entry_no_grow(key)
+ }
+
+ fn entry_no_grow(&mut self, key: K::Strong) -> Entry<K, V> {
+ let mut inner = {
+ let hash_code = self.hash(&key, K::hash);
+ InnerEntry {
+ pos: self.which_bucket(hash_code),
+ map: &mut self.inner,
+ hash_code,
+ key,
+ }
+ };
+
+ for dist in 0 .. inner.capacity() {
+ match inner.bucket_status() {
+ BucketStatus::Unoccupied =>
+ return Entry::Vacant(VacantEntry(inner)),
+ BucketStatus::MatchesKey =>
+ return Entry::Occupied(OccupiedEntry(inner)),
+ BucketStatus::ProbeDistance(bucket_distance) => {
+ if bucket_distance < dist {
+ return Entry::Vacant(VacantEntry(inner))
+ } else {
+ inner.pos = inner.next_bucket(inner.pos);
+ }
+ }
+ }
+ }
+
+ panic!("WeakKeyHashTable::entry: out of space");
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.drain();
+ }
+
+ fn find_bucket<Q>(&self, key: &Q) -> Option<(usize, K::Strong, HashCode)>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ if self.capacity() == 0 { return None; }
+
+ let hash_code = self.hash(key, Q::hash);
+ let mut pos = self.which_bucket(hash_code);
+
+ for dist in 0 .. self.capacity() {
+ if let Some((ref weak_key, _, bucket_hash_code)) = self.inner.buckets[pos] {
+ if bucket_hash_code == hash_code {
+ if let Some(bucket_key) = weak_key.view() {
+ if K::equals(&bucket_key, key) {
+ return Some((pos, bucket_key, bucket_hash_code));
+ }
+ }
+ }
+
+ let bucket_dist =
+ self.probe_distance(pos, self.which_bucket(bucket_hash_code));
+ if bucket_dist < dist {
+ return None;
+ }
+ } else {
+ return None;
+ }
+
+ pos = self.next_bucket(pos);
+ }
+
+ None
+ }
+
+ /// Returns a reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get<Q>(&self, key: &Q) -> Option<&V>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).and_then(move |tup|
+ self.inner.buckets[tup.0].as_ref().map(|bucket| &bucket.1))
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains_key<Q>(&self, key: &Q) -> bool
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).is_some()
+ }
+
+ /// Returns a strong reference to the key, if found.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_key<Q>(&self, key: &Q) -> Option<K::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).map(|tup| tup.1)
+ }
+
+ /// Returns a pair of a strong reference to the key, and a reference to the value, if present.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_both<Q>(&self, key: &Q) -> Option<(K::Strong, &V)>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).and_then(move |tup|
+ self.inner.buckets[tup.0].as_ref().map(|bucket| (tup.1, &bucket.1)))
+ }
+
+ /// Returns a mutable reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).and_then(move |tup|
+ self.inner.buckets[tup.0].as_mut().map(|bucket| &mut bucket.1))
+ }
+
+ /// Returns a pair of a strong reference to the key, and a mutable reference to the value,
+ /// if present.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_both_mut<Q>(&mut self, key: &Q) -> Option<(K::Strong, &mut V)>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).and_then(move |tup|
+ self.inner.buckets[tup.0].as_mut().map(|bucket| (tup.1, &mut bucket.1)))
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present.
+ ///
+ /// Unlike `std::collections::HashMap`, this replaced the key even if occupied.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: K::Strong, value: V) -> Option<V> {
+ match self.entry(key) {
+ Entry::Occupied(mut occupied) => {
+ Some(occupied.insert(value))
+ },
+ Entry::Vacant(vacant) => {
+ vacant.insert(value);
+ None
+ }
+ }
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove<Q>(&mut self, key: &Q) -> Option<V>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).map(|(pos, strong_key, hash_code)| {
+ OccupiedEntry(InnerEntry {
+ map: &mut self.inner,
+ pos,
+ key: strong_key,
+ hash_code,
+ }).remove()
+ })
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, mut f: F)
+ where F: FnMut(K::Strong, &mut V) -> bool
+ {
+ for i in 0 .. self.capacity() {
+ let remove = match self.inner.buckets[i] {
+ None => false,
+ Some(ref mut bucket) =>
+ match bucket.0.view() {
+ None => true,
+ Some(key) => !f(key, &mut bucket.1),
+ }
+ };
+
+ if remove {
+ self.inner.remove_index(i);
+ }
+ }
+ }
+
+ /// Is this map a submap of the other under the given value comparison `cmp`?
+ ///
+ /// In particular, for every key `k` of `self`,
+ ///
+ /// - `k` must also be a key of `other` and
+ /// - `cmp(self[k], other[k])` must hold.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap_with<F, S1, V1>(&self, other: &WeakKeyHashMap<K, V1, S1>,
+ mut cmp: F) -> bool
+ where F: FnMut(&V, &V1) -> bool,
+ S1: BuildHasher
+ {
+ for (key, value1) in self {
+ if let Some(value2) = K::with_key(&key, |k| other.get(k)) {
+ if !cmp(value1, value2) {
+ return false;
+ }
+ } else {
+ return false;
+ }
+ }
+
+ true
+ }
+
+ /// Is `self` a submap of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap<V1, S1>(&self, other: &WeakKeyHashMap<K, V1, S1>) -> bool
+ where V: PartialEq<V1>,
+ S1: BuildHasher
+ {
+ self.is_submap_with(other, PartialEq::eq)
+ }
+
+ /// Are the keys of `self` a subset of the keys of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn domain_is_subset<V1, S1>(&self, other: &WeakKeyHashMap<K, V1, S1>) -> bool
+ where S1: BuildHasher
+ {
+ self.is_submap_with(other, |_, _| true)
+ }
+
+ fn hash<Q, H>(&self, key: Q, hash: H) -> HashCode
+ where H: FnOnce(Q, &mut S::Hasher)
+ {
+ let hasher = &mut self.hash_builder.build_hasher();
+ hash(key, hasher);
+ HashCode(hasher.finish())
+ }
+}
+
+impl<K, V, V1, S, S1> PartialEq<WeakKeyHashMap<K, V1, S1>> for WeakKeyHashMap<K, V, S>
+ where K: WeakKey,
+ V: PartialEq<V1>,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &WeakKeyHashMap<K, V1, S1>) -> bool {
+ self.is_submap(other) && other.domain_is_subset(self)
+ }
+}
+
+impl<K: WeakKey, V: Eq, S: BuildHasher> Eq for WeakKeyHashMap<K, V, S> { }
+
+impl<K: WeakKey, V, S: BuildHasher + Default> Default for WeakKeyHashMap<K, V, S> {
+ fn default() -> Self {
+ WeakKeyHashMap::with_hasher(Default::default())
+ }
+}
+
+impl<'a, K, V, S, Q> ops::Index<&'a Q> for WeakKeyHashMap<K, V, S>
+ where K: WeakKey,
+ K::Key: Borrow<Q>,
+ S: BuildHasher,
+ Q: ?Sized + Eq + Hash
+{
+ type Output = V;
+
+ fn index(&self, index: &'a Q) -> &Self::Output {
+ self.get(index).expect("Index::index: key not found")
+ }
+}
+
+impl<'a, K, V, S, Q> ops::IndexMut<&'a Q> for WeakKeyHashMap<K, V, S>
+ where K: WeakKey,
+ K::Key: Borrow<Q>,
+ S: BuildHasher,
+ Q: ?Sized + Eq + Hash
+{
+ fn index_mut(&mut self, index: &'a Q) -> &mut Self::Output {
+ self.get_mut(index).expect("IndexMut::index_mut: key not found")
+ }
+}
+
+impl<K, V, S> iter::FromIterator<(K::Strong, V)> for WeakKeyHashMap<K, V, S>
+ where K: WeakKey,
+ S: BuildHasher + Default
+{
+ fn from_iter<T: IntoIterator<Item=(K::Strong, V)>>(iter: T) -> Self {
+ let mut result = WeakKeyHashMap::with_hasher(Default::default());
+ result.extend(iter);
+ result
+ }
+}
+
+impl<K, V, S> iter::Extend<(K::Strong, V)> for WeakKeyHashMap<K, V, S>
+ where K: WeakKey,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(K::Strong, V)>>(&mut self, iter: T) {
+ for (key, value) in iter {
+ self.insert(key, value);
+ }
+ }
+}
+
+impl<'a, K, V, S> iter::Extend<(&'a K::Strong, &'a V)> for WeakKeyHashMap<K, V, S>
+ where K: 'a + WeakKey,
+ K::Strong: Clone,
+ V: 'a + Clone,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(&'a K::Strong, &'a V)>>(&mut self, iter: T) {
+ for (key, value) in iter {
+ self.insert(key.clone(), value.clone());
+ }
+ }
+}
+
+enum BucketStatus {
+ Unoccupied,
+ MatchesKey,
+ ProbeDistance(usize),
+}
+
+impl<'a, K: WeakKey, V> InnerEntry<'a, K, V> {
+ // Gets the status of the current bucket.
+ fn bucket_status(&self) -> BucketStatus {
+ match &self.map.buckets[self.pos] {
+ Some(bucket) => {
+ if bucket.2 == self.hash_code {
+ if let Some(key) = bucket.0.view() {
+ if K::with_key(&self.key, |k| K::equals(&key, k)) {
+ return BucketStatus::MatchesKey;
+ }
+ }
+ }
+
+ let dist = self.probe_distance(self.pos,
+ self.which_bucket(bucket.2));
+ BucketStatus::ProbeDistance(dist)
+ },
+ None => BucketStatus::Unoccupied,
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V> Entry<'a, K, V> {
+ /// Ensures a value is in the entry by inserting a default value
+ /// if empty, and returns a mutable reference to the value in the
+ /// entry.
+ ///
+ /// *O*(1) time
+ pub fn or_insert(self, default: V) -> &'a mut V {
+ self.or_insert_with(|| default)
+ }
+
+ /// Ensures a value is in the entry by inserting the result of the
+ /// default function if empty, and returns a mutable reference to
+ /// the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn or_insert_with<F: FnOnce() -> V>(self, default: F) -> &'a mut V {
+ match self {
+ Entry::Occupied(occupied) => occupied.into_mut(),
+ Entry::Vacant(vacant) => vacant.insert(default()),
+ }
+ }
+
+ /// Returns a reference to this entry's key.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ match *self {
+ Entry::Occupied(ref occupied) => occupied.key(),
+ Entry::Vacant(ref vacant) => vacant.key(),
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V> OccupiedEntry<'a, K, V> {
+ /// Gets a reference to the key held by the entry.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ &self.0.key
+ }
+
+ /// Takes ownership of the key and value from the map.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove_entry(self) -> (K::Strong, V) {
+ let (_, value, _) = self.0.map.buckets[self.0.pos].take().unwrap();
+ self.0.map.remove_index(self.0.pos);
+ (self.0.key, value)
+ }
+
+ /// Gets a reference to the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get(&self) -> &V {
+ &self.0.map.buckets[self.0.pos].as_ref().unwrap().1
+ }
+
+ /// Gets a mutable reference to the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get_mut(&mut self) -> &mut V {
+ &mut self.0.map.buckets[self.0.pos].as_mut().unwrap().1
+ }
+
+ /// Turns the entry into a mutable reference to the value borrowed from the map.
+ ///
+ /// *O*(1) time
+ pub fn into_mut(self) -> &'a mut V {
+ &mut self.0.map.buckets[self.0.pos].as_mut().unwrap().1
+ }
+
+ /// Replaces the value in the entry with the given value.
+ ///
+ /// *O*(1) time
+ pub fn insert(&mut self, mut value: V) -> V {
+ self.0.map.buckets[self.0.pos].as_mut().unwrap().0 = K::new(&self.0.key);
+ mem::swap(self.get_mut(), &mut value);
+ value
+ }
+
+ /// Removes the entry, returning the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(self) -> V {
+ self.remove_entry().1
+ }
+}
+
+impl<'a, K: WeakKey, V> VacantEntry<'a, K, V> {
+ /// Gets a reference to the key that would be used when inserting a
+ /// value through the `VacantEntry`.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ &self.0.key
+ }
+
+ /// Returns ownership of the key.
+ ///
+ /// *O*(1) time
+ pub fn into_key(self) -> K::Strong {
+ self.0.key
+ }
+
+ /// Inserts the key and value into the map and return a mutable
+ /// reference to the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(self, value: V) -> &'a mut V {
+ let old_bucket = mem::replace(
+ &mut self.0.map.buckets[self.0.pos],
+ Some((K::new(&self.0.key), value, self.0.hash_code)));
+
+ if let Some(full_bucket) = old_bucket {
+ let next_bucket = self.next_bucket(self.0.pos);
+ self.0.map.steal(next_bucket, full_bucket);
+ }
+
+ self.0.map.len += 1;
+
+ &mut self.0.map.buckets[self.0.pos].as_mut().unwrap().1
+ }
+}
+
+impl<K: WeakKey, V> WeakKeyInnerMap<K, V> {
+ // Steals buckets starting at `pos`, replacing them with `bucket`.
+ fn steal(&mut self, mut pos: usize, mut bucket: FullBucket<K, V>) {
+ let mut my_dist = self.probe_distance(pos, self.which_bucket(bucket.2));
+
+ while let Some(hash_code) = self.buckets[pos].as_ref().and_then(
+ |bucket| if bucket.0.is_expired() {None} else {Some(bucket.2)}) {
+
+ let victim_dist = self.probe_distance(pos, self.which_bucket(hash_code));
+
+ if my_dist > victim_dist {
+ mem::swap(self.buckets[pos].as_mut().unwrap(), &mut bucket);
+ my_dist = victim_dist;
+ }
+
+ pos = self.next_bucket(pos);
+ my_dist += 1;
+ }
+
+ self.buckets[pos] = Some(bucket);
+ }
+
+ /// Removes the element at `dst`, shifting if necessary to preserve invariants.
+ fn remove_index(&mut self, mut dst: usize) {
+ let mut src = self.next_bucket(dst);
+
+ // We are going to remove the buckets in the range [dst, src)
+
+ loop {
+ let hash_code_option = self.buckets[src].as_ref().map(|tup| tup.2);
+
+ if let Some(hash_code) = hash_code_option {
+ let goal_pos = self.which_bucket(hash_code);
+ let dist = self.probe_distance(src, goal_pos);
+ if dist == 0 { break; }
+
+ if !self.buckets[src].as_ref().unwrap().0.is_expired() {
+ if in_interval(dst, goal_pos, src) {
+ self.erase_range(dst, goal_pos);
+ self.buckets[goal_pos] = self.buckets[src].take();
+ dst = self.next_bucket(goal_pos);
+ } else {
+ self.buckets[dst] = self.buckets[src].take();
+ dst = self.next_bucket(dst);
+ }
+ }
+ } else {
+ break;
+ }
+
+ src = self.next_bucket(src);
+ }
+
+ self.erase_range(dst, src);
+ }
+
+ /// Erases the (presumably expired, but not empty) elements in [start, limit).
+ fn erase_range(&mut self, mut start: usize, limit: usize)
+ {
+ while start != limit {
+ self.buckets[start] = None;
+ self.len -= 1;
+ start = self.next_bucket(start);
+ }
+ }
+}
+
+// Is value in [start, limit) modulo capacity?
+fn in_interval(start: usize, value: usize, limit: usize) -> bool
+{
+ if start <= limit {
+ start <= value && value < limit
+ } else {
+ start <= value || value < limit
+ }
+}
+
+// Helper trait for computing with indices modulo capacity.
+trait ModuloCapacity {
+ fn capacity(&self) -> usize;
+
+ fn probe_distance(&self, actual: usize, ideal: usize) -> usize {
+ if actual >= ideal {
+ actual - ideal
+ } else {
+ actual + self.capacity() - ideal
+ }
+ }
+
+ fn next_bucket(&self, pos: usize) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (pos + 1) % self.capacity()
+ }
+
+ fn which_bucket(&self, hash_code: HashCode) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (hash_code.0 as usize) % self.capacity()
+ }
+}
+
+impl<K, V> ModuloCapacity for WeakKeyInnerMap<K, V> {
+ fn capacity(&self) -> usize {
+ self.buckets.len()
+ }
+}
+
+impl<K, V, S> ModuloCapacity for WeakKeyHashMap<K, V, S> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V> ModuloCapacity for InnerEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.map.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V> ModuloCapacity for OccupiedEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V> ModuloCapacity for VacantEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.0.capacity()
+ }
+}
+
+impl<K, V> Debug for WeakKeyInnerMap<K, V>
+ where K: WeakElement,
+ K::Strong: Debug,
+ V: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "{{ ")?;
+ for (i, bucket) in self.buckets.iter().enumerate() {
+ if let Some((ref k, ref v, _)) = *bucket {
+ write!(f, "[{}] {:?} => {:?}, ", i, k.view(), *v)?;
+ }
+ }
+ write!(f, "}}")
+ }
+}
+
+impl<K: WeakElement, V: Debug, S> Debug for WeakKeyHashMap<K, V, S>
+ where K::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: Debug> Debug for Entry<'a, K, V>
+ where K::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ match *self {
+ Entry::Occupied(ref e) => e.fmt(f),
+ Entry::Vacant(ref e) => e.fmt(f),
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V: Debug> Debug for OccupiedEntry<'a, K, V>
+ where K::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: Debug> Debug for VacantEntry<'a, K, V>
+ where K::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.0.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: Debug> Debug for InnerEntry<'a, K, V>
+ where K::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "InnerEntry {{ pos = {}, buckets = {:?} }}", self.pos, self.map)
+ }
+}
+
+impl<K: WeakElement, V, S> IntoIterator for WeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, V);
+ type IntoIter = IntoIter<K, V>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter {
+ size: self.inner.len,
+ base: self.inner.buckets.into_vec().into_iter(),
+ }
+ }
+}
+
+impl<'a, K: WeakElement, V, S> IntoIterator for &'a WeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, &'a V);
+ type IntoIter = Iter<'a, K, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ Iter {
+ base: self.inner.buckets.iter(),
+ size: self.inner.len,
+ }
+ }
+}
+
+impl<'a, K: WeakElement, V, S> IntoIterator for &'a mut WeakKeyHashMap<K, V, S> {
+ type Item = (K::Strong, &'a mut V);
+ type IntoIter = IterMut<'a, K, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ IterMut {
+ base: self.inner.buckets.iter_mut(),
+ size: self.inner.len,
+ }
+ }
+}
+
+impl<K: WeakElement, V, S> WeakKeyHashMap<K, V, S> {
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<K, V> {
+ self.into_iter()
+ }
+
+ /// Gets an iterator over the keys.
+ ///
+ /// *O*(1) time
+ pub fn keys(&self) -> Keys<K, V> {
+ Keys(self.iter())
+ }
+
+ /// Gets an iterator over the values.
+ ///
+ /// *O*(1) time
+ pub fn values(&self) -> Values<K, V> {
+ Values(self.iter())
+ }
+
+ /// Gets an iterator over the keys and mutable values.
+ ///
+ /// *O*(1) time
+ pub fn iter_mut(&mut self) -> IterMut<K, V> {
+ self.into_iter()
+ }
+
+ /// Gets an iterator over the mutable values.
+ ///
+ /// *O*(1) time
+ pub fn values_mut(&mut self) -> ValuesMut<K, V> {
+ ValuesMut(self.iter_mut())
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<K, V> {
+ let old_len = self.inner.len;
+ self.inner.len = 0;
+ Drain {
+ base: self.inner.buckets.iter_mut(),
+ size: old_len,
+ }
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use crate::compat::{
+ eprintln,
+ rc::{Rc, Weak},
+ String,
+ Vec,
+ };
+ use super::{Entry, WeakKeyHashMap};
+
+ #[test]
+ fn simple() {
+ let mut map: WeakKeyHashMap<Weak<str>, usize> = WeakKeyHashMap::new();
+ assert_eq!( map.len(), 0 );
+ assert!( !map.contains_key("five") );
+
+ let five: Rc<str> = Rc::from(String::from("five"));
+ map.insert(five.clone(), 5);
+
+ assert_eq!( map.len(), 1 );
+ assert!( map.contains_key("five") );
+
+ drop(five);
+
+ assert_eq!( map.len(), 1 );
+ assert!( !map.contains_key("five") );
+
+ map.remove_expired();
+
+ assert_eq!( map.len(), 0 );
+ assert!( !map.contains_key("five") );
+ }
+
+ // From https://github.com/tov/weak-table-rs/issues/1#issuecomment-461858060
+ #[test]
+ fn insert_and_check() {
+ let mut rcs: Vec<Rc<u32>> = Vec::new();
+
+ for i in 0 .. 50 {
+ rcs.push(Rc::new(i));
+ }
+
+ let mut weakmap: WeakKeyHashMap<Weak<u32>, f32> = WeakKeyHashMap::new();
+
+ for key in rcs.iter().cloned() {
+ let f = *key as f32 + 0.1;
+ weakmap.insert(key, f);
+ }
+
+ let mut count = 0;
+
+ for key in &rcs {
+ assert_eq!(weakmap.get(key), Some(&(**key as f32 + 0.1)));
+
+ match weakmap.entry(Rc::clone(key)) {
+ Entry::Occupied(_) => count += 1,
+ Entry::Vacant(_) => eprintln!("WeakKeyHashMap: missing: {}", *key),
+ }
+ }
+
+ assert_eq!( count, rcs.len() );
+ }
+}
diff --git a/crates/weak-table/src/weak_value_hash_map.rs b/crates/weak-table/src/weak_value_hash_map.rs
new file mode 100644
index 0000000..7177e41
--- /dev/null
+++ b/crates/weak-table/src/weak_value_hash_map.rs
@@ -0,0 +1,965 @@
+//! A hash map where the values are held by weak pointers.
+
+use super::*;
+use super::size_policy::*;
+use super::traits::*;
+use super::util::*;
+
+pub use super::WeakValueHashMap;
+
+/// Represents an entry in the table which may be occupied or vacant.
+pub enum Entry<'a, K: 'a, V: 'a + WeakElement> {
+ Occupied(OccupiedEntry<'a, K, V>),
+ Vacant(VacantEntry<'a, K, V>),
+}
+
+/// An occupied entry, which can be removed or viewed.
+pub struct OccupiedEntry<'a, K: 'a, V: 'a + WeakElement> {
+ inner: InnerEntry<'a, K, V>,
+ value: V::Strong,
+}
+
+/// A vacant entry, which can be inserted in or viewed.
+pub struct VacantEntry<'a, K: 'a, V: 'a + WeakElement> {
+ inner: InnerEntry<'a, K, V>,
+}
+
+struct InnerEntry<'a, K: 'a, V: 'a + WeakElement> {
+ map: &'a mut WeakValueInnerMap<K, V>,
+ pos: usize,
+ key: K,
+ hash_code: HashCode,
+}
+
+/// An iterator over the keys and values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Iter<'a, K: 'a, V: 'a> {
+ base: slice::Iter<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K, V: WeakElement> Iterator for Iter<'a, K, V> {
+ type Item = (&'a K, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((ref key, ref weak_value, _)) = *bucket {
+ self.size -= 1;
+ if let Some(value) = weak_value.view() {
+ return Some((key, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+/// An iterator over the keys of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Keys<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K, V: WeakElement> Iterator for Keys<'a, K, V> {
+ type Item = &'a K;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(k, _)| k)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// An iterator over the values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Values<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K, V: WeakElement> Iterator for Values<'a, K, V> {
+ type Item = V::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(_, v)| v)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+#[derive(Debug)]
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct Drain<'a, K: 'a, V: 'a> {
+ base: slice::IterMut<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K, V: WeakElement> Iterator for Drain<'a, K, V> {
+ type Item = (K, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((key, weak_value, _)) = bucket.take() {
+ self.size -= 1;
+ if let Some(value) = weak_value.view() {
+ return Some((key, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<'a, K, V> Drop for Drain<'a, K, V> {
+ fn drop(&mut self) {
+ for option in &mut self.base {
+ *option = None;
+ }
+ }
+}
+
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct IntoIter<K, V> {
+ base: vec::IntoIter<Bucket<K, V>>,
+ size: usize,
+}
+
+impl<K, V: WeakElement> Iterator for IntoIter<K, V> {
+ type Item = (K, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for (key, weak_value, _) in (&mut self.base).flatten() {
+ self.size -= 1;
+ if let Some(value) = weak_value.view() {
+ return Some((key, value));
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<K: Eq + Hash, V: WeakElement> WeakValueHashMap<K, V, RandomState>
+{
+ /// Creates an empty `WeakValueHashMap`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ Self::with_capacity(DEFAULT_INITIAL_CAPACITY)
+ }
+
+ /// Creates an empty `WeakValueHashMap` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ Self::with_capacity_and_hasher(capacity, Default::default())
+ }
+}
+
+impl<K: Eq + Hash, V: WeakElement, S: BuildHasher> WeakValueHashMap<K, V, S>
+{
+ /// Creates an empty `WeakValueHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ Self::with_capacity_and_hasher(DEFAULT_INITIAL_CAPACITY, hash_builder)
+ }
+
+ /// Creates an empty `WeakValueHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ WeakValueHashMap {
+ hash_builder,
+ inner: WeakValueInnerMap {
+ buckets: new_boxed_option_slice(capacity),
+ len: 0,
+ }
+ }
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ &self.hash_builder
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+
+ /// This has some preconditions.
+ fn resize(&mut self, capacity: usize) {
+ let old_buckets = mem::replace(&mut self.inner.buckets,
+ new_boxed_option_slice(capacity));
+
+ let iter = IntoIter {
+ base: old_buckets.into_vec().into_iter(),
+ size: self.inner.len,
+ };
+
+ self.inner.len = 0;
+
+ for (key, value) in iter {
+ self.entry_no_grow(key).or_insert(value);
+ }
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.retain(|_, _| true)
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ let new_capacity = additional_capacity + self.capacity();
+ self.resize(new_capacity);
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.remove_expired();
+ let new_capacity = (self.len() as f32 / COLLECT_LOAD_FACTOR).ceil() as usize;
+ self.resize(new_capacity);
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.inner.len
+ }
+
+ /// Is the map empty?
+ ///
+ /// Note that this may return false even if all keys in the map have
+ /// expired, if they haven't been collected yet.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired keys.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ (self.len() as f32 + 1.0) / self.capacity() as f32
+ }
+
+ fn maybe_adjust_size(&mut self) {
+ if self.load_factor() > COLLECT_LOAD_FACTOR {
+ self.remove_expired();
+
+ let load_factor = self.load_factor();
+ let capacity = self.capacity();
+ if load_factor > GROW_LOAD_FACTOR {
+ self.resize(max(1, capacity * 2));
+ } else if load_factor < SHRINK_LOAD_FACTOR && capacity > DEFAULT_INITIAL_CAPACITY {
+ self.resize(max(1, capacity / 2));
+ }
+ }
+ }
+
+ /// Gets the requested entry.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn entry(&mut self, key: K) -> Entry<K, V> {
+ self.maybe_adjust_size();
+ self.entry_no_grow(key)
+ }
+
+ fn entry_no_grow(&mut self, key: K) -> Entry<K, V> {
+ let mut inner = {
+ let hash_code = self.hash(&key);
+ InnerEntry {
+ pos: self.which_bucket(hash_code),
+ map: &mut self.inner,
+ hash_code,
+ key,
+ }
+ };
+
+ for dist in 0 .. inner.capacity() {
+ match inner.bucket_status() {
+ BucketStatus::Unoccupied =>
+ return Entry::Vacant(VacantEntry {inner}),
+ BucketStatus::MatchesKey(value) => {
+ return Entry::Occupied(OccupiedEntry {inner, value})
+ }
+ BucketStatus::ProbeDistance(bucket_distance) => {
+ if bucket_distance < dist {
+ return Entry::Vacant(VacantEntry {inner})
+ } else {
+ inner.pos = inner.next_bucket(inner.pos);
+ }
+ }
+ }
+ }
+
+ panic!("WeakValueHashTable::entry: out of space");
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.drain();
+ }
+
+ fn find_bucket<Q>(&self, key: &Q) -> Option<(usize, V::Strong)>
+ where Q: ?Sized + Hash + Eq,
+ K: Borrow<Q>
+ {
+ if self.capacity() == 0 { return None; }
+
+ let hash_code = self.hash(key);
+ let mut pos = self.which_bucket(hash_code);
+
+ for dist in 0 .. self.capacity() {
+ if let Some((ref bucket_key, ref weak_value, bucket_hash_code)) = self.inner.buckets[pos] {
+ if bucket_hash_code == hash_code {
+ if let Some(value) = weak_value.view() {
+ if bucket_key.borrow() == key {
+ return Some((pos, value));
+ }
+ }
+ }
+
+ let bucket_dist =
+ self.probe_distance(pos, self.which_bucket(hash_code));
+ if bucket_dist < dist {
+ return None;
+ }
+ } else {
+ return None;
+ }
+
+ pos = self.next_bucket(pos);
+ }
+
+ None
+ }
+
+ /// Returns a reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get<Q>(&self, key: &Q) -> Option<V::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K: Borrow<Q>
+ {
+ self.find_bucket(key).map(|tup| tup.1)
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains_key<Q>(&self, key: &Q) -> bool
+ where Q: ?Sized + Hash + Eq,
+ K: Borrow<Q>
+ {
+ self.find_bucket(key).is_some()
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present.
+ ///
+ /// Like `std::collections::HashMap`, this does not replace the key if occupied.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: K, value: V::Strong) -> Option<V::Strong> {
+ match self.entry(key) {
+ Entry::Occupied(mut occupied) => {
+ Some(occupied.insert(value))
+ },
+ Entry::Vacant(vacant) => {
+ vacant.insert(value);
+ None
+ }
+ }
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove<Q>(&mut self, key: &Q) -> Option<V::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K: Borrow<Q>
+ {
+ if let Some((pos, value)) = self.find_bucket(key) {
+ self.inner.remove_index(pos);
+ Some(value)
+ } else {
+ None
+ }
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, mut f: F)
+ where F: FnMut(&K, V::Strong) -> bool
+ {
+ for i in 0 .. self.capacity() {
+ let remove = match self.inner.buckets[i] {
+ None => false,
+ Some(ref mut bucket) =>
+ match bucket.1.view() {
+ None => true,
+ Some(value) => !f(&bucket.0, value),
+ }
+ };
+
+ if remove {
+ self.inner.remove_index(i);
+ }
+ }
+ }
+
+ /// Is this map a submap of the other, using the given value comparison.
+ ///
+ /// In particular, all the keys of `self` must be in `other` and the values must compare
+ /// `true` with `value_equal`.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap_with<F, S1, V1>(&self, other: &WeakValueHashMap<K, V1, S1>,
+ mut value_equal: F) -> bool
+ where V1: WeakElement,
+ F: FnMut(V::Strong, V1::Strong) -> bool,
+ S1: BuildHasher
+ {
+ for (key, value1) in self {
+ if let Some(value2) = other.get(key) {
+ if !value_equal(value1, value2) {
+ return false;
+ }
+ } else {
+ return false;
+ }
+ }
+
+ true
+ }
+
+ /// Is `self` a submap of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap<V1, S1>(&self, other: &WeakValueHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S1: BuildHasher
+ {
+ self.is_submap_with(other, |v, v1| v == v1)
+ }
+
+ /// Are the keys of `self` a subset of the keys of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn domain_is_subset<V1, S1>(&self, other: &WeakValueHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ S1: BuildHasher
+ {
+ self.is_submap_with(other, |_, _| true)
+ }
+
+ fn hash<Q>(&self, key: &Q) -> HashCode
+ where Q: ?Sized + Hash,
+ K: Borrow<Q>
+ {
+ let mut hasher = self.hash_builder.build_hasher();
+ key.hash(&mut hasher);
+ HashCode(hasher.finish())
+ }
+}
+
+impl<K, V, V1, S, S1> PartialEq<WeakValueHashMap<K, V1, S1>> for WeakValueHashMap<K, V, S>
+ where K: Eq + Hash,
+ V: WeakElement,
+ V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &WeakValueHashMap<K, V1, S1>) -> bool {
+ self.is_submap(other) && other.domain_is_subset(self)
+ }
+}
+
+impl<K: Eq + Hash, V: WeakElement, S: BuildHasher> Eq for WeakValueHashMap<K, V, S>
+ where V::Strong: Eq
+{ }
+
+impl<K: Eq + Hash, V: WeakElement, S: BuildHasher + Default> Default for WeakValueHashMap<K, V, S> {
+ fn default() -> Self {
+ WeakValueHashMap::with_hasher(Default::default())
+ }
+}
+
+impl<K, V, S> iter::FromIterator<(K, V::Strong)> for WeakValueHashMap<K, V, S>
+ where K: Eq + Hash,
+ V: WeakElement,
+ S: BuildHasher + Default
+{
+ fn from_iter<T: IntoIterator<Item=(K, V::Strong)>>(iter: T) -> Self {
+ let mut result = WeakValueHashMap::with_hasher(Default::default());
+ result.extend(iter);
+ result
+ }
+}
+
+impl<K, V, S> Extend<(K, V::Strong)> for WeakValueHashMap<K, V, S>
+ where K: Eq + Hash,
+ V: WeakElement,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(K, V::Strong)>>(&mut self, iter: T) {
+ for (key, value) in iter {
+ self.insert(key, value);
+ }
+ }
+}
+
+impl<'a, K, V, S> Extend<(&'a K, &'a V::Strong)> for WeakValueHashMap<K, V, S>
+ where K: 'a + Eq + Hash + Clone,
+ V: 'a + WeakElement,
+ V::Strong: Clone,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(&'a K, &'a V::Strong)>>(&mut self, iter: T) {
+ for (key, value) in iter {
+ self.insert(key.clone(), value.clone());
+ }
+ }
+}
+
+enum BucketStatus<V: WeakElement> {
+ Unoccupied,
+ MatchesKey(V::Strong),
+ ProbeDistance(usize),
+}
+
+impl<'a, K: Eq + Hash, V: WeakElement> InnerEntry<'a, K, V> {
+ // Gets the status of the current bucket.
+ fn bucket_status(&self) -> BucketStatus<V> {
+ match &self.map.buckets[self.pos] {
+ Some(bucket) => {
+ if bucket.2 == self.hash_code {
+ if let Some(value) = bucket.1.view() {
+ if self.key == bucket.0 {
+ return BucketStatus::MatchesKey(value);
+ }
+ }
+ }
+
+ let dist = self.probe_distance(self.pos,
+ self.which_bucket(bucket.2));
+ BucketStatus::ProbeDistance(dist)
+ },
+ None => BucketStatus::Unoccupied,
+ }
+ }
+}
+
+impl<'a, K, V: WeakElement> Entry<'a, K, V> {
+ /// Ensures a value is in the entry by inserting a default value
+ /// if empty.
+ ///
+ /// *O*(1) time
+ pub fn or_insert(self, default: V::Strong) -> V::Strong {
+ self.or_insert_with(|| default)
+ }
+
+ /// Ensures a value is in the entry by inserting the result of the
+ /// default function if empty.
+ ///
+ /// *O*(1) time
+ pub fn or_insert_with<F: FnOnce() -> V::Strong>(self, default: F) -> V::Strong {
+ match self {
+ Entry::Occupied(occupied) => occupied.get_strong(),
+ Entry::Vacant(vacant) => vacant.insert(default()),
+ }
+ }
+
+ /// Returns a reference to this entry's key.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K {
+ match *self {
+ Entry::Occupied(ref occupied) => occupied.key(),
+ Entry::Vacant(ref vacant) => vacant.key(),
+ }
+ }
+}
+
+impl<'a, K, V: WeakElement> OccupiedEntry<'a, K, V> {
+ /// Gets a reference to the key held by the entry.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K {
+ &self.inner.key
+ }
+
+ /// Takes ownership of the key and value from the map.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove_entry(self) -> (K, V::Strong) {
+ let (key, w_value, _) = self.inner.map.buckets[self.inner.pos].take().unwrap();
+ let value = w_value.view().unwrap();
+ self.inner.map.remove_index(self.inner.pos);
+ (key, value)
+ }
+
+ /// Gets a reference to the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get(&self) -> &V::Strong {
+ &self.value
+ }
+
+ /// Gets a copy of the strong value reference stored in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get_strong(&self) -> V::Strong {
+ V::clone(&self.value)
+ }
+
+ /// Replaces the value in the entry with the given value, returning the old value.
+ ///
+ /// *O*(1) time
+ pub fn insert(&mut self, value: V::Strong) -> V::Strong {
+ self.inner.map.buckets[self.inner.pos].as_mut().unwrap().1 = V::new(&value);
+ mem::replace(&mut self.value, value)
+ }
+
+ /// Removes the entry, returning the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(self) -> V::Strong {
+ self.remove_entry().1
+ }
+}
+
+impl<'a, K, V: WeakElement> VacantEntry<'a, K, V> {
+ /// Gets a reference to the key that would be used when inserting a
+ /// value through the `VacantEntry`.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K {
+ &self.inner.key
+ }
+
+ /// Returns ownership of the key.
+ ///
+ /// *O*(1) time
+ pub fn into_key(self) -> K {
+ self.inner.key
+ }
+
+ /// Inserts the value into the map, returning the same value.
+ ///
+ /// *O*(1) time
+ pub fn insert(self, value: V::Strong) -> V::Strong {
+ let InnerEntry { map, key, hash_code, pos } = self.inner;
+
+ let old_bucket = mem::replace(
+ &mut map.buckets[pos],
+ Some((key, V::new(&value), hash_code)));
+
+ if let Some(full_bucket) = old_bucket {
+ let next_bucket = map.next_bucket(pos);
+ map.steal(next_bucket, full_bucket);
+ }
+
+ map.len += 1;
+
+ value
+ }
+}
+
+impl<K, V: WeakElement> WeakValueInnerMap<K, V> {
+ // Steals buckets starting at `pos`, replacing them with `bucket`.
+ fn steal(&mut self, mut pos: usize, mut bucket: FullBucket<K, V>) {
+ let mut my_dist = self.probe_distance(pos, self.which_bucket(bucket.2));
+
+ while let Some(hash_code) = self.buckets[pos].as_ref().and_then(
+ |bucket| if bucket.1.is_expired() {None} else {Some(bucket.2)}) {
+
+ let victim_dist = self.probe_distance(pos, self.which_bucket(hash_code));
+
+ if my_dist > victim_dist {
+ mem::swap(self.buckets[pos].as_mut().unwrap(), &mut bucket);
+ my_dist = victim_dist;
+ }
+
+ pos = self.next_bucket(pos);
+ my_dist += 1;
+ }
+
+ self.buckets[pos] = Some(bucket);
+ }
+
+ /// Removes the element at `dst`, shifting if necessary to preserve invariants.
+ fn remove_index(&mut self, mut dst: usize) {
+ let mut src = self.next_bucket(dst);
+
+ // We are going to remove the buckets in the range [dst, src)
+
+ loop {
+ let hash_code_option = self.buckets[src].as_ref().map(|tup| tup.2);
+
+ if let Some(hash_code) = hash_code_option {
+ let goal_pos = self.which_bucket(hash_code);
+ let dist = self.probe_distance(src, goal_pos);
+ if dist == 0 { break; }
+
+ if !self.buckets[src].as_ref().unwrap().1.is_expired() {
+ if in_interval(dst, goal_pos, src) {
+ self.erase_range(dst, goal_pos);
+ self.buckets[goal_pos] = self.buckets[src].take();
+ dst = self.next_bucket(goal_pos);
+ } else {
+ self.buckets[dst] = self.buckets[src].take();
+ dst = self.next_bucket(dst);
+ }
+ }
+ } else {
+ break;
+ }
+
+ src = self.next_bucket(src);
+ }
+
+ self.erase_range(dst, src);
+ }
+
+ /// Erases the (presumably expired, but not empty) elements in [start, limit).
+ fn erase_range(&mut self, mut start: usize, limit: usize)
+ {
+ while start != limit {
+ self.buckets[start] = None;
+ self.len -= 1;
+ start = self.next_bucket(start);
+ }
+ }
+}
+
+// Is value in [start, limit) modulo capacity?
+fn in_interval(start: usize, value: usize, limit: usize) -> bool
+{
+ if start <= limit {
+ start <= value && value < limit
+ } else {
+ start <= value || value < limit
+ }
+}
+
+// Helper trait for computing with indices modulo capacity.
+trait ModuloCapacity {
+ fn capacity(&self) -> usize;
+
+ fn probe_distance(&self, actual: usize, ideal: usize) -> usize {
+ if actual >= ideal {
+ actual - ideal
+ } else {
+ actual + self.capacity() - ideal
+ }
+ }
+
+ fn next_bucket(&self, pos: usize) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (pos + 1) % self.capacity()
+ }
+
+ fn which_bucket(&self, hash_code: HashCode) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (hash_code.0 as usize) % self.capacity()
+ }
+}
+
+impl<K, V> ModuloCapacity for WeakValueInnerMap<K, V> {
+ fn capacity(&self) -> usize {
+ self.buckets.len()
+ }
+}
+
+impl<K, V, S> ModuloCapacity for WeakValueHashMap<K, V, S> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<'a, K, V: WeakElement> ModuloCapacity for InnerEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.map.capacity()
+ }
+}
+
+impl<'a, K, V: WeakElement> ModuloCapacity for OccupiedEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<'a, K, V: WeakElement> ModuloCapacity for VacantEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<K, V> Debug for WeakValueInnerMap<K, V>
+ where K: Debug,
+ V: WeakElement,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "{{ ")?;
+ for (i, bucket) in self.buckets.iter().enumerate() {
+ if let Some((k, v, _)) = bucket {
+ write!(f, "[{}] {:?} => {:?}, ", i, *k, v.view())?;
+ }
+ }
+ write!(f, "}}")
+ }
+}
+
+impl<K: Debug, V: WeakElement, S> Debug for WeakValueHashMap<K, V, S>
+ where V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: Debug, V: WeakElement> Debug for Entry<'a, K, V>
+ where V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ match *self {
+ Entry::Occupied(ref e) => e.fmt(f),
+ Entry::Vacant(ref e) => e.fmt(f),
+ }
+ }
+}
+
+impl<'a, K: Debug, V: WeakElement> Debug for OccupiedEntry<'a, K, V>
+ where V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: Debug, V: WeakElement> Debug for VacantEntry<'a, K, V>
+ where V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: Debug, V: WeakElement> Debug for InnerEntry<'a, K, V>
+ where V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "InnerEntry {{ pos = {}, buckets = {:?} }}", self.pos, self.map)
+ }
+}
+
+impl<K, V: WeakElement, S> IntoIterator for WeakValueHashMap<K, V, S> {
+ type Item = (K, V::Strong);
+ type IntoIter = IntoIter<K, V>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter {
+ size: self.inner.len,
+ base: self.inner.buckets.into_vec().into_iter(),
+ }
+ }
+}
+
+impl<'a, K, V: WeakElement, S> IntoIterator for &'a WeakValueHashMap<K, V, S> {
+ type Item = (&'a K, V::Strong);
+ type IntoIter = Iter<'a, K, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ Iter {
+ base: self.inner.buckets.iter(),
+ size: self.inner.len,
+ }
+ }
+}
+
+impl<K, V: WeakElement, S> WeakValueHashMap<K, V, S> {
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<K, V> {
+ self.into_iter()
+ }
+
+ /// Gets an iterator over the keys.
+ ///
+ /// *O*(1) time
+ pub fn keys(&self) -> Keys<K, V> {
+ Keys(self.iter())
+ }
+
+ /// Gets an iterator over the values.
+ ///
+ /// *O*(1) time
+ pub fn values(&self) -> Values<K, V> {
+ Values(self.iter())
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<K, V> {
+ let old_len = self.inner.len;
+ self.inner.len = 0;
+ Drain {
+ base: self.inner.buckets.iter_mut(),
+ size: old_len,
+ }
+ }
+}
+
+
diff --git a/crates/weak-table/src/weak_weak_hash_map.rs b/crates/weak-table/src/weak_weak_hash_map.rs
new file mode 100644
index 0000000..801bc64
--- /dev/null
+++ b/crates/weak-table/src/weak_weak_hash_map.rs
@@ -0,0 +1,986 @@
+//! A hash map where the keys and values are both held by weak pointers, and keys are compared by
+//! value.
+
+use super::*;
+use super::size_policy::*;
+use super::traits::*;
+use super::util::*;
+
+pub use super::WeakWeakHashMap;
+
+/// Represents an entry in the table which may be occupied or vacant.
+pub enum Entry<'a, K: 'a + WeakKey, V: 'a + WeakElement> {
+ Occupied(OccupiedEntry<'a, K, V>),
+ Vacant(VacantEntry<'a, K, V>),
+}
+
+/// An occupied entry, which can be removed or viewed.
+pub struct OccupiedEntry<'a, K: 'a + WeakKey, V: 'a + WeakElement> {
+ inner: InnerEntry<'a, K, V>,
+ value: V::Strong,
+}
+
+/// A vacant entry, which can be inserted in or viewed.
+pub struct VacantEntry<'a, K: 'a + WeakKey, V: 'a + WeakElement> {
+ inner: InnerEntry<'a, K, V>,
+}
+
+struct InnerEntry<'a, K: 'a + WeakKey, V: 'a> {
+ map: &'a mut WeakWeakInnerMap<K, V>,
+ pos: usize,
+ key: K::Strong,
+ hash_code: HashCode,
+}
+
+/// An iterator over the keys and values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Iter<'a, K: 'a, V: 'a> {
+ base: slice::Iter<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K: WeakElement, V: WeakElement> Iterator for Iter<'a, K, V> {
+ type Item = (K::Strong, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((ref weak_key, ref weak_value, _)) = *bucket {
+ self.size -= 1;
+ if let (Some(key), Some(value)) = (weak_key.view(), weak_value.view()) {
+ return Some((key, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+/// An iterator over the keys of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Keys<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K: WeakElement, V: WeakElement> Iterator for Keys<'a, K, V> {
+ type Item = K::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(k, _)| k)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+/// An iterator over the values of the weak hash map.
+#[derive(Clone, Debug)]
+pub struct Values<'a, K: 'a, V: 'a>(Iter<'a, K, V>);
+
+impl<'a, K: WeakElement, V: WeakElement> Iterator for Values<'a, K, V> {
+ type Item = V::Strong;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ self.0.next().map(|(_, v)| v)
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ self.0.size_hint()
+ }
+}
+
+#[derive(Debug)]
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct Drain<'a, K: 'a, V: 'a> {
+ base: slice::IterMut<'a, Bucket<K, V>>,
+ size: usize,
+}
+
+impl<'a, K: WeakElement, V: WeakElement> Iterator for Drain<'a, K, V> {
+ type Item = (K::Strong, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for bucket in &mut self.base {
+ if let Some((weak_key, weak_value, _)) = bucket.take() {
+ self.size -= 1;
+ if let (Some(key), Some(value)) = (weak_key.view(), weak_value.view()) {
+ return Some((key, value));
+ }
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<'a, K, V> Drop for Drain<'a, K, V> {
+ fn drop(&mut self) {
+ for option in &mut self.base {
+ *option = None;
+ }
+ }
+}
+
+/// An iterator that consumes the values of a weak hash map, leaving it empty.
+pub struct IntoIter<K, V> {
+ base: vec::IntoIter<Bucket<K, V>>,
+ size: usize,
+}
+
+impl<K: WeakElement, V: WeakElement> Iterator for IntoIter<K, V> {
+ type Item = (K::Strong, V::Strong);
+
+ fn next(&mut self) -> Option<Self::Item> {
+ for (weak_key, weak_value, _) in (&mut self.base).flatten() {
+ self.size -= 1;
+ if let (Some(key), Some(value)) = (weak_key.view(), weak_value.view()) {
+ return Some((key, value));
+ }
+ }
+
+ None
+ }
+
+ fn size_hint(&self) -> (usize, Option<usize>) {
+ (0, Some(self.size))
+ }
+}
+
+impl<K: WeakKey, V: WeakElement> WeakWeakHashMap<K, V, RandomState>
+{
+ /// Creates an empty `WeakWeakHashMap`.
+ ///
+ /// *O*(1) time
+ pub fn new() -> Self {
+ Self::with_capacity(DEFAULT_INITIAL_CAPACITY)
+ }
+
+ /// Creates an empty `WeakWeakHashMap` with the given capacity.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity(capacity: usize) -> Self {
+ Self::with_capacity_and_hasher(capacity, Default::default())
+ }
+}
+
+impl<K: WeakKey, V: WeakElement, S: BuildHasher> WeakWeakHashMap<K, V, S> {
+ /// Creates an empty `WeakWeakHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_hasher(hash_builder: S) -> Self {
+ Self::with_capacity_and_hasher(DEFAULT_INITIAL_CAPACITY, hash_builder)
+ }
+
+ /// Creates an empty `WeakWeakHashMap` with the given capacity and hasher.
+ ///
+ /// *O*(*n*) time
+ pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self {
+ WeakWeakHashMap {
+ hash_builder,
+ inner: WeakWeakInnerMap {
+ buckets: new_boxed_option_slice(capacity),
+ len: 0,
+ }
+ }
+ }
+
+ /// Returns a reference to the map's `BuildHasher`.
+ ///
+ /// *O*(1) time
+ pub fn hasher(&self) -> &S {
+ &self.hash_builder
+ }
+
+ /// Returns the number of elements the map can hold without reallocating.
+ ///
+ /// *O*(1) time
+ pub fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+
+ /// This has some preconditions.
+ fn resize(&mut self, capacity: usize) {
+ let old_buckets = mem::replace(&mut self.inner.buckets,
+ new_boxed_option_slice(capacity));
+
+ let iter = IntoIter {
+ base: old_buckets.into_vec().into_iter(),
+ size: self.inner.len,
+ };
+
+ self.inner.len = 0;
+
+ for (key, value) in iter {
+ self.entry_no_grow(key).or_insert(value);
+ }
+ }
+
+ /// Removes all mappings whose keys have expired.
+ ///
+ /// *O*(*n*) time
+ pub fn remove_expired(&mut self) {
+ self.retain(|_, _| true)
+ }
+
+ /// Reserves room for additional elements.
+ ///
+ /// *O*(*n*) time
+ pub fn reserve(&mut self, additional_capacity: usize) {
+ let new_capacity = additional_capacity + self.capacity();
+ self.resize(new_capacity);
+ }
+
+ /// Shrinks the capacity to the minimum allowed to hold the current number of elements.
+ ///
+ /// *O*(*n*) time
+ pub fn shrink_to_fit(&mut self) {
+ self.remove_expired();
+ let new_capacity = (self.len() as f32 / COLLECT_LOAD_FACTOR).ceil() as usize;
+ self.resize(new_capacity);
+ }
+
+ /// Returns an over-approximation of the number of elements.
+ ///
+ /// *O*(1) time
+ pub fn len(&self) -> usize {
+ self.inner.len
+ }
+
+ /// Is the map empty?
+ ///
+ /// Note that this may return false even if all keys in the map have
+ /// expired, if they haven't been collected yet.
+ ///
+ /// *O*(1) time
+ pub fn is_empty(&self) -> bool {
+ self.len() == 0
+ }
+
+ /// The proportion of buckets that are used.
+ ///
+ /// This is an over-approximation because of expired keys.
+ ///
+ /// *O*(1) time
+ pub fn load_factor(&self) -> f32 {
+ (self.len() as f32 + 1.0) / self.capacity() as f32
+ }
+
+ fn maybe_adjust_size(&mut self) {
+ if self.load_factor() > COLLECT_LOAD_FACTOR {
+ self.remove_expired();
+
+ let load_factor = self.load_factor();
+ let capacity = self.capacity();
+ if load_factor > GROW_LOAD_FACTOR {
+ self.resize(max(1, capacity * 2));
+ } else if load_factor < SHRINK_LOAD_FACTOR && capacity > DEFAULT_INITIAL_CAPACITY {
+ self.resize(max(1, capacity / 2));
+ }
+ }
+ }
+
+ /// Gets the requested entry.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn entry(&mut self, key: K::Strong) -> Entry<K, V> {
+ self.maybe_adjust_size();
+ self.entry_no_grow(key)
+ }
+
+ fn entry_no_grow(&mut self, key: K::Strong) -> Entry<K, V> {
+ let mut inner = {
+ let hash_code = self.hash(&key, K::hash);
+ InnerEntry {
+ pos: self.which_bucket(hash_code),
+ map: &mut self.inner,
+ hash_code,
+ key,
+ }
+ };
+
+ for dist in 0 .. inner.capacity() {
+ match inner.bucket_status() {
+ BucketStatus::Unoccupied =>
+ return Entry::Vacant(VacantEntry {inner}),
+ BucketStatus::MatchesKey(value) =>
+ return Entry::Occupied(OccupiedEntry {value, inner}),
+ BucketStatus::ProbeDistance(bucket_distance) => {
+ if bucket_distance < dist {
+ return Entry::Vacant(VacantEntry {inner})
+ } else {
+ inner.pos = inner.next_bucket(inner.pos);
+ }
+ }
+ }
+ }
+
+ panic!("WeakKeyHashTable::entry: out of space");
+ }
+
+ /// Removes all associations from the map.
+ ///
+ /// *O*(*n*) time
+ pub fn clear(&mut self) {
+ self.drain();
+ }
+
+ fn find_bucket<Q>(&self, key: &Q) -> Option<(usize, K::Strong, V::Strong)>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ if self.capacity() == 0 { return None; }
+
+ let hash_code = self.hash(key, Q::hash);
+ let mut pos = self.which_bucket(hash_code);
+
+ for dist in 0 .. self.capacity() {
+ if let Some((ref w_key, ref w_value, b_hash_code)) = self.inner.buckets[pos] {
+ if b_hash_code == hash_code {
+ if let (Some(b_key), Some(b_value)) = (w_key.view(), w_value.view()) {
+ if K::equals(&b_key, key) {
+ return Some((pos, b_key, b_value));
+ }
+ }
+ }
+
+ let bucket_dist =
+ self.probe_distance(pos, self.which_bucket(hash_code));
+ if bucket_dist < dist {
+ return None;
+ }
+ } else {
+ return None;
+ }
+
+ pos = self.next_bucket(pos);
+ }
+
+ None
+ }
+
+ /// Returns a reference to the value corresponding to the key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get<Q>(&self, key: &Q) -> Option<V::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).map(|tup| tup.2)
+ }
+
+ /// Returns the strong reference to the key, if present.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_key<Q>(&self, key: &Q) -> Option<K::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).map(|tup| tup.1)
+ }
+
+ /// Returns strong references to both the key and the value, if present.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn get_both<Q>(&self, key: &Q) -> Option<(K::Strong, V::Strong)>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).map(|tup| (tup.1, tup.2))
+ }
+
+ /// Returns true if the map contains the specified key.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn contains_key<Q>(&self, key: &Q) -> bool
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ self.find_bucket(key).is_some()
+ }
+
+ /// Unconditionally inserts the value, returning the old value if already present.
+ ///
+ /// Unlike `std::collections::HashMap`, this replaces the key even if occupied.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn insert(&mut self, key: K::Strong, value: V::Strong) -> Option<V::Strong> {
+ match self.entry(key) {
+ Entry::Occupied(mut occupied) => {
+ Some(occupied.insert(value))
+ },
+ Entry::Vacant(vacant) => {
+ vacant.insert(value);
+ None
+ }
+ }
+ }
+
+ /// Removes the entry with the given key, if it exists, and returns the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove<Q>(&mut self, key: &Q) -> Option<V::Strong>
+ where Q: ?Sized + Hash + Eq,
+ K::Key: Borrow<Q>
+ {
+ if let Some((pos, _, value)) = self.find_bucket(key) {
+ self.inner.remove_index(pos);
+ Some(value)
+ } else {
+ None
+ }
+ }
+
+ /// Removes all mappings not satisfying the given predicate.
+ ///
+ /// Also removes any expired mappings.
+ ///
+ /// *O*(*n*) time
+ pub fn retain<F>(&mut self, mut f: F)
+ where F: FnMut(K::Strong, V::Strong) -> bool
+ {
+ for i in 0 .. self.capacity() {
+ let remove = match self.inner.buckets[i] {
+ None => false,
+ Some(ref bucket) =>
+ match (bucket.0.view(), bucket.1.view()) {
+ (Some(key), Some(value)) => !f(key, value),
+ _ => true,
+ }
+ };
+
+ if remove {
+ self.inner.remove_index(i);
+ }
+ }
+ }
+
+ /// Is this map a submap of the other, using the given value comparison.
+ ///
+ /// In particular, all the keys of `self` must be in `other` and the values must compare
+ /// `true` with `value_equal`.
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap_with<F, S1, V1>(&self, other: &WeakWeakHashMap<K, V1, S1>,
+ mut value_equal: F) -> bool
+ where V1: WeakElement,
+ F: FnMut(V::Strong, V1::Strong) -> bool,
+ S1: BuildHasher
+ {
+ for (key, value1) in self {
+ if let Some(value2) = K::with_key(&key, |k| other.get(k)) {
+ if !value_equal(value1, value2) {
+ return false;
+ }
+ } else {
+ return false;
+ }
+ }
+
+ true
+ }
+
+ /// Is `self` a submap of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn is_submap<V1, S1>(&self, other: &WeakWeakHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S1: BuildHasher
+ {
+ self.is_submap_with(other, |v, v1| v == v1)
+ }
+
+ /// Are the keys of `self` a subset of the keys of `other`?
+ ///
+ /// expected *O*(*n*) time; worst-case *O*(*nq*) time (where *n* is
+ /// `self.capacity()` and *q* is the length of the probe sequences
+ /// in `other`)
+ pub fn domain_is_subset<V1, S1>(&self, other: &WeakWeakHashMap<K, V1, S1>) -> bool
+ where V1: WeakElement,
+ S1: BuildHasher
+ {
+ self.is_submap_with(other, |_, _| true)
+ }
+
+ fn hash<Q, H>(&self, key: Q, hash: H) -> HashCode
+ where H: FnOnce(Q, &mut S::Hasher)
+ {
+ let hasher = &mut self.hash_builder.build_hasher();
+ hash(key, hasher);
+ HashCode(hasher.finish())
+ }
+}
+
+impl<K, V, V1, S, S1> PartialEq<WeakWeakHashMap<K, V1, S1>> for WeakWeakHashMap<K, V, S>
+ where K: WeakKey,
+ V: WeakElement,
+ V1: WeakElement,
+ V::Strong: PartialEq<V1::Strong>,
+ S: BuildHasher,
+ S1: BuildHasher
+{
+ fn eq(&self, other: &WeakWeakHashMap<K, V1, S1>) -> bool {
+ self.is_submap(other) && other.domain_is_subset(self)
+ }
+}
+
+impl<K: WeakKey, V: WeakElement, S: BuildHasher> Eq for WeakWeakHashMap<K, V, S>
+ where V::Strong: Eq
+{ }
+
+impl<K: WeakKey, V: WeakElement, S: BuildHasher + Default> Default for WeakWeakHashMap<K, V, S> {
+ fn default() -> Self {
+ WeakWeakHashMap::with_hasher(Default::default())
+ }
+}
+
+impl<K, V, S> iter::FromIterator<(K::Strong, V::Strong)> for WeakWeakHashMap<K, V, S>
+ where K: WeakKey,
+ V: WeakElement,
+ S: BuildHasher + Default
+{
+ fn from_iter<T: IntoIterator<Item=(K::Strong, V::Strong)>>(iter: T) -> Self {
+ let mut result = WeakWeakHashMap::with_hasher(Default::default());
+ result.extend(iter);
+ result
+ }
+}
+
+impl<K, V, S> Extend<(K::Strong, V::Strong)> for WeakWeakHashMap<K, V, S>
+ where K: WeakKey,
+ V: WeakElement,
+ S: BuildHasher
+{
+ fn extend<T: IntoIterator<Item=(K::Strong, V::Strong)>>(&mut self, iter: T) {
+ for (key, value) in iter {
+ self.insert(key, value);
+ }
+ }
+}
+
+enum BucketStatus<V: WeakElement> {
+ Unoccupied,
+ MatchesKey(V::Strong),
+ ProbeDistance(usize),
+}
+
+impl<'a, K: WeakKey, V: WeakElement> InnerEntry<'a, K, V> {
+ // Gets the status of the current bucket.
+ fn bucket_status(&self) -> BucketStatus<V> {
+ match &self.map.buckets[self.pos] {
+ Some(bucket) => {
+ if bucket.2 == self.hash_code {
+ if let (Some(key), Some(value)) = (bucket.0.view(), bucket.1.view()) {
+ if K::with_key(&self.key, |k| K::equals(&key, k)) {
+ return BucketStatus::MatchesKey(value);
+ }
+ }
+ }
+
+ let dist = self.probe_distance(self.pos,
+ self.which_bucket(bucket.2));
+ BucketStatus::ProbeDistance(dist)
+ },
+ None => BucketStatus::Unoccupied,
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> Entry<'a, K, V> {
+ /// Ensures a value is in the entry by inserting a default value
+ /// if empty, and returns a mutable reference to the value in the
+ /// entry.
+ ///
+ /// *O*(1) time
+ pub fn or_insert(self, default: V::Strong) -> V::Strong {
+ self.or_insert_with(|| default)
+ }
+
+ /// Ensures a value is in the entry by inserting the result of the
+ /// default function if empty, and returns a mutable reference to
+ /// the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn or_insert_with<F: FnOnce() -> V::Strong>(self, default: F) -> V::Strong {
+ match self {
+ Entry::Occupied(occupied) => occupied.get_strong(),
+ Entry::Vacant(vacant) => vacant.insert(default()),
+ }
+ }
+
+ /// Returns a reference to this entry's key.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ match *self {
+ Entry::Occupied(ref occupied) => occupied.key(),
+ Entry::Vacant(ref vacant) => vacant.key(),
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> OccupiedEntry<'a, K, V> {
+ /// Gets a reference to the key held by the entry.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ &self.inner.key
+ }
+
+ /// Takes ownership of the key and value from the map.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove_entry(self) -> (K::Strong, V::Strong) {
+ let (_, w_value, _) = self.inner.map.buckets[self.inner.pos].take().unwrap();
+ let value = w_value.view().unwrap();
+ self.inner.map.remove_index(self.inner.pos);
+ (self.inner.key, value)
+ }
+
+ /// Gets a reference to the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get(&self) -> &V::Strong {
+ &self.value
+ }
+
+ /// Gets a clone of the reference to the value in the entry.
+ ///
+ /// *O*(1) time
+ pub fn get_strong(&self) -> V::Strong {
+ V::clone(&self.value)
+ }
+
+ /// Replaces the value in the entry with the given value.
+ ///
+ /// *O*(1) time
+ pub fn insert(&mut self, value: V::Strong) -> V::Strong {
+ self.inner.map.buckets[self.inner.pos].as_mut().unwrap().1 = V::new(&value);
+ mem::replace(&mut self.value, value)
+ }
+
+ /// Removes the entry, returning the value.
+ ///
+ /// expected *O*(1) time; worst-case *O*(*p*) time
+ pub fn remove(self) -> V::Strong {
+ self.remove_entry().1
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> VacantEntry<'a, K, V> {
+ /// Gets a reference to the key that would be used when inserting a
+ /// value through the `VacantEntry`.
+ ///
+ /// *O*(1) time
+ pub fn key(&self) -> &K::Strong {
+ &self.inner.key
+ }
+
+ /// Returns ownership of the key.
+ ///
+ /// *O*(1) time
+ pub fn into_key(self) -> K::Strong {
+ self.inner.key
+ }
+
+ /// Inserts the key and value into the map, returning the same value.
+ ///
+ /// *O*(1) time
+ pub fn insert(self, value: V::Strong) -> V::Strong {
+ let old_bucket = mem::replace(
+ &mut self.inner.map.buckets[self.inner.pos],
+ Some((K::new(&self.inner.key), V::new(&value), self.inner.hash_code)));
+
+ if let Some(full_bucket) = old_bucket {
+ let next_bucket = self.next_bucket(self.inner.pos);
+ self.inner.map.steal(next_bucket, full_bucket);
+ }
+
+ self.inner.map.len += 1;
+
+ value
+ }
+}
+
+impl<K: WeakKey, V: WeakElement> WeakWeakInnerMap<K, V> {
+ // Steals buckets starting at `pos`, replacing them with `bucket`.
+ fn steal(&mut self, mut pos: usize, mut bucket: FullBucket<K, V>) {
+ let mut my_dist = self.probe_distance(pos, self.which_bucket(bucket.2));
+
+ while let Some(hash_code) = self.buckets[pos].as_ref().and_then(
+ |bucket| if bucket.0.is_expired() || bucket.1.is_expired() {
+ None
+ } else {
+ Some(bucket.2)
+ }) {
+
+ let victim_dist = self.probe_distance(pos, self.which_bucket(hash_code));
+
+ if my_dist > victim_dist {
+ mem::swap(self.buckets[pos].as_mut().unwrap(), &mut bucket);
+ my_dist = victim_dist;
+ }
+
+ pos = self.next_bucket(pos);
+ my_dist += 1;
+ }
+
+ self.buckets[pos] = Some(bucket);
+ }
+
+ /// Removes the element at `dst`, shifting if necessary to preserve invariants.
+ fn remove_index(&mut self, mut dst: usize) {
+ let mut src = self.next_bucket(dst);
+
+ // We are going to remove the buckets in the range [dst, src)
+
+ loop {
+ let hash_code_option = self.buckets[src].as_ref().map(|tup| tup.2);
+
+ if let Some(hash_code) = hash_code_option {
+ let goal_pos = self.which_bucket(hash_code);
+ let dist = self.probe_distance(src, goal_pos);
+ if dist == 0 { break; }
+
+ let expired = {
+ let bucket = self.buckets[src].as_ref().unwrap();
+ bucket.0.is_expired() || bucket.1.is_expired()
+ };
+
+ if !expired {
+ if in_interval(dst, goal_pos, src) {
+ self.erase_range(dst, goal_pos);
+ self.buckets[goal_pos] = self.buckets[src].take();
+ dst = self.next_bucket(goal_pos);
+ } else {
+ self.buckets[dst] = self.buckets[src].take();
+ dst = self.next_bucket(dst);
+ }
+ }
+ } else {
+ break;
+ }
+
+ src = self.next_bucket(src);
+ }
+
+ self.erase_range(dst, src);
+ }
+
+ /// Erases the (presumably expired, but not empty) elements in [start, limit).
+ fn erase_range(&mut self, mut start: usize, limit: usize)
+ {
+ while start != limit {
+ self.buckets[start] = None;
+ self.len -= 1;
+ start = self.next_bucket(start);
+ }
+ }
+}
+
+// Is value in [start, limit) modulo capacity?
+fn in_interval(start: usize, value: usize, limit: usize) -> bool
+{
+ if start <= limit {
+ start <= value && value < limit
+ } else {
+ start <= value || value < limit
+ }
+}
+
+// Helper trait for computing with indices modulo capacity.
+trait ModuloCapacity {
+ fn capacity(&self) -> usize;
+
+ fn probe_distance(&self, actual: usize, ideal: usize) -> usize {
+ if actual >= ideal {
+ actual - ideal
+ } else {
+ actual + self.capacity() - ideal
+ }
+ }
+
+ fn next_bucket(&self, pos: usize) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (pos + 1) % self.capacity()
+ }
+
+ fn which_bucket(&self, hash_code: HashCode) -> usize {
+ assert_ne!( self.capacity(), 0 );
+ (hash_code.0 as usize) % self.capacity()
+ }
+}
+
+impl<K, V> ModuloCapacity for WeakWeakInnerMap<K, V> {
+ fn capacity(&self) -> usize {
+ self.buckets.len()
+ }
+}
+
+impl<K, V, S> ModuloCapacity for WeakWeakHashMap<K, V, S> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> ModuloCapacity for InnerEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.map.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> ModuloCapacity for OccupiedEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> ModuloCapacity for VacantEntry<'a, K, V> {
+ fn capacity(&self) -> usize {
+ self.inner.capacity()
+ }
+}
+
+impl<K, V> Debug for WeakWeakInnerMap<K, V>
+ where K: WeakElement,
+ K::Strong: Debug,
+ V: WeakElement,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "{{ ")?;
+ for (i, bucket) in self.buckets.iter().enumerate() {
+ if let Some((k, v, _)) = bucket {
+ write!(f, "[{}] {:?} => {:?}, ", i, k.view(), v.view())?;
+ }
+ }
+ write!(f, "}}")
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S> Debug for WeakWeakHashMap<K, V, S>
+ where K::Strong: Debug,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> Debug for Entry<'a, K, V>
+ where K::Strong: Debug,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ match *self {
+ Entry::Occupied(ref e) => e.fmt(f),
+ Entry::Vacant(ref e) => e.fmt(f),
+ }
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> Debug for OccupiedEntry<'a, K, V>
+ where K::Strong: Debug,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> Debug for VacantEntry<'a, K, V>
+ where K::Strong: Debug,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ self.inner.fmt(f)
+ }
+}
+
+impl<'a, K: WeakKey, V: WeakElement> Debug for InnerEntry<'a, K, V>
+ where K::Strong: Debug,
+ V::Strong: Debug
+{
+ fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+ write!(f, "InnerEntry {{ pos = {}, buckets = {:?} }}", self.pos, self.map)
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S> IntoIterator for WeakWeakHashMap<K, V, S> {
+ type Item = (K::Strong, V::Strong);
+ type IntoIter = IntoIter<K, V>;
+
+ /// Creates an owning iterator from `self`.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ fn into_iter(self) -> Self::IntoIter {
+ IntoIter {
+ size: self.inner.len,
+ base: self.inner.buckets.into_vec().into_iter(),
+ }
+ }
+}
+
+impl<'a, K: WeakElement, V: WeakElement, S> IntoIterator for &'a WeakWeakHashMap<K, V, S> {
+ type Item = (K::Strong, V::Strong);
+ type IntoIter = Iter<'a, K, V>;
+
+ /// Creates a borrowing iterator from `self`.
+ ///
+ /// *O*(1) time
+ fn into_iter(self) -> Self::IntoIter {
+ Iter {
+ base: self.inner.buckets.iter(),
+ size: self.inner.len,
+ }
+ }
+}
+
+impl<K: WeakElement, V: WeakElement, S> WeakWeakHashMap<K, V, S> {
+ /// Gets an iterator over the keys and values.
+ ///
+ /// *O*(1) time
+ pub fn iter(&self) -> Iter<K, V> {
+ self.into_iter()
+ }
+
+ /// Gets an iterator over the keys.
+ ///
+ /// *O*(1) time
+ pub fn keys(&self) -> Keys<K, V> {
+ Keys(self.iter())
+ }
+
+ /// Gets an iterator over the values.
+ ///
+ /// *O*(1) time
+ pub fn values(&self) -> Values<K, V> {
+ Values(self.iter())
+ }
+
+ /// Gets a draining iterator, which removes all the values but retains the storage.
+ ///
+ /// *O*(1) time (and *O*(*n*) time to dispose of the result)
+ pub fn drain(&mut self) -> Drain<K, V> {
+ let old_len = self.inner.len;
+ self.inner.len = 0;
+ Drain {
+ base: self.inner.buckets.iter_mut(),
+ size: old_len,
+ }
+ }
+}
+
diff --git a/crates/weak-table/tests/symbols.rs b/crates/weak-table/tests/symbols.rs
new file mode 100644
index 0000000..4f01b0d
--- /dev/null
+++ b/crates/weak-table/tests/symbols.rs
@@ -0,0 +1,54 @@
+extern crate weak_table;
+
+use weak_table::WeakHashSet;
+use std::ops::Deref;
+use std::rc::{Rc, Weak};
+
+#[derive(Clone, Debug)]
+pub struct Symbol(Rc<str>);
+
+impl PartialEq for Symbol {
+ fn eq(&self, other: &Symbol) -> bool {
+ Rc::ptr_eq(&self.0, &other.0)
+ }
+}
+
+impl Eq for Symbol {}
+
+impl Deref for Symbol {
+ type Target = str;
+ fn deref(&self) -> &str {
+ &self.0
+ }
+}
+
+#[derive(Debug, Default)]
+pub struct SymbolTable(WeakHashSet<Weak<str>>);
+
+impl SymbolTable {
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ pub fn intern(&mut self, name: &str) -> Symbol {
+ if let Some(rc) = self.0.get(name) {
+ Symbol(rc)
+ } else {
+ let rc = Rc::<str>::from(name);
+ self.0.insert(Rc::clone(&rc));
+ Symbol(rc)
+ }
+ }
+}
+
+#[test]
+fn interning() {
+ let mut tab = SymbolTable::new();
+
+ let a0 = tab.intern("a");
+ let a1 = tab.intern("a");
+ let b = tab.intern("b");
+
+ assert_eq!(a0, a1);
+ assert_ne!(a0, b);
+}
diff --git a/crates/weak-table/tests/weak_key_hash_map.rs b/crates/weak-table/tests/weak_key_hash_map.rs
new file mode 100644
index 0000000..5d50764
--- /dev/null
+++ b/crates/weak-table/tests/weak_key_hash_map.rs
@@ -0,0 +1,162 @@
+use std::collections::HashMap;
+use std::fmt::Debug;
+use std::hash::Hash;
+use std::rc::{Rc, Weak};
+
+use quickcheck::{Arbitrary, Gen, quickcheck};
+
+use weak_table::WeakKeyHashMap;
+
+use self::Cmd::*;
+
+fn test_script<K, V>(script: &Script<K, V>) -> bool
+ where K: Clone + Debug + Eq + Hash,
+ V: Clone + Debug + Eq
+{
+ let mut tester = Tester::with_capacity(4);
+ tester.execute_script(script);
+ tester.check()
+}
+
+quickcheck! {
+ fn prop_u8_u8(script: Script<u8, u8>) -> bool {
+ test_script(&script)
+ }
+
+ fn prop_string_usize(script: Script<String, usize>) -> bool {
+ test_script(&script)
+ }
+}
+
+#[derive(Clone, Debug)]
+pub enum Cmd<K, V>
+{
+ Insert(K, V),
+ Reinsert(usize, V),
+ RemoveInserted(usize),
+ RemoveOther(K),
+ ForgetInserted(usize),
+}
+
+#[derive(Clone, Debug)]
+pub struct Script<K, V>(Vec<Cmd<K, V>>);
+
+#[derive(Clone, Debug)]
+pub struct Tester<K: Hash + Eq, V> {
+ weak: WeakKeyHashMap<Weak<K>, V>,
+ strong: HashMap<Rc<K>, V>,
+ log: Vec<K>,
+}
+
+impl<K, V> Tester<K, V>
+ where K: Hash + Eq + Clone + Debug,
+ V: Eq + Clone + Debug
+{
+ pub fn new() -> Self {
+ Tester::with_capacity(8)
+ }
+
+ pub fn with_capacity(capacity: usize) -> Self {
+ Tester {
+ weak: WeakKeyHashMap::with_capacity(capacity),
+ strong: HashMap::new(),
+ log: Vec::new(),
+ }
+ }
+
+ pub fn check(&self) -> bool {
+ let copy = self.weak.iter().map(|(k, v)| (k, v.clone())).collect();
+ if self.strong == copy {
+// eprintln!("Tester::check: succeeded: {:?}", self.weak);
+ true
+ } else {
+ eprintln!("Tester::check: failed: {:?} ≠ {:?}", self.strong, copy);
+ false
+ }
+ }
+
+ pub fn execute_script(&mut self, script: &Script<K, V>) {
+// eprintln!("\n*** Starting script ***");
+ for cmd in &script.0 {
+ self.execute_command(cmd);
+ }
+ }
+
+ pub fn execute_command(&mut self, cmd: &Cmd<K, V>) {
+// eprintln!("Executing command: {:?}", cmd);
+ match *cmd {
+ Insert(ref k, ref v) => self.insert(k, v, true),
+ Reinsert(index, ref v) => self.reinsert(index, v),
+ RemoveInserted(index) => self.remove_inserted(index),
+ RemoveOther(ref k) => self.remove_other(k),
+ ForgetInserted(index) => self.forget_inserted(index),
+ }
+// eprintln!("Table state: {:?}", self.weak);
+ }
+
+ pub fn insert(&mut self, key: &K, value: &V, log: bool) {
+ let key_ptr = Rc::new(key.clone());
+ self.weak.insert(key_ptr.clone(), value.clone());
+ self.strong.remove(key);
+ self.strong.insert(key_ptr, value.clone());
+ if log { self.log.push(key.clone()); }
+ }
+
+ pub fn reinsert(&mut self, index: usize, value: &V) {
+ if let Some(key) = self.nth_key_mod_len(index) {
+ self.insert(&key, value, false);
+ }
+ }
+
+ pub fn remove_inserted(&mut self, index: usize) {
+ if let Some(key) = self.nth_key_mod_len(index) {
+ self.strong.remove(&key);
+ self.weak.remove(&key);
+ }
+ }
+
+ pub fn remove_other(&mut self, key: &K) {
+ self.strong.remove(key);
+ self.weak.remove(key);
+ }
+
+ pub fn forget_inserted(&mut self, index: usize) {
+ if let Some(key) = self.nth_key_mod_len(index) {
+ self.strong.remove(&key);
+ }
+ }
+
+ fn nth_key_mod_len(&self, n: usize) -> Option<K>
+ {
+ if self.log.is_empty() {
+ None
+ } else {
+ Some(self.log[n % self.log.len()].clone())
+ }
+ }
+}
+
+impl<K: Arbitrary, V: Arbitrary> Arbitrary for Cmd<K, V> {
+ fn arbitrary(g: &mut Gen) -> Self {
+ let choice = u8::arbitrary(g);
+
+ match choice % 10 {
+ 0..=3 => Insert(K::arbitrary(g), V::arbitrary(g)),
+ 4 => Reinsert(usize::arbitrary(g), V::arbitrary(g)),
+ 5..=6 => RemoveInserted(usize::arbitrary(g)),
+ 7 => RemoveOther(K::arbitrary(g)),
+ 8..=9 => ForgetInserted(usize::arbitrary(g)),
+ _ => unreachable!(),
+ }
+ }
+}
+
+impl<K: Arbitrary, V: Arbitrary> Arbitrary for Script<K, V> {
+ fn arbitrary(g: &mut Gen) -> Self {
+ Script(Vec::<Cmd<K, V>>::arbitrary(g))
+ }
+
+ fn shrink(&self) -> Box<dyn Iterator<Item=Self>> {
+ Box::new(self.0.shrink().map(|v| Script(v)))
+ }
+}
diff --git a/crates/webpki/.cargo-checksum.json b/crates/webpki/.cargo-checksum.json
new file mode 100644
index 0000000..2bbf30d
--- /dev/null
+++ b/crates/webpki/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"78d344e8110d5c32828dba68cc11f8b0af043858586ff9ffb22c62398e180398","LICENSE":"5b698ca13897be3afdb7174256fa1574f8c6892b8bea1a66dd6469d3fe27885a","README.md":"87d46581bccb893db159eb6d646ff6ed2bb00404a0b1aad0a8695c3f304dfdf7","src/budget.rs":"2e25e7b52f440a0869b96f5739f63e75a1977dd8a35e8a596a85a9ac3998a53b","src/calendar.rs":"3a6055dae96bb6ac870bb3a56afe4a4c0f4daed92543621dd3b9229857d7873e","src/cert.rs":"b686e1de3e8976731e359ab7b2e9344941afa2b946403b3a51f11e630abdc085","src/data/README.md":"d11d9e6adfe7c9e84d9c5956e5257eb656640f817aab391d3eef4878a73aeb20","src/data/alg-ecdsa-p256.der":"431ab0da5859f972141d7a6b17bfff1006ec2465878890eecacf4764748f999a","src/data/alg-ecdsa-p384.der":"a6307e2efeff1b4db45622b626b9a0f2b6395be5dd4024a899c057e512a0207e","src/data/alg-ecdsa-sha256.der":"8748ad98184c8f81b5db874ef1b7d3599afe05e2f92dac215a77f45e9b0699bc","src/data/alg-ecdsa-sha384.der":"5f6e0dc69f6930ca890ebcafaf7677254640b931439cd5bcad7688b1a06aaf92","src/data/alg-ed25519.der":"0b6d661fe75a1ce7a832d515b39b504032f1a6cbb67a5113fa74d635d038f4d9","src/data/alg-rsa-encryption.der":"7bc023427767a2f2e156f8ae030d06d19f862e326b952116649b423c3ff7110e","src/data/alg-rsa-pkcs1-sha256.der":"c0d1c5108d05adfdf58c73697af5c4e644d1a09fb2e4a76361c048eb0ec7a219","src/data/alg-rsa-pkcs1-sha384.der":"d3e50513620bac7e02f5c1821c569cf4fc2ca5a891fd1103e36574c77e6a888a","src/data/alg-rsa-pkcs1-sha512.der":"3705399877ad5d5bb559e5b5ed3cd80b352166511c2fd2b8f8959e1176ed72f8","src/data/alg-rsa-pss-sha256.der":"6eeb65499d8c64c3ef3e74305f2daaca0d947e7fca735ad072b5581392d73068","src/data/alg-rsa-pss-sha384.der":"b6e27adae679feb8f49925f4457da316657a6b7a55a1bfd164c66eec59d7d090","src/data/alg-rsa-pss-sha512.der":"60cea04c0dcb23c248eb644fe036d1b6b883004f73c68785895c885c8fa5d688","src/der.rs":"3cbb15c8503fc7597a543ea1f2d167a7a375cf3c8fbf8404088e123092c76e4a","src/end_entity.rs":"23a103e48ad09e23448754b1c7151bc194d20589da02f153aeede512ab190c0b","src/error.rs":"6188eac0b7390461429b91e642554ebe0e3612a355378a4843dc53da1d24ca5d","src/lib.rs":"d27f7af213c3db80d66a6a205005c42633b0e01baf6ff77faf1a3a7d8e2ed342","src/name.rs":"765b83112277f6bca6f6a46d55ea8beeb2c8cc32c2f44b03a40b665582e5aba8","src/name/dns_name.rs":"29368d38dbc1788d2516d4097ef7b607fc2c7200f0b676f4f097b517fbbf3532","src/name/ip_address.rs":"7a2b1c618d5a58addd1255cf836794478e24fcd8c0e0536f4da61823f466b270","src/name/verify.rs":"955b69df1b61ae4479c60aa1d3af616dbbe856dc3558b01626425fd663fc036f","src/signed_data.rs":"0c091475becad59e926f3c8b09556d7caee77c28c24bcc780d08eab81b43009b","src/time.rs":"1534f96f964acaf7dcaf6fee974f216241d39a52ff28779b264b79f1f949b072","src/trust_anchor.rs":"10920d313c4cc3ffa4eaea745b53c87d126e0e4b4888a9bde935b2820cd1d77c","src/verify_cert.rs":"007a2f4c176ec646c19dd8b94febca54653e23463bfc4d32196eb381790ea167","tests/dns_name_tests.rs":"9836ea648dcbd278680c9d32203fbd7925653baac4edb0f5d69eebd9605f8cc8","tests/ed25519/ca.der":"57c4b8e513e17954a5e0e4e11a63937c52507d1ffd36436e2b76e9b789ff1a2b","tests/ed25519/ee.der":"f32db7607b3c15ca3203d1c93064a47c5977288c5b2faa6ca2b11bf22b02911a","tests/integration.rs":"fd79e2e8a2637ddaf153c8532d394705b72d50490d26bbcc0779c9fc27c6a31c","tests/misc/serial_neg.der":"88497f01602f3154246ae28c4d5aef10f1d87ebb76626f4ae0b7f95ba7968799","tests/misc/serial_zero.der":"c3846bf24b9e93ca64274c0ec67c1ecc5e024ffcacd2d74019350e81fe546ae4","tests/netflix/ca.der":"eb04cf5eb1f39afa762f2bb120f296cba520c1b97db1589565b81cb9a17b7244","tests/netflix/ee.der":"d58b0dcbd15594693041633bbc788af700df3f8f243a1e09afe8cc585010322c","tests/netflix/inter.der":"564dbc6a76550fd2d4f4bac6448a1157b33cbd8e0b3fd76d72107540964a85b5","third-party/bettertls/LICENSE":"0cec06e0e55fbc3dc5cee4fca9b607f66cb8f4e4dbcf3b3c013594dd156732e9","third-party/bettertls/README.md":"4270e6ccb626095d638cb1f8c880d3c7cad7a85cc0d39525dee6aed22aeb48e1","third-party/chromium/LICENSE":"845022e0c1db1abb41a6ba4cd3c4b674ec290f3359d9d3c78ae558d4c0ed9308","third-party/chromium/data/verify_signed_data/README":"ca567fd754630fc28d0c8d1c84e0ef4e3f24169d82a913ed5f2e93b6531b36b0","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-spki-params-null.pem":"6ac6f5033fa11fd1a7c6a4df5f7ee790e3e572dac0a43c1f85d767ddc5683c21","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-unused-bits-signature.pem":"da3d8e9b8dddff9581c9218be447538e01cf84d629dab8b310a4c48e59689110","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecdh-key.pem":"0ace58a75dcb69766e8ca5ef1e2ef936f4b54d2e3430db5bd1fa99745799af77","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecmqv-key.pem":"2b5f1f423e3483d6747d9c1bbf5ccb27db830cbb24635fa235da9ee7ffa007f6","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-rsa-algorithm.pem":"45cd7e8bcc1e98498e6bdf16c57dcf3067525e3767113ed1ce1e2fb9d0d01ce0","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-wrong-signature-format.pem":"cb3bfe67be334ce01968aa760138f02324105524516438d8610cbd2fe2360425","third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512.pem":"111a3dc873ba1a8dd1a9c931b82ce34f0039a08ff919e2cdd528501e58270ad9","third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256-corrupted-data.pem":"143d020b5588b2af8fbe18e65589057c732982b6885d4bf9dc5dd14edf142768","third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256.pem":"96a6d3c113baa699e0187b0819cce1426523765f41d2287bd7f0902445d55878","third-party/chromium/data/verify_signed_data/ecdsa-using-rsa-key.pem":"ce2c52394c03f95f3a121b18185d99069f3a108f9dd3bc7c66426afecf3a1b47","third-party/chromium/data/verify_signed_data/ours/make-pss.py":"d479969c331b4de04f58b1ff618942c718b582836d75db19cc062dcd4a7f68a8","third-party/chromium/data/verify_signed_data/ours/priv.pem":"0516362bfad16242368004f46677589ecc37ff85152a3a7d3e665102e60bbb0b","third-party/chromium/data/verify_signed_data/ours/pub.pem":"5844c42bdef22e6d81621ebff836623241fbfca893a00ea3c6b8de4e0c05e7b5","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32-corrupted-data.pem":"8b5c942f19ae52eee1847515d4dd4970809768a7fcbcad691113e08ba90c6787","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32.pem":"3e68c625cfa80c7dd1aee27e0336892249e00b5f3604d5141e317f4416cef728","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48-corrupted-data.pem":"f624bc417b404cf6ebafd82cff02a611b3975af1217eca0aa88d37e0e8824b5a","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48.pem":"3673206911aa4bd8b4da9e951e37bbe6258f718d5521dc01da21936a9c92d172","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64-corrupted-data.pem":"bdcbfdc14c1d6adf01a86b8e7803be9a76dceb788fbf029ac2f67e482c277483","third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64.pem":"1a817548b4dc518a09eba5365787dc49fe30d643b21d24bf905284f6d2713ae8","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-length.pem":"d1b50934145834a4a7dedaf0a95ec557279721a2e7b91bd14fb2ba64393e8d32","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-null.pem":"0c983dbd426b12b939e78c2149da2089250bac97af4b883aaae9bd27b01b761a","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-key-params-absent.pem":"8f85c6ed8b3d8414b11c2881ac2945d59aab762671c847614a26d824110589c8","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-using-pss-key-no-params.pem":"773165ba6b867a71f88373a34b9dba676677ff5268b1ebd7e42f80ba323115de","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-wrong-algorithm.pem":"bf0ca6fe4176e3ec0198d60d37def6b836a74bfd96efd2122fb1d1703320d9e3","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1.pem":"f2a649b1d73ce1de006a1f2f11650e5ddb90ccf7de73bb19a57c157af34316a2","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-key-encoded-ber.pem":"df9b7c8cc7087a834dc2dd20431ceebf92aaf0e0c635ef367f116c39ca0e7a5b","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-spki-non-null-params.pem":"1534fe211f08e732c202e65e674bef2606b3b638add7300b6f7df8417e5404dc","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-ecdsa-algorithm.pem":"766d5e41e89bd69ef0cc804ef0de8bb7dc2cb99dca0b9b411a92b338ca5ea16e","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-id-ea-rsa.pem":"5457122a67150f0418d81fe2210cd6f4feedd59af243ef0ab196f808817f9446","third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256.pem":"34238a932aae2aa81968830f95f1669183286a29e0d9a04000d224b2e4285c62","third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-no-params.pem":"57c4b6652b6fc13f0f32265997a9fcb51fb873726fb97e1fc29d26593dfcd4c2","third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-with-null-params.pem":"67ee8e6f97d7f65f1af0ed4a53cbeb500e5cc156d44490efab0330f8af7ed7a2","third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20.pem":"94966ed94d5a59bbd47a06b33b716dd555a71b51bfc237d0ff45c3363cf21218","third-party/chromium/data/verify_signed_data/rsa-pss-sha1-wrong-salt.pem":"5583063ebca55b61a3f5f09d186dd250f8e8a29ce0beb7783f80ff5f77e1d9bb","third-party/chromium/data/verify_signed_data/rsa-pss-sha256-mgf1-sha512-salt33.pem":"7cb052b2cb306518397e227e53da76cc781a700b732b275e491cda9bd5844cd7","third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-params.pem":"4fd718a3ea88df68dfb384f7dc48c110dadca642f6265c997945fe2231fda422","third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-wrong-params.pem":"346695e766c3003c4d62a9a73016f8cab064b71bbde543cae904e4625dfa8b3b","third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10.pem":"1c3ee38f92a74a85a5a5563211431c0ec0f240ebbc803fbc19272b0469ac016b","third-party/chromium/data/verify_signed_data/rsa-using-ec-key.pem":"6ef47d55e423c0e4e942388cd09aab942dc33f0bc522249118a9857470c5dce2","third-party/chromium/data/verify_signed_data/rsa2048-pkcs1-sha512.pem":"4428f1b0ab076129bf728ae690b3b4469f9746f2e310911d89c2bba2942cd87d"},"package":"ed63aea5ce73d0ff405984102c42de94fc55a6b75765d621c65262469b3c9b53"}
\ No newline at end of file
diff --git a/crates/webpki/Android.bp b/crates/webpki/Android.bp
new file mode 100644
index 0000000..5a46ff4
--- /dev/null
+++ b/crates/webpki/Android.bp
@@ -0,0 +1,136 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file after the first "rust_*" or "genrule" module
+// because the changes will be overridden on upgrade.
+// Content before the first "rust_*" or "genrule" module is preserved.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_webpki_license"],
+}
+
+// Added automatically by a large-scale-change that took the approach of
+// 'apply every license found to every target'. While this makes sure we respect
+// every license restriction, it may not be entirely correct.
+//
+// e.g. GPL in an MIT project might only apply to the contrib/ directory.
+//
+// Please consider splitting the single license below into multiple licenses,
+// taking care not to lose any license_kind information, and overriding the
+// default license using the 'licenses: [...]' property on targets as needed.
+//
+// For unused files, consider creating a 'fileGroup' with "//visibility:private"
+// to attach the license to, and including a comment whether the files may be
+// used in the current project.
+// See: http://go/android-license-faq
+license {
+ name: "external_rust_crates_webpki_license",
+ visibility: [":__subpackages__"],
+ license_kinds: [
+ "SPDX-license-identifier-BSD",
+ "SPDX-license-identifier-ISC",
+ ],
+ license_text: [
+ "LICENSE",
+ ],
+}
+
+rust_library {
+ name: "libwebpki",
+ host_supported: true,
+ crate_name: "webpki",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.22.4",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ features: [
+ "alloc",
+ "std",
+ ],
+ rustlibs: [
+ "libring",
+ "libuntrusted",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+}
+
+rust_test {
+ name: "webpki_test_src_lib",
+ host_supported: true,
+ crate_name: "webpki",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.22.4",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "alloc",
+ "std",
+ ],
+ rustlibs: [
+ "libbase64_rust",
+ "libring",
+ "libserde",
+ "libserde_json",
+ "libuntrusted",
+ ],
+}
+
+rust_test {
+ name: "webpki_test_tests_dns_name_tests",
+ host_supported: true,
+ crate_name: "dns_name_tests",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.22.4",
+ crate_root: "tests/dns_name_tests.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "alloc",
+ "std",
+ ],
+ rustlibs: [
+ "libbase64_rust",
+ "libring",
+ "libserde",
+ "libserde_json",
+ "libuntrusted",
+ "libwebpki",
+ ],
+}
+
+rust_test {
+ name: "webpki_test_tests_integration",
+ host_supported: true,
+ crate_name: "integration",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.22.4",
+ crate_root: "tests/integration.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2018",
+ features: [
+ "alloc",
+ "std",
+ ],
+ rustlibs: [
+ "libbase64_rust",
+ "libring",
+ "libserde",
+ "libserde_json",
+ "libuntrusted",
+ "libwebpki",
+ ],
+}
diff --git a/crates/webpki/Cargo.toml b/crates/webpki/Cargo.toml
new file mode 100644
index 0000000..5bec9cb
--- /dev/null
+++ b/crates/webpki/Cargo.toml
@@ -0,0 +1,85 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+rust-version = "1.61.0"
+name = "webpki"
+version = "0.22.4"
+authors = ["Brian Smith <[email protected]>"]
+include = [
+ "Cargo.toml",
+ "LICENSE",
+ "README.md",
+ "src/**/*.rs",
+ "src/data/**/*",
+ "tests/dns_name_tests.rs",
+ "tests/integration.rs",
+ "tests/misc/serial_neg.der",
+ "tests/misc/serial_zero.der",
+ "tests/netflix/ca.der",
+ "tests/netflix/ee.der",
+ "tests/netflix/inter.der",
+ "tests/ed25519/ca.der",
+ "tests/ed25519/ee.der",
+ "third-party/chromium/**/*",
+]
+description = "Web PKI X.509 Certificate Verification."
+readme = "README.md"
+categories = [
+ "cryptography",
+ "no-std",
+]
+license-file = "LICENSE"
+repository = "https://github.com/briansmith/webpki"
+
+[package.metadata.docs.rs]
+all-features = true
+
+[profile.bench]
+opt-level = 3
+lto = true
+codegen-units = 1
+debug = 0
+debug-assertions = false
+rpath = false
+
+[profile.release]
+opt-level = 3
+lto = true
+codegen-units = 1
+debug = 0
+debug-assertions = false
+rpath = false
+
+[lib]
+name = "webpki"
+
+[dependencies.ring]
+version = "0.17.2"
+default-features = false
+
+[dependencies.untrusted]
+version = "0.9"
+
+[dev-dependencies.base64]
+version = "0.9.1"
+
+[dev-dependencies.serde]
+version = "1.0"
+features = ["derive"]
+
+[dev-dependencies.serde_json]
+version = "1.0"
+
+[features]
+alloc = ["ring/alloc"]
+std = ["alloc"]
diff --git a/crates/webpki/LICENSE b/crates/webpki/LICENSE
new file mode 100644
index 0000000..cd87be1
--- /dev/null
+++ b/crates/webpki/LICENSE
@@ -0,0 +1,19 @@
+Except as otherwise noted, this project is licensed under the following
+(ISC-style) terms:
+
+Copyright 2015 Brian Smith.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+The files under third-party/chromium are licensed as described in
+third-party/chromium/LICENSE.
diff --git a/crates/webpki/METADATA b/crates/webpki/METADATA
new file mode 100644
index 0000000..9156ed1
--- /dev/null
+++ b/crates/webpki/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/webpki
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "webpki"
+description: "Web PKI X.509 Certificate Verification."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 6
+ }
+ homepage: "https://crates.io/crates/webpki"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/webpki/webpki-0.22.4.crate"
+ version: "0.22.4"
+ }
+}
diff --git a/crates/webpki/MODULE_LICENSE_BSD_LIKE b/crates/webpki/MODULE_LICENSE_BSD_LIKE
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/webpki/MODULE_LICENSE_BSD_LIKE
diff --git a/crates/webpki/README.md b/crates/webpki/README.md
new file mode 100644
index 0000000..29bb836
--- /dev/null
+++ b/crates/webpki/README.md
@@ -0,0 +1,78 @@
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+
+What is webpki?
+==================
+
+webpki is a library that validates Web PKI (TLS/SSL) certificates. webpki
+is designed to provide a **full** implementation of the client side of the
+**Web PKI** to a diverse range of applications and devices,
+including embedded (IoT) applications, mobile apps, desktop applications, and
+server infrastructure. webpki is intended to not only be the best
+implementation of the Web PKI, but to also *precisely define* what the Web PKI
+is.
+
+webpki is written in [Rust](https://www.rust-lang.org/) and uses
+[*ring*](https://github.com/briansmith/ring) for signature verification.
+
+webpki is strongly influenced by
+[mozilla::pkix](https://github.com/briansmith/mozillapkix). You can read a
+little about the ideas underlying both mozilla::pkix and webpki in
+[insanity::pkix: A New Certificate Path Building & Validation
+Library](https://briansmith.org/insanity-pkix).
+
+The Rust compiler statically guarantees there are no buffer overflows,
+uses-after-free, double-frees, data races, etc. in webpki. webpki takes
+advantage of Rust's borrow checker to ensure that its **zero-copy parsing**
+strategy is safe and efficient. webpki *never* allocates memory on the heap,
+and it maintains a tight bound on the amount of stack memory it uses. webpki
+avoids all superfluous PKIX features in order to keep its object code size
+small. Further reducing the code size of webpki is an important goal.
+
+This release is the very first prototype. Lots of improvements are planned,
+including:
+
+* An extensive automated test suite.
+* Key pinning.
+* Certificate Transparency support.
+* Short-lived certificate, OCSP stapling, and CRLSet support.
+* Customization of the supported algorithms, key sizes, and elliptic curves
+ allowed during a validation.
+* A C language wrapper interface to allow using webpki in non-Rust
+ applications.
+* A specification of precisely what the Web PKI is.
+
+
+
+Demo
+====
+
+See https://github.com/ctz/rustls#example-code for an example of using
+webpki.
+
+
+
+License
+=======
+
+See [LICENSE](LICENSE). This project happily accepts pull requests without any
+formal copyright/contributor license agreement. Pull requests must explicitly
+indicate who owns the copyright to the code being contributed and that the code
+is being licensed under the same terms as the existing webpki code.
+
+
+
+Bug Reporting
+=============
+
+Please report bugs either as pull requests or as issues in [the issue
+tracker](https://github.com/briansmith/webpki/issues). webpki has a
+**full disclosure** vulnerability policy. **Please do NOT attempt to report
+any security vulnerability in this code privately to anybody.**
diff --git a/crates/webpki/TEST_MAPPING b/crates/webpki/TEST_MAPPING
new file mode 100644
index 0000000..66818d3
--- /dev/null
+++ b/crates/webpki/TEST_MAPPING
@@ -0,0 +1,25 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "presubmit": [
+ {
+ "name": "webpki_test_src_lib"
+ },
+ {
+ "name": "webpki_test_tests_dns_name_tests"
+ },
+ {
+ "name": "webpki_test_tests_integration"
+ }
+ ],
+ "presubmit-rust": [
+ {
+ "name": "webpki_test_src_lib"
+ },
+ {
+ "name": "webpki_test_tests_dns_name_tests"
+ },
+ {
+ "name": "webpki_test_tests_integration"
+ }
+ ]
+}
diff --git a/crates/webpki/cargo_embargo.json b/crates/webpki/cargo_embargo.json
new file mode 100644
index 0000000..e0003f2
--- /dev/null
+++ b/crates/webpki/cargo_embargo.json
@@ -0,0 +1,10 @@
+{
+ "features": [
+ "alloc",
+ "std"
+ ],
+ "product_available": false,
+ "run_cargo": false,
+ "tests": true,
+ "vendor_available": false
+}
diff --git a/crates/webpki/src/budget.rs b/crates/webpki/src/budget.rs
new file mode 100644
index 0000000..ea73a7d
--- /dev/null
+++ b/crates/webpki/src/budget.rs
@@ -0,0 +1,60 @@
+// Copyright 2015 Brian Smith.
+// Portions Copyright 2033 Daniel McCarney.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::ErrorExt;
+
+pub(super) struct Budget {
+ signatures: usize,
+ build_chain_calls: usize,
+}
+
+impl Budget {
+ #[inline]
+ pub fn consume_signature(&mut self) -> Result<(), ErrorExt> {
+ checked_sub(
+ &mut self.signatures,
+ ErrorExt::MaximumSignatureChecksExceeded,
+ )
+ }
+
+ #[inline]
+ pub fn consume_build_chain_call(&mut self) -> Result<(), ErrorExt> {
+ checked_sub(
+ &mut self.build_chain_calls,
+ ErrorExt::MaximumPathBuildCallsExceeded,
+ )
+ }
+}
+
+fn checked_sub(value: &mut usize, underflow_error: ErrorExt) -> Result<(), ErrorExt> {
+ *value = value.checked_sub(1).ok_or(underflow_error)?;
+ Ok(())
+}
+
+impl Default for Budget {
+ fn default() -> Self {
+ Self {
+ // This limit is taken from the remediation for golang CVE-2018-16875. However,
+ // note that golang subsequently implemented AKID matching due to this limit
+ // being hit in real applications (see <https://github.com/spiffe/spire/issues/1004>).
+ // So this may actually be too aggressive.
+ signatures: 100,
+
+ // This limit is taken from mozilla::pkix, see:
+ // <https://github.com/nss-dev/nss/blob/bb4a1d38dd9e92923525ac6b5ed0288479f3f3fc/lib/mozpkix/lib/pkixbuild.cpp#L381-L393>
+ build_chain_calls: 200_000,
+ }
+ }
+}
diff --git a/crates/webpki/src/calendar.rs b/crates/webpki/src/calendar.rs
new file mode 100644
index 0000000..f1d2c44
--- /dev/null
+++ b/crates/webpki/src/calendar.rs
@@ -0,0 +1,162 @@
+// Copyright 2015-2016 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use super::{time::Time, Error};
+
+pub fn time_from_ymdhms_utc(
+ year: u64,
+ month: u64,
+ day_of_month: u64,
+ hours: u64,
+ minutes: u64,
+ seconds: u64,
+) -> Result<Time, Error> {
+ let days_before_year_since_unix_epoch = days_before_year_since_unix_epoch(year)?;
+
+ const JAN: u64 = 31;
+ let feb = days_in_feb(year);
+ const MAR: u64 = 31;
+ const APR: u64 = 30;
+ const MAY: u64 = 31;
+ const JUN: u64 = 30;
+ const JUL: u64 = 31;
+ const AUG: u64 = 31;
+ const SEP: u64 = 30;
+ const OCT: u64 = 31;
+ const NOV: u64 = 30;
+ let days_before_month_in_year = match month {
+ 1 => 0,
+ 2 => JAN,
+ 3 => JAN + feb,
+ 4 => JAN + feb + MAR,
+ 5 => JAN + feb + MAR + APR,
+ 6 => JAN + feb + MAR + APR + MAY,
+ 7 => JAN + feb + MAR + APR + MAY + JUN,
+ 8 => JAN + feb + MAR + APR + MAY + JUN + JUL,
+ 9 => JAN + feb + MAR + APR + MAY + JUN + JUL + AUG,
+ 10 => JAN + feb + MAR + APR + MAY + JUN + JUL + AUG + SEP,
+ 11 => JAN + feb + MAR + APR + MAY + JUN + JUL + AUG + SEP + OCT,
+ 12 => JAN + feb + MAR + APR + MAY + JUN + JUL + AUG + SEP + OCT + NOV,
+ _ => unreachable!(), // `read_two_digits` already bounds-checked it.
+ };
+
+ let days_before =
+ days_before_year_since_unix_epoch + days_before_month_in_year + day_of_month - 1;
+
+ let seconds_since_unix_epoch =
+ (days_before * 24 * 60 * 60) + (hours * 60 * 60) + (minutes * 60) + seconds;
+
+ Ok(Time::from_seconds_since_unix_epoch(
+ seconds_since_unix_epoch,
+ ))
+}
+
+fn days_before_year_since_unix_epoch(year: u64) -> Result<u64, Error> {
+ // We don't support dates before January 1, 1970 because that is the
+ // Unix epoch. It is likely that other software won't deal well with
+ // certificates that have dates before the epoch.
+ if year < 1970 {
+ return Err(Error::BadDerTime);
+ }
+ let days_before_year_ad = days_before_year_ad(year);
+ debug_assert!(days_before_year_ad >= DAYS_BEFORE_UNIX_EPOCH_AD);
+ Ok(days_before_year_ad - DAYS_BEFORE_UNIX_EPOCH_AD)
+}
+
+fn days_before_year_ad(year: u64) -> u64 {
+ ((year - 1) * 365)
+ + ((year - 1) / 4) // leap years are every 4 years,
+ - ((year - 1) / 100) // except years divisible by 100,
+ + ((year - 1) / 400) // except years divisible by 400.
+}
+
+pub fn days_in_month(year: u64, month: u64) -> u64 {
+ match month {
+ 1 | 3 | 5 | 7 | 8 | 10 | 12 => 31,
+ 4 | 6 | 9 | 11 => 30,
+ 2 => days_in_feb(year),
+ _ => unreachable!(), // `read_two_digits` already bounds-checked it.
+ }
+}
+
+fn days_in_feb(year: u64) -> u64 {
+ if (year % 4 == 0) && ((year % 100 != 0) || (year % 400 == 0)) {
+ 29
+ } else {
+ 28
+ }
+}
+
+#[allow(clippy::unreadable_literal)] // TODO: Make this clear.
+const DAYS_BEFORE_UNIX_EPOCH_AD: u64 = 719162;
+
+#[cfg(test)]
+mod tests {
+ #[test]
+ fn test_days_before_unix_epoch() {
+ use super::{days_before_year_ad, DAYS_BEFORE_UNIX_EPOCH_AD};
+ assert_eq!(DAYS_BEFORE_UNIX_EPOCH_AD, days_before_year_ad(1970));
+ }
+
+ #[test]
+ fn test_days_in_month() {
+ use super::days_in_month;
+ assert_eq!(days_in_month(2017, 1), 31);
+ assert_eq!(days_in_month(2017, 2), 28);
+ assert_eq!(days_in_month(2017, 3), 31);
+ assert_eq!(days_in_month(2017, 4), 30);
+ assert_eq!(days_in_month(2017, 5), 31);
+ assert_eq!(days_in_month(2017, 6), 30);
+ assert_eq!(days_in_month(2017, 7), 31);
+ assert_eq!(days_in_month(2017, 8), 31);
+ assert_eq!(days_in_month(2017, 9), 30);
+ assert_eq!(days_in_month(2017, 10), 31);
+ assert_eq!(days_in_month(2017, 11), 30);
+ assert_eq!(days_in_month(2017, 12), 31);
+
+ // leap cases
+ assert_eq!(days_in_month(2000, 2), 29);
+ assert_eq!(days_in_month(2004, 2), 29);
+ assert_eq!(days_in_month(2016, 2), 29);
+ assert_eq!(days_in_month(2100, 2), 28);
+ }
+
+ #[allow(clippy::unreadable_literal)] // TODO: Make this clear.
+ #[test]
+ fn test_time_from_ymdhms_utc() {
+ use super::{time_from_ymdhms_utc, Time};
+
+ // year boundary
+ assert_eq!(
+ Time::from_seconds_since_unix_epoch(1483228799),
+ time_from_ymdhms_utc(2016, 12, 31, 23, 59, 59).unwrap()
+ );
+ assert_eq!(
+ Time::from_seconds_since_unix_epoch(1483228800),
+ time_from_ymdhms_utc(2017, 1, 1, 0, 0, 0).unwrap()
+ );
+
+ // not a leap year
+ assert_eq!(
+ Time::from_seconds_since_unix_epoch(1492449162),
+ time_from_ymdhms_utc(2017, 4, 17, 17, 12, 42).unwrap()
+ );
+
+ // leap year, post-feb
+ assert_eq!(
+ Time::from_seconds_since_unix_epoch(1460913162),
+ time_from_ymdhms_utc(2016, 4, 17, 17, 12, 42).unwrap()
+ );
+ }
+}
diff --git a/crates/webpki/src/cert.rs b/crates/webpki/src/cert.rs
new file mode 100644
index 0000000..792f49f
--- /dev/null
+++ b/crates/webpki/src/cert.rs
@@ -0,0 +1,226 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::{der, equal, signed_data, Error};
+
+pub enum EndEntityOrCa<'a> {
+ EndEntity,
+ Ca(&'a Cert<'a>),
+}
+
+pub struct Cert<'a> {
+ pub ee_or_ca: EndEntityOrCa<'a>,
+
+ pub signed_data: signed_data::SignedData<'a>,
+ pub issuer: untrusted::Input<'a>,
+ pub validity: untrusted::Input<'a>,
+ pub subject: untrusted::Input<'a>,
+ pub spki: der::Value<'a>,
+
+ pub basic_constraints: Option<untrusted::Input<'a>>,
+ pub eku: Option<untrusted::Input<'a>>,
+ pub name_constraints: Option<untrusted::Input<'a>>,
+ pub subject_alt_name: Option<untrusted::Input<'a>>,
+}
+
+pub fn parse_cert<'a>(
+ cert_der: untrusted::Input<'a>,
+ ee_or_ca: EndEntityOrCa<'a>,
+) -> Result<Cert<'a>, Error> {
+ parse_cert_internal(cert_der, ee_or_ca, certificate_serial_number)
+}
+
+/// Used by `parse_cert` for regular certificates (end-entity and intermediate)
+/// and by `cert_der_as_trust_anchor` for trust anchors encoded as
+/// certificates.
+pub(crate) fn parse_cert_internal<'a>(
+ cert_der: untrusted::Input<'a>,
+ ee_or_ca: EndEntityOrCa<'a>,
+ serial_number: fn(input: &mut untrusted::Reader<'_>) -> Result<(), Error>,
+) -> Result<Cert<'a>, Error> {
+ let (tbs, signed_data) = cert_der.read_all(Error::BadDer, |cert_der| {
+ der::nested(
+ cert_der,
+ der::Tag::Sequence,
+ Error::BadDer,
+ signed_data::parse_signed_data,
+ )
+ })?;
+
+ tbs.read_all(Error::BadDer, |tbs| {
+ version3(tbs)?;
+ serial_number(tbs)?;
+
+ let signature = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+ // TODO: In mozilla::pkix, the comparison is done based on the
+ // normalized value (ignoring whether or not there is an optional NULL
+ // parameter for RSA-based algorithms), so this may be too strict.
+ if !equal(signature, signed_data.algorithm) {
+ return Err(Error::SignatureAlgorithmMismatch);
+ }
+
+ let issuer = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+ let validity = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+ let subject = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+ let spki = der::expect_tag(tbs, der::Tag::Sequence)?;
+
+ // In theory there could be fields [1] issuerUniqueID and [2]
+ // subjectUniqueID, but in practice there never are, and to keep the
+ // code small and simple we don't accept any certificates that do
+ // contain them.
+
+ let mut cert = Cert {
+ ee_or_ca,
+
+ signed_data,
+ issuer,
+ validity,
+ subject,
+ spki,
+
+ basic_constraints: None,
+ eku: None,
+ name_constraints: None,
+ subject_alt_name: None,
+ };
+
+ // mozilla::pkix allows the extensions to be omitted. However, since
+ // the subjectAltName extension is mandatory, the extensions are
+ // mandatory too, and we enforce that. Also, mozilla::pkix includes
+ // special logic for handling critical Netscape Cert Type extensions.
+ // That has been intentionally omitted.
+
+ der::nested(
+ tbs,
+ der::Tag::ContextSpecificConstructed3,
+ Error::MissingOrMalformedExtensions,
+ |tagged| {
+ der::nested_of_mut(
+ tagged,
+ der::Tag::Sequence,
+ der::Tag::Sequence,
+ Error::BadDer,
+ |extension| {
+ let extn_id = der::expect_tag_and_get_value(extension, der::Tag::OID)?;
+ let critical = der::optional_boolean(extension)?;
+ let extn_value =
+ der::expect_tag_and_get_value(extension, der::Tag::OctetString)?;
+ match remember_extension(&mut cert, extn_id, extn_value)? {
+ Understood::No if critical => Err(Error::UnsupportedCriticalExtension),
+ _ => Ok(()),
+ }
+ },
+ )
+ },
+ )?;
+
+ Ok(cert)
+ })
+}
+
+// mozilla::pkix supports v1, v2, v3, and v4, including both the implicit
+// (correct) and explicit (incorrect) encoding of v1. We allow only v3.
+fn version3(input: &mut untrusted::Reader) -> Result<(), Error> {
+ der::nested(
+ input,
+ der::Tag::ContextSpecificConstructed0,
+ Error::UnsupportedCertVersion,
+ |input| {
+ let version = der::small_nonnegative_integer(input)?;
+ if version != 2 {
+ // v3
+ return Err(Error::UnsupportedCertVersion);
+ }
+ Ok(())
+ },
+ )
+}
+
+pub fn certificate_serial_number(input: &mut untrusted::Reader) -> Result<(), Error> {
+ // https://tools.ietf.org/html/rfc5280#section-4.1.2.2:
+ // * Conforming CAs MUST NOT use serialNumber values longer than 20 octets."
+ // * "The serial number MUST be a positive integer [...]"
+
+ let value = der::positive_integer(input)?;
+ if value.big_endian_without_leading_zero().len() > 20 {
+ return Err(Error::BadDer);
+ }
+ Ok(())
+}
+
+enum Understood {
+ Yes,
+ No,
+}
+
+fn remember_extension<'a>(
+ cert: &mut Cert<'a>,
+ extn_id: untrusted::Input,
+ value: untrusted::Input<'a>,
+) -> Result<Understood, Error> {
+ // We don't do anything with certificate policies so we can safely ignore
+ // all policy-related stuff. We assume that the policy-related extensions
+ // are not marked critical.
+
+ // id-ce 2.5.29
+ static ID_CE: [u8; 2] = oid![2, 5, 29];
+
+ if extn_id.len() != ID_CE.len() + 1 || !extn_id.as_slice_less_safe().starts_with(&ID_CE) {
+ return Ok(Understood::No);
+ }
+
+ let out = match *extn_id.as_slice_less_safe().last().unwrap() {
+ // id-ce-keyUsage 2.5.29.15. We ignore the KeyUsage extension. For CA
+ // certificates, BasicConstraints.cA makes KeyUsage redundant. Firefox
+ // and other common browsers do not check KeyUsage for end-entities,
+ // though it would be kind of nice to ensure that a KeyUsage without
+ // the keyEncipherment bit could not be used for RSA key exchange.
+ 15 => {
+ return Ok(Understood::Yes);
+ }
+
+ // id-ce-subjectAltName 2.5.29.17
+ 17 => &mut cert.subject_alt_name,
+
+ // id-ce-basicConstraints 2.5.29.19
+ 19 => &mut cert.basic_constraints,
+
+ // id-ce-nameConstraints 2.5.29.30
+ 30 => &mut cert.name_constraints,
+
+ // id-ce-extKeyUsage 2.5.29.37
+ 37 => &mut cert.eku,
+
+ _ => {
+ return Ok(Understood::No);
+ }
+ };
+
+ match *out {
+ Some(..) => {
+ // The certificate contains more than one instance of this
+ // extension.
+ return Err(Error::ExtensionValueInvalid);
+ }
+ None => {
+ // All the extensions that we care about are wrapped in a SEQUENCE.
+ let sequence_value = value.read_all(Error::BadDer, |value| {
+ der::expect_tag_and_get_value(value, der::Tag::Sequence)
+ })?;
+ *out = Some(sequence_value);
+ }
+ }
+
+ Ok(Understood::Yes)
+}
diff --git a/crates/webpki/src/data/README.md b/crates/webpki/src/data/README.md
new file mode 100644
index 0000000..78fc778
--- /dev/null
+++ b/crates/webpki/src/data/README.md
@@ -0,0 +1,21 @@
+These files contain the binary DER encoding of the *values* of some
+ASN.1 [`AlgorithmIdentifier`]s, without the outer `SEQUENCE` tag or the outer
+length component.
+
+These files were encoded with the help of [der-ascii]. They can be decoded
+using:
+
+```sh
+go get github.com/google/der-ascii/cmd/der2ascii
+der2ascii -i <filename> -o <filename>.ascii
+```
+
+New or modified der-ascii files can be encoded using:
+
+```sh
+go get github.com/google/der-ascii/cmd/ascii2der
+ascii2der i <filename>.ascii -o <filename>
+```
+
+[`AlgorithmIdentifier`]: https://tools.ietf.org/html/rfc5280#section-4.1.1.2]
+[der-ascii]: https://github.com/google/der-ascii
diff --git a/crates/webpki/src/data/alg-ecdsa-p256.der b/crates/webpki/src/data/alg-ecdsa-p256.der
new file mode 100644
index 0000000..d49c30d
--- /dev/null
+++ b/crates/webpki/src/data/alg-ecdsa-p256.der
@@ -0,0 +1 @@
+*HÎ=*HÎ=
\ No newline at end of file
diff --git a/crates/webpki/src/data/alg-ecdsa-p384.der b/crates/webpki/src/data/alg-ecdsa-p384.der
new file mode 100644
index 0000000..8b24916
--- /dev/null
+++ b/crates/webpki/src/data/alg-ecdsa-p384.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-ecdsa-sha256.der b/crates/webpki/src/data/alg-ecdsa-sha256.der
new file mode 100644
index 0000000..b2ee128
--- /dev/null
+++ b/crates/webpki/src/data/alg-ecdsa-sha256.der
@@ -0,0 +1 @@
+*HÎ=
\ No newline at end of file
diff --git a/crates/webpki/src/data/alg-ecdsa-sha384.der b/crates/webpki/src/data/alg-ecdsa-sha384.der
new file mode 100644
index 0000000..7c61d3a
--- /dev/null
+++ b/crates/webpki/src/data/alg-ecdsa-sha384.der
@@ -0,0 +1 @@
+*HÎ=
\ No newline at end of file
diff --git a/crates/webpki/src/data/alg-ed25519.der b/crates/webpki/src/data/alg-ed25519.der
new file mode 100644
index 0000000..7ca46fd
--- /dev/null
+++ b/crates/webpki/src/data/alg-ed25519.der
@@ -0,0 +1 @@
++ep
\ No newline at end of file
diff --git a/crates/webpki/src/data/alg-rsa-encryption.der b/crates/webpki/src/data/alg-rsa-encryption.der
new file mode 100644
index 0000000..77d159a
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-encryption.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pkcs1-sha256.der b/crates/webpki/src/data/alg-rsa-pkcs1-sha256.der
new file mode 100644
index 0000000..ab52bcd
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pkcs1-sha256.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pkcs1-sha384.der b/crates/webpki/src/data/alg-rsa-pkcs1-sha384.der
new file mode 100644
index 0000000..c0d43b1
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pkcs1-sha384.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pkcs1-sha512.der b/crates/webpki/src/data/alg-rsa-pkcs1-sha512.der
new file mode 100644
index 0000000..71aded5
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pkcs1-sha512.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pss-sha256.der b/crates/webpki/src/data/alg-rsa-pss-sha256.der
new file mode 100644
index 0000000..87328f7
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pss-sha256.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pss-sha384.der b/crates/webpki/src/data/alg-rsa-pss-sha384.der
new file mode 100644
index 0000000..9c3b170
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pss-sha384.der
Binary files differ
diff --git a/crates/webpki/src/data/alg-rsa-pss-sha512.der b/crates/webpki/src/data/alg-rsa-pss-sha512.der
new file mode 100644
index 0000000..c0ad57d
--- /dev/null
+++ b/crates/webpki/src/data/alg-rsa-pss-sha512.der
Binary files differ
diff --git a/crates/webpki/src/der.rs b/crates/webpki/src/der.rs
new file mode 100644
index 0000000..43d0847
--- /dev/null
+++ b/crates/webpki/src/der.rs
@@ -0,0 +1,173 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::{calendar, time, Error};
+pub use ring::io::{
+ der::{nested, Tag, CONSTRUCTED},
+ Positive,
+};
+
+#[inline(always)]
+pub fn expect_tag_and_get_value<'a>(
+ input: &mut untrusted::Reader<'a>,
+ tag: Tag,
+) -> Result<untrusted::Input<'a>, Error> {
+ ring::io::der::expect_tag_and_get_value(input, tag).map_err(|_| Error::BadDer)
+}
+
+pub struct Value<'a> {
+ value: untrusted::Input<'a>,
+}
+
+impl<'a> Value<'a> {
+ pub fn value(&self) -> untrusted::Input<'a> {
+ self.value
+ }
+}
+
+pub fn expect_tag<'a>(input: &mut untrusted::Reader<'a>, tag: Tag) -> Result<Value<'a>, Error> {
+ let (actual_tag, value) = read_tag_and_get_value(input)?;
+ if usize::from(tag) != usize::from(actual_tag) {
+ return Err(Error::BadDer);
+ }
+
+ Ok(Value { value })
+}
+
+#[inline(always)]
+pub fn read_tag_and_get_value<'a>(
+ input: &mut untrusted::Reader<'a>,
+) -> Result<(u8, untrusted::Input<'a>), Error> {
+ ring::io::der::read_tag_and_get_value(input).map_err(|_| Error::BadDer)
+}
+
+// TODO: investigate taking decoder as a reference to reduce generated code
+// size.
+pub fn nested_of_mut<'a, E>(
+ input: &mut untrusted::Reader<'a>,
+ outer_tag: Tag,
+ inner_tag: Tag,
+ error: E,
+ mut decoder: impl FnMut(&mut untrusted::Reader<'a>) -> Result<(), E>,
+) -> Result<(), E>
+where
+ E: Copy,
+{
+ nested(input, outer_tag, error, |outer| {
+ loop {
+ nested(outer, inner_tag, error, |inner| decoder(inner))?;
+ if outer.at_end() {
+ break;
+ }
+ }
+ Ok(())
+ })
+}
+
+pub fn bit_string_with_no_unused_bits<'a>(
+ input: &mut untrusted::Reader<'a>,
+) -> Result<untrusted::Input<'a>, Error> {
+ nested(input, Tag::BitString, Error::BadDer, |value| {
+ let unused_bits_at_end = value.read_byte().map_err(|_| Error::BadDer)?;
+ if unused_bits_at_end != 0 {
+ return Err(Error::BadDer);
+ }
+ Ok(value.read_bytes_to_end())
+ })
+}
+
+// Like mozilla::pkix, we accept the nonconformant explicit encoding of
+// the default value (false) for compatibility with real-world certificates.
+pub fn optional_boolean(input: &mut untrusted::Reader) -> Result<bool, Error> {
+ if !input.peek(Tag::Boolean.into()) {
+ return Ok(false);
+ }
+ nested(input, Tag::Boolean, Error::BadDer, |input| {
+ match input.read_byte() {
+ Ok(0xff) => Ok(true),
+ Ok(0x00) => Ok(false),
+ _ => Err(Error::BadDer),
+ }
+ })
+}
+
+pub fn positive_integer<'a>(input: &'a mut untrusted::Reader) -> Result<Positive<'a>, Error> {
+ ring::io::der::positive_integer(input).map_err(|_| Error::BadDer)
+}
+
+pub fn small_nonnegative_integer(input: &mut untrusted::Reader) -> Result<u8, Error> {
+ ring::io::der::small_nonnegative_integer(input).map_err(|_| Error::BadDer)
+}
+
+pub fn time_choice(input: &mut untrusted::Reader) -> Result<time::Time, Error> {
+ let is_utc_time = input.peek(Tag::UTCTime.into());
+ let expected_tag = if is_utc_time {
+ Tag::UTCTime
+ } else {
+ Tag::GeneralizedTime
+ };
+
+ fn read_digit(inner: &mut untrusted::Reader) -> Result<u64, Error> {
+ const DIGIT: core::ops::RangeInclusive<u8> = b'0'..=b'9';
+ let b = inner.read_byte().map_err(|_| Error::BadDerTime)?;
+ if DIGIT.contains(&b) {
+ return Ok(u64::from(b - DIGIT.start()));
+ }
+ Err(Error::BadDerTime)
+ }
+
+ fn read_two_digits(inner: &mut untrusted::Reader, min: u64, max: u64) -> Result<u64, Error> {
+ let hi = read_digit(inner)?;
+ let lo = read_digit(inner)?;
+ let value = (hi * 10) + lo;
+ if value < min || value > max {
+ return Err(Error::BadDerTime);
+ }
+ Ok(value)
+ }
+
+ nested(input, expected_tag, Error::BadDer, |value| {
+ let (year_hi, year_lo) = if is_utc_time {
+ let lo = read_two_digits(value, 0, 99)?;
+ let hi = if lo >= 50 { 19 } else { 20 };
+ (hi, lo)
+ } else {
+ let hi = read_two_digits(value, 0, 99)?;
+ let lo = read_two_digits(value, 0, 99)?;
+ (hi, lo)
+ };
+
+ let year = (year_hi * 100) + year_lo;
+ let month = read_two_digits(value, 1, 12)?;
+ let days_in_month = calendar::days_in_month(year, month);
+ let day_of_month = read_two_digits(value, 1, days_in_month)?;
+ let hours = read_two_digits(value, 0, 23)?;
+ let minutes = read_two_digits(value, 0, 59)?;
+ let seconds = read_two_digits(value, 0, 59)?;
+
+ let time_zone = value.read_byte().map_err(|_| Error::BadDerTime)?;
+ if time_zone != b'Z' {
+ return Err(Error::BadDerTime);
+ }
+
+ calendar::time_from_ymdhms_utc(year, month, day_of_month, hours, minutes, seconds)
+ })
+}
+
+macro_rules! oid {
+ ( $first:expr, $second:expr, $( $tail:expr ),* ) =>
+ (
+ [(40 * $first) + $second, $( $tail ),*]
+ )
+}
diff --git a/crates/webpki/src/end_entity.rs b/crates/webpki/src/end_entity.rs
new file mode 100644
index 0000000..cfe9ef1
--- /dev/null
+++ b/crates/webpki/src/end_entity.rs
@@ -0,0 +1,242 @@
+// Copyright 2015-2021 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::{
+ cert, name, signed_data, verify_cert, DnsNameRef, Error, ErrorExt, SignatureAlgorithm, Time,
+ TlsClientTrustAnchors, TlsServerTrustAnchors,
+};
+
+#[cfg(feature = "alloc")]
+use alloc::vec::Vec;
+
+/// An end-entity certificate.
+///
+/// Server certificate processing in a TLS connection consists of several
+/// steps. All of these steps are necessary:
+///
+/// * `EndEntityCert.verify_is_valid_tls_server_cert`: Verify that the server's
+/// certificate is currently valid *for use by a TLS server*.
+/// * `EndEntityCert.verify_is_valid_for_dns_name`: Verify that the server's
+/// certificate is valid for the host that is being connected to.
+/// * `EndEntityCert.verify_signature`: Verify that the signature of server's
+/// `ServerKeyExchange` message is valid for the server's certificate.
+///
+/// Client certificate processing in a TLS connection consists of analogous
+/// steps. All of these steps are necessary:
+///
+/// * `EndEntityCert.verify_is_valid_tls_client_cert`: Verify that the client's
+/// certificate is currently valid *for use by a TLS client*.
+/// * `EndEntityCert.verify_is_valid_for_dns_name` or
+/// `EndEntityCert.verify_is_valid_for_at_least_one_dns_name`: Verify that the
+/// client's certificate is valid for the identity or identities used to
+/// identify the client. (Currently client authentication only works when the
+/// client is identified by one or more DNS hostnames.)
+/// * `EndEntityCert.verify_signature`: Verify that the client's signature in
+/// its `CertificateVerify` message is valid using the public key from the
+/// client's certificate.
+///
+/// Although it would be less error-prone to combine all these steps into a
+/// single function call, some significant optimizations are possible if the
+/// three steps are processed separately (in parallel). It does not matter much
+/// which order the steps are done in, but **all of these steps must completed
+/// before application data is sent and before received application data is
+/// processed**. `EndEntityCert::from` is an inexpensive operation and is
+/// deterministic, so if these tasks are done in multiple threads, it is
+/// probably best to just call `EndEntityCert::from` multiple times (before each
+/// operation) for the same DER-encoded ASN.1 certificate bytes.
+pub struct EndEntityCert<'a> {
+ inner: cert::Cert<'a>,
+}
+
+impl<'a> core::convert::TryFrom<&'a [u8]> for EndEntityCert<'a> {
+ type Error = Error;
+
+ /// Parse the ASN.1 DER-encoded X.509 encoding of the certificate
+ /// `cert_der`.
+ fn try_from(cert_der: &'a [u8]) -> Result<Self, Self::Error> {
+ Ok(Self {
+ inner: cert::parse_cert(
+ untrusted::Input::from(cert_der),
+ cert::EndEntityOrCa::EndEntity,
+ )?,
+ })
+ }
+}
+
+impl<'a> EndEntityCert<'a> {
+ pub(super) fn inner(&self) -> &cert::Cert {
+ &self.inner
+ }
+
+ /// Backward-SemVer-compatible wrapper around `verify_is_valid_tls_server_cert_ext`.
+ ///
+ /// Errors that aren't representable as an `Error` are mapped to `Error::UnknownIssuer`.
+ pub fn verify_is_valid_tls_server_cert(
+ &self,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ trust_anchors: &TlsServerTrustAnchors,
+ intermediate_certs: &[&[u8]],
+ time: Time,
+ ) -> Result<(), Error> {
+ self.verify_is_valid_tls_server_cert_ext(
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ time,
+ )
+ .map_err(ErrorExt::into_error_lossy)
+ }
+
+ /// Verifies that the end-entity certificate is valid for use by a TLS
+ /// server.
+ ///
+ /// `supported_sig_algs` is the list of signature algorithms that are
+ /// trusted for use in certificate signatures; the end-entity certificate's
+ /// public key is not validated against this list. `trust_anchors` is the
+ /// list of root CAs to trust. `intermediate_certs` is the sequence of
+ /// intermediate certificates that the server sent in the TLS handshake.
+ /// `time` is the time for which the validation is effective (usually the
+ /// current time).
+ pub fn verify_is_valid_tls_server_cert_ext(
+ &self,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ &TlsServerTrustAnchors(trust_anchors): &TlsServerTrustAnchors,
+ intermediate_certs: &[&[u8]],
+ time: Time,
+ ) -> Result<(), ErrorExt> {
+ verify_cert::build_chain(
+ verify_cert::EKU_SERVER_AUTH,
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ &self.inner,
+ time,
+ )
+ }
+
+ /// Backward-SemVer-compatible wrapper around `verify_is_valid_tls_client_cert_ext`.
+ ///
+ /// Errors that aren't representable as an `Error` are mapped to `Error::UnknownIssuer`.
+ pub fn verify_is_valid_tls_client_cert(
+ &self,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ trust_anchors: &TlsClientTrustAnchors,
+ intermediate_certs: &[&[u8]],
+ time: Time,
+ ) -> Result<(), Error> {
+ self.verify_is_valid_tls_client_cert_ext(
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ time,
+ )
+ .map_err(ErrorExt::into_error_lossy)
+ }
+
+ /// Verifies that the end-entity certificate is valid for use by a TLS
+ /// client.
+ ///
+ /// If the certificate is not valid for any of the given names then this
+ /// fails with `Error::CertNotValidForName`.
+ ///
+ /// `supported_sig_algs` is the list of signature algorithms that are
+ /// trusted for use in certificate signatures; the end-entity certificate's
+ /// public key is not validated against this list. `trust_anchors` is the
+ /// list of root CAs to trust. `intermediate_certs` is the sequence of
+ /// intermediate certificates that the client sent in the TLS handshake.
+ /// `cert` is the purported end-entity certificate of the client. `time` is
+ /// the time for which the validation is effective (usually the current
+ /// time).
+ pub fn verify_is_valid_tls_client_cert_ext(
+ &self,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ &TlsClientTrustAnchors(trust_anchors): &TlsClientTrustAnchors,
+ intermediate_certs: &[&[u8]],
+ time: Time,
+ ) -> Result<(), ErrorExt> {
+ verify_cert::build_chain(
+ verify_cert::EKU_CLIENT_AUTH,
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ &self.inner,
+ time,
+ )
+ }
+
+ /// Verifies that the certificate is valid for the given DNS host name.
+ pub fn verify_is_valid_for_dns_name(&self, dns_name: DnsNameRef) -> Result<(), Error> {
+ name::verify_cert_dns_name(self, dns_name)
+ }
+
+ /// Verifies that the certificate is valid for at least one of the given DNS
+ /// host names.
+ ///
+ /// If the certificate is not valid for any of the given names then this
+ /// fails with `Error::CertNotValidForName`. Otherwise the DNS names for
+ /// which the certificate is valid are returned.
+ ///
+ /// Requires the `alloc` default feature; i.e. this isn't available in
+ /// `#![no_std]` configurations.
+ #[cfg(feature = "alloc")]
+ pub fn verify_is_valid_for_at_least_one_dns_name<'names, Names>(
+ &self,
+ dns_names: Names,
+ ) -> Result<Vec<DnsNameRef<'names>>, Error>
+ where
+ Names: Iterator<Item = DnsNameRef<'names>>,
+ {
+ let result: Vec<DnsNameRef<'names>> = dns_names
+ .filter(|n| self.verify_is_valid_for_dns_name(*n).is_ok())
+ .collect();
+ if result.is_empty() {
+ return Err(Error::CertNotValidForName);
+ }
+ Ok(result)
+ }
+
+ /// Verifies the signature `signature` of message `msg` using the
+ /// certificate's public key.
+ ///
+ /// `signature_alg` is the algorithm to use to
+ /// verify the signature; the certificate's public key is verified to be
+ /// compatible with this algorithm.
+ ///
+ /// For TLS 1.2, `signature` corresponds to TLS's
+ /// `DigitallySigned.signature` and `signature_alg` corresponds to TLS's
+ /// `DigitallySigned.algorithm` of TLS type `SignatureAndHashAlgorithm`. In
+ /// TLS 1.2 a single `SignatureAndHashAlgorithm` may map to multiple
+ /// `SignatureAlgorithm`s. For example, a TLS 1.2
+ /// `SignatureAndHashAlgorithm` of (ECDSA, SHA-256) may map to any or all
+ /// of {`ECDSA_P256_SHA256`, `ECDSA_P384_SHA256`}, depending on how the TLS
+ /// implementation is configured.
+ ///
+ /// For current TLS 1.3 drafts, `signature_alg` corresponds to TLS's
+ /// `algorithm` fields of type `SignatureScheme`. There is (currently) a
+ /// one-to-one correspondence between TLS 1.3's `SignatureScheme` and
+ /// `SignatureAlgorithm`.
+ pub fn verify_signature(
+ &self,
+ signature_alg: &SignatureAlgorithm,
+ msg: &[u8],
+ signature: &[u8],
+ ) -> Result<(), Error> {
+ signed_data::verify_signature(
+ signature_alg,
+ self.inner.spki.value(),
+ untrusted::Input::from(msg),
+ untrusted::Input::from(signature),
+ )
+ }
+}
diff --git a/crates/webpki/src/error.rs b/crates/webpki/src/error.rs
new file mode 100644
index 0000000..3cb7697
--- /dev/null
+++ b/crates/webpki/src/error.rs
@@ -0,0 +1,144 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use core::fmt;
+
+/// An error that occurs during certificate validation or name validation.
+#[derive(Clone, Copy, Debug, PartialEq)]
+pub enum Error {
+ /// The encoding of some ASN.1 DER-encoded item is invalid.
+ BadDer,
+
+ /// The encoding of an ASN.1 DER-encoded time is invalid.
+ BadDerTime,
+
+ /// A CA certificate is being used as an end-entity certificate.
+ CaUsedAsEndEntity,
+
+ /// The certificate is expired; i.e. the time it is being validated for is
+ /// later than the certificate's notAfter time.
+ CertExpired,
+
+ /// The certificate is not valid for the name it is being validated for.
+ CertNotValidForName,
+
+ /// The certificate is not valid yet; i.e. the time it is being validated
+ /// for is earlier than the certificate's notBefore time.
+ CertNotValidYet,
+
+ /// An end-entity certificate is being used as a CA certificate.
+ EndEntityUsedAsCa,
+
+ /// An X.509 extension is invalid.
+ ExtensionValueInvalid,
+
+ /// The certificate validity period (notBefore, notAfter) is invalid; e.g.
+ /// the notAfter time is earlier than the notBefore time.
+ InvalidCertValidity,
+
+ /// The signature is invalid for the given public key.
+ InvalidSignatureForPublicKey,
+
+ /// The certificate violates one or more name constraints.
+ NameConstraintViolation,
+
+ /// The certificate violates one or more path length constraints.
+ PathLenConstraintViolated,
+
+ /// The algorithm in the TBSCertificate "signature" field of a certificate
+ /// does not match the algorithm in the signature of the certificate.
+ SignatureAlgorithmMismatch,
+
+ /// The certificate is not valid for the Extended Key Usage for which it is
+ /// being validated.
+ RequiredEkuNotFound,
+
+ /// A valid issuer for the certificate could not be found.
+ UnknownIssuer,
+
+ /// The certificate is not a v3 X.509 certificate.
+ ///
+ /// This error may be also reported if the certificate version field
+ /// is malformed.
+ UnsupportedCertVersion,
+
+ /// The certificate extensions are missing or malformed.
+ ///
+ /// In particular, webpki requires the DNS name(s) be in the subjectAltName
+ /// extension as required by the CA/Browser Forum Baseline Requirements
+ /// and as recommended by RFC6125.
+ MissingOrMalformedExtensions,
+
+ /// The certificate contains an unsupported critical extension.
+ UnsupportedCriticalExtension,
+
+ /// The signature's algorithm does not match the algorithm of the public
+ /// key it is being validated for. This may be because the public key
+ /// algorithm's OID isn't recognized (e.g. DSA), or the public key
+ /// algorithm's parameters don't match the supported parameters for that
+ /// algorithm (e.g. ECC keys for unsupported curves), or the public key
+ /// algorithm and the signature algorithm simply don't match (e.g.
+ /// verifying an RSA signature with an ECC public key).
+ UnsupportedSignatureAlgorithmForPublicKey,
+
+ /// The signature algorithm for a signature is not in the set of supported
+ /// signature algorithms given.
+ UnsupportedSignatureAlgorithm,
+}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(f, "{:?}", self)
+ }
+}
+
+/// Requires the `std` feature.
+#[cfg(feature = "std")]
+impl ::std::error::Error for Error {}
+
+/// An error that occurs during certificate validation or name validation.
+///
+/// `ErrorExt` effectively extends `Error` to support reporting new errors. Because `Error` is not
+/// declared `#[non_exhaustive]` it could not be directly extended in a backward-compatible way.
+#[non_exhaustive]
+pub enum ErrorExt {
+ Error(Error),
+ MaximumSignatureChecksExceeded,
+ /// The maximum number of internal path building calls has been reached. Path complexity is too great.
+ MaximumPathBuildCallsExceeded,
+}
+
+impl ErrorExt {
+ pub(crate) fn is_fatal(&self) -> bool {
+ match self {
+ Self::Error(_) => false,
+ Self::MaximumSignatureChecksExceeded | Self::MaximumPathBuildCallsExceeded => true,
+ }
+ }
+
+ pub(crate) fn into_error_lossy(self) -> Error {
+ match self {
+ Self::Error(e) => e,
+ Self::MaximumSignatureChecksExceeded | Self::MaximumPathBuildCallsExceeded => {
+ Error::UnknownIssuer
+ }
+ }
+ }
+}
+
+impl From<Error> for ErrorExt {
+ fn from(error: Error) -> Self {
+ Self::Error(error)
+ }
+}
diff --git a/crates/webpki/src/lib.rs b/crates/webpki/src/lib.rs
new file mode 100644
index 0000000..40bb959
--- /dev/null
+++ b/crates/webpki/src/lib.rs
@@ -0,0 +1,103 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+//! webpki: Web PKI X.509 Certificate Validation.
+//!
+//! See `EndEntityCert`'s documentation for a description of the certificate
+//! processing steps necessary for a TLS connection.
+//!
+//! # Features
+//!
+//! | Feature | Description |
+//! | ------- | ----------- |
+//! | `alloc` | Enable features that require use of the heap. Currently all RSA signature algorithms require this feature. |
+//! | `std` | Enable features that require libstd. Implies `alloc`. |
+
+#![cfg_attr(not(feature = "std"), no_std)]
+#![allow(
+ clippy::doc_markdown,
+ clippy::if_not_else,
+ clippy::inline_always,
+ clippy::items_after_statements,
+ clippy::missing_errors_doc,
+ clippy::module_name_repetitions,
+ clippy::single_match,
+ clippy::single_match_else
+)]
+#![deny(clippy::as_conversions)]
+
+#[cfg(any(test, feature = "alloc"))]
+#[cfg_attr(test, macro_use)]
+extern crate alloc;
+
+mod budget;
+
+#[macro_use]
+mod der;
+
+mod calendar;
+mod cert;
+mod end_entity;
+mod error;
+mod name;
+mod signed_data;
+mod time;
+mod trust_anchor;
+
+mod verify_cert;
+
+pub use {
+ end_entity::EndEntityCert,
+ error::{Error, ErrorExt},
+ name::{DnsNameRef, InvalidDnsNameError},
+ signed_data::{
+ SignatureAlgorithm, ECDSA_P256_SHA256, ECDSA_P256_SHA384, ECDSA_P384_SHA256,
+ ECDSA_P384_SHA384, ED25519,
+ },
+ time::Time,
+ trust_anchor::{TlsClientTrustAnchors, TlsServerTrustAnchors, TrustAnchor},
+};
+
+#[cfg(feature = "alloc")]
+pub use {
+ name::DnsName,
+ signed_data::{
+ RSA_PKCS1_2048_8192_SHA256, RSA_PKCS1_2048_8192_SHA384, RSA_PKCS1_2048_8192_SHA512,
+ RSA_PKCS1_3072_8192_SHA384, RSA_PSS_2048_8192_SHA256_LEGACY_KEY,
+ RSA_PSS_2048_8192_SHA384_LEGACY_KEY, RSA_PSS_2048_8192_SHA512_LEGACY_KEY,
+ },
+};
+
+#[cfg(feature = "alloc")]
+#[allow(unknown_lints, clippy::upper_case_acronyms)]
+#[deprecated(note = "Use DnsName")]
+pub type DNSName = DnsName;
+
+#[deprecated(note = "use DnsNameRef")]
+#[allow(unknown_lints, clippy::upper_case_acronyms)]
+pub type DNSNameRef<'a> = DnsNameRef<'a>;
+
+#[deprecated(note = "use TlsServerTrustAnchors")]
+#[allow(unknown_lints, clippy::upper_case_acronyms)]
+pub type TLSServerTrustAnchors<'a> = TlsServerTrustAnchors<'a>;
+
+#[deprecated(note = "use TlsClientTrustAnchors")]
+#[allow(unknown_lints, clippy::upper_case_acronyms)]
+pub type TLSClientTrustAnchors<'a> = TlsClientTrustAnchors<'a>;
+
+// We don't operate on secret data so a convenient comparison function is warranted.
+#[must_use]
+fn equal(a: untrusted::Input, b: untrusted::Input) -> bool {
+ a.as_slice_less_safe() == b.as_slice_less_safe()
+}
diff --git a/crates/webpki/src/name.rs b/crates/webpki/src/name.rs
new file mode 100644
index 0000000..040a813
--- /dev/null
+++ b/crates/webpki/src/name.rs
@@ -0,0 +1,25 @@
+// Copyright 2015-2020 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+mod dns_name;
+pub use dns_name::{DnsNameRef, InvalidDnsNameError};
+
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub use dns_name::DnsName;
+
+mod ip_address;
+
+mod verify;
+pub(super) use verify::{check_name_constraints, verify_cert_dns_name};
diff --git a/crates/webpki/src/name/dns_name.rs b/crates/webpki/src/name/dns_name.rs
new file mode 100644
index 0000000..e4f18f2
--- /dev/null
+++ b/crates/webpki/src/name/dns_name.rs
@@ -0,0 +1,796 @@
+// Copyright 2015-2020 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+#[cfg(feature = "alloc")]
+use alloc::string::String;
+
+/// A DNS Name suitable for use in the TLS Server Name Indication (SNI)
+/// extension and/or for use as the reference hostname for which to verify a
+/// certificate.
+///
+/// A `DnsName` is guaranteed to be syntactically valid. The validity rules are
+/// specified in [RFC 5280 Section 7.2], except that underscores are also
+/// allowed.
+///
+/// `DnsName` stores a copy of the input it was constructed from in a `String`
+/// and so it is only available when the `std` default feature is enabled.
+///
+/// `Eq`, `PartialEq`, etc. are not implemented because name comparison
+/// frequently should be done case-insensitively and/or with other caveats that
+/// depend on the specific circumstances in which the comparison is done.
+///
+/// [RFC 5280 Section 7.2]: https://tools.ietf.org/html/rfc5280#section-7.2
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+#[derive(Clone, Debug, Eq, PartialEq, Hash)]
+pub struct DnsName(String);
+
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+impl DnsName {
+ /// Returns a `DnsNameRef` that refers to this `DnsName`.
+ pub fn as_ref(&self) -> DnsNameRef {
+ DnsNameRef(self.0.as_bytes())
+ }
+}
+
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+impl AsRef<str> for DnsName {
+ fn as_ref(&self) -> &str {
+ self.0.as_ref()
+ }
+}
+
+/// Requires the `alloc` feature.
+// Deprecated
+#[cfg(feature = "alloc")]
+impl From<DnsNameRef<'_>> for DnsName {
+ fn from(dns_name: DnsNameRef) -> Self {
+ dns_name.to_owned()
+ }
+}
+
+/// A reference to a DNS Name suitable for use in the TLS Server Name Indication
+/// (SNI) extension and/or for use as the reference hostname for which to verify
+/// a certificate.
+///
+/// A `DnsNameRef` is guaranteed to be syntactically valid. The validity rules
+/// are specified in [RFC 5280 Section 7.2], except that underscores are also
+/// allowed.
+///
+/// `Eq`, `PartialEq`, etc. are not implemented because name comparison
+/// frequently should be done case-insensitively and/or with other caveats that
+/// depend on the specific circumstances in which the comparison is done.
+///
+/// [RFC 5280 Section 7.2]: https://tools.ietf.org/html/rfc5280#section-7.2
+#[derive(Clone, Copy)]
+pub struct DnsNameRef<'a>(&'a [u8]);
+
+impl AsRef<[u8]> for DnsNameRef<'_> {
+ #[inline]
+ fn as_ref(&self) -> &[u8] {
+ self.0
+ }
+}
+
+/// An error indicating that a `DnsNameRef` could not built because the input
+/// is not a syntactically-valid DNS Name.
+#[derive(Clone, Copy, Debug, Eq, PartialEq)]
+pub struct InvalidDnsNameError;
+
+impl core::fmt::Display for InvalidDnsNameError {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
+ write!(f, "{:?}", self)
+ }
+}
+
+/// Requires the `std` feature.
+#[cfg(feature = "std")]
+impl ::std::error::Error for InvalidDnsNameError {}
+
+impl<'a> DnsNameRef<'a> {
+ /// Constructs a `DnsNameRef` from the given input if the input is a
+ /// syntactically-valid DNS name.
+ pub fn try_from_ascii(dns_name: &'a [u8]) -> Result<Self, InvalidDnsNameError> {
+ if !is_valid_reference_dns_id(untrusted::Input::from(dns_name)) {
+ return Err(InvalidDnsNameError);
+ }
+
+ Ok(Self(dns_name))
+ }
+
+ /// Constructs a `DnsNameRef` from the given input if the input is a
+ /// syntactically-valid DNS name.
+ pub fn try_from_ascii_str(dns_name: &'a str) -> Result<Self, InvalidDnsNameError> {
+ Self::try_from_ascii(dns_name.as_bytes())
+ }
+
+ /// Constructs a `DnsName` from this `DnsNameRef`
+ ///
+ /// Requires the `alloc` feature.
+ #[cfg(feature = "alloc")]
+ pub fn to_owned(&self) -> DnsName {
+ // DnsNameRef is already guaranteed to be valid ASCII, which is a
+ // subset of UTF-8.
+ let s: &str = (*self).into();
+ DnsName(s.to_ascii_lowercase())
+ }
+}
+
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+impl core::fmt::Debug for DnsNameRef<'_> {
+ fn fmt(&self, f: &mut core::fmt::Formatter) -> Result<(), core::fmt::Error> {
+ let lowercase = self.clone().to_owned();
+ f.debug_tuple("DnsNameRef").field(&lowercase.0).finish()
+ }
+}
+
+impl<'a> From<DnsNameRef<'a>> for &'a str {
+ fn from(DnsNameRef(d): DnsNameRef<'a>) -> Self {
+ // The unwrap won't fail because DnsNameRefs are guaranteed to be ASCII
+ // and ASCII is a subset of UTF-8.
+ core::str::from_utf8(d).unwrap()
+ }
+}
+
+pub(super) fn presented_id_matches_reference_id(
+ presented_dns_id: untrusted::Input,
+ reference_dns_id: untrusted::Input,
+) -> Option<bool> {
+ presented_id_matches_reference_id_internal(
+ presented_dns_id,
+ IdRole::Reference,
+ reference_dns_id,
+ )
+}
+
+pub(super) fn presented_id_matches_constraint(
+ presented_dns_id: untrusted::Input,
+ reference_dns_id: untrusted::Input,
+) -> Option<bool> {
+ presented_id_matches_reference_id_internal(
+ presented_dns_id,
+ IdRole::NameConstraint,
+ reference_dns_id,
+ )
+}
+
+// We do not distinguish between a syntactically-invalid presented_dns_id and
+// one that is syntactically valid but does not match reference_dns_id; in both
+// cases, the result is false.
+//
+// We assume that both presented_dns_id and reference_dns_id are encoded in
+// such a way that US-ASCII (7-bit) characters are encoded in one byte and no
+// encoding of a non-US-ASCII character contains a code point in the range
+// 0-127. For example, UTF-8 is OK but UTF-16 is not.
+//
+// RFC6125 says that a wildcard label may be of the form <x>*<y>.<DNSID>, where
+// <x> and/or <y> may be empty. However, NSS requires <y> to be empty, and we
+// follow NSS's stricter policy by accepting wildcards only of the form
+// <x>*.<DNSID>, where <x> may be empty.
+//
+// An relative presented DNS ID matches both an absolute reference ID and a
+// relative reference ID. Absolute presented DNS IDs are not supported:
+//
+// Presented ID Reference ID Result
+// -------------------------------------
+// example.com example.com Match
+// example.com. example.com Mismatch
+// example.com example.com. Match
+// example.com. example.com. Mismatch
+//
+// There are more subtleties documented inline in the code.
+//
+// Name constraints ///////////////////////////////////////////////////////////
+//
+// This is all RFC 5280 has to say about dNSName constraints:
+//
+// DNS name restrictions are expressed as host.example.com. Any DNS
+// name that can be constructed by simply adding zero or more labels to
+// the left-hand side of the name satisfies the name constraint. For
+// example, www.host.example.com would satisfy the constraint but
+// host1.example.com would not.
+//
+// This lack of specificity has lead to a lot of uncertainty regarding
+// subdomain matching. In particular, the following questions have been
+// raised and answered:
+//
+// Q: Does a presented identifier equal (case insensitive) to the name
+// constraint match the constraint? For example, does the presented
+// ID "host.example.com" match a "host.example.com" constraint?
+// A: Yes. RFC5280 says "by simply adding zero or more labels" and this
+// is the case of adding zero labels.
+//
+// Q: When the name constraint does not start with ".", do subdomain
+// presented identifiers match it? For example, does the presented
+// ID "www.host.example.com" match a "host.example.com" constraint?
+// A: Yes. RFC5280 says "by simply adding zero or more labels" and this
+// is the case of adding more than zero labels. The example is the
+// one from RFC 5280.
+//
+// Q: When the name constraint does not start with ".", does a
+// non-subdomain prefix match it? For example, does "bigfoo.bar.com"
+// match "foo.bar.com"? [4]
+// A: No. We interpret RFC 5280's language of "adding zero or more labels"
+// to mean that whole labels must be prefixed.
+//
+// (Note that the above three scenarios are the same as the RFC 6265
+// domain matching rules [0].)
+//
+// Q: Is a name constraint that starts with "." valid, and if so, what
+// semantics does it have? For example, does a presented ID of
+// "www.example.com" match a constraint of ".example.com"? Does a
+// presented ID of "example.com" match a constraint of ".example.com"?
+// A: This implementation, NSS[1], and SChannel[2] all support a
+// leading ".", but OpenSSL[3] does not yet. Amongst the
+// implementations that support it, a leading "." is legal and means
+// the same thing as when the "." is omitted, EXCEPT that a
+// presented identifier equal (case insensitive) to the name
+// constraint is not matched; i.e. presented dNSName identifiers
+// must be subdomains. Some CAs in Mozilla's CA program (e.g. HARICA)
+// have name constraints with the leading "." in their root
+// certificates. The name constraints imposed on DCISS by Mozilla also
+// have the it, so supporting this is a requirement for backward
+// compatibility, even if it is not yet standardized. So, for example, a
+// presented ID of "www.example.com" matches a constraint of
+// ".example.com" but a presented ID of "example.com" does not.
+//
+// Q: Is there a way to prevent subdomain matches?
+// A: Yes.
+//
+// Some people have proposed that dNSName constraints that do not
+// start with a "." should be restricted to exact (case insensitive)
+// matches. However, such a change of semantics from what RFC5280
+// specifies would be a non-backward-compatible change in the case of
+// permittedSubtrees constraints, and it would be a security issue for
+// excludedSubtrees constraints.
+//
+// However, it can be done with a combination of permittedSubtrees and
+// excludedSubtrees, e.g. "example.com" in permittedSubtrees and
+// ".example.com" in excludedSubtrees.
+//
+// Q: Are name constraints allowed to be specified as absolute names?
+// For example, does a presented ID of "example.com" match a name
+// constraint of "example.com." and vice versa.
+// A: Absolute names are not supported as presented IDs or name
+// constraints. Only reference IDs may be absolute.
+//
+// Q: Is "" a valid dNSName constraint? If so, what does it mean?
+// A: Yes. Any valid presented dNSName can be formed "by simply adding zero
+// or more labels to the left-hand side" of "". In particular, an
+// excludedSubtrees dNSName constraint of "" forbids all dNSNames.
+//
+// Q: Is "." a valid dNSName constraint? If so, what does it mean?
+// A: No, because absolute names are not allowed (see above).
+//
+// [0] RFC 6265 (Cookies) Domain Matching rules:
+// http://tools.ietf.org/html/rfc6265#section-5.1.3
+// [1] NSS source code:
+// https://mxr.mozilla.org/nss/source/lib/certdb/genname.c?rev=2a7348f013cb#1209
+// [2] Description of SChannel's behavior from Microsoft:
+// http://www.imc.org/ietf-pkix/mail-archive/msg04668.html
+// [3] Proposal to add such support to OpenSSL:
+// http://www.mail-archive.com/openssl-dev%40openssl.org/msg36204.html
+// https://rt.openssl.org/Ticket/Display.html?id=3562
+// [4] Feedback on the lack of clarify in the definition that never got
+// incorporated into the spec:
+// https://www.ietf.org/mail-archive/web/pkix/current/msg21192.html
+fn presented_id_matches_reference_id_internal(
+ presented_dns_id: untrusted::Input,
+ reference_dns_id_role: IdRole,
+ reference_dns_id: untrusted::Input,
+) -> Option<bool> {
+ if !is_valid_dns_id(presented_dns_id, IdRole::Presented, AllowWildcards::Yes) {
+ return None;
+ }
+
+ if !is_valid_dns_id(reference_dns_id, reference_dns_id_role, AllowWildcards::No) {
+ return None;
+ }
+
+ let mut presented = untrusted::Reader::new(presented_dns_id);
+ let mut reference = untrusted::Reader::new(reference_dns_id);
+
+ match reference_dns_id_role {
+ IdRole::Reference => (),
+
+ IdRole::NameConstraint if presented_dns_id.len() > reference_dns_id.len() => {
+ if reference_dns_id.is_empty() {
+ // An empty constraint matches everything.
+ return Some(true);
+ }
+
+ // If the reference ID starts with a dot then skip the prefix of
+ // the presented ID and start the comparison at the position of
+ // that dot. Examples:
+ //
+ // Matches Doesn't Match
+ // -----------------------------------------------------------
+ // original presented ID: www.example.com badexample.com
+ // skipped: www ba
+ // presented ID w/o prefix: .example.com dexample.com
+ // reference ID: .example.com .example.com
+ //
+ // If the reference ID does not start with a dot then we skip
+ // the prefix of the presented ID but also verify that the
+ // prefix ends with a dot. Examples:
+ //
+ // Matches Doesn't Match
+ // -----------------------------------------------------------
+ // original presented ID: www.example.com badexample.com
+ // skipped: www ba
+ // must be '.': . d
+ // presented ID w/o prefix: example.com example.com
+ // reference ID: example.com example.com
+ //
+ if reference.peek(b'.') {
+ if presented
+ .skip(presented_dns_id.len() - reference_dns_id.len())
+ .is_err()
+ {
+ unreachable!();
+ }
+ } else {
+ if presented
+ .skip(presented_dns_id.len() - reference_dns_id.len() - 1)
+ .is_err()
+ {
+ unreachable!();
+ }
+ if presented.read_byte() != Ok(b'.') {
+ return Some(false);
+ }
+ }
+ }
+
+ IdRole::NameConstraint => (),
+
+ IdRole::Presented => unreachable!(),
+ }
+
+ // Only allow wildcard labels that consist only of '*'.
+ if presented.peek(b'*') {
+ if presented.skip(1).is_err() {
+ unreachable!();
+ }
+
+ loop {
+ if reference.read_byte().is_err() {
+ return Some(false);
+ }
+ if reference.peek(b'.') {
+ break;
+ }
+ }
+ }
+
+ loop {
+ let presented_byte = match (presented.read_byte(), reference.read_byte()) {
+ (Ok(p), Ok(r)) if ascii_lower(p) == ascii_lower(r) => p,
+ _ => {
+ return Some(false);
+ }
+ };
+
+ if presented.at_end() {
+ // Don't allow presented IDs to be absolute.
+ if presented_byte == b'.' {
+ return None;
+ }
+ break;
+ }
+ }
+
+ // Allow a relative presented DNS ID to match an absolute reference DNS ID,
+ // unless we're matching a name constraint.
+ if !reference.at_end() {
+ if reference_dns_id_role != IdRole::NameConstraint {
+ match reference.read_byte() {
+ Ok(b'.') => (),
+ _ => {
+ return Some(false);
+ }
+ };
+ }
+ if !reference.at_end() {
+ return Some(false);
+ }
+ }
+
+ assert!(presented.at_end());
+ assert!(reference.at_end());
+
+ Some(true)
+}
+
+#[inline]
+fn ascii_lower(b: u8) -> u8 {
+ match b {
+ b'A'..=b'Z' => b + b'a' - b'A',
+ _ => b,
+ }
+}
+
+#[derive(Clone, Copy, PartialEq)]
+enum AllowWildcards {
+ No,
+ Yes,
+}
+
+#[derive(Clone, Copy, PartialEq)]
+enum IdRole {
+ Reference,
+ Presented,
+ NameConstraint,
+}
+
+fn is_valid_reference_dns_id(hostname: untrusted::Input) -> bool {
+ is_valid_dns_id(hostname, IdRole::Reference, AllowWildcards::No)
+}
+
+// https://tools.ietf.org/html/rfc5280#section-4.2.1.6:
+//
+// When the subjectAltName extension contains a domain name system
+// label, the domain name MUST be stored in the dNSName (an IA5String).
+// The name MUST be in the "preferred name syntax", as specified by
+// Section 3.5 of [RFC1034] and as modified by Section 2.1 of
+// [RFC1123].
+//
+// https://bugzilla.mozilla.org/show_bug.cgi?id=1136616: As an exception to the
+// requirement above, underscores are also allowed in names for compatibility.
+fn is_valid_dns_id(
+ hostname: untrusted::Input,
+ id_role: IdRole,
+ allow_wildcards: AllowWildcards,
+) -> bool {
+ // https://blogs.msdn.microsoft.com/oldnewthing/20120412-00/?p=7873/
+ if hostname.len() > 253 {
+ return false;
+ }
+
+ let mut input = untrusted::Reader::new(hostname);
+
+ if id_role == IdRole::NameConstraint && input.at_end() {
+ return true;
+ }
+
+ let mut dot_count = 0;
+ let mut label_length = 0;
+ let mut label_is_all_numeric = false;
+ let mut label_ends_with_hyphen = false;
+
+ // Only presented IDs are allowed to have wildcard labels. And, like
+ // Chromium, be stricter than RFC 6125 requires by insisting that a
+ // wildcard label consist only of '*'.
+ let is_wildcard = allow_wildcards == AllowWildcards::Yes && input.peek(b'*');
+ let mut is_first_byte = !is_wildcard;
+ if is_wildcard {
+ if input.read_byte() != Ok(b'*') || input.read_byte() != Ok(b'.') {
+ return false;
+ }
+ dot_count += 1;
+ }
+
+ loop {
+ const MAX_LABEL_LENGTH: usize = 63;
+
+ match input.read_byte() {
+ Ok(b'-') => {
+ if label_length == 0 {
+ return false; // Labels must not start with a hyphen.
+ }
+ label_is_all_numeric = false;
+ label_ends_with_hyphen = true;
+ label_length += 1;
+ if label_length > MAX_LABEL_LENGTH {
+ return false;
+ }
+ }
+
+ Ok(b'0'..=b'9') => {
+ if label_length == 0 {
+ label_is_all_numeric = true;
+ }
+ label_ends_with_hyphen = false;
+ label_length += 1;
+ if label_length > MAX_LABEL_LENGTH {
+ return false;
+ }
+ }
+
+ Ok(b'a'..=b'z') | Ok(b'A'..=b'Z') | Ok(b'_') => {
+ label_is_all_numeric = false;
+ label_ends_with_hyphen = false;
+ label_length += 1;
+ if label_length > MAX_LABEL_LENGTH {
+ return false;
+ }
+ }
+
+ Ok(b'.') => {
+ dot_count += 1;
+ if label_length == 0 && (id_role != IdRole::NameConstraint || !is_first_byte) {
+ return false;
+ }
+ if label_ends_with_hyphen {
+ return false; // Labels must not end with a hyphen.
+ }
+ label_length = 0;
+ }
+
+ _ => {
+ return false;
+ }
+ }
+ is_first_byte = false;
+
+ if input.at_end() {
+ break;
+ }
+ }
+
+ // Only reference IDs, not presented IDs or name constraints, may be
+ // absolute.
+ if label_length == 0 && id_role != IdRole::Reference {
+ return false;
+ }
+
+ if label_ends_with_hyphen {
+ return false; // Labels must not end with a hyphen.
+ }
+
+ if label_is_all_numeric {
+ return false; // Last label must not be all numeric.
+ }
+
+ if is_wildcard {
+ // If the DNS ID ends with a dot, the last dot signifies an absolute ID.
+ let label_count = if label_length == 0 {
+ dot_count
+ } else {
+ dot_count + 1
+ };
+
+ // Like NSS, require at least two labels to follow the wildcard label.
+ // TODO: Allow the TrustDomain to control this on a per-eTLD+1 basis,
+ // similar to Chromium. Even then, it might be better to still enforce
+ // that there are at least two labels after the wildcard.
+ if label_count < 3 {
+ return false;
+ }
+ }
+
+ true
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ const PRESENTED_MATCHES_REFERENCE: &[(&[u8], &[u8], Option<bool>)] = &[
+ (b"", b"a", None),
+ (b"a", b"a", Some(true)),
+ (b"b", b"a", Some(false)),
+ (b"*.b.a", b"c.b.a", Some(true)),
+ (b"*.b.a", b"b.a", Some(false)),
+ (b"*.b.a", b"b.a.", Some(false)),
+ // Wildcard not in leftmost label
+ (b"d.c.b.a", b"d.c.b.a", Some(true)),
+ (b"d.*.b.a", b"d.c.b.a", None),
+ (b"d.c*.b.a", b"d.c.b.a", None),
+ (b"d.c*.b.a", b"d.cc.b.a", None),
+ // case sensitivity
+ (
+ b"abcdefghijklmnopqrstuvwxyz",
+ b"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ Some(true),
+ ),
+ (
+ b"ABCDEFGHIJKLMNOPQRSTUVWXYZ",
+ b"abcdefghijklmnopqrstuvwxyz",
+ Some(true),
+ ),
+ (b"aBc", b"Abc", Some(true)),
+ // digits
+ (b"a1", b"a1", Some(true)),
+ // A trailing dot indicates an absolute name, and absolute names can match
+ // relative names, and vice-versa.
+ (b"example", b"example", Some(true)),
+ (b"example.", b"example.", None),
+ (b"example", b"example.", Some(true)),
+ (b"example.", b"example", None),
+ (b"example.com", b"example.com", Some(true)),
+ (b"example.com.", b"example.com.", None),
+ (b"example.com", b"example.com.", Some(true)),
+ (b"example.com.", b"example.com", None),
+ (b"example.com..", b"example.com.", None),
+ (b"example.com..", b"example.com", None),
+ (b"example.com...", b"example.com.", None),
+ // xn-- IDN prefix
+ (b"x*.b.a", b"xa.b.a", None),
+ (b"x*.b.a", b"xna.b.a", None),
+ (b"x*.b.a", b"xn-a.b.a", None),
+ (b"x*.b.a", b"xn--a.b.a", None),
+ (b"xn*.b.a", b"xn--a.b.a", None),
+ (b"xn-*.b.a", b"xn--a.b.a", None),
+ (b"xn--*.b.a", b"xn--a.b.a", None),
+ (b"xn*.b.a", b"xn--a.b.a", None),
+ (b"xn-*.b.a", b"xn--a.b.a", None),
+ (b"xn--*.b.a", b"xn--a.b.a", None),
+ (b"xn---*.b.a", b"xn--a.b.a", None),
+ // "*" cannot expand to nothing.
+ (b"c*.b.a", b"c.b.a", None),
+ // --------------------------------------------------------------------------
+ // The rest of these are test cases adapted from Chromium's
+ // x509_certificate_unittest.cc. The parameter order is the opposite in
+ // Chromium's tests. Also, they some tests were modified to fit into this
+ // framework or due to intentional differences between mozilla::pkix and
+ // Chromium.
+ (b"foo.com", b"foo.com", Some(true)),
+ (b"f", b"f", Some(true)),
+ (b"i", b"h", Some(false)),
+ (b"*.foo.com", b"bar.foo.com", Some(true)),
+ (b"*.test.fr", b"www.test.fr", Some(true)),
+ (b"*.test.FR", b"wwW.tESt.fr", Some(true)),
+ (b".uk", b"f.uk", None),
+ (b"?.bar.foo.com", b"w.bar.foo.com", None),
+ (b"(www|ftp).foo.com", b"www.foo.com", None), // regex!
+ (b"www.foo.com\0", b"www.foo.com", None),
+ (b"www.foo.com\0*.foo.com", b"www.foo.com", None),
+ (b"ww.house.example", b"www.house.example", Some(false)),
+ (b"www.test.org", b"test.org", Some(false)),
+ (b"*.test.org", b"test.org", Some(false)),
+ (b"*.org", b"test.org", None),
+ // '*' must be the only character in the wildcard label
+ (b"w*.bar.foo.com", b"w.bar.foo.com", None),
+ (b"ww*ww.bar.foo.com", b"www.bar.foo.com", None),
+ (b"ww*ww.bar.foo.com", b"wwww.bar.foo.com", None),
+ (b"w*w.bar.foo.com", b"wwww.bar.foo.com", None),
+ (b"w*w.bar.foo.c0m", b"wwww.bar.foo.com", None),
+ (b"wa*.bar.foo.com", b"WALLY.bar.foo.com", None),
+ (b"*Ly.bar.foo.com", b"wally.bar.foo.com", None),
+ // Chromium does URL decoding of the reference ID, but we don't, and we also
+ // require that the reference ID is valid, so we can't test these two.
+ // (b"www.foo.com", b"ww%57.foo.com", Some(true)),
+ // (b"www&.foo.com", b"www%26.foo.com", Some(true)),
+ (b"*.test.de", b"www.test.co.jp", Some(false)),
+ (b"*.jp", b"www.test.co.jp", None),
+ (b"www.test.co.uk", b"www.test.co.jp", Some(false)),
+ (b"www.*.co.jp", b"www.test.co.jp", None),
+ (b"www.bar.foo.com", b"www.bar.foo.com", Some(true)),
+ (b"*.foo.com", b"www.bar.foo.com", Some(false)),
+ (b"*.*.foo.com", b"www.bar.foo.com", None),
+ // Our matcher requires the reference ID to be a valid DNS name, so we cannot
+ // test this case.
+ // (b"*.*.bar.foo.com", b"*..bar.foo.com", Some(false)),
+ (b"www.bath.org", b"www.bath.org", Some(true)),
+ // Our matcher requires the reference ID to be a valid DNS name, so we cannot
+ // test these cases.
+ // DNS_ID_MISMATCH("www.bath.org", ""),
+ // (b"www.bath.org", b"20.30.40.50", Some(false)),
+ // (b"www.bath.org", b"66.77.88.99", Some(false)),
+
+ // IDN tests
+ (
+ b"xn--poema-9qae5a.com.br",
+ b"xn--poema-9qae5a.com.br",
+ Some(true),
+ ),
+ (
+ b"*.xn--poema-9qae5a.com.br",
+ b"www.xn--poema-9qae5a.com.br",
+ Some(true),
+ ),
+ (
+ b"*.xn--poema-9qae5a.com.br",
+ b"xn--poema-9qae5a.com.br",
+ Some(false),
+ ),
+ (b"xn--poema-*.com.br", b"xn--poema-9qae5a.com.br", None),
+ (b"xn--*-9qae5a.com.br", b"xn--poema-9qae5a.com.br", None),
+ (b"*--poema-9qae5a.com.br", b"xn--poema-9qae5a.com.br", None),
+ // The following are adapted from the examples quoted from
+ // http://tools.ietf.org/html/rfc6125#section-6.4.3
+ // (e.g., *.example.com would match foo.example.com but
+ // not bar.foo.example.com or example.com).
+ (b"*.example.com", b"foo.example.com", Some(true)),
+ (b"*.example.com", b"bar.foo.example.com", Some(false)),
+ (b"*.example.com", b"example.com", Some(false)),
+ (b"baz*.example.net", b"baz1.example.net", None),
+ (b"*baz.example.net", b"foobaz.example.net", None),
+ (b"b*z.example.net", b"buzz.example.net", None),
+ // Wildcards should not be valid for public registry controlled domains,
+ // and unknown/unrecognized domains, at least three domain components must
+ // be present. For mozilla::pkix and NSS, there must always be at least two
+ // labels after the wildcard label.
+ (b"*.test.example", b"www.test.example", Some(true)),
+ (b"*.example.co.uk", b"test.example.co.uk", Some(true)),
+ (b"*.example", b"test.example", None),
+ // The result is different than Chromium, because Chromium takes into account
+ // the additional knowledge it has that "co.uk" is a TLD. mozilla::pkix does
+ // not know that.
+ (b"*.co.uk", b"example.co.uk", Some(true)),
+ (b"*.com", b"foo.com", None),
+ (b"*.us", b"foo.us", None),
+ (b"*", b"foo", None),
+ // IDN variants of wildcards and registry controlled domains.
+ (
+ b"*.xn--poema-9qae5a.com.br",
+ b"www.xn--poema-9qae5a.com.br",
+ Some(true),
+ ),
+ (
+ b"*.example.xn--mgbaam7a8h",
+ b"test.example.xn--mgbaam7a8h",
+ Some(true),
+ ),
+ // RFC6126 allows this, and NSS accepts it, but Chromium disallows it.
+ // TODO: File bug against Chromium.
+ (b"*.com.br", b"xn--poema-9qae5a.com.br", Some(true)),
+ (b"*.xn--mgbaam7a8h", b"example.xn--mgbaam7a8h", None),
+ // Wildcards should be permissible for 'private' registry-controlled
+ // domains. (In mozilla::pkix, we do not know if it is a private registry-
+ // controlled domain or not.)
+ (b"*.appspot.com", b"www.appspot.com", Some(true)),
+ (b"*.s3.amazonaws.com", b"foo.s3.amazonaws.com", Some(true)),
+ // Multiple wildcards are not valid.
+ (b"*.*.com", b"foo.example.com", None),
+ (b"*.bar.*.com", b"foo.bar.example.com", None),
+ // Absolute vs relative DNS name tests. Although not explicitly specified
+ // in RFC 6125, absolute reference names (those ending in a .) should
+ // match either absolute or relative presented names.
+ // TODO: File errata against RFC 6125 about this.
+ (b"foo.com.", b"foo.com", None),
+ (b"foo.com", b"foo.com.", Some(true)),
+ (b"foo.com.", b"foo.com.", None),
+ (b"f.", b"f", None),
+ (b"f", b"f.", Some(true)),
+ (b"f.", b"f.", None),
+ (b"*.bar.foo.com.", b"www-3.bar.foo.com", None),
+ (b"*.bar.foo.com", b"www-3.bar.foo.com.", Some(true)),
+ (b"*.bar.foo.com.", b"www-3.bar.foo.com.", None),
+ // We require the reference ID to be a valid DNS name, so we cannot test this
+ // case.
+ // (b".", b".", Some(false)),
+ (b"*.com.", b"example.com", None),
+ (b"*.com", b"example.com.", None),
+ (b"*.com.", b"example.com.", None),
+ (b"*.", b"foo.", None),
+ (b"*.", b"foo", None),
+ // The result is different than Chromium because we don't know that co.uk is
+ // a TLD.
+ (b"*.co.uk.", b"foo.co.uk", None),
+ (b"*.co.uk.", b"foo.co.uk.", None),
+ ];
+
+ #[test]
+ fn presented_matches_reference_test() {
+ for &(presented, reference, expected_result) in PRESENTED_MATCHES_REFERENCE {
+ let actual_result = presented_id_matches_reference_id(
+ untrusted::Input::from(presented),
+ untrusted::Input::from(reference),
+ );
+ assert_eq!(
+ actual_result,
+ expected_result,
+ "presented_dns_id_matches_reference_dns_id(\"{:?}\", IDRole::ReferenceID, \"{:?}\")",
+ presented,
+ reference
+ );
+ }
+ }
+}
diff --git a/crates/webpki/src/name/ip_address.rs b/crates/webpki/src/name/ip_address.rs
new file mode 100644
index 0000000..fac5362
--- /dev/null
+++ b/crates/webpki/src/name/ip_address.rs
@@ -0,0 +1,64 @@
+// Copyright 2015-2020 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::Error;
+
+// https://tools.ietf.org/html/rfc5280#section-4.2.1.10 says:
+//
+// For IPv4 addresses, the iPAddress field of GeneralName MUST contain
+// eight (8) octets, encoded in the style of RFC 4632 (CIDR) to represent
+// an address range [RFC4632]. For IPv6 addresses, the iPAddress field
+// MUST contain 32 octets similarly encoded. For example, a name
+// constraint for "class C" subnet 192.0.2.0 is represented as the
+// octets C0 00 02 00 FF FF FF 00, representing the CIDR notation
+// 192.0.2.0/24 (mask 255.255.255.0).
+pub(super) fn presented_id_matches_constraint(
+ name: untrusted::Input,
+ constraint: untrusted::Input,
+) -> Result<bool, Error> {
+ if name.len() != 4 && name.len() != 16 {
+ return Err(Error::BadDer);
+ }
+ if constraint.len() != 8 && constraint.len() != 32 {
+ return Err(Error::BadDer);
+ }
+
+ // an IPv4 address never matches an IPv6 constraint, and vice versa.
+ if name.len() * 2 != constraint.len() {
+ return Ok(false);
+ }
+
+ let (constraint_address, constraint_mask) = constraint.read_all(Error::BadDer, |value| {
+ let address = value.read_bytes(constraint.len() / 2).unwrap();
+ let mask = value.read_bytes(constraint.len() / 2).unwrap();
+ Ok((address, mask))
+ })?;
+
+ let mut name = untrusted::Reader::new(name);
+ let mut constraint_address = untrusted::Reader::new(constraint_address);
+ let mut constraint_mask = untrusted::Reader::new(constraint_mask);
+ loop {
+ let name_byte = name.read_byte().unwrap();
+ let constraint_address_byte = constraint_address.read_byte().unwrap();
+ let constraint_mask_byte = constraint_mask.read_byte().unwrap();
+ if ((name_byte ^ constraint_address_byte) & constraint_mask_byte) != 0 {
+ return Ok(false);
+ }
+ if name.at_end() {
+ break;
+ }
+ }
+
+ Ok(true)
+}
diff --git a/crates/webpki/src/name/verify.rs b/crates/webpki/src/name/verify.rs
new file mode 100644
index 0000000..699aea2
--- /dev/null
+++ b/crates/webpki/src/name/verify.rs
@@ -0,0 +1,328 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use super::{
+ dns_name::{self, DnsNameRef},
+ ip_address,
+};
+use crate::{
+ cert::{Cert, EndEntityOrCa},
+ der, equal, Error,
+};
+
+pub fn verify_cert_dns_name(
+ cert: &crate::EndEntityCert,
+ dns_name: DnsNameRef,
+) -> Result<(), Error> {
+ let cert = cert.inner();
+ let dns_name = untrusted::Input::from(dns_name.as_ref());
+ iterate_names(
+ cert.subject,
+ cert.subject_alt_name,
+ Err(Error::CertNotValidForName),
+ &|name| {
+ match name {
+ GeneralName::DnsName(presented_id) => {
+ match dns_name::presented_id_matches_reference_id(presented_id, dns_name) {
+ Some(true) => {
+ return NameIteration::Stop(Ok(()));
+ }
+ Some(false) => (),
+ None => {
+ return NameIteration::Stop(Err(Error::BadDer));
+ }
+ }
+ }
+ _ => (),
+ }
+ NameIteration::KeepGoing
+ },
+ )
+}
+
+// https://tools.ietf.org/html/rfc5280#section-4.2.1.10
+pub fn check_name_constraints(
+ input: Option<&mut untrusted::Reader>,
+ subordinate_certs: &Cert,
+) -> Result<(), Error> {
+ let input = match input {
+ Some(input) => input,
+ None => {
+ return Ok(());
+ }
+ };
+
+ fn parse_subtrees<'b>(
+ inner: &mut untrusted::Reader<'b>,
+ subtrees_tag: der::Tag,
+ ) -> Result<Option<untrusted::Input<'b>>, Error> {
+ if !inner.peek(subtrees_tag.into()) {
+ return Ok(None);
+ }
+ let subtrees = der::nested(inner, subtrees_tag, Error::BadDer, |tagged| {
+ der::expect_tag_and_get_value(tagged, der::Tag::Sequence)
+ })?;
+ Ok(Some(subtrees))
+ }
+
+ let permitted_subtrees = parse_subtrees(input, der::Tag::ContextSpecificConstructed0)?;
+ let excluded_subtrees = parse_subtrees(input, der::Tag::ContextSpecificConstructed1)?;
+
+ let mut child = subordinate_certs;
+ loop {
+ iterate_names(child.subject, child.subject_alt_name, Ok(()), &|name| {
+ check_presented_id_conforms_to_constraints(name, permitted_subtrees, excluded_subtrees)
+ })?;
+
+ child = match child.ee_or_ca {
+ EndEntityOrCa::Ca(child_cert) => child_cert,
+ EndEntityOrCa::EndEntity => {
+ break;
+ }
+ };
+ }
+
+ Ok(())
+}
+
+fn check_presented_id_conforms_to_constraints(
+ name: GeneralName,
+ permitted_subtrees: Option<untrusted::Input>,
+ excluded_subtrees: Option<untrusted::Input>,
+) -> NameIteration {
+ match check_presented_id_conforms_to_constraints_in_subtree(
+ name,
+ Subtrees::PermittedSubtrees,
+ permitted_subtrees,
+ ) {
+ stop @ NameIteration::Stop(..) => {
+ return stop;
+ }
+ NameIteration::KeepGoing => (),
+ };
+
+ check_presented_id_conforms_to_constraints_in_subtree(
+ name,
+ Subtrees::ExcludedSubtrees,
+ excluded_subtrees,
+ )
+}
+
+#[derive(Clone, Copy)]
+enum Subtrees {
+ PermittedSubtrees,
+ ExcludedSubtrees,
+}
+
+fn check_presented_id_conforms_to_constraints_in_subtree(
+ name: GeneralName,
+ subtrees: Subtrees,
+ constraints: Option<untrusted::Input>,
+) -> NameIteration {
+ let mut constraints = match constraints {
+ Some(constraints) => untrusted::Reader::new(constraints),
+ None => {
+ return NameIteration::KeepGoing;
+ }
+ };
+
+ let mut has_permitted_subtrees_match = false;
+ let mut has_permitted_subtrees_mismatch = false;
+
+ loop {
+ // http://tools.ietf.org/html/rfc5280#section-4.2.1.10: "Within this
+ // profile, the minimum and maximum fields are not used with any name
+ // forms, thus, the minimum MUST be zero, and maximum MUST be absent."
+ //
+ // Since the default value isn't allowed to be encoded according to the
+ // DER encoding rules for DEFAULT, this is equivalent to saying that
+ // neither minimum or maximum must be encoded.
+ fn general_subtree<'b>(
+ input: &mut untrusted::Reader<'b>,
+ ) -> Result<GeneralName<'b>, Error> {
+ let general_subtree = der::expect_tag_and_get_value(input, der::Tag::Sequence)?;
+ general_subtree.read_all(Error::BadDer, general_name)
+ }
+
+ let base = match general_subtree(&mut constraints) {
+ Ok(base) => base,
+ Err(err) => {
+ return NameIteration::Stop(Err(err));
+ }
+ };
+
+ let matches = match (name, base) {
+ (GeneralName::DnsName(name), GeneralName::DnsName(base)) => {
+ dns_name::presented_id_matches_constraint(name, base).ok_or(Error::BadDer)
+ }
+
+ (GeneralName::DirectoryName(name), GeneralName::DirectoryName(base)) => Ok(
+ presented_directory_name_matches_constraint(name, base, subtrees),
+ ),
+
+ (GeneralName::IpAddress(name), GeneralName::IpAddress(base)) => {
+ ip_address::presented_id_matches_constraint(name, base)
+ }
+
+ // RFC 4280 says "If a name constraints extension that is marked as
+ // critical imposes constraints on a particular name form, and an
+ // instance of that name form appears in the subject field or
+ // subjectAltName extension of a subsequent certificate, then the
+ // application MUST either process the constraint or reject the
+ // certificate." Later, the CABForum agreed to support non-critical
+ // constraints, so it is important to reject the cert without
+ // considering whether the name constraint it critical.
+ (GeneralName::Unsupported(name_tag), GeneralName::Unsupported(base_tag))
+ if name_tag == base_tag =>
+ {
+ Err(Error::NameConstraintViolation)
+ }
+
+ _ => Ok(false),
+ };
+
+ match (subtrees, matches) {
+ (Subtrees::PermittedSubtrees, Ok(true)) => {
+ has_permitted_subtrees_match = true;
+ }
+
+ (Subtrees::PermittedSubtrees, Ok(false)) => {
+ has_permitted_subtrees_mismatch = true;
+ }
+
+ (Subtrees::ExcludedSubtrees, Ok(true)) => {
+ return NameIteration::Stop(Err(Error::NameConstraintViolation));
+ }
+
+ (Subtrees::ExcludedSubtrees, Ok(false)) => (),
+
+ (_, Err(err)) => {
+ return NameIteration::Stop(Err(err));
+ }
+ }
+
+ if constraints.at_end() {
+ break;
+ }
+ }
+
+ if has_permitted_subtrees_mismatch && !has_permitted_subtrees_match {
+ // If there was any entry of the given type in permittedSubtrees, then
+ // it required that at least one of them must match. Since none of them
+ // did, we have a failure.
+ NameIteration::Stop(Err(Error::NameConstraintViolation))
+ } else {
+ NameIteration::KeepGoing
+ }
+}
+
+// TODO: document this.
+fn presented_directory_name_matches_constraint(
+ name: untrusted::Input,
+ constraint: untrusted::Input,
+ subtrees: Subtrees,
+) -> bool {
+ match subtrees {
+ Subtrees::PermittedSubtrees => equal(name, constraint),
+ Subtrees::ExcludedSubtrees => true,
+ }
+}
+
+#[derive(Clone, Copy)]
+enum NameIteration {
+ KeepGoing,
+ Stop(Result<(), Error>),
+}
+
+fn iterate_names(
+ subject: untrusted::Input,
+ subject_alt_name: Option<untrusted::Input>,
+ result_if_never_stopped_early: Result<(), Error>,
+ f: &dyn Fn(GeneralName) -> NameIteration,
+) -> Result<(), Error> {
+ match subject_alt_name {
+ Some(subject_alt_name) => {
+ let mut subject_alt_name = untrusted::Reader::new(subject_alt_name);
+ // https://bugzilla.mozilla.org/show_bug.cgi?id=1143085: An empty
+ // subjectAltName is not legal, but some certificates have an empty
+ // subjectAltName. Since we don't support CN-IDs, the certificate
+ // will be rejected either way, but checking `at_end` before
+ // attempting to parse the first entry allows us to return a better
+ // error code.
+ while !subject_alt_name.at_end() {
+ let name = general_name(&mut subject_alt_name)?;
+ match f(name) {
+ NameIteration::Stop(result) => {
+ return result;
+ }
+ NameIteration::KeepGoing => (),
+ }
+ }
+ }
+ None => (),
+ }
+
+ match f(GeneralName::DirectoryName(subject)) {
+ NameIteration::Stop(result) => result,
+ NameIteration::KeepGoing => result_if_never_stopped_early,
+ }
+}
+
+// It is *not* valid to derive `Eq`, `PartialEq, etc. for this type. In
+// particular, for the types of `GeneralName`s that we don't understand, we
+// don't even store the value. Also, the meaning of a `GeneralName` in a name
+// constraint is different than the meaning of the identically-represented
+// `GeneralName` in other contexts.
+#[derive(Clone, Copy)]
+enum GeneralName<'a> {
+ DnsName(untrusted::Input<'a>),
+ DirectoryName(untrusted::Input<'a>),
+ IpAddress(untrusted::Input<'a>),
+
+ // The value is the `tag & ~(der::CONTEXT_SPECIFIC | der::CONSTRUCTED)` so
+ // that the name constraint checking matches tags regardless of whether
+ // those bits are set.
+ Unsupported(u8),
+}
+
+fn general_name<'a>(input: &mut untrusted::Reader<'a>) -> Result<GeneralName<'a>, Error> {
+ use ring::io::der::{CONSTRUCTED, CONTEXT_SPECIFIC};
+ #[allow(clippy::identity_op)]
+ const OTHER_NAME_TAG: u8 = CONTEXT_SPECIFIC | CONSTRUCTED | 0;
+ const RFC822_NAME_TAG: u8 = CONTEXT_SPECIFIC | 1;
+ const DNS_NAME_TAG: u8 = CONTEXT_SPECIFIC | 2;
+ const X400_ADDRESS_TAG: u8 = CONTEXT_SPECIFIC | CONSTRUCTED | 3;
+ const DIRECTORY_NAME_TAG: u8 = CONTEXT_SPECIFIC | CONSTRUCTED | 4;
+ const EDI_PARTY_NAME_TAG: u8 = CONTEXT_SPECIFIC | CONSTRUCTED | 5;
+ const UNIFORM_RESOURCE_IDENTIFIER_TAG: u8 = CONTEXT_SPECIFIC | 6;
+ const IP_ADDRESS_TAG: u8 = CONTEXT_SPECIFIC | 7;
+ const REGISTERED_ID_TAG: u8 = CONTEXT_SPECIFIC | 8;
+
+ let (tag, value) = der::read_tag_and_get_value(input)?;
+ let name = match tag {
+ DNS_NAME_TAG => GeneralName::DnsName(value),
+ DIRECTORY_NAME_TAG => GeneralName::DirectoryName(value),
+ IP_ADDRESS_TAG => GeneralName::IpAddress(value),
+
+ OTHER_NAME_TAG
+ | RFC822_NAME_TAG
+ | X400_ADDRESS_TAG
+ | EDI_PARTY_NAME_TAG
+ | UNIFORM_RESOURCE_IDENTIFIER_TAG
+ | REGISTERED_ID_TAG => GeneralName::Unsupported(tag & !(CONTEXT_SPECIFIC | CONSTRUCTED)),
+
+ _ => return Err(Error::BadDer),
+ };
+ Ok(name)
+}
diff --git a/crates/webpki/src/signed_data.rs b/crates/webpki/src/signed_data.rs
new file mode 100644
index 0000000..ccd834e
--- /dev/null
+++ b/crates/webpki/src/signed_data.rs
@@ -0,0 +1,792 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use crate::{der, equal, Error};
+use ring::signature;
+
+/// X.509 certificates and related items that are signed are almost always
+/// encoded in the format "tbs||signatureAlgorithm||signature". This structure
+/// captures this pattern.
+pub struct SignedData<'a> {
+ /// The signed data. This would be `tbsCertificate` in the case of an X.509
+ /// certificate, `tbsResponseData` in the case of an OCSP response, and the
+ /// data nested in the `digitally-signed` construct for TLS 1.2 signed
+ /// data.
+ data: untrusted::Input<'a>,
+
+ /// The value of the `AlgorithmIdentifier`. This would be
+ /// `signatureAlgorithm` in the case of an X.509 certificate or OCSP
+ /// response. This would have to be synthesized in the case of TLS 1.2
+ /// signed data, since TLS does not identify algorithms by ASN.1 OIDs.
+ pub(crate) algorithm: untrusted::Input<'a>,
+
+ /// The value of the signature. This would be `signature` in an X.509
+ /// certificate or OCSP response. This would be the value of
+ /// `DigitallySigned.signature` for TLS 1.2 signed data.
+ signature: untrusted::Input<'a>,
+}
+
+/// Parses the concatenation of "tbs||signatureAlgorithm||signature" that
+/// is common in the X.509 certificate and OCSP response syntaxes.
+///
+/// X.509 Certificates (RFC 5280) look like this:
+///
+/// ```ASN.1
+/// Certificate (SEQUENCE) {
+/// tbsCertificate TBSCertificate,
+/// signatureAlgorithm AlgorithmIdentifier,
+/// signatureValue BIT STRING
+/// }
+/// ```
+///
+/// OCSP responses (RFC 6960) look like this:
+/// ```ASN.1
+/// BasicOCSPResponse {
+/// tbsResponseData ResponseData,
+/// signatureAlgorithm AlgorithmIdentifier,
+/// signature BIT STRING,
+/// certs [0] EXPLICIT SEQUENCE OF Certificate OPTIONAL
+/// }
+/// ```
+///
+/// Note that this function does NOT parse the outermost `SEQUENCE` or the
+/// `certs` value.
+///
+/// The return value's first component is the contents of
+/// `tbsCertificate`/`tbsResponseData`; the second component is a `SignedData`
+/// structure that can be passed to `verify_signed_data`.
+pub(crate) fn parse_signed_data<'a>(
+ der: &mut untrusted::Reader<'a>,
+) -> Result<(untrusted::Input<'a>, SignedData<'a>), Error> {
+ let (data, tbs) =
+ der.read_partial(|input| der::expect_tag_and_get_value(input, der::Tag::Sequence))?;
+ let algorithm = der::expect_tag_and_get_value(der, der::Tag::Sequence)?;
+ let signature = der::bit_string_with_no_unused_bits(der)?;
+
+ Ok((
+ tbs,
+ SignedData {
+ data,
+ algorithm,
+ signature,
+ },
+ ))
+}
+
+/// Verify `signed_data` using the public key in the DER-encoded
+/// SubjectPublicKeyInfo `spki` using one of the algorithms in
+/// `supported_algorithms`.
+///
+/// The algorithm is chosen based on the algorithm information encoded in the
+/// algorithm identifiers in `public_key` and `signed_data.algorithm`. The
+/// ordering of the algorithms in `supported_algorithms` does not really matter,
+/// but generally more common algorithms should go first, as it is scanned
+/// linearly for matches.
+pub(crate) fn verify_signed_data(
+ supported_algorithms: &[&SignatureAlgorithm],
+ spki_value: untrusted::Input,
+ signed_data: &SignedData,
+) -> Result<(), Error> {
+ // We need to verify the signature in `signed_data` using the public key
+ // in `public_key`. In order to know which *ring* signature verification
+ // algorithm to use, we need to know the public key algorithm (ECDSA,
+ // RSA PKCS#1, etc.), the curve (if applicable), and the digest algorithm.
+ // `signed_data` identifies only the public key algorithm and the digest
+ // algorithm, and `public_key` identifies only the public key algorithm and
+ // the curve (if any). Thus, we have to combine information from both
+ // inputs to figure out which `ring::signature::VerificationAlgorithm` to
+ // use to verify the signature.
+ //
+ // This is all further complicated by the fact that we don't have any
+ // implicit knowledge about any algorithms or identifiers, since all of
+ // that information is encoded in `supported_algorithms.` In particular, we
+ // avoid hard-coding any of that information so that (link-time) dead code
+ // elimination will work effectively in eliminating code for unused
+ // algorithms.
+
+ // Parse the signature.
+ //
+ let mut found_signature_alg_match = false;
+ for supported_alg in supported_algorithms.iter().filter(|alg| {
+ alg.signature_alg_id
+ .matches_algorithm_id_value(signed_data.algorithm)
+ }) {
+ match verify_signature(
+ supported_alg,
+ spki_value,
+ signed_data.data,
+ signed_data.signature,
+ ) {
+ Err(Error::UnsupportedSignatureAlgorithmForPublicKey) => {
+ found_signature_alg_match = true;
+ continue;
+ }
+ result => {
+ return result;
+ }
+ }
+ }
+
+ if found_signature_alg_match {
+ Err(Error::UnsupportedSignatureAlgorithmForPublicKey)
+ } else {
+ Err(Error::UnsupportedSignatureAlgorithm)
+ }
+}
+
+pub(crate) fn verify_signature(
+ signature_alg: &SignatureAlgorithm,
+ spki_value: untrusted::Input,
+ msg: untrusted::Input,
+ signature: untrusted::Input,
+) -> Result<(), Error> {
+ let spki = parse_spki_value(spki_value)?;
+ if !signature_alg
+ .public_key_alg_id
+ .matches_algorithm_id_value(spki.algorithm_id_value)
+ {
+ return Err(Error::UnsupportedSignatureAlgorithmForPublicKey);
+ }
+ signature::UnparsedPublicKey::new(
+ signature_alg.verification_alg,
+ spki.key_value.as_slice_less_safe(),
+ )
+ .verify(msg.as_slice_less_safe(), signature.as_slice_less_safe())
+ .map_err(|_| Error::InvalidSignatureForPublicKey)
+}
+
+struct SubjectPublicKeyInfo<'a> {
+ algorithm_id_value: untrusted::Input<'a>,
+ key_value: untrusted::Input<'a>,
+}
+
+// Parse the public key into an algorithm OID, an optional curve OID, and the
+// key value. The caller needs to check whether these match the
+// `PublicKeyAlgorithm` for the `SignatureAlgorithm` that is matched when
+// parsing the signature.
+fn parse_spki_value(input: untrusted::Input) -> Result<SubjectPublicKeyInfo, Error> {
+ input.read_all(Error::BadDer, |input| {
+ let algorithm_id_value = der::expect_tag_and_get_value(input, der::Tag::Sequence)?;
+ let key_value = der::bit_string_with_no_unused_bits(input)?;
+ Ok(SubjectPublicKeyInfo {
+ algorithm_id_value,
+ key_value,
+ })
+ })
+}
+
+/// A signature algorithm.
+pub struct SignatureAlgorithm {
+ public_key_alg_id: AlgorithmIdentifier,
+ signature_alg_id: AlgorithmIdentifier,
+ verification_alg: &'static dyn signature::VerificationAlgorithm,
+}
+
+/// ECDSA signatures using the P-256 curve and SHA-256.
+pub static ECDSA_P256_SHA256: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: ECDSA_P256,
+ signature_alg_id: ECDSA_SHA256,
+ verification_alg: &signature::ECDSA_P256_SHA256_ASN1,
+};
+
+/// ECDSA signatures using the P-256 curve and SHA-384. Deprecated.
+pub static ECDSA_P256_SHA384: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: ECDSA_P256,
+ signature_alg_id: ECDSA_SHA384,
+ verification_alg: &signature::ECDSA_P256_SHA384_ASN1,
+};
+
+/// ECDSA signatures using the P-384 curve and SHA-256. Deprecated.
+pub static ECDSA_P384_SHA256: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: ECDSA_P384,
+ signature_alg_id: ECDSA_SHA256,
+ verification_alg: &signature::ECDSA_P384_SHA256_ASN1,
+};
+
+/// ECDSA signatures using the P-384 curve and SHA-384.
+pub static ECDSA_P384_SHA384: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: ECDSA_P384,
+ signature_alg_id: ECDSA_SHA384,
+ verification_alg: &signature::ECDSA_P384_SHA384_ASN1,
+};
+
+/// RSA PKCS#1 1.5 signatures using SHA-256 for keys of 2048-8192 bits.
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PKCS1_2048_8192_SHA256: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PKCS1_SHA256,
+ verification_alg: &signature::RSA_PKCS1_2048_8192_SHA256,
+};
+
+/// RSA PKCS#1 1.5 signatures using SHA-384 for keys of 2048-8192 bits.
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PKCS1_2048_8192_SHA384: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PKCS1_SHA384,
+ verification_alg: &signature::RSA_PKCS1_2048_8192_SHA384,
+};
+
+/// RSA PKCS#1 1.5 signatures using SHA-512 for keys of 2048-8192 bits.
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PKCS1_2048_8192_SHA512: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PKCS1_SHA512,
+ verification_alg: &signature::RSA_PKCS1_2048_8192_SHA512,
+};
+
+/// RSA PKCS#1 1.5 signatures using SHA-384 for keys of 3072-8192 bits.
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PKCS1_3072_8192_SHA384: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PKCS1_SHA384,
+ verification_alg: &signature::RSA_PKCS1_3072_8192_SHA384,
+};
+
+/// RSA PSS signatures using SHA-256 for keys of 2048-8192 bits and of
+/// type rsaEncryption; see [RFC 4055 Section 1.2].
+///
+/// [RFC 4055 Section 1.2]: https://tools.ietf.org/html/rfc4055#section-1.2
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PSS_2048_8192_SHA256_LEGACY_KEY: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PSS_SHA256,
+ verification_alg: &signature::RSA_PSS_2048_8192_SHA256,
+};
+
+/// RSA PSS signatures using SHA-384 for keys of 2048-8192 bits and of
+/// type rsaEncryption; see [RFC 4055 Section 1.2].
+///
+/// [RFC 4055 Section 1.2]: https://tools.ietf.org/html/rfc4055#section-1.2
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PSS_2048_8192_SHA384_LEGACY_KEY: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PSS_SHA384,
+ verification_alg: &signature::RSA_PSS_2048_8192_SHA384,
+};
+
+/// RSA PSS signatures using SHA-512 for keys of 2048-8192 bits and of
+/// type rsaEncryption; see [RFC 4055 Section 1.2].
+///
+/// [RFC 4055 Section 1.2]: https://tools.ietf.org/html/rfc4055#section-1.2
+///
+/// Requires the `alloc` feature.
+#[cfg(feature = "alloc")]
+pub static RSA_PSS_2048_8192_SHA512_LEGACY_KEY: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: RSA_ENCRYPTION,
+ signature_alg_id: RSA_PSS_SHA512,
+ verification_alg: &signature::RSA_PSS_2048_8192_SHA512,
+};
+
+/// ED25519 signatures according to RFC 8410
+pub static ED25519: SignatureAlgorithm = SignatureAlgorithm {
+ public_key_alg_id: ED_25519,
+ signature_alg_id: ED_25519,
+ verification_alg: &signature::ED25519,
+};
+
+struct AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input<'static>,
+}
+
+impl AlgorithmIdentifier {
+ fn matches_algorithm_id_value(&self, encoded: untrusted::Input) -> bool {
+ equal(encoded, self.asn1_id_value)
+ }
+}
+
+// See src/data/README.md.
+
+const ECDSA_P256: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-ecdsa-p256.der")),
+};
+
+const ECDSA_P384: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-ecdsa-p384.der")),
+};
+
+const ECDSA_SHA256: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-ecdsa-sha256.der")),
+};
+
+const ECDSA_SHA384: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-ecdsa-sha384.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_ENCRYPTION: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-encryption.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PKCS1_SHA256: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pkcs1-sha256.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PKCS1_SHA384: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pkcs1-sha384.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PKCS1_SHA512: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pkcs1-sha512.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PSS_SHA256: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pss-sha256.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PSS_SHA384: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pss-sha384.der")),
+};
+
+#[cfg(feature = "alloc")]
+const RSA_PSS_SHA512: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-rsa-pss-sha512.der")),
+};
+
+const ED_25519: AlgorithmIdentifier = AlgorithmIdentifier {
+ asn1_id_value: untrusted::Input::from(include_bytes!("data/alg-ed25519.der")),
+};
+
+#[cfg(test)]
+mod tests {
+ use crate::{der, signed_data, Error};
+ use alloc::{string::String, vec::Vec};
+
+ macro_rules! test_file_bytes {
+ ( $file_name:expr ) => {
+ include_bytes!(concat!(
+ "../third-party/chromium/data/verify_signed_data/",
+ $file_name
+ ))
+ };
+ }
+
+ // TODO: The expected results need to be modified for SHA-1 deprecation.
+
+ macro_rules! test_verify_signed_data {
+ ($fn_name:ident, $file_name:expr, $expected_result:expr) => {
+ #[test]
+ fn $fn_name() {
+ test_verify_signed_data(test_file_bytes!($file_name), $expected_result);
+ }
+ };
+ }
+
+ fn test_verify_signed_data(file_contents: &[u8], expected_result: Result<(), Error>) {
+ let tsd = parse_test_signed_data(file_contents);
+ let spki_value = untrusted::Input::from(&tsd.spki);
+ let spki_value = spki_value
+ .read_all(Error::BadDer, |input| {
+ der::expect_tag_and_get_value(input, der::Tag::Sequence)
+ })
+ .unwrap();
+
+ // we can't use `parse_signed_data` because it requires `data`
+ // to be an ASN.1 SEQUENCE, and that isn't the case with
+ // Chromium's test data. TODO: The test data set should be
+ // expanded with SEQUENCE-wrapped data so that we can actually
+ // test `parse_signed_data`.
+
+ let algorithm = untrusted::Input::from(&tsd.algorithm);
+ let algorithm = algorithm
+ .read_all(Error::BadDer, |input| {
+ der::expect_tag_and_get_value(input, der::Tag::Sequence)
+ })
+ .unwrap();
+
+ let signature = untrusted::Input::from(&tsd.signature);
+ let signature = signature
+ .read_all(Error::BadDer, |input| {
+ der::bit_string_with_no_unused_bits(input)
+ })
+ .unwrap();
+
+ let signed_data = signed_data::SignedData {
+ data: untrusted::Input::from(&tsd.data),
+ algorithm,
+ signature,
+ };
+
+ assert_eq!(
+ expected_result,
+ signed_data::verify_signed_data(
+ SUPPORTED_ALGORITHMS_IN_TESTS,
+ spki_value,
+ &signed_data
+ )
+ );
+ }
+
+ // XXX: This is testing code that isn't even in this module.
+ macro_rules! test_verify_signed_data_signature_outer {
+ ($fn_name:ident, $file_name:expr, $expected_result:expr) => {
+ #[test]
+ fn $fn_name() {
+ test_verify_signed_data_signature_outer(
+ test_file_bytes!($file_name),
+ $expected_result,
+ );
+ }
+ };
+ }
+
+ fn test_verify_signed_data_signature_outer(file_contents: &[u8], expected_error: Error) {
+ let tsd = parse_test_signed_data(file_contents);
+ let signature = untrusted::Input::from(&tsd.signature);
+ assert_eq!(
+ expected_error,
+ signature
+ .read_all(Error::BadDer, |input| {
+ der::bit_string_with_no_unused_bits(input)
+ })
+ .unwrap_err()
+ );
+ }
+
+ // XXX: This is testing code that is not even in this module.
+ macro_rules! test_parse_spki_bad_outer {
+ ($fn_name:ident, $file_name:expr, $error:expr) => {
+ #[test]
+ fn $fn_name() {
+ test_parse_spki_bad_outer(test_file_bytes!($file_name), $error)
+ }
+ };
+ }
+
+ fn test_parse_spki_bad_outer(file_contents: &[u8], expected_error: Error) {
+ let tsd = parse_test_signed_data(file_contents);
+ let spki = untrusted::Input::from(&tsd.spki);
+ assert_eq!(
+ expected_error,
+ spki.read_all(Error::BadDer, |input| {
+ der::expect_tag_and_get_value(input, der::Tag::Sequence)
+ })
+ .unwrap_err()
+ );
+ }
+
+ const UNSUPPORTED_SIGNATURE_ALGORITHM_FOR_RSA_KEY: Error = if cfg!(feature = "alloc") {
+ Error::UnsupportedSignatureAlgorithmForPublicKey
+ } else {
+ Error::UnsupportedSignatureAlgorithm
+ };
+
+ const INVALID_SIGNATURE_FOR_RSA_KEY: Error = if cfg!(feature = "alloc") {
+ Error::InvalidSignatureForPublicKey
+ } else {
+ Error::UnsupportedSignatureAlgorithm
+ };
+
+ const OK_IF_RSA_AVAILABLE: Result<(), Error> = if cfg!(feature = "alloc") {
+ Ok(())
+ } else {
+ Err(Error::UnsupportedSignatureAlgorithm)
+ };
+
+ // XXX: Some of the BadDER tests should have better error codes, maybe?
+
+ // XXX: We should have a variant of this test with a SHA-256 digest that gives
+ // `Error::UnsupportedSignatureAlgorithmForPublicKey`.
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512_spki_params_null,
+ "ecdsa-prime256v1-sha512-spki-params-null.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data_signature_outer!(
+ test_ecdsa_prime256v1_sha512_unused_bits_signature,
+ "ecdsa-prime256v1-sha512-unused-bits-signature.pem",
+ Error::BadDer
+ );
+ // XXX: We should have a variant of this test with a SHA-256 digest that gives
+ // `Error::UnsupportedSignatureAlgorithmForPublicKey`.
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512_using_ecdh_key,
+ "ecdsa-prime256v1-sha512-using-ecdh-key.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ // XXX: We should have a variant of this test with a SHA-256 digest that gives
+ // `Error::UnsupportedSignatureAlgorithmForPublicKey`.
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512_using_ecmqv_key,
+ "ecdsa-prime256v1-sha512-using-ecmqv-key.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512_using_rsa_algorithm,
+ "ecdsa-prime256v1-sha512-using-rsa-algorithm.pem",
+ Err(UNSUPPORTED_SIGNATURE_ALGORITHM_FOR_RSA_KEY)
+ );
+ // XXX: We should have a variant of this test with a SHA-256 digest that gives
+ // `Error::InvalidSignatureForPublicKey`.
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512_wrong_signature_format,
+ "ecdsa-prime256v1-sha512-wrong-signature-format.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ // Differs from Chromium because we don't support P-256 with SHA-512.
+ test_verify_signed_data!(
+ test_ecdsa_prime256v1_sha512,
+ "ecdsa-prime256v1-sha512.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_ecdsa_secp384r1_sha256_corrupted_data,
+ "ecdsa-secp384r1-sha256-corrupted-data.pem",
+ Err(Error::InvalidSignatureForPublicKey)
+ );
+ test_verify_signed_data!(
+ test_ecdsa_secp384r1_sha256,
+ "ecdsa-secp384r1-sha256.pem",
+ Ok(())
+ );
+ test_verify_signed_data!(
+ test_ecdsa_using_rsa_key,
+ "ecdsa-using-rsa-key.pem",
+ Err(Error::UnsupportedSignatureAlgorithmForPublicKey)
+ );
+
+ test_parse_spki_bad_outer!(
+ test_rsa_pkcs1_sha1_bad_key_der_length,
+ "rsa-pkcs1-sha1-bad-key-der-length.pem",
+ Error::BadDer
+ );
+ test_parse_spki_bad_outer!(
+ test_rsa_pkcs1_sha1_bad_key_der_null,
+ "rsa-pkcs1-sha1-bad-key-der-null.pem",
+ Error::BadDer
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha1_key_params_absent,
+ "rsa-pkcs1-sha1-key-params-absent.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha1_using_pss_key_no_params,
+ "rsa-pkcs1-sha1-using-pss-key-no-params.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha1_wrong_algorithm,
+ "rsa-pkcs1-sha1-wrong-algorithm.pem",
+ Err(INVALID_SIGNATURE_FOR_RSA_KEY)
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha1,
+ "rsa-pkcs1-sha1.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ // XXX: RSA PKCS#1 with SHA-1 is a supported algorithm, but we only accept
+ // 2048-8192 bit keys, and this test file is using a 1024 bit key. Thus,
+ // our results differ from Chromium's. TODO: this means we need a 2048+ bit
+ // version of this test.
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha256,
+ "rsa-pkcs1-sha256.pem",
+ Err(INVALID_SIGNATURE_FOR_RSA_KEY)
+ );
+ test_parse_spki_bad_outer!(
+ test_rsa_pkcs1_sha256_key_encoded_ber,
+ "rsa-pkcs1-sha256-key-encoded-ber.pem",
+ Error::BadDer
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha256_spki_non_null_params,
+ "rsa-pkcs1-sha256-spki-non-null-params.pem",
+ Err(UNSUPPORTED_SIGNATURE_ALGORITHM_FOR_RSA_KEY)
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha256_using_ecdsa_algorithm,
+ "rsa-pkcs1-sha256-using-ecdsa-algorithm.pem",
+ Err(Error::UnsupportedSignatureAlgorithmForPublicKey)
+ );
+ test_verify_signed_data!(
+ test_rsa_pkcs1_sha256_using_id_ea_rsa,
+ "rsa-pkcs1-sha256-using-id-ea-rsa.pem",
+ Err(UNSUPPORTED_SIGNATURE_ALGORITHM_FOR_RSA_KEY)
+ );
+
+ // Chromium's PSS test are for parameter combinations we don't support.
+ test_verify_signed_data!(
+ test_rsa_pss_sha1_salt20_using_pss_key_no_params,
+ "rsa-pss-sha1-salt20-using-pss-key-no-params.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha1_salt20_using_pss_key_with_null_params,
+ "rsa-pss-sha1-salt20-using-pss-key-with-null-params.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha1_salt20,
+ "rsa-pss-sha1-salt20.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha1_wrong_salt,
+ "rsa-pss-sha1-wrong-salt.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_mgf1_sha512_salt33,
+ "rsa-pss-sha256-mgf1-sha512-salt33.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_salt10_using_pss_key_with_params,
+ "rsa-pss-sha256-salt10-using-pss-key-with-params.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_salt10_using_pss_key_with_wrong_params,
+ "rsa-pss-sha256-salt10-using-pss-key-with-wrong-params.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_salt10,
+ "rsa-pss-sha256-salt10.pem",
+ Err(Error::UnsupportedSignatureAlgorithm)
+ );
+
+ // Our PSS tests that should work.
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_salt32,
+ "ours/rsa-pss-sha256-salt32.pem",
+ OK_IF_RSA_AVAILABLE
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha384_salt48,
+ "ours/rsa-pss-sha384-salt48.pem",
+ OK_IF_RSA_AVAILABLE
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha512_salt64,
+ "ours/rsa-pss-sha512-salt64.pem",
+ OK_IF_RSA_AVAILABLE
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha256_salt32_corrupted_data,
+ "ours/rsa-pss-sha256-salt32-corrupted-data.pem",
+ Err(INVALID_SIGNATURE_FOR_RSA_KEY)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha384_salt48_corrupted_data,
+ "ours/rsa-pss-sha384-salt48-corrupted-data.pem",
+ Err(INVALID_SIGNATURE_FOR_RSA_KEY)
+ );
+ test_verify_signed_data!(
+ test_rsa_pss_sha512_salt64_corrupted_data,
+ "ours/rsa-pss-sha512-salt64-corrupted-data.pem",
+ Err(INVALID_SIGNATURE_FOR_RSA_KEY)
+ );
+
+ test_verify_signed_data!(
+ test_rsa_using_ec_key,
+ "rsa-using-ec-key.pem",
+ Err(UNSUPPORTED_SIGNATURE_ALGORITHM_FOR_RSA_KEY)
+ );
+ test_verify_signed_data!(
+ test_rsa2048_pkcs1_sha512,
+ "rsa2048-pkcs1-sha512.pem",
+ OK_IF_RSA_AVAILABLE
+ );
+
+ struct TestSignedData {
+ spki: Vec<u8>,
+ data: Vec<u8>,
+ algorithm: Vec<u8>,
+ signature: Vec<u8>,
+ }
+
+ fn parse_test_signed_data(file_contents: &[u8]) -> TestSignedData {
+ let mut lines = core::str::from_utf8(file_contents).unwrap().lines();
+ let spki = read_pem_section(&mut lines, "PUBLIC KEY");
+ let algorithm = read_pem_section(&mut lines, "ALGORITHM");
+ let data = read_pem_section(&mut lines, "DATA");
+ let signature = read_pem_section(&mut lines, "SIGNATURE");
+
+ TestSignedData {
+ spki,
+ data,
+ algorithm,
+ signature,
+ }
+ }
+
+ use alloc::str::Lines;
+
+ fn read_pem_section(lines: &mut Lines, section_name: &str) -> Vec<u8> {
+ // Skip comments and header
+ let begin_section = format!("-----BEGIN {}-----", section_name);
+ loop {
+ let line = lines.next().unwrap();
+ if line == begin_section {
+ break;
+ }
+ }
+
+ let mut base64 = String::new();
+
+ let end_section = format!("-----END {}-----", section_name);
+ loop {
+ let line = lines.next().unwrap();
+ if line == end_section {
+ break;
+ }
+ base64.push_str(line);
+ }
+
+ base64::decode(&base64).unwrap()
+ }
+
+ static SUPPORTED_ALGORITHMS_IN_TESTS: &[&signed_data::SignatureAlgorithm] = &[
+ // Reasonable algorithms.
+ &signed_data::ECDSA_P256_SHA256,
+ &signed_data::ECDSA_P384_SHA384,
+ &signed_data::ED25519,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PKCS1_2048_8192_SHA256,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PKCS1_2048_8192_SHA384,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PKCS1_2048_8192_SHA512,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PKCS1_3072_8192_SHA384,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PSS_2048_8192_SHA256_LEGACY_KEY,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PSS_2048_8192_SHA384_LEGACY_KEY,
+ #[cfg(feature = "alloc")]
+ &signed_data::RSA_PSS_2048_8192_SHA512_LEGACY_KEY,
+ // Algorithms deprecated because they are annoying (P-521) or because
+ // they are nonsensical combinations.
+ &signed_data::ECDSA_P256_SHA384, // Truncates digest.
+ &signed_data::ECDSA_P384_SHA256, // Digest is unnecessarily short.
+ ];
+}
diff --git a/crates/webpki/src/time.rs b/crates/webpki/src/time.rs
new file mode 100644
index 0000000..0457cae
--- /dev/null
+++ b/crates/webpki/src/time.rs
@@ -0,0 +1,65 @@
+// Copyright 2015-2016 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+//! Conversions into the library's time type.
+
+/// The time type.
+///
+/// Internally this is merely a UNIX timestamp: a count of non-leap
+/// seconds since the start of 1970. This type exists to assist
+/// unit-of-measure correctness.
+#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
+pub struct Time(u64);
+
+impl Time {
+ /// Create a `webpki::Time` from a unix timestamp.
+ ///
+ /// It is usually better to use the less error-prone
+ /// `webpki::Time::try_from(time: std::time::SystemTime)` instead when
+ /// `std::time::SystemTime` is available (when `#![no_std]` isn't being
+ /// used).
+ #[allow(clippy::must_use_candidate)]
+ pub fn from_seconds_since_unix_epoch(secs: u64) -> Self {
+ Self(secs)
+ }
+}
+
+#[cfg(feature = "std")]
+impl core::convert::TryFrom<std::time::SystemTime> for Time {
+ type Error = std::time::SystemTimeError;
+
+ /// Create a `webpki::Time` from a `std::time::SystemTime`.
+ ///
+ /// # Example:
+ ///
+ /// Construct a `webpki::Time` from the current system time:
+ ///
+ /// ```
+ /// # extern crate ring;
+ /// # extern crate webpki;
+ /// #
+ /// #![cfg(feature = "std")]
+ /// use std::{convert::TryFrom, time::{SystemTime, SystemTimeError}};
+ ///
+ /// # fn foo() -> Result<(), SystemTimeError> {
+ /// let time = webpki::Time::try_from(SystemTime::now())?;
+ /// # Ok(())
+ /// # }
+ /// ```
+ fn try_from(value: std::time::SystemTime) -> Result<Self, Self::Error> {
+ value
+ .duration_since(std::time::UNIX_EPOCH)
+ .map(|d| Self::from_seconds_since_unix_epoch(d.as_secs()))
+ }
+}
diff --git a/crates/webpki/src/trust_anchor.rs b/crates/webpki/src/trust_anchor.rs
new file mode 100644
index 0000000..0ac2806
--- /dev/null
+++ b/crates/webpki/src/trust_anchor.rs
@@ -0,0 +1,119 @@
+use crate::cert::{certificate_serial_number, Cert};
+use crate::{
+ cert::{parse_cert_internal, EndEntityOrCa},
+ der, Error,
+};
+
+/// A trust anchor (a.k.a. root CA).
+///
+/// Traditionally, certificate verification libraries have represented trust
+/// anchors as full X.509 root certificates. However, those certificates
+/// contain a lot more data than is needed for verifying certificates. The
+/// `TrustAnchor` representation allows an application to store just the
+/// essential elements of trust anchors. The `webpki::trust_anchor_util` module
+/// provides functions for converting X.509 certificates to to the minimized
+/// `TrustAnchor` representation, either at runtime or in a build script.
+#[derive(Debug)]
+pub struct TrustAnchor<'a> {
+ /// The value of the `subject` field of the trust anchor.
+ pub subject: &'a [u8],
+
+ /// The value of the `subjectPublicKeyInfo` field of the trust anchor.
+ pub spki: &'a [u8],
+
+ /// The value of a DER-encoded NameConstraints, containing name
+ /// constraints to apply to the trust anchor, if any.
+ pub name_constraints: Option<&'a [u8]>,
+}
+
+/// Trust anchors which may be used for authenticating servers.
+#[derive(Debug)]
+pub struct TlsServerTrustAnchors<'a>(pub &'a [TrustAnchor<'a>]);
+
+/// Trust anchors which may be used for authenticating clients.
+#[derive(Debug)]
+pub struct TlsClientTrustAnchors<'a>(pub &'a [TrustAnchor<'a>]);
+
+impl<'a> TrustAnchor<'a> {
+ /// Interprets the given DER-encoded certificate as a `TrustAnchor`. The
+ /// certificate is not validated. In particular, there is no check that the
+ /// certificate is self-signed or even that the certificate has the cA basic
+ /// constraint.
+ pub fn try_from_cert_der(cert_der: &'a [u8]) -> Result<Self, Error> {
+ let cert_der = untrusted::Input::from(cert_der);
+
+ // XXX: `EndEntityOrCA::EndEntity` is used instead of `EndEntityOrCA::CA`
+ // because we don't have a reference to a child cert, which is needed for
+ // `EndEntityOrCA::CA`. For this purpose, it doesn't matter.
+ //
+ // v1 certificates will result in `Error::BadDER` because `parse_cert` will
+ // expect a version field that isn't there. In that case, try to parse the
+ // certificate using a special parser for v1 certificates. Notably, that
+ // parser doesn't allow extensions, so there's no need to worry about
+ // embedded name constraints in a v1 certificate.
+ match parse_cert_internal(
+ cert_der,
+ EndEntityOrCa::EndEntity,
+ possibly_invalid_certificate_serial_number,
+ ) {
+ Ok(cert) => Ok(Self::from(cert)),
+ Err(Error::UnsupportedCertVersion) => parse_cert_v1(cert_der).or(Err(Error::BadDer)),
+ Err(err) => Err(err),
+ }
+ }
+}
+
+fn possibly_invalid_certificate_serial_number(input: &mut untrusted::Reader) -> Result<(), Error> {
+ // https://tools.ietf.org/html/rfc5280#section-4.1.2.2:
+ // * Conforming CAs MUST NOT use serialNumber values longer than 20 octets."
+ // * "The serial number MUST be a positive integer [...]"
+ //
+ // However, we don't enforce these constraints on trust anchors, as there
+ // are widely-deployed trust anchors that violate these constraints.
+ skip(input, der::Tag::Integer)
+}
+
+impl<'a> From<Cert<'a>> for TrustAnchor<'a> {
+ fn from(cert: Cert<'a>) -> Self {
+ Self {
+ subject: cert.subject.as_slice_less_safe(),
+ spki: cert.spki.value().as_slice_less_safe(),
+ name_constraints: cert.name_constraints.map(|nc| nc.as_slice_less_safe()),
+ }
+ }
+}
+
+/// Parses a v1 certificate directly into a TrustAnchor.
+fn parse_cert_v1(cert_der: untrusted::Input) -> Result<TrustAnchor, Error> {
+ // X.509 Certificate: https://tools.ietf.org/html/rfc5280#section-4.1.
+ cert_der.read_all(Error::BadDer, |cert_der| {
+ der::nested(cert_der, der::Tag::Sequence, Error::BadDer, |cert_der| {
+ let anchor = der::nested(cert_der, der::Tag::Sequence, Error::BadDer, |tbs| {
+ // The version number field does not appear in v1 certificates.
+ certificate_serial_number(tbs)?;
+
+ skip(tbs, der::Tag::Sequence)?; // signature.
+ skip(tbs, der::Tag::Sequence)?; // issuer.
+ skip(tbs, der::Tag::Sequence)?; // validity.
+ let subject = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+ let spki = der::expect_tag_and_get_value(tbs, der::Tag::Sequence)?;
+
+ Ok(TrustAnchor {
+ subject: subject.as_slice_less_safe(),
+ spki: spki.as_slice_less_safe(),
+ name_constraints: None,
+ })
+ });
+
+ // read and discard signatureAlgorithm + signature
+ skip(cert_der, der::Tag::Sequence)?;
+ skip(cert_der, der::Tag::BitString)?;
+
+ anchor
+ })
+ })
+}
+
+fn skip(input: &mut untrusted::Reader, tag: der::Tag) -> Result<(), Error> {
+ der::expect_tag_and_get_value(input, tag).map(|_| ())
+}
diff --git a/crates/webpki/src/verify_cert.rs b/crates/webpki/src/verify_cert.rs
new file mode 100644
index 0000000..fe7ef9d
--- /dev/null
+++ b/crates/webpki/src/verify_cert.rs
@@ -0,0 +1,410 @@
+// Copyright 2015 Brian Smith.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use core::default::Default;
+
+use crate::{
+ budget::Budget,
+ cert::{self, Cert, EndEntityOrCa},
+ der, equal,
+ error::ErrorExt,
+ name, signed_data, time, Error, SignatureAlgorithm, TrustAnchor,
+};
+
+pub fn build_chain(
+ required_eku_if_present: KeyPurposeId,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ trust_anchors: &[TrustAnchor],
+ intermediate_certs: &[&[u8]],
+ cert: &Cert,
+ time: time::Time,
+) -> Result<(), ErrorExt> {
+ build_chain_inner(
+ required_eku_if_present,
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ cert,
+ time,
+ 0,
+ &mut Budget::default(),
+ )
+}
+
+#[allow(clippy::too_many_arguments)]
+fn build_chain_inner(
+ required_eku_if_present: KeyPurposeId,
+ supported_sig_algs: &[&SignatureAlgorithm],
+ trust_anchors: &[TrustAnchor],
+ intermediate_certs: &[&[u8]],
+ cert: &Cert,
+ time: time::Time,
+ sub_ca_count: usize,
+ budget: &mut Budget,
+) -> Result<(), ErrorExt> {
+ let used_as_ca = used_as_ca(&cert.ee_or_ca);
+
+ check_issuer_independent_properties(
+ cert,
+ time,
+ used_as_ca,
+ sub_ca_count,
+ required_eku_if_present,
+ )?;
+
+ // TODO: HPKP checks.
+
+ match used_as_ca {
+ UsedAsCa::Yes => {
+ const MAX_SUB_CA_COUNT: usize = 6;
+
+ if sub_ca_count >= MAX_SUB_CA_COUNT {
+ return Err(Error::UnknownIssuer.into());
+ }
+ }
+ UsedAsCa::No => {
+ assert_eq!(0, sub_ca_count);
+ }
+ }
+
+ // TODO: revocation.
+
+ match loop_while_non_fatal_error(trust_anchors, |trust_anchor: &TrustAnchor| {
+ let trust_anchor_subject = untrusted::Input::from(trust_anchor.subject);
+ if !equal(cert.issuer, trust_anchor_subject) {
+ return Err(Error::UnknownIssuer.into());
+ }
+
+ let trust_anchor_spki = untrusted::Input::from(trust_anchor.spki);
+
+ // TODO: check_distrust(trust_anchor_subject, trust_anchor_spki)?;
+
+ check_signatures(supported_sig_algs, cert, trust_anchor_spki, budget)?;
+
+ check_signed_chain_name_constraints(cert, trust_anchor)?;
+
+ Ok(())
+ }) {
+ Ok(()) => {
+ return Ok(());
+ }
+ Err(e) => {
+ if e.is_fatal() {
+ return Err(e);
+ }
+ // If the error is not fatal, then keep going.
+ }
+ }
+
+ loop_while_non_fatal_error(intermediate_certs, |cert_der| {
+ let potential_issuer =
+ cert::parse_cert(untrusted::Input::from(cert_der), EndEntityOrCa::Ca(cert))?;
+
+ if !equal(potential_issuer.subject, cert.issuer) {
+ return Err(Error::UnknownIssuer.into());
+ }
+
+ // Prevent loops; see RFC 4158 section 5.2.
+ let mut prev = cert;
+ loop {
+ if equal(potential_issuer.spki.value(), prev.spki.value())
+ && equal(potential_issuer.subject, prev.subject)
+ {
+ return Err(Error::UnknownIssuer.into());
+ }
+ match &prev.ee_or_ca {
+ EndEntityOrCa::EndEntity => {
+ break;
+ }
+ EndEntityOrCa::Ca(child_cert) => {
+ prev = child_cert;
+ }
+ }
+ }
+
+ let next_sub_ca_count = match used_as_ca {
+ UsedAsCa::No => sub_ca_count,
+ UsedAsCa::Yes => sub_ca_count + 1,
+ };
+
+ budget.consume_build_chain_call()?;
+ build_chain_inner(
+ required_eku_if_present,
+ supported_sig_algs,
+ trust_anchors,
+ intermediate_certs,
+ &potential_issuer,
+ time,
+ next_sub_ca_count,
+ budget,
+ )
+ })
+}
+
+fn check_signatures(
+ supported_sig_algs: &[&SignatureAlgorithm],
+ cert_chain: &Cert,
+ trust_anchor_key: untrusted::Input,
+ budget: &mut Budget,
+) -> Result<(), ErrorExt> {
+ let mut spki_value = trust_anchor_key;
+ let mut cert = cert_chain;
+ loop {
+ budget.consume_signature()?;
+ signed_data::verify_signed_data(supported_sig_algs, spki_value, &cert.signed_data)?;
+
+ // TODO: check revocation
+
+ match &cert.ee_or_ca {
+ EndEntityOrCa::Ca(child_cert) => {
+ spki_value = cert.spki.value();
+ cert = child_cert;
+ }
+ EndEntityOrCa::EndEntity => {
+ break;
+ }
+ }
+ }
+
+ Ok(())
+}
+
+fn check_signed_chain_name_constraints(
+ cert_chain: &Cert,
+ trust_anchor: &TrustAnchor,
+) -> Result<(), Error> {
+ let mut cert = cert_chain;
+ let mut name_constraints = trust_anchor.name_constraints.map(untrusted::Input::from);
+
+ loop {
+ untrusted::read_all_optional(name_constraints, Error::BadDer, |value| {
+ name::check_name_constraints(value, cert)
+ })?;
+
+ match &cert.ee_or_ca {
+ EndEntityOrCa::Ca(child_cert) => {
+ name_constraints = cert.name_constraints;
+ cert = child_cert;
+ }
+ EndEntityOrCa::EndEntity => {
+ break;
+ }
+ }
+ }
+
+ Ok(())
+}
+
+fn check_issuer_independent_properties(
+ cert: &Cert,
+ time: time::Time,
+ used_as_ca: UsedAsCa,
+ sub_ca_count: usize,
+ required_eku_if_present: KeyPurposeId,
+) -> Result<(), Error> {
+ // TODO: check_distrust(trust_anchor_subject, trust_anchor_spki)?;
+ // TODO: Check signature algorithm like mozilla::pkix.
+ // TODO: Check SPKI like mozilla::pkix.
+ // TODO: check for active distrust like mozilla::pkix.
+
+ // See the comment in `remember_extension` for why we don't check the
+ // KeyUsage extension.
+
+ cert.validity
+ .read_all(Error::BadDer, |value| check_validity(value, time))?;
+ untrusted::read_all_optional(cert.basic_constraints, Error::BadDer, |value| {
+ check_basic_constraints(value, used_as_ca, sub_ca_count)
+ })?;
+ untrusted::read_all_optional(cert.eku, Error::BadDer, |value| {
+ check_eku(value, required_eku_if_present)
+ })?;
+
+ Ok(())
+}
+
+// https://tools.ietf.org/html/rfc5280#section-4.1.2.5
+fn check_validity(input: &mut untrusted::Reader, time: time::Time) -> Result<(), Error> {
+ let not_before = der::time_choice(input)?;
+ let not_after = der::time_choice(input)?;
+
+ if not_before > not_after {
+ return Err(Error::InvalidCertValidity);
+ }
+ if time < not_before {
+ return Err(Error::CertNotValidYet);
+ }
+ if time > not_after {
+ return Err(Error::CertExpired);
+ }
+
+ // TODO: mozilla::pkix allows the TrustDomain to check not_before and
+ // not_after, to enforce things like a maximum validity period. We should
+ // do something similar.
+
+ Ok(())
+}
+
+#[derive(Clone, Copy)]
+enum UsedAsCa {
+ Yes,
+ No,
+}
+
+fn used_as_ca(ee_or_ca: &EndEntityOrCa) -> UsedAsCa {
+ match ee_or_ca {
+ EndEntityOrCa::EndEntity => UsedAsCa::No,
+ EndEntityOrCa::Ca(..) => UsedAsCa::Yes,
+ }
+}
+
+// https://tools.ietf.org/html/rfc5280#section-4.2.1.9
+fn check_basic_constraints(
+ input: Option<&mut untrusted::Reader>,
+ used_as_ca: UsedAsCa,
+ sub_ca_count: usize,
+) -> Result<(), Error> {
+ let (is_ca, path_len_constraint) = match input {
+ Some(input) => {
+ let is_ca = der::optional_boolean(input)?;
+
+ // https://bugzilla.mozilla.org/show_bug.cgi?id=985025: RFC 5280
+ // says that a certificate must not have pathLenConstraint unless
+ // it is a CA certificate, but some real-world end-entity
+ // certificates have pathLenConstraint.
+ let path_len_constraint = if !input.at_end() {
+ let value = der::small_nonnegative_integer(input)?;
+ Some(usize::from(value))
+ } else {
+ None
+ };
+
+ (is_ca, path_len_constraint)
+ }
+ None => (false, None),
+ };
+
+ match (used_as_ca, is_ca, path_len_constraint) {
+ (UsedAsCa::No, true, _) => Err(Error::CaUsedAsEndEntity),
+ (UsedAsCa::Yes, false, _) => Err(Error::EndEntityUsedAsCa),
+ (UsedAsCa::Yes, true, Some(len)) if sub_ca_count > len => {
+ Err(Error::PathLenConstraintViolated)
+ }
+ _ => Ok(()),
+ }
+}
+
+#[derive(Clone, Copy)]
+pub struct KeyPurposeId {
+ oid_value: untrusted::Input<'static>,
+}
+
+// id-pkix OBJECT IDENTIFIER ::= { 1 3 6 1 5 5 7 }
+// id-kp OBJECT IDENTIFIER ::= { id-pkix 3 }
+
+// id-kp-serverAuth OBJECT IDENTIFIER ::= { id-kp 1 }
+#[allow(clippy::identity_op)] // TODO: Make this clearer
+pub static EKU_SERVER_AUTH: KeyPurposeId = KeyPurposeId {
+ oid_value: untrusted::Input::from(&[(40 * 1) + 3, 6, 1, 5, 5, 7, 3, 1]),
+};
+
+// id-kp-clientAuth OBJECT IDENTIFIER ::= { id-kp 2 }
+#[allow(clippy::identity_op)] // TODO: Make this clearer
+pub static EKU_CLIENT_AUTH: KeyPurposeId = KeyPurposeId {
+ oid_value: untrusted::Input::from(&[(40 * 1) + 3, 6, 1, 5, 5, 7, 3, 2]),
+};
+
+// id-kp-OCSPSigning OBJECT IDENTIFIER ::= { id-kp 9 }
+#[allow(clippy::identity_op)] // TODO: Make this clearer
+pub static EKU_OCSP_SIGNING: KeyPurposeId = KeyPurposeId {
+ oid_value: untrusted::Input::from(&[(40 * 1) + 3, 6, 1, 5, 5, 7, 3, 9]),
+};
+
+// https://tools.ietf.org/html/rfc5280#section-4.2.1.12
+//
+// Notable Differences from RFC 5280:
+//
+// * We follow the convention established by Microsoft's implementation and
+// mozilla::pkix of treating the EKU extension in a CA certificate as a
+// restriction on the allowable EKUs for certificates issued by that CA. RFC
+// 5280 doesn't prescribe any meaning to the EKU extension when a certificate
+// is being used as a CA certificate.
+//
+// * We do not recognize anyExtendedKeyUsage. NSS and mozilla::pkix do not
+// recognize it either.
+//
+// * We treat id-Netscape-stepUp as being equivalent to id-kp-serverAuth in CA
+// certificates (only). Comodo has issued certificates that require this
+// behavior that don't expire until June 2020. See https://bugzilla.mozilla.org/show_bug.cgi?id=982292.
+fn check_eku(
+ input: Option<&mut untrusted::Reader>,
+ required_eku_if_present: KeyPurposeId,
+) -> Result<(), Error> {
+ match input {
+ Some(input) => {
+ loop {
+ let value = der::expect_tag_and_get_value(input, der::Tag::OID)?;
+ if equal(value, required_eku_if_present.oid_value) {
+ input.skip_to_end();
+ break;
+ }
+ if input.at_end() {
+ return Err(Error::RequiredEkuNotFound);
+ }
+ }
+ Ok(())
+ }
+ None => {
+ // http://tools.ietf.org/html/rfc6960#section-4.2.2.2:
+ // "OCSP signing delegation SHALL be designated by the inclusion of
+ // id-kp-OCSPSigning in an extended key usage certificate extension
+ // included in the OCSP response signer's certificate."
+ //
+ // A missing EKU extension generally means "any EKU", but it is
+ // important that id-kp-OCSPSigning is explicit so that a normal
+ // end-entity certificate isn't able to sign trusted OCSP responses
+ // for itself or for other certificates issued by its issuing CA.
+ if equal(
+ required_eku_if_present.oid_value,
+ EKU_OCSP_SIGNING.oid_value,
+ ) {
+ return Err(Error::RequiredEkuNotFound);
+ }
+
+ Ok(())
+ }
+ }
+}
+
+fn loop_while_non_fatal_error<V>(
+ values: V,
+ mut f: impl FnMut(V::Item) -> Result<(), ErrorExt>,
+) -> Result<(), ErrorExt>
+where
+ V: IntoIterator,
+{
+ for v in values {
+ match f(v) {
+ Ok(()) => {
+ return Ok(());
+ }
+ Err(e) => {
+ if e.is_fatal() {
+ return Err(e);
+ }
+ // If the error is not fatal, then keep going.
+ }
+ }
+ }
+ Err(Error::UnknownIssuer.into())
+}
diff --git a/crates/webpki/tests/dns_name_tests.rs b/crates/webpki/tests/dns_name_tests.rs
new file mode 100644
index 0000000..0e51999
--- /dev/null
+++ b/crates/webpki/tests/dns_name_tests.rs
@@ -0,0 +1,408 @@
+// Copyright 2014-2017 Brian Smith.
+
+// (name, is_valid)
+static DNS_NAME_VALIDITY: &[(&[u8], bool)] = &[
+ (b"a", true),
+ (b"a.b", true),
+ (b"a.b.c", true),
+ (b"a.b.c.d", true),
+
+ // Hyphens, one component.
+ (b"-", false),
+ (b"-a", false),
+ (b"a-", false),
+ (b"a-b", true),
+
+ // Hyphens, last component.
+ (b"a.-", false),
+ (b"a.-a", false),
+ (b"a.a-", false),
+ (b"a.a-b", true),
+
+ // Hyphens, not last component.
+ (b"-.a", false),
+ (b"-a.a", false),
+ (b"a-.a", false),
+ (b"a-b.a", true),
+
+ // Underscores, one component.
+ (b"_", true), // TODO: Perhaps this should be rejected for '_' being sole character?.
+ (b"_a", true), // TODO: Perhaps this should be rejected for '_' being 1st?
+ (b"a_", true),
+ (b"a_b", true),
+
+ // Underscores, last component.
+ (b"a._", true), // TODO: Perhaps this should be rejected for '_' being sole character?.
+ (b"a._a", true), // TODO: Perhaps this should be rejected for '_' being 1st?
+ (b"a.a_", true),
+ (b"a.a_b", true),
+
+ // Underscores, not last component.
+ (b"_.a", true), // TODO: Perhaps this should be rejected for '_' being sole character?.
+ (b"_a.a", true),
+ (b"a_.a", true),
+ (b"a_b.a", true),
+
+ // empty labels
+ (b"", false),
+ (b".", false),
+ (b"a", true),
+ (b".a", false),
+ (b".a.b", false),
+ (b"..a", false),
+ (b"a..b", false),
+ (b"a...b", false),
+ (b"a..b.c", false),
+ (b"a.b..c", false),
+ (b".a.b.c.", false),
+
+ // absolute names
+ (b"a.", true),
+ (b"a.b.", true),
+ (b"a.b.c.", true),
+
+ // absolute names with empty label at end
+ (b"a..", false),
+ (b"a.b..", false),
+ (b"a.b.c..", false),
+ (b"a...", false),
+
+ // Punycode
+ (b"xn--", false),
+ (b"xn--.", false),
+ (b"xn--.a", false),
+ (b"a.xn--", false),
+ (b"a.xn--.", false),
+ (b"a.xn--.b", false),
+ (b"a.xn--.b", false),
+ (b"a.xn--\0.b", false),
+ (b"a.xn--a.b", true),
+ (b"xn--a", true),
+ (b"a.xn--a", true),
+ (b"a.xn--a.a", true),
+ (b"\xc4\x95.com", false), // UTF-8 ĕ
+ (b"xn--jea.com", true), // punycode ĕ
+ (b"xn--\xc4\x95.com", false), // UTF-8 ĕ, malformed punycode + UTF-8 mashup
+
+ // Surprising punycode
+ (b"xn--google.com", true), // 䕮䕵䕶䕱.com
+ (b"xn--citibank.com", true), // 岍岊岊岅岉岎.com
+ (b"xn--cnn.com", true), // 䁾.com
+ (b"a.xn--cnn", true), // a.䁾
+ (b"a.xn--cnn.com", true), // a.䁾.com
+
+ (b"1.2.3.4", false), // IPv4 address
+ (b"1::2", false), // IPV6 address
+
+ // whitespace not allowed anywhere.
+ (b" ", false),
+ (b" a", false),
+ (b"a ", false),
+ (b"a b", false),
+ (b"a.b 1", false),
+ (b"a\t", false),
+
+ // Nulls not allowed
+ (b"\0", false),
+ (b"a\0", false),
+ (b"example.org\0.example.com", false), // Hi Moxie!
+ (b"\0a", false),
+ (b"xn--\0", false),
+
+ // Allowed character set
+ (b"a.b.c.d.e.f.g.h.i.j.k.l.m.n.o.p.q.r.s.t.u.v.w.x.y.z", true),
+ (b"A.B.C.D.E.F.G.H.I.J.K.L.M.N.O.P.Q.R.S.T.U.V.W.X.Y.Z", true),
+ (b"0.1.2.3.4.5.6.7.8.9.a", true), // "a" needed to avoid numeric last label
+ (b"a-b", true), // hyphen (a label cannot start or end with a hyphen)
+
+ // An invalid character in various positions
+ (b"!", false),
+ (b"!a", false),
+ (b"a!", false),
+ (b"a!b", false),
+ (b"a.!", false),
+ (b"a.a!", false),
+ (b"a.!a", false),
+ (b"a.a!a", false),
+ (b"a.!a.a", false),
+ (b"a.a!.a", false),
+ (b"a.a!a.a", false),
+
+ // Various other invalid characters
+ (b"a!", false),
+ (b"a@", false),
+ (b"a#", false),
+ (b"a$", false),
+ (b"a%", false),
+ (b"a^", false),
+ (b"a&", false),
+ (b"a*", false),
+ (b"a(", false),
+ (b"a)", false),
+
+ // last label can't be fully numeric
+ (b"1", false),
+ (b"a.1", false),
+
+ // other labels can be fully numeric
+ (b"1.a", true),
+ (b"1.2.a", true),
+ (b"1.2.3.a", true),
+
+ // last label can be *partly* numeric
+ (b"1a", true),
+ (b"1.1a", true),
+ (b"1-1", true),
+ (b"a.1-1", true),
+ (b"a.1-a", true),
+
+ // labels cannot start with a hyphen
+ (b"-", false),
+ (b"-1", false),
+
+ // labels cannot end with a hyphen
+ (b"1-", false),
+ (b"1-.a", false),
+ (b"a-", false),
+ (b"a-.a", false),
+ (b"a.1-.a", false),
+ (b"a.a-.a", false),
+
+ // labels can contain a hyphen in the middle
+ (b"a-b", true),
+ (b"1-2", true),
+ (b"a.a-1", true),
+
+ // multiple consecutive hyphens allowed
+ (b"a--1", true),
+ (b"1---a", true),
+ (b"a-----------------b", true),
+
+ // Wildcard specifications are not valid reference names.
+ (b"*.a", false),
+ (b"a*", false),
+ (b"a*.", false),
+ (b"a*.a", false),
+ (b"a*.a.", false),
+ (b"*.a.b", false),
+ (b"*.a.b.", false),
+ (b"a*.b.c", false),
+ (b"*.a.b.c", false),
+ (b"a*.b.c.d", false),
+
+ // Multiple wildcards.
+ (b"a**.b.c", false),
+ (b"a*b*.c.d", false),
+ (b"a*.b*.c", false),
+
+ // Wildcards not in the first label.
+ (b"a.*", false),
+ (b"a.*.b", false),
+ (b"a.b.*", false),
+ (b"a.b*.c", false),
+ (b"*.b*.c", false),
+ (b".*.a.b", false),
+ (b".a*.b.c", false),
+
+ // Wildcards not at the end of the first label.
+ (b"*a.b.c", false),
+ (b"a*b.c.d", false),
+
+ // Wildcards and IDNA prefix.
+ (b"x*.a.b", false),
+ (b"xn*.a.b", false),
+ (b"xn-*.a.b", false),
+ (b"xn--*.a.b", false),
+ (b"xn--w*.a.b", false),
+
+ // Redacted labels from RFC6962bis draft 4
+ // https://tools.ietf.org/html/draft-ietf-trans-rfc6962-bis-04#section-3.2.2
+ (b"(PRIVATE).foo", false),
+
+ // maximum label length is 63 characters
+ (b"123456789012345678901234567890123456789012345678901234567890abc", true),
+ (b"123456789012345678901234567890123456789012345678901234567890abcd", false),
+
+ // maximum total length is 253 characters
+ (b"12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.123456789012345678901234567890123456789012345678a",
+ true),
+ (b"12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.12345678901234567890123456789012345678901234567890.1234567890123456789012345678901234567890123456789a",
+ false),
+];
+
+// (IP address, is valid DNS name). The comments here refer to the validity of
+// the string as an IP address, not as a DNS name validity.
+static IP_ADDRESS_DNS_VALIDITY: &[(&[u8], bool)] = &[
+ (b"", false),
+ (b"1", false),
+ (b"1.2", false),
+ (b"1.2.3", false),
+ (b"1.2.3.4", false),
+ (b"1.2.3.4.5", false),
+ (b"1.2.3.4a", true), // a DNS name!
+ (b"a.2.3.4", false), // not even a DNS name!
+ (b"1::2", false), // IPv6 address
+ // Whitespace not allowed
+ (b" 1.2.3.4", false),
+ (b"1.2.3.4 ", false),
+ (b"1 .2.3.4", false),
+ (b"\n1.2.3.4", false),
+ (b"1.2.3.4\n", false),
+ // Nulls not allowed
+ (b"\0", false),
+ (b"\x001.2.3.4", false),
+ (b"1.2.3.4\0", false),
+ (b"1.2.3.4\0.5", false),
+ // Range
+ (b"0.0.0.0", false),
+ (b"255.255.255.255", false),
+ (b"256.0.0.0", false),
+ (b"0.256.0.0", false),
+ (b"0.0.256.0", false),
+ (b"0.0.0.256", false),
+ (b"999.0.0.0", false),
+ (b"9999999999999999999.0.0.0", false),
+ // All digits allowed
+ (b"0.1.2.3", false),
+ (b"4.5.6.7", false),
+ (b"8.9.0.1", false),
+ // Leading zeros not allowed
+ (b"01.2.3.4", false),
+ (b"001.2.3.4", false),
+ (b"00000000001.2.3.4", false),
+ (b"010.2.3.4", false),
+ (b"1.02.3.4", false),
+ (b"1.2.03.4", false),
+ (b"1.2.3.04", false),
+ // Empty components
+ (b".2.3.4", false),
+ (b"1..3.4", false),
+ (b"1.2..4", false),
+ (b"1.2.3.", false),
+ // Too many components
+ (b"1.2.3.4.5", false),
+ (b"1.2.3.4.5.6", false),
+ (b"0.1.2.3.4", false),
+ (b"1.2.3.4.0", false),
+ // Leading/trailing dot
+ (b".1.2.3.4", false),
+ (b"1.2.3.4.", false),
+ // Other common forms of IPv4 address
+ // http://en.wikipedia.org/wiki/IPv4#Address_representations
+ (b"192.0.2.235", false), // dotted decimal (control value)
+ (b"0xC0.0x00.0x02.0xEB", true), // dotted hex - actually a DNS name!
+ (b"0301.0000.0002.0353", false), // dotted octal
+ (b"0xC00002EB", true), // non-dotted hex, actually a DNS name!
+ (b"3221226219", false), // non-dotted decimal
+ (b"030000001353", false), // non-dotted octal
+ (b"192.0.0002.0xEB", true), // mixed, actually a DNS name!
+ (b"1234", false),
+ (b"1234:5678", false),
+ (b"1234:5678:9abc", false),
+ (b"1234:5678:9abc:def0", false),
+ (b"1234:5678:9abc:def0:1234:", false),
+ (b"1234:5678:9abc:def0:1234:5678:", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc:", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc:def0:", false),
+ (b":1234:5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc:def0:0000", false),
+ // Valid contractions
+ (b"::1", false),
+ (b"::1234", false),
+ (b"1234::", false),
+ (b"1234::5678", false),
+ (b"1234:5678::abcd", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc::", false),
+ // Contraction in full IPv6 addresses not allowed
+ (b"::1234:5678:9abc:def0:1234:5678:9abc:def0", false), // start
+ (b"1234:5678:9abc:def0:1234:5678:9abc:def0::", false), // end
+ (b"1234:5678::9abc:def0:1234:5678:9abc:def0", false), // interior
+ // Multiple contractions not allowed
+ (b"::1::", false),
+ (b"::1::2", false),
+ (b"1::2::", false),
+ // Colon madness!
+ (b":", false),
+ (b"::", false),
+ (b":::", false),
+ (b"::::", false),
+ (b":::1", false),
+ (b"::::1", false),
+ (b"1:::2", false),
+ (b"1::::2", false),
+ (b"1:2:::", false),
+ (b"1:2::::", false),
+ (b"::1234:", false),
+ (b":1234::", false),
+ (b"01234::", false), // too many digits, even if zero
+ (b"12345678::", false), // too many digits or missing colon
+ // uppercase
+ (b"ABCD:EFAB::", false),
+ // miXeD CAse
+ (b"aBcd:eFAb::", false),
+ // IPv4-style
+ (b"::2.3.4.5", false),
+ (b"1234::2.3.4.5", false),
+ (b"::abcd:2.3.4.5", false),
+ (b"1234:5678:9abc:def0:1234:5678:252.253.254.255", false),
+ (b"1234:5678:9abc:def0:1234::252.253.254.255", false),
+ (b"1234::252.253.254", false),
+ (b"::252.253.254", false),
+ (b"::252.253.254.300", false),
+ (b"1234::252.253.254.255:", false),
+ (b"1234::252.253.254.255:5678", false),
+ // Contractions that don't contract
+ (b"::1234:5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"1234:5678:9abc:def0:1234:5678:9abc:def0::", false),
+ (b"1234:5678:9abc:def0::1234:5678:9abc:def0", false),
+ (b"1234:5678:9abc:def0:1234:5678::252.253.254.255", false),
+ // With and without leading zeros
+ (b"::123", false),
+ (b"::0123", false),
+ (b"::012", false),
+ (b"::0012", false),
+ (b"::01", false),
+ (b"::001", false),
+ (b"::0001", false),
+ (b"::0", false),
+ (b"::00", false),
+ (b"::000", false),
+ (b"::0000", false),
+ (b"::01234", false),
+ (b"::00123", false),
+ (b"::000123", false),
+ // Trailing zero
+ (b"::12340", false),
+ // Whitespace
+ (b" 1234:5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"\t1234:5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"\t1234:5678:9abc:def0:1234:5678:9abc:def0\n", false),
+ (b"1234 :5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b"1234: 5678:9abc:def0:1234:5678:9abc:def0", false),
+ (b":: 2.3.4.5", false),
+ (b"1234::252.253.254.255 ", false),
+ (b"1234::252.253.254.255\n", false),
+ (b"1234::252.253. 254.255", false),
+ // Nulls
+ (b"\0", false),
+ (b"::1\0:2", false),
+ (b"::1\0", false),
+ (b"::1.2.3.4\0", false),
+ (b"::1.2\x002.3.4", false),
+];
+
+#[test]
+fn dns_name_ref_try_from_ascii_test() {
+ for &(s, is_valid) in DNS_NAME_VALIDITY
+ .iter()
+ .chain(IP_ADDRESS_DNS_VALIDITY.iter())
+ {
+ assert_eq!(
+ webpki::DnsNameRef::try_from_ascii(s).is_ok(),
+ is_valid,
+ "DnsNameRef::try_from_ascii_str failed for \"{:?}\"",
+ s
+ );
+ }
+}
diff --git a/crates/webpki/tests/ed25519/ca.der b/crates/webpki/tests/ed25519/ca.der
new file mode 100644
index 0000000..9994daf
--- /dev/null
+++ b/crates/webpki/tests/ed25519/ca.der
Binary files differ
diff --git a/crates/webpki/tests/ed25519/ee.der b/crates/webpki/tests/ed25519/ee.der
new file mode 100644
index 0000000..5181f7b
--- /dev/null
+++ b/crates/webpki/tests/ed25519/ee.der
Binary files differ
diff --git a/crates/webpki/tests/integration.rs b/crates/webpki/tests/integration.rs
new file mode 100644
index 0000000..598641d
--- /dev/null
+++ b/crates/webpki/tests/integration.rs
@@ -0,0 +1,91 @@
+// Copyright 2016 Joseph Birr-Pixton.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+use core::convert::TryFrom;
+extern crate webpki;
+
+static ALL_SIGALGS: &[&webpki::SignatureAlgorithm] = &[
+ &webpki::ECDSA_P256_SHA256,
+ &webpki::ECDSA_P256_SHA384,
+ &webpki::ECDSA_P384_SHA256,
+ &webpki::ECDSA_P384_SHA384,
+ &webpki::ED25519,
+ #[cfg(feature = "alloc")]
+ &webpki::RSA_PKCS1_2048_8192_SHA256,
+ #[cfg(feature = "alloc")]
+ &webpki::RSA_PKCS1_2048_8192_SHA384,
+ #[cfg(feature = "alloc")]
+ &webpki::RSA_PKCS1_2048_8192_SHA512,
+ #[cfg(feature = "alloc")]
+ &webpki::RSA_PKCS1_3072_8192_SHA384,
+];
+
+/* Checks we can verify netflix's cert chain. This is notable
+ * because they're rooted at a Verisign v1 root. */
+#[cfg(feature = "alloc")]
+#[test]
+pub fn netflix() {
+ let ee: &[u8] = include_bytes!("netflix/ee.der");
+ let inter = include_bytes!("netflix/inter.der");
+ let ca = include_bytes!("netflix/ca.der");
+
+ let anchors = vec![webpki::TrustAnchor::try_from_cert_der(ca).unwrap()];
+ let anchors = webpki::TlsServerTrustAnchors(&anchors);
+
+ #[allow(clippy::unreadable_literal)] // TODO: Make this clear.
+ let time = webpki::Time::from_seconds_since_unix_epoch(1492441716);
+
+ let cert = webpki::EndEntityCert::try_from(ee).unwrap();
+ assert_eq!(
+ Ok(()),
+ cert.verify_is_valid_tls_server_cert(ALL_SIGALGS, &anchors, &[inter], time)
+ );
+}
+
+#[test]
+pub fn ed25519() {
+ let ee: &[u8] = include_bytes!("ed25519/ee.der");
+ let ca = include_bytes!("ed25519/ca.der");
+
+ let anchors = vec![webpki::TrustAnchor::try_from_cert_der(ca).unwrap()];
+ let anchors = webpki::TlsServerTrustAnchors(&anchors);
+
+ #[allow(clippy::unreadable_literal)] // TODO: Make this clear.
+ let time = webpki::Time::from_seconds_since_unix_epoch(1547363522);
+
+ let cert = webpki::EndEntityCert::try_from(ee).unwrap();
+ assert_eq!(
+ Ok(()),
+ cert.verify_is_valid_tls_server_cert(ALL_SIGALGS, &anchors, &[], time)
+ );
+}
+
+#[test]
+fn read_root_with_zero_serial() {
+ let ca = include_bytes!("misc/serial_zero.der");
+ let _ =
+ webpki::TrustAnchor::try_from_cert_der(ca).expect("godaddy cert should parse as anchor");
+}
+
+#[test]
+fn read_root_with_neg_serial() {
+ let ca = include_bytes!("misc/serial_neg.der");
+ let _ = webpki::TrustAnchor::try_from_cert_der(ca).expect("idcat cert should parse as anchor");
+}
+
+#[cfg(feature = "std")]
+#[test]
+fn time_constructor() {
+ let _ = webpki::Time::try_from(std::time::SystemTime::now()).unwrap();
+}
diff --git a/crates/webpki/tests/misc/serial_neg.der b/crates/webpki/tests/misc/serial_neg.der
new file mode 100644
index 0000000..f1317bf
--- /dev/null
+++ b/crates/webpki/tests/misc/serial_neg.der
Binary files differ
diff --git a/crates/webpki/tests/misc/serial_zero.der b/crates/webpki/tests/misc/serial_zero.der
new file mode 100644
index 0000000..3cd289b
--- /dev/null
+++ b/crates/webpki/tests/misc/serial_zero.der
Binary files differ
diff --git a/crates/webpki/tests/netflix/ca.der b/crates/webpki/tests/netflix/ca.der
new file mode 100644
index 0000000..6a15da3
--- /dev/null
+++ b/crates/webpki/tests/netflix/ca.der
Binary files differ
diff --git a/crates/webpki/tests/netflix/ee.der b/crates/webpki/tests/netflix/ee.der
new file mode 100644
index 0000000..c06fbe5
--- /dev/null
+++ b/crates/webpki/tests/netflix/ee.der
Binary files differ
diff --git a/crates/webpki/tests/netflix/inter.der b/crates/webpki/tests/netflix/inter.der
new file mode 100644
index 0000000..ff25d78
--- /dev/null
+++ b/crates/webpki/tests/netflix/inter.der
Binary files differ
diff --git a/crates/webpki/third-party/bettertls/LICENSE b/crates/webpki/third-party/bettertls/LICENSE
new file mode 100644
index 0000000..4947287
--- /dev/null
+++ b/crates/webpki/third-party/bettertls/LICENSE
@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
\ No newline at end of file
diff --git a/crates/webpki/third-party/bettertls/README.md b/crates/webpki/third-party/bettertls/README.md
new file mode 100644
index 0000000..9c12dc8
--- /dev/null
+++ b/crates/webpki/third-party/bettertls/README.md
@@ -0,0 +1,17 @@
+# BetterTLS Test Suite
+
+Generated using the Netflix [bettertls] project.
+
+[bettertls]: https://github.com/Netflix/bettertls
+
+## Pathbuilding
+
+To regenerate pathbuilding test data:
+
+1. Install Go
+2. Generate the JSON testdata export for the path building suite:
+
+```bash
+GOBIN=$PWD go install github.com/Netflix/bettertls/test-suites/cmd/bettertls@latest
+./bettertls export-tests --suite pathbuilding --out ./pathbuilding.tests.json
+```
diff --git a/crates/webpki/third-party/chromium/LICENSE b/crates/webpki/third-party/chromium/LICENSE
new file mode 100644
index 0000000..a32e00c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/LICENSE
@@ -0,0 +1,27 @@
+// Copyright 2015 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/README b/crates/webpki/third-party/chromium/data/verify_signed_data/README
new file mode 100644
index 0000000..2acf6e6
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/README
@@ -0,0 +1,35 @@
+This directory contains test data for testing net::VerifySignedData().
+
+When adding or changing test data, run the script
+ $ python annotate_test_data.py
+
+This script will apply a uniform formatting. For instance it will add a
+comment showing what the parsed ASN.1 looks like, and reformat the base64 to
+have consistent line breaks.
+
+The general format for the test files is as follows:
+
+
+ <A description of the test>
+
+ -----BEGIN PUBLIC KEY-----
+ <base64-encoded, DER-encoded, SPKI>
+ -----END PUBLIC KEY-----
+
+ -----BEGIN ALGORITHM-----
+ <base64-encoded, DER-encoded, AlgorithmIdentifier for the signature.>
+ -----END ALGORITHM-----
+
+ -----BEGIN DATA-----
+ <base64-encoded data that is being verified>
+ -----END DATA-----
+
+ -----BEGIN SIGNATURE-----
+ <base64-encoded, DER-encoded, BIT STRING of the signature>
+ -----END SIGNATURE-----
+
+
+Comments for a PEM block should be placed immediately below that block.
+The script will also insert a comment after the block describing its parsed
+ASN.1 structure (your extra comments need to be above the script-generated
+comments or they will be stripped).
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-spki-params-null.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-spki-params-null.pem
new file mode 100644
index 0000000..6f65be1
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-spki-params-null.pem
@@ -0,0 +1,45 @@
+This is the same test as ecdsa-prime256v1-sha512.pem except the public key's
+algorithm has been tampered with. The parameters for ecPublicKey should be a
+namedCurve, but here they have been replaced by NULL.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFEwCwYHKoZIzj0CAQUAA0IABJywz2kwPa/HYdTkaHtOzwOebTSrlkr4CBDY1VikqNb3LVEjOhe
+IkgqG7gihlix576MX+3h54pfa0hRtuZX6HHg=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 81 cons: SEQUENCE
+ 2:d=1 hl=2 l= 11 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 0 prim: NULL
+ 15:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cAMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-unused-bits-signature.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-unused-bits-signature.pem
new file mode 100644
index 0000000..24efda0
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-unused-bits-signature.pem
@@ -0,0 +1,53 @@
+This is the same test as ecdsa-prime256v1-sha512.pem, however the SIGNATURE has
+been changed to a (valid) BIT STRING containing two unused bits.
+
+Note that the last two bits of the original signature were 0, so the
+DER-encoded bytes portion of the mutated BIT STRING remains the same. All that
+changes is the octet at the start which indicates the number of unused bits.
+
+In other words SIGNATURE changes from:
+ 03 47 00 30 ... 84
+To:
+ 03 47 02 30 ... 84
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEnLDPaTA9r8dh1ORoe07PA55tNKuWSvgIENjVWKS
+o1vctUSM6F4iSCobuCKGWLHnvoxf7eHnil9rSFG25lfoceA==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 89 cons: SEQUENCE
+ 2:d=1 hl=2 l= 19 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 23:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cCMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecdh-key.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecdh-key.pem
new file mode 100644
index 0000000..4f3e26c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecdh-key.pem
@@ -0,0 +1,48 @@
+This uses the same test data as ecdsa-prime256v1-sha512.pem, HOWEVER the
+algorithm OID for the public key has been changed from id-ecPublicKey
+(1.2.840.10045.2.1) to id-ecDH (1.3.132.1.12)
+
+This test should fail because the public key's algorithm does not match that of
+the signature algorithm.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFcwEQYFK4EEAQwGCCqGSM49AwEHA0IABJywz2kwPa/HYdTkaHtOzwOebTSrlkr4CBDY1VikqNb
+3LVEjOheIkgqG7gihlix576MX+3h54pfa0hRtuZX6HHg=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 87 cons: SEQUENCE
+ 2:d=1 hl=2 l= 17 cons: SEQUENCE
+ 4:d=2 hl=2 l= 5 prim: OBJECT :1.3.132.1.12
+ 11:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 21:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cAMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecmqv-key.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecmqv-key.pem
new file mode 100644
index 0000000..d0b906f
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-ecmqv-key.pem
@@ -0,0 +1,48 @@
+This uses the same test data as ecdsa-prime256v1-sha512.pem, HOWEVER the
+algorithm OID for the public key has been changed from id-ecPublicKey
+(1.2.840.10045.2.1) to id-ecMQV (1.3.132.1.13)
+
+This test should fail because the public key's algorithm does not match that of
+the signature algorithm.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFcwEQYFK4EEAQ0GCCqGSM49AwEHA0IABJywz2kwPa/HYdTkaHtOzwOebTSrlkr4CBDY1VikqNb
+3LVEjOheIkgqG7gihlix576MX+3h54pfa0hRtuZX6HHg=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 87 cons: SEQUENCE
+ 2:d=1 hl=2 l= 17 cons: SEQUENCE
+ 4:d=2 hl=2 l= 5 prim: OBJECT :1.3.132.1.13
+ 11:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 21:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cAMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-rsa-algorithm.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-rsa-algorithm.pem
new file mode 100644
index 0000000..8085486
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-using-rsa-algorithm.pem
@@ -0,0 +1,48 @@
+This test specified a valid ECDSA signature and EC key (the same as ecdsa-prime256v1-sha512.pem)
+
+The problem however is the signature algorithm is indicated as being RSA PKCS#1 v1.5.
+
+Signature verification consequently should fail.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEnLDPaTA9r8dh1ORoe07PA55tNKuWSvgIENjVWKS
+o1vctUSM6F4iSCobuCKGWLHnvoxf7eHnil9rSFG25lfoceA==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 89 cons: SEQUENCE
+ 2:d=1 hl=2 l= 19 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 23:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBDQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha512WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cAMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-wrong-signature-format.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-wrong-signature-format.pem
new file mode 100644
index 0000000..d51317c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512-wrong-signature-format.pem
@@ -0,0 +1,47 @@
+This is the same as ecdsa-prime256v1-sha512.pem, except the signature is wrong.
+
+Rather than encoding the signature into a DER-encoded Ecdsa-Sig-Value, it is a
+concatenation of the r and s values. This is the format that WebCrypto uses for
+ECDSA signature, but not what is used for digital signatures.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEnLDPaTA9r8dh1ORoe07PA55tNKuWSvgIENjVWKS
+o1vctUSM6F4iSCobuCKGWLHnvoxf7eHnil9rSFG25lfoceA==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 89 cons: SEQUENCE
+ 2:d=1 hl=2 l= 19 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 23:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0EAS5+R5ChShyYaHRySPPYZzVLBdc/n8b5gpSWMYQNIuj0oxF+QHXHEGymGOOwNaoXX/LDDO7/
+sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 65 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512.pem
new file mode 100644
index 0000000..54f490c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-prime256v1-sha512.pem
@@ -0,0 +1,49 @@
+The key, message, and signature come from:
+http://csrc.nist.gov/groups/STM/cavp/documents/dss/186-3ecdsatestvectors.zip (SigVer.rsp)
+
+The algorithm DER was synthesized to match, and the signature (provided as an r
+and s tuple) was encoded into a Ecdsa-Sig-Value and then a BIT STRING.
+
+It uses ECDSA verification, using curve prime256v1 and SHA-512
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEnLDPaTA9r8dh1ORoe07PA55tNKuWSvgIENjVWKS
+o1vctUSM6F4iSCobuCKGWLHnvoxf7eHnil9rSFG25lfoceA==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 89 cons: SEQUENCE
+ 2:d=1 hl=2 l= 19 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 23:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAME
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA512
+
+
+
+-----BEGIN DATA-----
+bikyFTMBpO72gOZCiSmtrpiMEI1mijH/VdBImUfXX/gaRr+J6E1kAfAjvm6HaI+814TXhcqEZzV
+SSstS0ARSyEBApHnnzDMJNkQdk7vnIqlDKm4dsRK1yUA7ECcssTR/1hnUY/ep0iOtdv3gbYpog1
+APuEMjWr/5jiQb37VTjD4=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A0cAMEQCIEufkeQoUocmGh0ckjz2Gc1SwXXP5/G+YKUljGEDSLo9AiAoxF+QHXHEGymGOOwNaoX
+X/LDDO7/sWpyBCEa2OSiahA==
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 71 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256-corrupted-data.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256-corrupted-data.pem
new file mode 100644
index 0000000..5f5380b
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256-corrupted-data.pem
@@ -0,0 +1,53 @@
+This is the same test as ecdsa-secp384r1-sha256.pem, except the DATA section
+has been corrupted. The third byte has been set to 0.
+
+This signature should NOT verify successfully.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEXFhBi+WKXuxeK9yCbC9jqEchwjCNsQ4RXAsJ07oHZ+Q
+qz55cNIY5BAhcQ0QYY5jv9BimGL9SuhUuOSuS3Pn9rrsIFGcFsihy4kDr8rq5+7RbN8bV057gW5
+emYjLtvDsQ
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 118 cons: SEQUENCE
+ 2:d=1 hl=2 l= 16 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 5 prim: OBJECT :secp384r1
+ 20:d=1 hl=2 l= 98 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAMC
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA256
+
+
+
+-----BEGIN DATA-----
+MIIA6KADAgECAgkAtUVxft6/Vc0wCgYIKoZIzj0EAwIwbzELMAkGA1UEBhMCQVUxEzARBgNVBAg
+MClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEMMAoGA1UEAw
+wDYWhhMRowGAYJKoZIhvcNAQkBFgtzdXBAZm9vLmNvbTAeFw0xNTA3MDIwMDM4MTRaFw0xNjA3M
+DEwMDM4MTRaMG8xCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJ
+bnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxDDAKBgNVBAMMA2FoYTEaMBgGCSqGSIb3DQEJARYLc3V
+wQGZvby5jb20wdjAQBgcqhkjOPQIBBgUrgQQAIgNiAARcWEGL5Ype7F4r3IJsL2OoRyHCMI2xDh
+FcCwnTugdn5CrPnlw0hjkECFxDRBhjmO/0GKYYv1K6FS45K5Lc+f2uuwgUZwWyKHLiQOvyurn7t
+Fs3xtXTnuBbl6ZiMu28OxCjUDBOMB0GA1UdDgQWBBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAfBgNV
+HSMEGDAWgBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAMBgNVHRMEBTADAQH/
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A2kAMGYCMQCDwMSZVJZ8qThiNTV7VX57m8fdNnNS6cXIjRYoh4SozlYWmWGh87nhmJJCeD16jVM
+CMQDkroAY8oNi8RxLUor+LozhhVgu24tu6lcp4MP8H3Zy8bBea5HerAd1AqJp3Ox7KDU=
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 105 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256.pem
new file mode 100644
index 0000000..d5c3798
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-secp384r1-sha256.pem
@@ -0,0 +1,84 @@
+This test data was produced by creating a self-signed EC cert using OpenSSL,
+and then extracting the relevant fields.
+
+It uses ECDSA with curve secp384r1 an SHA-256.
+
+(1) Generate self-signed certificate
+
+ openssl ecparam -out ec_key.pem -name secp384r1 -genkey
+ openssl req -new -key ec_key.pem -x509 -nodes -days 365 -out cert.pem
+
+(2) Extract public key
+
+ openssl x509 -in cert.pem -pubkey -noout > pubkey.pem
+ cat pubkey.pem
+
+(3) Extract signed data (tbsCertificate)
+
+ openssl asn1parse -in cert.pem -out tbs -noout -strparse 4
+ base64 tbs
+
+(4) Extract signature algorithm
+
+ # Find the offset of the signature algorithm near the end (496 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out alg -noout -strparse 496
+ base64 alg
+
+(5) Extract the signature
+
+ # Find the final offset of BIT STRING (508 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out sig -noout -strparse 508
+ base64 sig
+
+
+
+-----BEGIN PUBLIC KEY-----
+MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEXFhBi+WKXuxeK9yCbC9jqEchwjCNsQ4RXAsJ07oHZ+Q
+qz55cNIY5BAhcQ0QYY5jv9BimGL9SuhUuOSuS3Pn9rrsIFGcFsihy4kDr8rq5+7RbN8bV057gW5
+emYjLtvDsQ
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 118 cons: SEQUENCE
+ 2:d=1 hl=2 l= 16 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 5 prim: OBJECT :secp384r1
+ 20:d=1 hl=2 l= 98 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAMC
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA256
+
+
+
+-----BEGIN DATA-----
+MIIB6KADAgECAgkAtUVxft6/Vc0wCgYIKoZIzj0EAwIwbzELMAkGA1UEBhMCQVUxEzARBgNVBAg
+MClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEMMAoGA1UEAw
+wDYWhhMRowGAYJKoZIhvcNAQkBFgtzdXBAZm9vLmNvbTAeFw0xNTA3MDIwMDM4MTRaFw0xNjA3M
+DEwMDM4MTRaMG8xCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJ
+bnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxDDAKBgNVBAMMA2FoYTEaMBgGCSqGSIb3DQEJARYLc3V
+wQGZvby5jb20wdjAQBgcqhkjOPQIBBgUrgQQAIgNiAARcWEGL5Ype7F4r3IJsL2OoRyHCMI2xDh
+FcCwnTugdn5CrPnlw0hjkECFxDRBhjmO/0GKYYv1K6FS45K5Lc+f2uuwgUZwWyKHLiQOvyurn7t
+Fs3xtXTnuBbl6ZiMu28OxCjUDBOMB0GA1UdDgQWBBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAfBgNV
+HSMEGDAWgBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAMBgNVHRMEBTADAQH/
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A2kAMGYCMQCDwMSZVJZ8qThiNTV7VX57m8fdNnNS6cXIjRYoh4SozlYWmWGh87nhmJJCeD16jVM
+CMQDkroAY8oNi8RxLUor+LozhhVgu24tu6lcp4MP8H3Zy8bBea5HerAd1AqJp3Ox7KDU=
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 105 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-using-rsa-key.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-using-rsa-key.pem
new file mode 100644
index 0000000..653bcd7
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ecdsa-using-rsa-key.pem
@@ -0,0 +1,51 @@
+This test specifies an ECDSA signature algorithm (and a valid ecdsa signature),
+HOWEVER it provides an RSA key. Verification should fail.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAMC
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA256
+
+
+
+-----BEGIN DATA-----
+MIIB6KADAgECAgkAtUVxft6/Vc0wCgYIKoZIzj0EAwIwbzELMAkGA1UEBhMCQVUxEzARBgNVBAg
+MClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEMMAoGA1UEAw
+wDYWhhMRowGAYJKoZIhvcNAQkBFgtzdXBAZm9vLmNvbTAeFw0xNTA3MDIwMDM4MTRaFw0xNjA3M
+DEwMDM4MTRaMG8xCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJ
+bnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQxDDAKBgNVBAMMA2FoYTEaMBgGCSqGSIb3DQEJARYLc3V
+wQGZvby5jb20wdjAQBgcqhkjOPQIBBgUrgQQAIgNiAARcWEGL5Ype7F4r3IJsL2OoRyHCMI2xDh
+FcCwnTugdn5CrPnlw0hjkECFxDRBhjmO/0GKYYv1K6FS45K5Lc+f2uuwgUZwWyKHLiQOvyurn7t
+Fs3xtXTnuBbl6ZiMu28OxCjUDBOMB0GA1UdDgQWBBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAfBgNV
+HSMEGDAWgBR6nDgtPalG2JvSlWzdGRCi/Cu7NjAMBgNVHRMEBTADAQH/
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A2kAMGYCMQCDwMSZVJZ8qThiNTV7VX57m8fdNnNS6cXIjRYoh4SozlYWmWGh87nhmJJCeD16jVM
+CMQDkroAY8oNi8RxLUor+LozhhVgu24tu6lcp4MP8H3Zy8bBea5HerAd1AqJp3Ox7KDU=
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=2 l= 105 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/make-pss.py b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/make-pss.py
new file mode 100644
index 0000000..7708bc8
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/make-pss.py
@@ -0,0 +1,59 @@
+# Copyright 2016 Joseph Birr-Pixton.
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+import subprocess
+import glob
+import hashlib
+import os
+
+TOP = '../../../../../'
+
+def dump(bin, type):
+ return '-----BEGIN %s-----\n%s-----END %s-----\n' % \
+ (type, bin.encode('base64'), type)
+
+def gen(outfile, paramfile, hashfn):
+ param = open(paramfile).read()
+
+ rand = os.urandom(64)
+ hash = getattr(hashlib, hashfn)(rand).digest()
+
+ proc = subprocess.Popen(['openssl', 'pkeyutl',
+ '-inkey', 'priv.pem',
+ '-sign',
+ '-pkeyopt', 'rsa_padding_mode:pss',
+ '-pkeyopt', 'rsa_pss_saltlen:-1',
+ '-pkeyopt', 'digest:%s' % hashfn
+ ],
+ stdout = subprocess.PIPE,
+ stdin = subprocess.PIPE)
+
+ sig, _ = proc.communicate(hash)
+
+ with open(outfile, 'w') as f:
+ print >>f, dump(open('pub.der').read(), 'PUBLIC KEY')
+ print >>f, dump(param, 'ALGORITHM')
+ print >>f, dump(rand, 'DATA')
+
+ assert len(sig) == 256 # only works with 2048-bit keys
+ # turn it into a DER bitstring
+ print >>f, dump('\x03\x82\x01\x01\x00' + sig, 'SIGNATURE')
+
+if __name__ == '__main__':
+ subprocess.check_call('openssl genrsa -out priv.pem 2048', shell = True)
+ subprocess.check_call('openssl rsa -pubout -out pub.pem -in priv.pem', shell = True)
+ subprocess.check_call('openssl asn1parse -inform pem -in pub.pem -out pub.der', shell = True)
+ gen('rsa-pss-sha256-salt32.pem', TOP + 'src/data/alg-pss-sha256.der', 'sha256')
+ gen('rsa-pss-sha384-salt48.pem', TOP + 'src/data/alg-pss-sha384.der', 'sha384')
+ gen('rsa-pss-sha512-salt64.pem', TOP + 'src/data/alg-pss-sha512.der', 'sha512')
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/priv.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/priv.pem
new file mode 100644
index 0000000..dea5059
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/priv.pem
@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkmClZR5z1jNht+As6+M
+lgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNvrQkoOL
+znXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF
+5Wc0sktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZ
+xmqoewYHuXQUAfl7W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6e
+alb5Osj3iSEknxRTley47SsODQ0maUUWj8wEjwIDAQABAoIBAFBAVQmt7fBQgAWQ
+JDimeWz198k7pVKCVND94Zg7luReYmmlhpUVM7V6A1/BC9EMuERlmq6YEgwIyZjW
+KUFxhQZAINfk64334CSRMzh/om9uPgjLPoMIQG1dzL9NtR0Ic7wKV8afxPf/mKL9
+Iwvv1+HMoi5qafzz58xNNLk6OgopdZ6H2aX0QtHy/jkMfpE3od7W6Xc+lSVUO7HG
+zmN3pHaM5K5n59cX9jpg/K+a0loceY5vmqUfXyh6IP6h1XyAb2NTpU04klDEFEnU
+tyaYtxL4ZMZzefoeVXVbCl7qeOE7KGIz7gcvsqL7T8dkK+uYf6mLENeyUvkCKiTG
+QAqon0kCgYEA6pLLAYpRo9JbLYlYNt9iTFwIU+R8RcxzZrltm7OUqztmaVq4pOek
+cPw/2sCMvqeEWuGhv+bbeIsDUWADU9NFkWySlVRKEFKGb3ECv3A07yfP2K22exOZ
+/SglNZKB/ycvpOMcNKnJD5folRrh0actdVG8vOf/sN+887vE77u0f6sCgYEAxeC0
+/6831k/EWYzQf+OfeLqx4ABgkgqxvMXO3YCp44+DD4l8TVWfP4Ahfj5p0zCbXIv3
+5OcxdVwjNljZw4Y5vDNwcDK7vKwp9ne+H9xJB7Yedfr7oyJbqIvJ1nd6jmXoL7GA
+dX9xSxJ1CucD7RAY99MS77y8xm0sTbFoI6SvOq0CgYEApeQihXhYvE6sBMw5ArWA
+QxhjG1FfQc2RX3iLt62M2nwrtR5frt/TP8RlNEMwRjUaOVuQlLKjS+Cj/Ay2zbWA
+YZQzJkByEJEMWgvGMbUc+nVhXI+dmfUG1i5qAjUWkmgYHbgv3l6kvs5jwe88/JQK
+ZgnkPISmI2RXsNd+MzzALfkCgYB/56HXa/ERzHnE0KqtH/si1LrJajUB8Xu14761
+msc12rwCvQHmEyRerXn42msZIeAq0CaqhW6Ix8fTB1erdQW4yx8wxvpnGHn/YKM6
+gO+L1oKWDGe/qSPKLKGIya4kgWa1/Wxlhr06o3GYXH9DKxaYio1A/aSgNk1e4v/H
+mlnR+QKBgQDd2cdhBTXIo5FZSONip5GG2Ku9m60qGSyPTCqxLNWBfYE/fu0aFCUU
+GemqA2ygxFnyCG1Af0SDWwQFH8W7BJ6H1geJVcwVKLrZokKOul8kdwXCxz1J2XGe
+gskT4Dsd9K8TSU3J09XVKhC5SrF0vDjdXOE6rtFSqa/bs7B2JcfNwQ==
+-----END RSA PRIVATE KEY-----
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/pub.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/pub.pem
new file mode 100644
index 0000000..7ece334
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/pub.pem
@@ -0,0 +1,9 @@
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mj
+EB5mxjJzgkmClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDO
+FwtrxJE6Eg1GQ2ux9nDVNvrQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbc
+Wc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0sktNr6he6R3zSQ6YK5KZFzQdnEtGc4gw
+HWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7W0DC3hoxOoLwSqL2bt2z
+MMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0maUUWj8wE
+jwIDAQAB
+-----END PUBLIC KEY-----
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32-corrupted-data.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32-corrupted-data.pem
new file mode 100644
index 0000000..153189b
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32-corrupted-data.pem
@@ -0,0 +1,63 @@
+This has had DATA corrupted, so the signature is not valid.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIBBQCiAwIBIA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :20
+
+
+
+-----BEGIN DATA-----
+K6BCjy4hCNAZBmRT+wS4h5wDg7pO67oHFabDt5cXNp8X6sLNH2vjICLtO2niPwZ/Yk2ySxC8MgO
+/+U9sdSXxqA==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQCZqlXJhviFKOKHe1ssbm0ThtAnAbcuP3ACBZyfpBjfYlxAgltNzBnmEtxjsbZQPMXHDHy
+Y+fdEXwK2vboCz7BzIRXcrcJGzjsBc2zPeNZlmhaadIoa5d8jy3kxnT+f3YVjKGZBqwDaqE5Kie
+jhV0laTK+cNGFXo9a3ylICok+s4jVN2Y7qE+ImgyANbZyn1d6W6VnFf4GVvin2hFwTCcZnKA6Db
+NYnArbbNmHmMB2S+1Kw9dAklnzZmwWgNSRirtTpUHTBIWYq3B0hPL8IzwKk89/iKDaY2fpV/Wnt
+oL2mgM7oa/7+oQWa27BGYftYZmDpIQtNbUeO4VBnaeqGgA5f
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32.pem
new file mode 100644
index 0000000..85d4f61
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha256-salt32.pem
@@ -0,0 +1,63 @@
+
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIBBQCiAwIBIA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :20
+
+
+
+-----BEGIN DATA-----
+K5BCjy4hCNAZBmRT+wS4h5wDg7pO67oHFabDt5cXNp8X6sLNH2vjICLtO2niPwZ/Yk2ySxC8MgO
+/+U9sdSXxqA==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQCZqlXJhviFKOKHe1ssbm0ThtAnAbcuP3ACBZyfpBjfYlxAgltNzBnmEtxjsbZQPMXHDHy
+Y+fdEXwK2vboCz7BzIRXcrcJGzjsBc2zPeNZlmhaadIoa5d8jy3kxnT+f3YVjKGZBqwDaqE5Kie
+jhV0laTK+cNGFXo9a3ylICok+s4jVN2Y7qE+ImgyANbZyn1d6W6VnFf4GVvin2hFwTCcZnKA6Db
+NYnArbbNmHmMB2S+1Kw9dAklnzZmwWgNSRirtTpUHTBIWYq3B0hPL8IzwKk89/iKDaY2fpV/Wnt
+oL2mgM7oa/7+oQWa27BGYftYZmDpIQtNbUeO4VBnaeqGgA5f
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48-corrupted-data.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48-corrupted-data.pem
new file mode 100644
index 0000000..d3e7a0b
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48-corrupted-data.pem
@@ -0,0 +1,63 @@
+This has had DATA corrupted, so the signature is not valid.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAICBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAICBQCiAwIBMA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha384
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha384
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :30
+
+
+
+-----BEGIN DATA-----
+TDrlz5dKOqfOQhirwHj00bsVlf+0WEe2qMe9l6SVr9SHB4Eow26r+aU7+pGZFp774O041xIeU2g
+ZHYzNWBjGZQ==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQBvlL4AuwL3hEobMolBzR/0gzuJ9u4ATWEPO5uTiBtdJ5Nx9O6gFCrtZMwfEU9q4bzazKV
+yWRSpn23GZjlmNYhFCNlfY3l6IlhxGEVz/YeOglrBR8hFbA17835jTmcCR09G6SZ7Wwm8NV7riw
+woW15A1N2axuaAAcCxf9T48uehAmXrfApJygl2PWeKzzATUAuGzLLmQ0hNGVvUraxCJfiehtnMl
+kWUiSZgjvmXKv6N2JtN8dHMHVEzPTBou4a25ozQIRAIGFvZYcDm5DW4CNJqFM1mTv2BEeOCW5hw
+Bt60xm8kXOX4OGwgEyB/aHttWHPdAiFUoODo5j4MtcvajuWt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48.pem
new file mode 100644
index 0000000..ac65a9c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha384-salt48.pem
@@ -0,0 +1,63 @@
+
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAICBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAICBQCiAwIBMA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha384
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha384
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :30
+
+
+
+-----BEGIN DATA-----
+TDRlz5dKOqfOQhirwHj00bsVlf+0WEe2qMe9l6SVr9SHB4Eow26r+aU7+pGZFp774O041xIeU2g
+ZHYzNWBjGZQ==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQBvlL4AuwL3hEobMolBzR/0gzuJ9u4ATWEPO5uTiBtdJ5Nx9O6gFCrtZMwfEU9q4bzazKV
+yWRSpn23GZjlmNYhFCNlfY3l6IlhxGEVz/YeOglrBR8hFbA17835jTmcCR09G6SZ7Wwm8NV7riw
+woW15A1N2axuaAAcCxf9T48uehAmXrfApJygl2PWeKzzATUAuGzLLmQ0hNGVvUraxCJfiehtnMl
+kWUiSZgjvmXKv6N2JtN8dHMHVEzPTBou4a25ozQIRAIGFvZYcDm5DW4CNJqFM1mTv2BEeOCW5hw
+Bt60xm8kXOX4OGwgEyB/aHttWHPdAiFUoODo5j4MtcvajuWt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64-corrupted-data.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64-corrupted-data.pem
new file mode 100644
index 0000000..7696270
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64-corrupted-data.pem
@@ -0,0 +1,63 @@
+This has had DATA corrupted, so the signature is not valid.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIDBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIDBQCiAwIBQA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha512
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha512
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :40
+
+
+
+-----BEGIN DATA-----
+BENGYY+GrDsvawb08kP/OZ0iWbG5yBlJpCIJ1YLPfTCjEouvBzwAkWpUEsI3zk0N8+xcMyJ3qOi
+pIsX4YnFfPw==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQBPA1K787NaEycdAHDfil1/F2imI9PcVD5ZuloBz9Qj1q4ZfdZ9PMagunDBVRQoBr1VDhI
+6VkDfyQvhKebIbSsfk/qJoNZGCZtsKhXcGm5ZI2+fUbbMW7EwlKle8SqXCHRAIICND/qwundcqp
+kLNHOqOK8GRUYHnJcMmQbMCBUx9aw3IRu2LRp6FtBwA16stpSat/NlX+aH79f1B/uoFpDVzG7Kw
+oqmAuv81vOVQSCNTn4MrCyxmJTLqbk6frXN7nRF+SQOPksUwXXYgpzGyFhrwgUHwkc3skNx/jOT
+fpWnvjOUVbi80Sa9i7EIOcmt4IP4a3BRPWT/MTYDDPADIgVf
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64.pem
new file mode 100644
index 0000000..3504cc8
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/ours/rsa-pss-sha512-salt64.pem
@@ -0,0 +1,63 @@
+
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtVDcg1BMqPneiNBL5+mjEB5mxjJzgkm
+ClZR5z1jNht+As6+Mlgflni0bB8LjhWbIt+dZ6Bt4cSHOnAOnkMDOFwtrxJE6Eg1GQ2ux9nDVNv
+rQkoOLznXrxMh/af0pcSo8kItDmkqbV/fi3Q7agpbcWc/4wTZOfO6lns4nb5s08oaUv3uF5Wc0s
+ktNr6he6R3zSQ6YK5KZFzQdnEtGc4gwHWXZ9xt4JeANht3m4RNpMY89qZsZxmqoewYHuXQUAfl7
+W0DC3hoxOoLwSqL2bt2zMMeR8WAo51YY0cJnzAEETcnWIM6ealb5Osj3iSEknxRTley47SsODQ0
+maUUWj8wEjwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIDBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIDBQCiAwIBQA==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha512
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha512
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :40
+
+
+
+-----BEGIN DATA-----
+BEnGYY+GrDsvawb08kP/OZ0iWbG5yBlJpCIJ1YLPfTCjEouvBzwAkWpUEsI3zk0N8+xcMyJ3qOi
+pIsX4YnFfPw==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQBPA1K787NaEycdAHDfil1/F2imI9PcVD5ZuloBz9Qj1q4ZfdZ9PMagunDBVRQoBr1VDhI
+6VkDfyQvhKebIbSsfk/qJoNZGCZtsKhXcGm5ZI2+fUbbMW7EwlKle8SqXCHRAIICND/qwundcqp
+kLNHOqOK8GRUYHnJcMmQbMCBUx9aw3IRu2LRp6FtBwA16stpSat/NlX+aH79f1B/uoFpDVzG7Kw
+oqmAuv81vOVQSCNTn4MrCyxmJTLqbk6frXN7nRF+SQOPksUwXXYgpzGyFhrwgUHwkc3skNx/jOT
+fpWnvjOUVbi80Sa9i7EIOcmt4IP4a3BRPWT/MTYDDPADIgVf
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-length.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-length.pem
new file mode 100644
index 0000000..ef7967d
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-length.pem
@@ -0,0 +1,44 @@
+Same test as rsa-pkcs1-sha1.pem except the length of the first SEQUENCE has
+been increased by 2 (which makes it invalid).
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIOfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+Error in encoding
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBBQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha1WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-null.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-null.pem
new file mode 100644
index 0000000..59559f4
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-bad-key-der-null.pem
@@ -0,0 +1,52 @@
+Same test as rsa-pkcs1-sha1.pem except an extra NULL (0x05, 0x00) has been
+appended to the SPKI.
+
+The DER can still be parsed, however it should fail due to the unconsumed data
+at the end.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQABBQA=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+ 162:d=0 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBBQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha1WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-key-params-absent.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-key-params-absent.pem
new file mode 100644
index 0000000..10cc3d0
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-key-params-absent.pem
@@ -0,0 +1,49 @@
+Same test as rsa-pkcs1-sha1.pem, except the SPKI has been modified so the
+algorithm parameters are absent rather than NULL.
+
+This should fail because RFC 3279 says the parameters MUST be NULL.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGdMAsGCSqGSIb3DQEBAQOBjQAwgYkCgYEApW5KDnAQF1iaUYfcfqhB0Vby7A42rVKkTf6x5h9
+62ZHYxRBW/+2xYrTA8oOhKoijlN/1JqtykcuzB86r/OCx39XNlQgJbVsri2311nHvY3fAkhyyPC
+cKcOJZjm/4nRnxBazC0/DLNfKSgOE4a29kxO8i4eHyDQzoz/siSb2aITcCAwEAAQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 157 cons: SEQUENCE
+ 3:d=1 hl=2 l= 11 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBBQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha1WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-using-pss-key-no-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-using-pss-key-no-params.pem
new file mode 100644
index 0000000..0dfff97
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-using-pss-key-no-params.pem
@@ -0,0 +1,51 @@
+This is the same test as rsa-pkcs1-sha1.pem, except the SPKI has been modified
+so that the key algorithm is rsaPss (1.2.840.113549.1.1.10) with absent
+parameters.
+
+Subsequently this should fail, as a PSS key should not be used with a signature
+algorithm for PKCS#1 v1.5.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGdMAsGCSqGSIb3DQEBCgOBjQAwgYkCgYEApW5KDnAQF1iaUYfcfqhB0Vby7A42rVKkTf6x5h9
+62ZHYxRBW/+2xYrTA8oOhKoijlN/1JqtykcuzB86r/OCx39XNlQgJbVsri2311nHvY3fAkhyyPC
+cKcOJZjm/4nRnxBazC0/DLNfKSgOE4a29kxO8i4eHyDQzoz/siSb2aITcCAwEAAQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 157 cons: SEQUENCE
+ 3:d=1 hl=2 l= 11 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 16:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBBQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha1WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-wrong-algorithm.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-wrong-algorithm.pem
new file mode 100644
index 0000000..9aaedba
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1-wrong-algorithm.pem
@@ -0,0 +1,48 @@
+This is the same as rsa-pkcs1-sha1.pem, however the ALGORITHM has been change
+to have SHA256 instead of SHA1. Using this algorithm verification should fail.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1.pem
new file mode 100644
index 0000000..0972aca
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha1.pem
@@ -0,0 +1,53 @@
+The key, message, and signature come from Example 1 of:
+ftp://ftp.rsa.com/pub/rsalabs/tmp/pkcs1v15sign-vectors.txt
+
+(The algorithm DER was synthesized to match, and the signature enclosed in a BIT STRING).
+
+It uses an RSA key with modulus length of 1024 bits, PKCS#1 v1.5 padding, and
+SHA-1 as the digest.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBBQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha1WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAGvDoGZWhCkwokfjDVhktNgZI2unxollhirX28TiSvKOhrtTHwM1i+X7dHd8YIb4UMrviT8
+Nb8wtDJHsATaTtOoAuAzUmqxOy1+JEa/lOa2kqPOCPR0T5HLRSQVHxlnHYX89JAh9228rcglhZ/
+wJfKsY6aRY/LY0zc6O41iUxITX
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-key-encoded-ber.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-key-encoded-ber.pem
new file mode 100644
index 0000000..2a8db4a
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-key-encoded-ber.pem
@@ -0,0 +1,62 @@
+This is the same test as rsa-pkcs1-sha256.pem except the SPKI has been encoded
+using a non-minimal length for the outtermost SEQUENCE.
+
+Under DER, the tag-length-value encodings should be minimal and hence this should fail.
+
+Specifically the SPKI start was changed from:
+ 30 81 9f
+To:
+ 30 82 00 9f
+
+(the length of 0x9F is being expressed using 2 bytes instead of 1)
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIAnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAqkfgdjI9YqzadSZ2Ns0CEEUD8+8m7OplIx0
+94X+QD8mooNrunwT04asbLIINGL4qiI/+9IVSvyV3Kj9c4EeQIbANGoJ8AI3wf6MOBB/txxGFed
+qqcTffKVMQvtZdoYFbZ/MQkvyRsoyvunb/pWcN4sSaF9kY1bXSeP3J99fBIYUCAwEAAQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 159 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-spki-non-null-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-spki-non-null-params.pem
new file mode 100644
index 0000000..4e7fc96
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-spki-non-null-params.pem
@@ -0,0 +1,59 @@
+This is the same test as rsa-pkcs1-sha256.pem except the SPKI has been tampered
+with. The parameters have been changed from NULL to an INTEGER.
+
+This was done by changing:
+
+ 05 00 (NULL)
+To:
+ 02 00 (INTEGER)
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQIAA4GNADCBiQKBgQCqR+B2Mj1irNp1JnY2zQIQRQPz7ybs6mUjHT3
+hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA0agnwAjfB/ow4EH+3HEYV52q
+pxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/cn318EhhQIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: INTEGER :00
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-ecdsa-algorithm.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-ecdsa-algorithm.pem
new file mode 100644
index 0000000..a9b9eb9
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-ecdsa-algorithm.pem
@@ -0,0 +1,55 @@
+This test specified a valid RSA PKCS#1 v.1.5 signature and RSA key (the same as rsa-pkcs1-sha256.pem).
+
+The problem however is the signature algorithm is indicated as being ECDSA.
+
+Signature verification consequently should fail.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp1JnY2zQIQRQPz7ybs6mUjHT3
+hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA0agnwAjfB/ow4EH+3HEYV52q
+pxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/cn318EhhQIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MAoGCCqGSM49BAMC
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 10 cons: SEQUENCE
+ 2:d=1 hl=2 l= 8 prim: OBJECT :ecdsa-with-SHA256
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-id-ea-rsa.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-id-ea-rsa.pem
new file mode 100644
index 0000000..dd5d39c
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256-using-id-ea-rsa.pem
@@ -0,0 +1,54 @@
+This is the same test as rsa-pkcs1-sha256.pem except the SPKI has been tampered
+with. Rather than using an rsaEncryption OID for the key's algorithm, it uses
+id-ea-rsa (2.5.8.1.1).
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGaMAgGBFUIAQEFAAOBjQAwgYkCgYEAqkfgdjI9YqzadSZ2Ns0CEEUD8+8m7OplIx094X+QD8m
+ooNrunwT04asbLIINGL4qiI/+9IVSvyV3Kj9c4EeQIbANGoJ8AI3wf6MOBB/txxGFedqqcTffKV
+MQvtZdoYFbZ/MQkvyRsoyvunb/pWcN4sSaF9kY1bXSeP3J99fBIYUCAwEAAQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 154 cons: SEQUENCE
+ 3:d=1 hl=2 l= 8 cons: SEQUENCE
+ 5:d=2 hl=2 l= 4 prim: OBJECT :rsa
+ 11:d=2 hl=2 l= 0 prim: NULL
+ 13:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256.pem
new file mode 100644
index 0000000..8509111
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pkcs1-sha256.pem
@@ -0,0 +1,86 @@
+This test data was produced by creating a self-signed EC cert using OpenSSL,
+and then extracting the relevant fields.
+
+It uses RSA PKCS#1 v1.5 with SHA-256 and a 1024-bit key.
+
+(1) Generate self-signed certificate
+
+ openssl genrsa -out rsa_key.pem 1024
+ openssl req -new -key rsa_key.pem -x509 -nodes -days 365 -out cert.pem
+
+(2) Extract public key
+
+ openssl x509 -in cert.pem -pubkey -noout > pubkey.pem
+ cat pubkey.pem
+
+(3) Extract signed data (tbsCertificate)
+
+ openssl asn1parse -in cert.pem -out tbs -noout -strparse 4
+ base64 tbs
+
+(4) Extract signature algorithm
+
+ # Find the offset of the signature algorithm near the end (491 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out alg -noout -strparse 491
+ base64 alg
+
+(5) Extract the signature
+
+ # Find the final offset of BIT STRING (506 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out sig -noout -strparse 506
+ base64 sig
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp1JnY2zQIQRQPz7ybs6mUjHT3
+hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA0agnwAjfB/ow4EH+3HEYV52q
+pxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/cn318EhhQIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-no-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-no-params.pem
new file mode 100644
index 0000000..503cc2e
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-no-params.pem
@@ -0,0 +1,48 @@
+This is the same test as rsa-pss-sha1-salt20.pem, except the public key's
+algorithm identifier has been changed from rsaEncryption (1.2.840.113549.1.1.1)
+to rsaPss (1.2.840.113549.1.1.10).
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGdMAsGCSqGSIb3DQEBCgOBjQAwgYkCgYEApW5KDnAQF1iaUYfcfqhB0Vby7A42rVKkTf6x5h9
+62ZHYxRBW/+2xYrTA8oOhKoijlN/1JqtykcuzB86r/OCx39XNlQgJbVsri2311nHvY3fAkhyyPC
+cKcOJZjm/4nRnxBazC0/DLNfKSgOE4a29kxO8i4eHyDQzoz/siSb2aITcCAwEAAQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 157 cons: SEQUENCE
+ 3:d=1 hl=2 l= 11 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 16:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCjAA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 0 cons: SEQUENCE
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAJB0MI+1mOlwGyKUOI5S+XH6rCtgpRRa8YXfUoe17SiH5Xzn/UTchjTkB8jg5DYLwibz7CJ
+/nZ5UY46NMfUFEhXfbrucL5V5qndZijj5FLW5wb2DxOL584Kg0Ko1Qv/uZZhKYBvGnrKN6yfcoS
+yCwtTD9mzVAPH/K5lNik4wy7M8
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-with-null-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-with-null-params.pem
new file mode 100644
index 0000000..222614b
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20-using-pss-key-with-null-params.pem
@@ -0,0 +1,50 @@
+This is the same test as rsa-pss-sha1-salt20.pem, except the public key's
+algorithm identifier has been changed from rsaEncryption (1.2.840.113549.1.1.1)
+to rsaPss (1.2.840.113549.1.1.10). Note that the PSS parameters have been
+encoded as NULL which is incorrect.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBCgUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCjAA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 0 cons: SEQUENCE
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAJB0MI+1mOlwGyKUOI5S+XH6rCtgpRRa8YXfUoe17SiH5Xzn/UTchjTkB8jg5DYLwibz7CJ
+/nZ5UY46NMfUFEhXfbrucL5V5qndZijj5FLW5wb2DxOL584Kg0Ko1Qv/uZZhKYBvGnrKN6yfcoS
+yCwtTD9mzVAPH/K5lNik4wy7M8
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20.pem
new file mode 100644
index 0000000..e56f0fe
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-salt20.pem
@@ -0,0 +1,53 @@
+The key, message, and signature come from Example 1.1 of:
+ftp://ftp.rsasecurity.com/pub/pkcs/pkcs-1/pkcs-1v2-1-vec.zip (pss-vect.txt)
+
+(The algorithm DER was synthesized to match, and the signature enclosed in a BIT STRING).
+
+It uses an RSA key with modulus length of 1024 bits, PSS padding,
+SHA-1 as the digest, MGF1 with SHA-1, and salt length of 20.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCjAA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 0 cons: SEQUENCE
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAJB0MI+1mOlwGyKUOI5S+XH6rCtgpRRa8YXfUoe17SiH5Xzn/UTchjTkB8jg5DYLwibz7CJ
+/nZ5UY46NMfUFEhXfbrucL5V5qndZijj5FLW5wb2DxOL584Kg0Ko1Qv/uZZhKYBvGnrKN6yfcoS
+yCwtTD9mzVAPH/K5lNik4wy7M8
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-wrong-salt.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-wrong-salt.pem
new file mode 100644
index 0000000..57ec775
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha1-wrong-salt.pem
@@ -0,0 +1,51 @@
+Same as rsa-pss-sha1-wrong-salt.pem except the ALGORITHM has been changed to
+have a salt of 23. When verified using this algorithm it will fail, however if
+the default salt of 20 were used it would succeed.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MBIGCSqGSIb3DQEBCjAFogMCARc=
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 18 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 5 cons: SEQUENCE
+ 15:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 17:d=3 hl=2 l= 1 prim: INTEGER :17
+
+
+
+-----BEGIN DATA-----
+zch9oiPXht87ReC7vHITJtHuKvgGzDFUdcxvDZxm4bYjcdRc4jkuGskoRMMQEC8Vag2NUsH0xAu
+jqmUJV4bLdpdXplY7qVj+0LzJhOi1F6PV9RWyO4pB50qoZ2k/kN+wYabobfqu5kRywA5fIJRXKc
+vr538Gznjgj0CY+6QfnWGTwDF+i2DUtghKy0LSnjgIo7w3LYXjMRcPy/fMctC3HClmSLOk0Q9BY
+pXQgHqmJcqydE/Z6o/SI8QlNwKYKL0WvgJUbxMP0uM7k20mduCK7RtzMYt1CgFn0A==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAJB0MI+1mOlwGyKUOI5S+XH6rCtgpRRa8YXfUoe17SiH5Xzn/UTchjTkB8jg5DYLwibz7CJ
+/nZ5UY46NMfUFEhXfbrucL5V5qndZijj5FLW5wb2DxOL584Kg0Ko1Qv/uZZhKYBvGnrKN6yfcoS
+yCwtTD9mzVAPH/K5lNik4wy7M8
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-mgf1-sha512-salt33.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-mgf1-sha512-salt33.pem
new file mode 100644
index 0000000..f3b9dcb
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-mgf1-sha512-salt33.pem
@@ -0,0 +1,67 @@
+This test exercises using a different hash function parameter to the mask gen
+function (SHA-256 for the hash, but SHA-512 for the MGF1 hash).
+
+This test data was constructed manually by calling signing functions from
+OpenSSL code.
+
+It constructs an RSASSA-PSS signature using:
+ * Key with modulus 1024 bit
+ * Salt length 33 bytes
+ * Digest function of SHA-256
+ * Mask gen function of MGF1 with SHA-512
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQClbkoOcBAXWJpRh9x+qEHRVvLsDjatUqRN/rH
+mH3rZkdjFEFb/7bFitMDyg6EqiKOU3/Umq3KRy7MHzqv84LHf1c2VCAltWyuLbfXWce9jd8CSHL
+I8Jwpw4lmOb/idGfEFrMLT8Ms18pKA4Thrb2TE7yLh4fINDOjP+yJJvZohNwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 159 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 141 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIDBQCiAwIBIQ==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha512
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :21
+
+
+
+-----BEGIN DATA-----
+VGVzdCBtZXNzYWdlIHRvIGJlIHNpZ25lZC4uLg==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBAFob0HSC5uuTqKu4J/lj+5bDa+Hhij4H3klWnvt6Yc+wwPza7/UC4lgGGyvZqD32RUEdt7v
+Z14qqYNk53b5aj4C2gBMvLzV7Pay4mmQM4DSWa5JHMxTILqE3DDqihrbMcBw2q3XAsLcjeqLWQ9
+yp8tfnV21h98qsCLtErrxZWHRr
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-params.pem
new file mode 100644
index 0000000..e0140b3
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-params.pem
@@ -0,0 +1,74 @@
+This is the same test as rsa-pss-sha256-salt10.pem except instead of specifying
+the SPKI using rsaEncryption it is specified using rsaPss along with
+parameters that match those of the signature algorithm.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIHRMEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZ
+IAWUDBAIBBQCiAwIBCgOBiwAwgYcCgYEAvkmbXn8GyD+gKT4xRlyOtrWK+SC65Sp7W5v+t6py2x
+JkES6z/UMdMaKn5QlBVmkpSUoOiR7VYTkYtLUbDR+5d4Oyas99DzhM+zX00oJPXdOAYjomvxgLY
+5YcYZ3NsgyuQG8i9uJ2yAo3JZSQz+tywacahPGEbTMId7o+MQHsnHsCARE=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 209 cons: SEQUENCE
+ 3:d=1 hl=2 l= 65 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 16:d=2 hl=2 l= 52 cons: SEQUENCE
+ 18:d=3 hl=2 l= 15 cons: cont [ 0 ]
+ 20:d=4 hl=2 l= 13 cons: SEQUENCE
+ 22:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 33:d=5 hl=2 l= 0 prim: NULL
+ 35:d=3 hl=2 l= 28 cons: cont [ 1 ]
+ 37:d=4 hl=2 l= 26 cons: SEQUENCE
+ 39:d=5 hl=2 l= 9 prim: OBJECT :mgf1
+ 50:d=5 hl=2 l= 13 cons: SEQUENCE
+ 52:d=6 hl=2 l= 9 prim: OBJECT :sha256
+ 63:d=6 hl=2 l= 0 prim: NULL
+ 65:d=3 hl=2 l= 3 cons: cont [ 2 ]
+ 67:d=4 hl=2 l= 1 prim: INTEGER :0A
+ 70:d=1 hl=3 l= 139 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIBBQCiAwIBCg==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :0A
+
+
+
+-----BEGIN DATA-----
+x/UnD8pyX5vRn1GajXzKPMXAeQJAKfO65RD5sCFA/iOJCOT2wY8HqJxofIaEZpsfHbK6+SUaPIK
+frMtJMIThbsnijViGgHSl1iIWZ91uUo0W/iyfPbTPr2xNzoyEOa84zqqqnOLsrnvI9KWlXjv5bf
+nNV1xPnLMnlRuM3+QIcWg=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBABHhafL9QLB2Qbl2iiqxmWX7bCfxD88DI/zG0S608cBrMw3aoepQRAevop3p6+A3T+nR59D
+/vV/Bzzo0RuQUVBXSqyT3ibNGTFxDola7wdaSz38EgB2sW7QBpKA6t9VyioYMGeGk3Hl8pULIID
+zsLmAesMUfVn8u2gIrC5693u76
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-wrong-params.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-wrong-params.pem
new file mode 100644
index 0000000..646ac1f
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10-using-pss-key-with-wrong-params.pem
@@ -0,0 +1,74 @@
+This is the same test as rsa-pss-sha256-salt10-using-pss-key-with-params.pem
+except the hash in the PSS key's parameters has been changed from SHA-256 to
+SHA-384.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIHRMEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAICBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZ
+IAWUDBAIBBQCiAwIBCgOBiwAwgYcCgYEAvkmbXn8GyD+gKT4xRlyOtrWK+SC65Sp7W5v+t6py2x
+JkES6z/UMdMaKn5QlBVmkpSUoOiR7VYTkYtLUbDR+5d4Oyas99DzhM+zX00oJPXdOAYjomvxgLY
+5YcYZ3NsgyuQG8i9uJ2yAo3JZSQz+tywacahPGEbTMId7o+MQHsnHsCARE=
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 209 cons: SEQUENCE
+ 3:d=1 hl=2 l= 65 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 16:d=2 hl=2 l= 52 cons: SEQUENCE
+ 18:d=3 hl=2 l= 15 cons: cont [ 0 ]
+ 20:d=4 hl=2 l= 13 cons: SEQUENCE
+ 22:d=5 hl=2 l= 9 prim: OBJECT :sha384
+ 33:d=5 hl=2 l= 0 prim: NULL
+ 35:d=3 hl=2 l= 28 cons: cont [ 1 ]
+ 37:d=4 hl=2 l= 26 cons: SEQUENCE
+ 39:d=5 hl=2 l= 9 prim: OBJECT :mgf1
+ 50:d=5 hl=2 l= 13 cons: SEQUENCE
+ 52:d=6 hl=2 l= 9 prim: OBJECT :sha256
+ 63:d=6 hl=2 l= 0 prim: NULL
+ 65:d=3 hl=2 l= 3 cons: cont [ 2 ]
+ 67:d=4 hl=2 l= 1 prim: INTEGER :0A
+ 70:d=1 hl=3 l= 139 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIBBQCiAwIBCg==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :0A
+
+
+
+-----BEGIN DATA-----
+x/UnD8pyX5vRn1GajXzKPMXAeQJAKfO65RD5sCFA/iOJCOT2wY8HqJxofIaEZpsfHbK6+SUaPIK
+frMtJMIThbsnijViGgHSl1iIWZ91uUo0W/iyfPbTPr2xNzoyEOa84zqqqnOLsrnvI9KWlXjv5bf
+nNV1xPnLMnlRuM3+QIcWg=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBABHhafL9QLB2Qbl2iiqxmWX7bCfxD88DI/zG0S608cBrMw3aoepQRAevop3p6+A3T+nR59D
+/vV/Bzzo0RuQUVBXSqyT3ibNGTFxDola7wdaSz38EgB2sW7QBpKA6t9VyioYMGeGk3Hl8pULIID
+zsLmAesMUfVn8u2gIrC5693u76
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10.pem
new file mode 100644
index 0000000..fc37f41
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-pss-sha256-salt10.pem
@@ -0,0 +1,65 @@
+The key, message, and signature come from:
+http://csrc.nist.gov/groups/STM/cavp/documents/dss/186-2rsatestvectors.zip (SigVerPSS_186-3.rsp)
+
+(The algorithm DER was synthesized to match, and the signature wrapped in a BIT STRING).
+
+It uses an RSA key with modulus length of 1024 bits, PSS padding,
+SHA-256 as the digest, MGF1 with SHA-256, and salt length of 10.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIGdMA0GCSqGSIb3DQEBAQUAA4GLADCBhwKBgQC+SZtefwbIP6ApPjFGXI62tYr5ILrlKntbm/6
+3qnLbEmQRLrP9Qx0xoqflCUFWaSlJSg6JHtVhORi0tRsNH7l3g7Jqz30POEz7NfTSgk9d04BiOi
+a/GAtjlhxhnc2yDK5AbyL24nbICjcllJDP63LBpxqE8YRtMwh3uj4xAeycewIBEQ==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=3 l= 157 cons: SEQUENCE
+ 3:d=1 hl=2 l= 13 cons: SEQUENCE
+ 5:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 16:d=2 hl=2 l= 0 prim: NULL
+ 18:d=1 hl=3 l= 139 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MEEGCSqGSIb3DQEBCjA0oA8wDQYJYIZIAWUDBAIBBQChHDAaBgkqhkiG9w0BAQgwDQYJYIZIAWU
+DBAIBBQCiAwIBCg==
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 65 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :rsassaPss
+ 13:d=1 hl=2 l= 52 cons: SEQUENCE
+ 15:d=2 hl=2 l= 15 cons: cont [ 0 ]
+ 17:d=3 hl=2 l= 13 cons: SEQUENCE
+ 19:d=4 hl=2 l= 9 prim: OBJECT :sha256
+ 30:d=4 hl=2 l= 0 prim: NULL
+ 32:d=2 hl=2 l= 28 cons: cont [ 1 ]
+ 34:d=3 hl=2 l= 26 cons: SEQUENCE
+ 36:d=4 hl=2 l= 9 prim: OBJECT :mgf1
+ 47:d=4 hl=2 l= 13 cons: SEQUENCE
+ 49:d=5 hl=2 l= 9 prim: OBJECT :sha256
+ 60:d=5 hl=2 l= 0 prim: NULL
+ 62:d=2 hl=2 l= 3 cons: cont [ 2 ]
+ 64:d=3 hl=2 l= 1 prim: INTEGER :0A
+
+
+
+-----BEGIN DATA-----
+x/UnD8pyX5vRn1GajXzKPMXAeQJAKfO65RD5sCFA/iOJCOT2wY8HqJxofIaEZpsfHbK6+SUaPIK
+frMtJMIThbsnijViGgHSl1iIWZ91uUo0W/iyfPbTPr2xNzoyEOa84zqqqnOLsrnvI9KWlXjv5bf
+nNV1xPnLMnlRuM3+QIcWg=
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBABHhafL9QLB2Qbl2iiqxmWX7bCfxD88DI/zG0S608cBrMw3aoepQRAevop3p6+A3T+nR59D
+/vV/Bzzo0RuQUVBXSqyT3ibNGTFxDola7wdaSz38EgB2sW7QBpKA6t9VyioYMGeGk3Hl8pULIID
+zsLmAesMUfVn8u2gIrC5693u76
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-using-ec-key.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-using-ec-key.pem
new file mode 100644
index 0000000..b9a3777
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa-using-ec-key.pem
@@ -0,0 +1,52 @@
+This test specifies an RSA PKCS#1 v1.5 signature algorithm (and a valid RSA
+signature), HOWEVER it provides an EC key. Verification should fail.
+
+
+
+-----BEGIN PUBLIC KEY-----
+MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEnLDPaTA9r8dh1ORoe07PA55tNKuWSvgIENjVWKS
+o1vctUSM6F4iSCobuCKGWLHnvoxf7eHnil9rSFG25lfoceA==
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=2 l= 89 cons: SEQUENCE
+ 2:d=1 hl=2 l= 19 cons: SEQUENCE
+ 4:d=2 hl=2 l= 7 prim: OBJECT :id-ecPublicKey
+ 13:d=2 hl=2 l= 8 prim: OBJECT :prime256v1
+ 23:d=1 hl=2 l= 66 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBCwUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha256WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIIB46ADAgECAgkA3l4tFOVii0UwDQYJKoZIhvcNAQELBQAwVjELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDEPMA0GA1
+UEAwwGTXkga2V5MB4XDTE1MDcwMjE3MDYzOVoXDTE2MDcwMTE3MDYzOVowVjELMAkGA1UEBhMCQ
+VUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZDEPMA0GA1UEAwwGTXkga2V5MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqR+B2Mj1irNp
+1JnY2zQIQRQPz7ybs6mUjHT3hf5APyaig2u6fBPThqxssgg0YviqIj/70hVK/JXcqP1zgR5AhsA
+0agnwAjfB/ow4EH+3HEYV52qpxN98pUxC+1l2hgVtn8xCS/JGyjK+6dv+lZw3ixJoX2RjVtdJ4/
+cn318EhhQIDAQABo1AwTjAdBgNVHQ4EFgQUzQBVKTEknyLndWd2HTsBdTKvyikwHwYDVR0jBBgw
+FoAUzQBVKTEknyLndWd2HTsBdTKvyikwDAYDVR0TBAUwAwEB/w==
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4GBADrHSmFSJw/Gv7hs5PNzpaJwAri/sitarIZfzN/SjR+n8L8yeTEoiDb1+BkxlFvXvPHTaOK
+oO3WlslNNOxh1W5/JkYYGOUkCcyIjnln6qS560imcr3VNjomT/M8M2Iss+rJiKau1TRuaP7H8i6
++Gqf3saGdr8/LnvFAdNQvkalQt
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=3 l= 129 prim: BIT STRING
diff --git a/crates/webpki/third-party/chromium/data/verify_signed_data/rsa2048-pkcs1-sha512.pem b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa2048-pkcs1-sha512.pem
new file mode 100644
index 0000000..342a31b
--- /dev/null
+++ b/crates/webpki/third-party/chromium/data/verify_signed_data/rsa2048-pkcs1-sha512.pem
@@ -0,0 +1,93 @@
+This test data was produced by creating a self-signed RSA cert using OpenSSL,
+and then extracting the relevant fields.
+
+It uses RSA PKCS#1 v1.5 with SHA-512 and a 2048-bit key.
+
+(1) Generate self-signed certificate
+
+ openssl genrsa -out rsa_key.pem 2048
+ openssl req -new -key rsa_key.pem -x509 -nodes -days 365 -sha512 -out cert.pem
+
+(2) Extract public key
+
+ openssl x509 -in cert.pem -pubkey -noout > pubkey.pem
+ cat pubkey.pem
+
+(3) Extract signed data (tbsCertificate)
+
+ openssl asn1parse -in cert.pem -out tbs -noout -strparse 4
+ base64 tbs
+
+(4) Extract signature algorithm
+
+ # Find the offset of the signature algorithm near the end (589 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out alg -noout -strparse 589
+ base64 alg
+
+(5) Extract the signature
+
+ # Find the final offset of BIT STRING (506 in this case)
+ openssl asn1parse -in cert.pem
+
+ openssl asn1parse -in cert.pem -out sig -noout -strparse 506
+ base64 sig
+
+
+
+-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzcu2shJRrXFAwMkf30y2AY1zIg9VF/h
+egYcejzdR2AzUb8vU2TXld2i8pp44l+DrvtqmzS7G+yxx3uOx+zsoqBaUT0c9HfkbE+IRmcLkQF
+vYpSpm6Eu8OS14CSmEtiR91Et8LR0+bd0Gn3pgmb+epFJBaBPeDSiI/smqKCs7yP04+tS4Q4r47
+G04LhSp4/hmqH32b4Gcm9nsihHV9FfPfVdxDQUEJp3AgyBPwhPZEAyhoQS73TjjxXHqJRSz37Sl
+ueMVPuNncqbT4nAMKz25J1CtRlQh21uZzfY2QRP3m6rAZquQUos1febC6A7qmhQljWKKmXtfVY+
+fAamstdHrWwIDAQAB
+-----END PUBLIC KEY-----
+
+$ openssl asn1parse -i < [PUBLIC KEY]
+ 0:d=0 hl=4 l= 290 cons: SEQUENCE
+ 4:d=1 hl=2 l= 13 cons: SEQUENCE
+ 6:d=2 hl=2 l= 9 prim: OBJECT :rsaEncryption
+ 17:d=2 hl=2 l= 0 prim: NULL
+ 19:d=1 hl=4 l= 271 prim: BIT STRING
+
+
+
+-----BEGIN ALGORITHM-----
+MA0GCSqGSIb3DQEBDQUA
+-----END ALGORITHM-----
+
+$ openssl asn1parse -i < [ALGORITHM]
+ 0:d=0 hl=2 l= 13 cons: SEQUENCE
+ 2:d=1 hl=2 l= 9 prim: OBJECT :sha512WithRSAEncryption
+ 13:d=1 hl=2 l= 0 prim: NULL
+
+
+
+-----BEGIN DATA-----
+MIICRaADAgECAgkA7jWRLkwHvHswDQYJKoZIhvcNAQENBQAwRTELMAkGA1UEBhMCQVUxEzARBgN
+VBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAeFw0xNT
+A3MjgwMjIyMzFaFw0xNjA3MjcwMjIyMzFaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lL
+VN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQDNy7ayElGtcUDAyR/fTLYBjXMiD1UX+F6Bhx6PN1HYDNRvy9TZNeV
+3aLymnjiX4Ou+2qbNLsb7LHHe47H7OyioFpRPRz0d+RsT4hGZwuRAW9ilKmboS7w5LXgJKYS2JH
+3US3wtHT5t3QafemCZv56kUkFoE94NKIj+yaooKzvI/Tj61LhDivjsbTguFKnj+GaoffZvgZyb2
+eyKEdX0V899V3ENBQQmncCDIE/CE9kQDKGhBLvdOOPFceolFLPftKW54xU+42dyptPicAwrPbkn
+UK1GVCHbW5nN9jZBE/ebqsBmq5BSizV95sLoDuqaFCWNYoqZe19Vj58Bqay10etbAgMBAAGjUDB
+OMB0GA1UdDgQWBBRsCPajkEscZM6SpLbNTa/7dY5azzAfBgNVHSMEGDAWgBRsCPajkEscZM6SpL
+bNTa/7dY5azzAMBgNVHRMEBTADAQH/
+-----END DATA-----
+
+
+
+-----BEGIN SIGNATURE-----
+A4IBAQAhKSNq+X/CfzhtNsMo6MJpTBjJBV5fhHerIZr6e3ozCTBCR29vYsVnJ4/6i5lL1pNeOhM
+ldthnuSlMzTS1Zme1OqRWB3U8QmwCFwhDxW/i4fdT8kxDAmELNp4z0GcXbe27V895PE0R/m8P47
+B6xbra+SQlEMW12K1EndUqrO6vgLbobV14mveWdgc0KIOnDKgsTHV8NTV1w3qtp1ujfvizYfBZu
+yyMOA1yZPDpREZtClro7lufwDQ7+LgSdtNLMDAMzapfIjAEPVNVLmJzMgzaHqMsZM8gP8vWAdfc
+R4mCmWXVotrM6d1rjJGdRADAONYCC4/+d1IMkVGoVfpaej6I
+-----END SIGNATURE-----
+
+$ openssl asn1parse -i < [SIGNATURE]
+ 0:d=0 hl=4 l= 257 prim: BIT STRING
diff --git a/crates/which/.cargo-checksum.json b/crates/which/.cargo-checksum.json
new file mode 100644
index 0000000..7b3c3ca
--- /dev/null
+++ b/crates/which/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.toml":"52b2c35d7270c5db75872052c2f8e56740f3c4ccf48b4a17be7b600c57bf24a0","LICENSE.txt":"0041560f5d419c30e1594567f3b7ac2bc078ff6a68f437e0348ba85d9cf99112","README.md":"8b16d6a129cb05c3b6ed15e5eacbd7ca488a5005f3d22d3376cc75157996f1dc","src/checker.rs":"e17ca8bcccedfba17ba027e86de970a01d6d207ba442174184952966eeaba140","src/error.rs":"00315874353628366851cd0817a60059cb2c784fd315407a2c30f38021b18dc6","src/finder.rs":"71d09b164ebf51e70dc67b6e4db78bc1c10afedc6473b1edb795d36bd3a3c83b","src/helper.rs":"42cf60a98c017fcbf96d8cbf5880398b4f191c4b2445c43028c35ad57a1b846a","src/lib.rs":"53926af5cadb33966a6d7e0bdd87a48470ac703f144da77212edbedf88bb0692","tests/basic.rs":"90e2c26bc1402fea996e91342f0c299cc91fb54e82445b0bb46715a77660059b"},"package":"2441c784c52b289a054b7201fc93253e288f094e2f4be9058343127c4226a269"}
\ No newline at end of file
diff --git a/crates/which/Android.bp b/crates/which/Android.bp
new file mode 100644
index 0000000..2d34a1d
--- /dev/null
+++ b/crates/which/Android.bp
@@ -0,0 +1,34 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_which_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_which_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libwhich",
+ host_supported: true,
+ crate_name: "which",
+ cargo_env_compat: true,
+ cargo_pkg_version: "4.4.0",
+ crate_root: "src/lib.rs",
+ edition: "2018",
+ rustlibs: [
+ "libeither",
+ "liblibc",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "//apex_available:anyapex",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/which/Cargo.toml b/crates/which/Cargo.toml
new file mode 100644
index 0000000..ff6894a
--- /dev/null
+++ b/crates/which/Cargo.toml
@@ -0,0 +1,50 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2018"
+name = "which"
+version = "4.4.0"
+authors = ["Harry Fei <[email protected]>"]
+description = "A Rust equivalent of Unix command \"which\". Locate installed executable in cross platforms."
+documentation = "https://docs.rs/which/"
+readme = "README.md"
+keywords = [
+ "which",
+ "which-rs",
+ "unix",
+ "command",
+]
+categories = [
+ "os",
+ "filesystem",
+]
+license = "MIT"
+repository = "https://github.com/harryfei/which-rs.git"
+
+[package.metadata.docs.rs]
+all-features = true
+
+[dependencies.either]
+version = "1.6.1"
+
+[dependencies.libc]
+version = "0.2.121"
+
+[dependencies.regex]
+version = "1.5.5"
+optional = true
+
+[dev-dependencies.tempfile]
+version = "3.3.0"
+
+[target."cfg(windows)".dependencies.once_cell]
+version = "1"
diff --git a/crates/which/LICENSE b/crates/which/LICENSE
new file mode 120000
index 0000000..85de3d4
--- /dev/null
+++ b/crates/which/LICENSE
@@ -0,0 +1 @@
+LICENSE.txt
\ No newline at end of file
diff --git a/crates/which/LICENSE.txt b/crates/which/LICENSE.txt
new file mode 100644
index 0000000..369139b
--- /dev/null
+++ b/crates/which/LICENSE.txt
@@ -0,0 +1,19 @@
+Copyright (c) 2015 fangyuanziti
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/crates/which/METADATA b/crates/which/METADATA
new file mode 100644
index 0000000..d2123d9
--- /dev/null
+++ b/crates/which/METADATA
@@ -0,0 +1,23 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/which
+# For more info, check https://cs.android.com/android/platform/superproject/+/master:tools/external_updater/README.md
+
+name: "which"
+description: "A Rust equivalent of Unix command \"which\". Locate installed executable in cross platforms."
+third_party {
+ url {
+ type: HOMEPAGE
+ value: "https://crates.io/crates/which"
+ }
+ url {
+ type: ARCHIVE
+ value: "https://static.crates.io/crates/which/which-4.4.0.crate"
+ }
+ version: "4.4.0"
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 2
+ day: 17
+ }
+}
diff --git a/crates/which/MODULE_LICENSE_MIT b/crates/which/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/which/MODULE_LICENSE_MIT
diff --git a/crates/which/README.md b/crates/which/README.md
new file mode 100644
index 0000000..5615c36
--- /dev/null
+++ b/crates/which/README.md
@@ -0,0 +1,35 @@
+[](https://github.com/harryfei/which-rs/actions/workflows/rust.yml)
+
+# which
+
+A Rust equivalent of Unix command "which". Locate installed executable in cross platforms.
+
+## Support platforms
+
+* Linux
+* Windows
+* macOS
+
+## Examples
+
+1) To find which rustc executable binary is using.
+
+ ``` rust
+ use which::which;
+
+ let result = which("rustc").unwrap();
+ assert_eq!(result, PathBuf::from("/usr/bin/rustc"));
+ ```
+
+2. After enabling the `regex` feature, find all cargo subcommand executables on the path:
+
+ ``` rust
+ use which::which_re;
+
+ which_re(Regex::new("^cargo-.*").unwrap()).unwrap()
+ .for_each(|pth| println!("{}", pth.to_string_lossy()));
+ ```
+
+## Documentation
+
+The documentation is [available online](https://docs.rs/which/).
diff --git a/crates/which/TEST_MAPPING b/crates/which/TEST_MAPPING
new file mode 100644
index 0000000..23bbdf9
--- /dev/null
+++ b/crates/which/TEST_MAPPING
@@ -0,0 +1,14 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "external/rust/crates/libsqlite3-sys"
+ },
+ {
+ "path": "system/security/keystore2"
+ },
+ {
+ "path": "system/security/keystore2/legacykeystore"
+ }
+ ]
+}
diff --git a/crates/which/cargo_embargo.json b/crates/which/cargo_embargo.json
new file mode 100644
index 0000000..b639cc5
--- /dev/null
+++ b/crates/which/cargo_embargo.json
@@ -0,0 +1,4 @@
+{
+ "features": [],
+ "run_cargo": false
+}
diff --git a/crates/which/src/checker.rs b/crates/which/src/checker.rs
new file mode 100644
index 0000000..0e92c6a
--- /dev/null
+++ b/crates/which/src/checker.rs
@@ -0,0 +1,79 @@
+use crate::finder::Checker;
+#[cfg(unix)]
+use std::ffi::CString;
+use std::fs;
+#[cfg(unix)]
+use std::os::unix::ffi::OsStrExt;
+use std::path::Path;
+
+pub struct ExecutableChecker;
+
+impl ExecutableChecker {
+ pub fn new() -> ExecutableChecker {
+ ExecutableChecker
+ }
+}
+
+impl Checker for ExecutableChecker {
+ #[cfg(unix)]
+ fn is_valid(&self, path: &Path) -> bool {
+ CString::new(path.as_os_str().as_bytes())
+ .map(|c| unsafe { libc::access(c.as_ptr(), libc::X_OK) == 0 })
+ .unwrap_or(false)
+ }
+
+ #[cfg(windows)]
+ fn is_valid(&self, _path: &Path) -> bool {
+ true
+ }
+}
+
+pub struct ExistedChecker;
+
+impl ExistedChecker {
+ pub fn new() -> ExistedChecker {
+ ExistedChecker
+ }
+}
+
+impl Checker for ExistedChecker {
+ #[cfg(target_os = "windows")]
+ fn is_valid(&self, path: &Path) -> bool {
+ fs::symlink_metadata(path)
+ .map(|metadata| {
+ let file_type = metadata.file_type();
+ file_type.is_file() || file_type.is_symlink()
+ })
+ .unwrap_or(false)
+ }
+
+ #[cfg(not(target_os = "windows"))]
+ fn is_valid(&self, path: &Path) -> bool {
+ fs::metadata(path)
+ .map(|metadata| metadata.is_file())
+ .unwrap_or(false)
+ }
+}
+
+pub struct CompositeChecker {
+ checkers: Vec<Box<dyn Checker>>,
+}
+
+impl CompositeChecker {
+ pub fn new() -> CompositeChecker {
+ CompositeChecker {
+ checkers: Vec::new(),
+ }
+ }
+
+ pub fn add_checker(mut self, checker: Box<dyn Checker>) -> CompositeChecker {
+ self.checkers.push(checker);
+ self
+ }
+}
+
+impl Checker for CompositeChecker {
+ fn is_valid(&self, path: &Path) -> bool {
+ self.checkers.iter().all(|checker| checker.is_valid(path))
+ }
+}
diff --git a/crates/which/src/error.rs b/crates/which/src/error.rs
new file mode 100644
index 0000000..6d800a6
--- /dev/null
+++ b/crates/which/src/error.rs
@@ -0,0 +1,26 @@
+use std::fmt;
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Copy, Clone, Eq, PartialEq, Debug)]
+pub enum Error {
+ BadAbsolutePath,
+ BadRelativePath,
+ CannotFindBinaryPath,
+ CannotGetCurrentDir,
+ CannotCanonicalize,
+}
+
+impl std::error::Error for Error {}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Error::BadAbsolutePath => write!(f, "bad absolute path"),
+ Error::BadRelativePath => write!(f, "bad relative path"),
+ Error::CannotFindBinaryPath => write!(f, "cannot find binary path"),
+ Error::CannotGetCurrentDir => write!(f, "cannot get current directory"),
+ Error::CannotCanonicalize => write!(f, "cannot canonicalize path"),
+ }
+ }
+}
diff --git a/crates/which/src/finder.rs b/crates/which/src/finder.rs
new file mode 100644
index 0000000..858a224
--- /dev/null
+++ b/crates/which/src/finder.rs
@@ -0,0 +1,232 @@
+use crate::checker::CompositeChecker;
+use crate::error::*;
+#[cfg(windows)]
+use crate::helper::has_executable_extension;
+use either::Either;
+#[cfg(feature = "regex")]
+use regex::Regex;
+#[cfg(feature = "regex")]
+use std::borrow::Borrow;
+use std::env;
+use std::ffi::OsStr;
+#[cfg(any(feature = "regex", target_os = "windows"))]
+use std::fs;
+use std::iter;
+use std::path::{Path, PathBuf};
+
+pub trait Checker {
+ fn is_valid(&self, path: &Path) -> bool;
+}
+
+trait PathExt {
+ fn has_separator(&self) -> bool;
+
+ fn to_absolute<P>(self, cwd: P) -> PathBuf
+ where
+ P: AsRef<Path>;
+}
+
+impl PathExt for PathBuf {
+ fn has_separator(&self) -> bool {
+ self.components().count() > 1
+ }
+
+ fn to_absolute<P>(self, cwd: P) -> PathBuf
+ where
+ P: AsRef<Path>,
+ {
+ if self.is_absolute() {
+ self
+ } else {
+ let mut new_path = PathBuf::from(cwd.as_ref());
+ new_path.push(self);
+ new_path
+ }
+ }
+}
+
+pub struct Finder;
+
+impl Finder {
+ pub fn new() -> Finder {
+ Finder
+ }
+
+ pub fn find<T, U, V>(
+ &self,
+ binary_name: T,
+ paths: Option<U>,
+ cwd: Option<V>,
+ binary_checker: CompositeChecker,
+ ) -> Result<impl Iterator<Item = PathBuf>>
+ where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<Path>,
+ {
+ let path = PathBuf::from(&binary_name);
+
+ let binary_path_candidates = match cwd {
+ Some(cwd) if path.has_separator() => {
+ // Search binary in cwd if the path have a path separator.
+ Either::Left(Self::cwd_search_candidates(path, cwd).into_iter())
+ }
+ _ => {
+ // Search binary in PATHs(defined in environment variable).
+ let p = paths.ok_or(Error::CannotFindBinaryPath)?;
+ let paths: Vec<_> = env::split_paths(&p).collect();
+
+ Either::Right(Self::path_search_candidates(path, paths).into_iter())
+ }
+ };
+
+ Ok(binary_path_candidates
+ .filter(move |p| binary_checker.is_valid(p))
+ .map(correct_casing))
+ }
+
+ #[cfg(feature = "regex")]
+ pub fn find_re<T>(
+ &self,
+ binary_regex: impl Borrow<Regex>,
+ paths: Option<T>,
+ binary_checker: CompositeChecker,
+ ) -> Result<impl Iterator<Item = PathBuf>>
+ where
+ T: AsRef<OsStr>,
+ {
+ let p = paths.ok_or(Error::CannotFindBinaryPath)?;
+ // Collect needs to happen in order to not have to
+ // change the API to borrow on `paths`.
+ #[allow(clippy::needless_collect)]
+ let paths: Vec<_> = env::split_paths(&p).collect();
+
+ let matching_re = paths
+ .into_iter()
+ .flat_map(fs::read_dir)
+ .flatten()
+ .flatten()
+ .map(|e| e.path())
+ .filter(move |p| {
+ if let Some(unicode_file_name) = p.file_name().unwrap().to_str() {
+ binary_regex.borrow().is_match(unicode_file_name)
+ } else {
+ false
+ }
+ })
+ .filter(move |p| binary_checker.is_valid(p));
+
+ Ok(matching_re)
+ }
+
+ fn cwd_search_candidates<C>(binary_name: PathBuf, cwd: C) -> impl IntoIterator<Item = PathBuf>
+ where
+ C: AsRef<Path>,
+ {
+ let path = binary_name.to_absolute(cwd);
+
+ Self::append_extension(iter::once(path))
+ }
+
+ fn path_search_candidates<P>(
+ binary_name: PathBuf,
+ paths: P,
+ ) -> impl IntoIterator<Item = PathBuf>
+ where
+ P: IntoIterator<Item = PathBuf>,
+ {
+ let new_paths = paths.into_iter().map(move |p| p.join(binary_name.clone()));
+
+ Self::append_extension(new_paths)
+ }
+
+ #[cfg(unix)]
+ fn append_extension<P>(paths: P) -> impl IntoIterator<Item = PathBuf>
+ where
+ P: IntoIterator<Item = PathBuf>,
+ {
+ paths
+ }
+
+ #[cfg(windows)]
+ fn append_extension<P>(paths: P) -> impl IntoIterator<Item = PathBuf>
+ where
+ P: IntoIterator<Item = PathBuf>,
+ {
+ use once_cell::sync::Lazy;
+
+ // Sample %PATHEXT%: .COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH;.MSC
+ // PATH_EXTENSIONS is then [".COM", ".EXE", ".BAT", …].
+ // (In one use of PATH_EXTENSIONS we skip the dot, but in the other we need it;
+ // hence its retention.)
+ static PATH_EXTENSIONS: Lazy<Vec<String>> = Lazy::new(|| {
+ env::var("PATHEXT")
+ .map(|pathext| {
+ pathext
+ .split(';')
+ .filter_map(|s| {
+ if s.as_bytes().first() == Some(&b'.') {
+ Some(s.to_owned())
+ } else {
+ // Invalid segment; just ignore it.
+ None
+ }
+ })
+ .collect()
+ })
+ // PATHEXT not being set or not being a proper Unicode string is exceedingly
+ // improbable and would probably break Windows badly. Still, don't crash:
+ .unwrap_or_default()
+ });
+
+ paths
+ .into_iter()
+ .flat_map(move |p| -> Box<dyn Iterator<Item = _>> {
+ // Check if path already have executable extension
+ if has_executable_extension(&p, &PATH_EXTENSIONS) {
+ Box::new(iter::once(p))
+ } else {
+ let bare_file = p.extension().map(|_| p.clone());
+ // Appended paths with windows executable extensions.
+ // e.g. path `c:/windows/bin[.ext]` will expand to:
+ // [c:/windows/bin.ext]
+ // c:/windows/bin[.ext].COM
+ // c:/windows/bin[.ext].EXE
+ // c:/windows/bin[.ext].CMD
+ // ...
+ Box::new(
+ bare_file
+ .into_iter()
+ .chain(PATH_EXTENSIONS.iter().map(move |e| {
+ // Append the extension.
+ let mut p = p.clone().into_os_string();
+ p.push(e);
+
+ PathBuf::from(p)
+ })),
+ )
+ }
+ })
+ }
+}
+
+#[cfg(target_os = "windows")]
+fn correct_casing(mut p: PathBuf) -> PathBuf {
+ if let (Some(parent), Some(file_name)) = (p.parent(), p.file_name()) {
+ if let Ok(iter) = fs::read_dir(parent) {
+ for e in iter.filter_map(std::result::Result::ok) {
+ if e.file_name().eq_ignore_ascii_case(file_name) {
+ p.pop();
+ p.push(e.file_name());
+ break;
+ }
+ }
+ }
+ }
+ p
+}
+
+#[cfg(not(target_os = "windows"))]
+fn correct_casing(p: PathBuf) -> PathBuf {
+ p
+}
diff --git a/crates/which/src/helper.rs b/crates/which/src/helper.rs
new file mode 100644
index 0000000..eb96891
--- /dev/null
+++ b/crates/which/src/helper.rs
@@ -0,0 +1,40 @@
+use std::path::Path;
+
+/// Check if given path has extension which in the given vector.
+pub fn has_executable_extension<T: AsRef<Path>, S: AsRef<str>>(path: T, pathext: &[S]) -> bool {
+ let ext = path.as_ref().extension().and_then(|e| e.to_str());
+ match ext {
+ Some(ext) => pathext
+ .iter()
+ .any(|e| ext.eq_ignore_ascii_case(&e.as_ref()[1..])),
+ _ => false,
+ }
+}
+
+#[cfg(test)]
+mod test {
+ use super::*;
+ use std::path::PathBuf;
+
+ #[test]
+ fn test_extension_in_extension_vector() {
+ // Case insensitive
+ assert!(has_executable_extension(
+ PathBuf::from("foo.exe"),
+ &[".COM", ".EXE", ".CMD"]
+ ));
+
+ assert!(has_executable_extension(
+ PathBuf::from("foo.CMD"),
+ &[".COM", ".EXE", ".CMD"]
+ ));
+ }
+
+ #[test]
+ fn test_extension_not_in_extension_vector() {
+ assert!(!has_executable_extension(
+ PathBuf::from("foo.bar"),
+ &[".COM", ".EXE", ".CMD"]
+ ));
+ }
+}
diff --git a/crates/which/src/lib.rs b/crates/which/src/lib.rs
new file mode 100644
index 0000000..3e556eb
--- /dev/null
+++ b/crates/which/src/lib.rs
@@ -0,0 +1,631 @@
+//! which
+//!
+//! A Rust equivalent of Unix command `which(1)`.
+//! # Example:
+//!
+//! To find which rustc executable binary is using:
+//!
+//! ```no_run
+//! use which::which;
+//! use std::path::PathBuf;
+//!
+//! let result = which("rustc").unwrap();
+//! assert_eq!(result, PathBuf::from("/usr/bin/rustc"));
+//!
+//! ```
+
+mod checker;
+mod error;
+mod finder;
+#[cfg(windows)]
+mod helper;
+
+#[cfg(feature = "regex")]
+use std::borrow::Borrow;
+use std::env;
+use std::fmt;
+use std::path;
+
+use std::ffi::{OsStr, OsString};
+
+use crate::checker::{CompositeChecker, ExecutableChecker, ExistedChecker};
+pub use crate::error::*;
+use crate::finder::Finder;
+
+/// Find an executable binary's path by name.
+///
+/// If given an absolute path, returns it if the file exists and is executable.
+///
+/// If given a relative path, returns an absolute path to the file if
+/// it exists and is executable.
+///
+/// If given a string without path separators, looks for a file named
+/// `binary_name` at each directory in `$PATH` and if it finds an executable
+/// file there, returns it.
+///
+/// # Example
+///
+/// ```no_run
+/// use which::which;
+/// use std::path::PathBuf;
+///
+/// let result = which::which("rustc").unwrap();
+/// assert_eq!(result, PathBuf::from("/usr/bin/rustc"));
+///
+/// ```
+pub fn which<T: AsRef<OsStr>>(binary_name: T) -> Result<path::PathBuf> {
+ which_all(binary_name).and_then(|mut i| i.next().ok_or(Error::CannotFindBinaryPath))
+}
+
+/// Find an executable binary's path by name, ignoring `cwd`.
+///
+/// If given an absolute path, returns it if the file exists and is executable.
+///
+/// Does not resolve relative paths.
+///
+/// If given a string without path separators, looks for a file named
+/// `binary_name` at each directory in `$PATH` and if it finds an executable
+/// file there, returns it.
+///
+/// # Example
+///
+/// ```no_run
+/// use which::which;
+/// use std::path::PathBuf;
+///
+/// let result = which::which_global("rustc").unwrap();
+/// assert_eq!(result, PathBuf::from("/usr/bin/rustc"));
+///
+/// ```
+pub fn which_global<T: AsRef<OsStr>>(binary_name: T) -> Result<path::PathBuf> {
+ which_all_global(binary_name).and_then(|mut i| i.next().ok_or(Error::CannotFindBinaryPath))
+}
+
+/// Find all binaries with `binary_name` using `cwd` to resolve relative paths.
+pub fn which_all<T: AsRef<OsStr>>(binary_name: T) -> Result<impl Iterator<Item = path::PathBuf>> {
+ let cwd = env::current_dir().ok();
+
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ finder.find(binary_name, env::var_os("PATH"), cwd, binary_checker)
+}
+
+/// Find all binaries with `binary_name` ignoring `cwd`.
+pub fn which_all_global<T: AsRef<OsStr>>(
+ binary_name: T,
+) -> Result<impl Iterator<Item = path::PathBuf>> {
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ finder.find(
+ binary_name,
+ env::var_os("PATH"),
+ Option::<&Path>::None,
+ binary_checker,
+ )
+}
+
+/// Find all binaries matching a regular expression in a the system PATH.
+///
+/// Only available when feature `regex` is enabled.
+///
+/// # Arguments
+///
+/// * `regex` - A regular expression to match binaries with
+///
+/// # Examples
+///
+/// Find Python executables:
+///
+/// ```no_run
+/// use regex::Regex;
+/// use which::which;
+/// use std::path::PathBuf;
+///
+/// let re = Regex::new(r"python\d$").unwrap();
+/// let binaries: Vec<PathBuf> = which::which_re(re).unwrap().collect();
+/// let python_paths = vec![PathBuf::from("/usr/bin/python2"), PathBuf::from("/usr/bin/python3")];
+/// assert_eq!(binaries, python_paths);
+/// ```
+///
+/// Find all cargo subcommand executables on the path:
+///
+/// ```
+/// use which::which_re;
+/// use regex::Regex;
+///
+/// which_re(Regex::new("^cargo-.*").unwrap()).unwrap()
+/// .for_each(|pth| println!("{}", pth.to_string_lossy()));
+/// ```
+#[cfg(feature = "regex")]
+pub fn which_re(regex: impl Borrow<Regex>) -> Result<impl Iterator<Item = path::PathBuf>> {
+ which_re_in(regex, env::var_os("PATH"))
+}
+
+/// Find `binary_name` in the path list `paths`, using `cwd` to resolve relative paths.
+pub fn which_in<T, U, V>(binary_name: T, paths: Option<U>, cwd: V) -> Result<path::PathBuf>
+where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+{
+ which_in_all(binary_name, paths, cwd)
+ .and_then(|mut i| i.next().ok_or(Error::CannotFindBinaryPath))
+}
+
+/// Find all binaries matching a regular expression in a list of paths.
+///
+/// Only available when feature `regex` is enabled.
+///
+/// # Arguments
+///
+/// * `regex` - A regular expression to match binaries with
+/// * `paths` - A string containing the paths to search
+/// (separated in the same way as the PATH environment variable)
+///
+/// # Examples
+///
+/// ```no_run
+/// use regex::Regex;
+/// use which::which;
+/// use std::path::PathBuf;
+///
+/// let re = Regex::new(r"python\d$").unwrap();
+/// let paths = Some("/usr/bin:/usr/local/bin");
+/// let binaries: Vec<PathBuf> = which::which_re_in(re, paths).unwrap().collect();
+/// let python_paths = vec![PathBuf::from("/usr/bin/python2"), PathBuf::from("/usr/bin/python3")];
+/// assert_eq!(binaries, python_paths);
+/// ```
+#[cfg(feature = "regex")]
+pub fn which_re_in<T>(
+ regex: impl Borrow<Regex>,
+ paths: Option<T>,
+) -> Result<impl Iterator<Item = path::PathBuf>>
+where
+ T: AsRef<OsStr>,
+{
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ finder.find_re(regex, paths, binary_checker)
+}
+
+/// Find all binaries with `binary_name` in the path list `paths`, using `cwd` to resolve relative paths.
+pub fn which_in_all<T, U, V>(
+ binary_name: T,
+ paths: Option<U>,
+ cwd: V,
+) -> Result<impl Iterator<Item = path::PathBuf>>
+where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+{
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ finder.find(binary_name, paths, Some(cwd), binary_checker)
+}
+
+/// Find all binaries with `binary_name` in the path list `paths`, ignoring `cwd`.
+pub fn which_in_global<T, U>(
+ binary_name: T,
+ paths: Option<U>,
+) -> Result<impl Iterator<Item = path::PathBuf>>
+where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+{
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ finder.find(binary_name, paths, Option::<&Path>::None, binary_checker)
+}
+
+fn build_binary_checker() -> CompositeChecker {
+ CompositeChecker::new()
+ .add_checker(Box::new(ExistedChecker::new()))
+ .add_checker(Box::new(ExecutableChecker::new()))
+}
+
+/// A wrapper containing all functionality in this crate.
+pub struct WhichConfig {
+ cwd: Option<either::Either<bool, path::PathBuf>>,
+ custom_path_list: Option<OsString>,
+ binary_name: Option<OsString>,
+ #[cfg(feature = "regex")]
+ regex: Option<Regex>,
+}
+
+impl Default for WhichConfig {
+ fn default() -> Self {
+ Self {
+ cwd: Some(either::Either::Left(true)),
+ custom_path_list: None,
+ binary_name: None,
+ #[cfg(feature = "regex")]
+ regex: None,
+ }
+ }
+}
+
+#[cfg(feature = "regex")]
+type Regex = regex::Regex;
+
+#[cfg(not(feature = "regex"))]
+type Regex = ();
+
+impl WhichConfig {
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ /// Whether or not to use the current working directory. `true` by default.
+ ///
+ /// # Panics
+ ///
+ /// If regex was set previously, and you've just passed in `use_cwd: true`, this will panic.
+ pub fn system_cwd(mut self, use_cwd: bool) -> Self {
+ #[cfg(feature = "regex")]
+ if self.regex.is_some() && use_cwd {
+ panic!("which can't use regex and cwd at the same time!")
+ }
+ self.cwd = Some(either::Either::Left(use_cwd));
+ self
+ }
+
+ /// Sets a custom path for resolving relative paths.
+ ///
+ /// # Panics
+ ///
+ /// If regex was set previously, this will panic.
+ pub fn custom_cwd(mut self, cwd: path::PathBuf) -> Self {
+ #[cfg(feature = "regex")]
+ if self.regex.is_some() {
+ panic!("which can't use regex and cwd at the same time!")
+ }
+ self.cwd = Some(either::Either::Right(cwd));
+ self
+ }
+
+ /// Sets the path name regex to search for. You ***MUST*** call this, or [`Self::binary_name`] prior to searching.
+ ///
+ /// When `Regex` is disabled this function takes the unit type as a stand in. The parameter will change when
+ /// `Regex` is enabled.
+ ///
+ /// # Panics
+ ///
+ /// If the `regex` feature wasn't turned on for this crate this will always panic. Additionally if a
+ /// `cwd` (aka current working directory) or `binary_name` was set previously, this will panic, as those options
+ /// are incompatible with `regex`.
+ #[allow(unused_variables)]
+ pub fn regex(mut self, regex: Regex) -> Self {
+ #[cfg(not(feature = "regex"))]
+ {
+ panic!("which's regex feature was not enabled in your Cargo.toml!")
+ }
+ #[cfg(feature = "regex")]
+ {
+ if self.cwd != Some(either::Either::Left(false)) && self.cwd.is_some() {
+ panic!("which can't use regex and cwd at the same time!")
+ }
+ if self.binary_name.is_some() {
+ panic!("which can't use `binary_name` and `regex` at the same time!");
+ }
+ self.regex = Some(regex);
+ self
+ }
+ }
+
+ /// Sets the path name to search for. You ***MUST*** call this, or [`Self::regex`] prior to searching.
+ ///
+ /// # Panics
+ ///
+ /// If a `regex` was set previously this will panic as this is not compatible with `regex`.
+ pub fn binary_name(mut self, name: OsString) -> Self {
+ #[cfg(feature = "regex")]
+ if self.regex.is_some() {
+ panic!("which can't use `binary_name` and `regex` at the same time!");
+ }
+ self.binary_name = Some(name);
+ self
+ }
+
+ /// Uses the given string instead of the `PATH` env variable.
+ pub fn custom_path_list(mut self, custom_path_list: OsString) -> Self {
+ self.custom_path_list = Some(custom_path_list);
+ self
+ }
+
+ /// Uses the `PATH` env variable. Enabled by default.
+ pub fn system_path_list(mut self) -> Self {
+ self.custom_path_list = None;
+ self
+ }
+
+ /// Finishes configuring, runs the query and returns the first result.
+ pub fn first_result(self) -> Result<path::PathBuf> {
+ self.all_results()
+ .and_then(|mut i| i.next().ok_or(Error::CannotFindBinaryPath))
+ }
+
+ /// Finishes configuring, runs the query and returns all results.
+ pub fn all_results(self) -> Result<impl Iterator<Item = path::PathBuf>> {
+ let binary_checker = build_binary_checker();
+
+ let finder = Finder::new();
+
+ let paths = self.custom_path_list.or_else(|| env::var_os("PATH"));
+
+ #[cfg(feature = "regex")]
+ if let Some(regex) = self.regex {
+ return finder
+ .find_re(regex, paths, binary_checker)
+ .map(|i| Box::new(i) as Box<dyn Iterator<Item = path::PathBuf>>);
+ }
+
+ let cwd = match self.cwd {
+ Some(either::Either::Left(false)) => None,
+ Some(either::Either::Right(custom)) => Some(custom),
+ None | Some(either::Either::Left(true)) => env::current_dir().ok(),
+ };
+
+ finder
+ .find(
+ self.binary_name.expect(
+ "binary_name not set! You must set binary_name or regex before searching!",
+ ),
+ paths,
+ cwd,
+ binary_checker,
+ )
+ .map(|i| Box::new(i) as Box<dyn Iterator<Item = path::PathBuf>>)
+ }
+}
+
+/// An owned, immutable wrapper around a `PathBuf` containing the path of an executable.
+///
+/// The constructed `PathBuf` is the output of `which` or `which_in`, but `which::Path` has the
+/// advantage of being a type distinct from `std::path::Path` and `std::path::PathBuf`.
+///
+/// It can be beneficial to use `which::Path` instead of `std::path::Path` when you want the type
+/// system to enforce the need for a path that exists and points to a binary that is executable.
+///
+/// Since `which::Path` implements `Deref` for `std::path::Path`, all methods on `&std::path::Path`
+/// are also available to `&which::Path` values.
+#[derive(Clone, PartialEq, Eq)]
+pub struct Path {
+ inner: path::PathBuf,
+}
+
+impl Path {
+ /// Returns the path of an executable binary by name.
+ ///
+ /// This calls `which` and maps the result into a `Path`.
+ pub fn new<T: AsRef<OsStr>>(binary_name: T) -> Result<Path> {
+ which(binary_name).map(|inner| Path { inner })
+ }
+
+ /// Returns the paths of all executable binaries by a name.
+ ///
+ /// this calls `which_all` and maps the results into `Path`s.
+ pub fn all<T: AsRef<OsStr>>(binary_name: T) -> Result<impl Iterator<Item = Path>> {
+ which_all(binary_name).map(|inner| inner.map(|inner| Path { inner }))
+ }
+
+ /// Returns the path of an executable binary by name in the path list `paths` and using the
+ /// current working directory `cwd` to resolve relative paths.
+ ///
+ /// This calls `which_in` and maps the result into a `Path`.
+ pub fn new_in<T, U, V>(binary_name: T, paths: Option<U>, cwd: V) -> Result<Path>
+ where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+ {
+ which_in(binary_name, paths, cwd).map(|inner| Path { inner })
+ }
+
+ /// Returns all paths of an executable binary by name in the path list `paths` and using the
+ /// current working directory `cwd` to resolve relative paths.
+ ///
+ /// This calls `which_in_all` and maps the results into a `Path`.
+ pub fn all_in<T, U, V>(
+ binary_name: T,
+ paths: Option<U>,
+ cwd: V,
+ ) -> Result<impl Iterator<Item = Path>>
+ where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+ {
+ which_in_all(binary_name, paths, cwd).map(|inner| inner.map(|inner| Path { inner }))
+ }
+
+ /// Returns a reference to a `std::path::Path`.
+ pub fn as_path(&self) -> &path::Path {
+ self.inner.as_path()
+ }
+
+ /// Consumes the `which::Path`, yielding its underlying `std::path::PathBuf`.
+ pub fn into_path_buf(self) -> path::PathBuf {
+ self.inner
+ }
+}
+
+impl fmt::Debug for Path {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ fmt::Debug::fmt(&self.inner, f)
+ }
+}
+
+impl std::ops::Deref for Path {
+ type Target = path::Path;
+
+ fn deref(&self) -> &path::Path {
+ self.inner.deref()
+ }
+}
+
+impl AsRef<path::Path> for Path {
+ fn as_ref(&self) -> &path::Path {
+ self.as_path()
+ }
+}
+
+impl AsRef<OsStr> for Path {
+ fn as_ref(&self) -> &OsStr {
+ self.as_os_str()
+ }
+}
+
+impl PartialEq<path::PathBuf> for Path {
+ fn eq(&self, other: &path::PathBuf) -> bool {
+ self.inner == *other
+ }
+}
+
+impl PartialEq<Path> for path::PathBuf {
+ fn eq(&self, other: &Path) -> bool {
+ *self == other.inner
+ }
+}
+
+/// An owned, immutable wrapper around a `PathBuf` containing the _canonical_ path of an
+/// executable.
+///
+/// The constructed `PathBuf` is the result of `which` or `which_in` followed by
+/// `Path::canonicalize`, but `CanonicalPath` has the advantage of being a type distinct from
+/// `std::path::Path` and `std::path::PathBuf`.
+///
+/// It can be beneficial to use `CanonicalPath` instead of `std::path::Path` when you want the type
+/// system to enforce the need for a path that exists, points to a binary that is executable, is
+/// absolute, has all components normalized, and has all symbolic links resolved
+///
+/// Since `CanonicalPath` implements `Deref` for `std::path::Path`, all methods on
+/// `&std::path::Path` are also available to `&CanonicalPath` values.
+#[derive(Clone, PartialEq, Eq)]
+pub struct CanonicalPath {
+ inner: path::PathBuf,
+}
+
+impl CanonicalPath {
+ /// Returns the canonical path of an executable binary by name.
+ ///
+ /// This calls `which` and `Path::canonicalize` and maps the result into a `CanonicalPath`.
+ pub fn new<T: AsRef<OsStr>>(binary_name: T) -> Result<CanonicalPath> {
+ which(binary_name)
+ .and_then(|p| p.canonicalize().map_err(|_| Error::CannotCanonicalize))
+ .map(|inner| CanonicalPath { inner })
+ }
+
+ /// Returns the canonical paths of an executable binary by name.
+ ///
+ /// This calls `which_all` and `Path::canonicalize` and maps the results into `CanonicalPath`s.
+ pub fn all<T: AsRef<OsStr>>(
+ binary_name: T,
+ ) -> Result<impl Iterator<Item = Result<CanonicalPath>>> {
+ which_all(binary_name).map(|inner| {
+ inner.map(|inner| {
+ inner
+ .canonicalize()
+ .map_err(|_| Error::CannotCanonicalize)
+ .map(|inner| CanonicalPath { inner })
+ })
+ })
+ }
+
+ /// Returns the canonical path of an executable binary by name in the path list `paths` and
+ /// using the current working directory `cwd` to resolve relative paths.
+ ///
+ /// This calls `which_in` and `Path::canonicalize` and maps the result into a `CanonicalPath`.
+ pub fn new_in<T, U, V>(binary_name: T, paths: Option<U>, cwd: V) -> Result<CanonicalPath>
+ where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+ {
+ which_in(binary_name, paths, cwd)
+ .and_then(|p| p.canonicalize().map_err(|_| Error::CannotCanonicalize))
+ .map(|inner| CanonicalPath { inner })
+ }
+
+ /// Returns all of the canonical paths of an executable binary by name in the path list `paths` and
+ /// using the current working directory `cwd` to resolve relative paths.
+ ///
+ /// This calls `which_in_all` and `Path::canonicalize` and maps the result into a `CanonicalPath`.
+ pub fn all_in<T, U, V>(
+ binary_name: T,
+ paths: Option<U>,
+ cwd: V,
+ ) -> Result<impl Iterator<Item = Result<CanonicalPath>>>
+ where
+ T: AsRef<OsStr>,
+ U: AsRef<OsStr>,
+ V: AsRef<path::Path>,
+ {
+ which_in_all(binary_name, paths, cwd).map(|inner| {
+ inner.map(|inner| {
+ inner
+ .canonicalize()
+ .map_err(|_| Error::CannotCanonicalize)
+ .map(|inner| CanonicalPath { inner })
+ })
+ })
+ }
+
+ /// Returns a reference to a `std::path::Path`.
+ pub fn as_path(&self) -> &path::Path {
+ self.inner.as_path()
+ }
+
+ /// Consumes the `which::CanonicalPath`, yielding its underlying `std::path::PathBuf`.
+ pub fn into_path_buf(self) -> path::PathBuf {
+ self.inner
+ }
+}
+
+impl fmt::Debug for CanonicalPath {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ fmt::Debug::fmt(&self.inner, f)
+ }
+}
+
+impl std::ops::Deref for CanonicalPath {
+ type Target = path::Path;
+
+ fn deref(&self) -> &path::Path {
+ self.inner.deref()
+ }
+}
+
+impl AsRef<path::Path> for CanonicalPath {
+ fn as_ref(&self) -> &path::Path {
+ self.as_path()
+ }
+}
+
+impl AsRef<OsStr> for CanonicalPath {
+ fn as_ref(&self) -> &OsStr {
+ self.as_os_str()
+ }
+}
+
+impl PartialEq<path::PathBuf> for CanonicalPath {
+ fn eq(&self, other: &path::PathBuf) -> bool {
+ self.inner == *other
+ }
+}
+
+impl PartialEq<CanonicalPath> for path::PathBuf {
+ fn eq(&self, other: &CanonicalPath) -> bool {
+ *self == other.inner
+ }
+}
diff --git a/crates/which/tests/basic.rs b/crates/which/tests/basic.rs
new file mode 100644
index 0000000..32a1a28
--- /dev/null
+++ b/crates/which/tests/basic.rs
@@ -0,0 +1,404 @@
+extern crate which;
+
+#[cfg(all(unix, feature = "regex"))]
+use regex::Regex;
+use std::ffi::{OsStr, OsString};
+use std::fs;
+use std::io;
+use std::path::{Path, PathBuf};
+use std::{env, vec};
+use tempfile::TempDir;
+
+struct TestFixture {
+ /// Temp directory.
+ pub tempdir: TempDir,
+ /// $PATH
+ pub paths: OsString,
+ /// Binaries created in $PATH
+ pub bins: Vec<PathBuf>,
+}
+
+const SUBDIRS: &[&str] = &["a", "b", "c"];
+const BIN_NAME: &str = "bin";
+
+#[cfg(unix)]
+fn mk_bin(dir: &Path, path: &str, extension: &str) -> io::Result<PathBuf> {
+ use std::os::unix::fs::OpenOptionsExt;
+ let bin = dir.join(path).with_extension(extension);
+ fs::OpenOptions::new()
+ .write(true)
+ .create(true)
+ .mode(0o666 | (libc::S_IXUSR as u32))
+ .open(&bin)
+ .and_then(|_f| bin.canonicalize())
+}
+
+fn touch(dir: &Path, path: &str, extension: &str) -> io::Result<PathBuf> {
+ let b = dir.join(path).with_extension(extension);
+ fs::File::create(&b).and_then(|_f| b.canonicalize())
+}
+
+#[cfg(windows)]
+fn mk_bin(dir: &Path, path: &str, extension: &str) -> io::Result<PathBuf> {
+ touch(dir, path, extension)
+}
+
+impl TestFixture {
+ // tmp/a/bin
+ // tmp/a/bin.exe
+ // tmp/a/bin.cmd
+ // tmp/b/bin
+ // tmp/b/bin.exe
+ // tmp/b/bin.cmd
+ // tmp/c/bin
+ // tmp/c/bin.exe
+ // tmp/c/bin.cmd
+ pub fn new() -> TestFixture {
+ let tempdir = tempfile::tempdir().unwrap();
+ let mut builder = fs::DirBuilder::new();
+ builder.recursive(true);
+ let mut paths = vec![];
+ let mut bins = vec![];
+ for d in SUBDIRS.iter() {
+ let p = tempdir.path().join(d);
+ builder.create(&p).unwrap();
+ bins.push(mk_bin(&p, BIN_NAME, "").unwrap());
+ bins.push(mk_bin(&p, BIN_NAME, "exe").unwrap());
+ bins.push(mk_bin(&p, BIN_NAME, "cmd").unwrap());
+ paths.push(p);
+ }
+ let p = tempdir.path().join("win-bin");
+ builder.create(&p).unwrap();
+ bins.push(mk_bin(&p, "win-bin", "exe").unwrap());
+ paths.push(p);
+ TestFixture {
+ tempdir,
+ paths: env::join_paths(paths).unwrap(),
+ bins,
+ }
+ }
+
+ #[allow(dead_code)]
+ pub fn touch(&self, path: &str, extension: &str) -> io::Result<PathBuf> {
+ touch(self.tempdir.path(), path, extension)
+ }
+
+ pub fn mk_bin(&self, path: &str, extension: &str) -> io::Result<PathBuf> {
+ mk_bin(self.tempdir.path(), path, extension)
+ }
+}
+
+fn _which<T: AsRef<OsStr>>(f: &TestFixture, path: T) -> which::Result<which::CanonicalPath> {
+ which::CanonicalPath::new_in(path, Some(f.paths.clone()), f.tempdir.path())
+}
+
+fn _which_all<'a, T: AsRef<OsStr> + 'a>(
+ f: &'a TestFixture,
+ path: T,
+) -> which::Result<impl Iterator<Item = which::Result<which::CanonicalPath>> + '_> {
+ which::CanonicalPath::all_in(path, Some(f.paths.clone()), f.tempdir.path())
+}
+
+#[test]
+#[cfg(unix)]
+fn it_works() {
+ use std::process::Command;
+ let result = which::Path::new("rustc");
+ assert!(result.is_ok());
+
+ let which_result = Command::new("which").arg("rustc").output();
+
+ assert_eq!(
+ String::from(result.unwrap().to_str().unwrap()),
+ String::from_utf8(which_result.unwrap().stdout)
+ .unwrap()
+ .trim()
+ );
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which() {
+ let f = TestFixture::new();
+ assert_eq!(_which(&f, &BIN_NAME).unwrap(), f.bins[0])
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which() {
+ let f = TestFixture::new();
+ assert_eq!(_which(&f, &BIN_NAME).unwrap(), f.bins[1])
+}
+
+#[test]
+#[cfg(all(unix, feature = "regex"))]
+fn test_which_re_in_with_matches() {
+ let f = TestFixture::new();
+ f.mk_bin("a/bin_0", "").unwrap();
+ f.mk_bin("b/bin_1", "").unwrap();
+ let re = Regex::new(r"bin_\d").unwrap();
+
+ let result: Vec<PathBuf> = which::which_re_in(re, Some(f.paths))
+ .unwrap()
+ .into_iter()
+ .collect();
+
+ let temp = f.tempdir;
+
+ assert_eq!(
+ result,
+ vec![temp.path().join("a/bin_0"), temp.path().join("b/bin_1")]
+ )
+}
+
+#[test]
+#[cfg(all(unix, feature = "regex"))]
+fn test_which_re_in_without_matches() {
+ let f = TestFixture::new();
+ let re = Regex::new(r"bi[^n]").unwrap();
+
+ let result: Vec<PathBuf> = which::which_re_in(re, Some(f.paths))
+ .unwrap()
+ .into_iter()
+ .collect();
+
+ assert_eq!(result, Vec::<PathBuf>::new())
+}
+
+#[test]
+#[cfg(all(unix, feature = "regex"))]
+fn test_which_re_accepts_owned_and_borrow() {
+ which::which_re(Regex::new(r".").unwrap())
+ .unwrap()
+ .for_each(drop);
+ which::which_re(&Regex::new(r".").unwrap())
+ .unwrap()
+ .for_each(drop);
+ which::which_re_in(Regex::new(r".").unwrap(), Some("pth"))
+ .unwrap()
+ .for_each(drop);
+ which::which_re_in(&Regex::new(r".").unwrap(), Some("pth"))
+ .unwrap()
+ .for_each(drop);
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_extension() {
+ let f = TestFixture::new();
+ let b = Path::new(&BIN_NAME).with_extension("");
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[0])
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_extension() {
+ let f = TestFixture::new();
+ let b = Path::new(&BIN_NAME).with_extension("cmd");
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[2])
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_no_extension() {
+ let f = TestFixture::new();
+ let b = Path::new("win-bin");
+ let which_result = which::which_in(&b, Some(&f.paths), ".").unwrap();
+ // Make sure the extension is the correct case.
+ assert_eq!(which_result.extension(), f.bins[9].extension());
+ assert_eq!(fs::canonicalize(&which_result).unwrap(), f.bins[9])
+}
+
+#[test]
+fn test_which_not_found() {
+ let f = TestFixture::new();
+ assert!(_which(&f, "a").is_err());
+}
+
+#[test]
+fn test_which_second() {
+ let f = TestFixture::new();
+ let b = f.mk_bin("b/another", env::consts::EXE_EXTENSION).unwrap();
+ assert_eq!(_which(&f, "another").unwrap(), b);
+}
+
+#[test]
+fn test_which_all() {
+ let f = TestFixture::new();
+ let actual = _which_all(&f, BIN_NAME)
+ .unwrap()
+ .map(|c| c.unwrap())
+ .collect::<Vec<_>>();
+ let mut expected = f
+ .bins
+ .iter()
+ .map(|p| p.canonicalize().unwrap())
+ .collect::<Vec<_>>();
+ #[cfg(windows)]
+ {
+ expected.retain(|p| p.file_stem().unwrap() == BIN_NAME);
+ expected.retain(|p| p.extension().map(|ext| ext == "exe" || ext == "cmd") == Some(true));
+ }
+ #[cfg(not(windows))]
+ {
+ expected.retain(|p| p.file_name().unwrap() == BIN_NAME);
+ }
+ assert_eq!(actual, expected);
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_absolute() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, &f.bins[3]).unwrap(),
+ f.bins[3].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_absolute() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, &f.bins[4]).unwrap(),
+ f.bins[4].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_absolute_path_case() {
+ // Test that an absolute path with an uppercase extension
+ // is accepted.
+ let f = TestFixture::new();
+ let p = &f.bins[4];
+ assert_eq!(_which(&f, &p).unwrap(), f.bins[4].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_absolute_extension() {
+ let f = TestFixture::new();
+ // Don't append EXE_EXTENSION here.
+ let b = f.bins[3].parent().unwrap().join(&BIN_NAME);
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[3].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_absolute_extension() {
+ let f = TestFixture::new();
+ // Don't append EXE_EXTENSION here.
+ let b = f.bins[4].parent().unwrap().join(&BIN_NAME);
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[4].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_relative() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, "b/bin").unwrap(),
+ f.bins[3].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_relative() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, "b/bin").unwrap(),
+ f.bins[4].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_relative_extension() {
+ // test_which_relative tests a relative path without an extension,
+ // so test a relative path with an extension here.
+ let f = TestFixture::new();
+ let b = Path::new("b/bin").with_extension(env::consts::EXE_EXTENSION);
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[3].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_relative_extension() {
+ // test_which_relative tests a relative path without an extension,
+ // so test a relative path with an extension here.
+ let f = TestFixture::new();
+ let b = Path::new("b/bin").with_extension("cmd");
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[5].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_relative_extension_case() {
+ // Test that a relative path with an uppercase extension
+ // is accepted.
+ let f = TestFixture::new();
+ let b = Path::new("b/bin").with_extension("EXE");
+ assert_eq!(_which(&f, &b).unwrap(), f.bins[4].canonicalize().unwrap());
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_relative_leading_dot() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, "./b/bin").unwrap(),
+ f.bins[3].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(windows)]
+fn test_which_relative_leading_dot() {
+ let f = TestFixture::new();
+ assert_eq!(
+ _which(&f, "./b/bin").unwrap(),
+ f.bins[4].canonicalize().unwrap()
+ );
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_non_executable() {
+ // Shouldn't return non-executable files.
+ let f = TestFixture::new();
+ f.touch("b/another", "").unwrap();
+ assert!(_which(&f, "another").is_err());
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_absolute_non_executable() {
+ // Shouldn't return non-executable files, even if given an absolute path.
+ let f = TestFixture::new();
+ let b = f.touch("b/another", "").unwrap();
+ assert!(_which(&f, &b).is_err());
+}
+
+#[test]
+#[cfg(unix)]
+fn test_which_relative_non_executable() {
+ // Shouldn't return non-executable files.
+ let f = TestFixture::new();
+ f.touch("b/another", "").unwrap();
+ assert!(_which(&f, "b/another").is_err());
+}
+
+#[test]
+fn test_failure() {
+ let f = TestFixture::new();
+
+ let run = || -> which::Result<PathBuf> {
+ let p = _which(&f, "./b/bin")?;
+ Ok(p.into_path_buf())
+ };
+
+ let _ = run();
+}
diff --git a/crates/winnow/.cargo-checksum.json b/crates/winnow/.cargo-checksum.json
new file mode 100644
index 0000000..c82a3d6
--- /dev/null
+++ b/crates/winnow/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.lock":"db694e7e6a1d861cf51cc0db96f47cd04136035be41b456a871d6be38df7909a","Cargo.toml":"282f87b5600ef0f2476bba16911877bce142c1109930a5b297d702ab0ee72f83","LICENSE-MIT":"cb5aedb296c5246d1f22e9099f925a65146f9f0d6b4eebba97fd27a6cdbbab2d","README.md":"0b7e4cad5ef0cbb47dc1c1c34ff3b5d090aaba2cc3b3c5401539e5c4a22b7938","benches/contains_token.rs":"20e765de27f0ad9bf549e250bdb67d73714d23bc10bb67be240a258dcf8b6ed7","benches/find_slice.rs":"4853142ad538403b17c5f2d486b958a11628039b5366925927e61743ea462c48","benches/iter.rs":"bede3f156b87ffb8b901b092bcbb2717b7adf9a461a2fecdfad86025aad3e587","benches/next_slice.rs":"7cb1ea5e7122676532ecfbc53e0de78417bf96546c63a170370db8a99c90620b","benches/number.rs":"f4b54895ed523c462ce327a5205b0b99591eb7056fe9de9abe3f809eff287386","examples/arithmetic/bench.rs":"a162e4f91ce2ed19b5b53f79d77c92eb52278f0788da9af8fee3ee62cebfe0a9","examples/arithmetic/main.rs":"b7f2090beefa76ca324d23bc62e06ef97df8c7d02934998f4ddce1ac45e0b852","examples/arithmetic/parser.rs":"318f804e7324b762a7f84f4202537a21c2a299111b42e559d682a6d01857119a","examples/arithmetic/parser_ast.rs":"93f4b8a361bf37f20cba941a9bee878890e86eee0eb8256162f52910a8c43fe2","examples/arithmetic/parser_lexer.rs":"ecdbe258e9f88d5f25f6a57da3de5f4426b01f86f7ba20d2fd4e35a75481d2c8","examples/css/main.rs":"3127f259af57aaaa8363bfa6e0a64c9719173cc1dcc5a293771a2c8a7f31982e","examples/css/parser.rs":"e81d89b876288637d8480fe981ddacdf2faa7f54da051801ee308db39834497d","examples/custom_error.rs":"5ebf88007ed2ce998fdb16cd4326b1573e83f0c420e2f6561c10b6dd8ebf69a2","examples/http/bench.rs":"b6d3e9e5833b53ac58f8336617cc42a2f3f4c5e5ce88feb23184fcdbb36843f6","examples/http/main.rs":"95d3c73953cd76ea462d886ade2ab34e987239bae3abb0349c434fb01b80467d","examples/http/parser.rs":"21ebf9083fd5ced93ba74865bab80c76ba6ec0dcdf9f6fcc95acb7c0c90c2a73","examples/http/parser_streaming.rs":"468c2896d03d0d35bfe0ed750c13643e9a13d2dc4a651c0d9ffc024aba7fada7","examples/ini/bench.rs":"c8fd1aed25ce2878c0f440d765779d7877e83ca202cf071f8f4c57566596bf89","examples/ini/main.rs":"d771aa8aae11e53f4f5453ac39e10ae3a1de210408dfd31ca7d1ce58d14c3fb9","examples/ini/parser.rs":"c554286e8f2077f999d607902e7a63ce3945939118bccf830a68b22bfe24c775","examples/ini/parser_str.rs":"d55687d113440e40ce6df400a49331183feac3e904844af57b956caaa567fcec","examples/iterator.rs":"21fb0480749116407689162f0d3e9957e3e7b6863f9dda08ee01af675409b06e","examples/json/bench.rs":"9479248ccef46e0741e0eebf9fb3b307b343ba665925481adc4554d8e65f9d39","examples/json/json.rs":"48cf6c114098113c9767bebe430682f55f7c1a227e6486131ca58c00770711f2","examples/json/main.rs":"7ab1f6eefd4eb61153cf05991e593fd10827ac09f66af45d3019f94c39c5b84e","examples/json/parser.rs":"b7de8bfed29aa5c1da9f483d601dd2bb4129b8b2783bd0d339e356f34b265254","examples/json/parser_dispatch.rs":"148bfb3a1c73181b935dd4ad12ff1b79ce375f908377b93bdbfe0c7339d4e513","examples/json/parser_partial.rs":"d39c6749038031a363a79d9ee87fe9ea8c2bf21a321884845f37a1f63cac2905","examples/json_iterator.rs":"2a8a842b43fdea12a6b5c4927cede23cbd0eb96bb1cbf42a794103fc9be9ff3a","examples/ndjson/example.ndjson":"c44c130731008bca76181348d40f46b183577949b5a4d229e0e1a56e1e405e5d","examples/ndjson/main.rs":"dc92dd5d76b5d43edf947b6455d552f0212e46d59c926d95f97f5d159b14e361","examples/ndjson/parser.rs":"948a876edc6fbac22920c40c40c319fc48806544b7b7bc6d17109513d87e8179","examples/s_expression/main.rs":"5a2de0b477807c7d6ab8bb72579f03692e8f5ea89d5b6f3a8342cfdbe4d84b96","examples/s_expression/parser.rs":"2a468bf61e4aed9aa5c556fb19c479060d121f60671865324675ab9fd92f0ddd","examples/string/main.rs":"e6362f957d532d41bcd96476e55ac4c253eb04fa25ee88b48d872661a46a5bb5","examples/string/parser.rs":"7ed4bb82c4ec7f4b5a88b1ef127d7b6e59f5ff4105cc8d6b4590cf8d242f0799","src/_topic/arithmetic.rs":"28d61dd492b308209d534c54813ea48ac1862a39196527042180de7718f915d0","src/_topic/error.rs":"0d5e9631ff497d52e9da21958cae1b12e0e5d7293b0e650c5321a4d2a2bdcbcd","src/_topic/fromstr.rs":"01abdab296cd30067ae5f508b2b21ebe97c0571ace58e7817876eb2110e8d23a","src/_topic/http.rs":"19b9ec78a031fe5b3086fb34d04d6c13308c50b6e7bfe30229f5b682d3605ac8","src/_topic/ini.rs":"b2b04d48eac3158f4e26ee9dce748a699d02acaa0b12ae8d54421cad0fdc4ad7","src/_topic/json.rs":"bde39ee6b1c5fab2d2da480822b737674aed877f92c3f748d6932bec313b5661","src/_topic/language.rs":"61fc2e5bea30ded24fad43aaa6a7d5de940e6236f95c54093490be79514ff4ed","src/_topic/mod.rs":"c52d1cf092892d2b7548316a7ce77e2fabca1bd43e2bebc549f2a3f5d2fe9e9f","src/_topic/nom.rs":"9e7c4a900a7ad1bd417d9a72f2a5122a75707c5d53a2d39845b350d5aab362ca","src/_topic/partial.rs":"4777cedfbe8437a547114da346f6cd350d8e77ae62e2ed32d50636e9acbf876e","src/_topic/performance.rs":"115b636769c307bd80ecc5b89ffad47877352bc93ef47bf664093d3d7a2562cc","src/_topic/s_expression.rs":"6ca9a22a5c3344e120421f2ab353a1e822777aebfa1faa0acffc9632f7668cb2","src/_topic/stream.rs":"acc1e8942e27fec3911c562934be6bf9b096d436593af50a4418d9e0fe607535","src/_topic/why.rs":"097dbb252ed0c67e0d50157e1826286997450a9c413cf40697c0918e0dfecba1","src/_tutorial/chapter_0.rs":"c0512cb9857edb9df0ac1d327fccb1e950019b9a417959c802714039038b8bce","src/_tutorial/chapter_1.rs":"743847b36faab89235f7e4d36076b5090d1dff7c0f5f38f9c3387aaff80bbec2","src/_tutorial/chapter_2.rs":"3671bfd14e7a9c6c630daac8bc2c8128938fd0f830a5524c33a800d06d4cd205","src/_tutorial/chapter_3.rs":"b5dfcc806552ee958ef27558d377d6abee1c1437a5829941c51f475f389e2aa4","src/_tutorial/chapter_4.rs":"4390d7ec2a67a726bd8df7f62ebd3fc26df926e79c014b8a2e623ec3e4c1ca25","src/_tutorial/chapter_5.rs":"25656769ea285f9d6d3780294a24491b27918cecd754b430220b56ac2047a10c","src/_tutorial/chapter_6.rs":"51fae6d7479288f518d04d43b3e987aa0f26f83ff0620ca4bdcfe7ec92e2e0cb","src/_tutorial/chapter_7.rs":"6ffab9e8a2a7ef6c38dfb097a1f8ab6bffe86545511259a00e81e5b6e4367650","src/_tutorial/chapter_8.rs":"ddd6ec7cdd2d888a2361c4715221be2fdd24475d7be2953474fdd2a01ce6234a","src/_tutorial/mod.rs":"afba818d7d1c8309bee5399dc8f695d93b08e93f406734d41e7e66c019b43c53","src/ascii/mod.rs":"d607899a8399e769659d54dbee12e783239d7574224f507d09fbd0baef7294c2","src/ascii/tests.rs":"fc44d6120c7e6ca4f70684f668e195884ff1193e6924b99093cf411ad90f4a8b","src/binary/bits/mod.rs":"c0ba2cafd89f11d3f70c036b713e7792d7b55aa61cf91f12dc1a9d88766b660a","src/binary/bits/tests.rs":"1ce1707a8ab2300d601f67fb3cb9c4b8ba7528564477e65ff25d8542c3e0f6e7","src/binary/mod.rs":"79bf5f8f49ca21205afa2666762b68ec5769283f5503e86eacf6abe88b639e63","src/binary/tests.rs":"107a6a36115f0a52b5adf9e5e3bd2d242fc43888e916d3acca772c49563c545b","src/combinator/branch.rs":"243f68835c1ebd8407658f823093fd86f2e02d2dd79dcbde576b87c78e835689","src/combinator/core.rs":"a7c773c79001e061742327b4fa99082e4cb023e26defc5f23fc9f31fc83abc1f","src/combinator/debug/internals.rs":"3480e946ba22390ac84046487728fd89d78cb3bc5547305162ed925e2437802f","src/combinator/debug/mod.rs":"2b876e31880f3a1ff84585a5d31458f5c0e135a9d6176cb36859e365cbbe8baf","src/combinator/mod.rs":"b6d97df5256857b95d9d683682efc5b6078b43a3abd0a51bd55df6da93e67f9d","src/combinator/multi.rs":"ba423a6b199ddb550f9f2c63700a0c5ef16c5652863a1ad67c47210f63efe837","src/combinator/parser.rs":"a3ee56f3d12b6d1a5c74e590b646bde5aacf653d64fbb9a983ec2402b7af80ab","src/combinator/sequence.rs":"9ecf8e294fea355d00b4cc8d8a82c56b0565bc647d4f294a8c73c1d85d7dd355","src/combinator/tests.rs":"93848556fb5461e0bbbd9926d30204ef6980c88c0b36351048a8f140c0de2124","src/error.rs":"61d03a606b543e0e22eeefc4ee15abd7745fff6d089d904702692206aba4cefa","src/lib.rs":"a967f08aea09bfc95eb53112fd4718baa39819f9c35f9098bf29c5e0a4445a30","src/macros/dispatch.rs":"6a82b6f3472a58d114e2b40443d7177d326f9b9b7b25d1370b4867838e0e1e80","src/macros/mod.rs":"9faebae01ea216cda6160cc306ca4a5f531344aa65a628973c0825d0f53b3fb3","src/macros/seq.rs":"c64d7354d27c21b37901887f0bd3fb1c720adbe6c677a02880636d0ba9fc9491","src/macros/test.rs":"7b1df320d703fdedf90204d094c209cb69a3022b2cefb27803fb73031596b87b","src/parser.rs":"a26ffd1c9cfcb518b3224165dea96b6fe66c6bfad9a96b2b20745134d7f72419","src/stream/impls.rs":"139025ed7c350c86e14b3a23019b1e5569cfee98c5f3e07d5a7dc69f411a8730","src/stream/mod.rs":"db11794ada41fc3145691eab621fdb07096229bfe951f5c8e682b99cec4f7b11","src/stream/tests.rs":"399d884c7b1baf256f667f8dd25218fa473bd30a3b293625f756a9accd5b1f2d","src/token/mod.rs":"fc109bbd13e3531376c8a2cc3be6dd0c93b2fbf30113df958b6d862c432faa19","src/token/tests.rs":"74b54c5b631a29377c0af15329c822fed9752031d04531444d4c2b23367e3a5c","src/trace.rs":"6a1f066c7a3e4d93b6fdb0fa53c08e744b19173bb669f389933786908a88a5e0"},"package":"a7cad8365489051ae9f054164e459304af2e7e9bb407c958076c8bf4aef52da5"}
\ No newline at end of file
diff --git a/crates/winnow/Android.bp b/crates/winnow/Android.bp
new file mode 100644
index 0000000..79f5412
--- /dev/null
+++ b/crates/winnow/Android.bp
@@ -0,0 +1,28 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_winnow_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_winnow_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library_host {
+ name: "libwinnow",
+ crate_name: "winnow",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.5.37",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ features: [
+ "alloc",
+ "default",
+ "std",
+ ],
+}
diff --git a/crates/winnow/Cargo.lock b/crates/winnow/Cargo.lock
new file mode 100644
index 0000000..9dcaa1c
--- /dev/null
+++ b/crates/winnow/Cargo.lock
@@ -0,0 +1,1422 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "anes"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b46cbb362ab8752921c97e041f5e366ee6297bd428a31275b9fcf1e380f7299"
+
+[[package]]
+name = "anstream"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ca84f3628370c59db74ee214b3263d58f9aadd9b4fe7e711fd87dc452b7f163"
+dependencies = [
+ "anstyle",
+ "anstyle-parse",
+ "anstyle-query",
+ "anstyle-wincon",
+ "colorchoice",
+ "is-terminal",
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3a30da5c5f2d5e72842e00bcb57657162cdabef0931f40e2deb9b4140440cecd"
+
+[[package]]
+name = "anstyle-parse"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "938874ff5980b03a87c5524b3ae5b59cf99b1d6bc836848df7bc5ada9643c333"
+dependencies = [
+ "utf8parse",
+]
+
+[[package]]
+name = "anstyle-query"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ca11d4be1bab0c8bc8734a9aa7bf4ee8316d462a08c6ac5052f888fef5b494b"
+dependencies = [
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "anstyle-wincon"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "180abfa45703aebe0093f79badacc01b8fd4ea2e35118747e5811127f926e188"
+dependencies = [
+ "anstyle",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "atty"
+version = "0.2.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d9b39be18770d11421cdb1b9947a45dd3f37e93092cbf377614828a319d5fee8"
+dependencies = [
+ "hermit-abi 0.1.19",
+ "libc",
+ "winapi",
+]
+
+[[package]]
+name = "autocfg"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+
+[[package]]
+name = "bit-set"
+version = "0.5.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0700ddab506f33b20a03b13996eccd309a48e5ff77d0d95926aa0210fb4e95f1"
+dependencies = [
+ "bit-vec",
+]
+
+[[package]]
+name = "bit-vec"
+version = "0.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "349f9b6a179ed607305526ca489b34ad0a41aed5f7980fa90eb03160b69598fb"
+
+[[package]]
+name = "bitflags"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
+name = "bitflags"
+version = "2.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "630be753d4e58660abd17930c71b647fe46c27ea6b63cc59e1e3851406972e42"
+
+[[package]]
+name = "block-buffer"
+version = "0.10.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "69cce20737498f97b993470a6e536b8523f0af7892a4f928cceb1ac5e52ebe7e"
+dependencies = [
+ "generic-array",
+]
+
+[[package]]
+name = "bumpalo"
+version = "3.13.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a3e2c3daef883ecc1b5d58c15adae93470a91d425f3532ba1695849656af3fc1"
+
+[[package]]
+name = "bytecount"
+version = "0.6.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2c676a478f63e9fa2dd5368a42f28bba0d6c560b775f38583c8bbaa7fcd67c9c"
+
+[[package]]
+name = "byteorder"
+version = "1.4.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "14c189c53d098945499cdfa7ecc63567cf3886b3332b312a5b4585d8d3a6a610"
+
+[[package]]
+name = "cast"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "37b2a672a2cb129a2e41c10b1224bb368f9f37a2b16b612598138befd7b37eb5"
+
+[[package]]
+name = "cc"
+version = "1.0.79"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "50d30906286121d95be3d479533b458f87493b30a4b5f79a607db8f5d11aa91f"
+
+[[package]]
+name = "cfg-if"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
+
+[[package]]
+name = "ciborium"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "effd91f6c78e5a4ace8a5d3c0b6bfaec9e2baaef55f3efc00e45fb2e477ee926"
+dependencies = [
+ "ciborium-io",
+ "ciborium-ll",
+ "serde",
+]
+
+[[package]]
+name = "ciborium-io"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cdf919175532b369853f5d5e20b26b43112613fd6fe7aee757e35f7a44642656"
+
+[[package]]
+name = "ciborium-ll"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "defaa24ecc093c77630e6c15e17c51f5e187bf35ee514f4e2d67baaa96dae22b"
+dependencies = [
+ "ciborium-io",
+ "half",
+]
+
+[[package]]
+name = "circular"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b0fc239e0f6cb375d2402d48afb92f76f5404fd1df208a41930ec81eda078bea"
+
+[[package]]
+name = "clap"
+version = "4.3.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5fd304a20bff958a57f04c4e96a2e7594cc4490a0e809cbd48bb6437edaa452d"
+dependencies = [
+ "clap_builder",
+]
+
+[[package]]
+name = "clap_builder"
+version = "4.3.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "01c6a3f08f1fe5662a35cfe393aec09c4df95f60ee93b7556505260f75eee9e1"
+dependencies = [
+ "anstyle",
+ "clap_lex",
+]
+
+[[package]]
+name = "clap_lex"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2da6da31387c7e4ef160ffab6d5e7f00c42626fe39aea70a7b0f1773f7dd6c1b"
+
+[[package]]
+name = "colorchoice"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
+
+[[package]]
+name = "cpufeatures"
+version = "0.2.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "28d997bd5e24a5928dd43e46dc529867e207907fe0b239c3477d924f7f2ca320"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "criterion"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f2b12d017a929603d80db1831cd3a24082f8137ce19c69e6447f54f5fc8d692f"
+dependencies = [
+ "anes",
+ "cast",
+ "ciborium",
+ "clap",
+ "criterion-plot",
+ "is-terminal",
+ "itertools",
+ "num-traits",
+ "once_cell",
+ "oorandom",
+ "plotters",
+ "rayon",
+ "regex",
+ "serde",
+ "serde_derive",
+ "serde_json",
+ "tinytemplate",
+ "walkdir",
+]
+
+[[package]]
+name = "criterion-plot"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6b50826342786a51a89e2da3a28f1c32b06e387201bc2d19791f622c673706b1"
+dependencies = [
+ "cast",
+ "itertools",
+]
+
+[[package]]
+name = "crossbeam-channel"
+version = "0.5.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a33c2bf77f2df06183c3aa30d1e96c0695a313d4f9c453cc3762a6db39f99200"
+dependencies = [
+ "cfg-if",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-deque"
+version = "0.8.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ce6fd6f855243022dcecf8702fef0c297d4338e226845fe067f6341ad9fa0cef"
+dependencies = [
+ "cfg-if",
+ "crossbeam-epoch",
+ "crossbeam-utils",
+]
+
+[[package]]
+name = "crossbeam-epoch"
+version = "0.9.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ae211234986c545741a7dc064309f67ee1e5ad243d0e48335adc0484d960bcc7"
+dependencies = [
+ "autocfg",
+ "cfg-if",
+ "crossbeam-utils",
+ "memoffset",
+ "scopeguard",
+]
+
+[[package]]
+name = "crossbeam-utils"
+version = "0.8.16"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a22b2d63d4d1dc0b7f1b6b2747dd0088008a9be28b6ddf0b1e7d335e3037294"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "crypto-common"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1bfb12502f3fc46cca1bb51ac28df9d618d813cdc3d2f25b9fe775a34af26bb3"
+dependencies = [
+ "generic-array",
+ "typenum",
+]
+
+[[package]]
+name = "ctor"
+version = "0.1.26"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d2301688392eb071b0bf1a37be05c469d3cc4dbbd95df672fe28ab021e6a096"
+dependencies = [
+ "quote",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "diff"
+version = "0.1.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8"
+
+[[package]]
+name = "digest"
+version = "0.10.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8168378f4e5023e7218c89c891c0fd8ecdb5e5e4f18cb78f38cf245dd021e76f"
+dependencies = [
+ "block-buffer",
+ "crypto-common",
+]
+
+[[package]]
+name = "doc-comment"
+version = "0.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10"
+
+[[package]]
+name = "either"
+version = "1.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7fcaabb2fef8c910e7f4c7ce9f67a1283a1715879a7c230ca9d6d1ae31f16d91"
+
+[[package]]
+name = "errno"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4bcfec3a70f97c962c307b2d2c56e358cf1d00b558d74262b5f929ee8cc7e73a"
+dependencies = [
+ "errno-dragonfly",
+ "libc",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "errno-dragonfly"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "aa68f1b12764fab894d2755d2518754e71b4fd80ecfb822714a1206c2aab39bf"
+dependencies = [
+ "cc",
+ "libc",
+]
+
+[[package]]
+name = "escargot"
+version = "0.5.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f5584ba17d7ab26a8a7284f13e5bd196294dd2f2d79773cff29b9e9edef601a6"
+dependencies = [
+ "log",
+ "once_cell",
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "fastrand"
+version = "1.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e51093e27b0797c359783294ca4f0a911c270184cb10f85783b118614a1501be"
+dependencies = [
+ "instant",
+]
+
+[[package]]
+name = "fnv"
+version = "1.0.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1"
+
+[[package]]
+name = "generic-array"
+version = "0.14.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bff49e947297f3312447abdca79f45f4738097cc82b06e72054d2223f601f1b9"
+dependencies = [
+ "typenum",
+ "version_check",
+]
+
+[[package]]
+name = "getrandom"
+version = "0.2.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be4136b2a15dd319360be1c07d9933517ccf0be8f16bf62a3bee4f0d618df427"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "wasi",
+]
+
+[[package]]
+name = "half"
+version = "1.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eabb4a44450da02c90444cf74558da904edde8fb4e9035a9a6a4e15445af0bd7"
+
+[[package]]
+name = "handlebars"
+version = "4.3.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "035ef95d03713f2c347a72547b7cd38cbc9af7cd51e6099fb62d586d4a6dee3a"
+dependencies = [
+ "log",
+ "pest",
+ "pest_derive",
+ "serde",
+ "serde_json",
+ "thiserror",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.1.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "62b467343b94ba476dcb2500d242dadbb39557df889310ac77c5d99100aaac33"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee512640fe35acbfb4bb779db6f0d80704c2cacfa2e39b601ef3e3f47d1ae4c7"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "hermit-abi"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fed44880c466736ef9a5c5b5facefb5ed0785676d0c02d612db14e54f0d84286"
+
+[[package]]
+name = "instant"
+version = "0.1.12"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7a5bbe824c507c5da5956355e86a746d82e0e1464f65d862cc5e71da70e94b2c"
+dependencies = [
+ "cfg-if",
+]
+
+[[package]]
+name = "io-lifetimes"
+version = "1.0.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eae7b9aee968036d54dce06cebaefd919e4472e753296daccd6d344e3e2df0c2"
+dependencies = [
+ "hermit-abi 0.3.1",
+ "libc",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "is-terminal"
+version = "0.4.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cb0889898416213fab133e1d33a0e5858a48177452750691bde3666d0fdbaf8b"
+dependencies = [
+ "hermit-abi 0.3.1",
+ "rustix 0.38.6",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "itertools"
+version = "0.10.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b0fd2260e829bddf4cb6ea802289de2f86d6a7a690192fbe91b3f46e0f2c8473"
+dependencies = [
+ "either",
+]
+
+[[package]]
+name = "itoa"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "453ad9f582a441959e5f0d088b02ce04cfe8d51a8eaf077f12ac6d3e94164ca6"
+
+[[package]]
+name = "js-sys"
+version = "0.3.64"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c5f195fe497f702db0f318b07fdd68edb16955aed830df8363d837542f8f935a"
+dependencies = [
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "lazy_static"
+version = "1.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
+
+[[package]]
+name = "lexopt"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "baff4b617f7df3d896f97fe922b64817f6cd9a756bb81d40f8883f2f66dcb401"
+
+[[package]]
+name = "libc"
+version = "0.2.147"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b4668fb0ea861c1df094127ac5f1da3409a82116a4ba74fca2e58ef927159bb3"
+
+[[package]]
+name = "libm"
+version = "0.2.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f7012b1bbb0719e1097c47611d3898568c546d597c2e74d66f6087edd5233ff4"
+
+[[package]]
+name = "linux-raw-sys"
+version = "0.3.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ef53942eb7bf7ff43a617b3e2c1c4a5ecf5944a7c1bc12d7ee39bbb15e5c1519"
+
+[[package]]
+name = "linux-raw-sys"
+version = "0.4.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "57bcfdad1b858c2db7c38303a6d2ad4dfaf5eb53dfeb0910128b2c26d6158503"
+
+[[package]]
+name = "log"
+version = "0.4.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b06a4cde4c0f271a446782e3eff8de789548ce57dbc8eca9292c27f4a42004b4"
+
+[[package]]
+name = "memchr"
+version = "2.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2dffe52ecf27772e601905b7522cb4ef790d2cc203488bbd0e2fe85fcb74566d"
+
+[[package]]
+name = "memoffset"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5a634b1c61a95585bd15607c6ab0c4e5b226e695ff2800ba0cdccddf208c406c"
+dependencies = [
+ "autocfg",
+]
+
+[[package]]
+name = "normalize-line-endings"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "61807f77802ff30975e01f4f071c8ba10c022052f98b3294119f3e615d13e5be"
+
+[[package]]
+name = "num-traits"
+version = "0.2.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "578ede34cf02f8924ab9447f50c28075b4d3e5b269972345e7e0372b38c6cdcd"
+dependencies = [
+ "autocfg",
+ "libm",
+]
+
+[[package]]
+name = "num_cpus"
+version = "1.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fac9e2da13b5eb447a6ce3d392f23a29d8694bff781bf03a16cd9ac8697593b"
+dependencies = [
+ "hermit-abi 0.2.6",
+ "libc",
+]
+
+[[package]]
+name = "once_cell"
+version = "1.18.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dd8b5dd2ae5ed71462c540258bedcb51965123ad7e7ccf4b9a8cafaa4a63576d"
+
+[[package]]
+name = "oorandom"
+version = "11.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0ab1bc2a289d34bd04a330323ac98a1b4bc82c9d9fcb1e66b63caa84da26b575"
+
+[[package]]
+name = "os_pipe"
+version = "1.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a53dbb20faf34b16087a931834cba2d7a73cc74af2b7ef345a4c8324e2409a12"
+dependencies = [
+ "libc",
+ "windows-sys 0.45.0",
+]
+
+[[package]]
+name = "output_vt100"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "628223faebab4e3e40667ee0b2336d34a5b960ff60ea743ddfdbcf7770bcfb66"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "pest"
+version = "2.5.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "028accff104c4e513bad663bbcd2ad7cfd5304144404c31ed0a77ac103d00660"
+dependencies = [
+ "thiserror",
+ "ucd-trie",
+]
+
+[[package]]
+name = "pest_derive"
+version = "2.5.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2ac3922aac69a40733080f53c1ce7f91dcf57e1a5f6c52f421fadec7fbdc4b69"
+dependencies = [
+ "pest",
+ "pest_generator",
+]
+
+[[package]]
+name = "pest_generator"
+version = "2.5.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d06646e185566b5961b4058dd107e0a7f56e77c3f484549fb119867773c0f202"
+dependencies = [
+ "pest",
+ "pest_meta",
+ "proc-macro2",
+ "quote",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "pest_meta"
+version = "2.5.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6f60b2ba541577e2a0c307c8f39d1439108120eb7903adeb6497fa880c59616"
+dependencies = [
+ "once_cell",
+ "pest",
+ "sha2",
+]
+
+[[package]]
+name = "plotters"
+version = "0.3.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2538b639e642295546c50fcd545198c9d64ee2a38620a628724a3b266d5fbf97"
+dependencies = [
+ "num-traits",
+ "plotters-backend",
+ "plotters-svg",
+ "wasm-bindgen",
+ "web-sys",
+]
+
+[[package]]
+name = "plotters-backend"
+version = "0.3.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "193228616381fecdc1224c62e96946dfbc73ff4384fba576e052ff8c1bea8142"
+
+[[package]]
+name = "plotters-svg"
+version = "0.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f9a81d2759aae1dae668f783c308bc5c8ebd191ff4184aaa1b37f65a6ae5a56f"
+dependencies = [
+ "plotters-backend",
+]
+
+[[package]]
+name = "ppv-lite86"
+version = "0.2.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5b40af805b3121feab8a3c29f04d8ad262fa8e0561883e7653e024ae4479e6de"
+
+[[package]]
+name = "pretty_assertions"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a25e9bcb20aa780fd0bb16b72403a9064d6b3f22f026946029acb941a50af755"
+dependencies = [
+ "ctor",
+ "diff",
+ "output_vt100",
+ "yansi",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.63"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7b368fba921b0dce7e60f5e04ec15e565b3303972b42bcfde1d0713b881959eb"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "proptest"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4e35c06b98bf36aba164cc17cb25f7e232f5c4aeea73baa14b8a9f0d92dbfa65"
+dependencies = [
+ "bit-set",
+ "bitflags 1.3.2",
+ "byteorder",
+ "lazy_static",
+ "num-traits",
+ "rand",
+ "rand_chacha",
+ "rand_xorshift",
+ "regex-syntax 0.6.29",
+ "rusty-fork",
+ "tempfile",
+ "unarray",
+]
+
+[[package]]
+name = "quick-error"
+version = "1.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0"
+
+[[package]]
+name = "quick-xml"
+version = "0.23.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "11bafc859c6815fbaffbbbf4229ecb767ac913fecb27f9ad4343662e9ef099ea"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.28"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9ab9c7eadfd8df19006f1cf1a4aed13540ed5cbc047010ece5826e10825488"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "rand"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34af8d1a0e25924bc5b7c43c079c942339d8f0a8b57c39049bef581b46327404"
+dependencies = [
+ "libc",
+ "rand_chacha",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_chacha"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6c10a63a0fa32252be49d21e7709d4d4baf8d231c2dbce1eaa8141b9b127d88"
+dependencies = [
+ "ppv-lite86",
+ "rand_core",
+]
+
+[[package]]
+name = "rand_core"
+version = "0.6.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c"
+dependencies = [
+ "getrandom",
+]
+
+[[package]]
+name = "rand_xorshift"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d25bf25ec5ae4a3f1b92f929810509a2f53d7dca2f50b794ff57e3face536c8f"
+dependencies = [
+ "rand_core",
+]
+
+[[package]]
+name = "rayon"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d2df5196e37bcc87abebc0053e20787d73847bb33134a69841207dd0a47f03b"
+dependencies = [
+ "either",
+ "rayon-core",
+]
+
+[[package]]
+name = "rayon-core"
+version = "1.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4b8f95bd6966f5c87776639160a66bd8ab9895d9d4ab01ddba9fc60661aebe8d"
+dependencies = [
+ "crossbeam-channel",
+ "crossbeam-deque",
+ "crossbeam-utils",
+ "num_cpus",
+]
+
+[[package]]
+name = "redox_syscall"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "567664f262709473930a4bf9e51bf2ebf3348f2e748ccc50dea20646858f8f29"
+dependencies = [
+ "bitflags 1.3.2",
+]
+
+[[package]]
+name = "regex"
+version = "1.8.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d0ab3ca65655bb1e41f2a8c8cd662eb4fb035e67c3f78da1d61dffe89d07300f"
+dependencies = [
+ "regex-syntax 0.7.2",
+]
+
+[[package]]
+name = "regex-syntax"
+version = "0.6.29"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1"
+
+[[package]]
+name = "regex-syntax"
+version = "0.7.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "436b050e76ed2903236f032a59761c1eb99e1b0aead2c257922771dab1fc8c78"
+
+[[package]]
+name = "rustc-hash"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
+
+[[package]]
+name = "rustix"
+version = "0.37.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b96e891d04aa506a6d1f318d2771bcb1c7dfda84e126660ace067c9b474bb2c0"
+dependencies = [
+ "bitflags 1.3.2",
+ "errno",
+ "io-lifetimes",
+ "libc",
+ "linux-raw-sys 0.3.8",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "rustix"
+version = "0.38.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1ee020b1716f0a80e2ace9b03441a749e402e86712f15f16fe8a8f75afac732f"
+dependencies = [
+ "bitflags 2.3.3",
+ "errno",
+ "libc",
+ "linux-raw-sys 0.4.5",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "rusty-fork"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cb3dcc6e454c328bb824492db107ab7c0ae8fcffe4ad210136ef014458c1bc4f"
+dependencies = [
+ "fnv",
+ "quick-error",
+ "tempfile",
+ "wait-timeout",
+]
+
+[[package]]
+name = "ryu"
+version = "1.0.13"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f91339c0467de62360649f8d3e185ca8de4224ff281f66000de5eb2a77a79041"
+
+[[package]]
+name = "same-file"
+version = "1.0.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "93fc1dc3aaa9bfed95e02e6eadabb4baf7e3078b0bd1b4d7b6b0b68378900502"
+dependencies = [
+ "winapi-util",
+]
+
+[[package]]
+name = "scopeguard"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
+
+[[package]]
+name = "serde"
+version = "1.0.164"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9e8c8cf938e98f769bc164923b06dce91cea1751522f46f8466461af04c9027d"
+dependencies = [
+ "serde_derive",
+]
+
+[[package]]
+name = "serde_derive"
+version = "1.0.164"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d9735b638ccc51c28bf6914d90a2e9725b377144fc612c49a611fddd1b631d68"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.22",
+]
+
+[[package]]
+name = "serde_json"
+version = "1.0.99"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "46266871c240a00b8f503b877622fe33430b3c7d963bdc0f2adc511e54a1eae3"
+dependencies = [
+ "itoa",
+ "ryu",
+ "serde",
+]
+
+[[package]]
+name = "sha2"
+version = "0.10.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "82e6b795fe2e3b1e845bafcb27aa35405c4d47cdfc92af5fc8d3002f76cebdc0"
+dependencies = [
+ "cfg-if",
+ "cpufeatures",
+ "digest",
+]
+
+[[package]]
+name = "similar"
+version = "2.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "420acb44afdae038210c99e69aae24109f32f15500aa708e81d46c9f29d55fcf"
+
+[[package]]
+name = "snapbox"
+version = "0.4.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f6bccd62078347f89a914e3004d94582e13824d4e3d8a816317862884c423835"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "escargot",
+ "normalize-line-endings",
+ "similar",
+ "snapbox-macros",
+]
+
+[[package]]
+name = "snapbox-macros"
+version = "0.3.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eaaf09df9f0eeae82be96290918520214530e738a7fe5a351b0f24cf77c0ca31"
+dependencies = [
+ "anstream",
+]
+
+[[package]]
+name = "syn"
+version = "1.0.109"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2efbeae7acf4eabd6bcdcbd11c92f45231ddda7539edc7806bd1a04a03b24616"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "tempfile"
+version = "3.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "31c0432476357e58790aaa47a8efb0c5138f137343f3b5f23bd36a27e3b0a6d6"
+dependencies = [
+ "autocfg",
+ "cfg-if",
+ "fastrand",
+ "redox_syscall",
+ "rustix 0.37.20",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "term-transcript"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6d77280c9041d978e4ffedbdd19f710a1360085510c5e99dbcfec8e2f2bd4285"
+dependencies = [
+ "atty",
+ "bytecount",
+ "handlebars",
+ "os_pipe",
+ "pretty_assertions",
+ "quick-xml",
+ "serde",
+ "termcolor",
+ "unicode-width",
+]
+
+[[package]]
+name = "termcolor"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be55cf8942feac5c765c2c993422806843c9a9a45d4d5c407ad6dd2ea95eb9b6"
+dependencies = [
+ "winapi-util",
+]
+
+[[package]]
+name = "terminal_size"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e6bf6f19e9f8ed8d4048dc22981458ebcf406d67e94cd422e5ecd73d63b3237"
+dependencies = [
+ "rustix 0.37.20",
+ "windows-sys 0.48.0",
+]
+
+[[package]]
+name = "thiserror"
+version = "1.0.38"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a9cd18aa97d5c45c6603caea1da6628790b37f7a34b6ca89522331c5180fed0"
+dependencies = [
+ "thiserror-impl",
+]
+
+[[package]]
+name = "thiserror-impl"
+version = "1.0.38"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1fb327af4685e4d03fa8cbcf1716380da910eeb2bb8be417e7f9fd3fb164f36f"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 1.0.109",
+]
+
+[[package]]
+name = "tinytemplate"
+version = "1.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "be4d6b5f19ff7664e8c98d03e2139cb510db9b0a60b55f8e8709b689d939b6bc"
+dependencies = [
+ "serde",
+ "serde_json",
+]
+
+[[package]]
+name = "typenum"
+version = "1.16.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "497961ef93d974e23eb6f433eb5fe1b7930b659f06d12dec6fc44a8f554c0bba"
+
+[[package]]
+name = "ucd-trie"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9e79c4d996edb816c91e4308506774452e55e95c3c9de07b6729e17e15a5ef81"
+
+[[package]]
+name = "unarray"
+version = "0.1.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "eaea85b334db583fe3274d12b4cd1880032beab409c0d774be044d4480ab9a94"
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b15811caf2415fb889178633e7724bad2509101cde276048e013b9def5e51fa0"
+
+[[package]]
+name = "unicode-width"
+version = "0.1.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c0edd1e5b14653f783770bce4a4dabb4a5108a5370a5f5d8cfe8710c361f6c8b"
+
+[[package]]
+name = "utf8parse"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a"
+
+[[package]]
+name = "version_check"
+version = "0.9.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "49874b5167b65d7193b8aba1567f5c7d93d001cafc34600cee003eda787e483f"
+
+[[package]]
+name = "wait-timeout"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9f200f5b12eb75f8c1ed65abd4b2db8a6e1b138a20de009dacee265a2498f3f6"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "walkdir"
+version = "2.3.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "36df944cda56c7d8d8b7496af378e6b16de9284591917d307c9b4d313c44e698"
+dependencies = [
+ "same-file",
+ "winapi-util",
+]
+
+[[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
+[[package]]
+name = "wasm-bindgen"
+version = "0.2.87"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7706a72ab36d8cb1f80ffbf0e071533974a60d0a308d01a5d0375bf60499a342"
+dependencies = [
+ "cfg-if",
+ "wasm-bindgen-macro",
+]
+
+[[package]]
+name = "wasm-bindgen-backend"
+version = "0.2.87"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5ef2b6d3c510e9625e5fe6f509ab07d66a760f0885d858736483c32ed7809abd"
+dependencies = [
+ "bumpalo",
+ "log",
+ "once_cell",
+ "proc-macro2",
+ "quote",
+ "syn 2.0.22",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-macro"
+version = "0.2.87"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dee495e55982a3bd48105a7b947fd2a9b4a8ae3010041b9e0faab3f9cd028f1d"
+dependencies = [
+ "quote",
+ "wasm-bindgen-macro-support",
+]
+
+[[package]]
+name = "wasm-bindgen-macro-support"
+version = "0.2.87"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "54681b18a46765f095758388f2d0cf16eb8d4169b639ab575a8f5693af210c7b"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.22",
+ "wasm-bindgen-backend",
+ "wasm-bindgen-shared",
+]
+
+[[package]]
+name = "wasm-bindgen-shared"
+version = "0.2.87"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca6ad05a4870b2bf5fe995117d3728437bd27d7cd5f06f13c17443ef369775a1"
+
+[[package]]
+name = "web-sys"
+version = "0.3.64"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9b85cbef8c220a6abc02aefd892dfc0fc23afb1c6a426316ec33253a3877249b"
+dependencies = [
+ "js-sys",
+ "wasm-bindgen",
+]
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-util"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "70ec6ce85bb158151cae5e5c87f95a8e97d2c0c4b001223f33a334e3ce5de178"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
+name = "windows-sys"
+version = "0.45.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0"
+dependencies = [
+ "windows-targets 0.42.2",
+]
+
+[[package]]
+name = "windows-sys"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
+dependencies = [
+ "windows-targets 0.48.1",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e5180c00cd44c9b1c88adb3693291f1cd93605ded80c250a75d472756b4d071"
+dependencies = [
+ "windows_aarch64_gnullvm 0.42.2",
+ "windows_aarch64_msvc 0.42.2",
+ "windows_i686_gnu 0.42.2",
+ "windows_i686_msvc 0.42.2",
+ "windows_x86_64_gnu 0.42.2",
+ "windows_x86_64_gnullvm 0.42.2",
+ "windows_x86_64_msvc 0.42.2",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.48.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "05d4b17490f70499f20b9e791dcf6a299785ce8af4d709018206dc5b4953e95f"
+dependencies = [
+ "windows_aarch64_gnullvm 0.48.0",
+ "windows_aarch64_msvc 0.48.0",
+ "windows_i686_gnu 0.48.0",
+ "windows_i686_msvc 0.48.0",
+ "windows_x86_64_gnu 0.48.0",
+ "windows_x86_64_gnullvm 0.48.0",
+ "windows_x86_64_msvc 0.48.0",
+]
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "597a5118570b68bc08d8d59125332c54f1ba9d9adeedeef5b99b02ba2b0698f8"
+
+[[package]]
+name = "windows_aarch64_gnullvm"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "91ae572e1b79dba883e0d315474df7305d12f569b400fcf90581b06062f7e1bc"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e08e8864a60f06ef0d0ff4ba04124db8b0fb3be5776a5cd47641e942e58c4d43"
+
+[[package]]
+name = "windows_aarch64_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b2ef27e0d7bdfcfc7b868b317c1d32c641a6fe4629c171b8928c7b08d98d7cf3"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c61d927d8da41da96a81f029489353e68739737d3beca43145c8afec9a31a84f"
+
+[[package]]
+name = "windows_i686_gnu"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "622a1962a7db830d6fd0a69683c80a18fda201879f0f447f065a3b7467daa241"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "44d840b6ec649f480a41c8d80f9c65108b92d89345dd94027bfe06ac444d1060"
+
+[[package]]
+name = "windows_i686_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4542c6e364ce21bf45d69fdd2a8e455fa38d316158cfd43b3ac1c5b1b19f8e00"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8de912b8b8feb55c064867cf047dda097f92d51efad5b491dfb98f6bbb70cb36"
+
+[[package]]
+name = "windows_x86_64_gnu"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ca2b8a661f7628cbd23440e50b05d705db3686f894fc9580820623656af974b1"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "26d41b46a36d453748aedef1486d5c7a85db22e56aff34643984ea85514e94a3"
+
+[[package]]
+name = "windows_x86_64_gnullvm"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7896dbc1f41e08872e9d5e8f8baa8fdd2677f29468c4e156210174edc7f7b953"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.42.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9aec5da331524158c6d1a4ac0ab1541149c0b9505fde06423b02f5ef0106b9f0"
+
+[[package]]
+name = "windows_x86_64_msvc"
+version = "0.48.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1a515f5799fe4961cb532f983ce2b23082366b898e52ffbce459c86f67c8378a"
+
+[[package]]
+name = "winnow"
+version = "0.5.37"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "circular",
+ "criterion",
+ "doc-comment",
+ "escargot",
+ "is-terminal",
+ "lexopt",
+ "memchr",
+ "proptest",
+ "rustc-hash",
+ "snapbox",
+ "term-transcript",
+ "terminal_size",
+]
+
+[[package]]
+name = "yansi"
+version = "0.5.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec"
diff --git a/crates/winnow/Cargo.toml b/crates/winnow/Cargo.toml
new file mode 100644
index 0000000..61cf661
--- /dev/null
+++ b/crates/winnow/Cargo.toml
@@ -0,0 +1,260 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.64.0"
+name = "winnow"
+version = "0.5.37"
+include = [
+ "build.rs",
+ "src/**/*",
+ "Cargo.toml",
+ "Cargo.lock",
+ "LICENSE*",
+ "README.md",
+ "benches/**/*",
+ "examples/**/*",
+]
+autoexamples = false
+description = "A byte-oriented, zero-copy, parser combinators library"
+readme = "README.md"
+keywords = [
+ "parser",
+ "parser-combinators",
+ "parsing",
+ "streaming",
+ "bit",
+]
+categories = ["parsing"]
+license = "MIT"
+repository = "https://github.com/winnow-rs/winnow"
+
+[package.metadata.docs.rs]
+cargo-args = [
+ "-Zunstable-options",
+ "-Zrustdoc-scrape-examples",
+]
+features = ["unstable-doc"]
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+]
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+min = 1
+replace = "{{version}}"
+search = "Unreleased"
+
+[[package.metadata.release.pre-release-replacements]]
+exactly = 1
+file = "CHANGELOG.md"
+replace = "...{{tag_name}}"
+search = '\.\.\.HEAD'
+
+[[package.metadata.release.pre-release-replacements]]
+file = "CHANGELOG.md"
+min = 1
+replace = "{{date}}"
+search = "ReleaseDate"
+
+[[package.metadata.release.pre-release-replacements]]
+exactly = 1
+file = "CHANGELOG.md"
+replace = """
+<!-- next-header -->
+## [Unreleased] - ReleaseDate
+"""
+search = "<!-- next-header -->"
+
+[[package.metadata.release.pre-release-replacements]]
+exactly = 1
+file = "CHANGELOG.md"
+replace = """
+<!-- next-url -->
+[Unreleased]: https://github.com/winnow-rs/winnow/compare/{{tag_name}}...HEAD"""
+search = "<!-- next-url -->"
+
+[[package.metadata.release.pre-release-replacements]]
+exactly = 1
+file = "src/lib.rs"
+replace = "blob/v{{version}}/CHANGELOG.md"
+search = 'blob/v.+\..+\..+/CHANGELOG.md'
+
+[profile.bench]
+lto = true
+codegen-units = 1
+debug = 2
+
+[[example]]
+name = "arithmetic"
+test = true
+required-features = ["alloc"]
+
+[[example]]
+name = "css"
+test = true
+required-features = ["alloc"]
+
+[[example]]
+name = "custom_error"
+test = true
+required-features = ["alloc"]
+
+[[example]]
+name = "http"
+required-features = ["alloc"]
+
+[[example]]
+name = "ini"
+test = true
+required-features = ["std"]
+
+[[example]]
+name = "json"
+test = true
+required-features = ["std"]
+
+[[example]]
+name = "ndjson"
+test = true
+required-features = ["std"]
+
+[[example]]
+name = "json_iterator"
+required-features = ["std"]
+
+[[example]]
+name = "iterator"
+
+[[example]]
+name = "s_expression"
+required-features = ["alloc"]
+
+[[example]]
+name = "string"
+required-features = ["alloc"]
+
+[[bench]]
+name = "arithmetic"
+path = "examples/arithmetic/bench.rs"
+harness = false
+required-features = ["alloc"]
+
+[[bench]]
+name = "contains_token"
+harness = false
+
+[[bench]]
+name = "find_slice"
+harness = false
+
+[[bench]]
+name = "iter"
+harness = false
+
+[[bench]]
+name = "next_slice"
+harness = false
+
+[[bench]]
+name = "number"
+harness = false
+
+[[bench]]
+name = "http"
+path = "examples/http/bench.rs"
+harness = false
+required-features = ["alloc"]
+
+[[bench]]
+name = "ini"
+path = "examples/ini/bench.rs"
+harness = false
+required-features = ["std"]
+
+[[bench]]
+name = "json"
+path = "examples/json/bench.rs"
+harness = false
+required-features = ["std"]
+
+[dependencies.anstream]
+version = "0.3.2"
+optional = true
+
+[dependencies.anstyle]
+version = "1.0.1"
+optional = true
+
+[dependencies.is-terminal]
+version = "0.4.9"
+optional = true
+
+[dependencies.memchr]
+version = "2.5"
+optional = true
+default-features = false
+
+[dependencies.terminal_size]
+version = "0.2.6"
+optional = true
+
+[dev-dependencies.circular]
+version = "0.3.0"
+
+[dev-dependencies.criterion]
+version = "0.5.1"
+
+[dev-dependencies.doc-comment]
+version = "0.3"
+
+[dev-dependencies.escargot]
+version = "0.5.7"
+
+[dev-dependencies.lexopt]
+version = "0.3.0"
+
+[dev-dependencies.proptest]
+version = "1.2.0"
+
+[dev-dependencies.rustc-hash]
+version = "1.1.0"
+
+[dev-dependencies.snapbox]
+version = "0.4.11"
+features = ["examples"]
+
+[dev-dependencies.term-transcript]
+version = "0.2.0"
+
+[features]
+alloc = []
+debug = [
+ "dep:anstream",
+ "dep:anstyle",
+ "dep:is-terminal",
+ "dep:terminal_size",
+]
+default = ["std"]
+simd = ["dep:memchr"]
+std = [
+ "alloc",
+ "memchr?/std",
+]
+unstable-doc = [
+ "alloc",
+ "std",
+ "simd",
+ "unstable-recover",
+]
+unstable-recover = []
diff --git a/crates/winnow/LICENSE b/crates/winnow/LICENSE
new file mode 120000
index 0000000..7f9a88e
--- /dev/null
+++ b/crates/winnow/LICENSE
@@ -0,0 +1 @@
+LICENSE-MIT
\ No newline at end of file
diff --git a/crates/winnow/LICENSE-MIT b/crates/winnow/LICENSE-MIT
new file mode 100644
index 0000000..c9b44cb
--- /dev/null
+++ b/crates/winnow/LICENSE-MIT
@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/crates/winnow/METADATA b/crates/winnow/METADATA
new file mode 100644
index 0000000..9a3e52d
--- /dev/null
+++ b/crates/winnow/METADATA
@@ -0,0 +1,24 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update external/rust/crates/winnow
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "winnow"
+description: "A byte-oriented, zero-copy, parser combinators library"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2024
+ month: 2
+ day: 6
+ }
+ identifier {
+ type: "crates.io"
+ value: "https://static.crates.io/crates/winnow/winnow-0.5.37.crate"
+ version: "0.5.14"
+ }
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/winnow/winnow-0.5.14.crate"
+ version: "0.5.37"
+ }
+}
diff --git a/crates/winnow/MODULE_LICENSE_MIT b/crates/winnow/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/winnow/MODULE_LICENSE_MIT
diff --git a/crates/winnow/README.md b/crates/winnow/README.md
new file mode 100644
index 0000000..5530657
--- /dev/null
+++ b/crates/winnow/README.md
@@ -0,0 +1,27 @@
+# winnow, making parsing a breeze
+
+[](LICENSE)
+[](https://github.com/winnow-rs/winnow/actions/workflows/ci.yml)
+[](https://coveralls.io/github/winnow-rs/winnow?branch=main)
+[](https://crates.io/crates/winnow)
+
+## About
+
+Build up a parser for your format of choice with the building blocks provided by `winnow`.
+
+For more details, see:
+- [Tutorial](https://docs.rs/winnow/latest/winnow/_tutorial/index.html)
+- [Special Topics](https://docs.rs/winnow/latest/winnow/_topic/index.html)
+ - [Why winnow? How does it compare to ...?](https://docs.rs/winnow/latest/winnow/_topic/why/index.html)
+- [API Reference](https://docs.rs/winnow)
+- [List of combinators](https://docs.rs/winnow/latest/winnow/combinator/index.html)
+
+# Contributors
+
+winnow is the fruit of the work of many contributors over the years, many
+thanks for your help! In particular, thanks to [Geal](https://github.com/Geal)
+for the original [`nom` crate](https://crates.io/crates/nom).
+
+<a href="https://github.com/winnow-rs/winnow/graphs/contributors">
+ <img src="https://contributors-img.web.app/image?repo=winnow-rs/winnow" />
+</a>
diff --git a/crates/winnow/benches/contains_token.rs b/crates/winnow/benches/contains_token.rs
new file mode 100644
index 0000000..675b08e
--- /dev/null
+++ b/crates/winnow/benches/contains_token.rs
@@ -0,0 +1,114 @@
+use criterion::black_box;
+
+use winnow::combinator::alt;
+use winnow::combinator::repeat;
+use winnow::prelude::*;
+use winnow::token::take_till;
+use winnow::token::take_while;
+
+fn contains_token(c: &mut criterion::Criterion) {
+ let data = [
+ ("contiguous", CONTIGUOUS),
+ ("interleaved", INTERLEAVED),
+ ("canada", CANADA),
+ ];
+ let mut group = c.benchmark_group("contains_token");
+ for (name, sample) in data {
+ let len = sample.len();
+ group.throughput(criterion::Throughput::Bytes(len as u64));
+
+ group.bench_with_input(criterion::BenchmarkId::new("slice", name), &len, |b, _| {
+ b.iter(|| black_box(parser_slice.parse_peek(black_box(sample)).unwrap()));
+ });
+ group.bench_with_input(criterion::BenchmarkId::new("array", name), &len, |b, _| {
+ b.iter(|| black_box(parser_array.parse_peek(black_box(sample)).unwrap()));
+ });
+ group.bench_with_input(criterion::BenchmarkId::new("tuple", name), &len, |b, _| {
+ b.iter(|| black_box(parser_tuple.parse_peek(black_box(sample)).unwrap()));
+ });
+ group.bench_with_input(
+ criterion::BenchmarkId::new("closure-or", name),
+ &len,
+ |b, _| {
+ b.iter(|| black_box(parser_closure_or.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("closure-matches", name),
+ &len,
+ |b, _| {
+ b.iter(|| {
+ black_box(
+ parser_closure_matches
+ .parse_peek(black_box(sample))
+ .unwrap(),
+ )
+ });
+ },
+ );
+ }
+ group.finish();
+}
+
+fn parser_slice(input: &mut &str) -> PResult<usize> {
+ let contains = &['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'][..];
+ repeat(
+ 0..,
+ alt((take_while(1.., contains), take_till(1.., contains))),
+ )
+ .parse_next(input)
+}
+
+fn parser_array(input: &mut &str) -> PResult<usize> {
+ let contains = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9'];
+ repeat(
+ 0..,
+ alt((take_while(1.., contains), take_till(1.., contains))),
+ )
+ .parse_next(input)
+}
+
+fn parser_tuple(input: &mut &str) -> PResult<usize> {
+ let contains = ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9');
+ repeat(
+ 0..,
+ alt((take_while(1.., contains), take_till(1.., contains))),
+ )
+ .parse_next(input)
+}
+
+fn parser_closure_or(input: &mut &str) -> PResult<usize> {
+ let contains = |c: char| {
+ c == '0'
+ || c == '1'
+ || c == '2'
+ || c == '3'
+ || c == '4'
+ || c == '5'
+ || c == '6'
+ || c == '7'
+ || c == '8'
+ || c == '9'
+ };
+ repeat(
+ 0..,
+ alt((take_while(1.., contains), take_till(1.., contains))),
+ )
+ .parse_next(input)
+}
+
+fn parser_closure_matches(input: &mut &str) -> PResult<usize> {
+ let contains = |c: char| matches!(c, '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9');
+ repeat(
+ 0..,
+ alt((take_while(1.., contains), take_till(1.., contains))),
+ )
+ .parse_next(input)
+}
+
+const CONTIGUOUS: &str = "012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789";
+const INTERLEAVED: &str = "0123456789abc0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab";
+const CANADA: &str = include_str!("../third_party/nativejson-benchmark/data/canada.json");
+
+criterion::criterion_group!(benches, contains_token);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/benches/find_slice.rs b/crates/winnow/benches/find_slice.rs
new file mode 100644
index 0000000..656c989
--- /dev/null
+++ b/crates/winnow/benches/find_slice.rs
@@ -0,0 +1,50 @@
+use criterion::black_box;
+
+use winnow::combinator::repeat;
+use winnow::prelude::*;
+use winnow::token::take_until;
+
+fn find_slice(c: &mut criterion::Criterion) {
+ let empty = "";
+ let start_byte = "\r".repeat(100);
+ let start_slice = "\r\n".repeat(100);
+ let small = format!("{:>10}\r\n", "").repeat(100);
+ let large = format!("{:>10000}\r\n", "").repeat(100);
+
+ let data = [
+ ("empty", (empty, empty)),
+ ("start", (&start_byte, &start_slice)),
+ ("medium", (&small, &small)),
+ ("large", (&large, &large)),
+ ];
+ let mut group = c.benchmark_group("find_slice");
+ for (name, samples) in data {
+ group.bench_with_input(
+ criterion::BenchmarkId::new("byte", name),
+ samples.0,
+ |b, sample| {
+ b.iter(|| black_box(parser_byte.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+
+ group.bench_with_input(
+ criterion::BenchmarkId::new("slice", name),
+ samples.1,
+ |b, sample| {
+ b.iter(|| black_box(parser_slice.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ }
+ group.finish();
+}
+
+fn parser_byte(input: &mut &str) -> PResult<usize> {
+ repeat(0.., (take_until(0.., "\r"), "\r")).parse_next(input)
+}
+
+fn parser_slice(input: &mut &str) -> PResult<usize> {
+ repeat(0.., (take_until(0.., "\r\n"), "\r\n")).parse_next(input)
+}
+
+criterion::criterion_group!(benches, find_slice);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/benches/iter.rs b/crates/winnow/benches/iter.rs
new file mode 100644
index 0000000..0a0d5ff
--- /dev/null
+++ b/crates/winnow/benches/iter.rs
@@ -0,0 +1,120 @@
+use criterion::black_box;
+
+use winnow::combinator::opt;
+use winnow::prelude::*;
+use winnow::stream::AsChar;
+use winnow::stream::Stream as _;
+use winnow::token::one_of;
+
+fn iter(c: &mut criterion::Criterion) {
+ let data = [
+ ("contiguous", CONTIGUOUS.as_bytes()),
+ ("interleaved", INTERLEAVED.as_bytes()),
+ ("canada", CANADA.as_bytes()),
+ ];
+ let mut group = c.benchmark_group("iter");
+ for (name, sample) in data {
+ let len = sample.len();
+ group.throughput(criterion::Throughput::Bytes(len as u64));
+
+ group.bench_with_input(
+ criterion::BenchmarkId::new("iterate", name),
+ &len,
+ |b, _| {
+ b.iter(|| black_box(iterate.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("next_token", name),
+ &len,
+ |b, _| {
+ b.iter(|| black_box(next_token.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("opt(one_of)", name),
+ &len,
+ |b, _| {
+ b.iter(|| black_box(opt_one_of.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("take_while", name),
+ &len,
+ |b, _| {
+ b.iter(|| black_box(take_while.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(criterion::BenchmarkId::new("repeat", name), &len, |b, _| {
+ b.iter(|| black_box(repeat.parse_peek(black_box(sample)).unwrap()));
+ });
+ }
+ group.finish();
+}
+
+fn iterate(input: &mut &[u8]) -> PResult<usize> {
+ let mut count = 0;
+ for byte in input.iter() {
+ if byte.is_dec_digit() {
+ count += 1;
+ }
+ }
+ input.finish();
+ Ok(count)
+}
+
+fn next_token(input: &mut &[u8]) -> PResult<usize> {
+ let mut count = 0;
+ while let Some(byte) = input.next_token() {
+ if byte.is_dec_digit() {
+ count += 1;
+ }
+ }
+ Ok(count)
+}
+
+fn opt_one_of(input: &mut &[u8]) -> PResult<usize> {
+ let mut count = 0;
+ while !input.is_empty() {
+ while opt(one_of(AsChar::is_dec_digit))
+ .parse_next(input)?
+ .is_some()
+ {
+ count += 1;
+ }
+ while opt(one_of(|b: u8| !b.is_dec_digit()))
+ .parse_next(input)?
+ .is_some()
+ {}
+ }
+ Ok(count)
+}
+
+fn take_while(input: &mut &[u8]) -> PResult<usize> {
+ let mut count = 0;
+ while !input.is_empty() {
+ count += winnow::token::take_while(0.., AsChar::is_dec_digit)
+ .parse_next(input)?
+ .len();
+ let _ = winnow::token::take_while(0.., |b: u8| !b.is_dec_digit()).parse_next(input)?;
+ }
+ Ok(count)
+}
+
+fn repeat(input: &mut &[u8]) -> PResult<usize> {
+ let mut count = 0;
+ while !input.is_empty() {
+ count += winnow::combinator::repeat(0.., one_of(AsChar::is_dec_digit))
+ .map(|count: usize| count)
+ .parse_next(input)?;
+ winnow::combinator::repeat(0.., one_of(|b: u8| !b.is_dec_digit())).parse_next(input)?;
+ }
+ Ok(count)
+}
+
+const CONTIGUOUS: &str = "012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789";
+const INTERLEAVED: &str = "0123456789abc0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab0123456789ab";
+const CANADA: &str = include_str!("../third_party/nativejson-benchmark/data/canada.json");
+
+criterion::criterion_group!(benches, iter);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/benches/next_slice.rs b/crates/winnow/benches/next_slice.rs
new file mode 100644
index 0000000..6c25d23
--- /dev/null
+++ b/crates/winnow/benches/next_slice.rs
@@ -0,0 +1,133 @@
+use criterion::black_box;
+
+use winnow::combinator::repeat;
+use winnow::prelude::*;
+use winnow::token::one_of;
+use winnow::token::tag;
+
+fn next_slice(c: &mut criterion::Criterion) {
+ let mut group = c.benchmark_group("next_slice");
+
+ let name = "ascii";
+ let sample = "h".repeat(100);
+ let sample = sample.as_str();
+ group.bench_with_input(
+ criterion::BenchmarkId::new("char", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_ascii_char.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("str", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_ascii_str.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("one_of", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_ascii_one_of.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("tag_char", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_ascii_tag_char.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("tag_str", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_ascii_tag_str.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+
+ let name = "utf8";
+ let sample = "🧑".repeat(100);
+ let sample = sample.as_str();
+ group.bench_with_input(
+ criterion::BenchmarkId::new("char", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_utf8_char.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("str", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_utf8_str.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("one_of", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_utf8_one_of.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("tag_char", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_utf8_tag_char.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("tag_str", name),
+ sample,
+ |b, sample| {
+ b.iter(|| black_box(parser_utf8_tag_str.parse_peek(black_box(sample)).unwrap()));
+ },
+ );
+
+ group.finish();
+}
+
+fn parser_ascii_char(input: &mut &str) -> PResult<usize> {
+ repeat(0.., 'h').parse_next(input)
+}
+
+fn parser_ascii_str(input: &mut &str) -> PResult<usize> {
+ repeat(0.., "h").parse_next(input)
+}
+
+fn parser_ascii_one_of(input: &mut &str) -> PResult<usize> {
+ repeat(0.., one_of('h')).parse_next(input)
+}
+
+fn parser_ascii_tag_char(input: &mut &str) -> PResult<usize> {
+ repeat(0.., tag('h')).parse_next(input)
+}
+
+fn parser_ascii_tag_str(input: &mut &str) -> PResult<usize> {
+ repeat(0.., tag("h")).parse_next(input)
+}
+
+fn parser_utf8_char(input: &mut &str) -> PResult<usize> {
+ repeat(0.., '🧑').parse_next(input)
+}
+
+fn parser_utf8_str(input: &mut &str) -> PResult<usize> {
+ repeat(0.., "🧑").parse_next(input)
+}
+
+fn parser_utf8_one_of(input: &mut &str) -> PResult<usize> {
+ repeat(0.., one_of('🧑')).parse_next(input)
+}
+
+fn parser_utf8_tag_char(input: &mut &str) -> PResult<usize> {
+ repeat(0.., tag('🧑')).parse_next(input)
+}
+
+fn parser_utf8_tag_str(input: &mut &str) -> PResult<usize> {
+ repeat(0.., tag("🧑")).parse_next(input)
+}
+
+criterion::criterion_group!(benches, next_slice);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/benches/number.rs b/crates/winnow/benches/number.rs
new file mode 100644
index 0000000..d35d65c
--- /dev/null
+++ b/crates/winnow/benches/number.rs
@@ -0,0 +1,70 @@
+#[macro_use]
+extern crate criterion;
+
+use criterion::Criterion;
+
+use winnow::ascii::float;
+use winnow::binary::be_u64;
+use winnow::error::ErrMode;
+use winnow::error::ErrorKind;
+use winnow::error::InputError;
+use winnow::error::ParserError;
+use winnow::prelude::*;
+use winnow::stream::ParseSlice;
+
+type Stream<'i> = &'i [u8];
+
+fn parser(i: &mut Stream<'_>) -> PResult<u64> {
+ be_u64.parse_next(i)
+}
+
+fn number(c: &mut Criterion) {
+ let data = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12];
+
+ parser
+ .parse_peek(&data[..])
+ .expect("should parse correctly");
+ c.bench_function("number", move |b| {
+ b.iter(|| parser.parse_peek(&data[..]).unwrap());
+ });
+}
+
+fn float_bytes(c: &mut Criterion) {
+ println!(
+ "float_bytes result: {:?}",
+ float::<_, f64, InputError<_>>.parse_peek(&b"-1.234E-12"[..])
+ );
+ c.bench_function("float bytes", |b| {
+ b.iter(|| float::<_, f64, InputError<_>>.parse_peek(&b"-1.234E-12"[..]));
+ });
+}
+
+fn float_str(c: &mut Criterion) {
+ println!(
+ "float_str result: {:?}",
+ float::<_, f64, InputError<_>>.parse_peek("-1.234E-12")
+ );
+ c.bench_function("float str", |b| {
+ b.iter(|| float::<_, f64, InputError<_>>.parse_peek("-1.234E-12"));
+ });
+}
+
+fn std_float(input: &mut &[u8]) -> PResult<f64> {
+ match input.parse_slice() {
+ Some(n) => Ok(n),
+ None => Err(ErrMode::from_error_kind(input, ErrorKind::Slice)),
+ }
+}
+
+fn std_float_bytes(c: &mut Criterion) {
+ println!(
+ "std_float_bytes result: {:?}",
+ std_float.parse_peek(&b"-1.234E-12"[..])
+ );
+ c.bench_function("std_float bytes", |b| {
+ b.iter(|| std_float.parse_peek(&b"-1.234E-12"[..]));
+ });
+}
+
+criterion_group!(benches, number, float_bytes, std_float_bytes, float_str);
+criterion_main!(benches);
diff --git a/crates/winnow/cargo_embargo.json b/crates/winnow/cargo_embargo.json
new file mode 100644
index 0000000..fdcc304
--- /dev/null
+++ b/crates/winnow/cargo_embargo.json
@@ -0,0 +1,8 @@
+{
+ "package": {
+ "winnow": {
+ "device_supported": false
+ }
+ },
+ "run_cargo": false
+}
diff --git a/crates/winnow/examples/arithmetic/bench.rs b/crates/winnow/examples/arithmetic/bench.rs
new file mode 100644
index 0000000..692ac22
--- /dev/null
+++ b/crates/winnow/examples/arithmetic/bench.rs
@@ -0,0 +1,33 @@
+mod parser;
+mod parser_ast;
+mod parser_lexer;
+
+use winnow::prelude::*;
+
+#[allow(clippy::eq_op, clippy::erasing_op)]
+fn arithmetic(c: &mut criterion::Criterion) {
+ let data = " 2*2 / ( 5 - 1) + 3 / 4 * (2 - 7 + 567 *12 /2) + 3*(1+2*( 45 /2))";
+ let expected = 2 * 2 / (5 - 1) + 3 * (1 + 2 * (45 / 2));
+
+ assert_eq!(parser::expr.parse(data), Ok(expected));
+ assert_eq!(
+ parser_ast::expr.parse(data).map(|ast| ast.eval()),
+ Ok(expected)
+ );
+ assert_eq!(
+ parser_lexer::expr2.parse(data).map(|ast| ast.eval()),
+ Ok(expected)
+ );
+ c.bench_function("direct", |b| {
+ b.iter(|| parser::expr.parse(data).unwrap());
+ });
+ c.bench_function("ast", |b| {
+ b.iter(|| parser_ast::expr.parse(data).unwrap().eval());
+ });
+ c.bench_function("lexer", |b| {
+ b.iter(|| parser_lexer::expr2.parse_peek(data).unwrap());
+ });
+}
+
+criterion::criterion_group!(benches, arithmetic);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/examples/arithmetic/main.rs b/crates/winnow/examples/arithmetic/main.rs
new file mode 100644
index 0000000..e46cf2f
--- /dev/null
+++ b/crates/winnow/examples/arithmetic/main.rs
@@ -0,0 +1,86 @@
+use winnow::prelude::*;
+
+mod parser;
+mod parser_ast;
+mod parser_lexer;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let input = args.input.as_deref().unwrap_or("1 + 1");
+ if let Err(err) = calc(input, args.implementation) {
+ println!("FAILED");
+ println!("{}", err);
+ }
+
+ Ok(())
+}
+
+fn calc(
+ input: &str,
+ imp: Impl,
+) -> Result<(), winnow::error::ParseError<&str, winnow::error::ContextError>> {
+ println!("{} =", input);
+ match imp {
+ Impl::Eval => {
+ let result = parser::expr.parse(input)?;
+ println!(" {}", result);
+ }
+ Impl::Ast => {
+ let result = parser_ast::expr.parse(input)?;
+ println!(" {:#?}={}", result, result.eval());
+ }
+ Impl::Lexer => {
+ let tokens = parser_lexer::lex.parse(input)?;
+ println!(" {:#?}", tokens);
+ let result = parser_lexer::expr.parse(tokens.as_slice()).unwrap();
+ println!(" {:#?}={}", result, result.eval());
+ }
+ }
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+ implementation: Impl,
+}
+
+enum Impl {
+ Eval,
+ Ast,
+ Lexer,
+}
+
+impl Default for Impl {
+ fn default() -> Self {
+ Self::Eval
+ }
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Long("impl") => {
+ res.implementation = args.value()?.parse_with(|s| match s {
+ "eval" => Ok(Impl::Eval),
+ "ast" => Ok(Impl::Ast),
+ "lexer" => Ok(Impl::Lexer),
+ _ => Err("expected `eval`, `ast`"),
+ })?;
+ }
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
diff --git a/crates/winnow/examples/arithmetic/parser.rs b/crates/winnow/examples/arithmetic/parser.rs
new file mode 100644
index 0000000..d51007a
--- /dev/null
+++ b/crates/winnow/examples/arithmetic/parser.rs
@@ -0,0 +1,135 @@
+use std::str::FromStr;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{digit1 as digits, multispace0 as multispaces},
+ combinator::alt,
+ combinator::delimited,
+ combinator::repeat,
+ token::one_of,
+};
+
+// Parser definition
+
+pub fn expr(i: &mut &str) -> PResult<i64> {
+ let init = term.parse_next(i)?;
+
+ repeat(0.., (one_of(['+', '-']), term))
+ .fold(
+ move || init,
+ |acc, (op, val): (char, i64)| {
+ if op == '+' {
+ acc + val
+ } else {
+ acc - val
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+// We read an initial factor and for each time we find
+// a * or / operator followed by another factor, we do
+// the math by folding everything
+fn term(i: &mut &str) -> PResult<i64> {
+ let init = factor.parse_next(i)?;
+
+ repeat(0.., (one_of(['*', '/']), factor))
+ .fold(
+ move || init,
+ |acc, (op, val): (char, i64)| {
+ if op == '*' {
+ acc * val
+ } else {
+ acc / val
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+// We transform an integer string into a i64, ignoring surrounding whitespace
+// We look for a digit suite, and try to convert it.
+// If either str::from_utf8 or FromStr::from_str fail,
+// we fallback to the parens parser defined above
+fn factor(i: &mut &str) -> PResult<i64> {
+ delimited(
+ multispaces,
+ alt((digits.try_map(FromStr::from_str), parens)),
+ multispaces,
+ )
+ .parse_next(i)
+}
+
+// We parse any expr surrounded by parens, ignoring all whitespace around those
+fn parens(i: &mut &str) -> PResult<i64> {
+ delimited('(', expr, ')').parse_next(i)
+}
+
+#[test]
+fn factor_test() {
+ let input = "3";
+ let expected = Ok(("", 3));
+ assert_eq!(factor.parse_peek(input), expected);
+
+ let input = " 12";
+ let expected = Ok(("", 12));
+ assert_eq!(factor.parse_peek(input), expected);
+
+ let input = "537 ";
+ let expected = Ok(("", 537));
+ assert_eq!(factor.parse_peek(input), expected);
+
+ let input = " 24 ";
+ let expected = Ok(("", 24));
+ assert_eq!(factor.parse_peek(input), expected);
+}
+
+#[test]
+fn term_test() {
+ let input = " 12 *2 / 3";
+ let expected = Ok(("", 8));
+ assert_eq!(term.parse_peek(input), expected);
+
+ let input = " 12 *2 / 3";
+ let expected = Ok(("", 8));
+ assert_eq!(term.parse_peek(input), expected);
+
+ let input = " 2* 3 *2 *2 / 3";
+ let expected = Ok(("", 8));
+ assert_eq!(term.parse_peek(input), expected);
+
+ let input = " 48 / 3/2";
+ let expected = Ok(("", 8));
+ assert_eq!(term.parse_peek(input), expected);
+}
+
+#[test]
+fn expr_test() {
+ let input = " 1 + 2 ";
+ let expected = Ok(("", 3));
+ assert_eq!(expr.parse_peek(input), expected);
+
+ let input = " 12 + 6 - 4+ 3";
+ let expected = Ok(("", 17));
+ assert_eq!(expr.parse_peek(input), expected);
+
+ let input = " 1 + 2*3 + 4";
+ let expected = Ok(("", 11));
+ assert_eq!(expr.parse_peek(input), expected);
+}
+
+#[test]
+fn parens_test() {
+ let input = " ( 2 )";
+ let expected = Ok(("", 2));
+ assert_eq!(expr.parse_peek(input), expected);
+
+ let input = " 2* ( 3 + 4 ) ";
+ let expected = Ok(("", 14));
+ assert_eq!(expr.parse_peek(input), expected);
+
+ let input = " 2*2 / ( 5 - 1) + 3";
+ let expected = Ok(("", 4));
+ assert_eq!(expr.parse_peek(input), expected);
+}
diff --git a/crates/winnow/examples/arithmetic/parser_ast.rs b/crates/winnow/examples/arithmetic/parser_ast.rs
new file mode 100644
index 0000000..20feb26
--- /dev/null
+++ b/crates/winnow/examples/arithmetic/parser_ast.rs
@@ -0,0 +1,182 @@
+use std::fmt;
+use std::fmt::{Debug, Display, Formatter};
+
+use std::str::FromStr;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{digit1 as digits, multispace0 as multispaces},
+ combinator::alt,
+ combinator::delimited,
+ combinator::repeat,
+ token::one_of,
+};
+
+#[derive(Debug, Clone)]
+pub enum Expr {
+ Value(i64),
+ Add(Box<Expr>, Box<Expr>),
+ Sub(Box<Expr>, Box<Expr>),
+ Mul(Box<Expr>, Box<Expr>),
+ Div(Box<Expr>, Box<Expr>),
+ Paren(Box<Expr>),
+}
+
+impl Expr {
+ pub fn eval(&self) -> i64 {
+ match self {
+ Self::Value(v) => *v,
+ Self::Add(lhs, rhs) => lhs.eval() + rhs.eval(),
+ Self::Sub(lhs, rhs) => lhs.eval() - rhs.eval(),
+ Self::Mul(lhs, rhs) => lhs.eval() * rhs.eval(),
+ Self::Div(lhs, rhs) => lhs.eval() / rhs.eval(),
+ Self::Paren(expr) => expr.eval(),
+ }
+ }
+}
+
+impl Display for Expr {
+ fn fmt(&self, format: &mut Formatter<'_>) -> fmt::Result {
+ use Expr::{Add, Div, Mul, Paren, Sub, Value};
+ match *self {
+ Value(val) => write!(format, "{}", val),
+ Add(ref left, ref right) => write!(format, "{} + {}", left, right),
+ Sub(ref left, ref right) => write!(format, "{} - {}", left, right),
+ Mul(ref left, ref right) => write!(format, "{} * {}", left, right),
+ Div(ref left, ref right) => write!(format, "{} / {}", left, right),
+ Paren(ref expr) => write!(format, "({})", expr),
+ }
+ }
+}
+
+pub fn expr(i: &mut &str) -> PResult<Expr> {
+ let init = term.parse_next(i)?;
+
+ repeat(0.., (one_of(['+', '-']), term))
+ .fold(
+ move || init.clone(),
+ |acc, (op, val): (char, Expr)| {
+ if op == '+' {
+ Expr::Add(Box::new(acc), Box::new(val))
+ } else {
+ Expr::Sub(Box::new(acc), Box::new(val))
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+fn term(i: &mut &str) -> PResult<Expr> {
+ let init = factor.parse_next(i)?;
+
+ repeat(0.., (one_of(['*', '/']), factor))
+ .fold(
+ move || init.clone(),
+ |acc, (op, val): (char, Expr)| {
+ if op == '*' {
+ Expr::Mul(Box::new(acc), Box::new(val))
+ } else {
+ Expr::Div(Box::new(acc), Box::new(val))
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+fn factor(i: &mut &str) -> PResult<Expr> {
+ delimited(
+ multispaces,
+ alt((digits.try_map(FromStr::from_str).map(Expr::Value), parens)),
+ multispaces,
+ )
+ .parse_next(i)
+}
+
+fn parens(i: &mut &str) -> PResult<Expr> {
+ delimited("(", expr, ")")
+ .map(|e| Expr::Paren(Box::new(e)))
+ .parse_next(i)
+}
+
+#[test]
+fn factor_test() {
+ let input = "3";
+ let expected = Ok(("", String::from("Value(3)")));
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 12";
+ let expected = Ok(("", String::from("Value(12)")));
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = "537 ";
+ let expected = Ok(("", String::from("Value(537)")));
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 24 ";
+ let expected = Ok(("", String::from("Value(24)")));
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse_peek(input), expected);
+}
+
+#[test]
+fn term_test() {
+ let input = " 12 *2 / 3";
+ let expected = Ok(("", String::from("Div(Mul(Value(12), Value(2)), Value(3))")));
+ assert_eq!(term.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 12 *2 / 3";
+ let expected = Ok(("", String::from("Div(Mul(Value(12), Value(2)), Value(3))")));
+ assert_eq!(term.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 2* 3 *2 *2 / 3";
+ let expected = Ok((
+ "",
+ String::from("Div(Mul(Mul(Mul(Value(2), Value(3)), Value(2)), Value(2)), Value(3))"),
+ ));
+ assert_eq!(term.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 48 / 3/2";
+ let expected = Ok(("", String::from("Div(Div(Value(48), Value(3)), Value(2))")));
+ assert_eq!(term.map(|e| format!("{e:?}")).parse_peek(input), expected);
+}
+
+#[test]
+fn expr_test() {
+ let input = " 1 + 2 ";
+ let expected = Ok(("", String::from("Add(Value(1), Value(2))")));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 12 + 6 - 4+ 3";
+ let expected = Ok((
+ "",
+ String::from("Add(Sub(Add(Value(12), Value(6)), Value(4)), Value(3))"),
+ ));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 1 + 2*3 + 4";
+ let expected = Ok((
+ "",
+ String::from("Add(Add(Value(1), Mul(Value(2), Value(3))), Value(4))"),
+ ));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+}
+
+#[test]
+fn parens_test() {
+ let input = " ( 2 )";
+ let expected = Ok(("", String::from("Paren(Value(2))")));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 2* ( 3 + 4 ) ";
+ let expected = Ok((
+ "",
+ String::from("Mul(Value(2), Paren(Add(Value(3), Value(4))))"),
+ ));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+
+ let input = " 2*2 / ( 5 - 1) + 3";
+ let expected = Ok((
+ "",
+ String::from("Add(Div(Mul(Value(2), Value(2)), Paren(Sub(Value(5), Value(1)))), Value(3))"),
+ ));
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse_peek(input), expected);
+}
diff --git a/crates/winnow/examples/arithmetic/parser_lexer.rs b/crates/winnow/examples/arithmetic/parser_lexer.rs
new file mode 100644
index 0000000..d6b7422
--- /dev/null
+++ b/crates/winnow/examples/arithmetic/parser_lexer.rs
@@ -0,0 +1,300 @@
+use std::fmt;
+use std::fmt::{Debug, Display, Formatter};
+
+use std::str::FromStr;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{digit1 as digits, multispace0 as multispaces},
+ combinator::alt,
+ combinator::dispatch,
+ combinator::fail,
+ combinator::peek,
+ combinator::repeat,
+ combinator::{delimited, preceded, terminated},
+ token::any,
+ token::one_of,
+};
+
+#[derive(Debug, Clone)]
+pub enum Expr {
+ Value(i64),
+ Add(Box<Expr>, Box<Expr>),
+ Sub(Box<Expr>, Box<Expr>),
+ Mul(Box<Expr>, Box<Expr>),
+ Div(Box<Expr>, Box<Expr>),
+ Paren(Box<Expr>),
+}
+
+impl Expr {
+ pub fn eval(&self) -> i64 {
+ match self {
+ Self::Value(v) => *v,
+ Self::Add(lhs, rhs) => lhs.eval() + rhs.eval(),
+ Self::Sub(lhs, rhs) => lhs.eval() - rhs.eval(),
+ Self::Mul(lhs, rhs) => lhs.eval() * rhs.eval(),
+ Self::Div(lhs, rhs) => lhs.eval() / rhs.eval(),
+ Self::Paren(expr) => expr.eval(),
+ }
+ }
+}
+
+impl Display for Expr {
+ fn fmt(&self, format: &mut Formatter<'_>) -> fmt::Result {
+ use Expr::{Add, Div, Mul, Paren, Sub, Value};
+ match *self {
+ Value(val) => write!(format, "{}", val),
+ Add(ref left, ref right) => write!(format, "{} + {}", left, right),
+ Sub(ref left, ref right) => write!(format, "{} - {}", left, right),
+ Mul(ref left, ref right) => write!(format, "{} * {}", left, right),
+ Div(ref left, ref right) => write!(format, "{} / {}", left, right),
+ Paren(ref expr) => write!(format, "({})", expr),
+ }
+ }
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub enum Token {
+ Value(i64),
+ Oper(Oper),
+ OpenParen,
+ CloseParen,
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub enum Oper {
+ Add,
+ Sub,
+ Mul,
+ Div,
+}
+
+impl winnow::stream::ContainsToken<Token> for Token {
+ #[inline(always)]
+ fn contains_token(&self, token: Token) -> bool {
+ *self == token
+ }
+}
+
+impl winnow::stream::ContainsToken<Token> for &'_ [Token] {
+ #[inline]
+ fn contains_token(&self, token: Token) -> bool {
+ self.iter().any(|t| *t == token)
+ }
+}
+
+impl<const LEN: usize> winnow::stream::ContainsToken<Token> for &'_ [Token; LEN] {
+ #[inline]
+ fn contains_token(&self, token: Token) -> bool {
+ self.iter().any(|t| *t == token)
+ }
+}
+
+impl<const LEN: usize> winnow::stream::ContainsToken<Token> for [Token; LEN] {
+ #[inline]
+ fn contains_token(&self, token: Token) -> bool {
+ self.iter().any(|t| *t == token)
+ }
+}
+
+#[allow(dead_code)]
+pub fn expr2(i: &mut &str) -> PResult<Expr> {
+ let tokens = lex.parse_next(i)?;
+ expr.parse_next(&mut tokens.as_slice())
+}
+
+pub fn lex(i: &mut &str) -> PResult<Vec<Token>> {
+ preceded(multispaces, repeat(1.., terminated(token, multispaces))).parse_next(i)
+}
+
+fn token(i: &mut &str) -> PResult<Token> {
+ dispatch! {peek(any);
+ '0'..='9' => digits.try_map(FromStr::from_str).map(Token::Value),
+ '(' => '('.value(Token::OpenParen),
+ ')' => ')'.value(Token::CloseParen),
+ '+' => '+'.value(Token::Oper(Oper::Add)),
+ '-' => '-'.value(Token::Oper(Oper::Sub)),
+ '*' => '*'.value(Token::Oper(Oper::Mul)),
+ '/' => '/'.value(Token::Oper(Oper::Div)),
+ _ => fail,
+ }
+ .parse_next(i)
+}
+
+pub fn expr(i: &mut &[Token]) -> PResult<Expr> {
+ let init = term.parse_next(i)?;
+
+ repeat(
+ 0..,
+ (
+ one_of([Token::Oper(Oper::Add), Token::Oper(Oper::Sub)]),
+ term,
+ ),
+ )
+ .fold(
+ move || init.clone(),
+ |acc, (op, val): (Token, Expr)| {
+ if op == Token::Oper(Oper::Add) {
+ Expr::Add(Box::new(acc), Box::new(val))
+ } else {
+ Expr::Sub(Box::new(acc), Box::new(val))
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+fn term(i: &mut &[Token]) -> PResult<Expr> {
+ let init = factor.parse_next(i)?;
+
+ repeat(
+ 0..,
+ (
+ one_of([Token::Oper(Oper::Mul), Token::Oper(Oper::Div)]),
+ factor,
+ ),
+ )
+ .fold(
+ move || init.clone(),
+ |acc, (op, val): (Token, Expr)| {
+ if op == Token::Oper(Oper::Mul) {
+ Expr::Mul(Box::new(acc), Box::new(val))
+ } else {
+ Expr::Div(Box::new(acc), Box::new(val))
+ }
+ },
+ )
+ .parse_next(i)
+}
+
+fn factor(i: &mut &[Token]) -> PResult<Expr> {
+ alt((
+ one_of(|t| matches!(t, Token::Value(_))).map(|t| match t {
+ Token::Value(v) => Expr::Value(v),
+ _ => unreachable!(),
+ }),
+ parens,
+ ))
+ .parse_next(i)
+}
+
+fn parens(i: &mut &[Token]) -> PResult<Expr> {
+ delimited(one_of(Token::OpenParen), expr, one_of(Token::CloseParen))
+ .map(|e| Expr::Paren(Box::new(e)))
+ .parse_next(i)
+}
+
+#[test]
+fn lex_test() {
+ let input = "3";
+ let expected = Ok(String::from(r#"("", [Value(3)])"#));
+ assert_eq!(lex.parse_peek(input).map(|e| format!("{e:?}")), expected);
+
+ let input = " 24 ";
+ let expected = Ok(String::from(r#"("", [Value(24)])"#));
+ assert_eq!(lex.parse_peek(input).map(|e| format!("{e:?}")), expected);
+
+ let input = " 12 *2 / 3";
+ let expected = Ok(String::from(
+ r#"("", [Value(12), Oper(Mul), Value(2), Oper(Div), Value(3)])"#,
+ ));
+ assert_eq!(lex.parse_peek(input).map(|e| format!("{e:?}")), expected);
+
+ let input = " 2*2 / ( 5 - 1) + 3";
+ let expected = Ok(String::from(
+ r#"("", [Value(2), Oper(Mul), Value(2), Oper(Div), OpenParen, Value(5), Oper(Sub), Value(1), CloseParen, Oper(Add), Value(3)])"#,
+ ));
+ assert_eq!(lex.parse_peek(input).map(|e| format!("{e:?}")), expected);
+}
+
+#[test]
+fn factor_test() {
+ let input = "3";
+ let expected = Ok(String::from("Value(3)"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 12";
+ let expected = Ok(String::from("Value(12)"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = "537 ";
+ let expected = Ok(String::from("Value(537)"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 24 ";
+ let expected = Ok(String::from("Value(24)"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(factor.map(|e| format!("{e:?}")).parse(&input), expected);
+}
+
+#[test]
+fn term_test() {
+ let input = " 12 *2 / 3";
+ let expected = Ok(String::from("Div(Mul(Value(12), Value(2)), Value(3))"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(term.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 12 *2 / 3";
+ let expected = Ok(String::from("Div(Mul(Value(12), Value(2)), Value(3))"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(term.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 2* 3 *2 *2 / 3";
+ let expected = Ok(String::from(
+ "Div(Mul(Mul(Mul(Value(2), Value(3)), Value(2)), Value(2)), Value(3))",
+ ));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(term.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 48 / 3/2";
+ let expected = Ok(String::from("Div(Div(Value(48), Value(3)), Value(2))"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(term.map(|e| format!("{e:?}")).parse(&input), expected);
+}
+
+#[test]
+fn expr_test() {
+ let input = " 1 + 2 ";
+ let expected = Ok(String::from("Add(Value(1), Value(2))"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 12 + 6 - 4+ 3";
+ let expected = Ok(String::from(
+ "Add(Sub(Add(Value(12), Value(6)), Value(4)), Value(3))",
+ ));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 1 + 2*3 + 4";
+ let expected = Ok(String::from(
+ "Add(Add(Value(1), Mul(Value(2), Value(3))), Value(4))",
+ ));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+}
+
+#[test]
+fn parens_test() {
+ let input = " ( 2 )";
+ let expected = Ok(String::from("Paren(Value(2))"));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 2* ( 3 + 4 ) ";
+ let expected = Ok(String::from(
+ "Mul(Value(2), Paren(Add(Value(3), Value(4))))",
+ ));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+
+ let input = " 2*2 / ( 5 - 1) + 3";
+ let expected = Ok(String::from(
+ "Add(Div(Mul(Value(2), Value(2)), Paren(Sub(Value(5), Value(1)))), Value(3))",
+ ));
+ let input = lex.parse(input).unwrap();
+ assert_eq!(expr.map(|e| format!("{e:?}")).parse(&input), expected);
+}
diff --git a/crates/winnow/examples/css/main.rs b/crates/winnow/examples/css/main.rs
new file mode 100644
index 0000000..cf52ada
--- /dev/null
+++ b/crates/winnow/examples/css/main.rs
@@ -0,0 +1,62 @@
+use winnow::prelude::*;
+
+mod parser;
+
+use parser::hex_color;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let input = args.input.as_deref().unwrap_or("#AAAAAA");
+
+ println!("{} =", input);
+ match hex_color.parse(input) {
+ Ok(result) => {
+ println!(" {:?}", result);
+ }
+ Err(err) => {
+ println!(" {}", err);
+ }
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
+
+#[test]
+fn parse_color() {
+ assert_eq!(
+ hex_color.parse_peek("#2F14DF"),
+ Ok((
+ "",
+ parser::Color {
+ red: 47,
+ green: 20,
+ blue: 223,
+ }
+ ))
+ );
+}
diff --git a/crates/winnow/examples/css/parser.rs b/crates/winnow/examples/css/parser.rs
new file mode 100644
index 0000000..fa13078
--- /dev/null
+++ b/crates/winnow/examples/css/parser.rs
@@ -0,0 +1,35 @@
+use winnow::combinator::seq;
+use winnow::prelude::*;
+use winnow::token::take_while;
+
+#[derive(Debug, Eq, PartialEq)]
+pub struct Color {
+ pub red: u8,
+ pub green: u8,
+ pub blue: u8,
+}
+
+impl std::str::FromStr for Color {
+ // The error must be owned
+ type Err = String;
+
+ fn from_str(s: &str) -> Result<Self, Self::Err> {
+ hex_color.parse(s).map_err(|e| e.to_string())
+ }
+}
+
+pub fn hex_color(input: &mut &str) -> PResult<Color> {
+ seq!(Color {
+ _: '#',
+ red: hex_primary,
+ green: hex_primary,
+ blue: hex_primary
+ })
+ .parse_next(input)
+}
+
+fn hex_primary(input: &mut &str) -> PResult<u8> {
+ take_while(2, |c: char| c.is_ascii_hexdigit())
+ .try_map(|input| u8::from_str_radix(input, 16))
+ .parse_next(input)
+}
diff --git a/crates/winnow/examples/custom_error.rs b/crates/winnow/examples/custom_error.rs
new file mode 100644
index 0000000..998e5ad
--- /dev/null
+++ b/crates/winnow/examples/custom_error.rs
@@ -0,0 +1,40 @@
+use winnow::error::ErrMode;
+use winnow::error::ErrorKind;
+use winnow::error::ParserError;
+use winnow::prelude::*;
+
+#[derive(Debug, PartialEq, Eq)]
+pub enum CustomError<I> {
+ MyError,
+ Nom(I, ErrorKind),
+}
+
+impl<I: Clone> ParserError<I> for CustomError<I> {
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ CustomError::Nom(input.clone(), kind)
+ }
+
+ fn append(self, _: &I, _: ErrorKind) -> Self {
+ self
+ }
+}
+
+pub fn parse<'s>(_input: &mut &'s str) -> PResult<&'s str, CustomError<&'s str>> {
+ Err(ErrMode::Backtrack(CustomError::MyError))
+}
+
+fn main() {}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn it_works() {
+ let err = parse.parse_next(&mut "").unwrap_err();
+ match err {
+ ErrMode::Backtrack(e) => assert_eq!(e, CustomError::MyError),
+ _ => panic!("Unexpected error: {:?}", err),
+ }
+ }
+}
diff --git a/crates/winnow/examples/http/bench.rs b/crates/winnow/examples/http/bench.rs
new file mode 100644
index 0000000..a27a119
--- /dev/null
+++ b/crates/winnow/examples/http/bench.rs
@@ -0,0 +1,36 @@
+mod parser;
+mod parser_streaming;
+
+fn one_test(c: &mut criterion::Criterion) {
+ let data = &b"GET / HTTP/1.1
+Host: www.reddit.com
+User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:15.0) Gecko/20100101 Firefox/15.0.1
+Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip, deflate
+Connection: keep-alive
+
+"[..];
+
+ let mut http_group = c.benchmark_group("http");
+ http_group.throughput(criterion::Throughput::Bytes(data.len() as u64));
+ http_group.bench_with_input(
+ criterion::BenchmarkId::new("complete", data.len()),
+ data,
+ |b, data| {
+ b.iter(|| parser::parse(data).unwrap());
+ },
+ );
+ http_group.bench_with_input(
+ criterion::BenchmarkId::new("streaming", data.len()),
+ data,
+ |b, data| {
+ b.iter(|| parser_streaming::parse(data).unwrap());
+ },
+ );
+
+ http_group.finish();
+}
+
+criterion::criterion_group!(http, one_test);
+criterion::criterion_main!(http);
diff --git a/crates/winnow/examples/http/main.rs b/crates/winnow/examples/http/main.rs
new file mode 100644
index 0000000..b0e480f
--- /dev/null
+++ b/crates/winnow/examples/http/main.rs
@@ -0,0 +1,47 @@
+mod parser;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let input = args.input.as_deref().unwrap_or(
+ "GET / HTTP/1.1
+Host: www.reddit.com
+User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:15.0) Gecko/20100101 Firefox/15.0.1
+Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
+Accept-Language: en-us,en;q=0.5
+Accept-Encoding: gzip, deflate
+Connection: keep-alive
+
+",
+ );
+
+ if let Some(result) = parser::parse(input.as_bytes()) {
+ println!(" {:#?}", result);
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
diff --git a/crates/winnow/examples/http/parser.rs b/crates/winnow/examples/http/parser.rs
new file mode 100644
index 0000000..0afe33b
--- /dev/null
+++ b/crates/winnow/examples/http/parser.rs
@@ -0,0 +1,137 @@
+use winnow::combinator::seq;
+use winnow::prelude::*;
+use winnow::{ascii::line_ending, combinator::repeat, token::take_while};
+
+pub type Stream<'i> = &'i [u8];
+
+#[rustfmt::skip]
+#[derive(Debug)]
+#[allow(dead_code)]
+pub struct Request<'a> {
+ method: &'a [u8],
+ uri: &'a [u8],
+ version: &'a [u8],
+}
+
+#[derive(Debug)]
+#[allow(dead_code)]
+pub struct Header<'a> {
+ name: &'a [u8],
+ value: Vec<&'a [u8]>,
+}
+
+pub fn parse(data: &[u8]) -> Option<Vec<(Request<'_>, Vec<Header<'_>>)>> {
+ let mut buf = data;
+ let mut v = Vec::new();
+ loop {
+ match request(&mut buf) {
+ Ok(r) => {
+ v.push(r);
+
+ if buf.is_empty() {
+ //println!("{}", i);
+ break;
+ }
+ }
+ Err(e) => {
+ println!("error: {:?}", e);
+ return None;
+ }
+ }
+ }
+
+ Some(v)
+}
+
+fn request<'s>(input: &mut Stream<'s>) -> PResult<(Request<'s>, Vec<Header<'s>>)> {
+ let req = request_line(input)?;
+ let h = repeat(1.., message_header).parse_next(input)?;
+ let _ = line_ending.parse_next(input)?;
+
+ Ok((req, h))
+}
+
+fn request_line<'s>(input: &mut Stream<'s>) -> PResult<Request<'s>> {
+ seq!( Request {
+ method: take_while(1.., is_token),
+ _: take_while(1.., is_space),
+ uri: take_while(1.., is_not_space),
+ _: take_while(1.., is_space),
+ version: http_version,
+ _: line_ending,
+ })
+ .parse_next(input)
+}
+
+fn http_version<'s>(input: &mut Stream<'s>) -> PResult<&'s [u8]> {
+ let _ = "HTTP/".parse_next(input)?;
+ let version = take_while(1.., is_version).parse_next(input)?;
+
+ Ok(version)
+}
+
+fn message_header_value<'s>(input: &mut Stream<'s>) -> PResult<&'s [u8]> {
+ let _ = take_while(1.., is_horizontal_space).parse_next(input)?;
+ let data = take_while(1.., till_line_ending).parse_next(input)?;
+ let _ = line_ending.parse_next(input)?;
+
+ Ok(data)
+}
+
+fn message_header<'s>(input: &mut Stream<'s>) -> PResult<Header<'s>> {
+ seq!(Header {
+ name: take_while(1.., is_token),
+ _: ':',
+ value: repeat(1.., message_header_value),
+ })
+ .parse_next(input)
+}
+
+#[rustfmt::skip]
+#[allow(clippy::match_same_arms)]
+#[allow(clippy::match_like_matches_macro)]
+fn is_token(c: u8) -> bool {
+ match c {
+ 128..=255 => false,
+ 0..=31 => false,
+ b'(' => false,
+ b')' => false,
+ b'<' => false,
+ b'>' => false,
+ b'@' => false,
+ b',' => false,
+ b';' => false,
+ b':' => false,
+ b'\\' => false,
+ b'"' => false,
+ b'/' => false,
+ b'[' => false,
+ b']' => false,
+ b'?' => false,
+ b'=' => false,
+ b'{' => false,
+ b'}' => false,
+ b' ' => false,
+ _ => true,
+ }
+}
+
+fn is_version(c: u8) -> bool {
+ c.is_ascii_digit() || c == b'.'
+}
+
+fn till_line_ending(c: u8) -> bool {
+ c != b'\r' && c != b'\n'
+}
+
+fn is_space(c: u8) -> bool {
+ c == b' '
+}
+
+fn is_not_space(c: u8) -> bool {
+ c != b' '
+}
+
+fn is_horizontal_space(c: u8) -> bool {
+ c == b' ' || c == b'\t'
+}
diff --git a/crates/winnow/examples/http/parser_streaming.rs b/crates/winnow/examples/http/parser_streaming.rs
new file mode 100644
index 0000000..1079bc0
--- /dev/null
+++ b/crates/winnow/examples/http/parser_streaming.rs
@@ -0,0 +1,138 @@
+use winnow::combinator::seq;
+use winnow::{
+ ascii::line_ending, combinator::repeat, prelude::*, stream::Partial, token::take_while,
+};
+
+pub type Stream<'i> = Partial<&'i [u8]>;
+
+#[rustfmt::skip]
+#[derive(Debug)]
+#[allow(dead_code)]
+pub struct Request<'a> {
+ method: &'a [u8],
+ uri: &'a [u8],
+ version: &'a [u8],
+}
+
+#[derive(Debug)]
+#[allow(dead_code)]
+pub struct Header<'a> {
+ name: &'a [u8],
+ value: Vec<&'a [u8]>,
+}
+
+pub fn parse(data: &[u8]) -> Option<Vec<(Request<'_>, Vec<Header<'_>>)>> {
+ let mut buf = Partial::new(data);
+ let mut v = Vec::new();
+ loop {
+ match request(&mut buf) {
+ Ok(r) => {
+ v.push(r);
+
+ if buf.is_empty() {
+ //println!("{}", i);
+ break;
+ }
+ }
+ Err(e) => {
+ println!("error: {:?}", e);
+ return None;
+ }
+ }
+ }
+
+ Some(v)
+}
+
+fn request<'s>(input: &mut Stream<'s>) -> PResult<(Request<'s>, Vec<Header<'s>>)> {
+ let req = request_line(input)?;
+ let h = repeat(1.., message_header).parse_next(input)?;
+ let _ = line_ending.parse_next(input)?;
+
+ Ok((req, h))
+}
+
+fn request_line<'s>(input: &mut Stream<'s>) -> PResult<Request<'s>> {
+ seq!( Request {
+ method: take_while(1.., is_token),
+ _: take_while(1.., is_space),
+ uri: take_while(1.., is_not_space),
+ _: take_while(1.., is_space),
+ version: http_version,
+ _: line_ending,
+ })
+ .parse_next(input)
+}
+
+fn http_version<'s>(input: &mut Stream<'s>) -> PResult<&'s [u8]> {
+ let _ = "HTTP/".parse_next(input)?;
+ let version = take_while(1.., is_version).parse_next(input)?;
+
+ Ok(version)
+}
+
+fn message_header_value<'s>(input: &mut Stream<'s>) -> PResult<&'s [u8]> {
+ let _ = take_while(1.., is_horizontal_space).parse_next(input)?;
+ let data = take_while(1.., till_line_ending).parse_next(input)?;
+ let _ = line_ending.parse_next(input)?;
+
+ Ok(data)
+}
+
+fn message_header<'s>(input: &mut Stream<'s>) -> PResult<Header<'s>> {
+ seq!(Header {
+ name: take_while(1.., is_token),
+ _: ':',
+ value: repeat(1.., message_header_value),
+ })
+ .parse_next(input)
+}
+
+#[rustfmt::skip]
+#[allow(clippy::match_same_arms)]
+#[allow(clippy::match_like_matches_macro)]
+fn is_token(c: u8) -> bool {
+ match c {
+ 128..=255 => false,
+ 0..=31 => false,
+ b'(' => false,
+ b')' => false,
+ b'<' => false,
+ b'>' => false,
+ b'@' => false,
+ b',' => false,
+ b';' => false,
+ b':' => false,
+ b'\\' => false,
+ b'"' => false,
+ b'/' => false,
+ b'[' => false,
+ b']' => false,
+ b'?' => false,
+ b'=' => false,
+ b'{' => false,
+ b'}' => false,
+ b' ' => false,
+ _ => true,
+ }
+}
+
+fn is_version(c: u8) -> bool {
+ c.is_ascii_digit() || c == b'.'
+}
+
+fn till_line_ending(c: u8) -> bool {
+ c != b'\r' && c != b'\n'
+}
+
+fn is_space(c: u8) -> bool {
+ c == b' '
+}
+
+fn is_not_space(c: u8) -> bool {
+ c != b' '
+}
+
+fn is_horizontal_space(c: u8) -> bool {
+ c == b' ' || c == b'\t'
+}
diff --git a/crates/winnow/examples/ini/bench.rs b/crates/winnow/examples/ini/bench.rs
new file mode 100644
index 0000000..3c7eab8
--- /dev/null
+++ b/crates/winnow/examples/ini/bench.rs
@@ -0,0 +1,61 @@
+use winnow::combinator::repeat;
+use winnow::prelude::*;
+
+mod parser;
+mod parser_str;
+
+fn bench_ini(c: &mut criterion::Criterion) {
+ let str = "[owner]
+name=John Doe
+organization=Acme Widgets Inc.
+
+[database]
+server=192.0.2.62
+port=143
+file=payroll.dat
+\0";
+
+ let mut group = c.benchmark_group("ini");
+ group.throughput(criterion::Throughput::Bytes(str.len() as u64));
+ group.bench_function(criterion::BenchmarkId::new("bytes", str.len()), |b| {
+ b.iter(|| parser::categories.parse_peek(str.as_bytes()).unwrap());
+ });
+ group.bench_function(criterion::BenchmarkId::new("str", str.len()), |b| {
+ b.iter(|| parser_str::categories.parse_peek(str).unwrap())
+ });
+}
+
+fn bench_ini_keys_and_values(c: &mut criterion::Criterion) {
+ let str = "server=192.0.2.62
+port=143
+file=payroll.dat
+\0";
+
+ fn acc<'s>(i: &mut parser::Stream<'s>) -> PResult<Vec<(&'s str, &'s str)>> {
+ repeat(0.., parser::key_value).parse_next(i)
+ }
+
+ let mut group = c.benchmark_group("ini keys and values");
+ group.throughput(criterion::Throughput::Bytes(str.len() as u64));
+ group.bench_function(criterion::BenchmarkId::new("bytes", str.len()), |b| {
+ b.iter(|| acc.parse_peek(str.as_bytes()).unwrap());
+ });
+}
+
+fn bench_ini_key_value(c: &mut criterion::Criterion) {
+ let str = "server=192.0.2.62\n";
+
+ let mut group = c.benchmark_group("ini key value");
+ group.throughput(criterion::Throughput::Bytes(str.len() as u64));
+ group.bench_function(criterion::BenchmarkId::new("bytes", str.len()), |b| {
+ b.iter(|| parser::key_value.parse_peek(str.as_bytes()).unwrap());
+ });
+}
+
+criterion::criterion_group!(
+ benches,
+ bench_ini,
+ bench_ini_keys_and_values,
+ bench_ini_key_value
+);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/examples/ini/main.rs b/crates/winnow/examples/ini/main.rs
new file mode 100644
index 0000000..8f61d18
--- /dev/null
+++ b/crates/winnow/examples/ini/main.rs
@@ -0,0 +1,60 @@
+use winnow::prelude::*;
+
+mod parser;
+mod parser_str;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let input = args.input.as_deref().unwrap_or("1 + 1");
+
+ if args.binary {
+ match parser::categories.parse(input.as_bytes()) {
+ Ok(result) => {
+ println!(" {:?}", result);
+ }
+ Err(err) => {
+ println!(" {:?}", err);
+ }
+ }
+ } else {
+ match parser_str::categories.parse(input) {
+ Ok(result) => {
+ println!(" {:?}", result);
+ }
+ Err(err) => {
+ println!(" {}", err);
+ }
+ }
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+ binary: bool,
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Long("binary") => {
+ res.binary = true;
+ }
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
diff --git a/crates/winnow/examples/ini/parser.rs b/crates/winnow/examples/ini/parser.rs
new file mode 100644
index 0000000..a782d6e
--- /dev/null
+++ b/crates/winnow/examples/ini/parser.rs
@@ -0,0 +1,146 @@
+use std::collections::HashMap;
+use std::str;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{alphanumeric1 as alphanumeric, multispace0 as multispace, space0 as space},
+ combinator::opt,
+ combinator::repeat,
+ combinator::{delimited, separated_pair, terminated},
+ token::take_while,
+};
+
+pub type Stream<'i> = &'i [u8];
+
+pub fn categories<'s>(i: &mut Stream<'s>) -> PResult<HashMap<&'s str, HashMap<&'s str, &'s str>>> {
+ repeat(
+ 0..,
+ separated_pair(
+ category,
+ opt(multispace),
+ repeat(0.., terminated(key_value, opt(multispace))),
+ ),
+ )
+ .parse_next(i)
+}
+
+fn category<'s>(i: &mut Stream<'s>) -> PResult<&'s str> {
+ delimited('[', take_while(0.., |c| c != b']'), ']')
+ .try_map(str::from_utf8)
+ .parse_next(i)
+}
+
+pub fn key_value<'s>(i: &mut Stream<'s>) -> PResult<(&'s str, &'s str)> {
+ let key = alphanumeric.try_map(str::from_utf8).parse_next(i)?;
+ let _ = (opt(space), '=', opt(space)).parse_next(i)?;
+ let val = take_while(0.., |c| c != b'\n' && c != b';')
+ .try_map(str::from_utf8)
+ .parse_next(i)?;
+ let _ = opt((';', take_while(0.., |c| c != b'\n'))).parse_next(i)?;
+ Ok((key, val))
+}
+
+#[test]
+fn parse_category_test() {
+ let ini_file = &b"[category]
+
+parameter=value
+key = value2"[..];
+
+ let ini_without_category = &b"\n\nparameter=value
+key = value2"[..];
+
+ let res = category.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, o)) => println!("i: {:?} | o: {:?}", str::from_utf8(i), o),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_category, "category")));
+}
+
+#[test]
+fn parse_key_value_test() {
+ let ini_file = &b"parameter=value
+key = value2"[..];
+
+ let ini_without_key_value = &b"\nkey = value2"[..];
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {:?} | o: ({:?},{:?})", str::from_utf8(i), o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_key_value_with_space_test() {
+ let ini_file = &b"parameter = value
+key = value2"[..];
+
+ let ini_without_key_value = &b"\nkey = value2"[..];
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {:?} | o: ({:?},{:?})", str::from_utf8(i), o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_key_value_with_comment_test() {
+ let ini_file = &b"parameter=value;abc
+key = value2"[..];
+
+ let ini_without_key_value = &b"\nkey = value2"[..];
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {:?} | o: ({:?},{:?})", str::from_utf8(i), o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_multiple_categories_test() {
+ let ini_file = &b"[abcd]
+
+parameter=value;abc
+
+key = value2
+
+[category]
+parameter3=value3
+key4 = value4
+"[..];
+
+ let ini_after_parser = &b""[..];
+
+ let res = categories.parse_peek(ini_file);
+ //println!("{:?}", res);
+ match res {
+ Ok((i, ref o)) => println!("i: {:?} | o: {:?}", str::from_utf8(i), o),
+ _ => println!("error"),
+ }
+
+ let mut expected_1: HashMap<&str, &str> = HashMap::new();
+ expected_1.insert("parameter", "value");
+ expected_1.insert("key", "value2");
+ let mut expected_2: HashMap<&str, &str> = HashMap::new();
+ expected_2.insert("parameter3", "value3");
+ expected_2.insert("key4", "value4");
+ let mut expected_h: HashMap<&str, HashMap<&str, &str>> = HashMap::new();
+ expected_h.insert("abcd", expected_1);
+ expected_h.insert("category", expected_2);
+ assert_eq!(res, Ok((ini_after_parser, expected_h)));
+}
diff --git a/crates/winnow/examples/ini/parser_str.rs b/crates/winnow/examples/ini/parser_str.rs
new file mode 100644
index 0000000..7c3603c
--- /dev/null
+++ b/crates/winnow/examples/ini/parser_str.rs
@@ -0,0 +1,208 @@
+use std::collections::HashMap;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{alphanumeric1 as alphanumeric, space0 as space},
+ combinator::opt,
+ combinator::repeat,
+ combinator::{delimited, terminated},
+ token::{take_till, take_while},
+};
+
+pub type Stream<'i> = &'i str;
+
+pub fn categories<'s>(
+ input: &mut Stream<'s>,
+) -> PResult<HashMap<&'s str, HashMap<&'s str, &'s str>>> {
+ repeat(0.., category_and_keys).parse_next(input)
+}
+
+fn category_and_keys<'s>(i: &mut Stream<'s>) -> PResult<(&'s str, HashMap<&'s str, &'s str>)> {
+ (category, keys_and_values).parse_next(i)
+}
+
+fn category<'s>(i: &mut Stream<'s>) -> PResult<&'s str> {
+ terminated(
+ delimited('[', take_while(0.., |c| c != ']'), ']'),
+ opt(take_while(1.., [' ', '\r', '\n'])),
+ )
+ .parse_next(i)
+}
+
+fn keys_and_values<'s>(input: &mut Stream<'s>) -> PResult<HashMap<&'s str, &'s str>> {
+ repeat(0.., key_value).parse_next(input)
+}
+
+fn key_value<'s>(i: &mut Stream<'s>) -> PResult<(&'s str, &'s str)> {
+ let key = alphanumeric.parse_next(i)?;
+ let _ = (opt(space), "=", opt(space)).parse_next(i)?;
+ let val = take_till(0.., is_line_ending_or_comment).parse_next(i)?;
+ let _ = opt(space).parse_next(i)?;
+ let _ = opt((";", till_line_ending)).parse_next(i)?;
+ let _ = opt(space_or_line_ending).parse_next(i)?;
+
+ Ok((key, val))
+}
+
+fn is_line_ending_or_comment(chr: char) -> bool {
+ chr == ';' || chr == '\n'
+}
+
+fn till_line_ending<'s>(i: &mut Stream<'s>) -> PResult<&'s str> {
+ take_while(0.., |c| c != '\r' && c != '\n').parse_next(i)
+}
+
+fn space_or_line_ending<'s>(i: &mut Stream<'s>) -> PResult<&'s str> {
+ take_while(1.., [' ', '\r', '\n']).parse_next(i)
+}
+
+#[test]
+fn parse_category_test() {
+ let ini_file = "[category]
+
+parameter=value
+key = value2";
+
+ let ini_without_category = "parameter=value
+key = value2";
+
+ let res = category.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, o)) => println!("i: {} | o: {:?}", i, o),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_category, "category")));
+}
+
+#[test]
+fn parse_key_value_test() {
+ let ini_file = "parameter=value
+key = value2";
+
+ let ini_without_key_value = "key = value2";
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {} | o: ({:?},{:?})", i, o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_key_value_with_space_test() {
+ let ini_file = "parameter = value
+key = value2";
+
+ let ini_without_key_value = "key = value2";
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {} | o: ({:?},{:?})", i, o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_key_value_with_comment_test() {
+ let ini_file = "parameter=value;abc
+key = value2";
+
+ let ini_without_key_value = "key = value2";
+
+ let res = key_value.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, (o1, o2))) => println!("i: {} | o: ({:?},{:?})", i, o1, o2),
+ _ => println!("error"),
+ }
+
+ assert_eq!(res, Ok((ini_without_key_value, ("parameter", "value"))));
+}
+
+#[test]
+fn parse_multiple_keys_and_values_test() {
+ let ini_file = "parameter=value;abc
+
+key = value2
+
+[category]";
+
+ let ini_without_key_value = "[category]";
+
+ let res = keys_and_values.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, ref o)) => println!("i: {} | o: {:?}", i, o),
+ _ => println!("error"),
+ }
+
+ let mut expected: HashMap<&str, &str> = HashMap::new();
+ expected.insert("parameter", "value");
+ expected.insert("key", "value2");
+ assert_eq!(res, Ok((ini_without_key_value, expected)));
+}
+
+#[test]
+fn parse_category_then_multiple_keys_and_values_test() {
+ //FIXME: there can be an empty line or a comment line after a category
+ let ini_file = "[abcd]
+parameter=value;abc
+
+key = value2
+
+[category]";
+
+ let ini_after_parser = "[category]";
+
+ let res = category_and_keys.parse_peek(ini_file);
+ println!("{:?}", res);
+ match res {
+ Ok((i, ref o)) => println!("i: {} | o: {:?}", i, o),
+ _ => println!("error"),
+ }
+
+ let mut expected_h: HashMap<&str, &str> = HashMap::new();
+ expected_h.insert("parameter", "value");
+ expected_h.insert("key", "value2");
+ assert_eq!(res, Ok((ini_after_parser, ("abcd", expected_h))));
+}
+
+#[test]
+fn parse_multiple_categories_test() {
+ let ini_file = "[abcd]
+
+parameter=value;abc
+
+key = value2
+
+[category]
+parameter3=value3
+key4 = value4
+";
+
+ let res = categories.parse_peek(ini_file);
+ //println!("{:?}", res);
+ match res {
+ Ok((i, ref o)) => println!("i: {} | o: {:?}", i, o),
+ _ => println!("error"),
+ }
+
+ let mut expected_1: HashMap<&str, &str> = HashMap::new();
+ expected_1.insert("parameter", "value");
+ expected_1.insert("key", "value2");
+ let mut expected_2: HashMap<&str, &str> = HashMap::new();
+ expected_2.insert("parameter3", "value3");
+ expected_2.insert("key4", "value4");
+ let mut expected_h: HashMap<&str, HashMap<&str, &str>> = HashMap::new();
+ expected_h.insert("abcd", expected_1);
+ expected_h.insert("category", expected_2);
+ assert_eq!(res, Ok(("", expected_h)));
+}
diff --git a/crates/winnow/examples/iterator.rs b/crates/winnow/examples/iterator.rs
new file mode 100644
index 0000000..5c8c731
--- /dev/null
+++ b/crates/winnow/examples/iterator.rs
@@ -0,0 +1,77 @@
+use std::collections::HashMap;
+use std::iter::Iterator;
+
+use winnow::ascii::alphanumeric1;
+use winnow::combinator::iterator;
+use winnow::combinator::{separated_pair, terminated};
+use winnow::prelude::*;
+
+fn main() {
+ let mut data = "abcabcabcabc";
+
+ fn parser<'s>(i: &mut &'s str) -> PResult<&'s str> {
+ "abc".parse_next(i)
+ }
+
+ // `from_fn` (available from Rust 1.34) can create an iterator
+ // from a closure
+ let it = std::iter::from_fn(move || {
+ match parser.parse_next(&mut data) {
+ // when successful, a parser returns a tuple of
+ // the remaining input and the output value.
+ // So we replace the captured input data with the
+ // remaining input, to be parsed on the next call
+ Ok(o) => Some(o),
+ _ => None,
+ }
+ });
+
+ for value in it {
+ println!("parser returned: {}", value);
+ }
+
+ println!("\n********************\n");
+
+ let mut data = "abcabcabcabc";
+
+ // if `from_fn` is not available, it is possible to fold
+ // over an iterator of functions
+ let res = std::iter::repeat(parser)
+ .take(3)
+ .try_fold(Vec::new(), |mut acc, mut parser| {
+ parser.parse_next(&mut data).map(|o| {
+ acc.push(o);
+ acc
+ })
+ });
+
+ // will print "parser iterator returned: Ok(("abc", ["abc", "abc", "abc"]))"
+ println!("\nparser iterator returned: {:?}", res);
+
+ println!("\n********************\n");
+
+ let data = "key1:value1,key2:value2,key3:value3,;";
+
+ // `winnow::combinator::iterator` will return an iterator
+ // producing the parsed values. Compared to the previous
+ // solutions:
+ // - we can work with a normal iterator like `from_fn`
+ // - we can get the remaining input afterwards, like with the `try_fold` trick
+ let mut winnow_it = iterator(
+ data,
+ terminated(separated_pair(alphanumeric1, ":", alphanumeric1), ","),
+ );
+
+ let res = winnow_it
+ .map(|(k, v)| (k.to_uppercase(), v))
+ .collect::<HashMap<_, _>>();
+
+ let parser_result: PResult<(_, _), ()> = winnow_it.finish();
+ let (remaining_input, ()) = parser_result.unwrap();
+
+ // will print "iterator returned {"key1": "value1", "key3": "value3", "key2": "value2"}, remaining input is ';'"
+ println!(
+ "iterator returned {:?}, remaining input is '{}'",
+ res, remaining_input
+ );
+}
diff --git a/crates/winnow/examples/json/bench.rs b/crates/winnow/examples/json/bench.rs
new file mode 100644
index 0000000..d074ba5
--- /dev/null
+++ b/crates/winnow/examples/json/bench.rs
@@ -0,0 +1,70 @@
+use winnow::prelude::*;
+use winnow::Partial;
+
+mod json;
+mod parser;
+mod parser_dispatch;
+mod parser_partial;
+
+fn json_bench(c: &mut criterion::Criterion) {
+ let data = [("small", SMALL), ("canada", CANADA)];
+ let mut group = c.benchmark_group("json");
+ for (name, sample) in data {
+ let len = sample.len();
+ group.throughput(criterion::Throughput::Bytes(len as u64));
+
+ group.bench_with_input(criterion::BenchmarkId::new("basic", name), &len, |b, _| {
+ type Error<'i> = winnow::error::InputError<parser::Stream<'i>>;
+
+ b.iter(|| parser::json::<Error>.parse_peek(sample).unwrap());
+ });
+ group.bench_with_input(criterion::BenchmarkId::new("unit", name), &len, |b, _| {
+ type Error<'i> = ();
+
+ b.iter(|| parser::json::<Error>.parse_peek(sample).unwrap());
+ });
+ group.bench_with_input(
+ criterion::BenchmarkId::new("context", name),
+ &len,
+ |b, _| {
+ type Error<'i> = winnow::error::ContextError<parser::Stream<'i>>;
+
+ b.iter(|| parser::json::<Error>.parse_peek(sample).unwrap());
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("dispatch", name),
+ &len,
+ |b, _| {
+ type Error<'i> = winnow::error::InputError<parser_dispatch::Stream<'i>>;
+
+ b.iter(|| parser_dispatch::json::<Error>.parse_peek(sample).unwrap());
+ },
+ );
+ group.bench_with_input(
+ criterion::BenchmarkId::new("streaming", name),
+ &len,
+ |b, _| {
+ type Error<'i> = winnow::error::InputError<parser_partial::Stream<'i>>;
+
+ b.iter(|| {
+ parser_partial::json::<Error>
+ .parse_peek(Partial::new(sample))
+ .unwrap()
+ });
+ },
+ );
+ }
+ group.finish();
+}
+
+const SMALL: &str = " { \"a\"\t: 42,
+ \"b\": [ \"x\", \"y\", 12 ,\"\\u2014\", \"\\uD83D\\uDE10\"] ,
+ \"c\": { \"hello\" : \"world\"
+ }
+ } ";
+
+const CANADA: &str = include_str!("../../third_party/nativejson-benchmark/data/canada.json");
+
+criterion::criterion_group!(benches, json_bench,);
+criterion::criterion_main!(benches);
diff --git a/crates/winnow/examples/json/json.rs b/crates/winnow/examples/json/json.rs
new file mode 100644
index 0000000..6912d60
--- /dev/null
+++ b/crates/winnow/examples/json/json.rs
@@ -0,0 +1,11 @@
+use std::collections::HashMap;
+
+#[derive(Debug, PartialEq, Clone)]
+pub enum JsonValue {
+ Null,
+ Boolean(bool),
+ Str(String),
+ Num(f64),
+ Array(Vec<JsonValue>),
+ Object(HashMap<String, JsonValue>),
+}
diff --git a/crates/winnow/examples/json/main.rs b/crates/winnow/examples/json/main.rs
new file mode 100644
index 0000000..be431e8
--- /dev/null
+++ b/crates/winnow/examples/json/main.rs
@@ -0,0 +1,98 @@
+mod json;
+mod parser;
+mod parser_dispatch;
+#[allow(dead_code)]
+mod parser_partial;
+
+use winnow::error::ErrorKind;
+use winnow::prelude::*;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let data = args.input.as_deref().unwrap_or(if args.invalid {
+ " { \"a\"\t: 42,
+ \"b\": [ \"x\", \"y\", 12 ] ,
+ \"c\": { 1\"hello\" : \"world\"
+ }
+ } "
+ } else {
+ " { \"a\"\t: 42,
+ \"b\": [ \"x\", \"y\", 12 ] ,
+ \"c\": { \"hello\" : \"world\"
+ }
+ } "
+ });
+
+ let result = match args.implementation {
+ Impl::Naive => parser::json::<ErrorKind>.parse(data),
+ Impl::Dispatch => parser_dispatch::json::<ErrorKind>.parse(data),
+ };
+ match result {
+ Ok(json) => {
+ println!("{:#?}", json);
+ }
+ Err(err) => {
+ if args.pretty {
+ println!("{}", err);
+ } else {
+ println!("{:#?}", err);
+ }
+ }
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+ invalid: bool,
+ pretty: bool,
+ implementation: Impl,
+}
+
+enum Impl {
+ Naive,
+ Dispatch,
+}
+
+impl Default for Impl {
+ fn default() -> Self {
+ Self::Naive
+ }
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Long("invalid") => {
+ res.invalid = true;
+ }
+ Long("pretty") => {
+ // Only case where pretty matters
+ res.pretty = true;
+ res.invalid = true;
+ }
+ Long("impl") => {
+ res.implementation = args.value()?.parse_with(|s| match s {
+ "naive" => Ok(Impl::Naive),
+ "dispatch" => Ok(Impl::Dispatch),
+ _ => Err("expected `naive`, `dispatch`"),
+ })?;
+ }
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
diff --git a/crates/winnow/examples/json/parser.rs b/crates/winnow/examples/json/parser.rs
new file mode 100644
index 0000000..e8d9c8a
--- /dev/null
+++ b/crates/winnow/examples/json/parser.rs
@@ -0,0 +1,328 @@
+use std::collections::HashMap;
+use std::str;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::float,
+ combinator::alt,
+ combinator::cut_err,
+ combinator::{delimited, preceded, separated_pair, terminated},
+ combinator::{repeat, separated},
+ error::{AddContext, ParserError},
+ token::{any, none_of, take, take_while},
+};
+
+use crate::json::JsonValue;
+
+pub type Stream<'i> = &'i str;
+
+/// The root element of a JSON parser is any value
+///
+/// A parser has the following signature:
+/// `&mut Stream -> PResult<Output, InputError>`, with `PResult` defined as:
+/// `type PResult<O, E = (I, ErrorKind)> = Result<O, Err<E>>;`
+///
+/// most of the times you can ignore the error type and use the default (but this
+/// examples shows custom error types later on!)
+///
+/// Here we use `&str` as input type, but parsers can be generic over
+/// the input type, work directly with `&[u8]`, or any other type that
+/// implements the required traits.
+pub fn json<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ delimited(ws, json_value, ws).parse_next(input)
+}
+
+/// `alt` is a combinator that tries multiple parsers one by one, until
+/// one of them succeeds
+fn json_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ // `alt` combines the each value parser. It returns the result of the first
+ // successful parser, or an error
+ alt((
+ null.value(JsonValue::Null),
+ boolean.map(JsonValue::Boolean),
+ string.map(JsonValue::Str),
+ float.map(JsonValue::Num),
+ array.map(JsonValue::Array),
+ object.map(JsonValue::Object),
+ ))
+ .parse_next(input)
+}
+
+/// `tag(string)` generates a parser that recognizes the argument string.
+///
+/// This also shows returning a sub-slice of the original input
+fn null<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // This is a parser that returns `"null"` if it sees the string "null", and
+ // an error otherwise
+ "null".parse_next(input)
+}
+
+/// We can combine `tag` with other functions, like `value` which returns a given constant value on
+/// success.
+fn boolean<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<bool, E> {
+ // This is a parser that returns `true` if it sees the string "true", and
+ // an error otherwise
+ let parse_true = "true".value(true);
+
+ // This is a parser that returns `false` if it sees the string "false", and
+ // an error otherwise
+ let parse_false = "false".value(false);
+
+ alt((parse_true, parse_false)).parse_next(input)
+}
+
+/// This parser gathers all `char`s up into a `String`with a parse to recognize the double quote
+/// character, before the string (using `preceded`) and after the string (using `terminated`).
+fn string<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<String, E> {
+ preceded(
+ '\"',
+ // `cut_err` transforms an `ErrMode::Backtrack(e)` to `ErrMode::Cut(e)`, signaling to
+ // combinators like `alt` that they should not try other parsers. We were in the
+ // right branch (since we found the `"` character) but encountered an error when
+ // parsing the string
+ cut_err(terminated(
+ repeat(0.., character).fold(String::new, |mut string, c| {
+ string.push(c);
+ string
+ }),
+ '\"',
+ )),
+ )
+ // `context` lets you add a static string to errors to provide more information in the
+ // error chain (to indicate which parser had an error)
+ .context("string")
+ .parse_next(input)
+}
+
+/// You can mix the above declarative parsing with an imperative style to handle more unique cases,
+/// like escaping
+fn character<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ let c = none_of('\"').parse_next(input)?;
+ if c == '\\' {
+ alt((
+ any.verify_map(|c| {
+ Some(match c {
+ '"' | '\\' | '/' => c,
+ 'b' => '\x08',
+ 'f' => '\x0C',
+ 'n' => '\n',
+ 'r' => '\r',
+ 't' => '\t',
+ _ => return None,
+ })
+ }),
+ preceded('u', unicode_escape),
+ ))
+ .parse_next(input)
+ } else {
+ Ok(c)
+ }
+}
+
+fn unicode_escape<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ alt((
+ // Not a surrogate
+ u16_hex
+ .verify(|cp| !(0xD800..0xE000).contains(cp))
+ .map(|cp| cp as u32),
+ // See https://en.wikipedia.org/wiki/UTF-16#Code_points_from_U+010000_to_U+10FFFF for details
+ separated_pair(u16_hex, "\\u", u16_hex)
+ .verify(|(high, low)| (0xD800..0xDC00).contains(high) && (0xDC00..0xE000).contains(low))
+ .map(|(high, low)| {
+ let high_ten = (high as u32) - 0xD800;
+ let low_ten = (low as u32) - 0xDC00;
+ (high_ten << 10) + low_ten + 0x10000
+ }),
+ ))
+ .verify_map(
+ // Could be probably replaced with .unwrap() or _unchecked due to the verify checks
+ std::char::from_u32,
+ )
+ .parse_next(input)
+}
+
+fn u16_hex<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<u16, E> {
+ take(4usize)
+ .verify_map(|s| u16::from_str_radix(s, 16).ok())
+ .parse_next(input)
+}
+
+/// Some combinators, like `separated` or `repeat`, will call a parser repeatedly,
+/// accumulating results in a `Vec`, until it encounters an error.
+/// If you want more control on the parser application, check out the `iterator`
+/// combinator (cf `examples/iterator.rs`)
+fn array<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<Vec<JsonValue>, E> {
+ preceded(
+ ('[', ws),
+ cut_err(terminated(
+ separated(0.., json_value, (ws, ',', ws)),
+ (ws, ']'),
+ )),
+ )
+ .context("array")
+ .parse_next(input)
+}
+
+fn object<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<HashMap<String, JsonValue>, E> {
+ preceded(
+ ('{', ws),
+ cut_err(terminated(
+ separated(0.., key_value, (ws, ',', ws)),
+ (ws, '}'),
+ )),
+ )
+ .context("object")
+ .parse_next(input)
+}
+
+fn key_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<(String, JsonValue), E> {
+ separated_pair(string, cut_err((ws, ':', ws)), json_value).parse_next(input)
+}
+
+/// Parser combinators are constructed from the bottom up:
+/// first we write parsers for the smallest elements (here a space character),
+/// then we'll combine them in larger parsers
+fn ws<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // Combinators like `take_while` return a function. That function is the
+ // parser,to which we can pass the input
+ take_while(0.., WS).parse_next(input)
+}
+
+const WS: &[char] = &[' ', '\t', '\r', '\n'];
+
+#[cfg(test)]
+mod test {
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ use super::*;
+
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ type Error<'i> = winnow::error::InputError<&'i str>;
+
+ #[test]
+ fn json_string() {
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"\""),
+ Ok(("", "".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"abc\""),
+ Ok(("", "abc".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>
+ .parse_peek("\"abc\\\"\\\\\\/\\b\\f\\n\\r\\t\\u0001\\u2014\u{2014}def\""),
+ Ok(("", "abc\"\\/\x08\x0C\n\r\t\x01——def".to_string())),
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"\\uD83D\\uDE10\""),
+ Ok(("", "😐".to_string()))
+ );
+
+ assert!(string::<Error<'_>>.parse_peek("\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"abc").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\u123\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\uD800\"").is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek("\"\\uD800\\uD800\"")
+ .is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\uDC00\"").is_err());
+ }
+
+ #[test]
+ fn json_object() {
+ use JsonValue::{Num, Object, Str};
+
+ let input = r#"{"a":42,"b":"x"}"#;
+
+ let expected = Object(
+ vec![
+ ("a".to_string(), Num(42.0)),
+ ("b".to_string(), Str("x".to_string())),
+ ]
+ .into_iter()
+ .collect(),
+ );
+
+ assert_eq!(json::<Error<'_>>.parse_peek(input), Ok(("", expected)));
+ }
+
+ #[test]
+ fn json_array() {
+ use JsonValue::{Array, Num, Str};
+
+ let input = r#"[42,"x"]"#;
+
+ let expected = Array(vec![Num(42.0), Str("x".to_string())]);
+
+ assert_eq!(json::<Error<'_>>.parse_peek(input), Ok(("", expected)));
+ }
+
+ #[test]
+ fn json_whitespace() {
+ use JsonValue::{Array, Boolean, Null, Num, Object, Str};
+
+ let input = r#"
+ {
+ "null" : null,
+ "true" :true ,
+ "false": false ,
+ "number" : 123e4 ,
+ "string" : " abc 123 " ,
+ "array" : [ false , 1 , "two" ] ,
+ "object" : { "a" : 1.0 , "b" : "c" } ,
+ "empty_array" : [ ] ,
+ "empty_object" : { }
+ }
+ "#;
+
+ assert_eq!(
+ json::<Error<'_>>.parse_peek(input),
+ Ok((
+ "",
+ Object(
+ vec![
+ ("null".to_string(), Null),
+ ("true".to_string(), Boolean(true)),
+ ("false".to_string(), Boolean(false)),
+ ("number".to_string(), Num(123e4)),
+ ("string".to_string(), Str(" abc 123 ".to_string())),
+ (
+ "array".to_string(),
+ Array(vec![Boolean(false), Num(1.0), Str("two".to_string())])
+ ),
+ (
+ "object".to_string(),
+ Object(
+ vec![
+ ("a".to_string(), Num(1.0)),
+ ("b".to_string(), Str("c".to_string())),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ),
+ ("empty_array".to_string(), Array(vec![]),),
+ ("empty_object".to_string(), Object(HashMap::new()),),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ))
+ );
+ }
+}
diff --git a/crates/winnow/examples/json/parser_dispatch.rs b/crates/winnow/examples/json/parser_dispatch.rs
new file mode 100644
index 0000000..11bda4f
--- /dev/null
+++ b/crates/winnow/examples/json/parser_dispatch.rs
@@ -0,0 +1,335 @@
+use std::collections::HashMap;
+use std::str;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::float,
+ combinator::cut_err,
+ combinator::empty,
+ combinator::fail,
+ combinator::peek,
+ combinator::{alt, dispatch},
+ combinator::{delimited, preceded, separated_pair, terminated},
+ combinator::{repeat, separated},
+ error::{AddContext, ParserError},
+ token::{any, none_of, take, take_while},
+};
+
+use crate::json::JsonValue;
+
+pub type Stream<'i> = &'i str;
+
+/// The root element of a JSON parser is any value
+///
+/// A parser has the following signature:
+/// `&mut Stream -> PResult<Output, InputError>`, with `PResult` defined as:
+/// `type PResult<O, E = ErrorKind> = Result<O, ErrMode<E>>;`
+///
+/// most of the times you can ignore the error type and use the default (but this
+/// examples shows custom error types later on!)
+///
+/// Here we use `&str` as input type, but parsers can be generic over
+/// the input type, work directly with `&[u8]`, or any other type that
+/// implements the required traits.
+pub fn json<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ delimited(ws, json_value, ws).parse_next(input)
+}
+
+/// `alt` is a combinator that tries multiple parsers one by one, until
+/// one of them succeeds
+fn json_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ // `dispatch` gives you `match`-like behavior compared to `alt` successively trying different
+ // implementations.
+ dispatch!(peek(any);
+ 'n' => null.value(JsonValue::Null),
+ 't' => true_.map(JsonValue::Boolean),
+ 'f' => false_.map(JsonValue::Boolean),
+ '"' => string.map(JsonValue::Str),
+ '+' => float.map(JsonValue::Num),
+ '-' => float.map(JsonValue::Num),
+ '0'..='9' => float.map(JsonValue::Num),
+ '[' => array.map(JsonValue::Array),
+ '{' => object.map(JsonValue::Object),
+ _ => fail,
+ )
+ .parse_next(input)
+}
+
+/// `tag(string)` generates a parser that recognizes the argument string.
+///
+/// This also shows returning a sub-slice of the original input
+fn null<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // This is a parser that returns `"null"` if it sees the string "null", and
+ // an error otherwise
+ "null".parse_next(input)
+}
+
+/// We can combine `tag` with other functions, like `value` which returns a given constant value on
+/// success.
+fn true_<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<bool, E> {
+ // This is a parser that returns `true` if it sees the string "true", and
+ // an error otherwise
+ "true".value(true).parse_next(input)
+}
+
+/// We can combine `tag` with other functions, like `value` which returns a given constant value on
+/// success.
+fn false_<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<bool, E> {
+ // This is a parser that returns `false` if it sees the string "false", and
+ // an error otherwise
+ "false".value(false).parse_next(input)
+}
+
+/// This parser gathers all `char`s up into a `String`with a parse to recognize the double quote
+/// character, before the string (using `preceded`) and after the string (using `terminated`).
+fn string<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<String, E> {
+ preceded(
+ '\"',
+ // `cut_err` transforms an `ErrMode::Backtrack(e)` to `ErrMode::Cut(e)`, signaling to
+ // combinators like `alt` that they should not try other parsers. We were in the
+ // right branch (since we found the `"` character) but encountered an error when
+ // parsing the string
+ cut_err(terminated(
+ repeat(0.., character).fold(String::new, |mut string, c| {
+ string.push(c);
+ string
+ }),
+ '\"',
+ )),
+ )
+ // `context` lets you add a static string to errors to provide more information in the
+ // error chain (to indicate which parser had an error)
+ .context("string")
+ .parse_next(input)
+}
+
+/// You can mix the above declarative parsing with an imperative style to handle more unique cases,
+/// like escaping
+fn character<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ let c = none_of('\"').parse_next(input)?;
+ if c == '\\' {
+ dispatch!(any;
+ '"' => empty.value('"'),
+ '\\' => empty.value('\\'),
+ '/' => empty.value('/'),
+ 'b' => empty.value('\x08'),
+ 'f' => empty.value('\x0C'),
+ 'n' => empty.value('\n'),
+ 'r' => empty.value('\r'),
+ 't' => empty.value('\t'),
+ 'u' => unicode_escape,
+ _ => fail,
+ )
+ .parse_next(input)
+ } else {
+ Ok(c)
+ }
+}
+
+fn unicode_escape<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ alt((
+ // Not a surrogate
+ u16_hex
+ .verify(|cp| !(0xD800..0xE000).contains(cp))
+ .map(|cp| cp as u32),
+ // See https://en.wikipedia.org/wiki/UTF-16#Code_points_from_U+010000_to_U+10FFFF for details
+ separated_pair(u16_hex, "\\u", u16_hex)
+ .verify(|(high, low)| (0xD800..0xDC00).contains(high) && (0xDC00..0xE000).contains(low))
+ .map(|(high, low)| {
+ let high_ten = (high as u32) - 0xD800;
+ let low_ten = (low as u32) - 0xDC00;
+ (high_ten << 10) + low_ten + 0x10000
+ }),
+ ))
+ .verify_map(
+ // Could be probably replaced with .unwrap() or _unchecked due to the verify checks
+ std::char::from_u32,
+ )
+ .parse_next(input)
+}
+
+fn u16_hex<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<u16, E> {
+ take(4usize)
+ .verify_map(|s| u16::from_str_radix(s, 16).ok())
+ .parse_next(input)
+}
+
+/// Some combinators, like `separated` or `repeat`, will call a parser repeatedly,
+/// accumulating results in a `Vec`, until it encounters an error.
+/// If you want more control on the parser application, check out the `iterator`
+/// combinator (cf `examples/iterator.rs`)
+fn array<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<Vec<JsonValue>, E> {
+ preceded(
+ ('[', ws),
+ cut_err(terminated(
+ separated(0.., json_value, (ws, ',', ws)),
+ (ws, ']'),
+ )),
+ )
+ .context("array")
+ .parse_next(input)
+}
+
+fn object<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<HashMap<String, JsonValue>, E> {
+ preceded(
+ ('{', ws),
+ cut_err(terminated(
+ separated(0.., key_value, (ws, ',', ws)),
+ (ws, '}'),
+ )),
+ )
+ .context("object")
+ .parse_next(input)
+}
+
+fn key_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<(String, JsonValue), E> {
+ separated_pair(string, cut_err((ws, ':', ws)), json_value).parse_next(input)
+}
+
+/// Parser combinators are constructed from the bottom up:
+/// first we write parsers for the smallest elements (here a space character),
+/// then we'll combine them in larger parsers
+fn ws<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // Combinators like `take_while` return a function. That function is the
+ // parser,to which we can pass the input
+ take_while(0.., WS).parse_next(input)
+}
+
+const WS: &[char] = &[' ', '\t', '\r', '\n'];
+
+#[cfg(test)]
+mod test {
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ use super::*;
+
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ type Error<'i> = winnow::error::InputError<&'i str>;
+
+ #[test]
+ fn json_string() {
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"\""),
+ Ok(("", "".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"abc\""),
+ Ok(("", "abc".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>
+ .parse_peek("\"abc\\\"\\\\\\/\\b\\f\\n\\r\\t\\u0001\\u2014\u{2014}def\""),
+ Ok(("", "abc\"\\/\x08\x0C\n\r\t\x01——def".to_string())),
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek("\"\\uD83D\\uDE10\""),
+ Ok(("", "😐".to_string()))
+ );
+
+ assert!(string::<Error<'_>>.parse_peek("\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"abc").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\u123\"").is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\uD800\"").is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek("\"\\uD800\\uD800\"")
+ .is_err());
+ assert!(string::<Error<'_>>.parse_peek("\"\\uDC00\"").is_err());
+ }
+
+ #[test]
+ fn json_object() {
+ use JsonValue::{Num, Object, Str};
+
+ let input = r#"{"a":42,"b":"x"}"#;
+
+ let expected = Object(
+ vec![
+ ("a".to_string(), Num(42.0)),
+ ("b".to_string(), Str("x".to_string())),
+ ]
+ .into_iter()
+ .collect(),
+ );
+
+ assert_eq!(json::<Error<'_>>.parse_peek(input), Ok(("", expected)));
+ }
+
+ #[test]
+ fn json_array() {
+ use JsonValue::{Array, Num, Str};
+
+ let input = r#"[42,"x"]"#;
+
+ let expected = Array(vec![Num(42.0), Str("x".to_string())]);
+
+ assert_eq!(json::<Error<'_>>.parse_peek(input), Ok(("", expected)));
+ }
+
+ #[test]
+ fn json_whitespace() {
+ use JsonValue::{Array, Boolean, Null, Num, Object, Str};
+
+ let input = r#"
+ {
+ "null" : null,
+ "true" :true ,
+ "false": false ,
+ "number" : 123e4 ,
+ "string" : " abc 123 " ,
+ "array" : [ false , 1 , "two" ] ,
+ "object" : { "a" : 1.0 , "b" : "c" } ,
+ "empty_array" : [ ] ,
+ "empty_object" : { }
+ }
+ "#;
+
+ assert_eq!(
+ json::<Error<'_>>.parse_peek(input),
+ Ok((
+ "",
+ Object(
+ vec![
+ ("null".to_string(), Null),
+ ("true".to_string(), Boolean(true)),
+ ("false".to_string(), Boolean(false)),
+ ("number".to_string(), Num(123e4)),
+ ("string".to_string(), Str(" abc 123 ".to_string())),
+ (
+ "array".to_string(),
+ Array(vec![Boolean(false), Num(1.0), Str("two".to_string())])
+ ),
+ (
+ "object".to_string(),
+ Object(
+ vec![
+ ("a".to_string(), Num(1.0)),
+ ("b".to_string(), Str("c".to_string())),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ),
+ ("empty_array".to_string(), Array(vec![]),),
+ ("empty_object".to_string(), Object(HashMap::new()),),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ))
+ );
+ }
+}
diff --git a/crates/winnow/examples/json/parser_partial.rs b/crates/winnow/examples/json/parser_partial.rs
new file mode 100644
index 0000000..31aba00
--- /dev/null
+++ b/crates/winnow/examples/json/parser_partial.rs
@@ -0,0 +1,354 @@
+use std::collections::HashMap;
+use std::str;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::float,
+ combinator::alt,
+ combinator::{cut_err, rest},
+ combinator::{delimited, preceded, separated_pair, terminated},
+ combinator::{repeat, separated},
+ error::{AddContext, ParserError},
+ stream::Partial,
+ token::{any, none_of, take, take_while},
+};
+
+use crate::json::JsonValue;
+
+pub type Stream<'i> = Partial<&'i str>;
+
+/// The root element of a JSON parser is any value
+///
+/// A parser has the following signature:
+/// `&mut Stream -> PResult<Output, InputError>`, with `PResult` defined as:
+/// `type PResult<O, E = ErrorKind> = Result<O, ErrMode<E>>;`
+///
+/// most of the times you can ignore the error type and use the default (but this
+/// examples shows custom error types later on!)
+///
+/// Here we use `&str` as input type, but parsers can be generic over
+/// the input type, work directly with `&[u8]`, or any other type that
+/// implements the required traits.
+pub fn json<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ delimited(ws, json_value, ws_or_eof).parse_next(input)
+}
+
+/// `alt` is a combinator that tries multiple parsers one by one, until
+/// one of them succeeds
+fn json_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ // `alt` combines the each value parser. It returns the result of the first
+ // successful parser, or an error
+ alt((
+ null.value(JsonValue::Null),
+ boolean.map(JsonValue::Boolean),
+ string.map(JsonValue::Str),
+ float.map(JsonValue::Num),
+ array.map(JsonValue::Array),
+ object.map(JsonValue::Object),
+ ))
+ .parse_next(input)
+}
+
+/// `tag(string)` generates a parser that recognizes the argument string.
+///
+/// This also shows returning a sub-slice of the original input
+fn null<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // This is a parser that returns `"null"` if it sees the string "null", and
+ // an error otherwise
+ "null".parse_next(input)
+}
+
+/// We can combine `tag` with other functions, like `value` which returns a given constant value on
+/// success.
+fn boolean<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<bool, E> {
+ // This is a parser that returns `true` if it sees the string "true", and
+ // an error otherwise
+ let parse_true = "true".value(true);
+
+ // This is a parser that returns `false` if it sees the string "false", and
+ // an error otherwise
+ let parse_false = "false".value(false);
+
+ alt((parse_true, parse_false)).parse_next(input)
+}
+
+/// This parser gathers all `char`s up into a `String`with a parse to recognize the double quote
+/// character, before the string (using `preceded`) and after the string (using `terminated`).
+fn string<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<String, E> {
+ preceded(
+ '\"',
+ // `cut_err` transforms an `ErrMode::Backtrack(e)` to `ErrMode::Cut(e)`, signaling to
+ // combinators like `alt` that they should not try other parsers. We were in the
+ // right branch (since we found the `"` character) but encountered an error when
+ // parsing the string
+ cut_err(terminated(
+ repeat(0.., character).fold(String::new, |mut string, c| {
+ string.push(c);
+ string
+ }),
+ '\"',
+ )),
+ )
+ // `context` lets you add a static string to errors to provide more information in the
+ // error chain (to indicate which parser had an error)
+ .context("string")
+ .parse_next(input)
+}
+
+/// You can mix the above declarative parsing with an imperative style to handle more unique cases,
+/// like escaping
+fn character<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ let c = none_of('\"').parse_next(input)?;
+ if c == '\\' {
+ alt((
+ any.verify_map(|c| {
+ Some(match c {
+ '"' | '\\' | '/' => c,
+ 'b' => '\x08',
+ 'f' => '\x0C',
+ 'n' => '\n',
+ 'r' => '\r',
+ 't' => '\t',
+ _ => return None,
+ })
+ }),
+ preceded('u', unicode_escape),
+ ))
+ .parse_next(input)
+ } else {
+ Ok(c)
+ }
+}
+
+fn unicode_escape<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ alt((
+ // Not a surrogate
+ u16_hex
+ .verify(|cp| !(0xD800..0xE000).contains(cp))
+ .map(|cp| cp as u32),
+ // See https://en.wikipedia.org/wiki/UTF-16#Code_points_from_U+010000_to_U+10FFFF for details
+ separated_pair(u16_hex, "\\u", u16_hex)
+ .verify(|(high, low)| (0xD800..0xDC00).contains(high) && (0xDC00..0xE000).contains(low))
+ .map(|(high, low)| {
+ let high_ten = (high as u32) - 0xD800;
+ let low_ten = (low as u32) - 0xDC00;
+ (high_ten << 10) + low_ten + 0x10000
+ }),
+ ))
+ .verify_map(
+ // Could be probably replaced with .unwrap() or _unchecked due to the verify checks
+ std::char::from_u32,
+ )
+ .parse_next(input)
+}
+
+fn u16_hex<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<u16, E> {
+ take(4usize)
+ .verify_map(|s| u16::from_str_radix(s, 16).ok())
+ .parse_next(input)
+}
+
+/// Some combinators, like `separated` or `repeat`, will call a parser repeatedly,
+/// accumulating results in a `Vec`, until it encounters an error.
+/// If you want more control on the parser application, check out the `iterator`
+/// combinator (cf `examples/iterator.rs`)
+fn array<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<Vec<JsonValue>, E> {
+ preceded(
+ ('[', ws),
+ cut_err(terminated(
+ separated(0.., json_value, (ws, ',', ws)),
+ (ws, ']'),
+ )),
+ )
+ .context("array")
+ .parse_next(input)
+}
+
+fn object<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<HashMap<String, JsonValue>, E> {
+ preceded(
+ ('{', ws),
+ cut_err(terminated(
+ separated(0.., key_value, (ws, ',', ws)),
+ (ws, '}'),
+ )),
+ )
+ .context("object")
+ .parse_next(input)
+}
+
+fn key_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<(String, JsonValue), E> {
+ separated_pair(string, cut_err((ws, ':', ws)), json_value).parse_next(input)
+}
+
+/// Parser combinators are constructed from the bottom up:
+/// first we write parsers for the smallest elements (here a space character),
+/// then we'll combine them in larger parsers
+fn ws<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // Combinators like `take_while` return a function. That function is the
+ // parser,to which we can pass the input
+ take_while(0.., WS).parse_next(input)
+}
+
+fn ws_or_eof<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ rest.verify(|s: &str| s.chars().all(|c| WS.contains(&c)))
+ .parse_next(input)
+}
+
+const WS: &[char] = &[' ', '\t', '\r', '\n'];
+
+#[cfg(test)]
+mod test {
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ use super::*;
+
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ type Error<'i> = winnow::error::InputError<Partial<&'i str>>;
+
+ #[test]
+ fn json_string() {
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"\"")),
+ Ok((Partial::new(""), "".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"abc\"")),
+ Ok((Partial::new(""), "abc".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new(
+ "\"abc\\\"\\\\\\/\\b\\f\\n\\r\\t\\u0001\\u2014\u{2014}def\""
+ )),
+ Ok((
+ Partial::new(""),
+ "abc\"\\/\x08\x0C\n\r\t\x01——def".to_string()
+ )),
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"\\uD83D\\uDE10\"")),
+ Ok((Partial::new(""), "😐".to_string()))
+ );
+
+ assert!(string::<Error<'_>>.parse_peek(Partial::new("\"")).is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"abc"))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\u123\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uD800\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uD800\\uD800\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uDC00\""))
+ .is_err());
+ }
+
+ #[test]
+ fn json_object() {
+ use JsonValue::{Num, Object, Str};
+
+ let input = r#"{"a":42,"b":"x"}"#;
+
+ let expected = Object(
+ vec![
+ ("a".to_string(), Num(42.0)),
+ ("b".to_string(), Str("x".to_string())),
+ ]
+ .into_iter()
+ .collect(),
+ );
+
+ assert_eq!(
+ json::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((Partial::new(""), expected))
+ );
+ }
+
+ #[test]
+ fn json_array() {
+ use JsonValue::{Array, Num, Str};
+
+ let input = r#"[42,"x"]"#;
+
+ let expected = Array(vec![Num(42.0), Str("x".to_string())]);
+
+ assert_eq!(
+ json::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((Partial::new(""), expected))
+ );
+ }
+
+ #[test]
+ fn json_whitespace() {
+ use JsonValue::{Array, Boolean, Null, Num, Object, Str};
+
+ let input = r#"
+ {
+ "null" : null,
+ "true" :true ,
+ "false": false ,
+ "number" : 123e4 ,
+ "string" : " abc 123 " ,
+ "array" : [ false , 1 , "two" ] ,
+ "object" : { "a" : 1.0 , "b" : "c" } ,
+ "empty_array" : [ ] ,
+ "empty_object" : { }
+ }
+ "#;
+
+ assert_eq!(
+ json::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((
+ Partial::new(""),
+ Object(
+ vec![
+ ("null".to_string(), Null),
+ ("true".to_string(), Boolean(true)),
+ ("false".to_string(), Boolean(false)),
+ ("number".to_string(), Num(123e4)),
+ ("string".to_string(), Str(" abc 123 ".to_string())),
+ (
+ "array".to_string(),
+ Array(vec![Boolean(false), Num(1.0), Str("two".to_string())])
+ ),
+ (
+ "object".to_string(),
+ Object(
+ vec![
+ ("a".to_string(), Num(1.0)),
+ ("b".to_string(), Str("c".to_string())),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ),
+ ("empty_array".to_string(), Array(vec![]),),
+ ("empty_object".to_string(), Object(HashMap::new()),),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ))
+ );
+ }
+}
diff --git a/crates/winnow/examples/json_iterator.rs b/crates/winnow/examples/json_iterator.rs
new file mode 100644
index 0000000..9c21ae3
--- /dev/null
+++ b/crates/winnow/examples/json_iterator.rs
@@ -0,0 +1,311 @@
+use std::collections::HashMap;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::{alphanumeric1 as alphanumeric, escaped, float},
+ combinator::alt,
+ combinator::cut_err,
+ combinator::separated,
+ combinator::{preceded, separated_pair, terminated},
+ error::ParserError,
+ error::StrContext,
+ stream::Offset,
+ token::one_of,
+ token::{tag, take_while},
+};
+
+use std::cell::Cell;
+use std::str;
+
+#[derive(Clone, Debug)]
+pub struct JsonValue<'a, 'b> {
+ input: &'a str,
+ pub offset: &'b Cell<usize>,
+}
+
+impl<'a, 'b: 'a> JsonValue<'a, 'b> {
+ pub fn new(input: &'a str, offset: &'b Cell<usize>) -> JsonValue<'a, 'b> {
+ JsonValue { input, offset }
+ }
+
+ pub fn offset(&self, input: &'a str) {
+ let offset = input.offset_from(&self.input);
+ self.offset.set(offset);
+ }
+
+ pub fn data(&self) -> &'a str {
+ &self.input[self.offset.get()..]
+ }
+
+ pub fn string(&self) -> Option<&'a str> {
+ println!("string()");
+ let mut data = self.data();
+ match string(&mut data) {
+ Ok(s) => {
+ self.offset(data);
+ println!("-> {}", s);
+ Some(s)
+ }
+ _ => None,
+ }
+ }
+
+ pub fn boolean(&self) -> Option<bool> {
+ println!("boolean()");
+ let mut data = self.data();
+ match boolean(&mut data) {
+ Ok(o) => {
+ self.offset(data);
+ println!("-> {}", o);
+ Some(o)
+ }
+ _ => None,
+ }
+ }
+
+ pub fn number(&self) -> Option<f64> {
+ println!("number()");
+ let mut data = self.data();
+ match float::<_, _, ()>.parse_next(&mut data) {
+ Ok(o) => {
+ self.offset(data);
+ println!("-> {}", o);
+ Some(o)
+ }
+ _ => None,
+ }
+ }
+
+ pub fn array(&self) -> Option<impl Iterator<Item = JsonValue<'a, 'b>>> {
+ println!("array()");
+
+ let mut data = self.data();
+ match tag::<_, _, ()>("[").parse_next(&mut data) {
+ Err(_) => None,
+ Ok(_) => {
+ println!("[");
+ self.offset(data);
+ let mut first = true;
+ let mut done = false;
+ let mut previous = std::usize::MAX;
+
+ let v = self.clone();
+
+ Some(std::iter::from_fn(move || {
+ if done {
+ return None;
+ }
+
+ // if we ignored one of the items, skip over the value
+ if v.offset.get() == previous {
+ println!("skipping value");
+ if value(&mut data).is_ok() {
+ v.offset(data);
+ }
+ }
+
+ if tag::<_, _, ()>("]").parse_next(&mut data).is_ok() {
+ println!("]");
+ v.offset(data);
+ done = true;
+ return None;
+ }
+
+ if first {
+ first = false;
+ } else {
+ match tag::<_, _, ()>(",").parse_next(&mut data) {
+ Ok(_) => {
+ println!(",");
+ v.offset(data);
+ }
+ Err(_) => {
+ done = true;
+ return None;
+ }
+ }
+ }
+
+ println!("-> {}", v.data());
+ previous = v.offset.get();
+ Some(v.clone())
+ }))
+ }
+ }
+ }
+
+ pub fn object(&self) -> Option<impl Iterator<Item = (&'a str, JsonValue<'a, 'b>)>> {
+ println!("object()");
+ let mut data = self.data();
+ match tag::<_, _, ()>("{").parse_next(&mut data) {
+ Err(_) => None,
+ Ok(_) => {
+ self.offset(data);
+
+ println!("{{");
+
+ let mut first = true;
+ let mut done = false;
+ let mut previous = std::usize::MAX;
+
+ let v = self.clone();
+
+ Some(std::iter::from_fn(move || {
+ if done {
+ return None;
+ }
+
+ // if we ignored one of the items, skip over the value
+ if v.offset.get() == previous {
+ println!("skipping value");
+ if value(&mut data).is_ok() {
+ v.offset(data);
+ }
+ }
+
+ if tag::<_, _, ()>("}").parse_next(&mut data).is_ok() {
+ println!("}}");
+ v.offset(data);
+ done = true;
+ return None;
+ }
+
+ if first {
+ first = false;
+ } else {
+ match tag::<_, _, ()>(",").parse_next(&mut data) {
+ Ok(_) => {
+ println!(",");
+ v.offset(data);
+ }
+ Err(_) => {
+ done = true;
+ return None;
+ }
+ }
+ }
+
+ match string(&mut data) {
+ Ok(key) => {
+ v.offset(data);
+
+ match tag::<_, _, ()>(":").parse_next(&mut data) {
+ Err(_) => None,
+ Ok(_) => {
+ v.offset(data);
+
+ previous = v.offset.get();
+
+ println!("-> {} => {}", key, v.data());
+ Some((key, v.clone()))
+ }
+ }
+ }
+ _ => None,
+ }
+ }))
+ }
+ }
+ }
+}
+
+fn sp<'a, E: ParserError<&'a str>>(i: &mut &'a str) -> PResult<&'a str, E> {
+ let chars = " \t\r\n";
+
+ take_while(0.., move |c| chars.contains(c)).parse_next(i)
+}
+
+fn parse_str<'a, E: ParserError<&'a str>>(i: &mut &'a str) -> PResult<&'a str, E> {
+ escaped(alphanumeric, '\\', one_of(['"', 'n', '\\'])).parse_next(i)
+}
+
+fn string<'s>(i: &mut &'s str) -> PResult<&'s str> {
+ preceded('\"', cut_err(terminated(parse_str, '\"')))
+ .context(StrContext::Label("string"))
+ .parse_next(i)
+}
+
+fn boolean(input: &mut &str) -> PResult<bool> {
+ alt(("false".map(|_| false), "true".map(|_| true))).parse_next(input)
+}
+
+fn array(i: &mut &str) -> PResult<()> {
+ preceded(
+ '[',
+ cut_err(terminated(
+ separated(0.., value, preceded(sp, ',')),
+ preceded(sp, ']'),
+ )),
+ )
+ .context(StrContext::Label("array"))
+ .parse_next(i)
+}
+
+fn key_value<'s>(i: &mut &'s str) -> PResult<(&'s str, ())> {
+ separated_pair(preceded(sp, string), cut_err(preceded(sp, ':')), value).parse_next(i)
+}
+
+fn hash(i: &mut &str) -> PResult<()> {
+ preceded(
+ '{',
+ cut_err(terminated(
+ separated(0.., key_value, preceded(sp, ',')),
+ preceded(sp, '}'),
+ )),
+ )
+ .context(StrContext::Label("map"))
+ .parse_next(i)
+}
+
+fn value(i: &mut &str) -> PResult<()> {
+ preceded(
+ sp,
+ alt((
+ hash,
+ array,
+ string.map(|_| ()),
+ float::<_, f64, _>.map(|_| ()),
+ boolean.map(|_| ()),
+ )),
+ )
+ .parse_next(i)
+}
+
+/// object(input) -> iterator over (key, `JsonValue`)
+/// array(input) -> iterator over `JsonValue`
+///
+/// JsonValue.string -> iterator over String (returns None after first successful call)
+///
+/// object(input).filter(|(k, _)| k == "users").flatten(|(_, v)| v.object()).filter(|(k, _)| k == "city").flatten(|(_,v)| v.string())
+fn main() {
+ /*let data = "{
+ \"users\": {
+ \"user1\" : { \"city\": \"Nantes\", \"country\": \"France\" },
+ \"user2\" : { \"city\": \"Bruxelles\", \"country\": \"Belgium\" },
+ \"user3\": { \"city\": \"Paris\", \"country\": \"France\", \"age\": 30 }
+ },
+ \"countries\": [\"France\", \"Belgium\"]
+ }";
+ */
+ let data = "{\"users\":{\"user1\":{\"city\":\"Nantes\",\"country\":\"France\"},\"user2\":{\"city\":\"Bruxelles\",\"country\":\"Belgium\"},\"user3\":{\"city\":\"Paris\",\"country\":\"France\",\"age\":30}},\"countries\":[\"France\",\"Belgium\"]}";
+
+ let offset = Cell::new(0);
+ {
+ let parser = JsonValue::new(data, &offset);
+
+ if let Some(o) = parser.object() {
+ let s: HashMap<&str, &str> = o
+ .filter(|(k, _)| *k == "users")
+ .filter_map(|(_, v)| v.object())
+ .flatten()
+ .filter_map(|(user, v)| v.object().map(|o| (user, o)))
+ .flat_map(|(user, o)| {
+ o.filter(|(k, _)| *k == "city")
+ .filter_map(move |(_, v)| v.string().map(|s| (user, s)))
+ })
+ .collect();
+
+ println!("res = {:?}", s);
+ }
+ };
+}
diff --git a/crates/winnow/examples/ndjson/example.ndjson b/crates/winnow/examples/ndjson/example.ndjson
new file mode 100644
index 0000000..7f1fca0
--- /dev/null
+++ b/crates/winnow/examples/ndjson/example.ndjson
@@ -0,0 +1,158 @@
+{"reason":"compiler-artifact","package_id":"proc-macro2 1.0.46 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proc-macro2-1.0.46/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proc-macro2-1.0.46/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","proc-macro"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/proc-macro2-d6a7808ec27a845d/build-script-build"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"proc-macro2 1.0.46 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["use_proc_macro","wrap_proc_macro"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/proc-macro2-e500f83d0dabcc00/out"}
+{"reason":"compiler-artifact","package_id":"quote 1.0.21 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quote-1.0.21/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quote-1.0.21/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","proc-macro"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/quote-e70da9bace8e108a/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"libc 0.2.139 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/libc-0.2.139/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/libc-0.2.139/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","extra_traits","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/libc-ea536a8e67e0b7eb/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"unicode-ident 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-ident-1.0.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"unicode-ident","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-ident-1.0.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libunicode_ident-e72d3e3fa5fdcbf4.rlib","/home/epage/src/personal/winnow/target/debug/deps/libunicode_ident-e72d3e3fa5fdcbf4.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"proc-macro2 1.0.46 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proc-macro2-1.0.46/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"proc-macro2","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proc-macro2-1.0.46/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","proc-macro"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libproc_macro2-559e547b03a7ac1e.rlib","/home/epage/src/personal/winnow/target/debug/deps/libproc_macro2-559e547b03a7ac1e.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"libc 0.2.139 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["freebsd11","libc_priv_mod_use","libc_union","libc_const_size_of","libc_align","libc_int128","libc_core_cvoid","libc_packedN","libc_cfg_target_vendor","libc_non_exhaustive","libc_ptr_addr_of","libc_underscore_const_names","libc_const_extern_fn"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/libc-94d2f48bd38a8056/out"}
+{"reason":"build-script-executed","package_id":"quote 1.0.21 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/quote-a2754428d152a498/out"}
+{"reason":"compiler-artifact","package_id":"syn 1.0.102 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.102/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.102/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["clone-impls","default","derive","parsing","printing","proc-macro","quote"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/syn-c9e8af729632e4e4/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"cfg-if 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/cfg-if-1.0.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"cfg-if","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/cfg-if-1.0.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcfg_if-047a17fcf848a7e5.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"autocfg 1.1.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/autocfg-1.1.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"autocfg","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/autocfg-1.1.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libautocfg-25db3455927a66e1.rlib","/home/epage/src/personal/winnow/target/debug/deps/libautocfg-25db3455927a66e1.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde_derive 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_derive-1.0.145/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_derive-1.0.145/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/serde_derive-fcc2f4aec2a2d4ab/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde-1.0.145/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde-1.0.145/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","derive","serde_derive","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/serde-3f78a53b92e21d4d/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"libc 0.2.139 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/libc-0.2.139/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"libc","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/libc-0.2.139/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","extra_traits","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liblibc-5b6dd9f3e6fc0120.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"quote 1.0.21 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quote-1.0.21/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"quote","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quote-1.0.21/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","proc-macro"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libquote-9a0c3a96b2cdc59c.rlib","/home/epage/src/personal/winnow/target/debug/deps/libquote-9a0c3a96b2cdc59c.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"syn 1.0.102 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["syn_disable_nightly_tests"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/syn-0a9a191063f1b2fc/out"}
+{"reason":"build-script-executed","package_id":"serde_derive 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/serde_derive-ead5e900bac8546f/out"}
+{"reason":"build-script-executed","package_id":"serde 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/serde-03f4af86861cbc3e/out"}
+{"reason":"compiler-artifact","package_id":"thiserror 1.0.38 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/thiserror-66462325c558a4d5/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"ryu 1.0.11 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ryu-1.0.11/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"ryu","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ryu-1.0.11/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libryu-0e7b0d46c4589f15.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-utils 0.8.12 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-utils-0.8.12/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-utils-0.8.12/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/crossbeam-utils-c9170234d86239e2/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"memchr 2.5.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memchr-2.5.0/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memchr-2.5.0/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/memchr-99ffc1dfd2c517c1/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde_json 1.0.86 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_json-1.0.86/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_json-1.0.86/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/serde_json-3051866d1babe853/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"memoffset 0.6.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memoffset-0.6.5/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memoffset-0.6.5/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/memoffset-37767cb27e2441e6/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"bitflags 1.3.2 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bitflags-1.3.2/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"bitflags","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bitflags-1.3.2/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbitflags-ea9a4e086e887550.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"itoa 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itoa-1.0.4/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"itoa","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itoa-1.0.4/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libitoa-69c375d2fd4189a8.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-epoch 0.9.11 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-epoch-0.9.11/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-epoch-0.9.11/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/crossbeam-epoch-ec0452f91ac732bb/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"ucd-trie 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ucd-trie-0.1.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"ucd-trie","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ucd-trie-0.1.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libucd_trie-eb38f7c85a03bb9d.rlib","/home/epage/src/personal/winnow/target/debug/deps/libucd_trie-eb38f7c85a03bb9d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"io-lifetimes 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/io-lifetimes-1.0.5/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/io-lifetimes-1.0.5/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["close","default","libc","windows-sys"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/io-lifetimes-18d168bedd0c64e8/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"log 0.4.17 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/log-0.4.17/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/log-0.4.17/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/log-52c513d099058ca0/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"num-traits 0.2.15 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/num-traits-77d338745cc017c3/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rayon-core 1.9.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.3/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.3/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/rayon-core-eecac7c574986103/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rustix 0.36.8 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rustix-0.36.8/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rustix-0.36.8/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","io-lifetimes","libc","std","termios","use-libc-auxv"],"filenames":["/home/epage/src/personal/winnow/target/debug/build/rustix-32859c5d0061115d/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"syn 1.0.102 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.102/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"syn","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/syn-1.0.102/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["clone-impls","default","derive","parsing","printing","proc-macro","quote"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libsyn-c9741af862298610.rlib","/home/epage/src/personal/winnow/target/debug/deps/libsyn-c9741af862298610.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"thiserror 1.0.38 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/thiserror-37d8ebe1b01cc51d/out"}
+{"reason":"build-script-executed","package_id":"memchr 2.5.0 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["memchr_runtime_simd","memchr_runtime_sse2","memchr_runtime_sse42","memchr_runtime_avx"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/memchr-743d739a8480f48a/out"}
+{"reason":"build-script-executed","package_id":"crossbeam-utils 0.8.12 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/crossbeam-utils-1975bdb7ecfbff2a/out"}
+{"reason":"build-script-executed","package_id":"serde_json 1.0.86 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["limb_width_64"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/serde_json-3f569e9655a7cd7e/out"}
+{"reason":"build-script-executed","package_id":"memoffset 0.6.5 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["tuple_ty","allow_clippy","maybe_uninit","doctests","raw_ref_macros"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/memoffset-27100c1e8e709074/out"}
+{"reason":"build-script-executed","package_id":"crossbeam-epoch 0.9.11 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/crossbeam-epoch-7f643445aebfa633/out"}
+{"reason":"compiler-artifact","package_id":"getrandom 0.2.7 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.7/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"getrandom","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.7/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libgetrandom-d2efdd8bbd217458.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"log 0.4.17 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["atomic_cas","has_atomics"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/log-b56bc898d3207792/out"}
+{"reason":"build-script-executed","package_id":"io-lifetimes 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["io_safety_is_in_std","panic_in_const_fn"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/io-lifetimes-701560b8574ef205/out"}
+{"reason":"compiler-artifact","package_id":"once_cell 1.15.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"once_cell","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","race","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libonce_cell-c9f9ea925d35da52.rlib","/home/epage/src/personal/winnow/target/debug/deps/libonce_cell-c9f9ea925d35da52.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"scopeguard 1.1.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/scopeguard-1.1.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"scopeguard","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/scopeguard-1.1.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libscopeguard-13a4bbff1ce24cc7.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"rayon-core 1.9.3 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/rayon-core-b008d521ccec1e7b/out"}
+{"reason":"build-script-executed","package_id":"rustix 0.36.8 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["linux_raw","asm"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/rustix-e16304a596230d21/out"}
+{"reason":"build-script-executed","package_id":"num-traits 0.2.15 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["has_i128","has_to_int_unchecked","has_reverse_bits","has_leading_trailing_ones","has_int_assignop_ref","has_div_euclid","has_copysign"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/num-traits-6888d3d0832572a9/out"}
+{"reason":"compiler-artifact","package_id":"lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/lazy_static-1.4.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"lazy_static","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/lazy_static-1.4.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liblazy_static-afa8b761bb5d6b57.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"unicode-width 0.1.10 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-width-0.1.10/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"unicode-width","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-width-0.1.10/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libunicode_width-8dcd31c030e77d42.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"either 1.8.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/either-1.8.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"either","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/either-1.8.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["use_std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libeither-3c87d508139ef632.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"linux-raw-sys 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/linux-raw-sys-0.1.4/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"linux-raw-sys","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/linux-raw-sys-0.1.4/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["errno","general","ioctl","no_std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liblinux_raw_sys-297593f8ceab708f.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"num_cpus 1.13.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num_cpus-1.13.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"num_cpus","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num_cpus-1.13.1/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libnum_cpus-539d2b6f1744794b.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde_derive 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_derive-1.0.145/Cargo.toml","target":{"kind":["proc-macro"],"crate_types":["proc-macro"],"name":"serde_derive","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_derive-1.0.145/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libserde_derive-7934298a61c1a1a2.so"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"thiserror-impl 1.0.38 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-impl-1.0.38/Cargo.toml","target":{"kind":["proc-macro"],"crate_types":["proc-macro"],"name":"thiserror-impl","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-impl-1.0.38/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libthiserror_impl-213d86e6d4b69b5f.so"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"memchr 2.5.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memchr-2.5.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"memchr","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memchr-2.5.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libmemchr-ae9722f3894e3314.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-utils 0.8.12 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-utils-0.8.12/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"crossbeam-utils","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-utils-0.8.12/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcrossbeam_utils-59f0a08b7eefe073.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"memoffset 0.6.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memoffset-0.6.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"memoffset","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/memoffset-0.6.5/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libmemoffset-4787845978faa8b8.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"io-lifetimes 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/io-lifetimes-1.0.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"io-lifetimes","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/io-lifetimes-1.0.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["close","default","libc","windows-sys"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libio_lifetimes-0d158e24024d572c.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"log 0.4.17 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/log-0.4.17/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"log","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/log-0.4.17/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liblog-3242a8c3b3d72769.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rand_core 0.6.4 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_core-0.6.4/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rand_core","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_core-0.6.4/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","getrandom","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librand_core-aa1df72cb81e420e.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"num-traits 0.2.15 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"num-traits","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/num-traits-0.2.15/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libnum_traits-1c8d0251ac4ea61d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rayon 1.5.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-1.5.3/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-1.5.3/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/rayon-4f0513187044c0f2/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"escargot 0.5.7 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/escargot-0.5.7/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/escargot-0.5.7/build.rs","edition":"2018","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/escargot-44a89e78cfd0d26f/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"yansi 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/yansi-0.5.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"yansi","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/yansi-0.5.1/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libyansi-62809433fc3ff8e9.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"regex-automata 0.1.10 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-automata-0.1.10/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"regex-automata","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-automata-0.1.10/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libregex_automata-741e79c4b6938d7d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"remove_dir_all 0.5.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/remove_dir_all-0.5.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"remove_dir_all","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/remove_dir_all-0.5.3/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libremove_dir_all-bcafaf4f00d8e4a4.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"regex-syntax 0.6.27 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-syntax-0.6.27/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"regex-syntax","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-syntax-0.6.27/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","unicode","unicode-age","unicode-bool","unicode-case","unicode-gencat","unicode-perl","unicode-script","unicode-segment"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libregex_syntax-3fe0a07eb00f644f.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"ucd-trie 0.1.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ucd-trie-0.1.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"ucd-trie","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ucd-trie-0.1.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libucd_trie-b01a07ea40c7e7ed.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"plotters-backend 0.3.4 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-backend-0.3.4/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"plotters-backend","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-backend-0.3.4/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libplotters_backend-34c8fa8c2b121eeb.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"ppv-lite86 0.2.16 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ppv-lite86-0.2.16/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"ppv-lite86","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/ppv-lite86-0.2.16/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["simd","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libppv_lite86-3b9c603c4b32aff6.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"fastrand 1.8.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/fastrand-1.8.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"fastrand","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/fastrand-1.8.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libfastrand-52ad6b37c39c8a90.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"itertools 0.10.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.10.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"itertools","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itertools-0.10.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","use_alloc","use_std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libitertools-ba05d1064477b941.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde 1.0.145 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde-1.0.145/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"serde","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde-1.0.145/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","derive","serde_derive","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libserde-e026f194fb97de03.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"thiserror 1.0.38 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"thiserror","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libthiserror-4481f6326f711f93.rlib","/home/epage/src/personal/winnow/target/debug/deps/libthiserror-4481f6326f711f93.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-epoch 0.9.11 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-epoch-0.9.11/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"crossbeam-epoch","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-epoch-0.9.11/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcrossbeam_epoch-caa786e06425cee9.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"thiserror 1.0.38 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"thiserror","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/thiserror-1.0.38/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libthiserror-9187d79370422188.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rustix 0.36.8 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rustix-0.36.8/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rustix","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rustix-0.36.8/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","io-lifetimes","libc","std","termios","use-libc-auxv"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librustix-ec48622574cca747.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-channel 0.5.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-channel-0.5.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"crossbeam-channel","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-channel-0.5.6/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["crossbeam-utils","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcrossbeam_channel-a9b11ccef7773884.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"escargot 0.5.7 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/escargot-5711ac23b4781245/out"}
+{"reason":"compiler-artifact","package_id":"tempfile 3.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/tempfile-3.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"tempfile","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/tempfile-3.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libtempfile-8b83de608c2a0658.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rand_chacha 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_chacha-0.3.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rand_chacha","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_chacha-0.3.1/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librand_chacha-5967d0068d39b018.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"rayon 1.5.3 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":["has_step_by_rev","has_min_const_generics","has_control_flow"],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/rayon-d01aa17f59a1e98f/out"}
+{"reason":"compiler-artifact","package_id":"plotters-svg 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-svg-0.3.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"plotters-svg","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-svg-0.3.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libplotters_svg-2bb014e4a5d863b1.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"csv-core 0.1.10 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/csv-core-0.1.10/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"csv-core","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/csv-core-0.1.10/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcsv_core-bf47a6ecf716f212.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"textwrap 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/textwrap-0.11.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"textwrap","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/textwrap-0.11.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libtextwrap-1f9a5b633ba2872d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"atty 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/atty-0.2.14/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"atty","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/atty-0.2.14/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libatty-7590cc9da5872c3b.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"wait-timeout 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/wait-timeout-0.2.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"wait-timeout","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/wait-timeout-0.2.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libwait_timeout-d79299ed1c2df76b.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"diff 0.1.13 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/diff-0.1.13/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"diff","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/diff-0.1.13/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libdiff-a3c1327ada950886.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"concolor-query 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/concolor-query-0.1.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"concolor-query","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/concolor-query-0.1.0/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["windows"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libconcolor_query-1b1f33bda6da9636.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"same-file 1.0.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/same-file-1.0.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"same-file","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/same-file-1.0.6/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libsame_file-8dba8c6e6bbcef0a.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"bit-vec 0.6.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bit-vec-0.6.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"bit-vec","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bit-vec-0.6.3/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbit_vec-5cc1be6dbbb7d172.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"fnv 1.0.7 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/fnv-1.0.7/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"fnv","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/fnv-1.0.7/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libfnv-e811c8615aede027.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde_json 1.0.86 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_json-1.0.86/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"serde_json","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_json-1.0.86/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libserde_json-10d232e85191c379.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pest 2.5.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest-2.5.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"pest","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest-2.5.5/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std","thiserror"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpest-c28124a2ace8ce41.rlib","/home/epage/src/personal/winnow/target/debug/deps/libpest-c28124a2ace8ce41.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"crossbeam-deque 0.8.2 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-deque-0.8.2/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"crossbeam-deque","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-deque-0.8.2/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["crossbeam-epoch","crossbeam-utils","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcrossbeam_deque-a531937c1e514cf3.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"bstr 0.2.17 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bstr-0.2.17/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"bstr","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bstr-0.2.17/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","lazy_static","regex-automata","serde","serde1","serde1-nostd","std","unicode"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbstr-3245cbc7e1b4eee0.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"is-terminal 0.4.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/is-terminal-0.4.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"is-terminal","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/is-terminal-0.4.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libis_terminal-ddb4d6f1cea88415.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pest 2.5.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest-2.5.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"pest","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest-2.5.5/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std","thiserror"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpest-3fe2406158c36e91.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"doc-comment 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/doc-comment-0.3.3/Cargo.toml","target":{"kind":["custom-build"],"crate_types":["bin"],"name":"build-script-build","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/doc-comment-0.3.3/build.rs","edition":"2015","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/build/doc-comment-476a3be5ae9523a0/build-script-build"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"cast 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/cast-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"cast","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/cast-0.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcast-0f6ca0f808d89c22.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"half 1.8.2 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/half-1.8.2/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"half","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/half-1.8.2/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libhalf-ec0164f76c2e0030.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"quick-error 1.2.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-error-1.2.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"quick-error","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-error-1.2.3/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libquick_error-e7675fcf1fdb276d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"once_cell 1.15.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"once_cell","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/once_cell-1.15.0/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","race","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libonce_cell-6a83ca81f3790104.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"itoa 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itoa-0.4.8/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"itoa","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/itoa-0.4.8/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libitoa-af0357b7d39004b0.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"plotters 0.3.4 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-0.3.4/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"plotters","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/plotters-0.3.4/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["area_series","line_series","plotters-svg","svg_backend"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libplotters-c6ddec411d8166e5.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"walkdir 2.3.2 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/walkdir-2.3.2/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"walkdir","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/walkdir-2.3.2/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libwalkdir-9e7e41a0b2bf038d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"bit-set 0.5.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bit-set-0.5.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"bit-set","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bit-set-0.5.3/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbit_set-2aef4909cbe7f4dc.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pretty_assertions 1.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pretty_assertions-1.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"pretty_assertions","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pretty_assertions-1.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpretty_assertions-917f731810bb748b.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"clap 2.34.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"clap","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libclap-af397f0f338fc8b9.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rand 0.8.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand-0.8.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rand","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand-0.8.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","getrandom","libc","rand_chacha","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librand-79231f927b479fcb.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"quick-xml 0.23.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-xml-0.23.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"quick-xml","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-xml-0.23.1/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libquick_xml-56f1f63175d80ec8.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rand_xorshift 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_xorshift-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rand_xorshift","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rand_xorshift-0.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librand_xorshift-52cda07a05fef0b5.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pest_meta 2.5.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_meta-2.5.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"pest_meta","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_meta-2.5.5/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpest_meta-e592b8a19ab895e0.rlib","/home/epage/src/personal/winnow/target/debug/deps/libpest_meta-e592b8a19ab895e0.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rayon-core 1.9.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rayon-core","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librayon_core-28c7fd349d6eb8a3.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"tinytemplate 1.2.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/tinytemplate-1.2.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"tinytemplate","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/tinytemplate-1.2.1/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libtinytemplate-1e34f9b3f54388b1.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"serde_cbor 0.11.2 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_cbor-0.11.2/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"serde_cbor","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/serde_cbor-0.11.2/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libserde_cbor-a6696a57f0dc1b3e.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"escargot 0.5.7 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/escargot-0.5.7/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"escargot","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/escargot-0.5.7/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libescargot-8a922c953f0ce0d3.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"csv 1.1.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/csv-1.1.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"csv","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/csv-1.1.6/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcsv-66898c2026240d6e.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rusty-fork 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rusty-fork-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rusty-fork","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rusty-fork-0.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["timeout","wait-timeout"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librusty_fork-3ff190906b9b0c88.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-script-executed","package_id":"doc-comment 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)","linked_libs":[],"linked_paths":[],"cfgs":[],"env":[],"out_dir":"/home/epage/src/personal/winnow/target/debug/build/doc-comment-9f27b6aeba0913e7/out"}
+{"reason":"compiler-artifact","package_id":"criterion-plot 0.4.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/criterion-plot-0.4.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"criterion-plot","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/criterion-plot-0.4.5/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcriterion_plot-dc7b9242779f53d6.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"concolor 0.0.11 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/concolor-0.0.11/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"concolor","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/concolor-0.0.11/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["auto","bitflags","clicolor","concolor-query","core","interactive","no_color","std","term","windows"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libconcolor-c2d97e9aa66666d7.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"regex 1.6.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-1.6.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"regex","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/regex-1.6.0/src/lib.rs","edition":"2018","doc":true,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libregex-14a9fe50552aac49.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"os_pipe 1.1.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/os_pipe-1.1.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"os_pipe","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/os_pipe-1.1.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libos_pipe-be2a22288f932a49.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"quick-error 2.0.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-error-2.0.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"quick-error","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/quick-error-2.0.1/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libquick_error-280edfc32cc83812.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"normalize-line-endings 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/normalize-line-endings-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"normalize-line-endings","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/normalize-line-endings-0.3.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libnormalize_line_endings-8a66ba357a389996.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"bytecount 0.6.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bytecount-0.6.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"bytecount","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/bytecount-0.6.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbytecount-c083e2cdbbb4f003.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"snapbox-macros 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/snapbox-macros-0.3.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"snapbox-macros","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/snapbox-macros-0.3.1/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libsnapbox_macros-d9da77d55f4279bc.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"oorandom 11.1.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/oorandom-11.1.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"oorandom","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/oorandom-11.1.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liboorandom-052fb0be6ac16c94.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"byteorder 1.4.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/byteorder-1.4.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"byteorder","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/byteorder-1.4.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libbyteorder-9f6a3ecb302657b0.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"similar 2.2.1 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/similar-2.2.1/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"similar","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/similar-2.2.1/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","inline","text"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libsimilar-ca2082771c207a3c.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"termcolor 1.2.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/termcolor-1.2.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"termcolor","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/termcolor-1.2.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libtermcolor-dad1a04bc5d2f742.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pest_generator 2.5.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_generator-2.5.5/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"pest_generator","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_generator-2.5.5/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpest_generator-17d62a3fe28e46f5.rlib","/home/epage/src/personal/winnow/target/debug/deps/libpest_generator-17d62a3fe28e46f5.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"rayon 1.5.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-1.5.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"rayon","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-1.5.3/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/librayon-41dd0a10f9292557.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"proptest 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proptest-1.0.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"proptest","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/proptest-1.0.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["bit-set","break-dead-code","default","fork","lazy_static","quick-error","regex-syntax","rusty-fork","std","tempfile","timeout"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libproptest-7f94966e4936da95.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"snapbox 0.4.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/snapbox-0.4.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"snapbox","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/snapbox-0.4.6/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["color","color-auto","concolor","default","diff","examples"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libsnapbox-d99468a5201f9b87.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"doc-comment 0.3.3 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/doc-comment-0.3.3/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"doc_comment","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/doc-comment-0.3.3/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libdoc_comment-5644793091a6953d.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"lexopt 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/lexopt-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"lexopt","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/lexopt-0.3.0/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/liblexopt-c945e030a97b8e1f.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"circular 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/circular-0.3.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"circular","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/circular-0.3.0/src/lib.rs","edition":"2015","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":[],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcircular-6190d46717d189a0.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"winnow","src_path":"/home/epage/src/personal/winnow/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libwinnow-a64b99fd45b2e97c.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"pest_derive 2.5.5 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_derive-2.5.5/Cargo.toml","target":{"kind":["proc-macro"],"crate_types":["proc-macro"],"name":"pest_derive","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/pest_derive-2.5.5/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libpest_derive-23acec6b80f586aa.so"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"criterion 0.3.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/criterion-0.3.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"criterion","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/criterion-0.3.6/src/lib.rs","edition":"2018","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["cargo_bench_support","default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libcriterion-864d2d30e85a25cf.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"handlebars 4.3.6 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/handlebars-4.3.6/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"handlebars","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/handlebars-4.3.6/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["default"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libhandlebars-8f7ca769e2915c7a.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"term-transcript 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)","manifest_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/term-transcript-0.2.0/Cargo.toml","target":{"kind":["lib"],"crate_types":["lib"],"name":"term-transcript","src_path":"/home/epage/.cargo/registry/src/github.com-1ecc6299db9ec823/term-transcript-0.2.0/src/lib.rs","edition":"2021","doc":true,"doctest":true,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["atty","default","handlebars","pretty_assertions","quick-xml","serde","svg","test"],"filenames":["/home/epage/src/personal/winnow/target/debug/deps/libterm_transcript-67537cf74f0568cc.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"ini","src_path":"/home/epage/src/personal/winnow/examples/ini/main.rs","edition":"2021","required-features":["std"],"doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libini-029ff669d11d054a.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"custom_error","src_path":"/home/epage/src/personal/winnow/examples/custom_error.rs","edition":"2021","required-features":["alloc"],"doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libcustom_error-8382fb7d49937909.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"s_expression","src_path":"/home/epage/src/personal/winnow/examples/s_expression/main.rs","edition":"2021","required-features":["alloc"],"doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libs_expression-0161e16eb3795e0c.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"css","src_path":"/home/epage/src/personal/winnow/examples/css/main.rs","edition":"2021","doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libcss-d003331b0eaf24a5.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"json","src_path":"/home/epage/src/personal/winnow/examples/json/main.rs","edition":"2021","required-features":["std"],"doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libjson-20da0c01e9db35aa.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"ndjson","src_path":"/home/epage/src/personal/winnow/examples/ndjson/main.rs","edition":"2021","required-features":["std"],"doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libndjson-17afbe6b158251ab.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"http","src_path":"/home/epage/src/personal/winnow/examples/http/main.rs","edition":"2021","required-features":["alloc"],"doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libhttp-08613cd431f59551.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"iterator","src_path":"/home/epage/src/personal/winnow/examples/iterator.rs","edition":"2021","doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libiterator-46a33f71a5378497.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"string","src_path":"/home/epage/src/personal/winnow/examples/string/main.rs","edition":"2021","required-features":["alloc"],"doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libstring-73fadc9999eff689.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"arithmetic","src_path":"/home/epage/src/personal/winnow/examples/arithmetic/main.rs","edition":"2021","required-features":["alloc"],"doc":false,"doctest":false,"test":true},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libarithmetic-04ca5fb45c28ebc2.rmeta"],"executable":null,"fresh":true}
+{"reason":"compiler-artifact","package_id":"winnow 0.3.1 (path+file:///home/epage/src/personal/winnow)","manifest_path":"/home/epage/src/personal/winnow/Cargo.toml","target":{"kind":["example"],"crate_types":["bin"],"name":"json_iterator","src_path":"/home/epage/src/personal/winnow/examples/json_iterator.rs","edition":"2021","required-features":["std"],"doc":false,"doctest":false,"test":false},"profile":{"opt_level":"0","debuginfo":2,"debug_assertions":true,"overflow_checks":true,"test":false},"features":["alloc","default","std"],"filenames":["/home/epage/src/personal/winnow/target/debug/examples/libjson_iterator-9bb330a957b0d53d.rmeta"],"executable":null,"fresh":true}
+{"reason":"build-finished","success":true}
+
diff --git a/crates/winnow/examples/ndjson/main.rs b/crates/winnow/examples/ndjson/main.rs
new file mode 100644
index 0000000..6b2a716
--- /dev/null
+++ b/crates/winnow/examples/ndjson/main.rs
@@ -0,0 +1,114 @@
+mod parser;
+
+use std::io::Read;
+
+use winnow::error::ErrMode;
+use winnow::error::InputError;
+use winnow::error::Needed;
+use winnow::prelude::*;
+use winnow::stream::Offset;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+ let input = args.input.ok_or_else(|| lexopt::Error::MissingValue {
+ option: Some("<PATH>".to_owned()),
+ })?;
+
+ let mut file = std::fs::File::open(&input).map_err(to_lexopt)?;
+
+ // Intentionally starting with a small buffer to make it easier to show `Incomplete` handling
+ let buffer_size = 10;
+ let min_buffer_growth = 100;
+ let buffer_growth_factor = 2;
+ let mut buffer = circular::Buffer::with_capacity(buffer_size);
+ loop {
+ let read = file.read(buffer.space()).map_err(to_lexopt)?;
+ eprintln!("read {}", read);
+ if read == 0 {
+ // Should be EOF since we always make sure there is `available_space`
+ assert_ne!(buffer.available_space(), 0);
+ assert_eq!(
+ buffer.available_data(),
+ 0,
+ "leftover data: {}",
+ String::from_utf8_lossy(buffer.data())
+ );
+ break;
+ }
+ buffer.fill(read);
+
+ loop {
+ let input = parser::Stream::new(std::str::from_utf8(buffer.data()).map_err(to_lexopt)?);
+ match parser::ndjson::<InputError<parser::Stream>>.parse_peek(input) {
+ Ok((remainder, value)) => {
+ println!("{:?}", value);
+ println!();
+ // Tell the buffer how much we read
+ let consumed = remainder.offset_from(&input);
+ buffer.consume(consumed);
+ }
+ Err(ErrMode::Backtrack(e)) | Err(ErrMode::Cut(e)) => {
+ return Err(fmt_lexopt(e.to_string()));
+ }
+ Err(ErrMode::Incomplete(Needed::Size(size))) => {
+ // Without the format telling us how much space is required, we really should
+ // treat this the same as `Unknown` but are doing this to demonstrate how to
+ // handle `Size`.
+ //
+ // Even when the format has a header to tell us `Size`, we could hit incidental
+ // `Size(1)`s, so make sure we buffer more space than that to avoid reading
+ // one byte at a time
+ let head_room = size.get().max(min_buffer_growth);
+ let new_capacity = buffer.available_data() + head_room;
+ eprintln!("growing buffer to {}", new_capacity);
+ buffer.grow(new_capacity);
+ if buffer.available_space() < head_room {
+ eprintln!("buffer shift");
+ buffer.shift();
+ }
+ break;
+ }
+ Err(ErrMode::Incomplete(Needed::Unknown)) => {
+ let new_capacity = buffer_growth_factor * buffer.capacity();
+ eprintln!("growing buffer to {}", new_capacity);
+ buffer.grow(new_capacity);
+ break;
+ }
+ }
+ }
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<std::path::PathBuf>,
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Value(input) => {
+ res.input = Some(input.into());
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
+
+fn to_lexopt(e: impl std::error::Error + Send + Sync + 'static) -> lexopt::Error {
+ lexopt::Error::Custom(Box::new(e))
+}
+
+fn fmt_lexopt(e: String) -> lexopt::Error {
+ lexopt::Error::Custom(e.into())
+}
diff --git a/crates/winnow/examples/ndjson/parser.rs b/crates/winnow/examples/ndjson/parser.rs
new file mode 100644
index 0000000..101391e
--- /dev/null
+++ b/crates/winnow/examples/ndjson/parser.rs
@@ -0,0 +1,344 @@
+use std::collections::HashMap;
+use std::str;
+
+use winnow::prelude::*;
+use winnow::{
+ ascii::float,
+ ascii::line_ending,
+ combinator::alt,
+ combinator::cut_err,
+ combinator::{delimited, preceded, separated_pair, terminated},
+ combinator::{repeat, separated},
+ error::{AddContext, ParserError},
+ stream::Partial,
+ token::{any, none_of, take, take_while},
+};
+
+#[derive(Debug, PartialEq, Clone)]
+pub enum JsonValue {
+ Null,
+ Boolean(bool),
+ Str(String),
+ Num(f64),
+ Array(Vec<JsonValue>),
+ Object(HashMap<String, JsonValue>),
+}
+
+/// Use `Partial` to cause `ErrMode::Incomplete` while parsing
+pub type Stream<'i> = Partial<&'i str>;
+
+pub fn ndjson<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<Option<JsonValue>, E> {
+ alt((
+ terminated(delimited(ws, json_value, ws), line_ending).map(Some),
+ line_ending.value(None),
+ ))
+ .parse_next(input)
+}
+
+// --Besides `WS`, same as a regular json parser ----------------------------
+
+/// `alt` is a combinator that tries multiple parsers one by one, until
+/// one of them succeeds
+fn json_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<JsonValue, E> {
+ // `alt` combines the each value parser. It returns the result of the first
+ // successful parser, or an error
+ alt((
+ null.value(JsonValue::Null),
+ boolean.map(JsonValue::Boolean),
+ string.map(JsonValue::Str),
+ float.map(JsonValue::Num),
+ array.map(JsonValue::Array),
+ object.map(JsonValue::Object),
+ ))
+ .parse_next(input)
+}
+
+/// `tag(string)` generates a parser that recognizes the argument string.
+///
+/// This also shows returning a sub-slice of the original input
+fn null<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // This is a parser that returns `"null"` if it sees the string "null", and
+ // an error otherwise
+ "null".parse_next(input)
+}
+
+/// We can combine `tag` with other functions, like `value` which returns a given constant value on
+/// success.
+fn boolean<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<bool, E> {
+ // This is a parser that returns `true` if it sees the string "true", and
+ // an error otherwise
+ let parse_true = "true".value(true);
+
+ // This is a parser that returns `false` if it sees the string "false", and
+ // an error otherwise
+ let parse_false = "false".value(false);
+
+ alt((parse_true, parse_false)).parse_next(input)
+}
+
+/// This parser gathers all `char`s up into a `String`with a parse to recognize the double quote
+/// character, before the string (using `preceded`) and after the string (using `terminated`).
+fn string<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<String, E> {
+ preceded(
+ '\"',
+ // `cut_err` transforms an `ErrMode::Backtrack(e)` to `ErrMode::Cut(e)`, signaling to
+ // combinators like `alt` that they should not try other parsers. We were in the
+ // right branch (since we found the `"` character) but encountered an error when
+ // parsing the string
+ cut_err(terminated(
+ repeat(0.., character).fold(String::new, |mut string, c| {
+ string.push(c);
+ string
+ }),
+ '\"',
+ )),
+ )
+ // `context` lets you add a static string to errors to provide more information in the
+ // error chain (to indicate which parser had an error)
+ .context("string")
+ .parse_next(input)
+}
+
+/// You can mix the above declarative parsing with an imperative style to handle more unique cases,
+/// like escaping
+fn character<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ let c = none_of('"').parse_next(input)?;
+ if c == '\\' {
+ alt((
+ any.verify_map(|c| {
+ Some(match c {
+ '"' | '\\' | '/' => c,
+ 'b' => '\x08',
+ 'f' => '\x0C',
+ 'n' => '\n',
+ 'r' => '\r',
+ 't' => '\t',
+ _ => return None,
+ })
+ }),
+ preceded('u', unicode_escape),
+ ))
+ .parse_next(input)
+ } else {
+ Ok(c)
+ }
+}
+
+fn unicode_escape<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<char, E> {
+ alt((
+ // Not a surrogate
+ u16_hex
+ .verify(|cp| !(0xD800..0xE000).contains(cp))
+ .map(|cp| cp as u32),
+ // See https://en.wikipedia.org/wiki/UTF-16#Code_points_from_U+010000_to_U+10FFFF for details
+ separated_pair(u16_hex, "\\u", u16_hex)
+ .verify(|(high, low)| (0xD800..0xDC00).contains(high) && (0xDC00..0xE000).contains(low))
+ .map(|(high, low)| {
+ let high_ten = (high as u32) - 0xD800;
+ let low_ten = (low as u32) - 0xDC00;
+ (high_ten << 10) + low_ten + 0x10000
+ }),
+ ))
+ .verify_map(
+ // Could be probably replaced with .unwrap() or _unchecked due to the verify checks
+ std::char::from_u32,
+ )
+ .parse_next(input)
+}
+
+fn u16_hex<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<u16, E> {
+ take(4usize)
+ .verify_map(|s| u16::from_str_radix(s, 16).ok())
+ .parse_next(input)
+}
+
+/// Some combinators, like `separated` or `repeat`, will call a parser repeatedly,
+/// accumulating results in a `Vec`, until it encounters an error.
+/// If you want more control on the parser application, check out the `iterator`
+/// combinator (cf `examples/iterator.rs`)
+fn array<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<Vec<JsonValue>, E> {
+ preceded(
+ ('[', ws),
+ cut_err(terminated(
+ separated(0.., json_value, (ws, ',', ws)),
+ (ws, ']'),
+ )),
+ )
+ .context("array")
+ .parse_next(input)
+}
+
+fn object<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<HashMap<String, JsonValue>, E> {
+ preceded(
+ ('{', ws),
+ cut_err(terminated(
+ separated(0.., key_value, (ws, ',', ws)),
+ (ws, '}'),
+ )),
+ )
+ .context("object")
+ .parse_next(input)
+}
+
+fn key_value<'i, E: ParserError<Stream<'i>> + AddContext<Stream<'i>, &'static str>>(
+ input: &mut Stream<'i>,
+) -> PResult<(String, JsonValue), E> {
+ separated_pair(string, cut_err((ws, ':', ws)), json_value).parse_next(input)
+}
+
+/// Parser combinators are constructed from the bottom up:
+/// first we write parsers for the smallest elements (here a space character),
+/// then we'll combine them in larger parsers
+fn ws<'i, E: ParserError<Stream<'i>>>(input: &mut Stream<'i>) -> PResult<&'i str, E> {
+ // Combinators like `take_while` return a function. That function is the
+ // parser,to which we can pass the input
+ take_while(0.., WS).parse_next(input)
+}
+
+const WS: &[char] = &[' ', '\t'];
+
+#[cfg(test)]
+mod test {
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ use super::*;
+
+ #[allow(clippy::useless_attribute)]
+ #[allow(dead_code)] // its dead for benches
+ type Error<'i> = winnow::error::InputError<Partial<&'i str>>;
+
+ #[test]
+ fn json_string() {
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"\"")),
+ Ok((Partial::new(""), "".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"abc\"")),
+ Ok((Partial::new(""), "abc".to_string()))
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new(
+ "\"abc\\\"\\\\\\/\\b\\f\\n\\r\\t\\u0001\\u2014\u{2014}def\""
+ )),
+ Ok((
+ Partial::new(""),
+ "abc\"\\/\x08\x0C\n\r\t\x01——def".to_string()
+ )),
+ );
+ assert_eq!(
+ string::<Error<'_>>.parse_peek(Partial::new("\"\\uD83D\\uDE10\"")),
+ Ok((Partial::new(""), "😐".to_string()))
+ );
+
+ assert!(string::<Error<'_>>.parse_peek(Partial::new("\"")).is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"abc"))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\u123\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uD800\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uD800\\uD800\""))
+ .is_err());
+ assert!(string::<Error<'_>>
+ .parse_peek(Partial::new("\"\\uDC00\""))
+ .is_err());
+ }
+
+ #[test]
+ fn json_object() {
+ use JsonValue::{Num, Object, Str};
+
+ let input = r#"{"a":42,"b":"x"}
+"#;
+
+ let expected = Object(
+ vec![
+ ("a".to_string(), Num(42.0)),
+ ("b".to_string(), Str("x".to_string())),
+ ]
+ .into_iter()
+ .collect(),
+ );
+
+ assert_eq!(
+ ndjson::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((Partial::new(""), Some(expected)))
+ );
+ }
+
+ #[test]
+ fn json_array() {
+ use JsonValue::{Array, Num, Str};
+
+ let input = r#"[42,"x"]
+"#;
+
+ let expected = Array(vec![Num(42.0), Str("x".to_string())]);
+
+ assert_eq!(
+ ndjson::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((Partial::new(""), Some(expected)))
+ );
+ }
+
+ #[test]
+ fn json_whitespace() {
+ use JsonValue::{Array, Boolean, Null, Num, Object, Str};
+
+ let input = r#" { "null" : null, "true" :true , "false": false , "number" : 123e4 , "string" : " abc 123 " , "array" : [ false , 1 , "two" ] , "object" : { "a" : 1.0 , "b" : "c" } , "empty_array" : [ ] , "empty_object" : { } }
+"#;
+
+ assert_eq!(
+ ndjson::<Error<'_>>.parse_peek(Partial::new(input)),
+ Ok((
+ Partial::new(""),
+ Some(Object(
+ vec![
+ ("null".to_string(), Null),
+ ("true".to_string(), Boolean(true)),
+ ("false".to_string(), Boolean(false)),
+ ("number".to_string(), Num(123e4)),
+ ("string".to_string(), Str(" abc 123 ".to_string())),
+ (
+ "array".to_string(),
+ Array(vec![Boolean(false), Num(1.0), Str("two".to_string())])
+ ),
+ (
+ "object".to_string(),
+ Object(
+ vec![
+ ("a".to_string(), Num(1.0)),
+ ("b".to_string(), Str("c".to_string())),
+ ]
+ .into_iter()
+ .collect()
+ )
+ ),
+ ("empty_array".to_string(), Array(vec![]),),
+ ("empty_object".to_string(), Object(HashMap::new()),),
+ ]
+ .into_iter()
+ .collect()
+ ))
+ ))
+ );
+ }
+}
diff --git a/crates/winnow/examples/s_expression/main.rs b/crates/winnow/examples/s_expression/main.rs
new file mode 100644
index 0000000..da055be
--- /dev/null
+++ b/crates/winnow/examples/s_expression/main.rs
@@ -0,0 +1,20 @@
+//! In this example we build an [S-expression](https://en.wikipedia.org/wiki/S-expression)
+//! parser and tiny [lisp](https://en.wikipedia.org/wiki/Lisp_(programming_language)) interpreter.
+//! Lisp is a simple type of language made up of Atoms and Lists, forming easily parsable trees.
+
+#![cfg(feature = "alloc")]
+
+mod parser;
+
+fn main() {
+ let expression_1 = "((if (= (+ 3 (/ 9 3))
+ (* 2 3))
+ *
+ /)
+ 456 123)";
+ println!(
+ "\"{}\"\nevaled gives us: {:?}",
+ expression_1,
+ parser::eval_from_str(expression_1)
+ );
+}
diff --git a/crates/winnow/examples/s_expression/parser.rs b/crates/winnow/examples/s_expression/parser.rs
new file mode 100644
index 0000000..c445053
--- /dev/null
+++ b/crates/winnow/examples/s_expression/parser.rs
@@ -0,0 +1,361 @@
+//! In this example we build an [S-expression](https://en.wikipedia.org/wiki/S-expression)
+//! parser and tiny [lisp](https://en.wikipedia.org/wiki/Lisp_(programming_language)) interpreter.
+//! Lisp is a simple type of language made up of Atoms and Lists, forming easily parsable trees.
+
+use winnow::{
+ ascii::{alpha1, digit1, multispace0, multispace1},
+ combinator::alt,
+ combinator::repeat,
+ combinator::{cut_err, opt},
+ combinator::{delimited, preceded, terminated},
+ error::ContextError,
+ error::StrContext,
+ prelude::*,
+ token::one_of,
+};
+
+/// We start with a top-level function to tie everything together, letting
+/// us call eval on a string directly
+pub fn eval_from_str(src: &str) -> Result<Expr, String> {
+ parse_expr
+ .parse(src)
+ .map_err(|e| e.to_string())
+ .and_then(|exp| eval_expression(exp).ok_or_else(|| "Eval failed".to_string()))
+}
+
+/// For parsing, we start by defining the types that define the shape of data that we want.
+/// In this case, we want something tree-like
+
+/// The remaining half is Lists. We implement these as recursive Expressions.
+/// For a list of numbers, we have `'(1 2 3)`, which we'll parse to:
+/// ```
+/// Expr::Quote(vec![Expr::Constant(Atom::Num(1)),
+/// Expr::Constant(Atom::Num(2)),
+/// Expr::Constant(Atom::Num(3))])
+/// Quote takes an S-expression and prevents evaluation of it, making it a data
+/// structure that we can deal with programmatically. Thus any valid expression
+/// is also a valid data structure in Lisp itself.
+#[derive(Debug, Eq, PartialEq, Clone)]
+pub enum Expr {
+ Constant(Atom),
+ /// (func-name arg1 arg2)
+ Application(Box<Expr>, Vec<Expr>),
+ /// (if predicate do-this)
+ If(Box<Expr>, Box<Expr>),
+ /// (if predicate do-this otherwise-do-this)
+ IfElse(Box<Expr>, Box<Expr>, Box<Expr>),
+ /// '(3 (if (+ 3 3) 4 5) 7)
+ Quote(Vec<Expr>),
+}
+
+/// We now wrap this type and a few other primitives into our Atom type.
+/// Remember from before that Atoms form one half of our language.
+#[derive(Debug, Eq, PartialEq, Clone)]
+pub enum Atom {
+ Num(i32),
+ Keyword(String),
+ Boolean(bool),
+ BuiltIn(BuiltIn),
+}
+
+/// Now, the most basic type. We define some built-in functions that our lisp has
+#[derive(Debug, Eq, PartialEq, Clone, Copy)]
+pub enum BuiltIn {
+ Plus,
+ Minus,
+ Times,
+ Divide,
+ Equal,
+ Not,
+}
+
+/// With types defined, we move onto the top-level expression parser!
+fn parse_expr(i: &mut &'_ str) -> PResult<Expr> {
+ preceded(
+ multispace0,
+ alt((parse_constant, parse_application, parse_if, parse_quote)),
+ )
+ .parse_next(i)
+}
+
+/// We then add the Expr layer on top
+fn parse_constant(i: &mut &'_ str) -> PResult<Expr> {
+ parse_atom.map(Expr::Constant).parse_next(i)
+}
+
+/// Now we take all these simple parsers and connect them.
+/// We can now parse half of our language!
+fn parse_atom(i: &mut &'_ str) -> PResult<Atom> {
+ alt((
+ parse_num,
+ parse_bool,
+ parse_builtin.map(Atom::BuiltIn),
+ parse_keyword,
+ ))
+ .parse_next(i)
+}
+
+/// Next up is number parsing. We're keeping it simple here by accepting any number (> 1)
+/// of digits but ending the program if it doesn't fit into an i32.
+fn parse_num(i: &mut &'_ str) -> PResult<Atom> {
+ alt((
+ digit1.try_map(|digit_str: &str| digit_str.parse::<i32>().map(Atom::Num)),
+ preceded("-", digit1).map(|digit_str: &str| Atom::Num(-digit_str.parse::<i32>().unwrap())),
+ ))
+ .parse_next(i)
+}
+
+/// Our boolean values are also constant, so we can do it the same way
+fn parse_bool(i: &mut &'_ str) -> PResult<Atom> {
+ alt((
+ "#t".map(|_| Atom::Boolean(true)),
+ "#f".map(|_| Atom::Boolean(false)),
+ ))
+ .parse_next(i)
+}
+
+fn parse_builtin(i: &mut &'_ str) -> PResult<BuiltIn> {
+ // alt gives us the result of first parser that succeeds, of the series of
+ // parsers we give it
+ alt((
+ parse_builtin_op,
+ // map lets us process the parsed output, in this case we know what we parsed,
+ // so we ignore the input and return the BuiltIn directly
+ "not".map(|_| BuiltIn::Not),
+ ))
+ .parse_next(i)
+}
+
+/// Continuing the trend of starting from the simplest piece and building up,
+/// we start by creating a parser for the built-in operator functions.
+fn parse_builtin_op(i: &mut &'_ str) -> PResult<BuiltIn> {
+ // one_of matches one of the characters we give it
+ let t = one_of(['+', '-', '*', '/', '=']).parse_next(i)?;
+
+ // because we are matching single character tokens, we can do the matching logic
+ // on the returned value
+ Ok(match t {
+ '+' => BuiltIn::Plus,
+ '-' => BuiltIn::Minus,
+ '*' => BuiltIn::Times,
+ '/' => BuiltIn::Divide,
+ '=' => BuiltIn::Equal,
+ _ => unreachable!(),
+ })
+}
+
+/// The next easiest thing to parse are keywords.
+/// We introduce some error handling combinators: `context` for human readable errors
+/// and `cut_err` to prevent back-tracking.
+///
+/// Put plainly: `preceded(":", cut_err(alpha1))` means that once we see the `:`
+/// character, we have to see one or more alphabetic characters or the input is invalid.
+fn parse_keyword(i: &mut &'_ str) -> PResult<Atom> {
+ preceded(":", cut_err(alpha1))
+ .context(StrContext::Label("keyword"))
+ .map(|sym_str: &str| Atom::Keyword(sym_str.to_string()))
+ .parse_next(i)
+}
+
+/// We can now use our new combinator to define the rest of the `Expr`s.
+///
+/// Starting with function application, we can see how the parser mirrors our data
+/// definitions: our definition is `Application(Box<Expr>, Vec<Expr>)`, so we know
+/// that we need to parse an expression and then parse 0 or more expressions, all
+/// wrapped in an S-expression.
+///
+/// tuples are themselves a parser, used to sequence parsers together, so we can translate this
+/// directly and then map over it to transform the output into an `Expr::Application`
+fn parse_application(i: &mut &'_ str) -> PResult<Expr> {
+ let application_inner = (parse_expr, repeat(0.., parse_expr))
+ .map(|(head, tail)| Expr::Application(Box::new(head), tail));
+ // finally, we wrap it in an s-expression
+ s_exp(application_inner).parse_next(i)
+}
+
+/// Because `Expr::If` and `Expr::IfElse` are so similar (we easily could have
+/// defined `Expr::If` to have an `Option` for the else block), we parse both
+/// in a single function.
+///
+/// In fact, we define our parser as if `Expr::If` was defined with an Option in it,
+/// we have the `opt` combinator which fits very nicely here.
+fn parse_if(i: &mut &'_ str) -> PResult<Expr> {
+ let if_inner = preceded(
+ // here to avoid ambiguity with other names starting with `if`, if we added
+ // variables to our language, we say that if must be terminated by at least
+ // one whitespace character
+ terminated("if", multispace1),
+ cut_err((parse_expr, parse_expr, opt(parse_expr))),
+ )
+ .map(|(pred, true_branch, maybe_false_branch)| {
+ if let Some(false_branch) = maybe_false_branch {
+ Expr::IfElse(
+ Box::new(pred),
+ Box::new(true_branch),
+ Box::new(false_branch),
+ )
+ } else {
+ Expr::If(Box::new(pred), Box::new(true_branch))
+ }
+ })
+ .context(StrContext::Label("if expression"));
+ s_exp(if_inner).parse_next(i)
+}
+
+/// A quoted S-expression is list data structure.
+///
+/// This example doesn't have the symbol atom, but by adding variables and changing
+/// the definition of quote to not always be around an S-expression, we'd get them
+/// naturally.
+fn parse_quote(i: &mut &'_ str) -> PResult<Expr> {
+ // this should look very straight-forward after all we've done:
+ // we find the `'` (quote) character, use cut_err to say that we're unambiguously
+ // looking for an s-expression of 0 or more expressions, and then parse them
+ preceded("'", cut_err(s_exp(repeat(0.., parse_expr))))
+ .context(StrContext::Label("quote"))
+ .map(Expr::Quote)
+ .parse_next(i)
+}
+
+/// Before continuing, we need a helper function to parse lists.
+/// A list starts with `(` and ends with a matching `)`.
+/// By putting whitespace and newline parsing here, we can avoid having to worry about it
+/// in much of the rest of the parser.
+//.parse_next/
+/// Unlike the previous functions, this function doesn't take or consume input, instead it
+/// takes a parsing function and returns a new parsing function.
+fn s_exp<'a, O1, F>(inner: F) -> impl Parser<&'a str, O1, ContextError>
+where
+ F: Parser<&'a str, O1, ContextError>,
+{
+ delimited(
+ '(',
+ preceded(multispace0, inner),
+ cut_err(preceded(multispace0, ')')).context(StrContext::Label("closing paren")),
+ )
+}
+
+/// And that's it!
+/// We can now parse our entire lisp language.
+///
+/// But in order to make it a little more interesting, we can hack together
+/// a little interpreter to take an Expr, which is really an
+/// [Abstract Syntax Tree](https://en.wikipedia.org/wiki/Abstract_syntax_tree) (AST),
+/// and give us something back
+
+/// This function tries to reduce the AST.
+/// This has to return an Expression rather than an Atom because quoted `s_expressions`
+/// can't be reduced
+fn eval_expression(e: Expr) -> Option<Expr> {
+ match e {
+ // Constants and quoted s-expressions are our base-case
+ Expr::Constant(_) | Expr::Quote(_) => Some(e),
+ // we then recursively `eval_expression` in the context of our special forms
+ // and built-in operators
+ Expr::If(pred, true_branch) => {
+ let reduce_pred = eval_expression(*pred)?;
+ if get_bool_from_expr(reduce_pred)? {
+ eval_expression(*true_branch)
+ } else {
+ None
+ }
+ }
+ Expr::IfElse(pred, true_branch, false_branch) => {
+ let reduce_pred = eval_expression(*pred)?;
+ if get_bool_from_expr(reduce_pred)? {
+ eval_expression(*true_branch)
+ } else {
+ eval_expression(*false_branch)
+ }
+ }
+ Expr::Application(head, tail) => {
+ let reduced_head = eval_expression(*head)?;
+ let reduced_tail = tail
+ .into_iter()
+ .map(eval_expression)
+ .collect::<Option<Vec<Expr>>>()?;
+ if let Expr::Constant(Atom::BuiltIn(bi)) = reduced_head {
+ Some(Expr::Constant(match bi {
+ BuiltIn::Plus => Atom::Num(
+ reduced_tail
+ .into_iter()
+ .map(get_num_from_expr)
+ .collect::<Option<Vec<i32>>>()?
+ .into_iter()
+ .sum(),
+ ),
+ BuiltIn::Times => Atom::Num(
+ reduced_tail
+ .into_iter()
+ .map(get_num_from_expr)
+ .collect::<Option<Vec<i32>>>()?
+ .into_iter()
+ .product(),
+ ),
+ BuiltIn::Equal => Atom::Boolean(
+ reduced_tail
+ .iter()
+ .zip(reduced_tail.iter().skip(1))
+ .all(|(a, b)| a == b),
+ ),
+ BuiltIn::Not => {
+ if reduced_tail.len() != 1 {
+ return None;
+ } else {
+ Atom::Boolean(!get_bool_from_expr(
+ reduced_tail.first().cloned().unwrap(),
+ )?)
+ }
+ }
+ BuiltIn::Minus => {
+ Atom::Num(if let Some(first_elem) = reduced_tail.first().cloned() {
+ let fe = get_num_from_expr(first_elem)?;
+ reduced_tail
+ .into_iter()
+ .map(get_num_from_expr)
+ .collect::<Option<Vec<i32>>>()?
+ .into_iter()
+ .skip(1)
+ .fold(fe, |a, b| a - b)
+ } else {
+ Default::default()
+ })
+ }
+ BuiltIn::Divide => {
+ Atom::Num(if let Some(first_elem) = reduced_tail.first().cloned() {
+ let fe = get_num_from_expr(first_elem)?;
+ reduced_tail
+ .into_iter()
+ .map(get_num_from_expr)
+ .collect::<Option<Vec<i32>>>()?
+ .into_iter()
+ .skip(1)
+ .fold(fe, |a, b| a / b)
+ } else {
+ Default::default()
+ })
+ }
+ }))
+ } else {
+ None
+ }
+ }
+ }
+}
+
+/// To start we define a couple of helper functions
+fn get_num_from_expr(e: Expr) -> Option<i32> {
+ if let Expr::Constant(Atom::Num(n)) = e {
+ Some(n)
+ } else {
+ None
+ }
+}
+
+fn get_bool_from_expr(e: Expr) -> Option<bool> {
+ if let Expr::Constant(Atom::Boolean(b)) = e {
+ Some(b)
+ } else {
+ None
+ }
+}
diff --git a/crates/winnow/examples/string/main.rs b/crates/winnow/examples/string/main.rs
new file mode 100644
index 0000000..0c2647e
--- /dev/null
+++ b/crates/winnow/examples/string/main.rs
@@ -0,0 +1,70 @@
+//! This example shows an example of how to parse an escaped string. The
+//! rules for the string are similar to JSON and rust. A string is:
+//!
+//! - Enclosed by double quotes
+//! - Can contain any raw unescaped code point besides \ and "
+//! - Matches the following escape sequences: \b, \f, \n, \r, \t, \", \\, \/
+//! - Matches code points like Rust: \u{XXXX}, where XXXX can be up to 6
+//! hex characters
+//! - an escape followed by whitespace consumes all whitespace between the
+//! escape and the next non-whitespace character
+
+#![cfg(feature = "alloc")]
+
+mod parser;
+
+use winnow::prelude::*;
+
+fn main() -> Result<(), lexopt::Error> {
+ let args = Args::parse()?;
+
+ let data = args.input.as_deref().unwrap_or("\"abc\"");
+ let result = parser::parse_string::<()>.parse(data);
+ match result {
+ Ok(data) => println!("{}", data),
+ Err(err) => println!("{:?}", err),
+ }
+
+ Ok(())
+}
+
+#[derive(Default)]
+struct Args {
+ input: Option<String>,
+}
+
+impl Args {
+ fn parse() -> Result<Self, lexopt::Error> {
+ use lexopt::prelude::*;
+
+ let mut res = Args::default();
+
+ let mut args = lexopt::Parser::from_env();
+ while let Some(arg) = args.next()? {
+ match arg {
+ Value(input) => {
+ res.input = Some(input.string()?);
+ }
+ _ => return Err(arg.unexpected()),
+ }
+ }
+ Ok(res)
+ }
+}
+
+#[test]
+fn simple() {
+ let data = "\"abc\"";
+ let result = parser::parse_string::<()>.parse(data);
+ assert_eq!(result, Ok(String::from("abc")));
+}
+
+#[test]
+fn escaped() {
+ let data = "\"tab:\\tafter tab, newline:\\nnew line, quote: \\\", emoji: \\u{1F602}, newline:\\nescaped whitespace: \\ abc\"";
+ let result = parser::parse_string::<()>.parse(data);
+ assert_eq!(
+ result,
+ Ok(String::from("tab:\tafter tab, newline:\nnew line, quote: \", emoji: 😂, newline:\nescaped whitespace: abc"))
+ );
+}
diff --git a/crates/winnow/examples/string/parser.rs b/crates/winnow/examples/string/parser.rs
new file mode 100644
index 0000000..7701335
--- /dev/null
+++ b/crates/winnow/examples/string/parser.rs
@@ -0,0 +1,167 @@
+//! This example shows an example of how to parse an escaped string. The
+//! rules for the string are similar to JSON and rust. A string is:
+//!
+//! - Enclosed by double quotes
+//! - Can contain any raw unescaped code point besides \ and "
+//! - Matches the following escape sequences: \b, \f, \n, \r, \t, \", \\, \/
+//! - Matches code points like Rust: \u{XXXX}, where XXXX can be up to 6
+//! hex characters
+//! - an escape followed by whitespace consumes all whitespace between the
+//! escape and the next non-whitespace character
+
+use winnow::ascii::multispace1;
+use winnow::combinator::alt;
+use winnow::combinator::repeat;
+use winnow::combinator::{delimited, preceded};
+use winnow::error::{FromExternalError, ParserError};
+use winnow::prelude::*;
+use winnow::token::{take_till, take_while};
+
+/// Parse a string. Use a loop of `parse_fragment` and push all of the fragments
+/// into an output string.
+pub fn parse_string<'a, E>(input: &mut &'a str) -> PResult<String, E>
+where
+ E: ParserError<&'a str> + FromExternalError<&'a str, std::num::ParseIntError>,
+{
+ // Repeat::fold is the equivalent of iterator::fold. It runs a parser in a loop,
+ // and for each output value, calls a folding function on each output value.
+ let build_string = repeat(
+ 0..,
+ // Our parser function – parses a single string fragment
+ parse_fragment,
+ )
+ .fold(
+ // Our init value, an empty string
+ String::new,
+ // Our folding function. For each fragment, append the fragment to the
+ // string.
+ |mut string, fragment| {
+ match fragment {
+ StringFragment::Literal(s) => string.push_str(s),
+ StringFragment::EscapedChar(c) => string.push(c),
+ StringFragment::EscapedWS => {}
+ }
+ string
+ },
+ );
+
+ // Finally, parse the string. Note that, if `build_string` could accept a raw
+ // " character, the closing delimiter " would never match. When using
+ // `delimited` with a looping parser (like Repeat::fold), be sure that the
+ // loop won't accidentally match your closing delimiter!
+ delimited('"', build_string, '"').parse_next(input)
+}
+
+/// A string fragment contains a fragment of a string being parsed: either
+/// a non-empty Literal (a series of non-escaped characters), a single
+/// parsed escaped character, or a block of escaped whitespace.
+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+enum StringFragment<'a> {
+ Literal(&'a str),
+ EscapedChar(char),
+ EscapedWS,
+}
+
+/// Combine `parse_literal`, `parse_escaped_whitespace`, and `parse_escaped_char`
+/// into a `StringFragment`.
+fn parse_fragment<'a, E>(input: &mut &'a str) -> PResult<StringFragment<'a>, E>
+where
+ E: ParserError<&'a str> + FromExternalError<&'a str, std::num::ParseIntError>,
+{
+ alt((
+ // The `map` combinator runs a parser, then applies a function to the output
+ // of that parser.
+ parse_literal.map(StringFragment::Literal),
+ parse_escaped_char.map(StringFragment::EscapedChar),
+ parse_escaped_whitespace.value(StringFragment::EscapedWS),
+ ))
+ .parse_next(input)
+}
+
+/// Parse a non-empty block of text that doesn't include \ or "
+fn parse_literal<'a, E: ParserError<&'a str>>(input: &mut &'a str) -> PResult<&'a str, E> {
+ // `take_till` parses a string of 0 or more characters that aren't one of the
+ // given characters.
+ let not_quote_slash = take_till(1.., ['"', '\\']);
+
+ // `verify` runs a parser, then runs a verification function on the output of
+ // the parser. The verification function accepts the output only if it
+ // returns true. In this case, we want to ensure that the output of take_till
+ // is non-empty.
+ not_quote_slash
+ .verify(|s: &str| !s.is_empty())
+ .parse_next(input)
+}
+
+// parser combinators are constructed from the bottom up:
+// first we write parsers for the smallest elements (escaped characters),
+// then combine them into larger parsers.
+
+/// Parse an escaped character: \n, \t, \r, \u{00AC}, etc.
+fn parse_escaped_char<'a, E>(input: &mut &'a str) -> PResult<char, E>
+where
+ E: ParserError<&'a str> + FromExternalError<&'a str, std::num::ParseIntError>,
+{
+ preceded(
+ '\\',
+ // `alt` tries each parser in sequence, returning the result of
+ // the first successful match
+ alt((
+ parse_unicode,
+ // The `value` parser returns a fixed value (the first argument) if its
+ // parser (the second argument) succeeds. In these cases, it looks for
+ // the marker characters (n, r, t, etc) and returns the matching
+ // character (\n, \r, \t, etc).
+ 'n'.value('\n'),
+ 'r'.value('\r'),
+ 't'.value('\t'),
+ 'b'.value('\u{08}'),
+ 'f'.value('\u{0C}'),
+ '\\'.value('\\'),
+ '/'.value('/'),
+ '"'.value('"'),
+ )),
+ )
+ .parse_next(input)
+}
+
+/// Parse a unicode sequence, of the form u{XXXX}, where XXXX is 1 to 6
+/// hexadecimal numerals. We will combine this later with `parse_escaped_char`
+/// to parse sequences like \u{00AC}.
+fn parse_unicode<'a, E>(input: &mut &'a str) -> PResult<char, E>
+where
+ E: ParserError<&'a str> + FromExternalError<&'a str, std::num::ParseIntError>,
+{
+ // `take_while` parses between `m` and `n` bytes (inclusive) that match
+ // a predicate. `parse_hex` here parses between 1 and 6 hexadecimal numerals.
+ let parse_hex = take_while(1..=6, |c: char| c.is_ascii_hexdigit());
+
+ // `preceded` takes a prefix parser, and if it succeeds, returns the result
+ // of the body parser. In this case, it parses u{XXXX}.
+ let parse_delimited_hex = preceded(
+ 'u',
+ // `delimited` is like `preceded`, but it parses both a prefix and a suffix.
+ // It returns the result of the middle parser. In this case, it parses
+ // {XXXX}, where XXXX is 1 to 6 hex numerals, and returns XXXX
+ delimited('{', parse_hex, '}'),
+ );
+
+ // `try_map` takes the result of a parser and applies a function that returns
+ // a Result. In this case we take the hex bytes from parse_hex and attempt to
+ // convert them to a u32.
+ let parse_u32 = parse_delimited_hex.try_map(move |hex| u32::from_str_radix(hex, 16));
+
+ // verify_map is like try_map, but it takes an Option instead of a Result. If
+ // the function returns None, verify_map returns an error. In this case, because
+ // not all u32 values are valid unicode code points, we have to fallibly
+ // convert to char with from_u32.
+ parse_u32.verify_map(std::char::from_u32).parse_next(input)
+}
+
+/// Parse a backslash, followed by any amount of whitespace. This is used later
+/// to discard any escaped whitespace.
+fn parse_escaped_whitespace<'a, E: ParserError<&'a str>>(
+ input: &mut &'a str,
+) -> PResult<&'a str, E> {
+ preceded('\\', multispace1).parse_next(input)
+}
diff --git a/crates/winnow/src/_topic/arithmetic.rs b/crates/winnow/src/_topic/arithmetic.rs
new file mode 100644
index 0000000..d94b4fa
--- /dev/null
+++ b/crates/winnow/src/_topic/arithmetic.rs
@@ -0,0 +1,19 @@
+//! # Arithmetic
+//!
+//! ## Direct evaluation
+//!
+//! ```rust
+#![doc = include_str!("../../examples/arithmetic/parser.rs")]
+//! ```
+//!
+//! ## Parse to AST
+//!
+//! ```rust
+#![doc = include_str!("../../examples/arithmetic/parser_ast.rs")]
+//! ```
+//!
+//! ## Parse to Tokens then AST
+//!
+//! ```rust
+#![doc = include_str!("../../examples/arithmetic/parser_lexer.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/error.rs b/crates/winnow/src/_topic/error.rs
new file mode 100644
index 0000000..8a401b4
--- /dev/null
+++ b/crates/winnow/src/_topic/error.rs
@@ -0,0 +1,27 @@
+//! # Custom Errors
+//!
+//! Between [`ContextError`], [`Parser::context`], and [`cut_err`],
+//! most error needs will likely be met
+//! (see [tutorial][chapter_6]).
+//! When that isn't the case, you can implement your own error type.
+//!
+//! The most basic error trait is [`ParserError`].
+//!
+//! Optional traits include:
+//! - [`AddContext`]
+//! - [`FromExternalError`]
+//!
+//! # Example
+//!
+//!```rust
+#![doc = include_str!("../../examples/custom_error.rs")]
+//!```
+
+#![allow(unused_imports)]
+use crate::combinator::cut_err;
+use crate::error::ContextError;
+use crate::Parser;
+use crate::_tutorial::chapter_6;
+use crate::error::AddContext;
+use crate::error::FromExternalError;
+use crate::error::ParserError;
diff --git a/crates/winnow/src/_topic/fromstr.rs b/crates/winnow/src/_topic/fromstr.rs
new file mode 100644
index 0000000..d126d16
--- /dev/null
+++ b/crates/winnow/src/_topic/fromstr.rs
@@ -0,0 +1,8 @@
+//! # Implementing `FromStr`
+//!
+//! The [`FromStr` trait][std::str::FromStr] provides
+//! a common interface to parse from a string.
+//!
+//! ```rust
+#![doc = include_str!("../../examples/css/parser.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/http.rs b/crates/winnow/src/_topic/http.rs
new file mode 100644
index 0000000..5001694
--- /dev/null
+++ b/crates/winnow/src/_topic/http.rs
@@ -0,0 +1,5 @@
+//! # HTTP
+//!
+//! ```rust
+#![doc = include_str!("../../examples/http/parser.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/ini.rs b/crates/winnow/src/_topic/ini.rs
new file mode 100644
index 0000000..b78ade5
--- /dev/null
+++ b/crates/winnow/src/_topic/ini.rs
@@ -0,0 +1,5 @@
+//! # INI
+//!
+//! ```rust
+#![doc = include_str!("../../examples/ini/parser.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/json.rs b/crates/winnow/src/_topic/json.rs
new file mode 100644
index 0000000..fb4df3b
--- /dev/null
+++ b/crates/winnow/src/_topic/json.rs
@@ -0,0 +1,5 @@
+//! # json
+//!
+//! ```rust,ignore
+#![doc = include_str!("../../examples/json/parser.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/language.rs b/crates/winnow/src/_topic/language.rs
new file mode 100644
index 0000000..c6a713a
--- /dev/null
+++ b/crates/winnow/src/_topic/language.rs
@@ -0,0 +1,330 @@
+//! # Elements of Programming Languages
+//!
+//! These are short recipes for accomplishing common tasks.
+//!
+//! * [Whitespace](#whitespace)
+//! + [Wrapper combinators that eat whitespace before and after a parser](#wrapper-combinators-that-eat-whitespace-before-and-after-a-parser)
+//! * [Comments](#comments)
+//! + [`// C++/EOL-style comments`](#-ceol-style-comments)
+//! + [`/* C-style comments */`](#-c-style-comments-)
+//! * [Identifiers](#identifiers)
+//! + [`Rust-Style Identifiers`](#rust-style-identifiers)
+//! * [Literal Values](#literal-values)
+//! + [Escaped Strings](#escaped-strings)
+//! + [Integers](#integers)
+//! - [Hexadecimal](#hexadecimal)
+//! - [Octal](#octal)
+//! - [Binary](#binary)
+//! - [Decimal](#decimal)
+//! + [Floating Point Numbers](#floating-point-numbers)
+//!
+//! ## Whitespace
+//!
+//!
+//!
+//! ### Wrapper combinators that eat whitespace before and after a parser
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! error::ParserError,
+//! combinator::delimited,
+//! ascii::multispace0,
+//! };
+//!
+//! /// A combinator that takes a parser `inner` and produces a parser that also consumes both leading and
+//! /// trailing whitespace, returning the output of `inner`.
+//! fn ws<'a, F, O, E: ParserError<&'a str>>(inner: F) -> impl Parser<&'a str, O, E>
+//! where
+//! F: Parser<&'a str, O, E>,
+//! {
+//! delimited(
+//! multispace0,
+//! inner,
+//! multispace0
+//! )
+//! }
+//! ```
+//!
+//! To eat only trailing whitespace, replace `delimited(...)` with `terminated(&inner, multispace0)`.
+//! Likewise, the eat only leading whitespace, replace `delimited(...)` with `preceded(multispace0,
+//! &inner)`. You can use your own parser instead of `multispace0` if you want to skip a different set
+//! of lexemes.
+//!
+//! ## Comments
+//!
+//! ### `// C++/EOL-style comments`
+//!
+//! This version uses `%` to start a comment, does not consume the newline character, and returns an
+//! output of `()`.
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! error::ParserError,
+//! token::take_till1,
+//! };
+//!
+//! pub fn peol_comment<'a, E: ParserError<&'a str>>(i: &mut &'a str) -> PResult<(), E>
+//! {
+//! ('%', take_till1(['\n', '\r']))
+//! .void() // Output is thrown away.
+//! .parse_next(i)
+//! }
+//! ```
+//!
+//! ### `/* C-style comments */`
+//!
+//! Inline comments surrounded with sentinel tags `(*` and `*)`. This version returns an output of `()`
+//! and does not handle nested comments.
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! error::ParserError,
+//! token::{tag, take_until},
+//! };
+//!
+//! pub fn pinline_comment<'a, E: ParserError<&'a str>>(i: &mut &'a str) -> PResult<(), E> {
+//! (
+//! "(*",
+//! take_until(0.., "*)"),
+//! "*)"
+//! )
+//! .void() // Output is thrown away.
+//! .parse_next(i)
+//! }
+//! ```
+//!
+//! ## Identifiers
+//!
+//! ### `Rust-Style Identifiers`
+//!
+//! Parsing identifiers that may start with a letter (or underscore) and may contain underscores,
+//! letters and numbers may be parsed like this:
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! stream::AsChar,
+//! token::take_while,
+//! token::one_of,
+//! };
+//!
+//! pub fn identifier<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! (
+//! one_of(|c: char| c.is_alpha() || c == '_'),
+//! take_while(0.., |c: char| c.is_alphanum() || c == '_')
+//! )
+//! .recognize()
+//! .parse_next(input)
+//! }
+//! ```
+//!
+//! Let's say we apply this to the identifier `hello_world123abc`. The first element of the tuple
+//! would uses [`one_of`][crate::token::one_of] which would recognize `h`. The tuple ensures that
+//! `ello_world123abc` will be piped to the next [`take_while`][crate::token::take_while] parser,
+//! which recognizes every remaining character. However, the tuple returns a tuple of the results
+//! of its sub-parsers. The [`recognize`][crate::Parser::recognize] parser produces a `&str` of the
+//! input text that was parsed, which in this case is the entire `&str` `hello_world123abc`.
+//!
+//! ## Literal Values
+//!
+//! ### Escaped Strings
+//!
+//! ```rust
+#![doc = include_str!("../../examples/string/parser.rs")]
+//! ```
+//!
+//! See also [`escaped`] and [`escaped_transform`].
+//!
+//! ### Integers
+//!
+//! The following recipes all return string slices rather than integer values. How to obtain an
+//! integer value instead is demonstrated for hexadecimal integers. The others are similar.
+//!
+//! The parsers allow the grouping character `_`, which allows one to group the digits by byte, for
+//! example: `0xA4_3F_11_28`. If you prefer to exclude the `_` character, the lambda to convert from a
+//! string slice to an integer value is slightly simpler. You can also strip the `_` from the string
+//! slice that is returned, which is demonstrated in the second hexadecimal number parser.
+//!
+//! #### Hexadecimal
+//!
+//! The parser outputs the string slice of the digits without the leading `0x`/`0X`.
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::alt,
+//! combinator::{repeat},
+//! combinator::{preceded, terminated},
+//! token::one_of,
+//! token::tag,
+//! };
+//!
+//! fn hexadecimal<'s>(input: &mut &'s str) -> PResult<&'s str> { // <'a, E: ParserError<&'a str>>
+//! preceded(
+//! alt(("0x", "0X")),
+//! repeat(1..,
+//! terminated(one_of(('0'..='9', 'a'..='f', 'A'..='F')), repeat(0.., '_').map(|()| ()))
+//! ).map(|()| ()).recognize()
+//! ).parse_next(input)
+//! }
+//! ```
+//!
+//! If you want it to return the integer value instead, use map:
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::alt,
+//! combinator::{repeat},
+//! combinator::{preceded, terminated},
+//! token::one_of,
+//! token::tag,
+//! };
+//!
+//! fn hexadecimal_value(input: &mut &str) -> PResult<i64> {
+//! preceded(
+//! alt(("0x", "0X")),
+//! repeat(1..,
+//! terminated(one_of(('0'..='9', 'a'..='f', 'A'..='F')), repeat(0.., '_').map(|()| ()))
+//! ).map(|()| ()).recognize()
+//! ).try_map(
+//! |out: &str| i64::from_str_radix(&str::replace(&out, "_", ""), 16)
+//! ).parse_next(input)
+//! }
+//! ```
+//!
+//! See also [`hex_uint`]
+//!
+//! #### Octal
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::alt,
+//! combinator::{repeat},
+//! combinator::{preceded, terminated},
+//! token::one_of,
+//! token::tag,
+//! };
+//!
+//! fn octal<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! preceded(
+//! alt(("0o", "0O")),
+//! repeat(1..,
+//! terminated(one_of('0'..='7'), repeat(0.., '_').map(|()| ()))
+//! ).map(|()| ()).recognize()
+//! ).parse_next(input)
+//! }
+//! ```
+//!
+//! #### Binary
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::alt,
+//! combinator::{repeat},
+//! combinator::{preceded, terminated},
+//! token::one_of,
+//! token::tag,
+//! };
+//!
+//! fn binary<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! preceded(
+//! alt(("0b", "0B")),
+//! repeat(1..,
+//! terminated(one_of('0'..='1'), repeat(0.., '_').map(|()| ()))
+//! ).map(|()| ()).recognize()
+//! ).parse_next(input)
+//! }
+//! ```
+//!
+//! #### Decimal
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::{repeat},
+//! combinator::terminated,
+//! token::one_of,
+//! };
+//!
+//! fn decimal<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! repeat(1..,
+//! terminated(one_of('0'..='9'), repeat(0.., '_').map(|()| ()))
+//! ).map(|()| ())
+//! .recognize()
+//! .parse_next(input)
+//! }
+//! ```
+//!
+//! See also [`dec_uint`] and [`dec_int`]
+//!
+//! ### Floating Point Numbers
+//!
+//! The following is adapted from [the Python parser by Valentin Lorentz](https://github.com/ProgVal/rust-python-parser/blob/master/src/numbers.rs).
+//!
+//! ```rust
+//! use winnow::prelude::*;
+//! use winnow::{
+//! combinator::alt,
+//! combinator::{repeat},
+//! combinator::opt,
+//! combinator::{preceded, terminated},
+//! token::one_of,
+//! };
+//!
+//! fn float<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! alt((
+//! // Case one: .42
+//! (
+//! '.',
+//! decimal,
+//! opt((
+//! one_of(['e', 'E']),
+//! opt(one_of(['+', '-'])),
+//! decimal
+//! ))
+//! ).recognize()
+//! , // Case two: 42e42 and 42.42e42
+//! (
+//! decimal,
+//! opt(preceded(
+//! '.',
+//! decimal,
+//! )),
+//! one_of(['e', 'E']),
+//! opt(one_of(['+', '-'])),
+//! decimal
+//! ).recognize()
+//! , // Case three: 42. and 42.42
+//! (
+//! decimal,
+//! '.',
+//! opt(decimal)
+//! ).recognize()
+//! )).parse_next(input)
+//! }
+//!
+//! fn decimal<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! repeat(1..,
+//! terminated(one_of('0'..='9'), repeat(0.., '_').map(|()| ()))
+//! ).
+//! map(|()| ())
+//! .recognize()
+//! .parse_next(input)
+//! }
+//! ```
+//!
+//! See also [`float`]
+
+#![allow(unused_imports)]
+use crate::ascii::dec_int;
+use crate::ascii::dec_uint;
+use crate::ascii::escaped;
+use crate::ascii::escaped_transform;
+use crate::ascii::float;
+use crate::ascii::hex_uint;
diff --git a/crates/winnow/src/_topic/mod.rs b/crates/winnow/src/_topic/mod.rs
new file mode 100644
index 0000000..c7bcc53
--- /dev/null
+++ b/crates/winnow/src/_topic/mod.rs
@@ -0,0 +1,40 @@
+//! # Special Topics
+//!
+//! These are short recipes for accomplishing common tasks.
+//!
+//! - [Why `winnow`?][why]
+//! - [Migrating from `nom`][nom]
+//! - Formats:
+//! - [Elements of Programming Languages][language]
+//! - [Arithmetic][arithmetic]
+//! - [s-expression][s_expression]
+//! - [json]
+//! - [INI][ini]
+//! - [HTTP][http]
+//! - Special Topics:
+//! - [Implementing `FromStr`][fromstr]
+//! - [Performance][performance]
+//! - [Parsing Partial Input][partial]
+//! - [Custom stream or token][stream]
+//! - [Custom errors][error]
+//! - [Debugging][crate::_tutorial::chapter_8]
+//!
+//! See also parsers written with `winnow`:
+//!
+//! - [`toml_edit`](https://crates.io/crates/toml_edit)
+//! - [`hcl-edit`](https://crates.io/crates/hcl-edit)
+#![allow(clippy::std_instead_of_core)]
+
+pub mod arithmetic;
+pub mod error;
+pub mod fromstr;
+pub mod http;
+pub mod ini;
+pub mod json;
+pub mod language;
+pub mod nom;
+pub mod partial;
+pub mod performance;
+pub mod s_expression;
+pub mod stream;
+pub mod why;
diff --git a/crates/winnow/src/_topic/nom.rs b/crates/winnow/src/_topic/nom.rs
new file mode 100644
index 0000000..f3cb74e
--- /dev/null
+++ b/crates/winnow/src/_topic/nom.rs
@@ -0,0 +1,49 @@
+//! # Migrating from `nom`
+//!
+//! For comparisons with `nom`, see
+//! - [Why `winnow`][super::why]
+//! - [parse-rosetta-rs](https://github.com/rosetta-rs/parse-rosetta-rs/)
+//!
+//! What approach you take depends on the size and complexity of your parser.
+//! For small, simple parsers, its likely easiest to directly port from `nom`.
+//! When trying to look for the equivalent of a `nom` combinator, search in the docs for the name
+//! of the `nom` combinator. It is expected that, where names diverge, a doc alias exists.
+//! See also the [List of combinators][crate::combinator].
+//!
+//! For larger parsers, it is likely best to take smaller steps
+//! - Easier to debug when something goes wrong
+//! - Deprecation messages will help assist through the process
+//!
+//! The workflow goes something like:
+//! 1. Run `cargo rm nom && cargo add [email protected]`
+//! 1. Ensure everything compiles and tests pass, ignoring deprecation messages (see [migration
+//! notes](https://github.com/winnow-rs/winnow/blob/v0.3-main/CHANGELOG.md#nom-migration-guide))
+//! 1. Commit
+//! 1. Switch any `impl FnMut(I) -> IResult<I, O, E>` to `impl Parser<I, O, E>`
+//! 1. Resolve deprecation messages
+//! 1. Commit
+//! 1. Run `cargo add [email protected]`
+//! 1. Ensure everything compiles and tests pass, ignoring deprecation messages (see [changelog](https://github.com/winnow-rs/winnow/blob/v0.4-main/CHANGELOG.md#compatibility-2) for more details)
+//! 1. Commit
+//! 1. Resolve deprecation messages
+//! 1. Commit
+//! 1. Run `cargo add [email protected]`
+//! 1. Ensure everything compiles and tests pass, ignoring deprecation messages (see [migration
+//! notes](https://github.com/winnow-rs/winnow/blob/v0.5.0/CHANGELOG.md))
+//! 1. Commit
+//! 1. Resolve deprecation messagess
+//! 1. Commit
+//!
+//! For example migrations, see
+//! - [git-config-env](https://github.com/gitext-rs/git-config-env/pull/11) (nom to winnow 0.3)
+//! - [git-conventional](https://github.com/crate-ci/git-conventional/pull/37) (nom to winnow 0.3,
+//! adds explicit tracing for easier debugging)
+//! - [typos](https://github.com/crate-ci/typos/pull/664) (nom to winnow 0.3)
+//! - [cargo-smart-release](https://github.com/Byron/gitoxide/pull/948) (gradual migration from nom
+//! to winnow 0.5)
+//! - [gix-config](https://github.com/Byron/gitoxide/pull/951) (gradual migration from nom
+//! to winnow 0.5)
+//! - [gix-protocol](https://github.com/Byron/gitoxide/pull/1009) (gradual migration from nom
+//! to winnow 0.5)
+//! - [gitoxide](https://github.com/Byron/gitoxide/pull/956) (gradual migration from nom
+//! to winnow 0.5)
diff --git a/crates/winnow/src/_topic/partial.rs b/crates/winnow/src/_topic/partial.rs
new file mode 100644
index 0000000..e4747f1
--- /dev/null
+++ b/crates/winnow/src/_topic/partial.rs
@@ -0,0 +1,46 @@
+//! # Parsing Partial Input
+//!
+//! Typically, the input being parsed is all in-memory, or is complete. Some data sources are too
+//! large to fit into memory, only allowing parsing an incomplete or [`Partial`] subset of the
+//! data, requiring incrementally parsing.
+//!
+//! By wrapping a stream, like `&[u8]`, with [`Partial`], parsers will report when the data is
+//! [`Incomplete`] and more input is [`Needed`], allowing the caller to stream-in additional data
+//! to be parsed. The data is then parsed a chunk at a time.
+//!
+//! Chunks are typically defined by either:
+//! - A header reporting the number of bytes, like with [`length_and_then`]
+//! - [`Partial`] can explicitly be changed to being complete once the specified bytes are
+//! acquired via [`StreamIsPartial::complete`].
+//! - A delimiter, like with [ndjson](http://ndjson.org/)
+//! - You can parse up-to the delimiter or do a `take_until(0.., delim).and_then(parser)`
+//!
+//! If the chunks are not homogeneous, a state machine will be needed to track what the expected
+//! parser is for the next chunk.
+//!
+//! Caveats:
+//! - `winnow` takes the approach of re-parsing from scratch. Chunks should be relatively small to
+//! prevent the re-parsing overhead from dominating.
+//! - Parsers like [`repeat`] do not know when an `eof` is from insufficient data or the end of the
+//! stream, causing them to always report [`Incomplete`].
+//!
+//! # Example
+//!
+//! `main.rs`:
+//! ```rust,ignore
+#![doc = include_str!("../../examples/ndjson/main.rs")]
+//! ```
+//!
+//! `parser.rs`:
+//! ```rust,ignore
+#![doc = include_str!("../../examples/ndjson/parser.rs")]
+//! ```
+
+#![allow(unused_imports)] // Used for intra-doc links
+
+use crate::binary::length_and_then;
+use crate::combinator::repeat;
+use crate::error::ErrMode::Incomplete;
+use crate::error::Needed;
+use crate::stream::Partial;
+use crate::stream::StreamIsPartial;
diff --git a/crates/winnow/src/_topic/performance.rs b/crates/winnow/src/_topic/performance.rs
new file mode 100644
index 0000000..2b53038
--- /dev/null
+++ b/crates/winnow/src/_topic/performance.rs
@@ -0,0 +1,55 @@
+//! # Performance
+//!
+//! ## Runtime Performance
+//!
+//! See also the general Rust [Performance Book](https://nnethercote.github.io/perf-book/)
+//!
+//! Tips
+//! - Try `cargo add winnow -F simd`. For some it offers significant performance improvements
+//! - When enough cases of an [`alt`] have unique prefixes, prefer [`dispatch`]
+//! - When parsing text, try to parse as bytes (`u8`) rather than `char`s ([`BStr`] can make
+//! debugging easier)
+//! - Find simplified subsets of the grammar to parse, falling back to the full grammar when it
+//! doesn't work. For example, when parsing json strings, parse them without support for escapes,
+//! falling back to escape support if it fails.
+//! - Watch for large return types. A surprising place these can show up is when chaining parsers
+//! with a tuple.
+//!
+//! ## Build-time Performance
+//!
+//! Returning complex types as `impl Trait` can negatively impact build times. This can hit in
+//! surprising cases like:
+//! ```rust
+//! # use winnow::prelude::*;
+//! fn foo<I, O, E>() -> impl Parser<I, O, E>
+//! # where
+//! # I: winnow::stream::Stream<Token=O>,
+//! # I: winnow::stream::StreamIsPartial,
+//! # E: winnow::error::ParserError<I>,
+//! {
+//! // ...some chained combinators...
+//! # winnow::token::any
+//! }
+//! ```
+//!
+//! Instead, wrap the combinators in a closure to simplify the type:
+//! ```rust
+//! # use winnow::prelude::*;
+//! fn foo<I, O, E>() -> impl Parser<I, O, E>
+//! # where
+//! # I: winnow::stream::Stream<Token=O>,
+//! # I: winnow::stream::StreamIsPartial,
+//! # E: winnow::error::ParserError<I>,
+//! {
+//! move |input: &mut I| {
+//! // ...some chained combinators...
+//! # winnow::token::any
+//! .parse_next(input)
+//! }
+//! }
+//! ```
+
+#![allow(unused_imports)]
+use crate::combinator::alt;
+use crate::combinator::dispatch;
+use crate::stream::BStr;
diff --git a/crates/winnow/src/_topic/s_expression.rs b/crates/winnow/src/_topic/s_expression.rs
new file mode 100644
index 0000000..ef66600
--- /dev/null
+++ b/crates/winnow/src/_topic/s_expression.rs
@@ -0,0 +1,5 @@
+//! # s-expression
+//!
+//! ```rust
+#![doc = include_str!("../../examples/s_expression/parser.rs")]
+//! ```
diff --git a/crates/winnow/src/_topic/stream.rs b/crates/winnow/src/_topic/stream.rs
new file mode 100644
index 0000000..2254f87
--- /dev/null
+++ b/crates/winnow/src/_topic/stream.rs
@@ -0,0 +1,66 @@
+//! # Custom [`Stream`]
+//!
+//! `winnow` is batteries included with support for
+//! - Basic inputs like `&str`, newtypes with
+//! - Improved debug output like [`Bytes`]
+//! - [`Stateful`] for passing state through your parser, like tracking recursion
+//! depth
+//! - [`Located`] for looking up the absolute position of a token
+//!
+//! But that won't always cut it for your parser. For example, you might lex `&str` into
+//! a series of tokens and then want to parse a `TokenStream`.
+//!
+//! ## Implementing a custom stream
+//!
+//! Let's assume we have an input type we'll call `MyStream`.
+//! `MyStream` is a sequence of `MyItem` type.
+//!
+//! The goal is to define parsers with this signature: `&mut MyStream -> PResult<Output>`.
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::tag;
+//! # type MyStream<'i> = &'i str;
+//! # type Output<'i> = &'i str;
+//! fn parser<'s>(i: &mut MyStream<'s>) -> PResult<Output<'s>> {
+//! "test".parse_next(i)
+//! }
+//! ```
+//!
+//! Here are the traits you may have to implement for `MyStream`:
+//!
+//! | trait | usage |
+//! |---|---|
+//! | [`Stream`] |Core trait for driving parsing|
+//! | [`StreamIsPartial`] | Marks the input as being the complete buffer or a partial buffer for streaming input |
+//! | [`AsBytes`] |Casts the input type to a byte slice|
+//! | [`AsBStr`] |Casts the input type to a slice of ASCII / UTF-8-like bytes|
+//! | [`Compare`] |Character comparison operations|
+//! | [`FindSlice`] |Look for a substring in self|
+//! | [`Location`] |Calculate location within initial input|
+//! | [`Offset`] |Calculate the offset between slices|
+//!
+//! And for `MyItem`:
+//!
+//! | trait | usage |
+//! |---|---|
+//! | [`AsChar`] |Transforms common types to a char for basic token parsing|
+//! | [`ContainsToken`] |Look for the token in the given set|
+//!
+//! And traits for `&[MyItem]`:
+//!
+//! | trait | usage |
+//! |---|---|
+//! | [`SliceLen`] |Calculate the input length|
+//! | [`ParseSlice`] |Used to integrate `&str`'s `parse()` method|
+//!
+//! ## Implementing a custom token
+//!
+//! If you are parsing `&[Myitem]`, leaving just the `MyItem` traits.
+//!
+//! For example:
+//! ```rust
+#![doc = include_str!("../../examples/arithmetic/parser_lexer.rs")]
+//! ```
+
+#[allow(unused_imports)] // Here for intra-dock links
+use crate::stream::*;
diff --git a/crates/winnow/src/_topic/why.rs b/crates/winnow/src/_topic/why.rs
new file mode 100644
index 0000000..fc1716a
--- /dev/null
+++ b/crates/winnow/src/_topic/why.rs
@@ -0,0 +1,101 @@
+//! # Why `winnow`?
+//!
+//! To answer this question, it will be useful to contrast this with other approaches to parsing.
+//!
+//! **Note:** This will focus on principles and priorities. For a deeper and wider wider
+//! comparison with other Rust parser libraries, see
+//! [parse-rosetta-rs](https://github.com/rosetta-rs/parse-rosetta-rs).
+//!
+//! ## Hand-written parsers
+//!
+//! Typically, a hand-written parser gives you the flexibility to get
+//! - Fast parse performance
+//! - Fast compile-time
+//! - Small binary sizes
+//! - High quality error message
+//! - Fewer dependencies to audit
+//!
+//! However, this comes at the cost of doing it all yourself, including
+//! - Optimizing for each of the above characteristics you care about
+//! - Ensuring the safety of any `unsafe` code (buffer overflows being a common bug with parsers)
+//! - Being aware of, familiar with, and correctly implement the relevant algorithms.
+//! matklad, who has written two rust compile frontends, commented
+//! ["I’ve implemented a production-grade Pratt parser once, but I no longer immediately understand that code :-)"](https://matklad.github.io/2020/04/13/simple-but-powerful-pratt-parsing.html)
+//!
+//! This approach works well if:
+//! - Your format is small and is unlikely to change
+//! - Your format is large but you have people who can focus solely on parsing, like with large
+//! programming languages
+//!
+//! ## `winnow`
+//!
+//! Unlike traditional programming language parsers that use
+//! [lex](https://en.wikipedia.org/wiki/Lex_(software)) or
+//! [yacc](https://en.wikipedia.org/wiki/Yacc), you can think of `winnow` as a general version of
+//! the helpers you would create along the way to writing a hand-written parser.
+//!
+//! `winnow` includes support for:
+//! - Zero-copy parsing
+//! - [Parse traces][crate::trace] for easier debugging
+//! - [Streaming parsing][crate::Partial] for network communication or large file
+//! - [Stateful][crate::Stateful] parsers
+//!
+//! For binary formats, `winnow` includes:
+//! - [A hexadecimal view][crate::Bytes] in [traces][crate::trace]
+//! - [TLV](https://en.wikipedia.org/wiki/Type-length-value) (e.g. [`length_take`])
+//! - Some common parsers to help get started, like numbers
+//!
+//! For text formats, `winnow` includes:
+//! - [Tracking of spans][crate::Located]
+//! - [A textual view when parsing as bytes][crate::BStr] in [traces][crate::trace]
+//! - Ability to evaluate directly, parse to an AST, or lex and parse the format
+//!
+//! This works well for:
+//! - Prototyping for what will be a hand-written parser
+//! - When you want to minimize the work to evolve your format
+//! - When you don't have contributors focused solely on parsing and your grammar is large enough
+//! to be unwieldy to hand write.
+//!
+//! ## `nom`
+//!
+//! `winnow` is a fork of the venerable [`nom`](https://crates.io/crates/nom). The difference
+//! between them is largely in priorities. `nom` prioritizes:
+//! - Lower churn for existing users while `winnow` is trying to find ways to make things better
+//! for the parsers yet to be written.
+//! - Having a small core, relying on external crates like
+//! [`nom-locate`](https://crates.io/crates/nom_locate) and
+//! [`nom-supreme`](https://crates.io/crates/nom-supreme), encouraging flexibility among users
+//! and to not block users on new features being merged while `winnow` aims to include all the
+//! fundamentals for parsing to ensure the experience is cohesive and high quality.
+//!
+//! See also our [nom migration guide][super::nom]
+//!
+//! ## `chumsky`
+//!
+//! [`chumsky`](https://crates.io/crates/chumsky) is an up and coming parser-combinator library
+//! that includes advanced features like error recovery.
+//!
+//! Probably the biggest diverging philosophy is `chumsky`s stance:
+//!
+//! > "If you need to implement either `Parser` or `Strategy` by hand, that's a problem that needs fixing".
+//!
+//! This is under "batteries included" but it also ties into the feeling that `chumsky` acts more like
+//! a framework. Instead of composing together helpers, you are expected to do everything through
+//! their system to the point that it is non-trivial to implement their `Parser` trait and are
+//! encouraged to use the
+//! [`custom`](https://docs.rs/chumsky/0.9.0/chumsky/primitive/fn.custom.html) helper. This
+//! requires re-framing everything to fit within their model and makes the code harder to understand
+//! and debug as you are working with abstract operations that will eventually be applied
+//! rather than directly with the parsers.
+//!
+//! In contrast, `winnow` is an introspectable toolbox that can easily be customized at any level.
+//! Probably the biggest thing that `winnow` loses out on is optimizations from ["parse modes" via
+//! GATs](https://github.com/zesterer/chumsky/pull/82) which allows downstream parsers to tell
+//! upstream parsers when information will be discarded, allowing bypassing expensive operations,
+//! like allocations. This requires a lot more complex interaction with parsers that isn't as
+//! trivial to do with bare functions which would lose out on any of that side-band information.
+//! Instead, we work around this with things like the [`Accumulate`] trait.
+
+#![allow(unused_imports)]
+use crate::binary::length_take;
+use crate::stream::Accumulate;
diff --git a/crates/winnow/src/_tutorial/chapter_0.rs b/crates/winnow/src/_tutorial/chapter_0.rs
new file mode 100644
index 0000000..35a2d14
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_0.rs
@@ -0,0 +1,39 @@
+//! # Chapter 0: Introduction
+//!
+//! This tutorial assumes that you are:
+//! - Already familiar with Rust
+//! - Using `winnow` for the first time
+//!
+//! The focus will be on parsing in-memory strings (`&str`). Once done, you might want to check the
+//! [Special Topics][_topic] for more specialized topics or examples.
+//!
+//! ## About
+//!
+//! `winnow` is a parser-combinator library. In other words, it gives you tools to define:
+//! - "parsers", or functions that take an input and give back an output
+//! - "combinators", or functions that take parsers and _combine_ them together!
+//!
+//! While "combinator" might be an unfamiliar word, you are likely using them in your rust code
+//! today, like with the [`Iterator`] trait:
+//! ```rust
+//! let data = vec![1, 2, 3, 4, 5];
+//! let even_count = data.iter()
+//! .copied() // combinator
+//! .filter(|d| d % 2 == 0) // combinator
+//! .count(); // combinator
+//! ```
+//!
+//! Parser combinators are great because:
+//!
+//! - The parsers are small and easy to write
+//! - The parsers components are easy to reuse (if they're general enough, please add them to winnow!)
+//! - The parsers components are easy to test separately (unit tests and property-based tests)
+//! - The parser combination code looks close to the grammar you would have written
+//! - You can build partial parsers, specific to the data you need at the moment, and ignore the rest
+
+#![allow(unused_imports)]
+use crate::_topic;
+use std::iter::Iterator;
+
+pub use super::chapter_1 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_1.rs b/crates/winnow/src/_tutorial/chapter_1.rs
new file mode 100644
index 0000000..2d94418
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_1.rs
@@ -0,0 +1,86 @@
+//! # Chapter 1: The Winnow Way
+//!
+//! First of all, we need to understand the way that winnow thinks about parsing.
+//! As discussed in the introduction, winnow lets us build simple parsers, and
+//! then combine them (using "combinators").
+//!
+//! Let's discuss what a "parser" actually does. A parser takes an input and returns
+//! a result, where:
+//! - `Ok` indicates the parser successfully found what it was looking for; or
+//! - `Err` indicates the parser could not find what it was looking for.
+//!
+//! Parsers do more than just return a binary "success"/"failure" code.
+//! On success, the parser will return the processed data. The input will be left pointing to
+//! data that still needs processing
+//!
+//! If the parser failed, then there are multiple errors that could be returned.
+//! For simplicity, however, in the next chapters we will leave these unexplored.
+//!
+//! ```text
+//! ┌─► Ok(what matched the parser)
+//! ┌─────────┐ │
+//! my input───►│my parser├──►either──┤
+//! └─────────┘ └─► Err(...)
+//! ```
+//!
+//!
+//! To represent this model of the world, winnow uses the [`PResult<O>`] type.
+//! The `Ok` variant has `output: O`;
+//! whereas the `Err` variant stores an error.
+//!
+//! You can import that from:
+//!
+//! ```rust
+//! use winnow::PResult;
+//! ```
+//!
+//! To combine parsers, we need a common way to refer to them which is where the [`Parser<I, O, E>`]
+//! trait comes in with [`Parser::parse_next`] being the primary way to drive
+//! parsing forward.
+//!
+//! You'll note that `I` and `O` are parameterized -- while most of the examples in this book
+//! will be with `&str` (i.e. parsing a string); they do not have to be strings; nor do they
+//! have to be the same type (consider the simple example where `I = &str`, and `O = u64` -- this
+//! parses a string into an unsigned integer.)
+//!
+//!
+//! # Let's write our first parser!
+//!
+//! The simplest parser we can write is one which successfully does nothing.
+//!
+//! To make it easier to implement a [`Parser`], the trait is implemented for
+//! functions of the form `Fn(&mut I) -> PResult<O>`.
+//!
+//! This parser function should take in a `&str`:
+//!
+//! - Since it is supposed to succeed, we know it will return the `Ok` variant.
+//! - Since it does nothing to our input, the remaining input is the same as the input.
+//! - Since it doesn't parse anything, it also should just return an empty string.
+//!
+//! ```rust
+//! use winnow::PResult;
+//! use winnow::Parser;
+//!
+//! pub fn do_nothing_parser<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! Ok("")
+//! }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let output = do_nothing_parser.parse_next(&mut input).unwrap();
+//! // Same as:
+//! // let output = do_nothing_parser(&mut input).unwrap();
+//!
+//! assert_eq!(input, "0x1a2b Hello");
+//! assert_eq!(output, "");
+//! }
+//! ```
+
+#![allow(unused_imports)]
+use crate::PResult;
+use crate::Parser;
+
+pub use super::chapter_0 as previous;
+pub use super::chapter_2 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_2.rs b/crates/winnow/src/_tutorial/chapter_2.rs
new file mode 100644
index 0000000..c27b719
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_2.rs
@@ -0,0 +1,248 @@
+//! # Chapter 2: Tokens and Tags
+//!
+//! The simplest *useful* parser you can write is one which matches tokens.
+//!
+//! ## Tokens
+//!
+//! [`Stream`] provides some core operations to help with parsing. For example, to process a
+//! single token, you can do:
+//! ```rust
+//! # use winnow::Parser;
+//! # use winnow::PResult;
+//! use winnow::stream::Stream;
+//! use winnow::error::ParserError;
+//! use winnow::error::ErrorKind;
+//! use winnow::error::ErrMode;
+//!
+//! fn parse_prefix(input: &mut &str) -> PResult<char> {
+//! let c = input.next_token().ok_or_else(|| {
+//! ErrMode::from_error_kind(input, ErrorKind::Token)
+//! })?;
+//! if c != '0' {
+//! return Err(ErrMode::from_error_kind(input, ErrorKind::Verify));
+//! }
+//! Ok(c)
+//! }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let output = parse_prefix.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, "x1a2b Hello");
+//! assert_eq!(output, '0');
+//!
+//! assert!(parse_prefix.parse_next(&mut "d").is_err());
+//! }
+//! ```
+//!
+//! [`any`] and [`Parser::verify`] are [`Parser`] building blocks on top of [`Stream`]:
+//! ```rust
+//! # use winnow::PResult;
+//! use winnow::Parser;
+//! use winnow::token::any;
+//!
+//! fn parse_prefix(input: &mut &str) -> PResult<char> {
+//! any.verify(|c| *c == '0').parse_next(input)
+//! }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let output = parse_prefix.parse_next(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, "x1a2b Hello");
+//! # assert_eq!(output, '0');
+//! #
+//! # assert!(parse_prefix.parse_next(&mut "d").is_err());
+//! # }
+//! ```
+//!
+//! Matching a single token literal is common enough that [`Parser`] is implemented for
+//! `char`.
+//!
+//! ```rust
+//! # use winnow::PResult;
+//! use winnow::Parser;
+//!
+//! fn parse_prefix(input: &mut &str) -> PResult<char> {
+//! '0'.parse_next(input)
+//! }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let output = parse_prefix.parse_next(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, "x1a2b Hello");
+//! # assert_eq!(output, '0');
+//! #
+//! # assert!(parse_prefix.parse_next(&mut "d").is_err());
+//! # }
+//! ```
+//!
+//! ## Tags
+//!
+//! [`Stream`] also supports processing slices of tokens:
+//! ```rust
+//! # use winnow::Parser;
+//! # use winnow::PResult;
+//! use winnow::stream::Stream;
+//! use winnow::error::ParserError;
+//! use winnow::error::ErrorKind;
+//! use winnow::error::ErrMode;
+//!
+//! fn parse_prefix<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! let expected = "0x";
+//! if input.len() < expected.len() {
+//! return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+//! }
+//! let actual = input.next_slice(expected.len());
+//! if actual != expected {
+//! return Err(ErrMode::from_error_kind(input, ErrorKind::Verify));
+//! }
+//! Ok(actual)
+//! }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let output = parse_prefix.parse_next(&mut input).unwrap();
+//! assert_eq!(input, "1a2b Hello");
+//! assert_eq!(output, "0x");
+//!
+//! assert!(parse_prefix.parse_next(&mut "0o123").is_err());
+//! }
+//! ```
+//!
+//! Again, matching a literal is common enough that [`Parser`] is implemented for `&str`:
+//! ```rust
+//! # use winnow::PResult;
+//! use winnow::Parser;
+//!
+//! fn parse_prefix<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! "0x".parse_next(input)
+//! }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let output = parse_prefix.parse_next(&mut input).unwrap();
+//! # assert_eq!(input, "1a2b Hello");
+//! # assert_eq!(output, "0x");
+//! #
+//! # assert!(parse_prefix.parse_next(&mut "0o123").is_err());
+//! # }
+//! ```
+//!
+//! In `winnow`, we call this type of parser a [`tag`]. See [`token`] for additional individual
+//! and token-slice parsers.
+//!
+//! ## Character Classes
+//!
+//! Selecting a single `char` or a [`tag`] is fairly limited. Sometimes, you will want to select one of several
+//! `chars` of a specific class, like digits. For this, we use the [`one_of`] parser:
+//!
+//! ```rust
+//! # use winnow::Parser;
+//! # use winnow::PResult;
+//! use winnow::token::one_of;
+//!
+//! fn parse_digits(input: &mut &str) -> PResult<char> {
+//! one_of(('0'..='9', 'a'..='f', 'A'..='F')).parse_next(input)
+//! }
+//!
+//! fn main() {
+//! let mut input = "1a2b Hello";
+//!
+//! let output = parse_digits.parse_next(&mut input).unwrap();
+//! assert_eq!(input, "a2b Hello");
+//! assert_eq!(output, '1');
+//!
+//! assert!(parse_digits.parse_next(&mut "Z").is_err());
+//! }
+//! ```
+//!
+//! > **Aside:** [`one_of`] might look straightforward, a function returning a value that implements `Parser`.
+//! > Let's look at it more closely as its used above (resolving all generic parameters):
+//! > ```rust
+//! > # use winnow::prelude::*;
+//! > # use winnow::error::InputError;
+//! > pub fn one_of<'i>(
+//! > list: &'static [char]
+//! > ) -> impl Parser<&'i str, char, InputError<&'i str>> {
+//! > // ...
+//! > # winnow::token::one_of(list)
+//! > }
+//! > ```
+//! > If you have not programmed in a language where functions are values, the type signature of the
+//! > [`one_of`] function might be a surprise.
+//! > The function [`one_of`] *returns a function*. The function it returns is a
+//! > `Parser`, taking a `&str` and returning an `PResult`. This is a common pattern in winnow for
+//! > configurable or stateful parsers.
+//!
+//! Some of character classes are common enough that a named parser is provided, like with:
+//! - [`line_ending`][crate::ascii::line_ending]: Recognizes an end of line (both `\n` and `\r\n`)
+//! - [`newline`][crate::ascii::newline]: Matches a newline character `\n`
+//! - [`tab`][crate::ascii::tab]: Matches a tab character `\t`
+//!
+//! You can then capture sequences of these characters with parsers like [`take_while`].
+//! ```rust
+//! # use winnow::Parser;
+//! # use winnow::PResult;
+//! use winnow::token::take_while;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! take_while(1.., ('0'..='9', 'a'..='f', 'A'..='F')).parse_next(input)
+//! }
+//!
+//! fn main() {
+//! let mut input = "1a2b Hello";
+//!
+//! let output = parse_digits.parse_next(&mut input).unwrap();
+//! assert_eq!(input, " Hello");
+//! assert_eq!(output, "1a2b");
+//!
+//! assert!(parse_digits.parse_next(&mut "Z").is_err());
+//! }
+//! ```
+//!
+//! We could simplify this further by using one of the built-in character classes, [`hex_digit1`]:
+//! ```rust
+//! # use winnow::Parser;
+//! # use winnow::PResult;
+//! use winnow::ascii::hex_digit1;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! hex_digit1.parse_next(input)
+//! }
+//!
+//! fn main() {
+//! let mut input = "1a2b Hello";
+//!
+//! let output = parse_digits.parse_next(&mut input).unwrap();
+//! assert_eq!(input, " Hello");
+//! assert_eq!(output, "1a2b");
+//!
+//! assert!(parse_digits.parse_next(&mut "Z").is_err());
+//! }
+//! ```
+//!
+//! See [`ascii`] for more text-based parsers.
+
+#![allow(unused_imports)]
+use crate::ascii;
+use crate::ascii::hex_digit1;
+use crate::stream::ContainsToken;
+use crate::stream::Stream;
+use crate::token;
+use crate::token::any;
+use crate::token::one_of;
+use crate::token::tag;
+use crate::token::take_while;
+use crate::Parser;
+use std::ops::RangeInclusive;
+
+pub use super::chapter_1 as previous;
+pub use super::chapter_3 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_3.rs b/crates/winnow/src/_tutorial/chapter_3.rs
new file mode 100644
index 0000000..2ad0124
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_3.rs
@@ -0,0 +1,376 @@
+//! # Chapter 3: Sequencing and Alternatives
+//!
+//! In the last chapter, we saw how to create simple parsers using prebuilt parsers.
+//!
+//! In this chapter, we explore two other widely used features:
+//! alternatives and composition.
+//!
+//! ## Sequencing
+//!
+//! Now that we can create more interesting parsers, we can sequence them together, like:
+//!
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! #
+//! fn parse_prefix<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! "0x".parse_next(input)
+//! }
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! take_while(1.., (
+//! ('0'..='9'),
+//! ('A'..='F'),
+//! ('a'..='f'),
+//! )).parse_next(input)
+//! }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let prefix = parse_prefix.parse_next(&mut input).unwrap();
+//! let digits = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(prefix, "0x");
+//! assert_eq!(digits, "1a2b");
+//! assert_eq!(input, " Hello");
+//! }
+//! ```
+//!
+//! To sequence these together, you can just put them in a tuple:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! #
+//! # fn parse_prefix<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # "0x".parse_next(input)
+//! # }
+//! #
+//! # fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! //...
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let (prefix, digits) = (
+//! parse_prefix,
+//! parse_digits
+//! ).parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(prefix, "0x");
+//! assert_eq!(digits, "1a2b");
+//! assert_eq!(input, " Hello");
+//! }
+//! ```
+//!
+//! Frequently, you won't care about the tag and you can instead use one of the provided combinators,
+//! like [`preceded`]:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::combinator::preceded;
+//!
+//! # fn parse_prefix<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # "0x".parse_next(input)
+//! # }
+//! #
+//! # fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! //...
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let digits = preceded(
+//! parse_prefix,
+//! parse_digits
+//! ).parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(digits, "1a2b");
+//! assert_eq!(input, " Hello");
+//! }
+//! ```
+//!
+//! See [`combinator`] for more sequencing parsers.
+//!
+//! ## Alternatives
+//!
+//! Sometimes, we might want to choose between two parsers; and we're happy with
+//! either being used.
+//!
+//! [`Stream::checkpoint`] helps us to retry parsing:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::stream::Stream;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<(&'s str, &'s str)> {
+//! let start = input.checkpoint();
+//!
+//! if let Ok(output) = ("0b", parse_bin_digits).parse_next(input) {
+//! return Ok(output);
+//! }
+//!
+//! input.reset(start);
+//! if let Ok(output) = ("0o", parse_oct_digits).parse_next(input) {
+//! return Ok(output);
+//! }
+//!
+//! input.reset(start);
+//! if let Ok(output) = ("0d", parse_dec_digits).parse_next(input) {
+//! return Ok(output);
+//! }
+//!
+//! input.reset(start);
+//! ("0x", parse_hex_digits).parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let (prefix, digits) = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(prefix, "0x");
+//! assert_eq!(digits, "1a2b");
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//!
+//! > **Warning:** the above example is for illustrative purposes and relying on `Result::Ok` or
+//! > `Result::Err` can lead to incorrect behavior. This will be clarified in later when covering
+//! > [error handling][`chapter_6`#errmode]
+//!
+//! [`opt`] is a basic building block for correctly handling retrying parsing:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::combinator::opt;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<(&'s str, &'s str)> {
+//! if let Some(output) = opt(("0b", parse_bin_digits)).parse_next(input)? {
+//! Ok(output)
+//! } else if let Some(output) = opt(("0o", parse_oct_digits)).parse_next(input)? {
+//! Ok(output)
+//! } else if let Some(output) = opt(("0d", parse_dec_digits)).parse_next(input)? {
+//! Ok(output)
+//! } else {
+//! ("0x", parse_hex_digits).parse_next(input)
+//! }
+//! }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let (prefix, digits) = parse_digits.parse_next(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, " Hello");
+//! # assert_eq!(prefix, "0x");
+//! # assert_eq!(digits, "1a2b");
+//! #
+//! # assert!(parse_digits(&mut "ghiWorld").is_err());
+//! # }
+//! ```
+//!
+//! [`alt`] encapsulates this if/else-if ladder pattern, with the last case being the `else`:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::combinator::alt;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<(&'s str, &'s str)> {
+//! alt((
+//! ("0b", parse_bin_digits),
+//! ("0o", parse_oct_digits),
+//! ("0d", parse_dec_digits),
+//! ("0x", parse_hex_digits),
+//! )).parse_next(input)
+//! }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let (prefix, digits) = parse_digits.parse_next(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, " Hello");
+//! # assert_eq!(prefix, "0x");
+//! # assert_eq!(digits, "1a2b");
+//! #
+//! # assert!(parse_digits(&mut "ghiWorld").is_err());
+//! # }
+//! ```
+//!
+//! > **Note:** [`empty`] and [`fail`] are parsers that might be useful in the `else` case.
+//!
+//! Sometimes a giant if/else-if ladder can be slow and you'd rather have a `match` statement for
+//! branches of your parser that have unique prefixes. In this case, you can use the
+//! [`dispatch`] macro:
+//!
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::combinator::dispatch;
+//! use winnow::token::take;
+//! use winnow::combinator::fail;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! dispatch!(take(2usize);
+//! "0b" => parse_bin_digits,
+//! "0o" => parse_oct_digits,
+//! "0d" => parse_dec_digits,
+//! "0x" => parse_hex_digits,
+//! _ => fail,
+//! ).parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let digits = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(digits, "1a2b");
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//!
+//! > **Note:** [`peek`] may be useful when [`dispatch`]ing from hints from each case's parser.
+//!
+//! See [`combinator`] for more alternative parsers.
+
+#![allow(unused_imports)]
+use super::chapter_6;
+use crate::combinator;
+use crate::combinator::alt;
+use crate::combinator::dispatch;
+use crate::combinator::empty;
+use crate::combinator::fail;
+use crate::combinator::opt;
+use crate::combinator::peek;
+use crate::combinator::preceded;
+use crate::stream::Stream;
+
+pub use super::chapter_2 as previous;
+pub use super::chapter_4 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_4.rs b/crates/winnow/src/_tutorial/chapter_4.rs
new file mode 100644
index 0000000..328a648
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_4.rs
@@ -0,0 +1,107 @@
+//! # Chapter 4: Parsers With Custom Return Types
+//!
+//! So far, we have seen mostly functions that take an `&str`, and return a
+//! `PResult<&str>`. Splitting strings into smaller strings and characters is certainly
+//! useful, but it's not the only thing winnow is capable of!
+//!
+//! A useful operation when parsing is to convert between types; for example
+//! parsing from `&str` to another primitive, like [`usize`].
+//!
+//! All we need to do for our parser to return a different type is to change
+//! the type parameter of [`PResult`] to the desired return type.
+//! For example, to return a `usize`, return a `PResult<usize>`.
+//!
+//! One winnow-native way of doing a type conversion is to use the
+//! [`Parser::parse_to`] combinator
+//! to convert from a successful parse to a particular type using [`FromStr`].
+//!
+//! The following code converts from a string containing a number to `usize`:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::ascii::digit1;
+//! #
+//! fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! digit1
+//! .parse_to()
+//! .parse_next(input)
+//! }
+//!
+//! fn main() {
+//! let mut input = "1024 Hello";
+//!
+//! let output = parse_digits.parse_next(&mut input).unwrap();
+//! assert_eq!(input, " Hello");
+//! assert_eq!(output, 1024);
+//!
+//! assert!(parse_digits(&mut "Z").is_err());
+//! }
+//! ```
+//!
+//! `Parser::parse_to` is just a convenient form of [`Parser::try_map`] which we can use to handle
+//! all radices of numbers:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! use winnow::combinator::dispatch;
+//! use winnow::token::take;
+//! use winnow::combinator::fail;
+//!
+//! fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! dispatch!(take(2usize);
+//! "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! _ => fail,
+//! ).parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let digits = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(digits, 0x1a2b);
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//!
+//! See also [`Parser`] for more output-modifying parsers.
+
+#![allow(unused_imports)]
+use crate::PResult;
+use crate::Parser;
+use std::str::FromStr;
+
+pub use super::chapter_3 as previous;
+pub use super::chapter_5 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_5.rs b/crates/winnow/src/_tutorial/chapter_5.rs
new file mode 100644
index 0000000..8aa719b
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_5.rs
@@ -0,0 +1,282 @@
+//! # Chapter 5: Repetition
+//!
+//! In [`chapter_3`], we covered how to sequence different parsers into a tuple but sometimes you need to run a
+//! single parser multiple times, collecting the result into a container, like [`Vec`].
+//!
+//! Let's collect the result of `parse_digits`:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::dispatch;
+//! # use winnow::token::take;
+//! # use winnow::combinator::fail;
+//! use winnow::combinator::opt;
+//! use winnow::combinator::repeat;
+//! use winnow::combinator::terminated;
+//!
+//! fn parse_list(input: &mut &str) -> PResult<Vec<usize>> {
+//! let mut list = Vec::new();
+//! while let Some(output) = opt(terminated(parse_digits, opt(','))).parse_next(input)? {
+//! list.push(output);
+//! }
+//! Ok(list)
+//! }
+//!
+//! // ...
+//! # fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! # dispatch!(take(2usize);
+//! # "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! # "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! # "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! # "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! # _ => fail,
+//! # ).parse_next(input)
+//! # }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b,0x3c4d,0x5e6f Hello";
+//!
+//! let digits = parse_list.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(digits, vec![0x1a2b, 0x3c4d, 0x5e6f]);
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//!
+//! We can implement this declaratively with [`repeat`]:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::dispatch;
+//! # use winnow::token::take;
+//! # use winnow::combinator::fail;
+//! use winnow::combinator::opt;
+//! use winnow::combinator::repeat;
+//! use winnow::combinator::terminated;
+//!
+//! fn parse_list(input: &mut &str) -> PResult<Vec<usize>> {
+//! repeat(0..,
+//! terminated(parse_digits, opt(','))
+//! ).parse_next(input)
+//! }
+//! #
+//! # fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! # dispatch!(take(2usize);
+//! # "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! # "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! # "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! # "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! # _ => fail,
+//! # ).parse_next(input)
+//! # }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b,0x3c4d,0x5e6f Hello";
+//! #
+//! # let digits = parse_list.parse_next(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, " Hello");
+//! # assert_eq!(digits, vec![0x1a2b, 0x3c4d, 0x5e6f]);
+//! #
+//! # assert!(parse_digits(&mut "ghiWorld").is_err());
+//! # }
+//! ```
+//!
+//! You'll notice that the above allows trailing `,` when we intended to not support that. We can
+//! easily fix this by using [`separated`]:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::dispatch;
+//! # use winnow::token::take;
+//! # use winnow::combinator::fail;
+//! use winnow::combinator::separated;
+//!
+//! fn parse_list(input: &mut &str) -> PResult<Vec<usize>> {
+//! separated(0.., parse_digits, ",").parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! # dispatch!(take(2usize);
+//! # "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! # "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! # "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! # "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! # _ => fail,
+//! # ).parse_next(input)
+//! # }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b,0x3c4d,0x5e6f Hello";
+//!
+//! let digits = parse_list.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(digits, vec![0x1a2b, 0x3c4d, 0x5e6f]);
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//!
+//! If you look closely at [`repeat`], it isn't collecting directly into a [`Vec`] but
+//! [`Accumulate`] to gather the results. This lets us make more complex parsers than we did in
+//! [`chapter_2`] by accumulating the results into a `()` and [`recognize`][Parser::recognize]-ing the captured input:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::dispatch;
+//! # use winnow::token::take;
+//! # use winnow::combinator::fail;
+//! # use winnow::combinator::separated;
+//! #
+//! fn recognize_list<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! parse_list.recognize().parse_next(input)
+//! }
+//!
+//! fn parse_list(input: &mut &str) -> PResult<()> {
+//! separated(0.., parse_digits, ",").parse_next(input)
+//! }
+//!
+//! # fn parse_digits(input: &mut &str) -> PResult<usize> {
+//! # dispatch!(take(2usize);
+//! # "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! # "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! # "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! # "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! # _ => fail,
+//! # ).parse_next(input)
+//! # }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b,0x3c4d,0x5e6f Hello";
+//!
+//! let digits = recognize_list.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(digits, "0x1a2b,0x3c4d,0x5e6f");
+//!
+//! assert!(parse_digits(&mut "ghiWorld").is_err());
+//! }
+//! ```
+//! See [`combinator`] for more repetition parsers.
+
+#![allow(unused_imports)]
+use super::chapter_2;
+use super::chapter_3;
+use crate::combinator;
+use crate::combinator::repeat;
+use crate::combinator::separated;
+use crate::stream::Accumulate;
+use crate::Parser;
+use std::vec::Vec;
+
+pub use super::chapter_4 as previous;
+pub use super::chapter_6 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_6.rs b/crates/winnow/src/_tutorial/chapter_6.rs
new file mode 100644
index 0000000..0d54e15
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_6.rs
@@ -0,0 +1,156 @@
+//! # Chapter 6: Error Reporting
+//!
+//! ## `Error`
+//!
+//! Back in [`chapter_1`], we glossed over the `Err` side of [`PResult`]. `PResult<O>` is
+//! actually short for `PResult<O, E=ContextError>` where [`ContextError`] is a relatively cheap
+//! way of building up reasonable errors for humans.
+//!
+//! You can use [`Parser::context`] to annotate the error with custom types
+//! while unwinding to further improve the error quality.
+//!
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::alt;
+//! use winnow::error::StrContext;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<(&'s str, &'s str)> {
+//! alt((
+//! ("0b", parse_bin_digits).context(StrContext::Label("binary")),
+//! ("0o", parse_oct_digits).context(StrContext::Label("octal")),
+//! ("0d", parse_dec_digits).context(StrContext::Label("decimal")),
+//! ("0x", parse_hex_digits).context(StrContext::Label("hexadecimal")),
+//! )).parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let (prefix, digits) = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(prefix, "0x");
+//! assert_eq!(digits, "1a2b");
+//! }
+//! ```
+//!
+//! At first glance, this looks correct but what `context` will be reported when parsing `"0b5"`?
+//! If you remember back to [`chapter_3`], [`alt`] will only report the last error by default which
+//! means when parsing `"0b5"`, the `context` will be `"hexadecimal"`.
+//!
+//! ## `ErrMode`
+//!
+//! Let's break down `PResult<O, E>` one step further:
+//! ```rust
+//! # use winnow::error::ErrorKind;
+//! # use winnow::error::ErrMode;
+//! pub type PResult<O, E = ErrorKind> = Result<O, ErrMode<E>>;
+//! ```
+//! [`PResult`] is just a fancy wrapper around `Result` that wraps our error in an [`ErrMode`]
+//! type.
+//!
+//! [`ErrMode`] is an enum with [`Backtrack`] and [`Cut`] variants (ignore [`Incomplete`] as its only
+//! relevant for [streaming][_topic::stream]). By default, errors are [`Backtrack`], meaning that
+//! other parsing branches will be attempted on failure, like the next case of an [`alt`]. [`Cut`]
+//! shortcircuits all other branches, immediately reporting the error.
+//!
+//! So we can get the correct `context` by modifying the above example with [`cut_err`]:
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::alt;
+//! # use winnow::error::StrContext;
+//! use winnow::combinator::cut_err;
+//!
+//! fn parse_digits<'s>(input: &mut &'s str) -> PResult<(&'s str, &'s str)> {
+//! alt((
+//! ("0b", cut_err(parse_bin_digits)).context(StrContext::Label("binary")),
+//! ("0o", cut_err(parse_oct_digits)).context(StrContext::Label("octal")),
+//! ("0d", cut_err(parse_dec_digits)).context(StrContext::Label("decimal")),
+//! ("0x", cut_err(parse_hex_digits)).context(StrContext::Label("hexadecimal")),
+//! )).parse_next(input)
+//! }
+//!
+//! // ...
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let mut input = "0x1a2b Hello";
+//!
+//! let (prefix, digits) = parse_digits.parse_next(&mut input).unwrap();
+//!
+//! assert_eq!(input, " Hello");
+//! assert_eq!(prefix, "0x");
+//! assert_eq!(digits, "1a2b");
+//! }
+//! ```
+//! Now, when parsing `"0b5"`, the `context` will be `"binary"`.
+
+#![allow(unused_imports)]
+use super::chapter_1;
+use super::chapter_3;
+use crate::combinator::alt;
+use crate::combinator::cut_err;
+use crate::error::ContextError;
+use crate::error::ErrMode;
+use crate::error::ErrMode::*;
+use crate::error::ErrorKind;
+use crate::PResult;
+use crate::Parser;
+use crate::_topic;
+
+pub use super::chapter_5 as previous;
+pub use super::chapter_7 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_7.rs b/crates/winnow/src/_tutorial/chapter_7.rs
new file mode 100644
index 0000000..659be3a
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_7.rs
@@ -0,0 +1,119 @@
+//! # Chapter 7: Integrating the Parser
+//!
+//! So far, we've highlighted how to incrementally parse, but how do we bring this all together
+//! into our application?
+//!
+//! Parsers we've been working with look like:
+//! ```rust
+//! # use winnow::error::ContextError;
+//! # use winnow::error::ErrMode;
+//! # use winnow::Parser;
+//! #
+//! pub fn parser<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! // ...
+//! # Ok("")
+//! }
+//!
+//! type PResult<O> = Result<
+//! O,
+//! ErrMode<ContextError>
+//! >;
+//! ```
+//! 1. We have to decide what to do about the "remainder" of the `input`.
+//! 2. The [`ErrMode<ContextError>`] is not compatible with the rest of the Rust ecosystem.
+//! Normally, Rust applications want errors that are `std::error::Error + Send + Sync + 'static`
+//! meaning:
+//! - They implement the [`std::error::Error`] trait
+//! - They can be sent across threads
+//! - They are safe to be referenced across threads
+//! - They do not borrow
+//!
+//! winnow provides [`Parser::parse`] to help with this:
+//! - Ensures we hit [`eof`]
+//! - Removes the [`ErrMode`] wrapper
+//! - Wraps the error in [`ParseError`]
+//! - Provides access to the original [`input`][ParseError::input] with the
+//! [`offset`][ParseError::offset] of where it failed
+//! - Provides a default renderer (via [`std::fmt::Display`])
+//! ```rust
+//! # use winnow::prelude::*;
+//! # use winnow::token::take_while;
+//! # use winnow::combinator::dispatch;
+//! # use winnow::token::take;
+//! # use winnow::combinator::fail;
+//! use winnow::Parser;
+//!
+//! #[derive(Debug, PartialEq, Eq)]
+//! pub struct Hex(usize);
+//!
+//! impl std::str::FromStr for Hex {
+//! type Err = String;
+//!
+//! fn from_str(input: &str) -> Result<Self, Self::Err> {
+//! parse_digits
+//! .map(Hex)
+//! .parse(input)
+//! .map_err(|e| e.to_string())
+//! }
+//! }
+//!
+//! // ...
+//! # fn parse_digits<'s>(input: &mut &'s str) -> PResult<usize> {
+//! # dispatch!(take(2usize);
+//! # "0b" => parse_bin_digits.try_map(|s| usize::from_str_radix(s, 2)),
+//! # "0o" => parse_oct_digits.try_map(|s| usize::from_str_radix(s, 8)),
+//! # "0d" => parse_dec_digits.try_map(|s| usize::from_str_radix(s, 10)),
+//! # "0x" => parse_hex_digits.try_map(|s| usize::from_str_radix(s, 16)),
+//! # _ => fail,
+//! # ).parse_next(input)
+//! # }
+//! #
+//! # fn parse_bin_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_oct_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='7'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_dec_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # )).parse_next(input)
+//! # }
+//! #
+//! # fn parse_hex_digits<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! # take_while(1.., (
+//! # ('0'..='9'),
+//! # ('A'..='F'),
+//! # ('a'..='f'),
+//! # )).parse_next(input)
+//! # }
+//!
+//! fn main() {
+//! let input = "0x1a2b";
+//! assert_eq!(input.parse::<Hex>().unwrap(), Hex(0x1a2b));
+//!
+//! let input = "0x1a2b Hello";
+//! assert!(input.parse::<Hex>().is_err());
+//! let input = "ghiHello";
+//! assert!(input.parse::<Hex>().is_err());
+//! }
+//! ```
+
+#![allow(unused_imports)]
+use super::chapter_1;
+use crate::combinator::eof;
+use crate::error::ErrMode;
+use crate::error::InputError;
+use crate::error::ParseError;
+use crate::PResult;
+use crate::Parser;
+
+pub use super::chapter_6 as previous;
+pub use super::chapter_8 as next;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/chapter_8.rs b/crates/winnow/src/_tutorial/chapter_8.rs
new file mode 100644
index 0000000..6ff8f29
--- /dev/null
+++ b/crates/winnow/src/_tutorial/chapter_8.rs
@@ -0,0 +1,34 @@
+//! # Chapter 8: Debugging
+//!
+//! When things inevitably go wrong, you can introspect the parsing state by running your test case
+//! with `--features debug`:
+//! 
+//!
+//! You can extend your own parsers to show up by wrapping their body with
+//! [`trace`][crate::combinator::trace]. Going back to [`do_nothing_parser`][super::chapter_1].
+//! ```rust
+//! # use winnow::PResult;
+//! # use winnow::Parser;
+//! use winnow::combinator::trace;
+//!
+//! pub fn do_nothing_parser<'s>(input: &mut &'s str) -> PResult<&'s str> {
+//! trace(
+//! "do_nothing_parser",
+//! |i: &mut _| Ok("")
+//! ).parse_next(input)
+//! }
+//! #
+//! # fn main() {
+//! # let mut input = "0x1a2b Hello";
+//! #
+//! # let output = do_nothing_parser.parse_next(&mut input).unwrap();
+//! # // Same as:
+//! # // let output = do_nothing_parser(&mut input).unwrap();
+//! #
+//! # assert_eq!(input, "0x1a2b Hello");
+//! # assert_eq!(output, "");
+//! # }
+//! ```
+
+pub use super::chapter_7 as previous;
+pub use crate::_tutorial as table_of_contents;
diff --git a/crates/winnow/src/_tutorial/mod.rs b/crates/winnow/src/_tutorial/mod.rs
new file mode 100644
index 0000000..3b1680e
--- /dev/null
+++ b/crates/winnow/src/_tutorial/mod.rs
@@ -0,0 +1,14 @@
+//! # Tutorial
+//!
+//! Table of Contents
+#![allow(clippy::std_instead_of_core)]
+
+pub mod chapter_0;
+pub mod chapter_1;
+pub mod chapter_2;
+pub mod chapter_3;
+pub mod chapter_4;
+pub mod chapter_5;
+pub mod chapter_6;
+pub mod chapter_7;
+pub mod chapter_8;
diff --git a/crates/winnow/src/ascii/mod.rs b/crates/winnow/src/ascii/mod.rs
new file mode 100644
index 0000000..8e6a480
--- /dev/null
+++ b/crates/winnow/src/ascii/mod.rs
@@ -0,0 +1,1727 @@
+//! Character specific parsers and combinators
+//!
+//! Functions recognizing specific characters
+
+#[cfg(test)]
+mod tests;
+
+use crate::lib::std::ops::{Add, Shl};
+
+use crate::combinator::alt;
+use crate::combinator::cut_err;
+use crate::combinator::opt;
+use crate::combinator::trace;
+use crate::error::ParserError;
+use crate::error::{ErrMode, ErrorKind, Needed};
+use crate::stream::{AsBStr, AsChar, ParseSlice, Stream, StreamIsPartial};
+use crate::stream::{Compare, CompareResult};
+use crate::token::one_of;
+use crate::token::take_till;
+use crate::token::take_while;
+use crate::PResult;
+use crate::Parser;
+
+/// Mark a value as case-insensitive for ASCII characters
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::ascii::Caseless;
+///
+/// fn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// Caseless("hello").parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser.parse_peek("hello, World!"), Ok((", World!", "hello")));
+/// assert_eq!(parser.parse_peek("HeLlo, World!"), Ok((", World!", "HeLlo")));
+/// assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+#[derive(Copy, Clone, Debug)]
+pub struct Caseless<T>(pub T);
+
+impl Caseless<&str> {
+ /// Get the byte-representation of this case-insensitive value
+ #[inline(always)]
+ pub fn as_bytes(&self) -> Caseless<&[u8]> {
+ Caseless(self.0.as_bytes())
+ }
+}
+
+/// Recognizes the string `"\r\n"`.
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::ascii::crlf;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// crlf.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("\r\nc"), Ok(("c", "\r\n")));
+/// assert_eq!(parser.parse_peek("ab\r\nc"), Err(ErrMode::Backtrack(InputError::new("ab\r\nc", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::crlf;
+/// assert_eq!(crlf::<_, InputError<_>>.parse_peek(Partial::new("\r\nc")), Ok((Partial::new("c"), "\r\n")));
+/// assert_eq!(crlf::<_, InputError<_>>.parse_peek(Partial::new("ab\r\nc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("ab\r\nc"), ErrorKind::Tag))));
+/// assert_eq!(crlf::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn crlf<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+{
+ trace("crlf", "\r\n").parse_next(input)
+}
+
+/// Recognizes a string of any char except `"\r\n"` or `"\n"`.
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::till_line_ending;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// till_line_ending.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("ab\r\nc"), Ok(("\r\nc", "ab")));
+/// assert_eq!(parser.parse_peek("ab\nc"), Ok(("\nc", "ab")));
+/// assert_eq!(parser.parse_peek("abc"), Ok(("", "abc")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// assert_eq!(parser.parse_peek("a\rb\nc"), Err(ErrMode::Backtrack(InputError::new("\rb\nc", ErrorKind::Tag ))));
+/// assert_eq!(parser.parse_peek("a\rbc"), Err(ErrMode::Backtrack(InputError::new("\rbc", ErrorKind::Tag ))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::till_line_ending;
+/// assert_eq!(till_line_ending::<_, InputError<_>>.parse_peek(Partial::new("ab\r\nc")), Ok((Partial::new("\r\nc"), "ab")));
+/// assert_eq!(till_line_ending::<_, InputError<_>>.parse_peek(Partial::new("abc")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(till_line_ending::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(till_line_ending::<_, InputError<_>>.parse_peek(Partial::new("a\rb\nc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("\rb\nc"), ErrorKind::Tag ))));
+/// assert_eq!(till_line_ending::<_, InputError<_>>.parse_peek(Partial::new("a\rbc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("\rbc"), ErrorKind::Tag ))));
+/// ```
+#[inline(always)]
+pub fn till_line_ending<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("till_line_ending", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ till_line_ending_::<_, _, true>(input)
+ } else {
+ till_line_ending_::<_, _, false>(input)
+ }
+ })
+ .parse_next(input)
+}
+
+/// Deprecated, replaced with [`till_line_ending`]
+#[deprecated(since = "0.5.35", note = "Replaced with `till_line_ending`")]
+#[inline(always)]
+pub fn not_line_ending<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ till_line_ending(input)
+}
+
+fn till_line_ending_<I, E: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ let res = take_till(0.., ('\r', '\n')).parse_next(input)?;
+ if input.compare("\r") == CompareResult::Ok {
+ let comp = input.compare("\r\n");
+ match comp {
+ //FIXME: calculate the right index
+ CompareResult::Ok => {}
+ CompareResult::Incomplete if PARTIAL && input.is_partial() => {
+ return Err(ErrMode::Incomplete(Needed::Unknown));
+ }
+ CompareResult::Incomplete | CompareResult::Error => {
+ let e: ErrorKind = ErrorKind::Tag;
+ return Err(ErrMode::from_error_kind(input, e));
+ }
+ }
+ }
+ Ok(res)
+}
+
+/// Recognizes an end of line (both `"\n"` and `"\r\n"`).
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::line_ending;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// line_ending.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("\r\nc"), Ok(("c", "\r\n")));
+/// assert_eq!(parser.parse_peek("ab\r\nc"), Err(ErrMode::Backtrack(InputError::new("ab\r\nc", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::line_ending;
+/// assert_eq!(line_ending::<_, InputError<_>>.parse_peek(Partial::new("\r\nc")), Ok((Partial::new("c"), "\r\n")));
+/// assert_eq!(line_ending::<_, InputError<_>>.parse_peek(Partial::new("ab\r\nc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("ab\r\nc"), ErrorKind::Tag))));
+/// assert_eq!(line_ending::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn line_ending<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+{
+ trace("line_ending", alt(("\n", "\r\n"))).parse_next(input)
+}
+
+/// Matches a newline character `'\n'`.
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::newline;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<char, InputError<&'s str>> {
+/// newline.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("\nc"), Ok(("c", '\n')));
+/// assert_eq!(parser.parse_peek("\r\nc"), Err(ErrMode::Backtrack(InputError::new("\r\nc", ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::newline;
+/// assert_eq!(newline::<_, InputError<_>>.parse_peek(Partial::new("\nc")), Ok((Partial::new("c"), '\n')));
+/// assert_eq!(newline::<_, InputError<_>>.parse_peek(Partial::new("\r\nc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("\r\nc"), ErrorKind::Verify))));
+/// assert_eq!(newline::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn newline<I, Error: ParserError<I>>(input: &mut I) -> PResult<char, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("newline", '\n'.map(AsChar::as_char)).parse_next(input)
+}
+
+/// Matches a tab character `'\t'`.
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::tab;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<char, InputError<&'s str>> {
+/// tab.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("\tc"), Ok(("c", '\t')));
+/// assert_eq!(parser.parse_peek("\r\nc"), Err(ErrMode::Backtrack(InputError::new("\r\nc", ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::tab;
+/// assert_eq!(tab::<_, InputError<_>>.parse_peek(Partial::new("\tc")), Ok((Partial::new("c"), '\t')));
+/// assert_eq!(tab::<_, InputError<_>>.parse_peek(Partial::new("\r\nc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("\r\nc"), ErrorKind::Verify))));
+/// assert_eq!(tab::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn tab<I, Error: ParserError<I>>(input: &mut I) -> PResult<char, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("tab", '\t'.map(AsChar::as_char)).parse_next(input)
+}
+
+/// Recognizes zero or more lowercase and uppercase ASCII alphabetic characters: `'a'..='z'`, `'A'..='Z'`
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non
+/// alphabetic character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non alphabetic character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::alpha0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alpha0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("ab1c"), Ok(("1c", "ab")));
+/// assert_eq!(parser.parse_peek("1c"), Ok(("1c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::alpha0;
+/// assert_eq!(alpha0::<_, InputError<_>>.parse_peek(Partial::new("ab1c")), Ok((Partial::new("1c"), "ab")));
+/// assert_eq!(alpha0::<_, InputError<_>>.parse_peek(Partial::new("1c")), Ok((Partial::new("1c"), "")));
+/// assert_eq!(alpha0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn alpha0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("alpha0", take_while(0.., AsChar::is_alpha)).parse_next(input)
+}
+
+/// Recognizes one or more lowercase and uppercase ASCII alphabetic characters: `'a'..='z'`, `'A'..='Z'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non alphabetic character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non alphabetic character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::alpha1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alpha1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("aB1c"), Ok(("1c", "aB")));
+/// assert_eq!(parser.parse_peek("1c"), Err(ErrMode::Backtrack(InputError::new("1c", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::alpha1;
+/// assert_eq!(alpha1::<_, InputError<_>>.parse_peek(Partial::new("aB1c")), Ok((Partial::new("1c"), "aB")));
+/// assert_eq!(alpha1::<_, InputError<_>>.parse_peek(Partial::new("1c")), Err(ErrMode::Backtrack(InputError::new(Partial::new("1c"), ErrorKind::Slice))));
+/// assert_eq!(alpha1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn alpha1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("alpha1", take_while(1.., AsChar::is_alpha)).parse_next(input)
+}
+
+/// Recognizes zero or more ASCII numerical characters: `'0'..='9'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::digit0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// digit0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21c"), Ok(("c", "21")));
+/// assert_eq!(parser.parse_peek("21"), Ok(("", "21")));
+/// assert_eq!(parser.parse_peek("a21c"), Ok(("a21c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::digit0;
+/// assert_eq!(digit0::<_, InputError<_>>.parse_peek(Partial::new("21c")), Ok((Partial::new("c"), "21")));
+/// assert_eq!(digit0::<_, InputError<_>>.parse_peek(Partial::new("a21c")), Ok((Partial::new("a21c"), "")));
+/// assert_eq!(digit0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn digit0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("digit0", take_while(0.., AsChar::is_dec_digit)).parse_next(input)
+}
+
+/// Recognizes one or more ASCII numerical characters: `'0'..='9'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::digit1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// digit1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21c"), Ok(("c", "21")));
+/// assert_eq!(parser.parse_peek("c1"), Err(ErrMode::Backtrack(InputError::new("c1", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::digit1;
+/// assert_eq!(digit1::<_, InputError<_>>.parse_peek(Partial::new("21c")), Ok((Partial::new("c"), "21")));
+/// assert_eq!(digit1::<_, InputError<_>>.parse_peek(Partial::new("c1")), Err(ErrMode::Backtrack(InputError::new(Partial::new("c1"), ErrorKind::Slice))));
+/// assert_eq!(digit1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+///
+/// ## Parsing an integer
+///
+/// You can use `digit1` in combination with [`Parser::try_map`] to parse an integer:
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed, Parser};
+/// # use winnow::ascii::digit1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<u32, InputError<&'s str>> {
+/// digit1.try_map(str::parse).parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("416"), Ok(("", 416)));
+/// assert_eq!(parser.parse_peek("12b"), Ok(("b", 12)));
+/// assert!(parser.parse_peek("b").is_err());
+/// ```
+#[inline(always)]
+pub fn digit1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("digit1", take_while(1.., AsChar::is_dec_digit)).parse_next(input)
+}
+
+/// Recognizes zero or more ASCII hexadecimal numerical characters: `'0'..='9'`, `'A'..='F'`,
+/// `'a'..='f'`
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non hexadecimal digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non hexadecimal digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::hex_digit0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// hex_digit0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ"), Ok(("Z", "21c")));
+/// assert_eq!(parser.parse_peek("Z21c"), Ok(("Z21c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::hex_digit0;
+/// assert_eq!(hex_digit0::<_, InputError<_>>.parse_peek(Partial::new("21cZ")), Ok((Partial::new("Z"), "21c")));
+/// assert_eq!(hex_digit0::<_, InputError<_>>.parse_peek(Partial::new("Z21c")), Ok((Partial::new("Z21c"), "")));
+/// assert_eq!(hex_digit0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn hex_digit0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("hex_digit0", take_while(0.., AsChar::is_hex_digit)).parse_next(input)
+}
+
+/// Recognizes one or more ASCII hexadecimal numerical characters: `'0'..='9'`, `'A'..='F'`,
+/// `'a'..='f'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non hexadecimal digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non hexadecimal digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::hex_digit1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// hex_digit1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ"), Ok(("Z", "21c")));
+/// assert_eq!(parser.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::hex_digit1;
+/// assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(Partial::new("21cZ")), Ok((Partial::new("Z"), "21c")));
+/// assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(Partial::new("H2")), Err(ErrMode::Backtrack(InputError::new(Partial::new("H2"), ErrorKind::Slice))));
+/// assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn hex_digit1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("hex_digit1", take_while(1.., AsChar::is_hex_digit)).parse_next(input)
+}
+
+/// Recognizes zero or more octal characters: `'0'..='7'`
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non octal
+/// digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non octal digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::oct_digit0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// oct_digit0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ"), Ok(("cZ", "21")));
+/// assert_eq!(parser.parse_peek("Z21c"), Ok(("Z21c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::oct_digit0;
+/// assert_eq!(oct_digit0::<_, InputError<_>>.parse_peek(Partial::new("21cZ")), Ok((Partial::new("cZ"), "21")));
+/// assert_eq!(oct_digit0::<_, InputError<_>>.parse_peek(Partial::new("Z21c")), Ok((Partial::new("Z21c"), "")));
+/// assert_eq!(oct_digit0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn oct_digit0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("oct_digit0", take_while(0.., AsChar::is_oct_digit)).parse_next(input)
+}
+
+/// Recognizes one or more octal characters: `'0'..='7'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non octal digit character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non octal digit character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::oct_digit1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// oct_digit1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ"), Ok(("cZ", "21")));
+/// assert_eq!(parser.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::oct_digit1;
+/// assert_eq!(oct_digit1::<_, InputError<_>>.parse_peek(Partial::new("21cZ")), Ok((Partial::new("cZ"), "21")));
+/// assert_eq!(oct_digit1::<_, InputError<_>>.parse_peek(Partial::new("H2")), Err(ErrMode::Backtrack(InputError::new(Partial::new("H2"), ErrorKind::Slice))));
+/// assert_eq!(oct_digit1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn oct_digit1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("oct_digit0", take_while(1.., AsChar::is_oct_digit)).parse_next(input)
+}
+
+/// Recognizes zero or more ASCII numerical and alphabetic characters: `'a'..='z'`, `'A'..='Z'`, `'0'..='9'`
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non
+/// alphanumerical character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non alphanumerical character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::alphanumeric0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alphanumeric0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ%1"), Ok(("%1", "21cZ")));
+/// assert_eq!(parser.parse_peek("&Z21c"), Ok(("&Z21c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::alphanumeric0;
+/// assert_eq!(alphanumeric0::<_, InputError<_>>.parse_peek(Partial::new("21cZ%1")), Ok((Partial::new("%1"), "21cZ")));
+/// assert_eq!(alphanumeric0::<_, InputError<_>>.parse_peek(Partial::new("&Z21c")), Ok((Partial::new("&Z21c"), "")));
+/// assert_eq!(alphanumeric0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn alphanumeric0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("alphanumeric0", take_while(0.., AsChar::is_alphanum)).parse_next(input)
+}
+
+/// Recognizes one or more ASCII numerical and alphabetic characters: `'a'..='z'`, `'A'..='Z'`, `'0'..='9'`
+///
+/// *Complete version*: Will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non alphanumerical character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non alphanumerical character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::alphanumeric1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alphanumeric1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("21cZ%1"), Ok(("%1", "21cZ")));
+/// assert_eq!(parser.parse_peek("&H2"), Err(ErrMode::Backtrack(InputError::new("&H2", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::alphanumeric1;
+/// assert_eq!(alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new("21cZ%1")), Ok((Partial::new("%1"), "21cZ")));
+/// assert_eq!(alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new("&H2")), Err(ErrMode::Backtrack(InputError::new(Partial::new("&H2"), ErrorKind::Slice))));
+/// assert_eq!(alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn alphanumeric1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar,
+{
+ trace("alphanumeric1", take_while(1.., AsChar::is_alphanum)).parse_next(input)
+}
+
+/// Recognizes zero or more spaces and tabs.
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non space
+/// character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non space character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::space0;
+/// assert_eq!(space0::<_, InputError<_>>.parse_peek(Partial::new(" \t21c")), Ok((Partial::new("21c"), " \t")));
+/// assert_eq!(space0::<_, InputError<_>>.parse_peek(Partial::new("Z21c")), Ok((Partial::new("Z21c"), "")));
+/// assert_eq!(space0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn space0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("space0", take_while(0.., AsChar::is_space)).parse_next(input)
+}
+
+/// Recognizes zero or more spaces and tabs.
+///
+/// *Complete version*: Will return the whole input if no terminating token is found (a non space
+/// character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non space character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::space1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// space1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek(" \t21c"), Ok(("21c", " \t")));
+/// assert_eq!(parser.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::space1;
+/// assert_eq!(space1::<_, InputError<_>>.parse_peek(Partial::new(" \t21c")), Ok((Partial::new("21c"), " \t")));
+/// assert_eq!(space1::<_, InputError<_>>.parse_peek(Partial::new("H2")), Err(ErrMode::Backtrack(InputError::new(Partial::new("H2"), ErrorKind::Slice))));
+/// assert_eq!(space1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn space1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("space1", take_while(1.., AsChar::is_space)).parse_next(input)
+}
+
+/// Recognizes zero or more spaces, tabs, carriage returns and line feeds.
+///
+/// *Complete version*: will return the whole input if no terminating token is found (a non space
+/// character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non space character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::ascii::multispace0;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// multispace0.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek(" \t\n\r21c"), Ok(("21c", " \t\n\r")));
+/// assert_eq!(parser.parse_peek("Z21c"), Ok(("Z21c", "")));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::multispace0;
+/// assert_eq!(multispace0::<_, InputError<_>>.parse_peek(Partial::new(" \t\n\r21c")), Ok((Partial::new("21c"), " \t\n\r")));
+/// assert_eq!(multispace0::<_, InputError<_>>.parse_peek(Partial::new("Z21c")), Ok((Partial::new("Z21c"), "")));
+/// assert_eq!(multispace0::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn multispace0<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("multispace0", take_while(0.., (' ', '\t', '\r', '\n'))).parse_next(input)
+}
+
+/// Recognizes one or more spaces, tabs, carriage returns and line feeds.
+///
+/// *Complete version*: will return an error if there's not enough input data,
+/// or the whole input if no terminating token is found (a non space character).
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data,
+/// or if no terminating token is found (a non space character).
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::ascii::multispace1;
+/// fn parser<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// multispace1.parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek(" \t\n\r21c"), Ok(("21c", " \t\n\r")));
+/// assert_eq!(parser.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::ascii::multispace1;
+/// assert_eq!(multispace1::<_, InputError<_>>.parse_peek(Partial::new(" \t\n\r21c")), Ok((Partial::new("21c"), " \t\n\r")));
+/// assert_eq!(multispace1::<_, InputError<_>>.parse_peek(Partial::new("H2")), Err(ErrMode::Backtrack(InputError::new(Partial::new("H2"), ErrorKind::Slice))));
+/// assert_eq!(multispace1::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn multispace1<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+{
+ trace("multispace1", take_while(1.., (' ', '\t', '\r', '\n'))).parse_next(input)
+}
+
+/// Decode a decimal unsigned integer (e.g. [`u32`])
+///
+/// *Complete version*: can parse until the end of input.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+#[doc(alias = "u8")]
+#[doc(alias = "u16")]
+#[doc(alias = "u32")]
+#[doc(alias = "u64")]
+#[doc(alias = "u128")]
+pub fn dec_uint<I, O, E: ParserError<I>>(input: &mut I) -> PResult<O, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+ O: Uint,
+{
+ trace("dec_uint", move |input: &mut I| {
+ if input.eof_offset() == 0 {
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ return Err(ErrMode::Incomplete(Needed::new(1)));
+ } else {
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ }
+ }
+
+ let mut value = O::default();
+ for (offset, c) in input.iter_offsets() {
+ match c.as_char().to_digit(10) {
+ Some(d) => match value.checked_mul(10, sealed::SealedMarker).and_then(|v| {
+ let d = d as u8;
+ v.checked_add(d, sealed::SealedMarker)
+ }) {
+ None => return Err(ErrMode::from_error_kind(input, ErrorKind::Verify)),
+ Some(v) => value = v,
+ },
+ None => {
+ if offset == 0 {
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ } else {
+ let _ = input.next_slice(offset);
+ return Ok(value);
+ }
+ }
+ }
+ }
+
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ } else {
+ let _ = input.finish();
+ Ok(value)
+ }
+ })
+ .parse_next(input)
+}
+
+/// Metadata for parsing unsigned integers, see [`dec_uint`]
+pub trait Uint: Default {
+ #[doc(hidden)]
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self>;
+ #[doc(hidden)]
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self>;
+}
+
+impl Uint for u8 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+impl Uint for u16 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+impl Uint for u32 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+impl Uint for u64 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+impl Uint for u128 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Deprecated since v0.5.17
+impl Uint for i8 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Deprecated since v0.5.17
+impl Uint for i16 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Deprecated since v0.5.17
+impl Uint for i32 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Deprecated since v0.5.17
+impl Uint for i64 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Deprecated since v0.5.17
+impl Uint for i128 {
+ fn checked_mul(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_mul(by as Self)
+ }
+ fn checked_add(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_add(by as Self)
+ }
+}
+
+/// Decode a decimal signed integer (e.g. [`i32`])
+///
+/// *Complete version*: can parse until the end of input.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+#[doc(alias = "i8")]
+#[doc(alias = "i16")]
+#[doc(alias = "i32")]
+#[doc(alias = "i64")]
+#[doc(alias = "i128")]
+pub fn dec_int<I, O, E: ParserError<I>>(input: &mut I) -> PResult<O, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+ O: Int,
+{
+ trace("dec_int", move |input: &mut I| {
+ fn sign(token: impl AsChar) -> bool {
+ let token = token.as_char();
+ token == '+' || token == '-'
+ }
+ let sign = opt(crate::token::one_of(sign).map(AsChar::as_char))
+ .map(|c| c != Some('-'))
+ .parse_next(input)?;
+
+ if input.eof_offset() == 0 {
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ return Err(ErrMode::Incomplete(Needed::new(1)));
+ } else {
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ }
+ }
+
+ let mut value = O::default();
+ for (offset, c) in input.iter_offsets() {
+ match c.as_char().to_digit(10) {
+ Some(d) => match value.checked_mul(10, sealed::SealedMarker).and_then(|v| {
+ let d = d as u8;
+ if sign {
+ v.checked_add(d, sealed::SealedMarker)
+ } else {
+ v.checked_sub(d, sealed::SealedMarker)
+ }
+ }) {
+ None => return Err(ErrMode::from_error_kind(input, ErrorKind::Verify)),
+ Some(v) => value = v,
+ },
+ None => {
+ if offset == 0 {
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ } else {
+ let _ = input.next_slice(offset);
+ return Ok(value);
+ }
+ }
+ }
+ }
+
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ } else {
+ let _ = input.finish();
+ Ok(value)
+ }
+ })
+ .parse_next(input)
+}
+
+/// Metadata for parsing signed integers, see [`dec_int`]
+pub trait Int: Uint {
+ #[doc(hidden)]
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self>;
+}
+
+impl Int for i8 {
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_sub(by as Self)
+ }
+}
+
+impl Int for i16 {
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_sub(by as Self)
+ }
+}
+
+impl Int for i32 {
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_sub(by as Self)
+ }
+}
+
+impl Int for i64 {
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_sub(by as Self)
+ }
+}
+
+impl Int for i128 {
+ fn checked_sub(self, by: u8, _: sealed::SealedMarker) -> Option<Self> {
+ self.checked_sub(by as Self)
+ }
+}
+
+/// Decode a variable-width hexadecimal integer (e.g. [`u32`])
+///
+/// *Complete version*: Will parse until the end of input if it has fewer characters than the type
+/// supports.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if end-of-input
+/// is hit before a hard boundary (non-hex character, more characters than supported).
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// use winnow::ascii::hex_uint;
+///
+/// fn parser<'s>(s: &mut &'s [u8]) -> PResult<u32, InputError<&'s [u8]>> {
+/// hex_uint(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(&b"01AE"[..]), Ok((&b""[..], 0x01AE)));
+/// assert_eq!(parser.parse_peek(&b"abc"[..]), Ok((&b""[..], 0x0ABC)));
+/// assert_eq!(parser.parse_peek(&b"ggg"[..]), Err(ErrMode::Backtrack(InputError::new(&b"ggg"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// use winnow::ascii::hex_uint;
+///
+/// fn parser<'s>(s: &mut Partial<&'s [u8]>) -> PResult<u32, InputError<Partial<&'s [u8]>>> {
+/// hex_uint(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(Partial::new(&b"01AE;"[..])), Ok((Partial::new(&b";"[..]), 0x01AE)));
+/// assert_eq!(parser.parse_peek(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(parser.parse_peek(Partial::new(&b"ggg"[..])), Err(ErrMode::Backtrack(InputError::new(Partial::new(&b"ggg"[..]), ErrorKind::Slice))));
+/// ```
+#[inline]
+pub fn hex_uint<I, O, E: ParserError<I>>(input: &mut I) -> PResult<O, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ O: HexUint,
+ <I as Stream>::Token: AsChar,
+ <I as Stream>::Slice: AsBStr,
+{
+ trace("hex_uint", move |input: &mut I| {
+ let invalid_offset = input
+ .offset_for(|c| {
+ let c = c.as_char();
+ !"0123456789abcdefABCDEF".contains(c)
+ })
+ .unwrap_or_else(|| input.eof_offset());
+ let max_nibbles = O::max_nibbles(sealed::SealedMarker);
+ let max_offset = input.offset_at(max_nibbles);
+ let offset = match max_offset {
+ Ok(max_offset) => {
+ if max_offset < invalid_offset {
+ // Overflow
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Verify));
+ } else {
+ invalid_offset
+ }
+ }
+ Err(_) => {
+ if <I as StreamIsPartial>::is_partial_supported()
+ && input.is_partial()
+ && invalid_offset == input.eof_offset()
+ {
+ // Only the next byte is guaranteed required
+ return Err(ErrMode::Incomplete(Needed::new(1)));
+ } else {
+ invalid_offset
+ }
+ }
+ };
+ if offset == 0 {
+ // Must be at least one digit
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ }
+ let parsed = input.next_slice(offset);
+
+ let mut res = O::default();
+ for c in parsed.as_bstr() {
+ let nibble = *c as char;
+ let nibble = nibble.to_digit(16).unwrap_or(0) as u8;
+ let nibble = O::from(nibble);
+ res = (res << O::from(4)) + nibble;
+ }
+
+ Ok(res)
+ })
+ .parse_next(input)
+}
+
+/// Metadata for parsing hex numbers, see [`hex_uint`]
+pub trait HexUint:
+ Default + Shl<Self, Output = Self> + Add<Self, Output = Self> + From<u8>
+{
+ #[doc(hidden)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize;
+}
+
+impl HexUint for u8 {
+ #[inline(always)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize {
+ 2
+ }
+}
+
+impl HexUint for u16 {
+ #[inline(always)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize {
+ 4
+ }
+}
+
+impl HexUint for u32 {
+ #[inline(always)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize {
+ 8
+ }
+}
+
+impl HexUint for u64 {
+ #[inline(always)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize {
+ 16
+ }
+}
+
+impl HexUint for u128 {
+ #[inline(always)]
+ fn max_nibbles(_: sealed::SealedMarker) -> usize {
+ 32
+ }
+}
+
+/// Recognizes floating point number in text format and returns a [`f32`] or [`f64`].
+///
+/// *Complete version*: Can parse until the end of input.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::error::Needed::Size;
+/// use winnow::ascii::float;
+///
+/// fn parser<'s>(s: &mut &'s str) -> PResult<f64, InputError<&'s str>> {
+/// float(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek("11e-1"), Ok(("", 1.1)));
+/// assert_eq!(parser.parse_peek("123E-02"), Ok(("", 1.23)));
+/// assert_eq!(parser.parse_peek("123K-01"), Ok(("K-01", 123.0)));
+/// assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Tag))));
+/// ```
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::ascii::float;
+///
+/// fn parser<'s>(s: &mut Partial<&'s str>) -> PResult<f64, InputError<Partial<&'s str>>> {
+/// float(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(Partial::new("11e-1 ")), Ok((Partial::new(" "), 1.1)));
+/// assert_eq!(parser.parse_peek(Partial::new("11e-1")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(parser.parse_peek(Partial::new("123E-02")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(parser.parse_peek(Partial::new("123K-01")), Ok((Partial::new("K-01"), 123.0)));
+/// assert_eq!(parser.parse_peek(Partial::new("abc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("abc"), ErrorKind::Tag))));
+/// ```
+#[inline(always)]
+#[doc(alias = "f32")]
+#[doc(alias = "double")]
+#[allow(clippy::trait_duplication_in_bounds)] // HACK: clippy 1.64.0 bug
+pub fn float<I, O, E: ParserError<I>>(input: &mut I) -> PResult<O, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Slice: ParseSlice<O>,
+ <I as Stream>::Token: AsChar + Clone,
+ <I as Stream>::IterOffsets: Clone,
+ I: AsBStr,
+{
+ trace("float", move |input: &mut I| {
+ let s = recognize_float_or_exceptions(input)?;
+ s.parse_slice()
+ .ok_or_else(|| ErrMode::from_error_kind(input, ErrorKind::Verify))
+ })
+ .parse_next(input)
+}
+
+#[allow(clippy::trait_duplication_in_bounds)] // HACK: clippy 1.64.0 bug
+#[allow(deprecated)]
+fn recognize_float_or_exceptions<I, E: ParserError<I>>(
+ input: &mut I,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Token: AsChar + Clone,
+ <I as Stream>::IterOffsets: Clone,
+ I: AsBStr,
+{
+ alt((
+ recognize_float,
+ crate::token::tag_no_case("nan"),
+ (
+ opt(one_of(['+', '-'])),
+ crate::token::tag_no_case("infinity"),
+ )
+ .recognize(),
+ (opt(one_of(['+', '-'])), crate::token::tag_no_case("inf")).recognize(),
+ ))
+ .parse_next(input)
+}
+
+#[allow(clippy::trait_duplication_in_bounds)] // HACK: clippy 1.64.0 bug
+fn recognize_float<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ I: Compare<&'static str>,
+ <I as Stream>::Token: AsChar + Clone,
+ <I as Stream>::IterOffsets: Clone,
+ I: AsBStr,
+{
+ (
+ opt(one_of(['+', '-'])),
+ alt((
+ (digit1, opt(('.', opt(digit1)))).map(|_| ()),
+ ('.', digit1).map(|_| ()),
+ )),
+ opt((one_of(['e', 'E']), opt(one_of(['+', '-'])), cut_err(digit1))),
+ )
+ .recognize()
+ .parse_next(input)
+}
+
+/// Matches a byte string with escaped characters.
+///
+/// * The first argument matches the normal characters (it must not accept the control character)
+/// * The second argument is the control character (like `\` in most languages)
+/// * The third argument matches the escaped characters
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed, IResult};
+/// # use winnow::ascii::digit1;
+/// # use winnow::prelude::*;
+/// use winnow::ascii::escaped;
+/// use winnow::token::one_of;
+///
+/// fn esc(s: &str) -> IResult<&str, &str> {
+/// escaped(digit1, '\\', one_of(['"', 'n', '\\'])).parse_peek(s)
+/// }
+///
+/// assert_eq!(esc("123;"), Ok((";", "123")));
+/// assert_eq!(esc(r#"12\"34;"#), Ok((";", r#"12\"34"#)));
+/// ```
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed, IResult};
+/// # use winnow::ascii::digit1;
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::ascii::escaped;
+/// use winnow::token::one_of;
+///
+/// fn esc(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// escaped(digit1, '\\', one_of(['"', 'n', '\\'])).parse_peek(s)
+/// }
+///
+/// assert_eq!(esc(Partial::new("123;")), Ok((Partial::new(";"), "123")));
+/// assert_eq!(esc(Partial::new("12\\\"34;")), Ok((Partial::new(";"), "12\\\"34")));
+/// ```
+#[inline(always)]
+pub fn escaped<'a, I: 'a, Error, F, G, O1, O2>(
+ mut normal: F,
+ control_char: char,
+ mut escapable: G,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+ F: Parser<I, O1, Error>,
+ G: Parser<I, O2, Error>,
+ Error: ParserError<I>,
+{
+ trace("escaped", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ streaming_escaped_internal(input, &mut normal, control_char, &mut escapable)
+ } else {
+ complete_escaped_internal(input, &mut normal, control_char, &mut escapable)
+ }
+ })
+}
+
+fn streaming_escaped_internal<I, Error, F, G, O1, O2>(
+ input: &mut I,
+ normal: &mut F,
+ control_char: char,
+ escapable: &mut G,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+ F: Parser<I, O1, Error>,
+ G: Parser<I, O2, Error>,
+ Error: ParserError<I>,
+{
+ let start = input.checkpoint();
+
+ while input.eof_offset() > 0 {
+ let current_len = input.eof_offset();
+
+ match opt(normal.by_ref()).parse_next(input)? {
+ Some(_) => {
+ if input.eof_offset() == current_len {
+ let offset = input.offset_from(&start);
+ input.reset(start);
+ return Ok(input.next_slice(offset));
+ }
+ }
+ None => {
+ if opt(control_char).parse_next(input)?.is_some() {
+ let _ = escapable.parse_next(input)?;
+ } else {
+ let offset = input.offset_from(&start);
+ input.reset(start);
+ return Ok(input.next_slice(offset));
+ }
+ }
+ }
+ }
+
+ Err(ErrMode::Incomplete(Needed::Unknown))
+}
+
+fn complete_escaped_internal<'a, I: 'a, Error, F, G, O1, O2>(
+ input: &mut I,
+ normal: &mut F,
+ control_char: char,
+ escapable: &mut G,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: crate::stream::AsChar + Clone,
+ F: Parser<I, O1, Error>,
+ G: Parser<I, O2, Error>,
+ Error: ParserError<I>,
+{
+ let start = input.checkpoint();
+
+ while input.eof_offset() > 0 {
+ let current_len = input.eof_offset();
+
+ match opt(normal.by_ref()).parse_next(input)? {
+ Some(_) => {
+ if input.eof_offset() == current_len {
+ let offset = input.offset_from(&start);
+ input.reset(start);
+ return Ok(input.next_slice(offset));
+ }
+ }
+ None => {
+ if opt(control_char).parse_next(input)?.is_some() {
+ let _ = escapable.parse_next(input)?;
+ } else {
+ let offset = input.offset_from(&start);
+ input.reset(start);
+ return Ok(input.next_slice(offset));
+ }
+ }
+ }
+ }
+
+ input.reset(start);
+ Ok(input.finish())
+}
+
+/// Matches a byte string with escaped characters.
+///
+/// * The first argument matches the normal characters (it must not match the control character)
+/// * The second argument is the control character (like `\` in most languages)
+/// * The third argument matches the escaped characters and transforms them
+///
+/// As an example, the chain `abc\tdef` could be `abc def` (it also consumes the control character)
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use std::str::from_utf8;
+/// use winnow::token::tag;
+/// use winnow::ascii::escaped_transform;
+/// use winnow::ascii::alpha1;
+/// use winnow::combinator::alt;
+///
+/// fn parser<'s>(input: &mut &'s str) -> PResult<String, InputError<&'s str>> {
+/// escaped_transform(
+/// alpha1,
+/// '\\',
+/// alt((
+/// "\\".value("\\"),
+/// "\"".value("\""),
+/// "n".value("\n"),
+/// ))
+/// ).parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek("ab\\\"cd"), Ok(("", String::from("ab\"cd"))));
+/// assert_eq!(parser.parse_peek("ab\\ncd"), Ok(("", String::from("ab\ncd"))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use std::str::from_utf8;
+/// # use winnow::Partial;
+/// use winnow::token::tag;
+/// use winnow::ascii::escaped_transform;
+/// use winnow::ascii::alpha1;
+/// use winnow::combinator::alt;
+///
+/// fn parser<'s>(input: &mut Partial<&'s str>) -> PResult<String, InputError<Partial<&'s str>>> {
+/// escaped_transform(
+/// alpha1,
+/// '\\',
+/// alt((
+/// "\\".value("\\"),
+/// "\"".value("\""),
+/// "n".value("\n"),
+/// ))
+/// ).parse_next(input)
+/// }
+///
+/// assert_eq!(parser.parse_peek(Partial::new("ab\\\"cd\"")), Ok((Partial::new("\""), String::from("ab\"cd"))));
+/// ```
+#[inline(always)]
+pub fn escaped_transform<I, Error, F, G, Output>(
+ mut normal: F,
+ control_char: char,
+ mut transform: G,
+) -> impl Parser<I, Output, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: crate::stream::AsChar + Clone,
+ Output: crate::stream::Accumulate<<I as Stream>::Slice>,
+ F: Parser<I, <I as Stream>::Slice, Error>,
+ G: Parser<I, <I as Stream>::Slice, Error>,
+ Error: ParserError<I>,
+{
+ trace("escaped_transform", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() && input.is_partial() {
+ streaming_escaped_transform_internal(input, &mut normal, control_char, &mut transform)
+ } else {
+ complete_escaped_transform_internal(input, &mut normal, control_char, &mut transform)
+ }
+ })
+}
+
+fn streaming_escaped_transform_internal<I, Error, F, G, Output>(
+ input: &mut I,
+ normal: &mut F,
+ control_char: char,
+ transform: &mut G,
+) -> PResult<Output, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: crate::stream::AsChar + Clone,
+ Output: crate::stream::Accumulate<<I as Stream>::Slice>,
+ F: Parser<I, <I as Stream>::Slice, Error>,
+ G: Parser<I, <I as Stream>::Slice, Error>,
+ Error: ParserError<I>,
+{
+ let mut res = Output::initial(Some(input.eof_offset()));
+
+ while input.eof_offset() > 0 {
+ let current_len = input.eof_offset();
+ match opt(normal.by_ref()).parse_next(input)? {
+ Some(o) => {
+ res.accumulate(o);
+ if input.eof_offset() == current_len {
+ return Ok(res);
+ }
+ }
+ None => {
+ if opt(control_char).parse_next(input)?.is_some() {
+ let o = transform.parse_next(input)?;
+ res.accumulate(o);
+ } else {
+ return Ok(res);
+ }
+ }
+ }
+ }
+ Err(ErrMode::Incomplete(Needed::Unknown))
+}
+
+fn complete_escaped_transform_internal<I, Error, F, G, Output>(
+ input: &mut I,
+ normal: &mut F,
+ control_char: char,
+ transform: &mut G,
+) -> PResult<Output, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: crate::stream::AsChar + Clone,
+ Output: crate::stream::Accumulate<<I as Stream>::Slice>,
+ F: Parser<I, <I as Stream>::Slice, Error>,
+ G: Parser<I, <I as Stream>::Slice, Error>,
+ Error: ParserError<I>,
+{
+ let mut res = Output::initial(Some(input.eof_offset()));
+
+ while input.eof_offset() > 0 {
+ let current_len = input.eof_offset();
+
+ match opt(normal.by_ref()).parse_next(input)? {
+ Some(o) => {
+ res.accumulate(o);
+ if input.eof_offset() == current_len {
+ return Ok(res);
+ }
+ }
+ None => {
+ if opt(control_char).parse_next(input)?.is_some() {
+ let o = transform.parse_next(input)?;
+ res.accumulate(o);
+ } else {
+ return Ok(res);
+ }
+ }
+ }
+ }
+ Ok(res)
+}
+
+mod sealed {
+ pub struct SealedMarker;
+}
diff --git a/crates/winnow/src/ascii/tests.rs b/crates/winnow/src/ascii/tests.rs
new file mode 100644
index 0000000..5091dc5
--- /dev/null
+++ b/crates/winnow/src/ascii/tests.rs
@@ -0,0 +1,1575 @@
+use super::*;
+use crate::prelude::*;
+
+mod complete {
+ use super::*;
+ use crate::combinator::alt;
+ use crate::combinator::opt;
+ use crate::error::ErrMode;
+ use crate::error::ErrorKind;
+ use crate::error::InputError;
+ use crate::stream::ParseSlice;
+ use crate::token::none_of;
+ use crate::token::one_of;
+ #[cfg(feature = "alloc")]
+ use crate::{lib::std::string::String, lib::std::vec::Vec};
+ use proptest::prelude::*;
+
+ macro_rules! assert_parse(
+ ($left: expr, $right: expr) => {
+ let res: $crate::IResult<_, _, InputError<_>> = $left;
+ assert_eq!(res, $right);
+ };
+ );
+
+ #[test]
+ fn character() {
+ let empty: &[u8] = b"";
+ let a: &[u8] = b"abcd";
+ let b: &[u8] = b"1234";
+ let c: &[u8] = b"a123";
+ let d: &[u8] = "azé12".as_bytes();
+ let e: &[u8] = b" ";
+ let f: &[u8] = b" ;";
+ //assert_eq!(alpha1::<_, InputError>(a), Err(ErrMode::Incomplete(Needed::Size(1))));
+ assert_parse!(alpha1.parse_peek(a), Ok((empty, a)));
+ assert_eq!(
+ alpha1.parse_peek(b),
+ Err(ErrMode::Backtrack(InputError::new(b, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(c),
+ Ok((&c[1..], &b"a"[..]))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(d),
+ Ok(("é12".as_bytes(), &b"az"[..]))
+ );
+ assert_eq!(
+ digit1.parse_peek(a),
+ Err(ErrMode::Backtrack(InputError::new(a, ErrorKind::Slice)))
+ );
+ assert_eq!(digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(
+ digit1.parse_peek(c),
+ Err(ErrMode::Backtrack(InputError::new(c, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ digit1.parse_peek(d),
+ Err(ErrMode::Backtrack(InputError::new(d, ErrorKind::Slice)))
+ );
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(a), Ok((empty, a)));
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(c), Ok((empty, c)));
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(d),
+ Ok(("zé12".as_bytes(), &b"a"[..]))
+ );
+ assert_eq!(
+ hex_digit1.parse_peek(e),
+ Err(ErrMode::Backtrack(InputError::new(e, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(a),
+ Err(ErrMode::Backtrack(InputError::new(a, ErrorKind::Slice)))
+ );
+ assert_eq!(oct_digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(
+ oct_digit1.parse_peek(c),
+ Err(ErrMode::Backtrack(InputError::new(c, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(d),
+ Err(ErrMode::Backtrack(InputError::new(d, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(a),
+ Ok((empty, a))
+ );
+ //assert_eq!(fix_error!(b,(), alphanumeric), Ok((empty, b)));
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(c),
+ Ok((empty, c))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(d),
+ Ok(("é12".as_bytes(), &b"az"[..]))
+ );
+ assert_eq!(space1::<_, InputError<_>>.parse_peek(e), Ok((empty, e)));
+ assert_eq!(
+ space1::<_, InputError<_>>.parse_peek(f),
+ Ok((&b";"[..], &b" "[..]))
+ );
+ }
+
+ #[cfg(feature = "alloc")]
+ #[test]
+ fn character_s() {
+ let empty = "";
+ let a = "abcd";
+ let b = "1234";
+ let c = "a123";
+ let d = "azé12";
+ let e = " ";
+ assert_eq!(alpha1::<_, InputError<_>>.parse_peek(a), Ok((empty, a)));
+ assert_eq!(
+ alpha1.parse_peek(b),
+ Err(ErrMode::Backtrack(InputError::new(b, ErrorKind::Slice)))
+ );
+ assert_eq!(alpha1::<_, InputError<_>>.parse_peek(c), Ok((&c[1..], "a")));
+ assert_eq!(alpha1::<_, InputError<_>>.parse_peek(d), Ok(("é12", "az")));
+ assert_eq!(
+ digit1.parse_peek(a),
+ Err(ErrMode::Backtrack(InputError::new(a, ErrorKind::Slice)))
+ );
+ assert_eq!(digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(
+ digit1.parse_peek(c),
+ Err(ErrMode::Backtrack(InputError::new(c, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ digit1.parse_peek(d),
+ Err(ErrMode::Backtrack(InputError::new(d, ErrorKind::Slice)))
+ );
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(a), Ok((empty, a)));
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(hex_digit1::<_, InputError<_>>.parse_peek(c), Ok((empty, c)));
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(d),
+ Ok(("zé12", "a"))
+ );
+ assert_eq!(
+ hex_digit1.parse_peek(e),
+ Err(ErrMode::Backtrack(InputError::new(e, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(a),
+ Err(ErrMode::Backtrack(InputError::new(a, ErrorKind::Slice)))
+ );
+ assert_eq!(oct_digit1::<_, InputError<_>>.parse_peek(b), Ok((empty, b)));
+ assert_eq!(
+ oct_digit1.parse_peek(c),
+ Err(ErrMode::Backtrack(InputError::new(c, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(d),
+ Err(ErrMode::Backtrack(InputError::new(d, ErrorKind::Slice)))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(a),
+ Ok((empty, a))
+ );
+ //assert_eq!(fix_error!(b,(), alphanumeric), Ok((empty, b)));
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(c),
+ Ok((empty, c))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(d),
+ Ok(("é12", "az"))
+ );
+ assert_eq!(space1::<_, InputError<_>>.parse_peek(e), Ok((empty, e)));
+ }
+
+ use crate::stream::Offset;
+ #[test]
+ fn offset() {
+ let a = &b"abcd;"[..];
+ let b = &b"1234;"[..];
+ let c = &b"a123;"[..];
+ let d = &b" \t;"[..];
+ let e = &b" \t\r\n;"[..];
+ let f = &b"123abcDEF;"[..];
+
+ match alpha1::<_, InputError<_>>.parse_peek(a) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&a) + i.len(), a.len());
+ }
+ _ => panic!("wrong return type in offset test for alpha"),
+ }
+ match digit1::<_, InputError<_>>.parse_peek(b) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&b) + i.len(), b.len());
+ }
+ _ => panic!("wrong return type in offset test for digit"),
+ }
+ match alphanumeric1::<_, InputError<_>>.parse_peek(c) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&c) + i.len(), c.len());
+ }
+ _ => panic!("wrong return type in offset test for alphanumeric"),
+ }
+ match space1::<_, InputError<_>>.parse_peek(d) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&d) + i.len(), d.len());
+ }
+ _ => panic!("wrong return type in offset test for space"),
+ }
+ match multispace1::<_, InputError<_>>.parse_peek(e) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&e) + i.len(), e.len());
+ }
+ _ => panic!("wrong return type in offset test for multispace"),
+ }
+ match hex_digit1::<_, InputError<_>>.parse_peek(f) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&f) + i.len(), f.len());
+ }
+ _ => panic!("wrong return type in offset test for hex_digit"),
+ }
+ match oct_digit1::<_, InputError<_>>.parse_peek(f) {
+ Ok((i, _)) => {
+ assert_eq!(i.offset_from(&f) + i.len(), f.len());
+ }
+ _ => panic!("wrong return type in offset test for oct_digit"),
+ }
+ }
+
+ #[test]
+ fn is_till_line_ending_bytes() {
+ let a: &[u8] = b"ab12cd\nefgh";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(a),
+ Ok((&b"\nefgh"[..], &b"ab12cd"[..]))
+ );
+
+ let b: &[u8] = b"ab12cd\nefgh\nijkl";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(b),
+ Ok((&b"\nefgh\nijkl"[..], &b"ab12cd"[..]))
+ );
+
+ let c: &[u8] = b"ab12cd\r\nefgh\nijkl";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(c),
+ Ok((&b"\r\nefgh\nijkl"[..], &b"ab12cd"[..]))
+ );
+
+ let d: &[u8] = b"ab12cd";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(d),
+ Ok((&[][..], d))
+ );
+ }
+
+ #[test]
+ fn is_till_line_ending_str() {
+ let f = "βèƒôřè\rÂßÇáƒƭèř";
+ assert_eq!(
+ till_line_ending.parse_peek(f),
+ Err(ErrMode::Backtrack(InputError::new(
+ &f[12..],
+ ErrorKind::Tag
+ )))
+ );
+
+ let g2: &str = "ab12cd";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(g2),
+ Ok(("", g2))
+ );
+ }
+
+ #[test]
+ fn hex_digit_test() {
+ let i = &b"0123456789abcdefABCDEF;"[..];
+ assert_parse!(hex_digit1.parse_peek(i), Ok((&b";"[..], &i[..i.len() - 1])));
+
+ let i = &b"g"[..];
+ assert_parse!(
+ hex_digit1.parse_peek(i),
+ Err(ErrMode::Backtrack(error_position!(&i, ErrorKind::Slice)))
+ );
+
+ let i = &b"G"[..];
+ assert_parse!(
+ hex_digit1.parse_peek(i),
+ Err(ErrMode::Backtrack(error_position!(&i, ErrorKind::Slice)))
+ );
+
+ assert!(AsChar::is_hex_digit(b'0'));
+ assert!(AsChar::is_hex_digit(b'9'));
+ assert!(AsChar::is_hex_digit(b'a'));
+ assert!(AsChar::is_hex_digit(b'f'));
+ assert!(AsChar::is_hex_digit(b'A'));
+ assert!(AsChar::is_hex_digit(b'F'));
+ assert!(!AsChar::is_hex_digit(b'g'));
+ assert!(!AsChar::is_hex_digit(b'G'));
+ assert!(!AsChar::is_hex_digit(b'/'));
+ assert!(!AsChar::is_hex_digit(b':'));
+ assert!(!AsChar::is_hex_digit(b'@'));
+ assert!(!AsChar::is_hex_digit(b'\x60'));
+ }
+
+ #[test]
+ fn oct_digit_test() {
+ let i = &b"01234567;"[..];
+ assert_parse!(oct_digit1.parse_peek(i), Ok((&b";"[..], &i[..i.len() - 1])));
+
+ let i = &b"8"[..];
+ assert_parse!(
+ oct_digit1.parse_peek(i),
+ Err(ErrMode::Backtrack(error_position!(&i, ErrorKind::Slice)))
+ );
+
+ assert!(AsChar::is_oct_digit(b'0'));
+ assert!(AsChar::is_oct_digit(b'7'));
+ assert!(!AsChar::is_oct_digit(b'8'));
+ assert!(!AsChar::is_oct_digit(b'9'));
+ assert!(!AsChar::is_oct_digit(b'a'));
+ assert!(!AsChar::is_oct_digit(b'A'));
+ assert!(!AsChar::is_oct_digit(b'/'));
+ assert!(!AsChar::is_oct_digit(b':'));
+ assert!(!AsChar::is_oct_digit(b'@'));
+ assert!(!AsChar::is_oct_digit(b'\x60'));
+ }
+
+ #[test]
+ fn full_line_windows() {
+ fn take_full_line(i: &[u8]) -> IResult<&[u8], (&[u8], &[u8])> {
+ (till_line_ending, line_ending).parse_peek(i)
+ }
+ let input = b"abc\r\n";
+ let output = take_full_line(input);
+ assert_eq!(output, Ok((&b""[..], (&b"abc"[..], &b"\r\n"[..]))));
+ }
+
+ #[test]
+ fn full_line_unix() {
+ fn take_full_line(i: &[u8]) -> IResult<&[u8], (&[u8], &[u8])> {
+ (till_line_ending, line_ending).parse_peek(i)
+ }
+ let input = b"abc\n";
+ let output = take_full_line(input);
+ assert_eq!(output, Ok((&b""[..], (&b"abc"[..], &b"\n"[..]))));
+ }
+
+ #[test]
+ fn check_windows_lineending() {
+ let input = b"\r\n";
+ let output = line_ending.parse_peek(&input[..]);
+ assert_parse!(output, Ok((&b""[..], &b"\r\n"[..])));
+ }
+
+ #[test]
+ fn check_unix_lineending() {
+ let input = b"\n";
+ let output = line_ending.parse_peek(&input[..]);
+ assert_parse!(output, Ok((&b""[..], &b"\n"[..])));
+ }
+
+ #[test]
+ fn cr_lf() {
+ assert_parse!(
+ crlf.parse_peek(&b"\r\na"[..]),
+ Ok((&b"a"[..], &b"\r\n"[..]))
+ );
+ assert_parse!(
+ crlf.parse_peek(&b"\r"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"\r"[..],
+ ErrorKind::Tag
+ )))
+ );
+ assert_parse!(
+ crlf.parse_peek(&b"\ra"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"\ra"[..],
+ ErrorKind::Tag
+ )))
+ );
+
+ assert_parse!(crlf.parse_peek("\r\na"), Ok(("a", "\r\n")));
+ assert_parse!(
+ crlf.parse_peek("\r"),
+ Err(ErrMode::Backtrack(error_position!(&"\r", ErrorKind::Tag)))
+ );
+ assert_parse!(
+ crlf.parse_peek("\ra"),
+ Err(ErrMode::Backtrack(error_position!(&"\ra", ErrorKind::Tag)))
+ );
+ }
+
+ #[test]
+ fn end_of_line() {
+ assert_parse!(
+ line_ending.parse_peek(&b"\na"[..]),
+ Ok((&b"a"[..], &b"\n"[..]))
+ );
+ assert_parse!(
+ line_ending.parse_peek(&b"\r\na"[..]),
+ Ok((&b"a"[..], &b"\r\n"[..]))
+ );
+ assert_parse!(
+ line_ending.parse_peek(&b"\r"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"\r"[..],
+ ErrorKind::Tag
+ )))
+ );
+ assert_parse!(
+ line_ending.parse_peek(&b"\ra"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"\ra"[..],
+ ErrorKind::Tag
+ )))
+ );
+
+ assert_parse!(line_ending.parse_peek("\na"), Ok(("a", "\n")));
+ assert_parse!(line_ending.parse_peek("\r\na"), Ok(("a", "\r\n")));
+ assert_parse!(
+ line_ending.parse_peek("\r"),
+ Err(ErrMode::Backtrack(error_position!(&"\r", ErrorKind::Tag)))
+ );
+ assert_parse!(
+ line_ending.parse_peek("\ra"),
+ Err(ErrMode::Backtrack(error_position!(&"\ra", ErrorKind::Tag)))
+ );
+ }
+
+ fn digit_to_i16(input: &str) -> IResult<&str, i16> {
+ let i = input;
+ let (i, opt_sign) = opt(alt(('+', '-'))).parse_peek(i)?;
+ let sign = match opt_sign {
+ Some('+') | None => true,
+ Some('-') => false,
+ _ => unreachable!(),
+ };
+
+ let (i, s) = digit1::<_, InputError<_>>.parse_peek(i)?;
+ match s.parse_slice() {
+ Some(n) => {
+ if sign {
+ Ok((i, n))
+ } else {
+ Ok((i, -n))
+ }
+ }
+ None => Err(ErrMode::from_error_kind(&i, ErrorKind::Verify)),
+ }
+ }
+
+ fn digit_to_u32(i: &str) -> IResult<&str, u32> {
+ let (i, s) = digit1.parse_peek(i)?;
+ match s.parse_slice() {
+ Some(n) => Ok((i, n)),
+ None => Err(ErrMode::from_error_kind(&i, ErrorKind::Verify)),
+ }
+ }
+
+ proptest! {
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn ints(s in "\\PC*") {
+ let res1 = digit_to_i16(&s);
+ let res2 = dec_int.parse_peek(s.as_str());
+ assert_eq!(res1, res2);
+ }
+
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn uints(s in "\\PC*") {
+ let res1 = digit_to_u32(&s);
+ let res2 = dec_uint.parse_peek(s.as_str());
+ assert_eq!(res1, res2);
+ }
+ }
+
+ #[test]
+ fn hex_uint_tests() {
+ fn hex_u32(input: &[u8]) -> IResult<&[u8], u32> {
+ hex_uint.parse_peek(input)
+ }
+
+ assert_parse!(
+ hex_u32(&b";"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b";"[..],
+ ErrorKind::Slice
+ )))
+ );
+ assert_parse!(hex_u32(&b"ff;"[..]), Ok((&b";"[..], 255)));
+ assert_parse!(hex_u32(&b"1be2;"[..]), Ok((&b";"[..], 7138)));
+ assert_parse!(hex_u32(&b"c5a31be2;"[..]), Ok((&b";"[..], 3_315_801_058)));
+ assert_parse!(hex_u32(&b"C5A31be2;"[..]), Ok((&b";"[..], 3_315_801_058)));
+ assert_parse!(
+ hex_u32(&b"00c5a31be2;"[..]), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"00c5a31be2;"[..],
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(&b"c5a31be201;"[..]), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"c5a31be201;"[..],
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(hex_u32(&b"ffffffff;"[..]), Ok((&b";"[..], 4_294_967_295)));
+ assert_parse!(
+ hex_u32(&b"ffffffffffffffff;"[..]), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"ffffffffffffffff;"[..],
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(&b"ffffffffffffffff"[..]), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"ffffffffffffffff"[..],
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(hex_u32(&b"0x1be2;"[..]), Ok((&b"x1be2;"[..], 0)));
+ assert_parse!(hex_u32(&b"12af"[..]), Ok((&b""[..], 0x12af)));
+ }
+
+ #[test]
+ #[cfg(feature = "std")]
+ fn float_test() {
+ let test_cases = [
+ "+3.14",
+ "3.14",
+ "-3.14",
+ "0",
+ "0.0",
+ "1.",
+ ".789",
+ "-.5",
+ "1e7",
+ "-1E-7",
+ ".3e-2",
+ "1.e4",
+ "1.2e4",
+ "12.34",
+ "-1.234E-12",
+ "-1.234e-12",
+ "0.00000000000000000087",
+ "inf",
+ "Inf",
+ "infinity",
+ "Infinity",
+ "-inf",
+ "-Inf",
+ "-infinity",
+ "-Infinity",
+ "+inf",
+ "+Inf",
+ "+infinity",
+ "+Infinity",
+ ];
+
+ for test in test_cases {
+ let expected32 = str::parse::<f32>(test).unwrap();
+ let expected64 = str::parse::<f64>(test).unwrap();
+
+ println!("now parsing: {} -> {}", test, expected32);
+
+ assert_parse!(
+ float.parse_peek(test.as_bytes()),
+ Ok((&b""[..], expected32))
+ );
+ assert_parse!(float.parse_peek(test), Ok(("", expected32)));
+
+ assert_parse!(
+ float.parse_peek(test.as_bytes()),
+ Ok((&b""[..], expected64))
+ );
+ assert_parse!(float.parse_peek(test), Ok(("", expected64)));
+ }
+
+ let remaining_exponent = "-1.234E-";
+ assert_parse!(
+ float::<_, f64, _>.parse_peek(remaining_exponent),
+ Err(ErrMode::Cut(InputError::new("", ErrorKind::Slice)))
+ );
+
+ let nan_test_cases = ["nan", "NaN", "NAN"];
+
+ for test in nan_test_cases {
+ println!("now parsing: {}", test);
+
+ let (remaining, parsed) = float::<_, f32, ()>.parse_peek(test.as_bytes()).unwrap();
+ assert!(parsed.is_nan());
+ assert!(remaining.is_empty());
+
+ let (remaining, parsed) = float::<_, f32, ()>.parse_peek(test).unwrap();
+ assert!(parsed.is_nan());
+ assert!(remaining.is_empty());
+
+ let (remaining, parsed) = float::<_, f64, ()>.parse_peek(test.as_bytes()).unwrap();
+ assert!(parsed.is_nan());
+ assert!(remaining.is_empty());
+
+ let (remaining, parsed) = float::<_, f64, ()>.parse_peek(test).unwrap();
+ assert!(parsed.is_nan());
+ assert!(remaining.is_empty());
+ }
+ }
+
+ #[cfg(feature = "std")]
+ fn parse_f64(i: &str) -> IResult<&str, f64, ()> {
+ match super::recognize_float_or_exceptions.parse_peek(i) {
+ Err(e) => Err(e),
+ Ok((i, s)) => {
+ if s.is_empty() {
+ return Err(ErrMode::Backtrack(()));
+ }
+ match s.parse_slice() {
+ Some(n) => Ok((i, n)),
+ None => Err(ErrMode::Backtrack(())),
+ }
+ }
+ }
+ }
+
+ proptest! {
+ #[test]
+ #[cfg(feature = "std")]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn floats(s in "\\PC*") {
+ println!("testing {}", s);
+ let res1 = parse_f64(&s);
+ let res2 = float::<_, f64, ()>.parse_peek(s.as_str());
+ assert_eq!(res1, res2);
+ }
+ }
+
+ // issue #1336 "escaped hangs if normal parser accepts empty"
+ #[test]
+ fn complete_escaped_hang() {
+ // issue #1336 "escaped hangs if normal parser accepts empty"
+ fn escaped_string(input: &str) -> IResult<&str, &str> {
+ use crate::ascii::alpha0;
+ use crate::token::one_of;
+ escaped(alpha0, '\\', one_of(['n'])).parse_peek(input)
+ }
+
+ escaped_string("7").unwrap();
+ escaped_string("a7").unwrap();
+ }
+
+ #[test]
+ fn complete_escaped_hang_1118() {
+ // issue ##1118 escaped does not work with empty string
+ fn unquote(input: &str) -> IResult<&str, &str> {
+ use crate::combinator::delimited;
+ use crate::combinator::opt;
+ use crate::token::one_of;
+
+ delimited(
+ '"',
+ escaped(
+ opt(none_of(['\\', '"'])),
+ '\\',
+ one_of(['\\', '"', 'r', 'n', 't']),
+ ),
+ '"',
+ )
+ .parse_peek(input)
+ }
+
+ assert_eq!(unquote(r#""""#), Ok(("", "")));
+ }
+
+ #[cfg(feature = "alloc")]
+ #[allow(unused_variables)]
+ #[test]
+ fn complete_escaping() {
+ use crate::ascii::{alpha1 as alpha, digit1 as digit};
+ use crate::token::one_of;
+
+ fn esc(i: &[u8]) -> IResult<&[u8], &[u8]> {
+ escaped(alpha, '\\', one_of(['\"', 'n', '\\'])).parse_peek(i)
+ }
+ assert_eq!(esc(&b"abcd;"[..]), Ok((&b";"[..], &b"abcd"[..])));
+ assert_eq!(esc(&b"ab\\\"cd;"[..]), Ok((&b";"[..], &b"ab\\\"cd"[..])));
+ assert_eq!(esc(&b"\\\"abcd;"[..]), Ok((&b";"[..], &b"\\\"abcd"[..])));
+ assert_eq!(esc(&b"\\n;"[..]), Ok((&b";"[..], &b"\\n"[..])));
+ assert_eq!(esc(&b"ab\\\"12"[..]), Ok((&b"12"[..], &b"ab\\\""[..])));
+ assert_eq!(
+ esc(&b"AB\\"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b""[..],
+ ErrorKind::Token
+ )))
+ );
+ assert_eq!(
+ esc(&b"AB\\A"[..]),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &&b"AB\\A"[..],
+ ErrorKind::Token,
+ error_position!(&&b"A"[..], ErrorKind::Verify)
+ )))
+ );
+
+ fn esc2(i: &[u8]) -> IResult<&[u8], &[u8]> {
+ escaped(digit, '\\', one_of(['\"', 'n', '\\'])).parse_peek(i)
+ }
+ assert_eq!(esc2(&b"12\\nnn34"[..]), Ok((&b"nn34"[..], &b"12\\n"[..])));
+ }
+
+ #[cfg(feature = "alloc")]
+ #[test]
+ fn complete_escaping_str() {
+ use crate::ascii::{alpha1 as alpha, digit1 as digit};
+ use crate::token::one_of;
+
+ fn esc(i: &str) -> IResult<&str, &str> {
+ escaped(alpha, '\\', one_of(['\"', 'n', '\\'])).parse_peek(i)
+ }
+ assert_eq!(esc("abcd;"), Ok((";", "abcd")));
+ assert_eq!(esc("ab\\\"cd;"), Ok((";", "ab\\\"cd")));
+ assert_eq!(esc("\\\"abcd;"), Ok((";", "\\\"abcd")));
+ assert_eq!(esc("\\n;"), Ok((";", "\\n")));
+ assert_eq!(esc("ab\\\"12"), Ok(("12", "ab\\\"")));
+ assert_eq!(
+ esc("AB\\"),
+ Err(ErrMode::Backtrack(error_position!(&"", ErrorKind::Token)))
+ );
+ assert_eq!(
+ esc("AB\\A"),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &"AB\\A",
+ ErrorKind::Token,
+ error_position!(&"A", ErrorKind::Verify)
+ )))
+ );
+
+ fn esc2(i: &str) -> IResult<&str, &str> {
+ escaped(digit, '\\', one_of(['\"', 'n', '\\'])).parse_peek(i)
+ }
+ assert_eq!(esc2("12\\nnn34"), Ok(("nn34", "12\\n")));
+
+ fn esc3(i: &str) -> IResult<&str, &str> {
+ escaped(alpha, '\u{241b}', one_of(['\"', 'n'])).parse_peek(i)
+ }
+ assert_eq!(esc3("ab␛ncd;"), Ok((";", "ab␛ncd")));
+ }
+
+ #[test]
+ fn test_escaped_error() {
+ fn esc(s: &str) -> IResult<&str, &str> {
+ use crate::ascii::digit1;
+ escaped(digit1, '\\', one_of(['\"', 'n', '\\'])).parse_peek(s)
+ }
+
+ assert_eq!(esc("abcd"), Ok(("abcd", "")));
+ }
+
+ #[cfg(feature = "alloc")]
+ #[test]
+ fn complete_escape_transform() {
+ use crate::ascii::alpha1 as alpha;
+
+ #[cfg(feature = "alloc")]
+ fn to_s(i: Vec<u8>) -> String {
+ String::from_utf8_lossy(&i).into_owned()
+ }
+
+ fn esc(i: &[u8]) -> IResult<&[u8], String> {
+ escaped_transform(
+ alpha,
+ '\\',
+ alt((
+ "\\".value(&b"\\"[..]),
+ "\"".value(&b"\""[..]),
+ "n".value(&b"\n"[..]),
+ )),
+ )
+ .map(to_s)
+ .parse_peek(i)
+ }
+
+ assert_eq!(esc(&b"abcd;"[..]), Ok((&b";"[..], String::from("abcd"))));
+ assert_eq!(
+ esc(&b"ab\\\"cd;"[..]),
+ Ok((&b";"[..], String::from("ab\"cd")))
+ );
+ assert_eq!(
+ esc(&b"\\\"abcd;"[..]),
+ Ok((&b";"[..], String::from("\"abcd")))
+ );
+ assert_eq!(esc(&b"\\n;"[..]), Ok((&b";"[..], String::from("\n"))));
+ assert_eq!(
+ esc(&b"ab\\\"12"[..]),
+ Ok((&b"12"[..], String::from("ab\"")))
+ );
+ assert_eq!(
+ esc(&b"AB\\"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b""[..],
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ esc(&b"AB\\A"[..]),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &&b"AB\\A"[..],
+ ErrorKind::Eof,
+ error_position!(&&b"A"[..], ErrorKind::Tag)
+ )))
+ );
+
+ fn esc2(i: &[u8]) -> IResult<&[u8], String> {
+ escaped_transform(
+ alpha,
+ '&',
+ alt((
+ "egrave;".value("è".as_bytes()),
+ "agrave;".value("à".as_bytes()),
+ )),
+ )
+ .map(to_s)
+ .parse_peek(i)
+ }
+ assert_eq!(
+ esc2(&b"abèDEF;"[..]),
+ Ok((&b";"[..], String::from("abèDEF")))
+ );
+ assert_eq!(
+ esc2(&b"abèDàEF;"[..]),
+ Ok((&b";"[..], String::from("abèDàEF")))
+ );
+ }
+
+ #[cfg(feature = "std")]
+ #[test]
+ fn complete_escape_transform_str() {
+ use crate::ascii::alpha1 as alpha;
+
+ fn esc(i: &str) -> IResult<&str, String> {
+ escaped_transform(
+ alpha,
+ '\\',
+ alt(("\\".value("\\"), "\"".value("\""), "n".value("\n"))),
+ )
+ .parse_peek(i)
+ }
+
+ assert_eq!(esc("abcd;"), Ok((";", String::from("abcd"))));
+ assert_eq!(esc("ab\\\"cd;"), Ok((";", String::from("ab\"cd"))));
+ assert_eq!(esc("\\\"abcd;"), Ok((";", String::from("\"abcd"))));
+ assert_eq!(esc("\\n;"), Ok((";", String::from("\n"))));
+ assert_eq!(esc("ab\\\"12"), Ok(("12", String::from("ab\""))));
+ assert_eq!(
+ esc("AB\\"),
+ Err(ErrMode::Backtrack(error_position!(&"", ErrorKind::Tag)))
+ );
+ assert_eq!(
+ esc("AB\\A"),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &"AB\\A",
+ ErrorKind::Eof,
+ error_position!(&"A", ErrorKind::Tag)
+ )))
+ );
+
+ fn esc2(i: &str) -> IResult<&str, String> {
+ escaped_transform(
+ alpha,
+ '&',
+ alt(("egrave;".value("è"), "agrave;".value("à"))),
+ )
+ .parse_peek(i)
+ }
+ assert_eq!(esc2("abèDEF;"), Ok((";", String::from("abèDEF"))));
+ assert_eq!(
+ esc2("abèDàEF;"),
+ Ok((";", String::from("abèDàEF")))
+ );
+
+ fn esc3(i: &str) -> IResult<&str, String> {
+ escaped_transform(alpha, '␛', alt(("0".value("\0"), "n".value("\n")))).parse_peek(i)
+ }
+ assert_eq!(esc3("a␛0bc␛n"), Ok(("", String::from("a\0bc\n"))));
+ }
+
+ #[test]
+ #[cfg(feature = "alloc")]
+ fn test_escaped_transform_error() {
+ fn esc_trans(s: &str) -> IResult<&str, String> {
+ use crate::ascii::digit1;
+ escaped_transform(digit1, '\\', "n").parse_peek(s)
+ }
+
+ assert_eq!(esc_trans("abcd"), Ok(("abcd", String::new())));
+ }
+}
+
+mod partial {
+ use super::*;
+ use crate::combinator::opt;
+ use crate::error::ErrorKind;
+ use crate::error::InputError;
+ use crate::error::{ErrMode, Needed};
+ use crate::stream::ParseSlice;
+ use crate::IResult;
+ use crate::Partial;
+ use proptest::prelude::*;
+
+ macro_rules! assert_parse(
+ ($left: expr, $right: expr) => {
+ let res: $crate::IResult<_, _, InputError<_>> = $left;
+ assert_eq!(res, $right);
+ };
+ );
+
+ #[test]
+ fn character() {
+ let a: &[u8] = b"abcd";
+ let b: &[u8] = b"1234";
+ let c: &[u8] = b"a123";
+ let d: &[u8] = "azé12".as_bytes();
+ let e: &[u8] = b" ";
+ let f: &[u8] = b" ;";
+ //assert_eq!(alpha1::<_, Error<_>>(a), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_parse!(
+ alpha1.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ alpha1.parse_peek(Partial::new(b)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(b),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Ok((Partial::new(&c[1..]), &b"a"[..]))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("é12".as_bytes()), &b"az"[..]))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(a)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(a),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(c)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(c),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(d)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(d),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("zé12".as_bytes()), &b"a"[..]))
+ );
+ assert_eq!(
+ hex_digit1.parse_peek(Partial::new(e)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(e),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(a)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(a),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(c)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(c),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(d)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(d),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ //assert_eq!(fix_error!(b,(), alphanumeric1), Ok((empty, b)));
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("é12".as_bytes()), &b"az"[..]))
+ );
+ assert_eq!(
+ space1::<_, InputError<_>>.parse_peek(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ space1::<_, InputError<_>>.parse_peek(Partial::new(f)),
+ Ok((Partial::new(&b";"[..]), &b" "[..]))
+ );
+ }
+
+ #[cfg(feature = "alloc")]
+ #[test]
+ fn character_s() {
+ let a = "abcd";
+ let b = "1234";
+ let c = "a123";
+ let d = "azé12";
+ let e = " ";
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ alpha1.parse_peek(Partial::new(b)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(b),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Ok((Partial::new(&c[1..]), "a"))
+ );
+ assert_eq!(
+ alpha1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("é12"), "az"))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(a)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(a),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(c)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(c),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ digit1.parse_peek(Partial::new(d)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(d),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("zé12"), "a"))
+ );
+ assert_eq!(
+ hex_digit1.parse_peek(Partial::new(e)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(e),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(a)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(a),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(c)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(c),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ oct_digit1.parse_peek(Partial::new(d)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(d),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ //assert_eq!(fix_error!(b,(), alphanumeric1), Ok((empty, b)));
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Ok((Partial::new("é12"), "az"))
+ );
+ assert_eq!(
+ space1::<_, InputError<_>>.parse_peek(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ use crate::stream::Offset;
+ #[test]
+ fn offset() {
+ let a = &b"abcd;"[..];
+ let b = &b"1234;"[..];
+ let c = &b"a123;"[..];
+ let d = &b" \t;"[..];
+ let e = &b" \t\r\n;"[..];
+ let f = &b"123abcDEF;"[..];
+
+ match alpha1::<_, InputError<_>>.parse_peek(Partial::new(a)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&a) + i.len(), a.len());
+ }
+ _ => panic!("wrong return type in offset test for alpha"),
+ }
+ match digit1::<_, InputError<_>>.parse_peek(Partial::new(b)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&b) + i.len(), b.len());
+ }
+ _ => panic!("wrong return type in offset test for digit"),
+ }
+ match alphanumeric1::<_, InputError<_>>.parse_peek(Partial::new(c)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&c) + i.len(), c.len());
+ }
+ _ => panic!("wrong return type in offset test for alphanumeric"),
+ }
+ match space1::<_, InputError<_>>.parse_peek(Partial::new(d)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&d) + i.len(), d.len());
+ }
+ _ => panic!("wrong return type in offset test for space"),
+ }
+ match multispace1::<_, InputError<_>>.parse_peek(Partial::new(e)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&e) + i.len(), e.len());
+ }
+ _ => panic!("wrong return type in offset test for multispace"),
+ }
+ match hex_digit1::<_, InputError<_>>.parse_peek(Partial::new(f)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&f) + i.len(), f.len());
+ }
+ _ => panic!("wrong return type in offset test for hex_digit"),
+ }
+ match oct_digit1::<_, InputError<_>>.parse_peek(Partial::new(f)) {
+ Ok((i, _)) => {
+ let i = i.into_inner();
+ assert_eq!(i.offset_from(&f) + i.len(), f.len());
+ }
+ _ => panic!("wrong return type in offset test for oct_digit"),
+ }
+ }
+
+ #[test]
+ fn is_till_line_ending_bytes() {
+ let a: &[u8] = b"ab12cd\nefgh";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(Partial::new(a)),
+ Ok((Partial::new(&b"\nefgh"[..]), &b"ab12cd"[..]))
+ );
+
+ let b: &[u8] = b"ab12cd\nefgh\nijkl";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(Partial::new(b)),
+ Ok((Partial::new(&b"\nefgh\nijkl"[..]), &b"ab12cd"[..]))
+ );
+
+ let c: &[u8] = b"ab12cd\r\nefgh\nijkl";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(Partial::new(c)),
+ Ok((Partial::new(&b"\r\nefgh\nijkl"[..]), &b"ab12cd"[..]))
+ );
+
+ let d: &[u8] = b"ab12cd";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(Partial::new(d)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn is_till_line_ending_str() {
+ let f = "βèƒôřè\rÂßÇáƒƭèř";
+ assert_eq!(
+ till_line_ending.parse_peek(Partial::new(f)),
+ Err(ErrMode::Backtrack(InputError::new(
+ Partial::new(&f[12..]),
+ ErrorKind::Tag
+ )))
+ );
+
+ let g2: &str = "ab12cd";
+ assert_eq!(
+ till_line_ending::<_, InputError<_>>.parse_peek(Partial::new(g2)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn hex_digit_test() {
+ let i = &b"0123456789abcdefABCDEF;"[..];
+ assert_parse!(
+ hex_digit1.parse_peek(Partial::new(i)),
+ Ok((Partial::new(&b";"[..]), &i[..i.len() - 1]))
+ );
+
+ let i = &b"g"[..];
+ assert_parse!(
+ hex_digit1.parse_peek(Partial::new(i)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(i),
+ ErrorKind::Slice
+ )))
+ );
+
+ let i = &b"G"[..];
+ assert_parse!(
+ hex_digit1.parse_peek(Partial::new(i)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(i),
+ ErrorKind::Slice
+ )))
+ );
+
+ assert!(AsChar::is_hex_digit(b'0'));
+ assert!(AsChar::is_hex_digit(b'9'));
+ assert!(AsChar::is_hex_digit(b'a'));
+ assert!(AsChar::is_hex_digit(b'f'));
+ assert!(AsChar::is_hex_digit(b'A'));
+ assert!(AsChar::is_hex_digit(b'F'));
+ assert!(!AsChar::is_hex_digit(b'g'));
+ assert!(!AsChar::is_hex_digit(b'G'));
+ assert!(!AsChar::is_hex_digit(b'/'));
+ assert!(!AsChar::is_hex_digit(b':'));
+ assert!(!AsChar::is_hex_digit(b'@'));
+ assert!(!AsChar::is_hex_digit(b'\x60'));
+ }
+
+ #[test]
+ fn oct_digit_test() {
+ let i = &b"01234567;"[..];
+ assert_parse!(
+ oct_digit1.parse_peek(Partial::new(i)),
+ Ok((Partial::new(&b";"[..]), &i[..i.len() - 1]))
+ );
+
+ let i = &b"8"[..];
+ assert_parse!(
+ oct_digit1.parse_peek(Partial::new(i)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(i),
+ ErrorKind::Slice
+ )))
+ );
+
+ assert!(AsChar::is_oct_digit(b'0'));
+ assert!(AsChar::is_oct_digit(b'7'));
+ assert!(!AsChar::is_oct_digit(b'8'));
+ assert!(!AsChar::is_oct_digit(b'9'));
+ assert!(!AsChar::is_oct_digit(b'a'));
+ assert!(!AsChar::is_oct_digit(b'A'));
+ assert!(!AsChar::is_oct_digit(b'/'));
+ assert!(!AsChar::is_oct_digit(b':'));
+ assert!(!AsChar::is_oct_digit(b'@'));
+ assert!(!AsChar::is_oct_digit(b'\x60'));
+ }
+
+ #[test]
+ fn full_line_windows() {
+ #[allow(clippy::type_complexity)]
+ fn take_full_line(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (&[u8], &[u8])> {
+ (till_line_ending, line_ending).parse_peek(i)
+ }
+ let input = b"abc\r\n";
+ let output = take_full_line(Partial::new(input));
+ assert_eq!(
+ output,
+ Ok((Partial::new(&b""[..]), (&b"abc"[..], &b"\r\n"[..])))
+ );
+ }
+
+ #[test]
+ fn full_line_unix() {
+ #[allow(clippy::type_complexity)]
+ fn take_full_line(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (&[u8], &[u8])> {
+ (till_line_ending, line_ending).parse_peek(i)
+ }
+ let input = b"abc\n";
+ let output = take_full_line(Partial::new(input));
+ assert_eq!(
+ output,
+ Ok((Partial::new(&b""[..]), (&b"abc"[..], &b"\n"[..])))
+ );
+ }
+
+ #[test]
+ fn check_windows_lineending() {
+ let input = b"\r\n";
+ let output = line_ending.parse_peek(Partial::new(&input[..]));
+ assert_parse!(output, Ok((Partial::new(&b""[..]), &b"\r\n"[..])));
+ }
+
+ #[test]
+ fn check_unix_lineending() {
+ let input = b"\n";
+ let output = line_ending.parse_peek(Partial::new(&input[..]));
+ assert_parse!(output, Ok((Partial::new(&b""[..]), &b"\n"[..])));
+ }
+
+ #[test]
+ fn cr_lf() {
+ assert_parse!(
+ crlf.parse_peek(Partial::new(&b"\r\na"[..])),
+ Ok((Partial::new(&b"a"[..]), &b"\r\n"[..]))
+ );
+ assert_parse!(
+ crlf.parse_peek(Partial::new(&b"\r"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_parse!(
+ crlf.parse_peek(Partial::new(&b"\ra"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"\ra"[..]),
+ ErrorKind::Tag
+ )))
+ );
+
+ assert_parse!(
+ crlf.parse_peek(Partial::new("\r\na")),
+ Ok((Partial::new("a"), "\r\n"))
+ );
+ assert_parse!(
+ crlf.parse_peek(Partial::new("\r")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_parse!(
+ crlf.parse_peek(Partial::new("\ra")),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new("\ra"),
+ ErrorKind::Tag
+ )))
+ );
+ }
+
+ #[test]
+ fn end_of_line() {
+ assert_parse!(
+ line_ending.parse_peek(Partial::new(&b"\na"[..])),
+ Ok((Partial::new(&b"a"[..]), &b"\n"[..]))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new(&b"\r\na"[..])),
+ Ok((Partial::new(&b"a"[..]), &b"\r\n"[..]))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new(&b"\r"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new(&b"\ra"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"\ra"[..]),
+ ErrorKind::Tag
+ )))
+ );
+
+ assert_parse!(
+ line_ending.parse_peek(Partial::new("\na")),
+ Ok((Partial::new("a"), "\n"))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new("\r\na")),
+ Ok((Partial::new("a"), "\r\n"))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new("\r")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_parse!(
+ line_ending.parse_peek(Partial::new("\ra")),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new("\ra"),
+ ErrorKind::Tag
+ )))
+ );
+ }
+
+ fn digit_to_i16(input: Partial<&str>) -> IResult<Partial<&str>, i16> {
+ let i = input;
+ let (i, opt_sign) = opt(one_of(['+', '-'])).parse_peek(i)?;
+ let sign = match opt_sign {
+ Some('+') | None => true,
+ Some('-') => false,
+ _ => unreachable!(),
+ };
+
+ let (i, s) = digit1::<_, InputError<_>>.parse_peek(i)?;
+ match s.parse_slice() {
+ Some(n) => {
+ if sign {
+ Ok((i, n))
+ } else {
+ Ok((i, -n))
+ }
+ }
+ None => Err(ErrMode::from_error_kind(&i, ErrorKind::Verify)),
+ }
+ }
+
+ fn digit_to_u32(i: Partial<&str>) -> IResult<Partial<&str>, u32> {
+ let (i, s) = digit1.parse_peek(i)?;
+ match s.parse_slice() {
+ Some(n) => Ok((i, n)),
+ None => Err(ErrMode::from_error_kind(&i, ErrorKind::Verify)),
+ }
+ }
+
+ proptest! {
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn ints(s in "\\PC*") {
+ let res1 = digit_to_i16(Partial::new(&s));
+ let res2 = dec_int.parse_peek(Partial::new(s.as_str()));
+ assert_eq!(res1, res2);
+ }
+
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn uints(s in "\\PC*") {
+ let res1 = digit_to_u32(Partial::new(&s));
+ let res2 = dec_uint.parse_peek(Partial::new(s.as_str()));
+ assert_eq!(res1, res2);
+ }
+ }
+
+ #[test]
+ fn hex_uint_tests() {
+ fn hex_u32(input: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+ hex_uint.parse_peek(input)
+ }
+
+ assert_parse!(
+ hex_u32(Partial::new(&b";"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b";"[..]),
+ ErrorKind::Slice
+ )))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"ff;"[..])),
+ Ok((Partial::new(&b";"[..]), 255))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"1be2;"[..])),
+ Ok((Partial::new(&b";"[..]), 7138))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"c5a31be2;"[..])),
+ Ok((Partial::new(&b";"[..]), 3_315_801_058))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"C5A31be2;"[..])),
+ Ok((Partial::new(&b";"[..]), 3_315_801_058))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"00c5a31be2;"[..])), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"00c5a31be2;"[..]),
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"c5a31be201;"[..])), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"c5a31be201;"[..]),
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"ffffffff;"[..])),
+ Ok((Partial::new(&b";"[..]), 4_294_967_295))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"ffffffffffffffff;"[..])), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"ffffffffffffffff;"[..]),
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"ffffffffffffffff"[..])), // overflow
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"ffffffffffffffff"[..]),
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"0x1be2;"[..])),
+ Ok((Partial::new(&b"x1be2;"[..]), 0))
+ );
+ assert_parse!(
+ hex_u32(Partial::new(&b"12af"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+}
diff --git a/crates/winnow/src/binary/bits/mod.rs b/crates/winnow/src/binary/bits/mod.rs
new file mode 100644
index 0000000..4a198c4
--- /dev/null
+++ b/crates/winnow/src/binary/bits/mod.rs
@@ -0,0 +1,365 @@
+//! Bit level parsers
+//!
+
+#[cfg(test)]
+mod tests;
+
+use crate::combinator::trace;
+use crate::error::{ErrMode, ErrorConvert, ErrorKind, Needed, ParserError};
+use crate::lib::std::ops::{AddAssign, Div, Shl, Shr};
+use crate::stream::{AsBytes, Stream, StreamIsPartial, ToUsize};
+use crate::{unpeek, IResult, PResult, Parser};
+
+/// Number of bits in a byte
+const BYTE: usize = u8::BITS as usize;
+
+/// Converts a byte-level input to a bit-level input
+///
+/// See [`bytes`] to convert it back.
+///
+/// # Example
+/// ```
+/// use winnow::prelude::*;
+/// use winnow::Bytes;
+/// use winnow::binary::bits::{bits, take};
+/// use winnow::error::InputError;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// fn parse(input: Stream<'_>) -> IResult<Stream<'_>, (u8, u8)> {
+/// bits::<_, _, InputError<(_, usize)>, _, _>((take(4usize), take(8usize))).parse_peek(input)
+/// }
+///
+/// let input = stream(&[0x12, 0x34, 0xff, 0xff]);
+///
+/// let output = parse(input).expect("We take 1.5 bytes and the input is longer than 2 bytes");
+///
+/// // The first byte is consumed, the second byte is partially consumed and dropped.
+/// let remaining = output.0;
+/// assert_eq!(remaining, stream(&[0xff, 0xff]));
+///
+/// let parsed = output.1;
+/// assert_eq!(parsed.0, 0x01);
+/// assert_eq!(parsed.1, 0x23);
+/// ```
+pub fn bits<I, O, E1, E2, P>(mut parser: P) -> impl Parser<I, O, E2>
+where
+ E1: ParserError<(I, usize)> + ErrorConvert<E2>,
+ E2: ParserError<I>,
+ I: Stream + Clone,
+ P: Parser<(I, usize), O, E1>,
+{
+ trace(
+ "bits",
+ unpeek(move |input: I| {
+ match parser.parse_peek((input, 0)) {
+ Ok(((rest, offset), result)) => {
+ // If the next byte has been partially read, it will be sliced away as well.
+ // The parser functions might already slice away all fully read bytes.
+ // That's why `offset / BYTE` isn't necessarily needed at all times.
+ let remaining_bytes_index =
+ offset / BYTE + if offset % BYTE == 0 { 0 } else { 1 };
+ let (input, _) = rest.peek_slice(remaining_bytes_index);
+ Ok((input, result))
+ }
+ Err(ErrMode::Incomplete(n)) => {
+ Err(ErrMode::Incomplete(n.map(|u| u.get() / BYTE + 1)))
+ }
+ Err(e) => Err(e.convert()),
+ }
+ }),
+ )
+}
+
+/// Convert a [`bits`] stream back into a byte stream
+///
+/// **Warning:** A partial byte remaining in the input will be ignored and the given parser will
+/// start parsing at the next full byte.
+///
+/// ```
+/// use winnow::prelude::*;
+/// use winnow::Bytes;
+/// use winnow::binary::bits::{bits, bytes, take};
+/// use winnow::combinator::rest;
+/// use winnow::error::InputError;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// fn parse(input: Stream<'_>) -> IResult<Stream<'_>, (u8, u8, &[u8])> {
+/// bits::<_, _, InputError<(_, usize)>, _, _>((
+/// take(4usize),
+/// take(8usize),
+/// bytes::<_, _, InputError<_>, _, _>(rest)
+/// )).parse_peek(input)
+/// }
+///
+/// let input = stream(&[0x12, 0x34, 0xff, 0xff]);
+///
+/// assert_eq!(parse(input), Ok(( stream(&[]), (0x01, 0x23, &[0xff, 0xff][..]) )));
+/// ```
+pub fn bytes<I, O, E1, E2, P>(mut parser: P) -> impl Parser<(I, usize), O, E2>
+where
+ E1: ParserError<I> + ErrorConvert<E2>,
+ E2: ParserError<(I, usize)>,
+ I: Stream<Token = u8> + Clone,
+ P: Parser<I, O, E1>,
+{
+ trace(
+ "bytes",
+ unpeek(move |(input, offset): (I, usize)| {
+ let (inner, _) = if offset % BYTE != 0 {
+ input.peek_slice(1 + offset / BYTE)
+ } else {
+ input.peek_slice(offset / BYTE)
+ };
+ let i = (input, offset);
+ match parser.parse_peek(inner) {
+ Ok((rest, res)) => Ok(((rest, 0), res)),
+ Err(ErrMode::Incomplete(Needed::Unknown)) => {
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ }
+ Err(ErrMode::Incomplete(Needed::Size(sz))) => {
+ Err(match sz.get().checked_mul(BYTE) {
+ Some(v) => ErrMode::Incomplete(Needed::new(v)),
+ None => ErrMode::Cut(E2::assert(
+ &i,
+ "overflow in turning needed bytes into needed bits",
+ )),
+ })
+ }
+ Err(e) => Err(e.convert()),
+ }
+ }),
+ )
+}
+
+/// Parse taking `count` bits
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::Bytes;
+/// # use winnow::error::{InputError, ErrorKind};
+/// use winnow::binary::bits::take;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// fn parser(input: (Stream<'_>, usize), count: usize)-> IResult<(Stream<'_>, usize), u8> {
+/// take(count).parse_peek(input)
+/// }
+///
+/// // Consumes 0 bits, returns 0
+/// assert_eq!(parser((stream(&[0b00010010]), 0), 0), Ok(((stream(&[0b00010010]), 0), 0)));
+///
+/// // Consumes 4 bits, returns their values and increase offset to 4
+/// assert_eq!(parser((stream(&[0b00010010]), 0), 4), Ok(((stream(&[0b00010010]), 4), 0b00000001)));
+///
+/// // Consumes 4 bits, offset is 4, returns their values and increase offset to 0 of next byte
+/// assert_eq!(parser((stream(&[0b00010010]), 4), 4), Ok(((stream(&[]), 0), 0b00000010)));
+///
+/// // Tries to consume 12 bits but only 8 are available
+/// assert_eq!(parser((stream(&[0b00010010]), 0), 12), Err(winnow::error::ErrMode::Backtrack(InputError::new((stream(&[0b00010010]), 0), ErrorKind::Eof))));
+/// ```
+#[inline(always)]
+pub fn take<I, O, C, E: ParserError<(I, usize)>>(count: C) -> impl Parser<(I, usize), O, E>
+where
+ I: Stream<Token = u8> + AsBytes + StreamIsPartial + Clone,
+ C: ToUsize,
+ O: From<u8> + AddAssign + Shl<usize, Output = O> + Shr<usize, Output = O>,
+{
+ let count = count.to_usize();
+ trace(
+ "take",
+ unpeek(move |input: (I, usize)| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_::<_, _, _, true>(input, count)
+ } else {
+ take_::<_, _, _, false>(input, count)
+ }
+ }),
+ )
+}
+
+fn take_<I, O, E: ParserError<(I, usize)>, const PARTIAL: bool>(
+ (input, bit_offset): (I, usize),
+ count: usize,
+) -> IResult<(I, usize), O, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8> + AsBytes + Clone,
+ O: From<u8> + AddAssign + Shl<usize, Output = O> + Shr<usize, Output = O>,
+{
+ if count == 0 {
+ Ok(((input, bit_offset), 0u8.into()))
+ } else {
+ if input.eof_offset() * BYTE < count + bit_offset {
+ if PARTIAL && input.is_partial() {
+ Err(ErrMode::Incomplete(Needed::new(count)))
+ } else {
+ Err(ErrMode::from_error_kind(
+ &(input, bit_offset),
+ ErrorKind::Eof,
+ ))
+ }
+ } else {
+ let cnt = (count + bit_offset).div(BYTE);
+ let mut acc: O = 0_u8.into();
+ let mut offset: usize = bit_offset;
+ let mut remaining: usize = count;
+ let mut end_offset: usize = 0;
+
+ for byte in input.as_bytes().iter().copied().take(cnt + 1) {
+ if remaining == 0 {
+ break;
+ }
+ let val: O = if offset == 0 {
+ byte.into()
+ } else {
+ (byte << offset >> offset).into()
+ };
+
+ if remaining < BYTE - offset {
+ acc += val >> (BYTE - offset - remaining);
+ end_offset = remaining + offset;
+ break;
+ } else {
+ acc += val << (remaining - (BYTE - offset));
+ remaining -= BYTE - offset;
+ offset = 0;
+ }
+ }
+ let (input, _) = input.peek_slice(cnt);
+ Ok(((input, end_offset), acc))
+ }
+ }
+}
+
+/// Parse taking `count` bits and comparing them to `pattern`
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::Bytes;
+/// # use winnow::error::{InputError, ErrorKind};
+/// use winnow::binary::bits::tag;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// /// Compare the lowest `count` bits of `input` against the lowest `count` bits of `pattern`.
+/// /// Return Ok and the matching section of `input` if there's a match.
+/// /// Return Err if there's no match.
+/// fn parser(pattern: u8, count: u8, input: (Stream<'_>, usize)) -> IResult<(Stream<'_>, usize), u8> {
+/// tag(pattern, count).parse_peek(input)
+/// }
+///
+/// // The lowest 4 bits of 0b00001111 match the lowest 4 bits of 0b11111111.
+/// assert_eq!(
+/// parser(0b0000_1111, 4, (stream(&[0b1111_1111]), 0)),
+/// Ok(((stream(&[0b1111_1111]), 4), 0b0000_1111))
+/// );
+///
+/// // The lowest bit of 0b00001111 matches the lowest bit of 0b11111111 (both are 1).
+/// assert_eq!(
+/// parser(0b00000001, 1, (stream(&[0b11111111]), 0)),
+/// Ok(((stream(&[0b11111111]), 1), 0b00000001))
+/// );
+///
+/// // The lowest 2 bits of 0b11111111 and 0b00000001 are different.
+/// assert_eq!(
+/// parser(0b000000_01, 2, (stream(&[0b111111_11]), 0)),
+/// Err(winnow::error::ErrMode::Backtrack(InputError::new(
+/// (stream(&[0b11111111]), 0),
+/// ErrorKind::Tag
+/// )))
+/// );
+///
+/// // The lowest 8 bits of 0b11111111 and 0b11111110 are different.
+/// assert_eq!(
+/// parser(0b11111110, 8, (stream(&[0b11111111]), 0)),
+/// Err(winnow::error::ErrMode::Backtrack(InputError::new(
+/// (stream(&[0b11111111]), 0),
+/// ErrorKind::Tag
+/// )))
+/// );
+/// ```
+#[inline(always)]
+#[doc(alias = "literal")]
+#[doc(alias = "just")]
+pub fn tag<I, O, C, E: ParserError<(I, usize)>>(
+ pattern: O,
+ count: C,
+) -> impl Parser<(I, usize), O, E>
+where
+ I: Stream<Token = u8> + AsBytes + StreamIsPartial + Clone,
+ C: ToUsize,
+ O: From<u8> + AddAssign + Shl<usize, Output = O> + Shr<usize, Output = O> + PartialEq,
+{
+ let count = count.to_usize();
+ trace("tag", move |input: &mut (I, usize)| {
+ let start = input.checkpoint();
+
+ take(count).parse_next(input).and_then(|o| {
+ if pattern == o {
+ Ok(o)
+ } else {
+ input.reset(start);
+ Err(ErrMode::Backtrack(E::from_error_kind(
+ input,
+ ErrorKind::Tag,
+ )))
+ }
+ })
+ })
+}
+
+/// Parses one specific bit as a bool.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::Bytes;
+/// # use winnow::error::{InputError, ErrorKind};
+/// use winnow::binary::bits::bool;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// fn parse(input: (Stream<'_>, usize)) -> IResult<(Stream<'_>, usize), bool> {
+/// bool.parse_peek(input)
+/// }
+///
+/// assert_eq!(parse((stream(&[0b10000000]), 0)), Ok(((stream(&[0b10000000]), 1), true)));
+/// assert_eq!(parse((stream(&[0b10000000]), 1)), Ok(((stream(&[0b10000000]), 2), false)));
+/// ```
+#[doc(alias = "any")]
+pub fn bool<I, E: ParserError<(I, usize)>>(input: &mut (I, usize)) -> PResult<bool, E>
+where
+ I: Stream<Token = u8> + AsBytes + StreamIsPartial + Clone,
+{
+ trace("bool", |input: &mut (I, usize)| {
+ let bit: u32 = take(1usize).parse_next(input)?;
+ Ok(bit != 0)
+ })
+ .parse_next(input)
+}
diff --git a/crates/winnow/src/binary/bits/tests.rs b/crates/winnow/src/binary/bits/tests.rs
new file mode 100644
index 0000000..41207c6
--- /dev/null
+++ b/crates/winnow/src/binary/bits/tests.rs
@@ -0,0 +1,191 @@
+use super::*;
+use crate::error::InputError;
+use crate::Partial;
+
+#[test]
+/// Take the `bits` function and assert that remaining bytes are correctly returned, if the
+/// previous bytes are fully consumed
+fn test_complete_byte_consumption_bits() {
+ let input = &[0x12, 0x34, 0x56, 0x78][..];
+
+ // Take 3 bit slices with sizes [4, 8, 4].
+ let result: IResult<&[u8], (u8, u8, u8)> =
+ bits::<_, _, InputError<(&[u8], usize)>, _, _>((take(4usize), take(8usize), take(4usize)))
+ .parse_peek(input);
+
+ let output = result.expect("We take 2 bytes and the input is longer than 2 bytes");
+
+ let remaining = output.0;
+ assert_eq!(remaining, [0x56, 0x78]);
+
+ let parsed = output.1;
+ assert_eq!(parsed.0, 0x01);
+ assert_eq!(parsed.1, 0x23);
+ assert_eq!(parsed.2, 0x04);
+}
+
+#[test]
+/// Take the `bits` function and assert that remaining bytes are correctly returned, if the
+/// previous bytes are NOT fully consumed. Partially consumed bytes are supposed to be dropped.
+/// I.e. if we consume 1.5 bytes of 4 bytes, 2 bytes will be returned, bits 13-16 will be
+/// dropped.
+fn test_partial_byte_consumption_bits() {
+ let input = &[0x12, 0x34, 0x56, 0x78][..];
+
+ // Take bit slices with sizes [4, 8].
+ let result: IResult<&[u8], (u8, u8)> =
+ bits::<_, _, InputError<(&[u8], usize)>, _, _>((take(4usize), take(8usize)))
+ .parse_peek(input);
+
+ let output = result.expect("We take 1.5 bytes and the input is longer than 2 bytes");
+
+ let remaining = output.0;
+ assert_eq!(remaining, [0x56, 0x78]);
+
+ let parsed = output.1;
+ assert_eq!(parsed.0, 0x01);
+ assert_eq!(parsed.1, 0x23);
+}
+
+#[test]
+#[cfg(feature = "std")]
+/// Ensure that in Incomplete error is thrown, if too few bytes are passed for a given parser.
+fn test_incomplete_bits() {
+ let input = Partial::new(&[0x12][..]);
+
+ // Take bit slices with sizes [4, 8].
+ let result: IResult<_, (u8, u8)> =
+ bits::<_, _, InputError<(_, usize)>, _, _>((take(4usize), take(8usize))).parse_peek(input);
+
+ assert!(result.is_err());
+ let error = result.err().unwrap();
+ assert_eq!("Parsing requires 2 bytes/chars", error.to_string());
+}
+
+#[test]
+fn test_take_complete_0() {
+ let input = &[0b00010010][..];
+ let count = 0usize;
+ assert_eq!(count, 0usize);
+ let offset = 0usize;
+
+ let result: crate::IResult<(&[u8], usize), usize> = take(count).parse_peek((input, offset));
+
+ assert_eq!(result, Ok(((input, offset), 0)));
+}
+
+#[test]
+fn test_take_complete_eof() {
+ let input = &[0b00010010][..];
+
+ let result: crate::IResult<(&[u8], usize), usize> = take(1usize).parse_peek((input, 8));
+
+ assert_eq!(
+ result,
+ Err(crate::error::ErrMode::Backtrack(InputError::new(
+ (input, 8),
+ ErrorKind::Eof
+ )))
+ );
+}
+
+#[test]
+fn test_take_complete_span_over_multiple_bytes() {
+ let input = &[0b00010010, 0b00110100, 0b11111111, 0b11111111][..];
+
+ let result: crate::IResult<(&[u8], usize), usize> = take(24usize).parse_peek((input, 4));
+
+ assert_eq!(
+ result,
+ Ok((([0b11111111].as_ref(), 4), 0b1000110100111111111111))
+ );
+}
+
+#[test]
+fn test_take_partial_0() {
+ let input = Partial::new(&[][..]);
+ let count = 0usize;
+ assert_eq!(count, 0usize);
+ let offset = 0usize;
+
+ let result: crate::IResult<(_, usize), usize> = take(count).parse_peek((input, offset));
+
+ assert_eq!(result, Ok(((input, offset), 0)));
+}
+
+#[test]
+fn test_tag_partial_ok() {
+ let input = Partial::new(&[0b00011111][..]);
+ let offset = 0usize;
+ let bits_to_take = 4usize;
+ let value_to_tag = 0b0001;
+
+ let result: crate::IResult<(_, usize), usize> =
+ tag(value_to_tag, bits_to_take).parse_peek((input, offset));
+
+ assert_eq!(result, Ok(((input, bits_to_take), value_to_tag)));
+}
+
+#[test]
+fn test_tag_partial_err() {
+ let input = Partial::new(&[0b00011111][..]);
+ let offset = 0usize;
+ let bits_to_take = 4usize;
+ let value_to_tag = 0b1111;
+
+ let result: crate::IResult<(_, usize), usize> =
+ tag(value_to_tag, bits_to_take).parse_peek((input, offset));
+
+ assert_eq!(
+ result,
+ Err(crate::error::ErrMode::Backtrack(InputError::new(
+ (input, offset),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn test_bool_0_complete() {
+ let input = [0b10000000].as_ref();
+
+ let result: crate::IResult<(&[u8], usize), bool> = bool.parse_peek((input, 0));
+
+ assert_eq!(result, Ok(((input, 1), true)));
+}
+
+#[test]
+fn test_bool_eof_complete() {
+ let input = [0b10000000].as_ref();
+
+ let result: crate::IResult<(&[u8], usize), bool> = bool.parse_peek((input, 8));
+
+ assert_eq!(
+ result,
+ Err(crate::error::ErrMode::Backtrack(InputError::new(
+ (input, 8),
+ ErrorKind::Eof
+ )))
+ );
+}
+
+#[test]
+fn test_bool_0_partial() {
+ let input = Partial::new([0b10000000].as_ref());
+
+ let result: crate::IResult<(Partial<&[u8]>, usize), bool> = bool.parse_peek((input, 0));
+
+ assert_eq!(result, Ok(((input, 1), true)));
+}
+
+#[test]
+fn test_bool_eof_partial() {
+ let input = Partial::new([0b10000000].as_ref());
+
+ let result: crate::IResult<(Partial<&[u8]>, usize), bool> = bool.parse_peek((input, 8));
+
+ assert_eq!(
+ result,
+ Err(crate::error::ErrMode::Incomplete(Needed::new(1)))
+ );
+}
diff --git a/crates/winnow/src/binary/mod.rs b/crates/winnow/src/binary/mod.rs
new file mode 100644
index 0000000..01053a5
--- /dev/null
+++ b/crates/winnow/src/binary/mod.rs
@@ -0,0 +1,2591 @@
+//! Parsers recognizing numbers
+
+#![allow(clippy::match_same_arms)]
+
+pub mod bits;
+
+#[cfg(test)]
+mod tests;
+
+use crate::combinator::repeat;
+use crate::combinator::trace;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::Needed;
+use crate::error::ParserError;
+use crate::lib::std::ops::{Add, Shl};
+use crate::stream::Accumulate;
+use crate::stream::{AsBytes, Stream, StreamIsPartial};
+use crate::stream::{ToUsize, UpdateSlice};
+use crate::token::take;
+use crate::PResult;
+use crate::Parser;
+
+/// Configurable endianness
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+pub enum Endianness {
+ /// Big endian
+ Big,
+ /// Little endian
+ Little,
+ /// Will match the host's endianness
+ Native,
+}
+
+/// Recognizes an unsigned 1 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u8> {
+/// be_u8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+/// be_u8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn be_u8<I, E: ParserError<I>>(input: &mut I) -> PResult<u8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ u8(input)
+}
+
+/// Recognizes a big endian unsigned 2 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u16;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u16> {
+/// be_u16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u16;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u16> {
+/// be_u16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn be_u16<I, E: ParserError<I>>(input: &mut I) -> PResult<u16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_u16", move |input: &mut I| be_uint(input, 2)).parse_next(input)
+}
+
+/// Recognizes a big endian unsigned 3 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u24;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u32> {
+/// be_u24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u24;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+/// be_u24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x000102)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn be_u24<I, E: ParserError<I>>(input: &mut I) -> PResult<u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_u23", move |input: &mut I| be_uint(input, 3)).parse_next(input)
+}
+
+/// Recognizes a big endian unsigned 4 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u32> {
+/// be_u32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+/// be_u32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn be_u32<I, E: ParserError<I>>(input: &mut I) -> PResult<u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_u32", move |input: &mut I| be_uint(input, 4)).parse_next(input)
+}
+
+/// Recognizes a big endian unsigned 8 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u64> {
+/// be_u64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u64> {
+/// be_u64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001020304050607)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn be_u64<I, E: ParserError<I>>(input: &mut I) -> PResult<u64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_u64", move |input: &mut I| be_uint(input, 8)).parse_next(input)
+}
+
+/// Recognizes a big endian unsigned 16 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_u128;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u128> {
+/// be_u128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_u128;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u128> {
+/// be_u128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203040506070809101112131415)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn be_u128<I, E: ParserError<I>>(input: &mut I) -> PResult<u128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_u128", move |input: &mut I| be_uint(input, 16)).parse_next(input)
+}
+
+#[inline]
+fn be_uint<I, Uint, E: ParserError<I>>(input: &mut I, bound: usize) -> PResult<Uint, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+ Uint: Default + Shl<u8, Output = Uint> + Add<Uint, Output = Uint> + From<u8>,
+{
+ debug_assert_ne!(bound, 1, "to_be_uint needs extra work to avoid overflow");
+ take(bound)
+ .map(|n: <I as Stream>::Slice| to_be_uint(n.as_bytes()))
+ .parse_next(input)
+}
+
+#[inline]
+fn to_be_uint<Uint>(number: &[u8]) -> Uint
+where
+ Uint: Default + Shl<u8, Output = Uint> + Add<Uint, Output = Uint> + From<u8>,
+{
+ let mut res = Uint::default();
+ for byte in number.iter().copied() {
+ res = (res << 8) + byte.into();
+ }
+
+ res
+}
+
+/// Recognizes a signed 1 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i8> {
+/// be_i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i8> {
+/// be_i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn be_i8<I, E: ParserError<I>>(input: &mut I) -> PResult<i8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ i8(input)
+}
+
+/// Recognizes a big endian signed 2 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i16;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i16> {
+/// be_i16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i16;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i16> {
+/// be_i16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn be_i16<I, E: ParserError<I>>(input: &mut I) -> PResult<i16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_i16", move |input: &mut I| {
+ be_uint::<_, u16, _>(input, 2).map(|n| n as i16)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a big endian signed 3 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i24;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i32> {
+/// be_i24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i24;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+/// be_i24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x000102)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn be_i24<I, E: ParserError<I>>(input: &mut I) -> PResult<i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_i24", move |input: &mut I| {
+ be_uint::<_, u32, _>(input, 3).map(|n| {
+ // Same as the unsigned version but we need to sign-extend manually here
+ let n = if n & 0x80_00_00 != 0 {
+ (n | 0xff_00_00_00) as i32
+ } else {
+ n as i32
+ };
+ n
+ })
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a big endian signed 4 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i32> {
+/// be_i32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+/// be_i32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(4))));
+/// ```
+#[inline(always)]
+pub fn be_i32<I, E: ParserError<I>>(input: &mut I) -> PResult<i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_i32", move |input: &mut I| {
+ be_uint::<_, u32, _>(input, 4).map(|n| n as i32)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a big endian signed 8 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i64> {
+/// be_i64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i64> {
+/// be_i64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0001020304050607)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn be_i64<I, E: ParserError<I>>(input: &mut I) -> PResult<i64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_i64", move |input: &mut I| {
+ be_uint::<_, u64, _>(input, 8).map(|n| n as i64)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a big endian signed 16 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_i128;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i128> {
+/// be_i128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_i128;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i128> {
+/// be_i128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x00010203040506070809101112131415)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn be_i128<I, E: ParserError<I>>(input: &mut I) -> PResult<i128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_i128", move |input: &mut I| {
+ be_uint::<_, u128, _>(input, 16).map(|n| n as i128)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes an unsigned 1 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u8> {
+/// le_u8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+/// le_u8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn le_u8<I, E: ParserError<I>>(input: &mut I) -> PResult<u8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ u8(input)
+}
+
+/// Recognizes a little endian unsigned 2 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u16;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u16> {
+/// le_u16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u16;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u16> {
+/// le_u16::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn le_u16<I, E: ParserError<I>>(input: &mut I) -> PResult<u16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_u16", move |input: &mut I| le_uint(input, 2)).parse_next(input)
+}
+
+/// Recognizes a little endian unsigned 3 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u24;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u32> {
+/// le_u24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u24;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+/// le_u24::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn le_u24<I, E: ParserError<I>>(input: &mut I) -> PResult<u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_u24", move |input: &mut I| le_uint(input, 3)).parse_next(input)
+}
+
+/// Recognizes a little endian unsigned 4 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u32> {
+/// le_u32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+/// le_u32::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x03020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn le_u32<I, E: ParserError<I>>(input: &mut I) -> PResult<u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_u32", move |input: &mut I| le_uint(input, 4)).parse_next(input)
+}
+
+/// Recognizes a little endian unsigned 8 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u64> {
+/// le_u64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u64> {
+/// le_u64::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0706050403020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn le_u64<I, E: ParserError<I>>(input: &mut I) -> PResult<u64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_u64", move |input: &mut I| le_uint(input, 8)).parse_next(input)
+}
+
+/// Recognizes a little endian unsigned 16 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_u128;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u128> {
+/// le_u128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_u128;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u128> {
+/// le_u128::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x15141312111009080706050403020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn le_u128<I, E: ParserError<I>>(input: &mut I) -> PResult<u128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_u128", move |input: &mut I| le_uint(input, 16)).parse_next(input)
+}
+
+#[inline]
+fn le_uint<I, Uint, E: ParserError<I>>(input: &mut I, bound: usize) -> PResult<Uint, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+ Uint: Default + Shl<u8, Output = Uint> + Add<Uint, Output = Uint> + From<u8>,
+{
+ take(bound)
+ .map(|n: <I as Stream>::Slice| to_le_uint(n.as_bytes()))
+ .parse_next(input)
+}
+
+#[inline]
+fn to_le_uint<Uint>(number: &[u8]) -> Uint
+where
+ Uint: Default + Shl<u8, Output = Uint> + Add<Uint, Output = Uint> + From<u8>,
+{
+ let mut res = Uint::default();
+ for (index, byte) in number.iter_offsets() {
+ res = res + (Uint::from(byte) << (8 * index as u8));
+ }
+
+ res
+}
+
+/// Recognizes a signed 1 byte integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i8> {
+/// le_i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i8> {
+/// le_i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"\x01abcd"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn le_i8<I, E: ParserError<I>>(input: &mut I) -> PResult<i8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ i8(input)
+}
+
+/// Recognizes a little endian signed 2 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i16;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i16> {
+/// le_i16.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i16;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i16> {
+/// le_i16::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn le_i16<I, E: ParserError<I>>(input: &mut I) -> PResult<i16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_i16", move |input: &mut I| {
+ le_uint::<_, u16, _>(input, 2).map(|n| n as i16)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian signed 3 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i24;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i32> {
+/// le_i24.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i24;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+/// le_i24::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn le_i24<I, E: ParserError<I>>(input: &mut I) -> PResult<i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_i24", move |input: &mut I| {
+ le_uint::<_, u32, _>(input, 3).map(|n| {
+ // Same as the unsigned version but we need to sign-extend manually here
+ let n = if n & 0x80_00_00 != 0 {
+ (n | 0xff_00_00_00) as i32
+ } else {
+ n as i32
+ };
+ n
+ })
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian signed 4 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i32> {
+/// le_i32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+/// le_i32::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x03020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn le_i32<I, E: ParserError<I>>(input: &mut I) -> PResult<i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_i32", move |input: &mut I| {
+ le_uint::<_, u32, _>(input, 4).map(|n| n as i32)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian signed 8 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i64> {
+/// le_i64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i64> {
+/// le_i64::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x0706050403020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn le_i64<I, E: ParserError<I>>(input: &mut I) -> PResult<i64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_i64", move |input: &mut I| {
+ le_uint::<_, u64, _>(input, 8).map(|n| n as i64)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian signed 16 bytes integer.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_i128;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i128> {
+/// le_i128.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100)));
+/// assert_eq!(parser(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_i128;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i128> {
+/// le_i128::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x10\x11\x12\x13\x14\x15abcd"[..])), Ok((Partial::new(&b"abcd"[..]), 0x15141312111009080706050403020100)));
+/// assert_eq!(parser(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn le_i128<I, E: ParserError<I>>(input: &mut I) -> PResult<i128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_i128", move |input: &mut I| {
+ le_uint::<_, u128, _>(input, 16).map(|n| n as i128)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes an unsigned 1 byte integer
+///
+/// **Note:** that endianness does not apply to 1 byte numbers.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], u8> {
+/// u8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+/// u8::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"\x03abcefg"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn u8<I, E: ParserError<I>>(input: &mut I) -> PResult<u8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ trace("u8", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ u8_::<_, _, true>(input)
+ } else {
+ u8_::<_, _, false>(input)
+ }
+ })
+ .parse_next(input)
+}
+
+fn u8_<I, E: ParserError<I>, const PARTIAL: bool>(input: &mut I) -> PResult<u8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ input.next_token().ok_or_else(|| {
+ if PARTIAL && input.is_partial() {
+ ErrMode::Incomplete(Needed::new(1))
+ } else {
+ ErrMode::Backtrack(E::from_error_kind(input, ErrorKind::Token))
+ }
+ })
+}
+
+/// Recognizes an unsigned 2 bytes integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian u16 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian u16 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u16;
+///
+/// let be_u16 = |s| {
+/// u16(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u16(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003)));
+/// assert_eq!(be_u16(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_u16 = |s| {
+/// u16(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u16(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300)));
+/// assert_eq!(le_u16(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u16;
+///
+/// let be_u16 = |s| {
+/// u16::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u16(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0003)));
+/// assert_eq!(be_u16(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// let le_u16 = |s| {
+/// u16::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u16(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0300)));
+/// assert_eq!(le_u16(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn u16<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, u16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_u16,
+ Endianness::Little => le_u16,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_u16,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_u16,
+ }
+ }(input)
+}
+
+/// Recognizes an unsigned 3 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian u24 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian u24 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u24;
+///
+/// let be_u24 = |s| {
+/// u24(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
+/// assert_eq!(be_u24(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_u24 = |s| {
+/// u24(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
+/// assert_eq!(le_u24(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u24;
+///
+/// let be_u24 = |s| {
+/// u24::<_,InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u24(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x000305)));
+/// assert_eq!(be_u24(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+///
+/// let le_u24 = |s| {
+/// u24::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u24(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x050300)));
+/// assert_eq!(le_u24(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn u24<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_u24,
+ Endianness::Little => le_u24,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_u24,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_u24,
+ }
+ }(input)
+}
+
+/// Recognizes an unsigned 4 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian u32 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian u32 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u32;
+///
+/// let be_u32 = |s| {
+/// u32(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u32(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507)));
+/// assert_eq!(be_u32(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_u32 = |s| {
+/// u32(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u32(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300)));
+/// assert_eq!(le_u32(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u32;
+///
+/// let be_u32 = |s| {
+/// u32::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u32(Partial::new(&b"\x00\x03\x05\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x00030507)));
+/// assert_eq!(be_u32(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+///
+/// let le_u32 = |s| {
+/// u32::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u32(Partial::new(&b"\x00\x03\x05\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x07050300)));
+/// assert_eq!(le_u32(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn u32<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, u32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_u32,
+ Endianness::Little => le_u32,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_u32,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_u32,
+ }
+ }(input)
+}
+
+/// Recognizes an unsigned 8 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian u64 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian u64 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u64;
+///
+/// let be_u64 = |s| {
+/// u64(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u64(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607)));
+/// assert_eq!(be_u64(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_u64 = |s| {
+/// u64(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u64(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100)));
+/// assert_eq!(le_u64(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u64;
+///
+/// let be_u64 = |s| {
+/// u64::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u64(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0001020304050607)));
+/// assert_eq!(be_u64(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+///
+/// let le_u64 = |s| {
+/// u64::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u64(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0706050403020100)));
+/// assert_eq!(le_u64(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn u64<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, u64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_u64,
+ Endianness::Little => le_u64,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_u64,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_u64,
+ }
+ }(input)
+}
+
+/// Recognizes an unsigned 16 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian u128 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian u128 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::u128;
+///
+/// let be_u128 = |s| {
+/// u128(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u128(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607)));
+/// assert_eq!(be_u128(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_u128 = |s| {
+/// u128(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u128(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100)));
+/// assert_eq!(le_u128(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::u128;
+///
+/// let be_u128 = |s| {
+/// u128::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_u128(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x00010203040506070001020304050607)));
+/// assert_eq!(be_u128(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+///
+/// let le_u128 = |s| {
+/// u128::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_u128(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x07060504030201000706050403020100)));
+/// assert_eq!(le_u128(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn u128<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, u128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_u128,
+ Endianness::Little => le_u128,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_u128,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_u128,
+ }
+ }(input)
+}
+
+/// Recognizes a signed 1 byte integer
+///
+/// **Note:** that endianness does not apply to 1 byte numbers.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i8;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], i8> {
+/// i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&b"\x00\x03abcefg"[..]), Ok((&b"\x03abcefg"[..], 0x00)));
+/// assert_eq!(parser(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&[][..], ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i8;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i8> {
+/// i8.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"\x03abcefg"[..]), 0x00)));
+/// assert_eq!(parser(Partial::new(&b""[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn i8<I, E: ParserError<I>>(input: &mut I) -> PResult<i8, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+{
+ trace("i8", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ u8_::<_, _, true>(input)
+ } else {
+ u8_::<_, _, false>(input)
+ }
+ .map(|n| n as i8)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a signed 2 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian i16 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian i16 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i16;
+///
+/// let be_i16 = |s| {
+/// i16(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i16(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0003)));
+/// assert_eq!(be_i16(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_i16 = |s| {
+/// i16(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i16(&b"\x00\x03abcefg"[..]), Ok((&b"abcefg"[..], 0x0300)));
+/// assert_eq!(le_i16(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i16;
+///
+/// let be_i16 = |s| {
+/// i16::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i16(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0003)));
+/// assert_eq!(be_i16(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// let le_i16 = |s| {
+/// i16::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i16(Partial::new(&b"\x00\x03abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0300)));
+/// assert_eq!(le_i16(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn i16<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, i16, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_i16,
+ Endianness::Little => le_i16,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_i16,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_i16,
+ }
+ }(input)
+}
+
+/// Recognizes a signed 3 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian i24 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian i24 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i24;
+///
+/// let be_i24 = |s| {
+/// i24(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x000305)));
+/// assert_eq!(be_i24(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_i24 = |s| {
+/// i24(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i24(&b"\x00\x03\x05abcefg"[..]), Ok((&b"abcefg"[..], 0x050300)));
+/// assert_eq!(le_i24(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i24;
+///
+/// let be_i24 = |s| {
+/// i24::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i24(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x000305)));
+/// assert_eq!(be_i24(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+///
+/// let le_i24 = |s| {
+/// i24::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i24(Partial::new(&b"\x00\x03\x05abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x050300)));
+/// assert_eq!(le_i24(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+#[inline(always)]
+pub fn i24<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_i24,
+ Endianness::Little => le_i24,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_i24,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_i24,
+ }
+ }(input)
+}
+
+/// Recognizes a signed 4 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian i32 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian i32 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i32;
+///
+/// let be_i32 = |s| {
+/// i32(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i32(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00030507)));
+/// assert_eq!(be_i32(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_i32 = |s| {
+/// i32(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i32(&b"\x00\x03\x05\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07050300)));
+/// assert_eq!(le_i32(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i32;
+///
+/// let be_i32 = |s| {
+/// i32::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i32(Partial::new(&b"\x00\x03\x05\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x00030507)));
+/// assert_eq!(be_i32(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+///
+/// let le_i32 = |s| {
+/// i32::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i32(Partial::new(&b"\x00\x03\x05\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x07050300)));
+/// assert_eq!(le_i32(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn i32<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, i32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_i32,
+ Endianness::Little => le_i32,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_i32,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_i32,
+ }
+ }(input)
+}
+
+/// Recognizes a signed 8 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian i64 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian i64 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i64;
+///
+/// let be_i64 = |s| {
+/// i64(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i64(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0001020304050607)));
+/// assert_eq!(be_i64(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_i64 = |s| {
+/// i64(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i64(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x0706050403020100)));
+/// assert_eq!(le_i64(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i64;
+///
+/// let be_i64 = |s| {
+/// i64::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i64(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0001020304050607)));
+/// assert_eq!(be_i64(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+///
+/// let le_i64 = |s| {
+/// i64::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i64(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x0706050403020100)));
+/// assert_eq!(le_i64(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn i64<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, i64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_i64,
+ Endianness::Little => le_i64,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_i64,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_i64,
+ }
+ }(input)
+}
+
+/// Recognizes a signed 16 byte integer
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian i128 integer,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian i128 integer.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::i128;
+///
+/// let be_i128 = |s| {
+/// i128(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i128(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x00010203040506070001020304050607)));
+/// assert_eq!(be_i128(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+///
+/// let le_i128 = |s| {
+/// i128(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i128(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..]), Ok((&b"abcefg"[..], 0x07060504030201000706050403020100)));
+/// assert_eq!(le_i128(&b"\x01"[..]), Err(ErrMode::Backtrack(InputError::new(&[0x01][..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::i128;
+///
+/// let be_i128 = |s| {
+/// i128::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_i128(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x00010203040506070001020304050607)));
+/// assert_eq!(be_i128(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+///
+/// let le_i128 = |s| {
+/// i128::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_i128(Partial::new(&b"\x00\x01\x02\x03\x04\x05\x06\x07\x00\x01\x02\x03\x04\x05\x06\x07abcefg"[..])), Ok((Partial::new(&b"abcefg"[..]), 0x07060504030201000706050403020100)));
+/// assert_eq!(le_i128(Partial::new(&b"\x01"[..])), Err(ErrMode::Incomplete(Needed::new(15))));
+/// ```
+#[inline(always)]
+pub fn i128<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, i128, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_i128,
+ Endianness::Little => le_i128,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_i128,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_i128,
+ }
+ }(input)
+}
+
+/// Recognizes a big endian 4 bytes floating point number.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_f32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], f32> {
+/// be_f32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&[0x41, 0x48, 0x00, 0x00][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(parser(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_f32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, f32> {
+/// be_f32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&[0x40, 0x29, 0x00, 0x00][..])), Ok((Partial::new(&b""[..]), 2.640625)));
+/// assert_eq!(parser(Partial::new(&[0x01][..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn be_f32<I, E: ParserError<I>>(input: &mut I) -> PResult<f32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_f32", move |input: &mut I| {
+ be_uint::<_, u32, _>(input, 4).map(f32::from_bits)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a big endian 8 bytes floating point number.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::be_f64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], f64> {
+/// be_f64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&[0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(parser(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::be_f64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, f64> {
+/// be_f64::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&[0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(parser(Partial::new(&[0x01][..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn be_f64<I, E: ParserError<I>>(input: &mut I) -> PResult<f64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_f64", move |input: &mut I| {
+ be_uint::<_, u64, _>(input, 8).map(f64::from_bits)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian 4 bytes floating point number.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_f32;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], f32> {
+/// le_f32.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&[0x00, 0x00, 0x48, 0x41][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(parser(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_f32;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, f32> {
+/// le_f32::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&[0x00, 0x00, 0x48, 0x41][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(parser(Partial::new(&[0x01][..])), Err(ErrMode::Incomplete(Needed::new(3))));
+/// ```
+#[inline(always)]
+pub fn le_f32<I, E: ParserError<I>>(input: &mut I) -> PResult<f32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("le_f32", move |input: &mut I| {
+ le_uint::<_, u32, _>(input, 4).map(f32::from_bits)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a little endian 8 bytes floating point number.
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::le_f64;
+///
+/// fn parser(s: &[u8]) -> IResult<&[u8], f64> {
+/// le_f64.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(parser(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::binary::le_f64;
+///
+/// fn parser(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, f64> {
+/// le_f64::<_, InputError<_>>.parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x48, 0x41][..])), Ok((Partial::new(&b""[..]), 3145728.0)));
+/// assert_eq!(parser(Partial::new(&[0x01][..])), Err(ErrMode::Incomplete(Needed::new(7))));
+/// ```
+#[inline(always)]
+pub fn le_f64<I, E: ParserError<I>>(input: &mut I) -> PResult<f64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ trace("be_f64", move |input: &mut I| {
+ le_uint::<_, u64, _>(input, 8).map(f64::from_bits)
+ })
+ .parse_next(input)
+}
+
+/// Recognizes a 4 byte floating point number
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian f32 float,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian f32 float.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::f32;
+///
+/// let be_f32 = |s| {
+/// f32(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_f32(&[0x41, 0x48, 0x00, 0x00][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(be_f32(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+///
+/// let le_f32 = |s| {
+/// f32(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_f32(&[0x00, 0x00, 0x48, 0x41][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(le_f32(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::f32;
+///
+/// let be_f32 = |s| {
+/// f32::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_f32(Partial::new(&[0x41, 0x48, 0x00, 0x00][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(be_f32(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// let le_f32 = |s| {
+/// f32::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_f32(Partial::new(&[0x00, 0x00, 0x48, 0x41][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(le_f32(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn f32<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, f32, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_f32,
+ Endianness::Little => le_f32,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_f32,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_f32,
+ }
+ }(input)
+}
+
+/// Recognizes an 8 byte floating point number
+///
+/// If the parameter is `winnow::binary::Endianness::Big`, parse a big endian f64 float,
+/// otherwise if `winnow::binary::Endianness::Little` parse a little endian f64 float.
+///
+/// *Complete version*: returns an error if there is not enough input data
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::binary::f64;
+///
+/// let be_f64 = |s| {
+/// f64(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_f64(&[0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(be_f64(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+///
+/// let le_f64 = |s| {
+/// f64(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_f64(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40][..]), Ok((&b""[..], 12.5)));
+/// assert_eq!(le_f64(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// # use winnow::Partial;
+/// use winnow::binary::f64;
+///
+/// let be_f64 = |s| {
+/// f64::<_, InputError<_>>(winnow::binary::Endianness::Big).parse_peek(s)
+/// };
+///
+/// assert_eq!(be_f64(Partial::new(&[0x40, 0x29, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(be_f64(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(5))));
+///
+/// let le_f64 = |s| {
+/// f64::<_, InputError<_>>(winnow::binary::Endianness::Little).parse_peek(s)
+/// };
+///
+/// assert_eq!(le_f64(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x29, 0x40][..])), Ok((Partial::new(&b""[..]), 12.5)));
+/// assert_eq!(le_f64(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(5))));
+/// ```
+#[inline(always)]
+pub fn f64<I, E: ParserError<I>>(endian: Endianness) -> impl Parser<I, f64, E>
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ <I as Stream>::Slice: AsBytes,
+{
+ move |input: &mut I| {
+ match endian {
+ Endianness::Big => be_f64,
+ Endianness::Little => le_f64,
+ #[cfg(target_endian = "big")]
+ Endianness::Native => be_f64,
+ #[cfg(target_endian = "little")]
+ Endianness::Native => le_f64,
+ }
+ }(input)
+}
+
+/// Get a length-prefixed slice ([TLV](https://en.wikipedia.org/wiki/Type-length-value))
+///
+/// To apply a parser to the returned slice, see [`length_and_then`].
+///
+/// If the count is for something besides tokens, see [`length_repeat`].
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Arguments
+/// * `f` The parser to apply.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed, stream::Partial};
+/// # use winnow::prelude::*;
+/// use winnow::Bytes;
+/// use winnow::binary::be_u16;
+/// use winnow::binary::length_take;
+/// use winnow::token::tag;
+///
+/// type Stream<'i> = Partial<&'i Bytes>;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Partial::new(Bytes::new(b))
+/// }
+///
+/// fn parser(s: Stream<'_>) -> IResult<Stream<'_>, &[u8]> {
+/// length_take(be_u16).parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(stream(b"\x00\x03abcefg")), Ok((stream(&b"efg"[..]), &b"abc"[..])));
+/// assert_eq!(parser(stream(b"\x00\x03a")), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+pub fn length_take<I, N, E, F>(mut f: F) -> impl Parser<I, <I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ N: ToUsize,
+ F: Parser<I, N, E>,
+ E: ParserError<I>,
+{
+ trace("length_take", move |i: &mut I| {
+ let length = f.parse_next(i)?;
+
+ crate::token::take(length).parse_next(i)
+ })
+}
+
+/// Deprecated since 0.5.27, replaced with [`length_take`]
+#[deprecated(since = "0.5.27", note = "Replaced with `length_take`")]
+pub fn length_data<I, N, E, F>(f: F) -> impl Parser<I, <I as Stream>::Slice, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ N: ToUsize,
+ F: Parser<I, N, E>,
+ E: ParserError<I>,
+{
+ length_take(f)
+}
+
+/// Parse a length-prefixed slice ([TLV](https://en.wikipedia.org/wiki/Type-length-value))
+///
+/// *Complete version*: Returns an error if there is not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there is not enough data.
+///
+/// # Arguments
+/// * `f` The parser to apply.
+/// * `g` The parser to apply on the subslice.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed, stream::{Partial, StreamIsPartial}};
+/// # use winnow::prelude::*;
+/// use winnow::Bytes;
+/// use winnow::binary::be_u16;
+/// use winnow::binary::length_and_then;
+/// use winnow::token::tag;
+///
+/// type Stream<'i> = Partial<&'i Bytes>;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Partial::new(Bytes::new(b))
+/// }
+///
+/// fn complete_stream(b: &[u8]) -> Stream<'_> {
+/// let mut p = Partial::new(Bytes::new(b));
+/// let _ = p.complete();
+/// p
+/// }
+///
+/// fn parser(s: Stream<'_>) -> IResult<Stream<'_>, &[u8]> {
+/// length_and_then(be_u16, "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(stream(b"\x00\x03abcefg")), Ok((stream(&b"efg"[..]), &b"abc"[..])));
+/// assert_eq!(parser(stream(b"\x00\x03123123")), Err(ErrMode::Backtrack(InputError::new(complete_stream(&b"123"[..]), ErrorKind::Tag))));
+/// assert_eq!(parser(stream(b"\x00\x03a")), Err(ErrMode::Incomplete(Needed::new(2))));
+/// ```
+pub fn length_and_then<I, O, N, E, F, G>(mut f: F, mut g: G) -> impl Parser<I, O, E>
+where
+ I: StreamIsPartial,
+ I: Stream + UpdateSlice + Clone,
+ N: ToUsize,
+ F: Parser<I, N, E>,
+ G: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ trace("length_and_then", move |i: &mut I| {
+ let data = length_take(f.by_ref()).parse_next(i)?;
+ let mut data = I::update_slice(i.clone(), data);
+ let _ = data.complete();
+ let o = g.by_ref().complete_err().parse_next(&mut data)?;
+ Ok(o)
+ })
+}
+
+/// Deprecated since 0.5.27, replaced with [`length_and_then`]
+#[deprecated(since = "0.5.27", note = "Replaced with `length_and_then`")]
+pub fn length_value<I, O, N, E, F, G>(f: F, g: G) -> impl Parser<I, O, E>
+where
+ I: StreamIsPartial,
+ I: Stream + UpdateSlice + Clone,
+ N: ToUsize,
+ F: Parser<I, N, E>,
+ G: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ length_and_then(f, g)
+}
+
+/// [`Accumulate`] a length-prefixed sequence of values ([TLV](https://en.wikipedia.org/wiki/Type-length-value))
+///
+/// If the length represents token counts, see instead [`length_take`]
+///
+/// # Arguments
+/// * `f` The parser to apply to obtain the count.
+/// * `g` The parser to apply repeatedly.
+///
+/// # Example
+///
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::Bytes;
+/// use winnow::binary::u8;
+/// use winnow::binary::length_count;
+/// use winnow::token::tag;
+///
+/// type Stream<'i> = &'i Bytes;
+///
+/// fn stream(b: &[u8]) -> Stream<'_> {
+/// Bytes::new(b)
+/// }
+///
+/// fn parser(s: Stream<'_>) -> IResult<Stream<'_>, Vec<&[u8]>> {
+/// length_count(u8.map(|i| {
+/// println!("got number: {}", i);
+/// i
+/// }), "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(stream(b"\x02abcabcabc")), Ok((stream(b"abc"), vec![&b"abc"[..], &b"abc"[..]])));
+/// assert_eq!(parser(stream(b"\x03123123123")), Err(ErrMode::Backtrack(InputError::new(stream(b"123123123"), ErrorKind::Tag))));
+/// # }
+/// ```
+pub fn length_repeat<I, O, C, N, E, F, G>(mut f: F, mut g: G) -> impl Parser<I, C, E>
+where
+ I: Stream,
+ N: ToUsize,
+ C: Accumulate<O>,
+ F: Parser<I, N, E>,
+ G: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ trace("length_repeat", move |i: &mut I| {
+ let n = f.parse_next(i)?;
+ let n = n.to_usize();
+ repeat(n, g.by_ref()).parse_next(i)
+ })
+}
+
+/// Deprecated since 0.5.27, replaced with [`length_repeat`]
+#[deprecated(since = "0.5.27", note = "Replaced with `length_repeat`")]
+pub fn length_count<I, O, C, N, E, F, G>(f: F, g: G) -> impl Parser<I, C, E>
+where
+ I: Stream,
+ N: ToUsize,
+ C: Accumulate<O>,
+ F: Parser<I, N, E>,
+ G: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ length_repeat(f, g)
+}
diff --git a/crates/winnow/src/binary/tests.rs b/crates/winnow/src/binary/tests.rs
new file mode 100644
index 0000000..bc2a005
--- /dev/null
+++ b/crates/winnow/src/binary/tests.rs
@@ -0,0 +1,1316 @@
+use super::*;
+use crate::unpeek;
+use crate::IResult;
+
+mod complete {
+ use super::*;
+ use crate::error::InputError;
+
+ macro_rules! assert_parse(
+ ($left: expr, $right: expr) => {
+ let res: $crate::IResult<_, _, InputError<_>> = $left;
+ assert_eq!(res, $right);
+ };
+ );
+
+ #[test]
+ fn i8_tests() {
+ assert_parse!(i8.parse_peek(&[0x00][..]), Ok((&b""[..], 0)));
+ assert_parse!(i8.parse_peek(&[0x7f][..]), Ok((&b""[..], 127)));
+ assert_parse!(i8.parse_peek(&[0xff][..]), Ok((&b""[..], -1)));
+ assert_parse!(i8.parse_peek(&[0x80][..]), Ok((&b""[..], -128)));
+ }
+
+ #[test]
+ fn be_i8_tests() {
+ assert_parse!(be_i8.parse_peek(&[0x00][..]), Ok((&b""[..], 0)));
+ assert_parse!(be_i8.parse_peek(&[0x7f][..]), Ok((&b""[..], 127)));
+ assert_parse!(be_i8.parse_peek(&[0xff][..]), Ok((&b""[..], -1)));
+ assert_parse!(be_i8.parse_peek(&[0x80][..]), Ok((&b""[..], -128)));
+ }
+
+ #[test]
+ fn be_i16_tests() {
+ assert_parse!(be_i16.parse_peek(&[0x00, 0x00][..]), Ok((&b""[..], 0)));
+ assert_parse!(
+ be_i16.parse_peek(&[0x7f, 0xff][..]),
+ Ok((&b""[..], 32_767_i16))
+ );
+ assert_parse!(be_i16.parse_peek(&[0xff, 0xff][..]), Ok((&b""[..], -1)));
+ assert_parse!(
+ be_i16.parse_peek(&[0x80, 0x00][..]),
+ Ok((&b""[..], -32_768_i16))
+ );
+ }
+
+ #[test]
+ fn be_u24_tests() {
+ assert_parse!(
+ be_u24.parse_peek(&[0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ be_u24.parse_peek(&[0x00, 0xFF, 0xFF][..]),
+ Ok((&b""[..], 65_535_u32))
+ );
+ assert_parse!(
+ be_u24.parse_peek(&[0x12, 0x34, 0x56][..]),
+ Ok((&b""[..], 1_193_046_u32))
+ );
+ }
+
+ #[test]
+ fn be_i24_tests() {
+ assert_parse!(
+ be_i24.parse_peek(&[0xFF, 0xFF, 0xFF][..]),
+ Ok((&b""[..], -1_i32))
+ );
+ assert_parse!(
+ be_i24.parse_peek(&[0xFF, 0x00, 0x00][..]),
+ Ok((&b""[..], -65_536_i32))
+ );
+ assert_parse!(
+ be_i24.parse_peek(&[0xED, 0xCB, 0xAA][..]),
+ Ok((&b""[..], -1_193_046_i32))
+ );
+ }
+
+ #[test]
+ fn be_i32_tests() {
+ assert_parse!(
+ be_i32.parse_peek(&[0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ be_i32.parse_peek(&[0x7f, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], 2_147_483_647_i32))
+ );
+ assert_parse!(
+ be_i32.parse_peek(&[0xff, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ be_i32.parse_peek(&[0x80, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], -2_147_483_648_i32))
+ );
+ }
+
+ #[test]
+ fn be_i64_tests() {
+ assert_parse!(
+ be_i64.parse_peek(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ be_i64.parse_peek(&[0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], 9_223_372_036_854_775_807_i64))
+ );
+ assert_parse!(
+ be_i64.parse_peek(&[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ be_i64.parse_peek(&[0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], -9_223_372_036_854_775_808_i64))
+ );
+ }
+
+ #[test]
+ fn be_i128_tests() {
+ assert_parse!(
+ be_i128.parse_peek(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ ),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ be_i128.parse_peek(
+ &[
+ 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ ),
+ Ok((
+ &b""[..],
+ 170_141_183_460_469_231_731_687_303_715_884_105_727_i128
+ ))
+ );
+ assert_parse!(
+ be_i128.parse_peek(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ ),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ be_i128.parse_peek(
+ &[
+ 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ ),
+ Ok((
+ &b""[..],
+ -170_141_183_460_469_231_731_687_303_715_884_105_728_i128
+ ))
+ );
+ }
+
+ #[test]
+ fn le_i8_tests() {
+ assert_parse!(le_i8.parse_peek(&[0x00][..]), Ok((&b""[..], 0)));
+ assert_parse!(le_i8.parse_peek(&[0x7f][..]), Ok((&b""[..], 127)));
+ assert_parse!(le_i8.parse_peek(&[0xff][..]), Ok((&b""[..], -1)));
+ assert_parse!(le_i8.parse_peek(&[0x80][..]), Ok((&b""[..], -128)));
+ }
+
+ #[test]
+ fn le_i16_tests() {
+ assert_parse!(le_i16.parse_peek(&[0x00, 0x00][..]), Ok((&b""[..], 0)));
+ assert_parse!(
+ le_i16.parse_peek(&[0xff, 0x7f][..]),
+ Ok((&b""[..], 32_767_i16))
+ );
+ assert_parse!(le_i16.parse_peek(&[0xff, 0xff][..]), Ok((&b""[..], -1)));
+ assert_parse!(
+ le_i16.parse_peek(&[0x00, 0x80][..]),
+ Ok((&b""[..], -32_768_i16))
+ );
+ }
+
+ #[test]
+ fn le_u24_tests() {
+ assert_parse!(
+ le_u24.parse_peek(&[0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ le_u24.parse_peek(&[0xFF, 0xFF, 0x00][..]),
+ Ok((&b""[..], 65_535_u32))
+ );
+ assert_parse!(
+ le_u24.parse_peek(&[0x56, 0x34, 0x12][..]),
+ Ok((&b""[..], 1_193_046_u32))
+ );
+ }
+
+ #[test]
+ fn le_i24_tests() {
+ assert_parse!(
+ le_i24.parse_peek(&[0xFF, 0xFF, 0xFF][..]),
+ Ok((&b""[..], -1_i32))
+ );
+ assert_parse!(
+ le_i24.parse_peek(&[0x00, 0x00, 0xFF][..]),
+ Ok((&b""[..], -65_536_i32))
+ );
+ assert_parse!(
+ le_i24.parse_peek(&[0xAA, 0xCB, 0xED][..]),
+ Ok((&b""[..], -1_193_046_i32))
+ );
+ }
+
+ #[test]
+ fn le_i32_tests() {
+ assert_parse!(
+ le_i32.parse_peek(&[0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ le_i32.parse_peek(&[0xff, 0xff, 0xff, 0x7f][..]),
+ Ok((&b""[..], 2_147_483_647_i32))
+ );
+ assert_parse!(
+ le_i32.parse_peek(&[0xff, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ le_i32.parse_peek(&[0x00, 0x00, 0x00, 0x80][..]),
+ Ok((&b""[..], -2_147_483_648_i32))
+ );
+ }
+
+ #[test]
+ fn le_i64_tests() {
+ assert_parse!(
+ le_i64.parse_peek(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ le_i64.parse_peek(&[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f][..]),
+ Ok((&b""[..], 9_223_372_036_854_775_807_i64))
+ );
+ assert_parse!(
+ le_i64.parse_peek(&[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ le_i64.parse_peek(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80][..]),
+ Ok((&b""[..], -9_223_372_036_854_775_808_i64))
+ );
+ }
+
+ #[test]
+ fn le_i128_tests() {
+ assert_parse!(
+ le_i128.parse_peek(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ ),
+ Ok((&b""[..], 0))
+ );
+ assert_parse!(
+ le_i128.parse_peek(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0x7f
+ ][..]
+ ),
+ Ok((
+ &b""[..],
+ 170_141_183_460_469_231_731_687_303_715_884_105_727_i128
+ ))
+ );
+ assert_parse!(
+ le_i128.parse_peek(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ ),
+ Ok((&b""[..], -1))
+ );
+ assert_parse!(
+ le_i128.parse_peek(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x80
+ ][..]
+ ),
+ Ok((
+ &b""[..],
+ -170_141_183_460_469_231_731_687_303_715_884_105_728_i128
+ ))
+ );
+ }
+
+ #[test]
+ fn be_f32_tests() {
+ assert_parse!(
+ be_f32.parse_peek(&[0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0_f32))
+ );
+ assert_parse!(
+ be_f32.parse_peek(&[0x4d, 0x31, 0x1f, 0xd8][..]),
+ Ok((&b""[..], 185_728_380_f32))
+ );
+ }
+
+ #[test]
+ fn be_f64_tests() {
+ assert_parse!(
+ be_f64.parse_peek(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0_f64))
+ );
+ assert_parse!(
+ be_f64.parse_peek(&[0x41, 0xa6, 0x23, 0xfb, 0x10, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 185_728_392_f64))
+ );
+ }
+
+ #[test]
+ fn le_f32_tests() {
+ assert_parse!(
+ le_f32.parse_peek(&[0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0_f32))
+ );
+ assert_parse!(
+ le_f32.parse_peek(&[0xd8, 0x1f, 0x31, 0x4d][..]),
+ Ok((&b""[..], 185_728_380_f32))
+ );
+ }
+
+ #[test]
+ fn le_f64_tests() {
+ assert_parse!(
+ le_f64.parse_peek(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]),
+ Ok((&b""[..], 0_f64))
+ );
+ assert_parse!(
+ le_f64.parse_peek(&[0x00, 0x00, 0x00, 0x10, 0xfb, 0x23, 0xa6, 0x41][..]),
+ Ok((&b""[..], 185_728_392_f64))
+ );
+ }
+
+ #[test]
+ fn configurable_endianness() {
+ use crate::binary::Endianness;
+
+ fn be_tst16(i: &[u8]) -> IResult<&[u8], u16> {
+ u16(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst16(i: &[u8]) -> IResult<&[u8], u16> {
+ u16(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(be_tst16(&[0x80, 0x00]), Ok((&b""[..], 32_768_u16)));
+ assert_eq!(le_tst16(&[0x80, 0x00]), Ok((&b""[..], 128_u16)));
+
+ fn be_tst32(i: &[u8]) -> IResult<&[u8], u32> {
+ u32(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst32(i: &[u8]) -> IResult<&[u8], u32> {
+ u32(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tst32(&[0x12, 0x00, 0x60, 0x00]),
+ Ok((&b""[..], 302_014_464_u32))
+ );
+ assert_eq!(
+ le_tst32(&[0x12, 0x00, 0x60, 0x00]),
+ Ok((&b""[..], 6_291_474_u32))
+ );
+
+ fn be_tst64(i: &[u8]) -> IResult<&[u8], u64> {
+ u64(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst64(i: &[u8]) -> IResult<&[u8], u64> {
+ u64(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tst64(&[0x12, 0x00, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00]),
+ Ok((&b""[..], 1_297_142_246_100_992_000_u64))
+ );
+ assert_eq!(
+ le_tst64(&[0x12, 0x00, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00]),
+ Ok((&b""[..], 36_028_874_334_666_770_u64))
+ );
+
+ fn be_tsti16(i: &[u8]) -> IResult<&[u8], i16> {
+ i16(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti16(i: &[u8]) -> IResult<&[u8], i16> {
+ i16(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(be_tsti16(&[0x00, 0x80]), Ok((&b""[..], 128_i16)));
+ assert_eq!(le_tsti16(&[0x00, 0x80]), Ok((&b""[..], -32_768_i16)));
+
+ fn be_tsti32(i: &[u8]) -> IResult<&[u8], i32> {
+ i32(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti32(i: &[u8]) -> IResult<&[u8], i32> {
+ i32(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tsti32(&[0x00, 0x12, 0x60, 0x00]),
+ Ok((&b""[..], 1_204_224_i32))
+ );
+ assert_eq!(
+ le_tsti32(&[0x00, 0x12, 0x60, 0x00]),
+ Ok((&b""[..], 6_296_064_i32))
+ );
+
+ fn be_tsti64(i: &[u8]) -> IResult<&[u8], i64> {
+ i64(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti64(i: &[u8]) -> IResult<&[u8], i64> {
+ i64(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tsti64(&[0x00, 0xFF, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00]),
+ Ok((&b""[..], 71_881_672_479_506_432_i64))
+ );
+ assert_eq!(
+ le_tsti64(&[0x00, 0xFF, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00]),
+ Ok((&b""[..], 36_028_874_334_732_032_i64))
+ );
+ }
+}
+
+mod partial {
+ use super::*;
+ use crate::error::ErrMode;
+ use crate::error::InputError;
+ use crate::error::Needed;
+ #[cfg(feature = "alloc")]
+ use crate::lib::std::vec::Vec;
+ use crate::Partial;
+ use crate::{
+ ascii::digit1 as digit,
+ binary::{be_u16, be_u8},
+ error::ErrorKind,
+ lib::std::str::{self, FromStr},
+ IResult,
+ };
+
+ macro_rules! assert_parse(
+ ($left: expr, $right: expr) => {
+ let res: $crate::IResult<_, _, InputError<_>> = $left;
+ assert_eq!(res, $right);
+ };
+ );
+
+ #[test]
+ fn i8_tests() {
+ assert_parse!(
+ be_i8.parse_peek(Partial::new(&[0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_i8.parse_peek(Partial::new(&[0x7f][..])),
+ Ok((Partial::new(&b""[..]), 127))
+ );
+ assert_parse!(
+ be_i8.parse_peek(Partial::new(&[0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ be_i8.parse_peek(Partial::new(&[0x80][..])),
+ Ok((Partial::new(&b""[..]), -128))
+ );
+ assert_parse!(
+ be_i8.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn i16_tests() {
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[0x7f, 0xff][..])),
+ Ok((Partial::new(&b""[..]), 32_767_i16))
+ );
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[0xff, 0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[0x80, 0x00][..])),
+ Ok((Partial::new(&b""[..]), -32_768_i16))
+ );
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_i16.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn u24_tests() {
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[0x00, 0xFF, 0xFF][..])),
+ Ok((Partial::new(&b""[..]), 65_535_u32))
+ );
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[0x12, 0x34, 0x56][..])),
+ Ok((Partial::new(&b""[..]), 1_193_046_u32))
+ );
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_u24.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn i24_tests() {
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[0xFF, 0xFF, 0xFF][..])),
+ Ok((Partial::new(&b""[..]), -1_i32))
+ );
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[0xFF, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), -65_536_i32))
+ );
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[0xED, 0xCB, 0xAA][..])),
+ Ok((Partial::new(&b""[..]), -1_193_046_i32))
+ );
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_i24.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn i32_tests() {
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x7f, 0xff, 0xff, 0xff][..])),
+ Ok((Partial::new(&b""[..]), 2_147_483_647_i32))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0xff, 0xff, 0xff, 0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x80, 0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), -2_147_483_648_i32))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_i32.parse_peek(Partial::new(&[0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn i64_tests() {
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(
+ &[0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]
+ )),
+ Ok((Partial::new(&b""[..]), 9_223_372_036_854_775_807_i64))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(
+ &[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]
+ )),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(
+ &[0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), -9_223_372_036_854_775_808_i64))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(8)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(7)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(6)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(5)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_i64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn i128_tests() {
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0x7f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ )),
+ Ok((
+ Partial::new(&b""[..]),
+ 170_141_183_460_469_231_731_687_303_715_884_105_727_i128
+ ))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ )),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ )),
+ Ok((
+ Partial::new(&b""[..]),
+ -170_141_183_460_469_231_731_687_303_715_884_105_728_i128
+ ))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[][..])),
+ Err(ErrMode::Incomplete(Needed::new(16)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(15)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(14)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(13)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(12)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(11)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..])),
+ Err(ErrMode::Incomplete(Needed::new(10)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(9)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(8)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(7)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(6)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(5)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00
+ ][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_parse!(
+ be_i128.parse_peek(Partial::new(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00
+ ][..]
+ )),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ }
+
+ #[test]
+ fn le_i8_tests() {
+ assert_parse!(
+ le_i8.parse_peek(Partial::new(&[0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_i8.parse_peek(Partial::new(&[0x7f][..])),
+ Ok((Partial::new(&b""[..]), 127))
+ );
+ assert_parse!(
+ le_i8.parse_peek(Partial::new(&[0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ le_i8.parse_peek(Partial::new(&[0x80][..])),
+ Ok((Partial::new(&b""[..]), -128))
+ );
+ }
+
+ #[test]
+ fn le_i16_tests() {
+ assert_parse!(
+ le_i16.parse_peek(Partial::new(&[0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_i16.parse_peek(Partial::new(&[0xff, 0x7f][..])),
+ Ok((Partial::new(&b""[..]), 32_767_i16))
+ );
+ assert_parse!(
+ le_i16.parse_peek(Partial::new(&[0xff, 0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ le_i16.parse_peek(Partial::new(&[0x00, 0x80][..])),
+ Ok((Partial::new(&b""[..]), -32_768_i16))
+ );
+ }
+
+ #[test]
+ fn le_u24_tests() {
+ assert_parse!(
+ le_u24.parse_peek(Partial::new(&[0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_u24.parse_peek(Partial::new(&[0xFF, 0xFF, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 65_535_u32))
+ );
+ assert_parse!(
+ le_u24.parse_peek(Partial::new(&[0x56, 0x34, 0x12][..])),
+ Ok((Partial::new(&b""[..]), 1_193_046_u32))
+ );
+ }
+
+ #[test]
+ fn le_i24_tests() {
+ assert_parse!(
+ le_i24.parse_peek(Partial::new(&[0xFF, 0xFF, 0xFF][..])),
+ Ok((Partial::new(&b""[..]), -1_i32))
+ );
+ assert_parse!(
+ le_i24.parse_peek(Partial::new(&[0x00, 0x00, 0xFF][..])),
+ Ok((Partial::new(&b""[..]), -65_536_i32))
+ );
+ assert_parse!(
+ le_i24.parse_peek(Partial::new(&[0xAA, 0xCB, 0xED][..])),
+ Ok((Partial::new(&b""[..]), -1_193_046_i32))
+ );
+ }
+
+ #[test]
+ fn le_i32_tests() {
+ assert_parse!(
+ le_i32.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_i32.parse_peek(Partial::new(&[0xff, 0xff, 0xff, 0x7f][..])),
+ Ok((Partial::new(&b""[..]), 2_147_483_647_i32))
+ );
+ assert_parse!(
+ le_i32.parse_peek(Partial::new(&[0xff, 0xff, 0xff, 0xff][..])),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ le_i32.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x80][..])),
+ Ok((Partial::new(&b""[..]), -2_147_483_648_i32))
+ );
+ }
+
+ #[test]
+ fn le_i64_tests() {
+ assert_parse!(
+ le_i64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_i64.parse_peek(Partial::new(
+ &[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x7f][..]
+ )),
+ Ok((Partial::new(&b""[..]), 9_223_372_036_854_775_807_i64))
+ );
+ assert_parse!(
+ le_i64.parse_peek(Partial::new(
+ &[0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff][..]
+ )),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ le_i64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x80][..]
+ )),
+ Ok((Partial::new(&b""[..]), -9_223_372_036_854_775_808_i64))
+ );
+ }
+
+ #[test]
+ fn le_i128_tests() {
+ assert_parse!(
+ le_i128.parse_peek(Partial::new(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00
+ ][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0))
+ );
+ assert_parse!(
+ le_i128.parse_peek(Partial::new(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0x7f
+ ][..]
+ )),
+ Ok((
+ Partial::new(&b""[..]),
+ 170_141_183_460_469_231_731_687_303_715_884_105_727_i128
+ ))
+ );
+ assert_parse!(
+ le_i128.parse_peek(Partial::new(
+ &[
+ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
+ 0xff, 0xff, 0xff
+ ][..]
+ )),
+ Ok((Partial::new(&b""[..]), -1))
+ );
+ assert_parse!(
+ le_i128.parse_peek(Partial::new(
+ &[
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x80
+ ][..]
+ )),
+ Ok((
+ Partial::new(&b""[..]),
+ -170_141_183_460_469_231_731_687_303_715_884_105_728_i128
+ ))
+ );
+ }
+
+ #[test]
+ fn be_f32_tests() {
+ assert_parse!(
+ be_f32.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0_f32))
+ );
+ assert_parse!(
+ be_f32.parse_peek(Partial::new(&[0x4d, 0x31, 0x1f, 0xd8][..])),
+ Ok((Partial::new(&b""[..]), 185_728_380_f32))
+ );
+ }
+
+ #[test]
+ fn be_f64_tests() {
+ assert_parse!(
+ be_f64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0_f64))
+ );
+ assert_parse!(
+ be_f64.parse_peek(Partial::new(
+ &[0x41, 0xa6, 0x23, 0xfb, 0x10, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), 185_728_392_f64))
+ );
+ }
+
+ #[test]
+ fn le_f32_tests() {
+ assert_parse!(
+ le_f32.parse_peek(Partial::new(&[0x00, 0x00, 0x00, 0x00][..])),
+ Ok((Partial::new(&b""[..]), 0_f32))
+ );
+ assert_parse!(
+ le_f32.parse_peek(Partial::new(&[0xd8, 0x1f, 0x31, 0x4d][..])),
+ Ok((Partial::new(&b""[..]), 185_728_380_f32))
+ );
+ }
+
+ #[test]
+ fn le_f64_tests() {
+ assert_parse!(
+ le_f64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00][..]
+ )),
+ Ok((Partial::new(&b""[..]), 0_f64))
+ );
+ assert_parse!(
+ le_f64.parse_peek(Partial::new(
+ &[0x00, 0x00, 0x00, 0x10, 0xfb, 0x23, 0xa6, 0x41][..]
+ )),
+ Ok((Partial::new(&b""[..]), 185_728_392_f64))
+ );
+ }
+
+ #[test]
+ fn configurable_endianness() {
+ use crate::binary::Endianness;
+
+ fn be_tst16(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u16> {
+ u16(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst16(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u16> {
+ u16(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tst16(Partial::new(&[0x80, 0x00])),
+ Ok((Partial::new(&b""[..]), 32_768_u16))
+ );
+ assert_eq!(
+ le_tst16(Partial::new(&[0x80, 0x00])),
+ Ok((Partial::new(&b""[..]), 128_u16))
+ );
+
+ fn be_tst32(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+ u32(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst32(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+ u32(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tst32(Partial::new(&[0x12, 0x00, 0x60, 0x00])),
+ Ok((Partial::new(&b""[..]), 302_014_464_u32))
+ );
+ assert_eq!(
+ le_tst32(Partial::new(&[0x12, 0x00, 0x60, 0x00])),
+ Ok((Partial::new(&b""[..]), 6_291_474_u32))
+ );
+
+ fn be_tst64(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u64> {
+ u64(Endianness::Big).parse_peek(i)
+ }
+ fn le_tst64(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u64> {
+ u64(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tst64(Partial::new(&[
+ 0x12, 0x00, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00
+ ])),
+ Ok((Partial::new(&b""[..]), 1_297_142_246_100_992_000_u64))
+ );
+ assert_eq!(
+ le_tst64(Partial::new(&[
+ 0x12, 0x00, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00
+ ])),
+ Ok((Partial::new(&b""[..]), 36_028_874_334_666_770_u64))
+ );
+
+ fn be_tsti16(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i16> {
+ i16(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti16(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i16> {
+ i16(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tsti16(Partial::new(&[0x00, 0x80])),
+ Ok((Partial::new(&b""[..]), 128_i16))
+ );
+ assert_eq!(
+ le_tsti16(Partial::new(&[0x00, 0x80])),
+ Ok((Partial::new(&b""[..]), -32_768_i16))
+ );
+
+ fn be_tsti32(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+ i32(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti32(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i32> {
+ i32(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tsti32(Partial::new(&[0x00, 0x12, 0x60, 0x00])),
+ Ok((Partial::new(&b""[..]), 1_204_224_i32))
+ );
+ assert_eq!(
+ le_tsti32(Partial::new(&[0x00, 0x12, 0x60, 0x00])),
+ Ok((Partial::new(&b""[..]), 6_296_064_i32))
+ );
+
+ fn be_tsti64(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i64> {
+ i64(Endianness::Big).parse_peek(i)
+ }
+ fn le_tsti64(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, i64> {
+ i64(Endianness::Little).parse_peek(i)
+ }
+ assert_eq!(
+ be_tsti64(Partial::new(&[
+ 0x00, 0xFF, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00
+ ])),
+ Ok((Partial::new(&b""[..]), 71_881_672_479_506_432_i64))
+ );
+ assert_eq!(
+ le_tsti64(Partial::new(&[
+ 0x00, 0xFF, 0x60, 0x00, 0x12, 0x00, 0x80, 0x00
+ ])),
+ Ok((Partial::new(&b""[..]), 36_028_874_334_732_032_i64))
+ );
+ }
+
+ #[test]
+ #[cfg(feature = "alloc")]
+ fn length_repeat_test() {
+ fn number(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+ digit
+ .try_map(str::from_utf8)
+ .try_map(FromStr::from_str)
+ .parse_peek(i)
+ }
+
+ fn cnt(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ length_repeat(unpeek(number), "abc").parse_peek(i)
+ }
+
+ assert_eq!(
+ cnt(Partial::new(&b"2abcabcabcdef"[..])),
+ Ok((Partial::new(&b"abcdef"[..]), vec![&b"abc"[..], &b"abc"[..]]))
+ );
+ assert_eq!(
+ cnt(Partial::new(&b"2ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ cnt(Partial::new(&b"3abcab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ cnt(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ cnt(Partial::new(&b"2abcxxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ }
+
+ #[test]
+ fn partial_length_bytes() {
+ use crate::binary::le_u8;
+
+ fn x(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ length_take(le_u8).parse_peek(i)
+ }
+ assert_eq!(
+ x(Partial::new(b"\x02..>>")),
+ Ok((Partial::new(&b">>"[..]), &b".."[..]))
+ );
+ assert_eq!(
+ x(Partial::new(b"\x02..")),
+ Ok((Partial::new(&[][..]), &b".."[..]))
+ );
+ assert_eq!(
+ x(Partial::new(b"\x02.")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ x(Partial::new(b"\x02")),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+
+ fn y(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ let (i, _) = "magic".parse_peek(i)?;
+ length_take(le_u8).parse_peek(i)
+ }
+ assert_eq!(
+ y(Partial::new(b"magic\x02..>>")),
+ Ok((Partial::new(&b">>"[..]), &b".."[..]))
+ );
+ assert_eq!(
+ y(Partial::new(b"magic\x02..")),
+ Ok((Partial::new(&[][..]), &b".."[..]))
+ );
+ assert_eq!(
+ y(Partial::new(b"magic\x02.")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ y(Partial::new(b"magic\x02")),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ }
+
+ #[test]
+ fn length_take_test() {
+ fn number(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u32> {
+ digit
+ .try_map(str::from_utf8)
+ .try_map(FromStr::from_str)
+ .parse_peek(i)
+ }
+
+ fn take(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ length_take(unpeek(number)).parse_peek(i)
+ }
+
+ assert_eq!(
+ take(Partial::new(&b"6abcabcabcdef"[..])),
+ Ok((Partial::new(&b"abcdef"[..]), &b"abcabc"[..]))
+ );
+ assert_eq!(
+ take(Partial::new(&b"3ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ take(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ take(Partial::new(&b"2abcxxx"[..])),
+ Ok((Partial::new(&b"cxxx"[..]), &b"ab"[..]))
+ );
+ }
+
+ #[test]
+ fn length_and_then_test() {
+ use crate::stream::StreamIsPartial;
+
+ fn length_and_then_1(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u16> {
+ length_and_then(be_u8, be_u16).parse_peek(i)
+ }
+ fn length_and_then_2(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (u8, u8)> {
+ length_and_then(be_u8, (be_u8, be_u8)).parse_peek(i)
+ }
+
+ let mut empty_complete = Partial::new(&b""[..]);
+ let _ = empty_complete.complete();
+
+ let i1 = [0, 5, 6];
+ assert_eq!(
+ length_and_then_1(Partial::new(&i1)),
+ Err(ErrMode::Backtrack(error_position!(
+ &empty_complete,
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ length_and_then_2(Partial::new(&i1)),
+ Err(ErrMode::Backtrack(error_position!(
+ &empty_complete,
+ ErrorKind::Token
+ )))
+ );
+
+ let i2 = [1, 5, 6, 3];
+ {
+ let mut middle_complete = Partial::new(&i2[1..2]);
+ let _ = middle_complete.complete();
+ assert_eq!(
+ length_and_then_1(Partial::new(&i2)),
+ Err(ErrMode::Backtrack(error_position!(
+ &middle_complete,
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ length_and_then_2(Partial::new(&i2)),
+ Err(ErrMode::Backtrack(error_position!(
+ &empty_complete,
+ ErrorKind::Token
+ )))
+ );
+ }
+
+ let i3 = [2, 5, 6, 3, 4, 5, 7];
+ assert_eq!(
+ length_and_then_1(Partial::new(&i3)),
+ Ok((Partial::new(&i3[3..]), 1286))
+ );
+ assert_eq!(
+ length_and_then_2(Partial::new(&i3)),
+ Ok((Partial::new(&i3[3..]), (5, 6)))
+ );
+
+ let i4 = [3, 5, 6, 3, 4, 5];
+ assert_eq!(
+ length_and_then_1(Partial::new(&i4)),
+ Ok((Partial::new(&i4[4..]), 1286))
+ );
+ assert_eq!(
+ length_and_then_2(Partial::new(&i4)),
+ Ok((Partial::new(&i4[4..]), (5, 6)))
+ );
+ }
+}
diff --git a/crates/winnow/src/combinator/branch.rs b/crates/winnow/src/combinator/branch.rs
new file mode 100644
index 0000000..7fdcf8d
--- /dev/null
+++ b/crates/winnow/src/combinator/branch.rs
@@ -0,0 +1,329 @@
+use crate::combinator::trace;
+use crate::error::{ErrMode, ErrorKind, ParserError};
+use crate::stream::Stream;
+use crate::*;
+
+#[doc(inline)]
+pub use crate::dispatch;
+
+/// Helper trait for the [alt()] combinator.
+///
+/// This trait is implemented for tuples of up to 21 elements
+pub trait Alt<I, O, E> {
+ /// Tests each parser in the tuple and returns the result of the first one that succeeds
+ fn choice(&mut self, input: &mut I) -> PResult<O, E>;
+}
+
+/// Pick the first successful parser
+///
+/// To stop on an error, rather than trying further cases, see
+/// [`cut_err`][crate::combinator::cut_err] ([example][crate::_tutorial::chapter_6]).
+///
+/// For tight control over the error when no match is found, add a final case using [`fail`][crate::combinator::fail].
+/// Alternatively, with a [custom error type][crate::_topic::error], it is possible to track all
+/// errors or return the error of the parser that went the farthest in the input data.
+///
+/// When the alternative cases have unique prefixes, [`dispatch`] can offer better performance.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::InputError,error::ErrorKind, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::ascii::{alpha1, digit1};
+/// use winnow::combinator::alt;
+/// # fn main() {
+/// fn parser(input: &str) -> IResult<&str, &str> {
+/// alt((alpha1, digit1)).parse_peek(input)
+/// };
+///
+/// // the first parser, alpha1, recognizes the input
+/// assert_eq!(parser("abc"), Ok(("", "abc")));
+///
+/// // the first parser returns an error, so alt tries the second one
+/// assert_eq!(parser("123456"), Ok(("", "123456")));
+///
+/// // both parsers failed, and with the default error type, alt will return the last error
+/// assert_eq!(parser(" "), Err(ErrMode::Backtrack(InputError::new(" ", ErrorKind::Slice))));
+/// # }
+/// ```
+#[doc(alias = "choice")]
+pub fn alt<I: Stream, O, E: ParserError<I>, List: Alt<I, O, E>>(
+ mut l: List,
+) -> impl Parser<I, O, E> {
+ trace("alt", move |i: &mut I| l.choice(i))
+}
+
+/// Helper trait for the [permutation()] combinator.
+///
+/// This trait is implemented for tuples of up to 21 elements
+pub trait Permutation<I, O, E> {
+ /// Tries to apply all parsers in the tuple in various orders until all of them succeed
+ fn permutation(&mut self, input: &mut I) -> PResult<O, E>;
+}
+
+/// Applies a list of parsers in any order.
+///
+/// Permutation will succeed if all of the child parsers succeeded.
+/// It takes as argument a tuple of parsers, and returns a
+/// tuple of the parser results.
+///
+/// To stop on an error, rather than trying further permutations, see
+/// [`cut_err`][crate::combinator::cut_err] ([example][crate::_tutorial::chapter_6]).
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode,error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::ascii::{alpha1, digit1};
+/// use winnow::combinator::permutation;
+/// # fn main() {
+/// fn parser(input: &str) -> IResult<&str, (&str, &str)> {
+/// permutation((alpha1, digit1)).parse_peek(input)
+/// }
+///
+/// // permutation recognizes alphabetic characters then digit
+/// assert_eq!(parser("abc123"), Ok(("", ("abc", "123"))));
+///
+/// // but also in inverse order
+/// assert_eq!(parser("123abc"), Ok(("", ("abc", "123"))));
+///
+/// // it will fail if one of the parsers failed
+/// assert_eq!(parser("abc;"), Err(ErrMode::Backtrack(InputError::new(";", ErrorKind::Slice))));
+/// # }
+/// ```
+///
+/// The parsers are applied greedily: if there are multiple unapplied parsers
+/// that could parse the next slice of input, the first one is used.
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::permutation;
+/// use winnow::token::any;
+///
+/// fn parser(input: &str) -> IResult<&str, (char, char)> {
+/// permutation((any, 'a')).parse_peek(input)
+/// }
+///
+/// // any parses 'b', then char('a') parses 'a'
+/// assert_eq!(parser("ba"), Ok(("", ('b', 'a'))));
+///
+/// // any parses 'a', then char('a') fails on 'b',
+/// // even though char('a') followed by any would succeed
+/// assert_eq!(parser("ab"), Err(ErrMode::Backtrack(InputError::new("b", ErrorKind::Verify))));
+/// ```
+///
+pub fn permutation<I: Stream, O, E: ParserError<I>, List: Permutation<I, O, E>>(
+ mut l: List,
+) -> impl Parser<I, O, E> {
+ trace("permutation", move |i: &mut I| l.permutation(i))
+}
+
+impl<const N: usize, I: Stream, O, E: ParserError<I>, P: Parser<I, O, E>> Alt<I, O, E> for [P; N] {
+ fn choice(&mut self, input: &mut I) -> PResult<O, E> {
+ let mut error: Option<E> = None;
+
+ let start = input.checkpoint();
+ for branch in self {
+ input.reset(start.clone());
+ match branch.parse_next(input) {
+ Err(ErrMode::Backtrack(e)) => {
+ error = match error {
+ Some(error) => Some(error.or(e)),
+ None => Some(e),
+ };
+ }
+ res => return res,
+ }
+ }
+
+ match error {
+ Some(e) => Err(ErrMode::Backtrack(e.append(input, ErrorKind::Alt))),
+ None => Err(ErrMode::assert(input, "`alt` needs at least one parser")),
+ }
+ }
+}
+
+macro_rules! alt_trait(
+ ($first:ident $second:ident $($id: ident)+) => (
+ alt_trait!(__impl $first $second; $($id)+);
+ );
+ (__impl $($current:ident)*; $head:ident $($id: ident)+) => (
+ alt_trait_impl!($($current)*);
+
+ alt_trait!(__impl $($current)* $head; $($id)+);
+ );
+ (__impl $($current:ident)*; $head:ident) => (
+ alt_trait_impl!($($current)*);
+ alt_trait_impl!($($current)* $head);
+ );
+);
+
+macro_rules! alt_trait_impl(
+ ($($id:ident)+) => (
+ impl<
+ I: Stream, Output, Error: ParserError<I>,
+ $($id: Parser<I, Output, Error>),+
+ > Alt<I, Output, Error> for ( $($id),+ ) {
+
+ fn choice(&mut self, input: &mut I) -> PResult<Output, Error> {
+ let start = input.checkpoint();
+ match self.0.parse_next(input) {
+ Err(ErrMode::Backtrack(e)) => alt_trait_inner!(1, self, input, start, e, $($id)+),
+ res => res,
+ }
+ }
+ }
+ );
+);
+
+macro_rules! succ (
+ (0, $submac:ident ! ($($rest:tt)*)) => ($submac!(1, $($rest)*));
+ (1, $submac:ident ! ($($rest:tt)*)) => ($submac!(2, $($rest)*));
+ (2, $submac:ident ! ($($rest:tt)*)) => ($submac!(3, $($rest)*));
+ (3, $submac:ident ! ($($rest:tt)*)) => ($submac!(4, $($rest)*));
+ (4, $submac:ident ! ($($rest:tt)*)) => ($submac!(5, $($rest)*));
+ (5, $submac:ident ! ($($rest:tt)*)) => ($submac!(6, $($rest)*));
+ (6, $submac:ident ! ($($rest:tt)*)) => ($submac!(7, $($rest)*));
+ (7, $submac:ident ! ($($rest:tt)*)) => ($submac!(8, $($rest)*));
+ (8, $submac:ident ! ($($rest:tt)*)) => ($submac!(9, $($rest)*));
+ (9, $submac:ident ! ($($rest:tt)*)) => ($submac!(10, $($rest)*));
+ (10, $submac:ident ! ($($rest:tt)*)) => ($submac!(11, $($rest)*));
+ (11, $submac:ident ! ($($rest:tt)*)) => ($submac!(12, $($rest)*));
+ (12, $submac:ident ! ($($rest:tt)*)) => ($submac!(13, $($rest)*));
+ (13, $submac:ident ! ($($rest:tt)*)) => ($submac!(14, $($rest)*));
+ (14, $submac:ident ! ($($rest:tt)*)) => ($submac!(15, $($rest)*));
+ (15, $submac:ident ! ($($rest:tt)*)) => ($submac!(16, $($rest)*));
+ (16, $submac:ident ! ($($rest:tt)*)) => ($submac!(17, $($rest)*));
+ (17, $submac:ident ! ($($rest:tt)*)) => ($submac!(18, $($rest)*));
+ (18, $submac:ident ! ($($rest:tt)*)) => ($submac!(19, $($rest)*));
+ (19, $submac:ident ! ($($rest:tt)*)) => ($submac!(20, $($rest)*));
+ (20, $submac:ident ! ($($rest:tt)*)) => ($submac!(21, $($rest)*));
+);
+
+macro_rules! alt_trait_inner(
+ ($it:tt, $self:expr, $input:expr, $start:ident, $err:expr, $head:ident $($id:ident)+) => ({
+ $input.reset($start.clone());
+ match $self.$it.parse_next($input) {
+ Err(ErrMode::Backtrack(e)) => {
+ let err = $err.or(e);
+ succ!($it, alt_trait_inner!($self, $input, $start, err, $($id)+))
+ }
+ res => res,
+ }
+ });
+ ($it:tt, $self:expr, $input:expr, $start:ident, $err:expr, $head:ident) => ({
+ Err(ErrMode::Backtrack($err.append($input, ErrorKind::Alt)))
+ });
+);
+
+alt_trait!(Alt2 Alt3 Alt4 Alt5 Alt6 Alt7 Alt8 Alt9 Alt10 Alt11 Alt12 Alt13 Alt14 Alt15 Alt16 Alt17 Alt18 Alt19 Alt20 Alt21 Alt22);
+
+// Manually implement Alt for (A,), the 1-tuple type
+impl<I, O, E: ParserError<I>, A: Parser<I, O, E>> Alt<I, O, E> for (A,) {
+ fn choice(&mut self, input: &mut I) -> PResult<O, E> {
+ self.0.parse_next(input)
+ }
+}
+
+macro_rules! permutation_trait(
+ (
+ $name1:ident $ty1:ident $item1:ident
+ $name2:ident $ty2:ident $item2:ident
+ $($name3:ident $ty3:ident $item3:ident)*
+ ) => (
+ permutation_trait!(__impl $name1 $ty1 $item1, $name2 $ty2 $item2; $($name3 $ty3 $item3)*);
+ );
+ (
+ __impl $($name:ident $ty:ident $item:ident),+;
+ $name1:ident $ty1:ident $item1:ident $($name2:ident $ty2:ident $item2:ident)*
+ ) => (
+ permutation_trait_impl!($($name $ty $item),+);
+ permutation_trait!(__impl $($name $ty $item),+ , $name1 $ty1 $item1; $($name2 $ty2 $item2)*);
+ );
+ (__impl $($name:ident $ty:ident $item:ident),+;) => (
+ permutation_trait_impl!($($name $ty $item),+);
+ );
+);
+
+macro_rules! permutation_trait_impl(
+ ($($name:ident $ty:ident $item:ident),+) => (
+ impl<
+ I: Stream, $($ty),+ , Error: ParserError<I>,
+ $($name: Parser<I, $ty, Error>),+
+ > Permutation<I, ( $($ty),+ ), Error> for ( $($name),+ ) {
+
+ fn permutation(&mut self, input: &mut I) -> PResult<( $($ty),+ ), Error> {
+ let mut res = ($(Option::<$ty>::None),+);
+
+ loop {
+ let mut err: Option<Error> = None;
+ let start = input.checkpoint();
+ permutation_trait_inner!(0, self, input, start, res, err, $($name)+);
+
+ // If we reach here, every iterator has either been applied before,
+ // or errored on the remaining input
+ if let Some(err) = err {
+ // There are remaining parsers, and all errored on the remaining input
+ input.reset(start.clone());
+ return Err(ErrMode::Backtrack(err.append(input, ErrorKind::Alt)));
+ }
+
+ // All parsers were applied
+ match res {
+ ($(Some($item)),+) => return Ok(($($item),+)),
+ _ => unreachable!(),
+ }
+ }
+ }
+ }
+ );
+);
+
+macro_rules! permutation_trait_inner(
+ ($it:tt, $self:expr, $input:ident, $start:ident, $res:expr, $err:expr, $head:ident $($id:ident)*) => (
+ if $res.$it.is_none() {
+ $input.reset($start.clone());
+ match $self.$it.parse_next($input) {
+ Ok(o) => {
+ $res.$it = Some(o);
+ continue;
+ }
+ Err(ErrMode::Backtrack(e)) => {
+ $err = Some(match $err {
+ Some(err) => err.or(e),
+ None => e,
+ });
+ }
+ Err(e) => return Err(e),
+ };
+ }
+ succ!($it, permutation_trait_inner!($self, $input, $start, $res, $err, $($id)*));
+ );
+ ($it:tt, $self:expr, $input:ident, $start:ident, $res:expr, $err:expr,) => ();
+);
+
+permutation_trait!(
+ P1 O1 o1
+ P2 O2 o2
+ P3 O3 o3
+ P4 O4 o4
+ P5 O5 o5
+ P6 O6 o6
+ P7 O7 o7
+ P8 O8 o8
+ P9 O9 o9
+ P10 O10 o10
+ P11 O11 o11
+ P12 O12 o12
+ P13 O13 o13
+ P14 O14 o14
+ P15 O15 o15
+ P16 O16 o16
+ P17 O17 o17
+ P18 O18 o18
+ P19 O19 o19
+ P20 O20 o20
+ P21 O21 o21
+);
diff --git a/crates/winnow/src/combinator/core.rs b/crates/winnow/src/combinator/core.rs
new file mode 100644
index 0000000..efd7758
--- /dev/null
+++ b/crates/winnow/src/combinator/core.rs
@@ -0,0 +1,501 @@
+use crate::combinator::trace;
+use crate::error::{ErrMode, ErrorKind, Needed, ParserError};
+use crate::stream::Stream;
+use crate::*;
+
+/// Return the remaining input.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::error::ErrorKind;
+/// # use winnow::error::InputError;
+/// use winnow::combinator::rest;
+/// assert_eq!(rest::<_,InputError<_>>.parse_peek("abc"), Ok(("", "abc")));
+/// assert_eq!(rest::<_,InputError<_>>.parse_peek(""), Ok(("", "")));
+/// ```
+#[inline]
+pub fn rest<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: Stream,
+{
+ trace("rest", move |input: &mut I| Ok(input.finish())).parse_next(input)
+}
+
+/// Return the length of the remaining input.
+///
+/// Note: this does not advance the [`Stream`]
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::error::ErrorKind;
+/// # use winnow::error::InputError;
+/// use winnow::combinator::rest_len;
+/// assert_eq!(rest_len::<_,InputError<_>>.parse_peek("abc"), Ok(("abc", 3)));
+/// assert_eq!(rest_len::<_,InputError<_>>.parse_peek(""), Ok(("", 0)));
+/// ```
+#[inline]
+pub fn rest_len<I, E: ParserError<I>>(input: &mut I) -> PResult<usize, E>
+where
+ I: Stream,
+{
+ trace("rest_len", move |input: &mut I| {
+ let len = input.eof_offset();
+ Ok(len)
+ })
+ .parse_next(input)
+}
+
+/// Apply a [`Parser`], producing `None` on [`ErrMode::Backtrack`].
+///
+/// To chain an error up, see [`cut_err`].
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::opt;
+/// use winnow::ascii::alpha1;
+/// # fn main() {
+///
+/// fn parser(i: &str) -> IResult<&str, Option<&str>> {
+/// opt(alpha1).parse_peek(i)
+/// }
+///
+/// assert_eq!(parser("abcd;"), Ok((";", Some("abcd"))));
+/// assert_eq!(parser("123;"), Ok(("123;", None)));
+/// # }
+/// ```
+pub fn opt<I: Stream, O, E: ParserError<I>, F>(mut f: F) -> impl Parser<I, Option<O>, E>
+where
+ F: Parser<I, O, E>,
+{
+ trace("opt", move |input: &mut I| {
+ let start = input.checkpoint();
+ match f.parse_next(input) {
+ Ok(o) => Ok(Some(o)),
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ Ok(None)
+ }
+ Err(e) => Err(e),
+ }
+ })
+}
+
+/// Calls the parser if the condition is met.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, IResult};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::cond;
+/// use winnow::ascii::alpha1;
+/// # fn main() {
+///
+/// fn parser(b: bool, i: &str) -> IResult<&str, Option<&str>> {
+/// cond(b, alpha1).parse_peek(i)
+/// }
+///
+/// assert_eq!(parser(true, "abcd;"), Ok((";", Some("abcd"))));
+/// assert_eq!(parser(false, "abcd;"), Ok(("abcd;", None)));
+/// assert_eq!(parser(true, "123;"), Err(ErrMode::Backtrack(InputError::new("123;", ErrorKind::Slice))));
+/// assert_eq!(parser(false, "123;"), Ok(("123;", None)));
+/// # }
+/// ```
+pub fn cond<I, O, E: ParserError<I>, F>(b: bool, mut f: F) -> impl Parser<I, Option<O>, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+{
+ trace("cond", move |input: &mut I| {
+ if b {
+ f.parse_next(input).map(Some)
+ } else {
+ Ok(None)
+ }
+ })
+}
+
+/// Tries to apply its parser without consuming the input.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, IResult};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::peek;
+/// use winnow::ascii::alpha1;
+/// # fn main() {
+///
+/// let mut parser = peek(alpha1);
+///
+/// assert_eq!(parser.parse_peek("abcd;"), Ok(("abcd;", "abcd")));
+/// assert_eq!(parser.parse_peek("123;"), Err(ErrMode::Backtrack(InputError::new("123;", ErrorKind::Slice))));
+/// # }
+/// ```
+#[doc(alias = "look_ahead")]
+#[doc(alias = "rewind")]
+pub fn peek<I: Stream, O, E: ParserError<I>, F>(mut f: F) -> impl Parser<I, O, E>
+where
+ F: Parser<I, O, E>,
+{
+ trace("peek", move |input: &mut I| {
+ let start = input.checkpoint();
+ let res = f.parse_next(input);
+ input.reset(start);
+ res
+ })
+}
+
+/// Match the end of the [`Stream`]
+///
+/// Otherwise, it will error.
+///
+/// # Example
+///
+/// ```rust
+/// # use std::str;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::combinator::eof;
+/// # use winnow::prelude::*;
+///
+/// let mut parser = eof;
+/// assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Eof))));
+/// assert_eq!(parser.parse_peek(""), Ok(("", "")));
+/// ```
+#[doc(alias = "end")]
+#[doc(alias = "eoi")]
+pub fn eof<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Slice, E>
+where
+ I: Stream,
+{
+ trace("eof", move |input: &mut I| {
+ if input.eof_offset() == 0 {
+ Ok(input.next_slice(0))
+ } else {
+ Err(ErrMode::from_error_kind(input, ErrorKind::Eof))
+ }
+ })
+ .parse_next(input)
+}
+
+/// Succeeds if the child parser returns an error.
+///
+/// **Note:** This does not advance the [`Stream`]
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, IResult};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::not;
+/// use winnow::ascii::alpha1;
+/// # fn main() {
+///
+/// let mut parser = not(alpha1);
+///
+/// assert_eq!(parser.parse_peek("123"), Ok(("123", ())));
+/// assert_eq!(parser.parse_peek("abcd"), Err(ErrMode::Backtrack(InputError::new("abcd", ErrorKind::Not))));
+/// # }
+/// ```
+pub fn not<I: Stream, O, E: ParserError<I>, F>(mut parser: F) -> impl Parser<I, (), E>
+where
+ F: Parser<I, O, E>,
+{
+ trace("not", move |input: &mut I| {
+ let start = input.checkpoint();
+ let res = parser.parse_next(input);
+ input.reset(start);
+ match res {
+ Ok(_) => Err(ErrMode::from_error_kind(input, ErrorKind::Not)),
+ Err(ErrMode::Backtrack(_)) => Ok(()),
+ Err(e) => Err(e),
+ }
+ })
+}
+
+/// Transforms an [`ErrMode::Backtrack`] (recoverable) to [`ErrMode::Cut`] (unrecoverable)
+///
+/// This commits the parse result, preventing alternative branch paths like with
+/// [`winnow::combinator::alt`][crate::combinator::alt].
+///
+/// See the [tutorial][crate::_tutorial::chapter_6] for more details.
+///
+/// # Example
+///
+/// Without `cut_err`:
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::token::one_of;
+/// # use winnow::ascii::digit1;
+/// # use winnow::combinator::rest;
+/// # use winnow::combinator::alt;
+/// # use winnow::combinator::preceded;
+/// # use winnow::prelude::*;
+/// # fn main() {
+///
+/// fn parser(input: &str) -> IResult<&str, &str> {
+/// alt((
+/// preceded(one_of(['+', '-']), digit1),
+/// rest
+/// )).parse_peek(input)
+/// }
+///
+/// assert_eq!(parser("+10 ab"), Ok((" ab", "10")));
+/// assert_eq!(parser("ab"), Ok(("", "ab")));
+/// assert_eq!(parser("+"), Ok(("", "+")));
+/// # }
+/// ```
+///
+/// With `cut_err`:
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::prelude::*;
+/// # use winnow::token::one_of;
+/// # use winnow::ascii::digit1;
+/// # use winnow::combinator::rest;
+/// # use winnow::combinator::alt;
+/// # use winnow::combinator::preceded;
+/// use winnow::combinator::cut_err;
+/// # fn main() {
+///
+/// fn parser(input: &str) -> IResult<&str, &str> {
+/// alt((
+/// preceded(one_of(['+', '-']), cut_err(digit1)),
+/// rest
+/// )).parse_peek(input)
+/// }
+///
+/// assert_eq!(parser("+10 ab"), Ok((" ab", "10")));
+/// assert_eq!(parser("ab"), Ok(("", "ab")));
+/// assert_eq!(parser("+"), Err(ErrMode::Cut(InputError::new("", ErrorKind::Slice ))));
+/// # }
+/// ```
+pub fn cut_err<I, O, E: ParserError<I>, F>(mut parser: F) -> impl Parser<I, O, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+{
+ trace("cut_err", move |input: &mut I| {
+ parser.parse_next(input).map_err(|e| e.cut())
+ })
+}
+
+/// Transforms an [`ErrMode::Cut`] (unrecoverable) to [`ErrMode::Backtrack`] (recoverable)
+///
+/// This attempts the parse, allowing other parsers to be tried on failure, like with
+/// [`winnow::combinator::alt`][crate::combinator::alt].
+pub fn backtrack_err<I, O, E: ParserError<I>, F>(mut parser: F) -> impl Parser<I, O, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+{
+ trace("backtrack_err", move |input: &mut I| {
+ parser.parse_next(input).map_err(|e| e.backtrack())
+ })
+}
+
+/// A placeholder for a not-yet-implemented [`Parser`]
+///
+/// This is analogous to the [`todo!`] macro and helps with prototyping.
+///
+/// # Panic
+///
+/// This will panic when parsing
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::combinator::todo;
+///
+/// fn parser(input: &mut &str) -> PResult<u64> {
+/// todo(input)
+/// }
+/// ```
+#[track_caller]
+pub fn todo<I, O, E>(input: &mut I) -> PResult<O, E>
+where
+ I: Stream,
+{
+ #![allow(clippy::todo)]
+ trace("todo", move |_input: &mut I| todo!("unimplemented parse")).parse_next(input)
+}
+
+/// Repeats the embedded parser, lazily returning the results
+///
+/// Call the iterator's [`ParserIterator::finish`] method to get the remaining input if successful,
+/// or the error value if we encountered an error.
+///
+/// On [`ErrMode::Backtrack`], iteration will stop. To instead chain an error up, see [`cut_err`].
+///
+/// # Example
+///
+/// ```rust
+/// use winnow::{combinator::iterator, IResult, token::tag, ascii::alpha1, combinator::terminated};
+/// use std::collections::HashMap;
+///
+/// let data = "abc|defg|hijkl|mnopqr|123";
+/// let mut it = iterator(data, terminated(alpha1, "|"));
+///
+/// let parsed = it.map(|v| (v, v.len())).collect::<HashMap<_,_>>();
+/// let res: IResult<_,_> = it.finish();
+///
+/// assert_eq!(parsed, [("abc", 3usize), ("defg", 4), ("hijkl", 5), ("mnopqr", 6)].iter().cloned().collect());
+/// assert_eq!(res, Ok(("123", ())));
+/// ```
+pub fn iterator<I, O, E, F>(input: I, parser: F) -> ParserIterator<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+ E: ParserError<I>,
+{
+ ParserIterator {
+ parser,
+ input,
+ state: Some(State::Running),
+ o: Default::default(),
+ }
+}
+
+/// Main structure associated to [`iterator`].
+pub struct ParserIterator<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ parser: F,
+ input: I,
+ state: Option<State<E>>,
+ o: core::marker::PhantomData<O>,
+}
+
+impl<F, I, O, E> ParserIterator<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ /// Returns the remaining input if parsing was successful, or the error if we encountered an error.
+ pub fn finish(mut self) -> PResult<(I, ()), E> {
+ match self.state.take().unwrap() {
+ State::Running | State::Done => Ok((self.input, ())),
+ State::Failure(e) => Err(ErrMode::Cut(e)),
+ State::Incomplete(i) => Err(ErrMode::Incomplete(i)),
+ }
+ }
+}
+
+impl<'a, F, I, O, E> core::iter::Iterator for &'a mut ParserIterator<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ type Item = O;
+
+ fn next(&mut self) -> Option<Self::Item> {
+ if let State::Running = self.state.take().unwrap() {
+ let start = self.input.checkpoint();
+
+ match self.parser.parse_next(&mut self.input) {
+ Ok(o) => {
+ self.state = Some(State::Running);
+ Some(o)
+ }
+ Err(ErrMode::Backtrack(_)) => {
+ self.input.reset(start);
+ self.state = Some(State::Done);
+ None
+ }
+ Err(ErrMode::Cut(e)) => {
+ self.state = Some(State::Failure(e));
+ None
+ }
+ Err(ErrMode::Incomplete(i)) => {
+ self.state = Some(State::Incomplete(i));
+ None
+ }
+ }
+ } else {
+ None
+ }
+ }
+}
+
+enum State<E> {
+ Running,
+ Done,
+ Failure(E),
+ Incomplete(Needed),
+}
+
+/// Succeed, consuming no input
+///
+/// For example, it can be used as the last alternative in `alt` to
+/// specify the default case.
+///
+/// Useful with:
+/// - [`Parser::value`]
+/// - [`Parser::default_value`]
+/// - [`Parser::map`]
+///
+/// **Note:** This never advances the [`Stream`]
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::alt;
+/// use winnow::combinator::empty;
+///
+/// fn sign(input: &str) -> IResult<&str, isize> {
+/// alt((
+/// '-'.value(-1),
+/// '+'.value(1),
+/// empty.value(1)
+/// )).parse_peek(input)
+/// }
+/// assert_eq!(sign("+10"), Ok(("10", 1)));
+/// assert_eq!(sign("-10"), Ok(("10", -1)));
+/// assert_eq!(sign("10"), Ok(("10", 1)));
+/// ```
+#[doc(alias = "value")]
+#[doc(alias = "success")]
+pub fn empty<I: Stream, E: ParserError<I>>(_input: &mut I) -> PResult<(), E> {
+ Ok(())
+}
+
+/// Deprecated, replaced with [`empty`] + [`Parser::value`]
+#[deprecated(since = "0.5.35", note = "Replaced with empty.value(...)`")]
+pub fn success<I: Stream, O: Clone, E: ParserError<I>>(val: O) -> impl Parser<I, O, E> {
+ trace("success", move |_input: &mut I| Ok(val.clone()))
+}
+
+/// A parser which always fails.
+///
+/// For example, it can be used as the last alternative in `alt` to
+/// control the error message given.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, IResult};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::fail;
+///
+/// let s = "string";
+/// assert_eq!(fail::<_, &str, _>.parse_peek(s), Err(ErrMode::Backtrack(InputError::new(s, ErrorKind::Fail))));
+/// ```
+#[doc(alias = "unexpected")]
+pub fn fail<I: Stream, O, E: ParserError<I>>(i: &mut I) -> PResult<O, E> {
+ trace("fail", |i: &mut I| {
+ Err(ErrMode::from_error_kind(i, ErrorKind::Fail))
+ })
+ .parse_next(i)
+}
diff --git a/crates/winnow/src/combinator/debug/internals.rs b/crates/winnow/src/combinator/debug/internals.rs
new file mode 100644
index 0000000..c38b11e
--- /dev/null
+++ b/crates/winnow/src/combinator/debug/internals.rs
@@ -0,0 +1,301 @@
+#![cfg(feature = "std")]
+
+use std::io::Write;
+
+use crate::error::ErrMode;
+use crate::stream::Stream;
+use crate::*;
+
+pub struct Trace<P, D, I, O, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ D: std::fmt::Display,
+{
+ parser: P,
+ name: D,
+ call_count: usize,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<P, D, I, O, E> Trace<P, D, I, O, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ D: std::fmt::Display,
+{
+ #[inline(always)]
+ pub fn new(parser: P, name: D) -> Self {
+ Self {
+ parser,
+ name,
+ call_count: 0,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<P, D, I, O, E> Parser<I, O, E> for Trace<P, D, I, O, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ D: std::fmt::Display,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ let depth = Depth::new();
+ let original = i.checkpoint();
+ start(*depth, &self.name, self.call_count, i);
+
+ let res = self.parser.parse_next(i);
+
+ let consumed = i.offset_from(&original);
+ let severity = Severity::with_result(&res);
+ end(*depth, &self.name, self.call_count, consumed, severity);
+ self.call_count += 1;
+
+ res
+ }
+}
+
+pub struct Depth {
+ depth: usize,
+ inc: bool,
+}
+
+impl Depth {
+ pub fn new() -> Self {
+ let depth = DEPTH.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
+ let inc = true;
+ Self { depth, inc }
+ }
+
+ pub fn existing() -> Self {
+ let depth = DEPTH.load(std::sync::atomic::Ordering::SeqCst);
+ let inc = false;
+ Self { depth, inc }
+ }
+}
+
+impl Drop for Depth {
+ fn drop(&mut self) {
+ if self.inc {
+ let _ = DEPTH.fetch_sub(1, std::sync::atomic::Ordering::SeqCst);
+ }
+ }
+}
+
+impl AsRef<usize> for Depth {
+ #[inline(always)]
+ fn as_ref(&self) -> &usize {
+ &self.depth
+ }
+}
+
+impl crate::lib::std::ops::Deref for Depth {
+ type Target = usize;
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.depth
+ }
+}
+
+static DEPTH: std::sync::atomic::AtomicUsize = std::sync::atomic::AtomicUsize::new(0);
+
+pub enum Severity {
+ Success,
+ Backtrack,
+ Cut,
+ Incomplete,
+}
+
+impl Severity {
+ pub fn with_result<T, E>(result: &Result<T, ErrMode<E>>) -> Self {
+ match result {
+ Ok(_) => Self::Success,
+ Err(ErrMode::Backtrack(_)) => Self::Backtrack,
+ Err(ErrMode::Cut(_)) => Self::Cut,
+ Err(ErrMode::Incomplete(_)) => Self::Incomplete,
+ }
+ }
+}
+
+pub fn start<I: Stream>(
+ depth: usize,
+ name: &dyn crate::lib::std::fmt::Display,
+ count: usize,
+ input: &I,
+) {
+ let gutter_style = anstyle::Style::new().bold();
+ let input_style = anstyle::Style::new().underline();
+ let eof_style = anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Cyan.into()));
+
+ let (call_width, input_width) = column_widths();
+
+ let count = if 0 < count {
+ format!(":{count}")
+ } else {
+ "".to_owned()
+ };
+ let call_column = format!("{:depth$}> {name}{count}", "");
+
+ // The debug version of `slice` might be wider, either due to rendering one byte as two nibbles or
+ // escaping in strings.
+ let mut debug_slice = format!("{:#?}", input.raw());
+ let (debug_slice, eof) = if let Some(debug_offset) = debug_slice
+ .char_indices()
+ .enumerate()
+ .find_map(|(pos, (offset, _))| (input_width <= pos).then_some(offset))
+ {
+ debug_slice.truncate(debug_offset);
+ let eof = "";
+ (debug_slice, eof)
+ } else {
+ let eof = if debug_slice.chars().count() < input_width {
+ "∅"
+ } else {
+ ""
+ };
+ (debug_slice, eof)
+ };
+
+ let writer = anstream::stderr();
+ let mut writer = writer.lock();
+ let _ = writeln!(
+ writer,
+ "{call_column:call_width$} {gutter_style}|{gutter_reset} {input_style}{debug_slice}{input_reset}{eof_style}{eof}{eof_reset}",
+ gutter_style=gutter_style.render(),
+ gutter_reset=gutter_style.render_reset(),
+ input_style=input_style.render(),
+ input_reset=input_style.render_reset(),
+ eof_style=eof_style.render(),
+ eof_reset=eof_style.render_reset(),
+ );
+}
+
+pub fn end(
+ depth: usize,
+ name: &dyn crate::lib::std::fmt::Display,
+ count: usize,
+ consumed: usize,
+ severity: Severity,
+) {
+ let gutter_style = anstyle::Style::new().bold();
+
+ let (call_width, _) = column_widths();
+
+ let count = if 0 < count {
+ format!(":{count}")
+ } else {
+ "".to_owned()
+ };
+ let call_column = format!("{:depth$}< {name}{count}", "");
+
+ let (status_style, status) = match severity {
+ Severity::Success => {
+ let style = anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Green.into()));
+ let status = format!("+{}", consumed);
+ (style, status)
+ }
+ Severity::Backtrack => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Yellow.into())),
+ "backtrack".to_owned(),
+ ),
+ Severity::Cut => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Red.into())),
+ "cut".to_owned(),
+ ),
+ Severity::Incomplete => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Red.into())),
+ "incomplete".to_owned(),
+ ),
+ };
+
+ let writer = anstream::stderr();
+ let mut writer = writer.lock();
+ let _ = writeln!(
+ writer,
+ "{status_style}{call_column:call_width$}{status_reset} {gutter_style}|{gutter_reset} {status_style}{status}{status_reset}",
+ gutter_style=gutter_style.render(),
+ gutter_reset=gutter_style.render_reset(),
+ status_style=status_style.render(),
+ status_reset=status_style.render_reset(),
+ );
+}
+
+pub fn result(depth: usize, name: &dyn crate::lib::std::fmt::Display, severity: Severity) {
+ let gutter_style = anstyle::Style::new().bold();
+
+ let (call_width, _) = column_widths();
+
+ let call_column = format!("{:depth$}| {name}", "");
+
+ let (status_style, status) = match severity {
+ Severity::Success => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Green.into())),
+ "",
+ ),
+ Severity::Backtrack => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Yellow.into())),
+ "backtrack",
+ ),
+ Severity::Cut => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Red.into())),
+ "cut",
+ ),
+ Severity::Incomplete => (
+ anstyle::Style::new().fg_color(Some(anstyle::AnsiColor::Red.into())),
+ "incomplete",
+ ),
+ };
+
+ let writer = anstream::stderr();
+ let mut writer = writer.lock();
+ let _ = writeln!(
+ writer,
+ "{status_style}{call_column:call_width$}{status_reset} {gutter_style}|{gutter_reset} {status_style}{status}{status_reset}",
+ gutter_style=gutter_style.render(),
+ gutter_reset=gutter_style.render_reset(),
+ status_style=status_style.render(),
+ status_reset=status_style.render_reset(),
+ );
+}
+
+fn column_widths() -> (usize, usize) {
+ let term_width = term_width();
+
+ let min_call_width = 40;
+ let min_input_width = 20;
+ let decor_width = 3;
+ let extra_width = term_width
+ .checked_sub(min_call_width + min_input_width + decor_width)
+ .unwrap_or_default();
+ let call_width = min_call_width + 2 * extra_width / 3;
+ let input_width = min_input_width + extra_width / 3;
+
+ (call_width, input_width)
+}
+
+fn term_width() -> usize {
+ columns_env().or_else(query_width).unwrap_or(80)
+}
+
+fn query_width() -> Option<usize> {
+ use is_terminal::IsTerminal;
+ if std::io::stderr().is_terminal() {
+ terminal_size::terminal_size().map(|(w, _h)| w.0.into())
+ } else {
+ None
+ }
+}
+
+fn columns_env() -> Option<usize> {
+ std::env::var("COLUMNS")
+ .ok()
+ .and_then(|c| c.parse::<usize>().ok())
+}
diff --git a/crates/winnow/src/combinator/debug/mod.rs b/crates/winnow/src/combinator/debug/mod.rs
new file mode 100644
index 0000000..ee4c293
--- /dev/null
+++ b/crates/winnow/src/combinator/debug/mod.rs
@@ -0,0 +1,91 @@
+#![cfg_attr(feature = "debug", allow(clippy::std_instead_of_core))]
+
+#[cfg(feature = "debug")]
+mod internals;
+
+use crate::error::ErrMode;
+use crate::stream::Stream;
+use crate::Parser;
+
+#[cfg(all(feature = "debug", not(feature = "std")))]
+compile_error!("`debug` requires `std`");
+
+/// Trace the execution of the parser
+///
+/// Note that [`Parser::context`] also provides high level trace information.
+///
+/// See [tutorial][crate::_tutorial::chapter_8] for more details.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::token::take_while;
+/// # use winnow::stream::AsChar;
+/// # use winnow::prelude::*;
+/// use winnow::combinator::trace;
+///
+/// fn short_alpha<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// trace("short_alpha",
+/// take_while(3..=6, AsChar::is_alpha)
+/// ).parse_next(s)
+/// }
+///
+/// assert_eq!(short_alpha.parse_peek(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"lengthy"), Ok((&b"y"[..], &b"length"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"latin"), Ok((&b""[..], &b"latin"[..])));
+/// assert_eq!(short_alpha.parse_peek(b"ed"), Err(ErrMode::Backtrack(InputError::new(&b"ed"[..], ErrorKind::Slice))));
+/// assert_eq!(short_alpha.parse_peek(b"12345"), Err(ErrMode::Backtrack(InputError::new(&b"12345"[..], ErrorKind::Slice))));
+/// ```
+#[cfg_attr(not(feature = "debug"), allow(unused_variables))]
+#[cfg_attr(not(feature = "debug"), allow(unused_mut))]
+#[cfg_attr(not(feature = "debug"), inline(always))]
+pub fn trace<I: Stream, O, E>(
+ name: impl crate::lib::std::fmt::Display,
+ parser: impl Parser<I, O, E>,
+) -> impl Parser<I, O, E> {
+ #[cfg(feature = "debug")]
+ {
+ internals::Trace::new(parser, name)
+ }
+ #[cfg(not(feature = "debug"))]
+ {
+ parser
+ }
+}
+
+#[cfg_attr(not(feature = "debug"), allow(unused_variables))]
+pub(crate) fn trace_result<T, E>(
+ name: impl crate::lib::std::fmt::Display,
+ res: &Result<T, ErrMode<E>>,
+) {
+ #[cfg(feature = "debug")]
+ {
+ let depth = internals::Depth::existing();
+ let severity = internals::Severity::with_result(res);
+ internals::result(*depth, &name, severity);
+ }
+}
+
+#[test]
+#[cfg(feature = "std")]
+#[cfg_attr(miri, ignore)]
+#[cfg(unix)]
+#[cfg(feature = "debug")]
+fn example() {
+ use term_transcript::{test::TestConfig, ShellOptions};
+
+ let path = snapbox::cmd::compile_example("string", ["--features=debug"]).unwrap();
+
+ let current_dir = path.parent().unwrap();
+ let cmd = path.file_name().unwrap();
+ // HACK: term_transcript doesn't allow non-UTF8 paths
+ let cmd = format!("./{}", cmd.to_string_lossy());
+
+ TestConfig::new(
+ ShellOptions::default()
+ .with_current_dir(current_dir)
+ .with_env("CLICOLOR_FORCE", "1"),
+ )
+ .test("assets/trace.svg", [cmd.as_str()]);
+}
diff --git a/crates/winnow/src/combinator/mod.rs b/crates/winnow/src/combinator/mod.rs
new file mode 100644
index 0000000..da5fa79
--- /dev/null
+++ b/crates/winnow/src/combinator/mod.rs
@@ -0,0 +1,176 @@
+//! # List of parsers and combinators
+//!
+//! **Note**: this list is meant to provide a nicer way to find a parser than reading through the documentation on docs.rs. Function combinators are organized in module so they are a bit easier to find.
+//!
+//! ## Basic elements
+//!
+//! Those are used to recognize the lowest level elements of your grammar, like, "here is a dot", or "here is an big endian integer".
+//!
+//! | combinator | usage | input | new input | output | comment |
+//! |---|---|---|---|---|---|
+//! | [`one_of`][crate::token::one_of] | `one_of(['a', 'b', 'c'])` | `"abc"` | `"bc"` | `Ok('a')` |Matches one of the provided characters (works with non ASCII characters too)|
+//! | [`none_of`][crate::token::none_of] | `none_of(['a', 'b', 'c'])` | `"xyab"` | `"yab"` | `Ok('x')` |Matches anything but the provided characters|
+//! | [`tag`][crate::token::tag] | `"hello"` | `"hello world"` | `" world"` | `Ok("hello")` |Recognizes a specific suite of characters or bytes (see also [`Caseless`][crate::ascii::Caseless])|
+//! | [`take`][crate::token::take] | `take(4)` | `"hello"` | `"o"` | `Ok("hell")` |Takes a specific number of bytes or characters|
+//! | [`take_while`][crate::token::take_while] | `take_while(0.., is_alphabetic)` | `"abc123"` | `"123"` | `Ok("abc")` |Returns the longest list of bytes for which the provided pattern matches.|
+//! | [`take_till0`][crate::token::take_till0] | `take_till0(is_alphabetic)` | `"123abc"` | `"abc"` | `Ok("123")` |Returns the longest list of bytes or characters until the provided pattern matches. `take_till1` does the same, but must return at least one character. This is the reverse behaviour from `take_while`: `take_till(f)` is equivalent to `take_while(0.., \|c\| !f(c))`|
+//! | [`take_until`][crate::token::take_until] | `take_until(0.., "world")` | `"Hello world"` | `"world"` | `Ok("Hello ")` |Returns the longest list of bytes or characters until the provided tag is found.|
+//!
+//! ## Choice combinators
+//!
+//! | combinator | usage | input | new input | output | comment |
+//! |---|---|---|---|---|---|
+//! | [`alt`] | `alt(("ab", "cd"))` | `"cdef"` | `"ef"` | `Ok("cd")` |Try a list of parsers and return the result of the first successful one|
+//! | [`dispatch`] | \- | \- | \- | \- | `match` for parsers |
+//! | [`permutation`] | `permutation(("ab", "cd", "12"))` | `"cd12abc"` | `"c"` | `Ok(("ab", "cd", "12"))` |Succeeds when all its child parser have succeeded, whatever the order|
+//!
+//! ## Sequence combinators
+//!
+//! | combinator | usage | input | new input | output | comment |
+//! |---|---|---|---|---|---|
+//! | [`(...)` (tuples)][crate::Parser] | `("ab", "XY", take(1))` | `"abXYZ!"` | `"!"` | `Ok(("ab", "XY", "Z"))` |Chains parsers and assemble the sub results in a tuple. You can use as many child parsers as you can put elements in a tuple|
+//! | [`seq!`] | `seq!(_: char('('), take(2), _: char(')'))` | `"(ab)cd"` | `"cd"` | `Ok("ab")` ||
+//! | [`delimited`] | `delimited(char('('), take(2), char(')'))` | `"(ab)cd"` | `"cd"` | `Ok("ab")` ||
+//! | [`preceded`] | `preceded("ab", "XY")` | `"abXYZ"` | `"Z"` | `Ok("XY")` ||
+//! | [`terminated`] | `terminated("ab", "XY")` | `"abXYZ"` | `"Z"` | `Ok("ab")` ||
+//! | [`separated_pair`] | `separated_pair("hello", char(','), "world")` | `"hello,world!"` | `"!"` | `Ok(("hello", "world"))` ||
+//!
+//! ## Applying a parser multiple times
+//!
+//! | combinator | usage | input | new input | output | comment |
+//! |---|---|---|---|---|---|
+//! | [`repeat`] | `repeat(1..=3, "ab")` | `"ababc"` | `"c"` | `Ok(vec!["ab", "ab"])` |Applies the parser between m and n times (n included) and returns the list of results in a Vec|
+//! | [`repeat_till`] | `repeat_till(0.., tag( "ab" ), tag( "ef" ))` | `"ababefg"` | `"g"` | `Ok((vec!["ab", "ab"], "ef"))` |Applies the first parser until the second applies. Returns a tuple containing the list of results from the first in a Vec and the result of the second|
+//! | [`separated`] | `separated(1..=3, "ab", ",")` | `"ab,ab,ab."` | `"."` | `Ok(vec!["ab", "ab", "ab"])` |Applies the parser and separator between m and n times (n included) and returns the list of results in a Vec|
+//! | [`fold_repeat`] | `fold_repeat(1..=2, be_u8, \|\| 0, \|acc, item\| acc + item)` | `[1, 2, 3]` | `[3]` | `Ok(3)` |Applies the parser between m and n times (n included) and folds the list of return value|
+//!
+//! ## Partial related
+//!
+//! - [`eof`]: Returns its input if it is at the end of input data
+//! - [`Parser::complete_err`]: Replaces an `Incomplete` returned by the child parser with an `Backtrack`
+//!
+//! ## Modifiers
+//!
+//! - [`cond`]: Conditional combinator. Wraps another parser and calls it if the condition is met
+//! - [`Parser::flat_map`]: method to map a new parser from the output of the first parser, then apply that parser over the rest of the input
+//! - [`Parser::value`]: method to replace the result of a parser
+//! - [`Parser::default_value`]: method to replace the result of a parser
+//! - [`Parser::void`]: method to discard the result of a parser
+//! - [`Parser::map`]: method to map a function on the result of a parser
+//! - [`Parser::and_then`]: Applies a second parser over the output of the first one
+//! - [`Parser::verify_map`]: Maps a function returning an `Option` on the output of a parser
+//! - [`Parser::try_map`]: Maps a function returning a `Result` on the output of a parser
+//! - [`Parser::parse_to`]: Apply [`std::str::FromStr`] to the output of the parser
+//! - [`not`]: Returns a result only if the embedded parser returns `Backtrack` or `Incomplete`. Does not consume the input
+//! - [`opt`]: Make the underlying parser optional
+//! - [`peek`]: Returns a result without consuming the input
+//! - [`Parser::recognize`]: If the child parser was successful, return the consumed input as the produced value
+//! - [`Parser::with_recognized`]: If the child parser was successful, return a tuple of the consumed input and the produced output.
+//! - [`Parser::span`]: If the child parser was successful, return the location of the consumed input as the produced value
+//! - [`Parser::with_span`]: If the child parser was successful, return a tuple of the location of the consumed input and the produced output.
+//! - [`Parser::verify`]: Returns the result of the child parser if it satisfies a verification function
+//!
+//! ## Error management and debugging
+//!
+//! - [`cut_err`]: Commit the parse result, disallowing alternative parsers from being attempted
+//! - [`backtrack_err`]: Attempts a parse, allowing alternative parsers to be attempted despite
+//! use of `cut_err`
+//! - [`Parser::context`]: Add context to the error if the parser fails
+//! - [`trace`]: Print the parse state with the `debug` feature flag
+//! - [`todo()`]: Placeholder parser
+//!
+//! ## Remaining combinators
+//!
+//! - [`success`]: Returns a value without consuming any input, always succeeds
+//! - [`fail`]: Inversion of `success`. Always fails.
+//! - [`Parser::by_ref`]: Allow moving `&mut impl Parser` into other parsers
+//!
+//! ## Text parsing
+//!
+//! - [`any`][crate::token::any]: Matches one token
+//! - [`tab`][crate::ascii::tab]: Matches a tab character `\t`
+//! - [`crlf`][crate::ascii::crlf]: Recognizes the string `\r\n`
+//! - [`line_ending`][crate::ascii::line_ending]: Recognizes an end of line (both `\n` and `\r\n`)
+//! - [`newline`][crate::ascii::newline]: Matches a newline character `\n`
+//! - [`till_line_ending`][crate::ascii::till_line_ending]: Recognizes a string of any char except `\r` or `\n`
+//! - [`rest`]: Return the remaining input
+//!
+//! - [`alpha0`][crate::ascii::alpha0]: Recognizes zero or more lowercase and uppercase alphabetic characters: `[a-zA-Z]`. [`alpha1`][crate::ascii::alpha1] does the same but returns at least one character
+//! - [`alphanumeric0`][crate::ascii::alphanumeric0]: Recognizes zero or more numerical and alphabetic characters: `[0-9a-zA-Z]`. [`alphanumeric1`][crate::ascii::alphanumeric1] does the same but returns at least one character
+//! - [`space0`][crate::ascii::space0]: Recognizes zero or more spaces and tabs. [`space1`][crate::ascii::space1] does the same but returns at least one character
+//! - [`multispace0`][crate::ascii::multispace0]: Recognizes zero or more spaces, tabs, carriage returns and line feeds. [`multispace1`][crate::ascii::multispace1] does the same but returns at least one character
+//! - [`digit0`][crate::ascii::digit0]: Recognizes zero or more numerical characters: `[0-9]`. [`digit1`][crate::ascii::digit1] does the same but returns at least one character
+//! - [`hex_digit0`][crate::ascii::hex_digit0]: Recognizes zero or more hexadecimal numerical characters: `[0-9A-Fa-f]`. [`hex_digit1`][crate::ascii::hex_digit1] does the same but returns at least one character
+//! - [`oct_digit0`][crate::ascii::oct_digit0]: Recognizes zero or more octal characters: `[0-7]`. [`oct_digit1`][crate::ascii::oct_digit1] does the same but returns at least one character
+//!
+//! - [`float`][crate::ascii::float]: Parse a floating point number in a byte string
+//! - [`dec_int`][crate::ascii::dec_int]: Decode a variable-width, decimal signed integer
+//! - [`dec_uint`][crate::ascii::dec_uint]: Decode a variable-width, decimal unsigned integer
+//! - [`hex_uint`][crate::ascii::hex_uint]: Decode a variable-width, hexadecimal integer
+//!
+//! - [`escaped`][crate::ascii::escaped]: Matches a byte string with escaped characters
+//! - [`escaped_transform`][crate::ascii::escaped_transform]: Matches a byte string with escaped characters, and returns a new string with the escaped characters replaced
+//!
+//! ### Character test functions
+//!
+//! Use these functions with a combinator like `take_while`:
+//!
+//! - [`AsChar::is_alpha`][crate::stream::AsChar::is_alpha]: Tests if byte is ASCII alphabetic: `[A-Za-z]`
+//! - [`AsChar::is_alphanum`][crate::stream::AsChar::is_alphanum]: Tests if byte is ASCII alphanumeric: `[A-Za-z0-9]`
+//! - [`AsChar::is_dec_digit`][crate::stream::AsChar::is_dec_digit]: Tests if byte is ASCII digit: `[0-9]`
+//! - [`AsChar::is_hex_digit`][crate::stream::AsChar::is_hex_digit]: Tests if byte is ASCII hex digit: `[0-9A-Fa-f]`
+//! - [`AsChar::is_oct_digit`][crate::stream::AsChar::is_oct_digit]: Tests if byte is ASCII octal digit: `[0-7]`
+//! - [`AsChar::is_space`][crate::stream::AsChar::is_space]: Tests if byte is ASCII space or tab: `[ \t]`
+//! - [`AsChar::is_newline`][crate::stream::AsChar::is_newline]: Tests if byte is ASCII newline: `[\n]`
+//!
+//! ## Binary format parsing
+//!
+//! - [`length_count`][crate::binary::length_count] Gets a number from the first parser, then applies the second parser that many times
+//! - [`length_data`][crate::binary::length_data]: Gets a number from the first parser, then takes a subslice of the input of that size, and returns that subslice
+//! - [`length_value`][crate::binary::length_value]: Gets a number from the first parser, takes a subslice of the input of that size, then applies the second parser on that subslice. If the second parser returns `Incomplete`, `length_value` will return an error
+//!
+//! ### Integers
+//!
+//! Parsing integers from binary formats can be done in two ways: With parser functions, or combinators with configurable endianness.
+//!
+//! - **configurable endianness:** [`i16`][crate::binary::i16], [`i32`][crate::binary::i32],
+//! [`i64`][crate::binary::i64], [`u16`][crate::binary::u16], [`u32`][crate::binary::u32],
+//! [`u64`][crate::binary::u64] are combinators that take as argument a
+//! [`winnow::binary::Endianness`][crate::binary::Endianness], like this: `i16(endianness)`. If the
+//! parameter is `winnow::binary::Endianness::Big`, parse a big endian `i16` integer, otherwise a
+//! little endian `i16` integer.
+//! - **fixed endianness**: The functions are prefixed by `be_` for big endian numbers, and by `le_` for little endian numbers, and the suffix is the type they parse to. As an example, `be_u32` parses a big endian unsigned integer stored in 32 bits.
+//! - [`be_f32`][crate::binary::be_f32], [`be_f64`][crate::binary::be_f64]: Big endian floating point numbers
+//! - [`le_f32`][crate::binary::le_f32], [`le_f64`][crate::binary::le_f64]: Little endian floating point numbers
+//! - [`be_i8`][crate::binary::be_i8], [`be_i16`][crate::binary::be_i16], [`be_i24`][crate::binary::be_i24], [`be_i32`][crate::binary::be_i32], [`be_i64`][crate::binary::be_i64], [`be_i128`][crate::binary::be_i128]: Big endian signed integers
+//! - [`be_u8`][crate::binary::be_u8], [`be_u16`][crate::binary::be_u16], [`be_u24`][crate::binary::be_u24], [`be_u32`][crate::binary::be_u32], [`be_u64`][crate::binary::be_u64], [`be_u128`][crate::binary::be_u128]: Big endian unsigned integers
+//! - [`le_i8`][crate::binary::le_i8], [`le_i16`][crate::binary::le_i16], [`le_i24`][crate::binary::le_i24], [`le_i32`][crate::binary::le_i32], [`le_i64`][crate::binary::le_i64], [`le_i128`][crate::binary::le_i128]: Little endian signed integers
+//! - [`le_u8`][crate::binary::le_u8], [`le_u16`][crate::binary::le_u16], [`le_u24`][crate::binary::le_u24], [`le_u32`][crate::binary::le_u32], [`le_u64`][crate::binary::le_u64], [`le_u128`][crate::binary::le_u128]: Little endian unsigned integers
+//!
+//! ### Bit stream parsing
+//!
+//! - [`bits`][crate::binary::bits::bits]: Transforms the current input type (byte slice `&[u8]`) to a bit stream on which bit specific parsers and more general combinators can be applied
+//! - [`bytes`][crate::binary::bits::bytes]: Transforms its bits stream input back into a byte slice for the underlying parser
+//! - [`take`][crate::binary::bits::take]: Take a set number of bits
+//! - [`tag`][crate::binary::bits::tag]: Check if a set number of bits matches a pattern
+//! - [`bool`][crate::binary::bits::bool]: Match any one bit
+
+mod branch;
+mod core;
+mod debug;
+mod multi;
+mod parser;
+mod sequence;
+
+#[cfg(test)]
+mod tests;
+
+pub use self::branch::*;
+pub use self::core::*;
+pub use self::debug::*;
+pub use self::multi::*;
+pub use self::parser::*;
+pub use self::sequence::*;
+
+#[allow(unused_imports)]
+use crate::Parser;
diff --git a/crates/winnow/src/combinator/multi.rs b/crates/winnow/src/combinator/multi.rs
new file mode 100644
index 0000000..f76d635
--- /dev/null
+++ b/crates/winnow/src/combinator/multi.rs
@@ -0,0 +1,1408 @@
+//! Combinators applying their child parser multiple times
+
+use crate::combinator::trace;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::ParserError;
+use crate::stream::Accumulate;
+use crate::stream::Range;
+use crate::stream::Stream;
+use crate::PResult;
+use crate::Parser;
+
+/// [`Accumulate`] the output of a parser into a container, like `Vec`
+///
+/// This stops before `n` when the parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Arguments
+/// * `m` The minimum number of iterations.
+/// * `n` The maximum number of iterations.
+/// * `f` The parser to apply.
+///
+/// To recognize a series of tokens, [`Accumulate`] into a `()` and then [`Parser::recognize`].
+///
+/// **Warning:** If the parser passed to `repeat` accepts empty inputs
+/// (like `alpha0` or `digit0`), `repeat` will return an error,
+/// to prevent going into an infinite loop.
+///
+/// # Example
+///
+/// Zero or more repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::repeat;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// repeat(0.., "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+/// assert_eq!(parser("123123"), Ok(("123123", vec![])));
+/// assert_eq!(parser(""), Ok(("", vec![])));
+/// # }
+/// ```
+///
+/// One or more repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::repeat;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// repeat(1.., "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+/// assert_eq!(parser("123123"), Err(ErrMode::Backtrack(InputError::new("123123", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// # }
+/// ```
+///
+/// Fixed number of repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::repeat;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// repeat(2, "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// assert_eq!(parser("123123"), Err(ErrMode::Backtrack(InputError::new("123123", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("abcabcabc"), Ok(("abc", vec!["abc", "abc"])));
+/// # }
+/// ```
+///
+/// Arbitrary repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::repeat;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// repeat(0..=2, "abc").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+/// assert_eq!(parser("123123"), Ok(("123123", vec![])));
+/// assert_eq!(parser(""), Ok(("", vec![])));
+/// assert_eq!(parser("abcabcabc"), Ok(("abc", vec!["abc", "abc"])));
+/// # }
+/// ```
+#[doc(alias = "many0")]
+#[doc(alias = "count")]
+#[doc(alias = "many0_count")]
+#[doc(alias = "many1")]
+#[doc(alias = "many1_count")]
+#[doc(alias = "many_m_n")]
+#[doc(alias = "repeated")]
+#[doc(alias = "skip_many")]
+#[doc(alias = "skip_many1")]
+#[inline(always)]
+pub fn repeat<I, O, C, E, P>(range: impl Into<Range>, parser: P) -> Repeat<P, I, O, C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ Repeat {
+ range: range.into(),
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ c: Default::default(),
+ e: Default::default(),
+ }
+}
+
+/// Implementation of [`repeat`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Repeat<P, I, O, C, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ C: Accumulate<O>,
+ E: ParserError<I>,
+{
+ range: Range,
+ parser: P,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ c: core::marker::PhantomData<C>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<P, I, O, E> Repeat<P, I, O, (), E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ E: ParserError<I>,
+{
+ /// Repeats the embedded parser, calling `g` to gather the results
+ ///
+ /// This stops before `n` when the parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+ /// [`cut_err`][crate::combinator::cut_err].
+ ///
+ /// # Arguments
+ /// * `init` A function returning the initial value.
+ /// * `g` The function that combines a result of `f` with
+ /// the current accumulator.
+ ///
+ /// **Warning:** If the parser passed to `fold` accepts empty inputs
+ /// (like `alpha0` or `digit0`), `fold_repeat` will return an error,
+ /// to prevent going into an infinite loop.
+ ///
+ /// # Example
+ ///
+ /// Zero or more repetitions:
+ /// ```rust
+ /// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+ /// # use winnow::prelude::*;
+ /// use winnow::combinator::repeat;
+ /// use winnow::token::tag;
+ ///
+ /// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+ /// repeat(
+ /// 0..,
+ /// "abc"
+ /// ).fold(
+ /// Vec::new,
+ /// |mut acc: Vec<_>, item| {
+ /// acc.push(item);
+ /// acc
+ /// }
+ /// ).parse_peek(s)
+ /// }
+ ///
+ /// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+ /// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+ /// assert_eq!(parser("123123"), Ok(("123123", vec![])));
+ /// assert_eq!(parser(""), Ok(("", vec![])));
+ /// ```
+ ///
+ /// One or more repetitions:
+ /// ```rust
+ /// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+ /// # use winnow::prelude::*;
+ /// use winnow::combinator::repeat;
+ /// use winnow::token::tag;
+ ///
+ /// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+ /// repeat(
+ /// 1..,
+ /// "abc",
+ /// ).fold(
+ /// Vec::new,
+ /// |mut acc: Vec<_>, item| {
+ /// acc.push(item);
+ /// acc
+ /// }
+ /// ).parse_peek(s)
+ /// }
+ ///
+ /// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+ /// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+ /// assert_eq!(parser("123123"), Err(ErrMode::Backtrack(InputError::new("123123", ErrorKind::Many))));
+ /// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Many))));
+ /// ```
+ ///
+ /// Arbitrary number of repetitions:
+ /// ```rust
+ /// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+ /// # use winnow::prelude::*;
+ /// use winnow::combinator::repeat;
+ /// use winnow::token::tag;
+ ///
+ /// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+ /// repeat(
+ /// 0..=2,
+ /// "abc",
+ /// ).fold(
+ /// Vec::new,
+ /// |mut acc: Vec<_>, item| {
+ /// acc.push(item);
+ /// acc
+ /// }
+ /// ).parse_peek(s)
+ /// }
+ ///
+ /// assert_eq!(parser("abcabc"), Ok(("", vec!["abc", "abc"])));
+ /// assert_eq!(parser("abc123"), Ok(("123", vec!["abc"])));
+ /// assert_eq!(parser("123123"), Ok(("123123", vec![])));
+ /// assert_eq!(parser(""), Ok(("", vec![])));
+ /// assert_eq!(parser("abcabcabc"), Ok(("abc", vec!["abc", "abc"])));
+ /// ```
+ #[doc(alias = "fold_many0")]
+ #[doc(alias = "fold_many1")]
+ #[doc(alias = "fold_many_m_n")]
+ #[doc(alias = "fold_repeat")]
+ #[inline(always)]
+ pub fn fold<H, G, R>(mut self, mut init: H, mut g: G) -> impl Parser<I, R, E>
+ where
+ G: FnMut(R, O) -> R,
+ H: FnMut() -> R,
+ {
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = self.range;
+ trace("repeat_fold", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => fold_repeat0_(&mut self.parser, &mut init, &mut g, i),
+ (1, None) => fold_repeat1_(&mut self.parser, &mut init, &mut g, i),
+ (start, end) => fold_repeat_m_n_(
+ start,
+ end.unwrap_or(usize::MAX),
+ &mut self.parser,
+ &mut init,
+ &mut g,
+ i,
+ ),
+ }
+ })
+ }
+}
+
+impl<P, I, O, C, E> Parser<I, C, E> for Repeat<P, I, O, C, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ C: Accumulate<O>,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<C, E> {
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = self.range;
+ trace("repeat", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => repeat0_(&mut self.parser, i),
+ (1, None) => repeat1_(&mut self.parser, i),
+ (start, end) if Some(start) == end => repeat_n_(start, &mut self.parser, i),
+ (start, end) => repeat_m_n_(start, end.unwrap_or(usize::MAX), &mut self.parser, i),
+ }
+ })
+ .parse_next(i)
+ }
+}
+
+fn repeat0_<I, O, C, E, F>(f: &mut F, i: &mut I) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ let mut acc = C::initial(None);
+ loop {
+ let start = i.checkpoint();
+ let len = i.eof_offset();
+ match f.parse_next(i) {
+ Err(ErrMode::Backtrack(_)) => {
+ i.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if i.eof_offset() == len {
+ return Err(ErrMode::assert(i, "`repeat` parsers must always consume"));
+ }
+
+ acc.accumulate(o);
+ }
+ }
+ }
+}
+
+fn repeat1_<I, O, C, E, F>(f: &mut F, i: &mut I) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ match f.parse_next(i) {
+ Err(e) => Err(e.append(i, ErrorKind::Many)),
+ Ok(o) => {
+ let mut acc = C::initial(None);
+ acc.accumulate(o);
+
+ loop {
+ let start = i.checkpoint();
+ let len = i.eof_offset();
+ match f.parse_next(i) {
+ Err(ErrMode::Backtrack(_)) => {
+ i.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if i.eof_offset() == len {
+ return Err(ErrMode::assert(i, "`repeat` parsers must always consume"));
+ }
+
+ acc.accumulate(o);
+ }
+ }
+ }
+ }
+ }
+}
+
+fn repeat_n_<I, O, C, E, F>(count: usize, f: &mut F, i: &mut I) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ let mut res = C::initial(Some(count));
+
+ for _ in 0..count {
+ match f.parse_next(i) {
+ Ok(o) => {
+ res.accumulate(o);
+ }
+ Err(e) => {
+ return Err(e.append(i, ErrorKind::Many));
+ }
+ }
+ }
+
+ Ok(res)
+}
+
+fn repeat_m_n_<I, O, C, E, F>(min: usize, max: usize, parse: &mut F, input: &mut I) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ if min > max {
+ return Err(ErrMode::Cut(E::from_error_kind(input, ErrorKind::Many)));
+ }
+
+ let mut res = C::initial(Some(min));
+ for count in 0..max {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match parse.parse_next(input) {
+ Ok(value) => {
+ // infinite loop check: the parser must always consume
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`repeat` parsers must always consume",
+ ));
+ }
+
+ res.accumulate(value);
+ }
+ Err(ErrMode::Backtrack(e)) => {
+ if count < min {
+ return Err(ErrMode::Backtrack(e.append(input, ErrorKind::Many)));
+ } else {
+ input.reset(start);
+ return Ok(res);
+ }
+ }
+ Err(e) => {
+ return Err(e);
+ }
+ }
+ }
+
+ Ok(res)
+}
+
+/// [`Accumulate`] the output of parser `f` into a container, like `Vec`, until the parser `g`
+/// produces a result.
+///
+/// Returns a tuple of the results of `f` in a `Vec` and the result of `g`.
+///
+/// `f` keeps going so long as `g` produces [`ErrMode::Backtrack`]. To instead chain an error up, see [`cut_err`][crate::combinator::cut_err].
+///
+/// To recognize a series of tokens, [`Accumulate`] into a `()` and then [`Parser::recognize`].
+///
+/// # Example
+///
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::repeat_till;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, (Vec<&str>, &str)> {
+/// repeat_till(0.., "abc", "end").parse_peek(s)
+/// };
+///
+/// assert_eq!(parser("abcabcend"), Ok(("", (vec!["abc", "abc"], "end"))));
+/// assert_eq!(parser("abc123end"), Err(ErrMode::Backtrack(InputError::new("123end", ErrorKind::Tag))));
+/// assert_eq!(parser("123123end"), Err(ErrMode::Backtrack(InputError::new("123123end", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("abcendefg"), Ok(("efg", (vec!["abc"], "end"))));
+/// # }
+/// ```
+#[doc(alias = "many_till0")]
+pub fn repeat_till<I, O, C, P, E, F, G>(
+ range: impl Into<Range>,
+ mut f: F,
+ mut g: G,
+) -> impl Parser<I, (C, P), E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ G: Parser<I, P, E>,
+ E: ParserError<I>,
+{
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = range.into();
+ trace("repeat_till", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => repeat_till0_(&mut f, &mut g, i),
+ (start, end) => repeat_till_m_n_(start, end.unwrap_or(usize::MAX), &mut f, &mut g, i),
+ }
+ })
+}
+
+/// Deprecated, replaced with [`repeat_till`]
+#[deprecated(since = "0.5.35", note = "Replaced with `repeat_till`")]
+#[inline(always)]
+pub fn repeat_till0<I, O, C, P, E, F, G>(f: F, g: G) -> impl Parser<I, (C, P), E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ G: Parser<I, P, E>,
+ E: ParserError<I>,
+{
+ repeat_till(0.., f, g)
+}
+
+fn repeat_till0_<I, O, C, P, E, F, G>(f: &mut F, g: &mut G, i: &mut I) -> PResult<(C, P), E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ G: Parser<I, P, E>,
+ E: ParserError<I>,
+{
+ let mut res = C::initial(None);
+ loop {
+ let start = i.checkpoint();
+ let len = i.eof_offset();
+ match g.parse_next(i) {
+ Ok(o) => return Ok((res, o)),
+ Err(ErrMode::Backtrack(_)) => {
+ i.reset(start);
+ match f.parse_next(i) {
+ Err(e) => return Err(e.append(i, ErrorKind::Many)),
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if i.eof_offset() == len {
+ return Err(ErrMode::assert(i, "`repeat` parsers must always consume"));
+ }
+
+ res.accumulate(o);
+ }
+ }
+ }
+ Err(e) => return Err(e),
+ }
+ }
+}
+
+fn repeat_till_m_n_<I, O, C, P, E, F, G>(
+ min: usize,
+ max: usize,
+ f: &mut F,
+ g: &mut G,
+ i: &mut I,
+) -> PResult<(C, P), E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ F: Parser<I, O, E>,
+ G: Parser<I, P, E>,
+ E: ParserError<I>,
+{
+ if min > max {
+ return Err(ErrMode::Cut(E::from_error_kind(i, ErrorKind::Many)));
+ }
+
+ let mut res = C::initial(Some(min));
+ for _ in 0..min {
+ match f.parse_next(i) {
+ Ok(o) => {
+ res.accumulate(o);
+ }
+ Err(e) => {
+ return Err(e.append(i, ErrorKind::Many));
+ }
+ }
+ }
+ for count in min..=max {
+ let start = i.checkpoint();
+ let len = i.eof_offset();
+ match g.parse_next(i) {
+ Ok(o) => return Ok((res, o)),
+ Err(ErrMode::Backtrack(err)) => {
+ if count == max {
+ return Err(ErrMode::Backtrack(err));
+ }
+ i.reset(start);
+ match f.parse_next(i) {
+ Err(e) => {
+ return Err(e.append(i, ErrorKind::Many));
+ }
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if i.eof_offset() == len {
+ return Err(ErrMode::assert(i, "`repeat` parsers must always consume"));
+ }
+
+ res.accumulate(o);
+ }
+ }
+ }
+ Err(e) => return Err(e),
+ }
+ }
+ unreachable!()
+}
+
+/// [`Accumulate`] the output of a parser, interleaved with `sep`
+///
+/// This stops when either parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Arguments
+/// * `range` The minimum and maximum number of iterations.
+/// * `parser` The parser that parses the elements of the list.
+/// * `sep` The parser that parses the separator between list elements.
+///
+/// **Warning:** If the separator parser accepts empty inputs
+/// (like `alpha0` or `digit0`), `separated` will return an error,
+/// to prevent going into an infinite loop.
+///
+/// # Example
+///
+/// Zero or more repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated(0.., "abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("", vec!["abc", "abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Ok(("123abc", vec!["abc"])));
+/// assert_eq!(parser("abc|def"), Ok(("|def", vec!["abc"])));
+/// assert_eq!(parser(""), Ok(("", vec![])));
+/// assert_eq!(parser("def|abc"), Ok(("def|abc", vec![])));
+/// # }
+/// ```
+///
+/// One or more repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated(1.., "abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("", vec!["abc", "abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Ok(("123abc", vec!["abc"])));
+/// assert_eq!(parser("abc|def"), Ok(("|def", vec!["abc"])));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("def|abc"), Err(ErrMode::Backtrack(InputError::new("def|abc", ErrorKind::Tag))));
+/// # }
+/// ```
+///
+/// Fixed number of repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated(2, "abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("|abc", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Err(ErrMode::Backtrack(InputError::new("123abc", ErrorKind::Tag))));
+/// assert_eq!(parser("abc|def"), Err(ErrMode::Backtrack(InputError::new("def", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("def|abc"), Err(ErrMode::Backtrack(InputError::new("def|abc", ErrorKind::Tag))));
+/// # }
+/// ```
+///
+/// Arbitrary repetitions:
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated(0..=2, "abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("|abc", vec!["abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Ok(("123abc", vec!["abc"])));
+/// assert_eq!(parser("abc|def"), Ok(("|def", vec!["abc"])));
+/// assert_eq!(parser(""), Ok(("", vec![])));
+/// assert_eq!(parser("def|abc"), Ok(("def|abc", vec![])));
+/// # }
+/// ```
+#[doc(alias = "sep_by")]
+#[doc(alias = "sep_by1")]
+#[doc(alias = "separated_list0")]
+#[doc(alias = "separated_list1")]
+#[doc(alias = "separated_m_n")]
+#[inline(always)]
+pub fn separated<I, O, C, O2, E, P, S>(
+ range: impl Into<Range>,
+ mut parser: P,
+ mut separator: S,
+) -> impl Parser<I, C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = range.into();
+ trace("separated", move |input: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => separated0_(&mut parser, &mut separator, input),
+ (1, None) => separated1_(&mut parser, &mut separator, input),
+ (start, end) if Some(start) == end => {
+ separated_n_(start, &mut parser, &mut separator, input)
+ }
+ (start, end) => separated_m_n_(
+ start,
+ end.unwrap_or(usize::MAX),
+ &mut parser,
+ &mut separator,
+ input,
+ ),
+ }
+ })
+}
+
+/// [`Accumulate`] the output of a parser, interleaved with `sep`
+///
+/// This stops when either parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Arguments
+/// * `parser` Parses the elements of the list.
+/// * `sep` Parses the separator between list elements.
+///
+/// # Example
+///
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated0;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated0("abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("", vec!["abc", "abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Ok(("123abc", vec!["abc"])));
+/// assert_eq!(parser("abc|def"), Ok(("|def", vec!["abc"])));
+/// assert_eq!(parser(""), Ok(("", vec![])));
+/// assert_eq!(parser("def|abc"), Ok(("def|abc", vec![])));
+/// # }
+/// ```
+#[doc(alias = "sep_by")]
+#[doc(alias = "separated_list0")]
+#[deprecated(since = "0.5.19", note = "Replaced with `combinator::separated`")]
+pub fn separated0<I, O, C, O2, E, P, S>(mut parser: P, mut sep: S) -> impl Parser<I, C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ trace("separated0", move |i: &mut I| {
+ separated0_(&mut parser, &mut sep, i)
+ })
+}
+
+fn separated0_<I, O, C, O2, E, P, S>(
+ parser: &mut P,
+ separator: &mut S,
+ input: &mut I,
+) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ let mut acc = C::initial(None);
+
+ let start = input.checkpoint();
+ match parser.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+
+ loop {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match separator.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(_) => {
+ // infinite loop check
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`separated` separator parser must always consume",
+ ));
+ }
+
+ match parser.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+ }
+ }
+ }
+}
+
+/// [`Accumulate`] the output of a parser, interleaved with `sep`
+///
+/// Fails if the element parser does not produce at least one element.$
+///
+/// This stops when either parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Arguments
+/// * `sep` Parses the separator between list elements.
+/// * `f` Parses the elements of the list.
+///
+/// # Example
+///
+/// ```rust
+/// # #[cfg(feature = "std")] {
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated1;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, Vec<&str>> {
+/// separated1("abc", "|").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("abc|abc|abc"), Ok(("", vec!["abc", "abc", "abc"])));
+/// assert_eq!(parser("abc123abc"), Ok(("123abc", vec!["abc"])));
+/// assert_eq!(parser("abc|def"), Ok(("|def", vec!["abc"])));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("def|abc"), Err(ErrMode::Backtrack(InputError::new("def|abc", ErrorKind::Tag))));
+/// # }
+/// ```
+#[doc(alias = "sep_by1")]
+#[doc(alias = "separated_list1")]
+#[deprecated(since = "0.5.19", note = "Replaced with `combinator::separated`")]
+pub fn separated1<I, O, C, O2, E, P, S>(mut parser: P, mut sep: S) -> impl Parser<I, C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ trace("separated1", move |i: &mut I| {
+ separated1_(&mut parser, &mut sep, i)
+ })
+}
+
+fn separated1_<I, O, C, O2, E, P, S>(
+ parser: &mut P,
+ separator: &mut S,
+ input: &mut I,
+) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ let mut acc = C::initial(None);
+
+ // Parse the first element
+ match parser.parse_next(input) {
+ Err(e) => return Err(e),
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+
+ loop {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match separator.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(_) => {
+ // infinite loop check
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`separated` separator parser must always consume",
+ ));
+ }
+
+ match parser.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(acc);
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+ }
+ }
+ }
+}
+
+fn separated_n_<I, O, C, O2, E, P, S>(
+ count: usize,
+ parser: &mut P,
+ separator: &mut S,
+ input: &mut I,
+) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ let mut acc = C::initial(Some(count));
+
+ if count == 0 {
+ return Ok(acc);
+ }
+
+ match parser.parse_next(input) {
+ Err(e) => {
+ return Err(e.append(input, ErrorKind::Many));
+ }
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+
+ for _ in 1..count {
+ let len = input.eof_offset();
+ match separator.parse_next(input) {
+ Err(e) => {
+ return Err(e.append(input, ErrorKind::Many));
+ }
+ Ok(_) => {
+ // infinite loop check
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`separated` separator parser must always consume",
+ ));
+ }
+
+ match parser.parse_next(input) {
+ Err(e) => {
+ return Err(e.append(input, ErrorKind::Many));
+ }
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+ }
+ }
+ }
+
+ Ok(acc)
+}
+
+fn separated_m_n_<I, O, C, O2, E, P, S>(
+ min: usize,
+ max: usize,
+ parser: &mut P,
+ separator: &mut S,
+ input: &mut I,
+) -> PResult<C, E>
+where
+ I: Stream,
+ C: Accumulate<O>,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+{
+ if min > max {
+ return Err(ErrMode::Cut(E::from_error_kind(input, ErrorKind::Many)));
+ }
+
+ let mut acc = C::initial(Some(min));
+
+ let start = input.checkpoint();
+ match parser.parse_next(input) {
+ Err(ErrMode::Backtrack(e)) => {
+ if min == 0 {
+ input.reset(start);
+ return Ok(acc);
+ } else {
+ return Err(ErrMode::Backtrack(e.append(input, ErrorKind::Many)));
+ }
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+
+ for index in 1..max {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match separator.parse_next(input) {
+ Err(ErrMode::Backtrack(e)) => {
+ if index < min {
+ return Err(ErrMode::Backtrack(e.append(input, ErrorKind::Many)));
+ } else {
+ input.reset(start);
+ return Ok(acc);
+ }
+ }
+ Err(e) => {
+ return Err(e);
+ }
+ Ok(_) => {
+ // infinite loop check
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`separated` separator parser must always consume",
+ ));
+ }
+
+ match parser.parse_next(input) {
+ Err(ErrMode::Backtrack(e)) => {
+ if index < min {
+ return Err(ErrMode::Backtrack(e.append(input, ErrorKind::Many)));
+ } else {
+ input.reset(start);
+ return Ok(acc);
+ }
+ }
+ Err(e) => {
+ return Err(e);
+ }
+ Ok(o) => {
+ acc.accumulate(o);
+ }
+ }
+ }
+ }
+ }
+
+ Ok(acc)
+}
+
+/// Alternates between two parsers, merging the results (left associative)
+///
+/// This stops when either parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated_foldl1;
+/// use winnow::ascii::dec_int;
+///
+/// fn parser(s: &str) -> IResult<&str, i32> {
+/// separated_foldl1(dec_int, "-", |l, _, r| l - r).parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("9-3-5"), Ok(("", 1)));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// assert_eq!(parser("def|abc"), Err(ErrMode::Backtrack(InputError::new("def|abc", ErrorKind::Slice))));
+/// ```
+pub fn separated_foldl1<I, O, O2, E, P, S, Op>(
+ mut parser: P,
+ mut sep: S,
+ mut op: Op,
+) -> impl Parser<I, O, E>
+where
+ I: Stream,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+ Op: FnMut(O, O2, O) -> O,
+{
+ trace("separated_foldl1", move |i: &mut I| {
+ let mut ol = parser.parse_next(i)?;
+
+ loop {
+ let start = i.checkpoint();
+ let len = i.eof_offset();
+ match sep.parse_next(i) {
+ Err(ErrMode::Backtrack(_)) => {
+ i.reset(start);
+ return Ok(ol);
+ }
+ Err(e) => return Err(e),
+ Ok(s) => {
+ // infinite loop check: the parser must always consume
+ if i.eof_offset() == len {
+ return Err(ErrMode::assert(i, "`repeat` parsers must always consume"));
+ }
+
+ match parser.parse_next(i) {
+ Err(ErrMode::Backtrack(_)) => {
+ i.reset(start);
+ return Ok(ol);
+ }
+ Err(e) => return Err(e),
+ Ok(or) => {
+ ol = op(ol, s, or);
+ }
+ }
+ }
+ }
+ }
+ })
+}
+
+/// Alternates between two parsers, merging the results (right associative)
+///
+/// This stops when either parser returns [`ErrMode::Backtrack`]. To instead chain an error up, see
+/// [`cut_err`][crate::combinator::cut_err].
+///
+/// # Example
+///
+/// ```
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated_foldr1;
+/// use winnow::ascii::dec_uint;
+///
+/// fn parser(s: &str) -> IResult<&str, u32> {
+/// separated_foldr1(dec_uint, "^", |l: u32, _, r: u32| l.pow(r)).parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("2^3^2"), Ok(("", 512)));
+/// assert_eq!(parser("2"), Ok(("", 2)));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// assert_eq!(parser("def|abc"), Err(ErrMode::Backtrack(InputError::new("def|abc", ErrorKind::Slice))));
+/// ```
+#[cfg(feature = "alloc")]
+pub fn separated_foldr1<I, O, O2, E, P, S, Op>(
+ mut parser: P,
+ mut sep: S,
+ mut op: Op,
+) -> impl Parser<I, O, E>
+where
+ I: Stream,
+ P: Parser<I, O, E>,
+ S: Parser<I, O2, E>,
+ E: ParserError<I>,
+ Op: FnMut(O, O2, O) -> O,
+{
+ trace("separated_foldr1", move |i: &mut I| {
+ let ol = parser.parse_next(i)?;
+ let all: crate::lib::std::vec::Vec<(O2, O)> =
+ repeat(0.., (sep.by_ref(), parser.by_ref())).parse_next(i)?;
+ if let Some((s, or)) = all
+ .into_iter()
+ .rev()
+ .reduce(|(sr, or), (sl, ol)| (sl, op(ol, sr, or)))
+ {
+ let merged = op(ol, s, or);
+ Ok(merged)
+ } else {
+ Ok(ol)
+ }
+ })
+}
+
+/// Repeats the embedded parser, filling the given slice with results.
+///
+/// This parser fails if the input runs out before the given slice is full.
+///
+/// # Arguments
+/// * `f` The parser to apply.
+/// * `buf` The slice to fill
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::combinator::fill;
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, [&str; 2]> {
+/// let mut buf = ["", ""];
+/// let (rest, ()) = fill("abc", &mut buf).parse_peek(s)?;
+/// Ok((rest, buf))
+/// }
+///
+/// assert_eq!(parser("abcabc"), Ok(("", ["abc", "abc"])));
+/// assert_eq!(parser("abc123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// assert_eq!(parser("123123"), Err(ErrMode::Backtrack(InputError::new("123123", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser("abcabcabc"), Ok(("abc", ["abc", "abc"])));
+/// ```
+pub fn fill<'a, I, O, E, F>(mut f: F, buf: &'a mut [O]) -> impl Parser<I, (), E> + 'a
+where
+ I: Stream + 'a,
+ F: Parser<I, O, E> + 'a,
+ E: ParserError<I> + 'a,
+{
+ trace("fill", move |i: &mut I| {
+ for elem in buf.iter_mut() {
+ match f.parse_next(i) {
+ Ok(o) => {
+ *elem = o;
+ }
+ Err(e) => {
+ return Err(e.append(i, ErrorKind::Many));
+ }
+ }
+ }
+
+ Ok(())
+ })
+}
+
+/// Deprecated, replaced with [`Repeat::fold`]
+#[deprecated(since = "0.5.36", note = "Replaced with `repeat(...).fold(...)`")]
+#[inline(always)]
+pub fn fold_repeat<I, O, E, F, G, H, R>(
+ range: impl Into<Range>,
+ f: F,
+ init: H,
+ g: G,
+) -> impl Parser<I, R, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+ G: FnMut(R, O) -> R,
+ H: FnMut() -> R,
+ E: ParserError<I>,
+{
+ repeat(range, f).fold(init, g)
+}
+
+fn fold_repeat0_<I, O, E, F, G, H, R>(
+ f: &mut F,
+ init: &mut H,
+ g: &mut G,
+ input: &mut I,
+) -> PResult<R, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+ G: FnMut(R, O) -> R,
+ H: FnMut() -> R,
+ E: ParserError<I>,
+{
+ let mut res = init();
+
+ loop {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match f.parse_next(input) {
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`repeat` parsers must always consume",
+ ));
+ }
+
+ res = g(res, o);
+ }
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ return Ok(res);
+ }
+ Err(e) => {
+ return Err(e);
+ }
+ }
+ }
+}
+
+fn fold_repeat1_<I, O, E, F, G, H, R>(
+ f: &mut F,
+ init: &mut H,
+ g: &mut G,
+ input: &mut I,
+) -> PResult<R, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+ G: FnMut(R, O) -> R,
+ H: FnMut() -> R,
+ E: ParserError<I>,
+{
+ let init = init();
+ match f.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => Err(ErrMode::from_error_kind(input, ErrorKind::Many)),
+ Err(e) => Err(e),
+ Ok(o1) => {
+ let mut acc = g(init, o1);
+
+ loop {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match f.parse_next(input) {
+ Err(ErrMode::Backtrack(_)) => {
+ input.reset(start);
+ break;
+ }
+ Err(e) => return Err(e),
+ Ok(o) => {
+ // infinite loop check: the parser must always consume
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`repeat` parsers must always consume",
+ ));
+ }
+
+ acc = g(acc, o);
+ }
+ }
+ }
+
+ Ok(acc)
+ }
+ }
+}
+
+fn fold_repeat_m_n_<I, O, E, F, G, H, R>(
+ min: usize,
+ max: usize,
+ parse: &mut F,
+ init: &mut H,
+ fold: &mut G,
+ input: &mut I,
+) -> PResult<R, E>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+ G: FnMut(R, O) -> R,
+ H: FnMut() -> R,
+ E: ParserError<I>,
+{
+ if min > max {
+ return Err(ErrMode::Cut(E::from_error_kind(input, ErrorKind::Many)));
+ }
+
+ let mut acc = init();
+ for count in 0..max {
+ let start = input.checkpoint();
+ let len = input.eof_offset();
+ match parse.parse_next(input) {
+ Ok(value) => {
+ // infinite loop check: the parser must always consume
+ if input.eof_offset() == len {
+ return Err(ErrMode::assert(
+ input,
+ "`repeat` parsers must always consume",
+ ));
+ }
+
+ acc = fold(acc, value);
+ }
+ //FInputXMError: handle failure properly
+ Err(ErrMode::Backtrack(err)) => {
+ if count < min {
+ return Err(ErrMode::Backtrack(err.append(input, ErrorKind::Many)));
+ } else {
+ input.reset(start);
+ break;
+ }
+ }
+ Err(e) => return Err(e),
+ }
+ }
+
+ Ok(acc)
+}
diff --git a/crates/winnow/src/combinator/parser.rs b/crates/winnow/src/combinator/parser.rs
new file mode 100644
index 0000000..9ffdb3c
--- /dev/null
+++ b/crates/winnow/src/combinator/parser.rs
@@ -0,0 +1,1097 @@
+use crate::combinator::trace;
+use crate::combinator::trace_result;
+#[cfg(feature = "unstable-recover")]
+use crate::error::FromRecoverableError;
+use crate::error::{AddContext, ErrMode, ErrorKind, FromExternalError, ParserError};
+use crate::lib::std::borrow::Borrow;
+use crate::lib::std::ops::Range;
+#[cfg(feature = "unstable-recover")]
+use crate::stream::Recover;
+use crate::stream::StreamIsPartial;
+use crate::stream::{Location, Stream};
+use crate::*;
+
+/// Implementation of [`Parser::by_ref`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct ByRef<'p, P> {
+ p: &'p mut P,
+}
+
+impl<'p, P> ByRef<'p, P> {
+ #[inline(always)]
+ pub(crate) fn new(p: &'p mut P) -> Self {
+ Self { p }
+ }
+}
+
+impl<'p, I, O, E, P> Parser<I, O, E> for ByRef<'p, P>
+where
+ P: Parser<I, O, E>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ self.p.parse_next(i)
+ }
+}
+
+/// Implementation of [`Parser::map`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Map<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> O2,
+{
+ parser: F,
+ map: G,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, G, I, O, O2, E> Map<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> O2,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, map: G) -> Self {
+ Self {
+ parser,
+ map,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, G, I, O, O2, E> Parser<I, O2, E> for Map<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> O2,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O2, E> {
+ match self.parser.parse_next(i) {
+ Err(e) => Err(e),
+ Ok(o) => Ok((self.map)(o)),
+ }
+ }
+}
+
+/// Implementation of [`Parser::try_map`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct TryMap<F, G, I, O, O2, E, E2>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Result<O2, E2>,
+ I: Stream,
+ E: FromExternalError<I, E2>,
+{
+ parser: F,
+ map: G,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+ e2: core::marker::PhantomData<E2>,
+}
+
+impl<F, G, I, O, O2, E, E2> TryMap<F, G, I, O, O2, E, E2>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Result<O2, E2>,
+ I: Stream,
+ E: FromExternalError<I, E2>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, map: G) -> Self {
+ Self {
+ parser,
+ map,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ e2: Default::default(),
+ }
+ }
+}
+
+impl<F, G, I, O, O2, E, E2> Parser<I, O2, E> for TryMap<F, G, I, O, O2, E, E2>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Result<O2, E2>,
+ I: Stream,
+ E: FromExternalError<I, E2>,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O2, E> {
+ let start = input.checkpoint();
+ let o = self.parser.parse_next(input)?;
+ let res = (self.map)(o).map_err(|err| {
+ input.reset(start);
+ ErrMode::from_external_error(input, ErrorKind::Verify, err)
+ });
+ trace_result("verify", &res);
+ res
+ }
+}
+
+/// Implementation of [`Parser::verify_map`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct VerifyMap<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Option<O2>,
+ I: Stream,
+ E: ParserError<I>,
+{
+ parser: F,
+ map: G,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, G, I, O, O2, E> VerifyMap<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Option<O2>,
+ I: Stream,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, map: G) -> Self {
+ Self {
+ parser,
+ map,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, G, I, O, O2, E> Parser<I, O2, E> for VerifyMap<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> Option<O2>,
+ I: Stream,
+ E: ParserError<I>,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O2, E> {
+ let start = input.checkpoint();
+ let o = self.parser.parse_next(input)?;
+ let res = (self.map)(o).ok_or_else(|| {
+ input.reset(start);
+ ErrMode::from_error_kind(input, ErrorKind::Verify)
+ });
+ trace_result("verify", &res);
+ res
+ }
+}
+
+/// Implementation of [`Parser::and_then`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct AndThen<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: Parser<O, O2, E>,
+ O: StreamIsPartial,
+ I: Stream,
+{
+ outer: F,
+ inner: G,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, G, I, O, O2, E> AndThen<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: Parser<O, O2, E>,
+ O: StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ pub(crate) fn new(outer: F, inner: G) -> Self {
+ Self {
+ outer,
+ inner,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, G, I, O, O2, E> Parser<I, O2, E> for AndThen<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: Parser<O, O2, E>,
+ O: StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O2, E> {
+ let start = i.checkpoint();
+ let mut o = self.outer.parse_next(i)?;
+ let _ = o.complete();
+ let o2 = self.inner.parse_next(&mut o).map_err(|err| {
+ i.reset(start);
+ err
+ })?;
+ Ok(o2)
+ }
+}
+
+/// Implementation of [`Parser::parse_to`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct ParseTo<P, I, O, O2, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ O: crate::stream::ParseSlice<O2>,
+ E: ParserError<I>,
+{
+ p: P,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<P, I, O, O2, E> ParseTo<P, I, O, O2, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ O: crate::stream::ParseSlice<O2>,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ pub(crate) fn new(p: P) -> Self {
+ Self {
+ p,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<P, I, O, O2, E> Parser<I, O2, E> for ParseTo<P, I, O, O2, E>
+where
+ P: Parser<I, O, E>,
+ I: Stream,
+ O: crate::stream::ParseSlice<O2>,
+ E: ParserError<I>,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O2, E> {
+ let start = i.checkpoint();
+ let o = self.p.parse_next(i)?;
+ let res = o.parse_slice().ok_or_else(|| {
+ i.reset(start);
+ ErrMode::from_error_kind(i, ErrorKind::Verify)
+ });
+ trace_result("verify", &res);
+ res
+ }
+}
+
+/// Implementation of [`Parser::flat_map`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct FlatMap<F, G, H, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> H,
+ H: Parser<I, O2, E>,
+{
+ f: F,
+ g: G,
+ h: core::marker::PhantomData<H>,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, G, H, I, O, O2, E> FlatMap<F, G, H, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> H,
+ H: Parser<I, O2, E>,
+{
+ #[inline(always)]
+ pub(crate) fn new(f: F, g: G) -> Self {
+ Self {
+ f,
+ g,
+ h: Default::default(),
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, G, H, I, O, O2, E> Parser<I, O2, E> for FlatMap<F, G, H, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(O) -> H,
+ H: Parser<I, O2, E>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O2, E> {
+ let o = self.f.parse_next(i)?;
+ (self.g)(o).parse_next(i)
+ }
+}
+
+/// Implementation of [`Parser::complete_err`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct CompleteErr<F> {
+ f: F,
+}
+
+impl<F> CompleteErr<F> {
+ #[inline(always)]
+ pub(crate) fn new(f: F) -> Self {
+ Self { f }
+ }
+}
+
+impl<F, I, O, E> Parser<I, O, E> for CompleteErr<F>
+where
+ I: Stream,
+ F: Parser<I, O, E>,
+ E: ParserError<I>,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O, E> {
+ trace("complete_err", |input: &mut I| {
+ match (self.f).parse_next(input) {
+ Err(ErrMode::Incomplete(_)) => {
+ Err(ErrMode::from_error_kind(input, ErrorKind::Complete))
+ }
+ rest => rest,
+ }
+ })
+ .parse_next(input)
+ }
+}
+
+/// Implementation of [`Parser::verify`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Verify<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(&O2) -> bool,
+ I: Stream,
+ O: Borrow<O2>,
+ O2: ?Sized,
+ E: ParserError<I>,
+{
+ parser: F,
+ filter: G,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, G, I, O, O2, E> Verify<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(&O2) -> bool,
+ I: Stream,
+ O: Borrow<O2>,
+ O2: ?Sized,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, filter: G) -> Self {
+ Self {
+ parser,
+ filter,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, G, I, O, O2, E> Parser<I, O, E> for Verify<F, G, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ G: FnMut(&O2) -> bool,
+ I: Stream,
+ O: Borrow<O2>,
+ O2: ?Sized,
+ E: ParserError<I>,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O, E> {
+ let start = input.checkpoint();
+ let o = self.parser.parse_next(input)?;
+ let res = (self.filter)(o.borrow()).then_some(o).ok_or_else(|| {
+ input.reset(start);
+ ErrMode::from_error_kind(input, ErrorKind::Verify)
+ });
+ trace_result("verify", &res);
+ res
+ }
+}
+
+/// Implementation of [`Parser::value`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Value<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: Clone,
+{
+ parser: F,
+ val: O2,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, O2, E> Value<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: Clone,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, val: O2) -> Self {
+ Self {
+ parser,
+ val,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, O2, E> Parser<I, O2, E> for Value<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: Clone,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O2, E> {
+ (self.parser).parse_next(input).map(|_| self.val.clone())
+ }
+}
+
+/// Implementation of [`Parser::default_value`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct DefaultValue<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: core::default::Default,
+{
+ parser: F,
+ o2: core::marker::PhantomData<O2>,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, O2, E> DefaultValue<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: core::default::Default,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ o2: Default::default(),
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, O2, E> Parser<I, O2, E> for DefaultValue<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O2: core::default::Default,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<O2, E> {
+ (self.parser).parse_next(input).map(|_| O2::default())
+ }
+}
+
+/// Implementation of [`Parser::void`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Void<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E> Void<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, E> Parser<I, (), E> for Void<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, input: &mut I) -> PResult<(), E> {
+ (self.parser).parse_next(input).map(|_| ())
+ }
+}
+
+/// Implementation of [`Parser::recognize`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Recognize<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E> Recognize<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<I, O, E, F> Parser<I, <I as Stream>::Slice, E> for Recognize<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ let checkpoint = input.checkpoint();
+ match (self.parser).parse_next(input) {
+ Ok(_) => {
+ let offset = input.offset_from(&checkpoint);
+ input.reset(checkpoint);
+ let recognized = input.next_slice(offset);
+ Ok(recognized)
+ }
+ Err(e) => Err(e),
+ }
+ }
+}
+
+/// Implementation of [`Parser::with_recognized`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct WithRecognized<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E> WithRecognized<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, E> Parser<I, (O, <I as Stream>::Slice), E> for WithRecognized<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<(O, <I as Stream>::Slice), E> {
+ let checkpoint = input.checkpoint();
+ match (self.parser).parse_next(input) {
+ Ok(result) => {
+ let offset = input.offset_from(&checkpoint);
+ input.reset(checkpoint);
+ let recognized = input.next_slice(offset);
+ Ok((result, recognized))
+ }
+ Err(e) => Err(e),
+ }
+ }
+}
+
+/// Implementation of [`Parser::span`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Span<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E> Span<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<I, O, E, F> Parser<I, Range<usize>, E> for Span<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<Range<usize>, E> {
+ let start = input.location();
+ self.parser.parse_next(input).map(move |_| {
+ let end = input.location();
+ start..end
+ })
+ }
+}
+
+/// Implementation of [`Parser::with_span`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct WithSpan<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E> WithSpan<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, E> Parser<I, (O, Range<usize>), E> for WithSpan<F, I, O, E>
+where
+ F: Parser<I, O, E>,
+ I: Stream + Location,
+{
+ #[inline]
+ fn parse_next(&mut self, input: &mut I) -> PResult<(O, Range<usize>), E> {
+ let start = input.location();
+ self.parser.parse_next(input).map(move |output| {
+ let end = input.location();
+ (output, (start..end))
+ })
+ }
+}
+
+/// Implementation of [`Parser::output_into`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct OutputInto<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O: Into<O2>,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ o2: core::marker::PhantomData<O2>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, O2, E> OutputInto<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O: Into<O2>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ o2: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, O2, E> Parser<I, O2, E> for OutputInto<F, I, O, O2, E>
+where
+ F: Parser<I, O, E>,
+ O: Into<O2>,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O2, E> {
+ self.parser.parse_next(i).map(|o| o.into())
+ }
+}
+
+/// Implementation of [`Parser::err_into`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct ErrInto<F, I, O, E, E2>
+where
+ F: Parser<I, O, E>,
+ E: Into<E2>,
+{
+ parser: F,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+ e2: core::marker::PhantomData<E2>,
+}
+
+impl<F, I, O, E, E2> ErrInto<F, I, O, E, E2>
+where
+ F: Parser<I, O, E>,
+ E: Into<E2>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F) -> Self {
+ Self {
+ parser,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ e2: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, E, E2> Parser<I, O, E2> for ErrInto<F, I, O, E, E2>
+where
+ F: Parser<I, O, E>,
+ E: Into<E2>,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E2> {
+ match self.parser.parse_next(i) {
+ Ok(ok) => Ok(ok),
+ Err(ErrMode::Backtrack(e)) => Err(ErrMode::Backtrack(e.into())),
+ Err(ErrMode::Cut(e)) => Err(ErrMode::Cut(e.into())),
+ Err(ErrMode::Incomplete(e)) => Err(ErrMode::Incomplete(e)),
+ }
+ }
+}
+
+/// Implementation of [`Parser::context`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct Context<F, I, O, E, C>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+ E: AddContext<I, C>,
+ C: Clone + crate::lib::std::fmt::Debug,
+{
+ parser: F,
+ context: C,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+impl<F, I, O, E, C> Context<F, I, O, E, C>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+ E: AddContext<I, C>,
+ C: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: F, context: C) -> Self {
+ Self {
+ parser,
+ context,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+impl<F, I, O, E, C> Parser<I, O, E> for Context<F, I, O, E, C>
+where
+ F: Parser<I, O, E>,
+ I: Stream,
+ E: AddContext<I, C>,
+ C: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ #[cfg(feature = "debug")]
+ let name = format!("context={:?}", self.context);
+ #[cfg(not(feature = "debug"))]
+ let name = "context";
+ trace(name, move |i: &mut I| {
+ (self.parser)
+ .parse_next(i)
+ .map_err(|err| err.add_context(i, self.context.clone()))
+ })
+ .parse_next(i)
+ }
+}
+
+/// Implementation of [`Parser::retry_after`]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+#[cfg(feature = "unstable-recover")]
+pub struct RetryAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ parser: P,
+ recover: R,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<P, R, I, O, E> RetryAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: P, recover: R) -> Self {
+ Self {
+ parser,
+ recover,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<P, R, I, O, E> Parser<I, O, E> for RetryAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ if I::is_recovery_supported() {
+ retry_after_inner(&mut self.parser, &mut self.recover, i)
+ } else {
+ self.parser.parse_next(i)
+ }
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+fn retry_after_inner<P, R, I, O, E>(parser: &mut P, recover: &mut R, i: &mut I) -> PResult<O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ loop {
+ let token_start = i.checkpoint();
+ let mut err = match parser.parse_next(i) {
+ Ok(o) => {
+ return Ok(o);
+ }
+ Err(ErrMode::Incomplete(e)) => return Err(ErrMode::Incomplete(e)),
+ Err(err) => err,
+ };
+ let err_start = i.checkpoint();
+ let err_start_eof_offset = i.eof_offset();
+ if recover.parse_next(i).is_ok() {
+ let i_eof_offset = i.eof_offset();
+ if err_start_eof_offset == i_eof_offset {
+ // Didn't advance so bubble the error up
+ } else if let Err(err_) = i.record_err(&token_start, &err_start, err) {
+ err = err_;
+ } else {
+ continue;
+ }
+ }
+
+ i.reset(err_start.clone());
+ err = err.map(|err| E::from_recoverable_error(&token_start, &err_start, i, err));
+ return Err(err);
+ }
+}
+
+/// Implementation of [`Parser::resume_after`]
+#[cfg(feature = "unstable-recover")]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub struct ResumeAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ parser: P,
+ recover: R,
+ i: core::marker::PhantomData<I>,
+ o: core::marker::PhantomData<O>,
+ e: core::marker::PhantomData<E>,
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<P, R, I, O, E> ResumeAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ #[inline(always)]
+ pub(crate) fn new(parser: P, recover: R) -> Self {
+ Self {
+ parser,
+ recover,
+ i: Default::default(),
+ o: Default::default(),
+ e: Default::default(),
+ }
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<P, R, I, O, E> Parser<I, Option<O>, E> for ResumeAfter<P, R, I, O, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<Option<O>, E> {
+ if I::is_recovery_supported() {
+ resume_after_inner(&mut self.parser, &mut self.recover, i)
+ } else {
+ self.parser.parse_next(i).map(Some)
+ }
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+fn resume_after_inner<P, R, I, O, E>(
+ parser: &mut P,
+ recover: &mut R,
+ i: &mut I,
+) -> PResult<Option<O>, E>
+where
+ P: Parser<I, O, E>,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+{
+ let token_start = i.checkpoint();
+ let mut err = match parser.parse_next(i) {
+ Ok(o) => {
+ return Ok(Some(o));
+ }
+ Err(ErrMode::Incomplete(e)) => return Err(ErrMode::Incomplete(e)),
+ Err(err) => err,
+ };
+ let err_start = i.checkpoint();
+ if recover.parse_next(i).is_ok() {
+ if let Err(err_) = i.record_err(&token_start, &err_start, err) {
+ err = err_;
+ } else {
+ return Ok(None);
+ }
+ }
+
+ i.reset(err_start.clone());
+ err = err.map(|err| E::from_recoverable_error(&token_start, &err_start, i, err));
+ Err(err)
+}
diff --git a/crates/winnow/src/combinator/sequence.rs b/crates/winnow/src/combinator/sequence.rs
new file mode 100644
index 0000000..0f2e633
--- /dev/null
+++ b/crates/winnow/src/combinator/sequence.rs
@@ -0,0 +1,175 @@
+use crate::combinator::trace;
+use crate::error::ParserError;
+use crate::stream::Stream;
+use crate::*;
+
+#[doc(inline)]
+pub use crate::seq;
+
+/// Sequence two parsers, only returning the output from the second.
+///
+/// # Arguments
+/// * `first` The opening parser.
+/// * `second` The second parser to get object.
+///
+/// See also [`seq`] to generalize this across any number of fields.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::combinator::preceded;
+/// use winnow::token::tag;
+///
+/// let mut parser = preceded("abc", "efg");
+///
+/// assert_eq!(parser.parse_peek("abcefg"), Ok(("", "efg")));
+/// assert_eq!(parser.parse_peek("abcefghij"), Ok(("hij", "efg")));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// ```
+#[doc(alias = "ignore_then")]
+pub fn preceded<I, O1, O2, E: ParserError<I>, F, G>(
+ mut first: F,
+ mut second: G,
+) -> impl Parser<I, O2, E>
+where
+ I: Stream,
+ F: Parser<I, O1, E>,
+ G: Parser<I, O2, E>,
+{
+ trace("preceded", move |input: &mut I| {
+ let _ = first.parse_next(input)?;
+ second.parse_next(input)
+ })
+}
+
+/// Sequence two parsers, only returning the output of the first.
+///
+/// # Arguments
+/// * `first` The first parser to apply.
+/// * `second` The second parser to match an object.
+///
+/// See also [`seq`] to generalize this across any number of fields.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::error::Needed::Size;
+/// use winnow::combinator::terminated;
+/// use winnow::token::tag;
+///
+/// let mut parser = terminated("abc", "efg");
+///
+/// assert_eq!(parser.parse_peek("abcefg"), Ok(("", "abc")));
+/// assert_eq!(parser.parse_peek("abcefghij"), Ok(("hij", "abc")));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// ```
+#[doc(alias = "then_ignore")]
+pub fn terminated<I, O1, O2, E: ParserError<I>, F, G>(
+ mut first: F,
+ mut second: G,
+) -> impl Parser<I, O1, E>
+where
+ I: Stream,
+ F: Parser<I, O1, E>,
+ G: Parser<I, O2, E>,
+{
+ trace("terminated", move |input: &mut I| {
+ let o1 = first.parse_next(input)?;
+ second.parse_next(input).map(|_| o1)
+ })
+}
+
+/// Sequence three parsers, only returning the values of the first and third.
+///
+/// # Arguments
+/// * `first` The first parser to apply.
+/// * `sep` The separator parser to apply.
+/// * `second` The second parser to apply.
+///
+/// See also [`seq`] to generalize this across any number of fields.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::error::Needed::Size;
+/// # use winnow::prelude::*;
+/// use winnow::combinator::separated_pair;
+/// use winnow::token::tag;
+///
+/// let mut parser = separated_pair("abc", "|", "efg");
+///
+/// assert_eq!(parser.parse_peek("abc|efg"), Ok(("", ("abc", "efg"))));
+/// assert_eq!(parser.parse_peek("abc|efghij"), Ok(("hij", ("abc", "efg"))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// ```
+pub fn separated_pair<I, O1, O2, O3, E: ParserError<I>, F, G, H>(
+ mut first: F,
+ mut sep: G,
+ mut second: H,
+) -> impl Parser<I, (O1, O3), E>
+where
+ I: Stream,
+ F: Parser<I, O1, E>,
+ G: Parser<I, O2, E>,
+ H: Parser<I, O3, E>,
+{
+ trace("separated_pair", move |input: &mut I| {
+ let o1 = first.parse_next(input)?;
+ let _ = sep.parse_next(input)?;
+ second.parse_next(input).map(|o2| (o1, o2))
+ })
+}
+
+/// Sequence three parsers, only returning the output of the second.
+///
+/// # Arguments
+/// * `first` The first parser to apply and discard.
+/// * `second` The second parser to apply.
+/// * `third` The third parser to apply and discard.
+///
+/// See also [`seq`] to generalize this across any number of fields.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::error::Needed::Size;
+/// # use winnow::prelude::*;
+/// use winnow::combinator::delimited;
+/// use winnow::token::tag;
+///
+/// let mut parser = delimited("(", "abc", ")");
+///
+/// assert_eq!(parser.parse_peek("(abc)"), Ok(("", "abc")));
+/// assert_eq!(parser.parse_peek("(abc)def"), Ok(("def", "abc")));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// assert_eq!(parser.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Tag))));
+/// ```
+#[doc(alias = "between")]
+#[doc(alias = "padded")]
+pub fn delimited<I, O1, O2, O3, E: ParserError<I>, F, G, H>(
+ mut first: F,
+ mut second: G,
+ mut third: H,
+) -> impl Parser<I, O2, E>
+where
+ I: Stream,
+ F: Parser<I, O1, E>,
+ G: Parser<I, O2, E>,
+ H: Parser<I, O3, E>,
+{
+ trace("delimited", move |input: &mut I| {
+ let _ = first.parse_next(input)?;
+ let o2 = second.parse_next(input)?;
+ third.parse_next(input).map(|_| o2)
+ })
+}
diff --git a/crates/winnow/src/combinator/tests.rs b/crates/winnow/src/combinator/tests.rs
new file mode 100644
index 0000000..726b410
--- /dev/null
+++ b/crates/winnow/src/combinator/tests.rs
@@ -0,0 +1,1379 @@
+use super::*;
+
+use crate::ascii::digit1 as digit;
+use crate::binary::u16;
+use crate::binary::u8;
+use crate::binary::Endianness;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::InputError;
+use crate::error::Needed;
+use crate::error::ParserError;
+use crate::stream::Stream;
+use crate::token::take;
+use crate::unpeek;
+use crate::IResult;
+use crate::PResult;
+use crate::Parser;
+use crate::Partial;
+
+#[cfg(feature = "alloc")]
+use crate::lib::std::vec::Vec;
+
+macro_rules! assert_parse(
+ ($left: expr, $right: expr) => {
+ let res: $crate::IResult<_, _, InputError<_>> = $left;
+ assert_eq!(res, $right);
+ };
+);
+
+#[test]
+fn eof_on_slices() {
+ let not_over: &[u8] = &b"Hello, world!"[..];
+ let is_over: &[u8] = &b""[..];
+
+ let res_not_over = eof.parse_peek(not_over);
+ assert_parse!(
+ res_not_over,
+ Err(ErrMode::Backtrack(error_position!(
+ ¬_over,
+ ErrorKind::Eof
+ )))
+ );
+
+ let res_over = eof.parse_peek(is_over);
+ assert_parse!(res_over, Ok((is_over, is_over)));
+}
+
+#[test]
+fn eof_on_strs() {
+ let not_over: &str = "Hello, world!";
+ let is_over: &str = "";
+
+ let res_not_over = eof.parse_peek(not_over);
+ assert_parse!(
+ res_not_over,
+ Err(ErrMode::Backtrack(error_position!(
+ ¬_over,
+ ErrorKind::Eof
+ )))
+ );
+
+ let res_over = eof.parse_peek(is_over);
+ assert_parse!(res_over, Ok((is_over, is_over)));
+}
+
+#[test]
+fn rest_on_slices() {
+ let input: &[u8] = &b"Hello, world!"[..];
+ let empty: &[u8] = &b""[..];
+ assert_parse!(rest.parse_peek(input), Ok((empty, input)));
+}
+
+#[test]
+fn rest_on_strs() {
+ let input: &str = "Hello, world!";
+ let empty: &str = "";
+ assert_parse!(rest.parse_peek(input), Ok((empty, input)));
+}
+
+#[test]
+fn rest_len_on_slices() {
+ let input: &[u8] = &b"Hello, world!"[..];
+ assert_parse!(rest_len.parse_peek(input), Ok((input, input.len())));
+}
+
+use crate::lib::std::convert::From;
+impl From<u32> for CustomError {
+ fn from(_: u32) -> Self {
+ CustomError
+ }
+}
+
+impl<I> ParserError<I> for CustomError {
+ fn from_error_kind(_: &I, _: ErrorKind) -> Self {
+ CustomError
+ }
+
+ fn append(self, _: &I, _: ErrorKind) -> Self {
+ CustomError
+ }
+}
+
+struct CustomError;
+#[allow(dead_code)]
+fn custom_error(input: &[u8]) -> IResult<&[u8], &[u8], CustomError> {
+ //fix_error!(input, CustomError<_>, alphanumeric)
+ crate::ascii::alphanumeric1.parse_peek(input)
+}
+
+#[test]
+fn test_parser_flat_map() {
+ let input: &[u8] = &[3, 100, 101, 102, 103, 104][..];
+ assert_parse!(
+ u8.flat_map(take).parse_peek(input),
+ Ok((&[103, 104][..], &[100, 101, 102][..]))
+ );
+}
+
+#[allow(dead_code)]
+fn test_closure_compiles_195(input: &[u8]) -> IResult<&[u8], ()> {
+ u8.flat_map(|num| repeat(num as usize, u16(Endianness::Big)))
+ .parse_peek(input)
+}
+
+#[test]
+fn test_parser_verify_map() {
+ let input: &[u8] = &[50][..];
+ assert_parse!(
+ u8.verify_map(|u| if u < 20 { Some(u) } else { None })
+ .parse_peek(input),
+ Err(ErrMode::Backtrack(InputError::new(
+ &[50][..],
+ ErrorKind::Verify
+ )))
+ );
+ assert_parse!(
+ u8.verify_map(|u| if u > 20 { Some(u) } else { None })
+ .parse_peek(input),
+ Ok((&[][..], 50))
+ );
+}
+
+#[test]
+fn test_parser_map_parser() {
+ let input: &[u8] = &[100, 101, 102, 103, 104][..];
+ assert_parse!(
+ take(4usize).and_then(take(2usize)).parse_peek(input),
+ Ok((&[104][..], &[100, 101][..]))
+ );
+}
+
+#[test]
+#[cfg(feature = "std")]
+fn test_parser_into() {
+ use crate::error::InputError;
+ use crate::token::take;
+
+ let mut parser = take::<_, _, InputError<_>>(3u8).output_into();
+ let result: IResult<&[u8], Vec<u8>> = parser.parse_peek(&b"abcdefg"[..]);
+
+ assert_eq!(result, Ok((&b"defg"[..], vec![97, 98, 99])));
+}
+
+#[test]
+fn opt_test() {
+ fn opt_abcd(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Option<&[u8]>> {
+ opt("abcd").parse_peek(i)
+ }
+
+ let a = &b"abcdef"[..];
+ let b = &b"bcdefg"[..];
+ let c = &b"ab"[..];
+ assert_eq!(
+ opt_abcd(Partial::new(a)),
+ Ok((Partial::new(&b"ef"[..]), Some(&b"abcd"[..])))
+ );
+ assert_eq!(
+ opt_abcd(Partial::new(b)),
+ Ok((Partial::new(&b"bcdefg"[..]), None))
+ );
+ assert_eq!(
+ opt_abcd(Partial::new(c)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+fn peek_test() {
+ fn peek_tag(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ peek("abcd").parse_peek(i)
+ }
+
+ assert_eq!(
+ peek_tag(Partial::new(&b"abcdef"[..])),
+ Ok((Partial::new(&b"abcdef"[..]), &b"abcd"[..]))
+ );
+ assert_eq!(
+ peek_tag(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ peek_tag(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn not_test() {
+ fn not_aaa(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, ()> {
+ not("aaa").parse_peek(i)
+ }
+
+ assert_eq!(
+ not_aaa(Partial::new(&b"aaa"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"aaa"[..]),
+ ErrorKind::Not
+ )))
+ );
+ assert_eq!(
+ not_aaa(Partial::new(&b"aa"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ not_aaa(Partial::new(&b"abcd"[..])),
+ Ok((Partial::new(&b"abcd"[..]), ()))
+ );
+}
+
+#[test]
+fn test_parser_verify() {
+ use crate::token::take;
+
+ fn test(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take(5u8)
+ .verify(|slice: &[u8]| slice[0] == b'a')
+ .parse_peek(i)
+ }
+ assert_eq!(
+ test(Partial::new(&b"bcd"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ test(Partial::new(&b"bcdefg"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"bcdefg"[..]),
+ ErrorKind::Verify
+ )))
+ );
+ assert_eq!(
+ test(Partial::new(&b"abcdefg"[..])),
+ Ok((Partial::new(&b"fg"[..]), &b"abcde"[..]))
+ );
+}
+
+#[test]
+#[allow(unused)]
+fn test_parser_verify_ref() {
+ use crate::token::take;
+
+ let mut parser1 = take(3u8).verify(|s: &[u8]| s == &b"abc"[..]);
+
+ assert_eq!(
+ parser1.parse_peek(&b"abcd"[..]),
+ Ok((&b"d"[..], &b"abc"[..]))
+ );
+ assert_eq!(
+ parser1.parse_peek(&b"defg"[..]),
+ Err(ErrMode::Backtrack(InputError::new(
+ &b"defg"[..],
+ ErrorKind::Verify
+ )))
+ );
+
+ fn parser2(i: &[u8]) -> IResult<&[u8], u32> {
+ crate::binary::be_u32
+ .verify(|val: &u32| *val < 3)
+ .parse_peek(i)
+ }
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn test_parser_verify_alloc() {
+ use crate::token::take;
+ let mut parser1 = take(3u8)
+ .map(|s: &[u8]| s.to_vec())
+ .verify(|s: &[u8]| s == &b"abc"[..]);
+
+ assert_eq!(
+ parser1.parse_peek(&b"abcd"[..]),
+ Ok((&b"d"[..], b"abc".to_vec()))
+ );
+ assert_eq!(
+ parser1.parse_peek(&b"defg"[..]),
+ Err(ErrMode::Backtrack(InputError::new(
+ &b"defg"[..],
+ ErrorKind::Verify
+ )))
+ );
+}
+
+#[test]
+fn fail_test() {
+ let a = "string";
+ let b = "another string";
+
+ assert_eq!(
+ fail::<_, &str, _>.parse_peek(a),
+ Err(ErrMode::Backtrack(InputError::new(a, ErrorKind::Fail)))
+ );
+ assert_eq!(
+ fail::<_, &str, _>.parse_peek(b),
+ Err(ErrMode::Backtrack(InputError::new(b, ErrorKind::Fail)))
+ );
+}
+
+#[test]
+fn complete() {
+ fn err_test(i: &[u8]) -> IResult<&[u8], &[u8]> {
+ let (i, _) = "ijkl".parse_peek(i)?;
+ "mnop".parse_peek(i)
+ }
+ let a = &b"ijklmn"[..];
+
+ let res_a = err_test(a);
+ assert_eq!(
+ res_a,
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"mn"[..],
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn separated_pair_test() {
+ #[allow(clippy::type_complexity)]
+ fn sep_pair_abc_def(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (&[u8], &[u8])> {
+ separated_pair("abc", ",", "def").parse_peek(i)
+ }
+
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"abc,defghijkl"[..])),
+ Ok((Partial::new(&b"ghijkl"[..]), (&b"abc"[..], &b"def"[..])))
+ );
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"abc,d"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"xxx,def"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx,def"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ sep_pair_abc_def(Partial::new(&b"abc,xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn preceded_test() {
+ fn preceded_abcd_efgh(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ preceded("abcd", "efgh").parse_peek(i)
+ }
+
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"abcdefghijkl"[..])),
+ Ok((Partial::new(&b"ijkl"[..]), &b"efgh"[..]))
+ );
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"abcde"[..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"xxxxdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxxdef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ preceded_abcd_efgh(Partial::new(&b"abcdxxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn terminated_test() {
+ fn terminated_abcd_efgh(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ terminated("abcd", "efgh").parse_peek(i)
+ }
+
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"abcdefghijkl"[..])),
+ Ok((Partial::new(&b"ijkl"[..]), &b"abcd"[..]))
+ );
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"abcde"[..])),
+ Err(ErrMode::Incomplete(Needed::new(3)))
+ );
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"xxxxdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxxdef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ terminated_abcd_efgh(Partial::new(&b"abcdxxxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn delimited_test() {
+ fn delimited_abc_def_ghi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ delimited("abc", "def", "ghi").parse_peek(i)
+ }
+
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"abcdefghijkl"[..])),
+ Ok((Partial::new(&b"jkl"[..]), &b"def"[..]))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"abcde"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"abcdefgh"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"xxxdefghi"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxdefghi"[..]),
+ ErrorKind::Tag
+ ),))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"abcxxxghi"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxghi"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ delimited_abc_def_ghi(Partial::new(&b"abcdefxxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[cfg(feature = "alloc")]
+#[test]
+fn alt_test() {
+ #[cfg(feature = "alloc")]
+ use crate::{
+ error::ParserError,
+ lib::std::{
+ fmt::Debug,
+ string::{String, ToString},
+ },
+ };
+
+ #[cfg(feature = "alloc")]
+ #[derive(Debug, Clone, Eq, PartialEq)]
+ pub struct ErrorStr(String);
+
+ #[cfg(feature = "alloc")]
+ impl From<u32> for ErrorStr {
+ fn from(i: u32) -> Self {
+ ErrorStr(format!("custom error code: {}", i))
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl<'a> From<&'a str> for ErrorStr {
+ fn from(i: &'a str) -> Self {
+ ErrorStr(format!("custom error message: {}", i))
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl<I: Debug> ParserError<I> for ErrorStr {
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ ErrorStr(format!("custom error message: ({:?}, {:?})", input, kind))
+ }
+
+ fn append(self, input: &I, kind: ErrorKind) -> Self {
+ ErrorStr(format!(
+ "custom error message: ({:?}, {:?}) - {:?}",
+ input, kind, self
+ ))
+ }
+ }
+
+ fn work(input: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ Ok(input.peek_finish())
+ }
+
+ #[allow(unused_variables)]
+ fn dont_work(input: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ Err(ErrMode::Backtrack(ErrorStr("abcd".to_string())))
+ }
+
+ fn work2(input: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ Ok((input, &b""[..]))
+ }
+
+ fn alt1(i: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ alt((unpeek(dont_work), unpeek(dont_work))).parse_peek(i)
+ }
+ fn alt2(i: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ alt((unpeek(dont_work), unpeek(work))).parse_peek(i)
+ }
+ fn alt3(i: &[u8]) -> IResult<&[u8], &[u8], ErrorStr> {
+ alt((
+ unpeek(dont_work),
+ unpeek(dont_work),
+ unpeek(work2),
+ unpeek(dont_work),
+ ))
+ .parse_peek(i)
+ }
+ //named!(alt1, alt!(dont_work | dont_work));
+ //named!(alt2, alt!(dont_work | work));
+ //named!(alt3, alt!(dont_work | dont_work | work2 | dont_work));
+
+ let a = &b"abcd"[..];
+ assert_eq!(
+ alt1(a),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &a,
+ ErrorKind::Alt,
+ ErrorStr("abcd".to_string())
+ )))
+ );
+ assert_eq!(alt2(a), Ok((&b""[..], a)));
+ assert_eq!(alt3(a), Ok((a, &b""[..])));
+
+ fn alt4(i: &[u8]) -> IResult<&[u8], &[u8]> {
+ alt(("abcd", "efgh")).parse_peek(i)
+ }
+ let b = &b"efgh"[..];
+ assert_eq!(alt4(a), Ok((&b""[..], a)));
+ assert_eq!(alt4(b), Ok((&b""[..], b)));
+}
+
+#[test]
+fn alt_incomplete() {
+ fn alt1(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ alt(("a", "bc", "def")).parse_peek(i)
+ }
+
+ let a = &b""[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ let a = &b"b"[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ let a = &b"bcd"[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Ok((Partial::new(&b"d"[..]), &b"bc"[..]))
+ );
+ let a = &b"cde"[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(a),
+ ErrorKind::Tag
+ )))
+ );
+ let a = &b"de"[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ let a = &b"defg"[..];
+ assert_eq!(
+ alt1(Partial::new(a)),
+ Ok((Partial::new(&b"g"[..]), &b"def"[..]))
+ );
+}
+
+#[test]
+fn alt_array() {
+ fn alt1<'i>(i: &mut &'i [u8]) -> PResult<&'i [u8]> {
+ alt(["a", "bc", "def"]).parse_next(i)
+ }
+
+ let i = &b"a"[..];
+ assert_eq!(alt1.parse_peek(i), Ok((&b""[..], (&b"a"[..]))));
+
+ let i = &b"bc"[..];
+ assert_eq!(alt1.parse_peek(i), Ok((&b""[..], (&b"bc"[..]))));
+
+ let i = &b"defg"[..];
+ assert_eq!(alt1.parse_peek(i), Ok((&b"g"[..], (&b"def"[..]))));
+
+ let i = &b"z"[..];
+ assert_eq!(
+ alt1.parse_peek(i),
+ Err(ErrMode::Backtrack(error_position!(&i, ErrorKind::Tag)))
+ );
+}
+
+#[test]
+fn permutation_test() {
+ #[allow(clippy::type_complexity)]
+ fn perm(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (&[u8], &[u8], &[u8])> {
+ permutation(("abcd", "efg", "hi")).parse_peek(i)
+ }
+
+ let expected = (&b"abcd"[..], &b"efg"[..], &b"hi"[..]);
+
+ let a = &b"abcdefghijk"[..];
+ assert_eq!(
+ perm(Partial::new(a)),
+ Ok((Partial::new(&b"jk"[..]), expected))
+ );
+ let b = &b"efgabcdhijk"[..];
+ assert_eq!(
+ perm(Partial::new(b)),
+ Ok((Partial::new(&b"jk"[..]), expected))
+ );
+ let c = &b"hiefgabcdjk"[..];
+ assert_eq!(
+ perm(Partial::new(c)),
+ Ok((Partial::new(&b"jk"[..]), expected))
+ );
+
+ let d = &b"efgxyzabcdefghi"[..];
+ assert_eq!(
+ perm(Partial::new(d)),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &Partial::new(&b"efgxyzabcdefghi"[..]),
+ ErrorKind::Alt,
+ error_position!(&Partial::new(&b"xyzabcdefghi"[..]), ErrorKind::Tag)
+ )))
+ );
+
+ let e = &b"efgabc"[..];
+ assert_eq!(
+ perm(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn separated0_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(0.., "abcd", ",").parse_peek(i)
+ }
+ fn multi_empty(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(0.., "", ",").parse_peek(i)
+ }
+ fn multi_longsep(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(0.., "abcd", "..").parse_peek(i)
+ }
+
+ let a = &b"abcdef"[..];
+ let b = &b"abcd,abcdef"[..];
+ let c = &b"azerty"[..];
+ let d = &b",,abc"[..];
+ let e = &b"abcd,abcd,ef"[..];
+ let f = &b"abc"[..];
+ let g = &b"abcd."[..];
+ let h = &b"abcd,abc"[..];
+
+ let res1 = vec![&b"abcd"[..]];
+ assert_eq!(multi(Partial::new(a)), Ok((Partial::new(&b"ef"[..]), res1)));
+ let res2 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(multi(Partial::new(b)), Ok((Partial::new(&b"ef"[..]), res2)));
+ assert_eq!(
+ multi(Partial::new(c)),
+ Ok((Partial::new(&b"azerty"[..]), Vec::new()))
+ );
+ let res3 = vec![&b""[..], &b""[..], &b""[..]];
+ assert_eq!(
+ multi_empty(Partial::new(d)),
+ Ok((Partial::new(&b"abc"[..]), res3))
+ );
+ let res4 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(e)),
+ Ok((Partial::new(&b",ef"[..]), res4))
+ );
+
+ assert_eq!(
+ multi(Partial::new(f)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ multi_longsep(Partial::new(g)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ multi(Partial::new(h)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+#[cfg_attr(debug_assertions, should_panic)]
+fn separated0_empty_sep_test() {
+ fn empty_sep(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(0.., "abc", "").parse_peek(i)
+ }
+
+ let i = &b"abcabc"[..];
+
+ let i_err_pos = &i[3..];
+ assert_eq!(
+ empty_sep(Partial::new(i)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(i_err_pos),
+ ErrorKind::Assert
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn separated1_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(1.., "abcd", ",").parse_peek(i)
+ }
+ fn multi_longsep(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(1.., "abcd", "..").parse_peek(i)
+ }
+
+ let a = &b"abcdef"[..];
+ let b = &b"abcd,abcdef"[..];
+ let c = &b"azerty"[..];
+ let d = &b"abcd,abcd,ef"[..];
+
+ let f = &b"abc"[..];
+ let g = &b"abcd."[..];
+ let h = &b"abcd,abc"[..];
+
+ let res1 = vec![&b"abcd"[..]];
+ assert_eq!(multi(Partial::new(a)), Ok((Partial::new(&b"ef"[..]), res1)));
+ let res2 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(multi(Partial::new(b)), Ok((Partial::new(&b"ef"[..]), res2)));
+ assert_eq!(
+ multi(Partial::new(c)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(c),
+ ErrorKind::Tag
+ )))
+ );
+ let res3 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(d)),
+ Ok((Partial::new(&b",ef"[..]), res3))
+ );
+
+ assert_eq!(
+ multi(Partial::new(f)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ multi_longsep(Partial::new(g)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ multi(Partial::new(h)),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn separated_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ separated(2..=4, "abcd", ",").parse_peek(i)
+ }
+
+ let a = &b"abcd,ef"[..];
+ let b = &b"abcd,abcd,efgh"[..];
+ let c = &b"abcd,abcd,abcd,abcd,efgh"[..];
+ let d = &b"abcd,abcd,abcd,abcd,abcd,efgh"[..];
+ let e = &b"abcd,ab"[..];
+
+ assert_eq!(
+ multi(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"ef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ let res1 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(b)),
+ Ok((Partial::new(&b",efgh"[..]), res1))
+ );
+ let res2 = vec![&b"abcd"[..], &b"abcd"[..], &b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(c)),
+ Ok((Partial::new(&b",efgh"[..]), res2))
+ );
+ let res3 = vec![&b"abcd"[..], &b"abcd"[..], &b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(d)),
+ Ok((Partial::new(&b",abcd,efgh"[..]), res3))
+ );
+ assert_eq!(
+ multi(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn repeat0_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(0.., "abcd").parse_peek(i)
+ }
+
+ assert_eq!(
+ multi(Partial::new(&b"abcdef"[..])),
+ Ok((Partial::new(&b"ef"[..]), vec![&b"abcd"[..]]))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcdabcdefgh"[..])),
+ Ok((Partial::new(&b"efgh"[..]), vec![&b"abcd"[..], &b"abcd"[..]]))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"azerty"[..])),
+ Ok((Partial::new(&b"azerty"[..]), Vec::new()))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcdab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcd"[..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+ assert_eq!(
+ multi(Partial::new(&b""[..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+#[cfg_attr(debug_assertions, should_panic)]
+fn repeat0_empty_test() {
+ fn multi_empty(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(0.., "").parse_peek(i)
+ }
+
+ assert_eq!(
+ multi_empty(Partial::new(&b"abcdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"abcdef"[..]),
+ ErrorKind::Assert
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn repeat1_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(1.., "abcd").parse_peek(i)
+ }
+
+ let a = &b"abcdef"[..];
+ let b = &b"abcdabcdefgh"[..];
+ let c = &b"azerty"[..];
+ let d = &b"abcdab"[..];
+
+ let res1 = vec![&b"abcd"[..]];
+ assert_eq!(multi(Partial::new(a)), Ok((Partial::new(&b"ef"[..]), res1)));
+ let res2 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(b)),
+ Ok((Partial::new(&b"efgh"[..]), res2))
+ );
+ assert_eq!(
+ multi(Partial::new(c)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(c),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ multi(Partial::new(d)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn repeat_till_test() {
+ #[allow(clippy::type_complexity)]
+ fn multi(i: &[u8]) -> IResult<&[u8], (Vec<&[u8]>, &[u8])> {
+ repeat_till(0.., "abcd", "efgh").parse_peek(i)
+ }
+
+ let a = b"abcdabcdefghabcd";
+ let b = b"efghabcd";
+ let c = b"azerty";
+
+ let res_a = (vec![&b"abcd"[..], &b"abcd"[..]], &b"efgh"[..]);
+ let res_b: (Vec<&[u8]>, &[u8]) = (Vec::new(), &b"efgh"[..]);
+ assert_eq!(multi(&a[..]), Ok((&b"abcd"[..], res_a)));
+ assert_eq!(multi(&b[..]), Ok((&b"abcd"[..], res_b)));
+ assert_eq!(
+ multi(&c[..]),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &&c[..],
+ ErrorKind::Many,
+ error_position!(&&c[..], ErrorKind::Tag)
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn repeat_till_range_test() {
+ #[allow(clippy::type_complexity)]
+ fn multi(i: &str) -> IResult<&str, (Vec<&str>, &str)> {
+ repeat_till(2..=4, "ab", "cd").parse_peek(i)
+ }
+
+ assert_eq!(
+ multi("cd"),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &"cd",
+ ErrorKind::Many,
+ error_position!(&"cd", ErrorKind::Tag)
+ )))
+ );
+ assert_eq!(
+ multi("abcd"),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &"cd",
+ ErrorKind::Many,
+ error_position!(&"cd", ErrorKind::Tag)
+ )))
+ );
+ assert_eq!(multi("ababcd"), Ok(("", (vec!["ab", "ab"], "cd"))));
+ assert_eq!(multi("abababcd"), Ok(("", (vec!["ab", "ab", "ab"], "cd"))));
+ assert_eq!(
+ multi("ababababcd"),
+ Ok(("", (vec!["ab", "ab", "ab", "ab"], "cd")))
+ );
+ assert_eq!(
+ multi("abababababcd"),
+ Err(ErrMode::Backtrack(error_node_position!(
+ &"cd",
+ ErrorKind::Many,
+ error_position!(&"abcd", ErrorKind::Tag)
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "std")]
+fn infinite_many() {
+ fn tst(input: &[u8]) -> IResult<&[u8], &[u8]> {
+ println!("input: {:?}", input);
+ Err(ErrMode::Backtrack(error_position!(&input, ErrorKind::Tag)))
+ }
+
+ // should not go into an infinite loop
+ fn multi0(i: &[u8]) -> IResult<&[u8], Vec<&[u8]>> {
+ repeat(0.., unpeek(tst)).parse_peek(i)
+ }
+ let a = &b"abcdef"[..];
+ assert_eq!(multi0(a), Ok((a, Vec::new())));
+
+ fn multi1(i: &[u8]) -> IResult<&[u8], Vec<&[u8]>> {
+ repeat(1.., unpeek(tst)).parse_peek(i)
+ }
+ let a = &b"abcdef"[..];
+ assert_eq!(
+ multi1(a),
+ Err(ErrMode::Backtrack(error_position!(&a, ErrorKind::Tag)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn repeat_test() {
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(2..=4, "Abcd").parse_peek(i)
+ }
+
+ let a = &b"Abcdef"[..];
+ let b = &b"AbcdAbcdefgh"[..];
+ let c = &b"AbcdAbcdAbcdAbcdefgh"[..];
+ let d = &b"AbcdAbcdAbcdAbcdAbcdefgh"[..];
+ let e = &b"AbcdAb"[..];
+
+ assert_eq!(
+ multi(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"ef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ let res1 = vec![&b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(b)),
+ Ok((Partial::new(&b"efgh"[..]), res1))
+ );
+ let res2 = vec![&b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(c)),
+ Ok((Partial::new(&b"efgh"[..]), res2))
+ );
+ let res3 = vec![&b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(d)),
+ Ok((Partial::new(&b"Abcdefgh"[..]), res3))
+ );
+ assert_eq!(
+ multi(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn count_test() {
+ const TIMES: usize = 2;
+ fn cnt_2(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(TIMES, "abc").parse_peek(i)
+ }
+
+ assert_eq!(
+ cnt_2(Partial::new(&b"abcabcabcdef"[..])),
+ Ok((Partial::new(&b"abcdef"[..]), vec![&b"abc"[..], &b"abc"[..]]))
+ );
+ assert_eq!(
+ cnt_2(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ cnt_2(Partial::new(&b"abcab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ cnt_2(Partial::new(&b"xxx"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxx"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ cnt_2(Partial::new(&b"xxxabcabcdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxabcabcdef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ cnt_2(Partial::new(&b"abcxxxabcdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"xxxabcdef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn count_zero() {
+ const TIMES: usize = 0;
+ fn counter_2(i: &[u8]) -> IResult<&[u8], Vec<&[u8]>> {
+ repeat(TIMES, "abc").parse_peek(i)
+ }
+
+ let done = &b"abcabcabcdef"[..];
+ let parsed_done = Vec::new();
+ let rest = done;
+ let incomplete_1 = &b"ab"[..];
+ let parsed_incompl_1 = Vec::new();
+ let incomplete_2 = &b"abcab"[..];
+ let parsed_incompl_2 = Vec::new();
+ let error = &b"xxx"[..];
+ let error_remain = &b"xxx"[..];
+ let parsed_err = Vec::new();
+ let error_1 = &b"xxxabcabcdef"[..];
+ let parsed_err_1 = Vec::new();
+ let error_1_remain = &b"xxxabcabcdef"[..];
+ let error_2 = &b"abcxxxabcdef"[..];
+ let parsed_err_2 = Vec::new();
+ let error_2_remain = &b"abcxxxabcdef"[..];
+
+ assert_eq!(counter_2(done), Ok((rest, parsed_done)));
+ assert_eq!(
+ counter_2(incomplete_1),
+ Ok((incomplete_1, parsed_incompl_1))
+ );
+ assert_eq!(
+ counter_2(incomplete_2),
+ Ok((incomplete_2, parsed_incompl_2))
+ );
+ assert_eq!(counter_2(error), Ok((error_remain, parsed_err)));
+ assert_eq!(counter_2(error_1), Ok((error_1_remain, parsed_err_1)));
+ assert_eq!(counter_2(error_2), Ok((error_2_remain, parsed_err_2)));
+}
+
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub struct NilError;
+
+impl<I> From<(I, ErrorKind)> for NilError {
+ fn from(_: (I, ErrorKind)) -> Self {
+ NilError
+ }
+}
+
+impl<I> ParserError<I> for NilError {
+ fn from_error_kind(_: &I, _: ErrorKind) -> NilError {
+ NilError
+ }
+ fn append(self, _: &I, _: ErrorKind) -> NilError {
+ NilError
+ }
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn fold_repeat0_test() {
+ fn fold_into_vec<T>(mut acc: Vec<T>, item: T) -> Vec<T> {
+ acc.push(item);
+ acc
+ }
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(0.., "abcd")
+ .fold(Vec::new, fold_into_vec)
+ .parse_peek(i)
+ }
+
+ assert_eq!(
+ multi(Partial::new(&b"abcdef"[..])),
+ Ok((Partial::new(&b"ef"[..]), vec![&b"abcd"[..]]))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcdabcdefgh"[..])),
+ Ok((Partial::new(&b"efgh"[..]), vec![&b"abcd"[..], &b"abcd"[..]]))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"azerty"[..])),
+ Ok((Partial::new(&b"azerty"[..]), Vec::new()))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcdab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ multi(Partial::new(&b"abcd"[..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+ assert_eq!(
+ multi(Partial::new(&b""[..])),
+ Err(ErrMode::Incomplete(Needed::new(4)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+#[cfg_attr(debug_assertions, should_panic)]
+fn fold_repeat0_empty_test() {
+ fn fold_into_vec<T>(mut acc: Vec<T>, item: T) -> Vec<T> {
+ acc.push(item);
+ acc
+ }
+ fn multi_empty(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(0.., "").fold(Vec::new, fold_into_vec).parse_peek(i)
+ }
+
+ assert_eq!(
+ multi_empty(Partial::new(&b"abcdef"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"abcdef"[..]),
+ ErrorKind::Assert
+ )))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn fold_repeat1_test() {
+ fn fold_into_vec<T>(mut acc: Vec<T>, item: T) -> Vec<T> {
+ acc.push(item);
+ acc
+ }
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(1.., "abcd")
+ .fold(Vec::new, fold_into_vec)
+ .parse_peek(i)
+ }
+
+ let a = &b"abcdef"[..];
+ let b = &b"abcdabcdefgh"[..];
+ let c = &b"azerty"[..];
+ let d = &b"abcdab"[..];
+
+ let res1 = vec![&b"abcd"[..]];
+ assert_eq!(multi(Partial::new(a)), Ok((Partial::new(&b"ef"[..]), res1)));
+ let res2 = vec![&b"abcd"[..], &b"abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(b)),
+ Ok((Partial::new(&b"efgh"[..]), res2))
+ );
+ assert_eq!(
+ multi(Partial::new(c)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(c),
+ ErrorKind::Many
+ )))
+ );
+ assert_eq!(
+ multi(Partial::new(d)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn fold_repeat_test() {
+ fn fold_into_vec<T>(mut acc: Vec<T>, item: T) -> Vec<T> {
+ acc.push(item);
+ acc
+ }
+ fn multi(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, Vec<&[u8]>> {
+ repeat(2..=4, "Abcd")
+ .fold(Vec::new, fold_into_vec)
+ .parse_peek(i)
+ }
+
+ let a = &b"Abcdef"[..];
+ let b = &b"AbcdAbcdefgh"[..];
+ let c = &b"AbcdAbcdAbcdAbcdefgh"[..];
+ let d = &b"AbcdAbcdAbcdAbcdAbcdefgh"[..];
+ let e = &b"AbcdAb"[..];
+
+ assert_eq!(
+ multi(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"ef"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ let res1 = vec![&b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(b)),
+ Ok((Partial::new(&b"efgh"[..]), res1))
+ );
+ let res2 = vec![&b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(c)),
+ Ok((Partial::new(&b"efgh"[..]), res2))
+ );
+ let res3 = vec![&b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..], &b"Abcd"[..]];
+ assert_eq!(
+ multi(Partial::new(d)),
+ Ok((Partial::new(&b"Abcdefgh"[..]), res3))
+ );
+ assert_eq!(
+ multi(Partial::new(e)),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+}
+
+#[test]
+fn repeat0_count_test() {
+ fn count0_nums(i: &[u8]) -> IResult<&[u8], usize> {
+ repeat(0.., (digit, ",")).parse_peek(i)
+ }
+
+ assert_eq!(count0_nums(&b"123,junk"[..]), Ok((&b"junk"[..], 1)));
+
+ assert_eq!(count0_nums(&b"123,45,junk"[..]), Ok((&b"junk"[..], 2)));
+
+ assert_eq!(
+ count0_nums(&b"1,2,3,4,5,6,7,8,9,0,junk"[..]),
+ Ok((&b"junk"[..], 10))
+ );
+
+ assert_eq!(count0_nums(&b"hello"[..]), Ok((&b"hello"[..], 0)));
+}
+
+#[test]
+fn repeat1_count_test() {
+ fn count1_nums(i: &[u8]) -> IResult<&[u8], usize> {
+ repeat(1.., (digit, ",")).parse_peek(i)
+ }
+
+ assert_eq!(count1_nums(&b"123,45,junk"[..]), Ok((&b"junk"[..], 2)));
+
+ assert_eq!(
+ count1_nums(&b"1,2,3,4,5,6,7,8,9,0,junk"[..]),
+ Ok((&b"junk"[..], 10))
+ );
+
+ assert_eq!(
+ count1_nums(&b"hello"[..]),
+ Err(ErrMode::Backtrack(error_position!(
+ &&b"hello"[..],
+ ErrorKind::Slice
+ )))
+ );
+}
diff --git a/crates/winnow/src/error.rs b/crates/winnow/src/error.rs
new file mode 100644
index 0000000..3f28013
--- /dev/null
+++ b/crates/winnow/src/error.rs
@@ -0,0 +1,1467 @@
+//! # Error management
+//!
+//! Errors are designed with multiple needs in mind:
+//! - Accumulate more [context][Parser::context] as the error goes up the parser chain
+//! - Distinguish between [recoverable errors,
+//! unrecoverable errors, and more data is needed][ErrMode]
+//! - Have a very low overhead, as errors are often discarded by the calling parser (examples: `repeat`, `alt`)
+//! - Can be modified according to the user's needs, because some languages need a lot more information
+//! - Help thread-through the [stream][crate::stream]
+//!
+//! To abstract these needs away from the user, generally `winnow` parsers use the [`PResult`]
+//! alias, rather than [`Result`]. [`Parser::parse`] is a top-level operation
+//! that can help convert to a `Result` for integrating with your application's error reporting.
+//!
+//! Error types include:
+//! - `()`
+//! - [`ErrorKind`]
+//! - [`InputError`] (mostly for testing)
+//! - [`ContextError`]
+//! - [`TreeError`] (mostly for testing)
+//! - [Custom errors][crate::_topic::error]
+
+#[cfg(feature = "alloc")]
+use crate::lib::std::borrow::ToOwned;
+use crate::lib::std::fmt;
+use core::num::NonZeroUsize;
+
+use crate::stream::AsBStr;
+use crate::stream::Stream;
+#[allow(unused_imports)] // Here for intra-doc links
+use crate::Parser;
+
+/// For use with [`Parser::parse_peek`] which allows the input stream to be threaded through a
+/// parser.
+///
+/// - `Ok((I, O))` is the remaining [input][crate::stream] and the parsed value
+/// - [`Err(ErrMode<E>)`][ErrMode] is the error along with how to respond to it
+///
+/// By default, the error type (`E`) is [`InputError`]
+///
+/// When integrating into the result of the application, see
+/// - [`Parser::parse`]
+/// - [`ErrMode::into_inner`]
+pub type IResult<I, O, E = InputError<I>> = PResult<(I, O), E>;
+
+/// For use with [`Parser::parse_next`]
+///
+/// - `Ok(O)` is the parsed value
+/// - [`Err(ErrMode<E>)`][ErrMode] is the error along with how to respond to it
+///
+/// By default, the error type (`E`) is [`ContextError`].
+///
+/// When integrating into the result of the application, see
+/// - [`Parser::parse`]
+/// - [`ErrMode::into_inner`]
+pub type PResult<O, E = ContextError> = Result<O, ErrMode<E>>;
+
+/// Contains information on needed data if a parser returned `Incomplete`
+///
+/// **Note:** This is only possible for `Stream` that are [partial][`crate::stream::StreamIsPartial`],
+/// like [`Partial`][crate::Partial].
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub enum Needed {
+ /// Needs more data, but we do not know how much
+ Unknown,
+ /// Contains the required data size in bytes
+ Size(NonZeroUsize),
+}
+
+impl Needed {
+ /// Creates `Needed` instance, returns `Needed::Unknown` if the argument is zero
+ pub fn new(s: usize) -> Self {
+ match NonZeroUsize::new(s) {
+ Some(sz) => Needed::Size(sz),
+ None => Needed::Unknown,
+ }
+ }
+
+ /// Indicates if we know how many bytes we need
+ pub fn is_known(&self) -> bool {
+ *self != Needed::Unknown
+ }
+
+ /// Maps a `Needed` to `Needed` by applying a function to a contained `Size` value.
+ #[inline]
+ pub fn map<F: Fn(NonZeroUsize) -> usize>(self, f: F) -> Needed {
+ match self {
+ Needed::Unknown => Needed::Unknown,
+ Needed::Size(n) => Needed::new(f(n)),
+ }
+ }
+}
+
+/// Add parse error state to [`ParserError`]s
+#[derive(Debug, Clone, PartialEq)]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+pub enum ErrMode<E> {
+ /// There was not enough data to determine the appropriate action
+ ///
+ /// More data needs to be buffered before retrying the parse.
+ ///
+ /// This must only be set when the [`Stream`] is [partial][`crate::stream::StreamIsPartial`], like with
+ /// [`Partial`][crate::Partial]
+ ///
+ /// Convert this into an `Backtrack` with [`Parser::complete_err`]
+ Incomplete(Needed),
+ /// The parser failed with a recoverable error (the default).
+ ///
+ /// For example, a parser for json values might include a
+ /// [`dec_uint`][crate::ascii::dec_uint] as one case in an [`alt`][crate::combinator::alt]
+ /// combinator. If it fails, the next case should be tried.
+ Backtrack(E),
+ /// The parser had an unrecoverable error.
+ ///
+ /// The parser was on the right branch, so directly report it to the user rather than trying
+ /// other branches. You can use [`cut_err()`][crate::combinator::cut_err] combinator to switch
+ /// from `ErrMode::Backtrack` to `ErrMode::Cut`.
+ ///
+ /// For example, one case in an [`alt`][crate::combinator::alt] combinator found a unique prefix
+ /// and you want any further errors parsing the case to be reported to the user.
+ Cut(E),
+}
+
+impl<E> ErrMode<E> {
+ /// Tests if the result is Incomplete
+ #[inline]
+ pub fn is_incomplete(&self) -> bool {
+ matches!(self, ErrMode::Incomplete(_))
+ }
+
+ /// Prevent backtracking, bubbling the error up to the top
+ pub fn cut(self) -> Self {
+ match self {
+ ErrMode::Backtrack(e) => ErrMode::Cut(e),
+ rest => rest,
+ }
+ }
+
+ /// Enable backtracking support
+ pub fn backtrack(self) -> Self {
+ match self {
+ ErrMode::Cut(e) => ErrMode::Backtrack(e),
+ rest => rest,
+ }
+ }
+
+ /// Applies the given function to the inner error
+ pub fn map<E2, F>(self, f: F) -> ErrMode<E2>
+ where
+ F: FnOnce(E) -> E2,
+ {
+ match self {
+ ErrMode::Incomplete(n) => ErrMode::Incomplete(n),
+ ErrMode::Cut(t) => ErrMode::Cut(f(t)),
+ ErrMode::Backtrack(t) => ErrMode::Backtrack(f(t)),
+ }
+ }
+
+ /// Automatically converts between errors if the underlying type supports it
+ pub fn convert<F>(self) -> ErrMode<F>
+ where
+ E: ErrorConvert<F>,
+ {
+ self.map(ErrorConvert::convert)
+ }
+
+ /// Unwrap the mode, returning the underlying error
+ ///
+ /// Returns `None` for [`ErrMode::Incomplete`]
+ #[cfg_attr(debug_assertions, track_caller)]
+ #[inline(always)]
+ pub fn into_inner(self) -> Option<E> {
+ match self {
+ ErrMode::Backtrack(e) | ErrMode::Cut(e) => Some(e),
+ ErrMode::Incomplete(_) => None,
+ }
+ }
+}
+
+impl<I, E: ParserError<I>> ParserError<I> for ErrMode<E> {
+ #[inline(always)]
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ ErrMode::Backtrack(E::from_error_kind(input, kind))
+ }
+
+ #[cfg_attr(debug_assertions, track_caller)]
+ #[inline(always)]
+ fn assert(input: &I, message: &'static str) -> Self
+ where
+ I: crate::lib::std::fmt::Debug,
+ {
+ ErrMode::Backtrack(E::assert(input, message))
+ }
+
+ #[inline]
+ fn append(self, input: &I, kind: ErrorKind) -> Self {
+ match self {
+ ErrMode::Backtrack(e) => ErrMode::Backtrack(e.append(input, kind)),
+ e => e,
+ }
+ }
+
+ fn or(self, other: Self) -> Self {
+ match (self, other) {
+ (ErrMode::Backtrack(e), ErrMode::Backtrack(o)) => ErrMode::Backtrack(e.or(o)),
+ (ErrMode::Incomplete(e), _) | (_, ErrMode::Incomplete(e)) => ErrMode::Incomplete(e),
+ (ErrMode::Cut(e), _) | (_, ErrMode::Cut(e)) => ErrMode::Cut(e),
+ }
+ }
+}
+
+impl<I, EXT, E> FromExternalError<I, EXT> for ErrMode<E>
+where
+ E: FromExternalError<I, EXT>,
+{
+ #[inline(always)]
+ fn from_external_error(input: &I, kind: ErrorKind, e: EXT) -> Self {
+ ErrMode::Backtrack(E::from_external_error(input, kind, e))
+ }
+}
+
+impl<I, C, E: AddContext<I, C>> AddContext<I, C> for ErrMode<E> {
+ #[inline(always)]
+ fn add_context(self, input: &I, ctx: C) -> Self {
+ self.map(|err| err.add_context(input, ctx))
+ }
+}
+
+impl<T: Clone> ErrMode<InputError<T>> {
+ /// Maps `ErrMode<InputError<T>>` to `ErrMode<InputError<U>>` with the given `F: T -> U`
+ pub fn map_input<U: Clone, F>(self, f: F) -> ErrMode<InputError<U>>
+ where
+ F: FnOnce(T) -> U,
+ {
+ match self {
+ ErrMode::Incomplete(n) => ErrMode::Incomplete(n),
+ ErrMode::Cut(InputError { input, kind }) => ErrMode::Cut(InputError {
+ input: f(input),
+ kind,
+ }),
+ ErrMode::Backtrack(InputError { input, kind }) => ErrMode::Backtrack(InputError {
+ input: f(input),
+ kind,
+ }),
+ }
+ }
+}
+
+impl<E: Eq> Eq for ErrMode<E> {}
+
+impl<E> fmt::Display for ErrMode<E>
+where
+ E: fmt::Debug,
+{
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ ErrMode::Incomplete(Needed::Size(u)) => write!(f, "Parsing requires {} bytes/chars", u),
+ ErrMode::Incomplete(Needed::Unknown) => write!(f, "Parsing requires more data"),
+ ErrMode::Cut(c) => write!(f, "Parsing Failure: {:?}", c),
+ ErrMode::Backtrack(c) => write!(f, "Parsing Error: {:?}", c),
+ }
+ }
+}
+
+/// The basic [`Parser`] trait for errors
+///
+/// It provides methods to create an error from some combinators,
+/// and combine existing errors in combinators like `alt`.
+pub trait ParserError<I>: Sized {
+ /// Creates an error from the input position and an [`ErrorKind`]
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self;
+
+ /// Process a parser assertion
+ #[cfg_attr(debug_assertions, track_caller)]
+ fn assert(input: &I, _message: &'static str) -> Self
+ where
+ I: crate::lib::std::fmt::Debug,
+ {
+ #[cfg(debug_assertions)]
+ panic!("assert `{}` failed at {:#?}", _message, input);
+ #[cfg(not(debug_assertions))]
+ Self::from_error_kind(input, ErrorKind::Assert)
+ }
+
+ /// Like [`ParserError::from_error_kind`] but merges it with the existing error.
+ ///
+ /// This is useful when backtracking through a parse tree, accumulating error context on the
+ /// way.
+ fn append(self, input: &I, kind: ErrorKind) -> Self;
+
+ /// Combines errors from two different parse branches.
+ ///
+ /// For example, this would be used by [`alt`][crate::combinator::alt] to report the error from
+ /// each case.
+ #[inline]
+ fn or(self, other: Self) -> Self {
+ other
+ }
+}
+
+/// Used by [`Parser::context`] to add custom data to error while backtracking
+///
+/// May be implemented multiple times for different kinds of context.
+pub trait AddContext<I, C = &'static str>: Sized {
+ /// Append to an existing error custom data
+ ///
+ /// This is used mainly by [`Parser::context`], to add user friendly information
+ /// to errors when backtracking through a parse tree
+ #[inline]
+ fn add_context(self, _input: &I, _ctx: C) -> Self {
+ self
+ }
+}
+
+/// Capture context from when an error was recovered
+pub trait FromRecoverableError<I: Stream, E> {
+ /// Capture context from when an error was recovered
+ fn from_recoverable_error(
+ token_start: &<I as Stream>::Checkpoint,
+ err_start: &<I as Stream>::Checkpoint,
+ input: &I,
+ e: E,
+ ) -> Self;
+}
+
+/// Create a new error with an external error, from [`std::str::FromStr`]
+///
+/// This trait is required by the [`Parser::try_map`] combinator.
+pub trait FromExternalError<I, E> {
+ /// Like [`ParserError::from_error_kind`] but also include an external error.
+ fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self;
+}
+
+/// Equivalent of `From` implementation to avoid orphan rules in bits parsers
+pub trait ErrorConvert<E> {
+ /// Transform to another error type
+ fn convert(self) -> E;
+}
+
+/// Capture input on error
+///
+/// This is useful for testing of generic parsers to ensure the error happens at the right
+/// location.
+///
+/// **Note:** [context][Parser::context] and inner errors (like from [`Parser::try_map`]) will be
+/// dropped.
+#[derive(Copy, Clone, Debug, Eq, PartialEq)]
+pub struct InputError<I: Clone> {
+ /// The input stream, pointing to the location where the error occurred
+ pub input: I,
+ /// A rudimentary error kind
+ pub kind: ErrorKind,
+}
+
+impl<I: Clone> InputError<I> {
+ /// Creates a new basic error
+ #[inline]
+ pub fn new(input: I, kind: ErrorKind) -> Self {
+ Self { input, kind }
+ }
+
+ /// Translate the input type
+ #[inline]
+ pub fn map_input<I2: Clone, O: Fn(I) -> I2>(self, op: O) -> InputError<I2> {
+ InputError {
+ input: op(self.input),
+ kind: self.kind,
+ }
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<'i, I: ToOwned> InputError<&'i I>
+where
+ <I as ToOwned>::Owned: Clone,
+{
+ /// Obtaining ownership
+ pub fn into_owned(self) -> InputError<<I as ToOwned>::Owned> {
+ self.map_input(ToOwned::to_owned)
+ }
+}
+
+impl<I: Clone> ParserError<I> for InputError<I> {
+ #[inline]
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ Self {
+ input: input.clone(),
+ kind,
+ }
+ }
+
+ #[inline]
+ fn append(self, _: &I, _: ErrorKind) -> Self {
+ self
+ }
+}
+
+impl<I: Clone, C> AddContext<I, C> for InputError<I> {}
+
+impl<I: Clone + Stream> FromRecoverableError<I, Self> for InputError<I> {
+ #[inline]
+ fn from_recoverable_error(
+ _token_start: &<I as Stream>::Checkpoint,
+ _err_start: &<I as Stream>::Checkpoint,
+ _input: &I,
+ e: Self,
+ ) -> Self {
+ e
+ }
+}
+
+impl<I: Clone, E> FromExternalError<I, E> for InputError<I> {
+ /// Create a new error from an input position and an external error
+ #[inline]
+ fn from_external_error(input: &I, kind: ErrorKind, _e: E) -> Self {
+ Self {
+ input: input.clone(),
+ kind,
+ }
+ }
+}
+
+impl<I: Clone> ErrorConvert<InputError<(I, usize)>> for InputError<I> {
+ #[inline]
+ fn convert(self) -> InputError<(I, usize)> {
+ InputError {
+ input: (self.input, 0),
+ kind: self.kind,
+ }
+ }
+}
+
+impl<I: Clone> ErrorConvert<InputError<I>> for InputError<(I, usize)> {
+ #[inline]
+ fn convert(self) -> InputError<I> {
+ InputError {
+ input: self.input.0,
+ kind: self.kind,
+ }
+ }
+}
+
+/// The Display implementation allows the `std::error::Error` implementation
+impl<I: Clone + fmt::Display> fmt::Display for InputError<I> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(
+ f,
+ "{} error starting at: {}",
+ self.kind.description(),
+ self.input
+ )
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I: Clone + fmt::Debug + fmt::Display + Sync + Send + 'static> std::error::Error
+ for InputError<I>
+{
+}
+
+impl<I> ParserError<I> for () {
+ #[inline]
+ fn from_error_kind(_: &I, _: ErrorKind) -> Self {}
+
+ #[inline]
+ fn append(self, _: &I, _: ErrorKind) -> Self {}
+}
+
+impl<I, C> AddContext<I, C> for () {}
+
+impl<I: Stream> FromRecoverableError<I, Self> for () {
+ #[inline]
+ fn from_recoverable_error(
+ _token_start: &<I as Stream>::Checkpoint,
+ _err_start: &<I as Stream>::Checkpoint,
+ _input: &I,
+ (): Self,
+ ) -> Self {
+ }
+}
+
+impl<I, E> FromExternalError<I, E> for () {
+ #[inline]
+ fn from_external_error(_input: &I, _kind: ErrorKind, _e: E) -> Self {}
+}
+
+impl ErrorConvert<()> for () {
+ #[inline]
+ fn convert(self) {}
+}
+
+/// Accumulate context while backtracking errors
+#[derive(Debug)]
+pub struct ContextError<C = StrContext> {
+ #[cfg(feature = "alloc")]
+ context: crate::lib::std::vec::Vec<C>,
+ #[cfg(not(feature = "alloc"))]
+ context: core::marker::PhantomData<C>,
+ #[cfg(feature = "std")]
+ cause: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
+}
+
+impl<C> ContextError<C> {
+ /// Create an empty error
+ #[inline]
+ pub fn new() -> Self {
+ Self {
+ context: Default::default(),
+ #[cfg(feature = "std")]
+ cause: None,
+ }
+ }
+
+ /// Access context from [`Parser::context`]
+ #[inline]
+ #[cfg(feature = "alloc")]
+ pub fn context(&self) -> impl Iterator<Item = &C> {
+ self.context.iter()
+ }
+
+ /// Originating [`std::error::Error`]
+ #[inline]
+ #[cfg(feature = "std")]
+ pub fn cause(&self) -> Option<&(dyn std::error::Error + Send + Sync + 'static)> {
+ self.cause.as_deref()
+ }
+}
+
+impl<C: Clone> Clone for ContextError<C> {
+ fn clone(&self) -> Self {
+ Self {
+ context: self.context.clone(),
+ #[cfg(feature = "std")]
+ cause: self.cause.as_ref().map(|e| e.to_string().into()),
+ }
+ }
+}
+
+impl<C> Default for ContextError<C> {
+ #[inline]
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl<I, C> ParserError<I> for ContextError<C> {
+ #[inline]
+ fn from_error_kind(_input: &I, _kind: ErrorKind) -> Self {
+ Self::new()
+ }
+
+ #[inline]
+ fn append(self, _input: &I, _kind: ErrorKind) -> Self {
+ self
+ }
+
+ #[inline]
+ fn or(self, other: Self) -> Self {
+ other
+ }
+}
+
+impl<C, I> AddContext<I, C> for ContextError<C> {
+ #[inline]
+ fn add_context(mut self, _input: &I, ctx: C) -> Self {
+ #[cfg(feature = "alloc")]
+ self.context.push(ctx);
+ self
+ }
+}
+
+impl<I: Stream, C> FromRecoverableError<I, Self> for ContextError<C> {
+ #[inline]
+ fn from_recoverable_error(
+ _token_start: &<I as Stream>::Checkpoint,
+ _err_start: &<I as Stream>::Checkpoint,
+ _input: &I,
+ e: Self,
+ ) -> Self {
+ e
+ }
+}
+
+#[cfg(feature = "std")]
+impl<C, I, E: std::error::Error + Send + Sync + 'static> FromExternalError<I, E>
+ for ContextError<C>
+{
+ #[inline]
+ fn from_external_error(_input: &I, _kind: ErrorKind, e: E) -> Self {
+ let mut err = Self::new();
+ {
+ err.cause = Some(Box::new(e));
+ }
+ err
+ }
+}
+
+// HACK: This is more general than `std`, making the features non-additive
+#[cfg(not(feature = "std"))]
+impl<C, I, E: Send + Sync + 'static> FromExternalError<I, E> for ContextError<C> {
+ #[inline]
+ fn from_external_error(_input: &I, _kind: ErrorKind, _e: E) -> Self {
+ let err = Self::new();
+ err
+ }
+}
+
+// For tests
+impl<C: core::cmp::PartialEq> core::cmp::PartialEq for ContextError<C> {
+ fn eq(&self, other: &Self) -> bool {
+ #[cfg(feature = "alloc")]
+ {
+ if self.context != other.context {
+ return false;
+ }
+ }
+ #[cfg(feature = "std")]
+ {
+ if self.cause.as_ref().map(ToString::to_string)
+ != other.cause.as_ref().map(ToString::to_string)
+ {
+ return false;
+ }
+ }
+
+ true
+ }
+}
+
+impl crate::lib::std::fmt::Display for ContextError<StrContext> {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ #[cfg(feature = "alloc")]
+ {
+ let expression = self.context().find_map(|c| match c {
+ StrContext::Label(c) => Some(c),
+ _ => None,
+ });
+ let expected = self
+ .context()
+ .filter_map(|c| match c {
+ StrContext::Expected(c) => Some(c),
+ _ => None,
+ })
+ .collect::<crate::lib::std::vec::Vec<_>>();
+
+ let mut newline = false;
+
+ if let Some(expression) = expression {
+ newline = true;
+
+ write!(f, "invalid {}", expression)?;
+ }
+
+ if !expected.is_empty() {
+ if newline {
+ writeln!(f)?;
+ }
+ newline = true;
+
+ write!(f, "expected ")?;
+ for (i, expected) in expected.iter().enumerate() {
+ if i != 0 {
+ write!(f, ", ")?;
+ }
+ write!(f, "{}", expected)?;
+ }
+ }
+ #[cfg(feature = "std")]
+ {
+ if let Some(cause) = self.cause() {
+ if newline {
+ writeln!(f)?;
+ }
+ write!(f, "{}", cause)?;
+ }
+ }
+ }
+
+ Ok(())
+ }
+}
+
+/// Additional parse context for [`ContextError`] added via [`Parser::context`]
+#[derive(Clone, Debug, PartialEq, Eq)]
+#[non_exhaustive]
+pub enum StrContext {
+ /// Description of what is currently being parsed
+ Label(&'static str),
+ /// Grammar item that was expected
+ Expected(StrContextValue),
+}
+
+impl crate::lib::std::fmt::Display for StrContext {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ match self {
+ Self::Label(name) => write!(f, "invalid {name}"),
+ Self::Expected(value) => write!(f, "expected {value}"),
+ }
+ }
+}
+
+/// See [`StrContext`]
+#[derive(Clone, Debug, PartialEq, Eq)]
+#[non_exhaustive]
+pub enum StrContextValue {
+ /// A [`char`] token
+ CharLiteral(char),
+ /// A [`&str`] token
+ StringLiteral(&'static str),
+ /// A description of what was being parsed
+ Description(&'static str),
+}
+
+impl From<char> for StrContextValue {
+ #[inline]
+ fn from(inner: char) -> Self {
+ Self::CharLiteral(inner)
+ }
+}
+
+impl From<&'static str> for StrContextValue {
+ #[inline]
+ fn from(inner: &'static str) -> Self {
+ Self::StringLiteral(inner)
+ }
+}
+
+impl crate::lib::std::fmt::Display for StrContextValue {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ match self {
+ Self::CharLiteral('\n') => "newline".fmt(f),
+ Self::CharLiteral('`') => "'`'".fmt(f),
+ Self::CharLiteral(c) if c.is_ascii_control() => {
+ write!(f, "`{}`", c.escape_debug())
+ }
+ Self::CharLiteral(c) => write!(f, "`{}`", c),
+ Self::StringLiteral(c) => write!(f, "`{}`", c),
+ Self::Description(c) => write!(f, "{}", c),
+ }
+ }
+}
+
+/// Trace all error paths, particularly for tests
+#[derive(Debug)]
+#[cfg(feature = "std")]
+pub enum TreeError<I, C = StrContext> {
+ /// Initial error that kicked things off
+ Base(TreeErrorBase<I>),
+ /// Traces added to the error while walking back up the stack
+ Stack {
+ /// Initial error that kicked things off
+ base: Box<Self>,
+ /// Traces added to the error while walking back up the stack
+ stack: Vec<TreeErrorFrame<I, C>>,
+ },
+ /// All failed branches of an `alt`
+ Alt(Vec<Self>),
+}
+
+/// See [`TreeError::Stack`]
+#[derive(Debug)]
+#[cfg(feature = "std")]
+pub enum TreeErrorFrame<I, C = StrContext> {
+ /// See [`ParserError::append`]
+ Kind(TreeErrorBase<I>),
+ /// See [`AddContext::add_context`]
+ Context(TreeErrorContext<I, C>),
+}
+
+/// See [`TreeErrorFrame::Kind`], [`ParserError::append`]
+#[derive(Debug)]
+#[cfg(feature = "std")]
+pub struct TreeErrorBase<I> {
+ /// Parsed input, at the location where the error occurred
+ pub input: I,
+ /// Debug context
+ pub kind: ErrorKind,
+ /// See [`FromExternalError::from_external_error`]
+ pub cause: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
+}
+
+/// See [`TreeErrorFrame::Context`], [`AddContext::add_context`]
+#[derive(Debug)]
+#[cfg(feature = "std")]
+pub struct TreeErrorContext<I, C = StrContext> {
+ /// Parsed input, at the location where the error occurred
+ pub input: I,
+ /// See [`AddContext::add_context`]
+ pub context: C,
+}
+
+#[cfg(feature = "std")]
+impl<'i, I: ToOwned, C> TreeError<&'i I, C>
+where
+ <I as ToOwned>::Owned: Clone,
+{
+ /// Obtaining ownership
+ pub fn into_owned(self) -> TreeError<<I as ToOwned>::Owned, C> {
+ self.map_input(ToOwned::to_owned)
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I, C> TreeError<I, C>
+where
+ I: Clone,
+{
+ /// Translate the input type
+ pub fn map_input<I2: Clone, O: Clone + Fn(I) -> I2>(self, op: O) -> TreeError<I2, C> {
+ match self {
+ TreeError::Base(base) => TreeError::Base(TreeErrorBase {
+ input: op(base.input),
+ kind: base.kind,
+ cause: base.cause,
+ }),
+ TreeError::Stack { base, stack } => {
+ let base = Box::new(base.map_input(op.clone()));
+ let stack = stack
+ .into_iter()
+ .map(|frame| match frame {
+ TreeErrorFrame::Kind(kind) => TreeErrorFrame::Kind(TreeErrorBase {
+ input: op(kind.input),
+ kind: kind.kind,
+ cause: kind.cause,
+ }),
+ TreeErrorFrame::Context(context) => {
+ TreeErrorFrame::Context(TreeErrorContext {
+ input: op(context.input),
+ context: context.context,
+ })
+ }
+ })
+ .collect();
+ TreeError::Stack { base, stack }
+ }
+ TreeError::Alt(alt) => {
+ TreeError::Alt(alt.into_iter().map(|e| e.map_input(op.clone())).collect())
+ }
+ }
+ }
+
+ fn append_frame(self, frame: TreeErrorFrame<I, C>) -> Self {
+ match self {
+ TreeError::Stack { base, mut stack } => {
+ stack.push(frame);
+ TreeError::Stack { base, stack }
+ }
+ base => TreeError::Stack {
+ base: Box::new(base),
+ stack: vec![frame],
+ },
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I, C> ParserError<I> for TreeError<I, C>
+where
+ I: Clone,
+{
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ TreeError::Base(TreeErrorBase {
+ input: input.clone(),
+ kind,
+ cause: None,
+ })
+ }
+
+ fn append(self, input: &I, kind: ErrorKind) -> Self {
+ let frame = TreeErrorFrame::Kind(TreeErrorBase {
+ input: input.clone(),
+ kind,
+ cause: None,
+ });
+ self.append_frame(frame)
+ }
+
+ fn or(self, other: Self) -> Self {
+ match (self, other) {
+ (TreeError::Alt(mut first), TreeError::Alt(second)) => {
+ // Just in case an implementation does a divide-and-conquer algorithm
+ //
+ // To prevent mixing `alt`s at different levels, parsers should
+ // `alt_err.append(input, ErrorKind::Alt)`.
+ first.extend(second);
+ TreeError::Alt(first)
+ }
+ (TreeError::Alt(mut alt), new) | (new, TreeError::Alt(mut alt)) => {
+ alt.push(new);
+ TreeError::Alt(alt)
+ }
+ (first, second) => TreeError::Alt(vec![first, second]),
+ }
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I, C> AddContext<I, C> for TreeError<I, C>
+where
+ I: Clone,
+{
+ fn add_context(self, input: &I, context: C) -> Self {
+ let frame = TreeErrorFrame::Context(TreeErrorContext {
+ input: input.clone(),
+ context,
+ });
+ self.append_frame(frame)
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I: Clone + Stream, C> FromRecoverableError<I, Self> for TreeError<I, C> {
+ #[inline]
+ fn from_recoverable_error(
+ _token_start: &<I as Stream>::Checkpoint,
+ _err_start: &<I as Stream>::Checkpoint,
+ _input: &I,
+ e: Self,
+ ) -> Self {
+ e
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I, C, E: std::error::Error + Send + Sync + 'static> FromExternalError<I, E> for TreeError<I, C>
+where
+ I: Clone,
+{
+ fn from_external_error(input: &I, kind: ErrorKind, e: E) -> Self {
+ TreeError::Base(TreeErrorBase {
+ input: input.clone(),
+ kind,
+ cause: Some(Box::new(e)),
+ })
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I, C> TreeError<I, C>
+where
+ I: Clone + crate::lib::std::fmt::Display,
+ C: fmt::Display,
+{
+ fn write(&self, f: &mut fmt::Formatter<'_>, indent: usize) -> fmt::Result {
+ let child_indent = indent + 2;
+ match self {
+ TreeError::Base(base) => {
+ writeln!(f, "{:indent$}{base}", "")?;
+ }
+ TreeError::Stack { base, stack } => {
+ base.write(f, indent)?;
+ for (level, frame) in stack.iter().enumerate() {
+ match frame {
+ TreeErrorFrame::Kind(frame) => {
+ writeln!(f, "{:child_indent$}{level}: {frame}", "")?;
+ }
+ TreeErrorFrame::Context(frame) => {
+ writeln!(f, "{:child_indent$}{level}: {frame}", "")?;
+ }
+ }
+ }
+ }
+ TreeError::Alt(alt) => {
+ writeln!(f, "{:indent$}during one of:", "")?;
+ for child in alt {
+ child.write(f, child_indent)?;
+ }
+ }
+ }
+
+ Ok(())
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I: Clone + fmt::Display> fmt::Display for TreeErrorBase<I> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if let Some(cause) = self.cause.as_ref() {
+ write!(f, "caused by {cause}")?;
+ } else {
+ let kind = self.kind.description();
+ write!(f, "in {kind}")?;
+ }
+ let input = abbreviate(self.input.to_string());
+ write!(f, " at '{input}'")?;
+ Ok(())
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I: Clone + fmt::Display, C: fmt::Display> fmt::Display for TreeErrorContext<I, C> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let context = &self.context;
+ let input = abbreviate(self.input.to_string());
+ write!(f, "{context} at '{input}'")?;
+ Ok(())
+ }
+}
+
+#[cfg(feature = "std")]
+impl<
+ I: Clone + fmt::Debug + fmt::Display + Sync + Send + 'static,
+ C: fmt::Display + fmt::Debug,
+ > std::error::Error for TreeError<I, C>
+{
+}
+
+#[cfg(feature = "std")]
+fn abbreviate(input: String) -> String {
+ let mut abbrev = None;
+
+ if let Some((line, _)) = input.split_once('\n') {
+ abbrev = Some(line);
+ }
+
+ let max_len = 20;
+ let current = abbrev.unwrap_or(&input);
+ if max_len < current.len() {
+ if let Some((index, _)) = current.char_indices().nth(max_len) {
+ abbrev = Some(¤t[..index]);
+ }
+ }
+
+ if let Some(abbrev) = abbrev {
+ format!("{abbrev}...")
+ } else {
+ input
+ }
+}
+
+#[cfg(feature = "std")]
+impl<I: Clone + fmt::Display, C: fmt::Display> fmt::Display for TreeError<I, C> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ self.write(f, 0)
+ }
+}
+
+/// Deprecated, replaced with [`ContextError`]
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+#[deprecated(since = "0.5.8", note = "Replaced with `ContextError`")]
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct VerboseError<I: Clone, C = &'static str> {
+ /// Accumulated error information
+ pub errors: crate::lib::std::vec::Vec<(I, VerboseErrorKind<C>)>,
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<'i, I: ToOwned, C> VerboseError<&'i I, C>
+where
+ <I as ToOwned>::Owned: Clone,
+{
+ /// Obtaining ownership
+ pub fn into_owned(self) -> VerboseError<<I as ToOwned>::Owned, C> {
+ self.map_input(ToOwned::to_owned)
+ }
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<I: Clone, C> VerboseError<I, C> {
+ /// Translate the input type
+ pub fn map_input<I2: Clone, O>(self, op: O) -> VerboseError<I2, C>
+ where
+ O: Fn(I) -> I2,
+ {
+ VerboseError {
+ errors: self.errors.into_iter().map(|(i, k)| (op(i), k)).collect(),
+ }
+ }
+}
+
+/// Deprecated, replaced with [`ContextError`]
+#[cfg(feature = "std")]
+#[deprecated(since = "0.5.8", note = "Replaced with `ContextError`")]
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum VerboseErrorKind<C = &'static str> {
+ /// Static string added by the `context` function
+ Context(C),
+ /// Error kind given by various parsers
+ Winnow(ErrorKind),
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<I: Clone, C> ParserError<I> for VerboseError<I, C> {
+ fn from_error_kind(input: &I, kind: ErrorKind) -> Self {
+ VerboseError {
+ errors: vec![(input.clone(), VerboseErrorKind::Winnow(kind))],
+ }
+ }
+
+ fn append(mut self, input: &I, kind: ErrorKind) -> Self {
+ self.errors
+ .push((input.clone(), VerboseErrorKind::Winnow(kind)));
+ self
+ }
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<I: Clone, C> AddContext<I, C> for VerboseError<I, C> {
+ fn add_context(mut self, input: &I, ctx: C) -> Self {
+ self.errors
+ .push((input.clone(), VerboseErrorKind::Context(ctx)));
+ self
+ }
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<I: Clone, C, E> FromExternalError<I, E> for VerboseError<I, C> {
+ /// Create a new error from an input position and an external error
+ fn from_external_error(input: &I, kind: ErrorKind, _e: E) -> Self {
+ Self::from_error_kind(input, kind)
+ }
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<I: Clone + fmt::Display, C: fmt::Display> fmt::Display for VerboseError<I, C> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ writeln!(f, "Parse error:")?;
+ for (input, error) in &self.errors {
+ match error {
+ VerboseErrorKind::Winnow(e) => writeln!(f, "{} at: {}", e.description(), input)?,
+ VerboseErrorKind::Context(s) => writeln!(f, "in section '{}', at: {}", s, input)?,
+ }
+ }
+
+ Ok(())
+ }
+}
+
+#[cfg(feature = "std")]
+#[allow(deprecated)]
+impl<
+ I: Clone + fmt::Debug + fmt::Display + Sync + Send + 'static,
+ C: fmt::Display + fmt::Debug,
+ > std::error::Error for VerboseError<I, C>
+{
+}
+
+/// Provide some minor debug context for errors
+#[rustfmt::skip]
+#[derive(Debug,PartialEq,Eq,Hash,Clone,Copy)]
+#[allow(missing_docs)]
+pub enum ErrorKind {
+ Assert,
+ Token,
+ Tag,
+ Alt,
+ Many,
+ Eof,
+ Slice,
+ Complete,
+ Not,
+ Verify,
+ Fail,
+}
+
+impl ErrorKind {
+ #[rustfmt::skip]
+ /// Converts an `ErrorKind` to a text description
+ pub fn description(&self) -> &str {
+ match *self {
+ ErrorKind::Assert => "assert",
+ ErrorKind::Token => "token",
+ ErrorKind::Tag => "tag",
+ ErrorKind::Alt => "alternative",
+ ErrorKind::Many => "many",
+ ErrorKind::Eof => "end of file",
+ ErrorKind::Slice => "slice",
+ ErrorKind::Complete => "complete",
+ ErrorKind::Not => "negation",
+ ErrorKind::Verify => "predicate verification",
+ ErrorKind::Fail => "fail",
+ }
+ }
+}
+
+impl<I> ParserError<I> for ErrorKind {
+ #[inline]
+ fn from_error_kind(_input: &I, kind: ErrorKind) -> Self {
+ kind
+ }
+
+ #[inline]
+ fn append(self, _: &I, _: ErrorKind) -> Self {
+ self
+ }
+}
+
+impl<I, C> AddContext<I, C> for ErrorKind {}
+
+impl<I, E> FromExternalError<I, E> for ErrorKind {
+ /// Create a new error from an input position and an external error
+ #[inline]
+ fn from_external_error(_input: &I, kind: ErrorKind, _e: E) -> Self {
+ kind
+ }
+}
+
+/// The Display implementation allows the `std::error::Error` implementation
+impl fmt::Display for ErrorKind {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "error {:?}", self)
+ }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for ErrorKind {}
+
+/// See [`Parser::parse`]
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct ParseError<I, E> {
+ input: I,
+ offset: usize,
+ inner: E,
+}
+
+impl<I: Stream, E: ParserError<I>> ParseError<I, E> {
+ pub(crate) fn new(mut input: I, start: I::Checkpoint, inner: E) -> Self {
+ let offset = input.offset_from(&start);
+ input.reset(start);
+ Self {
+ input,
+ offset,
+ inner,
+ }
+ }
+}
+
+impl<I, E> ParseError<I, E> {
+ /// The [`Stream`] at the initial location when parsing started
+ #[inline]
+ pub fn input(&self) -> &I {
+ &self.input
+ }
+
+ /// The location in [`ParseError::input`] where parsing failed
+ ///
+ /// **Note:** This is an offset, not an index, and may point to the end of input
+ /// (`input.len()`) on eof errors.
+ #[inline]
+ pub fn offset(&self) -> usize {
+ self.offset
+ }
+
+ /// The original [`ParserError`]
+ #[inline]
+ pub fn inner(&self) -> &E {
+ &self.inner
+ }
+
+ /// The original [`ParserError`]
+ #[inline]
+ pub fn into_inner(self) -> E {
+ self.inner
+ }
+}
+
+impl<I, E> core::fmt::Display for ParseError<I, E>
+where
+ I: AsBStr,
+ E: core::fmt::Display,
+{
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ let input = self.input.as_bstr();
+ let span_start = self.offset;
+ let span_end = span_start;
+ #[cfg(feature = "std")]
+ if input.contains(&b'\n') {
+ let (line_idx, col_idx) = translate_position(input, span_start);
+ let line_num = line_idx + 1;
+ let col_num = col_idx + 1;
+ let gutter = line_num.to_string().len();
+ let content = input
+ .split(|c| *c == b'\n')
+ .nth(line_idx)
+ .expect("valid line number");
+
+ writeln!(f, "parse error at line {}, column {}", line_num, col_num)?;
+ // |
+ for _ in 0..gutter {
+ write!(f, " ")?;
+ }
+ writeln!(f, " |")?;
+
+ // 1 | 00:32:00.a999999
+ write!(f, "{} | ", line_num)?;
+ writeln!(f, "{}", String::from_utf8_lossy(content))?;
+
+ // | ^
+ for _ in 0..gutter {
+ write!(f, " ")?;
+ }
+ write!(f, " | ")?;
+ for _ in 0..col_idx {
+ write!(f, " ")?;
+ }
+ // The span will be empty at eof, so we need to make sure we always print at least
+ // one `^`
+ write!(f, "^")?;
+ for _ in (span_start + 1)..(span_end.min(span_start + content.len())) {
+ write!(f, "^")?;
+ }
+ writeln!(f)?;
+ } else {
+ let content = input;
+ writeln!(f, "{}", String::from_utf8_lossy(content))?;
+ for _ in 0..span_start {
+ write!(f, " ")?;
+ }
+ // The span will be empty at eof, so we need to make sure we always print at least
+ // one `^`
+ write!(f, "^")?;
+ for _ in (span_start + 1)..(span_end.min(span_start + content.len())) {
+ write!(f, "^")?;
+ }
+ writeln!(f)?;
+ }
+ write!(f, "{}", self.inner)?;
+
+ Ok(())
+ }
+}
+
+#[cfg(feature = "std")]
+fn translate_position(input: &[u8], index: usize) -> (usize, usize) {
+ if input.is_empty() {
+ return (0, index);
+ }
+
+ let safe_index = index.min(input.len() - 1);
+ let column_offset = index - safe_index;
+ let index = safe_index;
+
+ let nl = input[0..index]
+ .iter()
+ .rev()
+ .enumerate()
+ .find(|(_, b)| **b == b'\n')
+ .map(|(nl, _)| index - nl - 1);
+ let line_start = match nl {
+ Some(nl) => nl + 1,
+ None => 0,
+ };
+ let line = input[0..line_start].iter().filter(|b| **b == b'\n').count();
+
+ // HACK: This treats byte offset and column offsets the same
+ let column = crate::lib::std::str::from_utf8(&input[line_start..=index])
+ .map(|s| s.chars().count() - 1)
+ .unwrap_or_else(|_| index - line_start);
+ let column = column + column_offset;
+
+ (line, column)
+}
+
+#[cfg(test)]
+#[cfg(feature = "std")]
+mod test_parse_error {
+ use super::*;
+
+ #[test]
+ fn single_line() {
+ let mut input = "0xZ123";
+ let start = input.checkpoint();
+ let _ = input.next_token().unwrap();
+ let _ = input.next_token().unwrap();
+ let inner = InputError::new(input, ErrorKind::Slice);
+ let error = ParseError::new(input, start, inner);
+ let expected = "\
+0xZ123
+ ^
+slice error starting at: Z123";
+ assert_eq!(error.to_string(), expected);
+ }
+}
+
+#[cfg(test)]
+#[cfg(feature = "std")]
+mod test_translate_position {
+ use super::*;
+
+ #[test]
+ fn empty() {
+ let input = b"";
+ let index = 0;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, 0));
+ }
+
+ #[test]
+ fn start() {
+ let input = b"Hello";
+ let index = 0;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, 0));
+ }
+
+ #[test]
+ fn end() {
+ let input = b"Hello";
+ let index = input.len() - 1;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, input.len() - 1));
+ }
+
+ #[test]
+ fn after() {
+ let input = b"Hello";
+ let index = input.len();
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, input.len()));
+ }
+
+ #[test]
+ fn first_line() {
+ let input = b"Hello\nWorld\n";
+ let index = 2;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, 2));
+ }
+
+ #[test]
+ fn end_of_line() {
+ let input = b"Hello\nWorld\n";
+ let index = 5;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (0, 5));
+ }
+
+ #[test]
+ fn start_of_second_line() {
+ let input = b"Hello\nWorld\n";
+ let index = 6;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (1, 0));
+ }
+
+ #[test]
+ fn second_line() {
+ let input = b"Hello\nWorld\n";
+ let index = 8;
+ let position = translate_position(&input[..], index);
+ assert_eq!(position, (1, 2));
+ }
+}
+
+/// Creates a parse error from a [`ErrorKind`]
+/// and the position in the input
+#[cfg(test)]
+macro_rules! error_position(
+ ($input:expr, $code:expr) => ({
+ $crate::error::ParserError::from_error_kind($input, $code)
+ });
+);
+
+#[cfg(test)]
+macro_rules! error_node_position(
+ ($input:expr, $code:expr, $next:expr) => ({
+ $crate::error::ParserError::append($next, $input, $code)
+ });
+);
diff --git a/crates/winnow/src/lib.rs b/crates/winnow/src/lib.rs
new file mode 100644
index 0000000..6dcbda5
--- /dev/null
+++ b/crates/winnow/src/lib.rs
@@ -0,0 +1,255 @@
+//! > winnow, making parsing a breeze
+//!
+//! `winnow` is a parser combinator library
+//!
+//! Quick links:
+//! - [List of combinators][crate::combinator]
+//! - [Tutorial][_tutorial::chapter_0]
+//! - [Special Topics][_topic]
+//! - [Discussions](https://github.com/winnow-rs/winnow/discussions)
+//! - [CHANGELOG](https://github.com/winnow-rs/winnow/blob/v0.5.37/CHANGELOG.md) (includes major version migration
+//! guides)
+//!
+//! ## Aspirations
+//!
+//! `winnow` aims to be your "do everything" parser, much like people treat regular expressions.
+//!
+//! In roughly priority order:
+//! 1. Support writing parser declaratively while not getting in the way of imperative-style
+//! parsing when needed, working as an open-ended toolbox rather than a close-ended framework.
+//! 2. Flexible enough to be used for any application, including parsing binary data, strings, or
+//! separate lexing and parsing phases
+//! 3. Zero-cost abstractions, making it easy to write high performance parsers
+//! 4. Easy to use, making it trivial for one-off uses
+//!
+//! In addition:
+//! - Resilient maintainership, including
+//! - Willing to break compatibility rather than batching up breaking changes in large releases
+//! - Leverage feature flags to keep one active branch
+//! - We will support the last 6 months of rust releases (MSRV, currently 1.64.0)
+//!
+//! See also [Special Topic: Why winnow?][crate::_topic::why]
+//!
+//! ## Example
+//!
+//! Run
+//! ```console
+//! $ cargo add winnow
+//! ```
+//!
+//! Then use it to parse:
+//! ```rust
+//! # #[cfg(feature = "alloc")] {
+#![doc = include_str!("../examples/css/parser.rs")]
+//! # }
+//! ```
+//!
+//! See also the [Tutorial][_tutorial::chapter_0] and [Special Topics][_topic]
+
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![cfg_attr(docsrs, feature(doc_cfg))]
+#![cfg_attr(docsrs, feature(extended_key_value_attributes))]
+#![cfg_attr(not(feature = "std"), no_std)]
+#![warn(missing_docs)]
+#![warn(clippy::std_instead_of_core)]
+// BEGIN - Embark standard lints v6 for Rust 1.55+
+// do not change or add/remove here, but one can add exceptions after this section
+// for more info see: <https://github.com/EmbarkStudios/rust-ecosystem/issues/59>
+// "-Dunsafe_code",
+#![warn(clippy::all)]
+#![warn(clippy::await_holding_lock)]
+#![warn(clippy::char_lit_as_u8)]
+#![warn(clippy::checked_conversions)]
+#![warn(clippy::dbg_macro)]
+#![warn(clippy::debug_assert_with_mut_call)]
+#![warn(clippy::doc_markdown)]
+#![warn(clippy::empty_enum)]
+#![warn(clippy::enum_glob_use)]
+#![warn(clippy::exit)]
+#![warn(clippy::expl_impl_clone_on_copy)]
+#![warn(clippy::explicit_deref_methods)]
+#![warn(clippy::explicit_into_iter_loop)]
+#![warn(clippy::fallible_impl_from)]
+#![warn(clippy::filter_map_next)]
+#![warn(clippy::flat_map_option)]
+#![warn(clippy::float_cmp_const)]
+#![warn(clippy::fn_params_excessive_bools)]
+#![warn(clippy::from_iter_instead_of_collect)]
+#![warn(clippy::if_let_mutex)]
+#![warn(clippy::implicit_clone)]
+#![warn(clippy::imprecise_flops)]
+#![warn(clippy::inefficient_to_string)]
+#![warn(clippy::invalid_upcast_comparisons)]
+#![warn(clippy::large_digit_groups)]
+#![warn(clippy::large_stack_arrays)]
+#![warn(clippy::large_types_passed_by_value)]
+#![warn(clippy::let_unit_value)]
+#![warn(clippy::linkedlist)]
+#![warn(clippy::lossy_float_literal)]
+#![warn(clippy::macro_use_imports)]
+#![warn(clippy::manual_ok_or)]
+#![warn(clippy::map_err_ignore)]
+#![warn(clippy::map_flatten)]
+#![warn(clippy::map_unwrap_or)]
+#![warn(clippy::match_on_vec_items)]
+#![warn(clippy::match_same_arms)]
+#![warn(clippy::match_wild_err_arm)]
+#![warn(clippy::match_wildcard_for_single_variants)]
+#![warn(clippy::mem_forget)]
+#![warn(clippy::mismatched_target_os)]
+#![warn(clippy::missing_enforced_import_renames)]
+#![warn(clippy::mut_mut)]
+#![warn(clippy::mutex_integer)]
+#![warn(clippy::needless_borrow)]
+#![warn(clippy::needless_continue)]
+#![warn(clippy::needless_for_each)]
+#![warn(clippy::option_option)]
+#![warn(clippy::path_buf_push_overwrite)]
+#![warn(clippy::ptr_as_ptr)]
+#![warn(clippy::rc_mutex)]
+#![warn(clippy::ref_option_ref)]
+#![warn(clippy::rest_pat_in_fully_bound_structs)]
+#![warn(clippy::same_functions_in_if_condition)]
+#![warn(clippy::semicolon_if_nothing_returned)]
+#![warn(clippy::single_match_else)]
+#![warn(clippy::string_add_assign)]
+#![warn(clippy::string_add)]
+#![warn(clippy::string_lit_as_bytes)]
+#![warn(clippy::string_to_string)]
+#![warn(clippy::todo)]
+#![warn(clippy::trait_duplication_in_bounds)]
+#![warn(clippy::unimplemented)]
+#![warn(clippy::unnested_or_patterns)]
+#![warn(clippy::unused_self)]
+#![warn(clippy::useless_transmute)]
+#![warn(clippy::verbose_file_reads)]
+#![warn(clippy::zero_sized_map_values)]
+#![warn(future_incompatible)]
+#![warn(nonstandard_style)]
+#![warn(rust_2018_idioms)]
+// END - Embark standard lints v6 for Rust 1.55+
+#![allow(clippy::branches_sharing_code)]
+#![allow(clippy::collapsible_else_if)]
+#![allow(clippy::if_same_then_else)]
+#![allow(clippy::bool_assert_comparison)]
+#![allow(clippy::let_and_return)]
+#![allow(clippy::assertions_on_constants)]
+#![allow(clippy::map_unwrap_or)]
+#![allow(clippy::single_match_else)]
+#![allow(clippy::single_match)]
+#![allow(clippy::unnested_or_patterns)]
+#[cfg_attr(nightly, warn(rustdoc::missing_doc_code_examples))]
+#[cfg(feature = "alloc")]
+#[cfg_attr(test, macro_use)]
+extern crate alloc;
+#[cfg(doctest)]
+extern crate doc_comment;
+
+#[cfg(doctest)]
+doc_comment::doctest!("../README.md");
+
+/// Lib module to re-export everything needed from `std` or `core`/`alloc`. This is how `serde` does
+/// it, albeit there it is not public.
+#[doc(hidden)]
+pub(crate) mod lib {
+ /// `std` facade allowing `std`/`core` to be interchangeable. Reexports `alloc` crate optionally,
+ /// as well as `core` or `std`
+ #[cfg(not(feature = "std"))]
+ /// internal std exports for no_std compatibility
+ pub mod std {
+ #[doc(hidden)]
+ #[cfg(not(feature = "alloc"))]
+ pub use core::borrow;
+
+ #[cfg(feature = "alloc")]
+ #[doc(hidden)]
+ pub use alloc::{borrow, boxed, collections, string, vec};
+
+ #[doc(hidden)]
+ pub use core::{cmp, convert, fmt, hash, iter, mem, ops, option, result, slice, str};
+
+ /// internal reproduction of std prelude
+ #[doc(hidden)]
+ pub mod prelude {
+ pub use core::prelude as v1;
+ }
+ }
+
+ #[cfg(feature = "std")]
+ /// internal std exports for `no_std` compatibility
+ pub mod std {
+ #![allow(clippy::std_instead_of_core)]
+ #[doc(hidden)]
+ pub use std::{
+ alloc, borrow, boxed, cmp, collections, convert, fmt, hash, iter, mem, ops, option,
+ result, slice, str, string, vec,
+ };
+
+ /// internal reproduction of std prelude
+ #[doc(hidden)]
+ pub mod prelude {
+ pub use std::prelude as v1;
+ }
+ }
+}
+
+#[macro_use]
+mod macros;
+
+#[macro_use]
+pub mod error;
+
+mod parser;
+
+pub mod stream;
+
+pub mod ascii;
+pub mod binary;
+pub mod combinator;
+pub mod token;
+pub mod trace;
+
+#[cfg(feature = "unstable-doc")]
+pub mod _topic;
+#[cfg(feature = "unstable-doc")]
+pub mod _tutorial;
+
+/// Core concepts available for glob import
+///
+/// Including
+/// - [`StreamIsPartial`][crate::stream::StreamIsPartial]
+/// - [`Parser`]
+///
+/// ## Example
+///
+/// ```rust
+/// use winnow::prelude::*;
+///
+/// fn parse_data(input: &mut &str) -> PResult<u64> {
+/// // ...
+/// # winnow::ascii::dec_uint(input)
+/// }
+///
+/// fn main() {
+/// let result = parse_data.parse("100");
+/// assert_eq!(result, Ok(100));
+/// }
+/// ```
+pub mod prelude {
+ pub use crate::stream::StreamIsPartial as _;
+ pub use crate::IResult;
+ pub use crate::PResult;
+ pub use crate::Parser;
+ #[cfg(feature = "unstable-recover")]
+ pub use crate::RecoverableParser as _;
+}
+
+pub use error::IResult;
+pub use error::PResult;
+pub use parser::*;
+pub use stream::BStr;
+pub use stream::Bytes;
+pub use stream::Located;
+pub use stream::Partial;
+pub use stream::Stateful;
+pub use stream::Str;
diff --git a/crates/winnow/src/macros/dispatch.rs b/crates/winnow/src/macros/dispatch.rs
new file mode 100644
index 0000000..b763d4b
--- /dev/null
+++ b/crates/winnow/src/macros/dispatch.rs
@@ -0,0 +1,55 @@
+/// `match` for parsers
+///
+/// When parsers have unique prefixes to test for, this offers better performance over
+/// [`alt`][crate::combinator::alt] though it might be at the cost of duplicating parts of your grammar
+/// if you needed to [`peek`][crate::combinator::peek].
+///
+/// For tight control over the error in a catch-all case, use [`fail`][crate::combinator::fail].
+///
+/// # Example
+///
+/// ```rust
+/// use winnow::prelude::*;
+/// use winnow::combinator::dispatch;
+/// # use winnow::token::any;
+/// # use winnow::combinator::peek;
+/// # use winnow::combinator::preceded;
+/// # use winnow::combinator::empty;
+/// # use winnow::combinator::fail;
+///
+/// fn escaped(input: &mut &str) -> PResult<char> {
+/// preceded('\\', escape_seq_char).parse_next(input)
+/// }
+///
+/// fn escape_seq_char(input: &mut &str) -> PResult<char> {
+/// dispatch! {any;
+/// 'b' => empty.value('\u{8}'),
+/// 'f' => empty.value('\u{c}'),
+/// 'n' => empty.value('\n'),
+/// 'r' => empty.value('\r'),
+/// 't' => empty.value('\t'),
+/// '\\' => empty.value('\\'),
+/// '"' => empty.value('"'),
+/// _ => fail::<_, char, _>,
+/// }
+/// .parse_next(input)
+/// }
+///
+/// assert_eq!(escaped.parse_peek("\\nHello"), Ok(("Hello", '\n')));
+/// ```
+#[macro_export]
+#[doc(hidden)] // forced to be visible in intended location
+macro_rules! dispatch {
+ ($match_parser: expr; $( $pat:pat $(if $pred:expr)? => $expr: expr ),+ $(,)? ) => {
+ $crate::combinator::trace("dispatch", move |i: &mut _|
+ {
+ use $crate::Parser;
+ let initial = $match_parser.parse_next(i)?;
+ match initial {
+ $(
+ $pat $(if $pred)? => $expr.parse_next(i),
+ )*
+ }
+ })
+ }
+}
diff --git a/crates/winnow/src/macros/mod.rs b/crates/winnow/src/macros/mod.rs
new file mode 100644
index 0000000..09dc68b
--- /dev/null
+++ b/crates/winnow/src/macros/mod.rs
@@ -0,0 +1,5 @@
+mod dispatch;
+mod seq;
+
+#[cfg(test)]
+mod test;
diff --git a/crates/winnow/src/macros/seq.rs b/crates/winnow/src/macros/seq.rs
new file mode 100644
index 0000000..e104391
--- /dev/null
+++ b/crates/winnow/src/macros/seq.rs
@@ -0,0 +1,268 @@
+/// Initialize a struct or tuple out of a sequences of parsers
+///
+///# Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::ascii::{alphanumeric1, dec_uint, space0};
+/// # use winnow::combinator::delimited;
+/// # use winnow::combinator::empty;
+/// # use winnow::error::ContextError;
+/// use winnow::combinator::seq;
+///
+/// #[derive(Default, Debug, PartialEq)]
+/// struct Field {
+/// namespace: u32,
+/// name: Vec<u8>,
+/// value: Vec<u8>,
+/// point: (u32, u32),
+/// metadata: Vec<u8>,
+/// }
+///
+/// // Parse into structs / tuple-structs
+/// fn field(input: &mut &[u8]) -> PResult<Field> {
+/// seq!{Field {
+/// namespace: empty.value(5),
+/// name: alphanumeric1.map(|s: &[u8]| s.to_owned()),
+/// // `_` fields are ignored when building the struct
+/// _: (space0, b':', space0),
+/// value: alphanumeric1.map(|s: &[u8]| s.to_owned()),
+/// _: (space0, b':', space0),
+/// point: point,
+/// // default initialization also works
+/// ..Default::default()
+/// }}.parse_next(input)
+/// }
+///
+/// // Or parse into tuples
+/// fn point(input: &mut &[u8]) -> PResult<(u32, u32)> {
+/// let num = dec_uint::<_, u32, ContextError>;
+/// seq!(num, _: (space0, b',', space0), num).parse_next(input)
+/// }
+///
+/// assert_eq!(
+/// field.parse_peek(&b"test: data: 123 , 4"[..]),
+/// Ok((
+/// &b""[..],
+/// Field {
+/// namespace: 5,
+/// name: b"test"[..].to_owned(),
+/// value: b"data"[..].to_owned(),
+/// point: (123, 4),
+/// metadata: Default::default(),
+/// },
+/// )),
+/// );
+/// ```
+#[macro_export]
+#[doc(alias = "tuple")]
+#[doc(alias = "preceded")]
+#[doc(alias = "terminated")]
+#[doc(alias = "delimited")]
+#[doc(alias = "pair")]
+#[doc(alias = "separated_pair")]
+#[doc(alias = "struct_parser")]
+macro_rules! seq {
+ ($name: ident { $($fields: tt)* }) => {
+ $crate::combinator::trace(stringify!($name), move |input: &mut _| {
+ use $crate::Parser;
+ $crate::seq_parse_struct_fields!(input; $($fields)*);
+ #[allow(clippy::redundant_field_names)]
+ Ok($crate::seq_init_struct_fields!( ($($fields)*); $name;))
+ })
+ };
+ ($name: ident ( $($elements: tt)* )) => {
+ $crate::combinator::trace(stringify!($name), move |input: &mut _| {
+ use $crate::Parser;
+ $crate::seq_parse_tuple_fields!( ($($elements)*) ; ).map(|t| {
+ $crate::seq_init_tuple_fields!(
+ ($($elements)*);
+ (t.0, t.1, t.2, t.3, t.4, t.5, t.6, t.7, t.8, t.9, t.10, t.11, t.12, t.13, t.14, t.15, t.16, t.17, t.18, t.19, t.20);
+ $name;
+ )
+ }).parse_next(input)
+ })
+ };
+ (( $($elements: tt)* )) => {
+ $crate::combinator::trace("tuple", move |input: &mut _| {
+ use $crate::Parser;
+ $crate::seq_parse_tuple_fields!( ($($elements)*) ; ).map(|t| {
+ $crate::seq_init_tuple_fields!(
+ ($($elements)*);
+ (t.0, t.1, t.2, t.3, t.4, t.5, t.6, t.7, t.8, t.9, t.10, t.11, t.12, t.13, t.14, t.15, t.16, t.17, t.18, t.19, t.20);
+ ;
+ )
+ }).parse_next(input)
+ })
+ };
+ ($($elements: tt)*) => {
+ $crate::seq!(($($elements)*))
+ };
+}
+
+#[macro_export]
+#[doc(hidden)]
+macro_rules! seq_parse_struct_fields {
+ (
+ $input: ident;
+ _ : $head_parser: expr, $($fields: tt)*
+ ) => {
+ let _ = $head_parser.parse_next($input)?;
+ $crate::seq_parse_struct_fields!($input; $($fields)*)
+ };
+ (
+ $input: ident;
+ _ : $head_parser: expr
+ ) => {
+ let _ = $head_parser.parse_next($input)?;
+ };
+ (
+ $input: ident;
+ $head_field: ident : $head_parser: expr, $($fields: tt)*
+ ) => {
+ let $head_field = $head_parser.parse_next($input)?;
+ $crate::seq_parse_struct_fields!($input; $($fields)*)
+ };
+ (
+ $input: ident;
+ $head_field: ident : $head_parser: expr
+ ) => {
+ let $head_field = $head_parser.parse_next($input)?;
+ };
+ (
+ $input: expr;
+ .. $update: expr
+ ) => {};
+ (
+ $input: expr;
+ $(,)?
+ ) => {};
+}
+
+#[macro_export]
+#[doc(hidden)]
+macro_rules! seq_parse_tuple_fields {
+ (
+ (_ : $head_parser: expr, $($fields: tt)* );
+ $($sequenced: tt)*
+ ) => {
+ $crate::seq_parse_tuple_fields!( ( $($fields)* ) ; $($sequenced)* $head_parser.void(), )
+ };
+ (
+ (_ : $head_parser: expr);
+ $($sequenced: tt)*
+ ) => {
+ $crate::seq_parse_tuple_fields!((); $($sequenced)* $head_parser.void(), )
+ };
+ (
+ ($head_parser: expr, $($fields: tt)*);
+ $($sequenced: tt)*
+ ) => {
+ $crate::seq_parse_tuple_fields!( ( $($fields)* ) ; $($sequenced)* $head_parser, )
+ };
+ (
+ ($head_parser: expr);
+ $($sequenced: tt)*
+ )=> {
+ $crate::seq_parse_tuple_fields!((); $($sequenced)* $head_parser, )
+ };
+ (
+ ();
+ $($sequenced: tt)*
+ ) => {
+ ($($sequenced)*)
+ };
+}
+
+#[macro_export]
+#[doc(hidden)]
+macro_rules! seq_init_struct_fields {
+ (
+ (_ : $head_parser: expr, $($fields: tt)*);
+ $name: ident;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_struct_fields!( ( $($fields)* ) ; $name ; $($inits)* )
+ };
+ (
+ (_ : $head_parser: expr);
+ $name: ident;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_struct_fields!( (); $name ; $($inits)* )
+ };
+ (
+ ($head_field: ident : $head_parser: expr, $($fields: tt)*);
+ $name: ident;
+ $($inits: tt)*
+ ) =>
+ {
+ $crate::seq_init_struct_fields!( ( $($fields)* ) ; $name ; $($inits)* $head_field: $head_field, )
+ };
+ (
+ ($head_field: ident : $head_parser: expr);
+ $name: ident;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_struct_fields!( (); $name ; $($inits)* $head_field: $head_field,)
+ };
+ (
+ (.. $update: expr);
+ $name: ident;
+ $($inits: tt)*
+ ) => {
+ $name { $($inits)* ..$update }
+ };
+ (
+ ($(,)?);
+ $name: ident;
+ $($inits: tt)*
+ ) => {
+ $name { $($inits)* }
+ };
+}
+
+#[macro_export]
+#[doc(hidden)]
+macro_rules! seq_init_tuple_fields {
+ (
+ (_ : $head_parser: expr, $($fields: tt)*);
+ ($head_arg: expr, $($args: expr),*);
+ $($name: ident)?;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_tuple_fields!( ( $($fields)* ); ( $($args),* ) ; $($name)? ; $($inits)* )
+ };
+ (
+ (_ : $head_parser: expr);
+ ($head_arg: expr, $($args: expr),*);
+ $($name: ident)?;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_tuple_fields!((); ( $($args),* ); $($name)? ; $($inits)*)
+ };
+ (
+ ($head_parser: expr, $($fields: tt)*);
+ ($head_arg: expr, $($args: expr),*);
+ $($name: ident)?;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_tuple_fields!( ( $($fields)* ) ; ( $($args),* ) ; $($name)? ; $($inits)* $head_arg, )
+ };
+ (
+ ($head_parser: expr);
+ ($head_arg: expr, $($args: expr),*);
+ $($name: ident)?;
+ $($inits: tt)*
+ ) => {
+ $crate::seq_init_tuple_fields!((); ( $($args),* ); $($name)? ; $($inits)* $head_arg)
+ };
+ (
+ ();
+ ($($args: expr),*);
+ $($name: ident)?;
+ $($inits: expr),* $(,)?
+ ) => {
+ $($name)?( $($inits,)* )
+ };
+}
diff --git a/crates/winnow/src/macros/test.rs b/crates/winnow/src/macros/test.rs
new file mode 100644
index 0000000..17601bc
--- /dev/null
+++ b/crates/winnow/src/macros/test.rs
@@ -0,0 +1,378 @@
+use crate::ascii::dec_uint;
+use crate::combinator::dispatch;
+use crate::combinator::empty;
+use crate::combinator::fail;
+use crate::combinator::seq;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::ParserError;
+use crate::prelude::*;
+use crate::token::any;
+
+#[test]
+fn dispatch_basics() {
+ fn escape_seq_char(input: &mut &str) -> PResult<char> {
+ dispatch! {any;
+ 'b' => empty.value('\u{8}'),
+ 'f' => empty.value('\u{c}'),
+ 'n' => empty.value('\n'),
+ 'r' => empty.value('\r'),
+ 't' => empty.value('\t'),
+ '\\' => empty.value('\\'),
+ '"' => empty.value('"'),
+ _ => fail::<_, char, _>,
+ }
+ .parse_next(input)
+ }
+ assert_eq!(escape_seq_char.parse_peek("b123"), Ok(("123", '\u{8}')));
+ assert_eq!(
+ escape_seq_char.parse_peek("error"),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"rror",
+ ErrorKind::Fail
+ )))
+ );
+ assert_eq!(
+ escape_seq_char.parse_peek(""),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"",
+ ErrorKind::Fail
+ )))
+ );
+}
+
+#[test]
+fn seq_struct_basics() {
+ #[derive(Debug, PartialEq)]
+ struct Point {
+ x: u32,
+ y: u32,
+ }
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point {
+ x: dec_uint,
+ _: ',',
+ y: dec_uint,
+ }
+ }
+ .parse_next(input)
+ }
+ assert_eq!(
+ parser.parse_peek("123,4 remaining"),
+ Ok((" remaining", Point { x: 123, y: 4 },)),
+ );
+ assert_eq!(
+ parser.parse_peek("123, remaining"),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &" remaining",
+ ErrorKind::Fail
+ )))
+ );
+ assert_eq!(
+ parser.parse_peek(""),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"",
+ ErrorKind::Fail
+ )))
+ );
+}
+
+#[test]
+fn seq_struct_default_init() {
+ #[derive(Debug, PartialEq, Default)]
+ struct Point {
+ x: u32,
+ y: u32,
+ z: u32,
+ }
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point {
+ x: dec_uint,
+ _: ',',
+ y: dec_uint,
+ ..Default::default()
+ }
+ }
+ .parse_next(input)
+ }
+ assert_eq!(
+ parser.parse_peek("123,4 remaining"),
+ Ok((" remaining", Point { x: 123, y: 4, z: 0 },)),
+ );
+ assert_eq!(
+ parser.parse_peek("123, remaining"),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &" remaining",
+ ErrorKind::Fail
+ )))
+ );
+ assert_eq!(
+ parser.parse_peek(""),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"",
+ ErrorKind::Fail
+ )))
+ );
+}
+
+#[test]
+fn seq_struct_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point {
+ x: u32,
+ y: u32,
+ }
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point {
+ x: dec_uint,
+ _: ',',
+ y: dec_uint,
+ _: empty,
+ }
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_struct_no_trailing_comma() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point {
+ x: u32,
+ y: u32,
+ }
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point {
+ x: dec_uint,
+ _: ',',
+ y: dec_uint
+ }
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_struct_no_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point {
+ x: u32,
+ y: u32,
+ }
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point {
+ x: dec_uint,
+ _: ',',
+ y: dec_uint,
+ _: empty
+ }
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_struct_basics() {
+ #[derive(Debug, PartialEq)]
+ struct Point(u32, u32);
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point(
+ dec_uint,
+ _: ',',
+ dec_uint,
+ )
+ }
+ .parse_next(input)
+ }
+ assert_eq!(
+ parser.parse_peek("123,4 remaining"),
+ Ok((" remaining", Point(123, 4),)),
+ );
+ assert_eq!(
+ parser.parse_peek("123, remaining"),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &" remaining",
+ ErrorKind::Fail
+ )))
+ );
+ assert_eq!(
+ parser.parse_peek(""),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"",
+ ErrorKind::Fail
+ )))
+ );
+}
+
+#[test]
+fn seq_tuple_struct_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point(u32, u32);
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point(
+ dec_uint,
+ _: ',',
+ dec_uint,
+ _: empty,
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_struct_no_trailing_comma() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point(u32, u32);
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point(
+ dec_uint,
+ _: ',',
+ dec_uint
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_struct_no_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ #[derive(Debug, PartialEq)]
+ struct Point(u32, u32);
+
+ fn parser(input: &mut &str) -> PResult<Point> {
+ seq! {
+ Point(
+ dec_uint,
+ _: ',',
+ dec_uint,
+ _: empty
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_basics() {
+ fn parser(input: &mut &str) -> PResult<(u32, u32)> {
+ seq! {
+ (
+ dec_uint,
+ _: ',',
+ dec_uint,
+ )
+ }
+ .parse_next(input)
+ }
+ assert_eq!(
+ parser.parse_peek("123,4 remaining"),
+ Ok((" remaining", (123, 4),)),
+ );
+ assert_eq!(
+ parser.parse_peek("123, remaining"),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &" remaining",
+ ErrorKind::Fail
+ )))
+ );
+ assert_eq!(
+ parser.parse_peek(""),
+ Err(ErrMode::Backtrack(ParserError::from_error_kind(
+ &"",
+ ErrorKind::Fail
+ )))
+ );
+}
+
+#[test]
+fn seq_tuple_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ fn parser(input: &mut &str) -> PResult<(u32, u32)> {
+ seq! {
+ (
+ dec_uint,
+ _: ',',
+ dec_uint,
+ _: empty,
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_no_trailing_comma() {
+ #![allow(dead_code)]
+
+ fn parser(input: &mut &str) -> PResult<(u32, u32)> {
+ seq! {
+ (
+ dec_uint,
+ _: ',',
+ dec_uint
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_no_trailing_comma_elided() {
+ #![allow(dead_code)]
+
+ fn parser(input: &mut &str) -> PResult<(u32, u32)> {
+ seq! {
+ (
+ dec_uint,
+ _: ',',
+ dec_uint,
+ _: empty
+ )
+ }
+ .parse_next(input)
+ }
+}
+
+#[test]
+fn seq_tuple_no_parens() {
+ #![allow(dead_code)]
+
+ fn parser(input: &mut &str) -> PResult<(u32, u32)> {
+ seq! (
+ dec_uint,
+ _: ',',
+ dec_uint,
+ )
+ .parse_next(input)
+ }
+}
diff --git a/crates/winnow/src/parser.rs b/crates/winnow/src/parser.rs
new file mode 100644
index 0000000..1afa7e5
--- /dev/null
+++ b/crates/winnow/src/parser.rs
@@ -0,0 +1,1205 @@
+//! Basic types to build the parsers
+
+use crate::ascii::Caseless as AsciiCaseless;
+use crate::combinator::*;
+#[cfg(feature = "unstable-recover")]
+use crate::error::FromRecoverableError;
+use crate::error::{AddContext, FromExternalError, IResult, PResult, ParseError, ParserError};
+use crate::stream::{AsChar, Compare, Location, ParseSlice, Stream, StreamIsPartial};
+#[cfg(feature = "unstable-recover")]
+use crate::stream::{Recover, Recoverable};
+
+/// Core trait for parsing
+///
+/// The simplest way to implement a `Parser` is with a function
+/// ```rust
+/// use winnow::prelude::*;
+///
+/// fn empty(input: &mut &str) -> PResult<()> {
+/// let output = ();
+/// Ok(output)
+/// }
+///
+/// let (input, output) = empty.parse_peek("Hello").unwrap();
+/// assert_eq!(input, "Hello"); // We didn't consume any input
+/// ```
+///
+/// which can be made stateful by returning a function
+/// ```rust
+/// use winnow::prelude::*;
+///
+/// fn empty<O: Clone>(output: O) -> impl FnMut(&mut &str) -> PResult<O> {
+/// move |input: &mut &str| {
+/// let output = output.clone();
+/// Ok(output)
+/// }
+/// }
+///
+/// let (input, output) = empty("World").parse_peek("Hello").unwrap();
+/// assert_eq!(input, "Hello"); // We didn't consume any input
+/// assert_eq!(output, "World");
+/// ```
+///
+/// Additionally, some basic types implement `Parser` as well, including
+/// - `u8` and `char`, see [`winnow::token::one_of`][crate::token::one_of]
+/// - `&[u8]` and `&str`, see [`winnow::token::tag`][crate::token::tag]
+pub trait Parser<I, O, E> {
+ /// Parse all of `input`, generating `O` from it
+ #[inline]
+ fn parse(&mut self, mut input: I) -> Result<O, ParseError<I, E>>
+ where
+ Self: core::marker::Sized,
+ I: Stream,
+ // Force users to deal with `Incomplete` when `StreamIsPartial<true>`
+ I: StreamIsPartial,
+ I: Clone,
+ E: ParserError<I>,
+ {
+ debug_assert!(
+ !I::is_partial_supported(),
+ "partial streams need to handle `ErrMode::Incomplete`"
+ );
+
+ let start = input.checkpoint();
+ let (o, _) = (self.by_ref(), crate::combinator::eof)
+ .parse_next(&mut input)
+ .map_err(|e| {
+ let e = e
+ .into_inner()
+ .expect("complete parsers should not report `ErrMode::Incomplete(_)`");
+ ParseError::new(input, start, e)
+ })?;
+ Ok(o)
+ }
+
+ /// Take tokens from the [`Stream`], turning it into the output
+ ///
+ /// This includes advancing the [`Stream`] to the next location.
+ ///
+ /// On error, `input` will be left pointing at the error location.
+ fn parse_next(&mut self, input: &mut I) -> PResult<O, E>;
+
+ /// Take tokens from the [`Stream`], turning it into the output
+ ///
+ /// This includes advancing the [`Stream`] to the next location.
+ #[inline(always)]
+ fn parse_peek(&mut self, mut input: I) -> IResult<I, O, E> {
+ match self.parse_next(&mut input) {
+ Ok(o) => Ok((input, o)),
+ Err(err) => Err(err),
+ }
+ }
+
+ /// Treat `&mut Self` as a parser
+ ///
+ /// This helps when needing to move a `Parser` when all you have is a `&mut Parser`.
+ ///
+ /// # Example
+ ///
+ /// Because parsers are `FnMut`, they can be called multiple times. This prevents moving `f`
+ /// into [`length_data`][crate::binary::length_data] and `g` into
+ /// [`Parser::complete_err`]:
+ /// ```rust,compile_fail
+ /// # use winnow::prelude::*;
+ /// # use winnow::Parser;
+ /// # use winnow::error::ParserError;
+ /// # use winnow::binary::length_data;
+ /// pub fn length_value<'i, O, E: ParserError<&'i [u8]>>(
+ /// mut f: impl Parser<&'i [u8], usize, E>,
+ /// mut g: impl Parser<&'i [u8], O, E>
+ /// ) -> impl Parser<&'i [u8], O, E> {
+ /// move |i: &mut &'i [u8]| {
+ /// let mut data = length_data(f).parse_next(i)?;
+ /// let o = g.complete_err().parse_next(&mut data)?;
+ /// Ok(o)
+ /// }
+ /// }
+ /// ```
+ ///
+ /// By adding `by_ref`, we can make this work:
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// # use winnow::Parser;
+ /// # use winnow::error::ParserError;
+ /// # use winnow::binary::length_data;
+ /// pub fn length_value<'i, O, E: ParserError<&'i [u8]>>(
+ /// mut f: impl Parser<&'i [u8], usize, E>,
+ /// mut g: impl Parser<&'i [u8], O, E>
+ /// ) -> impl Parser<&'i [u8], O, E> {
+ /// move |i: &mut &'i [u8]| {
+ /// let mut data = length_data(f.by_ref()).parse_next(i)?;
+ /// let o = g.by_ref().complete_err().parse_next(&mut data)?;
+ /// Ok(o)
+ /// }
+ /// }
+ /// ```
+ #[inline(always)]
+ fn by_ref(&mut self) -> ByRef<'_, Self>
+ where
+ Self: core::marker::Sized,
+ {
+ ByRef::new(self)
+ }
+
+ /// Produce the provided value
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::alpha1;
+ /// # fn main() {
+ ///
+ /// let mut parser = alpha1.value(1234);
+ ///
+ /// assert_eq!(parser.parse_peek("abcd"), Ok(("", 1234)));
+ /// assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[doc(alias = "to")]
+ #[inline(always)]
+ fn value<O2>(self, val: O2) -> Value<Self, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ O2: Clone,
+ {
+ Value::new(self, val)
+ }
+
+ /// Produce a type's default value
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::alpha1;
+ /// # fn main() {
+ ///
+ /// let mut parser = alpha1.default_value::<u32>();
+ ///
+ /// assert_eq!(parser.parse_peek("abcd"), Ok(("", 0)));
+ /// assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn default_value<O2>(self) -> DefaultValue<Self, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ O2: core::default::Default,
+ {
+ DefaultValue::new(self)
+ }
+
+ /// Discards the output of the `Parser`
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::alpha1;
+ /// # fn main() {
+ ///
+ /// let mut parser = alpha1.void();
+ ///
+ /// assert_eq!(parser.parse_peek("abcd"), Ok(("", ())));
+ /// assert_eq!(parser.parse_peek("123abcd;"), Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn void(self) -> Void<Self, I, O, E>
+ where
+ Self: core::marker::Sized,
+ {
+ Void::new(self)
+ }
+
+ /// Convert the parser's output to another type using [`std::convert::From`]
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// # use winnow::error::InputError;
+ /// use winnow::ascii::alpha1;
+ /// # fn main() {
+ ///
+ /// fn parser1<'s>(i: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+ /// alpha1(i)
+ /// }
+ ///
+ /// let mut parser2 = parser1.output_into();
+ ///
+ /// // the parser converts the &str output of the child parser into a Vec<u8>
+ /// let bytes: IResult<&str, Vec<u8>> = parser2.parse_peek("abcd");
+ /// assert_eq!(bytes, Ok(("", vec![97, 98, 99, 100])));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn output_into<O2>(self) -> OutputInto<Self, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ O: Into<O2>,
+ {
+ OutputInto::new(self)
+ }
+
+ /// Produce the consumed input as produced value.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::{alpha1};
+ /// use winnow::combinator::separated_pair;
+ /// # fn main() {
+ ///
+ /// let mut parser = separated_pair(alpha1, ',', alpha1).recognize();
+ ///
+ /// assert_eq!(parser.parse_peek("abcd,efgh"), Ok(("", "abcd,efgh")));
+ /// assert_eq!(parser.parse_peek("abcd;"),Err(ErrMode::Backtrack(InputError::new(";", ErrorKind::Verify))));
+ /// # }
+ /// ```
+ #[doc(alias = "concat")]
+ #[inline(always)]
+ fn recognize(self) -> Recognize<Self, I, O, E>
+ where
+ Self: core::marker::Sized,
+ I: Stream,
+ {
+ Recognize::new(self)
+ }
+
+ /// Produce the consumed input with the output
+ ///
+ /// Functions similarly to [recognize][Parser::recognize] except it
+ /// returns the parser output as well.
+ ///
+ /// This can be useful especially in cases where the output is not the same type
+ /// as the input, or the input is a user defined type.
+ ///
+ /// Returned tuple is of the format `(produced output, consumed input)`.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError};
+ /// use winnow::ascii::{alpha1};
+ /// use winnow::token::tag;
+ /// use winnow::combinator::separated_pair;
+ ///
+ /// fn inner_parser<'s>(input: &mut &'s str) -> PResult<bool, InputError<&'s str>> {
+ /// "1234".value(true).parse_next(input)
+ /// }
+ ///
+ /// let mut consumed_parser = separated_pair(alpha1, ',', alpha1).value(true).with_recognized();
+ ///
+ /// assert_eq!(consumed_parser.parse_peek("abcd,efgh1"), Ok(("1", (true, "abcd,efgh"))));
+ /// assert_eq!(consumed_parser.parse_peek("abcd;"),Err(ErrMode::Backtrack(InputError::new(";", ErrorKind::Verify))));
+ ///
+ /// // the second output (representing the consumed input)
+ /// // should be the same as that of the `recognize` parser.
+ /// let mut recognize_parser = inner_parser.recognize();
+ /// let mut consumed_parser = inner_parser.with_recognized().map(|(output, consumed)| consumed);
+ ///
+ /// assert_eq!(recognize_parser.parse_peek("1234"), consumed_parser.parse_peek("1234"));
+ /// assert_eq!(recognize_parser.parse_peek("abcd"), consumed_parser.parse_peek("abcd"));
+ /// ```
+ #[doc(alias = "consumed")]
+ #[inline(always)]
+ fn with_recognized(self) -> WithRecognized<Self, I, O, E>
+ where
+ Self: core::marker::Sized,
+ I: Stream,
+ {
+ WithRecognized::new(self)
+ }
+
+ /// Produce the location of the consumed input as produced value.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, stream::Stream};
+ /// use winnow::stream::Located;
+ /// use winnow::ascii::alpha1;
+ /// use winnow::combinator::separated_pair;
+ ///
+ /// let mut parser = separated_pair(alpha1.span(), ',', alpha1.span());
+ ///
+ /// assert_eq!(parser.parse(Located::new("abcd,efgh")), Ok((0..4, 5..9)));
+ /// assert_eq!(parser.parse_peek(Located::new("abcd;")),Err(ErrMode::Backtrack(InputError::new(Located::new("abcd;").peek_slice(4).0, ErrorKind::Verify))));
+ /// ```
+ #[inline(always)]
+ fn span(self) -> Span<Self, I, O, E>
+ where
+ Self: core::marker::Sized,
+ I: Stream + Location,
+ {
+ Span::new(self)
+ }
+
+ /// Produce the location of consumed input with the output
+ ///
+ /// Functions similarly to [`Parser::span`] except it
+ /// returns the parser output as well.
+ ///
+ /// This can be useful especially in cases where the output is not the same type
+ /// as the input, or the input is a user defined type.
+ ///
+ /// Returned tuple is of the format `(produced output, consumed input)`.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, stream::Stream};
+ /// use winnow::stream::Located;
+ /// use winnow::ascii::alpha1;
+ /// use winnow::token::tag;
+ /// use winnow::combinator::separated_pair;
+ ///
+ /// fn inner_parser<'s>(input: &mut Located<&'s str>) -> PResult<bool, InputError<Located<&'s str>>> {
+ /// "1234".value(true).parse_next(input)
+ /// }
+ ///
+ /// # fn main() {
+ ///
+ /// let mut consumed_parser = separated_pair(alpha1.value(1).with_span(), ',', alpha1.value(2).with_span());
+ ///
+ /// assert_eq!(consumed_parser.parse(Located::new("abcd,efgh")), Ok(((1, 0..4), (2, 5..9))));
+ /// assert_eq!(consumed_parser.parse_peek(Located::new("abcd;")),Err(ErrMode::Backtrack(InputError::new(Located::new("abcd;").peek_slice(4).0, ErrorKind::Verify))));
+ ///
+ /// // the second output (representing the consumed input)
+ /// // should be the same as that of the `span` parser.
+ /// let mut recognize_parser = inner_parser.span();
+ /// let mut consumed_parser = inner_parser.with_span().map(|(output, consumed)| consumed);
+ ///
+ /// assert_eq!(recognize_parser.parse_peek(Located::new("1234")), consumed_parser.parse_peek(Located::new("1234")));
+ /// assert_eq!(recognize_parser.parse_peek(Located::new("abcd")), consumed_parser.parse_peek(Located::new("abcd")));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn with_span(self) -> WithSpan<Self, I, O, E>
+ where
+ Self: core::marker::Sized,
+ I: Stream + Location,
+ {
+ WithSpan::new(self)
+ }
+
+ /// Maps a function over the output of a parser
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::digit1;
+ /// # fn main() {
+ ///
+ /// let mut parser = digit1.map(|s: &str| s.len());
+ ///
+ /// // the parser will count how many characters were returned by digit1
+ /// assert_eq!(parser.parse_peek("123456"), Ok(("", 6)));
+ ///
+ /// // this will fail if digit1 fails
+ /// assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn map<G, O2>(self, map: G) -> Map<Self, G, I, O, O2, E>
+ where
+ G: FnMut(O) -> O2,
+ Self: core::marker::Sized,
+ {
+ Map::new(self, map)
+ }
+
+ /// Applies a function returning a `Result` over the output of a parser.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::digit1;
+ /// # fn main() {
+ ///
+ /// let mut parse = digit1.try_map(|s: &str| s.parse::<u8>());
+ ///
+ /// // the parser will convert the result of digit1 to a number
+ /// assert_eq!(parse.parse_peek("123"), Ok(("", 123)));
+ ///
+ /// // this will fail if digit1 fails
+ /// assert_eq!(parse.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
+ ///
+ /// // this will fail if the mapped function fails (a `u8` is too small to hold `123456`)
+ /// assert_eq!(parse.parse_peek("123456"), Err(ErrMode::Backtrack(InputError::new("123456", ErrorKind::Verify))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn try_map<G, O2, E2>(self, map: G) -> TryMap<Self, G, I, O, O2, E, E2>
+ where
+ Self: core::marker::Sized,
+ G: FnMut(O) -> Result<O2, E2>,
+ I: Stream,
+ E: FromExternalError<I, E2>,
+ {
+ TryMap::new(self, map)
+ }
+
+ /// Apply both [`Parser::verify`] and [`Parser::map`].
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::digit1;
+ /// # fn main() {
+ ///
+ /// let mut parse = digit1.verify_map(|s: &str| s.parse::<u8>().ok());
+ ///
+ /// // the parser will convert the result of digit1 to a number
+ /// assert_eq!(parse.parse_peek("123"), Ok(("", 123)));
+ ///
+ /// // this will fail if digit1 fails
+ /// assert_eq!(parse.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
+ ///
+ /// // this will fail if the mapped function fails (a `u8` is too small to hold `123456`)
+ /// assert_eq!(parse.parse_peek("123456"), Err(ErrMode::Backtrack(InputError::new("123456", ErrorKind::Verify))));
+ /// # }
+ /// ```
+ #[doc(alias = "satisfy_map")]
+ #[doc(alias = "filter_map")]
+ #[doc(alias = "map_opt")]
+ #[inline(always)]
+ fn verify_map<G, O2>(self, map: G) -> VerifyMap<Self, G, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ G: FnMut(O) -> Option<O2>,
+ I: Stream,
+ E: ParserError<I>,
+ {
+ VerifyMap::new(self, map)
+ }
+
+ /// Creates a parser from the output of this one
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, PResult, Parser};
+ /// use winnow::token::take;
+ /// use winnow::binary::u8;
+ ///
+ /// fn length_data<'s>(input: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+ /// u8.flat_map(take).parse_next(input)
+ /// }
+ ///
+ /// assert_eq!(length_data.parse_peek(&[2, 0, 1, 2][..]), Ok((&[2][..], &[0, 1][..])));
+ /// assert_eq!(length_data.parse_peek(&[4, 0, 1, 2][..]), Err(ErrMode::Backtrack(InputError::new(&[0, 1, 2][..], ErrorKind::Slice))));
+ /// ```
+ ///
+ /// which is the same as
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, PResult, Parser};
+ /// use winnow::token::take;
+ /// use winnow::binary::u8;
+ ///
+ /// fn length_data<'s>(input: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+ /// let length = u8.parse_next(input)?;
+ /// let data = take(length).parse_next(input)?;
+ /// Ok(data)
+ /// }
+ ///
+ /// assert_eq!(length_data.parse_peek(&[2, 0, 1, 2][..]), Ok((&[2][..], &[0, 1][..])));
+ /// assert_eq!(length_data.parse_peek(&[4, 0, 1, 2][..]), Err(ErrMode::Backtrack(InputError::new(&[0, 1, 2][..], ErrorKind::Slice))));
+ /// ```
+ #[inline(always)]
+ fn flat_map<G, H, O2>(self, map: G) -> FlatMap<Self, G, H, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ G: FnMut(O) -> H,
+ H: Parser<I, O2, E>,
+ {
+ FlatMap::new(self, map)
+ }
+
+ /// Applies a second parser over the output of the first one
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::digit1;
+ /// use winnow::token::take;
+ /// # fn main() {
+ ///
+ /// let mut digits = take(5u8).and_then(digit1);
+ ///
+ /// assert_eq!(digits.parse_peek("12345"), Ok(("", "12345")));
+ /// assert_eq!(digits.parse_peek("123ab"), Ok(("", "123")));
+ /// assert_eq!(digits.parse_peek("123"), Err(ErrMode::Backtrack(InputError::new("123", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn and_then<G, O2>(self, inner: G) -> AndThen<Self, G, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ G: Parser<O, O2, E>,
+ O: StreamIsPartial,
+ I: Stream,
+ {
+ AndThen::new(self, inner)
+ }
+
+ /// Apply [`std::str::FromStr`] to the output of the parser
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::prelude::*;
+ /// use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// use winnow::ascii::digit1;
+ ///
+ /// fn parser<'s>(input: &mut &'s str) -> PResult<u64, InputError<&'s str>> {
+ /// digit1.parse_to().parse_next(input)
+ /// }
+ ///
+ /// // the parser will count how many characters were returned by digit1
+ /// assert_eq!(parser.parse_peek("123456"), Ok(("", 123456)));
+ ///
+ /// // this will fail if digit1 fails
+ /// assert_eq!(parser.parse_peek("abc"), Err(ErrMode::Backtrack(InputError::new("abc", ErrorKind::Slice))));
+ /// ```
+ #[doc(alias = "from_str")]
+ #[inline(always)]
+ fn parse_to<O2>(self) -> ParseTo<Self, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ I: Stream,
+ O: ParseSlice<O2>,
+ E: ParserError<I>,
+ {
+ ParseTo::new(self)
+ }
+
+ /// Returns the output of the child parser if it satisfies a verification function.
+ ///
+ /// The verification function takes as argument a reference to the output of the
+ /// parser.
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode,error::ErrorKind, error::InputError, Parser};
+ /// # use winnow::ascii::alpha1;
+ /// # fn main() {
+ ///
+ /// let mut parser = alpha1.verify(|s: &str| s.len() == 4);
+ ///
+ /// assert_eq!(parser.parse_peek("abcd"), Ok(("", "abcd")));
+ /// assert_eq!(parser.parse_peek("abcde"), Err(ErrMode::Backtrack(InputError::new("abcde", ErrorKind::Verify))));
+ /// assert_eq!(parser.parse_peek("123abcd;"),Err(ErrMode::Backtrack(InputError::new("123abcd;", ErrorKind::Slice))));
+ /// # }
+ /// ```
+ #[doc(alias = "satisfy")]
+ #[doc(alias = "filter")]
+ #[inline(always)]
+ fn verify<G, O2>(self, filter: G) -> Verify<Self, G, I, O, O2, E>
+ where
+ Self: core::marker::Sized,
+ G: FnMut(&O2) -> bool,
+ I: Stream,
+ O: crate::lib::std::borrow::Borrow<O2>,
+ O2: ?Sized,
+ E: ParserError<I>,
+ {
+ Verify::new(self, filter)
+ }
+
+ /// If parsing fails, add context to the error
+ ///
+ /// This is used mainly to add user friendly information
+ /// to errors when backtracking through a parse tree.
+ #[doc(alias = "labelled")]
+ #[inline(always)]
+ fn context<C>(self, context: C) -> Context<Self, I, O, E, C>
+ where
+ Self: core::marker::Sized,
+ I: Stream,
+ E: AddContext<I, C>,
+ C: Clone + crate::lib::std::fmt::Debug,
+ {
+ Context::new(self, context)
+ }
+
+ /// Transforms [`Incomplete`][crate::error::ErrMode::Incomplete] into [`Backtrack`][crate::error::ErrMode::Backtrack]
+ ///
+ /// # Example
+ ///
+ /// ```rust
+ /// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, stream::Partial, Parser};
+ /// # use winnow::token::take;
+ /// # fn main() {
+ ///
+ /// let mut parser = take(5u8).complete_err();
+ ///
+ /// assert_eq!(parser.parse_peek(Partial::new("abcdefg")), Ok((Partial::new("fg"), "abcde")));
+ /// assert_eq!(parser.parse_peek(Partial::new("abcd")), Err(ErrMode::Backtrack(InputError::new(Partial::new("abcd"), ErrorKind::Complete))));
+ /// # }
+ /// ```
+ #[inline(always)]
+ fn complete_err(self) -> CompleteErr<Self>
+ where
+ Self: core::marker::Sized,
+ {
+ CompleteErr::new(self)
+ }
+
+ /// Convert the parser's error to another type using [`std::convert::From`]
+ #[inline(always)]
+ fn err_into<E2>(self) -> ErrInto<Self, I, O, E, E2>
+ where
+ Self: core::marker::Sized,
+ E: Into<E2>,
+ {
+ ErrInto::new(self)
+ }
+
+ /// Recover from an error by skipping everything `recover` consumes and trying again
+ ///
+ /// If `recover` consumes nothing, the error is returned, allowing an alternative recovery
+ /// method.
+ ///
+ /// This commits the parse result, preventing alternative branch paths like with
+ /// [`winnow::combinator::alt`][crate::combinator::alt].
+ #[inline(always)]
+ #[cfg(feature = "unstable-recover")]
+ fn retry_after<R>(self, recover: R) -> RetryAfter<Self, R, I, O, E>
+ where
+ Self: core::marker::Sized,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+ {
+ RetryAfter::new(self, recover)
+ }
+
+ /// Recover from an error by skipping this parse and everything `recover` consumes
+ ///
+ /// This commits the parse result, preventing alternative branch paths like with
+ /// [`winnow::combinator::alt`][crate::combinator::alt].
+ #[inline(always)]
+ #[cfg(feature = "unstable-recover")]
+ fn resume_after<R>(self, recover: R) -> ResumeAfter<Self, R, I, O, E>
+ where
+ Self: core::marker::Sized,
+ R: Parser<I, (), E>,
+ I: Stream,
+ I: Recover<E>,
+ E: FromRecoverableError<I, E>,
+ {
+ ResumeAfter::new(self, recover)
+ }
+}
+
+impl<'a, I, O, E, F> Parser<I, O, E> for F
+where
+ F: FnMut(&mut I) -> PResult<O, E> + 'a,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ self(i)
+ }
+}
+
+/// This is a shortcut for [`one_of`][crate::token::one_of].
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{ErrorKind, InputError}};
+/// fn parser<'s>(i: &mut &'s [u8]) -> PResult<u8, InputError<&'s [u8]>> {
+/// b'a'.parse_next(i)
+/// }
+/// assert_eq!(parser.parse_peek(&b"abc"[..]), Ok((&b"bc"[..], b'a')));
+/// assert_eq!(parser.parse_peek(&b" abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b" abc"[..], ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek(&b"bc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"bc"[..], ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Token))));
+/// ```
+impl<I, E> Parser<I, u8, E> for u8
+where
+ I: StreamIsPartial,
+ I: Stream<Token = u8>,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<u8, E> {
+ crate::token::one_of(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`one_of`][crate::token::one_of].
+///
+/// # Example
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{ErrorKind, InputError}};
+/// fn parser<'s>(i: &mut &'s str) -> PResult<char, InputError<&'s str>> {
+/// 'a'.parse_next(i)
+/// }
+/// assert_eq!(parser.parse_peek("abc"), Ok(("bc", 'a')));
+/// assert_eq!(parser.parse_peek(" abc"), Err(ErrMode::Backtrack(InputError::new(" abc", ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek("bc"), Err(ErrMode::Backtrack(InputError::new("bc", ErrorKind::Verify))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+impl<I, E> Parser<I, <I as Stream>::Token, E> for char
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: AsChar + Clone,
+ E: ParserError<I>,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Token, E> {
+ crate::token::one_of(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+///
+/// fn parser<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// alt((&"Hello"[..], take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(&b"Hello, World!"[..]), Ok((&b", World!"[..], &b"Hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
+/// assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s [u8]
+where
+ I: Compare<&'s [u8]> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+/// use winnow::ascii::Caseless;
+///
+/// fn parser<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// alt((Caseless(&"hello"[..]), take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(&b"Hello, World!"[..]), Ok((&b", World!"[..], &b"Hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"hello, World!"[..]), Ok((&b", World!"[..], &b"hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"HeLlo, World!"[..]), Ok((&b", World!"[..], &b"HeLlo"[..])));
+/// assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
+/// assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for AsciiCaseless<&'s [u8]>
+where
+ I: Compare<AsciiCaseless<&'s [u8]>> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+///
+/// fn parser<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// alt((b"Hello", take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(&b"Hello, World!"[..]), Ok((&b", World!"[..], &b"Hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
+/// assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E> for &'s [u8; N]
+where
+ I: Compare<&'s [u8; N]> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+/// use winnow::ascii::Caseless;
+///
+/// fn parser<'s>(s: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// alt((Caseless(b"hello"), take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek(&b"Hello, World!"[..]), Ok((&b", World!"[..], &b"Hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"hello, World!"[..]), Ok((&b", World!"[..], &b"hello"[..])));
+/// assert_eq!(parser.parse_peek(&b"HeLlo, World!"[..]), Ok((&b", World!"[..], &b"HeLlo"[..])));
+/// assert_eq!(parser.parse_peek(&b"Something"[..]), Ok((&b"hing"[..], &b"Somet"[..])));
+/// assert_eq!(parser.parse_peek(&b"Some"[..]), Err(ErrMode::Backtrack(InputError::new(&b"Some"[..], ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(&b""[..]), Err(ErrMode::Backtrack(InputError::new(&b""[..], ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>, const N: usize> Parser<I, <I as Stream>::Slice, E>
+ for AsciiCaseless<&'s [u8; N]>
+where
+ I: Compare<AsciiCaseless<&'s [u8; N]>> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+///
+/// fn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alt(("Hello", take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
+/// assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for &'s str
+where
+ I: Compare<&'s str> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+/// This is a shortcut for [`tag`][crate::token::tag].
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::combinator::alt;
+/// # use winnow::token::take;
+/// # use winnow::ascii::Caseless;
+///
+/// fn parser<'s>(s: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// alt((Caseless("hello"), take(5usize))).parse_next(s)
+/// }
+///
+/// assert_eq!(parser.parse_peek("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser.parse_peek("hello, World!"), Ok((", World!", "hello")));
+/// assert_eq!(parser.parse_peek("HeLlo, World!"), Ok((", World!", "HeLlo")));
+/// assert_eq!(parser.parse_peek("Something"), Ok(("hing", "Somet")));
+/// assert_eq!(parser.parse_peek("Some"), Err(ErrMode::Backtrack(InputError::new("Some", ErrorKind::Slice))));
+/// assert_eq!(parser.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+impl<'s, I, E: ParserError<I>> Parser<I, <I as Stream>::Slice, E> for AsciiCaseless<&'s str>
+where
+ I: Compare<AsciiCaseless<&'s str>> + StreamIsPartial,
+ I: Stream,
+{
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<<I as Stream>::Slice, E> {
+ crate::token::tag(*self).parse_next(i)
+ }
+}
+
+impl<I, E: ParserError<I>> Parser<I, (), E> for () {
+ #[inline(always)]
+ fn parse_next(&mut self, _i: &mut I) -> PResult<(), E> {
+ Ok(())
+ }
+}
+
+macro_rules! impl_parser_for_tuple {
+ ($($parser:ident $output:ident),+) => (
+ #[allow(non_snake_case)]
+ impl<I, $($output),+, E: ParserError<I>, $($parser),+> Parser<I, ($($output),+,), E> for ($($parser),+,)
+ where
+ $($parser: Parser<I, $output, E>),+
+ {
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<($($output),+,), E> {
+ let ($(ref mut $parser),+,) = *self;
+
+ $(let $output = $parser.parse_next(i)?;)+
+
+ Ok(($($output),+,))
+ }
+ }
+ )
+}
+
+macro_rules! impl_parser_for_tuples {
+ ($parser1:ident $output1:ident, $($parser:ident $output:ident),+) => {
+ impl_parser_for_tuples!(__impl $parser1 $output1; $($parser $output),+);
+ };
+ (__impl $($parser:ident $output:ident),+; $parser1:ident $output1:ident $(,$parser2:ident $output2:ident)*) => {
+ impl_parser_for_tuple!($($parser $output),+);
+ impl_parser_for_tuples!(__impl $($parser $output),+, $parser1 $output1; $($parser2 $output2),*);
+ };
+ (__impl $($parser:ident $output:ident),+;) => {
+ impl_parser_for_tuple!($($parser $output),+);
+ }
+}
+
+/// Collect all errors when parsing the input
+///
+/// [`Parser`]s will need to use [`Recoverable<I, _>`] for their input.
+#[cfg(feature = "unstable-recover")]
+pub trait RecoverableParser<I, O, R, E> {
+ /// Collect all errors when parsing the input
+ ///
+ /// If `self` fails, this acts like [`Parser::resume_after`] and returns `Ok(None)`.
+ /// Generally, this should be avoided by using
+ /// [`Parser::retry_after`] and [`Parser::resume_after`] throughout your parser.
+ ///
+ /// The empty `input` is returned to allow turning the errors into [`ParserError`]s.
+ fn recoverable_parse(&mut self, input: I) -> (I, Option<O>, Vec<R>);
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<P, I, O, R, E> RecoverableParser<I, O, R, E> for P
+where
+ P: Parser<Recoverable<I, R>, O, E>,
+ I: Stream,
+ I: StreamIsPartial,
+ R: FromRecoverableError<Recoverable<I, R>, E>,
+ R: crate::lib::std::fmt::Debug,
+ E: FromRecoverableError<Recoverable<I, R>, E>,
+ E: ParserError<Recoverable<I, R>>,
+ E: crate::lib::std::fmt::Debug,
+{
+ #[inline]
+ fn recoverable_parse(&mut self, input: I) -> (I, Option<O>, Vec<R>) {
+ debug_assert!(
+ !I::is_partial_supported(),
+ "partial streams need to handle `ErrMode::Incomplete`"
+ );
+
+ let start = input.checkpoint();
+ let mut input = Recoverable::new(input);
+ let start_token = input.checkpoint();
+ let result = (
+ self.by_ref(),
+ crate::combinator::eof.resume_after(rest.void()),
+ )
+ .parse_next(&mut input);
+
+ let (o, err) = match result {
+ Ok((o, _)) => (Some(o), None),
+ Err(err) => {
+ let err = err
+ .into_inner()
+ .expect("complete parsers should not report `ErrMode::Incomplete(_)`");
+ let err_start = input.checkpoint();
+ let err = R::from_recoverable_error(&start_token, &err_start, &input, err);
+ (None, Some(err))
+ }
+ };
+
+ let (mut input, mut errs) = input.into_parts();
+ input.reset(start);
+ if let Some(err) = err {
+ errs.push(err);
+ }
+
+ (input, o, errs)
+ }
+}
+
+impl_parser_for_tuples!(
+ P1 O1,
+ P2 O2,
+ P3 O3,
+ P4 O4,
+ P5 O5,
+ P6 O6,
+ P7 O7,
+ P8 O8,
+ P9 O9,
+ P10 O10,
+ P11 O11,
+ P12 O12,
+ P13 O13,
+ P14 O14,
+ P15 O15,
+ P16 O16,
+ P17 O17,
+ P18 O18,
+ P19 O19,
+ P20 O20,
+ P21 O21
+);
+
+#[cfg(feature = "alloc")]
+use alloc::boxed::Box;
+
+#[cfg(feature = "alloc")]
+impl<'a, I, O, E> Parser<I, O, E> for Box<dyn Parser<I, O, E> + 'a> {
+ #[inline(always)]
+ fn parse_next(&mut self, i: &mut I) -> PResult<O, E> {
+ (**self).parse_next(i)
+ }
+}
+
+/// Convert a [`Parser::parse_peek`] style parse function to be a [`Parser`]
+#[inline(always)]
+pub fn unpeek<'a, I, O, E>(
+ mut peek: impl FnMut(I) -> IResult<I, O, E> + 'a,
+) -> impl FnMut(&mut I) -> PResult<O, E>
+where
+ I: Clone,
+{
+ move |input| match peek((*input).clone()) {
+ Ok((i, o)) => {
+ *input = i;
+ Ok(o)
+ }
+ Err(err) => Err(err),
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+ use crate::binary::be_u16;
+ use crate::error::ErrMode;
+ use crate::error::ErrorKind;
+ use crate::error::InputError;
+ use crate::error::Needed;
+ use crate::token::take;
+ use crate::Partial;
+
+ #[doc(hidden)]
+ #[macro_export]
+ macro_rules! assert_size (
+ ($t:ty, $sz:expr) => (
+ assert!($crate::lib::std::mem::size_of::<$t>() <= $sz, "{} <= {} failed", $crate::lib::std::mem::size_of::<$t>(), $sz);
+ );
+ );
+
+ #[test]
+ #[cfg(target_pointer_width = "64")]
+ fn size_test() {
+ assert_size!(IResult<&[u8], &[u8], (&[u8], u32)>, 40);
+ assert_size!(IResult<&str, &str, u32>, 40);
+ assert_size!(Needed, 8);
+ assert_size!(ErrMode<u32>, 16);
+ assert_size!(ErrorKind, 1);
+ }
+
+ #[test]
+ fn err_map_test() {
+ let e = ErrMode::Backtrack(1);
+ assert_eq!(e.map(|v| v + 1), ErrMode::Backtrack(2));
+ }
+
+ #[test]
+ fn single_element_tuples() {
+ use crate::ascii::alpha1;
+ use crate::error::ErrorKind;
+
+ let mut parser = (alpha1,);
+ assert_eq!(parser.parse_peek("abc123def"), Ok(("123def", ("abc",))));
+ assert_eq!(
+ parser.parse_peek("123def"),
+ Err(ErrMode::Backtrack(InputError::new(
+ "123def",
+ ErrorKind::Slice
+ )))
+ );
+ }
+
+ #[test]
+ fn tuple_test() {
+ #[allow(clippy::type_complexity)]
+ fn tuple_3(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, (u16, &[u8], &[u8])> {
+ (be_u16, take(3u8), "fg").parse_peek(i)
+ }
+
+ assert_eq!(
+ tuple_3(Partial::new(&b"abcdefgh"[..])),
+ Ok((
+ Partial::new(&b"h"[..]),
+ (0x6162u16, &b"cde"[..], &b"fg"[..])
+ ))
+ );
+ assert_eq!(
+ tuple_3(Partial::new(&b"abcd"[..])),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ tuple_3(Partial::new(&b"abcde"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ tuple_3(Partial::new(&b"abcdejk"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"jk"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ }
+
+ #[test]
+ fn unit_type() {
+ fn parser(i: &mut &str) -> PResult<()> {
+ ().parse_next(i)
+ }
+ assert_eq!(parser.parse_peek("abxsbsh"), Ok(("abxsbsh", ())));
+ assert_eq!(parser.parse_peek("sdfjakdsas"), Ok(("sdfjakdsas", ())));
+ assert_eq!(parser.parse_peek(""), Ok(("", ())));
+ }
+}
diff --git a/crates/winnow/src/stream/impls.rs b/crates/winnow/src/stream/impls.rs
new file mode 100644
index 0000000..d76e1bf
--- /dev/null
+++ b/crates/winnow/src/stream/impls.rs
@@ -0,0 +1,537 @@
+macro_rules! impl_partial_eq {
+ ($lhs:ty, $rhs:ty) => {
+ impl<'a, 'b> PartialEq<$rhs> for $lhs {
+ #[inline]
+ fn eq(&self, other: &$rhs) -> bool {
+ let l = self.as_ref();
+ let r: &Self = other.as_ref();
+ PartialEq::eq(l, r)
+ }
+ }
+
+ impl<'a, 'b> PartialEq<$lhs> for $rhs {
+ #[inline]
+ fn eq(&self, other: &$lhs) -> bool {
+ PartialEq::eq(other, self)
+ }
+ }
+ };
+}
+
+macro_rules! impl_partial_ord {
+ ($lhs:ty, $rhs:ty) => {
+ impl<'a, 'b> PartialOrd<$rhs> for $lhs {
+ #[inline]
+ fn partial_cmp(&self, other: &$rhs) -> Option<Ordering> {
+ let l = self.as_ref();
+ let r: &Self = other.as_ref();
+ PartialOrd::partial_cmp(l, r)
+ }
+ }
+
+ impl<'a, 'b> PartialOrd<$lhs> for $rhs {
+ #[inline]
+ fn partial_cmp(&self, other: &$lhs) -> Option<Ordering> {
+ PartialOrd::partial_cmp(other, self)
+ }
+ }
+ };
+}
+
+mod bytes {
+ use crate::lib::std::{cmp::Ordering, fmt, ops};
+
+ use crate::stream::Bytes;
+
+ impl fmt::Display for Bytes {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ <Self as fmt::UpperHex>::fmt(self, f)
+ }
+ }
+
+ impl fmt::Debug for Bytes {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ <Self as fmt::UpperHex>::fmt(self, f)
+ }
+ }
+
+ impl fmt::LowerHex for Bytes {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ for byte in self.as_bytes() {
+ write!(f, "{:0>2x}", byte)?;
+ }
+ Ok(())
+ }
+ }
+
+ impl fmt::UpperHex for Bytes {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ for (i, byte) in self.as_bytes().iter().enumerate() {
+ if 0 < i {
+ let absolute = (self.as_bytes().as_ptr() as usize) + i;
+ if f.alternate() && absolute != 0 && absolute % 4 == 0 {
+ write!(f, "_")?;
+ }
+ }
+ write!(f, "{:0>2X}", byte)?;
+ }
+ Ok(())
+ }
+ }
+
+ impl ops::Deref for Bytes {
+ type Target = [u8];
+
+ #[inline]
+ fn deref(&self) -> &[u8] {
+ self.as_bytes()
+ }
+ }
+
+ impl ops::Index<usize> for Bytes {
+ type Output = u8;
+
+ #[inline]
+ fn index(&self, idx: usize) -> &u8 {
+ &self.as_bytes()[idx]
+ }
+ }
+
+ impl ops::Index<ops::RangeFull> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, _: ops::RangeFull) -> &Bytes {
+ self
+ }
+ }
+
+ impl ops::Index<ops::Range<usize>> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, r: ops::Range<usize>) -> &Bytes {
+ Bytes::new(&self.as_bytes()[r.start..r.end])
+ }
+ }
+
+ impl ops::Index<ops::RangeInclusive<usize>> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, r: ops::RangeInclusive<usize>) -> &Bytes {
+ Bytes::new(&self.as_bytes()[*r.start()..=*r.end()])
+ }
+ }
+
+ impl ops::Index<ops::RangeFrom<usize>> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, r: ops::RangeFrom<usize>) -> &Bytes {
+ Bytes::new(&self.as_bytes()[r.start..])
+ }
+ }
+
+ impl ops::Index<ops::RangeTo<usize>> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, r: ops::RangeTo<usize>) -> &Bytes {
+ Bytes::new(&self.as_bytes()[..r.end])
+ }
+ }
+
+ impl ops::Index<ops::RangeToInclusive<usize>> for Bytes {
+ type Output = Bytes;
+
+ #[inline]
+ fn index(&self, r: ops::RangeToInclusive<usize>) -> &Bytes {
+ Bytes::new(&self.as_bytes()[..=r.end])
+ }
+ }
+
+ impl AsRef<[u8]> for Bytes {
+ #[inline]
+ fn as_ref(&self) -> &[u8] {
+ self.as_bytes()
+ }
+ }
+
+ impl AsRef<Bytes> for [u8] {
+ #[inline]
+ fn as_ref(&self) -> &Bytes {
+ Bytes::new(self)
+ }
+ }
+
+ impl AsRef<Bytes> for str {
+ #[inline]
+ fn as_ref(&self) -> &Bytes {
+ Bytes::new(self)
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl crate::lib::std::borrow::ToOwned for Bytes {
+ type Owned = crate::lib::std::vec::Vec<u8>;
+
+ #[inline]
+ fn to_owned(&self) -> Self::Owned {
+ crate::lib::std::vec::Vec::from(self.as_bytes())
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl crate::lib::std::borrow::Borrow<Bytes> for crate::lib::std::vec::Vec<u8> {
+ #[inline]
+ fn borrow(&self) -> &Bytes {
+ Bytes::from_bytes(self.as_slice())
+ }
+ }
+
+ impl<'a> Default for &'a Bytes {
+ fn default() -> &'a Bytes {
+ Bytes::new(b"")
+ }
+ }
+
+ impl<'a> From<&'a [u8]> for &'a Bytes {
+ #[inline]
+ fn from(s: &'a [u8]) -> &'a Bytes {
+ Bytes::new(s)
+ }
+ }
+
+ impl<'a> From<&'a Bytes> for &'a [u8] {
+ #[inline]
+ fn from(s: &'a Bytes) -> &'a [u8] {
+ Bytes::as_bytes(s)
+ }
+ }
+
+ impl<'a> From<&'a str> for &'a Bytes {
+ #[inline]
+ fn from(s: &'a str) -> &'a Bytes {
+ Bytes::new(s.as_bytes())
+ }
+ }
+
+ impl Eq for Bytes {}
+
+ impl PartialEq<Bytes> for Bytes {
+ #[inline]
+ fn eq(&self, other: &Bytes) -> bool {
+ self.as_bytes() == other.as_bytes()
+ }
+ }
+
+ impl_partial_eq!(Bytes, [u8]);
+ impl_partial_eq!(Bytes, &'a [u8]);
+ impl_partial_eq!(Bytes, str);
+ impl_partial_eq!(Bytes, &'a str);
+
+ impl PartialOrd for Bytes {
+ #[inline]
+ fn partial_cmp(&self, other: &Bytes) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+ }
+
+ impl Ord for Bytes {
+ #[inline]
+ fn cmp(&self, other: &Bytes) -> Ordering {
+ Ord::cmp(self.as_bytes(), other.as_bytes())
+ }
+ }
+
+ impl_partial_ord!(Bytes, [u8]);
+ impl_partial_ord!(Bytes, &'a [u8]);
+ impl_partial_ord!(Bytes, str);
+ impl_partial_ord!(Bytes, &'a str);
+
+ #[cfg(all(test, feature = "std"))]
+ mod display {
+ use crate::stream::Bytes;
+
+ #[test]
+ fn clean() {
+ assert_eq!(&format!("{}", Bytes::new(b"abc")), "616263");
+ assert_eq!(&format!("{}", Bytes::new(b"\xf0\x28\x8c\xbc")), "F0288CBC");
+ }
+ }
+
+ #[cfg(all(test, feature = "std"))]
+ mod debug {
+ use crate::stream::Bytes;
+
+ #[test]
+ fn test_debug() {
+ assert_eq!(
+ "000000206674797069736F6D0000020069736F6D69736F32617663316D70",
+ format!(
+ "{:?}",
+ Bytes::new(b"\0\0\0 ftypisom\0\0\x02\0isomiso2avc1mp")
+ ),
+ );
+ }
+
+ #[test]
+ fn test_pretty_debug() {
+ // Output can change from run-to-run
+ format!(
+ "{:#?}",
+ Bytes::new(b"\0\0\0 ftypisom\0\0\x02\0isomiso2avc1mp")
+ );
+ }
+
+ #[test]
+ fn test_sliced() {
+ // Output can change from run-to-run
+ let total = Bytes::new(b"12345678901234567890");
+ format!("{:#?}", total);
+ format!("{:#?}", &total[1..]);
+ format!("{:#?}", &total[10..]);
+ }
+ }
+}
+
+mod bstr {
+ use crate::lib::std::{cmp::Ordering, fmt, ops};
+
+ use crate::stream::BStr;
+
+ #[cfg(feature = "alloc")]
+ impl fmt::Display for BStr {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ crate::lib::std::string::String::from_utf8_lossy(self.as_bytes()).fmt(f)
+ }
+ }
+
+ impl fmt::Debug for BStr {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if !f.alternate() {
+ write!(f, "\"")?;
+ }
+ for byte in self.as_bytes() {
+ let c = *byte as char;
+ write!(f, "{}", c.escape_debug())?;
+ }
+ if !f.alternate() {
+ write!(f, "\"")?;
+ }
+ Ok(())
+ }
+ }
+
+ impl ops::Deref for BStr {
+ type Target = [u8];
+
+ #[inline]
+ fn deref(&self) -> &[u8] {
+ self.as_bytes()
+ }
+ }
+
+ impl ops::Index<usize> for BStr {
+ type Output = u8;
+
+ #[inline]
+ fn index(&self, idx: usize) -> &u8 {
+ &self.as_bytes()[idx]
+ }
+ }
+
+ impl ops::Index<ops::RangeFull> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, _: ops::RangeFull) -> &BStr {
+ self
+ }
+ }
+
+ impl ops::Index<ops::Range<usize>> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, r: ops::Range<usize>) -> &BStr {
+ BStr::new(&self.as_bytes()[r.start..r.end])
+ }
+ }
+
+ impl ops::Index<ops::RangeInclusive<usize>> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, r: ops::RangeInclusive<usize>) -> &BStr {
+ BStr::new(&self.as_bytes()[*r.start()..=*r.end()])
+ }
+ }
+
+ impl ops::Index<ops::RangeFrom<usize>> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, r: ops::RangeFrom<usize>) -> &BStr {
+ BStr::new(&self.as_bytes()[r.start..])
+ }
+ }
+
+ impl ops::Index<ops::RangeTo<usize>> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, r: ops::RangeTo<usize>) -> &BStr {
+ BStr::new(&self.as_bytes()[..r.end])
+ }
+ }
+
+ impl ops::Index<ops::RangeToInclusive<usize>> for BStr {
+ type Output = BStr;
+
+ #[inline]
+ fn index(&self, r: ops::RangeToInclusive<usize>) -> &BStr {
+ BStr::new(&self.as_bytes()[..=r.end])
+ }
+ }
+
+ impl AsRef<[u8]> for BStr {
+ #[inline]
+ fn as_ref(&self) -> &[u8] {
+ self.as_bytes()
+ }
+ }
+
+ impl AsRef<BStr> for [u8] {
+ #[inline]
+ fn as_ref(&self) -> &BStr {
+ BStr::new(self)
+ }
+ }
+
+ impl AsRef<BStr> for str {
+ #[inline]
+ fn as_ref(&self) -> &BStr {
+ BStr::new(self)
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl crate::lib::std::borrow::ToOwned for BStr {
+ type Owned = crate::lib::std::vec::Vec<u8>;
+
+ #[inline]
+ fn to_owned(&self) -> Self::Owned {
+ crate::lib::std::vec::Vec::from(self.as_bytes())
+ }
+ }
+
+ #[cfg(feature = "alloc")]
+ impl crate::lib::std::borrow::Borrow<BStr> for crate::lib::std::vec::Vec<u8> {
+ #[inline]
+ fn borrow(&self) -> &BStr {
+ BStr::from_bytes(self.as_slice())
+ }
+ }
+
+ impl<'a> Default for &'a BStr {
+ fn default() -> &'a BStr {
+ BStr::new(b"")
+ }
+ }
+
+ impl<'a> From<&'a [u8]> for &'a BStr {
+ #[inline]
+ fn from(s: &'a [u8]) -> &'a BStr {
+ BStr::new(s)
+ }
+ }
+
+ impl<'a> From<&'a BStr> for &'a [u8] {
+ #[inline]
+ fn from(s: &'a BStr) -> &'a [u8] {
+ BStr::as_bytes(s)
+ }
+ }
+
+ impl<'a> From<&'a str> for &'a BStr {
+ #[inline]
+ fn from(s: &'a str) -> &'a BStr {
+ BStr::new(s.as_bytes())
+ }
+ }
+
+ impl Eq for BStr {}
+
+ impl PartialEq<BStr> for BStr {
+ #[inline]
+ fn eq(&self, other: &BStr) -> bool {
+ self.as_bytes() == other.as_bytes()
+ }
+ }
+
+ impl_partial_eq!(BStr, [u8]);
+ impl_partial_eq!(BStr, &'a [u8]);
+ impl_partial_eq!(BStr, str);
+ impl_partial_eq!(BStr, &'a str);
+
+ impl PartialOrd for BStr {
+ #[inline]
+ fn partial_cmp(&self, other: &BStr) -> Option<Ordering> {
+ Some(self.cmp(other))
+ }
+ }
+
+ impl Ord for BStr {
+ #[inline]
+ fn cmp(&self, other: &BStr) -> Ordering {
+ Ord::cmp(self.as_bytes(), other.as_bytes())
+ }
+ }
+
+ impl_partial_ord!(BStr, [u8]);
+ impl_partial_ord!(BStr, &'a [u8]);
+ impl_partial_ord!(BStr, str);
+ impl_partial_ord!(BStr, &'a str);
+
+ #[cfg(all(test, feature = "std"))]
+ mod display {
+ use crate::stream::BStr;
+
+ #[test]
+ fn clean() {
+ assert_eq!(&format!("{}", BStr::new(b"abc")), "abc");
+ assert_eq!(&format!("{}", BStr::new(b"\xf0\x28\x8c\xbc")), "�(��");
+ }
+ }
+
+ #[cfg(all(test, feature = "std"))]
+ mod debug {
+ use crate::stream::BStr;
+
+ #[test]
+ fn test_debug() {
+ assert_eq!(&format!("{:?}", BStr::new(b"abc")), "\"abc\"");
+
+ assert_eq!(
+ "\"\\0\\0\\0 ftypisom\\0\\0\\u{2}\\0isomiso2avc1mp\"",
+ format!(
+ "{:?}",
+ BStr::new(b"\0\0\0 ftypisom\0\0\x02\0isomiso2avc1mp")
+ ),
+ );
+ }
+
+ #[test]
+ fn test_pretty_debug() {
+ assert_eq!(&format!("{:#?}", BStr::new(b"abc")), "abc");
+ }
+ }
+}
diff --git a/crates/winnow/src/stream/mod.rs b/crates/winnow/src/stream/mod.rs
new file mode 100644
index 0000000..6873ac3
--- /dev/null
+++ b/crates/winnow/src/stream/mod.rs
@@ -0,0 +1,3684 @@
+//! Stream capability for combinators to parse
+//!
+//! Stream types include:
+//! - `&[u8]` and [`Bytes`] for binary data
+//! - `&str` (aliased as [`Str`]) and [`BStr`] for UTF-8 data
+//! - [`Located`] can track the location within the original buffer to report
+//! [spans][crate::Parser::with_span]
+//! - [`Stateful`] to thread global state through your parsers
+//! - [`Partial`] can mark an input as partial buffer that is being streamed into
+//! - [Custom stream types][crate::_topic::stream]
+
+use core::hash::BuildHasher;
+use core::num::NonZeroUsize;
+
+use crate::ascii::Caseless as AsciiCaseless;
+#[cfg(feature = "unstable-recover")]
+use crate::error::FromRecoverableError;
+use crate::error::Needed;
+use crate::lib::std::iter::{Cloned, Enumerate};
+use crate::lib::std::slice::Iter;
+use crate::lib::std::str::from_utf8;
+use crate::lib::std::str::CharIndices;
+use crate::lib::std::str::FromStr;
+
+#[allow(unused_imports)]
+#[cfg(any(feature = "unstable-doc", feature = "unstable-recover"))]
+use crate::error::ErrMode;
+
+#[cfg(feature = "alloc")]
+use crate::lib::std::collections::BTreeMap;
+#[cfg(feature = "alloc")]
+use crate::lib::std::collections::BTreeSet;
+#[cfg(feature = "std")]
+use crate::lib::std::collections::HashMap;
+#[cfg(feature = "std")]
+use crate::lib::std::collections::HashSet;
+#[cfg(feature = "alloc")]
+use crate::lib::std::string::String;
+#[cfg(feature = "alloc")]
+use crate::lib::std::vec::Vec;
+
+mod impls;
+#[cfg(test)]
+mod tests;
+
+/// UTF-8 Stream
+pub type Str<'i> = &'i str;
+
+/// Improved `Debug` experience for `&[u8]` byte streams
+#[allow(clippy::derive_hash_xor_eq)]
+#[derive(Hash)]
+#[repr(transparent)]
+pub struct Bytes([u8]);
+
+impl Bytes {
+ /// Make a stream out of a byte slice-like.
+ #[inline]
+ pub fn new<B: ?Sized + AsRef<[u8]>>(bytes: &B) -> &Self {
+ Self::from_bytes(bytes.as_ref())
+ }
+
+ #[inline]
+ fn from_bytes(slice: &[u8]) -> &Self {
+ unsafe { crate::lib::std::mem::transmute(slice) }
+ }
+
+ #[inline]
+ fn as_bytes(&self) -> &[u8] {
+ &self.0
+ }
+}
+
+/// Improved `Debug` experience for `&[u8]` UTF-8-ish streams
+#[allow(clippy::derive_hash_xor_eq)]
+#[derive(Hash)]
+#[repr(transparent)]
+pub struct BStr([u8]);
+
+impl BStr {
+ /// Make a stream out of a byte slice-like.
+ #[inline]
+ pub fn new<B: ?Sized + AsRef<[u8]>>(bytes: &B) -> &Self {
+ Self::from_bytes(bytes.as_ref())
+ }
+
+ #[inline]
+ fn from_bytes(slice: &[u8]) -> &Self {
+ unsafe { crate::lib::std::mem::transmute(slice) }
+ }
+
+ #[inline]
+ fn as_bytes(&self) -> &[u8] {
+ &self.0
+ }
+}
+
+/// Allow collecting the span of a parsed token
+///
+/// Spans are tracked as a [`Range<usize>`] of byte offsets.
+///
+/// Converting byte offsets to line or column numbers is left up to the user, as computing column
+/// numbers requires domain knowledge (are columns byte-based, codepoint-based, or grapheme-based?)
+/// and O(n) iteration over the input to determine codepoint and line boundaries.
+///
+/// [The `line-span` crate](https://docs.rs/line-span/latest/line_span/) can help with converting
+/// byte offsets to line numbers.
+///
+/// See [`Parser::span`][crate::Parser::span] and [`Parser::with_span`][crate::Parser::with_span] for more details
+#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, PartialOrd, Ord)]
+#[doc(alias = "LocatedSpan")]
+pub struct Located<I> {
+ initial: I,
+ input: I,
+}
+
+impl<I> Located<I>
+where
+ I: Clone + Offset,
+{
+ /// Wrap another Stream with span tracking
+ pub fn new(input: I) -> Self {
+ let initial = input.clone();
+ Self { initial, input }
+ }
+
+ fn location(&self) -> usize {
+ self.input.offset_from(&self.initial)
+ }
+}
+
+impl<I> AsRef<I> for Located<I> {
+ #[inline(always)]
+ fn as_ref(&self) -> &I {
+ &self.input
+ }
+}
+
+impl<I> crate::lib::std::ops::Deref for Located<I> {
+ type Target = I;
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.input
+ }
+}
+
+impl<I: crate::lib::std::fmt::Display> crate::lib::std::fmt::Display for Located<I> {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ self.input.fmt(f)
+ }
+}
+
+/// Allow recovering from parse errors, capturing them as the parser continues
+///
+/// Generally, this will be used indirectly via
+/// [`RecoverableParser::recoverable_parse`][crate::RecoverableParser::recoverable_parse].
+#[cfg(feature = "unstable-recover")]
+#[derive(Clone, Debug)]
+pub struct Recoverable<I, E>
+where
+ I: Stream,
+{
+ input: I,
+ errors: Vec<E>,
+ is_recoverable: bool,
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Recoverable<I, E>
+where
+ I: Stream,
+{
+ /// Track recoverable errors with the stream
+ pub fn new(input: I) -> Self {
+ Self {
+ input,
+ errors: Default::default(),
+ is_recoverable: true,
+ }
+ }
+
+ /// Act as a normal stream
+ pub fn unrecoverable(input: I) -> Self {
+ Self {
+ input,
+ errors: Default::default(),
+ is_recoverable: false,
+ }
+ }
+
+ /// Access the current input and errors
+ pub fn into_parts(self) -> (I, Vec<E>) {
+ (self.input, self.errors)
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> AsRef<I> for Recoverable<I, E>
+where
+ I: Stream,
+{
+ #[inline(always)]
+ fn as_ref(&self) -> &I {
+ &self.input
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> crate::lib::std::ops::Deref for Recoverable<I, E>
+where
+ I: Stream,
+{
+ type Target = I;
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.input
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I: crate::lib::std::fmt::Display, E> crate::lib::std::fmt::Display for Recoverable<I, E>
+where
+ I: Stream,
+{
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ crate::lib::std::fmt::Display::fmt(&self.input, f)
+ }
+}
+
+/// Thread global state through your parsers
+///
+/// Use cases
+/// - Recursion checks
+/// - Error recovery
+/// - Debugging
+///
+/// # Example
+///
+/// ```
+/// # use std::cell::Cell;
+/// # use winnow::prelude::*;
+/// # use winnow::stream::Stateful;
+/// # use winnow::ascii::alpha1;
+/// # type Error = ();
+///
+/// #[derive(Clone, Debug)]
+/// struct State<'s>(&'s Cell<u32>);
+///
+/// impl<'s> State<'s> {
+/// fn count(&self) {
+/// self.0.set(self.0.get() + 1);
+/// }
+/// }
+///
+/// type Stream<'is> = Stateful<&'is str, State<'is>>;
+///
+/// fn word<'s>(i: &mut Stream<'s>) -> PResult<&'s str> {
+/// i.state.count();
+/// alpha1.parse_next(i)
+/// }
+///
+/// let data = "Hello";
+/// let state = Cell::new(0);
+/// let input = Stream { input: data, state: State(&state) };
+/// let output = word.parse(input).unwrap();
+/// assert_eq!(state.get(), 1);
+/// ```
+#[derive(Clone, Copy, Debug, Eq, PartialEq)]
+#[doc(alias = "LocatedSpan")]
+pub struct Stateful<I, S> {
+ /// Inner input being wrapped in state
+ pub input: I,
+ /// User-provided state
+ pub state: S,
+}
+
+impl<I, S> AsRef<I> for Stateful<I, S> {
+ #[inline(always)]
+ fn as_ref(&self) -> &I {
+ &self.input
+ }
+}
+
+impl<I, S> crate::lib::std::ops::Deref for Stateful<I, S> {
+ type Target = I;
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ self.as_ref()
+ }
+}
+
+impl<I: crate::lib::std::fmt::Display, S> crate::lib::std::fmt::Display for Stateful<I, S> {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ self.input.fmt(f)
+ }
+}
+
+/// Mark the input as a partial buffer for streaming input.
+///
+/// Complete input means that we already have all of the data. This will be the common case with
+/// small files that can be read entirely to memory.
+///
+/// In contrast, streaming input assumes that we might not have all of the data.
+/// This can happen with some network protocol or large file parsers, where the
+/// input buffer can be full and need to be resized or refilled.
+/// - [`ErrMode::Incomplete`] will report how much more data is needed.
+/// - [`Parser::complete_err`][crate::Parser::complete_err] transform [`ErrMode::Incomplete`] to
+/// [`ErrMode::Backtrack`]
+///
+/// See also [`StreamIsPartial`] to tell whether the input supports complete or partial parsing.
+///
+/// See also [Special Topics: Parsing Partial Input][crate::_topic::partial].
+///
+/// # Example
+///
+/// Here is how it works in practice:
+///
+/// ```rust
+/// # use winnow::{PResult, error::ErrMode, error::Needed, error::{InputError, ErrorKind}, token, ascii, stream::Partial};
+/// # use winnow::prelude::*;
+///
+/// fn take_partial<'s>(i: &mut Partial<&'s [u8]>) -> PResult<&'s [u8], InputError<Partial<&'s [u8]>>> {
+/// token::take(4u8).parse_next(i)
+/// }
+///
+/// fn take_complete<'s>(i: &mut &'s [u8]) -> PResult<&'s [u8], InputError<&'s [u8]>> {
+/// token::take(4u8).parse_next(i)
+/// }
+///
+/// // both parsers will take 4 bytes as expected
+/// assert_eq!(take_partial.parse_peek(Partial::new(&b"abcde"[..])), Ok((Partial::new(&b"e"[..]), &b"abcd"[..])));
+/// assert_eq!(take_complete.parse_peek(&b"abcde"[..]), Ok((&b"e"[..], &b"abcd"[..])));
+///
+/// // if the input is smaller than 4 bytes, the partial parser
+/// // will return `Incomplete` to indicate that we need more data
+/// assert_eq!(take_partial.parse_peek(Partial::new(&b"abc"[..])), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// // but the complete parser will return an error
+/// assert_eq!(take_complete.parse_peek(&b"abc"[..]), Err(ErrMode::Backtrack(InputError::new(&b"abc"[..], ErrorKind::Slice))));
+///
+/// // the alpha0 function recognizes 0 or more alphabetic characters
+/// fn alpha0_partial<'s>(i: &mut Partial<&'s str>) -> PResult<&'s str, InputError<Partial<&'s str>>> {
+/// ascii::alpha0.parse_next(i)
+/// }
+///
+/// fn alpha0_complete<'s>(i: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// ascii::alpha0.parse_next(i)
+/// }
+///
+/// // if there's a clear limit to the recognized characters, both parsers work the same way
+/// assert_eq!(alpha0_partial.parse_peek(Partial::new("abcd;")), Ok((Partial::new(";"), "abcd")));
+/// assert_eq!(alpha0_complete.parse_peek("abcd;"), Ok((";", "abcd")));
+///
+/// // but when there's no limit, the partial version returns `Incomplete`, because it cannot
+/// // know if more input data should be recognized. The whole input could be "abcd;", or
+/// // "abcde;"
+/// assert_eq!(alpha0_partial.parse_peek(Partial::new("abcd")), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// // while the complete version knows that all of the data is there
+/// assert_eq!(alpha0_complete.parse_peek("abcd"), Ok(("", "abcd")));
+/// ```
+#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
+pub struct Partial<I> {
+ input: I,
+ partial: bool,
+}
+
+impl<I> Partial<I>
+where
+ I: StreamIsPartial,
+{
+ /// Create a partial input
+ pub fn new(input: I) -> Self {
+ debug_assert!(
+ !I::is_partial_supported(),
+ "`Partial` can only wrap complete sources"
+ );
+ let partial = true;
+ Self { input, partial }
+ }
+
+ /// Extract the original [`Stream`]
+ #[inline(always)]
+ pub fn into_inner(self) -> I {
+ self.input
+ }
+}
+
+impl<I> Default for Partial<I>
+where
+ I: Default + StreamIsPartial,
+{
+ fn default() -> Self {
+ Self::new(I::default())
+ }
+}
+
+impl<I> crate::lib::std::ops::Deref for Partial<I> {
+ type Target = I;
+
+ #[inline(always)]
+ fn deref(&self) -> &Self::Target {
+ &self.input
+ }
+}
+
+impl<I: crate::lib::std::fmt::Display> crate::lib::std::fmt::Display for Partial<I> {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ self.input.fmt(f)
+ }
+}
+
+/// Abstract method to calculate the input length
+pub trait SliceLen {
+ /// Calculates the input length, as indicated by its name,
+ /// and the name of the trait itself
+ fn slice_len(&self) -> usize;
+}
+
+impl<S: SliceLen> SliceLen for AsciiCaseless<S> {
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.0.slice_len()
+ }
+}
+
+impl<'a, T> SliceLen for &'a [T] {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl<T, const LEN: usize> SliceLen for [T; LEN] {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl<'a, T, const LEN: usize> SliceLen for &'a [T; LEN] {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl<'a> SliceLen for &'a str {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl SliceLen for char {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len_utf8()
+ }
+}
+
+impl<'a> SliceLen for &'a Bytes {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl<'a> SliceLen for &'a BStr {
+ #[inline]
+ fn slice_len(&self) -> usize {
+ self.len()
+ }
+}
+
+impl<I> SliceLen for (I, usize, usize)
+where
+ I: SliceLen,
+{
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.0.slice_len() * 8 + self.2 - self.1
+ }
+}
+
+impl<I> SliceLen for Located<I>
+where
+ I: SliceLen,
+{
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.input.slice_len()
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> SliceLen for Recoverable<I, E>
+where
+ I: SliceLen,
+ I: Stream,
+{
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.input.slice_len()
+ }
+}
+
+impl<I, S> SliceLen for Stateful<I, S>
+where
+ I: SliceLen,
+{
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.input.slice_len()
+ }
+}
+
+impl<I> SliceLen for Partial<I>
+where
+ I: SliceLen,
+{
+ #[inline(always)]
+ fn slice_len(&self) -> usize {
+ self.input.slice_len()
+ }
+}
+
+/// Core definition for parser input state
+pub trait Stream: Offset<<Self as Stream>::Checkpoint> + crate::lib::std::fmt::Debug {
+ /// The smallest unit being parsed
+ ///
+ /// Example: `u8` for `&[u8]` or `char` for `&str`
+ type Token: crate::lib::std::fmt::Debug;
+ /// Sequence of `Token`s
+ ///
+ /// Example: `&[u8]` for `Located<&[u8]>` or `&str` for `Located<&str>`
+ type Slice: crate::lib::std::fmt::Debug;
+
+ /// Iterate with the offset from the current location
+ type IterOffsets: Iterator<Item = (usize, Self::Token)>;
+
+ /// A parse location within the stream
+ type Checkpoint: Offset + Clone + crate::lib::std::fmt::Debug;
+
+ /// Iterate with the offset from the current location
+ fn iter_offsets(&self) -> Self::IterOffsets;
+
+ /// Returns the offset to the end of the input
+ fn eof_offset(&self) -> usize;
+
+ /// Split off the next token from the input
+ fn next_token(&mut self) -> Option<Self::Token>;
+ /// Split off the next token from the input
+ #[inline(always)]
+ fn peek_token(&self) -> Option<(Self, Self::Token)>
+ where
+ Self: Clone,
+ {
+ let mut peek = self.clone();
+ let token = peek.next_token()?;
+ Some((peek, token))
+ }
+
+ /// Finds the offset of the next matching token
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool;
+ /// Get the offset for the number of `tokens` into the stream
+ ///
+ /// This means "0 tokens" will return `0` offset
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed>;
+ /// Split off a slice of tokens from the input
+ ///
+ /// **NOTE:** For inputs with variable width tokens, like `&str`'s `char`, `offset` might not correspond
+ /// with the number of tokens. To get a valid offset, use:
+ /// - [`Stream::eof_offset`]
+ /// - [`Stream::iter_offsets`]
+ /// - [`Stream::offset_for`]
+ /// - [`Stream::offset_at`]
+ ///
+ /// # Panic
+ ///
+ /// This will panic if
+ ///
+ /// * Indexes must be within bounds of the original input;
+ /// * Indexes must uphold invariants of the stream, like for `str` they must lie on UTF-8
+ /// sequence boundaries.
+ ///
+ fn next_slice(&mut self, offset: usize) -> Self::Slice;
+ /// Split off a slice of tokens from the input
+ #[inline(always)]
+ fn peek_slice(&self, offset: usize) -> (Self, Self::Slice)
+ where
+ Self: Clone,
+ {
+ let mut peek = self.clone();
+ let slice = peek.next_slice(offset);
+ (peek, slice)
+ }
+
+ /// Advance to the end of the stream
+ #[inline(always)]
+ fn finish(&mut self) -> Self::Slice {
+ self.next_slice(self.eof_offset())
+ }
+ /// Advance to the end of the stream
+ #[inline(always)]
+ fn peek_finish(&self) -> (Self, Self::Slice)
+ where
+ Self: Clone,
+ {
+ let mut peek = self.clone();
+ let slice = peek.finish();
+ (peek, slice)
+ }
+
+ /// Save the current parse location within the stream
+ fn checkpoint(&self) -> Self::Checkpoint;
+ /// Revert the stream to a prior [`Self::Checkpoint`]
+ ///
+ /// # Panic
+ ///
+ /// May panic if an invalid [`Self::Checkpoint`] is provided
+ fn reset(&mut self, checkpoint: Self::Checkpoint);
+
+ /// Return the inner-most stream
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug;
+}
+
+impl<'i, T> Stream for &'i [T]
+where
+ T: Clone + crate::lib::std::fmt::Debug,
+{
+ type Token = T;
+ type Slice = &'i [T];
+
+ type IterOffsets = Enumerate<Cloned<Iter<'i, T>>>;
+
+ type Checkpoint = Checkpoint<Self>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.iter().cloned().enumerate()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.len()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ let (token, next) = self.split_first()?;
+ *self = next;
+ Some(token.clone())
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.iter().position(|b| predicate(b.clone()))
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ if let Some(needed) = tokens.checked_sub(self.len()).and_then(NonZeroUsize::new) {
+ Err(Needed::Size(needed))
+ } else {
+ Ok(tokens)
+ }
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ let (slice, next) = self.split_at(offset);
+ *self = next;
+ slice
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(*self)
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ *self = checkpoint.0;
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ self
+ }
+}
+
+impl<'i> Stream for &'i str {
+ type Token = char;
+ type Slice = &'i str;
+
+ type IterOffsets = CharIndices<'i>;
+
+ type Checkpoint = Checkpoint<Self>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.char_indices()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.len()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ let c = self.chars().next()?;
+ let offset = c.len();
+ *self = &self[offset..];
+ Some(c)
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ for (o, c) in self.iter_offsets() {
+ if predicate(c) {
+ return Some(o);
+ }
+ }
+ None
+ }
+ #[inline]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ let mut cnt = 0;
+ for (offset, _) in self.iter_offsets() {
+ if cnt == tokens {
+ return Ok(offset);
+ }
+ cnt += 1;
+ }
+
+ if cnt == tokens {
+ Ok(self.eof_offset())
+ } else {
+ Err(Needed::Unknown)
+ }
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ let (slice, next) = self.split_at(offset);
+ *self = next;
+ slice
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(*self)
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ *self = checkpoint.0;
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ self
+ }
+}
+
+impl<'i> Stream for &'i Bytes {
+ type Token = u8;
+ type Slice = &'i [u8];
+
+ type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>;
+
+ type Checkpoint = Checkpoint<Self>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.iter().cloned().enumerate()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.len()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ if self.is_empty() {
+ None
+ } else {
+ let token = self[0];
+ *self = &self[1..];
+ Some(token)
+ }
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.iter().position(|b| predicate(*b))
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ if let Some(needed) = tokens.checked_sub(self.len()).and_then(NonZeroUsize::new) {
+ Err(Needed::Size(needed))
+ } else {
+ Ok(tokens)
+ }
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ let (slice, next) = self.0.split_at(offset);
+ *self = Bytes::from_bytes(next);
+ slice
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(*self)
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ *self = checkpoint.0;
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ self
+ }
+}
+
+impl<'i> Stream for &'i BStr {
+ type Token = u8;
+ type Slice = &'i [u8];
+
+ type IterOffsets = Enumerate<Cloned<Iter<'i, u8>>>;
+
+ type Checkpoint = Checkpoint<Self>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.iter().cloned().enumerate()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.len()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ if self.is_empty() {
+ None
+ } else {
+ let token = self[0];
+ *self = &self[1..];
+ Some(token)
+ }
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.iter().position(|b| predicate(*b))
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ if let Some(needed) = tokens.checked_sub(self.len()).and_then(NonZeroUsize::new) {
+ Err(Needed::Size(needed))
+ } else {
+ Ok(tokens)
+ }
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ let (slice, next) = self.0.split_at(offset);
+ *self = BStr::from_bytes(next);
+ slice
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(*self)
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ *self = checkpoint.0;
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ self
+ }
+}
+
+impl<I> Stream for (I, usize)
+where
+ I: Stream<Token = u8> + Clone,
+{
+ type Token = bool;
+ type Slice = (I::Slice, usize, usize);
+
+ type IterOffsets = BitOffsets<I>;
+
+ type Checkpoint = Checkpoint<(I::Checkpoint, usize)>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ BitOffsets {
+ i: self.clone(),
+ o: 0,
+ }
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ let offset = self.0.eof_offset() * 8;
+ if offset == 0 {
+ 0
+ } else {
+ offset - self.1
+ }
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ next_bit(self)
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.iter_offsets()
+ .find_map(|(o, b)| predicate(b).then_some(o))
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ if let Some(needed) = tokens
+ .checked_sub(self.eof_offset())
+ .and_then(NonZeroUsize::new)
+ {
+ Err(Needed::Size(needed))
+ } else {
+ Ok(tokens)
+ }
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ let byte_offset = (offset + self.1) / 8;
+ let end_offset = (offset + self.1) % 8;
+ let s = self.0.next_slice(byte_offset);
+ let start_offset = self.1;
+ self.1 = end_offset;
+ (s, start_offset, end_offset)
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint((self.0.checkpoint(), self.1))
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ self.0.reset(checkpoint.0 .0);
+ self.1 = checkpoint.0 .1;
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ &self.0
+ }
+}
+
+/// Iterator for [bit][crate::binary::bits] stream (`(I, usize)`)
+pub struct BitOffsets<I> {
+ i: (I, usize),
+ o: usize,
+}
+
+impl<I> Iterator for BitOffsets<I>
+where
+ I: Stream<Token = u8> + Clone,
+{
+ type Item = (usize, bool);
+ fn next(&mut self) -> Option<Self::Item> {
+ let b = next_bit(&mut self.i)?;
+ let o = self.o;
+
+ self.o += 1;
+
+ Some((o, b))
+ }
+}
+
+fn next_bit<I>(i: &mut (I, usize)) -> Option<bool>
+where
+ I: Stream<Token = u8> + Clone,
+{
+ if i.eof_offset() == 0 {
+ return None;
+ }
+ let offset = i.1;
+
+ let mut next_i = i.0.clone();
+ let byte = next_i.next_token()?;
+ let bit = (byte >> offset) & 0x1 == 0x1;
+
+ let next_offset = offset + 1;
+ if next_offset == 8 {
+ i.0 = next_i;
+ i.1 = 0;
+ Some(bit)
+ } else {
+ i.1 = next_offset;
+ Some(bit)
+ }
+}
+
+impl<I: Stream> Stream for Located<I> {
+ type Token = <I as Stream>::Token;
+ type Slice = <I as Stream>::Slice;
+
+ type IterOffsets = <I as Stream>::IterOffsets;
+
+ type Checkpoint = Checkpoint<I::Checkpoint>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.input.iter_offsets()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.input.eof_offset()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ self.input.next_token()
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.input.offset_for(predicate)
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ self.input.offset_at(tokens)
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ self.input.next_slice(offset)
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(self.input.checkpoint())
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ self.input.reset(checkpoint.0);
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ &self.input
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E: crate::lib::std::fmt::Debug> Stream for Recoverable<I, E>
+where
+ I: Stream,
+{
+ type Token = <I as Stream>::Token;
+ type Slice = <I as Stream>::Slice;
+
+ type IterOffsets = <I as Stream>::IterOffsets;
+
+ type Checkpoint = Checkpoint<I::Checkpoint>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.input.iter_offsets()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.input.eof_offset()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ self.input.next_token()
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.input.offset_for(predicate)
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ self.input.offset_at(tokens)
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ self.input.next_slice(offset)
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(self.input.checkpoint())
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ self.input.reset(checkpoint.0);
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ &self.input
+ }
+}
+
+impl<I: Stream, S: crate::lib::std::fmt::Debug> Stream for Stateful<I, S> {
+ type Token = <I as Stream>::Token;
+ type Slice = <I as Stream>::Slice;
+
+ type IterOffsets = <I as Stream>::IterOffsets;
+
+ type Checkpoint = Checkpoint<I::Checkpoint>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.input.iter_offsets()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.input.eof_offset()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ self.input.next_token()
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.input.offset_for(predicate)
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ self.input.offset_at(tokens)
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ self.input.next_slice(offset)
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(self.input.checkpoint())
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ self.input.reset(checkpoint.0);
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ &self.input
+ }
+}
+
+impl<I: Stream> Stream for Partial<I> {
+ type Token = <I as Stream>::Token;
+ type Slice = <I as Stream>::Slice;
+
+ type IterOffsets = <I as Stream>::IterOffsets;
+
+ type Checkpoint = Checkpoint<I::Checkpoint>;
+
+ #[inline(always)]
+ fn iter_offsets(&self) -> Self::IterOffsets {
+ self.input.iter_offsets()
+ }
+ #[inline(always)]
+ fn eof_offset(&self) -> usize {
+ self.input.eof_offset()
+ }
+
+ #[inline(always)]
+ fn next_token(&mut self) -> Option<Self::Token> {
+ self.input.next_token()
+ }
+
+ #[inline(always)]
+ fn offset_for<P>(&self, predicate: P) -> Option<usize>
+ where
+ P: Fn(Self::Token) -> bool,
+ {
+ self.input.offset_for(predicate)
+ }
+ #[inline(always)]
+ fn offset_at(&self, tokens: usize) -> Result<usize, Needed> {
+ self.input.offset_at(tokens)
+ }
+ #[inline(always)]
+ fn next_slice(&mut self, offset: usize) -> Self::Slice {
+ self.input.next_slice(offset)
+ }
+
+ #[inline(always)]
+ fn checkpoint(&self) -> Self::Checkpoint {
+ Checkpoint(self.input.checkpoint())
+ }
+ #[inline(always)]
+ fn reset(&mut self, checkpoint: Self::Checkpoint) {
+ self.input.reset(checkpoint.0);
+ }
+
+ #[inline(always)]
+ fn raw(&self) -> &dyn crate::lib::std::fmt::Debug {
+ &self.input
+ }
+}
+
+/// Number of indices input has advanced since start of parsing
+///
+/// See [`Located`] for adding location tracking to your [`Stream`]
+pub trait Location {
+ /// Number of indices input has advanced since start of parsing
+ fn location(&self) -> usize;
+}
+
+impl<I> Location for Located<I>
+where
+ I: Clone + Offset,
+{
+ #[inline(always)]
+ fn location(&self) -> usize {
+ self.location()
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Location for Recoverable<I, E>
+where
+ I: Location,
+ I: Stream,
+{
+ #[inline(always)]
+ fn location(&self) -> usize {
+ self.input.location()
+ }
+}
+
+impl<I, S> Location for Stateful<I, S>
+where
+ I: Location,
+{
+ #[inline(always)]
+ fn location(&self) -> usize {
+ self.input.location()
+ }
+}
+
+impl<I> Location for Partial<I>
+where
+ I: Location,
+{
+ #[inline(always)]
+ fn location(&self) -> usize {
+ self.input.location()
+ }
+}
+
+/// Capture top-level errors in the middle of parsing so parsing can resume
+///
+/// See [`Recoverable`] for adding error recovery tracking to your [`Stream`]
+#[cfg(feature = "unstable-recover")]
+pub trait Recover<E>: Stream {
+ /// Capture a top-level error
+ ///
+ /// May return `Err(err)` if recovery is not possible (e.g. if [`Recover::is_recovery_supported`]
+ /// returns `false`).
+ fn record_err(
+ &mut self,
+ token_start: &Self::Checkpoint,
+ err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>>;
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ fn is_recovery_supported() -> bool;
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<'a, T, E> Recover<E> for &'a [T]
+where
+ &'a [T]: Stream,
+{
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<'a, E> Recover<E> for &'a str {
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<'a, E> Recover<E> for &'a Bytes {
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<'a, E> Recover<E> for &'a BStr {
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Recover<E> for (I, usize)
+where
+ I: Recover<E>,
+ I: Stream<Token = u8> + Clone,
+{
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Recover<E> for Located<I>
+where
+ I: Recover<E>,
+ I: Stream,
+{
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E, R> Recover<E> for Recoverable<I, R>
+where
+ I: Stream,
+ R: FromRecoverableError<Self, E>,
+ R: crate::lib::std::fmt::Debug,
+{
+ fn record_err(
+ &mut self,
+ token_start: &Self::Checkpoint,
+ err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ if self.is_recoverable {
+ match err {
+ ErrMode::Incomplete(need) => Err(ErrMode::Incomplete(need)),
+ ErrMode::Backtrack(err) | ErrMode::Cut(err) => {
+ self.errors
+ .push(R::from_recoverable_error(token_start, err_start, self, err));
+ Ok(())
+ }
+ }
+ } else {
+ Err(err)
+ }
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ true
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E, S> Recover<E> for Stateful<I, S>
+where
+ I: Recover<E>,
+ I: Stream,
+ S: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Recover<E> for Partial<I>
+where
+ I: Recover<E>,
+ I: Stream,
+{
+ #[inline(always)]
+ fn record_err(
+ &mut self,
+ _token_start: &Self::Checkpoint,
+ _err_start: &Self::Checkpoint,
+ err: ErrMode<E>,
+ ) -> Result<(), ErrMode<E>> {
+ Err(err)
+ }
+
+ /// Report whether the [`Stream`] can save off errors for recovery
+ #[inline(always)]
+ fn is_recovery_supported() -> bool {
+ false
+ }
+}
+
+/// Marks the input as being the complete buffer or a partial buffer for streaming input
+///
+/// See [`Partial`] for marking a presumed complete buffer type as a streaming buffer.
+pub trait StreamIsPartial: Sized {
+ /// Whether the stream is currently partial or complete
+ type PartialState;
+
+ /// Mark the stream is complete
+ #[must_use]
+ fn complete(&mut self) -> Self::PartialState;
+
+ /// Restore the stream back to its previous state
+ fn restore_partial(&mut self, state: Self::PartialState);
+
+ /// Report whether the [`Stream`] is can ever be incomplete
+ fn is_partial_supported() -> bool;
+
+ /// Report whether the [`Stream`] is currently incomplete
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ Self::is_partial_supported()
+ }
+}
+
+impl<'a, T> StreamIsPartial for &'a [T] {
+ type PartialState = ();
+
+ fn complete(&mut self) -> Self::PartialState {}
+
+ fn restore_partial(&mut self, _state: Self::PartialState) {}
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ false
+ }
+}
+
+impl<'a> StreamIsPartial for &'a str {
+ type PartialState = ();
+
+ fn complete(&mut self) -> Self::PartialState {
+ // Already complete
+ }
+
+ fn restore_partial(&mut self, _state: Self::PartialState) {}
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ false
+ }
+}
+
+impl<'a> StreamIsPartial for &'a Bytes {
+ type PartialState = ();
+
+ fn complete(&mut self) -> Self::PartialState {
+ // Already complete
+ }
+
+ fn restore_partial(&mut self, _state: Self::PartialState) {}
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ false
+ }
+}
+
+impl<'a> StreamIsPartial for &'a BStr {
+ type PartialState = ();
+
+ fn complete(&mut self) -> Self::PartialState {
+ // Already complete
+ }
+
+ fn restore_partial(&mut self, _state: Self::PartialState) {}
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ false
+ }
+}
+
+impl<I> StreamIsPartial for (I, usize)
+where
+ I: StreamIsPartial,
+{
+ type PartialState = I::PartialState;
+
+ fn complete(&mut self) -> Self::PartialState {
+ self.0.complete()
+ }
+
+ fn restore_partial(&mut self, state: Self::PartialState) {
+ self.0.restore_partial(state);
+ }
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ I::is_partial_supported()
+ }
+
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ self.0.is_partial()
+ }
+}
+
+impl<I> StreamIsPartial for Located<I>
+where
+ I: StreamIsPartial,
+{
+ type PartialState = I::PartialState;
+
+ fn complete(&mut self) -> Self::PartialState {
+ self.input.complete()
+ }
+
+ fn restore_partial(&mut self, state: Self::PartialState) {
+ self.input.restore_partial(state);
+ }
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ I::is_partial_supported()
+ }
+
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ self.input.is_partial()
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> StreamIsPartial for Recoverable<I, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+{
+ type PartialState = I::PartialState;
+
+ fn complete(&mut self) -> Self::PartialState {
+ self.input.complete()
+ }
+
+ fn restore_partial(&mut self, state: Self::PartialState) {
+ self.input.restore_partial(state);
+ }
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ I::is_partial_supported()
+ }
+
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ self.input.is_partial()
+ }
+}
+
+impl<I, S> StreamIsPartial for Stateful<I, S>
+where
+ I: StreamIsPartial,
+{
+ type PartialState = I::PartialState;
+
+ fn complete(&mut self) -> Self::PartialState {
+ self.input.complete()
+ }
+
+ fn restore_partial(&mut self, state: Self::PartialState) {
+ self.input.restore_partial(state);
+ }
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ I::is_partial_supported()
+ }
+
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ self.input.is_partial()
+ }
+}
+
+impl<I> StreamIsPartial for Partial<I>
+where
+ I: StreamIsPartial,
+{
+ type PartialState = bool;
+
+ fn complete(&mut self) -> Self::PartialState {
+ core::mem::replace(&mut self.partial, false)
+ }
+
+ fn restore_partial(&mut self, state: Self::PartialState) {
+ self.partial = state;
+ }
+
+ #[inline(always)]
+ fn is_partial_supported() -> bool {
+ true
+ }
+
+ #[inline(always)]
+ fn is_partial(&self) -> bool {
+ self.partial
+ }
+}
+
+/// Useful functions to calculate the offset between slices and show a hexdump of a slice
+pub trait Offset<Start = Self> {
+ /// Offset between the first byte of `start` and the first byte of `self`a
+ ///
+ /// **Note:** This is an offset, not an index, and may point to the end of input
+ /// (`start.len()`) when `self` is exhausted.
+ fn offset_from(&self, start: &Start) -> usize;
+}
+
+impl<'a, T> Offset for &'a [T] {
+ #[inline]
+ fn offset_from(&self, start: &Self) -> usize {
+ let fst = (*start).as_ptr();
+ let snd = (*self).as_ptr();
+
+ debug_assert!(
+ fst <= snd,
+ "`Offset::offset_from({snd:?}, {fst:?})` only accepts slices of `self`"
+ );
+ (snd as usize - fst as usize) / crate::lib::std::mem::size_of::<T>()
+ }
+}
+
+impl<'a, T> Offset<<&'a [T] as Stream>::Checkpoint> for &'a [T]
+where
+ T: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<&'a [T] as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<'a> Offset for &'a str {
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.as_bytes().offset_from(&start.as_bytes())
+ }
+}
+
+impl<'a> Offset<<&'a str as Stream>::Checkpoint> for &'a str {
+ #[inline(always)]
+ fn offset_from(&self, other: &<&'a str as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<'a> Offset for &'a Bytes {
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.as_bytes().offset_from(&start.as_bytes())
+ }
+}
+
+impl<'a> Offset<<&'a Bytes as Stream>::Checkpoint> for &'a Bytes {
+ #[inline(always)]
+ fn offset_from(&self, other: &<&'a Bytes as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<'a> Offset for &'a BStr {
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.as_bytes().offset_from(&start.as_bytes())
+ }
+}
+
+impl<'a> Offset<<&'a BStr as Stream>::Checkpoint> for &'a BStr {
+ #[inline(always)]
+ fn offset_from(&self, other: &<&'a BStr as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<I> Offset for (I, usize)
+where
+ I: Offset,
+{
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.0.offset_from(&start.0) * 8 + self.1 - start.1
+ }
+}
+
+impl<I> Offset<<(I, usize) as Stream>::Checkpoint> for (I, usize)
+where
+ I: Stream<Token = u8> + Clone,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<(I, usize) as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<I> Offset for Located<I>
+where
+ I: Stream,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &Self) -> usize {
+ self.offset_from(&other.checkpoint())
+ }
+}
+
+impl<I> Offset<<Located<I> as Stream>::Checkpoint> for Located<I>
+where
+ I: Stream,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<Located<I> as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Offset for Recoverable<I, E>
+where
+ I: Stream,
+ E: crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &Self) -> usize {
+ self.offset_from(&other.checkpoint())
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> Offset<<Recoverable<I, E> as Stream>::Checkpoint> for Recoverable<I, E>
+where
+ I: Stream,
+ E: crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<Recoverable<I, E> as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<I, S> Offset for Stateful<I, S>
+where
+ I: Stream,
+ S: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.offset_from(&start.checkpoint())
+ }
+}
+
+impl<I, S> Offset<<Stateful<I, S> as Stream>::Checkpoint> for Stateful<I, S>
+where
+ I: Stream,
+ S: crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<Stateful<I, S> as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<I> Offset for Partial<I>
+where
+ I: Stream,
+{
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.offset_from(&start.checkpoint())
+ }
+}
+
+impl<I> Offset<<Partial<I> as Stream>::Checkpoint> for Partial<I>
+where
+ I: Stream,
+{
+ #[inline(always)]
+ fn offset_from(&self, other: &<Partial<I> as Stream>::Checkpoint) -> usize {
+ self.checkpoint().offset_from(other)
+ }
+}
+
+impl<I> Offset for Checkpoint<I>
+where
+ I: Offset,
+{
+ #[inline(always)]
+ fn offset_from(&self, start: &Self) -> usize {
+ self.0.offset_from(&start.0)
+ }
+}
+
+/// Helper trait for types that can be viewed as a byte slice
+pub trait AsBytes {
+ /// Casts the input type to a byte slice
+ fn as_bytes(&self) -> &[u8];
+}
+
+impl<'a> AsBytes for &'a [u8] {
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ self
+ }
+}
+
+impl<'a> AsBytes for &'a Bytes {
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ (*self).as_bytes()
+ }
+}
+
+impl<I> AsBytes for Located<I>
+where
+ I: AsBytes,
+{
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ self.input.as_bytes()
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> AsBytes for Recoverable<I, E>
+where
+ I: Stream,
+ I: AsBytes,
+{
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ self.input.as_bytes()
+ }
+}
+
+impl<I, S> AsBytes for Stateful<I, S>
+where
+ I: AsBytes,
+{
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ self.input.as_bytes()
+ }
+}
+
+impl<I> AsBytes for Partial<I>
+where
+ I: AsBytes,
+{
+ #[inline(always)]
+ fn as_bytes(&self) -> &[u8] {
+ self.input.as_bytes()
+ }
+}
+
+/// Helper trait for types that can be viewed as a byte slice
+pub trait AsBStr {
+ /// Casts the input type to a byte slice
+ fn as_bstr(&self) -> &[u8];
+}
+
+impl<'a> AsBStr for &'a [u8] {
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ self
+ }
+}
+
+impl<'a> AsBStr for &'a BStr {
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ (*self).as_bytes()
+ }
+}
+
+impl<'a> AsBStr for &'a str {
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ (*self).as_bytes()
+ }
+}
+
+impl<I> AsBStr for Located<I>
+where
+ I: AsBStr,
+{
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ self.input.as_bstr()
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> AsBStr for Recoverable<I, E>
+where
+ I: Stream,
+ I: AsBStr,
+{
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ self.input.as_bstr()
+ }
+}
+
+impl<I, S> AsBStr for Stateful<I, S>
+where
+ I: AsBStr,
+{
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ self.input.as_bstr()
+ }
+}
+
+impl<I> AsBStr for Partial<I>
+where
+ I: AsBStr,
+{
+ #[inline(always)]
+ fn as_bstr(&self) -> &[u8] {
+ self.input.as_bstr()
+ }
+}
+
+/// Result of [`Compare::compare`]
+#[derive(Debug, Eq, PartialEq)]
+pub enum CompareResult {
+ /// Comparison was successful
+ Ok,
+ /// We need more data to be sure
+ Incomplete,
+ /// Comparison failed
+ Error,
+}
+
+/// Abstracts comparison operations
+pub trait Compare<T> {
+ /// Compares self to another value for equality
+ fn compare(&self, t: T) -> CompareResult;
+ /// Compares self to another value for equality
+ /// independently of the case.
+ ///
+ /// Warning: for `&str`, the comparison is done
+ /// by lowercasing both strings and comparing
+ /// the result. This is a temporary solution until
+ /// a better one appears
+ #[deprecated(since = "0.5.20", note = "Replaced with `compare(ascii::Caseless(_))`")]
+ fn compare_no_case(&self, t: T) -> CompareResult;
+}
+
+impl<'a, 'b> Compare<&'b [u8]> for &'a [u8] {
+ #[inline]
+ fn compare(&self, t: &'b [u8]) -> CompareResult {
+ if t.iter().zip(*self).any(|(a, b)| a != b) {
+ CompareResult::Error
+ } else if self.len() < t.slice_len() {
+ CompareResult::Incomplete
+ } else {
+ CompareResult::Ok
+ }
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: &'b [u8]) -> CompareResult {
+ self.compare(AsciiCaseless(t))
+ }
+}
+
+impl<'a, 'b> Compare<AsciiCaseless<&'b [u8]>> for &'a [u8] {
+ #[inline]
+ fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult {
+ if t.0
+ .iter()
+ .zip(*self)
+ .any(|(a, b)| !a.eq_ignore_ascii_case(b))
+ {
+ CompareResult::Error
+ } else if self.len() < t.slice_len() {
+ CompareResult::Incomplete
+ } else {
+ CompareResult::Ok
+ }
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult {
+ self.compare(t)
+ }
+}
+
+impl<'a, const LEN: usize> Compare<[u8; LEN]> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: [u8; LEN]) -> CompareResult {
+ self.compare(&t[..])
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: [u8; LEN]) -> CompareResult {
+ self.compare_no_case(&t[..])
+ }
+}
+
+impl<'a, const LEN: usize> Compare<AsciiCaseless<[u8; LEN]>> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult {
+ self.compare(AsciiCaseless(&t.0[..]))
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<[u8; LEN]>) -> CompareResult {
+ self.compare_no_case(AsciiCaseless(&t.0[..]))
+ }
+}
+
+impl<'a, 'b, const LEN: usize> Compare<&'b [u8; LEN]> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: &'b [u8; LEN]) -> CompareResult {
+ self.compare(&t[..])
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: &'b [u8; LEN]) -> CompareResult {
+ self.compare_no_case(&t[..])
+ }
+}
+
+impl<'a, 'b, const LEN: usize> Compare<AsciiCaseless<&'b [u8; LEN]>> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult {
+ self.compare(AsciiCaseless(&t.0[..]))
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<&'b [u8; LEN]>) -> CompareResult {
+ self.compare_no_case(AsciiCaseless(&t.0[..]))
+ }
+}
+
+impl<'a, 'b> Compare<&'b str> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: &'b str) -> CompareResult {
+ self.compare(t.as_bytes())
+ }
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: &'b str) -> CompareResult {
+ self.compare_no_case(t.as_bytes())
+ }
+}
+
+impl<'a, 'b> Compare<AsciiCaseless<&'b str>> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult {
+ self.compare(AsciiCaseless(t.0.as_bytes()))
+ }
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<&'b str>) -> CompareResult {
+ self.compare_no_case(AsciiCaseless(t.0.as_bytes()))
+ }
+}
+
+impl<'a> Compare<char> for &'a [u8] {
+ #[inline(always)]
+ fn compare(&self, t: char) -> CompareResult {
+ self.compare(t.encode_utf8(&mut [0; 4]).as_bytes())
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: char) -> CompareResult {
+ self.compare_no_case(t.encode_utf8(&mut [0; 4]).as_bytes())
+ }
+}
+
+impl<'a> Compare<AsciiCaseless<char>> for &'a [u8] {
+ #[inline]
+ fn compare(&self, t: AsciiCaseless<char>) -> CompareResult {
+ self.compare(AsciiCaseless(t.0.encode_utf8(&mut [0; 4]).as_bytes()))
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<char>) -> CompareResult {
+ self.compare_no_case(AsciiCaseless(t.0.encode_utf8(&mut [0; 4]).as_bytes()))
+ }
+}
+
+impl<'a, 'b> Compare<&'b str> for &'a str {
+ #[inline(always)]
+ fn compare(&self, t: &'b str) -> CompareResult {
+ self.as_bytes().compare(t.as_bytes())
+ }
+
+ #[inline]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: &'b str) -> CompareResult {
+ self.compare(AsciiCaseless(t))
+ }
+}
+
+impl<'a, 'b> Compare<AsciiCaseless<&'b str>> for &'a str {
+ #[inline(always)]
+ fn compare(&self, t: AsciiCaseless<&'b str>) -> CompareResult {
+ self.as_bytes().compare(t.as_bytes())
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<&'b str>) -> CompareResult {
+ self.compare(t)
+ }
+}
+
+impl<'a> Compare<char> for &'a str {
+ #[inline(always)]
+ fn compare(&self, t: char) -> CompareResult {
+ self.compare(t.encode_utf8(&mut [0; 4]).as_bytes())
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: char) -> CompareResult {
+ self.compare_no_case(t.encode_utf8(&mut [0; 4]).as_bytes())
+ }
+}
+
+impl<'a> Compare<AsciiCaseless<char>> for &'a str {
+ #[inline]
+ fn compare(&self, t: AsciiCaseless<char>) -> CompareResult {
+ self.compare(AsciiCaseless(t.0.encode_utf8(&mut [0; 4]).as_bytes()))
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<char>) -> CompareResult {
+ self.compare_no_case(AsciiCaseless(t.0.encode_utf8(&mut [0; 4]).as_bytes()))
+ }
+}
+
+impl<'a, 'b> Compare<&'b [u8]> for &'a str {
+ #[inline(always)]
+ fn compare(&self, t: &'b [u8]) -> CompareResult {
+ AsBStr::as_bstr(self).compare(t)
+ }
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: &'b [u8]) -> CompareResult {
+ AsBStr::as_bstr(self).compare_no_case(t)
+ }
+}
+
+impl<'a, 'b> Compare<AsciiCaseless<&'b [u8]>> for &'a str {
+ #[inline(always)]
+ fn compare(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult {
+ AsBStr::as_bstr(self).compare(t)
+ }
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: AsciiCaseless<&'b [u8]>) -> CompareResult {
+ AsBStr::as_bstr(self).compare_no_case(t)
+ }
+}
+
+impl<'a, T> Compare<T> for &'a Bytes
+where
+ &'a [u8]: Compare<T>,
+{
+ #[inline(always)]
+ fn compare(&self, t: T) -> CompareResult {
+ let bytes = (*self).as_bytes();
+ bytes.compare(t)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: T) -> CompareResult {
+ let bytes = (*self).as_bytes();
+ bytes.compare_no_case(t)
+ }
+}
+
+impl<'a, T> Compare<T> for &'a BStr
+where
+ &'a [u8]: Compare<T>,
+{
+ #[inline(always)]
+ fn compare(&self, t: T) -> CompareResult {
+ let bytes = (*self).as_bytes();
+ bytes.compare(t)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: T) -> CompareResult {
+ let bytes = (*self).as_bytes();
+ bytes.compare_no_case(t)
+ }
+}
+
+impl<I, U> Compare<U> for Located<I>
+where
+ I: Compare<U>,
+{
+ #[inline(always)]
+ fn compare(&self, other: U) -> CompareResult {
+ self.input.compare(other)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, other: U) -> CompareResult {
+ self.input.compare_no_case(other)
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E, U> Compare<U> for Recoverable<I, E>
+where
+ I: Stream,
+ I: Compare<U>,
+{
+ #[inline(always)]
+ fn compare(&self, other: U) -> CompareResult {
+ self.input.compare(other)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, other: U) -> CompareResult {
+ self.input.compare_no_case(other)
+ }
+}
+
+impl<I, S, U> Compare<U> for Stateful<I, S>
+where
+ I: Compare<U>,
+{
+ #[inline(always)]
+ fn compare(&self, other: U) -> CompareResult {
+ self.input.compare(other)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, other: U) -> CompareResult {
+ self.input.compare_no_case(other)
+ }
+}
+
+impl<I, T> Compare<T> for Partial<I>
+where
+ I: Compare<T>,
+{
+ #[inline(always)]
+ fn compare(&self, t: T) -> CompareResult {
+ self.input.compare(t)
+ }
+
+ #[inline(always)]
+ #[allow(deprecated)]
+ fn compare_no_case(&self, t: T) -> CompareResult {
+ self.input.compare_no_case(t)
+ }
+}
+
+/// Look for a slice in self
+pub trait FindSlice<T> {
+ /// Returns the offset of the slice if it is found
+ fn find_slice(&self, substr: T) -> Option<usize>;
+}
+
+impl<'i, 's> FindSlice<&'s [u8]> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: &'s [u8]) -> Option<usize> {
+ memmem(self, substr)
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s [u8],)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s [u8],)) -> Option<usize> {
+ memmem(self, substr.0)
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s [u8], &'s [u8])> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s [u8], &'s [u8])) -> Option<usize> {
+ memmem2(self, substr)
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s [u8], &'s [u8], &'s [u8])> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s [u8], &'s [u8], &'s [u8])) -> Option<usize> {
+ memmem3(self, substr)
+ }
+}
+
+impl<'i> FindSlice<u8> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: u8) -> Option<usize> {
+ memchr(substr, self)
+ }
+}
+
+impl<'i> FindSlice<(u8,)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8,)) -> Option<usize> {
+ memchr(substr.0, self)
+ }
+}
+
+impl<'i> FindSlice<(u8, u8)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8, u8)) -> Option<usize> {
+ memchr2(substr, self)
+ }
+}
+
+impl<'i> FindSlice<(u8, u8, u8)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8, u8, u8)) -> Option<usize> {
+ memchr3(substr, self)
+ }
+}
+
+impl<'i, 's> FindSlice<&'s str> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: &'s str) -> Option<usize> {
+ self.find_slice(substr.as_bytes())
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str,)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str,)) -> Option<usize> {
+ memmem(self, substr.0.as_bytes())
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<usize> {
+ memmem2(self, (substr.0.as_bytes(), substr.1.as_bytes()))
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i [u8] {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str, &'s str, &'s str)) -> Option<usize> {
+ memmem3(
+ self,
+ (
+ substr.0.as_bytes(),
+ substr.1.as_bytes(),
+ substr.2.as_bytes(),
+ ),
+ )
+ }
+}
+
+impl<'i, 's> FindSlice<&'s str> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: &'s str) -> Option<usize> {
+ self.as_bytes().find_slice(substr.as_bytes())
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str,)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str,)) -> Option<usize> {
+ self.as_bytes().find_slice(substr)
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str, &'s str)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str, &'s str)) -> Option<usize> {
+ self.as_bytes().find_slice(substr)
+ }
+}
+
+impl<'i, 's> FindSlice<(&'s str, &'s str, &'s str)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (&'s str, &'s str, &'s str)) -> Option<usize> {
+ self.as_bytes().find_slice(substr)
+ }
+}
+
+impl<'i> FindSlice<char> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: char) -> Option<usize> {
+ let mut b = [0; 4];
+ let substr = substr.encode_utf8(&mut b);
+ self.find_slice(&*substr)
+ }
+}
+
+impl<'i> FindSlice<(char,)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (char,)) -> Option<usize> {
+ let mut b = [0; 4];
+ let substr0 = substr.0.encode_utf8(&mut b);
+ self.find_slice((&*substr0,))
+ }
+}
+
+impl<'i> FindSlice<(char, char)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (char, char)) -> Option<usize> {
+ let mut b = [0; 4];
+ let substr0 = substr.0.encode_utf8(&mut b);
+ let mut b = [0; 4];
+ let substr1 = substr.1.encode_utf8(&mut b);
+ self.find_slice((&*substr0, &*substr1))
+ }
+}
+
+impl<'i> FindSlice<(char, char, char)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (char, char, char)) -> Option<usize> {
+ let mut b = [0; 4];
+ let substr0 = substr.0.encode_utf8(&mut b);
+ let mut b = [0; 4];
+ let substr1 = substr.1.encode_utf8(&mut b);
+ let mut b = [0; 4];
+ let substr2 = substr.2.encode_utf8(&mut b);
+ self.find_slice((&*substr0, &*substr1, &*substr2))
+ }
+}
+
+impl<'i> FindSlice<u8> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: u8) -> Option<usize> {
+ self.find_slice(substr.as_char())
+ }
+}
+
+impl<'i> FindSlice<(u8,)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8,)) -> Option<usize> {
+ self.find_slice((substr.0.as_char(),))
+ }
+}
+
+impl<'i> FindSlice<(u8, u8)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8, u8)) -> Option<usize> {
+ self.find_slice((substr.0.as_char(), substr.1.as_char()))
+ }
+}
+
+impl<'i> FindSlice<(u8, u8, u8)> for &'i str {
+ #[inline(always)]
+ fn find_slice(&self, substr: (u8, u8, u8)) -> Option<usize> {
+ self.find_slice((substr.0.as_char(), substr.1.as_char(), substr.2.as_char()))
+ }
+}
+
+impl<'i, S> FindSlice<S> for &'i Bytes
+where
+ &'i [u8]: FindSlice<S>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: S) -> Option<usize> {
+ let bytes = (*self).as_bytes();
+ let offset = bytes.find_slice(substr);
+ offset
+ }
+}
+
+impl<'i, S> FindSlice<S> for &'i BStr
+where
+ &'i [u8]: FindSlice<S>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: S) -> Option<usize> {
+ let bytes = (*self).as_bytes();
+ let offset = bytes.find_slice(substr);
+ offset
+ }
+}
+
+impl<I, T> FindSlice<T> for Located<I>
+where
+ I: FindSlice<T>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: T) -> Option<usize> {
+ self.input.find_slice(substr)
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E, T> FindSlice<T> for Recoverable<I, E>
+where
+ I: Stream,
+ I: FindSlice<T>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: T) -> Option<usize> {
+ self.input.find_slice(substr)
+ }
+}
+
+impl<I, S, T> FindSlice<T> for Stateful<I, S>
+where
+ I: FindSlice<T>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: T) -> Option<usize> {
+ self.input.find_slice(substr)
+ }
+}
+
+impl<I, T> FindSlice<T> for Partial<I>
+where
+ I: FindSlice<T>,
+{
+ #[inline(always)]
+ fn find_slice(&self, substr: T) -> Option<usize> {
+ self.input.find_slice(substr)
+ }
+}
+
+/// Used to integrate `str`'s `parse()` method
+pub trait ParseSlice<R> {
+ /// Succeeds if `parse()` succeededThe
+ ///
+ /// The byte slice implementation will first convert it to a `&str`, then apply the `parse()`
+ /// function
+ fn parse_slice(&self) -> Option<R>;
+}
+
+impl<'a, R: FromStr> ParseSlice<R> for &'a [u8] {
+ #[inline(always)]
+ fn parse_slice(&self) -> Option<R> {
+ from_utf8(self).ok().and_then(|s| s.parse().ok())
+ }
+}
+
+impl<'a, R: FromStr> ParseSlice<R> for &'a str {
+ #[inline(always)]
+ fn parse_slice(&self) -> Option<R> {
+ self.parse().ok()
+ }
+}
+
+/// Convert a `Stream` into an appropriate `Output` type
+pub trait UpdateSlice: Stream {
+ /// Convert an `Output` type to be used as `Stream`
+ fn update_slice(self, inner: Self::Slice) -> Self;
+}
+
+impl<'a, T> UpdateSlice for &'a [T]
+where
+ T: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn update_slice(self, inner: Self::Slice) -> Self {
+ inner
+ }
+}
+
+impl<'a> UpdateSlice for &'a str {
+ #[inline(always)]
+ fn update_slice(self, inner: Self::Slice) -> Self {
+ inner
+ }
+}
+
+impl<'a> UpdateSlice for &'a Bytes {
+ #[inline(always)]
+ fn update_slice(self, inner: Self::Slice) -> Self {
+ Bytes::new(inner)
+ }
+}
+
+impl<'a> UpdateSlice for &'a BStr {
+ #[inline(always)]
+ fn update_slice(self, inner: Self::Slice) -> Self {
+ BStr::new(inner)
+ }
+}
+
+impl<I> UpdateSlice for Located<I>
+where
+ I: UpdateSlice,
+{
+ #[inline(always)]
+ fn update_slice(mut self, inner: Self::Slice) -> Self {
+ self.input = I::update_slice(self.input, inner);
+ self
+ }
+}
+
+#[cfg(feature = "unstable-recover")]
+impl<I, E> UpdateSlice for Recoverable<I, E>
+where
+ I: Stream,
+ I: UpdateSlice,
+ E: crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn update_slice(mut self, inner: Self::Slice) -> Self {
+ self.input = I::update_slice(self.input, inner);
+ self
+ }
+}
+
+impl<I, S> UpdateSlice for Stateful<I, S>
+where
+ I: UpdateSlice,
+ S: Clone + crate::lib::std::fmt::Debug,
+{
+ #[inline(always)]
+ fn update_slice(mut self, inner: Self::Slice) -> Self {
+ self.input = I::update_slice(self.input, inner);
+ self
+ }
+}
+
+impl<I> UpdateSlice for Partial<I>
+where
+ I: UpdateSlice,
+{
+ #[inline(always)]
+ fn update_slice(self, inner: Self::Slice) -> Self {
+ Partial {
+ input: I::update_slice(self.input, inner),
+ partial: self.partial,
+ }
+ }
+}
+
+/// Ensure checkpoint details are kept private
+#[derive(Copy, Clone, Debug)]
+pub struct Checkpoint<T>(T);
+
+/// A range bounded inclusively for counting parses performed
+#[derive(PartialEq, Eq)]
+pub struct Range {
+ pub(crate) start_inclusive: usize,
+ pub(crate) end_inclusive: Option<usize>,
+}
+
+impl Range {
+ #[inline(always)]
+ fn raw(start_inclusive: usize, end_inclusive: Option<usize>) -> Self {
+ Self {
+ start_inclusive,
+ end_inclusive,
+ }
+ }
+}
+
+impl crate::lib::std::ops::RangeBounds<usize> for Range {
+ #[inline(always)]
+ fn start_bound(&self) -> crate::lib::std::ops::Bound<&usize> {
+ crate::lib::std::ops::Bound::Included(&self.start_inclusive)
+ }
+
+ #[inline(always)]
+ fn end_bound(&self) -> crate::lib::std::ops::Bound<&usize> {
+ if let Some(end_inclusive) = &self.end_inclusive {
+ crate::lib::std::ops::Bound::Included(end_inclusive)
+ } else {
+ crate::lib::std::ops::Bound::Unbounded
+ }
+ }
+}
+
+impl From<usize> for Range {
+ #[inline(always)]
+ fn from(fixed: usize) -> Self {
+ (fixed..=fixed).into()
+ }
+}
+
+impl From<crate::lib::std::ops::Range<usize>> for Range {
+ #[inline(always)]
+ fn from(range: crate::lib::std::ops::Range<usize>) -> Self {
+ let start_inclusive = range.start;
+ let end_inclusive = Some(range.end.saturating_sub(1));
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl From<crate::lib::std::ops::RangeFull> for Range {
+ #[inline(always)]
+ fn from(_: crate::lib::std::ops::RangeFull) -> Self {
+ let start_inclusive = 0;
+ let end_inclusive = None;
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl From<crate::lib::std::ops::RangeFrom<usize>> for Range {
+ #[inline(always)]
+ fn from(range: crate::lib::std::ops::RangeFrom<usize>) -> Self {
+ let start_inclusive = range.start;
+ let end_inclusive = None;
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl From<crate::lib::std::ops::RangeTo<usize>> for Range {
+ #[inline(always)]
+ fn from(range: crate::lib::std::ops::RangeTo<usize>) -> Self {
+ let start_inclusive = 0;
+ let end_inclusive = Some(range.end.saturating_sub(1));
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl From<crate::lib::std::ops::RangeInclusive<usize>> for Range {
+ #[inline(always)]
+ fn from(range: crate::lib::std::ops::RangeInclusive<usize>) -> Self {
+ let start_inclusive = *range.start();
+ let end_inclusive = Some(*range.end());
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl From<crate::lib::std::ops::RangeToInclusive<usize>> for Range {
+ #[inline(always)]
+ fn from(range: crate::lib::std::ops::RangeToInclusive<usize>) -> Self {
+ let start_inclusive = 0;
+ let end_inclusive = Some(range.end);
+ Self::raw(start_inclusive, end_inclusive)
+ }
+}
+
+impl crate::lib::std::fmt::Display for Range {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ self.start_inclusive.fmt(f)?;
+ match self.end_inclusive {
+ Some(e) if e == self.start_inclusive => {}
+ Some(e) => {
+ "..=".fmt(f)?;
+ e.fmt(f)?;
+ }
+ None => {
+ "..".fmt(f)?;
+ }
+ }
+ Ok(())
+ }
+}
+
+impl crate::lib::std::fmt::Debug for Range {
+ fn fmt(&self, f: &mut crate::lib::std::fmt::Formatter<'_>) -> crate::lib::std::fmt::Result {
+ write!(f, "{self}")
+ }
+}
+
+/// Abstracts something which can extend an `Extend`.
+/// Used to build modified input slices in `escaped_transform`
+pub trait Accumulate<T>: Sized {
+ /// Create a new `Extend` of the correct type
+ fn initial(capacity: Option<usize>) -> Self;
+ /// Accumulate the input into an accumulator
+ fn accumulate(&mut self, acc: T);
+}
+
+impl<T> Accumulate<T> for () {
+ #[inline(always)]
+ fn initial(_capacity: Option<usize>) -> Self {}
+ #[inline(always)]
+ fn accumulate(&mut self, _acc: T) {}
+}
+
+impl<T> Accumulate<T> for usize {
+ #[inline(always)]
+ fn initial(_capacity: Option<usize>) -> Self {
+ 0
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, _acc: T) {
+ *self += 1;
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<T> Accumulate<T> for Vec<T> {
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ match capacity {
+ Some(capacity) => Vec::with_capacity(clamp_capacity::<T>(capacity)),
+ None => Vec::new(),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, acc: T) {
+ self.push(acc);
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<'i, T: Clone> Accumulate<&'i [T]> for Vec<T> {
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ match capacity {
+ Some(capacity) => Vec::with_capacity(clamp_capacity::<T>(capacity)),
+ None => Vec::new(),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, acc: &'i [T]) {
+ self.extend(acc.iter().cloned());
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl Accumulate<char> for String {
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ match capacity {
+ Some(capacity) => String::with_capacity(clamp_capacity::<char>(capacity)),
+ None => String::new(),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, acc: char) {
+ self.push(acc);
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<'i> Accumulate<&'i str> for String {
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ match capacity {
+ Some(capacity) => String::with_capacity(clamp_capacity::<char>(capacity)),
+ None => String::new(),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, acc: &'i str) {
+ self.push_str(acc);
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<K, V> Accumulate<(K, V)> for BTreeMap<K, V>
+where
+ K: crate::lib::std::cmp::Ord,
+{
+ #[inline(always)]
+ fn initial(_capacity: Option<usize>) -> Self {
+ BTreeMap::new()
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, (key, value): (K, V)) {
+ self.insert(key, value);
+ }
+}
+
+#[cfg(feature = "std")]
+impl<K, V, S> Accumulate<(K, V)> for HashMap<K, V, S>
+where
+ K: crate::lib::std::cmp::Eq + crate::lib::std::hash::Hash,
+ S: BuildHasher + Default,
+{
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ let h = S::default();
+ match capacity {
+ Some(capacity) => {
+ HashMap::with_capacity_and_hasher(clamp_capacity::<(K, V)>(capacity), h)
+ }
+ None => HashMap::with_hasher(h),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, (key, value): (K, V)) {
+ self.insert(key, value);
+ }
+}
+
+#[cfg(feature = "alloc")]
+impl<K> Accumulate<K> for BTreeSet<K>
+where
+ K: crate::lib::std::cmp::Ord,
+{
+ #[inline(always)]
+ fn initial(_capacity: Option<usize>) -> Self {
+ BTreeSet::new()
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, key: K) {
+ self.insert(key);
+ }
+}
+
+#[cfg(feature = "std")]
+impl<K, S> Accumulate<K> for HashSet<K, S>
+where
+ K: crate::lib::std::cmp::Eq + crate::lib::std::hash::Hash,
+ S: BuildHasher + Default,
+{
+ #[inline(always)]
+ fn initial(capacity: Option<usize>) -> Self {
+ let h = S::default();
+ match capacity {
+ Some(capacity) => HashSet::with_capacity_and_hasher(clamp_capacity::<K>(capacity), h),
+ None => HashSet::with_hasher(h),
+ }
+ }
+ #[inline(always)]
+ fn accumulate(&mut self, key: K) {
+ self.insert(key);
+ }
+}
+
+#[cfg(feature = "alloc")]
+#[inline]
+pub(crate) fn clamp_capacity<T>(capacity: usize) -> usize {
+ /// Don't pre-allocate more than 64KiB when calling `Vec::with_capacity`.
+ ///
+ /// Pre-allocating memory is a nice optimization but count fields can't
+ /// always be trusted. We should clamp initial capacities to some reasonable
+ /// amount. This reduces the risk of a bogus count value triggering a panic
+ /// due to an OOM error.
+ ///
+ /// This does not affect correctness. `winnow` will always read the full number
+ /// of elements regardless of the capacity cap.
+ const MAX_INITIAL_CAPACITY_BYTES: usize = 65536;
+
+ let max_initial_capacity =
+ MAX_INITIAL_CAPACITY_BYTES / crate::lib::std::mem::size_of::<T>().max(1);
+ capacity.min(max_initial_capacity)
+}
+
+/// Helper trait to convert numbers to usize.
+///
+/// By default, usize implements `From<u8>` and `From<u16>` but not
+/// `From<u32>` and `From<u64>` because that would be invalid on some
+/// platforms. This trait implements the conversion for platforms
+/// with 32 and 64 bits pointer platforms
+pub trait ToUsize {
+ /// converts self to usize
+ fn to_usize(&self) -> usize;
+}
+
+impl ToUsize for u8 {
+ #[inline(always)]
+ fn to_usize(&self) -> usize {
+ *self as usize
+ }
+}
+
+impl ToUsize for u16 {
+ #[inline(always)]
+ fn to_usize(&self) -> usize {
+ *self as usize
+ }
+}
+
+impl ToUsize for usize {
+ #[inline(always)]
+ fn to_usize(&self) -> usize {
+ *self
+ }
+}
+
+#[cfg(any(target_pointer_width = "32", target_pointer_width = "64"))]
+impl ToUsize for u32 {
+ #[inline(always)]
+ fn to_usize(&self) -> usize {
+ *self as usize
+ }
+}
+
+#[cfg(target_pointer_width = "64")]
+impl ToUsize for u64 {
+ #[inline(always)]
+ fn to_usize(&self) -> usize {
+ *self as usize
+ }
+}
+
+/// Transforms a token into a char for basic string parsing
+#[allow(clippy::len_without_is_empty)]
+#[allow(clippy::wrong_self_convention)]
+pub trait AsChar {
+ /// Makes a char from self
+ ///
+ /// # Example
+ ///
+ /// ```
+ /// use winnow::stream::AsChar as _;
+ ///
+ /// assert_eq!('a'.as_char(), 'a');
+ /// assert_eq!(u8::MAX.as_char(), std::char::from_u32(u8::MAX as u32).unwrap());
+ /// ```
+ fn as_char(self) -> char;
+
+ /// Tests that self is an alphabetic character
+ ///
+ /// **Warning:** for `&str` it recognizes alphabetic
+ /// characters outside of the 52 ASCII letters
+ fn is_alpha(self) -> bool;
+
+ /// Tests that self is an alphabetic character
+ /// or a decimal digit
+ fn is_alphanum(self) -> bool;
+ /// Tests that self is a decimal digit
+ fn is_dec_digit(self) -> bool;
+ /// Tests that self is an hex digit
+ fn is_hex_digit(self) -> bool;
+ /// Tests that self is an octal digit
+ fn is_oct_digit(self) -> bool;
+ /// Gets the len in bytes for self
+ fn len(self) -> usize;
+ /// Tests that self is ASCII space or tab
+ fn is_space(self) -> bool;
+ /// Tests if byte is ASCII newline: \n
+ fn is_newline(self) -> bool;
+}
+
+impl AsChar for u8 {
+ #[inline(always)]
+ fn as_char(self) -> char {
+ self as char
+ }
+ #[inline]
+ fn is_alpha(self) -> bool {
+ matches!(self, 0x41..=0x5A | 0x61..=0x7A)
+ }
+ #[inline]
+ fn is_alphanum(self) -> bool {
+ self.is_alpha() || self.is_dec_digit()
+ }
+ #[inline]
+ fn is_dec_digit(self) -> bool {
+ matches!(self, 0x30..=0x39)
+ }
+ #[inline]
+ fn is_hex_digit(self) -> bool {
+ matches!(self, 0x30..=0x39 | 0x41..=0x46 | 0x61..=0x66)
+ }
+ #[inline]
+ fn is_oct_digit(self) -> bool {
+ matches!(self, 0x30..=0x37)
+ }
+ #[inline]
+ fn len(self) -> usize {
+ 1
+ }
+ #[inline]
+ fn is_space(self) -> bool {
+ self == b' ' || self == b'\t'
+ }
+ #[inline]
+ fn is_newline(self) -> bool {
+ self == b'\n'
+ }
+}
+
+impl<'a> AsChar for &'a u8 {
+ #[inline(always)]
+ fn as_char(self) -> char {
+ *self as char
+ }
+ #[inline]
+ fn is_alpha(self) -> bool {
+ matches!(*self, 0x41..=0x5A | 0x61..=0x7A)
+ }
+ #[inline]
+ fn is_alphanum(self) -> bool {
+ self.is_alpha() || self.is_dec_digit()
+ }
+ #[inline]
+ fn is_dec_digit(self) -> bool {
+ matches!(*self, 0x30..=0x39)
+ }
+ #[inline]
+ fn is_hex_digit(self) -> bool {
+ matches!(*self, 0x30..=0x39 | 0x41..=0x46 | 0x61..=0x66)
+ }
+ #[inline]
+ fn is_oct_digit(self) -> bool {
+ matches!(*self, 0x30..=0x37)
+ }
+ #[inline]
+ fn len(self) -> usize {
+ 1
+ }
+ #[inline]
+ fn is_space(self) -> bool {
+ *self == b' ' || *self == b'\t'
+ }
+ #[inline]
+ fn is_newline(self) -> bool {
+ *self == b'\n'
+ }
+}
+
+impl AsChar for char {
+ #[inline(always)]
+ fn as_char(self) -> char {
+ self
+ }
+ #[inline]
+ fn is_alpha(self) -> bool {
+ self.is_ascii_alphabetic()
+ }
+ #[inline]
+ fn is_alphanum(self) -> bool {
+ self.is_alpha() || self.is_dec_digit()
+ }
+ #[inline]
+ fn is_dec_digit(self) -> bool {
+ self.is_ascii_digit()
+ }
+ #[inline]
+ fn is_hex_digit(self) -> bool {
+ self.is_ascii_hexdigit()
+ }
+ #[inline]
+ fn is_oct_digit(self) -> bool {
+ self.is_digit(8)
+ }
+ #[inline]
+ fn len(self) -> usize {
+ self.len_utf8()
+ }
+ #[inline]
+ fn is_space(self) -> bool {
+ self == ' ' || self == '\t'
+ }
+ #[inline]
+ fn is_newline(self) -> bool {
+ self == '\n'
+ }
+}
+
+impl<'a> AsChar for &'a char {
+ #[inline(always)]
+ fn as_char(self) -> char {
+ *self
+ }
+ #[inline]
+ fn is_alpha(self) -> bool {
+ self.is_ascii_alphabetic()
+ }
+ #[inline]
+ fn is_alphanum(self) -> bool {
+ self.is_alpha() || self.is_dec_digit()
+ }
+ #[inline]
+ fn is_dec_digit(self) -> bool {
+ self.is_ascii_digit()
+ }
+ #[inline]
+ fn is_hex_digit(self) -> bool {
+ self.is_ascii_hexdigit()
+ }
+ #[inline]
+ fn is_oct_digit(self) -> bool {
+ self.is_digit(8)
+ }
+ #[inline]
+ fn len(self) -> usize {
+ self.len_utf8()
+ }
+ #[inline]
+ fn is_space(self) -> bool {
+ *self == ' ' || *self == '\t'
+ }
+ #[inline]
+ fn is_newline(self) -> bool {
+ *self == '\n'
+ }
+}
+
+/// Check if a token in in a set of possible tokens
+///
+/// This is generally implemented on patterns that a token may match and supports `u8` and `char`
+/// tokens along with the following patterns
+/// - `b'c'` and `'c'`
+/// - `b""` and `""`
+/// - `|c| true`
+/// - `b'a'..=b'z'`, `'a'..='z'` (etc for each [range type][std::ops])
+/// - `(pattern1, pattern2, ...)`
+///
+/// # Example
+///
+/// For example, you could implement `hex_digit0` as:
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::token::take_while;
+/// fn hex_digit1<'s>(input: &mut &'s str) -> PResult<&'s str, InputError<&'s str>> {
+/// take_while(1.., ('a'..='f', 'A'..='F', '0'..='9')).parse_next(input)
+/// }
+///
+/// assert_eq!(hex_digit1.parse_peek("21cZ"), Ok(("Z", "21c")));
+/// assert_eq!(hex_digit1.parse_peek("H2"), Err(ErrMode::Backtrack(InputError::new("H2", ErrorKind::Slice))));
+/// assert_eq!(hex_digit1.parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+pub trait ContainsToken<T> {
+ /// Returns true if self contains the token
+ fn contains_token(&self, token: T) -> bool;
+}
+
+impl ContainsToken<u8> for u8 {
+ #[inline(always)]
+ fn contains_token(&self, token: u8) -> bool {
+ *self == token
+ }
+}
+
+impl<'a> ContainsToken<&'a u8> for u8 {
+ #[inline(always)]
+ fn contains_token(&self, token: &u8) -> bool {
+ self.contains_token(*token)
+ }
+}
+
+impl ContainsToken<char> for u8 {
+ #[inline(always)]
+ fn contains_token(&self, token: char) -> bool {
+ self.as_char() == token
+ }
+}
+
+impl<'a> ContainsToken<&'a char> for u8 {
+ #[inline(always)]
+ fn contains_token(&self, token: &char) -> bool {
+ self.contains_token(*token)
+ }
+}
+
+impl<C: AsChar> ContainsToken<C> for char {
+ #[inline(always)]
+ fn contains_token(&self, token: C) -> bool {
+ *self == token.as_char()
+ }
+}
+
+impl<C, F: Fn(C) -> bool> ContainsToken<C> for F {
+ #[inline(always)]
+ fn contains_token(&self, token: C) -> bool {
+ self(token)
+ }
+}
+
+impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for crate::lib::std::ops::Range<C2> {
+ #[inline(always)]
+ fn contains_token(&self, token: C1) -> bool {
+ let start = self.start.clone().as_char();
+ let end = self.end.clone().as_char();
+ (start..end).contains(&token.as_char())
+ }
+}
+
+impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1>
+ for crate::lib::std::ops::RangeInclusive<C2>
+{
+ #[inline(always)]
+ fn contains_token(&self, token: C1) -> bool {
+ let start = self.start().clone().as_char();
+ let end = self.end().clone().as_char();
+ (start..=end).contains(&token.as_char())
+ }
+}
+
+impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for crate::lib::std::ops::RangeFrom<C2> {
+ #[inline(always)]
+ fn contains_token(&self, token: C1) -> bool {
+ let start = self.start.clone().as_char();
+ (start..).contains(&token.as_char())
+ }
+}
+
+impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1> for crate::lib::std::ops::RangeTo<C2> {
+ #[inline(always)]
+ fn contains_token(&self, token: C1) -> bool {
+ let end = self.end.clone().as_char();
+ (..end).contains(&token.as_char())
+ }
+}
+
+impl<C1: AsChar, C2: AsChar + Clone> ContainsToken<C1>
+ for crate::lib::std::ops::RangeToInclusive<C2>
+{
+ #[inline(always)]
+ fn contains_token(&self, token: C1) -> bool {
+ let end = self.end.clone().as_char();
+ (..=end).contains(&token.as_char())
+ }
+}
+
+impl<C1: AsChar> ContainsToken<C1> for crate::lib::std::ops::RangeFull {
+ #[inline(always)]
+ fn contains_token(&self, _token: C1) -> bool {
+ true
+ }
+}
+
+impl<C: AsChar> ContainsToken<C> for &'_ [u8] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| t.as_char() == token)
+ }
+}
+
+impl<C: AsChar> ContainsToken<C> for &'_ [char] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| *t == token)
+ }
+}
+
+impl<const LEN: usize, C: AsChar> ContainsToken<C> for &'_ [u8; LEN] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| t.as_char() == token)
+ }
+}
+
+impl<const LEN: usize, C: AsChar> ContainsToken<C> for &'_ [char; LEN] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| *t == token)
+ }
+}
+
+impl<const LEN: usize, C: AsChar> ContainsToken<C> for [u8; LEN] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| t.as_char() == token)
+ }
+}
+
+impl<const LEN: usize, C: AsChar> ContainsToken<C> for [char; LEN] {
+ #[inline]
+ fn contains_token(&self, token: C) -> bool {
+ let token = token.as_char();
+ self.iter().any(|t| *t == token)
+ }
+}
+
+impl<T> ContainsToken<T> for () {
+ #[inline(always)]
+ fn contains_token(&self, _token: T) -> bool {
+ false
+ }
+}
+
+macro_rules! impl_contains_token_for_tuple {
+ ($($haystack:ident),+) => (
+ #[allow(non_snake_case)]
+ impl<T, $($haystack),+> ContainsToken<T> for ($($haystack),+,)
+ where
+ T: Clone,
+ $($haystack: ContainsToken<T>),+
+ {
+ #[inline]
+ fn contains_token(&self, token: T) -> bool {
+ let ($(ref $haystack),+,) = *self;
+ $($haystack.contains_token(token.clone()) || )+ false
+ }
+ }
+ )
+}
+
+macro_rules! impl_contains_token_for_tuples {
+ ($haystack1:ident, $($haystack:ident),+) => {
+ impl_contains_token_for_tuples!(__impl $haystack1; $($haystack),+);
+ };
+ (__impl $($haystack:ident),+; $haystack1:ident $(,$haystack2:ident)*) => {
+ impl_contains_token_for_tuple!($($haystack),+);
+ impl_contains_token_for_tuples!(__impl $($haystack),+, $haystack1; $($haystack2),*);
+ };
+ (__impl $($haystack:ident),+;) => {
+ impl_contains_token_for_tuple!($($haystack),+);
+ }
+}
+
+impl_contains_token_for_tuples!(
+ F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21
+);
+
+#[cfg(feature = "simd")]
+#[inline(always)]
+fn memchr(token: u8, slice: &[u8]) -> Option<usize> {
+ memchr::memchr(token, slice)
+}
+
+#[cfg(feature = "simd")]
+#[inline(always)]
+fn memchr2(token: (u8, u8), slice: &[u8]) -> Option<usize> {
+ memchr::memchr2(token.0, token.1, slice)
+}
+
+#[cfg(feature = "simd")]
+#[inline(always)]
+fn memchr3(token: (u8, u8, u8), slice: &[u8]) -> Option<usize> {
+ memchr::memchr3(token.0, token.1, token.2, slice)
+}
+
+#[cfg(not(feature = "simd"))]
+#[inline(always)]
+fn memchr(token: u8, slice: &[u8]) -> Option<usize> {
+ slice.iter().position(|t| *t == token)
+}
+
+#[cfg(not(feature = "simd"))]
+#[inline(always)]
+fn memchr2(token: (u8, u8), slice: &[u8]) -> Option<usize> {
+ slice.iter().position(|t| *t == token.0 || *t == token.1)
+}
+
+#[cfg(not(feature = "simd"))]
+#[inline(always)]
+fn memchr3(token: (u8, u8, u8), slice: &[u8]) -> Option<usize> {
+ slice
+ .iter()
+ .position(|t| *t == token.0 || *t == token.1 || *t == token.2)
+}
+
+#[inline(always)]
+fn memmem(slice: &[u8], tag: &[u8]) -> Option<usize> {
+ if tag.len() == 1 {
+ memchr(tag[0], slice)
+ } else {
+ memmem_(slice, tag)
+ }
+}
+
+#[inline(always)]
+fn memmem2(slice: &[u8], tag: (&[u8], &[u8])) -> Option<usize> {
+ if tag.0.len() == 1 && tag.1.len() == 1 {
+ memchr2((tag.0[0], tag.1[0]), slice)
+ } else {
+ memmem2_(slice, tag)
+ }
+}
+
+#[inline(always)]
+fn memmem3(slice: &[u8], tag: (&[u8], &[u8], &[u8])) -> Option<usize> {
+ if tag.0.len() == 1 && tag.1.len() == 1 && tag.2.len() == 1 {
+ memchr3((tag.0[0], tag.1[0], tag.2[0]), slice)
+ } else {
+ memmem3_(slice, tag)
+ }
+}
+
+#[cfg(feature = "simd")]
+#[inline(always)]
+fn memmem_(slice: &[u8], tag: &[u8]) -> Option<usize> {
+ let &prefix = match tag.first() {
+ Some(x) => x,
+ None => return Some(0),
+ };
+ #[allow(clippy::manual_find)] // faster this way
+ for i in memchr::memchr_iter(prefix, slice) {
+ if slice[i..].starts_with(tag) {
+ return Some(i);
+ }
+ }
+ None
+}
+
+#[cfg(feature = "simd")]
+fn memmem2_(slice: &[u8], tag: (&[u8], &[u8])) -> Option<usize> {
+ let prefix = match (tag.0.first(), tag.1.first()) {
+ (Some(&a), Some(&b)) => (a, b),
+ _ => return Some(0),
+ };
+ #[allow(clippy::manual_find)] // faster this way
+ for i in memchr::memchr2_iter(prefix.0, prefix.1, slice) {
+ let subslice = &slice[i..];
+ if subslice.starts_with(tag.0) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.1) {
+ return Some(i);
+ }
+ }
+ None
+}
+
+#[cfg(feature = "simd")]
+fn memmem3_(slice: &[u8], tag: (&[u8], &[u8], &[u8])) -> Option<usize> {
+ let prefix = match (tag.0.first(), tag.1.first(), tag.2.first()) {
+ (Some(&a), Some(&b), Some(&c)) => (a, b, c),
+ _ => return Some(0),
+ };
+ #[allow(clippy::manual_find)] // faster this way
+ for i in memchr::memchr3_iter(prefix.0, prefix.1, prefix.2, slice) {
+ let subslice = &slice[i..];
+ if subslice.starts_with(tag.0) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.1) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.2) {
+ return Some(i);
+ }
+ }
+ None
+}
+
+#[cfg(not(feature = "simd"))]
+fn memmem_(slice: &[u8], tag: &[u8]) -> Option<usize> {
+ for i in 0..slice.len() {
+ let subslice = &slice[i..];
+ if subslice.starts_with(tag) {
+ return Some(i);
+ }
+ }
+ None
+}
+
+#[cfg(not(feature = "simd"))]
+fn memmem2_(slice: &[u8], tag: (&[u8], &[u8])) -> Option<usize> {
+ for i in 0..slice.len() {
+ let subslice = &slice[i..];
+ if subslice.starts_with(tag.0) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.1) {
+ return Some(i);
+ }
+ }
+ None
+}
+
+#[cfg(not(feature = "simd"))]
+fn memmem3_(slice: &[u8], tag: (&[u8], &[u8], &[u8])) -> Option<usize> {
+ for i in 0..slice.len() {
+ let subslice = &slice[i..];
+ if subslice.starts_with(tag.0) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.1) {
+ return Some(i);
+ }
+ if subslice.starts_with(tag.2) {
+ return Some(i);
+ }
+ }
+ None
+}
diff --git a/crates/winnow/src/stream/tests.rs b/crates/winnow/src/stream/tests.rs
new file mode 100644
index 0000000..06047df
--- /dev/null
+++ b/crates/winnow/src/stream/tests.rs
@@ -0,0 +1,228 @@
+#[cfg(feature = "std")]
+use proptest::prelude::*;
+
+use crate::error::ErrMode::Backtrack;
+use crate::error::{ErrorKind, InputError};
+use crate::token::tag;
+use crate::{
+ combinator::{separated, separated_pair},
+ PResult, Parser,
+};
+
+use super::*;
+
+#[cfg(feature = "std")]
+#[test]
+fn test_fxhashmap_compiles() {
+ let input = "a=b";
+ fn pair(i: &mut &str) -> PResult<(char, char)> {
+ let out = separated_pair('a', '=', 'b').parse_next(i)?;
+ Ok(out)
+ }
+
+ let _: rustc_hash::FxHashMap<char, char> = separated(0.., pair, ',').parse(input).unwrap();
+}
+
+#[test]
+fn test_offset_u8() {
+ let s = b"abcd123";
+ let a = &s[..];
+ let b = &a[2..];
+ let c = &a[..4];
+ let d = &a[3..5];
+ assert_eq!(b.offset_from(&a), 2);
+ assert_eq!(c.offset_from(&a), 0);
+ assert_eq!(d.offset_from(&a), 3);
+}
+
+#[test]
+fn test_offset_str() {
+ let a = "abcřèÂßÇd123";
+ let b = &a[7..];
+ let c = &a[..5];
+ let d = &a[5..9];
+ assert_eq!(b.offset_from(&a), 7);
+ assert_eq!(c.offset_from(&a), 0);
+ assert_eq!(d.offset_from(&a), 5);
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn test_bit_stream_empty() {
+ let i = (&b""[..], 0);
+
+ let actual = i.iter_offsets().collect::<crate::lib::std::vec::Vec<_>>();
+ assert_eq!(actual, vec![]);
+
+ let actual = i.eof_offset();
+ assert_eq!(actual, 0);
+
+ let actual = i.peek_token();
+ assert_eq!(actual, None);
+
+ let actual = i.offset_for(|b| b);
+ assert_eq!(actual, None);
+
+ let actual = i.offset_at(1);
+ assert_eq!(actual, Err(Needed::new(1)));
+
+ let (actual_input, actual_slice) = i.peek_slice(0);
+ assert_eq!(actual_input, (&b""[..], 0));
+ assert_eq!(actual_slice, (&b""[..], 0, 0));
+}
+
+#[test]
+#[cfg(feature = "alloc")]
+fn test_bit_offset_empty() {
+ let i = (&b""[..], 0);
+
+ let actual = i.offset_from(&i);
+ assert_eq!(actual, 0);
+}
+
+#[cfg(feature = "std")]
+proptest! {
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn bit_stream(byte_len in 0..20usize, start in 0..160usize) {
+ bit_stream_inner(byte_len, start);
+ }
+}
+
+#[cfg(feature = "std")]
+fn bit_stream_inner(byte_len: usize, start: usize) {
+ let start = start.min(byte_len * 8);
+ let start_byte = start / 8;
+ let start_bit = start % 8;
+
+ let bytes = vec![0b1010_1010; byte_len];
+ let i = (&bytes[start_byte..], start_bit);
+
+ let mut curr_i = i;
+ let mut curr_offset = 0;
+ while let Some((next_i, _token)) = curr_i.peek_token() {
+ let to_offset = curr_i.offset_from(&i);
+ assert_eq!(curr_offset, to_offset);
+
+ let (slice_i, _) = i.peek_slice(curr_offset);
+ assert_eq!(curr_i, slice_i);
+
+ let at_offset = i.offset_at(curr_offset).unwrap();
+ assert_eq!(curr_offset, at_offset);
+
+ let eof_offset = curr_i.eof_offset();
+ let (next_eof_i, eof_slice) = curr_i.peek_slice(eof_offset);
+ assert_eq!(next_eof_i, (&b""[..], 0));
+ let eof_slice_i = (eof_slice.0, eof_slice.1);
+ assert_eq!(eof_slice_i, curr_i);
+
+ curr_offset += 1;
+ curr_i = next_i;
+ }
+ assert_eq!(i.eof_offset(), curr_offset);
+}
+
+#[test]
+fn test_partial_complete() {
+ let mut i = Partial::new(&b""[..]);
+ assert!(Partial::<&[u8]>::is_partial_supported());
+
+ assert!(i.is_partial(), "incomplete by default");
+ let incomplete_state = i.complete();
+ assert!(!i.is_partial(), "the stream should be marked as complete");
+
+ i.restore_partial(incomplete_state);
+ assert!(i.is_partial(), "incomplete stream state should be restored");
+}
+
+#[test]
+fn test_custom_slice() {
+ type Token = usize;
+ type TokenSlice<'i> = &'i [Token];
+
+ let mut tokens: TokenSlice<'_> = &[1, 2, 3, 4];
+
+ let input = &mut tokens;
+ let start = input.checkpoint();
+ let _ = input.next_token();
+ let _ = input.next_token();
+ let offset = input.offset_from(&start);
+ assert_eq!(offset, 2);
+}
+
+#[test]
+fn test_tag_support_char() {
+ assert_eq!(
+ tag::<_, _, InputError<_>>('π').parse_peek("π"),
+ Ok(("", "π"))
+ );
+ assert_eq!(
+ tag::<_, _, InputError<_>>('π').parse_peek("π3.14"),
+ Ok(("3.14", "π"))
+ );
+
+ assert_eq!(
+ tag::<_, _, InputError<_>>("π").parse_peek("π3.14"),
+ Ok(("3.14", "π"))
+ );
+
+ assert_eq!(
+ tag::<_, _, InputError<_>>('-').parse_peek("π"),
+ Err(Backtrack(InputError::new("π", ErrorKind::Tag)))
+ );
+
+ assert_eq!(
+ tag::<_, Partial<&[u8]>, InputError<_>>('π').parse_peek(Partial::new(b"\xCF\x80")),
+ Ok((Partial::new(Default::default()), "π".as_bytes()))
+ );
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>('π').parse_peek(b"\xCF\x80"),
+ Ok((Default::default(), "π".as_bytes()))
+ );
+
+ assert_eq!(
+ tag::<_, Partial<&[u8]>, InputError<_>>('π').parse_peek(Partial::new(b"\xCF\x803.14")),
+ Ok((Partial::new(&b"3.14"[..]), "π".as_bytes()))
+ );
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>('π').parse_peek(b"\xCF\x80"),
+ Ok((Default::default(), "π".as_bytes()))
+ );
+
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>('π').parse_peek(b"\xCF\x803.14"),
+ Ok((&b"3.14"[..], "π".as_bytes()))
+ );
+
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>(AsciiCaseless('a')).parse_peek(b"ABCxyz"),
+ Ok((&b"BCxyz"[..], &b"A"[..]))
+ );
+
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>('a').parse_peek(b"ABCxyz"),
+ Err(Backtrack(InputError::new(&b"ABCxyz"[..], ErrorKind::Tag)))
+ );
+
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>(AsciiCaseless('π')).parse_peek(b"\xCF\x803.14"),
+ Ok((&b"3.14"[..], "π".as_bytes()))
+ );
+
+ assert_eq!(
+ tag::<_, _, InputError<_>>(AsciiCaseless('🧑')).parse_peek("🧑你好"),
+ Ok(("你好", "🧑"))
+ );
+
+ let mut buffer = [0; 4];
+ let input = '\u{241b}'.encode_utf8(&mut buffer);
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>(AsciiCaseless('␛')).parse_peek(input.as_bytes()),
+ Ok((&b""[..], [226, 144, 155].as_slice()))
+ );
+
+ assert_eq!(
+ tag::<_, &[u8], InputError<_>>('-').parse_peek(b"\xCF\x80"),
+ Err(Backtrack(InputError::new(&b"\xCF\x80"[..], ErrorKind::Tag)))
+ );
+}
diff --git a/crates/winnow/src/token/mod.rs b/crates/winnow/src/token/mod.rs
new file mode 100644
index 0000000..8641515
--- /dev/null
+++ b/crates/winnow/src/token/mod.rs
@@ -0,0 +1,1232 @@
+//! Parsers extracting tokens from the stream
+
+#[cfg(test)]
+mod tests;
+
+use crate::combinator::trace;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::Needed;
+use crate::error::ParserError;
+use crate::lib::std::result::Result::Ok;
+use crate::stream::Range;
+use crate::stream::{Compare, CompareResult, ContainsToken, FindSlice, SliceLen, Stream};
+use crate::stream::{StreamIsPartial, ToUsize};
+use crate::PResult;
+use crate::Parser;
+
+/// Matches one token
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{token::any, error::ErrMode, error::{InputError, ErrorKind}};
+/// # use winnow::prelude::*;
+/// fn parser(input: &str) -> IResult<&str, char> {
+/// any.parse_peek(input)
+/// }
+///
+/// assert_eq!(parser("abc"), Ok(("bc",'a')));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{token::any, error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// assert_eq!(any::<_, InputError<_>>.parse_peek(Partial::new("abc")), Ok((Partial::new("bc"),'a')));
+/// assert_eq!(any::<_, InputError<_>>.parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+#[doc(alias = "token")]
+pub fn any<I, E: ParserError<I>>(input: &mut I) -> PResult<<I as Stream>::Token, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+{
+ trace("any", move |input: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ any_::<_, _, true>(input)
+ } else {
+ any_::<_, _, false>(input)
+ }
+ })
+ .parse_next(input)
+}
+
+fn any_<I, E: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+) -> PResult<<I as Stream>::Token, E>
+where
+ I: StreamIsPartial,
+ I: Stream,
+{
+ input.next_token().ok_or_else(|| {
+ if PARTIAL && input.is_partial() {
+ ErrMode::Incomplete(Needed::new(1))
+ } else {
+ ErrMode::from_error_kind(input, ErrorKind::Token)
+ }
+ })
+}
+
+/// Recognizes a literal
+///
+/// The input data will be compared to the tag combinator's argument and will return the part of
+/// the input that matches the argument
+///
+/// It will return `Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Tag)))` if the input doesn't match the pattern
+///
+/// **Note:** [`Parser`] is implemented for strings and byte strings as a convenience (complete
+/// only)
+///
+/// # Example
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// use winnow::token::tag;
+///
+/// fn parser(s: &str) -> IResult<&str, &str> {
+/// "Hello".parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser("Something"), Err(ErrMode::Backtrack(InputError::new("Something", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::Partial;
+/// use winnow::token::tag;
+///
+/// fn parser(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// "Hello".parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new("Hello, World!")), Ok((Partial::new(", World!"), "Hello")));
+/// assert_eq!(parser(Partial::new("Something")), Err(ErrMode::Backtrack(InputError::new(Partial::new("Something"), ErrorKind::Tag))));
+/// assert_eq!(parser(Partial::new("S")), Err(ErrMode::Backtrack(InputError::new(Partial::new("S"), ErrorKind::Tag))));
+/// assert_eq!(parser(Partial::new("H")), Err(ErrMode::Incomplete(Needed::new(4))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::tag;
+/// use winnow::ascii::Caseless;
+///
+/// fn parser(s: &str) -> IResult<&str, &str> {
+/// tag(Caseless("hello")).parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser("hello, World!"), Ok((", World!", "hello")));
+/// assert_eq!(parser("HeLlO, World!"), Ok((", World!", "HeLlO")));
+/// assert_eq!(parser("Something"), Err(ErrMode::Backtrack(InputError::new("Something", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+#[inline(always)]
+#[doc(alias = "literal")]
+#[doc(alias = "bytes")]
+#[doc(alias = "just")]
+pub fn tag<T, I, Error: ParserError<I>>(tag: T) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + Compare<T>,
+ T: SliceLen + Clone,
+{
+ trace("tag", move |i: &mut I| {
+ let t = tag.clone();
+ if <I as StreamIsPartial>::is_partial_supported() {
+ tag_::<_, _, _, true>(i, t)
+ } else {
+ tag_::<_, _, _, false>(i, t)
+ }
+ })
+}
+
+fn tag_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ t: T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + Compare<T>,
+ T: SliceLen,
+{
+ let tag_len = t.slice_len();
+ match i.compare(t) {
+ CompareResult::Ok => Ok(i.next_slice(tag_len)),
+ CompareResult::Incomplete if PARTIAL && i.is_partial() => {
+ Err(ErrMode::Incomplete(Needed::new(tag_len - i.eof_offset())))
+ }
+ CompareResult::Incomplete | CompareResult::Error => {
+ let e: ErrorKind = ErrorKind::Tag;
+ Err(ErrMode::from_error_kind(i, e))
+ }
+ }
+}
+
+/// Recognizes a case insensitive literal.
+///
+/// The input data will be compared to the tag combinator's argument and will return the part of
+/// the input that matches the argument with no regard to case.
+///
+/// It will return `Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Tag)))` if the input doesn't match the pattern.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::tag_no_case;
+///
+/// fn parser(s: &str) -> IResult<&str, &str> {
+/// tag_no_case("hello").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser("Hello, World!"), Ok((", World!", "Hello")));
+/// assert_eq!(parser("hello, World!"), Ok((", World!", "hello")));
+/// assert_eq!(parser("HeLlO, World!"), Ok((", World!", "HeLlO")));
+/// assert_eq!(parser("Something"), Err(ErrMode::Backtrack(InputError::new("Something", ErrorKind::Tag))));
+/// assert_eq!(parser(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Tag))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::tag_no_case;
+///
+/// fn parser(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// tag_no_case("hello").parse_peek(s)
+/// }
+///
+/// assert_eq!(parser(Partial::new("Hello, World!")), Ok((Partial::new(", World!"), "Hello")));
+/// assert_eq!(parser(Partial::new("hello, World!")), Ok((Partial::new(", World!"), "hello")));
+/// assert_eq!(parser(Partial::new("HeLlO, World!")), Ok((Partial::new(", World!"), "HeLlO")));
+/// assert_eq!(parser(Partial::new("Something")), Err(ErrMode::Backtrack(InputError::new(Partial::new("Something"), ErrorKind::Tag))));
+/// assert_eq!(parser(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(5))));
+/// ```
+#[inline(always)]
+#[doc(alias = "literal")]
+#[doc(alias = "bytes")]
+#[doc(alias = "just")]
+#[deprecated(since = "0.5.20", note = "Replaced with `tag(ascii::Caseless(_))`")]
+pub fn tag_no_case<T, I, Error: ParserError<I>>(
+ tag: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + Compare<T>,
+ T: SliceLen + Clone,
+{
+ trace("tag_no_case", move |i: &mut I| {
+ let t = tag.clone();
+ if <I as StreamIsPartial>::is_partial_supported() {
+ tag_no_case_::<_, _, _, true>(i, t)
+ } else {
+ tag_no_case_::<_, _, _, false>(i, t)
+ }
+ })
+}
+
+#[allow(deprecated)]
+fn tag_no_case_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ t: T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + Compare<T>,
+ T: SliceLen,
+{
+ let tag_len = t.slice_len();
+
+ match i.compare_no_case(t) {
+ CompareResult::Ok => Ok(i.next_slice(tag_len)),
+ CompareResult::Incomplete if PARTIAL && i.is_partial() => {
+ Err(ErrMode::Incomplete(Needed::new(tag_len - i.eof_offset())))
+ }
+ CompareResult::Incomplete | CompareResult::Error => {
+ let e: ErrorKind = ErrorKind::Tag;
+ Err(ErrMode::from_error_kind(i, e))
+ }
+ }
+}
+
+/// Recognize a token that matches the [pattern][ContainsToken]
+///
+/// **Note:** [`Parser`] is implemented as a convenience (complete
+/// only) for
+/// - `u8`
+/// - `char`
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::token::one_of;
+/// assert_eq!(one_of::<_, _, InputError<_>>(['a', 'b', 'c']).parse_peek("b"), Ok(("", 'b')));
+/// assert_eq!(one_of::<_, _, InputError<_>>('a').parse_peek("bc"), Err(ErrMode::Backtrack(InputError::new("bc", ErrorKind::Verify))));
+/// assert_eq!(one_of::<_, _, InputError<_>>('a').parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+///
+/// fn parser_fn(i: &str) -> IResult<&str, char> {
+/// one_of(|c| c == 'a' || c == 'b').parse_peek(i)
+/// }
+/// assert_eq!(parser_fn("abc"), Ok(("bc", 'a')));
+/// assert_eq!(parser_fn("cd"), Err(ErrMode::Backtrack(InputError::new("cd", ErrorKind::Verify))));
+/// assert_eq!(parser_fn(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+///
+/// ```
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// # use winnow::token::one_of;
+/// assert_eq!(one_of::<_, _, InputError<_>>(['a', 'b', 'c']).parse_peek(Partial::new("b")), Ok((Partial::new(""), 'b')));
+/// assert_eq!(one_of::<_, _, InputError<_>>('a').parse_peek(Partial::new("bc")), Err(ErrMode::Backtrack(InputError::new(Partial::new("bc"), ErrorKind::Verify))));
+/// assert_eq!(one_of::<_, _, InputError<_>>('a').parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// fn parser_fn(i: Partial<&str>) -> IResult<Partial<&str>, char> {
+/// one_of(|c| c == 'a' || c == 'b').parse_peek(i)
+/// }
+/// assert_eq!(parser_fn(Partial::new("abc")), Ok((Partial::new("bc"), 'a')));
+/// assert_eq!(parser_fn(Partial::new("cd")), Err(ErrMode::Backtrack(InputError::new(Partial::new("cd"), ErrorKind::Verify))));
+/// assert_eq!(parser_fn(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+#[doc(alias = "char")]
+#[doc(alias = "token")]
+#[doc(alias = "satisfy")]
+pub fn one_of<I, T, Error: ParserError<I>>(list: T) -> impl Parser<I, <I as Stream>::Token, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: Clone,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ trace(
+ "one_of",
+ any.verify(move |t: &<I as Stream>::Token| list.contains_token(t.clone())),
+ )
+}
+
+/// Recognize a token that does not match the [pattern][ContainsToken]
+///
+/// *Complete version*: Will return an error if there's not enough input data.
+///
+/// *Partial version*: Will return `Err(winnow::error::ErrMode::Incomplete(_))` if there's not enough input data.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError};
+/// # use winnow::prelude::*;
+/// # use winnow::token::none_of;
+/// assert_eq!(none_of::<_, _, InputError<_>>(['a', 'b', 'c']).parse_peek("z"), Ok(("", 'z')));
+/// assert_eq!(none_of::<_, _, InputError<_>>(['a', 'b']).parse_peek("a"), Err(ErrMode::Backtrack(InputError::new("a", ErrorKind::Verify))));
+/// assert_eq!(none_of::<_, _, InputError<_>>('a').parse_peek(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Token))));
+/// ```
+///
+/// ```
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// # use winnow::token::none_of;
+/// assert_eq!(none_of::<_, _, InputError<_>>(['a', 'b', 'c']).parse_peek(Partial::new("z")), Ok((Partial::new(""), 'z')));
+/// assert_eq!(none_of::<_, _, InputError<_>>(['a', 'b']).parse_peek(Partial::new("a")), Err(ErrMode::Backtrack(InputError::new(Partial::new("a"), ErrorKind::Verify))));
+/// assert_eq!(none_of::<_, _, InputError<_>>('a').parse_peek(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+pub fn none_of<I, T, Error: ParserError<I>>(list: T) -> impl Parser<I, <I as Stream>::Token, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ <I as Stream>::Token: Clone,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ trace(
+ "none_of",
+ any.verify(move |t: &<I as Stream>::Token| !list.contains_token(t.clone())),
+ )
+}
+
+/// Recognize the longest (m <= len <= n) input slice that matches the [pattern][ContainsToken]
+///
+/// It will return an `ErrMode::Backtrack(InputError::new(_, ErrorKind::Slice))` if the pattern wasn't met or is out
+/// of range (m <= len <= n).
+///
+/// *Partial version* will return a `ErrMode::Incomplete(Needed::new(1))` if the pattern reaches the end of the input or is too short.
+///
+/// To recognize a series of tokens, use [`repeat`][crate::combinator::repeat] to [`Accumulate`][crate::stream::Accumulate] into a `()` and then [`Parser::recognize`].
+///
+/// # Example
+///
+/// Zero or more tokens:
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn alpha(s: &[u8]) -> IResult<&[u8], &[u8]> {
+/// take_while(0.., AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(alpha(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
+/// assert_eq!(alpha(b"12345"), Ok((&b"12345"[..], &b""[..])));
+/// assert_eq!(alpha(b"latin"), Ok((&b""[..], &b"latin"[..])));
+/// assert_eq!(alpha(b""), Ok((&b""[..], &b""[..])));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn alpha(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+/// take_while(0.., AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(alpha(Partial::new(b"latin123")), Ok((Partial::new(&b"123"[..]), &b"latin"[..])));
+/// assert_eq!(alpha(Partial::new(b"12345")), Ok((Partial::new(&b"12345"[..]), &b""[..])));
+/// assert_eq!(alpha(Partial::new(b"latin")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(alpha(Partial::new(b"")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+///
+/// One or more tokens:
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn alpha(s: &[u8]) -> IResult<&[u8], &[u8]> {
+/// take_while(1.., AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(alpha(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
+/// assert_eq!(alpha(b"latin"), Ok((&b""[..], &b"latin"[..])));
+/// assert_eq!(alpha(b"12345"), Err(ErrMode::Backtrack(InputError::new(&b"12345"[..], ErrorKind::Slice))));
+///
+/// fn hex(s: &str) -> IResult<&str, &str> {
+/// take_while(1.., ('0'..='9', 'A'..='F')).parse_peek(s)
+/// }
+///
+/// assert_eq!(hex("123 and voila"), Ok((" and voila", "123")));
+/// assert_eq!(hex("DEADBEEF and others"), Ok((" and others", "DEADBEEF")));
+/// assert_eq!(hex("BADBABEsomething"), Ok(("something", "BADBABE")));
+/// assert_eq!(hex("D15EA5E"), Ok(("", "D15EA5E")));
+/// assert_eq!(hex(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn alpha(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+/// take_while(1.., AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(alpha(Partial::new(b"latin123")), Ok((Partial::new(&b"123"[..]), &b"latin"[..])));
+/// assert_eq!(alpha(Partial::new(b"latin")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(alpha(Partial::new(b"12345")), Err(ErrMode::Backtrack(InputError::new(Partial::new(&b"12345"[..]), ErrorKind::Slice))));
+///
+/// fn hex(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_while(1.., ('0'..='9', 'A'..='F')).parse_peek(s)
+/// }
+///
+/// assert_eq!(hex(Partial::new("123 and voila")), Ok((Partial::new(" and voila"), "123")));
+/// assert_eq!(hex(Partial::new("DEADBEEF and others")), Ok((Partial::new(" and others"), "DEADBEEF")));
+/// assert_eq!(hex(Partial::new("BADBABEsomething")), Ok((Partial::new("something"), "BADBABE")));
+/// assert_eq!(hex(Partial::new("D15EA5E")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(hex(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+///
+/// Arbitrary amount of tokens:
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn short_alpha(s: &[u8]) -> IResult<&[u8], &[u8]> {
+/// take_while(3..=6, AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(short_alpha(b"latin123"), Ok((&b"123"[..], &b"latin"[..])));
+/// assert_eq!(short_alpha(b"lengthy"), Ok((&b"y"[..], &b"length"[..])));
+/// assert_eq!(short_alpha(b"latin"), Ok((&b""[..], &b"latin"[..])));
+/// assert_eq!(short_alpha(b"ed"), Err(ErrMode::Backtrack(InputError::new(&b"ed"[..], ErrorKind::Slice))));
+/// assert_eq!(short_alpha(b"12345"), Err(ErrMode::Backtrack(InputError::new(&b"12345"[..], ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_while;
+/// use winnow::stream::AsChar;
+///
+/// fn short_alpha(s: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+/// take_while(3..=6, AsChar::is_alpha).parse_peek(s)
+/// }
+///
+/// assert_eq!(short_alpha(Partial::new(b"latin123")), Ok((Partial::new(&b"123"[..]), &b"latin"[..])));
+/// assert_eq!(short_alpha(Partial::new(b"lengthy")), Ok((Partial::new(&b"y"[..]), &b"length"[..])));
+/// assert_eq!(short_alpha(Partial::new(b"latin")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(short_alpha(Partial::new(b"ed")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(short_alpha(Partial::new(b"12345")), Err(ErrMode::Backtrack(InputError::new(Partial::new(&b"12345"[..]), ErrorKind::Slice))));
+/// ```
+#[inline(always)]
+#[doc(alias = "is_a")]
+#[doc(alias = "take_while0")]
+#[doc(alias = "take_while1")]
+pub fn take_while<T, I, Error: ParserError<I>>(
+ range: impl Into<Range>,
+ list: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = range.into();
+ trace("take_while", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_while0_::<_, _, _, true>(i, &list)
+ } else {
+ take_while0_::<_, _, _, false>(i, &list)
+ }
+ }
+ (1, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_while1_::<_, _, _, true>(i, &list)
+ } else {
+ take_while1_::<_, _, _, false>(i, &list)
+ }
+ }
+ (start, end) => {
+ let end = end.unwrap_or(usize::MAX);
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_while_m_n_::<_, _, _, true>(i, start, end, &list)
+ } else {
+ take_while_m_n_::<_, _, _, false>(i, start, end, &list)
+ }
+ }
+ }
+ })
+}
+
+fn take_while0_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+ list: &T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ if PARTIAL && input.is_partial() {
+ take_till0_partial(input, |c| !list.contains_token(c))
+ } else {
+ take_till0_complete(input, |c| !list.contains_token(c))
+ }
+}
+
+fn take_while1_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+ list: &T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ if PARTIAL && input.is_partial() {
+ take_till1_partial(input, |c| !list.contains_token(c))
+ } else {
+ take_till1_complete(input, |c| !list.contains_token(c))
+ }
+}
+
+fn take_while_m_n_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+ m: usize,
+ n: usize,
+ list: &T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ take_till_m_n::<_, _, _, PARTIAL>(input, m, n, |c| !list.contains_token(c))
+}
+
+/// Looks for the first element of the input type for which the condition returns true,
+/// and returns the input up to this position.
+///
+/// *Partial version*: If no element is found matching the condition, this will return `Incomplete`
+fn take_till0_partial<P, I: Stream, E: ParserError<I>>(
+ input: &mut I,
+ predicate: P,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ P: Fn(I::Token) -> bool,
+{
+ let offset = input
+ .offset_for(predicate)
+ .ok_or_else(|| ErrMode::Incomplete(Needed::new(1)))?;
+ Ok(input.next_slice(offset))
+}
+
+/// Looks for the first element of the input type for which the condition returns true
+/// and returns the input up to this position.
+///
+/// Fails if the produced slice is empty.
+///
+/// *Partial version*: If no element is found matching the condition, this will return `Incomplete`
+fn take_till1_partial<P, I: Stream, E: ParserError<I>>(
+ input: &mut I,
+ predicate: P,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ P: Fn(I::Token) -> bool,
+{
+ let e: ErrorKind = ErrorKind::Slice;
+ let offset = input
+ .offset_for(predicate)
+ .ok_or_else(|| ErrMode::Incomplete(Needed::new(1)))?;
+ if offset == 0 {
+ Err(ErrMode::from_error_kind(input, e))
+ } else {
+ Ok(input.next_slice(offset))
+ }
+}
+
+/// Looks for the first element of the input type for which the condition returns true,
+/// and returns the input up to this position.
+///
+/// *Complete version*: If no element is found matching the condition, this will return the whole input
+fn take_till0_complete<P, I: Stream, E: ParserError<I>>(
+ input: &mut I,
+ predicate: P,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ P: Fn(I::Token) -> bool,
+{
+ let offset = input
+ .offset_for(predicate)
+ .unwrap_or_else(|| input.eof_offset());
+ Ok(input.next_slice(offset))
+}
+
+/// Looks for the first element of the input type for which the condition returns true
+/// and returns the input up to this position.
+///
+/// Fails if the produced slice is empty.
+///
+/// *Complete version*: If no element is found matching the condition, this will return the whole input
+fn take_till1_complete<P, I: Stream, E: ParserError<I>>(
+ input: &mut I,
+ predicate: P,
+) -> PResult<<I as Stream>::Slice, E>
+where
+ P: Fn(I::Token) -> bool,
+{
+ let e: ErrorKind = ErrorKind::Slice;
+ let offset = input
+ .offset_for(predicate)
+ .unwrap_or_else(|| input.eof_offset());
+ if offset == 0 {
+ Err(ErrMode::from_error_kind(input, e))
+ } else {
+ Ok(input.next_slice(offset))
+ }
+}
+
+fn take_till_m_n<P, I, Error: ParserError<I>, const PARTIAL: bool>(
+ input: &mut I,
+ m: usize,
+ n: usize,
+ predicate: P,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ P: Fn(I::Token) -> bool,
+{
+ if n < m {
+ return Err(ErrMode::assert(input, "`m` should be <= `n`"));
+ }
+
+ let mut final_count = 0;
+ for (processed, (offset, token)) in input.iter_offsets().enumerate() {
+ if predicate(token) {
+ if processed < m {
+ return Err(ErrMode::from_error_kind(input, ErrorKind::Slice));
+ } else {
+ return Ok(input.next_slice(offset));
+ }
+ } else {
+ if processed == n {
+ return Ok(input.next_slice(offset));
+ }
+ final_count = processed + 1;
+ }
+ }
+ if PARTIAL && input.is_partial() {
+ if final_count == n {
+ Ok(input.finish())
+ } else {
+ let needed = if m > input.eof_offset() {
+ m - input.eof_offset()
+ } else {
+ 1
+ };
+ Err(ErrMode::Incomplete(Needed::new(needed)))
+ }
+ } else {
+ if m <= final_count {
+ Ok(input.finish())
+ } else {
+ Err(ErrMode::from_error_kind(input, ErrorKind::Slice))
+ }
+ }
+}
+
+/// Recognize the longest input slice (if any) till a [pattern][ContainsToken] is met.
+///
+/// *Partial version* will return a `ErrMode::Incomplete(Needed::new(1))` if the match reaches the
+/// end of input or if there was not match.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_till;
+///
+/// fn till_colon(s: &str) -> IResult<&str, &str> {
+/// take_till(0.., |c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon("latin:123"), Ok((":123", "latin")));
+/// assert_eq!(till_colon(":empty matched"), Ok((":empty matched", ""))); //allowed
+/// assert_eq!(till_colon("12345"), Ok(("", "12345")));
+/// assert_eq!(till_colon(""), Ok(("", "")));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_till;
+///
+/// fn till_colon(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_till(0.., |c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon(Partial::new("latin:123")), Ok((Partial::new(":123"), "latin")));
+/// assert_eq!(till_colon(Partial::new(":empty matched")), Ok((Partial::new(":empty matched"), ""))); //allowed
+/// assert_eq!(till_colon(Partial::new("12345")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(till_colon(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+#[doc(alias = "is_not")]
+pub fn take_till<T, I, Error: ParserError<I>>(
+ range: impl Into<Range>,
+ list: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = range.into();
+ trace("take_till", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_till0_partial(i, |c| list.contains_token(c))
+ } else {
+ take_till0_complete(i, |c| list.contains_token(c))
+ }
+ }
+ (1, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_till1_partial(i, |c| list.contains_token(c))
+ } else {
+ take_till1_complete(i, |c| list.contains_token(c))
+ }
+ }
+ (start, end) => {
+ let end = end.unwrap_or(usize::MAX);
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_till_m_n::<_, _, _, true>(i, start, end, |c| list.contains_token(c))
+ } else {
+ take_till_m_n::<_, _, _, false>(i, start, end, |c| list.contains_token(c))
+ }
+ }
+ }
+ })
+}
+
+/// Recognize the longest input slice (if any) till a [pattern][ContainsToken] is met.
+///
+/// *Partial version* will return a `ErrMode::Incomplete(Needed::new(1))` if the match reaches the
+/// end of input or if there was not match.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_till0;
+///
+/// fn till_colon(s: &str) -> IResult<&str, &str> {
+/// take_till0(|c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon("latin:123"), Ok((":123", "latin")));
+/// assert_eq!(till_colon(":empty matched"), Ok((":empty matched", ""))); //allowed
+/// assert_eq!(till_colon("12345"), Ok(("", "12345")));
+/// assert_eq!(till_colon(""), Ok(("", "")));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_till0;
+///
+/// fn till_colon(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_till0(|c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon(Partial::new("latin:123")), Ok((Partial::new(":123"), "latin")));
+/// assert_eq!(till_colon(Partial::new(":empty matched")), Ok((Partial::new(":empty matched"), ""))); //allowed
+/// assert_eq!(till_colon(Partial::new("12345")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(till_colon(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[deprecated(since = "0.5.21", note = "Replaced with `take_till(0.., ...)`")]
+#[inline(always)]
+pub fn take_till0<T, I, Error: ParserError<I>>(
+ list: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ trace("take_till0", move |i: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() && i.is_partial() {
+ take_till0_partial(i, |c| list.contains_token(c))
+ } else {
+ take_till0_complete(i, |c| list.contains_token(c))
+ }
+ })
+}
+
+/// Recognize the longest (at least 1) input slice till a [pattern][ContainsToken] is met.
+///
+/// It will return `Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Slice)))` if the input is empty or the
+/// predicate matches the first input.
+///
+/// *Partial version* will return a `ErrMode::Incomplete(Needed::new(1))` if the match reaches the
+/// end of input or if there was not match.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_till1;
+///
+/// fn till_colon(s: &str) -> IResult<&str, &str> {
+/// take_till1(|c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon("latin:123"), Ok((":123", "latin")));
+/// assert_eq!(till_colon(":empty matched"), Err(ErrMode::Backtrack(InputError::new(":empty matched", ErrorKind::Slice))));
+/// assert_eq!(till_colon("12345"), Ok(("", "12345")));
+/// assert_eq!(till_colon(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+///
+/// fn not_space(s: &str) -> IResult<&str, &str> {
+/// take_till1([' ', '\t', '\r', '\n']).parse_peek(s)
+/// }
+///
+/// assert_eq!(not_space("Hello, World!"), Ok((" World!", "Hello,")));
+/// assert_eq!(not_space("Sometimes\t"), Ok(("\t", "Sometimes")));
+/// assert_eq!(not_space("Nospace"), Ok(("", "Nospace")));
+/// assert_eq!(not_space(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_till1;
+///
+/// fn till_colon(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_till1(|c| c == ':').parse_peek(s)
+/// }
+///
+/// assert_eq!(till_colon(Partial::new("latin:123")), Ok((Partial::new(":123"), "latin")));
+/// assert_eq!(till_colon(Partial::new(":empty matched")), Err(ErrMode::Backtrack(InputError::new(Partial::new(":empty matched"), ErrorKind::Slice))));
+/// assert_eq!(till_colon(Partial::new("12345")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(till_colon(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+///
+/// fn not_space(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_till1([' ', '\t', '\r', '\n']).parse_peek(s)
+/// }
+///
+/// assert_eq!(not_space(Partial::new("Hello, World!")), Ok((Partial::new(" World!"), "Hello,")));
+/// assert_eq!(not_space(Partial::new("Sometimes\t")), Ok((Partial::new("\t"), "Sometimes")));
+/// assert_eq!(not_space(Partial::new("Nospace")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// assert_eq!(not_space(Partial::new("")), Err(ErrMode::Incomplete(Needed::new(1))));
+/// ```
+#[inline(always)]
+#[deprecated(since = "0.5.21", note = "Replaced with `take_till(1.., ...)`")]
+pub fn take_till1<T, I, Error: ParserError<I>>(
+ list: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ T: ContainsToken<<I as Stream>::Token>,
+{
+ trace("take_till1", move |i: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() && i.is_partial() {
+ take_till1_partial(i, |c| list.contains_token(c))
+ } else {
+ take_till1_complete(i, |c| list.contains_token(c))
+ }
+ })
+}
+
+/// Recognize an input slice containing the first N input elements (I[..N]).
+///
+/// *Complete version*: It will return `Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Slice)))` if the input is shorter than the argument.
+///
+/// *Partial version*: if the input has less than N elements, `take` will
+/// return a `ErrMode::Incomplete(Needed::new(M))` where M is the number of
+/// additional bytes the parser would need to succeed.
+/// It is well defined for `&[u8]` as the number of elements is the byte size,
+/// but for types like `&str`, we cannot know how many bytes correspond for
+/// the next few chars, so the result will be `ErrMode::Incomplete(Needed::Unknown)`
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take;
+///
+/// fn take6(s: &str) -> IResult<&str, &str> {
+/// take(6usize).parse_peek(s)
+/// }
+///
+/// assert_eq!(take6("1234567"), Ok(("7", "123456")));
+/// assert_eq!(take6("things"), Ok(("", "things")));
+/// assert_eq!(take6("short"), Err(ErrMode::Backtrack(InputError::new("short", ErrorKind::Slice))));
+/// assert_eq!(take6(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// ```
+///
+/// The units that are taken will depend on the input type. For example, for a
+/// `&str` it will take a number of `char`'s, whereas for a `&[u8]` it will
+/// take that many `u8`'s:
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// use winnow::error::InputError;
+/// use winnow::token::take;
+///
+/// assert_eq!(take::<_, _, InputError<_>>(1usize).parse_peek("💙"), Ok(("", "💙")));
+/// assert_eq!(take::<_, _, InputError<_>>(1usize).parse_peek("💙".as_bytes()), Ok((b"\x9F\x92\x99".as_ref(), b"\xF0".as_ref())));
+/// ```
+///
+/// ```rust
+/// # use winnow::prelude::*;
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::Partial;
+/// use winnow::token::take;
+///
+/// fn take6(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take(6usize).parse_peek(s)
+/// }
+///
+/// assert_eq!(take6(Partial::new("1234567")), Ok((Partial::new("7"), "123456")));
+/// assert_eq!(take6(Partial::new("things")), Ok((Partial::new(""), "things")));
+/// // `Unknown` as we don't know the number of bytes that `count` corresponds to
+/// assert_eq!(take6(Partial::new("short")), Err(ErrMode::Incomplete(Needed::Unknown)));
+/// ```
+#[inline(always)]
+pub fn take<C, I, Error: ParserError<I>>(count: C) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+ C: ToUsize,
+{
+ let c = count.to_usize();
+ trace("take", move |i: &mut I| {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_::<_, _, true>(i, c)
+ } else {
+ take_::<_, _, false>(i, c)
+ }
+ })
+}
+
+fn take_<I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ c: usize,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream,
+{
+ match i.offset_at(c) {
+ Ok(offset) => Ok(i.next_slice(offset)),
+ Err(e) if PARTIAL && i.is_partial() => Err(ErrMode::Incomplete(e)),
+ Err(_needed) => Err(ErrMode::from_error_kind(i, ErrorKind::Slice)),
+ }
+}
+
+/// Recognize the input slice up to the first occurrence of the literal.
+///
+/// It doesn't consume the pattern.
+///
+/// *Complete version*: It will return `Err(ErrMode::Backtrack(InputError::new(_, ErrorKind::Slice)))`
+/// if the pattern wasn't met.
+///
+/// *Partial version*: will return a `ErrMode::Incomplete(Needed::new(N))` if the input doesn't
+/// contain the pattern or if the input is smaller than the pattern.
+///
+/// # Example
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_until;
+///
+/// fn until_eof(s: &str) -> IResult<&str, &str> {
+/// take_until(0.., "eof").parse_peek(s)
+/// }
+///
+/// assert_eq!(until_eof("hello, worldeof"), Ok(("eof", "hello, world")));
+/// assert_eq!(until_eof("hello, world"), Err(ErrMode::Backtrack(InputError::new("hello, world", ErrorKind::Slice))));
+/// assert_eq!(until_eof(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// assert_eq!(until_eof("1eof2eof"), Ok(("eof2eof", "1")));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::ErrorKind, error::InputError, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_until;
+///
+/// fn until_eof(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_until(0.., "eof").parse_peek(s)
+/// }
+///
+/// assert_eq!(until_eof(Partial::new("hello, worldeof")), Ok((Partial::new("eof"), "hello, world")));
+/// assert_eq!(until_eof(Partial::new("hello, world")), Err(ErrMode::Incomplete(Needed::Unknown)));
+/// assert_eq!(until_eof(Partial::new("hello, worldeo")), Err(ErrMode::Incomplete(Needed::Unknown)));
+/// assert_eq!(until_eof(Partial::new("1eof2eof")), Ok((Partial::new("eof2eof"), "1")));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// use winnow::token::take_until;
+///
+/// fn until_eof(s: &str) -> IResult<&str, &str> {
+/// take_until(1.., "eof").parse_peek(s)
+/// }
+///
+/// assert_eq!(until_eof("hello, worldeof"), Ok(("eof", "hello, world")));
+/// assert_eq!(until_eof("hello, world"), Err(ErrMode::Backtrack(InputError::new("hello, world", ErrorKind::Slice))));
+/// assert_eq!(until_eof(""), Err(ErrMode::Backtrack(InputError::new("", ErrorKind::Slice))));
+/// assert_eq!(until_eof("1eof2eof"), Ok(("eof2eof", "1")));
+/// assert_eq!(until_eof("eof"), Err(ErrMode::Backtrack(InputError::new("eof", ErrorKind::Slice))));
+/// ```
+///
+/// ```rust
+/// # use winnow::{error::ErrMode, error::{InputError, ErrorKind}, error::Needed};
+/// # use winnow::prelude::*;
+/// # use winnow::Partial;
+/// use winnow::token::take_until;
+///
+/// fn until_eof(s: Partial<&str>) -> IResult<Partial<&str>, &str> {
+/// take_until(1.., "eof").parse_peek(s)
+/// }
+///
+/// assert_eq!(until_eof(Partial::new("hello, worldeof")), Ok((Partial::new("eof"), "hello, world")));
+/// assert_eq!(until_eof(Partial::new("hello, world")), Err(ErrMode::Incomplete(Needed::Unknown)));
+/// assert_eq!(until_eof(Partial::new("hello, worldeo")), Err(ErrMode::Incomplete(Needed::Unknown)));
+/// assert_eq!(until_eof(Partial::new("1eof2eof")), Ok((Partial::new("eof2eof"), "1")));
+/// assert_eq!(until_eof(Partial::new("eof")), Err(ErrMode::Backtrack(InputError::new(Partial::new("eof"), ErrorKind::Slice))));
+/// ```
+#[inline(always)]
+pub fn take_until<T, I, Error: ParserError<I>>(
+ range: impl Into<Range>,
+ tag: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen + Clone,
+{
+ let Range {
+ start_inclusive,
+ end_inclusive,
+ } = range.into();
+ trace("take_until", move |i: &mut I| {
+ match (start_inclusive, end_inclusive) {
+ (0, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_until0_::<_, _, _, true>(i, tag.clone())
+ } else {
+ take_until0_::<_, _, _, false>(i, tag.clone())
+ }
+ }
+ (1, None) => {
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_until1_::<_, _, _, true>(i, tag.clone())
+ } else {
+ take_until1_::<_, _, _, false>(i, tag.clone())
+ }
+ }
+ (start, end) => {
+ let end = end.unwrap_or(usize::MAX);
+ if <I as StreamIsPartial>::is_partial_supported() {
+ take_until_m_n_::<_, _, _, true>(i, start, end, tag.clone())
+ } else {
+ take_until_m_n_::<_, _, _, false>(i, start, end, tag.clone())
+ }
+ }
+ }
+ })
+}
+
+/// Deprecated, see [`take_until`]
+#[deprecated(since = "0.5.35", note = "Replaced with `take_until`")]
+pub fn take_until0<T, I, Error: ParserError<I>>(
+ tag: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen + Clone,
+{
+ take_until(0.., tag)
+}
+
+fn take_until0_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ t: T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen,
+{
+ match i.find_slice(t) {
+ Some(offset) => Ok(i.next_slice(offset)),
+ None if PARTIAL && i.is_partial() => Err(ErrMode::Incomplete(Needed::Unknown)),
+ None => Err(ErrMode::from_error_kind(i, ErrorKind::Slice)),
+ }
+}
+
+/// Deprecated, see [`take_until`]
+#[deprecated(since = "0.5.35", note = "Replaced with `take_until`")]
+#[inline(always)]
+pub fn take_until1<T, I, Error: ParserError<I>>(
+ tag: T,
+) -> impl Parser<I, <I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen + Clone,
+{
+ take_until(1.., tag)
+}
+
+fn take_until1_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ t: T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen,
+{
+ match i.find_slice(t) {
+ None if PARTIAL && i.is_partial() => Err(ErrMode::Incomplete(Needed::Unknown)),
+ None | Some(0) => Err(ErrMode::from_error_kind(i, ErrorKind::Slice)),
+ Some(offset) => Ok(i.next_slice(offset)),
+ }
+}
+
+fn take_until_m_n_<T, I, Error: ParserError<I>, const PARTIAL: bool>(
+ i: &mut I,
+ start: usize,
+ end: usize,
+ t: T,
+) -> PResult<<I as Stream>::Slice, Error>
+where
+ I: StreamIsPartial,
+ I: Stream + FindSlice<T>,
+ T: SliceLen,
+{
+ if end < start {
+ return Err(ErrMode::assert(i, "`start` should be <= `end`"));
+ }
+
+ match i.find_slice(t) {
+ Some(offset) => {
+ let start_offset = i.offset_at(start);
+ let end_offset = i.offset_at(end).unwrap_or_else(|_err| i.eof_offset());
+ if start_offset.map(|s| offset < s).unwrap_or(true) {
+ if PARTIAL && i.is_partial() {
+ return Err(ErrMode::Incomplete(Needed::Unknown));
+ } else {
+ return Err(ErrMode::from_error_kind(i, ErrorKind::Slice));
+ }
+ }
+ if end_offset < offset {
+ return Err(ErrMode::from_error_kind(i, ErrorKind::Slice));
+ }
+ Ok(i.next_slice(offset))
+ }
+ None if PARTIAL && i.is_partial() => Err(ErrMode::Incomplete(Needed::Unknown)),
+ None => Err(ErrMode::from_error_kind(i, ErrorKind::Slice)),
+ }
+}
diff --git a/crates/winnow/src/token/tests.rs b/crates/winnow/src/token/tests.rs
new file mode 100644
index 0000000..e8198f9
--- /dev/null
+++ b/crates/winnow/src/token/tests.rs
@@ -0,0 +1,686 @@
+use super::*;
+
+#[cfg(feature = "std")]
+use proptest::prelude::*;
+
+use crate::ascii::Caseless;
+use crate::combinator::delimited;
+use crate::error::ErrMode;
+use crate::error::ErrorKind;
+use crate::error::InputError;
+use crate::error::Needed;
+use crate::stream::AsChar;
+use crate::token::tag;
+use crate::unpeek;
+use crate::IResult;
+use crate::Parser;
+use crate::Partial;
+
+#[test]
+fn complete_take_while_m_n_utf8_all_matching() {
+ let result: IResult<&str, &str> =
+ take_while(1..=4, |c: char| c.is_alphabetic()).parse_peek("øn");
+ assert_eq!(result, Ok(("", "øn")));
+}
+
+#[test]
+fn complete_take_while_m_n_utf8_all_matching_substring() {
+ let result: IResult<&str, &str> = take_while(1, |c: char| c.is_alphabetic()).parse_peek("øn");
+ assert_eq!(result, Ok(("n", "ø")));
+}
+
+#[cfg(feature = "std")]
+fn model_complete_take_while_m_n(
+ m: usize,
+ n: usize,
+ valid: usize,
+ input: &str,
+) -> IResult<&str, &str> {
+ if n < m {
+ Err(crate::error::ErrMode::from_error_kind(
+ &input,
+ crate::error::ErrorKind::Slice,
+ ))
+ } else if m <= valid {
+ let offset = n.min(valid);
+ Ok((&input[offset..], &input[0..offset]))
+ } else {
+ Err(crate::error::ErrMode::from_error_kind(
+ &input,
+ crate::error::ErrorKind::Slice,
+ ))
+ }
+}
+
+#[cfg(feature = "std")]
+proptest! {
+ #[test]
+ #[cfg_attr(miri, ignore)] // See https://github.com/AltSysrq/proptest/issues/253
+ fn complete_take_while_m_n_bounds(m in 0..20usize, n in 0..20usize, valid in 0..20usize, invalid in 0..20usize) {
+ let input = format!("{:a<valid$}{:b<invalid$}", "", "", valid=valid, invalid=invalid);
+ let expected = model_complete_take_while_m_n(m, n, valid, &input);
+ if m <= n {
+ let actual = take_while(m..=n, |c: char| c == 'a').parse_peek(input.as_str());
+ assert_eq!(expected, actual);
+ }
+ }
+}
+
+#[test]
+fn complete_take_until() {
+ fn take_until_5_10(i: &str) -> IResult<&str, &str> {
+ take_until(5..=8, "end").parse_peek(i)
+ }
+ assert_eq!(
+ take_until_5_10("end"),
+ Err(ErrMode::Backtrack(error_position!(
+ &"end",
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ take_until_5_10("1234end"),
+ Err(ErrMode::Backtrack(error_position!(
+ &"1234end",
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(take_until_5_10("12345end"), Ok(("end", "12345")));
+ assert_eq!(take_until_5_10("123456end"), Ok(("end", "123456")));
+ assert_eq!(take_until_5_10("12345678end"), Ok(("end", "12345678")));
+ assert_eq!(
+ take_until_5_10("123456789end"),
+ Err(ErrMode::Backtrack(error_position!(
+ &"123456789end",
+ ErrorKind::Slice
+ )))
+ );
+}
+
+#[test]
+fn partial_any_str() {
+ use super::any;
+ assert_eq!(
+ any::<_, InputError<Partial<&str>>>.parse_peek(Partial::new("Ә")),
+ Ok((Partial::new(""), 'Ә'))
+ );
+}
+
+#[test]
+fn partial_one_of_test() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+ one_of(['a', 'b']).parse_peek(i)
+ }
+
+ let a = &b"abcd"[..];
+ assert_eq!(f(Partial::new(a)), Ok((Partial::new(&b"bcd"[..]), b'a')));
+
+ let b = &b"cde"[..];
+ assert_eq!(
+ f(Partial::new(b)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(b),
+ ErrorKind::Verify
+ )))
+ );
+
+ fn utf8(i: Partial<&str>) -> IResult<Partial<&str>, char> {
+ one_of(['+', '\u{FF0B}']).parse_peek(i)
+ }
+
+ assert!(utf8(Partial::new("+")).is_ok());
+ assert!(utf8(Partial::new("\u{FF0B}")).is_ok());
+}
+
+#[test]
+fn char_byteslice() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+ 'c'.parse_peek(i)
+ }
+
+ let a = &b"abcd"[..];
+ assert_eq!(
+ f(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(a),
+ ErrorKind::Verify
+ )))
+ );
+
+ let b = &b"cde"[..];
+ assert_eq!(f(Partial::new(b)), Ok((Partial::new(&b"de"[..]), b'c')));
+}
+
+#[test]
+fn char_str() {
+ fn f(i: Partial<&str>) -> IResult<Partial<&str>, char> {
+ 'c'.parse_peek(i)
+ }
+
+ let a = "abcd";
+ assert_eq!(
+ f(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(a),
+ ErrorKind::Verify
+ )))
+ );
+
+ let b = "cde";
+ assert_eq!(f(Partial::new(b)), Ok((Partial::new("de"), 'c')));
+}
+
+#[test]
+fn partial_none_of_test() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, u8> {
+ none_of(['a', 'b']).parse_peek(i)
+ }
+
+ let a = &b"abcd"[..];
+ assert_eq!(
+ f(Partial::new(a)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(a),
+ ErrorKind::Verify
+ )))
+ );
+
+ let b = &b"cde"[..];
+ assert_eq!(f(Partial::new(b)), Ok((Partial::new(&b"de"[..]), b'c')));
+}
+
+#[test]
+fn partial_is_a() {
+ fn a_or_b(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_while(1.., ['a', 'b']).parse_peek(i)
+ }
+
+ let a = Partial::new(&b"abcd"[..]);
+ assert_eq!(a_or_b(a), Ok((Partial::new(&b"cd"[..]), &b"ab"[..])));
+
+ let b = Partial::new(&b"bcde"[..]);
+ assert_eq!(a_or_b(b), Ok((Partial::new(&b"cde"[..]), &b"b"[..])));
+
+ let c = Partial::new(&b"cdef"[..]);
+ assert_eq!(
+ a_or_b(c),
+ Err(ErrMode::Backtrack(error_position!(&c, ErrorKind::Slice)))
+ );
+
+ let d = Partial::new(&b"bacdef"[..]);
+ assert_eq!(a_or_b(d), Ok((Partial::new(&b"cdef"[..]), &b"ba"[..])));
+}
+
+#[test]
+fn partial_is_not() {
+ fn a_or_b(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_till(1.., ['a', 'b']).parse_peek(i)
+ }
+
+ let a = Partial::new(&b"cdab"[..]);
+ assert_eq!(a_or_b(a), Ok((Partial::new(&b"ab"[..]), &b"cd"[..])));
+
+ let b = Partial::new(&b"cbde"[..]);
+ assert_eq!(a_or_b(b), Ok((Partial::new(&b"bde"[..]), &b"c"[..])));
+
+ let c = Partial::new(&b"abab"[..]);
+ assert_eq!(
+ a_or_b(c),
+ Err(ErrMode::Backtrack(error_position!(&c, ErrorKind::Slice)))
+ );
+
+ let d = Partial::new(&b"cdefba"[..]);
+ assert_eq!(a_or_b(d), Ok((Partial::new(&b"ba"[..]), &b"cdef"[..])));
+
+ let e = Partial::new(&b"e"[..]);
+ assert_eq!(a_or_b(e), Err(ErrMode::Incomplete(Needed::new(1))));
+}
+
+#[test]
+fn partial_take_until_incomplete() {
+ fn y(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_until(0.., "end").parse_peek(i)
+ }
+ assert_eq!(
+ y(Partial::new(&b"nd"[..])),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+ assert_eq!(
+ y(Partial::new(&b"123"[..])),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+ assert_eq!(
+ y(Partial::new(&b"123en"[..])),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+}
+
+#[test]
+fn partial_take_until_incomplete_s() {
+ fn ys(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_until(0.., "end").parse_peek(i)
+ }
+ assert_eq!(
+ ys(Partial::new("123en")),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+}
+
+#[test]
+fn partial_recognize() {
+ use crate::ascii::{
+ alpha1 as alpha, alphanumeric1 as alphanumeric, digit1 as digit, hex_digit1 as hex_digit,
+ multispace1 as multispace, oct_digit1 as oct_digit, space1 as space,
+ };
+
+ fn x(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ delimited("<!--", take(5_usize), "-->")
+ .recognize()
+ .parse_peek(i)
+ }
+ let r = x(Partial::new(&b"<!-- abc --> aaa"[..]));
+ assert_eq!(r, Ok((Partial::new(&b" aaa"[..]), &b"<!-- abc -->"[..])));
+
+ let semicolon = &b";"[..];
+
+ fn ya(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ alpha.recognize().parse_peek(i)
+ }
+ let ra = ya(Partial::new(&b"abc;"[..]));
+ assert_eq!(ra, Ok((Partial::new(semicolon), &b"abc"[..])));
+
+ fn yd(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ digit.recognize().parse_peek(i)
+ }
+ let rd = yd(Partial::new(&b"123;"[..]));
+ assert_eq!(rd, Ok((Partial::new(semicolon), &b"123"[..])));
+
+ fn yhd(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ hex_digit.recognize().parse_peek(i)
+ }
+ let rhd = yhd(Partial::new(&b"123abcDEF;"[..]));
+ assert_eq!(rhd, Ok((Partial::new(semicolon), &b"123abcDEF"[..])));
+
+ fn yod(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ oct_digit.recognize().parse_peek(i)
+ }
+ let rod = yod(Partial::new(&b"1234567;"[..]));
+ assert_eq!(rod, Ok((Partial::new(semicolon), &b"1234567"[..])));
+
+ fn yan(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ alphanumeric.recognize().parse_peek(i)
+ }
+ let ran = yan(Partial::new(&b"123abc;"[..]));
+ assert_eq!(ran, Ok((Partial::new(semicolon), &b"123abc"[..])));
+
+ fn ys(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ space.recognize().parse_peek(i)
+ }
+ let rs = ys(Partial::new(&b" \t;"[..]));
+ assert_eq!(rs, Ok((Partial::new(semicolon), &b" \t"[..])));
+
+ fn yms(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ multispace.recognize().parse_peek(i)
+ }
+ let rms = yms(Partial::new(&b" \t\r\n;"[..]));
+ assert_eq!(rms, Ok((Partial::new(semicolon), &b" \t\r\n"[..])));
+}
+
+#[test]
+fn partial_take_while0() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_while(0.., AsChar::is_alpha).parse_peek(i)
+ }
+ let a = &b""[..];
+ let b = &b"abcd"[..];
+ let c = &b"abcd123"[..];
+ let d = &b"123"[..];
+
+ assert_eq!(f(Partial::new(a)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(f(Partial::new(b)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(f(Partial::new(c)), Ok((Partial::new(d), b)));
+ assert_eq!(f(Partial::new(d)), Ok((Partial::new(d), a)));
+}
+
+#[test]
+fn partial_take_while1() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_while(1.., AsChar::is_alpha).parse_peek(i)
+ }
+ let a = &b""[..];
+ let b = &b"abcd"[..];
+ let c = &b"abcd123"[..];
+ let d = &b"123"[..];
+
+ assert_eq!(f(Partial::new(a)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(f(Partial::new(b)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(f(Partial::new(c)), Ok((Partial::new(&b"123"[..]), b)));
+ assert_eq!(
+ f(Partial::new(d)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(d),
+ ErrorKind::Slice
+ )))
+ );
+}
+
+#[test]
+fn partial_take_while_m_n() {
+ fn x(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_while(2..=4, AsChar::is_alpha).parse_peek(i)
+ }
+ let a = &b""[..];
+ let b = &b"a"[..];
+ let c = &b"abc"[..];
+ let d = &b"abc123"[..];
+ let e = &b"abcde"[..];
+ let f = &b"123"[..];
+
+ assert_eq!(x(Partial::new(a)), Err(ErrMode::Incomplete(Needed::new(2))));
+ assert_eq!(x(Partial::new(b)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(x(Partial::new(c)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(x(Partial::new(d)), Ok((Partial::new(&b"123"[..]), c)));
+ assert_eq!(
+ x(Partial::new(e)),
+ Ok((Partial::new(&b"e"[..]), &b"abcd"[..]))
+ );
+ assert_eq!(
+ x(Partial::new(f)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(f),
+ ErrorKind::Slice
+ )))
+ );
+}
+
+#[test]
+fn partial_take_till0() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_till(0.., AsChar::is_alpha).parse_peek(i)
+ }
+ let a = &b""[..];
+ let b = &b"abcd"[..];
+ let c = &b"123abcd"[..];
+ let d = &b"123"[..];
+
+ assert_eq!(f(Partial::new(a)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(
+ f(Partial::new(b)),
+ Ok((Partial::new(&b"abcd"[..]), &b""[..]))
+ );
+ assert_eq!(
+ f(Partial::new(c)),
+ Ok((Partial::new(&b"abcd"[..]), &b"123"[..]))
+ );
+ assert_eq!(f(Partial::new(d)), Err(ErrMode::Incomplete(Needed::new(1))));
+}
+
+#[test]
+fn partial_take_till1() {
+ fn f(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_till(1.., AsChar::is_alpha).parse_peek(i)
+ }
+ let a = &b""[..];
+ let b = &b"abcd"[..];
+ let c = &b"123abcd"[..];
+ let d = &b"123"[..];
+
+ assert_eq!(f(Partial::new(a)), Err(ErrMode::Incomplete(Needed::new(1))));
+ assert_eq!(
+ f(Partial::new(b)),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(b),
+ ErrorKind::Slice
+ )))
+ );
+ assert_eq!(
+ f(Partial::new(c)),
+ Ok((Partial::new(&b"abcd"[..]), &b"123"[..]))
+ );
+ assert_eq!(f(Partial::new(d)), Err(ErrMode::Incomplete(Needed::new(1))));
+}
+
+#[test]
+fn partial_take_while_utf8() {
+ fn f(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(0.., |c| c != '點').parse_peek(i)
+ }
+
+ assert_eq!(
+ f(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ f(Partial::new("abcd")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(f(Partial::new("abcd點")), Ok((Partial::new("點"), "abcd")));
+ assert_eq!(
+ f(Partial::new("abcd點a")),
+ Ok((Partial::new("點a"), "abcd"))
+ );
+
+ fn g(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(0.., |c| c == '點').parse_peek(i)
+ }
+
+ assert_eq!(
+ g(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(g(Partial::new("點abcd")), Ok((Partial::new("abcd"), "點")));
+ assert_eq!(
+ g(Partial::new("點點點a")),
+ Ok((Partial::new("a"), "點點點"))
+ );
+}
+
+#[test]
+fn partial_take_till0_utf8() {
+ fn f(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_till(0.., |c| c == '點').parse_peek(i)
+ }
+
+ assert_eq!(
+ f(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(
+ f(Partial::new("abcd")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(f(Partial::new("abcd點")), Ok((Partial::new("點"), "abcd")));
+ assert_eq!(
+ f(Partial::new("abcd點a")),
+ Ok((Partial::new("點a"), "abcd"))
+ );
+
+ fn g(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_till(0.., |c| c != '點').parse_peek(i)
+ }
+
+ assert_eq!(
+ g(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(g(Partial::new("點abcd")), Ok((Partial::new("abcd"), "點")));
+ assert_eq!(
+ g(Partial::new("點點點a")),
+ Ok((Partial::new("a"), "點點點"))
+ );
+}
+
+#[test]
+fn partial_take_utf8() {
+ fn f(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take(3_usize).parse_peek(i)
+ }
+
+ assert_eq!(
+ f(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+ assert_eq!(
+ f(Partial::new("ab")),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+ assert_eq!(
+ f(Partial::new("點")),
+ Err(ErrMode::Incomplete(Needed::Unknown))
+ );
+ assert_eq!(f(Partial::new("ab點cd")), Ok((Partial::new("cd"), "ab點")));
+ assert_eq!(f(Partial::new("a點bcd")), Ok((Partial::new("cd"), "a點b")));
+ assert_eq!(f(Partial::new("a點b")), Ok((Partial::new(""), "a點b")));
+
+ fn g(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(0.., |c| c == '點').parse_peek(i)
+ }
+
+ assert_eq!(
+ g(Partial::new("")),
+ Err(ErrMode::Incomplete(Needed::new(1)))
+ );
+ assert_eq!(g(Partial::new("點abcd")), Ok((Partial::new("abcd"), "點")));
+ assert_eq!(
+ g(Partial::new("點點點a")),
+ Ok((Partial::new("a"), "點點點"))
+ );
+}
+
+#[test]
+fn partial_take_while_m_n_utf8_fixed() {
+ fn parser(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(1, |c| c == 'A' || c == '😃').parse_peek(i)
+ }
+ assert_eq!(parser(Partial::new("A!")), Ok((Partial::new("!"), "A")));
+ assert_eq!(parser(Partial::new("😃!")), Ok((Partial::new("!"), "😃")));
+}
+
+#[test]
+fn partial_take_while_m_n_utf8_range() {
+ fn parser(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(1..=2, |c| c == 'A' || c == '😃').parse_peek(i)
+ }
+ assert_eq!(parser(Partial::new("A!")), Ok((Partial::new("!"), "A")));
+ assert_eq!(parser(Partial::new("😃!")), Ok((Partial::new("!"), "😃")));
+}
+
+#[test]
+fn partial_take_while_m_n_utf8_full_match_fixed() {
+ fn parser(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(1, |c: char| c.is_alphabetic()).parse_peek(i)
+ }
+ assert_eq!(parser(Partial::new("øn")), Ok((Partial::new("n"), "ø")));
+}
+
+#[test]
+fn partial_take_while_m_n_utf8_full_match_range() {
+ fn parser(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ take_while(1..=2, |c: char| c.is_alphabetic()).parse_peek(i)
+ }
+ assert_eq!(parser(Partial::new("øn")), Ok((Partial::new(""), "øn")));
+}
+
+#[test]
+#[cfg(feature = "std")]
+fn partial_recognize_take_while0() {
+ fn x(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ take_while(0.., AsChar::is_alphanum).parse_peek(i)
+ }
+ fn y(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ unpeek(x).recognize().parse_peek(i)
+ }
+ assert_eq!(
+ x(Partial::new(&b"ab."[..])),
+ Ok((Partial::new(&b"."[..]), &b"ab"[..]))
+ );
+ assert_eq!(
+ y(Partial::new(&b"ab."[..])),
+ Ok((Partial::new(&b"."[..]), &b"ab"[..]))
+ );
+}
+
+#[cfg(feature = "alloc")]
+#[test]
+fn partial_case_insensitive() {
+ fn test(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ tag(Caseless("ABcd")).parse_peek(i)
+ }
+ assert_eq!(
+ test(Partial::new(&b"aBCdefgh"[..])),
+ Ok((Partial::new(&b"efgh"[..]), &b"aBCd"[..]))
+ );
+ assert_eq!(
+ test(Partial::new(&b"abcdefgh"[..])),
+ Ok((Partial::new(&b"efgh"[..]), &b"abcd"[..]))
+ );
+ assert_eq!(
+ test(Partial::new(&b"ABCDefgh"[..])),
+ Ok((Partial::new(&b"efgh"[..]), &b"ABCD"[..]))
+ );
+ assert_eq!(
+ test(Partial::new(&b"ab"[..])),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ test(Partial::new(&b"Hello"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"Hello"[..]),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ test(Partial::new(&b"Hel"[..])),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new(&b"Hel"[..]),
+ ErrorKind::Tag
+ )))
+ );
+
+ fn test2(i: Partial<&str>) -> IResult<Partial<&str>, &str> {
+ tag(Caseless("ABcd")).parse_peek(i)
+ }
+ assert_eq!(
+ test2(Partial::new("aBCdefgh")),
+ Ok((Partial::new("efgh"), "aBCd"))
+ );
+ assert_eq!(
+ test2(Partial::new("abcdefgh")),
+ Ok((Partial::new("efgh"), "abcd"))
+ );
+ assert_eq!(
+ test2(Partial::new("ABCDefgh")),
+ Ok((Partial::new("efgh"), "ABCD"))
+ );
+ assert_eq!(
+ test2(Partial::new("ab")),
+ Err(ErrMode::Incomplete(Needed::new(2)))
+ );
+ assert_eq!(
+ test2(Partial::new("Hello")),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new("Hello"),
+ ErrorKind::Tag
+ )))
+ );
+ assert_eq!(
+ test2(Partial::new("Hel")),
+ Err(ErrMode::Backtrack(error_position!(
+ &Partial::new("Hel"),
+ ErrorKind::Tag
+ )))
+ );
+}
+
+#[test]
+fn partial_tag_fixed_size_array() {
+ fn test(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ tag([0x42]).parse_peek(i)
+ }
+ fn test2(i: Partial<&[u8]>) -> IResult<Partial<&[u8]>, &[u8]> {
+ tag(&[0x42]).parse_peek(i)
+ }
+ let input = Partial::new(&[0x42, 0x00][..]);
+ assert_eq!(test(input), Ok((Partial::new(&b"\x00"[..]), &b"\x42"[..])));
+ assert_eq!(test2(input), Ok((Partial::new(&b"\x00"[..]), &b"\x42"[..])));
+}
diff --git a/crates/winnow/src/trace.rs b/crates/winnow/src/trace.rs
new file mode 100644
index 0000000..9c05576
--- /dev/null
+++ b/crates/winnow/src/trace.rs
@@ -0,0 +1,11 @@
+//! Deprecated, replaced with [`winnow::combinator`][crate::combinator]
+
+/// Deprecated, replaced with [`winnow::combinator::trace`][crate::combinator::trace]
+#[deprecated(since = "0.5.35", note = "Replaced with `winnow::combinator::trace`")]
+#[inline(always)]
+pub fn trace<I: crate::stream::Stream, O, E>(
+ name: impl crate::lib::std::fmt::Display,
+ parser: impl crate::Parser<I, O, E>,
+) -> impl crate::Parser<I, O, E> {
+ crate::combinator::trace(name, parser)
+}
diff --git a/crates/x509-cert/.cargo-checksum.json b/crates/x509-cert/.cargo-checksum.json
new file mode 100644
index 0000000..4caf555
--- /dev/null
+++ b/crates/x509-cert/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"CHANGELOG.md":"043e0aa12a2234d83a6275b3c441ad4a20e35b69573f1ab0bc9807328386c0c6","Cargo.toml":"8eac04d64bf333868cda728353223b88b99a3a0c2c13a2bcccee688d8acc6002","LICENSE-APACHE":"a9040321c3712d8fd0b09cf52b17445de04a23a10165049ae187cd39e5c86be5","LICENSE-MIT":"90c503b61dee04e1449c323ec34c229dfb68d7adcb96c7e140ee55f70fce2d8e","README.md":"134e595199609f93ce701855a28deb5f8efd499cce90d14f8d7eacf07df5dd81","src/anchor.rs":"6ecb9d5fd0dbf4d11259ca84b4b0401176dbe6f48015fe3cf5f2e298cad030f3","src/attr.rs":"4e4a3f0c6fb9e6f0b18f2bd2b9823292058348d5232ee9c0252cb9a7666795a6","src/builder.rs":"6983c82f49fd66ea7fe88b02d1568f22dfa977c4e727b238f05be16cfef781d8","src/certificate.rs":"68808361a48741be9e1c16aff98581b35761f81debb5aa97679d124485e3ca51","src/crl.rs":"77edbb79548f8eaecb088752f7ecb3a28cb81345d64c25eaee5f4255a37a6784","src/ext.rs":"b867b7c0fbff7499749cc272e332cbb7407888aaf36407e0e68800d1ce59d037","src/ext/pkix.rs":"5c97e5fdaf578278fd001e41ed27be557dc31f1ea0aa909a0d655919c09b974f","src/ext/pkix/access.rs":"ff64cb248ff3932b74ebf7eab2b69fa51b7ca238e68f85a15c59155ccb983e7e","src/ext/pkix/authkeyid.rs":"cd12ce35614d27768856a3899ee905ea4141d335606f5d7ab42e22853751a4bc","src/ext/pkix/certpolicy.rs":"2be7db88e52a448a33818d9383b6d7ef07eb5d52c98316fcb0ac9fb1b9773948","src/ext/pkix/constraints.rs":"68fe4071e21306b6c74c6ee28c61dec946bbc681766b2d33be22891a49c95e44","src/ext/pkix/constraints/basic.rs":"9dd80d33f24f4d9ca6d2bc6077a2b90b15edc639a76abada509d0e098a8b3493","src/ext/pkix/constraints/name.rs":"6f6852652507c8a742c6e0d4289ed32e67c795b9e183a27a85b90b0d51825a98","src/ext/pkix/constraints/policy.rs":"2d9fcebc0cac3d26404e9a675e015dc926938eda81bd87e8c34163a245109541","src/ext/pkix/crl.rs":"7d02db6ddda693722270ead960029a0a7ad4156bf905a01d50104114413cbf59","src/ext/pkix/crl/dp.rs":"239f8de74b6ce65595ff2c547e80112b534d3dc20d66d1de72fc9a620cf40d3b","src/ext/pkix/keyusage.rs":"8f717b7f1520d554acf75674b69575bf7665b193cb6253090af941f0a953684d","src/ext/pkix/name.rs":"945dc3a845b8eeae8f2340c786344c780d80493b7b263a1a78592f61493e5d47","src/ext/pkix/name/dirstr.rs":"9d3a9d2f771e3c2d96653a0976471f029b17c936415ce1057f937a79b2e3e4eb","src/ext/pkix/name/dp.rs":"c3e84d12459b490a8a6ea27716909cbe5429de0902b24f63f69cc93e45d40939","src/ext/pkix/name/ediparty.rs":"8d7dff42927ac368b859c70a4755e9661da620dbe5374540073955dc9f00164c","src/ext/pkix/name/general.rs":"16dafa78b1cbb2aef5988aea86441243b58775a75e6f371b5d41eaf0f7218eb5","src/ext/pkix/name/other.rs":"194184079c7f7829b578736fdcdf3c6329286fb0ba261fc366b814c05d8bd0aa","src/ext/pkix/policymap.rs":"c3b2298900fce5228c8ab06cca06577caa676686839ddea9a9bc0ab223a6aa4f","src/lib.rs":"2ad71e3cdc9460898d16a824227e19d83cf60d69e563bc7f9f58fb47aecacadf","src/macros.rs":"3104401b4acb01238ee2bd6c3575b49504d1b03e89f12b4c8e7b577af6cff60b","src/name.rs":"c0428f5e6086cae97dae5a89e701cde44846292f756fe9d272c1313177700100","src/request.rs":"133ee2462510669b7d0610a80d76f688d55cc49a1e7d9bc798e0ec7d35c569b8","src/serial_number.rs":"dc1e94157364394ca97549fbff0cc35d11892c99ccc681383f77492cb6b6c840","src/time.rs":"655ccced65bd97279f2a8b5bece32f282c3189f808770fe75a76e9ece1bfaeb0","tests/builder.rs":"367ffa3c941a4c8e2b830a40978dc796463e503dea62d05708d0bf6873fc33df","tests/certificate.rs":"c752993d956cfebd74a7b5d8ba5e04626cd6983b7bf10c1688abd32af9fb63eb","tests/certreq.rs":"ef3dcaef71ed0cd0f391e820627c5c622df2bc75f3a636a6ff1a9a5d71478962","tests/crl.rs":"9620abb796c47c6931146b66d7840803375afb9ef2969b3007c1c3054c39d1c2","tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der":"d6c5bdce158bad5f5107441cb2bbe42adfa7bee7c6ccf369b68c993315be04b8","tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.pem":"b152f44a300694af28b3dd7416d3bc1ffce028dab5e5633b3623548b10f63a76","tests/examples/085B1E2F40254F9C7A2387BE9FF4EC116C326E10.fake.der":"321f8f032322e8933279bcff4a5e86780eb58286edd68d99d1f91394450dd760","tests/examples/0954e2343dd5efe0a7f0967d69caf33e5f893720.der":"0b57e9180fc8f1b466a2421069d232cf45596106f83e6fd19621caea183f1cf6","tests/examples/0fcc78fbbca9f32b08b19b032b84f2c86a128f35.der":"6061f773354cd2ed5613a094ab0e8270d5c2479932b42dfda727db83febd18b8","tests/examples/15b05c4865410c6b3ff76a4e8f3d87276756bd0c.der":"f74da4d9a687c5046499aefc9fa867de91a1a3941a09f24cf94603b7ab78108a","tests/examples/16ee54e48c76eaa1052e09010d8faefee95e5ebb.der":"7e32368e24a2cc48d3d29e883b260e40ceda22af97189c78fc5b928484e9a010","tests/examples/2049a5b28f104b2c6e1a08546f9cfc0353d6fd30.der":"ec0cbf1b122d440981788e57ef55fc7e0ca556126b476f865a1418e1273f5993","tests/examples/21723e7a0fb61a0bd4a29879b82a02b2fb4ad096.der":"6c03a6b5b01df504e5af7886e6bceb77e14d09f07f42e397952783b9cea38c6a","tests/examples/284A0A3A9B56DD752DAA2E09E2FADEDB858D9338.fake.der":"a7358a8665442cfc8d96d1525954b3376d8222c0c0c34189f73f8b2b097ecb4f","tests/examples/28879DABB0FD11618FB74E47BE049D2933866D53.fake.der":"d60ff530d5cf57b8338ef30c8396414f0736e74ead47a0d49c8b28eafa05158f","tests/examples/288C8BCFEE6B89D110DAE2C9873897BF7FF53382.fake.der":"40317ddec0b0c91f14043a8263a74c8548de13d30b4afd6730228a1cb0ae1572","tests/examples/28903a635b5280fae6774c0b6da7d6baa64af2e8.der":"88497f01602f3154246ae28c4d5aef10f1d87ebb76626f4ae0b7f95ba7968799","tests/examples/33D8388EDA1E92475EF19075D2EF4093D1CB6F7F.fake.der":"6fac22b428f1b8d4cf83f203e2e6d1a0c98bb5741cae9982267f75f589158c0a","tests/examples/342cd9d3062da48c346965297f081ebc2ef68fdc.der":"5e3571f33f45a7df1537a68b5ffb9e036af9d2f5bc4c9717130dc43d7175aac7","tests/examples/554D5FF11DA613A155584D8D4AA07F67724D8077.fake.der":"4ec4474a86383ab4a0979ad9bb453a8608c1eb3379aba82ca856f527dfcd25b1","tests/examples/GoodCACRL.crl":"d78e5eca421f082f55bf1c25ddf697111be3eeee0d395e339f1b97711ee2b496","tests/examples/GoodCACert.crt":"86d218374763fce77d5b2b45398db48f10e553da1875be7d6103085baca0343f","tests/examples/amazon.der":"5bf3d7e0e6927f773d5106c822c53f6f52c199f7eb1b3b8154b41f2924391c75","tests/examples/amazon.pem":"3b2d6d64e99ec971a1d4455cd6743c8f43e1829ef1f7764199242414960697fd","tests/examples/crates.io-chain.pem":"7bb36476e05b7f5431893bd27373cd17d616a5925aab75e116bd92849238912b","tests/examples/eca.der":"343ff530f246b00c71616a5d42541d551114baf74b7f786c7b42527586c6b22a","tests/examples/eca_policies.ta":"18f040c9e6cffbc36f6e3ff398b6f8797dfbd82717f2c88020be260c0d398ce0","tests/examples/entrust.der":"32e407c73121bf961287e9ccc7110a54f5c90e1e3ccf9f10478b36813fb54ae9","tests/examples/entrust_dnConstraint.ta":"c8bce2bf5424794450ce6a6137590beb1409bd732eaec29370986bc22e82e59b","tests/examples/exostar.der":"b63d71c64784857fc0677f634e7bc9bd0b2b1963f3272317a0406f8746cb9477","tests/examples/exostar_policyFlags.ta":"8927c86016bf1db45421bc497333f2306417b82b852f122582a3820a47084a1d","tests/examples/p256-priv.der":"8125ab208d2181ed3ef05ff0ab1906e5898c36a858277e5b987e78e505288769","tests/examples/p256-pub.der":"b9968d56ed8d6aa3fb43b15fa01e355d7a3a0203b1408b3fd2733637c4d1642c","tests/examples/qualcomm.pem":"4ec6058239c3589ab450c6cae9a4415cff429dfdc9490c35d9f022d03d1a6a82","tests/examples/raytheon.der":"d85ae3f67b0acf316829a02cec624b50f76732ca5c503fce4f53b64a168aa94c","tests/examples/raytheon_pathLenConstraint.ta":"08c8480329fb3fb9e73540c0d7e288b12025ddc7a4bd17ffe8085c33006034ea","tests/examples/rsa2048-crt.der":"283b2e3824ea47fb1556cccb1898eadcecf1adadfcf0782ba41ad7122a213568","tests/examples/rsa2048-crt.pem":"e443351100f1b9acd798f878d5e6266f40265179e7b47933f0e250b75069fdd8","tests/examples/rsa2048-csr.der":"f22da04d95947d3c42a4d1619af70097cd38d0156af5ad31f53c044776c4e909","tests/examples/rsa2048-csr.pem":"c58ca6cd37b4f2f7beb6eb184a26e6819ae650f03abeaf6efa50fa55e54e0b43","tests/examples/rsa2048-priv.der":"f94b60300e4877e863b2bea8d5c366a90432794454c05e0ec098ddbf96263614","tests/examples/rsa2048-prv.der":"2ce481dc184e82f43ff3b5fe2b8cdd2a9113c76f35e2c34e070c6706f73ad09d","tests/examples/rsa2048-prv.pem":"22a248487fb9602d223844cba1993ebf53e701287675e9446c95d38867604b17","tests/examples/rsa2048-pub.der":"efeda9bfead9fd0594f6a5cf6fdf6c163116a3b1fad6d73cea05295b68fd1794","tests/examples/tscpbcasha256.crl":"f7759eefacb39ae86931780a6aafad162b5cd57209d1cf283876296dfb5f06e7","tests/general_name.rs":"fee62078996ccb4440133de1909dfc35519f9d9e4aca3c2262c120bbc44d7bce","tests/name.rs":"ced4a3a0991f3523ffbb67b1c495378b19254a547160ed3b80111ac2f700dd94","tests/pkix_extensions.rs":"d0bd2d522bd9a71647f6d3469882a9e1a7bd95da6f826eb880adfaafb43c2b86","tests/trust_anchor_format.rs":"cd6d88262debb8690efd7e2b213442de5ac02cd408ca1125fcd7607577b90647","tests/validity.rs":"687e1c549a250ab6384578e0d31637c932aaf1d6f990c1d5ff3e2163d50ef97e"},"package":"25eefca1d99701da3a57feb07e5079fc62abba059fc139e98c13bbb250f3ef29"}
\ No newline at end of file
diff --git a/crates/x509-cert/Android.bp b/crates/x509-cert/Android.bp
new file mode 100644
index 0000000..a037765
--- /dev/null
+++ b/crates/x509-cert/Android.bp
@@ -0,0 +1,71 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_x509-cert_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_x509-cert_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-Apache-2.0"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libx509_cert",
+ host_supported: true,
+ crate_name: "x509_cert",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.4",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ rustlibs: [
+ "libconst_oid",
+ "libder",
+ "libspki",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.virt",
+ ],
+ product_available: true,
+ vendor_available: true,
+ visibility: [
+ "//packages/modules/Virtualization:__subpackages__",
+ "//system/keymint:__subpackages__",
+ ],
+
+}
+
+rust_library_rlib {
+ name: "libx509_cert_nostd",
+ crate_name: "x509_cert",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.2.4",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ rustlibs: [
+ "libconst_oid_nostd",
+ "libder_nostd",
+ "libspki_nostd",
+ ],
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.virt",
+ ],
+ prefer_rlib: true,
+ no_stdlibs: true,
+ stdlibs: [
+ "libcompiler_builtins.rust_sysroot",
+ "libcore.rust_sysroot",
+ ],
+ product_available: true,
+ vendor_available: true,
+ visibility: [
+ "//packages/modules/Virtualization:__subpackages__",
+ "//system/keymint:__subpackages__",
+ ],
+
+}
diff --git a/crates/x509-cert/CHANGELOG.md b/crates/x509-cert/CHANGELOG.md
new file mode 100644
index 0000000..9922da4
--- /dev/null
+++ b/crates/x509-cert/CHANGELOG.md
@@ -0,0 +1,149 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.2.4 (2023-07-25)
+
+### Added
+- `add_attribute` to `RequestBuilder` ([#1137])
+
+### Changed
+- bump `serde_json` from 1.0.97 to 1.0.99 ([#1122])
+- use the shortest name when looking attr OID ([#1130])
+- bump `serde_json` from 1.0.100 to 1.0.103 ([#1158])
+
+### Fixed
+- RDN string representation ([#1126])
+- `Arbitrary` for certificates ([#1150])
+
+[#1122]: https://github.com/RustCrypto/formats/pull/1122
+[#1126]: https://github.com/RustCrypto/formats/pull/1126
+[#1130]: https://github.com/RustCrypto/formats/pull/1130
+[#1137]: https://github.com/RustCrypto/formats/pull/1137
+[#1150]: https://github.com/RustCrypto/formats/pull/1150
+[#1158]: https://github.com/RustCrypto/formats/pull/1158
+
+## 0.2.3 (2023-05-30)
+
+### Added
+- Added `TryFrom` for `RelativeDistinguishedName` ([#1092])
+- Load a chain of certificates from a slice ([#1081])
+
+[#1092]: https://github.com/RustCrypto/formats/pull/1092
+[#1081]: https://github.com/RustCrypto/formats/pull/1081
+
+## 0.2.2 (2023-05-19)
+
+### Added
+- Certificate builder ([#764])
+- Support for `RandomizedSigner` in builder ([#1007])
+- Provide parsing profiles ([#987])
+- Support for `Time::INFINITY` ([#1024])
+- Conversion from `std::net::IpAddr` ([#1035])
+- `CertReq` builder ([#1034])
+- missing extension implementations ([#1050])
+- notes about `UTCTime` range being 1970-2049 ([#1052])
+- consume the `SignatureBitStringEncoding` trait ([#1048])
+
+### Changed
+- use `ErrorKind::Value` for overlength serial ([#988])
+- Bump `hex-literal` to v0.4.1 ([#999])
+- Builder updates ([#1001])
+- better debug info when `zlint` isn't installed ([#1018])
+- make SKI optional in leaf certificate ([#1028])
+- bump rsa from 0.9.0-pre.2 to 0.9.0 ([#1033])
+- bump rsa from 0.9.1 to 0.9.2 ([#1056])
+
+### Fixed
+- fix `KeyUsage` bit tests ([#993])
+- extraneous PhantomData in `TbsCertificate` ([#1017])
+- CI flakiness ([#1042])
+- usage of ecdsa signer ([#1043])
+
+[#764]: https://github.com/RustCrypto/formats/pull/764
+[#987]: https://github.com/RustCrypto/formats/pull/987
+[#988]: https://github.com/RustCrypto/formats/pull/988
+[#993]: https://github.com/RustCrypto/formats/pull/993
+[#999]: https://github.com/RustCrypto/formats/pull/999
+[#1001]: https://github.com/RustCrypto/formats/pull/1001
+[#1007]: https://github.com/RustCrypto/formats/pull/1007
+[#1017]: https://github.com/RustCrypto/formats/pull/1017
+[#1018]: https://github.com/RustCrypto/formats/pull/1018
+[#1024]: https://github.com/RustCrypto/formats/pull/1024
+[#1028]: https://github.com/RustCrypto/formats/pull/1028
+[#1033]: https://github.com/RustCrypto/formats/pull/1033
+[#1034]: https://github.com/RustCrypto/formats/pull/1034
+[#1035]: https://github.com/RustCrypto/formats/pull/1035
+[#1042]: https://github.com/RustCrypto/formats/pull/1042
+[#1043]: https://github.com/RustCrypto/formats/pull/1043
+[#1048]: https://github.com/RustCrypto/formats/pull/1048
+[#1050]: https://github.com/RustCrypto/formats/pull/1050
+[#1052]: https://github.com/RustCrypto/formats/pull/1052
+[#1056]: https://github.com/RustCrypto/formats/pull/1056
+
+## 0.2.1 (2023-03-26)
+### Added
+- `FromStr` impls for `RdnSequence` (`Name`), `RelativeDistinguishedName`, and
+ `AttributeTypeAndValue` ([#949])
+
+### Changed
+- Deprecate `encode_from_string` functions ([#951])
+
+[#949]: https://github.com/RustCrypto/formats/pull/949
+[#951]: https://github.com/RustCrypto/formats/pull/951
+
+## 0.2.0 (2023-03-18)
+### Added
+- Feature-gated `Arbitrary` impl for `Certificate` ([#761])
+- Allow request to be serialized to PEM ([#819])
+- `Display` impl for `SerialNumber` ([#820])
+- `std` feature implies `const-oid/std` ([#874])
+
+### Changed
+- Serial numbers are formatted as `PrintableString` ([#794])
+- `SerialNumber` is now a specialized object ([#795])
+- MSRV 1.65 ([#805])
+- Make types owned instead of reference-based ([#806], [#841])
+- Bump `der` to v0.7 ([#899])
+- Bump `spki` to v0.7 ([#900])
+
+### Fixed
+- Handling of negative serial numbers ([#823], [#831])
+
+### Removed
+- `alloc` feature: now unconditionally required ([#841])
+
+[#761]: https://github.com/RustCrypto/formats/pull/761
+[#794]: https://github.com/RustCrypto/formats/pull/794
+[#795]: https://github.com/RustCrypto/formats/pull/795
+[#805]: https://github.com/RustCrypto/formats/pull/805
+[#806]: https://github.com/RustCrypto/formats/pull/806
+[#819]: https://github.com/RustCrypto/formats/pull/819
+[#820]: https://github.com/RustCrypto/formats/pull/820
+[#823]: https://github.com/RustCrypto/formats/pull/823
+[#831]: https://github.com/RustCrypto/formats/pull/831
+[#841]: https://github.com/RustCrypto/formats/pull/841
+[#874]: https://github.com/RustCrypto/formats/pull/874
+[#899]: https://github.com/RustCrypto/formats/pull/899
+[#900]: https://github.com/RustCrypto/formats/pull/900
+
+## 0.1.1 (2022-12-10)
+### Added
+- Support `TeletexString` in `DirectoryString` ([#692])
+- Re-export `spki` ([#701])
+- `PemLabel` impl for `Certificate` ([#763])
+- `ValueOrd` impl for `Version` and other derived types ([#723])
+
+### Fixed
+- `countryName` should always be `PrintableString` ([#760])
+
+[#692]: https://github.com/RustCrypto/formats/pull/692
+[#701]: https://github.com/RustCrypto/formats/pull/701
+[#723]: https://github.com/RustCrypto/formats/pull/723
+[#760]: https://github.com/RustCrypto/formats/pull/760
+[#763]: https://github.com/RustCrypto/formats/pull/763
+
+## 0.1.0 (2022-07-23)
+- Initial release
diff --git a/crates/x509-cert/Cargo.toml b/crates/x509-cert/Cargo.toml
new file mode 100644
index 0000000..793721f
--- /dev/null
+++ b/crates/x509-cert/Cargo.toml
@@ -0,0 +1,126 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.65"
+name = "x509-cert"
+version = "0.2.4"
+authors = ["RustCrypto Developers"]
+description = """
+Pure Rust implementation of the X.509 Public Key Infrastructure Certificate
+format as described in RFC 5280
+"""
+readme = "README.md"
+keywords = ["crypto"]
+categories = [
+ "cryptography",
+ "data-structures",
+ "encoding",
+ "no-std",
+]
+license = "Apache-2.0 OR MIT"
+repository = "https://github.com/RustCrypto/formats/tree/master/x509-cert"
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = [
+ "--cfg",
+ "docsrs",
+]
+
+[dependencies.arbitrary]
+version = "1.3"
+features = ["derive"]
+optional = true
+
+[dependencies.const-oid]
+version = "0.9.3"
+features = ["db"]
+
+[dependencies.der]
+version = "0.7.6"
+features = [
+ "alloc",
+ "derive",
+ "flagset",
+ "oid",
+]
+
+[dependencies.sha1]
+version = "0.10.0"
+optional = true
+
+[dependencies.signature]
+version = "2.1.0"
+features = ["rand_core"]
+optional = true
+
+[dependencies.spki]
+version = "0.7.2"
+features = ["alloc"]
+
+[dev-dependencies.ecdsa]
+version = "0.16.7"
+features = [
+ "digest",
+ "pem",
+]
+
+[dev-dependencies.hex-literal]
+version = "0.4"
+
+[dev-dependencies.p256]
+version = "0.13.0"
+
+[dev-dependencies.rand]
+version = "0.8.5"
+
+[dev-dependencies.rsa]
+version = "0.9.2"
+features = ["sha2"]
+
+[dev-dependencies.rstest]
+version = "0.17"
+
+[dev-dependencies.sha2]
+version = "0.10"
+features = ["oid"]
+
+[dev-dependencies.tempfile]
+version = "3.5.0"
+
+[features]
+arbitrary = [
+ "dep:arbitrary",
+ "std",
+ "der/arbitrary",
+ "spki/arbitrary",
+]
+builder = [
+ "std",
+ "sha1/default",
+ "signature",
+]
+default = [
+ "pem",
+ "std",
+]
+hazmat = []
+pem = [
+ "der/pem",
+ "spki/pem",
+]
+std = [
+ "const-oid/std",
+ "der/std",
+ "spki/std",
+]
diff --git a/crates/x509-cert/LICENSE b/crates/x509-cert/LICENSE
new file mode 120000
index 0000000..6b579aa
--- /dev/null
+++ b/crates/x509-cert/LICENSE
@@ -0,0 +1 @@
+LICENSE-APACHE
\ No newline at end of file
diff --git a/crates/x509-cert/LICENSE-APACHE b/crates/x509-cert/LICENSE-APACHE
new file mode 100644
index 0000000..78173fa
--- /dev/null
+++ b/crates/x509-cert/LICENSE-APACHE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/crates/x509-cert/LICENSE-MIT b/crates/x509-cert/LICENSE-MIT
new file mode 100644
index 0000000..c869ada
--- /dev/null
+++ b/crates/x509-cert/LICENSE-MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2021 The RustCrypto Project Developers
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/crates/x509-cert/METADATA b/crates/x509-cert/METADATA
new file mode 100644
index 0000000..fb2e5f3
--- /dev/null
+++ b/crates/x509-cert/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/x509-cert
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "x509-cert"
+description: "Pure Rust implementation of the X.509 Public Key Infrastructure Certificate format as described in RFC 5280."
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 12
+ day: 15
+ }
+ homepage: "https://crates.io/crates/x509-cert"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/x509-cert/x509-cert-0.2.4.crate"
+ version: "0.2.4"
+ }
+}
diff --git a/crates/x509-cert/MODULE_LICENSE_APACHE2 b/crates/x509-cert/MODULE_LICENSE_APACHE2
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/x509-cert/MODULE_LICENSE_APACHE2
diff --git a/crates/x509-cert/README.md b/crates/x509-cert/README.md
new file mode 100644
index 0000000..e131c7d
--- /dev/null
+++ b/crates/x509-cert/README.md
@@ -0,0 +1,53 @@
+# [RustCrypto]: X.509 Certificates
+
+[![crate][crate-image]][crate-link]
+[![Docs][docs-image]][docs-link]
+[![Build Status][build-image]][build-link]
+![Apache2/MIT licensed][license-image]
+![Rust Version][rustc-image]
+[![Project Chat][chat-image]][chat-link]
+
+Pure Rust implementation of the X.509 Public Key Infrastructure Certificate
+format as described in [RFC 5280].
+
+[Documentation][docs-link]
+
+## Minimum Supported Rust Version
+
+This crate requires **Rust 1.65** at a minimum.
+
+We may change the MSRV in the future, but it will be accompanied by a minor
+version bump.
+
+## License
+
+Licensed under either of:
+
+- [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+- [MIT license](http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+[//]: # (badges)
+
+[crate-image]: https://buildstats.info/crate/x509-cert
+[crate-link]: https://crates.io/crates/x509-cert
+[docs-image]: https://docs.rs/x509-cert/badge.svg
+[docs-link]: https://docs.rs/x509-cert/
+[build-image]: https://github.com/RustCrypto/formats/actions/workflows/x509-cert.yml/badge.svg
+[build-link]: https://github.com/RustCrypto/formats/actions/workflows/x509-cert.yml
+[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
+[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/300570-formats
+
+[//]: # (links)
+
+[RustCrypto]: https://github.com/rustcrypto
+[RFC 5280]: https://datatracker.ietf.org/doc/html/rfc5280
diff --git a/crates/x509-cert/cargo2android_viz.bp b/crates/x509-cert/cargo2android_viz.bp
new file mode 100644
index 0000000..8ce03b7
--- /dev/null
+++ b/crates/x509-cert/cargo2android_viz.bp
@@ -0,0 +1,4 @@
+visibility: [
+ "//packages/modules/Virtualization:__subpackages__",
+ "//system/keymint:__subpackages__",
+]
diff --git a/crates/x509-cert/cargo_embargo.json b/crates/x509-cert/cargo_embargo.json
new file mode 100644
index 0000000..a36fc1f
--- /dev/null
+++ b/crates/x509-cert/cargo_embargo.json
@@ -0,0 +1,34 @@
+{
+ "apex_available": [
+ "//apex_available:platform",
+ "com.android.virt"
+ ],
+ "features": [],
+ "run_cargo": false,
+ "variants": [
+ {
+ "package": {
+ "x509-cert": {
+ "add_module_block": "cargo2android_viz.bp"
+ }
+ }
+ },
+ {
+ "module_name_overrides": {
+ "libconst_oid": "libconst_oid_nostd",
+ "libder": "libder_nostd",
+ "libflagset": "libflagset_nostd",
+ "libspki": "libspki_nostd",
+ "libx509_cert": "libx509_cert_nostd"
+ },
+ "package": {
+ "x509-cert": {
+ "add_module_block": "cargo2android_viz.bp",
+ "force_rlib": true,
+ "host_supported": false,
+ "no_std": true
+ }
+ }
+ }
+ ]
+}
diff --git a/crates/x509-cert/patches/std.diff b/crates/x509-cert/patches/std.diff
new file mode 100644
index 0000000..6933bc7
--- /dev/null
+++ b/crates/x509-cert/patches/std.diff
@@ -0,0 +1,15 @@
+diff --git a/src/lib.rs b/src/lib.rs
+index 49d888c..651bdc7 100644
+--- a/src/lib.rs
++++ b/src/lib.rs
+@@ -13,6 +13,10 @@
+ unused_qualifications
+ )]
+
++/// Local Android change: Use std to allow building as a dylib.
++#[cfg(android_dylib)]
++extern crate std;
++
+ extern crate alloc;
+
+ #[cfg(feature = "std")]
diff --git a/crates/x509-cert/rules.mk b/crates/x509-cert/rules.mk
new file mode 100644
index 0000000..060b15c
--- /dev/null
+++ b/crates/x509-cert/rules.mk
@@ -0,0 +1,20 @@
+# This file is generated by cargo2rulesmk.py --run --config cargo2rulesmk.json --features .
+# Do not modify this file as changes will be overridden on upgrade.
+
+LOCAL_DIR := $(GET_LOCAL_DIR)
+MODULE := $(LOCAL_DIR)
+MODULE_CRATE_NAME := x509_cert
+MODULE_SRCS := \
+ $(LOCAL_DIR)/src/lib.rs \
+
+MODULE_RUST_EDITION := 2021
+MODULE_RUSTFLAGS += \
+ --cfg 'feature="alloc"' \
+
+MODULE_LIBRARY_DEPS := \
+ external/rust/crates/const-oid \
+ external/rust/crates/der \
+ external/rust/crates/flagset \
+ external/rust/crates/spki \
+
+include make/library.mk
diff --git a/crates/x509-cert/src/anchor.rs b/crates/x509-cert/src/anchor.rs
new file mode 100644
index 0000000..bc3a2fb
--- /dev/null
+++ b/crates/x509-cert/src/anchor.rs
@@ -0,0 +1,135 @@
+//! Trust anchor-related structures as defined in RFC 5914
+
+use crate::ext::pkix::{certpolicy::CertificatePolicies, NameConstraints};
+use crate::{ext::Extensions, name::Name};
+use crate::{Certificate, TbsCertificate};
+
+use alloc::string::String;
+use der::asn1::OctetString;
+use der::flagset::{flags, FlagSet};
+use der::{Choice, Enumerated, Sequence};
+use spki::SubjectPublicKeyInfoOwned;
+
+/// Version identifier for TrustAnchorInfo
+#[derive(Clone, Debug, Default, Copy, PartialEq, Eq, Enumerated)]
+#[asn1(type = "INTEGER")]
+#[repr(u8)]
+pub enum Version {
+ /// Version 1 (default)
+ #[default]
+ V1 = 0,
+}
+
+/// ```text
+/// TrustAnchorInfo ::= SEQUENCE {
+/// version TrustAnchorInfoVersion DEFAULT v1,
+/// pubKey SubjectPublicKeyInfo,
+/// keyId KeyIdentifier,
+/// taTitle TrustAnchorTitle OPTIONAL,
+/// certPath CertPathControls OPTIONAL,
+/// exts [1] EXPLICIT Extensions OPTIONAL,
+/// taTitleLangTag [2] UTF8String OPTIONAL
+/// }
+///
+/// TrustAnchorInfoVersion ::= INTEGER { v1(1) }
+///
+/// TrustAnchorTitle ::= UTF8String (SIZE (1..64))
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Sequence)]
+#[allow(missing_docs)]
+pub struct TrustAnchorInfo {
+ #[asn1(default = "Default::default")]
+ pub version: Version,
+
+ pub pub_key: SubjectPublicKeyInfoOwned,
+
+ pub key_id: OctetString,
+
+ #[asn1(optional = "true")]
+ pub ta_title: Option<String>,
+
+ #[asn1(optional = "true")]
+ pub cert_path: Option<CertPathControls>,
+
+ #[asn1(context_specific = "1", tag_mode = "EXPLICIT", optional = "true")]
+ pub extensions: Option<Extensions>,
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT", optional = "true")]
+ pub ta_title_lang_tag: Option<String>,
+}
+
+/// ```text
+/// CertPathControls ::= SEQUENCE {
+/// taName Name,
+/// certificate [0] Certificate OPTIONAL,
+/// policySet [1] CertificatePolicies OPTIONAL,
+/// policyFlags [2] CertPolicyFlags OPTIONAL,
+/// nameConstr [3] NameConstraints OPTIONAL,
+/// pathLenConstraint [4] INTEGER (0..MAX) OPTIONAL
+/// }
+/// ```
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct CertPathControls {
+ pub ta_name: Name,
+
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT", optional = "true")]
+ pub certificate: Option<Certificate>,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub policy_set: Option<CertificatePolicies>,
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT", optional = "true")]
+ pub policy_flags: Option<CertPolicyFlags>,
+
+ #[asn1(context_specific = "3", tag_mode = "IMPLICIT", optional = "true")]
+ pub name_constr: Option<NameConstraints>,
+
+ #[asn1(context_specific = "4", tag_mode = "IMPLICIT", optional = "true")]
+ pub path_len_constraint: Option<u32>,
+}
+
+flags! {
+ /// Certificate policies as defined in [RFC 5280 Section 4.2.1.13].
+ ///
+ /// ```text
+ /// CertPolicyFlags ::= BIT STRING {
+ /// inhibitPolicyMapping (0),
+ /// requireExplicitPolicy (1),
+ /// inhibitAnyPolicy (2)
+ /// }
+ /// ```
+ ///
+ /// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+ #[allow(missing_docs)]
+ pub enum CertPolicies: u8 {
+ InhibitPolicyMapping = 1 << 0,
+ RequireExplicitPolicy = 1 << 1,
+ InhibitAnyPolicy = 1 << 2,
+ }
+}
+
+/// Certificate policy flags as defined in [RFC 5280 Section 4.2.1.13].
+///
+/// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+pub type CertPolicyFlags = FlagSet<CertPolicies>;
+
+/// ```text
+/// TrustAnchorChoice ::= CHOICE {
+/// certificate Certificate,
+/// tbsCert [1] EXPLICIT TBSCertificate,
+/// taInfo [2] EXPLICIT TrustAnchorInfo
+/// }
+/// ```
+#[derive(Clone, Debug, PartialEq, Eq, Choice)]
+#[allow(clippy::large_enum_variant)]
+#[allow(missing_docs)]
+pub enum TrustAnchorChoice {
+ Certificate(Certificate),
+
+ #[asn1(context_specific = "1", tag_mode = "EXPLICIT", constructed = "true")]
+ TbsCertificate(TbsCertificate),
+
+ #[asn1(context_specific = "2", tag_mode = "EXPLICIT", constructed = "true")]
+ TaInfo(TrustAnchorInfo),
+}
diff --git a/crates/x509-cert/src/attr.rs b/crates/x509-cert/src/attr.rs
new file mode 100644
index 0000000..d4cccc3
--- /dev/null
+++ b/crates/x509-cert/src/attr.rs
@@ -0,0 +1,310 @@
+//! Attribute-related definitions as defined in X.501 (and updated by RFC 5280).
+
+use alloc::vec::Vec;
+use const_oid::db::{
+ rfc4519::{COUNTRY_NAME, DOMAIN_COMPONENT, SERIAL_NUMBER},
+ Database, DB,
+};
+use core::{
+ fmt::{self, Write},
+ str::FromStr,
+};
+use der::{
+ asn1::{
+ Any, Ia5StringRef, ObjectIdentifier, PrintableStringRef, SetOfVec, TeletexStringRef,
+ Utf8StringRef,
+ },
+ Decode, Encode, Error, ErrorKind, Sequence, Tag, Tagged, ValueOrd,
+};
+
+/// X.501 `AttributeType` as defined in [RFC 5280 Appendix A.1].
+///
+/// ```text
+/// AttributeType ::= OBJECT IDENTIFIER
+/// ```
+///
+/// [RFC 5280 Appendix A.1]: https://datatracker.ietf.org/doc/html/rfc5280#appendix-A.1
+pub type AttributeType = ObjectIdentifier;
+
+/// X.501 `AttributeValue` as defined in [RFC 5280 Appendix A.1].
+///
+/// ```text
+/// AttributeValue ::= ANY
+/// ```
+///
+/// [RFC 5280 Appendix A.1]: https://datatracker.ietf.org/doc/html/rfc5280#appendix-A.1
+pub type AttributeValue = Any;
+
+/// X.501 `Attribute` as defined in [RFC 5280 Appendix A.1].
+///
+/// ```text
+/// Attribute ::= SEQUENCE {
+/// type AttributeType,
+/// values SET OF AttributeValue -- at least one value is required
+/// }
+/// ```
+///
+/// Note that [RFC 2986 Section 4] defines a constrained version of this type:
+///
+/// ```text
+/// Attribute { ATTRIBUTE:IOSet } ::= SEQUENCE {
+/// type ATTRIBUTE.&id({IOSet}),
+/// values SET SIZE(1..MAX) OF ATTRIBUTE.&Type({IOSet}{@type})
+/// }
+/// ```
+///
+/// The unconstrained version should be preferred.
+///
+/// [RFC 2986 Section 4]: https://datatracker.ietf.org/doc/html/rfc2986#section-4
+/// [RFC 5280 Appendix A.1]: https://datatracker.ietf.org/doc/html/rfc5280#appendix-A.1
+#[derive(Clone, Debug, PartialEq, Eq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct Attribute {
+ pub oid: AttributeType,
+ pub values: SetOfVec<AttributeValue>,
+}
+
+/// X.501 `Attributes` as defined in [RFC 2986 Section 4].
+///
+/// ```text
+/// Attributes { ATTRIBUTE:IOSet } ::= SET OF Attribute{{ IOSet }}
+/// ```
+///
+/// [RFC 2986 Section 4]: https://datatracker.ietf.org/doc/html/rfc2986#section-4
+pub type Attributes = SetOfVec<Attribute>;
+
+/// X.501 `AttributeTypeAndValue` as defined in [RFC 5280 Appendix A.1].
+///
+/// ```text
+/// AttributeTypeAndValue ::= SEQUENCE {
+/// type AttributeType,
+/// value AttributeValue
+/// }
+/// ```
+///
+/// [RFC 5280 Appendix A.1]: https://datatracker.ietf.org/doc/html/rfc5280#appendix-A.1
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Eq, PartialEq, PartialOrd, Ord, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct AttributeTypeAndValue {
+ pub oid: AttributeType,
+ pub value: AttributeValue,
+}
+
+#[derive(Copy, Clone)]
+enum Escape {
+ None,
+ Some,
+ Hex(u8),
+}
+
+struct Parser {
+ state: Escape,
+ bytes: Vec<u8>,
+}
+
+impl Parser {
+ pub fn new() -> Self {
+ Self {
+ state: Escape::None,
+ bytes: Vec::new(),
+ }
+ }
+
+ fn push(&mut self, c: u8) {
+ self.state = Escape::None;
+ self.bytes.push(c);
+ }
+
+ pub fn add(&mut self, c: u8) -> Result<(), Error> {
+ match (self.state, c) {
+ (Escape::Hex(p), b'0'..=b'9') => self.push(p | (c - b'0')),
+ (Escape::Hex(p), b'a'..=b'f') => self.push(p | (c - b'a' + 10)),
+ (Escape::Hex(p), b'A'..=b'F') => self.push(p | (c - b'A' + 10)),
+
+ (Escape::Some, b'0'..=b'9') => self.state = Escape::Hex((c - b'0') << 4),
+ (Escape::Some, b'a'..=b'f') => self.state = Escape::Hex((c - b'a' + 10) << 4),
+ (Escape::Some, b'A'..=b'F') => self.state = Escape::Hex((c - b'A' + 10) << 4),
+
+ (Escape::Some, b' ' | b'"' | b'#' | b'=' | b'\\') => self.push(c),
+ (Escape::Some, b'+' | b',' | b';' | b'<' | b'>') => self.push(c),
+
+ (Escape::None, b'\\') => self.state = Escape::Some,
+ (Escape::None, ..) => self.push(c),
+
+ _ => return Err(ErrorKind::Failed.into()),
+ }
+
+ Ok(())
+ }
+
+ pub fn as_bytes(&self) -> &[u8] {
+ &self.bytes
+ }
+}
+
+impl AttributeTypeAndValue {
+ /// Parses the hex value in the `OID=#HEX` format.
+ fn from_hex(oid: ObjectIdentifier, val: &str) -> Result<Self, Error> {
+ // Ensure an even number of hex bytes.
+ let mut iter = match val.len() % 2 {
+ 0 => [].iter().cloned().chain(val.bytes()),
+ 1 => [0u8].iter().cloned().chain(val.bytes()),
+ _ => unreachable!(),
+ };
+
+ // Decode der bytes from hex.
+ let mut bytes = Vec::with_capacity((val.len() + 1) / 2);
+
+ while let (Some(h), Some(l)) = (iter.next(), iter.next()) {
+ let mut byte = 0u8;
+
+ for (half, shift) in [(h, 4), (l, 0)] {
+ match half {
+ b'0'..=b'9' => byte |= (half - b'0') << shift,
+ b'a'..=b'f' => byte |= (half - b'a' + 10) << shift,
+ b'A'..=b'F' => byte |= (half - b'A' + 10) << shift,
+ _ => return Err(ErrorKind::Failed.into()),
+ }
+ }
+
+ bytes.push(byte);
+ }
+
+ Ok(Self {
+ oid,
+ value: Any::from_der(&bytes)?,
+ })
+ }
+
+ /// Parses the string value in the `NAME=STRING` format.
+ fn from_delimited_str(oid: ObjectIdentifier, val: &str) -> Result<Self, Error> {
+ // Undo escaping.
+ let mut parser = Parser::new();
+ for c in val.bytes() {
+ parser.add(c)?;
+ }
+
+ let tag = match oid {
+ COUNTRY_NAME => Tag::PrintableString,
+ DOMAIN_COMPONENT => Tag::Ia5String,
+ // Serial numbers are formatted as Printable String as per RFC 5280 Appendix A.1:
+ // https://datatracker.ietf.org/doc/html/rfc5280#appendix-A.1
+ SERIAL_NUMBER => Tag::PrintableString,
+ _ => Tag::Utf8String,
+ };
+
+ Ok(Self {
+ oid,
+ value: Any::new(tag, parser.as_bytes())?,
+ })
+ }
+
+ /// Converts an AttributeTypeAndValue string into an encoded AttributeTypeAndValue
+ ///
+ /// This function follows the rules in [RFC 4514].
+ ///
+ /// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+ #[deprecated(
+ since = "0.2.1",
+ note = "use AttributeTypeAndValue::from_str(...)?.to_der()"
+ )]
+ pub fn encode_from_string(s: &str) -> Result<Vec<u8>, Error> {
+ Self::from_str(s)?.to_der()
+ }
+}
+
+/// Parse an [`AttributeTypeAndValue`] string.
+///
+/// This function follows the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl FromStr for AttributeTypeAndValue {
+ type Err = Error;
+
+ fn from_str(s: &str) -> der::Result<Self> {
+ let idx = s.find('=').ok_or_else(|| Error::from(ErrorKind::Failed))?;
+ let (key, val) = s.split_at(idx);
+ let val = &val[1..];
+
+ // Either decode or lookup the OID for the given key.
+ let oid = match DB.by_name(key) {
+ Some(oid) => *oid,
+ None => ObjectIdentifier::new(key)?,
+ };
+
+ // If the value is hex-encoded DER...
+ match val.strip_prefix('#') {
+ Some(val) => Self::from_hex(oid, val),
+ None => Self::from_delimited_str(oid, val),
+ }
+ }
+}
+
+/// Serializes the structure according to the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl fmt::Display for AttributeTypeAndValue {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ let val = match self.value.tag() {
+ Tag::PrintableString => PrintableStringRef::try_from(&self.value)
+ .ok()
+ .map(|s| s.as_str()),
+ Tag::Utf8String => Utf8StringRef::try_from(&self.value)
+ .ok()
+ .map(|s| s.as_str()),
+ Tag::Ia5String => Ia5StringRef::try_from(&self.value).ok().map(|s| s.as_str()),
+ Tag::TeletexString => TeletexStringRef::try_from(&self.value)
+ .ok()
+ .map(|s| s.as_str()),
+ _ => None,
+ };
+
+ if let (Some(key), Some(val)) = (DB.shortest_name_by_oid(&self.oid), val) {
+ write!(f, "{}=", key.to_ascii_uppercase())?;
+
+ let mut iter = val.char_indices().peekable();
+ while let Some((i, c)) = iter.next() {
+ match c {
+ '#' if i == 0 => write!(f, "\\#")?,
+ ' ' if i == 0 || iter.peek().is_none() => write!(f, "\\ ")?,
+ '"' | '+' | ',' | ';' | '<' | '>' | '\\' => write!(f, "\\{}", c)?,
+ '\x00'..='\x1f' | '\x7f' => write!(f, "\\{:02x}", c as u8)?,
+ _ => f.write_char(c)?,
+ }
+ }
+ } else {
+ let value = self.value.to_der().or(Err(fmt::Error))?;
+
+ write!(f, "{}=#", self.oid)?;
+ for c in value {
+ write!(f, "{:02x}", c)?;
+ }
+ }
+
+ Ok(())
+ }
+}
+
+/// Helper trait to bring shortest name by oid lookups to Database
+trait ShortestName {
+ fn shortest_name_by_oid(&self, oid: &ObjectIdentifier) -> Option<&str>;
+}
+
+impl<'a> ShortestName for Database<'a> {
+ fn shortest_name_by_oid(&self, oid: &ObjectIdentifier) -> Option<&'a str> {
+ let mut best_match: Option<&'a str> = None;
+
+ for m in self.find_names_for_oid(*oid) {
+ if let Some(previous) = best_match {
+ if m.len() < previous.len() {
+ best_match = Some(m);
+ }
+ } else {
+ best_match = Some(m);
+ }
+ }
+
+ best_match
+ }
+}
diff --git a/crates/x509-cert/src/builder.rs b/crates/x509-cert/src/builder.rs
new file mode 100644
index 0000000..ec51a7e
--- /dev/null
+++ b/crates/x509-cert/src/builder.rs
@@ -0,0 +1,526 @@
+//! X509 Certificate builder
+
+use alloc::vec;
+use core::fmt;
+use der::{asn1::BitString, referenced::OwnedToRef, Encode};
+use signature::{rand_core::CryptoRngCore, Keypair, RandomizedSigner, Signer};
+use spki::{
+ DynSignatureAlgorithmIdentifier, EncodePublicKey, SignatureBitStringEncoding,
+ SubjectPublicKeyInfoOwned, SubjectPublicKeyInfoRef,
+};
+
+use crate::{
+ certificate::{Certificate, TbsCertificate, Version},
+ ext::{
+ pkix::{
+ AuthorityKeyIdentifier, BasicConstraints, KeyUsage, KeyUsages, SubjectKeyIdentifier,
+ },
+ AsExtension, Extension, Extensions,
+ },
+ name::Name,
+ request::{attributes::AsAttribute, CertReq, CertReqInfo, ExtensionReq},
+ serial_number::SerialNumber,
+ time::Validity,
+};
+
+/// Error type
+#[derive(Debug)]
+#[non_exhaustive]
+pub enum Error {
+ /// ASN.1 DER-related errors.
+ Asn1(der::Error),
+
+ /// Public key errors propagated from the [`spki::Error`] type.
+ PublicKey(spki::Error),
+
+ /// Signing error propagated for the [`signature::Error`] type.
+ Signature(signature::Error),
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for Error {}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Error::Asn1(err) => write!(f, "ASN.1 error: {}", err),
+ Error::PublicKey(err) => write!(f, "public key error: {}", err),
+ Error::Signature(err) => write!(f, "signature error: {}", err),
+ }
+ }
+}
+
+impl From<der::Error> for Error {
+ fn from(err: der::Error) -> Error {
+ Error::Asn1(err)
+ }
+}
+
+impl From<spki::Error> for Error {
+ fn from(err: spki::Error) -> Error {
+ Error::PublicKey(err)
+ }
+}
+
+impl From<signature::Error> for Error {
+ fn from(err: signature::Error) -> Error {
+ Error::Signature(err)
+ }
+}
+
+type Result<T> = core::result::Result<T, Error>;
+
+/// The type of certificate to build
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum Profile {
+ /// Build a root CA certificate
+ Root,
+ /// Build an intermediate sub CA certificate
+ SubCA {
+ /// issuer Name,
+ /// represents the name signing the certificate
+ issuer: Name,
+ /// pathLenConstraint INTEGER (0..MAX) OPTIONAL
+ /// BasicConstraints as defined in [RFC 5280 Section 4.2.1.9].
+ path_len_constraint: Option<u8>,
+ },
+ /// Build an end certificate
+ Leaf {
+ /// issuer Name,
+ /// represents the name signing the certificate
+ issuer: Name,
+ /// should the key agreement flag of KeyUsage be enabled
+ enable_key_agreement: bool,
+ /// should the key encipherment flag of KeyUsage be enabled
+ enable_key_encipherment: bool,
+ /// should the subject key identifier extension be included
+ ///
+ /// From [RFC 5280 Section 4.2.1.2]:
+ /// For end entity certificates, subject key identifiers SHOULD be
+ /// derived from the public key. Two common methods for generating key
+ /// identifiers from the public key are identified above.
+ #[cfg(feature = "hazmat")]
+ include_subject_key_identifier: bool,
+ },
+ #[cfg(feature = "hazmat")]
+ /// Opt-out of the default extensions
+ Manual {
+ /// issuer Name,
+ /// represents the name signing the certificate
+ /// A `None` will make it a self-signed certificate
+ issuer: Option<Name>,
+ },
+}
+
+impl Profile {
+ fn get_issuer(&self, subject: &Name) -> Name {
+ match self {
+ Profile::Root => subject.clone(),
+ Profile::SubCA { issuer, .. } => issuer.clone(),
+ Profile::Leaf { issuer, .. } => issuer.clone(),
+ #[cfg(feature = "hazmat")]
+ Profile::Manual { issuer, .. } => issuer.as_ref().unwrap_or(subject).clone(),
+ }
+ }
+
+ fn build_extensions(
+ &self,
+ spk: SubjectPublicKeyInfoRef<'_>,
+ issuer_spk: SubjectPublicKeyInfoRef<'_>,
+ tbs: &TbsCertificate,
+ ) -> Result<vec::Vec<Extension>> {
+ #[cfg(feature = "hazmat")]
+ // User opted out of default extensions set.
+ if let Profile::Manual { .. } = self {
+ return Ok(vec::Vec::default());
+ }
+
+ let mut extensions: vec::Vec<Extension> = vec::Vec::new();
+
+ match self {
+ #[cfg(feature = "hazmat")]
+ Profile::Leaf {
+ include_subject_key_identifier: false,
+ ..
+ } => {}
+ _ => extensions.push(
+ SubjectKeyIdentifier::try_from(spk)?.to_extension(&tbs.subject, &extensions)?,
+ ),
+ }
+
+ // Build Authority Key Identifier
+ match self {
+ Profile::Root => {}
+ _ => {
+ extensions.push(
+ AuthorityKeyIdentifier::try_from(issuer_spk.clone())?
+ .to_extension(&tbs.subject, &extensions)?,
+ );
+ }
+ }
+
+ // Build Basic Contraints extensions
+ extensions.push(match self {
+ Profile::Root => BasicConstraints {
+ ca: true,
+ path_len_constraint: None,
+ }
+ .to_extension(&tbs.subject, &extensions)?,
+ Profile::SubCA {
+ path_len_constraint,
+ ..
+ } => BasicConstraints {
+ ca: true,
+ path_len_constraint: *path_len_constraint,
+ }
+ .to_extension(&tbs.subject, &extensions)?,
+ Profile::Leaf { .. } => BasicConstraints {
+ ca: false,
+ path_len_constraint: None,
+ }
+ .to_extension(&tbs.subject, &extensions)?,
+ #[cfg(feature = "hazmat")]
+ Profile::Manual { .. } => unreachable!(),
+ });
+
+ // Build Key Usage extension
+ match self {
+ Profile::Root | Profile::SubCA { .. } => {
+ extensions.push(
+ KeyUsage(KeyUsages::KeyCertSign | KeyUsages::CRLSign)
+ .to_extension(&tbs.subject, &extensions)?,
+ );
+ }
+ Profile::Leaf {
+ enable_key_agreement,
+ enable_key_encipherment,
+ ..
+ } => {
+ let mut key_usage = KeyUsages::DigitalSignature | KeyUsages::NonRepudiation;
+ if *enable_key_encipherment {
+ key_usage |= KeyUsages::KeyEncipherment;
+ }
+ if *enable_key_agreement {
+ key_usage |= KeyUsages::KeyAgreement;
+ }
+
+ extensions.push(KeyUsage(key_usage).to_extension(&tbs.subject, &extensions)?);
+ }
+ #[cfg(feature = "hazmat")]
+ Profile::Manual { .. } => unreachable!(),
+ }
+
+ Ok(extensions)
+ }
+}
+
+/// X509 Certificate builder
+///
+/// ```
+/// use der::Decode;
+/// use x509_cert::spki::SubjectPublicKeyInfoOwned;
+/// use x509_cert::builder::{CertificateBuilder, Profile};
+/// use x509_cert::name::Name;
+/// use x509_cert::serial_number::SerialNumber;
+/// use x509_cert::time::Validity;
+/// use std::str::FromStr;
+///
+/// # const RSA_2048_DER: &[u8] = include_bytes!("../tests/examples/rsa2048-pub.der");
+/// # const RSA_2048_PRIV_DER: &[u8] = include_bytes!("../tests/examples/rsa2048-priv.der");
+/// # use rsa::{pkcs1v15::SigningKey, pkcs1::DecodeRsaPrivateKey};
+/// # use sha2::Sha256;
+/// # use std::time::Duration;
+/// # use der::referenced::RefToOwned;
+/// # fn rsa_signer() -> SigningKey<Sha256> {
+/// # let private_key = rsa::RsaPrivateKey::from_pkcs1_der(RSA_2048_PRIV_DER).unwrap();
+/// # let signing_key = SigningKey::<Sha256>::new_with_prefix(private_key);
+/// # signing_key
+/// # }
+///
+/// let serial_number = SerialNumber::from(42u32);
+/// let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+/// let profile = Profile::Root;
+/// let subject = Name::from_str("CN=World domination corporation,O=World domination Inc,C=US").unwrap();
+///
+/// let pub_key = SubjectPublicKeyInfoOwned::try_from(RSA_2048_DER).expect("get rsa pub key");
+///
+/// let mut signer = rsa_signer();
+/// let mut builder = CertificateBuilder::new(
+/// profile,
+/// serial_number,
+/// validity,
+/// subject,
+/// pub_key,
+/// &signer,
+/// )
+/// .expect("Create certificate");
+/// ```
+pub struct CertificateBuilder<'s, S> {
+ tbs: TbsCertificate,
+ extensions: Extensions,
+ cert_signer: &'s S,
+}
+
+impl<'s, S> CertificateBuilder<'s, S>
+where
+ S: Keypair + DynSignatureAlgorithmIdentifier,
+ S::VerifyingKey: EncodePublicKey,
+{
+ /// Creates a new certificate builder
+ pub fn new(
+ profile: Profile,
+ serial_number: SerialNumber,
+ mut validity: Validity,
+ subject: Name,
+ subject_public_key_info: SubjectPublicKeyInfoOwned,
+ cert_signer: &'s S,
+ ) -> Result<Self> {
+ let verifying_key = cert_signer.verifying_key();
+ let signer_pub = verifying_key
+ .to_public_key_der()?
+ .decode_msg::<SubjectPublicKeyInfoOwned>()?;
+
+ let signature_alg = cert_signer.signature_algorithm_identifier()?;
+ let issuer = profile.get_issuer(&subject);
+
+ validity.not_before.rfc5280_adjust_utc_time()?;
+ validity.not_after.rfc5280_adjust_utc_time()?;
+
+ let tbs = TbsCertificate {
+ version: Version::V3,
+ serial_number,
+ signature: signature_alg,
+ issuer,
+ validity,
+ subject,
+ subject_public_key_info,
+ extensions: None,
+
+ // We will not generate unique identifier because as per RFC5280 Section 4.1.2.8:
+ // CAs conforming to this profile MUST NOT generate
+ // certificates with unique identifiers.
+ //
+ // https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.8
+ issuer_unique_id: None,
+ subject_unique_id: None,
+ };
+
+ let extensions = profile.build_extensions(
+ tbs.subject_public_key_info.owned_to_ref(),
+ signer_pub.owned_to_ref(),
+ &tbs,
+ )?;
+ Ok(Self {
+ tbs,
+ extensions,
+ cert_signer,
+ })
+ }
+
+ /// Add an extension to this certificate
+ pub fn add_extension<E: AsExtension>(&mut self, extension: &E) -> Result<()> {
+ let ext = extension.to_extension(&self.tbs.subject, &self.extensions)?;
+ self.extensions.push(ext);
+
+ Ok(())
+ }
+}
+
+/// Builder for X509 Certificate Requests
+///
+/// ```
+/// # use p256::{pkcs8::DecodePrivateKey, NistP256, ecdsa::DerSignature};
+/// # const PKCS8_PRIVATE_KEY_DER: &[u8] = include_bytes!("../tests/examples/p256-priv.der");
+/// # fn ecdsa_signer() -> ecdsa::SigningKey<NistP256> {
+/// # let secret_key = p256::SecretKey::from_pkcs8_der(PKCS8_PRIVATE_KEY_DER).unwrap();
+/// # ecdsa::SigningKey::from(secret_key)
+/// # }
+/// use x509_cert::{
+/// builder::{Builder, RequestBuilder},
+/// ext::pkix::{name::GeneralName, SubjectAltName},
+/// name::Name,
+/// };
+/// use std::str::FromStr;
+///
+/// use std::net::{IpAddr, Ipv4Addr};
+/// let subject = Name::from_str("CN=service.domination.world").unwrap();
+///
+/// let signer = ecdsa_signer();
+/// let mut builder = RequestBuilder::new(subject, &signer).expect("Create certificate request");
+/// builder
+/// .add_extension(&SubjectAltName(vec![GeneralName::from(IpAddr::V4(
+/// Ipv4Addr::new(192, 0, 2, 0),
+/// ))]))
+/// .unwrap();
+///
+/// let cert_req = builder.build::<DerSignature>().unwrap();
+/// ```
+pub struct RequestBuilder<'s, S> {
+ info: CertReqInfo,
+ extension_req: ExtensionReq,
+ req_signer: &'s S,
+}
+
+impl<'s, S> RequestBuilder<'s, S>
+where
+ S: Keypair + DynSignatureAlgorithmIdentifier,
+ S::VerifyingKey: EncodePublicKey,
+{
+ /// Creates a new certificate request builder
+ pub fn new(subject: Name, req_signer: &'s S) -> Result<Self> {
+ let version = Default::default();
+ let verifying_key = req_signer.verifying_key();
+ let public_key = verifying_key
+ .to_public_key_der()?
+ .decode_msg::<SubjectPublicKeyInfoOwned>()?;
+ let attributes = Default::default();
+ let extension_req = Default::default();
+
+ Ok(Self {
+ info: CertReqInfo {
+ version,
+ subject,
+ public_key,
+ attributes,
+ },
+ extension_req,
+ req_signer,
+ })
+ }
+
+ /// Add an extension to this certificate request
+ pub fn add_extension<E: AsExtension>(&mut self, extension: &E) -> Result<()> {
+ let ext = extension.to_extension(&self.info.subject, &self.extension_req.0)?;
+
+ self.extension_req.0.push(ext);
+
+ Ok(())
+ }
+
+ /// Add an attribute to this certificate request
+ pub fn add_attribute<A: AsAttribute>(&mut self, attribute: &A) -> Result<()> {
+ let attr = attribute.to_attribute()?;
+
+ self.info.attributes.insert(attr)?;
+ Ok(())
+ }
+}
+
+/// Trait for X509 builders
+///
+/// This trait defines the interface between builder and the signers.
+pub trait Builder: Sized {
+ /// The builder's object signer
+ type Signer;
+
+ /// Type built by this builder
+ type Output: Sized;
+
+ /// Return a reference to the signer.
+ fn signer(&self) -> &Self::Signer;
+
+ /// Assemble the final object from signature.
+ fn assemble(self, signature: BitString) -> Result<Self::Output>;
+
+ /// Finalize and return a serialization of the object for signature.
+ fn finalize(&mut self) -> der::Result<vec::Vec<u8>>;
+
+ /// Run the object through the signer and build it.
+ fn build<Signature>(mut self) -> Result<Self::Output>
+ where
+ Self::Signer: Signer<Signature>,
+ Signature: SignatureBitStringEncoding,
+ {
+ let blob = self.finalize()?;
+
+ let signature = self.signer().try_sign(&blob)?.to_bitstring()?;
+
+ self.assemble(signature)
+ }
+
+ /// Run the object through the signer and build it.
+ fn build_with_rng<Signature>(mut self, rng: &mut impl CryptoRngCore) -> Result<Self::Output>
+ where
+ Self::Signer: RandomizedSigner<Signature>,
+ Signature: SignatureBitStringEncoding,
+ {
+ let blob = self.finalize()?;
+
+ let signature = self
+ .signer()
+ .try_sign_with_rng(rng, &blob)?
+ .to_bitstring()?;
+
+ self.assemble(signature)
+ }
+}
+
+impl<'s, S> Builder for CertificateBuilder<'s, S>
+where
+ S: Keypair + DynSignatureAlgorithmIdentifier,
+ S::VerifyingKey: EncodePublicKey,
+{
+ type Signer = S;
+ type Output = Certificate;
+
+ fn signer(&self) -> &Self::Signer {
+ self.cert_signer
+ }
+
+ fn finalize(&mut self) -> der::Result<vec::Vec<u8>> {
+ if !self.extensions.is_empty() {
+ self.tbs.extensions = Some(self.extensions.clone());
+ }
+
+ if self.tbs.extensions.is_none() {
+ if self.tbs.issuer_unique_id.is_some() || self.tbs.subject_unique_id.is_some() {
+ self.tbs.version = Version::V2;
+ } else {
+ self.tbs.version = Version::V1;
+ }
+ }
+
+ self.tbs.to_der()
+ }
+
+ fn assemble(self, signature: BitString) -> Result<Self::Output> {
+ let signature_algorithm = self.tbs.signature.clone();
+
+ Ok(Certificate {
+ tbs_certificate: self.tbs,
+ signature_algorithm,
+ signature,
+ })
+ }
+}
+
+impl<'s, S> Builder for RequestBuilder<'s, S>
+where
+ S: Keypair + DynSignatureAlgorithmIdentifier,
+ S::VerifyingKey: EncodePublicKey,
+{
+ type Signer = S;
+ type Output = CertReq;
+
+ fn signer(&self) -> &Self::Signer {
+ self.req_signer
+ }
+
+ fn finalize(&mut self) -> der::Result<vec::Vec<u8>> {
+ self.info
+ .attributes
+ .insert(self.extension_req.clone().try_into()?)?;
+
+ self.info.to_der()
+ }
+
+ fn assemble(self, signature: BitString) -> Result<Self::Output> {
+ let algorithm = self.req_signer.signature_algorithm_identifier()?;
+
+ Ok(CertReq {
+ info: self.info,
+ algorithm,
+ signature,
+ })
+ }
+}
diff --git a/crates/x509-cert/src/certificate.rs b/crates/x509-cert/src/certificate.rs
new file mode 100644
index 0000000..c5a105d
--- /dev/null
+++ b/crates/x509-cert/src/certificate.rs
@@ -0,0 +1,271 @@
+//! Certificate types
+
+use crate::{name::Name, serial_number::SerialNumber, time::Validity};
+use alloc::vec::Vec;
+use const_oid::AssociatedOid;
+use core::{cmp::Ordering, fmt::Debug};
+use der::asn1::BitString;
+use der::{Decode, Enumerated, Error, ErrorKind, Sequence, Tag, ValueOrd};
+use spki::{AlgorithmIdentifierOwned, SubjectPublicKeyInfoOwned};
+
+#[cfg(feature = "pem")]
+use der::{
+ pem::{self, PemLabel},
+ DecodePem,
+};
+
+/// [`Profile`] allows the consumer of this crate to customize the behavior when parsing
+/// certificates.
+/// By default, parsing will be made in a rfc5280-compliant manner.
+pub trait Profile: PartialEq + Debug + Eq + Clone {
+ /// Checks to run when parsing serial numbers
+ fn check_serial_number(serial: &SerialNumber<Self>) -> der::Result<()> {
+ // See the note in `SerialNumber::new`: we permit lengths of 21 bytes here,
+ // since some X.509 implementations interpret the limit of 20 bytes to refer
+ // to the pre-encoded value.
+ if serial.inner.len() > SerialNumber::<Self>::MAX_DECODE_LEN {
+ Err(Tag::Integer.value_error())
+ } else {
+ Ok(())
+ }
+ }
+}
+
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Debug, PartialEq, Eq, Clone)]
+/// Parse certificates with rfc5280-compliant checks
+pub struct Rfc5280;
+
+impl Profile for Rfc5280 {}
+
+#[cfg(feature = "hazmat")]
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Debug, PartialEq, Eq, Clone)]
+/// Parse raw x509 certificate and disable all the checks
+pub struct Raw;
+
+#[cfg(feature = "hazmat")]
+impl Profile for Raw {
+ fn check_serial_number(_serial: &SerialNumber<Self>) -> der::Result<()> {
+ Ok(())
+ }
+}
+
+/// Certificate `Version` as defined in [RFC 5280 Section 4.1].
+///
+/// ```text
+/// Version ::= INTEGER { v1(0), v2(1), v3(2) }
+/// ```
+///
+/// [RFC 5280 Section 4.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Copy, PartialEq, Eq, Enumerated)]
+#[asn1(type = "INTEGER")]
+#[repr(u8)]
+pub enum Version {
+ /// Version 1 (default)
+ V1 = 0,
+
+ /// Version 2
+ V2 = 1,
+
+ /// Version 3
+ V3 = 2,
+}
+
+impl ValueOrd for Version {
+ fn value_cmp(&self, other: &Self) -> der::Result<Ordering> {
+ (*self as u8).value_cmp(&(*other as u8))
+ }
+}
+
+impl Default for Version {
+ fn default() -> Self {
+ Self::V1
+ }
+}
+
+/// X.509 `TbsCertificate` as defined in [RFC 5280 Section 4.1]
+pub type TbsCertificate = TbsCertificateInner<Rfc5280>;
+
+/// X.509 `TbsCertificate` as defined in [RFC 5280 Section 4.1]
+///
+/// ASN.1 structure containing the names of the subject and issuer, a public
+/// key associated with the subject, a validity period, and other associated
+/// information.
+///
+/// ```text
+/// TBSCertificate ::= SEQUENCE {
+/// version [0] EXPLICIT Version DEFAULT v1,
+/// serialNumber CertificateSerialNumber,
+/// signature AlgorithmIdentifier,
+/// issuer Name,
+/// validity Validity,
+/// subject Name,
+/// subjectPublicKeyInfo SubjectPublicKeyInfo,
+/// issuerUniqueID [1] IMPLICIT UniqueIdentifier OPTIONAL,
+/// -- If present, version MUST be v2 or v3
+/// subjectUniqueID [2] IMPLICIT UniqueIdentifier OPTIONAL,
+/// -- If present, version MUST be v2 or v3
+/// extensions [3] Extensions OPTIONAL
+/// -- If present, version MUST be v3 --
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct TbsCertificateInner<P: Profile = Rfc5280> {
+ /// The certificate version
+ ///
+ /// Note that this value defaults to Version 1 per the RFC. However,
+ /// fields such as `issuer_unique_id`, `subject_unique_id` and `extensions`
+ /// require later versions. Care should be taken in order to ensure
+ /// standards compliance.
+ #[asn1(context_specific = "0", default = "Default::default")]
+ pub version: Version,
+
+ pub serial_number: SerialNumber<P>,
+ pub signature: AlgorithmIdentifierOwned,
+ pub issuer: Name,
+ pub validity: Validity,
+ pub subject: Name,
+ pub subject_public_key_info: SubjectPublicKeyInfoOwned,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub issuer_unique_id: Option<BitString>,
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT", optional = "true")]
+ pub subject_unique_id: Option<BitString>,
+
+ #[asn1(context_specific = "3", tag_mode = "EXPLICIT", optional = "true")]
+ pub extensions: Option<crate::ext::Extensions>,
+}
+
+impl<P: Profile> TbsCertificateInner<P> {
+ /// Decodes a single extension
+ ///
+ /// Returns an error if multiple of these extensions is present. Returns
+ /// `Ok(None)` if the extension is not present. Returns a decoding error
+ /// if decoding failed. Otherwise returns the extension.
+ pub fn get<'a, T: Decode<'a> + AssociatedOid>(&'a self) -> Result<Option<(bool, T)>, Error> {
+ let mut iter = self.filter::<T>().peekable();
+ match iter.next() {
+ None => Ok(None),
+ Some(item) => match iter.peek() {
+ Some(..) => Err(ErrorKind::Failed.into()),
+ None => Ok(Some(item?)),
+ },
+ }
+ }
+
+ /// Filters extensions by an associated OID
+ ///
+ /// Returns a filtered iterator over all the extensions with the OID.
+ pub fn filter<'a, T: Decode<'a> + AssociatedOid>(
+ &'a self,
+ ) -> impl 'a + Iterator<Item = Result<(bool, T), Error>> {
+ self.extensions
+ .as_deref()
+ .unwrap_or(&[])
+ .iter()
+ .filter(|e| e.extn_id == T::OID)
+ .map(|e| Ok((e.critical, T::from_der(e.extn_value.as_bytes())?)))
+ }
+}
+
+/// X.509 certificates are defined in [RFC 5280 Section 4.1].
+///
+/// [RFC 5280 Section 4.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1
+pub type Certificate = CertificateInner<Rfc5280>;
+
+/// X.509 certificates are defined in [RFC 5280 Section 4.1].
+///
+/// ```text
+/// Certificate ::= SEQUENCE {
+/// tbsCertificate TBSCertificate,
+/// signatureAlgorithm AlgorithmIdentifier,
+/// signature BIT STRING
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct CertificateInner<P: Profile = Rfc5280> {
+ pub tbs_certificate: TbsCertificateInner<P>,
+ pub signature_algorithm: AlgorithmIdentifierOwned,
+ pub signature: BitString,
+}
+
+#[cfg(feature = "pem")]
+impl<P: Profile> PemLabel for CertificateInner<P> {
+ const PEM_LABEL: &'static str = "CERTIFICATE";
+}
+
+/// `PkiPath` as defined by X.509 and referenced by [RFC 6066].
+///
+/// This contains a series of certificates in validation order from the
+/// top-most certificate to the bottom-most certificate. This means that
+/// the first certificate signs the second certificate and so on.
+///
+/// ```text
+/// PkiPath ::= SEQUENCE OF Certificate
+/// ```
+///
+/// [RFC 6066]: https://datatracker.ietf.org/doc/html/rfc6066#section-10.1
+pub type PkiPath = Vec<Certificate>;
+
+#[cfg(feature = "pem")]
+impl<P: Profile> CertificateInner<P> {
+ /// Parse a chain of pem-encoded certificates from a slice.
+ ///
+ /// Returns the list of certificates.
+ pub fn load_pem_chain(mut input: &[u8]) -> Result<Vec<Self>, Error> {
+ fn find_boundary<T>(haystack: &[T], needle: &[T]) -> Option<usize>
+ where
+ for<'a> &'a [T]: PartialEq,
+ {
+ haystack
+ .windows(needle.len())
+ .position(|window| window == needle)
+ }
+
+ let mut certs = Vec::new();
+ let mut position: usize = 0;
+
+ let end_boundary = &b"-----END CERTIFICATE-----"[..];
+
+ // Strip the trailing whitespaces
+ loop {
+ if input.is_empty() {
+ break;
+ }
+ let last_pos = input.len() - 1;
+
+ match input.get(last_pos) {
+ Some(b'\r') | Some(b'\n') => {
+ input = &input[..last_pos];
+ }
+ _ => break,
+ }
+ }
+
+ while position < input.len() - 1 {
+ let rest = &input[position..];
+ let end_pos = find_boundary(rest, end_boundary)
+ .ok_or(pem::Error::PostEncapsulationBoundary)?
+ + end_boundary.len();
+
+ let cert_buf = &rest[..end_pos];
+ let cert = Self::from_pem(cert_buf)?;
+ certs.push(cert);
+
+ position += end_pos;
+ }
+
+ Ok(certs)
+ }
+}
diff --git a/crates/x509-cert/src/crl.rs b/crates/x509-cert/src/crl.rs
new file mode 100644
index 0000000..6916783
--- /dev/null
+++ b/crates/x509-cert/src/crl.rs
@@ -0,0 +1,87 @@
+//! Certificate Revocation List types
+
+use crate::ext::Extensions;
+use crate::name::Name;
+use crate::serial_number::SerialNumber;
+use crate::time::Time;
+use crate::Version;
+
+use alloc::vec::Vec;
+
+use der::asn1::BitString;
+use der::{Sequence, ValueOrd};
+use spki::AlgorithmIdentifierOwned;
+
+/// `CertificateList` as defined in [RFC 5280 Section 5.1].
+///
+/// ```text
+/// CertificateList ::= SEQUENCE {
+/// tbsCertList TBSCertList,
+/// signatureAlgorithm AlgorithmIdentifier,
+/// signatureValue BIT STRING
+/// }
+/// ```
+///
+/// [RFC 5280 Section 5.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.1
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct CertificateList {
+ pub tbs_cert_list: TbsCertList,
+ pub signature_algorithm: AlgorithmIdentifierOwned,
+ pub signature: BitString,
+}
+
+/// Implicit intermediate structure from the ASN.1 definition of `TBSCertList`.
+///
+/// This type is used for the `revoked_certificates` field of `TbsCertList`.
+/// See [RFC 5280 Section 5.1].
+///
+/// ```text
+/// RevokedCert ::= SEQUENCE {
+/// userCertificate CertificateSerialNumber,
+/// revocationDate Time,
+/// crlEntryExtensions Extensions OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 5.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.1
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct RevokedCert {
+ pub serial_number: SerialNumber,
+ pub revocation_date: Time,
+ pub crl_entry_extensions: Option<Extensions>,
+}
+
+/// `TbsCertList` as defined in [RFC 5280 Section 5.1].
+///
+/// ```text
+/// TBSCertList ::= SEQUENCE {
+/// version Version OPTIONAL, -- if present, MUST be v2
+/// signature AlgorithmIdentifier,
+/// issuer Name,
+/// thisUpdate Time,
+/// nextUpdate Time OPTIONAL,
+/// revokedCertificates SEQUENCE OF SEQUENCE {
+/// userCertificate CertificateSerialNumber,
+/// revocationDate Time,
+/// crlEntryExtensions Extensions OPTIONAL -- if present, version MUST be v2
+/// } OPTIONAL,
+/// crlExtensions [0] EXPLICIT Extensions OPTIONAL -- if present, version MUST be v2
+/// }
+/// ```
+///
+/// [RFC 5280 Section 5.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.1
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct TbsCertList {
+ pub version: Version,
+ pub signature: AlgorithmIdentifierOwned,
+ pub issuer: Name,
+ pub this_update: Time,
+ pub next_update: Option<Time>,
+ pub revoked_certificates: Option<Vec<RevokedCert>>,
+
+ #[asn1(context_specific = "0", tag_mode = "EXPLICIT", optional = "true")]
+ pub crl_extensions: Option<Extensions>,
+}
diff --git a/crates/x509-cert/src/ext.rs b/crates/x509-cert/src/ext.rs
new file mode 100644
index 0000000..aa663c5
--- /dev/null
+++ b/crates/x509-cert/src/ext.rs
@@ -0,0 +1,67 @@
+//! Standardized X.509 Certificate Extensions
+
+use const_oid::AssociatedOid;
+use der::{asn1::OctetString, Sequence, ValueOrd};
+use spki::ObjectIdentifier;
+
+pub mod pkix;
+
+/// Extension as defined in [RFC 5280 Section 4.1.2.9].
+///
+/// The ASN.1 definition for Extension objects is below. The extnValue type
+/// may be further parsed using a decoder corresponding to the extnID value.
+///
+/// ```text
+/// Extension ::= SEQUENCE {
+/// extnID OBJECT IDENTIFIER,
+/// critical BOOLEAN DEFAULT FALSE,
+/// extnValue OCTET STRING
+/// -- contains the DER encoding of an ASN.1 value
+/// -- corresponding to the extension type identified
+/// -- by extnID
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct Extension {
+ pub extn_id: ObjectIdentifier,
+
+ #[asn1(default = "Default::default")]
+ pub critical: bool,
+
+ pub extn_value: OctetString,
+}
+
+/// Extensions as defined in [RFC 5280 Section 4.1.2.9].
+///
+/// ```text
+/// Extensions ::= SEQUENCE SIZE (1..MAX) OF Extension
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.9
+pub type Extensions = alloc::vec::Vec<Extension>;
+
+/// Trait to be implemented by extensions to allow them to be formated as x509 v3 extensions by
+/// builder.
+pub trait AsExtension: AssociatedOid + der::Encode {
+ /// Should the extension be marked critical
+ fn critical(&self, subject: &crate::name::Name, extensions: &[Extension]) -> bool;
+
+ /// Returns the Extension with the content encoded.
+ fn to_extension(
+ &self,
+ subject: &crate::name::Name,
+ extensions: &[Extension],
+ ) -> Result<Extension, der::Error> {
+ let content = OctetString::new(<Self as der::Encode>::to_der(self)?)?;
+
+ Ok(Extension {
+ extn_id: <Self as AssociatedOid>::OID,
+ critical: self.critical(subject, extensions),
+ extn_value: content,
+ })
+ }
+}
diff --git a/crates/x509-cert/src/ext/pkix.rs b/crates/x509-cert/src/ext/pkix.rs
new file mode 100644
index 0000000..95a5e2b
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix.rs
@@ -0,0 +1,139 @@
+//! PKIX X.509 Certificate Extensions (RFC 5280)
+
+pub mod certpolicy;
+pub mod constraints;
+pub mod crl;
+pub mod name;
+
+mod access;
+mod authkeyid;
+mod keyusage;
+mod policymap;
+
+use crate::attr::AttributeTypeAndValue;
+
+pub use access::{AccessDescription, AuthorityInfoAccessSyntax, SubjectInfoAccessSyntax};
+pub use authkeyid::AuthorityKeyIdentifier;
+pub use certpolicy::CertificatePolicies;
+use const_oid::{AssociatedOid, ObjectIdentifier};
+pub use constraints::{BasicConstraints, NameConstraints, PolicyConstraints};
+pub use crl::{
+ BaseCrlNumber, CrlDistributionPoints, CrlNumber, CrlReason, FreshestCrl,
+ IssuingDistributionPoint,
+};
+pub use keyusage::{ExtendedKeyUsage, KeyUsage, KeyUsages, PrivateKeyUsagePeriod};
+pub use policymap::{PolicyMapping, PolicyMappings};
+
+pub use const_oid::db::rfc5280::{
+ ID_CE_INHIBIT_ANY_POLICY, ID_CE_ISSUER_ALT_NAME, ID_CE_SUBJECT_ALT_NAME,
+ ID_CE_SUBJECT_DIRECTORY_ATTRIBUTES, ID_CE_SUBJECT_KEY_IDENTIFIER,
+};
+
+use alloc::vec::Vec;
+
+use der::asn1::OctetString;
+
+/// SubjectKeyIdentifier as defined in [RFC 5280 Section 4.2.1.2].
+///
+/// ```text
+/// SubjectKeyIdentifier ::= KeyIdentifier
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.2]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.2
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct SubjectKeyIdentifier(pub OctetString);
+
+impl AssociatedOid for SubjectKeyIdentifier {
+ const OID: ObjectIdentifier = ID_CE_SUBJECT_KEY_IDENTIFIER;
+}
+
+impl_newtype!(SubjectKeyIdentifier, OctetString);
+impl_extension!(SubjectKeyIdentifier, critical = false);
+impl_key_identifier!(
+ SubjectKeyIdentifier,
+ (|result: &[u8]| Ok(Self(OctetString::new(result)?)))
+);
+
+/// SubjectAltName as defined in [RFC 5280 Section 4.2.1.6].
+///
+/// ```text
+/// SubjectAltName ::= GeneralNames
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct SubjectAltName(pub name::GeneralNames);
+
+impl AssociatedOid for SubjectAltName {
+ const OID: ObjectIdentifier = ID_CE_SUBJECT_ALT_NAME;
+}
+
+impl_newtype!(SubjectAltName, name::GeneralNames);
+
+impl crate::ext::AsExtension for SubjectAltName {
+ fn critical(&self, subject: &crate::name::Name, _extensions: &[super::Extension]) -> bool {
+ // https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+ // Further, if the only subject identity included in the certificate is
+ // an alternative name form (e.g., an electronic mail address), then the
+ // subject distinguished name MUST be empty (an empty sequence), and the
+ // subjectAltName extension MUST be present. If the subject field
+ // contains an empty sequence, then the issuing CA MUST include a
+ // subjectAltName extension that is marked as critical. When including
+ // the subjectAltName extension in a certificate that has a non-empty
+ // subject distinguished name, conforming CAs SHOULD mark the
+ // subjectAltName extension as non-critical.
+
+ subject.is_empty()
+ }
+}
+
+/// IssuerAltName as defined in [RFC 5280 Section 4.2.1.7].
+///
+/// ```text
+/// IssuerAltName ::= GeneralNames
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.7]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.7
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct IssuerAltName(pub name::GeneralNames);
+
+impl AssociatedOid for IssuerAltName {
+ const OID: ObjectIdentifier = ID_CE_ISSUER_ALT_NAME;
+}
+
+impl_newtype!(IssuerAltName, name::GeneralNames);
+impl_extension!(IssuerAltName, critical = false);
+
+/// SubjectDirectoryAttributes as defined in [RFC 5280 Section 4.2.1.8].
+///
+/// ```text
+/// SubjectDirectoryAttributes ::= SEQUENCE SIZE (1..MAX) OF AttributeSet
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.8]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.8
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct SubjectDirectoryAttributes(pub Vec<AttributeTypeAndValue>);
+
+impl AssociatedOid for SubjectDirectoryAttributes {
+ const OID: ObjectIdentifier = ID_CE_SUBJECT_DIRECTORY_ATTRIBUTES;
+}
+
+impl_newtype!(SubjectDirectoryAttributes, Vec<AttributeTypeAndValue>);
+impl_extension!(SubjectDirectoryAttributes, critical = false);
+
+/// InhibitAnyPolicy as defined in [RFC 5280 Section 4.2.1.14].
+///
+/// ```text
+/// InhibitAnyPolicy ::= SkipCerts
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.14]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.14
+#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
+pub struct InhibitAnyPolicy(pub u32);
+
+impl AssociatedOid for InhibitAnyPolicy {
+ const OID: ObjectIdentifier = ID_CE_INHIBIT_ANY_POLICY;
+}
+
+impl_newtype!(InhibitAnyPolicy, u32);
+impl_extension!(InhibitAnyPolicy, critical = true);
diff --git a/crates/x509-cert/src/ext/pkix/access.rs b/crates/x509-cert/src/ext/pkix/access.rs
new file mode 100644
index 0000000..4d2d9db
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/access.rs
@@ -0,0 +1,60 @@
+use super::name::GeneralName;
+
+use alloc::vec::Vec;
+
+use const_oid::{
+ db::rfc5280::{ID_PE_AUTHORITY_INFO_ACCESS, ID_PE_SUBJECT_INFO_ACCESS},
+ AssociatedOid,
+};
+use der::{asn1::ObjectIdentifier, Sequence, ValueOrd};
+
+/// AuthorityInfoAccessSyntax as defined in [RFC 5280 Section 4.2.2.1].
+///
+/// ```text
+/// AuthorityInfoAccessSyntax ::= SEQUENCE SIZE (1..MAX) OF AccessDescription
+/// ```
+///
+/// [RFC 5280 Section 4.2.2.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.1
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct AuthorityInfoAccessSyntax(pub Vec<AccessDescription>);
+
+impl AssociatedOid for AuthorityInfoAccessSyntax {
+ const OID: ObjectIdentifier = ID_PE_AUTHORITY_INFO_ACCESS;
+}
+
+impl_newtype!(AuthorityInfoAccessSyntax, Vec<AccessDescription>);
+impl_extension!(AuthorityInfoAccessSyntax, critical = false);
+
+/// SubjectInfoAccessSyntax as defined in [RFC 5280 Section 4.2.2.2].
+///
+/// ```text
+/// SubjectInfoAccessSyntax ::= SEQUENCE SIZE (1..MAX) OF AccessDescription
+/// ```
+///
+/// [RFC 5280 Section 4.2.2.2]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.2
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct SubjectInfoAccessSyntax(pub Vec<AccessDescription>);
+
+impl AssociatedOid for SubjectInfoAccessSyntax {
+ const OID: ObjectIdentifier = ID_PE_SUBJECT_INFO_ACCESS;
+}
+
+impl_newtype!(SubjectInfoAccessSyntax, Vec<AccessDescription>);
+impl_extension!(SubjectInfoAccessSyntax, critical = false);
+
+/// AccessDescription as defined in [RFC 5280 Section 4.2.2.1].
+///
+/// ```text
+/// AccessDescription ::= SEQUENCE {
+/// accessMethod OBJECT IDENTIFIER,
+/// accessLocation GeneralName
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.2.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.2.1
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct AccessDescription {
+ pub access_method: ObjectIdentifier,
+ pub access_location: GeneralName,
+}
diff --git a/crates/x509-cert/src/ext/pkix/authkeyid.rs b/crates/x509-cert/src/ext/pkix/authkeyid.rs
new file mode 100644
index 0000000..60b61e5
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/authkeyid.rs
@@ -0,0 +1,46 @@
+use super::name::GeneralNames;
+use crate::serial_number::SerialNumber;
+
+use const_oid::db::rfc5280::ID_CE_AUTHORITY_KEY_IDENTIFIER;
+use const_oid::{AssociatedOid, ObjectIdentifier};
+use der::asn1::OctetString;
+use der::Sequence;
+
+/// AuthorityKeyIdentifier as defined in [RFC 5280 Section 4.2.1.1].
+///
+/// ```text
+/// AuthorityKeyIdentifier ::= SEQUENCE {
+/// keyIdentifier [0] KeyIdentifier OPTIONAL,
+/// authorityCertIssuer [1] GeneralNames OPTIONAL,
+/// authorityCertSerialNumber [2] CertificateSerialNumber OPTIONAL
+/// }
+///
+/// KeyIdentifier ::= OCTET STRING
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.1
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, Default)]
+#[allow(missing_docs)]
+pub struct AuthorityKeyIdentifier {
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT", optional = "true")]
+ pub key_identifier: Option<OctetString>,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub authority_cert_issuer: Option<GeneralNames>,
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT", optional = "true")]
+ pub authority_cert_serial_number: Option<SerialNumber>,
+}
+
+impl AssociatedOid for AuthorityKeyIdentifier {
+ const OID: ObjectIdentifier = ID_CE_AUTHORITY_KEY_IDENTIFIER;
+}
+
+impl_extension!(AuthorityKeyIdentifier, critical = false);
+impl_key_identifier!(
+ AuthorityKeyIdentifier,
+ (|result: &[u8]| Ok(Self {
+ key_identifier: Some(OctetString::new(result)?),
+ ..Default::default()
+ }))
+);
diff --git a/crates/x509-cert/src/ext/pkix/certpolicy.rs b/crates/x509-cert/src/ext/pkix/certpolicy.rs
new file mode 100644
index 0000000..85820c1
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/certpolicy.rs
@@ -0,0 +1,131 @@
+//! PKIX Certificate Policies extension
+
+use alloc::{string::String, vec::Vec};
+
+use const_oid::db::rfc5912::ID_CE_CERTIFICATE_POLICIES;
+use const_oid::AssociatedOid;
+use der::asn1::{GeneralizedTime, Ia5String, ObjectIdentifier, Uint};
+use der::{Any, Choice, Sequence, ValueOrd};
+
+/// CertificatePolicies as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// CertificatePolicies ::= SEQUENCE SIZE (1..MAX) OF PolicyInformation
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+// If this extension is
+// critical, the path validation software MUST be able to interpret this
+// extension (including the optional qualifier), or MUST reject the
+// certificate.
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct CertificatePolicies(pub Vec<PolicyInformation>);
+
+impl AssociatedOid for CertificatePolicies {
+ const OID: ObjectIdentifier = ID_CE_CERTIFICATE_POLICIES;
+}
+
+impl_newtype!(CertificatePolicies, Vec<PolicyInformation>);
+impl_extension!(CertificatePolicies);
+
+/// PolicyInformation as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// PolicyInformation ::= SEQUENCE {
+/// policyIdentifier CertPolicyId,
+/// policyQualifiers SEQUENCE SIZE (1..MAX) OF PolicyQualifierInfo OPTIONAL
+/// }
+///
+/// CertPolicyId ::= OBJECT IDENTIFIER
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct PolicyInformation {
+ pub policy_identifier: ObjectIdentifier,
+ pub policy_qualifiers: Option<Vec<PolicyQualifierInfo>>,
+}
+
+/// PolicyQualifierInfo as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// PolicyQualifierInfo ::= SEQUENCE {
+/// policyQualifierId PolicyQualifierId,
+/// qualifier ANY DEFINED BY policyQualifierId
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct PolicyQualifierInfo {
+ pub policy_qualifier_id: ObjectIdentifier,
+ pub qualifier: Option<Any>,
+}
+
+/// CpsUri as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// CPSuri ::= IA5String
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+pub type CpsUri = Ia5String;
+
+/// UserNotice as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// UserNotice ::= SEQUENCE {
+/// noticeRef NoticeReference OPTIONAL,
+/// explicitText DisplayText OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct UserNotice {
+ pub notice_ref: Option<GeneralizedTime>,
+ pub explicit_text: Option<DisplayText>,
+}
+
+/// NoticeReference as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// NoticeReference ::= SEQUENCE {
+/// organization DisplayText,
+/// noticeNumbers SEQUENCE OF INTEGER }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct NoticeReference {
+ pub organization: DisplayText,
+ pub notice_numbers: Option<Vec<Uint>>,
+}
+
+/// DisplayText as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ```text
+/// DisplayText ::= CHOICE {
+/// ia5String IA5String (SIZE (1..200)),
+/// visibleString VisibleString (SIZE (1..200)),
+/// bmpString BMPString (SIZE (1..200)),
+/// utf8String UTF8String (SIZE (1..200))
+/// }
+/// ```
+///
+/// Only the ia5String and utf8String options are currently supported.
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Choice, Clone, Debug, Eq, PartialEq)]
+#[allow(missing_docs)]
+pub enum DisplayText {
+ #[asn1(type = "IA5String")]
+ Ia5String(Ia5String),
+
+ #[asn1(type = "UTF8String")]
+ Utf8String(String),
+}
diff --git a/crates/x509-cert/src/ext/pkix/constraints.rs b/crates/x509-cert/src/ext/pkix/constraints.rs
new file mode 100644
index 0000000..abe4c3f
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/constraints.rs
@@ -0,0 +1,10 @@
+//! PKIX Constraint Extensions
+
+mod basic;
+mod policy;
+
+pub mod name;
+
+pub use basic::BasicConstraints;
+pub use name::NameConstraints;
+pub use policy::PolicyConstraints;
diff --git a/crates/x509-cert/src/ext/pkix/constraints/basic.rs b/crates/x509-cert/src/ext/pkix/constraints/basic.rs
new file mode 100644
index 0000000..c50d8e8
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/constraints/basic.rs
@@ -0,0 +1,49 @@
+use const_oid::{db::rfc5280::ID_CE_BASIC_CONSTRAINTS, AssociatedOid, ObjectIdentifier};
+use der::Sequence;
+
+/// BasicConstraints as defined in [RFC 5280 Section 4.2.1.9].
+///
+/// ```text
+/// BasicConstraints ::= SEQUENCE {
+/// cA BOOLEAN DEFAULT FALSE,
+/// pathLenConstraint INTEGER (0..MAX) OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.9]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.9
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct BasicConstraints {
+ #[asn1(default = "Default::default")]
+ pub ca: bool,
+ pub path_len_constraint: Option<u8>,
+}
+
+impl AssociatedOid for BasicConstraints {
+ const OID: ObjectIdentifier = ID_CE_BASIC_CONSTRAINTS;
+}
+
+impl crate::ext::AsExtension for BasicConstraints {
+ fn critical(
+ &self,
+ _subject: &crate::name::Name,
+ _extensions: &[crate::ext::Extension],
+ ) -> bool {
+ // https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.9
+ // Conforming CAs MUST include this extension in all CA certificates
+ // that contain public keys used to validate digital signatures on
+ // certificates and MUST mark the extension as critical in such
+ // certificates. This extension MAY appear as a critical or non-
+ // critical extension in CA certificates that contain public keys used
+ // exclusively for purposes other than validating digital signatures on
+ // certificates. Such CA certificates include ones that contain public
+ // keys used exclusively for validating digital signatures on CRLs and
+ // ones that contain key management public keys used with certificate
+ // enrollment protocols. This extension MAY appear as a critical or
+ // non-critical extension in end entity certificates.
+
+ // NOTE(baloo): from the spec, it doesn't appear to hurt if we force the extension
+ // to be critical.
+ true
+ }
+}
diff --git a/crates/x509-cert/src/ext/pkix/constraints/name.rs b/crates/x509-cert/src/ext/pkix/constraints/name.rs
new file mode 100644
index 0000000..c05d005
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/constraints/name.rs
@@ -0,0 +1,70 @@
+//! PKIX Name Constraint extension
+
+use alloc::vec::Vec;
+
+use const_oid::{db::rfc5280::ID_CE_NAME_CONSTRAINTS, AssociatedOid, ObjectIdentifier};
+use der::Sequence;
+
+use super::super::name::GeneralName;
+
+/// NameConstraints extension as defined in [RFC 5280 Section 4.2.1.10].
+///
+/// ```text
+/// NameConstraints ::= SEQUENCE {
+/// permittedSubtrees [0] GeneralSubtrees OPTIONAL,
+/// excludedSubtrees [1] GeneralSubtrees OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.10]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct NameConstraints {
+ #[asn1(context_specific = "0", optional = "true", tag_mode = "IMPLICIT")]
+ pub permitted_subtrees: Option<GeneralSubtrees>,
+
+ #[asn1(context_specific = "1", optional = "true", tag_mode = "IMPLICIT")]
+ pub excluded_subtrees: Option<GeneralSubtrees>,
+}
+
+impl AssociatedOid for NameConstraints {
+ const OID: ObjectIdentifier = ID_CE_NAME_CONSTRAINTS;
+}
+
+impl_extension!(NameConstraints, critical = true);
+
+/// GeneralSubtrees as defined in [RFC 5280 Section 4.2.1.10].
+///
+/// ```text
+/// GeneralSubtrees ::= SEQUENCE SIZE (1..MAX) OF GeneralSubtree
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.10]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10
+pub type GeneralSubtrees = Vec<GeneralSubtree>;
+
+/// GeneralSubtree as defined in [RFC 5280 Section 4.2.1.10].
+///
+/// ```text
+/// GeneralSubtree ::= SEQUENCE {
+/// base GeneralName,
+/// minimum [0] BaseDistance DEFAULT 0,
+/// maximum [1] BaseDistance OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.10]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.10
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct GeneralSubtree {
+ pub base: GeneralName,
+
+ #[asn1(
+ context_specific = "0",
+ tag_mode = "IMPLICIT",
+ default = "Default::default"
+ )]
+ pub minimum: u32,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub maximum: Option<u32>,
+}
diff --git a/crates/x509-cert/src/ext/pkix/constraints/policy.rs b/crates/x509-cert/src/ext/pkix/constraints/policy.rs
new file mode 100644
index 0000000..c409737
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/constraints/policy.rs
@@ -0,0 +1,28 @@
+use const_oid::{db::rfc5280::ID_CE_POLICY_CONSTRAINTS, AssociatedOid, ObjectIdentifier};
+use der::Sequence;
+
+/// Policy constraints extension as defined in [RFC 5280 Section 4.2.1.11].
+///
+/// ```text
+/// PolicyConstraints ::= SEQUENCE {
+/// requireExplicitPolicy [0] SkipCerts OPTIONAL,
+/// inhibitPolicyMapping [1] SkipCerts OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.11]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.11
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct PolicyConstraints {
+ #[asn1(context_specific = "0", optional = "true", tag_mode = "IMPLICIT")]
+ pub require_explicit_policy: Option<u32>,
+
+ #[asn1(context_specific = "1", optional = "true", tag_mode = "IMPLICIT")]
+ pub inhibit_policy_mapping: Option<u32>,
+}
+
+impl AssociatedOid for PolicyConstraints {
+ const OID: ObjectIdentifier = ID_CE_POLICY_CONSTRAINTS;
+}
+
+impl_extension!(PolicyConstraints, critical = true);
diff --git a/crates/x509-cert/src/ext/pkix/crl.rs b/crates/x509-cert/src/ext/pkix/crl.rs
new file mode 100644
index 0000000..f3e9397
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/crl.rs
@@ -0,0 +1,122 @@
+//! PKIX Certificate Revocation List extensions
+
+pub mod dp;
+
+use const_oid::db::rfc5280::{
+ ID_CE_CRL_DISTRIBUTION_POINTS, ID_CE_CRL_NUMBER, ID_CE_CRL_REASONS, ID_CE_DELTA_CRL_INDICATOR,
+ ID_CE_FRESHEST_CRL,
+};
+use const_oid::{AssociatedOid, ObjectIdentifier};
+pub use dp::IssuingDistributionPoint;
+
+use alloc::vec::Vec;
+
+use der::{asn1::Uint, Enumerated};
+
+/// CrlNumber as defined in [RFC 5280 Section 5.2.3].
+///
+/// ```text
+/// CRLNumber ::= INTEGER (0..MAX)
+/// ```
+///
+/// [RFC 5280 Section 5.2.3]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.3
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct CrlNumber(pub Uint);
+
+impl AssociatedOid for CrlNumber {
+ const OID: ObjectIdentifier = ID_CE_CRL_NUMBER;
+}
+
+impl_newtype!(CrlNumber, Uint);
+impl_extension!(CrlNumber, critical = false);
+
+/// BaseCRLNumber as defined in [RFC 5280 Section 5.2.4].
+///
+/// ```text
+/// BaseCRLNumber ::= CRLNumber
+/// ```
+///
+/// [RFC 5280 Section 5.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.4
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct BaseCrlNumber(pub Uint);
+
+impl AssociatedOid for BaseCrlNumber {
+ const OID: ObjectIdentifier = ID_CE_DELTA_CRL_INDICATOR;
+}
+
+impl_newtype!(BaseCrlNumber, Uint);
+impl_extension!(BaseCrlNumber, critical = true);
+
+/// CrlDistributionPoints as defined in [RFC 5280 Section 4.2.1.13].
+///
+/// ```text
+/// CRLDistributionPoints ::= SEQUENCE SIZE (1..MAX) OF DistributionPoint
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct CrlDistributionPoints(pub Vec<dp::DistributionPoint>);
+
+impl AssociatedOid for CrlDistributionPoints {
+ const OID: ObjectIdentifier = ID_CE_CRL_DISTRIBUTION_POINTS;
+}
+
+impl_newtype!(CrlDistributionPoints, Vec<dp::DistributionPoint>);
+impl_extension!(CrlDistributionPoints, critical = false);
+
+/// FreshestCrl as defined in [RFC 5280 Section 5.2.6].
+///
+/// ```text
+/// FreshestCRL ::= CRLDistributionPoints
+/// ```
+///
+/// [RFC 5280 Section 5.2.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.6
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct FreshestCrl(pub Vec<dp::DistributionPoint>);
+
+impl AssociatedOid for FreshestCrl {
+ const OID: ObjectIdentifier = ID_CE_FRESHEST_CRL;
+}
+
+impl_newtype!(FreshestCrl, Vec<dp::DistributionPoint>);
+impl_extension!(FreshestCrl, critical = false);
+
+/// CRLReason as defined in [RFC 5280 Section 5.3.1].
+///
+/// ```text
+/// CRLReason ::= ENUMERATED {
+/// unspecified (0),
+/// keyCompromise (1),
+/// cACompromise (2),
+/// affiliationChanged (3),
+/// superseded (4),
+/// cessationOfOperation (5),
+/// certificateHold (6),
+/// removeFromCRL (8),
+/// privilegeWithdrawn (9),
+/// aACompromise (10)
+/// }
+/// ```
+///
+/// [RFC 5280 Section 5.3.1]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.3.1
+#[derive(Copy, Clone, Debug, Eq, PartialEq, Enumerated)]
+#[allow(missing_docs)]
+#[repr(u32)]
+pub enum CrlReason {
+ Unspecified = 0,
+ KeyCompromise = 1,
+ CaCompromise = 2,
+ AffiliationChanged = 3,
+ Superseded = 4,
+ CessationOfOperation = 5,
+ CertificateHold = 6,
+ RemoveFromCRL = 8,
+ PrivilegeWithdrawn = 9,
+ AaCompromise = 10,
+}
+
+impl AssociatedOid for CrlReason {
+ const OID: ObjectIdentifier = ID_CE_CRL_REASONS;
+}
+
+impl_extension!(CrlReason, critical = false);
diff --git a/crates/x509-cert/src/ext/pkix/crl/dp.rs b/crates/x509-cert/src/ext/pkix/crl/dp.rs
new file mode 100644
index 0000000..7acd2c9
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/crl/dp.rs
@@ -0,0 +1,127 @@
+//! PKIX distribution point types
+
+use const_oid::{db::rfc5280::ID_PE_SUBJECT_INFO_ACCESS, AssociatedOid, ObjectIdentifier};
+use der::flagset::{flags, FlagSet};
+use der::{Sequence, ValueOrd};
+
+use crate::ext::pkix::name::{DistributionPointName, GeneralNames};
+
+/// IssuingDistributionPoint as defined in [RFC 5280 Section 5.2.5].
+///
+/// ```text
+/// IssuingDistributionPoint ::= SEQUENCE {
+/// distributionPoint [0] DistributionPointName OPTIONAL,
+/// onlyContainsUserCerts [1] BOOLEAN DEFAULT FALSE,
+/// onlyContainsCACerts [2] BOOLEAN DEFAULT FALSE,
+/// onlySomeReasons [3] ReasonFlags OPTIONAL,
+/// indirectCRL [4] BOOLEAN DEFAULT FALSE,
+/// onlyContainsAttributeCerts [5] BOOLEAN DEFAULT FALSE
+/// -- at most one of onlyContainsUserCerts, onlyContainsCACerts,
+/// -- and onlyContainsAttributeCerts may be set to TRUE.
+/// }
+/// ```
+///
+/// [RFC 5280 Section 5.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-5.2.5
+#[derive(Clone, Debug, Eq, PartialEq, Sequence)]
+#[allow(missing_docs)]
+pub struct IssuingDistributionPoint {
+ #[asn1(context_specific = "0", tag_mode = "EXPLICIT", optional = "true")]
+ pub distribution_point: Option<DistributionPointName>,
+
+ #[asn1(
+ context_specific = "1",
+ tag_mode = "IMPLICIT",
+ default = "Default::default"
+ )]
+ pub only_contains_user_certs: bool,
+
+ #[asn1(
+ context_specific = "2",
+ tag_mode = "IMPLICIT",
+ default = "Default::default"
+ )]
+ pub only_contains_ca_certs: bool,
+
+ #[asn1(context_specific = "3", tag_mode = "IMPLICIT", optional = "true")]
+ pub only_some_reasons: Option<ReasonFlags>,
+
+ #[asn1(
+ context_specific = "4",
+ tag_mode = "IMPLICIT",
+ default = "Default::default"
+ )]
+ pub indirect_crl: bool,
+
+ #[asn1(
+ context_specific = "5",
+ tag_mode = "IMPLICIT",
+ default = "Default::default"
+ )]
+ pub only_contains_attribute_certs: bool,
+}
+
+impl AssociatedOid for IssuingDistributionPoint {
+ const OID: ObjectIdentifier = ID_PE_SUBJECT_INFO_ACCESS;
+}
+
+impl_extension!(IssuingDistributionPoint, critical = true);
+
+/// DistributionPoint as defined in [RFC 5280 Section 4.2.1.13].
+///
+/// ```text
+/// DistributionPoint ::= SEQUENCE {
+/// distributionPoint [0] DistributionPointName OPTIONAL,
+/// reasons [1] ReasonFlags OPTIONAL,
+/// cRLIssuer [2] GeneralNames OPTIONAL }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+#[derive(Clone, Debug, PartialEq, Eq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct DistributionPoint {
+ #[asn1(context_specific = "0", tag_mode = "EXPLICIT", optional = "true")]
+ pub distribution_point: Option<DistributionPointName>,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub reasons: Option<ReasonFlags>,
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT", optional = "true")]
+ pub crl_issuer: Option<GeneralNames>,
+}
+
+/// ReasonFlags as defined in [RFC 5280 Section 4.2.1.13].
+///
+/// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+pub type ReasonFlags = FlagSet<Reasons>;
+
+flags! {
+ /// ReasonFlags values as defined in [RFC 5280 Section 4.2.1.13].
+ ///
+ /// ```text
+ /// ReasonFlags ::= BIT STRING {
+ /// unused (0),
+ /// keyCompromise (1),
+ /// cACompromise (2),
+ /// affiliationChanged (3),
+ /// superseded (4),
+ /// cessationOfOperation (5),
+ /// certificateHold (6),
+ /// privilegeWithdrawn (7),
+ /// aACompromise (8)
+ /// }
+ /// ```
+ ///
+ /// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+ #[allow(missing_docs)]
+ pub enum Reasons: u16 {
+ Unused = 1 << 0,
+ KeyCompromise = 1 << 1,
+ CaCompromise = 1 << 2,
+ AffiliationChanged = 1 << 3,
+ Superseded = 1 << 4,
+ CessationOfOperation = 1 << 5,
+ CertificateHold = 1 << 6,
+ PrivilegeWithdrawn = 1 << 7,
+ AaCompromise = 1 << 8,
+ }
+}
diff --git a/crates/x509-cert/src/ext/pkix/keyusage.rs b/crates/x509-cert/src/ext/pkix/keyusage.rs
new file mode 100644
index 0000000..833db69
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/keyusage.rs
@@ -0,0 +1,220 @@
+use alloc::vec::Vec;
+
+use const_oid::db::rfc5280::{
+ ANY_EXTENDED_KEY_USAGE, ID_CE_EXT_KEY_USAGE, ID_CE_KEY_USAGE, ID_CE_PRIVATE_KEY_USAGE_PERIOD,
+};
+use const_oid::AssociatedOid;
+use der::asn1::{GeneralizedTime, ObjectIdentifier};
+use der::flagset::{flags, FlagSet};
+use der::Sequence;
+
+flags! {
+ /// Key usage flags as defined in [RFC 5280 Section 4.2.1.3].
+ ///
+ /// ```text
+ /// KeyUsage ::= BIT STRING {
+ /// digitalSignature (0),
+ /// nonRepudiation (1), -- recent editions of X.509 have
+ /// -- renamed this bit to contentCommitment
+ /// keyEncipherment (2),
+ /// dataEncipherment (3),
+ /// keyAgreement (4),
+ /// keyCertSign (5),
+ /// cRLSign (6),
+ /// encipherOnly (7),
+ /// decipherOnly (8)
+ /// }
+ /// ```
+ ///
+ /// [RFC 5280 Section 4.2.1.3]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.3
+ #[allow(missing_docs)]
+ pub enum KeyUsages: u16 {
+ DigitalSignature = 1 << 0,
+ NonRepudiation = 1 << 1,
+ KeyEncipherment = 1 << 2,
+ DataEncipherment = 1 << 3,
+ KeyAgreement = 1 << 4,
+ KeyCertSign = 1 << 5,
+ CRLSign = 1 << 6,
+ EncipherOnly = 1 << 7,
+ DecipherOnly = 1 << 8,
+ }
+}
+
+/// KeyUsage as defined in [RFC 5280 Section 4.2.1.3].
+///
+/// [RFC 5280 Section 4.2.1.3]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.3
+#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+pub struct KeyUsage(pub FlagSet<KeyUsages>);
+
+impl AssociatedOid for KeyUsage {
+ const OID: ObjectIdentifier = ID_CE_KEY_USAGE;
+}
+
+impl_newtype!(KeyUsage, FlagSet<KeyUsages>);
+impl_extension!(KeyUsage, critical = true);
+
+impl KeyUsage {
+ /// The subject public key is used for verifying digital signatures
+ pub fn digital_signature(&self) -> bool {
+ self.0.contains(KeyUsages::DigitalSignature)
+ }
+
+ /// When the subject public key is used to verify digital signatures,
+ /// it is asserted as non-repudiation.
+ pub fn non_repudiation(&self) -> bool {
+ self.0.contains(KeyUsages::NonRepudiation)
+ }
+
+ /// The subject public key is used for enciphering private or
+ /// secret keys, i.e., for key transport.
+ pub fn key_encipherment(&self) -> bool {
+ self.0.contains(KeyUsages::KeyEncipherment)
+ }
+
+ /// The subject public key is used for directly enciphering
+ /// raw user data without the use of an intermediate symmetric cipher.
+ pub fn data_encipherment(&self) -> bool {
+ self.0.contains(KeyUsages::DataEncipherment)
+ }
+
+ /// The subject public key is used for key agreement
+ pub fn key_agreement(&self) -> bool {
+ self.0.contains(KeyUsages::KeyAgreement)
+ }
+
+ /// The subject public key is used for enciphering private or
+ /// secret keys, i.e., for key transport.
+ pub fn key_cert_sign(&self) -> bool {
+ self.0.contains(KeyUsages::KeyCertSign)
+ }
+
+ /// The subject public key is used for verifying signatures
+ /// on certificate revocation lists (e.g., CRLs, delta CRLs,
+ /// or ARLs).
+ pub fn crl_sign(&self) -> bool {
+ self.0.contains(KeyUsages::CRLSign)
+ }
+
+ /// The meaning of the `encipher_only` is undefined when `key_agreement`
+ /// returns false. When `encipher_only` returns true and
+ /// `key_agreement` also returns true, the subject public key may be
+ /// used only for enciphering data while performing key agreement.
+ pub fn encipher_only(&self) -> bool {
+ self.0.contains(KeyUsages::EncipherOnly)
+ }
+
+ /// The meaning of the `decipher_only` is undefined when `key_agreement`
+ /// returns false. When `encipher_only` returns true and
+ /// `key_agreement` also returns true, the subject public key may be
+ /// used only for deciphering data while performing key agreement.
+ pub fn decipher_only(&self) -> bool {
+ self.0.contains(KeyUsages::DecipherOnly)
+ }
+}
+
+/// ExtKeyUsageSyntax as defined in [RFC 5280 Section 4.2.1.12].
+///
+/// Many extended key usage values include:
+/// - [`PKIX_CE_ANYEXTENDEDKEYUSAGE`](constant.PKIX_CE_ANYEXTENDEDKEYUSAGE.html),
+/// - [`PKIX_KP_SERVERAUTH`](constant.PKIX_KP_SERVERAUTH.html),
+/// - [`PKIX_KP_CLIENTAUTH`](constant.PKIX_KP_CLIENTAUTH.html),
+/// - [`PKIX_KP_CODESIGNING`](constant.PKIX_KP_CODESIGNING.html),
+/// - [`PKIX_KP_EMAILPROTECTION`](constant.PKIX_KP_EMAILPROTECTION.html),
+/// - [`PKIX_KP_TIMESTAMPING`](constant.PKIX_KP_TIMESTAMPING.html),
+///
+/// ```text
+/// ExtKeyUsageSyntax ::= SEQUENCE SIZE (1..MAX) OF KeyPurposeId
+/// KeyPurposeId ::= OBJECT IDENTIFIER
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.12]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct ExtendedKeyUsage(pub Vec<ObjectIdentifier>);
+
+impl AssociatedOid for ExtendedKeyUsage {
+ const OID: ObjectIdentifier = ID_CE_EXT_KEY_USAGE;
+}
+
+impl_newtype!(ExtendedKeyUsage, Vec<ObjectIdentifier>);
+
+impl crate::ext::AsExtension for ExtendedKeyUsage {
+ fn critical(
+ &self,
+ _subject: &crate::name::Name,
+ _extensions: &[crate::ext::Extension],
+ ) -> bool {
+ // https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12
+ // This extension MAY, at the option of the certificate issuer, be
+ // either critical or non-critical.
+ //
+ // If a CA includes extended key usages to satisfy such applications,
+ // but does not wish to restrict usages of the key, the CA can include
+ // the special KeyPurposeId anyExtendedKeyUsage in addition to the
+ // particular key purposes required by the applications. Conforming CAs
+ // SHOULD NOT mark this extension as critical if the anyExtendedKeyUsage
+ // KeyPurposeId is present. Applications that require the presence of a
+ // particular purpose MAY reject certificates that include the
+ // anyExtendedKeyUsage OID but not the particular OID expected for the
+ // application.
+
+ !self.0.iter().any(|el| *el == ANY_EXTENDED_KEY_USAGE)
+ }
+}
+
+/// PrivateKeyUsagePeriod as defined in [RFC 3280 Section 4.2.1.4].
+///
+/// RFC 5280 states "use of this ISO standard extension is neither deprecated nor recommended for use in the Internet PKI."
+///
+/// ```text
+/// PrivateKeyUsagePeriod ::= SEQUENCE {
+/// notBefore [0] GeneralizedTime OPTIONAL,
+/// notAfter [1] GeneralizedTime OPTIONAL }
+/// -- either notBefore or notAfter MUST be present
+/// ```
+///
+/// [RFC 3280 Section 4.2.1.12]: https://datatracker.ietf.org/doc/html/rfc3280#section-4.2.1.4
+#[derive(Clone, Debug, PartialEq, Eq, Sequence)]
+#[allow(missing_docs)]
+pub struct PrivateKeyUsagePeriod {
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT", optional = "true")]
+ pub not_before: Option<GeneralizedTime>,
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", optional = "true")]
+ pub not_after: Option<GeneralizedTime>,
+}
+
+impl AssociatedOid for PrivateKeyUsagePeriod {
+ const OID: ObjectIdentifier = ID_CE_PRIVATE_KEY_USAGE_PERIOD;
+}
+
+impl_extension!(PrivateKeyUsagePeriod, critical = false);
+
+#[cfg(test)]
+mod tests {
+ use super::*;
+
+ #[test]
+ fn digital_signature_contains_digital_signature() {
+ let key_usage = KeyUsage(KeyUsages::DigitalSignature.into());
+ assert!(key_usage.digital_signature());
+ }
+
+ #[test]
+ fn all_contains_digital_signature() {
+ let key_usage = KeyUsage(FlagSet::full());
+ assert!(key_usage.digital_signature());
+ }
+
+ #[test]
+ fn key_encipherment_not_contains_digital_signature() {
+ let key_usage = KeyUsage(KeyUsages::KeyEncipherment.into());
+ assert!(!key_usage.digital_signature());
+ }
+
+ #[test]
+ fn empty_not_contains_digital_signature() {
+ let key_usage = KeyUsage(None.into());
+ assert!(!key_usage.digital_signature());
+ }
+}
diff --git a/crates/x509-cert/src/ext/pkix/name.rs b/crates/x509-cert/src/ext/pkix/name.rs
new file mode 100644
index 0000000..4e0112b
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name.rs
@@ -0,0 +1,13 @@
+//! PKIX Name types
+
+mod dirstr;
+mod dp;
+mod ediparty;
+mod general;
+mod other;
+
+pub use dirstr::DirectoryString;
+pub use dp::DistributionPointName;
+pub use ediparty::EdiPartyName;
+pub use general::{GeneralName, GeneralNames};
+pub use other::OtherName;
diff --git a/crates/x509-cert/src/ext/pkix/name/dirstr.rs b/crates/x509-cert/src/ext/pkix/name/dirstr.rs
new file mode 100644
index 0000000..a6a0117
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name/dirstr.rs
@@ -0,0 +1,53 @@
+use alloc::string::String;
+use der::asn1::{PrintableString, TeletexString};
+use der::{Choice, ValueOrd};
+
+/// DirectoryString as defined in [RFC 5280 Section 4.2.1.4].
+///
+/// ASN.1 structure for DirectoryString is below.
+///
+/// ```text
+/// DirectoryString ::= CHOICE {
+/// teletexString TeletexString (SIZE (1..MAX)),
+/// printableString PrintableString (SIZE (1..MAX)),
+/// universalString UniversalString (SIZE (1..MAX)),
+/// utf8String UTF8String (SIZE (1..MAX)),
+/// bmpString BMPString (SIZE (1..MAX))
+/// }
+/// ```
+///
+/// Further, [RFC 5280 Section 4.2.1.4] states:
+///
+/// ```text
+/// The DirectoryString type is defined as a choice of PrintableString,
+/// TeletexString, BMPString, UTF8String, and UniversalString. CAs
+/// conforming to this profile MUST use either the PrintableString or
+/// UTF8String encoding of DirectoryString, with two exceptions. When
+/// CAs have previously issued certificates with issuer fields with
+/// attributes encoded using TeletexString, BMPString, or
+/// UniversalString, then the CA MAY continue to use these encodings of
+/// the DirectoryString to preserve backward compatibility. Also, new
+/// CAs that are added to a domain where existing CAs issue certificates
+/// with issuer fields with attributes encoded using TeletexString,
+/// BMPString, or UniversalString MAY encode attributes that they share
+/// with the existing CAs using the same encodings as the existing CAs
+/// use.
+/// ```
+///
+/// The implication of the above paragraph is that `PrintableString` and
+/// `UTF8String` are the new types and the other types are legacy. Until
+/// the need arises, we only support `PrintableString` and `UTF8String`.
+///
+/// [RFC 5280 Section 4.2.1.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4
+#[derive(Clone, Debug, Eq, PartialEq, Choice, ValueOrd)]
+#[allow(missing_docs)]
+pub enum DirectoryString {
+ #[asn1(type = "PrintableString")]
+ PrintableString(PrintableString),
+
+ #[asn1(type = "TeletexString")]
+ TeletexString(TeletexString),
+
+ #[asn1(type = "UTF8String")]
+ Utf8String(String),
+}
diff --git a/crates/x509-cert/src/ext/pkix/name/dp.rs b/crates/x509-cert/src/ext/pkix/name/dp.rs
new file mode 100644
index 0000000..0965564
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name/dp.rs
@@ -0,0 +1,24 @@
+use super::GeneralNames;
+use crate::name::RelativeDistinguishedName;
+
+use der::{Choice, ValueOrd};
+
+/// DistributionPointName as defined in [RFC 5280 Section 4.2.1.13].
+///
+/// ```text
+/// DistributionPointName ::= CHOICE {
+/// fullName [0] GeneralNames,
+/// nameRelativeToCRLIssuer [1] RelativeDistinguishedName
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.13]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.13
+#[derive(Clone, Debug, Eq, PartialEq, Choice, ValueOrd)]
+#[allow(missing_docs)]
+pub enum DistributionPointName {
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT", constructed = "true")]
+ FullName(GeneralNames),
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT", constructed = "true")]
+ NameRelativeToCRLIssuer(RelativeDistinguishedName),
+}
diff --git a/crates/x509-cert/src/ext/pkix/name/ediparty.rs b/crates/x509-cert/src/ext/pkix/name/ediparty.rs
new file mode 100644
index 0000000..9d10040
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name/ediparty.rs
@@ -0,0 +1,36 @@
+use der::{Sequence, ValueOrd};
+
+use super::DirectoryString;
+
+/// EDIPartyName as defined in [RFC 5280 Section 4.2.1.6].
+///
+/// ```text
+/// EDIPartyName ::= SEQUENCE {
+/// nameAssigner [0] DirectoryString OPTIONAL,
+/// partyName [1] DirectoryString
+/// }
+/// ```
+///
+/// Note that although the module uses `IMPLICIT` tagging, these tags are
+/// `EXPLICIT` because of `X.680-2015 31.2.7 (c)`:
+///
+/// ```text
+/// c) the "Tag Type" alternative is used and the value of "TagDefault" for
+/// the module is IMPLICIT TAGS or AUTOMATIC TAGS, but the type defined by
+/// "Type" is an untagged choice type, an untagged open type, or an untagged
+/// "DummyReference" (see Rec. ITU-T X.683 | ISO/IEC 8824-4, 8.3).
+/// ```
+///
+/// See [this OpenSSL bug] for more details.
+///
+/// [this OpenSSL bug]: https://github.com/openssl/openssl/issues/6859
+/// [RFC 5280 Section 4.2.1.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct EdiPartyName {
+ #[asn1(context_specific = "0", tag_mode = "EXPLICIT", optional = "true")]
+ pub name_assigner: Option<DirectoryString>,
+
+ #[asn1(context_specific = "1", tag_mode = "EXPLICIT")]
+ pub party_name: DirectoryString,
+}
diff --git a/crates/x509-cert/src/ext/pkix/name/general.rs b/crates/x509-cert/src/ext/pkix/name/general.rs
new file mode 100644
index 0000000..bd0fa7e
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name/general.rs
@@ -0,0 +1,109 @@
+//! GeneralNames as defined in [RFC 5280 Section 4.2.1.6].
+
+use super::{EdiPartyName, OtherName};
+use crate::name::Name;
+
+use der::asn1::{Ia5String, ObjectIdentifier, OctetString};
+use der::{Choice, ValueOrd};
+
+/// GeneralNames as defined in [RFC 5280 Section 4.2.1.6].
+///
+/// ```text
+/// GeneralNames ::= SEQUENCE SIZE (1..MAX) OF GeneralName
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+pub type GeneralNames = alloc::vec::Vec<GeneralName>;
+
+/// GeneralName as defined in [RFC 5280 Section 4.2.1.6].
+///
+/// ```text
+/// GeneralName ::= CHOICE {
+/// otherName [0] OtherName,
+/// rfc822Name [1] IA5String,
+/// dNSName [2] IA5String,
+/// x400Address [3] ORAddress,
+/// directoryName [4] Name,
+/// ediPartyName [5] EDIPartyName,
+/// uniformResourceIdentifier [6] IA5String,
+/// iPAddress [7] OCTET STRING,
+/// registeredID [8] OBJECT IDENTIFIER
+/// }
+/// ```
+///
+/// This implementation does not currently support the `x400Address` choice.
+///
+/// [RFC 5280 Section 4.2.1.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+#[derive(Clone, Debug, Eq, PartialEq, Choice, ValueOrd)]
+#[allow(missing_docs)]
+pub enum GeneralName {
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT", constructed = "true")]
+ OtherName(OtherName),
+
+ #[asn1(context_specific = "1", tag_mode = "IMPLICIT")]
+ Rfc822Name(Ia5String),
+
+ #[asn1(context_specific = "2", tag_mode = "IMPLICIT")]
+ DnsName(Ia5String),
+
+ #[asn1(context_specific = "4", tag_mode = "EXPLICIT", constructed = "true")]
+ DirectoryName(Name),
+
+ #[asn1(context_specific = "5", tag_mode = "IMPLICIT", constructed = "true")]
+ EdiPartyName(EdiPartyName),
+
+ #[asn1(context_specific = "6", tag_mode = "IMPLICIT")]
+ UniformResourceIdentifier(Ia5String),
+
+ #[asn1(context_specific = "7", tag_mode = "IMPLICIT")]
+ IpAddress(OctetString),
+
+ #[asn1(context_specific = "8", tag_mode = "IMPLICIT")]
+ RegisteredId(ObjectIdentifier),
+}
+
+#[cfg(feature = "std")]
+impl From<std::net::IpAddr> for GeneralName {
+ fn from(ip: std::net::IpAddr) -> Self {
+ // Safety: this is unfailable here, OctetString will issue an error if you go
+ // over 256MiB, here the buffer is at most 16 bytes (ipv6). The two `expect`s
+ // below are safe.
+ let buf = match ip {
+ std::net::IpAddr::V4(v) => {
+ let value = v.octets();
+ OctetString::new(&value[..])
+ .expect("OctetString is not expected to fail with a 4 bytes long buffer")
+ }
+ std::net::IpAddr::V6(v) => {
+ let value = v.octets();
+ OctetString::new(&value[..])
+ .expect("OctetString is not expected to fail with a 16 bytes long buffer")
+ }
+ };
+
+ GeneralName::IpAddress(buf)
+ }
+}
+
+#[cfg(all(feature = "std", test))]
+mod tests {
+ use super::*;
+ use der::Encode;
+
+ #[test]
+ fn test_convert() {
+ use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
+
+ let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
+ let localhost_v6 = IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+
+ assert_eq!(
+ GeneralName::from(localhost_v4).to_der().unwrap(),
+ &[135, 4, 127, 0, 0, 1][..]
+ );
+ assert_eq!(
+ GeneralName::from(localhost_v6).to_der().unwrap(),
+ &[135, 16, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1][..]
+ );
+ }
+}
diff --git a/crates/x509-cert/src/ext/pkix/name/other.rs b/crates/x509-cert/src/ext/pkix/name/other.rs
new file mode 100644
index 0000000..26b93bc
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/name/other.rs
@@ -0,0 +1,37 @@
+use der::{asn1::ObjectIdentifier, Any, Sequence, ValueOrd};
+
+/// OtherName as defined in [RFC 5280 Section 4.2.1.6].
+///
+/// ```text
+/// OtherName ::= SEQUENCE {
+/// type-id OBJECT IDENTIFIER,
+/// value [0] EXPLICIT ANY DEFINED BY type-id
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.6]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.6
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct OtherName {
+ pub type_id: ObjectIdentifier,
+
+ #[asn1(context_specific = "0", tag_mode = "EXPLICIT")]
+ pub value: Any,
+}
+
+#[test]
+#[cfg(test)]
+fn test() {
+ use alloc::string::ToString;
+ use der::{asn1::Utf8StringRef, Decode, Encode};
+ use hex_literal::hex;
+
+ let input = hex!("3021060A2B060104018237140203A0130C1155706E5F323134393530313330406D696C");
+ let decoded = OtherName::from_der(&input).unwrap();
+
+ let onval = Utf8StringRef::try_from(&decoded.value).unwrap();
+ assert_eq!(onval.to_string(), "Upn_214950130@mil");
+
+ let encoded = decoded.to_der().unwrap();
+ assert_eq!(&input[..], &encoded);
+}
diff --git a/crates/x509-cert/src/ext/pkix/policymap.rs b/crates/x509-cert/src/ext/pkix/policymap.rs
new file mode 100644
index 0000000..1997f54
--- /dev/null
+++ b/crates/x509-cert/src/ext/pkix/policymap.rs
@@ -0,0 +1,40 @@
+use alloc::vec::Vec;
+
+use const_oid::db::rfc5280::ID_CE_POLICY_MAPPINGS;
+use const_oid::AssociatedOid;
+use der::asn1::ObjectIdentifier;
+use der::{Sequence, ValueOrd};
+
+/// PolicyMappings as defined in [RFC 5280 Section 4.2.1.5].
+///
+/// ```text
+/// PolicyMappings ::= SEQUENCE SIZE (1..MAX) OF SEQUENCE {
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.5
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct PolicyMappings(pub Vec<PolicyMapping>);
+
+impl AssociatedOid for PolicyMappings {
+ const OID: ObjectIdentifier = ID_CE_POLICY_MAPPINGS;
+}
+
+impl_newtype!(PolicyMappings, Vec<PolicyMapping>);
+impl_extension!(PolicyMappings, critical = true);
+
+/// PolicyMapping as defined in [RFC 5280 Section 4.2.1.5].
+///
+/// ```text
+/// PolicyMapping ::= SEQUENCE {
+/// issuerDomainPolicy CertPolicyId,
+/// subjectDomainPolicy CertPolicyId
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.2.1.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.5
+#[derive(Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+#[allow(missing_docs)]
+pub struct PolicyMapping {
+ pub issuer_domain_policy: ObjectIdentifier,
+ pub subject_domain_policy: ObjectIdentifier,
+}
diff --git a/crates/x509-cert/src/lib.rs b/crates/x509-cert/src/lib.rs
new file mode 100644
index 0000000..dbf3d93
--- /dev/null
+++ b/crates/x509-cert/src/lib.rs
@@ -0,0 +1,45 @@
+#![no_std]
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+#![doc = include_str!("../README.md")]
+#![doc(
+ html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
+ html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
+)]
+#![forbid(unsafe_code)]
+#![warn(
+ clippy::mod_module_files,
+ clippy::unwrap_used,
+ missing_docs,
+ rust_2018_idioms,
+ unused_lifetimes,
+ unused_qualifications
+)]
+
+/// Local Android change: Use std to allow building as a dylib.
+#[cfg(android_dylib)]
+extern crate std;
+
+extern crate alloc;
+
+#[cfg(feature = "std")]
+extern crate std;
+
+#[macro_use]
+mod macros;
+
+pub mod anchor;
+pub mod attr;
+pub mod certificate;
+pub mod crl;
+pub mod ext;
+pub mod name;
+pub mod request;
+pub mod serial_number;
+pub mod time;
+
+#[cfg(feature = "builder")]
+pub mod builder;
+
+pub use certificate::{Certificate, PkiPath, TbsCertificate, Version};
+pub use der;
+pub use spki;
diff --git a/crates/x509-cert/src/macros.rs b/crates/x509-cert/src/macros.rs
new file mode 100644
index 0000000..0333ef7
--- /dev/null
+++ b/crates/x509-cert/src/macros.rs
@@ -0,0 +1,138 @@
+//! Macros used by this crate
+
+/// Implements the following traits for a newtype of a `der` decodable/encodable type:
+///
+/// - `From` conversions to/from the inner type
+/// - `AsRef` and `AsMut`
+/// - `DecodeValue` and `EncodeValue`
+/// - `FixedTag` mapping to the inner value's `FixedTag::TAG`
+///
+/// The main case is simplifying newtypes which need an `AssociatedOid`
+#[macro_export]
+macro_rules! impl_newtype {
+ ($newtype:ty, $inner:ty) => {
+ #[allow(unused_lifetimes)]
+ impl<'a> From<$inner> for $newtype {
+ #[inline]
+ fn from(value: $inner) -> Self {
+ Self(value)
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> From<$newtype> for $inner {
+ #[inline]
+ fn from(value: $newtype) -> Self {
+ value.0
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> AsRef<$inner> for $newtype {
+ #[inline]
+ fn as_ref(&self) -> &$inner {
+ &self.0
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> AsMut<$inner> for $newtype {
+ #[inline]
+ fn as_mut(&mut self) -> &mut $inner {
+ &mut self.0
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> ::der::FixedTag for $newtype {
+ const TAG: ::der::Tag = <$inner as ::der::FixedTag>::TAG;
+ }
+
+ impl<'a> ::der::DecodeValue<'a> for $newtype {
+ fn decode_value<R: ::der::Reader<'a>>(
+ decoder: &mut R,
+ header: ::der::Header,
+ ) -> ::der::Result<Self> {
+ Ok(Self(<$inner as ::der::DecodeValue>::decode_value(
+ decoder, header,
+ )?))
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> ::der::EncodeValue for $newtype {
+ fn encode_value(&self, encoder: &mut impl ::der::Writer) -> ::der::Result<()> {
+ self.0.encode_value(encoder)
+ }
+
+ fn value_len(&self) -> ::der::Result<::der::Length> {
+ self.0.value_len()
+ }
+ }
+
+ #[allow(unused_lifetimes)]
+ impl<'a> ::der::ValueOrd for $newtype {
+ fn value_cmp(&self, other: &Self) -> ::der::Result<::core::cmp::Ordering> {
+ self.0.value_cmp(&other.0)
+ }
+ }
+ };
+}
+
+/// Implements the AsExtension traits for every defined Extension paylooad
+macro_rules! impl_extension {
+ ($newtype:ty) => {
+ impl_extension!($newtype, critical = false);
+ };
+ ($newtype:ty, critical = $critical:expr) => {
+ impl crate::ext::AsExtension for $newtype {
+ fn critical(
+ &self,
+ _subject: &crate::name::Name,
+ _extensions: &[crate::ext::Extension],
+ ) -> bool {
+ $critical
+ }
+ }
+ };
+}
+
+/// Implements conversions between [`spki::SubjectPublicKeyInfo`] and [`SubjectKeyIdentifier`] or [`AuthorityKeyIdentifier`]
+macro_rules! impl_key_identifier {
+ ($newtype:ty, $out:expr) => {
+ #[cfg(feature = "builder")]
+ mod builder_key_identifier {
+ use super::*;
+ use der::asn1::OctetString;
+ use sha1::{Digest, Sha1};
+ use spki::SubjectPublicKeyInfoRef;
+
+ impl<'a> TryFrom<SubjectPublicKeyInfoRef<'a>> for $newtype {
+ type Error = der::Error;
+
+ fn try_from(issuer: SubjectPublicKeyInfoRef<'a>) -> Result<Self, Self::Error> {
+ // https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.2
+ //
+ // For CA certificates, subject key identifiers SHOULD be derived from
+ // the public key or a method that generates unique values. Two common
+ // methods for generating key identifiers from the public key are:
+
+ // (1) The keyIdentifier is composed of the 160-bit SHA-1 hash of the
+ // value of the BIT STRING subjectPublicKey (excluding the tag,
+ // length, and number of unused bits).
+
+ // (2) The keyIdentifier is composed of a four-bit type field with
+ // the value 0100 followed by the least significant 60 bits of
+ // the SHA-1 hash of the value of the BIT STRING
+ // subjectPublicKey (excluding the tag, length, and number of
+ // unused bits).
+
+ // Here we're using the first method
+
+ let result = Sha1::digest(issuer.subject_public_key.raw_bytes());
+ $out(result.as_slice())
+ }
+ }
+ }
+ };
+}
diff --git a/crates/x509-cert/src/name.rs b/crates/x509-cert/src/name.rs
new file mode 100644
index 0000000..ec62249
--- /dev/null
+++ b/crates/x509-cert/src/name.rs
@@ -0,0 +1,195 @@
+//! Name-related definitions as defined in X.501 (and updated by RFC 5280).
+
+use crate::attr::AttributeTypeAndValue;
+use alloc::vec::Vec;
+use core::{fmt, str::FromStr};
+use der::{asn1::SetOfVec, Encode};
+
+/// X.501 Name as defined in [RFC 5280 Section 4.1.2.4]. X.501 Name is used to represent distinguished names.
+///
+/// ```text
+/// Name ::= CHOICE { rdnSequence RDNSequence }
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
+pub type Name = RdnSequence;
+
+/// X.501 RDNSequence as defined in [RFC 5280 Section 4.1.2.4].
+///
+/// ```text
+/// RDNSequence ::= SEQUENCE OF RelativeDistinguishedName
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct RdnSequence(pub Vec<RelativeDistinguishedName>);
+
+impl RdnSequence {
+ /// Converts an `RDNSequence` string into an encoded `RDNSequence`.
+ #[deprecated(since = "0.2.1", note = "use RdnSequence::from_str(...)?.to_der()")]
+ pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
+ Self::from_str(s)?.to_der()
+ }
+
+ /// Is this [`RdnSequence`] empty?
+ pub fn is_empty(&self) -> bool {
+ self.0.is_empty()
+ }
+}
+
+/// Parse an [`RdnSequence`] string.
+///
+/// Follows the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl FromStr for RdnSequence {
+ type Err = der::Error;
+
+ fn from_str(s: &str) -> der::Result<Self> {
+ let mut parts = split(s, b',')
+ .map(RelativeDistinguishedName::from_str)
+ .collect::<der::Result<Vec<_>>>()?;
+ parts.reverse();
+ Ok(Self(parts))
+ }
+}
+
+/// Serializes the structure according to the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl fmt::Display for RdnSequence {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ // As per RFC 4514 Section 2.1, the elements are reversed
+ for (i, atv) in self.0.iter().rev().enumerate() {
+ match i {
+ 0 => write!(f, "{}", atv)?,
+ _ => write!(f, ",{}", atv)?,
+ }
+ }
+
+ Ok(())
+ }
+}
+
+impl_newtype!(RdnSequence, Vec<RelativeDistinguishedName>);
+
+/// Find the indices of all non-escaped separators.
+fn find(s: &str, b: u8) -> impl '_ + Iterator<Item = usize> {
+ (0..s.len())
+ .filter(move |i| s.as_bytes()[*i] == b)
+ .filter(|i| {
+ let x = i
+ .checked_sub(2)
+ .map(|i| s.as_bytes()[i])
+ .unwrap_or_default();
+
+ let y = i
+ .checked_sub(1)
+ .map(|i| s.as_bytes()[i])
+ .unwrap_or_default();
+
+ y != b'\\' || x == b'\\'
+ })
+}
+
+/// Split a string at all non-escaped separators.
+fn split(s: &str, b: u8) -> impl '_ + Iterator<Item = &'_ str> {
+ let mut prev = 0;
+ find(s, b).chain([s.len()].into_iter()).map(move |i| {
+ let x = &s[prev..i];
+ prev = i + 1;
+ x
+ })
+}
+
+/// X.501 DistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
+///
+/// ```text
+/// DistinguishedName ::= RDNSequence
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
+pub type DistinguishedName = RdnSequence;
+
+/// RelativeDistinguishedName as defined in [RFC 5280 Section 4.1.2.4].
+///
+/// ```text
+/// RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndValue
+/// ```
+///
+/// Note that we follow the more common definition above. This technically
+/// differs from the definition in X.501, which is:
+///
+/// ```text
+/// RelativeDistinguishedName ::= SET SIZE (1..MAX) OF AttributeTypeAndDistinguishedValue
+///
+/// AttributeTypeAndDistinguishedValue ::= SEQUENCE {
+/// type ATTRIBUTE.&id ({SupportedAttributes}),
+/// value ATTRIBUTE.&Type({SupportedAttributes}{@type}),
+/// primaryDistinguished BOOLEAN DEFAULT TRUE,
+/// valuesWithContext SET SIZE (1..MAX) OF SEQUENCE {
+/// distingAttrValue [0] ATTRIBUTE.&Type ({SupportedAttributes}{@type}) OPTIONAL,
+/// contextList SET SIZE (1..MAX) OF Context
+/// } OPTIONAL
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.4]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.4
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Clone, Debug, Default, PartialEq, Eq)]
+pub struct RelativeDistinguishedName(pub SetOfVec<AttributeTypeAndValue>);
+
+impl RelativeDistinguishedName {
+ /// Converts an RelativeDistinguishedName string into an encoded RelativeDistinguishedName
+ #[deprecated(
+ since = "0.2.1",
+ note = "use RelativeDistinguishedName::from_str(...)?.to_der()"
+ )]
+ pub fn encode_from_string(s: &str) -> Result<Vec<u8>, der::Error> {
+ Self::from_str(s)?.to_der()
+ }
+}
+
+/// Parse a [`RelativeDistinguishedName`] string.
+///
+/// This function follows the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl FromStr for RelativeDistinguishedName {
+ type Err = der::Error;
+
+ fn from_str(s: &str) -> der::Result<Self> {
+ split(s, b'+')
+ .map(AttributeTypeAndValue::from_str)
+ .collect::<der::Result<Vec<_>>>()?
+ .try_into()
+ .map(Self)
+ }
+}
+
+impl TryFrom<Vec<AttributeTypeAndValue>> for RelativeDistinguishedName {
+ type Error = der::Error;
+
+ fn try_from(vec: Vec<AttributeTypeAndValue>) -> der::Result<RelativeDistinguishedName> {
+ Ok(RelativeDistinguishedName(SetOfVec::try_from(vec)?))
+ }
+}
+
+/// Serializes the structure according to the rules in [RFC 4514].
+///
+/// [RFC 4514]: https://datatracker.ietf.org/doc/html/rfc4514
+impl fmt::Display for RelativeDistinguishedName {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ for (i, atv) in self.0.iter().enumerate() {
+ match i {
+ 0 => write!(f, "{}", atv)?,
+ _ => write!(f, "+{}", atv)?,
+ }
+ }
+
+ Ok(())
+ }
+}
+
+impl_newtype!(RelativeDistinguishedName, SetOfVec<AttributeTypeAndValue>);
diff --git a/crates/x509-cert/src/request.rs b/crates/x509-cert/src/request.rs
new file mode 100644
index 0000000..50478d8
--- /dev/null
+++ b/crates/x509-cert/src/request.rs
@@ -0,0 +1,191 @@
+//! PKCS#10 Certification Request types
+
+use crate::{
+ attr::{Attribute, AttributeValue, Attributes},
+ ext::Extension,
+ name::Name,
+};
+
+use alloc::vec::Vec;
+
+use const_oid::db::rfc5912::ID_EXTENSION_REQ;
+use const_oid::{AssociatedOid, ObjectIdentifier};
+use der::asn1::BitString;
+use der::{
+ asn1::{Any, SetOfVec},
+ Decode, Enumerated, Sequence,
+};
+use spki::{AlgorithmIdentifierOwned, SubjectPublicKeyInfoOwned};
+
+#[cfg(feature = "pem")]
+use der::pem::PemLabel;
+
+/// Version identifier for certification request information.
+///
+/// (RFC 2986 designates `0` as the only valid version)
+#[derive(Clone, Debug, Copy, PartialEq, Eq, Enumerated, Default)]
+#[asn1(type = "INTEGER")]
+#[repr(u8)]
+pub enum Version {
+ /// Denotes PKCS#8 v1
+ #[default]
+ V1 = 0,
+}
+
+/// PKCS#10 `CertificationRequestInfo` as defined in [RFC 2986 Section 4].
+///
+/// ```text
+/// CertificationRequestInfo ::= SEQUENCE {
+/// version INTEGER { v1(0) } (v1,...),
+/// subject Name,
+/// subjectPKInfo SubjectPublicKeyInfo{{ PKInfoAlgorithms }},
+/// attributes [0] Attributes{{ CRIAttributes }}
+/// }
+/// ```
+///
+/// [RFC 2986 Section 4]: https://datatracker.ietf.org/doc/html/rfc2986#section-4
+#[derive(Clone, Debug, PartialEq, Eq, Sequence)]
+pub struct CertReqInfo {
+ /// Certification request version.
+ pub version: Version,
+
+ /// Subject name.
+ pub subject: Name,
+
+ /// Subject public key info.
+ pub public_key: SubjectPublicKeyInfoOwned,
+
+ /// Request attributes.
+ #[asn1(context_specific = "0", tag_mode = "IMPLICIT")]
+ pub attributes: Attributes,
+}
+
+/// PKCS#10 `CertificationRequest` as defined in [RFC 2986 Section 4].
+///
+/// ```text
+/// CertificationRequest ::= SEQUENCE {
+/// certificationRequestInfo CertificationRequestInfo,
+/// signatureAlgorithm AlgorithmIdentifier{{ SignatureAlgorithms }},
+/// signature BIT STRING
+/// }
+/// ```
+///
+/// [RFC 2986 Section 4]: https://datatracker.ietf.org/doc/html/rfc2986#section-4
+#[derive(Clone, Debug, PartialEq, Eq, Sequence)]
+pub struct CertReq {
+ /// Certification request information.
+ pub info: CertReqInfo,
+
+ /// Signature algorithm identifier.
+ pub algorithm: AlgorithmIdentifierOwned,
+
+ /// Signature.
+ pub signature: BitString,
+}
+
+#[cfg(feature = "pem")]
+impl PemLabel for CertReq {
+ const PEM_LABEL: &'static str = "CERTIFICATE REQUEST";
+}
+
+impl<'a> TryFrom<&'a [u8]> for CertReq {
+ type Error = der::Error;
+
+ fn try_from(bytes: &'a [u8]) -> Result<Self, Self::Error> {
+ Self::from_der(bytes)
+ }
+}
+
+/// `ExtensionReq` as defined in [RFC 5272 Section 3.1].
+///
+/// ```text
+/// ExtensionReq ::= SEQUENCE SIZE (1..MAX) OF Extension
+/// ```
+///
+/// [RFC 5272 Section 3.1]: https://datatracker.ietf.org/doc/html/rfc5272#section-3.1
+#[derive(Clone, Debug, PartialEq, Eq, Default)]
+pub struct ExtensionReq(pub Vec<Extension>);
+
+impl AssociatedOid for ExtensionReq {
+ const OID: ObjectIdentifier = ID_EXTENSION_REQ;
+}
+
+impl_newtype!(ExtensionReq, Vec<Extension>);
+
+impl TryFrom<ExtensionReq> for Attribute {
+ type Error = der::Error;
+
+ fn try_from(extension_req: ExtensionReq) -> der::Result<Attribute> {
+ let mut values: SetOfVec<AttributeValue> = Default::default();
+ values.insert(Any::encode_from(&extension_req.0)?)?;
+
+ Ok(Attribute {
+ oid: ExtensionReq::OID,
+ values,
+ })
+ }
+}
+
+pub mod attributes {
+ //! Set of attributes that may be associated to a request
+
+ use alloc::vec;
+ use const_oid::AssociatedOid;
+ use der::{
+ asn1::{Any, ObjectIdentifier, SetOfVec},
+ EncodeValue, Length, Result, Tag, Tagged, Writer,
+ };
+
+ use crate::{attr::Attribute, ext::pkix::name::DirectoryString};
+
+ /// Trait to be implement by request attributes
+ pub trait AsAttribute: AssociatedOid + Tagged + EncodeValue + Sized {
+ /// Returns the Attribute with the content encoded.
+ fn to_attribute(&self) -> Result<Attribute> {
+ let inner: Any = der::asn1::Any::encode_from(self)?;
+
+ let values = SetOfVec::try_from(vec![inner])?;
+
+ Ok(Attribute {
+ oid: Self::OID,
+ values,
+ })
+ }
+ }
+
+ /// `ChallengePassword` as defined in [RFC 2985 Section 5.4.1]
+ ///
+ /// ```text
+ /// challengePassword ATTRIBUTE ::= {
+ /// WITH SYNTAX DirectoryString {pkcs-9-ub-challengePassword}
+ /// EQUALITY MATCHING RULE caseExactMatch
+ /// SINGLE VALUE TRUE
+ /// ID pkcs-9-at-challengePassword
+ /// }
+ /// ```
+ ///
+ /// [RFC 2985 Section 5.4.1]: https://www.rfc-editor.org/rfc/rfc2985#page-16
+ pub struct ChallengePassword(pub DirectoryString);
+
+ impl AsAttribute for ChallengePassword {}
+
+ impl AssociatedOid for ChallengePassword {
+ const OID: ObjectIdentifier = ObjectIdentifier::new_unwrap("1.2.840.113549.1.9.7");
+ }
+
+ impl Tagged for ChallengePassword {
+ fn tag(&self) -> Tag {
+ self.0.tag()
+ }
+ }
+
+ impl EncodeValue for ChallengePassword {
+ fn value_len(&self) -> Result<Length> {
+ self.0.value_len()
+ }
+
+ fn encode_value(&self, encoder: &mut impl Writer) -> Result<()> {
+ self.0.encode_value(encoder)
+ }
+ }
+}
diff --git a/crates/x509-cert/src/serial_number.rs b/crates/x509-cert/src/serial_number.rs
new file mode 100644
index 0000000..b14487a
--- /dev/null
+++ b/crates/x509-cert/src/serial_number.rs
@@ -0,0 +1,195 @@
+//! X.509 serial number
+
+use core::{fmt::Display, marker::PhantomData};
+
+use der::{
+ asn1::{self, Int},
+ DecodeValue, EncodeValue, ErrorKind, FixedTag, Header, Length, Reader, Result, Tag, ValueOrd,
+ Writer,
+};
+
+use crate::certificate::{Profile, Rfc5280};
+
+/// [RFC 5280 Section 4.1.2.2.] Serial Number
+///
+/// The serial number MUST be a positive integer assigned by the CA to
+/// each certificate. It MUST be unique for each certificate issued by a
+/// given CA (i.e., the issuer name and serial number identify a unique
+/// certificate). CAs MUST force the serialNumber to be a non-negative
+/// integer.
+///
+/// Given the uniqueness requirements above, serial numbers can be
+/// expected to contain long integers. Certificate users MUST be able to
+/// handle serialNumber values up to 20 octets. Conforming CAs MUST NOT
+/// use serialNumber values longer than 20 octets.
+///
+/// Note: Non-conforming CAs may issue certificates with serial numbers
+/// that are negative or zero. Certificate users SHOULD be prepared to
+/// gracefully handle such certificates.
+#[derive(Clone, Debug, Eq, PartialEq, ValueOrd, PartialOrd, Ord)]
+pub struct SerialNumber<P: Profile = Rfc5280> {
+ pub(crate) inner: Int,
+ _profile: PhantomData<P>,
+}
+
+impl<P: Profile> SerialNumber<P> {
+ /// Maximum length in bytes for a [`SerialNumber`]
+ pub const MAX_LEN: Length = Length::new(20);
+
+ /// See notes in `SerialNumber::new` and `SerialNumber::decode_value`.
+ pub(crate) const MAX_DECODE_LEN: Length = Length::new(21);
+
+ /// Create a new [`SerialNumber`] from a byte slice.
+ ///
+ /// The byte slice **must** represent a positive integer.
+ pub fn new(bytes: &[u8]) -> Result<Self> {
+ let inner = asn1::Uint::new(bytes)?;
+
+ // The user might give us a 20 byte unsigned integer with a high MSB,
+ // which we'd then encode with 21 octets to preserve the sign bit.
+ // RFC 5280 is ambiguous about whether this is valid, so we limit
+ // `SerialNumber` *encodings* to 20 bytes or fewer while permitting
+ // `SerialNumber` *decodings* to have up to 21 bytes below.
+ if inner.value_len()? > Self::MAX_LEN {
+ return Err(ErrorKind::Overlength.into());
+ }
+
+ Ok(Self {
+ inner: inner.into(),
+ _profile: PhantomData,
+ })
+ }
+
+ /// Borrow the inner byte slice which contains the least significant bytes
+ /// of a big endian integer value with all leading zeros stripped.
+ pub fn as_bytes(&self) -> &[u8] {
+ self.inner.as_bytes()
+ }
+}
+
+impl<P: Profile> EncodeValue for SerialNumber<P> {
+ fn value_len(&self) -> Result<Length> {
+ self.inner.value_len()
+ }
+
+ fn encode_value(&self, writer: &mut impl Writer) -> Result<()> {
+ self.inner.encode_value(writer)
+ }
+}
+
+impl<'a, P: Profile> DecodeValue<'a> for SerialNumber<P> {
+ fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
+ let inner = Int::decode_value(reader, header)?;
+ let serial = Self {
+ inner,
+ _profile: PhantomData,
+ };
+
+ P::check_serial_number(&serial)?;
+
+ Ok(serial)
+ }
+}
+
+impl<P: Profile> FixedTag for SerialNumber<P> {
+ const TAG: Tag = <Int as FixedTag>::TAG;
+}
+
+impl Display for SerialNumber {
+ fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+ let mut iter = self.as_bytes().iter().peekable();
+
+ while let Some(byte) = iter.next() {
+ match iter.peek() {
+ Some(_) => write!(f, "{:02X}:", byte)?,
+ None => write!(f, "{:02X}", byte)?,
+ }
+ }
+
+ Ok(())
+ }
+}
+
+macro_rules! impl_from {
+ ($source:ty) => {
+ impl From<$source> for SerialNumber {
+ fn from(inner: $source) -> SerialNumber {
+ let serial_number = &inner.to_be_bytes()[..];
+ let serial_number = asn1::Uint::new(serial_number).unwrap();
+
+ // This could only fail if the big endian representation was to be more than 20
+ // bytes long. Because it's only implemented for up to u64 / usize (8 bytes).
+ SerialNumber::new(serial_number.as_bytes()).unwrap()
+ }
+ }
+ };
+}
+
+impl_from!(u8);
+impl_from!(u16);
+impl_from!(u32);
+impl_from!(u64);
+impl_from!(usize);
+
+// Implement by hand because the derive would create invalid values.
+// Use the constructor to create a valid value.
+#[cfg(feature = "arbitrary")]
+impl<'a, P: Profile> arbitrary::Arbitrary<'a> for SerialNumber<P> {
+ fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
+ let len = u.int_in_range(0u32..=Self::MAX_LEN.into())?;
+
+ Self::new(u.bytes(len as usize)?).map_err(|_| arbitrary::Error::IncorrectFormat)
+ }
+
+ fn size_hint(depth: usize) -> (usize, Option<usize>) {
+ arbitrary::size_hint::and(u32::size_hint(depth), (0, None))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use alloc::string::ToString;
+
+ use super::*;
+
+ #[test]
+ fn serial_number_invariants() {
+ // Creating a new serial with an oversized encoding (due to high MSB) fails.
+ {
+ let too_big = [0x80; 20];
+ assert!(SerialNumber::<Rfc5280>::new(&too_big).is_err());
+ }
+
+ // Creating a new serial with the maximum encoding succeeds.
+ {
+ let just_enough = [
+ 0x7F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF,
+ ];
+ assert!(SerialNumber::<Rfc5280>::new(&just_enough).is_ok());
+ }
+ }
+
+ #[test]
+ fn serial_number_display() {
+ {
+ let sn = SerialNumber::new(&[0x11, 0x22, 0x33]).unwrap();
+
+ assert_eq!(sn.to_string(), "11:22:33")
+ }
+
+ {
+ let sn = SerialNumber::new(&[0xAA, 0xBB, 0xCC, 0x01, 0x10, 0x00, 0x11]).unwrap();
+
+ // We force the user's serial to be positive if they give us a negative one.
+ assert_eq!(sn.to_string(), "00:AA:BB:CC:01:10:00:11")
+ }
+
+ {
+ let sn = SerialNumber::new(&[0x00, 0x00, 0x01]).unwrap();
+
+ // Leading zeroes are ignored, due to canonicalization.
+ assert_eq!(sn.to_string(), "01")
+ }
+ }
+}
diff --git a/crates/x509-cert/src/time.rs b/crates/x509-cert/src/time.rs
new file mode 100644
index 0000000..c0ef8bf
--- /dev/null
+++ b/crates/x509-cert/src/time.rs
@@ -0,0 +1,156 @@
+//! X.501 time types as defined in RFC 5280
+
+use core::fmt;
+use core::time::Duration;
+use der::asn1::{GeneralizedTime, UtcTime};
+use der::{Choice, DateTime, Sequence, ValueOrd};
+
+#[cfg(feature = "std")]
+use std::time::SystemTime;
+
+/// X.501 `Time` as defined in [RFC 5280 Section 4.1.2.5].
+///
+/// Schema definition from [RFC 5280 Appendix A]:
+///
+/// ```text
+/// Time ::= CHOICE {
+/// utcTime UTCTime,
+/// generalTime GeneralizedTime
+/// }
+/// ```
+///
+/// [RFC 5280 Section 4.1.2.5]: https://tools.ietf.org/html/rfc5280#section-4.1.2.5
+/// [RFC 5280 Appendix A]: https://tools.ietf.org/html/rfc5280#page-117
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Choice, Copy, Clone, Debug, Eq, PartialEq, ValueOrd)]
+pub enum Time {
+ /// Legacy UTC time (has 2-digit year, valid from 1970 to 2049).
+ ///
+ /// Note: RFC 5280 specifies 1950-2049, however due to common operations working on
+ /// `UNIX_EPOCH` this implementation's lower bound is 1970.
+ #[asn1(type = "UTCTime")]
+ UtcTime(UtcTime),
+
+ /// Modern [`GeneralizedTime`] encoding with 4-digit year.
+ #[asn1(type = "GeneralizedTime")]
+ GeneralTime(GeneralizedTime),
+}
+
+impl Time {
+ /// Time used for Certificate who do not expire.
+ pub const INFINITY: Time =
+ Time::GeneralTime(GeneralizedTime::from_date_time(DateTime::INFINITY));
+
+ /// Get duration since `UNIX_EPOCH`.
+ pub fn to_unix_duration(self) -> Duration {
+ match self {
+ Time::UtcTime(t) => t.to_unix_duration(),
+ Time::GeneralTime(t) => t.to_unix_duration(),
+ }
+ }
+
+ /// Get Time as DateTime
+ pub fn to_date_time(&self) -> DateTime {
+ match self {
+ Time::UtcTime(t) => t.to_date_time(),
+ Time::GeneralTime(t) => t.to_date_time(),
+ }
+ }
+
+ /// Convert to [`SystemTime`].
+ #[cfg(feature = "std")]
+ pub fn to_system_time(&self) -> SystemTime {
+ match self {
+ Time::UtcTime(t) => t.to_system_time(),
+ Time::GeneralTime(t) => t.to_system_time(),
+ }
+ }
+
+ /// Convert time to UTCTime representation
+ /// As per RFC 5280: 4.1.2.5, date through 2049 should be expressed as UTC Time.
+ #[cfg(feature = "builder")]
+ pub(crate) fn rfc5280_adjust_utc_time(&mut self) -> der::Result<()> {
+ if let Time::GeneralTime(t) = self {
+ let date = t.to_date_time();
+ if date.year() <= UtcTime::MAX_YEAR {
+ *self = Time::UtcTime(UtcTime::from_date_time(date)?);
+ }
+ }
+
+ Ok(())
+ }
+}
+
+impl fmt::Display for Time {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}", self.to_date_time())
+ }
+}
+
+impl From<UtcTime> for Time {
+ fn from(time: UtcTime) -> Time {
+ Time::UtcTime(time)
+ }
+}
+
+impl From<GeneralizedTime> for Time {
+ fn from(time: GeneralizedTime) -> Time {
+ Time::GeneralTime(time)
+ }
+}
+
+#[cfg(feature = "std")]
+impl From<Time> for SystemTime {
+ fn from(time: Time) -> SystemTime {
+ time.to_system_time()
+ }
+}
+
+#[cfg(feature = "std")]
+impl From<&Time> for SystemTime {
+ fn from(time: &Time) -> SystemTime {
+ time.to_system_time()
+ }
+}
+
+#[cfg(feature = "std")]
+impl TryFrom<SystemTime> for Time {
+ type Error = der::Error;
+
+ fn try_from(time: SystemTime) -> der::Result<Time> {
+ Ok(GeneralizedTime::try_from(time)?.into())
+ }
+}
+
+/// X.501 `Validity` as defined in [RFC 5280 Section 4.1.2.5]
+///
+/// ```text
+/// Validity ::= SEQUENCE {
+/// notBefore Time,
+/// notAfter Time
+/// }
+/// ```
+/// [RFC 5280 Section 4.1.2.5]: https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5
+#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
+#[derive(Copy, Clone, Debug, Eq, PartialEq, Sequence, ValueOrd)]
+pub struct Validity {
+ /// notBefore value
+ pub not_before: Time,
+
+ /// notAfter value
+ pub not_after: Time,
+}
+
+impl Validity {
+ /// Creates a `Validity` which starts now and lasts for `duration`.
+ #[cfg(feature = "std")]
+ pub fn from_now(duration: Duration) -> der::Result<Self> {
+ let now = SystemTime::now();
+ let then = now + duration;
+
+ Ok(Self {
+ not_before: Time::try_from(now)?,
+ not_after: Time::try_from(then)?,
+ })
+ }
+}
diff --git a/crates/x509-cert/tests/builder.rs b/crates/x509-cert/tests/builder.rs
new file mode 100644
index 0000000..06aae51
--- /dev/null
+++ b/crates/x509-cert/tests/builder.rs
@@ -0,0 +1,315 @@
+#![cfg(all(feature = "builder", feature = "pem"))]
+
+use der::{asn1::PrintableString, pem::LineEnding, Decode, Encode, EncodePem};
+use p256::{ecdsa::DerSignature, pkcs8::DecodePrivateKey, NistP256};
+use rsa::pkcs1::DecodeRsaPrivateKey;
+use rsa::pkcs1v15::SigningKey;
+use sha2::Sha256;
+use spki::SubjectPublicKeyInfoOwned;
+use std::{str::FromStr, time::Duration};
+use x509_cert::{
+ builder::{Builder, CertificateBuilder, Profile, RequestBuilder},
+ ext::pkix::{
+ name::{DirectoryString, GeneralName},
+ SubjectAltName,
+ },
+ name::Name,
+ request,
+ serial_number::SerialNumber,
+ time::Validity,
+};
+use x509_cert_test_support::{openssl, zlint};
+
+const RSA_2048_DER_EXAMPLE: &[u8] = include_bytes!("examples/rsa2048-pub.der");
+const PKCS8_PUBLIC_KEY_DER: &[u8] = include_bytes!("examples/p256-pub.der");
+
+#[test]
+fn root_ca_certificate() {
+ let serial_number = SerialNumber::from(42u32);
+ let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+ let profile = Profile::Root;
+ let subject = Name::from_str("CN=World domination corporation,O=World domination Inc,C=US")
+ .unwrap()
+ .to_der()
+ .unwrap();
+ let subject = Name::from_der(&subject).unwrap();
+ let pub_key =
+ SubjectPublicKeyInfoOwned::try_from(RSA_2048_DER_EXAMPLE).expect("get rsa pub key");
+
+ let signer = rsa_signer();
+ let builder =
+ CertificateBuilder::new(profile, serial_number, validity, subject, pub_key, &signer)
+ .expect("Create certificate");
+
+ let certificate = builder.build().unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ let ignored = &[];
+ zlint::check_certificate(pem.as_bytes(), ignored);
+}
+
+#[test]
+fn root_ca_certificate_ecdsa() {
+ let serial_number = SerialNumber::from(42u32);
+ let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+ let profile = Profile::Root;
+ let subject = Name::from_str("CN=World domination corporation,O=World domination Inc,C=US")
+ .unwrap()
+ .to_der()
+ .unwrap();
+ let subject = Name::from_der(&subject).unwrap();
+ let pub_key =
+ SubjectPublicKeyInfoOwned::try_from(PKCS8_PUBLIC_KEY_DER).expect("get ecdsa pub key");
+
+ let signer = ecdsa_signer();
+ let builder =
+ CertificateBuilder::new(profile, serial_number, validity, subject, pub_key, &signer)
+ .expect("Create certificate");
+
+ let certificate = builder.build::<DerSignature>().unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ let ignored = &[];
+ zlint::check_certificate(pem.as_bytes(), ignored);
+}
+
+#[test]
+fn sub_ca_certificate() {
+ let serial_number = SerialNumber::from(42u32);
+ let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+
+ let issuer =
+ Name::from_str("CN=World domination corporation,O=World domination Inc,C=US").unwrap();
+ let profile = Profile::SubCA {
+ issuer,
+ path_len_constraint: Some(0),
+ };
+
+ let subject =
+ Name::from_str("CN=World domination task force,O=World domination Inc,C=US").unwrap();
+ let pub_key =
+ SubjectPublicKeyInfoOwned::try_from(RSA_2048_DER_EXAMPLE).expect("get rsa pub key");
+
+ let signer = ecdsa_signer();
+ let builder =
+ CertificateBuilder::new(profile, serial_number, validity, subject, pub_key, &signer)
+ .expect("Create certificate");
+
+ let certificate = builder.build::<DerSignature>().unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ // TODO(baloo): not too sure we should tackle those in this API.
+ let ignored = &[
+ "w_sub_ca_aia_missing",
+ "e_sub_ca_crl_distribution_points_missing",
+ "e_sub_ca_certificate_policies_missing",
+ "w_sub_ca_aia_does_not_contain_issuing_ca_url",
+ ];
+
+ zlint::check_certificate(pem.as_bytes(), ignored);
+}
+
+#[test]
+fn leaf_certificate() {
+ let serial_number = SerialNumber::from(42u32);
+ let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+
+ let issuer =
+ Name::from_str("CN=World domination corporation,O=World domination Inc,C=US").unwrap();
+ let profile = Profile::Leaf {
+ issuer: issuer.clone(),
+ enable_key_agreement: false,
+ enable_key_encipherment: false,
+ #[cfg(feature = "hazmat")]
+ include_subject_key_identifier: true,
+ };
+
+ let subject = Name::from_str("CN=service.domination.world").unwrap();
+ let pub_key =
+ SubjectPublicKeyInfoOwned::try_from(RSA_2048_DER_EXAMPLE).expect("get rsa pub key");
+
+ let signer = ecdsa_signer();
+ let builder = CertificateBuilder::new(
+ profile,
+ serial_number.clone(),
+ validity.clone(),
+ subject.clone(),
+ pub_key.clone(),
+ &signer,
+ )
+ .expect("Create certificate");
+
+ let certificate = builder.build::<DerSignature>().unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ // TODO(baloo): not too sure we should tackle those in this API.
+ let ignored = vec![
+ "e_sub_cert_aia_missing",
+ "e_sub_cert_crl_distribution_points_missing",
+ "w_sub_cert_aia_does_not_contain_issuing_ca_url",
+ // Missing policies
+ "e_sub_cert_certificate_policies_missing",
+ "e_sub_cert_cert_policy_empty",
+ // Needs to be added by the end-user
+ "e_sub_cert_aia_does_not_contain_ocsp_url",
+ // SAN needs to include DNS name (if used)
+ "e_ext_san_missing",
+ "e_subject_common_name_not_exactly_from_san",
+ // Extended key usage needs to be added by end-user and is use-case dependent
+ "e_sub_cert_eku_missing",
+ ];
+
+ zlint::check_certificate(pem.as_bytes(), &ignored);
+
+ #[cfg(feature = "hazmat")]
+ {
+ let profile = Profile::Leaf {
+ issuer,
+ enable_key_agreement: false,
+ enable_key_encipherment: false,
+ include_subject_key_identifier: false,
+ };
+ let builder =
+ CertificateBuilder::new(profile, serial_number, validity, subject, pub_key, &signer)
+ .expect("Create certificate");
+
+ let certificate = builder.build::<DerSignature>().unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ // Ignore warning about leaf not having SKI extension (this is a warning not a fail, as
+ // denoted by the `w_` prefix.
+ let mut ignored = ignored;
+ ignored.push("w_ext_subject_key_identifier_missing_sub_cert");
+ zlint::check_certificate(pem.as_bytes(), &ignored);
+ }
+}
+
+#[test]
+fn pss_certificate() {
+ let serial_number = SerialNumber::from(42u32);
+ let validity = Validity::from_now(Duration::new(5, 0)).unwrap();
+
+ let issuer =
+ Name::from_str("CN=World domination corporation,O=World domination Inc,C=US").unwrap();
+ let profile = Profile::Leaf {
+ issuer,
+ enable_key_agreement: false,
+ enable_key_encipherment: false,
+ #[cfg(feature = "hazmat")]
+ include_subject_key_identifier: true,
+ };
+
+ let subject = Name::from_str("CN=service.domination.world").unwrap();
+ let pub_key =
+ SubjectPublicKeyInfoOwned::try_from(RSA_2048_DER_EXAMPLE).expect("get rsa pub key");
+
+ let signer = rsa_pss_signer();
+ let builder =
+ CertificateBuilder::new(profile, serial_number, validity, subject, pub_key, &signer)
+ .expect("Create certificate");
+
+ let certificate = builder
+ .build_with_rng::<rsa::pss::Signature>(&mut rand::thread_rng())
+ .unwrap();
+
+ let pem = certificate.to_pem(LineEnding::LF).expect("generate pem");
+ println!("{}", openssl::check_certificate(pem.as_bytes()));
+
+ // TODO(baloo): not too sure we should tackle those in this API.
+ let ignored = &[
+ "e_sub_cert_aia_missing",
+ "e_sub_cert_crl_distribution_points_missing",
+ "w_sub_cert_aia_does_not_contain_issuing_ca_url",
+ // Missing policies
+ "e_sub_cert_certificate_policies_missing",
+ "e_sub_cert_cert_policy_empty",
+ // Needs to be added by the end-user
+ "e_sub_cert_aia_does_not_contain_ocsp_url",
+ // SAN needs to include DNS name (if used)
+ "e_ext_san_missing",
+ "e_subject_common_name_not_exactly_from_san",
+ // Extended key usage needs to be added by end-user and is use-case dependent
+ "e_sub_cert_eku_missing",
+ // zlint warns on RSAPSS signature algorithms
+ "e_signature_algorithm_not_supported",
+ ];
+
+ zlint::check_certificate(pem.as_bytes(), ignored);
+}
+
+const RSA_2048_PRIV_DER_EXAMPLE: &[u8] = include_bytes!("examples/rsa2048-priv.der");
+
+fn rsa_signer() -> SigningKey<Sha256> {
+ let private_key = rsa::RsaPrivateKey::from_pkcs1_der(RSA_2048_PRIV_DER_EXAMPLE).unwrap();
+ let signing_key = SigningKey::<Sha256>::new(private_key);
+ signing_key
+}
+
+fn rsa_pss_signer() -> rsa::pss::SigningKey<Sha256> {
+ let private_key = rsa::RsaPrivateKey::from_pkcs1_der(RSA_2048_PRIV_DER_EXAMPLE).unwrap();
+ let signing_key = rsa::pss::SigningKey::<Sha256>::new(private_key);
+ signing_key
+}
+
+const PKCS8_PRIVATE_KEY_DER: &[u8] = include_bytes!("examples/p256-priv.der");
+
+fn ecdsa_signer() -> ecdsa::SigningKey<NistP256> {
+ let secret_key = p256::SecretKey::from_pkcs8_der(PKCS8_PRIVATE_KEY_DER).unwrap();
+ ecdsa::SigningKey::from(secret_key)
+}
+
+#[test]
+fn certificate_request() {
+ use std::net::{IpAddr, Ipv4Addr};
+ let subject = Name::from_str("CN=service.domination.world").unwrap();
+
+ let signer = ecdsa_signer();
+ let mut builder = RequestBuilder::new(subject, &signer).expect("Create certificate request");
+ builder
+ .add_extension(&SubjectAltName(vec![GeneralName::from(IpAddr::V4(
+ Ipv4Addr::new(192, 0, 2, 0),
+ ))]))
+ .unwrap();
+
+ let cert_req = builder.build::<DerSignature>().unwrap();
+ let pem = cert_req.to_pem(LineEnding::LF).expect("generate pem");
+ use std::fs::File;
+ use std::io::Write;
+ let mut file = File::create("/tmp/ecdsa.csr").expect("create pem file");
+ file.write_all(pem.as_bytes()).expect("Create pem file");
+ println!("{}", openssl::check_request(pem.as_bytes()));
+}
+
+#[test]
+fn certificate_request_attributes() {
+ let subject = Name::from_str("CN=service.domination.world").unwrap();
+
+ let signer = ecdsa_signer();
+ let mut builder = RequestBuilder::new(subject, &signer).expect("Create certificate request");
+ builder
+ .add_attribute(&request::attributes::ChallengePassword(
+ DirectoryString::PrintableString(
+ PrintableString::new(b"password1234")
+ .expect("create printable string with password"),
+ ),
+ ))
+ .expect("unable to add attribute");
+
+ let cert_req = builder.build::<DerSignature>().unwrap();
+ let pem = cert_req.to_pem(LineEnding::LF).expect("generate pem");
+ use std::fs::File;
+ use std::io::Write;
+ let mut file = File::create("/tmp/ecdsa.csr").expect("create pem file");
+ file.write_all(pem.as_bytes()).expect("Create pem file");
+ println!("{}", openssl::check_request(pem.as_bytes()));
+}
diff --git a/crates/x509-cert/tests/certificate.rs b/crates/x509-cert/tests/certificate.rs
new file mode 100644
index 0000000..e5b3243
--- /dev/null
+++ b/crates/x509-cert/tests/certificate.rs
@@ -0,0 +1,467 @@
+//! Certificate tests
+
+use der::{
+ asn1::{BitStringRef, ContextSpecific, ObjectIdentifier, PrintableStringRef, Utf8StringRef},
+ Decode, DecodeValue, Encode, FixedTag, Header, Reader, Tag, Tagged,
+};
+use hex_literal::hex;
+use spki::AlgorithmIdentifierRef;
+use x509_cert::serial_number::SerialNumber;
+use x509_cert::Certificate;
+use x509_cert::*;
+
+#[cfg(feature = "pem")]
+use der::DecodePem;
+
+// TODO - parse and compare extension values
+const EXTENSIONS: &[(&str, bool)] = &[
+ ("2.5.29.15", true),
+ ("2.5.29.19", true),
+ ("2.5.29.33", false),
+ ("2.5.29.32", false),
+ ("2.5.29.14", false),
+ ("2.5.29.31", false),
+ ("1.3.6.1.5.5.7.1.11", false),
+ ("1.3.6.1.5.5.7.1.1", false),
+ ("2.5.29.54", false),
+ ("2.5.29.35", false),
+];
+
+///Structure supporting deferred decoding of fields in the Certificate SEQUENCE
+pub struct DeferDecodeCertificate<'a> {
+ /// tbsCertificate TBSCertificate,
+ pub tbs_certificate: &'a [u8],
+ /// signatureAlgorithm AlgorithmIdentifier,
+ pub signature_algorithm: &'a [u8],
+ /// signature BIT STRING
+ pub signature: &'a [u8],
+}
+
+impl<'a> DecodeValue<'a> for DeferDecodeCertificate<'a> {
+ fn decode_value<R: Reader<'a>>(
+ reader: &mut R,
+ header: Header,
+ ) -> der::Result<DeferDecodeCertificate<'a>> {
+ reader.read_nested(header.length, |reader| {
+ Ok(Self {
+ tbs_certificate: reader.tlv_bytes()?,
+ signature_algorithm: reader.tlv_bytes()?,
+ signature: reader.tlv_bytes()?,
+ })
+ })
+ }
+}
+
+impl FixedTag for DeferDecodeCertificate<'_> {
+ const TAG: Tag = Tag::Sequence;
+}
+
+///Structure supporting deferred decoding of fields in the TBSCertificate SEQUENCE
+pub struct DeferDecodeTbsCertificate<'a> {
+ /// Decoded field
+ pub version: u8,
+ /// Defer decoded field
+ pub serial_number: &'a [u8],
+ /// Defer decoded field
+ pub signature: &'a [u8],
+ /// Defer decoded field
+ pub issuer: &'a [u8],
+ /// Defer decoded field
+ pub validity: &'a [u8],
+ /// Defer decoded field
+ pub subject: &'a [u8],
+ /// Defer decoded field
+ pub subject_public_key_info: &'a [u8],
+ /// Decoded field (never present)
+ pub issuer_unique_id: Option<BitStringRef<'a>>,
+ /// Decoded field (never present)
+ pub subject_unique_id: Option<BitStringRef<'a>>,
+ /// Defer decoded field
+ pub extensions: &'a [u8],
+}
+
+impl<'a> DecodeValue<'a> for DeferDecodeTbsCertificate<'a> {
+ fn decode_value<R: Reader<'a>>(
+ reader: &mut R,
+ header: Header,
+ ) -> der::Result<DeferDecodeTbsCertificate<'a>> {
+ reader.read_nested(header.length, |reader| {
+ let version = ContextSpecific::decode_explicit(reader, ::der::TagNumber::N0)?
+ .map(|cs| cs.value)
+ .unwrap_or_else(Default::default);
+
+ Ok(Self {
+ version,
+ serial_number: reader.tlv_bytes()?,
+ signature: reader.tlv_bytes()?,
+ issuer: reader.tlv_bytes()?,
+ validity: reader.tlv_bytes()?,
+ subject: reader.tlv_bytes()?,
+ subject_public_key_info: reader.tlv_bytes()?,
+ issuer_unique_id: reader.decode()?,
+ subject_unique_id: reader.decode()?,
+ extensions: reader.tlv_bytes()?,
+ })
+ })
+ }
+}
+
+impl FixedTag for DeferDecodeTbsCertificate<'_> {
+ const TAG: Tag = Tag::Sequence;
+}
+
+#[test]
+fn reencode_cert() {
+ let der_encoded_cert =
+ include_bytes!("examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der");
+ let defer_cert = DeferDecodeCertificate::from_der(der_encoded_cert).unwrap();
+
+ let parsed_tbs = TbsCertificate::from_der(defer_cert.tbs_certificate).unwrap();
+ let reencoded_tbs = parsed_tbs.to_der().unwrap();
+ assert_eq!(defer_cert.tbs_certificate, reencoded_tbs);
+
+ let parsed_sigalg = AlgorithmIdentifierRef::from_der(defer_cert.signature_algorithm).unwrap();
+ let reencoded_sigalg = parsed_sigalg.to_der().unwrap();
+ assert_eq!(defer_cert.signature_algorithm, reencoded_sigalg);
+
+ let parsed_sig = BitStringRef::from_der(defer_cert.signature).unwrap();
+ let reencoded_sig = parsed_sig.to_der().unwrap();
+ assert_eq!(defer_cert.signature, reencoded_sig);
+
+ let parsed_coverage_tbs =
+ DeferDecodeTbsCertificate::from_der(defer_cert.tbs_certificate).unwrap();
+
+ // TODO - defer decode then re-encode version field
+
+ let encoded_serial = parsed_tbs.serial_number.to_der().unwrap();
+ assert_eq!(parsed_coverage_tbs.serial_number, encoded_serial);
+
+ let encoded_signature = parsed_tbs.signature.to_der().unwrap();
+ assert_eq!(parsed_coverage_tbs.signature, encoded_signature);
+
+ let encoded_issuer = parsed_tbs.issuer.to_der().unwrap();
+ assert_eq!(parsed_coverage_tbs.issuer, encoded_issuer);
+
+ let encoded_validity = parsed_tbs.validity.to_der().unwrap();
+ assert_eq!(parsed_coverage_tbs.validity, encoded_validity);
+
+ let encoded_subject = parsed_tbs.subject.to_der().unwrap();
+ assert_eq!(parsed_coverage_tbs.subject, encoded_subject);
+
+ let encoded_subject_public_key_info = parsed_tbs.subject_public_key_info.to_der().unwrap();
+ assert_eq!(
+ parsed_coverage_tbs.subject_public_key_info,
+ encoded_subject_public_key_info
+ );
+
+ // TODO - either encode as context specific or decode to sequence. for know lop off context
+ // specific tag and length
+ let encoded_extensions = parsed_tbs.extensions.to_der().unwrap();
+ assert_eq!(&parsed_coverage_tbs.extensions[4..], encoded_extensions);
+}
+
+#[test]
+fn decode_oversized_oids() {
+ let o1parse = ObjectIdentifier::from_der(&hex!(
+ "06252B060104018237150885C8B86B87AFF00383A99F3C96C34081ADE6494D82B0E91D85B2873D"
+ ))
+ .unwrap();
+ let o1str = o1parse.to_string();
+ assert_eq!(
+ o1str,
+ "1.3.6.1.4.1.311.21.8.11672683.15464451.6967228.369088.2847561.77.4994205.11305917"
+ );
+ let o1 = ObjectIdentifier::new_unwrap(
+ "1.3.6.1.4.1.311.21.8.11672683.15464451.6967228.369088.2847561.77.4994205.11305917",
+ );
+ assert_eq!(
+ o1.to_string(),
+ "1.3.6.1.4.1.311.21.8.11672683.15464451.6967228.369088.2847561.77.4994205.11305917"
+ );
+ let enc_oid = o1.to_der().unwrap();
+ assert_eq!(
+ &hex!("06252B060104018237150885C8B86B87AFF00383A99F3C96C34081ADE6494D82B0E91D85B2873D"),
+ enc_oid.as_slice()
+ );
+}
+
+#[test]
+fn decode_cert() {
+ // cloned cert with variety of interesting bits, including subject DN encoded backwards, large
+ // policy mapping set, large policy set (including one with qualifiers), fairly typical set of
+ // extensions otherwise
+ let der_encoded_cert =
+ include_bytes!("examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ println!("{:?}", cert);
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ for (ext, (oid, crit)) in exts.iter().zip(EXTENSIONS) {
+ assert_eq!(ext.extn_id.to_string(), *oid);
+ assert_eq!(ext.critical, *crit);
+ }
+
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+
+ assert_eq!(cert.tbs_certificate.version, Version::V3);
+ let target_serial: [u8; 16] = [
+ 0x7F, 0x00, 0x00, 0x01, 0x00, 0x00, 0x01, 0x49, 0xCF, 0x70, 0x66, 0x4D, 0x00, 0x00, 0x00,
+ 0x02,
+ ];
+ assert_eq!(
+ cert.tbs_certificate.serial_number,
+ SerialNumber::new(&target_serial).unwrap()
+ );
+ assert_eq!(
+ cert.tbs_certificate.signature.oid.to_string(),
+ "1.2.840.113549.1.1.11"
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .signature
+ .parameters
+ .as_ref()
+ .unwrap()
+ .tag(),
+ Tag::Null
+ );
+ assert!(cert
+ .tbs_certificate
+ .signature
+ .parameters
+ .as_ref()
+ .unwrap()
+ .is_null());
+
+ let mut counter = 0;
+ let i = cert.tbs_certificate.issuer.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Mock"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ Utf8StringRef::try_from(&atav.value).unwrap().to_string(),
+ "IdenTrust Services LLC"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ Utf8StringRef::try_from(&atav.value).unwrap().to_string(),
+ "PTE IdenTrust Global Common Root CA 1"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ assert_eq!(
+ cert.tbs_certificate
+ .validity
+ .not_before
+ .to_unix_duration()
+ .as_secs(),
+ 1416524490
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .validity
+ .not_after
+ .to_unix_duration()
+ .as_secs(),
+ 1516628593
+ );
+
+ counter = 0;
+ let i = cert.tbs_certificate.subject.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ // Yes, this cert features RDNs encoded in reverse order
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Test Federal Bridge CA"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "TestFPKI"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "U.S. Government"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ assert_eq!(
+ cert.tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .oid
+ .to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .parameters
+ .as_ref()
+ .unwrap()
+ .tag(),
+ Tag::Null
+ );
+ assert!(cert
+ .tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .parameters
+ .as_ref()
+ .unwrap()
+ .is_null());
+
+ // TODO - parse and compare public key
+
+ let exts = cert.tbs_certificate.extensions.as_ref().unwrap();
+ for (ext, (oid, crit)) in exts.iter().zip(EXTENSIONS) {
+ assert_eq!(ext.extn_id.to_string(), *oid);
+ assert_eq!(ext.critical, *crit);
+ }
+
+ assert_eq!(
+ cert.signature_algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.11"
+ );
+ assert_eq!(
+ cert.signature_algorithm.parameters.as_ref().unwrap().tag(),
+ Tag::Null
+ );
+ assert!(cert
+ .signature_algorithm
+ .parameters
+ .as_ref()
+ .unwrap()
+ .is_null());
+
+ assert_eq!(
+ &hex!("2A892F357BF3EF19E1211986106803FA18E66237802F1B1B0C6756CE678DB01D72CD0A4EB7171C2CDDF110ACD38AA65C35699E869C219AD7550AA4F287BB784F72EF8C9EA0E3DD103EFE5BF182EA36FFBCB45AAE65840263680534789C4F3215AF5454AD48CBC4B7A881E0135401A0BD5A849C11101DD1C66178E762C00DF59DD50F8DE9ED46FC6A0D742AE5697D87DD08DAC5291A75FB13C82FF2865C9E36799EA726137E1814E6A878C9532E8FC3D0A2A942D1CCC668FFCEAC255E6002FDE5ACDF2CE47556BB141C3A797A4BFDB673F6F1C229D7914FFEEF1505EE36F8038137D1B8F90106994BAB3E6FF0F60360A2E32F7A30B7ECEC1502DF3CC725BD6E436BA8F96A1847C9CEBB3F5A5906472292501D59BE1A98475BB1F30B677FAA8A45E351640C85B1B22661D33BD23EC6C0CA33DDD79E1120C7FC869EC4D0175ADB4A258AEAC5E8D2F0F578B8BF4B2C5DCC3269768AAA5B9E26D0592C5BB09C702C72E0A60F66D3EEB2B4983279634D59B0A2011B0E26AE796CC95D3243DF49615434E5CC06C374C3F936C005D360CAE6101F3AE7E97E29A157F5020770D4648D7877EBF8248CF3F3E68F9957A36F92D50616F2C60D3842327EF9BC0312CFF03A48C78E97254C2ADEADCA05069168443D833831FF66295A2EED685F164F1DBE01F8C897E1F63D42851682CBEE7B5A64D7BA2923D33644DBF1F7B3EDCE996F9928F043"),
+ cert.signature.raw_bytes()
+ );
+
+ #[cfg(feature = "pem")]
+ {
+ let pem_encoded_cert =
+ include_bytes!("examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.pem");
+ let result = Certificate::from_pem(pem_encoded_cert);
+ let pem_cert: Certificate = result.unwrap();
+
+ assert_eq!(pem_cert, cert);
+ }
+}
+
+#[test]
+fn decode_cert_negative_serial_number() {
+ let der_encoded_cert = include_bytes!("examples/28903a635b5280fae6774c0b6da7d6baa64af2e8.der");
+
+ let cert = Certificate::from_der(der_encoded_cert).unwrap();
+ assert_eq!(
+ cert.tbs_certificate.serial_number.as_bytes(),
+ // INTEGER (125 bit) -2.370157924795571e+37
+ &[238, 43, 61, 235, 212, 33, 222, 20, 168, 98, 172, 4, 243, 221, 196, 1]
+ );
+
+ let reencoded = cert.to_der().unwrap();
+ assert_eq!(der_encoded_cert, reencoded.as_slice());
+}
+
+#[cfg(all(feature = "pem", feature = "hazmat"))]
+#[test]
+fn decode_cert_overlength_serial_number() {
+ use der::{pem::LineEnding, DecodePem, EncodePem};
+ use x509_cert::certificate::CertificateInner;
+
+ let pem_encoded_cert = include_bytes!("examples/qualcomm.pem");
+
+ assert!(Certificate::from_pem(pem_encoded_cert).is_err());
+
+ let cert = CertificateInner::<x509_cert::certificate::Raw>::from_pem(pem_encoded_cert).unwrap();
+ assert_eq!(
+ cert.tbs_certificate.serial_number.as_bytes(),
+ &[
+ 0, 132, 206, 11, 246, 160, 254, 130, 78, 229, 229, 6, 202, 168, 157, 120, 198, 21, 1,
+ 98, 87, 113
+ ]
+ );
+ assert_eq!(cert.tbs_certificate.serial_number.as_bytes().len(), 22);
+
+ let reencoded = cert.to_pem(LineEnding::LF).unwrap();
+ assert_eq!(pem_encoded_cert, reencoded.as_bytes());
+}
+
+#[cfg(all(feature = "pem"))]
+#[test]
+fn load_certificate_chains() {
+ let pem_encoded_chain = include_bytes!("examples/crates.io-chain.pem");
+
+ let chain = Certificate::load_pem_chain(pem_encoded_chain).expect("parse certificate chain");
+
+ assert_eq!(chain.len(), 4, "4 certificates are expected in this chain");
+}
+
+#[cfg(feature = "arbitrary")]
+#[test]
+// Purpose of this check is to ensure the arbitraty trait is provided for certificate variants
+#[allow(unused)]
+fn certificate_arbitrary() {
+ fn check_arbitrary<'a>(_arbitrary: impl arbitrary::Arbitrary<'a>) {}
+
+ fn check_certificate(certificate: x509_cert::Certificate) {
+ check_arbitrary(certificate);
+ }
+
+ #[cfg(feature = "hazmat")]
+ fn check_raw_certificate(
+ certificate: x509_cert::certificate::CertificateInner<x509_cert::certificate::Raw>,
+ ) {
+ check_arbitrary(certificate);
+ }
+}
diff --git a/crates/x509-cert/tests/certreq.rs b/crates/x509-cert/tests/certreq.rs
new file mode 100644
index 0000000..82ce41c
--- /dev/null
+++ b/crates/x509-cert/tests/certreq.rs
@@ -0,0 +1,87 @@
+//! Certification request (`CertReq`) tests
+
+use der::asn1::{PrintableStringRef, Utf8StringRef};
+use der::{Decode, Encode, Tag, Tagged};
+use hex_literal::hex;
+use x509_cert::request::{CertReq, Version};
+
+const RSA_KEY: &[u8] = &hex!("3082010A0282010100BF59F7FE716DDE47C73579CA846EFA8D30AB3612E0D6A524204A72CA8E50C9F459513DF0D73331BED3D7A2DA7A362719E471EE6A9D87827D1024ED44605AB9B48F3B808C5E173B9F3EC4003D57F1718489F5C7A0421C46FBD527A40AB4BA6B9DB16A545D1ECF6E2A5633BD80594EBA4AFEE71F63E1D357C64E9A3FF6B83746A885C373F3527987E4C2B4AF7FE4D4EA16405E5E15285DD938823AA18E2634BAFE847A761CAFABB0401D3FA03A07A9D097CBB0C77156CCFE36131DADF1C109C2823972F0AF21A35F358E788304C0C78B951739D91FABFFD07AA8CD4F69746B3D0EB4587469F9D39F4FBDC761200DFB27DAF69562311D8B191B7EEFAAE2F8D6F8EB0203010001");
+const RSA_SIG: &[u8] = &hex!("2B053CFE81C6542176BD70B373A5FC8DC1F1806A5AB10D25E36690EED1DF57AD5F18EC0CCF165F000245B14157141224B431EC6715EFE937F66B892D11EDF8858EDF67ACCAE9701A2244BECA80705D7CC292BAD9B02001E4572EE492B08473D5AF59CC83DDA1DE5C2BF470FD784495070A9C5AF8EA9A4060C1DBC5C4690CC8DF6D528C55D82EC9C0DF3046BBCAE7542025D7EE170788C9C234132703290A31AC2700E55339590226D5E582EC61869862769FD85B45F287FFDD6DB530995D31F94D7D2C26EF3F48A182C3026CC698F382A72F1A11E3C689953055DAC0DFEBE9CDB163CA3AF33FFC4DA0F6B84B9D7CDD4321CCECD4BAC528DEFF9715FFD9D4731E");
+
+/// RSA-2048 `CertReq` encoded as ASN.1 DER
+const RSA_2048_DER_EXAMPLE: &[u8] = include_bytes!("examples/rsa2048-csr.der");
+
+const NAMES: &[(&str, &str)] = &[
+ ("2.5.4.3", "example.com"),
+ ("2.5.4.7", "Los Angeles"),
+ ("2.5.4.8", "California"),
+ ("2.5.4.10", "Example Inc"),
+ ("2.5.4.6", "US"),
+];
+
+#[rustfmt::skip]
+const EXTENSIONS: &[(&str, &[u8])] = &[
+ ("2.5.29.19", &hex!("3000")), // basicConstraints
+ ("2.5.29.15", &hex!("030205A0")), // keyUsage
+ ("2.5.29.37", &hex!("301406082B0601050507030106082B06010505070302")), // extKeyUsage
+ ("2.5.29.17", &hex!("300D820B6578616D706C652E636F6D")), // subjectAltNamec
+];
+
+#[test]
+fn decode_rsa_2048_der() {
+ let cr = CertReq::from_der(RSA_2048_DER_EXAMPLE).unwrap();
+
+ // Check the version.
+ assert_eq!(cr.info.version, Version::V1);
+
+ // Check all the RDNs.
+ assert_eq!(cr.info.subject.0.len(), NAMES.len());
+ for (name, (oid, val)) in cr.info.subject.0.iter().zip(NAMES) {
+ let kind = name.0.get(0).unwrap();
+ let value = match kind.value.tag() {
+ Tag::Utf8String => Utf8StringRef::try_from(&kind.value).unwrap().as_str(),
+ Tag::PrintableString => PrintableStringRef::try_from(&kind.value).unwrap().as_str(),
+ _ => panic!("unexpected tag"),
+ };
+
+ assert_eq!(kind.oid, oid.parse().unwrap());
+ assert_eq!(name.0.len(), 1);
+ assert_eq!(value, *val);
+ }
+
+ // Check the public key.
+ let alg = cr.info.public_key.algorithm;
+ assert_eq!(alg.oid, "1.2.840.113549.1.1.1".parse().unwrap());
+ assert!(alg.parameters.unwrap().is_null());
+ assert_eq!(cr.info.public_key.subject_public_key.raw_bytes(), RSA_KEY);
+
+ // Check the attributes (just one; contains extensions).
+ assert_eq!(cr.info.attributes.len(), 1);
+ let attribute = cr.info.attributes.get(0).unwrap();
+ assert_eq!(attribute.oid, "1.2.840.113549.1.9.14".parse().unwrap()); // extensionRequest
+ assert_eq!(attribute.values.len(), 1);
+
+ // Check the extensions.
+ let extensions: x509_cert::ext::Extensions =
+ attribute.values.get(0).unwrap().decode_as().unwrap();
+ for (ext, (oid, val)) in extensions.iter().zip(EXTENSIONS) {
+ assert_eq!(ext.extn_id, oid.parse().unwrap());
+ assert_eq!(ext.extn_value.as_bytes(), *val);
+ assert!(!ext.critical);
+ }
+
+ // Check the signature value.
+ assert_eq!(cr.algorithm.oid, "1.2.840.113549.1.1.11".parse().unwrap());
+ assert!(cr.algorithm.parameters.unwrap().is_null());
+ assert_eq!(cr.signature.as_bytes().unwrap(), RSA_SIG);
+}
+
+// The following tests currently fail because of a bug in the `der` crate;
+// specifically, the `IMPLICIT` tagging on `CertReqInfo::attributes`.
+
+#[test]
+fn encode_rsa_2048_der() {
+ let cr = CertReq::from_der(RSA_2048_DER_EXAMPLE).unwrap();
+ let cr_encoded = cr.to_der().unwrap();
+ assert_eq!(RSA_2048_DER_EXAMPLE, cr_encoded.as_slice());
+}
diff --git a/crates/x509-cert/tests/crl.rs b/crates/x509-cert/tests/crl.rs
new file mode 100644
index 0000000..e3d7eba
--- /dev/null
+++ b/crates/x509-cert/tests/crl.rs
@@ -0,0 +1,17 @@
+use der::Decode;
+use x509_cert::crl::CertificateList;
+
+#[test]
+fn decode_crl() {
+ // vanilla CRL from PKITS
+ let der_encoded_cert = include_bytes!("examples/GoodCACRL.crl");
+ let crl = CertificateList::from_der(der_encoded_cert).unwrap();
+ assert_eq!(2, crl.tbs_cert_list.crl_extensions.unwrap().len());
+ assert_eq!(2, crl.tbs_cert_list.revoked_certificates.unwrap().len());
+
+ // CRL with an entry with no entry extensions
+ let der_encoded_cert = include_bytes!("examples/tscpbcasha256.crl");
+ let crl = CertificateList::from_der(der_encoded_cert).unwrap();
+ assert_eq!(2, crl.tbs_cert_list.crl_extensions.unwrap().len());
+ assert_eq!(4, crl.tbs_cert_list.revoked_certificates.unwrap().len());
+}
diff --git a/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der b/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der
new file mode 100644
index 0000000..d6cda5a
--- /dev/null
+++ b/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.pem b/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.pem
new file mode 100644
index 0000000..f13043d
--- /dev/null
+++ b/crates/x509-cert/tests/examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.pem
@@ -0,0 +1,61 @@
+-----BEGIN CERTIFICATE-----
+MIILDDCCCPSgAwIBAgIQfwAAAQAAAUnPcGZNAAAAAjANBgkqhkiG9w0BAQsFADBt
+MQswCQYDVQQGEwJVUzENMAsGA1UEChMETW9jazEfMB0GA1UECgwWSWRlblRydXN0
+IFNlcnZpY2VzIExMQzEuMCwGA1UEAwwlUFRFIElkZW5UcnVzdCBHbG9iYWwgQ29t
+bW9uIFJvb3QgQ0EgMTAeFw0xNDExMjAyMzAxMzBaFw0xODAxMjIxMzQzMTNaMFsx
+HzAdBgNVBAMTFlRlc3QgRmVkZXJhbCBCcmlkZ2UgQ0ExETAPBgNVBAsTCFRlc3RG
+UEtJMRgwFgYDVQQKEw9VLlMuIEdvdmVybm1lbnQxCzAJBgNVBAYTAlVTMIIBIjAN
+BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvBZsJer07n0I60VOfHzZ3yk4oPAM
+2Qh8pZFT6Dp8OSOxFouoib7EhoElJ66AMTO+2SUXP8DgiUOQ7qR7AdKBipqaZP1B
+T+3sjvlLr1faiCrPLmGB+GmbaORGeIwezH3J5dmVY4UBKoH4GIZvo65w99OiSf4N
+tSqE4RDqZr+KM8LoE7FnJIpCrWk1lScs7WcoLWul8KKMGhf9JcEkl1yEzrYOxRcY
+T2rilBBED07TLaTEj7vb/nq6K8rewszjmPAvI/TVoW1mXE1pzfSxVqzQ+jfPgDAN
+BEJGWwP3+qHxp3FfFAgc1QpC05366xFxbwPaMfFF6kfzSZTdIXQOtKkY+QIDAQAB
+o4IGuDCCBrQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wggIOBgNV
+HSEEggIFMIICATAZBgtghkgBhvkvAGQCAQYKYIZIAWUDAgEwAjAZBgtghkgBhvkv
+AGQCAgYKYIZIAWUDAgEwAjAZBgtghkgBhvkvAGQDAQYKYIZIAWUDAgEwAzAZBgtg
+hkgBhvkvAGQDAgYKYIZIAWUDAgEwAzAZBgtghkgBhvkvAGQOAQYKYIZIAWUDAgEw
+BTAZBgtghkgBhvkvAGQOAgYKYIZIAWUDAgEwBTAZBgtghkgBhvkvAGQMAQYKYIZI
+AWUDAgEwBDAZBgtghkgBhvkvAGQMAgYKYIZIAWUDAgEwBDAZBgtghkgBhvkvAGQP
+AQYKYIZIAWUDAgEwBjAZBgtghkgBhvkvAGQPAgYKYIZIAWUDAgEwBjAZBgtghkgB
+hvkvAGQSAAYKYIZIAWUDAgEwTjAZBgtghkgBhvkvAGQSAQYKYIZIAWUDAgEwTjAZ
+BgtghkgBhvkvAGQSAgYKYIZIAWUDAgEwTjAZBgtghkgBhvkvAGQTAQYKYIZIAWUD
+AgEwTzAZBgtghkgBhvkvAGQUAQYKYIZIAWUDAgEwUDAZBgtghkgBhvkvAGQlAQYK
+YIZIAWUDAgEwYzAZBgtghkgBhvkvAGQlAgYKYIZIAWUDAgEwYzAZBgtghkgBhvkv
+AGQmAQYKYIZIAWUDAgEwZDAZBgtghkgBhvkvAGQmAgYKYIZIAWUDAgEwZDCCAnAG
+A1UdIASCAmcwggJjMA0GC2CGSAGG+S8AZAIBMA0GC2CGSAGG+S8AZAICMA0GC2CG
+SAGG+S8AZAMBMA0GC2CGSAGG+S8AZAMCMA0GC2CGSAGG+S8AZA4BMA0GC2CGSAGG
++S8AZA4CMA0GC2CGSAGG+S8AZAwBMA0GC2CGSAGG+S8AZAwCMA0GC2CGSAGG+S8A
+ZA8BMA0GC2CGSAGG+S8AZA8CMA0GC2CGSAGG+S8AZBIAMA0GC2CGSAGG+S8AZBIB
+MA0GC2CGSAGG+S8AZBICMA0GC2CGSAGG+S8AZBMBMA0GC2CGSAGG+S8AZBQBMA0G
+C2CGSAGG+S8AZCUBMA0GC2CGSAGG+S8AZCUCMA0GC2CGSAGG+S8AZCYBMIIBUQYL
+YIZIAYb5LwBkJgIwggFAMEsGCCsGAQUFBwIBFj9odHRwczovL3NlY3VyZS5pZGVu
+dHJ1c3QuY29tL2NlcnRpZmljYXRlcy9wb2xpY3kvSUdDL2luZGV4Lmh0bWwwgfAG
+CCsGAQUFBwICMIHjGoHgVGhpcyBpcyBhIHRlc3QgY2VydGlmaWNhdGUuIERvIE5v
+dCBSZWx5LiBDZXJ0aWZpY2F0ZSB1c2UgcmVzdHJpY3RlZCB0byBSZWx5aW5nIFBh
+cnR5KHMpIGluIGFjY29yZGFuY2Ugd2l0aCBJR0MtQ1AgKHNlZSBodHRwczovL3Nl
+Y3VyZS5pZGVudHJ1c3QuY29tL2NlcnRpZmljYXRlcy9wb2xpY3kvSUdDL2luZGV4
+Lmh0bWwpLiBJc3N1ZXIncyBDUFMgaW5jb3Jwb3JhdGVkIGJ5IHJlZmVyZW5jZS4w
+HgYDVR0OBBcEFdvT3r8Ne2FbMoA7wCBs16rdObis/zCBxQYDVR0fBIG9MIG6MDqg
+OKA2hjRodHRwOi8vY3JsLXB0ZS5pZGVudHJ1c3QuY29tLnRlc3QvY3JsL0lHQ1Jv
+b3RjYTEuY3JsMHygeqB4hnZsZGFwOi8vbGRhcC1wdGUuaWRlbnRydXN0LmNvbS50
+ZXN0L2NuJTNESUdDJTIwUm9vdCUyMENBMSUyQ28lM0RJZGVuVHJ1c3QlMkNjJTNE
+VVMlM0ZjZXJ0aWZpY2F0ZVJldm9jYXRpb25MaXN0JTNCYmluYXJ5MGEGCCsGAQUF
+BwELBFUwUzBRBggrBgEFBQcwBYZFaHR0cDovL2h0dHAuY2l0ZS5mcGtpLWxhYi5n
+b3YudGVzdC9icmlkZ2UvY2FDZXJ0c0lzc3VlZEJ5dGVzdEZCQ0EucDdjMIGRBggr
+BgEFBQcBAQSBhDCBgTBDBggrBgEFBQcwAoY3aHR0cDovL2FwcHMtc3RnLmlkZW50
+cnVzdC5jb20udGVzdC9yb290cy9JR0NSb290Y2ExLnA3YzA6BggrBgEFBQcwAYYu
+aHR0cDovL2lnY3Jvb3RwdGUub2NzcC5pZGVudHJ1c3QuY29tLnRlc3Q6ODEyNTAK
+BgNVHTYEAwIBADAgBgNVHSMEGTAXgBV8TIY6uAvViYcL7bfhG70qCLs9I/8wDQYJ
+KoZIhvcNAQELBQADggIBACqJLzV78+8Z4SEZhhBoA/oY5mI3gC8bGwxnVs5njbAd
+cs0KTrcXHCzd8RCs04qmXDVpnoacIZrXVQqk8oe7eE9y74yeoOPdED7+W/GC6jb/
+vLRarmWEAmNoBTR4nE8yFa9UVK1Iy8S3qIHgE1QBoL1ahJwREB3RxmF452LADfWd
+1Q+N6e1G/GoNdCrlaX2H3QjaxSkadfsTyC/yhlyeNnmepyYTfhgU5qh4yVMuj8PQ
+oqlC0czGaP/OrCVeYAL95azfLOR1VrsUHDp5ekv9tnP28cIp15FP/u8VBe42+AOB
+N9G4+QEGmUurPm/w9gNgouMvejC37OwVAt88xyW9bkNrqPlqGEfJzrs/WlkGRyKS
+UB1ZvhqYR1ux8wtnf6qKReNRZAyFsbImYdM70j7GwMoz3deeESDH/IaexNAXWttK
+JYrqxejS8PV4uL9LLF3MMml2iqpbnibQWSxbsJxwLHLgpg9m0+6ytJgyeWNNWbCi
+ARsOJq55bMldMkPfSWFUNOXMBsN0w/k2wAXTYMrmEB865+l+KaFX9QIHcNRkjXh3
+6/gkjPPz5o+ZV6NvktUGFvLGDThCMn75vAMSz/A6SMeOlyVMKt6tygUGkWhEPYM4
+Mf9mKVou7WhfFk8dvgH4yJfh9j1ChRaCy+57WmTXuikj0zZE2/H3s+3OmW+ZKPBD
+-----END CERTIFICATE-----
diff --git a/crates/x509-cert/tests/examples/085B1E2F40254F9C7A2387BE9FF4EC116C326E10.fake.der b/crates/x509-cert/tests/examples/085B1E2F40254F9C7A2387BE9FF4EC116C326E10.fake.der
new file mode 100644
index 0000000..08db364
--- /dev/null
+++ b/crates/x509-cert/tests/examples/085B1E2F40254F9C7A2387BE9FF4EC116C326E10.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/0954e2343dd5efe0a7f0967d69caf33e5f893720.der b/crates/x509-cert/tests/examples/0954e2343dd5efe0a7f0967d69caf33e5f893720.der
new file mode 100644
index 0000000..63dbd46
--- /dev/null
+++ b/crates/x509-cert/tests/examples/0954e2343dd5efe0a7f0967d69caf33e5f893720.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/0fcc78fbbca9f32b08b19b032b84f2c86a128f35.der b/crates/x509-cert/tests/examples/0fcc78fbbca9f32b08b19b032b84f2c86a128f35.der
new file mode 100644
index 0000000..bcdf79c
--- /dev/null
+++ b/crates/x509-cert/tests/examples/0fcc78fbbca9f32b08b19b032b84f2c86a128f35.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/15b05c4865410c6b3ff76a4e8f3d87276756bd0c.der b/crates/x509-cert/tests/examples/15b05c4865410c6b3ff76a4e8f3d87276756bd0c.der
new file mode 100644
index 0000000..d94106f
--- /dev/null
+++ b/crates/x509-cert/tests/examples/15b05c4865410c6b3ff76a4e8f3d87276756bd0c.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/16ee54e48c76eaa1052e09010d8faefee95e5ebb.der b/crates/x509-cert/tests/examples/16ee54e48c76eaa1052e09010d8faefee95e5ebb.der
new file mode 100644
index 0000000..a0fba41
--- /dev/null
+++ b/crates/x509-cert/tests/examples/16ee54e48c76eaa1052e09010d8faefee95e5ebb.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/2049a5b28f104b2c6e1a08546f9cfc0353d6fd30.der b/crates/x509-cert/tests/examples/2049a5b28f104b2c6e1a08546f9cfc0353d6fd30.der
new file mode 100644
index 0000000..24bdee8
--- /dev/null
+++ b/crates/x509-cert/tests/examples/2049a5b28f104b2c6e1a08546f9cfc0353d6fd30.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/21723e7a0fb61a0bd4a29879b82a02b2fb4ad096.der b/crates/x509-cert/tests/examples/21723e7a0fb61a0bd4a29879b82a02b2fb4ad096.der
new file mode 100644
index 0000000..8f48e0d
--- /dev/null
+++ b/crates/x509-cert/tests/examples/21723e7a0fb61a0bd4a29879b82a02b2fb4ad096.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/284A0A3A9B56DD752DAA2E09E2FADEDB858D9338.fake.der b/crates/x509-cert/tests/examples/284A0A3A9B56DD752DAA2E09E2FADEDB858D9338.fake.der
new file mode 100644
index 0000000..ae22bd4
--- /dev/null
+++ b/crates/x509-cert/tests/examples/284A0A3A9B56DD752DAA2E09E2FADEDB858D9338.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/28879DABB0FD11618FB74E47BE049D2933866D53.fake.der b/crates/x509-cert/tests/examples/28879DABB0FD11618FB74E47BE049D2933866D53.fake.der
new file mode 100644
index 0000000..0aef65d
--- /dev/null
+++ b/crates/x509-cert/tests/examples/28879DABB0FD11618FB74E47BE049D2933866D53.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/288C8BCFEE6B89D110DAE2C9873897BF7FF53382.fake.der b/crates/x509-cert/tests/examples/288C8BCFEE6B89D110DAE2C9873897BF7FF53382.fake.der
new file mode 100644
index 0000000..62e8f41
--- /dev/null
+++ b/crates/x509-cert/tests/examples/288C8BCFEE6B89D110DAE2C9873897BF7FF53382.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/28903a635b5280fae6774c0b6da7d6baa64af2e8.der b/crates/x509-cert/tests/examples/28903a635b5280fae6774c0b6da7d6baa64af2e8.der
new file mode 100644
index 0000000..f1317bf
--- /dev/null
+++ b/crates/x509-cert/tests/examples/28903a635b5280fae6774c0b6da7d6baa64af2e8.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/33D8388EDA1E92475EF19075D2EF4093D1CB6F7F.fake.der b/crates/x509-cert/tests/examples/33D8388EDA1E92475EF19075D2EF4093D1CB6F7F.fake.der
new file mode 100644
index 0000000..936b06a
--- /dev/null
+++ b/crates/x509-cert/tests/examples/33D8388EDA1E92475EF19075D2EF4093D1CB6F7F.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/342cd9d3062da48c346965297f081ebc2ef68fdc.der b/crates/x509-cert/tests/examples/342cd9d3062da48c346965297f081ebc2ef68fdc.der
new file mode 100644
index 0000000..750c085
--- /dev/null
+++ b/crates/x509-cert/tests/examples/342cd9d3062da48c346965297f081ebc2ef68fdc.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/554D5FF11DA613A155584D8D4AA07F67724D8077.fake.der b/crates/x509-cert/tests/examples/554D5FF11DA613A155584D8D4AA07F67724D8077.fake.der
new file mode 100644
index 0000000..5231873
--- /dev/null
+++ b/crates/x509-cert/tests/examples/554D5FF11DA613A155584D8D4AA07F67724D8077.fake.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/GoodCACRL.crl b/crates/x509-cert/tests/examples/GoodCACRL.crl
new file mode 100644
index 0000000..d46110c
--- /dev/null
+++ b/crates/x509-cert/tests/examples/GoodCACRL.crl
Binary files differ
diff --git a/crates/x509-cert/tests/examples/GoodCACert.crt b/crates/x509-cert/tests/examples/GoodCACert.crt
new file mode 100644
index 0000000..edbfa64
--- /dev/null
+++ b/crates/x509-cert/tests/examples/GoodCACert.crt
Binary files differ
diff --git a/crates/x509-cert/tests/examples/amazon.der b/crates/x509-cert/tests/examples/amazon.der
new file mode 100644
index 0000000..cc30bd6
--- /dev/null
+++ b/crates/x509-cert/tests/examples/amazon.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/amazon.pem b/crates/x509-cert/tests/examples/amazon.pem
new file mode 100644
index 0000000..8b41dea
--- /dev/null
+++ b/crates/x509-cert/tests/examples/amazon.pem
@@ -0,0 +1,49 @@
+-----BEGIN CERTIFICATE-----
+MIIIwTCCB6mgAwIBAgIQDkI5q4Xi5qJ8Usbem5B42TANBgkqhkiG9w0BAQsFADBE
+MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMR4wHAYDVQQDExVE
+aWdpQ2VydCBHbG9iYWwgQ0EgRzIwHhcNMjExMDA2MDAwMDAwWhcNMjIwOTE5MjM1
+OTU5WjAYMRYwFAYDVQQDDA0qLnBlZy5hMnouY29tMIIBIjANBgkqhkiG9w0BAQEF
+AAOCAQ8AMIIBCgKCAQEAv+/uM8Nke+pDU6lWoZALXfrNwH6/B3+8FEfNewD6mN8u
+ntzCMH8fPU5Gb1/odQWS7GiBPowoU6smFj4F0kD3Qh4OUpAVbcYS2ad5nVBnwmh8
+Tm/U3DO34FZgxtjz3qxBVKr1ryYO3+1/H2xBuit8W1TSd/s+2joupzAAQq0zn8B3
+6kpi14dYIaZgBw0WuQHaybTlC0cko9x2t43RXxNZgRxqYyh+I+MK19ZOAZgCPAoo
+JXyQiUIohTdOw8gnDY5gI4zhHyzvuhifSBeII1WA6MfGdiKV+K0R9LLr0oHYV3F7
+yCQoDN29ZVgXj4UZu64IxIQnuHRN6X2otR3qgUjAoQIDAQABo4IF2TCCBdUwHwYD
+VR0jBBgwFoAUJG4rLdBqklFRJWkBqppHponnQCAwHQYDVR0OBBYEFJVFFD46QB6V
+FvCCrEVzglhtm/B0MIICowYDVR0RBIICmjCCApaCDGFtYXpvbi5jby51a4ITdWVk
+YXRhLmFtYXpvbi5jby51a4IQd3d3LmFtYXpvbi5jby51a4IXb3JpZ2luLXd3dy5h
+bWF6b24uY28udWuCDSoucGVnLmEyei5jb22CCmFtYXpvbi5jb22CCGFtem4uY29t
+ghF1ZWRhdGEuYW1hem9uLmNvbYINdXMuYW1hem9uLmNvbYIOd3d3LmFtYXpvbi5j
+b22CDHd3dy5hbXpuLmNvbYIUY29ycG9yYXRlLmFtYXpvbi5jb22CEWJ1eWJveC5h
+bWF6b24uY29tghFpcGhvbmUuYW1hem9uLmNvbYINeXAuYW1hem9uLmNvbYIPaG9t
+ZS5hbWF6b24uY29tghVvcmlnaW4td3d3LmFtYXpvbi5jb22CFm9yaWdpbjItd3d3
+LmFtYXpvbi5jb22CIWJ1Y2tleWUtcmV0YWlsLXdlYnNpdGUuYW1hem9uLmNvbYIS
+aHVkZGxlcy5hbWF6b24uY29tgglhbWF6b24uZGWCDXd3dy5hbWF6b24uZGWCFG9y
+aWdpbi13d3cuYW1hem9uLmRlggxhbWF6b24uY28uanCCCWFtYXpvbi5qcIINd3d3
+LmFtYXpvbi5qcIIQd3d3LmFtYXpvbi5jby5qcIIXb3JpZ2luLXd3dy5hbWF6b24u
+Y28uanCCECouYWEucGVnLmEyei5jb22CECouYWIucGVnLmEyei5jb22CECouYWMu
+cGVnLmEyei5jb22CGG9yaWdpbi13d3cuYW1hem9uLmNvbS5hdYIRd3d3LmFtYXpv
+bi5jb20uYXWCECouYnoucGVnLmEyei5jb22CDWFtYXpvbi5jb20uYXWCGG9yaWdp
+bjItd3d3LmFtYXpvbi5jby5qcDAOBgNVHQ8BAf8EBAMCBaAwHQYDVR0lBBYwFAYI
+KwYBBQUHAwEGCCsGAQUFBwMCMHcGA1UdHwRwMG4wNaAzoDGGL2h0dHA6Ly9jcmwz
+LmRpZ2ljZXJ0LmNvbS9EaWdpQ2VydEdsb2JhbENBRzIuY3JsMDWgM6Axhi9odHRw
+Oi8vY3JsNC5kaWdpY2VydC5jb20vRGlnaUNlcnRHbG9iYWxDQUcyLmNybDA+BgNV
+HSAENzA1MDMGBmeBDAECATApMCcGCCsGAQUFBwIBFhtodHRwOi8vd3d3LmRpZ2lj
+ZXJ0LmNvbS9DUFMwdAYIKwYBBQUHAQEEaDBmMCQGCCsGAQUFBzABhhhodHRwOi8v
+b2NzcC5kaWdpY2VydC5jb20wPgYIKwYBBQUHMAKGMmh0dHA6Ly9jYWNlcnRzLmRp
+Z2ljZXJ0LmNvbS9EaWdpQ2VydEdsb2JhbENBRzIuY3J0MAwGA1UdEwEB/wQCMAAw
+ggF+BgorBgEEAdZ5AgQCBIIBbgSCAWoBaAB2ACl5vvCeOTkh8FZzn2Old+W+V32c
+YAr4+U1dJlwlXceEAAABfFOKWLsAAAQDAEcwRQIhAOIjvEg/ozDhjhiV0fbaYc83
+oPb2I08md/bU7nhfQufgAiAyA6CaJgpUYYQjchPqiS3DzHIIQL0FIkohEcluqPJV
+oAB3AFGjsPX9AXmcVm24N3iPDKR6zBsny/eeiEKaDf7UiwXlAAABfFOKWOQAAAQD
+AEgwRgIhAJA7QR62SZNgoU0SCfXaPUriW4FrPlVUZbSLl7s+q3W4AiEAg/iCIUET
+pZEw8IAvQGC4ggNwRgm97pma3Ug8FhJp0KgAdQBByMqx3yJGShDGoToJQodeTjGL
+GwPr60vHaPCQYpYG9gAAAXxTilifAAAEAwBGMEQCIFcuV+EsdfqUxhSV4+pSF5I/
+EVBVin/kOpaTBcSTlHccAiA7IdRwyN09v9bnXKJ2XsMDGfe9RHwWwVoXA/NJMx5A
+3DANBgkqhkiG9w0BAQsFAAOCAQEAyLJluG6AFZ5fVgxdS574SZd7dInEumnQUQmt
++D/vbUb4NfiO4aRdPGkGotGHptFW9wxYjvYlSmtWbns5v+0CmpiXadXLNPWZtNjJ
+gFR3WTLbHzBtD+C8yL1AQ/L2kOk9PVpq50leD7+dZimurjX3k7CbxaItjHnKAq3V
+klINM2LLV//ZqnQxBlHeUiTfnUjKR/0FRDM4zr247HX0BH5CUl3wT5/e6mBqkXkK
+Vvl+zzVfQjkeL40KjJJjQ4+N0gsPS8+rBPGHEVXFGPtlbI6pyS3Wo2rTkaIDwd+i
+7ckVQviFKPooe4SVfp+kX4xVu9BEI4hlVa2y7qc/mMecBpXT+Q==
+-----END CERTIFICATE-----
diff --git a/crates/x509-cert/tests/examples/crates.io-chain.pem b/crates/x509-cert/tests/examples/crates.io-chain.pem
new file mode 100644
index 0000000..1927099
--- /dev/null
+++ b/crates/x509-cert/tests/examples/crates.io-chain.pem
@@ -0,0 +1,122 @@
+This is an X.509 certificate chain serialized as PEM, with a preamble.
+
+-----BEGIN CERTIFICATE-----
+MIIF/jCCBOagAwIBAgIQC6Hm8WViUmt88+VrEPNELzANBgkqhkiG9w0BAQsFADA8
+MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRwwGgYDVQQDExNBbWF6b24g
+UlNBIDIwNDggTTAyMB4XDTIzMDEyNTAwMDAwMFoXDTI0MDIyMzIzNTk1OVowFDES
+MBAGA1UEAxMJY3JhdGVzLmlvMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC
+AQEA5ivp2b8HKoaSyAq/Gt4ZJbELL/FhVNXhnHmPvdhvkD6vtGSxJQhbACftNBB4
+Kor8zK+6o1mQSpR1SNnQ5OKJIko4s+e7p4tuFV3b4LSxh+nNBZmBTvEmb5nCVs/c
+78hXtLPu48Ws4rd+Ujz6ZEcGfK15X+XT04sJFoQRSnkTwhO3DsRXwUXxhckvNJen
+R6i0dH3Um5I7sIfzgxMFh66akg2PE8s7/oM0VCY4+9hwvWRTqpz+Byi3XO1Ph+BZ
+cvJhLwn4t/KdGaSU7EV8+qhNu4mP6dsjCY03Gpha1wCvlh4Vh/TsqR3R4oPhhohh
++W3YdrTe8Deqs5nW9XrtB98F/QIDAQABo4IDIjCCAx4wHwYDVR0jBBgwFoAUwDFS
+zVpQw4J8dHHOy+mc+XrrguIwHQYDVR0OBBYEFB2jpSCo7Y3rXtxOmQPni/vQ8Ihd
+MFQGA1UdEQRNMEuCCWNyYXRlcy5pb4IbY2xvdWRmcm9udC1zdGF0aWMuY3JhdGVz
+Lmlvgg9pbmRleC5jcmF0ZXMuaW+CEHN0YXRpYy5jcmF0ZXMuaW8wDgYDVR0PAQH/
+BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjA7BgNVHR8ENDAy
+MDCgLqAshipodHRwOi8vY3JsLnIybTAyLmFtYXpvbnRydXN0LmNvbS9yMm0wMi5j
+cmwwEwYDVR0gBAwwCjAIBgZngQwBAgEwdQYIKwYBBQUHAQEEaTBnMC0GCCsGAQUF
+BzABhiFodHRwOi8vb2NzcC5yMm0wMi5hbWF6b250cnVzdC5jb20wNgYIKwYBBQUH
+MAKGKmh0dHA6Ly9jcnQucjJtMDIuYW1hem9udHJ1c3QuY29tL3IybTAyLmNlcjAM
+BgNVHRMBAf8EAjAAMIIBfgYKKwYBBAHWeQIEAgSCAW4EggFqAWgAdwDuzdBk1dsa
+zsVct520zROiModGfLzs3sNRSFlGcR+1mwAAAYXoOwzkAAAEAwBIMEYCIQDx3bii
+KZKB7CKHMUq25cNLF5RGhfqjRl0TfA1EUJw8ngIhANii/IksRi+gF3VZuqf+NpE6
+hamc+2sTJYmG/ICe7H3UAHUAc9meiRtMlnigIH1HneayxhzQUV5xGSqMa4AQesF3
+crUAAAGF6DsNTgAABAMARjBEAiBGBvFbTLCHkRTM71r0wslHjcary8UmGQ7rd7ws
+mZcoBAIgPZYVni2CIK0+U7aijle1LqEPDI2UtgnFtrKGefXhdAUAdgBIsONr2qZH
+NA/lagL6nTDrHFIBy1bdLIHZu7+rOdiEcwAAAYXoOw0UAAAEAwBHMEUCIE39dFmq
+xAUUmiJiGW9HS0/VbEIt0wC9VI0jCli9T28kAiEAx19Sl2Hzh62E0tISm5p1vmGr
+K3J+m3u3fm5+YcuCdUUwDQYJKoZIhvcNAQELBQADggEBAI3+jl3AGFqBVq3Amo97
+u86v/zHykGQQFvb9LyFdhIhw8OmI/C89YmUy+ZEVsc0GBO5jf3Xr/tUDidggbRva
+ajaR1lv5hWC6HjASg4dX/88ew5eKxV9ddjcNb15bzuxWPLw+X2NAq9S+QRnkDZkr
+/VW0rYSnu3YOEwxys56JSDzHx/UWqkUHb1bsO6ixxN8sbKjM4UDeB9WHvLHO85B8
+b5rgtqrT2vIqO1wtxxo3TY72eDEqu8N1MfatTEaOaJEQu86meGO7Wbx6QQX3OJc3
+ulPbBw+/o2sXvYxy251skJRwvyi00dGhxGSlRmbGGmXpWY97CPkY1iJwQ73uJ4qx
+Uj0=
+-----END CERTIFICATE-----
+
+
+-----BEGIN CERTIFICATE-----
+MIIEXjCCA0agAwIBAgITB3MSSkvL1E7HtTvq8ZSELToPoTANBgkqhkiG9w0BAQsF
+ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6
+b24gUm9vdCBDQSAxMB4XDTIyMDgyMzIyMjUzMFoXDTMwMDgyMzIyMjUzMFowPDEL
+MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEcMBoGA1UEAxMTQW1hem9uIFJT
+QSAyMDQ4IE0wMjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALtDGMZa
+qHneKei1by6+pUPPLljTB143Si6VpEWPc6mSkFhZb/6qrkZyoHlQLbDYnI2D7hD0
+sdzEqfnuAjIsuXQLG3A8TvX6V3oFNBFVe8NlLJHvBseKY88saLwufxkZVwk74g4n
+WlNMXzla9Y5F3wwRHwMVH443xGz6UtGSZSqQ94eFx5X7Tlqt8whi8qCaKdZ5rNak
++r9nUThOeClqFd4oXych//Rc7Y0eX1KNWHYSI1Nk31mYgiK3JvH063g+K9tHA63Z
+eTgKgndlh+WI+zv7i44HepRZjA1FYwYZ9Vv/9UkC5Yz8/yU65fgjaE+wVHM4e/Yy
+C2osrPWE7gJ+dXMCAwEAAaOCAVowggFWMBIGA1UdEwEB/wQIMAYBAf8CAQAwDgYD
+VR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAdBgNV
+HQ4EFgQUwDFSzVpQw4J8dHHOy+mc+XrrguIwHwYDVR0jBBgwFoAUhBjMhTTsvAyU
+lC4IWZzHshBOCggwewYIKwYBBQUHAQEEbzBtMC8GCCsGAQUFBzABhiNodHRwOi8v
+b2NzcC5yb290Y2ExLmFtYXpvbnRydXN0LmNvbTA6BggrBgEFBQcwAoYuaHR0cDov
+L2NydC5yb290Y2ExLmFtYXpvbnRydXN0LmNvbS9yb290Y2ExLmNlcjA/BgNVHR8E
+ODA2MDSgMqAwhi5odHRwOi8vY3JsLnJvb3RjYTEuYW1hem9udHJ1c3QuY29tL3Jv
+b3RjYTEuY3JsMBMGA1UdIAQMMAowCAYGZ4EMAQIBMA0GCSqGSIb3DQEBCwUAA4IB
+AQAtTi6Fs0Azfi+iwm7jrz+CSxHH+uHl7Law3MQSXVtR8RV53PtR6r/6gNpqlzdo
+Zq4FKbADi1v9Bun8RY8D51uedRfjsbeodizeBB8nXmeyD33Ep7VATj4ozcd31YFV
+fgRhvTSxNrrTlNpWkUk0m3BMPv8sg381HhA6uEYokE5q9uws/3YkKqRiEz3TsaWm
+JqIRZhMbgAfp7O7FUwFIb7UIspogZSKxPIWJpxiPo3TcBambbVtQOcNRWz5qCQdD
+slI2yayq0n2TXoHyNCLEH8rpsJRVILFsg0jc7BaFrMnF462+ajSehgj12IidNeRN
+4zl+EoNaWdpnWndvSpAEkq2P
+-----END CERTIFICATE-----
+
+
+
+-----BEGIN CERTIFICATE-----
+MIIEkjCCA3qgAwIBAgITBn+USionzfP6wq4rAfkI7rnExjANBgkqhkiG9w0BAQsF
+ADCBmDELMAkGA1UEBhMCVVMxEDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNj
+b3R0c2RhbGUxJTAjBgNVBAoTHFN0YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4x
+OzA5BgNVBAMTMlN0YXJmaWVsZCBTZXJ2aWNlcyBSb290IENlcnRpZmljYXRlIEF1
+dGhvcml0eSAtIEcyMB4XDTE1MDUyNTEyMDAwMFoXDTM3MTIzMTAxMDAwMFowOTEL
+MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJv
+b3QgQ0EgMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJ4gHHKeNXj
+ca9HgFB0fW7Y14h29Jlo91ghYPl0hAEvrAIthtOgQ3pOsqTQNroBvo3bSMgHFzZM
+9O6II8c+6zf1tRn4SWiw3te5djgdYZ6k/oI2peVKVuRF4fn9tBb6dNqcmzU5L/qw
+IFAGbHrQgLKm+a/sRxmPUDgH3KKHOVj4utWp+UhnMJbulHheb4mjUcAwhmahRWa6
+VOujw5H5SNz/0egwLX0tdHA114gk957EWW67c4cX8jJGKLhD+rcdqsq08p8kDi1L
+93FcXmn/6pUCyziKrlA4b9v7LWIbxcceVOF34GfID5yHI9Y/QCB/IIDEgEw+OyQm
+jgSubJrIqg0CAwEAAaOCATEwggEtMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/
+BAQDAgGGMB0GA1UdDgQWBBSEGMyFNOy8DJSULghZnMeyEE4KCDAfBgNVHSMEGDAW
+gBScXwDfqgHXMCs4iKK4bUqc8hGRgzB4BggrBgEFBQcBAQRsMGowLgYIKwYBBQUH
+MAGGImh0dHA6Ly9vY3NwLnJvb3RnMi5hbWF6b250cnVzdC5jb20wOAYIKwYBBQUH
+MAKGLGh0dHA6Ly9jcnQucm9vdGcyLmFtYXpvbnRydXN0LmNvbS9yb290ZzIuY2Vy
+MD0GA1UdHwQ2MDQwMqAwoC6GLGh0dHA6Ly9jcmwucm9vdGcyLmFtYXpvbnRydXN0
+LmNvbS9yb290ZzIuY3JsMBEGA1UdIAQKMAgwBgYEVR0gADANBgkqhkiG9w0BAQsF
+AAOCAQEAYjdCXLwQtT6LLOkMm2xF4gcAevnFWAu5CIw+7bMlPLVvUOTNNWqnkzSW
+MiGpSESrnO09tKpzbeR/FoCJbM8oAxiDR3mjEH4wW6w7sGDgd9QIpuEdfF7Au/ma
+eyKdpwAJfqxGF4PcnCZXmTA5YpaP7dreqsXMGz7KQ2hsVxa81Q4gLv7/wmpdLqBK
+bRRYh5TmOTFffHPLkIhqhBGWJ6bt2YFGpn6jcgAKUj6DiAdjd4lpFw85hdKrCEVN
+0FE6/V1dN2RMfjCyVSRCnTawXZwXgWHxyvkQAiSr6w10kY17RSlQOYiypok1JR4U
+akcjMS9cmvqtmg5iUaQqqcT5NJ0hGA==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIIEdTCCA12gAwIBAgIJAKcOSkw0grd/MA0GCSqGSIb3DQEBCwUAMGgxCzAJBgNV
+BAYTAlVTMSUwIwYDVQQKExxTdGFyZmllbGQgVGVjaG5vbG9naWVzLCBJbmMuMTIw
+MAYDVQQLEylTdGFyZmllbGQgQ2xhc3MgMiBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0
+eTAeFw0wOTA5MDIwMDAwMDBaFw0zNDA2MjgxNzM5MTZaMIGYMQswCQYDVQQGEwJV
+UzEQMA4GA1UECBMHQXJpem9uYTETMBEGA1UEBxMKU2NvdHRzZGFsZTElMCMGA1UE
+ChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjE7MDkGA1UEAxMyU3RhcmZp
+ZWxkIFNlcnZpY2VzIFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IC0gRzIwggEi
+MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDVDDrEKvlO4vW+GZdfjohTsR8/
+y8+fIBNtKTrID30892t2OGPZNmCom15cAICyL1l/9of5JUOG52kbUpqQ4XHj2C0N
+Tm/2yEnZtvMaVq4rtnQU68/7JuMauh2WLmo7WJSJR1b/JaCTcFOD2oR0FMNnngRo
+Ot+OQFodSk7PQ5E751bWAHDLUu57fa4657wx+UX2wmDPE1kCK4DMNEffud6QZW0C
+zyyRpqbn3oUYSXxmTqM6bam17jQuug0DuDPfR+uxa40l2ZvOgdFFRjKWcIfeAg5J
+Q4W2bHO7ZOphQazJ1FTfhy/HIrImzJ9ZVGif/L4qL8RVHHVAYBeFAlU5i38FAgMB
+AAGjgfAwge0wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwHQYDVR0O
+BBYEFJxfAN+qAdcwKziIorhtSpzyEZGDMB8GA1UdIwQYMBaAFL9ft9HO3R+G9FtV
+rNzXEMIOqYjnME8GCCsGAQUFBwEBBEMwQTAcBggrBgEFBQcwAYYQaHR0cDovL28u
+c3MyLnVzLzAhBggrBgEFBQcwAoYVaHR0cDovL3guc3MyLnVzL3guY2VyMCYGA1Ud
+HwQfMB0wG6AZoBeGFWh0dHA6Ly9zLnNzMi51cy9yLmNybDARBgNVHSAECjAIMAYG
+BFUdIAAwDQYJKoZIhvcNAQELBQADggEBACMd44pXyn3pF3lM8R5V/cxTbj5HD9/G
+VfKyBDbtgB9TxF00KGu+x1X8Z+rLP3+QsjPNG1gQggL4+C/1E2DUBc7xgQjB3ad1
+l08YuW3e95ORCLp+QCztweq7dp4zBncdDQh/U90bZKuCJ/Fp1U1ervShw3WnWEQt
+8jxwmKy6abaVd38PMV4s/KCHOkdp8Hlf9BRUpJVeEXgSYCfOn8J3/yNTd126/+pZ
+59vPr5KW7ySaNRB6nJHGDn2Z9j8Z3/VyVOEVqQdZe4O/Ui5GjLIAZHYcSNPYeehu
+VsyuLAOQ1xk4meTKCRlb/weWsKh/NEnfVqn3sF/tM+2MR7cwA130A4w=
+-----END CERTIFICATE-----
+
diff --git a/crates/x509-cert/tests/examples/eca.der b/crates/x509-cert/tests/examples/eca.der
new file mode 100644
index 0000000..fdd35d5
--- /dev/null
+++ b/crates/x509-cert/tests/examples/eca.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/eca_policies.ta b/crates/x509-cert/tests/examples/eca_policies.ta
new file mode 100755
index 0000000..717364a
--- /dev/null
+++ b/crates/x509-cert/tests/examples/eca_policies.ta
Binary files differ
diff --git a/crates/x509-cert/tests/examples/entrust.der b/crates/x509-cert/tests/examples/entrust.der
new file mode 100644
index 0000000..dbddf49
--- /dev/null
+++ b/crates/x509-cert/tests/examples/entrust.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/entrust_dnConstraint.ta b/crates/x509-cert/tests/examples/entrust_dnConstraint.ta
new file mode 100755
index 0000000..ff784dd
--- /dev/null
+++ b/crates/x509-cert/tests/examples/entrust_dnConstraint.ta
Binary files differ
diff --git a/crates/x509-cert/tests/examples/exostar.der b/crates/x509-cert/tests/examples/exostar.der
new file mode 100644
index 0000000..d2047e4
--- /dev/null
+++ b/crates/x509-cert/tests/examples/exostar.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/exostar_policyFlags.ta b/crates/x509-cert/tests/examples/exostar_policyFlags.ta
new file mode 100755
index 0000000..46e5f92
--- /dev/null
+++ b/crates/x509-cert/tests/examples/exostar_policyFlags.ta
Binary files differ
diff --git a/crates/x509-cert/tests/examples/p256-priv.der b/crates/x509-cert/tests/examples/p256-priv.der
new file mode 100644
index 0000000..c0de45e
--- /dev/null
+++ b/crates/x509-cert/tests/examples/p256-priv.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/p256-pub.der b/crates/x509-cert/tests/examples/p256-pub.der
new file mode 100644
index 0000000..67c719c
--- /dev/null
+++ b/crates/x509-cert/tests/examples/p256-pub.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/qualcomm.pem b/crates/x509-cert/tests/examples/qualcomm.pem
new file mode 100644
index 0000000..5226062
--- /dev/null
+++ b/crates/x509-cert/tests/examples/qualcomm.pem
@@ -0,0 +1,16 @@
+-----BEGIN CERTIFICATE-----
+MIICnDCCAiGgAwIBAgIWAITOC/ag/oJO5eUGyqideMYVAWJXcTAKBggqhkjOPQQD
+AzB2MSQwIgYDVQQKDBtRdWFsY29tbSBUZWNobm9sb2dpZXMsIEluYy4xKjAoBgNV
+BAsMIVF1YWxjb21tIENyeXB0b2dyYXBoaWMgT3BlcmF0aW9uczEiMCAGA1UEAwwZ
+UU1DIEF0dGVzdGF0aW9uIFJvb3QgQ0EgNDAeFw0xNzA4MDEyMjE2MzJaFw0yNzA4
+MDEyMjE2MzJaMH4xJDAiBgNVBAoMG1F1YWxjb21tIFRlY2hub2xvZ2llcywgSW5j
+LjEqMCgGA1UECwwhUXVhbGNvbW0gQ3J5cHRvZ3JhcGhpYyBPcGVyYXRpb25zMSow
+KAYDVQQDDCFRTUMgQXR0ZXN0YXRpb24gUm9vdCBDQSA0IFN1YkNBIDEwdjAQBgcq
+hkjOPQIBBgUrgQQAIgNiAAQDsjssSUEFLyyBe17UmO3pMzqKS+V1jfQkhq7a7zmH
+LCrPFmfaKLm0/szdzZxn+zwhoYen3fgJIuZUaip8wAQxLe4550c1ZBl3iSTvYUbe
+J+gBz2DiJHRBOtY1bQH35NWjZjBkMBIGA1UdEwEB/wQIMAYBAf8CAQAwDgYDVR0P
+AQH/BAQDAgEGMB0GA1UdDgQWBBTrVYStHPbaTn4k7bPerqZAmJcuXzAfBgNVHSME
+GDAWgBQBBnkODO3o7rgWy996xOf1BxR4VTAKBggqhkjOPQQDAwNpADBmAjEAmpM/
+Xvfawl4/A3jd0VVb6lOBh0Jy+zFz1Jz/hw+Xpm9G4XJCscBE7r7lbe2Xc1DHAjEA
+psnskI8pLJQwL80QzAwP3HvgyDUeedNpxnYNK797vqJu6uRMLsZBVHatLM1R4gyE
+-----END CERTIFICATE-----
diff --git a/crates/x509-cert/tests/examples/raytheon.der b/crates/x509-cert/tests/examples/raytheon.der
new file mode 100644
index 0000000..9b57743
--- /dev/null
+++ b/crates/x509-cert/tests/examples/raytheon.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/raytheon_pathLenConstraint.ta b/crates/x509-cert/tests/examples/raytheon_pathLenConstraint.ta
new file mode 100644
index 0000000..eb0fd7f
--- /dev/null
+++ b/crates/x509-cert/tests/examples/raytheon_pathLenConstraint.ta
Binary files differ
diff --git a/crates/x509-cert/tests/examples/rsa2048-crt.der b/crates/x509-cert/tests/examples/rsa2048-crt.der
new file mode 100644
index 0000000..6f46ef1
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-crt.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/rsa2048-crt.pem b/crates/x509-cert/tests/examples/rsa2048-crt.pem
new file mode 100644
index 0000000..d45142c
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-crt.pem
@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDnDCCAoSgAwIBAgIJAKQzLo3paeO7MA0GCSqGSIb3DQEBCwUAMGQxFDASBgNV
+BAMMC2V4YW1wbGUuY29tMRQwEgYDVQQHDAtMb3MgQW5nZWxlczETMBEGA1UECAwK
+Q2FsaWZvcm5pYTEUMBIGA1UECgwLRXhhbXBsZSBJbmMxCzAJBgNVBAYTAlVTMB4X
+DTIyMDEwODE4NDA1N1oXDTIzMDEwODE4NDA1N1owZDEUMBIGA1UEAwwLZXhhbXBs
+ZS5jb20xFDASBgNVBAcMC0xvcyBBbmdlbGVzMRMwEQYDVQQIDApDYWxpZm9ybmlh
+MRQwEgYDVQQKDAtFeGFtcGxlIEluYzELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3
+DQEBAQUAA4IBDwAwggEKAoIBAQC/Wff+cW3eR8c1ecqEbvqNMKs2EuDWpSQgSnLK
+jlDJ9FlRPfDXMzG+09ei2no2Jxnkce5qnYeCfRAk7URgWrm0jzuAjF4XO58+xAA9
+V/FxhIn1x6BCHEb71SekCrS6a52xalRdHs9uKlYzvYBZTrpK/ucfY+HTV8ZOmj/2
+uDdGqIXDc/NSeYfkwrSvf+TU6hZAXl4VKF3ZOII6oY4mNLr+hHp2HK+rsEAdP6A6
+B6nQl8uwx3FWzP42Ex2t8cEJwoI5cvCvIaNfNY54gwTAx4uVFznZH6v/0HqozU9p
+dGs9DrRYdGn5059PvcdhIA37J9r2lWIxHYsZG37vquL41vjrAgMBAAGjUTBPMAkG
+A1UdEwQCMAAwCwYDVR0PBAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEF
+BQcDAjAWBgNVHREEDzANggtleGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEA
+kqvA9M0WRVffA9Eb5h813vio3ceQ8JItVHWyvh9vNGOz3d3eywXIOAKMmzQRQUfY
+7WMbjCM9ppTKRmfoFbMnDQb1aa93isuCoo5QRSpX6DmN/p4v3uz79p8m8in+xhKQ
+1m6et1iwR9cbQxLsmsaVaVTn16xdsL+gq7V4IZXf8CVyxL0mH5FdRmj/nqiWTv6S
+I9tIFiEhCqq1P5XGi6TJAg59M8Dlnd/j5eJHTIlADjG0O1LLvAcuc3rq+dYj0mOU
+RX4MzusreyKRGdvr2IN2gYCDPOgOiqp3YKkOnXV8/pya1KSGrT51fEYTdUrjJ6dr
+430thqsUED++/t+K76IRMw==
+-----END CERTIFICATE-----
diff --git a/crates/x509-cert/tests/examples/rsa2048-csr.der b/crates/x509-cert/tests/examples/rsa2048-csr.der
new file mode 100644
index 0000000..31c9e22
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-csr.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/rsa2048-csr.pem b/crates/x509-cert/tests/examples/rsa2048-csr.pem
new file mode 100644
index 0000000..15c7cc4
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-csr.pem
@@ -0,0 +1,19 @@
+-----BEGIN CERTIFICATE REQUEST-----
+MIIDCTCCAfECAQAwZDEUMBIGA1UEAwwLZXhhbXBsZS5jb20xFDASBgNVBAcMC0xv
+cyBBbmdlbGVzMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtFeGFtcGxl
+IEluYzELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
+AQC/Wff+cW3eR8c1ecqEbvqNMKs2EuDWpSQgSnLKjlDJ9FlRPfDXMzG+09ei2no2
+Jxnkce5qnYeCfRAk7URgWrm0jzuAjF4XO58+xAA9V/FxhIn1x6BCHEb71SekCrS6
+a52xalRdHs9uKlYzvYBZTrpK/ucfY+HTV8ZOmj/2uDdGqIXDc/NSeYfkwrSvf+TU
+6hZAXl4VKF3ZOII6oY4mNLr+hHp2HK+rsEAdP6A6B6nQl8uwx3FWzP42Ex2t8cEJ
+woI5cvCvIaNfNY54gwTAx4uVFznZH6v/0HqozU9pdGs9DrRYdGn5059PvcdhIA37
+J9r2lWIxHYsZG37vquL41vjrAgMBAAGgYDBeBgkqhkiG9w0BCQ4xUTBPMAkGA1Ud
+EwQCMAAwCwYDVR0PBAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcD
+AjAWBgNVHREEDzANggtleGFtcGxlLmNvbTANBgkqhkiG9w0BAQsFAAOCAQEAKwU8
+/oHGVCF2vXCzc6X8jcHxgGpasQ0l42aQ7tHfV61fGOwMzxZfAAJFsUFXFBIktDHs
+ZxXv6Tf2a4ktEe34hY7fZ6zK6XAaIkS+yoBwXXzCkrrZsCAB5Fcu5JKwhHPVr1nM
+g92h3lwr9HD9eESVBwqcWvjqmkBgwdvFxGkMyN9tUoxV2C7JwN8wRrvK51QgJdfu
+FweIycI0EycDKQoxrCcA5VM5WQIm1eWC7GGGmGJ2n9hbRfKH/91ttTCZXTH5TX0s
+Ju8/SKGCwwJsxpjzgqcvGhHjxomVMFXawN/r6c2xY8o68z/8TaD2uEudfN1DIczs
+1LrFKN7/lxX/2dRzHg==
+-----END CERTIFICATE REQUEST-----
diff --git a/crates/x509-cert/tests/examples/rsa2048-priv.der b/crates/x509-cert/tests/examples/rsa2048-priv.der
new file mode 100644
index 0000000..bbf1876
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-priv.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/rsa2048-prv.der b/crates/x509-cert/tests/examples/rsa2048-prv.der
new file mode 100644
index 0000000..f5c6adc
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-prv.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/rsa2048-prv.pem b/crates/x509-cert/tests/examples/rsa2048-prv.pem
new file mode 100644
index 0000000..26e7df3
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-prv.pem
@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEowIBAAKCAQEAv1n3/nFt3kfHNXnKhG76jTCrNhLg1qUkIEpyyo5QyfRZUT3w
+1zMxvtPXotp6NicZ5HHuap2Hgn0QJO1EYFq5tI87gIxeFzufPsQAPVfxcYSJ9ceg
+QhxG+9UnpAq0umudsWpUXR7PbipWM72AWU66Sv7nH2Ph01fGTpo/9rg3RqiFw3Pz
+UnmH5MK0r3/k1OoWQF5eFShd2TiCOqGOJjS6/oR6dhyvq7BAHT+gOgep0JfLsMdx
+Vsz+NhMdrfHBCcKCOXLwryGjXzWOeIMEwMeLlRc52R+r/9B6qM1PaXRrPQ60WHRp
++dOfT73HYSAN+yfa9pViMR2LGRt+76ri+Nb46wIDAQABAoIBAQC0ZwMKrTATH4Lt
+pLxM7UBkupzAJz44v4r2spnU5CXAsRFAKfCVQxvEOH8Vd3s+8NBVcyB+/bOTT4tX
+9SXA3eg1FdDYWf4fU0PIbgt3yiDEkFttD97EVVqK9KQh4UIQe4M5j/CntnOD/oA0
+2ZVXHYU/TWDjVEzE7vz0gDKLzZO3lWrpmUiLd6bglfA0vxpbgQ901e/SWdXlqXzO
+ejjRX/htEQ8tDyW9GrOdVs6NRM1KH3+WCUhNp6xBQtNcqCwKzpvmMcPQyVGxAy6P
+fB7vqzjSDs1jEREFhWW7266tZgL+AieA+b86eSFDqMJ9LoLhYyHtflR2UAsgae/a
++sB3B4XRAoGBAN3E2HFJDewNSIniM+f1XVk+rvbOTsTcCFvmXd47HFz+ogJ+n6ME
+/xwT5OYGsXAEhuduFndkbZAz/s+GpNGu8BBklmUagGXcYKUibt7nhQDRUC8pf9NQ
+KPGQOyLsZXfFVs/QxwIQl/QXw8TS0vtqosirY//zPG9gm2jfqmkr34BDAoGBANzj
+Lq85a1V4s2UVGj05VBZsP5P9XL9ew7oOthXvffgcwc5mIQDiGsU2rQRn957JES/g
+hoPG5LgOjep129mT7h1Ws0+4dMO0uKXbMvOHkhUbdXiumFFYCxfQWiV1AVOMxyeE
+jWPZiXKCuaTLQs0VFnQG0dT5cWIfBnOBhUx8lU45AoGAAvNjjd5S+RkUJgGEf0mc
+fFuBKHeGRMhItDBUf2h58CLTNQVKSnj+i/kXype8NKlawimM0vnbG1gVw90exEt3
+lkBAYAgCPVi5UHks0Hp0IpamYnpC4STn5o7suoI6t2VAynMUsspVu0G1sSC8/etl
+TxY4tmceHr1CVBrlwZB74NECgYByAStaMteMELT+ieq2CL22qP4TgqP4/Y8lm2wt
+XCN3CFibD6kfDJPmj7ay3Ho4UOx2+npSzzfDK3fhuBzVan1uVQ5NKhXR4JegusbM
+XH9wN3Dk7bAd48Qt8VJlnMMnfTRY2BglneRL3t60CFidArJJBjAMrQXxL7Qjr4i+
+Flr1OQKBgCHey67JrCzv3VqnnCB1iScVMi8ABv11Mw8fwXIdhpgzYeFFAQ4YROuB
+YgmIjTW2H6sjZHKVuyUq0wWm+SOByeVmNnh6dNhD6MLWnaGOC2ZSzaM3w0QizJZP
+lo2n+xr6iC0aRBV5PkbIxv1eCLwDBO7Rij0NMaljeFUIXdMNb8NT
+-----END RSA PRIVATE KEY-----
diff --git a/crates/x509-cert/tests/examples/rsa2048-pub.der b/crates/x509-cert/tests/examples/rsa2048-pub.der
new file mode 100644
index 0000000..4148aaa
--- /dev/null
+++ b/crates/x509-cert/tests/examples/rsa2048-pub.der
Binary files differ
diff --git a/crates/x509-cert/tests/examples/tscpbcasha256.crl b/crates/x509-cert/tests/examples/tscpbcasha256.crl
new file mode 100644
index 0000000..e7fe379
--- /dev/null
+++ b/crates/x509-cert/tests/examples/tscpbcasha256.crl
Binary files differ
diff --git a/crates/x509-cert/tests/general_name.rs b/crates/x509-cert/tests/general_name.rs
new file mode 100644
index 0000000..f63b4a2
--- /dev/null
+++ b/crates/x509-cert/tests/general_name.rs
@@ -0,0 +1,80 @@
+use x509_cert::ext::pkix::name::{GeneralName, GeneralNames};
+
+use der::{Decode, Encode};
+use hex_literal::hex;
+use rstest::rstest;
+
+const OTHER_NAME: &[u8] = &hex!("A01B060560865E0202A0120C105249462D472D32303030343033362D30");
+const RFC822_NAME: &[u8] = &hex!("8117456D61696C5F353238343037373733406468732E676F76");
+const DNS_NAME: &[u8] =
+ &hex!("8222756E7465726E65686D656E736E616368666F6C67652D696E2D62617965726E2E6465");
+const DIRECTORY_NAME: &[u8] =
+ &hex!("A43B3039310B3009060355040613024445310F300D06035504080C0642617965726E31193017060355040A0C104672656973746161742042617965726E");
+// TODO: EdiPartyName
+const URI: &[u8] = &hex!(
+ "862A687474703A2F2F63726C2E71756F7661646973676C6F62616C2E636F6D2F71767263613267332E63726C"
+);
+const IPADDR: &[u8] = &hex!("87202A02102C000000000000000000000000FFFFFFFF000000000000000000000000");
+// TODO: RegisteredId
+
+const OTHER_NAMES: &[u8] = &hex!("301da01b060560865e0202a0120c105249462d472d32303030343033362d30");
+const RFC822_NAMES: &[u8] = &hex!("30198117456D61696C5F353238343037373733406468732E676F76");
+const DNS_NAMES: &[u8] =
+ &hex!("30248222756E7465726E65686D656E736E616368666F6C67652D696E2D62617965726E2E6465");
+const DIRECTORY_NAMES: &[u8] = &hex!("303DA43B3039310B3009060355040613024445310F300D06035504080C0642617965726E31193017060355040A0C104672656973746161742042617965726E");
+// TODO: EdiPartyName
+const URIS: &[u8] = &hex!(
+ "302C862A687474703A2F2F63726C2E71756F7661646973676C6F62616C2E636F6D2F71767263613267332E63726C"
+);
+const IPADDRS: &[u8] =
+ &hex!("302287202A02102C000000000000000000000000FFFFFFFF000000000000000000000000");
+// TODO: RegisteredId
+
+#[rstest]
+#[case(1, OTHER_NAME)]
+#[case(2, RFC822_NAME)]
+#[case(3, DNS_NAME)]
+#[case(4, DIRECTORY_NAME)]
+#[case(5, URI)]
+#[case(6, IPADDR)]
+fn singular(#[case] idx: usize, #[case] value: &[u8]) {
+ let decoded = GeneralName::from_der(value).unwrap();
+
+ match (idx, &decoded) {
+ (1, GeneralName::OtherName(..)) => (),
+ (2, GeneralName::Rfc822Name(..)) => (),
+ (3, GeneralName::DnsName(..)) => (),
+ (4, GeneralName::DirectoryName(..)) => (),
+ (5, GeneralName::UniformResourceIdentifier(..)) => (),
+ (6, GeneralName::IpAddress(..)) => (),
+ _ => panic!("unexpected decoded value"),
+ }
+
+ let encoded = decoded.to_der().unwrap();
+ assert_eq!(value, encoded);
+}
+
+#[rstest]
+#[case(1, OTHER_NAMES)]
+#[case(2, RFC822_NAMES)]
+#[case(3, DNS_NAMES)]
+#[case(4, DIRECTORY_NAMES)]
+#[case(5, URIS)]
+#[case(6, IPADDRS)]
+fn plural(#[case] idx: usize, #[case] value: &[u8]) {
+ let decoded = GeneralNames::from_der(value).unwrap();
+
+ assert_eq!(1, decoded.len());
+ match (idx, &decoded[0]) {
+ (1, GeneralName::OtherName(..)) => (),
+ (2, GeneralName::Rfc822Name(..)) => (),
+ (3, GeneralName::DnsName(..)) => (),
+ (4, GeneralName::DirectoryName(..)) => (),
+ (5, GeneralName::UniformResourceIdentifier(..)) => (),
+ (6, GeneralName::IpAddress(..)) => (),
+ _ => panic!("unexpected decoded value"),
+ }
+
+ let encoded = decoded.to_der().unwrap();
+ assert_eq!(value, encoded);
+}
diff --git a/crates/x509-cert/tests/name.rs b/crates/x509-cert/tests/name.rs
new file mode 100644
index 0000000..27af2b5
--- /dev/null
+++ b/crates/x509-cert/tests/name.rs
@@ -0,0 +1,370 @@
+//! Name tests
+
+use const_oid::ObjectIdentifier;
+use der::asn1::{Ia5StringRef, OctetStringRef, PrintableStringRef, SetOfVec, Utf8StringRef};
+use der::{Any, Decode, Encode, Tag, Tagged};
+use hex_literal::hex;
+use x509_cert::attr::AttributeTypeAndValue;
+use x509_cert::name::{Name, RdnSequence, RelativeDistinguishedName};
+
+#[test]
+fn decode_name() {
+ // 134 64: SEQUENCE {
+ // 136 11: SET {
+ // 138 9: SEQUENCE {
+ // 140 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 145 2: PrintableString 'US'
+ // : }
+ // : }
+ // 149 31: SET {
+ // 151 29: SEQUENCE {
+ // 153 3: OBJECT IDENTIFIER organizationName (2 5 4 10)
+ // 158 22: PrintableString 'Test Certificates 2011'
+ // : }
+ // : }
+ // 182 16: SET {
+ // 184 14: SEQUENCE {
+ // 186 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 191 7: PrintableString 'Good CA'
+ // : }
+ // : }
+ // : }
+ let rdn1 =
+ Name::from_der(&hex!("3040310B3009060355040613025553311F301D060355040A1316546573742043657274696669636174657320323031313110300E06035504031307476F6F64204341")[..]);
+ let rdn1a = rdn1.unwrap();
+
+ let mut counter = 0;
+ let i = rdn1a.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Test Certificates 2011"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Good CA"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ #[cfg(feature = "std")]
+ {
+ // https://datatracker.ietf.org/doc/html/rfc4514.html#section-2.1
+ // If the RDNSequence is an empty sequence, the result is the empty or
+ // zero-length string.
+ // Otherwise, the output consists of the string encodings of each
+ // RelativeDistinguishedName in the RDNSequence (according to Section 2.2),
+ // starting with the last element of the sequence and moving backwards
+ // toward the first.
+ // The encodings of adjoining RelativeDistinguishedNames are separated by
+ // a comma (',' U+002C) character.
+ let name = rdn1a.to_string();
+ assert_eq!(name, "CN=Good CA,O=Test Certificates 2011,C=US");
+
+ // https://github.com/RustCrypto/formats/issues/1121
+ let rdn1 = Name::from_der(&hex!("3081c0310b30090603550406130255533113301106035504080c0a43616c69666f726e69613116301406035504070c0d4d6f756e7461696e205669657731133011060355040a0c0a476f6f676c65204c4c43311e301c06035504030c154f51464176444e4457732e676f6f676c652e636f6d31243022060355040b0c1b6d616e6167656d656e743a64732e67726f75702e3338393131313131293027060a0992268993f22c6401010c196964656e746974793a64732e67726f75702e33383931313131")[..]);
+ let rdn1a = rdn1.unwrap();
+ let name = rdn1a.to_string();
+ assert_eq!(name, "UID=identity:ds.group.3891111,OU=management:ds.group.3891111,CN=OQFAvDNDWs.google.com,O=Google LLC,L=Mountain View,ST=California,C=US");
+ }
+}
+
+#[test]
+fn decode_rdn() {
+ // 0 11: SET {
+ // 2 9: SEQUENCE {
+ // 4 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 9 2: PrintableString 'US'
+ // : }
+ // : }
+ let rdn1 =
+ RelativeDistinguishedName::from_der(&hex!("310B3009060355040613025553")[..]).unwrap();
+ let i = rdn1.0.iter();
+ for atav in i {
+ let oid = atav.oid;
+ assert_eq!(oid.to_string(), "2.5.4.6");
+ let value = &atav.value;
+ assert_eq!(value.tag(), Tag::PrintableString);
+ let ps = PrintableStringRef::try_from(value).unwrap();
+ assert_eq!(ps.to_string(), "US");
+ }
+
+ // 0 31: SET {
+ // 2 17: SEQUENCE {
+ // 4 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 9 10: UTF8String 'JOHN SMITH'
+ // : }
+ // 21 10: SEQUENCE {
+ // 23 3: OBJECT IDENTIFIER organizationName (2 5 4 10)
+ // 28 3: UTF8String '123'
+ // : }
+ // : }
+
+ // reordered the encoding so second element above appears first so parsing can succeed
+ let rdn2a = RelativeDistinguishedName::from_der(
+ &hex!("311F300A060355040A0C03313233301106035504030C0A4A4F484E20534D495448")[..],
+ )
+ .unwrap();
+ let mut i = rdn2a.0.iter();
+ let atav1a = i.next().unwrap();
+ let oid2 = atav1a.oid;
+ assert_eq!(oid2.to_string(), "2.5.4.10");
+ let value2 = &atav1a.value;
+ assert_eq!(value2.tag(), Tag::Utf8String);
+ let utf8b = Utf8StringRef::try_from(value2).unwrap();
+ assert_eq!(utf8b.to_string(), "123");
+
+ let atav2a = i.next().unwrap();
+ let oid1 = atav2a.oid;
+ assert_eq!(oid1.to_string(), "2.5.4.3");
+ let value1 = &atav2a.value;
+ assert_eq!(value1.tag(), Tag::Utf8String);
+ let utf8a = Utf8StringRef::try_from(value1).unwrap();
+ assert_eq!(utf8a.to_string(), "JOHN SMITH");
+
+ let mut from_scratch = RelativeDistinguishedName::default();
+ assert!(from_scratch.0.insert(atav1a.clone()).is_ok());
+ assert!(from_scratch.0.insert(atav2a.clone()).is_ok());
+ let reencoded = from_scratch.to_der().unwrap();
+ assert_eq!(
+ reencoded,
+ &hex!("311F300A060355040A0C03313233301106035504030C0A4A4F484E20534D495448")
+ );
+
+ let mut from_scratch2 = RelativeDistinguishedName::default();
+ assert!(from_scratch2.0.insert_ordered(atav2a.clone()).is_ok());
+ // fails when caller adds items not in DER lexicographical order
+ assert!(from_scratch2.0.insert_ordered(atav1a.clone()).is_err());
+
+ // allow out-of-order RDNs (see: RustCrypto/formats#625)
+ assert!(RelativeDistinguishedName::from_der(
+ &hex!("311F301106035504030C0A4A4F484E20534D495448300A060355040A0C03313233")[..],
+ )
+ .is_ok());
+}
+
+// #[test]
+// fn encode_atav() {
+// // 0 11: SET {
+// // 2 9: SEQUENCE {
+// // 4 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+// // 9 2: PrintableString 'US'
+// // : }
+// // : }
+// let rdn1 =
+// RelativeDistinguishedName::from_der(&hex!("310B3009060355040613025553")[..]).unwrap();
+//
+// // Re-encode and compare to reference
+// let b1 = rdn1.to_vec().unwrap();
+// assert_eq!(b1, &hex!("310B3009060355040613025553")[..]);
+// let mut i = rdn1.iter();
+// let atav1 = i.next().unwrap();
+//
+// // 0 31: SET {
+// // 2 17: SEQUENCE {
+// // 4 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+// // 9 10: UTF8String 'JOHN SMITH'
+// // : }
+// // 21 10: SEQUENCE {
+// // 23 3: OBJECT IDENTIFIER organizationName (2 5 4 10)
+// // 28 3: UTF8String '123'
+// // : }
+// // : }
+// let rdn2 = RelativeDistinguishedName::from_der(
+// &hex!("311F301106035504030C0A4A4F484E20534D495448300A060355040A0C03313233")[..],
+// )
+// .unwrap();
+//
+// // Re-encode and compare to reference
+// let b1 = rdn2.to_vec().unwrap();
+// assert_eq!(
+// b1,
+// &hex!("311F301106035504030C0A4A4F484E20534D495448300A060355040A0C03313233")[..]
+// );
+//
+// let mut i = rdn2.iter();
+// let atav2 = i.next().unwrap();
+//
+// // Create new AttributeTypeAndValue with OID from second item above and value from first
+// let atav3: AttributeTypeAndValue = AttributeTypeAndValue {
+// oid: atav2.oid,
+// value: atav1.value,
+// };
+// let b3 = atav3.to_vec().unwrap();
+// assert_eq!(b3, &hex!("3009060355040313025553")[..]);
+// }
+
+/// Tests RdnSequence string serialization and deserialization
+#[test]
+fn rdns_serde() {
+ #[allow(clippy::type_complexity)]
+ let values: &[(&[&str], &str, &[&[AttributeTypeAndValue]])] = &[
+ (
+ &[
+ "CN=foo,SN=bar,C=baz+L=bat",
+ "commonName=foo,sn=bar,COUNTRYNAME=baz+l=bat",
+ ],
+ "CN=foo,SN=bar,C=baz+L=bat",
+ &[
+ &[
+ AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::C,
+ value: Any::from(PrintableStringRef::new("baz").unwrap()),
+ },
+ AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::L,
+ value: Any::from(Utf8StringRef::new("bat").unwrap()),
+ },
+ ],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::SN,
+ value: Any::from(Utf8StringRef::new("bar").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::CN,
+ value: Any::from(Utf8StringRef::new("foo").unwrap()),
+ }],
+ ],
+ ),
+ (
+ &["UID=jsmith,DC=example,DC=net"],
+ "UID=jsmith,DC=example,DC=net",
+ &[
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("net").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("example").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::UID,
+ value: Any::from(Utf8StringRef::new("jsmith").unwrap()),
+ }],
+ ],
+ ),
+ (
+ &["OU=Sales+CN=J. Smith,DC=example,DC=net"],
+ "OU=Sales+CN=J. Smith,DC=example,DC=net",
+ &[
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("net").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("example").unwrap()),
+ }],
+ &[
+ AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::OU,
+ value: Any::from(Utf8StringRef::new("Sales").unwrap()),
+ },
+ AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::CN,
+ value: Any::from(Utf8StringRef::new("J. Smith").unwrap()),
+ },
+ ],
+ ],
+ ),
+ (
+ &["CN=James \\\"Jim\\\" Smith\\, III,DC=example,DC=net"],
+ "CN=James \\\"Jim\\\" Smith\\, III,DC=example,DC=net",
+ &[
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("net").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("example").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::CN,
+ value: Any::from(Utf8StringRef::new(r#"James "Jim" Smith, III"#).unwrap()),
+ }],
+ ],
+ ),
+ (
+ &["CN=Before\\0dAfter,DC=example,DC=net"],
+ "CN=Before\\0dAfter,DC=example,DC=net",
+ &[
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("net").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::DC,
+ value: Any::from(Ia5StringRef::new("example").unwrap()),
+ }],
+ &[AttributeTypeAndValue {
+ oid: const_oid::db::rfc4519::CN,
+ value: Any::from(Utf8StringRef::new("Before\rAfter").unwrap()),
+ }],
+ ],
+ ),
+ (
+ &["1.3.6.1.4.1.1466.0=#04024869"],
+ "1.3.6.1.4.1.1466.0=#04024869",
+ &[&[AttributeTypeAndValue {
+ oid: ObjectIdentifier::new("1.3.6.1.4.1.1466.0").unwrap(),
+ value: Any::from(OctetStringRef::new(&[b'H', b'i']).unwrap()),
+ }]],
+ ),
+ ];
+
+ for (inputs, output, rdns) in values {
+ let mut brdns = RdnSequence::default();
+ for rdn in rdns.iter() {
+ let sofv = SetOfVec::try_from(rdn.to_vec()).unwrap();
+ brdns.0.push(RelativeDistinguishedName::from(sofv));
+ }
+
+ // Check that serialization matches the expected output.
+ eprintln!("output: {}", output);
+ assert_eq!(*output, format!("{}", brdns));
+
+ // Check that all inputs deserializize as expected.
+ for input in inputs.iter() {
+ eprintln!("input: {}", input);
+
+ let der = input
+ .parse::<RdnSequence>()
+ .and_then(|rdn| rdn.to_der())
+ .unwrap();
+
+ let rdns = RdnSequence::from_der(&der).unwrap();
+
+ for (l, r) in brdns.0.iter().zip(rdns.0.iter()) {
+ for (ll, rr) in l.0.iter().zip(r.0.iter()) {
+ assert_eq!(ll, rr);
+ }
+
+ assert_eq!(l, r);
+ }
+
+ assert_eq!(brdns, rdns);
+ }
+ }
+}
diff --git a/crates/x509-cert/tests/pkix_extensions.rs b/crates/x509-cert/tests/pkix_extensions.rs
new file mode 100644
index 0000000..108eeb5
--- /dev/null
+++ b/crates/x509-cert/tests/pkix_extensions.rs
@@ -0,0 +1,1220 @@
+//! Certificate tests
+use const_oid::AssociatedOid;
+use der::asn1::{Ia5StringRef, OctetString, PrintableStringRef, Utf8StringRef};
+use der::{Decode, Encode, ErrorKind, Length, Tag, Tagged};
+use hex_literal::hex;
+use x509_cert::ext::pkix::crl::dp::{DistributionPoint, ReasonFlags, Reasons};
+use x509_cert::ext::pkix::name::{DistributionPointName, GeneralName, GeneralNames};
+use x509_cert::ext::pkix::*;
+use x509_cert::ext::Extensions;
+use x509_cert::name::Name;
+use x509_cert::{serial_number::SerialNumber, Certificate, Version};
+
+use const_oid::db::rfc5280::*;
+use const_oid::db::rfc5912::ID_CE_CERTIFICATE_POLICIES;
+
+fn spin_over_exts(exts: Extensions) {
+ for ext in exts {
+ match ext.extn_id {
+ SubjectDirectoryAttributes::OID => {
+ let decoded =
+ SubjectDirectoryAttributes::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ SubjectKeyIdentifier::OID => {
+ let decoded = SubjectKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ KeyUsage::OID => {
+ let decoded = KeyUsage::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ PrivateKeyUsagePeriod::OID => {
+ let decoded = PrivateKeyUsagePeriod::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ SubjectAltName::OID => {
+ let decoded = SubjectAltName::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ IssuerAltName::OID => {
+ let decoded = IssuerAltName::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ BasicConstraints::OID => {
+ let decoded = BasicConstraints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ NameConstraints::OID => {
+ let decoded = NameConstraints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ CrlDistributionPoints::OID => {
+ let decoded = CrlDistributionPoints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ CertificatePolicies::OID => {
+ let decoded = CertificatePolicies::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ PolicyMappings::OID => {
+ let decoded = PolicyMappings::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ AuthorityKeyIdentifier::OID => {
+ let decoded = AuthorityKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ PolicyConstraints::OID => {
+ let decoded = PolicyConstraints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ ExtendedKeyUsage::OID => {
+ let decoded = ExtendedKeyUsage::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ FreshestCrl::OID => {
+ let decoded = FreshestCrl::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ InhibitAnyPolicy::OID => {
+ let decoded = InhibitAnyPolicy::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ AuthorityInfoAccessSyntax::OID => {
+ let decoded =
+ AuthorityInfoAccessSyntax::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ SubjectInfoAccessSyntax::OID => {
+ let decoded = SubjectInfoAccessSyntax::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ ext.extn_value,
+ decoded.to_der().and_then(OctetString::new).unwrap()
+ );
+ }
+
+ _ => {
+ eprintln!("ignoring {} with criticality {}", ext.extn_id, ext.critical);
+ }
+ }
+ }
+}
+
+#[test]
+fn decode_general_name() {
+ // DnsName
+ let dns_name = GeneralName::from_der(&hex!("820C616D617A6F6E2E636F2E756B")[..]).unwrap();
+ match dns_name {
+ GeneralName::DnsName(dns_name) => assert_eq!(dns_name.to_string(), "amazon.co.uk"),
+ _ => panic!("Failed to parse DnsName from GeneralName"),
+ }
+
+ // Rfc822Name
+ let rfc822 = GeneralName::from_der(
+ &hex!("811B456D61696C5F38303837323037343440746D612E6F73642E6D696C")[..],
+ )
+ .unwrap();
+ match rfc822 {
+ GeneralName::Rfc822Name(rfc822) => {
+ assert_eq!(rfc822.to_string(), "[email protected]")
+ }
+ _ => panic!("Failed to parse Rfc822Name from GeneralName"),
+ }
+
+ // OtherName
+ let bytes = hex!("A021060A2B060104018237140203A0130C1155706E5F323134393530313330406D696C");
+ match GeneralName::from_der(&bytes).unwrap() {
+ GeneralName::OtherName(other_name) => {
+ let onval = Utf8StringRef::try_from(&other_name.value).unwrap();
+ assert_eq!(onval.to_string(), "Upn_214950130@mil");
+ }
+ _ => panic!("Failed to parse OtherName from GeneralName"),
+ }
+}
+
+#[test]
+fn decode_cert() {
+ // cloned cert with variety of interesting bits, including subject DN encoded backwards, large
+ // policy mapping set, large policy set (including one with qualifiers), fairly typical set of
+ // extensions otherwise
+ let der_encoded_cert =
+ include_bytes!("examples/026EDA6FA1EDFA8C253936C75B5EEBD954BFF452.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ let i = exts.iter();
+ let mut counter = 0;
+ for ext in i {
+ if 0 == counter {
+ assert_eq!(ext.extn_id.to_string(), ID_CE_KEY_USAGE.to_string());
+ assert_eq!(ext.critical, true);
+
+ let ku = KeyUsage::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(KeyUsages::KeyCertSign | KeyUsages::CRLSign, ku);
+
+ let reencoded = ku.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+ } else if 1 == counter {
+ assert_eq!(ext.extn_id.to_string(), ID_CE_BASIC_CONSTRAINTS.to_string());
+ assert_eq!(ext.critical, true);
+ let bc = BasicConstraints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(true, bc.ca);
+ assert!(bc.path_len_constraint.is_none());
+
+ let reencoded = bc.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+ } else if 2 == counter {
+ assert_eq!(ext.extn_id.to_string(), ID_CE_POLICY_MAPPINGS.to_string());
+ assert_eq!(ext.critical, false);
+ let pm = PolicyMappings::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(19, pm.0.len());
+
+ let reencoded = pm.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+
+ let subject_domain_policy: [&str; 19] = [
+ "2.16.840.1.101.3.2.1.48.2",
+ "2.16.840.1.101.3.2.1.48.2",
+ "2.16.840.1.101.3.2.1.48.3",
+ "2.16.840.1.101.3.2.1.48.3",
+ "2.16.840.1.101.3.2.1.48.5",
+ "2.16.840.1.101.3.2.1.48.5",
+ "2.16.840.1.101.3.2.1.48.4",
+ "2.16.840.1.101.3.2.1.48.4",
+ "2.16.840.1.101.3.2.1.48.6",
+ "2.16.840.1.101.3.2.1.48.6",
+ "2.16.840.1.101.3.2.1.48.78",
+ "2.16.840.1.101.3.2.1.48.78",
+ "2.16.840.1.101.3.2.1.48.78",
+ "2.16.840.1.101.3.2.1.48.79",
+ "2.16.840.1.101.3.2.1.48.80",
+ "2.16.840.1.101.3.2.1.48.99",
+ "2.16.840.1.101.3.2.1.48.99",
+ "2.16.840.1.101.3.2.1.48.100",
+ "2.16.840.1.101.3.2.1.48.100",
+ ];
+
+ let issuer_domain_policy: [&str; 19] = [
+ "2.16.840.1.113839.0.100.2.1",
+ "2.16.840.1.113839.0.100.2.2",
+ "2.16.840.1.113839.0.100.3.1",
+ "2.16.840.1.113839.0.100.3.2",
+ "2.16.840.1.113839.0.100.14.1",
+ "2.16.840.1.113839.0.100.14.2",
+ "2.16.840.1.113839.0.100.12.1",
+ "2.16.840.1.113839.0.100.12.2",
+ "2.16.840.1.113839.0.100.15.1",
+ "2.16.840.1.113839.0.100.15.2",
+ "2.16.840.1.113839.0.100.18.0",
+ "2.16.840.1.113839.0.100.18.1",
+ "2.16.840.1.113839.0.100.18.2",
+ "2.16.840.1.113839.0.100.19.1",
+ "2.16.840.1.113839.0.100.20.1",
+ "2.16.840.1.113839.0.100.37.1",
+ "2.16.840.1.113839.0.100.37.2",
+ "2.16.840.1.113839.0.100.38.1",
+ "2.16.840.1.113839.0.100.38.2",
+ ];
+
+ let mut counter_pm = 0;
+ for mapping in pm.0 {
+ assert_eq!(
+ issuer_domain_policy[counter_pm],
+ mapping.issuer_domain_policy.to_string()
+ );
+ assert_eq!(
+ subject_domain_policy[counter_pm],
+ mapping.subject_domain_policy.to_string()
+ );
+ counter_pm += 1;
+ }
+ } else if 3 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_CERTIFICATE_POLICIES.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let cps = CertificatePolicies::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(19, cps.0.len());
+
+ let reencoded = cps.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+
+ let ids: [&str; 19] = [
+ "2.16.840.1.113839.0.100.2.1",
+ "2.16.840.1.113839.0.100.2.2",
+ "2.16.840.1.113839.0.100.3.1",
+ "2.16.840.1.113839.0.100.3.2",
+ "2.16.840.1.113839.0.100.14.1",
+ "2.16.840.1.113839.0.100.14.2",
+ "2.16.840.1.113839.0.100.12.1",
+ "2.16.840.1.113839.0.100.12.2",
+ "2.16.840.1.113839.0.100.15.1",
+ "2.16.840.1.113839.0.100.15.2",
+ "2.16.840.1.113839.0.100.18.0",
+ "2.16.840.1.113839.0.100.18.1",
+ "2.16.840.1.113839.0.100.18.2",
+ "2.16.840.1.113839.0.100.19.1",
+ "2.16.840.1.113839.0.100.20.1",
+ "2.16.840.1.113839.0.100.37.1",
+ "2.16.840.1.113839.0.100.37.2",
+ "2.16.840.1.113839.0.100.38.1",
+ "2.16.840.1.113839.0.100.38.2",
+ ];
+
+ let mut cp_counter = 0;
+ for cp in cps.0 {
+ assert_eq!(ids[cp_counter], cp.policy_identifier.to_string());
+ if 18 == cp_counter {
+ assert!(cp.policy_qualifiers.is_some());
+ let pq = cp.policy_qualifiers.unwrap();
+ let mut counter_pq = 0;
+ for pqi in pq.iter() {
+ if 0 == counter_pq {
+ assert_eq!("1.3.6.1.5.5.7.2.1", pqi.policy_qualifier_id.to_string());
+ let cpsval =
+ Ia5StringRef::try_from(pqi.qualifier.as_ref().unwrap()).unwrap();
+ assert_eq!(
+ "https://secure.identrust.com/certificates/policy/IGC/index.html",
+ cpsval.to_string()
+ );
+ } else if 1 == counter_pq {
+ assert_eq!("1.3.6.1.5.5.7.2.2", pqi.policy_qualifier_id.to_string());
+ // TODO VisibleString
+ }
+ counter_pq += 1;
+ }
+ } else {
+ assert!(cp.policy_qualifiers.is_none())
+ }
+
+ cp_counter += 1;
+ }
+ } else if 4 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_SUBJECT_KEY_IDENTIFIER.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let skid = SubjectKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(Length::new(21), skid.0.len());
+ assert_eq!(
+ &hex!("DBD3DEBF0D7B615B32803BC0206CD7AADD39B8ACFF"),
+ skid.0.as_bytes()
+ );
+
+ let reencoded = skid.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+ } else if 5 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_CRL_DISTRIBUTION_POINTS.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let crl_dps = CrlDistributionPoints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(2, crl_dps.0.len());
+
+ let reencoded = crl_dps.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+
+ let mut crldp_counter = 0;
+ for crldp in crl_dps.0 {
+ let dpn = crldp.distribution_point.unwrap();
+ if 0 == crldp_counter {
+ match dpn {
+ DistributionPointName::FullName(gns) => {
+ assert_eq!(1, gns.len());
+ let gn = gns.get(0).unwrap();
+ match gn {
+ GeneralName::UniformResourceIdentifier(uri) => {
+ assert_eq!(
+ "http://crl-pte.identrust.com.test/crl/IGCRootca1.crl",
+ uri.to_string()
+ );
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ }
+ _ => {
+ panic!("Expected FullName");
+ }
+ }
+ } else if 1 == crldp_counter {
+ match dpn {
+ DistributionPointName::FullName(gns) => {
+ assert_eq!(1, gns.len());
+ let gn = gns.get(0).unwrap();
+ match gn {
+ GeneralName::UniformResourceIdentifier(uri) => {
+ assert_eq!("ldap://ldap-pte.identrust.com.test/cn%3DIGC%20Root%20CA1%2Co%3DIdenTrust%2Cc%3DUS%3FcertificateRevocationList%3Bbinary", uri.to_string());
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ }
+
+ crldp_counter += 1;
+ }
+ } else if 6 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_PE_SUBJECT_INFO_ACCESS.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let sias = SubjectInfoAccessSyntax::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(1, sias.0.len());
+
+ let reencoded = sias.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+
+ for sia in sias.0 {
+ assert_eq!("1.3.6.1.5.5.7.48.5", sia.access_method.to_string());
+ let gn = sia.access_location;
+ match gn {
+ GeneralName::UniformResourceIdentifier(gn) => {
+ assert_eq!(
+ "http://http.cite.fpki-lab.gov.test/bridge/caCertsIssuedBytestFBCA.p7c",
+ gn.to_string()
+ );
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ }
+ } else if 7 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_PE_AUTHORITY_INFO_ACCESS.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let aias = AuthorityInfoAccessSyntax::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(2, aias.0.len());
+ let mut aia_counter = 0;
+
+ let reencoded = aias.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+
+ for aia in aias.0 {
+ if 0 == aia_counter {
+ assert_eq!("1.3.6.1.5.5.7.48.2", aia.access_method.to_string());
+ let gn = aia.access_location;
+ match gn {
+ GeneralName::UniformResourceIdentifier(gn) => {
+ assert_eq!(
+ "http://apps-stg.identrust.com.test/roots/IGCRootca1.p7c",
+ gn.to_string()
+ );
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ } else if 1 == aia_counter {
+ assert_eq!("1.3.6.1.5.5.7.48.1", aia.access_method.to_string());
+ let gn = aia.access_location;
+ match gn {
+ GeneralName::UniformResourceIdentifier(gn) => {
+ assert_eq!(
+ "http://igcrootpte.ocsp.identrust.com.test:8125",
+ gn.to_string()
+ );
+ }
+ _ => {
+ panic!("Expected UniformResourceIdentifier");
+ }
+ }
+ }
+
+ aia_counter += 1;
+ }
+ } else if 8 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_INHIBIT_ANY_POLICY.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let iap = InhibitAnyPolicy::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(0, iap.0);
+
+ let reencoded = iap.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+ } else if 9 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_AUTHORITY_KEY_IDENTIFIER.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let akid = AuthorityKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ &hex!("7C4C863AB80BD589870BEDB7E11BBD2A08BB3D23FF"),
+ akid.key_identifier.as_ref().unwrap().as_bytes()
+ );
+
+ let reencoded = akid.to_der().and_then(OctetString::new).unwrap();
+ assert_eq!(ext.extn_value, reencoded);
+ }
+
+ counter += 1;
+ }
+
+ let der_encoded_cert = include_bytes!("examples/GoodCACert.crt");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+
+ assert_eq!(cert.tbs_certificate.version, Version::V3);
+ let target_serial: [u8; 1] = [2];
+ assert_eq!(
+ cert.tbs_certificate.serial_number,
+ SerialNumber::new(&target_serial).unwrap()
+ );
+ assert_eq!(
+ cert.tbs_certificate.signature.oid.to_string(),
+ "1.2.840.113549.1.1.11"
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .signature
+ .parameters
+ .as_ref()
+ .unwrap()
+ .tag(),
+ Tag::Null
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .signature
+ .parameters
+ .as_ref()
+ .unwrap()
+ .is_null(),
+ true
+ );
+
+ let mut counter = 0;
+ let i = cert.tbs_certificate.issuer.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Test Certificates 2011"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Trust Anchor"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ assert_eq!(
+ cert.tbs_certificate
+ .validity
+ .not_before
+ .to_unix_duration()
+ .as_secs(),
+ 1262334600
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .validity
+ .not_after
+ .to_unix_duration()
+ .as_secs(),
+ 1924936200
+ );
+
+ counter = 0;
+ let i = cert.tbs_certificate.subject.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Test Certificates 2011"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Good CA"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ assert_eq!(
+ cert.tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .oid
+ .to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .parameters
+ .as_ref()
+ .unwrap()
+ .tag(),
+ Tag::Null
+ );
+ assert_eq!(
+ cert.tbs_certificate
+ .subject_public_key_info
+ .algorithm
+ .parameters
+ .as_ref()
+ .unwrap()
+ .is_null(),
+ true
+ );
+
+ // TODO - parse and compare public key
+
+ counter = 0;
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ let i = exts.iter();
+ for ext in i {
+ if 0 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_AUTHORITY_KEY_IDENTIFIER.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let akid = AuthorityKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ akid.key_identifier.unwrap().as_bytes(),
+ &hex!("E47D5FD15C9586082C05AEBE75B665A7D95DA866")[..]
+ );
+ } else if 1 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_SUBJECT_KEY_IDENTIFIER.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let skid = SubjectKeyIdentifier::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(
+ skid.0.as_bytes(),
+ &hex!("580184241BBC2B52944A3DA510721451F5AF3AC9")[..]
+ );
+ } else if 2 == counter {
+ assert_eq!(ext.extn_id.to_string(), ID_CE_KEY_USAGE.to_string());
+ assert_eq!(ext.critical, true);
+ let ku = KeyUsage::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(KeyUsages::KeyCertSign | KeyUsages::CRLSign, ku);
+ } else if 3 == counter {
+ assert_eq!(
+ ext.extn_id.to_string(),
+ ID_CE_CERTIFICATE_POLICIES.to_string()
+ );
+ assert_eq!(ext.critical, false);
+ let r = CertificatePolicies::from_der(ext.extn_value.as_bytes());
+ let cp = r.unwrap();
+ let i = cp.0.iter();
+ for p in i {
+ assert_eq!(p.policy_identifier.to_string(), "2.16.840.1.101.3.2.1.48.1");
+ }
+ } else if 4 == counter {
+ assert_eq!(ext.extn_id.to_string(), ID_CE_BASIC_CONSTRAINTS.to_string());
+ assert_eq!(ext.critical, true);
+ let bc = BasicConstraints::from_der(ext.extn_value.as_bytes()).unwrap();
+ assert_eq!(bc.ca, true);
+ assert_eq!(bc.path_len_constraint, Option::None);
+ }
+
+ counter += 1;
+ }
+ assert_eq!(
+ cert.signature_algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.11"
+ );
+ assert_eq!(
+ cert.signature_algorithm.parameters.as_ref().unwrap().tag(),
+ Tag::Null
+ );
+ assert_eq!(cert.signature_algorithm.parameters.unwrap().is_null(), true);
+
+ // TODO - parse and compare signature value
+
+ // This cert adds extended key usage and netscape cert type vs above samples
+ let der_encoded_cert = include_bytes!("examples/0954e2343dd5efe0a7f0967d69caf33e5f893720.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds extended key usage and name constraints vs above samples
+ let der_encoded_cert = include_bytes!("examples/0fcc78fbbca9f32b08b19b032b84f2c86a128f35.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds logotype (which is unrecognized) vs above samples
+ let der_encoded_cert = include_bytes!("examples/15b05c4865410c6b3ff76a4e8f3d87276756bd0c.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert features an EC key unlike the above samples
+ let der_encoded_cert = include_bytes!("examples/16ee54e48c76eaa1052e09010d8faefee95e5ebb.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds issuer alt name vs above samples
+ let der_encoded_cert = include_bytes!("examples/342cd9d3062da48c346965297f081ebc2ef68fdc.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds policy constraints vs above samples
+ let der_encoded_cert = include_bytes!("examples/2049a5b28f104b2c6e1a08546f9cfc0353d6fd30.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds subject alt name vs above samples
+ let der_encoded_cert = include_bytes!("examples/21723e7a0fb61a0bd4a29879b82a02b2fb4ad096.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds subject directory attributes vs above samples
+ let der_encoded_cert =
+ include_bytes!("examples/085B1E2F40254F9C7A2387BE9FF4EC116C326E10.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds private key usage period (and an unprocessed Entrust extension) vs above samples
+ let der_encoded_cert =
+ include_bytes!("examples/554D5FF11DA613A155584D8D4AA07F67724D8077.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds OCSP no check vs above samples
+ let der_encoded_cert =
+ include_bytes!("examples/28879DABB0FD11618FB74E47BE049D2933866D53.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+
+ // This cert adds PIV NACI indicator vs above samples
+ let der_encoded_cert =
+ include_bytes!("examples/288C8BCFEE6B89D110DAE2C9873897BF7FF53382.fake.der");
+ let result = Certificate::from_der(der_encoded_cert);
+ let cert: Certificate = result.unwrap();
+ let exts = cert.tbs_certificate.extensions.unwrap();
+ spin_over_exts(exts);
+}
+
+#[test]
+fn decode_idp() {
+ use der::TagNumber;
+
+ // IDP from 04A8739769B3C090A11DCDFABA3CF33F4BEF21F3.crl in PKITS 2048 in ficam-scvp-testing repo
+ let idp = IssuingDistributionPoint::from_der(&hex!("30038201FF")).unwrap();
+ assert_eq!(idp.only_contains_ca_certs, true);
+ assert_eq!(idp.only_contains_attribute_certs, false);
+ assert_eq!(idp.only_contains_user_certs, false);
+ assert_eq!(idp.indirect_crl, false);
+ assert!(idp.only_some_reasons.is_none());
+ assert!(idp.distribution_point.is_none());
+
+ let n =
+ Name::from_der(&hex!("305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C")).unwrap();
+ assert_eq!(4, n.0.len());
+
+ let gn =
+ GeneralName::from_der(&hex!("A45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C")).unwrap();
+ match gn {
+ GeneralName::DirectoryName(gn) => {
+ assert_eq!(4, gn.0.len());
+ }
+ _ => {}
+ }
+
+ let gns =
+ GeneralNames::from_der(&hex!("305EA45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C")).unwrap();
+ assert_eq!(1, gns.len());
+ let gn = gns.get(0).unwrap();
+ match gn {
+ GeneralName::DirectoryName(gn) => {
+ assert_eq!(4, gn.0.len());
+ }
+ _ => {}
+ }
+
+ //TODO - fix decode impl (expecting a SEQUENCE despite this being a CHOICE). Sort out FixedTag implementation.
+ // let dpn =
+ // DistributionPointName::from_der(&hex!("A05EA45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C")).unwrap();
+ // match dpn {
+ // DistributionPointName::FullName(dpn) => {
+ // assert_eq!(1, dpn.len());
+ // let gn = dpn.get(0).unwrap();
+ // match gn {
+ // GeneralName::DirectoryName(gn) => {
+ // assert_eq!(4, gn.len());
+ // }
+ // _ => {}
+ // }
+ // }
+ // _ => {}
+ // }
+
+ let dp =
+ DistributionPoint::from_der(&hex!("3062A060A05EA45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C")).unwrap();
+ let dpn = dp.distribution_point.unwrap();
+ match dpn {
+ DistributionPointName::FullName(dpn) => {
+ assert_eq!(1, dpn.len());
+ let gn = dpn.get(0).unwrap();
+ match gn {
+ GeneralName::DirectoryName(gn) => {
+ assert_eq!(4, gn.0.len());
+ }
+ _ => {}
+ }
+ }
+ _ => {}
+ }
+ assert!(dp.crl_issuer.is_none());
+ assert!(dp.reasons.is_none());
+
+ // 0 103: SEQUENCE {
+ // 2 96: [0] {
+ // 4 94: [0] {
+ // 6 92: [4] {
+ // 8 90: SEQUENCE {
+ // 10 11: SET {
+ // 12 9: SEQUENCE {
+ // 14 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 19 2: PrintableString 'US'
+ // : }
+ // : }
+ // 23 31: SET {
+ // 25 29: SEQUENCE {
+ // 27 3: OBJECT IDENTIFIER organizationName (2 5 4 10)
+ // 32 22: PrintableString 'Test Certificates 2017'
+ // : }
+ // : }
+ // 56 28: SET {
+ // 58 26: SEQUENCE {
+ // 60 3: OBJECT IDENTIFIER organizationalUnitName (2 5 4 11)
+ // 65 19: PrintableString 'onlySomeReasons CA3'
+ // : }
+ // : }
+ // 86 12: SET {
+ // 88 10: SEQUENCE {
+ // 90 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 95 3: PrintableString 'CRL'
+ // : }
+ // : }
+ // : }
+ // : }
+ // : }
+ // : }
+ // 100 3: [3] 07 9F 80
+ // : }
+ // IDP from 54B0D2A6F6AA4780771CC4F9F076F623CEB0F57E.crl in PKITS 2048 in ficam-scvp-testing repo
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("3067A060A05EA45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C8303079F80")).unwrap();
+ assert_eq!(idp.only_contains_ca_certs, false);
+ assert_eq!(idp.only_contains_attribute_certs, false);
+ assert_eq!(idp.only_contains_user_certs, false);
+ assert_eq!(idp.indirect_crl, false);
+ assert!(idp.only_some_reasons.is_some());
+ assert!(idp.distribution_point.is_some());
+
+ assert_eq!(
+ Reasons::Unused
+ | Reasons::AffiliationChanged
+ | Reasons::Superseded
+ | Reasons::CessationOfOperation
+ | Reasons::CertificateHold
+ | Reasons::PrivilegeWithdrawn
+ | Reasons::AaCompromise,
+ idp.only_some_reasons.unwrap()
+ );
+
+ // 930 360: SEQUENCE {
+ // 934 353: [0] {
+ // 938 349: [0] {
+ // 942 117: [4] {
+ // 944 115: SEQUENCE {
+ // 946 11: SET {
+ // 948 9: SEQUENCE {
+ // 950 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 955 2: PrintableString 'US'
+ // : }
+ // : }
+ // 959 31: SET {
+ // 961 29: SEQUENCE {
+ // 963 3: OBJECT IDENTIFIER
+ // : organizationName (2 5 4 10)
+ // 968 22: PrintableString 'Test Certificates 2017'
+ // : }
+ // : }
+ // 992 24: SET {
+ // 994 22: SEQUENCE {
+ // 996 3: OBJECT IDENTIFIER
+ // : organizationalUnitName (2 5 4 11)
+ // 1001 15: PrintableString 'indirectCRL CA5'
+ // : }
+ // : }
+ // 1018 41: SET {
+ // 1020 39: SEQUENCE {
+ // 1022 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 1027 32: PrintableString 'indirect CRL for indirectCRL CA6'
+ // : }
+ // : }
+ // : }
+ // : }
+ // 1061 117: [4] {
+ // 1063 115: SEQUENCE {
+ // 1065 11: SET {
+ // 1067 9: SEQUENCE {
+ // 1069 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 1074 2: PrintableString 'US'
+ // : }
+ // : }
+ // 1078 31: SET {
+ // 1080 29: SEQUENCE {
+ // 1082 3: OBJECT IDENTIFIER
+ // : organizationName (2 5 4 10)
+ // 1087 22: PrintableString 'Test Certificates 2017'
+ // : }
+ // : }
+ // 1111 24: SET {
+ // 1113 22: SEQUENCE {
+ // 1115 3: OBJECT IDENTIFIER
+ // : organizationalUnitName (2 5 4 11)
+ // 1120 15: PrintableString 'indirectCRL CA5'
+ // : }
+ // : }
+ // 1137 41: SET {
+ // 1139 39: SEQUENCE {
+ // 1141 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 1146 32: PrintableString 'indirect CRL for indirectCRL CA7'
+ // : }
+ // : }
+ // : }
+ // : }
+ // 1180 109: [4] {
+ // 1182 107: SEQUENCE {
+ // 1184 11: SET {
+ // 1186 9: SEQUENCE {
+ // 1188 3: OBJECT IDENTIFIER countryName (2 5 4 6)
+ // 1193 2: PrintableString 'US'
+ // : }
+ // : }
+ // 1197 31: SET {
+ // 1199 29: SEQUENCE {
+ // 1201 3: OBJECT IDENTIFIER
+ // : organizationName (2 5 4 10)
+ // 1206 22: PrintableString 'Test Certificates 2017'
+ // : }
+ // : }
+ // 1230 24: SET {
+ // 1232 22: SEQUENCE {
+ // 1234 3: OBJECT IDENTIFIER
+ // : organizationalUnitName (2 5 4 11)
+ // 1239 15: PrintableString 'indirectCRL CA5'
+ // : }
+ // : }
+ // 1256 33: SET {
+ // 1258 31: SEQUENCE {
+ // 1260 3: OBJECT IDENTIFIER commonName (2 5 4 3)
+ // 1265 24: PrintableString 'CRL1 for indirectCRL CA5'
+ // : }
+ // : }
+ // : }
+ // : }
+ // : }
+ // : }
+ // 1291 1: [4] FF
+ // : }
+ // : }
+ // : }
+ // IDP from 959528526E54B646AF895E2362D3AD20F4B3284D.crl in PKITS 2048 in ficam-scvp-testing repo
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("30820168A0820161A082015DA4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434136A4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434137A46D306B310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353121301F0603550403131843524C3120666F7220696E64697265637443524C204341358401FF")).unwrap();
+ assert_eq!(idp.only_contains_ca_certs, false);
+ assert_eq!(idp.only_contains_attribute_certs, false);
+ assert_eq!(idp.only_contains_user_certs, false);
+ assert_eq!(idp.indirect_crl, true);
+ assert!(idp.only_some_reasons.is_none());
+ assert!(idp.distribution_point.is_some());
+ let dp = idp.distribution_point.unwrap();
+ match dp {
+ DistributionPointName::FullName(dp) => {
+ assert_eq!(3, dp.len());
+ for gn in dp {
+ match gn {
+ GeneralName::DirectoryName(gn) => {
+ assert_eq!(4, gn.0.len());
+ }
+ _ => {
+ panic!("Expected DirectoryName")
+ }
+ }
+ }
+ }
+ _ => {
+ panic!("Expected FullName")
+ }
+ }
+
+ // Tag on second RDN in first name is TeletexString (20) instead of PrintableString (19)
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("30820168A0820161A082015DA4753073310B3009060355040613025553311F301D060355040A14165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434136A4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434137A46D306B310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353121301F0603550403131843524C3120666F7220696E64697265637443524C204341358401FF")).unwrap();
+ assert_eq!(idp.only_contains_ca_certs, false);
+ assert_eq!(idp.only_contains_attribute_certs, false);
+ assert_eq!(idp.only_contains_user_certs, false);
+ assert_eq!(idp.indirect_crl, true);
+ assert!(idp.only_some_reasons.is_none());
+ assert!(idp.distribution_point.is_some());
+ let dp = idp.distribution_point.unwrap();
+ match dp {
+ DistributionPointName::FullName(dp) => {
+ assert_eq!(3, dp.len());
+ for gn in dp {
+ match gn {
+ GeneralName::DirectoryName(gn) => {
+ assert_eq!(4, gn.0.len());
+ }
+ _ => {
+ panic!("Expected DirectoryName")
+ }
+ }
+ }
+ }
+ _ => {
+ panic!("Expected FullName")
+ }
+ }
+
+ //---------------------------------
+ // Negative tests
+ //---------------------------------
+ // Value contains more than length value indicates
+ let reason_flags = ReasonFlags::from_der(&hex!("0302079F80"));
+ let err = reason_flags.err().unwrap();
+ assert_eq!(
+ ErrorKind::TrailingData {
+ decoded: 4u8.into(),
+ remaining: 1u8.into()
+ },
+ err.kind()
+ );
+
+ // Value incomplete relative to length value
+ let reason_flags = ReasonFlags::from_der(&hex!("0304079F80"));
+ let err = reason_flags.err().unwrap();
+ assert_eq!(
+ ErrorKind::Incomplete {
+ expected_len: 6u8.into(),
+ actual_len: 5u8.into()
+ },
+ err.kind()
+ );
+
+ // Value incomplete relative to length value
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("3067A060A05EA45C305A310B3009060355040613025553311F301D060355040A131654657374204365727469666963617465732032303137311C301A060355040B13136F6E6C79536F6D65526561736F6E7320434133310C300A0603550403130343524C8304079F80"));
+ let err = idp.err().unwrap();
+ assert_eq!(err.position().unwrap(), 103u8.into());
+ assert_eq!(
+ ErrorKind::Incomplete {
+ expected_len: 106u8.into(),
+ actual_len: 105u8.into()
+ },
+ err.kind()
+ );
+
+ // Truncated
+ let reason_flags = ReasonFlags::from_der(&hex!("0303079F"));
+ let err = reason_flags.err().unwrap();
+ assert_eq!(
+ ErrorKind::Incomplete {
+ expected_len: 5u8.into(),
+ actual_len: 4u8.into()
+ },
+ err.kind()
+ );
+
+ // Nonsensical tag where BIT STRING tag should be
+ let reason_flags = ReasonFlags::from_der(&hex!("FF03079F80"));
+ let err = reason_flags.err().unwrap();
+ assert_eq!(ErrorKind::TagNumberInvalid, err.kind());
+
+ // INTEGER tag where BIT STRING expected
+ let reason_flags = ReasonFlags::from_der(&hex!("0203079F80"));
+ let err = reason_flags.err().unwrap();
+ assert_eq!(
+ ErrorKind::TagUnexpected {
+ expected: Some(Tag::BitString),
+ actual: Tag::Integer
+ },
+ err.kind()
+ );
+
+ // Context specific tag that should be primitive is constructed
+ let idp = IssuingDistributionPoint::from_der(&hex!("3003A201FF"));
+ let err = idp.err().unwrap();
+ assert_eq!(
+ ErrorKind::Noncanonical {
+ tag: Tag::ContextSpecific {
+ constructed: true,
+ number: TagNumber::new(2)
+ }
+ },
+ err.kind()
+ );
+
+ // Boolean value is two bytes long
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("30820168A0820161A082015DA4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434136A4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434137A46D306B310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353121301F0603550403131843524C3120666F7220696E64697265637443524C204341358402FFFF"));
+ let err = idp.err().unwrap();
+ assert_eq!(ErrorKind::Length { tag: Tag::Boolean }, err.kind());
+
+ // Boolean value is neither 0x00 nor 0xFF
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("30820168A0820161A082015DA4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434136A4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434137A46D306B310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353121301F0603550403131843524C3120666F7220696E64697265637443524C20434135840175"));
+ let err = idp.err().unwrap();
+ assert_eq!(ErrorKind::Noncanonical { tag: Tag::Boolean }, err.kind());
+
+ // Length on second RDN in first name indicates more bytes than are present
+ let idp =
+ IssuingDistributionPoint::from_der(&hex!("30820168A0820161A082015DA4753073310B3009060355040613025553311F301D060355040A13995465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434136A4753073310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353129302706035504031320696E6469726563742043524C20666F7220696E64697265637443524C20434137A46D306B310B3009060355040613025553311F301D060355040A13165465737420436572746966696361746573203230313731183016060355040B130F696E64697265637443524C204341353121301F0603550403131843524C3120666F7220696E64697265637443524C204341358401FF"));
+ let err = idp.err().unwrap();
+ assert_eq!(
+ ErrorKind::Length {
+ tag: Tag::PrintableString
+ },
+ err.kind()
+ );
+}
diff --git a/crates/x509-cert/tests/trust_anchor_format.rs b/crates/x509-cert/tests/trust_anchor_format.rs
new file mode 100644
index 0000000..a1bdc69
--- /dev/null
+++ b/crates/x509-cert/tests/trust_anchor_format.rs
@@ -0,0 +1,461 @@
+use der::{
+ asn1::{Ia5StringRef, PrintableStringRef},
+ Decode, Encode, SliceReader,
+};
+use hex_literal::hex;
+use x509_cert::anchor::{CertPolicies, TrustAnchorChoice};
+use x509_cert::ext::pkix::name::GeneralName;
+
+#[test]
+fn decode_ta1() {
+ // features an ECA cert wrapped in a TrustAnchorInfo that contains a pile of certificate policies
+ // in the cert path controls field
+ let der_encoded_tac = include_bytes!("examples/eca_policies.ta");
+ let der_encoded_cert = include_bytes!("examples/eca.der");
+
+ let mut decoder = SliceReader::new(der_encoded_tac).unwrap();
+ let tac = TrustAnchorChoice::decode(&mut decoder).unwrap();
+ let reencoded_tac = tac.to_der().unwrap();
+ println!("Original : {:02X?}", der_encoded_cert);
+ println!("Reencoded: {:02X?}", reencoded_tac);
+ assert_eq!(der_encoded_tac, reencoded_tac.as_slice());
+
+ match tac {
+ TrustAnchorChoice::TaInfo(tai) => {
+ assert_eq!(
+ tai.pub_key.algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+
+ assert_eq!(
+ &hex!("335BA56F7A55602B814B2614CC79BF4ABA8B32BD"),
+ tai.key_id.as_bytes()
+ );
+
+ let policy_ids: [&str; 42] = [
+ "1.2.36.1.334.1.2.1.2",
+ "1.2.840.113549.5.6.1.3.1.12",
+ "1.2.840.113549.5.6.1.3.1.18",
+ "1.3.6.1.4.1.103.100.1.1.3.1",
+ "1.3.6.1.4.1.13948.1.1.1.2",
+ "1.3.6.1.4.1.13948.1.1.1.6",
+ "1.3.6.1.4.1.1569.10.1.1",
+ "1.3.6.1.4.1.1569.10.1.2",
+ "1.3.6.1.4.1.16304.3.6.2.12",
+ "1.3.6.1.4.1.16304.3.6.2.20",
+ "1.3.6.1.4.1.16334.509.2.6",
+ "1.3.6.1.4.1.23337.1.1.10",
+ "1.3.6.1.4.1.23337.1.1.8",
+ "1.3.6.1.4.1.2396.2.1.2",
+ "1.3.6.1.4.1.2396.2.1.7",
+ "1.3.6.1.4.1.24019.1.1.1.18",
+ "1.3.6.1.4.1.24019.1.1.1.19",
+ "1.3.6.1.4.1.24019.1.1.1.2",
+ "1.3.6.1.4.1.24019.1.1.1.7",
+ "1.3.6.1.4.1.73.15.3.1.12",
+ "1.3.6.1.4.1.73.15.3.1.5",
+ "2.16.528.1.1003.1.2.5.1",
+ "2.16.528.1.1003.1.2.5.2",
+ "2.16.840.1.101.2.1.11.19",
+ "2.16.840.1.101.3.2.1.12.2",
+ "2.16.840.1.101.3.2.1.12.3",
+ "2.16.840.1.101.3.2.1.3.12",
+ "2.16.840.1.101.3.2.1.3.13",
+ "2.16.840.1.101.3.2.1.3.16",
+ "2.16.840.1.101.3.2.1.3.18",
+ "2.16.840.1.101.3.2.1.3.24",
+ "2.16.840.1.101.3.2.1.3.4",
+ "2.16.840.1.101.3.2.1.3.7",
+ "2.16.840.1.101.3.2.1.5.4",
+ "2.16.840.1.101.3.2.1.5.5",
+ "2.16.840.1.101.3.2.1.6.12",
+ "2.16.840.1.101.3.2.1.6.4",
+ "2.16.840.1.113733.1.7.23.3.1.18",
+ "2.16.840.1.113733.1.7.23.3.1.7",
+ "2.16.840.1.114027.200.3.10.7.2",
+ "2.16.840.1.114027.200.3.10.7.4",
+ "2.16.840.1.114027.200.3.10.7.6",
+ ];
+
+ let cert_path = tai.cert_path.as_ref().unwrap();
+ let mut counter = 0;
+ let exts = cert_path.policy_set.as_ref().unwrap();
+ let i = exts.0.iter();
+ for ext in i {
+ assert_eq!(policy_ids[counter], ext.policy_identifier.to_string());
+ counter += 1;
+ }
+
+ counter = 0;
+ let i = cert_path.ta_name.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "U.S. Government"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "ECA"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "ECA Root CA 4"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ let reencoded_cert = cert_path.certificate.to_der().unwrap();
+ assert_eq!(der_encoded_cert, reencoded_cert.as_slice());
+ }
+ _ => panic!("Unexpected TrustAnchorChoice contents"),
+ }
+}
+
+#[test]
+fn decode_ta2() {
+ // features an Entrust cert wrapped in a TrustAnchorInfo that contains an excluded subtree in the
+ // name constraint in the cert path controls field
+ let der_encoded_tac = include_bytes!("examples/entrust_dnConstraint.ta");
+ let der_encoded_cert = include_bytes!("examples/entrust.der");
+
+ let mut decoder = SliceReader::new(der_encoded_tac).unwrap();
+ let tac = TrustAnchorChoice::decode(&mut decoder).unwrap();
+ let reencoded_tac = tac.to_der().unwrap();
+ println!("Original : {:02X?}", der_encoded_cert);
+ println!("Reencoded: {:02X?}", reencoded_tac);
+ assert_eq!(der_encoded_tac, reencoded_tac.as_slice());
+
+ match tac {
+ TrustAnchorChoice::TaInfo(tai) => {
+ assert_eq!(
+ tai.pub_key.algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+
+ assert_eq!(
+ &hex!("1A74551E8A85089F505D3E8A46018A819CF99E1E"),
+ tai.key_id.as_bytes()
+ );
+
+ let cert_path = tai.cert_path.as_ref().unwrap();
+
+ let mut counter = 0;
+ let i = cert_path.ta_name.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Entrust"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Certification Authorities"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Entrust Managed Services NFI Root CA"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ let nc = cert_path.name_constr.as_ref().unwrap();
+ counter = 0;
+ let gsi = nc.excluded_subtrees.as_ref().unwrap().iter();
+ for gs in gsi {
+ match &gs.base {
+ GeneralName::DirectoryName(dn) => {
+ let i = dn.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "U.S. Government"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "DoD"
+ );
+ }
+ counter += 1;
+ }
+ }
+ }
+ _ => panic!("Unexpected GeneralSubtree type"),
+ }
+ }
+
+ let reencoded_cert = cert_path.certificate.to_der().unwrap();
+ assert_eq!(der_encoded_cert, reencoded_cert.as_slice());
+ }
+ _ => panic!("Unexpected TrustAnchorChoice contents"),
+ }
+}
+
+#[test]
+fn decode_ta3() {
+ // features an Exostar cert wrapped in a TrustAnchorInfo that contains an excluded subtree in the
+ // name constraint and policy flags in the cert path controls field
+ let der_encoded_tac = include_bytes!("examples/exostar_policyFlags.ta");
+ let der_encoded_cert = include_bytes!("examples/exostar.der");
+
+ let mut decoder = SliceReader::new(der_encoded_tac).unwrap();
+ let tac = TrustAnchorChoice::decode(&mut decoder).unwrap();
+ let reencoded_tac = tac.to_der().unwrap();
+ println!("Original : {:02X?}", der_encoded_cert);
+ println!("Reencoded: {:02X?}", reencoded_tac);
+ assert_eq!(der_encoded_tac, reencoded_tac.as_slice());
+
+ match tac {
+ TrustAnchorChoice::TaInfo(tai) => {
+ assert_eq!(
+ tai.pub_key.algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+
+ assert_eq!(
+ &hex!("2EBE91A6776A373CF5FD1DB6DD78C9A6E5F42220"),
+ tai.key_id.as_bytes()
+ );
+
+ let cert_path = tai.cert_path.as_ref().unwrap();
+
+ assert_eq!(
+ CertPolicies::InhibitPolicyMapping
+ | CertPolicies::RequireExplicitPolicy
+ | CertPolicies::InhibitAnyPolicy,
+ cert_path.policy_flags.unwrap()
+ );
+
+ let mut counter = 0;
+ let i = cert_path.ta_name.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Exostar LLC"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Certification Authorities"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.3");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "Exostar Federated Identity Service Root CA 1"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ let nc = cert_path.name_constr.as_ref().unwrap();
+ counter = 0;
+ let gsi = nc.excluded_subtrees.as_ref().unwrap().iter();
+ for gs in gsi {
+ match &gs.base {
+ GeneralName::DirectoryName(dn) => {
+ let i = dn.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.6");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "US"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "U.S. Government"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "DoD"
+ );
+ }
+ counter += 1;
+ }
+ }
+ }
+ _ => panic!("Unexpected GeneralSubtree type"),
+ }
+ }
+
+ let reencoded_cert = cert_path.certificate.to_der().unwrap();
+ assert_eq!(der_encoded_cert, reencoded_cert.as_slice());
+ }
+ _ => panic!("Unexpected TrustAnchorChoice contents"),
+ }
+}
+
+#[test]
+fn decode_ta4() {
+ // features an Exostar cert wrapped in a TrustAnchorInfo that contains path length constraint in
+ // the cert path controls field
+ let der_encoded_tac = include_bytes!("examples/raytheon_pathLenConstraint.ta");
+ let der_encoded_cert = include_bytes!("examples/raytheon.der");
+
+ let mut decoder = SliceReader::new(der_encoded_tac).unwrap();
+ let tac = TrustAnchorChoice::decode(&mut decoder).unwrap();
+ let reencoded_tac = tac.to_der().unwrap();
+ println!("Original : {:02X?}", der_encoded_cert);
+ println!("Reencoded: {:02X?}", reencoded_tac);
+ assert_eq!(der_encoded_tac, reencoded_tac.as_slice());
+
+ match tac {
+ TrustAnchorChoice::TaInfo(tai) => {
+ assert_eq!(
+ tai.pub_key.algorithm.oid.to_string(),
+ "1.2.840.113549.1.1.1"
+ );
+
+ assert_eq!(
+ &hex!("283086D556154210425CF07B1C11B28389D47920"),
+ tai.key_id.as_bytes()
+ );
+
+ let cert_path = tai.cert_path.as_ref().unwrap();
+
+ let mut counter = 0;
+ let i = cert_path.ta_name.0.iter();
+ for rdn in i {
+ let i1 = rdn.0.iter();
+ for atav in i1 {
+ if 0 == counter {
+ assert_eq!(atav.oid.to_string(), "0.9.2342.19200300.100.1.25");
+ assert_eq!(
+ Ia5StringRef::try_from(&atav.value).unwrap().to_string(),
+ "com"
+ );
+ } else if 1 == counter {
+ assert_eq!(atav.oid.to_string(), "0.9.2342.19200300.100.1.25");
+ assert_eq!(
+ Ia5StringRef::try_from(&atav.value).unwrap().to_string(),
+ "raytheon"
+ );
+ } else if 2 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.10");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "CAs"
+ );
+ } else if 3 == counter {
+ assert_eq!(atav.oid.to_string(), "2.5.4.11");
+ assert_eq!(
+ PrintableStringRef::try_from(&atav.value)
+ .unwrap()
+ .to_string(),
+ "RaytheonRoot"
+ );
+ }
+ counter += 1;
+ }
+ }
+
+ let pl = cert_path.path_len_constraint.unwrap();
+ if 2 != pl {
+ panic!("Wrong path length constraint");
+ }
+
+ let reencoded_cert = cert_path.certificate.to_der().unwrap();
+ assert_eq!(der_encoded_cert, reencoded_cert.as_slice());
+ }
+ _ => panic!("Unexpected TrustAnchorChoice contents"),
+ }
+}
diff --git a/crates/x509-cert/tests/validity.rs b/crates/x509-cert/tests/validity.rs
new file mode 100644
index 0000000..b2e676c
--- /dev/null
+++ b/crates/x509-cert/tests/validity.rs
@@ -0,0 +1,136 @@
+//! Validity tests
+
+use der::{Decode, Encode};
+use hex_literal::hex;
+use x509_cert::time::Validity;
+
+#[test]
+fn decode_validity() {
+ // Decode Validity from GoodCACert.crt in NIST's PKITS certificate collection
+ // 102 30: SEQUENCE {
+ // 104 13: UTCTime 01/01/2010 08:30:00 GMT
+ // 119 13: UTCTime 31/12/2030 08:30:00 GMT
+ // : }
+ let val1 = Validity::from_der(
+ &hex!("301E170D3130303130313038333030305A170D3330313233313038333030305A")[..],
+ )
+ .unwrap();
+
+ // Decode Validity from InvalidEEnotAfterDateTest6EE.crt in NIST's PKITS certificate collection
+ // 97 30: SEQUENCE {
+ // 99 13: UTCTime 01/01/2010 08:30:00 GMT
+ // 114 13: UTCTime 01/01/2011 08:30:00 GMT
+ // : }
+ let val2 = Validity::from_der(
+ &hex!("301E170D3130303130313038333030305A170D3131303130313038333030305A")[..],
+ )
+ .unwrap();
+
+ // Compare to values from https://www.epochconverter.com/
+ assert_eq!(val1.not_before.to_unix_duration().as_secs(), 1262334600);
+ assert_eq!(val1.not_after.to_unix_duration().as_secs(), 1924936200);
+ assert_eq!(
+ val1.not_before.to_unix_duration().as_millis(),
+ 1262334600000
+ );
+ assert_eq!(val1.not_after.to_unix_duration().as_millis(), 1924936200000);
+
+ assert_eq!(val2.not_before.to_unix_duration().as_secs(), 1262334600);
+ assert_eq!(val2.not_after.to_unix_duration().as_secs(), 1293870600);
+ assert_eq!(
+ val2.not_before.to_unix_duration().as_millis(),
+ 1262334600000
+ );
+ assert_eq!(val2.not_after.to_unix_duration().as_millis(), 1293870600000);
+
+ assert_ne!(val1, val2);
+ assert_eq!(val1, val1);
+
+ // Decode Validity from ValidGeneralizedTimenotAfterDateTest8EE.crt in NIST's PKITS certificate collection
+ // 97 32: SEQUENCE {
+ // 99 13: UTCTime 01/01/2010 08:30:00 GMT
+ // 114 15: GeneralizedTime 01/01/2050 12:01:00 GMT
+ // : }
+ let val3 = Validity::from_der(
+ &hex!("3020170D3130303130313038333030305A180F32303530303130313132303130305A")[..],
+ )
+ .unwrap();
+ assert_eq!(val3.not_before.to_unix_duration().as_secs(), 1262334600);
+ assert_eq!(val3.not_after.to_unix_duration().as_secs(), 2524651260);
+ assert_eq!(
+ val3.not_before.to_unix_duration().as_millis(),
+ 1262334600000
+ );
+ assert_eq!(val3.not_after.to_unix_duration().as_millis(), 2524651260000);
+
+ assert_ne!(val1, val3);
+ assert_eq!(val3, val3);
+
+ // Decode Validity from ValidGeneralizedTimenotBeforeDateTest4EE.crt in NIST's PKITS certificate collection
+ // 97 32: SEQUENCE {
+ // 99 15: GeneralizedTime 01/01/2002 12:01:00 GMT
+ // 116 13: UTCTime 31/12/2030 08:30:00 GMT
+ // : }
+ let val4 = Validity::from_der(
+ &hex!("3020180F32303032303130313132303130305A170D3330313233313038333030305A")[..],
+ )
+ .unwrap();
+ assert_eq!(val4.not_before.to_unix_duration().as_secs(), 1009886460);
+ assert_eq!(val4.not_after.to_unix_duration().as_secs(), 1924936200);
+ assert_eq!(
+ val4.not_before.to_unix_duration().as_millis(),
+ 1009886460000
+ );
+ assert_eq!(val4.not_after.to_unix_duration().as_millis(), 1924936200000);
+
+ assert_ne!(val4, val3);
+ assert_eq!(val4, val4);
+}
+
+#[test]
+fn encode_validity() {
+ // Decode Validity from GoodCACert.crt in NIST's PKITS certificate collection then re-encode
+ // 102 30: SEQUENCE {
+ // 104 13: UTCTime 01/01/2010 08:30:00 GMT
+ // 119 13: UTCTime 31/12/2030 08:30:00 GMT
+ // : }
+ let val1 = Validity::from_der(
+ &hex!("301E170D3130303130313038333030305A170D3330313233313038333030305A")[..],
+ )
+ .unwrap();
+ let b1 = val1.to_der().unwrap();
+ assert_eq!(
+ b1,
+ &hex!("301E170D3130303130313038333030305A170D3330313233313038333030305A")[..]
+ );
+
+ // Decode Validity from ValidGeneralizedTimenotAfterDateTest8EE.crt in NIST's PKITS certificate collection
+ // 97 32: SEQUENCE {
+ // 99 13: UTCTime 01/01/2010 08:30:00 GMT
+ // 114 15: GeneralizedTime 01/01/2050 12:01:00 GMT
+ // : }
+ let val3 = Validity::from_der(
+ &hex!("3020170D3130303130313038333030305A180F32303530303130313132303130305A")[..],
+ )
+ .unwrap();
+ let b3 = val3.to_der().unwrap();
+ assert_eq!(
+ b3,
+ &hex!("3020170D3130303130313038333030305A180F32303530303130313132303130305A")[..]
+ );
+
+ // Decode Validity from ValidGeneralizedTimenotBeforeDateTest4EE.crt in NIST's PKITS certificate collection
+ // 97 32: SEQUENCE {
+ // 99 15: GeneralizedTime 01/01/2002 12:01:00 GMT
+ // 116 13: UTCTime 31/12/2030 08:30:00 GMT
+ // : }
+ let val4 = Validity::from_der(
+ &hex!("3020180F32303032303130313132303130305A170D3330313233313038333030305A")[..],
+ )
+ .unwrap();
+ let b4 = val4.to_der().unwrap();
+ assert_eq!(
+ b4,
+ &hex!("3020180F32303032303130313132303130305A170D3330313233313038333030305A")[..]
+ );
+}
diff --git a/crates/xml-rs/.cargo-checksum.json b/crates/xml-rs/.cargo-checksum.json
new file mode 100644
index 0000000..613c892
--- /dev/null
+++ b/crates/xml-rs/.cargo-checksum.json
@@ -0,0 +1 @@
+{"files":{"Cargo.lock":"0d1467ca3f1d00252583d897df0fb653edc5c505e713cfccef16bb90cb23233d","Cargo.toml":"b36f4b5d63cd4c805ecf9494b3cab4f3d0d60fc1752e97e5c607740025da3120","LICENSE":"0dc18d924dc0a5f41172a393012843a5eaaef338e795b3645da9cc3b6068220b","README.md":"a49f384a84c15f4ece1294a8432f334116f6dd31ad2c3e9b82c6189454862872","src/analyze.rs":"fe23f60176aa0c36d6973df15f00b9b5dc82b6e029f6bbe7aba9fa8a9934cf44","src/attribute.rs":"30aed450b476f15499f03a659086d310d18be6017d0b20832bd35f211a10cc33","src/common.rs":"aa814222a6fab9e5c9483c9288e7d6b230c03f7c18994cab2e5d10624026bb69","src/escape.rs":"4eb2d93122b41028c221e62507ba28188f22c896f2601f6027d5cef9c44595cd","src/lib.rs":"1ad4b09efb57dbde5d18feb051fa2fdf51ffb02ae2e8c4a2c1c00eb70dfc08bd","src/macros.rs":"fcebc87ca3f2a32082b0d3149c6f0fefa47dbaab8c6b1f8244cb959b2a04cb6e","src/name.rs":"df0e4653472ec8e350f16e55bbb6763cb6dbcfbc5ae982d73372f3d2c7b0003c","src/namespace.rs":"f1ccc2ecdfd2690a1a1cf63b4ad5a61e7565e114b5b39b8fbd6f0958a4138b5f","src/reader.rs":"7efaf92c64da201c69624acf3b3d995ac7793199f0166a725ff26b31b7f0dc23","src/reader/config.rs":"a25b4aa26d41daf896e432ba9c594c0235aae01c9010e82d3d1c36e0671bf93b","src/reader/error.rs":"883ca0de377b43e262dc00596649443a6529604344bf3ce08c3c2cfb134af046","src/reader/events.rs":"e36d8bbce2073150bd14b4c3216802b704a14bcb80a9923c8f16c9a6066e90f9","src/reader/indexset.rs":"fe7ab3b92e77a1c8fe90563981f398335e6758ebcfad6edc177cc39b8f82aec0","src/reader/lexer.rs":"3a475d27c433b8a94157e9ad754d0d54a01dcbd0c94539ebc1b73ca4f5fc450e","src/reader/parser.rs":"6aa11935bd0aa01bd3d6c8e42e233a8d028fd1de3016df46b2631b5ad5ce2906","src/reader/parser/inside_cdata.rs":"4a7626ead1d539f5e424adeeabeb167d725f603ca39d4cfa876a7b56e99ff2fa","src/reader/parser/inside_closing_tag_name.rs":"8b3bb6cab5aea7b28d70bfd4f2e6862f0128db750f58eefcab59333a1d6698be","src/reader/parser/inside_comment.rs":"9aeb5048c17bd20aa3c57dd8be648ead5ab6369783ff797296b07f6338209573","src/reader/parser/inside_declaration.rs":"c3b567a699bcdaf5c67c43dfb65251d05b4168eb9052f30aa98baaad81e5ca7a","src/reader/parser/inside_doctype.rs":"f70b11782758211988d9a77209d6ffeeeb1d8c12adde4e697beea2a6f8cd46a9","src/reader/parser/inside_opening_tag.rs":"c19950967d4fbee1848922c115324b6aae60ce3389bfa47fbe211f9a7978a0cf","src/reader/parser/inside_processing_instruction.rs":"c847fee0adf2e7212613a249178e3c19d90ac0210488ee5010b52d60e39b42cc","src/reader/parser/inside_reference.rs":"5f2056211f3b6617c892c01262d755247164be4cc319107a0b992c72b05dc735","src/reader/parser/outside_tag.rs":"cb6850cfc70c4e58d19672be3abfb4edd2ae79a04b595fbf1a39f263d7a61c1f","src/util.rs":"52e29cd4b5852dc8423e6e58d91268153d236d225ae66aff2a97347e6942bc8c","src/writer.rs":"2b8061761935c094736b782b0e471513b99b898dff2123934564dc15490c7ace","src/writer/config.rs":"d9c42dd67c3eb90fa5b86e1a095bbc44755a3505ac39a5c5522cb4928cd3fe19","src/writer/emitter.rs":"c20532a9452e2e9e2179d5c7705eb8df157465bee3d84a1ea1a15a18520b44ca","src/writer/events.rs":"f0e24e7fb039213d5b332bc4f521276cb8482caad20507d5f8ba2aa4ecb9acc1"},"package":"0fcb9cbac069e033553e8bb871be2fbdffcab578eb25bd0f7c508cedc6dcd75a"}
\ No newline at end of file
diff --git a/crates/xml-rs/Android.bp b/crates/xml-rs/Android.bp
new file mode 100644
index 0000000..ed7bacc
--- /dev/null
+++ b/crates/xml-rs/Android.bp
@@ -0,0 +1,58 @@
+// This file is generated by cargo_embargo.
+// Do not modify this file because the changes will be overridden on upgrade.
+
+package {
+ default_applicable_licenses: ["external_rust_crates_xml-rs_license"],
+ default_team: "trendy_team_android_rust",
+}
+
+license {
+ name: "external_rust_crates_xml-rs_license",
+ visibility: [":__subpackages__"],
+ license_kinds: ["SPDX-license-identifier-MIT"],
+ license_text: ["LICENSE"],
+}
+
+rust_library {
+ name: "libxml_rust",
+ host_supported: true,
+ crate_name: "xml",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.8.19",
+ crate_root: "src/lib.rs",
+ edition: "2021",
+ apex_available: [
+ "//apex_available:platform",
+ "com.android.virt",
+ ],
+ product_available: true,
+ vendor_available: true,
+}
+
+rust_test {
+ name: "xml-rs_test_src_lib",
+ host_supported: true,
+ crate_name: "xml",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.8.19",
+ crate_root: "src/lib.rs",
+ test_suites: ["general-tests"],
+ auto_gen_config: true,
+ test_options: {
+ unit_test: true,
+ },
+ edition: "2021",
+}
+
+rust_binary {
+ name: "xml_analyze",
+ host_supported: true,
+ crate_name: "xml_analyze",
+ cargo_env_compat: true,
+ cargo_pkg_version: "0.8.19",
+ crate_root: "src/analyze.rs",
+ edition: "2021",
+ rustlibs: ["libxml_rust"],
+ product_available: true,
+ vendor_available: true,
+}
diff --git a/crates/xml-rs/Cargo.lock b/crates/xml-rs/Cargo.lock
new file mode 100644
index 0000000..ed6d163
--- /dev/null
+++ b/crates/xml-rs/Cargo.lock
@@ -0,0 +1,7 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 3
+
+[[package]]
+name = "xml-rs"
+version = "0.8.19"
diff --git a/crates/xml-rs/Cargo.toml b/crates/xml-rs/Cargo.toml
new file mode 100644
index 0000000..5d8dc0c
--- /dev/null
+++ b/crates/xml-rs/Cargo.toml
@@ -0,0 +1,55 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g., crates.io) dependencies.
+#
+# If you are reading this file be aware that the original Cargo.toml
+# will likely look very different (and much more reasonable).
+# See Cargo.toml.orig for the original contents.
+
+[package]
+edition = "2021"
+rust-version = "1.58"
+name = "xml-rs"
+version = "0.8.19"
+authors = ["Vladimir Matveev <[email protected]>"]
+include = [
+ "src/**",
+ "LICENSE",
+ "README.md",
+]
+description = "An XML library in pure Rust"
+homepage = "https://lib.rs/crates/xml-rs"
+documentation = "https://docs.rs/xml-rs/"
+readme = "README.md"
+keywords = [
+ "xml",
+ "parser",
+ "sax",
+ "parsing",
+ "writer",
+]
+categories = ["parser-implementations"]
+license = "MIT"
+repository = "https://github.com/kornelski/xml-rs"
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[package.metadata.release]
+tag-message = ""
+tag-name = "{{version}}"
+
+[lib]
+name = "xml"
+path = "src/lib.rs"
+
+[[bin]]
+name = "xml-analyze"
+path = "src/analyze.rs"
+
+[badges.maintenance]
+status = "actively-developed"
diff --git a/crates/xml-rs/LICENSE b/crates/xml-rs/LICENSE
new file mode 100644
index 0000000..6caa1d3
--- /dev/null
+++ b/crates/xml-rs/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Vladimir Matveev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/crates/xml-rs/METADATA b/crates/xml-rs/METADATA
new file mode 100644
index 0000000..629fe15
--- /dev/null
+++ b/crates/xml-rs/METADATA
@@ -0,0 +1,20 @@
+# This project was upgraded with external_updater.
+# Usage: tools/external_updater/updater.sh update rust/crates/xml-rs
+# For more info, check https://cs.android.com/android/platform/superproject/+/main:tools/external_updater/README.md
+
+name: "xml-rs"
+description: "An XML library in pure Rust"
+third_party {
+ license_type: NOTICE
+ last_upgrade_date {
+ year: 2023
+ month: 12
+ day: 4
+ }
+ homepage: "https://crates.io/crates/xml-rs"
+ identifier {
+ type: "Archive"
+ value: "https://static.crates.io/crates/xml-rs/xml-rs-0.8.19.crate"
+ version: "0.8.19"
+ }
+}
diff --git a/crates/xml-rs/MODULE_LICENSE_MIT b/crates/xml-rs/MODULE_LICENSE_MIT
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/crates/xml-rs/MODULE_LICENSE_MIT
diff --git a/crates/xml-rs/README.md b/crates/xml-rs/README.md
new file mode 100644
index 0000000..07f306c
--- /dev/null
+++ b/crates/xml-rs/README.md
@@ -0,0 +1,216 @@
+xml-rs, an XML library for Rust
+===============================
+
+[](https://github.com/kornelski/xml-rs/actions/workflows/main.yml)
+[![crates.io][crates-io-img]](https://lib.rs/crates/xml-rs)
+[![docs][docs-img]](https://docs.rs/xml-rs/)
+
+[Documentation](https://docs.rs/xml-rs/)
+
+ [crates-io-img]: https://img.shields.io/crates/v/xml-rs.svg
+ [docs-img]: https://img.shields.io/badge/docs-latest%20release-6495ed.svg
+
+xml-rs is an XML library for the [Rust](https://www.rust-lang.org/) programming language.
+It supports reading and writing of XML documents in a streaming fashion (without DOM).
+
+### Features
+
+* XML spec conformance better than other pure-Rust libraries.
+
+* Easy to use API based on `Iterator`s and regular `String`s without tricky lifetimes.
+
+* Support for UTF-16, UTF-8, ISO-8859-1, and ASCII encodings.
+
+* Written entirely in the safe Rust subset. Designed to safely handle untrusted input.
+
+
+The API is heavily inspired by Java Streaming API for XML ([StAX][stax]). It contains a pull parser much like StAX event reader. It provides an iterator API, so you can leverage Rust's existing iterators library features.
+
+ [stax]: https://en.wikipedia.org/wiki/StAX
+
+It also provides a streaming document writer much like StAX event writer.
+This writer consumes its own set of events, but reader events can be converted to
+writer events easily, and so it is possible to write XML transformation chains in a pretty
+clean manner.
+
+This parser is mostly full-featured, however, there are limitations:
+* Legacy code pages and non-Unicode encodings are not supported;
+* DTD validation is not supported (but entities defined in the internal subset are supported);
+* attribute value normalization is not performed, and end-of-line characters are not normalized either.
+
+Other than that the parser tries to be mostly XML-1.1-compliant.
+
+Writer is also mostly full-featured with the following limitations:
+* no support for encodings other than UTF-8,
+* no support for emitting `<!DOCTYPE>` declarations;
+* more validations of input are needed, for example, checking that namespace prefixes are bounded
+ or comments are well-formed.
+
+Building and using
+------------------
+
+xml-rs uses [Cargo](https://crates.io), so add it with `cargo add xml` or modify `Cargo.toml`:
+
+```toml
+[dependencies]
+xml = "0.8.16"
+```
+
+The package exposes a single crate called `xml`.
+
+Reading XML documents
+---------------------
+
+[`xml::reader::EventReader`](EventReader) requires a [`Read`](stdread) instance to read from. It can be a `File` wrapped in `BufReader`, or a `Vec<u8>`, or a `&[u8]` slice.
+
+[EventReader]: https://docs.rs/xml-rs/latest/xml/reader/struct.EventReader.html
+[stdread]: https://doc.rust-lang.org/stable/std/io/trait.Read.html
+
+`EventReader` implements `IntoIterator` trait, so you can use it in a `for` loop directly:
+
+```rust,no_run
+use std::fs::File;
+use std::io::BufReader;
+
+use xml::reader::{EventReader, XmlEvent};
+
+fn main() -> std::io::Result<()> {
+ let file = File::open("file.xml")?;
+ let file = BufReader::new(file); // Buffering is important for performance
+
+ let parser = EventReader::new(file);
+ let mut depth = 0;
+ for e in parser {
+ match e {
+ Ok(XmlEvent::StartElement { name, .. }) => {
+ println!("{:spaces$}+{name}", "", spaces = depth * 2);
+ depth += 1;
+ }
+ Ok(XmlEvent::EndElement { name }) => {
+ depth -= 1;
+ println!("{:spaces$}-{name}", "", spaces = depth * 2);
+ }
+ Err(e) => {
+ eprintln!("Error: {e}");
+ break;
+ }
+ // There's more: https://docs.rs/xml-rs/latest/xml/reader/enum.XmlEvent.html
+ _ => {}
+ }
+ }
+
+ Ok(())
+}
+```
+
+Document parsing can end normally or with an error. Regardless of exact cause, the parsing
+process will be stopped, and the iterator will terminate normally.
+
+You can also have finer control over when to pull the next event from the parser using its own
+`next()` method:
+
+```rust,ignore
+match parser.next() {
+ ...
+}
+```
+
+Upon the end of the document or an error, the parser will remember the last event and will always
+return it in the result of `next()` call afterwards. If iterator is used, then it will yield
+error or end-of-document event once and will produce `None` afterwards.
+
+It is also possible to tweak parsing process a little using [`xml::reader::ParserConfig`][ParserConfig] structure.
+See its documentation for more information and examples.
+
+[ParserConfig]: https://docs.rs/xml-rs/latest/xml/reader/struct.ParserConfig.html
+
+You can find a more extensive example of using `EventReader` in `src/analyze.rs`, which is a
+small program (BTW, it is built with `cargo build` and can be run after that) which shows various
+statistics about specified XML document. It can also be used to check for well-formedness of
+XML documents - if a document is not well-formed, this program will exit with an error.
+
+
+## Parsing untrusted inputs
+
+The parser is written in safe Rust subset, so by Rust's guarantees the worst that it can do is to cause a panic.
+You can use `ParserConfig` to set limits on maximum lenghts of names, attributes, text, entities, etc.
+You should also set a maximum document size via `io::Read`'s [`take(max)`](https://doc.rust-lang.org/stable/std/io/trait.Read.html#method.take) method.
+
+Writing XML documents
+---------------------
+
+xml-rs also provides a streaming writer much like StAX event writer. With it you can write an
+XML document to any `Write` implementor.
+
+```rust,no_run
+use std::io;
+use xml::writer::{EmitterConfig, XmlEvent};
+
+/// A simple demo syntax where "+foo" makes `<foo>`, "-foo" makes `</foo>`
+fn make_event_from_line(line: &str) -> XmlEvent {
+ let line = line.trim();
+ if let Some(name) = line.strip_prefix("+") {
+ XmlEvent::start_element(name).into()
+ } else if line.starts_with("-") {
+ XmlEvent::end_element().into()
+ } else {
+ XmlEvent::characters(line).into()
+ }
+}
+
+fn main() -> io::Result<()> {
+ let input = io::stdin();
+ let output = io::stdout();
+ let mut writer = EmitterConfig::new()
+ .perform_indent(true)
+ .create_writer(output);
+
+ let mut line = String::new();
+ loop {
+ line.clear();
+ let bytes_read = input.read_line(&mut line)?;
+ if bytes_read == 0 {
+ break; // EOF
+ }
+
+ let event = make_event_from_line(&line);
+ if let Err(e) = writer.write(event) {
+ panic!("Write error: {e}")
+ }
+ }
+ Ok(())
+}
+```
+
+The code example above also demonstrates how to create a writer out of its configuration.
+Similar thing also works with `EventReader`.
+
+The library provides an XML event building DSL which helps to construct complex events,
+e.g. ones having namespace definitions. Some examples:
+
+```rust,ignore
+// <a:hello a:param="value" xmlns:a="urn:some:document">
+XmlEvent::start_element("a:hello").attr("a:param", "value").ns("a", "urn:some:document")
+
+// <hello b:config="name" xmlns="urn:default:uri">
+XmlEvent::start_element("hello").attr("b:config", "value").default_ns("urn:defaul:uri")
+
+// <![CDATA[some unescaped text]]>
+XmlEvent::cdata("some unescaped text")
+```
+
+Of course, one can create `XmlEvent` enum variants directly instead of using the builder DSL.
+There are more examples in [`xml::writer::XmlEvent`][XmlEvent] documentation.
+
+[XmlEvent]: https://docs.rs/xml-rs/latest/xml/reader/enum.XmlEvent.html
+
+The writer has multiple configuration options; see `EmitterConfig` documentation for more
+information.
+
+[EmitterConfig]: https://docs.rs/xml-rs/latest/xml/writer/struct.EmitterConfig.html
+
+Bug reports
+------------
+
+Please report issues at: <https://github.com/kornelski/xml-rs/issues>.
+
diff --git a/crates/xml-rs/TEST_MAPPING b/crates/xml-rs/TEST_MAPPING
new file mode 100644
index 0000000..e12f6b2
--- /dev/null
+++ b/crates/xml-rs/TEST_MAPPING
@@ -0,0 +1,11 @@
+// Generated by update_crate_tests.py for tests that depend on this crate.
+{
+ "imports": [
+ {
+ "path": "external/rust/crates/serde-xml-rs"
+ },
+ {
+ "path": "packages/modules/Virtualization/virtualizationmanager"
+ }
+ ]
+}
diff --git a/crates/xml-rs/cargo_embargo.json b/crates/xml-rs/cargo_embargo.json
new file mode 100644
index 0000000..f6ad908
--- /dev/null
+++ b/crates/xml-rs/cargo_embargo.json
@@ -0,0 +1,14 @@
+{
+ "apex_available": [
+ "//apex_available:platform",
+ "com.android.virt"
+ ],
+ "package": {
+ "xml-rs": {
+ "dep_blocklist": [
+ "libdoc_comment"
+ ]
+ }
+ },
+ "tests": true
+}
diff --git a/crates/xml-rs/src/analyze.rs b/crates/xml-rs/src/analyze.rs
new file mode 100644
index 0000000..d50b2d9
--- /dev/null
+++ b/crates/xml-rs/src/analyze.rs
@@ -0,0 +1,85 @@
+#![forbid(unsafe_code)]
+
+use std::cmp;
+use std::collections::HashSet;
+use std::env;
+use std::fs::File;
+use std::io::{self, BufReader, Read};
+
+use xml::reader::XmlEvent;
+use xml::ParserConfig;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+ let mut file;
+ let mut stdin;
+ let source: &mut dyn Read = if let Some(file_name) = env::args().nth(1) {
+ file = File::open(file_name).map_err(|e| format!("Cannot open input file: {e}"))?;
+ &mut file
+ } else {
+ stdin = io::stdin();
+ &mut stdin
+ };
+
+ let reader = ParserConfig::new()
+ .whitespace_to_characters(true)
+ .ignore_comments(false)
+ .create_reader(BufReader::new(source));
+
+ let mut processing_instructions = 0;
+ let mut elements = 0;
+ let mut character_blocks = 0;
+ let mut cdata_blocks = 0;
+ let mut characters = 0;
+ let mut comment_blocks = 0;
+ let mut comment_characters = 0;
+ let mut namespaces = HashSet::new();
+ let mut depth = 0;
+ let mut max_depth = 0;
+
+ for e in reader {
+ let e = e.map_err(|e| format!("Error parsing XML document: {e}"))?;
+ match e {
+ XmlEvent::StartDocument { version, encoding, standalone } =>
+ println!(
+ "XML document version {}, encoded in {}, {}standalone",
+ version, encoding, if standalone.unwrap_or(false) { "" } else { "not " }
+ ),
+ XmlEvent::EndDocument => println!("Document finished"),
+ XmlEvent::ProcessingInstruction { .. } => processing_instructions += 1,
+ XmlEvent::Whitespace(_) => {} // can't happen due to configuration
+ XmlEvent::Characters(s) => {
+ character_blocks += 1;
+ characters += s.len();
+ }
+ XmlEvent::CData(s) => {
+ cdata_blocks += 1;
+ characters += s.len();
+ }
+ XmlEvent::Comment(s) => {
+ comment_blocks += 1;
+ comment_characters += s.len();
+ }
+ XmlEvent::StartElement { namespace, .. } => {
+ depth += 1;
+ max_depth = cmp::max(max_depth, depth);
+ elements += 1;
+ namespaces.extend(namespace.0.into_values());
+ }
+ XmlEvent::EndElement { .. } => {
+ depth -= 1;
+ }
+ };
+ }
+
+ namespaces.remove(xml::namespace::NS_EMPTY_URI);
+ namespaces.remove(xml::namespace::NS_XMLNS_URI);
+ namespaces.remove(xml::namespace::NS_XML_URI);
+
+ println!("Elements: {elements}, maximum depth: {max_depth}");
+ println!("Namespaces (excluding built-in): {}", namespaces.len());
+ println!("Characters: {characters}, characters blocks: {character_blocks}, CDATA blocks: {cdata_blocks}");
+ println!("Comment blocks: {comment_blocks}, comment characters: {comment_characters}");
+ println!("Processing instructions (excluding built-in): {processing_instructions}");
+
+ Ok(())
+}
diff --git a/crates/xml-rs/src/attribute.rs b/crates/xml-rs/src/attribute.rs
new file mode 100644
index 0000000..5d0184e
--- /dev/null
+++ b/crates/xml-rs/src/attribute.rs
@@ -0,0 +1,103 @@
+//! Contains XML attributes manipulation types and functions.
+//!
+
+use std::fmt;
+
+use crate::escape::{AttributeEscapes, Escaped};
+use crate::name::{Name, OwnedName};
+
+/// A borrowed version of an XML attribute.
+///
+/// Consists of a borrowed qualified name and a borrowed string value.
+#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
+pub struct Attribute<'a> {
+ /// Attribute name.
+ pub name: Name<'a>,
+
+ /// Attribute value.
+ pub value: &'a str,
+}
+
+impl<'a> fmt::Display for Attribute<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}=\"{}\"", self.name, Escaped::<AttributeEscapes>::new(self.value))
+ }
+}
+
+impl<'a> Attribute<'a> {
+ /// Creates an owned attribute out of this borrowed one.
+ #[inline]
+ #[must_use]
+ pub fn to_owned(&self) -> OwnedAttribute {
+ OwnedAttribute {
+ name: self.name.into(),
+ value: self.value.into(),
+ }
+ }
+
+ /// Creates a borrowed attribute using the provided borrowed name and a borrowed string value.
+ #[inline]
+ #[must_use]
+ pub fn new(name: Name<'a>, value: &'a str) -> Attribute<'a> {
+ Attribute { name, value }
+ }
+}
+
+/// An owned version of an XML attribute.
+///
+/// Consists of an owned qualified name and an owned string value.
+#[derive(Clone, Eq, PartialEq, Hash, Debug)]
+pub struct OwnedAttribute {
+ /// Attribute name.
+ pub name: OwnedName,
+
+ /// Attribute value.
+ pub value: String,
+}
+
+impl OwnedAttribute {
+ /// Returns a borrowed `Attribute` out of this owned one.
+ #[must_use]
+ #[inline]
+ pub fn borrow(&self) -> Attribute<'_> {
+ Attribute {
+ name: self.name.borrow(),
+ value: &self.value,
+ }
+ }
+
+ /// Creates a new owned attribute using the provided owned name and an owned string value.
+ #[inline]
+ pub fn new<S: Into<String>>(name: OwnedName, value: S) -> OwnedAttribute {
+ OwnedAttribute {
+ name,
+ value: value.into(),
+ }
+ }
+}
+
+impl fmt::Display for OwnedAttribute {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}=\"{}\"", self.name, Escaped::<AttributeEscapes>::new(&self.value))
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::Attribute;
+
+ use crate::name::Name;
+
+ #[test]
+ fn attribute_display() {
+ let attr = Attribute::new(
+ Name::qualified("attribute", "urn:namespace", Some("n")),
+ "its value with > & \" ' < weird symbols",
+ );
+
+ assert_eq!(
+ &*attr.to_string(),
+ "{urn:namespace}n:attribute=\"its value with > & " ' < weird symbols\""
+ );
+ }
+}
diff --git a/crates/xml-rs/src/common.rs b/crates/xml-rs/src/common.rs
new file mode 100644
index 0000000..0b324f2
--- /dev/null
+++ b/crates/xml-rs/src/common.rs
@@ -0,0 +1,157 @@
+//! Contains common types and functions used throughout the library.
+
+use std::fmt;
+
+/// Represents a position inside some textual document.
+#[derive(Copy, Clone, PartialEq, Eq)]
+pub struct TextPosition {
+ /// Row, counting from 0
+ pub row: u64,
+ /// Column, counting from 0
+ pub column: u64,
+}
+
+impl TextPosition {
+ /// Creates a new position initialized to the beginning of the document
+ #[inline]
+ #[must_use]
+ pub fn new() -> TextPosition {
+ TextPosition { row: 0, column: 0 }
+ }
+
+ /// Advances the position in a line
+ #[inline]
+ pub fn advance(&mut self, count: u8) {
+ self.column += u64::from(count);
+ }
+
+ /// Advances the position in a line to the next tab position
+ #[inline]
+ pub fn advance_to_tab(&mut self, width: u8) {
+ let width = u64::from(width);
+ self.column += width - self.column % width;
+ }
+
+ /// Advances the position to the beginning of the next line
+ #[inline]
+ pub fn new_line(&mut self) {
+ self.column = 0;
+ self.row += 1;
+ }
+}
+
+impl fmt::Debug for TextPosition {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}:{}", self.row + 1, self.column + 1)
+ }
+}
+
+impl fmt::Display for TextPosition {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{}:{}", self.row + 1, self.column + 1)
+ }
+}
+
+/// Get the position in the document corresponding to the object
+///
+/// This trait is implemented by parsers, lexers and errors.
+pub trait Position {
+ /// Returns the current position or a position corresponding to the object.
+ fn position(&self) -> TextPosition;
+}
+
+impl Position for TextPosition {
+ #[inline]
+ fn position(&self) -> TextPosition {
+ *self
+ }
+}
+
+/// XML version enumeration.
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
+pub enum XmlVersion {
+ /// XML version 1.0.
+ Version10,
+
+ /// XML version 1.1.
+ Version11,
+}
+
+impl fmt::Display for XmlVersion {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ XmlVersion::Version10 => "1.0",
+ XmlVersion::Version11 => "1.1",
+ }.fmt(f)
+ }
+}
+
+impl fmt::Debug for XmlVersion {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(self, f)
+ }
+}
+
+/// Checks whether the given character is a white space character (`S`)
+/// as is defined by XML 1.1 specification, [section 2.3][1].
+///
+/// [1]: http://www.w3.org/TR/2006/REC-xml11-20060816/#sec-common-syn
+#[must_use]
+#[inline]
+pub fn is_whitespace_char(c: char) -> bool {
+ matches!(c, '\x20' | '\x0a' | '\x09' | '\x0d')
+}
+
+/// Checks whether the given string is compound only by white space
+/// characters (`S`) using the previous `is_whitespace_char` to check
+/// all characters of this string
+pub fn is_whitespace_str(s: &str) -> bool {
+ s.chars().all(is_whitespace_char)
+}
+
+#[must_use] pub fn is_xml10_char(c: char) -> bool {
+ matches!(c, '\u{09}' | '\u{0A}' | '\u{0D}' | '\u{20}'..='\u{D7FF}' | '\u{E000}'..='\u{FFFD}' | '\u{10000}'..)
+}
+
+#[must_use] pub fn is_xml11_char(c: char) -> bool {
+ matches!(c, '\u{01}'..='\u{D7FF}' | '\u{E000}'..='\u{FFFD}' | '\u{10000}'..)
+}
+
+#[must_use] pub fn is_xml11_char_not_restricted(c: char) -> bool {
+ is_xml11_char(c) && !matches!(c, '\u{01}'..='\u{08}' | '\u{0B}'..='\u{0C}' | '\u{0E}'..='\u{1F}' | '\u{7F}'..='\u{84}' | '\u{86}'..='\u{9F}')
+}
+
+/// Checks whether the given character is a name start character (`NameStartChar`)
+/// as is defined by XML 1.1 specification, [section 2.3][1].
+///
+/// [1]: http://www.w3.org/TR/2006/REC-xml11-20060816/#sec-common-syn
+#[must_use]
+pub fn is_name_start_char(c: char) -> bool {
+ match c {
+ ':' | 'A'..='Z' | '_' | 'a'..='z' |
+ '\u{C0}'..='\u{D6}' | '\u{D8}'..='\u{F6}' | '\u{F8}'..='\u{2FF}' |
+ '\u{370}'..='\u{37D}' | '\u{37F}'..='\u{1FFF}' |
+ '\u{200C}'..='\u{200D}' | '\u{2070}'..='\u{218F}' |
+ '\u{2C00}'..='\u{2FEF}' | '\u{3001}'..='\u{D7FF}' |
+ '\u{F900}'..='\u{FDCF}' | '\u{FDF0}'..='\u{FFFD}' |
+ '\u{10000}'..='\u{EFFFF}' => true,
+ _ => false
+ }
+}
+
+/// Checks whether the given character is a name character (`NameChar`)
+/// as is defined by XML 1.1 specification, [section 2.3][1].
+///
+/// [1]: http://www.w3.org/TR/2006/REC-xml11-20060816/#sec-common-syn
+#[must_use]
+pub fn is_name_char(c: char) -> bool {
+ match c {
+ _ if is_name_start_char(c) => true,
+ '-' | '.' | '0'..='9' | '\u{B7}' |
+ '\u{300}'..='\u{36F}' | '\u{203F}'..='\u{2040}' => true,
+ _ => false
+ }
+}
diff --git a/crates/xml-rs/src/escape.rs b/crates/xml-rs/src/escape.rs
new file mode 100644
index 0000000..ad8ee4a
--- /dev/null
+++ b/crates/xml-rs/src/escape.rs
@@ -0,0 +1,162 @@
+//! Contains functions for performing XML special characters escaping.
+
+use std::{borrow::Cow, marker::PhantomData, fmt::{Display, Result, Formatter}};
+
+pub(crate) trait Escapes {
+ fn escape(c: u8) -> Option<&'static str>;
+
+ fn byte_needs_escaping(c: u8) -> bool {
+ Self::escape(c).is_some()
+ }
+
+ fn str_needs_escaping(s: &str) -> bool {
+ s.bytes().any(|c| Self::escape(c).is_some())
+ }
+}
+
+pub(crate) struct Escaped<'a, E: Escapes> {
+ _escape_phantom: PhantomData<E>,
+ to_escape: &'a str,
+}
+
+impl<'a, E: Escapes> Escaped<'a, E> {
+ pub fn new(s: &'a str) -> Self {
+ Escaped {
+ _escape_phantom: PhantomData,
+ to_escape: s,
+ }
+ }
+}
+
+impl<'a, E: Escapes> Display for Escaped<'a, E> {
+ fn fmt(&self, f: &mut Formatter<'_>) -> Result {
+ let mut total_remaining = self.to_escape;
+
+ // find the next occurence
+ while let Some(n) = total_remaining
+ .bytes()
+ .position(E::byte_needs_escaping)
+ {
+ let (start, remaining) = total_remaining.split_at(n);
+
+ f.write_str(start)?;
+
+ // unwrap is safe because we checked is_some for position n earlier
+ let next_byte = remaining.bytes().next().unwrap();
+ let replacement = E::escape(next_byte).unwrap();
+ f.write_str(replacement)?;
+
+ total_remaining = &remaining[1..];
+ }
+
+ f.write_str(total_remaining)
+ }
+}
+
+fn escape_str<E: Escapes>(s: &str) -> Cow<'_, str> {
+ if E::str_needs_escaping(s) {
+ Cow::Owned(format!("{}", Escaped::<E>::new(s)))
+ } else {
+ Cow::Borrowed(s)
+ }
+}
+
+macro_rules! escapes {
+ {
+ $name: ident,
+ $($k: expr => $v: expr),* $(,)?
+ } => {
+ pub(crate) struct $name;
+
+ impl Escapes for $name {
+ fn escape(c: u8) -> Option<&'static str> {
+ match c {
+ $( $k => Some($v),)*
+ _ => None
+ }
+ }
+ }
+ };
+}
+
+escapes!(
+ AttributeEscapes,
+ b'<' => "<",
+ b'>' => ">",
+ b'"' => """,
+ b'\'' => "'",
+ b'&' => "&",
+ b'\n' => "
",
+ b'\r' => "
",
+);
+
+escapes!(
+ PcDataEscapes,
+ b'<' => "<",
+ b'&' => "&",
+);
+
+/// Performs escaping of common XML characters inside an attribute value.
+///
+/// This function replaces several important markup characters with their
+/// entity equivalents:
+///
+/// * `<` → `<`
+/// * `>` → `>`
+/// * `"` → `"`
+/// * `'` → `'`
+/// * `&` → `&`
+///
+/// The following characters are escaped so that attributes are printed on
+/// a single line:
+/// * `\n` → `
`
+/// * `\r` → `
`
+///
+/// The resulting string is safe to use inside XML attribute values or in PCDATA sections.
+///
+/// Does not perform allocations if the given string does not contain escapable characters.
+#[inline]
+#[must_use]
+pub fn escape_str_attribute(s: &str) -> Cow<'_, str> {
+ escape_str::<AttributeEscapes>(s)
+}
+
+/// Performs escaping of common XML characters inside PCDATA.
+///
+/// This function replaces several important markup characters with their
+/// entity equivalents:
+///
+/// * `<` → `<`
+/// * `&` → `&`
+///
+/// The resulting string is safe to use inside PCDATA sections but NOT inside attribute values.
+///
+/// Does not perform allocations if the given string does not contain escapable characters.
+#[inline]
+#[must_use]
+pub fn escape_str_pcdata(s: &str) -> Cow<'_, str> {
+ escape_str::<PcDataEscapes>(s)
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{escape_str_attribute, escape_str_pcdata};
+
+ #[test]
+ fn test_escape_str_attribute() {
+ assert_eq!(escape_str_attribute("<>'\"&\n\r"), "<>'"&

");
+ assert_eq!(escape_str_attribute("no_escapes"), "no_escapes");
+ }
+
+ #[test]
+ fn test_escape_str_pcdata() {
+ assert_eq!(escape_str_pcdata("<&"), "<&");
+ assert_eq!(escape_str_pcdata("no_escapes"), "no_escapes");
+ }
+
+ #[test]
+ fn test_escape_multibyte_code_points() {
+ assert_eq!(escape_str_attribute("☃<"), "☃<");
+ assert_eq!(escape_str_pcdata("☃<"), "☃<");
+ }
+}
diff --git a/crates/xml-rs/src/lib.rs b/crates/xml-rs/src/lib.rs
new file mode 100644
index 0000000..40a4f21
--- /dev/null
+++ b/crates/xml-rs/src/lib.rs
@@ -0,0 +1,30 @@
+//#![warn(missing_doc)]
+#![forbid(non_camel_case_types)]
+#![forbid(unsafe_code)]
+#![allow(clippy::redundant_closure_for_method_calls)]
+#![allow(clippy::module_name_repetitions)]
+
+//! This crate currently provides an almost XML 1.0/1.1-compliant pull parser.
+//!
+//! Please note that functions of this parser may panic.
+//! If a panic could cause a Denial Of Service in your codebase, *you're* responsible for wrapping access to this library in `catch_unwind`.
+//!
+
+#![cfg_attr(doctest, doc = include_str!("../README.md"))]
+
+pub use crate::reader::EventReader;
+pub use crate::reader::ParserConfig;
+pub use crate::util::Encoding;
+pub use crate::writer::EmitterConfig;
+pub use crate::writer::EventWriter;
+
+pub mod attribute;
+pub mod common;
+pub mod escape;
+#[doc(hidden)] // FIXME: not supposed to be public
+pub mod macros;
+pub mod name;
+pub mod namespace;
+pub mod reader;
+mod util;
+pub mod writer;
diff --git a/crates/xml-rs/src/macros.rs b/crates/xml-rs/src/macros.rs
new file mode 100644
index 0000000..da1adad
--- /dev/null
+++ b/crates/xml-rs/src/macros.rs
@@ -0,0 +1,60 @@
+#![macro_use]
+
+//! Contains several macros used in this crate.
+
+macro_rules! gen_setter {
+ ($(#[$comments:meta])* $field:ident : into $t:ty) => {
+
+ $(#[$comments])*
+ ///
+ /// <small>See [`ParserConfig`][crate::ParserConfig] fields docs for details</small>
+ #[inline]
+ pub fn $field<T: Into<$t>>(mut self, value: T) -> Self {
+ self.$field = value.into();
+ self
+ }
+ };
+ ($(#[$comments:meta])* $field:ident : val $t:ty) => {
+ $(#[$comments])*
+ ///
+ /// <small>See [`ParserConfig`][crate::ParserConfig] fields docs for details</small>
+ #[inline]
+ #[must_use] pub fn $field(mut self, value: $t) -> Self {
+ self.$field = value;
+ self
+ }
+ };
+ ($(#[$comments:meta])* $field:ident : delegate $t:ty) => {
+ $(#[$comments])*
+ ///
+ /// <small>See [`ParserConfig`][crate::ParserConfig] fields docs for details</small>
+ #[inline]
+ #[must_use] pub fn $field(mut self, value: $t) -> Self {
+ self.c.$field = value;
+ self
+ }
+ };
+ ($(#[$comments:meta])* $field:ident : c2 $t:ty) => {
+ $(#[$comments])*
+ ///
+ /// <small>See [`ParserConfig2`][crate::reader::ParserConfig2] fields docs for details</small>
+ #[inline]
+ #[must_use]
+ pub fn $field(self, value: $t) -> ParserConfig2 {
+ ParserConfig2 {
+ c: self,
+ ..Default::default()
+ }
+ .$field(value)
+ }
+ };
+}
+
+macro_rules! gen_setters {
+ ($target:ident, $($(#[$comments:meta])* $field:ident : $k:tt $tpe:ty),+) => (
+ impl $target {$(
+
+ gen_setter! { $(#[$comments])* $field : $k $tpe }
+ )+
+ })
+}
diff --git a/crates/xml-rs/src/name.rs b/crates/xml-rs/src/name.rs
new file mode 100644
index 0000000..fc11981
--- /dev/null
+++ b/crates/xml-rs/src/name.rs
@@ -0,0 +1,312 @@
+//! Contains XML qualified names manipulation types and functions.
+//!
+
+use std::fmt;
+use std::str::FromStr;
+
+use crate::namespace::NS_NO_PREFIX;
+
+/// Represents a qualified XML name.
+///
+/// A qualified name always consists at least of a local name. It can optionally contain
+/// a prefix; when reading an XML document, if it contains a prefix, it must also contain a
+/// namespace URI, but this is not enforced statically; see below. The name can contain a
+/// namespace without a prefix; in that case a default, empty prefix is assumed.
+///
+/// When writing XML documents, it is possible to omit the namespace URI, leaving only
+/// the prefix. In this case the writer will check that the specifed prefix is bound to some
+/// URI in the current namespace context. If both prefix and namespace URI are specified,
+/// it is checked that the current namespace context contains this exact correspondence
+/// between prefix and namespace URI.
+///
+/// # Prefixes and URIs
+///
+/// A qualified name with a prefix must always contain a proper namespace URI --- names with
+/// a prefix but without a namespace associated with that prefix are meaningless. However,
+/// it is impossible to obtain proper namespace URI by a prefix without a context, and such
+/// context is only available when parsing a document (or it can be constructed manually
+/// when writing a document). Tying a name to a context statically seems impractical. This
+/// may change in future, though.
+///
+/// # Conversions
+///
+/// `Name` implements some `From` instances for conversion from strings and tuples. For example:
+///
+/// ```rust
+/// # use xml::name::Name;
+/// let n1: Name = "p:some-name".into();
+/// let n2: Name = ("p", "some-name").into();
+///
+/// assert_eq!(n1, n2);
+/// assert_eq!(n1.local_name, "some-name");
+/// assert_eq!(n1.prefix, Some("p"));
+/// assert!(n1.namespace.is_none());
+/// ```
+///
+/// This is added to support easy specification of XML elements when writing XML documents.
+#[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
+pub struct Name<'a> {
+ /// A local name, e.g. `string` in `xsi:string`.
+ pub local_name: &'a str,
+
+ /// A namespace URI, e.g. `http://www.w3.org/2000/xmlns/`.
+ pub namespace: Option<&'a str>,
+
+ /// A name prefix, e.g. `xsi` in `xsi:string`.
+ pub prefix: Option<&'a str>,
+}
+
+impl<'a> From<&'a str> for Name<'a> {
+ fn from(s: &'a str) -> Name<'a> {
+ let mut parts = s.splitn(2, ':').fuse();
+ match (parts.next(), parts.next()) {
+ (Some(name), None) => Name::local(name),
+ (Some(prefix), Some(name)) => Name::prefixed(name, prefix),
+ _ => unreachable!(),
+ }
+ }
+}
+
+impl<'a> From<(&'a str, &'a str)> for Name<'a> {
+ fn from((prefix, name): (&'a str, &'a str)) -> Name<'a> {
+ Name::prefixed(name, prefix)
+ }
+}
+
+impl<'a> fmt::Display for Name<'a> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ if let Some(namespace) = self.namespace {
+ write!(f, "{{{namespace}}}")?;
+ }
+
+ if let Some(prefix) = self.prefix {
+ write!(f, "{prefix}:")?;
+ }
+
+ f.write_str(self.local_name)
+ }
+}
+
+impl<'a> Name<'a> {
+ /// Returns an owned variant of the qualified name.
+ #[must_use]
+ pub fn to_owned(&self) -> OwnedName {
+ OwnedName {
+ local_name: self.local_name.into(),
+ namespace: self.namespace.map(std::convert::Into::into),
+ prefix: self.prefix.map(std::convert::Into::into),
+ }
+ }
+
+ /// Returns a new `Name` instance representing plain local name.
+ #[inline]
+ #[must_use]
+ pub fn local(local_name: &str) -> Name<'_> {
+ Name {
+ local_name,
+ prefix: None,
+ namespace: None,
+ }
+ }
+
+ /// Returns a new `Name` instance with the given local name and prefix.
+ #[inline]
+ #[must_use]
+ pub fn prefixed(local_name: &'a str, prefix: &'a str) -> Name<'a> {
+ Name {
+ local_name,
+ namespace: None,
+ prefix: Some(prefix),
+ }
+ }
+
+ /// Returns a new `Name` instance representing a qualified name with or without a prefix and
+ /// with a namespace URI.
+ #[inline]
+ #[must_use]
+ pub fn qualified(local_name: &'a str, namespace: &'a str, prefix: Option<&'a str>) -> Name<'a> {
+ Name {
+ local_name,
+ namespace: Some(namespace),
+ prefix,
+ }
+ }
+
+ /// Returns a correct XML representation of this local name and prefix.
+ ///
+ /// This method is different from the autoimplemented `to_string()` because it does not
+ /// include namespace URI in the result.
+ #[must_use]
+ pub fn to_repr(&self) -> String {
+ self.repr_display().to_string()
+ }
+
+ /// Returns a structure which can be displayed with `std::fmt` machinery to obtain this
+ /// local name and prefix.
+ ///
+ /// This method is needed for efficiency purposes in order not to create unnecessary
+ /// allocations.
+ #[inline]
+ #[must_use]
+ pub fn repr_display(&self) -> ReprDisplay<'_, '_> {
+ ReprDisplay(self)
+ }
+
+ /// Returns either a prefix of this name or `namespace::NS_NO_PREFIX` constant.
+ #[inline]
+ #[must_use]
+ pub fn prefix_repr(&self) -> &str {
+ self.prefix.unwrap_or(NS_NO_PREFIX)
+ }
+}
+
+/// A wrapper around `Name` whose `Display` implementation prints the wrapped name as it is
+/// displayed in an XML document.
+pub struct ReprDisplay<'a, 'b>(&'a Name<'b>);
+
+impl<'a, 'b: 'a> fmt::Display for ReprDisplay<'a, 'b> {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self.0.prefix {
+ Some(prefix) => write!(f, "{}:{}", prefix, self.0.local_name),
+ None => self.0.local_name.fmt(f),
+ }
+ }
+}
+
+/// An owned variant of `Name`.
+///
+/// Everything about `Name` applies to this structure as well.
+#[derive(Clone, PartialEq, Eq, Hash, Debug)]
+pub struct OwnedName {
+ /// A local name, e.g. `string` in `xsi:string`.
+ pub local_name: String,
+
+ /// A namespace URI, e.g. `http://www.w3.org/2000/xmlns/`.
+ pub namespace: Option<String>,
+
+ /// A name prefix, e.g. `xsi` in `xsi:string`.
+ pub prefix: Option<String>,
+}
+
+impl fmt::Display for OwnedName {
+ #[inline]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ fmt::Display::fmt(&self.borrow(), f)
+ }
+}
+
+impl OwnedName {
+ /// Constructs a borrowed `Name` based on this owned name.
+ #[must_use]
+ #[inline]
+ pub fn borrow(&self) -> Name<'_> {
+ Name {
+ local_name: &self.local_name,
+ namespace: self.namespace.as_deref(),
+ prefix: self.prefix.as_deref(),
+ }
+ }
+
+ /// Returns a new `OwnedName` instance representing a plain local name.
+ #[inline]
+ pub fn local<S>(local_name: S) -> OwnedName where S: Into<String> {
+ OwnedName {
+ local_name: local_name.into(),
+ namespace: None,
+ prefix: None,
+ }
+ }
+
+ /// Returns a new `OwnedName` instance representing a qualified name with or without
+ /// a prefix and with a namespace URI.
+ #[inline]
+ pub fn qualified<S1, S2, S3>(local_name: S1, namespace: S2, prefix: Option<S3>) -> OwnedName
+ where S1: Into<String>, S2: Into<String>, S3: Into<String>
+ {
+ OwnedName {
+ local_name: local_name.into(),
+ namespace: Some(namespace.into()),
+ prefix: prefix.map(std::convert::Into::into),
+ }
+ }
+
+ /// Returns an optional prefix by reference, equivalent to `self.borrow().prefix`
+ /// but avoids extra work.
+ #[inline]
+ #[must_use]
+ pub fn prefix_ref(&self) -> Option<&str> {
+ self.prefix.as_deref()
+ }
+
+ /// Returns an optional namespace by reference, equivalen to `self.borrow().namespace`
+ /// but avoids extra work.
+ #[inline]
+ #[must_use]
+ pub fn namespace_ref(&self) -> Option<&str> {
+ self.namespace.as_deref()
+ }
+}
+
+impl<'a> From<Name<'a>> for OwnedName {
+ #[inline]
+ fn from(n: Name<'a>) -> OwnedName {
+ n.to_owned()
+ }
+}
+
+impl FromStr for OwnedName {
+ type Err = ();
+
+ /// Parses the given string slice into a qualified name.
+ ///
+ /// This function, when finishes sucessfully, always return a qualified
+ /// name without a namespace (`name.namespace == None`). It should be filled later
+ /// using proper `NamespaceStack`.
+ ///
+ /// It is supposed that all characters in the argument string are correct
+ /// as defined by the XML specification. No additional checks except a check
+ /// for emptiness are done.
+ fn from_str(s: &str) -> Result<OwnedName, ()> {
+ let mut it = s.split(':');
+
+ let r = match (it.next(), it.next(), it.next()) {
+ (Some(prefix), Some(local_name), None) if !prefix.is_empty() &&
+ !local_name.is_empty() =>
+ Some((local_name.into(), Some(prefix.into()))),
+ (Some(local_name), None, None) if !local_name.is_empty() =>
+ Some((local_name.into(), None)),
+ (_, _, _) => None
+ };
+ r.map(|(local_name, prefix)| OwnedName {
+ local_name,
+ namespace: None,
+ prefix
+ }).ok_or(())
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::OwnedName;
+
+ #[test]
+ fn test_owned_name_from_str() {
+ assert_eq!("prefix:name".parse(), Ok(OwnedName {
+ local_name: "name".into(),
+ namespace: None,
+ prefix: Some("prefix".into())
+ }));
+
+ assert_eq!("name".parse(), Ok(OwnedName {
+ local_name: "name".into(),
+ namespace: None,
+ prefix: None
+ }));
+
+ assert_eq!("".parse(), Err::<OwnedName, ()>(()));
+ assert_eq!(":".parse(), Err::<OwnedName, ()>(()));
+ assert_eq!(":a".parse(), Err::<OwnedName, ()>(()));
+ assert_eq!("a:".parse(), Err::<OwnedName, ()>(()));
+ assert_eq!("a:b:c".parse(), Err::<OwnedName, ()>(()));
+ }
+}
diff --git a/crates/xml-rs/src/namespace.rs b/crates/xml-rs/src/namespace.rs
new file mode 100644
index 0000000..02f3b3d
--- /dev/null
+++ b/crates/xml-rs/src/namespace.rs
@@ -0,0 +1,508 @@
+//! Contains namespace manipulation types and functions.
+
+use std::borrow::Cow;
+use std::collections::btree_map::Iter as Entries;
+use std::collections::btree_map::{BTreeMap, Entry};
+use std::collections::HashSet;
+use std::iter::{Map, Rev};
+use std::slice::Iter;
+
+/// Designates prefix for namespace definitions.
+///
+/// See [Namespaces in XML][namespace] spec for more information.
+///
+/// [namespace]: http://www.w3.org/TR/xml-names/#ns-decl
+pub const NS_XMLNS_PREFIX: &str = "xmlns";
+
+/// Designates the standard URI for `xmlns` prefix.
+///
+/// See [A Namespace Name for xmlns Attributes][namespace] for more information.
+///
+/// [namespace]: http://www.w3.org/2000/xmlns/
+pub const NS_XMLNS_URI: &str = "http://www.w3.org/2000/xmlns/";
+
+/// Designates prefix for a namespace containing several special predefined attributes.
+///
+/// See [2.10 White Space handling][1], [2.1 Language Identification][2],
+/// [XML Base specification][3] and [xml:id specification][4] for more information.
+///
+/// [1]: http://www.w3.org/TR/REC-xml/#sec-white-space
+/// [2]: http://www.w3.org/TR/REC-xml/#sec-lang-tag
+/// [3]: http://www.w3.org/TR/xmlbase/
+/// [4]: http://www.w3.org/TR/xml-id/
+pub const NS_XML_PREFIX: &str = "xml";
+
+/// Designates the standard URI for `xml` prefix.
+///
+/// See `NS_XML_PREFIX` documentation for more information.
+pub const NS_XML_URI: &str = "http://www.w3.org/XML/1998/namespace";
+
+/// Designates the absence of prefix in a qualified name.
+///
+/// This constant should be used to define or query default namespace which should be used
+/// for element or attribute names without prefix. For example, if a namespace mapping
+/// at a particular point in the document contains correspondence like
+///
+/// ```none
+/// NS_NO_PREFIX --> urn:some:namespace
+/// ```
+///
+/// then all names declared without an explicit prefix `urn:some:namespace` is assumed as
+/// a namespace URI.
+///
+/// By default empty prefix corresponds to absence of namespace, but this can change either
+/// when writing an XML document (manually) or when reading an XML document (based on namespace
+/// declarations).
+pub const NS_NO_PREFIX: &str = "";
+
+/// Designates an empty namespace URI, which is equivalent to absence of namespace.
+///
+/// This constant should not usually be used directly; it is used to designate that
+/// empty prefix corresponds to absent namespace in `NamespaceStack` instances created with
+/// `NamespaceStack::default()`. Therefore, it can be used to restore `NS_NO_PREFIX` mapping
+/// in a namespace back to its default value.
+pub const NS_EMPTY_URI: &str = "";
+
+/// Namespace is a map from prefixes to namespace URIs.
+///
+/// No prefix (i.e. default namespace) is designated by `NS_NO_PREFIX` constant.
+#[derive(PartialEq, Eq, Clone, Debug)]
+pub struct Namespace(pub BTreeMap<String, String>);
+
+impl Namespace {
+ /// Returns an empty namespace.
+ #[inline]
+ #[must_use]
+ pub fn empty() -> Namespace {
+ Namespace(BTreeMap::new())
+ }
+
+ /// Checks whether this namespace is empty.
+ #[inline]
+ #[must_use]
+ pub fn is_empty(&self) -> bool {
+ self.0.is_empty()
+ }
+
+ /// Checks whether this namespace is essentially empty, that is, it does not contain
+ /// anything but default mappings.
+ #[must_use]
+ pub fn is_essentially_empty(&self) -> bool {
+ // a shortcut for a namespace which is definitely not empty
+ if self.0.len() > 3 { return false; }
+
+ self.0.iter().all(|(k, v)| match (&**k, &**v) {
+ (NS_NO_PREFIX, NS_EMPTY_URI) => true,
+ (NS_XMLNS_PREFIX, NS_XMLNS_URI) => true,
+ (NS_XML_PREFIX, NS_XML_URI) => true,
+ _ => false
+ })
+ }
+
+ /// Checks whether this namespace mapping contains the given prefix.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix.
+ ///
+ /// # Return value
+ /// `true` if this namespace contains the given prefix, `false` otherwise.
+ #[inline]
+ pub fn contains<P: ?Sized + AsRef<str>>(&self, prefix: &P) -> bool {
+ self.0.contains_key(prefix.as_ref())
+ }
+
+ /// Puts a mapping into this namespace.
+ ///
+ /// This method does not override any already existing mappings.
+ ///
+ /// Returns a boolean flag indicating whether the map already contained
+ /// the given prefix.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix;
+ /// * `uri` --- namespace URI.
+ ///
+ /// # Return value
+ /// `true` if `prefix` has been inserted successfully; `false` if the `prefix`
+ /// was already present in the namespace.
+ pub fn put<P, U>(&mut self, prefix: P, uri: U) -> bool
+ where P: Into<String>, U: Into<String>
+ {
+ match self.0.entry(prefix.into()) {
+ Entry::Occupied(_) => false,
+ Entry::Vacant(ve) => {
+ ve.insert(uri.into());
+ true
+ }
+ }
+ }
+
+ /// Puts a mapping into this namespace forcefully.
+ ///
+ /// This method, unlike `put()`, does replace an already existing mapping.
+ ///
+ /// Returns previous URI which was assigned to the given prefix, if it is present.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix;
+ /// * `uri` --- namespace URI.
+ ///
+ /// # Return value
+ /// `Some(uri)` with `uri` being a previous URI assigned to the `prefix`, or
+ /// `None` if such prefix was not present in the namespace before.
+ pub fn force_put<P, U>(&mut self, prefix: P, uri: U) -> Option<String>
+ where P: Into<String>, U: Into<String>
+ {
+ self.0.insert(prefix.into(), uri.into())
+ }
+
+ /// Queries the namespace for the given prefix.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix.
+ ///
+ /// # Return value
+ /// Namespace URI corresponding to the given prefix, if it is present.
+ pub fn get<'a, P: ?Sized + AsRef<str>>(&'a self, prefix: &P) -> Option<&'a str> {
+ self.0.get(prefix.as_ref()).map(|s| &**s)
+ }
+
+ /// Borrowed namespace for the writer
+ #[must_use]
+ pub fn borrow(&self) -> Cow<'_, Self> {
+ Cow::Borrowed(self)
+ }
+}
+
+/// An alias for iterator type for namespace mappings contained in a namespace.
+pub type NamespaceMappings<'a> = Map<
+ Entries<'a, String, String>,
+ for<'b> fn((&'b String, &'b String)) -> UriMapping<'b>
+>;
+
+impl<'a> IntoIterator for &'a Namespace {
+ type Item = UriMapping<'a>;
+ type IntoIter = NamespaceMappings<'a>;
+
+ fn into_iter(self) -> Self::IntoIter {
+ fn mapper<'a>((prefix, uri): (&'a String, &'a String)) -> UriMapping<'a> {
+ (prefix, uri)
+ }
+ self.0.iter().map(mapper)
+ }
+}
+
+/// Namespace stack is a sequence of namespaces.
+///
+/// Namespace stack is used to represent cumulative namespace consisting of
+/// combined namespaces from nested elements.
+#[derive(Clone, Eq, PartialEq, Debug)]
+pub struct NamespaceStack(pub Vec<Namespace>);
+
+impl NamespaceStack {
+ /// Returns an empty namespace stack.
+ #[inline]
+ #[must_use]
+ pub fn empty() -> NamespaceStack {
+ NamespaceStack(Vec::with_capacity(2))
+ }
+
+ /// Returns a namespace stack with default items in it.
+ ///
+ /// Default items are the following:
+ ///
+ /// * `xml` → `http://www.w3.org/XML/1998/namespace`;
+ /// * `xmlns` → `http://www.w3.org/2000/xmlns/`.
+ #[inline]
+ #[must_use]
+ pub fn default() -> NamespaceStack {
+ let mut nst = NamespaceStack::empty();
+ nst.push_empty();
+ // xml namespace
+ nst.put(NS_XML_PREFIX, NS_XML_URI);
+ // xmlns namespace
+ nst.put(NS_XMLNS_PREFIX, NS_XMLNS_URI);
+ // empty namespace
+ nst.put(NS_NO_PREFIX, NS_EMPTY_URI);
+ nst
+ }
+
+ /// Adds an empty namespace to the top of this stack.
+ #[inline]
+ pub fn push_empty(&mut self) -> &mut NamespaceStack {
+ self.0.push(Namespace::empty());
+ self
+ }
+
+ /// Removes the topmost namespace in this stack.
+ ///
+ /// Panics if the stack is empty.
+ #[inline]
+ pub fn pop(&mut self) -> Namespace {
+ self.0.pop().unwrap()
+ }
+
+ /// Removes the topmost namespace in this stack.
+ ///
+ /// Returns `Some(namespace)` if this stack is not empty and `None` otherwise.
+ #[inline]
+ pub fn try_pop(&mut self) -> Option<Namespace> {
+ self.0.pop()
+ }
+
+ /// Borrows the topmost namespace mutably, leaving the stack intact.
+ ///
+ /// Panics if the stack is empty.
+ #[inline]
+ pub fn peek_mut(&mut self) -> &mut Namespace {
+ self.0.last_mut().unwrap()
+ }
+
+ /// Borrows the topmost namespace immutably, leaving the stack intact.
+ ///
+ /// Panics if the stack is empty.
+ #[inline]
+ #[must_use]
+ pub fn peek(&self) -> &Namespace {
+ self.0.last().unwrap()
+ }
+
+ /// Puts a mapping into the topmost namespace if this stack does not already contain one.
+ ///
+ /// Returns a boolean flag indicating whether the insertion has completed successfully.
+ /// Note that both key and value are matched and the mapping is inserted if either
+ /// namespace prefix is not already mapped, or if it is mapped, but to a different URI.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix;
+ /// * `uri` --- namespace URI.
+ ///
+ /// # Return value
+ /// `true` if `prefix` has been inserted successfully; `false` if the `prefix`
+ /// was already present in the namespace stack.
+ pub fn put_checked<P, U>(&mut self, prefix: P, uri: U) -> bool
+ where P: Into<String> + AsRef<str>,
+ U: Into<String> + AsRef<str>
+ {
+ if self.0.iter().any(|ns| ns.get(&prefix) == Some(uri.as_ref())) {
+ false
+ } else {
+ self.put(prefix, uri);
+ true
+ }
+ }
+
+ /// Puts a mapping into the topmost namespace in this stack.
+ ///
+ /// This method does not override a mapping in the topmost namespace if it is
+ /// already present, however, it does not depend on other namespaces in the stack,
+ /// so it is possible to put a mapping which is present in lower namespaces.
+ ///
+ /// Returns a boolean flag indicating whether the insertion has completed successfully.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix;
+ /// * `uri` --- namespace URI.
+ ///
+ /// # Return value
+ /// `true` if `prefix` has been inserted successfully; `false` if the `prefix`
+ /// was already present in the namespace.
+ #[inline]
+ pub fn put<P, U>(&mut self, prefix: P, uri: U) -> bool
+ where P: Into<String>, U: Into<String>
+ {
+ if let Some(ns) = self.0.last_mut() {
+ ns.put(prefix, uri)
+ } else {
+ false
+ }
+ }
+
+ /// Performs a search for the given prefix in the whole stack.
+ ///
+ /// This method walks the stack from top to bottom, querying each namespace
+ /// in order for the given prefix. If none of the namespaces contains the prefix,
+ /// `None` is returned.
+ ///
+ /// # Parameters
+ /// * `prefix` --- namespace prefix.
+ #[inline]
+ pub fn get<'a, P: ?Sized + AsRef<str>>(&'a self, prefix: &P) -> Option<&'a str> {
+ let prefix = prefix.as_ref();
+ for ns in self.0.iter().rev() {
+ match ns.get(prefix) {
+ None => {},
+ r => return r,
+ }
+ }
+ None
+ }
+
+ /// Combines this stack of namespaces into a single namespace.
+ ///
+ /// Namespaces are combined in left-to-right order, that is, rightmost namespace
+ /// elements take priority over leftmost ones.
+ #[must_use]
+ pub fn squash(&self) -> Namespace {
+ let mut result = BTreeMap::new();
+ for ns in &self.0 {
+ result.extend(ns.0.iter().map(|(k, v)| (k.clone(), v.clone())));
+ }
+ Namespace(result)
+ }
+
+ /// Returns an object which implements `Extend` using `put_checked()` instead of `put()`.
+ ///
+ /// See `CheckedTarget` for more information.
+ #[inline]
+ pub fn checked_target(&mut self) -> CheckedTarget<'_> {
+ CheckedTarget(self)
+ }
+
+ /// Returns an iterator over all mappings in this namespace stack.
+ #[inline]
+ #[must_use]
+ pub fn iter(&self) -> NamespaceStackMappings<'_> {
+ self.into_iter()
+ }
+}
+
+/// An iterator over mappings from prefixes to URIs in a namespace stack.
+///
+/// # Example
+/// ```
+/// # use xml::namespace::NamespaceStack;
+/// let mut nst = NamespaceStack::empty();
+/// nst.push_empty();
+/// nst.put("a", "urn:A");
+/// nst.put("b", "urn:B");
+/// nst.push_empty();
+/// nst.put("c", "urn:C");
+///
+/// assert_eq!(vec![("c", "urn:C"), ("a", "urn:A"), ("b", "urn:B")], nst.iter().collect::<Vec<_>>());
+/// ```
+pub struct NamespaceStackMappings<'a> {
+ namespaces: Rev<Iter<'a, Namespace>>,
+ current_namespace: Option<NamespaceMappings<'a>>,
+ used_keys: HashSet<&'a str>,
+}
+
+impl<'a> NamespaceStackMappings<'a> {
+ fn go_to_next_namespace(&mut self) -> bool {
+ self.current_namespace = self.namespaces.next().map(|ns| ns.into_iter());
+ self.current_namespace.is_some()
+ }
+}
+
+impl<'a> Iterator for NamespaceStackMappings<'a> {
+ type Item = UriMapping<'a>;
+
+ fn next(&mut self) -> Option<UriMapping<'a>> {
+ // If there is no current namespace and no next namespace, we're finished
+ if self.current_namespace.is_none() && !self.go_to_next_namespace() {
+ return None;
+ }
+ let next_item = self.current_namespace.as_mut()?.next();
+
+ match next_item {
+ // There is an element in the current namespace
+ Some((k, v)) => if self.used_keys.contains(&k) {
+ // If the current key is used, go to the next one
+ self.next()
+ } else {
+ // Otherwise insert the current key to the set of used keys and
+ // return the mapping
+ self.used_keys.insert(k);
+ Some((k, v))
+ },
+ // Current namespace is exhausted
+ None => if self.go_to_next_namespace() {
+ // If there is next namespace, continue from it
+ self.next()
+ } else {
+ // No next namespace, exiting
+ None
+ }
+ }
+ }
+}
+
+impl<'a> IntoIterator for &'a NamespaceStack {
+ type Item = UriMapping<'a>;
+ type IntoIter = NamespaceStackMappings<'a>;
+
+ fn into_iter(self) -> Self::IntoIter {
+ NamespaceStackMappings {
+ namespaces: self.0.iter().rev(),
+ current_namespace: None,
+ used_keys: HashSet::new(),
+ }
+ }
+}
+
+/// A type alias for a pair of `(prefix, uri)` values returned by namespace iterators.
+pub type UriMapping<'a> = (&'a str, &'a str);
+
+impl<'a> Extend<UriMapping<'a>> for Namespace {
+ fn extend<T>(&mut self, iterable: T) where T: IntoIterator<Item=UriMapping<'a>> {
+ for (prefix, uri) in iterable {
+ self.put(prefix, uri);
+ }
+ }
+}
+
+impl<'a> Extend<UriMapping<'a>> for NamespaceStack {
+ fn extend<T>(&mut self, iterable: T) where T: IntoIterator<Item=UriMapping<'a>> {
+ for (prefix, uri) in iterable {
+ self.put(prefix, uri);
+ }
+ }
+}
+
+/// A wrapper around `NamespaceStack` which implements `Extend` using `put_checked()`.
+///
+/// # Example
+///
+/// ```
+/// # use xml::namespace::NamespaceStack;
+///
+/// let mut nst = NamespaceStack::empty();
+/// nst.push_empty();
+/// nst.put("a", "urn:A");
+/// nst.put("b", "urn:B");
+/// nst.push_empty();
+/// nst.put("c", "urn:C");
+///
+/// nst.checked_target().extend(vec![("a", "urn:Z"), ("b", "urn:B"), ("c", "urn:Y"), ("d", "urn:D")]);
+/// assert_eq!(
+/// vec![("a", "urn:Z"), ("c", "urn:C"), ("d", "urn:D"), ("b", "urn:B")],
+/// nst.iter().collect::<Vec<_>>()
+/// );
+/// ```
+///
+/// Compare:
+///
+/// ```
+/// # use xml::namespace::NamespaceStack;
+/// # let mut nst = NamespaceStack::empty();
+/// # nst.push_empty();
+/// # nst.put("a", "urn:A");
+/// # nst.put("b", "urn:B");
+/// # nst.push_empty();
+/// # nst.put("c", "urn:C");
+///
+/// nst.extend(vec![("a", "urn:Z"), ("b", "urn:B"), ("c", "urn:Y"), ("d", "urn:D")]);
+/// assert_eq!(
+/// vec![("a", "urn:Z"), ("b", "urn:B"), ("c", "urn:C"), ("d", "urn:D")],
+/// nst.iter().collect::<Vec<_>>()
+/// );
+/// ```
+pub struct CheckedTarget<'a>(&'a mut NamespaceStack);
+
+impl<'a, 'b> Extend<UriMapping<'b>> for CheckedTarget<'a> {
+ fn extend<T>(&mut self, iterable: T) where T: IntoIterator<Item=UriMapping<'b>> {
+ for (prefix, uri) in iterable {
+ self.0.put_checked(prefix, uri);
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader.rs b/crates/xml-rs/src/reader.rs
new file mode 100644
index 0000000..20a790c
--- /dev/null
+++ b/crates/xml-rs/src/reader.rs
@@ -0,0 +1,157 @@
+//! Contains high-level interface for a pull-based XML parser.
+//!
+//! The most important type in this module is `EventReader`, which provides an iterator
+//! view for events in XML document.
+
+use std::io::Read;
+use std::iter::FusedIterator;
+use std::result;
+
+use crate::common::{Position, TextPosition};
+
+pub use self::config::ParserConfig;
+pub use self::config::ParserConfig2;
+pub use self::error::{Error, ErrorKind};
+pub use self::events::XmlEvent;
+
+use self::parser::PullParser;
+
+mod config;
+mod events;
+mod lexer;
+mod parser;
+mod indexset;
+mod error;
+
+
+/// A result type yielded by `XmlReader`.
+pub type Result<T, E = Error> = result::Result<T, E>;
+
+/// A wrapper around an `std::io::Read` instance which provides pull-based XML parsing.
+pub struct EventReader<R: Read> {
+ source: R,
+ parser: PullParser,
+}
+
+impl<R: Read> EventReader<R> {
+ /// Creates a new reader, consuming the given stream.
+ #[inline]
+ pub fn new(source: R) -> EventReader<R> {
+ EventReader::new_with_config(source, ParserConfig2::new())
+ }
+
+ /// Creates a new reader with the provded configuration, consuming the given stream.
+ #[inline]
+ pub fn new_with_config(source: R, config: impl Into<ParserConfig2>) -> EventReader<R> {
+ EventReader { source, parser: PullParser::new(config) }
+ }
+
+ /// Pulls and returns next XML event from the stream.
+ ///
+ /// If returned event is `XmlEvent::Error` or `XmlEvent::EndDocument`, then
+ /// further calls to this method will return this event again.
+ #[inline]
+ pub fn next(&mut self) -> Result<XmlEvent> {
+ self.parser.next(&mut self.source)
+ }
+
+ /// Skips all XML events until the next end tag at the current level.
+ ///
+ /// Convenience function that is useful for the case where you have
+ /// encountered a start tag that is of no interest and want to
+ /// skip the entire XML subtree until the corresponding end tag.
+ #[inline]
+ pub fn skip(&mut self) -> Result<()> {
+ let mut depth = 1;
+
+ while depth > 0 {
+ match self.next()? {
+ XmlEvent::StartElement { .. } => depth += 1,
+ XmlEvent::EndElement { .. } => depth -= 1,
+ XmlEvent::EndDocument => unreachable!(),
+ _ => {}
+ }
+ }
+
+ Ok(())
+ }
+
+ pub fn source(&self) -> &R { &self.source }
+ pub fn source_mut(&mut self) -> &mut R { &mut self.source }
+
+ /// Unwraps this `EventReader`, returning the underlying reader.
+ ///
+ /// Note that this operation is destructive; unwrapping the reader and wrapping it
+ /// again with `EventReader::new()` will create a fresh reader which will attempt
+ /// to parse an XML document from the beginning.
+ pub fn into_inner(self) -> R {
+ self.source
+ }
+}
+
+impl<B: Read> Position for EventReader<B> {
+ /// Returns the position of the last event produced by the reader.
+ #[inline]
+ fn position(&self) -> TextPosition {
+ self.parser.position()
+ }
+}
+
+impl<R: Read> IntoIterator for EventReader<R> {
+ type Item = Result<XmlEvent>;
+ type IntoIter = Events<R>;
+
+ fn into_iter(self) -> Events<R> {
+ Events { reader: self, finished: false }
+ }
+}
+
+/// An iterator over XML events created from some type implementing `Read`.
+///
+/// When the next event is `xml::event::Error` or `xml::event::EndDocument`, then
+/// it will be returned by the iterator once, and then it will stop producing events.
+pub struct Events<R: Read> {
+ reader: EventReader<R>,
+ finished: bool,
+}
+
+impl<R: Read> Events<R> {
+ /// Unwraps the iterator, returning the internal `EventReader`.
+ #[inline]
+ pub fn into_inner(self) -> EventReader<R> {
+ self.reader
+ }
+
+ pub fn source(&self) -> &R { &self.reader.source }
+ pub fn source_mut(&mut self) -> &mut R { &mut self.reader.source }
+
+}
+
+impl<R: Read> FusedIterator for Events<R> {
+}
+
+impl<R: Read> Iterator for Events<R> {
+ type Item = Result<XmlEvent>;
+
+ #[inline]
+ fn next(&mut self) -> Option<Result<XmlEvent>> {
+ if self.finished && !self.reader.parser.is_ignoring_end_of_stream() {
+ None
+ } else {
+ let ev = self.reader.next();
+ if let Ok(XmlEvent::EndDocument) | Err(_) = ev {
+ self.finished = true;
+ }
+ Some(ev)
+ }
+ }
+}
+
+impl<'r> EventReader<&'r [u8]> {
+ /// A convenience method to create an `XmlReader` from a string slice.
+ #[inline]
+ #[must_use]
+ pub fn from_str(source: &'r str) -> EventReader<&'r [u8]> {
+ EventReader::new(source.as_bytes())
+ }
+}
diff --git a/crates/xml-rs/src/reader/config.rs b/crates/xml-rs/src/reader/config.rs
new file mode 100644
index 0000000..686d0d4
--- /dev/null
+++ b/crates/xml-rs/src/reader/config.rs
@@ -0,0 +1,369 @@
+//! Contains parser configuration structure.
+use std::collections::HashMap;
+use std::io::Read;
+
+use crate::reader::EventReader;
+use crate::util::Encoding;
+
+/// Limits to defend from billion laughs attack
+const DEFAULT_MAX_ENTITY_EXPANSION_LENGTH: usize = 1_000_000;
+const DEFAULT_MAX_ENTITY_EXPANSION_DEPTH: u8 = 10;
+
+/// Parser configuration structure. **There are more config methods than public fileds — see methods below**.
+///
+/// This structure contains various configuration options which affect
+/// behavior of the parser.
+#[derive(Clone, PartialEq, Eq, Debug)]
+pub struct ParserConfig {
+ /// Whether or not should whitespace in textual events be removed. Default is false.
+ ///
+ /// When true, all standalone whitespace will be removed (this means no
+ /// `Whitespace` events will be emitted), and leading and trailing whitespace
+ /// from `Character` events will be deleted. If after trimming `Characters`
+ /// event will be empty, it will also be omitted from output stream. This is
+ /// possible, however, only if `whitespace_to_characters` or
+ /// `cdata_to_characters` options are set.
+ ///
+ /// This option does not affect CDATA events, unless `cdata_to_characters`
+ /// option is also set. In that case CDATA content will also be trimmed.
+ pub trim_whitespace: bool,
+
+ /// Whether or not should whitespace be converted to characters.
+ /// Default is false.
+ ///
+ /// If true, instead of `Whitespace` events `Characters` events with the
+ /// same content will be emitted. If `trim_whitespace` is also true, these
+ /// events will be trimmed to nothing and, consequently, not emitted.
+ pub whitespace_to_characters: bool,
+
+ /// Whether or not should CDATA be converted to characters.
+ /// Default is false.
+ ///
+ /// If true, instead of `CData` events `Characters` events with the same
+ /// content will be emitted. If `trim_whitespace` is also true, these events
+ /// will be trimmed. If corresponding CDATA contained nothing but whitespace,
+ /// this event will be omitted from the stream.
+ pub cdata_to_characters: bool,
+
+ /// Whether or not should comments be omitted. Default is true.
+ ///
+ /// If true, `Comment` events will not be emitted at all.
+ pub ignore_comments: bool,
+
+ /// Whether or not should sequential `Characters` events be merged.
+ /// Default is true.
+ ///
+ /// If true, multiple sequential `Characters` events will be merged into
+ /// a single event, that is, their data will be concatenated.
+ ///
+ /// Multiple sequential `Characters` events are only possible if either
+ /// `cdata_to_characters` or `ignore_comments` are set. Otherwise character
+ /// events will always be separated by other events.
+ pub coalesce_characters: bool,
+
+ /// A map of extra entities recognized by the parser. Default is an empty map.
+ ///
+ /// By default the XML parser recognizes the entities defined in the XML spec. Sometimes,
+ /// however, it is convenient to make the parser recognize additional entities which
+ /// are also not available through the DTD definitions (especially given that at the moment
+ /// DTD parsing is not supported).
+ pub extra_entities: HashMap<String, String>,
+
+ /// Whether or not the parser should ignore the end of stream. Default is false.
+ ///
+ /// By default the parser will either error out when it encounters a premature end of
+ /// stream or complete normally if the end of stream was expected. If you want to continue
+ /// reading from a stream whose input is supplied progressively, you can set this option to true.
+ /// In this case the parser will allow you to invoke the next() method even if a supposed end
+ /// of stream has happened.
+ ///
+ /// Note that support for this functionality is incomplete; for example, the parser will fail if
+ /// the premature end of stream happens inside PCDATA. Therefore, use this option at your own risk.
+ pub ignore_end_of_stream: bool,
+
+ /// Whether or not non-unicode entity references get replaced with the replacement character
+ ///
+ /// When true, any decimal or hexadecimal character reference that cannot be converted from a
+ /// u32 to a char using [std::char::from_u32](https://doc.rust-lang.org/std/char/fn.from_u32.html)
+ /// will be converted into the unicode REPLACEMENT CHARACTER (U+FFFD).
+ pub replace_unknown_entity_references: bool,
+
+ /// Whether or not whitespace at the root level of the document is ignored. Default is true.
+ ///
+ /// By default any whitespace that is not enclosed within at least one level of elements will be
+ /// ignored. Setting this value to false will cause root level whitespace events to be emitted.
+ ///
+ /// **There are configuration options – see methods below**
+ pub ignore_root_level_whitespace: bool,
+}
+
+impl ParserConfig {
+ /// Returns a new config with default values.
+ ///
+ /// You can tweak default values using builder-like pattern:
+ ///
+ /// ```rust
+ /// use xml::reader::ParserConfig;
+ ///
+ /// let config = ParserConfig::new()
+ /// .trim_whitespace(true)
+ /// .ignore_comments(true)
+ /// .coalesce_characters(false);
+ /// ```
+ #[must_use]
+ #[inline]
+ pub fn new() -> ParserConfig {
+ ParserConfig {
+ trim_whitespace: false,
+ whitespace_to_characters: false,
+ cdata_to_characters: false,
+ ignore_comments: true,
+ coalesce_characters: true,
+ extra_entities: HashMap::new(),
+ ignore_end_of_stream: false,
+ replace_unknown_entity_references: false,
+ ignore_root_level_whitespace: true,
+ }
+ }
+
+ /// Creates an XML reader with this configuration.
+ ///
+ /// This is a convenience method for configuring and creating a reader at the same time:
+ ///
+ /// ```rust
+ /// use xml::reader::ParserConfig;
+ ///
+ /// let mut source: &[u8] = b"...";
+ ///
+ /// let reader = ParserConfig::new()
+ /// .trim_whitespace(true)
+ /// .ignore_comments(true)
+ /// .coalesce_characters(false)
+ /// .create_reader(&mut source);
+ /// ```
+ ///
+ /// This method is exactly equivalent to calling `EventReader::new_with_config()` with
+ /// this configuration object.
+ #[inline]
+ pub fn create_reader<R: Read>(self, source: R) -> EventReader<R> {
+ EventReader::new_with_config(source, self)
+ }
+
+ /// Adds a new entity mapping and returns an updated config object.
+ ///
+ /// This is a convenience method for adding external entities mappings to the XML parser.
+ /// An example:
+ ///
+ /// ```rust
+ /// use xml::reader::ParserConfig;
+ ///
+ /// let mut source: &[u8] = b"...";
+ ///
+ /// let reader = ParserConfig::new()
+ /// .add_entity("nbsp", " ")
+ /// .add_entity("copy", "©")
+ /// .add_entity("reg", "®")
+ /// .create_reader(&mut source);
+ /// ```
+ pub fn add_entity<S: Into<String>, T: Into<String>>(mut self, entity: S, value: T) -> ParserConfig {
+ self.extra_entities.insert(entity.into(), value.into());
+ self
+ }
+}
+
+impl Default for ParserConfig {
+ #[inline]
+ fn default() -> ParserConfig {
+ ParserConfig::new()
+ }
+}
+
+gen_setters! { ParserConfig,
+ trim_whitespace: val bool,
+ whitespace_to_characters: val bool,
+ cdata_to_characters: val bool,
+ ignore_comments: val bool,
+ coalesce_characters: val bool,
+ ignore_end_of_stream: val bool,
+ replace_unknown_entity_references: val bool,
+ ignore_root_level_whitespace: val bool
+}
+
+/// Backwards-compatible extension of `ParserConfig`, which will eventually be merged into the original `ParserConfig` struct
+#[derive(Clone, PartialEq, Eq, Debug)]
+#[non_exhaustive]
+pub struct ParserConfig2 {
+ pub(crate) c: ParserConfig,
+
+ /// Use this encoding as the default. Necessary for UTF-16 files without BOM.
+ pub override_encoding: Option<Encoding>,
+
+ /// Allow `<?xml encoding="…">` to contain unsupported encoding names,
+ /// and interpret them as Latin1 instead. This will mangle non-ASCII characters, but usually it won't fail parsing.
+ pub ignore_invalid_encoding_declarations: bool,
+
+ /// Documents with multiple root elements are ill-formed
+ pub allow_multiple_root_elements: bool,
+
+ /// Abort if custom entities create a string longer than this
+ pub max_entity_expansion_length: usize,
+ /// Entities can expand into other entities this many times (be careful about exponential cost!)
+ pub max_entity_expansion_depth: u8,
+
+ /// Maximum length of tag name or attribute name
+ pub max_name_length: usize,
+
+ /// Max number of attributes per element
+ pub max_attributes: usize,
+
+ /// Max number of bytes in each attribute
+ pub max_attribute_length: usize,
+
+ /// Maximum length of strings reprsenting characters, comments, and processing instructions
+ pub max_data_length: usize,
+}
+
+impl Default for ParserConfig2 {
+ fn default() -> Self {
+ ParserConfig2 {
+ c: Default::default(),
+ override_encoding: None,
+ ignore_invalid_encoding_declarations: false,
+ allow_multiple_root_elements: true,
+ max_entity_expansion_length: DEFAULT_MAX_ENTITY_EXPANSION_LENGTH,
+ max_entity_expansion_depth: DEFAULT_MAX_ENTITY_EXPANSION_DEPTH,
+ max_attributes: 1<<16,
+ max_attribute_length: 1<<30,
+ max_data_length: 1<<30,
+ max_name_length: 1<<18,
+ }
+ }
+}
+
+impl ParserConfig2 {
+ #[inline]
+ #[must_use]
+ pub fn new() -> Self {
+ Self::default()
+ }
+
+ /// Read character encoding from `Content-Type` header.
+ /// Set this when parsing XML documents fetched over HTTP.
+ ///
+ /// `text/*` MIME types do *not* imply latin1. UTF-8 is always the default fallback.
+ #[must_use] pub fn content_type(mut self, mime_type: &str) -> Self {
+ let charset = mime_type.split_once(';')
+ .and_then(|(_, args)| args.split_once("charset"))
+ .and_then(|(_, args)| args.split_once('='));
+ if let Some((_, charset)) = charset {
+ let name = charset.trim().trim_matches('"');
+ match name.parse() {
+ Ok(enc) => {
+ self.override_encoding = Some(enc);
+ },
+ Err(_) => {},
+ }
+ }
+ self
+ }
+
+ /// Creates an XML reader with this configuration.
+ ///
+ /// This is a convenience method for configuring and creating a reader at the same time:
+ ///
+ /// ```rust
+ /// use xml::reader::ParserConfig;
+ ///
+ /// let mut source: &[u8] = b"...";
+ ///
+ /// let reader = ParserConfig::new()
+ /// .trim_whitespace(true)
+ /// .ignore_comments(true)
+ /// .coalesce_characters(false)
+ /// .create_reader(&mut source);
+ /// ```
+ ///
+ /// This method is exactly equivalent to calling `EventReader::new_with_config()` with
+ /// this configuration object.
+ #[inline]
+ pub fn create_reader<R: Read>(self, source: R) -> EventReader<R> {
+ EventReader::new_with_config(source, self)
+ }
+}
+
+impl From<ParserConfig> for ParserConfig2 {
+ #[inline]
+ fn from(c: ParserConfig) -> Self {
+ Self {
+ c,
+ ..Default::default()
+ }
+ }
+}
+
+gen_setters! { ParserConfig2,
+ /// Set if you got one in the HTTP header
+ override_encoding: val Option<Encoding>,
+ /// Allows invalid documents. There should be only a single root element in XML.
+ allow_multiple_root_elements: val bool,
+ /// Abort if custom entities create a string longer than this
+ max_entity_expansion_length: val usize,
+ /// Entities can expand into other entities this many times (be careful about exponential cost!)
+ max_entity_expansion_depth: val u8,
+ /// Max number of attributes per element
+ max_attributes: val usize,
+ /// Maximum length of tag name or attribute name
+ max_name_length: val usize,
+ /// Max number of bytes in each attribute
+ max_attribute_length: val usize,
+ /// Maximum length of strings reprsenting characters, comments, and processing instructions
+ max_data_length: val usize,
+ /// Allow `<?xml encoding="bogus"?>`
+ ignore_invalid_encoding_declarations: val bool
+}
+
+gen_setters! { ParserConfig,
+ /// Set if you got one in the HTTP header (see `content_type`)
+ override_encoding: c2 Option<Encoding>,
+ /// Allow `<?xml encoding="bogus"?>`
+ ignore_invalid_encoding_declarations: c2 bool,
+ /// Allows invalid documents. There should be only a single root element in XML.
+ allow_multiple_root_elements: c2 bool,
+
+ /// Abort if custom entities create a string longer than this
+ max_entity_expansion_length: c2 usize,
+ /// Entities can expand into other entities this many times (be careful about exponential cost!)
+ max_entity_expansion_depth: c2 u8,
+ /// Max number of attributes per element
+ max_attributes: c2 usize,
+ /// Maximum length of tag name or attribute name
+ max_name_length: c2 usize,
+ /// Max number of bytes in each attribute
+ max_attribute_length: c2 usize,
+ /// Maximum length of strings reprsenting characters, comments, and processing instructions
+ max_data_length: c2 usize,
+
+ /// Set encoding from the MIME type. Important for HTTP compatibility.
+ content_type: c2 &str
+}
+
+gen_setters! { ParserConfig2,
+ trim_whitespace: delegate bool,
+ whitespace_to_characters: delegate bool,
+ cdata_to_characters: delegate bool,
+ ignore_comments: delegate bool,
+ coalesce_characters: delegate bool,
+ ignore_end_of_stream: delegate bool,
+ replace_unknown_entity_references: delegate bool,
+ /// Whether or not whitespace at the root level of the document is ignored. Default is true.
+ ignore_root_level_whitespace: delegate bool
+}
+
+#[test]
+fn mime_parse() {
+ let c = ParserConfig2::new().content_type("text/xml;charset=Us-AScii").max_entity_expansion_length(1000);
+ assert_eq!(c.override_encoding, Some(Encoding::Ascii));
+
+ let c = ParserConfig2::new().max_entity_expansion_depth(3).content_type("text/xml;charset = \"UTF-16\"");
+ assert_eq!(c.override_encoding, Some(Encoding::Utf16));
+}
diff --git a/crates/xml-rs/src/reader/error.rs b/crates/xml-rs/src/reader/error.rs
new file mode 100644
index 0000000..64210c4
--- /dev/null
+++ b/crates/xml-rs/src/reader/error.rs
@@ -0,0 +1,251 @@
+use crate::Encoding;
+use crate::reader::lexer::Token;
+
+use std::borrow::Cow;
+use std::error;
+use std::error::Error as _;
+use std::fmt;
+use std::io;
+use std::str;
+
+use crate::common::{Position, TextPosition};
+use crate::util;
+
+#[derive(Debug)]
+pub enum ErrorKind {
+ Syntax(Cow<'static, str>),
+ Io(io::Error),
+ Utf8(str::Utf8Error),
+ UnexpectedEof,
+}
+
+#[derive(Debug, Clone, PartialEq)]
+#[non_exhaustive]
+pub(crate) enum SyntaxError {
+ CannotRedefineXmlnsPrefix,
+ CannotRedefineXmlPrefix,
+ /// Recursive custom entity expanded to too many chars, it could be DoS
+ EntityTooBig,
+ EmptyEntity,
+ NoRootElement,
+ ProcessingInstructionWithoutName,
+ UnbalancedRootElement,
+ UnexpectedEof,
+ UnexpectedOpeningTag,
+ /// Missing `]]>`
+ UnclosedCdata,
+ UnexpectedQualifiedName(Token),
+ UnexpectedTokenOutsideRoot(Token),
+ UnexpectedToken(Token),
+ UnexpectedTokenInEntity(Token),
+ UnexpectedTokenInClosingTag(Token),
+ UnexpectedTokenInOpeningTag(Token),
+ InvalidQualifiedName(Box<str>),
+ UnboundAttribute(Box<str>),
+ UnboundElementPrefix(Box<str>),
+ UnexpectedClosingTag(Box<str>),
+ UnexpectedName(Box<str>),
+ /// Found <?xml-like PI not at the beginning of a document,
+ /// which is an error, see section 2.6 of XML 1.1 spec
+ UnexpectedProcessingInstruction(Box<str>, Token),
+ CannotUndefinePrefix(Box<str>),
+ InvalidCharacterEntity(u32),
+ InvalidDefaultNamespace(Box<str>),
+ InvalidNamePrefix(Box<str>),
+ InvalidNumericEntity(Box<str>),
+ InvalidStandaloneDeclaration(Box<str>),
+ InvalidXmlProcessingInstruction(Box<str>),
+ RedefinedAttribute(Box<str>),
+ UndefinedEntity(Box<str>),
+ UnexpectedEntity(Box<str>),
+ UnexpectedNameInsideXml(Box<str>),
+ UnsupportedEncoding(Box<str>),
+ /// In DTD
+ UnknownMarkupDeclaration(Box<str>),
+ UnexpectedXmlVersion(Box<str>),
+ ConflictingEncoding(Encoding, Encoding),
+ UnexpectedTokenBefore(&'static str, char),
+ /// Document has more stuff than `ParserConfig` allows
+ ExceededConfiguredLimit,
+}
+
+impl fmt::Display for SyntaxError {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ self.to_cow().fmt(f)
+ }
+}
+
+impl SyntaxError {
+ #[inline(never)]
+ #[cold]
+ pub(crate) fn to_cow(&self) -> Cow<'static, str> {
+ match *self {
+ Self::CannotRedefineXmlnsPrefix => "Cannot redefine XMLNS prefix".into(),
+ Self::CannotRedefineXmlPrefix => "Default XMLNS prefix cannot be rebound to another value".into(),
+ Self::EmptyEntity => "Encountered empty entity".into(),
+ Self::EntityTooBig => "Entity too big".into(),
+ Self::NoRootElement => "Unexpected end of stream: no root element found".into(),
+ Self::ProcessingInstructionWithoutName => "Encountered processing instruction without a name".into(),
+ Self::UnbalancedRootElement => "Unexpected end of stream: still inside the root element".into(),
+ Self::UnclosedCdata => "Unclosed <![CDATA[".into(),
+ Self::UnexpectedEof => "Unexpected end of stream".into(),
+ Self::UnexpectedOpeningTag => "'<' is not allowed in attributes".into(),
+ Self::CannotUndefinePrefix(ref ln) => format!("Cannot undefine prefix '{ln}'").into(),
+ Self::ConflictingEncoding(a, b) => format!("Declared encoding {a}, but uses {b}").into(),
+ Self::InvalidCharacterEntity(num) => format!("Invalid character U+{num:04X}").into(),
+ Self::InvalidDefaultNamespace(ref name) => format!( "Namespace '{name}' cannot be default").into(),
+ Self::InvalidNamePrefix(ref prefix) => format!("'{prefix}' cannot be an element name prefix").into(),
+ Self::InvalidNumericEntity(ref v) => format!("Invalid numeric entity: {v}").into(),
+ Self::InvalidQualifiedName(ref e) => format!("Qualified name is invalid: {e}").into(),
+ Self::InvalidStandaloneDeclaration(ref value) => format!("Invalid standalone declaration value: {value}").into(),
+ Self::InvalidXmlProcessingInstruction(ref name) => format!("Invalid processing instruction: <?{name} - \"<?xml\"-like PI is only valid at the beginning of the document").into(),
+ Self::RedefinedAttribute(ref name) => format!("Attribute '{name}' is redefined").into(),
+ Self::UnboundAttribute(ref name) => format!("Attribute {name} prefix is unbound").into(),
+ Self::UnboundElementPrefix(ref name) => format!("Element {name} prefix is unbound").into(),
+ Self::UndefinedEntity(ref v) => format!("Undefined entity: {v}").into(),
+ Self::UnexpectedClosingTag(ref expected_got) => format!("Unexpected closing tag: {expected_got}").into(),
+ Self::UnexpectedEntity(ref name) => format!("Unexpected entity: {name}").into(),
+ Self::UnexpectedName(ref name) => format!("Unexpected name: {name}").into(),
+ Self::UnexpectedNameInsideXml(ref name) => format!("Unexpected name inside XML declaration: {name}").into(),
+ Self::UnexpectedProcessingInstruction(ref buf, token) => format!("Unexpected token inside processing instruction: <?{buf}{token}").into(),
+ Self::UnexpectedQualifiedName(e) => format!("Unexpected token inside qualified name: {e}").into(),
+ Self::UnexpectedToken(token) => format!("Unexpected token: {token}").into(),
+ Self::UnexpectedTokenBefore(before, c) => format!("Unexpected token '{before}' before '{c}'").into(),
+ Self::UnexpectedTokenInClosingTag(token) => format!("Unexpected token inside closing tag: {token}").into(),
+ Self::UnexpectedTokenInEntity(token) => format!("Unexpected token inside entity: {token}").into(),
+ Self::UnexpectedTokenInOpeningTag(token) => format!("Unexpected token inside opening tag: {token}").into(),
+ Self::UnexpectedTokenOutsideRoot(token) => format!("Unexpected characters outside the root element: {token}").into(),
+ Self::UnexpectedXmlVersion(ref version) => format!("Invalid XML version: {version}").into(),
+ Self::UnknownMarkupDeclaration(ref v) => format!("Unknown markup declaration: {v}").into(),
+ Self::UnsupportedEncoding(ref v) => format!("Unsupported encoding: {v}").into(),
+ Self::ExceededConfiguredLimit => "This document is larger/more complex than allowed by the parser's configuration".into(),
+ }
+ }
+}
+
+/// An XML parsing error.
+///
+/// Consists of a 2D position in a document and a textual message describing the error.
+#[derive(Clone, PartialEq, Eq, Debug)]
+pub struct Error {
+ pub(crate) pos: TextPosition,
+ pub(crate) kind: ErrorKind,
+}
+
+impl fmt::Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ use self::ErrorKind::{Io, Syntax, UnexpectedEof, Utf8};
+
+ write!(f, "{} ", self.pos)?;
+ match &self.kind {
+ Io(io_error) => io_error.fmt(f),
+ Utf8(reason) => reason.fmt(f),
+ Syntax(msg) => f.write_str(msg),
+ UnexpectedEof => f.write_str("Unexpected EOF"),
+ }
+ }
+}
+
+impl Position for Error {
+ #[inline]
+ fn position(&self) -> TextPosition { self.pos }
+}
+
+impl Error {
+ /// Returns a reference to a message which is contained inside this error.
+ #[cold]
+ #[doc(hidden)]
+ #[allow(deprecated)]
+ #[must_use] pub fn msg(&self) -> &str {
+ use self::ErrorKind::{Io, Syntax, UnexpectedEof, Utf8};
+ match &self.kind {
+ Io(io_error) => io_error.description(),
+ Utf8(reason) => reason.description(),
+ Syntax(msg) => msg.as_ref(),
+ UnexpectedEof => "Unexpected EOF",
+ }
+ }
+
+ #[must_use]
+ #[inline]
+ pub fn kind(&self) -> &ErrorKind {
+ &self.kind
+ }
+}
+
+impl error::Error for Error {
+ #[allow(deprecated)]
+ #[cold]
+ fn description(&self) -> &str { self.msg() }
+}
+
+impl<'a, P, M> From<(&'a P, M)> for Error where P: Position, M: Into<Cow<'static, str>> {
+ #[cold]
+ fn from(orig: (&'a P, M)) -> Self {
+ Error {
+ pos: orig.0.position(),
+ kind: ErrorKind::Syntax(orig.1.into()),
+ }
+ }
+}
+
+impl From<util::CharReadError> for Error {
+ #[cold]
+ fn from(e: util::CharReadError) -> Self {
+ use crate::util::CharReadError::{Io, UnexpectedEof, Utf8};
+ Error {
+ pos: TextPosition::new(),
+ kind: match e {
+ UnexpectedEof => ErrorKind::UnexpectedEof,
+ Utf8(reason) => ErrorKind::Utf8(reason),
+ Io(io_error) => ErrorKind::Io(io_error),
+ },
+ }
+ }
+}
+
+impl From<io::Error> for Error {
+ #[cold]
+ fn from(e: io::Error) -> Self {
+ Error {
+ pos: TextPosition::new(),
+ kind: ErrorKind::Io(e),
+ }
+ }
+}
+
+impl Clone for ErrorKind {
+ #[cold]
+ fn clone(&self) -> Self {
+ use self::ErrorKind::{Io, Syntax, UnexpectedEof, Utf8};
+ match self {
+ UnexpectedEof => UnexpectedEof,
+ Utf8(reason) => Utf8(*reason),
+ Io(io_error) => Io(io::Error::new(io_error.kind(), io_error.to_string())),
+ Syntax(msg) => Syntax(msg.clone()),
+ }
+ }
+}
+impl PartialEq for ErrorKind {
+ #[allow(deprecated)]
+ fn eq(&self, other: &ErrorKind) -> bool {
+ use self::ErrorKind::{Io, Syntax, UnexpectedEof, Utf8};
+ match (self, other) {
+ (UnexpectedEof, UnexpectedEof) => true,
+ (Utf8(left), Utf8(right)) => left == right,
+ (Io(left), Io(right)) =>
+ left.kind() == right.kind() &&
+ left.description() == right.description(),
+ (Syntax(left), Syntax(right)) =>
+ left == right,
+
+ (_, _) => false,
+ }
+ }
+}
+impl Eq for ErrorKind {}
+
+#[test]
+fn err_size() {
+ assert!(std::mem::size_of::<SyntaxError>() <= 24);
+}
diff --git a/crates/xml-rs/src/reader/events.rs b/crates/xml-rs/src/reader/events.rs
new file mode 100644
index 0000000..e8eb81e
--- /dev/null
+++ b/crates/xml-rs/src/reader/events.rs
@@ -0,0 +1,219 @@
+//! Contains `XmlEvent` datatype, instances of which are emitted by the parser.
+
+use std::fmt;
+use crate::attribute::OwnedAttribute;
+use crate::common::XmlVersion;
+use crate::name::OwnedName;
+use crate::namespace::Namespace;
+
+/// An element of an XML input stream.
+///
+/// Items of this enum are emitted by `reader::EventReader`. They correspond to different
+/// elements of an XML document.
+#[derive(PartialEq, Clone)]
+pub enum XmlEvent {
+ /// Corresponds to XML document declaration.
+ ///
+ /// This event is always emitted before any other event. It is emitted
+ /// even if the actual declaration is not present in the document.
+ StartDocument {
+ /// XML version.
+ ///
+ /// If XML declaration is not present, defaults to `Version10`.
+ version: XmlVersion,
+
+ /// XML document encoding.
+ ///
+ /// If XML declaration is not present or does not contain `encoding` attribute,
+ /// defaults to `"UTF-8"`. This field is currently used for no other purpose than
+ /// informational.
+ encoding: String,
+
+ /// XML standalone declaration.
+ ///
+ /// If XML document is not present or does not contain `standalone` attribute,
+ /// defaults to `None`. This field is currently used for no other purpose than
+ /// informational.
+ standalone: Option<bool>,
+ },
+
+ /// Denotes to the end of the document stream.
+ ///
+ /// This event is always emitted after any other event (except `Error`). After it
+ /// is emitted for the first time, it will always be emitted on next event pull attempts.
+ EndDocument,
+
+ /// Denotes an XML processing instruction.
+ ///
+ /// This event contains a processing instruction target (`name`) and opaque `data`. It
+ /// is up to the application to process them.
+ ProcessingInstruction {
+ /// Processing instruction target.
+ name: String,
+
+ /// Processing instruction content.
+ data: Option<String>,
+ },
+
+ /// Denotes a beginning of an XML element.
+ ///
+ /// This event is emitted after parsing opening tags or after parsing bodiless tags. In the
+ /// latter case `EndElement` event immediately follows.
+ StartElement {
+ /// Qualified name of the element.
+ name: OwnedName,
+
+ /// A list of attributes associated with the element.
+ ///
+ /// Currently attributes are not checked for duplicates (TODO)
+ attributes: Vec<OwnedAttribute>,
+
+ /// Contents of the namespace mapping at this point of the document.
+ namespace: Namespace,
+ },
+
+ /// Denotes an end of an XML element.
+ ///
+ /// This event is emitted after parsing closing tags or after parsing bodiless tags. In the
+ /// latter case it is emitted immediately after corresponding `StartElement` event.
+ EndElement {
+ /// Qualified name of the element.
+ name: OwnedName,
+ },
+
+ /// Denotes CDATA content.
+ ///
+ /// This event contains unparsed data. No unescaping will be performed.
+ ///
+ /// It is possible to configure a parser to emit `Characters` event instead of `CData`. See
+ /// `pull::ParserConfiguration` structure for more information.
+ CData(String),
+
+ /// Denotes a comment.
+ ///
+ /// It is possible to configure a parser to ignore comments, so this event will never be emitted.
+ /// See `pull::ParserConfiguration` structure for more information.
+ Comment(String),
+
+ /// Denotes character data outside of tags.
+ ///
+ /// Contents of this event will always be unescaped, so no entities like `<` or `&` or `{`
+ /// will appear in it.
+ ///
+ /// It is possible to configure a parser to trim leading and trailing whitespace for this event.
+ /// See `pull::ParserConfiguration` structure for more information.
+ Characters(String),
+
+ /// Denotes a chunk of whitespace outside of tags.
+ ///
+ /// It is possible to configure a parser to emit `Characters` event instead of `Whitespace`.
+ /// See `pull::ParserConfiguration` structure for more information. When combined with whitespace
+ /// trimming, it will eliminate standalone whitespace from the event stream completely.
+ Whitespace(String),
+}
+
+impl fmt::Debug for XmlEvent {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ XmlEvent::StartDocument { ref version, ref encoding, standalone } =>
+ write!(f, "StartDocument({}, {}, {:?})", version, *encoding, standalone),
+ XmlEvent::EndDocument =>
+ write!(f, "EndDocument"),
+ XmlEvent::ProcessingInstruction { ref name, ref data } =>
+ write!(f, "ProcessingInstruction({}{})", *name, match *data {
+ Some(ref data) => format!(", {data}"),
+ None => String::new()
+ }),
+ XmlEvent::StartElement { ref name, ref attributes, namespace: Namespace(ref namespace) } =>
+ write!(f, "StartElement({}, {:?}{})", name, namespace, if attributes.is_empty() {
+ String::new()
+ } else {
+ let attributes: Vec<String> = attributes.iter().map(
+ |a| format!("{} -> {}", a.name, a.value)
+ ).collect();
+ format!(", [{}]", attributes.join(", "))
+ }),
+ XmlEvent::EndElement { ref name } =>
+ write!(f, "EndElement({name})"),
+ XmlEvent::Comment(ref data) =>
+ write!(f, "Comment({data})"),
+ XmlEvent::CData(ref data) =>
+ write!(f, "CData({data})"),
+ XmlEvent::Characters(ref data) =>
+ write!(f, "Characters({data})"),
+ XmlEvent::Whitespace(ref data) =>
+ write!(f, "Whitespace({data})")
+ }
+ }
+}
+
+impl XmlEvent {
+ /// Obtains a writer event from this reader event.
+ ///
+ /// This method is useful for streaming processing of XML documents where the output
+ /// is also an XML document. With this method it is possible to process some events
+ /// while passing other events through to the writer unchanged:
+ ///
+ /// ```rust
+ /// use std::str;
+ ///
+ /// use xml::{EventReader, EventWriter};
+ /// use xml::reader::XmlEvent as ReaderEvent;
+ /// use xml::writer::XmlEvent as WriterEvent;
+ ///
+ /// let mut input: &[u8] = b"<hello>world</hello>";
+ /// let mut output: Vec<u8> = Vec::new();
+ ///
+ /// {
+ /// let mut reader = EventReader::new(&mut input);
+ /// let mut writer = EventWriter::new(&mut output);
+ ///
+ /// for e in reader {
+ /// match e.unwrap() {
+ /// ReaderEvent::Characters(s) =>
+ /// writer.write(WriterEvent::characters(&s.to_uppercase())).unwrap(),
+ /// e => if let Some(e) = e.as_writer_event() {
+ /// writer.write(e).unwrap()
+ /// }
+ /// }
+ /// }
+ /// }
+ ///
+ /// assert_eq!(
+ /// str::from_utf8(&output).unwrap(),
+ /// r#"<?xml version="1.0" encoding="UTF-8"?><hello>WORLD</hello>"#
+ /// );
+ /// ```
+ ///
+ /// Note that this API may change or get additions in future to improve its ergonomics.
+ #[must_use]
+ pub fn as_writer_event(&self) -> Option<crate::writer::events::XmlEvent<'_>> {
+ match *self {
+ XmlEvent::StartDocument { version, ref encoding, standalone } =>
+ Some(crate::writer::events::XmlEvent::StartDocument {
+ version,
+ encoding: Some(encoding),
+ standalone
+ }),
+ XmlEvent::ProcessingInstruction { ref name, ref data } =>
+ Some(crate::writer::events::XmlEvent::ProcessingInstruction {
+ name,
+ data: data.as_ref().map(|s| &**s)
+ }),
+ XmlEvent::StartElement { ref name, ref attributes, ref namespace } =>
+ Some(crate::writer::events::XmlEvent::StartElement {
+ name: name.borrow(),
+ attributes: attributes.iter().map(|a| a.borrow()).collect(),
+ namespace: namespace.borrow(),
+ }),
+ XmlEvent::EndElement { ref name } =>
+ Some(crate::writer::events::XmlEvent::EndElement { name: Some(name.borrow()) }),
+ XmlEvent::Comment(ref data) => Some(crate::writer::events::XmlEvent::Comment(data)),
+ XmlEvent::CData(ref data) => Some(crate::writer::events::XmlEvent::CData(data)),
+ XmlEvent::Characters(ref data) |
+ XmlEvent::Whitespace(ref data) => Some(crate::writer::events::XmlEvent::Characters(data)),
+ XmlEvent::EndDocument => None,
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/indexset.rs b/crates/xml-rs/src/reader/indexset.rs
new file mode 100644
index 0000000..3d683a2
--- /dev/null
+++ b/crates/xml-rs/src/reader/indexset.rs
@@ -0,0 +1,116 @@
+use crate::attribute::OwnedAttribute;
+use crate::name::OwnedName;
+
+use std::collections::hash_map::RandomState;
+use std::collections::HashSet;
+use std::hash::BuildHasher;
+use std::hash::Hash;
+use std::hash::Hasher;
+
+/// An ordered set
+pub(crate) struct AttributesSet {
+ vec: Vec<OwnedAttribute>,
+ /// Uses a no-op hasher, because these u64s are hashes already
+ may_contain: HashSet<u64, U64HasherBuilder>,
+ /// This is real hasher for the `OwnedName`
+ hasher: RandomState,
+}
+
+/// Use linear search and don't allocate `HashSet` if there are few attributes,
+/// because allocation costs more than a few comparisons.
+const HASH_THRESHOLD: usize = 8;
+
+impl AttributesSet {
+ pub fn new() -> Self {
+ Self {
+ vec: Vec::new(),
+ hasher: RandomState::new(),
+ may_contain: HashSet::default(),
+ }
+ }
+
+ fn hash(&self, val: &OwnedName) -> u64 {
+ let mut h = self.hasher.build_hasher();
+ val.hash(&mut h);
+ h.finish()
+ }
+
+ pub fn len(&self) -> usize {
+ self.vec.len()
+ }
+
+ pub fn contains(&self, name: &OwnedName) -> bool {
+ // fall back to linear search only on duplicate or hash collision
+ (self.vec.len() < HASH_THRESHOLD || self.may_contain.contains(&self.hash(name))) &&
+ self.vec.iter().any(move |a| &a.name == name)
+ }
+
+ pub fn push(&mut self, attr: OwnedAttribute) {
+ if self.vec.len() >= HASH_THRESHOLD {
+ if self.vec.len() == HASH_THRESHOLD {
+ self.may_contain.reserve(HASH_THRESHOLD * 2);
+ for attr in &self.vec {
+ self.may_contain.insert(self.hash(&attr.name));
+ }
+ }
+ self.may_contain.insert(self.hash(&attr.name));
+ }
+ self.vec.push(attr);
+ }
+
+ pub fn into_vec(self) -> Vec<OwnedAttribute> {
+ self.vec
+ }
+}
+
+#[test]
+fn indexset() {
+ let mut s = AttributesSet::new();
+ let not_here = OwnedName {
+ local_name: "attr1000".into(),
+ namespace: Some("test".into()),
+ prefix: None,
+ };
+
+ // this test will take a lot of time if the `contains()` is linear, and the loop is quadratic
+ for i in 0..50000 {
+ let name = OwnedName {
+ local_name: format!("attr{i}"), namespace: None, prefix: None,
+ };
+ assert!(!s.contains(&name));
+
+ s.push(OwnedAttribute { name, value: String::new() });
+ assert!(!s.contains(¬_here));
+ }
+
+ assert!(s.contains(&OwnedName {
+ local_name: "attr1234".into(), namespace: None, prefix: None,
+ }));
+ assert!(s.contains(&OwnedName {
+ local_name: "attr0".into(), namespace: None, prefix: None,
+ }));
+ assert!(s.contains(&OwnedName {
+ local_name: "attr49999".into(), namespace: None, prefix: None,
+ }));
+}
+
+/// Hashser that does nothing except passing u64 through
+struct U64Hasher(u64);
+
+impl Hasher for U64Hasher {
+ fn finish(&self) -> u64 { self.0 }
+ fn write(&mut self, slice: &[u8]) {
+ for &v in slice { self.0 ^= u64::from(v) } // unused in practice
+ }
+ fn write_u64(&mut self, i: u64) {
+ self.0 ^= i;
+ }
+}
+
+#[derive(Default)]
+struct U64HasherBuilder;
+
+impl BuildHasher for U64HasherBuilder {
+ type Hasher = U64Hasher;
+ fn build_hasher(&self) -> U64Hasher { U64Hasher(0) }
+}
diff --git a/crates/xml-rs/src/reader/lexer.rs b/crates/xml-rs/src/reader/lexer.rs
new file mode 100644
index 0000000..6b59c86
--- /dev/null
+++ b/crates/xml-rs/src/reader/lexer.rs
@@ -0,0 +1,1167 @@
+//! Contains simple lexer for XML documents.
+//!
+//! This module is for internal use. Use `xml::pull` module to do parsing.
+
+
+use crate::reader::ErrorKind;
+use crate::reader::error::SyntaxError;
+use std::collections::VecDeque;
+use std::fmt;
+use std::io::Read;
+use std::result;
+use crate::common::{is_name_char, is_whitespace_char, Position, TextPosition, is_xml10_char, is_xml11_char};
+use crate::reader::Error;
+use crate::util::{CharReader, Encoding};
+
+use super::ParserConfig2;
+
+/// `Token` represents a single lexeme of an XML document. These lexemes
+/// are used to perform actual parsing.
+#[derive(Copy, Clone, PartialEq, Eq, Debug)]
+pub(crate) enum Token {
+ /// `<?`
+ ProcessingInstructionStart,
+ /// `?>`
+ ProcessingInstructionEnd,
+ /// `<!DOCTYPE
+ DoctypeStart,
+ /// `<`
+ OpeningTagStart,
+ /// `</`
+ ClosingTagStart,
+ /// `>`
+ TagEnd,
+ /// `/>`
+ EmptyTagEnd,
+ /// `<!--`
+ CommentStart,
+ /// `-->`
+ CommentEnd,
+ /// Any non-special character except whitespace.
+ Character(char),
+ /// `=`
+ EqualsSign,
+ /// `'`
+ SingleQuote,
+ /// `"`
+ DoubleQuote,
+ /// `<![CDATA[`
+ CDataStart,
+ /// `]]>`
+ CDataEnd,
+ /// `&`
+ ReferenceStart,
+ /// `;`
+ ReferenceEnd,
+ /// `<!` of `ENTITY`
+ MarkupDeclarationStart,
+}
+
+impl fmt::Display for Token {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match *self {
+ Token::Character(c) => c.fmt(f),
+ other => match other {
+ Token::OpeningTagStart => "<",
+ Token::ProcessingInstructionStart => "<?",
+ Token::DoctypeStart => "<!DOCTYPE",
+ Token::ClosingTagStart => "</",
+ Token::CommentStart => "<!--",
+ Token::CDataStart => "<![CDATA[",
+ Token::TagEnd => ">",
+ Token::EmptyTagEnd => "/>",
+ Token::ProcessingInstructionEnd => "?>",
+ Token::CommentEnd => "-->",
+ Token::CDataEnd => "]]>",
+ Token::ReferenceStart => "&",
+ Token::ReferenceEnd => ";",
+ Token::EqualsSign => "=",
+ Token::SingleQuote => "'",
+ Token::DoubleQuote => "\"",
+ Token::MarkupDeclarationStart => "<!",
+ _ => unreachable!()
+ }.fmt(f),
+ }
+ }
+}
+
+impl Token {
+ pub fn as_static_str(&self) -> Option<&'static str> {
+ match *self {
+ Token::OpeningTagStart => Some("<"),
+ Token::ProcessingInstructionStart => Some("<?"),
+ Token::DoctypeStart => Some("<!DOCTYPE"),
+ Token::ClosingTagStart => Some("</"),
+ Token::CommentStart => Some("<!--"),
+ Token::CDataStart => Some("<![CDATA["),
+ Token::TagEnd => Some(">"),
+ Token::EmptyTagEnd => Some("/>"),
+ Token::ProcessingInstructionEnd => Some("?>"),
+ Token::CommentEnd => Some("-->"),
+ Token::CDataEnd => Some("]]>"),
+ Token::ReferenceStart => Some("&"),
+ Token::ReferenceEnd => Some(";"),
+ Token::EqualsSign => Some("="),
+ Token::SingleQuote => Some("'"),
+ Token::DoubleQuote => Some("\""),
+ _ => None
+ }
+ }
+
+ // using String.push_str(token.to_string()) is simply way too slow
+ pub fn push_to_string(&self, target: &mut String) {
+ match *self {
+ Token::Character(c) => {
+ debug_assert!(is_xml10_char(c) || is_xml11_char(c));
+ target.push(c)
+ },
+ _ => if let Some(s) = self.as_static_str() {
+ target.push_str(s);
+ }
+ }
+ }
+}
+
+#[derive(Copy, Clone)]
+enum State {
+ /// Default state
+ Normal,
+ /// Triggered on '<'
+ TagStarted,
+ /// Triggered on '<!'
+ CommentOrCDataOrDoctypeStarted,
+ /// Triggered on '<!-'
+ CommentStarted,
+ /// Triggered on '<!D' up to '<!DOCTYPE'
+ DoctypeStarted(DoctypeStartedSubstate),
+ /// Other items like `<!ELEMENT` in DTD
+ InsideMarkupDeclaration,
+ /// Triggered after DoctypeStarted to handle sub elements
+ InsideDoctype,
+ /// Triggered on '<![' up to '<![CDATA'
+ CDataStarted(CDataStartedSubstate),
+ /// Triggered on '?'
+ ProcessingInstructionClosing,
+ /// Triggered on '/'
+ EmptyTagClosing,
+ /// Triggered on '-' up to '--'
+ CommentClosing(ClosingSubstate),
+ /// Triggered on ']' up to ']]' inside CDATA
+ CDataClosing(ClosingSubstate),
+ /// Triggered on ']' up to ']]' outside CDATA
+ InvalidCDataClosing(ClosingSubstate),
+ /// After `<!--`
+ InsideComment,
+ /// After `<[[`
+ InsideCdata,
+ /// After `<?`
+ InsideProcessingInstruction,
+ /// `<!ENTITY "here">`
+ InsideMarkupDeclarationQuotedString(QuoteStyle),
+}
+
+#[derive(Copy, Clone, Eq, PartialEq)]
+enum QuoteStyle {
+ Single, Double
+}
+
+#[derive(Copy, Clone)]
+enum ClosingSubstate {
+ First, Second
+}
+
+#[derive(Copy, Clone)]
+enum DoctypeStartedSubstate {
+ D, DO, DOC, DOCT, DOCTY, DOCTYP
+}
+
+#[derive(Copy, Clone)]
+enum CDataStartedSubstate {
+ E, C, CD, CDA, CDAT, CDATA
+}
+
+/// `Result` represents lexing result. It is either a token or an error message.
+pub(crate) type Result<T = Option<Token>, E = Error> = result::Result<T, E>;
+
+/// Helps to set up a dispatch table for lexing large unambigous tokens like
+/// `<![CDATA[` or `<!DOCTYPE `.
+macro_rules! dispatch_on_enum_state(
+ ($_self:ident, $s:expr, $c:expr, $is:expr,
+ $($st:ident; $stc:expr ; $next_st:ident ; $chunk:expr),+;
+ $end_st:ident ; $end_c:expr ; $end_chunk:expr ; $e:expr) => (
+ match $s {
+ $(
+ $st => match $c {
+ $stc => $_self.move_to($is($next_st)),
+ _ => $_self.handle_error($chunk, $c)
+ },
+ )+
+ $end_st => match $c {
+ $end_c => $e,
+ _ => $_self.handle_error($end_chunk, $c)
+ }
+ }
+ )
+);
+
+/// `Lexer` is a lexer for XML documents, which implements pull API.
+///
+/// Main method is `next_token` which accepts an `std::io::Read` instance and
+/// tries to read the next lexeme from it.
+///
+/// When `skip_errors` flag is set, invalid lexemes will be returned as `Chunk`s.
+/// When it is not set, errors will be reported as `Err` objects with a string message.
+/// By default this flag is not set. Use `enable_errors` and `disable_errors` methods
+/// to toggle the behavior.
+pub(crate) struct Lexer {
+ st: State,
+ reader: CharReader,
+ pos: TextPosition,
+ head_pos: TextPosition,
+ char_queue: VecDeque<char>,
+ /// Default state to go back to after a tag end (may be `InsideDoctype`)
+ normal_state: State,
+ inside_token: bool,
+ eof_handled: bool,
+ reparse_depth: u8,
+ #[cfg(test)]
+ skip_errors: bool,
+
+ max_entity_expansion_depth: u8,
+ max_entity_expansion_length: usize,
+}
+
+impl Position for Lexer {
+ #[inline]
+ /// Returns the position of the last token produced by the lexer
+ fn position(&self) -> TextPosition { self.pos }
+}
+
+impl Lexer {
+ /// Returns a new lexer with default state.
+ pub(crate) fn new(config: &ParserConfig2) -> Lexer {
+ Lexer {
+ reader: CharReader::new(),
+ pos: TextPosition::new(),
+ head_pos: TextPosition::new(),
+ char_queue: VecDeque::with_capacity(4), // TODO: check size
+ st: State::Normal,
+ normal_state: State::Normal,
+ inside_token: false,
+ eof_handled: false,
+ reparse_depth: 0,
+ #[cfg(test)]
+ skip_errors: false,
+
+ max_entity_expansion_depth: config.max_entity_expansion_depth,
+ max_entity_expansion_length: config.max_entity_expansion_length,
+ }
+ }
+
+ pub(crate) fn encoding(&mut self) -> Encoding {
+ self.reader.encoding
+ }
+
+ pub(crate) fn set_encoding(&mut self, encoding: Encoding) {
+ self.reader.encoding = encoding;
+ }
+
+ /// Disables error handling so `next_token` will return `Some(Chunk(..))`
+ /// upon invalid lexeme with this lexeme content.
+ #[cfg(test)] fn disable_errors(&mut self) { self.skip_errors = true; }
+
+ /// Reset the eof handled flag of the lexer.
+ #[inline]
+ pub fn reset_eof_handled(&mut self) { self.eof_handled = false; }
+
+ /// Tries to read the next token from the buffer.
+ ///
+ /// It is possible to pass different instaces of `BufReader` each time
+ /// this method is called, but the resulting behavior is undefined in this case.
+ ///
+ /// Return value:
+ /// * `Err(reason) where reason: reader::Error` - when an error occurs;
+ /// * `Ok(None)` - upon end of stream is reached;
+ /// * `Ok(Some(token)) where token: Token` - in case a complete-token has been read from the stream.
+ pub fn next_token<B: Read>(&mut self, b: &mut B) -> Result {
+ // Already reached end of buffer
+ if self.eof_handled {
+ return Ok(None);
+ }
+
+ if !self.inside_token {
+ self.pos = self.head_pos;
+ self.inside_token = true;
+ }
+
+ // Check if we have saved a char or two for ourselves
+ while let Some(c) = self.char_queue.pop_front() {
+ match self.dispatch_char(c)? {
+ Some(t) => {
+ self.inside_token = false;
+ return Ok(Some(t));
+ }
+ None => {} // continue
+ }
+ }
+ // if char_queue is empty, all circular reparsing is done
+ self.reparse_depth = 0;
+ loop {
+ let c = match self.reader.next_char_from(b)? {
+ Some(c) => c, // got next char
+ None => break, // nothing to read left
+ };
+
+ if c == '\n' {
+ self.head_pos.new_line();
+ } else {
+ self.head_pos.advance(1);
+ }
+
+ match self.dispatch_char(c)? {
+ Some(t) => {
+ self.inside_token = false;
+ return Ok(Some(t));
+ }
+ None => {
+ // continue
+ }
+ }
+ }
+
+ self.end_of_stream()
+ }
+
+ #[inline(never)]
+ fn end_of_stream(&mut self) -> Result {
+ // Handle end of stream
+ self.eof_handled = true;
+ self.pos = self.head_pos;
+ match self.st {
+ State::InsideCdata | State::CDataClosing(_) => Err(self.error(SyntaxError::UnclosedCdata)),
+ State::TagStarted | State::CommentOrCDataOrDoctypeStarted |
+ State::CommentStarted | State::CDataStarted(_)| State::DoctypeStarted(_) |
+ State::CommentClosing(ClosingSubstate::Second) |
+ State::InsideComment | State::InsideMarkupDeclaration |
+ State::InsideProcessingInstruction | State::ProcessingInstructionClosing |
+ State::InsideDoctype | State::InsideMarkupDeclarationQuotedString(_) =>
+ Err(self.error(SyntaxError::UnexpectedEof)),
+ State::EmptyTagClosing =>
+ Ok(Some(Token::Character('/'))),
+ State::CommentClosing(ClosingSubstate::First) =>
+ Ok(Some(Token::Character('-'))),
+ State::InvalidCDataClosing(ClosingSubstate::First) =>
+ Ok(Some(Token::Character(']'))),
+ State::InvalidCDataClosing(ClosingSubstate::Second) => {
+ self.eof_handled = false;
+ self.move_to_with_unread(State::Normal, &[']'], Token::Character(']'))
+ },
+ State::Normal =>
+ Ok(None),
+ }
+ }
+
+ #[cold]
+ fn error(&self, e: SyntaxError) -> Error {
+ Error {
+ pos: self.position(),
+ kind: ErrorKind::Syntax(e.to_cow()),
+ }
+ }
+
+
+ #[inline(never)]
+ fn dispatch_char(&mut self, c: char) -> Result {
+ match self.st {
+ State::Normal => self.normal(c),
+ State::TagStarted => self.tag_opened(c),
+ State::EmptyTagClosing => self.empty_element_closing(c),
+ State::CommentOrCDataOrDoctypeStarted => self.comment_or_cdata_or_doctype_started(c),
+ State::InsideCdata => self.inside_cdata(c),
+ State::CDataStarted(s) => self.cdata_started(c, s),
+ State::InsideComment => self.inside_comment_state(c),
+ State::CommentStarted => self.comment_started(c),
+ State::InsideProcessingInstruction => self.inside_processing_instruction(c),
+ State::ProcessingInstructionClosing => self.processing_instruction_closing(c),
+ State::CommentClosing(s) => self.comment_closing(c, s),
+ State::CDataClosing(s) => self.cdata_closing(c, s),
+ State::InsideDoctype => self.inside_doctype(c),
+ State::DoctypeStarted(s) => self.doctype_started(c, s),
+ State::InvalidCDataClosing(s) => self.invalid_cdata_closing(c, s),
+ State::InsideMarkupDeclaration => self.markup_declaration(c),
+ State::InsideMarkupDeclarationQuotedString(q) => self.markup_declaration_string(c, q),
+ }
+ }
+
+ #[inline]
+ fn move_to(&mut self, st: State) -> Result {
+ self.st = st;
+ Ok(None)
+ }
+
+ #[inline]
+ fn move_to_with(&mut self, st: State, token: Token) -> Result {
+ self.st = st;
+ Ok(Some(token))
+ }
+
+ #[inline]
+ fn move_to_and_reset_normal(&mut self, st: State, token: Token) -> Result {
+ self.normal_state = st;
+ self.st = st;
+ Ok(Some(token))
+ }
+
+ fn move_to_with_unread(&mut self, st: State, cs: &[char], token: Token) -> Result {
+ for c in cs.iter().rev().copied() {
+ self.char_queue.push_front(c);
+ }
+ self.move_to_with(st, token)
+ }
+
+ pub(crate) fn reparse(&mut self, markup: &str) -> Result<()> {
+ if markup.is_empty() {
+ return Ok(());
+ }
+
+ self.reparse_depth += 1;
+ if self.reparse_depth > self.max_entity_expansion_depth || self.char_queue.len() > self.max_entity_expansion_length {
+ return Err(self.error(SyntaxError::EntityTooBig))
+ }
+
+ self.eof_handled = false;
+ self.char_queue.reserve(markup.len());
+ for c in markup.chars().rev() {
+ self.char_queue.push_front(c);
+ }
+
+ Ok(())
+ }
+
+ fn handle_error(&mut self, chunk: &'static str, c: char) -> Result {
+ debug_assert!(!chunk.is_empty());
+
+ #[cfg(test)]
+ if self.skip_errors {
+ let mut chars = chunk.chars();
+ let first = chars.next().unwrap_or('\0');
+ self.char_queue.extend(chars);
+ self.char_queue.push_back(c);
+ return self.move_to_with(State::Normal, Token::Character(first));
+ }
+ Err(self.error(SyntaxError::UnexpectedTokenBefore(chunk, c)))
+ }
+
+ /// Encountered a char
+ fn normal(&mut self, c: char) -> Result {
+ match c {
+ '<' => self.move_to(State::TagStarted),
+ '>' => Ok(Some(Token::TagEnd)),
+ '/' => self.move_to(State::EmptyTagClosing),
+ '=' => Ok(Some(Token::EqualsSign)),
+ '"' => Ok(Some(Token::DoubleQuote)),
+ '\'' => Ok(Some(Token::SingleQuote)),
+ ']' => self.move_to(State::InvalidCDataClosing(ClosingSubstate::First)),
+ '&' => Ok(Some(Token::ReferenceStart)),
+ ';' => Ok(Some(Token::ReferenceEnd)),
+ _ => Ok(Some(Token::Character(c)))
+ }
+ }
+
+ fn inside_cdata(&mut self, c: char) -> Result {
+ match c {
+ ']' => self.move_to(State::CDataClosing(ClosingSubstate::First)),
+ _ => Ok(Some(Token::Character(c)))
+ }
+ }
+
+ fn inside_processing_instruction(&mut self, c: char) -> Result {
+ // These tokens are used by `<?xml?>` parser
+ match c {
+ '?' => self.move_to(State::ProcessingInstructionClosing),
+ '<' => Ok(Some(Token::OpeningTagStart)),
+ '>' => Ok(Some(Token::TagEnd)),
+ '/' => Ok(Some(Token::ClosingTagStart)),
+ '=' => Ok(Some(Token::EqualsSign)),
+ '"' => Ok(Some(Token::DoubleQuote)),
+ '\'' => Ok(Some(Token::SingleQuote)),
+ '&' => Ok(Some(Token::ReferenceStart)),
+ ';' => Ok(Some(Token::ReferenceEnd)),
+ _ => Ok(Some(Token::Character(c)))
+ }
+ }
+
+ fn inside_comment_state(&mut self, c: char) -> Result {
+ match c {
+ '-' => self.move_to(State::CommentClosing(ClosingSubstate::First)),
+ _ => Ok(Some(Token::Character(c)))
+ }
+ }
+
+ /// Encountered '<'
+ fn tag_opened(&mut self, c: char) -> Result {
+ match c {
+ '?' => self.move_to_with(State::InsideProcessingInstruction, Token::ProcessingInstructionStart),
+ '/' => self.move_to_with(self.normal_state, Token::ClosingTagStart),
+ '!' => self.move_to(State::CommentOrCDataOrDoctypeStarted),
+ _ if is_whitespace_char(c) => self.move_to_with_unread(self.normal_state, &[c], Token::OpeningTagStart),
+ _ if is_name_char(c) => self.move_to_with_unread(self.normal_state, &[c], Token::OpeningTagStart),
+ _ => self.handle_error("<", c)
+ }
+ }
+
+ /// Encountered '<!'
+ fn comment_or_cdata_or_doctype_started(&mut self, c: char) -> Result {
+ match c {
+ '-' => self.move_to(State::CommentStarted),
+ '[' => self.move_to(State::CDataStarted(CDataStartedSubstate::E)),
+ 'D' => self.move_to(State::DoctypeStarted(DoctypeStartedSubstate::D)),
+ 'E' | 'A' | 'N' if matches!(self.normal_state, State::InsideDoctype) => {
+ self.move_to_with_unread(State::InsideMarkupDeclaration, &[c], Token::MarkupDeclarationStart)
+ },
+ _ => self.handle_error("<!", c),
+ }
+ }
+
+ /// Encountered '<!-'
+ fn comment_started(&mut self, c: char) -> Result {
+ match c {
+ '-' => self.move_to_with(State::InsideComment, Token::CommentStart),
+ _ => self.handle_error("<!-", c),
+ }
+ }
+
+ /// Encountered '<!['
+ fn cdata_started(&mut self, c: char, s: CDataStartedSubstate) -> Result {
+ use self::CDataStartedSubstate::{C, CD, CDA, CDAT, CDATA, E};
+ dispatch_on_enum_state!(self, s, c, State::CDataStarted,
+ E ; 'C' ; C ; "<![",
+ C ; 'D' ; CD ; "<![C",
+ CD ; 'A' ; CDA ; "<![CD",
+ CDA ; 'T' ; CDAT ; "<![CDA",
+ CDAT ; 'A' ; CDATA ; "<![CDAT";
+ CDATA ; '[' ; "<![CDATA" ; self.move_to_with(State::InsideCdata, Token::CDataStart)
+ )
+ }
+
+ /// Encountered '<!…' that isn't DOCTYPE or CDATA
+ fn markup_declaration(&mut self, c: char) -> Result {
+ match c {
+ '<' => self.handle_error("<!", c),
+ '>' => self.move_to_with(self.normal_state, Token::TagEnd),
+ '&' => Ok(Some(Token::ReferenceStart)),
+ ';' => Ok(Some(Token::ReferenceEnd)),
+ '"' => self.move_to_with(State::InsideMarkupDeclarationQuotedString(QuoteStyle::Double), Token::DoubleQuote),
+ '\'' => self.move_to_with(State::InsideMarkupDeclarationQuotedString(QuoteStyle::Single), Token::SingleQuote),
+ _ => Ok(Some(Token::Character(c))),
+ }
+ }
+
+ fn markup_declaration_string(&mut self, c: char, q: QuoteStyle) -> Result {
+ match c {
+ '"' if q == QuoteStyle::Double => self.move_to_with(State::InsideMarkupDeclaration, Token::DoubleQuote),
+ '\'' if q == QuoteStyle::Single => self.move_to_with(State::InsideMarkupDeclaration, Token::SingleQuote),
+ _ => Ok(Some(Token::Character(c))),
+ }
+ }
+
+ /// Encountered '<!D'
+ fn doctype_started(&mut self, c: char, s: DoctypeStartedSubstate) -> Result {
+ use self::DoctypeStartedSubstate::{D, DO, DOC, DOCT, DOCTY, DOCTYP};
+ dispatch_on_enum_state!(self, s, c, State::DoctypeStarted,
+ D ; 'O' ; DO ; "<!D",
+ DO ; 'C' ; DOC ; "<!DO",
+ DOC ; 'T' ; DOCT ; "<!DOC",
+ DOCT ; 'Y' ; DOCTY ; "<!DOCT",
+ DOCTY ; 'P' ; DOCTYP ; "<!DOCTY";
+ DOCTYP ; 'E' ; "<!DOCTYP" ; self.move_to_and_reset_normal(State::InsideDoctype, Token::DoctypeStart)
+ )
+ }
+
+ /// State used while awaiting the closing bracket for the <!DOCTYPE tag
+ fn inside_doctype(&mut self, c: char) -> Result {
+ match c {
+ '>' => self.move_to_and_reset_normal(State::Normal, Token::TagEnd),
+ '<' => self.move_to(State::TagStarted),
+ '&' => Ok(Some(Token::ReferenceStart)),
+ ';' => Ok(Some(Token::ReferenceEnd)),
+ '"' => Ok(Some(Token::DoubleQuote)),
+ '\'' => Ok(Some(Token::SingleQuote)),
+ _ => Ok(Some(Token::Character(c))),
+ }
+ }
+
+ /// Encountered '?'
+ fn processing_instruction_closing(&mut self, c: char) -> Result {
+ match c {
+ '>' => self.move_to_with(self.normal_state, Token::ProcessingInstructionEnd),
+ _ => self.move_to_with_unread(State::InsideProcessingInstruction, &[c], Token::Character('?')),
+ }
+ }
+
+ /// Encountered '/'
+ fn empty_element_closing(&mut self, c: char) -> Result {
+ match c {
+ '>' => self.move_to_with(self.normal_state, Token::EmptyTagEnd),
+ _ => self.move_to_with_unread(self.normal_state, &[c], Token::Character('/')),
+ }
+ }
+
+ /// Encountered '-'
+ fn comment_closing(&mut self, c: char, s: ClosingSubstate) -> Result {
+ match s {
+ ClosingSubstate::First => match c {
+ '-' => self.move_to(State::CommentClosing(ClosingSubstate::Second)),
+ _ => self.move_to_with_unread(State::InsideComment, &[c], Token::Character('-')),
+ },
+ ClosingSubstate::Second => match c {
+ '>' => self.move_to_with(self.normal_state, Token::CommentEnd),
+ // double dash not followed by a greater-than is a hard error inside comment
+ _ => self.handle_error("--", c),
+ },
+ }
+ }
+
+ /// Encountered ']'
+ fn cdata_closing(&mut self, c: char, s: ClosingSubstate) -> Result {
+ match s {
+ ClosingSubstate::First => match c {
+ ']' => self.move_to(State::CDataClosing(ClosingSubstate::Second)),
+ _ => self.move_to_with_unread(State::InsideCdata, &[c], Token::Character(']')),
+ },
+ ClosingSubstate::Second => match c {
+ '>' => self.move_to_with(State::Normal, Token::CDataEnd),
+ _ => self.move_to_with_unread(State::InsideCdata, &[']', c], Token::Character(']')),
+ },
+ }
+ }
+
+ /// Encountered ']'
+ fn invalid_cdata_closing(&mut self, c: char, s: ClosingSubstate) -> Result {
+ match s {
+ ClosingSubstate::First => match c {
+ ']' => self.move_to(State::InvalidCDataClosing(ClosingSubstate::Second)),
+ _ => self.move_to_with_unread(State::Normal, &[c], Token::Character(']')),
+ },
+ ClosingSubstate::Second => match c {
+ '>' => self.move_to_with(self.normal_state, Token::CDataEnd),
+ _ => self.move_to_with_unread(State::Normal, &[']', c], Token::Character(']')),
+ },
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use crate::{common::Position, reader::ParserConfig2};
+ use std::io::{BufReader, Cursor};
+
+ use super::{Lexer, Token};
+
+ macro_rules! assert_oks(
+ (for $lex:ident and $buf:ident ; $($e:expr)+) => ({
+ $(
+ assert_eq!(Ok(Some($e)), $lex.next_token(&mut $buf));
+ )+
+ })
+ );
+
+ macro_rules! assert_err(
+ (for $lex:ident and $buf:ident expect row $r:expr ; $c:expr, $s:expr) => ({
+ let err = $lex.next_token(&mut $buf);
+ assert!(err.is_err());
+ let err = err.unwrap_err();
+ assert_eq!($r as u64, err.position().row);
+ assert_eq!($c as u64, err.position().column);
+ })
+ );
+
+ macro_rules! assert_none(
+ (for $lex:ident and $buf:ident) => (
+ assert_eq!(Ok(None), $lex.next_token(&mut $buf))
+ )
+ );
+
+ fn make_lex_and_buf(s: &str) -> (Lexer, BufReader<Cursor<Vec<u8>>>) {
+ (Lexer::new(&ParserConfig2::default()), BufReader::new(Cursor::new(s.to_owned().into_bytes())))
+ }
+
+ #[test]
+ fn tricky_pi() {
+ let (mut lex, mut buf) = make_lex_and_buf(r#"<?x<!-- &??><x>"#);
+
+ assert_oks!(for lex and buf ;
+ Token::ProcessingInstructionStart
+ Token::Character('x')
+ Token::OpeningTagStart // processing of <?xml?> relies on the extra tokens
+ Token::Character('!')
+ Token::Character('-')
+ Token::Character('-')
+ Token::Character(' ')
+ Token::ReferenceStart
+ Token::Character('?')
+ Token::ProcessingInstructionEnd
+ Token::OpeningTagStart
+ Token::Character('x')
+ Token::TagEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn reparser() {
+ let (mut lex, mut buf) = make_lex_and_buf(r#"&a;"#);
+
+ assert_oks!(for lex and buf ;
+ Token::ReferenceStart
+ Token::Character('a')
+ Token::ReferenceEnd
+ );
+ lex.reparse("<hi/>").unwrap();
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('h')
+ Token::Character('i')
+ Token::EmptyTagEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn simple_lexer_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<a p='q'> x<b z="y">d </b></a><p/> <?nm ?> <!-- a c --> "#
+ );
+
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::Character(' ')
+ Token::Character('p')
+ Token::EqualsSign
+ Token::SingleQuote
+ Token::Character('q')
+ Token::SingleQuote
+ Token::TagEnd
+ Token::Character(' ')
+ Token::Character('x')
+ Token::OpeningTagStart
+ Token::Character('b')
+ Token::Character(' ')
+ Token::Character('z')
+ Token::EqualsSign
+ Token::DoubleQuote
+ Token::Character('y')
+ Token::DoubleQuote
+ Token::TagEnd
+ Token::Character('d')
+ Token::Character('\t')
+ Token::ClosingTagStart
+ Token::Character('b')
+ Token::TagEnd
+ Token::ClosingTagStart
+ Token::Character('a')
+ Token::TagEnd
+ Token::OpeningTagStart
+ Token::Character('p')
+ Token::EmptyTagEnd
+ Token::Character(' ')
+ Token::ProcessingInstructionStart
+ Token::Character('n')
+ Token::Character('m')
+ Token::Character(' ')
+ Token::ProcessingInstructionEnd
+ Token::Character(' ')
+ Token::CommentStart
+ Token::Character(' ')
+ Token::Character('a')
+ Token::Character(' ')
+ Token::Character('c')
+ Token::Character(' ')
+ Token::CommentEnd
+ Token::Character(' ')
+ Token::ReferenceStart
+ Token::Character('n')
+ Token::Character('b')
+ Token::Character('s')
+ Token::Character('p')
+ Token::ReferenceEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn special_chars_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"?x!+ // -| ]z]]"#
+ );
+
+ assert_oks!(for lex and buf ;
+ Token::Character('?')
+ Token::Character('x')
+ Token::Character('!')
+ Token::Character('+')
+ Token::Character(' ')
+ Token::Character('/')
+ Token::Character('/')
+ Token::Character(' ')
+ Token::Character('-')
+ Token::Character('|')
+ Token::Character(' ')
+ Token::Character(']')
+ Token::Character('z')
+ Token::Character(']')
+ Token::Character(']')
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn cdata_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<a><![CDATA[x y ?]]> </a>"#
+ );
+
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::TagEnd
+ Token::CDataStart
+ Token::Character('x')
+ Token::Character(' ')
+ Token::Character('y')
+ Token::Character(' ')
+ Token::Character('?')
+ Token::CDataEnd
+ Token::Character(' ')
+ Token::ClosingTagStart
+ Token::Character('a')
+ Token::TagEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn cdata_closers_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<![CDATA[] > ]> ]]><!---->]]<a>"#
+ );
+
+ assert_oks!(for lex and buf ;
+ Token::CDataStart
+ Token::Character(']')
+ Token::Character(' ')
+ Token::Character('>')
+ Token::Character(' ')
+ Token::Character(']')
+ Token::Character('>')
+ Token::Character(' ')
+ Token::CDataEnd
+ Token::CommentStart
+ Token::CommentEnd
+ Token::Character(']')
+ Token::Character(']')
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::TagEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn doctype_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<a><!DOCTYPE ab xx z> "#
+ );
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::TagEnd
+ Token::DoctypeStart
+ Token::Character(' ')
+ Token::Character('a')
+ Token::Character('b')
+ Token::Character(' ')
+ Token::Character('x')
+ Token::Character('x')
+ Token::Character(' ')
+ Token::Character('z')
+ Token::TagEnd
+ Token::Character(' ')
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn tricky_comments() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<a><!-- C ->--></a>"#
+ );
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::TagEnd
+ Token::CommentStart
+ Token::Character(' ')
+ Token::Character('C')
+ Token::Character(' ')
+ Token::Character('-')
+ Token::Character('>')
+ Token::CommentEnd
+ Token::ClosingTagStart
+ Token::Character('a')
+ Token::TagEnd
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn doctype_with_internal_subset_test() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<a><!DOCTYPE ab[<!ELEMENT ba ">>>"> ]> "#
+ );
+ assert_oks!(for lex and buf ;
+ Token::OpeningTagStart
+ Token::Character('a')
+ Token::TagEnd
+ Token::DoctypeStart
+ Token::Character(' ')
+ Token::Character('a')
+ Token::Character('b')
+ Token::Character('[')
+ Token::MarkupDeclarationStart
+ Token::Character('E')
+ Token::Character('L')
+ Token::Character('E')
+ Token::Character('M')
+ Token::Character('E')
+ Token::Character('N')
+ Token::Character('T')
+ Token::Character(' ')
+ Token::Character('b')
+ Token::Character('a')
+ Token::Character(' ')
+ Token::DoubleQuote
+ Token::Character('>')
+ Token::Character('>')
+ Token::Character('>')
+ Token::DoubleQuote
+ Token::TagEnd
+ Token::Character(' ')
+ Token::Character(']')
+ Token::TagEnd
+ Token::Character(' ')
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn doctype_internal_pi_comment() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ "<!DOCTYPE a [\n<!ELEMENT l ANY> <!-- <?non?>--> <?pi > ?> \n]>"
+ );
+ assert_oks!(for lex and buf ;
+ Token::DoctypeStart
+ Token::Character(' ')
+ Token::Character('a')
+ Token::Character(' ')
+ Token::Character('[')
+ Token::Character('\n')
+ Token::MarkupDeclarationStart
+ Token::Character('E')
+ Token::Character('L')
+ Token::Character('E')
+ Token::Character('M')
+ Token::Character('E')
+ Token::Character('N')
+ Token::Character('T')
+ Token::Character(' ')
+ Token::Character('l')
+ Token::Character(' ')
+ Token::Character('A')
+ Token::Character('N')
+ Token::Character('Y')
+ Token::TagEnd
+ Token::Character(' ')
+ Token::CommentStart
+ Token::Character(' ')
+ Token::Character('<')
+ Token::Character('?')
+ Token::Character('n')
+ Token::Character('o')
+ Token::Character('n')
+ Token::Character('?')
+ Token::Character('>')
+ Token::CommentEnd
+ Token::Character(' ')
+ Token::ProcessingInstructionStart
+ Token::Character('p')
+ Token::Character('i')
+ Token::Character(' ')
+ Token::TagEnd // not really
+ Token::Character(' ')
+ Token::ProcessingInstructionEnd
+ Token::Character(' ')
+ Token::Character('\n')
+ Token::Character(']')
+ Token::TagEnd // DTD
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn end_of_stream_handling_ok() {
+ macro_rules! eof_check(
+ ($data:expr ; $token:expr) => ({
+ let (mut lex, mut buf) = make_lex_and_buf($data);
+ assert_oks!(for lex and buf ; $token);
+ assert_none!(for lex and buf);
+ })
+ );
+ eof_check!("?" ; Token::Character('?'));
+ eof_check!("/" ; Token::Character('/'));
+ eof_check!("-" ; Token::Character('-'));
+ eof_check!("]" ; Token::Character(']'));
+ eof_check!("]" ; Token::Character(']'));
+ eof_check!("]" ; Token::Character(']'));
+ }
+
+ #[test]
+ fn end_of_stream_handling_error() {
+ macro_rules! eof_check(
+ ($data:expr; $r:expr, $c:expr) => ({
+ let (mut lex, mut buf) = make_lex_and_buf($data);
+ assert_err!(for lex and buf expect row $r ; $c, "Unexpected end of stream");
+ assert_none!(for lex and buf);
+ })
+ );
+ eof_check!("<" ; 0, 1);
+ eof_check!("<!" ; 0, 2);
+ eof_check!("<!-" ; 0, 3);
+ eof_check!("<![" ; 0, 3);
+ eof_check!("<![C" ; 0, 4);
+ eof_check!("<![CD" ; 0, 5);
+ eof_check!("<![CDA" ; 0, 6);
+ eof_check!("<![CDAT" ; 0, 7);
+ eof_check!("<![CDATA" ; 0, 8);
+ }
+
+ #[test]
+ fn error_in_comment_or_cdata_prefix() {
+ let (mut lex, mut buf) = make_lex_and_buf("<!x");
+ assert_err!(for lex and buf expect row 0 ; 0,
+ "Unexpected token '<!' before 'x'"
+ );
+
+ let (mut lex, mut buf) = make_lex_and_buf("<!x");
+ lex.disable_errors();
+ assert_oks!(for lex and buf ;
+ Token::Character('<')
+ Token::Character('!')
+ Token::Character('x')
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn error_in_comment_started() {
+ let (mut lex, mut buf) = make_lex_and_buf("<!-\t");
+ assert_err!(for lex and buf expect row 0 ; 0,
+ "Unexpected token '<!-' before '\t'"
+ );
+
+ let (mut lex, mut buf) = make_lex_and_buf("<!-\t");
+ lex.disable_errors();
+ assert_oks!(for lex and buf ;
+ Token::Character('<')
+ Token::Character('!')
+ Token::Character('-')
+ Token::Character('\t')
+ );
+ assert_none!(for lex and buf);
+ }
+
+ #[test]
+ fn error_in_comment_two_dashes_not_at_end() {
+ let (mut lex, mut buf) = make_lex_and_buf("--x");
+ lex.st = super::State::InsideComment;
+ assert_err!(for lex and buf expect row 0; 0,
+ "Unexpected token '--' before 'x'"
+ );
+
+ let (mut lex, mut buf) = make_lex_and_buf("--x");
+ assert_oks!(for lex and buf ;
+ Token::Character('-')
+ Token::Character('-')
+ Token::Character('x')
+ );
+ }
+
+ macro_rules! check_case(
+ ($chunk:expr, $app:expr; $data:expr; $r:expr, $c:expr, $s:expr) => ({
+ let (mut lex, mut buf) = make_lex_and_buf($data);
+ assert_err!(for lex and buf expect row $r ; $c, $s);
+
+ let (mut lex, mut buf) = make_lex_and_buf($data);
+ lex.disable_errors();
+ for c in $chunk.chars() {
+ assert_eq!(Ok(Some(Token::Character(c))), lex.next_token(&mut buf));
+ }
+ assert_oks!(for lex and buf ;
+ Token::Character($app)
+ );
+ assert_none!(for lex and buf);
+ })
+ );
+
+ #[test]
+ fn token_size() {
+ assert_eq!(4, std::mem::size_of::<Token>());
+ assert_eq!(2, std::mem::size_of::<super::State>());
+ }
+
+ #[test]
+ fn error_in_cdata_started() {
+ check_case!("<![", '['; "<![[" ; 0, 0, "Unexpected token '<![' before '['");
+ check_case!("<![C", '['; "<![C[" ; 0, 0, "Unexpected token '<![C' before '['");
+ check_case!("<![CD", '['; "<![CD[" ; 0, 0, "Unexpected token '<![CD' before '['");
+ check_case!("<![CDA", '['; "<![CDA[" ; 0, 0, "Unexpected token '<![CDA' before '['");
+ check_case!("<![CDAT", '['; "<![CDAT[" ; 0, 0, "Unexpected token '<![CDAT' before '['");
+ check_case!("<![CDATA", '|'; "<![CDATA|" ; 0, 0, "Unexpected token '<![CDATA' before '|'");
+ }
+
+ #[test]
+ fn error_in_doctype_started() {
+ check_case!("<!D", 'a'; "<!Da" ; 0, 0, "Unexpected token '<!D' before 'a'");
+ check_case!("<!DO", 'b'; "<!DOb" ; 0, 0, "Unexpected token '<!DO' before 'b'");
+ check_case!("<!DOC", 'c'; "<!DOCc" ; 0, 0, "Unexpected token '<!DOC' before 'c'");
+ check_case!("<!DOCT", 'd'; "<!DOCTd" ; 0, 0, "Unexpected token '<!DOCT' before 'd'");
+ check_case!("<!DOCTY", 'e'; "<!DOCTYe" ; 0, 0, "Unexpected token '<!DOCTY' before 'e'");
+ check_case!("<!DOCTYP", 'f'; "<!DOCTYPf" ; 0, 0, "Unexpected token '<!DOCTYP' before 'f'");
+ }
+
+
+
+ #[test]
+ fn issue_98_cdata_ending_with_right_bracket() {
+ let (mut lex, mut buf) = make_lex_and_buf(
+ r#"<![CDATA[Foo [Bar]]]>"#
+ );
+
+ assert_oks!(for lex and buf ;
+ Token::CDataStart
+ Token::Character('F')
+ Token::Character('o')
+ Token::Character('o')
+ Token::Character(' ')
+ Token::Character('[')
+ Token::Character('B')
+ Token::Character('a')
+ Token::Character('r')
+ Token::Character(']')
+ Token::CDataEnd
+ );
+ assert_none!(for lex and buf);
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser.rs b/crates/xml-rs/src/reader/parser.rs
new file mode 100644
index 0000000..18f073d
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser.rs
@@ -0,0 +1,799 @@
+//! Contains an implementation of pull-based XML parser.
+
+use crate::common::{is_xml10_char, is_xml11_char, is_xml11_char_not_restricted, is_name_char, is_name_start_char, is_whitespace_char};
+use crate::common::{Position, TextPosition, XmlVersion};
+use crate::name::OwnedName;
+use crate::namespace::NamespaceStack;
+use crate::reader::config::ParserConfig2;
+use crate::reader::error::SyntaxError;
+use crate::reader::events::XmlEvent;
+use crate::reader::indexset::AttributesSet;
+use crate::reader::lexer::{Lexer, Token};
+use super::{Error, ErrorKind};
+
+use std::collections::HashMap;
+use std::io::Read;
+
+macro_rules! gen_takes(
+ ($($field:ident -> $method:ident, $t:ty, $def:expr);+) => (
+ $(
+ impl MarkupData {
+ #[inline]
+ #[allow(clippy::mem_replace_option_with_none)]
+ fn $method(&mut self) -> $t {
+ std::mem::replace(&mut self.$field, $def)
+ }
+ }
+ )+
+ )
+);
+
+gen_takes!(
+ name -> take_name, String, String::new();
+ ref_data -> take_ref_data, String, String::new();
+
+ encoding -> take_encoding, Option<String>, None;
+
+ element_name -> take_element_name, Option<OwnedName>, None;
+
+ attr_name -> take_attr_name, Option<OwnedName>, None;
+ attributes -> take_attributes, AttributesSet, AttributesSet::new()
+);
+
+mod inside_cdata;
+mod inside_closing_tag_name;
+mod inside_comment;
+mod inside_declaration;
+mod inside_doctype;
+mod inside_opening_tag;
+mod inside_processing_instruction;
+mod inside_reference;
+mod outside_tag;
+
+static DEFAULT_VERSION: XmlVersion = XmlVersion::Version10;
+static DEFAULT_STANDALONE: Option<bool> = None;
+
+type ElementStack = Vec<OwnedName>;
+pub type Result = super::Result<XmlEvent>;
+
+/// Pull-based XML parser.
+pub(crate) struct PullParser {
+ config: ParserConfig2,
+ lexer: Lexer,
+ st: State,
+ state_after_reference: State,
+ buf: String,
+
+ /// From DTD internal subset
+ entities: HashMap<String, String>,
+
+ nst: NamespaceStack,
+
+ data: MarkupData,
+ final_result: Option<Result>,
+ next_event: Option<Result>,
+ est: ElementStack,
+ pos: Vec<TextPosition>,
+
+ encountered: Encountered,
+ inside_whitespace: bool,
+ read_prefix_separator: bool,
+ pop_namespace: bool,
+}
+
+// Keeps track when XML declaration can happen
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
+enum Encountered {
+ None = 0,
+ AnyChars, // whitespace before <?xml is not allowed
+ Declaration,
+ Comment,
+ Doctype,
+ Element,
+}
+
+impl PullParser {
+ /// Returns a new parser using the given config.
+ #[inline]
+ pub fn new(config: impl Into<ParserConfig2>) -> PullParser {
+ let config = config.into();
+ Self::new_with_config2(config)
+ }
+
+ #[inline]
+ fn new_with_config2(config: ParserConfig2) -> PullParser {
+ let mut lexer = Lexer::new(&config);
+ if let Some(enc) = config.override_encoding {
+ lexer.set_encoding(enc);
+ }
+
+ let mut pos = Vec::with_capacity(16);
+ pos.push(TextPosition::new());
+
+ PullParser {
+ config,
+ lexer,
+ st: State::DocumentStart,
+ state_after_reference: State::OutsideTag,
+ buf: String::new(),
+ entities: HashMap::new(),
+ nst: NamespaceStack::default(),
+
+ data: MarkupData {
+ name: String::new(),
+ version: None,
+ encoding: None,
+ standalone: None,
+ ref_data: String::new(),
+ element_name: None,
+ quote: None,
+ attr_name: None,
+ attributes: AttributesSet::new(),
+ },
+ final_result: None,
+ next_event: None,
+ est: Vec::new(),
+ pos,
+
+ encountered: Encountered::None,
+ inside_whitespace: true,
+ read_prefix_separator: false,
+ pop_namespace: false,
+ }
+ }
+
+ /// Checks if this parser ignores the end of stream errors.
+ pub fn is_ignoring_end_of_stream(&self) -> bool { self.config.c.ignore_end_of_stream }
+
+ #[inline(never)]
+ fn set_encountered(&mut self, new_encounter: Encountered) -> Option<Result> {
+ if new_encounter <= self.encountered {
+ return None;
+ }
+ let prev_enc = self.encountered;
+ self.encountered = new_encounter;
+
+ // If declaration was not parsed and we have encountered an element,
+ // emit this declaration as the next event.
+ if prev_enc == Encountered::None {
+ self.push_pos();
+ Some(Ok(XmlEvent::StartDocument {
+ version: DEFAULT_VERSION,
+ encoding: self.lexer.encoding().to_string(),
+ standalone: DEFAULT_STANDALONE,
+ }))
+ } else {
+ None
+ }
+ }
+}
+
+impl Position for PullParser {
+ /// Returns the position of the last event produced by the parser
+ #[inline]
+ fn position(&self) -> TextPosition {
+ self.pos[0]
+ }
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum State {
+ OutsideTag,
+ InsideOpeningTag(OpeningTagSubstate),
+ InsideClosingTag(ClosingTagSubstate),
+ InsideProcessingInstruction(ProcessingInstructionSubstate),
+ InsideComment,
+ InsideCData,
+ InsideDeclaration(DeclarationSubstate),
+ InsideDoctype(DoctypeSubstate),
+ InsideReference,
+ DocumentStart,
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum DoctypeSubstate {
+ Outside,
+ String,
+ InsideName,
+ BeforeEntityName,
+ EntityName,
+ BeforeEntityValue,
+ EntityValue,
+ NumericReferenceStart,
+ NumericReference,
+ /// expansion
+ PEReferenceInValue,
+ PEReferenceInDtd,
+ /// name definition
+ PEReferenceDefinitionStart,
+ PEReferenceDefinition,
+ SkipDeclaration,
+ Comment,
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum OpeningTagSubstate {
+ InsideName,
+
+ InsideTag,
+
+ InsideAttributeName,
+ AfterAttributeName,
+
+ InsideAttributeValue,
+ AfterAttributeValue,
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum ClosingTagSubstate {
+ CTInsideName,
+ CTAfterName,
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum ProcessingInstructionSubstate {
+ PIInsideName,
+ PIInsideData,
+}
+
+#[derive(Copy, Clone, PartialEq)]
+pub enum DeclarationSubstate {
+ BeforeVersion,
+ InsideVersion,
+ AfterVersion,
+
+ InsideVersionValue,
+ AfterVersionValue,
+
+ BeforeEncoding,
+ InsideEncoding,
+ AfterEncoding,
+
+ InsideEncodingValue,
+ AfterEncodingValue,
+
+ BeforeStandaloneDecl,
+ InsideStandaloneDecl,
+ AfterStandaloneDecl,
+
+ InsideStandaloneDeclValue,
+ AfterStandaloneDeclValue,
+}
+
+#[derive(PartialEq)]
+enum QualifiedNameTarget {
+ AttributeNameTarget,
+ OpeningTagNameTarget,
+ ClosingTagNameTarget,
+}
+
+#[derive(Copy, Clone, PartialEq, Eq)]
+enum QuoteToken {
+ SingleQuoteToken,
+ DoubleQuoteToken,
+}
+
+impl QuoteToken {
+ fn from_token(t: &Token) -> QuoteToken {
+ match *t {
+ Token::SingleQuote => QuoteToken::SingleQuoteToken,
+ Token::DoubleQuote => QuoteToken::DoubleQuoteToken,
+ _ => panic!("Unexpected token: {t}"),
+ }
+ }
+
+ fn as_token(self) -> Token {
+ match self {
+ QuoteToken::SingleQuoteToken => Token::SingleQuote,
+ QuoteToken::DoubleQuoteToken => Token::DoubleQuote,
+ }
+ }
+}
+
+struct MarkupData {
+ name: String, // used for processing instruction name
+ ref_data: String, // used for reference content
+
+ version: Option<XmlVersion>, // used for XML declaration version
+ encoding: Option<String>, // used for XML declaration encoding
+ standalone: Option<bool>, // used for XML declaration standalone parameter
+
+ element_name: Option<OwnedName>, // used for element name
+
+ quote: Option<QuoteToken>, // used to hold opening quote for attribute value
+ attr_name: Option<OwnedName>, // used to hold attribute name
+ attributes: AttributesSet, // used to hold all accumulated attributes
+}
+
+impl PullParser {
+ /// Returns next event read from the given buffer.
+ ///
+ /// This method should be always called with the same buffer. If you call it
+ /// providing different buffers each time, the result will be undefined.
+ pub fn next<R: Read>(&mut self, r: &mut R) -> Result {
+ if let Some(ref ev) = self.final_result {
+ return ev.clone();
+ }
+
+ if let Some(ev) = self.next_event.take() {
+ return ev;
+ }
+
+ if self.pop_namespace {
+ self.pop_namespace = false;
+ self.nst.pop();
+ }
+
+ loop {
+ debug_assert!(self.next_event.is_none());
+ debug_assert!(!self.pop_namespace);
+
+ // While lexer gives us Ok(maybe_token) -- we loop.
+ // Upon having a complete XML-event -- we return from the whole function.
+ match self.lexer.next_token(r) {
+ Ok(Some(token)) => {
+ match self.dispatch_token(token) {
+ None => {} // continue
+ Some(Ok(xml_event)) => {
+ self.next_pos();
+ return Ok(xml_event)
+ },
+ Some(Err(xml_error)) => {
+ self.next_pos();
+ return self.set_final_result(Err(xml_error))
+ },
+ }
+ },
+ Ok(None) => break,
+ Err(lexer_error) => {
+ return self.set_final_result(Err(lexer_error))
+ },
+ }
+ }
+
+ self.handle_eof()
+ }
+
+ /// Handle end of stream
+ fn handle_eof(&mut self) -> std::result::Result<XmlEvent, super::Error> {
+ // Forward pos to the lexer head
+ self.next_pos();
+ let ev = if self.depth() == 0 {
+ if self.encountered == Encountered::Element && self.st == State::OutsideTag { // all is ok
+ Ok(XmlEvent::EndDocument)
+ } else if self.encountered < Encountered::Element {
+ self.error(SyntaxError::NoRootElement)
+ } else { // self.st != State::OutsideTag
+ self.error(SyntaxError::UnexpectedEof) // TODO: add expected hint?
+ }
+ } else if self.config.c.ignore_end_of_stream {
+ self.final_result = None;
+ self.lexer.reset_eof_handled();
+ return self.error(SyntaxError::UnbalancedRootElement);
+ } else {
+ self.error(SyntaxError::UnbalancedRootElement)
+ };
+ self.set_final_result(ev)
+ }
+
+ // This function is to be called when a terminal event is reached.
+ // The function sets up the `self.final_result` into `Some(result)` and return `result`.
+ #[inline]
+ fn set_final_result(&mut self, result: Result) -> Result {
+ self.final_result = Some(result.clone());
+ result
+ }
+
+ #[cold]
+ fn error(&self, e: SyntaxError) -> Result {
+ Err(Error {
+ pos: self.lexer.position(),
+ kind: ErrorKind::Syntax(e.to_cow()),
+ })
+ }
+
+ #[inline]
+ fn next_pos(&mut self) {
+ // unfortunately calls to next_pos will never be perfectly balanced with push_pos,
+ // at very least because parse errors and EOF can happen unexpectedly without a prior push.
+ if !self.pos.is_empty() {
+ if self.pos.len() > 1 {
+ self.pos.remove(0);
+ } else {
+ self.pos[0] = self.lexer.position();
+ }
+ }
+ }
+
+ #[inline]
+ #[track_caller]
+ fn push_pos(&mut self) {
+ debug_assert!(self.pos.len() != self.pos.capacity(), "You've found a bug in xml-rs, caused by calls to push_pos() in states that don't end up emitting events.
+ This case is ignored in release mode, and merely causes document positions to be out of sync.
+ Please file a bug and include the XML document that triggers this assert.");
+
+ // it has capacity preallocated for more than it ever needs, so this reduces code size
+ if self.pos.len() != self.pos.capacity() {
+ self.pos.push(self.lexer.position());
+ } else if self.pos.len() > 1 {
+ self.pos.remove(0); // this mitigates the excessive push_pos() call
+ }
+ }
+
+ #[inline(never)]
+ fn dispatch_token(&mut self, t: Token) -> Option<Result> {
+ match self.st {
+ State::OutsideTag => self.outside_tag(t),
+ State::InsideOpeningTag(s) => self.inside_opening_tag(t, s),
+ State::InsideClosingTag(s) => self.inside_closing_tag_name(t, s),
+ State::InsideReference => self.inside_reference(t),
+ State::InsideComment => self.inside_comment(t),
+ State::InsideCData => self.inside_cdata(t),
+ State::InsideProcessingInstruction(s) => self.inside_processing_instruction(t, s),
+ State::InsideDoctype(s) => self.inside_doctype(t, s),
+ State::InsideDeclaration(s) => self.inside_declaration(t, s),
+ State::DocumentStart => self.document_start(t),
+ }
+ }
+
+ #[inline]
+ fn depth(&self) -> usize {
+ self.est.len()
+ }
+
+ #[inline]
+ fn buf_has_data(&self) -> bool {
+ !self.buf.is_empty()
+ }
+
+ #[inline]
+ fn take_buf(&mut self) -> String {
+ std::mem::take(&mut self.buf)
+ }
+
+ #[inline]
+ fn into_state(&mut self, st: State, ev: Option<Result>) -> Option<Result> {
+ self.st = st;
+ ev
+ }
+
+ #[inline]
+ fn into_state_continue(&mut self, st: State) -> Option<Result> {
+ self.into_state(st, None)
+ }
+
+ #[inline]
+ fn into_state_emit(&mut self, st: State, ev: Result) -> Option<Result> {
+ self.into_state(st, Some(ev))
+ }
+
+ /// Dispatches tokens in order to process qualified name. If qualified name cannot be parsed,
+ /// an error is returned.
+ ///
+ /// # Parameters
+ /// * `t` --- next token;
+ /// * `on_name` --- a callback which is executed when whitespace is encountered.
+ fn read_qualified_name<F>(&mut self, t: Token, target: QualifiedNameTarget, on_name: F) -> Option<Result>
+ where F: Fn(&mut PullParser, Token, OwnedName) -> Option<Result> {
+ // We can get here for the first time only when self.data.name contains zero or one character,
+ // but first character cannot be a colon anyway
+ if self.buf.len() <= 1 {
+ self.read_prefix_separator = false;
+ }
+
+ let invoke_callback = move |this: &mut PullParser, t| {
+ let name = this.take_buf();
+ match name.parse() {
+ Ok(name) => on_name(this, t, name),
+ Err(_) => Some(this.error(SyntaxError::InvalidQualifiedName(name.into()))),
+ }
+ };
+
+ match t {
+ // There can be only one colon, and not as the first character
+ Token::Character(':') if self.buf_has_data() && !self.read_prefix_separator => {
+ self.buf.push(':');
+ self.read_prefix_separator = true;
+ None
+ }
+
+ Token::Character(c) if c != ':' && (self.buf.is_empty() && is_name_start_char(c) ||
+ self.buf_has_data() && is_name_char(c)) => {
+ if self.buf.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.buf.push(c);
+ None
+ },
+
+ Token::EqualsSign if target == QualifiedNameTarget::AttributeNameTarget => invoke_callback(self, t),
+
+ Token::EmptyTagEnd if target == QualifiedNameTarget::OpeningTagNameTarget => invoke_callback(self, t),
+
+ Token::TagEnd if target == QualifiedNameTarget::OpeningTagNameTarget ||
+ target == QualifiedNameTarget::ClosingTagNameTarget => invoke_callback(self, t),
+
+ Token::Character(c) if is_whitespace_char(c) => invoke_callback(self, t),
+
+ _ => Some(self.error(SyntaxError::UnexpectedQualifiedName(t))),
+ }
+ }
+
+ /// Dispatches tokens in order to process attribute value.
+ ///
+ /// # Parameters
+ /// * `t` --- next token;
+ /// * `on_value` --- a callback which is called when terminating quote is encountered.
+ fn read_attribute_value<F>(&mut self, t: Token, on_value: F) -> Option<Result>
+ where F: Fn(&mut PullParser, String) -> Option<Result> {
+ match t {
+ Token::Character(c) if self.data.quote.is_none() && is_whitespace_char(c) => None, // skip leading whitespace
+
+ Token::DoubleQuote | Token::SingleQuote => match self.data.quote {
+ None => { // Entered attribute value
+ self.data.quote = Some(QuoteToken::from_token(&t));
+ None
+ }
+ Some(q) if q.as_token() == t => {
+ self.data.quote = None;
+ let value = self.take_buf();
+ on_value(self, value)
+ }
+ _ => {
+ if let Token::Character(c) = t {
+ if !self.is_valid_xml_char_not_restricted(c) {
+ return Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)));
+ }
+ }
+ if self.buf.len() > self.config.max_attribute_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ t.push_to_string(&mut self.buf);
+ None
+ }
+ },
+
+ Token::ReferenceStart if self.data.quote.is_some() => {
+ self.state_after_reference = self.st;
+ self.into_state_continue(State::InsideReference)
+ },
+
+ Token::OpeningTagStart => Some(self.error(SyntaxError::UnexpectedOpeningTag)),
+
+ Token::Character(c) if !self.is_valid_xml_char_not_restricted(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+
+ // Every character except " and ' and < is okay
+ _ if self.data.quote.is_some() => {
+ if self.buf.len() > self.config.max_attribute_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ t.push_to_string(&mut self.buf);
+ None
+ }
+
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ }
+ }
+
+ fn emit_start_element(&mut self, emit_end_element: bool) -> Option<Result> {
+ let mut name = self.data.take_element_name()?;
+ let mut attributes = self.data.take_attributes().into_vec();
+
+ // check whether the name prefix is bound and fix its namespace
+ match self.nst.get(name.borrow().prefix_repr()) {
+ Some("") => name.namespace = None, // default namespace
+ Some(ns) => name.namespace = Some(ns.into()),
+ None => return Some(self.error(SyntaxError::UnboundElementPrefix(name.to_string().into())))
+ }
+
+ // check and fix accumulated attributes prefixes
+ for attr in &mut attributes {
+ if let Some(ref pfx) = attr.name.prefix {
+ let new_ns = match self.nst.get(pfx) {
+ Some("") => None, // default namespace
+ Some(ns) => Some(ns.into()),
+ None => return Some(self.error(SyntaxError::UnboundAttribute(attr.name.to_string().into())))
+ };
+ attr.name.namespace = new_ns;
+ }
+ }
+
+ if emit_end_element {
+ self.pop_namespace = true;
+ self.next_event = Some(Ok(XmlEvent::EndElement {
+ name: name.clone()
+ }));
+ } else {
+ self.est.push(name.clone());
+ }
+ let namespace = self.nst.squash();
+ self.into_state_emit(State::OutsideTag, Ok(XmlEvent::StartElement {
+ name,
+ attributes,
+ namespace
+ }))
+ }
+
+ fn emit_end_element(&mut self) -> Option<Result> {
+ let mut name = self.data.take_element_name()?;
+
+ // check whether the name prefix is bound and fix its namespace
+ match self.nst.get(name.borrow().prefix_repr()) {
+ Some("") => name.namespace = None, // default namespace
+ Some(ns) => name.namespace = Some(ns.into()),
+ None => return Some(self.error(SyntaxError::UnboundElementPrefix(name.to_string().into())))
+ }
+
+ let op_name = self.est.pop()?;
+
+ if name == op_name {
+ self.pop_namespace = true;
+ self.into_state_emit(State::OutsideTag, Ok(XmlEvent::EndElement { name }))
+ } else {
+ Some(self.error(SyntaxError::UnexpectedClosingTag(format!("{name} != {op_name}").into())))
+ }
+ }
+
+ #[inline]
+ fn is_valid_xml_char(&self, c: char) -> bool {
+ if Some(XmlVersion::Version11) == self.data.version {
+ is_xml11_char(c)
+ } else {
+ is_xml10_char(c)
+ }
+ }
+
+ #[inline]
+ fn is_valid_xml_char_not_restricted(&self, c: char) -> bool {
+ if Some(XmlVersion::Version11) == self.data.version {
+ is_xml11_char_not_restricted(c)
+ } else {
+ is_xml10_char(c)
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use std::io::BufReader;
+ use crate::attribute::OwnedAttribute;
+ use crate::common::TextPosition;
+ use crate::name::OwnedName;
+ use crate::reader::events::XmlEvent;
+ use crate::reader::parser::PullParser;
+ use crate::reader::ParserConfig;
+
+ fn new_parser() -> PullParser {
+ PullParser::new(ParserConfig::new())
+ }
+
+ macro_rules! expect_event(
+ ($r:expr, $p:expr, $t:pat) => (
+ match $p.next(&mut $r) {
+ $t => {}
+ e => panic!("Unexpected event: {e:?}\nExpected: {}", stringify!($t))
+ }
+ );
+ ($r:expr, $p:expr, $t:pat => $c:expr ) => (
+ match $p.next(&mut $r) {
+ $t if $c => {}
+ e => panic!("Unexpected event: {e:?}\nExpected: {} if {}", stringify!($t), stringify!($c))
+ }
+ )
+ );
+
+ macro_rules! test_data(
+ ($d:expr) => ({
+ static DATA: &'static str = $d;
+ let r = BufReader::new(DATA.as_bytes());
+ let p = new_parser();
+ (r, p)
+ })
+ );
+
+ #[test]
+ fn issue_3_semicolon_in_attribute_value() {
+ let (mut r, mut p) = test_data!(r#"
+ <a attr="zzz;zzz" />
+ "#);
+
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { ref name, ref attributes, ref namespace }) =>
+ *name == OwnedName::local("a") &&
+ attributes.len() == 1 &&
+ attributes[0] == OwnedAttribute::new(OwnedName::local("attr"), "zzz;zzz") &&
+ namespace.is_essentially_empty()
+ );
+ expect_event!(r, p, Ok(XmlEvent::EndElement { ref name }) => *name == OwnedName::local("a"));
+ expect_event!(r, p, Ok(XmlEvent::EndDocument));
+ }
+
+ #[test]
+ fn issue_140_entity_reference_inside_tag() {
+ let (mut r, mut p) = test_data!(r#"
+ <bla>♫</bla>
+ "#);
+
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { ref name, .. }) => *name == OwnedName::local("bla"));
+ expect_event!(r, p, Ok(XmlEvent::Characters(ref s)) => s == "\u{266b}");
+ expect_event!(r, p, Ok(XmlEvent::EndElement { ref name, .. }) => *name == OwnedName::local("bla"));
+ expect_event!(r, p, Ok(XmlEvent::EndDocument));
+ }
+
+ #[test]
+ fn issue_220_comment() {
+ let (mut r, mut p) = test_data!(r#"<x><!-- <!--></x>"#);
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { .. }));
+ expect_event!(r, p, Ok(XmlEvent::EndElement { .. }));
+ expect_event!(r, p, Ok(XmlEvent::EndDocument));
+
+ let (mut r, mut p) = test_data!(r#"<x><!-- <!---></x>"#);
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { .. }));
+ expect_event!(r, p, Err(_)); // ---> is forbidden in comments
+
+ let (mut r, mut p) = test_data!(r#"<x><!--<text&x;> <!--></x>"#);
+ p.config.c.ignore_comments = false;
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { .. }));
+ expect_event!(r, p, Ok(XmlEvent::Comment(s)) => s == "<text&x;> <!");
+ expect_event!(r, p, Ok(XmlEvent::EndElement { .. }));
+ expect_event!(r, p, Ok(XmlEvent::EndDocument));
+ }
+
+ #[test]
+ fn malformed_declaration_attrs() {
+ let (mut r, mut p) = test_data!(r#"<?xml version x="1.0"?>"#);
+ expect_event!(r, p, Err(_));
+
+ let (mut r, mut p) = test_data!(r#"<?xml version="1.0" version="1.0"?>"#);
+ expect_event!(r, p, Err(_));
+
+ let (mut r, mut p) = test_data!(r#"<?xml version="1.0"encoding="utf-8"?>"#);
+ expect_event!(r, p, Err(_));
+
+ let (mut r, mut p) = test_data!(r#"<?xml version="1.0"standalone="yes"?>"#);
+ expect_event!(r, p, Err(_));
+
+ let (mut r, mut p) = test_data!(r#"<?xml version="1.0" encoding="utf-8"standalone="yes"?>"#);
+ expect_event!(r, p, Err(_));
+ }
+
+ #[test]
+ fn opening_tag_in_attribute_value() {
+ use crate::reader::error::{SyntaxError, Error, ErrorKind};
+
+ let (mut r, mut p) = test_data!(r#"
+ <a attr="zzz<zzz" />
+ "#);
+
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Err(ref e) =>
+ *e == Error {
+ kind: ErrorKind::Syntax(SyntaxError::UnexpectedOpeningTag.to_cow()),
+ pos: TextPosition { row: 1, column: 24 }
+ }
+ );
+ }
+
+ #[test]
+ fn reference_err() {
+ let (mut r, mut p) = test_data!(r#"
+ <a>&&</a>
+ "#);
+
+ expect_event!(r, p, Ok(XmlEvent::StartDocument { .. }));
+ expect_event!(r, p, Ok(XmlEvent::StartElement { .. }));
+ expect_event!(r, p, Err(_));
+ }
+
+ #[test]
+ fn state_size() {
+ assert_eq!(2, std::mem::size_of::<super::State>());
+ assert_eq!(1, std::mem::size_of::<super::DoctypeSubstate>());
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_cdata.rs b/crates/xml-rs/src/reader/parser/inside_cdata.rs
new file mode 100644
index 0000000..f0ca0c8
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_cdata.rs
@@ -0,0 +1,38 @@
+use crate::reader::error::SyntaxError;
+use crate::reader::lexer::Token;
+use crate::{common::is_whitespace_char, reader::events::XmlEvent};
+
+use super::{PullParser, Result, State};
+
+impl PullParser {
+ pub fn inside_cdata(&mut self, t: Token) -> Option<Result> {
+ match t {
+ Token::CDataEnd => {
+ let event = if self.config.c.cdata_to_characters {
+ // start called push_pos, but there will be no event to pop it
+ if self.buf.is_empty() {
+ self.next_pos();
+ }
+ None
+ } else {
+ let data = self.take_buf();
+ Some(Ok(XmlEvent::CData(data)))
+ };
+ self.into_state(State::OutsideTag, event)
+ }
+
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+ Token::Character(c) => {
+ if !is_whitespace_char(c) {
+ self.inside_whitespace = false;
+ }
+ self.buf.push(c);
+ None
+ }
+
+ _ => unreachable!(),
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_closing_tag_name.rs b/crates/xml-rs/src/reader/parser/inside_closing_tag_name.rs
new file mode 100644
index 0000000..6d86808
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_closing_tag_name.rs
@@ -0,0 +1,31 @@
+use crate::reader::error::SyntaxError;
+use crate::{common::is_whitespace_char, namespace};
+use crate::reader::lexer::Token;
+use super::{ClosingTagSubstate, PullParser, QualifiedNameTarget, Result, State};
+
+impl PullParser {
+ pub fn inside_closing_tag_name(&mut self, t: Token, s: ClosingTagSubstate) -> Option<Result> {
+ match s {
+ ClosingTagSubstate::CTInsideName => self.read_qualified_name(t, QualifiedNameTarget::ClosingTagNameTarget, |this, token, name| {
+ match name.prefix_ref() {
+ Some(prefix) if prefix == namespace::NS_XML_PREFIX ||
+ prefix == namespace::NS_XMLNS_PREFIX =>
+ Some(this.error(SyntaxError::InvalidNamePrefix(prefix.into()))),
+ _ => {
+ this.data.element_name = Some(name.clone());
+ match token {
+ Token::TagEnd => this.emit_end_element(),
+ Token::Character(c) if is_whitespace_char(c) => this.into_state_continue(State::InsideClosingTag(ClosingTagSubstate::CTAfterName)),
+ _ => Some(this.error(SyntaxError::UnexpectedTokenInClosingTag(token)))
+ }
+ }
+ }
+ }),
+ ClosingTagSubstate::CTAfterName => match t {
+ Token::TagEnd => self.emit_end_element(),
+ Token::Character(c) if is_whitespace_char(c) => None, // Skip whitespace
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInClosingTag(t)))
+ }
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_comment.rs b/crates/xml-rs/src/reader/parser/inside_comment.rs
new file mode 100644
index 0000000..240ee20
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_comment.rs
@@ -0,0 +1,34 @@
+use crate::reader::error::SyntaxError;
+use crate::reader::events::XmlEvent;
+use crate::reader::lexer::Token;
+
+use super::{PullParser, Result, State};
+
+impl PullParser {
+ pub fn inside_comment(&mut self, t: Token) -> Option<Result> {
+ match t {
+ Token::CommentEnd if self.config.c.ignore_comments => {
+ self.into_state_continue(State::OutsideTag)
+ }
+
+ Token::CommentEnd => {
+ let data = self.take_buf();
+ self.into_state_emit(State::OutsideTag, Ok(XmlEvent::Comment(data)))
+ }
+
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+
+ _ if self.config.c.ignore_comments => None, // Do not modify buffer if ignoring the comment
+
+ _ => {
+ if self.buf.len() > self.config.max_data_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ t.push_to_string(&mut self.buf);
+ None
+ }
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_declaration.rs b/crates/xml-rs/src/reader/parser/inside_declaration.rs
new file mode 100644
index 0000000..4ff1427
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_declaration.rs
@@ -0,0 +1,180 @@
+use crate::common::{is_whitespace_char, XmlVersion};
+use crate::reader::error::SyntaxError;
+use crate::reader::events::XmlEvent;
+use crate::reader::lexer::Token;
+use crate::util::Encoding;
+
+use super::{
+ DeclarationSubstate, Encountered, PullParser, QualifiedNameTarget, Result, State,
+ DEFAULT_VERSION,
+};
+
+impl PullParser {
+ #[inline(never)]
+ fn emit_start_document(&mut self) -> Option<Result> {
+ debug_assert!(self.encountered == Encountered::None);
+ self.encountered = Encountered::Declaration;
+
+ let version = self.data.version;
+ let encoding = self.data.take_encoding();
+ let standalone = self.data.standalone;
+
+ if let Some(new_encoding) = encoding.as_deref() {
+ let new_encoding = match new_encoding.parse() {
+ Ok(e) => e,
+ Err(_) if self.config.ignore_invalid_encoding_declarations => Encoding::Latin1,
+ Err(_) => return Some(self.error(SyntaxError::UnsupportedEncoding(new_encoding.into()))),
+ };
+ let current_encoding = self.lexer.encoding();
+ if current_encoding != new_encoding {
+ let set = match (current_encoding, new_encoding) {
+ (Encoding::Unknown | Encoding::Default, new) if new != Encoding::Utf16 => new,
+ (Encoding::Utf16Be | Encoding::Utf16Le, Encoding::Utf16) => current_encoding,
+ _ if self.config.ignore_invalid_encoding_declarations => current_encoding,
+ _ => return Some(self.error(SyntaxError::ConflictingEncoding(new_encoding, current_encoding))),
+ };
+ self.lexer.set_encoding(set);
+ }
+ }
+
+ let current_encoding = self.lexer.encoding();
+ self.into_state_emit(State::OutsideTag, Ok(XmlEvent::StartDocument {
+ version: version.unwrap_or(DEFAULT_VERSION),
+ encoding: encoding.unwrap_or_else(move || current_encoding.to_string()),
+ standalone
+ }))
+ }
+
+ // TODO: remove redundancy via macros or extra methods
+ pub fn inside_declaration(&mut self, t: Token, s: DeclarationSubstate) -> Option<Result> {
+
+ match s {
+ DeclarationSubstate::BeforeVersion => match t {
+ Token::Character('v') => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideVersion)),
+ Token::Character(c) if is_whitespace_char(c) => None, // continue
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideVersion => self.read_qualified_name(t, QualifiedNameTarget::AttributeNameTarget, |this, token, name| {
+ match &*name.local_name {
+ "ersion" if name.namespace.is_none() =>
+ this.into_state_continue(State::InsideDeclaration(
+ if token == Token::EqualsSign {
+ DeclarationSubstate::InsideVersionValue
+ } else {
+ DeclarationSubstate::AfterVersion
+ }
+ )),
+ _ => Some(this.error(SyntaxError::UnexpectedNameInsideXml(name.to_string().into()))),
+ }
+ }),
+
+ DeclarationSubstate::AfterVersion => match t {
+ Token::EqualsSign => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideVersionValue)),
+ Token::Character(c) if is_whitespace_char(c) => None,
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideVersionValue => self.read_attribute_value(t, |this, value| {
+ this.data.version = match &*value {
+ "1.0" => Some(XmlVersion::Version10),
+ "1.1" => Some(XmlVersion::Version11),
+ _ => None
+ };
+ if this.data.version.is_some() {
+ this.into_state_continue(State::InsideDeclaration(DeclarationSubstate::AfterVersionValue))
+ } else {
+ Some(this.error(SyntaxError::UnexpectedXmlVersion(value.into())))
+ }
+ }),
+
+ DeclarationSubstate::AfterVersionValue => match t {
+ Token::Character(c) if is_whitespace_char(c) => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::BeforeEncoding)),
+ Token::ProcessingInstructionEnd => self.emit_start_document(),
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::BeforeEncoding => match t {
+ Token::Character('e') => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideEncoding)),
+ Token::Character('s') => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideStandaloneDecl)),
+ Token::ProcessingInstructionEnd => self.emit_start_document(),
+ Token::Character(c) if is_whitespace_char(c) => None, // skip whitespace
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideEncoding => self.read_qualified_name(t, QualifiedNameTarget::AttributeNameTarget, |this, token, name| {
+ match &*name.local_name {
+ "ncoding" if name.namespace.is_none() =>
+ this.into_state_continue(State::InsideDeclaration(
+ if token == Token::EqualsSign { DeclarationSubstate::InsideEncodingValue } else { DeclarationSubstate::AfterEncoding }
+ )),
+ _ => Some(this.error(SyntaxError::UnexpectedName(name.to_string().into())))
+ }
+ }),
+
+ DeclarationSubstate::AfterEncoding => match t {
+ Token::EqualsSign => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideEncodingValue)),
+ Token::Character(c) if is_whitespace_char(c) => None,
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideEncodingValue => self.read_attribute_value(t, |this, value| {
+ this.data.encoding = Some(value);
+ this.into_state_continue(State::InsideDeclaration(DeclarationSubstate::AfterEncodingValue))
+ }),
+
+ DeclarationSubstate::AfterEncodingValue => match t {
+ Token::Character(c) if is_whitespace_char(c) => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::BeforeStandaloneDecl)),
+ Token::ProcessingInstructionEnd => self.emit_start_document(),
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::BeforeStandaloneDecl => match t {
+ Token::Character('s') => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideStandaloneDecl)),
+ Token::ProcessingInstructionEnd => self.emit_start_document(),
+ Token::Character(c) if is_whitespace_char(c) => None, // skip whitespace
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideStandaloneDecl => self.read_qualified_name(t, QualifiedNameTarget::AttributeNameTarget, |this, token, name| {
+ match &*name.local_name {
+ "tandalone" if name.namespace.is_none() =>
+ this.into_state_continue(State::InsideDeclaration(
+ if token == Token::EqualsSign {
+ DeclarationSubstate::InsideStandaloneDeclValue
+ } else {
+ DeclarationSubstate::AfterStandaloneDecl
+ }
+ )),
+ _ => Some(this.error(SyntaxError::UnexpectedName(name.to_string().into()))),
+ }
+ }),
+
+ DeclarationSubstate::AfterStandaloneDecl => match t {
+ Token::EqualsSign => self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::InsideStandaloneDeclValue)),
+ Token::Character(c) if is_whitespace_char(c) => None,
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+
+ DeclarationSubstate::InsideStandaloneDeclValue => self.read_attribute_value(t, |this, value| {
+ let standalone = match &*value {
+ "yes" => Some(true),
+ "no" => Some(false),
+ _ => None
+ };
+ if standalone.is_some() {
+ this.data.standalone = standalone;
+ this.into_state_continue(State::InsideDeclaration(DeclarationSubstate::AfterStandaloneDeclValue))
+ } else {
+ Some(this.error(SyntaxError::InvalidStandaloneDeclaration(value.into())))
+ }
+ }),
+
+ DeclarationSubstate::AfterStandaloneDeclValue => match t {
+ Token::ProcessingInstructionEnd => self.emit_start_document(),
+ Token::Character(c) if is_whitespace_char(c) => None, // skip whitespace
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_doctype.rs b/crates/xml-rs/src/reader/parser/inside_doctype.rs
new file mode 100644
index 0000000..87595d6
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_doctype.rs
@@ -0,0 +1,244 @@
+use crate::reader::error::SyntaxError;
+use crate::common::{is_name_char, is_name_start_char, is_whitespace_char};
+use crate::reader::lexer::Token;
+
+use super::{DoctypeSubstate, PullParser, QuoteToken, Result, State};
+
+impl PullParser {
+ pub fn inside_doctype(&mut self, t: Token, substate: DoctypeSubstate) -> Option<Result> {
+ match substate {
+ DoctypeSubstate::Outside => match t {
+ Token::TagEnd => self.into_state_continue(State::OutsideTag),
+ Token::MarkupDeclarationStart => {
+ self.buf.clear();
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::InsideName))
+ },
+ Token::Character('%') => {
+ self.data.ref_data.clear();
+ self.data.ref_data.push('%');
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::PEReferenceInDtd))
+ },
+ Token::CommentStart => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::Comment))
+ },
+ Token::SingleQuote | Token::DoubleQuote => {
+ // just discard string literals
+ self.data.quote = Some(super::QuoteToken::from_token(&t));
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::String))
+ },
+ Token::CDataEnd | Token::CDataStart => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ // TODO: parse SYSTEM, and [
+ _ => None,
+ },
+ DoctypeSubstate::String => match t {
+ Token::SingleQuote if self.data.quote != Some(QuoteToken::SingleQuoteToken) => None,
+ Token::DoubleQuote if self.data.quote != Some(QuoteToken::DoubleQuoteToken) => None,
+ Token::SingleQuote | Token::DoubleQuote => {
+ self.data.quote = None;
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::Outside))
+ },
+ _ => None,
+ },
+ DoctypeSubstate::Comment => match t {
+ Token::CommentEnd => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::Outside))
+ },
+ _ => None,
+ },
+ DoctypeSubstate::InsideName => match t {
+ Token::Character(c @ 'A'..='Z') => {
+ self.buf.push(c);
+ None
+ },
+ Token::Character(c) if is_whitespace_char(c) => {
+ let buf = self.take_buf();
+ match buf.as_str() {
+ "ENTITY" => self.into_state_continue(State::InsideDoctype(DoctypeSubstate::BeforeEntityName)),
+ "NOTATION" | "ELEMENT" | "ATTLIST" => self.into_state_continue(State::InsideDoctype(DoctypeSubstate::SkipDeclaration)),
+ _ => Some(self.error(SyntaxError::UnknownMarkupDeclaration(buf.into()))),
+ }
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ },
+ DoctypeSubstate::BeforeEntityName => {
+ self.data.name.clear();
+ match t {
+ Token::Character(c) if is_whitespace_char(c) => None,
+ Token::Character('%') => { // % is for PEDecl
+ self.data.name.push('%');
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::PEReferenceDefinitionStart))
+ },
+ Token::Character(c) if is_name_start_char(c) => {
+ if self.data.name.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.data.name.push(c);
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::EntityName))
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ }
+ },
+ DoctypeSubstate::EntityName => match t {
+ Token::Character(c) if is_whitespace_char(c) => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::BeforeEntityValue))
+ },
+ Token::Character(c) if is_name_char(c) => {
+ if self.data.name.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.data.name.push(c);
+ None
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::BeforeEntityValue => {
+ self.buf.clear();
+ match t {
+ Token::Character(c) if is_whitespace_char(c) => None,
+ // SYSTEM/PUBLIC not supported
+ Token::Character('S' | 'P') => {
+ let name = self.data.take_name();
+ self.entities.entry(name).or_insert_with(String::new); // Dummy value, but at least the name is recognized
+
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::SkipDeclaration))
+ },
+ Token::SingleQuote | Token::DoubleQuote => {
+ self.data.quote = Some(super::QuoteToken::from_token(&t));
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::EntityValue))
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ }
+ },
+ DoctypeSubstate::EntityValue => match t {
+ Token::SingleQuote if self.data.quote != Some(QuoteToken::SingleQuoteToken) => { self.buf.push('\''); None },
+ Token::DoubleQuote if self.data.quote != Some(QuoteToken::DoubleQuoteToken) => { self.buf.push('"'); None },
+ Token::SingleQuote | Token::DoubleQuote => {
+ self.data.quote = None;
+ let name = self.data.take_name();
+ let val = self.take_buf();
+ self.entities.entry(name).or_insert(val); // First wins
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::SkipDeclaration)) // FIXME
+ },
+ Token::ReferenceStart | Token::Character('&') => {
+ self.data.ref_data.clear();
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::NumericReferenceStart))
+ },
+ Token::Character('%') => {
+ self.data.ref_data.clear();
+ self.data.ref_data.push('%'); // include literal % in the name to distinguish from regular entities
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::PEReferenceInValue))
+ },
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+ Token::Character(c) => {
+ self.buf.push(c);
+ None
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::PEReferenceDefinitionStart => match t {
+ Token::Character(c) if is_whitespace_char(c) => {
+ None
+ },
+ Token::Character(c) if is_name_start_char(c) => {
+ debug_assert_eq!(self.data.name, "%");
+ self.data.name.push(c);
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::PEReferenceDefinition))
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::PEReferenceDefinition => match t {
+ Token::Character(c) if is_name_char(c) => {
+ if self.data.name.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.data.name.push(c);
+ None
+ },
+ Token::Character(c) if is_whitespace_char(c) => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::BeforeEntityValue))
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::PEReferenceInDtd => match t {
+ Token::Character(c) if is_name_char(c) => {
+ self.data.ref_data.push(c);
+ None
+ },
+ Token::ReferenceEnd | Token::Character(';') => {
+ let name = self.data.take_ref_data();
+ match self.entities.get(&name) {
+ Some(ent) => {
+ if let Err(e) = self.lexer.reparse(ent) {
+ return Some(Err(e));
+ }
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::Outside))
+ },
+ None => Some(self.error(SyntaxError::UndefinedEntity(name.into()))),
+ }
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::PEReferenceInValue => match t {
+ Token::Character(c) if is_name_char(c) => {
+ self.data.ref_data.push(c);
+ None
+ },
+ Token::ReferenceEnd | Token::Character(';') => {
+ let name = self.data.take_ref_data();
+ match self.entities.get(&name) {
+ Some(ent) => {
+ self.buf.push_str(ent);
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::EntityValue))
+ },
+ None => Some(self.error(SyntaxError::UndefinedEntity(name.into()))),
+ }
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::NumericReferenceStart => match t {
+ Token::Character('#') => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::NumericReference))
+ },
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+ Token::Character(c) => {
+ self.buf.push('&');
+ self.buf.push(c);
+ // named entities are not expanded inside doctype
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::EntityValue))
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::NumericReference => match t {
+ Token::ReferenceEnd | Token::Character(';') => {
+ let r = self.data.take_ref_data();
+ // https://www.w3.org/TR/xml/#sec-entexpand
+ match self.numeric_reference_from_str(&r) {
+ Ok(c) => {
+ self.buf.push(c);
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::EntityValue))
+ }
+ Err(e) => Some(self.error(e)),
+ }
+ },
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+ Token::Character(c) => {
+ self.data.ref_data.push(c);
+ None
+ },
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ },
+ DoctypeSubstate::SkipDeclaration => match t {
+ Token::TagEnd => {
+ self.into_state_continue(State::InsideDoctype(DoctypeSubstate::Outside))
+ },
+ _ => None,
+ },
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_opening_tag.rs b/crates/xml-rs/src/reader/parser/inside_opening_tag.rs
new file mode 100644
index 0000000..fb6d001
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_opening_tag.rs
@@ -0,0 +1,120 @@
+use crate::reader::error::SyntaxError;
+use crate::common::is_name_start_char;
+use crate::namespace;
+use crate::{attribute::OwnedAttribute, common::is_whitespace_char};
+
+use crate::reader::lexer::Token;
+
+use super::{OpeningTagSubstate, PullParser, QualifiedNameTarget, Result, State};
+
+impl PullParser {
+ pub fn inside_opening_tag(&mut self, t: Token, s: OpeningTagSubstate) -> Option<Result> {
+ let max_attrs = self.config.max_attributes;
+ match s {
+ OpeningTagSubstate::InsideName => self.read_qualified_name(t, QualifiedNameTarget::OpeningTagNameTarget, |this, token, name| {
+ match name.prefix_ref() {
+ Some(prefix) if prefix == namespace::NS_XML_PREFIX ||
+ prefix == namespace::NS_XMLNS_PREFIX =>
+ Some(this.error(SyntaxError::InvalidNamePrefix(prefix.into()))),
+ _ => {
+ this.data.element_name = Some(name.clone());
+ match token {
+ Token::TagEnd => this.emit_start_element(false),
+ Token::EmptyTagEnd => this.emit_start_element(true),
+ Token::Character(c) if is_whitespace_char(c) => this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::InsideTag)),
+ _ => unreachable!()
+ }
+ }
+ }
+ }),
+
+ OpeningTagSubstate::InsideTag => match t {
+ Token::TagEnd => self.emit_start_element(false),
+ Token::EmptyTagEnd => self.emit_start_element(true),
+ Token::Character(c) if is_whitespace_char(c) => None, // skip whitespace
+ Token::Character(c) if is_name_start_char(c) => {
+ if self.buf.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.buf.push(c);
+ self.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::InsideAttributeName))
+ }
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInOpeningTag(t))),
+ },
+
+ OpeningTagSubstate::InsideAttributeName => self.read_qualified_name(t, QualifiedNameTarget::AttributeNameTarget, |this, token, name| {
+ // check that no attribute with such name is already present
+ // if there is one, XML is not well-formed
+ if this.data.attributes.contains(&name) {
+ return Some(this.error(SyntaxError::RedefinedAttribute(name.to_string().into())))
+ }
+
+ this.data.attr_name = Some(name);
+ match token {
+ Token::EqualsSign => this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::InsideAttributeValue)),
+ Token::Character(c) if is_whitespace_char(c) => this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::AfterAttributeName)),
+ _ => Some(this.error(SyntaxError::UnexpectedTokenInOpeningTag(t))) // likely unreachable
+ }
+ }),
+
+ OpeningTagSubstate::AfterAttributeName => match t {
+ Token::EqualsSign => self.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::InsideAttributeValue)),
+ Token::Character(c) if is_whitespace_char(c) => None,
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInOpeningTag(t)))
+ },
+
+ OpeningTagSubstate::InsideAttributeValue => self.read_attribute_value(t, |this, value| {
+ let name = this.data.take_attr_name()?; // will always succeed here
+ match name.prefix_ref() {
+ // declaring a new prefix; it is sufficient to check prefix only
+ // because "xmlns" prefix is reserved
+ Some(namespace::NS_XMLNS_PREFIX) => {
+ let ln = &*name.local_name;
+ if ln == namespace::NS_XMLNS_PREFIX {
+ Some(this.error(SyntaxError::CannotRedefineXmlnsPrefix))
+ } else if ln == namespace::NS_XML_PREFIX && &*value != namespace::NS_XML_URI {
+ Some(this.error(SyntaxError::CannotRedefineXmlPrefix))
+ } else if value.is_empty() {
+ Some(this.error(SyntaxError::CannotUndefinePrefix(ln.into())))
+ } else {
+ this.nst.put(name.local_name.clone(), value);
+ this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::AfterAttributeValue))
+ }
+ }
+
+ // declaring default namespace
+ None if &*name.local_name == namespace::NS_XMLNS_PREFIX =>
+ match &*value {
+ namespace::NS_XMLNS_PREFIX | namespace::NS_XML_PREFIX | namespace::NS_XML_URI | namespace::NS_XMLNS_URI =>
+ Some(this.error(SyntaxError::InvalidDefaultNamespace(value.into()))),
+ _ => {
+ this.nst.put(namespace::NS_NO_PREFIX, value.clone());
+ this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::AfterAttributeValue))
+ }
+ },
+
+ // regular attribute
+ _ => {
+ if this.data.attributes.len() >= max_attrs {
+ return Some(this.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ this.data.attributes.push(OwnedAttribute {
+ name,
+ value
+ });
+ this.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::AfterAttributeValue))
+ }
+ }
+ }),
+
+ OpeningTagSubstate::AfterAttributeValue => match t {
+ Token::Character(c) if is_whitespace_char(c) => {
+ self.into_state_continue(State::InsideOpeningTag(OpeningTagSubstate::InsideTag))
+ },
+ Token::TagEnd => self.emit_start_element(false),
+ Token::EmptyTagEnd => self.emit_start_element(true),
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInOpeningTag(t))),
+ },
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_processing_instruction.rs b/crates/xml-rs/src/reader/parser/inside_processing_instruction.rs
new file mode 100644
index 0000000..99caf59
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_processing_instruction.rs
@@ -0,0 +1,116 @@
+use crate::reader::error::SyntaxError;
+use crate::common::{is_name_char, is_name_start_char, is_whitespace_char};
+
+use crate::reader::events::XmlEvent;
+use crate::reader::lexer::Token;
+
+use super::{DeclarationSubstate, ProcessingInstructionSubstate, PullParser, Result, State, Encountered};
+
+impl PullParser {
+ pub fn inside_processing_instruction(&mut self, t: Token, s: ProcessingInstructionSubstate) -> Option<Result> {
+ match s {
+ ProcessingInstructionSubstate::PIInsideName => match t {
+ Token::Character(c) if self.buf.is_empty() && is_name_start_char(c) ||
+ self.buf_has_data() && is_name_char(c) => {
+ if self.buf.len() > self.config.max_name_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.buf.push(c);
+ None
+ },
+
+ Token::ProcessingInstructionEnd => {
+ // self.buf contains PI name
+ let name = self.take_buf();
+
+ // Don't need to check for declaration because it has mandatory attributes
+ // but there is none
+ match &*name {
+ // Name is empty, it is an error
+ "" => Some(self.error(SyntaxError::ProcessingInstructionWithoutName)),
+
+ // Found <?xml-like PI not at the beginning of a document,
+ // it is an error - see section 2.6 of XML 1.1 spec
+ n if "xml".eq_ignore_ascii_case(n) =>
+ Some(self.error(SyntaxError::InvalidXmlProcessingInstruction(name.into()))),
+
+ // All is ok, emitting event
+ _ => {
+ debug_assert!(self.next_event.is_none(), "{:?}", self.next_event);
+ // can't have a PI before `<?xml`
+ let event1 = self.set_encountered(Encountered::Declaration);
+ let event2 = Some(Ok(XmlEvent::ProcessingInstruction {
+ name,
+ data: None
+ }));
+ // emitting two events at once is cumbersome
+ let event1 = if event1.is_some() {
+ self.next_event = event2;
+ event1
+ } else {
+ event2
+ };
+ self.into_state(State::OutsideTag, event1)
+ }
+ }
+ }
+
+ Token::Character(c) if is_whitespace_char(c) => {
+ // self.buf contains PI name
+ let name = self.take_buf();
+
+ match &*name {
+ // We have not ever encountered an element and have not parsed XML declaration
+ "xml" if self.encountered == Encountered::None =>
+ self.into_state_continue(State::InsideDeclaration(DeclarationSubstate::BeforeVersion)),
+
+ // Found <?xml-like PI after the beginning of a document,
+ // it is an error - see section 2.6 of XML 1.1 spec
+ n if "xml".eq_ignore_ascii_case(n) =>
+ Some(self.error(SyntaxError::InvalidXmlProcessingInstruction(name.into()))),
+
+ // All is ok, starting parsing PI data
+ _ => {
+ self.data.name = name;
+ // can't have a PI before `<?xml`
+ let next_event = self.set_encountered(Encountered::Declaration);
+ self.into_state(State::InsideProcessingInstruction(ProcessingInstructionSubstate::PIInsideData), next_event)
+ }
+ }
+ }
+
+ _ => {
+ let buf = self.take_buf();
+ Some(self.error(SyntaxError::UnexpectedProcessingInstruction(buf.into(), t)))
+ }
+ },
+
+ ProcessingInstructionSubstate::PIInsideData => match t {
+ Token::ProcessingInstructionEnd => {
+ let name = self.data.take_name();
+ let data = self.take_buf();
+ self.into_state_emit(
+ State::OutsideTag,
+ Ok(XmlEvent::ProcessingInstruction {
+ name,
+ data: Some(data),
+ }),
+ )
+ },
+
+ Token::Character(c) if !self.is_valid_xml_char(c) => {
+ Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)))
+ },
+
+ // Any other token should be treated as plain characters
+ _ => {
+ if self.buf.len() > self.config.max_data_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ t.push_to_string(&mut self.buf);
+ None
+ }
+ },
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/inside_reference.rs b/crates/xml-rs/src/reader/parser/inside_reference.rs
new file mode 100644
index 0000000..eced606
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/inside_reference.rs
@@ -0,0 +1,78 @@
+use crate::reader::error::SyntaxError;
+use std::char;
+use crate::common::{is_name_char, is_name_start_char, is_whitespace_char};
+use crate::reader::lexer::Token;
+use super::{PullParser, Result, State};
+
+impl PullParser {
+ pub fn inside_reference(&mut self, t: Token) -> Option<Result> {
+ match t {
+ Token::Character(c) if !self.data.ref_data.is_empty() && is_name_char(c) ||
+ self.data.ref_data.is_empty() && (is_name_start_char(c) || c == '#') => {
+ self.data.ref_data.push(c);
+ None
+ }
+
+ Token::ReferenceEnd => {
+ let name = self.data.take_ref_data();
+ if name.is_empty() {
+ return Some(self.error(SyntaxError::EmptyEntity));
+ }
+
+ let c = match &*name {
+ "lt" => Some('<'),
+ "gt" => Some('>'),
+ "amp" => Some('&'),
+ "apos" => Some('\''),
+ "quot" => Some('"'),
+ _ if name.starts_with('#') => match self.numeric_reference_from_str(&name[1..]) {
+ Ok(c) => Some(c),
+ Err(e) => return Some(self.error(e))
+ },
+ _ => None,
+ };
+ if let Some(c) = c {
+ self.buf.push(c);
+ } else if let Some(v) = self.config.c.extra_entities.get(&name) {
+ self.buf.push_str(v);
+ } else if let Some(v) = self.entities.get(&name) {
+ if self.state_after_reference == State::OutsideTag {
+ // an entity can expand to *elements*, so outside of a tag it needs a full reparse
+ if let Err(e) = self.lexer.reparse(v) {
+ return Some(Err(e));
+ }
+ } else {
+ // however, inside attributes it's not allowed to affect attribute quoting,
+ // so it can't be fed to the lexer
+ self.buf.push_str(v);
+ }
+ } else {
+ return Some(self.error(SyntaxError::UnexpectedEntity(name.into())));
+ }
+ let prev_st = self.state_after_reference;
+ if prev_st == State::OutsideTag && !is_whitespace_char(self.buf.chars().last().unwrap_or('\0')) {
+ self.inside_whitespace = false;
+ }
+ self.into_state_continue(prev_st)
+ }
+
+ _ => Some(self.error(SyntaxError::UnexpectedTokenInEntity(t))),
+ }
+ }
+
+ pub(crate) fn numeric_reference_from_str(&self, num_str: &str) -> std::result::Result<char, SyntaxError> {
+ let val = if let Some(hex) = num_str.strip_prefix('x') {
+ u32::from_str_radix(hex, 16).map_err(move |_| SyntaxError::InvalidNumericEntity(num_str.into()))?
+ } else {
+ u32::from_str_radix(num_str, 10).map_err(move |_| SyntaxError::InvalidNumericEntity(num_str.into()))?
+ };
+ match char::from_u32(val) {
+ Some(c) if self.is_valid_xml_char(c) => Ok(c),
+ Some(_) if self.config.c.replace_unknown_entity_references => Ok('\u{fffd}'),
+ None if self.config.c.replace_unknown_entity_references => {
+ Ok('\u{fffd}')
+ },
+ _ => Err(SyntaxError::InvalidCharacterEntity(val)),
+ }
+ }
+}
diff --git a/crates/xml-rs/src/reader/parser/outside_tag.rs b/crates/xml-rs/src/reader/parser/outside_tag.rs
new file mode 100644
index 0000000..e62f862
--- /dev/null
+++ b/crates/xml-rs/src/reader/parser/outside_tag.rs
@@ -0,0 +1,205 @@
+use crate::reader::error::SyntaxError;
+use crate::common::is_whitespace_char;
+use crate::reader::events::XmlEvent;
+use crate::reader::lexer::Token;
+
+use super::{
+ ClosingTagSubstate, DoctypeSubstate, Encountered, OpeningTagSubstate,
+ ProcessingInstructionSubstate, PullParser, Result, State,
+};
+
+impl PullParser {
+ pub fn outside_tag(&mut self, t: Token) -> Option<Result> {
+ match t {
+ Token::Character(c) => {
+ if is_whitespace_char(c) {
+ // skip whitespace outside of the root element
+ if (self.config.c.trim_whitespace && self.buf.is_empty()) ||
+ (self.depth() == 0 && self.config.c.ignore_root_level_whitespace) {
+ return None;
+ }
+ } else {
+ self.inside_whitespace = false;
+ if self.depth() == 0 {
+ return Some(self.error(SyntaxError::UnexpectedTokenOutsideRoot(t)));
+ }
+ }
+
+ if !self.is_valid_xml_char_not_restricted(c) {
+ return Some(self.error(SyntaxError::InvalidCharacterEntity(c as u32)));
+ }
+
+ if self.buf.is_empty() {
+ self.push_pos();
+ } else if self.buf.len() > self.config.max_data_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ self.buf.push(c);
+ None
+ },
+
+ Token::CommentEnd | Token::TagEnd | Token::EqualsSign |
+ Token::DoubleQuote | Token::SingleQuote |
+ Token::ProcessingInstructionEnd | Token::EmptyTagEnd => {
+ if self.depth() == 0 {
+ return Some(self.error(SyntaxError::UnexpectedTokenOutsideRoot(t)));
+ }
+ self.inside_whitespace = false;
+
+ if let Some(s) = t.as_static_str() {
+ if self.buf.is_empty() {
+ self.push_pos();
+ } else if self.buf.len() > self.config.max_data_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+
+ self.buf.push_str(s);
+ }
+ None
+ },
+
+ Token::ReferenceStart if self.depth() > 0 => {
+ self.state_after_reference = State::OutsideTag;
+ self.into_state_continue(State::InsideReference)
+ },
+
+ Token::ReferenceEnd if self.depth() > 0 => { // Semi-colon in a text outside an entity
+ self.inside_whitespace = false;
+ if self.buf.len() > self.config.max_data_length {
+ return Some(self.error(SyntaxError::ExceededConfiguredLimit));
+ }
+ Token::ReferenceEnd.push_to_string(&mut self.buf);
+ None
+ },
+
+ Token::CommentStart if self.config.c.coalesce_characters && self.config.c.ignore_comments => {
+ let next_event = self.set_encountered(Encountered::Comment);
+ // We need to switch the lexer into a comment mode inside comments
+ self.into_state(State::InsideComment, next_event)
+ }
+
+ Token::CDataStart if self.depth() > 0 && self.config.c.coalesce_characters && self.config.c.cdata_to_characters => {
+ if self.buf.is_empty() {
+ self.push_pos();
+ }
+ self.into_state_continue(State::InsideCData)
+ },
+
+ _ => {
+ // Encountered some markup event, flush the buffer as characters
+ // or a whitespace
+ let mut next_event = if self.buf_has_data() {
+ let buf = self.take_buf();
+ if self.inside_whitespace && self.config.c.trim_whitespace {
+ None
+ } else if self.inside_whitespace && !self.config.c.whitespace_to_characters {
+ debug_assert!(buf.chars().all(|ch| ch.is_whitespace()), "ws={buf:?}");
+ Some(Ok(XmlEvent::Whitespace(buf)))
+ } else if self.config.c.trim_whitespace {
+ Some(Ok(XmlEvent::Characters(buf.trim_matches(is_whitespace_char).into())))
+ } else {
+ Some(Ok(XmlEvent::Characters(buf)))
+ }
+ } else { None };
+ self.inside_whitespace = true; // Reset inside_whitespace flag
+
+ // pos is popped whenever an event is emitted, so pushes must happen only if there will be an event to balance it
+ // and ignored comments don't pop
+ if t != Token::CommentStart || !self.config.c.ignore_comments {
+ self.push_pos();
+ }
+ match t {
+ Token::OpeningTagStart if self.depth() > 0 || self.encountered < Encountered::Element || self.config.allow_multiple_root_elements => {
+ if let Some(e) = self.set_encountered(Encountered::Element) {
+ next_event = Some(e);
+ }
+ self.nst.push_empty();
+ self.into_state(State::InsideOpeningTag(OpeningTagSubstate::InsideName), next_event)
+ },
+
+ Token::ClosingTagStart if self.depth() > 0 =>
+ self.into_state(State::InsideClosingTag(ClosingTagSubstate::CTInsideName), next_event),
+
+ Token::CommentStart => {
+ if let Some(e) = self.set_encountered(Encountered::Comment) {
+ next_event = Some(e);
+ }
+ // We need to switch the lexer into a comment mode inside comments
+ self.into_state(State::InsideComment, next_event)
+ },
+
+ Token::DoctypeStart if self.encountered < Encountered::Doctype => {
+ if let Some(e) = self.set_encountered(Encountered::Doctype) {
+ next_event = Some(e);
+ }
+
+ // We don't have a doctype event so skip this position
+ // FIXME: update when we have a doctype event
+ self.next_pos();
+ self.into_state(State::InsideDoctype(DoctypeSubstate::Outside), next_event)
+ },
+
+ Token::ProcessingInstructionStart =>
+ self.into_state(State::InsideProcessingInstruction(ProcessingInstructionSubstate::PIInsideName), next_event),
+
+ Token::CDataStart if self.depth() > 0 => {
+ self.into_state(State::InsideCData, next_event)
+ },
+
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t)))
+ }
+ }
+ }
+ }
+
+ pub fn document_start(&mut self, t: Token) -> Option<Result> {
+ debug_assert!(self.encountered < Encountered::Declaration);
+
+ match t {
+ Token::Character(c) => {
+ let next_event = self.set_encountered(Encountered::AnyChars);
+
+ if !is_whitespace_char(c) {
+ return Some(self.error(SyntaxError::UnexpectedTokenOutsideRoot(t)));
+ }
+ self.inside_whitespace = true;
+
+ // skip whitespace outside of the root element
+ if (self.config.c.trim_whitespace && self.buf.is_empty()) ||
+ (self.depth() == 0 && self.config.c.ignore_root_level_whitespace) {
+ return self.into_state(State::OutsideTag, next_event);
+ }
+
+ self.push_pos();
+ self.buf.push(c);
+ self.into_state(State::OutsideTag, next_event)
+ },
+
+ Token::CommentStart => {
+ let next_event = self.set_encountered(Encountered::Comment);
+ self.into_state(State::InsideComment, next_event)
+ }
+
+ Token::OpeningTagStart => {
+ let next_event = self.set_encountered(Encountered::Element);
+ self.nst.push_empty();
+ self.into_state(State::InsideOpeningTag(OpeningTagSubstate::InsideName), next_event)
+ },
+
+ Token::DoctypeStart => {
+ let next_event = self.set_encountered(Encountered::Doctype);
+ // We don't have a doctype event so skip this position
+ // FIXME: update when we have a doctype event
+ self.next_pos();
+ self.into_state(State::InsideDoctype(DoctypeSubstate::Outside), next_event)
+ },
+
+ Token::ProcessingInstructionStart => {
+ self.push_pos();
+ self.into_state_continue(State::InsideProcessingInstruction(ProcessingInstructionSubstate::PIInsideName))
+ },
+
+ _ => Some(self.error(SyntaxError::UnexpectedToken(t))),
+ }
+ }
+}
diff --git a/crates/xml-rs/src/util.rs b/crates/xml-rs/src/util.rs
new file mode 100644
index 0000000..07d0336
--- /dev/null
+++ b/crates/xml-rs/src/util.rs
@@ -0,0 +1,305 @@
+use std::fmt;
+use std::io::{self, Read};
+use std::str::{self, FromStr};
+
+#[derive(Debug)]
+pub enum CharReadError {
+ UnexpectedEof,
+ Utf8(str::Utf8Error),
+ Io(io::Error),
+}
+
+impl From<str::Utf8Error> for CharReadError {
+ #[cold]
+ fn from(e: str::Utf8Error) -> CharReadError {
+ CharReadError::Utf8(e)
+ }
+}
+
+impl From<io::Error> for CharReadError {
+ #[cold]
+ fn from(e: io::Error) -> CharReadError {
+ CharReadError::Io(e)
+ }
+}
+
+impl fmt::Display for CharReadError {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ use self::CharReadError::{Io, UnexpectedEof, Utf8};
+ match *self {
+ UnexpectedEof => write!(f, "unexpected end of stream"),
+ Utf8(ref e) => write!(f, "UTF-8 decoding error: {e}"),
+ Io(ref e) => write!(f, "I/O error: {e}"),
+ }
+ }
+}
+
+/// Character encoding used for parsing
+#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[non_exhaustive]
+pub enum Encoding {
+ /// Explicitly UTF-8 only
+ Utf8,
+ /// UTF-8 fallback, but can be any 8-bit encoding
+ Default,
+ /// ISO-8859-1
+ Latin1,
+ /// US-ASCII
+ Ascii,
+ /// Big-Endian
+ Utf16Be,
+ /// Little-Endian
+ Utf16Le,
+ /// Unknown endianness yet, will be sniffed
+ Utf16,
+ /// Not determined yet, may be sniffed to be anything
+ Unknown,
+}
+
+// Rustc inlines eq_ignore_ascii_case and creates kilobytes of code!
+#[inline(never)]
+fn icmp(lower: &str, varcase: &str) -> bool {
+ lower.bytes().zip(varcase.bytes()).all(|(l, v)| l == v.to_ascii_lowercase())
+}
+
+impl FromStr for Encoding {
+ type Err = &'static str;
+
+ fn from_str(val: &str) -> Result<Self, Self::Err> {
+ if ["utf-8", "utf8"].into_iter().any(move |label| icmp(label, val)) {
+ Ok(Encoding::Utf8)
+ } else if ["iso-8859-1", "latin1"].into_iter().any(move |label| icmp(label, val)) {
+ Ok(Encoding::Latin1)
+ } else if ["utf-16", "utf16"].into_iter().any(move |label| icmp(label, val)) {
+ Ok(Encoding::Utf16)
+ } else if ["ascii", "us-ascii"].into_iter().any(move |label| icmp(label, val)) {
+ Ok(Encoding::Ascii)
+ } else {
+ Err("unknown encoding name")
+ }
+ }
+}
+
+impl fmt::Display for Encoding {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str(match self {
+ Encoding::Utf8 => "UTF-8",
+ Encoding::Default => "UTF-8",
+ Encoding::Latin1 => "ISO-8859-1",
+ Encoding::Ascii => "US-ASCII",
+ Encoding::Utf16Be => "UTF-16",
+ Encoding::Utf16Le => "UTF-16",
+ Encoding::Utf16 => "UTF-16",
+ Encoding::Unknown => "(unknown)",
+ })
+ }
+}
+
+pub(crate) struct CharReader {
+ pub encoding: Encoding,
+}
+
+impl CharReader {
+ pub fn new() -> Self {
+ Self {
+ encoding: Encoding::Unknown,
+ }
+ }
+
+ pub fn next_char_from<R: Read>(&mut self, source: &mut R) -> Result<Option<char>, CharReadError> {
+ let mut bytes = source.bytes();
+ const MAX_CODEPOINT_LEN: usize = 4;
+
+ let mut buf = [0u8; MAX_CODEPOINT_LEN];
+ let mut pos = 0;
+ loop {
+ let next = match bytes.next() {
+ Some(Ok(b)) => b,
+ Some(Err(e)) => return Err(e.into()),
+ None if pos == 0 => return Ok(None),
+ None => return Err(CharReadError::UnexpectedEof),
+ };
+
+ match self.encoding {
+ Encoding::Utf8 | Encoding::Default => {
+ // fast path for ASCII subset
+ if pos == 0 && next.is_ascii() {
+ return Ok(Some(next.into()));
+ }
+
+ buf[pos] = next;
+ pos += 1;
+
+ match str::from_utf8(&buf[..pos]) {
+ Ok(s) => return Ok(s.chars().next()), // always Some(..)
+ Err(_) if pos < MAX_CODEPOINT_LEN => continue,
+ Err(e) => return Err(e.into()),
+ }
+ },
+ Encoding::Latin1 => {
+ return Ok(Some(next.into()));
+ },
+ Encoding::Ascii => {
+ if next.is_ascii() {
+ return Ok(Some(next.into()));
+ } else {
+ return Err(CharReadError::Io(io::Error::new(io::ErrorKind::InvalidData, "char is not ASCII")));
+ }
+ },
+ Encoding::Unknown | Encoding::Utf16 => {
+ buf[pos] = next;
+ pos += 1;
+
+ // sniff BOM
+ if pos <= 3 && buf[..pos] == [0xEF, 0xBB, 0xBF][..pos] {
+ if pos == 3 && self.encoding != Encoding::Utf16 {
+ pos = 0;
+ self.encoding = Encoding::Utf8;
+ }
+ } else if pos <= 2 && buf[..pos] == [0xFE, 0xFF][..pos] {
+ if pos == 2 {
+ pos = 0;
+ self.encoding = Encoding::Utf16Be;
+ }
+ } else if pos <= 2 && buf[..pos] == [0xFF, 0xFE][..pos] {
+ if pos == 2 {
+ pos = 0;
+ self.encoding = Encoding::Utf16Le;
+ }
+ } else if pos == 1 && self.encoding == Encoding::Utf16 {
+ // sniff ASCII char in UTF-16
+ self.encoding = if next == 0 { Encoding::Utf16Be } else { Encoding::Utf16Le };
+ } else {
+ // UTF-8 is the default, but XML decl can change it to other 8-bit encoding
+ self.encoding = Encoding::Default;
+ if pos == 1 && next.is_ascii() {
+ return Ok(Some(next.into()));
+ }
+ }
+ },
+ Encoding::Utf16Be => {
+ buf[pos] = next;
+ pos += 1;
+ if pos == 2 {
+ if let Some(Ok(c)) = char::decode_utf16([u16::from_be_bytes(buf[..2].try_into().unwrap())]).next() {
+ return Ok(Some(c));
+ }
+ } else if pos == 4 { // surrogate
+ return char::decode_utf16([u16::from_be_bytes(buf[..2].try_into().unwrap()), u16::from_be_bytes(buf[2..4].try_into().unwrap())])
+ .next().transpose()
+ .map_err(|e| CharReadError::Io(io::Error::new(io::ErrorKind::InvalidData, e)));
+ }
+ },
+ Encoding::Utf16Le => {
+ buf[pos] = next;
+ pos += 1;
+ if pos == 2 {
+ if let Some(Ok(c)) = char::decode_utf16([u16::from_le_bytes(buf[..2].try_into().unwrap())]).next() {
+ return Ok(Some(c));
+ }
+ } else if pos == 4 { // surrogate
+ return char::decode_utf16([u16::from_le_bytes(buf[..2].try_into().unwrap()), u16::from_le_bytes(buf[2..4].try_into().unwrap())])
+ .next().transpose()
+ .map_err(|e| CharReadError::Io(io::Error::new(io::ErrorKind::InvalidData, e)));
+ }
+ },
+ }
+ }
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ use super::{CharReadError, CharReader, Encoding};
+
+ #[test]
+ fn test_next_char_from() {
+ use std::io;
+
+ let mut bytes: &[u8] = "correct".as_bytes(); // correct ASCII
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('c'));
+
+ let mut bytes: &[u8] = b"\xEF\xBB\xBF\xE2\x80\xA2!"; // BOM
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('•'));
+
+ let mut bytes: &[u8] = b"\xEF\xBB\xBFx123"; // BOM
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('x'));
+
+ let mut bytes: &[u8] = b"\xEF\xBB\xBF"; // Nothing after BOM
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), None);
+
+ let mut bytes: &[u8] = b"\xEF\xBB"; // Nothing after BO
+ assert!(matches!(CharReader::new().next_char_from(&mut bytes), Err(CharReadError::UnexpectedEof)));
+
+ let mut bytes: &[u8] = b"\xEF\xBB\x42"; // Nothing after BO
+ assert!(matches!(CharReader::new().next_char_from(&mut bytes), Err(_)));
+
+ let mut bytes: &[u8] = b"\xFE\xFF\x00\x42"; // UTF-16
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('B'));
+
+ let mut bytes: &[u8] = b"\xFF\xFE\x42\x00"; // UTF-16
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('B'));
+
+ let mut bytes: &[u8] = b"\xFF\xFE"; // UTF-16
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), None);
+
+ let mut bytes: &[u8] = b"\xFF\xFE\x00"; // UTF-16
+ assert!(matches!(CharReader::new().next_char_from(&mut bytes), Err(CharReadError::UnexpectedEof)));
+
+ let mut bytes: &[u8] = "правильно".as_bytes(); // correct BMP
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('п'));
+
+ let mut bytes: &[u8] = "правильно".as_bytes();
+ assert_eq!(CharReader { encoding: Encoding::Utf16Be }.next_char_from(&mut bytes).unwrap(), Some('킿'));
+
+ let mut bytes: &[u8] = "правильно".as_bytes();
+ assert_eq!(CharReader { encoding: Encoding::Utf16Le }.next_char_from(&mut bytes).unwrap(), Some('뿐'));
+
+ let mut bytes: &[u8] = b"\xD8\xD8\x80";
+ assert!(matches!(CharReader { encoding: Encoding::Utf16 }.next_char_from(&mut bytes), Err(_)));
+
+ let mut bytes: &[u8] = b"\x00\x42";
+ assert_eq!(CharReader { encoding: Encoding::Utf16 }.next_char_from(&mut bytes).unwrap(), Some('B'));
+
+ let mut bytes: &[u8] = b"\x42\x00";
+ assert_eq!(CharReader { encoding: Encoding::Utf16 }.next_char_from(&mut bytes).unwrap(), Some('B'));
+
+ let mut bytes: &[u8] = b"\x00";
+ assert!(matches!(CharReader { encoding: Encoding::Utf16Be }.next_char_from(&mut bytes), Err(_)));
+
+ let mut bytes: &[u8] = "😊".as_bytes(); // correct non-BMP
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), Some('😊'));
+
+ let mut bytes: &[u8] = b""; // empty
+ assert_eq!(CharReader::new().next_char_from(&mut bytes).unwrap(), None);
+
+ let mut bytes: &[u8] = b"\xf0\x9f\x98"; // incomplete code point
+ match CharReader::new().next_char_from(&mut bytes).unwrap_err() {
+ super::CharReadError::UnexpectedEof => {},
+ e => panic!("Unexpected result: {e:?}")
+ };
+
+ let mut bytes: &[u8] = b"\xff\x9f\x98\x32"; // invalid code point
+ match CharReader::new().next_char_from(&mut bytes).unwrap_err() {
+ super::CharReadError::Utf8(_) => {},
+ e => panic!("Unexpected result: {e:?}")
+ };
+
+ // error during read
+ struct ErrorReader;
+ impl io::Read for ErrorReader {
+ fn read(&mut self, _: &mut [u8]) -> io::Result<usize> {
+ Err(io::Error::new(io::ErrorKind::Other, "test error"))
+ }
+ }
+
+ let mut r = ErrorReader;
+ match CharReader::new().next_char_from(&mut r).unwrap_err() {
+ super::CharReadError::Io(ref e) if e.kind() == io::ErrorKind::Other &&
+ e.to_string().contains("test error") => {},
+ e => panic!("Unexpected result: {e:?}")
+ }
+ }
+}
diff --git a/crates/xml-rs/src/writer.rs b/crates/xml-rs/src/writer.rs
new file mode 100644
index 0000000..e2b70ec
--- /dev/null
+++ b/crates/xml-rs/src/writer.rs
@@ -0,0 +1,90 @@
+//! Contains high-level interface for an events-based XML emitter.
+//!
+//! The most important type in this module is `EventWriter` which allows writing an XML document
+//! to some output stream.
+
+pub use self::config::EmitterConfig;
+pub use self::emitter::EmitterError as Error;
+pub use self::emitter::Result;
+pub use self::events::XmlEvent;
+
+use self::emitter::Emitter;
+
+use std::io::prelude::*;
+
+mod config;
+mod emitter;
+pub mod events;
+
+/// A wrapper around an `std::io::Write` instance which emits XML document according to provided
+/// events.
+pub struct EventWriter<W> {
+ sink: W,
+ emitter: Emitter,
+}
+
+impl<W: Write> EventWriter<W> {
+ /// Creates a new `EventWriter` out of an `std::io::Write` instance using the default
+ /// configuration.
+ #[inline]
+ pub fn new(sink: W) -> EventWriter<W> {
+ EventWriter::new_with_config(sink, EmitterConfig::new())
+ }
+
+ /// Creates a new `EventWriter` out of an `std::io::Write` instance using the provided
+ /// configuration.
+ #[inline]
+ pub fn new_with_config(sink: W, config: EmitterConfig) -> EventWriter<W> {
+ EventWriter {
+ sink,
+ emitter: Emitter::new(config),
+ }
+ }
+
+ /// Writes the next piece of XML document according to the provided event.
+ ///
+ /// Note that output data may not exactly correspond to the written event because
+ /// of various configuration options. For example, `XmlEvent::EndElement` may
+ /// correspond to a separate closing element or it may cause writing an empty element.
+ /// Another example is that `XmlEvent::CData` may be represented as characters in
+ /// the output stream.
+ pub fn write<'a, E>(&mut self, event: E) -> Result<()> where E: Into<XmlEvent<'a>> {
+ match event.into() {
+ XmlEvent::StartDocument { version, encoding, standalone } =>
+ self.emitter.emit_start_document(&mut self.sink, version, encoding.unwrap_or("UTF-8"), standalone),
+ XmlEvent::ProcessingInstruction { name, data } =>
+ self.emitter.emit_processing_instruction(&mut self.sink, name, data),
+ XmlEvent::StartElement { name, attributes, namespace } => {
+ self.emitter.namespace_stack_mut().push_empty().checked_target().extend(namespace.as_ref());
+ self.emitter.emit_start_element(&mut self.sink, name, &attributes)
+ }
+ XmlEvent::EndElement { name } => {
+ let r = self.emitter.emit_end_element(&mut self.sink, name);
+ self.emitter.namespace_stack_mut().try_pop();
+ r
+ }
+ XmlEvent::Comment(content) => self.emitter.emit_comment(&mut self.sink, content),
+ XmlEvent::CData(content) => self.emitter.emit_cdata(&mut self.sink, content),
+ XmlEvent::Characters(content) => self.emitter.emit_characters(&mut self.sink, content),
+ }
+ }
+
+ /// Returns a mutable reference to the underlying `Writer`.
+ ///
+ /// Note that having a reference to the underlying sink makes it very easy to emit invalid XML
+ /// documents. Use this method with care. Valid use cases for this method include accessing
+ /// methods like `Write::flush`, which do not emit new data but rather change the state
+ /// of the stream itself.
+ pub fn inner_mut(&mut self) -> &mut W {
+ &mut self.sink
+ }
+
+ /// Unwraps this `EventWriter`, returning the underlying writer.
+ ///
+ /// Note that this is a destructive operation: unwrapping a writer and then wrapping
+ /// it again with `EventWriter::new()` will create a fresh writer whose state will be
+ /// blank; for example, accumulated namespaces will be reset.
+ pub fn into_inner(self) -> W {
+ self.sink
+ }
+}
diff --git a/crates/xml-rs/src/writer/config.rs b/crates/xml-rs/src/writer/config.rs
new file mode 100644
index 0000000..c7841bc
--- /dev/null
+++ b/crates/xml-rs/src/writer/config.rs
@@ -0,0 +1,157 @@
+//! Contains emitter configuration structure.
+
+use std::borrow::Cow;
+use std::io::Write;
+use crate::writer::EventWriter;
+
+/// Emitter configuration structure.
+///
+/// This structure contains various options which control XML document emitter behavior.
+#[derive(Clone, PartialEq, Eq, Debug)]
+pub struct EmitterConfig {
+ /// Line separator used to separate lines in formatted output. Default is `"\n"`.
+ pub line_separator: Cow<'static, str>,
+
+ /// A string which will be used for a single level of indentation. Default is `" "`
+ /// (two spaces).
+ pub indent_string: Cow<'static, str>,
+
+ /// Whether or not the emitted document should be indented. Default is false.
+ ///
+ /// The emitter is capable to perform automatic indentation of the emitted XML document.
+ /// It is done in stream-like fashion and does not require the knowledge of the whole
+ /// document in advance.
+ ///
+ /// Sometimes, however, automatic indentation is undesirable, e.g. when you want to keep
+ /// existing layout when processing an existing XML document. Also the indentiation algorithm
+ /// is not thoroughly tested. Hence by default it is disabled.
+ pub perform_indent: bool,
+
+ /// Whether or not characters in output events will be escaped. Default is true.
+ ///
+ /// The emitter can automatically escape characters which can't appear in PCDATA sections
+ /// or element attributes of an XML document, like `<` or `"` (in attributes). This may
+ /// introduce some overhead because then every corresponding piece of character data
+ /// should be scanned for invalid characters.
+ ///
+ /// If this option is disabled, the XML writer may produce non-well-formed documents, so
+ /// use `false` value for this option with care.
+ pub perform_escaping: bool,
+
+ /// Whether or not to write XML document declaration at the beginning of a document.
+ /// Default is true.
+ ///
+ /// This option controls whether the document declaration should be emitted automatically
+ /// before a root element is written if it was not emitted explicitly by the user.
+ pub write_document_declaration: bool,
+
+ /// Whether or not to convert elements with empty content to empty elements. Default is true.
+ ///
+ /// This option allows turning elements like `<a></a>` (an element with empty content)
+ /// into `<a />` (an empty element).
+ pub normalize_empty_elements: bool,
+
+ /// Whether or not to emit CDATA events as plain characters. Default is false.
+ ///
+ /// This option forces the emitter to convert CDATA events into regular character events,
+ /// performing all the necessary escaping beforehand. This may be occasionally useful
+ /// for feeding the document into incorrect parsers which do not support CDATA.
+ pub cdata_to_characters: bool,
+
+ /// Whether or not to keep element names to support `EndElement` events without explicit names.
+ /// Default is true.
+ ///
+ /// This option makes the emitter to keep names of written elements in order to allow
+ /// omitting names when writing closing element tags. This could incur some memory overhead.
+ pub keep_element_names_stack: bool,
+
+ /// Whether or not to automatically insert leading and trailing spaces in emitted comments,
+ /// if necessary. Default is true.
+ ///
+ /// This is a convenience option in order for the user not to append spaces before and after
+ /// comments text in order to get more pretty comments: `<!-- something -->` instead of
+ /// `<!--something-->`.
+ pub autopad_comments: bool,
+
+ /// Whether or not to automatically insert spaces before the trailing `/>` in self-closing
+ /// elements. Default is true.
+ ///
+ /// This option is only meaningful if `normalize_empty_elements` is true. For example, the
+ /// element `<a></a>` would be unaffected. When `normalize_empty_elements` is true, then when
+ /// this option is also true, the same element would appear `<a />`. If this option is false,
+ /// then the same element would appear `<a/>`.
+ pub pad_self_closing: bool,
+}
+
+impl EmitterConfig {
+ /// Creates an emitter configuration with default values.
+ ///
+ /// You can tweak default options with builder-like pattern:
+ ///
+ /// ```rust
+ /// use xml::writer::EmitterConfig;
+ ///
+ /// let config = EmitterConfig::new()
+ /// .line_separator("\r\n")
+ /// .perform_indent(true)
+ /// .normalize_empty_elements(false);
+ /// ```
+ #[inline]
+ #[must_use]
+ pub fn new() -> EmitterConfig {
+ EmitterConfig {
+ line_separator: "\n".into(),
+ indent_string: " ".into(), // two spaces
+ perform_indent: false,
+ perform_escaping: true,
+ write_document_declaration: true,
+ normalize_empty_elements: true,
+ cdata_to_characters: false,
+ keep_element_names_stack: true,
+ autopad_comments: true,
+ pad_self_closing: true,
+ }
+ }
+
+ /// Creates an XML writer with this configuration.
+ ///
+ /// This is a convenience method for configuring and creating a writer at the same time:
+ ///
+ /// ```rust
+ /// use xml::writer::EmitterConfig;
+ ///
+ /// let mut target: Vec<u8> = Vec::new();
+ ///
+ /// let writer = EmitterConfig::new()
+ /// .line_separator("\r\n")
+ /// .perform_indent(true)
+ /// .normalize_empty_elements(false)
+ /// .create_writer(&mut target);
+ /// ```
+ ///
+ /// This method is exactly equivalent to calling `EventWriter::new_with_config()` with
+ /// this configuration object.
+ #[inline]
+ pub fn create_writer<W: Write>(self, sink: W) -> EventWriter<W> {
+ EventWriter::new_with_config(sink, self)
+ }
+}
+
+impl Default for EmitterConfig {
+ #[inline]
+ fn default() -> EmitterConfig {
+ EmitterConfig::new()
+ }
+}
+
+gen_setters!(EmitterConfig,
+ line_separator: into Cow<'static, str>,
+ indent_string: into Cow<'static, str>,
+ perform_indent: val bool,
+ write_document_declaration: val bool,
+ normalize_empty_elements: val bool,
+ cdata_to_characters: val bool,
+ keep_element_names_stack: val bool,
+ autopad_comments: val bool,
+ pad_self_closing: val bool
+);
diff --git a/crates/xml-rs/src/writer/emitter.rs b/crates/xml-rs/src/writer/emitter.rs
new file mode 100644
index 0000000..431d48c
--- /dev/null
+++ b/crates/xml-rs/src/writer/emitter.rs
@@ -0,0 +1,437 @@
+use std::error::Error;
+use std::fmt;
+use std::io;
+use std::io::prelude::*;
+use std::result;
+
+use crate::attribute::Attribute;
+use crate::common;
+use crate::common::XmlVersion;
+use crate::escape::{AttributeEscapes, Escaped, PcDataEscapes};
+use crate::name::{Name, OwnedName};
+use crate::namespace::{NamespaceStack, NS_EMPTY_URI, NS_NO_PREFIX, NS_XMLNS_PREFIX, NS_XML_PREFIX};
+
+use crate::writer::config::EmitterConfig;
+
+/// An error which may be returned by `XmlWriter` when writing XML events.
+#[derive(Debug)]
+pub enum EmitterError {
+ /// An I/O error occured in the underlying `Write` instance.
+ Io(io::Error),
+
+ /// Document declaration has already been written to the output stream.
+ DocumentStartAlreadyEmitted,
+
+ /// The name of the last opening element is not available.
+ LastElementNameNotAvailable,
+
+ /// The name of the last opening element is not equal to the name of the provided
+ /// closing element.
+ EndElementNameIsNotEqualToLastStartElementName,
+
+ /// End element name is not specified when it is needed, for example, when automatic
+ /// closing is not enabled in configuration.
+ EndElementNameIsNotSpecified,
+}
+
+impl From<io::Error> for EmitterError {
+ #[cold]
+ fn from(err: io::Error) -> EmitterError {
+ EmitterError::Io(err)
+ }
+}
+
+impl fmt::Display for EmitterError {
+ #[cold]
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ f.write_str("emitter error: ")?;
+ match self {
+ EmitterError::Io(e) => write!(f, "I/O error: {e}"),
+ EmitterError::DocumentStartAlreadyEmitted => f.write_str("document start event has already been emitted"),
+ EmitterError::LastElementNameNotAvailable => f.write_str("last element name is not available"),
+ EmitterError::EndElementNameIsNotEqualToLastStartElementName => f.write_str("end element name is not equal to last start element name"),
+ EmitterError::EndElementNameIsNotSpecified => f.write_str("end element name is not specified and can't be inferred"),
+ }
+ }
+}
+
+impl Error for EmitterError {
+}
+
+/// A result type yielded by `XmlWriter`.
+pub type Result<T, E = EmitterError> = result::Result<T, E>;
+
+// TODO: split into a low-level fast writer without any checks and formatting logic and a
+// high-level indenting validating writer
+pub struct Emitter {
+ config: EmitterConfig,
+
+ nst: NamespaceStack,
+
+ indent_level: usize,
+ indent_stack: Vec<IndentFlags>,
+
+ element_names: Vec<OwnedName>,
+
+ start_document_emitted: bool,
+ just_wrote_start_element: bool,
+}
+
+impl Emitter {
+ pub fn new(config: EmitterConfig) -> Emitter {
+ let mut indent_stack = Vec::with_capacity(16);
+ indent_stack.push(IndentFlags::WroteNothing);
+
+ Emitter {
+ config,
+
+ nst: NamespaceStack::empty(),
+
+ indent_level: 0,
+ indent_stack,
+
+ element_names: Vec::new(),
+
+ start_document_emitted: false,
+ just_wrote_start_element: false,
+ }
+ }
+}
+
+#[derive(Copy, Clone, Eq, PartialEq, Debug)]
+enum IndentFlags {
+ WroteNothing,
+ WroteMarkup,
+ WroteText,
+}
+
+impl Emitter {
+ /// Returns the current state of namespaces.
+ #[inline]
+ pub fn namespace_stack_mut(&mut self) -> &mut NamespaceStack {
+ &mut self.nst
+ }
+
+ #[inline]
+ fn wrote_text(&self) -> bool {
+ self.indent_stack.last().map_or(false, |&e| e == IndentFlags::WroteText)
+ }
+
+ #[inline]
+ fn wrote_markup(&self) -> bool {
+ self.indent_stack.last().map_or(false, |&e| e == IndentFlags::WroteMarkup)
+ }
+
+ #[inline]
+ fn set_wrote_text(&mut self) {
+ if let Some(e) = self.indent_stack.last_mut() {
+ *e = IndentFlags::WroteText;
+ }
+ }
+
+ #[inline]
+ fn set_wrote_markup(&mut self) {
+ if let Some(e) = self.indent_stack.last_mut() {
+ *e = IndentFlags::WroteMarkup;
+ }
+ }
+
+ fn write_newline<W: Write>(&mut self, target: &mut W, level: usize) -> Result<()> {
+ target.write_all(self.config.line_separator.as_bytes())?;
+ for _ in 0..level {
+ target.write_all(self.config.indent_string.as_bytes())?;
+ }
+ Ok(())
+ }
+
+ fn before_markup<W: Write>(&mut self, target: &mut W) -> Result<()> {
+ if self.config.perform_indent && !self.wrote_text() &&
+ (self.indent_level > 0 || self.wrote_markup()) {
+ let indent_level = self.indent_level;
+ self.write_newline(target, indent_level)?;
+ if self.indent_level > 0 && self.config.indent_string.len() > 0 {
+ self.after_markup();
+ }
+ }
+ Ok(())
+ }
+
+ fn after_markup(&mut self) {
+ self.set_wrote_markup();
+ }
+
+ fn before_start_element<W: Write>(&mut self, target: &mut W) -> Result<()> {
+ self.before_markup(target)?;
+ self.indent_stack.push(IndentFlags::WroteNothing);
+ Ok(())
+ }
+
+ fn after_start_element(&mut self) {
+ self.after_markup();
+ self.indent_level += 1;
+ }
+
+ fn before_end_element<W: Write>(&mut self, target: &mut W) -> Result<()> {
+ if self.config.perform_indent && self.indent_level > 0 && self.wrote_markup() &&
+ !self.wrote_text() {
+ let indent_level = self.indent_level;
+ self.write_newline(target, indent_level - 1)
+ } else {
+ Ok(())
+ }
+ }
+
+ fn after_end_element(&mut self) {
+ if self.indent_level > 0 {
+ self.indent_level -= 1;
+ self.indent_stack.pop();
+ }
+ self.set_wrote_markup();
+ }
+
+ fn after_text(&mut self) {
+ self.set_wrote_text();
+ }
+
+ pub fn emit_start_document<W: Write>(&mut self, target: &mut W,
+ version: XmlVersion,
+ encoding: &str,
+ standalone: Option<bool>) -> Result<()> {
+ if self.start_document_emitted {
+ return Err(EmitterError::DocumentStartAlreadyEmitted);
+ }
+ self.start_document_emitted = true;
+
+ self.before_markup(target)?;
+ let result = {
+ let mut write = move || {
+ write!(target, "<?xml version=\"{version}\" encoding=\"{encoding}\"")?;
+
+ if let Some(standalone) = standalone {
+ write!(target, " standalone=\"{}\"", if standalone { "yes" } else { "no" })?;
+ }
+
+ write!(target, "?>")?;
+
+ Ok(())
+ };
+ write()
+ };
+ self.after_markup();
+
+ result
+ }
+
+ fn check_document_started<W: Write>(&mut self, target: &mut W) -> Result<()> {
+ if !self.start_document_emitted && self.config.write_document_declaration {
+ self.emit_start_document(target, common::XmlVersion::Version10, "utf-8", None)
+ } else {
+ Ok(())
+ }
+ }
+
+ fn fix_non_empty_element<W: Write>(&mut self, target: &mut W) -> Result<()> {
+ if self.config.normalize_empty_elements && self.just_wrote_start_element {
+ self.just_wrote_start_element = false;
+ target.write_all(b">").map_err(From::from)
+ } else {
+ Ok(())
+ }
+ }
+
+ pub fn emit_processing_instruction<W: Write>(&mut self,
+ target: &mut W,
+ name: &str,
+ data: Option<&str>) -> Result<()> {
+ self.check_document_started(target)?;
+ self.fix_non_empty_element(target)?;
+
+ self.before_markup(target)?;
+
+ let result = {
+ let mut write = move || {
+ write!(target, "<?{name}")?;
+
+ if let Some(data) = data {
+ write!(target, " {data}")?;
+ }
+
+ write!(target, "?>")?;
+
+ Ok(())
+ };
+ write()
+ };
+
+ self.after_markup();
+
+ result
+ }
+
+ fn emit_start_element_initial<W>(&mut self, target: &mut W,
+ name: Name<'_>,
+ attributes: &[Attribute<'_>]) -> Result<()>
+ where W: Write
+ {
+ self.check_document_started(target)?;
+ self.fix_non_empty_element(target)?;
+ self.before_start_element(target)?;
+ write!(target, "<{}", name.repr_display())?;
+ self.emit_current_namespace_attributes(target)?;
+ self.emit_attributes(target, attributes)?;
+ self.after_start_element();
+ Ok(())
+ }
+
+ pub fn emit_start_element<W>(&mut self, target: &mut W,
+ name: Name<'_>,
+ attributes: &[Attribute<'_>]) -> Result<()>
+ where W: Write
+ {
+ if self.config.keep_element_names_stack {
+ self.element_names.push(name.to_owned());
+ }
+
+ self.emit_start_element_initial(target, name, attributes)?;
+ self.just_wrote_start_element = true;
+
+ if !self.config.normalize_empty_elements {
+ write!(target, ">")?;
+ }
+
+ Ok(())
+ }
+
+ pub fn emit_current_namespace_attributes<W>(&mut self, target: &mut W) -> Result<()>
+ where W: Write
+ {
+ for (prefix, uri) in self.nst.peek() {
+ match prefix {
+ // internal namespaces are not emitted
+ NS_XMLNS_PREFIX | NS_XML_PREFIX => Ok(()),
+ //// there is already a namespace binding with this prefix in scope
+ //prefix if self.nst.get(prefix) == Some(uri) => Ok(()),
+ // emit xmlns only if it is overridden
+ NS_NO_PREFIX => if uri != NS_EMPTY_URI {
+ write!(target, " xmlns=\"{uri}\"")
+ } else { Ok(()) },
+ // everything else
+ prefix => write!(target, " xmlns:{prefix}=\"{uri}\"")
+ }?;
+ }
+ Ok(())
+ }
+
+ pub fn emit_attributes<W: Write>(&mut self, target: &mut W,
+ attributes: &[Attribute<'_>]) -> Result<()> {
+ for attr in attributes.iter() {
+ write!(target, " {}=\"", attr.name.repr_display())?;
+ if self.config.perform_escaping {
+ write!(target, "{}", Escaped::<AttributeEscapes>::new(attr.value))?;
+ } else {
+ write!(target, "{}", attr.value)?;
+ }
+ write!(target, "\"")?;
+ }
+ Ok(())
+ }
+
+ pub fn emit_end_element<W: Write>(&mut self, target: &mut W,
+ name: Option<Name<'_>>) -> Result<()> {
+ let owned_name = if self.config.keep_element_names_stack {
+ Some(self.element_names.pop().ok_or(EmitterError::LastElementNameNotAvailable)?)
+ } else {
+ None
+ };
+
+ // Check that last started element name equals to the provided name, if there are both
+ if let Some(ref last_name) = owned_name {
+ if let Some(ref name) = name {
+ if last_name.borrow() != *name {
+ return Err(EmitterError::EndElementNameIsNotEqualToLastStartElementName);
+ }
+ }
+ }
+
+ if let Some(name) = owned_name.as_ref().map(|n| n.borrow()).or(name) {
+ if self.config.normalize_empty_elements && self.just_wrote_start_element {
+ self.just_wrote_start_element = false;
+ let termination = if self.config.pad_self_closing { " />" } else { "/>" };
+ let result = target.write_all(termination.as_bytes()).map_err(From::from);
+ self.after_end_element();
+ result
+ } else {
+ self.just_wrote_start_element = false;
+
+ self.before_end_element(target)?;
+ let result = write!(target, "</{}>", name.repr_display()).map_err(From::from);
+ self.after_end_element();
+
+ result
+ }
+ } else {
+ Err(EmitterError::EndElementNameIsNotSpecified)
+ }
+ }
+
+ pub fn emit_cdata<W: Write>(&mut self, target: &mut W, content: &str) -> Result<()> {
+ self.fix_non_empty_element(target)?;
+ if self.config.cdata_to_characters {
+ self.emit_characters(target, content)
+ } else {
+ // TODO: escape ']]>' characters in CDATA as two adjacent CDATA blocks
+ target.write_all(b"<![CDATA[")?;
+ target.write_all(content.as_bytes())?;
+ target.write_all(b"]]>")?;
+
+ self.after_text();
+
+ Ok(())
+ }
+ }
+
+ pub fn emit_characters<W: Write>(&mut self, target: &mut W, content: &str) -> Result<()> {
+ self.check_document_started(target)?;
+ self.fix_non_empty_element(target)?;
+
+ if self.config.perform_escaping {
+ write!(target, "{}", Escaped::<PcDataEscapes>::new(content))?;
+ } else {
+ target.write_all(content.as_bytes())?;
+ }
+
+ self.after_text();
+ Ok(())
+ }
+
+ pub fn emit_comment<W: Write>(&mut self, target: &mut W, content: &str) -> Result<()> {
+ self.fix_non_empty_element(target)?;
+
+ // TODO: add escaping dashes at the end of the comment
+
+ let autopad_comments = self.config.autopad_comments;
+ let write = move |target: &mut W| -> Result<()> {
+ target.write_all(b"<!--")?;
+
+ if autopad_comments && !content.starts_with(char::is_whitespace) {
+ target.write_all(b" ")?;
+ }
+
+ target.write_all(content.as_bytes())?;
+
+ if autopad_comments && !content.ends_with(char::is_whitespace) {
+ target.write_all(b" ")?;
+ }
+
+ target.write_all(b"-->")?;
+
+ Ok(())
+ };
+
+ self.before_markup(target)?;
+ let result = write(target);
+ self.after_markup();
+
+ result
+ }
+}
diff --git a/crates/xml-rs/src/writer/events.rs b/crates/xml-rs/src/writer/events.rs
new file mode 100644
index 0000000..af9f37c
--- /dev/null
+++ b/crates/xml-rs/src/writer/events.rs
@@ -0,0 +1,256 @@
+//! Contains `XmlEvent` datatype, instances of which are consumed by the writer.
+
+use std::borrow::Cow;
+
+use crate::attribute::Attribute;
+use crate::common::XmlVersion;
+use crate::name::Name;
+use crate::namespace::{Namespace, NS_NO_PREFIX};
+
+/// A part of an XML output stream.
+///
+/// Objects of this enum are consumed by `EventWriter`. They correspond to different parts of
+/// an XML document.
+#[derive(Debug, Clone)]
+pub enum XmlEvent<'a> {
+ /// Corresponds to XML document declaration.
+ ///
+ /// This event should always be written before any other event. If it is not written
+ /// at all, a default XML declaration will be outputted if the corresponding option
+ /// is set in the configuration. Otherwise an error will be returned.
+ StartDocument {
+ /// XML version.
+ ///
+ /// Defaults to `XmlVersion::Version10`.
+ version: XmlVersion,
+
+ /// XML document encoding.
+ ///
+ /// Defaults to `Some("UTF-8")`.
+ encoding: Option<&'a str>,
+
+ /// XML standalone declaration.
+ ///
+ /// Defaults to `None`.
+ standalone: Option<bool>,
+ },
+
+ /// Denotes an XML processing instruction.
+ ProcessingInstruction {
+ /// Processing instruction target.
+ name: &'a str,
+
+ /// Processing instruction content.
+ data: Option<&'a str>,
+ },
+
+ /// Denotes a beginning of an XML element.
+ StartElement {
+ /// Qualified name of the element.
+ name: Name<'a>,
+
+ /// A list of attributes associated with the element.
+ ///
+ /// Currently attributes are not checked for duplicates (TODO). Attribute values
+ /// will be escaped, and all characters invalid for attribute values like `"` or `<`
+ /// will be changed into character entities.
+ attributes: Cow<'a, [Attribute<'a>]>,
+
+ /// Contents of the namespace mapping at this point of the document.
+ ///
+ /// This mapping will be inspected for "new" entries, and if at this point of the document
+ /// a particular pair of prefix and namespace URI is already defined, no namespace
+ /// attributes will be emitted.
+ namespace: Cow<'a, Namespace>,
+ },
+
+ /// Denotes an end of an XML element.
+ EndElement {
+ /// Optional qualified name of the element.
+ ///
+ /// If `None`, then it is assumed that the element name should be the last valid one.
+ /// If `Some` and element names tracking is enabled, then the writer will check it for
+ /// correctness.
+ name: Option<Name<'a>>,
+ },
+
+ /// Denotes CDATA content.
+ ///
+ /// This event contains unparsed data, and no escaping will be performed when writing it
+ /// to the output stream.
+ CData(&'a str),
+
+ /// Denotes a comment.
+ ///
+ /// The string will be checked for invalid sequences and error will be returned by the
+ /// write operation
+ Comment(&'a str),
+
+ /// Denotes character data outside of tags.
+ ///
+ /// Contents of this event will be escaped if `perform_escaping` option is enabled,
+ /// that is, every character invalid for PCDATA will appear as a character entity.
+ Characters(&'a str),
+}
+
+impl<'a> XmlEvent<'a> {
+ /// Returns an writer event for a processing instruction.
+ #[inline]
+ #[must_use]
+ pub fn processing_instruction(name: &'a str, data: Option<&'a str>) -> XmlEvent<'a> {
+ XmlEvent::ProcessingInstruction { name, data }
+ }
+
+ /// Returns a builder for a starting element.
+ ///
+ /// This builder can then be used to tweak attributes and namespace starting at
+ /// this element.
+ #[inline]
+ pub fn start_element<S>(name: S) -> StartElementBuilder<'a> where S: Into<Name<'a>> {
+ StartElementBuilder {
+ name: name.into(),
+ attributes: Vec::new(),
+ namespace: Namespace::empty(),
+ }
+ }
+
+ /// Returns a builder for an closing element.
+ ///
+ /// This method, unline `start_element()`, does not accept a name because by default
+ /// the writer is able to determine it automatically. However, when this functionality
+ /// is disabled, it is possible to specify the name with `name()` method on the builder.
+ #[inline]
+ #[must_use]
+ pub fn end_element() -> EndElementBuilder<'a> {
+ EndElementBuilder { name: None }
+ }
+
+ /// Returns a CDATA event.
+ ///
+ /// Naturally, the provided string won't be escaped, except for closing CDATA token `]]>`
+ /// (depending on the configuration).
+ #[inline]
+ #[must_use]
+ pub fn cdata(data: &'a str) -> XmlEvent<'a> {
+ XmlEvent::CData(data)
+ }
+
+ /// Returns a regular characters (PCDATA) event.
+ ///
+ /// All offending symbols, in particular, `&` and `<`, will be escaped by the writer.
+ #[inline]
+ #[must_use]
+ pub fn characters(data: &'a str) -> XmlEvent<'a> {
+ XmlEvent::Characters(data)
+ }
+
+ /// Returns a comment event.
+ #[inline]
+ #[must_use]
+ pub fn comment(data: &'a str) -> XmlEvent<'a> {
+ XmlEvent::Comment(data)
+ }
+}
+
+impl<'a> From<&'a str> for XmlEvent<'a> {
+ #[inline]
+ fn from(s: &'a str) -> XmlEvent<'a> {
+ XmlEvent::Characters(s)
+ }
+}
+
+pub struct EndElementBuilder<'a> {
+ name: Option<Name<'a>>,
+}
+
+/// A builder for a closing element event.
+impl<'a> EndElementBuilder<'a> {
+ /// Sets the name of this closing element.
+ ///
+ /// Usually the writer is able to determine closing element names automatically. If
+ /// this functionality is enabled (by default it is), then this name is checked for correctness.
+ /// It is possible, however, to disable such behavior; then the user must ensure that
+ /// closing element name is correct manually.
+ #[inline]
+ pub fn name<N>(mut self, name: N) -> EndElementBuilder<'a> where N: Into<Name<'a>> {
+ self.name = Some(name.into());
+ self
+ }
+}
+
+impl<'a> From<EndElementBuilder<'a>> for XmlEvent<'a> {
+ fn from(b: EndElementBuilder<'a>) -> XmlEvent<'a> {
+ XmlEvent::EndElement { name: b.name }
+ }
+}
+
+/// A builder for a starting element event.
+pub struct StartElementBuilder<'a> {
+ name: Name<'a>,
+ attributes: Vec<Attribute<'a>>,
+ namespace: Namespace,
+}
+
+impl<'a> StartElementBuilder<'a> {
+ /// Sets an attribute value of this element to the given string.
+ ///
+ /// This method can be used to add attributes to the starting element. Name is a qualified
+ /// name; its namespace is ignored, but its prefix is checked for correctness, that is,
+ /// it is checked that the prefix is bound to some namespace in the current context.
+ ///
+ /// Currently attributes are not checked for duplicates. Note that duplicate attributes
+ /// are a violation of XML document well-formedness.
+ ///
+ /// The writer checks that you don't specify reserved prefix names, for example `xmlns`.
+ #[inline]
+ pub fn attr<N>(mut self, name: N, value: &'a str) -> StartElementBuilder<'a>
+ where N: Into<Name<'a>>
+ {
+ self.attributes.push(Attribute::new(name.into(), value));
+ self
+ }
+
+ /// Adds a namespace to the current namespace context.
+ ///
+ /// If no namespace URI was bound to the provided prefix at this point of the document,
+ /// then the mapping from the prefix to the provided namespace URI will be written as
+ /// a part of this element attribute set.
+ ///
+ /// If the same namespace URI was bound to the provided prefix at this point of the document,
+ /// then no namespace attributes will be emitted.
+ ///
+ /// If some other namespace URI was bound to the provided prefix at this point of the document,
+ /// then another binding will be added as a part of this element attribute set, shadowing
+ /// the outer binding.
+ #[inline]
+ #[must_use]
+ pub fn ns<S1, S2>(mut self, prefix: S1, uri: S2) -> StartElementBuilder<'a>
+ where S1: Into<String>, S2: Into<String>
+ {
+ self.namespace.put(prefix, uri);
+ self
+ }
+
+ /// Adds a default namespace mapping to the current namespace context.
+ ///
+ /// Same rules as for `ns()` are also valid for the default namespace mapping.
+ #[inline]
+ #[must_use]
+ pub fn default_ns<S>(mut self, uri: S) -> StartElementBuilder<'a>
+ where S: Into<String>
+ {
+ self.namespace.put(NS_NO_PREFIX, uri);
+ self
+ }
+}
+
+impl<'a> From<StartElementBuilder<'a>> for XmlEvent<'a> {
+ #[inline]
+ fn from(b: StartElementBuilder<'a>) -> XmlEvent<'a> {
+ XmlEvent::StartElement {
+ name: b.name,
+ attributes: Cow::Owned(b.attributes),
+ namespace: Cow::Owned(b.namespace),
+ }
+ }
+}
diff --git a/pseudo_crate/Cargo.lock b/pseudo_crate/Cargo.lock
index f8b6e46..08d59dd 100644
--- a/pseudo_crate/Cargo.lock
+++ b/pseudo_crate/Cargo.lock
@@ -259,7 +259,33 @@
"tinytemplate",
"tokio-macros",
"tokio-stream",
+ "tokio-util",
+ "tower",
+ "tower-layer",
+ "tower-service",
+ "tracing",
+ "tracing-attributes",
+ "tracing-core",
+ "tracing-subscriber",
+ "try-lock",
+ "tungstenite",
+ "twox-hash",
+ "ucd-trie",
+ "unicode-bidi",
+ "unicode-normalization",
+ "unicode-segmentation",
+ "unicode-width",
+ "unsafe-libyaml",
"url",
+ "userfaultfd",
+ "utf-8",
+ "uuid",
+ "weak-table",
+ "webpki",
+ "which",
+ "winnow 0.5.37",
+ "x509-cert",
+ "xml-rs",
"zeroize",
"zeroize_derive",
"zip",
@@ -519,6 +545,26 @@
]
[[package]]
+name = "bindgen"
+version = "0.68.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "726e4313eb6ec35d2730258ad4e15b547ee75d6afaa1361a922e78e59b7d8078"
+dependencies = [
+ "bitflags 2.6.0",
+ "cexpr",
+ "clang-sys",
+ "lazy_static",
+ "lazycell",
+ "peeking_take_while",
+ "proc-macro2",
+ "quote",
+ "regex",
+ "rustc-hash",
+ "shlex",
+ "syn 2.0.43",
+]
+
+[[package]]
name = "bitflags"
version = "1.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -710,6 +756,17 @@
]
[[package]]
+name = "clang-sys"
+version = "1.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0b023947811758c97c59bf9d1c188fd619ad4718dcaa767947df1cadb14f39f4"
+dependencies = [
+ "glob",
+ "libc",
+ "libloading 0.8.3",
+]
+
+[[package]]
name = "clap"
version = "3.2.25"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -1007,6 +1064,9 @@
checksum = "fffa369a668c8af7dbf8b5e56c9f744fbd399949ed171606040001947de40b1c"
dependencies = [
"const-oid",
+ "der_derive",
+ "flagset",
+ "pem-rfc7468",
"zeroize",
]
@@ -1786,6 +1846,12 @@
checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
[[package]]
+name = "lazycell"
+version = "1.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830d08ce1d1d941e6b30645f1a0eb5643013d835ce3779a5fc208261dbe10f55"
+
+[[package]]
name = "libc"
version = "0.2.153"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2162,6 +2228,16 @@
]
[[package]]
+name = "nu-ansi-term"
+version = "0.46.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "77a8165726e8236064dbb45459242600304b42a5ea24ee2948e18e023bf7ba84"
+dependencies = [
+ "overload",
+ "winapi",
+]
+
+[[package]]
name = "num-integer"
version = "0.1.45"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2225,6 +2301,12 @@
]
[[package]]
+name = "overload"
+version = "0.1.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39"
+
+[[package]]
name = "p9"
version = "0.2.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2315,6 +2397,21 @@
]
[[package]]
+name = "peeking_take_while"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "19b17cddbe7ec3f8bc800887bab5e717348c95ea2ca0b1bf0837fb964dc67099"
+
+[[package]]
+name = "pem-rfc7468"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "88b39c9bfcfc231068454382784bb460aae594343fb030d46e9f50a645418412"
+dependencies = [
+ "base64ct",
+]
+
+[[package]]
name = "percent-encoding"
version = "2.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2679,6 +2776,21 @@
]
[[package]]
+name = "ring"
+version = "0.17.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c17fa4cb658e3583423e915b9f3acc01cceaee1860e33d59ebae66adc3a2dc0d"
+dependencies = [
+ "cc",
+ "cfg-if",
+ "getrandom",
+ "libc",
+ "spin",
+ "untrusted",
+ "windows-sys 0.52.0",
+]
+
+[[package]]
name = "rusqlite"
version = "0.29.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2915,6 +3027,15 @@
checksum = "5f179d4e11094a893b82fff208f74d448a7512f99f5a0acbd5c679b705f83ed9"
[[package]]
+name = "sharded-slab"
+version = "0.1.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6"
+dependencies = [
+ "lazy_static",
+]
+
+[[package]]
name = "shared_library"
version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -2982,6 +3103,7 @@
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d91ed6c858b01f942cd56b37a94b3e0a1798290327d1236e4d9cf4eaca44d29d"
dependencies = [
+ "base64ct",
"der",
]
@@ -3270,15 +3392,16 @@
[[package]]
name = "tokio-util"
-version = "0.7.11"
+version = "0.7.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9cf6b47b3771c49ac75ad09a6162f53ad4b8088b76ac60e8ec1455b31a189fe1"
+checksum = "5419f34732d9eb6ee4c3578b7989078579b7f039cbbb9ca2c4da015749371e15"
dependencies = [
"bytes",
"futures-core",
"futures-sink",
"pin-project-lite",
"tokio",
+ "tracing",
]
[[package]]
@@ -3295,7 +3418,7 @@
dependencies = [
"indexmap 2.4.0",
"toml_datetime",
- "winnow",
+ "winnow 0.6.18",
]
[[package]]
@@ -3316,15 +3439,15 @@
[[package]]
name = "tower-layer"
-version = "0.3.3"
+version = "0.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e"
+checksum = "c20c8dbed6283a09604c3e69b4b7eeb54e298b8a600d4d5ecb5ad39de609f1d0"
[[package]]
name = "tower-service"
-version = "0.3.3"
+version = "0.3.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3"
+checksum = "b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52"
[[package]]
name = "tracing"
@@ -3334,16 +3457,54 @@
dependencies = [
"log",
"pin-project-lite",
+ "tracing-attributes",
"tracing-core",
]
[[package]]
+name = "tracing-attributes"
+version = "0.1.27"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "34704c8d6ebcbc939824180af020566b01a7c01f80641264eba0999f6c2b6be7"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn 2.0.43",
+]
+
+[[package]]
name = "tracing-core"
version = "0.1.32"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c06d3da6113f116aaee68e4d601191614c9053067f9ab7f6edbcb161237daa54"
dependencies = [
"once_cell",
+ "valuable",
+]
+
+[[package]]
+name = "tracing-log"
+version = "0.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3"
+dependencies = [
+ "log",
+ "once_cell",
+ "tracing-core",
+]
+
+[[package]]
+name = "tracing-subscriber"
+version = "0.3.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ad0f048c97dbd9faa9b7df56362b8ebcaa52adb06b498c050d2f4e32f90a7a8b"
+dependencies = [
+ "nu-ansi-term",
+ "sharded-slab",
+ "smallvec",
+ "thread_local",
+ "tracing-core",
+ "tracing-log",
]
[[package]]
@@ -3353,12 +3514,32 @@
checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b"
[[package]]
+name = "tungstenite"
+version = "0.21.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ef1a641ea34f399a848dea702823bbecfb4c486f911735368f1f137cb8257e1"
+dependencies = [
+ "byteorder",
+ "bytes",
+ "data-encoding",
+ "http 1.1.0",
+ "httparse",
+ "log",
+ "rand",
+ "sha1",
+ "thiserror",
+ "url",
+ "utf-8",
+]
+
+[[package]]
name = "twox-hash"
version = "1.6.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "97fee6b57c6a41524a810daee9286c02d7752c4253064d0b05472833a438f675"
dependencies = [
"cfg-if",
+ "rand",
"static_assertions",
]
@@ -3394,18 +3575,24 @@
[[package]]
name = "unicode-normalization"
-version = "0.1.23"
+version = "0.1.22"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5"
+checksum = "5c5713f0fc4b5db668a2ac63cdb7bb4469d8c9fed047b1d0292cc7b0ce2ba921"
dependencies = [
"tinyvec",
]
[[package]]
-name = "unicode-width"
-version = "0.1.13"
+name = "unicode-segmentation"
+version = "1.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0336d538f7abc86d282a4189614dfaa90810dfc2c6f6427eaf88e16311dd225d"
+checksum = "1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36"
+
+[[package]]
+name = "unicode-width"
+version = "0.1.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e51733f11c9c4f72aa0c160008246859e340b00807569a0da0e7a1079b27ba85"
[[package]]
name = "unicode-xid"
@@ -3423,6 +3610,18 @@
]
[[package]]
+name = "unsafe-libyaml"
+version = "0.2.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ab4c90930b95a82d00dc9e9ac071b4991924390d46cbd0dfe566148667605e4b"
+
+[[package]]
+name = "untrusted"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1"
+
+[[package]]
name = "unwind_safe"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -3440,6 +3639,49 @@
]
[[package]]
+name = "userfaultfd"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b6a38c7e24af201e66f02659492f86ccd5efa9fd62f2c851fff3961a60e81966"
+dependencies = [
+ "bitflags 2.6.0",
+ "cfg-if",
+ "libc",
+ "nix",
+ "thiserror",
+ "userfaultfd-sys",
+]
+
+[[package]]
+name = "userfaultfd-sys"
+version = "0.5.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d75595d2a62b7db16bd47f5a1ce14e1fe05ccbe27d6c96721a958e0a027cad41"
+dependencies = [
+ "bindgen",
+ "cc",
+ "cfg-if",
+]
+
+[[package]]
+name = "utf-8"
+version = "0.7.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "09cc8ee72d2a9becf2f2febe0205bbed8fc6615b7cb429ad062dc7b7ddd036a9"
+
+[[package]]
+name = "uuid"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f00cc9702ca12d3c81455259621e676d0f7251cec66a21e98fe2e9a37db93b2a"
+
+[[package]]
+name = "valuable"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d"
+
+[[package]]
name = "vcpkg"
version = "0.2.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -3584,6 +3826,12 @@
]
[[package]]
+name = "weak-table"
+version = "0.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "323f4da9523e9a669e1eaf9c6e763892769b1d38c623913647bfdc1532fe4549"
+
+[[package]]
name = "web-sys"
version = "0.3.70"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -3594,6 +3842,27 @@
]
[[package]]
+name = "webpki"
+version = "0.22.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed63aea5ce73d0ff405984102c42de94fc55a6b75765d621c65262469b3c9b53"
+dependencies = [
+ "ring",
+ "untrusted",
+]
+
+[[package]]
+name = "which"
+version = "4.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2441c784c52b289a054b7201fc93253e288f094e2f4be9058343127c4226a269"
+dependencies = [
+ "either",
+ "libc",
+ "once_cell",
+]
+
+[[package]]
name = "widestring"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -3837,6 +4106,15 @@
[[package]]
name = "winnow"
+version = "0.5.37"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a7cad8365489051ae9f054164e459304af2e7e9bb407c958076c8bf4aef52da5"
+dependencies = [
+ "memchr",
+]
+
+[[package]]
+name = "winnow"
version = "0.6.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "68a9bda4691f099d435ad181000724da8e5899daa10713c2d432552b9ccd3a6f"
@@ -3865,6 +4143,23 @@
]
[[package]]
+name = "x509-cert"
+version = "0.2.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "25eefca1d99701da3a57feb07e5079fc62abba059fc139e98c13bbb250f3ef29"
+dependencies = [
+ "const-oid",
+ "der",
+ "spki",
+]
+
+[[package]]
+name = "xml-rs"
+version = "0.8.19"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "0fcb9cbac069e033553e8bb871be2fbdffcab578eb25bd0f7c508cedc6dcd75a"
+
+[[package]]
name = "zerocopy"
version = "0.7.35"
source = "registry+https://github.com/rust-lang/crates.io-index"
diff --git a/pseudo_crate/Cargo.toml b/pseudo_crate/Cargo.toml
index 8001c28..eede007 100644
--- a/pseudo_crate/Cargo.toml
+++ b/pseudo_crate/Cargo.toml
@@ -194,7 +194,33 @@
tinytemplate = "=1.2.1"
tokio-macros = "=2.1.0"
tokio-stream = "=0.1.14"
+tokio-util = "=0.7.10"
+tower = "=0.4.13"
+tower-layer = "=0.3.2"
+tower-service = "=0.3.2"
+tracing = "=0.1.40"
+tracing-attributes = "=0.1.27"
+tracing-core = "=0.1.32"
+tracing-subscriber = "=0.3.18"
+try-lock = "=0.2.5"
+tungstenite = "=0.21.0"
+twox-hash = "=1.6.3"
+ucd-trie = "=0.1.6"
+unicode-bidi = "=0.3.15"
+unicode-normalization = "=0.1.22"
+unicode-segmentation = "=1.10.1"
+unicode-width = "=0.1.11"
+unsafe-libyaml = "=0.2.10"
url = "=2.3.1"
+userfaultfd = "=0.7.0"
+utf-8 = "=0.7.6"
+uuid = "=1.7.0"
+weak-table = "=0.3.2"
+webpki = "=0.22.4"
+which = "=4.4.0"
+winnow = "=0.5.37"
+x509-cert = "=0.2.4"
+xml-rs = "=0.8.19"
zeroize = "=1.6.0"
zeroize_derive = "=1.4.2"
zip = "=0.6.6"
diff --git a/pseudo_crate/crate-list.txt b/pseudo_crate/crate-list.txt
index 208383f..a0cfb2c 100644
--- a/pseudo_crate/crate-list.txt
+++ b/pseudo_crate/crate-list.txt
@@ -186,7 +186,33 @@
tinytemplate
tokio-macros
tokio-stream
+tokio-util
+tower
+tower-layer
+tower-service
+tracing
+tracing-attributes
+tracing-core
+tracing-subscriber
+try-lock
+tungstenite
+twox-hash
+ucd-trie
+unicode-bidi
+unicode-normalization
+unicode-segmentation
+unicode-width
+unsafe-libyaml
url
+userfaultfd
+utf-8
+uuid
+weak-table
+webpki
+which
+winnow
+x509-cert
+xml-rs
zeroize
zeroize_derive
zip
